diff --git a/src/annotator.ts b/src/annotator.ts index 1cdaa7dc..f822f73d 100644 --- a/src/annotator.ts +++ b/src/annotator.ts @@ -1,41 +1,57 @@ import {isPlainObject} from 'lodash' -import {DereferencedPaths} from './resolver' -import {AnnotatedJSONSchema, JSONSchema, Parent, isAnnotated} from './types/JSONSchema' +import {AnnotatedJSONSchema, IsSchema, JSONSchema, Parent, isAnnotated} from './types/JSONSchema' +import {isSchemaLike} from './utils' -/** - * Traverses over the schema, assigning to each - * node metadata that will be used downstream. - */ -export function annotate( - schema: JSONSchema, - dereferencedPaths: DereferencedPaths, - parent: JSONSchema | null = null, -): AnnotatedJSONSchema { - if (!Array.isArray(schema) && !isPlainObject(schema)) { - return schema as AnnotatedJSONSchema - } +const annotators = new Set<(schema: JSONSchema, parent: JSONSchema | null) => void>() - // Handle cycles - if (isAnnotated(schema)) { - return schema - } - - // Add a reference to this schema's parent +annotators.add(function annotateParent(schema, parent) { Object.defineProperty(schema, Parent, { enumerable: false, value: parent, writable: false, }) +}) - // Arrays - if (Array.isArray(schema)) { - schema.forEach(child => annotate(child, dereferencedPaths, schema)) - } +annotators.add(function annotateSchemas(schema) { + Object.defineProperty(schema, IsSchema, { + enumerable: false, + value: isSchemaLike(schema), + writable: false, + }) +}) + +/** + * Traverses over the schema, assigning to each + * node metadata that will be used downstream. + */ +export function annotate(schema: JSONSchema): AnnotatedJSONSchema { + function go(s: JSONSchema, parent: JSONSchema | null): void { + if (!Array.isArray(s) && !isPlainObject(s)) { + return + } + + // Handle cycles + if (isAnnotated(s)) { + return + } + + // Run annotators + annotators.forEach(f => { + f(s, parent) + }) - // Objects - for (const key in schema) { - annotate(schema[key], dereferencedPaths, schema) + // Handle arrays + if (Array.isArray(s)) { + s.forEach(_ => go(_, s)) + } + + // Handle objects + for (const key in s) { + go(s[key], s) + } } + go(schema, null) + return schema as AnnotatedJSONSchema } diff --git a/src/index.ts b/src/index.ts index 9bc37d70..60ff877c 100644 --- a/src/index.ts +++ b/src/index.ts @@ -35,7 +35,7 @@ export interface Options { /** * Custom function to provide a type name for a given schema */ - customName?: (schema: AnnotatedJSONSchema, keyNameFromDefinition: string | undefined) => string | undefined + customName?: (schema: AnnotatedJSONSchema) => string | undefined /** * Root directory for resolving [`$ref`](https://tools.ietf.org/id/draft-pbryan-zyp-json-ref-03.html)s. */ @@ -150,7 +150,7 @@ export async function compile(schema: JSONSchema4, name: string, options: Partia // Initial clone to avoid mutating the input const _schema = cloneDeep(schema) - const {dereferencedPaths, dereferencedSchema} = await dereference(_schema, _options) + const dereferencedSchema = await dereference(_schema, _options) if (process.env.VERBOSE) { if (isDeepStrictEqual(_schema, dereferencedSchema)) { log('green', 'dereferencer', time(), '✅ No change') @@ -159,7 +159,7 @@ export async function compile(schema: JSONSchema4, name: string, options: Partia } } - const annotated = annotate(dereferencedSchema, dereferencedPaths) + const annotated = annotate(dereferencedSchema) if (process.env.VERBOSE) { log('green', 'annotater', time(), '✅ No change') } @@ -173,7 +173,7 @@ export async function compile(schema: JSONSchema4, name: string, options: Partia log('green', 'validator', time(), '✅ No change') } - const normalized = normalize(annotated, dereferencedPaths, name, _options) + const normalized = normalize(annotated, name, _options) log('yellow', 'normalizer', time(), '✅ Result:', normalized) const parsed = parse(normalized, _options) diff --git a/src/normalizer.ts b/src/normalizer.ts index 1009fb2a..e5dbe3a6 100644 --- a/src/normalizer.ts +++ b/src/normalizer.ts @@ -1,16 +1,18 @@ -import {JSONSchemaTypeName, AnnotatedJSONSchema, NormalizedJSONSchema, JSONSchema, Parent} from './types/JSONSchema' -import {appendToDescription, escapeBlockComment, isSchemaLike, justName, toSafeString, traverse} from './utils' +import { + JSONSchemaTypeName, + AnnotatedJSONSchema, + NormalizedJSONSchema, + JSONSchema, + Parent, + Ref, + IsSchema, +} from './types/JSONSchema' +import {appendToDescription, escapeBlockComment, justName, toSafeString, traverse} from './utils' import {Options} from './' -import {DereferencedPaths} from './resolver' import {isDeepStrictEqual} from 'util' +import {typesOfSchema} from './typesOfSchema' -type Rule = ( - schema: AnnotatedJSONSchema, - fileName: string, - options: Options, - key: string | null, - dereferencedPaths: DereferencedPaths, -) => void +type Rule = (schema: AnnotatedJSONSchema, fileName: string, options: Options, key: string | null) => void const rules = new Map() function hasType(schema: JSONSchema, type: JSONSchemaTypeName) { @@ -62,9 +64,10 @@ rules.set('Default additionalProperties', (schema, _, options) => { }) rules.set('Transform id to $id', (schema, fileName) => { - if (!isSchemaLike(schema)) { + if (!schema[IsSchema]) { return } + if (schema.id && schema.$id && schema.id !== schema.$id) { throw ReferenceError( `Schema must define either id or $id, not both. Given id=${schema.id}, $id=${schema.$id} in ${fileName}`, @@ -76,32 +79,28 @@ rules.set('Transform id to $id', (schema, fileName) => { } }) -rules.set('Add an $id to anything that needs it', (schema, fileName, _options, _key, dereferencedPaths) => { - if (!isSchemaLike(schema)) { +rules.set('Add an $id to each top-level schema', (schema, fileName) => { + if (schema.$id || schema[Parent]) { return } - // Top-level schema - if (!schema.$id && !schema[Parent]) { - schema.$id = toSafeString(justName(fileName)) + if (!schema[IsSchema]) { return } - // Sub-schemas with references - if (!isArrayType(schema) && !isObjectType(schema)) { + schema.$id = toSafeString(justName(fileName)) +}) + +rules.set('Add an $id to each referenced schema', schema => { + if (schema.$id) { return } - // We'll infer from $id and title downstream - // TODO: Normalize upstream - const dereferencedName = dereferencedPaths.get(schema) - if (!schema.$id && !schema.title && dereferencedName) { - schema.$id = toSafeString(justName(dereferencedName)) + if (!schema[Ref]) { + return } - if (dereferencedName) { - dereferencedPaths.delete(schema) - } + schema.$id = toSafeString(justName(schema[Ref])) }) rules.set('Escape closing JSDoc comment', schema => { @@ -218,6 +217,35 @@ rules.set('Transform definitions to $defs', (schema, fileName) => { } }) +rules.set( + "Add an $id to each $def that doesn't have one, if unreachableDefinitions is enabled", + (schema, _, options) => { + if (!options.unreachableDefinitions) { + return + } + + if (schema.$id) { + return + } + + const parent = schema[Parent] + if (!parent) { + return + } + + const grandparent = parent[Parent] + if (!grandparent) { + return + } + + if (Object.keys(grandparent).find(_ => grandparent[_] === parent) !== '$defs') { + return + } + + schema.$id = toSafeString(Object.keys(parent).find(_ => parent[_] === schema)!) + }, +) + rules.set('Transform const to singleton enum', schema => { if (schema.const !== undefined) { schema.enum = [schema.const] @@ -231,12 +259,34 @@ rules.set('Add tsEnumNames to enum types', (schema, _, options) => { } }) -export function normalize( - rootSchema: AnnotatedJSONSchema, - dereferencedPaths: DereferencedPaths, - filename: string, - options: Options, -): NormalizedJSONSchema { - rules.forEach(rule => traverse(rootSchema, (schema, key) => rule(schema, filename, options, key, dereferencedPaths))) +rules.set('Add an $id to each named enum', schema => { + if (!schema[IsSchema]) { + return + } + + if (schema.$id) { + return + } + + if (!typesOfSchema(schema).includes('NAMED_ENUM')) { + return + } + + const parent = schema[Parent] + const keyName = Object.keys(parent).find(_ => parent[_] === schema) + + // Special case: generate nicer names for additionalProperties enums + if (parent[IsSchema] && keyName === 'additionalProperties') { + const grandparent = parent[Parent] + const parentKeyName = Object.keys(grandparent).find(_ => grandparent[_] === parent)! + schema.$id = toSafeString(parentKeyName) + toSafeString(keyName) + return + } + + schema.$id = toSafeString(justName(keyName)) +}) + +export function normalize(rootSchema: AnnotatedJSONSchema, filename: string, options: Options): NormalizedJSONSchema { + rules.forEach(rule => traverse(rootSchema, (schema, key) => rule(schema, filename, options, key))) return rootSchema as NormalizedJSONSchema } diff --git a/src/parser.ts b/src/parser.ts index 22e585ac..a1b3b907 100644 --- a/src/parser.ts +++ b/src/parser.ts @@ -1,5 +1,5 @@ import {JSONSchema4Type, JSONSchema4TypeName} from 'json-schema' -import {findKey, includes, isPlainObject, map, memoize, omit} from 'lodash' +import {includes, map, omit} from 'lodash' import {format} from 'util' import {Options} from './' import {typesOfSchema} from './typesOfSchema' @@ -17,12 +17,12 @@ import { } from './types/AST' import { EnumJSONSchema, - getRootSchema, isBoolean, isPrimitive, - JSONSchemaWithDefinitions, + IsSchema, NormalizedJSONSchema, Parent, + Ref, SchemaSchema, SchemaType, } from './types/JSONSchema' @@ -58,7 +58,9 @@ export function parse( // so that it gets first pick for standalone name. const ast = parseAsTypeWithCache( { + [IsSchema]: schema[IsSchema], [Parent]: schema[Parent], + [Ref]: schema[Ref], $id: schema.$id, additionalProperties: schema.additionalProperties, allOf: [], @@ -143,16 +145,13 @@ function parseNonLiteral( processed: Processed, usedNames: UsedNames, ): AST { - const definitions = getDefinitionsMemoized(getRootSchema(schema as any)) // TODO - const keyNameFromDefinition = findKey(definitions, _ => _ === schema) - switch (type) { case 'ALL_OF': return { comment: schema.description, deprecated: schema.deprecated, keyName, - standaloneName: standaloneName(schema, keyNameFromDefinition, usedNames, options), + standaloneName: standaloneName(schema, usedNames, options), params: schema.allOf!.map(_ => parse(_, options, undefined, processed, usedNames)), type: 'INTERSECTION', } @@ -162,14 +161,14 @@ function parseNonLiteral( comment: schema.description, deprecated: schema.deprecated, keyName, - standaloneName: standaloneName(schema, keyNameFromDefinition, usedNames, options), + standaloneName: standaloneName(schema, usedNames, options), } case 'ANY_OF': return { comment: schema.description, deprecated: schema.deprecated, keyName, - standaloneName: standaloneName(schema, keyNameFromDefinition, usedNames, options), + standaloneName: standaloneName(schema, usedNames, options), params: schema.anyOf!.map(_ => parse(_, options, undefined, processed, usedNames)), type: 'UNION', } @@ -178,7 +177,7 @@ function parseNonLiteral( comment: schema.description, deprecated: schema.deprecated, keyName, - standaloneName: standaloneName(schema, keyNameFromDefinition, usedNames, options), + standaloneName: standaloneName(schema, usedNames, options), type: 'BOOLEAN', } case 'CUSTOM_TYPE': @@ -187,7 +186,7 @@ function parseNonLiteral( deprecated: schema.deprecated, keyName, params: schema.tsType!, - standaloneName: standaloneName(schema, keyNameFromDefinition, usedNames, options), + standaloneName: standaloneName(schema, usedNames, options), type: 'CUSTOM_TYPE', } case 'NAMED_ENUM': @@ -195,7 +194,7 @@ function parseNonLiteral( comment: schema.description, deprecated: schema.deprecated, keyName, - standaloneName: standaloneName(schema, keyNameFromDefinition ?? keyName, usedNames, options)!, + standaloneName: standaloneName(schema, usedNames, options)!, params: (schema as EnumJSONSchema).enum!.map((_, n) => ({ ast: parseLiteral(_, undefined), keyName: schema.tsEnumNames![n], @@ -209,7 +208,7 @@ function parseNonLiteral( comment: schema.description, deprecated: schema.deprecated, keyName, - standaloneName: standaloneName(schema, keyNameFromDefinition, usedNames, options), + standaloneName: standaloneName(schema, usedNames, options), type: 'NEVER', } case 'NULL': @@ -217,7 +216,7 @@ function parseNonLiteral( comment: schema.description, deprecated: schema.deprecated, keyName, - standaloneName: standaloneName(schema, keyNameFromDefinition, usedNames, options), + standaloneName: standaloneName(schema, usedNames, options), type: 'NULL', } case 'NUMBER': @@ -225,14 +224,14 @@ function parseNonLiteral( comment: schema.description, deprecated: schema.deprecated, keyName, - standaloneName: standaloneName(schema, keyNameFromDefinition, usedNames, options), + standaloneName: standaloneName(schema, usedNames, options), type: 'NUMBER', } case 'OBJECT': return { comment: schema.description, keyName, - standaloneName: standaloneName(schema, keyNameFromDefinition, usedNames, options), + standaloneName: standaloneName(schema, usedNames, options), type: 'OBJECT', deprecated: schema.deprecated, } @@ -241,7 +240,7 @@ function parseNonLiteral( comment: schema.description, deprecated: schema.deprecated, keyName, - standaloneName: standaloneName(schema, keyNameFromDefinition, usedNames, options), + standaloneName: standaloneName(schema, usedNames, options), params: schema.oneOf!.map(_ => parse(_, options, undefined, processed, usedNames)), type: 'UNION', } @@ -252,10 +251,11 @@ function parseNonLiteral( comment: schema.description, deprecated: schema.deprecated, keyName, - standaloneName: standaloneName(schema, keyNameFromDefinition, usedNames, options), + standaloneName: standaloneName(schema, usedNames, options), type: 'STRING', } - case 'TYPED_ARRAY': + case 'TYPED_ARRAY': { + const name = standaloneName(schema, usedNames, options) if (Array.isArray(schema.items)) { // normalised to not be undefined const minItems = schema.minItems! @@ -266,7 +266,7 @@ function parseNonLiteral( keyName, maxItems, minItems, - standaloneName: standaloneName(schema, keyNameFromDefinition, usedNames, options), + standaloneName: name, params: schema.items.map(_ => parse(_, options, undefined, processed, usedNames)), type: 'TUPLE', } @@ -281,17 +281,18 @@ function parseNonLiteral( comment: schema.description, deprecated: schema.deprecated, keyName, - standaloneName: standaloneName(schema, keyNameFromDefinition, usedNames, options), - params: parse(schema.items!, options, `{keyNameFromDefinition}Items`, processed, usedNames), + standaloneName: name, + params: parse(schema.items!, options, `${name}Items`, processed, usedNames), type: 'ARRAY', } } + } case 'UNION': return { comment: schema.description, deprecated: schema.deprecated, keyName, - standaloneName: standaloneName(schema, keyNameFromDefinition, usedNames, options), + standaloneName: standaloneName(schema, usedNames, options), params: (schema.type as JSONSchema4TypeName[]).map(type => { const member: NormalizedJSONSchema = { ...omit(schema, '$id', 'description', 'title'), @@ -308,12 +309,12 @@ function parseNonLiteral( comment: schema.description, deprecated: schema.deprecated, keyName, - standaloneName: standaloneName(schema, keyNameFromDefinition, usedNames, options), + standaloneName: standaloneName(schema, usedNames, options), params: (schema as EnumJSONSchema).enum!.map(_ => parseLiteral(_, undefined)), type: 'UNION', } case 'UNNAMED_SCHEMA': - return newInterface(schema as SchemaSchema, options, processed, usedNames, keyName, keyNameFromDefinition) + return newInterface(schema as SchemaSchema, options, processed, usedNames, keyName) case 'UNTYPED_ARRAY': // normalised to not be undefined const minItems = schema.minItems! @@ -330,7 +331,7 @@ function parseNonLiteral( params: Array(Math.max(maxItems, minItems) || 0).fill(params), // if there is no maximum, then add a spread item to collect the rest spreadParam: maxItems >= 0 ? undefined : params, - standaloneName: standaloneName(schema, keyNameFromDefinition, usedNames, options), + standaloneName: standaloneName(schema, usedNames, options), type: 'TUPLE', } } @@ -340,7 +341,7 @@ function parseNonLiteral( deprecated: schema.deprecated, keyName, params, - standaloneName: standaloneName(schema, keyNameFromDefinition, usedNames, options), + standaloneName: standaloneName(schema, usedNames, options), type: 'ARRAY', } } @@ -349,14 +350,8 @@ function parseNonLiteral( /** * Compute a schema name using a series of fallbacks */ -function standaloneName( - schema: NormalizedJSONSchema, - keyNameFromDefinition: string | undefined, - usedNames: UsedNames, - options: Options, -): string | undefined { - const name = - options.customName?.(schema, keyNameFromDefinition) || schema.title || schema.$id || keyNameFromDefinition +function standaloneName(schema: NormalizedJSONSchema, usedNames: UsedNames, options: Options): string | undefined { + const name = options.customName?.(schema) || schema.title || schema.$id if (name) { return generateName(name, usedNames) } @@ -368,9 +363,8 @@ function newInterface( processed: Processed, usedNames: UsedNames, keyName?: string, - keyNameFromDefinition?: string, ): TInterface { - const name = standaloneName(schema, keyNameFromDefinition, usedNames, options)! + const name = standaloneName(schema, usedNames, options)! return { comment: schema.description, deprecated: schema.deprecated, @@ -487,47 +481,3 @@ via the \`definition\` "${key}".` }) } } - -type Definitions = {[k: string]: NormalizedJSONSchema} - -function getDefinitions( - schema: NormalizedJSONSchema, - isSchema = true, - processed = new Set(), -): Definitions { - if (processed.has(schema)) { - return {} - } - processed.add(schema) - if (Array.isArray(schema)) { - return schema.reduce( - (prev, cur) => ({ - ...prev, - ...getDefinitions(cur, false, processed), - }), - {}, - ) - } - if (isPlainObject(schema)) { - return { - ...(isSchema && hasDefinitions(schema) ? schema.$defs : {}), - ...Object.keys(schema).reduce( - (prev, cur) => ({ - ...prev, - ...getDefinitions(schema[cur], false, processed), - }), - {}, - ), - } - } - return {} -} - -const getDefinitionsMemoized = memoize(getDefinitions) - -/** - * TODO: Reduce rate of false positives - */ -function hasDefinitions(schema: NormalizedJSONSchema): schema is JSONSchemaWithDefinitions { - return '$defs' in schema -} diff --git a/src/resolver.ts b/src/resolver.ts index 94dc5a0e..60b78db9 100644 --- a/src/resolver.ts +++ b/src/resolver.ts @@ -1,24 +1,25 @@ import {$RefParser, ParserOptions as $RefOptions} from '@apidevtools/json-schema-ref-parser' -import {JSONSchema} from './types/JSONSchema' +import {DereferencedJSONSchema, JSONSchema, Ref} from './types/JSONSchema' import {log} from './utils' -export type DereferencedPaths = WeakMap - export async function dereference( schema: JSONSchema, {cwd, $refOptions}: {cwd: string; $refOptions: $RefOptions}, -): Promise<{dereferencedPaths: DereferencedPaths; dereferencedSchema: JSONSchema}> { +): Promise { log('green', 'dereferencer', 'Dereferencing input schema:', cwd, schema) const parser = new $RefParser() - const dereferencedPaths: DereferencedPaths = new WeakMap() const dereferencedSchema = (await parser.dereference(cwd, schema, { ...$refOptions, dereference: { ...$refOptions.dereference, onDereference($ref: string, schema: JSONSchema) { - dereferencedPaths.set(schema, $ref) + if (Ref in schema) { + // TODO: What to do with >1 name for the same ref? + return + } + Object.defineProperty(schema, Ref, {value: $ref}) }, }, - })) as any // TODO: fix types - return {dereferencedPaths, dereferencedSchema} + })) as DereferencedJSONSchema // TODO: fix types + return dereferencedSchema } diff --git a/src/types/JSONSchema.ts b/src/types/JSONSchema.ts index 89917e29..08375e31 100644 --- a/src/types/JSONSchema.ts +++ b/src/types/JSONSchema.ts @@ -1,5 +1,5 @@ import {JSONSchema4, JSONSchema4Type, JSONSchema4TypeName} from 'json-schema' -import {isPlainObject, memoize} from 'lodash' +import {isPlainObject} from 'lodash' export type SchemaType = | 'ALL_OF' @@ -40,9 +40,22 @@ export interface JSONSchema extends JSONSchema4 { deprecated?: boolean } +export const IsSchema = Symbol('IsSchema') export const Parent = Symbol('Parent') +export const Ref = Symbol('Ref') -export interface AnnotatedJSONSchema extends JSONSchema { +export interface DereferencedJSONSchema extends JSONSchema { + /** + * The original $ref that was dereferenced, if there was one. + */ + [Ref]: string | undefined +} + +export interface AnnotatedJSONSchema extends DereferencedJSONSchema { + /** + * Whether the given object is a JSONSchema (as opposed to a part of a schema, like a property) + */ + [IsSchema]: boolean [Parent]: AnnotatedJSONSchema additionalItems?: boolean | AnnotatedJSONSchema @@ -112,24 +125,10 @@ export interface SchemaSchema extends NormalizedJSONSchema { required: string[] } -export interface JSONSchemaWithDefinitions extends NormalizedJSONSchema { - $defs: { - [k: string]: NormalizedJSONSchema - } -} - export interface CustomTypeJSONSchema extends NormalizedJSONSchema { tsType: string } -export const getRootSchema = memoize((schema: NormalizedJSONSchema): NormalizedJSONSchema => { - const parent = schema[Parent] - if (!parent) { - return schema - } - return getRootSchema(parent) -}) - export function isBoolean(schema: AnnotatedJSONSchema | JSONSchemaType): schema is boolean { return schema === true || schema === false } diff --git a/test/__snapshots__/test/test.ts.md b/test/__snapshots__/test/test.ts.md index 0991ab2b..afe16611 100644 --- a/test/__snapshots__/test/test.ts.md +++ b/test/__snapshots__/test/test.ts.md @@ -4,9 +4,9 @@ The actual snapshot is saved in `test.ts.snap`. Generated by [AVA](https://avajs.dev). -## JSONSchema.js +## union.5.js -> Expected output to match snapshot for e2e test: JSONSchema.js +> Expected output to match snapshot for e2e test: union.5.js `/* eslint-disable */␊ /**␊ @@ -15,449726 +15,16 @@ Generated by [AVA](https://avajs.dev). * and run json-schema-to-typescript to regenerate this file.␊ */␊ ␊ - export type PositiveInteger = number;␊ - export type PositiveIntegerDefault0 = PositiveInteger;␊ - /**␊ - * @minItems 1␊ - */␊ - export type SchemaArray = [HttpJsonSchemaOrgDraft04Schema, ...HttpJsonSchemaOrgDraft04Schema[]];␊ - /**␊ - * @minItems 1␊ - */␊ - export type StringArray = [string, ...string[]];␊ - export type SimpleTypes = "array" | "boolean" | "integer" | "null" | "number" | "object" | "string";␊ - ␊ - /**␊ - * Core schema meta-schema␊ - */␊ - export interface HttpJsonSchemaOrgDraft04Schema {␊ - id?: string;␊ - $schema?: string;␊ - title?: string;␊ - description?: string;␊ - default?: unknown;␊ - multipleOf?: number;␊ - maximum?: number;␊ - exclusiveMaximum?: boolean;␊ - minimum?: number;␊ - exclusiveMinimum?: boolean;␊ - maxLength?: PositiveInteger;␊ - minLength?: PositiveIntegerDefault0;␊ - pattern?: string;␊ - additionalItems?: boolean | HttpJsonSchemaOrgDraft04Schema;␊ - items?: HttpJsonSchemaOrgDraft04Schema | SchemaArray;␊ - maxItems?: PositiveInteger;␊ - minItems?: PositiveIntegerDefault0;␊ - uniqueItems?: boolean;␊ - maxProperties?: PositiveInteger;␊ - minProperties?: PositiveIntegerDefault0;␊ - required?: StringArray;␊ - additionalProperties?: boolean | HttpJsonSchemaOrgDraft04Schema;␊ - definitions?: {␊ - [k: string]: HttpJsonSchemaOrgDraft04Schema;␊ - };␊ - properties?: {␊ - [k: string]: HttpJsonSchemaOrgDraft04Schema;␊ - };␊ - patternProperties?: {␊ - [k: string]: HttpJsonSchemaOrgDraft04Schema;␊ - };␊ - dependencies?: {␊ - [k: string]: HttpJsonSchemaOrgDraft04Schema | StringArray;␊ - };␊ - /**␊ - * @minItems 1␊ - */␊ - enum?: [unknown, ...unknown[]];␊ - type?: SimpleTypes | [SimpleTypes, ...SimpleTypes[]];␊ - allOf?: SchemaArray;␊ - anyOf?: SchemaArray;␊ - oneOf?: SchemaArray;␊ - not?: HttpJsonSchemaOrgDraft04Schema;␊ - [k: string]: unknown;␊ - }␊ - ` - -## WithComment.js - -> Expected output to match snapshot for e2e test: WithComment.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface WithComment {␊ - /**␊ - * /* comment * /␊ - */␊ - a?: {␊ - /**␊ - * /* nested comment * /␊ - */␊ - b?: string;␊ - [k: string]: unknown;␊ - };␊ - [k: string]: unknown;␊ - }␊ - ` - -## additionalProperties.1.js - -> Expected output to match snapshot for e2e test: additionalProperties.1.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface AdditionalProperties {␊ - foo?: string;␊ - [k: string]: number;␊ - }␊ - ` - -## additionalProperties.2.js - -> Expected output to match snapshot for e2e test: additionalProperties.2.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface AdditionalPropertiesConfiguredToDefaultToFalse {␊ - a?: {};␊ - b?: {};␊ - c?: {␊ - [k: string]: unknown;␊ - };␊ - d?: {␊ - [k: string]: number;␊ - };␊ - e?: E;␊ - }␊ - export interface E {}␊ - ` - -## additionalProperties.3.js - -> Expected output to match snapshot for e2e test: additionalProperties.3.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface AdditionalPropertiesDefaultToTrue {␊ - a?: {␊ - [k: string]: unknown;␊ - };␊ - b?: {};␊ - c?: {␊ - [k: string]: unknown;␊ - };␊ - d?: {␊ - [k: string]: number;␊ - };␊ - e?: E;␊ - [k: string]: unknown;␊ - }␊ - export interface E {␊ - [k: string]: unknown;␊ - }␊ - ` - -## allOf.js - -> Expected output to match snapshot for e2e test: allOf.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface AllOf {␊ - foo: Foo & Bar;␊ - }␊ - export interface Foo {␊ - a: string;␊ - b: number;␊ - }␊ - export interface Bar {␊ - a: string;␊ - }␊ - ` - -## anyOf.js - -> Expected output to match snapshot for e2e test: anyOf.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface AnyOf {␊ - foo: Foo | Bar | Baz;␊ - }␊ - export interface Foo {␊ - a: string;␊ - b?: number;␊ - }␊ - export interface Bar {␊ - a?: "a" | "b" | "c";␊ - bam?: "wam"[];␊ - [k: string]: unknown;␊ - }␊ - export interface Baz {␊ - baz?: Bar;␊ - [k: string]: unknown;␊ - }␊ - ` - -## anyOfRoot.js - -> Expected output to match snapshot for e2e test: anyOfRoot.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export type RootAnyOf = Foo | Bar | Baz;␊ - ␊ - export interface Foo {␊ - a: string;␊ - b?: number;␊ - }␊ - export interface Bar {␊ - a?: "a" | "b" | "c";␊ - [k: string]: unknown;␊ - }␊ - export interface Baz {␊ - baz?: Bar;␊ - [k: string]: unknown;␊ - }␊ - ` - -## arrayAdditionalItems.js - -> Expected output to match snapshot for e2e test: arrayAdditionalItems.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface ArrayAdditionalItems {␊ - namedEums?: {␊ - additionalItemsAny?: [] | [NamedEnum2, ...unknown[]];␊ - additionalItems?: [] | [NamedEnum21, ...NamedEnum22[]];␊ - };␊ - unnamedEmums?: {␊ - additionalItemsAny?: [] | [1 | 2 | 3, ...unknown[]];␊ - additionalItems?: [] | ["One" | "Two" | "Three", ...(4 | 5 | 6)[]];␊ - };␊ - namedSchema?: {␊ - additionalItemsAny?: [] | [StringSchema1] | [StringSchema1, NumberSchema1, ...unknown[]];␊ - additionalItems?: [] | [StringSchema2] | [StringSchema2, NumberSchema2, ...BooleanSchema1[]];␊ - };␊ - schema?: {␊ - additionalItemsAny?:␊ - | []␊ - | [␊ - {␊ - foo?: string;␊ - [k: string]: unknown;␊ - }␊ - ]␊ - | [␊ - {␊ - foo?: string;␊ - [k: string]: unknown;␊ - },␊ - {␊ - bar?: number;␊ - [k: string]: unknown;␊ - },␊ - ...unknown[]␊ - ];␊ - additionalItems?:␊ - | []␊ - | [␊ - {␊ - foo?: string;␊ - [k: string]: unknown;␊ - }␊ - ]␊ - | [␊ - {␊ - foo?: string;␊ - [k: string]: unknown;␊ - },␊ - {␊ - bar?: number;␊ - [k: string]: unknown;␊ - },␊ - ...{␊ - baz?: boolean;␊ - [k: string]: unknown;␊ - }[]␊ - ];␊ - };␊ - ofType?: {␊ - additonalItemsAny?: [] | [number] | [number, string, ...unknown[]];␊ - additonalItems?: [] | [number] | [number, string, ...boolean[]];␊ - };␊ - refs?: {␊ - additionalItemsAny?: [] | [ExampleSchema, ...unknown[]];␊ - additionalItems?: [] | [ExampleSchema1, ...ExampleSchema2[]];␊ - };␊ - defs?: {␊ - additionalItemsAny?: [] | [FirstDefinition, ...unknown[]];␊ - additionalItems?: [] | [UnrelatedTitle, ...ThirdDefinition[]];␊ - };␊ - }␊ - export interface StringSchema1 {␊ - foo?: string;␊ - [k: string]: unknown;␊ - }␊ - export interface NumberSchema1 {␊ - bar?: number;␊ - [k: string]: unknown;␊ - }␊ - export interface StringSchema2 {␊ - foo?: string;␊ - [k: string]: unknown;␊ - }␊ - export interface NumberSchema2 {␊ - bar?: number;␊ - [k: string]: unknown;␊ - }␊ - export interface BooleanSchema1 {␊ - baz?: boolean;␊ - [k: string]: unknown;␊ - }␊ - export interface ExampleSchema {␊ - firstName: string;␊ - lastName: string;␊ - /**␊ - * Age in years␊ - */␊ - age?: number;␊ - height?: number;␊ - favoriteFoods?: unknown[];␊ - likesDogs?: boolean;␊ - [k: string]: unknown;␊ - }␊ - export interface ExampleSchema1 {␊ - firstName: string;␊ - lastName: string;␊ - /**␊ - * Age in years␊ - */␊ - age?: number;␊ - height?: number;␊ - favoriteFoods?: unknown[];␊ - likesDogs?: boolean;␊ - [k: string]: unknown;␊ - }␊ - export interface ExampleSchema2 {␊ - isConflict: boolean;␊ - }␊ - /**␊ - * Title matches definition key for kicks␊ - */␊ - export interface FirstDefinition {␊ - name?: string;␊ - }␊ - /**␊ - * Title is unrelated to definition key and behaviour is the same␊ - */␊ - export interface UnrelatedTitle {␊ - name?: string;␊ - } /**␊ - * Definition has no title and produces no duplicate Interface␊ - */␊ - export interface ThirdDefinition {␊ - name?: string;␊ - }␊ - ␊ - export const enum NamedEnum2 {␊ - One = 1,␊ - Two = 2,␊ - Three = 3␊ - }␊ - export const enum NamedEnum21 {␊ - One = 1,␊ - Two = 2,␊ - Three = 3␊ - }␊ - export const enum NamedEnum22 {␊ - Four = 4,␊ - Five = 5,␊ - Six = 6␊ - }␊ - ` - -## arrayMaxMinItems.js - -> Expected output to match snapshot for e2e test: arrayMaxMinItems.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface ArrayMaxMinItems {␊ - array?: {␊ - /**␊ - * @minItems 3␊ - */␊ - withMinItems?: [string, string, string, ...string[]];␊ - /**␊ - * @maxItems 3␊ - */␊ - withMaxItems?: [] | [string] | [string, string] | [string, string, string];␊ - /**␊ - * @minItems 3␊ - * @maxItems 8␊ - */␊ - withMinMaxItems?:␊ - | [string, string, string]␊ - | [string, string, string, string]␊ - | [string, string, string, string, string]␊ - | [string, string, string, string, string, string]␊ - | [string, string, string, string, string, string, string]␊ - | [string, string, string, string, string, string, string, string];␊ - /**␊ - * @maxItems 0␊ - */␊ - withMaxItems0?: [];␊ - /**␊ - * @minItems 0␊ - */␊ - withMinItems0?: string[];␊ - /**␊ - * @minItems 0␊ - * @maxItems 0␊ - */␊ - withMinMaxItems0?: [];␊ - };␊ - untyped?: {␊ - /**␊ - * @minItems 3␊ - */␊ - withMinItems?: [unknown, unknown, unknown, ...unknown[]];␊ - /**␊ - * @maxItems 3␊ - */␊ - withMaxItems?: [] | [unknown] | [unknown, unknown] | [unknown, unknown, unknown];␊ - /**␊ - * @minItems 3␊ - * @maxItems 8␊ - */␊ - withMinMaxItems?:␊ - | [unknown, unknown, unknown]␊ - | [unknown, unknown, unknown, unknown]␊ - | [unknown, unknown, unknown, unknown, unknown]␊ - | [unknown, unknown, unknown, unknown, unknown, unknown]␊ - | [unknown, unknown, unknown, unknown, unknown, unknown, unknown]␊ - | [unknown, unknown, unknown, unknown, unknown, unknown, unknown, unknown];␊ - /**␊ - * @maxItems 0␊ - */␊ - withMaxItems0?: [];␊ - /**␊ - * @minItems 0␊ - */␊ - withMinItems0?: unknown[];␊ - /**␊ - * @minItems 0␊ - * @maxItems 0␊ - */␊ - withMinMaxItems0?: [];␊ - };␊ - tuple?: {␊ - /**␊ - * @minItems 2␊ - */␊ - withMinItemsLessThanItemLength?: [1, 2] | [1, 2, 3] | [1, 2, 3, 4] | [1, 2, 3, 4, 5] | [1, 2, 3, 4, 5, 6];␊ - /**␊ - * @minItems 8␊ - */␊ - withMinItemsGreaterThanItemLength?: [1, 2, 3, 4, 5, 6, ...unknown[]];␊ - /**␊ - * @maxItems 2␊ - */␊ - withMaxItemsLessThanItemLength?: [] | [1] | [1, 2];␊ - /**␊ - * @maxItems 8␊ - */␊ - withMaxItemsGreaterThanItemLength?:␊ - | []␊ - | [1]␊ - | [1, 2]␊ - | [1, 2, 3]␊ - | [1, 2, 3, 4]␊ - | [1, 2, 3, 4, 5]␊ - | [1, 2, 3, 4, 5, 6]␊ - | [1, 2, 3, 4, 5, 6, unknown]␊ - | [1, 2, 3, 4, 5, 6, unknown, unknown];␊ - /**␊ - * @minItems 4␊ - * @maxItems 8␊ - */␊ - withMinItemsLessThanItemLength_and_MaxItemsGreaterThanItemLength?:␊ - | [1, 2, 3, 4]␊ - | [1, 2, 3, 4, 5]␊ - | [1, 2, 3, 4, 5, 6]␊ - | [1, 2, 3, 4, 5, 6, unknown]␊ - | [1, 2, 3, 4, 5, 6, unknown, unknown];␊ - /**␊ - * @minItems 2␊ - * @maxItems 4␊ - */␊ - withMinItemsLessThanItemLength_and_MaxItemsLessThanItemLength?: [1, 2] | [1, 2, 3] | [1, 2, 3, 4];␊ - /**␊ - * @minItems 8␊ - * @maxItems 10␊ - */␊ - withMinItemsGreaterThanItemLength_and_MaxItemsGreaterThanItemLength?:␊ - | [1, 2, 3, 4, 5, 6, unknown, unknown]␊ - | [1, 2, 3, 4, 5, 6, unknown, unknown, unknown]␊ - | [1, 2, 3, 4, 5, 6, unknown, unknown, unknown, unknown];␊ - /**␊ - * @maxItems 0␊ - */␊ - withMaxItems0?: [];␊ - /**␊ - * @minItems 0␊ - */␊ - withMinItems0?: [] | [1] | [1, 2] | [1, 2, 3] | [1, 2, 3, 4] | [1, 2, 3, 4, 5] | [1, 2, 3, 4, 5, 6];␊ - /**␊ - * @minItems 0␊ - * @maxItems 0␊ - */␊ - withMinMaxItems0?: [];␊ - };␊ - }␊ - ` - -## arrayOfEnum.js - -> Expected output to match snapshot for e2e test: arrayOfEnum.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface ArrayOfEnum {␊ - namedEnum: NamedEnum[];␊ - tuples?: [] | [string] | [string, NamedEnum2];␊ - }␊ - ␊ - export const enum NamedEnum {␊ - One = 1,␊ - Two = 2,␊ - Three = 3␊ - }␊ - export const enum NamedEnum2 {␊ - One = 1,␊ - Two = 2,␊ - Three = 3␊ - }␊ - ` - -## arrayOfSchema.2.js - -> Expected output to match snapshot for e2e test: arrayOfSchema.2.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export type ArrayOfSchema = {␊ - description: string;␊ - schema: unknown;␊ - /**␊ - * @minItems 1␊ - */␊ - tests: [␊ - {␊ - description: string;␊ - data: unknown;␊ - valid: boolean;␊ - },␊ - ...{␊ - description: string;␊ - data: unknown;␊ - valid: boolean;␊ - }[]␊ - ];␊ - }[];␊ - ` - -## arrayOfSchema.js - -> Expected output to match snapshot for e2e test: arrayOfSchema.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export type Countries = {␊ - id: string;␊ - name: string;␊ - [k: string]: unknown;␊ - }[];␊ - ␊ - export interface ArrayOfSchema {␊ - countries?: Countries;␊ - tuple?:␊ - | []␊ - | [␊ - {␊ - foo?: string;␊ - [k: string]: unknown;␊ - }␊ - ]␊ - | [␊ - {␊ - foo?: string;␊ - [k: string]: unknown;␊ - },␊ - {␊ - bar?: number;␊ - [k: string]: unknown;␊ - }␊ - ];␊ - [k: string]: unknown;␊ - }␊ - ` - -## arrayOfType.js - -> Expected output to match snapshot for e2e test: arrayOfType.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface ArrayOfType {␊ - foo?: string[];␊ - bar?: string[];␊ - baz?: (string | number)[];␊ - moo?: [] | [number] | [number, string];␊ - [k: string]: unknown;␊ - }␊ - ` - -## basics.js - -> Expected output to match snapshot for e2e test: basics.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export type LastName = string;␊ - export type Height = number;␊ - ␊ - export interface ExampleSchema {␊ - firstName: string;␊ - lastName: LastName;␊ - /**␊ - * Age in years␊ - */␊ - age?: number;␊ - height?: Height;␊ - favoriteFoods?: unknown[];␊ - likesDogs?: boolean;␊ - [k: string]: unknown;␊ - }␊ - ` - -## booleanSchema.1.js - -> Expected output to match snapshot for e2e test: booleanSchema.1.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface SchemaWithBooleanSubschemasUnknownAny {␊ - always?: unknown;␊ - never?: never;␊ - [k: string]: unknown;␊ - }␊ - ` - -## booleanSchema.2.js - -> Expected output to match snapshot for e2e test: booleanSchema.2.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface SchemaWithBooleanSubschemas {␊ - always?: any;␊ - never?: never;␊ - [k: string]: any;␊ - }␊ - ` - -## customName.1.js - -> Expected output to match snapshot for e2e test: customName.1.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface FooTitle {␊ - propaaa?: CustomPrefixDefaa;␊ - propaab?: CustomPrefixDefaa;␊ - propbbb?: PropbbbTitle;␊ - [k: string]: unknown;␊ - }␊ - export interface CustomPrefixDefaa {␊ - [k: string]: unknown;␊ - }␊ - export interface PropbbbTitle {␊ - [k: string]: unknown;␊ - }␊ - ` - -## customType.js - -> Expected output to match snapshot for e2e test: customType.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - /**␊ - * Map from number to string␊ - */␊ - export type Foobar = Map;␊ - ␊ - export interface CustomType {␊ - foo?: Set;␊ - /**␊ - * Comparator function␊ - */␊ - bar?: (a: number, b: number) => number;␊ - foobar?: Foobar;␊ - }␊ - ` - -## deep.js - -> Expected output to match snapshot for e2e test: deep.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface Deep {␊ - foo:␊ - | (␊ - | number␊ - | Foo␊ - | Bar␊ - | {␊ - baz?: number;␊ - [k: string]: unknown;␊ - }␊ - )␊ - | Bar;␊ - }␊ - export interface Foo {␊ - a: string;␊ - b: number;␊ - }␊ - export interface Bar {␊ - a: string;␊ - [k: string]: unknown;␊ - }␊ - ` - -## deprecated.js - -> Expected output to match snapshot for e2e test: deprecated.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - /**␊ - * @deprecated␊ - * comment␊ - */␊ - export interface ExampleSchema {␊ - /**␊ - * @deprecated␊ - */␊ - firstName: string;␊ - /**␊ - * @deprecated␊ - * Hi, my name's Doechii, this will be in a comment␊ - */␊ - middleName?: string;␊ - /**␊ - * nested comment␊ - */␊ - lastName?: string;␊ - description?: string;␊ - }␊ - ` - -## disjointType.js - -> Expected output to match snapshot for e2e test: disjointType.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - /**␊ - * My cool schema␊ - */␊ - export interface ExampleSchema {␊ - value: number | string;␊ - anotherValue?: null | string;␊ - nullableStringEnum?: null | ("foo" | "bar");␊ - nullableObj?: null | {␊ - foo: string;␊ - [k: string]: unknown;␊ - };␊ - nullableArrayEnums?: null | ("foo" | "bar")[];␊ - [k: string]: unknown;␊ - }␊ - ` - -## emptyDefinition.js - -> Expected output to match snapshot for e2e test: emptyDefinition.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export type MyInterface = unknown;␊ - ␊ - export interface EmptyDefinition {␊ - [k: string]: MyInterface;␊ - }␊ - ` - -## emptyProperties.js - -> Expected output to match snapshot for e2e test: emptyProperties.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export type B = unknown;␊ - ␊ - export interface EmptyProperties {␊ - a?: unknown;␊ - b?: B;␊ - [k: string]: unknown;␊ - }␊ - ` - -## emptySchema.js - -> Expected output to match snapshot for e2e test: emptySchema.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface EmptySchema {␊ - [k: string]: unknown;␊ - }␊ - ` - -## enum.2.js - -> Expected output to match snapshot for e2e test: enum.2.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface EntityObjectDefinition {␊ - definitions?: {␊ - [k: string]: EntityObject;␊ - };␊ - [k: string]: unknown;␊ - }␊ - /**␊ - * My example entity object definition␊ - *␊ - * This interface was referenced by \`undefined\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^[a-zA-Z0-9_. /]+$".␊ - */␊ - export interface EntityObject {␊ - EntityDataCategory: {␊ - APorpertyName?: EntityDataCategory;␊ - };␊ - [k: string]: unknown;␊ - }␊ - ␊ - export const enum EntityDataCategory {␊ - Table = "TABLE",␊ - Field = "OBJ",␊ - Func = "FUNC"␊ - }␊ - ` - -## enum.3.js - -> Expected output to match snapshot for e2e test: enum.3.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export type InterfaceWithTsEnumNames = InterfaceWithTsEnumNames1;␊ - ␊ - export interface InterfaceWithTsEnumNames1 {␊ - TsEnumNames?: TsEnums;␊ - }␊ - ␊ - export const enum TsEnums {␊ - publish = "publish",␊ - draft = "draft"␊ - }␊ - ` - -## enum.4.js - -> Expected output to match snapshot for e2e test: enum.4.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export type EnumWithJSONLiteral =␊ - | {type: "string"}␊ - | {foo: 3}␊ - | "foo"␊ - | {foo: {bar: "baz"}}␊ - | [2, 3, 4]␊ - | [{foo: [4, 6]}];␊ - ` - -## enum.5.js - -> Expected output to match snapshot for e2e test: enum.5.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface Enum {␊ - stringEnum: StringEnum;␊ - impliedStringEnum: "a" | "b" | "c";␊ - booleanEnum: true;␊ - impliedBooleanEnum: true;␊ - integerEnum: -1 | 0 | 1;␊ - impliedIntegerEnum: -1 | 0 | 1;␊ - }␊ - ␊ - export const enum StringEnum {␊ - a = "a",␊ - b = "b",␊ - c = "c"␊ - }␊ - ` - -## enum.js - -> Expected output to match snapshot for e2e test: enum.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export type EnumFromDefinition = "a" | "b" | "c";␊ - ␊ - export interface Enum {␊ - stringEnum: "a" | "b" | "c";␊ - impliedStringEnum: "a" | "b" | "c";␊ - booleanEnum: true;␊ - impliedBooleanEnum: true;␊ - integerEnum: -1 | 0 | 1;␊ - impliedIntegerEnum: -1 | 0 | 1;␊ - numberEnum?: -1.1 | 0 | 1.2;␊ - namedIntegerEnum?: NamedIntegerEnum;␊ - impliedNamedIntegerEnum: ImpliedNamedIntegerEnum;␊ - impliedHeterogeneousEnum?: -20.1 | null | "foo" | false;␊ - namedIntegerEnumTitle: NamedInteger;␊ - impliedNamedIntegerEnumTitle: ImpliedNamedInteger;␊ - enumThatComesFromADefinition?: EnumFromDefinition;␊ - propertyWithAnEnum?: {␊ - enumThatComesFromADefinition?: EnumFromDefinition;␊ - [k: string]: unknown;␊ - };␊ - }␊ - ␊ - export const enum NamedIntegerEnum {␊ - One = 1,␊ - Two = 2,␊ - Three = 3␊ - }␊ - export const enum ImpliedNamedIntegerEnum {␊ - Four = 4,␊ - Five = 5,␊ - Six = 6␊ - }␊ - export const enum NamedInteger {␊ - One = 1,␊ - Two = 2,␊ - Three = 3␊ - }␊ - export const enum ImpliedNamedInteger {␊ - Four = 4,␊ - Five = 5,␊ - Six = 6␊ - }␊ - ` - -## enumInArray.js - -> Expected output to match snapshot for e2e test: enumInArray.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface EnumInArray {␊ - foo?: KeyNameFromDefinitionItems[];␊ - title?: "foo";␊ - [k: string]: unknown;␊ - }␊ - ␊ - export const enum KeyNameFromDefinitionItems {␊ - BAR = "BAR",␊ - BAZ = "BAZ"␊ - }␊ - ` - -## extends.1a.js - -> Expected output to match snapshot for e2e test: extends.1a.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface Extends extends Base1 {␊ - foo: string;␊ - }␊ - export interface Base1 {␊ - firstName: string;␊ - lastName: string;␊ - }␊ - ` - -## extends.1b.js - -> Expected output to match snapshot for e2e test: extends.1b.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface Extends extends Base1 {␊ - foo: string;␊ - }␊ - ` - -## extends.2a.js - -> Expected output to match snapshot for e2e test: extends.2a.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface Extends extends Base1, Base2 {␊ - foo: string;␊ - }␊ - export interface Base1 {␊ - firstName: string;␊ - lastName: string;␊ - }␊ - export interface Base2 {␊ - age: number;␊ - }␊ - ` - -## extends.2b.js - -> Expected output to match snapshot for e2e test: extends.2b.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface Extends extends Base1, Base2 {␊ - foo: string;␊ - }␊ - ` - -## extends.3.js - -> Expected output to match snapshot for e2e test: extends.3.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - /**␊ - * Any Shape␊ - */␊ - export type Schema = Circle | Square;␊ - ␊ - /**␊ - * A Circle␊ - */␊ - export interface Circle extends Shape {␊ - type: "circle";␊ - radius: number;␊ - }␊ - /**␊ - * A Shape␊ - */␊ - export interface Shape {␊ - type: string;␊ - id: string;␊ - }␊ - /**␊ - * A Square␊ - */␊ - export interface Square extends Shape {␊ - type: "square";␊ - height: number;␊ - width: number;␊ - }␊ - ` - -## intersection.1.js - -> Expected output to match snapshot for e2e test: intersection.1.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export type Intersection = {␊ - a: A;␊ - b: B;␊ - } & (C | D);␊ - ␊ - export interface A {␊ - a: string;␊ - }␊ - export interface B {␊ - b: string;␊ - }␊ - export interface C {␊ - c: string;␊ - }␊ - export interface D {␊ - d: string;␊ - }␊ - ` - -## intersection.2.js - -> Expected output to match snapshot for e2e test: intersection.2.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export type Intersection = (A & B) & {␊ - c: string;␊ - d: string;␊ - /**␊ - * This interface was referenced by \`undefined\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - };␊ - ␊ - export interface A {␊ - a?: string;␊ - [k: string]: unknown;␊ - }␊ - export interface B {␊ - b?: string;␊ - [k: string]: unknown;␊ - }␊ - ` - -## intersection.3.js - -> Expected output to match snapshot for e2e test: intersection.3.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export type Parameter = Parameter1 & {␊ - name: string;␊ - in: string;␊ - description?: string;␊ - required?: boolean;␊ - deprecated?: boolean;␊ - allowEmptyValue?: boolean;␊ - style?: string;␊ - explode?: boolean;␊ - allowReserved?: boolean;␊ - schema?: Schema | Reference;␊ - content?: {␊ - [k: string]: MediaType;␊ - };␊ - example?: unknown;␊ - examples?: {␊ - [k: string]: Example | Reference;␊ - };␊ - /**␊ - * This interface was referenced by \`undefined\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - };␊ - export type Parameter1 = ExampleXORExamples & SchemaXORContent & ParameterLocation;␊ - /**␊ - * Schema and content are mutually exclusive, at least one is required␊ - */␊ - export type SchemaXORContent = {␊ - [k: string]: unknown;␊ - };␊ - /**␊ - * Parameter location␊ - */␊ - export type ParameterLocation =␊ - | {␊ - in?: "path";␊ - style?: "matrix" | "label" | "simple";␊ - required: true;␊ - [k: string]: unknown;␊ - }␊ - | {␊ - in?: "query";␊ - style?: "form" | "spaceDelimited" | "pipeDelimited" | "deepObject";␊ - [k: string]: unknown;␊ - }␊ - | {␊ - in?: "header";␊ - style?: "simple";␊ - [k: string]: unknown;␊ - }␊ - | {␊ - in?: "cookie";␊ - style?: "form";␊ - [k: string]: unknown;␊ - };␊ - export type MediaType = MediaType1 & {␊ - schema?: Schema | Reference;␊ - example?: unknown;␊ - examples?: {␊ - [k: string]: Example | Reference;␊ - };␊ - encoding?: {␊ - [k: string]: Encoding;␊ - };␊ - /**␊ - * This interface was referenced by \`undefined\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - };␊ - export type MediaType1 = ExampleXORExamples;␊ - export type Header = Header1 & {␊ - description?: string;␊ - required?: boolean;␊ - deprecated?: boolean;␊ - allowEmptyValue?: boolean;␊ - style?: "simple";␊ - explode?: boolean;␊ - allowReserved?: boolean;␊ - schema?: Schema | Reference;␊ - content?: {␊ - [k: string]: MediaType1;␊ - };␊ - example?: unknown;␊ - examples?: {␊ - [k: string]: Example | Reference;␊ - };␊ - /**␊ - * This interface was referenced by \`undefined\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - };␊ - export type Header1 = ExampleXORExamples & SchemaXORContent;␊ - export type SecurityScheme =␊ - | APIKeySecurityScheme␊ - | HTTPSecurityScheme␊ - | OAuth2SecurityScheme␊ - | OpenIdConnectSecurityScheme;␊ - export type HTTPSecurityScheme = {␊ - scheme: string;␊ - bearerFormat?: string;␊ - description?: string;␊ - type: "http";␊ - /**␊ - * This interface was referenced by \`undefined\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - } & HTTPSecurityScheme1;␊ - export type HTTPSecurityScheme1 =␊ - | {␊ - scheme?: "bearer";␊ - [k: string]: unknown;␊ - }␊ - | {␊ - scheme?: {␊ - [k: string]: unknown;␊ - };␊ - [k: string]: unknown;␊ - };␊ - ␊ - /**␊ - * Validation schema for OpenAPI Specification 3.0.X.␊ - */␊ - export interface HttpsSpecOpenapisOrgOas30Schema20190402 {␊ - openapi: string;␊ - info: Info;␊ - externalDocs?: ExternalDocumentation;␊ - servers?: Server[];␊ - security?: SecurityRequirement[];␊ - tags?: Tag[];␊ - paths: Paths;␊ - components?: Components;␊ - /**␊ - * This interface was referenced by \`HttpsSpecOpenapisOrgOas30Schema20190402\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - }␊ - export interface Info {␊ - title: string;␊ - description?: string;␊ - termsOfService?: string;␊ - contact?: Contact;␊ - license?: License;␊ - version: string;␊ - /**␊ - * This interface was referenced by \`Info\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - }␊ - export interface Contact {␊ - name?: string;␊ - url?: string;␊ - email?: string;␊ - /**␊ - * This interface was referenced by \`Contact\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - }␊ - export interface License {␊ - name: string;␊ - url?: string;␊ - /**␊ - * This interface was referenced by \`License\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - }␊ - export interface ExternalDocumentation {␊ - description?: string;␊ - url: string;␊ - /**␊ - * This interface was referenced by \`ExternalDocumentation\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - }␊ - export interface Server {␊ - url: string;␊ - description?: string;␊ - variables?: {␊ - [k: string]: ServerVariable;␊ - };␊ - /**␊ - * This interface was referenced by \`Server\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - }␊ - export interface ServerVariable {␊ - enum?: string[];␊ - default: string;␊ - description?: string;␊ - /**␊ - * This interface was referenced by \`ServerVariable\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - }␊ - export interface SecurityRequirement {␊ - [k: string]: string[];␊ - }␊ - export interface Tag {␊ - name: string;␊ - description?: string;␊ - externalDocs?: ExternalDocumentation;␊ - /**␊ - * This interface was referenced by \`Tag\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - }␊ - export interface Paths {}␊ - /**␊ - * This interface was referenced by \`Paths\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^\\/".␊ - */␊ - export interface PathItem {␊ - $ref?: string;␊ - summary?: string;␊ - description?: string;␊ - servers?: Server[];␊ - parameters?: (Parameter | Reference)[];␊ - }␊ - /**␊ - * Example and examples are mutually exclusive␊ - */␊ - export interface ExampleXORExamples {␊ - [k: string]: unknown;␊ - }␊ - export interface Schema {␊ - title?: string;␊ - multipleOf?: number;␊ - maximum?: number;␊ - exclusiveMaximum?: boolean;␊ - minimum?: number;␊ - exclusiveMinimum?: boolean;␊ - maxLength?: number;␊ - minLength?: number;␊ - pattern?: string;␊ - maxItems?: number;␊ - minItems?: number;␊ - uniqueItems?: boolean;␊ - maxProperties?: number;␊ - minProperties?: number;␊ - /**␊ - * @minItems 1␊ - */␊ - required?: [string, ...string[]];␊ - /**␊ - * @minItems 1␊ - */␊ - enum?: [unknown, ...unknown[]];␊ - type?: "array" | "boolean" | "integer" | "number" | "object" | "string";␊ - not?: Schema | Reference;␊ - allOf?: (Schema | Reference)[];␊ - oneOf?: (Schema | Reference)[];␊ - anyOf?: (Schema | Reference)[];␊ - items?: Schema | Reference;␊ - properties?: {␊ - [k: string]: Schema | Reference;␊ - };␊ - additionalProperties?: Schema | Reference | boolean;␊ - description?: string;␊ - format?: string;␊ - default?: unknown;␊ - nullable?: boolean;␊ - discriminator?: Discriminator;␊ - readOnly?: boolean;␊ - writeOnly?: boolean;␊ - example?: unknown;␊ - externalDocs?: ExternalDocumentation;␊ - deprecated?: boolean;␊ - xml?: XML;␊ - /**␊ - * This interface was referenced by \`Schema\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - }␊ - export interface Reference {␊ - /**␊ - * This interface was referenced by \`Reference\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^\\$ref$".␊ - */␊ - [k: string]: string;␊ - }␊ - export interface Discriminator {␊ - propertyName: string;␊ - mapping?: {␊ - [k: string]: string;␊ - };␊ - [k: string]: unknown;␊ - }␊ - export interface XML {␊ - name?: string;␊ - namespace?: string;␊ - prefix?: string;␊ - attribute?: boolean;␊ - wrapped?: boolean;␊ - /**␊ - * This interface was referenced by \`XML\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - }␊ - export interface Example {␊ - summary?: string;␊ - description?: string;␊ - value?: unknown;␊ - externalValue?: string;␊ - /**␊ - * This interface was referenced by \`Example\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - }␊ - export interface Encoding {␊ - contentType?: string;␊ - headers?: {␊ - [k: string]: Header;␊ - };␊ - style?: "form" | "spaceDelimited" | "pipeDelimited" | "deepObject";␊ - explode?: boolean;␊ - allowReserved?: boolean;␊ - }␊ - /**␊ - * This interface was referenced by \`PathItem\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^(get|put|post|delete|options|head|patch|trace)$".␊ - */␊ - export interface Operation {␊ - tags?: string[];␊ - summary?: string;␊ - description?: string;␊ - externalDocs?: ExternalDocumentation;␊ - operationId?: string;␊ - parameters?: (Parameter1 | Reference)[];␊ - requestBody?: RequestBody | Reference;␊ - responses: Responses;␊ - callbacks?: {␊ - [k: string]: Callback | Reference;␊ - };␊ - deprecated?: boolean;␊ - security?: SecurityRequirement[];␊ - servers?: Server[];␊ - /**␊ - * This interface was referenced by \`Operation\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - }␊ - export interface RequestBody {␊ - description?: string;␊ - content: {␊ - [k: string]: MediaType1;␊ - };␊ - required?: boolean;␊ - /**␊ - * This interface was referenced by \`RequestBody\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - }␊ - export interface Responses {␊ - default?: Response | Reference;␊ - }␊ - export interface Response {␊ - description: string;␊ - headers?: {␊ - [k: string]: Header1 | Reference;␊ - };␊ - content?: {␊ - [k: string]: MediaType1;␊ - };␊ - links?: {␊ - [k: string]: Link | Reference;␊ - };␊ - /**␊ - * This interface was referenced by \`Response\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - }␊ - export interface Link {␊ - operationId?: string;␊ - operationRef?: string;␊ - parameters?: {␊ - [k: string]: unknown;␊ - };␊ - requestBody?: unknown;␊ - description?: string;␊ - server?: Server;␊ - /**␊ - * This interface was referenced by \`Link\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - }␊ - export interface Callback {␊ - [k: string]: PathItem;␊ - }␊ - export interface Components {␊ - schemas?: {␊ - /**␊ - * This interface was referenced by \`undefined\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^[a-zA-Z0-9\\.\\-_]+$".␊ - */␊ - [k: string]: Schema | Reference;␊ - };␊ - responses?: {␊ - /**␊ - * This interface was referenced by \`undefined\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^[a-zA-Z0-9\\.\\-_]+$".␊ - */␊ - [k: string]: Reference | Response;␊ - };␊ - parameters?: {␊ - /**␊ - * This interface was referenced by \`undefined\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^[a-zA-Z0-9\\.\\-_]+$".␊ - */␊ - [k: string]: Reference | Parameter1;␊ - };␊ - examples?: {␊ - /**␊ - * This interface was referenced by \`undefined\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^[a-zA-Z0-9\\.\\-_]+$".␊ - */␊ - [k: string]: Reference | Example;␊ - };␊ - requestBodies?: {␊ - /**␊ - * This interface was referenced by \`undefined\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^[a-zA-Z0-9\\.\\-_]+$".␊ - */␊ - [k: string]: Reference | RequestBody;␊ - };␊ - headers?: {␊ - /**␊ - * This interface was referenced by \`undefined\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^[a-zA-Z0-9\\.\\-_]+$".␊ - */␊ - [k: string]: Reference | Header1;␊ - };␊ - securitySchemes?: {␊ - /**␊ - * This interface was referenced by \`undefined\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^[a-zA-Z0-9\\.\\-_]+$".␊ - */␊ - [k: string]: Reference | SecurityScheme;␊ - };␊ - links?: {␊ - /**␊ - * This interface was referenced by \`undefined\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^[a-zA-Z0-9\\.\\-_]+$".␊ - */␊ - [k: string]: Reference | Link;␊ - };␊ - callbacks?: {␊ - /**␊ - * This interface was referenced by \`undefined\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^[a-zA-Z0-9\\.\\-_]+$".␊ - */␊ - [k: string]: Reference | Callback;␊ - };␊ - /**␊ - * This interface was referenced by \`Components\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - }␊ - export interface APIKeySecurityScheme {␊ - type: "apiKey";␊ - name: string;␊ - in: "header" | "query" | "cookie";␊ - description?: string;␊ - /**␊ - * This interface was referenced by \`APIKeySecurityScheme\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - }␊ - export interface OAuth2SecurityScheme {␊ - type: "oauth2";␊ - flows: OAuthFlows;␊ - description?: string;␊ - /**␊ - * This interface was referenced by \`OAuth2SecurityScheme\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - }␊ - export interface OAuthFlows {␊ - implicit?: ImplicitOAuthFlow;␊ - password?: PasswordOAuthFlow;␊ - clientCredentials?: ClientCredentialsFlow;␊ - authorizationCode?: AuthorizationCodeOAuthFlow;␊ - /**␊ - * This interface was referenced by \`OAuthFlows\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - }␊ - export interface ImplicitOAuthFlow {␊ - authorizationUrl: string;␊ - refreshUrl?: string;␊ - scopes: {␊ - [k: string]: string;␊ - };␊ - /**␊ - * This interface was referenced by \`ImplicitOAuthFlow\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - }␊ - export interface PasswordOAuthFlow {␊ - tokenUrl: string;␊ - refreshUrl?: string;␊ - scopes?: {␊ - [k: string]: string;␊ - };␊ - /**␊ - * This interface was referenced by \`PasswordOAuthFlow\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - }␊ - export interface ClientCredentialsFlow {␊ - tokenUrl: string;␊ - refreshUrl?: string;␊ - scopes?: {␊ - [k: string]: string;␊ - };␊ - /**␊ - * This interface was referenced by \`ClientCredentialsFlow\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - }␊ - export interface AuthorizationCodeOAuthFlow {␊ - authorizationUrl: string;␊ - tokenUrl: string;␊ - refreshUrl?: string;␊ - scopes?: {␊ - [k: string]: string;␊ - };␊ - /**␊ - * This interface was referenced by \`AuthorizationCodeOAuthFlow\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - }␊ - export interface OpenIdConnectSecurityScheme {␊ - type: "openIdConnect";␊ - openIdConnectUrl: string;␊ - description?: string;␊ - /**␊ - * This interface was referenced by \`OpenIdConnectSecurityScheme\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - }␊ - ` - -## namedProperty.js - -> Expected output to match snapshot for e2e test: namedProperty.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - /**␊ - * Array of authorized user ids.␊ - */␊ - export type UserIdArray = string[];␊ - ␊ - /**␊ - * My cool schema␊ - */␊ - export interface ExampleSchema {␊ - users?: UserIdArray;␊ - [k: string]: unknown;␊ - }␊ - ` - -## notExtensible.js - -> Expected output to match snapshot for e2e test: notExtensible.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface ExampleSchema {␊ - firstName: string;␊ - lastName: string;␊ - /**␊ - * Age in years␊ - */␊ - age?: number;␊ - }␊ - ` - -## oneOf.js - -> Expected output to match snapshot for e2e test: oneOf.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface OneOf {␊ - foo: Foo | Bar | Baz;␊ - }␊ - export interface Foo {␊ - a: string;␊ - b?: number;␊ - }␊ - export interface Bar {␊ - a?: "a" | "b" | "c";␊ - [k: string]: unknown;␊ - }␊ - export interface Baz {␊ - baz?: Bar;␊ - [k: string]: unknown;␊ - }␊ - ` - -## oneOfWithDupes.js - -> Expected output to match snapshot for e2e test: oneOfWithDupes.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export type C = number;␊ - export type D = number;␊ - ␊ - export interface Test {␊ - a?: A;␊ - b?: A | B;␊ - c?: C | D;␊ - d?: C | D;␊ - e?: D;␊ - f?: A | B | C | D;␊ - [k: string]: unknown;␊ - }␊ - export interface A {␊ - name?: string;␊ - [k: string]: unknown;␊ - }␊ - export interface B {␊ - name?: string;␊ - [k: string]: unknown;␊ - }␊ - ` - -## optimize.2.js - -> Expected output to match snapshot for e2e test: optimize.2.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export type A = string;␊ - ␊ - export interface OptimizableSchema2 {␊ - a: A;␊ - b: B;␊ - c: B | C;␊ - d: {␊ - [k: string]: unknown;␊ - };␊ - e: {␊ - [k: string]: unknown;␊ - };␊ - }␊ - export interface B {␊ - [k: string]: unknown;␊ - }␊ - export interface C {␊ - [k: string]: unknown;␊ - }␊ - ` - -## optimize.js - -> Expected output to match snapshot for e2e test: optimize.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface OptimizableSchema {␊ - bar: string | number;␊ - foo: unknown;␊ - fooBar: A | B;␊ - [k: string]: unknown;␊ - }␊ - ` - -## options.arrayIgnoreMaxMinItems.js - -> Expected output to match snapshot for e2e test: options.arrayIgnoreMaxMinItems.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface ArrayMaxMinItems {␊ - array?: {␊ - /**␊ - * @minItems 3␊ - */␊ - withMinItems?: string[];␊ - /**␊ - * @maxItems 3␊ - */␊ - withMaxItems?: string[];␊ - /**␊ - * @minItems 3␊ - * @maxItems 8␊ - */␊ - withMinMaxItems?: string[];␊ - /**␊ - * @maxItems 0␊ - */␊ - withMaxItems0?: string[];␊ - /**␊ - * @minItems 0␊ - */␊ - withMinItems0?: string[];␊ - /**␊ - * @minItems 0␊ - * @maxItems 0␊ - */␊ - withMinMaxItems0?: string[];␊ - };␊ - untyped?: {␊ - /**␊ - * @minItems 3␊ - */␊ - withMinItems?: unknown[];␊ - /**␊ - * @maxItems 3␊ - */␊ - withMaxItems?: unknown[];␊ - /**␊ - * @minItems 3␊ - * @maxItems 8␊ - */␊ - withMinMaxItems?: unknown[];␊ - /**␊ - * @maxItems 0␊ - */␊ - withMaxItems0?: unknown[];␊ - /**␊ - * @minItems 0␊ - */␊ - withMinItems0?: unknown[];␊ - /**␊ - * @minItems 0␊ - * @maxItems 0␊ - */␊ - withMinMaxItems0?: unknown[];␊ - };␊ - tuple?: {␊ - /**␊ - * @minItems 2␊ - */␊ - withMinItemsLessThanItemLength?: [1, 2, 3, 4, 5, 6];␊ - /**␊ - * @minItems 8␊ - */␊ - withMinItemsGreaterThanItemLength?: [1, 2, 3, 4, 5, 6];␊ - /**␊ - * @maxItems 2␊ - */␊ - withMaxItemsLessThanItemLength?: [1, 2, 3, 4, 5, 6];␊ - /**␊ - * @maxItems 8␊ - */␊ - withMaxItemsGreaterThanItemLength?: [1, 2, 3, 4, 5, 6];␊ - /**␊ - * @minItems 4␊ - * @maxItems 8␊ - */␊ - withMinItemsLessThanItemLength_and_MaxItemsGreaterThanItemLength?: [1, 2, 3, 4, 5, 6];␊ - /**␊ - * @minItems 2␊ - * @maxItems 4␊ - */␊ - withMinItemsLessThanItemLength_and_MaxItemsLessThanItemLength?: [1, 2, 3, 4, 5, 6];␊ - /**␊ - * @minItems 8␊ - * @maxItems 10␊ - */␊ - withMinItemsGreaterThanItemLength_and_MaxItemsGreaterThanItemLength?: [1, 2, 3, 4, 5, 6];␊ - /**␊ - * @maxItems 0␊ - */␊ - withMaxItems0?: [1, 2, 3, 4, 5, 6];␊ - /**␊ - * @minItems 0␊ - */␊ - withMinItems0?: [1, 2, 3, 4, 5, 6];␊ - /**␊ - * @minItems 0␊ - * @maxItems 0␊ - */␊ - withMinMaxItems0?: [1, 2, 3, 4, 5, 6];␊ - };␊ - }␊ - ` - -## options.enableConstEnums.js - -> Expected output to match snapshot for e2e test: options.enableConstEnums.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface Enum {␊ - stringEnum: "a" | "b" | "c";␊ - impliedStringEnum: "a" | "b" | "c";␊ - booleanEnum: true;␊ - impliedBooleanEnum: true;␊ - integerEnum: -1 | 0 | 1;␊ - impliedIntegerEnum: -1 | 0 | 1;␊ - numberEnum?: -1.1 | 0 | 1.2;␊ - namedIntegerEnum?: NamedIntegerEnum;␊ - impliedNamedIntegerEnum: ImpliedNamedIntegerEnum;␊ - impliedHeterogeneousEnum?: -20.1 | null | "foo" | false;␊ - namedIntegerEnumTitle: NamedInteger;␊ - impliedNamedIntegerEnumTitle: ImpliedNamedInteger;␊ - oneOfNamedEnum: IntegerOneOfNamedEnum | StringOneOfNamedEnum;␊ - anyOfNamedEnum: IntegerAnyOfNamedEnum | StringAnyOfNamedEnum;␊ - allOfNamedEnum: IntegerAllOfNamedEnum & StringAllOfNamedEnum;␊ - }␊ - ␊ - export const enum NamedIntegerEnum {␊ - One = 1,␊ - Two = 2,␊ - Three = 3␊ - }␊ - export const enum ImpliedNamedIntegerEnum {␊ - Four = 4,␊ - Five = 5,␊ - Six = 6␊ - }␊ - export const enum NamedInteger {␊ - One = 1,␊ - Two = 2,␊ - Three = 3␊ - }␊ - export const enum ImpliedNamedInteger {␊ - Four = 4,␊ - Five = 5,␊ - Six = 6␊ - }␊ - export const enum IntegerOneOfNamedEnum {␊ - One = 1,␊ - Two = 2,␊ - Three = 3␊ - }␊ - export const enum StringOneOfNamedEnum {␊ - Four = "four",␊ - Five = "five",␊ - Six = "six"␊ - }␊ - export const enum IntegerAnyOfNamedEnum {␊ - One = 1,␊ - Two = 2,␊ - Three = 3␊ - }␊ - export const enum StringAnyOfNamedEnum {␊ - Four = "four",␊ - Five = "five",␊ - Six = "six"␊ - }␊ - export const enum IntegerAllOfNamedEnum {␊ - One = 1,␊ - Two = 2,␊ - Three = 3␊ - }␊ - export const enum StringAllOfNamedEnum {␊ - Four = "four",␊ - Five = "five",␊ - Six = "six"␊ - }␊ - ` - -## options.format.js - -> Expected output to match snapshot for e2e test: options.format.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export type LastName = string␊ - ␊ - export interface ExampleSchema {␊ - firstName: string␊ - lastName: LastName␊ - [k: string]: unknown␊ - }␊ - ` - -## options.strictIndexSignatures.js - -> Expected output to match snapshot for e2e test: options.strictIndexSignatures.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface StrictIndexSignatures {␊ - maybe?: string;␊ - complex?: {␊ - maybe?: string;␊ - [k: string]: Leaf | undefined;␊ - };␊ - [k: string]: string | undefined;␊ - }␊ - export interface Leaf {␊ - maybe?: string;␊ - [k: string]: unknown;␊ - }␊ - ` - -## options.style.js - -> Expected output to match snapshot for e2e test: options.style.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export type LastName = string␊ - ␊ - export interface ExampleSchema {␊ - firstName: string␊ - lastName: LastName␊ - [k: string]: unknown␊ - }␊ - ` - -## options.unreachableDefinitions.js - -> Expected output to match snapshot for e2e test: options.unreachableDefinitions.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export type LastName = string;␊ - ␊ - export interface UnreachableDefinition {␊ - b?: {␊ - likesDogs?: boolean;␊ - [k: string]: unknown;␊ - };␊ - [k: string]: unknown;␊ - }␊ - /**␊ - * This interface was referenced by \`UnreachableDefinition\`'s JSON-Schema␊ - * via the \`definition\` "a".␊ - */␊ - export interface A {␊ - firstName?: string;␊ - lastName?: LastName;␊ - [k: string]: unknown;␊ - }␊ - ` - -## patternProperties.1.js - -> Expected output to match snapshot for e2e test: patternProperties.1.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface Parent {␊ - [k: string]: Child;␊ - }␊ - /**␊ - * This interface was referenced by \`Parent\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^[a-zA-Z]+".␊ - */␊ - export interface Child {␊ - aProperty?: string;␊ - [k: string]: unknown;␊ - }␊ - ` - -## patternProperties.2.js - -> Expected output to match snapshot for e2e test: patternProperties.2.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface Parent {␊ - a?: number;␊ - b?: string;␊ - [k: string]: Child;␊ - }␊ - /**␊ - * This interface was referenced by \`Parent\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^[a-zA-Z]+".␊ - */␊ - export interface Child {␊ - aProperty?: string;␊ - [k: string]: unknown;␊ - }␊ - ` - -## patternProperties.3.js - -> Expected output to match snapshot for e2e test: patternProperties.3.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface Parent {␊ - [k: string]: Child;␊ - }␊ - /**␊ - * This interface was referenced by \`Parent\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^[a-zA-Z]+".␊ - */␊ - export interface Child {␊ - aProperty?: string;␊ - [k: string]: unknown;␊ - }␊ - ` - -## patternProperties.4.js - -> Expected output to match snapshot for e2e test: patternProperties.4.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - /**␊ - * This interface was referenced by \`Parent\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^[0-9]+".␊ - */␊ - export type NumberChild = number;␊ - /**␊ - * This interface was referenced by \`Parent\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^[a-zA-Z]+".␊ - */␊ - export type StringChild = string;␊ - ␊ - export interface Parent {}␊ - ` - -## patternProperties.5.js - -> Expected output to match snapshot for e2e test: patternProperties.5.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - /**␊ - * This interface was referenced by \`Parent\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^[0-9]+".␊ - */␊ - export type NumberChild = number;␊ - /**␊ - * This interface was referenced by \`Parent\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^[a-zA-Z]+".␊ - */␊ - export type StringChild = string;␊ - ␊ - export interface Parent {␊ - [k: string]: unknown;␊ - }␊ - ` - -## patternProperties.6.js - -> Expected output to match snapshot for e2e test: patternProperties.6.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - /**␊ - * This interface was referenced by \`Parent\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^[a-zA-Z]+".␊ - */␊ - export type StringChild = string;␊ - ␊ - export interface Parent {␊ - [k: string]: number;␊ - }␊ - ` - -## patternProperties.7.js - -> Expected output to match snapshot for e2e test: patternProperties.7.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface PatternProperties {␊ - /**␊ - * This interface was referenced by \`PatternProperties\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^[a-z][a-z0-9-]*\\/[a-z][a-z0-9-]*$".␊ - */␊ - [k: string]: string;␊ - }␊ - ` - -## patternProperties.8.js - -> Expected output to match snapshot for e2e test: patternProperties.8.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface PatternProperties {␊ - /**␊ - * This interface was referenced by \`PatternProperties\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^[a-z][a-z0-9-]/*[a-z][a-z0-9-]*$".␊ - */␊ - [k: string]: string;␊ - }␊ - ` - -## realWorld.awsQuicksight.js - -> Expected output to match snapshot for e2e test: realWorld.awsQuicksight.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export type GeoSpatialCountryCode = "US";␊ - export type DataSetImportMode = "SPICE" | "DIRECT_QUERY";␊ - export type GeoSpatialDataRole =␊ - | "COUNTRY"␊ - | "STATE"␊ - | "COUNTY"␊ - | "CITY"␊ - | "POSTCODE"␊ - | "LONGITUDE"␊ - | "LATITUDE"␊ - | "POLITICAL1";␊ - export type ColumnDataType = "STRING" | "INTEGER" | "DECIMAL" | "DATETIME";␊ - export type JoinType = "INNER" | "OUTER" | "LEFT" | "RIGHT";␊ - export type InputColumnDataType = "STRING" | "INTEGER" | "DECIMAL" | "DATETIME" | "BIT" | "BOOLEAN" | "JSON";␊ - export type TextQualifier = "DOUBLE_QUOTE" | "SINGLE_QUOTE";␊ - export type FileFormat = "CSV" | "TSV" | "CLF" | "ELF" | "XLSX" | "JSON";␊ - export type RowLevelPermissionPolicy = "GRANT_ACCESS" | "DENY_ACCESS";␊ - export type RowLevelPermissionFormatVersion = "VERSION_1" | "VERSION_2";␊ - ␊ - /**␊ - * Definition of the AWS::QuickSight::DataSet Resource Type.␊ - */␊ - export interface RealWorld {␊ - /**␊ - *

The Amazon Resource Name (ARN) of the resource.

␊ - */␊ - Arn?: string;␊ - AwsAccountId?: string;␊ - /**␊ - *

Groupings of columns that work together in certain QuickSight features. Currently, only geospatial hierarchy is supported.

␊ - *␊ - * @minItems 1␊ - * @maxItems 8␊ - */␊ - ColumnGroups?:␊ - | [ColumnGroup]␊ - | [ColumnGroup, ColumnGroup]␊ - | [ColumnGroup, ColumnGroup, ColumnGroup]␊ - | [ColumnGroup, ColumnGroup, ColumnGroup, ColumnGroup]␊ - | [ColumnGroup, ColumnGroup, ColumnGroup, ColumnGroup, ColumnGroup]␊ - | [ColumnGroup, ColumnGroup, ColumnGroup, ColumnGroup, ColumnGroup, ColumnGroup]␊ - | [ColumnGroup, ColumnGroup, ColumnGroup, ColumnGroup, ColumnGroup, ColumnGroup, ColumnGroup]␊ - | [ColumnGroup, ColumnGroup, ColumnGroup, ColumnGroup, ColumnGroup, ColumnGroup, ColumnGroup, ColumnGroup];␊ - /**␊ - * @minItems 1␊ - */␊ - ColumnLevelPermissionRules?: [ColumnLevelPermissionRule, ...ColumnLevelPermissionRule[]];␊ - /**␊ - *

The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't␊ - * imported into SPICE.

␊ - */␊ - ConsumedSpiceCapacityInBytes?: number;␊ - /**␊ - *

The time that this dataset was created.

␊ - */␊ - CreatedTime?: string;␊ - DataSetId?: string;␊ - FieldFolders?: FieldFolderMap;␊ - ImportMode?: DataSetImportMode;␊ - /**␊ - *

The last time that this dataset was updated.

␊ - */␊ - LastUpdatedTime?: string;␊ - LogicalTableMap?: LogicalTableMap;␊ - /**␊ - *

The display name for the dataset.

␊ - */␊ - Name?: string;␊ - /**␊ - *

The list of columns after all transforms. These columns are available in templates,␊ - * analyses, and dashboards.

␊ - */␊ - OutputColumns?: OutputColumn[];␊ - /**␊ - *

A list of resource permissions on the dataset.

␊ - *␊ - * @minItems 1␊ - * @maxItems 64␊ - */␊ - Permissions?: [ResourcePermission, ...ResourcePermission[]];␊ - PhysicalTableMap?: PhysicalTableMap;␊ - RowLevelPermissionDataSet?: RowLevelPermissionDataSet;␊ - /**␊ - *

Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.

␊ - *␊ - * @minItems 1␊ - * @maxItems 200␊ - */␊ - Tags?: [Tag, ...Tag[]];␊ - IngestionWaitPolicy?: IngestionWaitPolicy;␊ - }␊ - /**␊ - *

Groupings of columns that work together in certain Amazon QuickSight features. This is␊ - * a variant type structure. For this structure to be valid, only one of the attributes can␊ - * be non-null.

␊ - */␊ - export interface ColumnGroup {␊ - GeoSpatialColumnGroup?: GeoSpatialColumnGroup;␊ - [k: string]: unknown;␊ - }␊ - /**␊ - *

Geospatial column group that denotes a hierarchy.

␊ - */␊ - export interface GeoSpatialColumnGroup {␊ - /**␊ - *

Columns in this hierarchy.

␊ - *␊ - * @minItems 1␊ - * @maxItems 16␊ - */␊ - Columns:␊ - | [string]␊ - | [string, string]␊ - | [string, string, string]␊ - | [string, string, string, string]␊ - | [string, string, string, string, string]␊ - | [string, string, string, string, string, string]␊ - | [string, string, string, string, string, string, string]␊ - | [string, string, string, string, string, string, string, string]␊ - | [string, string, string, string, string, string, string, string, string]␊ - | [string, string, string, string, string, string, string, string, string, string]␊ - | [string, string, string, string, string, string, string, string, string, string, string]␊ - | [string, string, string, string, string, string, string, string, string, string, string, string]␊ - | [string, string, string, string, string, string, string, string, string, string, string, string, string]␊ - | [string, string, string, string, string, string, string, string, string, string, string, string, string, string]␊ - | [␊ - string,␊ - string,␊ - string,␊ - string,␊ - string,␊ - string,␊ - string,␊ - string,␊ - string,␊ - string,␊ - string,␊ - string,␊ - string,␊ - string,␊ - string␊ - ]␊ - | [␊ - string,␊ - string,␊ - string,␊ - string,␊ - string,␊ - string,␊ - string,␊ - string,␊ - string,␊ - string,␊ - string,␊ - string,␊ - string,␊ - string,␊ - string,␊ - string␊ - ];␊ - CountryCode?: GeoSpatialCountryCode;␊ - /**␊ - *

A display name for the hierarchy.

␊ - */␊ - Name: string;␊ - [k: string]: unknown;␊ - }␊ - export interface ColumnLevelPermissionRule {␊ - /**␊ - * @minItems 1␊ - */␊ - ColumnNames?: [string, ...string[]];␊ - /**␊ - * @minItems 1␊ - * @maxItems 100␊ - */␊ - Principals?: [string, ...string[]];␊ - [k: string]: unknown;␊ - }␊ - export interface FieldFolderMap {␊ - [k: string]: FieldFolder;␊ - }␊ - /**␊ - * This interface was referenced by \`FieldFolderMap\`'s JSON-Schema definition␊ - * via the \`patternProperty\` ".+".␊ - */␊ - export interface FieldFolder {␊ - Description?: string;␊ - /**␊ - * @minItems 0␊ - * @maxItems 5000␊ - */␊ - Columns?: string[];␊ - [k: string]: unknown;␊ - }␊ - export interface LogicalTableMap {␊ - [k: string]: LogicalTable;␊ - }␊ - /**␊ - *

A logical table is a unit that joins and that data␊ - * transformations operate on. A logical table has a source, which can be either a physical␊ - * table or result of a join. When a logical table points to a physical table, the logical␊ - * table acts as a mutable copy of that physical table through transform operations.

␊ - *␊ - * This interface was referenced by \`LogicalTableMap\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "[0-9a-zA-Z-]*".␊ - */␊ - export interface LogicalTable {␊ - /**␊ - *

A display name for the logical table.

␊ - */␊ - Alias: string;␊ - /**␊ - *

Transform operations that act on this logical table.

␊ - *␊ - * @minItems 1␊ - * @maxItems 2048␊ - */␊ - DataTransforms?: [TransformOperation, ...TransformOperation[]];␊ - Source: LogicalTableSource;␊ - [k: string]: unknown;␊ - }␊ - /**␊ - *

A data transformation on a logical table. This is a variant type structure. For this␊ - * structure to be valid, only one of the attributes can be non-null.

␊ - */␊ - export interface TransformOperation {␊ - TagColumnOperation?: TagColumnOperation;␊ - FilterOperation?: FilterOperation;␊ - CastColumnTypeOperation?: CastColumnTypeOperation;␊ - CreateColumnsOperation?: CreateColumnsOperation;␊ - RenameColumnOperation?: RenameColumnOperation;␊ - ProjectOperation?: ProjectOperation;␊ - [k: string]: unknown;␊ - }␊ - /**␊ - *

A transform operation that tags a column with additional information.

␊ - */␊ - export interface TagColumnOperation {␊ - /**␊ - *

The column that this operation acts on.

␊ - */␊ - ColumnName: string;␊ - /**␊ - *

The dataset column tag, currently only used for geospatial type tagging. .

␊ - * ␊ - *

This is not tags for the AWS tagging feature. .

␊ - * ␊ - *␊ - * @minItems 1␊ - * @maxItems 16␊ - */␊ - Tags:␊ - | [ColumnTag]␊ - | [ColumnTag, ColumnTag]␊ - | [ColumnTag, ColumnTag, ColumnTag]␊ - | [ColumnTag, ColumnTag, ColumnTag, ColumnTag]␊ - | [ColumnTag, ColumnTag, ColumnTag, ColumnTag, ColumnTag]␊ - | [ColumnTag, ColumnTag, ColumnTag, ColumnTag, ColumnTag, ColumnTag]␊ - | [ColumnTag, ColumnTag, ColumnTag, ColumnTag, ColumnTag, ColumnTag, ColumnTag]␊ - | [ColumnTag, ColumnTag, ColumnTag, ColumnTag, ColumnTag, ColumnTag, ColumnTag, ColumnTag]␊ - | [ColumnTag, ColumnTag, ColumnTag, ColumnTag, ColumnTag, ColumnTag, ColumnTag, ColumnTag, ColumnTag]␊ - | [ColumnTag, ColumnTag, ColumnTag, ColumnTag, ColumnTag, ColumnTag, ColumnTag, ColumnTag, ColumnTag, ColumnTag]␊ - | [␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag␊ - ]␊ - | [␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag␊ - ]␊ - | [␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag␊ - ]␊ - | [␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag␊ - ]␊ - | [␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag␊ - ]␊ - | [␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag,␊ - ColumnTag␊ - ];␊ - [k: string]: unknown;␊ - }␊ - /**␊ - *

A tag for a column in a TagColumnOperation structure. This is a␊ - * variant type structure. For this structure to be valid, only one of the attributes can␊ - * be non-null.

␊ - */␊ - export interface ColumnTag {␊ - ColumnGeographicRole?: GeoSpatialDataRole;␊ - ColumnDescription?: ColumnDescription;␊ - [k: string]: unknown;␊ - }␊ - /**␊ - *

Metadata that contains a description for a column.

␊ - */␊ - export interface ColumnDescription {␊ - /**␊ - *

The text of a description for a column.

␊ - */␊ - Text?: string;␊ - [k: string]: unknown;␊ - }␊ - /**␊ - *

A transform operation that filters rows based on a condition.

␊ - */␊ - export interface FilterOperation {␊ - /**␊ - *

An expression that must evaluate to a Boolean value. Rows for which the expression␊ - * evaluates to true are kept in the dataset.

␊ - */␊ - ConditionExpression: string;␊ - [k: string]: unknown;␊ - }␊ - /**␊ - *

A transform operation that casts a column to a different type.

␊ - */␊ - export interface CastColumnTypeOperation {␊ - /**␊ - *

Column name.

␊ - */␊ - ColumnName: string;␊ - /**␊ - *

When casting a column from string to datetime type, you can supply a string in a␊ - * format supported by Amazon QuickSight to denote the source data format.

␊ - */␊ - Format?: string;␊ - NewColumnType: ColumnDataType;␊ - [k: string]: unknown;␊ - }␊ - /**␊ - *

A transform operation that creates calculated columns. Columns created in one such␊ - * operation form a lexical closure.

␊ - */␊ - export interface CreateColumnsOperation {␊ - /**␊ - *

Calculated columns to create.

␊ - *␊ - * @minItems 1␊ - * @maxItems 128␊ - */␊ - Columns: [CalculatedColumn, ...CalculatedColumn[]];␊ - [k: string]: unknown;␊ - }␊ - /**␊ - *

A calculated column for a dataset.

␊ - */␊ - export interface CalculatedColumn {␊ - /**␊ - *

A unique ID to identify a calculated column. During a dataset update, if the column ID␊ - * of a calculated column matches that of an existing calculated column, Amazon QuickSight␊ - * preserves the existing calculated column.

␊ - */␊ - ColumnId: string;␊ - /**␊ - *

Column name.

␊ - */␊ - ColumnName: string;␊ - /**␊ - *

An expression that defines the calculated column.

␊ - */␊ - Expression: string;␊ - [k: string]: unknown;␊ - }␊ - /**␊ - *

A transform operation that renames a column.

␊ - */␊ - export interface RenameColumnOperation {␊ - /**␊ - *

The new name for the column.

␊ - */␊ - NewColumnName: string;␊ - /**␊ - *

The name of the column to be renamed.

␊ - */␊ - ColumnName: string;␊ - [k: string]: unknown;␊ - }␊ - /**␊ - *

A transform operation that projects columns. Operations that come after a projection␊ - * can only refer to projected columns.

␊ - */␊ - export interface ProjectOperation {␊ - /**␊ - *

Projected columns.

␊ - *␊ - * @minItems 1␊ - * @maxItems 2000␊ - */␊ - ProjectedColumns: [string, ...string[]];␊ - [k: string]: unknown;␊ - }␊ - /**␊ - *

Information about the source of a logical table. This is a variant type structure. For␊ - * this structure to be valid, only one of the attributes can be non-null.

␊ - */␊ - export interface LogicalTableSource {␊ - /**␊ - *

Physical table ID.

␊ - */␊ - PhysicalTableId?: string;␊ - JoinInstruction?: JoinInstruction;␊ - [k: string]: unknown;␊ - }␊ - /**␊ - *

Join instruction.

␊ - */␊ - export interface JoinInstruction {␊ - /**␊ - *

On Clause.

␊ - */␊ - OnClause: string;␊ - Type: JoinType;␊ - LeftJoinKeyProperties?: JoinKeyProperties;␊ - /**␊ - *

Left operand.

␊ - */␊ - LeftOperand: string;␊ - /**␊ - *

Right operand.

␊ - */␊ - RightOperand: string;␊ - RightJoinKeyProperties?: JoinKeyProperties;␊ - [k: string]: unknown;␊ - }␊ - export interface JoinKeyProperties {␊ - UniqueKey?: boolean;␊ - [k: string]: unknown;␊ - }␊ - /**␊ - *

Output column.

␊ - */␊ - export interface OutputColumn {␊ - Type?: ColumnDataType;␊ - /**␊ - *

A description for a column.

␊ - */␊ - Description?: string;␊ - /**␊ - *

A display name for the dataset.

␊ - */␊ - Name?: string;␊ - [k: string]: unknown;␊ - }␊ - /**␊ - *

Permission for the resource.

␊ - */␊ - export interface ResourcePermission {␊ - /**␊ - *

The IAM action to grant or revoke permissions on.

␊ - *␊ - * @minItems 1␊ - * @maxItems 16␊ - */␊ - Actions:␊ - | [string]␊ - | [string, string]␊ - | [string, string, string]␊ - | [string, string, string, string]␊ - | [string, string, string, string, string]␊ - | [string, string, string, string, string, string]␊ - | [string, string, string, string, string, string, string]␊ - | [string, string, string, string, string, string, string, string]␊ - | [string, string, string, string, string, string, string, string, string]␊ - | [string, string, string, string, string, string, string, string, string, string]␊ - | [string, string, string, string, string, string, string, string, string, string, string]␊ - | [string, string, string, string, string, string, string, string, string, string, string, string]␊ - | [string, string, string, string, string, string, string, string, string, string, string, string, string]␊ - | [string, string, string, string, string, string, string, string, string, string, string, string, string, string]␊ - | [␊ - string,␊ - string,␊ - string,␊ - string,␊ - string,␊ - string,␊ - string,␊ - string,␊ - string,␊ - string,␊ - string,␊ - string,␊ - string,␊ - string,␊ - string␊ - ]␊ - | [␊ - string,␊ - string,␊ - string,␊ - string,␊ - string,␊ - string,␊ - string,␊ - string,␊ - string,␊ - string,␊ - string,␊ - string,␊ - string,␊ - string,␊ - string,␊ - string␊ - ];␊ - /**␊ - *

The Amazon Resource Name (ARN) of the principal. This can be one of the␊ - * following:

␊ - *
    ␊ - *
  • ␊ - *

    The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

    ␊ - *
    • ␊ - *
  • ␊ - *

    The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)

    ␊ - *
    • ␊ - *
  • ␊ - *

    The ARN of an AWS account root: This is an IAM ARN rather than a QuickSight␊ - * ARN. Use this option only to share resources (templates) across AWS accounts.␊ - * (This is less common.)

    ␊ - *
    • ␊ - *
␊ - */␊ - Principal: string;␊ - [k: string]: unknown;␊ - }␊ - export interface PhysicalTableMap {␊ - [k: string]: PhysicalTable;␊ - }␊ - /**␊ - *

A view of a data source that contains information about the shape of the data in the␊ - * underlying source. This is a variant type structure. For this structure to be valid,␊ - * only one of the attributes can be non-null.

␊ - *␊ - * This interface was referenced by \`PhysicalTableMap\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "[0-9a-zA-Z-]*".␊ - */␊ - export interface PhysicalTable {␊ - RelationalTable?: RelationalTable;␊ - CustomSql?: CustomSql;␊ - S3Source?: S3Source;␊ - [k: string]: unknown;␊ - }␊ - /**␊ - *

A physical table type for relational data sources.

␊ - */␊ - export interface RelationalTable {␊ - /**␊ - *

The Amazon Resource Name (ARN) for the data source.

␊ - */␊ - DataSourceArn: string;␊ - /**␊ - *

The column schema of the table.

␊ - *␊ - * @minItems 1␊ - * @maxItems 2048␊ - */␊ - InputColumns: [InputColumn, ...InputColumn[]];␊ - /**␊ - *

The schema name. This name applies to certain relational database engines.

␊ - */␊ - Schema?: string;␊ - /**␊ - *

The catalog associated with a table.

␊ - */␊ - Catalog?: string;␊ - /**␊ - *

The name of the relational table.

␊ - */␊ - Name: string;␊ - [k: string]: unknown;␊ - }␊ - /**␊ - *

Metadata for a column that is used as the input of a transform operation.

␊ - */␊ - export interface InputColumn {␊ - Type: InputColumnDataType;␊ - /**␊ - *

The name of this column in the underlying data source.

␊ - */␊ - Name: string;␊ - [k: string]: unknown;␊ - }␊ - /**␊ - *

A physical table type built from the results of the custom SQL query.

␊ - */␊ - export interface CustomSql {␊ - /**␊ - *

The Amazon Resource Name (ARN) of the data source.

␊ - */␊ - DataSourceArn: string;␊ - /**␊ - *

The SQL query.

␊ - */␊ - SqlQuery: string;␊ - /**␊ - *

The column schema from the SQL query result set.

␊ - *␊ - * @minItems 1␊ - * @maxItems 2048␊ - */␊ - Columns: [InputColumn, ...InputColumn[]];␊ - /**␊ - *

A display name for the SQL query result.

␊ - */␊ - Name: string;␊ - [k: string]: unknown;␊ - }␊ - /**␊ - *

A physical table type for as S3 data source.

␊ - */␊ - export interface S3Source {␊ - /**␊ - *

The amazon Resource Name (ARN) for the data source.

␊ - */␊ - DataSourceArn: string;␊ - /**␊ - *

A physical table type for as S3 data source.

␊ - *␊ - * @minItems 1␊ - * @maxItems 2048␊ - */␊ - InputColumns: [InputColumn, ...InputColumn[]];␊ - UploadSettings?: UploadSettings;␊ - [k: string]: unknown;␊ - }␊ - /**␊ - *

Information about the format for a source file or files.

␊ - */␊ - export interface UploadSettings {␊ - /**␊ - *

Whether the file has a header row, or the files each have a header row.

␊ - */␊ - ContainsHeader?: boolean;␊ - TextQualifier?: TextQualifier;␊ - Format?: FileFormat;␊ - /**␊ - *

A row number to start reading data from.

␊ - */␊ - StartFromRow?: number;␊ - /**␊ - *

The delimiter between values in the file.

␊ - */␊ - Delimiter?: string;␊ - [k: string]: unknown;␊ - }␊ - /**␊ - *

The row-level security configuration for the dataset.

␊ - */␊ - export interface RowLevelPermissionDataSet {␊ - /**␊ - *

The Amazon Resource Name (ARN) of the permission dataset.

␊ - */␊ - Arn: string;␊ - /**␊ - *

The namespace associated with the row-level permissions dataset.

␊ - */␊ - Namespace?: string;␊ - PermissionPolicy: RowLevelPermissionPolicy;␊ - FormatVersion?: RowLevelPermissionFormatVersion;␊ - [k: string]: unknown;␊ - }␊ - /**␊ - *

The key or keys of the key-value pairs for the resource tag or tags assigned to the␊ - * resource.

␊ - */␊ - export interface Tag {␊ - /**␊ - *

Tag value.

␊ - */␊ - Value: string;␊ - /**␊ - *

Tag key.

␊ - */␊ - Key: string;␊ - [k: string]: unknown;␊ - }␊ - /**␊ - *

Wait policy to use when creating/updating dataset. Default is to wait for SPICE ingestion to finish with timeout of 36 hours.

␊ - */␊ - export interface IngestionWaitPolicy {␊ - /**␊ - *

Wait for SPICE ingestion to finish to mark dataset creation/update successful. Default (true).␊ - * Applicable only when DataSetImportMode mode is set to SPICE.

␊ - */␊ - WaitForSpiceIngestion?: boolean;␊ - /**␊ - *

The maximum time (in hours) to wait for Ingestion to complete. Default timeout is 36 hours.␊ - * Applicable only when DataSetImportMode mode is set to SPICE and WaitForSpiceIngestion is set to true.

␊ - */␊ - IngestionWaitTimeInHours?: number;␊ - [k: string]: unknown;␊ - }␊ - ` - -## realWorld.azureDeploymentTemplate.js - -> Expected output to match snapshot for e2e test: realWorld.azureDeploymentTemplate.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - /**␊ - * Default value to be used if one is not provided␊ - */␊ - export type ParameterValueTypes = (string | boolean | number | {␊ - [k: string]: unknown␊ - } | unknown[] | null)␊ - /**␊ - * Value assigned for function output␊ - */␊ - export type ParameterValueTypes1 = (string | boolean | number | {␊ - [k: string]: unknown␊ - } | unknown[] | null)␊ - /**␊ - * Collection of resource schemas␊ - */␊ - export type Resource = ((ResourceBase & (Services | ConfigurationStores | Services1 | Accounts | FrontDoorWebApplicationFirewallPolicies | FrontDoors | FrontDoors1 | FrontDoorWebApplicationFirewallPolicies1 | NetworkExperimentProfiles | NetworkExperimentProfiles_Experiments | FrontDoors2 | FrontDoorsRulesEngines | Redis | RedisFirewallRules | RedisLinkedServers | RedisPatchSchedules | SearchServices | Servers | Servers1 | Vaults | Vaults1 | VaultsCertificates | VaultsExtendedInformation | DatabaseAccounts | DatabaseAccountsApisDatabases | DatabaseAccountsApisDatabasesCollections | DatabaseAccountsApisDatabasesContainers | DatabaseAccountsApisDatabasesGraphs | DatabaseAccountsApisKeyspaces | DatabaseAccountsApisKeyspacesTables | DatabaseAccountsApisTables | DatabaseAccountsApisDatabasesCollectionsSettings | DatabaseAccountsApisDatabasesContainersSettings | DatabaseAccountsApisDatabasesGraphsSettings | DatabaseAccountsApisKeyspacesSettings | DatabaseAccountsApisKeyspacesTablesSettings | DatabaseAccountsApisTablesSettings | VaultsSecrets | Vaults2 | Vaults3 | VaultsAccessPolicies | VaultsSecrets1 | Vaults4 | VaultsAccessPolicies1 | VaultsPrivateEndpointConnections | VaultsSecrets2 | Vaults5 | VaultsAccessPolicies2 | VaultsSecrets3 | Vaults6 | VaultsAccessPolicies3 | VaultsKeys | VaultsPrivateEndpointConnections1 | VaultsSecrets4 | ManagedHSMs | Vaults7 | VaultsAccessPolicies4 | VaultsPrivateEndpointConnections2 | VaultsSecrets5 | Labs | LabsArtifactsources | LabsCustomimages | LabsFormulas | LabsPolicysetsPolicies | LabsSchedules | LabsVirtualmachines | LabsVirtualnetworks | LabsCosts | LabsNotificationchannels | LabsServicerunners | LabsUsers | LabsVirtualmachinesSchedules | LabsUsersDisks | LabsUsersEnvironments | LabsUsersSecrets | VaultsReplicationAlertSettings | VaultsReplicationFabrics | VaultsReplicationFabricsReplicationNetworksReplicationNetworkMappings | VaultsReplicationFabricsReplicationProtectionContainers | VaultsReplicationFabricsReplicationProtectionContainersReplicationMigrationItems | VaultsReplicationFabricsReplicationProtectionContainersReplicationProtectedItems | VaultsReplicationFabricsReplicationProtectionContainersReplicationProtectionContainerMappings | VaultsReplicationFabricsReplicationRecoveryServicesProviders | VaultsReplicationFabricsReplicationStorageClassificationsReplicationStorageClassificationMappings | VaultsReplicationFabricsReplicationvCenters | VaultsReplicationPolicies | VaultsReplicationRecoveryPlans | DigitalTwinsInstances | DigitalTwinsInstancesEndpoints | Labs1 | LabsVirtualmachines1 | Clusters | ClustersDatabases | Clusters1 | ClustersDatabases1 | Clusters2 | ClustersDatabases2 | ClustersDatabasesDataConnections | Clusters3 | ClustersDatabases3 | ClustersDatabasesDataConnections1 | Clusters4 | ClustersDatabases4 | ClustersDatabasesDataConnections2 | ClustersAttachedDatabaseConfigurations | Clusters5 | ClustersDatabases5 | ClustersDatabasesDataConnections3 | ClustersAttachedDatabaseConfigurations1 | ClustersDataConnections | ClustersPrincipalAssignments | ClustersDatabasesPrincipalAssignments | Clusters6 | ClustersDatabases6 | ClustersDatabasesDataConnections4 | ClustersAttachedDatabaseConfigurations2 | ClustersDataConnections1 | ClustersPrincipalAssignments1 | ClustersDatabasesPrincipalAssignments1 | Clusters7 | ClustersDatabases7 | ClustersDatabasesDataConnections5 | ClustersAttachedDatabaseConfigurations3 | ClustersDataConnections2 | ClustersPrincipalAssignments2 | ClustersDatabasesPrincipalAssignments2 | Clusters8 | ClustersDatabases8 | ClustersDatabasesDataConnections6 | ClustersAttachedDatabaseConfigurations4 | ClustersDataConnections3 | ClustersPrincipalAssignments3 | ClustersDatabasesPrincipalAssignments3 | Redis1 | NamespacesNotificationHubs | NamespacesNotificationHubs_AuthorizationRules | Redis2 | TrafficManagerProfiles | TrafficManagerProfiles1 | TrafficManagerProfiles2 | TrafficManagerProfiles3 | StorageAccounts | StorageAccounts1 | StorageAccounts2 | StorageAccounts3 | StorageAccounts4 | StorageAccountsBlobServicesContainers | StorageAccountsBlobServicesContainersImmutabilityPolicies | StorageAccounts5 | StorageAccountsManagementPolicies | StorageAccountsBlobServicesContainers1 | StorageAccountsBlobServicesContainersImmutabilityPolicies1 | StorageAccounts6 | StorageAccountsBlobServices | StorageAccountsBlobServicesContainers2 | StorageAccountsBlobServicesContainersImmutabilityPolicies2 | StorageAccounts7 | StorageAccountsBlobServices1 | StorageAccountsBlobServicesContainers3 | StorageAccountsBlobServicesContainersImmutabilityPolicies3 | StorageAccountsManagementPolicies1 | StorageAccounts8 | StorageAccountsBlobServices2 | StorageAccountsBlobServicesContainers4 | StorageAccountsBlobServicesContainersImmutabilityPolicies4 | StorageAccountsManagementPolicies2 | StorageAccountsFileServices | StorageAccountsFileServicesShares | StorageAccounts9 | StorageAccountsBlobServices3 | StorageAccountsBlobServicesContainers5 | StorageAccountsBlobServicesContainersImmutabilityPolicies5 | StorageAccountsFileServices1 | StorageAccountsFileServicesShares1 | StorageAccountsManagementPolicies3 | StorageAccountsPrivateEndpointConnections | StorageAccountsEncryptionScopes | StorageAccountsObjectReplicationPolicies | StorageAccountsQueueServices | StorageAccountsQueueServicesQueues | StorageAccountsTableServices | StorageAccountsTableServicesTables | StorageAccountsInventoryPolicies | DedicatedCloudNodes | DedicatedCloudServices | VirtualMachines | AvailabilitySets | Extensions | VirtualMachineScaleSets | JobCollections | VirtualMachines1 | Accounts1 | Accounts2 | AccountsFirewallRules | AccountsTrustedIdProviders | AccountsVirtualNetworkRules | Accounts3 | Accounts4 | AccountsDataLakeStoreAccounts | AccountsStorageAccounts | AccountsFirewallRules1 | AccountsComputePolicies | Accounts5 | Accounts6 | AccountsPrivateEndpointConnections | WorkspaceCollections | Capacities | Catalogs | ContainerServices | Dnszones | Dnszones_A | Dnszones_AAAA | Dnszones_CNAME | Dnszones_MX | Dnszones_NS | Dnszones_PTR | Dnszones_SOA | Dnszones_SRV | Dnszones_TXT | Dnszones1 | Dnszones_A1 | Dnszones_AAAA1 | Dnszones_CNAME1 | Dnszones_MX1 | Dnszones_NS1 | Dnszones_PTR1 | Dnszones_SOA1 | Dnszones_SRV1 | Dnszones_TXT1 | Profiles | ProfilesEndpoints | ProfilesEndpointsCustomDomains | ProfilesEndpointsOrigins | Profiles1 | ProfilesEndpoints1 | ProfilesEndpointsCustomDomains1 | ProfilesEndpointsOrigins1 | BatchAccounts | BatchAccountsApplications | BatchAccountsApplicationsVersions | BatchAccounts1 | BatchAccountsApplications1 | BatchAccountsApplicationsVersions1 | BatchAccountsCertificates | BatchAccountsPools | Redis3 | RedisFirewallRules1 | RedisPatchSchedules1 | Workflows | Workflows1 | IntegrationAccounts | IntegrationAccountsAgreements | IntegrationAccountsCertificates | IntegrationAccountsMaps | IntegrationAccountsPartners | IntegrationAccountsSchemas | IntegrationAccountsAssemblies | IntegrationAccountsBatchConfigurations | Workflows2 | Workflows3 | JobCollections1 | JobCollectionsJobs | WebServices | CommitmentPlans | Workspaces | Workspaces1 | WorkspacesComputes | Accounts7 | AccountsWorkspaces | AccountsWorkspacesProjects | Workspaces2 | AutomationAccounts | AutomationAccountsRunbooks | AutomationAccountsModules | AutomationAccountsCertificates | AutomationAccountsConnections | AutomationAccountsVariables | AutomationAccountsSchedules | AutomationAccountsJobs | AutomationAccountsConnectionTypes | AutomationAccountsCompilationjobs | AutomationAccountsConfigurations | AutomationAccountsJobSchedules | AutomationAccountsNodeConfigurations | AutomationAccountsWebhooks | AutomationAccountsCredentials | AutomationAccountsWatchers | AutomationAccountsSoftwareUpdateConfigurations | AutomationAccountsJobs1 | AutomationAccountsSourceControls | AutomationAccountsSourceControlsSourceControlSyncJobs | AutomationAccountsCompilationjobs1 | AutomationAccountsNodeConfigurations1 | AutomationAccountsPython2Packages | AutomationAccountsRunbooks1 | Mediaservices | Mediaservices1 | MediaServicesAccountFilters | MediaServicesAssets | MediaServicesAssetsAssetFilters | MediaServicesContentKeyPolicies | MediaServicesStreamingLocators | MediaServicesStreamingPolicies | MediaServicesTransforms | MediaServicesTransformsJobs | IotHubs | IotHubs1 | IotHubsCertificates | IotHubs2 | IotHubsCertificates1 | IotHubs3 | IotHubsCertificates2 | IotHubsEventHubEndpoints_ConsumerGroups | IotHubsEventHubEndpoints_ConsumerGroups1 | ProvisioningServices | ProvisioningServices1 | ProvisioningServicesCertificates | Clusters9 | Clusters10 | Clusters11 | ClustersApplications | ClustersApplicationsServices | ClustersApplicationTypes | ClustersApplicationTypesVersions | Clusters12 | Clusters13 | ClustersApplications1 | ClustersApplicationsServices1 | ClustersApplicationTypes1 | ClustersApplicationTypesVersions1 | Managers | ManagersAccessControlRecords | ManagersBandwidthSettings | ManagersDevicesAlertSettings | ManagersDevicesBackupPolicies | ManagersDevicesBackupPoliciesSchedules | ManagersDevicesTimeSettings | ManagersDevicesVolumeContainers | ManagersDevicesVolumeContainersVolumes | ManagersExtendedInformation | ManagersStorageAccountCredentials | Deployments | Deployments1 | ApplianceDefinitions | Appliances | Service | ServiceApis | ServiceSubscriptions | ServiceProducts | ServiceGroups | ServiceCertificates | ServiceUsers | ServiceAuthorizationServers | ServiceLoggers | ServiceProperties | ServiceOpenidConnectProviders | ServiceBackends | ServiceIdentityProviders | ServiceApisOperations | ServiceGroupsUsers | ServiceProductsApis | ServiceProductsGroups | Service1 | ServiceApis1 | ServiceApisOperations1 | ServiceApisOperationsPolicies | ServiceApisOperationsTags | ServiceApisPolicies | ServiceApisReleases | ServiceApisSchemas | ServiceApisTagDescriptions | ServiceApisTags | ServiceAuthorizationServers1 | ServiceBackends1 | ServiceCertificates1 | ServiceDiagnostics | ServiceDiagnosticsLoggers | ServiceGroups1 | ServiceGroupsUsers1 | ServiceIdentityProviders1 | ServiceLoggers1 | ServiceNotifications | ServiceNotificationsRecipientEmails | ServiceNotificationsRecipientUsers | ServiceOpenidConnectProviders1 | ServicePolicies | ServiceProducts1 | ServiceProductsApis1 | ServiceProductsGroups1 | ServiceProductsPolicies | ServiceProductsTags | ServiceProperties1 | ServiceSubscriptions1 | ServiceTags | ServiceTemplates | ServiceUsers1 | ServiceApisDiagnostics | ServiceApisIssues | ServiceApiVersionSets | ServiceApisDiagnosticsLoggers | ServiceApisIssuesAttachments | ServiceApisIssuesComments | Service2 | ServiceApis2 | ServiceApisOperations2 | ServiceApisOperationsPolicies1 | ServiceApisOperationsTags1 | ServiceApisPolicies1 | ServiceApisReleases1 | ServiceApisSchemas1 | ServiceApisTagDescriptions1 | ServiceApisTags1 | ServiceAuthorizationServers2 | ServiceBackends2 | ServiceCertificates2 | ServiceDiagnostics1 | ServiceDiagnosticsLoggers1 | ServiceGroups2 | ServiceGroupsUsers2 | ServiceIdentityProviders2 | ServiceLoggers2 | ServiceNotifications1 | ServiceNotificationsRecipientEmails1 | ServiceNotificationsRecipientUsers1 | ServiceOpenidConnectProviders2 | ServicePolicies1 | ServiceProducts2 | ServiceProductsApis2 | ServiceProductsGroups2 | ServiceProductsPolicies1 | ServiceProductsTags1 | ServiceProperties2 | ServiceSubscriptions2 | ServiceTags1 | ServiceTemplates1 | ServiceUsers2 | ServiceApisDiagnostics1 | ServiceApisIssues1 | ServiceApiVersionSets1 | ServiceApisDiagnosticsLoggers1 | ServiceApisIssuesAttachments1 | ServiceApisIssuesComments1 | Service3 | ServiceApis3 | ServiceApisDiagnostics2 | ServiceApisOperations3 | ServiceApisOperationsPolicies2 | ServiceApisOperationsTags2 | ServiceApisPolicies2 | ServiceApisReleases2 | ServiceApisSchemas2 | ServiceApisTagDescriptions2 | ServiceApisTags2 | ServiceApiVersionSets2 | ServiceAuthorizationServers3 | ServiceBackends3 | ServiceCertificates3 | ServiceDiagnostics2 | ServiceGroups3 | ServiceGroupsUsers3 | ServiceIdentityProviders3 | ServiceLoggers3 | ServiceNotifications2 | ServiceNotificationsRecipientEmails2 | ServiceNotificationsRecipientUsers2 | ServiceOpenidConnectProviders3 | ServicePolicies2 | ServiceProducts3 | ServiceProductsApis3 | ServiceProductsGroups3 | ServiceProductsPolicies2 | ServiceProductsTags2 | ServiceProperties3 | ServiceSubscriptions3 | ServiceTags2 | ServiceTemplates2 | ServiceUsers3 | Service4 | ServiceApis4 | ServiceApisDiagnostics3 | ServiceApisOperations4 | ServiceApisOperationsPolicies3 | ServiceApisOperationsTags3 | ServiceApisPolicies3 | ServiceApisReleases3 | ServiceApisSchemas3 | ServiceApisTagDescriptions3 | ServiceApisTags3 | ServiceApisIssues2 | ServiceApiVersionSets3 | ServiceAuthorizationServers4 | ServiceBackends4 | ServiceCaches | ServiceCertificates4 | ServiceDiagnostics3 | ServiceGroups4 | ServiceGroupsUsers4 | ServiceIdentityProviders4 | ServiceLoggers4 | ServiceNotifications3 | ServiceNotificationsRecipientEmails3 | ServiceNotificationsRecipientUsers3 | ServiceOpenidConnectProviders4 | ServicePolicies3 | ServiceProducts4 | ServiceProductsApis4 | ServiceProductsGroups4 | ServiceProductsPolicies3 | ServiceProductsTags3 | ServiceProperties4 | ServiceSubscriptions4 | ServiceTags3 | ServiceTemplates3 | ServiceUsers4 | ServiceApisIssuesAttachments2 | ServiceApisIssuesComments2 | Namespaces | Namespaces_AuthorizationRules | NamespacesNotificationHubs1 | NamespacesNotificationHubs_AuthorizationRules1 | Namespaces1 | Namespaces_AuthorizationRules1 | NamespacesNotificationHubs2 | NamespacesNotificationHubs_AuthorizationRules2 | Namespaces2 | Namespaces_AuthorizationRules2 | Disks | Snapshots | Images | AvailabilitySets1 | VirtualMachines2 | VirtualMachineScaleSets1 | VirtualMachinesExtensions | Registries | Registries1 | Registries2 | RegistriesReplications | RegistriesWebhooks | Registries3 | RegistriesReplications1 | RegistriesWebhooks1 | RegistriesBuildTasks | RegistriesBuildTasksSteps | RegistriesTasks | PublicIPAddresses | VirtualNetworks | LoadBalancers | NetworkSecurityGroups | NetworkInterfaces1 | RouteTables | PublicIPAddresses1 | VirtualNetworks1 | LoadBalancers1 | NetworkSecurityGroups1 | NetworkInterfaces2 | RouteTables1 | PublicIPAddresses2 | VirtualNetworks2 | LoadBalancers2 | NetworkSecurityGroups2 | NetworkInterfaces3 | RouteTables2 | PublicIPAddresses3 | VirtualNetworks3 | LoadBalancers3 | NetworkSecurityGroups3 | NetworkInterfaces4 | RouteTables3 | PublicIPAddresses4 | VirtualNetworks4 | LoadBalancers4 | NetworkSecurityGroups4 | NetworkInterfaces5 | RouteTables4 | PublicIPAddresses5 | VirtualNetworks5 | LoadBalancers5 | NetworkSecurityGroups5 | NetworkInterfaces6 | RouteTables5 | PublicIPAddresses6 | VirtualNetworks6 | LoadBalancers6 | NetworkSecurityGroups6 | NetworkInterfaces7 | RouteTables6 | PublicIPAddresses7 | VirtualNetworks7 | LoadBalancers7 | NetworkSecurityGroups7 | NetworkInterfaces8 | RouteTables7 | PublicIPAddresses8 | VirtualNetworks8 | LoadBalancers8 | NetworkSecurityGroups8 | NetworkInterfaces9 | RouteTables8 | ApplicationGateways | Connections | LocalNetworkGateways | VirtualNetworkGateways | VirtualNetworksSubnets | VirtualNetworksVirtualNetworkPeerings | NetworkSecurityGroupsSecurityRules | RouteTablesRoutes | Disks1 | Snapshots1 | Images1 | AvailabilitySets2 | VirtualMachines3 | VirtualMachineScaleSets2 | VirtualMachinesExtensions1 | Servers2 | ServersAdvisors | ServersAdministrators | ServersAuditingPolicies | ServersCommunicationLinks | ServersConnectionPolicies | ServersDatabases | ServersDatabasesAdvisors | ServersDatabasesAuditingPolicies | ServersDatabasesConnectionPolicies | ServersDatabasesDataMaskingPolicies | ServersDatabasesDataMaskingPoliciesRules | ServersDatabasesExtensions | ServersDatabasesGeoBackupPolicies | ServersDatabasesSecurityAlertPolicies | ServersDatabasesTransparentDataEncryption | ServersDisasterRecoveryConfiguration | ServersElasticPools | ServersFirewallRules | ManagedInstances | Servers3 | ServersDatabasesAuditingSettings | ServersDatabasesSyncGroups | ServersDatabasesSyncGroupsSyncMembers | ServersEncryptionProtector | ServersFailoverGroups | ServersFirewallRules1 | ServersKeys | ServersSyncAgents | ServersVirtualNetworkRules | ManagedInstancesDatabases | ServersAuditingSettings | ServersDatabases1 | ServersDatabasesAuditingSettings1 | ServersDatabasesBackupLongTermRetentionPolicies | ServersDatabasesExtendedAuditingSettings | ServersDatabasesSecurityAlertPolicies1 | ServersSecurityAlertPolicies | ManagedInstancesDatabasesSecurityAlertPolicies | ManagedInstancesSecurityAlertPolicies | ServersDatabasesVulnerabilityAssessmentsRulesBaselines | ServersDatabasesVulnerabilityAssessments | ManagedInstancesDatabasesVulnerabilityAssessmentsRulesBaselines | ManagedInstancesDatabasesVulnerabilityAssessments | ServersVulnerabilityAssessments | ManagedInstancesVulnerabilityAssessments | ServersDnsAliases | ServersExtendedAuditingSettings | ServersJobAgents | ServersJobAgentsCredentials | ServersJobAgentsJobs | ServersJobAgentsJobsExecutions | ServersJobAgentsJobsSteps | ServersJobAgentsTargetGroups | WebServices1 | Workspaces3 | Streamingjobs | StreamingjobsFunctions | StreamingjobsInputs | StreamingjobsOutputs | StreamingjobsTransformations | Environments | EnvironmentsEventSources | EnvironmentsReferenceDataSets | EnvironmentsAccessPolicies | Environments1 | EnvironmentsEventSources1 | EnvironmentsReferenceDataSets1 | EnvironmentsAccessPolicies1 | WorkspacesComputes1 | Workspaces4 | WorkspacesComputes2 | Workspaces5 | WorkspacesComputes3 | Workspaces6 | WorkspacesComputes4 | Workspaces7 | WorkspacesComputes5 | WorkspacesPrivateEndpointConnections | PublicIPAddresses9 | VirtualNetworks9 | LoadBalancers9 | NetworkSecurityGroups9 | NetworkInterfaces10 | RouteTables9 | ApplicationGateways1 | Connections1 | LocalNetworkGateways1 | VirtualNetworkGateways1 | VirtualNetworksSubnets1 | VirtualNetworksVirtualNetworkPeerings1 | LoadBalancersInboundNatRules | NetworkSecurityGroupsSecurityRules1 | RouteTablesRoutes1 | PublicIPAddresses10 | VirtualNetworks10 | LoadBalancers10 | NetworkSecurityGroups10 | NetworkInterfaces11 | RouteTables10 | ApplicationGateways2 | LoadBalancersInboundNatRules1 | NetworkSecurityGroupsSecurityRules2 | RouteTablesRoutes2 | PublicIPAddresses11 | VirtualNetworks11 | LoadBalancers11 | NetworkSecurityGroups11 | NetworkInterfaces12 | RouteTables11 | ApplicationGateways3 | LoadBalancersInboundNatRules2 | NetworkSecurityGroupsSecurityRules3 | RouteTablesRoutes3 | Jobs | DnsZones | DnsZones_A | DnsZones_AAAA | DnsZones_CAA | DnsZones_CNAME | DnsZones_MX | DnsZones_NS | DnsZones_PTR | DnsZones_SOA | DnsZones_SRV | DnsZones_TXT | Connections2 | LocalNetworkGateways2 | VirtualNetworkGateways2 | VirtualNetworksSubnets2 | VirtualNetworksVirtualNetworkPeerings2 | DnsZones1 | DnsZones_A1 | DnsZones_AAAA1 | DnsZones_CAA1 | DnsZones_CNAME1 | DnsZones_MX1 | DnsZones_NS1 | DnsZones_PTR1 | DnsZones_SOA1 | DnsZones_SRV1 | DnsZones_TXT1 | Connections3 | LocalNetworkGateways3 | VirtualNetworkGateways3 | VirtualNetworksSubnets3 | VirtualNetworksVirtualNetworkPeerings3 | Registrations | RegistrationsCustomerSubscriptions | PublicIPAddresses12 | VirtualNetworks12 | LoadBalancers12 | NetworkSecurityGroups12 | NetworkInterfaces13 | RouteTables12 | ApplicationGateways4 | Connections4 | LocalNetworkGateways4 | VirtualNetworkGateways4 | VirtualNetworksSubnets4 | VirtualNetworksVirtualNetworkPeerings4 | LoadBalancersInboundNatRules3 | NetworkSecurityGroupsSecurityRules4 | RouteTablesRoutes4 | Images2 | AvailabilitySets3 | VirtualMachines4 | VirtualMachineScaleSets3 | VirtualMachinesExtensions2 | VirtualMachineScaleSetsExtensions | Servers4 | ServersConfigurations | ServersDatabases2 | ServersFirewallRules2 | ServersVirtualNetworkRules1 | ServersSecurityAlertPolicies1 | ServersPrivateEndpointConnections | Servers5 | ServersConfigurations1 | ServersDatabases3 | ServersFirewallRules3 | ServersVirtualNetworkRules2 | ServersSecurityAlertPolicies2 | ServersAdministrators1 | Servers6 | ServersConfigurations2 | ServersDatabases4 | ServersFirewallRules4 | ServersVirtualNetworkRules3 | ServersSecurityAlertPolicies3 | ServersAdministrators2 | Servers7 | ServersConfigurations3 | ServersDatabases5 | ServersFirewallRules5 | Servers8 | ServersConfigurations4 | ServersDatabases6 | ServersFirewallRules6 | ApplicationGateways5 | Connections5 | ExpressRouteCircuitsAuthorizations | ExpressRouteCircuitsPeerings | LoadBalancers13 | LocalNetworkGateways5 | NetworkInterfaces14 | NetworkSecurityGroups13 | NetworkSecurityGroupsSecurityRules5 | PublicIPAddresses13 | RouteTables13 | RouteTablesRoutes5 | VirtualNetworkGateways5 | VirtualNetworks13 | VirtualNetworksSubnets5 | ApplicationGateways6 | Connections6 | ExpressRouteCircuits | ExpressRouteCircuitsAuthorizations1 | ExpressRouteCircuitsPeerings1 | LoadBalancers14 | LocalNetworkGateways6 | NetworkInterfaces15 | NetworkSecurityGroups14 | NetworkSecurityGroupsSecurityRules6 | PublicIPAddresses14 | RouteTables14 | RouteTablesRoutes6 | VirtualNetworkGateways6 | VirtualNetworks14 | VirtualNetworksSubnets6 | ApplicationGateways7 | Connections7 | ExpressRouteCircuits1 | ExpressRouteCircuitsAuthorizations2 | ExpressRouteCircuitsPeerings2 | LoadBalancers15 | LocalNetworkGateways7 | NetworkInterfaces16 | NetworkSecurityGroups15 | NetworkSecurityGroupsSecurityRules7 | PublicIPAddresses15 | RouteTables15 | RouteTablesRoutes7 | VirtualNetworkGateways7 | VirtualNetworks15 | VirtualNetworksSubnets7 | ApplicationSecurityGroups | ApplicationSecurityGroups1 | ApplicationSecurityGroups2 | ApplicationSecurityGroups3 | PublicIPAddresses16 | VirtualNetworks16 | LoadBalancers16 | NetworkSecurityGroups16 | NetworkInterfaces17 | RouteTables16 | ApplicationGateways8 | Connections8 | LocalNetworkGateways8 | VirtualNetworkGateways8 | VirtualNetworksSubnets8 | VirtualNetworksVirtualNetworkPeerings5 | LoadBalancersInboundNatRules4 | NetworkSecurityGroupsSecurityRules8 | RouteTablesRoutes8 | ApplicationSecurityGroups4 | DdosProtectionPlans | ExpressRouteCircuits2 | ExpressRouteCrossConnections | PublicIPAddresses17 | VirtualNetworks17 | LoadBalancers17 | NetworkSecurityGroups17 | NetworkInterfaces18 | RouteTables17 | LoadBalancersInboundNatRules5 | NetworkSecurityGroupsSecurityRules9 | RouteTablesRoutes9 | ExpressRouteCircuitsAuthorizations3 | ExpressRouteCircuitsPeerings3 | ExpressRouteCrossConnectionsPeerings | ExpressRouteCircuitsPeeringsConnections | ApplicationGateways9 | ApplicationSecurityGroups5 | AzureFirewalls | Connections9 | DdosProtectionPlans1 | ExpressRouteCircuits3 | ExpressRouteCircuitsAuthorizations4 | ExpressRouteCircuitsPeerings4 | ExpressRouteCircuitsPeeringsConnections1 | ExpressRouteCrossConnections1 | ExpressRouteCrossConnectionsPeerings1 | LoadBalancers18 | LoadBalancersInboundNatRules6 | LocalNetworkGateways9 | NetworkInterfaces19 | NetworkSecurityGroups18 | NetworkSecurityGroupsSecurityRules10 | NetworkWatchers | NetworkWatchersConnectionMonitors | NetworkWatchersPacketCaptures | PublicIPAddresses18 | RouteFilters | RouteFiltersRouteFilterRules | RouteTables18 | RouteTablesRoutes10 | VirtualHubs | VirtualNetworkGateways9 | VirtualNetworks18 | VirtualNetworksSubnets9 | VirtualNetworksVirtualNetworkPeerings6 | VirtualWans | VpnGateways | VpnGatewaysVpnConnections | VpnSites | ApplicationGateways10 | ApplicationSecurityGroups6 | AzureFirewalls1 | Connections10 | DdosProtectionPlans2 | ExpressRouteCircuits4 | ExpressRouteCircuitsAuthorizations5 | ExpressRouteCircuitsPeerings5 | ExpressRouteCircuitsPeeringsConnections2 | ExpressRouteCrossConnections2 | ExpressRouteCrossConnectionsPeerings2 | LoadBalancers19 | LoadBalancersInboundNatRules7 | LocalNetworkGateways10 | NetworkInterfaces20 | NetworkSecurityGroups19 | NetworkSecurityGroupsSecurityRules11 | NetworkWatchers1 | NetworkWatchersConnectionMonitors1 | NetworkWatchersPacketCaptures1 | PublicIPAddresses19 | RouteFilters1 | RouteFiltersRouteFilterRules1 | RouteTables19 | RouteTablesRoutes11 | VirtualHubs1 | VirtualNetworkGateways10 | VirtualNetworks19 | VirtualNetworksSubnets10 | VirtualNetworksVirtualNetworkPeerings7 | VirtualWans1 | VpnGateways1 | VpnGatewaysVpnConnections1 | VpnSites1 | ApplicationGateways11 | ApplicationSecurityGroups7 | AzureFirewalls2 | Connections11 | DdosProtectionPlans3 | ExpressRouteCircuits5 | ExpressRouteCircuitsAuthorizations6 | ExpressRouteCircuitsPeerings6 | ExpressRouteCircuitsPeeringsConnections3 | ExpressRouteCrossConnections3 | ExpressRouteCrossConnectionsPeerings3 | LoadBalancers20 | LoadBalancersInboundNatRules8 | LocalNetworkGateways11 | NetworkInterfaces21 | NetworkSecurityGroups20 | NetworkSecurityGroupsSecurityRules12 | NetworkWatchers2 | NetworkWatchersConnectionMonitors2 | NetworkWatchersPacketCaptures2 | PublicIPAddresses20 | PublicIPPrefixes | RouteFilters2 | RouteFiltersRouteFilterRules2 | RouteTables20 | RouteTablesRoutes12 | ServiceEndpointPolicies | ServiceEndpointPoliciesServiceEndpointPolicyDefinitions | VirtualHubs2 | VirtualNetworkGateways11 | VirtualNetworks20 | VirtualNetworksSubnets11 | VirtualNetworksVirtualNetworkPeerings8 | VirtualWans2 | VpnGateways2 | VpnGatewaysVpnConnections2 | VpnSites2 | ApplicationSecurityGroups8 | DdosProtectionPlans4 | ExpressRouteCircuits6 | ExpressRouteCrossConnections4 | PublicIPAddresses21 | VirtualNetworks21 | LoadBalancers21 | NetworkSecurityGroups21 | NetworkInterfaces22 | RouteTables21 | ApplicationGateways12 | ExpressRouteCircuitsAuthorizations7 | ExpressRoutePorts | Connections12 | LocalNetworkGateways12 | VirtualNetworkGateways12 | VirtualNetworksSubnets12 | VirtualNetworksVirtualNetworkPeerings9 | ExpressRouteCircuitsPeerings7 | ExpressRouteCrossConnectionsPeerings4 | LoadBalancersInboundNatRules9 | NetworkInterfacesTapConfigurations | NetworkSecurityGroupsSecurityRules13 | RouteTablesRoutes13 | ExpressRouteCircuitsPeeringsConnections4 | ApplicationSecurityGroups9 | DdosProtectionPlans5 | ExpressRouteCircuits7 | ExpressRouteCrossConnections5 | PublicIPAddresses22 | VirtualNetworks22 | LoadBalancers22 | NetworkSecurityGroups22 | NetworkInterfaces23 | RouteTables22 | ApplicationGateways13 | ExpressRouteCircuitsAuthorizations8 | ExpressRouteCircuitsPeeringsConnections5 | ApplicationSecurityGroups10 | ApplicationSecurityGroups11 | DdosProtectionPlans6 | ExpressRouteCircuits8 | ExpressRouteCrossConnections6 | PublicIPAddresses23 | VirtualNetworks23 | LoadBalancers23 | NetworkSecurityGroups23 | NetworkInterfaces24 | RouteTables23 | ApplicationGateways14 | ExpressRouteCircuitsAuthorizations9 | ExpressRouteCircuitsPeerings8 | ExpressRouteCrossConnectionsPeerings5 | LoadBalancersInboundNatRules10 | NetworkInterfacesTapConfigurations1 | NetworkSecurityGroupsSecurityRules14 | RouteTablesRoutes14 | ExpressRoutePorts1 | ExpressRouteCircuitsPeeringsConnections6 | ApplicationSecurityGroups12 | DdosProtectionPlans7 | ExpressRouteCircuits9 | ExpressRouteCrossConnections7 | PublicIPAddresses24 | VirtualNetworks24 | LoadBalancers24 | NetworkSecurityGroups24 | NetworkInterfaces25 | RouteTables24 | ApplicationGateways15 | ExpressRouteCircuitsAuthorizations10 | ExpressRoutePorts2 | ApplicationGatewayWebApplicationFirewallPolicies | ExpressRouteCircuitsPeerings9 | ExpressRouteCrossConnectionsPeerings6 | LoadBalancersInboundNatRules11 | NetworkInterfacesTapConfigurations2 | NetworkSecurityGroupsSecurityRules15 | RouteTablesRoutes15 | ExpressRouteCircuitsPeeringsConnections7 | ApplicationGateways16 | ApplicationGatewayWebApplicationFirewallPolicies1 | ApplicationSecurityGroups13 | AzureFirewalls3 | BastionHosts | Connections13 | DdosCustomPolicies | DdosProtectionPlans8 | ExpressRouteCircuits10 | ExpressRouteCircuitsAuthorizations11 | ExpressRouteCircuitsPeerings10 | ExpressRouteCircuitsPeeringsConnections8 | ExpressRouteCrossConnections8 | ExpressRouteCrossConnectionsPeerings7 | ExpressRouteGateways | ExpressRouteGatewaysExpressRouteConnections | ExpressRoutePorts3 | LoadBalancers25 | LoadBalancersInboundNatRules12 | LocalNetworkGateways13 | NatGateways | NetworkInterfaces26 | NetworkInterfacesTapConfigurations3 | NetworkProfiles | NetworkSecurityGroups25 | NetworkSecurityGroupsSecurityRules16 | NetworkWatchers3 | NetworkWatchersConnectionMonitors3 | NetworkWatchersPacketCaptures3 | P2SvpnGateways | PrivateEndpoints | PrivateLinkServices | PrivateLinkServicesPrivateEndpointConnections | PublicIPAddresses25 | PublicIPPrefixes1 | RouteFilters3 | RouteFiltersRouteFilterRules3 | RouteTables25 | RouteTablesRoutes16 | ServiceEndpointPolicies1 | ServiceEndpointPoliciesServiceEndpointPolicyDefinitions1 | VirtualHubs3 | VirtualNetworkGateways13 | VirtualNetworks25 | VirtualNetworksSubnets13 | VirtualNetworksVirtualNetworkPeerings10 | VirtualNetworkTaps | VirtualWans3 | VirtualWansP2SVpnServerConfigurations | VpnGateways3 | VpnGatewaysVpnConnections3 | VpnSites3 | ApplicationGateways17 | ApplicationGatewayWebApplicationFirewallPolicies2 | ApplicationSecurityGroups14 | AzureFirewalls4 | BastionHosts1 | Connections14 | DdosCustomPolicies1 | DdosProtectionPlans9 | ExpressRouteCircuits11 | ExpressRouteCircuitsAuthorizations12 | ExpressRouteCircuitsPeerings11 | ExpressRouteCircuitsPeeringsConnections9 | ExpressRouteCrossConnections9 | ExpressRouteCrossConnectionsPeerings8 | ExpressRouteGateways1 | ExpressRouteGatewaysExpressRouteConnections1 | ExpressRoutePorts4 | FirewallPolicies | FirewallPoliciesRuleGroups | LoadBalancers26 | LoadBalancersInboundNatRules13 | LocalNetworkGateways14 | NatGateways1 | NetworkInterfaces27 | NetworkInterfacesTapConfigurations4 | NetworkProfiles1 | NetworkSecurityGroups26 | NetworkSecurityGroupsSecurityRules17 | NetworkWatchers4 | NetworkWatchersConnectionMonitors4 | NetworkWatchersPacketCaptures4 | P2SvpnGateways1 | PrivateEndpoints1 | PrivateLinkServices1 | PrivateLinkServicesPrivateEndpointConnections1 | PublicIPAddresses26 | PublicIPPrefixes2 | RouteFilters4 | RouteFiltersRouteFilterRules4 | RouteTables26 | RouteTablesRoutes17 | ServiceEndpointPolicies2 | ServiceEndpointPoliciesServiceEndpointPolicyDefinitions2 | VirtualHubs4 | VirtualNetworkGateways14 | VirtualNetworks26 | VirtualNetworksSubnets14 | VirtualNetworksVirtualNetworkPeerings11 | VirtualNetworkTaps1 | VirtualWans4 | VirtualWansP2SVpnServerConfigurations1 | VpnGateways4 | VpnGatewaysVpnConnections4 | VpnSites4 | ApplicationGateways18 | ApplicationGatewayWebApplicationFirewallPolicies3 | ApplicationSecurityGroups15 | AzureFirewalls5 | BastionHosts2 | Connections15 | DdosCustomPolicies2 | DdosProtectionPlans10 | ExpressRouteCircuits12 | ExpressRouteCircuitsAuthorizations13 | ExpressRouteCircuitsPeerings12 | ExpressRouteCircuitsPeeringsConnections10 | ExpressRouteCrossConnections10 | ExpressRouteCrossConnectionsPeerings9 | ExpressRouteGateways2 | ExpressRouteGatewaysExpressRouteConnections2 | ExpressRoutePorts5 | FirewallPolicies1 | FirewallPoliciesRuleGroups1 | LoadBalancers27 | LoadBalancersInboundNatRules14 | LocalNetworkGateways15 | NatGateways2 | NetworkInterfaces28 | NetworkInterfacesTapConfigurations5 | NetworkProfiles2 | NetworkSecurityGroups27 | NetworkSecurityGroupsSecurityRules18 | NetworkWatchers5 | NetworkWatchersPacketCaptures5 | P2SvpnGateways2 | PrivateEndpoints2 | PrivateLinkServices2 | PrivateLinkServicesPrivateEndpointConnections2 | PublicIPAddresses27 | PublicIPPrefixes3 | RouteFilters5 | RouteFiltersRouteFilterRules5 | RouteTables27 | RouteTablesRoutes18 | ServiceEndpointPolicies3 | ServiceEndpointPoliciesServiceEndpointPolicyDefinitions3 | VirtualHubs5 | VirtualNetworkGateways15 | VirtualNetworks27 | VirtualNetworksSubnets15 | VirtualNetworksVirtualNetworkPeerings12 | VirtualNetworkTaps2 | VirtualRouters | VirtualRoutersPeerings | VirtualWans5 | VirtualWansP2SVpnServerConfigurations2 | VpnGateways5 | VpnGatewaysVpnConnections5 | VpnSites5 | ApplicationGateways19 | ApplicationGatewayWebApplicationFirewallPolicies4 | ApplicationSecurityGroups16 | AzureFirewalls6 | BastionHosts3 | Connections16 | DdosCustomPolicies3 | DdosProtectionPlans11 | ExpressRouteCircuits13 | ExpressRouteCircuitsAuthorizations14 | ExpressRouteCircuitsPeerings13 | ExpressRouteCircuitsPeeringsConnections11 | ExpressRouteCrossConnections11 | ExpressRouteCrossConnectionsPeerings10 | ExpressRouteGateways3 | ExpressRouteGatewaysExpressRouteConnections3 | ExpressRoutePorts6 | FirewallPolicies2 | FirewallPoliciesRuleGroups2 | LoadBalancers28 | LoadBalancersInboundNatRules15 | LocalNetworkGateways16 | NatGateways3 | NetworkInterfaces29 | NetworkInterfacesTapConfigurations6 | NetworkProfiles3 | NetworkSecurityGroups28 | NetworkSecurityGroupsSecurityRules19 | NetworkWatchers6 | NetworkWatchersPacketCaptures6 | P2SvpnGateways3 | PrivateEndpoints3 | PrivateLinkServices3 | PrivateLinkServicesPrivateEndpointConnections3 | PublicIPAddresses28 | PublicIPPrefixes4 | RouteFilters6 | RouteFiltersRouteFilterRules6 | RouteTables28 | RouteTablesRoutes19 | ServiceEndpointPolicies4 | ServiceEndpointPoliciesServiceEndpointPolicyDefinitions4 | VirtualHubs6 | VirtualNetworkGateways16 | VirtualNetworks28 | VirtualNetworksSubnets16 | VirtualNetworksVirtualNetworkPeerings13 | VirtualNetworkTaps3 | VirtualRouters1 | VirtualRoutersPeerings1 | VirtualWans6 | VpnGateways6 | VpnGatewaysVpnConnections6 | VpnServerConfigurations | VpnSites6 | ApplicationGateways20 | ApplicationGatewayWebApplicationFirewallPolicies5 | ApplicationSecurityGroups17 | AzureFirewalls7 | BastionHosts4 | Connections17 | DdosCustomPolicies4 | DdosProtectionPlans12 | ExpressRouteCircuits14 | ExpressRouteCircuitsAuthorizations15 | ExpressRouteCircuitsPeerings14 | ExpressRouteCircuitsPeeringsConnections12 | ExpressRouteCrossConnections12 | ExpressRouteCrossConnectionsPeerings11 | ExpressRouteGateways4 | ExpressRouteGatewaysExpressRouteConnections4 | ExpressRoutePorts7 | FirewallPolicies3 | FirewallPoliciesRuleGroups3 | IpGroups | LoadBalancers29 | LoadBalancersInboundNatRules16 | LocalNetworkGateways17 | NatGateways4 | NetworkInterfaces30 | NetworkInterfacesTapConfigurations7 | NetworkProfiles4 | NetworkSecurityGroups29 | NetworkSecurityGroupsSecurityRules20 | NetworkWatchers7 | NetworkWatchersPacketCaptures7 | P2SvpnGateways4 | PrivateEndpoints4 | PrivateLinkServices4 | PrivateLinkServicesPrivateEndpointConnections4 | PublicIPAddresses29 | PublicIPPrefixes5 | RouteFilters7 | RouteFiltersRouteFilterRules7 | RouteTables29 | RouteTablesRoutes20 | ServiceEndpointPolicies5 | ServiceEndpointPoliciesServiceEndpointPolicyDefinitions5 | VirtualHubs7 | VirtualHubsRouteTables | VirtualNetworkGateways17 | VirtualNetworks29 | VirtualNetworksSubnets17 | VirtualNetworksVirtualNetworkPeerings14 | VirtualNetworkTaps4 | VirtualRouters2 | VirtualRoutersPeerings2 | VirtualWans7 | VpnGateways7 | VpnGatewaysVpnConnections7 | VpnServerConfigurations1 | VpnSites7 | NatGateways5 | Connections18 | LocalNetworkGateways18 | VirtualNetworkGateways18 | VirtualNetworksSubnets18 | VirtualNetworksVirtualNetworkPeerings15 | ApplicationGatewayWebApplicationFirewallPolicies6 | Connections19 | LocalNetworkGateways19 | VirtualNetworkGateways19 | VirtualNetworksSubnets19 | VirtualNetworksVirtualNetworkPeerings16 | DdosProtectionPlans13 | ExpressRouteCircuits15 | ExpressRouteCrossConnections13 | PublicIPAddresses30 | VirtualNetworks30 | LoadBalancers30 | NetworkSecurityGroups30 | NetworkInterfaces31 | RouteTables30 | ApplicationGateways21 | ExpressRouteCircuitsAuthorizations16 | ExpressRoutePorts8 | Connections20 | LocalNetworkGateways20 | VirtualNetworkGateways20 | VirtualNetworksSubnets20 | VirtualNetworksVirtualNetworkPeerings17 | ExpressRouteCircuitsPeerings15 | ExpressRouteCrossConnectionsPeerings12 | LoadBalancersInboundNatRules17 | NetworkInterfacesTapConfigurations8 | NetworkSecurityGroupsSecurityRules21 | RouteTablesRoutes21 | ExpressRouteCircuitsPeeringsConnections13 | ExpressRoutePorts9 | Connections21 | LocalNetworkGateways21 | VirtualNetworkGateways21 | VirtualNetworksSubnets21 | VirtualNetworksVirtualNetworkPeerings18 | ExpressRouteCircuitsPeerings16 | ExpressRouteCrossConnectionsPeerings13 | LoadBalancersInboundNatRules18 | NetworkInterfacesTapConfigurations9 | NetworkSecurityGroupsSecurityRules22 | RouteTablesRoutes22 | ApplicationGateways22 | Connections22 | LocalNetworkGateways22 | VirtualNetworkGateways22 | VirtualNetworksSubnets22 | VirtualNetworksVirtualNetworkPeerings19 | DnsZones2 | DnsZones_A2 | DnsZones_AAAA2 | DnsZones_CAA2 | DnsZones_CNAME2 | DnsZones_MX2 | DnsZones_NS2 | DnsZones_PTR2 | DnsZones_SOA2 | DnsZones_SRV2 | DnsZones_TXT2 | PrivateDnsZones | PrivateDnsZonesVirtualNetworkLinks | PrivateDnsZones_A | PrivateDnsZones_AAAA | PrivateDnsZones_CNAME | PrivateDnsZones_MX | PrivateDnsZones_PTR | PrivateDnsZones_SOA | PrivateDnsZones_SRV | PrivateDnsZones_TXT | ApplicationGateways23 | ApplicationGatewayWebApplicationFirewallPolicies7 | ApplicationSecurityGroups18 | AzureFirewalls8 | BastionHosts5 | Connections23 | DdosCustomPolicies5 | DdosProtectionPlans14 | ExpressRouteCircuits16 | ExpressRouteCircuitsAuthorizations17 | ExpressRouteCircuitsPeerings17 | ExpressRouteCircuitsPeeringsConnections14 | ExpressRouteCrossConnections14 | ExpressRouteCrossConnectionsPeerings14 | ExpressRouteGateways5 | ExpressRouteGatewaysExpressRouteConnections5 | ExpressRoutePorts10 | FirewallPolicies4 | FirewallPoliciesRuleGroups4 | IpGroups1 | LoadBalancers31 | LoadBalancersInboundNatRules19 | LocalNetworkGateways23 | NatGateways6 | NetworkInterfaces32 | NetworkInterfacesTapConfigurations10 | NetworkProfiles5 | NetworkSecurityGroups31 | NetworkSecurityGroupsSecurityRules23 | NetworkWatchers8 | NetworkWatchersPacketCaptures8 | P2SvpnGateways5 | PrivateEndpoints5 | PrivateLinkServices5 | PrivateLinkServicesPrivateEndpointConnections5 | PublicIPAddresses31 | PublicIPPrefixes6 | RouteFilters8 | RouteFiltersRouteFilterRules8 | RouteTables31 | RouteTablesRoutes23 | ServiceEndpointPolicies6 | ServiceEndpointPoliciesServiceEndpointPolicyDefinitions6 | VirtualHubs8 | VirtualHubsRouteTables1 | VirtualNetworkGateways23 | VirtualNetworks31 | VirtualNetworksSubnets23 | VirtualNetworksVirtualNetworkPeerings20 | VirtualNetworkTaps5 | VirtualRouters3 | VirtualRoutersPeerings3 | VirtualWans8 | VpnGateways8 | VpnGatewaysVpnConnections8 | VpnServerConfigurations2 | VpnSites8 | NetworkWatchersConnectionMonitors5 | NetworkWatchersFlowLogs | ApplicationGateways24 | ApplicationGatewayWebApplicationFirewallPolicies8 | ApplicationSecurityGroups19 | AzureFirewalls9 | BastionHosts6 | Connections24 | ConnectionsSharedkey | DdosCustomPolicies6 | DdosProtectionPlans15 | ExpressRouteCircuits17 | ExpressRouteCircuitsAuthorizations18 | ExpressRouteCircuitsPeerings18 | ExpressRouteCircuitsPeeringsConnections15 | ExpressRouteCrossConnections15 | ExpressRouteCrossConnectionsPeerings15 | ExpressRouteGateways6 | ExpressRouteGatewaysExpressRouteConnections6 | ExpressRoutePorts11 | FirewallPolicies5 | FirewallPoliciesRuleGroups5 | IpGroups2 | LoadBalancers32 | LoadBalancersInboundNatRules20 | LocalNetworkGateways24 | NatGateways7 | NetworkInterfaces33 | NetworkInterfacesTapConfigurations11 | NetworkProfiles6 | NetworkSecurityGroups32 | NetworkSecurityGroupsSecurityRules24 | NetworkVirtualAppliances | NetworkWatchers9 | NetworkWatchersConnectionMonitors6 | NetworkWatchersFlowLogs1 | NetworkWatchersPacketCaptures9 | P2SvpnGateways6 | PrivateEndpoints6 | PrivateLinkServices6 | PrivateLinkServicesPrivateEndpointConnections6 | PublicIPAddresses32 | PublicIPPrefixes7 | RouteFilters9 | RouteFiltersRouteFilterRules9 | RouteTables32 | RouteTablesRoutes24 | ServiceEndpointPolicies7 | ServiceEndpointPoliciesServiceEndpointPolicyDefinitions7 | VirtualHubs9 | VirtualHubsRouteTables2 | VirtualNetworkGateways24 | VirtualNetworks32 | VirtualNetworksSubnets24 | VirtualNetworksVirtualNetworkPeerings21 | VirtualNetworkTaps6 | VirtualRouters4 | VirtualRoutersPeerings4 | VirtualWans9 | VpnGateways9 | VpnGatewaysVpnConnections9 | VpnServerConfigurations3 | VpnSites9 | ApplicationGateways25 | ApplicationGatewayWebApplicationFirewallPolicies9 | ApplicationSecurityGroups20 | AzureFirewalls10 | BastionHosts7 | Connections25 | DdosCustomPolicies7 | DdosProtectionPlans16 | ExpressRouteCircuits18 | ExpressRouteCircuitsAuthorizations19 | ExpressRouteCircuitsPeerings19 | ExpressRouteCircuitsPeeringsConnections16 | ExpressRouteCrossConnections16 | ExpressRouteCrossConnectionsPeerings16 | ExpressRouteGateways7 | ExpressRouteGatewaysExpressRouteConnections7 | ExpressRoutePorts12 | FirewallPolicies6 | FirewallPoliciesRuleGroups6 | IpAllocations | IpGroups3 | LoadBalancers33 | LoadBalancersInboundNatRules21 | LocalNetworkGateways25 | NatGateways8 | NetworkInterfaces34 | NetworkInterfacesTapConfigurations12 | NetworkProfiles7 | NetworkSecurityGroups33 | NetworkSecurityGroupsSecurityRules25 | NetworkVirtualAppliances1 | NetworkWatchers10 | NetworkWatchersConnectionMonitors7 | NetworkWatchersFlowLogs2 | NetworkWatchersPacketCaptures10 | P2SvpnGateways7 | PrivateEndpoints7 | PrivateEndpointsPrivateDnsZoneGroups | PrivateLinkServices7 | PrivateLinkServicesPrivateEndpointConnections7 | PublicIPAddresses33 | PublicIPPrefixes8 | RouteFilters10 | RouteFiltersRouteFilterRules10 | RouteTables33 | RouteTablesRoutes25 | SecurityPartnerProviders | ServiceEndpointPolicies8 | ServiceEndpointPoliciesServiceEndpointPolicyDefinitions8 | VirtualHubs10 | VirtualHubsRouteTables3 | VirtualNetworkGateways25 | VirtualNetworks33 | VirtualNetworksSubnets25 | VirtualNetworksVirtualNetworkPeerings22 | VirtualNetworkTaps7 | VirtualRouters5 | VirtualRoutersPeerings5 | VirtualWans10 | VpnGateways10 | VpnGatewaysVpnConnections10 | VpnServerConfigurations4 | VpnSites10 | ApplicationGateways26 | ApplicationGatewayWebApplicationFirewallPolicies10 | ApplicationSecurityGroups21 | AzureFirewalls11 | BastionHosts8 | Connections26 | DdosCustomPolicies8 | DdosProtectionPlans17 | ExpressRouteCircuits19 | ExpressRouteCircuitsAuthorizations20 | ExpressRouteCircuitsPeerings20 | ExpressRouteCircuitsPeeringsConnections17 | ExpressRouteCrossConnections17 | ExpressRouteCrossConnectionsPeerings17 | ExpressRouteGateways8 | ExpressRouteGatewaysExpressRouteConnections8 | ExpressRoutePorts13 | FirewallPolicies7 | FirewallPoliciesRuleGroups7 | IpAllocations1 | IpGroups4 | LoadBalancers34 | LoadBalancersBackendAddressPools | LoadBalancersInboundNatRules22 | LocalNetworkGateways26 | NatGateways9 | NetworkInterfaces35 | NetworkInterfacesTapConfigurations13 | NetworkProfiles8 | NetworkSecurityGroups34 | NetworkSecurityGroupsSecurityRules26 | NetworkVirtualAppliances2 | NetworkWatchers11 | NetworkWatchersConnectionMonitors8 | NetworkWatchersFlowLogs3 | NetworkWatchersPacketCaptures11 | P2SvpnGateways8 | PrivateEndpoints8 | PrivateEndpointsPrivateDnsZoneGroups1 | PrivateLinkServices8 | PrivateLinkServicesPrivateEndpointConnections8 | PublicIPAddresses34 | PublicIPPrefixes9 | RouteFilters11 | RouteFiltersRouteFilterRules11 | RouteTables34 | RouteTablesRoutes26 | SecurityPartnerProviders1 | ServiceEndpointPolicies9 | ServiceEndpointPoliciesServiceEndpointPolicyDefinitions9 | VirtualHubs11 | VirtualHubsHubRouteTables | VirtualHubsRouteTables4 | VirtualNetworkGateways26 | VirtualNetworks34 | VirtualNetworksSubnets26 | VirtualNetworksVirtualNetworkPeerings23 | VirtualNetworkTaps8 | VirtualRouters6 | VirtualRoutersPeerings6 | VirtualWans11 | VpnGateways11 | VpnGatewaysVpnConnections11 | VpnServerConfigurations5 | VpnSites11 | ApplicationGateways27 | ApplicationGatewaysPrivateEndpointConnections | ApplicationGatewayWebApplicationFirewallPolicies11 | ApplicationSecurityGroups22 | AzureFirewalls12 | BastionHosts9 | Connections27 | DdosCustomPolicies9 | DdosProtectionPlans18 | ExpressRouteCircuits20 | ExpressRouteCircuitsAuthorizations21 | ExpressRouteCircuitsPeerings21 | ExpressRouteCircuitsPeeringsConnections18 | ExpressRouteCrossConnections18 | ExpressRouteCrossConnectionsPeerings18 | ExpressRouteGateways9 | ExpressRouteGatewaysExpressRouteConnections9 | ExpressRoutePorts14 | FirewallPolicies8 | FirewallPoliciesRuleCollectionGroups | IpAllocations2 | IpGroups5 | LoadBalancers35 | LoadBalancersBackendAddressPools1 | LoadBalancersInboundNatRules23 | LocalNetworkGateways27 | NatGateways10 | NetworkInterfaces36 | NetworkInterfacesTapConfigurations14 | NetworkProfiles9 | NetworkSecurityGroups35 | NetworkSecurityGroupsSecurityRules27 | NetworkVirtualAppliances3 | NetworkVirtualAppliancesVirtualApplianceSites | NetworkWatchers12 | NetworkWatchersConnectionMonitors9 | NetworkWatchersFlowLogs4 | NetworkWatchersPacketCaptures12 | P2SvpnGateways9 | PrivateEndpoints9 | PrivateEndpointsPrivateDnsZoneGroups2 | PrivateLinkServices9 | PrivateLinkServicesPrivateEndpointConnections9 | PublicIPAddresses35 | PublicIPPrefixes10 | RouteFilters12 | RouteFiltersRouteFilterRules12 | RouteTables35 | RouteTablesRoutes27 | SecurityPartnerProviders2 | ServiceEndpointPolicies10 | ServiceEndpointPoliciesServiceEndpointPolicyDefinitions10 | VirtualHubs12 | VirtualHubsBgpConnections | VirtualHubsHubRouteTables1 | VirtualHubsHubVirtualNetworkConnections | VirtualHubsIpConfigurations | VirtualHubsRouteTables5 | VirtualNetworkGateways27 | VirtualNetworks35 | VirtualNetworksSubnets27 | VirtualNetworksVirtualNetworkPeerings24 | VirtualNetworkTaps9 | VirtualRouters7 | VirtualRoutersPeerings7 | VirtualWans12 | VpnGateways12 | VpnGatewaysVpnConnections12 | VpnServerConfigurations6 | VpnSites12 | Services2 | ServicesProjects | Services3 | ServicesProjects1 | Budgets | Clusters14 | FileServers | Jobs1 | VaultsBackupFabricsProtectionContainersProtectedItems | VaultsBackupPolicies | VaultsBackupFabricsBackupProtectionIntent | VaultsBackupFabricsProtectionContainers | VaultsBackupstorageconfig | Disks2 | Snapshots2 | ContainerGroups | ContainerGroups1 | Galleries | GalleriesImages | GalleriesImagesVersions | Images3 | AvailabilitySets4 | VirtualMachines5 | VirtualMachineScaleSets4 | Disks3 | Snapshots3 | VirtualMachineScaleSetsVirtualmachines | VirtualMachinesExtensions3 | VirtualMachineScaleSetsExtensions1 | Images4 | AvailabilitySets5 | VirtualMachines6 | VirtualMachineScaleSets5 | VirtualMachineScaleSetsVirtualmachines1 | VirtualMachinesExtensions4 | VirtualMachineScaleSetsExtensions2 | AvailabilitySets6 | HostGroups | HostGroupsHosts | Images5 | ProximityPlacementGroups | VirtualMachines7 | VirtualMachineScaleSets6 | VirtualMachineScaleSetsVirtualmachines2 | VirtualMachinesExtensions5 | VirtualMachineScaleSetsExtensions3 | Galleries1 | GalleriesImages1 | GalleriesImagesVersions1 | IotApps | Accounts8 | Workspaces8 | WorkspacesClusters | WorkspacesExperiments | WorkspacesExperimentsJobs | WorkspacesFileServers | ContainerServices1 | ManagedClusters | WorkspacesSavedSearches | WorkspacesStorageInsightConfigs | Workspaces9 | WorkspacesDataSources | WorkspacesLinkedServices | Clusters15 | ManagementConfigurations | Solutions | Peerings | PeeringServices | PeeringServicesPrefixes | Peerings1 | PeeringServices1 | PeeringServicesPrefixes1 | Peerings2 | PeeringsRegisteredAsns | PeeringsRegisteredPrefixes | PeeringServices2 | PeeringServicesPrefixes2 | DomainServices | DomainServices1 | DomainServicesOuContainer | SignalR | NetAppAccounts | NetAppAccountsCapacityPools | NetAppAccountsCapacityPoolsVolumes | NetAppAccountsCapacityPoolsVolumesSnapshots | NetAppAccounts1 | NetAppAccountsCapacityPools1 | NetAppAccountsCapacityPoolsVolumes1 | NetAppAccountsCapacityPoolsVolumesSnapshots1 | Managers1 | ManagersAccessControlRecords1 | ManagersCertificates | ManagersDevicesAlertSettings1 | ManagersDevicesBackupScheduleGroups | ManagersDevicesChapSettings | ManagersDevicesFileservers | ManagersDevicesFileserversShares | ManagersDevicesIscsiservers | ManagersDevicesIscsiserversDisks | ManagersExtendedInformation1 | ManagersStorageAccountCredentials1 | ManagersStorageDomains | Accounts9 | Accounts10 | AccountsPrivateAtlases | UserAssignedIdentities | UserAssignedIdentities1 | Clusters16 | ClustersApplications2 | ClustersExtensions | Clusters17 | ClustersApplications3 | ClustersExtensions1 | LocationsJitNetworkAccessPolicies | IotSecuritySolutions | Pricings | AdvancedThreatProtectionSettings | DeviceSecurityGroups | AdvancedThreatProtectionSettings1 | Automations | Assessments | IotSecuritySolutions1 | DeviceSecurityGroups1 | LocationsJitNetworkAccessPolicies1 | Assessments1 | AssessmentProjects | AssessmentProjectsGroups | AssessmentProjectsGroupsAssessments | AssessmentProjectsHypervcollectors | AssessmentProjectsVmwarecollectors | RegistrationAssignments | RegistrationDefinitions | RegistrationAssignments1 | RegistrationDefinitions1 | CrayServers | ManagedClusters1 | ManagedClustersAgentPools | MigrateProjects | MigrateProjectsSolutions | Namespaces3 | Namespaces_AuthorizationRules3 | NamespacesQueues | NamespacesQueuesAuthorizationRules | NamespacesTopics | NamespacesTopicsAuthorizationRules | NamespacesTopicsSubscriptions | Namespaces4 | Namespaces_AuthorizationRules4 | NamespacesDisasterRecoveryConfigs | NamespacesMigrationConfigurations | NamespacesNetworkRuleSets | NamespacesQueues1 | NamespacesQueuesAuthorizationRules1 | NamespacesTopics1 | NamespacesTopicsAuthorizationRules1 | NamespacesTopicsSubscriptions1 | NamespacesTopicsSubscriptionsRules | Namespaces5 | NamespacesIpfilterrules | NamespacesNetworkRuleSets1 | NamespacesVirtualnetworkrules | NamespacesPrivateEndpointConnections | NamespacesQueues2 | NamespacesQueuesAuthorizationRules2 | NamespacesTopics2 | NamespacesTopicsAuthorizationRules2 | NamespacesTopicsSubscriptions2 | NamespacesTopicsSubscriptionsRules1 | NamespacesDisasterRecoveryConfigs1 | NamespacesMigrationConfigurations1 | Namespaces_AuthorizationRules5 | Account | AccountExtension | AccountProject | Namespaces6 | Namespaces_AuthorizationRules6 | NamespacesEventhubs | NamespacesEventhubsAuthorizationRules | NamespacesEventhubsConsumergroups | Namespaces7 | Namespaces_AuthorizationRules7 | NamespacesEventhubs1 | NamespacesEventhubsAuthorizationRules1 | NamespacesEventhubsConsumergroups1 | Namespaces8 | NamespacesAuthorizationRules | NamespacesDisasterRecoveryConfigs2 | NamespacesEventhubs2 | NamespacesEventhubsAuthorizationRules2 | NamespacesEventhubsConsumergroups2 | NamespacesNetworkRuleSets2 | Clusters18 | Namespaces9 | NamespacesIpfilterrules1 | NamespacesNetworkRuleSets3 | NamespacesVirtualnetworkrules1 | Namespaces10 | Namespaces_AuthorizationRules8 | Namespaces_HybridConnections | Namespaces_HybridConnectionsAuthorizationRules | Namespaces_WcfRelays | Namespaces_WcfRelaysAuthorizationRules | Namespaces11 | NamespacesAuthorizationRules1 | NamespacesHybridConnections | NamespacesHybridConnectionsAuthorizationRules | NamespacesWcfRelays | NamespacesWcfRelaysAuthorizationRules | Factories | FactoriesDatasets | FactoriesIntegrationRuntimes | FactoriesLinkedservices | FactoriesPipelines | FactoriesTriggers | Factories1 | FactoriesDataflows | FactoriesDatasets1 | FactoriesIntegrationRuntimes1 | FactoriesLinkedservices1 | FactoriesPipelines1 | FactoriesTriggers1 | FactoriesManagedVirtualNetworks | FactoriesManagedVirtualNetworksManagedPrivateEndpoints | Topics | EventSubscriptions | Topics1 | EventSubscriptions1 | Topics2 | EventSubscriptions2 | Topics3 | EventSubscriptions3 | Domains | Topics4 | EventSubscriptions4 | Topics5 | EventSubscriptions5 | Domains1 | DomainsTopics | Topics6 | EventSubscriptions6 | Domains2 | DomainsTopics1 | Topics7 | EventSubscriptions7 | AvailabilitySets7 | DiskEncryptionSets | Disks4 | HostGroups1 | HostGroupsHosts1 | Images6 | ProximityPlacementGroups1 | Snapshots4 | VirtualMachines8 | VirtualMachineScaleSets7 | VirtualMachineScaleSetsVirtualmachines3 | VirtualMachineScaleSetsVirtualMachinesExtensions | VirtualMachinesExtensions6 | VirtualMachineScaleSetsExtensions4 | MultipleActivationKeys | JobCollectionsJobs1 | JobCollections2 | JobCollectionsJobs2 | SearchServices1 | SearchServices2 | SearchServicesPrivateEndpointConnections | Workspaces10 | WorkspacesAdministrators | WorkspacesBigDataPools | WorkspacesFirewallRules | WorkspacesManagedIdentitySqlControlSettings | WorkspacesSqlPools | WorkspacesSqlPoolsAuditingSettings | WorkspacesSqlPoolsMetadataSync | WorkspacesSqlPoolsSchemasTablesColumnsSensitivityLabels | WorkspacesSqlPoolsSecurityAlertPolicies | WorkspacesSqlPoolsTransparentDataEncryption | WorkspacesSqlPoolsVulnerabilityAssessments | WorkspacesSqlPoolsVulnerabilityAssessmentsRulesBaselines | Queries | CommunicationServices | Alertrules | Components | Webtests | Autoscalesettings | Components1 | ComponentsAnalyticsItems | Components_Annotations | ComponentsCurrentbillingfeatures | ComponentsFavorites | ComponentsMyanalyticsItems | Components_ProactiveDetectionConfigs | MyWorkbooks | Webtests1 | Workbooks | ComponentsExportconfiguration | ComponentsPricingPlans | Components2 | Components_ProactiveDetectionConfigs1 | Workbooks1 | Workbooktemplates | Components3 | ComponentsLinkedStorageAccounts | Autoscalesettings1 | Alertrules1 | ActivityLogAlerts | ActionGroups | ActivityLogAlerts1 | ActionGroups1 | MetricAlerts | ScheduledQueryRules | GuestDiagnosticSettings | ActionGroups2 | ActionGroups3 | ActionGroups4 | PrivateLinkScopes | PrivateLinkScopesPrivateEndpointConnections | PrivateLinkScopesScopedResources | DataCollectionRules | ScheduledQueryRules1 | Workspaces11 | Locks | Policyassignments | Policyassignments1 | Locks1 | PolicyAssignments | PolicyAssignments1 | PolicyAssignments2 | PolicyAssignments3 | PolicyAssignments4 | PolicyAssignments5 | PolicyAssignments6 | PolicyAssignments7 | PolicyExemptions | PolicyAssignments8 | CertificateOrders | CertificateOrdersCertificates | CertificateOrders1 | CertificateOrdersCertificates1 | CertificateOrders2 | CertificateOrdersCertificates2 | CertificateOrders3 | CertificateOrdersCertificates3 | CertificateOrders4 | CertificateOrdersCertificates4 | CertificateOrders5 | CertificateOrdersCertificates5 | CertificateOrders6 | CertificateOrdersCertificates6 | Domains3 | DomainsDomainOwnershipIdentifiers | Domains4 | DomainsDomainOwnershipIdentifiers1 | Domains5 | DomainsDomainOwnershipIdentifiers2 | Domains6 | DomainsDomainOwnershipIdentifiers3 | Domains7 | DomainsDomainOwnershipIdentifiers4 | Domains8 | DomainsDomainOwnershipIdentifiers5 | Domains9 | DomainsDomainOwnershipIdentifiers6 | Certificates | Csrs | HostingEnvironments | HostingEnvironmentsMultiRolePools | HostingEnvironmentsWorkerPools | ManagedHostingEnvironments | Serverfarms | ServerfarmsVirtualNetworkConnectionsGateways | ServerfarmsVirtualNetworkConnectionsRoutes | Sites | SitesBackups | SitesConfig | SitesDeployments | SitesHostNameBindings | SitesHybridconnection | SitesInstancesDeployments | SitesPremieraddons | SitesSlots | SitesSlotsBackups | SitesSlotsConfig | SitesSlotsDeployments | SitesSlotsHostNameBindings | SitesSlotsHybridconnection | SitesSlotsInstancesDeployments | SitesSlotsPremieraddons | SitesSlotsSnapshots | SitesSlotsSourcecontrols | SitesSlotsVirtualNetworkConnections | SitesSlotsVirtualNetworkConnectionsGateways | SitesSnapshots | SitesSourcecontrols | SitesVirtualNetworkConnections | SitesVirtualNetworkConnectionsGateways | Connections28 | Certificates1 | ConnectionGateways | Connections29 | CustomApis | Sites1 | SitesBackups1 | SitesConfig1 | SitesDeployments1 | SitesDomainOwnershipIdentifiers | SitesExtensions | SitesFunctions | SitesHostNameBindings1 | SitesHybridconnection1 | SitesHybridConnectionNamespacesRelays | SitesInstancesExtensions | SitesMigrate | SitesPremieraddons1 | SitesPublicCertificates | SitesSiteextensions | SitesSlots1 | SitesSlotsBackups1 | SitesSlotsConfig1 | SitesSlotsDeployments1 | SitesSlotsDomainOwnershipIdentifiers | SitesSlotsExtensions | SitesSlotsFunctions | SitesSlotsHostNameBindings1 | SitesSlotsHybridconnection1 | SitesSlotsHybridConnectionNamespacesRelays | SitesSlotsInstancesExtensions | SitesSlotsPremieraddons1 | SitesSlotsPublicCertificates | SitesSlotsSiteextensions | SitesSlotsSourcecontrols1 | SitesSlotsVirtualNetworkConnections1 | SitesSlotsVirtualNetworkConnectionsGateways1 | SitesSourcecontrols1 | SitesVirtualNetworkConnections1 | SitesVirtualNetworkConnectionsGateways1 | HostingEnvironments1 | HostingEnvironmentsMultiRolePools1 | HostingEnvironmentsWorkerPools1 | Serverfarms1 | ServerfarmsVirtualNetworkConnectionsGateways1 | ServerfarmsVirtualNetworkConnectionsRoutes1 | Certificates2 | HostingEnvironments2 | HostingEnvironmentsMultiRolePools2 | HostingEnvironmentsWorkerPools2 | Serverfarms2 | ServerfarmsVirtualNetworkConnectionsGateways2 | ServerfarmsVirtualNetworkConnectionsRoutes2 | Sites2 | SitesConfig2 | SitesDeployments2 | SitesDomainOwnershipIdentifiers1 | SitesExtensions1 | SitesFunctions1 | SitesFunctionsKeys | SitesHostNameBindings2 | SitesHybridconnection2 | SitesHybridConnectionNamespacesRelays1 | SitesInstancesExtensions1 | SitesMigrate1 | SitesNetworkConfig | SitesPremieraddons2 | SitesPrivateAccess | SitesPublicCertificates1 | SitesSiteextensions1 | SitesSlots2 | SitesSlotsConfig2 | SitesSlotsDeployments2 | SitesSlotsDomainOwnershipIdentifiers1 | SitesSlotsExtensions1 | SitesSlotsFunctions1 | SitesSlotsFunctionsKeys | SitesSlotsHostNameBindings2 | SitesSlotsHybridconnection2 | SitesSlotsHybridConnectionNamespacesRelays1 | SitesSlotsInstancesExtensions1 | SitesSlotsNetworkConfig | SitesSlotsPremieraddons2 | SitesSlotsPrivateAccess | SitesSlotsPublicCertificates1 | SitesSlotsSiteextensions1 | SitesSlotsSourcecontrols2 | SitesSlotsVirtualNetworkConnections2 | SitesSlotsVirtualNetworkConnectionsGateways2 | SitesSourcecontrols2 | SitesVirtualNetworkConnections2 | SitesVirtualNetworkConnectionsGateways2 | Certificates3 | Sites3 | SitesConfig3 | SitesDeployments3 | SitesDomainOwnershipIdentifiers2 | SitesExtensions2 | SitesFunctions2 | SitesHostNameBindings3 | SitesHybridconnection3 | SitesHybridConnectionNamespacesRelays2 | SitesInstancesExtensions2 | SitesMigrate2 | SitesNetworkConfig1 | SitesPremieraddons3 | SitesPrivateAccess1 | SitesPublicCertificates2 | SitesSiteextensions2 | SitesSlots3 | SitesSlotsConfig3 | SitesSlotsDeployments3 | SitesSlotsDomainOwnershipIdentifiers2 | SitesSlotsExtensions2 | SitesSlotsFunctions2 | SitesSlotsHostNameBindings3 | SitesSlotsHybridconnection3 | SitesSlotsHybridConnectionNamespacesRelays2 | SitesSlotsInstancesExtensions2 | SitesSlotsNetworkConfig1 | SitesSlotsPremieraddons3 | SitesSlotsPrivateAccess1 | SitesSlotsPublicCertificates2 | SitesSlotsSiteextensions2 | SitesSlotsSourcecontrols3 | SitesSlotsVirtualNetworkConnections3 | SitesSlotsVirtualNetworkConnectionsGateways3 | SitesSourcecontrols3 | SitesVirtualNetworkConnections3 | SitesVirtualNetworkConnectionsGateways3 | Certificates4 | HostingEnvironments3 | HostingEnvironmentsMultiRolePools3 | HostingEnvironmentsWorkerPools3 | Serverfarms3 | ServerfarmsVirtualNetworkConnectionsGateways3 | ServerfarmsVirtualNetworkConnectionsRoutes3 | Sites4 | SitesBasicPublishingCredentialsPolicies | SitesConfig4 | SitesDeployments4 | SitesDomainOwnershipIdentifiers3 | SitesExtensions3 | SitesFunctions3 | SitesFunctionsKeys1 | SitesHostNameBindings4 | SitesHybridconnection4 | SitesHybridConnectionNamespacesRelays3 | SitesInstancesExtensions3 | SitesMigrate3 | SitesNetworkConfig2 | SitesPremieraddons4 | SitesPrivateAccess2 | SitesPrivateEndpointConnections | SitesPublicCertificates3 | SitesSiteextensions3 | SitesSlots4 | SitesSlotsConfig4 | SitesSlotsDeployments4 | SitesSlotsDomainOwnershipIdentifiers3 | SitesSlotsExtensions3 | SitesSlotsFunctions3 | SitesSlotsFunctionsKeys1 | SitesSlotsHostNameBindings4 | SitesSlotsHybridconnection4 | SitesSlotsHybridConnectionNamespacesRelays3 | SitesSlotsInstancesExtensions3 | SitesSlotsNetworkConfig2 | SitesSlotsPremieraddons4 | SitesSlotsPrivateAccess2 | SitesSlotsPublicCertificates3 | SitesSlotsSiteextensions3 | SitesSlotsSourcecontrols4 | SitesSlotsVirtualNetworkConnections4 | SitesSlotsVirtualNetworkConnectionsGateways4 | SitesSourcecontrols4 | SitesVirtualNetworkConnections4 | SitesVirtualNetworkConnectionsGateways4 | StaticSites | StaticSitesBuildsConfig | StaticSitesConfig | StaticSitesCustomDomains | Certificates5 | HostingEnvironments4 | HostingEnvironmentsMultiRolePools4 | HostingEnvironmentsWorkerPools4 | Serverfarms4 | ServerfarmsVirtualNetworkConnectionsGateways4 | ServerfarmsVirtualNetworkConnectionsRoutes4 | Sites5 | SitesBasicPublishingCredentialsPolicies1 | SitesConfig5 | SitesDeployments5 | SitesDomainOwnershipIdentifiers4 | SitesExtensions4 | SitesFunctions4 | SitesFunctionsKeys2 | SitesHostNameBindings5 | SitesHybridconnection5 | SitesHybridConnectionNamespacesRelays4 | SitesInstancesExtensions4 | SitesMigrate4 | SitesNetworkConfig3 | SitesPremieraddons5 | SitesPrivateAccess3 | SitesPrivateEndpointConnections1 | SitesPublicCertificates4 | SitesSiteextensions4 | SitesSlots5 | SitesSlotsConfig5 | SitesSlotsDeployments5 | SitesSlotsDomainOwnershipIdentifiers4 | SitesSlotsExtensions4 | SitesSlotsFunctions4 | SitesSlotsFunctionsKeys2 | SitesSlotsHostNameBindings5 | SitesSlotsHybridconnection5 | SitesSlotsHybridConnectionNamespacesRelays4 | SitesSlotsInstancesExtensions4 | SitesSlotsNetworkConfig3 | SitesSlotsPremieraddons5 | SitesSlotsPrivateAccess3 | SitesSlotsPublicCertificates4 | SitesSlotsSiteextensions4 | SitesSlotsSourcecontrols5 | SitesSlotsVirtualNetworkConnections5 | SitesSlotsVirtualNetworkConnectionsGateways5 | SitesSourcecontrols5 | SitesVirtualNetworkConnections5 | SitesVirtualNetworkConnectionsGateways5 | StaticSites1 | StaticSitesBuildsConfig1 | StaticSitesConfig1 | StaticSitesCustomDomains1 | Certificates6 | HostingEnvironments5 | HostingEnvironmentsMultiRolePools5 | HostingEnvironmentsWorkerPools5 | Serverfarms5 | ServerfarmsVirtualNetworkConnectionsGateways5 | ServerfarmsVirtualNetworkConnectionsRoutes5 | Sites6 | SitesBasicPublishingCredentialsPolicies2 | SitesConfig6 | SitesDeployments6 | SitesDomainOwnershipIdentifiers5 | SitesExtensions5 | SitesFunctions5 | SitesFunctionsKeys3 | SitesHostNameBindings6 | SitesHybridconnection6 | SitesHybridConnectionNamespacesRelays5 | SitesInstancesExtensions5 | SitesMigrate5 | SitesNetworkConfig4 | SitesPremieraddons6 | SitesPrivateAccess4 | SitesPrivateEndpointConnections2 | SitesPublicCertificates5 | SitesSiteextensions5 | SitesSlots6 | SitesSlotsConfig6 | SitesSlotsDeployments6 | SitesSlotsDomainOwnershipIdentifiers5 | SitesSlotsExtensions5 | SitesSlotsFunctions5 | SitesSlotsFunctionsKeys3 | SitesSlotsHostNameBindings6 | SitesSlotsHybridconnection6 | SitesSlotsHybridConnectionNamespacesRelays5 | SitesSlotsInstancesExtensions5 | SitesSlotsNetworkConfig4 | SitesSlotsPremieraddons6 | SitesSlotsPrivateAccess4 | SitesSlotsPublicCertificates5 | SitesSlotsSiteextensions5 | SitesSlotsSourcecontrols6 | SitesSlotsVirtualNetworkConnections6 | SitesSlotsVirtualNetworkConnectionsGateways6 | SitesSourcecontrols6 | SitesVirtualNetworkConnections6 | SitesVirtualNetworkConnectionsGateways6 | StaticSites2 | StaticSitesBuildsConfig2 | StaticSitesConfig2 | StaticSitesCustomDomains2 | Certificates7 | HostingEnvironments6 | HostingEnvironmentsMultiRolePools6 | HostingEnvironmentsWorkerPools6 | Serverfarms6 | ServerfarmsVirtualNetworkConnectionsGateways6 | ServerfarmsVirtualNetworkConnectionsRoutes6 | Sites7 | SitesBasicPublishingCredentialsPolicies3 | SitesConfig7 | SitesDeployments7 | SitesDomainOwnershipIdentifiers6 | SitesExtensions6 | SitesFunctions6 | SitesFunctionsKeys4 | SitesHostNameBindings7 | SitesHybridconnection7 | SitesHybridConnectionNamespacesRelays6 | SitesInstancesExtensions6 | SitesMigrate6 | SitesNetworkConfig5 | SitesPremieraddons7 | SitesPrivateAccess5 | SitesPrivateEndpointConnections3 | SitesPublicCertificates6 | SitesSiteextensions6 | SitesSlots7 | SitesSlotsConfig7 | SitesSlotsDeployments7 | SitesSlotsDomainOwnershipIdentifiers6 | SitesSlotsExtensions6 | SitesSlotsFunctions6 | SitesSlotsFunctionsKeys4 | SitesSlotsHostNameBindings7 | SitesSlotsHybridconnection7 | SitesSlotsHybridConnectionNamespacesRelays6 | SitesSlotsInstancesExtensions6 | SitesSlotsNetworkConfig5 | SitesSlotsPremieraddons7 | SitesSlotsPrivateAccess5 | SitesSlotsPublicCertificates6 | SitesSlotsSiteextensions6 | SitesSlotsSourcecontrols7 | SitesSlotsVirtualNetworkConnections7 | SitesSlotsVirtualNetworkConnectionsGateways7 | SitesSourcecontrols7 | SitesVirtualNetworkConnections7 | SitesVirtualNetworkConnectionsGateways7 | StaticSites3 | StaticSitesBuildsConfig3 | StaticSitesConfig3 | StaticSitesCustomDomains3 | Certificates8 | HostingEnvironments7 | HostingEnvironmentsConfigurations | HostingEnvironmentsMultiRolePools7 | HostingEnvironmentsPrivateEndpointConnections | HostingEnvironmentsWorkerPools7 | Serverfarms7 | ServerfarmsVirtualNetworkConnectionsGateways7 | ServerfarmsVirtualNetworkConnectionsRoutes7 | Sites8 | SitesBasicPublishingCredentialsPolicies4 | SitesConfig8 | SitesDeployments8 | SitesDomainOwnershipIdentifiers7 | SitesExtensions7 | SitesFunctions7 | SitesFunctionsKeys5 | SitesHostNameBindings8 | SitesHybridconnection8 | SitesHybridConnectionNamespacesRelays7 | SitesInstancesExtensions7 | SitesMigrate7 | SitesNetworkConfig6 | SitesPremieraddons8 | SitesPrivateAccess6 | SitesPrivateEndpointConnections4 | SitesPublicCertificates7 | SitesSiteextensions7 | SitesSlots8 | SitesSlotsBasicPublishingCredentialsPolicies | SitesSlotsConfig8 | SitesSlotsDeployments8 | SitesSlotsDomainOwnershipIdentifiers7 | SitesSlotsExtensions7 | SitesSlotsFunctions7 | SitesSlotsFunctionsKeys5 | SitesSlotsHostNameBindings8 | SitesSlotsHybridconnection8 | SitesSlotsHybridConnectionNamespacesRelays7 | SitesSlotsInstancesExtensions7 | SitesSlotsPremieraddons8 | SitesSlotsPrivateAccess6 | SitesSlotsPrivateEndpointConnections | SitesSlotsPublicCertificates7 | SitesSlotsSiteextensions7 | SitesSlotsSourcecontrols8 | SitesSlotsVirtualNetworkConnections8 | SitesSlotsVirtualNetworkConnectionsGateways8 | SitesSourcecontrols8 | SitesVirtualNetworkConnections8 | SitesVirtualNetworkConnectionsGateways8 | StaticSites4 | StaticSitesBuildsConfig4 | StaticSitesBuildsUserProvidedFunctionApps | StaticSitesConfig4 | StaticSitesCustomDomains4 | StaticSitesPrivateEndpointConnections | StaticSitesUserProvidedFunctionApps)) | ((ARMResourceBase & {␊ - /**␊ - * Location to deploy resource to␊ - */␊ - location?: (string | ("East Asia" | "Southeast Asia" | "Central US" | "East US" | "East US 2" | "West US" | "North Central US" | "South Central US" | "North Europe" | "West Europe" | "Japan West" | "Japan East" | "Brazil South" | "Australia East" | "Australia Southeast" | "Central India" | "West India" | "South India" | "Canada Central" | "Canada East" | "West Central US" | "West US 2" | "UK South" | "UK West" | "Korea Central" | "Korea South" | "global"))␊ - /**␊ - * Name-value pairs to add to the resource␊ - */␊ - tags?: {␊ - [k: string]: unknown␊ - }␊ - copy?: ResourceCopy␊ - /**␊ - * Scope for the resource or deployment. Today, this works for two cases: 1) setting the scope for extension resources 2) deploying resources to the tenant scope in non-tenant scope deployments␊ - */␊ - scope?: string␊ - comments?: string␊ - [k: string]: unknown␊ - }) & Accounts11) | (ARMResourceBase & (Deployments2 | Deployments3 | Deployments4 | Deployments5 | Links)))␊ - export type ResourceBase = (ARMResourceBase & {␊ - /**␊ - * Location to deploy resource to␊ - */␊ - location?: (string | ("East Asia" | "Southeast Asia" | "Central US" | "East US" | "East US 2" | "West US" | "North Central US" | "South Central US" | "North Europe" | "West Europe" | "Japan West" | "Japan East" | "Brazil South" | "Australia East" | "Australia Southeast" | "Central India" | "West India" | "South India" | "Canada Central" | "Canada East" | "West Central US" | "West US 2" | "UK South" | "UK West" | "Korea Central" | "Korea South" | "global"))␊ - /**␊ - * Name-value pairs to add to the resource␊ - */␊ - tags?: {␊ - [k: string]: unknown␊ - }␊ - copy?: ResourceCopy␊ - /**␊ - * Scope for the resource or deployment. Today, this works for two cases: 1) setting the scope for extension resources 2) deploying resources to the tenant scope in non-tenant scope deployments␊ - */␊ - scope?: string␊ - comments?: string␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Base class for all types of Route.␊ - */␊ - export type RouteConfiguration = ({␊ - [k: string]: unknown␊ - } & (ForwardingConfiguration | RedirectConfiguration))␊ - /**␊ - * Base class for all types of Route.␊ - */␊ - export type RouteConfiguration1 = ({␊ - [k: string]: unknown␊ - } & (ForwardingConfiguration1 | RedirectConfiguration1))␊ - /**␊ - * Base class for all types of Route.␊ - */␊ - export type RouteConfiguration2 = ({␊ - [k: string]: unknown␊ - } & (ForwardingConfiguration2 | RedirectConfiguration2))␊ - /**␊ - * Microsoft.DocumentDB/databaseAccounts/apis/databases/settings␊ - */␊ - export type DatabaseAccountsApisDatabasesSettingsChildResource = ({␊ - apiVersion: "2015-04-08"␊ - type: "settings"␊ - [k: string]: unknown␊ - } & {␊ - name: "throughput"␊ - /**␊ - * Properties to update Azure Cosmos DB resource throughput.␊ - */␊ - properties: (ThroughputUpdateProperties | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Fabric provider specific settings.␊ - */␊ - export type FabricSpecificCreationInput = ({␊ - [k: string]: unknown␊ - } & (AzureFabricCreationInput | VMwareV2FabricCreationInput))␊ - /**␊ - * Provider specific input for container creation operation.␊ - */␊ - export type ReplicationProviderSpecificContainerCreationInput = ({␊ - [k: string]: unknown␊ - } & (A2AContainerCreationInput | VMwareCbtContainerCreationInput))␊ - /**␊ - * Input details specific to fabrics during Network Mapping.␊ - */␊ - export type FabricSpecificCreateNetworkMappingInput = ({␊ - [k: string]: unknown␊ - } & (AzureToAzureCreateNetworkMappingInput | VmmToAzureCreateNetworkMappingInput | VmmToVmmCreateNetworkMappingInput))␊ - /**␊ - * Enable migration provider specific input.␊ - */␊ - export type EnableMigrationProviderSpecificInput = ({␊ - [k: string]: unknown␊ - } & VMwareCbtEnableMigrationInput)␊ - /**␊ - * Enable protection provider specific input.␊ - */␊ - export type EnableProtectionProviderSpecificInput = ({␊ - [k: string]: unknown␊ - } & (A2AEnableProtectionInput | HyperVReplicaAzureEnableProtectionInput | InMageAzureV2EnableProtectionInput | InMageEnableProtectionInput | SanEnableProtectionInput))␊ - /**␊ - * Provider specific input for pairing operations.␊ - */␊ - export type ReplicationProviderSpecificContainerMappingInput = ({␊ - [k: string]: unknown␊ - } & (A2AContainerMappingInput | VMwareCbtContainerMappingInput))␊ - /**␊ - * Base class for provider specific input␊ - */␊ - export type PolicyProviderSpecificInput = ({␊ - [k: string]: unknown␊ - } & (A2APolicyCreationInput | HyperVReplicaAzurePolicyInput | HyperVReplicaBluePolicyInput | HyperVReplicaPolicyInput | InMageAzureV2PolicyInput | InMagePolicyInput | VMwareCbtPolicyCreationInput))␊ - /**␊ - * Recovery plan action custom details.␊ - */␊ - export type RecoveryPlanActionDetails = ({␊ - [k: string]: unknown␊ - } & (RecoveryPlanAutomationRunbookActionDetails | RecoveryPlanManualActionDetails | RecoveryPlanScriptActionDetails))␊ - /**␊ - * Properties related to Digital Twins Endpoint␊ - */␊ - export type DigitalTwinsEndpointResourceProperties = ({␊ - /**␊ - * The resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - } & (ServiceBus | EventHub | EventGrid))␊ - /**␊ - * Microsoft.Kusto/clusters/databases/dataConnections␊ - */␊ - export type ClustersDatabasesDataConnectionsChildResource = ({␊ - apiVersion: "2019-01-21"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the data connection.␊ - */␊ - name: string␊ - type: "dataConnections"␊ - [k: string]: unknown␊ - } & (EventHubDataConnection | EventGridDataConnection))␊ - /**␊ - * Microsoft.Kusto/clusters/databases/dataConnections␊ - */␊ - export type ClustersDatabasesDataConnections = ({␊ - apiVersion: "2019-01-21"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the data connection.␊ - */␊ - name: string␊ - type: "Microsoft.Kusto/clusters/databases/dataConnections"␊ - [k: string]: unknown␊ - } & (EventHubDataConnection | EventGridDataConnection))␊ - /**␊ - * Microsoft.Kusto/clusters/databases/dataConnections␊ - */␊ - export type ClustersDatabasesDataConnectionsChildResource1 = ({␊ - apiVersion: "2019-05-15"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the data connection.␊ - */␊ - name: string␊ - type: "dataConnections"␊ - [k: string]: unknown␊ - } & (EventHubDataConnection1 | IotHubDataConnection | EventGridDataConnection1))␊ - /**␊ - * Microsoft.Kusto/clusters/databases/dataConnections␊ - */␊ - export type ClustersDatabasesDataConnections1 = ({␊ - apiVersion: "2019-05-15"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the data connection.␊ - */␊ - name: string␊ - type: "Microsoft.Kusto/clusters/databases/dataConnections"␊ - [k: string]: unknown␊ - } & (EventHubDataConnection1 | IotHubDataConnection | EventGridDataConnection1))␊ - /**␊ - * Microsoft.Kusto/clusters/databases␊ - */␊ - export type ClustersDatabasesChildResource3 = ({␊ - apiVersion: "2019-09-07"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the database in the Kusto cluster.␊ - */␊ - name: string␊ - type: "databases"␊ - [k: string]: unknown␊ - } & (ReadWriteDatabase | ReadOnlyFollowingDatabase))␊ - /**␊ - * Microsoft.Kusto/clusters/databases␊ - */␊ - export type ClustersDatabases4 = ({␊ - apiVersion: "2019-09-07"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the database in the Kusto cluster.␊ - */␊ - name: string␊ - resources?: ClustersDatabasesDataConnectionsChildResource2[]␊ - type: "Microsoft.Kusto/clusters/databases"␊ - [k: string]: unknown␊ - } & (ReadWriteDatabase | ReadOnlyFollowingDatabase))␊ - /**␊ - * Microsoft.Kusto/clusters/databases/dataConnections␊ - */␊ - export type ClustersDatabasesDataConnectionsChildResource2 = ({␊ - apiVersion: "2019-09-07"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the data connection.␊ - */␊ - name: string␊ - type: "dataConnections"␊ - [k: string]: unknown␊ - } & (EventHubDataConnection2 | IotHubDataConnection1 | EventGridDataConnection2))␊ - /**␊ - * Microsoft.Kusto/clusters/databases/dataConnections␊ - */␊ - export type ClustersDatabasesDataConnections2 = ({␊ - apiVersion: "2019-09-07"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the data connection.␊ - */␊ - name: string␊ - type: "Microsoft.Kusto/clusters/databases/dataConnections"␊ - [k: string]: unknown␊ - } & (EventHubDataConnection2 | IotHubDataConnection1 | EventGridDataConnection2))␊ - /**␊ - * Microsoft.Kusto/clusters/databases␊ - */␊ - export type ClustersDatabasesChildResource4 = ({␊ - apiVersion: "2019-11-09"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the database in the Kusto cluster.␊ - */␊ - name: string␊ - type: "databases"␊ - [k: string]: unknown␊ - } & (ReadWriteDatabase1 | ReadOnlyFollowingDatabase1))␊ - /**␊ - * Microsoft.Kusto/clusters/dataConnections␊ - */␊ - export type ClustersDataConnectionsChildResource = ({␊ - /**␊ - * The data connection name␊ - */␊ - name?: string␊ - type: "Microsoft.Kusto/clusters/dataconnections"␊ - apiVersion: "2019-11-09"␊ - [k: string]: unknown␊ - } & (GenevaDataConnection | GenevaLegacyDataConnection))␊ - /**␊ - * Microsoft.Kusto/clusters/databases␊ - */␊ - export type ClustersDatabases5 = ({␊ - apiVersion: "2019-11-09"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the database in the Kusto cluster.␊ - */␊ - name: string␊ - resources?: (ClustersDatabasesPrincipalAssignmentsChildResource | ClustersDatabasesDataConnectionsChildResource3)[]␊ - type: "Microsoft.Kusto/clusters/databases"␊ - [k: string]: unknown␊ - } & (ReadWriteDatabase1 | ReadOnlyFollowingDatabase1))␊ - /**␊ - * Microsoft.Kusto/clusters/databases/dataConnections␊ - */␊ - export type ClustersDatabasesDataConnectionsChildResource3 = ({␊ - apiVersion: "2019-11-09"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the data connection.␊ - */␊ - name: string␊ - type: "dataConnections"␊ - [k: string]: unknown␊ - } & (EventHubDataConnection3 | IotHubDataConnection2 | EventGridDataConnection3))␊ - /**␊ - * Microsoft.Kusto/clusters/databases/dataConnections␊ - */␊ - export type ClustersDatabasesDataConnections3 = ({␊ - apiVersion: "2019-11-09"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the data connection.␊ - */␊ - name: string␊ - type: "Microsoft.Kusto/clusters/databases/dataConnections"␊ - [k: string]: unknown␊ - } & (EventHubDataConnection3 | IotHubDataConnection2 | EventGridDataConnection3))␊ - /**␊ - * Microsoft.Kusto/clusters/dataConnections␊ - */␊ - export type ClustersDataConnections = ({␊ - /**␊ - * The data connection name␊ - */␊ - name?: string␊ - type: "Microsoft.Kusto/clusters/dataconnections"␊ - apiVersion: "2019-11-09"␊ - [k: string]: unknown␊ - } & (GenevaDataConnection | GenevaLegacyDataConnection))␊ - /**␊ - * Microsoft.Kusto/clusters/databases␊ - */␊ - export type ClustersDatabasesChildResource5 = ({␊ - apiVersion: "2020-02-15"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the database in the Kusto cluster.␊ - */␊ - name: string␊ - type: "databases"␊ - [k: string]: unknown␊ - } & (ReadWriteDatabase2 | ReadOnlyFollowingDatabase2))␊ - /**␊ - * Microsoft.Kusto/clusters/dataConnections␊ - */␊ - export type ClustersDataConnectionsChildResource1 = ({␊ - /**␊ - * The data connection name␊ - */␊ - name?: string␊ - type: "Microsoft.Kusto/clusters/dataconnections"␊ - apiVersion: "2020-02-15"␊ - [k: string]: unknown␊ - } & (GenevaDataConnection1 | GenevaLegacyDataConnection1))␊ - /**␊ - * Microsoft.Kusto/clusters/databases␊ - */␊ - export type ClustersDatabases6 = ({␊ - apiVersion: "2020-02-15"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the database in the Kusto cluster.␊ - */␊ - name: string␊ - resources?: (ClustersDatabasesPrincipalAssignmentsChildResource1 | ClustersDatabasesDataConnectionsChildResource4)[]␊ - type: "Microsoft.Kusto/clusters/databases"␊ - [k: string]: unknown␊ - } & (ReadWriteDatabase2 | ReadOnlyFollowingDatabase2))␊ - /**␊ - * Microsoft.Kusto/clusters/databases/dataConnections␊ - */␊ - export type ClustersDatabasesDataConnectionsChildResource4 = ({␊ - apiVersion: "2020-02-15"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the data connection.␊ - */␊ - name: string␊ - type: "dataConnections"␊ - [k: string]: unknown␊ - } & (EventHubDataConnection4 | IotHubDataConnection3 | EventGridDataConnection4))␊ - /**␊ - * Microsoft.Kusto/clusters/databases/dataConnections␊ - */␊ - export type ClustersDatabasesDataConnections4 = ({␊ - apiVersion: "2020-02-15"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the data connection.␊ - */␊ - name: string␊ - type: "Microsoft.Kusto/clusters/databases/dataConnections"␊ - [k: string]: unknown␊ - } & (EventHubDataConnection4 | IotHubDataConnection3 | EventGridDataConnection4))␊ - /**␊ - * Microsoft.Kusto/clusters/dataConnections␊ - */␊ - export type ClustersDataConnections1 = ({␊ - /**␊ - * The data connection name␊ - */␊ - name?: string␊ - type: "Microsoft.Kusto/clusters/dataconnections"␊ - apiVersion: "2020-02-15"␊ - [k: string]: unknown␊ - } & (GenevaDataConnection1 | GenevaLegacyDataConnection1))␊ - /**␊ - * Microsoft.Kusto/clusters/databases␊ - */␊ - export type ClustersDatabasesChildResource6 = ({␊ - apiVersion: "2020-06-14"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the database in the Kusto cluster.␊ - */␊ - name: string␊ - type: "databases"␊ - [k: string]: unknown␊ - } & (ReadWriteDatabase3 | ReadOnlyFollowingDatabase3))␊ - /**␊ - * Microsoft.Kusto/clusters/dataConnections␊ - */␊ - export type ClustersDataConnectionsChildResource2 = ({␊ - /**␊ - * The data connection name␊ - */␊ - name?: string␊ - type: "Microsoft.Kusto/clusters/dataconnections"␊ - apiVersion: "2020-06-14"␊ - [k: string]: unknown␊ - } & (GenevaDataConnection2 | GenevaLegacyDataConnection2))␊ - /**␊ - * Microsoft.Kusto/clusters/databases␊ - */␊ - export type ClustersDatabases7 = ({␊ - apiVersion: "2020-06-14"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the database in the Kusto cluster.␊ - */␊ - name: string␊ - resources?: (ClustersDatabasesPrincipalAssignmentsChildResource2 | ClustersDatabasesDataConnectionsChildResource5)[]␊ - type: "Microsoft.Kusto/clusters/databases"␊ - [k: string]: unknown␊ - } & (ReadWriteDatabase3 | ReadOnlyFollowingDatabase3))␊ - /**␊ - * Microsoft.Kusto/clusters/databases/dataConnections␊ - */␊ - export type ClustersDatabasesDataConnectionsChildResource5 = ({␊ - apiVersion: "2020-06-14"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the data connection.␊ - */␊ - name: string␊ - type: "dataConnections"␊ - [k: string]: unknown␊ - } & (EventHubDataConnection5 | IotHubDataConnection4 | EventGridDataConnection5))␊ - /**␊ - * Microsoft.Kusto/clusters/databases/dataConnections␊ - */␊ - export type ClustersDatabasesDataConnections5 = ({␊ - apiVersion: "2020-06-14"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the data connection.␊ - */␊ - name: string␊ - type: "Microsoft.Kusto/clusters/databases/dataConnections"␊ - [k: string]: unknown␊ - } & (EventHubDataConnection5 | IotHubDataConnection4 | EventGridDataConnection5))␊ - /**␊ - * Microsoft.Kusto/clusters/dataConnections␊ - */␊ - export type ClustersDataConnections2 = ({␊ - /**␊ - * The data connection name␊ - */␊ - name?: string␊ - type: "Microsoft.Kusto/clusters/dataconnections"␊ - apiVersion: "2020-06-14"␊ - [k: string]: unknown␊ - } & (GenevaDataConnection2 | GenevaLegacyDataConnection2))␊ - /**␊ - * Microsoft.Kusto/clusters/databases␊ - */␊ - export type ClustersDatabasesChildResource7 = ({␊ - apiVersion: "2020-09-18"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the database in the Kusto cluster.␊ - */␊ - name: string␊ - type: "databases"␊ - [k: string]: unknown␊ - } & (ReadWriteDatabase4 | ReadOnlyFollowingDatabase4))␊ - /**␊ - * Microsoft.Kusto/clusters/dataConnections␊ - */␊ - export type ClustersDataConnectionsChildResource3 = ({␊ - /**␊ - * The data connection name␊ - */␊ - name?: string␊ - type: "Microsoft.Kusto/clusters/dataconnections"␊ - apiVersion: "2020-09-18"␊ - [k: string]: unknown␊ - } & (GenevaDataConnection3 | GenevaLegacyDataConnection3))␊ - /**␊ - * Microsoft.Kusto/clusters/databases␊ - */␊ - export type ClustersDatabases8 = ({␊ - apiVersion: "2020-09-18"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the database in the Kusto cluster.␊ - */␊ - name: string␊ - resources?: (ClustersDatabasesPrincipalAssignmentsChildResource3 | ClustersDatabasesDataConnectionsChildResource6)[]␊ - type: "Microsoft.Kusto/clusters/databases"␊ - [k: string]: unknown␊ - } & (ReadWriteDatabase4 | ReadOnlyFollowingDatabase4))␊ - /**␊ - * Microsoft.Kusto/clusters/databases/dataConnections␊ - */␊ - export type ClustersDatabasesDataConnectionsChildResource6 = ({␊ - apiVersion: "2020-09-18"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the data connection.␊ - */␊ - name: string␊ - type: "dataConnections"␊ - [k: string]: unknown␊ - } & (EventHubDataConnection6 | IotHubDataConnection5 | EventGridDataConnection6))␊ - /**␊ - * Microsoft.Kusto/clusters/databases/dataConnections␊ - */␊ - export type ClustersDatabasesDataConnections6 = ({␊ - apiVersion: "2020-09-18"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the data connection.␊ - */␊ - name: string␊ - type: "Microsoft.Kusto/clusters/databases/dataConnections"␊ - [k: string]: unknown␊ - } & (EventHubDataConnection6 | IotHubDataConnection5 | EventGridDataConnection6))␊ - /**␊ - * Microsoft.Kusto/clusters/dataConnections␊ - */␊ - export type ClustersDataConnections3 = ({␊ - /**␊ - * The data connection name␊ - */␊ - name?: string␊ - type: "Microsoft.Kusto/clusters/dataconnections"␊ - apiVersion: "2020-09-18"␊ - [k: string]: unknown␊ - } & (GenevaDataConnection3 | GenevaLegacyDataConnection3))␊ - export type HttpAuthentication1 = ({␊ - [k: string]: unknown␊ - } & (ClientCertAuthentication | BasicAuthentication | OAuthAuthentication))␊ - /**␊ - * The set of properties specific to the Azure ML web service resource.␊ - */␊ - export type WebServiceProperties = ({␊ - /**␊ - * Contains user defined properties describing web service assets. Properties are expressed as Key/Value pairs.␊ - */␊ - assets?: ({␊ - [k: string]: AssetItem␊ - } | string)␊ - /**␊ - * Information about the machine learning commitment plan associated with the web service.␊ - */␊ - commitmentPlan?: (CommitmentPlanModel | string)␊ - /**␊ - * The description of the web service.␊ - */␊ - description?: string␊ - /**␊ - * Diagnostics settings for an Azure ML web service.␊ - */␊ - diagnostics?: (DiagnosticsConfiguration | string)␊ - /**␊ - * Sample input data for the service's input(s).␊ - */␊ - exampleRequest?: (ExampleRequest | string)␊ - /**␊ - * When set to true, sample data is included in the web service's swagger definition. The default value is true.␊ - */␊ - exposeSampleData?: (boolean | string)␊ - /**␊ - * The swagger 2.0 schema describing the service's inputs or outputs. See Swagger specification: http://swagger.io/specification/␊ - */␊ - input?: (ServiceInputOutputSpecification | string)␊ - /**␊ - * Access keys for the web service calls.␊ - */␊ - keys?: (WebServiceKeys | string)␊ - /**␊ - * Information about the machine learning workspace containing the experiment that is source for the web service.␊ - */␊ - machineLearningWorkspace?: (MachineLearningWorkspace | string)␊ - /**␊ - * The swagger 2.0 schema describing the service's inputs or outputs. See Swagger specification: http://swagger.io/specification/␊ - */␊ - output?: (ServiceInputOutputSpecification | string)␊ - /**␊ - * The set of global parameters values defined for the web service, given as a global parameter name to default value map. If no default value is specified, the parameter is considered to be required.␊ - */␊ - parameters?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * When set to true, indicates that the web service is read-only and can no longer be updated or patched, only removed. Default, is false. Note: Once set to true, you cannot change its value.␊ - */␊ - readOnly?: (boolean | string)␊ - /**␊ - * Holds the available configuration options for an Azure ML web service endpoint.␊ - */␊ - realtimeConfiguration?: (RealtimeConfiguration | string)␊ - /**␊ - * Access information for a storage account.␊ - */␊ - storageAccount?: (StorageAccount | string)␊ - /**␊ - * The title of the web service.␊ - */␊ - title?: string␊ - [k: string]: unknown␊ - } & WebServicePropertiesForGraph)␊ - /**␊ - * Machine Learning compute object.␊ - */␊ - export type Compute = ({␊ - /**␊ - * Location for the underlying compute␊ - */␊ - computeLocation?: string␊ - /**␊ - * The description of the Machine Learning compute.␊ - */␊ - description?: string␊ - /**␊ - * ARM resource id of the underlying compute␊ - */␊ - resourceId?: string␊ - [k: string]: unknown␊ - } & (AKS | AmlCompute | VirtualMachine | HDInsight | DataFactory | Databricks | DataLakeAnalytics))␊ - /**␊ - * Machine Learning compute object.␊ - */␊ - export type Compute1 = ({␊ - /**␊ - * Location for the underlying compute␊ - */␊ - computeLocation?: string␊ - /**␊ - * The description of the Machine Learning compute.␊ - */␊ - description?: string␊ - /**␊ - * ARM resource id of the compute␊ - */␊ - resourceId?: string␊ - [k: string]: unknown␊ - } & (AKS1 | BatchAI | VirtualMachine1 | HDInsight1 | DataFactory1))␊ - /**␊ - * Microsoft.Automation/automationAccounts/runbooks/draft␊ - */␊ - export type AutomationAccountsRunbooksDraftChildResource = ({␊ - apiVersion: "2015-10-31"␊ - type: "draft"␊ - [k: string]: unknown␊ - } & ({␊ - name: "content"␊ - [k: string]: unknown␊ - } | {␊ - name: "testJob"␊ - /**␊ - * Gets or sets the parameters of the test job.␊ - */␊ - parameters?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Gets or sets the runOn which specifies the group name where the job is to be executed.␊ - */␊ - runOn?: string␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * Microsoft.Automation/automationAccounts/runbooks/draft␊ - */␊ - export type AutomationAccountsRunbooksDraftChildResource1 = ({␊ - apiVersion: "2018-06-30"␊ - type: "draft"␊ - [k: string]: unknown␊ - } & ({␊ - name: "content"␊ - [k: string]: unknown␊ - } | {␊ - name: "testJob"␊ - /**␊ - * Gets or sets the parameters of the test job.␊ - */␊ - parameters?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Gets or sets the runOn which specifies the group name where the job is to be executed.␊ - */␊ - runOn?: string␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * Base class for Content Key Policy configuration. A derived class must be used to create a configuration.␊ - */␊ - export type ContentKeyPolicyConfiguration = ({␊ - [k: string]: unknown␊ - } & (ContentKeyPolicyClearKeyConfiguration | ContentKeyPolicyUnknownConfiguration | ContentKeyPolicyWidevineConfiguration | ContentKeyPolicyPlayReadyConfiguration | ContentKeyPolicyFairPlayConfiguration))␊ - /**␊ - * Base class for content key ID location. A derived class must be used to represent the location.␊ - */␊ - export type ContentKeyPolicyPlayReadyContentKeyLocation = ({␊ - [k: string]: unknown␊ - } & (ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader | ContentKeyPolicyPlayReadyContentEncryptionKeyFromKeyIdentifier))␊ - /**␊ - * Base class for Content Key Policy restrictions. A derived class must be used to create a restriction.␊ - */␊ - export type ContentKeyPolicyRestriction = ({␊ - [k: string]: unknown␊ - } & (ContentKeyPolicyOpenRestriction | ContentKeyPolicyUnknownRestriction | ContentKeyPolicyTokenRestriction))␊ - /**␊ - * Base class for Content Key Policy key for token validation. A derived class must be used to create a token key.␊ - */␊ - export type ContentKeyPolicyRestrictionTokenKey = ({␊ - [k: string]: unknown␊ - } & (ContentKeyPolicySymmetricTokenKey | ContentKeyPolicyRsaTokenKey | ContentKeyPolicyX509CertificateTokenKey))␊ - /**␊ - * Base type for all Presets, which define the recipe or instructions on how the input media files should be processed.␊ - */␊ - export type Preset = ({␊ - [k: string]: unknown␊ - } & (FaceDetectorPreset | AudioAnalyzerPreset | BuiltInStandardEncoderPreset | StandardEncoderPreset))␊ - /**␊ - * The Audio Analyzer preset applies a pre-defined set of AI-based analysis operations, including speech transcription. Currently, the preset supports processing of content with a single audio track.␊ - */␊ - export type AudioAnalyzerPreset = ({␊ - "@odata.type": "#Microsoft.Media.AudioAnalyzerPreset"␊ - /**␊ - * The language for the audio payload in the input using the BCP-47 format of 'language tag-region' (e.g: 'en-US'). The list of supported languages are English ('en-US' and 'en-GB'), Spanish ('es-ES' and 'es-MX'), French ('fr-FR'), Italian ('it-IT'), Japanese ('ja-JP'), Portuguese ('pt-BR'), Chinese ('zh-CN'), German ('de-DE'), Arabic ('ar-EG' and 'ar-SY'), Russian ('ru-RU'), Hindi ('hi-IN'), and Korean ('ko-KR'). If you know the language of your content, it is recommended that you specify it. If the language isn't specified or set to null, automatic language detection will choose the first language detected and process with the selected language for the duration of the file. This language detection feature currently supports English, Chinese, French, German, Italian, Japanese, Spanish, Russian, and Portuguese. It does not currently support dynamically switching between languages after the first language is detected. The automatic detection works best with audio recordings with clearly discernable speech. If automatic detection fails to find the language, transcription would fallback to 'en-US'."␊ - */␊ - audioLanguage?: string␊ - [k: string]: unknown␊ - } & VideoAnalyzerPreset)␊ - /**␊ - * Describes the basic properties of all codecs.␊ - */␊ - export type Codec = ({␊ - /**␊ - * An optional label for the codec. The label can be used to control muxing behavior.␊ - */␊ - label?: string␊ - [k: string]: unknown␊ - } & (Audio | CopyVideo | Video | CopyAudio))␊ - /**␊ - * Defines the common properties for all audio codecs.␊ - */␊ - export type Audio = ({␊ - "@odata.type": "#Microsoft.Media.Audio"␊ - /**␊ - * The bitrate, in bits per second, of the output encoded audio.␊ - */␊ - bitrate?: (number | string)␊ - /**␊ - * The number of channels in the audio.␊ - */␊ - channels?: (number | string)␊ - /**␊ - * The sampling rate to use for encoding in hertz.␊ - */␊ - samplingRate?: (number | string)␊ - [k: string]: unknown␊ - } & AacAudio)␊ - /**␊ - * Describes the basic properties for encoding the input video.␊ - */␊ - export type Video = ({␊ - "@odata.type": "#Microsoft.Media.Video"␊ - /**␊ - * The distance between two key frames, thereby defining a group of pictures (GOP). The value should be a non-zero integer in the range [1, 30] seconds, specified in ISO 8601 format. The default is 2 seconds (PT2S).␊ - */␊ - keyFrameInterval?: string␊ - /**␊ - * The resizing mode - how the input video will be resized to fit the desired output resolution(s). Default is AutoSize.␊ - */␊ - stretchMode?: (("None" | "AutoSize" | "AutoFit") | string)␊ - [k: string]: unknown␊ - } & (Image | H264Video))␊ - /**␊ - * Describes the basic properties for generating thumbnails from the input video␊ - */␊ - export type Image = ({␊ - "@odata.type": "#Microsoft.Media.Image"␊ - /**␊ - * The position in the input video at which to stop generating thumbnails. The value can be in absolute timestamp (ISO 8601, e.g: PT5M30S to stop at 5 minutes and 30 seconds), or a frame count (For example, 300 to stop at the 300th frame), or a relative value (For example, 100%).␊ - */␊ - range?: string␊ - /**␊ - * The position in the input video from where to start generating thumbnails. The value can be in absolute timestamp (ISO 8601, e.g: PT05S), or a frame count (For example, 10 for the 10th frame), or a relative value (For example, 1%). Also supports a macro {Best}, which tells the encoder to select the best thumbnail from the first few seconds of the video.␊ - */␊ - start: string␊ - /**␊ - * The intervals at which thumbnails are generated. The value can be in absolute timestamp (ISO 8601, e.g: PT05S for one image every 5 seconds), or a frame count (For example, 30 for every 30 frames), or a relative value (For example, 1%).␊ - */␊ - step?: string␊ - [k: string]: unknown␊ - } & (JpgImage | PngImage))␊ - /**␊ - * Base type for all overlays - image, audio or video.␊ - */␊ - export type Overlay = ({␊ - /**␊ - * The gain level of audio in the overlay. The value should be in the range [0, 1.0]. The default is 1.0.␊ - */␊ - audioGainLevel?: (number | string)␊ - /**␊ - * The position in the input video at which the overlay ends. The value should be in ISO 8601 duration format. For example, PT30S to end the overlay at 30 seconds in to the input video. If not specified the overlay will be applied until the end of the input video if inputLoop is true. Else, if inputLoop is false, then overlay will last as long as the duration of the overlay media.␊ - */␊ - end?: string␊ - /**␊ - * The duration over which the overlay fades in onto the input video. The value should be in ISO 8601 duration format. If not specified the default behavior is to have no fade in (same as PT0S).␊ - */␊ - fadeInDuration?: string␊ - /**␊ - * The duration over which the overlay fades out of the input video. The value should be in ISO 8601 duration format. If not specified the default behavior is to have no fade out (same as PT0S).␊ - */␊ - fadeOutDuration?: string␊ - /**␊ - * The label of the job input which is to be used as an overlay. The Input must specify exactly one file. You can specify an image file in JPG or PNG formats, or an audio file (such as a WAV, MP3, WMA or M4A file), or a video file. See https://aka.ms/mesformats for the complete list of supported audio and video file formats.␊ - */␊ - inputLabel: string␊ - /**␊ - * The start position, with reference to the input video, at which the overlay starts. The value should be in ISO 8601 format. For example, PT05S to start the overlay at 5 seconds in to the input video. If not specified the overlay starts from the beginning of the input video.␊ - */␊ - start?: string␊ - [k: string]: unknown␊ - } & (AudioOverlay | VideoOverlay))␊ - /**␊ - * Base class for output.␊ - */␊ - export type Format = ({␊ - /**␊ - * The pattern of the file names for the generated output files. The following macros are supported in the file name: {Basename} - The base name of the input video {Extension} - The appropriate extension for this format. {Label} - The label assigned to the codec/layer. {Index} - A unique index for thumbnails. Only applicable to thumbnails. {Bitrate} - The audio/video bitrate. Not applicable to thumbnails. {Codec} - The type of the audio/video codec. Any unsubstituted macros will be collapsed and removed from the filename.␊ - */␊ - filenamePattern: string␊ - [k: string]: unknown␊ - } & (ImageFormat | MultiBitrateFormat))␊ - /**␊ - * Describes the properties for an output image file.␊ - */␊ - export type ImageFormat = ({␊ - "@odata.type": "#Microsoft.Media.ImageFormat"␊ - [k: string]: unknown␊ - } & (JpgFormat | PngFormat))␊ - /**␊ - * Describes the properties for producing a collection of GOP aligned multi-bitrate files. The default behavior is to produce one output file for each video layer which is muxed together with all the audios. The exact output files produced can be controlled by specifying the outputFiles collection.␊ - */␊ - export type MultiBitrateFormat = ({␊ - "@odata.type": "#Microsoft.Media.MultiBitrateFormat"␊ - /**␊ - * The list of output files to produce. Each entry in the list is a set of audio and video layer labels to be muxed together .␊ - */␊ - outputFiles?: (OutputFile[] | string)␊ - [k: string]: unknown␊ - } & (Mp4Format | TransportStreamFormat))␊ - /**␊ - * Base class for inputs to a Job.␊ - */␊ - export type JobInput = ({␊ - [k: string]: unknown␊ - } & (JobInputClip | JobInputs))␊ - /**␊ - * Represents input files for a Job.␊ - */␊ - export type JobInputClip = ({␊ - "@odata.type": "#Microsoft.Media.JobInputClip"␊ - /**␊ - * Base class for specifying a clip time. Use sub classes of this class to specify the time position in the media.␊ - */␊ - end?: (ClipTime | string)␊ - /**␊ - * List of files. Required for JobInputHttp. Maximum of 4000 characters each.␊ - */␊ - files?: (string[] | string)␊ - /**␊ - * A label that is assigned to a JobInputClip, that is used to satisfy a reference used in the Transform. For example, a Transform can be authored so as to take an image file with the label 'xyz' and apply it as an overlay onto the input video before it is encoded. When submitting a Job, exactly one of the JobInputs should be the image file, and it should have the label 'xyz'.␊ - */␊ - label?: string␊ - /**␊ - * Base class for specifying a clip time. Use sub classes of this class to specify the time position in the media.␊ - */␊ - start?: (AbsoluteClipTime | string)␊ - [k: string]: unknown␊ - } & (JobInputAsset | JobInputHttp))␊ - /**␊ - * Base class for specifying a clip time. Use sub classes of this class to specify the time position in the media.␊ - */␊ - export type ClipTime = ({␊ - [k: string]: unknown␊ - } & AbsoluteClipTime)␊ - /**␊ - * Describes all the properties of a JobOutput.␊ - */␊ - export type JobOutput = ({␊ - /**␊ - * A label that is assigned to a JobOutput in order to help uniquely identify it. This is useful when your Transform has more than one TransformOutput, whereby your Job has more than one JobOutput. In such cases, when you submit the Job, you will add two or more JobOutputs, in the same order as TransformOutputs in the Transform. Subsequently, when you retrieve the Job, either through events or on a GET request, you can use the label to easily identify the JobOutput. If a label is not provided, a default value of '{presetName}_{outputIndex}' will be used, where the preset name is the name of the preset in the corresponding TransformOutput and the output index is the relative index of the this JobOutput within the Job. Note that this index is the same as the relative index of the corresponding TransformOutput within its Transform.␊ - */␊ - label?: string␊ - [k: string]: unknown␊ - } & JobOutputAsset)␊ - /**␊ - * The service resource properties.␊ - */␊ - export type ServiceResourceProperties = ({␊ - /**␊ - * A list that describes the correlation of the service with other services.␊ - */␊ - correlationScheme?: (ServiceCorrelationDescription[] | string)␊ - /**␊ - * Specifies the move cost for the service.␊ - */␊ - defaultMoveCost?: (("Zero" | "Low" | "Medium" | "High") | string)␊ - /**␊ - * Describes how the service is partitioned.␊ - */␊ - partitionDescription?: (PartitionSchemeDescription | string)␊ - /**␊ - * The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: "NodeColor == blue)".␊ - */␊ - placementConstraints?: string␊ - /**␊ - * The service load metrics is given as an array of ServiceLoadMetricDescription objects.␊ - */␊ - serviceLoadMetrics?: (ServiceLoadMetricDescription[] | string)␊ - /**␊ - * A list that describes the correlation of the service with other services.␊ - */␊ - servicePlacementPolicies?: (ServicePlacementPolicyDescription[] | string)␊ - /**␊ - * The name of the service type␊ - */␊ - serviceTypeName?: string␊ - [k: string]: unknown␊ - } & (StatefulServiceProperties | StatelessServiceProperties))␊ - /**␊ - * Describes how the service is partitioned.␊ - */␊ - export type PartitionSchemeDescription = ({␊ - [k: string]: unknown␊ - } & SingletonPartitionSchemeDescription)␊ - /**␊ - * The service resource properties.␊ - */␊ - export type ServiceResourceProperties1 = ({␊ - /**␊ - * A list that describes the correlation of the service with other services.␊ - */␊ - correlationScheme?: (ServiceCorrelationDescription1[] | string)␊ - /**␊ - * Specifies the move cost for the service.␊ - */␊ - defaultMoveCost?: (("Zero" | "Low" | "Medium" | "High") | string)␊ - /**␊ - * Describes how the service is partitioned.␊ - */␊ - partitionDescription?: (PartitionSchemeDescription1 | string)␊ - /**␊ - * The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: "NodeColor == blue)".␊ - */␊ - placementConstraints?: string␊ - /**␊ - * The service load metrics is given as an array of ServiceLoadMetricDescription objects.␊ - */␊ - serviceLoadMetrics?: (ServiceLoadMetricDescription1[] | string)␊ - /**␊ - * The activation Mode of the service package.␊ - */␊ - servicePackageActivationMode?: (("SharedProcess" | "ExclusiveProcess") | string)␊ - /**␊ - * A list that describes the correlation of the service with other services.␊ - */␊ - servicePlacementPolicies?: (ServicePlacementPolicyDescription1[] | string)␊ - /**␊ - * The name of the service type␊ - */␊ - serviceTypeName?: string␊ - [k: string]: unknown␊ - } & (StatefulServiceProperties1 | StatelessServiceProperties1))␊ - /**␊ - * Describes how the service is partitioned.␊ - */␊ - export type PartitionSchemeDescription1 = ({␊ - [k: string]: unknown␊ - } & SingletonPartitionSchemeDescription1)␊ - /**␊ - * Microsoft.ApiManagement/service/portalsettings␊ - */␊ - export type ServicePortalsettingsChildResource = ({␊ - apiVersion: "2017-03-01"␊ - type: "portalsettings"␊ - [k: string]: unknown␊ - } & ({␊ - name: "signin"␊ - /**␊ - * Sign-in settings contract properties.␊ - */␊ - properties: (PortalSigninSettingProperties | string)␊ - [k: string]: unknown␊ - } | {␊ - name: "signup"␊ - /**␊ - * Sign-up settings contract properties.␊ - */␊ - properties: (PortalSignupSettingsProperties | string)␊ - [k: string]: unknown␊ - } | {␊ - name: "delegation"␊ - /**␊ - * Delegation settings contract properties.␊ - */␊ - properties: (PortalDelegationSettingsProperties | string)␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * Microsoft.ApiManagement/service/portalsettings␊ - */␊ - export type ServicePortalsettingsChildResource1 = ({␊ - apiVersion: "2018-01-01"␊ - type: "portalsettings"␊ - [k: string]: unknown␊ - } & ({␊ - name: "signin"␊ - /**␊ - * Sign-in settings contract properties.␊ - */␊ - properties: (PortalSigninSettingProperties1 | string)␊ - [k: string]: unknown␊ - } | {␊ - name: "signup"␊ - /**␊ - * Sign-up settings contract properties.␊ - */␊ - properties: (PortalSignupSettingsProperties1 | string)␊ - [k: string]: unknown␊ - } | {␊ - name: "delegation"␊ - /**␊ - * Delegation settings contract properties.␊ - */␊ - properties: (PortalDelegationSettingsProperties1 | string)␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * Microsoft.ApiManagement/service/portalsettings␊ - */␊ - export type ServicePortalsettingsChildResource2 = ({␊ - apiVersion: "2018-06-01-preview"␊ - type: "portalsettings"␊ - [k: string]: unknown␊ - } & ({␊ - name: "signin"␊ - /**␊ - * Sign-in settings contract properties.␊ - */␊ - properties: (PortalSigninSettingProperties2 | string)␊ - [k: string]: unknown␊ - } | {␊ - name: "signup"␊ - /**␊ - * Sign-up settings contract properties.␊ - */␊ - properties: (PortalSignupSettingsProperties2 | string)␊ - [k: string]: unknown␊ - } | {␊ - name: "delegation"␊ - /**␊ - * Delegation settings contract properties.␊ - */␊ - properties: (PortalDelegationSettingsProperties2 | string)␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * Microsoft.ApiManagement/service/portalsettings␊ - */␊ - export type ServicePortalsettingsChildResource3 = ({␊ - apiVersion: "2019-01-01"␊ - type: "portalsettings"␊ - [k: string]: unknown␊ - } & ({␊ - name: "signin"␊ - /**␊ - * Sign-in settings contract properties.␊ - */␊ - properties: (PortalSigninSettingProperties3 | string)␊ - [k: string]: unknown␊ - } | {␊ - name: "signup"␊ - /**␊ - * Sign-up settings contract properties.␊ - */␊ - properties: (PortalSignupSettingsProperties3 | string)␊ - [k: string]: unknown␊ - } | {␊ - name: "delegation"␊ - /**␊ - * Delegation settings contract properties.␊ - */␊ - properties: (PortalDelegationSettingsProperties3 | string)␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * Base properties for any build step.␊ - */␊ - export type BuildStepProperties = ({␊ - [k: string]: unknown␊ - } & DockerBuildStep)␊ - /**␊ - * Base properties for any task step.␊ - */␊ - export type TaskStepProperties = ({␊ - /**␊ - * The token (git PAT or SAS token of storage account blob) associated with the context for a step.␊ - */␊ - contextAccessToken?: string␊ - /**␊ - * The URL(absolute or relative) of the source context for the task step.␊ - */␊ - contextPath?: string␊ - [k: string]: unknown␊ - } & (DockerBuildStep1 | FileTaskStep | EncodedTaskStep))␊ - /**␊ - * The set of properties specific to the Azure ML web service resource.␊ - */␊ - export type WebServiceProperties1 = ({␊ - /**␊ - * Contains user defined properties describing web service assets. Properties are expressed as Key/Value pairs.␊ - */␊ - assets?: ({␊ - [k: string]: AssetItem1␊ - } | string)␊ - /**␊ - * Information about the machine learning commitment plan associated with the web service.␊ - */␊ - commitmentPlan?: (CommitmentPlan | string)␊ - /**␊ - * The description of the web service.␊ - */␊ - description?: string␊ - /**␊ - * Diagnostics settings for an Azure ML web service.␊ - */␊ - diagnostics?: (DiagnosticsConfiguration1 | string)␊ - /**␊ - * Sample input data for the service's input(s).␊ - */␊ - exampleRequest?: (ExampleRequest1 | string)␊ - /**␊ - * When set to true, sample data is included in the web service's swagger definition. The default value is true.␊ - */␊ - exposeSampleData?: (boolean | string)␊ - /**␊ - * The swagger 2.0 schema describing the service's inputs or outputs. See Swagger specification: http://swagger.io/specification/␊ - */␊ - input?: (ServiceInputOutputSpecification1 | string)␊ - /**␊ - * Access keys for the web service calls.␊ - */␊ - keys?: (WebServiceKeys1 | string)␊ - /**␊ - * Information about the machine learning workspace containing the experiment that is source for the web service.␊ - */␊ - machineLearningWorkspace?: (MachineLearningWorkspace1 | string)␊ - /**␊ - * The swagger 2.0 schema describing the service's inputs or outputs. See Swagger specification: http://swagger.io/specification/␊ - */␊ - output?: (ServiceInputOutputSpecification1 | string)␊ - /**␊ - * The set of global parameters values defined for the web service, given as a global parameter name to default value map. If no default value is specified, the parameter is considered to be required.␊ - */␊ - parameters?: ({␊ - [k: string]: WebServiceParameter␊ - } | string)␊ - /**␊ - * When set to true, indicates that the payload size is larger than 3 MB. Otherwise false. If the payload size exceed 3 MB, the payload is stored in a blob and the PayloadsLocation parameter contains the URI of the blob. Otherwise, this will be set to false and Assets, Input, Output, Package, Parameters, ExampleRequest are inline. The Payload sizes is determined by adding the size of the Assets, Input, Output, Package, Parameters, and the ExampleRequest.␊ - */␊ - payloadsInBlobStorage?: (boolean | string)␊ - /**␊ - * Describes the access location for a blob.␊ - */␊ - payloadsLocation?: (BlobLocation | string)␊ - /**␊ - * When set to true, indicates that the web service is read-only and can no longer be updated or patched, only removed. Default, is false. Note: Once set to true, you cannot change its value.␊ - */␊ - readOnly?: (boolean | string)␊ - /**␊ - * Holds the available configuration options for an Azure ML web service endpoint.␊ - */␊ - realtimeConfiguration?: (RealtimeConfiguration1 | string)␊ - /**␊ - * Access information for a storage account.␊ - */␊ - storageAccount?: (StorageAccount3 | string)␊ - /**␊ - * The title of the web service.␊ - */␊ - title?: string␊ - [k: string]: unknown␊ - } & WebServicePropertiesForGraph1)␊ - /**␊ - * The properties that are associated with a function.␊ - */␊ - export type FunctionProperties = ({␊ - [k: string]: unknown␊ - } & ScalarFunctionProperties)␊ - /**␊ - * The physical binding of the function. For example, in the Azure Machine Learning web service’s case, this describes the endpoint.␊ - */␊ - export type FunctionBinding = ({␊ - [k: string]: unknown␊ - } & (AzureMachineLearningWebServiceFunctionBinding | JavaScriptFunctionBinding))␊ - /**␊ - * The properties that are associated with an input.␊ - */␊ - export type InputProperties = ({␊ - /**␊ - * Describes how data from an input is serialized or how data is serialized when written to an output.␊ - */␊ - serialization?: (Serialization | string)␊ - [k: string]: unknown␊ - } & (StreamInputProperties | ReferenceInputProperties))␊ - /**␊ - * Describes how data from an input is serialized or how data is serialized when written to an output.␊ - */␊ - export type Serialization = ({␊ - [k: string]: unknown␊ - } & (CsvSerialization | JsonSerialization | AvroSerialization))␊ - /**␊ - * Describes an input data source that contains stream data.␊ - */␊ - export type StreamInputDataSource = ({␊ - [k: string]: unknown␊ - } & (BlobStreamInputDataSource | EventHubStreamInputDataSource | IoTHubStreamInputDataSource))␊ - /**␊ - * Describes an input data source that contains reference data.␊ - */␊ - export type ReferenceInputDataSource = ({␊ - [k: string]: unknown␊ - } & BlobReferenceInputDataSource)␊ - /**␊ - * Describes the data source that output will be written to.␊ - */␊ - export type OutputDataSource = ({␊ - [k: string]: unknown␊ - } & (BlobOutputDataSource | AzureTableOutputDataSource | EventHubOutputDataSource | AzureSqlDatabaseOutputDataSource | DocumentDbOutputDataSource | ServiceBusQueueOutputDataSource | ServiceBusTopicOutputDataSource | PowerBIOutputDataSource | AzureDataLakeStoreOutputDataSource))␊ - /**␊ - * Microsoft.TimeSeriesInsights/environments/eventSources␊ - */␊ - export type EnvironmentsEventSourcesChildResource = ({␊ - apiVersion: "2017-11-15"␊ - /**␊ - * The location of the resource.␊ - */␊ - location: string␊ - /**␊ - * Name of the event source.␊ - */␊ - name: string␊ - /**␊ - * Key-value pairs of additional properties for the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "eventSources"␊ - [k: string]: unknown␊ - } & (EventHubEventSourceCreateOrUpdateParameters | IoTHubEventSourceCreateOrUpdateParameters))␊ - /**␊ - * Microsoft.TimeSeriesInsights/environments/eventSources␊ - */␊ - export type EnvironmentsEventSources = ({␊ - apiVersion: "2017-11-15"␊ - /**␊ - * The location of the resource.␊ - */␊ - location: string␊ - /**␊ - * Name of the event source.␊ - */␊ - name: string␊ - /**␊ - * Key-value pairs of additional properties for the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.TimeSeriesInsights/environments/eventSources"␊ - [k: string]: unknown␊ - } & (EventHubEventSourceCreateOrUpdateParameters | IoTHubEventSourceCreateOrUpdateParameters))␊ - /**␊ - * Microsoft.TimeSeriesInsights/environments␊ - */␊ - export type Environments1 = ({␊ - apiVersion: "2018-08-15-preview"␊ - /**␊ - * The location of the resource.␊ - */␊ - location: string␊ - /**␊ - * Name of the environment␊ - */␊ - name: string␊ - resources?: (EnvironmentsEventSourcesChildResource1 | EnvironmentsReferenceDataSetsChildResource1 | EnvironmentsAccessPoliciesChildResource1)[]␊ - /**␊ - * The sku determines the type of environment, either standard (S1 or S2) or long-term (L1). For standard environments the sku determines the capacity of the environment, the ingress rate, and the billing rate.␊ - */␊ - sku: (Sku45 | string)␊ - /**␊ - * Key-value pairs of additional properties for the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.TimeSeriesInsights/environments"␊ - [k: string]: unknown␊ - } & (StandardEnvironmentCreateOrUpdateParameters | LongTermEnvironmentCreateOrUpdateParameters))␊ - /**␊ - * Microsoft.TimeSeriesInsights/environments/eventSources␊ - */␊ - export type EnvironmentsEventSourcesChildResource1 = ({␊ - apiVersion: "2018-08-15-preview"␊ - /**␊ - * An object that represents the local timestamp property. It contains the format of local timestamp that needs to be used and the corresponding timezone offset information. If a value isn't specified for localTimestamp, or if null, then the local timestamp will not be ingressed with the events.␊ - */␊ - localTimestamp?: (LocalTimestamp | string)␊ - /**␊ - * The location of the resource.␊ - */␊ - location: string␊ - /**␊ - * Name of the event source.␊ - */␊ - name: string␊ - /**␊ - * Key-value pairs of additional properties for the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "eventSources"␊ - [k: string]: unknown␊ - } & (EventHubEventSourceCreateOrUpdateParameters1 | IoTHubEventSourceCreateOrUpdateParameters1))␊ - /**␊ - * Microsoft.TimeSeriesInsights/environments/eventSources␊ - */␊ - export type EnvironmentsEventSources1 = ({␊ - apiVersion: "2018-08-15-preview"␊ - /**␊ - * An object that represents the local timestamp property. It contains the format of local timestamp that needs to be used and the corresponding timezone offset information. If a value isn't specified for localTimestamp, or if null, then the local timestamp will not be ingressed with the events.␊ - */␊ - localTimestamp?: (LocalTimestamp | string)␊ - /**␊ - * The location of the resource.␊ - */␊ - location: string␊ - /**␊ - * Name of the event source.␊ - */␊ - name: string␊ - /**␊ - * Key-value pairs of additional properties for the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.TimeSeriesInsights/environments/eventSources"␊ - [k: string]: unknown␊ - } & (EventHubEventSourceCreateOrUpdateParameters1 | IoTHubEventSourceCreateOrUpdateParameters1))␊ - /**␊ - * Machine Learning compute object.␊ - */␊ - export type Compute2 = ({␊ - /**␊ - * Location for the underlying compute␊ - */␊ - computeLocation?: string␊ - /**␊ - * The description of the Machine Learning compute.␊ - */␊ - description?: string␊ - /**␊ - * ARM resource id of the underlying compute␊ - */␊ - resourceId?: string␊ - [k: string]: unknown␊ - } & (AKS2 | AmlCompute1 | VirtualMachine2 | HDInsight2 | DataFactory2 | Databricks1 | DataLakeAnalytics1))␊ - /**␊ - * Machine Learning compute object.␊ - */␊ - export type Compute3 = ({␊ - /**␊ - * Location for the underlying compute␊ - */␊ - computeLocation?: string␊ - /**␊ - * The description of the Machine Learning compute.␊ - */␊ - description?: string␊ - /**␊ - * ARM resource id of the underlying compute␊ - */␊ - resourceId?: string␊ - [k: string]: unknown␊ - } & (AKS3 | AmlCompute2 | VirtualMachine3 | HDInsight3 | DataFactory3 | Databricks2 | DataLakeAnalytics2))␊ - /**␊ - * Machine Learning compute object.␊ - */␊ - export type Compute4 = ({␊ - /**␊ - * Location for the underlying compute␊ - */␊ - computeLocation?: string␊ - /**␊ - * The description of the Machine Learning compute.␊ - */␊ - description?: string␊ - /**␊ - * ARM resource id of the underlying compute␊ - */␊ - resourceId?: string␊ - [k: string]: unknown␊ - } & (AKS4 | AmlCompute3 | VirtualMachine4 | HDInsight4 | DataFactory4 | Databricks3 | DataLakeAnalytics3))␊ - /**␊ - * Machine Learning compute object.␊ - */␊ - export type Compute5 = ({␊ - /**␊ - * Location for the underlying compute␊ - */␊ - computeLocation?: string␊ - /**␊ - * The description of the Machine Learning compute.␊ - */␊ - description?: string␊ - /**␊ - * ARM resource id of the underlying compute␊ - */␊ - resourceId?: string␊ - [k: string]: unknown␊ - } & (AKS5 | AmlCompute4 | VirtualMachine5 | HDInsight5 | DataFactory5 | Databricks4 | DataLakeAnalytics4))␊ - /**␊ - * The properties used to create a new server.␊ - */␊ - export type ServerPropertiesForCreate = ({␊ - /**␊ - * Enforce a minimal Tls version for the server.␊ - */␊ - minimalTlsVersion?: (("TLS1_0" | "TLS1_1" | "TLS1_2" | "TLSEnforcementDisabled") | string)␊ - /**␊ - * Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'.␊ - */␊ - publicNetworkAccess?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Enable ssl enforcement or not when connect to server.␊ - */␊ - sslEnforcement?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Storage Profile properties of a server␊ - */␊ - storageProfile?: (StorageProfile4 | string)␊ - /**␊ - * Server version.␊ - */␊ - version?: (("10.2" | "10.3") | string)␊ - [k: string]: unknown␊ - } & (ServerPropertiesForDefaultCreate | ServerPropertiesForRestore | ServerPropertiesForGeoRestore | ServerPropertiesForReplica))␊ - /**␊ - * The properties used to create a new server.␊ - */␊ - export type ServerPropertiesForCreate1 = ({␊ - /**␊ - * Status showing whether the server enabled infrastructure encryption.␊ - */␊ - infrastructureEncryption?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Enforce a minimal Tls version for the server.␊ - */␊ - minimalTlsVersion?: (("TLS1_0" | "TLS1_1" | "TLS1_2" | "TLSEnforcementDisabled") | string)␊ - /**␊ - * Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'.␊ - */␊ - publicNetworkAccess?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Enable ssl enforcement or not when connect to server.␊ - */␊ - sslEnforcement?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Storage Profile properties of a server␊ - */␊ - storageProfile?: (StorageProfile5 | string)␊ - /**␊ - * Server version.␊ - */␊ - version?: (("5.6" | "5.7" | "8.0") | string)␊ - [k: string]: unknown␊ - } & (ServerPropertiesForDefaultCreate1 | ServerPropertiesForRestore1 | ServerPropertiesForGeoRestore1 | ServerPropertiesForReplica1))␊ - /**␊ - * The properties used to create a new server.␊ - */␊ - export type ServerPropertiesForCreate2 = ({␊ - /**␊ - * Status showing whether the server enabled infrastructure encryption.␊ - */␊ - infrastructureEncryption?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Enforce a minimal Tls version for the server.␊ - */␊ - minimalTlsVersion?: (("TLS1_0" | "TLS1_1" | "TLS1_2" | "TLSEnforcementDisabled") | string)␊ - /**␊ - * Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'.␊ - */␊ - publicNetworkAccess?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Enable ssl enforcement or not when connect to server.␊ - */␊ - sslEnforcement?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Storage Profile properties of a server␊ - */␊ - storageProfile?: (StorageProfile6 | string)␊ - /**␊ - * Server version.␊ - */␊ - version?: (("9.5" | "9.6" | "10" | "10.0" | "10.2" | "11") | string)␊ - [k: string]: unknown␊ - } & (ServerPropertiesForDefaultCreate2 | ServerPropertiesForRestore2 | ServerPropertiesForGeoRestore2 | ServerPropertiesForReplica2))␊ - /**␊ - * The properties used to create a new server.␊ - */␊ - export type ServerPropertiesForCreate3 = ({␊ - /**␊ - * Enforce a minimal Tls version for the server.␊ - */␊ - minimalTlsVersion?: (("TLS1_0" | "TLS1_1" | "TLS1_2" | "TLSEnforcementDisabled") | string)␊ - /**␊ - * Enable ssl enforcement or not when connect to server.␊ - */␊ - sslEnforcement?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Storage Profile properties of a server␊ - */␊ - storageProfile?: (StorageProfile7 | string)␊ - /**␊ - * Server version.␊ - */␊ - version?: (("5.6" | "5.7" | "8.0") | string)␊ - [k: string]: unknown␊ - } & (ServerPropertiesForDefaultCreate3 | ServerPropertiesForRestore3 | ServerPropertiesForGeoRestore3 | ServerPropertiesForReplica3))␊ - /**␊ - * The properties used to create a new server.␊ - */␊ - export type ServerPropertiesForCreate4 = ({␊ - /**␊ - * Enforce a minimal Tls version for the server.␊ - */␊ - minimalTlsVersion?: (("TLS1_0" | "TLS1_1" | "TLS1_2" | "TLSEnforcementDisabled") | string)␊ - /**␊ - * Enable ssl enforcement or not when connect to server.␊ - */␊ - sslEnforcement?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Storage Profile properties of a server␊ - */␊ - storageProfile?: (StorageProfile8 | string)␊ - /**␊ - * Server version.␊ - */␊ - version?: (("9.5" | "9.6" | "10" | "10.0" | "10.2" | "11") | string)␊ - [k: string]: unknown␊ - } & (ServerPropertiesForDefaultCreate4 | ServerPropertiesForRestore4 | ServerPropertiesForGeoRestore4 | ServerPropertiesForReplica4))␊ - /**␊ - * Properties of the rule.␊ - */␊ - export type FirewallPolicyRule = ({␊ - /**␊ - * Name of the Rule␊ - */␊ - name?: string␊ - /**␊ - * Priority of the Firewall Policy Rule resource.␊ - */␊ - priority?: (number | string)␊ - ruleType: string␊ - [k: string]: unknown␊ - } & ({␊ - ruleType?: ("FirewallPolicyRule" | string)␊ - [k: string]: unknown␊ - } | FirewallPolicyNatRule | FirewallPolicyFilterRule))␊ - /**␊ - * Firewall Policy NAT Rule␊ - */␊ - export type FirewallPolicyNatRule = ({␊ - /**␊ - * The action type of a Nat rule, SNAT or DNAT␊ - */␊ - action?: (FirewallPolicyNatRuleAction | string)␊ - /**␊ - * The translated address for this NAT rule.␊ - */␊ - translatedAddress?: string␊ - /**␊ - * The translated port for this NAT rule.␊ - */␊ - translatedPort?: string␊ - /**␊ - * The match conditions for incoming traffic␊ - */␊ - ruleCondition?: (FirewallPolicyRuleCondition | string)␊ - ruleType: string␊ - [k: string]: unknown␊ - } & {␊ - ruleType?: ("FirewallPolicyNatRule" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Properties of a rule.␊ - */␊ - export type FirewallPolicyRuleCondition = ({␊ - /**␊ - * Name of the rule condition.␊ - */␊ - name?: string␊ - /**␊ - * Description of the rule condition.␊ - */␊ - description?: string␊ - ruleConditionType: string␊ - [k: string]: unknown␊ - } & ({␊ - ruleConditionType?: ("FirewallPolicyRuleCondition" | string)␊ - [k: string]: unknown␊ - } | ApplicationRuleCondition | NetworkRuleCondition))␊ - /**␊ - * Rule condition of type application.␊ - */␊ - export type ApplicationRuleCondition = ({␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * List of destination IP addresses or Service Tags.␊ - */␊ - destinationAddresses?: (string[] | string)␊ - /**␊ - * Array of Application Protocols.␊ - */␊ - protocols?: (FirewallPolicyRuleConditionApplicationProtocol[] | string)␊ - /**␊ - * List of FQDNs for this rule condition.␊ - */␊ - targetFqdns?: (string[] | string)␊ - /**␊ - * List of FQDN Tags for this rule condition.␊ - */␊ - fqdnTags?: (string[] | string)␊ - ruleConditionType: string␊ - [k: string]: unknown␊ - } & {␊ - ruleConditionType?: ("ApplicationRuleCondition" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Rule condition of type network␊ - */␊ - export type NetworkRuleCondition = ({␊ - /**␊ - * Array of FirewallPolicyRuleConditionNetworkProtocols.␊ - */␊ - ipProtocols?: (("TCP" | "UDP" | "Any" | "ICMP")[] | string)␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * List of destination IP addresses or Service Tags.␊ - */␊ - destinationAddresses?: (string[] | string)␊ - /**␊ - * List of destination ports.␊ - */␊ - destinationPorts?: (string[] | string)␊ - ruleConditionType: string␊ - [k: string]: unknown␊ - } & {␊ - ruleConditionType?: ("NetworkRuleCondition" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Firewall Policy Filter Rule␊ - */␊ - export type FirewallPolicyFilterRule = ({␊ - /**␊ - * The action type of a Filter rule␊ - */␊ - action?: (FirewallPolicyFilterRuleAction | string)␊ - /**␊ - * Collection of rule conditions used by a rule.␊ - */␊ - ruleConditions?: (({␊ - ruleConditionType?: ("FirewallPolicyRuleCondition" | string)␊ - [k: string]: unknown␊ - } | ApplicationRuleCondition | NetworkRuleCondition)[] | string)␊ - ruleType: string␊ - [k: string]: unknown␊ - } & {␊ - ruleType?: ("FirewallPolicyFilterRule" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Properties of the rule.␊ - */␊ - export type FirewallPolicyRule1 = ({␊ - /**␊ - * The name of the rule.␊ - */␊ - name?: string␊ - /**␊ - * Priority of the Firewall Policy Rule resource.␊ - */␊ - priority?: (number | string)␊ - ruleType: string␊ - [k: string]: unknown␊ - } & ({␊ - ruleType?: ("FirewallPolicyRule" | string)␊ - [k: string]: unknown␊ - } | FirewallPolicyNatRule1 | FirewallPolicyFilterRule1))␊ - /**␊ - * Firewall Policy NAT Rule.␊ - */␊ - export type FirewallPolicyNatRule1 = ({␊ - /**␊ - * The action type of a Nat rule.␊ - */␊ - action?: (FirewallPolicyNatRuleAction1 | string)␊ - /**␊ - * The translated address for this NAT rule.␊ - */␊ - translatedAddress?: string␊ - /**␊ - * The translated port for this NAT rule.␊ - */␊ - translatedPort?: string␊ - /**␊ - * The match conditions for incoming traffic.␊ - */␊ - ruleCondition?: (FirewallPolicyRuleCondition1 | string)␊ - ruleType: string␊ - [k: string]: unknown␊ - } & {␊ - ruleType?: ("FirewallPolicyNatRule" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Properties of a rule.␊ - */␊ - export type FirewallPolicyRuleCondition1 = ({␊ - /**␊ - * Name of the rule condition.␊ - */␊ - name?: string␊ - /**␊ - * Description of the rule condition.␊ - */␊ - description?: string␊ - ruleConditionType: string␊ - [k: string]: unknown␊ - } & ({␊ - ruleConditionType?: ("FirewallPolicyRuleCondition" | string)␊ - [k: string]: unknown␊ - } | ApplicationRuleCondition1 | NetworkRuleCondition1))␊ - /**␊ - * Rule condition of type application.␊ - */␊ - export type ApplicationRuleCondition1 = ({␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * List of destination IP addresses or Service Tags.␊ - */␊ - destinationAddresses?: (string[] | string)␊ - /**␊ - * Array of Application Protocols.␊ - */␊ - protocols?: (FirewallPolicyRuleConditionApplicationProtocol1[] | string)␊ - /**␊ - * List of FQDNs for this rule condition.␊ - */␊ - targetFqdns?: (string[] | string)␊ - /**␊ - * List of FQDN Tags for this rule condition.␊ - */␊ - fqdnTags?: (string[] | string)␊ - ruleConditionType: string␊ - [k: string]: unknown␊ - } & {␊ - ruleConditionType?: ("ApplicationRuleCondition" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Rule condition of type network.␊ - */␊ - export type NetworkRuleCondition1 = ({␊ - /**␊ - * Array of FirewallPolicyRuleConditionNetworkProtocols.␊ - */␊ - ipProtocols?: (("TCP" | "UDP" | "Any" | "ICMP")[] | string)␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * List of destination IP addresses or Service Tags.␊ - */␊ - destinationAddresses?: (string[] | string)␊ - /**␊ - * List of destination ports.␊ - */␊ - destinationPorts?: (string[] | string)␊ - ruleConditionType: string␊ - [k: string]: unknown␊ - } & {␊ - ruleConditionType?: ("NetworkRuleCondition" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Firewall Policy Filter Rule.␊ - */␊ - export type FirewallPolicyFilterRule1 = ({␊ - /**␊ - * The action type of a Filter rule.␊ - */␊ - action?: (FirewallPolicyFilterRuleAction1 | string)␊ - /**␊ - * Collection of rule conditions used by a rule.␊ - */␊ - ruleConditions?: (({␊ - ruleConditionType?: ("FirewallPolicyRuleCondition" | string)␊ - [k: string]: unknown␊ - } | ApplicationRuleCondition1 | NetworkRuleCondition1)[] | string)␊ - ruleType: string␊ - [k: string]: unknown␊ - } & {␊ - ruleType?: ("FirewallPolicyFilterRule" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Properties of the rule.␊ - */␊ - export type FirewallPolicyRule2 = ({␊ - /**␊ - * The name of the rule.␊ - */␊ - name?: string␊ - /**␊ - * Priority of the Firewall Policy Rule resource.␊ - */␊ - priority?: (number | string)␊ - ruleType: string␊ - [k: string]: unknown␊ - } & ({␊ - ruleType?: ("FirewallPolicyRule" | string)␊ - [k: string]: unknown␊ - } | FirewallPolicyNatRule2 | FirewallPolicyFilterRule2))␊ - /**␊ - * Firewall Policy NAT Rule.␊ - */␊ - export type FirewallPolicyNatRule2 = ({␊ - /**␊ - * The action type of a Nat rule.␊ - */␊ - action?: (FirewallPolicyNatRuleAction2 | string)␊ - /**␊ - * The translated address for this NAT rule.␊ - */␊ - translatedAddress?: string␊ - /**␊ - * The translated port for this NAT rule.␊ - */␊ - translatedPort?: string␊ - /**␊ - * The match conditions for incoming traffic.␊ - */␊ - ruleCondition?: (FirewallPolicyRuleCondition2 | string)␊ - ruleType: string␊ - [k: string]: unknown␊ - } & {␊ - ruleType?: ("FirewallPolicyNatRule" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Properties of a rule.␊ - */␊ - export type FirewallPolicyRuleCondition2 = ({␊ - /**␊ - * Name of the rule condition.␊ - */␊ - name?: string␊ - /**␊ - * Description of the rule condition.␊ - */␊ - description?: string␊ - ruleConditionType: string␊ - [k: string]: unknown␊ - } & ({␊ - ruleConditionType?: ("FirewallPolicyRuleCondition" | string)␊ - [k: string]: unknown␊ - } | ApplicationRuleCondition2 | NetworkRuleCondition2))␊ - /**␊ - * Rule condition of type application.␊ - */␊ - export type ApplicationRuleCondition2 = ({␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * List of destination IP addresses or Service Tags.␊ - */␊ - destinationAddresses?: (string[] | string)␊ - /**␊ - * Array of Application Protocols.␊ - */␊ - protocols?: (FirewallPolicyRuleConditionApplicationProtocol2[] | string)␊ - /**␊ - * List of FQDNs for this rule condition.␊ - */␊ - targetFqdns?: (string[] | string)␊ - /**␊ - * List of FQDN Tags for this rule condition.␊ - */␊ - fqdnTags?: (string[] | string)␊ - ruleConditionType: string␊ - [k: string]: unknown␊ - } & {␊ - ruleConditionType?: ("ApplicationRuleCondition" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Rule condition of type network.␊ - */␊ - export type NetworkRuleCondition2 = ({␊ - /**␊ - * Array of FirewallPolicyRuleConditionNetworkProtocols.␊ - */␊ - ipProtocols?: (("TCP" | "UDP" | "Any" | "ICMP")[] | string)␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * List of destination IP addresses or Service Tags.␊ - */␊ - destinationAddresses?: (string[] | string)␊ - /**␊ - * List of destination ports.␊ - */␊ - destinationPorts?: (string[] | string)␊ - ruleConditionType: string␊ - [k: string]: unknown␊ - } & {␊ - ruleConditionType?: ("NetworkRuleCondition" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Firewall Policy Filter Rule.␊ - */␊ - export type FirewallPolicyFilterRule2 = ({␊ - /**␊ - * The action type of a Filter rule.␊ - */␊ - action?: (FirewallPolicyFilterRuleAction2 | string)␊ - /**␊ - * Collection of rule conditions used by a rule.␊ - */␊ - ruleConditions?: (({␊ - ruleConditionType?: ("FirewallPolicyRuleCondition" | string)␊ - [k: string]: unknown␊ - } | ApplicationRuleCondition2 | NetworkRuleCondition2)[] | string)␊ - ruleType: string␊ - [k: string]: unknown␊ - } & {␊ - ruleType?: ("FirewallPolicyFilterRule" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Properties of the rule.␊ - */␊ - export type FirewallPolicyRule3 = ({␊ - /**␊ - * The name of the rule.␊ - */␊ - name?: string␊ - /**␊ - * Priority of the Firewall Policy Rule resource.␊ - */␊ - priority?: (number | string)␊ - ruleType: string␊ - [k: string]: unknown␊ - } & ({␊ - ruleType?: ("FirewallPolicyRule" | string)␊ - [k: string]: unknown␊ - } | FirewallPolicyNatRule3 | FirewallPolicyFilterRule3))␊ - /**␊ - * Firewall Policy NAT Rule.␊ - */␊ - export type FirewallPolicyNatRule3 = ({␊ - /**␊ - * The action type of a Nat rule.␊ - */␊ - action?: (FirewallPolicyNatRuleAction3 | string)␊ - /**␊ - * The translated address for this NAT rule.␊ - */␊ - translatedAddress?: string␊ - /**␊ - * The translated port for this NAT rule.␊ - */␊ - translatedPort?: string␊ - /**␊ - * The match conditions for incoming traffic.␊ - */␊ - ruleCondition?: (FirewallPolicyRuleCondition3 | string)␊ - ruleType: string␊ - [k: string]: unknown␊ - } & {␊ - ruleType?: ("FirewallPolicyNatRule" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Properties of a rule.␊ - */␊ - export type FirewallPolicyRuleCondition3 = ({␊ - /**␊ - * Name of the rule condition.␊ - */␊ - name?: string␊ - /**␊ - * Description of the rule condition.␊ - */␊ - description?: string␊ - ruleConditionType: string␊ - [k: string]: unknown␊ - } & ({␊ - ruleConditionType?: ("FirewallPolicyRuleCondition" | string)␊ - [k: string]: unknown␊ - } | ApplicationRuleCondition3 | NetworkRuleCondition3))␊ - /**␊ - * Rule condition of type application.␊ - */␊ - export type ApplicationRuleCondition3 = ({␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * List of destination IP addresses or Service Tags.␊ - */␊ - destinationAddresses?: (string[] | string)␊ - /**␊ - * Array of Application Protocols.␊ - */␊ - protocols?: (FirewallPolicyRuleConditionApplicationProtocol3[] | string)␊ - /**␊ - * List of FQDNs for this rule condition.␊ - */␊ - targetFqdns?: (string[] | string)␊ - /**␊ - * List of FQDN Tags for this rule condition.␊ - */␊ - fqdnTags?: (string[] | string)␊ - ruleConditionType: string␊ - [k: string]: unknown␊ - } & {␊ - ruleConditionType?: ("ApplicationRuleCondition" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Rule condition of type network.␊ - */␊ - export type NetworkRuleCondition3 = ({␊ - /**␊ - * Array of FirewallPolicyRuleConditionNetworkProtocols.␊ - */␊ - ipProtocols?: (("TCP" | "UDP" | "Any" | "ICMP")[] | string)␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * List of destination IP addresses or Service Tags.␊ - */␊ - destinationAddresses?: (string[] | string)␊ - /**␊ - * List of destination ports.␊ - */␊ - destinationPorts?: (string[] | string)␊ - ruleConditionType: string␊ - [k: string]: unknown␊ - } & {␊ - ruleConditionType?: ("NetworkRuleCondition" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Firewall Policy Filter Rule.␊ - */␊ - export type FirewallPolicyFilterRule3 = ({␊ - /**␊ - * The action type of a Filter rule.␊ - */␊ - action?: (FirewallPolicyFilterRuleAction3 | string)␊ - /**␊ - * Collection of rule conditions used by a rule.␊ - */␊ - ruleConditions?: (({␊ - ruleConditionType?: ("FirewallPolicyRuleCondition" | string)␊ - [k: string]: unknown␊ - } | ApplicationRuleCondition3 | NetworkRuleCondition3)[] | string)␊ - ruleType: string␊ - [k: string]: unknown␊ - } & {␊ - ruleType?: ("FirewallPolicyFilterRule" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Properties of the rule.␊ - */␊ - export type FirewallPolicyRule4 = ({␊ - /**␊ - * The name of the rule.␊ - */␊ - name?: string␊ - /**␊ - * Priority of the Firewall Policy Rule resource.␊ - */␊ - priority?: (number | string)␊ - ruleType: string␊ - [k: string]: unknown␊ - } & ({␊ - ruleType?: ("FirewallPolicyRule" | string)␊ - [k: string]: unknown␊ - } | FirewallPolicyNatRule4 | FirewallPolicyFilterRule4))␊ - /**␊ - * Firewall Policy NAT Rule.␊ - */␊ - export type FirewallPolicyNatRule4 = ({␊ - /**␊ - * The action type of a Nat rule.␊ - */␊ - action?: (FirewallPolicyNatRuleAction4 | string)␊ - /**␊ - * The translated address for this NAT rule.␊ - */␊ - translatedAddress?: string␊ - /**␊ - * The translated port for this NAT rule.␊ - */␊ - translatedPort?: string␊ - /**␊ - * The match conditions for incoming traffic.␊ - */␊ - ruleCondition?: (FirewallPolicyRuleCondition4 | string)␊ - ruleType: string␊ - [k: string]: unknown␊ - } & {␊ - ruleType?: ("FirewallPolicyNatRule" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Properties of a rule.␊ - */␊ - export type FirewallPolicyRuleCondition4 = ({␊ - /**␊ - * Name of the rule condition.␊ - */␊ - name?: string␊ - /**␊ - * Description of the rule condition.␊ - */␊ - description?: string␊ - ruleConditionType: string␊ - [k: string]: unknown␊ - } & ({␊ - ruleConditionType?: ("FirewallPolicyRuleCondition" | string)␊ - [k: string]: unknown␊ - } | ApplicationRuleCondition4 | NetworkRuleCondition4))␊ - /**␊ - * Rule condition of type application.␊ - */␊ - export type ApplicationRuleCondition4 = ({␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * List of destination IP addresses or Service Tags.␊ - */␊ - destinationAddresses?: (string[] | string)␊ - /**␊ - * Array of Application Protocols.␊ - */␊ - protocols?: (FirewallPolicyRuleConditionApplicationProtocol4[] | string)␊ - /**␊ - * List of FQDNs for this rule condition.␊ - */␊ - targetFqdns?: (string[] | string)␊ - /**␊ - * List of FQDN Tags for this rule condition.␊ - */␊ - fqdnTags?: (string[] | string)␊ - ruleConditionType: string␊ - [k: string]: unknown␊ - } & {␊ - ruleConditionType?: ("ApplicationRuleCondition" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Rule condition of type network.␊ - */␊ - export type NetworkRuleCondition4 = ({␊ - /**␊ - * Array of FirewallPolicyRuleConditionNetworkProtocols.␊ - */␊ - ipProtocols?: (("TCP" | "UDP" | "Any" | "ICMP")[] | string)␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * List of destination IP addresses or Service Tags.␊ - */␊ - destinationAddresses?: (string[] | string)␊ - /**␊ - * List of destination ports.␊ - */␊ - destinationPorts?: (string[] | string)␊ - ruleConditionType: string␊ - [k: string]: unknown␊ - } & {␊ - ruleConditionType?: ("NetworkRuleCondition" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Firewall Policy Filter Rule.␊ - */␊ - export type FirewallPolicyFilterRule4 = ({␊ - /**␊ - * The action type of a Filter rule.␊ - */␊ - action?: (FirewallPolicyFilterRuleAction4 | string)␊ - /**␊ - * Collection of rule conditions used by a rule.␊ - */␊ - ruleConditions?: (({␊ - ruleConditionType?: ("FirewallPolicyRuleCondition" | string)␊ - [k: string]: unknown␊ - } | ApplicationRuleCondition4 | NetworkRuleCondition4)[] | string)␊ - ruleType: string␊ - [k: string]: unknown␊ - } & {␊ - ruleType?: ("FirewallPolicyFilterRule" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Properties of the rule.␊ - */␊ - export type FirewallPolicyRule5 = ({␊ - /**␊ - * The name of the rule.␊ - */␊ - name?: string␊ - /**␊ - * Priority of the Firewall Policy Rule resource.␊ - */␊ - priority?: (number | string)␊ - [k: string]: unknown␊ - } & (FirewallPolicyNatRule5 | FirewallPolicyFilterRule5))␊ - /**␊ - * Properties of a rule.␊ - */␊ - export type FirewallPolicyRuleCondition5 = ({␊ - /**␊ - * Description of the rule condition.␊ - */␊ - description?: string␊ - /**␊ - * Name of the rule condition.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - } & (ApplicationRuleCondition5 | NatRuleCondition | NetworkRuleCondition5))␊ - /**␊ - * Properties of the rule.␊ - */␊ - export type FirewallPolicyRule6 = ({␊ - /**␊ - * The name of the rule.␊ - */␊ - name?: string␊ - /**␊ - * Priority of the Firewall Policy Rule resource.␊ - */␊ - priority?: (number | string)␊ - ruleType: string␊ - [k: string]: unknown␊ - } & ({␊ - ruleType?: ("FirewallPolicyRule" | string)␊ - [k: string]: unknown␊ - } | FirewallPolicyNatRule6 | FirewallPolicyFilterRule6))␊ - /**␊ - * Firewall Policy NAT Rule.␊ - */␊ - export type FirewallPolicyNatRule6 = ({␊ - /**␊ - * The action type of a Nat rule.␊ - */␊ - action?: (FirewallPolicyNatRuleAction6 | string)␊ - /**␊ - * The translated address for this NAT rule.␊ - */␊ - translatedAddress?: string␊ - /**␊ - * The translated port for this NAT rule.␊ - */␊ - translatedPort?: string␊ - /**␊ - * The match conditions for incoming traffic.␊ - */␊ - ruleCondition?: (FirewallPolicyRuleCondition6 | string)␊ - ruleType: string␊ - [k: string]: unknown␊ - } & {␊ - ruleType?: ("FirewallPolicyNatRule" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Properties of a rule.␊ - */␊ - export type FirewallPolicyRuleCondition6 = ({␊ - /**␊ - * Name of the rule condition.␊ - */␊ - name?: string␊ - /**␊ - * Description of the rule condition.␊ - */␊ - description?: string␊ - ruleConditionType: string␊ - [k: string]: unknown␊ - } & ({␊ - ruleConditionType?: ("FirewallPolicyRuleCondition" | string)␊ - [k: string]: unknown␊ - } | ApplicationRuleCondition6 | NatRuleCondition1 | NetworkRuleCondition6))␊ - /**␊ - * Rule condition of type application.␊ - */␊ - export type ApplicationRuleCondition6 = ({␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * List of destination IP addresses or Service Tags.␊ - */␊ - destinationAddresses?: (string[] | string)␊ - /**␊ - * Array of Application Protocols.␊ - */␊ - protocols?: (FirewallPolicyRuleConditionApplicationProtocol6[] | string)␊ - /**␊ - * List of FQDNs for this rule condition.␊ - */␊ - targetFqdns?: (string[] | string)␊ - /**␊ - * List of FQDN Tags for this rule condition.␊ - */␊ - fqdnTags?: (string[] | string)␊ - /**␊ - * List of source IpGroups for this rule.␊ - */␊ - sourceIpGroups?: (string[] | string)␊ - ruleConditionType: string␊ - [k: string]: unknown␊ - } & {␊ - ruleConditionType?: ("ApplicationRuleCondition" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Rule condition of type nat.␊ - */␊ - export type NatRuleCondition1 = ({␊ - /**␊ - * Array of FirewallPolicyRuleConditionNetworkProtocols.␊ - */␊ - ipProtocols?: (("TCP" | "UDP" | "Any" | "ICMP")[] | string)␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * List of destination IP addresses or Service Tags.␊ - */␊ - destinationAddresses?: (string[] | string)␊ - /**␊ - * List of destination ports.␊ - */␊ - destinationPorts?: (string[] | string)␊ - /**␊ - * List of source IpGroups for this rule.␊ - */␊ - sourceIpGroups?: (string[] | string)␊ - ruleConditionType: string␊ - [k: string]: unknown␊ - } & {␊ - ruleConditionType?: ("NatRuleCondition" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Rule condition of type network.␊ - */␊ - export type NetworkRuleCondition6 = ({␊ - /**␊ - * Array of FirewallPolicyRuleConditionNetworkProtocols.␊ - */␊ - ipProtocols?: (("TCP" | "UDP" | "Any" | "ICMP")[] | string)␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * List of destination IP addresses or Service Tags.␊ - */␊ - destinationAddresses?: (string[] | string)␊ - /**␊ - * List of destination ports.␊ - */␊ - destinationPorts?: (string[] | string)␊ - /**␊ - * List of source IpGroups for this rule.␊ - */␊ - sourceIpGroups?: (string[] | string)␊ - /**␊ - * List of destination IpGroups for this rule.␊ - */␊ - destinationIpGroups?: (string[] | string)␊ - ruleConditionType: string␊ - [k: string]: unknown␊ - } & {␊ - ruleConditionType?: ("NetworkRuleCondition" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Firewall Policy Filter Rule.␊ - */␊ - export type FirewallPolicyFilterRule6 = ({␊ - /**␊ - * The action type of a Filter rule.␊ - */␊ - action?: (FirewallPolicyFilterRuleAction6 | string)␊ - /**␊ - * Collection of rule conditions used by a rule.␊ - */␊ - ruleConditions?: (({␊ - ruleConditionType?: ("FirewallPolicyRuleCondition" | string)␊ - [k: string]: unknown␊ - } | ApplicationRuleCondition6 | NatRuleCondition1 | NetworkRuleCondition6)[] | string)␊ - ruleType: string␊ - [k: string]: unknown␊ - } & {␊ - ruleType?: ("FirewallPolicyFilterRule" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Properties of the rule.␊ - */␊ - export type FirewallPolicyRule7 = ({␊ - /**␊ - * The name of the rule.␊ - */␊ - name?: string␊ - /**␊ - * Priority of the Firewall Policy Rule resource.␊ - */␊ - priority?: (number | string)␊ - ruleType: string␊ - [k: string]: unknown␊ - } & ({␊ - ruleType?: ("FirewallPolicyRule" | string)␊ - [k: string]: unknown␊ - } | FirewallPolicyNatRule7 | FirewallPolicyFilterRule7))␊ - /**␊ - * Firewall Policy NAT Rule.␊ - */␊ - export type FirewallPolicyNatRule7 = ({␊ - /**␊ - * The action type of a Nat rule.␊ - */␊ - action?: (FirewallPolicyNatRuleAction7 | string)␊ - /**␊ - * The translated address for this NAT rule.␊ - */␊ - translatedAddress?: string␊ - /**␊ - * The translated port for this NAT rule.␊ - */␊ - translatedPort?: string␊ - /**␊ - * The match conditions for incoming traffic.␊ - */␊ - ruleCondition?: (FirewallPolicyRuleCondition7 | string)␊ - ruleType: string␊ - [k: string]: unknown␊ - } & {␊ - ruleType?: ("FirewallPolicyNatRule" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Properties of a rule.␊ - */␊ - export type FirewallPolicyRuleCondition7 = ({␊ - /**␊ - * Name of the rule condition.␊ - */␊ - name?: string␊ - /**␊ - * Description of the rule condition.␊ - */␊ - description?: string␊ - ruleConditionType: string␊ - [k: string]: unknown␊ - } & ({␊ - ruleConditionType?: ("FirewallPolicyRuleCondition" | string)␊ - [k: string]: unknown␊ - } | ApplicationRuleCondition7 | NatRuleCondition2 | NetworkRuleCondition7))␊ - /**␊ - * Rule condition of type application.␊ - */␊ - export type ApplicationRuleCondition7 = ({␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * List of destination IP addresses or Service Tags.␊ - */␊ - destinationAddresses?: (string[] | string)␊ - /**␊ - * Array of Application Protocols.␊ - */␊ - protocols?: (FirewallPolicyRuleConditionApplicationProtocol7[] | string)␊ - /**␊ - * List of Urls for this rule condition.␊ - */␊ - targetUrls?: (string[] | string)␊ - /**␊ - * List of FQDNs for this rule condition.␊ - */␊ - targetFqdns?: (string[] | string)␊ - /**␊ - * List of FQDN Tags for this rule condition.␊ - */␊ - fqdnTags?: (string[] | string)␊ - /**␊ - * List of source IpGroups for this rule.␊ - */␊ - sourceIpGroups?: (string[] | string)␊ - ruleConditionType: string␊ - [k: string]: unknown␊ - } & {␊ - ruleConditionType?: ("ApplicationRuleCondition" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Rule condition of type nat.␊ - */␊ - export type NatRuleCondition2 = ({␊ - /**␊ - * Array of FirewallPolicyRuleConditionNetworkProtocols.␊ - */␊ - ipProtocols?: (("TCP" | "UDP" | "Any" | "ICMP")[] | string)␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * List of destination IP addresses or Service Tags.␊ - */␊ - destinationAddresses?: (string[] | string)␊ - /**␊ - * List of destination ports.␊ - */␊ - destinationPorts?: (string[] | string)␊ - /**␊ - * List of source IpGroups for this rule.␊ - */␊ - sourceIpGroups?: (string[] | string)␊ - /**␊ - * Terminate TLS connections for this rule.␊ - */␊ - terminateTLS?: (boolean | string)␊ - ruleConditionType: string␊ - [k: string]: unknown␊ - } & {␊ - ruleConditionType?: ("NatRuleCondition" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Rule condition of type network.␊ - */␊ - export type NetworkRuleCondition7 = ({␊ - /**␊ - * Array of FirewallPolicyRuleConditionNetworkProtocols.␊ - */␊ - ipProtocols?: (("TCP" | "UDP" | "Any" | "ICMP")[] | string)␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * List of destination IP addresses or Service Tags.␊ - */␊ - destinationAddresses?: (string[] | string)␊ - /**␊ - * List of destination ports.␊ - */␊ - destinationPorts?: (string[] | string)␊ - /**␊ - * List of source IpGroups for this rule.␊ - */␊ - sourceIpGroups?: (string[] | string)␊ - /**␊ - * List of destination IpGroups for this rule.␊ - */␊ - destinationIpGroups?: (string[] | string)␊ - ruleConditionType: string␊ - [k: string]: unknown␊ - } & {␊ - ruleConditionType?: ("NetworkRuleCondition" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Firewall Policy Filter Rule.␊ - */␊ - export type FirewallPolicyFilterRule7 = ({␊ - /**␊ - * The action type of a Filter rule.␊ - */␊ - action?: (FirewallPolicyFilterRuleAction7 | string)␊ - /**␊ - * Collection of rule conditions used by a rule.␊ - */␊ - ruleConditions?: (({␊ - ruleConditionType?: ("FirewallPolicyRuleCondition" | string)␊ - [k: string]: unknown␊ - } | ApplicationRuleCondition7 | NatRuleCondition2 | NetworkRuleCondition7)[] | string)␊ - ruleType: string␊ - [k: string]: unknown␊ - } & {␊ - ruleType?: ("FirewallPolicyFilterRule" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Properties of the rule collection.␊ - */␊ - export type FirewallPolicyRuleCollection = ({␊ - /**␊ - * The name of the rule collection.␊ - */␊ - name?: string␊ - /**␊ - * Priority of the Firewall Policy Rule Collection resource.␊ - */␊ - priority?: (number | string)␊ - ruleCollectionType: string␊ - [k: string]: unknown␊ - } & ({␊ - ruleCollectionType?: ("FirewallPolicyRuleCollection" | string)␊ - [k: string]: unknown␊ - } | FirewallPolicyNatRuleCollection | FirewallPolicyFilterRuleCollection))␊ - /**␊ - * Firewall Policy NAT Rule Collection.␊ - */␊ - export type FirewallPolicyNatRuleCollection = ({␊ - /**␊ - * The action type of a Nat rule collection.␊ - */␊ - action?: (FirewallPolicyNatRuleCollectionAction | string)␊ - /**␊ - * List of rules included in a rule collection.␊ - */␊ - rules?: (FirewallPolicyRule8[] | string)␊ - ruleCollectionType: string␊ - [k: string]: unknown␊ - } & {␊ - ruleCollectionType?: ("FirewallPolicyNatRuleCollection" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Properties of a rule.␊ - */␊ - export type FirewallPolicyRule8 = ({␊ - /**␊ - * Name of the rule.␊ - */␊ - name?: string␊ - /**␊ - * Description of the rule.␊ - */␊ - description?: string␊ - ruleType: string␊ - [k: string]: unknown␊ - } & ({␊ - ruleType?: ("FirewallPolicyRule" | string)␊ - [k: string]: unknown␊ - } | ApplicationRule | NatRule | NetworkRule))␊ - /**␊ - * Rule of type application.␊ - */␊ - export type ApplicationRule = ({␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * List of destination IP addresses or Service Tags.␊ - */␊ - destinationAddresses?: (string[] | string)␊ - /**␊ - * Array of Application Protocols.␊ - */␊ - protocols?: (FirewallPolicyRuleApplicationProtocol[] | string)␊ - /**␊ - * List of Urls for this rule condition.␊ - */␊ - targetUrls?: (string[] | string)␊ - /**␊ - * List of FQDNs for this rule.␊ - */␊ - targetFqdns?: (string[] | string)␊ - /**␊ - * List of FQDN Tags for this rule.␊ - */␊ - fqdnTags?: (string[] | string)␊ - /**␊ - * List of source IpGroups for this rule.␊ - */␊ - sourceIpGroups?: (string[] | string)␊ - /**␊ - * Terminate TLS connections for this rule.␊ - */␊ - terminateTLS?: (boolean | string)␊ - ruleType: string␊ - [k: string]: unknown␊ - } & {␊ - ruleType?: ("ApplicationRule" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Rule of type nat.␊ - */␊ - export type NatRule = ({␊ - /**␊ - * Array of FirewallPolicyRuleNetworkProtocols.␊ - */␊ - ipProtocols?: (("TCP" | "UDP" | "Any" | "ICMP")[] | string)␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * List of destination IP addresses or Service Tags.␊ - */␊ - destinationAddresses?: (string[] | string)␊ - /**␊ - * List of destination ports.␊ - */␊ - destinationPorts?: (string[] | string)␊ - /**␊ - * The translated address for this NAT rule.␊ - */␊ - translatedAddress?: string␊ - /**␊ - * The translated port for this NAT rule.␊ - */␊ - translatedPort?: string␊ - /**␊ - * List of source IpGroups for this rule.␊ - */␊ - sourceIpGroups?: (string[] | string)␊ - ruleType: string␊ - [k: string]: unknown␊ - } & {␊ - ruleType?: ("NatRule" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Rule of type network.␊ - */␊ - export type NetworkRule = ({␊ - /**␊ - * Array of FirewallPolicyRuleNetworkProtocols.␊ - */␊ - ipProtocols?: (("TCP" | "UDP" | "Any" | "ICMP")[] | string)␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * List of destination IP addresses or Service Tags.␊ - */␊ - destinationAddresses?: (string[] | string)␊ - /**␊ - * List of destination ports.␊ - */␊ - destinationPorts?: (string[] | string)␊ - /**␊ - * List of source IpGroups for this rule.␊ - */␊ - sourceIpGroups?: (string[] | string)␊ - /**␊ - * List of destination IpGroups for this rule.␊ - */␊ - destinationIpGroups?: (string[] | string)␊ - /**␊ - * List of destination FQDNs.␊ - */␊ - destinationFqdns?: (string[] | string)␊ - ruleType: string␊ - [k: string]: unknown␊ - } & {␊ - ruleType?: ("NetworkRule" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Firewall Policy Filter Rule Collection.␊ - */␊ - export type FirewallPolicyFilterRuleCollection = ({␊ - /**␊ - * The action type of a Filter rule collection.␊ - */␊ - action?: (FirewallPolicyFilterRuleCollectionAction | string)␊ - /**␊ - * List of rules included in a rule collection.␊ - */␊ - rules?: (({␊ - ruleType?: ("FirewallPolicyRule" | string)␊ - [k: string]: unknown␊ - } | ApplicationRule | NatRule | NetworkRule)[] | string)␊ - ruleCollectionType: string␊ - [k: string]: unknown␊ - } & {␊ - ruleCollectionType?: ("FirewallPolicyFilterRuleCollection" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Defines the connection properties of a server␊ - */␊ - export type ConnectionInfo = ({␊ - /**␊ - * Password credential.␊ - */␊ - password?: string␊ - /**␊ - * User name␊ - */␊ - userName?: string␊ - [k: string]: unknown␊ - } & SqlConnectionInfo)␊ - /**␊ - * Base class for all types of DMS task properties. If task is not supported by current client, this object is returned.␊ - */␊ - export type ProjectTaskProperties = ({␊ - [k: string]: unknown␊ - } & (ConnectToSourceSqlServerTaskProperties | ConnectToTargetSqlDbTaskProperties | GetUserTablesSqlTaskProperties | MigrateSqlServerSqlDbTaskProperties))␊ - /**␊ - * Defines the connection properties of a server␊ - */␊ - export type ConnectionInfo1 = ({␊ - /**␊ - * User name␊ - */␊ - userName?: string␊ - /**␊ - * Password credential.␊ - */␊ - password?: string␊ - type: string␊ - [k: string]: unknown␊ - } & (OracleConnectionInfo | MySqlConnectionInfo | {␊ - type?: "Unknown"␊ - [k: string]: unknown␊ - } | SqlConnectionInfo1))␊ - /**␊ - * Information for connecting to Oracle source␊ - */␊ - export type OracleConnectionInfo = ({␊ - /**␊ - * User name␊ - */␊ - userName?: string␊ - /**␊ - * Password credential.␊ - */␊ - password?: string␊ - /**␊ - * Name of the server␊ - */␊ - serverName?: string␊ - /**␊ - * Port for Server␊ - */␊ - port?: (number | string)␊ - /**␊ - * Connection mode to be used. If ConnectionString mode is used, then customConnectionString should be provided, else it should not be set.␊ - */␊ - connectionMode?: (("ConnectionString" | "Standard") | string)␊ - /**␊ - * Instance name (SID)␊ - */␊ - instance?: string␊ - /**␊ - * Connection string␊ - */␊ - customConnectionString?: string␊ - type: string␊ - [k: string]: unknown␊ - } & {␊ - type?: "OracleConnectionInfo"␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Information for connecting to MySQL source␊ - */␊ - export type MySqlConnectionInfo = ({␊ - /**␊ - * User name␊ - */␊ - userName?: string␊ - /**␊ - * Password credential.␊ - */␊ - password?: string␊ - /**␊ - * Name of the server␊ - */␊ - serverName: string␊ - /**␊ - * Port for Server␊ - */␊ - port: (number | string)␊ - type: string␊ - [k: string]: unknown␊ - } & {␊ - type?: "MySqlConnectionInfo"␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Information for connecting to SQL database server␊ - */␊ - export type SqlConnectionInfo1 = ({␊ - /**␊ - * User name␊ - */␊ - userName?: string␊ - /**␊ - * Password credential.␊ - */␊ - password?: string␊ - /**␊ - * Data source in the format Protocol:MachineName\\SQLServerInstanceName,PortNumber␊ - */␊ - dataSource: string␊ - /**␊ - * Authentication type to use for connection.␊ - */␊ - authentication?: (("None" | "WindowsAuthentication" | "SqlAuthentication" | "ActiveDirectoryIntegrated" | "ActiveDirectoryPassword") | string)␊ - /**␊ - * Whether to encrypt the connection␊ - */␊ - encryptConnection?: (boolean | string)␊ - /**␊ - * Additional connection settings␊ - */␊ - additionalSettings?: string␊ - /**␊ - * Whether to trust the server certificate␊ - */␊ - trustServerCertificate?: (boolean | string)␊ - type: string␊ - [k: string]: unknown␊ - } & {␊ - type?: "SqlConnectionInfo"␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Base class for all types of DMS task properties. If task is not supported by current client, this object is returned.␊ - */␊ - export type ProjectTaskProperties1 = ({␊ - taskType: string␊ - [k: string]: unknown␊ - } & (ValidateMigrationInputSqlServerSqlServerTaskProperties | ValidateMigrationInputSqlServerCloudDbTaskProperties | MigrateSqlServerSqlServerTaskProperties | MigrateSqlServerSqlDbTaskProperties1 | MigrateSqlServerCloudDbTaskProperties | GetProjectDetailsOracleSqlTaskProperties | GetProjectDetailsMySqlSqlTaskProperties | ConnectToTargetSqlServerTaskProperties | ConnectToTargetCloudDbTaskProperties | GetUserTablesSqlTaskProperties1 | ConnectToTargetSqlDbTaskProperties1 | ConnectToSourceSqlServerTaskProperties1 | {␊ - taskType?: ("Unknown" | string)␊ - [k: string]: unknown␊ - } | ConnectToSourceMySqlTaskProperties | ConnectToSourceOracleTaskProperties | MigrateMySqlSqlTaskProperties | MigrateOracleSqlTaskProperties))␊ - /**␊ - * Properties for task that validates migration input for SQL to SQL on VM migrations␊ - */␊ - export type ValidateMigrationInputSqlServerSqlServerTaskProperties = ({␊ - /**␊ - * Task input␊ - */␊ - input?: (ValidateMigrationInputSqlServerSqlServerTaskInput | string)␊ - taskType: string␊ - [k: string]: unknown␊ - } & {␊ - taskType?: ("ValidateMigrationInput_SqlServer_SqlServer" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Properties for task that validates migration input for SQL to Cloud DB migrations␊ - */␊ - export type ValidateMigrationInputSqlServerCloudDbTaskProperties = ({␊ - /**␊ - * Task input␊ - */␊ - input?: (ValidateMigrationInputSqlServerCloudDbTaskInput | string)␊ - taskType: string␊ - [k: string]: unknown␊ - } & {␊ - taskType?: ("ValidateMigrationInput_SqlServer_CloudDb" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Properties for the task that migrates on-prem SQL Server databases to SQL on VM␊ - */␊ - export type MigrateSqlServerSqlServerTaskProperties = ({␊ - /**␊ - * Task input␊ - */␊ - input?: (MigrateSqlServerSqlServerTaskInput | string)␊ - taskType: string␊ - [k: string]: unknown␊ - } & {␊ - taskType?: ("Migrate_SqlServer_SqlServer" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Properties for the task that migrates on-prem SQL Server databases to Azure SQL Database␊ - */␊ - export type MigrateSqlServerSqlDbTaskProperties1 = ({␊ - /**␊ - * Task input␊ - */␊ - input?: (MigrateSqlServerSqlDbTaskInput1 | string)␊ - taskType: string␊ - [k: string]: unknown␊ - } & {␊ - taskType?: ("Migrate_SqlServer_SqlDb" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Properties for task that migrates SQL Server databases to Cloud DB␊ - */␊ - export type MigrateSqlServerCloudDbTaskProperties = ({␊ - /**␊ - * Task input␊ - */␊ - input?: (MigrateSqlServerCloudDbTaskInput | string)␊ - taskType: string␊ - [k: string]: unknown␊ - } & {␊ - taskType?: ("Migrate_SqlServer_CloudDb" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Properties for task that reads information from project artifacts for Oracle as source␊ - */␊ - export type GetProjectDetailsOracleSqlTaskProperties = ({␊ - /**␊ - * Task input␊ - */␊ - input?: (GetProjectDetailsNonSqlTaskInput | string)␊ - taskType: string␊ - [k: string]: unknown␊ - } & {␊ - taskType?: ("GetProjectDetails_Oracle_Sql" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Properties for task that reads information from project artifacts for MySQL as source␊ - */␊ - export type GetProjectDetailsMySqlSqlTaskProperties = ({␊ - /**␊ - * Task input␊ - */␊ - input?: (GetProjectDetailsNonSqlTaskInput | string)␊ - taskType: string␊ - [k: string]: unknown␊ - } & {␊ - taskType?: ("GetProjectDetails_MySql_Sql" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Properties for the task that validates connection to SQL Server and target server requirements␊ - */␊ - export type ConnectToTargetSqlServerTaskProperties = ({␊ - /**␊ - * Task input␊ - */␊ - input?: (ConnectToTargetSqlServerTaskInput | string)␊ - taskType: string␊ - [k: string]: unknown␊ - } & {␊ - taskType?: ("ConnectToTarget_SqlServer" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Properties for the task that validates connection to Cloud DB␊ - */␊ - export type ConnectToTargetCloudDbTaskProperties = ({␊ - /**␊ - * Task input␊ - */␊ - input?: (ConnectToTargetCloudDbTaskInput | string)␊ - taskType: string␊ - [k: string]: unknown␊ - } & {␊ - taskType?: ("ConnectToTarget_CloudDb" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Properties for the task that collects user tables for the given list of databases␊ - */␊ - export type GetUserTablesSqlTaskProperties1 = ({␊ - /**␊ - * Task input␊ - */␊ - input?: (GetUserTablesSqlTaskInput1 | string)␊ - taskType: string␊ - [k: string]: unknown␊ - } & {␊ - taskType?: ("GetUserTables_Sql" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Properties for the task that validates connection to SQL DB and target server requirements␊ - */␊ - export type ConnectToTargetSqlDbTaskProperties1 = ({␊ - /**␊ - * Task input␊ - */␊ - input?: (ConnectToTargetSqlDbTaskInput1 | string)␊ - taskType: string␊ - [k: string]: unknown␊ - } & {␊ - taskType?: ("ConnectToTarget_SqlDb" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Properties for the task that validates connection to SQL Server and also validates source server requirements␊ - */␊ - export type ConnectToSourceSqlServerTaskProperties1 = ({␊ - /**␊ - * Task input␊ - */␊ - input?: (ConnectToSourceSqlServerTaskInput1 | string)␊ - taskType: string␊ - [k: string]: unknown␊ - } & {␊ - taskType?: ("ConnectToSource_SqlServer" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Properties for the task that validates MySQL database connection␊ - */␊ - export type ConnectToSourceMySqlTaskProperties = ({␊ - /**␊ - * Task input␊ - */␊ - input?: (ConnectToSourceMySqlTaskInput | string)␊ - taskType: string␊ - [k: string]: unknown␊ - } & {␊ - taskType?: ("ConnectToSource_MySql" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Properties for the task that validates Oracle database connection␊ - */␊ - export type ConnectToSourceOracleTaskProperties = ({␊ - /**␊ - * Task input␊ - */␊ - input?: (ConnectToSourceOracleTaskInput | string)␊ - taskType: string␊ - [k: string]: unknown␊ - } & {␊ - taskType?: ("ConnectToSource_Oracle" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Properties for task that migrates MySQL databases to Azure and SQL Server databases␊ - */␊ - export type MigrateMySqlSqlTaskProperties = ({␊ - /**␊ - * Task input␊ - */␊ - input?: (MigrateMySqlSqlTaskInput | string)␊ - taskType: string␊ - [k: string]: unknown␊ - } & {␊ - taskType?: ("Migrate_MySql_Sql" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Properties for task that migrates Oracle databases to Azure and SQL Server databases␊ - */␊ - export type MigrateOracleSqlTaskProperties = ({␊ - /**␊ - * Task input␊ - */␊ - input?: (MigrateOracleSqlTaskInput | string)␊ - taskType: string␊ - [k: string]: unknown␊ - } & {␊ - taskType?: ("Migrate_Oracle_Sql" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Base class for backup items.␊ - */␊ - export type ProtectedItem = ({␊ - /**␊ - * Type of backup management for the backed up item.␊ - */␊ - backupManagementType?: (("Invalid" | "AzureIaasVM" | "MAB" | "DPM" | "AzureBackupServer" | "AzureSql" | "AzureStorage" | "AzureWorkload" | "DefaultBackup") | string)␊ - /**␊ - * Type of workload this item represents.␊ - */␊ - workloadType?: (("Invalid" | "VM" | "FileFolder" | "AzureSqlDb" | "SQLDB" | "Exchange" | "Sharepoint" | "VMwareVM" | "SystemState" | "Client" | "GenericDataSource" | "SQLDataBase" | "AzureFileShare" | "SAPHanaDatabase" | "SAPAseDatabase") | string)␊ - /**␊ - * Unique name of container␊ - */␊ - containerName?: string␊ - /**␊ - * ARM ID of the resource to be backed up.␊ - */␊ - sourceResourceId?: string␊ - /**␊ - * ID of the backup policy with which this item is backed up.␊ - */␊ - policyId?: string␊ - /**␊ - * Timestamp when the last (latest) backup copy was created for this backup item.␊ - */␊ - lastRecoveryPoint?: string␊ - /**␊ - * Name of the backup set the backup item belongs to␊ - */␊ - backupSetName?: string␊ - /**␊ - * Create mode to indicate recovery of existing soft deleted data source or creation of new data source.␊ - */␊ - createMode?: (("Invalid" | "Default" | "Recover") | string)␊ - protectedItemType: string␊ - [k: string]: unknown␊ - } & (AzureFileshareProtectedItem | AzureIaaSVMProtectedItem | AzureSqlProtectedItem | AzureVmWorkloadProtectedItem | DPMProtectedItem | GenericProtectedItem | MabFileFolderProtectedItem | {␊ - protectedItemType?: ("ProtectedItem" | string)␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * Azure File Share workload-specific backup item.␊ - */␊ - export type AzureFileshareProtectedItem = ({␊ - /**␊ - * Friendly name of the fileshare represented by this backup item.␊ - */␊ - friendlyName?: string␊ - /**␊ - * Backup status of this backup item.␊ - */␊ - protectionStatus?: string␊ - /**␊ - * Backup state of this backup item.␊ - */␊ - protectionState?: (("Invalid" | "IRPending" | "Protected" | "ProtectionError" | "ProtectionStopped" | "ProtectionPaused") | string)␊ - /**␊ - * backups running status for this backup item.␊ - */␊ - healthStatus?: (("Passed" | "ActionRequired" | "ActionSuggested" | "Invalid") | string)␊ - /**␊ - * Last backup operation status. Possible values: Healthy, Unhealthy.␊ - */␊ - lastBackupStatus?: string␊ - /**␊ - * Timestamp of the last backup operation on this backup item.␊ - */␊ - lastBackupTime?: string␊ - /**␊ - * Additional information with this backup item.␊ - */␊ - extendedInfo?: (AzureFileshareProtectedItemExtendedInfo | string)␊ - protectedItemType: string␊ - [k: string]: unknown␊ - } & {␊ - protectedItemType?: ("AzureFileShareProtectedItem" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * IaaS VM workload-specific backup item.␊ - */␊ - export type AzureIaaSVMProtectedItem = ({␊ - /**␊ - * Friendly name of the VM represented by this backup item.␊ - */␊ - friendlyName?: string␊ - /**␊ - * Fully qualified ARM ID of the virtual machine represented by this item.␊ - */␊ - virtualMachineId?: string␊ - /**␊ - * Backup status of this backup item.␊ - */␊ - protectionStatus?: string␊ - /**␊ - * Backup state of this backup item.␊ - */␊ - protectionState?: (("Invalid" | "IRPending" | "Protected" | "ProtectionError" | "ProtectionStopped" | "ProtectionPaused") | string)␊ - /**␊ - * Health status of protected item.␊ - */␊ - healthStatus?: (("Passed" | "ActionRequired" | "ActionSuggested" | "Invalid") | string)␊ - /**␊ - * Health details on this backup item.␊ - */␊ - healthDetails?: (AzureIaaSVMHealthDetails[] | string)␊ - /**␊ - * Last backup operation status.␊ - */␊ - lastBackupStatus?: string␊ - /**␊ - * Timestamp of the last backup operation on this backup item.␊ - */␊ - lastBackupTime?: string␊ - /**␊ - * Data ID of the protected item.␊ - */␊ - protectedItemDataId?: string␊ - /**␊ - * Additional information for this backup item.␊ - */␊ - extendedInfo?: (AzureIaaSVMProtectedItemExtendedInfo | string)␊ - protectedItemType: string␊ - [k: string]: unknown␊ - } & (AzureIaaSClassicComputeVMProtectedItem | AzureIaaSComputeVMProtectedItem | {␊ - protectedItemType?: ("AzureIaaSVMProtectedItem" | string)␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * IaaS VM workload-specific backup item representing the Classic Compute VM.␊ - */␊ - export type AzureIaaSClassicComputeVMProtectedItem = ({␊ - protectedItemType: string␊ - [k: string]: unknown␊ - } & {␊ - protectedItemType?: ("Microsoft.ClassicCompute/virtualMachines" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * IaaS VM workload-specific backup item representing the Azure Resource Manager VM.␊ - */␊ - export type AzureIaaSComputeVMProtectedItem = ({␊ - protectedItemType: string␊ - [k: string]: unknown␊ - } & {␊ - protectedItemType?: ("Microsoft.Compute/virtualMachines" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Azure SQL workload-specific backup item.␊ - */␊ - export type AzureSqlProtectedItem = ({␊ - /**␊ - * Internal ID of a backup item. Used by Azure SQL Backup engine to contact Recovery Services.␊ - */␊ - protectedItemDataId?: string␊ - /**␊ - * Backup state of the backed up item.␊ - */␊ - protectionState?: (("Invalid" | "IRPending" | "Protected" | "ProtectionError" | "ProtectionStopped" | "ProtectionPaused") | string)␊ - /**␊ - * Additional information for this backup item.␊ - */␊ - extendedInfo?: (AzureSqlProtectedItemExtendedInfo | string)␊ - protectedItemType: string␊ - [k: string]: unknown␊ - } & {␊ - protectedItemType?: ("Microsoft.Sql/servers/databases" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Azure VM workload-specific protected item.␊ - */␊ - export type AzureVmWorkloadProtectedItem = ({␊ - /**␊ - * Friendly name of the DB represented by this backup item.␊ - */␊ - friendlyName?: string␊ - /**␊ - * Host/Cluster Name for instance or AG␊ - */␊ - serverName?: string␊ - /**␊ - * Parent name of the DB such as Instance or Availability Group.␊ - */␊ - parentName?: string␊ - /**␊ - * Parent type of protected item, example: for a DB, standalone server or distributed␊ - */␊ - parentType?: string␊ - /**␊ - * Backup status of this backup item.␊ - */␊ - protectionStatus?: string␊ - /**␊ - * Backup state of this backup item.␊ - */␊ - protectionState?: (("Invalid" | "IRPending" | "Protected" | "ProtectionError" | "ProtectionStopped" | "ProtectionPaused") | string)␊ - /**␊ - * Last backup operation status. Possible values: Healthy, Unhealthy.␊ - */␊ - lastBackupStatus?: (("Invalid" | "Healthy" | "Unhealthy" | "IRPending") | string)␊ - /**␊ - * Timestamp of the last backup operation on this backup item.␊ - */␊ - lastBackupTime?: string␊ - /**␊ - * Error details in last backup␊ - */␊ - lastBackupErrorDetail?: (ErrorDetail | string)␊ - /**␊ - * Data ID of the protected item.␊ - */␊ - protectedItemDataSourceId?: string␊ - /**␊ - * Health status of the backup item, evaluated based on last heartbeat received.␊ - */␊ - protectedItemHealthStatus?: (("Invalid" | "Healthy" | "Unhealthy" | "NotReachable" | "IRPending") | string)␊ - /**␊ - * Additional information for this backup item.␊ - */␊ - extendedInfo?: (AzureVmWorkloadProtectedItemExtendedInfo | string)␊ - protectedItemType: string␊ - [k: string]: unknown␊ - } & ({␊ - protectedItemType?: ("AzureVmWorkloadProtectedItem" | string)␊ - [k: string]: unknown␊ - } | AzureVmWorkloadSAPAseDatabaseProtectedItem | AzureVmWorkloadSAPHanaDatabaseProtectedItem | AzureVmWorkloadSQLDatabaseProtectedItem))␊ - /**␊ - * Azure VM workload-specific protected item representing SAP ASE Database.␊ - */␊ - export type AzureVmWorkloadSAPAseDatabaseProtectedItem = ({␊ - protectedItemType: string␊ - [k: string]: unknown␊ - } & {␊ - protectedItemType?: ("AzureVmWorkloadSAPAseDatabase" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Azure VM workload-specific protected item representing SAP HANA Database.␊ - */␊ - export type AzureVmWorkloadSAPHanaDatabaseProtectedItem = ({␊ - protectedItemType: string␊ - [k: string]: unknown␊ - } & {␊ - protectedItemType?: ("AzureVmWorkloadSAPHanaDatabase" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Azure VM workload-specific protected item representing SQL Database.␊ - */␊ - export type AzureVmWorkloadSQLDatabaseProtectedItem = ({␊ - protectedItemType: string␊ - [k: string]: unknown␊ - } & {␊ - protectedItemType?: ("AzureVmWorkloadSQLDatabase" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Additional information on Backup engine specific backup item.␊ - */␊ - export type DPMProtectedItem = ({␊ - /**␊ - * Friendly name of the managed item␊ - */␊ - friendlyName?: string␊ - /**␊ - * Backup Management server protecting this backup item␊ - */␊ - backupEngineName?: string␊ - /**␊ - * Protection state of the backupengine.␊ - */␊ - protectionState?: (("Invalid" | "IRPending" | "Protected" | "ProtectionError" | "ProtectionStopped" | "ProtectionPaused") | string)␊ - /**␊ - * To check if backup item is scheduled for deferred delete␊ - */␊ - isScheduledForDeferredDelete?: (boolean | string)␊ - /**␊ - * Extended info of the backup item.␊ - */␊ - extendedInfo?: (DPMProtectedItemExtendedInfo | string)␊ - protectedItemType: string␊ - [k: string]: unknown␊ - } & {␊ - protectedItemType?: ("DPMProtectedItem" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Base class for backup items.␊ - */␊ - export type GenericProtectedItem = ({␊ - /**␊ - * Friendly name of the container.␊ - */␊ - friendlyName?: string␊ - /**␊ - * Indicates consistency of policy object and policy applied to this backup item.␊ - */␊ - policyState?: string␊ - /**␊ - * Backup state of this backup item.␊ - */␊ - protectionState?: (("Invalid" | "IRPending" | "Protected" | "ProtectionError" | "ProtectionStopped" | "ProtectionPaused") | string)␊ - /**␊ - * Data Plane Service ID of the protected item.␊ - */␊ - protectedItemId?: (number | string)␊ - /**␊ - * Loosely coupled (type, value) associations (example - parent of a protected item)␊ - */␊ - sourceAssociations?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Name of this backup item's fabric.␊ - */␊ - fabricName?: string␊ - protectedItemType: string␊ - [k: string]: unknown␊ - } & {␊ - protectedItemType?: ("GenericProtectedItem" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * MAB workload-specific backup item.␊ - */␊ - export type MabFileFolderProtectedItem = ({␊ - /**␊ - * Friendly name of this backup item.␊ - */␊ - friendlyName?: string␊ - /**␊ - * Name of the computer associated with this backup item.␊ - */␊ - computerName?: string␊ - /**␊ - * Status of last backup operation.␊ - */␊ - lastBackupStatus?: string␊ - /**␊ - * Protected, ProtectionStopped, IRPending or ProtectionError␊ - */␊ - protectionState?: string␊ - /**␊ - * Specifies if the item is scheduled for deferred deletion.␊ - */␊ - isScheduledForDeferredDelete?: (boolean | string)␊ - /**␊ - * Sync time for deferred deletion.␊ - */␊ - deferredDeleteSyncTimeInUTC?: (number | string)␊ - /**␊ - * Additional information with this backup item.␊ - */␊ - extendedInfo?: (MabFileFolderProtectedItemExtendedInfo | string)␊ - protectedItemType: string␊ - [k: string]: unknown␊ - } & {␊ - protectedItemType?: ("MabFileFolderProtectedItem" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Base class for backup policy. Workload-specific backup policies are derived from this class.␊ - */␊ - export type ProtectionPolicy = ({␊ - /**␊ - * Number of items associated with this policy.␊ - */␊ - protectedItemsCount?: (number | string)␊ - backupManagementType: string␊ - [k: string]: unknown␊ - } & (AzureFileShareProtectionPolicy | AzureIaaSVMProtectionPolicy | AzureSqlProtectionPolicy | AzureVmWorkloadProtectionPolicy | GenericProtectionPolicy | MabProtectionPolicy | {␊ - backupManagementType?: ("ProtectionPolicy" | string)␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * AzureStorage backup policy.␊ - */␊ - export type AzureFileShareProtectionPolicy = ({␊ - /**␊ - * Type of workload for the backup management.␊ - */␊ - workLoadType?: (("Invalid" | "VM" | "FileFolder" | "AzureSqlDb" | "SQLDB" | "Exchange" | "Sharepoint" | "VMwareVM" | "SystemState" | "Client" | "GenericDataSource" | "SQLDataBase" | "AzureFileShare" | "SAPHanaDatabase" | "SAPAseDatabase") | string)␊ - /**␊ - * Backup schedule specified as part of backup policy.␊ - */␊ - schedulePolicy?: (SchedulePolicy | string)␊ - /**␊ - * Retention policy with the details on backup copy retention ranges.␊ - */␊ - retentionPolicy?: (RetentionPolicy | string)␊ - /**␊ - * TimeZone optional input as string. For example: TimeZone = "Pacific Standard Time".␊ - */␊ - timeZone?: string␊ - backupManagementType: string␊ - [k: string]: unknown␊ - } & {␊ - backupManagementType?: ("AzureStorage" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Base class for backup schedule.␊ - */␊ - export type SchedulePolicy = ({␊ - schedulePolicyType: string␊ - [k: string]: unknown␊ - } & ({␊ - schedulePolicyType?: ("SchedulePolicy" | string)␊ - [k: string]: unknown␊ - } | LogSchedulePolicy | LongTermSchedulePolicy | SimpleSchedulePolicy))␊ - /**␊ - * Log policy schedule.␊ - */␊ - export type LogSchedulePolicy = ({␊ - /**␊ - * Frequency of the log schedule operation of this policy in minutes.␊ - */␊ - scheduleFrequencyInMins?: (number | string)␊ - schedulePolicyType: string␊ - [k: string]: unknown␊ - } & {␊ - schedulePolicyType?: ("LogSchedulePolicy" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Long term policy schedule.␊ - */␊ - export type LongTermSchedulePolicy = ({␊ - schedulePolicyType: string␊ - [k: string]: unknown␊ - } & {␊ - schedulePolicyType?: ("LongTermSchedulePolicy" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Simple policy schedule.␊ - */␊ - export type SimpleSchedulePolicy = ({␊ - /**␊ - * Frequency of the schedule operation of this policy.␊ - */␊ - scheduleRunFrequency?: (("Invalid" | "Daily" | "Weekly") | string)␊ - /**␊ - * List of days of week this schedule has to be run.␊ - */␊ - scheduleRunDays?: (("Sunday" | "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday")[] | string)␊ - /**␊ - * List of times of day this schedule has to be run.␊ - */␊ - scheduleRunTimes?: (string[] | string)␊ - /**␊ - * At every number weeks this schedule has to be run.␊ - */␊ - scheduleWeeklyFrequency?: (number | string)␊ - schedulePolicyType: string␊ - [k: string]: unknown␊ - } & {␊ - schedulePolicyType?: ("SimpleSchedulePolicy" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Base class for retention policy.␊ - */␊ - export type RetentionPolicy = ({␊ - retentionPolicyType: string␊ - [k: string]: unknown␊ - } & ({␊ - retentionPolicyType?: ("RetentionPolicy" | string)␊ - [k: string]: unknown␊ - } | LongTermRetentionPolicy | SimpleRetentionPolicy))␊ - /**␊ - * Long term retention policy.␊ - */␊ - export type LongTermRetentionPolicy = ({␊ - /**␊ - * Daily retention schedule of the protection policy.␊ - */␊ - dailySchedule?: (DailyRetentionSchedule | string)␊ - /**␊ - * Weekly retention schedule of the protection policy.␊ - */␊ - weeklySchedule?: (WeeklyRetentionSchedule | string)␊ - /**␊ - * Monthly retention schedule of the protection policy.␊ - */␊ - monthlySchedule?: (MonthlyRetentionSchedule | string)␊ - /**␊ - * Yearly retention schedule of the protection policy.␊ - */␊ - yearlySchedule?: (YearlyRetentionSchedule | string)␊ - retentionPolicyType: string␊ - [k: string]: unknown␊ - } & {␊ - retentionPolicyType?: ("LongTermRetentionPolicy" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Simple policy retention.␊ - */␊ - export type SimpleRetentionPolicy = ({␊ - /**␊ - * Retention duration of the protection policy.␊ - */␊ - retentionDuration?: (RetentionDuration | string)␊ - retentionPolicyType: string␊ - [k: string]: unknown␊ - } & {␊ - retentionPolicyType?: ("SimpleRetentionPolicy" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * IaaS VM workload-specific backup policy.␊ - */␊ - export type AzureIaaSVMProtectionPolicy = ({␊ - /**␊ - * Backup schedule specified as part of backup policy.␊ - */␊ - schedulePolicy?: (({␊ - schedulePolicyType?: ("SchedulePolicy" | string)␊ - [k: string]: unknown␊ - } | LogSchedulePolicy | LongTermSchedulePolicy | SimpleSchedulePolicy) | string)␊ - /**␊ - * Retention policy with the details on backup copy retention ranges.␊ - */␊ - retentionPolicy?: (({␊ - retentionPolicyType?: ("RetentionPolicy" | string)␊ - [k: string]: unknown␊ - } | LongTermRetentionPolicy | SimpleRetentionPolicy) | string)␊ - /**␊ - * Instant RP retention policy range in days␊ - */␊ - instantRpRetentionRangeInDays?: (number | string)␊ - /**␊ - * TimeZone optional input as string. For example: TimeZone = "Pacific Standard Time".␊ - */␊ - timeZone?: string␊ - backupManagementType: string␊ - [k: string]: unknown␊ - } & {␊ - backupManagementType?: ("AzureIaasVM" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Azure SQL workload-specific backup policy.␊ - */␊ - export type AzureSqlProtectionPolicy = ({␊ - /**␊ - * Retention policy details.␊ - */␊ - retentionPolicy?: (({␊ - retentionPolicyType?: ("RetentionPolicy" | string)␊ - [k: string]: unknown␊ - } | LongTermRetentionPolicy | SimpleRetentionPolicy) | string)␊ - backupManagementType: string␊ - [k: string]: unknown␊ - } & {␊ - backupManagementType?: ("AzureSql" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Azure VM (Mercury) workload-specific backup policy.␊ - */␊ - export type AzureVmWorkloadProtectionPolicy = ({␊ - /**␊ - * Type of workload for the backup management.␊ - */␊ - workLoadType?: (("Invalid" | "VM" | "FileFolder" | "AzureSqlDb" | "SQLDB" | "Exchange" | "Sharepoint" | "VMwareVM" | "SystemState" | "Client" | "GenericDataSource" | "SQLDataBase" | "AzureFileShare" | "SAPHanaDatabase" | "SAPAseDatabase") | string)␊ - /**␊ - * Common settings for the backup management␊ - */␊ - settings?: (Settings | string)␊ - /**␊ - * List of sub-protection policies which includes schedule and retention␊ - */␊ - subProtectionPolicy?: (SubProtectionPolicy[] | string)␊ - backupManagementType: string␊ - [k: string]: unknown␊ - } & {␊ - backupManagementType?: ("AzureWorkload" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Azure VM (Mercury) workload-specific backup policy.␊ - */␊ - export type GenericProtectionPolicy = ({␊ - /**␊ - * List of sub-protection policies which includes schedule and retention␊ - */␊ - subProtectionPolicy?: (SubProtectionPolicy[] | string)␊ - /**␊ - * TimeZone optional input as string. For example: TimeZone = "Pacific Standard Time".␊ - */␊ - timeZone?: string␊ - /**␊ - * Name of this policy's fabric.␊ - */␊ - fabricName?: string␊ - backupManagementType: string␊ - [k: string]: unknown␊ - } & {␊ - backupManagementType?: ("GenericProtectionPolicy" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Mab container-specific backup policy.␊ - */␊ - export type MabProtectionPolicy = ({␊ - /**␊ - * Backup schedule of backup policy.␊ - */␊ - schedulePolicy?: (({␊ - schedulePolicyType?: ("SchedulePolicy" | string)␊ - [k: string]: unknown␊ - } | LogSchedulePolicy | LongTermSchedulePolicy | SimpleSchedulePolicy) | string)␊ - /**␊ - * Retention policy details.␊ - */␊ - retentionPolicy?: (({␊ - retentionPolicyType?: ("RetentionPolicy" | string)␊ - [k: string]: unknown␊ - } | LongTermRetentionPolicy | SimpleRetentionPolicy) | string)␊ - backupManagementType: string␊ - [k: string]: unknown␊ - } & {␊ - backupManagementType?: ("MAB" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Base class for backup ProtectionIntent.␊ - */␊ - export type ProtectionIntent = ({␊ - /**␊ - * Type of backup management for the backed up item.␊ - */␊ - backupManagementType?: (("Invalid" | "AzureIaasVM" | "MAB" | "DPM" | "AzureBackupServer" | "AzureSql" | "AzureStorage" | "AzureWorkload" | "DefaultBackup") | string)␊ - /**␊ - * ARM ID of the resource to be backed up.␊ - */␊ - sourceResourceId?: string␊ - /**␊ - * ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId␊ - */␊ - itemId?: string␊ - /**␊ - * ID of the backup policy with which this item is backed up.␊ - */␊ - policyId?: string␊ - /**␊ - * Backup state of this backup item.␊ - */␊ - protectionState?: (("Invalid" | "NotProtected" | "Protecting" | "Protected" | "ProtectionFailed") | string)␊ - protectionIntentItemType: string␊ - [k: string]: unknown␊ - } & (AzureRecoveryServiceVaultProtectionIntent | AzureResourceProtectionIntent | {␊ - protectionIntentItemType?: ("ProtectionIntent" | string)␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * Azure Recovery Services Vault specific protection intent item.␊ - */␊ - export type AzureRecoveryServiceVaultProtectionIntent = ({␊ - protectionIntentItemType: string␊ - [k: string]: unknown␊ - } & ({␊ - protectionIntentItemType?: ("RecoveryServiceVaultItem" | string)␊ - [k: string]: unknown␊ - } | AzureWorkloadAutoProtectionIntent))␊ - /**␊ - * Azure Recovery Services Vault specific protection intent item.␊ - */␊ - export type AzureWorkloadAutoProtectionIntent = ({␊ - protectionIntentItemType: string␊ - [k: string]: unknown␊ - } & ({␊ - protectionIntentItemType?: ("AzureWorkloadAutoProtectionIntent" | string)␊ - [k: string]: unknown␊ - } | AzureWorkloadSQLAutoProtectionIntent))␊ - /**␊ - * Azure Workload SQL Auto Protection intent item.␊ - */␊ - export type AzureWorkloadSQLAutoProtectionIntent = ({␊ - /**␊ - * Workload item type of the item for which intent is to be set.␊ - */␊ - workloadItemType?: (("Invalid" | "SQLInstance" | "SQLDataBase" | "SAPHanaSystem" | "SAPHanaDatabase" | "SAPAseSystem" | "SAPAseDatabase") | string)␊ - protectionIntentItemType: string␊ - [k: string]: unknown␊ - } & {␊ - protectionIntentItemType?: ("AzureWorkloadSQLAutoProtectionIntent" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * IaaS VM specific backup protection intent item.␊ - */␊ - export type AzureResourceProtectionIntent = ({␊ - /**␊ - * Friendly name of the VM represented by this backup item.␊ - */␊ - friendlyName?: string␊ - protectionIntentItemType: string␊ - [k: string]: unknown␊ - } & {␊ - protectionIntentItemType?: ("AzureResourceItem" | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Base class for container with backup items. Containers with specific workloads are derived from this class.␊ - */␊ - export type ProtectionContainer = ({␊ - /**␊ - * Type of backup management for the container.␊ - */␊ - backupManagementType?: (("Invalid" | "AzureIaasVM" | "MAB" | "DPM" | "AzureSql" | "AzureBackupServer" | "AzureWorkload" | "AzureStorage" | "DefaultBackup") | string)␊ - /**␊ - * Friendly name of the container.␊ - */␊ - friendlyName?: string␊ - /**␊ - * Status of health of the container.␊ - */␊ - healthStatus?: string␊ - /**␊ - * Status of registration of the container with the Recovery Services Vault.␊ - */␊ - registrationStatus?: string␊ - [k: string]: unknown␊ - } & (AzureSqlContainer | AzureStorageContainer | AzureWorkloadContainer | DpmContainer | GenericContainer | IaaSVMContainer | MabContainer))␊ - /**␊ - * Container for the workloads running inside Azure Compute or Classic Compute.␊ - */␊ - export type AzureWorkloadContainer = ({␊ - containerType: "AzureWorkloadContainer"␊ - /**␊ - * Extended information of the container.␊ - */␊ - extendedInfo?: (AzureWorkloadContainerExtendedInfo | string)␊ - /**␊ - * Time stamp when this container was updated.␊ - */␊ - lastUpdatedTime?: string␊ - /**␊ - * Re-Do Operation.␊ - */␊ - operationType?: (("Invalid" | "Register" | "Reregister") | string)␊ - /**␊ - * ARM ID of the virtual machine represented by this Azure Workload Container␊ - */␊ - sourceResourceId?: string␊ - /**␊ - * Workload type for which registration was sent.␊ - */␊ - workloadType?: (("Invalid" | "VM" | "FileFolder" | "AzureSqlDb" | "SQLDB" | "Exchange" | "Sharepoint" | "VMwareVM" | "SystemState" | "Client" | "GenericDataSource" | "SQLDataBase" | "AzureFileShare" | "SAPHanaDatabase" | "SAPAseDatabase") | string)␊ - [k: string]: unknown␊ - } & (AzureSQLAGWorkloadContainerProtectionContainer | AzureVMAppContainerProtectionContainer))␊ - /**␊ - * DPM workload-specific protection container.␊ - */␊ - export type DpmContainer = ({␊ - /**␊ - * Specifies whether the container is re-registrable.␊ - */␊ - canReRegister?: (boolean | string)␊ - /**␊ - * ID of container.␊ - */␊ - containerId?: string␊ - containerType: "DPMContainer"␊ - /**␊ - * Backup engine Agent version␊ - */␊ - dpmAgentVersion?: string␊ - /**␊ - * List of BackupEngines protecting the container␊ - */␊ - dpmServers?: (string[] | string)␊ - /**␊ - * Additional information of the DPMContainer.␊ - */␊ - extendedInfo?: (DPMContainerExtendedInfo | string)␊ - /**␊ - * Number of protected items in the BackupEngine␊ - */␊ - protectedItemCount?: (number | string)␊ - /**␊ - * Protection status of the container.␊ - */␊ - protectionStatus?: string␊ - /**␊ - * To check if upgrade available␊ - */␊ - upgradeAvailable?: (boolean | string)␊ - [k: string]: unknown␊ - } & AzureBackupServerContainer)␊ - /**␊ - * IaaS VM workload-specific container.␊ - */␊ - export type IaaSVMContainer = ({␊ - containerType: "IaaSVMContainer"␊ - /**␊ - * Resource group name of Recovery Services Vault.␊ - */␊ - resourceGroup?: string␊ - /**␊ - * Fully qualified ARM url of the virtual machine represented by this Azure IaaS VM container.␊ - */␊ - virtualMachineId?: string␊ - /**␊ - * Specifies whether the container represents a Classic or an Azure Resource Manager VM.␊ - */␊ - virtualMachineVersion?: string␊ - [k: string]: unknown␊ - } & (AzureIaaSClassicComputeVMContainer | AzureIaaSComputeVMContainer))␊ - /**␊ - * Microsoft.HDInsight/clusters/extensions␊ - */␊ - export type ClustersExtensionsChildResource = ({␊ - apiVersion: "2015-03-01-preview"␊ - type: "extensions"␊ - [k: string]: unknown␊ - } & ({␊ - name: "clustermonitoring"␊ - /**␊ - * The cluster monitor workspace key.␊ - */␊ - primaryKey?: string␊ - /**␊ - * The cluster monitor workspace ID.␊ - */␊ - workspaceId?: string␊ - [k: string]: unknown␊ - } | {␊ - name: "azureMonitor"␊ - /**␊ - * The Log Analytics workspace key.␊ - */␊ - primaryKey?: string␊ - /**␊ - * The selected configurations for azure monitor.␊ - */␊ - selectedConfigurations?: (AzureMonitorSelectedConfigurations | string)␊ - /**␊ - * The Log Analytics workspace ID.␊ - */␊ - workspaceId?: string␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * Microsoft.HDInsight/clusters/extensions␊ - */␊ - export type ClustersExtensions = ({␊ - apiVersion: "2015-03-01-preview"␊ - type: "Microsoft.HDInsight/clusters/extensions"␊ - [k: string]: unknown␊ - } & ({␊ - name: string␊ - /**␊ - * The cluster monitor workspace key.␊ - */␊ - primaryKey?: string␊ - /**␊ - * The cluster monitor workspace ID.␊ - */␊ - workspaceId?: string␊ - [k: string]: unknown␊ - } | {␊ - name: string␊ - /**␊ - * The Log Analytics workspace key.␊ - */␊ - primaryKey?: string␊ - /**␊ - * The selected configurations for azure monitor.␊ - */␊ - selectedConfigurations?: (AzureMonitorSelectedConfigurations | string)␊ - /**␊ - * The Log Analytics workspace ID.␊ - */␊ - workspaceId?: string␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * Microsoft.HDInsight/clusters/extensions␊ - */␊ - export type ClustersExtensionsChildResource1 = ({␊ - apiVersion: "2018-06-01-preview"␊ - type: "extensions"␊ - [k: string]: unknown␊ - } & ({␊ - name: "clustermonitoring"␊ - /**␊ - * The cluster monitor workspace key.␊ - */␊ - primaryKey?: string␊ - /**␊ - * The cluster monitor workspace ID.␊ - */␊ - workspaceId?: string␊ - [k: string]: unknown␊ - } | {␊ - name: "azureMonitor"␊ - /**␊ - * The Log Analytics workspace key.␊ - */␊ - primaryKey?: string␊ - /**␊ - * The selected configurations for azure monitor.␊ - */␊ - selectedConfigurations?: (AzureMonitorSelectedConfigurations1 | string)␊ - /**␊ - * The Log Analytics workspace ID.␊ - */␊ - workspaceId?: string␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * Microsoft.HDInsight/clusters/extensions␊ - */␊ - export type ClustersExtensions1 = ({␊ - apiVersion: "2018-06-01-preview"␊ - type: "Microsoft.HDInsight/clusters/extensions"␊ - [k: string]: unknown␊ - } & ({␊ - name: string␊ - /**␊ - * The cluster monitor workspace key.␊ - */␊ - primaryKey?: string␊ - /**␊ - * The cluster monitor workspace ID.␊ - */␊ - workspaceId?: string␊ - [k: string]: unknown␊ - } | {␊ - name: string␊ - /**␊ - * The Log Analytics workspace key.␊ - */␊ - primaryKey?: string␊ - /**␊ - * The selected configurations for azure monitor.␊ - */␊ - selectedConfigurations?: (AzureMonitorSelectedConfigurations1 | string)␊ - /**␊ - * The Log Analytics workspace ID.␊ - */␊ - workspaceId?: string␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * A custom alert rule that checks if a value (depends on the custom alert type) is allowed.␊ - */␊ - export type AllowlistCustomAlertRule = ({␊ - /**␊ - * The values to allow. The format of the values depends on the rule type.␊ - */␊ - allowlistValues: (string[] | string)␊ - /**␊ - * Status of the custom alert.␊ - */␊ - isEnabled: (boolean | string)␊ - [k: string]: unknown␊ - } & (ConnectionToIpNotAllowed | LocalUserNotAllowed | ProcessNotAllowed))␊ - /**␊ - * A custom alert rule that checks if a value (depends on the custom alert type) is within the given range.␊ - */␊ - export type ThresholdCustomAlertRule = ({␊ - /**␊ - * Status of the custom alert.␊ - */␊ - isEnabled: (boolean | string)␊ - /**␊ - * The maximum threshold.␊ - */␊ - maxThreshold: (number | string)␊ - /**␊ - * The minimum threshold.␊ - */␊ - minThreshold: (number | string)␊ - [k: string]: unknown␊ - } & TimeWindowCustomAlertRule)␊ - /**␊ - * A custom alert rule that checks if the number of activities (depends on the custom alert type) in a time window is within the given range.␊ - */␊ - export type TimeWindowCustomAlertRule = ({␊ - ruleType: "TimeWindowCustomAlertRule"␊ - /**␊ - * The time window size in iso8601 format.␊ - */␊ - timeWindowSize: string␊ - [k: string]: unknown␊ - } & (ActiveConnectionsNotInAllowedRange | AmqpC2DMessagesNotInAllowedRange | MqttC2DMessagesNotInAllowedRange | HttpC2DMessagesNotInAllowedRange | AmqpC2DRejectedMessagesNotInAllowedRange | MqttC2DRejectedMessagesNotInAllowedRange | HttpC2DRejectedMessagesNotInAllowedRange | AmqpD2CMessagesNotInAllowedRange | MqttD2CMessagesNotInAllowedRange | HttpD2CMessagesNotInAllowedRange | DirectMethodInvokesNotInAllowedRange | FailedLocalLoginsNotInAllowedRange | FileUploadsNotInAllowedRange | QueuePurgesNotInAllowedRange | TwinUpdatesNotInAllowedRange | UnauthorizedOperationsNotInAllowedRange))␊ - /**␊ - * The action that should be triggered.␊ - */␊ - export type AutomationAction = ({␊ - [k: string]: unknown␊ - } & (AutomationActionLogicApp | AutomationActionEventHub | AutomationActionWorkspace))␊ - /**␊ - * Details of the resource that was assessed␊ - */␊ - export type ResourceDetails = ({␊ - [k: string]: unknown␊ - } & (AzureResourceDetails | OnPremiseResourceDetails))␊ - /**␊ - * Details of the On Premise resource that was assessed␊ - */␊ - export type OnPremiseResourceDetails = ({␊ - /**␊ - * The name of the machine␊ - */␊ - machineName: string␊ - source: "OnPremise"␊ - /**␊ - * The oms agent Id installed on the machine␊ - */␊ - sourceComputerId: string␊ - /**␊ - * The unique Id of the machine␊ - */␊ - vmuuid: string␊ - /**␊ - * Azure resource Id of the workspace the machine is attached to␊ - */␊ - workspaceId: string␊ - [k: string]: unknown␊ - } & OnPremiseSqlResourceDetails)␊ - /**␊ - * A custom alert rule that checks if a value (depends on the custom alert type) is allowed.␊ - */␊ - export type AllowlistCustomAlertRule1 = ({␊ - /**␊ - * The values to allow. The format of the values depends on the rule type.␊ - */␊ - allowlistValues: (string[] | string)␊ - /**␊ - * Status of the custom alert.␊ - */␊ - isEnabled: (boolean | string)␊ - [k: string]: unknown␊ - } & (ConnectionToIpNotAllowed1 | ConnectionFromIpNotAllowed | LocalUserNotAllowed1 | ProcessNotAllowed1))␊ - /**␊ - * A custom alert rule that checks if a value (depends on the custom alert type) is within the given range.␊ - */␊ - export type ThresholdCustomAlertRule1 = ({␊ - /**␊ - * Status of the custom alert.␊ - */␊ - isEnabled: (boolean | string)␊ - /**␊ - * The maximum threshold.␊ - */␊ - maxThreshold: (number | string)␊ - /**␊ - * The minimum threshold.␊ - */␊ - minThreshold: (number | string)␊ - [k: string]: unknown␊ - } & TimeWindowCustomAlertRule1)␊ - /**␊ - * A custom alert rule that checks if the number of activities (depends on the custom alert type) in a time window is within the given range.␊ - */␊ - export type TimeWindowCustomAlertRule1 = ({␊ - ruleType: "TimeWindowCustomAlertRule"␊ - /**␊ - * The time window size in iso8601 format.␊ - */␊ - timeWindowSize: string␊ - [k: string]: unknown␊ - } & (ActiveConnectionsNotInAllowedRange1 | AmqpC2DMessagesNotInAllowedRange1 | MqttC2DMessagesNotInAllowedRange1 | HttpC2DMessagesNotInAllowedRange1 | AmqpC2DRejectedMessagesNotInAllowedRange1 | MqttC2DRejectedMessagesNotInAllowedRange1 | HttpC2DRejectedMessagesNotInAllowedRange1 | AmqpD2CMessagesNotInAllowedRange1 | MqttD2CMessagesNotInAllowedRange1 | HttpD2CMessagesNotInAllowedRange1 | DirectMethodInvokesNotInAllowedRange1 | FailedLocalLoginsNotInAllowedRange1 | FileUploadsNotInAllowedRange1 | QueuePurgesNotInAllowedRange1 | TwinUpdatesNotInAllowedRange1 | UnauthorizedOperationsNotInAllowedRange1))␊ - /**␊ - * Details of the resource that was assessed␊ - */␊ - export type ResourceDetails1 = ({␊ - [k: string]: unknown␊ - } & (AzureResourceDetails1 | OnPremiseResourceDetails1))␊ - /**␊ - * Details of the On Premise resource that was assessed␊ - */␊ - export type OnPremiseResourceDetails1 = ({␊ - /**␊ - * The name of the machine␊ - */␊ - machineName: string␊ - source: "OnPremise"␊ - /**␊ - * The oms agent Id installed on the machine␊ - */␊ - sourceComputerId: string␊ - /**␊ - * The unique Id of the machine␊ - */␊ - vmuuid: string␊ - /**␊ - * Azure resource Id of the workspace the machine is attached to␊ - */␊ - workspaceId: string␊ - [k: string]: unknown␊ - } & OnPremiseSqlResourceDetails1)␊ - /**␊ - * The solution summary class.␊ - */␊ - export type SolutionSummary = ({␊ - [k: string]: unknown␊ - } & (ServersSolutionSummary | DatabasesSolutionSummary))␊ - /**␊ - * Azure Data Factory nested object which serves as a compute resource for activities.␊ - */␊ - export type IntegrationRuntime = ({␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Integration runtime description.␊ - */␊ - description?: string␊ - [k: string]: unknown␊ - } & (ManagedIntegrationRuntime | SelfHostedIntegrationRuntime))␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - export type LinkedIntegrationRuntimeProperties = ({␊ - [k: string]: unknown␊ - } & (LinkedIntegrationRuntimeKey | LinkedIntegrationRuntimeRbac))␊ - /**␊ - * The Azure Data Factory nested object which contains the information and credential which can be used to connect with related store or compute resource.␊ - */␊ - export type LinkedService = ({␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * List of tags that can be used for describing the Dataset.␊ - */␊ - annotations?: ({␊ - [k: string]: unknown␊ - }[] | string)␊ - /**␊ - * Integration runtime reference type.␊ - */␊ - connectVia?: (IntegrationRuntimeReference | string)␊ - /**␊ - * Linked service description.␊ - */␊ - description?: string␊ - /**␊ - * Definition of all parameters for an entity.␊ - */␊ - parameters?: ({␊ - [k: string]: ParameterSpecification␊ - } | string)␊ - [k: string]: unknown␊ - } & (AzureStorageLinkedService | AzureSqlDWLinkedService | SqlServerLinkedService | AzureSqlDatabaseLinkedService | AzureBatchLinkedService | AzureKeyVaultLinkedService | CosmosDbLinkedService | DynamicsLinkedService | HDInsightLinkedService | FileServerLinkedService | OracleLinkedService | AzureMySqlLinkedService | MySqlLinkedService | PostgreSqlLinkedService | SybaseLinkedService | Db2LinkedService | TeradataLinkedService | AzureMLLinkedService | OdbcLinkedService | HdfsLinkedService | ODataLinkedService | WebLinkedService | CassandraLinkedService | MongoDbLinkedService | AzureDataLakeStoreLinkedService | SalesforceLinkedService | SapCloudForCustomerLinkedService | SapEccLinkedService | AmazonS3LinkedService | AmazonRedshiftLinkedService | CustomDataSourceLinkedService | AzureSearchLinkedService | HttpLinkedService | FtpServerLinkedService | SftpServerLinkedService | SapBWLinkedService | SapHanaLinkedService | AmazonMWSLinkedService | AzurePostgreSqlLinkedService | ConcurLinkedService | CouchbaseLinkedService | DrillLinkedService | EloquaLinkedService | GoogleBigQueryLinkedService | GreenplumLinkedService | HBaseLinkedService | HiveLinkedService | HubspotLinkedService | ImpalaLinkedService | JiraLinkedService | MagentoLinkedService | MariaDBLinkedService | MarketoLinkedService | PaypalLinkedService | PhoenixLinkedService | PrestoLinkedService | QuickBooksLinkedService | ServiceNowLinkedService | ShopifyLinkedService | SparkLinkedService | SquareLinkedService | XeroLinkedService | ZohoLinkedService | VerticaLinkedService | NetezzaLinkedService | SalesforceMarketingCloudLinkedService | HDInsightOnDemandLinkedService | AzureDataLakeAnalyticsLinkedService | AzureDatabricksLinkedService | ResponsysLinkedService))␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - export type SecretBase = ({␊ - [k: string]: unknown␊ - } & (SecureString | AzureKeyVaultSecretReference))␊ - /**␊ - * Base definition of WebLinkedServiceTypeProperties, this typeProperties is polymorphic based on authenticationType, so not flattened in SDK models.␊ - */␊ - export type WebLinkedServiceTypeProperties = ({␊ - /**␊ - * The URL of the web service endpoint, e.g. https://www.microsoft.com . Type: string (or Expression with resultType string).␊ - */␊ - url: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - } & (WebAnonymousAuthentication | WebBasicAuthentication | WebClientCertificateAuthentication))␊ - /**␊ - * The Azure Data Factory nested object which identifies data within different data stores, such as tables, files, folders, and documents.␊ - */␊ - export type Dataset = ({␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * List of tags that can be used for describing the Dataset.␊ - */␊ - annotations?: ({␊ - [k: string]: unknown␊ - }[] | string)␊ - /**␊ - * Dataset description.␊ - */␊ - description?: string␊ - /**␊ - * Linked service reference type.␊ - */␊ - linkedServiceName: (LinkedServiceReference | string)␊ - /**␊ - * Definition of all parameters for an entity.␊ - */␊ - parameters?: ({␊ - [k: string]: ParameterSpecification␊ - } | string)␊ - /**␊ - * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.␊ - */␊ - structure?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - } & (AmazonS3Dataset | AzureBlobDataset | AzureTableDataset | AzureSqlTableDataset | AzureSqlDWTableDataset | CassandraTableDataset | DocumentDbCollectionDataset | DynamicsEntityDataset | AzureDataLakeStoreDataset | FileShareDataset | MongoDbCollectionDataset | ODataResourceDataset | OracleTableDataset | AzureMySqlTableDataset | RelationalTableDataset | SalesforceObjectDataset | SapCloudForCustomerResourceDataset | SapEccResourceDataset | SqlServerTableDataset | WebTableDataset | AzureSearchIndexDataset | HttpDataset | AmazonMWSObjectDataset | AzurePostgreSqlTableDataset | ConcurObjectDataset | CouchbaseTableDataset | DrillTableDataset | EloquaObjectDataset | GoogleBigQueryObjectDataset | GreenplumTableDataset | HBaseObjectDataset | HiveObjectDataset | HubspotObjectDataset | ImpalaObjectDataset | JiraObjectDataset | MagentoObjectDataset | MariaDBTableDataset | MarketoObjectDataset | PaypalObjectDataset | PhoenixObjectDataset | PrestoObjectDataset | QuickBooksObjectDataset | ServiceNowObjectDataset | ShopifyObjectDataset | SparkObjectDataset | SquareObjectDataset | XeroObjectDataset | ZohoObjectDataset | NetezzaTableDataset | VerticaTableDataset | SalesforceMarketingCloudObjectDataset | ResponsysObjectDataset))␊ - /**␊ - * The compression method used on a dataset.␊ - */␊ - export type DatasetCompression = ({␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - [k: string]: unknown␊ - } & (DatasetBZip2Compression | DatasetGZipCompression | DatasetDeflateCompression | DatasetZipDeflateCompression))␊ - /**␊ - * A pipeline activity.␊ - */␊ - export type Activity = ({␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Activity depends on condition.␊ - */␊ - dependsOn?: (ActivityDependency[] | string)␊ - /**␊ - * Activity description.␊ - */␊ - description?: string␊ - /**␊ - * Activity name.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - } & (ControlActivity | ExecutionActivity))␊ - /**␊ - * Base class for all control activities like IfCondition, ForEach , Until.␊ - */␊ - export type ControlActivity = ({␊ - type: "Container"␊ - [k: string]: unknown␊ - } & (ExecutePipelineActivity | IfConditionActivity | ForEachActivity | WaitActivity | UntilActivity | FilterActivity))␊ - /**␊ - * Base class for all execution activities.␊ - */␊ - export type ExecutionActivity = ({␊ - /**␊ - * Linked service reference type.␊ - */␊ - linkedServiceName?: (LinkedServiceReference | string)␊ - /**␊ - * Execution policy for an activity.␊ - */␊ - policy?: (ActivityPolicy | string)␊ - type: "Execution"␊ - [k: string]: unknown␊ - } & (CopyActivity | HDInsightHiveActivity | HDInsightPigActivity | HDInsightMapReduceActivity | HDInsightStreamingActivity | HDInsightSparkActivity | ExecuteSSISPackageActivity | CustomActivity | SqlServerStoredProcedureActivity | LookupActivity | WebActivity | GetMetadataActivity | AzureMLBatchExecutionActivity | AzureMLUpdateResourceActivity | DataLakeAnalyticsUSQLActivity | DatabricksNotebookActivity))␊ - /**␊ - * Azure data factory nested object which contains information about creating pipeline run␊ - */␊ - export type Trigger = ({␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Trigger description.␊ - */␊ - description?: string␊ - [k: string]: unknown␊ - } & MultiplePipelineTrigger)␊ - /**␊ - * Factory's git repo information.␊ - */␊ - export type FactoryRepoConfiguration = ({␊ - /**␊ - * Account name.␊ - */␊ - accountName: string␊ - /**␊ - * Collaboration branch.␊ - */␊ - collaborationBranch: string␊ - /**␊ - * Last commit id.␊ - */␊ - lastCommitId?: string␊ - /**␊ - * Repository name.␊ - */␊ - repositoryName: string␊ - /**␊ - * Root folder.␊ - */␊ - rootFolder: string␊ - [k: string]: unknown␊ - } & (FactoryVSTSConfiguration1 | FactoryGitHubConfiguration))␊ - /**␊ - * Azure Data Factory nested object which serves as a compute resource for activities.␊ - */␊ - export type IntegrationRuntime1 = ({␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Integration runtime description.␊ - */␊ - description?: string␊ - [k: string]: unknown␊ - } & (ManagedIntegrationRuntime1 | SelfHostedIntegrationRuntime1))␊ - /**␊ - * The base definition of the custom setup.␊ - */␊ - export type CustomSetupBase = ({␊ - [k: string]: unknown␊ - } & (CmdkeySetup | EnvironmentVariableSetup | ComponentSetup | AzPowerShellSetup))␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - export type SecretBase1 = ({␊ - [k: string]: unknown␊ - } & (SecureString1 | AzureKeyVaultSecretReference1))␊ - /**␊ - * The base definition of a linked integration runtime.␊ - */␊ - export type LinkedIntegrationRuntimeType = ({␊ - [k: string]: unknown␊ - } & (LinkedIntegrationRuntimeKeyAuthorization | LinkedIntegrationRuntimeRbacAuthorization))␊ - /**␊ - * The nested object which contains the information and credential which can be used to connect with related store or compute resource.␊ - */␊ - export type LinkedService1 = ({␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * List of tags that can be used for describing the linked service.␊ - */␊ - annotations?: ({␊ - [k: string]: unknown␊ - }[] | string)␊ - /**␊ - * Integration runtime reference type.␊ - */␊ - connectVia?: (IntegrationRuntimeReference1 | string)␊ - /**␊ - * Linked service description.␊ - */␊ - description?: string␊ - /**␊ - * Definition of all parameters for an entity.␊ - */␊ - parameters?: ({␊ - [k: string]: ParameterSpecification1␊ - } | string)␊ - [k: string]: unknown␊ - } & (AzureStorageLinkedService1 | AzureBlobStorageLinkedService | AzureTableStorageLinkedService | AzureSqlDWLinkedService1 | SqlServerLinkedService1 | AmazonRdsForSqlServerLinkedService | AzureSqlDatabaseLinkedService1 | AzureSqlMILinkedService | AzureBatchLinkedService1 | AzureKeyVaultLinkedService1 | CosmosDbLinkedService1 | DynamicsLinkedService1 | DynamicsCrmLinkedService | CommonDataServiceForAppsLinkedService | HDInsightLinkedService1 | FileServerLinkedService1 | AzureFileStorageLinkedService | AmazonS3CompatibleLinkedService | OracleCloudStorageLinkedService | GoogleCloudStorageLinkedService | OracleLinkedService1 | AmazonRdsForOracleLinkedService | AzureMySqlLinkedService1 | MySqlLinkedService1 | PostgreSqlLinkedService1 | SybaseLinkedService1 | Db2LinkedService1 | TeradataLinkedService1 | AzureMLLinkedService1 | AzureMLServiceLinkedService | OdbcLinkedService1 | InformixLinkedService | MicrosoftAccessLinkedService | HdfsLinkedService1 | ODataLinkedService1 | WebLinkedService1 | CassandraLinkedService1 | MongoDbLinkedService1 | MongoDbAtlasLinkedService | MongoDbV2LinkedService | CosmosDbMongoDbApiLinkedService | AzureDataLakeStoreLinkedService1 | AzureBlobFSLinkedService | Office365LinkedService | SalesforceLinkedService1 | SalesforceServiceCloudLinkedService | SapCloudForCustomerLinkedService1 | SapEccLinkedService1 | SapOpenHubLinkedService | SapOdpLinkedService | RestServiceLinkedService | TeamDeskLinkedService | QuickbaseLinkedService | SmartsheetLinkedService | ZendeskLinkedService | DataworldLinkedService | AppFiguresLinkedService | AsanaLinkedService | TwilioLinkedService | AmazonS3LinkedService1 | AmazonRedshiftLinkedService1 | CustomDataSourceLinkedService1 | AzureSearchLinkedService1 | HttpLinkedService1 | FtpServerLinkedService1 | SftpServerLinkedService1 | SapBWLinkedService1 | SapHanaLinkedService1 | AmazonMWSLinkedService1 | AzurePostgreSqlLinkedService1 | ConcurLinkedService1 | CouchbaseLinkedService1 | DrillLinkedService1 | EloquaLinkedService1 | GoogleBigQueryLinkedService1 | GreenplumLinkedService1 | HBaseLinkedService1 | HiveLinkedService1 | HubspotLinkedService1 | ImpalaLinkedService1 | JiraLinkedService1 | MagentoLinkedService1 | MariaDBLinkedService1 | AzureMariaDBLinkedService | MarketoLinkedService1 | PaypalLinkedService1 | PhoenixLinkedService1 | PrestoLinkedService1 | QuickBooksLinkedService1 | ServiceNowLinkedService1 | ShopifyLinkedService1 | SparkLinkedService1 | SquareLinkedService1 | XeroLinkedService1 | ZohoLinkedService1 | VerticaLinkedService1 | NetezzaLinkedService1 | SalesforceMarketingCloudLinkedService1 | HDInsightOnDemandLinkedService1 | AzureDataLakeAnalyticsLinkedService1 | AzureDatabricksLinkedService1 | AzureDatabricksDeltaLakeLinkedService | ResponsysLinkedService1 | DynamicsAXLinkedService | OracleServiceCloudLinkedService | GoogleAdWordsLinkedService | SapTableLinkedService | AzureDataExplorerLinkedService | AzureFunctionLinkedService | SnowflakeLinkedService | SharePointOnlineListLinkedService))␊ - /**␊ - * Base definition of WebLinkedServiceTypeProperties, this typeProperties is polymorphic based on authenticationType, so not flattened in SDK models.␊ - */␊ - export type WebLinkedServiceTypeProperties1 = ({␊ - /**␊ - * The URL of the web service endpoint, e.g. https://www.microsoft.com . Type: string (or Expression with resultType string).␊ - */␊ - url: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - } & (WebAnonymousAuthentication1 | WebBasicAuthentication1 | WebClientCertificateAuthentication1))␊ - /**␊ - * The Azure Data Factory nested object which identifies data within different data stores, such as tables, files, folders, and documents.␊ - */␊ - export type Dataset1 = ({␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * List of tags that can be used for describing the Dataset.␊ - */␊ - annotations?: ({␊ - [k: string]: unknown␊ - }[] | string)␊ - /**␊ - * Dataset description.␊ - */␊ - description?: string␊ - /**␊ - * The folder that this Dataset is in. If not specified, Dataset will appear at the root level.␊ - */␊ - folder?: (DatasetFolder | string)␊ - /**␊ - * Linked service reference type.␊ - */␊ - linkedServiceName: (LinkedServiceReference1 | string)␊ - /**␊ - * Definition of all parameters for an entity.␊ - */␊ - parameters?: ({␊ - [k: string]: ParameterSpecification1␊ - } | string)␊ - /**␊ - * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.␊ - */␊ - schema?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.␊ - */␊ - structure?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - } & (AmazonS3Dataset1 | AvroDataset | ExcelDataset | ParquetDataset | DelimitedTextDataset | JsonDataset | XmlDataset | OrcDataset | BinaryDataset | AzureBlobDataset1 | AzureTableDataset1 | AzureSqlTableDataset1 | AzureSqlMITableDataset | AzureSqlDWTableDataset1 | CassandraTableDataset1 | CustomDataset | CosmosDbSqlApiCollectionDataset | DocumentDbCollectionDataset1 | DynamicsEntityDataset1 | DynamicsCrmEntityDataset | CommonDataServiceForAppsEntityDataset | AzureDataLakeStoreDataset1 | AzureBlobFSDataset | Office365Dataset | FileShareDataset1 | MongoDbCollectionDataset1 | MongoDbAtlasCollectionDataset | MongoDbV2CollectionDataset | CosmosDbMongoDbApiCollectionDataset | ODataResourceDataset1 | OracleTableDataset1 | AmazonRdsForOracleTableDataset | TeradataTableDataset | AzureMySqlTableDataset1 | AmazonRedshiftTableDataset | Db2TableDataset | RelationalTableDataset1 | InformixTableDataset | OdbcTableDataset | MySqlTableDataset | PostgreSqlTableDataset | MicrosoftAccessTableDataset | SalesforceObjectDataset1 | SalesforceServiceCloudObjectDataset | SybaseTableDataset | SapBwCubeDataset | SapCloudForCustomerResourceDataset1 | SapEccResourceDataset1 | SapHanaTableDataset | SapOpenHubTableDataset | SqlServerTableDataset1 | AmazonRdsForSqlServerTableDataset | RestResourceDataset | SapTableResourceDataset | SapOdpResourceDataset | WebTableDataset1 | AzureSearchIndexDataset1 | HttpDataset1 | AmazonMWSObjectDataset1 | AzurePostgreSqlTableDataset1 | ConcurObjectDataset1 | CouchbaseTableDataset1 | DrillTableDataset1 | EloquaObjectDataset1 | GoogleBigQueryObjectDataset1 | GreenplumTableDataset1 | HBaseObjectDataset1 | HiveObjectDataset1 | HubspotObjectDataset1 | ImpalaObjectDataset1 | JiraObjectDataset1 | MagentoObjectDataset1 | MariaDBTableDataset1 | AzureMariaDBTableDataset | MarketoObjectDataset1 | PaypalObjectDataset1 | PhoenixObjectDataset1 | PrestoObjectDataset1 | QuickBooksObjectDataset1 | ServiceNowObjectDataset1 | ShopifyObjectDataset1 | SparkObjectDataset1 | SquareObjectDataset1 | XeroObjectDataset1 | ZohoObjectDataset1 | NetezzaTableDataset1 | VerticaTableDataset1 | SalesforceMarketingCloudObjectDataset1 | ResponsysObjectDataset1 | DynamicsAXResourceDataset | OracleServiceCloudObjectDataset | AzureDataExplorerTableDataset | GoogleAdWordsObjectDataset | SnowflakeDataset | SharePointOnlineListResourceDataset | AzureDatabricksDeltaLakeDataset))␊ - /**␊ - * The format definition of a storage.␊ - */␊ - export type DatasetStorageFormat1 = ({␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Deserializer. Type: string (or Expression with resultType string).␊ - */␊ - deserializer?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Serializer. Type: string (or Expression with resultType string).␊ - */␊ - serializer?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - } & (TextFormat | JsonFormat | AvroFormat | OrcFormat | ParquetFormat))␊ - /**␊ - * Dataset location.␊ - */␊ - export type DatasetLocation = ({␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Specify the file name of dataset. Type: string (or Expression with resultType string).␊ - */␊ - fileName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specify the folder path of dataset. Type: string (or Expression with resultType string)␊ - */␊ - folderPath?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - } & (AzureBlobStorageLocation | AzureBlobFSLocation | AzureDataLakeStoreLocation | AmazonS3Location | FileServerLocation | AzureFileStorageLocation | AmazonS3CompatibleLocation | OracleCloudStorageLocation | GoogleCloudStorageLocation | FtpServerLocation | SftpLocation | HttpServerLocation | HdfsLocation))␊ - /**␊ - * A pipeline activity.␊ - */␊ - export type Activity1 = ({␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Activity depends on condition.␊ - */␊ - dependsOn?: (ActivityDependency1[] | string)␊ - /**␊ - * Activity description.␊ - */␊ - description?: string␊ - /**␊ - * Activity name.␊ - */␊ - name: string␊ - /**␊ - * Activity user properties.␊ - */␊ - userProperties?: (UserProperty[] | string)␊ - [k: string]: unknown␊ - } & (ControlActivity1 | ExecutionActivity1 | ExecuteWranglingDataflowActivity))␊ - /**␊ - * Base class for all control activities like IfCondition, ForEach , Until.␊ - */␊ - export type ControlActivity1 = ({␊ - type: "Container"␊ - [k: string]: unknown␊ - } & (ExecutePipelineActivity1 | IfConditionActivity1 | SwitchActivity | ForEachActivity1 | WaitActivity1 | FailActivity | UntilActivity1 | ValidationActivity | FilterActivity1 | SetVariableActivity | AppendVariableActivity | WebHookActivity))␊ - /**␊ - * Base class for all execution activities.␊ - */␊ - export type ExecutionActivity1 = ({␊ - /**␊ - * Linked service reference type.␊ - */␊ - linkedServiceName?: (LinkedServiceReference1 | string)␊ - /**␊ - * Execution policy for an activity.␊ - */␊ - policy?: (ActivityPolicy1 | string)␊ - type: "Execution"␊ - [k: string]: unknown␊ - } & (CopyActivity1 | HDInsightHiveActivity1 | HDInsightPigActivity1 | HDInsightMapReduceActivity1 | HDInsightStreamingActivity1 | HDInsightSparkActivity1 | ExecuteSSISPackageActivity1 | CustomActivity1 | SqlServerStoredProcedureActivity1 | DeleteActivity | AzureDataExplorerCommandActivity | LookupActivity1 | WebActivity1 | GetMetadataActivity1 | AzureMLBatchExecutionActivity1 | AzureMLUpdateResourceActivity1 | AzureMLExecutePipelineActivity | DataLakeAnalyticsUSQLActivity1 | DatabricksNotebookActivity1 | DatabricksSparkJarActivity | DatabricksSparkPythonActivity | AzureFunctionActivity | ExecuteDataFlowActivity | ScriptActivity))␊ - /**␊ - * A copy activity sink.␊ - */␊ - export type CopySink1 = ({␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).␊ - */␊ - disableMetricsCollection?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).␊ - */␊ - maxConcurrentConnections?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Sink retry count. Type: integer (or Expression with resultType integer).␊ - */␊ - sinkRetryCount?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9])).␊ - */␊ - sinkRetryWait?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.␊ - */␊ - writeBatchSize?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9])).␊ - */␊ - writeBatchTimeout?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - } & (DelimitedTextSink | JsonSink | OrcSink | RestSink | AzurePostgreSqlSink | AzureMySqlSink | AzureDatabricksDeltaLakeSink | SapCloudForCustomerSink | AzureQueueSink | AzureTableSink | AvroSink | ParquetSink | BinarySink | BlobSink | FileSystemSink | DocumentDbCollectionSink | CosmosDbSqlApiSink | SqlSink | SqlServerSink | AzureSqlSink | SqlMISink | SqlDWSink | SnowflakeSink | OracleSink | AzureDataLakeStoreSink | AzureBlobFSSink | AzureSearchIndexSink | OdbcSink | InformixSink | MicrosoftAccessSink | DynamicsSink | DynamicsCrmSink | CommonDataServiceForAppsSink | AzureDataExplorerSink | SalesforceSink | SalesforceServiceCloudSink | MongoDbAtlasSink | MongoDbV2Sink | CosmosDbMongoDbApiSink))␊ - /**␊ - * Connector write settings.␊ - */␊ - export type StoreWriteSettings = ({␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * The type of copy behavior for copy sink.␊ - */␊ - copyBehavior?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).␊ - */␊ - disableMetricsCollection?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).␊ - */␊ - maxConcurrentConnections?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - } & (SftpWriteSettings | AzureBlobStorageWriteSettings | AzureBlobFSWriteSettings | AzureDataLakeStoreWriteSettings | FileServerWriteSettings | AzureFileStorageWriteSettings))␊ - /**␊ - * A copy activity source.␊ - */␊ - export type CopySource1 = ({␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).␊ - */␊ - disableMetricsCollection?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).␊ - */␊ - maxConcurrentConnections?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Source retry count. Type: integer (or Expression with resultType integer).␊ - */␊ - sourceRetryCount?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9])).␊ - */␊ - sourceRetryWait?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - } & (AvroSource | ExcelSource | ParquetSource | DelimitedTextSource | JsonSource | XmlSource | OrcSource | BinarySource | TabularSource | BlobSource | DocumentDbCollectionSource | CosmosDbSqlApiSource | DynamicsSource | DynamicsCrmSource | CommonDataServiceForAppsSource | RelationalSource | MicrosoftAccessSource | ODataSource | SalesforceServiceCloudSource | RestSource | FileSystemSource | HdfsSource | AzureDataExplorerSource | OracleSource | AmazonRdsForOracleSource | WebSource | MongoDbSource | MongoDbAtlasSource | MongoDbV2Source | CosmosDbMongoDbApiSource | Office365Source | AzureDataLakeStoreSource | AzureBlobFSSource | HttpSource | SnowflakeSource | AzureDatabricksDeltaLakeSource | SharePointOnlineListSource))␊ - /**␊ - * Connector read setting.␊ - */␊ - export type StoreReadSettings = ({␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).␊ - */␊ - disableMetricsCollection?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).␊ - */␊ - maxConcurrentConnections?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - } & (AzureBlobStorageReadSettings | AzureBlobFSReadSettings | AzureDataLakeStoreReadSettings | AmazonS3ReadSettings | FileServerReadSettings | AzureFileStorageReadSettings | AmazonS3CompatibleReadSettings | OracleCloudStorageReadSettings | GoogleCloudStorageReadSettings | FtpReadSettings | SftpReadSettings | HttpReadSettings | HdfsReadSettings))␊ - /**␊ - * Compression read settings.␊ - */␊ - export type CompressionReadSettings = ({␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - [k: string]: unknown␊ - } & (ZipDeflateReadSettings | TarReadSettings | TarGZipReadSettings))␊ - /**␊ - * Copy activity sources of tabular type.␊ - */␊ - export type TabularSource = ({␊ - /**␊ - * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).␊ - */␊ - additionalColumns?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9])).␊ - */␊ - queryTimeout?: {␊ - [k: string]: unknown␊ - }␊ - type: "TabularSource"␊ - [k: string]: unknown␊ - } & (AzureTableSource | InformixSource | Db2Source | OdbcSource | MySqlSource | PostgreSqlSource | SybaseSource | SapBwSource | SalesforceSource | SapCloudForCustomerSource | SapEccSource | SapHanaSource | SapOpenHubSource | SapOdpSource | SapTableSource | SqlSource | SqlServerSource | AmazonRdsForSqlServerSource | AzureSqlSource | SqlMISource | SqlDWSource | AzureMySqlSource | TeradataSource | CassandraSource | AmazonMWSSource | AzurePostgreSqlSource | ConcurSource | CouchbaseSource | DrillSource | EloquaSource | GoogleBigQuerySource | GreenplumSource | HBaseSource | HiveSource | HubspotSource | ImpalaSource | JiraSource | MagentoSource | MariaDBSource | AzureMariaDBSource | MarketoSource | PaypalSource | PhoenixSource | PrestoSource | QuickBooksSource | ServiceNowSource | ShopifySource | SparkSource | SquareSource | XeroSource | ZohoSource | NetezzaSource | VerticaSource | SalesforceMarketingCloudSource | ResponsysSource | DynamicsAXSource | OracleServiceCloudSource | GoogleAdWordsSource | AmazonRedshiftSource))␊ - /**␊ - * Format read settings.␊ - */␊ - export type FormatReadSettings = ({␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - [k: string]: unknown␊ - } & (DelimitedTextReadSettings | JsonReadSettings | XmlReadSettings | BinaryReadSettings))␊ - /**␊ - * Azure data factory nested object which contains information about creating pipeline run␊ - */␊ - export type Trigger1 = ({␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * List of tags that can be used for describing the trigger.␊ - */␊ - annotations?: ({␊ - [k: string]: unknown␊ - }[] | string)␊ - /**␊ - * Trigger description.␊ - */␊ - description?: string␊ - [k: string]: unknown␊ - } & (MultiplePipelineTrigger1 | TumblingWindowTrigger | RerunTumblingWindowTrigger | ChainingTrigger))␊ - /**␊ - * Base class for all triggers that support one to many model for trigger to pipeline.␊ - */␊ - export type MultiplePipelineTrigger1 = ({␊ - /**␊ - * Pipelines that need to be started.␊ - */␊ - pipelines?: (TriggerPipelineReference1[] | string)␊ - type: "MultiplePipelineTrigger"␊ - [k: string]: unknown␊ - } & (ScheduleTrigger | BlobTrigger | BlobEventsTrigger | CustomEventsTrigger))␊ - /**␊ - * Referenced dependency.␊ - */␊ - export type DependencyReference = ({␊ - [k: string]: unknown␊ - } & (TriggerDependencyReference | SelfDependencyTumblingWindowTriggerReference))␊ - /**␊ - * Trigger referenced dependency.␊ - */␊ - export type TriggerDependencyReference = ({␊ - /**␊ - * Trigger reference type.␊ - */␊ - referenceTrigger: (TriggerReference | string)␊ - type: "TriggerDependencyReference"␊ - [k: string]: unknown␊ - } & TumblingWindowTriggerDependencyReference)␊ - /**␊ - * Azure Data Factory nested object which contains a flow with data movements and transformations.␊ - */␊ - export type DataFlow = ({␊ - /**␊ - * List of tags that can be used for describing the data flow.␊ - */␊ - annotations?: ({␊ - [k: string]: unknown␊ - }[] | string)␊ - /**␊ - * The description of the data flow.␊ - */␊ - description?: string␊ - /**␊ - * The folder that this data flow is in. If not specified, Data flow will appear at the root level.␊ - */␊ - folder?: (DataFlowFolder | string)␊ - [k: string]: unknown␊ - } & (MappingDataFlow | Flowlet | WranglingDataFlow))␊ - /**␊ - * Information about the destination for an event subscription␊ - */␊ - export type EventSubscriptionDestination1 = ({␊ - [k: string]: unknown␊ - } & (WebHookEventSubscriptionDestination | EventHubEventSubscriptionDestination))␊ - /**␊ - * Information about the destination for an event subscription␊ - */␊ - export type EventSubscriptionDestination2 = ({␊ - [k: string]: unknown␊ - } & (WebHookEventSubscriptionDestination1 | EventHubEventSubscriptionDestination1))␊ - /**␊ - * By default, Event Grid expects events to be in the Event Grid event schema. Specifying an input schema mapping enables publishing to Event Grid using a custom input schema. Currently, the only supported type of InputSchemaMapping is 'JsonInputSchemaMapping'.␊ - */␊ - export type InputSchemaMapping = ({␊ - [k: string]: unknown␊ - } & JsonInputSchemaMapping)␊ - /**␊ - * Information about the dead letter destination for an event subscription. To configure a deadletter destination, do not directly instantiate an object of this class. Instead, instantiate an object of a derived class. Currently, StorageBlobDeadLetterDestination is the only class that derives from this class.␊ - */␊ - export type DeadLetterDestination = ({␊ - [k: string]: unknown␊ - } & StorageBlobDeadLetterDestination)␊ - /**␊ - * Information about the destination for an event subscription␊ - */␊ - export type EventSubscriptionDestination3 = ({␊ - [k: string]: unknown␊ - } & (WebHookEventSubscriptionDestination2 | EventHubEventSubscriptionDestination2 | StorageQueueEventSubscriptionDestination | HybridConnectionEventSubscriptionDestination))␊ - /**␊ - * By default, Event Grid expects events to be in the Event Grid event schema. Specifying an input schema mapping enables publishing to Event Grid using a custom input schema. Currently, the only supported type of InputSchemaMapping is 'JsonInputSchemaMapping'.␊ - */␊ - export type InputSchemaMapping1 = ({␊ - [k: string]: unknown␊ - } & JsonInputSchemaMapping1)␊ - /**␊ - * Information about the dead letter destination for an event subscription. To configure a deadletter destination, do not directly instantiate an object of this class. Instead, instantiate an object of a derived class. Currently, StorageBlobDeadLetterDestination is the only class that derives from this class.␊ - */␊ - export type DeadLetterDestination1 = ({␊ - [k: string]: unknown␊ - } & StorageBlobDeadLetterDestination1)␊ - /**␊ - * Information about the destination for an event subscription␊ - */␊ - export type EventSubscriptionDestination4 = ({␊ - [k: string]: unknown␊ - } & (WebHookEventSubscriptionDestination3 | EventHubEventSubscriptionDestination3 | StorageQueueEventSubscriptionDestination1 | HybridConnectionEventSubscriptionDestination1))␊ - /**␊ - * Represents an advanced filter that can be used to filter events based on various event envelope/data fields.␊ - */␊ - export type AdvancedFilter = ({␊ - /**␊ - * The filter key. Represents an event property with up to two levels of nesting.␊ - */␊ - key?: string␊ - [k: string]: unknown␊ - } & (NumberInAdvancedFilter | NumberNotInAdvancedFilter | NumberLessThanAdvancedFilter | NumberGreaterThanAdvancedFilter | NumberLessThanOrEqualsAdvancedFilter | NumberGreaterThanOrEqualsAdvancedFilter | BoolEqualsAdvancedFilter | StringInAdvancedFilter | StringNotInAdvancedFilter | StringBeginsWithAdvancedFilter | StringEndsWithAdvancedFilter | StringContainsAdvancedFilter))␊ - /**␊ - * Information about the dead letter destination for an event subscription. To configure a deadletter destination, do not directly instantiate an object of this class. Instead, instantiate an object of a derived class. Currently, StorageBlobDeadLetterDestination is the only class that derives from this class.␊ - */␊ - export type DeadLetterDestination2 = ({␊ - [k: string]: unknown␊ - } & StorageBlobDeadLetterDestination2)␊ - /**␊ - * Information about the destination for an event subscription␊ - */␊ - export type EventSubscriptionDestination5 = ({␊ - [k: string]: unknown␊ - } & (WebHookEventSubscriptionDestination4 | EventHubEventSubscriptionDestination4 | StorageQueueEventSubscriptionDestination2 | HybridConnectionEventSubscriptionDestination2))␊ - /**␊ - * By default, Event Grid expects events to be in the Event Grid event schema. Specifying an input schema mapping enables publishing to Event Grid using a custom input schema. Currently, the only supported type of InputSchemaMapping is 'JsonInputSchemaMapping'.␊ - */␊ - export type InputSchemaMapping2 = ({␊ - [k: string]: unknown␊ - } & JsonInputSchemaMapping2)␊ - /**␊ - * Information about the dead letter destination for an event subscription. To configure a deadletter destination, do not directly instantiate an object of this class. Instead, instantiate an object of a derived class. Currently, StorageBlobDeadLetterDestination is the only class that derives from this class.␊ - */␊ - export type DeadLetterDestination3 = ({␊ - [k: string]: unknown␊ - } & StorageBlobDeadLetterDestination3)␊ - /**␊ - * Information about the destination for an event subscription␊ - */␊ - export type EventSubscriptionDestination6 = ({␊ - [k: string]: unknown␊ - } & (WebHookEventSubscriptionDestination5 | EventHubEventSubscriptionDestination5 | StorageQueueEventSubscriptionDestination3 | HybridConnectionEventSubscriptionDestination3 | ServiceBusQueueEventSubscriptionDestination))␊ - /**␊ - * This is the base type that represents an advanced filter. To configure an advanced filter, do not directly instantiate an object of this class. Instead, instantiate an object of a derived class such as BoolEqualsAdvancedFilter, NumberInAdvancedFilter, StringEqualsAdvancedFilter etc. depending on the type of the key based on which you want to filter.␊ - */␊ - export type AdvancedFilter1 = ({␊ - /**␊ - * The field/property in the event based on which you want to filter.␊ - */␊ - key?: string␊ - [k: string]: unknown␊ - } & (NumberInAdvancedFilter1 | NumberNotInAdvancedFilter1 | NumberLessThanAdvancedFilter1 | NumberGreaterThanAdvancedFilter1 | NumberLessThanOrEqualsAdvancedFilter1 | NumberGreaterThanOrEqualsAdvancedFilter1 | BoolEqualsAdvancedFilter1 | StringInAdvancedFilter1 | StringNotInAdvancedFilter1 | StringBeginsWithAdvancedFilter1 | StringEndsWithAdvancedFilter1 | StringContainsAdvancedFilter1))␊ - /**␊ - * Information about the dead letter destination for an event subscription. To configure a deadletter destination, do not directly instantiate an object of this class. Instead, instantiate an object of a derived class. Currently, StorageBlobDeadLetterDestination is the only class that derives from this class.␊ - */␊ - export type DeadLetterDestination4 = ({␊ - [k: string]: unknown␊ - } & StorageBlobDeadLetterDestination4)␊ - /**␊ - * Information about the destination for an event subscription␊ - */␊ - export type EventSubscriptionDestination7 = ({␊ - [k: string]: unknown␊ - } & (WebHookEventSubscriptionDestination6 | EventHubEventSubscriptionDestination6 | StorageQueueEventSubscriptionDestination4 | HybridConnectionEventSubscriptionDestination4 | ServiceBusQueueEventSubscriptionDestination1))␊ - /**␊ - * This is the base type that represents an advanced filter. To configure an advanced filter, do not directly instantiate an object of this class. Instead, instantiate an object of a derived class such as BoolEqualsAdvancedFilter, NumberInAdvancedFilter, StringEqualsAdvancedFilter etc. depending on the type of the key based on which you want to filter.␊ - */␊ - export type AdvancedFilter2 = ({␊ - /**␊ - * The field/property in the event based on which you want to filter.␊ - */␊ - key?: string␊ - [k: string]: unknown␊ - } & (NumberInAdvancedFilter2 | NumberNotInAdvancedFilter2 | NumberLessThanAdvancedFilter2 | NumberGreaterThanAdvancedFilter2 | NumberLessThanOrEqualsAdvancedFilter2 | NumberGreaterThanOrEqualsAdvancedFilter2 | BoolEqualsAdvancedFilter2 | StringInAdvancedFilter2 | StringNotInAdvancedFilter2 | StringBeginsWithAdvancedFilter2 | StringEndsWithAdvancedFilter2 | StringContainsAdvancedFilter2))␊ - /**␊ - * Azure Synapse nested object which serves as a compute resource for activities.␊ - */␊ - export type IntegrationRuntime2 = ({␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Integration runtime description.␊ - */␊ - description?: string␊ - [k: string]: unknown␊ - } & (ManagedIntegrationRuntime2 | SelfHostedIntegrationRuntime2))␊ - /**␊ - * The base definition of the custom setup.␊ - */␊ - export type CustomSetupBase1 = ({␊ - [k: string]: unknown␊ - } & (CmdkeySetup1 | EnvironmentVariableSetup1 | ComponentSetup1))␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - export type SecretBase2 = ({␊ - [k: string]: unknown␊ - } & SecureString2)␊ - /**␊ - * The base definition of a linked integration runtime.␊ - */␊ - export type LinkedIntegrationRuntimeType1 = ({␊ - [k: string]: unknown␊ - } & (LinkedIntegrationRuntimeKeyAuthorization1 | LinkedIntegrationRuntimeRbacAuthorization1))␊ - /**␊ - * The action that is performed when the alert rule becomes active, and when an alert condition is resolved.␊ - */␊ - export type RuleAction = ({␊ - [k: string]: unknown␊ - } & (RuleEmailAction | RuleWebhookAction))␊ - /**␊ - * The condition that results in the alert rule being activated.␊ - */␊ - export type RuleCondition = ({␊ - /**␊ - * The resource from which the rule collects its data.␊ - */␊ - dataSource?: (RuleDataSource | string)␊ - [k: string]: unknown␊ - } & (ThresholdRuleCondition | LocationThresholdRuleCondition | ManagementEventRuleCondition))␊ - /**␊ - * The resource from which the rule collects its data.␊ - */␊ - export type RuleDataSource = ({␊ - /**␊ - * the legacy resource identifier of the resource the rule monitors. **NOTE**: this property cannot be updated for an existing rule.␊ - */␊ - legacyResourceId?: string␊ - /**␊ - * the namespace of the metric.␊ - */␊ - metricNamespace?: string␊ - /**␊ - * the location of the resource.␊ - */␊ - resourceLocation?: string␊ - /**␊ - * the resource identifier of the resource the rule monitors. **NOTE**: this property cannot be updated for an existing rule.␊ - */␊ - resourceUri?: string␊ - [k: string]: unknown␊ - } & (RuleMetricDataSource | RuleManagementEventDataSource))␊ - /**␊ - * The action that is performed when the alert rule becomes active, and when an alert condition is resolved.␊ - */␊ - export type RuleAction1 = ({␊ - [k: string]: unknown␊ - } & (RuleEmailAction1 | RuleWebhookAction1))␊ - /**␊ - * The condition that results in the alert rule being activated.␊ - */␊ - export type RuleCondition1 = ({␊ - /**␊ - * The resource from which the rule collects its data.␊ - */␊ - dataSource?: (RuleDataSource1 | string)␊ - [k: string]: unknown␊ - } & (ThresholdRuleCondition1 | LocationThresholdRuleCondition1 | ManagementEventRuleCondition1))␊ - /**␊ - * The resource from which the rule collects its data.␊ - */␊ - export type RuleDataSource1 = ({␊ - /**␊ - * the legacy resource identifier of the resource the rule monitors. **NOTE**: this property cannot be updated for an existing rule.␊ - */␊ - legacyResourceId?: string␊ - /**␊ - * the namespace of the metric.␊ - */␊ - metricNamespace?: string␊ - /**␊ - * the location of the resource.␊ - */␊ - resourceLocation?: string␊ - /**␊ - * the resource identifier of the resource the rule monitors. **NOTE**: this property cannot be updated for an existing rule.␊ - */␊ - resourceUri?: string␊ - [k: string]: unknown␊ - } & (RuleMetricDataSource1 | RuleManagementEventDataSource1))␊ - /**␊ - * The rule criteria that defines the conditions of the alert rule.␊ - */␊ - export type MetricAlertCriteria = ({␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - [k: string]: unknown␊ - } & (MetricAlertSingleResourceMultipleMetricCriteria | WebtestLocationAvailabilityCriteria | MetricAlertMultipleResourceMultipleMetricCriteria))␊ - /**␊ - * The types of conditions for a multi resource alert.␊ - */␊ - export type MultiMetricCriteria = ({␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * List of dimension conditions.␊ - */␊ - dimensions?: (MetricDimension[] | string)␊ - /**␊ - * Name of the metric.␊ - */␊ - metricName: string␊ - /**␊ - * Namespace of the metric.␊ - */␊ - metricNamespace?: string␊ - /**␊ - * Name of the criteria.␊ - */␊ - name: string␊ - /**␊ - * Allows creating an alert rule on a custom metric that isn't yet emitted, by causing the metric validation to be skipped.␊ - */␊ - skipMetricValidation?: (boolean | string)␊ - /**␊ - * the criteria time aggregation types.␊ - */␊ - timeAggregation: (("Average" | "Count" | "Minimum" | "Maximum" | "Total") | string)␊ - [k: string]: unknown␊ - } & (MetricCriteria | DynamicMetricCriteria))␊ - /**␊ - * Action descriptor.␊ - */␊ - export type Action2 = ({␊ - [k: string]: unknown␊ - } & (AlertingAction | LogToMetricAction))␊ - /**␊ - * Microsoft.Web/sites/config␊ - */␊ - export type SitesConfigChildResource = ({␊ - apiVersion: "2015-08-01"␊ - type: "config"␊ - [k: string]: unknown␊ - } & ({␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - name: "slotConfigNames"␊ - properties: (SlotConfigNamesResourceProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Resource type␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - name: "web"␊ - properties: (SiteConfigProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Resource type␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - name: "appsettings"␊ - /**␊ - * Settings␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Resource type␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - name: "connectionstrings"␊ - /**␊ - * Connection strings␊ - */␊ - properties: ({␊ - [k: string]: ConnStringValueTypePair␊ - } | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Resource type␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - } | {␊ - aadClientId?: string␊ - /**␊ - * Gets or sets a list of login parameters to send to the OpenID Connect authorization endpoint when␍␊ - * a user logs in. Each parameter must be in the form "key=value".␊ - */␊ - additionalLoginParams?: (string[] | string)␊ - /**␊ - * Gets or sets a list of allowed audience values to consider when validating JWTs issued by ␍␊ - * Azure Active Directory. Note that the {Microsoft.Web.Hosting.Administration.SiteAuthSettings.ClientId} value is always considered an␍␊ - * allowed audience, regardless of this setting.␊ - */␊ - allowedAudiences?: (string[] | string)␊ - /**␊ - * Gets or sets a collection of external URLs that can be redirected to as part of logging in␍␊ - * or logging out of the web 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.␊ - */␊ - allowedExternalRedirectUrls?: (string[] | string)␊ - /**␊ - * Gets or sets 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␊ - */␊ - clientId?: string␊ - /**␊ - * Gets or sets 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␊ - */␊ - clientSecret?: string␊ - /**␊ - * Gets or sets 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".␊ - */␊ - defaultProvider?: (("AzureActiveDirectory" | "Facebook" | "Google" | "MicrosoftAccount" | "Twitter") | string)␊ - /**␊ - * Gets or sets a value indicating whether the Authentication / Authorization feature is enabled for the current app.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Gets or sets 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␊ - */␊ - facebookAppId?: string␊ - /**␊ - * Gets or sets 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␊ - */␊ - facebookAppSecret?: string␊ - /**␊ - * Gets or sets 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␊ - */␊ - facebookOAuthScopes?: (string[] | string)␊ - /**␊ - * Gets or sets 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/␊ - */␊ - googleClientId?: string␊ - /**␊ - * Gets or sets 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/␊ - */␊ - googleClientSecret?: string␊ - /**␊ - * Gets or sets 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/␊ - */␊ - googleOAuthScopes?: (string[] | string)␊ - /**␊ - * Gets or sets the relative path prefix used by platform HTTP APIs.␍␊ - * Changing this value is not recommended except for compatibility reasons.␊ - */␊ - httpApiPrefixPath?: string␊ - /**␊ - * Gets or sets 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␊ - */␊ - issuer?: string␊ - /**␊ - * Gets or sets 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␊ - */␊ - microsoftAccountClientId?: string␊ - /**␊ - * Gets or sets 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␊ - */␊ - microsoftAccountClientSecret?: string␊ - /**␊ - * Gets or sets 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␊ - */␊ - microsoftAccountOAuthScopes?: (string[] | string)␊ - name: "authsettings"␊ - openIdIssuer?: string␊ - /**␊ - * Gets or sets 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.␊ - */␊ - tokenRefreshExtensionHours?: (number | string)␊ - /**␊ - * Gets or sets a value indicating whether to durably store platform-specific security tokens␍␊ - * obtained during login flows. This capability is disabled by default.␊ - */␊ - tokenStoreEnabled?: (boolean | string)␊ - /**␊ - * Gets or sets 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␊ - */␊ - twitterConsumerKey?: string␊ - /**␊ - * Gets or sets 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␊ - */␊ - twitterConsumerSecret?: string␊ - /**␊ - * Gets or sets the action to take when an unauthenticated client attempts to access the app.␊ - */␊ - unauthenticatedClientAction?: (("RedirectToLoginPage" | "AllowAnonymous") | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - name: "metadata"␊ - /**␊ - * Settings␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Resource type␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - name: "logs"␊ - properties: (SiteLogsConfigProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Resource type␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - name: "backup"␊ - properties: (BackupRequestProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Resource type␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * Microsoft.Web/sites/config␊ - */␊ - export type SitesConfig = ({␊ - apiVersion: "2015-08-01"␊ - type: "Microsoft.Web/sites/config"␊ - [k: string]: unknown␊ - } & ({␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - name: string␊ - properties: (SlotConfigNamesResourceProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Resource type␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - name: string␊ - properties: (SiteConfigProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Resource type␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - name: string␊ - /**␊ - * Settings␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Resource type␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - name: string␊ - /**␊ - * Connection strings␊ - */␊ - properties: ({␊ - [k: string]: ConnStringValueTypePair␊ - } | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Resource type␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - } | {␊ - aadClientId?: string␊ - /**␊ - * Gets or sets a list of login parameters to send to the OpenID Connect authorization endpoint when␍␊ - * a user logs in. Each parameter must be in the form "key=value".␊ - */␊ - additionalLoginParams?: (string[] | string)␊ - /**␊ - * Gets or sets a list of allowed audience values to consider when validating JWTs issued by ␍␊ - * Azure Active Directory. Note that the {Microsoft.Web.Hosting.Administration.SiteAuthSettings.ClientId} value is always considered an␍␊ - * allowed audience, regardless of this setting.␊ - */␊ - allowedAudiences?: (string[] | string)␊ - /**␊ - * Gets or sets a collection of external URLs that can be redirected to as part of logging in␍␊ - * or logging out of the web 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.␊ - */␊ - allowedExternalRedirectUrls?: (string[] | string)␊ - /**␊ - * Gets or sets 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␊ - */␊ - clientId?: string␊ - /**␊ - * Gets or sets 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␊ - */␊ - clientSecret?: string␊ - /**␊ - * Gets or sets 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".␊ - */␊ - defaultProvider?: (("AzureActiveDirectory" | "Facebook" | "Google" | "MicrosoftAccount" | "Twitter") | string)␊ - /**␊ - * Gets or sets a value indicating whether the Authentication / Authorization feature is enabled for the current app.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Gets or sets 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␊ - */␊ - facebookAppId?: string␊ - /**␊ - * Gets or sets 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␊ - */␊ - facebookAppSecret?: string␊ - /**␊ - * Gets or sets 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␊ - */␊ - facebookOAuthScopes?: (string[] | string)␊ - /**␊ - * Gets or sets 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/␊ - */␊ - googleClientId?: string␊ - /**␊ - * Gets or sets 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/␊ - */␊ - googleClientSecret?: string␊ - /**␊ - * Gets or sets 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/␊ - */␊ - googleOAuthScopes?: (string[] | string)␊ - /**␊ - * Gets or sets the relative path prefix used by platform HTTP APIs.␍␊ - * Changing this value is not recommended except for compatibility reasons.␊ - */␊ - httpApiPrefixPath?: string␊ - /**␊ - * Gets or sets 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␊ - */␊ - issuer?: string␊ - /**␊ - * Gets or sets 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␊ - */␊ - microsoftAccountClientId?: string␊ - /**␊ - * Gets or sets 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␊ - */␊ - microsoftAccountClientSecret?: string␊ - /**␊ - * Gets or sets 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␊ - */␊ - microsoftAccountOAuthScopes?: (string[] | string)␊ - name: string␊ - openIdIssuer?: string␊ - /**␊ - * Gets or sets 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.␊ - */␊ - tokenRefreshExtensionHours?: (number | string)␊ - /**␊ - * Gets or sets a value indicating whether to durably store platform-specific security tokens␍␊ - * obtained during login flows. This capability is disabled by default.␊ - */␊ - tokenStoreEnabled?: (boolean | string)␊ - /**␊ - * Gets or sets 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␊ - */␊ - twitterConsumerKey?: string␊ - /**␊ - * Gets or sets 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␊ - */␊ - twitterConsumerSecret?: string␊ - /**␊ - * Gets or sets the action to take when an unauthenticated client attempts to access the app.␊ - */␊ - unauthenticatedClientAction?: (("RedirectToLoginPage" | "AllowAnonymous") | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - name: string␊ - properties: (SiteLogsConfigProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Resource type␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - name: string␊ - properties: (BackupRequestProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Resource type␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * Microsoft.Web/sites/slots/config␊ - */␊ - export type SitesSlotsConfigChildResource = ({␊ - apiVersion: "2015-08-01"␊ - type: "config"␊ - [k: string]: unknown␊ - } & ({␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - name: "web"␊ - properties: (SiteConfigProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Resource type␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - name: "appsettings"␊ - /**␊ - * Settings␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Resource type␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - name: "connectionstrings"␊ - /**␊ - * Connection strings␊ - */␊ - properties: ({␊ - [k: string]: ConnStringValueTypePair␊ - } | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Resource type␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - } | {␊ - aadClientId?: string␊ - /**␊ - * Gets or sets a list of login parameters to send to the OpenID Connect authorization endpoint when␍␊ - * a user logs in. Each parameter must be in the form "key=value".␊ - */␊ - additionalLoginParams?: (string[] | string)␊ - /**␊ - * Gets or sets a list of allowed audience values to consider when validating JWTs issued by ␍␊ - * Azure Active Directory. Note that the {Microsoft.Web.Hosting.Administration.SiteAuthSettings.ClientId} value is always considered an␍␊ - * allowed audience, regardless of this setting.␊ - */␊ - allowedAudiences?: (string[] | string)␊ - /**␊ - * Gets or sets a collection of external URLs that can be redirected to as part of logging in␍␊ - * or logging out of the web 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.␊ - */␊ - allowedExternalRedirectUrls?: (string[] | string)␊ - /**␊ - * Gets or sets 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␊ - */␊ - clientId?: string␊ - /**␊ - * Gets or sets 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␊ - */␊ - clientSecret?: string␊ - /**␊ - * Gets or sets 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".␊ - */␊ - defaultProvider?: (("AzureActiveDirectory" | "Facebook" | "Google" | "MicrosoftAccount" | "Twitter") | string)␊ - /**␊ - * Gets or sets a value indicating whether the Authentication / Authorization feature is enabled for the current app.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Gets or sets 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␊ - */␊ - facebookAppId?: string␊ - /**␊ - * Gets or sets 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␊ - */␊ - facebookAppSecret?: string␊ - /**␊ - * Gets or sets 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␊ - */␊ - facebookOAuthScopes?: (string[] | string)␊ - /**␊ - * Gets or sets 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/␊ - */␊ - googleClientId?: string␊ - /**␊ - * Gets or sets 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/␊ - */␊ - googleClientSecret?: string␊ - /**␊ - * Gets or sets 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/␊ - */␊ - googleOAuthScopes?: (string[] | string)␊ - /**␊ - * Gets or sets the relative path prefix used by platform HTTP APIs.␍␊ - * Changing this value is not recommended except for compatibility reasons.␊ - */␊ - httpApiPrefixPath?: string␊ - /**␊ - * Gets or sets 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␊ - */␊ - issuer?: string␊ - /**␊ - * Gets or sets 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␊ - */␊ - microsoftAccountClientId?: string␊ - /**␊ - * Gets or sets 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␊ - */␊ - microsoftAccountClientSecret?: string␊ - /**␊ - * Gets or sets 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␊ - */␊ - microsoftAccountOAuthScopes?: (string[] | string)␊ - name: "authsettings"␊ - openIdIssuer?: string␊ - /**␊ - * Gets or sets 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.␊ - */␊ - tokenRefreshExtensionHours?: (number | string)␊ - /**␊ - * Gets or sets a value indicating whether to durably store platform-specific security tokens␍␊ - * obtained during login flows. This capability is disabled by default.␊ - */␊ - tokenStoreEnabled?: (boolean | string)␊ - /**␊ - * Gets or sets 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␊ - */␊ - twitterConsumerKey?: string␊ - /**␊ - * Gets or sets 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␊ - */␊ - twitterConsumerSecret?: string␊ - /**␊ - * Gets or sets the action to take when an unauthenticated client attempts to access the app.␊ - */␊ - unauthenticatedClientAction?: (("RedirectToLoginPage" | "AllowAnonymous") | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - name: "metadata"␊ - /**␊ - * Settings␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Resource type␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - name: "logs"␊ - properties: (SiteLogsConfigProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Resource type␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - name: "backup"␊ - properties: (BackupRequestProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Resource type␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * Microsoft.Web/sites/slots/config␊ - */␊ - export type SitesSlotsConfig = ({␊ - apiVersion: "2015-08-01"␊ - type: "Microsoft.Web/sites/slots/config"␊ - [k: string]: unknown␊ - } & ({␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - name: string␊ - properties: (SiteConfigProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Resource type␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - name: string␊ - /**␊ - * Settings␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Resource type␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - name: string␊ - /**␊ - * Connection strings␊ - */␊ - properties: ({␊ - [k: string]: ConnStringValueTypePair␊ - } | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Resource type␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - } | {␊ - aadClientId?: string␊ - /**␊ - * Gets or sets a list of login parameters to send to the OpenID Connect authorization endpoint when␍␊ - * a user logs in. Each parameter must be in the form "key=value".␊ - */␊ - additionalLoginParams?: (string[] | string)␊ - /**␊ - * Gets or sets a list of allowed audience values to consider when validating JWTs issued by ␍␊ - * Azure Active Directory. Note that the {Microsoft.Web.Hosting.Administration.SiteAuthSettings.ClientId} value is always considered an␍␊ - * allowed audience, regardless of this setting.␊ - */␊ - allowedAudiences?: (string[] | string)␊ - /**␊ - * Gets or sets a collection of external URLs that can be redirected to as part of logging in␍␊ - * or logging out of the web 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.␊ - */␊ - allowedExternalRedirectUrls?: (string[] | string)␊ - /**␊ - * Gets or sets 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␊ - */␊ - clientId?: string␊ - /**␊ - * Gets or sets 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␊ - */␊ - clientSecret?: string␊ - /**␊ - * Gets or sets 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".␊ - */␊ - defaultProvider?: (("AzureActiveDirectory" | "Facebook" | "Google" | "MicrosoftAccount" | "Twitter") | string)␊ - /**␊ - * Gets or sets a value indicating whether the Authentication / Authorization feature is enabled for the current app.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Gets or sets 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␊ - */␊ - facebookAppId?: string␊ - /**␊ - * Gets or sets 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␊ - */␊ - facebookAppSecret?: string␊ - /**␊ - * Gets or sets 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␊ - */␊ - facebookOAuthScopes?: (string[] | string)␊ - /**␊ - * Gets or sets 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/␊ - */␊ - googleClientId?: string␊ - /**␊ - * Gets or sets 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/␊ - */␊ - googleClientSecret?: string␊ - /**␊ - * Gets or sets 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/␊ - */␊ - googleOAuthScopes?: (string[] | string)␊ - /**␊ - * Gets or sets the relative path prefix used by platform HTTP APIs.␍␊ - * Changing this value is not recommended except for compatibility reasons.␊ - */␊ - httpApiPrefixPath?: string␊ - /**␊ - * Gets or sets 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␊ - */␊ - issuer?: string␊ - /**␊ - * Gets or sets 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␊ - */␊ - microsoftAccountClientId?: string␊ - /**␊ - * Gets or sets 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␊ - */␊ - microsoftAccountClientSecret?: string␊ - /**␊ - * Gets or sets 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␊ - */␊ - microsoftAccountOAuthScopes?: (string[] | string)␊ - name: string␊ - openIdIssuer?: string␊ - /**␊ - * Gets or sets 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.␊ - */␊ - tokenRefreshExtensionHours?: (number | string)␊ - /**␊ - * Gets or sets a value indicating whether to durably store platform-specific security tokens␍␊ - * obtained during login flows. This capability is disabled by default.␊ - */␊ - tokenStoreEnabled?: (boolean | string)␊ - /**␊ - * Gets or sets 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␊ - */␊ - twitterConsumerKey?: string␊ - /**␊ - * Gets or sets 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␊ - */␊ - twitterConsumerSecret?: string␊ - /**␊ - * Gets or sets the action to take when an unauthenticated client attempts to access the app.␊ - */␊ - unauthenticatedClientAction?: (("RedirectToLoginPage" | "AllowAnonymous") | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - name: string␊ - properties: (SiteLogsConfigProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Resource type␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - name: string␊ - properties: (BackupRequestProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Resource type␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * Microsoft.Web/sites/config␊ - */␊ - export type SitesConfigChildResource1 = ({␊ - apiVersion: "2016-08-01"␊ - type: "config"␊ - [k: string]: unknown␊ - } & ({␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "appsettings"␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "authsettings"␊ - /**␊ - * SiteAuthSettings resource specific properties␊ - */␊ - properties: (SiteAuthSettingsProperties | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "backup"␊ - /**␊ - * BackupRequest resource specific properties␊ - */␊ - properties: (BackupRequestProperties1 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "connectionstrings"␊ - /**␊ - * Connection strings.␊ - */␊ - properties: ({␊ - [k: string]: ConnStringValueTypePair1␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "logs"␊ - /**␊ - * SiteLogsConfig resource specific properties␊ - */␊ - properties: (SiteLogsConfigProperties1 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "metadata"␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "pushsettings"␊ - /**␊ - * PushSettings resource specific properties␊ - */␊ - properties: (PushSettingsProperties | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "slotConfigNames"␊ - /**␊ - * 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.␊ - */␊ - properties: (SlotConfigNames | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "web"␊ - /**␊ - * Configuration of an App Service app.␊ - */␊ - properties: (SiteConfig1 | string)␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * Microsoft.Web/sites/config␊ - */␊ - export type SitesConfig1 = ({␊ - apiVersion: "2016-08-01"␊ - type: "Microsoft.Web/sites/config"␊ - [k: string]: unknown␊ - } & ({␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteAuthSettings resource specific properties␊ - */␊ - properties: (SiteAuthSettingsProperties | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * BackupRequest resource specific properties␊ - */␊ - properties: (BackupRequestProperties1 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Connection strings.␊ - */␊ - properties: ({␊ - [k: string]: ConnStringValueTypePair1␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteLogsConfig resource specific properties␊ - */␊ - properties: (SiteLogsConfigProperties1 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * PushSettings resource specific properties␊ - */␊ - properties: (PushSettingsProperties | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * 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.␊ - */␊ - properties: (SlotConfigNames | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Configuration of an App Service app.␊ - */␊ - properties: (SiteConfig1 | string)␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * Microsoft.Web/sites/slots/config␊ - */␊ - export type SitesSlotsConfigChildResource1 = ({␊ - apiVersion: "2016-08-01"␊ - type: "config"␊ - [k: string]: unknown␊ - } & ({␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "appsettings"␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "authsettings"␊ - /**␊ - * SiteAuthSettings resource specific properties␊ - */␊ - properties: (SiteAuthSettingsProperties | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "backup"␊ - /**␊ - * BackupRequest resource specific properties␊ - */␊ - properties: (BackupRequestProperties1 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "connectionstrings"␊ - /**␊ - * Connection strings.␊ - */␊ - properties: ({␊ - [k: string]: ConnStringValueTypePair1␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "logs"␊ - /**␊ - * SiteLogsConfig resource specific properties␊ - */␊ - properties: (SiteLogsConfigProperties1 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "metadata"␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "pushsettings"␊ - /**␊ - * PushSettings resource specific properties␊ - */␊ - properties: (PushSettingsProperties | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "web"␊ - /**␊ - * Configuration of an App Service app.␊ - */␊ - properties: (SiteConfig1 | string)␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * Microsoft.Web/sites/slots/config␊ - */␊ - export type SitesSlotsConfig1 = ({␊ - apiVersion: "2016-08-01"␊ - type: "Microsoft.Web/sites/slots/config"␊ - [k: string]: unknown␊ - } & ({␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteAuthSettings resource specific properties␊ - */␊ - properties: (SiteAuthSettingsProperties | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * BackupRequest resource specific properties␊ - */␊ - properties: (BackupRequestProperties1 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Connection strings.␊ - */␊ - properties: ({␊ - [k: string]: ConnStringValueTypePair1␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteLogsConfig resource specific properties␊ - */␊ - properties: (SiteLogsConfigProperties1 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * PushSettings resource specific properties␊ - */␊ - properties: (PushSettingsProperties | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Configuration of an App Service app.␊ - */␊ - properties: (SiteConfig1 | string)␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * Microsoft.Web/sites/config␊ - */␊ - export type SitesConfigChildResource2 = ({␊ - apiVersion: "2018-02-01"␊ - type: "config"␊ - [k: string]: unknown␊ - } & ({␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "appsettings"␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "authsettings"␊ - /**␊ - * SiteAuthSettings resource specific properties␊ - */␊ - properties: (SiteAuthSettingsProperties1 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "azurestorageaccounts"␊ - /**␊ - * Azure storage accounts.␊ - */␊ - properties: ({␊ - [k: string]: AzureStorageInfoValue␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "backup"␊ - /**␊ - * BackupRequest resource specific properties␊ - */␊ - properties: (BackupRequestProperties2 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "connectionstrings"␊ - /**␊ - * Connection strings.␊ - */␊ - properties: ({␊ - [k: string]: ConnStringValueTypePair2␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "logs"␊ - /**␊ - * SiteLogsConfig resource specific properties␊ - */␊ - properties: (SiteLogsConfigProperties2 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "metadata"␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "pushsettings"␊ - /**␊ - * PushSettings resource specific properties␊ - */␊ - properties: (PushSettingsProperties1 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "slotConfigNames"␊ - /**␊ - * Names for connection strings, application settings, and external Azure storage account configuration␊ - * identifiers 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.␊ - */␊ - properties: (SlotConfigNames1 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "web"␊ - /**␊ - * Configuration of an App Service app.␊ - */␊ - properties: (SiteConfig2 | string)␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * Microsoft.Web/sites/config␊ - */␊ - export type SitesConfig2 = ({␊ - apiVersion: "2018-02-01"␊ - type: "Microsoft.Web/sites/config"␊ - [k: string]: unknown␊ - } & ({␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteAuthSettings resource specific properties␊ - */␊ - properties: (SiteAuthSettingsProperties1 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Azure storage accounts.␊ - */␊ - properties: ({␊ - [k: string]: AzureStorageInfoValue␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * BackupRequest resource specific properties␊ - */␊ - properties: (BackupRequestProperties2 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Connection strings.␊ - */␊ - properties: ({␊ - [k: string]: ConnStringValueTypePair2␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteLogsConfig resource specific properties␊ - */␊ - properties: (SiteLogsConfigProperties2 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * PushSettings resource specific properties␊ - */␊ - properties: (PushSettingsProperties1 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Names for connection strings, application settings, and external Azure storage account configuration␊ - * identifiers 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.␊ - */␊ - properties: (SlotConfigNames1 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Configuration of an App Service app.␊ - */␊ - properties: (SiteConfig2 | string)␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * Microsoft.Web/sites/slots/config␊ - */␊ - export type SitesSlotsConfigChildResource2 = ({␊ - apiVersion: "2018-02-01"␊ - type: "config"␊ - [k: string]: unknown␊ - } & ({␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "appsettings"␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "authsettings"␊ - /**␊ - * SiteAuthSettings resource specific properties␊ - */␊ - properties: (SiteAuthSettingsProperties1 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "azurestorageaccounts"␊ - /**␊ - * Azure storage accounts.␊ - */␊ - properties: ({␊ - [k: string]: AzureStorageInfoValue␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "backup"␊ - /**␊ - * BackupRequest resource specific properties␊ - */␊ - properties: (BackupRequestProperties2 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "connectionstrings"␊ - /**␊ - * Connection strings.␊ - */␊ - properties: ({␊ - [k: string]: ConnStringValueTypePair2␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "logs"␊ - /**␊ - * SiteLogsConfig resource specific properties␊ - */␊ - properties: (SiteLogsConfigProperties2 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "metadata"␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "pushsettings"␊ - /**␊ - * PushSettings resource specific properties␊ - */␊ - properties: (PushSettingsProperties1 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "web"␊ - /**␊ - * Configuration of an App Service app.␊ - */␊ - properties: (SiteConfig2 | string)␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * Microsoft.Web/sites/slots/config␊ - */␊ - export type SitesSlotsConfig2 = ({␊ - apiVersion: "2018-02-01"␊ - type: "Microsoft.Web/sites/slots/config"␊ - [k: string]: unknown␊ - } & ({␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteAuthSettings resource specific properties␊ - */␊ - properties: (SiteAuthSettingsProperties1 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Azure storage accounts.␊ - */␊ - properties: ({␊ - [k: string]: AzureStorageInfoValue␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * BackupRequest resource specific properties␊ - */␊ - properties: (BackupRequestProperties2 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Connection strings.␊ - */␊ - properties: ({␊ - [k: string]: ConnStringValueTypePair2␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteLogsConfig resource specific properties␊ - */␊ - properties: (SiteLogsConfigProperties2 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * PushSettings resource specific properties␊ - */␊ - properties: (PushSettingsProperties1 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Configuration of an App Service app.␊ - */␊ - properties: (SiteConfig2 | string)␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * Microsoft.Web/sites/config␊ - */␊ - export type SitesConfigChildResource3 = ({␊ - apiVersion: "2018-11-01"␊ - type: "config"␊ - [k: string]: unknown␊ - } & ({␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "appsettings"␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "authsettings"␊ - /**␊ - * SiteAuthSettings resource specific properties␊ - */␊ - properties: (SiteAuthSettingsProperties2 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "azurestorageaccounts"␊ - /**␊ - * Azure storage accounts.␊ - */␊ - properties: ({␊ - [k: string]: AzureStorageInfoValue1␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "backup"␊ - /**␊ - * BackupRequest resource specific properties␊ - */␊ - properties: (BackupRequestProperties3 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "connectionstrings"␊ - /**␊ - * Connection strings.␊ - */␊ - properties: ({␊ - [k: string]: ConnStringValueTypePair3␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "logs"␊ - /**␊ - * SiteLogsConfig resource specific properties␊ - */␊ - properties: (SiteLogsConfigProperties3 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "metadata"␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "pushsettings"␊ - /**␊ - * PushSettings resource specific properties␊ - */␊ - properties: (PushSettingsProperties2 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "slotConfigNames"␊ - /**␊ - * Names for connection strings, application settings, and external Azure storage account configuration␊ - * identifiers 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.␊ - */␊ - properties: (SlotConfigNames2 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "web"␊ - /**␊ - * Configuration of an App Service app.␊ - */␊ - properties: (SiteConfig3 | string)␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * Microsoft.Web/sites/config␊ - */␊ - export type SitesConfig3 = ({␊ - apiVersion: "2018-11-01"␊ - type: "Microsoft.Web/sites/config"␊ - [k: string]: unknown␊ - } & ({␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteAuthSettings resource specific properties␊ - */␊ - properties: (SiteAuthSettingsProperties2 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Azure storage accounts.␊ - */␊ - properties: ({␊ - [k: string]: AzureStorageInfoValue1␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * BackupRequest resource specific properties␊ - */␊ - properties: (BackupRequestProperties3 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Connection strings.␊ - */␊ - properties: ({␊ - [k: string]: ConnStringValueTypePair3␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteLogsConfig resource specific properties␊ - */␊ - properties: (SiteLogsConfigProperties3 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * PushSettings resource specific properties␊ - */␊ - properties: (PushSettingsProperties2 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Names for connection strings, application settings, and external Azure storage account configuration␊ - * identifiers 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.␊ - */␊ - properties: (SlotConfigNames2 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Configuration of an App Service app.␊ - */␊ - properties: (SiteConfig3 | string)␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * Microsoft.Web/sites/slots/config␊ - */␊ - export type SitesSlotsConfigChildResource3 = ({␊ - apiVersion: "2018-11-01"␊ - type: "config"␊ - [k: string]: unknown␊ - } & ({␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "appsettings"␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "authsettings"␊ - /**␊ - * SiteAuthSettings resource specific properties␊ - */␊ - properties: (SiteAuthSettingsProperties2 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "azurestorageaccounts"␊ - /**␊ - * Azure storage accounts.␊ - */␊ - properties: ({␊ - [k: string]: AzureStorageInfoValue1␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "backup"␊ - /**␊ - * BackupRequest resource specific properties␊ - */␊ - properties: (BackupRequestProperties3 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "connectionstrings"␊ - /**␊ - * Connection strings.␊ - */␊ - properties: ({␊ - [k: string]: ConnStringValueTypePair3␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "logs"␊ - /**␊ - * SiteLogsConfig resource specific properties␊ - */␊ - properties: (SiteLogsConfigProperties3 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "metadata"␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "pushsettings"␊ - /**␊ - * PushSettings resource specific properties␊ - */␊ - properties: (PushSettingsProperties2 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "web"␊ - /**␊ - * Configuration of an App Service app.␊ - */␊ - properties: (SiteConfig3 | string)␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * Microsoft.Web/sites/slots/config␊ - */␊ - export type SitesSlotsConfig3 = ({␊ - apiVersion: "2018-11-01"␊ - type: "Microsoft.Web/sites/slots/config"␊ - [k: string]: unknown␊ - } & ({␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteAuthSettings resource specific properties␊ - */␊ - properties: (SiteAuthSettingsProperties2 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Azure storage accounts.␊ - */␊ - properties: ({␊ - [k: string]: AzureStorageInfoValue1␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * BackupRequest resource specific properties␊ - */␊ - properties: (BackupRequestProperties3 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Connection strings.␊ - */␊ - properties: ({␊ - [k: string]: ConnStringValueTypePair3␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteLogsConfig resource specific properties␊ - */␊ - properties: (SiteLogsConfigProperties3 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * PushSettings resource specific properties␊ - */␊ - properties: (PushSettingsProperties2 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Configuration of an App Service app.␊ - */␊ - properties: (SiteConfig3 | string)␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * Microsoft.Web/sites/basicPublishingCredentialsPolicies␊ - */␊ - export type SitesBasicPublishingCredentialsPoliciesChildResource = ({␊ - apiVersion: "2019-08-01"␊ - type: "basicPublishingCredentialsPolicies"␊ - [k: string]: unknown␊ - } & ({␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "ftp"␊ - /**␊ - * CsmPublishingCredentialsPoliciesEntity resource specific properties␊ - */␊ - properties: (CsmPublishingCredentialsPoliciesEntityProperties | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "scm"␊ - /**␊ - * CsmPublishingCredentialsPoliciesEntity resource specific properties␊ - */␊ - properties: (CsmPublishingCredentialsPoliciesEntityProperties | string)␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * Microsoft.Web/sites/config␊ - */␊ - export type SitesConfigChildResource4 = ({␊ - apiVersion: "2019-08-01"␊ - type: "config"␊ - [k: string]: unknown␊ - } & ({␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "appsettings"␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "authsettings"␊ - /**␊ - * SiteAuthSettings resource specific properties␊ - */␊ - properties: (SiteAuthSettingsProperties3 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "azurestorageaccounts"␊ - /**␊ - * Azure storage accounts.␊ - */␊ - properties: ({␊ - [k: string]: AzureStorageInfoValue2␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "backup"␊ - /**␊ - * BackupRequest resource specific properties␊ - */␊ - properties: (BackupRequestProperties4 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "connectionstrings"␊ - /**␊ - * Connection strings.␊ - */␊ - properties: ({␊ - [k: string]: ConnStringValueTypePair4␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "logs"␊ - /**␊ - * SiteLogsConfig resource specific properties␊ - */␊ - properties: (SiteLogsConfigProperties4 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "metadata"␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "pushsettings"␊ - /**␊ - * PushSettings resource specific properties␊ - */␊ - properties: (PushSettingsProperties3 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "slotConfigNames"␊ - /**␊ - * Names for connection strings, application settings, and external Azure storage account configuration␊ - * identifiers 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.␊ - */␊ - properties: (SlotConfigNames3 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "web"␊ - /**␊ - * Configuration of an App Service app.␊ - */␊ - properties: (SiteConfig4 | string)␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * Microsoft.Web/sites/basicPublishingCredentialsPolicies␊ - */␊ - export type SitesBasicPublishingCredentialsPolicies = ({␊ - apiVersion: "2019-08-01"␊ - type: "Microsoft.Web/sites/basicPublishingCredentialsPolicies"␊ - [k: string]: unknown␊ - } & {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * CsmPublishingCredentialsPoliciesEntity resource specific properties␊ - */␊ - properties: (CsmPublishingCredentialsPoliciesEntityProperties | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Microsoft.Web/sites/config␊ - */␊ - export type SitesConfig4 = ({␊ - apiVersion: "2019-08-01"␊ - type: "Microsoft.Web/sites/config"␊ - [k: string]: unknown␊ - } & ({␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteAuthSettings resource specific properties␊ - */␊ - properties: (SiteAuthSettingsProperties3 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Azure storage accounts.␊ - */␊ - properties: ({␊ - [k: string]: AzureStorageInfoValue2␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * BackupRequest resource specific properties␊ - */␊ - properties: (BackupRequestProperties4 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Connection strings.␊ - */␊ - properties: ({␊ - [k: string]: ConnStringValueTypePair4␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteLogsConfig resource specific properties␊ - */␊ - properties: (SiteLogsConfigProperties4 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * PushSettings resource specific properties␊ - */␊ - properties: (PushSettingsProperties3 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Names for connection strings, application settings, and external Azure storage account configuration␊ - * identifiers 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.␊ - */␊ - properties: (SlotConfigNames3 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Configuration of an App Service app.␊ - */␊ - properties: (SiteConfig4 | string)␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * Microsoft.Web/sites/slots/config␊ - */␊ - export type SitesSlotsConfigChildResource4 = ({␊ - apiVersion: "2019-08-01"␊ - type: "config"␊ - [k: string]: unknown␊ - } & ({␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "appsettings"␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "authsettings"␊ - /**␊ - * SiteAuthSettings resource specific properties␊ - */␊ - properties: (SiteAuthSettingsProperties3 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "azurestorageaccounts"␊ - /**␊ - * Azure storage accounts.␊ - */␊ - properties: ({␊ - [k: string]: AzureStorageInfoValue2␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "backup"␊ - /**␊ - * BackupRequest resource specific properties␊ - */␊ - properties: (BackupRequestProperties4 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "connectionstrings"␊ - /**␊ - * Connection strings.␊ - */␊ - properties: ({␊ - [k: string]: ConnStringValueTypePair4␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "logs"␊ - /**␊ - * SiteLogsConfig resource specific properties␊ - */␊ - properties: (SiteLogsConfigProperties4 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "metadata"␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "pushsettings"␊ - /**␊ - * PushSettings resource specific properties␊ - */␊ - properties: (PushSettingsProperties3 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "web"␊ - /**␊ - * Configuration of an App Service app.␊ - */␊ - properties: (SiteConfig4 | string)␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * Microsoft.Web/sites/slots/config␊ - */␊ - export type SitesSlotsConfig4 = ({␊ - apiVersion: "2019-08-01"␊ - type: "Microsoft.Web/sites/slots/config"␊ - [k: string]: unknown␊ - } & ({␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteAuthSettings resource specific properties␊ - */␊ - properties: (SiteAuthSettingsProperties3 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Azure storage accounts.␊ - */␊ - properties: ({␊ - [k: string]: AzureStorageInfoValue2␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * BackupRequest resource specific properties␊ - */␊ - properties: (BackupRequestProperties4 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Connection strings.␊ - */␊ - properties: ({␊ - [k: string]: ConnStringValueTypePair4␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteLogsConfig resource specific properties␊ - */␊ - properties: (SiteLogsConfigProperties4 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * PushSettings resource specific properties␊ - */␊ - properties: (PushSettingsProperties3 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Configuration of an App Service app.␊ - */␊ - properties: (SiteConfig4 | string)␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * Microsoft.Web/sites/basicPublishingCredentialsPolicies␊ - */␊ - export type SitesBasicPublishingCredentialsPoliciesChildResource1 = ({␊ - apiVersion: "2020-06-01"␊ - type: "basicPublishingCredentialsPolicies"␊ - [k: string]: unknown␊ - } & ({␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "ftp"␊ - /**␊ - * CsmPublishingCredentialsPoliciesEntity resource specific properties␊ - */␊ - properties: (CsmPublishingCredentialsPoliciesEntityProperties1 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "scm"␊ - /**␊ - * CsmPublishingCredentialsPoliciesEntity resource specific properties␊ - */␊ - properties: (CsmPublishingCredentialsPoliciesEntityProperties1 | string)␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * Microsoft.Web/sites/config␊ - */␊ - export type SitesConfigChildResource5 = ({␊ - apiVersion: "2020-06-01"␊ - type: "config"␊ - [k: string]: unknown␊ - } & ({␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "appsettings"␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "authsettings"␊ - /**␊ - * SiteAuthSettings resource specific properties␊ - */␊ - properties: (SiteAuthSettingsProperties4 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "authsettingsV2"␊ - /**␊ - * SiteAuthSettingsV2 resource specific properties␊ - */␊ - properties: (SiteAuthSettingsV2Properties | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "azurestorageaccounts"␊ - /**␊ - * Azure storage accounts.␊ - */␊ - properties: ({␊ - [k: string]: AzureStorageInfoValue3␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "backup"␊ - /**␊ - * BackupRequest resource specific properties␊ - */␊ - properties: (BackupRequestProperties5 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "connectionstrings"␊ - /**␊ - * Connection strings.␊ - */␊ - properties: ({␊ - [k: string]: ConnStringValueTypePair5␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "logs"␊ - /**␊ - * SiteLogsConfig resource specific properties␊ - */␊ - properties: (SiteLogsConfigProperties5 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "metadata"␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "pushsettings"␊ - /**␊ - * PushSettings resource specific properties␊ - */␊ - properties: (PushSettingsProperties4 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "slotConfigNames"␊ - /**␊ - * Names for connection strings, application settings, and external Azure storage account configuration␊ - * identifiers 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.␊ - */␊ - properties: (SlotConfigNames4 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "web"␊ - /**␊ - * Configuration of an App Service app.␊ - */␊ - properties: (SiteConfig5 | string)␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * Microsoft.Web/sites/basicPublishingCredentialsPolicies␊ - */␊ - export type SitesBasicPublishingCredentialsPolicies1 = ({␊ - apiVersion: "2020-06-01"␊ - type: "Microsoft.Web/sites/basicPublishingCredentialsPolicies"␊ - [k: string]: unknown␊ - } & {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * CsmPublishingCredentialsPoliciesEntity resource specific properties␊ - */␊ - properties: (CsmPublishingCredentialsPoliciesEntityProperties1 | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Microsoft.Web/sites/config␊ - */␊ - export type SitesConfig5 = ({␊ - apiVersion: "2020-06-01"␊ - type: "Microsoft.Web/sites/config"␊ - [k: string]: unknown␊ - } & ({␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteAuthSettings resource specific properties␊ - */␊ - properties: (SiteAuthSettingsProperties4 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteAuthSettingsV2 resource specific properties␊ - */␊ - properties: (SiteAuthSettingsV2Properties | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Azure storage accounts.␊ - */␊ - properties: ({␊ - [k: string]: AzureStorageInfoValue3␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * BackupRequest resource specific properties␊ - */␊ - properties: (BackupRequestProperties5 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Connection strings.␊ - */␊ - properties: ({␊ - [k: string]: ConnStringValueTypePair5␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteLogsConfig resource specific properties␊ - */␊ - properties: (SiteLogsConfigProperties5 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * PushSettings resource specific properties␊ - */␊ - properties: (PushSettingsProperties4 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Names for connection strings, application settings, and external Azure storage account configuration␊ - * identifiers 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.␊ - */␊ - properties: (SlotConfigNames4 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Configuration of an App Service app.␊ - */␊ - properties: (SiteConfig5 | string)␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * Microsoft.Web/sites/slots/config␊ - */␊ - export type SitesSlotsConfigChildResource5 = ({␊ - apiVersion: "2020-06-01"␊ - type: "config"␊ - [k: string]: unknown␊ - } & ({␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "appsettings"␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "authsettings"␊ - /**␊ - * SiteAuthSettings resource specific properties␊ - */␊ - properties: (SiteAuthSettingsProperties4 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "authsettingsV2"␊ - /**␊ - * SiteAuthSettingsV2 resource specific properties␊ - */␊ - properties: (SiteAuthSettingsV2Properties | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "azurestorageaccounts"␊ - /**␊ - * Azure storage accounts.␊ - */␊ - properties: ({␊ - [k: string]: AzureStorageInfoValue3␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "backup"␊ - /**␊ - * BackupRequest resource specific properties␊ - */␊ - properties: (BackupRequestProperties5 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "connectionstrings"␊ - /**␊ - * Connection strings.␊ - */␊ - properties: ({␊ - [k: string]: ConnStringValueTypePair5␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "logs"␊ - /**␊ - * SiteLogsConfig resource specific properties␊ - */␊ - properties: (SiteLogsConfigProperties5 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "metadata"␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "pushsettings"␊ - /**␊ - * PushSettings resource specific properties␊ - */␊ - properties: (PushSettingsProperties4 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "web"␊ - /**␊ - * Configuration of an App Service app.␊ - */␊ - properties: (SiteConfig5 | string)␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * Microsoft.Web/sites/slots/config␊ - */␊ - export type SitesSlotsConfig5 = ({␊ - apiVersion: "2020-06-01"␊ - type: "Microsoft.Web/sites/slots/config"␊ - [k: string]: unknown␊ - } & ({␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteAuthSettings resource specific properties␊ - */␊ - properties: (SiteAuthSettingsProperties4 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteAuthSettingsV2 resource specific properties␊ - */␊ - properties: (SiteAuthSettingsV2Properties | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Azure storage accounts.␊ - */␊ - properties: ({␊ - [k: string]: AzureStorageInfoValue3␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * BackupRequest resource specific properties␊ - */␊ - properties: (BackupRequestProperties5 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Connection strings.␊ - */␊ - properties: ({␊ - [k: string]: ConnStringValueTypePair5␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteLogsConfig resource specific properties␊ - */␊ - properties: (SiteLogsConfigProperties5 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * PushSettings resource specific properties␊ - */␊ - properties: (PushSettingsProperties4 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Configuration of an App Service app.␊ - */␊ - properties: (SiteConfig5 | string)␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * Microsoft.Web/sites/basicPublishingCredentialsPolicies␊ - */␊ - export type SitesBasicPublishingCredentialsPoliciesChildResource2 = ({␊ - apiVersion: "2020-09-01"␊ - type: "basicPublishingCredentialsPolicies"␊ - [k: string]: unknown␊ - } & ({␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "ftp"␊ - /**␊ - * CsmPublishingCredentialsPoliciesEntity resource specific properties␊ - */␊ - properties: (CsmPublishingCredentialsPoliciesEntityProperties2 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "scm"␊ - /**␊ - * CsmPublishingCredentialsPoliciesEntity resource specific properties␊ - */␊ - properties: (CsmPublishingCredentialsPoliciesEntityProperties2 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * Microsoft.Web/sites/config␊ - */␊ - export type SitesConfigChildResource6 = ({␊ - apiVersion: "2020-09-01"␊ - type: "config"␊ - [k: string]: unknown␊ - } & ({␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "appsettings"␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "authsettings"␊ - /**␊ - * SiteAuthSettings resource specific properties␊ - */␊ - properties: (SiteAuthSettingsProperties5 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "authsettingsV2"␊ - /**␊ - * SiteAuthSettingsV2 resource specific properties␊ - */␊ - properties: (SiteAuthSettingsV2Properties1 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "azurestorageaccounts"␊ - /**␊ - * Azure storage accounts.␊ - */␊ - properties: ({␊ - [k: string]: AzureStorageInfoValue4␊ - } | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "backup"␊ - /**␊ - * BackupRequest resource specific properties␊ - */␊ - properties: (BackupRequestProperties6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "connectionstrings"␊ - /**␊ - * Connection strings.␊ - */␊ - properties: ({␊ - [k: string]: ConnStringValueTypePair6␊ - } | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "logs"␊ - /**␊ - * SiteLogsConfig resource specific properties␊ - */␊ - properties: (SiteLogsConfigProperties6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "metadata"␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "pushsettings"␊ - /**␊ - * PushSettings resource specific properties␊ - */␊ - properties: (PushSettingsProperties5 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "slotConfigNames"␊ - /**␊ - * Names for connection strings, application settings, and external Azure storage account configuration␊ - * identifiers 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.␊ - */␊ - properties: (SlotConfigNames5 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "web"␊ - /**␊ - * Configuration of an App Service app.␊ - */␊ - properties: (SiteConfig6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * Microsoft.Web/sites/basicPublishingCredentialsPolicies␊ - */␊ - export type SitesBasicPublishingCredentialsPolicies2 = ({␊ - apiVersion: "2020-09-01"␊ - type: "Microsoft.Web/sites/basicPublishingCredentialsPolicies"␊ - [k: string]: unknown␊ - } & {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * CsmPublishingCredentialsPoliciesEntity resource specific properties␊ - */␊ - properties: (CsmPublishingCredentialsPoliciesEntityProperties2 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Microsoft.Web/sites/config␊ - */␊ - export type SitesConfig6 = ({␊ - apiVersion: "2020-09-01"␊ - type: "Microsoft.Web/sites/config"␊ - [k: string]: unknown␊ - } & ({␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteAuthSettings resource specific properties␊ - */␊ - properties: (SiteAuthSettingsProperties5 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteAuthSettingsV2 resource specific properties␊ - */␊ - properties: (SiteAuthSettingsV2Properties1 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Azure storage accounts.␊ - */␊ - properties: ({␊ - [k: string]: AzureStorageInfoValue4␊ - } | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * BackupRequest resource specific properties␊ - */␊ - properties: (BackupRequestProperties6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Connection strings.␊ - */␊ - properties: ({␊ - [k: string]: ConnStringValueTypePair6␊ - } | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteLogsConfig resource specific properties␊ - */␊ - properties: (SiteLogsConfigProperties6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * PushSettings resource specific properties␊ - */␊ - properties: (PushSettingsProperties5 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Names for connection strings, application settings, and external Azure storage account configuration␊ - * identifiers 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.␊ - */␊ - properties: (SlotConfigNames5 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Configuration of an App Service app.␊ - */␊ - properties: (SiteConfig6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * Microsoft.Web/sites/slots/config␊ - */␊ - export type SitesSlotsConfigChildResource6 = ({␊ - apiVersion: "2020-09-01"␊ - type: "config"␊ - [k: string]: unknown␊ - } & ({␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "appsettings"␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "authsettings"␊ - /**␊ - * SiteAuthSettings resource specific properties␊ - */␊ - properties: (SiteAuthSettingsProperties5 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "authsettingsV2"␊ - /**␊ - * SiteAuthSettingsV2 resource specific properties␊ - */␊ - properties: (SiteAuthSettingsV2Properties1 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "azurestorageaccounts"␊ - /**␊ - * Azure storage accounts.␊ - */␊ - properties: ({␊ - [k: string]: AzureStorageInfoValue4␊ - } | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "backup"␊ - /**␊ - * BackupRequest resource specific properties␊ - */␊ - properties: (BackupRequestProperties6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "connectionstrings"␊ - /**␊ - * Connection strings.␊ - */␊ - properties: ({␊ - [k: string]: ConnStringValueTypePair6␊ - } | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "logs"␊ - /**␊ - * SiteLogsConfig resource specific properties␊ - */␊ - properties: (SiteLogsConfigProperties6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "metadata"␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "pushsettings"␊ - /**␊ - * PushSettings resource specific properties␊ - */␊ - properties: (PushSettingsProperties5 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "web"␊ - /**␊ - * Configuration of an App Service app.␊ - */␊ - properties: (SiteConfig6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * Microsoft.Web/sites/slots/config␊ - */␊ - export type SitesSlotsConfig6 = ({␊ - apiVersion: "2020-09-01"␊ - type: "Microsoft.Web/sites/slots/config"␊ - [k: string]: unknown␊ - } & ({␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteAuthSettings resource specific properties␊ - */␊ - properties: (SiteAuthSettingsProperties5 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteAuthSettingsV2 resource specific properties␊ - */␊ - properties: (SiteAuthSettingsV2Properties1 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Azure storage accounts.␊ - */␊ - properties: ({␊ - [k: string]: AzureStorageInfoValue4␊ - } | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * BackupRequest resource specific properties␊ - */␊ - properties: (BackupRequestProperties6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Connection strings.␊ - */␊ - properties: ({␊ - [k: string]: ConnStringValueTypePair6␊ - } | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteLogsConfig resource specific properties␊ - */␊ - properties: (SiteLogsConfigProperties6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * PushSettings resource specific properties␊ - */␊ - properties: (PushSettingsProperties5 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Configuration of an App Service app.␊ - */␊ - properties: (SiteConfig6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * Microsoft.Web/sites/basicPublishingCredentialsPolicies␊ - */␊ - export type SitesBasicPublishingCredentialsPoliciesChildResource3 = ({␊ - apiVersion: "2020-10-01"␊ - type: "basicPublishingCredentialsPolicies"␊ - [k: string]: unknown␊ - } & ({␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "ftp"␊ - /**␊ - * CsmPublishingCredentialsPoliciesEntity resource specific properties␊ - */␊ - properties: (CsmPublishingCredentialsPoliciesEntityProperties3 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "scm"␊ - /**␊ - * CsmPublishingCredentialsPoliciesEntity resource specific properties␊ - */␊ - properties: (CsmPublishingCredentialsPoliciesEntityProperties3 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * Microsoft.Web/sites/config␊ - */␊ - export type SitesConfigChildResource7 = ({␊ - apiVersion: "2020-10-01"␊ - type: "config"␊ - [k: string]: unknown␊ - } & ({␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "appsettings"␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "authsettings"␊ - /**␊ - * SiteAuthSettings resource specific properties␊ - */␊ - properties: (SiteAuthSettingsProperties6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "authsettingsV2"␊ - /**␊ - * SiteAuthSettingsV2 resource specific properties␊ - */␊ - properties: (SiteAuthSettingsV2Properties2 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "azurestorageaccounts"␊ - /**␊ - * Azure storage accounts.␊ - */␊ - properties: ({␊ - [k: string]: AzureStorageInfoValue5␊ - } | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "backup"␊ - /**␊ - * BackupRequest resource specific properties␊ - */␊ - properties: (BackupRequestProperties7 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "connectionstrings"␊ - /**␊ - * Connection strings.␊ - */␊ - properties: ({␊ - [k: string]: ConnStringValueTypePair7␊ - } | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "logs"␊ - /**␊ - * SiteLogsConfig resource specific properties␊ - */␊ - properties: (SiteLogsConfigProperties7 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "metadata"␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "pushsettings"␊ - /**␊ - * PushSettings resource specific properties␊ - */␊ - properties: (PushSettingsProperties6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "slotConfigNames"␊ - /**␊ - * Names for connection strings, application settings, and external Azure storage account configuration␊ - * identifiers 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.␊ - */␊ - properties: (SlotConfigNames6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "web"␊ - /**␊ - * Configuration of an App Service app.␊ - */␊ - properties: (SiteConfig7 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * Microsoft.Web/sites/basicPublishingCredentialsPolicies␊ - */␊ - export type SitesBasicPublishingCredentialsPolicies3 = ({␊ - apiVersion: "2020-10-01"␊ - type: "Microsoft.Web/sites/basicPublishingCredentialsPolicies"␊ - [k: string]: unknown␊ - } & {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * CsmPublishingCredentialsPoliciesEntity resource specific properties␊ - */␊ - properties: (CsmPublishingCredentialsPoliciesEntityProperties3 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Microsoft.Web/sites/config␊ - */␊ - export type SitesConfig7 = ({␊ - apiVersion: "2020-10-01"␊ - type: "Microsoft.Web/sites/config"␊ - [k: string]: unknown␊ - } & ({␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteAuthSettings resource specific properties␊ - */␊ - properties: (SiteAuthSettingsProperties6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteAuthSettingsV2 resource specific properties␊ - */␊ - properties: (SiteAuthSettingsV2Properties2 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Azure storage accounts.␊ - */␊ - properties: ({␊ - [k: string]: AzureStorageInfoValue5␊ - } | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * BackupRequest resource specific properties␊ - */␊ - properties: (BackupRequestProperties7 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Connection strings.␊ - */␊ - properties: ({␊ - [k: string]: ConnStringValueTypePair7␊ - } | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteLogsConfig resource specific properties␊ - */␊ - properties: (SiteLogsConfigProperties7 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * PushSettings resource specific properties␊ - */␊ - properties: (PushSettingsProperties6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Names for connection strings, application settings, and external Azure storage account configuration␊ - * identifiers 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.␊ - */␊ - properties: (SlotConfigNames6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Configuration of an App Service app.␊ - */␊ - properties: (SiteConfig7 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * Microsoft.Web/sites/slots/config␊ - */␊ - export type SitesSlotsConfigChildResource7 = ({␊ - apiVersion: "2020-10-01"␊ - type: "config"␊ - [k: string]: unknown␊ - } & ({␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "appsettings"␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "authsettings"␊ - /**␊ - * SiteAuthSettings resource specific properties␊ - */␊ - properties: (SiteAuthSettingsProperties6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "authsettingsV2"␊ - /**␊ - * SiteAuthSettingsV2 resource specific properties␊ - */␊ - properties: (SiteAuthSettingsV2Properties2 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "azurestorageaccounts"␊ - /**␊ - * Azure storage accounts.␊ - */␊ - properties: ({␊ - [k: string]: AzureStorageInfoValue5␊ - } | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "backup"␊ - /**␊ - * BackupRequest resource specific properties␊ - */␊ - properties: (BackupRequestProperties7 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "connectionstrings"␊ - /**␊ - * Connection strings.␊ - */␊ - properties: ({␊ - [k: string]: ConnStringValueTypePair7␊ - } | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "logs"␊ - /**␊ - * SiteLogsConfig resource specific properties␊ - */␊ - properties: (SiteLogsConfigProperties7 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "metadata"␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "pushsettings"␊ - /**␊ - * PushSettings resource specific properties␊ - */␊ - properties: (PushSettingsProperties6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "web"␊ - /**␊ - * Configuration of an App Service app.␊ - */␊ - properties: (SiteConfig7 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * Microsoft.Web/sites/slots/config␊ - */␊ - export type SitesSlotsConfig7 = ({␊ - apiVersion: "2020-10-01"␊ - type: "Microsoft.Web/sites/slots/config"␊ - [k: string]: unknown␊ - } & ({␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteAuthSettings resource specific properties␊ - */␊ - properties: (SiteAuthSettingsProperties6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteAuthSettingsV2 resource specific properties␊ - */␊ - properties: (SiteAuthSettingsV2Properties2 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Azure storage accounts.␊ - */␊ - properties: ({␊ - [k: string]: AzureStorageInfoValue5␊ - } | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * BackupRequest resource specific properties␊ - */␊ - properties: (BackupRequestProperties7 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Connection strings.␊ - */␊ - properties: ({␊ - [k: string]: ConnStringValueTypePair7␊ - } | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteLogsConfig resource specific properties␊ - */␊ - properties: (SiteLogsConfigProperties7 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * PushSettings resource specific properties␊ - */␊ - properties: (PushSettingsProperties6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Configuration of an App Service app.␊ - */␊ - properties: (SiteConfig7 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * Microsoft.Web/sites/basicPublishingCredentialsPolicies␊ - */␊ - export type SitesBasicPublishingCredentialsPoliciesChildResource4 = ({␊ - apiVersion: "2020-12-01"␊ - type: "basicPublishingCredentialsPolicies"␊ - [k: string]: unknown␊ - } & ({␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "ftp"␊ - /**␊ - * CsmPublishingCredentialsPoliciesEntity resource specific properties␊ - */␊ - properties: (CsmPublishingCredentialsPoliciesEntityProperties4 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "scm"␊ - /**␊ - * CsmPublishingCredentialsPoliciesEntity resource specific properties␊ - */␊ - properties: (CsmPublishingCredentialsPoliciesEntityProperties4 | string)␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * Microsoft.Web/sites/config␊ - */␊ - export type SitesConfigChildResource8 = ({␊ - apiVersion: "2020-12-01"␊ - type: "config"␊ - [k: string]: unknown␊ - } & ({␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "appsettings"␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "authsettings"␊ - /**␊ - * SiteAuthSettings resource specific properties␊ - */␊ - properties: (SiteAuthSettingsProperties7 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "authsettingsV2"␊ - /**␊ - * SiteAuthSettingsV2 resource specific properties␊ - */␊ - properties: (SiteAuthSettingsV2Properties3 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "azurestorageaccounts"␊ - /**␊ - * Azure storage accounts.␊ - */␊ - properties: ({␊ - [k: string]: AzureStorageInfoValue6␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "backup"␊ - /**␊ - * BackupRequest resource specific properties␊ - */␊ - properties: (BackupRequestProperties8 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "connectionstrings"␊ - /**␊ - * Connection strings.␊ - */␊ - properties: ({␊ - [k: string]: ConnStringValueTypePair8␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "logs"␊ - /**␊ - * SiteLogsConfig resource specific properties␊ - */␊ - properties: (SiteLogsConfigProperties8 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "metadata"␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "pushsettings"␊ - /**␊ - * PushSettings resource specific properties␊ - */␊ - properties: (PushSettingsProperties7 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "slotConfigNames"␊ - /**␊ - * Names for connection strings, application settings, and external Azure storage account configuration␊ - * identifiers 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.␊ - */␊ - properties: (SlotConfigNames7 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "web"␊ - /**␊ - * Configuration of an App Service app.␊ - */␊ - properties: (SiteConfig8 | string)␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * Microsoft.Web/sites/basicPublishingCredentialsPolicies␊ - */␊ - export type SitesBasicPublishingCredentialsPolicies4 = ({␊ - apiVersion: "2020-12-01"␊ - type: "Microsoft.Web/sites/basicPublishingCredentialsPolicies"␊ - [k: string]: unknown␊ - } & {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * CsmPublishingCredentialsPoliciesEntity resource specific properties␊ - */␊ - properties: (CsmPublishingCredentialsPoliciesEntityProperties4 | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Microsoft.Web/sites/config␊ - */␊ - export type SitesConfig8 = ({␊ - apiVersion: "2020-12-01"␊ - type: "Microsoft.Web/sites/config"␊ - [k: string]: unknown␊ - } & ({␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteAuthSettings resource specific properties␊ - */␊ - properties: (SiteAuthSettingsProperties7 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteAuthSettingsV2 resource specific properties␊ - */␊ - properties: (SiteAuthSettingsV2Properties3 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Azure storage accounts.␊ - */␊ - properties: ({␊ - [k: string]: AzureStorageInfoValue6␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * BackupRequest resource specific properties␊ - */␊ - properties: (BackupRequestProperties8 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Connection strings.␊ - */␊ - properties: ({␊ - [k: string]: ConnStringValueTypePair8␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteLogsConfig resource specific properties␊ - */␊ - properties: (SiteLogsConfigProperties8 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * PushSettings resource specific properties␊ - */␊ - properties: (PushSettingsProperties7 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Names for connection strings, application settings, and external Azure storage account configuration␊ - * identifiers 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.␊ - */␊ - properties: (SlotConfigNames7 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Configuration of an App Service app.␊ - */␊ - properties: (SiteConfig8 | string)␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies␊ - */␊ - export type SitesSlotsBasicPublishingCredentialsPoliciesChildResource = ({␊ - apiVersion: "2020-12-01"␊ - type: "basicPublishingCredentialsPolicies"␊ - [k: string]: unknown␊ - } & ({␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "ftp"␊ - /**␊ - * CsmPublishingCredentialsPoliciesEntity resource specific properties␊ - */␊ - properties: (CsmPublishingCredentialsPoliciesEntityProperties4 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "scm"␊ - /**␊ - * CsmPublishingCredentialsPoliciesEntity resource specific properties␊ - */␊ - properties: (CsmPublishingCredentialsPoliciesEntityProperties4 | string)␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * Microsoft.Web/sites/slots/config␊ - */␊ - export type SitesSlotsConfigChildResource8 = ({␊ - apiVersion: "2020-12-01"␊ - type: "config"␊ - [k: string]: unknown␊ - } & ({␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "appsettings"␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "authsettings"␊ - /**␊ - * SiteAuthSettings resource specific properties␊ - */␊ - properties: (SiteAuthSettingsProperties7 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "authsettingsV2"␊ - /**␊ - * SiteAuthSettingsV2 resource specific properties␊ - */␊ - properties: (SiteAuthSettingsV2Properties3 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "azurestorageaccounts"␊ - /**␊ - * Azure storage accounts.␊ - */␊ - properties: ({␊ - [k: string]: AzureStorageInfoValue6␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "backup"␊ - /**␊ - * BackupRequest resource specific properties␊ - */␊ - properties: (BackupRequestProperties8 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "connectionstrings"␊ - /**␊ - * Connection strings.␊ - */␊ - properties: ({␊ - [k: string]: ConnStringValueTypePair8␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "logs"␊ - /**␊ - * SiteLogsConfig resource specific properties␊ - */␊ - properties: (SiteLogsConfigProperties8 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "metadata"␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "pushsettings"␊ - /**␊ - * PushSettings resource specific properties␊ - */␊ - properties: (PushSettingsProperties7 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "web"␊ - /**␊ - * Configuration of an App Service app.␊ - */␊ - properties: (SiteConfig8 | string)␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies␊ - */␊ - export type SitesSlotsBasicPublishingCredentialsPolicies = ({␊ - apiVersion: "2020-12-01"␊ - type: "Microsoft.Web/sites/slots/basicPublishingCredentialsPolicies"␊ - [k: string]: unknown␊ - } & {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * CsmPublishingCredentialsPoliciesEntity resource specific properties␊ - */␊ - properties: (CsmPublishingCredentialsPoliciesEntityProperties4 | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Microsoft.Web/sites/slots/config␊ - */␊ - export type SitesSlotsConfig8 = ({␊ - apiVersion: "2020-12-01"␊ - type: "Microsoft.Web/sites/slots/config"␊ - [k: string]: unknown␊ - } & ({␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteAuthSettings resource specific properties␊ - */␊ - properties: (SiteAuthSettingsProperties7 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteAuthSettingsV2 resource specific properties␊ - */␊ - properties: (SiteAuthSettingsV2Properties3 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Azure storage accounts.␊ - */␊ - properties: ({␊ - [k: string]: AzureStorageInfoValue6␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * BackupRequest resource specific properties␊ - */␊ - properties: (BackupRequestProperties8 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Connection strings.␊ - */␊ - properties: ({␊ - [k: string]: ConnStringValueTypePair8␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteLogsConfig resource specific properties␊ - */␊ - properties: (SiteLogsConfigProperties8 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * PushSettings resource specific properties␊ - */␊ - properties: (PushSettingsProperties7 | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Configuration of an App Service app.␊ - */␊ - properties: (SiteConfig8 | string)␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * Microsoft.Web/staticSites/config␊ - */␊ - export type StaticSitesConfigChildResource4 = ({␊ - apiVersion: "2020-12-01"␊ - type: "config"␊ - [k: string]: unknown␊ - } & ({␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "appsettings"␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - } | {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "functionappsettings"␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * Microsoft.Web/staticSites/builds/config␊ - */␊ - export type StaticSitesBuildsConfig4 = ({␊ - apiVersion: "2020-12-01"␊ - type: "Microsoft.Web/staticSites/builds/config"␊ - [k: string]: unknown␊ - } & {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Microsoft.Web/staticSites/config␊ - */␊ - export type StaticSitesConfig4 = ({␊ - apiVersion: "2020-12-01"␊ - type: "Microsoft.Web/staticSites/config"␊ - [k: string]: unknown␊ - } & {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Resources without symbolic names␊ - */␊ - export type ResourcesWithoutSymbolicNames = Resource[]␊ - /**␊ - * Value assigned for output␊ - */␊ - export type ParameterValueTypes2 = (string | boolean | number | {␊ - [k: string]: unknown␊ - } | unknown[] | null)␊ - ␊ - /**␊ - * An Azure deployment template␊ - */␊ - export interface Template {␊ - /**␊ - * JSON schema reference␊ - */␊ - $schema: string␊ - /**␊ - * Additional unstructured metadata to include with the template deployment.␊ - */␊ - metadata?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The apiProfile to use for all resources in the template.␊ - */␊ - apiProfile?: ("2017-03-09-profile" | "2018-03-01-hybrid" | "2018-06-01-profile" | "2019-03-01-hybrid")␊ - /**␊ - * A 4 number format for the version number of this template file. For example, 1.0.0.0␊ - */␊ - contentVersion: string␊ - /**␊ - * Variable definitions␊ - */␊ - variables?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Input parameter definitions␊ - */␊ - parameters?: {␊ - [k: string]: Parameter␊ - }␊ - /**␊ - * User defined functions␊ - */␊ - functions?: FunctionNamespace[]␊ - /**␊ - * Collection of resources to be deployed␊ - */␊ - resources: (ResourcesWithoutSymbolicNames | ResourcesWithSymbolicNames)␊ - /**␊ - * Output parameter definitions␊ - */␊ - outputs?: {␊ - [k: string]: Output1␊ - }␊ - }␊ - /**␊ - * Input parameter definitions␊ - */␊ - export interface Parameter {␊ - /**␊ - * Type of input parameter␊ - */␊ - type: ("string" | "securestring" | "int" | "bool" | "object" | "secureObject" | "array")␊ - defaultValue?: ParameterValueTypes␊ - /**␊ - * Value can only be one of these values␊ - */␊ - allowedValues?: unknown[]␊ - /**␊ - * Metadata for the parameter, can be any valid JSON object␊ - */␊ - metadata?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Minimum value for the int type parameter␊ - */␊ - minValue?: number␊ - /**␊ - * Maximum value for the int type parameter␊ - */␊ - maxValue?: number␊ - /**␊ - * Minimum length for the string or array type parameter␊ - */␊ - minLength?: number␊ - /**␊ - * Maximum length for the string or array type parameter␊ - */␊ - maxLength?: number␊ - [k: string]: unknown␊ - }␊ - export interface FunctionNamespace {␊ - /**␊ - * Function namespace␊ - */␊ - namespace?: string␊ - /**␊ - * Function members␊ - */␊ - members?: {␊ - [k: string]: FunctionMember␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface FunctionMember {␊ - /**␊ - * Function parameters␊ - */␊ - parameters?: FunctionParameter[]␊ - output?: FunctionOutput␊ - [k: string]: unknown␊ - }␊ - export interface FunctionParameter {␊ - /**␊ - * Function parameter name␊ - */␊ - name?: string␊ - /**␊ - * Type of function parameter value␊ - */␊ - type?: ("string" | "securestring" | "int" | "bool" | "object" | "secureObject" | "array")␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Function output␊ - */␊ - export interface FunctionOutput {␊ - /**␊ - * Type of function output value␊ - */␊ - type?: ("string" | "securestring" | "int" | "bool" | "object" | "secureObject" | "array")␊ - value?: ParameterValueTypes1␊ - [k: string]: unknown␊ - }␊ - export interface ARMResourceBase {␊ - /**␊ - * Name of the resource␊ - */␊ - name: string␊ - /**␊ - * Resource type␊ - */␊ - type: string␊ - /**␊ - * Condition of the resource␊ - */␊ - condition?: (boolean | string)␊ - /**␊ - * API Version of the resource type, optional when apiProfile is used on the template␊ - */␊ - apiVersion?: string␊ - /**␊ - * Collection of resources this resource depends on␊ - */␊ - dependsOn?: string[]␊ - [k: string]: unknown␊ - }␊ - export interface ResourceCopy {␊ - /**␊ - * Name of the copy␊ - */␊ - name?: string␊ - /**␊ - * Count of the copy␊ - */␊ - count?: (string | number)␊ - /**␊ - * The copy mode␊ - */␊ - mode?: ("Parallel" | "Serial")␊ - /**␊ - * The serial copy batch size␊ - */␊ - batchSize?: (string | number)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.HealthcareApis/services␊ - */␊ - export interface Services {␊ - apiVersion: "2019-09-16"␊ - /**␊ - * An etag associated with the resource, used for optimistic concurrency when editing it.␊ - */␊ - etag?: string␊ - /**␊ - * Setting indicating whether the service has a managed identity associated with it.␊ - */␊ - identity?: (ResourceIdentity | string)␊ - /**␊ - * The kind of the service.␊ - */␊ - kind: (("fhir" | "fhir-Stu3" | "fhir-R4") | string)␊ - /**␊ - * The resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the service instance.␊ - */␊ - name: string␊ - /**␊ - * The properties of a service instance.␊ - */␊ - properties: (ServicesProperties | string)␊ - /**␊ - * The resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.HealthcareApis/services"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Setting indicating whether the service has a managed identity associated with it.␊ - */␊ - export interface ResourceIdentity {␊ - /**␊ - * Type of identity being specified, currently SystemAssigned and None are allowed.␊ - */␊ - type?: (("SystemAssigned" | "None") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a service instance.␊ - */␊ - export interface ServicesProperties {␊ - /**␊ - * The access policies of the service instance.␊ - */␊ - accessPolicies?: (ServiceAccessPolicyEntry[] | string)␊ - /**␊ - * Authentication configuration information␊ - */␊ - authenticationConfiguration?: (ServiceAuthenticationConfigurationInfo | string)␊ - /**␊ - * The settings for the CORS configuration of the service instance.␊ - */␊ - corsConfiguration?: (ServiceCorsConfigurationInfo | string)␊ - /**␊ - * The settings for the Cosmos DB database backing the service.␊ - */␊ - cosmosDbConfiguration?: (ServiceCosmosDbConfigurationInfo | string)␊ - /**␊ - * Export operation configuration information␊ - */␊ - exportConfiguration?: (ServiceExportConfigurationInfo | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An access policy entry.␊ - */␊ - export interface ServiceAccessPolicyEntry {␊ - /**␊ - * An Azure AD object ID (User or Apps) that is allowed access to the FHIR service.␊ - */␊ - objectId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authentication configuration information␊ - */␊ - export interface ServiceAuthenticationConfigurationInfo {␊ - /**␊ - * The audience url for the service␊ - */␊ - audience?: string␊ - /**␊ - * The authority url for the service␊ - */␊ - authority?: string␊ - /**␊ - * If the SMART on FHIR proxy is enabled␊ - */␊ - smartProxyEnabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The settings for the CORS configuration of the service instance.␊ - */␊ - export interface ServiceCorsConfigurationInfo {␊ - /**␊ - * If credentials are allowed via CORS.␊ - */␊ - allowCredentials?: (boolean | string)␊ - /**␊ - * The headers to be allowed via CORS.␊ - */␊ - headers?: (string[] | string)␊ - /**␊ - * The max age to be allowed via CORS.␊ - */␊ - maxAge?: (number | string)␊ - /**␊ - * The methods to be allowed via CORS.␊ - */␊ - methods?: (string[] | string)␊ - /**␊ - * The origins to be allowed via CORS.␊ - */␊ - origins?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The settings for the Cosmos DB database backing the service.␊ - */␊ - export interface ServiceCosmosDbConfigurationInfo {␊ - /**␊ - * The provisioned throughput for the backing database.␊ - */␊ - offerThroughput?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Export operation configuration information␊ - */␊ - export interface ServiceExportConfigurationInfo {␊ - /**␊ - * The name of the default export storage account.␊ - */␊ - storageAccountName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.AppConfiguration/configurationStores␊ - */␊ - export interface ConfigurationStores {␊ - apiVersion: "2019-02-01-preview"␊ - /**␊ - * The location of the resource. This cannot be changed after the resource is created.␊ - */␊ - location: string␊ - /**␊ - * The name of the configuration store.␊ - */␊ - name: string␊ - /**␊ - * The properties of a configuration store.␊ - */␊ - properties: (ConfigurationStoreProperties | string)␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.AppConfiguration/configurationStores"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a configuration store.␊ - */␊ - export interface ConfigurationStoreProperties {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.HealthcareApis/services␊ - */␊ - export interface Services1 {␊ - apiVersion: "2018-08-20-preview"␊ - /**␊ - * An etag associated with the resource, used for optimistic concurrency when editing it.␊ - */␊ - etag?: string␊ - /**␊ - * Setting indicating whether the service has a managed identity associated with it.␊ - */␊ - identity?: (ResourceIdentity1 | string)␊ - /**␊ - * The kind of the service. Valid values are: fhir, fhir-Stu3 and fhir-R4.␊ - */␊ - kind: (("fhir" | "fhir-Stu3" | "fhir-R4") | string)␊ - /**␊ - * The resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the service instance.␊ - */␊ - name: string␊ - /**␊ - * The properties of a service instance.␊ - */␊ - properties: (ServicesProperties1 | string)␊ - /**␊ - * The resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.HealthcareApis/services"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Setting indicating whether the service has a managed identity associated with it.␊ - */␊ - export interface ResourceIdentity1 {␊ - /**␊ - * Type of identity being specified, currently SystemAssigned and None are allowed.␊ - */␊ - type?: (("SystemAssigned" | "None") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a service instance.␊ - */␊ - export interface ServicesProperties1 {␊ - /**␊ - * The access policies of the service instance.␊ - */␊ - accessPolicies?: (ServiceAccessPolicyEntry1[] | string)␊ - /**␊ - * Authentication configuration information␊ - */␊ - authenticationConfiguration?: (ServiceAuthenticationConfigurationInfo1 | string)␊ - /**␊ - * The settings for the CORS configuration of the service instance.␊ - */␊ - corsConfiguration?: (ServiceCorsConfigurationInfo1 | string)␊ - /**␊ - * The settings for the Cosmos DB database backing the service.␊ - */␊ - cosmosDbConfiguration?: (ServiceCosmosDbConfigurationInfo1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An access policy entry.␊ - */␊ - export interface ServiceAccessPolicyEntry1 {␊ - /**␊ - * An object ID that is allowed access to the FHIR service.␊ - */␊ - objectId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authentication configuration information␊ - */␊ - export interface ServiceAuthenticationConfigurationInfo1 {␊ - /**␊ - * The audience url for the service␊ - */␊ - audience?: string␊ - /**␊ - * The authority url for the service␊ - */␊ - authority?: string␊ - /**␊ - * If the SMART on FHIR proxy is enabled␊ - */␊ - smartProxyEnabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The settings for the CORS configuration of the service instance.␊ - */␊ - export interface ServiceCorsConfigurationInfo1 {␊ - /**␊ - * If credentials are allowed via CORS.␊ - */␊ - allowCredentials?: (boolean | string)␊ - /**␊ - * The headers to be allowed via CORS.␊ - */␊ - headers?: (string[] | string)␊ - /**␊ - * The max age to be allowed via CORS.␊ - */␊ - maxAge?: (number | string)␊ - /**␊ - * The methods to be allowed via CORS.␊ - */␊ - methods?: (string[] | string)␊ - /**␊ - * The origins to be allowed via CORS.␊ - */␊ - origins?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The settings for the Cosmos DB database backing the service.␊ - */␊ - export interface ServiceCosmosDbConfigurationInfo1 {␊ - /**␊ - * The provisioned throughput for the backing database.␊ - */␊ - offerThroughput?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Genomics/accounts␊ - */␊ - export interface Accounts {␊ - name: string␊ - type: "Microsoft.Genomics/accounts"␊ - apiVersion: "2017-08-01-preview"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Must exist in the request. Must not be null.␊ - */␊ - properties: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/FrontDoorWebApplicationFirewallPolicies␊ - */␊ - export interface FrontDoorWebApplicationFirewallPolicies {␊ - apiVersion: "2019-03-01"␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the Web Application Firewall Policy.␊ - */␊ - name: string␊ - /**␊ - * Defines web application firewall policy properties.␊ - */␊ - properties: (WebApplicationFirewallPolicyProperties | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Network/FrontDoorWebApplicationFirewallPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines web application firewall policy properties.␊ - */␊ - export interface WebApplicationFirewallPolicyProperties {␊ - /**␊ - * Defines contents of custom rules␊ - */␊ - customRules?: (CustomRuleList | string)␊ - /**␊ - * Defines the list of managed rule sets for the policy.␊ - */␊ - managedRules?: (ManagedRuleSetList | string)␊ - /**␊ - * Defines top-level WebApplicationFirewallPolicy configuration settings.␊ - */␊ - policySettings?: (PolicySettings | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines contents of custom rules␊ - */␊ - export interface CustomRuleList {␊ - /**␊ - * List of rules␊ - */␊ - rules?: (CustomRule[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines contents of a web application rule␊ - */␊ - export interface CustomRule {␊ - /**␊ - * Describes what action to be applied when rule matches.␊ - */␊ - action: (("Allow" | "Block" | "Log" | "Redirect") | string)␊ - /**␊ - * Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified.␊ - */␊ - enabledState?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * List of match conditions.␊ - */␊ - matchConditions: (MatchCondition[] | string)␊ - /**␊ - * Describes the name of the rule.␊ - */␊ - name?: string␊ - /**␊ - * Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value.␊ - */␊ - priority: (number | string)␊ - /**␊ - * Defines rate limit duration. Default is 1 minute.␊ - */␊ - rateLimitDurationInMinutes?: (number | string)␊ - /**␊ - * Defines rate limit threshold.␊ - */␊ - rateLimitThreshold?: (number | string)␊ - /**␊ - * Describes type of rule.␊ - */␊ - ruleType: (("MatchRule" | "RateLimitRule") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Define a match condition.␊ - */␊ - export interface MatchCondition {␊ - /**␊ - * List of possible match values.␊ - */␊ - matchValue: (string[] | string)␊ - /**␊ - * Match variable to compare against.␊ - */␊ - matchVariable: (("RemoteAddr" | "RequestMethod" | "QueryString" | "PostArgs" | "RequestUri" | "RequestHeader" | "RequestBody" | "Cookies") | string)␊ - /**␊ - * Describes if the result of this condition should be negated.␊ - */␊ - negateCondition?: (boolean | string)␊ - /**␊ - * Describes operator to be matched.␊ - */␊ - operator: (("Any" | "IPMatch" | "GeoMatch" | "Equal" | "Contains" | "LessThan" | "GreaterThan" | "LessThanOrEqual" | "GreaterThanOrEqual" | "BeginsWith" | "EndsWith" | "RegEx") | string)␊ - /**␊ - * Selector can used to match against a specific key from QueryString, PostArgs, RequestHeader or Cookies.␊ - */␊ - selector?: string␊ - /**␊ - * List of transforms.␊ - */␊ - transforms?: (("Lowercase" | "Uppercase" | "Trim" | "UrlDecode" | "UrlEncode" | "RemoveNulls")[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines the list of managed rule sets for the policy.␊ - */␊ - export interface ManagedRuleSetList {␊ - /**␊ - * List of rule sets.␊ - */␊ - managedRuleSets?: (ManagedRuleSet[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines a managed rule set.␊ - */␊ - export interface ManagedRuleSet {␊ - /**␊ - * Defines the rule group overrides to apply to the rule set.␊ - */␊ - ruleGroupOverrides?: (ManagedRuleGroupOverride[] | string)␊ - /**␊ - * Defines the rule set type to use.␊ - */␊ - ruleSetType: string␊ - /**␊ - * Defines the version of the rule set to use.␊ - */␊ - ruleSetVersion: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines a managed rule group override setting.␊ - */␊ - export interface ManagedRuleGroupOverride {␊ - /**␊ - * Describes the managed rule group to override.␊ - */␊ - ruleGroupName: string␊ - /**␊ - * List of rules that will be disabled. If none specified, all rules in the group will be disabled.␊ - */␊ - rules?: (ManagedRuleOverride[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines a managed rule group override setting.␊ - */␊ - export interface ManagedRuleOverride {␊ - /**␊ - * Describes the override action to be applied when rule matches.␊ - */␊ - action?: (("Allow" | "Block" | "Log" | "Redirect") | string)␊ - /**␊ - * Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified.␊ - */␊ - enabledState?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * Identifier for the managed rule.␊ - */␊ - ruleId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines top-level WebApplicationFirewallPolicy configuration settings.␊ - */␊ - export interface PolicySettings {␊ - /**␊ - * If the action type is block, customer can override the response body. The body must be specified in base64 encoding.␊ - */␊ - customBlockResponseBody?: string␊ - /**␊ - * If the action type is block, customer can override the response status code.␊ - */␊ - customBlockResponseStatusCode?: (number | string)␊ - /**␊ - * Describes if the policy is in enabled or disabled state. Defaults to Enabled if not specified.␊ - */␊ - enabledState?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * Describes if it is in detection mode or prevention mode at policy level.␊ - */␊ - mode?: (("Prevention" | "Detection") | string)␊ - /**␊ - * If action type is redirect, this field represents redirect URL for the client.␊ - */␊ - redirectUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/frontDoors␊ - */␊ - export interface FrontDoors {␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * Name of the Front Door which is globally unique.␊ - */␊ - name: string␊ - /**␊ - * The JSON object that contains the properties required to create an endpoint.␊ - */␊ - properties: (FrontDoorProperties | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Network/frontDoors"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The JSON object that contains the properties required to create an endpoint.␊ - */␊ - export interface FrontDoorProperties {␊ - /**␊ - * Backend pools available to routing rules.␊ - */␊ - backendPools?: (BackendPool[] | string)␊ - /**␊ - * Settings that apply to all backend pools.␊ - */␊ - backendPoolsSettings?: (BackendPoolsSettings | string)␊ - /**␊ - * Operational status of the Front Door load balancer. Permitted values are 'Enabled' or 'Disabled'.␊ - */␊ - enabledState?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * A friendly name for the frontDoor␊ - */␊ - friendlyName?: string␊ - /**␊ - * Frontend endpoints available to routing rules.␊ - */␊ - frontendEndpoints?: (FrontendEndpoint[] | string)␊ - /**␊ - * Health probe settings associated with this Front Door instance.␊ - */␊ - healthProbeSettings?: (HealthProbeSettingsModel[] | string)␊ - /**␊ - * Load balancing settings associated with this Front Door instance.␊ - */␊ - loadBalancingSettings?: (LoadBalancingSettingsModel[] | string)␊ - /**␊ - * Resource status of the Front Door.␊ - */␊ - resourceState?: (("Creating" | "Enabling" | "Enabled" | "Disabling" | "Disabled" | "Deleting") | string)␊ - /**␊ - * Routing rules associated with this Front Door.␊ - */␊ - routingRules?: (RoutingRule[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A backend pool is a collection of backends that can be routed to.␊ - */␊ - export interface BackendPool {␊ - /**␊ - * Resource ID.␊ - */␊ - id?: string␊ - /**␊ - * Resource name.␊ - */␊ - name?: string␊ - /**␊ - * The JSON object that contains the properties required to create a routing rule.␊ - */␊ - properties?: (BackendPoolProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The JSON object that contains the properties required to create a routing rule.␊ - */␊ - export interface BackendPoolProperties {␊ - /**␊ - * The set of backends for this pool␊ - */␊ - backends?: (Backend[] | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - healthProbeSettings?: (SubResource | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - loadBalancingSettings?: (SubResource | string)␊ - /**␊ - * Resource status.␊ - */␊ - resourceState?: (("Creating" | "Enabling" | "Enabled" | "Disabling" | "Disabled" | "Deleting") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address of a frontDoor load balancer.␊ - */␊ - export interface Backend {␊ - /**␊ - * Location of the backend (IP address or FQDN)␊ - */␊ - address?: string␊ - /**␊ - * The value to use as the host header sent to the backend. If blank or unspecified, this defaults to the incoming host.␊ - */␊ - backendHostHeader?: string␊ - /**␊ - * Whether to enable use of this backend. Permitted values are 'Enabled' or 'Disabled'.␊ - */␊ - enabledState?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * The HTTP TCP port number. Must be between 1 and 65535.␊ - */␊ - httpPort?: (number | string)␊ - /**␊ - * The HTTPS TCP port number. Must be between 1 and 65535.␊ - */␊ - httpsPort?: (number | string)␊ - /**␊ - * Priority to use for load balancing. Higher priorities will not be used for load balancing if any lower priority backend is healthy.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * Weight of this endpoint for load balancing purposes.␊ - */␊ - weight?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Reference to another subresource.␊ - */␊ - export interface SubResource {␊ - /**␊ - * Resource ID.␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Settings that apply to all backend pools.␊ - */␊ - export interface BackendPoolsSettings {␊ - /**␊ - * Whether to enforce certificate name check on HTTPS requests to all backend pools. No effect on non-HTTPS requests.␊ - */␊ - enforceCertificateNameCheck?: (("Enabled" | "Disabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A frontend endpoint used for routing.␊ - */␊ - export interface FrontendEndpoint {␊ - /**␊ - * Resource ID.␊ - */␊ - id?: string␊ - /**␊ - * Resource name.␊ - */␊ - name?: string␊ - /**␊ - * The JSON object that contains the properties required to create a frontend endpoint.␊ - */␊ - properties?: (FrontendEndpointProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The JSON object that contains the properties required to create a frontend endpoint.␊ - */␊ - export interface FrontendEndpointProperties {␊ - /**␊ - * The host name of the frontendEndpoint. Must be a domain name.␊ - */␊ - hostName?: string␊ - /**␊ - * Resource status.␊ - */␊ - resourceState?: (("Creating" | "Enabling" | "Enabled" | "Disabling" | "Disabled" | "Deleting") | string)␊ - /**␊ - * Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled'.␊ - */␊ - sessionAffinityEnabledState?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * UNUSED. This field will be ignored. The TTL to use in seconds for session affinity, if applicable.␊ - */␊ - sessionAffinityTtlSeconds?: (number | string)␊ - /**␊ - * Defines the Web Application Firewall policy for each host (if applicable)␊ - */␊ - webApplicationFirewallPolicyLink?: (FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLink | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines the Web Application Firewall policy for each host (if applicable)␊ - */␊ - export interface FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLink {␊ - /**␊ - * Resource ID.␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Load balancing settings for a backend pool␊ - */␊ - export interface HealthProbeSettingsModel {␊ - /**␊ - * Resource ID.␊ - */␊ - id?: string␊ - /**␊ - * Resource name.␊ - */␊ - name?: string␊ - /**␊ - * The JSON object that contains the properties required to create a health probe settings.␊ - */␊ - properties?: (HealthProbeSettingsProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The JSON object that contains the properties required to create a health probe settings.␊ - */␊ - export interface HealthProbeSettingsProperties {␊ - /**␊ - * The number of seconds between health probes.␊ - */␊ - intervalInSeconds?: (number | string)␊ - /**␊ - * The path to use for the health probe. Default is /␊ - */␊ - path?: string␊ - /**␊ - * Protocol scheme to use for this probe.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Resource status.␊ - */␊ - resourceState?: (("Creating" | "Enabling" | "Enabled" | "Disabling" | "Disabled" | "Deleting") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Load balancing settings for a backend pool␊ - */␊ - export interface LoadBalancingSettingsModel {␊ - /**␊ - * Resource ID.␊ - */␊ - id?: string␊ - /**␊ - * Resource name.␊ - */␊ - name?: string␊ - /**␊ - * The JSON object that contains the properties required to create load balancing settings␊ - */␊ - properties?: (LoadBalancingSettingsProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The JSON object that contains the properties required to create load balancing settings␊ - */␊ - export interface LoadBalancingSettingsProperties {␊ - /**␊ - * The additional latency in milliseconds for probes to fall into the lowest latency bucket␊ - */␊ - additionalLatencyMilliseconds?: (number | string)␊ - /**␊ - * Resource status.␊ - */␊ - resourceState?: (("Creating" | "Enabling" | "Enabled" | "Disabling" | "Disabled" | "Deleting") | string)␊ - /**␊ - * The number of samples to consider for load balancing decisions␊ - */␊ - sampleSize?: (number | string)␊ - /**␊ - * The number of samples within the sample period that must succeed␊ - */␊ - successfulSamplesRequired?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A routing rule represents a specification for traffic to treat and where to send it, along with health probe information.␊ - */␊ - export interface RoutingRule {␊ - /**␊ - * Resource ID.␊ - */␊ - id?: string␊ - /**␊ - * Resource name.␊ - */␊ - name?: string␊ - /**␊ - * The JSON object that contains the properties required to create a routing rule.␊ - */␊ - properties?: (RoutingRuleProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The JSON object that contains the properties required to create a routing rule.␊ - */␊ - export interface RoutingRuleProperties {␊ - /**␊ - * Protocol schemes to match for this rule␊ - */␊ - acceptedProtocols?: (("Http" | "Https")[] | string)␊ - /**␊ - * Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'.␊ - */␊ - enabledState?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Frontend endpoints associated with this rule␊ - */␊ - frontendEndpoints?: (SubResource[] | string)␊ - /**␊ - * The route patterns of the rule.␊ - */␊ - patternsToMatch?: (string[] | string)␊ - /**␊ - * Resource status.␊ - */␊ - resourceState?: (("Creating" | "Enabling" | "Enabled" | "Disabling" | "Disabled" | "Deleting") | string)␊ - /**␊ - * Base class for all types of Route.␊ - */␊ - routeConfiguration?: (RouteConfiguration | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes Forwarding Route.␊ - */␊ - export interface ForwardingConfiguration {␊ - "@odata.type": "#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration"␊ - /**␊ - * Reference to another subresource.␊ - */␊ - backendPool?: (SubResource | string)␊ - /**␊ - * Caching settings for a caching-type route. To disable caching, do not provide a cacheConfiguration object.␊ - */␊ - cacheConfiguration?: (CacheConfiguration | string)␊ - /**␊ - * A custom path used to rewrite resource paths matched by this rule. Leave empty to use incoming path.␊ - */␊ - customForwardingPath?: string␊ - /**␊ - * Protocol this rule will use when forwarding traffic to backends.␊ - */␊ - forwardingProtocol?: (("HttpOnly" | "HttpsOnly" | "MatchRequest") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Caching settings for a caching-type route. To disable caching, do not provide a cacheConfiguration object.␊ - */␊ - export interface CacheConfiguration {␊ - /**␊ - * Whether to use dynamic compression for cached content.␊ - */␊ - dynamicCompression?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Treatment of URL query terms when forming the cache key.␊ - */␊ - queryParameterStripDirective?: (("StripNone" | "StripAll") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes Redirect Route.␊ - */␊ - export interface RedirectConfiguration {␊ - "@odata.type": "#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration"␊ - /**␊ - * Fragment to add to the redirect URL. Fragment is the part of the URL that comes after #. Do not include the #.␊ - */␊ - customFragment?: string␊ - /**␊ - * Host to redirect. Leave empty to use the incoming host as the destination host.␊ - */␊ - customHost?: string␊ - /**␊ - * The full path to redirect. Path cannot be empty and must start with /. Leave empty to use the incoming path as destination path.␊ - */␊ - customPath?: string␊ - /**␊ - * The set of query strings to be placed in the redirect URL. Setting this value would replace any existing query string; leave empty to preserve the incoming query string. Query string must be in = format. The first ? and & will be added automatically so do not include them in the front, but do separate multiple query strings with &.␊ - */␊ - customQueryString?: string␊ - /**␊ - * The protocol of the destination to where the traffic is redirected.␊ - */␊ - redirectProtocol?: (("HttpOnly" | "HttpsOnly" | "MatchRequest") | string)␊ - /**␊ - * The redirect type the rule will use when redirecting traffic.␊ - */␊ - redirectType?: (("Moved" | "Found" | "TemporaryRedirect" | "PermanentRedirect") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/frontDoors␊ - */␊ - export interface FrontDoors1 {␊ - apiVersion: "2019-05-01"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * Name of the Front Door which is globally unique.␊ - */␊ - name: string␊ - /**␊ - * The JSON object that contains the properties required to create an endpoint.␊ - */␊ - properties: (FrontDoorProperties1 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Network/frontDoors"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The JSON object that contains the properties required to create an endpoint.␊ - */␊ - export interface FrontDoorProperties1 {␊ - /**␊ - * Backend pools available to routing rules.␊ - */␊ - backendPools?: (BackendPool1[] | string)␊ - /**␊ - * Settings that apply to all backend pools.␊ - */␊ - backendPoolsSettings?: (BackendPoolsSettings1 | string)␊ - /**␊ - * Operational status of the Front Door load balancer. Permitted values are 'Enabled' or 'Disabled'.␊ - */␊ - enabledState?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * A friendly name for the frontDoor␊ - */␊ - friendlyName?: string␊ - /**␊ - * Frontend endpoints available to routing rules.␊ - */␊ - frontendEndpoints?: (FrontendEndpoint1[] | string)␊ - /**␊ - * Health probe settings associated with this Front Door instance.␊ - */␊ - healthProbeSettings?: (HealthProbeSettingsModel1[] | string)␊ - /**␊ - * Load balancing settings associated with this Front Door instance.␊ - */␊ - loadBalancingSettings?: (LoadBalancingSettingsModel1[] | string)␊ - /**␊ - * Resource status of the Front Door.␊ - */␊ - resourceState?: (("Creating" | "Enabling" | "Enabled" | "Disabling" | "Disabled" | "Deleting") | string)␊ - /**␊ - * Routing rules associated with this Front Door.␊ - */␊ - routingRules?: (RoutingRule1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A backend pool is a collection of backends that can be routed to.␊ - */␊ - export interface BackendPool1 {␊ - /**␊ - * Resource ID.␊ - */␊ - id?: string␊ - /**␊ - * Resource name.␊ - */␊ - name?: string␊ - /**␊ - * The JSON object that contains the properties required to create a routing rule.␊ - */␊ - properties?: (BackendPoolProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The JSON object that contains the properties required to create a routing rule.␊ - */␊ - export interface BackendPoolProperties1 {␊ - /**␊ - * The set of backends for this pool␊ - */␊ - backends?: (Backend1[] | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - healthProbeSettings?: (SubResource1 | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - loadBalancingSettings?: (SubResource1 | string)␊ - /**␊ - * Resource status.␊ - */␊ - resourceState?: (("Creating" | "Enabling" | "Enabled" | "Disabling" | "Disabled" | "Deleting") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address of a frontDoor load balancer.␊ - */␊ - export interface Backend1 {␊ - /**␊ - * Location of the backend (IP address or FQDN)␊ - */␊ - address?: string␊ - /**␊ - * The value to use as the host header sent to the backend. If blank or unspecified, this defaults to the incoming host.␊ - */␊ - backendHostHeader?: string␊ - /**␊ - * Whether to enable use of this backend. Permitted values are 'Enabled' or 'Disabled'.␊ - */␊ - enabledState?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * The HTTP TCP port number. Must be between 1 and 65535.␊ - */␊ - httpPort?: (number | string)␊ - /**␊ - * The HTTPS TCP port number. Must be between 1 and 65535.␊ - */␊ - httpsPort?: (number | string)␊ - /**␊ - * Priority to use for load balancing. Higher priorities will not be used for load balancing if any lower priority backend is healthy.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * Weight of this endpoint for load balancing purposes.␊ - */␊ - weight?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Reference to another subresource.␊ - */␊ - export interface SubResource1 {␊ - /**␊ - * Resource ID.␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Settings that apply to all backend pools.␊ - */␊ - export interface BackendPoolsSettings1 {␊ - /**␊ - * Whether to enforce certificate name check on HTTPS requests to all backend pools. No effect on non-HTTPS requests.␊ - */␊ - enforceCertificateNameCheck?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Send and receive timeout on forwarding request to the backend. When timeout is reached, the request fails and returns.␊ - */␊ - sendRecvTimeoutSeconds?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A frontend endpoint used for routing.␊ - */␊ - export interface FrontendEndpoint1 {␊ - /**␊ - * Resource ID.␊ - */␊ - id?: string␊ - /**␊ - * Resource name.␊ - */␊ - name?: string␊ - /**␊ - * The JSON object that contains the properties required to create a frontend endpoint.␊ - */␊ - properties?: (FrontendEndpointProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The JSON object that contains the properties required to create a frontend endpoint.␊ - */␊ - export interface FrontendEndpointProperties1 {␊ - /**␊ - * The host name of the frontendEndpoint. Must be a domain name.␊ - */␊ - hostName?: string␊ - /**␊ - * Resource status.␊ - */␊ - resourceState?: (("Creating" | "Enabling" | "Enabled" | "Disabling" | "Disabled" | "Deleting") | string)␊ - /**␊ - * Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled'.␊ - */␊ - sessionAffinityEnabledState?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * UNUSED. This field will be ignored. The TTL to use in seconds for session affinity, if applicable.␊ - */␊ - sessionAffinityTtlSeconds?: (number | string)␊ - /**␊ - * Defines the Web Application Firewall policy for each host (if applicable)␊ - */␊ - webApplicationFirewallPolicyLink?: (FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLink1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines the Web Application Firewall policy for each host (if applicable)␊ - */␊ - export interface FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLink1 {␊ - /**␊ - * Resource ID.␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Load balancing settings for a backend pool␊ - */␊ - export interface HealthProbeSettingsModel1 {␊ - /**␊ - * Resource ID.␊ - */␊ - id?: string␊ - /**␊ - * Resource name.␊ - */␊ - name?: string␊ - /**␊ - * The JSON object that contains the properties required to create a health probe settings.␊ - */␊ - properties?: (HealthProbeSettingsProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The JSON object that contains the properties required to create a health probe settings.␊ - */␊ - export interface HealthProbeSettingsProperties1 {␊ - /**␊ - * Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool.␊ - */␊ - enabledState?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Configures which HTTP method to use to probe the backends defined under backendPools.␊ - */␊ - healthProbeMethod?: (("GET" | "HEAD") | string)␊ - /**␊ - * The number of seconds between health probes.␊ - */␊ - intervalInSeconds?: (number | string)␊ - /**␊ - * The path to use for the health probe. Default is /␊ - */␊ - path?: string␊ - /**␊ - * Protocol scheme to use for this probe.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Resource status.␊ - */␊ - resourceState?: (("Creating" | "Enabling" | "Enabled" | "Disabling" | "Disabled" | "Deleting") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Load balancing settings for a backend pool␊ - */␊ - export interface LoadBalancingSettingsModel1 {␊ - /**␊ - * Resource ID.␊ - */␊ - id?: string␊ - /**␊ - * Resource name.␊ - */␊ - name?: string␊ - /**␊ - * The JSON object that contains the properties required to create load balancing settings␊ - */␊ - properties?: (LoadBalancingSettingsProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The JSON object that contains the properties required to create load balancing settings␊ - */␊ - export interface LoadBalancingSettingsProperties1 {␊ - /**␊ - * The additional latency in milliseconds for probes to fall into the lowest latency bucket␊ - */␊ - additionalLatencyMilliseconds?: (number | string)␊ - /**␊ - * Resource status.␊ - */␊ - resourceState?: (("Creating" | "Enabling" | "Enabled" | "Disabling" | "Disabled" | "Deleting") | string)␊ - /**␊ - * The number of samples to consider for load balancing decisions␊ - */␊ - sampleSize?: (number | string)␊ - /**␊ - * The number of samples within the sample period that must succeed␊ - */␊ - successfulSamplesRequired?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A routing rule represents a specification for traffic to treat and where to send it, along with health probe information.␊ - */␊ - export interface RoutingRule1 {␊ - /**␊ - * Resource ID.␊ - */␊ - id?: string␊ - /**␊ - * Resource name.␊ - */␊ - name?: string␊ - /**␊ - * The JSON object that contains the properties required to create a routing rule.␊ - */␊ - properties?: (RoutingRuleProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The JSON object that contains the properties required to create a routing rule.␊ - */␊ - export interface RoutingRuleProperties1 {␊ - /**␊ - * Protocol schemes to match for this rule␊ - */␊ - acceptedProtocols?: (("Http" | "Https")[] | string)␊ - /**␊ - * Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'.␊ - */␊ - enabledState?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Frontend endpoints associated with this rule␊ - */␊ - frontendEndpoints?: (SubResource1[] | string)␊ - /**␊ - * The route patterns of the rule.␊ - */␊ - patternsToMatch?: (string[] | string)␊ - /**␊ - * Resource status.␊ - */␊ - resourceState?: (("Creating" | "Enabling" | "Enabled" | "Disabling" | "Disabled" | "Deleting") | string)␊ - /**␊ - * Base class for all types of Route.␊ - */␊ - routeConfiguration?: (RouteConfiguration1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes Forwarding Route.␊ - */␊ - export interface ForwardingConfiguration1 {␊ - "@odata.type": "#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration"␊ - /**␊ - * Reference to another subresource.␊ - */␊ - backendPool?: (SubResource1 | string)␊ - /**␊ - * Caching settings for a caching-type route. To disable caching, do not provide a cacheConfiguration object.␊ - */␊ - cacheConfiguration?: (CacheConfiguration1 | string)␊ - /**␊ - * A custom path used to rewrite resource paths matched by this rule. Leave empty to use incoming path.␊ - */␊ - customForwardingPath?: string␊ - /**␊ - * Protocol this rule will use when forwarding traffic to backends.␊ - */␊ - forwardingProtocol?: (("HttpOnly" | "HttpsOnly" | "MatchRequest") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Caching settings for a caching-type route. To disable caching, do not provide a cacheConfiguration object.␊ - */␊ - export interface CacheConfiguration1 {␊ - /**␊ - * Whether to use dynamic compression for cached content.␊ - */␊ - dynamicCompression?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Treatment of URL query terms when forming the cache key.␊ - */␊ - queryParameterStripDirective?: (("StripNone" | "StripAll") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes Redirect Route.␊ - */␊ - export interface RedirectConfiguration1 {␊ - "@odata.type": "#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration"␊ - /**␊ - * Fragment to add to the redirect URL. Fragment is the part of the URL that comes after #. Do not include the #.␊ - */␊ - customFragment?: string␊ - /**␊ - * Host to redirect. Leave empty to use the incoming host as the destination host.␊ - */␊ - customHost?: string␊ - /**␊ - * The full path to redirect. Path cannot be empty and must start with /. Leave empty to use the incoming path as destination path.␊ - */␊ - customPath?: string␊ - /**␊ - * The set of query strings to be placed in the redirect URL. Setting this value would replace any existing query string; leave empty to preserve the incoming query string. Query string must be in = format. The first ? and & will be added automatically so do not include them in the front, but do separate multiple query strings with &.␊ - */␊ - customQueryString?: string␊ - /**␊ - * The protocol of the destination to where the traffic is redirected.␊ - */␊ - redirectProtocol?: (("HttpOnly" | "HttpsOnly" | "MatchRequest") | string)␊ - /**␊ - * The redirect type the rule will use when redirecting traffic.␊ - */␊ - redirectType?: (("Moved" | "Found" | "TemporaryRedirect" | "PermanentRedirect") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/FrontDoorWebApplicationFirewallPolicies␊ - */␊ - export interface FrontDoorWebApplicationFirewallPolicies1 {␊ - apiVersion: "2019-10-01"␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the Web Application Firewall Policy.␊ - */␊ - name: string␊ - /**␊ - * Defines web application firewall policy properties.␊ - */␊ - properties: (WebApplicationFirewallPolicyProperties1 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Network/FrontDoorWebApplicationFirewallPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines web application firewall policy properties.␊ - */␊ - export interface WebApplicationFirewallPolicyProperties1 {␊ - /**␊ - * Defines contents of custom rules␊ - */␊ - customRules?: (CustomRuleList1 | string)␊ - /**␊ - * Defines the list of managed rule sets for the policy.␊ - */␊ - managedRules?: (ManagedRuleSetList1 | string)␊ - /**␊ - * Defines top-level WebApplicationFirewallPolicy configuration settings.␊ - */␊ - policySettings?: (PolicySettings1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines contents of custom rules␊ - */␊ - export interface CustomRuleList1 {␊ - /**␊ - * List of rules␊ - */␊ - rules?: (CustomRule1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines contents of a web application rule␊ - */␊ - export interface CustomRule1 {␊ - /**␊ - * Describes what action to be applied when rule matches.␊ - */␊ - action: (("Allow" | "Block" | "Log" | "Redirect") | string)␊ - /**␊ - * Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified.␊ - */␊ - enabledState?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * List of match conditions.␊ - */␊ - matchConditions: (MatchCondition1[] | string)␊ - /**␊ - * Describes the name of the rule.␊ - */␊ - name?: string␊ - /**␊ - * Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value.␊ - */␊ - priority: (number | string)␊ - /**␊ - * Time window for resetting the rate limit count. Default is 1 minute.␊ - */␊ - rateLimitDurationInMinutes?: (number | string)␊ - /**␊ - * Number of allowed requests per client within the time window.␊ - */␊ - rateLimitThreshold?: (number | string)␊ - /**␊ - * Describes type of rule.␊ - */␊ - ruleType: (("MatchRule" | "RateLimitRule") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Define a match condition.␊ - */␊ - export interface MatchCondition1 {␊ - /**␊ - * List of possible match values.␊ - */␊ - matchValue: (string[] | string)␊ - /**␊ - * Request variable to compare with.␊ - */␊ - matchVariable: (("RemoteAddr" | "RequestMethod" | "QueryString" | "PostArgs" | "RequestUri" | "RequestHeader" | "RequestBody" | "Cookies" | "SocketAddr") | string)␊ - /**␊ - * Describes if the result of this condition should be negated.␊ - */␊ - negateCondition?: (boolean | string)␊ - /**␊ - * Comparison type to use for matching with the variable value.␊ - */␊ - operator: (("Any" | "IPMatch" | "GeoMatch" | "Equal" | "Contains" | "LessThan" | "GreaterThan" | "LessThanOrEqual" | "GreaterThanOrEqual" | "BeginsWith" | "EndsWith" | "RegEx") | string)␊ - /**␊ - * Match against a specific key from the QueryString, PostArgs, RequestHeader or Cookies variables. Default is null.␊ - */␊ - selector?: string␊ - /**␊ - * List of transforms.␊ - */␊ - transforms?: (("Lowercase" | "Uppercase" | "Trim" | "UrlDecode" | "UrlEncode" | "RemoveNulls")[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines the list of managed rule sets for the policy.␊ - */␊ - export interface ManagedRuleSetList1 {␊ - /**␊ - * List of rule sets.␊ - */␊ - managedRuleSets?: (ManagedRuleSet1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines a managed rule set.␊ - */␊ - export interface ManagedRuleSet1 {␊ - /**␊ - * Describes the exclusions that are applied to all rules in the set.␊ - */␊ - exclusions?: (ManagedRuleExclusion[] | string)␊ - /**␊ - * Defines the rule group overrides to apply to the rule set.␊ - */␊ - ruleGroupOverrides?: (ManagedRuleGroupOverride1[] | string)␊ - /**␊ - * Defines the rule set type to use.␊ - */␊ - ruleSetType: string␊ - /**␊ - * Defines the version of the rule set to use.␊ - */␊ - ruleSetVersion: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Exclude variables from managed rule evaluation.␊ - */␊ - export interface ManagedRuleExclusion {␊ - /**␊ - * The variable type to be excluded.␊ - */␊ - matchVariable: (("RequestHeaderNames" | "RequestCookieNames" | "QueryStringArgNames" | "RequestBodyPostArgNames") | string)␊ - /**␊ - * Selector value for which elements in the collection this exclusion applies to.␊ - */␊ - selector: string␊ - /**␊ - * Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to.␊ - */␊ - selectorMatchOperator: (("Equals" | "Contains" | "StartsWith" | "EndsWith" | "EqualsAny") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines a managed rule group override setting.␊ - */␊ - export interface ManagedRuleGroupOverride1 {␊ - /**␊ - * Describes the exclusions that are applied to all rules in the group.␊ - */␊ - exclusions?: (ManagedRuleExclusion[] | string)␊ - /**␊ - * Describes the managed rule group to override.␊ - */␊ - ruleGroupName: string␊ - /**␊ - * List of rules that will be disabled. If none specified, all rules in the group will be disabled.␊ - */␊ - rules?: (ManagedRuleOverride1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines a managed rule group override setting.␊ - */␊ - export interface ManagedRuleOverride1 {␊ - /**␊ - * Describes the override action to be applied when rule matches.␊ - */␊ - action?: (("Allow" | "Block" | "Log" | "Redirect") | string)␊ - /**␊ - * Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified.␊ - */␊ - enabledState?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * Describes the exclusions that are applied to this specific rule.␊ - */␊ - exclusions?: (ManagedRuleExclusion[] | string)␊ - /**␊ - * Identifier for the managed rule.␊ - */␊ - ruleId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines top-level WebApplicationFirewallPolicy configuration settings.␊ - */␊ - export interface PolicySettings1 {␊ - /**␊ - * If the action type is block, customer can override the response body. The body must be specified in base64 encoding.␊ - */␊ - customBlockResponseBody?: string␊ - /**␊ - * If the action type is block, customer can override the response status code.␊ - */␊ - customBlockResponseStatusCode?: (number | string)␊ - /**␊ - * Describes if the policy is in enabled or disabled state. Defaults to Enabled if not specified.␊ - */␊ - enabledState?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * Describes if it is in detection mode or prevention mode at policy level.␊ - */␊ - mode?: (("Prevention" | "Detection") | string)␊ - /**␊ - * If action type is redirect, this field represents redirect URL for the client.␊ - */␊ - redirectUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/NetworkExperimentProfiles␊ - */␊ - export interface NetworkExperimentProfiles {␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * The Profile identifier associated with the Tenant and Partner␊ - */␊ - name: string␊ - /**␊ - * Defines the properties of an experiment␊ - */␊ - properties: (ProfileProperties | string)␊ - resources?: NetworkExperimentProfiles_ExperimentsChildResource[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Network/NetworkExperimentProfiles"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines the properties of an experiment␊ - */␊ - export interface ProfileProperties {␊ - /**␊ - * The state of the Experiment.␊ - */␊ - enabledState?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Resource status.␊ - */␊ - resourceState?: (("Creating" | "Enabling" | "Enabled" | "Disabling" | "Disabled" | "Deleting") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/NetworkExperimentProfiles/Experiments␊ - */␊ - export interface NetworkExperimentProfiles_ExperimentsChildResource {␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * The Experiment identifier associated with the Experiment␊ - */␊ - name: string␊ - /**␊ - * Defines the properties of an experiment␊ - */␊ - properties: (ExperimentProperties | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Experiments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines the properties of an experiment␊ - */␊ - export interface ExperimentProperties {␊ - /**␊ - * The description of the details or intents of the Experiment␊ - */␊ - description?: string␊ - /**␊ - * The state of the Experiment.␊ - */␊ - enabledState?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Defines the endpoint properties␊ - */␊ - endpointA?: (Endpoint | string)␊ - /**␊ - * Defines the endpoint properties␊ - */␊ - endpointB?: (Endpoint | string)␊ - /**␊ - * Resource status.␊ - */␊ - resourceState?: (("Creating" | "Enabling" | "Enabled" | "Disabling" | "Disabled" | "Deleting") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines the endpoint properties␊ - */␊ - export interface Endpoint {␊ - /**␊ - * The endpoint URL␊ - */␊ - endpoint?: string␊ - /**␊ - * The name of the endpoint␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/NetworkExperimentProfiles/Experiments␊ - */␊ - export interface NetworkExperimentProfiles_Experiments {␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * The Experiment identifier associated with the Experiment␊ - */␊ - name: string␊ - /**␊ - * Defines the properties of an experiment␊ - */␊ - properties: (ExperimentProperties | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Network/NetworkExperimentProfiles/Experiments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/frontDoors␊ - */␊ - export interface FrontDoors2 {␊ - apiVersion: "2020-01-01"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * Name of the Front Door which is globally unique.␊ - */␊ - name: string␊ - /**␊ - * The JSON object that contains the properties required to create an endpoint.␊ - */␊ - properties: (FrontDoorProperties2 | string)␊ - resources?: FrontDoorsRulesEnginesChildResource[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Network/frontDoors"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The JSON object that contains the properties required to create an endpoint.␊ - */␊ - export interface FrontDoorProperties2 {␊ - /**␊ - * Backend pools available to routing rules.␊ - */␊ - backendPools?: (BackendPool2[] | string)␊ - /**␊ - * Settings that apply to all backend pools.␊ - */␊ - backendPoolsSettings?: (BackendPoolsSettings2 | string)␊ - /**␊ - * Operational status of the Front Door load balancer. Permitted values are 'Enabled' or 'Disabled'.␊ - */␊ - enabledState?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * A friendly name for the frontDoor␊ - */␊ - friendlyName?: string␊ - /**␊ - * Frontend endpoints available to routing rules.␊ - */␊ - frontendEndpoints?: (FrontendEndpoint2[] | string)␊ - /**␊ - * Health probe settings associated with this Front Door instance.␊ - */␊ - healthProbeSettings?: (HealthProbeSettingsModel2[] | string)␊ - /**␊ - * Load balancing settings associated with this Front Door instance.␊ - */␊ - loadBalancingSettings?: (LoadBalancingSettingsModel2[] | string)␊ - /**␊ - * Resource status of the Front Door.␊ - */␊ - resourceState?: (("Creating" | "Enabling" | "Enabled" | "Disabling" | "Disabled" | "Deleting") | string)␊ - /**␊ - * Routing rules associated with this Front Door.␊ - */␊ - routingRules?: (RoutingRule2[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A backend pool is a collection of backends that can be routed to.␊ - */␊ - export interface BackendPool2 {␊ - /**␊ - * Resource ID.␊ - */␊ - id?: string␊ - /**␊ - * Resource name.␊ - */␊ - name?: string␊ - /**␊ - * The JSON object that contains the properties required to create a Backend Pool.␊ - */␊ - properties?: (BackendPoolProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The JSON object that contains the properties required to create a Backend Pool.␊ - */␊ - export interface BackendPoolProperties2 {␊ - /**␊ - * The set of backends for this pool␊ - */␊ - backends?: (Backend2[] | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - healthProbeSettings?: (SubResource2 | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - loadBalancingSettings?: (SubResource2 | string)␊ - /**␊ - * Resource status.␊ - */␊ - resourceState?: (("Creating" | "Enabling" | "Enabled" | "Disabling" | "Disabled" | "Deleting") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address of a frontDoor load balancer.␊ - */␊ - export interface Backend2 {␊ - /**␊ - * Location of the backend (IP address or FQDN)␊ - */␊ - address?: string␊ - /**␊ - * The value to use as the host header sent to the backend. If blank or unspecified, this defaults to the incoming host.␊ - */␊ - backendHostHeader?: string␊ - /**␊ - * Whether to enable use of this backend. Permitted values are 'Enabled' or 'Disabled'.␊ - */␊ - enabledState?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * The HTTP TCP port number. Must be between 1 and 65535.␊ - */␊ - httpPort?: (number | string)␊ - /**␊ - * The HTTPS TCP port number. Must be between 1 and 65535.␊ - */␊ - httpsPort?: (number | string)␊ - /**␊ - * Priority to use for load balancing. Higher priorities will not be used for load balancing if any lower priority backend is healthy.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * The Alias of the Private Link resource. Populating this optional field indicates that this backend is 'Private'␊ - */␊ - privateLinkAlias?: string␊ - /**␊ - * A custom message to be included in the approval request to connect to the Private Link␊ - */␊ - privateLinkApprovalMessage?: string␊ - /**␊ - * Weight of this endpoint for load balancing purposes.␊ - */␊ - weight?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Reference to another subresource.␊ - */␊ - export interface SubResource2 {␊ - /**␊ - * Resource ID.␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Settings that apply to all backend pools.␊ - */␊ - export interface BackendPoolsSettings2 {␊ - /**␊ - * Whether to enforce certificate name check on HTTPS requests to all backend pools. No effect on non-HTTPS requests.␊ - */␊ - enforceCertificateNameCheck?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Send and receive timeout on forwarding request to the backend. When timeout is reached, the request fails and returns.␊ - */␊ - sendRecvTimeoutSeconds?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A frontend endpoint used for routing.␊ - */␊ - export interface FrontendEndpoint2 {␊ - /**␊ - * Resource ID.␊ - */␊ - id?: string␊ - /**␊ - * Resource name.␊ - */␊ - name?: string␊ - /**␊ - * The JSON object that contains the properties required to create a frontend endpoint.␊ - */␊ - properties?: (FrontendEndpointProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The JSON object that contains the properties required to create a frontend endpoint.␊ - */␊ - export interface FrontendEndpointProperties2 {␊ - /**␊ - * The host name of the frontendEndpoint. Must be a domain name.␊ - */␊ - hostName?: string␊ - /**␊ - * Resource status.␊ - */␊ - resourceState?: (("Creating" | "Enabling" | "Enabled" | "Disabling" | "Disabled" | "Deleting") | string)␊ - /**␊ - * Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled'.␊ - */␊ - sessionAffinityEnabledState?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * UNUSED. This field will be ignored. The TTL to use in seconds for session affinity, if applicable.␊ - */␊ - sessionAffinityTtlSeconds?: (number | string)␊ - /**␊ - * Defines the Web Application Firewall policy for each host (if applicable)␊ - */␊ - webApplicationFirewallPolicyLink?: (FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLink2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines the Web Application Firewall policy for each host (if applicable)␊ - */␊ - export interface FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLink2 {␊ - /**␊ - * Resource ID.␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Load balancing settings for a backend pool␊ - */␊ - export interface HealthProbeSettingsModel2 {␊ - /**␊ - * Resource ID.␊ - */␊ - id?: string␊ - /**␊ - * Resource name.␊ - */␊ - name?: string␊ - /**␊ - * The JSON object that contains the properties required to create a health probe settings.␊ - */␊ - properties?: (HealthProbeSettingsProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The JSON object that contains the properties required to create a health probe settings.␊ - */␊ - export interface HealthProbeSettingsProperties2 {␊ - /**␊ - * Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool.␊ - */␊ - enabledState?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Configures which HTTP method to use to probe the backends defined under backendPools.␊ - */␊ - healthProbeMethod?: (("GET" | "HEAD") | string)␊ - /**␊ - * The number of seconds between health probes.␊ - */␊ - intervalInSeconds?: (number | string)␊ - /**␊ - * The path to use for the health probe. Default is /␊ - */␊ - path?: string␊ - /**␊ - * Protocol scheme to use for this probe.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Resource status.␊ - */␊ - resourceState?: (("Creating" | "Enabling" | "Enabled" | "Disabling" | "Disabled" | "Deleting") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Load balancing settings for a backend pool␊ - */␊ - export interface LoadBalancingSettingsModel2 {␊ - /**␊ - * Resource ID.␊ - */␊ - id?: string␊ - /**␊ - * Resource name.␊ - */␊ - name?: string␊ - /**␊ - * The JSON object that contains the properties required to create load balancing settings␊ - */␊ - properties?: (LoadBalancingSettingsProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The JSON object that contains the properties required to create load balancing settings␊ - */␊ - export interface LoadBalancingSettingsProperties2 {␊ - /**␊ - * The additional latency in milliseconds for probes to fall into the lowest latency bucket␊ - */␊ - additionalLatencyMilliseconds?: (number | string)␊ - /**␊ - * Resource status.␊ - */␊ - resourceState?: (("Creating" | "Enabling" | "Enabled" | "Disabling" | "Disabled" | "Deleting") | string)␊ - /**␊ - * The number of samples to consider for load balancing decisions␊ - */␊ - sampleSize?: (number | string)␊ - /**␊ - * The number of samples within the sample period that must succeed␊ - */␊ - successfulSamplesRequired?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A routing rule represents a specification for traffic to treat and where to send it, along with health probe information.␊ - */␊ - export interface RoutingRule2 {␊ - /**␊ - * Resource ID.␊ - */␊ - id?: string␊ - /**␊ - * Resource name.␊ - */␊ - name?: string␊ - /**␊ - * The JSON object that contains the properties required to create a routing rule.␊ - */␊ - properties?: (RoutingRuleProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The JSON object that contains the properties required to create a routing rule.␊ - */␊ - export interface RoutingRuleProperties2 {␊ - /**␊ - * Protocol schemes to match for this rule␊ - */␊ - acceptedProtocols?: (("Http" | "Https")[] | string)␊ - /**␊ - * Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'.␊ - */␊ - enabledState?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Frontend endpoints associated with this rule␊ - */␊ - frontendEndpoints?: (SubResource2[] | string)␊ - /**␊ - * The route patterns of the rule.␊ - */␊ - patternsToMatch?: (string[] | string)␊ - /**␊ - * Resource status.␊ - */␊ - resourceState?: (("Creating" | "Enabling" | "Enabled" | "Disabling" | "Disabled" | "Deleting") | string)␊ - /**␊ - * Base class for all types of Route.␊ - */␊ - routeConfiguration?: (RouteConfiguration2 | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - rulesEngine?: (SubResource2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes Forwarding Route.␊ - */␊ - export interface ForwardingConfiguration2 {␊ - "@odata.type": "#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration"␊ - /**␊ - * Reference to another subresource.␊ - */␊ - backendPool?: (SubResource2 | string)␊ - /**␊ - * Caching settings for a caching-type route. To disable caching, do not provide a cacheConfiguration object.␊ - */␊ - cacheConfiguration?: (CacheConfiguration2 | string)␊ - /**␊ - * A custom path used to rewrite resource paths matched by this rule. Leave empty to use incoming path.␊ - */␊ - customForwardingPath?: string␊ - /**␊ - * Protocol this rule will use when forwarding traffic to backends.␊ - */␊ - forwardingProtocol?: (("HttpOnly" | "HttpsOnly" | "MatchRequest") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Caching settings for a caching-type route. To disable caching, do not provide a cacheConfiguration object.␊ - */␊ - export interface CacheConfiguration2 {␊ - /**␊ - * The duration for which the content needs to be cached. Allowed format is in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations). HTTP requires the value to be no more than a year␊ - */␊ - cacheDuration?: string␊ - /**␊ - * Whether to use dynamic compression for cached content.␊ - */␊ - dynamicCompression?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * query parameters to include or exclude (comma separated).␊ - */␊ - queryParameters?: string␊ - /**␊ - * Treatment of URL query terms when forming the cache key.␊ - */␊ - queryParameterStripDirective?: (("StripNone" | "StripAll" | "StripOnly" | "StripAllExcept") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes Redirect Route.␊ - */␊ - export interface RedirectConfiguration2 {␊ - "@odata.type": "#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration"␊ - /**␊ - * Fragment to add to the redirect URL. Fragment is the part of the URL that comes after #. Do not include the #.␊ - */␊ - customFragment?: string␊ - /**␊ - * Host to redirect. Leave empty to use the incoming host as the destination host.␊ - */␊ - customHost?: string␊ - /**␊ - * The full path to redirect. Path cannot be empty and must start with /. Leave empty to use the incoming path as destination path.␊ - */␊ - customPath?: string␊ - /**␊ - * The set of query strings to be placed in the redirect URL. Setting this value would replace any existing query string; leave empty to preserve the incoming query string. Query string must be in = format. The first ? and & will be added automatically so do not include them in the front, but do separate multiple query strings with &.␊ - */␊ - customQueryString?: string␊ - /**␊ - * The protocol of the destination to where the traffic is redirected.␊ - */␊ - redirectProtocol?: (("HttpOnly" | "HttpsOnly" | "MatchRequest") | string)␊ - /**␊ - * The redirect type the rule will use when redirecting traffic.␊ - */␊ - redirectType?: (("Moved" | "Found" | "TemporaryRedirect" | "PermanentRedirect") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/frontDoors/rulesEngines␊ - */␊ - export interface FrontDoorsRulesEnginesChildResource {␊ - apiVersion: "2020-01-01"␊ - /**␊ - * Name of the Rules Engine which is unique within the Front Door.␊ - */␊ - name: string␊ - /**␊ - * The JSON object that contains the properties required to create a Rules Engine Configuration.␊ - */␊ - properties: (RulesEngineProperties | string)␊ - type: "rulesEngines"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The JSON object that contains the properties required to create a Rules Engine Configuration.␊ - */␊ - export interface RulesEngineProperties {␊ - /**␊ - * Resource status.␊ - */␊ - resourceState?: (("Creating" | "Enabling" | "Enabled" | "Disabling" | "Disabled" | "Deleting") | string)␊ - /**␊ - * A list of rules that define a particular Rules Engine Configuration.␊ - */␊ - rules?: (RulesEngineRule[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains a list of match conditions, and an action on how to modify the request/response. If multiple rules match, the actions from one rule that conflict with a previous rule overwrite for a singular action, or append in the case of headers manipulation.␊ - */␊ - export interface RulesEngineRule {␊ - /**␊ - * One or more actions that will execute, modifying the request and/or response.␊ - */␊ - action: (RulesEngineAction | string)␊ - /**␊ - * A list of match conditions that must meet in order for the actions of this rule to run. Having no match conditions means the actions will always run.␊ - */␊ - matchConditions?: (RulesEngineMatchCondition[] | string)␊ - /**␊ - * If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue.␊ - */␊ - matchProcessingBehavior?: (("Continue" | "Stop") | string)␊ - /**␊ - * A name to refer to this specific rule.␊ - */␊ - name: string␊ - /**␊ - * A priority assigned to this rule. ␊ - */␊ - priority: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * One or more actions that will execute, modifying the request and/or response.␊ - */␊ - export interface RulesEngineAction {␊ - /**␊ - * A list of header actions to apply from the request from AFD to the origin.␊ - */␊ - requestHeaderActions?: (HeaderAction[] | string)␊ - /**␊ - * A list of header actions to apply from the response from AFD to the client.␊ - */␊ - responseHeaderActions?: (HeaderAction[] | string)␊ - /**␊ - * Base class for all types of Route.␊ - */␊ - routeConfigurationOverride?: ((ForwardingConfiguration2 | RedirectConfiguration2) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An action that can manipulate an http header.␊ - */␊ - export interface HeaderAction {␊ - /**␊ - * Which type of manipulation to apply to the header.␊ - */␊ - headerActionType: (("Append" | "Delete" | "Overwrite") | string)␊ - /**␊ - * The name of the header this action will apply to.␊ - */␊ - headerName: string␊ - /**␊ - * The value to update the given header name with. This value is not used if the actionType is Delete.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Define a match condition␊ - */␊ - export interface RulesEngineMatchCondition {␊ - /**␊ - * Describes if this is negate condition or not␊ - */␊ - negateCondition?: (boolean | string)␊ - /**␊ - * Match values to match against. The operator will apply to each value in here with OR semantics. If any of them match the variable with the given operator this match condition is considered a match.␊ - */␊ - rulesEngineMatchValue: (string[] | string)␊ - /**␊ - * Match Variable.␊ - */␊ - rulesEngineMatchVariable: (("IsMobile" | "RemoteAddr" | "RequestMethod" | "QueryString" | "PostArgs" | "RequestUri" | "RequestPath" | "RequestFilename" | "RequestFilenameExtension" | "RequestHeader" | "RequestBody" | "RequestScheme") | string)␊ - /**␊ - * Describes operator to apply to the match condition.␊ - */␊ - rulesEngineOperator: (("Any" | "IPMatch" | "GeoMatch" | "Equal" | "Contains" | "LessThan" | "GreaterThan" | "LessThanOrEqual" | "GreaterThanOrEqual" | "BeginsWith" | "EndsWith") | string)␊ - /**␊ - * Name of selector in RequestHeader or RequestBody to be matched␊ - */␊ - selector?: string␊ - /**␊ - * List of transforms␊ - */␊ - transforms?: (("Lowercase" | "Uppercase" | "Trim" | "UrlDecode" | "UrlEncode" | "RemoveNulls")[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/frontDoors/rulesEngines␊ - */␊ - export interface FrontDoorsRulesEngines {␊ - apiVersion: "2020-01-01"␊ - /**␊ - * Name of the Rules Engine which is unique within the Front Door.␊ - */␊ - name: string␊ - /**␊ - * The JSON object that contains the properties required to create a Rules Engine Configuration.␊ - */␊ - properties: (RulesEngineProperties | string)␊ - type: "Microsoft.Network/frontDoors/rulesEngines"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Cache/Redis␊ - */␊ - export interface Redis {␊ - apiVersion: "2017-10-01"␊ - /**␊ - * The geo-location where the resource lives␊ - */␊ - location: string␊ - /**␊ - * The name of the Redis cache.␊ - */␊ - name: string␊ - /**␊ - * Properties supplied to Create Redis operation.␊ - */␊ - properties: (RedisCreateProperties | string)␊ - resources?: (RedisFirewallRulesChildResource | RedisPatchSchedulesChildResource | RedisLinkedServersChildResource)[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Cache/Redis"␊ - /**␊ - * A list of availability zones denoting where the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties supplied to Create Redis operation.␊ - */␊ - export interface RedisCreateProperties {␊ - /**␊ - * Specifies whether the non-ssl Redis server port (6379) is enabled.␊ - */␊ - enableNonSslPort?: (boolean | string)␊ - /**␊ - * All Redis Settings. Few possible keys: rdb-backup-enabled,rdb-storage-connection-string,rdb-backup-frequency,maxmemory-delta,maxmemory-policy,notify-keyspace-events,maxmemory-samples,slowlog-log-slower-than,slowlog-max-len,list-max-ziplist-entries,list-max-ziplist-value,hash-max-ziplist-entries,hash-max-ziplist-value,set-max-intset-entries,zset-max-ziplist-entries,zset-max-ziplist-value etc.␊ - */␊ - redisConfiguration?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The number of shards to be created on a Premium Cluster Cache.␊ - */␊ - shardCount?: (number | string)␊ - /**␊ - * SKU parameters supplied to the create Redis operation.␊ - */␊ - sku: (Sku | string)␊ - /**␊ - * Static IP address. Required when deploying a Redis cache inside an existing Azure Virtual Network.␊ - */␊ - staticIP?: string␊ - /**␊ - * The full resource ID of a subnet in a virtual network to deploy the Redis cache in. Example format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft.{Network|ClassicNetwork}/VirtualNetworks/vnet1/subnets/subnet1␊ - */␊ - subnetId?: string␊ - /**␊ - * A dictionary of tenant settings␊ - */␊ - tenantSettings?: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU parameters supplied to the create Redis operation.␊ - */␊ - export interface Sku {␊ - /**␊ - * The size of the Redis cache to deploy. Valid values: for C (Basic/Standard) family (0, 1, 2, 3, 4, 5, 6), for P (Premium) family (1, 2, 3, 4).␊ - */␊ - capacity: (number | string)␊ - /**␊ - * The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium).␊ - */␊ - family: (("C" | "P") | string)␊ - /**␊ - * The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium).␊ - */␊ - name: (("Basic" | "Standard" | "Premium") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Cache/Redis/firewallRules␊ - */␊ - export interface RedisFirewallRulesChildResource {␊ - apiVersion: "2017-10-01"␊ - /**␊ - * The name of the firewall rule.␊ - */␊ - name: string␊ - /**␊ - * Specifies a range of IP addresses permitted to connect to the cache␊ - */␊ - properties: (RedisFirewallRuleProperties | string)␊ - type: "firewallRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies a range of IP addresses permitted to connect to the cache␊ - */␊ - export interface RedisFirewallRuleProperties {␊ - /**␊ - * highest IP address included in the range␊ - */␊ - endIP: string␊ - /**␊ - * lowest IP address included in the range␊ - */␊ - startIP: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Cache/Redis/patchSchedules␊ - */␊ - export interface RedisPatchSchedulesChildResource {␊ - apiVersion: "2017-10-01"␊ - /**␊ - * Default string modeled as parameter for auto generation to work correctly.␊ - */␊ - name: "default"␊ - /**␊ - * List of patch schedules for a Redis cache.␊ - */␊ - properties: (ScheduleEntries | string)␊ - type: "patchSchedules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * List of patch schedules for a Redis cache.␊ - */␊ - export interface ScheduleEntries {␊ - /**␊ - * List of patch schedules for a Redis cache.␊ - */␊ - scheduleEntries: (ScheduleEntry[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Patch schedule entry for a Premium Redis Cache.␊ - */␊ - export interface ScheduleEntry {␊ - /**␊ - * Day of the week when a cache can be patched.␊ - */␊ - dayOfWeek: (("Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday" | "Sunday" | "Everyday" | "Weekend") | string)␊ - /**␊ - * ISO8601 timespan specifying how much time cache patching can take. ␊ - */␊ - maintenanceWindow?: string␊ - /**␊ - * Start hour after which cache patching can start.␊ - */␊ - startHourUtc: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Cache/Redis/linkedServers␊ - */␊ - export interface RedisLinkedServersChildResource {␊ - apiVersion: "2017-10-01"␊ - /**␊ - * The name of the linked server that is being added to the Redis cache.␊ - */␊ - name: string␊ - /**␊ - * Create properties for a linked server␊ - */␊ - properties: (RedisLinkedServerCreateProperties | string)␊ - type: "linkedServers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Create properties for a linked server␊ - */␊ - export interface RedisLinkedServerCreateProperties {␊ - /**␊ - * Fully qualified resourceId of the linked redis cache.␊ - */␊ - linkedRedisCacheId: string␊ - /**␊ - * Location of the linked redis cache.␊ - */␊ - linkedRedisCacheLocation: string␊ - /**␊ - * Role of the linked server.␊ - */␊ - serverRole: (("Primary" | "Secondary") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Cache/Redis/firewallRules␊ - */␊ - export interface RedisFirewallRules {␊ - apiVersion: "2017-10-01"␊ - /**␊ - * The name of the firewall rule.␊ - */␊ - name: string␊ - /**␊ - * Specifies a range of IP addresses permitted to connect to the cache␊ - */␊ - properties: (RedisFirewallRuleProperties | string)␊ - type: "Microsoft.Cache/Redis/firewallRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Cache/Redis/linkedServers␊ - */␊ - export interface RedisLinkedServers {␊ - apiVersion: "2017-10-01"␊ - /**␊ - * The name of the linked server that is being added to the Redis cache.␊ - */␊ - name: string␊ - /**␊ - * Create properties for a linked server␊ - */␊ - properties: (RedisLinkedServerCreateProperties | string)␊ - type: "Microsoft.Cache/Redis/linkedServers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Cache/Redis/patchSchedules␊ - */␊ - export interface RedisPatchSchedules {␊ - apiVersion: "2017-10-01"␊ - /**␊ - * Default string modeled as parameter for auto generation to work correctly.␊ - */␊ - name: string␊ - /**␊ - * List of patch schedules for a Redis cache.␊ - */␊ - properties: (ScheduleEntries | string)␊ - type: "Microsoft.Cache/Redis/patchSchedules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Search/searchServices␊ - */␊ - export interface SearchServices {␊ - apiVersion: "2015-08-19"␊ - /**␊ - * Identity for the resource.␊ - */␊ - identity?: (Identity | string)␊ - /**␊ - * The geographic location of the resource. This must be one of the supported and registered Azure Geo Regions (for example, West US, East US, Southeast Asia, and so forth). This property is required when creating a new resource.␊ - */␊ - location?: string␊ - /**␊ - * The name of the Azure Cognitive Search service to create or update. Search service names must only contain lowercase letters, digits or dashes, cannot use dash as the first two or last one characters, cannot contain consecutive dashes, and must be between 2 and 60 characters in length. Search service names must be globally unique since they are part of the service URI (https://.search.windows.net). You cannot change the service name after the service is created.␊ - */␊ - name: string␊ - /**␊ - * Properties of the Search service.␊ - */␊ - properties: (SearchServiceProperties | string)␊ - /**␊ - * Defines the SKU of an Azure Cognitive Search Service, which determines price tier and capacity limits.␊ - */␊ - sku?: (Sku1 | string)␊ - /**␊ - * Tags to help categorize the resource in the Azure portal.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Search/searchServices"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the resource.␊ - */␊ - export interface Identity {␊ - /**␊ - * The identity type.␊ - */␊ - type: (("None" | "SystemAssigned") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Search service.␊ - */␊ - export interface SearchServiceProperties {␊ - /**␊ - * Applicable only for the standard3 SKU. You can set this property to enable up to 3 high density partitions that allow up to 1000 indexes, which is much higher than the maximum indexes allowed for any other SKU. For the standard3 SKU, the value is either 'default' or 'highDensity'. For all other SKUs, this value must be 'default'.␊ - */␊ - hostingMode?: (("default" | "highDensity") | string)␊ - /**␊ - * The number of partitions in the Search service; if specified, it can be 1, 2, 3, 4, 6, or 12. Values greater than 1 are only valid for standard SKUs. For 'standard3' services with hostingMode set to 'highDensity', the allowed values are between 1 and 3.␊ - */␊ - partitionCount?: ((number & string) | string)␊ - /**␊ - * The number of replicas in the Search service. If specified, it must be a value between 1 and 12 inclusive for standard SKUs or between 1 and 3 inclusive for basic SKU.␊ - */␊ - replicaCount?: ((number & string) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines the SKU of an Azure Cognitive Search Service, which determines price tier and capacity limits.␊ - */␊ - export interface Sku1 {␊ - /**␊ - * The SKU of the Search service. Valid values include: 'free': Shared service. 'basic': Dedicated service with up to 3 replicas. 'standard': Dedicated service with up to 12 partitions and 12 replicas. 'standard2': Similar to standard, but with more capacity per search unit. 'standard3': The largest Standard offering with up to 12 partitions and 12 replicas (or up to 3 partitions with more indexes if you also set the hostingMode property to 'highDensity'). 'storage_optimized_l1': Supports 1TB per partition, up to 12 partitions. 'storage_optimized_l2': Supports 2TB per partition, up to 12 partitions.'.␊ - */␊ - name?: (("free" | "basic" | "standard" | "standard2" | "standard3" | "storage_optimized_l1" | "storage_optimized_l2") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.AnalysisServices/servers␊ - */␊ - export interface Servers {␊ - apiVersion: "2016-05-16"␊ - /**␊ - * Location of the Analysis Services resource.␊ - */␊ - location: string␊ - /**␊ - * The name of the Analysis Services server. It must be a minimum of 3 characters, and a maximum of 63.␊ - */␊ - name: string␊ - /**␊ - * Properties of Analysis Services resource.␊ - */␊ - properties: (AnalysisServicesServerProperties | string)␊ - /**␊ - * Represents the SKU name and Azure pricing tier for Analysis Services resource.␊ - */␊ - sku: (ResourceSku | string)␊ - /**␊ - * Key-value pairs of additional resource provisioning properties.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.AnalysisServices/servers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Analysis Services resource.␊ - */␊ - export interface AnalysisServicesServerProperties {␊ - /**␊ - * An array of administrator user identities␊ - */␊ - asAdministrators?: (ServerAdministrators | string)␊ - /**␊ - * The container URI of backup blob.␊ - */␊ - backupBlobContainerUri?: string␊ - /**␊ - * The managed mode of the server (0 = not managed, 1 = managed).␊ - */␊ - managedMode?: ((number & string) | string)␊ - /**␊ - * The server monitor mode for AS server␊ - */␊ - serverMonitorMode?: ((number & string) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An array of administrator user identities␊ - */␊ - export interface ServerAdministrators {␊ - /**␊ - * An array of administrator user identities.␊ - */␊ - members?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents the SKU name and Azure pricing tier for Analysis Services resource.␊ - */␊ - export interface ResourceSku {␊ - /**␊ - * The number of instances in the read only query pool.␊ - */␊ - capacity?: ((number & string) | string)␊ - /**␊ - * Name of the SKU level.␊ - */␊ - name: string␊ - /**␊ - * The name of the Azure pricing tier to which the SKU applies.␊ - */␊ - tier?: (("Development" | "Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.AnalysisServices/servers␊ - */␊ - export interface Servers1 {␊ - apiVersion: "2017-08-01"␊ - /**␊ - * Location of the Analysis Services resource.␊ - */␊ - location: string␊ - /**␊ - * The name of the Analysis Services server. It must be a minimum of 3 characters, and a maximum of 63.␊ - */␊ - name: string␊ - /**␊ - * Properties of Analysis Services resource.␊ - */␊ - properties: (AnalysisServicesServerProperties1 | string)␊ - /**␊ - * Represents the SKU name and Azure pricing tier for Analysis Services resource.␊ - */␊ - sku: (ResourceSku1 | string)␊ - /**␊ - * Key-value pairs of additional resource provisioning properties.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.AnalysisServices/servers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Analysis Services resource.␊ - */␊ - export interface AnalysisServicesServerProperties1 {␊ - /**␊ - * An array of administrator user identities.␊ - */␊ - asAdministrators?: (ServerAdministrators1 | string)␊ - /**␊ - * The SAS container URI to the backup container.␊ - */␊ - backupBlobContainerUri?: string␊ - /**␊ - * The gateway details.␊ - */␊ - gatewayDetails?: (GatewayDetails | string)␊ - /**␊ - * An array of firewall rules.␊ - */␊ - ipV4FirewallSettings?: (IPv4FirewallSettings | string)␊ - /**␊ - * The managed mode of the server (0 = not managed, 1 = managed).␊ - */␊ - managedMode?: ((number & string) | string)␊ - /**␊ - * How the read-write server's participation in the query pool is controlled.
It can have the following values:
  • readOnly - indicates that the read-write server is intended not to participate in query operations
  • all - indicates that the read-write server can participate in query operations
Specifying readOnly when capacity is 1 results in error.␊ - */␊ - querypoolConnectionMode?: (("All" | "ReadOnly") | string)␊ - /**␊ - * The server monitor mode for AS server␊ - */␊ - serverMonitorMode?: ((number & string) | string)␊ - /**␊ - * Represents the SKU name and Azure pricing tier for Analysis Services resource.␊ - */␊ - sku?: (ResourceSku1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An array of administrator user identities.␊ - */␊ - export interface ServerAdministrators1 {␊ - /**␊ - * An array of administrator user identities.␊ - */␊ - members?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The gateway details.␊ - */␊ - export interface GatewayDetails {␊ - /**␊ - * Gateway resource to be associated with the server.␊ - */␊ - gatewayResourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An array of firewall rules.␊ - */␊ - export interface IPv4FirewallSettings {␊ - /**␊ - * The indicator of enabling PBI service.␊ - */␊ - enablePowerBIService?: (boolean | string)␊ - /**␊ - * An array of firewall rules.␊ - */␊ - firewallRules?: (IPv4FirewallRule[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The detail of firewall rule.␊ - */␊ - export interface IPv4FirewallRule {␊ - /**␊ - * The rule name.␊ - */␊ - firewallRuleName?: string␊ - /**␊ - * The end range of IPv4.␊ - */␊ - rangeEnd?: string␊ - /**␊ - * The start range of IPv4.␊ - */␊ - rangeStart?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents the SKU name and Azure pricing tier for Analysis Services resource.␊ - */␊ - export interface ResourceSku1 {␊ - /**␊ - * The number of instances in the read only query pool.␊ - */␊ - capacity?: ((number & string) | string)␊ - /**␊ - * Name of the SKU level.␊ - */␊ - name: string␊ - /**␊ - * The name of the Azure pricing tier to which the SKU applies.␊ - */␊ - tier?: (("Development" | "Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.RecoveryServices/vaults␊ - */␊ - export interface Vaults {␊ - apiVersion: "2016-06-01"␊ - /**␊ - * Optional ETag.␊ - */␊ - eTag?: string␊ - /**␊ - * Identity for the resource.␊ - */␊ - identity?: (IdentityData | string)␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the recovery services vault.␊ - */␊ - name: string␊ - /**␊ - * Properties of the vault.␊ - */␊ - properties: (VaultProperties | string)␊ - resources?: (VaultsCertificatesChildResource | VaultsExtendedInformationChildResource)[]␊ - /**␊ - * Identifies the unique system identifier for each Azure resource.␊ - */␊ - sku?: (Sku2 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.RecoveryServices/vaults"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the resource.␊ - */␊ - export interface IdentityData {␊ - /**␊ - * The identity type.␊ - */␊ - type: (("SystemAssigned" | "None") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the vault.␊ - */␊ - export interface VaultProperties {␊ - /**␊ - * Details for upgrading vault.␊ - */␊ - upgradeDetails?: (UpgradeDetails | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Details for upgrading vault.␊ - */␊ - export interface UpgradeDetails {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.RecoveryServices/vaults/certificates␊ - */␊ - export interface VaultsCertificatesChildResource {␊ - apiVersion: "2016-06-01"␊ - /**␊ - * Certificate friendly name.␊ - */␊ - name: string␊ - /**␊ - * Raw certificate data.␊ - */␊ - properties: (RawCertificateData | string)␊ - type: "certificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Raw certificate data.␊ - */␊ - export interface RawCertificateData {␊ - /**␊ - * Specifies the authentication type.␊ - */␊ - authType?: (("Invalid" | "ACS" | "AAD" | "AccessControlService" | "AzureActiveDirectory") | string)␊ - /**␊ - * The base64 encoded certificate raw data string␊ - */␊ - certificate?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.RecoveryServices/vaults/extendedInformation␊ - */␊ - export interface VaultsExtendedInformationChildResource {␊ - apiVersion: "2016-06-01"␊ - /**␊ - * Optional ETag.␊ - */␊ - eTag?: string␊ - name: "vaultExtendedInfo"␊ - /**␊ - * Vault extended information.␊ - */␊ - properties: (VaultExtendedInfo | string)␊ - type: "extendedInformation"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Vault extended information.␊ - */␊ - export interface VaultExtendedInfo {␊ - /**␊ - * Algorithm for Vault ExtendedInfo␊ - */␊ - algorithm?: string␊ - /**␊ - * Encryption key.␊ - */␊ - encryptionKey?: string␊ - /**␊ - * Encryption key thumbprint.␊ - */␊ - encryptionKeyThumbprint?: string␊ - /**␊ - * Integrity key.␊ - */␊ - integrityKey?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identifies the unique system identifier for each Azure resource.␊ - */␊ - export interface Sku2 {␊ - /**␊ - * The Sku name.␊ - */␊ - name: (("Standard" | "RS0") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.RecoveryServices/vaults␊ - */␊ - export interface Vaults1 {␊ - type: "Microsoft.RecoveryServices/vaults"␊ - apiVersion: ("2018-01-10" | "2017-07-01" | "2016-05-01" | "2015-12-15" | "2015-11-10" | "2015-08-15" | "2015-08-10" | "2015-06-10" | "2015-03-15")␊ - /**␊ - * Required. Gets or sets the sku type.␊ - */␊ - sku: (Sku3 | string)␊ - /**␊ - * Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update the request will succeed.␊ - */␊ - location: string␊ - /**␊ - * Gets or sets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (RecoveryServicesPropertiesCreateParameters | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The SKU of the recovery services vault.␊ - */␊ - export interface Sku3 {␊ - /**␊ - * Gets or sets the sku name. Required for vault creation, optional for update. Possible values include: 'RS0'␊ - */␊ - name: ("RS0" | string)␊ - /**␊ - * Gets or sets the sku tier. Required for vault creation, optional for update. Possible values include: 'Standard'␊ - */␊ - tier: ("Standard" | string)␊ - [k: string]: unknown␊ - }␊ - export interface RecoveryServicesPropertiesCreateParameters {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.RecoveryServices/vaults/certificates␊ - */␊ - export interface VaultsCertificates {␊ - apiVersion: "2016-06-01"␊ - /**␊ - * Certificate friendly name.␊ - */␊ - name: string␊ - /**␊ - * Raw certificate data.␊ - */␊ - properties: (RawCertificateData | string)␊ - type: "Microsoft.RecoveryServices/vaults/certificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.RecoveryServices/vaults/extendedInformation␊ - */␊ - export interface VaultsExtendedInformation {␊ - apiVersion: "2016-06-01"␊ - /**␊ - * Optional ETag.␊ - */␊ - eTag?: string␊ - name: string␊ - /**␊ - * Vault extended information.␊ - */␊ - properties: (VaultExtendedInfo | string)␊ - type: "Microsoft.RecoveryServices/vaults/extendedInformation"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DocumentDB/databaseAccounts␊ - */␊ - export interface DatabaseAccounts {␊ - apiVersion: "2015-04-08"␊ - /**␊ - * Indicates the type of database account. This can only be set at database account creation.␊ - */␊ - kind?: (("GlobalDocumentDB" | "MongoDB" | "Parse") | string)␊ - /**␊ - * The location of the resource group to which the resource belongs.␊ - */␊ - location?: string␊ - /**␊ - * Cosmos DB database account name.␊ - */␊ - name: string␊ - /**␊ - * Properties to create and update Azure Cosmos DB database accounts.␊ - */␊ - properties: (DatabaseAccountCreateUpdateProperties | string)␊ - /**␊ - * Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.DocumentDB/databaseAccounts"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties to create and update Azure Cosmos DB database accounts.␊ - */␊ - export interface DatabaseAccountCreateUpdateProperties {␊ - /**␊ - * List of Cosmos DB capabilities for the account␊ - */␊ - capabilities?: (Capability[] | string)␊ - /**␊ - * The cassandra connector offer type for the Cosmos DB database C* account.␊ - */␊ - connectorOffer?: ("Small" | string)␊ - /**␊ - * The consistency policy for the Cosmos DB database account.␊ - */␊ - consistencyPolicy?: (ConsistencyPolicy | string)␊ - /**␊ - * The offer type for the database␊ - */␊ - databaseAccountOfferType: ("Standard" | string)␊ - /**␊ - * Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account.␊ - */␊ - enableAutomaticFailover?: (boolean | string)␊ - /**␊ - * Enables the cassandra connector on the Cosmos DB C* account␊ - */␊ - enableCassandraConnector?: (boolean | string)␊ - /**␊ - * Enables the account to write in multiple locations␊ - */␊ - enableMultipleWriteLocations?: (boolean | string)␊ - /**␊ - * Cosmos DB Firewall Support: This value specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IPs for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces.␊ - */␊ - ipRangeFilter?: string␊ - /**␊ - * Flag to indicate whether to enable/disable Virtual Network ACL rules.␊ - */␊ - isVirtualNetworkFilterEnabled?: (boolean | string)␊ - /**␊ - * An array that contains the georeplication locations enabled for the Cosmos DB account.␊ - */␊ - locations: (Location[] | string)␊ - /**␊ - * List of Virtual Network ACL rules configured for the Cosmos DB account.␊ - */␊ - virtualNetworkRules?: (VirtualNetworkRule[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Cosmos DB capability object␊ - */␊ - export interface Capability {␊ - /**␊ - * Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin".␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The consistency policy for the Cosmos DB database account.␊ - */␊ - export interface ConsistencyPolicy {␊ - /**␊ - * The default consistency level and configuration settings of the Cosmos DB account.␊ - */␊ - defaultConsistencyLevel: (("Eventual" | "Session" | "BoundedStaleness" | "Strong" | "ConsistentPrefix") | string)␊ - /**␊ - * When used with the Bounded Staleness consistency level, this value represents the time amount of staleness (in seconds) tolerated. Accepted range for this value is 5 - 86400. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.␊ - */␊ - maxIntervalInSeconds?: (number | string)␊ - /**␊ - * When used with the Bounded Staleness consistency level, this value represents the number of stale requests tolerated. Accepted range for this value is 1 – 2,147,483,647. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.␊ - */␊ - maxStalenessPrefix?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A region in which the Azure Cosmos DB database account is deployed.␊ - */␊ - export interface Location {␊ - /**␊ - * The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.␊ - */␊ - failoverPriority?: (number | string)␊ - /**␊ - * Flag to indicate whether or not this region is an AvailabilityZone region␊ - */␊ - isZoneRedundant?: (boolean | string)␊ - /**␊ - * The name of the region.␊ - */␊ - locationName?: string␊ - /**␊ - * The status of the Cosmos DB account at the time the operation was called. The status can be one of following. 'Creating' – the Cosmos DB account is being created. When an account is in Creating state, only properties that are specified as input for the Create Cosmos DB account operation are returned. 'Succeeded' – the Cosmos DB account is active for use. 'Updating' – the Cosmos DB account is being updated. 'Deleting' – the Cosmos DB account is being deleted. 'Failed' – the Cosmos DB account failed creation. 'Offline' - the Cosmos DB account is not active. 'DeletionFailed' – the Cosmos DB account deletion failed.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Virtual Network ACL Rule object␊ - */␊ - export interface VirtualNetworkRule {␊ - /**␊ - * Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}.␊ - */␊ - id?: string␊ - /**␊ - * Create firewall rule before the virtual network has vnet service endpoint enabled.␊ - */␊ - ignoreMissingVNetServiceEndpoint?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DocumentDB/databaseAccounts/apis/databases␊ - */␊ - export interface DatabaseAccountsApisDatabases {␊ - apiVersion: "2015-04-08"␊ - /**␊ - * Cosmos DB database name.␊ - */␊ - name: string␊ - /**␊ - * Properties to create and update Azure Cosmos DB SQL database.␊ - */␊ - properties: (SqlDatabaseCreateUpdateProperties | string)␊ - resources?: (DatabaseAccountsApisDatabasesSettingsChildResource | DatabaseAccountsApisDatabasesContainersChildResource | DatabaseAccountsApisDatabasesCollectionsChildResource | DatabaseAccountsApisDatabasesGraphsChildResource)[]␊ - type: "Microsoft.DocumentDB/databaseAccounts/apis/databases"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties to create and update Azure Cosmos DB SQL database.␊ - */␊ - export interface SqlDatabaseCreateUpdateProperties {␊ - /**␊ - * CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput"␊ - */␊ - options: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Cosmos DB SQL database id object␊ - */␊ - resource: (SqlDatabaseResource | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Cosmos DB SQL database id object␊ - */␊ - export interface SqlDatabaseResource {␊ - /**␊ - * Name of the Cosmos DB SQL database␊ - */␊ - id: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties to update Azure Cosmos DB resource throughput.␊ - */␊ - export interface ThroughputUpdateProperties {␊ - /**␊ - * Cosmos DB resource throughput object␊ - */␊ - resource: (ThroughputResource | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Cosmos DB resource throughput object␊ - */␊ - export interface ThroughputResource {␊ - /**␊ - * Value of the Cosmos DB resource throughput␊ - */␊ - throughput: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DocumentDB/databaseAccounts/apis/databases/containers␊ - */␊ - export interface DatabaseAccountsApisDatabasesContainersChildResource {␊ - apiVersion: "2015-04-08"␊ - /**␊ - * Cosmos DB container name.␊ - */␊ - name: string␊ - /**␊ - * Properties to create and update Azure Cosmos DB container.␊ - */␊ - properties: (SqlContainerCreateUpdateProperties | string)␊ - type: "containers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties to create and update Azure Cosmos DB container.␊ - */␊ - export interface SqlContainerCreateUpdateProperties {␊ - /**␊ - * CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput"␊ - */␊ - options: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Cosmos DB SQL container resource object␊ - */␊ - resource: (SqlContainerResource | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Cosmos DB SQL container resource object␊ - */␊ - export interface SqlContainerResource {␊ - /**␊ - * The conflict resolution policy for the container.␊ - */␊ - conflictResolutionPolicy?: (ConflictResolutionPolicy | string)␊ - /**␊ - * Default time to live␊ - */␊ - defaultTtl?: (number | string)␊ - /**␊ - * Name of the Cosmos DB SQL container␊ - */␊ - id: string␊ - /**␊ - * Cosmos DB indexing policy␊ - */␊ - indexingPolicy?: (IndexingPolicy | string)␊ - /**␊ - * The configuration of the partition key to be used for partitioning data into multiple partitions␊ - */␊ - partitionKey?: (ContainerPartitionKey | string)␊ - /**␊ - * The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.␊ - */␊ - uniqueKeyPolicy?: (UniqueKeyPolicy | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The conflict resolution policy for the container.␊ - */␊ - export interface ConflictResolutionPolicy {␊ - /**␊ - * The conflict resolution path in the case of LastWriterWins mode.␊ - */␊ - conflictResolutionPath?: string␊ - /**␊ - * The procedure to resolve conflicts in the case of custom mode.␊ - */␊ - conflictResolutionProcedure?: string␊ - /**␊ - * Indicates the conflict resolution mode.␊ - */␊ - mode?: (("LastWriterWins" | "Custom") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Cosmos DB indexing policy␊ - */␊ - export interface IndexingPolicy {␊ - /**␊ - * Indicates if the indexing policy is automatic␊ - */␊ - automatic?: (boolean | string)␊ - /**␊ - * List of paths to exclude from indexing␊ - */␊ - excludedPaths?: (ExcludedPath[] | string)␊ - /**␊ - * List of paths to include in the indexing␊ - */␊ - includedPaths?: (IncludedPath[] | string)␊ - /**␊ - * Indicates the indexing mode.␊ - */␊ - indexingMode?: (("Consistent" | "Lazy" | "None") | string)␊ - [k: string]: unknown␊ - }␊ - export interface ExcludedPath {␊ - /**␊ - * The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)␊ - */␊ - path?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The paths that are included in indexing␊ - */␊ - export interface IncludedPath {␊ - /**␊ - * List of indexes for this path␊ - */␊ - indexes?: (Indexes[] | string)␊ - /**␊ - * The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)␊ - */␊ - path?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The indexes for the path.␊ - */␊ - export interface Indexes {␊ - /**␊ - * The datatype for which the indexing behavior is applied to.␊ - */␊ - dataType?: (("String" | "Number" | "Point" | "Polygon" | "LineString" | "MultiPolygon") | string)␊ - /**␊ - * Indicates the type of index.␊ - */␊ - kind?: (("Hash" | "Range" | "Spatial") | string)␊ - /**␊ - * The precision of the index. -1 is maximum precision.␊ - */␊ - precision?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The configuration of the partition key to be used for partitioning data into multiple partitions␊ - */␊ - export interface ContainerPartitionKey {␊ - /**␊ - * Indicates the kind of algorithm used for partitioning.␊ - */␊ - kind?: (("Hash" | "Range") | string)␊ - /**␊ - * List of paths using which data within the container can be partitioned␊ - */␊ - paths?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.␊ - */␊ - export interface UniqueKeyPolicy {␊ - /**␊ - * List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.␊ - */␊ - uniqueKeys?: (UniqueKey[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The unique key on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.␊ - */␊ - export interface UniqueKey {␊ - /**␊ - * List of paths must be unique for each document in the Azure Cosmos DB service␊ - */␊ - paths?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DocumentDB/databaseAccounts/apis/databases/collections␊ - */␊ - export interface DatabaseAccountsApisDatabasesCollectionsChildResource {␊ - apiVersion: "2015-04-08"␊ - /**␊ - * Cosmos DB collection name.␊ - */␊ - name: string␊ - /**␊ - * Properties to create and update Azure Cosmos DB MongoDB collection.␊ - */␊ - properties: (MongoDBCollectionCreateUpdateProperties | string)␊ - type: "collections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties to create and update Azure Cosmos DB MongoDB collection.␊ - */␊ - export interface MongoDBCollectionCreateUpdateProperties {␊ - /**␊ - * CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput"␊ - */␊ - options: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Cosmos DB MongoDB collection resource object␊ - */␊ - resource: (MongoDBCollectionResource | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Cosmos DB MongoDB collection resource object␊ - */␊ - export interface MongoDBCollectionResource {␊ - /**␊ - * Name of the Cosmos DB MongoDB collection␊ - */␊ - id: string␊ - /**␊ - * List of index keys␊ - */␊ - indexes?: (MongoIndex[] | string)␊ - /**␊ - * The shard key and partition kind pair, only support "Hash" partition kind␊ - */␊ - shardKey?: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Cosmos DB MongoDB collection index key␊ - */␊ - export interface MongoIndex {␊ - /**␊ - * Cosmos DB MongoDB collection resource object␊ - */␊ - key?: (MongoIndexKeys | string)␊ - /**␊ - * Cosmos DB MongoDB collection index options␊ - */␊ - options?: (MongoIndexOptions | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Cosmos DB MongoDB collection resource object␊ - */␊ - export interface MongoIndexKeys {␊ - /**␊ - * List of keys for each MongoDB collection in the Azure Cosmos DB service␊ - */␊ - keys?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Cosmos DB MongoDB collection index options␊ - */␊ - export interface MongoIndexOptions {␊ - /**␊ - * Expire after seconds␊ - */␊ - expireAfterSeconds?: (number | string)␊ - /**␊ - * Is unique or not␊ - */␊ - unique?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs␊ - */␊ - export interface DatabaseAccountsApisDatabasesGraphsChildResource {␊ - apiVersion: "2015-04-08"␊ - /**␊ - * Cosmos DB graph name.␊ - */␊ - name: string␊ - /**␊ - * Properties to create and update Azure Cosmos DB Gremlin graph.␊ - */␊ - properties: (GremlinGraphCreateUpdateProperties | string)␊ - type: "graphs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties to create and update Azure Cosmos DB Gremlin graph.␊ - */␊ - export interface GremlinGraphCreateUpdateProperties {␊ - /**␊ - * CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput"␊ - */␊ - options: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Cosmos DB Gremlin graph resource object␊ - */␊ - resource: (GremlinGraphResource | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Cosmos DB Gremlin graph resource object␊ - */␊ - export interface GremlinGraphResource {␊ - /**␊ - * The conflict resolution policy for the container.␊ - */␊ - conflictResolutionPolicy?: (ConflictResolutionPolicy | string)␊ - /**␊ - * Default time to live␊ - */␊ - defaultTtl?: (number | string)␊ - /**␊ - * Name of the Cosmos DB Gremlin graph␊ - */␊ - id: string␊ - /**␊ - * Cosmos DB indexing policy␊ - */␊ - indexingPolicy?: (IndexingPolicy | string)␊ - /**␊ - * The configuration of the partition key to be used for partitioning data into multiple partitions␊ - */␊ - partitionKey?: (ContainerPartitionKey | string)␊ - /**␊ - * The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.␊ - */␊ - uniqueKeyPolicy?: (UniqueKeyPolicy | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DocumentDB/databaseAccounts/apis/databases/collections␊ - */␊ - export interface DatabaseAccountsApisDatabasesCollections {␊ - apiVersion: "2015-04-08"␊ - /**␊ - * Cosmos DB collection name.␊ - */␊ - name: string␊ - /**␊ - * Properties to create and update Azure Cosmos DB MongoDB collection.␊ - */␊ - properties: (MongoDBCollectionCreateUpdateProperties | string)␊ - resources?: DatabaseAccountsApisDatabasesCollectionsSettingsChildResource[]␊ - type: "Microsoft.DocumentDB/databaseAccounts/apis/databases/collections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DocumentDB/databaseAccounts/apis/databases/collections/settings␊ - */␊ - export interface DatabaseAccountsApisDatabasesCollectionsSettingsChildResource {␊ - apiVersion: "2015-04-08"␊ - name: "throughput"␊ - /**␊ - * Properties to update Azure Cosmos DB resource throughput.␊ - */␊ - properties: (ThroughputUpdateProperties | string)␊ - type: "settings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DocumentDB/databaseAccounts/apis/databases/containers␊ - */␊ - export interface DatabaseAccountsApisDatabasesContainers {␊ - apiVersion: "2015-04-08"␊ - /**␊ - * Cosmos DB container name.␊ - */␊ - name: string␊ - /**␊ - * Properties to create and update Azure Cosmos DB container.␊ - */␊ - properties: (SqlContainerCreateUpdateProperties | string)␊ - resources?: DatabaseAccountsApisDatabasesContainersSettingsChildResource[]␊ - type: "Microsoft.DocumentDB/databaseAccounts/apis/databases/containers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DocumentDB/databaseAccounts/apis/databases/containers/settings␊ - */␊ - export interface DatabaseAccountsApisDatabasesContainersSettingsChildResource {␊ - apiVersion: "2015-04-08"␊ - name: "throughput"␊ - /**␊ - * Properties to update Azure Cosmos DB resource throughput.␊ - */␊ - properties: (ThroughputUpdateProperties | string)␊ - type: "settings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs␊ - */␊ - export interface DatabaseAccountsApisDatabasesGraphs {␊ - apiVersion: "2015-04-08"␊ - /**␊ - * Cosmos DB graph name.␊ - */␊ - name: string␊ - /**␊ - * Properties to create and update Azure Cosmos DB Gremlin graph.␊ - */␊ - properties: (GremlinGraphCreateUpdateProperties | string)␊ - resources?: DatabaseAccountsApisDatabasesGraphsSettingsChildResource[]␊ - type: "Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs/settings␊ - */␊ - export interface DatabaseAccountsApisDatabasesGraphsSettingsChildResource {␊ - apiVersion: "2015-04-08"␊ - name: "throughput"␊ - /**␊ - * Properties to update Azure Cosmos DB resource throughput.␊ - */␊ - properties: (ThroughputUpdateProperties | string)␊ - type: "settings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DocumentDB/databaseAccounts/apis/keyspaces␊ - */␊ - export interface DatabaseAccountsApisKeyspaces {␊ - apiVersion: "2015-04-08"␊ - /**␊ - * Cosmos DB keyspace name.␊ - */␊ - name: string␊ - /**␊ - * Properties to create and update Azure Cosmos DB Cassandra keyspace.␊ - */␊ - properties: (CassandraKeyspaceCreateUpdateProperties | string)␊ - resources?: (DatabaseAccountsApisKeyspacesSettingsChildResource | DatabaseAccountsApisKeyspacesTablesChildResource)[]␊ - type: "Microsoft.DocumentDB/databaseAccounts/apis/keyspaces"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties to create and update Azure Cosmos DB Cassandra keyspace.␊ - */␊ - export interface CassandraKeyspaceCreateUpdateProperties {␊ - /**␊ - * CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput"␊ - */␊ - options: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Cosmos DB Cassandra keyspace id object␊ - */␊ - resource: (CassandraKeyspaceResource | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Cosmos DB Cassandra keyspace id object␊ - */␊ - export interface CassandraKeyspaceResource {␊ - /**␊ - * Name of the Cosmos DB Cassandra keyspace␊ - */␊ - id: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/settings␊ - */␊ - export interface DatabaseAccountsApisKeyspacesSettingsChildResource {␊ - apiVersion: "2015-04-08"␊ - name: "throughput"␊ - /**␊ - * Properties to update Azure Cosmos DB resource throughput.␊ - */␊ - properties: (ThroughputUpdateProperties | string)␊ - type: "settings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/tables␊ - */␊ - export interface DatabaseAccountsApisKeyspacesTablesChildResource {␊ - apiVersion: "2015-04-08"␊ - /**␊ - * Cosmos DB table name.␊ - */␊ - name: string␊ - /**␊ - * Properties to create and update Azure Cosmos DB Cassandra table.␊ - */␊ - properties: (CassandraTableCreateUpdateProperties | string)␊ - type: "tables"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties to create and update Azure Cosmos DB Cassandra table.␊ - */␊ - export interface CassandraTableCreateUpdateProperties {␊ - /**␊ - * CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput"␊ - */␊ - options: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Cosmos DB Cassandra table id object␊ - */␊ - resource: (CassandraTableResource | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Cosmos DB Cassandra table id object␊ - */␊ - export interface CassandraTableResource {␊ - /**␊ - * Time to live of the Cosmos DB Cassandra table␊ - */␊ - defaultTtl?: (number | string)␊ - /**␊ - * Name of the Cosmos DB Cassandra table␊ - */␊ - id: string␊ - /**␊ - * Cosmos DB Cassandra table schema␊ - */␊ - schema?: (CassandraSchema | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Cosmos DB Cassandra table schema␊ - */␊ - export interface CassandraSchema {␊ - /**␊ - * List of cluster key.␊ - */␊ - clusterKeys?: (ClusterKey[] | string)␊ - /**␊ - * List of Cassandra table columns.␊ - */␊ - columns?: (Column[] | string)␊ - /**␊ - * List of partition key.␊ - */␊ - partitionKeys?: (CassandraPartitionKey[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Cosmos DB Cassandra table cluster key␊ - */␊ - export interface ClusterKey {␊ - /**␊ - * Name of the Cosmos DB Cassandra table cluster key␊ - */␊ - name?: string␊ - /**␊ - * Order of the Cosmos DB Cassandra table cluster key, only support "Asc" and "Desc"␊ - */␊ - orderBy?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Cosmos DB Cassandra table column␊ - */␊ - export interface Column {␊ - /**␊ - * Name of the Cosmos DB Cassandra table column␊ - */␊ - name?: string␊ - /**␊ - * Type of the Cosmos DB Cassandra table column␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Cosmos DB Cassandra table partition key␊ - */␊ - export interface CassandraPartitionKey {␊ - /**␊ - * Name of the Cosmos DB Cassandra table partition key␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/tables␊ - */␊ - export interface DatabaseAccountsApisKeyspacesTables {␊ - apiVersion: "2015-04-08"␊ - /**␊ - * Cosmos DB table name.␊ - */␊ - name: string␊ - /**␊ - * Properties to create and update Azure Cosmos DB Cassandra table.␊ - */␊ - properties: (CassandraTableCreateUpdateProperties | string)␊ - resources?: DatabaseAccountsApisKeyspacesTablesSettingsChildResource[]␊ - type: "Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/tables"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/tables/settings␊ - */␊ - export interface DatabaseAccountsApisKeyspacesTablesSettingsChildResource {␊ - apiVersion: "2015-04-08"␊ - name: "throughput"␊ - /**␊ - * Properties to update Azure Cosmos DB resource throughput.␊ - */␊ - properties: (ThroughputUpdateProperties | string)␊ - type: "settings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DocumentDB/databaseAccounts/apis/tables␊ - */␊ - export interface DatabaseAccountsApisTables {␊ - apiVersion: "2015-04-08"␊ - /**␊ - * Cosmos DB table name.␊ - */␊ - name: string␊ - /**␊ - * Properties to create and update Azure Cosmos DB Table.␊ - */␊ - properties: (TableCreateUpdateProperties | string)␊ - resources?: DatabaseAccountsApisTablesSettingsChildResource[]␊ - type: "Microsoft.DocumentDB/databaseAccounts/apis/tables"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties to create and update Azure Cosmos DB Table.␊ - */␊ - export interface TableCreateUpdateProperties {␊ - /**␊ - * CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput"␊ - */␊ - options: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Cosmos DB table id object␊ - */␊ - resource: (TableResource | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Cosmos DB table id object␊ - */␊ - export interface TableResource {␊ - /**␊ - * Name of the Cosmos DB table␊ - */␊ - id: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DocumentDB/databaseAccounts/apis/tables/settings␊ - */␊ - export interface DatabaseAccountsApisTablesSettingsChildResource {␊ - apiVersion: "2015-04-08"␊ - name: "throughput"␊ - /**␊ - * Properties to update Azure Cosmos DB resource throughput.␊ - */␊ - properties: (ThroughputUpdateProperties | string)␊ - type: "settings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DocumentDB/databaseAccounts/apis/databases/collections/settings␊ - */␊ - export interface DatabaseAccountsApisDatabasesCollectionsSettings {␊ - apiVersion: "2015-04-08"␊ - name: string␊ - /**␊ - * Properties to update Azure Cosmos DB resource throughput.␊ - */␊ - properties: (ThroughputUpdateProperties | string)␊ - type: "Microsoft.DocumentDB/databaseAccounts/apis/databases/collections/settings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DocumentDB/databaseAccounts/apis/databases/containers/settings␊ - */␊ - export interface DatabaseAccountsApisDatabasesContainersSettings {␊ - apiVersion: "2015-04-08"␊ - name: string␊ - /**␊ - * Properties to update Azure Cosmos DB resource throughput.␊ - */␊ - properties: (ThroughputUpdateProperties | string)␊ - type: "Microsoft.DocumentDB/databaseAccounts/apis/databases/containers/settings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs/settings␊ - */␊ - export interface DatabaseAccountsApisDatabasesGraphsSettings {␊ - apiVersion: "2015-04-08"␊ - name: string␊ - /**␊ - * Properties to update Azure Cosmos DB resource throughput.␊ - */␊ - properties: (ThroughputUpdateProperties | string)␊ - type: "Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs/settings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/settings␊ - */␊ - export interface DatabaseAccountsApisKeyspacesSettings {␊ - apiVersion: "2015-04-08"␊ - name: string␊ - /**␊ - * Properties to update Azure Cosmos DB resource throughput.␊ - */␊ - properties: (ThroughputUpdateProperties | string)␊ - type: "Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/settings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/tables/settings␊ - */␊ - export interface DatabaseAccountsApisKeyspacesTablesSettings {␊ - apiVersion: "2015-04-08"␊ - name: string␊ - /**␊ - * Properties to update Azure Cosmos DB resource throughput.␊ - */␊ - properties: (ThroughputUpdateProperties | string)␊ - type: "Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/tables/settings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DocumentDB/databaseAccounts/apis/tables/settings␊ - */␊ - export interface DatabaseAccountsApisTablesSettings {␊ - apiVersion: "2015-04-08"␊ - name: string␊ - /**␊ - * Properties to update Azure Cosmos DB resource throughput.␊ - */␊ - properties: (ThroughputUpdateProperties | string)␊ - type: "Microsoft.DocumentDB/databaseAccounts/apis/tables/settings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.KeyVault/vaults/secrets␊ - */␊ - export interface VaultsSecrets {␊ - type: "Microsoft.KeyVault/vaults/secrets"␊ - apiVersion: "2015-06-01"␊ - properties: {␊ - /**␊ - * Secret value␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.KeyVault/vaults␊ - */␊ - export interface Vaults2 {␊ - apiVersion: "2015-06-01"␊ - /**␊ - * The supported Azure location where the key vault should be created.␊ - */␊ - location: string␊ - /**␊ - * Name of the vault␊ - */␊ - name: string␊ - /**␊ - * Properties of the vault␊ - */␊ - properties: (VaultProperties1 | string)␊ - /**␊ - * The tags that will be assigned to the key vault. ␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.KeyVault/vaults"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the vault␊ - */␊ - export interface VaultProperties1 {␊ - /**␊ - * An array of 0 to 16 identities that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's tenant ID.␊ - */␊ - accessPolicies: (AccessPolicyEntry[] | string)␊ - /**␊ - * Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault.␊ - */␊ - enabledForDeployment?: (boolean | string)␊ - /**␊ - * Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys.␊ - */␊ - enabledForDiskEncryption?: (boolean | string)␊ - /**␊ - * Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault.␊ - */␊ - enabledForTemplateDeployment?: (boolean | string)␊ - /**␊ - * Property to specify whether the 'soft delete' functionality is enabled for this key vault.␊ - */␊ - enableSoftDelete?: (boolean | string)␊ - /**␊ - * SKU details␊ - */␊ - sku: (Sku4 | string)␊ - /**␊ - * The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.␊ - */␊ - tenantId: string␊ - /**␊ - * The URI of the vault for performing operations on keys and secrets.␊ - */␊ - vaultUri?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An identity that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's tenant ID.␊ - */␊ - export interface AccessPolicyEntry {␊ - /**␊ - * Application ID of the client making request on behalf of a principal␊ - */␊ - applicationId?: string␊ - /**␊ - * The object ID of a user, service principal or security group in the Azure Active Directory tenant for the vault. The object ID must be unique for the list of access policies.␊ - */␊ - objectId: string␊ - /**␊ - * Permissions the identity has for keys, secrets and certificates.␊ - */␊ - permissions: (Permissions | string)␊ - /**␊ - * The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.␊ - */␊ - tenantId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Permissions the identity has for keys, secrets and certificates.␊ - */␊ - export interface Permissions {␊ - /**␊ - * Permissions to certificates␊ - */␊ - certificates?: (("all" | "get" | "list" | "delete" | "create" | "import" | "update" | "managecontacts" | "getissuers" | "listissuers" | "setissuers" | "deleteissuers" | "manageissuers" | "recover" | "purge")[] | string)␊ - /**␊ - * Permissions to keys␊ - */␊ - keys?: (("all" | "encrypt" | "decrypt" | "wrapKey" | "unwrapKey" | "sign" | "verify" | "get" | "list" | "create" | "update" | "import" | "delete" | "backup" | "restore" | "recover" | "purge")[] | string)␊ - /**␊ - * Permissions to secrets␊ - */␊ - secrets?: (("all" | "get" | "list" | "set" | "delete" | "backup" | "restore" | "recover" | "purge")[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU details␊ - */␊ - export interface Sku4 {␊ - /**␊ - * SKU family name␊ - */␊ - family: ("A" | string)␊ - /**␊ - * SKU name to specify whether the key vault is a standard vault or a premium vault.␊ - */␊ - name: (("standard" | "premium") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.KeyVault/vaults␊ - */␊ - export interface Vaults3 {␊ - apiVersion: "2016-10-01"␊ - /**␊ - * The supported Azure location where the key vault should be created.␊ - */␊ - location: string␊ - /**␊ - * Name of the vault␊ - */␊ - name: string␊ - /**␊ - * Properties of the vault␊ - */␊ - properties: (VaultProperties2 | string)␊ - resources?: (VaultsAccessPoliciesChildResource | VaultsSecretsChildResource)[]␊ - /**␊ - * The tags that will be assigned to the key vault.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.KeyVault/vaults"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the vault␊ - */␊ - export interface VaultProperties2 {␊ - /**␊ - * An array of 0 to 16 identities that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's tenant ID. When \`createMode\` is set to \`recover\`, access policies are not required. Otherwise, access policies are required.␊ - */␊ - accessPolicies?: (AccessPolicyEntry1[] | string)␊ - /**␊ - * The vault's create mode to indicate whether the vault need to be recovered or not.␊ - */␊ - createMode?: (("recover" | "default") | string)␊ - /**␊ - * Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault.␊ - */␊ - enabledForDeployment?: (boolean | string)␊ - /**␊ - * Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys.␊ - */␊ - enabledForDiskEncryption?: (boolean | string)␊ - /**␊ - * Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault.␊ - */␊ - enabledForTemplateDeployment?: (boolean | string)␊ - /**␊ - * Property specifying whether protection against purge is enabled for this vault. Setting this property to true activates protection against purge for this vault and its content - only the Key Vault service may initiate a hard, irrecoverable deletion. The setting is effective only if soft delete is also enabled. Enabling this functionality is irreversible - that is, the property does not accept false as its value.␊ - */␊ - enablePurgeProtection?: (boolean | string)␊ - /**␊ - * Property specifying whether recoverable deletion is enabled for this key vault. Setting this property to true activates the soft delete feature, whereby vaults or vault entities can be recovered after deletion. Enabling this functionality is irreversible - that is, the property does not accept false as its value.␊ - */␊ - enableSoftDelete?: (boolean | string)␊ - /**␊ - * SKU details␊ - */␊ - sku: (Sku5 | string)␊ - /**␊ - * The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.␊ - */␊ - tenantId: string␊ - /**␊ - * The URI of the vault for performing operations on keys and secrets.␊ - */␊ - vaultUri?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An identity that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's tenant ID.␊ - */␊ - export interface AccessPolicyEntry1 {␊ - /**␊ - * Application ID of the client making request on behalf of a principal␊ - */␊ - applicationId?: string␊ - /**␊ - * The object ID of a user, service principal or security group in the Azure Active Directory tenant for the vault. The object ID must be unique for the list of access policies.␊ - */␊ - objectId: string␊ - /**␊ - * Permissions the identity has for keys, secrets, certificates and storage.␊ - */␊ - permissions: (Permissions1 | string)␊ - /**␊ - * The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.␊ - */␊ - tenantId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Permissions the identity has for keys, secrets, certificates and storage.␊ - */␊ - export interface Permissions1 {␊ - /**␊ - * Permissions to certificates␊ - */␊ - certificates?: (("get" | "list" | "delete" | "create" | "import" | "update" | "managecontacts" | "getissuers" | "listissuers" | "setissuers" | "deleteissuers" | "manageissuers" | "recover" | "purge")[] | string)␊ - /**␊ - * Permissions to keys␊ - */␊ - keys?: (("encrypt" | "decrypt" | "wrapKey" | "unwrapKey" | "sign" | "verify" | "get" | "list" | "create" | "update" | "import" | "delete" | "backup" | "restore" | "recover" | "purge")[] | string)␊ - /**␊ - * Permissions to secrets␊ - */␊ - secrets?: (("get" | "list" | "set" | "delete" | "backup" | "restore" | "recover" | "purge")[] | string)␊ - /**␊ - * Permissions to storage accounts␊ - */␊ - storage?: (("get" | "list" | "delete" | "set" | "update" | "regeneratekey" | "recover" | "purge" | "backup" | "restore" | "setsas" | "listsas" | "getsas" | "deletesas")[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU details␊ - */␊ - export interface Sku5 {␊ - /**␊ - * SKU family name␊ - */␊ - family: ("A" | string)␊ - /**␊ - * SKU name to specify whether the key vault is a standard vault or a premium vault.␊ - */␊ - name: (("standard" | "premium") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.KeyVault/vaults/accessPolicies␊ - */␊ - export interface VaultsAccessPoliciesChildResource {␊ - apiVersion: "2016-10-01"␊ - /**␊ - * Name of the operation.␊ - */␊ - name: (("add" | "replace" | "remove") | string)␊ - /**␊ - * Properties of the vault access policy␊ - */␊ - properties: (VaultAccessPolicyProperties | string)␊ - type: "accessPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the vault access policy␊ - */␊ - export interface VaultAccessPolicyProperties {␊ - /**␊ - * An array of 0 to 16 identities that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's tenant ID.␊ - */␊ - accessPolicies: (AccessPolicyEntry1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.KeyVault/vaults/secrets␊ - */␊ - export interface VaultsSecretsChildResource {␊ - apiVersion: "2016-10-01"␊ - /**␊ - * Name of the secret␊ - */␊ - name: string␊ - /**␊ - * Properties of the secret␊ - */␊ - properties: (SecretProperties | string)␊ - /**␊ - * The tags that will be assigned to the secret. ␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "secrets"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the secret␊ - */␊ - export interface SecretProperties {␊ - /**␊ - * The secret management attributes.␊ - */␊ - attributes?: (SecretAttributes | string)␊ - /**␊ - * The content type of the secret.␊ - */␊ - contentType?: string␊ - /**␊ - * The value of the secret. NOTE: 'value' will never be returned from the service, as APIs using this model are is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The secret management attributes.␊ - */␊ - export interface SecretAttributes {␊ - /**␊ - * Determines whether the object is enabled.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Expiry date in seconds since 1970-01-01T00:00:00Z.␊ - */␊ - exp?: (number | string)␊ - /**␊ - * Not before date in seconds since 1970-01-01T00:00:00Z.␊ - */␊ - nbf?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.KeyVault/vaults/accessPolicies␊ - */␊ - export interface VaultsAccessPolicies {␊ - apiVersion: "2016-10-01"␊ - /**␊ - * Name of the operation.␊ - */␊ - name: (("add" | "replace" | "remove") | string)␊ - /**␊ - * Properties of the vault access policy␊ - */␊ - properties: (VaultAccessPolicyProperties | string)␊ - type: "Microsoft.KeyVault/vaults/accessPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.KeyVault/vaults/secrets␊ - */␊ - export interface VaultsSecrets1 {␊ - apiVersion: "2016-10-01"␊ - /**␊ - * Name of the secret␊ - */␊ - name: string␊ - /**␊ - * Properties of the secret␊ - */␊ - properties: (SecretProperties | string)␊ - /**␊ - * The tags that will be assigned to the secret. ␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.KeyVault/vaults/secrets"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.KeyVault/vaults␊ - */␊ - export interface Vaults4 {␊ - apiVersion: "2018-02-14"␊ - /**␊ - * The supported Azure location where the key vault should be created.␊ - */␊ - location: string␊ - /**␊ - * Name of the vault␊ - */␊ - name: string␊ - /**␊ - * Properties of the vault␊ - */␊ - properties: (VaultProperties3 | string)␊ - resources?: (VaultsAccessPoliciesChildResource1 | VaultsPrivateEndpointConnectionsChildResource | VaultsSecretsChildResource1)[]␊ - /**␊ - * The tags that will be assigned to the key vault.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.KeyVault/vaults"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the vault␊ - */␊ - export interface VaultProperties3 {␊ - /**␊ - * An array of 0 to 1024 identities that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's tenant ID. When \`createMode\` is set to \`recover\`, access policies are not required. Otherwise, access policies are required.␊ - */␊ - accessPolicies?: (AccessPolicyEntry2[] | string)␊ - /**␊ - * The vault's create mode to indicate whether the vault need to be recovered or not.␊ - */␊ - createMode?: (("recover" | "default") | string)␊ - /**␊ - * Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault.␊ - */␊ - enabledForDeployment?: (boolean | string)␊ - /**␊ - * Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys.␊ - */␊ - enabledForDiskEncryption?: (boolean | string)␊ - /**␊ - * Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault.␊ - */␊ - enabledForTemplateDeployment?: (boolean | string)␊ - /**␊ - * Property specifying whether protection against purge is enabled for this vault. Setting this property to true activates protection against purge for this vault and its content - only the Key Vault service may initiate a hard, irrecoverable deletion. The setting is effective only if soft delete is also enabled. Enabling this functionality is irreversible - that is, the property does not accept false as its value.␊ - */␊ - enablePurgeProtection?: (boolean | string)␊ - /**␊ - * Property to specify whether the 'soft delete' functionality is enabled for this key vault. It does not accept false value.␊ - */␊ - enableSoftDelete?: (boolean | string)␊ - /**␊ - * A set of rules governing the network accessibility of a vault.␊ - */␊ - networkAcls?: (NetworkRuleSet | string)␊ - /**␊ - * SKU details␊ - */␊ - sku: (Sku6 | string)␊ - /**␊ - * The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.␊ - */␊ - tenantId: string␊ - /**␊ - * The URI of the vault for performing operations on keys and secrets.␊ - */␊ - vaultUri?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An identity that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's tenant ID.␊ - */␊ - export interface AccessPolicyEntry2 {␊ - /**␊ - * Application ID of the client making request on behalf of a principal␊ - */␊ - applicationId?: string␊ - /**␊ - * The object ID of a user, service principal or security group in the Azure Active Directory tenant for the vault. The object ID must be unique for the list of access policies.␊ - */␊ - objectId: string␊ - /**␊ - * Permissions the identity has for keys, secrets, certificates and storage.␊ - */␊ - permissions: (Permissions2 | string)␊ - /**␊ - * The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.␊ - */␊ - tenantId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Permissions the identity has for keys, secrets, certificates and storage.␊ - */␊ - export interface Permissions2 {␊ - /**␊ - * Permissions to certificates␊ - */␊ - certificates?: (("get" | "list" | "delete" | "create" | "import" | "update" | "managecontacts" | "getissuers" | "listissuers" | "setissuers" | "deleteissuers" | "manageissuers" | "recover" | "purge" | "backup" | "restore")[] | string)␊ - /**␊ - * Permissions to keys␊ - */␊ - keys?: (("encrypt" | "decrypt" | "wrapKey" | "unwrapKey" | "sign" | "verify" | "get" | "list" | "create" | "update" | "import" | "delete" | "backup" | "restore" | "recover" | "purge")[] | string)␊ - /**␊ - * Permissions to secrets␊ - */␊ - secrets?: (("get" | "list" | "set" | "delete" | "backup" | "restore" | "recover" | "purge")[] | string)␊ - /**␊ - * Permissions to storage accounts␊ - */␊ - storage?: (("get" | "list" | "delete" | "set" | "update" | "regeneratekey" | "recover" | "purge" | "backup" | "restore" | "setsas" | "listsas" | "getsas" | "deletesas")[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A set of rules governing the network accessibility of a vault.␊ - */␊ - export interface NetworkRuleSet {␊ - /**␊ - * Tells what traffic can bypass network rules. This can be 'AzureServices' or 'None'. If not specified the default is 'AzureServices'.␊ - */␊ - bypass?: (("AzureServices" | "None") | string)␊ - /**␊ - * The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated.␊ - */␊ - defaultAction?: (("Allow" | "Deny") | string)␊ - /**␊ - * The list of IP address rules.␊ - */␊ - ipRules?: (IPRule[] | string)␊ - /**␊ - * The list of virtual network rules.␊ - */␊ - virtualNetworkRules?: (VirtualNetworkRule1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A rule governing the accessibility of a vault from a specific ip address or ip range.␊ - */␊ - export interface IPRule {␊ - /**␊ - * An IPv4 address range in CIDR notation, such as '124.56.78.91' (simple IP address) or '124.56.78.0/24' (all addresses that start with 124.56.78).␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A rule governing the accessibility of a vault from a specific virtual network.␊ - */␊ - export interface VirtualNetworkRule1 {␊ - /**␊ - * Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'.␊ - */␊ - id: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU details␊ - */␊ - export interface Sku6 {␊ - /**␊ - * SKU family name␊ - */␊ - family: ("A" | string)␊ - /**␊ - * SKU name to specify whether the key vault is a standard vault or a premium vault.␊ - */␊ - name: (("standard" | "premium") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.KeyVault/vaults/accessPolicies␊ - */␊ - export interface VaultsAccessPoliciesChildResource1 {␊ - apiVersion: "2018-02-14"␊ - /**␊ - * Name of the operation.␊ - */␊ - name: (("add" | "replace" | "remove") | string)␊ - /**␊ - * Properties of the vault access policy␊ - */␊ - properties: (VaultAccessPolicyProperties1 | string)␊ - type: "accessPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the vault access policy␊ - */␊ - export interface VaultAccessPolicyProperties1 {␊ - /**␊ - * An array of 0 to 16 identities that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's tenant ID.␊ - */␊ - accessPolicies: (AccessPolicyEntry2[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.KeyVault/vaults/privateEndpointConnections␊ - */␊ - export interface VaultsPrivateEndpointConnectionsChildResource {␊ - apiVersion: "2018-02-14"␊ - /**␊ - * Name of the private endpoint connection associated with the key vault.␊ - */␊ - name: string␊ - /**␊ - * Properties of the private endpoint connection resource.␊ - */␊ - properties: (PrivateEndpointConnectionProperties | string)␊ - type: "privateEndpointConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the private endpoint connection resource.␊ - */␊ - export interface PrivateEndpointConnectionProperties {␊ - /**␊ - * Private endpoint object properties.␊ - */␊ - privateEndpoint?: (PrivateEndpoint | string)␊ - /**␊ - * An object that represents the approval state of the private link connection.␊ - */␊ - privateLinkServiceConnectionState?: (PrivateLinkServiceConnectionState | string)␊ - /**␊ - * Provisioning state of the private endpoint connection.␊ - */␊ - provisioningState?: (("Succeeded" | "Creating" | "Updating" | "Deleting" | "Failed" | "Disconnected") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Private endpoint object properties.␊ - */␊ - export interface PrivateEndpoint {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An object that represents the approval state of the private link connection.␊ - */␊ - export interface PrivateLinkServiceConnectionState {␊ - /**␊ - * A message indicating if changes on the service provider require any updates on the consumer.␊ - */␊ - actionRequired?: string␊ - /**␊ - * The reason for approval or rejection.␊ - */␊ - description?: string␊ - /**␊ - * Indicates whether the connection has been approved, rejected or removed by the key vault owner.␊ - */␊ - status?: (("Pending" | "Approved" | "Rejected" | "Disconnected") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.KeyVault/vaults/secrets␊ - */␊ - export interface VaultsSecretsChildResource1 {␊ - apiVersion: "2018-02-14"␊ - /**␊ - * Name of the secret␊ - */␊ - name: string␊ - /**␊ - * Properties of the secret␊ - */␊ - properties: (SecretProperties1 | string)␊ - /**␊ - * The tags that will be assigned to the secret. ␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "secrets"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the secret␊ - */␊ - export interface SecretProperties1 {␊ - /**␊ - * The secret management attributes.␊ - */␊ - attributes?: (SecretAttributes1 | string)␊ - /**␊ - * The content type of the secret.␊ - */␊ - contentType?: string␊ - /**␊ - * The value of the secret. NOTE: 'value' will never be returned from the service, as APIs using this model are is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The secret management attributes.␊ - */␊ - export interface SecretAttributes1 {␊ - /**␊ - * Determines whether the object is enabled.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Expiry date in seconds since 1970-01-01T00:00:00Z.␊ - */␊ - exp?: (number | string)␊ - /**␊ - * Not before date in seconds since 1970-01-01T00:00:00Z.␊ - */␊ - nbf?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.KeyVault/vaults/accessPolicies␊ - */␊ - export interface VaultsAccessPolicies1 {␊ - apiVersion: "2018-02-14"␊ - /**␊ - * Name of the operation.␊ - */␊ - name: (("add" | "replace" | "remove") | string)␊ - /**␊ - * Properties of the vault access policy␊ - */␊ - properties: (VaultAccessPolicyProperties1 | string)␊ - type: "Microsoft.KeyVault/vaults/accessPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.KeyVault/vaults/privateEndpointConnections␊ - */␊ - export interface VaultsPrivateEndpointConnections {␊ - apiVersion: "2018-02-14"␊ - /**␊ - * Name of the private endpoint connection associated with the key vault.␊ - */␊ - name: string␊ - /**␊ - * Properties of the private endpoint connection resource.␊ - */␊ - properties: (PrivateEndpointConnectionProperties | string)␊ - type: "Microsoft.KeyVault/vaults/privateEndpointConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.KeyVault/vaults/secrets␊ - */␊ - export interface VaultsSecrets2 {␊ - apiVersion: "2018-02-14"␊ - /**␊ - * Name of the secret␊ - */␊ - name: string␊ - /**␊ - * Properties of the secret␊ - */␊ - properties: (SecretProperties1 | string)␊ - /**␊ - * The tags that will be assigned to the secret. ␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.KeyVault/vaults/secrets"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.KeyVault/vaults␊ - */␊ - export interface Vaults5 {␊ - apiVersion: "2018-02-14-preview"␊ - /**␊ - * The supported Azure location where the key vault should be created.␊ - */␊ - location: string␊ - /**␊ - * Name of the vault␊ - */␊ - name: string␊ - /**␊ - * Properties of the vault␊ - */␊ - properties: (VaultProperties4 | string)␊ - resources?: (VaultsAccessPoliciesChildResource2 | VaultsSecretsChildResource2)[]␊ - /**␊ - * The tags that will be assigned to the key vault.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.KeyVault/vaults"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the vault␊ - */␊ - export interface VaultProperties4 {␊ - /**␊ - * An array of 0 to 1024 identities that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's tenant ID.␊ - */␊ - accessPolicies?: (AccessPolicyEntry3[] | string)␊ - /**␊ - * The vault's create mode to indicate whether the vault need to be recovered or not.␊ - */␊ - createMode?: (("recover" | "default") | string)␊ - /**␊ - * Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault.␊ - */␊ - enabledForDeployment?: (boolean | string)␊ - /**␊ - * Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys.␊ - */␊ - enabledForDiskEncryption?: (boolean | string)␊ - /**␊ - * Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault.␊ - */␊ - enabledForTemplateDeployment?: (boolean | string)␊ - /**␊ - * Property specifying whether protection against purge is enabled for this vault. Setting this property to true activates protection against purge for this vault and its content - only the Key Vault service may initiate a hard, irrecoverable deletion. The setting is effective only if soft delete is also enabled. Enabling this functionality is irreversible - that is, the property does not accept false as its value.␊ - */␊ - enablePurgeProtection?: (boolean | string)␊ - /**␊ - * Property to specify whether the 'soft delete' functionality is enabled for this key vault. It does not accept false value.␊ - */␊ - enableSoftDelete?: (boolean | string)␊ - /**␊ - * A set of rules governing the network accessibility of a vault.␊ - */␊ - networkAcls?: (NetworkRuleSet1 | string)␊ - /**␊ - * SKU details␊ - */␊ - sku: (Sku7 | string)␊ - /**␊ - * The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.␊ - */␊ - tenantId: string␊ - /**␊ - * The URI of the vault for performing operations on keys and secrets.␊ - */␊ - vaultUri?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An identity that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's tenant ID.␊ - */␊ - export interface AccessPolicyEntry3 {␊ - /**␊ - * Application ID of the client making request on behalf of a principal␊ - */␊ - applicationId?: string␊ - /**␊ - * The object ID of a user, service principal or security group in the Azure Active Directory tenant for the vault. The object ID must be unique for the list of access policies.␊ - */␊ - objectId: string␊ - /**␊ - * Permissions the identity has for keys, secrets, certificates and storage.␊ - */␊ - permissions: (Permissions3 | string)␊ - /**␊ - * The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.␊ - */␊ - tenantId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Permissions the identity has for keys, secrets, certificates and storage.␊ - */␊ - export interface Permissions3 {␊ - /**␊ - * Permissions to certificates␊ - */␊ - certificates?: (("get" | "list" | "delete" | "create" | "import" | "update" | "managecontacts" | "getissuers" | "listissuers" | "setissuers" | "deleteissuers" | "manageissuers" | "recover" | "purge" | "backup" | "restore")[] | string)␊ - /**␊ - * Permissions to keys␊ - */␊ - keys?: (("encrypt" | "decrypt" | "wrapKey" | "unwrapKey" | "sign" | "verify" | "get" | "list" | "create" | "update" | "import" | "delete" | "backup" | "restore" | "recover" | "purge")[] | string)␊ - /**␊ - * Permissions to secrets␊ - */␊ - secrets?: (("get" | "list" | "set" | "delete" | "backup" | "restore" | "recover" | "purge")[] | string)␊ - /**␊ - * Permissions to storage accounts␊ - */␊ - storage?: (("get" | "list" | "delete" | "set" | "update" | "regeneratekey" | "recover" | "purge" | "backup" | "restore" | "setsas" | "listsas" | "getsas" | "deletesas")[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A set of rules governing the network accessibility of a vault.␊ - */␊ - export interface NetworkRuleSet1 {␊ - /**␊ - * Tells what traffic can bypass network rules. This can be 'AzureServices' or 'None'. If not specified the default is 'AzureServices'.␊ - */␊ - bypass?: (("AzureServices" | "None") | string)␊ - /**␊ - * The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated.␊ - */␊ - defaultAction?: (("Allow" | "Deny") | string)␊ - /**␊ - * The list of IP address rules.␊ - */␊ - ipRules?: (IPRule1[] | string)␊ - /**␊ - * The list of virtual network rules.␊ - */␊ - virtualNetworkRules?: (VirtualNetworkRule2[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A rule governing the accessibility of a vault from a specific ip address or ip range.␊ - */␊ - export interface IPRule1 {␊ - /**␊ - * An IPv4 address range in CIDR notation, such as '124.56.78.91' (simple IP address) or '124.56.78.0/24' (all addresses that start with 124.56.78).␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A rule governing the accessibility of a vault from a specific virtual network.␊ - */␊ - export interface VirtualNetworkRule2 {␊ - /**␊ - * Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'.␊ - */␊ - id: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU details␊ - */␊ - export interface Sku7 {␊ - /**␊ - * SKU family name␊ - */␊ - family: ("A" | string)␊ - /**␊ - * SKU name to specify whether the key vault is a standard vault or a premium vault.␊ - */␊ - name: (("standard" | "premium") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.KeyVault/vaults/accessPolicies␊ - */␊ - export interface VaultsAccessPoliciesChildResource2 {␊ - apiVersion: "2018-02-14-preview"␊ - /**␊ - * Name of the operation.␊ - */␊ - name: (("add" | "replace" | "remove") | string)␊ - /**␊ - * Properties of the vault access policy␊ - */␊ - properties: (VaultAccessPolicyProperties2 | string)␊ - type: "accessPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the vault access policy␊ - */␊ - export interface VaultAccessPolicyProperties2 {␊ - /**␊ - * An array of 0 to 16 identities that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's tenant ID.␊ - */␊ - accessPolicies: (AccessPolicyEntry3[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.KeyVault/vaults/secrets␊ - */␊ - export interface VaultsSecretsChildResource2 {␊ - apiVersion: "2018-02-14-preview"␊ - /**␊ - * Name of the secret␊ - */␊ - name: string␊ - /**␊ - * Properties of the secret␊ - */␊ - properties: (SecretProperties2 | string)␊ - /**␊ - * The tags that will be assigned to the secret. ␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "secrets"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the secret␊ - */␊ - export interface SecretProperties2 {␊ - /**␊ - * The secret management attributes.␊ - */␊ - attributes?: (SecretAttributes2 | string)␊ - /**␊ - * The content type of the secret.␊ - */␊ - contentType?: string␊ - /**␊ - * The value of the secret. NOTE: 'value' will never be returned from the service, as APIs using this model are is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The secret management attributes.␊ - */␊ - export interface SecretAttributes2 {␊ - /**␊ - * Determines whether the object is enabled.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Expiry date in seconds since 1970-01-01T00:00:00Z.␊ - */␊ - exp?: (number | string)␊ - /**␊ - * Not before date in seconds since 1970-01-01T00:00:00Z.␊ - */␊ - nbf?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.KeyVault/vaults/accessPolicies␊ - */␊ - export interface VaultsAccessPolicies2 {␊ - apiVersion: "2018-02-14-preview"␊ - /**␊ - * Name of the operation.␊ - */␊ - name: (("add" | "replace" | "remove") | string)␊ - /**␊ - * Properties of the vault access policy␊ - */␊ - properties: (VaultAccessPolicyProperties2 | string)␊ - type: "Microsoft.KeyVault/vaults/accessPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.KeyVault/vaults/secrets␊ - */␊ - export interface VaultsSecrets3 {␊ - apiVersion: "2018-02-14-preview"␊ - /**␊ - * Name of the secret␊ - */␊ - name: string␊ - /**␊ - * Properties of the secret␊ - */␊ - properties: (SecretProperties2 | string)␊ - /**␊ - * The tags that will be assigned to the secret. ␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.KeyVault/vaults/secrets"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.KeyVault/vaults␊ - */␊ - export interface Vaults6 {␊ - apiVersion: "2019-09-01"␊ - /**␊ - * The supported Azure location where the key vault should be created.␊ - */␊ - location: string␊ - /**␊ - * Name of the vault␊ - */␊ - name: string␊ - /**␊ - * Properties of the vault␊ - */␊ - properties: (VaultProperties5 | string)␊ - resources?: (VaultsAccessPoliciesChildResource3 | VaultsPrivateEndpointConnectionsChildResource1 | VaultsKeysChildResource | VaultsSecretsChildResource3)[]␊ - /**␊ - * The tags that will be assigned to the key vault.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.KeyVault/vaults"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the vault␊ - */␊ - export interface VaultProperties5 {␊ - /**␊ - * An array of 0 to 1024 identities that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's tenant ID. When \`createMode\` is set to \`recover\`, access policies are not required. Otherwise, access policies are required.␊ - */␊ - accessPolicies?: (AccessPolicyEntry4[] | string)␊ - /**␊ - * The vault's create mode to indicate whether the vault need to be recovered or not.␊ - */␊ - createMode?: (("recover" | "default") | string)␊ - /**␊ - * Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault.␊ - */␊ - enabledForDeployment?: (boolean | string)␊ - /**␊ - * Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys.␊ - */␊ - enabledForDiskEncryption?: (boolean | string)␊ - /**␊ - * Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault.␊ - */␊ - enabledForTemplateDeployment?: (boolean | string)␊ - /**␊ - * Property specifying whether protection against purge is enabled for this vault. Setting this property to true activates protection against purge for this vault and its content - only the Key Vault service may initiate a hard, irrecoverable deletion. The setting is effective only if soft delete is also enabled. Enabling this functionality is irreversible - that is, the property does not accept false as its value.␊ - */␊ - enablePurgeProtection?: (boolean | string)␊ - /**␊ - * Property that controls how data actions are authorized. When true, the key vault will use Role Based Access Control (RBAC) for authorization of data actions, and the access policies specified in vault properties will be ignored. When false, the key vault will use the access policies specified in vault properties, and any policy stored on Azure Resource Manager will be ignored. If null or not specified, the vault is created with the default value of false. Note that management actions are always authorized with RBAC.␊ - */␊ - enableRbacAuthorization?: (boolean | string)␊ - /**␊ - * Property to specify whether the 'soft delete' functionality is enabled for this key vault. If it's not set to any value(true or false) when creating new key vault, it will be set to true by default. Once set to true, it cannot be reverted to false.␊ - */␊ - enableSoftDelete?: (boolean | string)␊ - /**␊ - * A set of rules governing the network accessibility of a vault.␊ - */␊ - networkAcls?: (NetworkRuleSet2 | string)␊ - /**␊ - * Provisioning state of the vault.␊ - */␊ - provisioningState?: (("Succeeded" | "RegisteringDns") | string)␊ - /**␊ - * SKU details␊ - */␊ - sku: (Sku8 | string)␊ - /**␊ - * softDelete data retention days. It accepts >=7 and <=90.␊ - */␊ - softDeleteRetentionInDays?: ((number & string) | string)␊ - /**␊ - * The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.␊ - */␊ - tenantId: string␊ - /**␊ - * The URI of the vault for performing operations on keys and secrets. This property is readonly␊ - */␊ - vaultUri?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An identity that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's tenant ID.␊ - */␊ - export interface AccessPolicyEntry4 {␊ - /**␊ - * Application ID of the client making request on behalf of a principal␊ - */␊ - applicationId?: string␊ - /**␊ - * The object ID of a user, service principal or security group in the Azure Active Directory tenant for the vault. The object ID must be unique for the list of access policies.␊ - */␊ - objectId: string␊ - /**␊ - * Permissions the identity has for keys, secrets, certificates and storage.␊ - */␊ - permissions: (Permissions4 | string)␊ - /**␊ - * The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.␊ - */␊ - tenantId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Permissions the identity has for keys, secrets, certificates and storage.␊ - */␊ - export interface Permissions4 {␊ - /**␊ - * Permissions to certificates␊ - */␊ - certificates?: (("all" | "get" | "list" | "delete" | "create" | "import" | "update" | "managecontacts" | "getissuers" | "listissuers" | "setissuers" | "deleteissuers" | "manageissuers" | "recover" | "purge" | "backup" | "restore")[] | string)␊ - /**␊ - * Permissions to keys␊ - */␊ - keys?: (("all" | "encrypt" | "decrypt" | "wrapKey" | "unwrapKey" | "sign" | "verify" | "get" | "list" | "create" | "update" | "import" | "delete" | "backup" | "restore" | "recover" | "purge")[] | string)␊ - /**␊ - * Permissions to secrets␊ - */␊ - secrets?: (("all" | "get" | "list" | "set" | "delete" | "backup" | "restore" | "recover" | "purge")[] | string)␊ - /**␊ - * Permissions to storage accounts␊ - */␊ - storage?: (("all" | "get" | "list" | "delete" | "set" | "update" | "regeneratekey" | "recover" | "purge" | "backup" | "restore" | "setsas" | "listsas" | "getsas" | "deletesas")[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A set of rules governing the network accessibility of a vault.␊ - */␊ - export interface NetworkRuleSet2 {␊ - /**␊ - * Tells what traffic can bypass network rules. This can be 'AzureServices' or 'None'. If not specified the default is 'AzureServices'.␊ - */␊ - bypass?: (("AzureServices" | "None") | string)␊ - /**␊ - * The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated.␊ - */␊ - defaultAction?: (("Allow" | "Deny") | string)␊ - /**␊ - * The list of IP address rules.␊ - */␊ - ipRules?: (IPRule2[] | string)␊ - /**␊ - * The list of virtual network rules.␊ - */␊ - virtualNetworkRules?: (VirtualNetworkRule3[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A rule governing the accessibility of a vault from a specific ip address or ip range.␊ - */␊ - export interface IPRule2 {␊ - /**␊ - * An IPv4 address range in CIDR notation, such as '124.56.78.91' (simple IP address) or '124.56.78.0/24' (all addresses that start with 124.56.78).␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A rule governing the accessibility of a vault from a specific virtual network.␊ - */␊ - export interface VirtualNetworkRule3 {␊ - /**␊ - * Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'.␊ - */␊ - id: string␊ - /**␊ - * Property to specify whether NRP will ignore the check if parent subnet has serviceEndpoints configured.␊ - */␊ - ignoreMissingVnetServiceEndpoint?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU details␊ - */␊ - export interface Sku8 {␊ - /**␊ - * SKU family name␊ - */␊ - family: ("A" | string)␊ - /**␊ - * SKU name to specify whether the key vault is a standard vault or a premium vault.␊ - */␊ - name: (("standard" | "premium") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.KeyVault/vaults/accessPolicies␊ - */␊ - export interface VaultsAccessPoliciesChildResource3 {␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Name of the operation.␊ - */␊ - name: (("add" | "replace" | "remove") | string)␊ - /**␊ - * Properties of the vault access policy␊ - */␊ - properties: (VaultAccessPolicyProperties3 | string)␊ - type: "accessPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the vault access policy␊ - */␊ - export interface VaultAccessPolicyProperties3 {␊ - /**␊ - * An array of 0 to 16 identities that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's tenant ID.␊ - */␊ - accessPolicies: (AccessPolicyEntry4[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.KeyVault/vaults/privateEndpointConnections␊ - */␊ - export interface VaultsPrivateEndpointConnectionsChildResource1 {␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Modified whenever there is a change in the state of private endpoint connection.␊ - */␊ - etag?: string␊ - /**␊ - * Name of the private endpoint connection associated with the key vault.␊ - */␊ - name: string␊ - /**␊ - * Properties of the private endpoint connection resource.␊ - */␊ - properties: (PrivateEndpointConnectionProperties1 | string)␊ - type: "privateEndpointConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the private endpoint connection resource.␊ - */␊ - export interface PrivateEndpointConnectionProperties1 {␊ - /**␊ - * Private endpoint object properties.␊ - */␊ - privateEndpoint?: (PrivateEndpoint1 | string)␊ - /**␊ - * An object that represents the approval state of the private link connection.␊ - */␊ - privateLinkServiceConnectionState?: (PrivateLinkServiceConnectionState1 | string)␊ - /**␊ - * Provisioning state of the private endpoint connection.␊ - */␊ - provisioningState?: (("Succeeded" | "Creating" | "Updating" | "Deleting" | "Failed" | "Disconnected") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Private endpoint object properties.␊ - */␊ - export interface PrivateEndpoint1 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An object that represents the approval state of the private link connection.␊ - */␊ - export interface PrivateLinkServiceConnectionState1 {␊ - /**␊ - * A message indicating if changes on the service provider require any updates on the consumer.␊ - */␊ - actionsRequired?: string␊ - /**␊ - * The reason for approval or rejection.␊ - */␊ - description?: string␊ - /**␊ - * Indicates whether the connection has been approved, rejected or removed by the key vault owner.␊ - */␊ - status?: (("Pending" | "Approved" | "Rejected" | "Disconnected") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.KeyVault/vaults/keys␊ - */␊ - export interface VaultsKeysChildResource {␊ - apiVersion: "2019-09-01"␊ - /**␊ - * The name of the key to be created.␊ - */␊ - name: string␊ - /**␊ - * The properties of the key.␊ - */␊ - properties: (KeyProperties | string)␊ - /**␊ - * The tags that will be assigned to the key.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "keys"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the key.␊ - */␊ - export interface KeyProperties {␊ - /**␊ - * The attributes of the key.␊ - */␊ - attributes?: (KeyAttributes | string)␊ - /**␊ - * The elliptic curve name. For valid values, see JsonWebKeyCurveName.␊ - */␊ - curveName?: (("P-256" | "P-384" | "P-521" | "P-256K") | string)␊ - keyOps?: (("encrypt" | "decrypt" | "sign" | "verify" | "wrapKey" | "unwrapKey" | "import")[] | string)␊ - /**␊ - * The key size in bits. For example: 2048, 3072, or 4096 for RSA.␊ - */␊ - keySize?: (number | string)␊ - /**␊ - * The type of the key. For valid values, see JsonWebKeyType.␊ - */␊ - kty?: (("EC" | "EC-HSM" | "RSA" | "RSA-HSM") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The attributes of the key.␊ - */␊ - export interface KeyAttributes {␊ - /**␊ - * Determines whether or not the object is enabled.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Expiry date in seconds since 1970-01-01T00:00:00Z.␊ - */␊ - exp?: (number | string)␊ - /**␊ - * Not before date in seconds since 1970-01-01T00:00:00Z.␊ - */␊ - nbf?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.KeyVault/vaults/secrets␊ - */␊ - export interface VaultsSecretsChildResource3 {␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Name of the secret␊ - */␊ - name: string␊ - /**␊ - * Properties of the secret␊ - */␊ - properties: (SecretProperties3 | string)␊ - /**␊ - * The tags that will be assigned to the secret. ␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "secrets"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the secret␊ - */␊ - export interface SecretProperties3 {␊ - /**␊ - * The secret management attributes.␊ - */␊ - attributes?: (SecretAttributes3 | string)␊ - /**␊ - * The content type of the secret.␊ - */␊ - contentType?: string␊ - /**␊ - * The value of the secret. NOTE: 'value' will never be returned from the service, as APIs using this model are is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The secret management attributes.␊ - */␊ - export interface SecretAttributes3 {␊ - /**␊ - * Determines whether the object is enabled.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Expiry date in seconds since 1970-01-01T00:00:00Z.␊ - */␊ - exp?: (number | string)␊ - /**␊ - * Not before date in seconds since 1970-01-01T00:00:00Z.␊ - */␊ - nbf?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.KeyVault/vaults/accessPolicies␊ - */␊ - export interface VaultsAccessPolicies3 {␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Name of the operation.␊ - */␊ - name: (("add" | "replace" | "remove") | string)␊ - /**␊ - * Properties of the vault access policy␊ - */␊ - properties: (VaultAccessPolicyProperties3 | string)␊ - type: "Microsoft.KeyVault/vaults/accessPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.KeyVault/vaults/keys␊ - */␊ - export interface VaultsKeys {␊ - apiVersion: "2019-09-01"␊ - /**␊ - * The name of the key to be created.␊ - */␊ - name: string␊ - /**␊ - * The properties of the key.␊ - */␊ - properties: (KeyProperties | string)␊ - /**␊ - * The tags that will be assigned to the key.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.KeyVault/vaults/keys"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.KeyVault/vaults/privateEndpointConnections␊ - */␊ - export interface VaultsPrivateEndpointConnections1 {␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Modified whenever there is a change in the state of private endpoint connection.␊ - */␊ - etag?: string␊ - /**␊ - * Name of the private endpoint connection associated with the key vault.␊ - */␊ - name: string␊ - /**␊ - * Properties of the private endpoint connection resource.␊ - */␊ - properties: (PrivateEndpointConnectionProperties1 | string)␊ - type: "Microsoft.KeyVault/vaults/privateEndpointConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.KeyVault/vaults/secrets␊ - */␊ - export interface VaultsSecrets4 {␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Name of the secret␊ - */␊ - name: string␊ - /**␊ - * Properties of the secret␊ - */␊ - properties: (SecretProperties3 | string)␊ - /**␊ - * The tags that will be assigned to the secret. ␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.KeyVault/vaults/secrets"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.KeyVault/managedHSMs␊ - */␊ - export interface ManagedHSMs {␊ - apiVersion: "2020-04-01-preview"␊ - /**␊ - * The supported Azure location where the managed HSM Pool should be created.␊ - */␊ - location?: string␊ - /**␊ - * Name of the managed HSM Pool␊ - */␊ - name: string␊ - /**␊ - * Properties of the managed HSM Pool␊ - */␊ - properties: (ManagedHsmProperties | string)␊ - /**␊ - * SKU details␊ - */␊ - sku?: (ManagedHsmSku | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.KeyVault/managedHSMs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the managed HSM Pool␊ - */␊ - export interface ManagedHsmProperties {␊ - /**␊ - * The create mode to indicate whether the resource is being created or is being recovered from a deleted resource.␊ - */␊ - createMode?: (("recover" | "default") | string)␊ - /**␊ - * Property specifying whether protection against purge is enabled for this managed HSM pool. Setting this property to true activates protection against purge for this managed HSM pool and its content - only the Managed HSM service may initiate a hard, irrecoverable deletion. The setting is effective only if soft delete is also enabled. Enabling this functionality is irreversible.␊ - */␊ - enablePurgeProtection?: (boolean | string)␊ - /**␊ - * Property to specify whether the 'soft delete' functionality is enabled for this managed HSM pool. If it's not set to any value(true or false) when creating new managed HSM pool, it will be set to true by default. Once set to true, it cannot be reverted to false.␊ - */␊ - enableSoftDelete?: (boolean | string)␊ - /**␊ - * Array of initial administrators object ids for this managed hsm pool.␊ - */␊ - initialAdminObjectIds?: (string[] | string)␊ - /**␊ - * softDelete data retention days. It accepts >=7 and <=90.␊ - */␊ - softDeleteRetentionInDays?: ((number & string) | string)␊ - /**␊ - * The Azure Active Directory tenant ID that should be used for authenticating requests to the managed HSM pool.␊ - */␊ - tenantId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU details␊ - */␊ - export interface ManagedHsmSku {␊ - /**␊ - * SKU Family of the managed HSM Pool␊ - */␊ - family: ("B" | string)␊ - /**␊ - * SKU of the managed HSM Pool.␊ - */␊ - name: (("Standard_B1" | "Custom_B32") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.KeyVault/vaults␊ - */␊ - export interface Vaults7 {␊ - apiVersion: "2020-04-01-preview"␊ - /**␊ - * The supported Azure location where the key vault should be created.␊ - */␊ - location: string␊ - /**␊ - * Name of the vault␊ - */␊ - name: string␊ - /**␊ - * Properties of the vault␊ - */␊ - properties: (VaultProperties6 | string)␊ - resources?: (VaultsKeysChildResource1 | VaultsAccessPoliciesChildResource4 | VaultsPrivateEndpointConnectionsChildResource2 | VaultsSecretsChildResource4)[]␊ - /**␊ - * The tags that will be assigned to the key vault.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.KeyVault/vaults"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the vault␊ - */␊ - export interface VaultProperties6 {␊ - /**␊ - * An array of 0 to 1024 identities that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's tenant ID. When \`createMode\` is set to \`recover\`, access policies are not required. Otherwise, access policies are required.␊ - */␊ - accessPolicies?: (AccessPolicyEntry5[] | string)␊ - /**␊ - * The vault's create mode to indicate whether the vault need to be recovered or not.␊ - */␊ - createMode?: (("recover" | "default") | string)␊ - /**␊ - * Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault.␊ - */␊ - enabledForDeployment?: (boolean | string)␊ - /**␊ - * Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys.␊ - */␊ - enabledForDiskEncryption?: (boolean | string)␊ - /**␊ - * Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault.␊ - */␊ - enabledForTemplateDeployment?: (boolean | string)␊ - /**␊ - * Property specifying whether protection against purge is enabled for this vault. Setting this property to true activates protection against purge for this vault and its content - only the Key Vault service may initiate a hard, irrecoverable deletion. The setting is effective only if soft delete is also enabled. Enabling this functionality is irreversible - that is, the property does not accept false as its value.␊ - */␊ - enablePurgeProtection?: (boolean | string)␊ - /**␊ - * Property that controls how data actions are authorized. When true, the key vault will use Role Based Access Control (RBAC) for authorization of data actions, and the access policies specified in vault properties will be ignored. When false, the key vault will use the access policies specified in vault properties, and any policy stored on Azure Resource Manager will be ignored. If null or not specified, the vault is created with the default value of false. Note that management actions are always authorized with RBAC.␊ - */␊ - enableRbacAuthorization?: (boolean | string)␊ - /**␊ - * Property to specify whether the 'soft delete' functionality is enabled for this key vault. If it's not set to any value(true or false) when creating new key vault, it will be set to true by default. Once set to true, it cannot be reverted to false.␊ - */␊ - enableSoftDelete?: (boolean | string)␊ - /**␊ - * A set of rules governing the network accessibility of a vault.␊ - */␊ - networkAcls?: (NetworkRuleSet3 | string)␊ - /**␊ - * Provisioning state of the vault.␊ - */␊ - provisioningState?: (("Succeeded" | "RegisteringDns") | string)␊ - /**␊ - * SKU details␊ - */␊ - sku: (Sku9 | string)␊ - /**␊ - * softDelete data retention days. It accepts >=7 and <=90.␊ - */␊ - softDeleteRetentionInDays?: ((number & string) | string)␊ - /**␊ - * The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.␊ - */␊ - tenantId: string␊ - /**␊ - * The URI of the vault for performing operations on keys and secrets.␊ - */␊ - vaultUri?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An identity that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's tenant ID.␊ - */␊ - export interface AccessPolicyEntry5 {␊ - /**␊ - * Application ID of the client making request on behalf of a principal␊ - */␊ - applicationId?: string␊ - /**␊ - * The object ID of a user, service principal or security group in the Azure Active Directory tenant for the vault. The object ID must be unique for the list of access policies.␊ - */␊ - objectId: string␊ - /**␊ - * Permissions the identity has for keys, secrets, certificates and storage.␊ - */␊ - permissions: (Permissions5 | string)␊ - /**␊ - * The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.␊ - */␊ - tenantId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Permissions the identity has for keys, secrets, certificates and storage.␊ - */␊ - export interface Permissions5 {␊ - /**␊ - * Permissions to certificates␊ - */␊ - certificates?: (("get" | "list" | "delete" | "create" | "import" | "update" | "managecontacts" | "getissuers" | "listissuers" | "setissuers" | "deleteissuers" | "manageissuers" | "recover" | "purge" | "backup" | "restore")[] | string)␊ - /**␊ - * Permissions to keys␊ - */␊ - keys?: (("encrypt" | "decrypt" | "wrapKey" | "unwrapKey" | "sign" | "verify" | "get" | "list" | "create" | "update" | "import" | "delete" | "backup" | "restore" | "recover" | "purge")[] | string)␊ - /**␊ - * Permissions to secrets␊ - */␊ - secrets?: (("get" | "list" | "set" | "delete" | "backup" | "restore" | "recover" | "purge")[] | string)␊ - /**␊ - * Permissions to storage accounts␊ - */␊ - storage?: (("get" | "list" | "delete" | "set" | "update" | "regeneratekey" | "recover" | "purge" | "backup" | "restore" | "setsas" | "listsas" | "getsas" | "deletesas")[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A set of rules governing the network accessibility of a vault.␊ - */␊ - export interface NetworkRuleSet3 {␊ - /**␊ - * Tells what traffic can bypass network rules. This can be 'AzureServices' or 'None'. If not specified the default is 'AzureServices'.␊ - */␊ - bypass?: (("AzureServices" | "None") | string)␊ - /**␊ - * The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated.␊ - */␊ - defaultAction?: (("Allow" | "Deny") | string)␊ - /**␊ - * The list of IP address rules.␊ - */␊ - ipRules?: (IPRule3[] | string)␊ - /**␊ - * The list of virtual network rules.␊ - */␊ - virtualNetworkRules?: (VirtualNetworkRule4[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A rule governing the accessibility of a vault from a specific ip address or ip range.␊ - */␊ - export interface IPRule3 {␊ - /**␊ - * An IPv4 address range in CIDR notation, such as '124.56.78.91' (simple IP address) or '124.56.78.0/24' (all addresses that start with 124.56.78).␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A rule governing the accessibility of a vault from a specific virtual network.␊ - */␊ - export interface VirtualNetworkRule4 {␊ - /**␊ - * Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'.␊ - */␊ - id: string␊ - /**␊ - * Property to specify whether NRP will ignore the check if parent subnet has serviceEndpoints configured.␊ - */␊ - ignoreMissingVnetServiceEndpoint?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU details␊ - */␊ - export interface Sku9 {␊ - /**␊ - * SKU family name␊ - */␊ - family: ("A" | string)␊ - /**␊ - * SKU name to specify whether the key vault is a standard vault or a premium vault.␊ - */␊ - name: (("standard" | "premium") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.KeyVault/vaults/keys␊ - */␊ - export interface VaultsKeysChildResource1 {␊ - apiVersion: "2020-04-01-preview"␊ - /**␊ - * The name of the key to be created.␊ - */␊ - name: string␊ - /**␊ - * The properties of the key.␊ - */␊ - properties: (KeyProperties1 | string)␊ - /**␊ - * The tags that will be assigned to the key.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "keys"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the key.␊ - */␊ - export interface KeyProperties1 {␊ - /**␊ - * The attributes of the key.␊ - */␊ - attributes?: (KeyAttributes1 | string)␊ - /**␊ - * The elliptic curve name. For valid values, see JsonWebKeyCurveName.␊ - */␊ - curveName?: (("P-256" | "P-384" | "P-521" | "P-256K") | string)␊ - keyOps?: (("encrypt" | "decrypt" | "sign" | "verify" | "wrapKey" | "unwrapKey" | "import")[] | string)␊ - /**␊ - * The key size in bits. For example: 2048, 3072, or 4096 for RSA.␊ - */␊ - keySize?: (number | string)␊ - /**␊ - * The type of the key. For valid values, see JsonWebKeyType.␊ - */␊ - kty?: (("EC" | "EC-HSM" | "RSA" | "RSA-HSM") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The attributes of the key.␊ - */␊ - export interface KeyAttributes1 {␊ - /**␊ - * Determines whether or not the object is enabled.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Expiry date in seconds since 1970-01-01T00:00:00Z.␊ - */␊ - exp?: (number | string)␊ - /**␊ - * Not before date in seconds since 1970-01-01T00:00:00Z.␊ - */␊ - nbf?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.KeyVault/vaults/accessPolicies␊ - */␊ - export interface VaultsAccessPoliciesChildResource4 {␊ - apiVersion: "2020-04-01-preview"␊ - /**␊ - * Name of the operation.␊ - */␊ - name: (("add" | "replace" | "remove") | string)␊ - /**␊ - * Properties of the vault access policy␊ - */␊ - properties: (VaultAccessPolicyProperties4 | string)␊ - type: "accessPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the vault access policy␊ - */␊ - export interface VaultAccessPolicyProperties4 {␊ - /**␊ - * An array of 0 to 16 identities that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's tenant ID.␊ - */␊ - accessPolicies: (AccessPolicyEntry5[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.KeyVault/vaults/privateEndpointConnections␊ - */␊ - export interface VaultsPrivateEndpointConnectionsChildResource2 {␊ - apiVersion: "2020-04-01-preview"␊ - /**␊ - * Modified whenever there is a change in the state of private endpoint connection.␊ - */␊ - etag?: string␊ - /**␊ - * Name of the private endpoint connection associated with the key vault.␊ - */␊ - name: string␊ - /**␊ - * Properties of the private endpoint connection resource.␊ - */␊ - properties: (PrivateEndpointConnectionProperties2 | string)␊ - type: "privateEndpointConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the private endpoint connection resource.␊ - */␊ - export interface PrivateEndpointConnectionProperties2 {␊ - /**␊ - * Private endpoint object properties.␊ - */␊ - privateEndpoint?: (PrivateEndpoint2 | string)␊ - /**␊ - * An object that represents the approval state of the private link connection.␊ - */␊ - privateLinkServiceConnectionState?: (PrivateLinkServiceConnectionState2 | string)␊ - /**␊ - * Provisioning state of the private endpoint connection.␊ - */␊ - provisioningState?: (("Succeeded" | "Creating" | "Updating" | "Deleting" | "Failed" | "Disconnected") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Private endpoint object properties.␊ - */␊ - export interface PrivateEndpoint2 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An object that represents the approval state of the private link connection.␊ - */␊ - export interface PrivateLinkServiceConnectionState2 {␊ - /**␊ - * A message indicating if changes on the service provider require any updates on the consumer.␊ - */␊ - actionsRequired?: ("None" | string)␊ - /**␊ - * The reason for approval or rejection.␊ - */␊ - description?: string␊ - /**␊ - * Indicates whether the connection has been approved, rejected or removed by the key vault owner.␊ - */␊ - status?: (("Pending" | "Approved" | "Rejected" | "Disconnected") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.KeyVault/vaults/secrets␊ - */␊ - export interface VaultsSecretsChildResource4 {␊ - apiVersion: "2020-04-01-preview"␊ - /**␊ - * Name of the secret␊ - */␊ - name: string␊ - /**␊ - * Properties of the secret␊ - */␊ - properties: (SecretProperties4 | string)␊ - /**␊ - * The tags that will be assigned to the secret. ␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "secrets"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the secret␊ - */␊ - export interface SecretProperties4 {␊ - /**␊ - * The secret management attributes.␊ - */␊ - attributes?: (SecretAttributes4 | string)␊ - /**␊ - * The content type of the secret.␊ - */␊ - contentType?: string␊ - /**␊ - * The value of the secret. NOTE: 'value' will never be returned from the service, as APIs using this model are is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The secret management attributes.␊ - */␊ - export interface SecretAttributes4 {␊ - /**␊ - * Determines whether the object is enabled.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Expiry date in seconds since 1970-01-01T00:00:00Z.␊ - */␊ - exp?: (number | string)␊ - /**␊ - * Not before date in seconds since 1970-01-01T00:00:00Z.␊ - */␊ - nbf?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.KeyVault/vaults/accessPolicies␊ - */␊ - export interface VaultsAccessPolicies4 {␊ - apiVersion: "2020-04-01-preview"␊ - /**␊ - * Name of the operation.␊ - */␊ - name: (("add" | "replace" | "remove") | string)␊ - /**␊ - * Properties of the vault access policy␊ - */␊ - properties: (VaultAccessPolicyProperties4 | string)␊ - type: "Microsoft.KeyVault/vaults/accessPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.KeyVault/vaults/privateEndpointConnections␊ - */␊ - export interface VaultsPrivateEndpointConnections2 {␊ - apiVersion: "2020-04-01-preview"␊ - /**␊ - * Modified whenever there is a change in the state of private endpoint connection.␊ - */␊ - etag?: string␊ - /**␊ - * Name of the private endpoint connection associated with the key vault.␊ - */␊ - name: string␊ - /**␊ - * Properties of the private endpoint connection resource.␊ - */␊ - properties: (PrivateEndpointConnectionProperties2 | string)␊ - type: "Microsoft.KeyVault/vaults/privateEndpointConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.KeyVault/vaults/secrets␊ - */␊ - export interface VaultsSecrets5 {␊ - apiVersion: "2020-04-01-preview"␊ - /**␊ - * Name of the secret␊ - */␊ - name: string␊ - /**␊ - * Properties of the secret␊ - */␊ - properties: (SecretProperties4 | string)␊ - /**␊ - * The tags that will be assigned to the secret. ␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.KeyVault/vaults/secrets"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DevTestLab/labs␊ - */␊ - export interface Labs {␊ - apiVersion: "2016-05-15"␊ - /**␊ - * The location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * The name of the lab.␊ - */␊ - name: string␊ - /**␊ - * Properties of a lab.␊ - */␊ - properties: (LabProperties | string)␊ - resources?: (LabsArtifactsourcesChildResource | LabsCostsChildResource | LabsCustomimagesChildResource | LabsFormulasChildResource | LabsNotificationchannelsChildResource | LabsSchedulesChildResource | LabsServicerunnersChildResource | LabsUsersChildResource | LabsVirtualmachinesChildResource | LabsVirtualnetworksChildResource)[]␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.DevTestLab/labs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a lab.␊ - */␊ - export interface LabProperties {␊ - /**␊ - * Type of storage used by the lab. It can be either Premium or Standard. Default is Premium.␊ - */␊ - labStorageType?: (("Standard" | "Premium") | string)␊ - /**␊ - * The setting to enable usage of premium data disks.␍␊ - * When its value is 'Enabled', creation of standard or premium data disks is allowed.␍␊ - * When its value is 'Disabled', only creation of standard data disks is allowed.␊ - */␊ - premiumDataDisks?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * The provisioning status of the resource.␊ - */␊ - provisioningState?: string␊ - /**␊ - * The unique immutable identifier of a resource (Guid).␊ - */␊ - uniqueIdentifier?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DevTestLab/labs/artifactsources␊ - */␊ - export interface LabsArtifactsourcesChildResource {␊ - apiVersion: "2016-05-15"␊ - /**␊ - * The location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * The name of the artifact source.␊ - */␊ - name: string␊ - /**␊ - * Properties of an artifact source.␊ - */␊ - properties: (ArtifactSourceProperties | string)␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "artifactsources"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of an artifact source.␊ - */␊ - export interface ArtifactSourceProperties {␊ - /**␊ - * The folder containing Azure Resource Manager templates.␊ - */␊ - armTemplateFolderPath?: string␊ - /**␊ - * The artifact source's branch reference.␊ - */␊ - branchRef?: string␊ - /**␊ - * The artifact source's display name.␊ - */␊ - displayName?: string␊ - /**␊ - * The folder containing artifacts.␊ - */␊ - folderPath?: string␊ - /**␊ - * The provisioning status of the resource.␊ - */␊ - provisioningState?: string␊ - /**␊ - * The security token to authenticate to the artifact source.␊ - */␊ - securityToken?: string␊ - /**␊ - * The artifact source's type.␊ - */␊ - sourceType?: (("VsoGit" | "GitHub") | string)␊ - /**␊ - * Indicates if the artifact source is enabled (values: Enabled, Disabled).␊ - */␊ - status?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * The unique immutable identifier of a resource (Guid).␊ - */␊ - uniqueIdentifier?: string␊ - /**␊ - * The artifact source's URI.␊ - */␊ - uri?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DevTestLab/labs/costs␊ - */␊ - export interface LabsCostsChildResource {␊ - apiVersion: "2016-05-15"␊ - /**␊ - * The location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * The name of the cost.␊ - */␊ - name: string␊ - /**␊ - * Properties of a cost item.␊ - */␊ - properties: (LabCostProperties | string)␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "costs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a cost item.␊ - */␊ - export interface LabCostProperties {␊ - /**␊ - * The creation date of the cost.␊ - */␊ - createdDate?: string␊ - /**␊ - * The currency code of the cost.␊ - */␊ - currencyCode?: string␊ - /**␊ - * The end time of the cost data.␊ - */␊ - endDateTime?: string␊ - /**␊ - * The provisioning status of the resource.␊ - */␊ - provisioningState?: string␊ - /**␊ - * The start time of the cost data.␊ - */␊ - startDateTime?: string␊ - /**␊ - * Properties of a cost target.␊ - */␊ - targetCost?: (TargetCostProperties | string)␊ - /**␊ - * The unique immutable identifier of a resource (Guid).␊ - */␊ - uniqueIdentifier?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a cost target.␊ - */␊ - export interface TargetCostProperties {␊ - /**␊ - * Cost thresholds.␊ - */␊ - costThresholds?: (CostThresholdProperties[] | string)␊ - /**␊ - * Reporting cycle end date.␊ - */␊ - cycleEndDateTime?: string␊ - /**␊ - * Reporting cycle start date.␊ - */␊ - cycleStartDateTime?: string␊ - /**␊ - * Reporting cycle type.␊ - */␊ - cycleType?: (("CalendarMonth" | "Custom") | string)␊ - /**␊ - * Target cost status.␊ - */␊ - status?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Lab target cost␊ - */␊ - target?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a cost threshold item.␊ - */␊ - export interface CostThresholdProperties {␊ - /**␊ - * Indicates whether this threshold will be displayed on cost charts.␊ - */␊ - displayOnChart?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Indicates the datetime when notifications were last sent for this threshold.␊ - */␊ - notificationSent?: string␊ - /**␊ - * Properties of a percentage cost threshold.␊ - */␊ - percentageThreshold?: (PercentageCostThresholdProperties | string)␊ - /**␊ - * Indicates whether notifications will be sent when this threshold is exceeded.␊ - */␊ - sendNotificationWhenExceeded?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * The ID of the cost threshold item.␊ - */␊ - thresholdId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a percentage cost threshold.␊ - */␊ - export interface PercentageCostThresholdProperties {␊ - /**␊ - * The cost threshold value.␊ - */␊ - thresholdValue?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DevTestLab/labs/customimages␊ - */␊ - export interface LabsCustomimagesChildResource {␊ - apiVersion: "2016-05-15"␊ - /**␊ - * The location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * The name of the custom image.␊ - */␊ - name: string␊ - /**␊ - * Properties of a custom image.␊ - */␊ - properties: (CustomImageProperties | string)␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "customimages"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a custom image.␊ - */␊ - export interface CustomImageProperties {␊ - /**␊ - * The author of the custom image.␊ - */␊ - author?: string␊ - /**␊ - * The description of the custom image.␊ - */␊ - description?: string␊ - /**␊ - * The Managed Image Id backing the custom image.␊ - */␊ - managedImageId?: string␊ - /**␊ - * The provisioning status of the resource.␊ - */␊ - provisioningState?: string␊ - /**␊ - * The unique immutable identifier of a resource (Guid).␊ - */␊ - uniqueIdentifier?: string␊ - /**␊ - * Properties for creating a custom image from a VHD.␊ - */␊ - vhd?: (CustomImagePropertiesCustom | string)␊ - /**␊ - * Properties for creating a custom image from a virtual machine.␊ - */␊ - vm?: (CustomImagePropertiesFromVm | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties for creating a custom image from a VHD.␊ - */␊ - export interface CustomImagePropertiesCustom {␊ - /**␊ - * The image name.␊ - */␊ - imageName?: string␊ - /**␊ - * The OS type of the custom image (i.e. Windows, Linux).␊ - */␊ - osType: (("Windows" | "Linux" | "None") | string)␊ - /**␊ - * Indicates whether sysprep has been run on the VHD.␊ - */␊ - sysPrep?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties for creating a custom image from a virtual machine.␊ - */␊ - export interface CustomImagePropertiesFromVm {␊ - /**␊ - * Information about a Linux OS.␊ - */␊ - linuxOsInfo?: (LinuxOsInfo | string)␊ - /**␊ - * The source vm identifier.␊ - */␊ - sourceVmId?: string␊ - /**␊ - * Information about a Windows OS.␊ - */␊ - windowsOsInfo?: (WindowsOsInfo | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about a Linux OS.␊ - */␊ - export interface LinuxOsInfo {␊ - /**␊ - * The state of the Linux OS (i.e. NonDeprovisioned, DeprovisionRequested, DeprovisionApplied).␊ - */␊ - linuxOsState?: (("NonDeprovisioned" | "DeprovisionRequested" | "DeprovisionApplied") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about a Windows OS.␊ - */␊ - export interface WindowsOsInfo {␊ - /**␊ - * The state of the Windows OS (i.e. NonSysprepped, SysprepRequested, SysprepApplied).␊ - */␊ - windowsOsState?: (("NonSysprepped" | "SysprepRequested" | "SysprepApplied") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DevTestLab/labs/formulas␊ - */␊ - export interface LabsFormulasChildResource {␊ - apiVersion: "2016-05-15"␊ - /**␊ - * The location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * The name of the formula.␊ - */␊ - name: string␊ - /**␊ - * Properties of a formula.␊ - */␊ - properties: (FormulaProperties | string)␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "formulas"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a formula.␊ - */␊ - export interface FormulaProperties {␊ - /**␊ - * The author of the formula.␊ - */␊ - author?: string␊ - /**␊ - * The description of the formula.␊ - */␊ - description?: string␊ - /**␊ - * Properties for creating a virtual machine.␊ - */␊ - formulaContent?: (LabVirtualMachineCreationParameter | string)␊ - /**␊ - * The OS type of the formula.␊ - */␊ - osType?: string␊ - /**␊ - * The provisioning status of the resource.␊ - */␊ - provisioningState?: string␊ - /**␊ - * The unique immutable identifier of a resource (Guid).␊ - */␊ - uniqueIdentifier?: string␊ - /**␊ - * Information about a VM from which a formula is to be created.␊ - */␊ - vm?: (FormulaPropertiesFromVm | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties for creating a virtual machine.␊ - */␊ - export interface LabVirtualMachineCreationParameter {␊ - /**␊ - * The location of the new virtual machine or environment␊ - */␊ - location?: string␊ - /**␊ - * The name of the virtual machine or environment␊ - */␊ - name?: string␊ - /**␊ - * Properties for virtual machine creation.␊ - */␊ - properties?: (LabVirtualMachineCreationParameterProperties | string)␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties for virtual machine creation.␊ - */␊ - export interface LabVirtualMachineCreationParameterProperties {␊ - /**␊ - * Indicates whether another user can take ownership of the virtual machine␊ - */␊ - allowClaim?: (boolean | string)␊ - /**␊ - * Schedules applicable to a virtual machine. The schedules may have been defined on a VM or on lab level.␊ - */␊ - applicableSchedule?: (ApplicableSchedule | string)␊ - /**␊ - * Properties of an artifact deployment.␊ - */␊ - artifactDeploymentStatus?: (ArtifactDeploymentStatusProperties | string)␊ - /**␊ - * The artifacts to be installed on the virtual machine.␊ - */␊ - artifacts?: (ArtifactInstallProperties[] | string)␊ - /**␊ - * Parameters for creating multiple virtual machines as a single action.␊ - */␊ - bulkCreationParameters?: (BulkCreationParameters | string)␊ - /**␊ - * Properties of a virtual machine returned by the Microsoft.Compute API.␊ - */␊ - computeVm?: (ComputeVmProperties | string)␊ - /**␊ - * The email address of creator of the virtual machine.␊ - */␊ - createdByUser?: string␊ - /**␊ - * The object identifier of the creator of the virtual machine.␊ - */␊ - createdByUserId?: string␊ - /**␊ - * The creation date of the virtual machine.␊ - */␊ - createdDate?: string␊ - /**␊ - * The custom image identifier of the virtual machine.␊ - */␊ - customImageId?: string␊ - /**␊ - * Indicates whether the virtual machine is to be created without a public IP address.␊ - */␊ - disallowPublicIpAddress?: (boolean | string)␊ - /**␊ - * The resource ID of the environment that contains this virtual machine, if any.␊ - */␊ - environmentId?: string␊ - /**␊ - * The expiration date for VM.␊ - */␊ - expirationDate?: string␊ - /**␊ - * The fully-qualified domain name of the virtual machine.␊ - */␊ - fqdn?: string␊ - /**␊ - * The reference information for an Azure Marketplace image.␊ - */␊ - galleryImageReference?: (GalleryImageReference | string)␊ - /**␊ - * Indicates whether this virtual machine uses an SSH key for authentication.␊ - */␊ - isAuthenticationWithSshKey?: (boolean | string)␊ - /**␊ - * The lab subnet name of the virtual machine.␊ - */␊ - labSubnetName?: string␊ - /**␊ - * The lab virtual network identifier of the virtual machine.␊ - */␊ - labVirtualNetworkId?: string␊ - /**␊ - * Properties of a network interface.␊ - */␊ - networkInterface?: (NetworkInterfaceProperties | string)␊ - /**␊ - * The notes of the virtual machine.␊ - */␊ - notes?: string␊ - /**␊ - * The OS type of the virtual machine.␊ - */␊ - osType?: string␊ - /**␊ - * The object identifier of the owner of the virtual machine.␊ - */␊ - ownerObjectId?: string␊ - /**␊ - * The user principal name of the virtual machine owner.␊ - */␊ - ownerUserPrincipalName?: string␊ - /**␊ - * The password of the virtual machine administrator.␊ - */␊ - password?: string␊ - /**␊ - * The provisioning status of the resource.␊ - */␊ - provisioningState?: string␊ - /**␊ - * The size of the virtual machine.␊ - */␊ - size?: string␊ - /**␊ - * The SSH key of the virtual machine administrator.␊ - */␊ - sshKey?: string␊ - /**␊ - * Storage type to use for virtual machine (i.e. Standard, Premium).␊ - */␊ - storageType?: string␊ - /**␊ - * The unique immutable identifier of a resource (Guid).␊ - */␊ - uniqueIdentifier?: string␊ - /**␊ - * The user name of the virtual machine.␊ - */␊ - userName?: string␊ - /**␊ - * Tells source of creation of lab virtual machine. Output property only.␊ - */␊ - virtualMachineCreationSource?: (("FromCustomImage" | "FromGalleryImage") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Schedules applicable to a virtual machine. The schedules may have been defined on a VM or on lab level.␊ - */␊ - export interface ApplicableSchedule {␊ - /**␊ - * The location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * Properties of a schedules applicable to a virtual machine.␊ - */␊ - properties: (ApplicableScheduleProperties | string)␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a schedules applicable to a virtual machine.␊ - */␊ - export interface ApplicableScheduleProperties {␊ - /**␊ - * A schedule.␊ - */␊ - labVmsShutdown?: (Schedule | string)␊ - /**␊ - * A schedule.␊ - */␊ - labVmsStartup?: (Schedule | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A schedule.␊ - */␊ - export interface Schedule {␊ - /**␊ - * The location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * Properties of a schedule.␊ - */␊ - properties: (ScheduleProperties | string)␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a schedule.␊ - */␊ - export interface ScheduleProperties {␊ - /**␊ - * Properties of a daily schedule.␊ - */␊ - dailyRecurrence?: (DayDetails | string)␊ - /**␊ - * Properties of an hourly schedule.␊ - */␊ - hourlyRecurrence?: (HourDetails | string)␊ - /**␊ - * Notification settings for a schedule.␊ - */␊ - notificationSettings?: (NotificationSettings | string)␊ - /**␊ - * The provisioning status of the resource.␊ - */␊ - provisioningState?: string␊ - /**␊ - * The status of the schedule (i.e. Enabled, Disabled).␊ - */␊ - status?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * The resource ID to which the schedule belongs␊ - */␊ - targetResourceId?: string␊ - /**␊ - * The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart).␊ - */␊ - taskType?: string␊ - /**␊ - * The time zone ID (e.g. Pacific Standard time).␊ - */␊ - timeZoneId?: string␊ - /**␊ - * The unique immutable identifier of a resource (Guid).␊ - */␊ - uniqueIdentifier?: string␊ - /**␊ - * Properties of a weekly schedule.␊ - */␊ - weeklyRecurrence?: (WeekDetails | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a daily schedule.␊ - */␊ - export interface DayDetails {␊ - /**␊ - * The time of day the schedule will occur.␊ - */␊ - time?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of an hourly schedule.␊ - */␊ - export interface HourDetails {␊ - /**␊ - * Minutes of the hour the schedule will run.␊ - */␊ - minute?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Notification settings for a schedule.␊ - */␊ - export interface NotificationSettings {␊ - /**␊ - * If notifications are enabled for this schedule (i.e. Enabled, Disabled).␊ - */␊ - status?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * Time in minutes before event at which notification will be sent.␊ - */␊ - timeInMinutes?: (number | string)␊ - /**␊ - * The webhook URL to which the notification will be sent.␊ - */␊ - webhookUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a weekly schedule.␊ - */␊ - export interface WeekDetails {␊ - /**␊ - * The time of the day the schedule will occur.␊ - */␊ - time?: string␊ - /**␊ - * The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.).␊ - */␊ - weekdays?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of an artifact deployment.␊ - */␊ - export interface ArtifactDeploymentStatusProperties {␊ - /**␊ - * The total count of the artifacts that were successfully applied.␊ - */␊ - artifactsApplied?: (number | string)␊ - /**␊ - * The deployment status of the artifact.␊ - */␊ - deploymentStatus?: string␊ - /**␊ - * The total count of the artifacts that were tentatively applied.␊ - */␊ - totalArtifacts?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of an artifact.␊ - */␊ - export interface ArtifactInstallProperties {␊ - /**␊ - * The artifact's identifier.␊ - */␊ - artifactId?: string␊ - /**␊ - * The status message from the deployment.␊ - */␊ - deploymentStatusMessage?: string␊ - /**␊ - * The time that the artifact starts to install on the virtual machine.␊ - */␊ - installTime?: string␊ - /**␊ - * The parameters of the artifact.␊ - */␊ - parameters?: (ArtifactParameterProperties[] | string)␊ - /**␊ - * The status of the artifact.␊ - */␊ - status?: string␊ - /**␊ - * The status message from the virtual machine extension.␊ - */␊ - vmExtensionStatusMessage?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of an artifact parameter.␊ - */␊ - export interface ArtifactParameterProperties {␊ - /**␊ - * The name of the artifact parameter.␊ - */␊ - name?: string␊ - /**␊ - * The value of the artifact parameter.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for creating multiple virtual machines as a single action.␊ - */␊ - export interface BulkCreationParameters {␊ - /**␊ - * The number of virtual machine instances to create.␊ - */␊ - instanceCount?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a virtual machine returned by the Microsoft.Compute API.␊ - */␊ - export interface ComputeVmProperties {␊ - /**␊ - * Gets data disks blob uri for the virtual machine.␊ - */␊ - dataDiskIds?: (string[] | string)␊ - /**␊ - * Gets all data disks attached to the virtual machine.␊ - */␊ - dataDisks?: (ComputeDataDisk[] | string)␊ - /**␊ - * Gets the network interface ID of the virtual machine.␊ - */␊ - networkInterfaceId?: string␊ - /**␊ - * Gets OS disk blob uri for the virtual machine.␊ - */␊ - osDiskId?: string␊ - /**␊ - * Gets the OS type of the virtual machine.␊ - */␊ - osType?: string␊ - /**␊ - * Gets the statuses of the virtual machine.␊ - */␊ - statuses?: (ComputeVmInstanceViewStatus[] | string)␊ - /**␊ - * Gets the size of the virtual machine.␊ - */␊ - vmSize?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A data disks attached to a virtual machine.␊ - */␊ - export interface ComputeDataDisk {␊ - /**␊ - * Gets data disk size in GiB.␊ - */␊ - diskSizeGiB?: (number | string)␊ - /**␊ - * When backed by a blob, the URI of underlying blob.␊ - */␊ - diskUri?: string␊ - /**␊ - * When backed by managed disk, this is the ID of the compute disk resource.␊ - */␊ - managedDiskId?: string␊ - /**␊ - * Gets data disk name.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Status information about a virtual machine.␊ - */␊ - export interface ComputeVmInstanceViewStatus {␊ - /**␊ - * Gets the status Code.␊ - */␊ - code?: string␊ - /**␊ - * Gets the short localizable label for the status.␊ - */␊ - displayStatus?: string␊ - /**␊ - * Gets the message associated with the status.␊ - */␊ - message?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The reference information for an Azure Marketplace image.␊ - */␊ - export interface GalleryImageReference {␊ - /**␊ - * The offer of the gallery image.␊ - */␊ - offer?: string␊ - /**␊ - * The OS type of the gallery image.␊ - */␊ - osType?: string␊ - /**␊ - * The publisher of the gallery image.␊ - */␊ - publisher?: string␊ - /**␊ - * The SKU of the gallery image.␊ - */␊ - sku?: string␊ - /**␊ - * The version of the gallery image.␊ - */␊ - version?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a network interface.␊ - */␊ - export interface NetworkInterfaceProperties {␊ - /**␊ - * The DNS name.␊ - */␊ - dnsName?: string␊ - /**␊ - * The private IP address.␊ - */␊ - privateIpAddress?: string␊ - /**␊ - * The public IP address.␊ - */␊ - publicIpAddress?: string␊ - /**␊ - * The resource ID of the public IP address.␊ - */␊ - publicIpAddressId?: string␊ - /**␊ - * The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol).␊ - */␊ - rdpAuthority?: string␊ - /**␊ - * Properties of a virtual machine that determine how it is connected to a load balancer.␊ - */␊ - sharedPublicIpAddressConfiguration?: (SharedPublicIpAddressConfiguration | string)␊ - /**␊ - * The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH.␊ - */␊ - sshAuthority?: string␊ - /**␊ - * The resource ID of the sub net.␊ - */␊ - subnetId?: string␊ - /**␊ - * The resource ID of the virtual network.␊ - */␊ - virtualNetworkId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a virtual machine that determine how it is connected to a load balancer.␊ - */␊ - export interface SharedPublicIpAddressConfiguration {␊ - /**␊ - * The incoming NAT rules␊ - */␊ - inboundNatRules?: (InboundNatRule[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A rule for NAT - exposing a VM's port (backendPort) on the public IP address using a load balancer.␊ - */␊ - export interface InboundNatRule {␊ - /**␊ - * The port to which the external traffic will be redirected.␊ - */␊ - backendPort?: (number | string)␊ - /**␊ - * The external endpoint port of the inbound connection. Possible values range between 1 and 65535, inclusive. If unspecified, a value will be allocated automatically.␊ - */␊ - frontendPort?: (number | string)␊ - /**␊ - * The transport protocol for the endpoint.␊ - */␊ - transportProtocol?: (("Tcp" | "Udp") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about a VM from which a formula is to be created.␊ - */␊ - export interface FormulaPropertiesFromVm {␊ - /**␊ - * The identifier of the VM from which a formula is to be created.␊ - */␊ - labVmId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DevTestLab/labs/notificationchannels␊ - */␊ - export interface LabsNotificationchannelsChildResource {␊ - apiVersion: "2016-05-15"␊ - /**␊ - * The location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * The name of the notificationChannel.␊ - */␊ - name: string␊ - /**␊ - * Properties of a schedule.␊ - */␊ - properties: (NotificationChannelProperties | string)␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "notificationchannels"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a schedule.␊ - */␊ - export interface NotificationChannelProperties {␊ - /**␊ - * Description of notification.␊ - */␊ - description?: string␊ - /**␊ - * The list of event for which this notification is enabled.␊ - */␊ - events?: (Event[] | string)␊ - /**␊ - * The provisioning status of the resource.␊ - */␊ - provisioningState?: string␊ - /**␊ - * The unique immutable identifier of a resource (Guid).␊ - */␊ - uniqueIdentifier?: string␊ - /**␊ - * The webhook URL to send notifications to.␊ - */␊ - webHookUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An event to be notified for.␊ - */␊ - export interface Event {␊ - /**␊ - * The event type for which this notification is enabled (i.e. AutoShutdown, Cost).␊ - */␊ - eventName?: (("AutoShutdown" | "Cost") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DevTestLab/labs/schedules␊ - */␊ - export interface LabsSchedulesChildResource {␊ - apiVersion: "2016-05-15"␊ - /**␊ - * The location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * The name of the schedule.␊ - */␊ - name: string␊ - /**␊ - * Properties of a schedule.␊ - */␊ - properties: (ScheduleProperties | string)␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "schedules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DevTestLab/labs/servicerunners␊ - */␊ - export interface LabsServicerunnersChildResource {␊ - apiVersion: "2016-05-15"␊ - /**␊ - * Properties of a managed identity␊ - */␊ - identity?: (IdentityProperties | string)␊ - /**␊ - * The location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * The name of the service runner.␊ - */␊ - name: string␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "servicerunners"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a managed identity␊ - */␊ - export interface IdentityProperties {␊ - /**␊ - * The client secret URL of the identity.␊ - */␊ - clientSecretUrl?: string␊ - /**␊ - * The principal id of resource identity.␊ - */␊ - principalId?: string␊ - /**␊ - * The tenant identifier of resource.␊ - */␊ - tenantId?: string␊ - /**␊ - * Managed identity.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DevTestLab/labs/users␊ - */␊ - export interface LabsUsersChildResource {␊ - apiVersion: "2016-05-15"␊ - /**␊ - * The location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * The name of the user profile.␊ - */␊ - name: string␊ - /**␊ - * Properties of a lab user profile.␊ - */␊ - properties: (UserProperties | string)␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "users"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a lab user profile.␊ - */␊ - export interface UserProperties {␊ - /**␊ - * Identity attributes of a lab user.␊ - */␊ - identity?: (UserIdentity | string)␊ - /**␊ - * The provisioning status of the resource.␊ - */␊ - provisioningState?: string␊ - /**␊ - * Properties of a user's secret store.␊ - */␊ - secretStore?: (UserSecretStore | string)␊ - /**␊ - * The unique immutable identifier of a resource (Guid).␊ - */␊ - uniqueIdentifier?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity attributes of a lab user.␊ - */␊ - export interface UserIdentity {␊ - /**␊ - * Set to the app Id of the client JWT making the request.␊ - */␊ - appId?: string␊ - /**␊ - * Set to the object Id of the client JWT making the request. Not all users have object Id. For CSP (reseller) scenarios for example, object Id is not available.␊ - */␊ - objectId?: string␊ - /**␊ - * Set to the principal Id of the client JWT making the request. Service principal will not have the principal Id.␊ - */␊ - principalId?: string␊ - /**␊ - * Set to the principal name / UPN of the client JWT making the request.␊ - */␊ - principalName?: string␊ - /**␊ - * Set to the tenant ID of the client JWT making the request.␊ - */␊ - tenantId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a user's secret store.␊ - */␊ - export interface UserSecretStore {␊ - /**␊ - * The ID of the user's Key vault.␊ - */␊ - keyVaultId?: string␊ - /**␊ - * The URI of the user's Key vault.␊ - */␊ - keyVaultUri?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DevTestLab/labs/virtualmachines␊ - */␊ - export interface LabsVirtualmachinesChildResource {␊ - apiVersion: "2016-05-15"␊ - /**␊ - * The location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * The name of the virtual machine.␊ - */␊ - name: string␊ - /**␊ - * Properties of a virtual machine.␊ - */␊ - properties: (LabVirtualMachineProperties | string)␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "virtualmachines"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a virtual machine.␊ - */␊ - export interface LabVirtualMachineProperties {␊ - /**␊ - * Indicates whether another user can take ownership of the virtual machine␊ - */␊ - allowClaim?: (boolean | string)␊ - /**␊ - * Schedules applicable to a virtual machine. The schedules may have been defined on a VM or on lab level.␊ - */␊ - applicableSchedule?: (ApplicableSchedule | string)␊ - /**␊ - * Properties of an artifact deployment.␊ - */␊ - artifactDeploymentStatus?: (ArtifactDeploymentStatusProperties | string)␊ - /**␊ - * The artifacts to be installed on the virtual machine.␊ - */␊ - artifacts?: (ArtifactInstallProperties[] | string)␊ - /**␊ - * Properties of a virtual machine returned by the Microsoft.Compute API.␊ - */␊ - computeVm?: (ComputeVmProperties | string)␊ - /**␊ - * The email address of creator of the virtual machine.␊ - */␊ - createdByUser?: string␊ - /**␊ - * The object identifier of the creator of the virtual machine.␊ - */␊ - createdByUserId?: string␊ - /**␊ - * The creation date of the virtual machine.␊ - */␊ - createdDate?: string␊ - /**␊ - * The custom image identifier of the virtual machine.␊ - */␊ - customImageId?: string␊ - /**␊ - * Indicates whether the virtual machine is to be created without a public IP address.␊ - */␊ - disallowPublicIpAddress?: (boolean | string)␊ - /**␊ - * The resource ID of the environment that contains this virtual machine, if any.␊ - */␊ - environmentId?: string␊ - /**␊ - * The expiration date for VM.␊ - */␊ - expirationDate?: string␊ - /**␊ - * The fully-qualified domain name of the virtual machine.␊ - */␊ - fqdn?: string␊ - /**␊ - * The reference information for an Azure Marketplace image.␊ - */␊ - galleryImageReference?: (GalleryImageReference | string)␊ - /**␊ - * Indicates whether this virtual machine uses an SSH key for authentication.␊ - */␊ - isAuthenticationWithSshKey?: (boolean | string)␊ - /**␊ - * The lab subnet name of the virtual machine.␊ - */␊ - labSubnetName?: string␊ - /**␊ - * The lab virtual network identifier of the virtual machine.␊ - */␊ - labVirtualNetworkId?: string␊ - /**␊ - * Properties of a network interface.␊ - */␊ - networkInterface?: (NetworkInterfaceProperties | string)␊ - /**␊ - * The notes of the virtual machine.␊ - */␊ - notes?: string␊ - /**␊ - * The OS type of the virtual machine.␊ - */␊ - osType?: string␊ - /**␊ - * The object identifier of the owner of the virtual machine.␊ - */␊ - ownerObjectId?: string␊ - /**␊ - * The user principal name of the virtual machine owner.␊ - */␊ - ownerUserPrincipalName?: string␊ - /**␊ - * The password of the virtual machine administrator.␊ - */␊ - password?: string␊ - /**␊ - * The provisioning status of the resource.␊ - */␊ - provisioningState?: string␊ - /**␊ - * The size of the virtual machine.␊ - */␊ - size?: string␊ - /**␊ - * The SSH key of the virtual machine administrator.␊ - */␊ - sshKey?: string␊ - /**␊ - * Storage type to use for virtual machine (i.e. Standard, Premium).␊ - */␊ - storageType?: string␊ - /**␊ - * The unique immutable identifier of a resource (Guid).␊ - */␊ - uniqueIdentifier?: string␊ - /**␊ - * The user name of the virtual machine.␊ - */␊ - userName?: string␊ - /**␊ - * Tells source of creation of lab virtual machine. Output property only.␊ - */␊ - virtualMachineCreationSource?: (("FromCustomImage" | "FromGalleryImage") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DevTestLab/labs/virtualnetworks␊ - */␊ - export interface LabsVirtualnetworksChildResource {␊ - apiVersion: "2016-05-15"␊ - /**␊ - * The location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * The name of the virtual network.␊ - */␊ - name: string␊ - /**␊ - * Properties of a virtual network.␊ - */␊ - properties: (VirtualNetworkProperties | string)␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "virtualnetworks"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a virtual network.␊ - */␊ - export interface VirtualNetworkProperties {␊ - /**␊ - * The allowed subnets of the virtual network.␊ - */␊ - allowedSubnets?: (Subnet[] | string)␊ - /**␊ - * The description of the virtual network.␊ - */␊ - description?: string␊ - /**␊ - * The Microsoft.Network resource identifier of the virtual network.␊ - */␊ - externalProviderResourceId?: string␊ - /**␊ - * The external subnet properties.␊ - */␊ - externalSubnets?: (ExternalSubnet[] | string)␊ - /**␊ - * The provisioning status of the resource.␊ - */␊ - provisioningState?: string␊ - /**␊ - * The subnet overrides of the virtual network.␊ - */␊ - subnetOverrides?: (SubnetOverride[] | string)␊ - /**␊ - * The unique immutable identifier of a resource (Guid).␊ - */␊ - uniqueIdentifier?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Subnet information.␊ - */␊ - export interface Subnet {␊ - /**␊ - * The permission policy of the subnet for allowing public IP addresses (i.e. Allow, Deny)).␊ - */␊ - allowPublicIp?: (("Default" | "Deny" | "Allow") | string)␊ - /**␊ - * The name of the subnet as seen in the lab.␊ - */␊ - labSubnetName?: string␊ - /**␊ - * The resource ID of the subnet.␊ - */␊ - resourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Subnet information as returned by the Microsoft.Network API.␊ - */␊ - export interface ExternalSubnet {␊ - /**␊ - * Gets or sets the identifier.␊ - */␊ - id?: string␊ - /**␊ - * Gets or sets the name.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Property overrides on a subnet of a virtual network.␊ - */␊ - export interface SubnetOverride {␊ - /**␊ - * The name given to the subnet within the lab.␊ - */␊ - labSubnetName?: string␊ - /**␊ - * The resource ID of the subnet.␊ - */␊ - resourceId?: string␊ - /**␊ - * Configuration for public IP address sharing.␊ - */␊ - sharedPublicIpAddressConfiguration?: (SubnetSharedPublicIpAddressConfiguration | string)␊ - /**␊ - * Indicates whether this subnet can be used during virtual machine creation (i.e. Allow, Deny).␊ - */␊ - useInVmCreationPermission?: (("Default" | "Deny" | "Allow") | string)␊ - /**␊ - * Indicates whether public IP addresses can be assigned to virtual machines on this subnet (i.e. Allow, Deny).␊ - */␊ - usePublicIpAddressPermission?: (("Default" | "Deny" | "Allow") | string)␊ - /**␊ - * The virtual network pool associated with this subnet.␊ - */␊ - virtualNetworkPoolName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Configuration for public IP address sharing.␊ - */␊ - export interface SubnetSharedPublicIpAddressConfiguration {␊ - /**␊ - * Backend ports that virtual machines on this subnet are allowed to expose␊ - */␊ - allowedPorts?: (Port[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a network port.␊ - */␊ - export interface Port {␊ - /**␊ - * Backend port of the target virtual machine.␊ - */␊ - backendPort?: (number | string)␊ - /**␊ - * Protocol type of the port.␊ - */␊ - transportProtocol?: (("Tcp" | "Udp") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DevTestLab/labs/artifactsources␊ - */␊ - export interface LabsArtifactsources {␊ - apiVersion: "2016-05-15"␊ - /**␊ - * The location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * The name of the artifact source.␊ - */␊ - name: string␊ - /**␊ - * Properties of an artifact source.␊ - */␊ - properties: (ArtifactSourceProperties | string)␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.DevTestLab/labs/artifactsources"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DevTestLab/labs/customimages␊ - */␊ - export interface LabsCustomimages {␊ - apiVersion: "2016-05-15"␊ - /**␊ - * The location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * The name of the custom image.␊ - */␊ - name: string␊ - /**␊ - * Properties of a custom image.␊ - */␊ - properties: (CustomImageProperties | string)␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.DevTestLab/labs/customimages"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DevTestLab/labs/formulas␊ - */␊ - export interface LabsFormulas {␊ - apiVersion: "2016-05-15"␊ - /**␊ - * The location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * The name of the formula.␊ - */␊ - name: string␊ - /**␊ - * Properties of a formula.␊ - */␊ - properties: (FormulaProperties | string)␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.DevTestLab/labs/formulas"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DevTestLab/labs/policysets/policies␊ - */␊ - export interface LabsPolicysetsPolicies {␊ - apiVersion: "2016-05-15"␊ - /**␊ - * The location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * The name of the policy.␊ - */␊ - name: string␊ - /**␊ - * Properties of a Policy.␊ - */␊ - properties: (PolicyProperties | string)␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.DevTestLab/labs/policysets/policies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a Policy.␊ - */␊ - export interface PolicyProperties {␊ - /**␊ - * The description of the policy.␊ - */␊ - description?: string␊ - /**␊ - * The evaluator type of the policy (i.e. AllowedValuesPolicy, MaxValuePolicy).␊ - */␊ - evaluatorType?: (("AllowedValuesPolicy" | "MaxValuePolicy") | string)␊ - /**␊ - * The fact data of the policy.␊ - */␊ - factData?: string␊ - /**␊ - * The fact name of the policy (e.g. LabVmCount, LabVmSize, MaxVmsAllowedPerLab, etc.␊ - */␊ - factName?: (("UserOwnedLabVmCount" | "UserOwnedLabPremiumVmCount" | "LabVmCount" | "LabPremiumVmCount" | "LabVmSize" | "GalleryImage" | "UserOwnedLabVmCountInSubnet" | "LabTargetCost") | string)␊ - /**␊ - * The provisioning status of the resource.␊ - */␊ - provisioningState?: string␊ - /**␊ - * The status of the policy.␊ - */␊ - status?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * The threshold of the policy (i.e. a number for MaxValuePolicy, and a JSON array of values for AllowedValuesPolicy).␊ - */␊ - threshold?: string␊ - /**␊ - * The unique immutable identifier of a resource (Guid).␊ - */␊ - uniqueIdentifier?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DevTestLab/labs/schedules␊ - */␊ - export interface LabsSchedules {␊ - apiVersion: "2016-05-15"␊ - /**␊ - * The location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * The name of the schedule.␊ - */␊ - name: string␊ - /**␊ - * Properties of a schedule.␊ - */␊ - properties: (ScheduleProperties | string)␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.DevTestLab/labs/schedules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DevTestLab/labs/virtualmachines␊ - */␊ - export interface LabsVirtualmachines {␊ - apiVersion: "2016-05-15"␊ - /**␊ - * The location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * The name of the virtual machine.␊ - */␊ - name: string␊ - /**␊ - * Properties of a virtual machine.␊ - */␊ - properties: (LabVirtualMachineProperties | string)␊ - resources?: LabsVirtualmachinesSchedulesChildResource[]␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.DevTestLab/labs/virtualmachines"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DevTestLab/labs/virtualmachines/schedules␊ - */␊ - export interface LabsVirtualmachinesSchedulesChildResource {␊ - apiVersion: "2016-05-15"␊ - /**␊ - * The location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * The name of the schedule.␊ - */␊ - name: string␊ - /**␊ - * Properties of a schedule.␊ - */␊ - properties: (ScheduleProperties | string)␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "schedules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DevTestLab/labs/virtualnetworks␊ - */␊ - export interface LabsVirtualnetworks {␊ - apiVersion: "2016-05-15"␊ - /**␊ - * The location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * The name of the virtual network.␊ - */␊ - name: string␊ - /**␊ - * Properties of a virtual network.␊ - */␊ - properties: (VirtualNetworkProperties | string)␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.DevTestLab/labs/virtualnetworks"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DevTestLab/labs/costs␊ - */␊ - export interface LabsCosts {␊ - apiVersion: "2016-05-15"␊ - /**␊ - * The location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * The name of the cost.␊ - */␊ - name: string␊ - /**␊ - * Properties of a cost item.␊ - */␊ - properties: (LabCostProperties | string)␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.DevTestLab/labs/costs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DevTestLab/labs/notificationchannels␊ - */␊ - export interface LabsNotificationchannels {␊ - apiVersion: "2016-05-15"␊ - /**␊ - * The location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * The name of the notificationChannel.␊ - */␊ - name: string␊ - /**␊ - * Properties of a schedule.␊ - */␊ - properties: (NotificationChannelProperties | string)␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.DevTestLab/labs/notificationchannels"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DevTestLab/labs/servicerunners␊ - */␊ - export interface LabsServicerunners {␊ - apiVersion: "2016-05-15"␊ - /**␊ - * Properties of a managed identity␊ - */␊ - identity?: (IdentityProperties | string)␊ - /**␊ - * The location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * The name of the service runner.␊ - */␊ - name: string␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.DevTestLab/labs/servicerunners"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DevTestLab/labs/users␊ - */␊ - export interface LabsUsers {␊ - apiVersion: "2016-05-15"␊ - /**␊ - * The location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * The name of the user profile.␊ - */␊ - name: string␊ - /**␊ - * Properties of a lab user profile.␊ - */␊ - properties: (UserProperties | string)␊ - resources?: (LabsUsersDisksChildResource | LabsUsersEnvironmentsChildResource | LabsUsersSecretsChildResource)[]␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.DevTestLab/labs/users"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DevTestLab/labs/users/disks␊ - */␊ - export interface LabsUsersDisksChildResource {␊ - apiVersion: "2016-05-15"␊ - /**␊ - * The location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * The name of the disk.␊ - */␊ - name: string␊ - /**␊ - * Properties of a disk.␊ - */␊ - properties: (DiskProperties | string)␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "disks"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a disk.␊ - */␊ - export interface DiskProperties {␊ - /**␊ - * When backed by a blob, the name of the VHD blob without extension.␊ - */␊ - diskBlobName?: string␊ - /**␊ - * The size of the disk in Gibibytes.␊ - */␊ - diskSizeGiB?: (number | string)␊ - /**␊ - * The storage type for the disk (i.e. Standard, Premium).␊ - */␊ - diskType?: (("Standard" | "Premium") | string)␊ - /**␊ - * When backed by a blob, the URI of underlying blob.␊ - */␊ - diskUri?: string␊ - /**␊ - * The host caching policy of the disk (i.e. None, ReadOnly, ReadWrite).␊ - */␊ - hostCaching?: string␊ - /**␊ - * The resource ID of the VM to which this disk is leased.␊ - */␊ - leasedByLabVmId?: string␊ - /**␊ - * When backed by managed disk, this is the ID of the compute disk resource.␊ - */␊ - managedDiskId?: string␊ - /**␊ - * The provisioning status of the resource.␊ - */␊ - provisioningState?: string␊ - /**␊ - * The unique immutable identifier of a resource (Guid).␊ - */␊ - uniqueIdentifier?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DevTestLab/labs/users/environments␊ - */␊ - export interface LabsUsersEnvironmentsChildResource {␊ - apiVersion: "2016-05-15"␊ - /**␊ - * The location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * The name of the environment.␊ - */␊ - name: string␊ - /**␊ - * Properties of an environment.␊ - */␊ - properties: (EnvironmentProperties | string)␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "environments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of an environment.␊ - */␊ - export interface EnvironmentProperties {␊ - /**␊ - * The display name of the Azure Resource Manager template that produced the environment.␊ - */␊ - armTemplateDisplayName?: string␊ - /**␊ - * Properties of an environment deployment.␊ - */␊ - deploymentProperties?: (EnvironmentDeploymentProperties | string)␊ - /**␊ - * The provisioning status of the resource.␊ - */␊ - provisioningState?: string␊ - /**␊ - * The unique immutable identifier of a resource (Guid).␊ - */␊ - uniqueIdentifier?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of an environment deployment.␊ - */␊ - export interface EnvironmentDeploymentProperties {␊ - /**␊ - * The Azure Resource Manager template's identifier.␊ - */␊ - armTemplateId?: string␊ - /**␊ - * The parameters of the Azure Resource Manager template.␊ - */␊ - parameters?: (ArmTemplateParameterProperties[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of an Azure Resource Manager template parameter.␊ - */␊ - export interface ArmTemplateParameterProperties {␊ - /**␊ - * The name of the template parameter.␊ - */␊ - name?: string␊ - /**␊ - * The value of the template parameter.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DevTestLab/labs/users/secrets␊ - */␊ - export interface LabsUsersSecretsChildResource {␊ - apiVersion: "2016-05-15"␊ - /**␊ - * The location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * The name of the secret.␊ - */␊ - name: string␊ - /**␊ - * Properties of a secret.␊ - */␊ - properties: (SecretProperties5 | string)␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "secrets"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a secret.␊ - */␊ - export interface SecretProperties5 {␊ - /**␊ - * The provisioning status of the resource.␊ - */␊ - provisioningState?: string␊ - /**␊ - * The unique immutable identifier of a resource (Guid).␊ - */␊ - uniqueIdentifier?: string␊ - /**␊ - * The value of the secret for secret creation.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DevTestLab/labs/virtualmachines/schedules␊ - */␊ - export interface LabsVirtualmachinesSchedules {␊ - apiVersion: "2016-05-15"␊ - /**␊ - * The location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * The name of the schedule.␊ - */␊ - name: string␊ - /**␊ - * Properties of a schedule.␊ - */␊ - properties: (ScheduleProperties | string)␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.DevTestLab/labs/virtualmachines/schedules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DevTestLab/labs/users/disks␊ - */␊ - export interface LabsUsersDisks {␊ - apiVersion: "2016-05-15"␊ - /**␊ - * The location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * The name of the disk.␊ - */␊ - name: string␊ - /**␊ - * Properties of a disk.␊ - */␊ - properties: (DiskProperties | string)␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.DevTestLab/labs/users/disks"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DevTestLab/labs/users/environments␊ - */␊ - export interface LabsUsersEnvironments {␊ - apiVersion: "2016-05-15"␊ - /**␊ - * The location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * The name of the environment.␊ - */␊ - name: string␊ - /**␊ - * Properties of an environment.␊ - */␊ - properties: (EnvironmentProperties | string)␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.DevTestLab/labs/users/environments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DevTestLab/labs/users/secrets␊ - */␊ - export interface LabsUsersSecrets {␊ - apiVersion: "2016-05-15"␊ - /**␊ - * The location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * The name of the secret.␊ - */␊ - name: string␊ - /**␊ - * Properties of a secret.␊ - */␊ - properties: (SecretProperties5 | string)␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.DevTestLab/labs/users/secrets"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.RecoveryServices/vaults/replicationAlertSettings␊ - */␊ - export interface VaultsReplicationAlertSettings {␊ - apiVersion: "2018-01-10"␊ - /**␊ - * The name of the email notification(alert) configuration.␊ - */␊ - name: string␊ - /**␊ - * Properties of a configure alert request.␊ - */␊ - properties: (ConfigureAlertRequestProperties | string)␊ - type: "Microsoft.RecoveryServices/vaults/replicationAlertSettings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a configure alert request.␊ - */␊ - export interface ConfigureAlertRequestProperties {␊ - /**␊ - * The custom email address for sending emails.␊ - */␊ - customEmailAddresses?: (string[] | string)␊ - /**␊ - * The locale for the email notification.␊ - */␊ - locale?: string␊ - /**␊ - * A value indicating whether to send email to subscription administrator.␊ - */␊ - sendToOwners?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.RecoveryServices/vaults/replicationFabrics␊ - */␊ - export interface VaultsReplicationFabrics {␊ - apiVersion: "2018-01-10"␊ - /**␊ - * Name of the ASR fabric.␊ - */␊ - name: string␊ - /**␊ - * Properties of site details provided during the time of site creation␊ - */␊ - properties: (FabricCreationInputProperties | string)␊ - resources?: (VaultsReplicationFabricsReplicationProtectionContainersChildResource | VaultsReplicationFabricsReplicationRecoveryServicesProvidersChildResource | VaultsReplicationFabricsReplicationvCentersChildResource)[]␊ - type: "Microsoft.RecoveryServices/vaults/replicationFabrics"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of site details provided during the time of site creation␊ - */␊ - export interface FabricCreationInputProperties {␊ - /**␊ - * Fabric provider specific settings.␊ - */␊ - customDetails?: (FabricSpecificCreationInput | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Fabric provider specific settings.␊ - */␊ - export interface AzureFabricCreationInput {␊ - instanceType: "Azure"␊ - /**␊ - * The Location.␊ - */␊ - location?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VMwareV2 fabric provider specific settings.␊ - */␊ - export interface VMwareV2FabricCreationInput {␊ - instanceType: "VMwareV2"␊ - /**␊ - * The ARM Id of the migration solution.␊ - */␊ - migrationSolutionId: string␊ - /**␊ - * The ARM Id of the physical site.␊ - */␊ - physicalSiteId?: string␊ - /**␊ - * The ARM Id of the VMware site.␊ - */␊ - vmwareSiteId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers␊ - */␊ - export interface VaultsReplicationFabricsReplicationProtectionContainersChildResource {␊ - apiVersion: "2018-01-10"␊ - /**␊ - * Unique protection container ARM name.␊ - */␊ - name: string␊ - /**␊ - * Create protection container input properties.␊ - */␊ - properties: (CreateProtectionContainerInputProperties | string)␊ - type: "replicationProtectionContainers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Create protection container input properties.␊ - */␊ - export interface CreateProtectionContainerInputProperties {␊ - /**␊ - * Provider specific inputs for container creation.␊ - */␊ - providerSpecificInput?: (ReplicationProviderSpecificContainerCreationInput[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A2A cloud creation input.␊ - */␊ - export interface A2AContainerCreationInput {␊ - instanceType: "A2A"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VMwareCbt container creation input.␊ - */␊ - export interface VMwareCbtContainerCreationInput {␊ - instanceType: "VMwareCbt"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders␊ - */␊ - export interface VaultsReplicationFabricsReplicationRecoveryServicesProvidersChildResource {␊ - apiVersion: "2018-01-10"␊ - /**␊ - * Recovery services provider name.␊ - */␊ - name: string␊ - /**␊ - * The properties of an add provider request.␊ - */␊ - properties: (AddRecoveryServicesProviderInputProperties | string)␊ - type: "replicationRecoveryServicesProviders"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of an add provider request.␊ - */␊ - export interface AddRecoveryServicesProviderInputProperties {␊ - /**␊ - * Identity provider input.␊ - */␊ - authenticationIdentityInput: (IdentityProviderInput | string)␊ - /**␊ - * The name of the machine where the provider is getting added.␊ - */␊ - machineName: string␊ - /**␊ - * Identity provider input.␊ - */␊ - resourceAccessIdentityInput: (IdentityProviderInput | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity provider input.␊ - */␊ - export interface IdentityProviderInput {␊ - /**␊ - * The base authority for Azure Active Directory authentication.␊ - */␊ - aadAuthority: string␊ - /**␊ - * The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.␊ - */␊ - applicationId: string␊ - /**␊ - * The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services.␊ - */␊ - audience: string␊ - /**␊ - * The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services.␊ - */␊ - objectId: string␊ - /**␊ - * The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.␊ - */␊ - tenantId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters␊ - */␊ - export interface VaultsReplicationFabricsReplicationvCentersChildResource {␊ - apiVersion: "2018-01-10"␊ - /**␊ - * vCenter name.␊ - */␊ - name: string␊ - /**␊ - * The properties of an add vCenter request.␊ - */␊ - properties: (AddVCenterRequestProperties | string)␊ - type: "replicationvCenters"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of an add vCenter request.␊ - */␊ - export interface AddVCenterRequestProperties {␊ - /**␊ - * The friendly name of the vCenter.␊ - */␊ - friendlyName?: string␊ - /**␊ - * The IP address of the vCenter to be discovered.␊ - */␊ - ipAddress?: string␊ - /**␊ - * The port number for discovery.␊ - */␊ - port?: string␊ - /**␊ - * The process server Id from where the discovery is orchestrated.␊ - */␊ - processServerId?: string␊ - /**␊ - * The account Id which has privileges to discover the vCenter.␊ - */␊ - runAsAccountId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings␊ - */␊ - export interface VaultsReplicationFabricsReplicationNetworksReplicationNetworkMappings {␊ - apiVersion: "2018-01-10"␊ - /**␊ - * Network mapping name.␊ - */␊ - name: string␊ - /**␊ - * Common input details for network mapping operation.␊ - */␊ - properties: (CreateNetworkMappingInputProperties | string)␊ - type: "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Common input details for network mapping operation.␊ - */␊ - export interface CreateNetworkMappingInputProperties {␊ - /**␊ - * Input details specific to fabrics during Network Mapping.␊ - */␊ - fabricSpecificDetails?: (FabricSpecificCreateNetworkMappingInput | string)␊ - /**␊ - * Recovery fabric Name.␊ - */␊ - recoveryFabricName?: string␊ - /**␊ - * Recovery network Id.␊ - */␊ - recoveryNetworkId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Create network mappings input properties/behavior specific to Azure to Azure Network mapping.␊ - */␊ - export interface AzureToAzureCreateNetworkMappingInput {␊ - instanceType: "AzureToAzure"␊ - /**␊ - * The primary azure vnet Id.␊ - */␊ - primaryNetworkId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Create network mappings input properties/behavior specific to Vmm to Azure Network mapping.␊ - */␊ - export interface VmmToAzureCreateNetworkMappingInput {␊ - instanceType: "VmmToAzure"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Create network mappings input properties/behavior specific to vmm to vmm Network mapping.␊ - */␊ - export interface VmmToVmmCreateNetworkMappingInput {␊ - instanceType: "VmmToVmm"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers␊ - */␊ - export interface VaultsReplicationFabricsReplicationProtectionContainers {␊ - apiVersion: "2018-01-10"␊ - /**␊ - * Unique protection container ARM name.␊ - */␊ - name: string␊ - /**␊ - * Create protection container input properties.␊ - */␊ - properties: (CreateProtectionContainerInputProperties | string)␊ - resources?: (VaultsReplicationFabricsReplicationProtectionContainersReplicationMigrationItemsChildResource | VaultsReplicationFabricsReplicationProtectionContainersReplicationProtectedItemsChildResource | VaultsReplicationFabricsReplicationProtectionContainersReplicationProtectionContainerMappingsChildResource)[]␊ - type: "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems␊ - */␊ - export interface VaultsReplicationFabricsReplicationProtectionContainersReplicationMigrationItemsChildResource {␊ - apiVersion: "2018-01-10"␊ - /**␊ - * Migration item name.␊ - */␊ - name: string␊ - /**␊ - * Enable migration input properties.␊ - */␊ - properties: (EnableMigrationInputProperties | string)␊ - type: "replicationMigrationItems"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Enable migration input properties.␊ - */␊ - export interface EnableMigrationInputProperties {␊ - /**␊ - * The policy Id.␊ - */␊ - policyId: string␊ - /**␊ - * Enable migration provider specific input.␊ - */␊ - providerSpecificDetails: (EnableMigrationProviderSpecificInput | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VMwareCbt specific enable migration input.␊ - */␊ - export interface VMwareCbtEnableMigrationInput {␊ - /**␊ - * The data mover RunAs account Id.␊ - */␊ - dataMoverRunAsAccountId: string␊ - /**␊ - * The disks to include list.␊ - */␊ - disksToInclude: (VMwareCbtDiskInput[] | string)␊ - instanceType: "VMwareCbt"␊ - /**␊ - * License type.␊ - */␊ - licenseType?: (("NotSpecified" | "NoLicenseType" | "WindowsServer") | string)␊ - /**␊ - * A value indicating whether auto resync is to be done.␊ - */␊ - performAutoResync?: string␊ - /**␊ - * The snapshot RunAs account Id.␊ - */␊ - snapshotRunAsAccountId: string␊ - /**␊ - * The target availability set ARM Id.␊ - */␊ - targetAvailabilitySetId?: string␊ - /**␊ - * The target availability zone.␊ - */␊ - targetAvailabilityZone?: string␊ - /**␊ - * The target boot diagnostics storage account ARM Id.␊ - */␊ - targetBootDiagnosticsStorageAccountId?: string␊ - /**␊ - * The target network ARM Id.␊ - */␊ - targetNetworkId: string␊ - /**␊ - * The target resource group ARM Id.␊ - */␊ - targetResourceGroupId: string␊ - /**␊ - * The target subnet name.␊ - */␊ - targetSubnetName?: string␊ - /**␊ - * The target VM name.␊ - */␊ - targetVmName?: string␊ - /**␊ - * The target VM size.␊ - */␊ - targetVmSize?: string␊ - /**␊ - * The ARM Id of the VM discovered in VMware.␊ - */␊ - vmwareMachineId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VMwareCbt disk input.␊ - */␊ - export interface VMwareCbtDiskInput {␊ - /**␊ - * The DiskEncryptionSet ARM Id.␊ - */␊ - diskEncryptionSetId?: string␊ - /**␊ - * The disk Id.␊ - */␊ - diskId: string␊ - /**␊ - * The disk type.␊ - */␊ - diskType?: (("Standard_LRS" | "Premium_LRS" | "StandardSSD_LRS") | string)␊ - /**␊ - * A value indicating whether the disk is the OS disk.␊ - */␊ - isOSDisk: string␊ - /**␊ - * The log storage account ARM Id.␊ - */␊ - logStorageAccountId: string␊ - /**␊ - * The key vault secret name of the log storage account.␊ - */␊ - logStorageAccountSasSecretName: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems␊ - */␊ - export interface VaultsReplicationFabricsReplicationProtectionContainersReplicationProtectedItemsChildResource {␊ - apiVersion: "2018-01-10"␊ - /**␊ - * A name for the replication protected item.␊ - */␊ - name: string␊ - /**␊ - * Enable protection input properties.␊ - */␊ - properties: (EnableProtectionInputProperties | string)␊ - type: "replicationProtectedItems"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Enable protection input properties.␊ - */␊ - export interface EnableProtectionInputProperties {␊ - /**␊ - * The Policy Id.␊ - */␊ - policyId?: string␊ - /**␊ - * The protectable item Id.␊ - */␊ - protectableItemId?: string␊ - /**␊ - * Enable protection provider specific input.␊ - */␊ - providerSpecificDetails?: (EnableProtectionProviderSpecificInput | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A2A enable protection input.␊ - */␊ - export interface A2AEnableProtectionInput {␊ - /**␊ - * Recovery disk encryption info (BEK and KEK).␊ - */␊ - diskEncryptionInfo?: (DiskEncryptionInfo | string)␊ - /**␊ - * The fabric specific object Id of the virtual machine.␊ - */␊ - fabricObjectId?: string␊ - instanceType: "A2A"␊ - /**␊ - * The multi vm group name.␊ - */␊ - multiVmGroupName?: string␊ - /**␊ - * The recovery availability set Id.␊ - */␊ - recoveryAvailabilitySetId?: string␊ - /**␊ - * The boot diagnostic storage account.␊ - */␊ - recoveryBootDiagStorageAccountId?: string␊ - /**␊ - * The recovery cloud service Id. Valid for V1 scenarios.␊ - */␊ - recoveryCloudServiceId?: string␊ - /**␊ - * The recovery container Id.␊ - */␊ - recoveryContainerId?: string␊ - /**␊ - * The recovery resource group Id. Valid for V2 scenarios.␊ - */␊ - recoveryResourceGroupId?: string␊ - /**␊ - * The list of vm disk details.␊ - */␊ - vmDisks?: (A2AVmDiskInputDetails[] | string)␊ - /**␊ - * The list of vm managed disk details.␊ - */␊ - vmManagedDisks?: (A2AVmManagedDiskInputDetails[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Recovery disk encryption info (BEK and KEK).␊ - */␊ - export interface DiskEncryptionInfo {␊ - /**␊ - * Disk Encryption Key Information (BitLocker Encryption Key (BEK) on Windows).␊ - */␊ - diskEncryptionKeyInfo?: (DiskEncryptionKeyInfo | string)␊ - /**␊ - * Key Encryption Key (KEK) information.␊ - */␊ - keyEncryptionKeyInfo?: (KeyEncryptionKeyInfo | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Disk Encryption Key Information (BitLocker Encryption Key (BEK) on Windows).␊ - */␊ - export interface DiskEncryptionKeyInfo {␊ - /**␊ - * The KeyVault resource ARM id for secret.␊ - */␊ - keyVaultResourceArmId?: string␊ - /**␊ - * The secret url / identifier.␊ - */␊ - secretIdentifier?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Key Encryption Key (KEK) information.␊ - */␊ - export interface KeyEncryptionKeyInfo {␊ - /**␊ - * The key url / identifier.␊ - */␊ - keyIdentifier?: string␊ - /**␊ - * The KeyVault resource ARM id for key.␊ - */␊ - keyVaultResourceArmId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure VM disk input details.␊ - */␊ - export interface A2AVmDiskInputDetails {␊ - /**␊ - * The disk Uri.␊ - */␊ - diskUri?: string␊ - /**␊ - * The primary staging storage account Id.␊ - */␊ - primaryStagingAzureStorageAccountId?: string␊ - /**␊ - * The recovery VHD storage account Id.␊ - */␊ - recoveryAzureStorageAccountId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure VM managed disk input details.␊ - */␊ - export interface A2AVmManagedDiskInputDetails {␊ - /**␊ - * The disk Id.␊ - */␊ - diskId?: string␊ - /**␊ - * The primary staging storage account Arm Id.␊ - */␊ - primaryStagingAzureStorageAccountId?: string␊ - /**␊ - * The replica disk type. Its an optional value and will be same as source disk type if not user provided.␊ - */␊ - recoveryReplicaDiskAccountType?: string␊ - /**␊ - * The target resource group Arm Id.␊ - */␊ - recoveryResourceGroupId?: string␊ - /**␊ - * The target disk type after failover. Its an optional value and will be same as source disk type if not user provided.␊ - */␊ - recoveryTargetDiskAccountType?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure specific enable protection input.␊ - */␊ - export interface HyperVReplicaAzureEnableProtectionInput {␊ - /**␊ - * The list of VHD IDs of disks to be protected.␊ - */␊ - disksToInclude?: (string[] | string)␊ - /**␊ - * The selected option to enable RDP\\SSH on target vm after failover. String value of {SrsDataContract.EnableRDPOnTargetOption} enum.␊ - */␊ - enableRdpOnTargetOption?: string␊ - /**␊ - * The Hyper-V host Vm Id.␊ - */␊ - hvHostVmId?: string␊ - instanceType: "HyperVReplicaAzure"␊ - /**␊ - * The storage account to be used for logging during replication.␊ - */␊ - logStorageAccountId?: string␊ - /**␊ - * The OS type associated with vm.␊ - */␊ - osType?: string␊ - /**␊ - * The selected target Azure network Id.␊ - */␊ - targetAzureNetworkId?: string␊ - /**␊ - * The selected target Azure subnet Id.␊ - */␊ - targetAzureSubnetId?: string␊ - /**␊ - * The Id of the target resource group (for classic deployment) in which the failover VM is to be created.␊ - */␊ - targetAzureV1ResourceGroupId?: string␊ - /**␊ - * The Id of the target resource group (for resource manager deployment) in which the failover VM is to be created.␊ - */␊ - targetAzureV2ResourceGroupId?: string␊ - /**␊ - * The target azure Vm Name.␊ - */␊ - targetAzureVmName?: string␊ - /**␊ - * The storage account name.␊ - */␊ - targetStorageAccountId?: string␊ - /**␊ - * A value indicating whether managed disks should be used during failover.␊ - */␊ - useManagedDisks?: string␊ - /**␊ - * The OS disk VHD id associated with vm.␊ - */␊ - vhdId?: string␊ - /**␊ - * The Vm Name.␊ - */␊ - vmName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VMware Azure specific enable protection input.␊ - */␊ - export interface InMageAzureV2EnableProtectionInput {␊ - /**␊ - * The disks to include list.␊ - */␊ - disksToInclude?: (string[] | string)␊ - /**␊ - * The selected option to enable RDP\\SSH on target vm after failover. String value of {SrsDataContract.EnableRDPOnTargetOption} enum.␊ - */␊ - enableRdpOnTargetOption?: string␊ - instanceType: "InMageAzureV2"␊ - /**␊ - * The storage account to be used for logging during replication.␊ - */␊ - logStorageAccountId?: string␊ - /**␊ - * The Master target Id.␊ - */␊ - masterTargetId?: string␊ - /**␊ - * The multi vm group Id.␊ - */␊ - multiVmGroupId?: string␊ - /**␊ - * The multi vm group name.␊ - */␊ - multiVmGroupName?: string␊ - /**␊ - * The Process Server Id.␊ - */␊ - processServerId?: string␊ - /**␊ - * The CS account Id.␊ - */␊ - runAsAccountId?: string␊ - /**␊ - * The storage account name.␊ - */␊ - storageAccountId: string␊ - /**␊ - * The selected target Azure network Id.␊ - */␊ - targetAzureNetworkId?: string␊ - /**␊ - * The selected target Azure subnet Id.␊ - */␊ - targetAzureSubnetId?: string␊ - /**␊ - * The Id of the target resource group (for classic deployment) in which the failover VM is to be created.␊ - */␊ - targetAzureV1ResourceGroupId?: string␊ - /**␊ - * The Id of the target resource group (for resource manager deployment) in which the failover VM is to be created.␊ - */␊ - targetAzureV2ResourceGroupId?: string␊ - /**␊ - * The target azure Vm Name.␊ - */␊ - targetAzureVmName?: string␊ - /**␊ - * A value indicating whether managed disks should be used during failover.␊ - */␊ - useManagedDisks?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VMware Azure specific enable protection input.␊ - */␊ - export interface InMageEnableProtectionInput {␊ - /**␊ - * The target data store name.␊ - */␊ - datastoreName?: string␊ - /**␊ - * DiskExclusionInput when doing enable protection of virtual machine in InMage provider.␊ - */␊ - diskExclusionInput?: (InMageDiskExclusionInput | string)␊ - /**␊ - * The disks to include list.␊ - */␊ - disksToInclude?: (string[] | string)␊ - instanceType: "InMage"␊ - /**␊ - * The Master Target Id.␊ - */␊ - masterTargetId: string␊ - /**␊ - * The multi vm group Id.␊ - */␊ - multiVmGroupId: string␊ - /**␊ - * The multi vm group name.␊ - */␊ - multiVmGroupName: string␊ - /**␊ - * The Process Server Id.␊ - */␊ - processServerId: string␊ - /**␊ - * The retention drive to use on the MT.␊ - */␊ - retentionDrive: string␊ - /**␊ - * The CS account Id.␊ - */␊ - runAsAccountId?: string␊ - /**␊ - * The Vm Name.␊ - */␊ - vmFriendlyName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DiskExclusionInput when doing enable protection of virtual machine in InMage provider.␊ - */␊ - export interface InMageDiskExclusionInput {␊ - /**␊ - * The guest disk signature based option for disk exclusion.␊ - */␊ - diskSignatureOptions?: (InMageDiskSignatureExclusionOptions[] | string)␊ - /**␊ - * The volume label based option for disk exclusion.␊ - */␊ - volumeOptions?: (InMageVolumeExclusionOptions[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Guest disk signature based disk exclusion option when doing enable protection of virtual machine in InMage provider.␊ - */␊ - export interface InMageDiskSignatureExclusionOptions {␊ - /**␊ - * The guest signature of disk to be excluded from replication.␊ - */␊ - diskSignature?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Guest disk signature based disk exclusion option when doing enable protection of virtual machine in InMage provider.␊ - */␊ - export interface InMageVolumeExclusionOptions {␊ - /**␊ - * The value indicating whether to exclude multi volume disk or not. If a disk has multiple volumes and one of the volume has label matching with VolumeLabel this disk will be excluded from replication if OnlyExcludeIfSingleVolume is false.␊ - */␊ - onlyExcludeIfSingleVolume?: string␊ - /**␊ - * The volume label. The disk having any volume with this label will be excluded from replication.␊ - */␊ - volumeLabel?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * San enable protection provider specific input.␊ - */␊ - export interface SanEnableProtectionInput {␊ - instanceType: "San"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings␊ - */␊ - export interface VaultsReplicationFabricsReplicationProtectionContainersReplicationProtectionContainerMappingsChildResource {␊ - apiVersion: "2018-01-10"␊ - /**␊ - * Protection container mapping name.␊ - */␊ - name: string␊ - /**␊ - * Configure pairing input properties.␊ - */␊ - properties: (CreateProtectionContainerMappingInputProperties | string)␊ - type: "replicationProtectionContainerMappings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Configure pairing input properties.␊ - */␊ - export interface CreateProtectionContainerMappingInputProperties {␊ - /**␊ - * Applicable policy.␊ - */␊ - policyId?: string␊ - /**␊ - * Provider specific input for pairing operations.␊ - */␊ - providerSpecificInput?: (ReplicationProviderSpecificContainerMappingInput | string)␊ - /**␊ - * The target unique protection container name.␊ - */␊ - targetProtectionContainerId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A2A container mapping input.␊ - */␊ - export interface A2AContainerMappingInput {␊ - /**␊ - * A value indicating whether the auto update is enabled.␊ - */␊ - agentAutoUpdateStatus?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * The automation account arm id.␊ - */␊ - automationAccountArmId?: string␊ - instanceType: "A2A"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VMwareCbt container mapping input.␊ - */␊ - export interface VMwareCbtContainerMappingInput {␊ - instanceType: "VMwareCbt"␊ - /**␊ - * The target key vault ARM Id.␊ - */␊ - keyVaultId: string␊ - /**␊ - * The target key vault URL.␊ - */␊ - keyVaultUri: string␊ - /**␊ - * The secret name of the service bus connection string.␊ - */␊ - serviceBusConnectionStringSecretName: string␊ - /**␊ - * The storage account ARM Id.␊ - */␊ - storageAccountId: string␊ - /**␊ - * The secret name of the storage account.␊ - */␊ - storageAccountSasSecretName: string␊ - /**␊ - * The target location.␊ - */␊ - targetLocation: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems␊ - */␊ - export interface VaultsReplicationFabricsReplicationProtectionContainersReplicationMigrationItems {␊ - apiVersion: "2018-01-10"␊ - /**␊ - * Migration item name.␊ - */␊ - name: string␊ - /**␊ - * Enable migration input properties.␊ - */␊ - properties: (EnableMigrationInputProperties | string)␊ - type: "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems␊ - */␊ - export interface VaultsReplicationFabricsReplicationProtectionContainersReplicationProtectedItems {␊ - apiVersion: "2018-01-10"␊ - /**␊ - * A name for the replication protected item.␊ - */␊ - name: string␊ - /**␊ - * Enable protection input properties.␊ - */␊ - properties: (EnableProtectionInputProperties | string)␊ - type: "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings␊ - */␊ - export interface VaultsReplicationFabricsReplicationProtectionContainersReplicationProtectionContainerMappings {␊ - apiVersion: "2018-01-10"␊ - /**␊ - * Protection container mapping name.␊ - */␊ - name: string␊ - /**␊ - * Configure pairing input properties.␊ - */␊ - properties: (CreateProtectionContainerMappingInputProperties | string)␊ - type: "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders␊ - */␊ - export interface VaultsReplicationFabricsReplicationRecoveryServicesProviders {␊ - apiVersion: "2018-01-10"␊ - /**␊ - * Recovery services provider name.␊ - */␊ - name: string␊ - /**␊ - * The properties of an add provider request.␊ - */␊ - properties: (AddRecoveryServicesProviderInputProperties | string)␊ - type: "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings␊ - */␊ - export interface VaultsReplicationFabricsReplicationStorageClassificationsReplicationStorageClassificationMappings {␊ - apiVersion: "2018-01-10"␊ - /**␊ - * Storage classification mapping name.␊ - */␊ - name: string␊ - /**␊ - * Storage mapping input properties.␊ - */␊ - properties: (StorageMappingInputProperties | string)␊ - type: "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationStorageClassifications/replicationStorageClassificationMappings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Storage mapping input properties.␊ - */␊ - export interface StorageMappingInputProperties {␊ - /**␊ - * The ID of the storage object.␊ - */␊ - targetStorageClassificationId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters␊ - */␊ - export interface VaultsReplicationFabricsReplicationvCenters {␊ - apiVersion: "2018-01-10"␊ - /**␊ - * vCenter name.␊ - */␊ - name: string␊ - /**␊ - * The properties of an add vCenter request.␊ - */␊ - properties: (AddVCenterRequestProperties | string)␊ - type: "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationvCenters"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.RecoveryServices/vaults/replicationPolicies␊ - */␊ - export interface VaultsReplicationPolicies {␊ - apiVersion: "2018-01-10"␊ - /**␊ - * Replication policy name␊ - */␊ - name: string␊ - /**␊ - * Policy creation properties.␊ - */␊ - properties: (CreatePolicyInputProperties | string)␊ - type: "Microsoft.RecoveryServices/vaults/replicationPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Policy creation properties.␊ - */␊ - export interface CreatePolicyInputProperties {␊ - /**␊ - * Base class for provider specific input␊ - */␊ - providerSpecificInput?: (PolicyProviderSpecificInput | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A2A Policy creation input.␊ - */␊ - export interface A2APolicyCreationInput {␊ - /**␊ - * The app consistent snapshot frequency (in minutes).␊ - */␊ - appConsistentFrequencyInMinutes?: (number | string)␊ - /**␊ - * The crash consistent snapshot frequency (in minutes).␊ - */␊ - crashConsistentFrequencyInMinutes?: (number | string)␊ - instanceType: "A2A"␊ - /**␊ - * A value indicating whether multi-VM sync has to be enabled. Value should be 'Enabled' or 'Disabled'.␊ - */␊ - multiVmSyncStatus: (("Enable" | "Disable") | string)␊ - /**␊ - * The duration in minutes until which the recovery points need to be stored.␊ - */␊ - recoveryPointHistory?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Hyper-V Replica Azure specific input for creating a protection profile.␊ - */␊ - export interface HyperVReplicaAzurePolicyInput {␊ - /**␊ - * The interval (in hours) at which Hyper-V Replica should create an application consistent snapshot within the VM.␊ - */␊ - applicationConsistentSnapshotFrequencyInHours?: (number | string)␊ - instanceType: "HyperVReplicaAzure"␊ - /**␊ - * The scheduled start time for the initial replication. If this parameter is Null, the initial replication starts immediately.␊ - */␊ - onlineReplicationStartTime?: string␊ - /**␊ - * The duration (in hours) to which point the recovery history needs to be maintained.␊ - */␊ - recoveryPointHistoryDuration?: (number | string)␊ - /**␊ - * The replication interval.␊ - */␊ - replicationInterval?: (number | string)␊ - /**␊ - * The list of storage accounts to which the VMs in the primary cloud can replicate to.␊ - */␊ - storageAccounts?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HyperV Replica Blue policy input.␊ - */␊ - export interface HyperVReplicaBluePolicyInput {␊ - /**␊ - * A value indicating the authentication type.␊ - */␊ - allowedAuthenticationType?: (number | string)␊ - /**␊ - * A value indicating the application consistent frequency.␊ - */␊ - applicationConsistentSnapshotFrequencyInHours?: (number | string)␊ - /**␊ - * A value indicating whether compression has to be enabled.␊ - */␊ - compression?: string␊ - /**␊ - * A value indicating whether IR is online.␊ - */␊ - initialReplicationMethod?: string␊ - instanceType: "HyperVReplica2012R2"␊ - /**␊ - * A value indicating the offline IR export path.␊ - */␊ - offlineReplicationExportPath?: string␊ - /**␊ - * A value indicating the offline IR import path.␊ - */␊ - offlineReplicationImportPath?: string␊ - /**␊ - * A value indicating the online IR start time.␊ - */␊ - onlineReplicationStartTime?: string␊ - /**␊ - * A value indicating the number of recovery points.␊ - */␊ - recoveryPoints?: (number | string)␊ - /**␊ - * A value indicating whether the VM has to be auto deleted.␊ - */␊ - replicaDeletion?: string␊ - /**␊ - * A value indicating the replication interval.␊ - */␊ - replicationFrequencyInSeconds?: (number | string)␊ - /**␊ - * A value indicating the recovery HTTPS port.␊ - */␊ - replicationPort?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Hyper-V Replica specific policy Input.␊ - */␊ - export interface HyperVReplicaPolicyInput {␊ - /**␊ - * A value indicating the authentication type.␊ - */␊ - allowedAuthenticationType?: (number | string)␊ - /**␊ - * A value indicating the application consistent frequency.␊ - */␊ - applicationConsistentSnapshotFrequencyInHours?: (number | string)␊ - /**␊ - * A value indicating whether compression has to be enabled.␊ - */␊ - compression?: string␊ - /**␊ - * A value indicating whether IR is online.␊ - */␊ - initialReplicationMethod?: string␊ - instanceType: "HyperVReplica2012"␊ - /**␊ - * A value indicating the offline IR export path.␊ - */␊ - offlineReplicationExportPath?: string␊ - /**␊ - * A value indicating the offline IR import path.␊ - */␊ - offlineReplicationImportPath?: string␊ - /**␊ - * A value indicating the online IR start time.␊ - */␊ - onlineReplicationStartTime?: string␊ - /**␊ - * A value indicating the number of recovery points.␊ - */␊ - recoveryPoints?: (number | string)␊ - /**␊ - * A value indicating whether the VM has to be auto deleted.␊ - */␊ - replicaDeletion?: string␊ - /**␊ - * A value indicating the recovery HTTPS port.␊ - */␊ - replicationPort?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VMWare Azure specific policy Input.␊ - */␊ - export interface InMageAzureV2PolicyInput {␊ - /**␊ - * The app consistent snapshot frequency (in minutes).␊ - */␊ - appConsistentFrequencyInMinutes?: (number | string)␊ - /**␊ - * The crash consistent snapshot frequency (in minutes).␊ - */␊ - crashConsistentFrequencyInMinutes?: (number | string)␊ - instanceType: "InMageAzureV2"␊ - /**␊ - * A value indicating whether multi-VM sync has to be enabled. Value should be 'Enabled' or 'Disabled'.␊ - */␊ - multiVmSyncStatus: (("Enable" | "Disable") | string)␊ - /**␊ - * The duration in minutes until which the recovery points need to be stored.␊ - */␊ - recoveryPointHistory?: (number | string)␊ - /**␊ - * The recovery point threshold in minutes.␊ - */␊ - recoveryPointThresholdInMinutes?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VMWare Azure specific protection profile Input.␊ - */␊ - export interface InMagePolicyInput {␊ - /**␊ - * The app consistent snapshot frequency (in minutes).␊ - */␊ - appConsistentFrequencyInMinutes?: (number | string)␊ - instanceType: "InMage"␊ - /**␊ - * A value indicating whether multi-VM sync has to be enabled. Value should be 'Enabled' or 'Disabled'.␊ - */␊ - multiVmSyncStatus: (("Enable" | "Disable") | string)␊ - /**␊ - * The duration in minutes until which the recovery points need to be stored.␊ - */␊ - recoveryPointHistory?: (number | string)␊ - /**␊ - * The recovery point threshold in minutes.␊ - */␊ - recoveryPointThresholdInMinutes?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VMware Cbt policy creation input.␊ - */␊ - export interface VMwareCbtPolicyCreationInput {␊ - /**␊ - * The app consistent snapshot frequency (in minutes).␊ - */␊ - appConsistentFrequencyInMinutes?: (number | string)␊ - /**␊ - * The crash consistent snapshot frequency (in minutes).␊ - */␊ - crashConsistentFrequencyInMinutes?: (number | string)␊ - instanceType: "VMwareCbt"␊ - /**␊ - * The duration in minutes until which the recovery points need to be stored.␊ - */␊ - recoveryPointHistoryInMinutes?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.RecoveryServices/vaults/replicationRecoveryPlans␊ - */␊ - export interface VaultsReplicationRecoveryPlans {␊ - apiVersion: "2018-01-10"␊ - /**␊ - * Recovery plan name.␊ - */␊ - name: string␊ - /**␊ - * Recovery plan creation properties.␊ - */␊ - properties: (CreateRecoveryPlanInputProperties | string)␊ - type: "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Recovery plan creation properties.␊ - */␊ - export interface CreateRecoveryPlanInputProperties {␊ - /**␊ - * The failover deployment model.␊ - */␊ - failoverDeploymentModel?: (("NotApplicable" | "Classic" | "ResourceManager") | string)␊ - /**␊ - * The recovery plan groups.␊ - */␊ - groups: (RecoveryPlanGroup[] | string)␊ - /**␊ - * The primary fabric Id.␊ - */␊ - primaryFabricId: string␊ - /**␊ - * The recovery fabric Id.␊ - */␊ - recoveryFabricId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Recovery plan group details.␊ - */␊ - export interface RecoveryPlanGroup {␊ - /**␊ - * The end group actions.␊ - */␊ - endGroupActions?: (RecoveryPlanAction[] | string)␊ - /**␊ - * The group type.␊ - */␊ - groupType: (("Shutdown" | "Boot" | "Failover") | string)␊ - /**␊ - * The list of protected items.␊ - */␊ - replicationProtectedItems?: (RecoveryPlanProtectedItem[] | string)␊ - /**␊ - * The start group actions.␊ - */␊ - startGroupActions?: (RecoveryPlanAction[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Recovery plan action details.␊ - */␊ - export interface RecoveryPlanAction {␊ - /**␊ - * The action name.␊ - */␊ - actionName: string␊ - /**␊ - * Recovery plan action custom details.␊ - */␊ - customDetails: (RecoveryPlanActionDetails | string)␊ - /**␊ - * The list of failover directions.␊ - */␊ - failoverDirections: (("PrimaryToRecovery" | "RecoveryToPrimary")[] | string)␊ - /**␊ - * The list of failover types.␊ - */␊ - failoverTypes: (("ReverseReplicate" | "Commit" | "PlannedFailover" | "UnplannedFailover" | "DisableProtection" | "TestFailover" | "TestFailoverCleanup" | "Failback" | "FinalizeFailback" | "ChangePit" | "RepairReplication" | "SwitchProtection" | "CompleteMigration")[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Recovery plan Automation runbook action details.␊ - */␊ - export interface RecoveryPlanAutomationRunbookActionDetails {␊ - /**␊ - * The fabric location.␊ - */␊ - fabricLocation: (("Primary" | "Recovery") | string)␊ - instanceType: "AutomationRunbookActionDetails"␊ - /**␊ - * The runbook ARM Id.␊ - */␊ - runbookId?: string␊ - /**␊ - * The runbook timeout.␊ - */␊ - timeout?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Recovery plan manual action details.␊ - */␊ - export interface RecoveryPlanManualActionDetails {␊ - /**␊ - * The manual action description.␊ - */␊ - description?: string␊ - instanceType: "ManualActionDetails"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Recovery plan script action details.␊ - */␊ - export interface RecoveryPlanScriptActionDetails {␊ - /**␊ - * The fabric location.␊ - */␊ - fabricLocation: (("Primary" | "Recovery") | string)␊ - instanceType: "ScriptActionDetails"␊ - /**␊ - * The script path.␊ - */␊ - path: string␊ - /**␊ - * The script timeout.␊ - */␊ - timeout?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Recovery plan protected item.␊ - */␊ - export interface RecoveryPlanProtectedItem {␊ - /**␊ - * The ARM Id of the recovery plan protected item.␊ - */␊ - id?: string␊ - /**␊ - * The virtual machine Id.␊ - */␊ - virtualMachineId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DigitalTwins/digitalTwinsInstances␊ - */␊ - export interface DigitalTwinsInstances {␊ - apiVersion: "2020-03-01-preview"␊ - /**␊ - * The resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the DigitalTwinsInstance.␊ - */␊ - name: string␊ - /**␊ - * The properties of a DigitalTwinsInstance.␊ - */␊ - properties: (DigitalTwinsProperties | string)␊ - resources?: DigitalTwinsInstancesEndpointsChildResource[]␊ - /**␊ - * Information about the SKU of the DigitalTwinsInstance.␊ - */␊ - sku?: (DigitalTwinsSkuInfo | string)␊ - /**␊ - * The resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.DigitalTwins/digitalTwinsInstances"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a DigitalTwinsInstance.␊ - */␊ - export interface DigitalTwinsProperties {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DigitalTwins/digitalTwinsInstances/endpoints␊ - */␊ - export interface DigitalTwinsInstancesEndpointsChildResource {␊ - apiVersion: "2020-03-01-preview"␊ - /**␊ - * Name of Endpoint Resource.␊ - */␊ - name: string␊ - /**␊ - * Properties related to Digital Twins Endpoint␊ - */␊ - properties: (DigitalTwinsEndpointResourceProperties | string)␊ - type: "endpoints"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * properties related to servicebus.␊ - */␊ - export interface ServiceBus {␊ - endpointType: "ServiceBus"␊ - /**␊ - * PrimaryConnectionString of the endpoint. Will be obfuscated during read␊ - */␊ - primaryConnectionString: string␊ - /**␊ - * SecondaryConnectionString of the endpoint. Will be obfuscated during read␊ - */␊ - secondaryConnectionString: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * properties related to eventhub.␊ - */␊ - export interface EventHub {␊ - /**␊ - * PrimaryConnectionString of the endpoint. Will be obfuscated during read␊ - */␊ - "connectionString-PrimaryKey": string␊ - /**␊ - * SecondaryConnectionString of the endpoint. Will be obfuscated during read␊ - */␊ - "connectionString-SecondaryKey": string␊ - endpointType: "EventHub"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * properties related to eventgrid.␊ - */␊ - export interface EventGrid {␊ - /**␊ - * EventGrid secondary accesskey. Will be obfuscated during read␊ - */␊ - accessKey1: string␊ - /**␊ - * EventGrid secondary accesskey. Will be obfuscated during read␊ - */␊ - accessKey2: string␊ - endpointType: "EventGrid"␊ - /**␊ - * EventGrid Topic Endpoint␊ - */␊ - TopicEndpoint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the SKU of the DigitalTwinsInstance.␊ - */␊ - export interface DigitalTwinsSkuInfo {␊ - /**␊ - * The name of the SKU.␊ - */␊ - name: ("F1" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DigitalTwins/digitalTwinsInstances/endpoints␊ - */␊ - export interface DigitalTwinsInstancesEndpoints {␊ - apiVersion: "2020-03-01-preview"␊ - /**␊ - * Name of Endpoint Resource.␊ - */␊ - name: string␊ - /**␊ - * Properties related to Digital Twins Endpoint␊ - */␊ - properties: ((ServiceBus | EventHub | EventGrid) | string)␊ - type: "Microsoft.DigitalTwins/digitalTwinsInstances/endpoints"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DevTestLab/labs␊ - */␊ - export interface Labs1 {␊ - apiVersion: "2015-05-21-preview"␊ - /**␊ - * The identifier of the resource.␊ - */␊ - id?: string␊ - /**␊ - * The location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * The name of the lab.␊ - */␊ - name: string␊ - /**␊ - * Properties of a lab.␊ - */␊ - properties: (LabProperties1 | string)␊ - resources?: (LabsArtifactsourcesChildResource1 | LabsCustomimagesChildResource1 | LabsFormulasChildResource1 | LabsSchedulesChildResource1 | LabsVirtualmachinesChildResource1 | LabsVirtualnetworksChildResource1)[]␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.DevTestLab/labs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a lab.␊ - */␊ - export interface LabProperties1 {␊ - /**␊ - * The artifact storage account of the lab.␊ - */␊ - artifactsStorageAccount?: string␊ - /**␊ - * The creation date of the lab.␊ - */␊ - createdDate?: string␊ - /**␊ - * The lab's default storage account.␊ - */␊ - defaultStorageAccount?: string␊ - /**␊ - * The default virtual network identifier of the lab.␊ - */␊ - defaultVirtualNetworkId?: string␊ - /**␊ - * The type of the lab storage.␊ - */␊ - labStorageType?: (("Standard" | "Premium") | string)␊ - /**␊ - * The provisioning status of the resource.␊ - */␊ - provisioningState?: string␊ - /**␊ - * The storage accounts of the lab.␊ - */␊ - storageAccounts?: (string[] | string)␊ - /**␊ - * The name of the key vault of the lab.␊ - */␊ - vaultName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DevTestLab/labs/artifactsources␊ - */␊ - export interface LabsArtifactsourcesChildResource1 {␊ - apiVersion: "2015-05-21-preview"␊ - /**␊ - * The identifier of the resource.␊ - */␊ - id?: string␊ - /**␊ - * The location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * The name of the artifact source.␊ - */␊ - name: string␊ - /**␊ - * Properties of an artifact source.␊ - */␊ - properties: (ArtifactSourceProperties1 | string)␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "artifactsources"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of an artifact source.␊ - */␊ - export interface ArtifactSourceProperties1 {␊ - /**␊ - * The branch reference of the artifact source.␊ - */␊ - branchRef?: string␊ - /**␊ - * The display name of the artifact source.␊ - */␊ - displayName?: string␊ - /**␊ - * The folder path of the artifact source.␊ - */␊ - folderPath?: string␊ - /**␊ - * The provisioning status of the resource.␊ - */␊ - provisioningState?: string␊ - /**␊ - * The security token of the artifact source.␊ - */␊ - securityToken?: string␊ - /**␊ - * The type of the artifact source.␊ - */␊ - sourceType?: (("VsoGit" | "GitHub") | string)␊ - /**␊ - * The status of the artifact source.␊ - */␊ - status?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * The URI of the artifact source.␊ - */␊ - uri?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DevTestLab/labs/customimages␊ - */␊ - export interface LabsCustomimagesChildResource1 {␊ - apiVersion: "2015-05-21-preview"␊ - /**␊ - * The identifier of the resource.␊ - */␊ - id?: string␊ - /**␊ - * The location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * The name of the custom image.␊ - */␊ - name: string␊ - /**␊ - * Properties of a custom image.␊ - */␊ - properties: (CustomImageProperties1 | string)␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "customimages"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a custom image.␊ - */␊ - export interface CustomImageProperties1 {␊ - /**␊ - * The author of the custom image.␊ - */␊ - author?: string␊ - /**␊ - * The creation date of the custom image.␊ - */␊ - creationDate?: string␊ - /**␊ - * The description of the custom image.␊ - */␊ - description?: string␊ - /**␊ - * The OS type of the custom image.␊ - */␊ - osType?: (("Windows" | "Linux" | "None") | string)␊ - /**␊ - * The provisioning status of the resource.␊ - */␊ - provisioningState?: string␊ - /**␊ - * Properties for creating a custom image from a VHD.␊ - */␊ - vhd?: (CustomImagePropertiesCustom1 | string)␊ - /**␊ - * Properties for creating a custom image from a virtual machine.␊ - */␊ - vm?: (CustomImagePropertiesFromVm1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties for creating a custom image from a VHD.␊ - */␊ - export interface CustomImagePropertiesCustom1 {␊ - /**␊ - * The image name.␊ - */␊ - imageName?: string␊ - /**␊ - * Indicates whether sysprep has been run on the VHD.␊ - */␊ - sysPrep?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties for creating a custom image from a virtual machine.␊ - */␊ - export interface CustomImagePropertiesFromVm1 {␊ - /**␊ - * Information about a Linux OS.␊ - */␊ - linuxOsInfo?: (LinuxOsInfo1 | string)␊ - /**␊ - * The source vm identifier.␊ - */␊ - sourceVmId?: string␊ - /**␊ - * Indicates whether sysprep has been run on the VHD.␊ - */␊ - sysPrep?: (boolean | string)␊ - /**␊ - * Information about a Windows OS.␊ - */␊ - windowsOsInfo?: (WindowsOsInfo1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about a Linux OS.␊ - */␊ - export interface LinuxOsInfo1 {␊ - /**␊ - * The state of the Linux OS.␊ - */␊ - linuxOsState?: (("NonDeprovisioned" | "DeprovisionRequested" | "DeprovisionApplied") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about a Windows OS.␊ - */␊ - export interface WindowsOsInfo1 {␊ - /**␊ - * The state of the Windows OS.␊ - */␊ - windowsOsState?: (("NonSysprepped" | "SysprepRequested" | "SysprepApplied") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DevTestLab/labs/formulas␊ - */␊ - export interface LabsFormulasChildResource1 {␊ - apiVersion: "2015-05-21-preview"␊ - /**␊ - * The identifier of the resource.␊ - */␊ - id?: string␊ - /**␊ - * The location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * The name of the formula.␊ - */␊ - name: string␊ - /**␊ - * Properties of a formula.␊ - */␊ - properties: (FormulaProperties1 | string)␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "formulas"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a formula.␊ - */␊ - export interface FormulaProperties1 {␊ - /**␊ - * The author of the formula.␊ - */␊ - author?: string␊ - /**␊ - * The creation date of the formula.␊ - */␊ - creationDate?: string␊ - /**␊ - * The description of the formula.␊ - */␊ - description?: string␊ - /**␊ - * A virtual machine.␊ - */␊ - formulaContent?: (LabVirtualMachine | string)␊ - /**␊ - * The OS type of the formula.␊ - */␊ - osType?: string␊ - /**␊ - * The provisioning status of the resource.␊ - */␊ - provisioningState?: string␊ - /**␊ - * Information about a VM from which a formula is to be created.␊ - */␊ - vm?: (FormulaPropertiesFromVm1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A virtual machine.␊ - */␊ - export interface LabVirtualMachine {␊ - /**␊ - * The identifier of the resource.␊ - */␊ - id?: string␊ - /**␊ - * The location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * The name of the resource.␊ - */␊ - name?: string␊ - /**␊ - * Properties of a virtual machine.␊ - */␊ - properties?: (LabVirtualMachineProperties1 | string)␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a virtual machine.␊ - */␊ - export interface LabVirtualMachineProperties1 {␊ - /**␊ - * Properties of an artifact deployment.␊ - */␊ - artifactDeploymentStatus?: (ArtifactDeploymentStatusProperties1 | string)␊ - /**␊ - * The artifacts to be installed on the virtual machine.␊ - */␊ - artifacts?: (ArtifactInstallProperties1[] | string)␊ - /**␊ - * The resource identifier (Microsoft.Compute) of the virtual machine.␊ - */␊ - computeId?: string␊ - /**␊ - * The email address of creator of the virtual machine.␊ - */␊ - createdByUser?: string␊ - /**␊ - * The object identifier of the creator of the virtual machine.␊ - */␊ - createdByUserId?: string␊ - /**␊ - * The custom image identifier of the virtual machine.␊ - */␊ - customImageId?: string␊ - /**␊ - * Indicates whether the virtual machine is to be created without a public IP address.␊ - */␊ - disallowPublicIpAddress?: (boolean | string)␊ - /**␊ - * The fully-qualified domain name of the virtual machine.␊ - */␊ - fqdn?: string␊ - /**␊ - * The reference information for an Azure Marketplace image.␊ - */␊ - galleryImageReference?: (GalleryImageReference1 | string)␊ - /**␊ - * A value indicating whether this virtual machine uses an SSH key for authentication.␊ - */␊ - isAuthenticationWithSshKey?: (boolean | string)␊ - /**␊ - * The lab subnet name of the virtual machine.␊ - */␊ - labSubnetName?: string␊ - /**␊ - * The lab virtual network identifier of the virtual machine.␊ - */␊ - labVirtualNetworkId?: string␊ - /**␊ - * The notes of the virtual machine.␊ - */␊ - notes?: string␊ - /**␊ - * The OS type of the virtual machine.␊ - */␊ - osType?: string␊ - /**␊ - * The object identifier of the owner of the virtual machine.␊ - */␊ - ownerObjectId?: string␊ - /**␊ - * The password of the virtual machine administrator.␊ - */␊ - password?: string␊ - /**␊ - * The provisioning status of the resource.␊ - */␊ - provisioningState?: string␊ - /**␊ - * The size of the virtual machine.␊ - */␊ - size?: string␊ - /**␊ - * The SSH key of the virtual machine administrator.␊ - */␊ - sshKey?: string␊ - /**␊ - * The user name of the virtual machine.␊ - */␊ - userName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of an artifact deployment.␊ - */␊ - export interface ArtifactDeploymentStatusProperties1 {␊ - /**␊ - * The total count of the artifacts that were successfully applied.␊ - */␊ - artifactsApplied?: (number | string)␊ - /**␊ - * The deployment status of the artifact.␊ - */␊ - deploymentStatus?: string␊ - /**␊ - * The total count of the artifacts that were tentatively applied.␊ - */␊ - totalArtifacts?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of an artifact.␊ - */␊ - export interface ArtifactInstallProperties1 {␊ - /**␊ - * The artifact's identifier.␊ - */␊ - artifactId?: string␊ - /**␊ - * The parameters of the artifact.␊ - */␊ - parameters?: (ArtifactParameterProperties1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of an artifact parameter.␊ - */␊ - export interface ArtifactParameterProperties1 {␊ - /**␊ - * The name of the artifact parameter.␊ - */␊ - name?: string␊ - /**␊ - * The value of the artifact parameter.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The reference information for an Azure Marketplace image.␊ - */␊ - export interface GalleryImageReference1 {␊ - /**␊ - * The offer of the gallery image.␊ - */␊ - offer?: string␊ - /**␊ - * The OS type of the gallery image.␊ - */␊ - osType?: string␊ - /**␊ - * The publisher of the gallery image.␊ - */␊ - publisher?: string␊ - /**␊ - * The SKU of the gallery image.␊ - */␊ - sku?: string␊ - /**␊ - * The version of the gallery image.␊ - */␊ - version?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about a VM from which a formula is to be created.␊ - */␊ - export interface FormulaPropertiesFromVm1 {␊ - /**␊ - * The identifier of the VM from which a formula is to be created.␊ - */␊ - labVmId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DevTestLab/labs/schedules␊ - */␊ - export interface LabsSchedulesChildResource1 {␊ - apiVersion: "2015-05-21-preview"␊ - /**␊ - * The identifier of the resource.␊ - */␊ - id?: string␊ - /**␊ - * The location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * The name of the schedule.␊ - */␊ - name: string␊ - /**␊ - * Properties of a schedule.␊ - */␊ - properties: (ScheduleProperties1 | string)␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "schedules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a schedule.␊ - */␊ - export interface ScheduleProperties1 {␊ - /**␊ - * Properties of a daily schedule.␊ - */␊ - dailyRecurrence?: (DayDetails1 | string)␊ - /**␊ - * Properties of an hourly schedule.␊ - */␊ - hourlyRecurrence?: (HourDetails1 | string)␊ - /**␊ - * The provisioning status of the resource.␊ - */␊ - provisioningState?: string␊ - /**␊ - * The status of the schedule.␊ - */␊ - status?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * The task type of the schedule.␊ - */␊ - taskType?: (("LabVmsShutdownTask" | "LabVmsStartupTask" | "LabBillingTask") | string)␊ - /**␊ - * The time zone id.␊ - */␊ - timeZoneId?: string␊ - /**␊ - * Properties of a weekly schedule.␊ - */␊ - weeklyRecurrence?: (WeekDetails1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a daily schedule.␊ - */␊ - export interface DayDetails1 {␊ - time?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of an hourly schedule.␊ - */␊ - export interface HourDetails1 {␊ - /**␊ - * Minutes of the hour the schedule will run.␊ - */␊ - minute?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a weekly schedule.␊ - */␊ - export interface WeekDetails1 {␊ - /**␊ - * The time of the day.␊ - */␊ - time?: string␊ - /**␊ - * The days of the week.␊ - */␊ - weekdays?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DevTestLab/labs/virtualmachines␊ - */␊ - export interface LabsVirtualmachinesChildResource1 {␊ - apiVersion: "2015-05-21-preview"␊ - /**␊ - * The identifier of the resource.␊ - */␊ - id?: string␊ - /**␊ - * The location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * The name of the virtual Machine.␊ - */␊ - name: string␊ - /**␊ - * Properties of a virtual machine.␊ - */␊ - properties: (LabVirtualMachineProperties1 | string)␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "virtualmachines"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DevTestLab/labs/virtualnetworks␊ - */␊ - export interface LabsVirtualnetworksChildResource1 {␊ - apiVersion: "2015-05-21-preview"␊ - /**␊ - * The identifier of the resource.␊ - */␊ - id?: string␊ - /**␊ - * The location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * The name of the virtual network.␊ - */␊ - name: string␊ - /**␊ - * Properties of a virtual network.␊ - */␊ - properties: (VirtualNetworkProperties1 | string)␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "virtualnetworks"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a virtual network.␊ - */␊ - export interface VirtualNetworkProperties1 {␊ - /**␊ - * The allowed subnets of the virtual network.␊ - */␊ - allowedSubnets?: (Subnet1[] | string)␊ - /**␊ - * The description of the virtual network.␊ - */␊ - description?: string␊ - /**␊ - * The Microsoft.Network resource identifier of the virtual network.␊ - */␊ - externalProviderResourceId?: string␊ - /**␊ - * The provisioning status of the resource.␊ - */␊ - provisioningState?: string␊ - /**␊ - * The subnet overrides of the virtual network.␊ - */␊ - subnetOverrides?: (SubnetOverride1[] | string)␊ - [k: string]: unknown␊ - }␊ - export interface Subnet1 {␊ - allowPublicIp?: (("Default" | "Deny" | "Allow") | string)␊ - labSubnetName?: string␊ - resourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Property overrides on a subnet of a virtual network.␊ - */␊ - export interface SubnetOverride1 {␊ - /**␊ - * The name given to the subnet within the lab.␊ - */␊ - labSubnetName?: string␊ - /**␊ - * The resource identifier of the subnet.␊ - */␊ - resourceId?: string␊ - /**␊ - * Indicates whether this subnet can be used during virtual machine creation.␊ - */␊ - useInVmCreationPermission?: (("Default" | "Deny" | "Allow") | string)␊ - /**␊ - * Indicates whether public IP addresses can be assigned to virtual machines on this subnet.␊ - */␊ - usePublicIpAddressPermission?: (("Default" | "Deny" | "Allow") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DevTestLab/labs/virtualmachines␊ - */␊ - export interface LabsVirtualmachines1 {␊ - apiVersion: "2015-05-21-preview"␊ - /**␊ - * The identifier of the resource.␊ - */␊ - id?: string␊ - /**␊ - * The location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * The name of the virtual Machine.␊ - */␊ - name: string␊ - /**␊ - * Properties of a virtual machine.␊ - */␊ - properties: (LabVirtualMachineProperties1 | string)␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.DevTestLab/labs/virtualmachines"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Kusto/clusters␊ - */␊ - export interface Clusters {␊ - /**␊ - * The Cluster name␊ - */␊ - name: string␊ - type: "Microsoft.Kusto/clusters"␊ - apiVersion: "2017-09-07-privatepreview"␊ - /**␊ - * Cluster's location␊ - */␊ - location: string␊ - /**␊ - * Cluster tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The SKU (pricing tier) of the Kusto cluster.␊ - */␊ - sku: ((AzureSku | string) | string)␊ - resources?: ClustersDatabases[]␊ - [k: string]: unknown␊ - }␊ - export interface AzureSku {␊ - /**␊ - * SKU name. Possible values include: 'KC8', 'KC16', 'KS8', 'KS16'␊ - */␊ - name: ("KC8" | "KC16" | "KS8" | "KS16")␊ - /**␊ - * SKU tier␊ - */␊ - tier: "Standard"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Kusto/clusters/databases␊ - */␊ - export interface ClustersDatabases {␊ - /**␊ - * The Database name␊ - */␊ - name: string␊ - type: "Microsoft.Kusto/clusters/databases"␊ - apiVersion: "2017-09-07-privatepreview"␊ - /**␊ - * Properties supplied to the Database Create Or Update Kusto operation.␊ - */␊ - properties: (DatabaseProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the Kusto database properties.␊ - */␊ - export interface DatabaseProperties {␊ - /**␊ - * The number of days data should be kept before it stops being accessible to queries.␊ - */␊ - softDeletePeriodInDays: number␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Kusto/clusters␊ - */␊ - export interface Clusters1 {␊ - apiVersion: "2018-09-07-preview"␊ - /**␊ - * The geo-location where the resource lives␊ - */␊ - location: string␊ - /**␊ - * The name of the Kusto cluster.␊ - */␊ - name: string␊ - /**␊ - * Class representing the Kusto cluster properties.␊ - */␊ - properties?: (ClusterProperties | string)␊ - resources?: ClustersDatabasesChildResource[]␊ - sku: (AzureSku1 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Kusto/clusters"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the Kusto cluster properties.␊ - */␊ - export interface ClusterProperties {␊ - /**␊ - * The cluster's external tenants.␊ - */␊ - trustedExternalTenants?: (TrustedExternalTenant[] | string)␊ - [k: string]: unknown␊ - }␊ - export interface TrustedExternalTenant {␊ - /**␊ - * GUID representing an external tenant.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Kusto/clusters/databases␊ - */␊ - export interface ClustersDatabasesChildResource {␊ - apiVersion: "2018-09-07-preview"␊ - /**␊ - * The geo-location where the resource lives␊ - */␊ - location: string␊ - /**␊ - * The name of the database in the Kusto cluster.␊ - */␊ - name: string␊ - /**␊ - * Class representing the Kusto database properties.␊ - */␊ - properties: (DatabaseProperties1 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "databases"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the Kusto database properties.␊ - */␊ - export interface DatabaseProperties1 {␊ - /**␊ - * The number of days of data that should be kept in cache for fast queries.␊ - */␊ - hotCachePeriodInDays?: (number | string)␊ - /**␊ - * The number of days data should be kept before it stops being accessible to queries.␊ - */␊ - softDeletePeriodInDays: (number | string)␊ - [k: string]: unknown␊ - }␊ - export interface AzureSku1 {␊ - /**␊ - * SKU capacity.␊ - */␊ - capacity?: (number | string)␊ - /**␊ - * SKU name.␊ - */␊ - name: (("KC8" | "KC16" | "KS8" | "KS16" | "D13_v2" | "D14_v2" | "L8" | "L16") | string)␊ - /**␊ - * SKU tier.␊ - */␊ - tier: ("Standard" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Kusto/clusters/databases␊ - */␊ - export interface ClustersDatabases1 {␊ - apiVersion: "2018-09-07-preview"␊ - /**␊ - * The geo-location where the resource lives␊ - */␊ - location: string␊ - /**␊ - * The name of the database in the Kusto cluster.␊ - */␊ - name: string␊ - /**␊ - * Class representing the Kusto database properties.␊ - */␊ - properties: (DatabaseProperties1 | string)␊ - resources?: ClustersDatabasesEventhubconnectionsChildResource[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Kusto/clusters/databases"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Kusto/clusters/databases/eventhubconnections␊ - */␊ - export interface ClustersDatabasesEventhubconnectionsChildResource {␊ - apiVersion: "2018-09-07-preview"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the event hub connection.␊ - */␊ - name: string␊ - /**␊ - * Class representing the Kusto event hub connection properties.␊ - */␊ - properties: (EventHubConnectionProperties | string)␊ - type: "eventhubconnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the Kusto event hub connection properties.␊ - */␊ - export interface EventHubConnectionProperties {␊ - /**␊ - * The event hub consumer group.␊ - */␊ - consumerGroup: string␊ - /**␊ - * The data format of the message. Optionally the data format can be added to each message.␊ - */␊ - dataFormat?: (("MULTIJSON" | "JSON" | "CSV") | string)␊ - /**␊ - * The resource ID of the event hub to be used to create a data connection.␊ - */␊ - eventHubResourceId: string␊ - /**␊ - * The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.␊ - */␊ - mappingRuleName?: string␊ - /**␊ - * The table where the data should be ingested. Optionally the table information can be added to each message.␊ - */␊ - tableName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Kusto/clusters␊ - */␊ - export interface Clusters2 {␊ - apiVersion: "2019-01-21"␊ - /**␊ - * The geo-location where the resource lives␊ - */␊ - location: string␊ - /**␊ - * The name of the Kusto cluster.␊ - */␊ - name: string␊ - /**␊ - * Class representing the Kusto cluster properties.␊ - */␊ - properties?: (ClusterProperties1 | string)␊ - resources?: ClustersDatabasesChildResource1[]␊ - /**␊ - * Azure SKU definition.␊ - */␊ - sku: (AzureSku2 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Kusto/clusters"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the Kusto cluster properties.␊ - */␊ - export interface ClusterProperties1 {␊ - /**␊ - * The cluster's external tenants.␊ - */␊ - trustedExternalTenants?: (TrustedExternalTenant1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents a tenant ID that is trusted by the cluster.␊ - */␊ - export interface TrustedExternalTenant1 {␊ - /**␊ - * GUID representing an external tenant.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Kusto/clusters/databases␊ - */␊ - export interface ClustersDatabasesChildResource1 {␊ - apiVersion: "2019-01-21"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the database in the Kusto cluster.␊ - */␊ - name: string␊ - /**␊ - * Class representing the Kusto database properties.␊ - */␊ - properties: (DatabaseProperties2 | string)␊ - type: "databases"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the Kusto database properties.␊ - */␊ - export interface DatabaseProperties2 {␊ - /**␊ - * The time the data that should be kept in cache for fast queries in TimeSpan.␊ - */␊ - hotCachePeriod?: string␊ - /**␊ - * The time the data should be kept before it stops being accessible to queries in TimeSpan.␊ - */␊ - softDeletePeriod?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure SKU definition.␊ - */␊ - export interface AzureSku2 {␊ - /**␊ - * The number of instances of the cluster.␊ - */␊ - capacity?: (number | string)␊ - /**␊ - * SKU name.␊ - */␊ - name: (("Standard_DS13_v2+1TB_PS" | "Standard_DS13_v2+2TB_PS" | "Standard_DS14_v2+3TB_PS" | "Standard_DS14_v2+4TB_PS" | "Standard_D13_v2" | "Standard_D14_v2" | "Standard_L8s" | "Standard_L16s" | "Standard_D11_v2" | "Standard_D12_v2" | "Standard_L4s" | "Dev(No SLA)_Standard_D11_v2") | string)␊ - /**␊ - * SKU tier.␊ - */␊ - tier: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Kusto/clusters/databases␊ - */␊ - export interface ClustersDatabases2 {␊ - apiVersion: "2019-01-21"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the database in the Kusto cluster.␊ - */␊ - name: string␊ - /**␊ - * Class representing the Kusto database properties.␊ - */␊ - properties: (DatabaseProperties2 | string)␊ - resources?: ClustersDatabasesDataConnectionsChildResource[]␊ - type: "Microsoft.Kusto/clusters/databases"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing an event hub data connection.␊ - */␊ - export interface EventHubDataConnection {␊ - kind: "EventHub"␊ - /**␊ - * Class representing the Kusto event hub connection properties.␊ - */␊ - properties?: (EventHubConnectionProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the Kusto event hub connection properties.␊ - */␊ - export interface EventHubConnectionProperties1 {␊ - /**␊ - * The event hub consumer group.␊ - */␊ - consumerGroup: string␊ - /**␊ - * The data format of the message. Optionally the data format can be added to each message.␊ - */␊ - dataFormat?: (("MULTIJSON" | "JSON" | "CSV" | "TSV" | "SCSV" | "SOHSV" | "PSV" | "TXT" | "RAW" | "SINGLEJSON" | "AVRO") | string)␊ - /**␊ - * The resource ID of the event hub to be used to create a data connection.␊ - */␊ - eventHubResourceId: string␊ - /**␊ - * The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.␊ - */␊ - mappingRuleName?: string␊ - /**␊ - * The table where the data should be ingested. Optionally the table information can be added to each message.␊ - */␊ - tableName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing an Event Grid data connection.␊ - */␊ - export interface EventGridDataConnection {␊ - kind: "EventGrid"␊ - /**␊ - * Class representing the Kusto event grid connection properties.␊ - */␊ - properties?: (EventGridConnectionProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the Kusto event grid connection properties.␊ - */␊ - export interface EventGridConnectionProperties {␊ - /**␊ - * The event hub consumer group.␊ - */␊ - consumerGroup: string␊ - /**␊ - * The data format of the message. Optionally the data format can be added to each message.␊ - */␊ - dataFormat: (("MULTIJSON" | "JSON" | "CSV" | "TSV" | "SCSV" | "SOHSV" | "PSV" | "TXT" | "RAW" | "SINGLEJSON" | "AVRO") | string)␊ - /**␊ - * The resource ID where the event grid is configured to send events.␊ - */␊ - eventHubResourceId: string␊ - /**␊ - * The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.␊ - */␊ - mappingRuleName?: string␊ - /**␊ - * The resource ID of the storage account where the data resides.␊ - */␊ - storageAccountResourceId: string␊ - /**␊ - * The table where the data should be ingested. Optionally the table information can be added to each message.␊ - */␊ - tableName: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Kusto/clusters␊ - */␊ - export interface Clusters3 {␊ - apiVersion: "2019-05-15"␊ - /**␊ - * The geo-location where the resource lives␊ - */␊ - location: string␊ - /**␊ - * The name of the Kusto cluster.␊ - */␊ - name: string␊ - /**␊ - * Class representing the Kusto cluster properties.␊ - */␊ - properties?: (ClusterProperties2 | string)␊ - resources?: ClustersDatabasesChildResource2[]␊ - /**␊ - * Azure SKU definition.␊ - */␊ - sku: (AzureSku3 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Kusto/clusters"␊ - /**␊ - * An array represents the availability zones of the cluster.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the Kusto cluster properties.␊ - */␊ - export interface ClusterProperties2 {␊ - /**␊ - * A boolean value that indicates if the cluster's disks are encrypted.␊ - */␊ - enableDiskEncryption?: (boolean | string)␊ - /**␊ - * A boolean value that indicates if the streaming ingest is enabled.␊ - */␊ - enableStreamingIngest?: (boolean | string)␊ - /**␊ - * A class that contains the optimized auto scale definition.␊ - */␊ - optimizedAutoscale?: (OptimizedAutoscale | string)␊ - /**␊ - * The cluster's external tenants.␊ - */␊ - trustedExternalTenants?: (TrustedExternalTenant2[] | string)␊ - /**␊ - * A class that contains virtual network definition.␊ - */␊ - virtualNetworkConfiguration?: (VirtualNetworkConfiguration | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A class that contains the optimized auto scale definition.␊ - */␊ - export interface OptimizedAutoscale {␊ - /**␊ - * A boolean value that indicate if the optimized autoscale feature is enabled or not.␊ - */␊ - isEnabled: (boolean | string)␊ - /**␊ - * Maximum allowed instances count.␊ - */␊ - maximum: (number | string)␊ - /**␊ - * Minimum allowed instances count.␊ - */␊ - minimum: (number | string)␊ - /**␊ - * The version of the template defined, for instance 1.␊ - */␊ - version: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents a tenant ID that is trusted by the cluster.␊ - */␊ - export interface TrustedExternalTenant2 {␊ - /**␊ - * GUID representing an external tenant.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A class that contains virtual network definition.␊ - */␊ - export interface VirtualNetworkConfiguration {␊ - /**␊ - * Data management's service public IP address resource id.␊ - */␊ - dataManagementPublicIpId: string␊ - /**␊ - * Engine service's public IP address resource id.␊ - */␊ - enginePublicIpId: string␊ - /**␊ - * The subnet resource id.␊ - */␊ - subnetId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Kusto/clusters/databases␊ - */␊ - export interface ClustersDatabasesChildResource2 {␊ - apiVersion: "2019-05-15"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the database in the Kusto cluster.␊ - */␊ - name: string␊ - /**␊ - * Class representing the Kusto database properties.␊ - */␊ - properties: (DatabaseProperties3 | string)␊ - type: "databases"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the Kusto database properties.␊ - */␊ - export interface DatabaseProperties3 {␊ - /**␊ - * The time the data should be kept in cache for fast queries in TimeSpan.␊ - */␊ - hotCachePeriod?: string␊ - /**␊ - * The time the data should be kept before it stops being accessible to queries in TimeSpan.␊ - */␊ - softDeletePeriod?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure SKU definition.␊ - */␊ - export interface AzureSku3 {␊ - /**␊ - * The number of instances of the cluster.␊ - */␊ - capacity?: (number | string)␊ - /**␊ - * SKU name.␊ - */␊ - name: (("Standard_DS13_v2+1TB_PS" | "Standard_DS13_v2+2TB_PS" | "Standard_DS14_v2+3TB_PS" | "Standard_DS14_v2+4TB_PS" | "Standard_D13_v2" | "Standard_D14_v2" | "Standard_L8s" | "Standard_L16s" | "Standard_D11_v2" | "Standard_D12_v2" | "Standard_L4s" | "Dev(No SLA)_Standard_D11_v2") | string)␊ - /**␊ - * SKU tier.␊ - */␊ - tier: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Kusto/clusters/databases␊ - */␊ - export interface ClustersDatabases3 {␊ - apiVersion: "2019-05-15"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the database in the Kusto cluster.␊ - */␊ - name: string␊ - /**␊ - * Class representing the Kusto database properties.␊ - */␊ - properties: (DatabaseProperties3 | string)␊ - resources?: ClustersDatabasesDataConnectionsChildResource1[]␊ - type: "Microsoft.Kusto/clusters/databases"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing an event hub data connection.␊ - */␊ - export interface EventHubDataConnection1 {␊ - kind: "EventHub"␊ - /**␊ - * Class representing the Kusto event hub connection properties.␊ - */␊ - properties?: (EventHubConnectionProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the Kusto event hub connection properties.␊ - */␊ - export interface EventHubConnectionProperties2 {␊ - /**␊ - * The event hub consumer group.␊ - */␊ - consumerGroup: string␊ - /**␊ - * The data format of the message. Optionally the data format can be added to each message.␊ - */␊ - dataFormat?: (("MULTIJSON" | "JSON" | "CSV" | "TSV" | "SCSV" | "SOHSV" | "PSV" | "TXT" | "RAW" | "SINGLEJSON" | "AVRO" | "TSVE") | string)␊ - /**␊ - * The resource ID of the event hub to be used to create a data connection.␊ - */␊ - eventHubResourceId: string␊ - /**␊ - * System properties of the event hub␊ - */␊ - eventSystemProperties?: (string[] | string)␊ - /**␊ - * The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.␊ - */␊ - mappingRuleName?: string␊ - /**␊ - * The table where the data should be ingested. Optionally the table information can be added to each message.␊ - */␊ - tableName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing an iot hub data connection.␊ - */␊ - export interface IotHubDataConnection {␊ - kind: "IotHub"␊ - /**␊ - * Class representing the Kusto iot hub connection properties.␊ - */␊ - properties?: (IotHubConnectionProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the Kusto iot hub connection properties.␊ - */␊ - export interface IotHubConnectionProperties {␊ - /**␊ - * The iot hub consumer group.␊ - */␊ - consumerGroup: string␊ - /**␊ - * The data format of the message. Optionally the data format can be added to each message.␊ - */␊ - dataFormat?: (("MULTIJSON" | "JSON" | "CSV" | "TSV" | "SCSV" | "SOHSV" | "PSV" | "TXT" | "RAW" | "SINGLEJSON" | "AVRO" | "TSVE") | string)␊ - /**␊ - * System properties of the iot hub␊ - */␊ - eventSystemProperties?: (string[] | string)␊ - /**␊ - * The resource ID of the Iot hub to be used to create a data connection.␊ - */␊ - iotHubResourceId: string␊ - /**␊ - * The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.␊ - */␊ - mappingRuleName?: string␊ - /**␊ - * The name of the share access policy name␊ - */␊ - sharedAccessPolicyName: string␊ - /**␊ - * The table where the data should be ingested. Optionally the table information can be added to each message.␊ - */␊ - tableName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing an Event Grid data connection.␊ - */␊ - export interface EventGridDataConnection1 {␊ - kind: "EventGrid"␊ - /**␊ - * Class representing the Kusto event grid connection properties.␊ - */␊ - properties?: (EventGridConnectionProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the Kusto event grid connection properties.␊ - */␊ - export interface EventGridConnectionProperties1 {␊ - /**␊ - * The event hub consumer group.␊ - */␊ - consumerGroup: string␊ - /**␊ - * The data format of the message. Optionally the data format can be added to each message.␊ - */␊ - dataFormat: (("MULTIJSON" | "JSON" | "CSV" | "TSV" | "SCSV" | "SOHSV" | "PSV" | "TXT" | "RAW" | "SINGLEJSON" | "AVRO" | "TSVE") | string)␊ - /**␊ - * The resource ID where the event grid is configured to send events.␊ - */␊ - eventHubResourceId: string␊ - /**␊ - * The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.␊ - */␊ - mappingRuleName?: string␊ - /**␊ - * The resource ID of the storage account where the data resides.␊ - */␊ - storageAccountResourceId: string␊ - /**␊ - * The table where the data should be ingested. Optionally the table information can be added to each message.␊ - */␊ - tableName: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Kusto/clusters␊ - */␊ - export interface Clusters4 {␊ - apiVersion: "2019-09-07"␊ - /**␊ - * Identity for the resource.␊ - */␊ - identity?: (Identity1 | string)␊ - /**␊ - * The geo-location where the resource lives␊ - */␊ - location: string␊ - /**␊ - * The name of the Kusto cluster.␊ - */␊ - name: string␊ - /**␊ - * Class representing the Kusto cluster properties.␊ - */␊ - properties?: (ClusterProperties3 | string)␊ - resources?: (ClustersDatabasesChildResource3 | ClustersAttachedDatabaseConfigurationsChildResource)[]␊ - /**␊ - * Azure SKU definition.␊ - */␊ - sku: (AzureSku4 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Kusto/clusters"␊ - /**␊ - * An array represents the availability zones of the cluster.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the resource.␊ - */␊ - export interface Identity1 {␊ - /**␊ - * The identity type.␊ - */␊ - type: (("None" | "SystemAssigned") | string)␊ - /**␊ - * The list of user identities associated with the Kusto cluster. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.␊ - */␊ - userAssignedIdentities?: ({␊ - [k: string]: Componentssgqdofschemasidentitypropertiesuserassignedidentitiesadditionalproperties␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - export interface Componentssgqdofschemasidentitypropertiesuserassignedidentitiesadditionalproperties {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the Kusto cluster properties.␊ - */␊ - export interface ClusterProperties3 {␊ - /**␊ - * A boolean value that indicates if the cluster's disks are encrypted.␊ - */␊ - enableDiskEncryption?: (boolean | string)␊ - /**␊ - * A boolean value that indicates if the streaming ingest is enabled.␊ - */␊ - enableStreamingIngest?: (boolean | string)␊ - /**␊ - * Properties of the key vault.␊ - */␊ - keyVaultProperties?: (KeyVaultProperties | string)␊ - /**␊ - * A class that contains the optimized auto scale definition.␊ - */␊ - optimizedAutoscale?: (OptimizedAutoscale1 | string)␊ - /**␊ - * The cluster's external tenants.␊ - */␊ - trustedExternalTenants?: (TrustedExternalTenant3[] | string)␊ - /**␊ - * A class that contains virtual network definition.␊ - */␊ - virtualNetworkConfiguration?: (VirtualNetworkConfiguration1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the key vault.␊ - */␊ - export interface KeyVaultProperties {␊ - /**␊ - * The name of the key vault key.␊ - */␊ - keyName: string␊ - /**␊ - * The Uri of the key vault.␊ - */␊ - keyVaultUri: string␊ - /**␊ - * The version of the key vault key.␊ - */␊ - keyVersion: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A class that contains the optimized auto scale definition.␊ - */␊ - export interface OptimizedAutoscale1 {␊ - /**␊ - * A boolean value that indicate if the optimized autoscale feature is enabled or not.␊ - */␊ - isEnabled: (boolean | string)␊ - /**␊ - * Maximum allowed instances count.␊ - */␊ - maximum: (number | string)␊ - /**␊ - * Minimum allowed instances count.␊ - */␊ - minimum: (number | string)␊ - /**␊ - * The version of the template defined, for instance 1.␊ - */␊ - version: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents a tenant ID that is trusted by the cluster.␊ - */␊ - export interface TrustedExternalTenant3 {␊ - /**␊ - * GUID representing an external tenant.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A class that contains virtual network definition.␊ - */␊ - export interface VirtualNetworkConfiguration1 {␊ - /**␊ - * Data management's service public IP address resource id.␊ - */␊ - dataManagementPublicIpId: string␊ - /**␊ - * Engine service's public IP address resource id.␊ - */␊ - enginePublicIpId: string␊ - /**␊ - * The subnet resource id.␊ - */␊ - subnetId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing a read write database.␊ - */␊ - export interface ReadWriteDatabase {␊ - kind: "ReadWrite"␊ - /**␊ - * Class representing the Kusto database properties.␊ - */␊ - properties?: (ReadWriteDatabaseProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the Kusto database properties.␊ - */␊ - export interface ReadWriteDatabaseProperties {␊ - /**␊ - * The time the data should be kept in cache for fast queries in TimeSpan.␊ - */␊ - hotCachePeriod?: string␊ - /**␊ - * The time the data should be kept before it stops being accessible to queries in TimeSpan.␊ - */␊ - softDeletePeriod?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing a read only following database.␊ - */␊ - export interface ReadOnlyFollowingDatabase {␊ - kind: "ReadOnlyFollowing"␊ - /**␊ - * Class representing the Kusto database properties.␊ - */␊ - properties?: (ReadOnlyFollowingDatabaseProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the Kusto database properties.␊ - */␊ - export interface ReadOnlyFollowingDatabaseProperties {␊ - /**␊ - * The time the data should be kept in cache for fast queries in TimeSpan.␊ - */␊ - hotCachePeriod?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Kusto/clusters/attachedDatabaseConfigurations␊ - */␊ - export interface ClustersAttachedDatabaseConfigurationsChildResource {␊ - apiVersion: "2019-09-07"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the attached database configuration.␊ - */␊ - name: string␊ - /**␊ - * Class representing the an attached database configuration properties of kind specific.␊ - */␊ - properties: (AttachedDatabaseConfigurationProperties | string)␊ - type: "attachedDatabaseConfigurations"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the an attached database configuration properties of kind specific.␊ - */␊ - export interface AttachedDatabaseConfigurationProperties {␊ - /**␊ - * The resource id of the cluster where the databases you would like to attach reside.␊ - */␊ - clusterResourceId: string␊ - /**␊ - * The name of the database which you would like to attach, use * if you want to follow all current and future databases.␊ - */␊ - databaseName: string␊ - /**␊ - * The default principals modification kind.␊ - */␊ - defaultPrincipalsModificationKind: (("Union" | "Replace" | "None") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure SKU definition.␊ - */␊ - export interface AzureSku4 {␊ - /**␊ - * The number of instances of the cluster.␊ - */␊ - capacity?: (number | string)␊ - /**␊ - * SKU name.␊ - */␊ - name: (("Standard_DS13_v2+1TB_PS" | "Standard_DS13_v2+2TB_PS" | "Standard_DS14_v2+3TB_PS" | "Standard_DS14_v2+4TB_PS" | "Standard_D13_v2" | "Standard_D14_v2" | "Standard_L8s" | "Standard_L16s" | "Standard_D11_v2" | "Standard_D12_v2" | "Standard_L4s" | "Dev(No SLA)_Standard_D11_v2") | string)␊ - /**␊ - * SKU tier.␊ - */␊ - tier: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing an event hub data connection.␊ - */␊ - export interface EventHubDataConnection2 {␊ - kind: "EventHub"␊ - /**␊ - * Class representing the Kusto event hub connection properties.␊ - */␊ - properties?: (EventHubConnectionProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the Kusto event hub connection properties.␊ - */␊ - export interface EventHubConnectionProperties3 {␊ - /**␊ - * The event hub consumer group.␊ - */␊ - consumerGroup: string␊ - /**␊ - * The data format of the message. Optionally the data format can be added to each message.␊ - */␊ - dataFormat?: (("MULTIJSON" | "JSON" | "CSV" | "TSV" | "SCSV" | "SOHSV" | "PSV" | "TXT" | "RAW" | "SINGLEJSON" | "AVRO" | "TSVE") | string)␊ - /**␊ - * The resource ID of the event hub to be used to create a data connection.␊ - */␊ - eventHubResourceId: string␊ - /**␊ - * System properties of the event hub␊ - */␊ - eventSystemProperties?: (string[] | string)␊ - /**␊ - * The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.␊ - */␊ - mappingRuleName?: string␊ - /**␊ - * The table where the data should be ingested. Optionally the table information can be added to each message.␊ - */␊ - tableName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing an iot hub data connection.␊ - */␊ - export interface IotHubDataConnection1 {␊ - kind: "IotHub"␊ - /**␊ - * Class representing the Kusto iot hub connection properties.␊ - */␊ - properties?: (IotHubConnectionProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the Kusto iot hub connection properties.␊ - */␊ - export interface IotHubConnectionProperties1 {␊ - /**␊ - * The iot hub consumer group.␊ - */␊ - consumerGroup: string␊ - /**␊ - * The data format of the message. Optionally the data format can be added to each message.␊ - */␊ - dataFormat?: (("MULTIJSON" | "JSON" | "CSV" | "TSV" | "SCSV" | "SOHSV" | "PSV" | "TXT" | "RAW" | "SINGLEJSON" | "AVRO" | "TSVE") | string)␊ - /**␊ - * System properties of the iot hub␊ - */␊ - eventSystemProperties?: (string[] | string)␊ - /**␊ - * The resource ID of the Iot hub to be used to create a data connection.␊ - */␊ - iotHubResourceId: string␊ - /**␊ - * The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.␊ - */␊ - mappingRuleName?: string␊ - /**␊ - * The name of the share access policy name␊ - */␊ - sharedAccessPolicyName: string␊ - /**␊ - * The table where the data should be ingested. Optionally the table information can be added to each message.␊ - */␊ - tableName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing an Event Grid data connection.␊ - */␊ - export interface EventGridDataConnection2 {␊ - kind: "EventGrid"␊ - /**␊ - * Class representing the Kusto event grid connection properties.␊ - */␊ - properties?: (EventGridConnectionProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the Kusto event grid connection properties.␊ - */␊ - export interface EventGridConnectionProperties2 {␊ - /**␊ - * The event hub consumer group.␊ - */␊ - consumerGroup: string␊ - /**␊ - * The data format of the message. Optionally the data format can be added to each message.␊ - */␊ - dataFormat: (("MULTIJSON" | "JSON" | "CSV" | "TSV" | "SCSV" | "SOHSV" | "PSV" | "TXT" | "RAW" | "SINGLEJSON" | "AVRO" | "TSVE") | string)␊ - /**␊ - * The resource ID where the event grid is configured to send events.␊ - */␊ - eventHubResourceId: string␊ - /**␊ - * The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.␊ - */␊ - mappingRuleName?: string␊ - /**␊ - * The resource ID of the storage account where the data resides.␊ - */␊ - storageAccountResourceId: string␊ - /**␊ - * The table where the data should be ingested. Optionally the table information can be added to each message.␊ - */␊ - tableName: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Kusto/clusters/attachedDatabaseConfigurations␊ - */␊ - export interface ClustersAttachedDatabaseConfigurations {␊ - apiVersion: "2019-09-07"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the attached database configuration.␊ - */␊ - name: string␊ - /**␊ - * Class representing the an attached database configuration properties of kind specific.␊ - */␊ - properties: (AttachedDatabaseConfigurationProperties | string)␊ - type: "Microsoft.Kusto/clusters/attachedDatabaseConfigurations"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Kusto/clusters␊ - */␊ - export interface Clusters5 {␊ - apiVersion: "2019-11-09"␊ - /**␊ - * Identity for the resource.␊ - */␊ - identity?: (Identity2 | string)␊ - /**␊ - * The geo-location where the resource lives␊ - */␊ - location: string␊ - /**␊ - * The name of the Kusto cluster.␊ - */␊ - name: string␊ - /**␊ - * Class representing the Kusto cluster properties.␊ - */␊ - properties?: (ClusterProperties4 | string)␊ - resources?: (ClustersPrincipalAssignmentsChildResource | ClustersDatabasesChildResource4 | ClustersAttachedDatabaseConfigurationsChildResource1 | ClustersDataConnectionsChildResource)[]␊ - /**␊ - * Azure SKU definition.␊ - */␊ - sku: (AzureSku5 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Kusto/clusters"␊ - /**␊ - * An array represents the availability zones of the cluster.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the resource.␊ - */␊ - export interface Identity2 {␊ - /**␊ - * The identity type.␊ - */␊ - type: (("None" | "SystemAssigned") | string)␊ - /**␊ - * The list of user identities associated with the Kusto cluster. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.␊ - */␊ - userAssignedIdentities?: ({␊ - [k: string]: Componentssgqdofschemasidentitypropertiesuserassignedidentitiesadditionalproperties1␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - export interface Componentssgqdofschemasidentitypropertiesuserassignedidentitiesadditionalproperties1 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the Kusto cluster properties.␊ - */␊ - export interface ClusterProperties4 {␊ - /**␊ - * A boolean value that indicates if the cluster's disks are encrypted.␊ - */␊ - enableDiskEncryption?: (boolean | string)␊ - /**␊ - * A boolean value that indicates if the streaming ingest is enabled.␊ - */␊ - enableStreamingIngest?: (boolean | string)␊ - /**␊ - * Properties of the key vault.␊ - */␊ - keyVaultProperties?: (KeyVaultProperties1 | string)␊ - /**␊ - * A class that contains the optimized auto scale definition.␊ - */␊ - optimizedAutoscale?: (OptimizedAutoscale2 | string)␊ - /**␊ - * The cluster's external tenants.␊ - */␊ - trustedExternalTenants?: (TrustedExternalTenant4[] | string)␊ - /**␊ - * A class that contains virtual network definition.␊ - */␊ - virtualNetworkConfiguration?: (VirtualNetworkConfiguration2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the key vault.␊ - */␊ - export interface KeyVaultProperties1 {␊ - /**␊ - * The name of the key vault key.␊ - */␊ - keyName: string␊ - /**␊ - * The Uri of the key vault.␊ - */␊ - keyVaultUri: string␊ - /**␊ - * The version of the key vault key.␊ - */␊ - keyVersion: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A class that contains the optimized auto scale definition.␊ - */␊ - export interface OptimizedAutoscale2 {␊ - /**␊ - * A boolean value that indicate if the optimized autoscale feature is enabled or not.␊ - */␊ - isEnabled: (boolean | string)␊ - /**␊ - * Maximum allowed instances count.␊ - */␊ - maximum: (number | string)␊ - /**␊ - * Minimum allowed instances count.␊ - */␊ - minimum: (number | string)␊ - /**␊ - * The version of the template defined, for instance 1.␊ - */␊ - version: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents a tenant ID that is trusted by the cluster.␊ - */␊ - export interface TrustedExternalTenant4 {␊ - /**␊ - * GUID representing an external tenant.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A class that contains virtual network definition.␊ - */␊ - export interface VirtualNetworkConfiguration2 {␊ - /**␊ - * Data management's service public IP address resource id.␊ - */␊ - dataManagementPublicIpId: string␊ - /**␊ - * Engine service's public IP address resource id.␊ - */␊ - enginePublicIpId: string␊ - /**␊ - * The subnet resource id.␊ - */␊ - subnetId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Kusto/clusters/principalAssignments␊ - */␊ - export interface ClustersPrincipalAssignmentsChildResource {␊ - apiVersion: "2019-11-09"␊ - /**␊ - * The name of the Kusto principalAssignment.␊ - */␊ - name: string␊ - /**␊ - * A class representing cluster principal property.␊ - */␊ - properties: (ClusterPrincipalProperties | string)␊ - type: "principalAssignments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A class representing cluster principal property.␊ - */␊ - export interface ClusterPrincipalProperties {␊ - /**␊ - * The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name.␊ - */␊ - principalId: string␊ - /**␊ - * Principal type.␊ - */␊ - principalType: (("App" | "Group" | "User") | string)␊ - /**␊ - * Cluster principal role.␊ - */␊ - role: (("AllDatabasesAdmin" | "AllDatabasesViewer") | string)␊ - /**␊ - * The tenant id of the principal␊ - */␊ - tenantId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing a read write database.␊ - */␊ - export interface ReadWriteDatabase1 {␊ - kind: "ReadWrite"␊ - /**␊ - * Class representing the Kusto database properties.␊ - */␊ - properties?: (ReadWriteDatabaseProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the Kusto database properties.␊ - */␊ - export interface ReadWriteDatabaseProperties1 {␊ - /**␊ - * The time the data should be kept in cache for fast queries in TimeSpan.␊ - */␊ - hotCachePeriod?: string␊ - /**␊ - * The time the data should be kept before it stops being accessible to queries in TimeSpan.␊ - */␊ - softDeletePeriod?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing a read only following database.␊ - */␊ - export interface ReadOnlyFollowingDatabase1 {␊ - kind: "ReadOnlyFollowing"␊ - /**␊ - * Class representing the Kusto database properties.␊ - */␊ - properties?: (ReadOnlyFollowingDatabaseProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the Kusto database properties.␊ - */␊ - export interface ReadOnlyFollowingDatabaseProperties1 {␊ - /**␊ - * The time the data should be kept in cache for fast queries in TimeSpan.␊ - */␊ - hotCachePeriod?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Kusto/clusters/attachedDatabaseConfigurations␊ - */␊ - export interface ClustersAttachedDatabaseConfigurationsChildResource1 {␊ - apiVersion: "2019-11-09"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the attached database configuration.␊ - */␊ - name: string␊ - /**␊ - * Class representing the an attached database configuration properties of kind specific.␊ - */␊ - properties: (AttachedDatabaseConfigurationProperties1 | string)␊ - type: "attachedDatabaseConfigurations"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the an attached database configuration properties of kind specific.␊ - */␊ - export interface AttachedDatabaseConfigurationProperties1 {␊ - /**␊ - * The resource id of the cluster where the databases you would like to attach reside.␊ - */␊ - clusterResourceId: string␊ - /**␊ - * The name of the database which you would like to attach, use * if you want to follow all current and future databases.␊ - */␊ - databaseName: string␊ - /**␊ - * The default principals modification kind.␊ - */␊ - defaultPrincipalsModificationKind: (("Union" | "Replace" | "None") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the Geneva (GDS) data connection␊ - */␊ - export interface GenevaDataConnection {␊ - /**␊ - * Geneva (DGS) data connection properties␊ - */␊ - properties?: (GenevaDataConnectionProperties | string)␊ - kind: "Geneva"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the Kusto Geneva (GDS) connection properties.␊ - */␊ - export interface GenevaDataConnectionProperties {␊ - /**␊ - * The Geneva environment of the geneva data connection.␊ - */␊ - genevaEnvironment: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the Geneva legacy data connection.␊ - */␊ - export interface GenevaLegacyDataConnection {␊ - /**␊ - * Geneva legacy data connection properties.␊ - */␊ - properties?: (GenevaLegacyDataConnectionProperties | string)␊ - kind: "GenevaLegacy"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the Kusto Geneva legacy connection properties.␊ - */␊ - export interface GenevaLegacyDataConnectionProperties {␊ - /**␊ - * The Geneva environment of the geneva data connection.␊ - */␊ - genevaEnvironment: string␊ - /**␊ - * The list of mds accounts of the geneva data connection.␊ - */␊ - mdsAccounts: unknown[]␊ - /**␊ - * Indicates whether the data is scrubbed.␊ - */␊ - isScrubbed: boolean␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure SKU definition.␊ - */␊ - export interface AzureSku5 {␊ - /**␊ - * The number of instances of the cluster.␊ - */␊ - capacity?: (number | string)␊ - /**␊ - * SKU name.␊ - */␊ - name: (("Standard_DS13_v2+1TB_PS" | "Standard_DS13_v2+2TB_PS" | "Standard_DS14_v2+3TB_PS" | "Standard_DS14_v2+4TB_PS" | "Standard_D13_v2" | "Standard_D14_v2" | "Standard_L8s" | "Standard_L16s" | "Standard_D11_v2" | "Standard_D12_v2" | "Standard_L4s" | "Dev(No SLA)_Standard_D11_v2") | string)␊ - /**␊ - * SKU tier.␊ - */␊ - tier: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Kusto/clusters/databases/principalAssignments␊ - */␊ - export interface ClustersDatabasesPrincipalAssignmentsChildResource {␊ - apiVersion: "2019-11-09"␊ - /**␊ - * The name of the Kusto principalAssignment.␊ - */␊ - name: string␊ - /**␊ - * A class representing database principal property.␊ - */␊ - properties: (DatabasePrincipalProperties | string)␊ - type: "principalAssignments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A class representing database principal property.␊ - */␊ - export interface DatabasePrincipalProperties {␊ - /**␊ - * The principal ID assigned to the database principal. It can be a user email, application ID, or security group name.␊ - */␊ - principalId: string␊ - /**␊ - * Principal type.␊ - */␊ - principalType: (("App" | "Group" | "User") | string)␊ - /**␊ - * Database principal role.␊ - */␊ - role: (("Admin" | "Ingestor" | "Monitor" | "User" | "UnrestrictedViewers" | "Viewer") | string)␊ - /**␊ - * The tenant id of the principal␊ - */␊ - tenantId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing an event hub data connection.␊ - */␊ - export interface EventHubDataConnection3 {␊ - kind: "EventHub"␊ - /**␊ - * Class representing the Kusto event hub connection properties.␊ - */␊ - properties?: (EventHubConnectionProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the Kusto event hub connection properties.␊ - */␊ - export interface EventHubConnectionProperties4 {␊ - /**␊ - * The event hub messages compression type.␊ - */␊ - compression?: (("None" | "GZip") | string)␊ - /**␊ - * The event hub consumer group.␊ - */␊ - consumerGroup: string␊ - /**␊ - * The data format of the message. Optionally the data format can be added to each message.␊ - */␊ - dataFormat?: (("MULTIJSON" | "JSON" | "CSV" | "TSV" | "SCSV" | "SOHSV" | "PSV" | "TXT" | "RAW" | "SINGLEJSON" | "AVRO" | "TSVE" | "PARQUET" | "ORC") | string)␊ - /**␊ - * The resource ID of the event hub to be used to create a data connection.␊ - */␊ - eventHubResourceId: string␊ - /**␊ - * System properties of the event hub␊ - */␊ - eventSystemProperties?: (string[] | string)␊ - /**␊ - * The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.␊ - */␊ - mappingRuleName?: string␊ - /**␊ - * The table where the data should be ingested. Optionally the table information can be added to each message.␊ - */␊ - tableName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing an iot hub data connection.␊ - */␊ - export interface IotHubDataConnection2 {␊ - kind: "IotHub"␊ - /**␊ - * Class representing the Kusto Iot hub connection properties.␊ - */␊ - properties?: (IotHubConnectionProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the Kusto Iot hub connection properties.␊ - */␊ - export interface IotHubConnectionProperties2 {␊ - /**␊ - * The iot hub consumer group.␊ - */␊ - consumerGroup: string␊ - /**␊ - * The data format of the message. Optionally the data format can be added to each message.␊ - */␊ - dataFormat?: (("MULTIJSON" | "JSON" | "CSV" | "TSV" | "SCSV" | "SOHSV" | "PSV" | "TXT" | "RAW" | "SINGLEJSON" | "AVRO" | "TSVE" | "PARQUET" | "ORC") | string)␊ - /**␊ - * System properties of the iot hub␊ - */␊ - eventSystemProperties?: (string[] | string)␊ - /**␊ - * The resource ID of the Iot hub to be used to create a data connection.␊ - */␊ - iotHubResourceId: string␊ - /**␊ - * The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.␊ - */␊ - mappingRuleName?: string␊ - /**␊ - * The name of the share access policy␊ - */␊ - sharedAccessPolicyName: string␊ - /**␊ - * The table where the data should be ingested. Optionally the table information can be added to each message.␊ - */␊ - tableName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing an Event Grid data connection.␊ - */␊ - export interface EventGridDataConnection3 {␊ - kind: "EventGrid"␊ - /**␊ - * Class representing the Kusto event grid connection properties.␊ - */␊ - properties?: (EventGridConnectionProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the Kusto event grid connection properties.␊ - */␊ - export interface EventGridConnectionProperties3 {␊ - /**␊ - * The event hub consumer group.␊ - */␊ - consumerGroup: string␊ - /**␊ - * The data format of the message. Optionally the data format can be added to each message.␊ - */␊ - dataFormat: (("MULTIJSON" | "JSON" | "CSV" | "TSV" | "SCSV" | "SOHSV" | "PSV" | "TXT" | "RAW" | "SINGLEJSON" | "AVRO" | "TSVE" | "PARQUET" | "ORC") | string)␊ - /**␊ - * The resource ID where the event grid is configured to send events.␊ - */␊ - eventHubResourceId: string␊ - /**␊ - * The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.␊ - */␊ - mappingRuleName?: string␊ - /**␊ - * The resource ID of the storage account where the data resides.␊ - */␊ - storageAccountResourceId: string␊ - /**␊ - * The table where the data should be ingested. Optionally the table information can be added to each message.␊ - */␊ - tableName: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Kusto/clusters/attachedDatabaseConfigurations␊ - */␊ - export interface ClustersAttachedDatabaseConfigurations1 {␊ - apiVersion: "2019-11-09"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the attached database configuration.␊ - */␊ - name: string␊ - /**␊ - * Class representing the an attached database configuration properties of kind specific.␊ - */␊ - properties: (AttachedDatabaseConfigurationProperties1 | string)␊ - type: "Microsoft.Kusto/clusters/attachedDatabaseConfigurations"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Kusto/clusters/principalAssignments␊ - */␊ - export interface ClustersPrincipalAssignments {␊ - apiVersion: "2019-11-09"␊ - /**␊ - * The name of the Kusto principalAssignment.␊ - */␊ - name: string␊ - /**␊ - * A class representing cluster principal property.␊ - */␊ - properties: (ClusterPrincipalProperties | string)␊ - type: "Microsoft.Kusto/clusters/principalAssignments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Kusto/clusters/databases/principalAssignments␊ - */␊ - export interface ClustersDatabasesPrincipalAssignments {␊ - apiVersion: "2019-11-09"␊ - /**␊ - * The name of the Kusto principalAssignment.␊ - */␊ - name: string␊ - /**␊ - * A class representing database principal property.␊ - */␊ - properties: (DatabasePrincipalProperties | string)␊ - type: "Microsoft.Kusto/clusters/databases/principalAssignments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Kusto/clusters␊ - */␊ - export interface Clusters6 {␊ - apiVersion: "2020-02-15"␊ - /**␊ - * Identity for the resource.␊ - */␊ - identity?: (Identity3 | string)␊ - /**␊ - * The geo-location where the resource lives␊ - */␊ - location: string␊ - /**␊ - * The name of the Kusto cluster.␊ - */␊ - name: string␊ - /**␊ - * Class representing the Kusto cluster properties.␊ - */␊ - properties?: (ClusterProperties5 | string)␊ - resources?: (ClustersPrincipalAssignmentsChildResource1 | ClustersDatabasesChildResource5 | ClustersAttachedDatabaseConfigurationsChildResource2 | ClustersDataConnectionsChildResource1)[]␊ - /**␊ - * Azure SKU definition.␊ - */␊ - sku: (AzureSku6 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Kusto/clusters"␊ - /**␊ - * An array represents the availability zones of the cluster.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the resource.␊ - */␊ - export interface Identity3 {␊ - /**␊ - * The identity type.␊ - */␊ - type: (("None" | "SystemAssigned") | string)␊ - /**␊ - * The list of user identities associated with the Kusto cluster. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.␊ - */␊ - userAssignedIdentities?: ({␊ - [k: string]: Componentssgqdofschemasidentitypropertiesuserassignedidentitiesadditionalproperties2␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - export interface Componentssgqdofschemasidentitypropertiesuserassignedidentitiesadditionalproperties2 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the Kusto cluster properties.␊ - */␊ - export interface ClusterProperties5 {␊ - /**␊ - * A boolean value that indicates if the cluster's disks are encrypted.␊ - */␊ - enableDiskEncryption?: (boolean | string)␊ - /**␊ - * A boolean value that indicates if the purge operations are enabled.␊ - */␊ - enablePurge?: (boolean | string)␊ - /**␊ - * A boolean value that indicates if the streaming ingest is enabled.␊ - */␊ - enableStreamingIngest?: (boolean | string)␊ - /**␊ - * Properties of the key vault.␊ - */␊ - keyVaultProperties?: (KeyVaultProperties2 | string)␊ - /**␊ - * The list of language extension objects.␊ - */␊ - languageExtensions?: (LanguageExtensionsList | string)␊ - /**␊ - * A class that contains the optimized auto scale definition.␊ - */␊ - optimizedAutoscale?: (OptimizedAutoscale3 | string)␊ - /**␊ - * The cluster's external tenants.␊ - */␊ - trustedExternalTenants?: (TrustedExternalTenant5[] | string)␊ - /**␊ - * A class that contains virtual network definition.␊ - */␊ - virtualNetworkConfiguration?: (VirtualNetworkConfiguration3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the key vault.␊ - */␊ - export interface KeyVaultProperties2 {␊ - /**␊ - * The name of the key vault key.␊ - */␊ - keyName: string␊ - /**␊ - * The Uri of the key vault.␊ - */␊ - keyVaultUri: string␊ - /**␊ - * The version of the key vault key.␊ - */␊ - keyVersion: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The list of language extension objects.␊ - */␊ - export interface LanguageExtensionsList {␊ - /**␊ - * The list of language extensions.␊ - */␊ - value?: (LanguageExtension[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The language extension object.␊ - */␊ - export interface LanguageExtension {␊ - /**␊ - * The language extension name.␊ - */␊ - languageExtensionName?: (("PYTHON" | "R") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A class that contains the optimized auto scale definition.␊ - */␊ - export interface OptimizedAutoscale3 {␊ - /**␊ - * A boolean value that indicate if the optimized autoscale feature is enabled or not.␊ - */␊ - isEnabled: (boolean | string)␊ - /**␊ - * Maximum allowed instances count.␊ - */␊ - maximum: (number | string)␊ - /**␊ - * Minimum allowed instances count.␊ - */␊ - minimum: (number | string)␊ - /**␊ - * The version of the template defined, for instance 1.␊ - */␊ - version: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents a tenant ID that is trusted by the cluster.␊ - */␊ - export interface TrustedExternalTenant5 {␊ - /**␊ - * GUID representing an external tenant.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A class that contains virtual network definition.␊ - */␊ - export interface VirtualNetworkConfiguration3 {␊ - /**␊ - * Data management's service public IP address resource id.␊ - */␊ - dataManagementPublicIpId: string␊ - /**␊ - * Engine service's public IP address resource id.␊ - */␊ - enginePublicIpId: string␊ - /**␊ - * The subnet resource id.␊ - */␊ - subnetId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Kusto/clusters/principalAssignments␊ - */␊ - export interface ClustersPrincipalAssignmentsChildResource1 {␊ - apiVersion: "2020-02-15"␊ - /**␊ - * The name of the Kusto principalAssignment.␊ - */␊ - name: string␊ - /**␊ - * A class representing cluster principal property.␊ - */␊ - properties: (ClusterPrincipalProperties1 | string)␊ - type: "principalAssignments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A class representing cluster principal property.␊ - */␊ - export interface ClusterPrincipalProperties1 {␊ - /**␊ - * The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name.␊ - */␊ - principalId: string␊ - /**␊ - * Principal type.␊ - */␊ - principalType: (("App" | "Group" | "User") | string)␊ - /**␊ - * Cluster principal role.␊ - */␊ - role: (("AllDatabasesAdmin" | "AllDatabasesViewer") | string)␊ - /**␊ - * The tenant id of the principal␊ - */␊ - tenantId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing a read write database.␊ - */␊ - export interface ReadWriteDatabase2 {␊ - kind: "ReadWrite"␊ - /**␊ - * Class representing the Kusto database properties.␊ - */␊ - properties?: (ReadWriteDatabaseProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the Kusto database properties.␊ - */␊ - export interface ReadWriteDatabaseProperties2 {␊ - /**␊ - * The time the data should be kept in cache for fast queries in TimeSpan.␊ - */␊ - hotCachePeriod?: string␊ - /**␊ - * The time the data should be kept before it stops being accessible to queries in TimeSpan.␊ - */␊ - softDeletePeriod?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing a read only following database.␊ - */␊ - export interface ReadOnlyFollowingDatabase2 {␊ - kind: "ReadOnlyFollowing"␊ - /**␊ - * Class representing the Kusto database properties.␊ - */␊ - properties?: (ReadOnlyFollowingDatabaseProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the Kusto database properties.␊ - */␊ - export interface ReadOnlyFollowingDatabaseProperties2 {␊ - /**␊ - * The time the data should be kept in cache for fast queries in TimeSpan.␊ - */␊ - hotCachePeriod?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Kusto/clusters/attachedDatabaseConfigurations␊ - */␊ - export interface ClustersAttachedDatabaseConfigurationsChildResource2 {␊ - apiVersion: "2020-02-15"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the attached database configuration.␊ - */␊ - name: string␊ - /**␊ - * Class representing the an attached database configuration properties of kind specific.␊ - */␊ - properties: (AttachedDatabaseConfigurationProperties2 | string)␊ - type: "attachedDatabaseConfigurations"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the an attached database configuration properties of kind specific.␊ - */␊ - export interface AttachedDatabaseConfigurationProperties2 {␊ - /**␊ - * The resource id of the cluster where the databases you would like to attach reside.␊ - */␊ - clusterResourceId: string␊ - /**␊ - * The name of the database which you would like to attach, use * if you want to follow all current and future databases.␊ - */␊ - databaseName: string␊ - /**␊ - * The default principals modification kind.␊ - */␊ - defaultPrincipalsModificationKind: (("Union" | "Replace" | "None") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the Geneva (GDS) data connection␊ - */␊ - export interface GenevaDataConnection1 {␊ - /**␊ - * Geneva (DGS) data connection properties␊ - */␊ - properties?: (GenevaDataConnectionProperties1 | string)␊ - kind: "Geneva"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the Kusto Geneva (GDS) connection properties.␊ - */␊ - export interface GenevaDataConnectionProperties1 {␊ - /**␊ - * The Geneva environment of the geneva data connection.␊ - */␊ - genevaEnvironment: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the Geneva legacy data connection.␊ - */␊ - export interface GenevaLegacyDataConnection1 {␊ - /**␊ - * Geneva legacy data connection properties.␊ - */␊ - properties?: (GenevaLegacyDataConnectionProperties1 | string)␊ - kind: "GenevaLegacy"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the Kusto Geneva legacy connection properties.␊ - */␊ - export interface GenevaLegacyDataConnectionProperties1 {␊ - /**␊ - * The Geneva environment of the geneva data connection.␊ - */␊ - genevaEnvironment: string␊ - /**␊ - * The list of mds accounts of the geneva data connection.␊ - */␊ - mdsAccounts: unknown[]␊ - /**␊ - * Indicates whether the data is scrubbed.␊ - */␊ - isScrubbed: boolean␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure SKU definition.␊ - */␊ - export interface AzureSku6 {␊ - /**␊ - * The number of instances of the cluster.␊ - */␊ - capacity?: (number | string)␊ - /**␊ - * SKU name.␊ - */␊ - name: (("Standard_DS13_v2+1TB_PS" | "Standard_DS13_v2+2TB_PS" | "Standard_DS14_v2+3TB_PS" | "Standard_DS14_v2+4TB_PS" | "Standard_D13_v2" | "Standard_D14_v2" | "Standard_L8s" | "Standard_L16s" | "Standard_D11_v2" | "Standard_D12_v2" | "Standard_L4s" | "Dev(No SLA)_Standard_D11_v2" | "Standard_E2a_v4" | "Standard_E4a_v4" | "Standard_E8a_v4" | "Standard_E16a_v4" | "Standard_E8as_v4+1TB_PS" | "Standard_E8as_v4+2TB_PS" | "Standard_E16as_v4+3TB_PS" | "Standard_E16as_v4+4TB_PS" | "Dev(No SLA)_Standard_E2a_v4") | string)␊ - /**␊ - * SKU tier.␊ - */␊ - tier: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Kusto/clusters/databases/principalAssignments␊ - */␊ - export interface ClustersDatabasesPrincipalAssignmentsChildResource1 {␊ - apiVersion: "2020-02-15"␊ - /**␊ - * The name of the Kusto principalAssignment.␊ - */␊ - name: string␊ - /**␊ - * A class representing database principal property.␊ - */␊ - properties: (DatabasePrincipalProperties1 | string)␊ - type: "principalAssignments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A class representing database principal property.␊ - */␊ - export interface DatabasePrincipalProperties1 {␊ - /**␊ - * The principal ID assigned to the database principal. It can be a user email, application ID, or security group name.␊ - */␊ - principalId: string␊ - /**␊ - * Principal type.␊ - */␊ - principalType: (("App" | "Group" | "User") | string)␊ - /**␊ - * Database principal role.␊ - */␊ - role: (("Admin" | "Ingestor" | "Monitor" | "User" | "UnrestrictedViewers" | "Viewer") | string)␊ - /**␊ - * The tenant id of the principal␊ - */␊ - tenantId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing an event hub data connection.␊ - */␊ - export interface EventHubDataConnection4 {␊ - kind: "EventHub"␊ - /**␊ - * Class representing the Kusto event hub connection properties.␊ - */␊ - properties?: (EventHubConnectionProperties5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the Kusto event hub connection properties.␊ - */␊ - export interface EventHubConnectionProperties5 {␊ - /**␊ - * The event hub messages compression type.␊ - */␊ - compression?: (("None" | "GZip") | string)␊ - /**␊ - * The event hub consumer group.␊ - */␊ - consumerGroup: string␊ - /**␊ - * The data format of the message. Optionally the data format can be added to each message.␊ - */␊ - dataFormat?: (("MULTIJSON" | "JSON" | "CSV" | "TSV" | "SCSV" | "SOHSV" | "PSV" | "TXT" | "RAW" | "SINGLEJSON" | "AVRO" | "TSVE" | "PARQUET" | "ORC") | string)␊ - /**␊ - * The resource ID of the event hub to be used to create a data connection.␊ - */␊ - eventHubResourceId: string␊ - /**␊ - * System properties of the event hub␊ - */␊ - eventSystemProperties?: (string[] | string)␊ - /**␊ - * The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.␊ - */␊ - mappingRuleName?: string␊ - /**␊ - * The table where the data should be ingested. Optionally the table information can be added to each message.␊ - */␊ - tableName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing an iot hub data connection.␊ - */␊ - export interface IotHubDataConnection3 {␊ - kind: "IotHub"␊ - /**␊ - * Class representing the Kusto Iot hub connection properties.␊ - */␊ - properties?: (IotHubConnectionProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the Kusto Iot hub connection properties.␊ - */␊ - export interface IotHubConnectionProperties3 {␊ - /**␊ - * The iot hub consumer group.␊ - */␊ - consumerGroup: string␊ - /**␊ - * The data format of the message. Optionally the data format can be added to each message.␊ - */␊ - dataFormat?: (("MULTIJSON" | "JSON" | "CSV" | "TSV" | "SCSV" | "SOHSV" | "PSV" | "TXT" | "RAW" | "SINGLEJSON" | "AVRO" | "TSVE" | "PARQUET" | "ORC") | string)␊ - /**␊ - * System properties of the iot hub␊ - */␊ - eventSystemProperties?: (string[] | string)␊ - /**␊ - * The resource ID of the Iot hub to be used to create a data connection.␊ - */␊ - iotHubResourceId: string␊ - /**␊ - * The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.␊ - */␊ - mappingRuleName?: string␊ - /**␊ - * The name of the share access policy␊ - */␊ - sharedAccessPolicyName: string␊ - /**␊ - * The table where the data should be ingested. Optionally the table information can be added to each message.␊ - */␊ - tableName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing an Event Grid data connection.␊ - */␊ - export interface EventGridDataConnection4 {␊ - kind: "EventGrid"␊ - /**␊ - * Class representing the Kusto event grid connection properties.␊ - */␊ - properties?: (EventGridConnectionProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the Kusto event grid connection properties.␊ - */␊ - export interface EventGridConnectionProperties4 {␊ - /**␊ - * The event hub consumer group.␊ - */␊ - consumerGroup: string␊ - /**␊ - * The data format of the message. Optionally the data format can be added to each message.␊ - */␊ - dataFormat: (("MULTIJSON" | "JSON" | "CSV" | "TSV" | "SCSV" | "SOHSV" | "PSV" | "TXT" | "RAW" | "SINGLEJSON" | "AVRO" | "TSVE" | "PARQUET" | "ORC") | string)␊ - /**␊ - * The resource ID where the event grid is configured to send events.␊ - */␊ - eventHubResourceId: string␊ - /**␊ - * The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.␊ - */␊ - mappingRuleName?: string␊ - /**␊ - * The resource ID of the storage account where the data resides.␊ - */␊ - storageAccountResourceId: string␊ - /**␊ - * The table where the data should be ingested. Optionally the table information can be added to each message.␊ - */␊ - tableName: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Kusto/clusters/attachedDatabaseConfigurations␊ - */␊ - export interface ClustersAttachedDatabaseConfigurations2 {␊ - apiVersion: "2020-02-15"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the attached database configuration.␊ - */␊ - name: string␊ - /**␊ - * Class representing the an attached database configuration properties of kind specific.␊ - */␊ - properties: (AttachedDatabaseConfigurationProperties2 | string)␊ - type: "Microsoft.Kusto/clusters/attachedDatabaseConfigurations"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Kusto/clusters/principalAssignments␊ - */␊ - export interface ClustersPrincipalAssignments1 {␊ - apiVersion: "2020-02-15"␊ - /**␊ - * The name of the Kusto principalAssignment.␊ - */␊ - name: string␊ - /**␊ - * A class representing cluster principal property.␊ - */␊ - properties: (ClusterPrincipalProperties1 | string)␊ - type: "Microsoft.Kusto/clusters/principalAssignments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Kusto/clusters/databases/principalAssignments␊ - */␊ - export interface ClustersDatabasesPrincipalAssignments1 {␊ - apiVersion: "2020-02-15"␊ - /**␊ - * The name of the Kusto principalAssignment.␊ - */␊ - name: string␊ - /**␊ - * A class representing database principal property.␊ - */␊ - properties: (DatabasePrincipalProperties1 | string)␊ - type: "Microsoft.Kusto/clusters/databases/principalAssignments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Kusto/clusters␊ - */␊ - export interface Clusters7 {␊ - apiVersion: "2020-06-14"␊ - /**␊ - * Identity for the resource.␊ - */␊ - identity?: (Identity4 | string)␊ - /**␊ - * The geo-location where the resource lives␊ - */␊ - location: string␊ - /**␊ - * The name of the Kusto cluster.␊ - */␊ - name: string␊ - /**␊ - * Class representing the Kusto cluster properties.␊ - */␊ - properties?: (ClusterProperties6 | string)␊ - resources?: (ClustersPrincipalAssignmentsChildResource2 | ClustersDatabasesChildResource6 | ClustersAttachedDatabaseConfigurationsChildResource3 | ClustersDataConnectionsChildResource2)[]␊ - /**␊ - * Azure SKU definition.␊ - */␊ - sku: (AzureSku7 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Kusto/clusters"␊ - /**␊ - * An array represents the availability zones of the cluster.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the resource.␊ - */␊ - export interface Identity4 {␊ - /**␊ - * The identity type.␊ - */␊ - type: (("None" | "SystemAssigned") | string)␊ - /**␊ - * The list of user identities associated with the Kusto cluster. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.␊ - */␊ - userAssignedIdentities?: ({␊ - [k: string]: Componentssgqdofschemasidentitypropertiesuserassignedidentitiesadditionalproperties3␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - export interface Componentssgqdofschemasidentitypropertiesuserassignedidentitiesadditionalproperties3 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the Kusto cluster properties.␊ - */␊ - export interface ClusterProperties6 {␊ - /**␊ - * A boolean value that indicates if the cluster's disks are encrypted.␊ - */␊ - enableDiskEncryption?: (boolean | string)␊ - /**␊ - * A boolean value that indicates if double encryption is enabled.␊ - */␊ - enableDoubleEncryption?: (boolean | string)␊ - /**␊ - * A boolean value that indicates if the purge operations are enabled.␊ - */␊ - enablePurge?: (boolean | string)␊ - /**␊ - * A boolean value that indicates if the streaming ingest is enabled.␊ - */␊ - enableStreamingIngest?: (boolean | string)␊ - /**␊ - * Properties of the key vault.␊ - */␊ - keyVaultProperties?: (KeyVaultProperties3 | string)␊ - /**␊ - * A class that contains the optimized auto scale definition.␊ - */␊ - optimizedAutoscale?: (OptimizedAutoscale4 | string)␊ - /**␊ - * The cluster's external tenants.␊ - */␊ - trustedExternalTenants?: (TrustedExternalTenant6[] | string)␊ - /**␊ - * A class that contains virtual network definition.␊ - */␊ - virtualNetworkConfiguration?: (VirtualNetworkConfiguration4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the key vault.␊ - */␊ - export interface KeyVaultProperties3 {␊ - /**␊ - * The name of the key vault key.␊ - */␊ - keyName: string␊ - /**␊ - * The Uri of the key vault.␊ - */␊ - keyVaultUri: string␊ - /**␊ - * The version of the key vault key.␊ - */␊ - keyVersion: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A class that contains the optimized auto scale definition.␊ - */␊ - export interface OptimizedAutoscale4 {␊ - /**␊ - * A boolean value that indicate if the optimized autoscale feature is enabled or not.␊ - */␊ - isEnabled: (boolean | string)␊ - /**␊ - * Maximum allowed instances count.␊ - */␊ - maximum: (number | string)␊ - /**␊ - * Minimum allowed instances count.␊ - */␊ - minimum: (number | string)␊ - /**␊ - * The version of the template defined, for instance 1.␊ - */␊ - version: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents a tenant ID that is trusted by the cluster.␊ - */␊ - export interface TrustedExternalTenant6 {␊ - /**␊ - * GUID representing an external tenant.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A class that contains virtual network definition.␊ - */␊ - export interface VirtualNetworkConfiguration4 {␊ - /**␊ - * Data management's service public IP address resource id.␊ - */␊ - dataManagementPublicIpId: string␊ - /**␊ - * Engine service's public IP address resource id.␊ - */␊ - enginePublicIpId: string␊ - /**␊ - * The subnet resource id.␊ - */␊ - subnetId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Kusto/clusters/principalAssignments␊ - */␊ - export interface ClustersPrincipalAssignmentsChildResource2 {␊ - apiVersion: "2020-06-14"␊ - /**␊ - * The name of the Kusto principalAssignment.␊ - */␊ - name: string␊ - /**␊ - * A class representing cluster principal property.␊ - */␊ - properties: (ClusterPrincipalProperties2 | string)␊ - type: "principalAssignments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A class representing cluster principal property.␊ - */␊ - export interface ClusterPrincipalProperties2 {␊ - /**␊ - * The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name.␊ - */␊ - principalId: string␊ - /**␊ - * Principal type.␊ - */␊ - principalType: (("App" | "Group" | "User") | string)␊ - /**␊ - * Cluster principal role.␊ - */␊ - role: (("AllDatabasesAdmin" | "AllDatabasesViewer") | string)␊ - /**␊ - * The tenant id of the principal␊ - */␊ - tenantId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing a read write database.␊ - */␊ - export interface ReadWriteDatabase3 {␊ - kind: "ReadWrite"␊ - /**␊ - * Class representing the Kusto database properties.␊ - */␊ - properties?: (ReadWriteDatabaseProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the Kusto database properties.␊ - */␊ - export interface ReadWriteDatabaseProperties3 {␊ - /**␊ - * The time the data should be kept in cache for fast queries in TimeSpan.␊ - */␊ - hotCachePeriod?: string␊ - /**␊ - * The time the data should be kept before it stops being accessible to queries in TimeSpan.␊ - */␊ - softDeletePeriod?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing a read only following database.␊ - */␊ - export interface ReadOnlyFollowingDatabase3 {␊ - kind: "ReadOnlyFollowing"␊ - /**␊ - * Class representing the Kusto database properties.␊ - */␊ - properties?: (ReadOnlyFollowingDatabaseProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the Kusto database properties.␊ - */␊ - export interface ReadOnlyFollowingDatabaseProperties3 {␊ - /**␊ - * The time the data should be kept in cache for fast queries in TimeSpan.␊ - */␊ - hotCachePeriod?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Kusto/clusters/attachedDatabaseConfigurations␊ - */␊ - export interface ClustersAttachedDatabaseConfigurationsChildResource3 {␊ - apiVersion: "2020-06-14"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the attached database configuration.␊ - */␊ - name: string␊ - /**␊ - * Class representing the an attached database configuration properties of kind specific.␊ - */␊ - properties: (AttachedDatabaseConfigurationProperties3 | string)␊ - type: "attachedDatabaseConfigurations"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the an attached database configuration properties of kind specific.␊ - */␊ - export interface AttachedDatabaseConfigurationProperties3 {␊ - /**␊ - * The resource id of the cluster where the databases you would like to attach reside.␊ - */␊ - clusterResourceId: string␊ - /**␊ - * The name of the database which you would like to attach, use * if you want to follow all current and future databases.␊ - */␊ - databaseName: string␊ - /**␊ - * The default principals modification kind.␊ - */␊ - defaultPrincipalsModificationKind: (("Union" | "Replace" | "None") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the Geneva (GDS) data connection␊ - */␊ - export interface GenevaDataConnection2 {␊ - /**␊ - * Geneva (DGS) data connection properties␊ - */␊ - properties?: (GenevaDataConnectionProperties2 | string)␊ - kind: "Geneva"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the Kusto Geneva (GDS) connection properties.␊ - */␊ - export interface GenevaDataConnectionProperties2 {␊ - /**␊ - * The Geneva environment of the geneva data connection.␊ - */␊ - genevaEnvironment: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the Geneva legacy data connection.␊ - */␊ - export interface GenevaLegacyDataConnection2 {␊ - /**␊ - * Geneva legacy data connection properties.␊ - */␊ - properties?: (GenevaLegacyDataConnectionProperties2 | string)␊ - kind: "GenevaLegacy"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the Kusto Geneva legacy connection properties.␊ - */␊ - export interface GenevaLegacyDataConnectionProperties2 {␊ - /**␊ - * The Geneva environment of the geneva data connection.␊ - */␊ - genevaEnvironment: string␊ - /**␊ - * The list of mds accounts of the geneva data connection.␊ - */␊ - mdsAccounts: unknown[]␊ - /**␊ - * Indicates whether the data is scrubbed.␊ - */␊ - isScrubbed: boolean␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure SKU definition.␊ - */␊ - export interface AzureSku7 {␊ - /**␊ - * The number of instances of the cluster.␊ - */␊ - capacity?: (number | string)␊ - /**␊ - * SKU name.␊ - */␊ - name: (("Standard_DS13_v2+1TB_PS" | "Standard_DS13_v2+2TB_PS" | "Standard_DS14_v2+3TB_PS" | "Standard_DS14_v2+4TB_PS" | "Standard_D13_v2" | "Standard_D14_v2" | "Standard_L8s" | "Standard_L16s" | "Standard_D11_v2" | "Standard_D12_v2" | "Standard_L4s" | "Dev(No SLA)_Standard_D11_v2" | "Standard_E2a_v4" | "Standard_E4a_v4" | "Standard_E8a_v4" | "Standard_E16a_v4" | "Standard_E8as_v4+1TB_PS" | "Standard_E8as_v4+2TB_PS" | "Standard_E16as_v4+3TB_PS" | "Standard_E16as_v4+4TB_PS" | "Dev(No SLA)_Standard_E2a_v4") | string)␊ - /**␊ - * SKU tier.␊ - */␊ - tier: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Kusto/clusters/databases/principalAssignments␊ - */␊ - export interface ClustersDatabasesPrincipalAssignmentsChildResource2 {␊ - apiVersion: "2020-06-14"␊ - /**␊ - * The name of the Kusto principalAssignment.␊ - */␊ - name: string␊ - /**␊ - * A class representing database principal property.␊ - */␊ - properties: (DatabasePrincipalProperties2 | string)␊ - type: "principalAssignments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A class representing database principal property.␊ - */␊ - export interface DatabasePrincipalProperties2 {␊ - /**␊ - * The principal ID assigned to the database principal. It can be a user email, application ID, or security group name.␊ - */␊ - principalId: string␊ - /**␊ - * Principal type.␊ - */␊ - principalType: (("App" | "Group" | "User") | string)␊ - /**␊ - * Database principal role.␊ - */␊ - role: (("Admin" | "Ingestor" | "Monitor" | "User" | "UnrestrictedViewers" | "Viewer") | string)␊ - /**␊ - * The tenant id of the principal␊ - */␊ - tenantId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing an event hub data connection.␊ - */␊ - export interface EventHubDataConnection5 {␊ - kind: "EventHub"␊ - /**␊ - * Class representing the Kusto event hub connection properties.␊ - */␊ - properties?: (EventHubConnectionProperties6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the Kusto event hub connection properties.␊ - */␊ - export interface EventHubConnectionProperties6 {␊ - /**␊ - * The event hub messages compression type.␊ - */␊ - compression?: (("None" | "GZip") | string)␊ - /**␊ - * The event hub consumer group.␊ - */␊ - consumerGroup: string␊ - /**␊ - * The data format of the message. Optionally the data format can be added to each message.␊ - */␊ - dataFormat?: (("MULTIJSON" | "JSON" | "CSV" | "TSV" | "SCSV" | "SOHSV" | "PSV" | "TXT" | "RAW" | "SINGLEJSON" | "AVRO" | "TSVE" | "PARQUET" | "ORC" | "APACHEAVRO" | "W3CLOGFILE") | string)␊ - /**␊ - * The resource ID of the event hub to be used to create a data connection.␊ - */␊ - eventHubResourceId: string␊ - /**␊ - * System properties of the event hub␊ - */␊ - eventSystemProperties?: (string[] | string)␊ - /**␊ - * The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.␊ - */␊ - mappingRuleName?: string␊ - /**␊ - * The table where the data should be ingested. Optionally the table information can be added to each message.␊ - */␊ - tableName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing an iot hub data connection.␊ - */␊ - export interface IotHubDataConnection4 {␊ - kind: "IotHub"␊ - /**␊ - * Class representing the Kusto Iot hub connection properties.␊ - */␊ - properties?: (IotHubConnectionProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the Kusto Iot hub connection properties.␊ - */␊ - export interface IotHubConnectionProperties4 {␊ - /**␊ - * The iot hub consumer group.␊ - */␊ - consumerGroup: string␊ - /**␊ - * The data format of the message. Optionally the data format can be added to each message.␊ - */␊ - dataFormat?: (("MULTIJSON" | "JSON" | "CSV" | "TSV" | "SCSV" | "SOHSV" | "PSV" | "TXT" | "RAW" | "SINGLEJSON" | "AVRO" | "TSVE" | "PARQUET" | "ORC" | "APACHEAVRO" | "W3CLOGFILE") | string)␊ - /**␊ - * System properties of the iot hub␊ - */␊ - eventSystemProperties?: (string[] | string)␊ - /**␊ - * The resource ID of the Iot hub to be used to create a data connection.␊ - */␊ - iotHubResourceId: string␊ - /**␊ - * The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.␊ - */␊ - mappingRuleName?: string␊ - /**␊ - * The name of the share access policy␊ - */␊ - sharedAccessPolicyName: string␊ - /**␊ - * The table where the data should be ingested. Optionally the table information can be added to each message.␊ - */␊ - tableName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing an Event Grid data connection.␊ - */␊ - export interface EventGridDataConnection5 {␊ - kind: "EventGrid"␊ - /**␊ - * Class representing the Kusto event grid connection properties.␊ - */␊ - properties?: (EventGridConnectionProperties5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the Kusto event grid connection properties.␊ - */␊ - export interface EventGridConnectionProperties5 {␊ - /**␊ - * The name of blob storage event type to process.␊ - */␊ - blobStorageEventType?: (("Microsoft.Storage.BlobCreated" | "Microsoft.Storage.BlobRenamed") | string)␊ - /**␊ - * The event hub consumer group.␊ - */␊ - consumerGroup: string␊ - /**␊ - * The data format of the message. Optionally the data format can be added to each message.␊ - */␊ - dataFormat?: (("MULTIJSON" | "JSON" | "CSV" | "TSV" | "SCSV" | "SOHSV" | "PSV" | "TXT" | "RAW" | "SINGLEJSON" | "AVRO" | "TSVE" | "PARQUET" | "ORC" | "APACHEAVRO" | "W3CLOGFILE") | string)␊ - /**␊ - * The resource ID where the event grid is configured to send events.␊ - */␊ - eventHubResourceId: string␊ - /**␊ - * A Boolean value that, if set to true, indicates that ingestion should ignore the first record of every file␊ - */␊ - ignoreFirstRecord?: (boolean | string)␊ - /**␊ - * The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.␊ - */␊ - mappingRuleName?: string␊ - /**␊ - * The resource ID of the storage account where the data resides.␊ - */␊ - storageAccountResourceId: string␊ - /**␊ - * The table where the data should be ingested. Optionally the table information can be added to each message.␊ - */␊ - tableName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Kusto/clusters/attachedDatabaseConfigurations␊ - */␊ - export interface ClustersAttachedDatabaseConfigurations3 {␊ - apiVersion: "2020-06-14"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the attached database configuration.␊ - */␊ - name: string␊ - /**␊ - * Class representing the an attached database configuration properties of kind specific.␊ - */␊ - properties: (AttachedDatabaseConfigurationProperties3 | string)␊ - type: "Microsoft.Kusto/clusters/attachedDatabaseConfigurations"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Kusto/clusters/principalAssignments␊ - */␊ - export interface ClustersPrincipalAssignments2 {␊ - apiVersion: "2020-06-14"␊ - /**␊ - * The name of the Kusto principalAssignment.␊ - */␊ - name: string␊ - /**␊ - * A class representing cluster principal property.␊ - */␊ - properties: (ClusterPrincipalProperties2 | string)␊ - type: "Microsoft.Kusto/clusters/principalAssignments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Kusto/clusters/databases/principalAssignments␊ - */␊ - export interface ClustersDatabasesPrincipalAssignments2 {␊ - apiVersion: "2020-06-14"␊ - /**␊ - * The name of the Kusto principalAssignment.␊ - */␊ - name: string␊ - /**␊ - * A class representing database principal property.␊ - */␊ - properties: (DatabasePrincipalProperties2 | string)␊ - type: "Microsoft.Kusto/clusters/databases/principalAssignments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Kusto/clusters␊ - */␊ - export interface Clusters8 {␊ - apiVersion: "2020-09-18"␊ - /**␊ - * Identity for the resource.␊ - */␊ - identity?: (Identity5 | string)␊ - /**␊ - * The geo-location where the resource lives␊ - */␊ - location: string␊ - /**␊ - * The name of the Kusto cluster.␊ - */␊ - name: string␊ - /**␊ - * Class representing the Kusto cluster properties.␊ - */␊ - properties?: (ClusterProperties7 | string)␊ - resources?: (ClustersPrincipalAssignmentsChildResource3 | ClustersDatabasesChildResource7 | ClustersAttachedDatabaseConfigurationsChildResource4 | ClustersDataConnectionsChildResource3)[]␊ - /**␊ - * Azure SKU definition.␊ - */␊ - sku: (AzureSku8 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Kusto/clusters"␊ - /**␊ - * An array represents the availability zones of the cluster.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the resource.␊ - */␊ - export interface Identity5 {␊ - /**␊ - * The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove all identities.␊ - */␊ - type: (("None" | "SystemAssigned" | "UserAssigned" | "SystemAssigned, UserAssigned") | string)␊ - /**␊ - * The list of user identities associated with the Kusto cluster. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.␊ - */␊ - userAssignedIdentities?: ({␊ - [k: string]: Componentssgqdofschemasidentitypropertiesuserassignedidentitiesadditionalproperties4␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - export interface Componentssgqdofschemasidentitypropertiesuserassignedidentitiesadditionalproperties4 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the Kusto cluster properties.␊ - */␊ - export interface ClusterProperties7 {␊ - /**␊ - * A boolean value that indicates if the cluster's disks are encrypted.␊ - */␊ - enableDiskEncryption?: (boolean | string)␊ - /**␊ - * A boolean value that indicates if double encryption is enabled.␊ - */␊ - enableDoubleEncryption?: (boolean | string)␊ - /**␊ - * A boolean value that indicates if the purge operations are enabled.␊ - */␊ - enablePurge?: (boolean | string)␊ - /**␊ - * A boolean value that indicates if the streaming ingest is enabled.␊ - */␊ - enableStreamingIngest?: (boolean | string)␊ - /**␊ - * The engine type.␊ - */␊ - engineType?: (("V2" | "V3") | string)␊ - /**␊ - * Properties of the key vault.␊ - */␊ - keyVaultProperties?: (KeyVaultProperties4 | string)␊ - /**␊ - * A class that contains the optimized auto scale definition.␊ - */␊ - optimizedAutoscale?: (OptimizedAutoscale5 | string)␊ - /**␊ - * The cluster's external tenants.␊ - */␊ - trustedExternalTenants?: (TrustedExternalTenant7[] | string)␊ - /**␊ - * A class that contains virtual network definition.␊ - */␊ - virtualNetworkConfiguration?: (VirtualNetworkConfiguration5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the key vault.␊ - */␊ - export interface KeyVaultProperties4 {␊ - /**␊ - * The name of the key vault key.␊ - */␊ - keyName: string␊ - /**␊ - * The Uri of the key vault.␊ - */␊ - keyVaultUri: string␊ - /**␊ - * The version of the key vault key.␊ - */␊ - keyVersion?: string␊ - /**␊ - * The user assigned identity (ARM resource id) that has access to the key.␊ - */␊ - userIdentity?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A class that contains the optimized auto scale definition.␊ - */␊ - export interface OptimizedAutoscale5 {␊ - /**␊ - * A boolean value that indicate if the optimized autoscale feature is enabled or not.␊ - */␊ - isEnabled: (boolean | string)␊ - /**␊ - * Maximum allowed instances count.␊ - */␊ - maximum: (number | string)␊ - /**␊ - * Minimum allowed instances count.␊ - */␊ - minimum: (number | string)␊ - /**␊ - * The version of the template defined, for instance 1.␊ - */␊ - version: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents a tenant ID that is trusted by the cluster.␊ - */␊ - export interface TrustedExternalTenant7 {␊ - /**␊ - * GUID representing an external tenant.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A class that contains virtual network definition.␊ - */␊ - export interface VirtualNetworkConfiguration5 {␊ - /**␊ - * Data management's service public IP address resource id.␊ - */␊ - dataManagementPublicIpId: string␊ - /**␊ - * Engine service's public IP address resource id.␊ - */␊ - enginePublicIpId: string␊ - /**␊ - * The subnet resource id.␊ - */␊ - subnetId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Kusto/clusters/principalAssignments␊ - */␊ - export interface ClustersPrincipalAssignmentsChildResource3 {␊ - apiVersion: "2020-09-18"␊ - /**␊ - * The name of the Kusto principalAssignment.␊ - */␊ - name: string␊ - /**␊ - * A class representing cluster principal property.␊ - */␊ - properties: (ClusterPrincipalProperties3 | string)␊ - type: "principalAssignments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A class representing cluster principal property.␊ - */␊ - export interface ClusterPrincipalProperties3 {␊ - /**␊ - * The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name.␊ - */␊ - principalId: string␊ - /**␊ - * Principal type.␊ - */␊ - principalType: (("App" | "Group" | "User") | string)␊ - /**␊ - * Cluster principal role.␊ - */␊ - role: (("AllDatabasesAdmin" | "AllDatabasesViewer") | string)␊ - /**␊ - * The tenant id of the principal␊ - */␊ - tenantId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing a read write database.␊ - */␊ - export interface ReadWriteDatabase4 {␊ - kind: "ReadWrite"␊ - /**␊ - * Class representing the Kusto database properties.␊ - */␊ - properties?: (ReadWriteDatabaseProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the Kusto database properties.␊ - */␊ - export interface ReadWriteDatabaseProperties4 {␊ - /**␊ - * The time the data should be kept in cache for fast queries in TimeSpan.␊ - */␊ - hotCachePeriod?: string␊ - /**␊ - * The time the data should be kept before it stops being accessible to queries in TimeSpan.␊ - */␊ - softDeletePeriod?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing a read only following database.␊ - */␊ - export interface ReadOnlyFollowingDatabase4 {␊ - kind: "ReadOnlyFollowing"␊ - /**␊ - * Class representing the Kusto database properties.␊ - */␊ - properties?: (ReadOnlyFollowingDatabaseProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the Kusto database properties.␊ - */␊ - export interface ReadOnlyFollowingDatabaseProperties4 {␊ - /**␊ - * The time the data should be kept in cache for fast queries in TimeSpan.␊ - */␊ - hotCachePeriod?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Kusto/clusters/attachedDatabaseConfigurations␊ - */␊ - export interface ClustersAttachedDatabaseConfigurationsChildResource4 {␊ - apiVersion: "2020-09-18"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the attached database configuration.␊ - */␊ - name: string␊ - /**␊ - * Class representing the an attached database configuration properties of kind specific.␊ - */␊ - properties: (AttachedDatabaseConfigurationProperties4 | string)␊ - type: "attachedDatabaseConfigurations"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the an attached database configuration properties of kind specific.␊ - */␊ - export interface AttachedDatabaseConfigurationProperties4 {␊ - /**␊ - * The resource id of the cluster where the databases you would like to attach reside.␊ - */␊ - clusterResourceId: string␊ - /**␊ - * The name of the database which you would like to attach, use * if you want to follow all current and future databases.␊ - */␊ - databaseName: string␊ - /**␊ - * The default principals modification kind.␊ - */␊ - defaultPrincipalsModificationKind: (("Union" | "Replace" | "None") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the Geneva (GDS) data connection␊ - */␊ - export interface GenevaDataConnection3 {␊ - /**␊ - * Geneva (DGS) data connection properties␊ - */␊ - properties?: (GenevaDataConnectionProperties3 | string)␊ - kind: "Geneva"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the Kusto Geneva (GDS) connection properties.␊ - */␊ - export interface GenevaDataConnectionProperties3 {␊ - /**␊ - * The Geneva environment of the geneva data connection.␊ - */␊ - genevaEnvironment: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the Geneva legacy data connection.␊ - */␊ - export interface GenevaLegacyDataConnection3 {␊ - /**␊ - * Geneva legacy data connection properties.␊ - */␊ - properties?: (GenevaLegacyDataConnectionProperties3 | string)␊ - kind: "GenevaLegacy"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the Kusto Geneva legacy connection properties.␊ - */␊ - export interface GenevaLegacyDataConnectionProperties3 {␊ - /**␊ - * The Geneva environment of the geneva data connection.␊ - */␊ - genevaEnvironment: string␊ - /**␊ - * The list of mds accounts of the geneva data connection.␊ - */␊ - mdsAccounts: unknown[]␊ - /**␊ - * Indicates whether the data is scrubbed.␊ - */␊ - isScrubbed: boolean␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure SKU definition.␊ - */␊ - export interface AzureSku8 {␊ - /**␊ - * The number of instances of the cluster.␊ - */␊ - capacity?: (number | string)␊ - /**␊ - * SKU name.␊ - */␊ - name: (("Standard_DS13_v2+1TB_PS" | "Standard_DS13_v2+2TB_PS" | "Standard_DS14_v2+3TB_PS" | "Standard_DS14_v2+4TB_PS" | "Standard_D13_v2" | "Standard_D14_v2" | "Standard_L8s" | "Standard_L16s" | "Standard_D11_v2" | "Standard_D12_v2" | "Standard_L4s" | "Dev(No SLA)_Standard_D11_v2" | "Standard_E64i_v3" | "Standard_E2a_v4" | "Standard_E4a_v4" | "Standard_E8a_v4" | "Standard_E16a_v4" | "Standard_E8as_v4+1TB_PS" | "Standard_E8as_v4+2TB_PS" | "Standard_E16as_v4+3TB_PS" | "Standard_E16as_v4+4TB_PS" | "Dev(No SLA)_Standard_E2a_v4") | string)␊ - /**␊ - * SKU tier.␊ - */␊ - tier: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Kusto/clusters/databases/principalAssignments␊ - */␊ - export interface ClustersDatabasesPrincipalAssignmentsChildResource3 {␊ - apiVersion: "2020-09-18"␊ - /**␊ - * The name of the Kusto principalAssignment.␊ - */␊ - name: string␊ - /**␊ - * A class representing database principal property.␊ - */␊ - properties: (DatabasePrincipalProperties3 | string)␊ - type: "principalAssignments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A class representing database principal property.␊ - */␊ - export interface DatabasePrincipalProperties3 {␊ - /**␊ - * The principal ID assigned to the database principal. It can be a user email, application ID, or security group name.␊ - */␊ - principalId: string␊ - /**␊ - * Principal type.␊ - */␊ - principalType: (("App" | "Group" | "User") | string)␊ - /**␊ - * Database principal role.␊ - */␊ - role: (("Admin" | "Ingestor" | "Monitor" | "User" | "UnrestrictedViewers" | "Viewer") | string)␊ - /**␊ - * The tenant id of the principal␊ - */␊ - tenantId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing an event hub data connection.␊ - */␊ - export interface EventHubDataConnection6 {␊ - kind: "EventHub"␊ - /**␊ - * Class representing the Kusto event hub connection properties.␊ - */␊ - properties?: (EventHubConnectionProperties7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the Kusto event hub connection properties.␊ - */␊ - export interface EventHubConnectionProperties7 {␊ - /**␊ - * The event hub messages compression type.␊ - */␊ - compression?: (("None" | "GZip") | string)␊ - /**␊ - * The event hub consumer group.␊ - */␊ - consumerGroup: string␊ - /**␊ - * The data format of the message. Optionally the data format can be added to each message.␊ - */␊ - dataFormat?: (("MULTIJSON" | "JSON" | "CSV" | "TSV" | "SCSV" | "SOHSV" | "PSV" | "TXT" | "RAW" | "SINGLEJSON" | "AVRO" | "TSVE" | "PARQUET" | "ORC" | "APACHEAVRO" | "W3CLOGFILE") | string)␊ - /**␊ - * The resource ID of the event hub to be used to create a data connection.␊ - */␊ - eventHubResourceId: string␊ - /**␊ - * System properties of the event hub␊ - */␊ - eventSystemProperties?: (string[] | string)␊ - /**␊ - * The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.␊ - */␊ - mappingRuleName?: string␊ - /**␊ - * The table where the data should be ingested. Optionally the table information can be added to each message.␊ - */␊ - tableName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing an iot hub data connection.␊ - */␊ - export interface IotHubDataConnection5 {␊ - kind: "IotHub"␊ - /**␊ - * Class representing the Kusto Iot hub connection properties.␊ - */␊ - properties?: (IotHubConnectionProperties5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the Kusto Iot hub connection properties.␊ - */␊ - export interface IotHubConnectionProperties5 {␊ - /**␊ - * The iot hub consumer group.␊ - */␊ - consumerGroup: string␊ - /**␊ - * The data format of the message. Optionally the data format can be added to each message.␊ - */␊ - dataFormat?: (("MULTIJSON" | "JSON" | "CSV" | "TSV" | "SCSV" | "SOHSV" | "PSV" | "TXT" | "RAW" | "SINGLEJSON" | "AVRO" | "TSVE" | "PARQUET" | "ORC" | "APACHEAVRO" | "W3CLOGFILE") | string)␊ - /**␊ - * System properties of the iot hub␊ - */␊ - eventSystemProperties?: (string[] | string)␊ - /**␊ - * The resource ID of the Iot hub to be used to create a data connection.␊ - */␊ - iotHubResourceId: string␊ - /**␊ - * The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.␊ - */␊ - mappingRuleName?: string␊ - /**␊ - * The name of the share access policy␊ - */␊ - sharedAccessPolicyName: string␊ - /**␊ - * The table where the data should be ingested. Optionally the table information can be added to each message.␊ - */␊ - tableName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing an Event Grid data connection.␊ - */␊ - export interface EventGridDataConnection6 {␊ - kind: "EventGrid"␊ - /**␊ - * Class representing the Kusto event grid connection properties.␊ - */␊ - properties?: (EventGridConnectionProperties6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the Kusto event grid connection properties.␊ - */␊ - export interface EventGridConnectionProperties6 {␊ - /**␊ - * The name of blob storage event type to process.␊ - */␊ - blobStorageEventType?: (("Microsoft.Storage.BlobCreated" | "Microsoft.Storage.BlobRenamed") | string)␊ - /**␊ - * The event hub consumer group.␊ - */␊ - consumerGroup: string␊ - /**␊ - * The data format of the message. Optionally the data format can be added to each message.␊ - */␊ - dataFormat?: (("MULTIJSON" | "JSON" | "CSV" | "TSV" | "SCSV" | "SOHSV" | "PSV" | "TXT" | "RAW" | "SINGLEJSON" | "AVRO" | "TSVE" | "PARQUET" | "ORC" | "APACHEAVRO" | "W3CLOGFILE") | string)␊ - /**␊ - * The resource ID where the event grid is configured to send events.␊ - */␊ - eventHubResourceId: string␊ - /**␊ - * A Boolean value that, if set to true, indicates that ingestion should ignore the first record of every file␊ - */␊ - ignoreFirstRecord?: (boolean | string)␊ - /**␊ - * The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.␊ - */␊ - mappingRuleName?: string␊ - /**␊ - * The resource ID of the storage account where the data resides.␊ - */␊ - storageAccountResourceId: string␊ - /**␊ - * The table where the data should be ingested. Optionally the table information can be added to each message.␊ - */␊ - tableName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Kusto/clusters/attachedDatabaseConfigurations␊ - */␊ - export interface ClustersAttachedDatabaseConfigurations4 {␊ - apiVersion: "2020-09-18"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the attached database configuration.␊ - */␊ - name: string␊ - /**␊ - * Class representing the an attached database configuration properties of kind specific.␊ - */␊ - properties: (AttachedDatabaseConfigurationProperties4 | string)␊ - type: "Microsoft.Kusto/clusters/attachedDatabaseConfigurations"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Kusto/clusters/principalAssignments␊ - */␊ - export interface ClustersPrincipalAssignments3 {␊ - apiVersion: "2020-09-18"␊ - /**␊ - * The name of the Kusto principalAssignment.␊ - */␊ - name: string␊ - /**␊ - * A class representing cluster principal property.␊ - */␊ - properties: (ClusterPrincipalProperties3 | string)␊ - type: "Microsoft.Kusto/clusters/principalAssignments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Kusto/clusters/databases/principalAssignments␊ - */␊ - export interface ClustersDatabasesPrincipalAssignments3 {␊ - apiVersion: "2020-09-18"␊ - /**␊ - * The name of the Kusto principalAssignment.␊ - */␊ - name: string␊ - /**␊ - * A class representing database principal property.␊ - */␊ - properties: (DatabasePrincipalProperties3 | string)␊ - type: "Microsoft.Kusto/clusters/databases/principalAssignments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Redis cache resource␊ - */␊ - export interface Redis1 {␊ - type: "Microsoft.Cache/Redis"␊ - apiVersion: "2014-04-01-preview"␊ - properties: {␊ - /**␊ - * Microsoft.Cache/Redis: sku␊ - */␊ - sku: ({␊ - /**␊ - * Microsoft.Cache/Redis: sku/name␊ - */␊ - name: (("Basic" | "Standard") | string)␊ - /**␊ - * Microsoft.Cache/Redis: sku/size␊ - */␊ - family: ("C" | string)␊ - /**␊ - * Microsoft.Cache/Redis: sku/capacity␊ - */␊ - capacity: ((0 | 1 | 2 | 3 | 4 | 5 | 6) | string)␊ - [k: string]: unknown␊ - } | string)␊ - /**␊ - * Microsoft.Cache/Redis: version of Redis␊ - */␊ - redisVersion: ("2.8" | string)␊ - /**␊ - * Microsoft.Cache/Redis: maxMemoryPolicy. How Redis will select what to remove when maxmemory is reached. Default: VolatileLRU.␊ - */␊ - maxMemoryPolicy?: (string | ("VolatileLRU" | "AllKeysLRU" | "VolatileRandom" | "AllKeysRandom" | "VolatileTTL" | "NoEviction"))␊ - /**␊ - * Microsoft.Cache/Redis enableNonSslPort. Enables less secure direct access to redis on port 6379 WITHOUT SSL tunneling.␊ - */␊ - enableNonSslPort?: (boolean | string)␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.NotificationHubs/namespaces/notificationHubs␊ - */␊ - export interface NamespacesNotificationHubs {␊ - apiVersion: "2017-04-01"␊ - /**␊ - * Resource location␊ - */␊ - location?: string␊ - /**␊ - * The notification hub name.␊ - */␊ - name: string␊ - /**␊ - * NotificationHub properties.␊ - */␊ - properties: (NotificationHubProperties | string)␊ - resources?: NamespacesNotificationHubs_AuthorizationRulesChildResource[]␊ - /**␊ - * The Sku description for a namespace␊ - */␊ - sku?: (Sku10 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.NotificationHubs/namespaces/notificationHubs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NotificationHub properties.␊ - */␊ - export interface NotificationHubProperties {␊ - /**␊ - * Description of a NotificationHub AdmCredential.␊ - */␊ - admCredential?: (AdmCredential | string)␊ - /**␊ - * Description of a NotificationHub ApnsCredential.␊ - */␊ - apnsCredential?: (ApnsCredential | string)␊ - /**␊ - * The AuthorizationRules of the created NotificationHub␊ - */␊ - authorizationRules?: (SharedAccessAuthorizationRuleProperties[] | string)␊ - /**␊ - * Description of a NotificationHub BaiduCredential.␊ - */␊ - baiduCredential?: (BaiduCredential | string)␊ - /**␊ - * Description of a NotificationHub GcmCredential.␊ - */␊ - gcmCredential?: (GcmCredential | string)␊ - /**␊ - * Description of a NotificationHub MpnsCredential.␊ - */␊ - mpnsCredential?: (MpnsCredential | string)␊ - /**␊ - * The NotificationHub name.␊ - */␊ - name?: string␊ - /**␊ - * The RegistrationTtl of the created NotificationHub␊ - */␊ - registrationTtl?: string␊ - /**␊ - * Description of a NotificationHub WnsCredential.␊ - */␊ - wnsCredential?: (WnsCredential | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a NotificationHub AdmCredential.␊ - */␊ - export interface AdmCredential {␊ - /**␊ - * Description of a NotificationHub AdmCredential.␊ - */␊ - properties?: (AdmCredentialProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a NotificationHub AdmCredential.␊ - */␊ - export interface AdmCredentialProperties {␊ - /**␊ - * The URL of the authorization token.␊ - */␊ - authTokenUrl?: string␊ - /**␊ - * The client identifier.␊ - */␊ - clientId?: string␊ - /**␊ - * The credential secret access key.␊ - */␊ - clientSecret?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a NotificationHub ApnsCredential.␊ - */␊ - export interface ApnsCredential {␊ - /**␊ - * Description of a NotificationHub ApnsCredential. Note that there is no explicit switch between Certificate and Token Authentication Modes. The mode is determined based on the properties passed in.␊ - */␊ - properties?: (ApnsCredentialProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a NotificationHub ApnsCredential. Note that there is no explicit switch between Certificate and Token Authentication Modes. The mode is determined based on the properties passed in.␊ - */␊ - export interface ApnsCredentialProperties {␊ - /**␊ - * The APNS certificate. Specify if using Certificate Authentication Mode.␊ - */␊ - apnsCertificate?: string␊ - /**␊ - * The issuer (iss) registered claim key. The value is a 10-character TeamId, obtained from your developer account. Specify if using Token Authentication Mode.␊ - */␊ - appId?: string␊ - /**␊ - * The name of the application or BundleId. Specify if using Token Authentication Mode.␊ - */␊ - appName?: string␊ - /**␊ - * The APNS certificate password if it exists.␊ - */␊ - certificateKey?: string␊ - /**␊ - * The APNS endpoint of this credential. If using Certificate Authentication Mode and Sandbox specify 'gateway.sandbox.push.apple.com'. If using Certificate Authentication Mode and Production specify 'gateway.push.apple.com'. If using Token Authentication Mode and Sandbox specify 'https://api.development.push.apple.com:443/3/device'. If using Token Authentication Mode and Production specify 'https://api.push.apple.com:443/3/device'.␊ - */␊ - endpoint?: string␊ - /**␊ - * A 10-character key identifier (kid) key, obtained from your developer account. Specify if using Token Authentication Mode.␊ - */␊ - keyId?: string␊ - /**␊ - * The APNS certificate thumbprint. Specify if using Certificate Authentication Mode.␊ - */␊ - thumbprint?: string␊ - /**␊ - * Provider Authentication Token, obtained through your developer account. Specify if using Token Authentication Mode.␊ - */␊ - token?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SharedAccessAuthorizationRule properties.␊ - */␊ - export interface SharedAccessAuthorizationRuleProperties {␊ - /**␊ - * The rights associated with the rule.␊ - */␊ - rights?: (("Manage" | "Send" | "Listen")[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a NotificationHub BaiduCredential.␊ - */␊ - export interface BaiduCredential {␊ - /**␊ - * Description of a NotificationHub BaiduCredential.␊ - */␊ - properties?: (BaiduCredentialProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a NotificationHub BaiduCredential.␊ - */␊ - export interface BaiduCredentialProperties {␊ - /**␊ - * Baidu Api Key.␊ - */␊ - baiduApiKey?: string␊ - /**␊ - * Baidu Endpoint.␊ - */␊ - baiduEndPoint?: string␊ - /**␊ - * Baidu Secret Key␊ - */␊ - baiduSecretKey?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a NotificationHub GcmCredential.␊ - */␊ - export interface GcmCredential {␊ - /**␊ - * Description of a NotificationHub GcmCredential.␊ - */␊ - properties?: (GcmCredentialProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a NotificationHub GcmCredential.␊ - */␊ - export interface GcmCredentialProperties {␊ - /**␊ - * The FCM legacy endpoint. Default value is 'https://fcm.googleapis.com/fcm/send'␊ - */␊ - gcmEndpoint?: string␊ - /**␊ - * The Google API key.␊ - */␊ - googleApiKey?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a NotificationHub MpnsCredential.␊ - */␊ - export interface MpnsCredential {␊ - /**␊ - * Description of a NotificationHub MpnsCredential.␊ - */␊ - properties?: (MpnsCredentialProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a NotificationHub MpnsCredential.␊ - */␊ - export interface MpnsCredentialProperties {␊ - /**␊ - * The certificate key for this credential.␊ - */␊ - certificateKey?: string␊ - /**␊ - * The MPNS certificate.␊ - */␊ - mpnsCertificate?: string␊ - /**␊ - * The MPNS certificate Thumbprint␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a NotificationHub WnsCredential.␊ - */␊ - export interface WnsCredential {␊ - /**␊ - * Description of a NotificationHub WnsCredential.␊ - */␊ - properties?: (WnsCredentialProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a NotificationHub WnsCredential.␊ - */␊ - export interface WnsCredentialProperties {␊ - /**␊ - * The package ID for this credential.␊ - */␊ - packageSid?: string␊ - /**␊ - * The secret key.␊ - */␊ - secretKey?: string␊ - /**␊ - * The Windows Live endpoint.␊ - */␊ - windowsLiveEndpoint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.NotificationHubs/namespaces/notificationHubs/AuthorizationRules␊ - */␊ - export interface NamespacesNotificationHubs_AuthorizationRulesChildResource {␊ - apiVersion: "2017-04-01"␊ - /**␊ - * Authorization Rule Name.␊ - */␊ - name: string␊ - /**␊ - * SharedAccessAuthorizationRule properties.␊ - */␊ - properties: (SharedAccessAuthorizationRuleProperties | string)␊ - type: "AuthorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Sku description for a namespace␊ - */␊ - export interface Sku10 {␊ - /**␊ - * The capacity of the resource␊ - */␊ - capacity?: (number | string)␊ - /**␊ - * The Sku Family␊ - */␊ - family?: string␊ - /**␊ - * Name of the notification hub sku.␊ - */␊ - name: (("Free" | "Basic" | "Standard") | string)␊ - /**␊ - * The Sku size␊ - */␊ - size?: string␊ - /**␊ - * The tier of particular sku␊ - */␊ - tier?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.NotificationHubs/namespaces/notificationHubs/AuthorizationRules␊ - */␊ - export interface NamespacesNotificationHubs_AuthorizationRules {␊ - apiVersion: "2017-04-01"␊ - /**␊ - * Authorization Rule Name.␊ - */␊ - name: string␊ - /**␊ - * SharedAccessAuthorizationRule properties.␊ - */␊ - properties: (SharedAccessAuthorizationRuleProperties | string)␊ - type: "Microsoft.NotificationHubs/namespaces/notificationHubs/AuthorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Cache/Redis␊ - */␊ - export interface Redis2 {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the Redis cache.␊ - */␊ - name: string␊ - /**␊ - * Parameters supplied to CreateOrUpdate Redis operation.␊ - */␊ - properties: (RedisProperties | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Cache/Redis"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters supplied to CreateOrUpdate Redis operation.␊ - */␊ - export interface RedisProperties {␊ - /**␊ - * If the value is true, then the non-SLL Redis server port (6379) will be enabled.␊ - */␊ - enableNonSslPort?: (boolean | string)␊ - /**␊ - * All Redis Settings. Few possible keys: rdb-backup-enabled,rdb-storage-connection-string,rdb-backup-frequency,maxmemory-delta,maxmemory-policy,notify-keyspace-events,maxmemory-samples,slowlog-log-slower-than,slowlog-max-len,list-max-ziplist-entries,list-max-ziplist-value,hash-max-ziplist-entries,hash-max-ziplist-value,set-max-intset-entries,zset-max-ziplist-entries,zset-max-ziplist-value etc.␊ - */␊ - redisConfiguration?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * RedisVersion parameter has been deprecated. As such, it is no longer necessary to provide this parameter and any value specified is ignored.␊ - */␊ - redisVersion?: string␊ - /**␊ - * The number of shards to be created on a Premium Cluster Cache.␊ - */␊ - shardCount?: (number | string)␊ - /**␊ - * SKU parameters supplied to the create Redis operation.␊ - */␊ - sku: (Sku11 | string)␊ - /**␊ - * Required when deploying a Redis cache inside an existing Azure Virtual Network.␊ - */␊ - staticIP?: string␊ - /**␊ - * Required when deploying a Redis cache inside an existing Azure Virtual Network.␊ - */␊ - subnet?: string␊ - /**␊ - * tenantSettings␊ - */␊ - tenantSettings?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The exact ARM resource ID of the virtual network to deploy the Redis cache in. Example format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft.ClassicNetwork/VirtualNetworks/vnet1␊ - */␊ - virtualNetwork?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU parameters supplied to the create Redis operation.␊ - */␊ - export interface Sku11 {␊ - /**␊ - * What size of Redis cache to deploy. Valid values: for C family (0, 1, 2, 3, 4, 5, 6), for P family (1, 2, 3, 4).␊ - */␊ - capacity: (number | string)␊ - /**␊ - * Which family to use. Valid values: (C, P).␊ - */␊ - family: (("C" | "P") | string)␊ - /**␊ - * What type of Redis cache to deploy. Valid values: (Basic, Standard, Premium).␊ - */␊ - name: (("Basic" | "Standard" | "Premium") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An Azure Traffic Manager profile␊ - */␊ - export interface TrafficManagerProfiles {␊ - apiVersion: "2015-11-01"␊ - type: "Microsoft.Network/trafficManagerProfiles"␊ - location: "global"␊ - properties: {␊ - /**␊ - * The status of the profile (Enabled/Disabled)␊ - */␊ - profileStatus?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * The traffic routing method (Performance/Priority/Weighted␊ - */␊ - trafficRoutingMethod: (("Performance" | "Priority" | "Weighted") | string)␊ - /**␊ - * DNS configuration settings for the profile␊ - */␊ - dnsConfig: ({␊ - /**␊ - * Microsoft.Network/trafficManagerProfiles The DNS name for the profile, relative to the Traffic Manager DNS suffix␊ - */␊ - relativeName: string␊ - ttl: (number | string)␊ - fqdn?: string␊ - } | string)␊ - /**␊ - * Microsoft.Network/trafficManagerProfiles Configuration for monitoring (probing) of endpoints in this profile␊ - */␊ - monitorConfig: ({␊ - /**␊ - * Microsoft.Network/trafficManagerProfiles The protocol over which Traffic Manager will send monitoring requests␊ - */␊ - protocol: (("HTTP" | "HTTPS") | string)␊ - /**␊ - * Microsoft.Network/trafficManagerProfiles The port to which Traffic Manager will send monitoring requests␊ - */␊ - port: (number | string)␊ - /**␊ - * Microsoft.Network/trafficManagerProfiles The path (relative to the hostname of the endpoint) to which Traffic Manager will send monitoring requests␊ - */␊ - path: string␊ - } | string)␊ - /**␊ - * The endpoints over which this profile will route traffic␊ - */␊ - endpoints?: ({␊ - /**␊ - * Microsoft.Network/trafficManagerProfiles The name of the endpoint, must be unique within this profile. This is not the DNS name of the endpoint␊ - */␊ - name: string␊ - type: ("Microsoft.Network/trafficManagerProfiles/azureEndpoints" | "Microsoft.Network/trafficManagerProfiles/externalEndpoints" | "Microsoft.Network/trafficManagerProfiles/nestedEndpoints")␊ - properties: {␊ - endpointStatus?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Microsoft.Network/trafficManagerProfiles (not allowed for ExternalEndpoints) The ID of a Microsoft.Network/publicIpAddresses, Microsoft.ClassicCompute/domainNames resource (for AzureEndpoints) or a Microsoft.Network/trafficMaanagerProfiles resource (for NestedEndpoints)␊ - */␊ - targetResourceId?: string␊ - /**␊ - * Microsoft.Network/trafficManagerProfiles (only used for ExternalEndpoints) The DNS name of the endpoint␊ - */␊ - target?: string␊ - /**␊ - * Microsoft.Network/trafficManagerProfiles (only used with trafficRoutingMethod:Weighted) The weight of the endpoint␊ - */␊ - weight?: (number | string)␊ - /**␊ - * Microsoft.Network/trafficManagerProfiles (only used with trafficRoutingMethod:Priority) The priority of the endpoint␊ - */␊ - priority?: (number | string)␊ - /**␊ - * Microsoft.Network/trafficManagerProfiles (only used for ExternalEndpoints and NestedEndpoints) The location of the endpoint. One of the supported Microsoft Azure locations, except 'global'␊ - */␊ - endpointLocation?: string␊ - /**␊ - * Microsoft.Network/trafficManagerProfiles (only used for NestedEndpoints) The minimum number of endpoints in the child profile that need to be available in order for this endpoint to be considered available in the current profile.␊ - */␊ - minChildEndpoints?: (number | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }[] | string)␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An Azure Traffic Manager profile␊ - */␊ - export interface TrafficManagerProfiles1 {␊ - apiVersion: "2017-03-01"␊ - type: "Microsoft.Network/trafficManagerProfiles"␊ - location: "global"␊ - properties: {␊ - /**␊ - * The status of the profile (Enabled/Disabled)␊ - */␊ - profileStatus?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * The traffic routing method (Performance/Priority/Weighted/Geographic)␊ - */␊ - trafficRoutingMethod: (("Performance" | "Priority" | "Weighted" | "Geographic") | string)␊ - /**␊ - * DNS configuration settings for the profile␊ - */␊ - dnsConfig: ({␊ - /**␊ - * Microsoft.Network/trafficManagerProfiles The DNS name for the profile, relative to the Traffic Manager DNS suffix␊ - */␊ - relativeName: string␊ - ttl: (number | string)␊ - fqdn?: string␊ - } | string)␊ - /**␊ - * Microsoft.Network/trafficManagerProfiles Configuration for monitoring (probing) of endpoints in this profile␊ - */␊ - monitorConfig: ({␊ - /**␊ - * Microsoft.Network/trafficManagerProfiles The protocol over which Traffic Manager will send monitoring requests␊ - */␊ - protocol: (("HTTP" | "HTTPS") | string)␊ - /**␊ - * Microsoft.Network/trafficManagerProfiles The port to which Traffic Manager will send monitoring requests␊ - */␊ - port: (number | string)␊ - /**␊ - * Microsoft.Network/trafficManagerProfiles The path (relative to the hostname of the endpoint) to which Traffic Manager will send monitoring requests␊ - */␊ - path: string␊ - } | string)␊ - /**␊ - * The endpoints over which this profile will route traffic␊ - */␊ - endpoints?: ({␊ - /**␊ - * Microsoft.Network/trafficManagerProfiles The name of the endpoint, must be unique within this profile. This is not the DNS name of the endpoint␊ - */␊ - name: string␊ - type: ("Microsoft.Network/trafficManagerProfiles/azureEndpoints" | "Microsoft.Network/trafficManagerProfiles/externalEndpoints" | "Microsoft.Network/trafficManagerProfiles/nestedEndpoints")␊ - properties: {␊ - endpointStatus?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Microsoft.Network/trafficManagerProfiles (not allowed for ExternalEndpoints) The ID of a Microsoft.Network/publicIpAddresses, Microsoft.ClassicCompute/domainNames resource (for AzureEndpoints) or a Microsoft.Network/trafficMaanagerProfiles resource (for NestedEndpoints)␊ - */␊ - targetResourceId?: string␊ - /**␊ - * Microsoft.Network/trafficManagerProfiles (only used for ExternalEndpoints) The DNS name of the endpoint␊ - */␊ - target?: string␊ - /**␊ - * Microsoft.Network/trafficManagerProfiles (only used with trafficRoutingMethod:Weighted) The weight of the endpoint␊ - */␊ - weight?: (number | string)␊ - /**␊ - * Microsoft.Network/trafficManagerProfiles (only used with trafficRoutingMethod:Priority) The priority of the endpoint␊ - */␊ - priority?: (number | string)␊ - /**␊ - * Microsoft.Network/trafficManagerProfiles (only used for ExternalEndpoints and NestedEndpoints) The location of the endpoint. One of the supported Microsoft Azure locations, except 'global'␊ - */␊ - endpointLocation?: string␊ - /**␊ - * Microsoft.Network/trafficManagerProfiles (only used for NestedEndpoints) The minimum number of endpoints in the child profile that need to be available in order for this endpoint to be considered available in the current profile.␊ - */␊ - minChildEndpoints?: (number | string)␊ - /**␊ - * Microsoft.Network/trafficManagerProfiles (only used with trafficRoutingMethod:Geographic) the list of regions mapped to this endpoint. Please consult Traffic Manager Geographic documentation for a full list of accepted values.␊ - */␊ - geoMapping?: string[]␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }[] | string)␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An Azure Traffic Manager profile␊ - */␊ - export interface TrafficManagerProfiles2 {␊ - apiVersion: "2017-05-01"␊ - type: "Microsoft.Network/trafficManagerProfiles"␊ - location: "global"␊ - properties: {␊ - /**␊ - * The status of the profile (Enabled/Disabled)␊ - */␊ - profileStatus?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * The traffic routing method (Performance/Priority/Weighted/Geographic)␊ - */␊ - trafficRoutingMethod: (("Performance" | "Priority" | "Weighted" | "Geographic") | string)␊ - /**␊ - * DNS configuration settings for the profile␊ - */␊ - dnsConfig: ({␊ - /**␊ - * Microsoft.Network/trafficManagerProfiles The DNS name for the profile, relative to the Traffic Manager DNS suffix␊ - */␊ - relativeName: string␊ - ttl: (number | string)␊ - fqdn?: string␊ - } | string)␊ - /**␊ - * Microsoft.Network/trafficManagerProfiles Configuration for monitoring (probing) of endpoints in this profile␊ - */␊ - monitorConfig: ({␊ - /**␊ - * Microsoft.Network/trafficManagerProfiles The protocol over which Traffic Manager will send monitoring requests␊ - */␊ - protocol: (("HTTP" | "HTTPS" | "TCP") | string)␊ - /**␊ - * Microsoft.Network/trafficManagerProfiles The port to which Traffic Manager will send monitoring requests␊ - */␊ - port: (number | string)␊ - /**␊ - * Microsoft.Network/trafficManagerProfiles The path (relative to the hostname of the endpoint) to which Traffic Manager will send monitoring requests␊ - */␊ - path?: string␊ - /**␊ - * Microsoft.Network/trafficManagerProfiles The interval at which Traffic Manager will send monitoring requests to each endpoint in this profile␊ - */␊ - intervalInSeconds?: (number | string)␊ - /**␊ - * Microsoft.Network/trafficManagerProfiles The time that Traffic Manager allows endpoints in this profile to respond to monitoring requests.␊ - */␊ - timeoutInSeconds?: (number | string)␊ - /**␊ - * Microsoft.Network/trafficManagerProfiles The number of consecutive failed monitoring requests that Traffic Manager tolerates before declaring an endpoint in this profile Degraded after the next failed monitoring request␊ - */␊ - toleratedNumberOfFailures?: (number | string)␊ - } | string)␊ - /**␊ - * The endpoints over which this profile will route traffic␊ - */␊ - endpoints?: ({␊ - /**␊ - * Microsoft.Network/trafficManagerProfiles The name of the endpoint, must be unique within this profile. This is not the DNS name of the endpoint␊ - */␊ - name: string␊ - type: ("Microsoft.Network/trafficManagerProfiles/azureEndpoints" | "Microsoft.Network/trafficManagerProfiles/externalEndpoints" | "Microsoft.Network/trafficManagerProfiles/nestedEndpoints")␊ - properties: {␊ - endpointStatus?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Microsoft.Network/trafficManagerProfiles (not allowed for ExternalEndpoints) The ID of a Microsoft.Network/publicIpAddresses, Microsoft.ClassicCompute/domainNames resource (for AzureEndpoints) or a Microsoft.Network/trafficMaanagerProfiles resource (for NestedEndpoints)␊ - */␊ - targetResourceId?: string␊ - /**␊ - * Microsoft.Network/trafficManagerProfiles (only used for ExternalEndpoints) The DNS name of the endpoint␊ - */␊ - target?: string␊ - /**␊ - * Microsoft.Network/trafficManagerProfiles (only used with trafficRoutingMethod:Weighted) The weight of the endpoint␊ - */␊ - weight?: (number | string)␊ - /**␊ - * Microsoft.Network/trafficManagerProfiles (only used with trafficRoutingMethod:Priority) The priority of the endpoint␊ - */␊ - priority?: (number | string)␊ - /**␊ - * Microsoft.Network/trafficManagerProfiles (only used for ExternalEndpoints and NestedEndpoints) The location of the endpoint. One of the supported Microsoft Azure locations, except 'global'␊ - */␊ - endpointLocation?: string␊ - /**␊ - * Microsoft.Network/trafficManagerProfiles (only used for NestedEndpoints) The minimum number of endpoints in the child profile that need to be available in order for this endpoint to be considered available in the current profile.␊ - */␊ - minChildEndpoints?: (number | string)␊ - /**␊ - * Microsoft.Network/trafficManagerProfiles (only used with trafficRoutingMethod:Geographic) the list of regions mapped to this endpoint. Please consult Traffic Manager Geographic documentation for a full list of accepted values.␊ - */␊ - geoMapping?: string[]␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }[] | string)␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/trafficmanagerprofiles␊ - */␊ - export interface TrafficManagerProfiles3 {␊ - name: string␊ - type: "Microsoft.Network/trafficManagerProfiles"␊ - apiVersion: "2018-04-01"␊ - /**␊ - * Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}␊ - */␊ - id?: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The Azure Region where the resource lives␊ - */␊ - location?: string␊ - /**␊ - * The properties of the Traffic Manager profile.␊ - */␊ - properties: (ProfileProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the Traffic Manager profile properties.␊ - */␊ - export interface ProfileProperties1 {␊ - /**␊ - * The status of the Traffic Manager profile.␊ - */␊ - profileStatus?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * The traffic routing method of the Traffic Manager profile.␊ - */␊ - trafficRoutingMethod?: (("Performance" | "Priority" | "Weighted" | "Geographic" | "MultiValue" | "Subnet") | string)␊ - /**␊ - * The DNS settings of the Traffic Manager profile.␊ - */␊ - dnsConfig?: (DnsConfig | string)␊ - /**␊ - * The endpoint monitoring settings of the Traffic Manager profile.␊ - */␊ - monitorConfig?: (MonitorConfig | string)␊ - /**␊ - * The list of endpoints in the Traffic Manager profile.␊ - */␊ - endpoints?: (Endpoint1[] | string)␊ - /**␊ - * Indicates whether Traffic View is 'Enabled' or 'Disabled' for the Traffic Manager profile. Null, indicates 'Disabled'. Enabling this feature will increase the cost of the Traffic Manage profile.␊ - */␊ - trafficViewEnrollmentStatus?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Maximum number of endpoints to be returned for MultiValue routing type.␊ - */␊ - maxReturn?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class containing DNS settings in a Traffic Manager profile.␊ - */␊ - export interface DnsConfig {␊ - /**␊ - * The relative DNS name provided by this Traffic Manager profile. This value is combined with the DNS domain name used by Azure Traffic Manager to form the fully-qualified domain name (FQDN) of the profile.␊ - */␊ - relativeName?: string␊ - /**␊ - * The DNS Time-To-Live (TTL), in seconds. This informs the local DNS resolvers and DNS clients how long to cache DNS responses provided by this Traffic Manager profile.␊ - */␊ - ttl?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class containing endpoint monitoring settings in a Traffic Manager profile.␊ - */␊ - export interface MonitorConfig {␊ - /**␊ - * The profile-level monitoring status of the Traffic Manager profile.␊ - */␊ - profileMonitorStatus?: (("CheckingEndpoints" | "Online" | "Degraded" | "Disabled" | "Inactive") | string)␊ - /**␊ - * The protocol (HTTP, HTTPS or TCP) used to probe for endpoint health.␊ - */␊ - protocol?: (("HTTP" | "HTTPS" | "TCP") | string)␊ - /**␊ - * The TCP port used to probe for endpoint health.␊ - */␊ - port?: (number | string)␊ - /**␊ - * The path relative to the endpoint domain name used to probe for endpoint health.␊ - */␊ - path?: string␊ - /**␊ - * The monitor interval for endpoints in this profile. This is the interval at which Traffic Manager will check the health of each endpoint in this profile.␊ - */␊ - intervalInSeconds?: (number | string)␊ - /**␊ - * The monitor timeout for endpoints in this profile. This is the time that Traffic Manager allows endpoints in this profile to response to the health check.␊ - */␊ - timeoutInSeconds?: (number | string)␊ - /**␊ - * The number of consecutive failed health check that Traffic Manager tolerates before declaring an endpoint in this profile Degraded after the next failed health check.␊ - */␊ - toleratedNumberOfFailures?: (number | string)␊ - /**␊ - * List of custom headers.␊ - */␊ - customHeaders?: (MonitorConfigCustomHeadersItem[] | string)␊ - /**␊ - * List of expected status code ranges.␊ - */␊ - expectedStatusCodeRanges?: (MonitorConfigExpectedStatusCodeRangesItem[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Custom header name and value.␊ - */␊ - export interface MonitorConfigCustomHeadersItem {␊ - /**␊ - * Header name.␊ - */␊ - name?: string␊ - /**␊ - * Header value.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Min and max value of a status code range.␊ - */␊ - export interface MonitorConfigExpectedStatusCodeRangesItem {␊ - /**␊ - * Min status code.␊ - */␊ - min?: (number | string)␊ - /**␊ - * Max status code.␊ - */␊ - max?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing a Traffic Manager endpoint.␊ - */␊ - export interface Endpoint1 {␊ - /**␊ - * Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}␊ - */␊ - id?: string␊ - /**␊ - * The name of the resource␊ - */␊ - name?: string␊ - /**␊ - * The type of the resource. Ex- Microsoft.Network/trafficmanagerProfiles.␊ - */␊ - type?: string␊ - /**␊ - * The properties of the Traffic Manager endpoint.␊ - */␊ - properties?: (EndpointProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing a Traffic Manager endpoint properties.␊ - */␊ - export interface EndpointProperties {␊ - /**␊ - * The Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'.␊ - */␊ - targetResourceId?: string␊ - /**␊ - * The fully-qualified DNS name or IP address of the endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint.␊ - */␊ - target?: string␊ - /**␊ - * The status of the endpoint. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method.␊ - */␊ - endpointStatus?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * The weight of this endpoint when using the 'Weighted' traffic routing method. Possible values are from 1 to 1000.␊ - */␊ - weight?: (number | string)␊ - /**␊ - * The priority of this endpoint when using the 'Priority' traffic routing method. Possible values are from 1 to 1000, lower values represent higher priority. This is an optional parameter. If specified, it must be specified on all endpoints, and no two endpoints can share the same priority value.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * Specifies the location of the external or nested endpoints when using the 'Performance' traffic routing method.␊ - */␊ - endpointLocation?: string␊ - /**␊ - * The monitoring status of the endpoint.␊ - */␊ - endpointMonitorStatus?: (("CheckingEndpoint" | "Online" | "Degraded" | "Disabled" | "Inactive" | "Stopped") | string)␊ - /**␊ - * The minimum number of endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type 'NestedEndpoints'.␊ - */␊ - minChildEndpoints?: (number | string)␊ - /**␊ - * The list of countries/regions mapped to this endpoint when using the 'Geographic' traffic routing method. Please consult Traffic Manager Geographic documentation for a full list of accepted values.␊ - */␊ - geoMapping?: (string[] | string)␊ - /**␊ - * The list of subnets, IP addresses, and/or address ranges mapped to this endpoint when using the 'Subnet' traffic routing method. An empty list will match all ranges not covered by other endpoints.␊ - */␊ - subnets?: (EndpointPropertiesSubnetsItem[] | string)␊ - /**␊ - * List of custom headers.␊ - */␊ - customHeaders?: (EndpointPropertiesCustomHeadersItem[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Subnet first address, scope, and/or last address.␊ - */␊ - export interface EndpointPropertiesSubnetsItem {␊ - /**␊ - * First address in the subnet.␊ - */␊ - first?: string␊ - /**␊ - * Last address in the subnet.␊ - */␊ - last?: string␊ - /**␊ - * Block size (number of leading bits in the subnet mask).␊ - */␊ - scope?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Custom header name and value.␊ - */␊ - export interface EndpointPropertiesCustomHeadersItem {␊ - /**␊ - * Header name.␊ - */␊ - name?: string␊ - /**␊ - * Header value.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts␊ - */␊ - export interface StorageAccounts {␊ - type: "Microsoft.Storage/storageAccounts"␊ - apiVersion: ("2015-05-01-preview" | "2015-06-15")␊ - properties: {␊ - /**␊ - * Microsoft.Storage/storageAccounts: The type of this account.␊ - */␊ - accountType: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts␊ - */␊ - export interface StorageAccounts1 {␊ - apiVersion: "2016-01-01"␊ - /**␊ - * Required. Indicates the type of storage account.␊ - */␊ - kind: (("Storage" | "BlobStorage") | string)␊ - /**␊ - * Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed.␊ - */␊ - location: string␊ - /**␊ - * 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.␊ - */␊ - name: string␊ - properties?: (StorageAccountPropertiesCreateParameters | string)␊ - /**␊ - * The SKU of the storage account.␊ - */␊ - sku: (Sku12 | string)␊ - /**␊ - * Gets or sets a list of key value pairs that describe the resource. These tags can be used for viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key with a length no greater than 128 characters and a value with a length no greater than 256 characters.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Storage/storageAccounts"␊ - [k: string]: unknown␊ - }␊ - export interface StorageAccountPropertiesCreateParameters {␊ - /**␊ - * Required for storage accounts where kind = BlobStorage. The access tier used for billing.␊ - */␊ - accessTier?: (("Hot" | "Cool") | string)␊ - /**␊ - * The custom domain assigned to this storage account. This can be set via Update.␊ - */␊ - customDomain?: (CustomDomain | string)␊ - /**␊ - * The encryption settings on the storage account.␊ - */␊ - encryption?: (Encryption | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The custom domain assigned to this storage account. This can be set via Update.␊ - */␊ - export interface CustomDomain {␊ - /**␊ - * Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source.␊ - */␊ - name: string␊ - /**␊ - * Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates.␊ - */␊ - useSubDomainName?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encryption settings on the storage account.␊ - */␊ - export interface Encryption {␊ - /**␊ - * The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage␊ - */␊ - keySource: ("Microsoft.Storage" | string)␊ - /**␊ - * A list of services that support encryption.␊ - */␊ - services?: (EncryptionServices | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A list of services that support encryption.␊ - */␊ - export interface EncryptionServices {␊ - /**␊ - * A service that allows server-side encryption to be used.␊ - */␊ - blob?: (EncryptionService | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A service that allows server-side encryption to be used.␊ - */␊ - export interface EncryptionService {␊ - /**␊ - * A boolean indicating whether or not the service encrypts the data as it is stored.␊ - */␊ - enabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The SKU of the storage account.␊ - */␊ - export interface Sku12 {␊ - /**␊ - * Gets or sets the sku name. Required for account creation; optional for update. Note that in older versions, sku name was called accountType.␊ - */␊ - name: (("Standard_LRS" | "Standard_GRS" | "Standard_RAGRS" | "Standard_ZRS" | "Premium_LRS") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts␊ - */␊ - export interface StorageAccounts2 {␊ - apiVersion: "2017-06-01"␊ - /**␊ - * Identity for the resource.␊ - */␊ - identity?: (Identity6 | string)␊ - /**␊ - * Required. Indicates the type of storage account.␊ - */␊ - kind: (("Storage" | "BlobStorage") | string)␊ - /**␊ - * Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed.␊ - */␊ - location: string␊ - /**␊ - * 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.␊ - */␊ - name: string␊ - /**␊ - * The parameters used to create the storage account.␊ - */␊ - properties?: (StorageAccountPropertiesCreateParameters1 | string)␊ - /**␊ - * The SKU of the storage account.␊ - */␊ - sku: (Sku13 | string)␊ - /**␊ - * Gets or sets a list of key value pairs that describe the resource. These tags can be used for viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key with a length no greater than 128 characters and a value with a length no greater than 256 characters.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Storage/storageAccounts"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the resource.␊ - */␊ - export interface Identity6 {␊ - /**␊ - * The identity type.␊ - */␊ - type: ("SystemAssigned" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The parameters used to create the storage account.␊ - */␊ - export interface StorageAccountPropertiesCreateParameters1 {␊ - /**␊ - * Required for storage accounts where kind = BlobStorage. The access tier used for billing.␊ - */␊ - accessTier?: (("Hot" | "Cool") | string)␊ - /**␊ - * The custom domain assigned to this storage account. This can be set via Update.␊ - */␊ - customDomain?: (CustomDomain1 | string)␊ - /**␊ - * The encryption settings on the storage account.␊ - */␊ - encryption?: (Encryption1 | string)␊ - /**␊ - * Network rule set␊ - */␊ - networkAcls?: (NetworkRuleSet4 | string)␊ - /**␊ - * Allows https traffic only to storage service if sets to true.␊ - */␊ - supportsHttpsTrafficOnly?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The custom domain assigned to this storage account. This can be set via Update.␊ - */␊ - export interface CustomDomain1 {␊ - /**␊ - * Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source.␊ - */␊ - name: string␊ - /**␊ - * Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates.␊ - */␊ - useSubDomainName?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encryption settings on the storage account.␊ - */␊ - export interface Encryption1 {␊ - /**␊ - * The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault.␊ - */␊ - keySource: (("Microsoft.Storage" | "Microsoft.Keyvault") | string)␊ - /**␊ - * Properties of key vault.␊ - */␊ - keyvaultproperties?: (KeyVaultProperties5 | string)␊ - /**␊ - * A list of services that support encryption.␊ - */␊ - services?: (EncryptionServices1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of key vault.␊ - */␊ - export interface KeyVaultProperties5 {␊ - /**␊ - * The name of KeyVault key.␊ - */␊ - keyname?: string␊ - /**␊ - * The Uri of KeyVault.␊ - */␊ - keyvaulturi?: string␊ - /**␊ - * The version of KeyVault key.␊ - */␊ - keyversion?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A list of services that support encryption.␊ - */␊ - export interface EncryptionServices1 {␊ - /**␊ - * A service that allows server-side encryption to be used.␊ - */␊ - blob?: (EncryptionService1 | string)␊ - /**␊ - * A service that allows server-side encryption to be used.␊ - */␊ - file?: (EncryptionService1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A service that allows server-side encryption to be used.␊ - */␊ - export interface EncryptionService1 {␊ - /**␊ - * A boolean indicating whether or not the service encrypts the data as it is stored.␊ - */␊ - enabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network rule set␊ - */␊ - export interface NetworkRuleSet4 {␊ - /**␊ - * Specifies whether traffic is bypassed for Logging/Metrics/AzureServices. Possible values are any combination of Logging|Metrics|AzureServices (For example, "Logging, Metrics"), or None to bypass none of those traffics.␊ - */␊ - bypass?: (("None" | "Logging" | "Metrics" | "AzureServices") | string)␊ - /**␊ - * Specifies the default action of allow or deny when no other rules match.␊ - */␊ - defaultAction: (("Allow" | "Deny") | string)␊ - /**␊ - * Sets the IP ACL rules␊ - */␊ - ipRules?: (IPRule4[] | string)␊ - /**␊ - * Sets the virtual network rules␊ - */␊ - virtualNetworkRules?: (VirtualNetworkRule5[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP rule with specific IP or IP range in CIDR format.␊ - */␊ - export interface IPRule4 {␊ - /**␊ - * The action of IP ACL rule.␊ - */␊ - action?: ("Allow" | string)␊ - /**␊ - * Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed.␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Virtual Network rule.␊ - */␊ - export interface VirtualNetworkRule5 {␊ - /**␊ - * The action of virtual network rule.␊ - */␊ - action?: ("Allow" | string)␊ - /**␊ - * Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}.␊ - */␊ - id: string␊ - /**␊ - * Gets the state of virtual network rule.␊ - */␊ - state?: (("provisioning" | "deprovisioning" | "succeeded" | "failed" | "networkSourceDeleted") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The SKU of the storage account.␊ - */␊ - export interface Sku13 {␊ - /**␊ - * Gets or sets the sku name. Required for account creation; optional for update. Note that in older versions, sku name was called accountType.␊ - */␊ - name: (("Standard_LRS" | "Standard_GRS" | "Standard_RAGRS" | "Standard_ZRS" | "Premium_LRS") | string)␊ - /**␊ - * The restrictions because of which SKU cannot be used. This is empty if there are no restrictions.␊ - */␊ - restrictions?: (Restriction[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The restriction because of which SKU cannot be used.␊ - */␊ - export interface Restriction {␊ - /**␊ - * The reason for the restriction. As of now this can be "QuotaId" or "NotAvailableForSubscription". Quota Id is set when the SKU has requiredQuotas parameter as the subscription does not belong to that quota. The "NotAvailableForSubscription" is related to capacity at DC.␊ - */␊ - reasonCode?: (("QuotaId" | "NotAvailableForSubscription") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts␊ - */␊ - export interface StorageAccounts3 {␊ - apiVersion: "2017-10-01"␊ - /**␊ - * Identity for the resource.␊ - */␊ - identity?: (Identity7 | string)␊ - /**␊ - * Required. Indicates the type of storage account.␊ - */␊ - kind: (("Storage" | "StorageV2" | "BlobStorage") | string)␊ - /**␊ - * Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed.␊ - */␊ - location: string␊ - /**␊ - * 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.␊ - */␊ - name: string␊ - /**␊ - * The parameters used to create the storage account.␊ - */␊ - properties?: (StorageAccountPropertiesCreateParameters2 | string)␊ - /**␊ - * The SKU of the storage account.␊ - */␊ - sku: (Sku14 | string)␊ - /**␊ - * Gets or sets a list of key value pairs that describe the resource. These tags can be used for viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key with a length no greater than 128 characters and a value with a length no greater than 256 characters.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Storage/storageAccounts"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the resource.␊ - */␊ - export interface Identity7 {␊ - /**␊ - * The identity type.␊ - */␊ - type: ("SystemAssigned" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The parameters used to create the storage account.␊ - */␊ - export interface StorageAccountPropertiesCreateParameters2 {␊ - /**␊ - * Required for storage accounts where kind = BlobStorage. The access tier used for billing.␊ - */␊ - accessTier?: (("Hot" | "Cool") | string)␊ - /**␊ - * The custom domain assigned to this storage account. This can be set via Update.␊ - */␊ - customDomain?: (CustomDomain2 | string)␊ - /**␊ - * The encryption settings on the storage account.␊ - */␊ - encryption?: (Encryption2 | string)␊ - /**␊ - * Network rule set␊ - */␊ - networkAcls?: (NetworkRuleSet5 | string)␊ - /**␊ - * Allows https traffic only to storage service if sets to true.␊ - */␊ - supportsHttpsTrafficOnly?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The custom domain assigned to this storage account. This can be set via Update.␊ - */␊ - export interface CustomDomain2 {␊ - /**␊ - * Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source.␊ - */␊ - name: string␊ - /**␊ - * Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates.␊ - */␊ - useSubDomainName?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encryption settings on the storage account.␊ - */␊ - export interface Encryption2 {␊ - /**␊ - * The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault.␊ - */␊ - keySource: (("Microsoft.Storage" | "Microsoft.Keyvault") | string)␊ - /**␊ - * Properties of key vault.␊ - */␊ - keyvaultproperties?: (KeyVaultProperties6 | string)␊ - /**␊ - * A list of services that support encryption.␊ - */␊ - services?: (EncryptionServices2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of key vault.␊ - */␊ - export interface KeyVaultProperties6 {␊ - /**␊ - * The name of KeyVault key.␊ - */␊ - keyname?: string␊ - /**␊ - * The Uri of KeyVault.␊ - */␊ - keyvaulturi?: string␊ - /**␊ - * The version of KeyVault key.␊ - */␊ - keyversion?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A list of services that support encryption.␊ - */␊ - export interface EncryptionServices2 {␊ - /**␊ - * A service that allows server-side encryption to be used.␊ - */␊ - blob?: (EncryptionService2 | string)␊ - /**␊ - * A service that allows server-side encryption to be used.␊ - */␊ - file?: (EncryptionService2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A service that allows server-side encryption to be used.␊ - */␊ - export interface EncryptionService2 {␊ - /**␊ - * A boolean indicating whether or not the service encrypts the data as it is stored.␊ - */␊ - enabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network rule set␊ - */␊ - export interface NetworkRuleSet5 {␊ - /**␊ - * Specifies whether traffic is bypassed for Logging/Metrics/AzureServices. Possible values are any combination of Logging|Metrics|AzureServices (For example, "Logging, Metrics"), or None to bypass none of those traffics.␊ - */␊ - bypass?: (("None" | "Logging" | "Metrics" | "AzureServices") | string)␊ - /**␊ - * Specifies the default action of allow or deny when no other rules match.␊ - */␊ - defaultAction: (("Allow" | "Deny") | string)␊ - /**␊ - * Sets the IP ACL rules␊ - */␊ - ipRules?: (IPRule5[] | string)␊ - /**␊ - * Sets the virtual network rules␊ - */␊ - virtualNetworkRules?: (VirtualNetworkRule6[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP rule with specific IP or IP range in CIDR format.␊ - */␊ - export interface IPRule5 {␊ - /**␊ - * The action of IP ACL rule.␊ - */␊ - action?: ("Allow" | string)␊ - /**␊ - * Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed.␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Virtual Network rule.␊ - */␊ - export interface VirtualNetworkRule6 {␊ - /**␊ - * The action of virtual network rule.␊ - */␊ - action?: ("Allow" | string)␊ - /**␊ - * Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}.␊ - */␊ - id: string␊ - /**␊ - * Gets the state of virtual network rule.␊ - */␊ - state?: (("provisioning" | "deprovisioning" | "succeeded" | "failed" | "networkSourceDeleted") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The SKU of the storage account.␊ - */␊ - export interface Sku14 {␊ - /**␊ - * Gets or sets the sku name. Required for account creation; optional for update. Note that in older versions, sku name was called accountType.␊ - */␊ - name: (("Standard_LRS" | "Standard_GRS" | "Standard_RAGRS" | "Standard_ZRS" | "Premium_LRS") | string)␊ - /**␊ - * The restrictions because of which SKU cannot be used. This is empty if there are no restrictions.␊ - */␊ - restrictions?: (Restriction1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The restriction because of which SKU cannot be used.␊ - */␊ - export interface Restriction1 {␊ - /**␊ - * The reason for the restriction. As of now this can be "QuotaId" or "NotAvailableForSubscription". Quota Id is set when the SKU has requiredQuotas parameter as the subscription does not belong to that quota. The "NotAvailableForSubscription" is related to capacity at DC.␊ - */␊ - reasonCode?: (("QuotaId" | "NotAvailableForSubscription") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts␊ - */␊ - export interface StorageAccounts4 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Identity for the resource.␊ - */␊ - identity?: (Identity8 | string)␊ - /**␊ - * Required. Indicates the type of storage account.␊ - */␊ - kind: (("Storage" | "StorageV2" | "BlobStorage") | string)␊ - /**␊ - * Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed.␊ - */␊ - location: string␊ - /**␊ - * 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.␊ - */␊ - name: string␊ - /**␊ - * The parameters used to create the storage account.␊ - */␊ - properties?: (StorageAccountPropertiesCreateParameters3 | string)␊ - /**␊ - * The SKU of the storage account.␊ - */␊ - sku: (Sku15 | string)␊ - /**␊ - * Gets or sets a list of key value pairs that describe the resource. These tags can be used for viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key with a length no greater than 128 characters and a value with a length no greater than 256 characters.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Storage/storageAccounts"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the resource.␊ - */␊ - export interface Identity8 {␊ - /**␊ - * The identity type.␊ - */␊ - type: ("SystemAssigned" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The parameters used to create the storage account.␊ - */␊ - export interface StorageAccountPropertiesCreateParameters3 {␊ - /**␊ - * Required for storage accounts where kind = BlobStorage. The access tier used for billing.␊ - */␊ - accessTier?: (("Hot" | "Cool") | string)␊ - /**␊ - * The custom domain assigned to this storage account. This can be set via Update.␊ - */␊ - customDomain?: (CustomDomain3 | string)␊ - /**␊ - * The encryption settings on the storage account.␊ - */␊ - encryption?: (Encryption3 | string)␊ - /**␊ - * Account HierarchicalNamespace enabled if sets to true.␊ - */␊ - isHnsEnabled?: (boolean | string)␊ - /**␊ - * Network rule set␊ - */␊ - networkAcls?: (NetworkRuleSet6 | string)␊ - /**␊ - * Allows https traffic only to storage service if sets to true.␊ - */␊ - supportsHttpsTrafficOnly?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The custom domain assigned to this storage account. This can be set via Update.␊ - */␊ - export interface CustomDomain3 {␊ - /**␊ - * Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source.␊ - */␊ - name: string␊ - /**␊ - * Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates.␊ - */␊ - useSubDomainName?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encryption settings on the storage account.␊ - */␊ - export interface Encryption3 {␊ - /**␊ - * The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault.␊ - */␊ - keySource: (("Microsoft.Storage" | "Microsoft.Keyvault") | string)␊ - /**␊ - * Properties of key vault.␊ - */␊ - keyvaultproperties?: (KeyVaultProperties7 | string)␊ - /**␊ - * A list of services that support encryption.␊ - */␊ - services?: (EncryptionServices3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of key vault.␊ - */␊ - export interface KeyVaultProperties7 {␊ - /**␊ - * The name of KeyVault key.␊ - */␊ - keyname?: string␊ - /**␊ - * The Uri of KeyVault.␊ - */␊ - keyvaulturi?: string␊ - /**␊ - * The version of KeyVault key.␊ - */␊ - keyversion?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A list of services that support encryption.␊ - */␊ - export interface EncryptionServices3 {␊ - /**␊ - * A service that allows server-side encryption to be used.␊ - */␊ - blob?: (EncryptionService3 | string)␊ - /**␊ - * A service that allows server-side encryption to be used.␊ - */␊ - file?: (EncryptionService3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A service that allows server-side encryption to be used.␊ - */␊ - export interface EncryptionService3 {␊ - /**␊ - * A boolean indicating whether or not the service encrypts the data as it is stored.␊ - */␊ - enabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network rule set␊ - */␊ - export interface NetworkRuleSet6 {␊ - /**␊ - * Specifies whether traffic is bypassed for Logging/Metrics/AzureServices. Possible values are any combination of Logging|Metrics|AzureServices (For example, "Logging, Metrics"), or None to bypass none of those traffics.␊ - */␊ - bypass?: (("None" | "Logging" | "Metrics" | "AzureServices") | string)␊ - /**␊ - * Specifies the default action of allow or deny when no other rules match.␊ - */␊ - defaultAction: (("Allow" | "Deny") | string)␊ - /**␊ - * Sets the IP ACL rules␊ - */␊ - ipRules?: (IPRule6[] | string)␊ - /**␊ - * Sets the virtual network rules␊ - */␊ - virtualNetworkRules?: (VirtualNetworkRule7[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP rule with specific IP or IP range in CIDR format.␊ - */␊ - export interface IPRule6 {␊ - /**␊ - * The action of IP ACL rule.␊ - */␊ - action?: ("Allow" | string)␊ - /**␊ - * Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed.␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Virtual Network rule.␊ - */␊ - export interface VirtualNetworkRule7 {␊ - /**␊ - * The action of virtual network rule.␊ - */␊ - action?: ("Allow" | string)␊ - /**␊ - * Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}.␊ - */␊ - id: string␊ - /**␊ - * Gets the state of virtual network rule.␊ - */␊ - state?: (("provisioning" | "deprovisioning" | "succeeded" | "failed" | "networkSourceDeleted") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The SKU of the storage account.␊ - */␊ - export interface Sku15 {␊ - /**␊ - * Gets or sets the sku name. Required for account creation; optional for update. Note that in older versions, sku name was called accountType.␊ - */␊ - name: (("Standard_LRS" | "Standard_GRS" | "Standard_RAGRS" | "Standard_ZRS" | "Premium_LRS") | string)␊ - /**␊ - * The restrictions because of which SKU cannot be used. This is empty if there are no restrictions.␊ - */␊ - restrictions?: (Restriction2[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The restriction because of which SKU cannot be used.␊ - */␊ - export interface Restriction2 {␊ - /**␊ - * The reason for the restriction. As of now this can be "QuotaId" or "NotAvailableForSubscription". Quota Id is set when the SKU has requiredQuotas parameter as the subscription does not belong to that quota. The "NotAvailableForSubscription" is related to capacity at DC.␊ - */␊ - reasonCode?: (("QuotaId" | "NotAvailableForSubscription") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/blobServices/containers␊ - */␊ - export interface StorageAccountsBlobServicesContainers {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * The name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.␊ - */␊ - name: string␊ - /**␊ - * The properties of a container.␊ - */␊ - properties?: (ContainerProperties | string)␊ - resources?: StorageAccountsBlobServicesContainersImmutabilityPoliciesChildResource[]␊ - type: "Microsoft.Storage/storageAccounts/blobServices/containers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a container.␊ - */␊ - export interface ContainerProperties {␊ - /**␊ - * A name-value pair to associate with the container as metadata.␊ - */␊ - metadata?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Specifies whether data in the container may be accessed publicly and the level of access.␊ - */␊ - publicAccess?: (("Container" | "Blob" | "None") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies␊ - */␊ - export interface StorageAccountsBlobServicesContainersImmutabilityPoliciesChildResource {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * The name of the blob container immutabilityPolicy within the specified storage account. ImmutabilityPolicy Name must be 'default'␊ - */␊ - name: "default"␊ - /**␊ - * The properties of an ImmutabilityPolicy of a blob container.␊ - */␊ - properties: (ImmutabilityPolicyProperty | string)␊ - type: "immutabilityPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of an ImmutabilityPolicy of a blob container.␊ - */␊ - export interface ImmutabilityPolicyProperty {␊ - /**␊ - * The immutability period for the blobs in the container since the policy creation, in days.␊ - */␊ - immutabilityPeriodSinceCreationInDays: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies␊ - */␊ - export interface StorageAccountsBlobServicesContainersImmutabilityPolicies {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * The name of the blob container immutabilityPolicy within the specified storage account. ImmutabilityPolicy Name must be 'default'␊ - */␊ - name: string␊ - /**␊ - * The properties of an ImmutabilityPolicy of a blob container.␊ - */␊ - properties?: (ImmutabilityPolicyProperty | string)␊ - type: "Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts␊ - */␊ - export interface StorageAccounts5 {␊ - apiVersion: "2018-03-01-preview"␊ - /**␊ - * Identity for the resource.␊ - */␊ - identity?: (Identity9 | string)␊ - /**␊ - * Required. Indicates the type of storage account.␊ - */␊ - kind: (("Storage" | "StorageV2" | "BlobStorage") | string)␊ - /**␊ - * Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed.␊ - */␊ - location: string␊ - /**␊ - * 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.␊ - */␊ - name: string␊ - /**␊ - * The parameters used to create the storage account.␊ - */␊ - properties?: (StorageAccountPropertiesCreateParameters4 | string)␊ - resources?: StorageAccountsManagementPoliciesChildResource[]␊ - /**␊ - * The SKU of the storage account.␊ - */␊ - sku: (Sku16 | string)␊ - /**␊ - * Gets or sets a list of key value pairs that describe the resource. These tags can be used for viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key with a length no greater than 128 characters and a value with a length no greater than 256 characters.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Storage/storageAccounts"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the resource.␊ - */␊ - export interface Identity9 {␊ - /**␊ - * The identity type.␊ - */␊ - type: ("SystemAssigned" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The parameters used to create the storage account.␊ - */␊ - export interface StorageAccountPropertiesCreateParameters4 {␊ - /**␊ - * Required for storage accounts where kind = BlobStorage. The access tier used for billing.␊ - */␊ - accessTier?: (("Hot" | "Cool") | string)␊ - /**␊ - * The custom domain assigned to this storage account. This can be set via Update.␊ - */␊ - customDomain?: (CustomDomain4 | string)␊ - /**␊ - * The encryption settings on the storage account.␊ - */␊ - encryption?: (Encryption4 | string)␊ - /**␊ - * Account HierarchicalNamespace enabled if sets to true.␊ - */␊ - isHnsEnabled?: (boolean | string)␊ - /**␊ - * Network rule set␊ - */␊ - networkAcls?: (NetworkRuleSet7 | string)␊ - /**␊ - * Allows https traffic only to storage service if sets to true.␊ - */␊ - supportsHttpsTrafficOnly?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The custom domain assigned to this storage account. This can be set via Update.␊ - */␊ - export interface CustomDomain4 {␊ - /**␊ - * Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source.␊ - */␊ - name: string␊ - /**␊ - * Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates.␊ - */␊ - useSubDomainName?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encryption settings on the storage account.␊ - */␊ - export interface Encryption4 {␊ - /**␊ - * The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault.␊ - */␊ - keySource: (("Microsoft.Storage" | "Microsoft.Keyvault") | string)␊ - /**␊ - * Properties of key vault.␊ - */␊ - keyvaultproperties?: (KeyVaultProperties8 | string)␊ - /**␊ - * A list of services that support encryption.␊ - */␊ - services?: (EncryptionServices4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of key vault.␊ - */␊ - export interface KeyVaultProperties8 {␊ - /**␊ - * The name of KeyVault key.␊ - */␊ - keyname?: string␊ - /**␊ - * The Uri of KeyVault.␊ - */␊ - keyvaulturi?: string␊ - /**␊ - * The version of KeyVault key.␊ - */␊ - keyversion?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A list of services that support encryption.␊ - */␊ - export interface EncryptionServices4 {␊ - /**␊ - * A service that allows server-side encryption to be used.␊ - */␊ - blob?: (EncryptionService4 | string)␊ - /**␊ - * A service that allows server-side encryption to be used.␊ - */␊ - file?: (EncryptionService4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A service that allows server-side encryption to be used.␊ - */␊ - export interface EncryptionService4 {␊ - /**␊ - * A boolean indicating whether or not the service encrypts the data as it is stored.␊ - */␊ - enabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network rule set␊ - */␊ - export interface NetworkRuleSet7 {␊ - /**␊ - * Specifies whether traffic is bypassed for Logging/Metrics/AzureServices. Possible values are any combination of Logging|Metrics|AzureServices (For example, "Logging, Metrics"), or None to bypass none of those traffics.␊ - */␊ - bypass?: (("None" | "Logging" | "Metrics" | "AzureServices") | string)␊ - /**␊ - * Specifies the default action of allow or deny when no other rules match.␊ - */␊ - defaultAction: (("Allow" | "Deny") | string)␊ - /**␊ - * Sets the IP ACL rules␊ - */␊ - ipRules?: (IPRule7[] | string)␊ - /**␊ - * Sets the virtual network rules␊ - */␊ - virtualNetworkRules?: (VirtualNetworkRule8[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP rule with specific IP or IP range in CIDR format.␊ - */␊ - export interface IPRule7 {␊ - /**␊ - * The action of IP ACL rule.␊ - */␊ - action?: ("Allow" | string)␊ - /**␊ - * Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed.␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Virtual Network rule.␊ - */␊ - export interface VirtualNetworkRule8 {␊ - /**␊ - * The action of virtual network rule.␊ - */␊ - action?: ("Allow" | string)␊ - /**␊ - * Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}.␊ - */␊ - id: string␊ - /**␊ - * Gets the state of virtual network rule.␊ - */␊ - state?: (("provisioning" | "deprovisioning" | "succeeded" | "failed" | "networkSourceDeleted") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/managementPolicies␊ - */␊ - export interface StorageAccountsManagementPoliciesChildResource {␊ - apiVersion: "2018-03-01-preview"␊ - /**␊ - * The name of the Storage Account Management Policy. It should always be 'default'␊ - */␊ - name: "default"␊ - /**␊ - * The Storage Account ManagementPolicies Rules, in JSON format. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts.␊ - */␊ - properties: (ManagementPoliciesRules | string)␊ - type: "managementPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Storage Account ManagementPolicies Rules, in JSON format. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts.␊ - */␊ - export interface ManagementPoliciesRules {␊ - /**␊ - * The Storage Account ManagementPolicies Rules, in JSON format. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts.␊ - */␊ - policy?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The SKU of the storage account.␊ - */␊ - export interface Sku16 {␊ - /**␊ - * Gets or sets the sku name. Required for account creation; optional for update. Note that in older versions, sku name was called accountType.␊ - */␊ - name: (("Standard_LRS" | "Standard_GRS" | "Standard_RAGRS" | "Standard_ZRS" | "Premium_LRS") | string)␊ - /**␊ - * The restrictions because of which SKU cannot be used. This is empty if there are no restrictions.␊ - */␊ - restrictions?: (Restriction3[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The restriction because of which SKU cannot be used.␊ - */␊ - export interface Restriction3 {␊ - /**␊ - * The reason for the restriction. As of now this can be "QuotaId" or "NotAvailableForSubscription". Quota Id is set when the SKU has requiredQuotas parameter as the subscription does not belong to that quota. The "NotAvailableForSubscription" is related to capacity at DC.␊ - */␊ - reasonCode?: (("QuotaId" | "NotAvailableForSubscription") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/managementPolicies␊ - */␊ - export interface StorageAccountsManagementPolicies {␊ - apiVersion: "2018-03-01-preview"␊ - /**␊ - * The name of the Storage Account Management Policy. It should always be 'default'␊ - */␊ - name: string␊ - /**␊ - * The Storage Account ManagementPolicies Rules, in JSON format. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts.␊ - */␊ - properties?: (ManagementPoliciesRules | string)␊ - type: "Microsoft.Storage/storageAccounts/managementPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/blobServices/containers␊ - */␊ - export interface StorageAccountsBlobServicesContainers1 {␊ - apiVersion: "2018-03-01-preview"␊ - /**␊ - * The name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.␊ - */␊ - name: string␊ - /**␊ - * The properties of a container.␊ - */␊ - properties?: (ContainerProperties1 | string)␊ - resources?: StorageAccountsBlobServicesContainersImmutabilityPoliciesChildResource1[]␊ - type: "Microsoft.Storage/storageAccounts/blobServices/containers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a container.␊ - */␊ - export interface ContainerProperties1 {␊ - /**␊ - * A name-value pair to associate with the container as metadata.␊ - */␊ - metadata?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Specifies whether data in the container may be accessed publicly and the level of access.␊ - */␊ - publicAccess?: (("Container" | "Blob" | "None") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies␊ - */␊ - export interface StorageAccountsBlobServicesContainersImmutabilityPoliciesChildResource1 {␊ - apiVersion: "2018-03-01-preview"␊ - /**␊ - * The name of the blob container immutabilityPolicy within the specified storage account. ImmutabilityPolicy Name must be 'default'␊ - */␊ - name: "default"␊ - /**␊ - * The properties of an ImmutabilityPolicy of a blob container.␊ - */␊ - properties: (ImmutabilityPolicyProperty1 | string)␊ - type: "immutabilityPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of an ImmutabilityPolicy of a blob container.␊ - */␊ - export interface ImmutabilityPolicyProperty1 {␊ - /**␊ - * The immutability period for the blobs in the container since the policy creation, in days.␊ - */␊ - immutabilityPeriodSinceCreationInDays: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies␊ - */␊ - export interface StorageAccountsBlobServicesContainersImmutabilityPolicies1 {␊ - apiVersion: "2018-03-01-preview"␊ - /**␊ - * The name of the blob container immutabilityPolicy within the specified storage account. ImmutabilityPolicy Name must be 'default'␊ - */␊ - name: string␊ - /**␊ - * The properties of an ImmutabilityPolicy of a blob container.␊ - */␊ - properties?: (ImmutabilityPolicyProperty1 | string)␊ - type: "Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts␊ - */␊ - export interface StorageAccounts6 {␊ - apiVersion: "2018-07-01"␊ - /**␊ - * Identity for the resource.␊ - */␊ - identity?: (Identity10 | string)␊ - /**␊ - * Required. Indicates the type of storage account.␊ - */␊ - kind: (("Storage" | "StorageV2" | "BlobStorage" | "FileStorage" | "BlockBlobStorage") | string)␊ - /**␊ - * Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed.␊ - */␊ - location: string␊ - /**␊ - * 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.␊ - */␊ - name: string␊ - /**␊ - * The parameters used to create the storage account.␊ - */␊ - properties?: (StorageAccountPropertiesCreateParameters5 | string)␊ - resources?: StorageAccountsBlobServicesChildResource[]␊ - /**␊ - * The SKU of the storage account.␊ - */␊ - sku: (Sku17 | string)␊ - /**␊ - * Gets or sets a list of key value pairs that describe the resource. These tags can be used for viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key with a length no greater than 128 characters and a value with a length no greater than 256 characters.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Storage/storageAccounts"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the resource.␊ - */␊ - export interface Identity10 {␊ - /**␊ - * The identity type.␊ - */␊ - type: ("SystemAssigned" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The parameters used to create the storage account.␊ - */␊ - export interface StorageAccountPropertiesCreateParameters5 {␊ - /**␊ - * Required for storage accounts where kind = BlobStorage. The access tier used for billing.␊ - */␊ - accessTier?: (("Hot" | "Cool") | string)␊ - /**␊ - * Enables Azure Files AAD Integration for SMB if sets to true.␊ - */␊ - azureFilesAadIntegration?: (boolean | string)␊ - /**␊ - * The custom domain assigned to this storage account. This can be set via Update.␊ - */␊ - customDomain?: (CustomDomain5 | string)␊ - /**␊ - * The encryption settings on the storage account.␊ - */␊ - encryption?: (Encryption5 | string)␊ - /**␊ - * Account HierarchicalNamespace enabled if sets to true.␊ - */␊ - isHnsEnabled?: (boolean | string)␊ - /**␊ - * Network rule set␊ - */␊ - networkAcls?: (NetworkRuleSet8 | string)␊ - /**␊ - * Allows https traffic only to storage service if sets to true.␊ - */␊ - supportsHttpsTrafficOnly?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The custom domain assigned to this storage account. This can be set via Update.␊ - */␊ - export interface CustomDomain5 {␊ - /**␊ - * Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source.␊ - */␊ - name: string␊ - /**␊ - * Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates.␊ - */␊ - useSubDomainName?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encryption settings on the storage account.␊ - */␊ - export interface Encryption5 {␊ - /**␊ - * The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault.␊ - */␊ - keySource: (("Microsoft.Storage" | "Microsoft.Keyvault") | string)␊ - /**␊ - * Properties of key vault.␊ - */␊ - keyvaultproperties?: (KeyVaultProperties9 | string)␊ - /**␊ - * A list of services that support encryption.␊ - */␊ - services?: (EncryptionServices5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of key vault.␊ - */␊ - export interface KeyVaultProperties9 {␊ - /**␊ - * The name of KeyVault key.␊ - */␊ - keyname?: string␊ - /**␊ - * The Uri of KeyVault.␊ - */␊ - keyvaulturi?: string␊ - /**␊ - * The version of KeyVault key.␊ - */␊ - keyversion?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A list of services that support encryption.␊ - */␊ - export interface EncryptionServices5 {␊ - /**␊ - * A service that allows server-side encryption to be used.␊ - */␊ - blob?: (EncryptionService5 | string)␊ - /**␊ - * A service that allows server-side encryption to be used.␊ - */␊ - file?: (EncryptionService5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A service that allows server-side encryption to be used.␊ - */␊ - export interface EncryptionService5 {␊ - /**␊ - * A boolean indicating whether or not the service encrypts the data as it is stored.␊ - */␊ - enabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network rule set␊ - */␊ - export interface NetworkRuleSet8 {␊ - /**␊ - * Specifies whether traffic is bypassed for Logging/Metrics/AzureServices. Possible values are any combination of Logging|Metrics|AzureServices (For example, "Logging, Metrics"), or None to bypass none of those traffics.␊ - */␊ - bypass?: (("None" | "Logging" | "Metrics" | "AzureServices") | string)␊ - /**␊ - * Specifies the default action of allow or deny when no other rules match.␊ - */␊ - defaultAction: (("Allow" | "Deny") | string)␊ - /**␊ - * Sets the IP ACL rules␊ - */␊ - ipRules?: (IPRule8[] | string)␊ - /**␊ - * Sets the virtual network rules␊ - */␊ - virtualNetworkRules?: (VirtualNetworkRule9[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP rule with specific IP or IP range in CIDR format.␊ - */␊ - export interface IPRule8 {␊ - /**␊ - * The action of IP ACL rule.␊ - */␊ - action?: ("Allow" | string)␊ - /**␊ - * Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed.␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Virtual Network rule.␊ - */␊ - export interface VirtualNetworkRule9 {␊ - /**␊ - * The action of virtual network rule.␊ - */␊ - action?: ("Allow" | string)␊ - /**␊ - * Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}.␊ - */␊ - id: string␊ - /**␊ - * Gets the state of virtual network rule.␊ - */␊ - state?: (("provisioning" | "deprovisioning" | "succeeded" | "failed" | "networkSourceDeleted") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/blobServices␊ - */␊ - export interface StorageAccountsBlobServicesChildResource {␊ - apiVersion: "2018-07-01"␊ - /**␊ - * The name of the blob Service within the specified storage account. Blob Service Name must be 'default'␊ - */␊ - name: "default"␊ - /**␊ - * The properties of a storage account’s Blob service.␊ - */␊ - properties: (BlobServicePropertiesProperties | string)␊ - type: "blobServices"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a storage account’s Blob service.␊ - */␊ - export interface BlobServicePropertiesProperties {␊ - /**␊ - * Sets the CORS rules. You can include up to five CorsRule elements in the request. ␊ - */␊ - cors?: (CorsRules | string)␊ - /**␊ - * DefaultServiceVersion indicates the default version to use for requests to the Blob service if an incoming request’s version is not specified. Possible values include version 2008-10-27 and all more recent versions.␊ - */␊ - defaultServiceVersion?: string␊ - /**␊ - * The blob service properties for soft delete.␊ - */␊ - deleteRetentionPolicy?: (DeleteRetentionPolicy | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Sets the CORS rules. You can include up to five CorsRule elements in the request. ␊ - */␊ - export interface CorsRules {␊ - /**␊ - * The List of CORS rules. You can include up to five CorsRule elements in the request. ␊ - */␊ - corsRules?: (CorsRule[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies a CORS rule for the Blob service.␊ - */␊ - export interface CorsRule {␊ - /**␊ - * Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request.␊ - */␊ - allowedHeaders: (string[] | string)␊ - /**␊ - * Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin.␊ - */␊ - allowedMethods: (("DELETE" | "GET" | "HEAD" | "MERGE" | "POST" | "OPTIONS" | "PUT")[] | string)␊ - /**␊ - * Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains␊ - */␊ - allowedOrigins: (string[] | string)␊ - /**␊ - * Required if CorsRule element is present. A list of response headers to expose to CORS clients.␊ - */␊ - exposedHeaders: (string[] | string)␊ - /**␊ - * Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response.␊ - */␊ - maxAgeInSeconds: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The blob service properties for soft delete.␊ - */␊ - export interface DeleteRetentionPolicy {␊ - /**␊ - * Indicates the number of days that the deleted blob should be retained. The minimum specified value can be 1 and the maximum value can be 365.␊ - */␊ - days?: (number | string)␊ - /**␊ - * Indicates whether DeleteRetentionPolicy is enabled for the Blob service.␊ - */␊ - enabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The SKU of the storage account.␊ - */␊ - export interface Sku17 {␊ - /**␊ - * Gets or sets the SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType.␊ - */␊ - name: (("Standard_LRS" | "Standard_GRS" | "Standard_RAGRS" | "Standard_ZRS" | "Premium_LRS" | "Premium_ZRS") | string)␊ - /**␊ - * The restrictions because of which SKU cannot be used. This is empty if there are no restrictions.␊ - */␊ - restrictions?: (Restriction4[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The restriction because of which SKU cannot be used.␊ - */␊ - export interface Restriction4 {␊ - /**␊ - * The reason for the restriction. As of now this can be "QuotaId" or "NotAvailableForSubscription". Quota Id is set when the SKU has requiredQuotas parameter as the subscription does not belong to that quota. The "NotAvailableForSubscription" is related to capacity at DC.␊ - */␊ - reasonCode?: (("QuotaId" | "NotAvailableForSubscription") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/blobServices␊ - */␊ - export interface StorageAccountsBlobServices {␊ - apiVersion: "2018-07-01"␊ - /**␊ - * The name of the blob Service within the specified storage account. Blob Service Name must be 'default'␊ - */␊ - name: string␊ - /**␊ - * The properties of a storage account’s Blob service.␊ - */␊ - properties?: (BlobServicePropertiesProperties | string)␊ - resources?: StorageAccountsBlobServicesContainersChildResource[]␊ - type: "Microsoft.Storage/storageAccounts/blobServices"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/blobServices/containers␊ - */␊ - export interface StorageAccountsBlobServicesContainersChildResource {␊ - apiVersion: "2018-07-01"␊ - /**␊ - * The name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.␊ - */␊ - name: string␊ - /**␊ - * The properties of a container.␊ - */␊ - properties: (ContainerProperties2 | string)␊ - type: "containers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a container.␊ - */␊ - export interface ContainerProperties2 {␊ - /**␊ - * A name-value pair to associate with the container as metadata.␊ - */␊ - metadata?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Specifies whether data in the container may be accessed publicly and the level of access.␊ - */␊ - publicAccess?: (("Container" | "Blob" | "None") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/blobServices/containers␊ - */␊ - export interface StorageAccountsBlobServicesContainers2 {␊ - apiVersion: "2018-07-01"␊ - /**␊ - * The name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.␊ - */␊ - name: string␊ - /**␊ - * The properties of a container.␊ - */␊ - properties?: (ContainerProperties2 | string)␊ - resources?: StorageAccountsBlobServicesContainersImmutabilityPoliciesChildResource2[]␊ - type: "Microsoft.Storage/storageAccounts/blobServices/containers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies␊ - */␊ - export interface StorageAccountsBlobServicesContainersImmutabilityPoliciesChildResource2 {␊ - apiVersion: "2018-07-01"␊ - /**␊ - * The name of the blob container immutabilityPolicy within the specified storage account. ImmutabilityPolicy Name must be 'default'␊ - */␊ - name: "default"␊ - /**␊ - * The properties of an ImmutabilityPolicy of a blob container.␊ - */␊ - properties: (ImmutabilityPolicyProperty2 | string)␊ - type: "immutabilityPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of an ImmutabilityPolicy of a blob container.␊ - */␊ - export interface ImmutabilityPolicyProperty2 {␊ - /**␊ - * The immutability period for the blobs in the container since the policy creation, in days.␊ - */␊ - immutabilityPeriodSinceCreationInDays: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies␊ - */␊ - export interface StorageAccountsBlobServicesContainersImmutabilityPolicies2 {␊ - apiVersion: "2018-07-01"␊ - /**␊ - * The name of the blob container immutabilityPolicy within the specified storage account. ImmutabilityPolicy Name must be 'default'␊ - */␊ - name: string␊ - /**␊ - * The properties of an ImmutabilityPolicy of a blob container.␊ - */␊ - properties?: (ImmutabilityPolicyProperty2 | string)␊ - type: "Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts␊ - */␊ - export interface StorageAccounts7 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Identity for the resource.␊ - */␊ - identity?: (Identity11 | string)␊ - /**␊ - * Required. Indicates the type of storage account.␊ - */␊ - kind: (("Storage" | "StorageV2" | "BlobStorage" | "FileStorage" | "BlockBlobStorage") | string)␊ - /**␊ - * Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed.␊ - */␊ - location: string␊ - /**␊ - * 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.␊ - */␊ - name: string␊ - /**␊ - * The parameters used to create the storage account.␊ - */␊ - properties?: (StorageAccountPropertiesCreateParameters6 | string)␊ - resources?: (StorageAccountsManagementPoliciesChildResource1 | StorageAccountsBlobServicesChildResource1)[]␊ - /**␊ - * The SKU of the storage account.␊ - */␊ - sku: (Sku18 | string)␊ - /**␊ - * Gets or sets a list of key value pairs that describe the resource. These tags can be used for viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key with a length no greater than 128 characters and a value with a length no greater than 256 characters.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Storage/storageAccounts"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the resource.␊ - */␊ - export interface Identity11 {␊ - /**␊ - * The identity type.␊ - */␊ - type: ("SystemAssigned" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The parameters used to create the storage account.␊ - */␊ - export interface StorageAccountPropertiesCreateParameters6 {␊ - /**␊ - * Required for storage accounts where kind = BlobStorage. The access tier used for billing.␊ - */␊ - accessTier?: (("Hot" | "Cool") | string)␊ - /**␊ - * Enables Azure Files AAD Integration for SMB if sets to true.␊ - */␊ - azureFilesAadIntegration?: (boolean | string)␊ - /**␊ - * The custom domain assigned to this storage account. This can be set via Update.␊ - */␊ - customDomain?: (CustomDomain6 | string)␊ - /**␊ - * The encryption settings on the storage account.␊ - */␊ - encryption?: (Encryption6 | string)␊ - /**␊ - * Account HierarchicalNamespace enabled if sets to true.␊ - */␊ - isHnsEnabled?: (boolean | string)␊ - /**␊ - * Network rule set␊ - */␊ - networkAcls?: (NetworkRuleSet9 | string)␊ - /**␊ - * Allows https traffic only to storage service if sets to true.␊ - */␊ - supportsHttpsTrafficOnly?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The custom domain assigned to this storage account. This can be set via Update.␊ - */␊ - export interface CustomDomain6 {␊ - /**␊ - * Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source.␊ - */␊ - name: string␊ - /**␊ - * Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates.␊ - */␊ - useSubDomainName?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encryption settings on the storage account.␊ - */␊ - export interface Encryption6 {␊ - /**␊ - * The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault.␊ - */␊ - keySource: (("Microsoft.Storage" | "Microsoft.Keyvault") | string)␊ - /**␊ - * Properties of key vault.␊ - */␊ - keyvaultproperties?: (KeyVaultProperties10 | string)␊ - /**␊ - * A list of services that support encryption.␊ - */␊ - services?: (EncryptionServices6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of key vault.␊ - */␊ - export interface KeyVaultProperties10 {␊ - /**␊ - * The name of KeyVault key.␊ - */␊ - keyname?: string␊ - /**␊ - * The Uri of KeyVault.␊ - */␊ - keyvaulturi?: string␊ - /**␊ - * The version of KeyVault key.␊ - */␊ - keyversion?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A list of services that support encryption.␊ - */␊ - export interface EncryptionServices6 {␊ - /**␊ - * A service that allows server-side encryption to be used.␊ - */␊ - blob?: (EncryptionService6 | string)␊ - /**␊ - * A service that allows server-side encryption to be used.␊ - */␊ - file?: (EncryptionService6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A service that allows server-side encryption to be used.␊ - */␊ - export interface EncryptionService6 {␊ - /**␊ - * A boolean indicating whether or not the service encrypts the data as it is stored.␊ - */␊ - enabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network rule set␊ - */␊ - export interface NetworkRuleSet9 {␊ - /**␊ - * Specifies whether traffic is bypassed for Logging/Metrics/AzureServices. Possible values are any combination of Logging|Metrics|AzureServices (For example, "Logging, Metrics"), or None to bypass none of those traffics.␊ - */␊ - bypass?: (("None" | "Logging" | "Metrics" | "AzureServices") | string)␊ - /**␊ - * Specifies the default action of allow or deny when no other rules match.␊ - */␊ - defaultAction: (("Allow" | "Deny") | string)␊ - /**␊ - * Sets the IP ACL rules␊ - */␊ - ipRules?: (IPRule9[] | string)␊ - /**␊ - * Sets the virtual network rules␊ - */␊ - virtualNetworkRules?: (VirtualNetworkRule10[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP rule with specific IP or IP range in CIDR format.␊ - */␊ - export interface IPRule9 {␊ - /**␊ - * The action of IP ACL rule.␊ - */␊ - action?: ("Allow" | string)␊ - /**␊ - * Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed.␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Virtual Network rule.␊ - */␊ - export interface VirtualNetworkRule10 {␊ - /**␊ - * The action of virtual network rule.␊ - */␊ - action?: ("Allow" | string)␊ - /**␊ - * Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}.␊ - */␊ - id: string␊ - /**␊ - * Gets the state of virtual network rule.␊ - */␊ - state?: (("provisioning" | "deprovisioning" | "succeeded" | "failed" | "networkSourceDeleted") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/managementPolicies␊ - */␊ - export interface StorageAccountsManagementPoliciesChildResource1 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * The name of the Storage Account Management Policy. It should always be 'default'␊ - */␊ - name: "default"␊ - type: "managementPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/blobServices␊ - */␊ - export interface StorageAccountsBlobServicesChildResource1 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * The name of the blob Service within the specified storage account. Blob Service Name must be 'default'␊ - */␊ - name: "default"␊ - /**␊ - * The properties of a storage account’s Blob service.␊ - */␊ - properties: (BlobServicePropertiesProperties1 | string)␊ - type: "blobServices"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a storage account’s Blob service.␊ - */␊ - export interface BlobServicePropertiesProperties1 {␊ - /**␊ - * Sets the CORS rules. You can include up to five CorsRule elements in the request. ␊ - */␊ - cors?: (CorsRules1 | string)␊ - /**␊ - * DefaultServiceVersion indicates the default version to use for requests to the Blob service if an incoming request’s version is not specified. Possible values include version 2008-10-27 and all more recent versions.␊ - */␊ - defaultServiceVersion?: string␊ - /**␊ - * The blob service properties for soft delete.␊ - */␊ - deleteRetentionPolicy?: (DeleteRetentionPolicy1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Sets the CORS rules. You can include up to five CorsRule elements in the request. ␊ - */␊ - export interface CorsRules1 {␊ - /**␊ - * The List of CORS rules. You can include up to five CorsRule elements in the request. ␊ - */␊ - corsRules?: (CorsRule1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies a CORS rule for the Blob service.␊ - */␊ - export interface CorsRule1 {␊ - /**␊ - * Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request.␊ - */␊ - allowedHeaders: (string[] | string)␊ - /**␊ - * Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin.␊ - */␊ - allowedMethods: (("DELETE" | "GET" | "HEAD" | "MERGE" | "POST" | "OPTIONS" | "PUT")[] | string)␊ - /**␊ - * Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains␊ - */␊ - allowedOrigins: (string[] | string)␊ - /**␊ - * Required if CorsRule element is present. A list of response headers to expose to CORS clients.␊ - */␊ - exposedHeaders: (string[] | string)␊ - /**␊ - * Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response.␊ - */␊ - maxAgeInSeconds: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The blob service properties for soft delete.␊ - */␊ - export interface DeleteRetentionPolicy1 {␊ - /**␊ - * Indicates the number of days that the deleted blob should be retained. The minimum specified value can be 1 and the maximum value can be 365.␊ - */␊ - days?: (number | string)␊ - /**␊ - * Indicates whether DeleteRetentionPolicy is enabled for the Blob service.␊ - */␊ - enabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The SKU of the storage account.␊ - */␊ - export interface Sku18 {␊ - /**␊ - * Gets or sets the SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType.␊ - */␊ - name: (("Standard_LRS" | "Standard_GRS" | "Standard_RAGRS" | "Standard_ZRS" | "Premium_LRS" | "Premium_ZRS") | string)␊ - /**␊ - * The restrictions because of which SKU cannot be used. This is empty if there are no restrictions.␊ - */␊ - restrictions?: (Restriction5[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The restriction because of which SKU cannot be used.␊ - */␊ - export interface Restriction5 {␊ - /**␊ - * The reason for the restriction. As of now this can be "QuotaId" or "NotAvailableForSubscription". Quota Id is set when the SKU has requiredQuotas parameter as the subscription does not belong to that quota. The "NotAvailableForSubscription" is related to capacity at DC.␊ - */␊ - reasonCode?: (("QuotaId" | "NotAvailableForSubscription") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/blobServices␊ - */␊ - export interface StorageAccountsBlobServices1 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * The name of the blob Service within the specified storage account. Blob Service Name must be 'default'␊ - */␊ - name: string␊ - /**␊ - * The properties of a storage account’s Blob service.␊ - */␊ - properties?: (BlobServicePropertiesProperties1 | string)␊ - resources?: StorageAccountsBlobServicesContainersChildResource1[]␊ - type: "Microsoft.Storage/storageAccounts/blobServices"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/blobServices/containers␊ - */␊ - export interface StorageAccountsBlobServicesContainersChildResource1 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * The name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.␊ - */␊ - name: string␊ - /**␊ - * The properties of a container.␊ - */␊ - properties: (ContainerProperties3 | string)␊ - type: "containers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a container.␊ - */␊ - export interface ContainerProperties3 {␊ - /**␊ - * A name-value pair to associate with the container as metadata.␊ - */␊ - metadata?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Specifies whether data in the container may be accessed publicly and the level of access.␊ - */␊ - publicAccess?: (("Container" | "Blob" | "None") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/blobServices/containers␊ - */␊ - export interface StorageAccountsBlobServicesContainers3 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * The name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.␊ - */␊ - name: string␊ - /**␊ - * The properties of a container.␊ - */␊ - properties?: (ContainerProperties3 | string)␊ - resources?: StorageAccountsBlobServicesContainersImmutabilityPoliciesChildResource3[]␊ - type: "Microsoft.Storage/storageAccounts/blobServices/containers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies␊ - */␊ - export interface StorageAccountsBlobServicesContainersImmutabilityPoliciesChildResource3 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * The name of the blob container immutabilityPolicy within the specified storage account. ImmutabilityPolicy Name must be 'default'␊ - */␊ - name: "default"␊ - /**␊ - * The properties of an ImmutabilityPolicy of a blob container.␊ - */␊ - properties: (ImmutabilityPolicyProperty3 | string)␊ - type: "immutabilityPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of an ImmutabilityPolicy of a blob container.␊ - */␊ - export interface ImmutabilityPolicyProperty3 {␊ - /**␊ - * The immutability period for the blobs in the container since the policy creation, in days.␊ - */␊ - immutabilityPeriodSinceCreationInDays: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies␊ - */␊ - export interface StorageAccountsBlobServicesContainersImmutabilityPolicies3 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * The name of the blob container immutabilityPolicy within the specified storage account. ImmutabilityPolicy Name must be 'default'␊ - */␊ - name: string␊ - /**␊ - * The properties of an ImmutabilityPolicy of a blob container.␊ - */␊ - properties?: (ImmutabilityPolicyProperty3 | string)␊ - type: "Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/managementPolicies␊ - */␊ - export interface StorageAccountsManagementPolicies1 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * The name of the Storage Account Management Policy. It should always be 'default'␊ - */␊ - name: string␊ - type: "Microsoft.Storage/storageAccounts/managementPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts␊ - */␊ - export interface StorageAccounts8 {␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Identity for the resource.␊ - */␊ - identity?: (Identity12 | string)␊ - /**␊ - * Required. Indicates the type of storage account.␊ - */␊ - kind: (("Storage" | "StorageV2" | "BlobStorage" | "FileStorage" | "BlockBlobStorage") | string)␊ - /**␊ - * Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed.␊ - */␊ - location: string␊ - /**␊ - * 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.␊ - */␊ - name: string␊ - /**␊ - * The parameters used to create the storage account.␊ - */␊ - properties?: (StorageAccountPropertiesCreateParameters7 | string)␊ - resources?: (StorageAccountsManagementPoliciesChildResource2 | StorageAccountsBlobServicesChildResource2 | StorageAccountsFileServicesChildResource)[]␊ - /**␊ - * The SKU of the storage account.␊ - */␊ - sku: (Sku19 | string)␊ - /**␊ - * Gets or sets a list of key value pairs that describe the resource. These tags can be used for viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key with a length no greater than 128 characters and a value with a length no greater than 256 characters.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Storage/storageAccounts"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the resource.␊ - */␊ - export interface Identity12 {␊ - /**␊ - * The identity type.␊ - */␊ - type: ("SystemAssigned" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The parameters used to create the storage account.␊ - */␊ - export interface StorageAccountPropertiesCreateParameters7 {␊ - /**␊ - * Required for storage accounts where kind = BlobStorage. The access tier used for billing.␊ - */␊ - accessTier?: (("Hot" | "Cool") | string)␊ - /**␊ - * Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is true for this property.␊ - */␊ - allowBlobPublicAccess?: (boolean | string)␊ - /**␊ - * Indicates whether the storage account permits requests to be authorized with the account access key via Shared Key. If false, then all requests, including shared access signatures, must be authorized with Azure Active Directory (Azure AD). The default value is null, which is equivalent to true.␊ - */␊ - allowSharedKeyAccess?: (boolean | string)␊ - /**␊ - * Settings for Azure Files identity based authentication.␊ - */␊ - azureFilesIdentityBasedAuthentication?: (AzureFilesIdentityBasedAuthentication | string)␊ - /**␊ - * The custom domain assigned to this storage account. This can be set via Update.␊ - */␊ - customDomain?: (CustomDomain7 | string)␊ - /**␊ - * The encryption settings on the storage account.␊ - */␊ - encryption?: (Encryption7 | string)␊ - /**␊ - * Account HierarchicalNamespace enabled if sets to true.␊ - */␊ - isHnsEnabled?: (boolean | string)␊ - /**␊ - * Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled.␊ - */␊ - largeFileSharesState?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property.␊ - */␊ - minimumTlsVersion?: (("TLS1_0" | "TLS1_1" | "TLS1_2") | string)␊ - /**␊ - * Network rule set␊ - */␊ - networkAcls?: (NetworkRuleSet10 | string)␊ - /**␊ - * Allows https traffic only to storage service if sets to true. The default value is true since API version 2019-04-01.␊ - */␊ - supportsHttpsTrafficOnly?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Settings for Azure Files identity based authentication.␊ - */␊ - export interface AzureFilesIdentityBasedAuthentication {␊ - /**␊ - * Settings properties for Active Directory (AD).␊ - */␊ - activeDirectoryProperties?: (ActiveDirectoryProperties | string)␊ - /**␊ - * Indicates the directory service used.␊ - */␊ - directoryServiceOptions: (("None" | "AADDS" | "AD") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Settings properties for Active Directory (AD).␊ - */␊ - export interface ActiveDirectoryProperties {␊ - /**␊ - * Specifies the security identifier (SID) for Azure Storage.␊ - */␊ - azureStorageSid: string␊ - /**␊ - * Specifies the domain GUID.␊ - */␊ - domainGuid: string␊ - /**␊ - * Specifies the primary domain that the AD DNS server is authoritative for.␊ - */␊ - domainName: string␊ - /**␊ - * Specifies the security identifier (SID).␊ - */␊ - domainSid: string␊ - /**␊ - * Specifies the Active Directory forest to get.␊ - */␊ - forestName: string␊ - /**␊ - * Specifies the NetBIOS domain name.␊ - */␊ - netBiosDomainName: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The custom domain assigned to this storage account. This can be set via Update.␊ - */␊ - export interface CustomDomain7 {␊ - /**␊ - * Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source.␊ - */␊ - name: string␊ - /**␊ - * Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates.␊ - */␊ - useSubDomainName?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encryption settings on the storage account.␊ - */␊ - export interface Encryption7 {␊ - /**␊ - * The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault.␊ - */␊ - keySource: (("Microsoft.Storage" | "Microsoft.Keyvault") | string)␊ - /**␊ - * Properties of key vault.␊ - */␊ - keyvaultproperties?: (KeyVaultProperties11 | string)␊ - /**␊ - * A list of services that support encryption.␊ - */␊ - services?: (EncryptionServices7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of key vault.␊ - */␊ - export interface KeyVaultProperties11 {␊ - /**␊ - * The name of KeyVault key.␊ - */␊ - keyname?: string␊ - /**␊ - * The Uri of KeyVault.␊ - */␊ - keyvaulturi?: string␊ - /**␊ - * The version of KeyVault key.␊ - */␊ - keyversion?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A list of services that support encryption.␊ - */␊ - export interface EncryptionServices7 {␊ - /**␊ - * A service that allows server-side encryption to be used.␊ - */␊ - blob?: (EncryptionService7 | string)␊ - /**␊ - * A service that allows server-side encryption to be used.␊ - */␊ - file?: (EncryptionService7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A service that allows server-side encryption to be used.␊ - */␊ - export interface EncryptionService7 {␊ - /**␊ - * A boolean indicating whether or not the service encrypts the data as it is stored.␊ - */␊ - enabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network rule set␊ - */␊ - export interface NetworkRuleSet10 {␊ - /**␊ - * Specifies whether traffic is bypassed for Logging/Metrics/AzureServices. Possible values are any combination of Logging|Metrics|AzureServices (For example, "Logging, Metrics"), or None to bypass none of those traffics.␊ - */␊ - bypass?: (("None" | "Logging" | "Metrics" | "AzureServices") | string)␊ - /**␊ - * Specifies the default action of allow or deny when no other rules match.␊ - */␊ - defaultAction: (("Allow" | "Deny") | string)␊ - /**␊ - * Sets the IP ACL rules␊ - */␊ - ipRules?: (IPRule10[] | string)␊ - /**␊ - * Sets the virtual network rules␊ - */␊ - virtualNetworkRules?: (VirtualNetworkRule11[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP rule with specific IP or IP range in CIDR format.␊ - */␊ - export interface IPRule10 {␊ - /**␊ - * The action of IP ACL rule.␊ - */␊ - action?: ("Allow" | string)␊ - /**␊ - * Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed.␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Virtual Network rule.␊ - */␊ - export interface VirtualNetworkRule11 {␊ - /**␊ - * The action of virtual network rule.␊ - */␊ - action?: ("Allow" | string)␊ - /**␊ - * Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}.␊ - */␊ - id: string␊ - /**␊ - * Gets the state of virtual network rule.␊ - */␊ - state?: (("provisioning" | "deprovisioning" | "succeeded" | "failed" | "networkSourceDeleted") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/managementPolicies␊ - */␊ - export interface StorageAccountsManagementPoliciesChildResource2 {␊ - apiVersion: "2019-04-01"␊ - /**␊ - * The name of the Storage Account Management Policy. It should always be 'default'␊ - */␊ - name: "default"␊ - /**␊ - * The Storage Account ManagementPolicy properties.␊ - */␊ - properties: (ManagementPolicyProperties | string)␊ - type: "managementPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Storage Account ManagementPolicy properties.␊ - */␊ - export interface ManagementPolicyProperties {␊ - /**␊ - * The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts.␊ - */␊ - policy: (ManagementPolicySchema | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts.␊ - */␊ - export interface ManagementPolicySchema {␊ - /**␊ - * The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts.␊ - */␊ - rules: (ManagementPolicyRule[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An object that wraps the Lifecycle rule. Each rule is uniquely defined by name.␊ - */␊ - export interface ManagementPolicyRule {␊ - /**␊ - * An object that defines the Lifecycle rule. Each definition is made up with a filters set and an actions set.␊ - */␊ - definition: (ManagementPolicyDefinition | string)␊ - /**␊ - * Rule is enabled if set to true.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy.␊ - */␊ - name: string␊ - /**␊ - * The valid value is Lifecycle␊ - */␊ - type: ("Lifecycle" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An object that defines the Lifecycle rule. Each definition is made up with a filters set and an actions set.␊ - */␊ - export interface ManagementPolicyDefinition {␊ - /**␊ - * Actions are applied to the filtered blobs when the execution condition is met.␊ - */␊ - actions: (ManagementPolicyAction | string)␊ - /**␊ - * Filters limit rule actions to a subset of blobs within the storage account. If multiple filters are defined, a logical AND is performed on all filters. ␊ - */␊ - filters?: (ManagementPolicyFilter | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Actions are applied to the filtered blobs when the execution condition is met.␊ - */␊ - export interface ManagementPolicyAction {␊ - /**␊ - * Management policy action for base blob.␊ - */␊ - baseBlob?: (ManagementPolicyBaseBlob | string)␊ - /**␊ - * Management policy action for snapshot.␊ - */␊ - snapshot?: (ManagementPolicySnapShot | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Management policy action for base blob.␊ - */␊ - export interface ManagementPolicyBaseBlob {␊ - /**␊ - * Object to define the number of days after last modification.␊ - */␊ - delete?: (DateAfterModification | string)␊ - /**␊ - * Object to define the number of days after last modification.␊ - */␊ - tierToArchive?: (DateAfterModification | string)␊ - /**␊ - * Object to define the number of days after last modification.␊ - */␊ - tierToCool?: (DateAfterModification | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Object to define the number of days after last modification.␊ - */␊ - export interface DateAfterModification {␊ - /**␊ - * Value indicating the age in days after last modification␊ - */␊ - daysAfterModificationGreaterThan: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Management policy action for snapshot.␊ - */␊ - export interface ManagementPolicySnapShot {␊ - /**␊ - * Object to define the number of days after creation.␊ - */␊ - delete?: (DateAfterCreation | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Object to define the number of days after creation.␊ - */␊ - export interface DateAfterCreation {␊ - /**␊ - * Value indicating the age in days after creation␊ - */␊ - daysAfterCreationGreaterThan: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Filters limit rule actions to a subset of blobs within the storage account. If multiple filters are defined, a logical AND is performed on all filters. ␊ - */␊ - export interface ManagementPolicyFilter {␊ - /**␊ - * An array of predefined enum values. Only blockBlob is supported.␊ - */␊ - blobTypes: (string[] | string)␊ - /**␊ - * An array of strings for prefixes to be match.␊ - */␊ - prefixMatch?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/blobServices␊ - */␊ - export interface StorageAccountsBlobServicesChildResource2 {␊ - apiVersion: "2019-04-01"␊ - /**␊ - * The name of the blob Service within the specified storage account. Blob Service Name must be 'default'␊ - */␊ - name: "default"␊ - /**␊ - * The properties of a storage account’s Blob service.␊ - */␊ - properties: (BlobServicePropertiesProperties2 | string)␊ - type: "blobServices"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a storage account’s Blob service.␊ - */␊ - export interface BlobServicePropertiesProperties2 {␊ - /**␊ - * Automatic Snapshot is enabled if set to true.␊ - */␊ - automaticSnapshotPolicyEnabled?: (boolean | string)␊ - /**␊ - * The blob service properties for change feed events.␊ - */␊ - changeFeed?: (ChangeFeed | string)␊ - /**␊ - * Sets the CORS rules. You can include up to five CorsRule elements in the request. ␊ - */␊ - cors?: (CorsRules2 | string)␊ - /**␊ - * DefaultServiceVersion indicates the default version to use for requests to the Blob service if an incoming request’s version is not specified. Possible values include version 2008-10-27 and all more recent versions.␊ - */␊ - defaultServiceVersion?: string␊ - /**␊ - * The blob service properties for soft delete.␊ - */␊ - deleteRetentionPolicy?: (DeleteRetentionPolicy2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The blob service properties for change feed events.␊ - */␊ - export interface ChangeFeed {␊ - /**␊ - * Indicates whether change feed event logging is enabled for the Blob service.␊ - */␊ - enabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Sets the CORS rules. You can include up to five CorsRule elements in the request. ␊ - */␊ - export interface CorsRules2 {␊ - /**␊ - * The List of CORS rules. You can include up to five CorsRule elements in the request. ␊ - */␊ - corsRules?: (CorsRule2[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies a CORS rule for the Blob service.␊ - */␊ - export interface CorsRule2 {␊ - /**␊ - * Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request.␊ - */␊ - allowedHeaders: (string[] | string)␊ - /**␊ - * Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin.␊ - */␊ - allowedMethods: (("DELETE" | "GET" | "HEAD" | "MERGE" | "POST" | "OPTIONS" | "PUT")[] | string)␊ - /**␊ - * Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains␊ - */␊ - allowedOrigins: (string[] | string)␊ - /**␊ - * Required if CorsRule element is present. A list of response headers to expose to CORS clients.␊ - */␊ - exposedHeaders: (string[] | string)␊ - /**␊ - * Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response.␊ - */␊ - maxAgeInSeconds: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The blob service properties for soft delete.␊ - */␊ - export interface DeleteRetentionPolicy2 {␊ - /**␊ - * Indicates the number of days that the deleted blob should be retained. The minimum specified value can be 1 and the maximum value can be 365.␊ - */␊ - days?: (number | string)␊ - /**␊ - * Indicates whether DeleteRetentionPolicy is enabled for the Blob service.␊ - */␊ - enabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/fileServices␊ - */␊ - export interface StorageAccountsFileServicesChildResource {␊ - apiVersion: "2019-04-01"␊ - /**␊ - * The name of the file Service within the specified storage account. File Service Name must be "default"␊ - */␊ - name: "default"␊ - /**␊ - * The properties of File services in storage account.␊ - */␊ - properties: (FileServicePropertiesProperties | string)␊ - type: "fileServices"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of File services in storage account.␊ - */␊ - export interface FileServicePropertiesProperties {␊ - /**␊ - * Sets the CORS rules. You can include up to five CorsRule elements in the request. ␊ - */␊ - cors?: (CorsRules2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The SKU of the storage account.␊ - */␊ - export interface Sku19 {␊ - /**␊ - * Gets or sets the SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType.␊ - */␊ - name: (("Standard_LRS" | "Standard_GRS" | "Standard_RAGRS" | "Standard_ZRS" | "Premium_LRS" | "Premium_ZRS" | "Standard_GZRS" | "Standard_RAGZRS") | string)␊ - /**␊ - * The restrictions because of which SKU cannot be used. This is empty if there are no restrictions.␊ - */␊ - restrictions?: (Restriction6[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The restriction because of which SKU cannot be used.␊ - */␊ - export interface Restriction6 {␊ - /**␊ - * The reason for the restriction. As of now this can be "QuotaId" or "NotAvailableForSubscription". Quota Id is set when the SKU has requiredQuotas parameter as the subscription does not belong to that quota. The "NotAvailableForSubscription" is related to capacity at DC.␊ - */␊ - reasonCode?: (("QuotaId" | "NotAvailableForSubscription") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/blobServices␊ - */␊ - export interface StorageAccountsBlobServices2 {␊ - apiVersion: "2019-04-01"␊ - /**␊ - * The name of the blob Service within the specified storage account. Blob Service Name must be 'default'␊ - */␊ - name: string␊ - /**␊ - * The properties of a storage account’s Blob service.␊ - */␊ - properties?: (BlobServicePropertiesProperties2 | string)␊ - resources?: StorageAccountsBlobServicesContainersChildResource2[]␊ - type: "Microsoft.Storage/storageAccounts/blobServices"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/blobServices/containers␊ - */␊ - export interface StorageAccountsBlobServicesContainersChildResource2 {␊ - apiVersion: "2019-04-01"␊ - /**␊ - * The name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.␊ - */␊ - name: string␊ - /**␊ - * The properties of a container.␊ - */␊ - properties: (ContainerProperties4 | string)␊ - type: "containers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a container.␊ - */␊ - export interface ContainerProperties4 {␊ - /**␊ - * A name-value pair to associate with the container as metadata.␊ - */␊ - metadata?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Specifies whether data in the container may be accessed publicly and the level of access.␊ - */␊ - publicAccess?: (("Container" | "Blob" | "None") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/blobServices/containers␊ - */␊ - export interface StorageAccountsBlobServicesContainers4 {␊ - apiVersion: "2019-04-01"␊ - /**␊ - * The name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.␊ - */␊ - name: string␊ - /**␊ - * The properties of a container.␊ - */␊ - properties?: (ContainerProperties4 | string)␊ - resources?: StorageAccountsBlobServicesContainersImmutabilityPoliciesChildResource4[]␊ - type: "Microsoft.Storage/storageAccounts/blobServices/containers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies␊ - */␊ - export interface StorageAccountsBlobServicesContainersImmutabilityPoliciesChildResource4 {␊ - apiVersion: "2019-04-01"␊ - /**␊ - * The name of the blob container immutabilityPolicy within the specified storage account. ImmutabilityPolicy Name must be 'default'␊ - */␊ - name: "default"␊ - /**␊ - * The properties of an ImmutabilityPolicy of a blob container.␊ - */␊ - properties: (ImmutabilityPolicyProperty4 | string)␊ - type: "immutabilityPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of an ImmutabilityPolicy of a blob container.␊ - */␊ - export interface ImmutabilityPolicyProperty4 {␊ - /**␊ - * The immutability period for the blobs in the container since the policy creation, in days.␊ - */␊ - immutabilityPeriodSinceCreationInDays: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies␊ - */␊ - export interface StorageAccountsBlobServicesContainersImmutabilityPolicies4 {␊ - apiVersion: "2019-04-01"␊ - /**␊ - * The name of the blob container immutabilityPolicy within the specified storage account. ImmutabilityPolicy Name must be 'default'␊ - */␊ - name: string␊ - /**␊ - * The properties of an ImmutabilityPolicy of a blob container.␊ - */␊ - properties?: (ImmutabilityPolicyProperty4 | string)␊ - type: "Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/managementPolicies␊ - */␊ - export interface StorageAccountsManagementPolicies2 {␊ - apiVersion: "2019-04-01"␊ - /**␊ - * The name of the Storage Account Management Policy. It should always be 'default'␊ - */␊ - name: string␊ - /**␊ - * The Storage Account ManagementPolicy properties.␊ - */␊ - properties?: (ManagementPolicyProperties | string)␊ - type: "Microsoft.Storage/storageAccounts/managementPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/fileServices␊ - */␊ - export interface StorageAccountsFileServices {␊ - apiVersion: "2019-04-01"␊ - /**␊ - * The name of the file Service within the specified storage account. File Service Name must be "default"␊ - */␊ - name: string␊ - /**␊ - * The properties of File services in storage account.␊ - */␊ - properties?: (FileServicePropertiesProperties | string)␊ - resources?: StorageAccountsFileServicesSharesChildResource[]␊ - type: "Microsoft.Storage/storageAccounts/fileServices"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/fileServices/shares␊ - */␊ - export interface StorageAccountsFileServicesSharesChildResource {␊ - apiVersion: "2019-04-01"␊ - /**␊ - * The name of the file share within the specified storage account. File share names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.␊ - */␊ - name: string␊ - /**␊ - * The properties of the file share.␊ - */␊ - properties: (FileShareProperties | string)␊ - type: "shares"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the file share.␊ - */␊ - export interface FileShareProperties {␊ - /**␊ - * A name-value pair to associate with the share as metadata.␊ - */␊ - metadata?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The maximum size of the share, in gigabytes. Must be greater than 0, and less than or equal to 5TB (5120).␊ - */␊ - shareQuota?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/fileServices/shares␊ - */␊ - export interface StorageAccountsFileServicesShares {␊ - apiVersion: "2019-04-01"␊ - /**␊ - * The name of the file share within the specified storage account. File share names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.␊ - */␊ - name: string␊ - /**␊ - * The properties of the file share.␊ - */␊ - properties?: (FileShareProperties | string)␊ - type: "Microsoft.Storage/storageAccounts/fileServices/shares"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts␊ - */␊ - export interface StorageAccounts9 {␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Identity for the resource.␊ - */␊ - identity?: (Identity13 | string)␊ - /**␊ - * Required. Indicates the type of storage account.␊ - */␊ - kind: (("Storage" | "StorageV2" | "BlobStorage" | "FileStorage" | "BlockBlobStorage") | string)␊ - /**␊ - * Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed.␊ - */␊ - location: string␊ - /**␊ - * 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.␊ - */␊ - name: string␊ - /**␊ - * The parameters used to create the storage account.␊ - */␊ - properties?: (StorageAccountPropertiesCreateParameters8 | string)␊ - resources?: (StorageAccountsManagementPoliciesChildResource3 | StorageAccountsInventoryPoliciesChildResource | StorageAccountsPrivateEndpointConnectionsChildResource | StorageAccountsObjectReplicationPoliciesChildResource | StorageAccountsEncryptionScopesChildResource | StorageAccountsBlobServicesChildResource3 | StorageAccountsFileServicesChildResource1 | StorageAccountsQueueServicesChildResource | StorageAccountsTableServicesChildResource)[]␊ - /**␊ - * The SKU of the storage account.␊ - */␊ - sku: (Sku20 | string)␊ - /**␊ - * Gets or sets a list of key value pairs that describe the resource. These tags can be used for viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key with a length no greater than 128 characters and a value with a length no greater than 256 characters.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Storage/storageAccounts"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the resource.␊ - */␊ - export interface Identity13 {␊ - /**␊ - * The identity type.␊ - */␊ - type: ("SystemAssigned" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The parameters used to create the storage account.␊ - */␊ - export interface StorageAccountPropertiesCreateParameters8 {␊ - /**␊ - * Required for storage accounts where kind = BlobStorage. The access tier used for billing.␊ - */␊ - accessTier?: (("Hot" | "Cool") | string)␊ - /**␊ - * Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is true for this property.␊ - */␊ - allowBlobPublicAccess?: (boolean | string)␊ - /**␊ - * Indicates whether the storage account permits requests to be authorized with the account access key via Shared Key. If false, then all requests, including shared access signatures, must be authorized with Azure Active Directory (Azure AD). The default value is null, which is equivalent to true.␊ - */␊ - allowSharedKeyAccess?: (boolean | string)␊ - /**␊ - * Settings for Azure Files identity based authentication.␊ - */␊ - azureFilesIdentityBasedAuthentication?: (AzureFilesIdentityBasedAuthentication1 | string)␊ - /**␊ - * The custom domain assigned to this storage account. This can be set via Update.␊ - */␊ - customDomain?: (CustomDomain8 | string)␊ - /**␊ - * The encryption settings on the storage account.␊ - */␊ - encryption?: (Encryption8 | string)␊ - /**␊ - * Account HierarchicalNamespace enabled if sets to true.␊ - */␊ - isHnsEnabled?: (boolean | string)␊ - /**␊ - * Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled.␊ - */␊ - largeFileSharesState?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property.␊ - */␊ - minimumTlsVersion?: (("TLS1_0" | "TLS1_1" | "TLS1_2") | string)␊ - /**␊ - * Network rule set␊ - */␊ - networkAcls?: (NetworkRuleSet11 | string)␊ - /**␊ - * Routing preference defines the type of network, either microsoft or internet routing to be used to deliver the user data, the default option is microsoft routing␊ - */␊ - routingPreference?: (RoutingPreference | string)␊ - /**␊ - * Allows https traffic only to storage service if sets to true. The default value is true since API version 2019-04-01.␊ - */␊ - supportsHttpsTrafficOnly?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Settings for Azure Files identity based authentication.␊ - */␊ - export interface AzureFilesIdentityBasedAuthentication1 {␊ - /**␊ - * Settings properties for Active Directory (AD).␊ - */␊ - activeDirectoryProperties?: (ActiveDirectoryProperties1 | string)␊ - /**␊ - * Indicates the directory service used.␊ - */␊ - directoryServiceOptions: (("None" | "AADDS" | "AD") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Settings properties for Active Directory (AD).␊ - */␊ - export interface ActiveDirectoryProperties1 {␊ - /**␊ - * Specifies the security identifier (SID) for Azure Storage.␊ - */␊ - azureStorageSid: string␊ - /**␊ - * Specifies the domain GUID.␊ - */␊ - domainGuid: string␊ - /**␊ - * Specifies the primary domain that the AD DNS server is authoritative for.␊ - */␊ - domainName: string␊ - /**␊ - * Specifies the security identifier (SID).␊ - */␊ - domainSid: string␊ - /**␊ - * Specifies the Active Directory forest to get.␊ - */␊ - forestName: string␊ - /**␊ - * Specifies the NetBIOS domain name.␊ - */␊ - netBiosDomainName: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The custom domain assigned to this storage account. This can be set via Update.␊ - */␊ - export interface CustomDomain8 {␊ - /**␊ - * Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source.␊ - */␊ - name: string␊ - /**␊ - * Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates.␊ - */␊ - useSubDomainName?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encryption settings on the storage account.␊ - */␊ - export interface Encryption8 {␊ - /**␊ - * The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault.␊ - */␊ - keySource: (("Microsoft.Storage" | "Microsoft.Keyvault") | string)␊ - /**␊ - * Properties of key vault.␊ - */␊ - keyvaultproperties?: (KeyVaultProperties12 | string)␊ - /**␊ - * A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest.␊ - */␊ - requireInfrastructureEncryption?: (boolean | string)␊ - /**␊ - * A list of services that support encryption.␊ - */␊ - services?: (EncryptionServices8 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of key vault.␊ - */␊ - export interface KeyVaultProperties12 {␊ - /**␊ - * The name of KeyVault key.␊ - */␊ - keyname?: string␊ - /**␊ - * The Uri of KeyVault.␊ - */␊ - keyvaulturi?: string␊ - /**␊ - * The version of KeyVault key.␊ - */␊ - keyversion?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A list of services that support encryption.␊ - */␊ - export interface EncryptionServices8 {␊ - /**␊ - * A service that allows server-side encryption to be used.␊ - */␊ - blob?: (EncryptionService8 | string)␊ - /**␊ - * A service that allows server-side encryption to be used.␊ - */␊ - file?: (EncryptionService8 | string)␊ - /**␊ - * A service that allows server-side encryption to be used.␊ - */␊ - queue?: (EncryptionService8 | string)␊ - /**␊ - * A service that allows server-side encryption to be used.␊ - */␊ - table?: (EncryptionService8 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A service that allows server-side encryption to be used.␊ - */␊ - export interface EncryptionService8 {␊ - /**␊ - * A boolean indicating whether or not the service encrypts the data as it is stored.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Encryption key type to be used for the encryption service. 'Account' key type implies that an account-scoped encryption key will be used. 'Service' key type implies that a default service key is used.␊ - */␊ - keyType?: (("Service" | "Account") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network rule set␊ - */␊ - export interface NetworkRuleSet11 {␊ - /**␊ - * Specifies whether traffic is bypassed for Logging/Metrics/AzureServices. Possible values are any combination of Logging|Metrics|AzureServices (For example, "Logging, Metrics"), or None to bypass none of those traffics.␊ - */␊ - bypass?: (("None" | "Logging" | "Metrics" | "AzureServices") | string)␊ - /**␊ - * Specifies the default action of allow or deny when no other rules match.␊ - */␊ - defaultAction: (("Allow" | "Deny") | string)␊ - /**␊ - * Sets the IP ACL rules␊ - */␊ - ipRules?: (IPRule11[] | string)␊ - /**␊ - * Sets the virtual network rules␊ - */␊ - virtualNetworkRules?: (VirtualNetworkRule12[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP rule with specific IP or IP range in CIDR format.␊ - */␊ - export interface IPRule11 {␊ - /**␊ - * The action of IP ACL rule.␊ - */␊ - action?: ("Allow" | string)␊ - /**␊ - * Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed.␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Virtual Network rule.␊ - */␊ - export interface VirtualNetworkRule12 {␊ - /**␊ - * The action of virtual network rule.␊ - */␊ - action?: ("Allow" | string)␊ - /**␊ - * Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}.␊ - */␊ - id: string␊ - /**␊ - * Gets the state of virtual network rule.␊ - */␊ - state?: (("provisioning" | "deprovisioning" | "succeeded" | "failed" | "networkSourceDeleted") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Routing preference defines the type of network, either microsoft or internet routing to be used to deliver the user data, the default option is microsoft routing␊ - */␊ - export interface RoutingPreference {␊ - /**␊ - * A boolean flag which indicates whether internet routing storage endpoints are to be published␊ - */␊ - publishInternetEndpoints?: (boolean | string)␊ - /**␊ - * A boolean flag which indicates whether microsoft routing storage endpoints are to be published␊ - */␊ - publishMicrosoftEndpoints?: (boolean | string)␊ - /**␊ - * Routing Choice defines the kind of network routing opted by the user.␊ - */␊ - routingChoice?: (("MicrosoftRouting" | "InternetRouting") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/managementPolicies␊ - */␊ - export interface StorageAccountsManagementPoliciesChildResource3 {␊ - apiVersion: "2019-06-01"␊ - /**␊ - * The name of the Storage Account Management Policy. It should always be 'default'␊ - */␊ - name: "default"␊ - /**␊ - * The Storage Account ManagementPolicy properties.␊ - */␊ - properties: (ManagementPolicyProperties1 | string)␊ - type: "managementPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Storage Account ManagementPolicy properties.␊ - */␊ - export interface ManagementPolicyProperties1 {␊ - /**␊ - * The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts.␊ - */␊ - policy: (ManagementPolicySchema1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts.␊ - */␊ - export interface ManagementPolicySchema1 {␊ - /**␊ - * The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts.␊ - */␊ - rules: (ManagementPolicyRule1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An object that wraps the Lifecycle rule. Each rule is uniquely defined by name.␊ - */␊ - export interface ManagementPolicyRule1 {␊ - /**␊ - * An object that defines the Lifecycle rule. Each definition is made up with a filters set and an actions set.␊ - */␊ - definition: (ManagementPolicyDefinition1 | string)␊ - /**␊ - * Rule is enabled if set to true.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy.␊ - */␊ - name: string␊ - /**␊ - * The valid value is Lifecycle␊ - */␊ - type: ("Lifecycle" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An object that defines the Lifecycle rule. Each definition is made up with a filters set and an actions set.␊ - */␊ - export interface ManagementPolicyDefinition1 {␊ - /**␊ - * Actions are applied to the filtered blobs when the execution condition is met.␊ - */␊ - actions: (ManagementPolicyAction1 | string)␊ - /**␊ - * Filters limit rule actions to a subset of blobs within the storage account. If multiple filters are defined, a logical AND is performed on all filters. ␊ - */␊ - filters?: (ManagementPolicyFilter1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Actions are applied to the filtered blobs when the execution condition is met.␊ - */␊ - export interface ManagementPolicyAction1 {␊ - /**␊ - * Management policy action for base blob.␊ - */␊ - baseBlob?: (ManagementPolicyBaseBlob1 | string)␊ - /**␊ - * Management policy action for snapshot.␊ - */␊ - snapshot?: (ManagementPolicySnapShot1 | string)␊ - /**␊ - * Management policy action for blob version.␊ - */␊ - version?: (ManagementPolicyVersion | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Management policy action for base blob.␊ - */␊ - export interface ManagementPolicyBaseBlob1 {␊ - /**␊ - * Object to define the number of days after object last modification Or last access. Properties daysAfterModificationGreaterThan and daysAfterLastAccessTimeGreaterThan are mutually exclusive.␊ - */␊ - delete?: (DateAfterModification1 | string)␊ - /**␊ - * This property enables auto tiering of a blob from cool to hot on a blob access. This property requires tierToCool.daysAfterLastAccessTimeGreaterThan.␊ - */␊ - enableAutoTierToHotFromCool?: (boolean | string)␊ - /**␊ - * Object to define the number of days after object last modification Or last access. Properties daysAfterModificationGreaterThan and daysAfterLastAccessTimeGreaterThan are mutually exclusive.␊ - */␊ - tierToArchive?: (DateAfterModification1 | string)␊ - /**␊ - * Object to define the number of days after object last modification Or last access. Properties daysAfterModificationGreaterThan and daysAfterLastAccessTimeGreaterThan are mutually exclusive.␊ - */␊ - tierToCool?: (DateAfterModification1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Object to define the number of days after object last modification Or last access. Properties daysAfterModificationGreaterThan and daysAfterLastAccessTimeGreaterThan are mutually exclusive.␊ - */␊ - export interface DateAfterModification1 {␊ - /**␊ - * Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy␊ - */␊ - daysAfterLastAccessTimeGreaterThan?: (number | string)␊ - /**␊ - * Value indicating the age in days after last modification␊ - */␊ - daysAfterModificationGreaterThan?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Management policy action for snapshot.␊ - */␊ - export interface ManagementPolicySnapShot1 {␊ - /**␊ - * Object to define the number of days after creation.␊ - */␊ - delete?: (DateAfterCreation1 | string)␊ - /**␊ - * Object to define the number of days after creation.␊ - */␊ - tierToArchive?: (DateAfterCreation1 | string)␊ - /**␊ - * Object to define the number of days after creation.␊ - */␊ - tierToCool?: (DateAfterCreation1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Object to define the number of days after creation.␊ - */␊ - export interface DateAfterCreation1 {␊ - /**␊ - * Value indicating the age in days after creation␊ - */␊ - daysAfterCreationGreaterThan: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Management policy action for blob version.␊ - */␊ - export interface ManagementPolicyVersion {␊ - /**␊ - * Object to define the number of days after creation.␊ - */␊ - delete?: (DateAfterCreation1 | string)␊ - /**␊ - * Object to define the number of days after creation.␊ - */␊ - tierToArchive?: (DateAfterCreation1 | string)␊ - /**␊ - * Object to define the number of days after creation.␊ - */␊ - tierToCool?: (DateAfterCreation1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Filters limit rule actions to a subset of blobs within the storage account. If multiple filters are defined, a logical AND is performed on all filters. ␊ - */␊ - export interface ManagementPolicyFilter1 {␊ - /**␊ - * An array of blob index tag based filters, there can be at most 10 tag filters␊ - */␊ - blobIndexMatch?: (TagFilter[] | string)␊ - /**␊ - * An array of predefined enum values. Currently blockBlob supports all tiering and delete actions. Only delete actions are supported for appendBlob.␊ - */␊ - blobTypes: (string[] | string)␊ - /**␊ - * An array of strings for prefixes to be match.␊ - */␊ - prefixMatch?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Blob index tag based filtering for blob objects␊ - */␊ - export interface TagFilter {␊ - /**␊ - * This is the filter tag name, it can have 1 - 128 characters␊ - */␊ - name: string␊ - /**␊ - * This is the comparison operator which is used for object comparison and filtering. Only == (equality operator) is currently supported␊ - */␊ - op: string␊ - /**␊ - * This is the filter tag value field used for tag based filtering, it can have 0 - 256 characters␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/inventoryPolicies␊ - */␊ - export interface StorageAccountsInventoryPoliciesChildResource {␊ - apiVersion: "2019-06-01"␊ - /**␊ - * The name of the storage account blob inventory policy. It should always be 'default'␊ - */␊ - name: "default"␊ - /**␊ - * The storage account blob inventory policy properties.␊ - */␊ - properties: (BlobInventoryPolicyProperties | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData | string)␊ - type: "inventoryPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The storage account blob inventory policy properties.␊ - */␊ - export interface BlobInventoryPolicyProperties {␊ - /**␊ - * The storage account blob inventory policy rules.␊ - */␊ - policy: (BlobInventoryPolicySchema | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The storage account blob inventory policy rules.␊ - */␊ - export interface BlobInventoryPolicySchema {␊ - /**␊ - * Container name where blob inventory files are stored. Must be pre-created.␊ - */␊ - destination: string␊ - /**␊ - * Policy is enabled if set to true.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * The storage account blob inventory policy rules. The rule is applied when it is enabled.␊ - */␊ - rules: (BlobInventoryPolicyRule[] | string)␊ - /**␊ - * The valid value is Inventory␊ - */␊ - type: ("Inventory" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An object that wraps the blob inventory rule. Each rule is uniquely defined by name.␊ - */␊ - export interface BlobInventoryPolicyRule {␊ - /**␊ - * An object that defines the blob inventory rule. Each definition consists of a set of filters.␊ - */␊ - definition: (BlobInventoryPolicyDefinition | string)␊ - /**␊ - * Rule is enabled when set to true.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An object that defines the blob inventory rule. Each definition consists of a set of filters.␊ - */␊ - export interface BlobInventoryPolicyDefinition {␊ - /**␊ - * An object that defines the blob inventory rule filter conditions.␊ - */␊ - filters: (BlobInventoryPolicyFilter | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An object that defines the blob inventory rule filter conditions.␊ - */␊ - export interface BlobInventoryPolicyFilter {␊ - /**␊ - * An array of predefined enum values. Valid values include blockBlob, appendBlob, pageBlob. Hns accounts does not support pageBlobs.␊ - */␊ - blobTypes: (string[] | string)␊ - /**␊ - * Includes blob versions in blob inventory when value set to true.␊ - */␊ - includeBlobVersions?: (boolean | string)␊ - /**␊ - * Includes blob snapshots in blob inventory when value set to true.␊ - */␊ - includeSnapshots?: (boolean | string)␊ - /**␊ - * An array of strings for blob prefixes to be matched.␊ - */␊ - prefixMatch?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - export interface SystemData {␊ - /**␊ - * The timestamp of resource creation (UTC).␊ - */␊ - createdAt?: string␊ - /**␊ - * The identity that created the resource.␊ - */␊ - createdBy?: string␊ - /**␊ - * The type of identity that created the resource.␊ - */␊ - createdByType?: (("User" | "Application" | "ManagedIdentity" | "Key") | string)␊ - /**␊ - * The timestamp of resource last modification (UTC)␊ - */␊ - lastModifiedAt?: string␊ - /**␊ - * The identity that last modified the resource.␊ - */␊ - lastModifiedBy?: string␊ - /**␊ - * The type of identity that last modified the resource.␊ - */␊ - lastModifiedByType?: (("User" | "Application" | "ManagedIdentity" | "Key") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/privateEndpointConnections␊ - */␊ - export interface StorageAccountsPrivateEndpointConnectionsChildResource {␊ - apiVersion: "2019-06-01"␊ - /**␊ - * The name of the private endpoint connection associated with the Azure resource␊ - */␊ - name: string␊ - /**␊ - * Properties of the PrivateEndpointConnectProperties.␊ - */␊ - properties: (PrivateEndpointConnectionProperties3 | string)␊ - type: "privateEndpointConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the PrivateEndpointConnectProperties.␊ - */␊ - export interface PrivateEndpointConnectionProperties3 {␊ - /**␊ - * The Private Endpoint resource.␊ - */␊ - privateEndpoint?: (PrivateEndpoint3 | string)␊ - /**␊ - * A collection of information about the state of the connection between service consumer and provider.␊ - */␊ - privateLinkServiceConnectionState: (PrivateLinkServiceConnectionState3 | string)␊ - /**␊ - * The provisioning state of the private endpoint connection resource.␊ - */␊ - provisioningState?: (("Succeeded" | "Creating" | "Deleting" | "Failed") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Private Endpoint resource.␊ - */␊ - export interface PrivateEndpoint3 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A collection of information about the state of the connection between service consumer and provider.␊ - */␊ - export interface PrivateLinkServiceConnectionState3 {␊ - /**␊ - * A message indicating if changes on the service provider require any updates on the consumer.␊ - */␊ - actionRequired?: string␊ - /**␊ - * The reason for approval/rejection of the connection.␊ - */␊ - description?: string␊ - /**␊ - * Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.␊ - */␊ - status?: (("Pending" | "Approved" | "Rejected") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/objectReplicationPolicies␊ - */␊ - export interface StorageAccountsObjectReplicationPoliciesChildResource {␊ - apiVersion: "2019-06-01"␊ - /**␊ - * The ID of object replication policy or 'default' if the policy ID is unknown.␊ - */␊ - name: string␊ - /**␊ - * The Storage Account ObjectReplicationPolicy properties.␊ - */␊ - properties: (ObjectReplicationPolicyProperties | string)␊ - type: "objectReplicationPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Storage Account ObjectReplicationPolicy properties.␊ - */␊ - export interface ObjectReplicationPolicyProperties {␊ - /**␊ - * Required. Destination account name.␊ - */␊ - destinationAccount: string␊ - /**␊ - * The storage account object replication rules.␊ - */␊ - rules?: (ObjectReplicationPolicyRule[] | string)␊ - /**␊ - * Required. Source account name.␊ - */␊ - sourceAccount: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The replication policy rule between two containers.␊ - */␊ - export interface ObjectReplicationPolicyRule {␊ - /**␊ - * Required. Destination container name.␊ - */␊ - destinationContainer: string␊ - /**␊ - * Filters limit replication to a subset of blobs within the storage account. A logical OR is performed on values in the filter. If multiple filters are defined, a logical AND is performed on all filters.␊ - */␊ - filters?: (ObjectReplicationPolicyFilter | string)␊ - /**␊ - * Rule Id is auto-generated for each new rule on destination account. It is required for put policy on source account.␊ - */␊ - ruleId?: string␊ - /**␊ - * Required. Source container name.␊ - */␊ - sourceContainer: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Filters limit replication to a subset of blobs within the storage account. A logical OR is performed on values in the filter. If multiple filters are defined, a logical AND is performed on all filters.␊ - */␊ - export interface ObjectReplicationPolicyFilter {␊ - /**␊ - * Blobs created after the time will be replicated to the destination. It must be in datetime format 'yyyy-MM-ddTHH:mm:ssZ'. Example: 2020-02-19T16:05:00Z␊ - */␊ - minCreationTime?: string␊ - /**␊ - * Optional. Filters the results to replicate only blobs whose names begin with the specified prefix.␊ - */␊ - prefixMatch?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/encryptionScopes␊ - */␊ - export interface StorageAccountsEncryptionScopesChildResource {␊ - apiVersion: "2019-06-01"␊ - /**␊ - * The name of the encryption scope within the specified storage account. Encryption scope names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.␊ - */␊ - name: string␊ - /**␊ - * Properties of the encryption scope.␊ - */␊ - properties: (EncryptionScopeProperties | string)␊ - type: "encryptionScopes"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the encryption scope.␊ - */␊ - export interface EncryptionScopeProperties {␊ - /**␊ - * The key vault properties for the encryption scope. This is a required field if encryption scope 'source' attribute is set to 'Microsoft.KeyVault'.␊ - */␊ - keyVaultProperties?: (EncryptionScopeKeyVaultProperties | string)␊ - /**␊ - * The provider for the encryption scope. Possible values (case-insensitive): Microsoft.Storage, Microsoft.KeyVault.␊ - */␊ - source?: (("Microsoft.Storage" | "Microsoft.KeyVault") | string)␊ - /**␊ - * The state of the encryption scope. Possible values (case-insensitive): Enabled, Disabled.␊ - */␊ - state?: (("Enabled" | "Disabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The key vault properties for the encryption scope. This is a required field if encryption scope 'source' attribute is set to 'Microsoft.KeyVault'.␊ - */␊ - export interface EncryptionScopeKeyVaultProperties {␊ - /**␊ - * The object identifier for a key vault key object. When applied, the encryption scope will use the key referenced by the identifier to enable customer-managed key support on this encryption scope.␊ - */␊ - keyUri?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/blobServices␊ - */␊ - export interface StorageAccountsBlobServicesChildResource3 {␊ - apiVersion: "2019-06-01"␊ - /**␊ - * The name of the blob Service within the specified storage account. Blob Service Name must be 'default'␊ - */␊ - name: "default"␊ - /**␊ - * The properties of a storage account’s Blob service.␊ - */␊ - properties: (BlobServicePropertiesProperties3 | string)␊ - type: "blobServices"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a storage account’s Blob service.␊ - */␊ - export interface BlobServicePropertiesProperties3 {␊ - /**␊ - * Deprecated in favor of isVersioningEnabled property.␊ - */␊ - automaticSnapshotPolicyEnabled?: (boolean | string)␊ - /**␊ - * The blob service properties for change feed events.␊ - */␊ - changeFeed?: (ChangeFeed1 | string)␊ - /**␊ - * The service properties for soft delete.␊ - */␊ - containerDeleteRetentionPolicy?: (DeleteRetentionPolicy3 | string)␊ - /**␊ - * Sets the CORS rules. You can include up to five CorsRule elements in the request. ␊ - */␊ - cors?: (CorsRules3 | string)␊ - /**␊ - * DefaultServiceVersion indicates the default version to use for requests to the Blob service if an incoming request’s version is not specified. Possible values include version 2008-10-27 and all more recent versions.␊ - */␊ - defaultServiceVersion?: string␊ - /**␊ - * The service properties for soft delete.␊ - */␊ - deleteRetentionPolicy?: (DeleteRetentionPolicy3 | string)␊ - /**␊ - * Versioning is enabled if set to true.␊ - */␊ - isVersioningEnabled?: (boolean | string)␊ - /**␊ - * The blob service properties for Last access time based tracking policy.␊ - */␊ - lastAccessTimeTrackingPolicy?: (LastAccessTimeTrackingPolicy | string)␊ - /**␊ - * The blob service properties for blob restore policy␊ - */␊ - restorePolicy?: (RestorePolicyProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The blob service properties for change feed events.␊ - */␊ - export interface ChangeFeed1 {␊ - /**␊ - * Indicates whether change feed event logging is enabled for the Blob service.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Indicates the duration of changeFeed retention in days. Minimum value is 1 day and maximum value is 146000 days (400 years). A null value indicates an infinite retention of the change feed.␊ - */␊ - retentionInDays?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The service properties for soft delete.␊ - */␊ - export interface DeleteRetentionPolicy3 {␊ - /**␊ - * Indicates the number of days that the deleted item should be retained. The minimum specified value can be 1 and the maximum value can be 365.␊ - */␊ - days?: (number | string)␊ - /**␊ - * Indicates whether DeleteRetentionPolicy is enabled.␊ - */␊ - enabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Sets the CORS rules. You can include up to five CorsRule elements in the request. ␊ - */␊ - export interface CorsRules3 {␊ - /**␊ - * The List of CORS rules. You can include up to five CorsRule elements in the request. ␊ - */␊ - corsRules?: (CorsRule3[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies a CORS rule for the Blob service.␊ - */␊ - export interface CorsRule3 {␊ - /**␊ - * Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request.␊ - */␊ - allowedHeaders: (string[] | string)␊ - /**␊ - * Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin.␊ - */␊ - allowedMethods: (("DELETE" | "GET" | "HEAD" | "MERGE" | "POST" | "OPTIONS" | "PUT")[] | string)␊ - /**␊ - * Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains␊ - */␊ - allowedOrigins: (string[] | string)␊ - /**␊ - * Required if CorsRule element is present. A list of response headers to expose to CORS clients.␊ - */␊ - exposedHeaders: (string[] | string)␊ - /**␊ - * Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response.␊ - */␊ - maxAgeInSeconds: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The blob service properties for Last access time based tracking policy.␊ - */␊ - export interface LastAccessTimeTrackingPolicy {␊ - /**␊ - * An array of predefined supported blob types. Only blockBlob is the supported value. This field is currently read only␊ - */␊ - blobType?: (string[] | string)␊ - /**␊ - * When set to true last access time based tracking is enabled.␊ - */␊ - enable: (boolean | string)␊ - /**␊ - * Name of the policy. The valid value is AccessTimeTracking. This field is currently read only.␊ - */␊ - name?: ("AccessTimeTracking" | string)␊ - /**␊ - * The field specifies blob object tracking granularity in days, typically how often the blob object should be tracked.This field is currently read only with value as 1␊ - */␊ - trackingGranularityInDays?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The blob service properties for blob restore policy␊ - */␊ - export interface RestorePolicyProperties {␊ - /**␊ - * how long this blob can be restored. It should be great than zero and less than DeleteRetentionPolicy.days.␊ - */␊ - days?: (number | string)␊ - /**␊ - * Blob restore is enabled if set to true.␊ - */␊ - enabled: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/fileServices␊ - */␊ - export interface StorageAccountsFileServicesChildResource1 {␊ - apiVersion: "2019-06-01"␊ - /**␊ - * The name of the file Service within the specified storage account. File Service Name must be "default"␊ - */␊ - name: "default"␊ - /**␊ - * The properties of File services in storage account.␊ - */␊ - properties: (FileServicePropertiesProperties1 | string)␊ - type: "fileServices"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of File services in storage account.␊ - */␊ - export interface FileServicePropertiesProperties1 {␊ - /**␊ - * Sets the CORS rules. You can include up to five CorsRule elements in the request. ␊ - */␊ - cors?: (CorsRules3 | string)␊ - /**␊ - * The service properties for soft delete.␊ - */␊ - shareDeleteRetentionPolicy?: (DeleteRetentionPolicy3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/queueServices␊ - */␊ - export interface StorageAccountsQueueServicesChildResource {␊ - apiVersion: "2019-06-01"␊ - /**␊ - * The name of the Queue Service within the specified storage account. Queue Service Name must be 'default'␊ - */␊ - name: "default"␊ - /**␊ - * The properties of a storage account’s Queue service.␊ - */␊ - properties: (QueueServicePropertiesProperties | string)␊ - type: "queueServices"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a storage account’s Queue service.␊ - */␊ - export interface QueueServicePropertiesProperties {␊ - /**␊ - * Sets the CORS rules. You can include up to five CorsRule elements in the request. ␊ - */␊ - cors?: (CorsRules3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/tableServices␊ - */␊ - export interface StorageAccountsTableServicesChildResource {␊ - apiVersion: "2019-06-01"␊ - /**␊ - * The name of the Table Service within the specified storage account. Table Service Name must be 'default'␊ - */␊ - name: "default"␊ - /**␊ - * The properties of a storage account’s Table service.␊ - */␊ - properties: (TableServicePropertiesProperties | string)␊ - type: "tableServices"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a storage account’s Table service.␊ - */␊ - export interface TableServicePropertiesProperties {␊ - /**␊ - * Sets the CORS rules. You can include up to five CorsRule elements in the request. ␊ - */␊ - cors?: (CorsRules3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The SKU of the storage account.␊ - */␊ - export interface Sku20 {␊ - name: (("Standard_LRS" | "Standard_GRS" | "Standard_RAGRS" | "Standard_ZRS" | "Premium_LRS" | "Premium_ZRS" | "Standard_GZRS" | "Standard_RAGZRS") | string)␊ - tier?: (("Standard" | "Premium") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/blobServices␊ - */␊ - export interface StorageAccountsBlobServices3 {␊ - apiVersion: "2019-06-01"␊ - /**␊ - * The name of the blob Service within the specified storage account. Blob Service Name must be 'default'␊ - */␊ - name: string␊ - /**␊ - * The properties of a storage account’s Blob service.␊ - */␊ - properties?: (BlobServicePropertiesProperties3 | string)␊ - resources?: StorageAccountsBlobServicesContainersChildResource3[]␊ - type: "Microsoft.Storage/storageAccounts/blobServices"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/blobServices/containers␊ - */␊ - export interface StorageAccountsBlobServicesContainersChildResource3 {␊ - apiVersion: "2019-06-01"␊ - /**␊ - * The name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.␊ - */␊ - name: string␊ - /**␊ - * The properties of a container.␊ - */␊ - properties: (ContainerProperties5 | string)␊ - type: "containers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a container.␊ - */␊ - export interface ContainerProperties5 {␊ - /**␊ - * Default the container to use specified encryption scope for all writes.␊ - */␊ - defaultEncryptionScope?: string␊ - /**␊ - * Block override of encryption scope from the container default.␊ - */␊ - denyEncryptionScopeOverride?: (boolean | string)␊ - /**␊ - * A name-value pair to associate with the container as metadata.␊ - */␊ - metadata?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Specifies whether data in the container may be accessed publicly and the level of access.␊ - */␊ - publicAccess?: (("Container" | "Blob" | "None") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/blobServices/containers␊ - */␊ - export interface StorageAccountsBlobServicesContainers5 {␊ - apiVersion: "2019-06-01"␊ - /**␊ - * The name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.␊ - */␊ - name: string␊ - /**␊ - * The properties of a container.␊ - */␊ - properties?: (ContainerProperties5 | string)␊ - resources?: StorageAccountsBlobServicesContainersImmutabilityPoliciesChildResource5[]␊ - type: "Microsoft.Storage/storageAccounts/blobServices/containers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies␊ - */␊ - export interface StorageAccountsBlobServicesContainersImmutabilityPoliciesChildResource5 {␊ - apiVersion: "2019-06-01"␊ - /**␊ - * The name of the blob container immutabilityPolicy within the specified storage account. ImmutabilityPolicy Name must be 'default'␊ - */␊ - name: "default"␊ - /**␊ - * The properties of an ImmutabilityPolicy of a blob container.␊ - */␊ - properties: (ImmutabilityPolicyProperty5 | string)␊ - type: "immutabilityPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of an ImmutabilityPolicy of a blob container.␊ - */␊ - export interface ImmutabilityPolicyProperty5 {␊ - /**␊ - * This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API␊ - */␊ - allowProtectedAppendWrites?: (boolean | string)␊ - /**␊ - * The immutability period for the blobs in the container since the policy creation, in days.␊ - */␊ - immutabilityPeriodSinceCreationInDays?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies␊ - */␊ - export interface StorageAccountsBlobServicesContainersImmutabilityPolicies5 {␊ - apiVersion: "2019-06-01"␊ - /**␊ - * The name of the blob container immutabilityPolicy within the specified storage account. ImmutabilityPolicy Name must be 'default'␊ - */␊ - name: string␊ - /**␊ - * The properties of an ImmutabilityPolicy of a blob container.␊ - */␊ - properties?: (ImmutabilityPolicyProperty5 | string)␊ - type: "Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/fileServices␊ - */␊ - export interface StorageAccountsFileServices1 {␊ - apiVersion: "2019-06-01"␊ - /**␊ - * The name of the file Service within the specified storage account. File Service Name must be "default"␊ - */␊ - name: string␊ - /**␊ - * The properties of File services in storage account.␊ - */␊ - properties?: (FileServicePropertiesProperties1 | string)␊ - resources?: StorageAccountsFileServicesSharesChildResource1[]␊ - type: "Microsoft.Storage/storageAccounts/fileServices"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/fileServices/shares␊ - */␊ - export interface StorageAccountsFileServicesSharesChildResource1 {␊ - apiVersion: "2019-06-01"␊ - /**␊ - * The name of the file share within the specified storage account. File share names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.␊ - */␊ - name: string␊ - /**␊ - * The properties of the file share.␊ - */␊ - properties: (FileShareProperties1 | string)␊ - type: "shares"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the file share.␊ - */␊ - export interface FileShareProperties1 {␊ - /**␊ - * Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium.␊ - */␊ - accessTier?: (("TransactionOptimized" | "Hot" | "Cool" | "Premium") | string)␊ - /**␊ - * The authentication protocol that is used for the file share. Can only be specified when creating a share.␊ - */␊ - enabledProtocols?: (("SMB" | "NFS") | string)␊ - /**␊ - * A name-value pair to associate with the share as metadata.␊ - */␊ - metadata?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The property is for NFS share only. The default is NoRootSquash.␊ - */␊ - rootSquash?: (("NoRootSquash" | "RootSquash" | "AllSquash") | string)␊ - /**␊ - * The maximum size of the share, in gigabytes. Must be greater than 0, and less than or equal to 5TB (5120). For Large File Shares, the maximum size is 102400.␊ - */␊ - shareQuota?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/fileServices/shares␊ - */␊ - export interface StorageAccountsFileServicesShares1 {␊ - apiVersion: "2019-06-01"␊ - /**␊ - * The name of the file share within the specified storage account. File share names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.␊ - */␊ - name: string␊ - /**␊ - * The properties of the file share.␊ - */␊ - properties?: (FileShareProperties1 | string)␊ - type: "Microsoft.Storage/storageAccounts/fileServices/shares"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/managementPolicies␊ - */␊ - export interface StorageAccountsManagementPolicies3 {␊ - apiVersion: "2019-06-01"␊ - /**␊ - * The name of the Storage Account Management Policy. It should always be 'default'␊ - */␊ - name: string␊ - /**␊ - * The Storage Account ManagementPolicy properties.␊ - */␊ - properties?: (ManagementPolicyProperties1 | string)␊ - type: "Microsoft.Storage/storageAccounts/managementPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/privateEndpointConnections␊ - */␊ - export interface StorageAccountsPrivateEndpointConnections {␊ - apiVersion: "2019-06-01"␊ - /**␊ - * The name of the private endpoint connection associated with the Azure resource␊ - */␊ - name: string␊ - /**␊ - * Properties of the PrivateEndpointConnectProperties.␊ - */␊ - properties?: (PrivateEndpointConnectionProperties3 | string)␊ - type: "Microsoft.Storage/storageAccounts/privateEndpointConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/encryptionScopes␊ - */␊ - export interface StorageAccountsEncryptionScopes {␊ - apiVersion: "2019-06-01"␊ - /**␊ - * The name of the encryption scope within the specified storage account. Encryption scope names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.␊ - */␊ - name: string␊ - /**␊ - * Properties of the encryption scope.␊ - */␊ - properties?: (EncryptionScopeProperties | string)␊ - type: "Microsoft.Storage/storageAccounts/encryptionScopes"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/objectReplicationPolicies␊ - */␊ - export interface StorageAccountsObjectReplicationPolicies {␊ - apiVersion: "2019-06-01"␊ - /**␊ - * The ID of object replication policy or 'default' if the policy ID is unknown.␊ - */␊ - name: string␊ - /**␊ - * The Storage Account ObjectReplicationPolicy properties.␊ - */␊ - properties?: (ObjectReplicationPolicyProperties | string)␊ - type: "Microsoft.Storage/storageAccounts/objectReplicationPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/queueServices␊ - */␊ - export interface StorageAccountsQueueServices {␊ - apiVersion: "2019-06-01"␊ - /**␊ - * The name of the Queue Service within the specified storage account. Queue Service Name must be 'default'␊ - */␊ - name: string␊ - /**␊ - * The properties of a storage account’s Queue service.␊ - */␊ - properties?: (QueueServicePropertiesProperties | string)␊ - resources?: StorageAccountsQueueServicesQueuesChildResource[]␊ - type: "Microsoft.Storage/storageAccounts/queueServices"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/queueServices/queues␊ - */␊ - export interface StorageAccountsQueueServicesQueuesChildResource {␊ - apiVersion: "2019-06-01"␊ - /**␊ - * A queue name must be unique within a storage account and must be between 3 and 63 characters.The name must comprise of lowercase alphanumeric and dash(-) characters only, it should begin and end with an alphanumeric character and it cannot have two consecutive dash(-) characters.␊ - */␊ - name: string␊ - properties: (QueueProperties | string)␊ - type: "queues"␊ - [k: string]: unknown␊ - }␊ - export interface QueueProperties {␊ - /**␊ - * A name-value pair that represents queue metadata.␊ - */␊ - metadata?: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/queueServices/queues␊ - */␊ - export interface StorageAccountsQueueServicesQueues {␊ - apiVersion: "2019-06-01"␊ - /**␊ - * A queue name must be unique within a storage account and must be between 3 and 63 characters.The name must comprise of lowercase alphanumeric and dash(-) characters only, it should begin and end with an alphanumeric character and it cannot have two consecutive dash(-) characters.␊ - */␊ - name: string␊ - properties?: (QueueProperties | string)␊ - type: "Microsoft.Storage/storageAccounts/queueServices/queues"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/tableServices␊ - */␊ - export interface StorageAccountsTableServices {␊ - apiVersion: "2019-06-01"␊ - /**␊ - * The name of the Table Service within the specified storage account. Table Service Name must be 'default'␊ - */␊ - name: string␊ - /**␊ - * The properties of a storage account’s Table service.␊ - */␊ - properties?: (TableServicePropertiesProperties | string)␊ - resources?: StorageAccountsTableServicesTablesChildResource[]␊ - type: "Microsoft.Storage/storageAccounts/tableServices"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/tableServices/tables␊ - */␊ - export interface StorageAccountsTableServicesTablesChildResource {␊ - apiVersion: "2019-06-01"␊ - /**␊ - * A table name must be unique within a storage account and must be between 3 and 63 characters.The name must comprise of only alphanumeric characters and it cannot begin with a numeric character.␊ - */␊ - name: string␊ - type: "tables"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/tableServices/tables␊ - */␊ - export interface StorageAccountsTableServicesTables {␊ - apiVersion: "2019-06-01"␊ - /**␊ - * A table name must be unique within a storage account and must be between 3 and 63 characters.The name must comprise of only alphanumeric characters and it cannot begin with a numeric character.␊ - */␊ - name: string␊ - type: "Microsoft.Storage/storageAccounts/tableServices/tables"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Storage/storageAccounts/inventoryPolicies␊ - */␊ - export interface StorageAccountsInventoryPolicies {␊ - apiVersion: "2019-06-01"␊ - /**␊ - * The name of the storage account blob inventory policy. It should always be 'default'␊ - */␊ - name: string␊ - /**␊ - * The storage account blob inventory policy properties.␊ - */␊ - properties?: (BlobInventoryPolicyProperties | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData | string)␊ - type: "Microsoft.Storage/storageAccounts/inventoryPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.VMwareCloudSimple/dedicatedCloudNodes␊ - */␊ - export interface DedicatedCloudNodes {␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Azure region␊ - */␊ - location: string␊ - /**␊ - * dedicated cloud node name␊ - */␊ - name: string␊ - /**␊ - * Properties of dedicated cloud node␊ - */␊ - properties: (DedicatedCloudNodeProperties | string)␊ - /**␊ - * The purchase SKU for CloudSimple paid resources␊ - */␊ - sku?: (Sku21 | string)␊ - /**␊ - * Tags model␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.VMwareCloudSimple/dedicatedCloudNodes"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of dedicated cloud node␊ - */␊ - export interface DedicatedCloudNodeProperties {␊ - /**␊ - * Availability Zone id, e.g. "az1"␊ - */␊ - availabilityZoneId: string␊ - /**␊ - * count of nodes to create␊ - */␊ - nodesCount: (number | string)␊ - /**␊ - * Placement Group id, e.g. "n1"␊ - */␊ - placementGroupId: string␊ - /**␊ - * purchase id␊ - */␊ - purchaseId: string␊ - /**␊ - * The purchase SKU for CloudSimple paid resources␊ - */␊ - skuDescription?: (SkuDescription | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The purchase SKU for CloudSimple paid resources␊ - */␊ - export interface SkuDescription {␊ - /**␊ - * SKU's id␊ - */␊ - id: string␊ - /**␊ - * SKU's name␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The purchase SKU for CloudSimple paid resources␊ - */␊ - export interface Sku21 {␊ - /**␊ - * The capacity of the SKU␊ - */␊ - capacity?: string␊ - /**␊ - * dedicatedCloudNode example: 8 x Ten-Core Intel® Xeon® Processor E5-2640 v4 2.40GHz 25MB Cache (90W); 12 x 64GB PC4-19200 2400MHz DDR4 ECC Registered DIMM, ...␊ - */␊ - description?: string␊ - /**␊ - * If the service has different generations of hardware, for the same SKU, then that can be captured here␊ - */␊ - family?: string␊ - /**␊ - * The name of the SKU for VMWare CloudSimple Node␊ - */␊ - name: string␊ - /**␊ - * The tier of the SKU␊ - */␊ - tier?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.VMwareCloudSimple/dedicatedCloudServices␊ - */␊ - export interface DedicatedCloudServices {␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Azure region␊ - */␊ - location: string␊ - /**␊ - * dedicated cloud Service name␊ - */␊ - name: string␊ - /**␊ - * Properties of dedicated cloud service␊ - */␊ - properties: (DedicatedCloudServiceProperties | string)␊ - /**␊ - * Tags model␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.VMwareCloudSimple/dedicatedCloudServices"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of dedicated cloud service␊ - */␊ - export interface DedicatedCloudServiceProperties {␊ - /**␊ - * gateway Subnet for the account. It will collect the subnet address and always treat it as /28␊ - */␊ - gatewaySubnet: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.VMwareCloudSimple/virtualMachines␊ - */␊ - export interface VirtualMachines {␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Azure region␊ - */␊ - location: string␊ - /**␊ - * virtual machine name␊ - */␊ - name: string␊ - /**␊ - * Properties of virtual machine␊ - */␊ - properties: (VirtualMachineProperties | string)␊ - /**␊ - * Tags model␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.VMwareCloudSimple/virtualMachines"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of virtual machine␊ - */␊ - export interface VirtualMachineProperties {␊ - /**␊ - * The amount of memory␊ - */␊ - amountOfRam: (number | string)␊ - /**␊ - * Guest OS Customization properties␊ - */␊ - customization?: (GuestOSCustomization | string)␊ - /**␊ - * The list of Virtual Disks␊ - */␊ - disks?: (VirtualDisk[] | string)␊ - /**␊ - * Expose Guest OS or not␊ - */␊ - exposeToGuestVM?: (boolean | string)␊ - /**␊ - * The list of Virtual NICs␊ - */␊ - nics?: (VirtualNic[] | string)␊ - /**␊ - * The number of CPU cores␊ - */␊ - numberOfCores: (number | string)␊ - /**␊ - * Password for login. Deprecated - use customization property␊ - */␊ - password?: string␊ - /**␊ - * Private Cloud Id␊ - */␊ - privateCloudId: string␊ - /**␊ - * Resource pool model␊ - */␊ - resourcePool?: (ResourcePool | string)␊ - /**␊ - * Virtual Machine Template Id␊ - */␊ - templateId?: string␊ - /**␊ - * Username for login. Deprecated - use customization property␊ - */␊ - username?: string␊ - /**␊ - * The list of Virtual VSphere Networks␊ - */␊ - vSphereNetworks?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Guest OS Customization properties␊ - */␊ - export interface GuestOSCustomization {␊ - /**␊ - * List of dns servers to use␊ - */␊ - dnsServers?: (string[] | string)␊ - /**␊ - * Virtual Machine hostname␊ - */␊ - hostName?: string␊ - /**␊ - * Password for login␊ - */␊ - password?: string␊ - /**␊ - * id of customization policy␊ - */␊ - policyId?: string␊ - /**␊ - * Username for login␊ - */␊ - username?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Virtual disk model␊ - */␊ - export interface VirtualDisk {␊ - /**␊ - * Disk's Controller id␊ - */␊ - controllerId: string␊ - /**␊ - * Disk's independence mode type.␊ - */␊ - independenceMode: (("persistent" | "independent_persistent" | "independent_nonpersistent") | string)␊ - /**␊ - * Disk's total size␊ - */␊ - totalSize: (number | string)␊ - /**␊ - * Disk's id␊ - */␊ - virtualDiskId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Virtual NIC model␊ - */␊ - export interface VirtualNic {␊ - /**␊ - * Guest OS nic customization␊ - */␊ - customization?: (GuestOSNICCustomization | string)␊ - /**␊ - * NIC ip address␊ - */␊ - ipAddresses?: (string[] | string)␊ - /**␊ - * NIC MAC address␊ - */␊ - macAddress?: string␊ - /**␊ - * Virtual network model␊ - */␊ - network: (VirtualNetwork | string)␊ - /**␊ - * NIC type.␊ - */␊ - nicType: (("E1000" | "E1000E" | "PCNET32" | "VMXNET" | "VMXNET2" | "VMXNET3") | string)␊ - /**␊ - * Is NIC powered on/off on boot␊ - */␊ - powerOnBoot?: (boolean | string)␊ - /**␊ - * NIC id␊ - */␊ - virtualNicId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Guest OS nic customization␊ - */␊ - export interface GuestOSNICCustomization {␊ - /**␊ - * IP address allocation method.␊ - */␊ - allocation?: (("static" | "dynamic") | string)␊ - /**␊ - * List of dns servers to use␊ - */␊ - dnsServers?: (string[] | string)␊ - /**␊ - * Gateway addresses assigned to nic␊ - */␊ - gateway?: (string[] | string)␊ - ipAddress?: string␊ - mask?: string␊ - primaryWinsServer?: string␊ - secondaryWinsServer?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Virtual network model␊ - */␊ - export interface VirtualNetwork {␊ - /**␊ - * virtual network id (privateCloudId:vsphereId)␊ - */␊ - id: string␊ - /**␊ - * Properties of virtual network␊ - */␊ - properties?: (VirtualNetworkProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of virtual network␊ - */␊ - export interface VirtualNetworkProperties2 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Resource pool model␊ - */␊ - export interface ResourcePool {␊ - /**␊ - * resource pool id (privateCloudId:vsphereId)␊ - */␊ - id: string␊ - /**␊ - * Properties of resource pool␊ - */␊ - properties?: (ResourcePoolProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of resource pool␊ - */␊ - export interface ResourcePoolProperties {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/availabilitySets␊ - */␊ - export interface AvailabilitySets {␊ - type: "Microsoft.Compute/availabilitySets"␊ - apiVersion: ("2015-05-01-preview" | "2015-06-15")␊ - properties: {␊ - /**␊ - * Microsoft.Compute/availabilitySets - Platform update domain count␊ - */␊ - platformUpdateDomainCount?: (number | string)␊ - /**␊ - * Microsoft.Compute/availabilitySets - Platform fault domain count␊ - */␊ - platformFaultDomainCount?: (number | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/virtualMachines/extensions␊ - */␊ - export interface Extensions {␊ - type: "Microsoft.Compute/virtualMachines/extensions"␊ - apiVersion: ("2015-05-01-preview" | "2015-06-15" | "2016-03-30")␊ - properties: (GenericExtension | IaaSDiagnostics | IaaSAntimalware | CustomScriptExtension | CustomScriptForLinux | LinuxDiagnostic | VmAccessForLinux | BgInfo | VmAccessAgent | DscExtension | AcronisBackupLinux | AcronisBackup | LinuxChefClient | ChefClient | DatadogLinuxAgent | DatadogWindowsAgent | DockerExtension | DynatraceLinux | DynatraceWindows | Eset | HpeSecurityApplicationDefender | PuppetAgent | Site24X7LinuxServerExtn | Site24X7WindowsServerExtn | Site24X7ApmInsightExtn | TrendMicroDSALinux | TrendMicroDSA | BmcCtmAgentLinux | BmcCtmAgentWindows | OSPatchingForLinux | VMSnapshot | VMSnapshotLinux | CustomScript | NetworkWatcherAgentWindows | NetworkWatcherAgentLinux)␊ - [k: string]: unknown␊ - }␊ - export interface GenericExtension {␊ - /**␊ - * Microsoft.Compute/extensions - Publisher␊ - */␊ - publisher: string␊ - /**␊ - * Microsoft.Compute/extensions - Type␊ - */␊ - type: string␊ - /**␊ - * Microsoft.Compute/extensions - Type handler version␊ - */␊ - typeHandlerVersion: string␊ - /**␊ - * Microsoft.Compute/extensions - Settings␊ - */␊ - settings: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - export interface IaaSDiagnostics {␊ - publisher: "Microsoft.Azure.Diagnostics"␊ - type: "IaaSDiagnostics"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - xmlCfg: string␊ - StorageAccount: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - storageAccountName: string␊ - storageAccountKey: string␊ - storageAccountEndPoint: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface IaaSAntimalware {␊ - publisher: "Microsoft.Azure.Security"␊ - type: "IaaSAntimalware"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - AntimalwareEnabled: boolean␊ - Exclusions: {␊ - Paths: string␊ - Extensions: string␊ - Processes: string␊ - [k: string]: unknown␊ - }␊ - RealtimeProtectionEnabled: ("true" | "false")␊ - ScheduledScanSettings: {␊ - isEnabled: ("true" | "false")␊ - scanType: string␊ - day: string␊ - time: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface CustomScriptExtension {␊ - publisher: "Microsoft.Compute"␊ - type: "CustomScriptExtension"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - fileUris?: string[]␊ - commandToExecute: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - storageAccountName?: string␊ - storageAccountKey?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface CustomScriptForLinux {␊ - publisher: "Microsoft.OSTCExtensions"␊ - type: "CustomScriptForLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - fileUris?: string[]␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - commandToExecute: string␊ - storageAccountName?: string␊ - storageAccountKey?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface LinuxDiagnostic {␊ - publisher: "Microsoft.OSTCExtensions"␊ - type: "LinuxDiagnostic"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - enableSyslog?: string␊ - mdsdHttpProxy?: string␊ - perCfg?: unknown[]␊ - fileCfg?: unknown[]␊ - xmlCfg?: string␊ - ladCfg?: {␊ - [k: string]: unknown␊ - }␊ - syslogCfg?: string␊ - eventVolume?: string␊ - mdsdCfg?: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - mdsdHttpProxy?: string␊ - storageAccountName: string␊ - storageAccountKey: string␊ - storageAccountEndPoint?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface VmAccessForLinux {␊ - publisher: "Microsoft.OSTCExtensions"␊ - type: "VMAccessForLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - check_disk?: boolean␊ - repair_disk?: boolean␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - username: string␊ - password: string␊ - ssh_key: string␊ - reset_ssh: string␊ - remove_user: string␊ - expiration: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface BgInfo {␊ - publisher: "Microsoft.Compute"␊ - type: "bginfo"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - [k: string]: unknown␊ - }␊ - export interface VmAccessAgent {␊ - publisher: "Microsoft.Compute"␊ - type: "VMAccessAgent"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - username?: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - password?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface DscExtension {␊ - publisher: "Microsoft.Powershell"␊ - type: "DSC"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - modulesUrl: string␊ - configurationFunction: string␊ - properties?: string␊ - wmfVersion?: string␊ - privacy?: {␊ - dataCollection?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - dataBlobUri?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface AcronisBackupLinux {␊ - publisher: "Acronis.Backup"␊ - type: "AcronisBackupLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - absURL: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - userLogin: string␊ - userPassword: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface AcronisBackup {␊ - publisher: "Acronis.Backup"␊ - type: "AcronisBackup"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - absURL: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - userLogin: string␊ - userPassword: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface LinuxChefClient {␊ - publisher: "Chef.Bootstrap.WindowsAzure"␊ - type: "LinuxChefClient"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - bootstrap_version?: string␊ - bootstrap_options?: {␊ - chef_node_name: string␊ - chef_server_url: string␊ - validation_client_name: string␊ - node_ssl_verify_mode: string␊ - environment: string␊ - [k: string]: unknown␊ - }␊ - runlist?: string␊ - client_rb?: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - validation_key: string␊ - chef_server_crt: string␊ - secret: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface ChefClient {␊ - publisher: "Chef.Bootstrap.WindowsAzure"␊ - type: "ChefClient"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - bootstrap_options?: {␊ - chef_node_name: string␊ - chef_server_url: string␊ - validation_client_name: string␊ - node_ssl_verify_mode: string␊ - environment: string␊ - [k: string]: unknown␊ - }␊ - runlist?: string␊ - client_rb?: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - validation_key: string␊ - chef_server_crt: string␊ - secret: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface DatadogLinuxAgent {␊ - publisher: "Datadog.Agent"␊ - type: "DatadogLinuxAgent"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - api_key: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface DatadogWindowsAgent {␊ - publisher: "Datadog.Agent"␊ - type: "DatadogWindowsAgent"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - api_key: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface DockerExtension {␊ - publisher: "Microsoft.Azure.Extensions"␊ - type: "DockerExtension"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - docker: {␊ - port: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - certs: {␊ - ca: string␊ - cert: string␊ - key: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface DynatraceLinux {␊ - publisher: "dynatrace.ruxit"␊ - type: "ruxitAgentLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - tenantId: string␊ - token: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface DynatraceWindows {␊ - publisher: "dynatrace.ruxit"␊ - type: "ruxitAgentWindows"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - tenantId: string␊ - token: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Eset {␊ - publisher: "ESET"␊ - type: "FileSecurity"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - LicenseKey: string␊ - "Install-RealtimeProtection": boolean␊ - "Install-ProtocolFiltering": boolean␊ - "Install-DeviceControl": boolean␊ - "Enable-Cloud": boolean␊ - "Enable-PUA": boolean␊ - ERAAgentCfgUrl: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface HpeSecurityApplicationDefender {␊ - publisher: "HPE.Security.ApplicationDefender"␊ - type: "DotnetAgent"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - protectedSettings: {␊ - key: string␊ - serverURL: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface PuppetAgent {␊ - publisher: "Puppet"␊ - type: "PuppetAgent"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - protectedSettings: {␊ - PUPPET_MASTER_SERVER: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Site24X7LinuxServerExtn {␊ - publisher: "Site24x7"␊ - type: "Site24x7LinuxServerExtn"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - site24x7AgentType?: "azurevmextnlinuxserver"␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - site24x7LicenseKey: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Site24X7WindowsServerExtn {␊ - publisher: "Site24x7"␊ - type: "Site24x7WindowsServerExtn"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - site24x7AgentType?: "azurevmextnwindowsserver"␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - site24x7LicenseKey: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Site24X7ApmInsightExtn {␊ - publisher: "Site24x7"␊ - type: "Site24x7ApmInsightExtn"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - site24x7AgentType?: "azurevmextnapminsightclassic"␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - site24x7LicenseKey: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface TrendMicroDSALinux {␊ - publisher: "TrendMicro.DeepSecurity"␊ - type: "TrendMicroDSALinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - DSMname: string␊ - DSMport: string␊ - policyNameorID?: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - tenantID: string␊ - tenantPassword: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface TrendMicroDSA {␊ - publisher: "TrendMicro.DeepSecurity"␊ - type: "TrendMicroDSA"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - DSMname: string␊ - DSMport: string␊ - policyNameorID?: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - tenantID: string␊ - tenantPassword: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface BmcCtmAgentLinux {␊ - publisher: "ctm.bmc.com"␊ - type: "BmcCtmAgentLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - "Control-M Server Name": string␊ - "Agent Port": string␊ - "Host Group": string␊ - "User Account": string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface BmcCtmAgentWindows {␊ - publisher: "bmc.ctm"␊ - type: "AgentWinExt"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - "Control-M Server Name": string␊ - "Agent Port": string␊ - "Host Group": string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface OSPatchingForLinux {␊ - publisher: "Microsoft.OSTCExtensions"␊ - type: "OSPatchingForLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - disabled: boolean␊ - stop: boolean␊ - installDuration?: string␊ - intervalOfWeeks?: number␊ - dayOfWeek?: string␊ - startTime?: string␊ - rebootAfterPatch?: string␊ - category?: string␊ - oneoff?: boolean␊ - local?: boolean␊ - idleTestScript?: string␊ - healthyTestScript?: string␊ - distUpgradeList?: string␊ - distUpgradeAll?: boolean␊ - vmStatusTest?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - storageAccountName?: string␊ - storageAccountKey?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface VMSnapshot {␊ - publisher: "Microsoft.Azure.RecoveryServices"␊ - type: "VMSnapshot"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - locale: string␊ - taskId: string␊ - commandToExecute: string␊ - objectStr: string␊ - logsBlobUri: string␊ - statusBlobUri: string␊ - commandStartTimeUTCTicks: string␊ - vmType: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface VMSnapshotLinux {␊ - publisher: "Microsoft.Azure.RecoveryServices"␊ - type: "VMSnapshotLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - locale: string␊ - taskId: string␊ - commandToExecute: string␊ - objectStr: string␊ - logsBlobUri: string␊ - statusBlobUri: string␊ - commandStartTimeUTCTicks: string␊ - vmType: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface CustomScript {␊ - publisher: "Microsoft.Azure.Extensions"␊ - type: "CustomScript"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - fileUris: string[]␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - storageAccountName: string␊ - storageAccountKey: string␊ - commandToExecute: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface NetworkWatcherAgentWindows {␊ - publisher: "Microsoft.Azure.NetworkWatcher"␊ - type: "NetworkWatcherAgentWindows"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - [k: string]: unknown␊ - }␊ - export interface NetworkWatcherAgentLinux {␊ - publisher: "Microsoft.Azure.NetworkWatcher"␊ - type: "NetworkWatcherAgentLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/virtualMachineScaleSets␊ - */␊ - export interface VirtualMachineScaleSets {␊ - type: "Microsoft.Compute/virtualMachineScaleSets"␊ - apiVersion: ("2015-05-01-preview" | "2015-06-15")␊ - sku: Sku22␊ - properties: {␊ - /**␊ - * Microsoft.Compute/virtualMachineScaleSets - Upgrade policy␊ - */␊ - upgradePolicy: (UpgradePolicy | string)␊ - /**␊ - * Microsoft.Compute/virtualMachineScaleSets - Virtual machine policy␊ - */␊ - virtualMachineProfile: (VirtualMachineProfile | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Sku22 {␊ - name: string␊ - tier?: string␊ - capacity: (string | number)␊ - [k: string]: unknown␊ - }␊ - export interface UpgradePolicy {␊ - mode: string␊ - [k: string]: unknown␊ - }␊ - export interface VirtualMachineProfile {␊ - osProfile: VirtualMachineScaleSetOsProfile␊ - storageProfile: VirtualMachineScaleSetStorageProfile␊ - extensionProfile?: VirtualMachineScaleSetExtensionProfile␊ - networkProfile: VirtualMachineScaleSetNetworkProfile␊ - [k: string]: unknown␊ - }␊ - export interface VirtualMachineScaleSetOsProfile {␊ - computerNamePrefix: string␊ - adminUsername: string␊ - adminPassword: string␊ - customData?: string␊ - windowsConfiguration?: WindowsConfiguration␊ - linuxConfiguration?: LinuxConfiguration␊ - secrets?: Secret[]␊ - [k: string]: unknown␊ - }␊ - export interface WindowsConfiguration {␊ - provisionVMAgent?: boolean␊ - winRM?: WinRM␊ - additionalUnattendContent?: AdditionalUnattendContent[]␊ - enableAutomaticUpdates?: boolean␊ - timeZone?: string␊ - [k: string]: unknown␊ - }␊ - export interface WinRM {␊ - listeners: WinRMListener[]␊ - [k: string]: unknown␊ - }␊ - export interface WinRMListener {␊ - protocol: (("Http" | "Https") | string)␊ - certificateUrl: string␊ - [k: string]: unknown␊ - }␊ - export interface AdditionalUnattendContent {␊ - pass: string␊ - component: string␊ - settingName: string␊ - content: string␊ - [k: string]: unknown␊ - }␊ - export interface LinuxConfiguration {␊ - disablePasswordAuthentication?: (string | boolean)␊ - ssh?: Ssh␊ - [k: string]: unknown␊ - }␊ - export interface Ssh {␊ - publicKeys?: PublicKey[]␊ - [k: string]: unknown␊ - }␊ - export interface PublicKey {␊ - path?: string␊ - keyData?: string␊ - [k: string]: unknown␊ - }␊ - export interface Secret {␊ - sourceVault: Id␊ - vaultCertificates: VaultCertificateUrl[]␊ - [k: string]: unknown␊ - }␊ - export interface Id {␊ - id: string␊ - [k: string]: unknown␊ - }␊ - export interface VaultCertificateUrl {␊ - certificateUrl: string␊ - [k: string]: unknown␊ - }␊ - export interface VirtualMachineScaleSetStorageProfile {␊ - imageReference?: (ImageReference | string)␊ - osDisk: VirtualMachineScaleSetOSDisk␊ - [k: string]: unknown␊ - }␊ - export interface ImageReference {␊ - publisher: string␊ - offer: string␊ - sku: string␊ - version: string␊ - [k: string]: unknown␊ - }␊ - export interface VirtualMachineScaleSetOSDisk {␊ - osType?: string␊ - name: string␊ - vhdContainers?: string[]␊ - caching?: string␊ - createOption: (("FromImage" | "Empty" | "Attach") | string)␊ - [k: string]: unknown␊ - }␊ - export interface VirtualMachineScaleSetExtensionProfile {␊ - extensions?: VirtualMachineScaleSetExtension[]␊ - [k: string]: unknown␊ - }␊ - export interface VirtualMachineScaleSetExtension {␊ - name?: string␊ - properties?: {␊ - publisher: string␊ - type: string␊ - typeHandlerVersion: string␊ - settings?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface VirtualMachineScaleSetNetworkProfile {␊ - networkInterfaceConfigurations: NetworkInterfaceConfiguration[]␊ - [k: string]: unknown␊ - }␊ - export interface NetworkInterfaceConfiguration {␊ - name: string␊ - properties: {␊ - primary: boolean␊ - ipConfigurations: IpConfiguration[]␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface IpConfiguration {␊ - name: string␊ - properties?: {␊ - subnet?: Id␊ - loadBalancerBackendAddressPools?: Id[]␊ - loadBalancerInboundNatPools?: Id[]␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Scheduler/jobCollections␊ - */␊ - export interface JobCollections {␊ - apiVersion: "2014-08-01-preview"␊ - /**␊ - * Gets or sets the storage account location.␊ - */␊ - location?: string␊ - /**␊ - * The job collection name.␊ - */␊ - name: string␊ - properties: (JobCollectionProperties | string)␊ - resources?: JobCollectionsJobsChildResource[]␊ - /**␊ - * Gets or sets the tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Scheduler/jobCollections"␊ - [k: string]: unknown␊ - }␊ - export interface JobCollectionProperties {␊ - quota?: (JobCollectionQuota | string)␊ - sku?: (Sku23 | string)␊ - /**␊ - * Gets or sets the state.␊ - */␊ - state?: (("Enabled" | "Disabled" | "Suspended" | "Deleted") | string)␊ - [k: string]: unknown␊ - }␊ - export interface JobCollectionQuota {␊ - /**␊ - * Gets or set the maximum job count.␊ - */␊ - maxJobCount?: (number | string)␊ - /**␊ - * Gets or sets the maximum job occurrence.␊ - */␊ - maxJobOccurrence?: (number | string)␊ - maxRecurrence?: (JobMaxRecurrence | string)␊ - [k: string]: unknown␊ - }␊ - export interface JobMaxRecurrence {␊ - /**␊ - * Gets or sets the frequency of recurrence (second, minute, hour, day, week, month).␊ - */␊ - frequency?: (("Minute" | "Hour" | "Day" | "Week" | "Month") | string)␊ - /**␊ - * Gets or sets the interval between retries.␊ - */␊ - interval?: (number | string)␊ - [k: string]: unknown␊ - }␊ - export interface Sku23 {␊ - /**␊ - * Gets or set the SKU.␊ - */␊ - name?: (("Standard" | "Free" | "Premium") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Scheduler/jobCollections/jobs␊ - */␊ - export interface JobCollectionsJobsChildResource {␊ - apiVersion: "2014-08-01-preview"␊ - /**␊ - * The job name.␊ - */␊ - name: string␊ - properties: (JobProperties | string)␊ - type: "jobs"␊ - [k: string]: unknown␊ - }␊ - export interface JobProperties {␊ - action?: (JobAction | string)␊ - recurrence?: (JobRecurrence | string)␊ - /**␊ - * Gets or sets the job start time.␊ - */␊ - startTime?: string␊ - /**␊ - * Gets or set the job state.␊ - */␊ - state?: (("Enabled" | "Disabled" | "Faulted" | "Completed") | string)␊ - [k: string]: unknown␊ - }␊ - export interface JobAction {␊ - errorAction?: (JobErrorAction | string)␊ - queueMessage?: (StorageQueueMessage | string)␊ - request?: (HttpRequest | string)␊ - retryPolicy?: (RetryPolicy | string)␊ - serviceBusQueueMessage?: (ServiceBusQueueMessage | string)␊ - serviceBusTopicMessage?: (ServiceBusTopicMessage | string)␊ - /**␊ - * Gets or sets the job action type.␊ - */␊ - type?: (("Http" | "Https" | "StorageQueue" | "ServiceBusQueue" | "ServiceBusTopic") | string)␊ - [k: string]: unknown␊ - }␊ - export interface JobErrorAction {␊ - queueMessage?: (StorageQueueMessage | string)␊ - request?: (HttpRequest | string)␊ - retryPolicy?: (RetryPolicy | string)␊ - serviceBusQueueMessage?: (ServiceBusQueueMessage | string)␊ - serviceBusTopicMessage?: (ServiceBusTopicMessage | string)␊ - /**␊ - * Gets or sets the job error action type.␊ - */␊ - type?: (("Http" | "Https" | "StorageQueue" | "ServiceBusQueue" | "ServiceBusTopic") | string)␊ - [k: string]: unknown␊ - }␊ - export interface StorageQueueMessage {␊ - /**␊ - * Gets or sets the message.␊ - */␊ - message?: string␊ - /**␊ - * Gets or sets the queue name.␊ - */␊ - queueName?: string␊ - /**␊ - * Gets or sets the SAS key.␊ - */␊ - sasToken?: string␊ - /**␊ - * Gets or sets the storage account name.␊ - */␊ - storageAccount?: string␊ - [k: string]: unknown␊ - }␊ - export interface HttpRequest {␊ - authentication?: (HttpAuthentication | string)␊ - /**␊ - * Gets or sets the request body.␊ - */␊ - body?: string␊ - /**␊ - * Gets or sets the headers.␊ - */␊ - headers?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Gets or sets the method of the request.␊ - */␊ - method?: string␊ - /**␊ - * Gets or sets the Uri.␊ - */␊ - uri?: string␊ - [k: string]: unknown␊ - }␊ - export interface HttpAuthentication {␊ - /**␊ - * Gets or sets the http authentication type.␊ - */␊ - type?: (("NotSpecified" | "ClientCertificate" | "ActiveDirectoryOAuth" | "Basic") | string)␊ - [k: string]: unknown␊ - }␊ - export interface RetryPolicy {␊ - /**␊ - * Gets or sets the number of times a retry should be attempted.␊ - */␊ - retryCount?: (number | string)␊ - /**␊ - * Gets or sets the retry interval between retries.␊ - */␊ - retryInterval?: string␊ - /**␊ - * Gets or sets the retry strategy to be used.␊ - */␊ - retryType?: (("None" | "Fixed") | string)␊ - [k: string]: unknown␊ - }␊ - export interface ServiceBusQueueMessage {␊ - authentication?: (ServiceBusAuthentication | string)␊ - brokeredMessageProperties?: (ServiceBusBrokeredMessageProperties | string)␊ - /**␊ - * Gets or sets the custom message properties.␊ - */␊ - customMessageProperties?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Gets or sets the message.␊ - */␊ - message?: string␊ - /**␊ - * Gets or sets the namespace.␊ - */␊ - namespace?: string␊ - /**␊ - * Gets or sets the queue name.␊ - */␊ - queueName?: string␊ - /**␊ - * Gets or sets the transport type.␊ - */␊ - transportType?: (("NotSpecified" | "NetMessaging" | "AMQP") | string)␊ - [k: string]: unknown␊ - }␊ - export interface ServiceBusAuthentication {␊ - /**␊ - * Gets or sets the SAS key.␊ - */␊ - sasKey?: string␊ - /**␊ - * Gets or sets the SAS key name.␊ - */␊ - sasKeyName?: string␊ - /**␊ - * Gets or sets the authentication type.␊ - */␊ - type?: (("NotSpecified" | "SharedAccessKey") | string)␊ - [k: string]: unknown␊ - }␊ - export interface ServiceBusBrokeredMessageProperties {␊ - /**␊ - * Gets or sets the content type.␊ - */␊ - contentType?: string␊ - /**␊ - * Gets or sets the correlation id.␊ - */␊ - correlationId?: string␊ - /**␊ - * Gets or sets the force persistence.␊ - */␊ - forcePersistence?: (boolean | string)␊ - /**␊ - * Gets or sets the label.␊ - */␊ - label?: string␊ - /**␊ - * Gets or sets the message id.␊ - */␊ - messageId?: string␊ - /**␊ - * Gets or sets the partition key.␊ - */␊ - partitionKey?: string␊ - /**␊ - * Gets or sets the reply to.␊ - */␊ - replyTo?: string␊ - /**␊ - * Gets or sets the reply to session id.␊ - */␊ - replyToSessionId?: string␊ - /**␊ - * Gets or sets the scheduled enqueue time UTC.␊ - */␊ - scheduledEnqueueTimeUtc?: string␊ - /**␊ - * Gets or sets the session id.␊ - */␊ - sessionId?: string␊ - /**␊ - * Gets or sets the time to live.␊ - */␊ - timeToLive?: string␊ - /**␊ - * Gets or sets the to.␊ - */␊ - to?: string␊ - /**␊ - * Gets or sets the via partition key.␊ - */␊ - viaPartitionKey?: string␊ - [k: string]: unknown␊ - }␊ - export interface ServiceBusTopicMessage {␊ - authentication?: (ServiceBusAuthentication | string)␊ - brokeredMessageProperties?: (ServiceBusBrokeredMessageProperties | string)␊ - /**␊ - * Gets or sets the custom message properties.␊ - */␊ - customMessageProperties?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Gets or sets the message.␊ - */␊ - message?: string␊ - /**␊ - * Gets or sets the namespace.␊ - */␊ - namespace?: string␊ - /**␊ - * Gets or sets the topic path.␊ - */␊ - topicPath?: string␊ - /**␊ - * Gets or sets the transport type.␊ - */␊ - transportType?: (("NotSpecified" | "NetMessaging" | "AMQP") | string)␊ - [k: string]: unknown␊ - }␊ - export interface JobRecurrence {␊ - /**␊ - * Gets or sets the maximum number of times that the job should run.␊ - */␊ - count?: (number | string)␊ - /**␊ - * Gets or sets the time at which the job will complete.␊ - */␊ - endTime?: string␊ - /**␊ - * Gets or sets the frequency of recurrence (second, minute, hour, day, week, month).␊ - */␊ - frequency?: (("Minute" | "Hour" | "Day" | "Week" | "Month") | string)␊ - /**␊ - * Gets or sets the interval between retries.␊ - */␊ - interval?: (number | string)␊ - schedule?: (JobRecurrenceSchedule | string)␊ - [k: string]: unknown␊ - }␊ - export interface JobRecurrenceSchedule {␊ - /**␊ - * Gets or sets the hours of the day that the job should execute at.␊ - */␊ - hours?: (number[] | string)␊ - /**␊ - * Gets or sets the minutes of the hour that the job should execute at.␊ - */␊ - minutes?: (number[] | string)␊ - /**␊ - * Gets or sets the days of the month that the job should execute on. Must be between 1 and 31.␊ - */␊ - monthDays?: (number[] | string)␊ - /**␊ - * Gets or sets the occurrences of days within a month.␊ - */␊ - monthlyOccurrences?: (JobRecurrenceScheduleMonthlyOccurrence[] | string)␊ - /**␊ - * Gets or sets the days of the week that the job should execute on.␊ - */␊ - weekDays?: (("Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday" | "Sunday")[] | string)␊ - [k: string]: unknown␊ - }␊ - export interface JobRecurrenceScheduleMonthlyOccurrence {␊ - /**␊ - * Gets or sets the day. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.␊ - */␊ - day?: (("Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday" | "Sunday") | string)␊ - /**␊ - * Gets or sets the occurrence. Must be between -5 and 5.␊ - */␊ - Occurrence?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/virtualMachines␊ - */␊ - export interface VirtualMachines1 {␊ - type: "Microsoft.Compute/virtualMachines"␊ - apiVersion: ("2015-05-01-preview" | "2015-06-15")␊ - properties: {␊ - /**␊ - * Microsoft.Compute/virtualMachines - Availability set␊ - */␊ - availabilitySet?: (Id | string)␊ - /**␊ - * Microsoft.Compute/virtualMachines - Hardware profile␊ - */␊ - hardwareProfile: (HardwareProfile | string)␊ - /**␊ - * Microsoft.Compute/virtualMachines - Storage profile␊ - */␊ - storageProfile: (StorageProfile | string)␊ - /**␊ - * Mirosoft.Compute/virtualMachines - Operating system profile␊ - */␊ - osProfile?: (OsProfile | string)␊ - /**␊ - * Microsoft.Compute/virtualMachines - Network profile␊ - */␊ - networkProfile: (NetworkProfile | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/virtualMachines: Resource Definition for Virtual Machines.␊ - */␊ - resources?: ((ARMResourceBase1 & {␊ - /**␊ - * Location to deploy resource to␊ - */␊ - location?: (string | ("East Asia" | "Southeast Asia" | "Central US" | "East US" | "East US 2" | "West US" | "North Central US" | "South Central US" | "North Europe" | "West Europe" | "Japan West" | "Japan East" | "Brazil South" | "Australia East" | "Australia Southeast" | "Central India" | "West India" | "South India" | "Canada Central" | "Canada East" | "West Central US" | "West US 2" | "UK South" | "UK West" | "Korea Central" | "Korea South" | "global"))␊ - /**␊ - * Name-value pairs to add to the resource␊ - */␊ - tags?: {␊ - [k: string]: unknown␊ - }␊ - copy?: ResourceCopy1␊ - comments?: string␊ - [k: string]: unknown␊ - }) & ExtensionsChild)[]␊ - [k: string]: unknown␊ - }␊ - export interface HardwareProfile {␊ - vmSize: string␊ - [k: string]: unknown␊ - }␊ - export interface StorageProfile {␊ - imageReference?: (ImageReference | string)␊ - osDisk: OsDisk␊ - dataDisks?: DataDisk[]␊ - [k: string]: unknown␊ - }␊ - export interface OsDisk {␊ - name: string␊ - vhd: Vhd␊ - image?: Vhd␊ - caching?: string␊ - createOption: (("FromImage" | "Empty" | "Attach") | string)␊ - [k: string]: unknown␊ - }␊ - export interface Vhd {␊ - uri: string␊ - [k: string]: unknown␊ - }␊ - export interface DataDisk {␊ - name: string␊ - diskSizeGB?: string␊ - lun: number␊ - vhd: VhdUri␊ - caching?: string␊ - createOption: (("FromImage" | "Empty" | "Attach") | string)␊ - [k: string]: unknown␊ - }␊ - export interface VhdUri {␊ - uri: string␊ - [k: string]: unknown␊ - }␊ - export interface OsProfile {␊ - computerName: string␊ - adminUsername: string␊ - adminPassword: string␊ - customData?: string␊ - windowsConfiguration?: WindowsConfiguration␊ - linuxConfiguration?: LinuxConfiguration␊ - secrets?: Secret[]␊ - [k: string]: unknown␊ - }␊ - export interface NetworkProfile {␊ - networkInterfaces: NetworkInterfaces[]␊ - [k: string]: unknown␊ - }␊ - export interface NetworkInterfaces {␊ - id: string␊ - properties?: {␊ - primary: boolean␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface ARMResourceBase1 {␊ - /**␊ - * Name of the resource␊ - */␊ - name: string␊ - /**␊ - * Resource type␊ - */␊ - type: string␊ - /**␊ - * Condition of the resource␊ - */␊ - condition?: (boolean | string)␊ - /**␊ - * API Version of the resource type, optional when apiProfile is used on the template␊ - */␊ - apiVersion?: string␊ - /**␊ - * Collection of resources this resource depends on␊ - */␊ - dependsOn?: string[]␊ - [k: string]: unknown␊ - }␊ - export interface ResourceCopy1 {␊ - /**␊ - * Name of the copy␊ - */␊ - name?: string␊ - /**␊ - * Count of the copy␊ - */␊ - count?: (string | number)␊ - /**␊ - * The copy mode␊ - */␊ - mode?: ("Parallel" | "Serial")␊ - /**␊ - * The serial copy batch size␊ - */␊ - batchSize?: (string | number)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/extensionsChild␊ - */␊ - export interface ExtensionsChild {␊ - type: "extensions"␊ - apiVersion: ("2015-05-01-preview" | "2015-06-15" | "2016-03-30")␊ - properties: (GenericExtension | IaaSDiagnostics | IaaSAntimalware | CustomScriptExtension | CustomScriptForLinux | LinuxDiagnostic | VmAccessForLinux | BgInfo | VmAccessAgent | DscExtension | AcronisBackupLinux | AcronisBackup | LinuxChefClient | ChefClient | DatadogLinuxAgent | DatadogWindowsAgent | DockerExtension | DynatraceLinux | DynatraceWindows | Eset | HpeSecurityApplicationDefender | PuppetAgent | Site24X7LinuxServerExtn | Site24X7WindowsServerExtn | Site24X7ApmInsightExtn | TrendMicroDSALinux | TrendMicroDSA | BmcCtmAgentLinux | BmcCtmAgentWindows | OSPatchingForLinux | VMSnapshot | VMSnapshotLinux | CustomScript | NetworkWatcherAgentWindows | NetworkWatcherAgentLinux)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataLakeStore/accounts␊ - */␊ - export interface Accounts1 {␊ - apiVersion: "2015-10-01-preview"␊ - identity?: (EncryptionIdentity | string)␊ - /**␊ - * the account regional location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the Data Lake Store account to create.␊ - */␊ - name: string␊ - /**␊ - * Data Lake Store account properties information␊ - */␊ - properties: (DataLakeStoreAccountProperties | string)␊ - resources?: AccountsFirewallRulesChildResource[]␊ - /**␊ - * the value of custom properties.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.DataLakeStore/accounts"␊ - [k: string]: unknown␊ - }␊ - export interface EncryptionIdentity {␊ - /**␊ - * The type of encryption being used. Currently the only supported type is 'SystemAssigned'.␊ - */␊ - type?: ("SystemAssigned" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Data Lake Store account properties information␊ - */␊ - export interface DataLakeStoreAccountProperties {␊ - /**␊ - * the default owner group for all new folders and files created in the Data Lake Store account.␊ - */␊ - defaultGroup?: string␊ - encryptionConfig?: (EncryptionConfig | string)␊ - /**␊ - * The current state of encryption for this Data Lake store account.␊ - */␊ - encryptionState?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * the gateway host.␊ - */␊ - endpoint?: string␊ - [k: string]: unknown␊ - }␊ - export interface EncryptionConfig {␊ - keyVaultMetaInfo?: (KeyVaultMetaInfo | string)␊ - /**␊ - * The type of encryption configuration being used. Currently the only supported types are 'UserManaged' and 'ServiceManaged'.␊ - */␊ - type?: (("UserManaged" | "ServiceManaged") | string)␊ - [k: string]: unknown␊ - }␊ - export interface KeyVaultMetaInfo {␊ - /**␊ - * The name of the user managed encryption key.␊ - */␊ - encryptionKeyName?: string␊ - /**␊ - * The version of the user managed encryption key.␊ - */␊ - encryptionKeyVersion?: string␊ - /**␊ - * The resource identifier for the user managed Key Vault being used to encrypt.␊ - */␊ - keyVaultResourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataLakeStore/accounts/firewallRules␊ - */␊ - export interface AccountsFirewallRulesChildResource {␊ - apiVersion: "2015-10-01-preview"␊ - /**␊ - * the firewall rule's subscription ID.␊ - */␊ - id?: string␊ - /**␊ - * the firewall rule's regional location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the firewall rule to create or update.␊ - */␊ - name: string␊ - /**␊ - * Data Lake Store firewall rule properties information␊ - */␊ - properties: (FirewallRuleProperties | string)␊ - type: "firewallRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Data Lake Store firewall rule properties information␊ - */␊ - export interface FirewallRuleProperties {␊ - /**␊ - * the end IP address for the firewall rule.␊ - */␊ - endIpAddress?: string␊ - /**␊ - * the start IP address for the firewall rule.␊ - */␊ - startIpAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataLakeStore/accounts␊ - */␊ - export interface Accounts2 {␊ - apiVersion: "2016-11-01"␊ - /**␊ - * The encryption identity properties.␊ - */␊ - identity?: (EncryptionIdentity1 | string)␊ - /**␊ - * The resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the Data Lake Store account.␊ - */␊ - name: string␊ - properties: (CreateDataLakeStoreAccountProperties | string)␊ - resources?: (AccountsFirewallRulesChildResource1 | AccountsVirtualNetworkRulesChildResource | AccountsTrustedIdProvidersChildResource)[]␊ - /**␊ - * The resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.DataLakeStore/accounts"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encryption identity properties.␊ - */␊ - export interface EncryptionIdentity1 {␊ - /**␊ - * The type of encryption being used. Currently the only supported type is 'SystemAssigned'.␊ - */␊ - type: ("SystemAssigned" | string)␊ - [k: string]: unknown␊ - }␊ - export interface CreateDataLakeStoreAccountProperties {␊ - /**␊ - * The default owner group for all new folders and files created in the Data Lake Store account.␊ - */␊ - defaultGroup?: string␊ - /**␊ - * The encryption configuration for the account.␊ - */␊ - encryptionConfig?: (EncryptionConfig1 | string)␊ - /**␊ - * The current state of encryption for this Data Lake Store account.␊ - */␊ - encryptionState?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * The current state of allowing or disallowing IPs originating within Azure through the firewall. If the firewall is disabled, this is not enforced.␊ - */␊ - firewallAllowAzureIps?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * The list of firewall rules associated with this Data Lake Store account.␊ - */␊ - firewallRules?: (CreateFirewallRuleWithAccountParameters[] | string)␊ - /**␊ - * The current state of the IP address firewall for this Data Lake Store account.␊ - */␊ - firewallState?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * The commitment tier to use for next month.␊ - */␊ - newTier?: (("Consumption" | "Commitment_1TB" | "Commitment_10TB" | "Commitment_100TB" | "Commitment_500TB" | "Commitment_1PB" | "Commitment_5PB") | string)␊ - /**␊ - * The list of trusted identity providers associated with this Data Lake Store account.␊ - */␊ - trustedIdProviders?: (CreateTrustedIdProviderWithAccountParameters[] | string)␊ - /**␊ - * The current state of the trusted identity provider feature for this Data Lake Store account.␊ - */␊ - trustedIdProviderState?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * The list of virtual network rules associated with this Data Lake Store account.␊ - */␊ - virtualNetworkRules?: (CreateVirtualNetworkRuleWithAccountParameters[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encryption configuration for the account.␊ - */␊ - export interface EncryptionConfig1 {␊ - /**␊ - * Metadata information used by account encryption.␊ - */␊ - keyVaultMetaInfo?: (KeyVaultMetaInfo1 | string)␊ - /**␊ - * The type of encryption configuration being used. Currently the only supported types are 'UserManaged' and 'ServiceManaged'.␊ - */␊ - type: (("UserManaged" | "ServiceManaged") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Metadata information used by account encryption.␊ - */␊ - export interface KeyVaultMetaInfo1 {␊ - /**␊ - * The name of the user managed encryption key.␊ - */␊ - encryptionKeyName: string␊ - /**␊ - * The version of the user managed encryption key.␊ - */␊ - encryptionKeyVersion: string␊ - /**␊ - * The resource identifier for the user managed Key Vault being used to encrypt.␊ - */␊ - keyVaultResourceId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The parameters used to create a new firewall rule while creating a new Data Lake Store account.␊ - */␊ - export interface CreateFirewallRuleWithAccountParameters {␊ - /**␊ - * The unique name of the firewall rule to create.␊ - */␊ - name: string␊ - /**␊ - * The firewall rule properties to use when creating a new firewall rule.␊ - */␊ - properties: (CreateOrUpdateFirewallRuleProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The firewall rule properties to use when creating a new firewall rule.␊ - */␊ - export interface CreateOrUpdateFirewallRuleProperties {␊ - /**␊ - * The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol.␊ - */␊ - endIpAddress: string␊ - /**␊ - * The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol.␊ - */␊ - startIpAddress: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The parameters used to create a new trusted identity provider while creating a new Data Lake Store account.␊ - */␊ - export interface CreateTrustedIdProviderWithAccountParameters {␊ - /**␊ - * The unique name of the trusted identity provider to create.␊ - */␊ - name: string␊ - /**␊ - * The trusted identity provider properties to use when creating a new trusted identity provider.␊ - */␊ - properties: (CreateOrUpdateTrustedIdProviderProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The trusted identity provider properties to use when creating a new trusted identity provider.␊ - */␊ - export interface CreateOrUpdateTrustedIdProviderProperties {␊ - /**␊ - * The URL of this trusted identity provider.␊ - */␊ - idProvider: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The parameters used to create a new virtual network rule while creating a new Data Lake Store account.␊ - */␊ - export interface CreateVirtualNetworkRuleWithAccountParameters {␊ - /**␊ - * The unique name of the virtual network rule to create.␊ - */␊ - name: string␊ - /**␊ - * The virtual network rule properties to use when creating a new virtual network rule.␊ - */␊ - properties: (CreateOrUpdateVirtualNetworkRuleProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The virtual network rule properties to use when creating a new virtual network rule.␊ - */␊ - export interface CreateOrUpdateVirtualNetworkRuleProperties {␊ - /**␊ - * The resource identifier for the subnet.␊ - */␊ - subnetId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataLakeStore/accounts/firewallRules␊ - */␊ - export interface AccountsFirewallRulesChildResource1 {␊ - apiVersion: "2016-11-01"␊ - /**␊ - * The name of the firewall rule to create or update.␊ - */␊ - name: string␊ - /**␊ - * The firewall rule properties to use when creating a new firewall rule.␊ - */␊ - properties: (CreateOrUpdateFirewallRuleProperties | string)␊ - type: "firewallRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataLakeStore/accounts/virtualNetworkRules␊ - */␊ - export interface AccountsVirtualNetworkRulesChildResource {␊ - apiVersion: "2016-11-01"␊ - /**␊ - * The name of the virtual network rule to create or update.␊ - */␊ - name: string␊ - /**␊ - * The virtual network rule properties to use when creating a new virtual network rule.␊ - */␊ - properties: (CreateOrUpdateVirtualNetworkRuleProperties | string)␊ - type: "virtualNetworkRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataLakeStore/accounts/trustedIdProviders␊ - */␊ - export interface AccountsTrustedIdProvidersChildResource {␊ - apiVersion: "2016-11-01"␊ - /**␊ - * The name of the trusted identity provider. This is used for differentiation of providers in the account.␊ - */␊ - name: string␊ - /**␊ - * The trusted identity provider properties to use when creating a new trusted identity provider.␊ - */␊ - properties: (CreateOrUpdateTrustedIdProviderProperties | string)␊ - type: "trustedIdProviders"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataLakeStore/accounts/firewallRules␊ - */␊ - export interface AccountsFirewallRules {␊ - apiVersion: "2016-11-01"␊ - /**␊ - * The name of the firewall rule to create or update.␊ - */␊ - name: string␊ - /**␊ - * The firewall rule properties to use when creating a new firewall rule.␊ - */␊ - properties: (CreateOrUpdateFirewallRuleProperties | string)␊ - type: "Microsoft.DataLakeStore/accounts/firewallRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataLakeStore/accounts/trustedIdProviders␊ - */␊ - export interface AccountsTrustedIdProviders {␊ - apiVersion: "2016-11-01"␊ - /**␊ - * The name of the trusted identity provider. This is used for differentiation of providers in the account.␊ - */␊ - name: string␊ - /**␊ - * The trusted identity provider properties to use when creating a new trusted identity provider.␊ - */␊ - properties: (CreateOrUpdateTrustedIdProviderProperties | string)␊ - type: "Microsoft.DataLakeStore/accounts/trustedIdProviders"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataLakeStore/accounts/virtualNetworkRules␊ - */␊ - export interface AccountsVirtualNetworkRules {␊ - apiVersion: "2016-11-01"␊ - /**␊ - * The name of the virtual network rule to create or update.␊ - */␊ - name: string␊ - /**␊ - * The virtual network rule properties to use when creating a new virtual network rule.␊ - */␊ - properties: (CreateOrUpdateVirtualNetworkRuleProperties | string)␊ - type: "Microsoft.DataLakeStore/accounts/virtualNetworkRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataLakeAnalytics/accounts␊ - */␊ - export interface Accounts3 {␊ - apiVersion: "2015-10-01-preview"␊ - /**␊ - * The resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the Data Lake Analytics account to retrieve.␊ - */␊ - name: string␊ - properties: (CreateDataLakeAnalyticsAccountProperties | string)␊ - resources?: (Accounts_DataLakeStoreAccountsChildResource | Accounts_StorageAccountsChildResource | AccountsComputePoliciesChildResource | AccountsFirewallRulesChildResource2)[]␊ - /**␊ - * The resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.DataLakeAnalytics/accounts"␊ - [k: string]: unknown␊ - }␊ - export interface CreateDataLakeAnalyticsAccountProperties {␊ - /**␊ - * The list of compute policies associated with this account.␊ - */␊ - computePolicies?: (CreateComputePolicyWithAccountParameters[] | string)␊ - /**␊ - * The list of Data Lake Store accounts associated with this account.␊ - */␊ - dataLakeStoreAccounts: (AddDataLakeStoreWithAccountParameters[] | string)␊ - /**␊ - * The default Data Lake Store account associated with this account.␊ - */␊ - defaultDataLakeStoreAccount: string␊ - /**␊ - * The current state of allowing or disallowing IPs originating within Azure through the firewall. If the firewall is disabled, this is not enforced.␊ - */␊ - firewallAllowAzureIps?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * The list of firewall rules associated with this account.␊ - */␊ - firewallRules?: (CreateFirewallRuleWithAccountParameters1[] | string)␊ - /**␊ - * The current state of the IP address firewall for this account.␊ - */␊ - firewallState?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * The maximum supported degree of parallelism for this account.␊ - */␊ - maxDegreeOfParallelism?: (number | string)␊ - /**␊ - * The maximum supported degree of parallelism per job for this account.␊ - */␊ - maxDegreeOfParallelismPerJob?: ((number & string) | string)␊ - /**␊ - * The maximum supported jobs running under the account at the same time.␊ - */␊ - maxJobCount?: ((number & string) | string)␊ - /**␊ - * The minimum supported priority per job for this account.␊ - */␊ - minPriorityPerJob?: (number | string)␊ - /**␊ - * The commitment tier for the next month.␊ - */␊ - newTier?: (("Consumption" | "Commitment_100AUHours" | "Commitment_500AUHours" | "Commitment_1000AUHours" | "Commitment_5000AUHours" | "Commitment_10000AUHours" | "Commitment_50000AUHours" | "Commitment_100000AUHours" | "Commitment_500000AUHours") | string)␊ - /**␊ - * The number of days that job metadata is retained.␊ - */␊ - queryStoreRetention?: ((number & string) | string)␊ - /**␊ - * The list of Azure Blob Storage accounts associated with this account.␊ - */␊ - storageAccounts?: (AddStorageAccountWithAccountParameters[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The parameters used to create a new compute policy while creating a new Data Lake Analytics account.␊ - */␊ - export interface CreateComputePolicyWithAccountParameters {␊ - /**␊ - * The unique name of the compute policy to create.␊ - */␊ - name: string␊ - /**␊ - * The compute policy properties to use when creating a new compute policy.␊ - */␊ - properties: (CreateOrUpdateComputePolicyProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The compute policy properties to use when creating a new compute policy.␊ - */␊ - export interface CreateOrUpdateComputePolicyProperties {␊ - /**␊ - * The maximum degree of parallelism per job this user can use to submit jobs. This property, the min priority per job property, or both must be passed.␊ - */␊ - maxDegreeOfParallelismPerJob?: (number | string)␊ - /**␊ - * The minimum priority per job this user can use to submit jobs. This property, the max degree of parallelism per job property, or both must be passed.␊ - */␊ - minPriorityPerJob?: (number | string)␊ - /**␊ - * The AAD object identifier for the entity to create a policy for.␊ - */␊ - objectId: string␊ - /**␊ - * The type of AAD object the object identifier refers to.␊ - */␊ - objectType: (("User" | "Group" | "ServicePrincipal") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The parameters used to add a new Data Lake Store account while creating a new Data Lake Analytics account.␊ - */␊ - export interface AddDataLakeStoreWithAccountParameters {␊ - /**␊ - * The unique name of the Data Lake Store account to add.␊ - */␊ - name: string␊ - /**␊ - * The Data Lake Store account properties to use when adding a new Data Lake Store account.␊ - */␊ - properties?: (AddDataLakeStoreProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Data Lake Store account properties to use when adding a new Data Lake Store account.␊ - */␊ - export interface AddDataLakeStoreProperties {␊ - /**␊ - * The optional suffix for the Data Lake Store account.␊ - */␊ - suffix?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The parameters used to create a new firewall rule while creating a new Data Lake Analytics account.␊ - */␊ - export interface CreateFirewallRuleWithAccountParameters1 {␊ - /**␊ - * The unique name of the firewall rule to create.␊ - */␊ - name: string␊ - /**␊ - * The firewall rule properties to use when creating a new firewall rule.␊ - */␊ - properties: (CreateOrUpdateFirewallRuleProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The firewall rule properties to use when creating a new firewall rule.␊ - */␊ - export interface CreateOrUpdateFirewallRuleProperties1 {␊ - /**␊ - * The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol.␊ - */␊ - endIpAddress: string␊ - /**␊ - * The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol.␊ - */␊ - startIpAddress: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The parameters used to add a new Azure Storage account while creating a new Data Lake Analytics account.␊ - */␊ - export interface AddStorageAccountWithAccountParameters {␊ - /**␊ - * The unique name of the Azure Storage account to add.␊ - */␊ - name: string␊ - /**␊ - * The Azure Storage account properties to use when adding a new Azure Storage account.␊ - */␊ - properties: (StorageAccountProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Azure Storage account properties to use when adding a new Azure Storage account.␊ - */␊ - export interface StorageAccountProperties {␊ - /**␊ - * The access key associated with this Azure Storage account that will be used to connect to it.␊ - */␊ - accessKey: string␊ - /**␊ - * The optional suffix for the storage account.␊ - */␊ - suffix?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataLakeAnalytics/accounts/DataLakeStoreAccounts␊ - */␊ - export interface Accounts_DataLakeStoreAccountsChildResource {␊ - apiVersion: "2015-10-01-preview"␊ - /**␊ - * The name of the Data Lake Store account to add.␊ - */␊ - name: string␊ - /**␊ - * The Data Lake Store account properties to use when adding a new Data Lake Store account.␊ - */␊ - properties: (AddDataLakeStoreProperties | string)␊ - type: "DataLakeStoreAccounts"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataLakeAnalytics/accounts/StorageAccounts␊ - */␊ - export interface Accounts_StorageAccountsChildResource {␊ - apiVersion: "2015-10-01-preview"␊ - /**␊ - * The name of the Azure Storage account to add␊ - */␊ - name: string␊ - /**␊ - * The Azure Storage account properties to use when adding a new Azure Storage account.␊ - */␊ - properties: (StorageAccountProperties | string)␊ - type: "StorageAccounts"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataLakeAnalytics/accounts/computePolicies␊ - */␊ - export interface AccountsComputePoliciesChildResource {␊ - apiVersion: "2015-10-01-preview"␊ - /**␊ - * The name of the compute policy to create or update.␊ - */␊ - name: string␊ - /**␊ - * The compute policy properties to use when creating a new compute policy.␊ - */␊ - properties: (CreateOrUpdateComputePolicyProperties | string)␊ - type: "computePolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataLakeAnalytics/accounts/firewallRules␊ - */␊ - export interface AccountsFirewallRulesChildResource2 {␊ - apiVersion: "2015-10-01-preview"␊ - /**␊ - * The name of the firewall rule to create or update.␊ - */␊ - name: string␊ - /**␊ - * The firewall rule properties to use when creating a new firewall rule.␊ - */␊ - properties: (CreateOrUpdateFirewallRuleProperties1 | string)␊ - type: "firewallRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataLakeAnalytics/accounts␊ - */␊ - export interface Accounts4 {␊ - apiVersion: "2016-11-01"␊ - /**␊ - * The resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the Data Lake Analytics account.␊ - */␊ - name: string␊ - properties: (CreateDataLakeAnalyticsAccountProperties1 | string)␊ - resources?: (AccountsDataLakeStoreAccountsChildResource | AccountsStorageAccountsChildResource | AccountsComputePoliciesChildResource1 | AccountsFirewallRulesChildResource3)[]␊ - /**␊ - * The resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.DataLakeAnalytics/accounts"␊ - [k: string]: unknown␊ - }␊ - export interface CreateDataLakeAnalyticsAccountProperties1 {␊ - /**␊ - * The list of compute policies associated with this account.␊ - */␊ - computePolicies?: (CreateComputePolicyWithAccountParameters1[] | string)␊ - /**␊ - * The list of Data Lake Store accounts associated with this account.␊ - */␊ - dataLakeStoreAccounts: (AddDataLakeStoreWithAccountParameters1[] | string)␊ - /**␊ - * The default Data Lake Store account associated with this account.␊ - */␊ - defaultDataLakeStoreAccount: string␊ - /**␊ - * The current state of allowing or disallowing IPs originating within Azure through the firewall. If the firewall is disabled, this is not enforced.␊ - */␊ - firewallAllowAzureIps?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * The list of firewall rules associated with this account.␊ - */␊ - firewallRules?: (CreateFirewallRuleWithAccountParameters2[] | string)␊ - /**␊ - * The current state of the IP address firewall for this account.␊ - */␊ - firewallState?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * The maximum supported degree of parallelism for this account.␊ - */␊ - maxDegreeOfParallelism?: ((number & string) | string)␊ - /**␊ - * The maximum supported degree of parallelism per job for this account.␊ - */␊ - maxDegreeOfParallelismPerJob?: ((number & string) | string)␊ - /**␊ - * The maximum supported jobs running under the account at the same time.␊ - */␊ - maxJobCount?: ((number & string) | string)␊ - /**␊ - * The minimum supported priority per job for this account.␊ - */␊ - minPriorityPerJob?: (number | string)␊ - /**␊ - * The commitment tier for the next month.␊ - */␊ - newTier?: (("Consumption" | "Commitment_100AUHours" | "Commitment_500AUHours" | "Commitment_1000AUHours" | "Commitment_5000AUHours" | "Commitment_10000AUHours" | "Commitment_50000AUHours" | "Commitment_100000AUHours" | "Commitment_500000AUHours") | string)␊ - /**␊ - * The number of days that job metadata is retained.␊ - */␊ - queryStoreRetention?: ((number & string) | string)␊ - /**␊ - * The list of Azure Blob Storage accounts associated with this account.␊ - */␊ - storageAccounts?: (AddStorageAccountWithAccountParameters1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The parameters used to create a new compute policy while creating a new Data Lake Analytics account.␊ - */␊ - export interface CreateComputePolicyWithAccountParameters1 {␊ - /**␊ - * The unique name of the compute policy to create.␊ - */␊ - name: string␊ - /**␊ - * The compute policy properties to use when creating a new compute policy.␊ - */␊ - properties: (CreateOrUpdateComputePolicyProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The compute policy properties to use when creating a new compute policy.␊ - */␊ - export interface CreateOrUpdateComputePolicyProperties1 {␊ - /**␊ - * The maximum degree of parallelism per job this user can use to submit jobs. This property, the min priority per job property, or both must be passed.␊ - */␊ - maxDegreeOfParallelismPerJob?: (number | string)␊ - /**␊ - * The minimum priority per job this user can use to submit jobs. This property, the max degree of parallelism per job property, or both must be passed.␊ - */␊ - minPriorityPerJob?: (number | string)␊ - /**␊ - * The AAD object identifier for the entity to create a policy for.␊ - */␊ - objectId: string␊ - /**␊ - * The type of AAD object the object identifier refers to.␊ - */␊ - objectType: (("User" | "Group" | "ServicePrincipal") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The parameters used to add a new Data Lake Store account while creating a new Data Lake Analytics account.␊ - */␊ - export interface AddDataLakeStoreWithAccountParameters1 {␊ - /**␊ - * The unique name of the Data Lake Store account to add.␊ - */␊ - name: string␊ - /**␊ - * The Data Lake Store account properties to use when adding a new Data Lake Store account.␊ - */␊ - properties?: (AddDataLakeStoreProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Data Lake Store account properties to use when adding a new Data Lake Store account.␊ - */␊ - export interface AddDataLakeStoreProperties1 {␊ - /**␊ - * The optional suffix for the Data Lake Store account.␊ - */␊ - suffix?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The parameters used to create a new firewall rule while creating a new Data Lake Analytics account.␊ - */␊ - export interface CreateFirewallRuleWithAccountParameters2 {␊ - /**␊ - * The unique name of the firewall rule to create.␊ - */␊ - name: string␊ - /**␊ - * The firewall rule properties to use when creating a new firewall rule.␊ - */␊ - properties: (CreateOrUpdateFirewallRuleProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The firewall rule properties to use when creating a new firewall rule.␊ - */␊ - export interface CreateOrUpdateFirewallRuleProperties2 {␊ - /**␊ - * The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol.␊ - */␊ - endIpAddress: string␊ - /**␊ - * The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol.␊ - */␊ - startIpAddress: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The parameters used to add a new Azure Storage account while creating a new Data Lake Analytics account.␊ - */␊ - export interface AddStorageAccountWithAccountParameters1 {␊ - /**␊ - * The unique name of the Azure Storage account to add.␊ - */␊ - name: string␊ - /**␊ - * The Azure Storage account properties to use when adding a new Azure Storage account.␊ - */␊ - properties: (AddStorageAccountProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Azure Storage account properties to use when adding a new Azure Storage account.␊ - */␊ - export interface AddStorageAccountProperties {␊ - /**␊ - * The access key associated with this Azure Storage account that will be used to connect to it.␊ - */␊ - accessKey: string␊ - /**␊ - * The optional suffix for the storage account.␊ - */␊ - suffix?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataLakeAnalytics/accounts/dataLakeStoreAccounts␊ - */␊ - export interface AccountsDataLakeStoreAccountsChildResource {␊ - apiVersion: "2016-11-01"␊ - /**␊ - * The name of the Data Lake Store account to add.␊ - */␊ - name: string␊ - /**␊ - * The Data Lake Store account properties to use when adding a new Data Lake Store account.␊ - */␊ - properties: (AddDataLakeStoreProperties1 | string)␊ - type: "dataLakeStoreAccounts"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataLakeAnalytics/accounts/storageAccounts␊ - */␊ - export interface AccountsStorageAccountsChildResource {␊ - apiVersion: "2016-11-01"␊ - /**␊ - * The name of the Azure Storage account to add␊ - */␊ - name: string␊ - /**␊ - * The Azure Storage account properties to use when adding a new Azure Storage account.␊ - */␊ - properties: (AddStorageAccountProperties | string)␊ - type: "storageAccounts"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataLakeAnalytics/accounts/computePolicies␊ - */␊ - export interface AccountsComputePoliciesChildResource1 {␊ - apiVersion: "2016-11-01"␊ - /**␊ - * The name of the compute policy to create or update.␊ - */␊ - name: string␊ - /**␊ - * The compute policy properties to use when creating a new compute policy.␊ - */␊ - properties: (CreateOrUpdateComputePolicyProperties1 | string)␊ - type: "computePolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataLakeAnalytics/accounts/firewallRules␊ - */␊ - export interface AccountsFirewallRulesChildResource3 {␊ - apiVersion: "2016-11-01"␊ - /**␊ - * The name of the firewall rule to create or update.␊ - */␊ - name: string␊ - /**␊ - * The firewall rule properties to use when creating a new firewall rule.␊ - */␊ - properties: (CreateOrUpdateFirewallRuleProperties2 | string)␊ - type: "firewallRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataLakeAnalytics/accounts/dataLakeStoreAccounts␊ - */␊ - export interface AccountsDataLakeStoreAccounts {␊ - apiVersion: "2016-11-01"␊ - /**␊ - * The name of the Data Lake Store account to add.␊ - */␊ - name: string␊ - /**␊ - * The Data Lake Store account properties to use when adding a new Data Lake Store account.␊ - */␊ - properties: (AddDataLakeStoreProperties1 | string)␊ - type: "Microsoft.DataLakeAnalytics/accounts/dataLakeStoreAccounts"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataLakeAnalytics/accounts/storageAccounts␊ - */␊ - export interface AccountsStorageAccounts {␊ - apiVersion: "2016-11-01"␊ - /**␊ - * The name of the Azure Storage account to add␊ - */␊ - name: string␊ - /**␊ - * The Azure Storage account properties to use when adding a new Azure Storage account.␊ - */␊ - properties: (AddStorageAccountProperties | string)␊ - type: "Microsoft.DataLakeAnalytics/accounts/storageAccounts"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataLakeAnalytics/accounts/firewallRules␊ - */␊ - export interface AccountsFirewallRules1 {␊ - apiVersion: "2016-11-01"␊ - /**␊ - * The name of the firewall rule to create or update.␊ - */␊ - name: string␊ - /**␊ - * The firewall rule properties to use when creating a new firewall rule.␊ - */␊ - properties: (CreateOrUpdateFirewallRuleProperties2 | string)␊ - type: "Microsoft.DataLakeAnalytics/accounts/firewallRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataLakeAnalytics/accounts/computePolicies␊ - */␊ - export interface AccountsComputePolicies {␊ - apiVersion: "2016-11-01"␊ - /**␊ - * The name of the compute policy to create or update.␊ - */␊ - name: string␊ - /**␊ - * The compute policy properties to use when creating a new compute policy.␊ - */␊ - properties: (CreateOrUpdateComputePolicyProperties1 | string)␊ - type: "Microsoft.DataLakeAnalytics/accounts/computePolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.CognitiveServices/accounts␊ - */␊ - export interface Accounts5 {␊ - apiVersion: "2016-02-01-preview"␊ - /**␊ - * Required. Indicates the type of cognitive service account.␊ - */␊ - kind: (("Academic" | "Bing.Autosuggest" | "Bing.Search" | "Bing.Speech" | "Bing.SpellCheck" | "ComputerVision" | "ContentModerator" | "Emotion" | "Face" | "LUIS" | "Recommendations" | "SpeakerRecognition" | "Speech" | "SpeechTranslation" | "TextAnalytics" | "TextTranslation" | "WebLM") | string)␊ - /**␊ - * Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update the request will succeed.␊ - */␊ - location: string␊ - /**␊ - * The name of the cognitive services account within the specified resource group. Cognitive Services account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.␊ - */␊ - name: string␊ - /**␊ - * required empty properties object. Must be an empty object, and must exist in the request.␊ - */␊ - properties: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The SKU of the cognitive services account.␊ - */␊ - sku: (Sku24 | string)␊ - /**␊ - * Gets or sets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.CognitiveServices/accounts"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The SKU of the cognitive services account.␊ - */␊ - export interface Sku24 {␊ - /**␊ - * Gets or sets the sku name. Required for account creation, optional for update.␊ - */␊ - name: (("F0" | "P0" | "P1" | "P2" | "S0" | "S1" | "S2" | "S3" | "S4" | "S5" | "S6") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.CognitiveServices/accounts␊ - */␊ - export interface Accounts6 {␊ - apiVersion: "2017-04-18"␊ - /**␊ - * Managed service identity.␊ - */␊ - identity?: (Identity14 | string)␊ - /**␊ - * Required. Indicates the type of cognitive service account.␊ - */␊ - kind?: string␊ - /**␊ - * The location of the resource␊ - */␊ - location?: string␊ - /**␊ - * The name of Cognitive Services account.␊ - */␊ - name: string␊ - /**␊ - * Properties of Cognitive Services account.␊ - */␊ - properties: (CognitiveServicesAccountProperties | string)␊ - resources?: AccountsPrivateEndpointConnectionsChildResource[]␊ - /**␊ - * The SKU of the cognitive services account.␊ - */␊ - sku?: (Sku25 | string)␊ - /**␊ - * Gets or sets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.CognitiveServices/accounts"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Managed service identity.␊ - */␊ - export interface Identity14 {␊ - /**␊ - * Type of managed service identity.␊ - */␊ - type?: (("None" | "SystemAssigned" | "UserAssigned") | string)␊ - /**␊ - * The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}␊ - */␊ - userAssignedIdentities?: ({␊ - [k: string]: UserAssignedIdentity␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * User-assigned managed identity.␊ - */␊ - export interface UserAssignedIdentity {␊ - /**␊ - * Client App Id associated with this identity.␊ - */␊ - clientId?: string␊ - /**␊ - * Azure Active Directory principal ID associated with this Identity.␊ - */␊ - principalId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Cognitive Services account.␊ - */␊ - export interface CognitiveServicesAccountProperties {␊ - /**␊ - * The api properties for special APIs.␊ - */␊ - apiProperties?: (CognitiveServicesAccountApiProperties | string)␊ - /**␊ - * Optional subdomain name used for token-based authentication.␊ - */␊ - customSubDomainName?: string␊ - /**␊ - * Properties to configure Encryption␊ - */␊ - encryption?: (Encryption9 | string)␊ - /**␊ - * A set of rules governing the network accessibility.␊ - */␊ - networkAcls?: (NetworkRuleSet12 | string)␊ - /**␊ - * The private endpoint connection associated with the Cognitive Services account.␊ - */␊ - privateEndpointConnections?: (PrivateEndpointConnection[] | string)␊ - /**␊ - * Whether or not public endpoint access is allowed for this account. Value is optional but if passed in, must be 'Enabled' or 'Disabled'.␊ - */␊ - publicNetworkAccess?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * The storage accounts for this resource.␊ - */␊ - userOwnedStorage?: (UserOwnedStorage[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The api properties for special APIs.␊ - */␊ - export interface CognitiveServicesAccountApiProperties {␊ - /**␊ - * (Metrics Advisor Only) The Azure AD Client Id (Application Id).␊ - */␊ - aadClientId?: string␊ - /**␊ - * (Metrics Advisor Only) The Azure AD Tenant Id.␊ - */␊ - aadTenantId?: string␊ - /**␊ - * (Personalization Only) The flag to enable statistics of Bing Search.␊ - */␊ - eventHubConnectionString?: string␊ - /**␊ - * (QnAMaker Only) The Azure Search endpoint id of QnAMaker.␊ - */␊ - qnaAzureSearchEndpointId?: string␊ - /**␊ - * (QnAMaker Only) The Azure Search endpoint key of QnAMaker.␊ - */␊ - qnaAzureSearchEndpointKey?: string␊ - /**␊ - * (QnAMaker Only) The runtime endpoint of QnAMaker.␊ - */␊ - qnaRuntimeEndpoint?: string␊ - /**␊ - * (Bing Search Only) The flag to enable statistics of Bing Search.␊ - */␊ - statisticsEnabled?: (boolean | string)␊ - /**␊ - * (Personalization Only) The storage account connection string.␊ - */␊ - storageAccountConnectionString?: string␊ - /**␊ - * (Metrics Advisor Only) The super user of Metrics Advisor.␊ - */␊ - superUser?: string␊ - /**␊ - * (Metrics Advisor Only) The website name of Metrics Advisor.␊ - */␊ - websiteName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties to configure Encryption␊ - */␊ - export interface Encryption9 {␊ - /**␊ - * Enumerates the possible value of keySource for Encryption.␊ - */␊ - keySource?: (("Microsoft.CognitiveServices" | "Microsoft.KeyVault") | string)␊ - /**␊ - * Properties to configure keyVault Properties␊ - */␊ - keyVaultProperties?: (KeyVaultProperties13 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties to configure keyVault Properties␊ - */␊ - export interface KeyVaultProperties13 {␊ - /**␊ - * Name of the Key from KeyVault␊ - */␊ - keyName?: string␊ - /**␊ - * Uri of KeyVault␊ - */␊ - keyVaultUri?: string␊ - /**␊ - * Version of the Key from KeyVault␊ - */␊ - keyVersion?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A set of rules governing the network accessibility.␊ - */␊ - export interface NetworkRuleSet12 {␊ - /**␊ - * The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated.␊ - */␊ - defaultAction?: (("Allow" | "Deny") | string)␊ - /**␊ - * The list of IP address rules.␊ - */␊ - ipRules?: (IpRule[] | string)␊ - /**␊ - * The list of virtual network rules.␊ - */␊ - virtualNetworkRules?: (VirtualNetworkRule13[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A rule governing the accessibility from a specific ip address or ip range.␊ - */␊ - export interface IpRule {␊ - /**␊ - * An IPv4 address range in CIDR notation, such as '124.56.78.91' (simple IP address) or '124.56.78.0/24' (all addresses that start with 124.56.78).␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A rule governing the accessibility from a specific virtual network.␊ - */␊ - export interface VirtualNetworkRule13 {␊ - /**␊ - * Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'.␊ - */␊ - id: string␊ - /**␊ - * Ignore missing vnet service endpoint or not.␊ - */␊ - ignoreMissingVnetServiceEndpoint?: (boolean | string)␊ - /**␊ - * Gets the state of virtual network rule.␊ - */␊ - state?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Private Endpoint Connection resource.␊ - */␊ - export interface PrivateEndpointConnection {␊ - /**␊ - * The location of the private endpoint connection␊ - */␊ - location?: string␊ - /**␊ - * Properties of the PrivateEndpointConnectProperties.␊ - */␊ - properties?: (PrivateEndpointConnectionProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the PrivateEndpointConnectProperties.␊ - */␊ - export interface PrivateEndpointConnectionProperties4 {␊ - /**␊ - * The private link resource group ids.␊ - */␊ - groupIds?: (string[] | string)␊ - /**␊ - * The Private Endpoint resource.␊ - */␊ - privateEndpoint?: (PrivateEndpoint4 | string)␊ - /**␊ - * A collection of information about the state of the connection between service consumer and provider.␊ - */␊ - privateLinkServiceConnectionState: (PrivateLinkServiceConnectionState4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Private Endpoint resource.␊ - */␊ - export interface PrivateEndpoint4 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A collection of information about the state of the connection between service consumer and provider.␊ - */␊ - export interface PrivateLinkServiceConnectionState4 {␊ - /**␊ - * A message indicating if changes on the service provider require any updates on the consumer.␊ - */␊ - actionsRequired?: string␊ - /**␊ - * The reason for approval/rejection of the connection.␊ - */␊ - description?: string␊ - /**␊ - * Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.␊ - */␊ - status?: (("Pending" | "Approved" | "Rejected" | "Disconnected") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The user owned storage for Cognitive Services account.␊ - */␊ - export interface UserOwnedStorage {␊ - /**␊ - * Full resource id of a Microsoft.Storage resource.␊ - */␊ - resourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.CognitiveServices/accounts/privateEndpointConnections␊ - */␊ - export interface AccountsPrivateEndpointConnectionsChildResource {␊ - apiVersion: "2017-04-18"␊ - /**␊ - * The location of the private endpoint connection␊ - */␊ - location?: string␊ - /**␊ - * The name of the private endpoint connection associated with the Cognitive Services Account␊ - */␊ - name: string␊ - /**␊ - * Properties of the PrivateEndpointConnectProperties.␊ - */␊ - properties: (PrivateEndpointConnectionProperties4 | string)␊ - type: "privateEndpointConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The SKU of the cognitive services account.␊ - */␊ - export interface Sku25 {␊ - /**␊ - * The name of SKU.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.CognitiveServices/accounts/privateEndpointConnections␊ - */␊ - export interface AccountsPrivateEndpointConnections {␊ - apiVersion: "2017-04-18"␊ - /**␊ - * The location of the private endpoint connection␊ - */␊ - location?: string␊ - /**␊ - * The name of the private endpoint connection associated with the Cognitive Services Account␊ - */␊ - name: string␊ - /**␊ - * Properties of the PrivateEndpointConnectProperties.␊ - */␊ - properties: (PrivateEndpointConnectionProperties4 | string)␊ - type: "Microsoft.CognitiveServices/accounts/privateEndpointConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.PowerBI/workspaceCollections␊ - */␊ - export interface WorkspaceCollections {␊ - apiVersion: "2016-01-29"␊ - /**␊ - * Azure location␊ - */␊ - location?: string␊ - /**␊ - * Power BI Embedded Workspace Collection name␊ - */␊ - name: string␊ - sku?: (AzureSku9 | string)␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.PowerBI/workspaceCollections"␊ - [k: string]: unknown␊ - }␊ - export interface AzureSku9 {␊ - /**␊ - * SKU name␊ - */␊ - name: ("S1" | string)␊ - /**␊ - * SKU tier␊ - */␊ - tier: ("Standard" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.PowerBIDedicated/capacities␊ - */␊ - export interface Capacities {␊ - apiVersion: "2017-10-01"␊ - /**␊ - * Location of the PowerBI Dedicated resource.␊ - */␊ - location: string␊ - /**␊ - * The name of the Dedicated capacity. It must be a minimum of 3 characters, and a maximum of 63.␊ - */␊ - name: string␊ - /**␊ - * Properties of Dedicated Capacity resource.␊ - */␊ - properties: (DedicatedCapacityProperties | string)␊ - /**␊ - * Represents the SKU name and Azure pricing tier for PowerBI Dedicated resource.␊ - */␊ - sku: (ResourceSku2 | string)␊ - /**␊ - * Key-value pairs of additional resource provisioning properties.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.PowerBIDedicated/capacities"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Dedicated Capacity resource.␊ - */␊ - export interface DedicatedCapacityProperties {␊ - /**␊ - * An array of administrator user identities␊ - */␊ - administration?: (DedicatedCapacityAdministrators | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An array of administrator user identities␊ - */␊ - export interface DedicatedCapacityAdministrators {␊ - /**␊ - * An array of administrator user identities.␊ - */␊ - members?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents the SKU name and Azure pricing tier for PowerBI Dedicated resource.␊ - */␊ - export interface ResourceSku2 {␊ - /**␊ - * The capacity of the SKU.␊ - */␊ - capacity?: (number | string)␊ - /**␊ - * Name of the SKU level.␊ - */␊ - name: string␊ - /**␊ - * The name of the Azure pricing tier to which the SKU applies.␊ - */␊ - tier?: ("PBIE_Azure" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataCatalog/catalogs␊ - */␊ - export interface Catalogs {␊ - apiVersion: "2016-03-30"␊ - /**␊ - * Resource etag␊ - */␊ - etag?: string␊ - /**␊ - * Resource location␊ - */␊ - location?: string␊ - /**␊ - * The name of the data catalog in the specified subscription and resource group.␊ - */␊ - name: string␊ - /**␊ - * Properties of the data catalog.␊ - */␊ - properties: (ADCCatalogProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.DataCatalog/catalogs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the data catalog.␊ - */␊ - export interface ADCCatalogProperties {␊ - /**␊ - * Azure data catalog admin list.␊ - */␊ - admins?: (Principals[] | string)␊ - /**␊ - * Automatic unit adjustment enabled or not.␊ - */␊ - enableAutomaticUnitAdjustment?: (boolean | string)␊ - /**␊ - * Azure data catalog SKU.␊ - */␊ - sku?: (("Free" | "Standard") | string)␊ - /**␊ - * Azure data catalog provision status.␊ - */␊ - successfullyProvisioned?: (boolean | string)␊ - /**␊ - * Azure data catalog units.␊ - */␊ - units?: (number | string)␊ - /**␊ - * Azure data catalog user list.␊ - */␊ - users?: (Principals[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * User principals.␊ - */␊ - export interface Principals {␊ - /**␊ - * Object Id for the user␊ - */␊ - objectId?: string␊ - /**␊ - * UPN of the user.␊ - */␊ - upn?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ContainerService/containerServices␊ - */␊ - export interface ContainerServices {␊ - apiVersion: "2016-03-30"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the container service in the specified subscription and resource group.␊ - */␊ - name: string␊ - /**␊ - * Properties of the container service.␊ - */␊ - properties: (ContainerServiceProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.ContainerService/containerServices"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the container service.␊ - */␊ - export interface ContainerServiceProperties {␊ - /**␊ - * Properties of the agent pool.␊ - */␊ - agentPoolProfiles: (ContainerServiceAgentPoolProfile[] | string)␊ - diagnosticsProfile?: (ContainerServiceDiagnosticsProfile | string)␊ - /**␊ - * Profile for Linux VMs in the container service cluster.␊ - */␊ - linuxProfile: (ContainerServiceLinuxProfile | string)␊ - /**␊ - * Profile for the container service master.␊ - */␊ - masterProfile: (ContainerServiceMasterProfile | string)␊ - /**␊ - * Profile for the container service orchestrator.␊ - */␊ - orchestratorProfile?: (ContainerServiceOrchestratorProfile | string)␊ - /**␊ - * Profile for Windows VMs in the container service cluster.␊ - */␊ - windowsProfile?: (ContainerServiceWindowsProfile | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Profile for the container service agent pool.␊ - */␊ - export interface ContainerServiceAgentPoolProfile {␊ - /**␊ - * Number of agents (VMs) to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. ␊ - */␊ - count?: (number | string)␊ - /**␊ - * DNS prefix to be used to create the FQDN for the agent pool.␊ - */␊ - dnsPrefix: string␊ - /**␊ - * Unique name of the agent pool profile in the context of the subscription and resource group.␊ - */␊ - name: string␊ - /**␊ - * Size of agent VMs.␊ - */␊ - vmSize: (("Standard_A0" | "Standard_A1" | "Standard_A2" | "Standard_A3" | "Standard_A4" | "Standard_A5" | "Standard_A6" | "Standard_A7" | "Standard_A8" | "Standard_A9" | "Standard_A10" | "Standard_A11" | "Standard_D1" | "Standard_D2" | "Standard_D3" | "Standard_D4" | "Standard_D11" | "Standard_D12" | "Standard_D13" | "Standard_D14" | "Standard_D1_v2" | "Standard_D2_v2" | "Standard_D3_v2" | "Standard_D4_v2" | "Standard_D5_v2" | "Standard_D11_v2" | "Standard_D12_v2" | "Standard_D13_v2" | "Standard_D14_v2" | "Standard_G1" | "Standard_G2" | "Standard_G3" | "Standard_G4" | "Standard_G5" | "Standard_DS1" | "Standard_DS2" | "Standard_DS3" | "Standard_DS4" | "Standard_DS11" | "Standard_DS12" | "Standard_DS13" | "Standard_DS14" | "Standard_GS1" | "Standard_GS2" | "Standard_GS3" | "Standard_GS4" | "Standard_GS5") | string)␊ - [k: string]: unknown␊ - }␊ - export interface ContainerServiceDiagnosticsProfile {␊ - /**␊ - * Profile for diagnostics on the container service VMs.␊ - */␊ - vmDiagnostics: (ContainerServiceVMDiagnostics | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Profile for diagnostics on the container service VMs.␊ - */␊ - export interface ContainerServiceVMDiagnostics {␊ - /**␊ - * Whether the VM diagnostic agent is provisioned on the VM.␊ - */␊ - enabled: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Profile for Linux VMs in the container service cluster.␊ - */␊ - export interface ContainerServiceLinuxProfile {␊ - /**␊ - * The administrator username to use for all Linux VMs␊ - */␊ - adminUsername: string␊ - /**␊ - * SSH configuration for Linux-based VMs running on Azure.␊ - */␊ - ssh: (ContainerServiceSshConfiguration | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSH configuration for Linux-based VMs running on Azure.␊ - */␊ - export interface ContainerServiceSshConfiguration {␊ - /**␊ - * the list of SSH public keys used to authenticate with Linux-based VMs.␊ - */␊ - publicKeys: (ContainerServiceSshPublicKey[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains information about SSH certificate public key data.␊ - */␊ - export interface ContainerServiceSshPublicKey {␊ - /**␊ - * Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers.␊ - */␊ - keyData: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Profile for the container service master.␊ - */␊ - export interface ContainerServiceMasterProfile {␊ - /**␊ - * Number of masters (VMs) in the container service cluster. Allowed values are 1, 3, and 5. The default value is 1.␊ - */␊ - count?: ((number & string) | string)␊ - /**␊ - * DNS prefix to be used to create the FQDN for master.␊ - */␊ - dnsPrefix: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Profile for the container service orchestrator.␊ - */␊ - export interface ContainerServiceOrchestratorProfile {␊ - /**␊ - * The orchestrator to use to manage container service cluster resources. Valid values are Swarm, DCOS, and Custom.␊ - */␊ - orchestratorType: (("Swarm" | "DCOS") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Profile for Windows VMs in the container service cluster.␊ - */␊ - export interface ContainerServiceWindowsProfile {␊ - /**␊ - * The administrator password to use for Windows VMs␊ - */␊ - adminPassword: string␊ - /**␊ - * The administrator username to use for Windows VMs␊ - */␊ - adminUsername: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnszones␊ - */␊ - export interface Dnszones {␊ - type: "Microsoft.Network/dnszones"␊ - apiVersion: "2015-05-04-preview"␊ - /**␊ - * Gets or sets the ETag of the zone that is being updated, as received from a Get operation.␊ - */␊ - etag?: string␊ - /**␊ - * Gets or sets the properties of the zone.␊ - */␊ - properties: (ZoneProperties | string)␊ - resources?: (Dnszones_TXTChildResource | Dnszones_SRVChildResource | Dnszones_SOAChildResource | Dnszones_PTRChildResource | Dnszones_NSChildResource | Dnszones_MXChildResource | Dnszones_CNAMEChildResource | Dnszones_AAAAChildResource | Dnszones_AChildResource)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents the properties of the zone.␊ - */␊ - export interface ZoneProperties {␊ - /**␊ - * Gets or sets the maximum number of record sets that can be created in this zone.␊ - */␊ - maxNumberOfRecordSets?: (number | string)␊ - /**␊ - * Gets or sets the current number of record sets in this zone.␊ - */␊ - numberOfRecordSets?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnszones/TXT␊ - */␊ - export interface Dnszones_TXTChildResource {␊ - type: "TXT"␊ - apiVersion: "2015-05-04-preview"␊ - /**␊ - * Gets or sets the ETag of the RecordSet.␊ - */␊ - etag?: string␊ - /**␊ - * Gets or sets the properties of the RecordSet.␊ - */␊ - properties: (RecordSetProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents the properties of the records in the RecordSet.␊ - */␊ - export interface RecordSetProperties {␊ - /**␊ - * Gets or sets the TTL of the records in the RecordSet.␊ - */␊ - TTL?: (number | string)␊ - /**␊ - * Gets or sets the list of A records in the RecordSet.␊ - */␊ - ARecords?: (ARecord[] | string)␊ - /**␊ - * Gets or sets the list of AAAA records in the RecordSet.␊ - */␊ - AAAARecords?: (AaaaRecord[] | string)␊ - /**␊ - * Gets or sets the list of MX records in the RecordSet.␊ - */␊ - MXRecords?: (MxRecord[] | string)␊ - /**␊ - * Gets or sets the list of NS records in the RecordSet.␊ - */␊ - NSRecords?: (NsRecord[] | string)␊ - /**␊ - * Gets or sets the list of PTR records in the RecordSet.␊ - */␊ - PTRRecords?: (PtrRecord[] | string)␊ - /**␊ - * Gets or sets the list of SRV records in the RecordSet.␊ - */␊ - SRVRecords?: (SrvRecord[] | string)␊ - /**␊ - * Gets or sets the list of TXT records in the RecordSet.␊ - */␊ - TXTRecords?: (TxtRecord[] | string)␊ - /**␊ - * Gets or sets the CNAME record in the RecordSet.␊ - */␊ - CNAMERecord?: (CnameRecord | string)␊ - /**␊ - * Gets or sets the SOA record in the RecordSet.␊ - */␊ - SOARecord?: (SoaRecord | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An A record.␊ - */␊ - export interface ARecord {␊ - /**␊ - * Gets or sets the IPv4 address of this A record in string notation.␊ - */␊ - ipv4Address?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An AAAA record.␊ - */␊ - export interface AaaaRecord {␊ - /**␊ - * Gets or sets the IPv6 address of this AAAA record in string notation.␊ - */␊ - ipv6Address?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An MX record.␊ - */␊ - export interface MxRecord {␊ - /**␊ - * Gets or sets the preference metric for this record.␊ - */␊ - preference?: (number | string)␊ - /**␊ - * Gets or sets the domain name of the mail host, without a terminating dot.␊ - */␊ - exchange?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An NS record.␊ - */␊ - export interface NsRecord {␊ - /**␊ - * Gets or sets the name server name for this record, without a terminating dot.␊ - */␊ - nsdname?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A PTR record.␊ - */␊ - export interface PtrRecord {␊ - /**␊ - * Gets or sets the PTR target domain name for this record without a terminating dot.␊ - */␊ - ptrdname?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An SRV record.␊ - */␊ - export interface SrvRecord {␊ - /**␊ - * Gets or sets the priority metric for this record.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * Gets or sets the weight metric for this this record.␊ - */␊ - weight?: (number | string)␊ - /**␊ - * Gets or sets the port of the service for this record.␊ - */␊ - port?: (number | string)␊ - /**␊ - * Gets or sets the domain name of the target for this record, without a terminating dot.␊ - */␊ - target?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A TXT record.␊ - */␊ - export interface TxtRecord {␊ - /**␊ - * Gets or sets the text value of this record.␊ - */␊ - value?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A CNAME record.␊ - */␊ - export interface CnameRecord {␊ - /**␊ - * Gets or sets the canonical name for this record without a terminating dot.␊ - */␊ - cname?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An SOA record.␊ - */␊ - export interface SoaRecord {␊ - /**␊ - * Gets or sets the domain name of the authoritative name server, without a temrinating dot.␊ - */␊ - host?: string␊ - /**␊ - * Gets or sets the email for this record.␊ - */␊ - email?: string␊ - /**␊ - * Gets or sets the serial number for this record.␊ - */␊ - serialNumber?: (number | string)␊ - /**␊ - * Gets or sets the refresh value for this record.␊ - */␊ - refreshTime?: (number | string)␊ - /**␊ - * Gets or sets the retry time for this record.␊ - */␊ - retryTime?: (number | string)␊ - /**␊ - * Gets or sets the expire time for this record.␊ - */␊ - expireTime?: (number | string)␊ - /**␊ - * Gets or sets the minimum TTL value for this record.␊ - */␊ - minimumTTL?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnszones/SRV␊ - */␊ - export interface Dnszones_SRVChildResource {␊ - type: "SRV"␊ - apiVersion: "2015-05-04-preview"␊ - /**␊ - * Gets or sets the ETag of the RecordSet.␊ - */␊ - etag?: string␊ - /**␊ - * Gets or sets the properties of the RecordSet.␊ - */␊ - properties: (RecordSetProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnszones/SOA␊ - */␊ - export interface Dnszones_SOAChildResource {␊ - type: "SOA"␊ - apiVersion: "2015-05-04-preview"␊ - /**␊ - * Gets or sets the ETag of the RecordSet.␊ - */␊ - etag?: string␊ - /**␊ - * Gets or sets the properties of the RecordSet.␊ - */␊ - properties: (RecordSetProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnszones/PTR␊ - */␊ - export interface Dnszones_PTRChildResource {␊ - type: "PTR"␊ - apiVersion: "2015-05-04-preview"␊ - /**␊ - * Gets or sets the ETag of the RecordSet.␊ - */␊ - etag?: string␊ - /**␊ - * Gets or sets the properties of the RecordSet.␊ - */␊ - properties: (RecordSetProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnszones/NS␊ - */␊ - export interface Dnszones_NSChildResource {␊ - type: "NS"␊ - apiVersion: "2015-05-04-preview"␊ - /**␊ - * Gets or sets the ETag of the RecordSet.␊ - */␊ - etag?: string␊ - /**␊ - * Gets or sets the properties of the RecordSet.␊ - */␊ - properties: (RecordSetProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnszones/MX␊ - */␊ - export interface Dnszones_MXChildResource {␊ - type: "MX"␊ - apiVersion: "2015-05-04-preview"␊ - /**␊ - * Gets or sets the ETag of the RecordSet.␊ - */␊ - etag?: string␊ - /**␊ - * Gets or sets the properties of the RecordSet.␊ - */␊ - properties: (RecordSetProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnszones/CNAME␊ - */␊ - export interface Dnszones_CNAMEChildResource {␊ - type: "CNAME"␊ - apiVersion: "2015-05-04-preview"␊ - /**␊ - * Gets or sets the ETag of the RecordSet.␊ - */␊ - etag?: string␊ - /**␊ - * Gets or sets the properties of the RecordSet.␊ - */␊ - properties: (RecordSetProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnszones/AAAA␊ - */␊ - export interface Dnszones_AAAAChildResource {␊ - type: "AAAA"␊ - apiVersion: "2015-05-04-preview"␊ - /**␊ - * Gets or sets the ETag of the RecordSet.␊ - */␊ - etag?: string␊ - /**␊ - * Gets or sets the properties of the RecordSet.␊ - */␊ - properties: (RecordSetProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnszones/A␊ - */␊ - export interface Dnszones_AChildResource {␊ - type: "A"␊ - apiVersion: "2015-05-04-preview"␊ - /**␊ - * Gets or sets the ETag of the RecordSet.␊ - */␊ - etag?: string␊ - /**␊ - * Gets or sets the properties of the RecordSet.␊ - */␊ - properties: (RecordSetProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnszones/A␊ - */␊ - export interface Dnszones_A {␊ - type: "Microsoft.Network/dnszones/A"␊ - apiVersion: "2015-05-04-preview"␊ - /**␊ - * Gets or sets the ETag of the RecordSet.␊ - */␊ - etag?: string␊ - /**␊ - * Gets or sets the properties of the RecordSet.␊ - */␊ - properties: (RecordSetProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnszones/AAAA␊ - */␊ - export interface Dnszones_AAAA {␊ - type: "Microsoft.Network/dnszones/AAAA"␊ - apiVersion: "2015-05-04-preview"␊ - /**␊ - * Gets or sets the ETag of the RecordSet.␊ - */␊ - etag?: string␊ - /**␊ - * Gets or sets the properties of the RecordSet.␊ - */␊ - properties: (RecordSetProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnszones/CNAME␊ - */␊ - export interface Dnszones_CNAME {␊ - type: "Microsoft.Network/dnszones/CNAME"␊ - apiVersion: "2015-05-04-preview"␊ - /**␊ - * Gets or sets the ETag of the RecordSet.␊ - */␊ - etag?: string␊ - /**␊ - * Gets or sets the properties of the RecordSet.␊ - */␊ - properties: (RecordSetProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnszones/MX␊ - */␊ - export interface Dnszones_MX {␊ - type: "Microsoft.Network/dnszones/MX"␊ - apiVersion: "2015-05-04-preview"␊ - /**␊ - * Gets or sets the ETag of the RecordSet.␊ - */␊ - etag?: string␊ - /**␊ - * Gets or sets the properties of the RecordSet.␊ - */␊ - properties: (RecordSetProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnszones/NS␊ - */␊ - export interface Dnszones_NS {␊ - type: "Microsoft.Network/dnszones/NS"␊ - apiVersion: "2015-05-04-preview"␊ - /**␊ - * Gets or sets the ETag of the RecordSet.␊ - */␊ - etag?: string␊ - /**␊ - * Gets or sets the properties of the RecordSet.␊ - */␊ - properties: (RecordSetProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnszones/PTR␊ - */␊ - export interface Dnszones_PTR {␊ - type: "Microsoft.Network/dnszones/PTR"␊ - apiVersion: "2015-05-04-preview"␊ - /**␊ - * Gets or sets the ETag of the RecordSet.␊ - */␊ - etag?: string␊ - /**␊ - * Gets or sets the properties of the RecordSet.␊ - */␊ - properties: (RecordSetProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnszones/SOA␊ - */␊ - export interface Dnszones_SOA {␊ - type: "Microsoft.Network/dnszones/SOA"␊ - apiVersion: "2015-05-04-preview"␊ - /**␊ - * Gets or sets the ETag of the RecordSet.␊ - */␊ - etag?: string␊ - /**␊ - * Gets or sets the properties of the RecordSet.␊ - */␊ - properties: (RecordSetProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnszones/SRV␊ - */␊ - export interface Dnszones_SRV {␊ - type: "Microsoft.Network/dnszones/SRV"␊ - apiVersion: "2015-05-04-preview"␊ - /**␊ - * Gets or sets the ETag of the RecordSet.␊ - */␊ - etag?: string␊ - /**␊ - * Gets or sets the properties of the RecordSet.␊ - */␊ - properties: (RecordSetProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnszones/TXT␊ - */␊ - export interface Dnszones_TXT {␊ - type: "Microsoft.Network/dnszones/TXT"␊ - apiVersion: "2015-05-04-preview"␊ - /**␊ - * Gets or sets the ETag of the RecordSet.␊ - */␊ - etag?: string␊ - /**␊ - * Gets or sets the properties of the RecordSet.␊ - */␊ - properties: (RecordSetProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnszones␊ - */␊ - export interface Dnszones1 {␊ - type: "Microsoft.Network/dnszones"␊ - apiVersion: "2016-04-01"␊ - /**␊ - * Gets or sets the ETag of the zone that is being updated, as received from a Get operation.␊ - */␊ - etag?: string␊ - /**␊ - * Gets or sets the properties of the zone.␊ - */␊ - properties: (ZoneProperties1 | string)␊ - resources?: (Dnszones_TXTChildResource1 | Dnszones_SRVChildResource1 | Dnszones_SOAChildResource1 | Dnszones_PTRChildResource1 | Dnszones_NSChildResource1 | Dnszones_MXChildResource1 | Dnszones_CNAMEChildResource1 | Dnszones_AAAAChildResource1 | Dnszones_AChildResource1)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents the properties of the zone.␊ - */␊ - export interface ZoneProperties1 {␊ - /**␊ - * Gets or sets the maximum number of record sets that can be created in this zone.␊ - */␊ - maxNumberOfRecordSets?: (number | string)␊ - /**␊ - * Gets or sets the current number of record sets in this zone.␊ - */␊ - numberOfRecordSets?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnszones/TXT␊ - */␊ - export interface Dnszones_TXTChildResource1 {␊ - type: "TXT"␊ - apiVersion: "2016-04-01"␊ - /**␊ - * Gets or sets the ID of the resource.␊ - */␊ - id?: string␊ - /**␊ - * Gets or sets the name of the resource.␊ - */␊ - name?: string␊ - /**␊ - * Gets or sets the ETag of the RecordSet.␊ - */␊ - etag?: string␊ - /**␊ - * Gets or sets the properties of the RecordSet.␊ - */␊ - properties: (RecordSetProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents the properties of the records in the RecordSet.␊ - */␊ - export interface RecordSetProperties1 {␊ - /**␊ - * Gets or sets the metadata attached to the resource.␊ - */␊ - metadata?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Gets or sets the TTL of the records in the RecordSet.␊ - */␊ - TTL?: (number | string)␊ - /**␊ - * Gets or sets the list of A records in the RecordSet.␊ - */␊ - ARecords?: (ARecord1[] | string)␊ - /**␊ - * Gets or sets the list of AAAA records in the RecordSet.␊ - */␊ - AAAARecords?: (AaaaRecord1[] | string)␊ - /**␊ - * Gets or sets the list of MX records in the RecordSet.␊ - */␊ - MXRecords?: (MxRecord1[] | string)␊ - /**␊ - * Gets or sets the list of NS records in the RecordSet.␊ - */␊ - NSRecords?: (NsRecord1[] | string)␊ - /**␊ - * Gets or sets the list of PTR records in the RecordSet.␊ - */␊ - PTRRecords?: (PtrRecord1[] | string)␊ - /**␊ - * Gets or sets the list of SRV records in the RecordSet.␊ - */␊ - SRVRecords?: (SrvRecord1[] | string)␊ - /**␊ - * Gets or sets the list of TXT records in the RecordSet.␊ - */␊ - TXTRecords?: (TxtRecord1[] | string)␊ - /**␊ - * Gets or sets the CNAME record in the RecordSet.␊ - */␊ - CNAMERecord?: (CnameRecord1 | string)␊ - /**␊ - * Gets or sets the SOA record in the RecordSet.␊ - */␊ - SOARecord?: (SoaRecord1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An A record.␊ - */␊ - export interface ARecord1 {␊ - /**␊ - * Gets or sets the IPv4 address of this A record in string notation.␊ - */␊ - ipv4Address?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An AAAA record.␊ - */␊ - export interface AaaaRecord1 {␊ - /**␊ - * Gets or sets the IPv6 address of this AAAA record in string notation.␊ - */␊ - ipv6Address?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An MX record.␊ - */␊ - export interface MxRecord1 {␊ - /**␊ - * Gets or sets the preference metric for this record.␊ - */␊ - preference?: (number | string)␊ - /**␊ - * Gets or sets the domain name of the mail host, without a terminating dot.␊ - */␊ - exchange?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An NS record.␊ - */␊ - export interface NsRecord1 {␊ - /**␊ - * Gets or sets the name server name for this record, without a terminating dot.␊ - */␊ - nsdname?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A PTR record.␊ - */␊ - export interface PtrRecord1 {␊ - /**␊ - * Gets or sets the PTR target domain name for this record without a terminating dot.␊ - */␊ - ptrdname?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An SRV record.␊ - */␊ - export interface SrvRecord1 {␊ - /**␊ - * Gets or sets the priority metric for this record.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * Gets or sets the weight metric for this this record.␊ - */␊ - weight?: (number | string)␊ - /**␊ - * Gets or sets the port of the service for this record.␊ - */␊ - port?: (number | string)␊ - /**␊ - * Gets or sets the domain name of the target for this record, without a terminating dot.␊ - */␊ - target?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A TXT record.␊ - */␊ - export interface TxtRecord1 {␊ - /**␊ - * Gets or sets the text value of this record.␊ - */␊ - value?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A CNAME record.␊ - */␊ - export interface CnameRecord1 {␊ - /**␊ - * Gets or sets the canonical name for this record without a terminating dot.␊ - */␊ - cname?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An SOA record.␊ - */␊ - export interface SoaRecord1 {␊ - /**␊ - * Gets or sets the domain name of the authoritative name server, without a temrinating dot.␊ - */␊ - host?: string␊ - /**␊ - * Gets or sets the email for this record.␊ - */␊ - email?: string␊ - /**␊ - * Gets or sets the serial number for this record.␊ - */␊ - serialNumber?: (number | string)␊ - /**␊ - * Gets or sets the refresh value for this record.␊ - */␊ - refreshTime?: (number | string)␊ - /**␊ - * Gets or sets the retry time for this record.␊ - */␊ - retryTime?: (number | string)␊ - /**␊ - * Gets or sets the expire time for this record.␊ - */␊ - expireTime?: (number | string)␊ - /**␊ - * Gets or sets the minimum TTL value for this record.␊ - */␊ - minimumTTL?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnszones/SRV␊ - */␊ - export interface Dnszones_SRVChildResource1 {␊ - type: "SRV"␊ - apiVersion: "2016-04-01"␊ - /**␊ - * Gets or sets the ID of the resource.␊ - */␊ - id?: string␊ - /**␊ - * Gets or sets the name of the resource.␊ - */␊ - name?: string␊ - /**␊ - * Gets or sets the ETag of the RecordSet.␊ - */␊ - etag?: string␊ - /**␊ - * Gets or sets the properties of the RecordSet.␊ - */␊ - properties: (RecordSetProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnszones/SOA␊ - */␊ - export interface Dnszones_SOAChildResource1 {␊ - type: "SOA"␊ - apiVersion: "2016-04-01"␊ - /**␊ - * Gets or sets the ID of the resource.␊ - */␊ - id?: string␊ - /**␊ - * Gets or sets the name of the resource.␊ - */␊ - name?: string␊ - /**␊ - * Gets or sets the ETag of the RecordSet.␊ - */␊ - etag?: string␊ - /**␊ - * Gets or sets the properties of the RecordSet.␊ - */␊ - properties: (RecordSetProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnszones/PTR␊ - */␊ - export interface Dnszones_PTRChildResource1 {␊ - type: "PTR"␊ - apiVersion: "2016-04-01"␊ - /**␊ - * Gets or sets the ID of the resource.␊ - */␊ - id?: string␊ - /**␊ - * Gets or sets the name of the resource.␊ - */␊ - name?: string␊ - /**␊ - * Gets or sets the ETag of the RecordSet.␊ - */␊ - etag?: string␊ - /**␊ - * Gets or sets the properties of the RecordSet.␊ - */␊ - properties: (RecordSetProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnszones/NS␊ - */␊ - export interface Dnszones_NSChildResource1 {␊ - type: "NS"␊ - apiVersion: "2016-04-01"␊ - /**␊ - * Gets or sets the ID of the resource.␊ - */␊ - id?: string␊ - /**␊ - * Gets or sets the name of the resource.␊ - */␊ - name?: string␊ - /**␊ - * Gets or sets the ETag of the RecordSet.␊ - */␊ - etag?: string␊ - /**␊ - * Gets or sets the properties of the RecordSet.␊ - */␊ - properties: (RecordSetProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnszones/MX␊ - */␊ - export interface Dnszones_MXChildResource1 {␊ - type: "MX"␊ - apiVersion: "2016-04-01"␊ - /**␊ - * Gets or sets the ID of the resource.␊ - */␊ - id?: string␊ - /**␊ - * Gets or sets the name of the resource.␊ - */␊ - name?: string␊ - /**␊ - * Gets or sets the ETag of the RecordSet.␊ - */␊ - etag?: string␊ - /**␊ - * Gets or sets the properties of the RecordSet.␊ - */␊ - properties: (RecordSetProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnszones/CNAME␊ - */␊ - export interface Dnszones_CNAMEChildResource1 {␊ - type: "CNAME"␊ - apiVersion: "2016-04-01"␊ - /**␊ - * Gets or sets the ID of the resource.␊ - */␊ - id?: string␊ - /**␊ - * Gets or sets the name of the resource.␊ - */␊ - name?: string␊ - /**␊ - * Gets or sets the ETag of the RecordSet.␊ - */␊ - etag?: string␊ - /**␊ - * Gets or sets the properties of the RecordSet.␊ - */␊ - properties: (RecordSetProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnszones/AAAA␊ - */␊ - export interface Dnszones_AAAAChildResource1 {␊ - type: "AAAA"␊ - apiVersion: "2016-04-01"␊ - /**␊ - * Gets or sets the ID of the resource.␊ - */␊ - id?: string␊ - /**␊ - * Gets or sets the name of the resource.␊ - */␊ - name?: string␊ - /**␊ - * Gets or sets the ETag of the RecordSet.␊ - */␊ - etag?: string␊ - /**␊ - * Gets or sets the properties of the RecordSet.␊ - */␊ - properties: (RecordSetProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnszones/A␊ - */␊ - export interface Dnszones_AChildResource1 {␊ - type: "A"␊ - apiVersion: "2016-04-01"␊ - /**␊ - * Gets or sets the ID of the resource.␊ - */␊ - id?: string␊ - /**␊ - * Gets or sets the name of the resource.␊ - */␊ - name?: string␊ - /**␊ - * Gets or sets the ETag of the RecordSet.␊ - */␊ - etag?: string␊ - /**␊ - * Gets or sets the properties of the RecordSet.␊ - */␊ - properties: (RecordSetProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnszones/A␊ - */␊ - export interface Dnszones_A1 {␊ - type: "Microsoft.Network/dnszones/A"␊ - apiVersion: "2016-04-01"␊ - /**␊ - * Gets or sets the ID of the resource.␊ - */␊ - id?: string␊ - /**␊ - * Gets or sets the name of the resource.␊ - */␊ - name?: string␊ - /**␊ - * Gets or sets the ETag of the RecordSet.␊ - */␊ - etag?: string␊ - /**␊ - * Gets or sets the properties of the RecordSet.␊ - */␊ - properties: (RecordSetProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnszones/AAAA␊ - */␊ - export interface Dnszones_AAAA1 {␊ - type: "Microsoft.Network/dnszones/AAAA"␊ - apiVersion: "2016-04-01"␊ - /**␊ - * Gets or sets the ID of the resource.␊ - */␊ - id?: string␊ - /**␊ - * Gets or sets the name of the resource.␊ - */␊ - name?: string␊ - /**␊ - * Gets or sets the ETag of the RecordSet.␊ - */␊ - etag?: string␊ - /**␊ - * Gets or sets the properties of the RecordSet.␊ - */␊ - properties: (RecordSetProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnszones/CNAME␊ - */␊ - export interface Dnszones_CNAME1 {␊ - type: "Microsoft.Network/dnszones/CNAME"␊ - apiVersion: "2016-04-01"␊ - /**␊ - * Gets or sets the ID of the resource.␊ - */␊ - id?: string␊ - /**␊ - * Gets or sets the name of the resource.␊ - */␊ - name?: string␊ - /**␊ - * Gets or sets the ETag of the RecordSet.␊ - */␊ - etag?: string␊ - /**␊ - * Gets or sets the properties of the RecordSet.␊ - */␊ - properties: (RecordSetProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnszones/MX␊ - */␊ - export interface Dnszones_MX1 {␊ - type: "Microsoft.Network/dnszones/MX"␊ - apiVersion: "2016-04-01"␊ - /**␊ - * Gets or sets the ID of the resource.␊ - */␊ - id?: string␊ - /**␊ - * Gets or sets the name of the resource.␊ - */␊ - name?: string␊ - /**␊ - * Gets or sets the ETag of the RecordSet.␊ - */␊ - etag?: string␊ - /**␊ - * Gets or sets the properties of the RecordSet.␊ - */␊ - properties: (RecordSetProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnszones/NS␊ - */␊ - export interface Dnszones_NS1 {␊ - type: "Microsoft.Network/dnszones/NS"␊ - apiVersion: "2016-04-01"␊ - /**␊ - * Gets or sets the ID of the resource.␊ - */␊ - id?: string␊ - /**␊ - * Gets or sets the name of the resource.␊ - */␊ - name?: string␊ - /**␊ - * Gets or sets the ETag of the RecordSet.␊ - */␊ - etag?: string␊ - /**␊ - * Gets or sets the properties of the RecordSet.␊ - */␊ - properties: (RecordSetProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnszones/PTR␊ - */␊ - export interface Dnszones_PTR1 {␊ - type: "Microsoft.Network/dnszones/PTR"␊ - apiVersion: "2016-04-01"␊ - /**␊ - * Gets or sets the ID of the resource.␊ - */␊ - id?: string␊ - /**␊ - * Gets or sets the name of the resource.␊ - */␊ - name?: string␊ - /**␊ - * Gets or sets the ETag of the RecordSet.␊ - */␊ - etag?: string␊ - /**␊ - * Gets or sets the properties of the RecordSet.␊ - */␊ - properties: (RecordSetProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnszones/SOA␊ - */␊ - export interface Dnszones_SOA1 {␊ - type: "Microsoft.Network/dnszones/SOA"␊ - apiVersion: "2016-04-01"␊ - /**␊ - * Gets or sets the ID of the resource.␊ - */␊ - id?: string␊ - /**␊ - * Gets or sets the name of the resource.␊ - */␊ - name?: string␊ - /**␊ - * Gets or sets the ETag of the RecordSet.␊ - */␊ - etag?: string␊ - /**␊ - * Gets or sets the properties of the RecordSet.␊ - */␊ - properties: (RecordSetProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnszones/SRV␊ - */␊ - export interface Dnszones_SRV1 {␊ - type: "Microsoft.Network/dnszones/SRV"␊ - apiVersion: "2016-04-01"␊ - /**␊ - * Gets or sets the ID of the resource.␊ - */␊ - id?: string␊ - /**␊ - * Gets or sets the name of the resource.␊ - */␊ - name?: string␊ - /**␊ - * Gets or sets the ETag of the RecordSet.␊ - */␊ - etag?: string␊ - /**␊ - * Gets or sets the properties of the RecordSet.␊ - */␊ - properties: (RecordSetProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnszones/TXT␊ - */␊ - export interface Dnszones_TXT1 {␊ - type: "Microsoft.Network/dnszones/TXT"␊ - apiVersion: "2016-04-01"␊ - /**␊ - * Gets or sets the ID of the resource.␊ - */␊ - id?: string␊ - /**␊ - * Gets or sets the name of the resource.␊ - */␊ - name?: string␊ - /**␊ - * Gets or sets the ETag of the RecordSet.␊ - */␊ - etag?: string␊ - /**␊ - * Gets or sets the properties of the RecordSet.␊ - */␊ - properties: (RecordSetProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Cdn/profiles␊ - */␊ - export interface Profiles {␊ - apiVersion: "2015-06-01"␊ - /**␊ - * Profile location␊ - */␊ - location: string␊ - /**␊ - * Name of the CDN profile within the resource group.␊ - */␊ - name: string␊ - properties: (ProfilePropertiesCreateParameters | string)␊ - resources?: ProfilesEndpointsChildResource[]␊ - /**␊ - * Profile tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Cdn/profiles"␊ - [k: string]: unknown␊ - }␊ - export interface ProfilePropertiesCreateParameters {␊ - /**␊ - * The SKU (pricing tier) of the CDN profile.␊ - */␊ - sku: (Sku26 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The SKU (pricing tier) of the CDN profile.␊ - */␊ - export interface Sku26 {␊ - /**␊ - * Name of the pricing tier.␊ - */␊ - name?: (("Standard" | "Premium") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Cdn/profiles/endpoints␊ - */␊ - export interface ProfilesEndpointsChildResource {␊ - apiVersion: "2015-06-01"␊ - /**␊ - * Endpoint location␊ - */␊ - location: string␊ - /**␊ - * Name of the endpoint within the CDN profile.␊ - */␊ - name: string␊ - properties: (EndpointPropertiesCreateParameters | string)␊ - /**␊ - * Endpoint tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "endpoints"␊ - [k: string]: unknown␊ - }␊ - export interface EndpointPropertiesCreateParameters {␊ - /**␊ - * List of content types on which compression will be applied. The value for the elements should be a valid MIME type.␊ - */␊ - contentTypesToCompress?: (string[] | string)␊ - /**␊ - * Indicates whether content compression is enabled. Default value is false. If compression is enabled, the content transferred from the CDN endpoint to the end user will be compressed. The requested content must be larger than 1 byte and smaller than 1 MB.␊ - */␊ - isCompressionEnabled?: (boolean | string)␊ - /**␊ - * Indicates whether HTTP traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.␊ - */␊ - isHttpAllowed?: (boolean | string)␊ - /**␊ - * Indicates whether https traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.␊ - */␊ - isHttpsAllowed?: (boolean | string)␊ - /**␊ - * The host header CDN provider will send along with content requests to origins. The default value is the host name of the origin.␊ - */␊ - originHostHeader?: string␊ - /**␊ - * The path used for origin requests.␊ - */␊ - originPath?: string␊ - /**␊ - * The set of origins for the CDN endpoint. When multiple origins exist, the first origin will be used as primary and rest will be used as failover options.␊ - */␊ - origins: (DeepCreatedOrigin[] | string)␊ - /**␊ - * Defines the query string caching behavior.␊ - */␊ - queryStringCachingBehavior?: (("IgnoreQueryString" | "BypassCaching" | "UseQueryString" | "NotSet") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Deep created origins within a CDN endpoint.␊ - */␊ - export interface DeepCreatedOrigin {␊ - /**␊ - * Origin name␊ - */␊ - name: string␊ - /**␊ - * Properties of deep created origin on a CDN endpoint.␊ - */␊ - properties?: (DeepCreatedOriginProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of deep created origin on a CDN endpoint.␊ - */␊ - export interface DeepCreatedOriginProperties {␊ - /**␊ - * The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.␊ - */␊ - hostName: string␊ - /**␊ - * The value of the HTTP port. Must be between 1 and 65535␊ - */␊ - httpPort?: (number | string)␊ - /**␊ - * The value of the HTTPS port. Must be between 1 and 65535␊ - */␊ - httpsPort?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Cdn/profiles/endpoints␊ - */␊ - export interface ProfilesEndpoints {␊ - apiVersion: "2015-06-01"␊ - /**␊ - * Endpoint location␊ - */␊ - location: string␊ - /**␊ - * Name of the endpoint within the CDN profile.␊ - */␊ - name: string␊ - properties: (EndpointPropertiesCreateParameters | string)␊ - resources?: (ProfilesEndpointsOriginsChildResource | ProfilesEndpointsCustomDomainsChildResource)[]␊ - /**␊ - * Endpoint tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Cdn/profiles/endpoints"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Cdn/profiles/endpoints/origins␊ - */␊ - export interface ProfilesEndpointsOriginsChildResource {␊ - apiVersion: "2015-06-01"␊ - /**␊ - * Name of the origin, an arbitrary value but it needs to be unique under endpoint␊ - */␊ - name: string␊ - properties: (OriginPropertiesParameters | string)␊ - type: "origins"␊ - [k: string]: unknown␊ - }␊ - export interface OriginPropertiesParameters {␊ - /**␊ - * The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.␊ - */␊ - hostName: string␊ - /**␊ - * The value of the HTTP port. Must be between 1 and 65535.␊ - */␊ - httpPort?: (number | string)␊ - /**␊ - * The value of the HTTPS port. Must be between 1 and 65535.␊ - */␊ - httpsPort?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Cdn/profiles/endpoints/customDomains␊ - */␊ - export interface ProfilesEndpointsCustomDomainsChildResource {␊ - apiVersion: "2015-06-01"␊ - /**␊ - * Name of the custom domain within an endpoint.␊ - */␊ - name: string␊ - properties: (CustomDomainPropertiesParameters | string)␊ - type: "customDomains"␊ - [k: string]: unknown␊ - }␊ - export interface CustomDomainPropertiesParameters {␊ - /**␊ - * The host name of the custom domain. Must be a domain name.␊ - */␊ - hostName: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Cdn/profiles/endpoints/customDomains␊ - */␊ - export interface ProfilesEndpointsCustomDomains {␊ - apiVersion: "2015-06-01"␊ - /**␊ - * Name of the custom domain within an endpoint.␊ - */␊ - name: string␊ - properties: (CustomDomainPropertiesParameters | string)␊ - type: "Microsoft.Cdn/profiles/endpoints/customDomains"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Cdn/profiles/endpoints/origins␊ - */␊ - export interface ProfilesEndpointsOrigins {␊ - apiVersion: "2015-06-01"␊ - /**␊ - * Name of the origin, an arbitrary value but it needs to be unique under endpoint␊ - */␊ - name: string␊ - properties: (OriginPropertiesParameters | string)␊ - type: "Microsoft.Cdn/profiles/endpoints/origins"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Cdn/profiles␊ - */␊ - export interface Profiles1 {␊ - apiVersion: "2016-04-02"␊ - /**␊ - * Profile location␊ - */␊ - location: string␊ - /**␊ - * Name of the CDN profile within the resource group.␊ - */␊ - name: string␊ - resources?: ProfilesEndpointsChildResource1[]␊ - /**␊ - * The SKU (pricing tier) of the CDN profile.␊ - */␊ - sku: (Sku27 | string)␊ - /**␊ - * Profile tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Cdn/profiles"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Cdn/profiles/endpoints␊ - */␊ - export interface ProfilesEndpointsChildResource1 {␊ - apiVersion: "2016-04-02"␊ - /**␊ - * Endpoint location␊ - */␊ - location: string␊ - /**␊ - * Name of the endpoint within the CDN profile.␊ - */␊ - name: string␊ - properties: (EndpointPropertiesCreateParameters1 | string)␊ - /**␊ - * Endpoint tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "endpoints"␊ - [k: string]: unknown␊ - }␊ - export interface EndpointPropertiesCreateParameters1 {␊ - /**␊ - * List of content types on which compression will be applied. The value for the elements should be a valid MIME type.␊ - */␊ - contentTypesToCompress?: (string[] | string)␊ - /**␊ - * Indicates whether content compression is enabled. Default value is false. If compression is enabled, the content transferred from the CDN endpoint to the end user will be compressed. The requested content must be larger than 1 byte and smaller than 1 MB.␊ - */␊ - isCompressionEnabled?: (boolean | string)␊ - /**␊ - * Indicates whether HTTP traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.␊ - */␊ - isHttpAllowed?: (boolean | string)␊ - /**␊ - * Indicates whether https traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.␊ - */␊ - isHttpsAllowed?: (boolean | string)␊ - /**␊ - * The host header CDN provider will send along with content requests to origins. The default value is the host name of the origin.␊ - */␊ - originHostHeader?: string␊ - /**␊ - * The path used for origin requests.␊ - */␊ - originPath?: string␊ - /**␊ - * The set of origins for the CDN endpoint. When multiple origins exist, the first origin will be used as primary and rest will be used as failover options.␊ - */␊ - origins: (DeepCreatedOrigin1[] | string)␊ - /**␊ - * Defines the query string caching behavior.␊ - */␊ - queryStringCachingBehavior?: (("IgnoreQueryString" | "BypassCaching" | "UseQueryString" | "NotSet") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Deep created origins within a CDN endpoint.␊ - */␊ - export interface DeepCreatedOrigin1 {␊ - /**␊ - * Origin name␊ - */␊ - name: string␊ - /**␊ - * Properties of deep created origin on a CDN endpoint.␊ - */␊ - properties?: (DeepCreatedOriginProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of deep created origin on a CDN endpoint.␊ - */␊ - export interface DeepCreatedOriginProperties1 {␊ - /**␊ - * The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.␊ - */␊ - hostName: string␊ - /**␊ - * The value of the HTTP port. Must be between 1 and 65535␊ - */␊ - httpPort?: (number | string)␊ - /**␊ - * The value of the HTTPS port. Must be between 1 and 65535␊ - */␊ - httpsPort?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The SKU (pricing tier) of the CDN profile.␊ - */␊ - export interface Sku27 {␊ - /**␊ - * Name of the pricing tier.␊ - */␊ - name?: (("Standard_Verizon" | "Premium_Verizon" | "Custom_Verizon" | "Standard_Akamai") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Cdn/profiles/endpoints␊ - */␊ - export interface ProfilesEndpoints1 {␊ - apiVersion: "2016-04-02"␊ - /**␊ - * Endpoint location␊ - */␊ - location: string␊ - /**␊ - * Name of the endpoint within the CDN profile.␊ - */␊ - name: string␊ - properties: (EndpointPropertiesCreateParameters1 | string)␊ - resources?: (ProfilesEndpointsOriginsChildResource1 | ProfilesEndpointsCustomDomainsChildResource1)[]␊ - /**␊ - * Endpoint tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Cdn/profiles/endpoints"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Cdn/profiles/endpoints/origins␊ - */␊ - export interface ProfilesEndpointsOriginsChildResource1 {␊ - apiVersion: "2016-04-02"␊ - /**␊ - * Name of the origin, an arbitrary value but it needs to be unique under endpoint␊ - */␊ - name: string␊ - properties: (OriginPropertiesParameters1 | string)␊ - type: "origins"␊ - [k: string]: unknown␊ - }␊ - export interface OriginPropertiesParameters1 {␊ - /**␊ - * The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.␊ - */␊ - hostName: string␊ - /**␊ - * The value of the HTTP port. Must be between 1 and 65535.␊ - */␊ - httpPort?: (number | string)␊ - /**␊ - * The value of the HTTPS port. Must be between 1 and 65535.␊ - */␊ - httpsPort?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Cdn/profiles/endpoints/customDomains␊ - */␊ - export interface ProfilesEndpointsCustomDomainsChildResource1 {␊ - apiVersion: "2016-04-02"␊ - /**␊ - * Name of the custom domain within an endpoint.␊ - */␊ - name: string␊ - properties: (CustomDomainPropertiesParameters1 | string)␊ - type: "customDomains"␊ - [k: string]: unknown␊ - }␊ - export interface CustomDomainPropertiesParameters1 {␊ - /**␊ - * The host name of the custom domain. Must be a domain name.␊ - */␊ - hostName: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Cdn/profiles/endpoints/customDomains␊ - */␊ - export interface ProfilesEndpointsCustomDomains1 {␊ - apiVersion: "2016-04-02"␊ - /**␊ - * Name of the custom domain within an endpoint.␊ - */␊ - name: string␊ - properties: (CustomDomainPropertiesParameters1 | string)␊ - type: "Microsoft.Cdn/profiles/endpoints/customDomains"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Cdn/profiles/endpoints/origins␊ - */␊ - export interface ProfilesEndpointsOrigins1 {␊ - apiVersion: "2016-04-02"␊ - /**␊ - * Name of the origin, an arbitrary value but it needs to be unique under endpoint␊ - */␊ - name: string␊ - properties: (OriginPropertiesParameters1 | string)␊ - type: "Microsoft.Cdn/profiles/endpoints/origins"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Batch/batchAccounts␊ - */␊ - export interface BatchAccounts {␊ - apiVersion: "2015-12-01"␊ - /**␊ - * The region in which to create the account.␊ - */␊ - location: string␊ - /**␊ - * A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.␊ - */␊ - name: string␊ - /**␊ - * The properties of a Batch account.␊ - */␊ - properties: (BatchAccountBaseProperties | string)␊ - resources?: BatchAccountsApplicationsChildResource[]␊ - /**␊ - * The user specified tags associated with the account.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Batch/batchAccounts"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a Batch account.␊ - */␊ - export interface BatchAccountBaseProperties {␊ - /**␊ - * The properties related to auto storage account.␊ - */␊ - autoStorage?: (AutoStorageBaseProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties related to auto storage account.␊ - */␊ - export interface AutoStorageBaseProperties {␊ - /**␊ - * The resource ID of the storage account to be used for auto storage account.␊ - */␊ - storageAccountId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Batch/batchAccounts/applications␊ - */␊ - export interface BatchAccountsApplicationsChildResource {␊ - /**␊ - * A value indicating whether packages within the application may be overwritten using the same version string.␊ - */␊ - allowUpdates?: (boolean | string)␊ - apiVersion: "2015-12-01"␊ - /**␊ - * The display name for the application.␊ - */␊ - displayName?: string␊ - /**␊ - * The ID of the application.␊ - */␊ - name: string␊ - type: "applications"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Batch/batchAccounts/applications␊ - */␊ - export interface BatchAccountsApplications {␊ - /**␊ - * A value indicating whether packages within the application may be overwritten using the same version string.␊ - */␊ - allowUpdates?: (boolean | string)␊ - apiVersion: "2015-12-01"␊ - /**␊ - * The display name for the application.␊ - */␊ - displayName?: string␊ - /**␊ - * The ID of the application.␊ - */␊ - name: string␊ - resources?: BatchAccountsApplicationsVersionsChildResource[]␊ - type: "Microsoft.Batch/batchAccounts/applications"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Batch/batchAccounts/applications/versions␊ - */␊ - export interface BatchAccountsApplicationsVersionsChildResource {␊ - apiVersion: "2015-12-01"␊ - /**␊ - * The version of the application.␊ - */␊ - name: string␊ - type: "versions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Batch/batchAccounts/applications/versions␊ - */␊ - export interface BatchAccountsApplicationsVersions {␊ - apiVersion: "2015-12-01"␊ - /**␊ - * The version of the application.␊ - */␊ - name: string␊ - type: "Microsoft.Batch/batchAccounts/applications/versions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Batch/batchAccounts␊ - */␊ - export interface BatchAccounts1 {␊ - apiVersion: "2017-09-01"␊ - /**␊ - * The region in which to create the account.␊ - */␊ - location: string␊ - /**␊ - * A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.␊ - */␊ - name: string␊ - /**␊ - * The properties of a Batch account.␊ - */␊ - properties: (BatchAccountCreateProperties | string)␊ - resources?: (BatchAccountsApplicationsChildResource1 | BatchAccountsCertificatesChildResource | BatchAccountsPoolsChildResource)[]␊ - /**␊ - * The user-specified tags associated with the account.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Batch/batchAccounts"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a Batch account.␊ - */␊ - export interface BatchAccountCreateProperties {␊ - /**␊ - * The properties related to the auto-storage account.␊ - */␊ - autoStorage?: (AutoStorageBaseProperties1 | string)␊ - /**␊ - * Identifies the Azure key vault associated with a Batch account.␊ - */␊ - keyVaultReference?: (KeyVaultReference | string)␊ - /**␊ - * The pool allocation mode also affects how clients may authenticate to the Batch Service API. If the mode is BatchService, clients may authenticate using access keys or Azure Active Directory. If the mode is UserSubscription, clients must use Azure Active Directory. The default is BatchService.␊ - */␊ - poolAllocationMode?: (("BatchService" | "UserSubscription") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties related to the auto-storage account.␊ - */␊ - export interface AutoStorageBaseProperties1 {␊ - /**␊ - * The resource ID of the storage account to be used for auto-storage account.␊ - */␊ - storageAccountId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identifies the Azure key vault associated with a Batch account.␊ - */␊ - export interface KeyVaultReference {␊ - /**␊ - * The resource ID of the Azure key vault associated with the Batch account.␊ - */␊ - id: string␊ - /**␊ - * The URL of the Azure key vault associated with the Batch account.␊ - */␊ - url: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Batch/batchAccounts/applications␊ - */␊ - export interface BatchAccountsApplicationsChildResource1 {␊ - /**␊ - * A value indicating whether packages within the application may be overwritten using the same version string.␊ - */␊ - allowUpdates?: (boolean | string)␊ - apiVersion: "2017-09-01"␊ - /**␊ - * The display name for the application.␊ - */␊ - displayName?: string␊ - /**␊ - * The ID of the application.␊ - */␊ - name: string␊ - type: "applications"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Batch/batchAccounts/certificates␊ - */␊ - export interface BatchAccountsCertificatesChildResource {␊ - apiVersion: "2017-09-01"␊ - /**␊ - * The identifier for the certificate. This must be made up of algorithm and thumbprint separated by a dash, and must match the certificate data in the request. For example SHA1-a3d1c5.␊ - */␊ - name: string␊ - /**␊ - * Certificate properties for create operations␊ - */␊ - properties: (CertificateCreateOrUpdateProperties | string)␊ - type: "certificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Certificate properties for create operations␊ - */␊ - export interface CertificateCreateOrUpdateProperties {␊ - /**␊ - * The maximum size is 10KB.␊ - */␊ - data: string␊ - /**␊ - * The format of the certificate - either Pfx or Cer. If omitted, the default is Pfx.␊ - */␊ - format?: (("Pfx" | "Cer") | string)␊ - /**␊ - * This is required if the certificate format is pfx and must be omitted if the certificate format is cer.␊ - */␊ - password?: string␊ - /**␊ - * This must match the thumbprint from the name.␊ - */␊ - thumbprint?: string␊ - /**␊ - * This must match the first portion of the certificate name. Currently required to be 'SHA1'.␊ - */␊ - thumbprintAlgorithm?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Batch/batchAccounts/pools␊ - */␊ - export interface BatchAccountsPoolsChildResource {␊ - apiVersion: "2017-09-01"␊ - /**␊ - * The pool name. This must be unique within the account.␊ - */␊ - name: string␊ - /**␊ - * Pool properties.␊ - */␊ - properties: (PoolProperties | string)␊ - type: "pools"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Pool properties.␊ - */␊ - export interface PoolProperties {␊ - /**␊ - * 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.␊ - */␊ - applicationLicenses?: (string[] | string)␊ - /**␊ - * Changes to application packages 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.␊ - */␊ - applicationPackages?: (ApplicationPackageReference[] | string)␊ - /**␊ - * 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.␊ - */␊ - certificates?: (CertificateReference[] | string)␊ - deploymentConfiguration?: (DeploymentConfiguration | string)␊ - /**␊ - * The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.␊ - */␊ - displayName?: string␊ - /**␊ - * This imposes restrictions on which nodes can be assigned to the pool. Enabling this value can reduce the chance of the requested number of nodes to be allocated in the pool. If not specified, this value defaults to 'Disabled'.␊ - */␊ - interNodeCommunication?: (("Enabled" | "Disabled") | string)␊ - maxTasksPerNode?: (number | string)␊ - /**␊ - * The Batch service does not assign any meaning to metadata; it is solely for the use of user code.␊ - */␊ - metadata?: (MetadataItem[] | string)␊ - /**␊ - * The network configuration for a pool.␊ - */␊ - networkConfiguration?: (NetworkConfiguration | string)␊ - /**␊ - * Defines the desired size of the pool. This can either be 'fixedScale' where the requested targetDedicatedNodes is specified, or 'autoScale' which defines a formula which is periodically reevaluated. If this property is not specified, the pool will have a fixed scale with 0 targetDedicatedNodes.␊ - */␊ - scaleSettings?: (ScaleSettings | string)␊ - startTask?: (StartTask | string)␊ - taskSchedulingPolicy?: (TaskSchedulingPolicy | string)␊ - userAccounts?: (UserAccount[] | string)␊ - /**␊ - * For information about available sizes of virtual machines for Cloud Services pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall. 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).␊ - */␊ - vmSize?: string␊ - [k: string]: unknown␊ - }␊ - export interface ApplicationPackageReference {␊ - id: string␊ - /**␊ - * If this is omitted, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences. If you are calling the REST API directly, the HTTP status code is 409.␊ - */␊ - version?: string␊ - [k: string]: unknown␊ - }␊ - export interface CertificateReference {␊ - id: string␊ - /**␊ - * 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.␊ - */␊ - storeLocation?: (("CurrentUser" | "LocalMachine") | string)␊ - /**␊ - * 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.␊ - */␊ - storeName?: string␊ - /**␊ - * 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.␊ - */␊ - visibility?: (("StartTask" | "Task" | "RemoteUser")[] | string)␊ - [k: string]: unknown␊ - }␊ - export interface DeploymentConfiguration {␊ - cloudServiceConfiguration?: (CloudServiceConfiguration | string)␊ - virtualMachineConfiguration?: (VirtualMachineConfiguration | string)␊ - [k: string]: unknown␊ - }␊ - export interface CloudServiceConfiguration {␊ - /**␊ - * 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.␊ - */␊ - currentOSVersion?: string␊ - /**␊ - * 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).␊ - */␊ - osFamily: string␊ - /**␊ - * The default value is * which specifies the latest operating system version for the specified OS family.␊ - */␊ - targetOSVersion?: string␊ - [k: string]: unknown␊ - }␊ - export interface VirtualMachineConfiguration {␊ - /**␊ - * This property must be specified if the compute nodes in the pool need to have empty data disks attached to them.␊ - */␊ - dataDisks?: (DataDisk1[] | string)␊ - imageReference: (ImageReference1 | string)␊ - /**␊ - * 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.␊ - * ␊ - */␊ - licenseType?: string␊ - /**␊ - * 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.␊ - */␊ - nodeAgentSkuId: string␊ - osDisk?: (OSDisk | string)␊ - windowsConfiguration?: (WindowsConfiguration1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Data Disk settings which will be used by the data disks associated to Compute Nodes in the pool.␊ - */␊ - export interface DataDisk1 {␊ - /**␊ - * 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/.␊ - */␊ - caching?: (("None" | "ReadOnly" | "ReadWrite") | string)␊ - diskSizeGB: (number | string)␊ - /**␊ - * The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun.␊ - */␊ - lun: (number | string)␊ - /**␊ - * 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.␊ - */␊ - storageAccountType?: (("Standard_LRS" | "Premium_LRS") | string)␊ - [k: string]: unknown␊ - }␊ - export interface ImageReference1 {␊ - /**␊ - * This property is mutually exclusive with other 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 Batch node agent to communicate with Batch service see https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration .␊ - */␊ - id?: string␊ - /**␊ - * For example, UbuntuServer or WindowsServer.␊ - */␊ - offer?: string␊ - /**␊ - * For example, Canonical or MicrosoftWindowsServer.␊ - */␊ - publisher?: string␊ - /**␊ - * For example, 14.04.0-LTS or 2012-R2-Datacenter.␊ - */␊ - sku?: string␊ - /**␊ - * A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'.␊ - */␊ - version?: string␊ - [k: string]: unknown␊ - }␊ - export interface OSDisk {␊ - /**␊ - * Default value is none.␊ - */␊ - caching?: (("None" | "ReadOnly" | "ReadWrite") | string)␊ - [k: string]: unknown␊ - }␊ - export interface WindowsConfiguration1 {␊ - /**␊ - * If omitted, the default value is true.␊ - */␊ - enableAutomaticUpdates?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Batch service does not assign any meaning to this metadata; it is solely for the use of user code.␊ - */␊ - export interface MetadataItem {␊ - name: string␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The network configuration for a pool.␊ - */␊ - export interface NetworkConfiguration {␊ - endpointConfiguration?: (PoolEndpointConfiguration | string)␊ - /**␊ - * 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 via virtualMachineConfiguration the Batch account must have poolAllocationMode userSubscription in order to use a VNet. 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␊ - */␊ - subnetId?: string␊ - [k: string]: unknown␊ - }␊ - export interface PoolEndpointConfiguration {␊ - /**␊ - * 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.␊ - */␊ - inboundNatPools: (InboundNatPool[] | string)␊ - [k: string]: unknown␊ - }␊ - export interface InboundNatPool {␊ - /**␊ - * 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.␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * 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.␊ - */␊ - frontendPortRangeEnd: (number | string)␊ - /**␊ - * 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.␊ - */␊ - frontendPortRangeStart: (number | string)␊ - /**␊ - * 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.␊ - */␊ - name: string␊ - /**␊ - * 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.␊ - */␊ - networkSecurityGroupRules?: (NetworkSecurityGroupRule[] | string)␊ - protocol: (("TCP" | "UDP") | string)␊ - [k: string]: unknown␊ - }␊ - export interface NetworkSecurityGroupRule {␊ - access: (("Allow" | "Deny") | string)␊ - /**␊ - * 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.␊ - */␊ - priority: (number | string)␊ - /**␊ - * 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.␊ - */␊ - sourceAddressPrefix: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines the desired size of the pool. This can either be 'fixedScale' where the requested targetDedicatedNodes is specified, or 'autoScale' which defines a formula which is periodically reevaluated. If this property is not specified, the pool will have a fixed scale with 0 targetDedicatedNodes.␊ - */␊ - export interface ScaleSettings {␊ - autoScale?: (AutoScaleSettings | string)␊ - fixedScale?: (FixedScaleSettings | string)␊ - [k: string]: unknown␊ - }␊ - export interface AutoScaleSettings {␊ - /**␊ - * If omitted, the default value is 15 minutes (PT15M).␊ - */␊ - evaluationInterval?: string␊ - formula: string␊ - [k: string]: unknown␊ - }␊ - export interface FixedScaleSettings {␊ - /**␊ - * If omitted, the default value is Requeue.␊ - */␊ - nodeDeallocationOption?: (("Requeue" | "Terminate" | "TaskCompletion" | "RetainedData") | string)␊ - /**␊ - * The default value is 15 minutes. Timeout values use ISO 8601 format. For example, use PT10M for 10 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).␊ - */␊ - resizeTimeout?: string␊ - /**␊ - * At least one of targetDedicatedNodes, targetLowPriority nodes must be set.␊ - */␊ - targetDedicatedNodes?: (number | string)␊ - /**␊ - * At least one of targetDedicatedNodes, targetLowPriority nodes must be set.␊ - */␊ - targetLowPriorityNodes?: (number | string)␊ - [k: string]: unknown␊ - }␊ - export interface StartTask {␊ - /**␊ - * 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. Required if any other properties of the startTask are specified.␊ - */␊ - commandLine?: string␊ - environmentSettings?: (EnvironmentSetting[] | string)␊ - /**␊ - * 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.␊ - */␊ - maxTaskRetryCount?: (number | string)␊ - resourceFiles?: (ResourceFile[] | string)␊ - /**␊ - * Specify either the userName or autoUser property, but not both.␊ - */␊ - userIdentity?: (UserIdentity1 | string)␊ - /**␊ - * 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 scheduling error detail. 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.␊ - */␊ - waitForSuccess?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - export interface EnvironmentSetting {␊ - name: string␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - export interface ResourceFile {␊ - /**␊ - * 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.␊ - */␊ - blobSource: string␊ - /**␊ - * 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.␊ - */␊ - fileMode?: string␊ - filePath: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specify either the userName or autoUser property, but not both.␊ - */␊ - export interface UserIdentity1 {␊ - autoUser?: (AutoUserSpecification | string)␊ - /**␊ - * The userName and autoUser properties are mutually exclusive; you must specify one but not both.␊ - */␊ - userName?: string␊ - [k: string]: unknown␊ - }␊ - export interface AutoUserSpecification {␊ - /**␊ - * 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.␊ - */␊ - elevationLevel?: (("NonAdmin" | "Admin") | string)␊ - /**␊ - * 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.␊ - */␊ - scope?: (("Task" | "Pool") | string)␊ - [k: string]: unknown␊ - }␊ - export interface TaskSchedulingPolicy {␊ - nodeFillType: (("Spread" | "Pack") | string)␊ - [k: string]: unknown␊ - }␊ - export interface UserAccount {␊ - /**␊ - * 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.␊ - */␊ - elevationLevel?: (("NonAdmin" | "Admin") | string)␊ - linuxUserConfiguration?: (LinuxUserConfiguration | string)␊ - name: string␊ - password: string␊ - [k: string]: unknown␊ - }␊ - export interface LinuxUserConfiguration {␊ - /**␊ - * The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid.␊ - */␊ - gid?: (number | string)␊ - /**␊ - * 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).␊ - */␊ - sshPrivateKey?: string␊ - /**␊ - * The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid.␊ - */␊ - uid?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Batch/batchAccounts/applications␊ - */␊ - export interface BatchAccountsApplications1 {␊ - /**␊ - * A value indicating whether packages within the application may be overwritten using the same version string.␊ - */␊ - allowUpdates?: (boolean | string)␊ - apiVersion: "2017-09-01"␊ - /**␊ - * The display name for the application.␊ - */␊ - displayName?: string␊ - /**␊ - * The ID of the application.␊ - */␊ - name: string␊ - resources?: BatchAccountsApplicationsVersionsChildResource1[]␊ - type: "Microsoft.Batch/batchAccounts/applications"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Batch/batchAccounts/applications/versions␊ - */␊ - export interface BatchAccountsApplicationsVersionsChildResource1 {␊ - apiVersion: "2017-09-01"␊ - /**␊ - * The version of the application.␊ - */␊ - name: string␊ - type: "versions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Batch/batchAccounts/applications/versions␊ - */␊ - export interface BatchAccountsApplicationsVersions1 {␊ - apiVersion: "2017-09-01"␊ - /**␊ - * The version of the application.␊ - */␊ - name: string␊ - type: "Microsoft.Batch/batchAccounts/applications/versions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Batch/batchAccounts/certificates␊ - */␊ - export interface BatchAccountsCertificates {␊ - apiVersion: "2017-09-01"␊ - /**␊ - * The identifier for the certificate. This must be made up of algorithm and thumbprint separated by a dash, and must match the certificate data in the request. For example SHA1-a3d1c5.␊ - */␊ - name: string␊ - /**␊ - * Certificate properties for create operations␊ - */␊ - properties: (CertificateCreateOrUpdateProperties | string)␊ - type: "Microsoft.Batch/batchAccounts/certificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Batch/batchAccounts/pools␊ - */␊ - export interface BatchAccountsPools {␊ - apiVersion: "2017-09-01"␊ - /**␊ - * The pool name. This must be unique within the account.␊ - */␊ - name: string␊ - /**␊ - * Pool properties.␊ - */␊ - properties: (PoolProperties | string)␊ - type: "Microsoft.Batch/batchAccounts/pools"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Cache/Redis␊ - */␊ - export interface Redis3 {␊ - apiVersion: "2016-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the Redis cache.␊ - */␊ - name: string␊ - /**␊ - * Properties supplied to Create Redis operation.␊ - */␊ - properties: (RedisCreateProperties1 | string)␊ - resources?: (RedisFirewallRulesChildResource1 | RedisPatchSchedulesChildResource1)[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Cache/Redis"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties supplied to Create Redis operation.␊ - */␊ - export interface RedisCreateProperties1 {␊ - /**␊ - * Specifies whether the non-ssl Redis server port (6379) is enabled.␊ - */␊ - enableNonSslPort?: (boolean | string)␊ - /**␊ - * All Redis Settings. Few possible keys: rdb-backup-enabled,rdb-storage-connection-string,rdb-backup-frequency,maxmemory-delta,maxmemory-policy,notify-keyspace-events,maxmemory-samples,slowlog-log-slower-than,slowlog-max-len,list-max-ziplist-entries,list-max-ziplist-value,hash-max-ziplist-entries,hash-max-ziplist-value,set-max-intset-entries,zset-max-ziplist-entries,zset-max-ziplist-value etc.␊ - */␊ - redisConfiguration?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The number of shards to be created on a Premium Cluster Cache.␊ - */␊ - shardCount?: (number | string)␊ - /**␊ - * SKU parameters supplied to the create Redis operation.␊ - */␊ - sku: (Sku28 | string)␊ - /**␊ - * Static IP address. Required when deploying a Redis cache inside an existing Azure Virtual Network.␊ - */␊ - staticIP?: string␊ - /**␊ - * The full resource ID of a subnet in a virtual network to deploy the Redis cache in. Example format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft.{Network|ClassicNetwork}/VirtualNetworks/vnet1/subnets/subnet1␊ - */␊ - subnetId?: string␊ - /**␊ - * tenantSettings␊ - */␊ - tenantSettings?: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU parameters supplied to the create Redis operation.␊ - */␊ - export interface Sku28 {␊ - /**␊ - * The size of the Redis cache to deploy. Valid values: for C (Basic/Standard) family (0, 1, 2, 3, 4, 5, 6), for P (Premium) family (1, 2, 3, 4).␊ - */␊ - capacity: (number | string)␊ - /**␊ - * The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium).␊ - */␊ - family: (("C" | "P") | string)␊ - /**␊ - * The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium).␊ - */␊ - name: (("Basic" | "Standard" | "Premium") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Cache/Redis/firewallRules␊ - */␊ - export interface RedisFirewallRulesChildResource1 {␊ - apiVersion: "2016-04-01"␊ - /**␊ - * The name of the firewall rule.␊ - */␊ - name: string␊ - /**␊ - * Specifies a range of IP addresses permitted to connect to the cache␊ - */␊ - properties: (RedisFirewallRuleProperties1 | string)␊ - type: "firewallRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies a range of IP addresses permitted to connect to the cache␊ - */␊ - export interface RedisFirewallRuleProperties1 {␊ - /**␊ - * highest IP address included in the range␊ - */␊ - endIP: string␊ - /**␊ - * lowest IP address included in the range␊ - */␊ - startIP: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Cache/Redis/patchSchedules␊ - */␊ - export interface RedisPatchSchedulesChildResource1 {␊ - apiVersion: "2016-04-01"␊ - name: "default"␊ - /**␊ - * List of patch schedules for a Redis cache.␊ - */␊ - properties: (ScheduleEntries1 | string)␊ - type: "patchSchedules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * List of patch schedules for a Redis cache.␊ - */␊ - export interface ScheduleEntries1 {␊ - /**␊ - * List of patch schedules for a Redis cache.␊ - */␊ - scheduleEntries: (ScheduleEntry1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Patch schedule entry for a Premium Redis Cache.␊ - */␊ - export interface ScheduleEntry1 {␊ - /**␊ - * Day of the week when a cache can be patched.␊ - */␊ - dayOfWeek: (("Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday" | "Sunday" | "Everyday" | "Weekend") | string)␊ - /**␊ - * ISO8601 timespan specifying how much time cache patching can take. ␊ - */␊ - maintenanceWindow?: string␊ - /**␊ - * Start hour after which cache patching can start.␊ - */␊ - startHourUtc: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Cache/Redis/firewallRules␊ - */␊ - export interface RedisFirewallRules1 {␊ - apiVersion: "2016-04-01"␊ - /**␊ - * The name of the firewall rule.␊ - */␊ - name: string␊ - /**␊ - * Specifies a range of IP addresses permitted to connect to the cache␊ - */␊ - properties: (RedisFirewallRuleProperties1 | string)␊ - type: "Microsoft.Cache/Redis/firewallRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Cache/Redis/patchSchedules␊ - */␊ - export interface RedisPatchSchedules1 {␊ - apiVersion: "2016-04-01"␊ - name: string␊ - /**␊ - * List of patch schedules for a Redis cache.␊ - */␊ - properties: (ScheduleEntries1 | string)␊ - type: "Microsoft.Cache/Redis/patchSchedules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Logic/workflows␊ - */␊ - export interface Workflows {␊ - type: "Microsoft.Logic/workflows"␊ - apiVersion: "2015-02-01-preview"␊ - /**␊ - * Gets or sets the workflow properties.␊ - */␊ - properties: (WorkflowProperties | string)␊ - [k: string]: unknown␊ - }␊ - export interface WorkflowProperties {␊ - /**␊ - * Gets or sets the state.␊ - */␊ - state?: (("NotSpecified" | "Enabled" | "Disabled" | "Deleted" | "Suspended") | string)␊ - /**␊ - * Gets or sets the sku.␊ - */␊ - sku?: (Sku29 | string)␊ - /**␊ - * Gets or sets the definition.␊ - */␊ - definition?: ({␊ - [k: string]: unknown␊ - } | string)␊ - /**␊ - * Gets or sets the parameters.␊ - */␊ - parameters?: ({␊ - [k: string]: WorkflowParameter␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - export interface Sku29 {␊ - /**␊ - * Gets or sets the name.␊ - */␊ - name?: (("NotSpecified" | "Free" | "Shared" | "Basic" | "Standard" | "Premium") | string)␊ - /**␊ - * Gets or sets the reference to plan.␊ - */␊ - plan?: (ResourceReference | string)␊ - [k: string]: unknown␊ - }␊ - export interface ResourceReference {␊ - /**␊ - * Gets or sets the resource id.␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - export interface WorkflowParameter {␊ - /**␊ - * Gets or sets the type.␊ - */␊ - type?: ("NotSpecified" | "String" | "SecureString" | "Int" | "Float" | "Bool" | "Array" | "Object" | "SecureObject")␊ - /**␊ - * Gets or sets the value.␊ - */␊ - value?: ({␊ - [k: string]: unknown␊ - } | string)␊ - /**␊ - * Gets or sets the metadata.␊ - */␊ - metadata?: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Logic/workflows␊ - */␊ - export interface Workflows1 {␊ - type: "Microsoft.Logic/workflows"␊ - apiVersion: "2016-06-01"␊ - /**␊ - * The resource id.␊ - */␊ - id?: string␊ - /**␊ - * Gets the resource name.␊ - */␊ - name?: string␊ - /**␊ - * The resource location.␊ - */␊ - location?: string␊ - /**␊ - * The resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The workflow properties.␊ - */␊ - properties: (WorkflowProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - export interface WorkflowProperties1 {␊ - /**␊ - * The state.␊ - */␊ - state?: (("NotSpecified" | "Completed" | "Enabled" | "Disabled" | "Deleted" | "Suspended") | string)␊ - /**␊ - * The sku.␊ - */␊ - sku?: (Sku30 | string)␊ - /**␊ - * The integration account.␊ - */␊ - integrationAccount?: (ResourceReference1 | string)␊ - /**␊ - * The definition.␊ - */␊ - definition?: ({␊ - [k: string]: unknown␊ - } | string)␊ - /**␊ - * The parameters.␊ - */␊ - parameters?: ({␊ - [k: string]: WorkflowParameter1␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - export interface Sku30 {␊ - /**␊ - * The name.␊ - */␊ - name?: (("NotSpecified" | "Free" | "Shared" | "Basic" | "Standard" | "Premium") | string)␊ - /**␊ - * The reference to plan.␊ - */␊ - plan?: (ResourceReference1 | string)␊ - [k: string]: unknown␊ - }␊ - export interface ResourceReference1 {␊ - /**␊ - * The resource id.␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - export interface WorkflowParameter1 {␊ - /**␊ - * The type.␊ - */␊ - type?: ("NotSpecified" | "String" | "SecureString" | "Int" | "Float" | "Bool" | "Array" | "Object" | "SecureObject")␊ - /**␊ - * The value.␊ - */␊ - value?: ({␊ - [k: string]: unknown␊ - } | string)␊ - /**␊ - * The metadata.␊ - */␊ - metadata?: ({␊ - [k: string]: unknown␊ - } | string)␊ - /**␊ - * The description.␊ - */␊ - description?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Logic/integrationAccounts␊ - */␊ - export interface IntegrationAccounts {␊ - type: "Microsoft.Logic/integrationAccounts"␊ - apiVersion: "2016-06-01"␊ - /**␊ - * The resource id.␊ - */␊ - id?: string␊ - /**␊ - * Gets the resource name.␊ - */␊ - name?: string␊ - /**␊ - * The resource location.␊ - */␊ - location?: string␊ - /**␊ - * The resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The integrationAccount properties.␊ - */␊ - properties?: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Logic/integrationAccounts/agreements␊ - */␊ - export interface IntegrationAccountsAgreements {␊ - type: "Microsoft.Logic/integrationAccounts/agreements"␊ - apiVersion: "2016-06-01"␊ - /**␊ - * The resource id.␊ - */␊ - id?: string␊ - /**␊ - * Gets the resource name.␊ - */␊ - name?: string␊ - /**␊ - * The resource location.␊ - */␊ - location?: string␊ - /**␊ - * The resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The integrationAccount agreement properties.␊ - */␊ - properties: (IntegrationAccountsAgreementsProperties | string)␊ - [k: string]: unknown␊ - }␊ - export interface IntegrationAccountsAgreementsProperties {␊ - /**␊ - * The host partner.␊ - */␊ - hostPartner?: string␊ - /**␊ - * The guest partner.␊ - */␊ - guestPartner?: string␊ - /**␊ - * The host identity.␊ - */␊ - hostIdentity?: (IdentityProperties1 | string)␊ - /**␊ - * The guest identity.␊ - */␊ - guestIdentity?: (IdentityProperties1 | string)␊ - /**␊ - * The agreement type.␊ - */␊ - agreementType?: string␊ - /**␊ - * The content.␊ - */␊ - content?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The metadata.␊ - */␊ - metadata?: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - export interface IdentityProperties1 {␊ - /**␊ - * The qualifier.␊ - */␊ - qualifier?: string␊ - /**␊ - * The value.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Logic/integrationAccounts/certificates␊ - */␊ - export interface IntegrationAccountsCertificates {␊ - type: "Microsoft.Logic/integrationAccounts/certificates"␊ - apiVersion: "2016-06-01"␊ - /**␊ - * The resource id.␊ - */␊ - id?: string␊ - /**␊ - * Gets the resource name.␊ - */␊ - name?: string␊ - /**␊ - * The resource location.␊ - */␊ - location?: string␊ - /**␊ - * The resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The integrationAccount properties.␊ - */␊ - properties: (IntegrationAccountsCertificatesProperties | string)␊ - [k: string]: unknown␊ - }␊ - export interface IntegrationAccountsCertificatesProperties {␊ - /**␊ - * The public certificate.␊ - */␊ - publicCertificate?: string␊ - /**␊ - * The key properties.␊ - */␊ - key?: (KeyProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - export interface KeyProperties2 {␊ - /**␊ - * The keyName.␊ - */␊ - keyName?: string␊ - /**␊ - * The key properties.␊ - */␊ - keyVault?: (KeyVaultProperties14 | string)␊ - [k: string]: unknown␊ - }␊ - export interface KeyVaultProperties14 {␊ - /**␊ - * The name.␊ - */␊ - name?: string␊ - /**␊ - * The id.␊ - */␊ - id?: string␊ - type?: "Microsoft.KeyVault/vaults"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Logic/integrationAccounts/maps␊ - */␊ - export interface IntegrationAccountsMaps {␊ - type: "Microsoft.Logic/integrationAccounts/maps"␊ - apiVersion: "2016-06-01"␊ - /**␊ - * The resource id.␊ - */␊ - id?: string␊ - /**␊ - * Gets the resource name.␊ - */␊ - name?: string␊ - /**␊ - * The resource location.␊ - */␊ - location?: string␊ - /**␊ - * The resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The integrationAccounts maps properties.␊ - */␊ - properties: (IntegrationAccountsMapsProperties | string)␊ - [k: string]: unknown␊ - }␊ - export interface IntegrationAccountsMapsProperties {␊ - /**␊ - * The map type.␊ - */␊ - mapType?: string␊ - /**␊ - * The content.␊ - */␊ - content?: string␊ - /**␊ - * The content link properties.␊ - */␊ - contentLink?: (ContentLinkProperties | string)␊ - /**␊ - * The contentType.␊ - */␊ - contentType?: string␊ - [k: string]: unknown␊ - }␊ - export interface ContentLinkProperties {␊ - /**␊ - * The uri.␊ - */␊ - uri?: string␊ - /**␊ - * The content version.␊ - */␊ - contentVersion?: string␊ - /**␊ - * The content size.␊ - */␊ - contentSize?: (number | string)␊ - /**␊ - * The content hash properties.␊ - */␊ - contentHash?: (ContentHashProperties | string)␊ - [k: string]: unknown␊ - }␊ - export interface ContentHashProperties {␊ - /**␊ - * The algorithm.␊ - */␊ - algorithm?: string␊ - /**␊ - * The value.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Logic/integrationAccounts/partners␊ - */␊ - export interface IntegrationAccountsPartners {␊ - type: "Microsoft.Logic/integrationAccounts/partners"␊ - apiVersion: "2016-06-01"␊ - /**␊ - * The resource id.␊ - */␊ - id?: string␊ - /**␊ - * Gets the resource name.␊ - */␊ - name?: string␊ - /**␊ - * The resource location.␊ - */␊ - location?: string␊ - /**␊ - * The resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The integrationAccount partner properties.␊ - */␊ - properties: (IntegrationAccountsPartnersProperties | string)␊ - [k: string]: unknown␊ - }␊ - export interface IntegrationAccountsPartnersProperties {␊ - /**␊ - * The partner type.␊ - */␊ - partnerType?: string␊ - /**␊ - * The metadata.␊ - */␊ - metadata?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The content.␊ - */␊ - content?: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Logic/integrationAccounts/schemas␊ - */␊ - export interface IntegrationAccountsSchemas {␊ - type: "Microsoft.Logic/integrationAccounts/schemas"␊ - apiVersion: "2016-06-01"␊ - /**␊ - * The resource id.␊ - */␊ - id?: string␊ - /**␊ - * Gets the resource name.␊ - */␊ - name?: string␊ - /**␊ - * The resource location.␊ - */␊ - location?: string␊ - /**␊ - * The resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The integrationAccounts schemas properties.␊ - */␊ - properties: (IntegrationAccountsSchemasProperties | string)␊ - [k: string]: unknown␊ - }␊ - export interface IntegrationAccountsSchemasProperties {␊ - /**␊ - * The schema type.␊ - */␊ - schemaType?: string␊ - /**␊ - * The target anmespace.␊ - */␊ - targetNamespace?: string␊ - /**␊ - * The document name.␊ - */␊ - documentName?: string␊ - /**␊ - * The content.␊ - */␊ - content?: string␊ - /**␊ - * The content link properties.␊ - */␊ - contentLink?: (ContentLinkProperties | string)␊ - /**␊ - * The contentType.␊ - */␊ - contentType?: string␊ - /**␊ - * The metadata.␊ - */␊ - metadata?: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Logic/integrationAccounts/assemblies␊ - */␊ - export interface IntegrationAccountsAssemblies {␊ - type: "Microsoft.Logic/integrationAccounts/assemblies"␊ - apiVersion: "2016-06-01"␊ - /**␊ - * The resource id.␊ - */␊ - id?: string␊ - /**␊ - * Gets the resource name.␊ - */␊ - name?: string␊ - /**␊ - * The resource location.␊ - */␊ - location?: string␊ - /**␊ - * The resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The integrationAccounts assemblies properties.␊ - */␊ - properties: (IntegrationAccountsAssembliesProperties | string)␊ - [k: string]: unknown␊ - }␊ - export interface IntegrationAccountsAssembliesProperties {␊ - /**␊ - * The map type.␊ - */␊ - assemblyName?: string␊ - /**␊ - * The map type.␊ - */␊ - assemblyVersion?: string␊ - /**␊ - * The content.␊ - */␊ - content?: string␊ - /**␊ - * The content link properties.␊ - */␊ - contentLink?: (ContentLinkProperties | string)␊ - /**␊ - * The contentType.␊ - */␊ - contentType?: string␊ - /**␊ - * The metadata.␊ - */␊ - metadata?: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Logic/integrationAccounts/batchConfigurations␊ - */␊ - export interface IntegrationAccountsBatchConfigurations {␊ - type: "Microsoft.Logic/integrationAccounts/batchConfigurations"␊ - apiVersion: "2016-06-01"␊ - /**␊ - * The resource id.␊ - */␊ - id?: string␊ - /**␊ - * Gets the resource name.␊ - */␊ - name?: string␊ - /**␊ - * The resource location.␊ - */␊ - location?: string␊ - /**␊ - * The resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The integration account batch configuration properties.␊ - */␊ - properties: (IntegrationAccountsBatchConfigurationsProperties | string)␊ - [k: string]: unknown␊ - }␊ - export interface IntegrationAccountsBatchConfigurationsProperties {␊ - /**␊ - * The batch group name.␊ - */␊ - batchGroupName?: string␊ - /**␊ - * The batch release criteria.␊ - */␊ - releaseCriteria?: (BatchReleaseCriteriaProperties | string)␊ - /**␊ - * The metadata.␊ - */␊ - metadata?: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - export interface BatchReleaseCriteriaProperties {␊ - /**␊ - * The message count.␊ - */␊ - messageCount?: number␊ - /**␊ - * The batch size.␊ - */␊ - batchSize?: number␊ - /**␊ - * The batch release recurrence.␊ - */␊ - recurrence?: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Logic/workflows␊ - */␊ - export interface Workflows2 {␊ - type: "Microsoft.Logic/workflows"␊ - apiVersion: "2016-10-01"␊ - /**␊ - * The resource id.␊ - */␊ - id?: string␊ - /**␊ - * Gets the resource name.␊ - */␊ - name?: string␊ - /**␊ - * The resource location.␊ - */␊ - location?: string␊ - /**␊ - * The resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The workflow properties.␊ - */␊ - properties: (WorkflowProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - export interface WorkflowProperties2 {␊ - /**␊ - * The state.␊ - */␊ - state?: (("NotSpecified" | "Completed" | "Enabled" | "Disabled" | "Deleted" | "Suspended") | string)␊ - /**␊ - * The integration account.␊ - */␊ - integrationAccount?: (ResourceReference2 | string)␊ - /**␊ - * The definition.␊ - */␊ - definition?: ({␊ - [k: string]: unknown␊ - } | string)␊ - /**␊ - * The parameters.␊ - */␊ - parameters?: ({␊ - [k: string]: WorkflowParameter2␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - export interface ResourceReference2 {␊ - /**␊ - * The resource id.␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - export interface WorkflowParameter2 {␊ - /**␊ - * The type.␊ - */␊ - type?: ("NotSpecified" | "String" | "SecureString" | "Int" | "Float" | "Bool" | "Array" | "Object" | "SecureObject")␊ - /**␊ - * The value.␊ - */␊ - value?: ({␊ - [k: string]: unknown␊ - } | string)␊ - /**␊ - * The metadata.␊ - */␊ - metadata?: ({␊ - [k: string]: unknown␊ - } | string)␊ - /**␊ - * The description.␊ - */␊ - description?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Logic/workflows␊ - */␊ - export interface Workflows3 {␊ - type: "Microsoft.Logic/workflows"␊ - apiVersion: "2017-07-01"␊ - /**␊ - * The resource id.␊ - */␊ - id?: string␊ - /**␊ - * Gets the resource name.␊ - */␊ - name?: string␊ - /**␊ - * The resource location.␊ - */␊ - location?: string␊ - /**␊ - * The resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The workflow properties.␊ - */␊ - properties: (WorkflowProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - export interface WorkflowProperties3 {␊ - /**␊ - * The state.␊ - */␊ - state?: (("NotSpecified" | "Completed" | "Enabled" | "Disabled" | "Deleted" | "Suspended") | string)␊ - /**␊ - * The integration account.␊ - */␊ - integrationAccount?: (ResourceReference3 | string)␊ - /**␊ - * The definition.␊ - */␊ - definition?: ({␊ - [k: string]: unknown␊ - } | string)␊ - /**␊ - * The parameters.␊ - */␊ - parameters?: ({␊ - [k: string]: WorkflowParameter3␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - export interface ResourceReference3 {␊ - /**␊ - * The resource id.␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - export interface WorkflowParameter3 {␊ - /**␊ - * The type.␊ - */␊ - type?: ("NotSpecified" | "String" | "SecureString" | "Int" | "Float" | "Bool" | "Array" | "Object" | "SecureObject")␊ - /**␊ - * The value.␊ - */␊ - value?: ({␊ - [k: string]: unknown␊ - } | string)␊ - /**␊ - * The metadata.␊ - */␊ - metadata?: ({␊ - [k: string]: unknown␊ - } | string)␊ - /**␊ - * The description.␊ - */␊ - description?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Scheduler/jobCollections␊ - */␊ - export interface JobCollections1 {␊ - apiVersion: "2016-03-01"␊ - /**␊ - * Gets or sets the storage account location.␊ - */␊ - location?: string␊ - /**␊ - * The job collection name.␊ - */␊ - name: string␊ - properties: (JobCollectionProperties1 | string)␊ - resources?: JobCollectionsJobsChildResource1[]␊ - /**␊ - * Gets or sets the tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Scheduler/jobCollections"␊ - [k: string]: unknown␊ - }␊ - export interface JobCollectionProperties1 {␊ - quota?: (JobCollectionQuota1 | string)␊ - sku?: (Sku31 | string)␊ - /**␊ - * Gets or sets the state.␊ - */␊ - state?: (("Enabled" | "Disabled" | "Suspended" | "Deleted") | string)␊ - [k: string]: unknown␊ - }␊ - export interface JobCollectionQuota1 {␊ - /**␊ - * Gets or set the maximum job count.␊ - */␊ - maxJobCount?: (number | string)␊ - /**␊ - * Gets or sets the maximum job occurrence.␊ - */␊ - maxJobOccurrence?: (number | string)␊ - maxRecurrence?: (JobMaxRecurrence1 | string)␊ - [k: string]: unknown␊ - }␊ - export interface JobMaxRecurrence1 {␊ - /**␊ - * Gets or sets the frequency of recurrence (second, minute, hour, day, week, month).␊ - */␊ - frequency?: (("Minute" | "Hour" | "Day" | "Week" | "Month") | string)␊ - /**␊ - * Gets or sets the interval between retries.␊ - */␊ - interval?: (number | string)␊ - [k: string]: unknown␊ - }␊ - export interface Sku31 {␊ - /**␊ - * Gets or set the SKU.␊ - */␊ - name?: (("Standard" | "Free" | "P10Premium" | "P20Premium") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Scheduler/jobCollections/jobs␊ - */␊ - export interface JobCollectionsJobsChildResource1 {␊ - apiVersion: "2016-03-01"␊ - /**␊ - * The job name.␊ - */␊ - name: string␊ - properties: (JobProperties1 | string)␊ - type: "jobs"␊ - [k: string]: unknown␊ - }␊ - export interface JobProperties1 {␊ - action?: (JobAction1 | string)␊ - recurrence?: (JobRecurrence1 | string)␊ - /**␊ - * Gets or sets the job start time.␊ - */␊ - startTime?: string␊ - /**␊ - * Gets or set the job state.␊ - */␊ - state?: (("Enabled" | "Disabled" | "Faulted" | "Completed") | string)␊ - [k: string]: unknown␊ - }␊ - export interface JobAction1 {␊ - errorAction?: (JobErrorAction1 | string)␊ - queueMessage?: (StorageQueueMessage1 | string)␊ - request?: (HttpRequest1 | string)␊ - retryPolicy?: (RetryPolicy1 | string)␊ - serviceBusQueueMessage?: (ServiceBusQueueMessage1 | string)␊ - serviceBusTopicMessage?: (ServiceBusTopicMessage1 | string)␊ - /**␊ - * Gets or sets the job action type.␊ - */␊ - type?: (("Http" | "Https" | "StorageQueue" | "ServiceBusQueue" | "ServiceBusTopic") | string)␊ - [k: string]: unknown␊ - }␊ - export interface JobErrorAction1 {␊ - queueMessage?: (StorageQueueMessage1 | string)␊ - request?: (HttpRequest1 | string)␊ - retryPolicy?: (RetryPolicy1 | string)␊ - serviceBusQueueMessage?: (ServiceBusQueueMessage1 | string)␊ - serviceBusTopicMessage?: (ServiceBusTopicMessage1 | string)␊ - /**␊ - * Gets or sets the job error action type.␊ - */␊ - type?: (("Http" | "Https" | "StorageQueue" | "ServiceBusQueue" | "ServiceBusTopic") | string)␊ - [k: string]: unknown␊ - }␊ - export interface StorageQueueMessage1 {␊ - /**␊ - * Gets or sets the message.␊ - */␊ - message?: string␊ - /**␊ - * Gets or sets the queue name.␊ - */␊ - queueName?: string␊ - /**␊ - * Gets or sets the SAS key.␊ - */␊ - sasToken?: string␊ - /**␊ - * Gets or sets the storage account name.␊ - */␊ - storageAccount?: string␊ - [k: string]: unknown␊ - }␊ - export interface HttpRequest1 {␊ - authentication?: (HttpAuthentication1 | string)␊ - /**␊ - * Gets or sets the request body.␊ - */␊ - body?: string␊ - /**␊ - * Gets or sets the headers.␊ - */␊ - headers?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Gets or sets the method of the request.␊ - */␊ - method?: string␊ - /**␊ - * Gets or sets the URI of the request.␊ - */␊ - uri?: string␊ - [k: string]: unknown␊ - }␊ - export interface ClientCertAuthentication {␊ - /**␊ - * Gets or sets the certificate expiration date.␊ - */␊ - certificateExpirationDate?: string␊ - /**␊ - * Gets or sets the certificate subject name.␊ - */␊ - certificateSubjectName?: string␊ - /**␊ - * Gets or sets the certificate thumbprint.␊ - */␊ - certificateThumbprint?: string␊ - /**␊ - * Gets or sets the certificate password, return value will always be empty.␊ - */␊ - password?: string␊ - /**␊ - * Gets or sets the pfx certificate. Accepts certification in base64 encoding, return value will always be empty.␊ - */␊ - pfx?: string␊ - type: "ClientCertificate"␊ - [k: string]: unknown␊ - }␊ - export interface BasicAuthentication {␊ - /**␊ - * Gets or sets the password, return value will always be empty.␊ - */␊ - password?: string␊ - type: "Basic"␊ - /**␊ - * Gets or sets the username.␊ - */␊ - username?: string␊ - [k: string]: unknown␊ - }␊ - export interface OAuthAuthentication {␊ - /**␊ - * Gets or sets the audience.␊ - */␊ - audience?: string␊ - /**␊ - * Gets or sets the client identifier.␊ - */␊ - clientId?: string␊ - /**␊ - * Gets or sets the secret, return value will always be empty.␊ - */␊ - secret?: string␊ - /**␊ - * Gets or sets the tenant.␊ - */␊ - tenant?: string␊ - type: "ActiveDirectoryOAuth"␊ - [k: string]: unknown␊ - }␊ - export interface RetryPolicy1 {␊ - /**␊ - * Gets or sets the number of times a retry should be attempted.␊ - */␊ - retryCount?: (number | string)␊ - /**␊ - * Gets or sets the retry interval between retries, specify duration in ISO 8601 format.␊ - */␊ - retryInterval?: string␊ - /**␊ - * Gets or sets the retry strategy to be used.␊ - */␊ - retryType?: (("None" | "Fixed") | string)␊ - [k: string]: unknown␊ - }␊ - export interface ServiceBusQueueMessage1 {␊ - authentication?: (ServiceBusAuthentication1 | string)␊ - brokeredMessageProperties?: (ServiceBusBrokeredMessageProperties1 | string)␊ - /**␊ - * Gets or sets the custom message properties.␊ - */␊ - customMessageProperties?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Gets or sets the message.␊ - */␊ - message?: string␊ - /**␊ - * Gets or sets the namespace.␊ - */␊ - namespace?: string␊ - /**␊ - * Gets or sets the queue name.␊ - */␊ - queueName?: string␊ - /**␊ - * Gets or sets the transport type.␊ - */␊ - transportType?: (("NotSpecified" | "NetMessaging" | "AMQP") | string)␊ - [k: string]: unknown␊ - }␊ - export interface ServiceBusAuthentication1 {␊ - /**␊ - * Gets or sets the SAS key.␊ - */␊ - sasKey?: string␊ - /**␊ - * Gets or sets the SAS key name.␊ - */␊ - sasKeyName?: string␊ - /**␊ - * Gets or sets the authentication type.␊ - */␊ - type?: (("NotSpecified" | "SharedAccessKey") | string)␊ - [k: string]: unknown␊ - }␊ - export interface ServiceBusBrokeredMessageProperties1 {␊ - /**␊ - * Gets or sets the content type.␊ - */␊ - contentType?: string␊ - /**␊ - * Gets or sets the correlation ID.␊ - */␊ - correlationId?: string␊ - /**␊ - * Gets or sets the force persistence.␊ - */␊ - forcePersistence?: (boolean | string)␊ - /**␊ - * Gets or sets the label.␊ - */␊ - label?: string␊ - /**␊ - * Gets or sets the message ID.␊ - */␊ - messageId?: string␊ - /**␊ - * Gets or sets the partition key.␊ - */␊ - partitionKey?: string␊ - /**␊ - * Gets or sets the reply to.␊ - */␊ - replyTo?: string␊ - /**␊ - * Gets or sets the reply to session ID.␊ - */␊ - replyToSessionId?: string␊ - /**␊ - * Gets or sets the scheduled enqueue time UTC.␊ - */␊ - scheduledEnqueueTimeUtc?: string␊ - /**␊ - * Gets or sets the session ID.␊ - */␊ - sessionId?: string␊ - /**␊ - * Gets or sets the time to live.␊ - */␊ - timeToLive?: string␊ - /**␊ - * Gets or sets the to.␊ - */␊ - to?: string␊ - /**␊ - * Gets or sets the via partition key.␊ - */␊ - viaPartitionKey?: string␊ - [k: string]: unknown␊ - }␊ - export interface ServiceBusTopicMessage1 {␊ - authentication?: (ServiceBusAuthentication1 | string)␊ - brokeredMessageProperties?: (ServiceBusBrokeredMessageProperties1 | string)␊ - /**␊ - * Gets or sets the custom message properties.␊ - */␊ - customMessageProperties?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Gets or sets the message.␊ - */␊ - message?: string␊ - /**␊ - * Gets or sets the namespace.␊ - */␊ - namespace?: string␊ - /**␊ - * Gets or sets the topic path.␊ - */␊ - topicPath?: string␊ - /**␊ - * Gets or sets the transport type.␊ - */␊ - transportType?: (("NotSpecified" | "NetMessaging" | "AMQP") | string)␊ - [k: string]: unknown␊ - }␊ - export interface JobRecurrence1 {␊ - /**␊ - * Gets or sets the maximum number of times that the job should run.␊ - */␊ - count?: (number | string)␊ - /**␊ - * Gets or sets the time at which the job will complete.␊ - */␊ - endTime?: string␊ - /**␊ - * Gets or sets the frequency of recurrence (second, minute, hour, day, week, month).␊ - */␊ - frequency?: (("Minute" | "Hour" | "Day" | "Week" | "Month") | string)␊ - /**␊ - * Gets or sets the interval between retries.␊ - */␊ - interval?: (number | string)␊ - schedule?: (JobRecurrenceSchedule1 | string)␊ - [k: string]: unknown␊ - }␊ - export interface JobRecurrenceSchedule1 {␊ - /**␊ - * Gets or sets the hours of the day that the job should execute at.␊ - */␊ - hours?: (number[] | string)␊ - /**␊ - * Gets or sets the minutes of the hour that the job should execute at.␊ - */␊ - minutes?: (number[] | string)␊ - /**␊ - * Gets or sets the days of the month that the job should execute on. Must be between 1 and 31.␊ - */␊ - monthDays?: (number[] | string)␊ - /**␊ - * Gets or sets the occurrences of days within a month.␊ - */␊ - monthlyOccurrences?: (JobRecurrenceScheduleMonthlyOccurrence1[] | string)␊ - /**␊ - * Gets or sets the days of the week that the job should execute on.␊ - */␊ - weekDays?: (("Sunday" | "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday")[] | string)␊ - [k: string]: unknown␊ - }␊ - export interface JobRecurrenceScheduleMonthlyOccurrence1 {␊ - /**␊ - * Gets or sets the day. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.␊ - */␊ - day?: (("Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday" | "Sunday") | string)␊ - /**␊ - * Gets or sets the occurrence. Must be between -5 and 5.␊ - */␊ - Occurrence?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Scheduler/jobCollections/jobs␊ - */␊ - export interface JobCollectionsJobs {␊ - apiVersion: "2016-03-01"␊ - /**␊ - * The job name.␊ - */␊ - name: string␊ - properties: (JobProperties1 | string)␊ - type: "Microsoft.Scheduler/jobCollections/jobs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.MachineLearning/webServices␊ - */␊ - export interface WebServices {␊ - apiVersion: "2016-05-01-preview"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the web service.␊ - */␊ - name: string␊ - /**␊ - * The set of properties specific to the Azure ML web service resource.␊ - */␊ - properties: (WebServiceProperties | string)␊ - /**␊ - * Contains resource tags defined as key/value pairs.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.MachineLearning/webServices"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about an asset associated with the web service.␊ - */␊ - export interface AssetItem {␊ - /**␊ - * Asset's Id.␊ - */␊ - id?: string␊ - /**␊ - * Information about the asset's input ports.␊ - */␊ - inputPorts?: ({␊ - [k: string]: InputPort␊ - } | string)␊ - /**␊ - * Describes the access location for a web service asset.␊ - */␊ - locationInfo: (AssetLocation | string)␊ - /**␊ - * If the asset is a custom module, this holds the module's metadata.␊ - */␊ - metadata?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Asset's friendly name.␊ - */␊ - name: string␊ - /**␊ - * Information about the asset's output ports.␊ - */␊ - outputPorts?: ({␊ - [k: string]: OutputPort␊ - } | string)␊ - /**␊ - * If the asset is a custom module, this holds the module's parameters.␊ - */␊ - parameters?: (ModuleAssetParameter[] | string)␊ - /**␊ - * Asset's type.␊ - */␊ - type: (("Module" | "Resource") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Asset input port␊ - */␊ - export interface InputPort {␊ - /**␊ - * Port data type.␊ - */␊ - type?: ("Dataset" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the access location for a web service asset.␊ - */␊ - export interface AssetLocation {␊ - /**␊ - * Access credentials for the asset, if applicable (e.g. asset specified by storage account connection string + blob URI)␊ - */␊ - credentials?: string␊ - /**␊ - * The URI where the asset is accessible from, (e.g. aml://abc for system assets or https://xyz for user assets␊ - */␊ - uri: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Asset output port␊ - */␊ - export interface OutputPort {␊ - /**␊ - * Port data type.␊ - */␊ - type?: ("Dataset" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameter definition for a module asset.␊ - */␊ - export interface ModuleAssetParameter {␊ - /**␊ - * Definitions for nested interface parameters if this is a complex module parameter.␊ - */␊ - modeValuesInfo?: ({␊ - [k: string]: ModeValueInfo␊ - } | string)␊ - /**␊ - * Parameter name.␊ - */␊ - name?: string␊ - /**␊ - * Parameter type.␊ - */␊ - parameterType?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Nested parameter definition.␊ - */␊ - export interface ModeValueInfo {␊ - /**␊ - * The interface string name for the nested parameter.␊ - */␊ - interfaceString?: string␊ - /**␊ - * The definition of the parameter.␊ - */␊ - parameters?: ({␊ - [k: string]: unknown␊ - }[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the machine learning commitment plan associated with the web service.␊ - */␊ - export interface CommitmentPlanModel {␊ - /**␊ - * Specifies the Azure Resource Manager ID of the commitment plan associated with the web service.␊ - */␊ - id: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Diagnostics settings for an Azure ML web service.␊ - */␊ - export interface DiagnosticsConfiguration {␊ - /**␊ - * Specifies the date and time when the logging will cease. If null, diagnostic collection is not time limited.␊ - */␊ - expiry?: string␊ - /**␊ - * Specifies the verbosity of the diagnostic output. Valid values are: None - disables tracing; Error - collects only error (stderr) traces; All - collects all traces (stdout and stderr).␊ - */␊ - level: (("None" | "Error" | "All") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Sample input data for the service's input(s).␊ - */␊ - export interface ExampleRequest {␊ - /**␊ - * Sample input data for the web service's global parameters␊ - */␊ - globalParameters?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Sample input data for the web service's input(s) given as an input name to sample input values matrix map.␊ - */␊ - inputs?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }[][]␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The swagger 2.0 schema describing the service's inputs or outputs. See Swagger specification: http://swagger.io/specification/␊ - */␊ - export interface ServiceInputOutputSpecification {␊ - /**␊ - * The description of the Swagger schema.␊ - */␊ - description?: string␊ - /**␊ - * Specifies a collection that contains the column schema for each input or output of the web service. For more information, see the Swagger specification.␊ - */␊ - properties: ({␊ - [k: string]: TableSpecification␊ - } | string)␊ - /**␊ - * The title of your Swagger schema.␊ - */␊ - title?: string␊ - /**␊ - * The type of the entity described in swagger. Always 'object'.␊ - */␊ - type: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The swagger 2.0 schema describing a single service input or output. See Swagger specification: http://swagger.io/specification/␊ - */␊ - export interface TableSpecification {␊ - /**␊ - * Swagger schema description.␊ - */␊ - description?: string␊ - /**␊ - * The format, if 'type' is not 'object'␊ - */␊ - format?: string␊ - /**␊ - * The set of columns within the data table.␊ - */␊ - properties?: ({␊ - [k: string]: ColumnSpecification␊ - } | string)␊ - /**␊ - * Swagger schema title.␊ - */␊ - title?: string␊ - /**␊ - * The type of the entity described in swagger.␊ - */␊ - type: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Swagger 2.0 schema for a column within the data table representing a web service input or output. See Swagger specification: http://swagger.io/specification/␊ - */␊ - export interface ColumnSpecification {␊ - /**␊ - * If the data type is categorical, this provides the list of accepted categories.␊ - */␊ - enum?: ({␊ - [k: string]: unknown␊ - }[] | string)␊ - /**␊ - * Additional format information for the data type.␊ - */␊ - format?: (("Byte" | "Char" | "Complex64" | "Complex128" | "Date-time" | "Date-timeOffset" | "Double" | "Duration" | "Float" | "Int8" | "Int16" | "Int32" | "Int64" | "Uint8" | "Uint16" | "Uint32" | "Uint64") | string)␊ - /**␊ - * Data type of the column.␊ - */␊ - type: (("Boolean" | "Integer" | "Number" | "String") | string)␊ - /**␊ - * Flag indicating if the type supports null values or not.␊ - */␊ - "x-ms-isnullable"?: (boolean | string)␊ - /**␊ - * Flag indicating whether the categories are treated as an ordered set or not, if this is a categorical column.␊ - */␊ - "x-ms-isordered"?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Access keys for the web service calls.␊ - */␊ - export interface WebServiceKeys {␊ - /**␊ - * The primary access key.␊ - */␊ - primary?: string␊ - /**␊ - * The secondary access key.␊ - */␊ - secondary?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the machine learning workspace containing the experiment that is source for the web service.␊ - */␊ - export interface MachineLearningWorkspace {␊ - /**␊ - * Specifies the workspace ID of the machine learning workspace associated with the web service␊ - */␊ - id: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Holds the available configuration options for an Azure ML web service endpoint.␊ - */␊ - export interface RealtimeConfiguration {␊ - /**␊ - * Specifies the maximum concurrent calls that can be made to the web service. Minimum value: 4, Maximum value: 200.␊ - */␊ - maxConcurrentCalls?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Access information for a storage account.␊ - */␊ - export interface StorageAccount {␊ - /**␊ - * Specifies the key used to access the storage account.␊ - */␊ - key?: string␊ - /**␊ - * Specifies the name of the storage account.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to a Graph based web service.␊ - */␊ - export interface WebServicePropertiesForGraph {␊ - /**␊ - * Defines the graph of modules making up the machine learning solution.␊ - */␊ - package?: (GraphPackage | string)␊ - packageType: "Graph"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines the graph of modules making up the machine learning solution.␊ - */␊ - export interface GraphPackage {␊ - /**␊ - * The list of edges making up the graph.␊ - */␊ - edges?: (GraphEdge[] | string)␊ - /**␊ - * The collection of global parameters for the graph, given as a global parameter name to GraphParameter map. Each parameter here has a 1:1 match with the global parameters values map declared at the WebServiceProperties level.␊ - */␊ - graphParameters?: ({␊ - [k: string]: GraphParameter␊ - } | string)␊ - /**␊ - * The set of nodes making up the graph, provided as a nodeId to GraphNode map␊ - */␊ - nodes?: ({␊ - [k: string]: GraphNode␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines an edge within the web service's graph.␊ - */␊ - export interface GraphEdge {␊ - /**␊ - * The source graph node's identifier.␊ - */␊ - sourceNodeId?: string␊ - /**␊ - * The identifier of the source node's port that the edge connects from.␊ - */␊ - sourcePortId?: string␊ - /**␊ - * The destination graph node's identifier.␊ - */␊ - targetNodeId?: string␊ - /**␊ - * The identifier of the destination node's port that the edge connects into.␊ - */␊ - targetPortId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines a global parameter in the graph.␊ - */␊ - export interface GraphParameter {␊ - /**␊ - * Description of this graph parameter.␊ - */␊ - description?: string␊ - /**␊ - * Association links for this parameter to nodes in the graph.␊ - */␊ - links: (GraphParameterLink[] | string)␊ - /**␊ - * Graph parameter's type.␊ - */␊ - type: (("String" | "Int" | "Float" | "Enumerated" | "Script" | "Mode" | "Credential" | "Boolean" | "Double" | "ColumnPicker" | "ParameterRange" | "DataGatewayName") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Association link for a graph global parameter to a node in the graph.␊ - */␊ - export interface GraphParameterLink {␊ - /**␊ - * The graph node's identifier␊ - */␊ - nodeId: string␊ - /**␊ - * The identifier of the node parameter that the global parameter maps to.␊ - */␊ - parameterKey: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies a node in the web service graph. The node can either be an input, output or asset node, so only one of the corresponding id properties is populated at any given time.␊ - */␊ - export interface GraphNode {␊ - /**␊ - * The id of the asset represented by this node.␊ - */␊ - assetId?: string␊ - /**␊ - * The id of the input element represented by this node.␊ - */␊ - inputId?: string␊ - /**␊ - * The id of the output element represented by this node.␊ - */␊ - outputId?: string␊ - /**␊ - * If applicable, parameters of the node. Global graph parameters map into these, with values set at runtime.␊ - */␊ - parameters?: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.MachineLearning/commitmentPlans␊ - */␊ - export interface CommitmentPlans {␊ - apiVersion: "2016-05-01-preview"␊ - /**␊ - * An entity tag used to enforce optimistic concurrency.␊ - */␊ - etag?: string␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The Azure ML commitment plan name.␊ - */␊ - name: string␊ - /**␊ - * The SKU of a resource.␊ - */␊ - sku?: (ResourceSku3 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.MachineLearning/commitmentPlans"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The SKU of a resource.␊ - */␊ - export interface ResourceSku3 {␊ - /**␊ - * The scale-out capacity of the resource. 1 is 1x, 2 is 2x, etc. This impacts the quantities and cost of any commitment plan resource.␊ - */␊ - capacity?: (number | string)␊ - /**␊ - * The SKU name. Along with tier, uniquely identifies the SKU.␊ - */␊ - name?: string␊ - /**␊ - * The SKU tier. Along with name, uniquely identifies the SKU.␊ - */␊ - tier?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.MachineLearning/workspaces␊ - */␊ - export interface Workspaces {␊ - apiVersion: "2016-04-01"␊ - /**␊ - * The location of the resource. This cannot be changed after the resource is created.␊ - */␊ - location: string␊ - /**␊ - * The name of the machine learning workspace.␊ - */␊ - name: string␊ - /**␊ - * The properties of a machine learning workspace.␊ - */␊ - properties: (WorkspaceProperties | string)␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.MachineLearning/workspaces"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a machine learning workspace.␊ - */␊ - export interface WorkspaceProperties {␊ - /**␊ - * The key vault identifier used for encrypted workspaces.␊ - */␊ - keyVaultIdentifierId?: string␊ - /**␊ - * The email id of the owner for this workspace.␊ - */␊ - ownerEmail: string␊ - /**␊ - * The fully qualified arm id of the storage account associated with this workspace.␊ - */␊ - userStorageAccountId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.MachineLearningServices/workspaces␊ - */␊ - export interface Workspaces1 {␊ - apiVersion: "2018-11-19"␊ - /**␊ - * Identity for the resource.␊ - */␊ - identity?: (Identity15 | string)␊ - /**␊ - * Specifies the location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * Name of Azure Machine Learning workspace.␊ - */␊ - name: string␊ - /**␊ - * The properties of a machine learning workspace.␊ - */␊ - properties: (WorkspaceProperties1 | string)␊ - resources?: WorkspacesComputesChildResource[]␊ - /**␊ - * Contains resource tags defined as key/value pairs.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.MachineLearningServices/workspaces"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the resource.␊ - */␊ - export interface Identity15 {␊ - /**␊ - * The identity type.␊ - */␊ - type?: ("SystemAssigned" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a machine learning workspace.␊ - */␊ - export interface WorkspaceProperties1 {␊ - /**␊ - * ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created␊ - */␊ - applicationInsights?: string␊ - /**␊ - * ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created␊ - */␊ - containerRegistry?: string␊ - /**␊ - * The description of this workspace.␊ - */␊ - description?: string␊ - /**␊ - * Url for the discovery service to identify regional endpoints for machine learning experimentation services␊ - */␊ - discoveryUrl?: string␊ - /**␊ - * The friendly name for this workspace. This name in mutable␊ - */␊ - friendlyName?: string␊ - /**␊ - * ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created␊ - */␊ - keyVault?: string␊ - /**␊ - * ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created␊ - */␊ - storageAccount?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.MachineLearningServices/workspaces/computes␊ - */␊ - export interface WorkspacesComputesChildResource {␊ - apiVersion: "2018-11-19"␊ - /**␊ - * Identity for the resource.␊ - */␊ - identity?: (Identity15 | string)␊ - /**␊ - * Specifies the location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * Name of the Azure Machine Learning compute.␊ - */␊ - name: string␊ - /**␊ - * Machine Learning compute object.␊ - */␊ - properties: (Compute | string)␊ - /**␊ - * Contains resource tags defined as key/value pairs.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "computes"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A Machine Learning compute based on AKS.␊ - */␊ - export interface AKS {␊ - computeType: "AKS"␊ - /**␊ - * AKS properties␊ - */␊ - properties?: (AKSProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AKS properties␊ - */␊ - export interface AKSProperties {␊ - /**␊ - * Number of agents␊ - */␊ - agentCount?: (number | string)␊ - /**␊ - * Agent virtual machine size␊ - */␊ - agentVMSize?: string␊ - /**␊ - * Advance configuration for AKS networking␊ - */␊ - aksNetworkingConfiguration?: (AksNetworkingConfiguration | string)␊ - /**␊ - * Cluster full qualified domain name␊ - */␊ - clusterFqdn?: string␊ - /**␊ - * The ssl configuration for scoring␊ - */␊ - sslConfiguration?: (SslConfiguration | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Advance configuration for AKS networking␊ - */␊ - export interface AksNetworkingConfiguration {␊ - /**␊ - * An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr.␊ - */␊ - dnsServiceIP?: string␊ - /**␊ - * A CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the Kubernetes service address range.␊ - */␊ - dockerBridgeCidr?: string␊ - /**␊ - * A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges.␊ - */␊ - serviceCidr?: string␊ - /**␊ - * Virtual network subnet resource ID the compute nodes belong to␊ - */␊ - subnetId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The ssl configuration for scoring␊ - */␊ - export interface SslConfiguration {␊ - /**␊ - * Cert data␊ - */␊ - cert?: string␊ - /**␊ - * CNAME of the cert␊ - */␊ - cname?: string␊ - /**␊ - * Key data␊ - */␊ - key?: string␊ - /**␊ - * Enable or disable ssl for scoring.␊ - */␊ - status?: (("Disabled" | "Enabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An Azure Machine Learning compute.␊ - */␊ - export interface AmlCompute {␊ - computeType: "AmlCompute"␊ - /**␊ - * AML Compute properties␊ - */␊ - properties?: (AmlComputeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AML Compute properties␊ - */␊ - export interface AmlComputeProperties {␊ - /**␊ - * scale settings for AML Compute␊ - */␊ - scaleSettings?: (ScaleSettings1 | string)␊ - /**␊ - * Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet.␊ - */␊ - subnet?: (ResourceId | string)␊ - /**␊ - * Settings for user account that gets created on each on the nodes of a compute.␊ - */␊ - userAccountCredentials?: (UserAccountCredentials | string)␊ - /**␊ - * Virtual Machine priority.␊ - */␊ - vmPriority?: (("Dedicated" | "LowPriority") | string)␊ - /**␊ - * Virtual Machine Size␊ - */␊ - vmSize?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * scale settings for AML Compute␊ - */␊ - export interface ScaleSettings1 {␊ - /**␊ - * Max number of nodes to use␊ - */␊ - maxNodeCount: (number | string)␊ - /**␊ - * Min number of nodes to use␊ - */␊ - minNodeCount?: ((number & string) | string)␊ - /**␊ - * Node Idle Time before scaling down amlCompute␊ - */␊ - nodeIdleTimeBeforeScaleDown?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet.␊ - */␊ - export interface ResourceId {␊ - /**␊ - * The ID of the resource␊ - */␊ - id: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Settings for user account that gets created on each on the nodes of a compute.␊ - */␊ - export interface UserAccountCredentials {␊ - /**␊ - * Name of the administrator user account which can be used to SSH to nodes.␊ - */␊ - adminUserName: string␊ - /**␊ - * Password of the administrator user account.␊ - */␊ - adminUserPassword?: string␊ - /**␊ - * SSH public key of the administrator user account.␊ - */␊ - adminUserSshPublicKey?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A Machine Learning compute based on Azure Virtual Machines.␊ - */␊ - export interface VirtualMachine {␊ - computeType: "VirtualMachine"␊ - properties?: (VirtualMachineProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - export interface VirtualMachineProperties1 {␊ - /**␊ - * Public IP address of the virtual machine.␊ - */␊ - address?: string␊ - /**␊ - * Admin credentials for virtual machine␊ - */␊ - administratorAccount?: (VirtualMachineSshCredentials | string)␊ - /**␊ - * Port open for ssh connections.␊ - */␊ - sshPort?: (number | string)␊ - /**␊ - * Virtual Machine size␊ - */␊ - virtualMachineSize?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Admin credentials for virtual machine␊ - */␊ - export interface VirtualMachineSshCredentials {␊ - /**␊ - * Password of admin account␊ - */␊ - password?: string␊ - /**␊ - * Private key data␊ - */␊ - privateKeyData?: string␊ - /**␊ - * Public key data␊ - */␊ - publicKeyData?: string␊ - /**␊ - * Username of admin account␊ - */␊ - username?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A HDInsight compute.␊ - */␊ - export interface HDInsight {␊ - computeType: "HDInsight"␊ - properties?: (HDInsightProperties | string)␊ - [k: string]: unknown␊ - }␊ - export interface HDInsightProperties {␊ - /**␊ - * Public IP address of the master node of the cluster.␊ - */␊ - address?: string␊ - /**␊ - * Admin credentials for virtual machine␊ - */␊ - administratorAccount?: (VirtualMachineSshCredentials | string)␊ - /**␊ - * Port open for ssh connections on the master node of the cluster.␊ - */␊ - sshPort?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A DataFactory compute.␊ - */␊ - export interface DataFactory {␊ - computeType: "DataFactory"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A DataFactory compute.␊ - */␊ - export interface Databricks {␊ - computeType: "Databricks"␊ - properties?: (DatabricksProperties | string)␊ - [k: string]: unknown␊ - }␊ - export interface DatabricksProperties {␊ - /**␊ - * Databricks access token␊ - */␊ - databricksAccessToken?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A DataLakeAnalytics compute.␊ - */␊ - export interface DataLakeAnalytics {␊ - computeType: "DataLakeAnalytics"␊ - properties?: (DataLakeAnalyticsProperties | string)␊ - [k: string]: unknown␊ - }␊ - export interface DataLakeAnalyticsProperties {␊ - /**␊ - * DataLake Store Account Name␊ - */␊ - dataLakeStoreAccountName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.MachineLearningServices/workspaces/computes␊ - */␊ - export interface WorkspacesComputes {␊ - apiVersion: "2018-11-19"␊ - /**␊ - * Identity for the resource.␊ - */␊ - identity?: (Identity15 | string)␊ - /**␊ - * Specifies the location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * Name of the Azure Machine Learning compute.␊ - */␊ - name: string␊ - /**␊ - * Machine Learning compute object.␊ - */␊ - properties: ((AKS | AmlCompute | VirtualMachine | HDInsight | DataFactory | Databricks | DataLakeAnalytics) | string)␊ - /**␊ - * Contains resource tags defined as key/value pairs.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.MachineLearningServices/workspaces/computes"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.MachineLearningExperimentation/accounts␊ - */␊ - export interface Accounts7 {␊ - apiVersion: "2017-05-01-preview"␊ - /**␊ - * The location of the resource. This cannot be changed after the resource is created.␊ - */␊ - location: string␊ - /**␊ - * The name of the machine learning team account.␊ - */␊ - name: string␊ - /**␊ - * The properties of a machine learning team account.␊ - */␊ - properties: (AccountProperties | string)␊ - resources?: AccountsWorkspacesChildResource[]␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.MachineLearningExperimentation/accounts"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a machine learning team account.␊ - */␊ - export interface AccountProperties {␊ - /**␊ - * The description of this workspace.␊ - */␊ - description?: string␊ - /**␊ - * The friendly name for this workspace. This will be the workspace name in the arm id when the workspace object gets created␊ - */␊ - friendlyName?: string␊ - /**␊ - * The fully qualified arm id of the user key vault.␊ - */␊ - keyVaultId: string␊ - /**␊ - * The no of users/seats who can access this team account. This property defines the charge on the team account.␊ - */␊ - seats?: string␊ - /**␊ - * The properties of a storage account for a machine learning team account.␊ - */␊ - storageAccount: (StorageAccountProperties1 | string)␊ - /**␊ - * The fully qualified arm id of the vso account to be used for this team account.␊ - */␊ - vsoAccountId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a storage account for a machine learning team account.␊ - */␊ - export interface StorageAccountProperties1 {␊ - /**␊ - * The access key to the storage account.␊ - */␊ - accessKey: string␊ - /**␊ - * The fully qualified arm Id of the storage account.␊ - */␊ - storageAccountId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.MachineLearningExperimentation/accounts/workspaces␊ - */␊ - export interface AccountsWorkspacesChildResource {␊ - apiVersion: "2017-05-01-preview"␊ - /**␊ - * The location of the resource. This cannot be changed after the resource is created.␊ - */␊ - location: string␊ - /**␊ - * The name of the machine learning team account workspace.␊ - */␊ - name: string␊ - /**␊ - * The properties of a machine learning team account workspace.␊ - */␊ - properties: (WorkspaceProperties2 | string)␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "workspaces"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a machine learning team account workspace.␊ - */␊ - export interface WorkspaceProperties2 {␊ - /**␊ - * The description of this workspace.␊ - */␊ - description?: string␊ - /**␊ - * The friendly name for this workspace. This will be the workspace name in the arm id when the workspace object gets created␊ - */␊ - friendlyName: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.MachineLearningExperimentation/accounts/workspaces␊ - */␊ - export interface AccountsWorkspaces {␊ - apiVersion: "2017-05-01-preview"␊ - /**␊ - * The location of the resource. This cannot be changed after the resource is created.␊ - */␊ - location: string␊ - /**␊ - * The name of the machine learning team account workspace.␊ - */␊ - name: string␊ - /**␊ - * The properties of a machine learning team account workspace.␊ - */␊ - properties: (WorkspaceProperties2 | string)␊ - resources?: AccountsWorkspacesProjectsChildResource[]␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.MachineLearningExperimentation/accounts/workspaces"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.MachineLearningExperimentation/accounts/workspaces/projects␊ - */␊ - export interface AccountsWorkspacesProjectsChildResource {␊ - apiVersion: "2017-05-01-preview"␊ - /**␊ - * The location of the resource. This cannot be changed after the resource is created.␊ - */␊ - location: string␊ - /**␊ - * The name of the machine learning project under a team account workspace.␊ - */␊ - name: string␊ - /**␊ - * The properties of a machine learning project.␊ - */␊ - properties: (ProjectProperties | string)␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "projects"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a machine learning project.␊ - */␊ - export interface ProjectProperties {␊ - /**␊ - * The description of this project.␊ - */␊ - description?: string␊ - /**␊ - * The friendly name for this project.␊ - */␊ - friendlyName: string␊ - /**␊ - * The reference to git repo for this project.␊ - */␊ - gitrepo?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.MachineLearningExperimentation/accounts/workspaces/projects␊ - */␊ - export interface AccountsWorkspacesProjects {␊ - apiVersion: "2017-05-01-preview"␊ - /**␊ - * The location of the resource. This cannot be changed after the resource is created.␊ - */␊ - location: string␊ - /**␊ - * The name of the machine learning project under a team account workspace.␊ - */␊ - name: string␊ - /**␊ - * The properties of a machine learning project.␊ - */␊ - properties: (ProjectProperties | string)␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.MachineLearningExperimentation/accounts/workspaces/projects"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.MachineLearningServices/workspaces␊ - */␊ - export interface Workspaces2 {␊ - apiVersion: "2018-03-01-preview"␊ - /**␊ - * Identity for the resource.␊ - */␊ - identity?: (Identity16 | string)␊ - /**␊ - * Specifies the location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * Name of Azure Machine Learning workspace.␊ - */␊ - name: string␊ - /**␊ - * The properties of a machine learning workspace.␊ - */␊ - properties: (WorkspaceProperties3 | string)␊ - resources?: WorkspacesComputesChildResource1[]␊ - /**␊ - * Contains resource tags defined as key/value pairs.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.MachineLearningServices/workspaces"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the resource.␊ - */␊ - export interface Identity16 {␊ - /**␊ - * The identity type.␊ - */␊ - type?: ("SystemAssigned" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a machine learning workspace.␊ - */␊ - export interface WorkspaceProperties3 {␊ - /**␊ - * ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created␊ - */␊ - applicationInsights?: string␊ - /**␊ - * ARM id of the Batch AI workspace associated with this workspace. This cannot be changed once the workspace has been created␊ - */␊ - batchaiWorkspace?: string␊ - /**␊ - * ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created␊ - */␊ - containerRegistry?: string␊ - /**␊ - * The description of this workspace.␊ - */␊ - description?: string␊ - /**␊ - * Url for the discovery service to identify regional endpoints for machine learning experimentation services␊ - */␊ - discoveryUrl?: string␊ - /**␊ - * The friendly name for this workspace. This name in mutable␊ - */␊ - friendlyName?: string␊ - /**␊ - * ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created␊ - */␊ - keyVault?: string␊ - /**␊ - * ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created␊ - */␊ - storageAccount?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.MachineLearningServices/workspaces/computes␊ - */␊ - export interface WorkspacesComputesChildResource1 {␊ - apiVersion: "2018-03-01-preview"␊ - /**␊ - * Identity for the resource.␊ - */␊ - identity?: (Identity16 | string)␊ - /**␊ - * Specifies the location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * Name of the Azure Machine Learning compute.␊ - */␊ - name: string␊ - /**␊ - * Machine Learning compute object.␊ - */␊ - properties: (Compute1 | string)␊ - /**␊ - * Contains resource tags defined as key/value pairs.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "computes"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A Machine Learning compute based on AKS.␊ - */␊ - export interface AKS1 {␊ - computeType: "AKS"␊ - /**␊ - * AKS properties␊ - */␊ - properties?: (AKSProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AKS properties␊ - */␊ - export interface AKSProperties1 {␊ - /**␊ - * Number of agents␊ - */␊ - agentCount?: (number | string)␊ - /**␊ - * Agent virtual machine size␊ - */␊ - agentVMSize?: string␊ - /**␊ - * Cluster full qualified domain name␊ - */␊ - clusterFqdn?: string␊ - /**␊ - * The SSL configuration for scoring␊ - */␊ - sslConfiguration?: (SslConfiguration1 | string)␊ - /**␊ - * System services␊ - */␊ - systemServices?: (SystemService[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The SSL configuration for scoring␊ - */␊ - export interface SslConfiguration1 {␊ - /**␊ - * Cert data␊ - */␊ - cert?: string␊ - /**␊ - * CNAME of the cert␊ - */␊ - cname?: string␊ - /**␊ - * Key data␊ - */␊ - key?: string␊ - /**␊ - * Enable or disable SSL for scoring.␊ - */␊ - status?: (("Disabled" | "Enabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A system service running on a compute.␊ - */␊ - export interface SystemService {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A Machine Learning compute based on Azure BatchAI.␊ - */␊ - export interface BatchAI {␊ - computeType: "BatchAI"␊ - /**␊ - * BatchAI properties␊ - */␊ - properties?: (BatchAIProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * BatchAI properties␊ - */␊ - export interface BatchAIProperties {␊ - /**␊ - * scale settings for BatchAI Compute␊ - */␊ - scaleSettings?: (ScaleSettings2 | string)␊ - /**␊ - * Virtual Machine priority␊ - */␊ - vmPriority?: string␊ - /**␊ - * Virtual Machine Size␊ - */␊ - vmSize?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * scale settings for BatchAI Compute␊ - */␊ - export interface ScaleSettings2 {␊ - /**␊ - * Enable or disable auto scale␊ - */␊ - autoScaleEnabled?: (boolean | string)␊ - /**␊ - * Max number of nodes to use␊ - */␊ - maxNodeCount?: (number | string)␊ - /**␊ - * Min number of nodes to use␊ - */␊ - minNodeCount?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A Machine Learning compute based on Azure Virtual Machines.␊ - */␊ - export interface VirtualMachine1 {␊ - computeType: "VirtualMachine"␊ - properties?: (VirtualMachineProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - export interface VirtualMachineProperties2 {␊ - /**␊ - * Public IP address of the virtual machine.␊ - */␊ - address?: string␊ - /**␊ - * Admin credentials for virtual machine␊ - */␊ - administratorAccount?: (VirtualMachineSshCredentials1 | string)␊ - /**␊ - * Port open for ssh connections.␊ - */␊ - sshPort?: (number | string)␊ - /**␊ - * Virtual Machine size␊ - */␊ - virtualMachineSize?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Admin credentials for virtual machine␊ - */␊ - export interface VirtualMachineSshCredentials1 {␊ - /**␊ - * Password of admin account␊ - */␊ - password?: string␊ - /**␊ - * Private key data␊ - */␊ - privateKeyData?: string␊ - /**␊ - * Public key data␊ - */␊ - publicKeyData?: string␊ - /**␊ - * Username of admin account␊ - */␊ - username?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A HDInsight compute.␊ - */␊ - export interface HDInsight1 {␊ - computeType: "HDInsight"␊ - properties?: (HDInsightProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - export interface HDInsightProperties1 {␊ - /**␊ - * Public IP address of the master node of the cluster.␊ - */␊ - address?: string␊ - /**␊ - * Admin credentials for virtual machine␊ - */␊ - administratorAccount?: (VirtualMachineSshCredentials1 | string)␊ - /**␊ - * Port open for ssh connections on the master node of the cluster.␊ - */␊ - sshPort?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A DataFactory compute.␊ - */␊ - export interface DataFactory1 {␊ - computeType: "DataFactory"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Automation/automationAccounts␊ - */␊ - export interface AutomationAccounts {␊ - apiVersion: "2015-10-31"␊ - /**␊ - * Gets or sets the location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * The name of the automation account.␊ - */␊ - name: string␊ - /**␊ - * The parameters supplied to the create or update account properties.␊ - */␊ - properties: (AutomationAccountCreateOrUpdateProperties | string)␊ - resources?: (AutomationAccountsCertificatesChildResource | AutomationAccountsConnectionsChildResource | AutomationAccountsConnectionTypesChildResource | AutomationAccountsCredentialsChildResource | AutomationAccountsCompilationjobsChildResource | AutomationAccountsConfigurationsChildResource | AutomationAccountsNodeConfigurationsChildResource | AutomationAccountsJobsChildResource | AutomationAccountsJobSchedulesChildResource | AutomationAccountsModulesChildResource | AutomationAccountsRunbooksChildResource | AutomationAccountsSchedulesChildResource | AutomationAccountsVariablesChildResource | AutomationAccountsWatchersChildResource | AutomationAccountsWebhooksChildResource)[]␊ - /**␊ - * Gets or sets the tags attached to the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Automation/automationAccounts"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The parameters supplied to the create or update account properties.␊ - */␊ - export interface AutomationAccountCreateOrUpdateProperties {␊ - /**␊ - * The account SKU.␊ - */␊ - sku?: (Sku32 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The account SKU.␊ - */␊ - export interface Sku32 {␊ - /**␊ - * Gets or sets the SKU capacity.␊ - */␊ - capacity?: (number | string)␊ - /**␊ - * Gets or sets the SKU family.␊ - */␊ - family?: string␊ - /**␊ - * Gets or sets the SKU name of the account.␊ - */␊ - name: (("Free" | "Basic") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Automation/automationAccounts/certificates␊ - */␊ - export interface AutomationAccountsCertificatesChildResource {␊ - apiVersion: "2015-10-31"␊ - /**␊ - * The parameters supplied to the create or update certificate operation.␊ - */␊ - name: string␊ - /**␊ - * The properties of the create certificate operation.␊ - */␊ - properties: (CertificateCreateOrUpdateProperties1 | string)␊ - type: "certificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the create certificate operation.␊ - */␊ - export interface CertificateCreateOrUpdateProperties1 {␊ - /**␊ - * Gets or sets the base64 encoded value of the certificate.␊ - */␊ - base64Value: string␊ - /**␊ - * Gets or sets the description of the certificate.␊ - */␊ - description?: string␊ - /**␊ - * Gets or sets the is exportable flag of the certificate.␊ - */␊ - isExportable?: (boolean | string)␊ - /**␊ - * Gets or sets the thumbprint of the certificate.␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Automation/automationAccounts/connections␊ - */␊ - export interface AutomationAccountsConnectionsChildResource {␊ - apiVersion: "2015-10-31"␊ - /**␊ - * The parameters supplied to the create or update connection operation.␊ - */␊ - name: string␊ - /**␊ - * The properties of the create connection properties␊ - */␊ - properties: (ConnectionCreateOrUpdateProperties | string)␊ - type: "connections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the create connection properties␊ - */␊ - export interface ConnectionCreateOrUpdateProperties {␊ - /**␊ - * The connection type property associated with the entity.␊ - */␊ - connectionType: (ConnectionTypeAssociationProperty | string)␊ - /**␊ - * Gets or sets the description of the connection.␊ - */␊ - description?: string␊ - /**␊ - * Gets or sets the field definition properties of the connection.␊ - */␊ - fieldDefinitionValues?: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The connection type property associated with the entity.␊ - */␊ - export interface ConnectionTypeAssociationProperty {␊ - /**␊ - * Gets or sets the name of the connection type.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Automation/automationAccounts/connectionTypes␊ - */␊ - export interface AutomationAccountsConnectionTypesChildResource {␊ - apiVersion: "2015-10-31"␊ - /**␊ - * The parameters supplied to the create or update connection type operation.␊ - */␊ - name: string␊ - /**␊ - * The properties of the create connection type.␊ - */␊ - properties: (ConnectionTypeCreateOrUpdateProperties | string)␊ - type: "connectionTypes"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the create connection type.␊ - */␊ - export interface ConnectionTypeCreateOrUpdateProperties {␊ - /**␊ - * Gets or sets the field definitions of the connection type.␊ - */␊ - fieldDefinitions: ({␊ - [k: string]: FieldDefinition␊ - } | string)␊ - /**␊ - * Gets or sets a Boolean value to indicate if the connection type is global.␊ - */␊ - isGlobal?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Definition of the connection fields.␊ - */␊ - export interface FieldDefinition {␊ - /**␊ - * Gets or sets the isEncrypted flag of the connection field definition.␊ - */␊ - isEncrypted?: (boolean | string)␊ - /**␊ - * Gets or sets the isOptional flag of the connection field definition.␊ - */␊ - isOptional?: (boolean | string)␊ - /**␊ - * Gets or sets the type of the connection field definition.␊ - */␊ - type: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Automation/automationAccounts/credentials␊ - */␊ - export interface AutomationAccountsCredentialsChildResource {␊ - apiVersion: "2015-10-31"␊ - /**␊ - * The parameters supplied to the create or update credential operation.␊ - */␊ - name: string␊ - /**␊ - * The properties of the create credential operation.␊ - */␊ - properties: (CredentialCreateOrUpdateProperties | string)␊ - type: "credentials"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the create credential operation.␊ - */␊ - export interface CredentialCreateOrUpdateProperties {␊ - /**␊ - * Gets or sets the description of the credential.␊ - */␊ - description?: string␊ - /**␊ - * Gets or sets the password of the credential.␊ - */␊ - password: string␊ - /**␊ - * Gets or sets the user name of the credential.␊ - */␊ - userName: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Automation/automationAccounts/compilationjobs␊ - */␊ - export interface AutomationAccountsCompilationjobsChildResource {␊ - apiVersion: "2015-10-31"␊ - /**␊ - * Gets or sets the location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * The DSC configuration Id.␊ - */␊ - name: string␊ - /**␊ - * The parameters supplied to the create compilation job operation.␊ - */␊ - properties: (DscCompilationJobCreateProperties | string)␊ - /**␊ - * Gets or sets the tags attached to the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "compilationjobs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The parameters supplied to the create compilation job operation.␊ - */␊ - export interface DscCompilationJobCreateProperties {␊ - /**␊ - * The Dsc configuration property associated with the entity.␊ - */␊ - configuration: (DscConfigurationAssociationProperty | string)␊ - /**␊ - * If a new build version of NodeConfiguration is required.␊ - */␊ - incrementNodeConfigurationBuild?: (boolean | string)␊ - /**␊ - * Gets or sets the parameters of the job.␊ - */␊ - parameters?: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Dsc configuration property associated with the entity.␊ - */␊ - export interface DscConfigurationAssociationProperty {␊ - /**␊ - * Gets or sets the name of the Dsc configuration.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Automation/automationAccounts/configurations␊ - */␊ - export interface AutomationAccountsConfigurationsChildResource {␊ - apiVersion: "2015-10-31"␊ - /**␊ - * Gets or sets the location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * The create or update parameters for configuration.␊ - */␊ - name: string␊ - /**␊ - * The properties to create or update configuration.␊ - */␊ - properties: (DscConfigurationCreateOrUpdateProperties | string)␊ - /**␊ - * Gets or sets the tags attached to the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "configurations"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties to create or update configuration.␊ - */␊ - export interface DscConfigurationCreateOrUpdateProperties {␊ - /**␊ - * Gets or sets the description of the configuration.␊ - */␊ - description?: string␊ - /**␊ - * Gets or sets progress log option.␊ - */␊ - logProgress?: (boolean | string)␊ - /**␊ - * Gets or sets verbose log option.␊ - */␊ - logVerbose?: (boolean | string)␊ - /**␊ - * Gets or sets the configuration parameters.␊ - */␊ - parameters?: ({␊ - [k: string]: DscConfigurationParameter␊ - } | string)␊ - /**␊ - * Definition of the content source.␊ - */␊ - source: (ContentSource | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Definition of the configuration parameter type.␊ - */␊ - export interface DscConfigurationParameter {␊ - /**␊ - * Gets or sets the default value of parameter.␊ - */␊ - defaultValue?: string␊ - /**␊ - * Gets or sets a Boolean value to indicate whether the parameter is mandatory or not.␊ - */␊ - isMandatory?: (boolean | string)␊ - /**␊ - * Get or sets the position of the parameter.␊ - */␊ - position?: (number | string)␊ - /**␊ - * Gets or sets the type of the parameter.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Definition of the content source.␊ - */␊ - export interface ContentSource {␊ - /**␊ - * Definition of the runbook property type.␊ - */␊ - hash?: (ContentHash | string)␊ - /**␊ - * Gets or sets the content source type.␊ - */␊ - type?: (("embeddedContent" | "uri") | string)␊ - /**␊ - * Gets or sets the value of the content. This is based on the content source type.␊ - */␊ - value?: string␊ - /**␊ - * Gets or sets the version of the content.␊ - */␊ - version?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Definition of the runbook property type.␊ - */␊ - export interface ContentHash {␊ - /**␊ - * Gets or sets the content hash algorithm used to hash the content.␊ - */␊ - algorithm: string␊ - /**␊ - * Gets or sets expected hash value of the content.␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Automation/automationAccounts/nodeConfigurations␊ - */␊ - export interface AutomationAccountsNodeConfigurationsChildResource {␊ - apiVersion: "2015-10-31"␊ - /**␊ - * The Dsc configuration property associated with the entity.␊ - */␊ - configuration: (DscConfigurationAssociationProperty | string)␊ - /**␊ - * If a new build version of NodeConfiguration is required.␊ - */␊ - incrementNodeConfigurationBuild?: (boolean | string)␊ - /**␊ - * The create or update parameters for configuration.␊ - */␊ - name: string␊ - /**␊ - * Definition of the content source.␊ - */␊ - source: (ContentSource | string)␊ - type: "nodeConfigurations"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Automation/automationAccounts/jobs␊ - */␊ - export interface AutomationAccountsJobsChildResource {␊ - apiVersion: "2015-10-31"␊ - /**␊ - * The job id.␊ - */␊ - name: string␊ - /**␊ - * The parameters supplied to the create job operation.␊ - */␊ - properties: (JobCreateProperties | string)␊ - type: "jobs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The parameters supplied to the create job operation.␊ - */␊ - export interface JobCreateProperties {␊ - /**␊ - * Gets or sets the parameters of the job.␊ - */␊ - parameters?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The runbook property associated with the entity.␊ - */␊ - runbook: (RunbookAssociationProperty | string)␊ - /**␊ - * Gets or sets the runOn which specifies the group name where the job is to be executed.␊ - */␊ - runOn?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The runbook property associated with the entity.␊ - */␊ - export interface RunbookAssociationProperty {␊ - /**␊ - * Gets or sets the name of the runbook.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Automation/automationAccounts/jobSchedules␊ - */␊ - export interface AutomationAccountsJobSchedulesChildResource {␊ - apiVersion: "2015-10-31"␊ - /**␊ - * The job schedule name.␊ - */␊ - name: string␊ - /**␊ - * The parameters supplied to the create job schedule operation.␊ - */␊ - properties: (JobScheduleCreateProperties | string)␊ - type: "jobSchedules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The parameters supplied to the create job schedule operation.␊ - */␊ - export interface JobScheduleCreateProperties {␊ - /**␊ - * Gets or sets a list of job properties.␊ - */␊ - parameters?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The runbook property associated with the entity.␊ - */␊ - runbook: (RunbookAssociationProperty | string)␊ - /**␊ - * Gets or sets the hybrid worker group that the scheduled job should run on.␊ - */␊ - runOn?: string␊ - /**␊ - * The schedule property associated with the entity.␊ - */␊ - schedule: (ScheduleAssociationProperty | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The schedule property associated with the entity.␊ - */␊ - export interface ScheduleAssociationProperty {␊ - /**␊ - * Gets or sets the name of the Schedule.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Automation/automationAccounts/modules␊ - */␊ - export interface AutomationAccountsModulesChildResource {␊ - apiVersion: "2015-10-31"␊ - /**␊ - * Gets or sets the location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * The name of module.␊ - */␊ - name: string␊ - /**␊ - * The parameters supplied to the create or update module properties.␊ - */␊ - properties: (ModuleCreateOrUpdateProperties | string)␊ - /**␊ - * Gets or sets the tags attached to the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "modules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The parameters supplied to the create or update module properties.␊ - */␊ - export interface ModuleCreateOrUpdateProperties {␊ - /**␊ - * Definition of the content link.␊ - */␊ - contentLink: (ContentLink | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Definition of the content link.␊ - */␊ - export interface ContentLink {␊ - /**␊ - * Definition of the runbook property type.␊ - */␊ - contentHash?: (ContentHash | string)␊ - /**␊ - * Gets or sets the uri of the runbook content.␊ - */␊ - uri?: string␊ - /**␊ - * Gets or sets the version of the content.␊ - */␊ - version?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Automation/automationAccounts/runbooks␊ - */␊ - export interface AutomationAccountsRunbooksChildResource {␊ - apiVersion: "2015-10-31"␊ - /**␊ - * Gets or sets the location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * The runbook name.␊ - */␊ - name: string␊ - /**␊ - * The parameters supplied to the create or update runbook properties.␊ - */␊ - properties: (RunbookCreateOrUpdateProperties | string)␊ - /**␊ - * Gets or sets the tags attached to the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "runbooks"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The parameters supplied to the create or update runbook properties.␊ - */␊ - export interface RunbookCreateOrUpdateProperties {␊ - /**␊ - * Gets or sets the description of the runbook.␊ - */␊ - description?: string␊ - draft?: (RunbookDraft | string)␊ - /**␊ - * Gets or sets the activity-level tracing options of the runbook.␊ - */␊ - logActivityTrace?: (number | string)␊ - /**␊ - * Gets or sets progress log option.␊ - */␊ - logProgress?: (boolean | string)␊ - /**␊ - * Gets or sets verbose log option.␊ - */␊ - logVerbose?: (boolean | string)␊ - /**␊ - * Definition of the content link.␊ - */␊ - publishContentLink?: (ContentLink | string)␊ - /**␊ - * Gets or sets the type of the runbook.␊ - */␊ - runbookType: (("Script" | "Graph" | "PowerShellWorkflow" | "PowerShell" | "GraphPowerShellWorkflow" | "GraphPowerShell" | "Python2" | "Python3") | string)␊ - [k: string]: unknown␊ - }␊ - export interface RunbookDraft {␊ - /**␊ - * Gets or sets the creation time of the runbook draft.␊ - */␊ - creationTime?: string␊ - /**␊ - * Definition of the content link.␊ - */␊ - draftContentLink?: (ContentLink | string)␊ - /**␊ - * Gets or sets whether runbook is in edit mode.␊ - */␊ - inEdit?: (boolean | string)␊ - /**␊ - * Gets or sets the last modified time of the runbook draft.␊ - */␊ - lastModifiedTime?: string␊ - /**␊ - * Gets or sets the runbook output types.␊ - */␊ - outputTypes?: (string[] | string)␊ - /**␊ - * Gets or sets the runbook draft parameters.␊ - */␊ - parameters?: ({␊ - [k: string]: RunbookParameter␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Definition of the runbook parameter type.␊ - */␊ - export interface RunbookParameter {␊ - /**␊ - * Gets or sets the default value of parameter.␊ - */␊ - defaultValue?: string␊ - /**␊ - * Gets or sets a Boolean value to indicate whether the parameter is mandatory or not.␊ - */␊ - isMandatory?: (boolean | string)␊ - /**␊ - * Get or sets the position of the parameter.␊ - */␊ - position?: (number | string)␊ - /**␊ - * Gets or sets the type of the parameter.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Automation/automationAccounts/schedules␊ - */␊ - export interface AutomationAccountsSchedulesChildResource {␊ - apiVersion: "2015-10-31"␊ - /**␊ - * The schedule name.␊ - */␊ - name: string␊ - /**␊ - * The parameters supplied to the create or update schedule operation.␊ - */␊ - properties: (ScheduleCreateOrUpdateProperties | string)␊ - type: "schedules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The parameters supplied to the create or update schedule operation.␊ - */␊ - export interface ScheduleCreateOrUpdateProperties {␊ - /**␊ - * The properties of the create Advanced Schedule.␊ - */␊ - advancedSchedule?: (AdvancedSchedule | string)␊ - /**␊ - * Gets or sets the description of the schedule.␊ - */␊ - description?: string␊ - /**␊ - * Gets or sets the end time of the schedule.␊ - */␊ - expiryTime?: string␊ - /**␊ - * Gets or sets the frequency of the schedule.␊ - */␊ - frequency: (("OneTime" | "Day" | "Hour" | "Week" | "Month" | "Minute") | string)␊ - /**␊ - * Gets or sets the interval of the schedule.␊ - */␊ - interval?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Gets or sets the start time of the schedule.␊ - */␊ - startTime: string␊ - /**␊ - * Gets or sets the time zone of the schedule.␊ - */␊ - timeZone?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the create Advanced Schedule.␊ - */␊ - export interface AdvancedSchedule {␊ - /**␊ - * Days of the month that the job should execute on. Must be between 1 and 31.␊ - */␊ - monthDays?: (number[] | string)␊ - /**␊ - * Occurrences of days within a month.␊ - */␊ - monthlyOccurrences?: (AdvancedScheduleMonthlyOccurrence[] | string)␊ - /**␊ - * Days of the week that the job should execute on.␊ - */␊ - weekDays?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the create advanced schedule monthly occurrence.␊ - */␊ - export interface AdvancedScheduleMonthlyOccurrence {␊ - /**␊ - * Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.␊ - */␊ - day?: (("Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday" | "Sunday") | string)␊ - /**␊ - * Occurrence of the week within the month. Must be between 1 and 5␊ - */␊ - occurrence?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Automation/automationAccounts/variables␊ - */␊ - export interface AutomationAccountsVariablesChildResource {␊ - apiVersion: "2015-10-31"␊ - /**␊ - * The variable name.␊ - */␊ - name: string␊ - /**␊ - * The properties of the create variable operation.␊ - */␊ - properties: (VariableCreateOrUpdateProperties | string)␊ - type: "variables"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the create variable operation.␊ - */␊ - export interface VariableCreateOrUpdateProperties {␊ - /**␊ - * Gets or sets the description of the variable.␊ - */␊ - description?: string␊ - /**␊ - * Gets or sets the encrypted flag of the variable.␊ - */␊ - isEncrypted?: (boolean | string)␊ - /**␊ - * Gets or sets the value of the variable.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Automation/automationAccounts/watchers␊ - */␊ - export interface AutomationAccountsWatchersChildResource {␊ - apiVersion: "2015-10-31"␊ - /**␊ - * Gets or sets the etag of the resource.␊ - */␊ - etag?: string␊ - /**␊ - * The Azure Region where the resource lives␊ - */␊ - location?: string␊ - /**␊ - * The watcher name.␊ - */␊ - name: string␊ - /**␊ - * Definition of the watcher properties␊ - */␊ - properties: (WatcherProperties | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "watchers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Definition of the watcher properties␊ - */␊ - export interface WatcherProperties {␊ - /**␊ - * Gets or sets the description.␊ - */␊ - description?: string␊ - /**␊ - * Gets or sets the frequency at which the watcher is invoked.␊ - */␊ - executionFrequencyInSeconds?: (number | string)␊ - /**␊ - * Gets or sets the name of the script the watcher is attached to, i.e. the name of an existing runbook.␊ - */␊ - scriptName?: string␊ - /**␊ - * Gets or sets the parameters of the script.␊ - */␊ - scriptParameters?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Gets or sets the name of the hybrid worker group the watcher will run on.␊ - */␊ - scriptRunOn?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Automation/automationAccounts/webhooks␊ - */␊ - export interface AutomationAccountsWebhooksChildResource {␊ - apiVersion: "2015-10-31"␊ - /**␊ - * The webhook name.␊ - */␊ - name: string␊ - /**␊ - * The properties of the create webhook operation.␊ - */␊ - properties: (WebhookCreateOrUpdateProperties | string)␊ - type: "webhooks"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the create webhook operation.␊ - */␊ - export interface WebhookCreateOrUpdateProperties {␊ - /**␊ - * Gets or sets the expiry time.␊ - */␊ - expiryTime?: string␊ - /**␊ - * Gets or sets the value of the enabled flag of webhook.␊ - */␊ - isEnabled?: (boolean | string)␊ - /**␊ - * Gets or sets the parameters of the job.␊ - */␊ - parameters?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The runbook property associated with the entity.␊ - */␊ - runbook?: (RunbookAssociationProperty | string)␊ - /**␊ - * Gets or sets the name of the hybrid worker group the webhook job will run on.␊ - */␊ - runOn?: string␊ - /**␊ - * Gets or sets the uri.␊ - */␊ - uri?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Automation/automationAccounts/runbooks␊ - */␊ - export interface AutomationAccountsRunbooks {␊ - apiVersion: "2015-10-31"␊ - /**␊ - * Gets or sets the location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * The runbook name.␊ - */␊ - name: string␊ - /**␊ - * The parameters supplied to the create or update runbook properties.␊ - */␊ - properties: (RunbookCreateOrUpdateProperties | string)␊ - resources?: AutomationAccountsRunbooksDraftChildResource[]␊ - /**␊ - * Gets or sets the tags attached to the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Automation/automationAccounts/runbooks"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Automation/automationAccounts/modules␊ - */␊ - export interface AutomationAccountsModules {␊ - apiVersion: "2015-10-31"␊ - /**␊ - * Gets or sets the location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * The name of module.␊ - */␊ - name: string␊ - /**␊ - * The parameters supplied to the create or update module properties.␊ - */␊ - properties: (ModuleCreateOrUpdateProperties | string)␊ - /**␊ - * Gets or sets the tags attached to the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Automation/automationAccounts/modules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Automation/automationAccounts/certificates␊ - */␊ - export interface AutomationAccountsCertificates {␊ - apiVersion: "2015-10-31"␊ - /**␊ - * The parameters supplied to the create or update certificate operation.␊ - */␊ - name: string␊ - /**␊ - * The properties of the create certificate operation.␊ - */␊ - properties: (CertificateCreateOrUpdateProperties1 | string)␊ - type: "Microsoft.Automation/automationAccounts/certificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Automation/automationAccounts/connections␊ - */␊ - export interface AutomationAccountsConnections {␊ - apiVersion: "2015-10-31"␊ - /**␊ - * The parameters supplied to the create or update connection operation.␊ - */␊ - name: string␊ - /**␊ - * The properties of the create connection properties␊ - */␊ - properties: (ConnectionCreateOrUpdateProperties | string)␊ - type: "Microsoft.Automation/automationAccounts/connections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Automation/automationAccounts/variables␊ - */␊ - export interface AutomationAccountsVariables {␊ - apiVersion: "2015-10-31"␊ - /**␊ - * The variable name.␊ - */␊ - name: string␊ - /**␊ - * The properties of the create variable operation.␊ - */␊ - properties: (VariableCreateOrUpdateProperties | string)␊ - type: "Microsoft.Automation/automationAccounts/variables"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Automation/automationAccounts/schedules␊ - */␊ - export interface AutomationAccountsSchedules {␊ - apiVersion: "2015-10-31"␊ - /**␊ - * The schedule name.␊ - */␊ - name: string␊ - /**␊ - * The parameters supplied to the create or update schedule operation.␊ - */␊ - properties: (ScheduleCreateOrUpdateProperties | string)␊ - type: "Microsoft.Automation/automationAccounts/schedules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Automation/automationAccounts/jobs␊ - */␊ - export interface AutomationAccountsJobs {␊ - apiVersion: "2015-10-31"␊ - /**␊ - * The job id.␊ - */␊ - name: string␊ - /**␊ - * The parameters supplied to the create job operation.␊ - */␊ - properties: (JobCreateProperties | string)␊ - type: "Microsoft.Automation/automationAccounts/jobs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Automation/automationAccounts/connectionTypes␊ - */␊ - export interface AutomationAccountsConnectionTypes {␊ - apiVersion: "2015-10-31"␊ - /**␊ - * The parameters supplied to the create or update connection type operation.␊ - */␊ - name: string␊ - /**␊ - * The properties of the create connection type.␊ - */␊ - properties: (ConnectionTypeCreateOrUpdateProperties | string)␊ - type: "Microsoft.Automation/automationAccounts/connectionTypes"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Automation/automationAccounts/compilationjobs␊ - */␊ - export interface AutomationAccountsCompilationjobs {␊ - apiVersion: "2015-10-31"␊ - /**␊ - * Gets or sets the location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * The DSC configuration Id.␊ - */␊ - name: string␊ - /**␊ - * The parameters supplied to the create compilation job operation.␊ - */␊ - properties: (DscCompilationJobCreateProperties | string)␊ - /**␊ - * Gets or sets the tags attached to the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Automation/automationAccounts/compilationjobs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Automation/automationAccounts/configurations␊ - */␊ - export interface AutomationAccountsConfigurations {␊ - apiVersion: "2015-10-31"␊ - /**␊ - * Gets or sets the location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * The create or update parameters for configuration.␊ - */␊ - name: string␊ - /**␊ - * The properties to create or update configuration.␊ - */␊ - properties: (DscConfigurationCreateOrUpdateProperties | string)␊ - /**␊ - * Gets or sets the tags attached to the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Automation/automationAccounts/configurations"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Automation/automationAccounts/jobSchedules␊ - */␊ - export interface AutomationAccountsJobSchedules {␊ - apiVersion: "2015-10-31"␊ - /**␊ - * The job schedule name.␊ - */␊ - name: string␊ - /**␊ - * The parameters supplied to the create job schedule operation.␊ - */␊ - properties: (JobScheduleCreateProperties | string)␊ - type: "Microsoft.Automation/automationAccounts/jobSchedules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Automation/automationAccounts/nodeConfigurations␊ - */␊ - export interface AutomationAccountsNodeConfigurations {␊ - apiVersion: "2015-10-31"␊ - /**␊ - * The Dsc configuration property associated with the entity.␊ - */␊ - configuration: (DscConfigurationAssociationProperty | string)␊ - /**␊ - * If a new build version of NodeConfiguration is required.␊ - */␊ - incrementNodeConfigurationBuild?: (boolean | string)␊ - /**␊ - * The create or update parameters for configuration.␊ - */␊ - name: string␊ - /**␊ - * Definition of the content source.␊ - */␊ - source: (ContentSource | string)␊ - type: "Microsoft.Automation/automationAccounts/nodeConfigurations"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Automation/automationAccounts/webhooks␊ - */␊ - export interface AutomationAccountsWebhooks {␊ - apiVersion: "2015-10-31"␊ - /**␊ - * The webhook name.␊ - */␊ - name: string␊ - /**␊ - * The properties of the create webhook operation.␊ - */␊ - properties: (WebhookCreateOrUpdateProperties | string)␊ - type: "Microsoft.Automation/automationAccounts/webhooks"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Automation/automationAccounts/credentials␊ - */␊ - export interface AutomationAccountsCredentials {␊ - apiVersion: "2015-10-31"␊ - /**␊ - * The parameters supplied to the create or update credential operation.␊ - */␊ - name: string␊ - /**␊ - * The properties of the create credential operation.␊ - */␊ - properties: (CredentialCreateOrUpdateProperties | string)␊ - type: "Microsoft.Automation/automationAccounts/credentials"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Automation/automationAccounts/watchers␊ - */␊ - export interface AutomationAccountsWatchers {␊ - apiVersion: "2015-10-31"␊ - /**␊ - * Gets or sets the etag of the resource.␊ - */␊ - etag?: string␊ - /**␊ - * The Azure Region where the resource lives␊ - */␊ - location?: string␊ - /**␊ - * The watcher name.␊ - */␊ - name: string␊ - /**␊ - * Definition of the watcher properties␊ - */␊ - properties: (WatcherProperties | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Automation/automationAccounts/watchers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Automation/automationAccounts/softwareUpdateConfigurations␊ - */␊ - export interface AutomationAccountsSoftwareUpdateConfigurations {␊ - apiVersion: "2017-05-15-preview"␊ - /**␊ - * The name of the software update configuration to be created.␊ - */␊ - name: string␊ - /**␊ - * Software update configuration properties.␊ - */␊ - properties: (SoftwareUpdateConfigurationProperties | string)␊ - type: "Microsoft.Automation/automationAccounts/softwareUpdateConfigurations"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Software update configuration properties.␊ - */␊ - export interface SoftwareUpdateConfigurationProperties {␊ - /**␊ - * Error response of an operation failure␊ - */␊ - error?: (ErrorResponse | string)␊ - /**␊ - * Definition of schedule parameters.␊ - */␊ - scheduleInfo: (ScheduleProperties2 | string)␊ - /**␊ - * Task properties of the software update configuration.␊ - */␊ - tasks?: (SoftwareUpdateConfigurationTasks | string)␊ - /**␊ - * Update specific properties of the software update configuration.␊ - */␊ - updateConfiguration: (UpdateConfiguration | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Error response of an operation failure␊ - */␊ - export interface ErrorResponse {␊ - /**␊ - * Error code␊ - */␊ - code?: string␊ - /**␊ - * Error message indicating why the operation failed.␊ - */␊ - message?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Definition of schedule parameters.␊ - */␊ - export interface ScheduleProperties2 {␊ - /**␊ - * The properties of the create Advanced Schedule.␊ - */␊ - advancedSchedule?: (AdvancedSchedule1 | string)␊ - /**␊ - * Gets or sets the creation time.␊ - */␊ - creationTime?: string␊ - /**␊ - * Gets or sets the description.␊ - */␊ - description?: string␊ - /**␊ - * Gets or sets the end time of the schedule.␊ - */␊ - expiryTime?: string␊ - /**␊ - * Gets or sets the expiry time's offset in minutes.␊ - */␊ - expiryTimeOffsetMinutes?: (number | string)␊ - /**␊ - * Gets or sets the frequency of the schedule.␊ - */␊ - frequency?: (("OneTime" | "Day" | "Hour" | "Week" | "Month" | "Minute") | string)␊ - /**␊ - * Gets or sets the interval of the schedule.␊ - */␊ - interval?: (number | string)␊ - /**␊ - * Gets or sets a value indicating whether this schedule is enabled.␊ - */␊ - isEnabled?: (boolean | string)␊ - /**␊ - * Gets or sets the last modified time.␊ - */␊ - lastModifiedTime?: string␊ - /**␊ - * Gets or sets the next run time of the schedule.␊ - */␊ - nextRun?: string␊ - /**␊ - * Gets or sets the next run time's offset in minutes.␊ - */␊ - nextRunOffsetMinutes?: (number | string)␊ - /**␊ - * Gets or sets the start time of the schedule.␊ - */␊ - startTime?: string␊ - /**␊ - * Gets or sets the time zone of the schedule.␊ - */␊ - timeZone?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the create Advanced Schedule.␊ - */␊ - export interface AdvancedSchedule1 {␊ - /**␊ - * Days of the month that the job should execute on. Must be between 1 and 31.␊ - */␊ - monthDays?: (number[] | string)␊ - /**␊ - * Occurrences of days within a month.␊ - */␊ - monthlyOccurrences?: (AdvancedScheduleMonthlyOccurrence1[] | string)␊ - /**␊ - * Days of the week that the job should execute on.␊ - */␊ - weekDays?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the create advanced schedule monthly occurrence.␊ - */␊ - export interface AdvancedScheduleMonthlyOccurrence1 {␊ - /**␊ - * Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.␊ - */␊ - day?: (("Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday" | "Sunday") | string)␊ - /**␊ - * Occurrence of the week within the month. Must be between 1 and 5␊ - */␊ - occurrence?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Task properties of the software update configuration.␊ - */␊ - export interface SoftwareUpdateConfigurationTasks {␊ - /**␊ - * Task properties of the software update configuration.␊ - */␊ - postTask?: (TaskProperties | string)␊ - /**␊ - * Task properties of the software update configuration.␊ - */␊ - preTask?: (TaskProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Task properties of the software update configuration.␊ - */␊ - export interface TaskProperties {␊ - /**␊ - * Gets or sets the parameters of the task.␊ - */␊ - parameters?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Gets or sets the name of the runbook.␊ - */␊ - source?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Update specific properties of the software update configuration.␊ - */␊ - export interface UpdateConfiguration {␊ - /**␊ - * List of azure resource Ids for azure virtual machines targeted by the software update configuration.␊ - */␊ - azureVirtualMachines?: (string[] | string)␊ - /**␊ - * Maximum time allowed for the software update configuration run. Duration needs to be specified using the format PT[n]H[n]M[n]S as per ISO8601␊ - */␊ - duration?: string␊ - /**␊ - * Linux specific update configuration.␊ - */␊ - linux?: (LinuxProperties | string)␊ - /**␊ - * List of names of non-azure machines targeted by the software update configuration.␊ - */␊ - nonAzureComputerNames?: (string[] | string)␊ - /**␊ - * operating system of target machines.␊ - */␊ - operatingSystem: (("Windows" | "Linux") | string)␊ - /**␊ - * Group specific to the update configuration.␊ - */␊ - targets?: (TargetProperties | string)␊ - /**␊ - * Windows specific update configuration.␊ - */␊ - windows?: (WindowsProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linux specific update configuration.␊ - */␊ - export interface LinuxProperties {␊ - /**␊ - * packages excluded from the software update configuration.␊ - */␊ - excludedPackageNameMasks?: (string[] | string)␊ - /**␊ - * Update classifications included in the software update configuration.␊ - */␊ - includedPackageClassifications?: (("Unclassified" | "Critical" | "Security" | "Other") | string)␊ - /**␊ - * packages included from the software update configuration.␊ - */␊ - includedPackageNameMasks?: (string[] | string)␊ - /**␊ - * Reboot setting for the software update configuration.␊ - */␊ - rebootSetting?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Group specific to the update configuration.␊ - */␊ - export interface TargetProperties {␊ - /**␊ - * List of Azure queries in the software update configuration.␊ - */␊ - azureQueries?: (AzureQueryProperties[] | string)␊ - /**␊ - * List of non Azure queries in the software update configuration.␊ - */␊ - nonAzureQueries?: (NonAzureQueryProperties[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure query for the update configuration.␊ - */␊ - export interface AzureQueryProperties {␊ - /**␊ - * List of locations to scope the query to.␊ - */␊ - locations?: (string[] | string)␊ - /**␊ - * List of Subscription or Resource Group ARM Ids.␊ - */␊ - scope?: (string[] | string)␊ - /**␊ - * Tag filter information for the VM.␊ - */␊ - tagSettings?: (TagSettingsProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Tag filter information for the VM.␊ - */␊ - export interface TagSettingsProperties {␊ - /**␊ - * Filter VMs by Any or All specified tags.␊ - */␊ - filterOperator?: (("All" | "Any") | string)␊ - /**␊ - * Dictionary of tags with its list of values.␊ - */␊ - tags?: ({␊ - [k: string]: string[]␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Non Azure query for the update configuration.␊ - */␊ - export interface NonAzureQueryProperties {␊ - /**␊ - * Log Analytics Saved Search name.␊ - */␊ - functionAlias?: string␊ - /**␊ - * Workspace Id for Log Analytics in which the saved Search is resided.␊ - */␊ - workspaceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Windows specific update configuration.␊ - */␊ - export interface WindowsProperties {␊ - /**␊ - * KB numbers excluded from the software update configuration.␊ - */␊ - excludedKbNumbers?: (string[] | string)␊ - /**␊ - * KB numbers included from the software update configuration.␊ - */␊ - includedKbNumbers?: (string[] | string)␊ - /**␊ - * Update classification included in the software update configuration. A comma separated string with required values.␊ - */␊ - includedUpdateClassifications?: (("Unclassified" | "Critical" | "Security" | "UpdateRollup" | "FeaturePack" | "ServicePack" | "Definition" | "Tools" | "Updates") | string)␊ - /**␊ - * Reboot setting for the software update configuration.␊ - */␊ - rebootSetting?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Automation/automationAccounts/jobs␊ - */␊ - export interface AutomationAccountsJobs1 {␊ - apiVersion: "2017-05-15-preview"␊ - /**␊ - * The job name.␊ - */␊ - name: string␊ - properties: (JobCreateProperties1 | string)␊ - type: "Microsoft.Automation/automationAccounts/jobs"␊ - [k: string]: unknown␊ - }␊ - export interface JobCreateProperties1 {␊ - /**␊ - * Gets or sets the parameters of the job.␊ - */␊ - parameters?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The runbook property associated with the entity.␊ - */␊ - runbook?: (RunbookAssociationProperty1 | string)␊ - /**␊ - * Gets or sets the runOn which specifies the group name where the job is to be executed.␊ - */␊ - runOn?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The runbook property associated with the entity.␊ - */␊ - export interface RunbookAssociationProperty1 {␊ - /**␊ - * Gets or sets the name of the runbook.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Automation/automationAccounts/sourceControls␊ - */␊ - export interface AutomationAccountsSourceControls {␊ - apiVersion: "2017-05-15-preview"␊ - /**␊ - * The source control name.␊ - */␊ - name: string␊ - /**␊ - * The properties of the create source control operation.␊ - */␊ - properties: (SourceControlCreateOrUpdateProperties | string)␊ - resources?: AutomationAccountsSourceControlsSourceControlSyncJobsChildResource[]␊ - type: "Microsoft.Automation/automationAccounts/sourceControls"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the create source control operation.␊ - */␊ - export interface SourceControlCreateOrUpdateProperties {␊ - /**␊ - * The auto async of the source control. Default is false.␊ - */␊ - autoSync?: (boolean | string)␊ - /**␊ - * The repo branch of the source control. Include branch as empty string for VsoTfvc.␊ - */␊ - branch?: string␊ - /**␊ - * The user description of the source control.␊ - */␊ - description?: string␊ - /**␊ - * The folder path of the source control. Path must be relative.␊ - */␊ - folderPath?: string␊ - /**␊ - * The auto publish of the source control. Default is true.␊ - */␊ - publishRunbook?: (boolean | string)␊ - /**␊ - * The repo url of the source control.␊ - */␊ - repoUrl?: string␊ - securityToken?: (SourceControlSecurityTokenProperties | string)␊ - /**␊ - * The source type. Must be one of VsoGit, VsoTfvc, GitHub, case sensitive.␊ - */␊ - sourceType?: (("VsoGit" | "VsoTfvc" | "GitHub") | string)␊ - [k: string]: unknown␊ - }␊ - export interface SourceControlSecurityTokenProperties {␊ - /**␊ - * The access token.␊ - */␊ - accessToken?: string␊ - /**␊ - * The refresh token.␊ - */␊ - refreshToken?: string␊ - /**␊ - * The token type. Must be either PersonalAccessToken or Oauth.␊ - */␊ - tokenType?: (("PersonalAccessToken" | "Oauth") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Automation/automationAccounts/sourceControls/sourceControlSyncJobs␊ - */␊ - export interface AutomationAccountsSourceControlsSourceControlSyncJobsChildResource {␊ - apiVersion: "2017-05-15-preview"␊ - /**␊ - * The source control sync job id.␊ - */␊ - name: string␊ - /**␊ - * Definition of create source control sync job properties.␊ - */␊ - properties: (SourceControlSyncJobCreateProperties | string)␊ - type: "sourceControlSyncJobs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Definition of create source control sync job properties.␊ - */␊ - export interface SourceControlSyncJobCreateProperties {␊ - /**␊ - * The commit id of the source control sync job. If not syncing to a commitId, enter an empty string.␊ - */␊ - commitId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Automation/automationAccounts/sourceControls/sourceControlSyncJobs␊ - */␊ - export interface AutomationAccountsSourceControlsSourceControlSyncJobs {␊ - apiVersion: "2017-05-15-preview"␊ - /**␊ - * The source control sync job id.␊ - */␊ - name: string␊ - /**␊ - * Definition of create source control sync job properties.␊ - */␊ - properties: (SourceControlSyncJobCreateProperties | string)␊ - type: "Microsoft.Automation/automationAccounts/sourceControls/sourceControlSyncJobs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Automation/automationAccounts/compilationjobs␊ - */␊ - export interface AutomationAccountsCompilationjobs1 {␊ - apiVersion: "2018-01-15"␊ - /**␊ - * Gets or sets the location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * The DSC configuration Id.␊ - */␊ - name: string␊ - /**␊ - * The parameters supplied to the create compilation job operation.␊ - */␊ - properties: (DscCompilationJobCreateProperties1 | string)␊ - /**␊ - * Gets or sets the tags attached to the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Automation/automationAccounts/compilationjobs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The parameters supplied to the create compilation job operation.␊ - */␊ - export interface DscCompilationJobCreateProperties1 {␊ - /**␊ - * The Dsc configuration property associated with the entity.␊ - */␊ - configuration: (DscConfigurationAssociationProperty1 | string)␊ - /**␊ - * If a new build version of NodeConfiguration is required.␊ - */␊ - incrementNodeConfigurationBuild?: (boolean | string)␊ - /**␊ - * Gets or sets the parameters of the job.␊ - */␊ - parameters?: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Dsc configuration property associated with the entity.␊ - */␊ - export interface DscConfigurationAssociationProperty1 {␊ - /**␊ - * Gets or sets the name of the Dsc configuration.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Automation/automationAccounts/nodeConfigurations␊ - */␊ - export interface AutomationAccountsNodeConfigurations1 {␊ - apiVersion: "2018-01-15"␊ - /**␊ - * The Dsc node configuration name.␊ - */␊ - name: string␊ - /**␊ - * The parameter properties supplied to the create or update node configuration operation.␊ - */␊ - properties: (DscNodeConfigurationCreateOrUpdateParametersProperties | string)␊ - /**␊ - * Gets or sets the tags attached to the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Automation/automationAccounts/nodeConfigurations"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The parameter properties supplied to the create or update node configuration operation.␊ - */␊ - export interface DscNodeConfigurationCreateOrUpdateParametersProperties {␊ - /**␊ - * The Dsc configuration property associated with the entity.␊ - */␊ - configuration: (DscConfigurationAssociationProperty1 | string)␊ - /**␊ - * If a new build version of NodeConfiguration is required.␊ - */␊ - incrementNodeConfigurationBuild?: (boolean | string)␊ - /**␊ - * Definition of the content source.␊ - */␊ - source: (ContentSource1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Definition of the content source.␊ - */␊ - export interface ContentSource1 {␊ - /**␊ - * Definition of the runbook property type.␊ - */␊ - hash?: (ContentHash1 | string)␊ - /**␊ - * Gets or sets the content source type.␊ - */␊ - type?: (("embeddedContent" | "uri") | string)␊ - /**␊ - * Gets or sets the value of the content. This is based on the content source type.␊ - */␊ - value?: string␊ - /**␊ - * Gets or sets the version of the content.␊ - */␊ - version?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Definition of the runbook property type.␊ - */␊ - export interface ContentHash1 {␊ - /**␊ - * Gets or sets the content hash algorithm used to hash the content.␊ - */␊ - algorithm: string␊ - /**␊ - * Gets or sets expected hash value of the content.␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Automation/automationAccounts/python2Packages␊ - */␊ - export interface AutomationAccountsPython2Packages {␊ - apiVersion: "2018-06-30"␊ - /**␊ - * The name of python package.␊ - */␊ - name: string␊ - /**␊ - * The parameters supplied to the create or update module properties.␊ - */␊ - properties: (PythonPackageCreateProperties | string)␊ - /**␊ - * Gets or sets the tags attached to the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Automation/automationAccounts/python2Packages"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The parameters supplied to the create or update module properties.␊ - */␊ - export interface PythonPackageCreateProperties {␊ - /**␊ - * Definition of the content link.␊ - */␊ - contentLink: (ContentLink1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Definition of the content link.␊ - */␊ - export interface ContentLink1 {␊ - /**␊ - * Definition of the runbook property type.␊ - */␊ - contentHash?: (ContentHash2 | string)␊ - /**␊ - * Gets or sets the uri of the runbook content.␊ - */␊ - uri?: string␊ - /**␊ - * Gets or sets the version of the content.␊ - */␊ - version?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Definition of the runbook property type.␊ - */␊ - export interface ContentHash2 {␊ - /**␊ - * Gets or sets the content hash algorithm used to hash the content.␊ - */␊ - algorithm: string␊ - /**␊ - * Gets or sets expected hash value of the content.␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Automation/automationAccounts/runbooks␊ - */␊ - export interface AutomationAccountsRunbooks1 {␊ - apiVersion: "2018-06-30"␊ - /**␊ - * Gets or sets the location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * The runbook name.␊ - */␊ - name: string␊ - /**␊ - * The parameters supplied to the create or update runbook properties.␊ - */␊ - properties: (RunbookCreateOrUpdateProperties1 | string)␊ - resources?: AutomationAccountsRunbooksDraftChildResource1[]␊ - /**␊ - * Gets or sets the tags attached to the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Automation/automationAccounts/runbooks"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The parameters supplied to the create or update runbook properties.␊ - */␊ - export interface RunbookCreateOrUpdateProperties1 {␊ - /**␊ - * Gets or sets the description of the runbook.␊ - */␊ - description?: string␊ - draft?: (RunbookDraft1 | string)␊ - /**␊ - * Gets or sets the activity-level tracing options of the runbook.␊ - */␊ - logActivityTrace?: (number | string)␊ - /**␊ - * Gets or sets progress log option.␊ - */␊ - logProgress?: (boolean | string)␊ - /**␊ - * Gets or sets verbose log option.␊ - */␊ - logVerbose?: (boolean | string)␊ - /**␊ - * Definition of the content link.␊ - */␊ - publishContentLink?: (ContentLink1 | string)␊ - /**␊ - * Gets or sets the type of the runbook.␊ - */␊ - runbookType: (("Script" | "Graph" | "PowerShellWorkflow" | "PowerShell" | "GraphPowerShellWorkflow" | "GraphPowerShell" | "Python2" | "Python3") | string)␊ - [k: string]: unknown␊ - }␊ - export interface RunbookDraft1 {␊ - /**␊ - * Gets or sets the creation time of the runbook draft.␊ - */␊ - creationTime?: string␊ - /**␊ - * Definition of the content link.␊ - */␊ - draftContentLink?: (ContentLink1 | string)␊ - /**␊ - * Gets or sets whether runbook is in edit mode.␊ - */␊ - inEdit?: (boolean | string)␊ - /**␊ - * Gets or sets the last modified time of the runbook draft.␊ - */␊ - lastModifiedTime?: string␊ - /**␊ - * Gets or sets the runbook output types.␊ - */␊ - outputTypes?: (string[] | string)␊ - /**␊ - * Gets or sets the runbook draft parameters.␊ - */␊ - parameters?: ({␊ - [k: string]: RunbookParameter1␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Definition of the runbook parameter type.␊ - */␊ - export interface RunbookParameter1 {␊ - /**␊ - * Gets or sets the default value of parameter.␊ - */␊ - defaultValue?: string␊ - /**␊ - * Gets or sets a Boolean value to indicate whether the parameter is mandatory or not.␊ - */␊ - isMandatory?: (boolean | string)␊ - /**␊ - * Get or sets the position of the parameter.␊ - */␊ - position?: (number | string)␊ - /**␊ - * Gets or sets the type of the parameter.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Media/mediaservices␊ - */␊ - export interface Mediaservices {␊ - apiVersion: "2015-10-01"␊ - /**␊ - * The geographic location of the resource. This must be one of the supported and registered Azure Geo Regions (for example, West US, East US, Southeast Asia, and so forth).␊ - */␊ - location?: string␊ - /**␊ - * Name of the Media Service.␊ - */␊ - name: string␊ - /**␊ - * The additional properties of a Media Service resource.␊ - */␊ - properties: (MediaServiceProperties | string)␊ - /**␊ - * Tags to help categorize the resource in the Azure portal.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Media/mediaservices"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The additional properties of a Media Service resource.␊ - */␊ - export interface MediaServiceProperties {␊ - /**␊ - * The storage accounts for this resource.␊ - */␊ - storageAccounts?: (StorageAccount1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a storage account associated with this resource.␊ - */␊ - export interface StorageAccount1 {␊ - /**␊ - * The id of the storage account resource. Media Services relies on tables and queues as well as blobs, so the primary storage account must be a Standard Storage account (either Microsoft.ClassicStorage or Microsoft.Storage). Blob only storage accounts can be added as secondary storage accounts (isPrimary false).␊ - */␊ - id: string␊ - /**␊ - * Is this storage account resource the primary storage account for the Media Service resource. Blob only storage must set this to false.␊ - */␊ - isPrimary: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Media/mediaservices␊ - */␊ - export interface Mediaservices1 {␊ - apiVersion: "2018-07-01"␊ - /**␊ - * The Azure Region of the resource.␊ - */␊ - location?: string␊ - /**␊ - * The Media Services account name.␊ - */␊ - name: string␊ - /**␊ - * Properties of the Media Services account.␊ - */␊ - properties: (MediaServiceProperties1 | string)␊ - resources?: (MediaServicesAccountFiltersChildResource | MediaServicesAssetsChildResource | MediaServicesContentKeyPoliciesChildResource | MediaServicesTransformsChildResource | MediaServicesStreamingPoliciesChildResource | MediaServicesStreamingLocatorsChildResource)[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Media/mediaservices"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Media Services account.␊ - */␊ - export interface MediaServiceProperties1 {␊ - /**␊ - * The storage accounts for this resource.␊ - */␊ - storageAccounts?: (StorageAccount2[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The storage account details.␊ - */␊ - export interface StorageAccount2 {␊ - /**␊ - * The ID of the storage account resource. Media Services relies on tables and queues as well as blobs, so the primary storage account must be a Standard Storage account (either Microsoft.ClassicStorage or Microsoft.Storage). Blob only storage accounts can be added as secondary storage accounts.␊ - */␊ - id?: string␊ - /**␊ - * The type of the storage account.␊ - */␊ - type: (("Primary" | "Secondary") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Media/mediaServices/accountFilters␊ - */␊ - export interface MediaServicesAccountFiltersChildResource {␊ - apiVersion: "2018-07-01"␊ - /**␊ - * The Account Filter name␊ - */␊ - name: string␊ - /**␊ - * The Media Filter properties.␊ - */␊ - properties: (MediaFilterProperties | string)␊ - type: "accountFilters"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Media Filter properties.␊ - */␊ - export interface MediaFilterProperties {␊ - /**␊ - * Filter First Quality␊ - */␊ - firstQuality?: (FirstQuality | string)␊ - /**␊ - * The presentation time range, this is asset related and not recommended for Account Filter.␊ - */␊ - presentationTimeRange?: (PresentationTimeRange | string)␊ - /**␊ - * The tracks selection conditions.␊ - */␊ - tracks?: (FilterTrackSelection[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Filter First Quality␊ - */␊ - export interface FirstQuality {␊ - /**␊ - * The first quality bitrate.␊ - */␊ - bitrate: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The presentation time range, this is asset related and not recommended for Account Filter.␊ - */␊ - export interface PresentationTimeRange {␊ - /**␊ - * The absolute end time boundary.␊ - */␊ - endTimestamp?: (number | string)␊ - /**␊ - * The indicator of forcing existing of end time stamp.␊ - */␊ - forceEndTimestamp?: (boolean | string)␊ - /**␊ - * The relative to end right edge.␊ - */␊ - liveBackoffDuration?: (number | string)␊ - /**␊ - * The relative to end sliding window.␊ - */␊ - presentationWindowDuration?: (number | string)␊ - /**␊ - * The absolute start time boundary.␊ - */␊ - startTimestamp?: (number | string)␊ - /**␊ - * The time scale of time stamps.␊ - */␊ - timescale?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Representing a list of FilterTrackPropertyConditions to select a track. The filters are combined using a logical AND operation.␊ - */␊ - export interface FilterTrackSelection {␊ - /**␊ - * The track selections.␊ - */␊ - trackSelections: (FilterTrackPropertyCondition[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The class to specify one track property condition.␊ - */␊ - export interface FilterTrackPropertyCondition {␊ - /**␊ - * The track property condition operation.␊ - */␊ - operation: (("Equal" | "NotEqual") | string)␊ - /**␊ - * The track property type.␊ - */␊ - property: (("Unknown" | "Type" | "Name" | "Language" | "FourCC" | "Bitrate") | string)␊ - /**␊ - * The track property value.␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Media/mediaServices/assets␊ - */␊ - export interface MediaServicesAssetsChildResource {␊ - apiVersion: "2018-07-01"␊ - /**␊ - * The Asset name.␊ - */␊ - name: string␊ - /**␊ - * The Asset properties.␊ - */␊ - properties: (AssetProperties | string)␊ - type: "assets"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Asset properties.␊ - */␊ - export interface AssetProperties {␊ - /**␊ - * The alternate ID of the Asset.␊ - */␊ - alternateId?: string␊ - /**␊ - * The name of the asset blob container.␊ - */␊ - container?: string␊ - /**␊ - * The Asset description.␊ - */␊ - description?: string␊ - /**␊ - * The name of the storage account.␊ - */␊ - storageAccountName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Media/mediaServices/contentKeyPolicies␊ - */␊ - export interface MediaServicesContentKeyPoliciesChildResource {␊ - apiVersion: "2018-07-01"␊ - /**␊ - * The Content Key Policy name.␊ - */␊ - name: string␊ - /**␊ - * The properties of the Content Key Policy.␊ - */␊ - properties: (ContentKeyPolicyProperties | string)␊ - type: "contentKeyPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the Content Key Policy.␊ - */␊ - export interface ContentKeyPolicyProperties {␊ - /**␊ - * A description for the Policy.␊ - */␊ - description?: string␊ - /**␊ - * The Key Policy options.␊ - */␊ - options: (ContentKeyPolicyOption[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents a policy option.␊ - */␊ - export interface ContentKeyPolicyOption {␊ - /**␊ - * Base class for Content Key Policy configuration. A derived class must be used to create a configuration.␊ - */␊ - configuration: (ContentKeyPolicyConfiguration | string)␊ - /**␊ - * The Policy Option description.␊ - */␊ - name?: string␊ - /**␊ - * Base class for Content Key Policy restrictions. A derived class must be used to create a restriction.␊ - */␊ - restriction: (ContentKeyPolicyRestriction | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents a configuration for non-DRM keys.␊ - */␊ - export interface ContentKeyPolicyClearKeyConfiguration {␊ - "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents a ContentKeyPolicyConfiguration that is unavailable in the current API version.␊ - */␊ - export interface ContentKeyPolicyUnknownConfiguration {␊ - "@odata.type": "#Microsoft.Media.ContentKeyPolicyUnknownConfiguration"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies a configuration for Widevine licenses.␊ - */␊ - export interface ContentKeyPolicyWidevineConfiguration {␊ - "@odata.type": "#Microsoft.Media.ContentKeyPolicyWidevineConfiguration"␊ - /**␊ - * The Widevine template.␊ - */␊ - widevineTemplate: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies a configuration for PlayReady licenses.␊ - */␊ - export interface ContentKeyPolicyPlayReadyConfiguration {␊ - "@odata.type": "#Microsoft.Media.ContentKeyPolicyPlayReadyConfiguration"␊ - /**␊ - * The PlayReady licenses.␊ - */␊ - licenses: (ContentKeyPolicyPlayReadyLicense[] | string)␊ - /**␊ - * The custom response data.␊ - */␊ - responseCustomData?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The PlayReady license␊ - */␊ - export interface ContentKeyPolicyPlayReadyLicense {␊ - /**␊ - * A flag indicating whether test devices can use the license.␊ - */␊ - allowTestDevices: (boolean | string)␊ - /**␊ - * The begin date of license␊ - */␊ - beginDate?: string␊ - /**␊ - * Base class for content key ID location. A derived class must be used to represent the location.␊ - */␊ - contentKeyLocation: (ContentKeyPolicyPlayReadyContentKeyLocation | string)␊ - /**␊ - * The PlayReady content type.␊ - */␊ - contentType: (("Unknown" | "Unspecified" | "UltraVioletDownload" | "UltraVioletStreaming") | string)␊ - /**␊ - * The expiration date of license.␊ - */␊ - expirationDate?: string␊ - /**␊ - * The grace period of license.␊ - */␊ - gracePeriod?: string␊ - /**␊ - * The license type.␊ - */␊ - licenseType: (("Unknown" | "NonPersistent" | "Persistent") | string)␊ - /**␊ - * Configures the Play Right in the PlayReady license.␊ - */␊ - playRight?: (ContentKeyPolicyPlayReadyPlayRight | string)␊ - /**␊ - * The relative begin date of license.␊ - */␊ - relativeBeginDate?: string␊ - /**␊ - * The relative expiration date of license.␊ - */␊ - relativeExpirationDate?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies that the content key ID is in the PlayReady header.␊ - */␊ - export interface ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader {␊ - "@odata.type": "#Microsoft.Media.ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies that the content key ID is specified in the PlayReady configuration.␊ - */␊ - export interface ContentKeyPolicyPlayReadyContentEncryptionKeyFromKeyIdentifier {␊ - "@odata.type": "#Microsoft.Media.ContentKeyPolicyPlayReadyContentEncryptionKeyFromKeyIdentifier"␊ - /**␊ - * The content key ID.␊ - */␊ - keyId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Configures the Play Right in the PlayReady license.␊ - */␊ - export interface ContentKeyPolicyPlayReadyPlayRight {␊ - /**␊ - * Configures Automatic Gain Control (AGC) and Color Stripe in the license. Must be between 0 and 3 inclusive.␊ - */␊ - agcAndColorStripeRestriction?: (number | string)␊ - /**␊ - * Configures Unknown output handling settings of the license.␊ - */␊ - allowPassingVideoContentToUnknownOutput: (("Unknown" | "NotAllowed" | "Allowed" | "AllowedWithVideoConstriction") | string)␊ - /**␊ - * Specifies the output protection level for compressed digital audio.␊ - */␊ - analogVideoOpl?: (number | string)␊ - /**␊ - * Specifies the output protection level for compressed digital audio.␊ - */␊ - compressedDigitalAudioOpl?: (number | string)␊ - /**␊ - * Specifies the output protection level for compressed digital video.␊ - */␊ - compressedDigitalVideoOpl?: (number | string)␊ - /**␊ - * Enables the Image Constraint For Analog Component Video Restriction in the license.␊ - */␊ - digitalVideoOnlyContentRestriction: (boolean | string)␊ - /**␊ - * Configures the Explicit Analog Television Output Restriction control bits. For further details see the PlayReady Compliance Rules.␊ - */␊ - explicitAnalogTelevisionOutputRestriction?: (ContentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction | string)␊ - /**␊ - * The amount of time that the license is valid after the license is first used to play content.␊ - */␊ - firstPlayExpiration?: string␊ - /**␊ - * Enables the Image Constraint For Analog Component Video Restriction in the license.␊ - */␊ - imageConstraintForAnalogComponentVideoRestriction: (boolean | string)␊ - /**␊ - * Enables the Image Constraint For Analog Component Video Restriction in the license.␊ - */␊ - imageConstraintForAnalogComputerMonitorRestriction: (boolean | string)␊ - /**␊ - * Configures the Serial Copy Management System (SCMS) in the license. Must be between 0 and 3 inclusive.␊ - */␊ - scmsRestriction?: (number | string)␊ - /**␊ - * Specifies the output protection level for uncompressed digital audio.␊ - */␊ - uncompressedDigitalAudioOpl?: (number | string)␊ - /**␊ - * Specifies the output protection level for uncompressed digital video.␊ - */␊ - uncompressedDigitalVideoOpl?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Configures the Explicit Analog Television Output Restriction control bits. For further details see the PlayReady Compliance Rules.␊ - */␊ - export interface ContentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction {␊ - /**␊ - * Indicates whether this restriction is enforced on a Best Effort basis.␊ - */␊ - bestEffort: (boolean | string)␊ - /**␊ - * Configures the restriction control bits. Must be between 0 and 3 inclusive.␊ - */␊ - configurationData: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies a configuration for FairPlay licenses.␊ - */␊ - export interface ContentKeyPolicyFairPlayConfiguration {␊ - "@odata.type": "#Microsoft.Media.ContentKeyPolicyFairPlayConfiguration"␊ - /**␊ - * The key that must be used as FairPlay Application Secret key.␊ - */␊ - ask: string␊ - /**␊ - * The Base64 representation of FairPlay certificate in PKCS 12 (pfx) format (including private key).␊ - */␊ - fairPlayPfx: string␊ - /**␊ - * The password encrypting FairPlay certificate in PKCS 12 (pfx) format.␊ - */␊ - fairPlayPfxPassword: string␊ - /**␊ - * The rental and lease key type.␊ - */␊ - rentalAndLeaseKeyType: (("Unknown" | "Undefined" | "PersistentUnlimited" | "PersistentLimited") | string)␊ - /**␊ - * The rental duration. Must be greater than or equal to 0.␊ - */␊ - rentalDuration: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents an open restriction. License or key will be delivered on every request.␊ - */␊ - export interface ContentKeyPolicyOpenRestriction {␊ - "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents a ContentKeyPolicyRestriction that is unavailable in the current API version.␊ - */␊ - export interface ContentKeyPolicyUnknownRestriction {␊ - "@odata.type": "#Microsoft.Media.ContentKeyPolicyUnknownRestriction"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents a token restriction. Provided token must match these requirements for successful license or key delivery.␊ - */␊ - export interface ContentKeyPolicyTokenRestriction {␊ - "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction"␊ - /**␊ - * A list of alternative verification keys.␊ - */␊ - alternateVerificationKeys?: (ContentKeyPolicyRestrictionTokenKey[] | string)␊ - /**␊ - * The audience for the token.␊ - */␊ - audience: string␊ - /**␊ - * The token issuer.␊ - */␊ - issuer: string␊ - /**␊ - * The OpenID connect discovery document.␊ - */␊ - openIdConnectDiscoveryDocument?: string␊ - /**␊ - * Base class for Content Key Policy key for token validation. A derived class must be used to create a token key.␊ - */␊ - primaryVerificationKey: ((ContentKeyPolicySymmetricTokenKey | ContentKeyPolicyRsaTokenKey | ContentKeyPolicyX509CertificateTokenKey) | string)␊ - /**␊ - * A list of required token claims.␊ - */␊ - requiredClaims?: (ContentKeyPolicyTokenClaim[] | string)␊ - /**␊ - * The type of token.␊ - */␊ - restrictionTokenType: (("Unknown" | "Swt" | "Jwt") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies a symmetric key for token validation.␊ - */␊ - export interface ContentKeyPolicySymmetricTokenKey {␊ - "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey"␊ - /**␊ - * The key value of the key␊ - */␊ - keyValue: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies a RSA key for token validation␊ - */␊ - export interface ContentKeyPolicyRsaTokenKey {␊ - "@odata.type": "#Microsoft.Media.ContentKeyPolicyRsaTokenKey"␊ - /**␊ - * The RSA Parameter exponent␊ - */␊ - exponent: string␊ - /**␊ - * The RSA Parameter modulus␊ - */␊ - modulus: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies a certificate for token validation.␊ - */␊ - export interface ContentKeyPolicyX509CertificateTokenKey {␊ - "@odata.type": "#Microsoft.Media.ContentKeyPolicyX509CertificateTokenKey"␊ - /**␊ - * The raw data field of a certificate in PKCS 12 format (X509Certificate2 in .NET)␊ - */␊ - rawBody: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents a token claim.␊ - */␊ - export interface ContentKeyPolicyTokenClaim {␊ - /**␊ - * Token claim type.␊ - */␊ - claimType?: string␊ - /**␊ - * Token claim value.␊ - */␊ - claimValue?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Media/mediaServices/transforms␊ - */␊ - export interface MediaServicesTransformsChildResource {␊ - apiVersion: "2018-07-01"␊ - /**␊ - * The Transform name.␊ - */␊ - name: string␊ - /**␊ - * A Transform.␊ - */␊ - properties: (TransformProperties | string)␊ - type: "transforms"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A Transform.␊ - */␊ - export interface TransformProperties {␊ - /**␊ - * An optional verbose description of the Transform.␊ - */␊ - description?: string␊ - /**␊ - * An array of one or more TransformOutputs that the Transform should generate.␊ - */␊ - outputs: (TransformOutput[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the properties of a TransformOutput, which are the rules to be applied while generating the desired output.␊ - */␊ - export interface TransformOutput {␊ - /**␊ - * A Transform can define more than one outputs. This property defines what the service should do when one output fails - either continue to produce other outputs, or, stop the other outputs. The overall Job state will not reflect failures of outputs that are specified with 'ContinueJob'. The default is 'StopProcessingJob'.␊ - */␊ - onError?: (("StopProcessingJob" | "ContinueJob") | string)␊ - /**␊ - * Base type for all Presets, which define the recipe or instructions on how the input media files should be processed.␊ - */␊ - preset: (Preset | string)␊ - /**␊ - * Sets the relative priority of the TransformOutputs within a Transform. This sets the priority that the service uses for processing TransformOutputs. The default priority is Normal.␊ - */␊ - relativePriority?: (("Low" | "Normal" | "High") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes all the settings to be used when analyzing a video in order to detect all the faces present.␊ - */␊ - export interface FaceDetectorPreset {␊ - "@odata.type": "#Microsoft.Media.FaceDetectorPreset"␊ - /**␊ - * Specifies the maximum resolution at which your video is analyzed. The default behavior is "SourceResolution," which will keep the input video at its original resolution when analyzed. Using "StandardDefinition" will resize input videos to standard definition while preserving the appropriate aspect ratio. It will only resize if the video is of higher resolution. For example, a 1920x1080 input would be scaled to 640x360 before processing. Switching to "StandardDefinition" will reduce the time it takes to process high resolution video. It may also reduce the cost of using this component (see https://azure.microsoft.com/en-us/pricing/details/media-services/#analytics for details). However, faces that end up being too small in the resized video may not be detected.␊ - */␊ - resolution?: (("SourceResolution" | "StandardDefinition") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A video analyzer preset that extracts insights (rich metadata) from both audio and video, and outputs a JSON format file.␊ - */␊ - export interface VideoAnalyzerPreset {␊ - "@odata.type": "#Microsoft.Media.VideoAnalyzerPreset"␊ - /**␊ - * Defines the type of insights that you want the service to generate. The allowed values are 'AudioInsightsOnly', 'VideoInsightsOnly', and 'AllInsights'. The default is AllInsights. If you set this to AllInsights and the input is audio only, then only audio insights are generated. Similarly if the input is video only, then only video insights are generated. It is recommended that you not use AudioInsightsOnly if you expect some of your inputs to be video only; or use VideoInsightsOnly if you expect some of your inputs to be audio only. Your Jobs in such conditions would error out.␊ - */␊ - insightsToExtract?: (("AudioInsightsOnly" | "VideoInsightsOnly" | "AllInsights") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a built-in preset for encoding the input video with the Standard Encoder.␊ - */␊ - export interface BuiltInStandardEncoderPreset {␊ - "@odata.type": "#Microsoft.Media.BuiltInStandardEncoderPreset"␊ - /**␊ - * The built-in preset to be used for encoding videos.␊ - */␊ - presetName: (("H264SingleBitrateSD" | "H264SingleBitrate720p" | "H264SingleBitrate1080p" | "AdaptiveStreaming" | "AACGoodQualityAudio" | "ContentAwareEncodingExperimental" | "H264MultipleBitrate1080p" | "H264MultipleBitrate720p" | "H264MultipleBitrateSD") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes all the settings to be used when encoding the input video with the Standard Encoder.␊ - */␊ - export interface StandardEncoderPreset {␊ - "@odata.type": "#Microsoft.Media.StandardEncoderPreset"␊ - /**␊ - * The list of codecs to be used when encoding the input video.␊ - */␊ - codecs: (Codec[] | string)␊ - /**␊ - * Describes all the filtering operations, such as de-interlacing, rotation etc. that are to be applied to the input media before encoding.␊ - */␊ - filters?: (Filters | string)␊ - /**␊ - * The list of outputs to be produced by the encoder.␊ - */␊ - formats: (Format[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes Advanced Audio Codec (AAC) audio encoding settings.␊ - */␊ - export interface AacAudio {␊ - "@odata.type": "#Microsoft.Media.AacAudio"␊ - /**␊ - * The encoding profile to be used when encoding audio with AAC.␊ - */␊ - profile?: (("AacLc" | "HeAacV1" | "HeAacV2") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A codec flag, which tells the encoder to copy the input video bitstream without re-encoding.␊ - */␊ - export interface CopyVideo {␊ - "@odata.type": "#Microsoft.Media.CopyVideo"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the properties for producing a series of JPEG images from the input video.␊ - */␊ - export interface JpgImage {␊ - "@odata.type": "#Microsoft.Media.JpgImage"␊ - /**␊ - * A collection of output JPEG image layers to be produced by the encoder.␊ - */␊ - layers?: (JpgLayer[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the settings to produce a JPEG image from the input video.␊ - */␊ - export interface JpgLayer {␊ - /**␊ - * The height of the output video for this layer. The value can be absolute (in pixels) or relative (in percentage). For example 50% means the output video has half as many pixels in height as the input.␊ - */␊ - height?: string␊ - /**␊ - * The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file.␊ - */␊ - label?: string␊ - /**␊ - * The compression quality of the JPEG output. Range is from 0-100 and the default is 70.␊ - */␊ - quality?: (number | string)␊ - /**␊ - * The width of the output video for this layer. The value can be absolute (in pixels) or relative (in percentage). For example 50% means the output video has half as many pixels in width as the input.␊ - */␊ - width?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the properties for producing a series of PNG images from the input video.␊ - */␊ - export interface PngImage {␊ - "@odata.type": "#Microsoft.Media.PngImage"␊ - /**␊ - * A collection of output PNG image layers to be produced by the encoder.␊ - */␊ - layers?: (PngLayer[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the settings to produce a PNG image from the input video.␊ - */␊ - export interface PngLayer {␊ - /**␊ - * The height of the output video for this layer. The value can be absolute (in pixels) or relative (in percentage). For example 50% means the output video has half as many pixels in height as the input.␊ - */␊ - height?: string␊ - /**␊ - * The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file.␊ - */␊ - label?: string␊ - /**␊ - * The width of the output video for this layer. The value can be absolute (in pixels) or relative (in percentage). For example 50% means the output video has half as many pixels in width as the input.␊ - */␊ - width?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes all the properties for encoding a video with the H.264 codec.␊ - */␊ - export interface H264Video {␊ - "@odata.type": "#Microsoft.Media.H264Video"␊ - /**␊ - * Tells the encoder how to choose its encoding settings. The default value is Balanced.␊ - */␊ - complexity?: (("Speed" | "Balanced" | "Quality") | string)␊ - /**␊ - * The collection of output H.264 layers to be produced by the encoder.␊ - */␊ - layers?: (H264Layer[] | string)␊ - /**␊ - * Whether or not the encoder should insert key frames at scene changes. If not specified, the default is false. This flag should be set to true only when the encoder is being configured to produce a single output video.␊ - */␊ - sceneChangeDetection?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the settings to be used when encoding the input video into a desired output bitrate layer with the H.264 video codec.␊ - */␊ - export interface H264Layer {␊ - /**␊ - * Whether or not adaptive B-frames are to be used when encoding this layer. If not specified, the encoder will turn it on whenever the video profile permits its use.␊ - */␊ - adaptiveBFrame?: (boolean | string)␊ - /**␊ - * The number of B-frames to be used when encoding this layer. If not specified, the encoder chooses an appropriate number based on the video profile and level.␊ - */␊ - bFrames?: (number | string)␊ - /**␊ - * The average bitrate in bits per second at which to encode the input video when generating this layer. This is a required field.␊ - */␊ - bitrate: (number | string)␊ - /**␊ - * The VBV buffer window length. The value should be in ISO 8601 format. The value should be in the range [0.1-100] seconds. The default is 5 seconds (for example, PT5S).␊ - */␊ - bufferWindow?: string␊ - /**␊ - * The entropy mode to be used for this layer. If not specified, the encoder chooses the mode that is appropriate for the profile and level.␊ - */␊ - entropyMode?: (("Cabac" | "Cavlc") | string)␊ - /**␊ - * The frame rate (in frames per second) at which to encode this layer. The value can be in the form of M/N where M and N are integers (For example, 30000/1001), or in the form of a number (For example, 30, or 29.97). The encoder enforces constraints on allowed frame rates based on the profile and level. If it is not specified, the encoder will use the same frame rate as the input video.␊ - */␊ - frameRate?: string␊ - /**␊ - * The height of the output video for this layer. The value can be absolute (in pixels) or relative (in percentage). For example 50% means the output video has half as many pixels in height as the input.␊ - */␊ - height?: string␊ - /**␊ - * The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file.␊ - */␊ - label?: string␊ - /**␊ - * We currently support Level up to 6.2. The value can be Auto, or a number that matches the H.264 profile. If not specified, the default is Auto, which lets the encoder choose the Level that is appropriate for this layer.␊ - */␊ - level?: string␊ - /**␊ - * The maximum bitrate (in bits per second), at which the VBV buffer should be assumed to refill. If not specified, defaults to the same value as bitrate.␊ - */␊ - maxBitrate?: (number | string)␊ - /**␊ - * We currently support Baseline, Main, High, High422, High444. Default is Auto.␊ - */␊ - profile?: (("Auto" | "Baseline" | "Main" | "High" | "High422" | "High444") | string)␊ - /**␊ - * The number of reference frames to be used when encoding this layer. If not specified, the encoder determines an appropriate number based on the encoder complexity setting.␊ - */␊ - referenceFrames?: (number | string)␊ - /**␊ - * The number of slices to be used when encoding this layer. If not specified, default is zero, which means that encoder will use a single slice for each frame.␊ - */␊ - slices?: (number | string)␊ - /**␊ - * The width of the output video for this layer. The value can be absolute (in pixels) or relative (in percentage). For example 50% means the output video has half as many pixels in width as the input.␊ - */␊ - width?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A codec flag, which tells the encoder to copy the input audio bitstream.␊ - */␊ - export interface CopyAudio {␊ - "@odata.type": "#Microsoft.Media.CopyAudio"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes all the filtering operations, such as de-interlacing, rotation etc. that are to be applied to the input media before encoding.␊ - */␊ - export interface Filters {␊ - /**␊ - * Describes the properties of a rectangular window applied to the input media before processing it.␊ - */␊ - crop?: (Rectangle | string)␊ - /**␊ - * Describes the de-interlacing settings.␊ - */␊ - deinterlace?: (Deinterlace | string)␊ - /**␊ - * The properties of overlays to be applied to the input video. These could be audio, image or video overlays.␊ - */␊ - overlays?: (Overlay[] | string)␊ - /**␊ - * The rotation, if any, to be applied to the input video, before it is encoded. Default is Auto.␊ - */␊ - rotation?: (("Auto" | "None" | "Rotate0" | "Rotate90" | "Rotate180" | "Rotate270") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the properties of a rectangular window applied to the input media before processing it.␊ - */␊ - export interface Rectangle {␊ - /**␊ - * The height of the rectangular region in pixels. This can be absolute pixel value (e.g 100), or relative to the size of the video (For example, 50%).␊ - */␊ - height?: string␊ - /**␊ - * The number of pixels from the left-margin. This can be absolute pixel value (e.g 100), or relative to the size of the video (For example, 50%).␊ - */␊ - left?: string␊ - /**␊ - * The number of pixels from the top-margin. This can be absolute pixel value (e.g 100), or relative to the size of the video (For example, 50%).␊ - */␊ - top?: string␊ - /**␊ - * The width of the rectangular region in pixels. This can be absolute pixel value (e.g 100), or relative to the size of the video (For example, 50%).␊ - */␊ - width?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the de-interlacing settings.␊ - */␊ - export interface Deinterlace {␊ - /**␊ - * The deinterlacing mode. Defaults to AutoPixelAdaptive.␊ - */␊ - mode?: (("Off" | "AutoPixelAdaptive") | string)␊ - /**␊ - * The field parity for de-interlacing, defaults to Auto.␊ - */␊ - parity?: (("Auto" | "TopFieldFirst" | "BottomFieldFirst") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the properties of an audio overlay.␊ - */␊ - export interface AudioOverlay {␊ - "@odata.type": "#Microsoft.Media.AudioOverlay"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the properties of a video overlay.␊ - */␊ - export interface VideoOverlay {␊ - "@odata.type": "#Microsoft.Media.VideoOverlay"␊ - /**␊ - * Describes the properties of a rectangular window applied to the input media before processing it.␊ - */␊ - cropRectangle?: (Rectangle | string)␊ - /**␊ - * The opacity of the overlay. This is a value in the range [0 - 1.0]. Default is 1.0 which mean the overlay is opaque.␊ - */␊ - opacity?: (number | string)␊ - /**␊ - * Describes the properties of a rectangular window applied to the input media before processing it.␊ - */␊ - position?: (Rectangle | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the settings for producing JPEG thumbnails.␊ - */␊ - export interface JpgFormat {␊ - "@odata.type": "#Microsoft.Media.JpgFormat"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the settings for producing PNG thumbnails.␊ - */␊ - export interface PngFormat {␊ - "@odata.type": "#Microsoft.Media.PngFormat"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents an output file produced.␊ - */␊ - export interface OutputFile {␊ - /**␊ - * The list of labels that describe how the encoder should multiplex video and audio into an output file. For example, if the encoder is producing two video layers with labels v1 and v2, and one audio layer with label a1, then an array like '[v1, a1]' tells the encoder to produce an output file with the video track represented by v1 and the audio track represented by a1.␊ - */␊ - labels: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the properties for an output ISO MP4 file.␊ - */␊ - export interface Mp4Format {␊ - "@odata.type": "#Microsoft.Media.Mp4Format"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the properties for generating an MPEG-2 Transport Stream (ISO/IEC 13818-1) output video file(s).␊ - */␊ - export interface TransportStreamFormat {␊ - "@odata.type": "#Microsoft.Media.TransportStreamFormat"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Media/mediaServices/streamingPolicies␊ - */␊ - export interface MediaServicesStreamingPoliciesChildResource {␊ - apiVersion: "2018-07-01"␊ - /**␊ - * The Streaming Policy name.␊ - */␊ - name: string␊ - /**␊ - * Class to specify properties of Streaming Policy␊ - */␊ - properties: (StreamingPolicyProperties | string)␊ - type: "streamingPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class to specify properties of Streaming Policy␊ - */␊ - export interface StreamingPolicyProperties {␊ - /**␊ - * Class for CommonEncryptionCbcs encryption scheme␊ - */␊ - commonEncryptionCbcs?: (CommonEncryptionCbcs | string)␊ - /**␊ - * Class for envelope encryption scheme␊ - */␊ - commonEncryptionCenc?: (CommonEncryptionCenc | string)␊ - /**␊ - * Default ContentKey used by current Streaming Policy␊ - */␊ - defaultContentKeyPolicyName?: string␊ - /**␊ - * Class for EnvelopeEncryption encryption scheme␊ - */␊ - envelopeEncryption?: (EnvelopeEncryption | string)␊ - /**␊ - * Class for NoEncryption scheme␊ - */␊ - noEncryption?: (NoEncryption | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class for CommonEncryptionCbcs encryption scheme␊ - */␊ - export interface CommonEncryptionCbcs {␊ - /**␊ - * Representing which tracks should not be encrypted␊ - */␊ - clearTracks?: (TrackSelection[] | string)␊ - /**␊ - * Class to specify properties of all content keys in Streaming Policy␊ - */␊ - contentKeys?: (StreamingPolicyContentKeys | string)␊ - /**␊ - * Class to specify DRM configurations of CommonEncryptionCbcs scheme in Streaming Policy␊ - */␊ - drm?: (CbcsDrmConfiguration | string)␊ - /**␊ - * Class to specify which protocols are enabled␊ - */␊ - enabledProtocols?: (EnabledProtocols | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class to select a track␊ - */␊ - export interface TrackSelection {␊ - /**␊ - * TrackSelections is a track property condition list which can specify track(s)␊ - */␊ - trackSelections?: (TrackPropertyCondition[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class to specify one track property condition␊ - */␊ - export interface TrackPropertyCondition {␊ - /**␊ - * Track property condition operation.␊ - */␊ - operation: (("Unknown" | "Equal") | string)␊ - /**␊ - * Track property type.␊ - */␊ - property: (("Unknown" | "FourCC") | string)␊ - /**␊ - * Track property value␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class to specify properties of all content keys in Streaming Policy␊ - */␊ - export interface StreamingPolicyContentKeys {␊ - /**␊ - * Class to specify properties of default content key for each encryption scheme␊ - */␊ - defaultKey?: (DefaultKey | string)␊ - /**␊ - * Representing tracks needs separate content key␊ - */␊ - keyToTrackMappings?: (StreamingPolicyContentKey[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class to specify properties of default content key for each encryption scheme␊ - */␊ - export interface DefaultKey {␊ - /**␊ - * Label can be used to specify Content Key when creating a Streaming Locator␊ - */␊ - label?: string␊ - /**␊ - * Policy used by Default Key␊ - */␊ - policyName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class to specify properties of content key␊ - */␊ - export interface StreamingPolicyContentKey {␊ - /**␊ - * Label can be used to specify Content Key when creating a Streaming Locator␊ - */␊ - label?: string␊ - /**␊ - * Policy used by Content Key␊ - */␊ - policyName?: string␊ - /**␊ - * Tracks which use this content key␊ - */␊ - tracks?: (TrackSelection[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class to specify DRM configurations of CommonEncryptionCbcs scheme in Streaming Policy␊ - */␊ - export interface CbcsDrmConfiguration {␊ - /**␊ - * Class to specify configurations of FairPlay in Streaming Policy␊ - */␊ - fairPlay?: (StreamingPolicyFairPlayConfiguration | string)␊ - /**␊ - * Class to specify configurations of PlayReady in Streaming Policy␊ - */␊ - playReady?: (StreamingPolicyPlayReadyConfiguration | string)␊ - /**␊ - * Class to specify configurations of Widevine in Streaming Policy␊ - */␊ - widevine?: (StreamingPolicyWidevineConfiguration | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class to specify configurations of FairPlay in Streaming Policy␊ - */␊ - export interface StreamingPolicyFairPlayConfiguration {␊ - /**␊ - * All license to be persistent or not␊ - */␊ - allowPersistentLicense: (boolean | string)␊ - /**␊ - * Template for the URL of the custom service delivering licenses to end user players. Not required when using Azure Media Services for issuing licenses. The template supports replaceable tokens that the service will update at runtime with the value specific to the request. The currently supported token values are {AlternativeMediaId}, which is replaced with the value of StreamingLocatorId.AlternativeMediaId, and {ContentKeyId}, which is replaced with the value of identifier of the key being requested.␊ - */␊ - customLicenseAcquisitionUrlTemplate?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class to specify configurations of PlayReady in Streaming Policy␊ - */␊ - export interface StreamingPolicyPlayReadyConfiguration {␊ - /**␊ - * Template for the URL of the custom service delivering licenses to end user players. Not required when using Azure Media Services for issuing licenses. The template supports replaceable tokens that the service will update at runtime with the value specific to the request. The currently supported token values are {AlternativeMediaId}, which is replaced with the value of StreamingLocatorId.AlternativeMediaId, and {ContentKeyId}, which is replaced with the value of identifier of the key being requested.␊ - */␊ - customLicenseAcquisitionUrlTemplate?: string␊ - /**␊ - * Custom attributes for PlayReady␊ - */␊ - playReadyCustomAttributes?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class to specify configurations of Widevine in Streaming Policy␊ - */␊ - export interface StreamingPolicyWidevineConfiguration {␊ - /**␊ - * Template for the URL of the custom service delivering licenses to end user players. Not required when using Azure Media Services for issuing licenses. The template supports replaceable tokens that the service will update at runtime with the value specific to the request. The currently supported token values are {AlternativeMediaId}, which is replaced with the value of StreamingLocatorId.AlternativeMediaId, and {ContentKeyId}, which is replaced with the value of identifier of the key being requested.␊ - */␊ - customLicenseAcquisitionUrlTemplate?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class to specify which protocols are enabled␊ - */␊ - export interface EnabledProtocols {␊ - /**␊ - * Enable DASH protocol or not␊ - */␊ - dash: (boolean | string)␊ - /**␊ - * Enable Download protocol or not␊ - */␊ - download: (boolean | string)␊ - /**␊ - * Enable HLS protocol or not␊ - */␊ - hls: (boolean | string)␊ - /**␊ - * Enable SmoothStreaming protocol or not␊ - */␊ - smoothStreaming: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class for envelope encryption scheme␊ - */␊ - export interface CommonEncryptionCenc {␊ - /**␊ - * Representing which tracks should not be encrypted␊ - */␊ - clearTracks?: (TrackSelection[] | string)␊ - /**␊ - * Class to specify properties of all content keys in Streaming Policy␊ - */␊ - contentKeys?: (StreamingPolicyContentKeys | string)␊ - /**␊ - * Class to specify DRM configurations of CommonEncryptionCenc scheme in Streaming Policy␊ - */␊ - drm?: (CencDrmConfiguration | string)␊ - /**␊ - * Class to specify which protocols are enabled␊ - */␊ - enabledProtocols?: (EnabledProtocols | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class to specify DRM configurations of CommonEncryptionCenc scheme in Streaming Policy␊ - */␊ - export interface CencDrmConfiguration {␊ - /**␊ - * Class to specify configurations of PlayReady in Streaming Policy␊ - */␊ - playReady?: (StreamingPolicyPlayReadyConfiguration | string)␊ - /**␊ - * Class to specify configurations of Widevine in Streaming Policy␊ - */␊ - widevine?: (StreamingPolicyWidevineConfiguration | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class for EnvelopeEncryption encryption scheme␊ - */␊ - export interface EnvelopeEncryption {␊ - /**␊ - * Representing which tracks should not be encrypted␊ - */␊ - clearTracks?: (TrackSelection[] | string)␊ - /**␊ - * Class to specify properties of all content keys in Streaming Policy␊ - */␊ - contentKeys?: (StreamingPolicyContentKeys | string)␊ - /**␊ - * Template for the URL of the custom service delivering keys to end user players. Not required when using Azure Media Services for issuing keys. The template supports replaceable tokens that the service will update at runtime with the value specific to the request. The currently supported token values are {AlternativeMediaId}, which is replaced with the value of StreamingLocatorId.AlternativeMediaId, and {ContentKeyId}, which is replaced with the value of identifier of the key being requested.␊ - */␊ - customKeyAcquisitionUrlTemplate?: string␊ - /**␊ - * Class to specify which protocols are enabled␊ - */␊ - enabledProtocols?: (EnabledProtocols | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class for NoEncryption scheme␊ - */␊ - export interface NoEncryption {␊ - /**␊ - * Class to specify which protocols are enabled␊ - */␊ - enabledProtocols?: (EnabledProtocols | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Media/mediaServices/streamingLocators␊ - */␊ - export interface MediaServicesStreamingLocatorsChildResource {␊ - apiVersion: "2018-07-01"␊ - /**␊ - * The Streaming Locator name.␊ - */␊ - name: string␊ - /**␊ - * Properties of the Streaming Locator.␊ - */␊ - properties: (StreamingLocatorProperties | string)␊ - type: "streamingLocators"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Streaming Locator.␊ - */␊ - export interface StreamingLocatorProperties {␊ - /**␊ - * Alternative Media ID of this Streaming Locator␊ - */␊ - alternativeMediaId?: string␊ - /**␊ - * Asset Name␊ - */␊ - assetName: string␊ - /**␊ - * The ContentKeys used by this Streaming Locator.␊ - */␊ - contentKeys?: (StreamingLocatorContentKey[] | string)␊ - /**␊ - * Name of the default ContentKeyPolicy used by this Streaming Locator.␊ - */␊ - defaultContentKeyPolicyName?: string␊ - /**␊ - * The end time of the Streaming Locator.␊ - */␊ - endTime?: string␊ - /**␊ - * A list of asset or account filters which apply to this streaming locator␊ - */␊ - filters?: (string[] | string)␊ - /**␊ - * The start time of the Streaming Locator.␊ - */␊ - startTime?: string␊ - /**␊ - * The StreamingLocatorId of the Streaming Locator.␊ - */␊ - streamingLocatorId?: string␊ - /**␊ - * Name of the Streaming Policy used by this Streaming Locator. Either specify the name of Streaming Policy you created or use one of the predefined Streaming Policies. The predefined Streaming Policies available are: 'Predefined_DownloadOnly', 'Predefined_ClearStreamingOnly', 'Predefined_DownloadAndClearStreaming', 'Predefined_ClearKey', 'Predefined_MultiDrmCencStreaming' and 'Predefined_MultiDrmStreaming'␊ - */␊ - streamingPolicyName: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class for content key in Streaming Locator␊ - */␊ - export interface StreamingLocatorContentKey {␊ - /**␊ - * ID of Content Key␊ - */␊ - id: string␊ - /**␊ - * Label of Content Key as specified in the Streaming Policy␊ - */␊ - labelReferenceInStreamingPolicy?: string␊ - /**␊ - * Value of Content Key␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Media/mediaServices/accountFilters␊ - */␊ - export interface MediaServicesAccountFilters {␊ - apiVersion: "2018-07-01"␊ - /**␊ - * The Account Filter name␊ - */␊ - name: string␊ - /**␊ - * The Media Filter properties.␊ - */␊ - properties: (MediaFilterProperties | string)␊ - type: "Microsoft.Media/mediaServices/accountFilters"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Media/mediaServices/assets␊ - */␊ - export interface MediaServicesAssets {␊ - apiVersion: "2018-07-01"␊ - /**␊ - * The Asset name.␊ - */␊ - name: string␊ - /**␊ - * The Asset properties.␊ - */␊ - properties: (AssetProperties | string)␊ - resources?: MediaServicesAssetsAssetFiltersChildResource[]␊ - type: "Microsoft.Media/mediaServices/assets"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Media/mediaServices/assets/assetFilters␊ - */␊ - export interface MediaServicesAssetsAssetFiltersChildResource {␊ - apiVersion: "2018-07-01"␊ - /**␊ - * The Asset Filter name␊ - */␊ - name: string␊ - /**␊ - * The Media Filter properties.␊ - */␊ - properties: (MediaFilterProperties | string)␊ - type: "assetFilters"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Media/mediaServices/assets/assetFilters␊ - */␊ - export interface MediaServicesAssetsAssetFilters {␊ - apiVersion: "2018-07-01"␊ - /**␊ - * The Asset Filter name␊ - */␊ - name: string␊ - /**␊ - * The Media Filter properties.␊ - */␊ - properties: (MediaFilterProperties | string)␊ - type: "Microsoft.Media/mediaServices/assets/assetFilters"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Media/mediaServices/contentKeyPolicies␊ - */␊ - export interface MediaServicesContentKeyPolicies {␊ - apiVersion: "2018-07-01"␊ - /**␊ - * The Content Key Policy name.␊ - */␊ - name: string␊ - /**␊ - * The properties of the Content Key Policy.␊ - */␊ - properties: (ContentKeyPolicyProperties | string)␊ - type: "Microsoft.Media/mediaServices/contentKeyPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Media/mediaServices/streamingLocators␊ - */␊ - export interface MediaServicesStreamingLocators {␊ - apiVersion: "2018-07-01"␊ - /**␊ - * The Streaming Locator name.␊ - */␊ - name: string␊ - /**␊ - * Properties of the Streaming Locator.␊ - */␊ - properties: (StreamingLocatorProperties | string)␊ - type: "Microsoft.Media/mediaServices/streamingLocators"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Media/mediaServices/streamingPolicies␊ - */␊ - export interface MediaServicesStreamingPolicies {␊ - apiVersion: "2018-07-01"␊ - /**␊ - * The Streaming Policy name.␊ - */␊ - name: string␊ - /**␊ - * Class to specify properties of Streaming Policy␊ - */␊ - properties: (StreamingPolicyProperties | string)␊ - type: "Microsoft.Media/mediaServices/streamingPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Media/mediaServices/transforms␊ - */␊ - export interface MediaServicesTransforms {␊ - apiVersion: "2018-07-01"␊ - /**␊ - * The Transform name.␊ - */␊ - name: string␊ - /**␊ - * A Transform.␊ - */␊ - properties: (TransformProperties | string)␊ - resources?: MediaServicesTransformsJobsChildResource[]␊ - type: "Microsoft.Media/mediaServices/transforms"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Media/mediaServices/transforms/jobs␊ - */␊ - export interface MediaServicesTransformsJobsChildResource {␊ - apiVersion: "2018-07-01"␊ - /**␊ - * The Job name.␊ - */␊ - name: string␊ - /**␊ - * Properties of the Job.␊ - */␊ - properties: (JobProperties2 | string)␊ - type: "jobs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Job.␊ - */␊ - export interface JobProperties2 {␊ - /**␊ - * Customer provided key, value pairs that will be returned in Job and JobOutput state events.␊ - */␊ - correlationData?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Optional customer supplied description of the Job.␊ - */␊ - description?: string␊ - /**␊ - * Base class for inputs to a Job.␊ - */␊ - input: (JobInput | string)␊ - /**␊ - * The outputs for the Job.␊ - */␊ - outputs: (JobOutput[] | string)␊ - /**␊ - * Priority with which the job should be processed. Higher priority jobs are processed before lower priority jobs. If not set, the default is normal.␊ - */␊ - priority?: (("Low" | "Normal" | "High") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the clip time as an absolute time position in the media file. The absolute time can point to a different position depending on whether the media file starts from a timestamp of zero or not.␊ - */␊ - export interface AbsoluteClipTime {␊ - "@odata.type": "#Microsoft.Media.AbsoluteClipTime"␊ - /**␊ - * The time position on the timeline of the input media. It is usually specified as an ISO8601 period. e.g PT30S for 30 seconds.␊ - */␊ - time: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents an Asset for input into a Job.␊ - */␊ - export interface JobInputAsset {␊ - "@odata.type": "#Microsoft.Media.JobInputAsset"␊ - /**␊ - * The name of the input Asset.␊ - */␊ - assetName: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents HTTPS job input.␊ - */␊ - export interface JobInputHttp {␊ - "@odata.type": "#Microsoft.Media.JobInputHttp"␊ - /**␊ - * Base URI for HTTPS job input. It will be concatenated with provided file names. If no base uri is given, then the provided file list is assumed to be fully qualified uris. Maximum length of 4000 characters.␊ - */␊ - baseUri?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a list of inputs to a Job.␊ - */␊ - export interface JobInputs {␊ - "@odata.type": "#Microsoft.Media.JobInputs"␊ - /**␊ - * List of inputs to a Job.␊ - */␊ - inputs?: ({␊ - [k: string]: unknown␊ - }[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents an Asset used as a JobOutput.␊ - */␊ - export interface JobOutputAsset {␊ - "@odata.type": "#Microsoft.Media.JobOutputAsset"␊ - /**␊ - * The name of the output Asset.␊ - */␊ - assetName: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Media/mediaServices/transforms/jobs␊ - */␊ - export interface MediaServicesTransformsJobs {␊ - apiVersion: "2018-07-01"␊ - /**␊ - * The Job name.␊ - */␊ - name: string␊ - /**␊ - * Properties of the Job.␊ - */␊ - properties: (JobProperties2 | string)␊ - type: "Microsoft.Media/mediaServices/transforms/jobs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Devices/IotHubs␊ - */␊ - export interface IotHubs {␊ - apiVersion: "2016-02-03"␊ - /**␊ - * The Etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.␊ - */␊ - etag?: string␊ - /**␊ - * The resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the IoT hub to create or update.␊ - */␊ - name: string␊ - /**␊ - * The properties of an IoT hub.␊ - */␊ - properties: (IotHubProperties | string)␊ - /**␊ - * The name of the resource group that contains the IoT hub. A resource group name uniquely identifies the resource group within the subscription.␊ - */␊ - resourcegroup: string␊ - /**␊ - * Information about the SKU of the IoT hub.␊ - */␊ - sku: (IotHubSkuInfo | string)␊ - /**␊ - * The subscription identifier.␊ - */␊ - subscriptionid: string␊ - /**␊ - * The resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Devices/IotHubs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of an IoT hub.␊ - */␊ - export interface IotHubProperties {␊ - /**␊ - * The shared access policies you can use to secure a connection to the IoT hub.␊ - */␊ - authorizationPolicies?: (SharedAccessSignatureAuthorizationRule[] | string)␊ - /**␊ - * The IoT hub cloud-to-device messaging properties.␊ - */␊ - cloudToDevice?: (CloudToDeviceProperties | string)␊ - /**␊ - * Comments.␊ - */␊ - comments?: string␊ - /**␊ - * If True, file upload notifications are enabled.␊ - */␊ - enableFileUploadNotifications?: (boolean | string)␊ - /**␊ - * The Event Hub-compatible endpoint properties. The possible keys to this dictionary are events and operationsMonitoringEvents. Both of these keys have to be present in the dictionary while making create or update calls for the IoT hub.␊ - */␊ - eventHubEndpoints?: ({␊ - [k: string]: EventHubProperties␊ - } | string)␊ - /**␊ - * The capabilities and features enabled for the IoT hub.␊ - */␊ - features?: (("None" | "DeviceManagement") | string)␊ - /**␊ - * The IP filter rules.␊ - */␊ - ipFilterRules?: (IpFilterRule[] | string)␊ - /**␊ - * The messaging endpoint properties for the file upload notification queue.␊ - */␊ - messagingEndpoints?: ({␊ - [k: string]: MessagingEndpointProperties␊ - } | string)␊ - /**␊ - * The operations monitoring properties for the IoT hub. The possible keys to the dictionary are Connections, DeviceTelemetry, C2DCommands, DeviceIdentityOperations, FileUploadOperations.␊ - */␊ - operationsMonitoringProperties?: (OperationsMonitoringProperties | string)␊ - /**␊ - * The list of Azure Storage endpoints where you can upload files. Currently you can configure only one Azure Storage account and that MUST have its key as $default. Specifying more than one storage account causes an error to be thrown. Not specifying a value for this property when the enableFileUploadNotifications property is set to True, causes an error to be thrown.␊ - */␊ - storageEndpoints?: ({␊ - [k: string]: StorageEndpointProperties␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of an IoT hub shared access policy.␊ - */␊ - export interface SharedAccessSignatureAuthorizationRule {␊ - /**␊ - * The name of the shared access policy.␊ - */␊ - keyName: string␊ - /**␊ - * The primary key.␊ - */␊ - primaryKey?: string␊ - /**␊ - * The permissions assigned to the shared access policy.␊ - */␊ - rights: (("RegistryRead" | "RegistryWrite" | "ServiceConnect" | "DeviceConnect" | "RegistryRead, RegistryWrite" | "RegistryRead, ServiceConnect" | "RegistryRead, DeviceConnect" | "RegistryWrite, ServiceConnect" | "RegistryWrite, DeviceConnect" | "ServiceConnect, DeviceConnect" | "RegistryRead, RegistryWrite, ServiceConnect" | "RegistryRead, RegistryWrite, DeviceConnect" | "RegistryRead, ServiceConnect, DeviceConnect" | "RegistryWrite, ServiceConnect, DeviceConnect" | "RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect") | string)␊ - /**␊ - * The secondary key.␊ - */␊ - secondaryKey?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The IoT hub cloud-to-device messaging properties.␊ - */␊ - export interface CloudToDeviceProperties {␊ - /**␊ - * The default time to live for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.␊ - */␊ - defaultTtlAsIso8601?: string␊ - /**␊ - * The properties of the feedback queue for cloud-to-device messages.␊ - */␊ - feedback?: (FeedbackProperties | string)␊ - /**␊ - * The max delivery count for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.␊ - */␊ - maxDeliveryCount?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the feedback queue for cloud-to-device messages.␊ - */␊ - export interface FeedbackProperties {␊ - /**␊ - * The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.␊ - */␊ - lockDurationAsIso8601?: string␊ - /**␊ - * The number of times the IoT hub attempts to deliver a message on the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.␊ - */␊ - maxDeliveryCount?: (number | string)␊ - /**␊ - * The period of time for which a message is available to consume before it is expired by the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.␊ - */␊ - ttlAsIso8601?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the provisioned Event Hub-compatible endpoint used by the IoT hub.␊ - */␊ - export interface EventHubProperties {␊ - /**␊ - * The number of partitions for receiving device-to-cloud messages in the Event Hub-compatible endpoint. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.␊ - */␊ - partitionCount?: (number | string)␊ - /**␊ - * The retention time for device-to-cloud messages in days. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages␊ - */␊ - retentionTimeInDays?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The IP filter rules for the IoT hub.␊ - */␊ - export interface IpFilterRule {␊ - /**␊ - * The desired action for requests captured by this rule.␊ - */␊ - action: (("Accept" | "Reject") | string)␊ - /**␊ - * The name of the IP filter rule.␊ - */␊ - filterName: string␊ - /**␊ - * A string that contains the IP address range in CIDR notation for the rule.␊ - */␊ - ipMask: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the messaging endpoints used by this IoT hub.␊ - */␊ - export interface MessagingEndpointProperties {␊ - /**␊ - * The lock duration. See: https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-file-upload.␊ - */␊ - lockDurationAsIso8601?: string␊ - /**␊ - * The number of times the IoT hub attempts to deliver a message. See: https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-file-upload.␊ - */␊ - maxDeliveryCount?: (number | string)␊ - /**␊ - * The period of time for which a message is available to consume before it is expired by the IoT hub. See: https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-file-upload.␊ - */␊ - ttlAsIso8601?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The operations monitoring properties for the IoT hub. The possible keys to the dictionary are Connections, DeviceTelemetry, C2DCommands, DeviceIdentityOperations, FileUploadOperations.␊ - */␊ - export interface OperationsMonitoringProperties {␊ - events?: ({␊ - [k: string]: ("None" | "Error" | "Information" | "Error, Information")␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the Azure Storage endpoint for file upload.␊ - */␊ - export interface StorageEndpointProperties {␊ - /**␊ - * The connection string for the Azure Storage account to which files are uploaded.␊ - */␊ - connectionString: string␊ - /**␊ - * The name of the root container where you upload files. The container need not exist but should be creatable using the connectionString specified.␊ - */␊ - containerName: string␊ - /**␊ - * The period of time for which the SAS URI generated by IoT Hub for file upload is valid. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.␊ - */␊ - sasTtlAsIso8601?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the SKU of the IoT hub.␊ - */␊ - export interface IotHubSkuInfo {␊ - /**␊ - * The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.␊ - */␊ - capacity: (number | string)␊ - /**␊ - * The name of the SKU.␊ - */␊ - name: (("F1" | "S1" | "S2" | "S3") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Devices/IotHubs␊ - */␊ - export interface IotHubs1 {␊ - apiVersion: "2017-07-01"␊ - /**␊ - * The Etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.␊ - */␊ - etag?: string␊ - /**␊ - * The resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the IoT hub.␊ - */␊ - name: string␊ - /**␊ - * The properties of an IoT hub.␊ - */␊ - properties: (IotHubProperties1 | string)␊ - /**␊ - * The name of the resource group that contains the IoT hub. A resource group name uniquely identifies the resource group within the subscription.␊ - */␊ - resourcegroup: string␊ - resources?: IotHubsCertificatesChildResource[]␊ - /**␊ - * Information about the SKU of the IoT hub.␊ - */␊ - sku: (IotHubSkuInfo1 | string)␊ - /**␊ - * The subscription identifier.␊ - */␊ - subscriptionid: string␊ - /**␊ - * The resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Devices/IotHubs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of an IoT hub.␊ - */␊ - export interface IotHubProperties1 {␊ - /**␊ - * The shared access policies you can use to secure a connection to the IoT hub.␊ - */␊ - authorizationPolicies?: (SharedAccessSignatureAuthorizationRule1[] | string)␊ - /**␊ - * The IoT hub cloud-to-device messaging properties.␊ - */␊ - cloudToDevice?: (CloudToDeviceProperties1 | string)␊ - /**␊ - * IoT hub comments.␊ - */␊ - comments?: string␊ - /**␊ - * If True, file upload notifications are enabled.␊ - */␊ - enableFileUploadNotifications?: (boolean | string)␊ - /**␊ - * The Event Hub-compatible endpoint properties. The possible keys to this dictionary are events and operationsMonitoringEvents. Both of these keys have to be present in the dictionary while making create or update calls for the IoT hub.␊ - */␊ - eventHubEndpoints?: ({␊ - [k: string]: EventHubProperties1␊ - } | string)␊ - /**␊ - * The capabilities and features enabled for the IoT hub.␊ - */␊ - features?: (("None" | "DeviceManagement") | string)␊ - /**␊ - * The IP filter rules.␊ - */␊ - ipFilterRules?: (IpFilterRule1[] | string)␊ - /**␊ - * The messaging endpoint properties for the file upload notification queue.␊ - */␊ - messagingEndpoints?: ({␊ - [k: string]: MessagingEndpointProperties1␊ - } | string)␊ - /**␊ - * The operations monitoring properties for the IoT hub. The possible keys to the dictionary are Connections, DeviceTelemetry, C2DCommands, DeviceIdentityOperations, FileUploadOperations, Routes, D2CTwinOperations, C2DTwinOperations, TwinQueries, JobsOperations, DirectMethods.␊ - */␊ - operationsMonitoringProperties?: (OperationsMonitoringProperties1 | string)␊ - /**␊ - * The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging␊ - */␊ - routing?: (RoutingProperties | string)␊ - /**␊ - * The list of Azure Storage endpoints where you can upload files. Currently you can configure only one Azure Storage account and that MUST have its key as $default. Specifying more than one storage account causes an error to be thrown. Not specifying a value for this property when the enableFileUploadNotifications property is set to True, causes an error to be thrown.␊ - */␊ - storageEndpoints?: ({␊ - [k: string]: StorageEndpointProperties1␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of an IoT hub shared access policy.␊ - */␊ - export interface SharedAccessSignatureAuthorizationRule1 {␊ - /**␊ - * The name of the shared access policy.␊ - */␊ - keyName: string␊ - /**␊ - * The primary key.␊ - */␊ - primaryKey?: string␊ - /**␊ - * The permissions assigned to the shared access policy.␊ - */␊ - rights: (("RegistryRead" | "RegistryWrite" | "ServiceConnect" | "DeviceConnect" | "RegistryRead, RegistryWrite" | "RegistryRead, ServiceConnect" | "RegistryRead, DeviceConnect" | "RegistryWrite, ServiceConnect" | "RegistryWrite, DeviceConnect" | "ServiceConnect, DeviceConnect" | "RegistryRead, RegistryWrite, ServiceConnect" | "RegistryRead, RegistryWrite, DeviceConnect" | "RegistryRead, ServiceConnect, DeviceConnect" | "RegistryWrite, ServiceConnect, DeviceConnect" | "RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect") | string)␊ - /**␊ - * The secondary key.␊ - */␊ - secondaryKey?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The IoT hub cloud-to-device messaging properties.␊ - */␊ - export interface CloudToDeviceProperties1 {␊ - /**␊ - * The default time to live for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.␊ - */␊ - defaultTtlAsIso8601?: string␊ - /**␊ - * The properties of the feedback queue for cloud-to-device messages.␊ - */␊ - feedback?: (FeedbackProperties1 | string)␊ - /**␊ - * The max delivery count for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.␊ - */␊ - maxDeliveryCount?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the feedback queue for cloud-to-device messages.␊ - */␊ - export interface FeedbackProperties1 {␊ - /**␊ - * The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.␊ - */␊ - lockDurationAsIso8601?: string␊ - /**␊ - * The number of times the IoT hub attempts to deliver a message on the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.␊ - */␊ - maxDeliveryCount?: (number | string)␊ - /**␊ - * The period of time for which a message is available to consume before it is expired by the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.␊ - */␊ - ttlAsIso8601?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the provisioned Event Hub-compatible endpoint used by the IoT hub.␊ - */␊ - export interface EventHubProperties1 {␊ - /**␊ - * The number of partitions for receiving device-to-cloud messages in the Event Hub-compatible endpoint. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.␊ - */␊ - partitionCount?: (number | string)␊ - /**␊ - * The retention time for device-to-cloud messages in days. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages␊ - */␊ - retentionTimeInDays?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The IP filter rules for the IoT hub.␊ - */␊ - export interface IpFilterRule1 {␊ - /**␊ - * The desired action for requests captured by this rule.␊ - */␊ - action: (("Accept" | "Reject") | string)␊ - /**␊ - * The name of the IP filter rule.␊ - */␊ - filterName: string␊ - /**␊ - * A string that contains the IP address range in CIDR notation for the rule.␊ - */␊ - ipMask: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the messaging endpoints used by this IoT hub.␊ - */␊ - export interface MessagingEndpointProperties1 {␊ - /**␊ - * The lock duration. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.␊ - */␊ - lockDurationAsIso8601?: string␊ - /**␊ - * The number of times the IoT hub attempts to deliver a message. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.␊ - */␊ - maxDeliveryCount?: (number | string)␊ - /**␊ - * The period of time for which a message is available to consume before it is expired by the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.␊ - */␊ - ttlAsIso8601?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The operations monitoring properties for the IoT hub. The possible keys to the dictionary are Connections, DeviceTelemetry, C2DCommands, DeviceIdentityOperations, FileUploadOperations, Routes, D2CTwinOperations, C2DTwinOperations, TwinQueries, JobsOperations, DirectMethods.␊ - */␊ - export interface OperationsMonitoringProperties1 {␊ - events?: ({␊ - [k: string]: ("None" | "Error" | "Information" | "Error, Information")␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging␊ - */␊ - export interface RoutingProperties {␊ - /**␊ - * The properties related to the custom endpoints to which your IoT hub routes messages based on the routing rules. A maximum of 10 custom endpoints are allowed across all endpoint types for paid hubs and only 1 custom endpoint is allowed across all endpoint types for free hubs.␊ - */␊ - endpoints?: (RoutingEndpoints | string)␊ - /**␊ - * The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint.␊ - */␊ - fallbackRoute?: (FallbackRouteProperties | string)␊ - /**␊ - * The list of user-provided routing rules that the IoT hub uses to route messages to built-in and custom endpoints. A maximum of 100 routing rules are allowed for paid hubs and a maximum of 5 routing rules are allowed for free hubs.␊ - */␊ - routes?: (RouteProperties[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties related to the custom endpoints to which your IoT hub routes messages based on the routing rules. A maximum of 10 custom endpoints are allowed across all endpoint types for paid hubs and only 1 custom endpoint is allowed across all endpoint types for free hubs.␊ - */␊ - export interface RoutingEndpoints {␊ - /**␊ - * The list of Event Hubs endpoints that IoT hub routes messages to, based on the routing rules. This list does not include the built-in Event Hubs endpoint.␊ - */␊ - eventHubs?: (RoutingEventHubProperties[] | string)␊ - /**␊ - * The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing rules.␊ - */␊ - serviceBusQueues?: (RoutingServiceBusQueueEndpointProperties[] | string)␊ - /**␊ - * The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing rules.␊ - */␊ - serviceBusTopics?: (RoutingServiceBusTopicEndpointProperties[] | string)␊ - /**␊ - * The list of storage container endpoints that IoT hub routes messages to, based on the routing rules.␊ - */␊ - storageContainers?: (RoutingStorageContainerProperties[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties related to an event hub endpoint.␊ - */␊ - export interface RoutingEventHubProperties {␊ - /**␊ - * The connection string of the event hub endpoint. ␊ - */␊ - connectionString: string␊ - /**␊ - * The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, operationsMonitoringEvents, fileNotifications, $default. Endpoint names must be unique across endpoint types.␊ - */␊ - name: string␊ - /**␊ - * The name of the resource group of the event hub endpoint.␊ - */␊ - resourceGroup?: string␊ - /**␊ - * The subscription identifier of the event hub endpoint.␊ - */␊ - subscriptionId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties related to service bus queue endpoint types.␊ - */␊ - export interface RoutingServiceBusQueueEndpointProperties {␊ - /**␊ - * The connection string of the service bus queue endpoint.␊ - */␊ - connectionString: string␊ - /**␊ - * The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, operationsMonitoringEvents, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual queue name.␊ - */␊ - name: string␊ - /**␊ - * The name of the resource group of the service bus queue endpoint.␊ - */␊ - resourceGroup?: string␊ - /**␊ - * The subscription identifier of the service bus queue endpoint.␊ - */␊ - subscriptionId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties related to service bus topic endpoint types.␊ - */␊ - export interface RoutingServiceBusTopicEndpointProperties {␊ - /**␊ - * The connection string of the service bus topic endpoint.␊ - */␊ - connectionString: string␊ - /**␊ - * The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, operationsMonitoringEvents, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual topic name.␊ - */␊ - name: string␊ - /**␊ - * The name of the resource group of the service bus topic endpoint.␊ - */␊ - resourceGroup?: string␊ - /**␊ - * The subscription identifier of the service bus topic endpoint.␊ - */␊ - subscriptionId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties related to a storage container endpoint.␊ - */␊ - export interface RoutingStorageContainerProperties {␊ - /**␊ - * Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds.␊ - */␊ - batchFrequencyInSeconds?: (number | string)␊ - /**␊ - * The connection string of the storage account.␊ - */␊ - connectionString: string␊ - /**␊ - * The name of storage container in the storage account.␊ - */␊ - containerName: string␊ - /**␊ - * Encoding that is used to serialize messages to blobs. Supported values are 'avro' and 'avroDeflate'. Default value is 'avro'.␊ - */␊ - encoding?: string␊ - /**␊ - * File name format for the blob. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered.␊ - */␊ - fileNameFormat?: string␊ - /**␊ - * Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB).␊ - */␊ - maxChunkSizeInBytes?: (number | string)␊ - /**␊ - * The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, operationsMonitoringEvents, fileNotifications, $default. Endpoint names must be unique across endpoint types.␊ - */␊ - name: string␊ - /**␊ - * The name of the resource group of the storage account.␊ - */␊ - resourceGroup?: string␊ - /**␊ - * The subscription identifier of the storage account.␊ - */␊ - subscriptionId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint.␊ - */␊ - export interface FallbackRouteProperties {␊ - /**␊ - * The condition which is evaluated in order to apply the fallback route. If the condition is not provided it will evaluate to true by default. For grammar, See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language␊ - */␊ - condition?: string␊ - /**␊ - * The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed.␊ - */␊ - endpointNames: (string[] | string)␊ - /**␊ - * Used to specify whether the fallback route is enabled.␊ - */␊ - isEnabled: (boolean | string)␊ - /**␊ - * The source to which the routing rule is to be applied to. For example, DeviceMessages.␊ - */␊ - source: (("DeviceMessages" | "TwinChangeEvents" | "DeviceLifecycleEvents" | "DeviceJobLifecycleEvents") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a routing rule that your IoT hub uses to route messages to endpoints.␊ - */␊ - export interface RouteProperties {␊ - /**␊ - * The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language␊ - */␊ - condition?: string␊ - /**␊ - * The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.␊ - */␊ - endpointNames: (string[] | string)␊ - /**␊ - * Used to specify whether a route is enabled.␊ - */␊ - isEnabled: (boolean | string)␊ - /**␊ - * The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.␊ - */␊ - name: string␊ - /**␊ - * The source that the routing rule is to be applied to, such as DeviceMessages.␊ - */␊ - source: (("DeviceMessages" | "TwinChangeEvents" | "DeviceLifecycleEvents" | "DeviceJobLifecycleEvents") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the Azure Storage endpoint for file upload.␊ - */␊ - export interface StorageEndpointProperties1 {␊ - /**␊ - * The connection string for the Azure Storage account to which files are uploaded.␊ - */␊ - connectionString: string␊ - /**␊ - * The name of the root container where you upload files. The container need not exist but should be creatable using the connectionString specified.␊ - */␊ - containerName: string␊ - /**␊ - * The period of time for which the SAS URI generated by IoT Hub for file upload is valid. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.␊ - */␊ - sasTtlAsIso8601?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Devices/IotHubs/certificates␊ - */␊ - export interface IotHubsCertificatesChildResource {␊ - apiVersion: "2017-07-01"␊ - /**␊ - * base-64 representation of the X509 leaf certificate .cer file or just .pem file content.␊ - */␊ - certificate?: string␊ - /**␊ - * The name of the certificate␊ - */␊ - name: string␊ - type: "certificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the SKU of the IoT hub.␊ - */␊ - export interface IotHubSkuInfo1 {␊ - /**␊ - * The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.␊ - */␊ - capacity: (number | string)␊ - /**␊ - * The name of the SKU.␊ - */␊ - name: (("F1" | "S1" | "S2" | "S3") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Devices/IotHubs/certificates␊ - */␊ - export interface IotHubsCertificates {␊ - apiVersion: "2017-07-01"␊ - /**␊ - * base-64 representation of the X509 leaf certificate .cer file or just .pem file content.␊ - */␊ - certificate?: string␊ - /**␊ - * The name of the certificate␊ - */␊ - name: string␊ - type: "Microsoft.Devices/IotHubs/certificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Devices/IotHubs␊ - */␊ - export interface IotHubs2 {␊ - apiVersion: "2018-01-22"␊ - /**␊ - * The Etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.␊ - */␊ - etag?: string␊ - /**␊ - * The resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the IoT hub.␊ - */␊ - name: string␊ - /**␊ - * The properties of an IoT hub.␊ - */␊ - properties: (IotHubProperties2 | string)␊ - resources?: IotHubsCertificatesChildResource1[]␊ - /**␊ - * Information about the SKU of the IoT hub.␊ - */␊ - sku: (IotHubSkuInfo2 | string)␊ - /**␊ - * The resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Devices/IotHubs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of an IoT hub.␊ - */␊ - export interface IotHubProperties2 {␊ - /**␊ - * The shared access policies you can use to secure a connection to the IoT hub.␊ - */␊ - authorizationPolicies?: (SharedAccessSignatureAuthorizationRule2[] | string)␊ - /**␊ - * The IoT hub cloud-to-device messaging properties.␊ - */␊ - cloudToDevice?: (CloudToDeviceProperties2 | string)␊ - /**␊ - * IoT hub comments.␊ - */␊ - comments?: string␊ - /**␊ - * If True, file upload notifications are enabled.␊ - */␊ - enableFileUploadNotifications?: (boolean | string)␊ - /**␊ - * The Event Hub-compatible endpoint properties. The possible keys to this dictionary are events and operationsMonitoringEvents. Both of these keys have to be present in the dictionary while making create or update calls for the IoT hub.␊ - */␊ - eventHubEndpoints?: ({␊ - [k: string]: EventHubProperties2␊ - } | string)␊ - /**␊ - * The capabilities and features enabled for the IoT hub.␊ - */␊ - features?: (("None" | "DeviceManagement") | string)␊ - /**␊ - * The IP filter rules.␊ - */␊ - ipFilterRules?: (IpFilterRule2[] | string)␊ - /**␊ - * The messaging endpoint properties for the file upload notification queue.␊ - */␊ - messagingEndpoints?: ({␊ - [k: string]: MessagingEndpointProperties2␊ - } | string)␊ - /**␊ - * The operations monitoring properties for the IoT hub. The possible keys to the dictionary are Connections, DeviceTelemetry, C2DCommands, DeviceIdentityOperations, FileUploadOperations, Routes, D2CTwinOperations, C2DTwinOperations, TwinQueries, JobsOperations, DirectMethods.␊ - */␊ - operationsMonitoringProperties?: (OperationsMonitoringProperties2 | string)␊ - /**␊ - * The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging␊ - */␊ - routing?: (RoutingProperties1 | string)␊ - /**␊ - * The list of Azure Storage endpoints where you can upload files. Currently you can configure only one Azure Storage account and that MUST have its key as $default. Specifying more than one storage account causes an error to be thrown. Not specifying a value for this property when the enableFileUploadNotifications property is set to True, causes an error to be thrown.␊ - */␊ - storageEndpoints?: ({␊ - [k: string]: StorageEndpointProperties2␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of an IoT hub shared access policy.␊ - */␊ - export interface SharedAccessSignatureAuthorizationRule2 {␊ - /**␊ - * The name of the shared access policy.␊ - */␊ - keyName: string␊ - /**␊ - * The primary key.␊ - */␊ - primaryKey?: string␊ - /**␊ - * The permissions assigned to the shared access policy.␊ - */␊ - rights: (("RegistryRead" | "RegistryWrite" | "ServiceConnect" | "DeviceConnect" | "RegistryRead, RegistryWrite" | "RegistryRead, ServiceConnect" | "RegistryRead, DeviceConnect" | "RegistryWrite, ServiceConnect" | "RegistryWrite, DeviceConnect" | "ServiceConnect, DeviceConnect" | "RegistryRead, RegistryWrite, ServiceConnect" | "RegistryRead, RegistryWrite, DeviceConnect" | "RegistryRead, ServiceConnect, DeviceConnect" | "RegistryWrite, ServiceConnect, DeviceConnect" | "RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect") | string)␊ - /**␊ - * The secondary key.␊ - */␊ - secondaryKey?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The IoT hub cloud-to-device messaging properties.␊ - */␊ - export interface CloudToDeviceProperties2 {␊ - /**␊ - * The default time to live for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.␊ - */␊ - defaultTtlAsIso8601?: string␊ - /**␊ - * The properties of the feedback queue for cloud-to-device messages.␊ - */␊ - feedback?: (FeedbackProperties2 | string)␊ - /**␊ - * The max delivery count for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.␊ - */␊ - maxDeliveryCount?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the feedback queue for cloud-to-device messages.␊ - */␊ - export interface FeedbackProperties2 {␊ - /**␊ - * The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.␊ - */␊ - lockDurationAsIso8601?: string␊ - /**␊ - * The number of times the IoT hub attempts to deliver a message on the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.␊ - */␊ - maxDeliveryCount?: (number | string)␊ - /**␊ - * The period of time for which a message is available to consume before it is expired by the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.␊ - */␊ - ttlAsIso8601?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the provisioned Event Hub-compatible endpoint used by the IoT hub.␊ - */␊ - export interface EventHubProperties2 {␊ - /**␊ - * The number of partitions for receiving device-to-cloud messages in the Event Hub-compatible endpoint. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.␊ - */␊ - partitionCount?: (number | string)␊ - /**␊ - * The retention time for device-to-cloud messages in days. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages␊ - */␊ - retentionTimeInDays?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The IP filter rules for the IoT hub.␊ - */␊ - export interface IpFilterRule2 {␊ - /**␊ - * The desired action for requests captured by this rule.␊ - */␊ - action: (("Accept" | "Reject") | string)␊ - /**␊ - * The name of the IP filter rule.␊ - */␊ - filterName: string␊ - /**␊ - * A string that contains the IP address range in CIDR notation for the rule.␊ - */␊ - ipMask: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the messaging endpoints used by this IoT hub.␊ - */␊ - export interface MessagingEndpointProperties2 {␊ - /**␊ - * The lock duration. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.␊ - */␊ - lockDurationAsIso8601?: string␊ - /**␊ - * The number of times the IoT hub attempts to deliver a message. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.␊ - */␊ - maxDeliveryCount?: (number | string)␊ - /**␊ - * The period of time for which a message is available to consume before it is expired by the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.␊ - */␊ - ttlAsIso8601?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The operations monitoring properties for the IoT hub. The possible keys to the dictionary are Connections, DeviceTelemetry, C2DCommands, DeviceIdentityOperations, FileUploadOperations, Routes, D2CTwinOperations, C2DTwinOperations, TwinQueries, JobsOperations, DirectMethods.␊ - */␊ - export interface OperationsMonitoringProperties2 {␊ - events?: ({␊ - [k: string]: ("None" | "Error" | "Information" | "Error, Information")␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging␊ - */␊ - export interface RoutingProperties1 {␊ - /**␊ - * The properties related to the custom endpoints to which your IoT hub routes messages based on the routing rules. A maximum of 10 custom endpoints are allowed across all endpoint types for paid hubs and only 1 custom endpoint is allowed across all endpoint types for free hubs.␊ - */␊ - endpoints?: (RoutingEndpoints1 | string)␊ - /**␊ - * The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint.␊ - */␊ - fallbackRoute?: (FallbackRouteProperties1 | string)␊ - /**␊ - * The list of user-provided routing rules that the IoT hub uses to route messages to built-in and custom endpoints. A maximum of 100 routing rules are allowed for paid hubs and a maximum of 5 routing rules are allowed for free hubs.␊ - */␊ - routes?: (RouteProperties1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties related to the custom endpoints to which your IoT hub routes messages based on the routing rules. A maximum of 10 custom endpoints are allowed across all endpoint types for paid hubs and only 1 custom endpoint is allowed across all endpoint types for free hubs.␊ - */␊ - export interface RoutingEndpoints1 {␊ - /**␊ - * The list of Event Hubs endpoints that IoT hub routes messages to, based on the routing rules. This list does not include the built-in Event Hubs endpoint.␊ - */␊ - eventHubs?: (RoutingEventHubProperties1[] | string)␊ - /**␊ - * The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing rules.␊ - */␊ - serviceBusQueues?: (RoutingServiceBusQueueEndpointProperties1[] | string)␊ - /**␊ - * The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing rules.␊ - */␊ - serviceBusTopics?: (RoutingServiceBusTopicEndpointProperties1[] | string)␊ - /**␊ - * The list of storage container endpoints that IoT hub routes messages to, based on the routing rules.␊ - */␊ - storageContainers?: (RoutingStorageContainerProperties1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties related to an event hub endpoint.␊ - */␊ - export interface RoutingEventHubProperties1 {␊ - /**␊ - * The connection string of the event hub endpoint. ␊ - */␊ - connectionString: string␊ - /**␊ - * The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, operationsMonitoringEvents, fileNotifications, $default. Endpoint names must be unique across endpoint types.␊ - */␊ - name: string␊ - /**␊ - * The name of the resource group of the event hub endpoint.␊ - */␊ - resourceGroup?: string␊ - /**␊ - * The subscription identifier of the event hub endpoint.␊ - */␊ - subscriptionId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties related to service bus queue endpoint types.␊ - */␊ - export interface RoutingServiceBusQueueEndpointProperties1 {␊ - /**␊ - * The connection string of the service bus queue endpoint.␊ - */␊ - connectionString: string␊ - /**␊ - * The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, operationsMonitoringEvents, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual queue name.␊ - */␊ - name: string␊ - /**␊ - * The name of the resource group of the service bus queue endpoint.␊ - */␊ - resourceGroup?: string␊ - /**␊ - * The subscription identifier of the service bus queue endpoint.␊ - */␊ - subscriptionId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties related to service bus topic endpoint types.␊ - */␊ - export interface RoutingServiceBusTopicEndpointProperties1 {␊ - /**␊ - * The connection string of the service bus topic endpoint.␊ - */␊ - connectionString: string␊ - /**␊ - * The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, operationsMonitoringEvents, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual topic name.␊ - */␊ - name: string␊ - /**␊ - * The name of the resource group of the service bus topic endpoint.␊ - */␊ - resourceGroup?: string␊ - /**␊ - * The subscription identifier of the service bus topic endpoint.␊ - */␊ - subscriptionId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties related to a storage container endpoint.␊ - */␊ - export interface RoutingStorageContainerProperties1 {␊ - /**␊ - * Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds.␊ - */␊ - batchFrequencyInSeconds?: (number | string)␊ - /**␊ - * The connection string of the storage account.␊ - */␊ - connectionString: string␊ - /**␊ - * The name of storage container in the storage account.␊ - */␊ - containerName: string␊ - /**␊ - * Encoding that is used to serialize messages to blobs. Supported values are 'avro' and 'avroDeflate'. Default value is 'avro'.␊ - */␊ - encoding?: string␊ - /**␊ - * File name format for the blob. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered.␊ - */␊ - fileNameFormat?: string␊ - /**␊ - * Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB).␊ - */␊ - maxChunkSizeInBytes?: (number | string)␊ - /**␊ - * The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, operationsMonitoringEvents, fileNotifications, $default. Endpoint names must be unique across endpoint types.␊ - */␊ - name: string␊ - /**␊ - * The name of the resource group of the storage account.␊ - */␊ - resourceGroup?: string␊ - /**␊ - * The subscription identifier of the storage account.␊ - */␊ - subscriptionId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint.␊ - */␊ - export interface FallbackRouteProperties1 {␊ - /**␊ - * The condition which is evaluated in order to apply the fallback route. If the condition is not provided it will evaluate to true by default. For grammar, See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language␊ - */␊ - condition?: string␊ - /**␊ - * The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed.␊ - */␊ - endpointNames: (string[] | string)␊ - /**␊ - * Used to specify whether the fallback route is enabled.␊ - */␊ - isEnabled: (boolean | string)␊ - /**␊ - * The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.␊ - */␊ - name?: string␊ - /**␊ - * The source to which the routing rule is to be applied to. For example, DeviceMessages.␊ - */␊ - source: (("DeviceMessages" | "TwinChangeEvents" | "DeviceLifecycleEvents" | "DeviceJobLifecycleEvents") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a routing rule that your IoT hub uses to route messages to endpoints.␊ - */␊ - export interface RouteProperties1 {␊ - /**␊ - * The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language␊ - */␊ - condition?: string␊ - /**␊ - * The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.␊ - */␊ - endpointNames: (string[] | string)␊ - /**␊ - * Used to specify whether a route is enabled.␊ - */␊ - isEnabled: (boolean | string)␊ - /**␊ - * The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.␊ - */␊ - name: string␊ - /**␊ - * The source that the routing rule is to be applied to, such as DeviceMessages.␊ - */␊ - source: (("DeviceMessages" | "TwinChangeEvents" | "DeviceLifecycleEvents" | "DeviceJobLifecycleEvents") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the Azure Storage endpoint for file upload.␊ - */␊ - export interface StorageEndpointProperties2 {␊ - /**␊ - * The connection string for the Azure Storage account to which files are uploaded.␊ - */␊ - connectionString: string␊ - /**␊ - * The name of the root container where you upload files. The container need not exist but should be creatable using the connectionString specified.␊ - */␊ - containerName: string␊ - /**␊ - * The period of time for which the SAS URI generated by IoT Hub for file upload is valid. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.␊ - */␊ - sasTtlAsIso8601?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Devices/IotHubs/certificates␊ - */␊ - export interface IotHubsCertificatesChildResource1 {␊ - apiVersion: "2018-01-22"␊ - /**␊ - * base-64 representation of the X509 leaf certificate .cer file or just .pem file content.␊ - */␊ - certificate?: string␊ - /**␊ - * The name of the certificate␊ - */␊ - name: string␊ - type: "certificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the SKU of the IoT hub.␊ - */␊ - export interface IotHubSkuInfo2 {␊ - /**␊ - * The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.␊ - */␊ - capacity?: (number | string)␊ - /**␊ - * The name of the SKU.␊ - */␊ - name: (("F1" | "S1" | "S2" | "S3") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Devices/IotHubs/certificates␊ - */␊ - export interface IotHubsCertificates1 {␊ - apiVersion: "2018-01-22"␊ - /**␊ - * base-64 representation of the X509 leaf certificate .cer file or just .pem file content.␊ - */␊ - certificate?: string␊ - /**␊ - * The name of the certificate␊ - */␊ - name: string␊ - type: "Microsoft.Devices/IotHubs/certificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Devices/IotHubs␊ - */␊ - export interface IotHubs3 {␊ - apiVersion: "2018-04-01"␊ - /**␊ - * The Etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.␊ - */␊ - etag?: string␊ - /**␊ - * The resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the IoT hub.␊ - */␊ - name: string␊ - /**␊ - * The properties of an IoT hub.␊ - */␊ - properties: (IotHubProperties3 | string)␊ - resources?: IotHubsCertificatesChildResource2[]␊ - /**␊ - * Information about the SKU of the IoT hub.␊ - */␊ - sku: (IotHubSkuInfo3 | string)␊ - /**␊ - * The resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Devices/IotHubs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of an IoT hub.␊ - */␊ - export interface IotHubProperties3 {␊ - /**␊ - * The shared access policies you can use to secure a connection to the IoT hub.␊ - */␊ - authorizationPolicies?: (SharedAccessSignatureAuthorizationRule3[] | string)␊ - /**␊ - * The IoT hub cloud-to-device messaging properties.␊ - */␊ - cloudToDevice?: (CloudToDeviceProperties3 | string)␊ - /**␊ - * IoT hub comments.␊ - */␊ - comments?: string␊ - /**␊ - * If True, file upload notifications are enabled.␊ - */␊ - enableFileUploadNotifications?: (boolean | string)␊ - /**␊ - * The Event Hub-compatible endpoint properties. The possible keys to this dictionary are events and operationsMonitoringEvents. Both of these keys have to be present in the dictionary while making create or update calls for the IoT hub.␊ - */␊ - eventHubEndpoints?: ({␊ - [k: string]: EventHubProperties3␊ - } | string)␊ - /**␊ - * The capabilities and features enabled for the IoT hub.␊ - */␊ - features?: (("None" | "DeviceManagement") | string)␊ - /**␊ - * The IP filter rules.␊ - */␊ - ipFilterRules?: (IpFilterRule3[] | string)␊ - /**␊ - * The messaging endpoint properties for the file upload notification queue.␊ - */␊ - messagingEndpoints?: ({␊ - [k: string]: MessagingEndpointProperties3␊ - } | string)␊ - /**␊ - * The operations monitoring properties for the IoT hub. The possible keys to the dictionary are Connections, DeviceTelemetry, C2DCommands, DeviceIdentityOperations, FileUploadOperations, Routes, D2CTwinOperations, C2DTwinOperations, TwinQueries, JobsOperations, DirectMethods.␊ - */␊ - operationsMonitoringProperties?: (OperationsMonitoringProperties3 | string)␊ - /**␊ - * The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging␊ - */␊ - routing?: (RoutingProperties2 | string)␊ - /**␊ - * The list of Azure Storage endpoints where you can upload files. Currently you can configure only one Azure Storage account and that MUST have its key as $default. Specifying more than one storage account causes an error to be thrown. Not specifying a value for this property when the enableFileUploadNotifications property is set to True, causes an error to be thrown.␊ - */␊ - storageEndpoints?: ({␊ - [k: string]: StorageEndpointProperties3␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of an IoT hub shared access policy.␊ - */␊ - export interface SharedAccessSignatureAuthorizationRule3 {␊ - /**␊ - * The name of the shared access policy.␊ - */␊ - keyName: string␊ - /**␊ - * The primary key.␊ - */␊ - primaryKey?: string␊ - /**␊ - * The permissions assigned to the shared access policy.␊ - */␊ - rights: (("RegistryRead" | "RegistryWrite" | "ServiceConnect" | "DeviceConnect" | "RegistryRead, RegistryWrite" | "RegistryRead, ServiceConnect" | "RegistryRead, DeviceConnect" | "RegistryWrite, ServiceConnect" | "RegistryWrite, DeviceConnect" | "ServiceConnect, DeviceConnect" | "RegistryRead, RegistryWrite, ServiceConnect" | "RegistryRead, RegistryWrite, DeviceConnect" | "RegistryRead, ServiceConnect, DeviceConnect" | "RegistryWrite, ServiceConnect, DeviceConnect" | "RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect") | string)␊ - /**␊ - * The secondary key.␊ - */␊ - secondaryKey?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The IoT hub cloud-to-device messaging properties.␊ - */␊ - export interface CloudToDeviceProperties3 {␊ - /**␊ - * The default time to live for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.␊ - */␊ - defaultTtlAsIso8601?: string␊ - /**␊ - * The properties of the feedback queue for cloud-to-device messages.␊ - */␊ - feedback?: (FeedbackProperties3 | string)␊ - /**␊ - * The max delivery count for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.␊ - */␊ - maxDeliveryCount?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the feedback queue for cloud-to-device messages.␊ - */␊ - export interface FeedbackProperties3 {␊ - /**␊ - * The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.␊ - */␊ - lockDurationAsIso8601?: string␊ - /**␊ - * The number of times the IoT hub attempts to deliver a message on the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.␊ - */␊ - maxDeliveryCount?: (number | string)␊ - /**␊ - * The period of time for which a message is available to consume before it is expired by the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.␊ - */␊ - ttlAsIso8601?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the provisioned Event Hub-compatible endpoint used by the IoT hub.␊ - */␊ - export interface EventHubProperties3 {␊ - /**␊ - * The number of partitions for receiving device-to-cloud messages in the Event Hub-compatible endpoint. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.␊ - */␊ - partitionCount?: (number | string)␊ - /**␊ - * The retention time for device-to-cloud messages in days. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages␊ - */␊ - retentionTimeInDays?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The IP filter rules for the IoT hub.␊ - */␊ - export interface IpFilterRule3 {␊ - /**␊ - * The desired action for requests captured by this rule.␊ - */␊ - action: (("Accept" | "Reject") | string)␊ - /**␊ - * The name of the IP filter rule.␊ - */␊ - filterName: string␊ - /**␊ - * A string that contains the IP address range in CIDR notation for the rule.␊ - */␊ - ipMask: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the messaging endpoints used by this IoT hub.␊ - */␊ - export interface MessagingEndpointProperties3 {␊ - /**␊ - * The lock duration. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.␊ - */␊ - lockDurationAsIso8601?: string␊ - /**␊ - * The number of times the IoT hub attempts to deliver a message. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.␊ - */␊ - maxDeliveryCount?: (number | string)␊ - /**␊ - * The period of time for which a message is available to consume before it is expired by the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.␊ - */␊ - ttlAsIso8601?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The operations monitoring properties for the IoT hub. The possible keys to the dictionary are Connections, DeviceTelemetry, C2DCommands, DeviceIdentityOperations, FileUploadOperations, Routes, D2CTwinOperations, C2DTwinOperations, TwinQueries, JobsOperations, DirectMethods.␊ - */␊ - export interface OperationsMonitoringProperties3 {␊ - events?: ({␊ - [k: string]: ("None" | "Error" | "Information" | "Error, Information")␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging␊ - */␊ - export interface RoutingProperties2 {␊ - /**␊ - * The properties related to the custom endpoints to which your IoT hub routes messages based on the routing rules. A maximum of 10 custom endpoints are allowed across all endpoint types for paid hubs and only 1 custom endpoint is allowed across all endpoint types for free hubs.␊ - */␊ - endpoints?: (RoutingEndpoints2 | string)␊ - /**␊ - * The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint.␊ - */␊ - fallbackRoute?: (FallbackRouteProperties2 | string)␊ - /**␊ - * The list of user-provided routing rules that the IoT hub uses to route messages to built-in and custom endpoints. A maximum of 100 routing rules are allowed for paid hubs and a maximum of 5 routing rules are allowed for free hubs.␊ - */␊ - routes?: (RouteProperties2[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties related to the custom endpoints to which your IoT hub routes messages based on the routing rules. A maximum of 10 custom endpoints are allowed across all endpoint types for paid hubs and only 1 custom endpoint is allowed across all endpoint types for free hubs.␊ - */␊ - export interface RoutingEndpoints2 {␊ - /**␊ - * The list of Event Hubs endpoints that IoT hub routes messages to, based on the routing rules. This list does not include the built-in Event Hubs endpoint.␊ - */␊ - eventHubs?: (RoutingEventHubProperties2[] | string)␊ - /**␊ - * The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing rules.␊ - */␊ - serviceBusQueues?: (RoutingServiceBusQueueEndpointProperties2[] | string)␊ - /**␊ - * The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing rules.␊ - */␊ - serviceBusTopics?: (RoutingServiceBusTopicEndpointProperties2[] | string)␊ - /**␊ - * The list of storage container endpoints that IoT hub routes messages to, based on the routing rules.␊ - */␊ - storageContainers?: (RoutingStorageContainerProperties2[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties related to an event hub endpoint.␊ - */␊ - export interface RoutingEventHubProperties2 {␊ - /**␊ - * The connection string of the event hub endpoint. ␊ - */␊ - connectionString: string␊ - /**␊ - * The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, operationsMonitoringEvents, fileNotifications, $default. Endpoint names must be unique across endpoint types.␊ - */␊ - name: string␊ - /**␊ - * The name of the resource group of the event hub endpoint.␊ - */␊ - resourceGroup?: string␊ - /**␊ - * The subscription identifier of the event hub endpoint.␊ - */␊ - subscriptionId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties related to service bus queue endpoint types.␊ - */␊ - export interface RoutingServiceBusQueueEndpointProperties2 {␊ - /**␊ - * The connection string of the service bus queue endpoint.␊ - */␊ - connectionString: string␊ - /**␊ - * The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, operationsMonitoringEvents, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual queue name.␊ - */␊ - name: string␊ - /**␊ - * The name of the resource group of the service bus queue endpoint.␊ - */␊ - resourceGroup?: string␊ - /**␊ - * The subscription identifier of the service bus queue endpoint.␊ - */␊ - subscriptionId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties related to service bus topic endpoint types.␊ - */␊ - export interface RoutingServiceBusTopicEndpointProperties2 {␊ - /**␊ - * The connection string of the service bus topic endpoint.␊ - */␊ - connectionString: string␊ - /**␊ - * The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, operationsMonitoringEvents, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual topic name.␊ - */␊ - name: string␊ - /**␊ - * The name of the resource group of the service bus topic endpoint.␊ - */␊ - resourceGroup?: string␊ - /**␊ - * The subscription identifier of the service bus topic endpoint.␊ - */␊ - subscriptionId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties related to a storage container endpoint.␊ - */␊ - export interface RoutingStorageContainerProperties2 {␊ - /**␊ - * Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds.␊ - */␊ - batchFrequencyInSeconds?: (number | string)␊ - /**␊ - * The connection string of the storage account.␊ - */␊ - connectionString: string␊ - /**␊ - * The name of storage container in the storage account.␊ - */␊ - containerName: string␊ - /**␊ - * Encoding that is used to serialize messages to blobs. Supported values are 'avro' and 'avroDeflate'. Default value is 'avro'.␊ - */␊ - encoding?: string␊ - /**␊ - * File name format for the blob. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered.␊ - */␊ - fileNameFormat?: string␊ - /**␊ - * Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB).␊ - */␊ - maxChunkSizeInBytes?: (number | string)␊ - /**␊ - * The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, operationsMonitoringEvents, fileNotifications, $default. Endpoint names must be unique across endpoint types.␊ - */␊ - name: string␊ - /**␊ - * The name of the resource group of the storage account.␊ - */␊ - resourceGroup?: string␊ - /**␊ - * The subscription identifier of the storage account.␊ - */␊ - subscriptionId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint.␊ - */␊ - export interface FallbackRouteProperties2 {␊ - /**␊ - * The condition which is evaluated in order to apply the fallback route. If the condition is not provided it will evaluate to true by default. For grammar, See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language␊ - */␊ - condition?: string␊ - /**␊ - * The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed.␊ - */␊ - endpointNames: (string[] | string)␊ - /**␊ - * Used to specify whether the fallback route is enabled.␊ - */␊ - isEnabled: (boolean | string)␊ - /**␊ - * The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.␊ - */␊ - name?: string␊ - /**␊ - * The source to which the routing rule is to be applied to. For example, DeviceMessages.␊ - */␊ - source: (("Invalid" | "DeviceMessages" | "TwinChangeEvents" | "DeviceLifecycleEvents" | "DeviceJobLifecycleEvents") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a routing rule that your IoT hub uses to route messages to endpoints.␊ - */␊ - export interface RouteProperties2 {␊ - /**␊ - * The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language␊ - */␊ - condition?: string␊ - /**␊ - * The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.␊ - */␊ - endpointNames: (string[] | string)␊ - /**␊ - * Used to specify whether a route is enabled.␊ - */␊ - isEnabled: (boolean | string)␊ - /**␊ - * The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.␊ - */␊ - name: string␊ - /**␊ - * The source that the routing rule is to be applied to, such as DeviceMessages.␊ - */␊ - source: (("Invalid" | "DeviceMessages" | "TwinChangeEvents" | "DeviceLifecycleEvents" | "DeviceJobLifecycleEvents") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the Azure Storage endpoint for file upload.␊ - */␊ - export interface StorageEndpointProperties3 {␊ - /**␊ - * The connection string for the Azure Storage account to which files are uploaded.␊ - */␊ - connectionString: string␊ - /**␊ - * The name of the root container where you upload files. The container need not exist but should be creatable using the connectionString specified.␊ - */␊ - containerName: string␊ - /**␊ - * The period of time for which the SAS URI generated by IoT Hub for file upload is valid. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.␊ - */␊ - sasTtlAsIso8601?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Devices/IotHubs/certificates␊ - */␊ - export interface IotHubsCertificatesChildResource2 {␊ - apiVersion: "2018-04-01"␊ - /**␊ - * base-64 representation of the X509 leaf certificate .cer file or just .pem file content.␊ - */␊ - certificate?: string␊ - /**␊ - * The name of the certificate␊ - */␊ - name: string␊ - type: "certificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the SKU of the IoT hub.␊ - */␊ - export interface IotHubSkuInfo3 {␊ - /**␊ - * The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.␊ - */␊ - capacity?: (number | string)␊ - /**␊ - * The name of the SKU.␊ - */␊ - name: (("F1" | "S1" | "S2" | "S3" | "B1" | "B2" | "B3") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Devices/IotHubs/certificates␊ - */␊ - export interface IotHubsCertificates2 {␊ - apiVersion: "2018-04-01"␊ - /**␊ - * base-64 representation of the X509 leaf certificate .cer file or just .pem file content.␊ - */␊ - certificate?: string␊ - /**␊ - * The name of the certificate␊ - */␊ - name: string␊ - type: "Microsoft.Devices/IotHubs/certificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups␊ - */␊ - export interface IotHubsEventHubEndpoints_ConsumerGroups {␊ - apiVersion: "2018-01-22"␊ - /**␊ - * The name of the consumer group to add.␊ - */␊ - name: string␊ - type: "Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups␊ - */␊ - export interface IotHubsEventHubEndpoints_ConsumerGroups1 {␊ - apiVersion: "2018-04-01"␊ - /**␊ - * The name of the consumer group to add.␊ - */␊ - name: string␊ - type: "Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Devices/provisioningServices␊ - */␊ - export interface ProvisioningServices {␊ - apiVersion: "2017-08-21-preview"␊ - /**␊ - * The Etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.␊ - */␊ - etag?: string␊ - /**␊ - * The resource location.␊ - */␊ - location: string␊ - /**␊ - * Name of provisioning service to create or update.␊ - */␊ - name: string␊ - properties: (IotDpsPropertiesDescription | string)␊ - resources?: ProvisioningServicesCertificatesChildResource[]␊ - /**␊ - * List of possible provisioning service SKUs.␊ - */␊ - sku: (IotDpsSkuInfo | string)␊ - /**␊ - * The resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Devices/provisioningServices"␊ - [k: string]: unknown␊ - }␊ - export interface IotDpsPropertiesDescription {␊ - /**␊ - * Allocation policy to be used by this provisioning service.␊ - */␊ - allocationPolicy?: (("Hashed" | "GeoLatency" | "Static") | string)␊ - authorizationPolicies?: (SharedAccessSignatureAuthorizationRuleAccessRightsDescription[] | string)␊ - /**␊ - * List of IoT hubs associated with this provisioning service.␊ - */␊ - iotHubs?: (IotHubDefinitionDescription[] | string)␊ - /**␊ - * The ARM provisioning state of the provisioning service.␊ - */␊ - provisioningState?: string␊ - /**␊ - * Current state of the provisioning service.␊ - */␊ - state?: (("Activating" | "Active" | "Deleting" | "Deleted" | "ActivationFailed" | "DeletionFailed" | "Transitioning" | "Suspending" | "Suspended" | "Resuming" | "FailingOver" | "FailoverFailed") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of the shared access key.␊ - */␊ - export interface SharedAccessSignatureAuthorizationRuleAccessRightsDescription {␊ - /**␊ - * Name of the key.␊ - */␊ - keyName: string␊ - /**␊ - * Primary SAS key value.␊ - */␊ - primaryKey?: string␊ - /**␊ - * Rights that this key has.␊ - */␊ - rights: (("ServiceConfig" | "EnrollmentRead" | "EnrollmentWrite" | "DeviceConnect" | "RegistrationStatusRead" | "RegistrationStatusWrite") | string)␊ - /**␊ - * Secondary SAS key value.␊ - */␊ - secondaryKey?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of the IoT hub.␊ - */␊ - export interface IotHubDefinitionDescription {␊ - allocationWeight?: (number | string)␊ - applyAllocationPolicy?: (boolean | string)␊ - /**␊ - * Connection string og the IoT hub.␊ - */␊ - connectionString: string␊ - /**␊ - * ARM region of the IoT hub.␊ - */␊ - location: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Devices/provisioningServices/certificates␊ - */␊ - export interface ProvisioningServicesCertificatesChildResource {␊ - apiVersion: "2017-08-21-preview"␊ - /**␊ - * Base-64 representation of the X509 leaf certificate .cer file or just .pem file content.␊ - */␊ - certificate?: string␊ - /**␊ - * The name of the certificate create or update.␊ - */␊ - name: string␊ - type: "certificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * List of possible provisioning service SKUs.␊ - */␊ - export interface IotDpsSkuInfo {␊ - /**␊ - * The number of services of the selected tier allowed in the subscription.␊ - */␊ - capacity?: (number | string)␊ - name?: ("S1" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Devices/provisioningServices␊ - */␊ - export interface ProvisioningServices1 {␊ - apiVersion: "2017-11-15"␊ - /**␊ - * The Etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.␊ - */␊ - etag?: string␊ - /**␊ - * The resource location.␊ - */␊ - location: string␊ - /**␊ - * Name of provisioning service to create or update.␊ - */␊ - name: string␊ - /**␊ - * the service specific properties of a provisioning service, including keys, linked iot hubs, current state, and system generated properties such as hostname and idScope␊ - */␊ - properties: (IotDpsPropertiesDescription1 | string)␊ - resources?: ProvisioningServicesCertificatesChildResource1[]␊ - /**␊ - * List of possible provisioning service SKUs.␊ - */␊ - sku: (IotDpsSkuInfo1 | string)␊ - /**␊ - * The resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Devices/provisioningServices"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * the service specific properties of a provisioning service, including keys, linked iot hubs, current state, and system generated properties such as hostname and idScope␊ - */␊ - export interface IotDpsPropertiesDescription1 {␊ - /**␊ - * Allocation policy to be used by this provisioning service.␊ - */␊ - allocationPolicy?: (("Hashed" | "GeoLatency" | "Static") | string)␊ - /**␊ - * List of authorization keys for a provisioning service.␊ - */␊ - authorizationPolicies?: (SharedAccessSignatureAuthorizationRuleAccessRightsDescription1[] | string)␊ - /**␊ - * List of IoT hubs associated with this provisioning service.␊ - */␊ - iotHubs?: (IotHubDefinitionDescription1[] | string)␊ - /**␊ - * The ARM provisioning state of the provisioning service.␊ - */␊ - provisioningState?: string␊ - /**␊ - * Current state of the provisioning service.␊ - */␊ - state?: (("Activating" | "Active" | "Deleting" | "Deleted" | "ActivationFailed" | "DeletionFailed" | "Transitioning" | "Suspending" | "Suspended" | "Resuming" | "FailingOver" | "FailoverFailed") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of the shared access key.␊ - */␊ - export interface SharedAccessSignatureAuthorizationRuleAccessRightsDescription1 {␊ - /**␊ - * Name of the key.␊ - */␊ - keyName: string␊ - /**␊ - * Primary SAS key value.␊ - */␊ - primaryKey?: string␊ - /**␊ - * Rights that this key has.␊ - */␊ - rights: (("ServiceConfig" | "EnrollmentRead" | "EnrollmentWrite" | "DeviceConnect" | "RegistrationStatusRead" | "RegistrationStatusWrite") | string)␊ - /**␊ - * Secondary SAS key value.␊ - */␊ - secondaryKey?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of the IoT hub.␊ - */␊ - export interface IotHubDefinitionDescription1 {␊ - /**␊ - * Weight to apply for a given IoT hub.␊ - */␊ - allocationWeight?: (number | string)␊ - /**␊ - * Flag for applying allocationPolicy or not for a given IoT hub.␊ - */␊ - applyAllocationPolicy?: (boolean | string)␊ - /**␊ - * Connection string of the IoT hub.␊ - */␊ - connectionString: string␊ - /**␊ - * ARM region of the IoT hub.␊ - */␊ - location: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Devices/provisioningServices/certificates␊ - */␊ - export interface ProvisioningServicesCertificatesChildResource1 {␊ - apiVersion: "2017-11-15"␊ - /**␊ - * Base-64 representation of the X509 leaf certificate .cer file or just .pem file content.␊ - */␊ - certificate?: string␊ - /**␊ - * The name of the certificate create or update.␊ - */␊ - name: string␊ - type: "certificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * List of possible provisioning service SKUs.␊ - */␊ - export interface IotDpsSkuInfo1 {␊ - /**␊ - * The number of units to provision␊ - */␊ - capacity?: (number | string)␊ - /**␊ - * Sku name.␊ - */␊ - name?: ("S1" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Devices/provisioningServices/certificates␊ - */␊ - export interface ProvisioningServicesCertificates {␊ - apiVersion: "2017-11-15"␊ - /**␊ - * Base-64 representation of the X509 leaf certificate .cer file or just .pem file content.␊ - */␊ - certificate?: string␊ - /**␊ - * The name of the certificate create or update.␊ - */␊ - name: string␊ - type: "Microsoft.Devices/provisioningServices/certificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceFabric/clusters: ServiceFabric cluster resource.␊ - */␊ - export interface Clusters9 {␊ - type: "Microsoft.ServiceFabric/clusters"␊ - apiVersion: "2016-03-01"␊ - /**␊ - * Gets or sets the cluster properties.␊ - */␊ - properties: (ClusterProperties8 | string)␊ - [k: string]: unknown␊ - }␊ - export interface ClusterProperties8 {␊ - /**␊ - * Microsoft.ServiceFabric/clusters: The name of VM image VMSS has been configured with. Generic names such as Windows or Linux can be used.␊ - */␊ - vmImage?: string␊ - /**␊ - * Microsoft.ServiceFabric/clusters: The server certificate used by reverse proxy.␊ - */␊ - httpApplicationGatewayCertificate?: (CertificateDescription | string)␊ - /**␊ - * Microsoft.ServiceFabric/clusters: The settings to enable AAD authentication on the cluster.␊ - */␊ - azureActiveDirectory?: (AzureActiveDirectory | string)␊ - /**␊ - * Microsoft.ServiceFabric/clusters: This level is used to set the number of replicas of the system services. Details: http://azure.microsoft.com/en-us/documentation/articles/service-fabric-cluster-capacity/#the-reliability-characteristics-of-the-cluster␊ - */␊ - reliabilityLevel?: (("Bronze" | "Silver" | "Gold" | "Platinum") | string)␊ - /**␊ - * Microsoft.ServiceFabric/clusters: The node types of the cluster. Details: http://azure.microsoft.com/en-us/documentation/articles/service-fabric-cluster-capacity␊ - */␊ - nodeTypes: ([NodeTypes, ...(NodeTypes)[]] | string)␊ - /**␊ - * Microsoft.ServiceFabric/clusters: The http management endpoint of the cluster.␊ - */␊ - managementEndpoint: string␊ - /**␊ - * Microsoft.ServiceFabric/clusters: The certificate to use for node to node communication within cluster, the server certificate of the cluster and the default admin client.␊ - */␊ - certificate?: (CertificateDescription | string)␊ - /**␊ - * Microsoft.ServiceFabric/clusters: List of client certificates to whitelist based on thumbprints.␊ - */␊ - clientCertificateThumbprints?: (ClientCertificateThumbprint[] | string)␊ - /**␊ - * Microsoft.ServiceFabric/clusters: List of client certificates to whitelist based on common names.␊ - */␊ - clientCertificateCommonNames?: (ClientCertificateCommonName[] | string)␊ - /**␊ - * Microsoft.ServiceFabric/clusters: List of custom fabric settings to configure the cluster.␊ - */␊ - fabricSettings?: (SettingsSectionDescription[] | string)␊ - /**␊ - * Microsoft.ServiceFabric/clusters: The policy to use when upgrading the cluster.␊ - */␊ - upgradeDescription?: (PaasClusterUpgradePolicy | string)␊ - /**␊ - * Microsoft.ServiceFabric/clusters: The azure storage account information for uploading cluster logs.␊ - */␊ - diagnosticsStorageAccountConfig?: (DiagnosticsStorageAccountConfig | string)␊ - [k: string]: unknown␊ - }␊ - export interface CertificateDescription {␊ - thumbprint: string␊ - thumbprintSecondary?: string␊ - x509StoreName: (("AddressBook" | "AuthRoot" | "CertificateAuthority" | "Disallowed" | "My" | "Root" | "TrustedPeople" | "TrustedPublisher") | string)␊ - [k: string]: unknown␊ - }␊ - export interface AzureActiveDirectory {␊ - tenantId: string␊ - clusterApplication: string␊ - clientApplication: string␊ - [k: string]: unknown␊ - }␊ - export interface NodeTypes {␊ - httpApplicationGatewayEndpointPort?: (number | string)␊ - /**␊ - * This level is used to set the durability of nodes of this type.␊ - */␊ - durabilityLevel?: (("Bronze" | "Silver" | "Gold" | "Platinum") | string)␊ - vmInstanceCount: (number | string)␊ - name: string␊ - placementProperties?: ({␊ - [k: string]: string␊ - } | string)␊ - capacities?: ({␊ - [k: string]: string␊ - } | string)␊ - clientConnectionEndpointPort: (number | string)␊ - httpGatewayEndpointPort: (number | string)␊ - applicationPorts?: (Ports | string)␊ - ephemeralPorts?: (Ports | string)␊ - isPrimary: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - export interface Ports {␊ - startPort: (number | string)␊ - endPort: (number | string)␊ - [k: string]: unknown␊ - }␊ - export interface ClientCertificateThumbprint {␊ - isAdmin: (boolean | string)␊ - certificateThumbprint: string␊ - [k: string]: unknown␊ - }␊ - export interface ClientCertificateCommonName {␊ - isAdmin: (boolean | string)␊ - certificateCommonName: string␊ - certificateIssuerThumbprint: string␊ - [k: string]: unknown␊ - }␊ - export interface SettingsSectionDescription {␊ - name: string␊ - parameters: ({␊ - name: string␊ - value: string␊ - [k: string]: unknown␊ - } | string)[]␊ - [k: string]: unknown␊ - }␊ - export interface PaasClusterUpgradePolicy {␊ - upgradeReplicaSetCheckTimeout: string␊ - healthCheckWaitDuration: string␊ - healthCheckStableDuration: string␊ - healthCheckRetryTimeout: string␊ - upgradeTimeout: string␊ - upgradeDomainTimeout: string␊ - healthPolicy: {␊ - maxPercentUnhealthyNodes: (number | string)␊ - maxPercentUnhealthyApplications: (number | string)␊ - [k: string]: unknown␊ - }␊ - deltaHealthPolicy?: {␊ - maxPercentDeltaUnhealthyNodes: (number | string)␊ - maxPercentUpgradeDomainDeltaUnhealthyNodes: (number | string)␊ - maxPercentDeltaUnhealthyApplications: (number | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface DiagnosticsStorageAccountConfig {␊ - storageAccountName: string␊ - protectedAccountKeyName: string␊ - blobEndpoint: string␊ - queueEndpoint: string␊ - tableEndpoint: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceFabric/clusters␊ - */␊ - export interface Clusters10 {␊ - apiVersion: "2016-09-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the cluster resource␊ - */␊ - name: string␊ - /**␊ - * The cluster resource properties␊ - */␊ - properties: (ClusterProperties9 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.ServiceFabric/clusters"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The cluster resource properties␊ - */␊ - export interface ClusterProperties9 {␊ - /**␊ - * The settings to enable AAD authentication on the cluster␊ - */␊ - azureActiveDirectory?: (AzureActiveDirectory1 | string)␊ - /**␊ - * Certificate details␊ - */␊ - certificate?: (CertificateDescription1 | string)␊ - /**␊ - * List of client certificates to whitelist based on common names␊ - */␊ - clientCertificateCommonNames?: (ClientCertificateCommonName1[] | string)␊ - /**␊ - * The client thumbprint details ,it is used for client access for cluster operation␊ - */␊ - clientCertificateThumbprints?: (ClientCertificateThumbprint1[] | string)␊ - /**␊ - * The ServiceFabric code version running in your cluster␊ - */␊ - clusterCodeVersion?: string␊ - /**␊ - * Diagnostics storage account config␊ - */␊ - diagnosticsStorageAccountConfig?: (DiagnosticsStorageAccountConfig1 | string)␊ - /**␊ - * List of custom fabric settings to configure the cluster.␊ - */␊ - fabricSettings?: (SettingsSectionDescription1[] | string)␊ - /**␊ - * The http management endpoint of the cluster␊ - */␊ - managementEndpoint: string␊ - /**␊ - * The list of node types that make up the cluster␊ - */␊ - nodeTypes: (NodeTypeDescription[] | string)␊ - /**␊ - * Cluster reliability level indicates replica set size of system service.␊ - */␊ - reliabilityLevel?: (("Bronze" | "Silver" | "Gold" | "Platinum") | string)␊ - /**␊ - * Certificate details␊ - */␊ - reverseProxyCertificate?: (CertificateDescription1 | string)␊ - /**␊ - * Cluster upgrade policy␊ - */␊ - upgradeDescription?: (ClusterUpgradePolicy | string)␊ - /**␊ - * Cluster upgrade mode indicates if fabric upgrade is initiated automatically by the system or not.␊ - */␊ - upgradeMode?: (("Automatic" | "Manual") | string)␊ - /**␊ - * The name of VM image VMSS has been configured with. Generic names such as Windows or Linux can be used.␊ - */␊ - vmImage?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The settings to enable AAD authentication on the cluster␊ - */␊ - export interface AzureActiveDirectory1 {␊ - /**␊ - * Azure active directory client application id␊ - */␊ - clientApplication?: string␊ - /**␊ - * Azure active directory cluster application id␊ - */␊ - clusterApplication?: string␊ - /**␊ - * Azure active directory tenant id␊ - */␊ - tenantId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Certificate details␊ - */␊ - export interface CertificateDescription1 {␊ - /**␊ - * Thumbprint of the primary certificate␊ - */␊ - thumbprint: string␊ - /**␊ - * Thumbprint of the secondary certificate␊ - */␊ - thumbprintSecondary?: string␊ - /**␊ - * The local certificate store location.␊ - */␊ - x509StoreName?: (("AddressBook" | "AuthRoot" | "CertificateAuthority" | "Disallowed" | "My" | "Root" | "TrustedPeople" | "TrustedPublisher") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Client certificate details using common name␊ - */␊ - export interface ClientCertificateCommonName1 {␊ - /**␊ - * Certificate common name to be granted access; be careful using wild card common names␊ - */␊ - certificateCommonName: string␊ - /**␊ - * Certificate issuer thumbprint␊ - */␊ - certificateIssuerThumbprint: string␊ - /**␊ - * Is this certificate used for admin access from the client, if false , it is used or query only access␊ - */␊ - isAdmin: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Client certificate details using thumbprint␊ - */␊ - export interface ClientCertificateThumbprint1 {␊ - /**␊ - * Certificate thumbprint␊ - */␊ - certificateThumbprint: string␊ - /**␊ - * Is this certificate used for admin access from the client, if false, it is used or query only access␊ - */␊ - isAdmin: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Diagnostics storage account config␊ - */␊ - export interface DiagnosticsStorageAccountConfig1 {␊ - /**␊ - * Diagnostics storage account blob endpoint␊ - */␊ - blobEndpoint: string␊ - /**␊ - * Protected Diagnostics storage key name␊ - */␊ - protectedAccountKeyName: string␊ - /**␊ - * Diagnostics storage account queue endpoint␊ - */␊ - queueEndpoint: string␊ - /**␊ - * Diagnostics storage account name␊ - */␊ - storageAccountName: string␊ - /**␊ - * Diagnostics storage account table endpoint␊ - */␊ - tableEndpoint: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ServiceFabric section settings␊ - */␊ - export interface SettingsSectionDescription1 {␊ - /**␊ - * The name of settings section␊ - */␊ - name: string␊ - /**␊ - * Collection of settings in the section, each setting is a tuple consisting of setting name and value␊ - */␊ - parameters: (SettingsParameterDescription[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ServiceFabric settings under sections␊ - */␊ - export interface SettingsParameterDescription {␊ - /**␊ - * The name of settings property␊ - */␊ - name: string␊ - /**␊ - * The value of the property␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a node type in the cluster, each node type represents sub set of nodes in the cluster␊ - */␊ - export interface NodeTypeDescription {␊ - /**␊ - * Port range details␊ - */␊ - applicationPorts?: (EndpointRangeDescription | string)␊ - /**␊ - * The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much of a resource a node has␊ - */␊ - capacities?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The TCP cluster management endpoint port␊ - */␊ - clientConnectionEndpointPort: (number | string)␊ - /**␊ - * Node type durability Level.␊ - */␊ - durabilityLevel?: (("Bronze" | "Silver" | "Gold") | string)␊ - /**␊ - * Port range details␊ - */␊ - ephemeralPorts?: (EndpointRangeDescription | string)␊ - /**␊ - * The HTTP cluster management endpoint port␊ - */␊ - httpGatewayEndpointPort: (number | string)␊ - /**␊ - * Mark this as the primary node type␊ - */␊ - isPrimary: (boolean | string)␊ - /**␊ - * Name of the node type␊ - */␊ - name: string␊ - /**␊ - * The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run␊ - */␊ - placementProperties?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Endpoint used by reverse proxy␊ - */␊ - reverseProxyEndpointPort?: (number | string)␊ - /**␊ - * The number of node instances in the node type␊ - */␊ - vmInstanceCount: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Port range details␊ - */␊ - export interface EndpointRangeDescription {␊ - /**␊ - * End port of a range of ports␊ - */␊ - endPort: (number | string)␊ - /**␊ - * Starting port of a range of ports␊ - */␊ - startPort: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Cluster upgrade policy␊ - */␊ - export interface ClusterUpgradePolicy {␊ - /**␊ - * Delta health policy for the cluster␊ - */␊ - deltaHealthPolicy?: (ClusterUpgradeDeltaHealthPolicy | string)␊ - /**␊ - * Force node to restart or not␊ - */␊ - forceRestart?: (boolean | string)␊ - /**␊ - * The length of time that health checks can fail continuously,it represents .Net TimeSpan␊ - */␊ - healthCheckRetryTimeout: string␊ - /**␊ - * The length of time that health checks must pass continuously,it represents .Net TimeSpan␊ - */␊ - healthCheckStableDuration: string␊ - /**␊ - * The length of time to wait after completing an upgrade domain before performing health checks, it represents .Net TimeSpan␊ - */␊ - healthCheckWaitDuration: string␊ - /**␊ - * Defines a health policy used to evaluate the health of the cluster or of a cluster node.␊ - */␊ - healthPolicy: (ClusterHealthPolicy | string)␊ - /**␊ - * Use the user defined upgrade policy or not␊ - */␊ - overrideUserUpgradePolicy?: (boolean | string)␊ - /**␊ - * The timeout for any upgrade domain,it represents .Net TimeSpan␊ - */␊ - upgradeDomainTimeout: string␊ - /**␊ - * Timeout for replica set upgrade to complete,it represents .Net TimeSpan␊ - */␊ - upgradeReplicaSetCheckTimeout: string␊ - /**␊ - * The upgrade timeout,it represents .Net TimeSpan␊ - */␊ - upgradeTimeout: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Delta health policy for the cluster␊ - */␊ - export interface ClusterUpgradeDeltaHealthPolicy {␊ - /**␊ - * Additional unhealthy applications percentage␊ - */␊ - maxPercentDeltaUnhealthyApplications: (number | string)␊ - /**␊ - * Additional unhealthy nodes percentage␊ - */␊ - maxPercentDeltaUnhealthyNodes: (number | string)␊ - /**␊ - * Additional unhealthy nodes percentage per upgrade domain ␊ - */␊ - maxPercentUpgradeDomainDeltaUnhealthyNodes: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines a health policy used to evaluate the health of the cluster or of a cluster node.␊ - */␊ - export interface ClusterHealthPolicy {␊ - /**␊ - * The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10. ␊ - */␊ - maxPercentUnhealthyApplications?: (number | string)␊ - /**␊ - * The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10. ␊ - */␊ - maxPercentUnhealthyNodes?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceFabric/clusters␊ - */␊ - export interface Clusters11 {␊ - apiVersion: "2017-07-01-preview"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the cluster resource.␊ - */␊ - name: string␊ - /**␊ - * Describes the cluster resource properties.␊ - */␊ - properties: (ClusterProperties10 | string)␊ - resources?: (ClustersApplicationTypesChildResource | ClustersApplicationsChildResource)[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.ServiceFabric/clusters"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the cluster resource properties.␊ - */␊ - export interface ClusterProperties10 {␊ - /**␊ - * The list of add-on features to enable in the cluster.␊ - */␊ - addOnFeatures?: (("RepairManager" | "DnsService" | "BackupRestoreService")[] | string)␊ - /**␊ - * The Service Fabric runtime versions available for this cluster.␊ - */␊ - availableClusterVersions?: (ClusterVersionDetails[] | string)␊ - /**␊ - * The settings to enable AAD authentication on the cluster.␊ - */␊ - azureActiveDirectory?: (AzureActiveDirectory2 | string)␊ - /**␊ - * Describes the certificate details.␊ - */␊ - certificate?: (CertificateDescription2 | string)␊ - /**␊ - * The list of client certificates referenced by common name that are allowed to manage the cluster.␊ - */␊ - clientCertificateCommonNames?: (ClientCertificateCommonName2[] | string)␊ - /**␊ - * The list of client certificates referenced by thumbprint that are allowed to manage the cluster.␊ - */␊ - clientCertificateThumbprints?: (ClientCertificateThumbprint2[] | string)␊ - /**␊ - * The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](./ClusterVersion.md). To get the list of available version for existing clusters use **availableClusterVersions**.␊ - */␊ - clusterCodeVersion?: string␊ - clusterState?: (("WaitingForNodes" | "Deploying" | "BaselineUpgrade" | "UpdatingUserConfiguration" | "UpdatingUserCertificate" | "UpdatingInfrastructure" | "EnforcingClusterVersion" | "UpgradeServiceUnreachable" | "AutoScale" | "Ready") | string)␊ - /**␊ - * The storage account information for storing Service Fabric diagnostic logs.␊ - */␊ - diagnosticsStorageAccountConfig?: (DiagnosticsStorageAccountConfig2 | string)␊ - /**␊ - * The list of custom fabric settings to configure the cluster.␊ - */␊ - fabricSettings?: (SettingsSectionDescription2[] | string)␊ - /**␊ - * The http management endpoint of the cluster.␊ - */␊ - managementEndpoint: string␊ - /**␊ - * The list of node types in the cluster.␊ - */␊ - nodeTypes: (NodeTypeDescription1[] | string)␊ - reliabilityLevel?: (("None" | "Bronze" | "Silver" | "Gold" | "Platinum") | string)␊ - /**␊ - * Describes the certificate details.␊ - */␊ - reverseProxyCertificate?: (CertificateDescription2 | string)␊ - /**␊ - * Describes the policy used when upgrading the cluster.␊ - */␊ - upgradeDescription?: (ClusterUpgradePolicy1 | string)␊ - upgradeMode?: (("Automatic" | "Manual") | string)␊ - /**␊ - * The VM image VMSS has been configured with. Generic names such as Windows or Linux can be used.␊ - */␊ - vmImage?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The detail of the Service Fabric runtime version result␊ - */␊ - export interface ClusterVersionDetails {␊ - /**␊ - * The Service Fabric runtime version of the cluster.␊ - */␊ - codeVersion?: string␊ - /**␊ - * Indicates if this version is for Windows or Linux operating system.␊ - */␊ - environment?: (("Windows" | "Linux") | string)␊ - /**␊ - * The date of expiry of support of the version.␊ - */␊ - supportExpiryUtc?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The settings to enable AAD authentication on the cluster.␊ - */␊ - export interface AzureActiveDirectory2 {␊ - /**␊ - * Azure active directory client application id.␊ - */␊ - clientApplication?: string␊ - /**␊ - * Azure active directory cluster application id.␊ - */␊ - clusterApplication?: string␊ - /**␊ - * Azure active directory tenant id.␊ - */␊ - tenantId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the certificate details.␊ - */␊ - export interface CertificateDescription2 {␊ - /**␊ - * Thumbprint of the primary certificate.␊ - */␊ - thumbprint: string␊ - /**␊ - * Thumbprint of the secondary certificate.␊ - */␊ - thumbprintSecondary?: string␊ - /**␊ - * The local certificate store location.␊ - */␊ - x509StoreName?: (("AddressBook" | "AuthRoot" | "CertificateAuthority" | "Disallowed" | "My" | "Root" | "TrustedPeople" | "TrustedPublisher") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the client certificate details using common name.␊ - */␊ - export interface ClientCertificateCommonName2 {␊ - /**␊ - * The common name of the client certificate.␊ - */␊ - certificateCommonName: string␊ - /**␊ - * The issuer thumbprint of the client certificate.␊ - */␊ - certificateIssuerThumbprint: string␊ - /**␊ - * Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster.␊ - */␊ - isAdmin: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the client certificate details using thumbprint.␊ - */␊ - export interface ClientCertificateThumbprint2 {␊ - /**␊ - * The thumbprint of the client certificate.␊ - */␊ - certificateThumbprint: string␊ - /**␊ - * Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster.␊ - */␊ - isAdmin: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The storage account information for storing Service Fabric diagnostic logs.␊ - */␊ - export interface DiagnosticsStorageAccountConfig2 {␊ - /**␊ - * The blob endpoint of the azure storage account.␊ - */␊ - blobEndpoint: string␊ - /**␊ - * The protected diagnostics storage key name.␊ - */␊ - protectedAccountKeyName: string␊ - /**␊ - * The queue endpoint of the azure storage account.␊ - */␊ - queueEndpoint: string␊ - /**␊ - * The Azure storage account name.␊ - */␊ - storageAccountName: string␊ - /**␊ - * The table endpoint of the azure storage account.␊ - */␊ - tableEndpoint: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a section in the fabric settings of the cluster.␊ - */␊ - export interface SettingsSectionDescription2 {␊ - /**␊ - * The section name of the fabric settings.␊ - */␊ - name: string␊ - /**␊ - * The collection of parameters in the section.␊ - */␊ - parameters: (SettingsParameterDescription1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a parameter in fabric settings of the cluster.␊ - */␊ - export interface SettingsParameterDescription1 {␊ - /**␊ - * The parameter name of fabric setting.␊ - */␊ - name: string␊ - /**␊ - * The parameter value of fabric setting.␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a node type in the cluster, each node type represents sub set of nodes in the cluster.␊ - */␊ - export interface NodeTypeDescription1 {␊ - /**␊ - * Port range details␊ - */␊ - applicationPorts?: (EndpointRangeDescription1 | string)␊ - /**␊ - * The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has.␊ - */␊ - capacities?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The TCP cluster management endpoint port.␊ - */␊ - clientConnectionEndpointPort: (number | string)␊ - durabilityLevel?: (("Bronze" | "Silver" | "Gold") | string)␊ - /**␊ - * Port range details␊ - */␊ - ephemeralPorts?: (EndpointRangeDescription1 | string)␊ - /**␊ - * The HTTP cluster management endpoint port.␊ - */␊ - httpGatewayEndpointPort: (number | string)␊ - /**␊ - * The node type on which system services will run. Only one node type should be marked as primary. Primary node type cannot be deleted or changed for existing clusters.␊ - */␊ - isPrimary: (boolean | string)␊ - /**␊ - * The name of the node type.␊ - */␊ - name: string␊ - /**␊ - * The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run.␊ - */␊ - placementProperties?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The endpoint used by reverse proxy.␊ - */␊ - reverseProxyEndpointPort?: (number | string)␊ - /**␊ - * The number of nodes in the node type. This count should match the capacity property in the corresponding VirtualMachineScaleSet resource.␊ - */␊ - vmInstanceCount: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Port range details␊ - */␊ - export interface EndpointRangeDescription1 {␊ - /**␊ - * End port of a range of ports␊ - */␊ - endPort: (number | string)␊ - /**␊ - * Starting port of a range of ports␊ - */␊ - startPort: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the policy used when upgrading the cluster.␊ - */␊ - export interface ClusterUpgradePolicy1 {␊ - /**␊ - * Describes the delta health policies for the cluster upgrade.␊ - */␊ - deltaHealthPolicy?: (ClusterUpgradeDeltaHealthPolicy1 | string)␊ - /**␊ - * If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).␊ - */␊ - forceRestart?: (boolean | string)␊ - /**␊ - * The amount of time to retry health evaluation when the application or cluster is unhealthy before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format.␊ - */␊ - healthCheckRetryTimeout: string␊ - /**␊ - * The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format.␊ - */␊ - healthCheckStableDuration: string␊ - /**␊ - * The length of time to wait after completing an upgrade domain before performing health checks. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format.␊ - */␊ - healthCheckWaitDuration: string␊ - /**␊ - * Defines a health policy used to evaluate the health of the cluster or of a cluster node.␊ - */␊ - healthPolicy: (ClusterHealthPolicy1 | string)␊ - /**␊ - * The amount of time each upgrade domain has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format.␊ - */␊ - upgradeDomainTimeout: string␊ - /**␊ - * The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format.␊ - */␊ - upgradeReplicaSetCheckTimeout: string␊ - /**␊ - * The amount of time the overall upgrade has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format.␊ - */␊ - upgradeTimeout: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the delta health policies for the cluster upgrade.␊ - */␊ - export interface ClusterUpgradeDeltaHealthPolicy1 {␊ - /**␊ - * The maximum allowed percentage of applications health degradation allowed during cluster upgrades. The delta is measured between the state of the applications at the beginning of upgrade and the state of the applications at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. System services are not included in this.␊ - */␊ - maxPercentDeltaUnhealthyApplications: (number | string)␊ - /**␊ - * The maximum allowed percentage of nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits.␊ - */␊ - maxPercentDeltaUnhealthyNodes: (number | string)␊ - /**␊ - * The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits. ␊ - */␊ - maxPercentUpgradeDomainDeltaUnhealthyNodes: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines a health policy used to evaluate the health of the cluster or of a cluster node.␊ - */␊ - export interface ClusterHealthPolicy1 {␊ - /**␊ - * The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10. ␊ - */␊ - maxPercentUnhealthyApplications?: (number | string)␊ - /**␊ - * The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10. ␊ - */␊ - maxPercentUnhealthyNodes?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceFabric/clusters/applicationTypes␊ - */␊ - export interface ClustersApplicationTypesChildResource {␊ - apiVersion: "2017-07-01-preview"␊ - /**␊ - * Azure resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the application type name resource.␊ - */␊ - name: string␊ - /**␊ - * The application type name properties␊ - */␊ - properties: (ApplicationTypeResourceProperties | string)␊ - type: "applicationTypes"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The application type name properties␊ - */␊ - export interface ApplicationTypeResourceProperties {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceFabric/clusters/applications␊ - */␊ - export interface ClustersApplicationsChildResource {␊ - apiVersion: "2017-07-01-preview"␊ - /**␊ - * Azure resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the application resource.␊ - */␊ - name: string␊ - /**␊ - * The application resource properties.␊ - */␊ - properties: (ApplicationResourceProperties | string)␊ - type: "applications"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The application resource properties.␊ - */␊ - export interface ApplicationResourceProperties {␊ - /**␊ - * The maximum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. By default, the value of this property is zero and it means that the services can be placed on any node.␊ - */␊ - maximumNodes?: ((number & string) | string)␊ - /**␊ - * List of application capacity metric description.␊ - */␊ - metrics?: (ApplicationMetricDescription[] | string)␊ - /**␊ - * The minimum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. If this property is set to zero, no capacity will be reserved. The value of this property cannot be more than the value of the MaximumNodes property.␊ - */␊ - minimumNodes?: (number | string)␊ - /**␊ - * List of application parameters with overridden values from their default values specified in the application manifest.␊ - */␊ - parameters?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Remove the current application capacity settings.␊ - */␊ - removeApplicationCapacity?: (boolean | string)␊ - /**␊ - * The application type name as defined in the application manifest.␊ - */␊ - typeName?: string␊ - /**␊ - * The version of the application type as defined in the application manifest.␊ - */␊ - typeVersion?: string␊ - /**␊ - * Describes the policy for a monitored application upgrade.␊ - */␊ - upgradePolicy?: (ApplicationUpgradePolicy | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes capacity information for a custom resource balancing metric. This can be used to limit the total consumption of this metric by the services of this application.␊ - * ␊ - */␊ - export interface ApplicationMetricDescription {␊ - /**␊ - * The maximum node capacity for Service Fabric application.␊ - * This is the maximum Load for an instance of this application on a single node. Even if the capacity of node is greater than this value, Service Fabric will limit the total load of services within the application on each node to this value.␊ - * If set to zero, capacity for this metric is unlimited on each node.␊ - * When creating a new application with application capacity defined, the product of MaximumNodes and this value must always be smaller than or equal to TotalApplicationCapacity.␊ - * When updating existing application with application capacity, the product of MaximumNodes and this value must always be smaller than or equal to TotalApplicationCapacity.␊ - * ␊ - */␊ - MaximumCapacity?: (number | string)␊ - /**␊ - * The name of the metric.␊ - */␊ - Name?: string␊ - /**␊ - * The node reservation capacity for Service Fabric application.␊ - * This is the amount of load which is reserved on nodes which have instances of this application.␊ - * If MinimumNodes is specified, then the product of these values will be the capacity reserved in the cluster for the application.␊ - * If set to zero, no capacity is reserved for this metric.␊ - * When setting application capacity or when updating application capacity; this value must be smaller than or equal to MaximumCapacity for each metric.␊ - * ␊ - */␊ - ReservationCapacity?: (number | string)␊ - /**␊ - * The total metric capacity for Service Fabric application.␊ - * This is the total metric capacity for this application in the cluster. Service Fabric will try to limit the sum of loads of services within the application to this value.␊ - * When creating a new application with application capacity defined, the product of MaximumNodes and MaximumCapacity must always be smaller than or equal to this value.␊ - * ␊ - */␊ - TotalApplicationCapacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the policy for a monitored application upgrade.␊ - */␊ - export interface ApplicationUpgradePolicy {␊ - /**␊ - * Defines a health policy used to evaluate the health of an application or one of its children entities.␊ - * ␊ - */␊ - applicationHealthPolicy?: (ArmApplicationHealthPolicy | string)␊ - /**␊ - * If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).␊ - */␊ - forceRestart?: (boolean | string)␊ - /**␊ - * The policy used for monitoring the application upgrade␊ - */␊ - rollingUpgradeMonitoringPolicy?: (ArmRollingUpgradeMonitoringPolicy | string)␊ - /**␊ - * The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer).␊ - */␊ - upgradeReplicaSetCheckTimeout?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines a health policy used to evaluate the health of an application or one of its children entities.␊ - * ␊ - */␊ - export interface ArmApplicationHealthPolicy {␊ - /**␊ - * Indicates whether warnings are treated with the same severity as errors.␊ - */␊ - ConsiderWarningAsError?: (boolean | string)␊ - /**␊ - * Represents the health policy used to evaluate the health of services belonging to a service type.␊ - * ␊ - */␊ - DefaultServiceTypeHealthPolicy?: (ArmServiceTypeHealthPolicy | string)␊ - /**␊ - * The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100.␊ - * The percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error.␊ - * This is calculated by dividing the number of unhealthy deployed applications over the number of nodes where the application is currently deployed on in the cluster.␊ - * The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero.␊ - * ␊ - */␊ - MaxPercentUnhealthyDeployedApplications?: ((number & string) | string)␊ - /**␊ - * Defines a ServiceTypeHealthPolicy per service type name.␊ - * ␊ - * The entries in the map replace the default service type health policy for each specified service type.␊ - * For example, in an application that contains both a stateless gateway service type and a stateful engine service type, the health policies for the stateless and stateful services can be configured differently.␊ - * With policy per service type, there's more granular control of the health of the service.␊ - * ␊ - * If no policy is specified for a service type name, the DefaultServiceTypeHealthPolicy is used for evaluation.␊ - * ␊ - */␊ - ServiceTypeHealthPolicyMap?: ({␊ - [k: string]: ArmServiceTypeHealthPolicy␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents the health policy used to evaluate the health of services belonging to a service type.␊ - * ␊ - */␊ - export interface ArmServiceTypeHealthPolicy {␊ - /**␊ - * The maximum percentage of partitions per service allowed to be unhealthy before your application is considered in error.␊ - * ␊ - */␊ - maxPercentUnhealthyPartitionsPerService?: ((number & string) | string)␊ - /**␊ - * The maximum percentage of replicas per partition allowed to be unhealthy before your application is considered in error.␊ - * ␊ - */␊ - maxPercentUnhealthyReplicasPerPartition?: ((number & string) | string)␊ - /**␊ - * The maximum percentage of services allowed to be unhealthy before your application is considered in error.␊ - * ␊ - */␊ - maxPercentUnhealthyServices?: ((number & string) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The policy used for monitoring the application upgrade␊ - */␊ - export interface ArmRollingUpgradeMonitoringPolicy {␊ - /**␊ - * The activation Mode of the service package.␊ - */␊ - failureAction?: (("Rollback" | "Manual") | string)␊ - /**␊ - * The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.␊ - */␊ - healthCheckRetryTimeout?: string␊ - /**␊ - * The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.␊ - */␊ - healthCheckStableDuration?: string␊ - /**␊ - * The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.␊ - */␊ - healthCheckWaitDuration?: string␊ - /**␊ - * The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.␊ - */␊ - upgradeDomainTimeout?: string␊ - /**␊ - * The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.␊ - */␊ - upgradeTimeout?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceFabric/clusters/applications␊ - */␊ - export interface ClustersApplications {␊ - apiVersion: "2017-07-01-preview"␊ - /**␊ - * Azure resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the application resource.␊ - */␊ - name: string␊ - /**␊ - * The application resource properties.␊ - */␊ - properties: (ApplicationResourceProperties | string)␊ - resources?: ClustersApplicationsServicesChildResource[]␊ - type: "Microsoft.ServiceFabric/clusters/applications"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceFabric/clusters/applications/services␊ - */␊ - export interface ClustersApplicationsServicesChildResource {␊ - apiVersion: "2017-07-01-preview"␊ - /**␊ - * Azure resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the service resource in the format of {applicationName}~{serviceName}.␊ - */␊ - name: string␊ - /**␊ - * The service resource properties.␊ - */␊ - properties: (ServiceResourceProperties | string)␊ - type: "services"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Creates a particular correlation between services.␊ - */␊ - export interface ServiceCorrelationDescription {␊ - /**␊ - * The ServiceCorrelationScheme which describes the relationship between this service and the service specified via ServiceName.␊ - */␊ - Scheme: (("Invalid" | "Affinity" | "AlignedAffinity" | "NonAlignedAffinity") | string)␊ - /**␊ - * The full name of the service with 'fabric:' URI scheme.␊ - */␊ - ServiceName: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SingletonPartitionSchemeDescription␊ - */␊ - export interface SingletonPartitionSchemeDescription {␊ - PartitionScheme: "Singleton"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies a metric to load balance a service during runtime.␊ - */␊ - export interface ServiceLoadMetricDescription {␊ - /**␊ - * Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric.␊ - */␊ - DefaultLoad?: (number | string)␊ - /**␊ - * The name of the metric. If the service chooses to report load during runtime, the load metric name should match the name that is specified in Name exactly. Note that metric names are case sensitive.␊ - */␊ - Name: string␊ - /**␊ - * Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Primary replica.␊ - */␊ - PrimaryDefaultLoad?: (number | string)␊ - /**␊ - * Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Secondary replica.␊ - */␊ - SecondaryDefaultLoad?: (number | string)␊ - /**␊ - * The service load metric relative weight, compared to other metrics configured for this service, as a number.␊ - */␊ - Weight?: (("Zero" | "Low" | "Medium" | "High") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the policy to be used for placement of a Service Fabric service.␊ - */␊ - export interface ServicePlacementPolicyDescription {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a stateful service resource.␊ - */␊ - export interface StatefulServiceProperties {␊ - /**␊ - * A flag indicating whether this is a persistent service which stores states on the local disk. If it is then the value of this property is true, if not it is false.␊ - */␊ - hasPersistedState?: (boolean | string)␊ - /**␊ - * The minimum replica set size as a number.␊ - */␊ - minReplicaSetSize?: (number | string)␊ - /**␊ - * The maximum duration for which a partition is allowed to be in a state of quorum loss, represented in ISO 8601 format (hh:mm:ss.s).␊ - */␊ - quorumLossWaitDuration?: string␊ - /**␊ - * The duration between when a replica goes down and when a new replica is created, represented in ISO 8601 format (hh:mm:ss.s).␊ - */␊ - replicaRestartWaitDuration?: string␊ - serviceKind: "Stateful"␊ - /**␊ - * The definition on how long StandBy replicas should be maintained before being removed, represented in ISO 8601 format (hh:mm:ss.s).␊ - */␊ - standByReplicaKeepDuration?: string␊ - /**␊ - * The target replica set size as a number.␊ - */␊ - targetReplicaSetSize?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a stateless service resource.␊ - */␊ - export interface StatelessServiceProperties {␊ - /**␊ - * The instance count.␊ - */␊ - instanceCount?: (number | string)␊ - serviceKind: "Stateless"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceFabric/clusters/applications/services␊ - */␊ - export interface ClustersApplicationsServices {␊ - apiVersion: "2017-07-01-preview"␊ - /**␊ - * Azure resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the service resource in the format of {applicationName}~{serviceName}.␊ - */␊ - name: string␊ - /**␊ - * The service resource properties.␊ - */␊ - properties: ((StatefulServiceProperties | StatelessServiceProperties) | string)␊ - type: "Microsoft.ServiceFabric/clusters/applications/services"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceFabric/clusters/applicationTypes␊ - */␊ - export interface ClustersApplicationTypes {␊ - apiVersion: "2017-07-01-preview"␊ - /**␊ - * Azure resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the application type name resource.␊ - */␊ - name: string␊ - /**␊ - * The application type name properties␊ - */␊ - properties: (ApplicationTypeResourceProperties | string)␊ - resources?: ClustersApplicationTypesVersionsChildResource[]␊ - type: "Microsoft.ServiceFabric/clusters/applicationTypes"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceFabric/clusters/applicationTypes/versions␊ - */␊ - export interface ClustersApplicationTypesVersionsChildResource {␊ - apiVersion: "2017-07-01-preview"␊ - /**␊ - * Azure resource location.␊ - */␊ - location?: string␊ - /**␊ - * The application type version.␊ - */␊ - name: string␊ - /**␊ - * The properties of the application type version resource.␊ - */␊ - properties: (ApplicationTypeVersionResourceProperties | string)␊ - type: "versions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the application type version resource.␊ - */␊ - export interface ApplicationTypeVersionResourceProperties {␊ - /**␊ - * The URL to the application package␊ - */␊ - appPackageUrl: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceFabric/clusters/applicationTypes/versions␊ - */␊ - export interface ClustersApplicationTypesVersions {␊ - apiVersion: "2017-07-01-preview"␊ - /**␊ - * Azure resource location.␊ - */␊ - location?: string␊ - /**␊ - * The application type version.␊ - */␊ - name: string␊ - /**␊ - * The properties of the application type version resource.␊ - */␊ - properties: (ApplicationTypeVersionResourceProperties | string)␊ - type: "Microsoft.ServiceFabric/clusters/applicationTypes/versions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceFabric/clusters␊ - */␊ - export interface Clusters12 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Azure resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the cluster resource.␊ - */␊ - name: string␊ - /**␊ - * Describes the cluster resource properties.␊ - */␊ - properties: (ClusterProperties11 | string)␊ - /**␊ - * Azure resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.ServiceFabric/clusters"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the cluster resource properties.␊ - */␊ - export interface ClusterProperties11 {␊ - /**␊ - * The list of add-on features to enable in the cluster.␊ - */␊ - addOnFeatures?: (("RepairManager" | "DnsService" | "BackupRestoreService" | "ResourceMonitorService")[] | string)␊ - /**␊ - * The settings to enable AAD authentication on the cluster.␊ - */␊ - azureActiveDirectory?: (AzureActiveDirectory3 | string)␊ - /**␊ - * Describes the certificate details.␊ - */␊ - certificate?: (CertificateDescription3 | string)␊ - /**␊ - * Describes a list of server certificates referenced by common name that are used to secure the cluster.␊ - */␊ - certificateCommonNames?: (ServerCertificateCommonNames | string)␊ - /**␊ - * The list of client certificates referenced by common name that are allowed to manage the cluster.␊ - */␊ - clientCertificateCommonNames?: (ClientCertificateCommonName3[] | string)␊ - /**␊ - * The list of client certificates referenced by thumbprint that are allowed to manage the cluster.␊ - */␊ - clientCertificateThumbprints?: (ClientCertificateThumbprint3[] | string)␊ - /**␊ - * The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](./ClusterVersion.md). To get the list of available version for existing clusters use **availableClusterVersions**.␊ - */␊ - clusterCodeVersion?: string␊ - /**␊ - * The storage account information for storing Service Fabric diagnostic logs.␊ - */␊ - diagnosticsStorageAccountConfig?: (DiagnosticsStorageAccountConfig3 | string)␊ - /**␊ - * The list of custom fabric settings to configure the cluster.␊ - */␊ - fabricSettings?: (SettingsSectionDescription3[] | string)␊ - /**␊ - * The http management endpoint of the cluster.␊ - */␊ - managementEndpoint: string␊ - /**␊ - * The list of node types in the cluster.␊ - */␊ - nodeTypes: (NodeTypeDescription2[] | string)␊ - /**␊ - * The reliability level sets the replica set size of system services. Learn about [ReliabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity).␊ - * ␊ - * - None - Run the System services with a target replica set count of 1. This should only be used for test clusters.␊ - * - Bronze - Run the System services with a target replica set count of 3. This should only be used for test clusters.␊ - * - Silver - Run the System services with a target replica set count of 5.␊ - * - Gold - Run the System services with a target replica set count of 7.␊ - * - Platinum - Run the System services with a target replica set count of 9.␊ - * .␊ - */␊ - reliabilityLevel?: (("None" | "Bronze" | "Silver" | "Gold" | "Platinum") | string)␊ - /**␊ - * Describes the certificate details.␊ - */␊ - reverseProxyCertificate?: (CertificateDescription3 | string)␊ - /**␊ - * Describes a list of server certificates referenced by common name that are used to secure the cluster.␊ - */␊ - reverseProxyCertificateCommonNames?: (ServerCertificateCommonNames | string)␊ - /**␊ - * Describes the policy used when upgrading the cluster.␊ - */␊ - upgradeDescription?: (ClusterUpgradePolicy2 | string)␊ - /**␊ - * The upgrade mode of the cluster when new Service Fabric runtime version is available.␊ - * ␊ - * - Automatic - The cluster will be automatically upgraded to the latest Service Fabric runtime version as soon as it is available.␊ - * - Manual - The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource.␊ - * .␊ - */␊ - upgradeMode?: (("Automatic" | "Manual") | string)␊ - /**␊ - * The VM image VMSS has been configured with. Generic names such as Windows or Linux can be used.␊ - */␊ - vmImage?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The settings to enable AAD authentication on the cluster.␊ - */␊ - export interface AzureActiveDirectory3 {␊ - /**␊ - * Azure active directory client application id.␊ - */␊ - clientApplication?: string␊ - /**␊ - * Azure active directory cluster application id.␊ - */␊ - clusterApplication?: string␊ - /**␊ - * Azure active directory tenant id.␊ - */␊ - tenantId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the certificate details.␊ - */␊ - export interface CertificateDescription3 {␊ - /**␊ - * Thumbprint of the primary certificate.␊ - */␊ - thumbprint: string␊ - /**␊ - * Thumbprint of the secondary certificate.␊ - */␊ - thumbprintSecondary?: string␊ - /**␊ - * The local certificate store location.␊ - */␊ - x509StoreName?: (("AddressBook" | "AuthRoot" | "CertificateAuthority" | "Disallowed" | "My" | "Root" | "TrustedPeople" | "TrustedPublisher") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a list of server certificates referenced by common name that are used to secure the cluster.␊ - */␊ - export interface ServerCertificateCommonNames {␊ - /**␊ - * The list of server certificates referenced by common name that are used to secure the cluster.␊ - */␊ - commonNames?: (ServerCertificateCommonName[] | string)␊ - /**␊ - * The local certificate store location.␊ - */␊ - x509StoreName?: (("AddressBook" | "AuthRoot" | "CertificateAuthority" | "Disallowed" | "My" | "Root" | "TrustedPeople" | "TrustedPublisher") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the server certificate details using common name.␊ - */␊ - export interface ServerCertificateCommonName {␊ - /**␊ - * The common name of the server certificate.␊ - */␊ - certificateCommonName: string␊ - /**␊ - * The issuer thumbprint of the server certificate.␊ - */␊ - certificateIssuerThumbprint: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the client certificate details using common name.␊ - */␊ - export interface ClientCertificateCommonName3 {␊ - /**␊ - * The common name of the client certificate.␊ - */␊ - certificateCommonName: string␊ - /**␊ - * The issuer thumbprint of the client certificate.␊ - */␊ - certificateIssuerThumbprint: string␊ - /**␊ - * Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster.␊ - */␊ - isAdmin: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the client certificate details using thumbprint.␊ - */␊ - export interface ClientCertificateThumbprint3 {␊ - /**␊ - * The thumbprint of the client certificate.␊ - */␊ - certificateThumbprint: string␊ - /**␊ - * Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster.␊ - */␊ - isAdmin: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The storage account information for storing Service Fabric diagnostic logs.␊ - */␊ - export interface DiagnosticsStorageAccountConfig3 {␊ - /**␊ - * The blob endpoint of the azure storage account.␊ - */␊ - blobEndpoint: string␊ - /**␊ - * The protected diagnostics storage key name.␊ - */␊ - protectedAccountKeyName: string␊ - /**␊ - * The queue endpoint of the azure storage account.␊ - */␊ - queueEndpoint: string␊ - /**␊ - * The Azure storage account name.␊ - */␊ - storageAccountName: string␊ - /**␊ - * The table endpoint of the azure storage account.␊ - */␊ - tableEndpoint: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a section in the fabric settings of the cluster.␊ - */␊ - export interface SettingsSectionDescription3 {␊ - /**␊ - * The section name of the fabric settings.␊ - */␊ - name: string␊ - /**␊ - * The collection of parameters in the section.␊ - */␊ - parameters: (SettingsParameterDescription2[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a parameter in fabric settings of the cluster.␊ - */␊ - export interface SettingsParameterDescription2 {␊ - /**␊ - * The parameter name of fabric setting.␊ - */␊ - name: string␊ - /**␊ - * The parameter value of fabric setting.␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a node type in the cluster, each node type represents sub set of nodes in the cluster.␊ - */␊ - export interface NodeTypeDescription2 {␊ - /**␊ - * Port range details␊ - */␊ - applicationPorts?: (EndpointRangeDescription2 | string)␊ - /**␊ - * The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has.␊ - */␊ - capacities?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The TCP cluster management endpoint port.␊ - */␊ - clientConnectionEndpointPort: (number | string)␊ - /**␊ - * The durability level of the node type. Learn about [DurabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity).␊ - * ␊ - * - Bronze - No privileges. This is the default.␊ - * - Silver - The infrastructure jobs can be paused for a duration of 10 minutes per UD.␊ - * - Gold - The infrastructure jobs can be paused for a duration of 2 hours per UD. Gold durability can be enabled only on full node VM SKUs like D15_V2, G5 etc.␊ - * .␊ - */␊ - durabilityLevel?: (("Bronze" | "Silver" | "Gold") | string)␊ - /**␊ - * Port range details␊ - */␊ - ephemeralPorts?: (EndpointRangeDescription2 | string)␊ - /**␊ - * The HTTP cluster management endpoint port.␊ - */␊ - httpGatewayEndpointPort: (number | string)␊ - /**␊ - * The node type on which system services will run. Only one node type should be marked as primary. Primary node type cannot be deleted or changed for existing clusters.␊ - */␊ - isPrimary: (boolean | string)␊ - /**␊ - * The name of the node type.␊ - */␊ - name: string␊ - /**␊ - * The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run.␊ - */␊ - placementProperties?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The endpoint used by reverse proxy.␊ - */␊ - reverseProxyEndpointPort?: (number | string)␊ - /**␊ - * The number of nodes in the node type. This count should match the capacity property in the corresponding VirtualMachineScaleSet resource.␊ - */␊ - vmInstanceCount: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Port range details␊ - */␊ - export interface EndpointRangeDescription2 {␊ - /**␊ - * End port of a range of ports␊ - */␊ - endPort: (number | string)␊ - /**␊ - * Starting port of a range of ports␊ - */␊ - startPort: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the policy used when upgrading the cluster.␊ - */␊ - export interface ClusterUpgradePolicy2 {␊ - /**␊ - * Describes the delta health policies for the cluster upgrade.␊ - */␊ - deltaHealthPolicy?: (ClusterUpgradeDeltaHealthPolicy2 | string)␊ - /**␊ - * If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).␊ - */␊ - forceRestart?: (boolean | string)␊ - /**␊ - * The amount of time to retry health evaluation when the application or cluster is unhealthy before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format.␊ - */␊ - healthCheckRetryTimeout: string␊ - /**␊ - * The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format.␊ - */␊ - healthCheckStableDuration: string␊ - /**␊ - * The length of time to wait after completing an upgrade domain before performing health checks. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format.␊ - */␊ - healthCheckWaitDuration: string␊ - /**␊ - * Defines a health policy used to evaluate the health of the cluster or of a cluster node.␊ - * ␊ - */␊ - healthPolicy: (ClusterHealthPolicy2 | string)␊ - /**␊ - * The amount of time each upgrade domain has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format.␊ - */␊ - upgradeDomainTimeout: string␊ - /**␊ - * The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format.␊ - */␊ - upgradeReplicaSetCheckTimeout: string␊ - /**␊ - * The amount of time the overall upgrade has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format.␊ - */␊ - upgradeTimeout: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the delta health policies for the cluster upgrade.␊ - */␊ - export interface ClusterUpgradeDeltaHealthPolicy2 {␊ - /**␊ - * Defines a map that contains specific application delta health policies for different applications.␊ - * Each entry specifies as key the application name and as value an ApplicationDeltaHealthPolicy used to evaluate the application health when upgrading the cluster.␊ - * The application name should include the 'fabric:' URI scheme.␊ - * The map is empty by default.␊ - * ␊ - */␊ - applicationDeltaHealthPolicies?: ({␊ - [k: string]: ApplicationDeltaHealthPolicy␊ - } | string)␊ - /**␊ - * The maximum allowed percentage of applications health degradation allowed during cluster upgrades.␊ - * The delta is measured between the state of the applications at the beginning of upgrade and the state of the applications at the time of the health evaluation.␊ - * The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. System services are not included in this.␊ - * ␊ - */␊ - maxPercentDeltaUnhealthyApplications: (number | string)␊ - /**␊ - * The maximum allowed percentage of nodes health degradation allowed during cluster upgrades.␊ - * The delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation.␊ - * The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits.␊ - * ␊ - */␊ - maxPercentDeltaUnhealthyNodes: (number | string)␊ - /**␊ - * The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades.␊ - * The delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation.␊ - * The check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits.␊ - * ␊ - */␊ - maxPercentUpgradeDomainDeltaUnhealthyNodes: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines a delta health policy used to evaluate the health of an application or one of its child entities when upgrading the cluster.␊ - * ␊ - */␊ - export interface ApplicationDeltaHealthPolicy {␊ - /**␊ - * Represents the delta health policy used to evaluate the health of services belonging to a service type when upgrading the cluster.␊ - * ␊ - */␊ - defaultServiceTypeDeltaHealthPolicy?: (ServiceTypeDeltaHealthPolicy | string)␊ - /**␊ - * Defines a map that contains specific delta health policies for different service types.␊ - * Each entry specifies as key the service type name and as value a ServiceTypeDeltaHealthPolicy used to evaluate the service health when upgrading the cluster.␊ - * The map is empty by default.␊ - * ␊ - */␊ - serviceTypeDeltaHealthPolicies?: ({␊ - [k: string]: ServiceTypeDeltaHealthPolicy␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents the delta health policy used to evaluate the health of services belonging to a service type when upgrading the cluster.␊ - * ␊ - */␊ - export interface ServiceTypeDeltaHealthPolicy {␊ - /**␊ - * The maximum allowed percentage of services health degradation allowed during cluster upgrades.␊ - * The delta is measured between the state of the services at the beginning of upgrade and the state of the services at the time of the health evaluation.␊ - * The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits.␊ - * ␊ - */␊ - maxPercentDeltaUnhealthyServices?: ((number & string) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines a health policy used to evaluate the health of the cluster or of a cluster node.␊ - * ␊ - */␊ - export interface ClusterHealthPolicy2 {␊ - /**␊ - * Defines a map that contains specific application health policies for different applications.␊ - * Each entry specifies as key the application name and as value an ApplicationHealthPolicy used to evaluate the application health.␊ - * The application name should include the 'fabric:' URI scheme.␊ - * The map is empty by default.␊ - * ␊ - */␊ - applicationHealthPolicies?: ({␊ - [k: string]: ApplicationHealthPolicy␊ - } | string)␊ - /**␊ - * The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10.␊ - * ␊ - * The percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error.␊ - * If the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning.␊ - * This is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap.␊ - * The computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero.␊ - * ␊ - */␊ - maxPercentUnhealthyApplications?: ((number & string) | string)␊ - /**␊ - * The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10.␊ - * ␊ - * The percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error.␊ - * If the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning.␊ - * The percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster.␊ - * The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero.␊ - * ␊ - * In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that.␊ - * ␊ - */␊ - maxPercentUnhealthyNodes?: ((number & string) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines a health policy used to evaluate the health of an application or one of its children entities.␊ - * ␊ - */␊ - export interface ApplicationHealthPolicy {␊ - /**␊ - * Represents the health policy used to evaluate the health of services belonging to a service type.␊ - * ␊ - */␊ - defaultServiceTypeHealthPolicy?: (ServiceTypeHealthPolicy | string)␊ - /**␊ - * Defines a ServiceTypeHealthPolicy per service type name.␊ - * ␊ - * The entries in the map replace the default service type health policy for each specified service type.␊ - * For example, in an application that contains both a stateless gateway service type and a stateful engine service type, the health policies for the stateless and stateful services can be configured differently.␊ - * With policy per service type, there's more granular control of the health of the service.␊ - * ␊ - * If no policy is specified for a service type name, the DefaultServiceTypeHealthPolicy is used for evaluation.␊ - * ␊ - */␊ - serviceTypeHealthPolicies?: ({␊ - [k: string]: ServiceTypeHealthPolicy␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents the health policy used to evaluate the health of services belonging to a service type.␊ - * ␊ - */␊ - export interface ServiceTypeHealthPolicy {␊ - /**␊ - * The maximum percentage of services allowed to be unhealthy before your application is considered in error.␊ - * ␊ - */␊ - maxPercentUnhealthyServices?: ((number & string) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceFabric/clusters␊ - */␊ - export interface Clusters13 {␊ - apiVersion: "2019-03-01-preview"␊ - /**␊ - * Azure resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the cluster resource.␊ - */␊ - name: string␊ - /**␊ - * Describes the cluster resource properties.␊ - */␊ - properties: (ClusterProperties12 | string)␊ - resources?: (ClustersApplicationTypesChildResource1 | ClustersApplicationsChildResource1)[]␊ - /**␊ - * Azure resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.ServiceFabric/clusters"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the cluster resource properties.␊ - */␊ - export interface ClusterProperties12 {␊ - /**␊ - * The list of add-on features to enable in the cluster.␊ - */␊ - addOnFeatures?: (("RepairManager" | "DnsService" | "BackupRestoreService" | "ResourceMonitorService")[] | string)␊ - /**␊ - * The settings to enable AAD authentication on the cluster.␊ - */␊ - azureActiveDirectory?: (AzureActiveDirectory4 | string)␊ - /**␊ - * Describes the certificate details.␊ - */␊ - certificate?: (CertificateDescription4 | string)␊ - /**␊ - * Describes a list of server certificates referenced by common name that are used to secure the cluster.␊ - */␊ - certificateCommonNames?: (ServerCertificateCommonNames1 | string)␊ - /**␊ - * The list of client certificates referenced by common name that are allowed to manage the cluster.␊ - */␊ - clientCertificateCommonNames?: (ClientCertificateCommonName4[] | string)␊ - /**␊ - * The list of client certificates referenced by thumbprint that are allowed to manage the cluster.␊ - */␊ - clientCertificateThumbprints?: (ClientCertificateThumbprint4[] | string)␊ - /**␊ - * The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](./ClusterVersion.md). To get the list of available version for existing clusters use **availableClusterVersions**.␊ - */␊ - clusterCodeVersion?: string␊ - /**␊ - * The storage account information for storing Service Fabric diagnostic logs.␊ - */␊ - diagnosticsStorageAccountConfig?: (DiagnosticsStorageAccountConfig4 | string)␊ - /**␊ - * Indicates if the event store service is enabled.␊ - */␊ - eventStoreServiceEnabled?: (boolean | string)␊ - /**␊ - * The list of custom fabric settings to configure the cluster.␊ - */␊ - fabricSettings?: (SettingsSectionDescription4[] | string)␊ - /**␊ - * The http management endpoint of the cluster.␊ - */␊ - managementEndpoint: string␊ - /**␊ - * The list of node types in the cluster.␊ - */␊ - nodeTypes: (NodeTypeDescription3[] | string)␊ - /**␊ - * The reliability level sets the replica set size of system services. Learn about [ReliabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity).␊ - * ␊ - * - None - Run the System services with a target replica set count of 1. This should only be used for test clusters.␊ - * - Bronze - Run the System services with a target replica set count of 3. This should only be used for test clusters.␊ - * - Silver - Run the System services with a target replica set count of 5.␊ - * - Gold - Run the System services with a target replica set count of 7.␊ - * - Platinum - Run the System services with a target replica set count of 9.␊ - * .␊ - */␊ - reliabilityLevel?: (("None" | "Bronze" | "Silver" | "Gold" | "Platinum") | string)␊ - /**␊ - * Describes the certificate details.␊ - */␊ - reverseProxyCertificate?: (CertificateDescription4 | string)␊ - /**␊ - * Describes a list of server certificates referenced by common name that are used to secure the cluster.␊ - */␊ - reverseProxyCertificateCommonNames?: (ServerCertificateCommonNames1 | string)␊ - /**␊ - * Describes the policy used when upgrading the cluster.␊ - */␊ - upgradeDescription?: (ClusterUpgradePolicy3 | string)␊ - /**␊ - * The upgrade mode of the cluster when new Service Fabric runtime version is available.␊ - * ␊ - * - Automatic - The cluster will be automatically upgraded to the latest Service Fabric runtime version as soon as it is available.␊ - * - Manual - The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource.␊ - * .␊ - */␊ - upgradeMode?: (("Automatic" | "Manual") | string)␊ - /**␊ - * The VM image VMSS has been configured with. Generic names such as Windows or Linux can be used.␊ - */␊ - vmImage?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The settings to enable AAD authentication on the cluster.␊ - */␊ - export interface AzureActiveDirectory4 {␊ - /**␊ - * Azure active directory client application id.␊ - */␊ - clientApplication?: string␊ - /**␊ - * Azure active directory cluster application id.␊ - */␊ - clusterApplication?: string␊ - /**␊ - * Azure active directory tenant id.␊ - */␊ - tenantId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the certificate details.␊ - */␊ - export interface CertificateDescription4 {␊ - /**␊ - * Thumbprint of the primary certificate.␊ - */␊ - thumbprint: string␊ - /**␊ - * Thumbprint of the secondary certificate.␊ - */␊ - thumbprintSecondary?: string␊ - /**␊ - * The local certificate store location.␊ - */␊ - x509StoreName?: (("AddressBook" | "AuthRoot" | "CertificateAuthority" | "Disallowed" | "My" | "Root" | "TrustedPeople" | "TrustedPublisher") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a list of server certificates referenced by common name that are used to secure the cluster.␊ - */␊ - export interface ServerCertificateCommonNames1 {␊ - /**␊ - * The list of server certificates referenced by common name that are used to secure the cluster.␊ - */␊ - commonNames?: (ServerCertificateCommonName1[] | string)␊ - /**␊ - * The local certificate store location.␊ - */␊ - x509StoreName?: (("AddressBook" | "AuthRoot" | "CertificateAuthority" | "Disallowed" | "My" | "Root" | "TrustedPeople" | "TrustedPublisher") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the server certificate details using common name.␊ - */␊ - export interface ServerCertificateCommonName1 {␊ - /**␊ - * The common name of the server certificate.␊ - */␊ - certificateCommonName: string␊ - /**␊ - * The issuer thumbprint of the server certificate.␊ - */␊ - certificateIssuerThumbprint: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the client certificate details using common name.␊ - */␊ - export interface ClientCertificateCommonName4 {␊ - /**␊ - * The common name of the client certificate.␊ - */␊ - certificateCommonName: string␊ - /**␊ - * The issuer thumbprint of the client certificate.␊ - */␊ - certificateIssuerThumbprint: string␊ - /**␊ - * Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster.␊ - */␊ - isAdmin: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the client certificate details using thumbprint.␊ - */␊ - export interface ClientCertificateThumbprint4 {␊ - /**␊ - * The thumbprint of the client certificate.␊ - */␊ - certificateThumbprint: string␊ - /**␊ - * Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster.␊ - */␊ - isAdmin: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The storage account information for storing Service Fabric diagnostic logs.␊ - */␊ - export interface DiagnosticsStorageAccountConfig4 {␊ - /**␊ - * The blob endpoint of the azure storage account.␊ - */␊ - blobEndpoint: string␊ - /**␊ - * The protected diagnostics storage key name.␊ - */␊ - protectedAccountKeyName: string␊ - /**␊ - * The queue endpoint of the azure storage account.␊ - */␊ - queueEndpoint: string␊ - /**␊ - * The Azure storage account name.␊ - */␊ - storageAccountName: string␊ - /**␊ - * The table endpoint of the azure storage account.␊ - */␊ - tableEndpoint: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a section in the fabric settings of the cluster.␊ - */␊ - export interface SettingsSectionDescription4 {␊ - /**␊ - * The section name of the fabric settings.␊ - */␊ - name: string␊ - /**␊ - * The collection of parameters in the section.␊ - */␊ - parameters: (SettingsParameterDescription3[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a parameter in fabric settings of the cluster.␊ - */␊ - export interface SettingsParameterDescription3 {␊ - /**␊ - * The parameter name of fabric setting.␊ - */␊ - name: string␊ - /**␊ - * The parameter value of fabric setting.␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a node type in the cluster, each node type represents sub set of nodes in the cluster.␊ - */␊ - export interface NodeTypeDescription3 {␊ - /**␊ - * Port range details␊ - */␊ - applicationPorts?: (EndpointRangeDescription3 | string)␊ - /**␊ - * The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has.␊ - */␊ - capacities?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The TCP cluster management endpoint port.␊ - */␊ - clientConnectionEndpointPort: (number | string)␊ - /**␊ - * The durability level of the node type. Learn about [DurabilityLevel](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-capacity).␊ - * ␊ - * - Bronze - No privileges. This is the default.␊ - * - Silver - The infrastructure jobs can be paused for a duration of 10 minutes per UD.␊ - * - Gold - The infrastructure jobs can be paused for a duration of 2 hours per UD. Gold durability can be enabled only on full node VM skus like D15_V2, G5 etc.␊ - * .␊ - */␊ - durabilityLevel?: (("Bronze" | "Silver" | "Gold") | string)␊ - /**␊ - * Port range details␊ - */␊ - ephemeralPorts?: (EndpointRangeDescription3 | string)␊ - /**␊ - * The HTTP cluster management endpoint port.␊ - */␊ - httpGatewayEndpointPort: (number | string)␊ - /**␊ - * The node type on which system services will run. Only one node type should be marked as primary. Primary node type cannot be deleted or changed for existing clusters.␊ - */␊ - isPrimary: (boolean | string)␊ - /**␊ - * The name of the node type.␊ - */␊ - name: string␊ - /**␊ - * The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run.␊ - */␊ - placementProperties?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The endpoint used by reverse proxy.␊ - */␊ - reverseProxyEndpointPort?: (number | string)␊ - /**␊ - * The number of nodes in the node type. This count should match the capacity property in the corresponding VirtualMachineScaleSet resource.␊ - */␊ - vmInstanceCount: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Port range details␊ - */␊ - export interface EndpointRangeDescription3 {␊ - /**␊ - * End port of a range of ports␊ - */␊ - endPort: (number | string)␊ - /**␊ - * Starting port of a range of ports␊ - */␊ - startPort: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the policy used when upgrading the cluster.␊ - */␊ - export interface ClusterUpgradePolicy3 {␊ - /**␊ - * Describes the delta health policies for the cluster upgrade.␊ - */␊ - deltaHealthPolicy?: (ClusterUpgradeDeltaHealthPolicy3 | string)␊ - /**␊ - * If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).␊ - */␊ - forceRestart?: (boolean | string)␊ - /**␊ - * The amount of time to retry health evaluation when the application or cluster is unhealthy before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format.␊ - */␊ - healthCheckRetryTimeout: string␊ - /**␊ - * The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format.␊ - */␊ - healthCheckStableDuration: string␊ - /**␊ - * The length of time to wait after completing an upgrade domain before performing health checks. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format.␊ - */␊ - healthCheckWaitDuration: string␊ - /**␊ - * Defines a health policy used to evaluate the health of the cluster or of a cluster node.␊ - * ␊ - */␊ - healthPolicy: (ClusterHealthPolicy3 | string)␊ - /**␊ - * The amount of time each upgrade domain has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format.␊ - */␊ - upgradeDomainTimeout: string␊ - /**␊ - * The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format.␊ - */␊ - upgradeReplicaSetCheckTimeout: string␊ - /**␊ - * The amount of time the overall upgrade has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format.␊ - */␊ - upgradeTimeout: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the delta health policies for the cluster upgrade.␊ - */␊ - export interface ClusterUpgradeDeltaHealthPolicy3 {␊ - /**␊ - * Defines a map that contains specific application delta health policies for different applications.␊ - * Each entry specifies as key the application name and as value an ApplicationDeltaHealthPolicy used to evaluate the application health when upgrading the cluster.␊ - * The application name should include the 'fabric:' URI scheme.␊ - * The map is empty by default.␊ - * ␊ - */␊ - applicationDeltaHealthPolicies?: ({␊ - [k: string]: ApplicationDeltaHealthPolicy1␊ - } | string)␊ - /**␊ - * The maximum allowed percentage of applications health degradation allowed during cluster upgrades.␊ - * The delta is measured between the state of the applications at the beginning of upgrade and the state of the applications at the time of the health evaluation.␊ - * The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. System services are not included in this.␊ - * ␊ - */␊ - maxPercentDeltaUnhealthyApplications: (number | string)␊ - /**␊ - * The maximum allowed percentage of nodes health degradation allowed during cluster upgrades.␊ - * The delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation.␊ - * The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits.␊ - * ␊ - */␊ - maxPercentDeltaUnhealthyNodes: (number | string)␊ - /**␊ - * The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades.␊ - * The delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation.␊ - * The check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits.␊ - * ␊ - */␊ - maxPercentUpgradeDomainDeltaUnhealthyNodes: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines a delta health policy used to evaluate the health of an application or one of its child entities when upgrading the cluster.␊ - * ␊ - */␊ - export interface ApplicationDeltaHealthPolicy1 {␊ - /**␊ - * Represents the delta health policy used to evaluate the health of services belonging to a service type when upgrading the cluster.␊ - * ␊ - */␊ - defaultServiceTypeDeltaHealthPolicy?: (ServiceTypeDeltaHealthPolicy1 | string)␊ - /**␊ - * Defines a map that contains specific delta health policies for different service types.␊ - * Each entry specifies as key the service type name and as value a ServiceTypeDeltaHealthPolicy used to evaluate the service health when upgrading the cluster.␊ - * The map is empty by default.␊ - * ␊ - */␊ - serviceTypeDeltaHealthPolicies?: ({␊ - [k: string]: ServiceTypeDeltaHealthPolicy1␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents the delta health policy used to evaluate the health of services belonging to a service type when upgrading the cluster.␊ - * ␊ - */␊ - export interface ServiceTypeDeltaHealthPolicy1 {␊ - /**␊ - * The maximum allowed percentage of services health degradation allowed during cluster upgrades.␊ - * The delta is measured between the state of the services at the beginning of upgrade and the state of the services at the time of the health evaluation.␊ - * The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits.␊ - * ␊ - */␊ - maxPercentDeltaUnhealthyServices?: ((number & string) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines a health policy used to evaluate the health of the cluster or of a cluster node.␊ - * ␊ - */␊ - export interface ClusterHealthPolicy3 {␊ - /**␊ - * Defines a map that contains specific application health policies for different applications.␊ - * Each entry specifies as key the application name and as value an ApplicationHealthPolicy used to evaluate the application health.␊ - * The application name should include the 'fabric:' URI scheme.␊ - * The map is empty by default.␊ - * ␊ - */␊ - applicationHealthPolicies?: ({␊ - [k: string]: ApplicationHealthPolicy1␊ - } | string)␊ - /**␊ - * The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10.␊ - * ␊ - * The percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error.␊ - * If the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning.␊ - * This is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap.␊ - * The computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero.␊ - * ␊ - */␊ - maxPercentUnhealthyApplications?: ((number & string) | string)␊ - /**␊ - * The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10.␊ - * ␊ - * The percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error.␊ - * If the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning.␊ - * The percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster.␊ - * The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero.␊ - * ␊ - * In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that.␊ - * ␊ - */␊ - maxPercentUnhealthyNodes?: ((number & string) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines a health policy used to evaluate the health of an application or one of its children entities.␊ - * ␊ - */␊ - export interface ApplicationHealthPolicy1 {␊ - /**␊ - * Represents the health policy used to evaluate the health of services belonging to a service type.␊ - * ␊ - */␊ - defaultServiceTypeHealthPolicy?: (ServiceTypeHealthPolicy1 | string)␊ - /**␊ - * Defines a ServiceTypeHealthPolicy per service type name.␊ - * ␊ - * The entries in the map replace the default service type health policy for each specified service type.␊ - * For example, in an application that contains both a stateless gateway service type and a stateful engine service type, the health policies for the stateless and stateful services can be configured differently.␊ - * With policy per service type, there's more granular control of the health of the service.␊ - * ␊ - * If no policy is specified for a service type name, the DefaultServiceTypeHealthPolicy is used for evaluation.␊ - * ␊ - */␊ - serviceTypeHealthPolicies?: ({␊ - [k: string]: ServiceTypeHealthPolicy1␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents the health policy used to evaluate the health of services belonging to a service type.␊ - * ␊ - */␊ - export interface ServiceTypeHealthPolicy1 {␊ - /**␊ - * The maximum percentage of services allowed to be unhealthy before your application is considered in error.␊ - * ␊ - */␊ - maxPercentUnhealthyServices?: ((number & string) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceFabric/clusters/applicationTypes␊ - */␊ - export interface ClustersApplicationTypesChildResource1 {␊ - apiVersion: "2019-03-01-preview"␊ - /**␊ - * Azure resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the application type name resource.␊ - */␊ - name: string␊ - /**␊ - * The application type name properties␊ - */␊ - properties: (ApplicationTypeResourceProperties1 | string)␊ - /**␊ - * Azure resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "applicationTypes"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The application type name properties␊ - */␊ - export interface ApplicationTypeResourceProperties1 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceFabric/clusters/applications␊ - */␊ - export interface ClustersApplicationsChildResource1 {␊ - apiVersion: "2019-03-01-preview"␊ - /**␊ - * Azure resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the application resource.␊ - */␊ - name: string␊ - /**␊ - * The application resource properties.␊ - */␊ - properties: (ApplicationResourceProperties1 | string)␊ - /**␊ - * Azure resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "applications"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The application resource properties.␊ - */␊ - export interface ApplicationResourceProperties1 {␊ - /**␊ - * The maximum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. By default, the value of this property is zero and it means that the services can be placed on any node.␊ - */␊ - maximumNodes?: ((number & string) | string)␊ - /**␊ - * List of application capacity metric description.␊ - */␊ - metrics?: (ApplicationMetricDescription1[] | string)␊ - /**␊ - * The minimum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. If this property is set to zero, no capacity will be reserved. The value of this property cannot be more than the value of the MaximumNodes property.␊ - */␊ - minimumNodes?: (number | string)␊ - /**␊ - * List of application parameters with overridden values from their default values specified in the application manifest.␊ - */␊ - parameters?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Remove the current application capacity settings.␊ - */␊ - removeApplicationCapacity?: (boolean | string)␊ - /**␊ - * The application type name as defined in the application manifest.␊ - */␊ - typeName?: string␊ - /**␊ - * The version of the application type as defined in the application manifest.␊ - */␊ - typeVersion?: string␊ - /**␊ - * Describes the policy for a monitored application upgrade.␊ - */␊ - upgradePolicy?: (ApplicationUpgradePolicy1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes capacity information for a custom resource balancing metric. This can be used to limit the total consumption of this metric by the services of this application.␊ - * ␊ - */␊ - export interface ApplicationMetricDescription1 {␊ - /**␊ - * The maximum node capacity for Service Fabric application.␊ - * This is the maximum Load for an instance of this application on a single node. Even if the capacity of node is greater than this value, Service Fabric will limit the total load of services within the application on each node to this value.␊ - * If set to zero, capacity for this metric is unlimited on each node.␊ - * When creating a new application with application capacity defined, the product of MaximumNodes and this value must always be smaller than or equal to TotalApplicationCapacity.␊ - * When updating existing application with application capacity, the product of MaximumNodes and this value must always be smaller than or equal to TotalApplicationCapacity.␊ - * ␊ - */␊ - maximumCapacity?: (number | string)␊ - /**␊ - * The name of the metric.␊ - */␊ - name?: string␊ - /**␊ - * The node reservation capacity for Service Fabric application.␊ - * This is the amount of load which is reserved on nodes which have instances of this application.␊ - * If MinimumNodes is specified, then the product of these values will be the capacity reserved in the cluster for the application.␊ - * If set to zero, no capacity is reserved for this metric.␊ - * When setting application capacity or when updating application capacity; this value must be smaller than or equal to MaximumCapacity for each metric.␊ - * ␊ - */␊ - reservationCapacity?: (number | string)␊ - /**␊ - * The total metric capacity for Service Fabric application.␊ - * This is the total metric capacity for this application in the cluster. Service Fabric will try to limit the sum of loads of services within the application to this value.␊ - * When creating a new application with application capacity defined, the product of MaximumNodes and MaximumCapacity must always be smaller than or equal to this value.␊ - * ␊ - */␊ - totalApplicationCapacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the policy for a monitored application upgrade.␊ - */␊ - export interface ApplicationUpgradePolicy1 {␊ - /**␊ - * Defines a health policy used to evaluate the health of an application or one of its children entities.␊ - * ␊ - */␊ - applicationHealthPolicy?: (ArmApplicationHealthPolicy1 | string)␊ - /**␊ - * If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).␊ - */␊ - forceRestart?: (boolean | string)␊ - /**␊ - * The policy used for monitoring the application upgrade␊ - */␊ - rollingUpgradeMonitoringPolicy?: (ArmRollingUpgradeMonitoringPolicy1 | string)␊ - /**␊ - * The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer).␊ - */␊ - upgradeReplicaSetCheckTimeout?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines a health policy used to evaluate the health of an application or one of its children entities.␊ - * ␊ - */␊ - export interface ArmApplicationHealthPolicy1 {␊ - /**␊ - * Indicates whether warnings are treated with the same severity as errors.␊ - */␊ - considerWarningAsError?: (boolean | string)␊ - /**␊ - * Represents the health policy used to evaluate the health of services belonging to a service type.␊ - * ␊ - */␊ - defaultServiceTypeHealthPolicy?: (ArmServiceTypeHealthPolicy1 | string)␊ - /**␊ - * The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100.␊ - * The percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error.␊ - * This is calculated by dividing the number of unhealthy deployed applications over the number of nodes where the application is currently deployed on in the cluster.␊ - * The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero.␊ - * ␊ - */␊ - maxPercentUnhealthyDeployedApplications?: ((number & string) | string)␊ - /**␊ - * Defines a ServiceTypeHealthPolicy per service type name.␊ - * ␊ - * The entries in the map replace the default service type health policy for each specified service type.␊ - * For example, in an application that contains both a stateless gateway service type and a stateful engine service type, the health policies for the stateless and stateful services can be configured differently.␊ - * With policy per service type, there's more granular control of the health of the service.␊ - * ␊ - * If no policy is specified for a service type name, the DefaultServiceTypeHealthPolicy is used for evaluation.␊ - * ␊ - */␊ - serviceTypeHealthPolicyMap?: ({␊ - [k: string]: ArmServiceTypeHealthPolicy1␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents the health policy used to evaluate the health of services belonging to a service type.␊ - * ␊ - */␊ - export interface ArmServiceTypeHealthPolicy1 {␊ - /**␊ - * The maximum percentage of partitions per service allowed to be unhealthy before your application is considered in error.␊ - * ␊ - */␊ - maxPercentUnhealthyPartitionsPerService?: ((number & string) | string)␊ - /**␊ - * The maximum percentage of replicas per partition allowed to be unhealthy before your application is considered in error.␊ - * ␊ - */␊ - maxPercentUnhealthyReplicasPerPartition?: ((number & string) | string)␊ - /**␊ - * The maximum percentage of services allowed to be unhealthy before your application is considered in error.␊ - * ␊ - */␊ - maxPercentUnhealthyServices?: ((number & string) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The policy used for monitoring the application upgrade␊ - */␊ - export interface ArmRollingUpgradeMonitoringPolicy1 {␊ - /**␊ - * The activation Mode of the service package.␊ - */␊ - failureAction?: (("Rollback" | "Manual") | string)␊ - /**␊ - * The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.␊ - */␊ - healthCheckRetryTimeout?: string␊ - /**␊ - * The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.␊ - */␊ - healthCheckStableDuration?: string␊ - /**␊ - * The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.␊ - */␊ - healthCheckWaitDuration?: string␊ - /**␊ - * The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.␊ - */␊ - upgradeDomainTimeout?: string␊ - /**␊ - * The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.␊ - */␊ - upgradeTimeout?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceFabric/clusters/applications␊ - */␊ - export interface ClustersApplications1 {␊ - apiVersion: "2019-03-01-preview"␊ - /**␊ - * Azure resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the application resource.␊ - */␊ - name: string␊ - /**␊ - * The application resource properties.␊ - */␊ - properties: (ApplicationResourceProperties1 | string)␊ - resources?: ClustersApplicationsServicesChildResource1[]␊ - /**␊ - * Azure resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.ServiceFabric/clusters/applications"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceFabric/clusters/applications/services␊ - */␊ - export interface ClustersApplicationsServicesChildResource1 {␊ - apiVersion: "2019-03-01-preview"␊ - /**␊ - * Azure resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the service resource in the format of {applicationName}~{serviceName}.␊ - */␊ - name: string␊ - /**␊ - * The service resource properties.␊ - */␊ - properties: (ServiceResourceProperties1 | string)␊ - /**␊ - * Azure resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "services"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Creates a particular correlation between services.␊ - */␊ - export interface ServiceCorrelationDescription1 {␊ - /**␊ - * The ServiceCorrelationScheme which describes the relationship between this service and the service specified via ServiceName.␊ - */␊ - scheme: (("Invalid" | "Affinity" | "AlignedAffinity" | "NonAlignedAffinity") | string)␊ - /**␊ - * The full name of the service with 'fabric:' URI scheme.␊ - */␊ - serviceName: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SingletonPartitionSchemeDescription␊ - */␊ - export interface SingletonPartitionSchemeDescription1 {␊ - partitionScheme: "Singleton"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies a metric to load balance a service during runtime.␊ - */␊ - export interface ServiceLoadMetricDescription1 {␊ - /**␊ - * Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric.␊ - */␊ - defaultLoad?: (number | string)␊ - /**␊ - * The name of the metric. If the service chooses to report load during runtime, the load metric name should match the name that is specified in Name exactly. Note that metric names are case sensitive.␊ - */␊ - name: string␊ - /**␊ - * Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Primary replica.␊ - */␊ - primaryDefaultLoad?: (number | string)␊ - /**␊ - * Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Secondary replica.␊ - */␊ - secondaryDefaultLoad?: (number | string)␊ - /**␊ - * The service load metric relative weight, compared to other metrics configured for this service, as a number.␊ - */␊ - weight?: (("Zero" | "Low" | "Medium" | "High") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the policy to be used for placement of a Service Fabric service.␊ - */␊ - export interface ServicePlacementPolicyDescription1 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a stateful service resource.␊ - */␊ - export interface StatefulServiceProperties1 {␊ - /**␊ - * A flag indicating whether this is a persistent service which stores states on the local disk. If it is then the value of this property is true, if not it is false.␊ - */␊ - hasPersistedState?: (boolean | string)␊ - /**␊ - * The minimum replica set size as a number.␊ - */␊ - minReplicaSetSize?: (number | string)␊ - /**␊ - * The maximum duration for which a partition is allowed to be in a state of quorum loss, represented in ISO 8601 format (hh:mm:ss.s).␊ - */␊ - quorumLossWaitDuration?: string␊ - /**␊ - * The duration between when a replica goes down and when a new replica is created, represented in ISO 8601 format (hh:mm:ss.s).␊ - */␊ - replicaRestartWaitDuration?: string␊ - serviceKind: "Stateful"␊ - /**␊ - * The definition on how long StandBy replicas should be maintained before being removed, represented in ISO 8601 format (hh:mm:ss.s).␊ - */␊ - standByReplicaKeepDuration?: string␊ - /**␊ - * The target replica set size as a number.␊ - */␊ - targetReplicaSetSize?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a stateless service resource.␊ - */␊ - export interface StatelessServiceProperties1 {␊ - /**␊ - * The instance count.␊ - */␊ - instanceCount?: (number | string)␊ - serviceKind: "Stateless"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceFabric/clusters/applications/services␊ - */␊ - export interface ClustersApplicationsServices1 {␊ - apiVersion: "2019-03-01-preview"␊ - /**␊ - * Azure resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the service resource in the format of {applicationName}~{serviceName}.␊ - */␊ - name: string␊ - /**␊ - * The service resource properties.␊ - */␊ - properties: ((StatefulServiceProperties1 | StatelessServiceProperties1) | string)␊ - /**␊ - * Azure resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.ServiceFabric/clusters/applications/services"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceFabric/clusters/applicationTypes␊ - */␊ - export interface ClustersApplicationTypes1 {␊ - apiVersion: "2019-03-01-preview"␊ - /**␊ - * Azure resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the application type name resource.␊ - */␊ - name: string␊ - /**␊ - * The application type name properties␊ - */␊ - properties: (ApplicationTypeResourceProperties1 | string)␊ - resources?: ClustersApplicationTypesVersionsChildResource1[]␊ - /**␊ - * Azure resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.ServiceFabric/clusters/applicationTypes"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceFabric/clusters/applicationTypes/versions␊ - */␊ - export interface ClustersApplicationTypesVersionsChildResource1 {␊ - apiVersion: "2019-03-01-preview"␊ - /**␊ - * Azure resource location.␊ - */␊ - location?: string␊ - /**␊ - * The application type version.␊ - */␊ - name: string␊ - /**␊ - * The properties of the application type version resource.␊ - */␊ - properties: (ApplicationTypeVersionResourceProperties1 | string)␊ - /**␊ - * Azure resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "versions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the application type version resource.␊ - */␊ - export interface ApplicationTypeVersionResourceProperties1 {␊ - /**␊ - * The URL to the application package␊ - */␊ - appPackageUrl: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceFabric/clusters/applicationTypes/versions␊ - */␊ - export interface ClustersApplicationTypesVersions1 {␊ - apiVersion: "2019-03-01-preview"␊ - /**␊ - * Azure resource location.␊ - */␊ - location?: string␊ - /**␊ - * The application type version.␊ - */␊ - name: string␊ - /**␊ - * The properties of the application type version resource.␊ - */␊ - properties: (ApplicationTypeVersionResourceProperties1 | string)␊ - /**␊ - * Azure resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.ServiceFabric/clusters/applicationTypes/versions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.StorSimple/managers␊ - */␊ - export interface Managers {␊ - apiVersion: "2017-06-01"␊ - /**␊ - * The etag of the manager.␊ - */␊ - etag?: string␊ - /**␊ - * The geo location of the resource.␊ - */␊ - location: string␊ - /**␊ - * The manager name␊ - */␊ - name: string␊ - /**␊ - * The properties of the StorSimple Manager.␊ - */␊ - properties: (ManagerProperties | string)␊ - resources?: (ManagersExtendedInformationChildResource | ManagersAccessControlRecordsChildResource | ManagersBandwidthSettingsChildResource | ManagersStorageAccountCredentialsChildResource)[]␊ - /**␊ - * The tags attached to the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.StorSimple/managers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the StorSimple Manager.␊ - */␊ - export interface ManagerProperties {␊ - /**␊ - * Intrinsic settings which refers to the type of the StorSimple Manager.␊ - */␊ - cisIntrinsicSettings?: (ManagerIntrinsicSettings | string)␊ - /**␊ - * Specifies the state of the resource as it is getting provisioned. Value of "Succeeded" means the Manager was successfully created.␊ - */␊ - provisioningState?: string␊ - /**␊ - * The Sku.␊ - */␊ - sku?: (ManagerSku | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Intrinsic settings which refers to the type of the StorSimple Manager.␊ - */␊ - export interface ManagerIntrinsicSettings {␊ - /**␊ - * The type of StorSimple Manager.␊ - */␊ - type: (("GardaV1" | "HelsinkiV1") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Sku.␊ - */␊ - export interface ManagerSku {␊ - /**␊ - * Refers to the sku name which should be "Standard"␊ - */␊ - name: ("Standard" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.StorSimple/managers/extendedInformation␊ - */␊ - export interface ManagersExtendedInformationChildResource {␊ - apiVersion: "2017-06-01"␊ - /**␊ - * The etag of the resource.␊ - */␊ - etag?: string␊ - /**␊ - * The Kind of the object. Currently only Series8000 is supported.␊ - */␊ - kind?: ("Series8000" | string)␊ - name: "vaultExtendedInfo"␊ - /**␊ - * The properties of the manager extended info.␊ - */␊ - properties: (ManagerExtendedInfoProperties | string)␊ - type: "extendedInformation"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the manager extended info.␊ - */␊ - export interface ManagerExtendedInfoProperties {␊ - /**␊ - * Represents the encryption algorithm used to encrypt the keys. None - if Key is saved in plain text format. Algorithm name - if key is encrypted␊ - */␊ - algorithm: string␊ - /**␊ - * Represents the CEK of the resource.␊ - */␊ - encryptionKey?: string␊ - /**␊ - * Represents the Cert thumbprint that was used to encrypt the CEK.␊ - */␊ - encryptionKeyThumbprint?: string␊ - /**␊ - * Represents the CIK of the resource.␊ - */␊ - integrityKey: string␊ - /**␊ - * Represents the portal thumbprint which can be used optionally to encrypt the entire data before storing it.␊ - */␊ - portalCertificateThumbprint?: string␊ - /**␊ - * The version of the extended info being persisted.␊ - */␊ - version?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.StorSimple/managers/accessControlRecords␊ - */␊ - export interface ManagersAccessControlRecordsChildResource {␊ - apiVersion: "2017-06-01"␊ - /**␊ - * The Kind of the object. Currently only Series8000 is supported.␊ - */␊ - kind?: ("Series8000" | string)␊ - /**␊ - * The name of the access control record.␊ - */␊ - name: string␊ - /**␊ - * The properties of access control record.␊ - */␊ - properties: (AccessControlRecordProperties | string)␊ - type: "accessControlRecords"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of access control record.␊ - */␊ - export interface AccessControlRecordProperties {␊ - /**␊ - * The iSCSI initiator name (IQN).␊ - */␊ - initiatorName: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.StorSimple/managers/bandwidthSettings␊ - */␊ - export interface ManagersBandwidthSettingsChildResource {␊ - apiVersion: "2017-06-01"␊ - /**␊ - * The Kind of the object. Currently only Series8000 is supported.␊ - */␊ - kind?: ("Series8000" | string)␊ - /**␊ - * The bandwidth setting name.␊ - */␊ - name: string␊ - /**␊ - * The properties of the bandwidth setting.␊ - */␊ - properties: (BandwidthRateSettingProperties | string)␊ - type: "bandwidthSettings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the bandwidth setting.␊ - */␊ - export interface BandwidthRateSettingProperties {␊ - /**␊ - * The schedules.␊ - */␊ - schedules: (BandwidthSchedule[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The schedule for bandwidth setting.␊ - */␊ - export interface BandwidthSchedule {␊ - /**␊ - * The days of the week when this schedule is applicable.␊ - */␊ - days: (("Sunday" | "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday")[] | string)␊ - /**␊ - * The rate in Mbps.␊ - */␊ - rateInMbps: (number | string)␊ - /**␊ - * The time.␊ - */␊ - start: (Time | string)␊ - /**␊ - * The time.␊ - */␊ - stop: (Time | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The time.␊ - */␊ - export interface Time {␊ - /**␊ - * The hour.␊ - */␊ - hours: (number | string)␊ - /**␊ - * The minute.␊ - */␊ - minutes: (number | string)␊ - /**␊ - * The second.␊ - */␊ - seconds: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.StorSimple/managers/storageAccountCredentials␊ - */␊ - export interface ManagersStorageAccountCredentialsChildResource {␊ - apiVersion: "2017-06-01"␊ - /**␊ - * The Kind of the object. Currently only Series8000 is supported.␊ - */␊ - kind?: ("Series8000" | string)␊ - /**␊ - * The storage account credential name.␊ - */␊ - name: string␊ - /**␊ - * The storage account credential properties.␊ - */␊ - properties: (StorageAccountCredentialProperties | string)␊ - type: "storageAccountCredentials"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The storage account credential properties.␊ - */␊ - export interface StorageAccountCredentialProperties {␊ - /**␊ - * Represent the secrets intended for encryption with asymmetric key pair.␊ - */␊ - accessKey?: (AsymmetricEncryptedSecret | string)␊ - /**␊ - * The storage endpoint␊ - */␊ - endPoint: string␊ - /**␊ - * Signifies whether SSL needs to be enabled or not.␊ - */␊ - sslStatus: (("Enabled" | "Disabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represent the secrets intended for encryption with asymmetric key pair.␊ - */␊ - export interface AsymmetricEncryptedSecret {␊ - /**␊ - * The algorithm used to encrypt "Value".␊ - */␊ - encryptionAlgorithm: (("None" | "AES256" | "RSAES_PKCS1_v_1_5") | string)␊ - /**␊ - * Thumbprint certificate that was used to encrypt "Value". If the value in unencrypted, it will be null.␊ - */␊ - encryptionCertThumbprint?: string␊ - /**␊ - * The value of the secret.␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.StorSimple/managers/accessControlRecords␊ - */␊ - export interface ManagersAccessControlRecords {␊ - apiVersion: "2017-06-01"␊ - /**␊ - * The Kind of the object. Currently only Series8000 is supported.␊ - */␊ - kind?: ("Series8000" | string)␊ - /**␊ - * The name of the access control record.␊ - */␊ - name: string␊ - /**␊ - * The properties of access control record.␊ - */␊ - properties: (AccessControlRecordProperties | string)␊ - type: "Microsoft.StorSimple/managers/accessControlRecords"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.StorSimple/managers/bandwidthSettings␊ - */␊ - export interface ManagersBandwidthSettings {␊ - apiVersion: "2017-06-01"␊ - /**␊ - * The Kind of the object. Currently only Series8000 is supported.␊ - */␊ - kind?: ("Series8000" | string)␊ - /**␊ - * The bandwidth setting name.␊ - */␊ - name: string␊ - /**␊ - * The properties of the bandwidth setting.␊ - */␊ - properties: (BandwidthRateSettingProperties | string)␊ - type: "Microsoft.StorSimple/managers/bandwidthSettings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.StorSimple/managers/devices/alertSettings␊ - */␊ - export interface ManagersDevicesAlertSettings {␊ - apiVersion: "2017-06-01"␊ - /**␊ - * The Kind of the object. Currently only Series8000 is supported.␊ - */␊ - kind?: ("Series8000" | string)␊ - name: string␊ - /**␊ - * The properties of the alert notification settings.␊ - */␊ - properties: (AlertNotificationProperties | string)␊ - type: "Microsoft.StorSimple/managers/devices/alertSettings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the alert notification settings.␊ - */␊ - export interface AlertNotificationProperties {␊ - /**␊ - * The alert notification email list.␊ - */␊ - additionalRecipientEmailList?: (string[] | string)␊ - /**␊ - * The alert notification culture.␊ - */␊ - alertNotificationCulture?: string␊ - /**␊ - * Indicates whether email notification enabled or not.␊ - */␊ - emailNotification: (("Enabled" | "Disabled") | string)␊ - /**␊ - * The value indicating whether alert notification enabled for admin or not.␊ - */␊ - notificationToServiceOwners?: (("Enabled" | "Disabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.StorSimple/managers/devices/backupPolicies␊ - */␊ - export interface ManagersDevicesBackupPolicies {␊ - apiVersion: "2017-06-01"␊ - /**␊ - * The Kind of the object. Currently only Series8000 is supported.␊ - */␊ - kind?: ("Series8000" | string)␊ - /**␊ - * The name of the backup policy to be created/updated.␊ - */␊ - name: string␊ - /**␊ - * The properties of the backup policy.␊ - */␊ - properties: (BackupPolicyProperties | string)␊ - resources?: ManagersDevicesBackupPoliciesSchedulesChildResource[]␊ - type: "Microsoft.StorSimple/managers/devices/backupPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the backup policy.␊ - */␊ - export interface BackupPolicyProperties {␊ - /**␊ - * The path IDs of the volumes which are part of the backup policy.␊ - */␊ - volumeIds: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.StorSimple/managers/devices/backupPolicies/schedules␊ - */␊ - export interface ManagersDevicesBackupPoliciesSchedulesChildResource {␊ - apiVersion: "2017-06-01"␊ - /**␊ - * The Kind of the object. Currently only Series8000 is supported.␊ - */␊ - kind?: ("Series8000" | string)␊ - /**␊ - * The backup schedule name.␊ - */␊ - name: string␊ - /**␊ - * The properties of the backup schedule.␊ - */␊ - properties: (BackupScheduleProperties | string)␊ - type: "schedules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the backup schedule.␊ - */␊ - export interface BackupScheduleProperties {␊ - /**␊ - * The type of backup which needs to be taken.␊ - */␊ - backupType: (("LocalSnapshot" | "CloudSnapshot") | string)␊ - /**␊ - * The number of backups to be retained.␊ - */␊ - retentionCount: (number | string)␊ - /**␊ - * The schedule recurrence.␊ - */␊ - scheduleRecurrence: (ScheduleRecurrence | string)␊ - /**␊ - * The schedule status.␊ - */␊ - scheduleStatus: (("Enabled" | "Disabled") | string)␊ - /**␊ - * The start time of the schedule.␊ - */␊ - startTime: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The schedule recurrence.␊ - */␊ - export interface ScheduleRecurrence {␊ - /**␊ - * The recurrence type.␊ - */␊ - recurrenceType: (("Minutes" | "Hourly" | "Daily" | "Weekly") | string)␊ - /**␊ - * The recurrence value.␊ - */␊ - recurrenceValue: (number | string)␊ - /**␊ - * The week days list. Applicable only for schedules of recurrence type 'weekly'.␊ - */␊ - weeklyDaysList?: (("Sunday" | "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday")[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.StorSimple/managers/devices/backupPolicies/schedules␊ - */␊ - export interface ManagersDevicesBackupPoliciesSchedules {␊ - apiVersion: "2017-06-01"␊ - /**␊ - * The Kind of the object. Currently only Series8000 is supported.␊ - */␊ - kind?: ("Series8000" | string)␊ - /**␊ - * The backup schedule name.␊ - */␊ - name: string␊ - /**␊ - * The properties of the backup schedule.␊ - */␊ - properties: (BackupScheduleProperties | string)␊ - type: "Microsoft.StorSimple/managers/devices/backupPolicies/schedules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.StorSimple/managers/devices/timeSettings␊ - */␊ - export interface ManagersDevicesTimeSettings {␊ - apiVersion: "2017-06-01"␊ - /**␊ - * The Kind of the object. Currently only Series8000 is supported.␊ - */␊ - kind?: ("Series8000" | string)␊ - name: string␊ - /**␊ - * The properties of time settings of a device.␊ - */␊ - properties: (TimeSettingsProperties | string)␊ - type: "Microsoft.StorSimple/managers/devices/timeSettings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of time settings of a device.␊ - */␊ - export interface TimeSettingsProperties {␊ - /**␊ - * The primary Network Time Protocol (NTP) server name, like 'time.windows.com'.␊ - */␊ - primaryTimeServer?: string␊ - /**␊ - * The secondary Network Time Protocol (NTP) server name, like 'time.contoso.com'. It's optional.␊ - */␊ - secondaryTimeServer?: (string[] | string)␊ - /**␊ - * The timezone of device, like '(UTC -06:00) Central America'␊ - */␊ - timeZone: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.StorSimple/managers/devices/volumeContainers␊ - */␊ - export interface ManagersDevicesVolumeContainers {␊ - apiVersion: "2017-06-01"␊ - /**␊ - * The Kind of the object. Currently only Series8000 is supported.␊ - */␊ - kind?: ("Series8000" | string)␊ - /**␊ - * The name of the volume container.␊ - */␊ - name: string␊ - /**␊ - * The properties of volume container.␊ - */␊ - properties: (VolumeContainerProperties | string)␊ - resources?: ManagersDevicesVolumeContainersVolumesChildResource[]␊ - type: "Microsoft.StorSimple/managers/devices/volumeContainers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of volume container.␊ - */␊ - export interface VolumeContainerProperties {␊ - /**␊ - * The bandwidth-rate set on the volume container.␊ - */␊ - bandWidthRateInMbps?: (number | string)␊ - /**␊ - * The ID of the bandwidth setting associated with the volume container.␊ - */␊ - bandwidthSettingId?: string␊ - /**␊ - * Represent the secrets intended for encryption with asymmetric key pair.␊ - */␊ - encryptionKey?: (AsymmetricEncryptedSecret | string)␊ - /**␊ - * The path ID of storage account associated with the volume container.␊ - */␊ - storageAccountCredentialId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.StorSimple/managers/devices/volumeContainers/volumes␊ - */␊ - export interface ManagersDevicesVolumeContainersVolumesChildResource {␊ - apiVersion: "2017-06-01"␊ - /**␊ - * The Kind of the object. Currently only Series8000 is supported.␊ - */␊ - kind?: ("Series8000" | string)␊ - /**␊ - * The volume name.␊ - */␊ - name: string␊ - /**␊ - * The properties of volume.␊ - */␊ - properties: (VolumeProperties | string)␊ - type: "volumes"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of volume.␊ - */␊ - export interface VolumeProperties {␊ - /**␊ - * The IDs of the access control records, associated with the volume.␊ - */␊ - accessControlRecordIds: (string[] | string)␊ - /**␊ - * The monitoring status of the volume.␊ - */␊ - monitoringStatus: (("Enabled" | "Disabled") | string)␊ - /**␊ - * The size of the volume in bytes.␊ - */␊ - sizeInBytes: (number | string)␊ - /**␊ - * The volume status.␊ - */␊ - volumeStatus: (("Online" | "Offline") | string)␊ - /**␊ - * The type of the volume.␊ - */␊ - volumeType: (("Tiered" | "Archival" | "LocallyPinned") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.StorSimple/managers/devices/volumeContainers/volumes␊ - */␊ - export interface ManagersDevicesVolumeContainersVolumes {␊ - apiVersion: "2017-06-01"␊ - /**␊ - * The Kind of the object. Currently only Series8000 is supported.␊ - */␊ - kind?: ("Series8000" | string)␊ - /**␊ - * The volume name.␊ - */␊ - name: string␊ - /**␊ - * The properties of volume.␊ - */␊ - properties: (VolumeProperties | string)␊ - type: "Microsoft.StorSimple/managers/devices/volumeContainers/volumes"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.StorSimple/managers/extendedInformation␊ - */␊ - export interface ManagersExtendedInformation {␊ - apiVersion: "2017-06-01"␊ - /**␊ - * The etag of the resource.␊ - */␊ - etag?: string␊ - /**␊ - * The Kind of the object. Currently only Series8000 is supported.␊ - */␊ - kind?: ("Series8000" | string)␊ - name: string␊ - /**␊ - * The properties of the manager extended info.␊ - */␊ - properties: (ManagerExtendedInfoProperties | string)␊ - type: "Microsoft.StorSimple/managers/extendedInformation"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.StorSimple/managers/storageAccountCredentials␊ - */␊ - export interface ManagersStorageAccountCredentials {␊ - apiVersion: "2017-06-01"␊ - /**␊ - * The Kind of the object. Currently only Series8000 is supported.␊ - */␊ - kind?: ("Series8000" | string)␊ - /**␊ - * The storage account credential name.␊ - */␊ - name: string␊ - /**␊ - * The storage account credential properties.␊ - */␊ - properties: (StorageAccountCredentialProperties | string)␊ - type: "Microsoft.StorSimple/managers/storageAccountCredentials"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Resources/deployments␊ - */␊ - export interface Deployments {␊ - apiVersion: "2016-09-01"␊ - /**␊ - * The name of the deployment.␊ - */␊ - name: string␊ - /**␊ - * Deployment properties.␊ - */␊ - properties: (DeploymentProperties | string)␊ - type: "Microsoft.Resources/deployments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Deployment properties.␊ - */␊ - export interface DeploymentProperties {␊ - debugSetting?: (DebugSetting | string)␊ - /**␊ - * The mode that is used to deploy resources. This value can be either Incremental or Complete. In Incremental mode, resources are deployed without deleting existing resources that are not included in the template. In Complete mode, resources are deployed and existing resources in the resource group that are not included in the template are deleted. Be careful when using Complete mode as you may unintentionally delete resources.␊ - */␊ - mode: (("Incremental" | "Complete") | string)␊ - /**␊ - * Name and value pairs that define the deployment parameters for the template. You use this element when you want to provide the parameter values directly in the request rather than link to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. It can be a JObject or a well formed JSON string.␊ - */␊ - parameters?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Entity representing the reference to the deployment parameters.␊ - */␊ - parametersLink?: (ParametersLink | string)␊ - /**␊ - * The template content. You use this element when you want to pass the template syntax directly in the request rather than link to an existing template. It can be a JObject or well-formed JSON string. Use either the templateLink property or the template property, but not both.␊ - */␊ - template?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Entity representing the reference to the template.␊ - */␊ - templateLink?: (TemplateLink | string)␊ - [k: string]: unknown␊ - }␊ - export interface DebugSetting {␊ - /**␊ - * Specifies the type of information to log for debugging. The permitted values are none, requestContent, responseContent, or both requestContent and responseContent separated by a comma. The default is none. When setting this value, carefully consider the type of information you are passing in during deployment. By logging information about the request or response, you could potentially expose sensitive data that is retrieved through the deployment operations.␊ - */␊ - detailLevel?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Entity representing the reference to the deployment parameters.␊ - */␊ - export interface ParametersLink {␊ - /**␊ - * If included, must match the ContentVersion in the template.␊ - */␊ - contentVersion?: string␊ - /**␊ - * The URI of the parameters file.␊ - */␊ - uri: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Entity representing the reference to the template.␊ - */␊ - export interface TemplateLink {␊ - /**␊ - * If included, must match the ContentVersion in the template.␊ - */␊ - contentVersion?: string␊ - /**␊ - * The URI of the template to deploy.␊ - */␊ - uri: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Resources/deployments␊ - */␊ - export interface Deployments1 {␊ - apiVersion: "2017-05-10"␊ - /**␊ - * The name of the deployment.␊ - */␊ - name: string␊ - /**␊ - * Deployment properties.␊ - */␊ - properties: (DeploymentProperties1 | string)␊ - type: "Microsoft.Resources/deployments"␊ - /**␊ - * The resource group to deploy to␊ - */␊ - resourceGroup?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Deployment properties.␊ - */␊ - export interface DeploymentProperties1 {␊ - debugSetting?: (DebugSetting1 | string)␊ - /**␊ - * The mode that is used to deploy resources. This value can be either Incremental or Complete. In Incremental mode, resources are deployed without deleting existing resources that are not included in the template. In Complete mode, resources are deployed and existing resources in the resource group that are not included in the template are deleted. Be careful when using Complete mode as you may unintentionally delete resources.␊ - */␊ - mode: (("Incremental" | "Complete") | string)␊ - /**␊ - * Name and value pairs that define the deployment parameters for the template. You use this element when you want to provide the parameter values directly in the request rather than link to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. It can be a JObject or a well formed JSON string.␊ - */␊ - parameters?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Entity representing the reference to the deployment parameters.␊ - */␊ - parametersLink?: (ParametersLink1 | string)␊ - /**␊ - * The template content. You use this element when you want to pass the template syntax directly in the request rather than link to an existing template. It can be a JObject or well-formed JSON string. Use either the templateLink property or the template property, but not both.␊ - */␊ - template?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Entity representing the reference to the template.␊ - */␊ - templateLink?: (TemplateLink1 | string)␊ - [k: string]: unknown␊ - }␊ - export interface DebugSetting1 {␊ - /**␊ - * Specifies the type of information to log for debugging. The permitted values are none, requestContent, responseContent, or both requestContent and responseContent separated by a comma. The default is none. When setting this value, carefully consider the type of information you are passing in during deployment. By logging information about the request or response, you could potentially expose sensitive data that is retrieved through the deployment operations.␊ - */␊ - detailLevel?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Entity representing the reference to the deployment parameters.␊ - */␊ - export interface ParametersLink1 {␊ - /**␊ - * If included, must match the ContentVersion in the template.␊ - */␊ - contentVersion?: string␊ - /**␊ - * The URI of the parameters file.␊ - */␊ - uri: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Entity representing the reference to the template.␊ - */␊ - export interface TemplateLink1 {␊ - /**␊ - * If included, must match the ContentVersion in the template.␊ - */␊ - contentVersion?: string␊ - /**␊ - * The URI of the template to deploy.␊ - */␊ - uri: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Solutions/applianceDefinitions␊ - */␊ - export interface ApplianceDefinitions {␊ - apiVersion: "2016-09-01-preview"␊ - /**␊ - * Identity for the resource.␊ - */␊ - identity?: (Identity17 | string)␊ - /**␊ - * Resource location␊ - */␊ - location?: string␊ - /**␊ - * ID of the resource that manages this resource.␊ - */␊ - managedBy?: string␊ - /**␊ - * The name of the appliance definition.␊ - */␊ - name: string␊ - /**␊ - * The appliance definition properties.␊ - */␊ - properties: (ApplianceDefinitionProperties | string)␊ - /**␊ - * SKU for the resource.␊ - */␊ - sku?: (Sku33 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Solutions/applianceDefinitions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the resource.␊ - */␊ - export interface Identity17 {␊ - /**␊ - * The identity type.␊ - */␊ - type?: ("SystemAssigned" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The appliance definition properties.␊ - */␊ - export interface ApplianceDefinitionProperties {␊ - /**␊ - * The collection of appliance artifacts. The portal will use the files specified as artifacts to construct the user experience of creating an appliance from an appliance definition.␊ - */␊ - artifacts?: (ApplianceArtifact[] | string)␊ - /**␊ - * The appliance provider authorizations.␊ - */␊ - authorizations: (ApplianceProviderAuthorization[] | string)␊ - /**␊ - * The appliance definition description.␊ - */␊ - description?: string␊ - /**␊ - * The appliance definition display name.␊ - */␊ - displayName?: string␊ - /**␊ - * The appliance lock level.␊ - */␊ - lockLevel: (("CanNotDelete" | "ReadOnly" | "None") | string)␊ - /**␊ - * The appliance definition package file Uri.␊ - */␊ - packageFileUri: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Appliance artifact.␊ - */␊ - export interface ApplianceArtifact {␊ - /**␊ - * The appliance artifact name.␊ - */␊ - name?: string␊ - /**␊ - * The appliance artifact type.␊ - */␊ - type?: (("Template" | "Custom") | string)␊ - /**␊ - * The appliance artifact blob uri.␊ - */␊ - uri?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The appliance provider authorization.␊ - */␊ - export interface ApplianceProviderAuthorization {␊ - /**␊ - * The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the appliance resources.␊ - */␊ - principalId: string␊ - /**␊ - * The provider's role definition identifier. This role will define all the permissions that the provider must have on the appliance's container resource group. This role definition cannot have permission to delete the resource group.␊ - */␊ - roleDefinitionId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU for the resource.␊ - */␊ - export interface Sku33 {␊ - /**␊ - * The SKU capacity.␊ - */␊ - capacity?: (number | string)␊ - /**␊ - * The SKU family.␊ - */␊ - family?: string␊ - /**␊ - * The SKU model.␊ - */␊ - model?: string␊ - /**␊ - * The SKU name.␊ - */␊ - name: string␊ - /**␊ - * The SKU size.␊ - */␊ - size?: string␊ - /**␊ - * The SKU tier.␊ - */␊ - tier?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Solutions/appliances␊ - */␊ - export interface Appliances {␊ - apiVersion: "2016-09-01-preview"␊ - /**␊ - * Identity for the resource.␊ - */␊ - identity?: (Identity17 | string)␊ - /**␊ - * The kind of the appliance. Allowed values are MarketPlace and ServiceCatalog.␊ - */␊ - kind?: string␊ - /**␊ - * Resource location␊ - */␊ - location?: string␊ - /**␊ - * ID of the resource that manages this resource.␊ - */␊ - managedBy?: string␊ - /**␊ - * The name of the appliance.␊ - */␊ - name: string␊ - /**␊ - * Plan for the appliance.␊ - */␊ - plan?: (Plan | string)␊ - /**␊ - * The appliance properties.␊ - */␊ - properties: (ApplianceProperties | string)␊ - /**␊ - * SKU for the resource.␊ - */␊ - sku?: (Sku33 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Solutions/appliances"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Plan for the appliance.␊ - */␊ - export interface Plan {␊ - /**␊ - * The plan name.␊ - */␊ - name: string␊ - /**␊ - * The product code.␊ - */␊ - product: string␊ - /**␊ - * The promotion code.␊ - */␊ - promotionCode?: string␊ - /**␊ - * The publisher ID.␊ - */␊ - publisher: string␊ - /**␊ - * The plan's version.␊ - */␊ - version: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The appliance properties.␊ - */␊ - export interface ApplianceProperties {␊ - /**␊ - * The fully qualified path of appliance definition Id.␊ - */␊ - applianceDefinitionId?: string␊ - /**␊ - * The managed resource group Id.␊ - */␊ - managedResourceGroupId: string␊ - /**␊ - * Name and value pairs that define the appliance parameters. It can be a JObject or a well formed JSON string.␊ - */␊ - parameters?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The blob URI where the UI definition file is located.␊ - */␊ - uiDefinitionUri?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service␊ - */␊ - export interface Service {␊ - apiVersion: "2016-07-07"␊ - /**␊ - * ETag of the resource.␊ - */␊ - etag?: string␊ - /**␊ - * Datacenter location of the API Management service.␊ - */␊ - location: string␊ - /**␊ - * The name of the API Management service.␊ - */␊ - name: string␊ - /**␊ - * Properties of an API Management service resource description.␊ - */␊ - properties: (ApiManagementServiceProperties | string)␊ - resources?: (ServiceApisChildResource | ServiceSubscriptionsChildResource | ServiceProductsChildResource | ServiceGroupsChildResource | ServiceCertificatesChildResource | ServiceUsersChildResource | ServiceAuthorizationServersChildResource | ServiceLoggersChildResource | ServicePropertiesChildResource | ServiceOpenidConnectProvidersChildResource | ServiceBackendsChildResource | ServiceIdentityProvidersChildResource)[]␊ - /**␊ - * API Management service resource SKU properties.␊ - */␊ - sku?: (ApiManagementServiceSkuProperties | string)␊ - /**␊ - * API Management service tags. A maximum of 10 tags can be provided for a resource, and each tag must have a key no greater than 128 characters (and a value no greater than 256 characters).␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.ApiManagement/service"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of an API Management service resource description.␊ - */␊ - export interface ApiManagementServiceProperties {␊ - /**␊ - * Additional datacenter locations of the API Management service.␊ - */␊ - additionalLocations?: (AdditionalRegion[] | string)␊ - /**␊ - * Addresser email.␊ - */␊ - addresserEmail?: string␊ - /**␊ - * Custom properties of the API Management service, like disabling TLS 1.0.␊ - */␊ - customProperties?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Custom hostname configuration of the API Management service.␊ - */␊ - hostnameConfigurations?: (HostnameConfiguration[] | string)␊ - /**␊ - * Publisher email.␊ - */␊ - publisherEmail: string␊ - /**␊ - * Publisher name.␊ - */␊ - publisherName: string␊ - /**␊ - * Configuration of a virtual network to which API Management service is deployed.␊ - */␊ - vpnconfiguration?: (VirtualNetworkConfiguration6 | string)␊ - /**␊ - * The type of VPN in which API Management service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only.␊ - */␊ - vpnType?: (("None" | "External" | "Internal") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of an additional API Management resource location.␊ - */␊ - export interface AdditionalRegion {␊ - /**␊ - * The location name of the additional region among Azure Data center regions.␊ - */␊ - location: string␊ - /**␊ - * The SKU type in the location.␊ - */␊ - skuType: (("Developer" | "Standard" | "Premium") | string)␊ - /**␊ - * The SKU Unit count at the location. The maximum SKU Unit count depends on the SkuType. Maximum allowed for Developer SKU is 1, for Standard SKU is 4, and for Premium SKU is 10, at a location.␊ - */␊ - skuUnitCount?: ((number & string) | string)␊ - /**␊ - * Configuration of a virtual network to which API Management service is deployed.␊ - */␊ - vpnconfiguration?: (VirtualNetworkConfiguration6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Configuration of a virtual network to which API Management service is deployed.␊ - */␊ - export interface VirtualNetworkConfiguration6 {␊ - /**␊ - * The location of the virtual network.␊ - */␊ - location?: string␊ - /**␊ - * The name of the subnet Resource ID. This has format /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft.{Network|ClassicNetwork}/VirtualNetworks/{virtual network name}/subnets/{subnet name}.␊ - */␊ - subnetResourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Custom hostname configuration.␊ - */␊ - export interface HostnameConfiguration {␊ - /**␊ - * SSL certificate information.␊ - */␊ - certificate: (CertificateInformation | string)␊ - /**␊ - * Hostname.␊ - */␊ - hostname: string␊ - /**␊ - * Hostname type.␊ - */␊ - type: (("Proxy" | "Portal" | "Management" | "Scm") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSL certificate information.␊ - */␊ - export interface CertificateInformation {␊ - /**␊ - * Expiration date of the certificate. The date conforms to the following format: \`yyyy-MM-ddTHH:mm:ssZ\` as specified by the ISO 8601 standard.␊ - */␊ - expiry: string␊ - /**␊ - * Subject of the certificate.␊ - */␊ - subject: string␊ - /**␊ - * Thumbprint of the certificate.␊ - */␊ - thumbprint: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis␊ - */␊ - export interface ServiceApisChildResource {␊ - apiVersion: "2016-07-07"␊ - /**␊ - * API Authentication Settings.␊ - */␊ - authenticationSettings?: (AuthenticationSettingsContract | string)␊ - /**␊ - * Description of the API. May include HTML formatting tags.␊ - */␊ - description?: string␊ - /**␊ - * API identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.␊ - */␊ - path: string␊ - /**␊ - * Describes on which protocols the operations in this API can be invoked.␊ - */␊ - protocols: (("Http" | "Https")[] | string)␊ - /**␊ - * Absolute URL of the backend service implementing this API.␊ - */␊ - serviceUrl: string␊ - /**␊ - * Subscription key parameter names details.␊ - */␊ - subscriptionKeyParameterNames?: (SubscriptionKeyParameterNamesContract | string)␊ - type: "apis"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * API Authentication Settings.␊ - */␊ - export interface AuthenticationSettingsContract {␊ - /**␊ - * API OAuth2 Authentication settings details.␊ - */␊ - oAuth2?: (OAuth2AuthenticationSettingsContract | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * API OAuth2 Authentication settings details.␊ - */␊ - export interface OAuth2AuthenticationSettingsContract {␊ - /**␊ - * OAuth authorization server identifier.␊ - */␊ - authorizationServerId?: string␊ - /**␊ - * operations scope.␊ - */␊ - scope?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Subscription key parameter names details.␊ - */␊ - export interface SubscriptionKeyParameterNamesContract {␊ - /**␊ - * Subscription key header name.␊ - */␊ - header?: string␊ - /**␊ - * Subscription key query string parameter name.␊ - */␊ - query?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/subscriptions␊ - */␊ - export interface ServiceSubscriptionsChildResource {␊ - apiVersion: "2016-07-07"␊ - /**␊ - * Identifier of the subscription.␊ - */␊ - name: string␊ - /**␊ - * Primary subscription key. If not specified during request key will be generated automatically.␊ - */␊ - primaryKey?: string␊ - /**␊ - * Product (product id path) for which subscription is being created in form /products/{productId}␊ - */␊ - productId: string␊ - /**␊ - * Secondary subscription key. If not specified during request key will be generated automatically.␊ - */␊ - secondaryKey?: string␊ - /**␊ - * Initial subscription state. If no value is specified, subscription is created with Submitted state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated.␊ - */␊ - state?: (("Suspended" | "Active" | "Expired" | "Submitted" | "Rejected" | "Cancelled") | string)␊ - type: "subscriptions"␊ - /**␊ - * User (user id path) for whom subscription is being created in form /users/{uid}␊ - */␊ - userId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/products␊ - */␊ - export interface ServiceProductsChildResource {␊ - apiVersion: "2016-07-07"␊ - /**␊ - * whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of true.␊ - */␊ - approvalRequired?: (boolean | string)␊ - /**␊ - * Product description. May include HTML formatting tags.␊ - */␊ - description?: string␊ - /**␊ - * Product identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is NotPublished.␊ - */␊ - state?: (("NotPublished" | "Published") | string)␊ - /**␊ - * Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true.␊ - */␊ - subscriptionRequired?: (boolean | string)␊ - /**␊ - * Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of true.␊ - */␊ - subscriptionsLimit?: (number | string)␊ - /**␊ - * Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process.␊ - */␊ - terms?: string␊ - type: "products"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/groups␊ - */␊ - export interface ServiceGroupsChildResource {␊ - apiVersion: "2016-07-07"␊ - /**␊ - * Group description.␊ - */␊ - description?: string␊ - /**␊ - * Identifier for an external group.␊ - */␊ - externalId?: string␊ - /**␊ - * Group identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "groups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/certificates␊ - */␊ - export interface ServiceCertificatesChildResource {␊ - apiVersion: "2016-07-07"␊ - /**␊ - * Base 64 encoded certificate using the application/x-pkcs12 representation.␊ - */␊ - data: string␊ - /**␊ - * Identifier of the certificate entity. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Password for the Certificate␊ - */␊ - password: string␊ - type: "certificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/users␊ - */␊ - export interface ServiceUsersChildResource {␊ - apiVersion: "2016-07-07"␊ - /**␊ - * Email address. Must not be empty and must be unique within the service instance.␊ - */␊ - email: string␊ - /**␊ - * First name.␊ - */␊ - firstName: string␊ - /**␊ - * Last name.␊ - */␊ - lastName: string␊ - /**␊ - * User identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Optional note about a user set by the administrator.␊ - */␊ - note?: string␊ - /**␊ - * User Password.␊ - */␊ - password: string␊ - /**␊ - * Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active.␊ - */␊ - state?: (("Active" | "Blocked") | string)␊ - type: "users"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/authorizationServers␊ - */␊ - export interface ServiceAuthorizationServersChildResource {␊ - apiVersion: "2016-07-07"␊ - /**␊ - * OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.␊ - */␊ - authorizationEndpoint: string␊ - /**␊ - * HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.␊ - */␊ - authorizationMethods?: (("HEAD" | "OPTIONS" | "TRACE" | "GET" | "POST" | "PUT" | "PATCH" | "DELETE")[] | string)␊ - /**␊ - * Specifies the mechanism by which access token is passed to the API. ␊ - */␊ - bearerTokenSendingMethods?: (("authorizationHeader" | "query")[] | string)␊ - /**␊ - * Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format.␊ - */␊ - clientAuthenticationMethod?: (("Basic" | "Body")[] | string)␊ - /**␊ - * Client or app id registered with this authorization server.␊ - */␊ - clientId: string␊ - /**␊ - * Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced.␊ - */␊ - clientRegistrationEndpoint: string␊ - /**␊ - * Client or app secret registered with this authorization server.␊ - */␊ - clientSecret?: string␊ - /**␊ - * Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values.␊ - */␊ - defaultScope?: string␊ - /**␊ - * Description of the authorization server. Can contain HTML formatting tags.␊ - */␊ - description?: string␊ - /**␊ - * Form of an authorization grant, which the client uses to request the access token.␊ - */␊ - grantTypes: (("authorizationCode" | "implicit" | "resourceOwnerPassword" | "clientCredentials")[] | string)␊ - /**␊ - * Identifier of the authorization server.␊ - */␊ - name: string␊ - /**␊ - * Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.␊ - */␊ - resourceOwnerPassword?: string␊ - /**␊ - * Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.␊ - */␊ - resourceOwnerUsername?: string␊ - /**␊ - * If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security.␊ - */␊ - supportState?: (boolean | string)␊ - /**␊ - * Additional parameters required by the token endpoint of this authorization server represented as an array of JSON objects with name and value string properties, i.e. {"name" : "name value", "value": "a value"}.␊ - */␊ - tokenBodyParameters?: (TokenBodyParameterContract[] | string)␊ - /**␊ - * OAuth token endpoint. Contains absolute URI to entity being referenced.␊ - */␊ - tokenEndpoint?: string␊ - type: "authorizationServers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * OAuth acquire token request body parameter (www-url-form-encoded).␊ - */␊ - export interface TokenBodyParameterContract {␊ - /**␊ - * body parameter name.␊ - */␊ - name: string␊ - /**␊ - * body parameter value.␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/loggers␊ - */␊ - export interface ServiceLoggersChildResource {␊ - apiVersion: "2016-07-07"␊ - /**␊ - * The name and SendRule connection string of the event hub.␊ - */␊ - credentials: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Logger description.␊ - */␊ - description?: string␊ - /**␊ - * Whether records are buffered in the logger before publishing. Default is assumed to be true.␊ - */␊ - isBuffered?: (boolean | string)␊ - /**␊ - * Identifier of the logger.␊ - */␊ - name: string␊ - type: "loggers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/properties␊ - */␊ - export interface ServicePropertiesChildResource {␊ - apiVersion: "2016-07-07"␊ - /**␊ - * Identifier of the property.␊ - */␊ - name: string␊ - /**␊ - * Determines whether the value is a secret and should be encrypted or not. Default value is false.␊ - */␊ - secret?: (boolean | string)␊ - /**␊ - * Optional tags that when provided can be used to filter the property list.␊ - */␊ - tags?: (string[] | string)␊ - type: "properties"␊ - /**␊ - * Value of the property. Can contain policy expressions. It may not be empty or consist only of whitespace.␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/openidConnectProviders␊ - */␊ - export interface ServiceOpenidConnectProvidersChildResource {␊ - apiVersion: "2016-07-07"␊ - /**␊ - * Client ID of developer console which is the client application.␊ - */␊ - clientId: string␊ - /**␊ - * Client Secret of developer console which is the client application.␊ - */␊ - clientSecret?: string␊ - /**␊ - * User-friendly description of OpenID Connect Provider.␊ - */␊ - description?: string␊ - /**␊ - * Metadata endpoint URI.␊ - */␊ - metadataEndpoint: string␊ - /**␊ - * Identifier of the OpenID Connect Provider.␊ - */␊ - name: string␊ - type: "openidConnectProviders"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/backends␊ - */␊ - export interface ServiceBackendsChildResource {␊ - apiVersion: "2016-07-07"␊ - /**␊ - * Host attribute of the backend. Host is a pure hostname without a port or suffix, for example backend.contoso.com. Must not be empty.␊ - */␊ - host: string␊ - /**␊ - * User identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Flag indicating whether SSL certificate chain validation should be skipped when using self-signed certificates for this backend host.␊ - */␊ - skipCertificateChainValidation?: (boolean | string)␊ - type: "backends"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/identityProviders␊ - */␊ - export interface ServiceIdentityProvidersChildResource {␊ - /**␊ - * List of Allowed Tenants when configuring Azure Active Directory login.␊ - */␊ - allowedTenants?: (string[] | string)␊ - apiVersion: "2016-07-07"␊ - /**␊ - * Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft.␊ - */␊ - clientId: string␊ - /**␊ - * Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft.␊ - */␊ - clientSecret: string␊ - /**␊ - * Identity Provider Type identifier.␊ - */␊ - name: (("facebook" | "google" | "microsoft" | "twitter" | "aad") | string)␊ - type: "identityProviders"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * API Management service resource SKU properties.␊ - */␊ - export interface ApiManagementServiceSkuProperties {␊ - /**␊ - * Capacity of the SKU (number of deployed units of the SKU). The default value is 1.␊ - */␊ - capacity?: ((number & string) | string)␊ - /**␊ - * Name of the Sku.␊ - */␊ - name: (("Developer" | "Standard" | "Premium") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis␊ - */␊ - export interface ServiceApis {␊ - apiVersion: "2016-07-07"␊ - /**␊ - * API Authentication Settings.␊ - */␊ - authenticationSettings?: (AuthenticationSettingsContract | string)␊ - /**␊ - * Description of the API. May include HTML formatting tags.␊ - */␊ - description?: string␊ - /**␊ - * API identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.␊ - */␊ - path: string␊ - /**␊ - * Describes on which protocols the operations in this API can be invoked.␊ - */␊ - protocols: (("Http" | "Https")[] | string)␊ - resources?: ServiceApisOperationsChildResource[]␊ - /**␊ - * Absolute URL of the backend service implementing this API.␊ - */␊ - serviceUrl: string␊ - /**␊ - * Subscription key parameter names details.␊ - */␊ - subscriptionKeyParameterNames?: (SubscriptionKeyParameterNamesContract | string)␊ - type: "Microsoft.ApiManagement/service/apis"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/operations␊ - */␊ - export interface ServiceApisOperationsChildResource {␊ - apiVersion: "2016-07-07"␊ - /**␊ - * Description of the operation. May include HTML formatting tags.␊ - */␊ - description?: string␊ - /**␊ - * A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.␊ - */␊ - method: string␊ - /**␊ - * Operation identifier within an API. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Operation request details.␊ - */␊ - request?: (RequestContract | string)␊ - /**␊ - * Array of Operation responses.␊ - */␊ - responses?: (ResultContract[] | string)␊ - /**␊ - * Collection of URL template parameters.␊ - */␊ - templateParameters?: (ParameterContract[] | string)␊ - type: "operations"␊ - /**␊ - * Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}␊ - */␊ - urlTemplate: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Operation request details.␊ - */␊ - export interface RequestContract {␊ - /**␊ - * Operation request description.␊ - */␊ - description?: string␊ - /**␊ - * Collection of operation request headers.␊ - */␊ - headers?: (ParameterContract[] | string)␊ - /**␊ - * Collection of operation request query parameters.␊ - */␊ - queryParameters?: (ParameterContract[] | string)␊ - /**␊ - * Collection of operation request representations.␊ - */␊ - representations?: (RepresentationContract[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Operation parameters details.␊ - */␊ - export interface ParameterContract {␊ - /**␊ - * Default parameter value.␊ - */␊ - defaultValue?: string␊ - /**␊ - * Parameter description.␊ - */␊ - description?: string␊ - /**␊ - * Parameter name.␊ - */␊ - name: string␊ - /**␊ - * whether parameter is required or not.␊ - */␊ - required?: (boolean | string)␊ - /**␊ - * Parameter type.␊ - */␊ - type: string␊ - /**␊ - * Parameter values.␊ - */␊ - values?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Operation request/response representation details.␊ - */␊ - export interface RepresentationContract {␊ - /**␊ - * Specifies a registered or custom content type for this representation, e.g. application/xml.␊ - */␊ - contentType: string␊ - /**␊ - * An example of the representation.␊ - */␊ - sample?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Operation response details.␊ - */␊ - export interface ResultContract {␊ - /**␊ - * Operation response description.␊ - */␊ - description?: string␊ - /**␊ - * Collection of operation response representations.␊ - */␊ - representations?: (RepresentationContract[] | string)␊ - /**␊ - * Operation response HTTP status code.␊ - */␊ - statusCode: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/subscriptions␊ - */␊ - export interface ServiceSubscriptions {␊ - apiVersion: "2016-07-07"␊ - /**␊ - * Identifier of the subscription.␊ - */␊ - name: string␊ - /**␊ - * Primary subscription key. If not specified during request key will be generated automatically.␊ - */␊ - primaryKey?: string␊ - /**␊ - * Product (product id path) for which subscription is being created in form /products/{productId}␊ - */␊ - productId: string␊ - /**␊ - * Secondary subscription key. If not specified during request key will be generated automatically.␊ - */␊ - secondaryKey?: string␊ - /**␊ - * Initial subscription state. If no value is specified, subscription is created with Submitted state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated.␊ - */␊ - state?: (("Suspended" | "Active" | "Expired" | "Submitted" | "Rejected" | "Cancelled") | string)␊ - type: "Microsoft.ApiManagement/service/subscriptions"␊ - /**␊ - * User (user id path) for whom subscription is being created in form /users/{uid}␊ - */␊ - userId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/products␊ - */␊ - export interface ServiceProducts {␊ - apiVersion: "2016-07-07"␊ - /**␊ - * whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of true.␊ - */␊ - approvalRequired?: (boolean | string)␊ - /**␊ - * Product description. May include HTML formatting tags.␊ - */␊ - description?: string␊ - /**␊ - * Product identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - resources?: (ServiceProductsApisChildResource | ServiceProductsGroupsChildResource)[]␊ - /**␊ - * whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is NotPublished.␊ - */␊ - state?: (("NotPublished" | "Published") | string)␊ - /**␊ - * Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true.␊ - */␊ - subscriptionRequired?: (boolean | string)␊ - /**␊ - * Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of true.␊ - */␊ - subscriptionsLimit?: (number | string)␊ - /**␊ - * Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process.␊ - */␊ - terms?: string␊ - type: "Microsoft.ApiManagement/service/products"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/products/apis␊ - */␊ - export interface ServiceProductsApisChildResource {␊ - apiVersion: "2016-07-07"␊ - /**␊ - * API identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "apis"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/products/groups␊ - */␊ - export interface ServiceProductsGroupsChildResource {␊ - apiVersion: "2016-07-07"␊ - /**␊ - * Group identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "groups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/groups␊ - */␊ - export interface ServiceGroups {␊ - apiVersion: "2016-07-07"␊ - /**␊ - * Group description.␊ - */␊ - description?: string␊ - /**␊ - * Identifier for an external group.␊ - */␊ - externalId?: string␊ - /**␊ - * Group identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - resources?: ServiceGroupsUsersChildResource[]␊ - type: "Microsoft.ApiManagement/service/groups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/groups/users␊ - */␊ - export interface ServiceGroupsUsersChildResource {␊ - apiVersion: "2016-07-07"␊ - /**␊ - * User identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "users"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/certificates␊ - */␊ - export interface ServiceCertificates {␊ - apiVersion: "2016-07-07"␊ - /**␊ - * Base 64 encoded certificate using the application/x-pkcs12 representation.␊ - */␊ - data: string␊ - /**␊ - * Identifier of the certificate entity. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Password for the Certificate␊ - */␊ - password: string␊ - type: "Microsoft.ApiManagement/service/certificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/users␊ - */␊ - export interface ServiceUsers {␊ - apiVersion: "2016-07-07"␊ - /**␊ - * Email address. Must not be empty and must be unique within the service instance.␊ - */␊ - email: string␊ - /**␊ - * First name.␊ - */␊ - firstName: string␊ - /**␊ - * Last name.␊ - */␊ - lastName: string␊ - /**␊ - * User identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Optional note about a user set by the administrator.␊ - */␊ - note?: string␊ - /**␊ - * User Password.␊ - */␊ - password: string␊ - /**␊ - * Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active.␊ - */␊ - state?: (("Active" | "Blocked") | string)␊ - type: "Microsoft.ApiManagement/service/users"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/authorizationServers␊ - */␊ - export interface ServiceAuthorizationServers {␊ - apiVersion: "2016-07-07"␊ - /**␊ - * OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.␊ - */␊ - authorizationEndpoint: string␊ - /**␊ - * HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.␊ - */␊ - authorizationMethods?: (("HEAD" | "OPTIONS" | "TRACE" | "GET" | "POST" | "PUT" | "PATCH" | "DELETE")[] | string)␊ - /**␊ - * Specifies the mechanism by which access token is passed to the API. ␊ - */␊ - bearerTokenSendingMethods?: (("authorizationHeader" | "query")[] | string)␊ - /**␊ - * Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format.␊ - */␊ - clientAuthenticationMethod?: (("Basic" | "Body")[] | string)␊ - /**␊ - * Client or app id registered with this authorization server.␊ - */␊ - clientId: string␊ - /**␊ - * Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced.␊ - */␊ - clientRegistrationEndpoint: string␊ - /**␊ - * Client or app secret registered with this authorization server.␊ - */␊ - clientSecret?: string␊ - /**␊ - * Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values.␊ - */␊ - defaultScope?: string␊ - /**␊ - * Description of the authorization server. Can contain HTML formatting tags.␊ - */␊ - description?: string␊ - /**␊ - * Form of an authorization grant, which the client uses to request the access token.␊ - */␊ - grantTypes: (("authorizationCode" | "implicit" | "resourceOwnerPassword" | "clientCredentials")[] | string)␊ - /**␊ - * Identifier of the authorization server.␊ - */␊ - name: string␊ - /**␊ - * Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.␊ - */␊ - resourceOwnerPassword?: string␊ - /**␊ - * Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.␊ - */␊ - resourceOwnerUsername?: string␊ - /**␊ - * If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security.␊ - */␊ - supportState?: (boolean | string)␊ - /**␊ - * Additional parameters required by the token endpoint of this authorization server represented as an array of JSON objects with name and value string properties, i.e. {"name" : "name value", "value": "a value"}.␊ - */␊ - tokenBodyParameters?: (TokenBodyParameterContract[] | string)␊ - /**␊ - * OAuth token endpoint. Contains absolute URI to entity being referenced.␊ - */␊ - tokenEndpoint?: string␊ - type: "Microsoft.ApiManagement/service/authorizationServers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/loggers␊ - */␊ - export interface ServiceLoggers {␊ - apiVersion: "2016-07-07"␊ - /**␊ - * The name and SendRule connection string of the event hub.␊ - */␊ - credentials: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Logger description.␊ - */␊ - description?: string␊ - /**␊ - * Whether records are buffered in the logger before publishing. Default is assumed to be true.␊ - */␊ - isBuffered?: (boolean | string)␊ - /**␊ - * Identifier of the logger.␊ - */␊ - name: string␊ - type: "Microsoft.ApiManagement/service/loggers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/properties␊ - */␊ - export interface ServiceProperties {␊ - apiVersion: "2016-07-07"␊ - /**␊ - * Identifier of the property.␊ - */␊ - name: string␊ - /**␊ - * Determines whether the value is a secret and should be encrypted or not. Default value is false.␊ - */␊ - secret?: (boolean | string)␊ - /**␊ - * Optional tags that when provided can be used to filter the property list.␊ - */␊ - tags?: (string[] | string)␊ - type: "Microsoft.ApiManagement/service/properties"␊ - /**␊ - * Value of the property. Can contain policy expressions. It may not be empty or consist only of whitespace.␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/openidConnectProviders␊ - */␊ - export interface ServiceOpenidConnectProviders {␊ - apiVersion: "2016-07-07"␊ - /**␊ - * Client ID of developer console which is the client application.␊ - */␊ - clientId: string␊ - /**␊ - * Client Secret of developer console which is the client application.␊ - */␊ - clientSecret?: string␊ - /**␊ - * User-friendly description of OpenID Connect Provider.␊ - */␊ - description?: string␊ - /**␊ - * Metadata endpoint URI.␊ - */␊ - metadataEndpoint: string␊ - /**␊ - * Identifier of the OpenID Connect Provider.␊ - */␊ - name: string␊ - type: "Microsoft.ApiManagement/service/openidConnectProviders"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/backends␊ - */␊ - export interface ServiceBackends {␊ - apiVersion: "2016-07-07"␊ - /**␊ - * Host attribute of the backend. Host is a pure hostname without a port or suffix, for example backend.contoso.com. Must not be empty.␊ - */␊ - host: string␊ - /**␊ - * User identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Flag indicating whether SSL certificate chain validation should be skipped when using self-signed certificates for this backend host.␊ - */␊ - skipCertificateChainValidation?: (boolean | string)␊ - type: "Microsoft.ApiManagement/service/backends"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/identityProviders␊ - */␊ - export interface ServiceIdentityProviders {␊ - /**␊ - * List of Allowed Tenants when configuring Azure Active Directory login.␊ - */␊ - allowedTenants?: (string[] | string)␊ - apiVersion: "2016-07-07"␊ - /**␊ - * Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft.␊ - */␊ - clientId: string␊ - /**␊ - * Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft.␊ - */␊ - clientSecret: string␊ - /**␊ - * Identity Provider Type identifier.␊ - */␊ - name: (("facebook" | "google" | "microsoft" | "twitter" | "aad") | string)␊ - type: "Microsoft.ApiManagement/service/identityProviders"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/operations␊ - */␊ - export interface ServiceApisOperations {␊ - apiVersion: "2016-07-07"␊ - /**␊ - * Description of the operation. May include HTML formatting tags.␊ - */␊ - description?: string␊ - /**␊ - * A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.␊ - */␊ - method: string␊ - /**␊ - * Operation identifier within an API. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Operation request details.␊ - */␊ - request?: (RequestContract | string)␊ - /**␊ - * Array of Operation responses.␊ - */␊ - responses?: (ResultContract[] | string)␊ - /**␊ - * Collection of URL template parameters.␊ - */␊ - templateParameters?: (ParameterContract[] | string)␊ - type: "Microsoft.ApiManagement/service/apis/operations"␊ - /**␊ - * Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}␊ - */␊ - urlTemplate: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/groups/users␊ - */␊ - export interface ServiceGroupsUsers {␊ - apiVersion: "2016-07-07"␊ - /**␊ - * User identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "Microsoft.ApiManagement/service/groups/users"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/products/apis␊ - */␊ - export interface ServiceProductsApis {␊ - apiVersion: "2016-07-07"␊ - /**␊ - * API identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "Microsoft.ApiManagement/service/products/apis"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/products/groups␊ - */␊ - export interface ServiceProductsGroups {␊ - apiVersion: "2016-07-07"␊ - /**␊ - * Group identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "Microsoft.ApiManagement/service/products/groups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service␊ - */␊ - export interface Service1 {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Identity properties of the Api Management service resource.␊ - */␊ - identity?: (ApiManagementServiceIdentity | string)␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the API Management service.␊ - */␊ - name: string␊ - /**␊ - * Properties of an API Management service resource description.␊ - */␊ - properties: (ApiManagementServiceProperties1 | string)␊ - resources?: (ServicePoliciesChildResource | ServiceApisChildResource1 | ServiceAuthorizationServersChildResource1 | ServiceBackendsChildResource1 | ServiceCertificatesChildResource1 | ServiceDiagnosticsChildResource | ServiceTemplatesChildResource | ServiceGroupsChildResource1 | ServiceIdentityProvidersChildResource1 | ServiceLoggersChildResource1 | ServiceNotificationsChildResource | ServiceOpenidConnectProvidersChildResource1 | ServicePortalsettingsChildResource | ServiceProductsChildResource1 | ServicePropertiesChildResource1 | ServiceSubscriptionsChildResource1 | ServiceTagsChildResource | ServiceUsersChildResource1 | ServiceApiVersionSetsChildResource)[]␊ - /**␊ - * API Management service resource SKU properties.␊ - */␊ - sku: (ApiManagementServiceSkuProperties1 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.ApiManagement/service"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity properties of the Api Management service resource.␊ - */␊ - export interface ApiManagementServiceIdentity {␊ - /**␊ - * The identity type. Currently the only supported type is 'SystemAssigned'.␊ - */␊ - type: ("SystemAssigned" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of an API Management service resource description.␊ - */␊ - export interface ApiManagementServiceProperties1 {␊ - /**␊ - * Additional datacenter locations of the API Management service.␊ - */␊ - additionalLocations?: (AdditionalLocation[] | string)␊ - /**␊ - * List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.␊ - */␊ - certificates?: (CertificateConfiguration[] | string)␊ - /**␊ - * Custom properties of the API Management service. Setting \`Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168\` will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2). Setting \`Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11\` can be used to disable just TLS 1.1 and setting \`Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10\` can be used to disable TLS 1.0 on an API Management service.␊ - */␊ - customProperties?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Custom hostname configuration of the API Management service.␊ - */␊ - hostnameConfigurations?: (HostnameConfiguration1[] | string)␊ - /**␊ - * Email address from which the notification will be sent.␊ - */␊ - notificationSenderEmail?: string␊ - /**␊ - * Publisher email.␊ - */␊ - publisherEmail: string␊ - /**␊ - * Publisher name.␊ - */␊ - publisherName: string␊ - /**␊ - * Configuration of a virtual network to which API Management service is deployed.␊ - */␊ - virtualNetworkConfiguration?: (VirtualNetworkConfiguration7 | string)␊ - /**␊ - * The type of VPN in which API Management service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only.␊ - */␊ - virtualNetworkType?: (("None" | "External" | "Internal") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of an additional API Management resource location.␊ - */␊ - export interface AdditionalLocation {␊ - /**␊ - * The location name of the additional region among Azure Data center regions.␊ - */␊ - location: string␊ - /**␊ - * API Management service resource SKU properties.␊ - */␊ - sku: (ApiManagementServiceSkuProperties1 | string)␊ - /**␊ - * Configuration of a virtual network to which API Management service is deployed.␊ - */␊ - virtualNetworkConfiguration?: (VirtualNetworkConfiguration7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * API Management service resource SKU properties.␊ - */␊ - export interface ApiManagementServiceSkuProperties1 {␊ - /**␊ - * Capacity of the SKU (number of deployed units of the SKU). The default value is 1.␊ - */␊ - capacity?: ((number & string) | string)␊ - /**␊ - * Name of the Sku.␊ - */␊ - name: (("Developer" | "Standard" | "Premium" | "Basic") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Configuration of a virtual network to which API Management service is deployed.␊ - */␊ - export interface VirtualNetworkConfiguration7 {␊ - /**␊ - * The full resource ID of a subnet in a virtual network to deploy the API Management service in.␊ - */␊ - subnetResourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Certificate configuration which consist of non-trusted intermediates and root certificates.␊ - */␊ - export interface CertificateConfiguration {␊ - /**␊ - * Certificate Password.␊ - */␊ - certificatePassword?: string␊ - /**␊ - * Base64 Encoded certificate.␊ - */␊ - encodedCertificate?: string␊ - /**␊ - * The local certificate store location. Only Root and CertificateAuthority are valid locations.␊ - */␊ - storeName: (("CertificateAuthority" | "Root") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Custom hostname configuration.␊ - */␊ - export interface HostnameConfiguration1 {␊ - /**␊ - * Certificate Password.␊ - */␊ - certificatePassword?: string␊ - /**␊ - * Specify true to setup the certificate associated with this Hostname as the Default SSL Certificate. If a client does not send the SNI header, then this will be the certificate that will be challenged. The property is useful if a service has multiple custom hostname enabled and it needs to decide on the default ssl certificate. The setting only applied to Proxy Hostname Type.␊ - */␊ - defaultSslBinding?: (boolean | string)␊ - /**␊ - * Base64 Encoded certificate.␊ - */␊ - encodedCertificate?: string␊ - /**␊ - * Hostname to configure on the Api Management service.␊ - */␊ - hostName: string␊ - /**␊ - * Url to the KeyVault Secret containing the Ssl Certificate. If absolute Url containing version is provided, auto-update of ssl certificate will not work. This requires Api Management service to be configured with MSI. The secret should be of type *application/x-pkcs12*␊ - */␊ - keyVaultId?: string␊ - /**␊ - * Specify true to always negotiate client certificate on the hostname. Default Value is false.␊ - */␊ - negotiateClientCertificate?: (boolean | string)␊ - /**␊ - * Hostname type.␊ - */␊ - type: (("Proxy" | "Portal" | "Management" | "Scm") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/policies␊ - */␊ - export interface ServicePoliciesChildResource {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * The identifier of the Policy.␊ - */␊ - name: "policy"␊ - /**␊ - * Policy contract Properties.␊ - */␊ - properties: (PolicyContractProperties | string)␊ - type: "policies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Policy contract Properties.␊ - */␊ - export interface PolicyContractProperties {␊ - /**␊ - * Json escaped Xml Encoded contents of the Policy.␊ - */␊ - policyContent: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis␊ - */␊ - export interface ServiceApisChildResource1 {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.␊ - */␊ - name: string␊ - /**␊ - * Api Create or Update Properties.␊ - */␊ - properties: (ApiCreateOrUpdateProperties | string)␊ - type: "apis"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Api Create or Update Properties.␊ - */␊ - export interface ApiCreateOrUpdateProperties {␊ - /**␊ - * Describes the Revision of the Api. If no value is provided, default revision 1 is created␊ - */␊ - apiRevision?: string␊ - /**␊ - * Indicates the Version identifier of the API if the API is versioned␊ - */␊ - apiVersion?: string␊ - /**␊ - * Api Version Set Contract details.␊ - */␊ - apiVersionSet?: (ApiVersionSetContract | string)␊ - /**␊ - * A resource identifier for the related ApiVersionSet.␊ - */␊ - apiVersionSetId?: string␊ - /**␊ - * API Authentication Settings.␊ - */␊ - authenticationSettings?: (AuthenticationSettingsContract1 | string)␊ - /**␊ - * Format of the Content in which the API is getting imported.␊ - */␊ - contentFormat?: (("wadl-xml" | "wadl-link-json" | "swagger-json" | "swagger-link-json" | "wsdl" | "wsdl-link") | string)␊ - /**␊ - * Content value when Importing an API.␊ - */␊ - contentValue?: string␊ - /**␊ - * Description of the API. May include HTML formatting tags.␊ - */␊ - description?: string␊ - /**␊ - * API name.␊ - */␊ - displayName?: string␊ - /**␊ - * Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.␊ - */␊ - path: string␊ - /**␊ - * Describes on which protocols the operations in this API can be invoked.␊ - */␊ - protocols?: (("http" | "https")[] | string)␊ - /**␊ - * Absolute URL of the backend service implementing this API.␊ - */␊ - serviceUrl?: string␊ - /**␊ - * Subscription key parameter names details.␊ - */␊ - subscriptionKeyParameterNames?: (SubscriptionKeyParameterNamesContract1 | string)␊ - /**␊ - * Type of API.␊ - */␊ - type?: (("http" | "soap") | string)␊ - /**␊ - * Criteria to limit import of WSDL to a subset of the document.␊ - */␊ - wsdlSelector?: (ApiCreateOrUpdatePropertiesWsdlSelector | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Api Version Set Contract details.␊ - */␊ - export interface ApiVersionSetContract {␊ - /**␊ - * Properties of an API Version Set.␊ - */␊ - properties?: (ApiVersionSetContractProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of an API Version Set.␊ - */␊ - export interface ApiVersionSetContractProperties {␊ - /**␊ - * Description of API Version Set.␊ - */␊ - description?: string␊ - /**␊ - * Name of API Version Set␊ - */␊ - displayName: string␊ - /**␊ - * Name of HTTP header parameter that indicates the API Version if versioningScheme is set to \`header\`.␊ - */␊ - versionHeaderName?: string␊ - /**␊ - * An value that determines where the API Version identifier will be located in a HTTP request.␊ - */␊ - versioningScheme: (("Segment" | "Query" | "Header") | string)␊ - /**␊ - * Name of query parameter that indicates the API Version if versioningScheme is set to \`query\`.␊ - */␊ - versionQueryName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * API Authentication Settings.␊ - */␊ - export interface AuthenticationSettingsContract1 {␊ - /**␊ - * API OAuth2 Authentication settings details.␊ - */␊ - oAuth2?: (OAuth2AuthenticationSettingsContract1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * API OAuth2 Authentication settings details.␊ - */␊ - export interface OAuth2AuthenticationSettingsContract1 {␊ - /**␊ - * OAuth authorization server identifier.␊ - */␊ - authorizationServerId?: string␊ - /**␊ - * operations scope.␊ - */␊ - scope?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Subscription key parameter names details.␊ - */␊ - export interface SubscriptionKeyParameterNamesContract1 {␊ - /**␊ - * Subscription key header name.␊ - */␊ - header?: string␊ - /**␊ - * Subscription key query string parameter name.␊ - */␊ - query?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Criteria to limit import of WSDL to a subset of the document.␊ - */␊ - export interface ApiCreateOrUpdatePropertiesWsdlSelector {␊ - /**␊ - * Name of endpoint(port) to import from WSDL␊ - */␊ - wsdlEndpointName?: string␊ - /**␊ - * Name of service to import from WSDL␊ - */␊ - wsdlServiceName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/authorizationServers␊ - */␊ - export interface ServiceAuthorizationServersChildResource1 {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Identifier of the authorization server.␊ - */␊ - name: string␊ - /**␊ - * External OAuth authorization server settings Properties.␊ - */␊ - properties: (AuthorizationServerContractProperties | string)␊ - type: "authorizationServers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * External OAuth authorization server settings Properties.␊ - */␊ - export interface AuthorizationServerContractProperties {␊ - /**␊ - * OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.␊ - */␊ - authorizationEndpoint: string␊ - /**␊ - * HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.␊ - */␊ - authorizationMethods?: (("HEAD" | "OPTIONS" | "TRACE" | "GET" | "POST" | "PUT" | "PATCH" | "DELETE")[] | string)␊ - /**␊ - * Specifies the mechanism by which access token is passed to the API. ␊ - */␊ - bearerTokenSendingMethods?: (("authorizationHeader" | "query")[] | string)␊ - /**␊ - * Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format.␊ - */␊ - clientAuthenticationMethod?: (("Basic" | "Body")[] | string)␊ - /**␊ - * Client or app id registered with this authorization server.␊ - */␊ - clientId: string␊ - /**␊ - * Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced.␊ - */␊ - clientRegistrationEndpoint: string␊ - /**␊ - * Client or app secret registered with this authorization server.␊ - */␊ - clientSecret?: string␊ - /**␊ - * Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values.␊ - */␊ - defaultScope?: string␊ - /**␊ - * Description of the authorization server. Can contain HTML formatting tags.␊ - */␊ - description?: string␊ - /**␊ - * User-friendly authorization server name.␊ - */␊ - displayName: string␊ - /**␊ - * Form of an authorization grant, which the client uses to request the access token.␊ - */␊ - grantTypes: (("authorizationCode" | "implicit" | "resourceOwnerPassword" | "clientCredentials")[] | string)␊ - /**␊ - * Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.␊ - */␊ - resourceOwnerPassword?: string␊ - /**␊ - * Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.␊ - */␊ - resourceOwnerUsername?: string␊ - /**␊ - * If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security.␊ - */␊ - supportState?: (boolean | string)␊ - /**␊ - * Additional parameters required by the token endpoint of this authorization server represented as an array of JSON objects with name and value string properties, i.e. {"name" : "name value", "value": "a value"}.␊ - */␊ - tokenBodyParameters?: (TokenBodyParameterContract1[] | string)␊ - /**␊ - * OAuth token endpoint. Contains absolute URI to entity being referenced.␊ - */␊ - tokenEndpoint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * OAuth acquire token request body parameter (www-url-form-encoded).␊ - */␊ - export interface TokenBodyParameterContract1 {␊ - /**␊ - * body parameter name.␊ - */␊ - name: string␊ - /**␊ - * body parameter value.␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/backends␊ - */␊ - export interface ServiceBackendsChildResource1 {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Identifier of the Backend entity. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Parameters supplied to the Create Backend operation.␊ - */␊ - properties: (BackendContractProperties | string)␊ - type: "backends"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters supplied to the Create Backend operation.␊ - */␊ - export interface BackendContractProperties {␊ - /**␊ - * Details of the Credentials used to connect to Backend.␊ - */␊ - credentials?: (BackendCredentialsContract | string)␊ - /**␊ - * Backend Description.␊ - */␊ - description?: string␊ - /**␊ - * Properties specific to the Backend Type.␊ - */␊ - properties?: (BackendProperties | string)␊ - /**␊ - * Backend communication protocol.␊ - */␊ - protocol: (("http" | "soap") | string)␊ - /**␊ - * Details of the Backend WebProxy Server to use in the Request to Backend.␊ - */␊ - proxy?: (BackendProxyContract | string)␊ - /**␊ - * Management Uri of the Resource in External System. This url can be the Arm Resource Id of Logic Apps, Function Apps or Api Apps.␊ - */␊ - resourceId?: string␊ - /**␊ - * Backend Title.␊ - */␊ - title?: string␊ - /**␊ - * Properties controlling TLS Certificate Validation.␊ - */␊ - tls?: (BackendTlsProperties | string)␊ - /**␊ - * Runtime Url of the Backend.␊ - */␊ - url: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Details of the Credentials used to connect to Backend.␊ - */␊ - export interface BackendCredentialsContract {␊ - /**␊ - * Authorization header information.␊ - */␊ - authorization?: (BackendAuthorizationHeaderCredentials | string)␊ - /**␊ - * List of Client Certificate Thumbprint.␊ - */␊ - certificate?: (string[] | string)␊ - /**␊ - * Header Parameter description.␊ - */␊ - header?: ({␊ - [k: string]: string[]␊ - } | string)␊ - /**␊ - * Query Parameter description.␊ - */␊ - query?: ({␊ - [k: string]: string[]␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authorization header information.␊ - */␊ - export interface BackendAuthorizationHeaderCredentials {␊ - /**␊ - * Authentication Parameter value.␊ - */␊ - parameter: string␊ - /**␊ - * Authentication Scheme name.␊ - */␊ - scheme: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to the Backend Type.␊ - */␊ - export interface BackendProperties {␊ - /**␊ - * Properties of the Service Fabric Type Backend.␊ - */␊ - serviceFabricCluster?: (BackendServiceFabricClusterProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Service Fabric Type Backend.␊ - */␊ - export interface BackendServiceFabricClusterProperties {␊ - /**␊ - * The client certificate thumbprint for the management endpoint.␊ - */␊ - clientCertificatethumbprint: string␊ - /**␊ - * The cluster management endpoint.␊ - */␊ - managementEndpoints: (string[] | string)␊ - /**␊ - * Maximum number of retries while attempting resolve the partition.␊ - */␊ - maxPartitionResolutionRetries?: (number | string)␊ - /**␊ - * Thumbprints of certificates cluster management service uses for tls communication␊ - */␊ - serverCertificateThumbprints?: (string[] | string)␊ - /**␊ - * Server X509 Certificate Names Collection␊ - */␊ - serverX509Names?: (X509CertificateName[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of server X509Names.␊ - */␊ - export interface X509CertificateName {␊ - /**␊ - * Thumbprint for the Issuer of the Certificate.␊ - */␊ - issuerCertificateThumbprint?: string␊ - /**␊ - * Common Name of the Certificate.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Details of the Backend WebProxy Server to use in the Request to Backend.␊ - */␊ - export interface BackendProxyContract {␊ - /**␊ - * Password to connect to the WebProxy Server␊ - */␊ - password?: string␊ - /**␊ - * WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings.␊ - */␊ - url: string␊ - /**␊ - * Username to connect to the WebProxy server␊ - */␊ - username?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties controlling TLS Certificate Validation.␊ - */␊ - export interface BackendTlsProperties {␊ - /**␊ - * Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host.␊ - */␊ - validateCertificateChain?: (boolean | string)␊ - /**␊ - * Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host.␊ - */␊ - validateCertificateName?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/certificates␊ - */␊ - export interface ServiceCertificatesChildResource1 {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Identifier of the certificate entity. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Parameters supplied to the CreateOrUpdate certificate operation.␊ - */␊ - properties: (CertificateCreateOrUpdateProperties2 | string)␊ - type: "certificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters supplied to the CreateOrUpdate certificate operation.␊ - */␊ - export interface CertificateCreateOrUpdateProperties2 {␊ - /**␊ - * Base 64 encoded certificate using the application/x-pkcs12 representation.␊ - */␊ - data: string␊ - /**␊ - * Password for the Certificate␊ - */␊ - password: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/diagnostics␊ - */␊ - export interface ServiceDiagnosticsChildResource {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Diagnostic identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Diagnostic Entity Properties␊ - */␊ - properties: (DiagnosticContractProperties | string)␊ - type: "diagnostics"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Diagnostic Entity Properties␊ - */␊ - export interface DiagnosticContractProperties {␊ - /**␊ - * Indicates whether a diagnostic should receive data or not.␊ - */␊ - enabled: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/templates␊ - */␊ - export interface ServiceTemplatesChildResource {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Email Template Name Identifier.␊ - */␊ - name: (("applicationApprovedNotificationMessage" | "accountClosedDeveloper" | "quotaLimitApproachingDeveloperNotificationMessage" | "newDeveloperNotificationMessage" | "emailChangeIdentityDefault" | "inviteUserNotificationMessage" | "newCommentNotificationMessage" | "confirmSignUpIdentityDefault" | "newIssueNotificationMessage" | "purchaseDeveloperNotificationMessage" | "passwordResetIdentityDefault" | "passwordResetByAdminNotificationMessage" | "rejectDeveloperNotificationMessage" | "requestDeveloperNotificationMessage") | string)␊ - /**␊ - * Email Template Update Contract properties.␊ - */␊ - properties: (EmailTemplateUpdateParameterProperties | string)␊ - type: "templates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Email Template Update Contract properties.␊ - */␊ - export interface EmailTemplateUpdateParameterProperties {␊ - /**␊ - * Email Template Body. This should be a valid XDocument␊ - */␊ - body?: string␊ - /**␊ - * Description of the Email Template.␊ - */␊ - description?: string␊ - /**␊ - * Email Template Parameter values.␊ - */␊ - parameters?: (EmailTemplateParametersContractProperties[] | string)␊ - /**␊ - * Subject of the Template.␊ - */␊ - subject?: string␊ - /**␊ - * Title of the Template.␊ - */␊ - title?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Email Template Parameter contract.␊ - */␊ - export interface EmailTemplateParametersContractProperties {␊ - /**␊ - * Template parameter description.␊ - */␊ - description?: string␊ - /**␊ - * Template parameter name.␊ - */␊ - name?: string␊ - /**␊ - * Template parameter title.␊ - */␊ - title?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/groups␊ - */␊ - export interface ServiceGroupsChildResource1 {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Group identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Parameters supplied to the Create Group operation.␊ - */␊ - properties: (GroupCreateParametersProperties | string)␊ - type: "groups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters supplied to the Create Group operation.␊ - */␊ - export interface GroupCreateParametersProperties {␊ - /**␊ - * Group description.␊ - */␊ - description?: string␊ - /**␊ - * Group name.␊ - */␊ - displayName: string␊ - /**␊ - * Identifier of the external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://.onmicrosoft.com/groups/; otherwise the value is null.␊ - */␊ - externalId?: string␊ - /**␊ - * Group type.␊ - */␊ - type?: (("custom" | "system" | "external") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/identityProviders␊ - */␊ - export interface ServiceIdentityProvidersChildResource1 {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Identity Provider Type identifier.␊ - */␊ - name: (("facebook" | "google" | "microsoft" | "twitter" | "aad" | "aadB2C") | string)␊ - /**␊ - * The external Identity Providers like Facebook, Google, Microsoft, Twitter or Azure Active Directory which can be used to enable access to the API Management service developer portal for all users.␊ - */␊ - properties: (IdentityProviderContractProperties | string)␊ - type: "identityProviders"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The external Identity Providers like Facebook, Google, Microsoft, Twitter or Azure Active Directory which can be used to enable access to the API Management service developer portal for all users.␊ - */␊ - export interface IdentityProviderContractProperties {␊ - /**␊ - * List of Allowed Tenants when configuring Azure Active Directory login.␊ - */␊ - allowedTenants?: (string[] | string)␊ - /**␊ - * Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft.␊ - */␊ - clientId: string␊ - /**␊ - * Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft.␊ - */␊ - clientSecret: string␊ - /**␊ - * Password Reset Policy Name. Only applies to AAD B2C Identity Provider.␊ - */␊ - passwordResetPolicyName?: string␊ - /**␊ - * Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.␊ - */␊ - profileEditingPolicyName?: string␊ - /**␊ - * Signin Policy Name. Only applies to AAD B2C Identity Provider.␊ - */␊ - signinPolicyName?: string␊ - /**␊ - * Signup Policy Name. Only applies to AAD B2C Identity Provider.␊ - */␊ - signupPolicyName?: string␊ - /**␊ - * Identity Provider Type identifier.␊ - */␊ - type?: (("facebook" | "google" | "microsoft" | "twitter" | "aad" | "aadB2C") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/loggers␊ - */␊ - export interface ServiceLoggersChildResource1 {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Logger identifier. Must be unique in the API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * The Logger entity in API Management represents an event sink that you can use to log API Management events. Currently the Logger entity supports logging API Management events to Azure Event Hubs.␊ - */␊ - properties: (LoggerContractProperties | string)␊ - type: "loggers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Logger entity in API Management represents an event sink that you can use to log API Management events. Currently the Logger entity supports logging API Management events to Azure Event Hubs.␊ - */␊ - export interface LoggerContractProperties {␊ - /**␊ - * The name and SendRule connection string of the event hub for azureEventHub logger.␊ - * Instrumentation key for applicationInsights logger.␊ - */␊ - credentials: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Logger description.␊ - */␊ - description?: string␊ - /**␊ - * Whether records are buffered in the logger before publishing. Default is assumed to be true.␊ - */␊ - isBuffered?: (boolean | string)␊ - /**␊ - * Logger type.␊ - */␊ - loggerType: (("azureEventHub" | "applicationInsights") | string)␊ - /**␊ - * Sampling settings contract.␊ - */␊ - sampling?: (LoggerSamplingContract | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Sampling settings contract.␊ - */␊ - export interface LoggerSamplingContract {␊ - /**␊ - * Sampling settings for an ApplicationInsights logger.␊ - */␊ - properties?: (LoggerSamplingProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Sampling settings for an ApplicationInsights logger.␊ - */␊ - export interface LoggerSamplingProperties {␊ - /**␊ - * Rate re-evaluation interval in ISO8601 format.␊ - */␊ - evaluationInterval?: string␊ - /**␊ - * Initial sampling rate.␊ - */␊ - initialPercentage?: (number | string)␊ - /**␊ - * Maximum allowed rate of sampling.␊ - */␊ - maxPercentage?: (number | string)␊ - /**␊ - * Target rate of telemetry items per second.␊ - */␊ - maxTelemetryItemsPerSecond?: (number | string)␊ - /**␊ - * Minimum allowed rate of sampling.␊ - */␊ - minPercentage?: (number | string)␊ - /**␊ - * Moving average ration assigned to most recent value.␊ - */␊ - movingAverageRatio?: (number | string)␊ - /**␊ - * Rate of sampling for fixed-rate sampling.␊ - */␊ - percentage?: (number | string)␊ - /**␊ - * Duration in ISO8601 format after which it's allowed to lower the sampling rate.␊ - */␊ - percentageDecreaseTimeout?: string␊ - /**␊ - * Duration in ISO8601 format after which it's allowed to increase the sampling rate.␊ - */␊ - percentageIncreaseTimeout?: string␊ - /**␊ - * Sampling type.␊ - */␊ - samplingType?: (("fixed" | "adaptive") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/notifications␊ - */␊ - export interface ServiceNotificationsChildResource {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Notification Name Identifier.␊ - */␊ - name: (("RequestPublisherNotificationMessage" | "PurchasePublisherNotificationMessage" | "NewApplicationNotificationMessage" | "BCC" | "NewIssuePublisherNotificationMessage" | "AccountClosedPublisher" | "QuotaLimitApproachingPublisherNotificationMessage") | string)␊ - type: "notifications"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/openidConnectProviders␊ - */␊ - export interface ServiceOpenidConnectProvidersChildResource1 {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Identifier of the OpenID Connect Provider.␊ - */␊ - name: string␊ - /**␊ - * OpenID Connect Providers Contract.␊ - */␊ - properties: (OpenidConnectProviderContractProperties | string)␊ - type: "openidConnectProviders"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * OpenID Connect Providers Contract.␊ - */␊ - export interface OpenidConnectProviderContractProperties {␊ - /**␊ - * Client ID of developer console which is the client application.␊ - */␊ - clientId: string␊ - /**␊ - * Client Secret of developer console which is the client application.␊ - */␊ - clientSecret?: string␊ - /**␊ - * User-friendly description of OpenID Connect Provider.␊ - */␊ - description?: string␊ - /**␊ - * User-friendly OpenID Connect Provider name.␊ - */␊ - displayName: string␊ - /**␊ - * Metadata endpoint URI.␊ - */␊ - metadataEndpoint: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Sign-in settings contract properties.␊ - */␊ - export interface PortalSigninSettingProperties {␊ - /**␊ - * Redirect Anonymous users to the Sign-In page.␊ - */␊ - enabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Sign-up settings contract properties.␊ - */␊ - export interface PortalSignupSettingsProperties {␊ - /**␊ - * Allow users to sign up on a developer portal.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Terms of service contract properties.␊ - */␊ - termsOfService?: (TermsOfServiceProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Terms of service contract properties.␊ - */␊ - export interface TermsOfServiceProperties {␊ - /**␊ - * Ask user for consent.␊ - */␊ - consentRequired?: (boolean | string)␊ - /**␊ - * Display terms of service during a sign-up process.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * A terms of service text.␊ - */␊ - text?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Delegation settings contract properties.␊ - */␊ - export interface PortalDelegationSettingsProperties {␊ - /**␊ - * Subscriptions delegation settings properties.␊ - */␊ - subscriptions?: (SubscriptionsDelegationSettingsProperties | string)␊ - /**␊ - * A delegation Url.␊ - */␊ - url?: string␊ - /**␊ - * User registration delegation settings properties.␊ - */␊ - userRegistration?: (RegistrationDelegationSettingsProperties | string)␊ - /**␊ - * A base64-encoded validation key to validate, that a request is coming from Azure API Management.␊ - */␊ - validationKey?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Subscriptions delegation settings properties.␊ - */␊ - export interface SubscriptionsDelegationSettingsProperties {␊ - /**␊ - * Enable or disable delegation for subscriptions.␊ - */␊ - enabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * User registration delegation settings properties.␊ - */␊ - export interface RegistrationDelegationSettingsProperties {␊ - /**␊ - * Enable or disable delegation for user registration.␊ - */␊ - enabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/products␊ - */␊ - export interface ServiceProductsChildResource1 {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Product identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Product profile.␊ - */␊ - properties: (ProductContractProperties | string)␊ - type: "products"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Product profile.␊ - */␊ - export interface ProductContractProperties {␊ - /**␊ - * whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of true.␊ - */␊ - approvalRequired?: (boolean | string)␊ - /**␊ - * Product description. May include HTML formatting tags.␊ - */␊ - description?: string␊ - /**␊ - * Product name.␊ - */␊ - displayName: string␊ - /**␊ - * whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished.␊ - */␊ - state?: (("notPublished" | "published") | string)␊ - /**␊ - * Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true.␊ - */␊ - subscriptionRequired?: (boolean | string)␊ - /**␊ - * Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of true.␊ - */␊ - subscriptionsLimit?: (number | string)␊ - /**␊ - * Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process.␊ - */␊ - terms?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/properties␊ - */␊ - export interface ServicePropertiesChildResource1 {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Identifier of the property.␊ - */␊ - name: string␊ - /**␊ - * Property Contract properties.␊ - */␊ - properties: (PropertyContractProperties | string)␊ - type: "properties"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Property Contract properties.␊ - */␊ - export interface PropertyContractProperties {␊ - /**␊ - * Unique name of Property. It may contain only letters, digits, period, dash, and underscore characters.␊ - */␊ - displayName: string␊ - /**␊ - * Determines whether the value is a secret and should be encrypted or not. Default value is false.␊ - */␊ - secret?: (boolean | string)␊ - /**␊ - * Optional tags that when provided can be used to filter the property list.␊ - */␊ - tags?: (string[] | string)␊ - /**␊ - * Value of the property. Can contain policy expressions. It may not be empty or consist only of whitespace.␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/subscriptions␊ - */␊ - export interface ServiceSubscriptionsChildResource1 {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Subscription entity Identifier. The entity represents the association between a user and a product in API Management.␊ - */␊ - name: string␊ - /**␊ - * Parameters supplied to the Create subscription operation.␊ - */␊ - properties: (SubscriptionCreateParameterProperties | string)␊ - type: "subscriptions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters supplied to the Create subscription operation.␊ - */␊ - export interface SubscriptionCreateParameterProperties {␊ - /**␊ - * Subscription name.␊ - */␊ - displayName: string␊ - /**␊ - * Primary subscription key. If not specified during request key will be generated automatically.␊ - */␊ - primaryKey?: string␊ - /**␊ - * Product (product id path) for which subscription is being created in form /products/{productId}␊ - */␊ - productId: string␊ - /**␊ - * Secondary subscription key. If not specified during request key will be generated automatically.␊ - */␊ - secondaryKey?: string␊ - /**␊ - * Initial subscription state. If no value is specified, subscription is created with Submitted state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated.␊ - */␊ - state?: (("suspended" | "active" | "expired" | "submitted" | "rejected" | "cancelled") | string)␊ - /**␊ - * User (user id path) for whom subscription is being created in form /users/{uid}␊ - */␊ - userId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/tags␊ - */␊ - export interface ServiceTagsChildResource {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Tag identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Tag contract Properties.␊ - */␊ - properties: (TagContractProperties | string)␊ - type: "tags"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Tag contract Properties.␊ - */␊ - export interface TagContractProperties {␊ - /**␊ - * Tag name.␊ - */␊ - displayName: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/users␊ - */␊ - export interface ServiceUsersChildResource1 {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * User identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Parameters supplied to the Create User operation.␊ - */␊ - properties: (UserCreateParameterProperties | string)␊ - type: "users"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters supplied to the Create User operation.␊ - */␊ - export interface UserCreateParameterProperties {␊ - /**␊ - * Determines the type of confirmation e-mail that will be sent to the newly created user.␊ - */␊ - confirmation?: (("signup" | "invite") | string)␊ - /**␊ - * Email address. Must not be empty and must be unique within the service instance.␊ - */␊ - email: string␊ - /**␊ - * First name.␊ - */␊ - firstName: string␊ - /**␊ - * Last name.␊ - */␊ - lastName: string␊ - /**␊ - * Optional note about a user set by the administrator.␊ - */␊ - note?: string␊ - /**␊ - * User Password. If no value is provided, a default password is generated.␊ - */␊ - password?: string␊ - /**␊ - * Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active.␊ - */␊ - state?: (("active" | "blocked" | "pending" | "deleted") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/api-version-sets␊ - */␊ - export interface ServiceApiVersionSetsChildResource {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Api Version Set identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Properties of an API Version Set.␊ - */␊ - properties: (ApiVersionSetContractProperties | string)␊ - type: "api-version-sets"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis␊ - */␊ - export interface ServiceApis1 {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.␊ - */␊ - name: string␊ - /**␊ - * Api Create or Update Properties.␊ - */␊ - properties: (ApiCreateOrUpdateProperties | string)␊ - resources?: (ServiceApisReleasesChildResource | ServiceApisOperationsChildResource1 | ServiceApisPoliciesChildResource | ServiceApisSchemasChildResource | ServiceApisDiagnosticsChildResource | ServiceApisIssuesChildResource | ServiceApisTagsChildResource | ServiceApisTagDescriptionsChildResource)[]␊ - type: "Microsoft.ApiManagement/service/apis"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/releases␊ - */␊ - export interface ServiceApisReleasesChildResource {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Release identifier within an API. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * API Release details␊ - */␊ - properties: (ApiReleaseContractProperties | string)␊ - type: "releases"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * API Release details␊ - */␊ - export interface ApiReleaseContractProperties {␊ - /**␊ - * Identifier of the API the release belongs to.␊ - */␊ - apiId?: string␊ - /**␊ - * Release Notes␊ - */␊ - notes?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/operations␊ - */␊ - export interface ServiceApisOperationsChildResource1 {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Operation identifier within an API. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Operation Contract Properties␊ - */␊ - properties: (OperationContractProperties | string)␊ - type: "operations"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Operation Contract Properties␊ - */␊ - export interface OperationContractProperties {␊ - /**␊ - * Description of the operation. May include HTML formatting tags.␊ - */␊ - description?: string␊ - /**␊ - * Operation Name.␊ - */␊ - displayName: string␊ - /**␊ - * A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.␊ - */␊ - method: string␊ - /**␊ - * Operation Policies␊ - */␊ - policies?: string␊ - /**␊ - * Operation request details.␊ - */␊ - request?: (RequestContract1 | string)␊ - /**␊ - * Array of Operation responses.␊ - */␊ - responses?: (ResponseContract[] | string)␊ - /**␊ - * Collection of URL template parameters.␊ - */␊ - templateParameters?: (ParameterContract1[] | string)␊ - /**␊ - * Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}␊ - */␊ - urlTemplate: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Operation request details.␊ - */␊ - export interface RequestContract1 {␊ - /**␊ - * Operation request description.␊ - */␊ - description?: string␊ - /**␊ - * Collection of operation request headers.␊ - */␊ - headers?: (ParameterContract1[] | string)␊ - /**␊ - * Collection of operation request query parameters.␊ - */␊ - queryParameters?: (ParameterContract1[] | string)␊ - /**␊ - * Collection of operation request representations.␊ - */␊ - representations?: (RepresentationContract1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Operation parameters details.␊ - */␊ - export interface ParameterContract1 {␊ - /**␊ - * Default parameter value.␊ - */␊ - defaultValue?: string␊ - /**␊ - * Parameter description.␊ - */␊ - description?: string␊ - /**␊ - * Parameter name.␊ - */␊ - name: string␊ - /**␊ - * whether parameter is required or not.␊ - */␊ - required?: (boolean | string)␊ - /**␊ - * Parameter type.␊ - */␊ - type: string␊ - /**␊ - * Parameter values.␊ - */␊ - values?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Operation request/response representation details.␊ - */␊ - export interface RepresentationContract1 {␊ - /**␊ - * Specifies a registered or custom content type for this representation, e.g. application/xml.␊ - */␊ - contentType: string␊ - /**␊ - * Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..␊ - */␊ - formParameters?: (ParameterContract1[] | string)␊ - /**␊ - * An example of the representation.␊ - */␊ - sample?: string␊ - /**␊ - * Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.␊ - */␊ - schemaId?: string␊ - /**␊ - * Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.␊ - */␊ - typeName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Operation response details.␊ - */␊ - export interface ResponseContract {␊ - /**␊ - * Operation response description.␊ - */␊ - description?: string␊ - /**␊ - * Collection of operation response headers.␊ - */␊ - headers?: (ParameterContract1[] | string)␊ - /**␊ - * Collection of operation response representations.␊ - */␊ - representations?: (RepresentationContract1[] | string)␊ - /**␊ - * Operation response HTTP status code.␊ - */␊ - statusCode: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/policies␊ - */␊ - export interface ServiceApisPoliciesChildResource {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * The identifier of the Policy.␊ - */␊ - name: "policy"␊ - /**␊ - * Policy contract Properties.␊ - */␊ - properties: (PolicyContractProperties | string)␊ - type: "policies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/schemas␊ - */␊ - export interface ServiceApisSchemasChildResource {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Schema identifier within an API. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Schema contract Properties.␊ - */␊ - properties: (SchemaContractProperties | string)␊ - type: "schemas"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Schema contract Properties.␊ - */␊ - export interface SchemaContractProperties {␊ - /**␊ - * Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml).␊ - */␊ - contentType: string␊ - /**␊ - * Schema Document Properties.␊ - */␊ - document?: (SchemaDocumentProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Schema Document Properties.␊ - */␊ - export interface SchemaDocumentProperties {␊ - /**␊ - * Json escaped string defining the document representing the Schema.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/diagnostics␊ - */␊ - export interface ServiceApisDiagnosticsChildResource {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Diagnostic identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Diagnostic Entity Properties␊ - */␊ - properties: (DiagnosticContractProperties | string)␊ - type: "diagnostics"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/issues␊ - */␊ - export interface ServiceApisIssuesChildResource {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Issue identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Issue contract Properties.␊ - */␊ - properties: (IssueContractProperties | string)␊ - type: "issues"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Issue contract Properties.␊ - */␊ - export interface IssueContractProperties {␊ - /**␊ - * A resource identifier for the API the issue was created for.␊ - */␊ - apiId?: string␊ - /**␊ - * Date and time when the issue was created.␊ - */␊ - createdDate?: string␊ - /**␊ - * Text describing the issue.␊ - */␊ - description: string␊ - /**␊ - * Status of the issue.␊ - */␊ - state?: (("proposed" | "open" | "removed" | "resolved" | "closed") | string)␊ - /**␊ - * The issue title.␊ - */␊ - title: string␊ - /**␊ - * A resource identifier for the user created the issue.␊ - */␊ - userId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/tags␊ - */␊ - export interface ServiceApisTagsChildResource {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Tag identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "tags"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/tagDescriptions␊ - */␊ - export interface ServiceApisTagDescriptionsChildResource {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Tag identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Parameters supplied to the Create TagDescription operation.␊ - */␊ - properties: (TagDescriptionBaseProperties | string)␊ - type: "tagDescriptions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters supplied to the Create TagDescription operation.␊ - */␊ - export interface TagDescriptionBaseProperties {␊ - /**␊ - * Description of the Tag.␊ - */␊ - description?: string␊ - /**␊ - * Description of the external resources describing the tag.␊ - */␊ - externalDocsDescription?: string␊ - /**␊ - * Absolute URL of external resources describing the tag.␊ - */␊ - externalDocsUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/operations␊ - */␊ - export interface ServiceApisOperations1 {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Operation identifier within an API. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Operation Contract Properties␊ - */␊ - properties: (OperationContractProperties | string)␊ - resources?: (ServiceApisOperationsPoliciesChildResource | ServiceApisOperationsTagsChildResource)[]␊ - type: "Microsoft.ApiManagement/service/apis/operations"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/operations/policies␊ - */␊ - export interface ServiceApisOperationsPoliciesChildResource {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * The identifier of the Policy.␊ - */␊ - name: "policy"␊ - /**␊ - * Policy contract Properties.␊ - */␊ - properties: (PolicyContractProperties | string)␊ - type: "policies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/operations/tags␊ - */␊ - export interface ServiceApisOperationsTagsChildResource {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Tag identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "tags"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/operations/policies␊ - */␊ - export interface ServiceApisOperationsPolicies {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * The identifier of the Policy.␊ - */␊ - name: string␊ - /**␊ - * Policy contract Properties.␊ - */␊ - properties: (PolicyContractProperties | string)␊ - type: "Microsoft.ApiManagement/service/apis/operations/policies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/operations/tags␊ - */␊ - export interface ServiceApisOperationsTags {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Tag identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "Microsoft.ApiManagement/service/apis/operations/tags"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/policies␊ - */␊ - export interface ServiceApisPolicies {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * The identifier of the Policy.␊ - */␊ - name: string␊ - /**␊ - * Policy contract Properties.␊ - */␊ - properties: (PolicyContractProperties | string)␊ - type: "Microsoft.ApiManagement/service/apis/policies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/releases␊ - */␊ - export interface ServiceApisReleases {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Release identifier within an API. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * API Release details␊ - */␊ - properties: (ApiReleaseContractProperties | string)␊ - type: "Microsoft.ApiManagement/service/apis/releases"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/schemas␊ - */␊ - export interface ServiceApisSchemas {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Schema identifier within an API. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Schema contract Properties.␊ - */␊ - properties: (SchemaContractProperties | string)␊ - type: "Microsoft.ApiManagement/service/apis/schemas"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/tagDescriptions␊ - */␊ - export interface ServiceApisTagDescriptions {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Tag identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Parameters supplied to the Create TagDescription operation.␊ - */␊ - properties: (TagDescriptionBaseProperties | string)␊ - type: "Microsoft.ApiManagement/service/apis/tagDescriptions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/tags␊ - */␊ - export interface ServiceApisTags {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Tag identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "Microsoft.ApiManagement/service/apis/tags"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/authorizationServers␊ - */␊ - export interface ServiceAuthorizationServers1 {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Identifier of the authorization server.␊ - */␊ - name: string␊ - /**␊ - * External OAuth authorization server settings Properties.␊ - */␊ - properties: (AuthorizationServerContractProperties | string)␊ - type: "Microsoft.ApiManagement/service/authorizationServers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/backends␊ - */␊ - export interface ServiceBackends1 {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Identifier of the Backend entity. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Parameters supplied to the Create Backend operation.␊ - */␊ - properties: (BackendContractProperties | string)␊ - type: "Microsoft.ApiManagement/service/backends"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/certificates␊ - */␊ - export interface ServiceCertificates1 {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Identifier of the certificate entity. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Parameters supplied to the CreateOrUpdate certificate operation.␊ - */␊ - properties: (CertificateCreateOrUpdateProperties2 | string)␊ - type: "Microsoft.ApiManagement/service/certificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/diagnostics␊ - */␊ - export interface ServiceDiagnostics {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Diagnostic identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Diagnostic Entity Properties␊ - */␊ - properties: (DiagnosticContractProperties | string)␊ - resources?: ServiceDiagnosticsLoggersChildResource[]␊ - type: "Microsoft.ApiManagement/service/diagnostics"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/diagnostics/loggers␊ - */␊ - export interface ServiceDiagnosticsLoggersChildResource {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Logger identifier. Must be unique in the API Management service instance.␊ - */␊ - name: string␊ - type: "loggers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/diagnostics/loggers␊ - */␊ - export interface ServiceDiagnosticsLoggers {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Logger identifier. Must be unique in the API Management service instance.␊ - */␊ - name: string␊ - type: "Microsoft.ApiManagement/service/diagnostics/loggers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/groups␊ - */␊ - export interface ServiceGroups1 {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Group identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Parameters supplied to the Create Group operation.␊ - */␊ - properties: (GroupCreateParametersProperties | string)␊ - resources?: ServiceGroupsUsersChildResource1[]␊ - type: "Microsoft.ApiManagement/service/groups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/groups/users␊ - */␊ - export interface ServiceGroupsUsersChildResource1 {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * User identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "users"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/groups/users␊ - */␊ - export interface ServiceGroupsUsers1 {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * User identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "Microsoft.ApiManagement/service/groups/users"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/identityProviders␊ - */␊ - export interface ServiceIdentityProviders1 {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Identity Provider Type identifier.␊ - */␊ - name: (("facebook" | "google" | "microsoft" | "twitter" | "aad" | "aadB2C") | string)␊ - /**␊ - * The external Identity Providers like Facebook, Google, Microsoft, Twitter or Azure Active Directory which can be used to enable access to the API Management service developer portal for all users.␊ - */␊ - properties: (IdentityProviderContractProperties | string)␊ - type: "Microsoft.ApiManagement/service/identityProviders"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/loggers␊ - */␊ - export interface ServiceLoggers1 {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Logger identifier. Must be unique in the API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * The Logger entity in API Management represents an event sink that you can use to log API Management events. Currently the Logger entity supports logging API Management events to Azure Event Hubs.␊ - */␊ - properties: (LoggerContractProperties | string)␊ - type: "Microsoft.ApiManagement/service/loggers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/notifications␊ - */␊ - export interface ServiceNotifications {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Notification Name Identifier.␊ - */␊ - name: (("RequestPublisherNotificationMessage" | "PurchasePublisherNotificationMessage" | "NewApplicationNotificationMessage" | "BCC" | "NewIssuePublisherNotificationMessage" | "AccountClosedPublisher" | "QuotaLimitApproachingPublisherNotificationMessage") | string)␊ - resources?: (ServiceNotificationsRecipientUsersChildResource | ServiceNotificationsRecipientEmailsChildResource)[]␊ - type: "Microsoft.ApiManagement/service/notifications"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/notifications/recipientUsers␊ - */␊ - export interface ServiceNotificationsRecipientUsersChildResource {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * User identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "recipientUsers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/notifications/recipientEmails␊ - */␊ - export interface ServiceNotificationsRecipientEmailsChildResource {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Email identifier.␊ - */␊ - name: string␊ - type: "recipientEmails"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/notifications/recipientEmails␊ - */␊ - export interface ServiceNotificationsRecipientEmails {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Email identifier.␊ - */␊ - name: string␊ - type: "Microsoft.ApiManagement/service/notifications/recipientEmails"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/notifications/recipientUsers␊ - */␊ - export interface ServiceNotificationsRecipientUsers {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * User identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "Microsoft.ApiManagement/service/notifications/recipientUsers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/openidConnectProviders␊ - */␊ - export interface ServiceOpenidConnectProviders1 {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Identifier of the OpenID Connect Provider.␊ - */␊ - name: string␊ - /**␊ - * OpenID Connect Providers Contract.␊ - */␊ - properties: (OpenidConnectProviderContractProperties | string)␊ - type: "Microsoft.ApiManagement/service/openidConnectProviders"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/policies␊ - */␊ - export interface ServicePolicies {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * The identifier of the Policy.␊ - */␊ - name: string␊ - /**␊ - * Policy contract Properties.␊ - */␊ - properties: (PolicyContractProperties | string)␊ - type: "Microsoft.ApiManagement/service/policies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/products␊ - */␊ - export interface ServiceProducts1 {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Product identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Product profile.␊ - */␊ - properties: (ProductContractProperties | string)␊ - resources?: (ServiceProductsApisChildResource1 | ServiceProductsGroupsChildResource1 | ServiceProductsPoliciesChildResource | ServiceProductsTagsChildResource)[]␊ - type: "Microsoft.ApiManagement/service/products"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/products/apis␊ - */␊ - export interface ServiceProductsApisChildResource1 {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * API identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "apis"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/products/groups␊ - */␊ - export interface ServiceProductsGroupsChildResource1 {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Group identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "groups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/products/policies␊ - */␊ - export interface ServiceProductsPoliciesChildResource {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * The identifier of the Policy.␊ - */␊ - name: "policy"␊ - /**␊ - * Policy contract Properties.␊ - */␊ - properties: (PolicyContractProperties | string)␊ - type: "policies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/products/tags␊ - */␊ - export interface ServiceProductsTagsChildResource {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Tag identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "tags"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/products/apis␊ - */␊ - export interface ServiceProductsApis1 {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * API identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "Microsoft.ApiManagement/service/products/apis"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/products/groups␊ - */␊ - export interface ServiceProductsGroups1 {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Group identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "Microsoft.ApiManagement/service/products/groups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/products/policies␊ - */␊ - export interface ServiceProductsPolicies {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * The identifier of the Policy.␊ - */␊ - name: string␊ - /**␊ - * Policy contract Properties.␊ - */␊ - properties: (PolicyContractProperties | string)␊ - type: "Microsoft.ApiManagement/service/products/policies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/products/tags␊ - */␊ - export interface ServiceProductsTags {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Tag identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "Microsoft.ApiManagement/service/products/tags"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/properties␊ - */␊ - export interface ServiceProperties1 {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Identifier of the property.␊ - */␊ - name: string␊ - /**␊ - * Property Contract properties.␊ - */␊ - properties: (PropertyContractProperties | string)␊ - type: "Microsoft.ApiManagement/service/properties"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/subscriptions␊ - */␊ - export interface ServiceSubscriptions1 {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Subscription entity Identifier. The entity represents the association between a user and a product in API Management.␊ - */␊ - name: string␊ - /**␊ - * Parameters supplied to the Create subscription operation.␊ - */␊ - properties: (SubscriptionCreateParameterProperties | string)␊ - type: "Microsoft.ApiManagement/service/subscriptions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/tags␊ - */␊ - export interface ServiceTags {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Tag identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Tag contract Properties.␊ - */␊ - properties: (TagContractProperties | string)␊ - type: "Microsoft.ApiManagement/service/tags"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/templates␊ - */␊ - export interface ServiceTemplates {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Email Template Name Identifier.␊ - */␊ - name: (("applicationApprovedNotificationMessage" | "accountClosedDeveloper" | "quotaLimitApproachingDeveloperNotificationMessage" | "newDeveloperNotificationMessage" | "emailChangeIdentityDefault" | "inviteUserNotificationMessage" | "newCommentNotificationMessage" | "confirmSignUpIdentityDefault" | "newIssueNotificationMessage" | "purchaseDeveloperNotificationMessage" | "passwordResetIdentityDefault" | "passwordResetByAdminNotificationMessage" | "rejectDeveloperNotificationMessage" | "requestDeveloperNotificationMessage") | string)␊ - /**␊ - * Email Template Update Contract properties.␊ - */␊ - properties: (EmailTemplateUpdateParameterProperties | string)␊ - type: "Microsoft.ApiManagement/service/templates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/users␊ - */␊ - export interface ServiceUsers1 {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * User identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Parameters supplied to the Create User operation.␊ - */␊ - properties: (UserCreateParameterProperties | string)␊ - type: "Microsoft.ApiManagement/service/users"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/diagnostics␊ - */␊ - export interface ServiceApisDiagnostics {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Diagnostic identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Diagnostic Entity Properties␊ - */␊ - properties: (DiagnosticContractProperties | string)␊ - resources?: ServiceApisDiagnosticsLoggersChildResource[]␊ - type: "Microsoft.ApiManagement/service/apis/diagnostics"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/diagnostics/loggers␊ - */␊ - export interface ServiceApisDiagnosticsLoggersChildResource {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Logger identifier. Must be unique in the API Management service instance.␊ - */␊ - name: string␊ - type: "loggers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/issues␊ - */␊ - export interface ServiceApisIssues {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Issue identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Issue contract Properties.␊ - */␊ - properties: (IssueContractProperties | string)␊ - resources?: (ServiceApisIssuesCommentsChildResource | ServiceApisIssuesAttachmentsChildResource)[]␊ - type: "Microsoft.ApiManagement/service/apis/issues"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/issues/comments␊ - */␊ - export interface ServiceApisIssuesCommentsChildResource {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Comment identifier within an Issue. Must be unique in the current Issue.␊ - */␊ - name: string␊ - /**␊ - * Issue Comment contract Properties.␊ - */␊ - properties: (IssueCommentContractProperties | string)␊ - type: "comments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Issue Comment contract Properties.␊ - */␊ - export interface IssueCommentContractProperties {␊ - /**␊ - * Date and time when the comment was created.␊ - */␊ - createdDate?: string␊ - /**␊ - * Comment text.␊ - */␊ - text: string␊ - /**␊ - * A resource identifier for the user who left the comment.␊ - */␊ - userId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/issues/attachments␊ - */␊ - export interface ServiceApisIssuesAttachmentsChildResource {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Attachment identifier within an Issue. Must be unique in the current Issue.␊ - */␊ - name: string␊ - /**␊ - * Issue Attachment contract Properties.␊ - */␊ - properties: (IssueAttachmentContractProperties | string)␊ - type: "attachments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Issue Attachment contract Properties.␊ - */␊ - export interface IssueAttachmentContractProperties {␊ - /**␊ - * An HTTP link or Base64-encoded binary data.␊ - */␊ - content: string␊ - /**␊ - * Either 'link' if content is provided via an HTTP link or the MIME type of the Base64-encoded binary data provided in the 'content' property.␊ - */␊ - contentFormat: string␊ - /**␊ - * Filename by which the binary data will be saved.␊ - */␊ - title: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/api-version-sets␊ - */␊ - export interface ServiceApiVersionSets {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Api Version Set identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Properties of an API Version Set.␊ - */␊ - properties: (ApiVersionSetContractProperties | string)␊ - type: "Microsoft.ApiManagement/service/api-version-sets"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/diagnostics/loggers␊ - */␊ - export interface ServiceApisDiagnosticsLoggers {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Logger identifier. Must be unique in the API Management service instance.␊ - */␊ - name: string␊ - type: "Microsoft.ApiManagement/service/apis/diagnostics/loggers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/issues/attachments␊ - */␊ - export interface ServiceApisIssuesAttachments {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Attachment identifier within an Issue. Must be unique in the current Issue.␊ - */␊ - name: string␊ - /**␊ - * Issue Attachment contract Properties.␊ - */␊ - properties: (IssueAttachmentContractProperties | string)␊ - type: "Microsoft.ApiManagement/service/apis/issues/attachments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/issues/comments␊ - */␊ - export interface ServiceApisIssuesComments {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Comment identifier within an Issue. Must be unique in the current Issue.␊ - */␊ - name: string␊ - /**␊ - * Issue Comment contract Properties.␊ - */␊ - properties: (IssueCommentContractProperties | string)␊ - type: "Microsoft.ApiManagement/service/apis/issues/comments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service␊ - */␊ - export interface Service2 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Identity properties of the Api Management service resource.␊ - */␊ - identity?: (ApiManagementServiceIdentity1 | string)␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the API Management service.␊ - */␊ - name: string␊ - /**␊ - * Properties of an API Management service resource description.␊ - */␊ - properties: (ApiManagementServiceProperties2 | string)␊ - resources?: (ServicePoliciesChildResource1 | ServiceApisChildResource2 | ServiceAuthorizationServersChildResource2 | ServiceBackendsChildResource2 | ServiceCertificatesChildResource2 | ServiceDiagnosticsChildResource1 | ServiceTemplatesChildResource1 | ServiceGroupsChildResource2 | ServiceIdentityProvidersChildResource2 | ServiceLoggersChildResource2 | ServiceNotificationsChildResource1 | ServiceOpenidConnectProvidersChildResource2 | ServicePortalsettingsChildResource1 | ServiceProductsChildResource2 | ServicePropertiesChildResource2 | ServiceSubscriptionsChildResource2 | ServiceTagsChildResource1 | ServiceUsersChildResource2 | ServiceApiVersionSetsChildResource1)[]␊ - /**␊ - * API Management service resource SKU properties.␊ - */␊ - sku: (ApiManagementServiceSkuProperties2 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.ApiManagement/service"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity properties of the Api Management service resource.␊ - */␊ - export interface ApiManagementServiceIdentity1 {␊ - /**␊ - * The identity type. Currently the only supported type is 'SystemAssigned'.␊ - */␊ - type: ("SystemAssigned" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of an API Management service resource description.␊ - */␊ - export interface ApiManagementServiceProperties2 {␊ - /**␊ - * Additional datacenter locations of the API Management service.␊ - */␊ - additionalLocations?: (AdditionalLocation1[] | string)␊ - /**␊ - * List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.␊ - */␊ - certificates?: (CertificateConfiguration1[] | string)␊ - /**␊ - * Custom properties of the API Management service. Setting \`Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168\` will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2). Setting \`Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11\` can be used to disable just TLS 1.1 and setting \`Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10\` can be used to disable TLS 1.0 on an API Management service.␊ - */␊ - customProperties?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Custom hostname configuration of the API Management service.␊ - */␊ - hostnameConfigurations?: (HostnameConfiguration2[] | string)␊ - /**␊ - * Email address from which the notification will be sent.␊ - */␊ - notificationSenderEmail?: string␊ - /**␊ - * Publisher email.␊ - */␊ - publisherEmail: string␊ - /**␊ - * Publisher name.␊ - */␊ - publisherName: string␊ - /**␊ - * Configuration of a virtual network to which API Management service is deployed.␊ - */␊ - virtualNetworkConfiguration?: (VirtualNetworkConfiguration8 | string)␊ - /**␊ - * The type of VPN in which API Management service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only.␊ - */␊ - virtualNetworkType?: (("None" | "External" | "Internal") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of an additional API Management resource location.␊ - */␊ - export interface AdditionalLocation1 {␊ - /**␊ - * The location name of the additional region among Azure Data center regions.␊ - */␊ - location: string␊ - /**␊ - * API Management service resource SKU properties.␊ - */␊ - sku: (ApiManagementServiceSkuProperties2 | string)␊ - /**␊ - * Configuration of a virtual network to which API Management service is deployed.␊ - */␊ - virtualNetworkConfiguration?: (VirtualNetworkConfiguration8 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * API Management service resource SKU properties.␊ - */␊ - export interface ApiManagementServiceSkuProperties2 {␊ - /**␊ - * Capacity of the SKU (number of deployed units of the SKU). The default value is 1.␊ - */␊ - capacity?: ((number & string) | string)␊ - /**␊ - * Name of the Sku.␊ - */␊ - name: (("Developer" | "Standard" | "Premium" | "Basic") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Configuration of a virtual network to which API Management service is deployed.␊ - */␊ - export interface VirtualNetworkConfiguration8 {␊ - /**␊ - * The full resource ID of a subnet in a virtual network to deploy the API Management service in.␊ - */␊ - subnetResourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Certificate configuration which consist of non-trusted intermediates and root certificates.␊ - */␊ - export interface CertificateConfiguration1 {␊ - /**␊ - * SSL certificate information.␊ - */␊ - certificate?: (CertificateInformation1 | string)␊ - /**␊ - * Certificate Password.␊ - */␊ - certificatePassword?: string␊ - /**␊ - * Base64 Encoded certificate.␊ - */␊ - encodedCertificate?: string␊ - /**␊ - * The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations.␊ - */␊ - storeName: (("CertificateAuthority" | "Root") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSL certificate information.␊ - */␊ - export interface CertificateInformation1 {␊ - /**␊ - * Expiration date of the certificate. The date conforms to the following format: \`yyyy-MM-ddTHH:mm:ssZ\` as specified by the ISO 8601 standard.␊ - */␊ - expiry: string␊ - /**␊ - * Subject of the certificate.␊ - */␊ - subject: string␊ - /**␊ - * Thumbprint of the certificate.␊ - */␊ - thumbprint: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Custom hostname configuration.␊ - */␊ - export interface HostnameConfiguration2 {␊ - /**␊ - * SSL certificate information.␊ - */␊ - certificate?: (CertificateInformation1 | string)␊ - /**␊ - * Certificate Password.␊ - */␊ - certificatePassword?: string␊ - /**␊ - * Specify true to setup the certificate associated with this Hostname as the Default SSL Certificate. If a client does not send the SNI header, then this will be the certificate that will be challenged. The property is useful if a service has multiple custom hostname enabled and it needs to decide on the default ssl certificate. The setting only applied to Proxy Hostname Type.␊ - */␊ - defaultSslBinding?: (boolean | string)␊ - /**␊ - * Base64 Encoded certificate.␊ - */␊ - encodedCertificate?: string␊ - /**␊ - * Hostname to configure on the Api Management service.␊ - */␊ - hostName: string␊ - /**␊ - * Url to the KeyVault Secret containing the Ssl Certificate. If absolute Url containing version is provided, auto-update of ssl certificate will not work. This requires Api Management service to be configured with MSI. The secret should be of type *application/x-pkcs12*␊ - */␊ - keyVaultId?: string␊ - /**␊ - * Specify true to always negotiate client certificate on the hostname. Default Value is false.␊ - */␊ - negotiateClientCertificate?: (boolean | string)␊ - /**␊ - * Hostname type.␊ - */␊ - type: (("Proxy" | "Portal" | "Management" | "Scm") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/policies␊ - */␊ - export interface ServicePoliciesChildResource1 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * The identifier of the Policy.␊ - */␊ - name: "policy"␊ - /**␊ - * Policy contract Properties.␊ - */␊ - properties: (PolicyContractProperties1 | string)␊ - type: "policies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Policy contract Properties.␊ - */␊ - export interface PolicyContractProperties1 {␊ - /**␊ - * Format of the policyContent.␊ - */␊ - contentFormat?: (("xml" | "xml-link" | "rawxml" | "rawxml-link") | string)␊ - /**␊ - * Json escaped Xml Encoded contents of the Policy.␊ - */␊ - policyContent: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis␊ - */␊ - export interface ServiceApisChildResource2 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.␊ - */␊ - name: string␊ - /**␊ - * Api Create or Update Properties.␊ - */␊ - properties: (ApiCreateOrUpdateProperties1 | string)␊ - type: "apis"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Api Create or Update Properties.␊ - */␊ - export interface ApiCreateOrUpdateProperties1 {␊ - /**␊ - * Describes the Revision of the Api. If no value is provided, default revision 1 is created␊ - */␊ - apiRevision?: string␊ - /**␊ - * Description of the Api Revision.␊ - */␊ - apiRevisionDescription?: string␊ - /**␊ - * Type of Api to create. ␊ - * * \`http\` creates a SOAP to REST API ␊ - * * \`soap\` creates a SOAP pass-through API.␊ - */␊ - apiType?: (("http" | "soap") | string)␊ - /**␊ - * Indicates the Version identifier of the API if the API is versioned␊ - */␊ - apiVersion?: string␊ - /**␊ - * Description of the Api Version.␊ - */␊ - apiVersionDescription?: string␊ - /**␊ - * An API Version Set contains the common configuration for a set of API Versions relating ␊ - */␊ - apiVersionSet?: (ApiVersionSetContractDetails | string)␊ - /**␊ - * A resource identifier for the related ApiVersionSet.␊ - */␊ - apiVersionSetId?: string␊ - /**␊ - * API Authentication Settings.␊ - */␊ - authenticationSettings?: (AuthenticationSettingsContract2 | string)␊ - /**␊ - * Format of the Content in which the API is getting imported.␊ - */␊ - contentFormat?: (("wadl-xml" | "wadl-link-json" | "swagger-json" | "swagger-link-json" | "wsdl" | "wsdl-link") | string)␊ - /**␊ - * Content value when Importing an API.␊ - */␊ - contentValue?: string␊ - /**␊ - * Description of the API. May include HTML formatting tags.␊ - */␊ - description?: string␊ - /**␊ - * API name.␊ - */␊ - displayName?: string␊ - /**␊ - * Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.␊ - */␊ - path: string␊ - /**␊ - * Describes on which protocols the operations in this API can be invoked.␊ - */␊ - protocols?: (("http" | "https")[] | string)␊ - /**␊ - * Absolute URL of the backend service implementing this API.␊ - */␊ - serviceUrl?: string␊ - /**␊ - * Subscription key parameter names details.␊ - */␊ - subscriptionKeyParameterNames?: (SubscriptionKeyParameterNamesContract2 | string)␊ - /**␊ - * Type of API.␊ - */␊ - type?: (("http" | "soap") | string)␊ - /**␊ - * Criteria to limit import of WSDL to a subset of the document.␊ - */␊ - wsdlSelector?: (ApiCreateOrUpdatePropertiesWsdlSelector1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An API Version Set contains the common configuration for a set of API Versions relating ␊ - */␊ - export interface ApiVersionSetContractDetails {␊ - /**␊ - * Description of API Version Set.␊ - */␊ - description?: string␊ - /**␊ - * Identifier for existing API Version Set. Omit this value to create a new Version Set.␊ - */␊ - id?: string␊ - /**␊ - * Name of HTTP header parameter that indicates the API Version if versioningScheme is set to \`header\`.␊ - */␊ - versionHeaderName?: string␊ - /**␊ - * An value that determines where the API Version identifier will be located in a HTTP request.␊ - */␊ - versioningScheme?: (("Segment" | "Query" | "Header") | string)␊ - /**␊ - * Name of query parameter that indicates the API Version if versioningScheme is set to \`query\`.␊ - */␊ - versionQueryName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * API Authentication Settings.␊ - */␊ - export interface AuthenticationSettingsContract2 {␊ - /**␊ - * API OAuth2 Authentication settings details.␊ - */␊ - oAuth2?: (OAuth2AuthenticationSettingsContract2 | string)␊ - /**␊ - * API OAuth2 Authentication settings details.␊ - */␊ - openid?: (OpenIdAuthenticationSettingsContract | string)␊ - /**␊ - * Specifies whether subscription key is required during call to this API, true - API is included into closed products only, false - API is included into open products alone, null - there is a mix of products.␊ - */␊ - subscriptionKeyRequired?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * API OAuth2 Authentication settings details.␊ - */␊ - export interface OAuth2AuthenticationSettingsContract2 {␊ - /**␊ - * OAuth authorization server identifier.␊ - */␊ - authorizationServerId?: string␊ - /**␊ - * operations scope.␊ - */␊ - scope?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * API OAuth2 Authentication settings details.␊ - */␊ - export interface OpenIdAuthenticationSettingsContract {␊ - /**␊ - * How to send token to the server.␊ - */␊ - bearerTokenSendingMethods?: (("authorizationHeader" | "query")[] | string)␊ - /**␊ - * OAuth authorization server identifier.␊ - */␊ - openidProviderId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Subscription key parameter names details.␊ - */␊ - export interface SubscriptionKeyParameterNamesContract2 {␊ - /**␊ - * Subscription key header name.␊ - */␊ - header?: string␊ - /**␊ - * Subscription key query string parameter name.␊ - */␊ - query?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Criteria to limit import of WSDL to a subset of the document.␊ - */␊ - export interface ApiCreateOrUpdatePropertiesWsdlSelector1 {␊ - /**␊ - * Name of endpoint(port) to import from WSDL␊ - */␊ - wsdlEndpointName?: string␊ - /**␊ - * Name of service to import from WSDL␊ - */␊ - wsdlServiceName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/authorizationServers␊ - */␊ - export interface ServiceAuthorizationServersChildResource2 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Identifier of the authorization server.␊ - */␊ - name: string␊ - /**␊ - * External OAuth authorization server settings Properties.␊ - */␊ - properties: (AuthorizationServerContractProperties1 | string)␊ - type: "authorizationServers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * External OAuth authorization server settings Properties.␊ - */␊ - export interface AuthorizationServerContractProperties1 {␊ - /**␊ - * OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.␊ - */␊ - authorizationEndpoint: string␊ - /**␊ - * HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.␊ - */␊ - authorizationMethods?: (("HEAD" | "OPTIONS" | "TRACE" | "GET" | "POST" | "PUT" | "PATCH" | "DELETE")[] | string)␊ - /**␊ - * Specifies the mechanism by which access token is passed to the API. ␊ - */␊ - bearerTokenSendingMethods?: (("authorizationHeader" | "query")[] | string)␊ - /**␊ - * Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format.␊ - */␊ - clientAuthenticationMethod?: (("Basic" | "Body")[] | string)␊ - /**␊ - * Client or app id registered with this authorization server.␊ - */␊ - clientId: string␊ - /**␊ - * Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced.␊ - */␊ - clientRegistrationEndpoint: string␊ - /**␊ - * Client or app secret registered with this authorization server.␊ - */␊ - clientSecret?: string␊ - /**␊ - * Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values.␊ - */␊ - defaultScope?: string␊ - /**␊ - * Description of the authorization server. Can contain HTML formatting tags.␊ - */␊ - description?: string␊ - /**␊ - * User-friendly authorization server name.␊ - */␊ - displayName: string␊ - /**␊ - * Form of an authorization grant, which the client uses to request the access token.␊ - */␊ - grantTypes: (("authorizationCode" | "implicit" | "resourceOwnerPassword" | "clientCredentials")[] | string)␊ - /**␊ - * Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.␊ - */␊ - resourceOwnerPassword?: string␊ - /**␊ - * Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.␊ - */␊ - resourceOwnerUsername?: string␊ - /**␊ - * If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security.␊ - */␊ - supportState?: (boolean | string)␊ - /**␊ - * Additional parameters required by the token endpoint of this authorization server represented as an array of JSON objects with name and value string properties, i.e. {"name" : "name value", "value": "a value"}.␊ - */␊ - tokenBodyParameters?: (TokenBodyParameterContract2[] | string)␊ - /**␊ - * OAuth token endpoint. Contains absolute URI to entity being referenced.␊ - */␊ - tokenEndpoint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * OAuth acquire token request body parameter (www-url-form-encoded).␊ - */␊ - export interface TokenBodyParameterContract2 {␊ - /**␊ - * body parameter name.␊ - */␊ - name: string␊ - /**␊ - * body parameter value.␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/backends␊ - */␊ - export interface ServiceBackendsChildResource2 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Identifier of the Backend entity. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Parameters supplied to the Create Backend operation.␊ - */␊ - properties: (BackendContractProperties1 | string)␊ - type: "backends"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters supplied to the Create Backend operation.␊ - */␊ - export interface BackendContractProperties1 {␊ - /**␊ - * Details of the Credentials used to connect to Backend.␊ - */␊ - credentials?: (BackendCredentialsContract1 | string)␊ - /**␊ - * Backend Description.␊ - */␊ - description?: string␊ - /**␊ - * Properties specific to the Backend Type.␊ - */␊ - properties?: (BackendProperties1 | string)␊ - /**␊ - * Backend communication protocol.␊ - */␊ - protocol: (("http" | "soap") | string)␊ - /**␊ - * Details of the Backend WebProxy Server to use in the Request to Backend.␊ - */␊ - proxy?: (BackendProxyContract1 | string)␊ - /**␊ - * Management Uri of the Resource in External System. This url can be the Arm Resource Id of Logic Apps, Function Apps or Api Apps.␊ - */␊ - resourceId?: string␊ - /**␊ - * Backend Title.␊ - */␊ - title?: string␊ - /**␊ - * Properties controlling TLS Certificate Validation.␊ - */␊ - tls?: (BackendTlsProperties1 | string)␊ - /**␊ - * Runtime Url of the Backend.␊ - */␊ - url: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Details of the Credentials used to connect to Backend.␊ - */␊ - export interface BackendCredentialsContract1 {␊ - /**␊ - * Authorization header information.␊ - */␊ - authorization?: (BackendAuthorizationHeaderCredentials1 | string)␊ - /**␊ - * List of Client Certificate Thumbprint.␊ - */␊ - certificate?: (string[] | string)␊ - /**␊ - * Header Parameter description.␊ - */␊ - header?: ({␊ - [k: string]: string[]␊ - } | string)␊ - /**␊ - * Query Parameter description.␊ - */␊ - query?: ({␊ - [k: string]: string[]␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authorization header information.␊ - */␊ - export interface BackendAuthorizationHeaderCredentials1 {␊ - /**␊ - * Authentication Parameter value.␊ - */␊ - parameter: string␊ - /**␊ - * Authentication Scheme name.␊ - */␊ - scheme: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to the Backend Type.␊ - */␊ - export interface BackendProperties1 {␊ - /**␊ - * Properties of the Service Fabric Type Backend.␊ - */␊ - serviceFabricCluster?: (BackendServiceFabricClusterProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Service Fabric Type Backend.␊ - */␊ - export interface BackendServiceFabricClusterProperties1 {␊ - /**␊ - * The client certificate thumbprint for the management endpoint.␊ - */␊ - clientCertificatethumbprint: string␊ - /**␊ - * The cluster management endpoint.␊ - */␊ - managementEndpoints: (string[] | string)␊ - /**␊ - * Maximum number of retries while attempting resolve the partition.␊ - */␊ - maxPartitionResolutionRetries?: (number | string)␊ - /**␊ - * Thumbprints of certificates cluster management service uses for tls communication␊ - */␊ - serverCertificateThumbprints?: (string[] | string)␊ - /**␊ - * Server X509 Certificate Names Collection␊ - */␊ - serverX509Names?: (X509CertificateName1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of server X509Names.␊ - */␊ - export interface X509CertificateName1 {␊ - /**␊ - * Thumbprint for the Issuer of the Certificate.␊ - */␊ - issuerCertificateThumbprint?: string␊ - /**␊ - * Common Name of the Certificate.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Details of the Backend WebProxy Server to use in the Request to Backend.␊ - */␊ - export interface BackendProxyContract1 {␊ - /**␊ - * Password to connect to the WebProxy Server␊ - */␊ - password?: string␊ - /**␊ - * WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings.␊ - */␊ - url: string␊ - /**␊ - * Username to connect to the WebProxy server␊ - */␊ - username?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties controlling TLS Certificate Validation.␊ - */␊ - export interface BackendTlsProperties1 {␊ - /**␊ - * Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host.␊ - */␊ - validateCertificateChain?: (boolean | string)␊ - /**␊ - * Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host.␊ - */␊ - validateCertificateName?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/certificates␊ - */␊ - export interface ServiceCertificatesChildResource2 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Identifier of the certificate entity. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Parameters supplied to the CreateOrUpdate certificate operation.␊ - */␊ - properties: (CertificateCreateOrUpdateProperties3 | string)␊ - type: "certificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters supplied to the CreateOrUpdate certificate operation.␊ - */␊ - export interface CertificateCreateOrUpdateProperties3 {␊ - /**␊ - * Base 64 encoded certificate using the application/x-pkcs12 representation.␊ - */␊ - data: string␊ - /**␊ - * Password for the Certificate␊ - */␊ - password: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/diagnostics␊ - */␊ - export interface ServiceDiagnosticsChildResource1 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Diagnostic identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Diagnostic Entity Properties␊ - */␊ - properties: (DiagnosticContractProperties1 | string)␊ - type: "diagnostics"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Diagnostic Entity Properties␊ - */␊ - export interface DiagnosticContractProperties1 {␊ - /**␊ - * Indicates whether a diagnostic should receive data or not.␊ - */␊ - enabled: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/templates␊ - */␊ - export interface ServiceTemplatesChildResource1 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Email Template Name Identifier.␊ - */␊ - name: (("applicationApprovedNotificationMessage" | "accountClosedDeveloper" | "quotaLimitApproachingDeveloperNotificationMessage" | "newDeveloperNotificationMessage" | "emailChangeIdentityDefault" | "inviteUserNotificationMessage" | "newCommentNotificationMessage" | "confirmSignUpIdentityDefault" | "newIssueNotificationMessage" | "purchaseDeveloperNotificationMessage" | "passwordResetIdentityDefault" | "passwordResetByAdminNotificationMessage" | "rejectDeveloperNotificationMessage" | "requestDeveloperNotificationMessage") | string)␊ - /**␊ - * Email Template Update Contract properties.␊ - */␊ - properties: (EmailTemplateUpdateParameterProperties1 | string)␊ - type: "templates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Email Template Update Contract properties.␊ - */␊ - export interface EmailTemplateUpdateParameterProperties1 {␊ - /**␊ - * Email Template Body. This should be a valid XDocument␊ - */␊ - body?: string␊ - /**␊ - * Description of the Email Template.␊ - */␊ - description?: string␊ - /**␊ - * Email Template Parameter values.␊ - */␊ - parameters?: (EmailTemplateParametersContractProperties1[] | string)␊ - /**␊ - * Subject of the Template.␊ - */␊ - subject?: string␊ - /**␊ - * Title of the Template.␊ - */␊ - title?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Email Template Parameter contract.␊ - */␊ - export interface EmailTemplateParametersContractProperties1 {␊ - /**␊ - * Template parameter description.␊ - */␊ - description?: string␊ - /**␊ - * Template parameter name.␊ - */␊ - name?: string␊ - /**␊ - * Template parameter title.␊ - */␊ - title?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/groups␊ - */␊ - export interface ServiceGroupsChildResource2 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Group identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Parameters supplied to the Create Group operation.␊ - */␊ - properties: (GroupCreateParametersProperties1 | string)␊ - type: "groups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters supplied to the Create Group operation.␊ - */␊ - export interface GroupCreateParametersProperties1 {␊ - /**␊ - * Group description.␊ - */␊ - description?: string␊ - /**␊ - * Group name.␊ - */␊ - displayName: string␊ - /**␊ - * Identifier of the external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://.onmicrosoft.com/groups/; otherwise the value is null.␊ - */␊ - externalId?: string␊ - /**␊ - * Group type.␊ - */␊ - type?: (("custom" | "system" | "external") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/identityProviders␊ - */␊ - export interface ServiceIdentityProvidersChildResource2 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Identity Provider Type identifier.␊ - */␊ - name: (("facebook" | "google" | "microsoft" | "twitter" | "aad" | "aadB2C") | string)␊ - /**␊ - * The external Identity Providers like Facebook, Google, Microsoft, Twitter or Azure Active Directory which can be used to enable access to the API Management service developer portal for all users.␊ - */␊ - properties: (IdentityProviderContractProperties1 | string)␊ - type: "identityProviders"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The external Identity Providers like Facebook, Google, Microsoft, Twitter or Azure Active Directory which can be used to enable access to the API Management service developer portal for all users.␊ - */␊ - export interface IdentityProviderContractProperties1 {␊ - /**␊ - * List of Allowed Tenants when configuring Azure Active Directory login.␊ - */␊ - allowedTenants?: (string[] | string)␊ - /**␊ - * Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft.␊ - */␊ - clientId: string␊ - /**␊ - * Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft.␊ - */␊ - clientSecret: string␊ - /**␊ - * Password Reset Policy Name. Only applies to AAD B2C Identity Provider.␊ - */␊ - passwordResetPolicyName?: string␊ - /**␊ - * Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.␊ - */␊ - profileEditingPolicyName?: string␊ - /**␊ - * Signin Policy Name. Only applies to AAD B2C Identity Provider.␊ - */␊ - signinPolicyName?: string␊ - /**␊ - * Signup Policy Name. Only applies to AAD B2C Identity Provider.␊ - */␊ - signupPolicyName?: string␊ - /**␊ - * Identity Provider Type identifier.␊ - */␊ - type?: (("facebook" | "google" | "microsoft" | "twitter" | "aad" | "aadB2C") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/loggers␊ - */␊ - export interface ServiceLoggersChildResource2 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Logger identifier. Must be unique in the API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * The Logger entity in API Management represents an event sink that you can use to log API Management events. Currently the Logger entity supports logging API Management events to Azure Event Hubs.␊ - */␊ - properties: (LoggerContractProperties1 | string)␊ - type: "loggers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Logger entity in API Management represents an event sink that you can use to log API Management events. Currently the Logger entity supports logging API Management events to Azure Event Hubs.␊ - */␊ - export interface LoggerContractProperties1 {␊ - /**␊ - * The name and SendRule connection string of the event hub for azureEventHub logger.␊ - * Instrumentation key for applicationInsights logger.␊ - */␊ - credentials: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Logger description.␊ - */␊ - description?: string␊ - /**␊ - * Whether records are buffered in the logger before publishing. Default is assumed to be true.␊ - */␊ - isBuffered?: (boolean | string)␊ - /**␊ - * Logger type.␊ - */␊ - loggerType: (("azureEventHub" | "applicationInsights") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/notifications␊ - */␊ - export interface ServiceNotificationsChildResource1 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Notification Name Identifier.␊ - */␊ - name: (("RequestPublisherNotificationMessage" | "PurchasePublisherNotificationMessage" | "NewApplicationNotificationMessage" | "BCC" | "NewIssuePublisherNotificationMessage" | "AccountClosedPublisher" | "QuotaLimitApproachingPublisherNotificationMessage") | string)␊ - type: "notifications"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/openidConnectProviders␊ - */␊ - export interface ServiceOpenidConnectProvidersChildResource2 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Identifier of the OpenID Connect Provider.␊ - */␊ - name: string␊ - /**␊ - * OpenID Connect Providers Contract.␊ - */␊ - properties: (OpenidConnectProviderContractProperties1 | string)␊ - type: "openidConnectProviders"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * OpenID Connect Providers Contract.␊ - */␊ - export interface OpenidConnectProviderContractProperties1 {␊ - /**␊ - * Client ID of developer console which is the client application.␊ - */␊ - clientId: string␊ - /**␊ - * Client Secret of developer console which is the client application.␊ - */␊ - clientSecret?: string␊ - /**␊ - * User-friendly description of OpenID Connect Provider.␊ - */␊ - description?: string␊ - /**␊ - * User-friendly OpenID Connect Provider name.␊ - */␊ - displayName: string␊ - /**␊ - * Metadata endpoint URI.␊ - */␊ - metadataEndpoint: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Sign-in settings contract properties.␊ - */␊ - export interface PortalSigninSettingProperties1 {␊ - /**␊ - * Redirect Anonymous users to the Sign-In page.␊ - */␊ - enabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Sign-up settings contract properties.␊ - */␊ - export interface PortalSignupSettingsProperties1 {␊ - /**␊ - * Allow users to sign up on a developer portal.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Terms of service contract properties.␊ - */␊ - termsOfService?: (TermsOfServiceProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Terms of service contract properties.␊ - */␊ - export interface TermsOfServiceProperties1 {␊ - /**␊ - * Ask user for consent to the terms of service.␊ - */␊ - consentRequired?: (boolean | string)␊ - /**␊ - * Display terms of service during a sign-up process.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * A terms of service text.␊ - */␊ - text?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Delegation settings contract properties.␊ - */␊ - export interface PortalDelegationSettingsProperties1 {␊ - /**␊ - * Subscriptions delegation settings properties.␊ - */␊ - subscriptions?: (SubscriptionsDelegationSettingsProperties1 | string)␊ - /**␊ - * A delegation Url.␊ - */␊ - url?: string␊ - /**␊ - * User registration delegation settings properties.␊ - */␊ - userRegistration?: (RegistrationDelegationSettingsProperties1 | string)␊ - /**␊ - * A base64-encoded validation key to validate, that a request is coming from Azure API Management.␊ - */␊ - validationKey?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Subscriptions delegation settings properties.␊ - */␊ - export interface SubscriptionsDelegationSettingsProperties1 {␊ - /**␊ - * Enable or disable delegation for subscriptions.␊ - */␊ - enabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * User registration delegation settings properties.␊ - */␊ - export interface RegistrationDelegationSettingsProperties1 {␊ - /**␊ - * Enable or disable delegation for user registration.␊ - */␊ - enabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/products␊ - */␊ - export interface ServiceProductsChildResource2 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Product identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Product profile.␊ - */␊ - properties: (ProductContractProperties1 | string)␊ - type: "products"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Product profile.␊ - */␊ - export interface ProductContractProperties1 {␊ - /**␊ - * whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of true.␊ - */␊ - approvalRequired?: (boolean | string)␊ - /**␊ - * Product description. May include HTML formatting tags.␊ - */␊ - description?: string␊ - /**␊ - * Product name.␊ - */␊ - displayName: string␊ - /**␊ - * whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished.␊ - */␊ - state?: (("notPublished" | "published") | string)␊ - /**␊ - * Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true.␊ - */␊ - subscriptionRequired?: (boolean | string)␊ - /**␊ - * Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of true.␊ - */␊ - subscriptionsLimit?: (number | string)␊ - /**␊ - * Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process.␊ - */␊ - terms?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/properties␊ - */␊ - export interface ServicePropertiesChildResource2 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Identifier of the property.␊ - */␊ - name: string␊ - /**␊ - * Property Contract properties.␊ - */␊ - properties: (PropertyContractProperties1 | string)␊ - type: "properties"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Property Contract properties.␊ - */␊ - export interface PropertyContractProperties1 {␊ - /**␊ - * Unique name of Property. It may contain only letters, digits, period, dash, and underscore characters.␊ - */␊ - displayName: string␊ - /**␊ - * Determines whether the value is a secret and should be encrypted or not. Default value is false.␊ - */␊ - secret?: (boolean | string)␊ - /**␊ - * Optional tags that when provided can be used to filter the property list.␊ - */␊ - tags?: (string[] | string)␊ - /**␊ - * Value of the property. Can contain policy expressions. It may not be empty or consist only of whitespace.␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/subscriptions␊ - */␊ - export interface ServiceSubscriptionsChildResource2 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Subscription entity Identifier. The entity represents the association between a user and a product in API Management.␊ - */␊ - name: string␊ - /**␊ - * Parameters supplied to the Create subscription operation.␊ - */␊ - properties: (SubscriptionCreateParameterProperties1 | string)␊ - type: "subscriptions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters supplied to the Create subscription operation.␊ - */␊ - export interface SubscriptionCreateParameterProperties1 {␊ - /**␊ - * Subscription name.␊ - */␊ - displayName: string␊ - /**␊ - * Primary subscription key. If not specified during request key will be generated automatically.␊ - */␊ - primaryKey?: string␊ - /**␊ - * Product (product id path) for which subscription is being created in form /products/{productId}␊ - */␊ - productId: string␊ - /**␊ - * Secondary subscription key. If not specified during request key will be generated automatically.␊ - */␊ - secondaryKey?: string␊ - /**␊ - * Initial subscription state. If no value is specified, subscription is created with Submitted state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated.␊ - */␊ - state?: (("suspended" | "active" | "expired" | "submitted" | "rejected" | "cancelled") | string)␊ - /**␊ - * User (user id path) for whom subscription is being created in form /users/{uid}␊ - */␊ - userId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/tags␊ - */␊ - export interface ServiceTagsChildResource1 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Tag identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Tag contract Properties.␊ - */␊ - properties: (TagContractProperties1 | string)␊ - type: "tags"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Tag contract Properties.␊ - */␊ - export interface TagContractProperties1 {␊ - /**␊ - * Tag name.␊ - */␊ - displayName: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/users␊ - */␊ - export interface ServiceUsersChildResource2 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * User identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Parameters supplied to the Create User operation.␊ - */␊ - properties: (UserCreateParameterProperties1 | string)␊ - type: "users"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters supplied to the Create User operation.␊ - */␊ - export interface UserCreateParameterProperties1 {␊ - /**␊ - * Determines the type of confirmation e-mail that will be sent to the newly created user.␊ - */␊ - confirmation?: (("signup" | "invite") | string)␊ - /**␊ - * Email address. Must not be empty and must be unique within the service instance.␊ - */␊ - email: string␊ - /**␊ - * First name.␊ - */␊ - firstName: string␊ - /**␊ - * Collection of user identities.␊ - */␊ - identities?: (UserIdentityContract[] | string)␊ - /**␊ - * Last name.␊ - */␊ - lastName: string␊ - /**␊ - * Optional note about a user set by the administrator.␊ - */␊ - note?: string␊ - /**␊ - * User Password. If no value is provided, a default password is generated.␊ - */␊ - password?: string␊ - /**␊ - * Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active.␊ - */␊ - state?: (("active" | "blocked" | "pending" | "deleted") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * User identity details.␊ - */␊ - export interface UserIdentityContract {␊ - /**␊ - * Identifier value within provider.␊ - */␊ - id?: string␊ - /**␊ - * Identity provider name.␊ - */␊ - provider?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/api-version-sets␊ - */␊ - export interface ServiceApiVersionSetsChildResource1 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Api Version Set identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Properties of an API Version Set.␊ - */␊ - properties: (ApiVersionSetContractProperties1 | string)␊ - type: "api-version-sets"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of an API Version Set.␊ - */␊ - export interface ApiVersionSetContractProperties1 {␊ - /**␊ - * Description of API Version Set.␊ - */␊ - description?: string␊ - /**␊ - * Name of API Version Set␊ - */␊ - displayName: string␊ - /**␊ - * Name of HTTP header parameter that indicates the API Version if versioningScheme is set to \`header\`.␊ - */␊ - versionHeaderName?: string␊ - /**␊ - * An value that determines where the API Version identifier will be located in a HTTP request.␊ - */␊ - versioningScheme: (("Segment" | "Query" | "Header") | string)␊ - /**␊ - * Name of query parameter that indicates the API Version if versioningScheme is set to \`query\`.␊ - */␊ - versionQueryName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis␊ - */␊ - export interface ServiceApis2 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.␊ - */␊ - name: string␊ - /**␊ - * Api Create or Update Properties.␊ - */␊ - properties: (ApiCreateOrUpdateProperties1 | string)␊ - resources?: (ServiceApisReleasesChildResource1 | ServiceApisOperationsChildResource2 | ServiceApisPoliciesChildResource1 | ServiceApisSchemasChildResource1 | ServiceApisDiagnosticsChildResource1 | ServiceApisIssuesChildResource1 | ServiceApisTagsChildResource1 | ServiceApisTagDescriptionsChildResource1)[]␊ - type: "Microsoft.ApiManagement/service/apis"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/releases␊ - */␊ - export interface ServiceApisReleasesChildResource1 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Release identifier within an API. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * API Release details␊ - */␊ - properties: (ApiReleaseContractProperties1 | string)␊ - type: "releases"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * API Release details␊ - */␊ - export interface ApiReleaseContractProperties1 {␊ - /**␊ - * Identifier of the API the release belongs to.␊ - */␊ - apiId?: string␊ - /**␊ - * Release Notes␊ - */␊ - notes?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/operations␊ - */␊ - export interface ServiceApisOperationsChildResource2 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Operation identifier within an API. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Operation Contract Properties␊ - */␊ - properties: (OperationContractProperties1 | string)␊ - type: "operations"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Operation Contract Properties␊ - */␊ - export interface OperationContractProperties1 {␊ - /**␊ - * Description of the operation. May include HTML formatting tags.␊ - */␊ - description?: string␊ - /**␊ - * Operation Name.␊ - */␊ - displayName: string␊ - /**␊ - * A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.␊ - */␊ - method: string␊ - /**␊ - * Operation Policies␊ - */␊ - policies?: string␊ - /**␊ - * Operation request details.␊ - */␊ - request?: (RequestContract2 | string)␊ - /**␊ - * Array of Operation responses.␊ - */␊ - responses?: (ResponseContract1[] | string)␊ - /**␊ - * Collection of URL template parameters.␊ - */␊ - templateParameters?: (ParameterContract2[] | string)␊ - /**␊ - * Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}␊ - */␊ - urlTemplate: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Operation request details.␊ - */␊ - export interface RequestContract2 {␊ - /**␊ - * Operation request description.␊ - */␊ - description?: string␊ - /**␊ - * Collection of operation request headers.␊ - */␊ - headers?: (ParameterContract2[] | string)␊ - /**␊ - * Collection of operation request query parameters.␊ - */␊ - queryParameters?: (ParameterContract2[] | string)␊ - /**␊ - * Collection of operation request representations.␊ - */␊ - representations?: (RepresentationContract2[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Operation parameters details.␊ - */␊ - export interface ParameterContract2 {␊ - /**␊ - * Default parameter value.␊ - */␊ - defaultValue?: string␊ - /**␊ - * Parameter description.␊ - */␊ - description?: string␊ - /**␊ - * Parameter name.␊ - */␊ - name: string␊ - /**␊ - * whether parameter is required or not.␊ - */␊ - required?: (boolean | string)␊ - /**␊ - * Parameter type.␊ - */␊ - type: string␊ - /**␊ - * Parameter values.␊ - */␊ - values?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Operation request/response representation details.␊ - */␊ - export interface RepresentationContract2 {␊ - /**␊ - * Specifies a registered or custom content type for this representation, e.g. application/xml.␊ - */␊ - contentType: string␊ - /**␊ - * Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..␊ - */␊ - formParameters?: (ParameterContract2[] | string)␊ - /**␊ - * An example of the representation.␊ - */␊ - sample?: string␊ - /**␊ - * Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.␊ - */␊ - schemaId?: string␊ - /**␊ - * Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.␊ - */␊ - typeName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Operation response details.␊ - */␊ - export interface ResponseContract1 {␊ - /**␊ - * Operation response description.␊ - */␊ - description?: string␊ - /**␊ - * Collection of operation response headers.␊ - */␊ - headers?: (ParameterContract2[] | string)␊ - /**␊ - * Collection of operation response representations.␊ - */␊ - representations?: (RepresentationContract2[] | string)␊ - /**␊ - * Operation response HTTP status code.␊ - */␊ - statusCode: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/policies␊ - */␊ - export interface ServiceApisPoliciesChildResource1 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * The identifier of the Policy.␊ - */␊ - name: "policy"␊ - /**␊ - * Policy contract Properties.␊ - */␊ - properties: (PolicyContractProperties1 | string)␊ - type: "policies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/schemas␊ - */␊ - export interface ServiceApisSchemasChildResource1 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Schema identifier within an API. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Schema contract Properties.␊ - */␊ - properties: (SchemaContractProperties1 | string)␊ - type: "schemas"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Schema contract Properties.␊ - */␊ - export interface SchemaContractProperties1 {␊ - /**␊ - * Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml).␊ - */␊ - contentType: string␊ - /**␊ - * Schema Document Properties.␊ - */␊ - document?: (SchemaDocumentProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Schema Document Properties.␊ - */␊ - export interface SchemaDocumentProperties1 {␊ - /**␊ - * Json escaped string defining the document representing the Schema.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/diagnostics␊ - */␊ - export interface ServiceApisDiagnosticsChildResource1 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Diagnostic identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Diagnostic Entity Properties␊ - */␊ - properties: (DiagnosticContractProperties1 | string)␊ - type: "diagnostics"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/issues␊ - */␊ - export interface ServiceApisIssuesChildResource1 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Issue identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Issue contract Properties.␊ - */␊ - properties: (IssueContractProperties1 | string)␊ - type: "issues"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Issue contract Properties.␊ - */␊ - export interface IssueContractProperties1 {␊ - /**␊ - * A resource identifier for the API the issue was created for.␊ - */␊ - apiId?: string␊ - /**␊ - * Date and time when the issue was created.␊ - */␊ - createdDate?: string␊ - /**␊ - * Text describing the issue.␊ - */␊ - description: string␊ - /**␊ - * Status of the issue.␊ - */␊ - state?: (("proposed" | "open" | "removed" | "resolved" | "closed") | string)␊ - /**␊ - * The issue title.␊ - */␊ - title: string␊ - /**␊ - * A resource identifier for the user created the issue.␊ - */␊ - userId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/tags␊ - */␊ - export interface ServiceApisTagsChildResource1 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Tag identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "tags"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/tagDescriptions␊ - */␊ - export interface ServiceApisTagDescriptionsChildResource1 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Tag identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Parameters supplied to the Create TagDescription operation.␊ - */␊ - properties: (TagDescriptionBaseProperties1 | string)␊ - type: "tagDescriptions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters supplied to the Create TagDescription operation.␊ - */␊ - export interface TagDescriptionBaseProperties1 {␊ - /**␊ - * Description of the Tag.␊ - */␊ - description?: string␊ - /**␊ - * Description of the external resources describing the tag.␊ - */␊ - externalDocsDescription?: string␊ - /**␊ - * Absolute URL of external resources describing the tag.␊ - */␊ - externalDocsUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/operations␊ - */␊ - export interface ServiceApisOperations2 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Operation identifier within an API. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Operation Contract Properties␊ - */␊ - properties: (OperationContractProperties1 | string)␊ - resources?: (ServiceApisOperationsPoliciesChildResource1 | ServiceApisOperationsTagsChildResource1)[]␊ - type: "Microsoft.ApiManagement/service/apis/operations"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/operations/policies␊ - */␊ - export interface ServiceApisOperationsPoliciesChildResource1 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * The identifier of the Policy.␊ - */␊ - name: "policy"␊ - /**␊ - * Policy contract Properties.␊ - */␊ - properties: (PolicyContractProperties1 | string)␊ - type: "policies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/operations/tags␊ - */␊ - export interface ServiceApisOperationsTagsChildResource1 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Tag identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "tags"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/operations/policies␊ - */␊ - export interface ServiceApisOperationsPolicies1 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * The identifier of the Policy.␊ - */␊ - name: string␊ - /**␊ - * Policy contract Properties.␊ - */␊ - properties: (PolicyContractProperties1 | string)␊ - type: "Microsoft.ApiManagement/service/apis/operations/policies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/operations/tags␊ - */␊ - export interface ServiceApisOperationsTags1 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Tag identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "Microsoft.ApiManagement/service/apis/operations/tags"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/policies␊ - */␊ - export interface ServiceApisPolicies1 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * The identifier of the Policy.␊ - */␊ - name: string␊ - /**␊ - * Policy contract Properties.␊ - */␊ - properties: (PolicyContractProperties1 | string)␊ - type: "Microsoft.ApiManagement/service/apis/policies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/releases␊ - */␊ - export interface ServiceApisReleases1 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Release identifier within an API. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * API Release details␊ - */␊ - properties: (ApiReleaseContractProperties1 | string)␊ - type: "Microsoft.ApiManagement/service/apis/releases"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/schemas␊ - */␊ - export interface ServiceApisSchemas1 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Schema identifier within an API. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Schema contract Properties.␊ - */␊ - properties: (SchemaContractProperties1 | string)␊ - type: "Microsoft.ApiManagement/service/apis/schemas"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/tagDescriptions␊ - */␊ - export interface ServiceApisTagDescriptions1 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Tag identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Parameters supplied to the Create TagDescription operation.␊ - */␊ - properties: (TagDescriptionBaseProperties1 | string)␊ - type: "Microsoft.ApiManagement/service/apis/tagDescriptions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/tags␊ - */␊ - export interface ServiceApisTags1 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Tag identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "Microsoft.ApiManagement/service/apis/tags"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/authorizationServers␊ - */␊ - export interface ServiceAuthorizationServers2 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Identifier of the authorization server.␊ - */␊ - name: string␊ - /**␊ - * External OAuth authorization server settings Properties.␊ - */␊ - properties: (AuthorizationServerContractProperties1 | string)␊ - type: "Microsoft.ApiManagement/service/authorizationServers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/backends␊ - */␊ - export interface ServiceBackends2 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Identifier of the Backend entity. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Parameters supplied to the Create Backend operation.␊ - */␊ - properties: (BackendContractProperties1 | string)␊ - type: "Microsoft.ApiManagement/service/backends"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/certificates␊ - */␊ - export interface ServiceCertificates2 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Identifier of the certificate entity. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Parameters supplied to the CreateOrUpdate certificate operation.␊ - */␊ - properties: (CertificateCreateOrUpdateProperties3 | string)␊ - type: "Microsoft.ApiManagement/service/certificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/diagnostics␊ - */␊ - export interface ServiceDiagnostics1 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Diagnostic identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Diagnostic Entity Properties␊ - */␊ - properties: (DiagnosticContractProperties1 | string)␊ - resources?: ServiceDiagnosticsLoggersChildResource1[]␊ - type: "Microsoft.ApiManagement/service/diagnostics"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/diagnostics/loggers␊ - */␊ - export interface ServiceDiagnosticsLoggersChildResource1 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Logger identifier. Must be unique in the API Management service instance.␊ - */␊ - name: string␊ - type: "loggers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/diagnostics/loggers␊ - */␊ - export interface ServiceDiagnosticsLoggers1 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Logger identifier. Must be unique in the API Management service instance.␊ - */␊ - name: string␊ - type: "Microsoft.ApiManagement/service/diagnostics/loggers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/groups␊ - */␊ - export interface ServiceGroups2 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Group identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Parameters supplied to the Create Group operation.␊ - */␊ - properties: (GroupCreateParametersProperties1 | string)␊ - resources?: ServiceGroupsUsersChildResource2[]␊ - type: "Microsoft.ApiManagement/service/groups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/groups/users␊ - */␊ - export interface ServiceGroupsUsersChildResource2 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * User identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "users"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/groups/users␊ - */␊ - export interface ServiceGroupsUsers2 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * User identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "Microsoft.ApiManagement/service/groups/users"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/identityProviders␊ - */␊ - export interface ServiceIdentityProviders2 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Identity Provider Type identifier.␊ - */␊ - name: (("facebook" | "google" | "microsoft" | "twitter" | "aad" | "aadB2C") | string)␊ - /**␊ - * The external Identity Providers like Facebook, Google, Microsoft, Twitter or Azure Active Directory which can be used to enable access to the API Management service developer portal for all users.␊ - */␊ - properties: (IdentityProviderContractProperties1 | string)␊ - type: "Microsoft.ApiManagement/service/identityProviders"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/loggers␊ - */␊ - export interface ServiceLoggers2 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Logger identifier. Must be unique in the API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * The Logger entity in API Management represents an event sink that you can use to log API Management events. Currently the Logger entity supports logging API Management events to Azure Event Hubs.␊ - */␊ - properties: (LoggerContractProperties1 | string)␊ - type: "Microsoft.ApiManagement/service/loggers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/notifications␊ - */␊ - export interface ServiceNotifications1 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Notification Name Identifier.␊ - */␊ - name: (("RequestPublisherNotificationMessage" | "PurchasePublisherNotificationMessage" | "NewApplicationNotificationMessage" | "BCC" | "NewIssuePublisherNotificationMessage" | "AccountClosedPublisher" | "QuotaLimitApproachingPublisherNotificationMessage") | string)␊ - resources?: (ServiceNotificationsRecipientUsersChildResource1 | ServiceNotificationsRecipientEmailsChildResource1)[]␊ - type: "Microsoft.ApiManagement/service/notifications"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/notifications/recipientUsers␊ - */␊ - export interface ServiceNotificationsRecipientUsersChildResource1 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * User identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "recipientUsers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/notifications/recipientEmails␊ - */␊ - export interface ServiceNotificationsRecipientEmailsChildResource1 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Email identifier.␊ - */␊ - name: string␊ - type: "recipientEmails"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/notifications/recipientEmails␊ - */␊ - export interface ServiceNotificationsRecipientEmails1 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Email identifier.␊ - */␊ - name: string␊ - type: "Microsoft.ApiManagement/service/notifications/recipientEmails"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/notifications/recipientUsers␊ - */␊ - export interface ServiceNotificationsRecipientUsers1 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * User identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "Microsoft.ApiManagement/service/notifications/recipientUsers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/openidConnectProviders␊ - */␊ - export interface ServiceOpenidConnectProviders2 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Identifier of the OpenID Connect Provider.␊ - */␊ - name: string␊ - /**␊ - * OpenID Connect Providers Contract.␊ - */␊ - properties: (OpenidConnectProviderContractProperties1 | string)␊ - type: "Microsoft.ApiManagement/service/openidConnectProviders"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/policies␊ - */␊ - export interface ServicePolicies1 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * The identifier of the Policy.␊ - */␊ - name: string␊ - /**␊ - * Policy contract Properties.␊ - */␊ - properties: (PolicyContractProperties1 | string)␊ - type: "Microsoft.ApiManagement/service/policies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/products␊ - */␊ - export interface ServiceProducts2 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Product identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Product profile.␊ - */␊ - properties: (ProductContractProperties1 | string)␊ - resources?: (ServiceProductsApisChildResource2 | ServiceProductsGroupsChildResource2 | ServiceProductsPoliciesChildResource1 | ServiceProductsTagsChildResource1)[]␊ - type: "Microsoft.ApiManagement/service/products"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/products/apis␊ - */␊ - export interface ServiceProductsApisChildResource2 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.␊ - */␊ - name: string␊ - type: "apis"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/products/groups␊ - */␊ - export interface ServiceProductsGroupsChildResource2 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Group identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "groups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/products/policies␊ - */␊ - export interface ServiceProductsPoliciesChildResource1 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * The identifier of the Policy.␊ - */␊ - name: "policy"␊ - /**␊ - * Policy contract Properties.␊ - */␊ - properties: (PolicyContractProperties1 | string)␊ - type: "policies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/products/tags␊ - */␊ - export interface ServiceProductsTagsChildResource1 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Tag identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "tags"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/products/apis␊ - */␊ - export interface ServiceProductsApis2 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.␊ - */␊ - name: string␊ - type: "Microsoft.ApiManagement/service/products/apis"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/products/groups␊ - */␊ - export interface ServiceProductsGroups2 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Group identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "Microsoft.ApiManagement/service/products/groups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/products/policies␊ - */␊ - export interface ServiceProductsPolicies1 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * The identifier of the Policy.␊ - */␊ - name: string␊ - /**␊ - * Policy contract Properties.␊ - */␊ - properties: (PolicyContractProperties1 | string)␊ - type: "Microsoft.ApiManagement/service/products/policies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/products/tags␊ - */␊ - export interface ServiceProductsTags1 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Tag identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "Microsoft.ApiManagement/service/products/tags"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/properties␊ - */␊ - export interface ServiceProperties2 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Identifier of the property.␊ - */␊ - name: string␊ - /**␊ - * Property Contract properties.␊ - */␊ - properties: (PropertyContractProperties1 | string)␊ - type: "Microsoft.ApiManagement/service/properties"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/subscriptions␊ - */␊ - export interface ServiceSubscriptions2 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Subscription entity Identifier. The entity represents the association between a user and a product in API Management.␊ - */␊ - name: string␊ - /**␊ - * Parameters supplied to the Create subscription operation.␊ - */␊ - properties: (SubscriptionCreateParameterProperties1 | string)␊ - type: "Microsoft.ApiManagement/service/subscriptions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/tags␊ - */␊ - export interface ServiceTags1 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Tag identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Tag contract Properties.␊ - */␊ - properties: (TagContractProperties1 | string)␊ - type: "Microsoft.ApiManagement/service/tags"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/templates␊ - */␊ - export interface ServiceTemplates1 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Email Template Name Identifier.␊ - */␊ - name: (("applicationApprovedNotificationMessage" | "accountClosedDeveloper" | "quotaLimitApproachingDeveloperNotificationMessage" | "newDeveloperNotificationMessage" | "emailChangeIdentityDefault" | "inviteUserNotificationMessage" | "newCommentNotificationMessage" | "confirmSignUpIdentityDefault" | "newIssueNotificationMessage" | "purchaseDeveloperNotificationMessage" | "passwordResetIdentityDefault" | "passwordResetByAdminNotificationMessage" | "rejectDeveloperNotificationMessage" | "requestDeveloperNotificationMessage") | string)␊ - /**␊ - * Email Template Update Contract properties.␊ - */␊ - properties: (EmailTemplateUpdateParameterProperties1 | string)␊ - type: "Microsoft.ApiManagement/service/templates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/users␊ - */␊ - export interface ServiceUsers2 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * User identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Parameters supplied to the Create User operation.␊ - */␊ - properties: (UserCreateParameterProperties1 | string)␊ - type: "Microsoft.ApiManagement/service/users"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/diagnostics␊ - */␊ - export interface ServiceApisDiagnostics1 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Diagnostic identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Diagnostic Entity Properties␊ - */␊ - properties: (DiagnosticContractProperties1 | string)␊ - resources?: ServiceApisDiagnosticsLoggersChildResource1[]␊ - type: "Microsoft.ApiManagement/service/apis/diagnostics"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/diagnostics/loggers␊ - */␊ - export interface ServiceApisDiagnosticsLoggersChildResource1 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Logger identifier. Must be unique in the API Management service instance.␊ - */␊ - name: string␊ - type: "loggers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/issues␊ - */␊ - export interface ServiceApisIssues1 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Issue identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Issue contract Properties.␊ - */␊ - properties: (IssueContractProperties1 | string)␊ - resources?: (ServiceApisIssuesCommentsChildResource1 | ServiceApisIssuesAttachmentsChildResource1)[]␊ - type: "Microsoft.ApiManagement/service/apis/issues"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/issues/comments␊ - */␊ - export interface ServiceApisIssuesCommentsChildResource1 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Comment identifier within an Issue. Must be unique in the current Issue.␊ - */␊ - name: string␊ - /**␊ - * Issue Comment contract Properties.␊ - */␊ - properties: (IssueCommentContractProperties1 | string)␊ - type: "comments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Issue Comment contract Properties.␊ - */␊ - export interface IssueCommentContractProperties1 {␊ - /**␊ - * Date and time when the comment was created.␊ - */␊ - createdDate?: string␊ - /**␊ - * Comment text.␊ - */␊ - text: string␊ - /**␊ - * A resource identifier for the user who left the comment.␊ - */␊ - userId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/issues/attachments␊ - */␊ - export interface ServiceApisIssuesAttachmentsChildResource1 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Attachment identifier within an Issue. Must be unique in the current Issue.␊ - */␊ - name: string␊ - /**␊ - * Issue Attachment contract Properties.␊ - */␊ - properties: (IssueAttachmentContractProperties1 | string)␊ - type: "attachments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Issue Attachment contract Properties.␊ - */␊ - export interface IssueAttachmentContractProperties1 {␊ - /**␊ - * An HTTP link or Base64-encoded binary data.␊ - */␊ - content: string␊ - /**␊ - * Either 'link' if content is provided via an HTTP link or the MIME type of the Base64-encoded binary data provided in the 'content' property.␊ - */␊ - contentFormat: string␊ - /**␊ - * Filename by which the binary data will be saved.␊ - */␊ - title: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/api-version-sets␊ - */␊ - export interface ServiceApiVersionSets1 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Api Version Set identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Properties of an API Version Set.␊ - */␊ - properties: (ApiVersionSetContractProperties1 | string)␊ - type: "Microsoft.ApiManagement/service/api-version-sets"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/diagnostics/loggers␊ - */␊ - export interface ServiceApisDiagnosticsLoggers1 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Logger identifier. Must be unique in the API Management service instance.␊ - */␊ - name: string␊ - type: "Microsoft.ApiManagement/service/apis/diagnostics/loggers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/issues/attachments␊ - */␊ - export interface ServiceApisIssuesAttachments1 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Attachment identifier within an Issue. Must be unique in the current Issue.␊ - */␊ - name: string␊ - /**␊ - * Issue Attachment contract Properties.␊ - */␊ - properties: (IssueAttachmentContractProperties1 | string)␊ - type: "Microsoft.ApiManagement/service/apis/issues/attachments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/issues/comments␊ - */␊ - export interface ServiceApisIssuesComments1 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Comment identifier within an Issue. Must be unique in the current Issue.␊ - */␊ - name: string␊ - /**␊ - * Issue Comment contract Properties.␊ - */␊ - properties: (IssueCommentContractProperties1 | string)␊ - type: "Microsoft.ApiManagement/service/apis/issues/comments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service␊ - */␊ - export interface Service3 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Identity properties of the Api Management service resource.␊ - */␊ - identity?: (ApiManagementServiceIdentity2 | string)␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the API Management service.␊ - */␊ - name: string␊ - /**␊ - * Properties of an API Management service resource description.␊ - */␊ - properties: (ApiManagementServiceProperties3 | string)␊ - resources?: (ServiceApisChildResource3 | ServiceTagsChildResource2 | ServiceAuthorizationServersChildResource3 | ServiceBackendsChildResource3 | ServiceCachesChildResource | ServiceCertificatesChildResource3 | ServiceDiagnosticsChildResource2 | ServiceTemplatesChildResource2 | ServiceGroupsChildResource3 | ServiceIdentityProvidersChildResource3 | ServiceLoggersChildResource3 | ServiceNotificationsChildResource2 | ServiceOpenidConnectProvidersChildResource3 | ServicePoliciesChildResource2 | ServicePortalsettingsChildResource2 | ServiceProductsChildResource3 | ServicePropertiesChildResource3 | ServiceSubscriptionsChildResource3 | ServiceUsersChildResource3 | ServiceApiVersionSetsChildResource2)[]␊ - /**␊ - * API Management service resource SKU properties.␊ - */␊ - sku: (ApiManagementServiceSkuProperties3 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.ApiManagement/service"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity properties of the Api Management service resource.␊ - */␊ - export interface ApiManagementServiceIdentity2 {␊ - /**␊ - * The identity type. Currently the only supported type is 'SystemAssigned'.␊ - */␊ - type: ("SystemAssigned" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of an API Management service resource description.␊ - */␊ - export interface ApiManagementServiceProperties3 {␊ - /**␊ - * Additional datacenter locations of the API Management service.␊ - */␊ - additionalLocations?: (AdditionalLocation2[] | string)␊ - /**␊ - * List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.␊ - */␊ - certificates?: (CertificateConfiguration2[] | string)␊ - /**␊ - * Custom properties of the API Management service. Setting \`Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168\` will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2). Setting \`Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11\` can be used to disable just TLS 1.1 and setting \`Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10\` can be used to disable TLS 1.0 on an API Management service.␊ - */␊ - customProperties?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Custom hostname configuration of the API Management service.␊ - */␊ - hostnameConfigurations?: (HostnameConfiguration3[] | string)␊ - /**␊ - * Email address from which the notification will be sent.␊ - */␊ - notificationSenderEmail?: string␊ - /**␊ - * Publisher email.␊ - */␊ - publisherEmail: string␊ - /**␊ - * Publisher name.␊ - */␊ - publisherName: string␊ - /**␊ - * Configuration of a virtual network to which API Management service is deployed.␊ - */␊ - virtualNetworkConfiguration?: (VirtualNetworkConfiguration9 | string)␊ - /**␊ - * The type of VPN in which API Management service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only.␊ - */␊ - virtualNetworkType?: (("None" | "External" | "Internal") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of an additional API Management resource location.␊ - */␊ - export interface AdditionalLocation2 {␊ - /**␊ - * The location name of the additional region among Azure Data center regions.␊ - */␊ - location: string␊ - /**␊ - * API Management service resource SKU properties.␊ - */␊ - sku: (ApiManagementServiceSkuProperties3 | string)␊ - /**␊ - * Configuration of a virtual network to which API Management service is deployed.␊ - */␊ - virtualNetworkConfiguration?: (VirtualNetworkConfiguration9 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * API Management service resource SKU properties.␊ - */␊ - export interface ApiManagementServiceSkuProperties3 {␊ - /**␊ - * Capacity of the SKU (number of deployed units of the SKU). The default value is 1.␊ - */␊ - capacity?: ((number & string) | string)␊ - /**␊ - * Name of the Sku.␊ - */␊ - name: (("Developer" | "Standard" | "Premium" | "Basic" | "Consumption") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Configuration of a virtual network to which API Management service is deployed.␊ - */␊ - export interface VirtualNetworkConfiguration9 {␊ - /**␊ - * The full resource ID of a subnet in a virtual network to deploy the API Management service in.␊ - */␊ - subnetResourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Certificate configuration which consist of non-trusted intermediates and root certificates.␊ - */␊ - export interface CertificateConfiguration2 {␊ - /**␊ - * SSL certificate information.␊ - */␊ - certificate?: (CertificateInformation2 | string)␊ - /**␊ - * Certificate Password.␊ - */␊ - certificatePassword?: string␊ - /**␊ - * Base64 Encoded certificate.␊ - */␊ - encodedCertificate?: string␊ - /**␊ - * The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations.␊ - */␊ - storeName: (("CertificateAuthority" | "Root") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSL certificate information.␊ - */␊ - export interface CertificateInformation2 {␊ - /**␊ - * Expiration date of the certificate. The date conforms to the following format: \`yyyy-MM-ddTHH:mm:ssZ\` as specified by the ISO 8601 standard.␊ - */␊ - expiry: string␊ - /**␊ - * Subject of the certificate.␊ - */␊ - subject: string␊ - /**␊ - * Thumbprint of the certificate.␊ - */␊ - thumbprint: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Custom hostname configuration.␊ - */␊ - export interface HostnameConfiguration3 {␊ - /**␊ - * SSL certificate information.␊ - */␊ - certificate?: (CertificateInformation2 | string)␊ - /**␊ - * Certificate Password.␊ - */␊ - certificatePassword?: string␊ - /**␊ - * Specify true to setup the certificate associated with this Hostname as the Default SSL Certificate. If a client does not send the SNI header, then this will be the certificate that will be challenged. The property is useful if a service has multiple custom hostname enabled and it needs to decide on the default ssl certificate. The setting only applied to Proxy Hostname Type.␊ - */␊ - defaultSslBinding?: (boolean | string)␊ - /**␊ - * Base64 Encoded certificate.␊ - */␊ - encodedCertificate?: string␊ - /**␊ - * Hostname to configure on the Api Management service.␊ - */␊ - hostName: string␊ - /**␊ - * Url to the KeyVault Secret containing the Ssl Certificate. If absolute Url containing version is provided, auto-update of ssl certificate will not work. This requires Api Management service to be configured with MSI. The secret should be of type *application/x-pkcs12*␊ - */␊ - keyVaultId?: string␊ - /**␊ - * Specify true to always negotiate client certificate on the hostname. Default Value is false.␊ - */␊ - negotiateClientCertificate?: (boolean | string)␊ - /**␊ - * Hostname type.␊ - */␊ - type: (("Proxy" | "Portal" | "Management" | "Scm") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis␊ - */␊ - export interface ServiceApisChildResource3 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.␊ - */␊ - name: string␊ - /**␊ - * Api Create or Update Properties.␊ - */␊ - properties: (ApiCreateOrUpdateProperties2 | string)␊ - type: "apis"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Api Create or Update Properties.␊ - */␊ - export interface ApiCreateOrUpdateProperties2 {␊ - /**␊ - * Describes the Revision of the Api. If no value is provided, default revision 1 is created␊ - */␊ - apiRevision?: string␊ - /**␊ - * Description of the Api Revision.␊ - */␊ - apiRevisionDescription?: string␊ - /**␊ - * Type of Api to create. ␊ - * * \`http\` creates a SOAP to REST API ␊ - * * \`soap\` creates a SOAP pass-through API.␊ - */␊ - apiType?: (("http" | "soap") | string)␊ - /**␊ - * Indicates the Version identifier of the API if the API is versioned␊ - */␊ - apiVersion?: string␊ - /**␊ - * Description of the Api Version.␊ - */␊ - apiVersionDescription?: string␊ - /**␊ - * An API Version Set contains the common configuration for a set of API Versions relating ␊ - */␊ - apiVersionSet?: (ApiVersionSetContractDetails1 | string)␊ - /**␊ - * A resource identifier for the related ApiVersionSet.␊ - */␊ - apiVersionSetId?: string␊ - /**␊ - * API Authentication Settings.␊ - */␊ - authenticationSettings?: (AuthenticationSettingsContract3 | string)␊ - /**␊ - * Format of the Content in which the API is getting imported.␊ - */␊ - contentFormat?: (("wadl-xml" | "wadl-link-json" | "swagger-json" | "swagger-link-json" | "wsdl" | "wsdl-link" | "openapi" | "openapi+json" | "openapi-link") | string)␊ - /**␊ - * Content value when Importing an API.␊ - */␊ - contentValue?: string␊ - /**␊ - * Description of the API. May include HTML formatting tags.␊ - */␊ - description?: string␊ - /**␊ - * API name.␊ - */␊ - displayName?: string␊ - /**␊ - * Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.␊ - */␊ - path: string␊ - /**␊ - * Describes on which protocols the operations in this API can be invoked.␊ - */␊ - protocols?: (("http" | "https")[] | string)␊ - /**␊ - * Absolute URL of the backend service implementing this API.␊ - */␊ - serviceUrl?: string␊ - /**␊ - * Subscription key parameter names details.␊ - */␊ - subscriptionKeyParameterNames?: (SubscriptionKeyParameterNamesContract3 | string)␊ - /**␊ - * Specifies whether an API or Product subscription is required for accessing the API.␊ - */␊ - subscriptionRequired?: (boolean | string)␊ - /**␊ - * Type of API.␊ - */␊ - type?: (("http" | "soap") | string)␊ - /**␊ - * Criteria to limit import of WSDL to a subset of the document.␊ - */␊ - wsdlSelector?: (ApiCreateOrUpdatePropertiesWsdlSelector2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An API Version Set contains the common configuration for a set of API Versions relating ␊ - */␊ - export interface ApiVersionSetContractDetails1 {␊ - /**␊ - * Description of API Version Set.␊ - */␊ - description?: string␊ - /**␊ - * Identifier for existing API Version Set. Omit this value to create a new Version Set.␊ - */␊ - id?: string␊ - /**␊ - * Name of HTTP header parameter that indicates the API Version if versioningScheme is set to \`header\`.␊ - */␊ - versionHeaderName?: string␊ - /**␊ - * An value that determines where the API Version identifier will be located in a HTTP request.␊ - */␊ - versioningScheme?: (("Segment" | "Query" | "Header") | string)␊ - /**␊ - * Name of query parameter that indicates the API Version if versioningScheme is set to \`query\`.␊ - */␊ - versionQueryName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * API Authentication Settings.␊ - */␊ - export interface AuthenticationSettingsContract3 {␊ - /**␊ - * API OAuth2 Authentication settings details.␊ - */␊ - oAuth2?: (OAuth2AuthenticationSettingsContract3 | string)␊ - /**␊ - * API OAuth2 Authentication settings details.␊ - */␊ - openid?: (OpenIdAuthenticationSettingsContract1 | string)␊ - /**␊ - * Specifies whether subscription key is required during call to this API, true - API is included into closed products only, false - API is included into open products alone, null - there is a mix of products.␊ - */␊ - subscriptionKeyRequired?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * API OAuth2 Authentication settings details.␊ - */␊ - export interface OAuth2AuthenticationSettingsContract3 {␊ - /**␊ - * OAuth authorization server identifier.␊ - */␊ - authorizationServerId?: string␊ - /**␊ - * operations scope.␊ - */␊ - scope?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * API OAuth2 Authentication settings details.␊ - */␊ - export interface OpenIdAuthenticationSettingsContract1 {␊ - /**␊ - * How to send token to the server.␊ - */␊ - bearerTokenSendingMethods?: (("authorizationHeader" | "query")[] | string)␊ - /**␊ - * OAuth authorization server identifier.␊ - */␊ - openidProviderId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Subscription key parameter names details.␊ - */␊ - export interface SubscriptionKeyParameterNamesContract3 {␊ - /**␊ - * Subscription key header name.␊ - */␊ - header?: string␊ - /**␊ - * Subscription key query string parameter name.␊ - */␊ - query?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Criteria to limit import of WSDL to a subset of the document.␊ - */␊ - export interface ApiCreateOrUpdatePropertiesWsdlSelector2 {␊ - /**␊ - * Name of endpoint(port) to import from WSDL␊ - */␊ - wsdlEndpointName?: string␊ - /**␊ - * Name of service to import from WSDL␊ - */␊ - wsdlServiceName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/tags␊ - */␊ - export interface ServiceTagsChildResource2 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Tag identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Tag contract Properties.␊ - */␊ - properties: (TagContractProperties2 | string)␊ - type: "tags"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Tag contract Properties.␊ - */␊ - export interface TagContractProperties2 {␊ - /**␊ - * Tag name.␊ - */␊ - displayName: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/authorizationServers␊ - */␊ - export interface ServiceAuthorizationServersChildResource3 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Identifier of the authorization server.␊ - */␊ - name: string␊ - /**␊ - * External OAuth authorization server settings Properties.␊ - */␊ - properties: (AuthorizationServerContractProperties2 | string)␊ - type: "authorizationServers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * External OAuth authorization server settings Properties.␊ - */␊ - export interface AuthorizationServerContractProperties2 {␊ - /**␊ - * OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.␊ - */␊ - authorizationEndpoint: string␊ - /**␊ - * HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.␊ - */␊ - authorizationMethods?: (("HEAD" | "OPTIONS" | "TRACE" | "GET" | "POST" | "PUT" | "PATCH" | "DELETE")[] | string)␊ - /**␊ - * Specifies the mechanism by which access token is passed to the API. ␊ - */␊ - bearerTokenSendingMethods?: (("authorizationHeader" | "query")[] | string)␊ - /**␊ - * Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format.␊ - */␊ - clientAuthenticationMethod?: (("Basic" | "Body")[] | string)␊ - /**␊ - * Client or app id registered with this authorization server.␊ - */␊ - clientId: string␊ - /**␊ - * Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced.␊ - */␊ - clientRegistrationEndpoint: string␊ - /**␊ - * Client or app secret registered with this authorization server.␊ - */␊ - clientSecret?: string␊ - /**␊ - * Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values.␊ - */␊ - defaultScope?: string␊ - /**␊ - * Description of the authorization server. Can contain HTML formatting tags.␊ - */␊ - description?: string␊ - /**␊ - * User-friendly authorization server name.␊ - */␊ - displayName: string␊ - /**␊ - * Form of an authorization grant, which the client uses to request the access token.␊ - */␊ - grantTypes: (("authorizationCode" | "implicit" | "resourceOwnerPassword" | "clientCredentials")[] | string)␊ - /**␊ - * Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.␊ - */␊ - resourceOwnerPassword?: string␊ - /**␊ - * Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.␊ - */␊ - resourceOwnerUsername?: string␊ - /**␊ - * If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security.␊ - */␊ - supportState?: (boolean | string)␊ - /**␊ - * Additional parameters required by the token endpoint of this authorization server represented as an array of JSON objects with name and value string properties, i.e. {"name" : "name value", "value": "a value"}.␊ - */␊ - tokenBodyParameters?: (TokenBodyParameterContract3[] | string)␊ - /**␊ - * OAuth token endpoint. Contains absolute URI to entity being referenced.␊ - */␊ - tokenEndpoint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * OAuth acquire token request body parameter (www-url-form-encoded).␊ - */␊ - export interface TokenBodyParameterContract3 {␊ - /**␊ - * body parameter name.␊ - */␊ - name: string␊ - /**␊ - * body parameter value.␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/backends␊ - */␊ - export interface ServiceBackendsChildResource3 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Identifier of the Backend entity. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Parameters supplied to the Create Backend operation.␊ - */␊ - properties: (BackendContractProperties2 | string)␊ - type: "backends"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters supplied to the Create Backend operation.␊ - */␊ - export interface BackendContractProperties2 {␊ - /**␊ - * Details of the Credentials used to connect to Backend.␊ - */␊ - credentials?: (BackendCredentialsContract2 | string)␊ - /**␊ - * Backend Description.␊ - */␊ - description?: string␊ - /**␊ - * Properties specific to the Backend Type.␊ - */␊ - properties?: (BackendProperties2 | string)␊ - /**␊ - * Backend communication protocol.␊ - */␊ - protocol: (("http" | "soap") | string)␊ - /**␊ - * Details of the Backend WebProxy Server to use in the Request to Backend.␊ - */␊ - proxy?: (BackendProxyContract2 | string)␊ - /**␊ - * Management Uri of the Resource in External System. This url can be the Arm Resource Id of Logic Apps, Function Apps or Api Apps.␊ - */␊ - resourceId?: string␊ - /**␊ - * Backend Title.␊ - */␊ - title?: string␊ - /**␊ - * Properties controlling TLS Certificate Validation.␊ - */␊ - tls?: (BackendTlsProperties2 | string)␊ - /**␊ - * Runtime Url of the Backend.␊ - */␊ - url: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Details of the Credentials used to connect to Backend.␊ - */␊ - export interface BackendCredentialsContract2 {␊ - /**␊ - * Authorization header information.␊ - */␊ - authorization?: (BackendAuthorizationHeaderCredentials2 | string)␊ - /**␊ - * List of Client Certificate Thumbprint.␊ - */␊ - certificate?: (string[] | string)␊ - /**␊ - * Header Parameter description.␊ - */␊ - header?: ({␊ - [k: string]: string[]␊ - } | string)␊ - /**␊ - * Query Parameter description.␊ - */␊ - query?: ({␊ - [k: string]: string[]␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authorization header information.␊ - */␊ - export interface BackendAuthorizationHeaderCredentials2 {␊ - /**␊ - * Authentication Parameter value.␊ - */␊ - parameter: string␊ - /**␊ - * Authentication Scheme name.␊ - */␊ - scheme: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to the Backend Type.␊ - */␊ - export interface BackendProperties2 {␊ - /**␊ - * Properties of the Service Fabric Type Backend.␊ - */␊ - serviceFabricCluster?: (BackendServiceFabricClusterProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Service Fabric Type Backend.␊ - */␊ - export interface BackendServiceFabricClusterProperties2 {␊ - /**␊ - * The client certificate thumbprint for the management endpoint.␊ - */␊ - clientCertificatethumbprint: string␊ - /**␊ - * The cluster management endpoint.␊ - */␊ - managementEndpoints: (string[] | string)␊ - /**␊ - * Maximum number of retries while attempting resolve the partition.␊ - */␊ - maxPartitionResolutionRetries?: (number | string)␊ - /**␊ - * Thumbprints of certificates cluster management service uses for tls communication␊ - */␊ - serverCertificateThumbprints?: (string[] | string)␊ - /**␊ - * Server X509 Certificate Names Collection␊ - */␊ - serverX509Names?: (X509CertificateName2[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of server X509Names.␊ - */␊ - export interface X509CertificateName2 {␊ - /**␊ - * Thumbprint for the Issuer of the Certificate.␊ - */␊ - issuerCertificateThumbprint?: string␊ - /**␊ - * Common Name of the Certificate.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Details of the Backend WebProxy Server to use in the Request to Backend.␊ - */␊ - export interface BackendProxyContract2 {␊ - /**␊ - * Password to connect to the WebProxy Server␊ - */␊ - password?: string␊ - /**␊ - * WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings.␊ - */␊ - url: string␊ - /**␊ - * Username to connect to the WebProxy server␊ - */␊ - username?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties controlling TLS Certificate Validation.␊ - */␊ - export interface BackendTlsProperties2 {␊ - /**␊ - * Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host.␊ - */␊ - validateCertificateChain?: (boolean | string)␊ - /**␊ - * Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host.␊ - */␊ - validateCertificateName?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/caches␊ - */␊ - export interface ServiceCachesChildResource {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Identifier of the Cache entity. Cache identifier (should be either 'default' or valid Azure region identifier).␊ - */␊ - name: string␊ - /**␊ - * Properties of the Cache contract.␊ - */␊ - properties: (CacheContractProperties | string)␊ - type: "caches"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Cache contract.␊ - */␊ - export interface CacheContractProperties {␊ - /**␊ - * Runtime connection string to cache␊ - */␊ - connectionString: string␊ - /**␊ - * Cache description␊ - */␊ - description?: string␊ - /**␊ - * Original uri of entity in external system cache points to␊ - */␊ - resourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/certificates␊ - */␊ - export interface ServiceCertificatesChildResource3 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Identifier of the certificate entity. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Parameters supplied to the CreateOrUpdate certificate operation.␊ - */␊ - properties: (CertificateCreateOrUpdateProperties4 | string)␊ - type: "certificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters supplied to the CreateOrUpdate certificate operation.␊ - */␊ - export interface CertificateCreateOrUpdateProperties4 {␊ - /**␊ - * Base 64 encoded certificate using the application/x-pkcs12 representation.␊ - */␊ - data: string␊ - /**␊ - * Password for the Certificate␊ - */␊ - password: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/diagnostics␊ - */␊ - export interface ServiceDiagnosticsChildResource2 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Diagnostic identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Diagnostic Entity Properties␊ - */␊ - properties: (DiagnosticContractProperties2 | string)␊ - type: "diagnostics"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Diagnostic Entity Properties␊ - */␊ - export interface DiagnosticContractProperties2 {␊ - /**␊ - * Specifies for what type of messages sampling settings should not apply.␊ - */␊ - alwaysLog?: ("allErrors" | string)␊ - /**␊ - * Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.␊ - */␊ - backend?: (PipelineDiagnosticSettings | string)␊ - /**␊ - * Whether to process Correlation Headers coming to Api Management Service. Only applicable to Application Insights diagnostics. Default is true.␊ - */␊ - enableHttpCorrelationHeaders?: (boolean | string)␊ - /**␊ - * Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.␊ - */␊ - frontend?: (PipelineDiagnosticSettings | string)␊ - /**␊ - * Resource Id of a target logger.␊ - */␊ - loggerId: string␊ - /**␊ - * Sampling settings for Diagnostic.␊ - */␊ - sampling?: (SamplingSettings | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.␊ - */␊ - export interface PipelineDiagnosticSettings {␊ - /**␊ - * Http message diagnostic settings.␊ - */␊ - request?: (HttpMessageDiagnostic | string)␊ - /**␊ - * Http message diagnostic settings.␊ - */␊ - response?: (HttpMessageDiagnostic | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http message diagnostic settings.␊ - */␊ - export interface HttpMessageDiagnostic {␊ - /**␊ - * Body logging settings.␊ - */␊ - body?: (BodyDiagnosticSettings | string)␊ - /**␊ - * Array of HTTP Headers to log.␊ - */␊ - headers?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Body logging settings.␊ - */␊ - export interface BodyDiagnosticSettings {␊ - /**␊ - * Number of request body bytes to log.␊ - */␊ - bytes?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Sampling settings for Diagnostic.␊ - */␊ - export interface SamplingSettings {␊ - /**␊ - * Rate of sampling for fixed-rate sampling.␊ - */␊ - percentage?: (number | string)␊ - /**␊ - * Sampling type.␊ - */␊ - samplingType?: ("fixed" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/templates␊ - */␊ - export interface ServiceTemplatesChildResource2 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Email Template Name Identifier.␊ - */␊ - name: (("applicationApprovedNotificationMessage" | "accountClosedDeveloper" | "quotaLimitApproachingDeveloperNotificationMessage" | "newDeveloperNotificationMessage" | "emailChangeIdentityDefault" | "inviteUserNotificationMessage" | "newCommentNotificationMessage" | "confirmSignUpIdentityDefault" | "newIssueNotificationMessage" | "purchaseDeveloperNotificationMessage" | "passwordResetIdentityDefault" | "passwordResetByAdminNotificationMessage" | "rejectDeveloperNotificationMessage" | "requestDeveloperNotificationMessage") | string)␊ - /**␊ - * Email Template Update Contract properties.␊ - */␊ - properties: (EmailTemplateUpdateParameterProperties2 | string)␊ - type: "templates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Email Template Update Contract properties.␊ - */␊ - export interface EmailTemplateUpdateParameterProperties2 {␊ - /**␊ - * Email Template Body. This should be a valid XDocument␊ - */␊ - body?: string␊ - /**␊ - * Description of the Email Template.␊ - */␊ - description?: string␊ - /**␊ - * Email Template Parameter values.␊ - */␊ - parameters?: (EmailTemplateParametersContractProperties2[] | string)␊ - /**␊ - * Subject of the Template.␊ - */␊ - subject?: string␊ - /**␊ - * Title of the Template.␊ - */␊ - title?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Email Template Parameter contract.␊ - */␊ - export interface EmailTemplateParametersContractProperties2 {␊ - /**␊ - * Template parameter description.␊ - */␊ - description?: string␊ - /**␊ - * Template parameter name.␊ - */␊ - name?: string␊ - /**␊ - * Template parameter title.␊ - */␊ - title?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/groups␊ - */␊ - export interface ServiceGroupsChildResource3 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Group identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Parameters supplied to the Create Group operation.␊ - */␊ - properties: (GroupCreateParametersProperties2 | string)␊ - type: "groups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters supplied to the Create Group operation.␊ - */␊ - export interface GroupCreateParametersProperties2 {␊ - /**␊ - * Group description.␊ - */␊ - description?: string␊ - /**␊ - * Group name.␊ - */␊ - displayName: string␊ - /**␊ - * Identifier of the external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory \`aad://.onmicrosoft.com/groups/\`; otherwise the value is null.␊ - */␊ - externalId?: string␊ - /**␊ - * Group type.␊ - */␊ - type?: (("custom" | "system" | "external") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/identityProviders␊ - */␊ - export interface ServiceIdentityProvidersChildResource3 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Identity Provider Type identifier.␊ - */␊ - name: (("facebook" | "google" | "microsoft" | "twitter" | "aad" | "aadB2C") | string)␊ - /**␊ - * The external Identity Providers like Facebook, Google, Microsoft, Twitter or Azure Active Directory which can be used to enable access to the API Management service developer portal for all users.␊ - */␊ - properties: (IdentityProviderContractProperties2 | string)␊ - type: "identityProviders"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The external Identity Providers like Facebook, Google, Microsoft, Twitter or Azure Active Directory which can be used to enable access to the API Management service developer portal for all users.␊ - */␊ - export interface IdentityProviderContractProperties2 {␊ - /**␊ - * List of Allowed Tenants when configuring Azure Active Directory login.␊ - */␊ - allowedTenants?: (string[] | string)␊ - /**␊ - * OpenID Connect discovery endpoint hostname for AAD or AAD B2C.␊ - */␊ - authority?: string␊ - /**␊ - * Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft.␊ - */␊ - clientId: string␊ - /**␊ - * Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft.␊ - */␊ - clientSecret: string␊ - /**␊ - * Password Reset Policy Name. Only applies to AAD B2C Identity Provider.␊ - */␊ - passwordResetPolicyName?: string␊ - /**␊ - * Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.␊ - */␊ - profileEditingPolicyName?: string␊ - /**␊ - * Signin Policy Name. Only applies to AAD B2C Identity Provider.␊ - */␊ - signinPolicyName?: string␊ - /**␊ - * Signup Policy Name. Only applies to AAD B2C Identity Provider.␊ - */␊ - signupPolicyName?: string␊ - /**␊ - * Identity Provider Type identifier.␊ - */␊ - type?: (("facebook" | "google" | "microsoft" | "twitter" | "aad" | "aadB2C") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/loggers␊ - */␊ - export interface ServiceLoggersChildResource3 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Logger identifier. Must be unique in the API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * The Logger entity in API Management represents an event sink that you can use to log API Management events. Currently the Logger entity supports logging API Management events to Azure Event Hubs.␊ - */␊ - properties: (LoggerContractProperties2 | string)␊ - type: "loggers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Logger entity in API Management represents an event sink that you can use to log API Management events. Currently the Logger entity supports logging API Management events to Azure Event Hubs.␊ - */␊ - export interface LoggerContractProperties2 {␊ - /**␊ - * The name and SendRule connection string of the event hub for azureEventHub logger.␊ - * Instrumentation key for applicationInsights logger.␊ - */␊ - credentials: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Logger description.␊ - */␊ - description?: string␊ - /**␊ - * Whether records are buffered in the logger before publishing. Default is assumed to be true.␊ - */␊ - isBuffered?: (boolean | string)␊ - /**␊ - * Logger type.␊ - */␊ - loggerType: (("azureEventHub" | "applicationInsights") | string)␊ - /**␊ - * Azure Resource Id of a log target (either Azure Event Hub resource or Azure Application Insights resource).␊ - */␊ - resourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/notifications␊ - */␊ - export interface ServiceNotificationsChildResource2 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Notification Name Identifier.␊ - */␊ - name: (("RequestPublisherNotificationMessage" | "PurchasePublisherNotificationMessage" | "NewApplicationNotificationMessage" | "BCC" | "NewIssuePublisherNotificationMessage" | "AccountClosedPublisher" | "QuotaLimitApproachingPublisherNotificationMessage") | string)␊ - type: "notifications"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/openidConnectProviders␊ - */␊ - export interface ServiceOpenidConnectProvidersChildResource3 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Identifier of the OpenID Connect Provider.␊ - */␊ - name: string␊ - /**␊ - * OpenID Connect Providers Contract.␊ - */␊ - properties: (OpenidConnectProviderContractProperties2 | string)␊ - type: "openidConnectProviders"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * OpenID Connect Providers Contract.␊ - */␊ - export interface OpenidConnectProviderContractProperties2 {␊ - /**␊ - * Client ID of developer console which is the client application.␊ - */␊ - clientId: string␊ - /**␊ - * Client Secret of developer console which is the client application.␊ - */␊ - clientSecret?: string␊ - /**␊ - * User-friendly description of OpenID Connect Provider.␊ - */␊ - description?: string␊ - /**␊ - * User-friendly OpenID Connect Provider name.␊ - */␊ - displayName: string␊ - /**␊ - * Metadata endpoint URI.␊ - */␊ - metadataEndpoint: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/policies␊ - */␊ - export interface ServicePoliciesChildResource2 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * The identifier of the Policy.␊ - */␊ - name: "policy"␊ - /**␊ - * Policy contract Properties.␊ - */␊ - properties: (PolicyContractProperties2 | string)␊ - type: "policies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Policy contract Properties.␊ - */␊ - export interface PolicyContractProperties2 {␊ - /**␊ - * Format of the policyContent.␊ - */␊ - contentFormat?: (("xml" | "xml-link" | "rawxml" | "rawxml-link") | string)␊ - /**␊ - * Json escaped Xml Encoded contents of the Policy.␊ - */␊ - policyContent: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Sign-in settings contract properties.␊ - */␊ - export interface PortalSigninSettingProperties2 {␊ - /**␊ - * Redirect Anonymous users to the Sign-In page.␊ - */␊ - enabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Sign-up settings contract properties.␊ - */␊ - export interface PortalSignupSettingsProperties2 {␊ - /**␊ - * Allow users to sign up on a developer portal.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Terms of service contract properties.␊ - */␊ - termsOfService?: (TermsOfServiceProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Terms of service contract properties.␊ - */␊ - export interface TermsOfServiceProperties2 {␊ - /**␊ - * Ask user for consent to the terms of service.␊ - */␊ - consentRequired?: (boolean | string)␊ - /**␊ - * Display terms of service during a sign-up process.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * A terms of service text.␊ - */␊ - text?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Delegation settings contract properties.␊ - */␊ - export interface PortalDelegationSettingsProperties2 {␊ - /**␊ - * Subscriptions delegation settings properties.␊ - */␊ - subscriptions?: (SubscriptionsDelegationSettingsProperties2 | string)␊ - /**␊ - * A delegation Url.␊ - */␊ - url?: string␊ - /**␊ - * User registration delegation settings properties.␊ - */␊ - userRegistration?: (RegistrationDelegationSettingsProperties2 | string)␊ - /**␊ - * A base64-encoded validation key to validate, that a request is coming from Azure API Management.␊ - */␊ - validationKey?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Subscriptions delegation settings properties.␊ - */␊ - export interface SubscriptionsDelegationSettingsProperties2 {␊ - /**␊ - * Enable or disable delegation for subscriptions.␊ - */␊ - enabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * User registration delegation settings properties.␊ - */␊ - export interface RegistrationDelegationSettingsProperties2 {␊ - /**␊ - * Enable or disable delegation for user registration.␊ - */␊ - enabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/products␊ - */␊ - export interface ServiceProductsChildResource3 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Product identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Product profile.␊ - */␊ - properties: (ProductContractProperties2 | string)␊ - type: "products"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Product profile.␊ - */␊ - export interface ProductContractProperties2 {␊ - /**␊ - * whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of true.␊ - */␊ - approvalRequired?: (boolean | string)␊ - /**␊ - * Product description. May include HTML formatting tags.␊ - */␊ - description?: string␊ - /**␊ - * Product name.␊ - */␊ - displayName: string␊ - /**␊ - * whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished.␊ - */␊ - state?: (("notPublished" | "published") | string)␊ - /**␊ - * Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true.␊ - */␊ - subscriptionRequired?: (boolean | string)␊ - /**␊ - * Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of true.␊ - */␊ - subscriptionsLimit?: (number | string)␊ - /**␊ - * Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process.␊ - */␊ - terms?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/properties␊ - */␊ - export interface ServicePropertiesChildResource3 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Identifier of the property.␊ - */␊ - name: string␊ - /**␊ - * Property Contract properties.␊ - */␊ - properties: (PropertyContractProperties2 | string)␊ - type: "properties"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Property Contract properties.␊ - */␊ - export interface PropertyContractProperties2 {␊ - /**␊ - * Unique name of Property. It may contain only letters, digits, period, dash, and underscore characters.␊ - */␊ - displayName: string␊ - /**␊ - * Determines whether the value is a secret and should be encrypted or not. Default value is false.␊ - */␊ - secret?: (boolean | string)␊ - /**␊ - * Optional tags that when provided can be used to filter the property list.␊ - */␊ - tags?: (string[] | string)␊ - /**␊ - * Value of the property. Can contain policy expressions. It may not be empty or consist only of whitespace.␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/subscriptions␊ - */␊ - export interface ServiceSubscriptionsChildResource3 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Subscription entity Identifier. The entity represents the association between a user and a product in API Management.␊ - */␊ - name: string␊ - /**␊ - * Parameters supplied to the Create subscription operation.␊ - */␊ - properties: (SubscriptionCreateParameterProperties2 | string)␊ - type: "subscriptions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters supplied to the Create subscription operation.␊ - */␊ - export interface SubscriptionCreateParameterProperties2 {␊ - /**␊ - * Determines whether tracing can be enabled␊ - */␊ - allowTracing?: (boolean | string)␊ - /**␊ - * Subscription name.␊ - */␊ - displayName: string␊ - /**␊ - * User (user id path) for whom subscription is being created in form /users/{userId}␊ - */␊ - ownerId?: string␊ - /**␊ - * Primary subscription key. If not specified during request key will be generated automatically.␊ - */␊ - primaryKey?: string␊ - /**␊ - * Scope like /products/{productId} or /apis or /apis/{apiId}.␊ - */␊ - scope: string␊ - /**␊ - * Secondary subscription key. If not specified during request key will be generated automatically.␊ - */␊ - secondaryKey?: string␊ - /**␊ - * Initial subscription state. If no value is specified, subscription is created with Submitted state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated.␊ - */␊ - state?: (("suspended" | "active" | "expired" | "submitted" | "rejected" | "cancelled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/users␊ - */␊ - export interface ServiceUsersChildResource3 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * User identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Parameters supplied to the Create User operation.␊ - */␊ - properties: (UserCreateParameterProperties2 | string)␊ - type: "users"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters supplied to the Create User operation.␊ - */␊ - export interface UserCreateParameterProperties2 {␊ - /**␊ - * Determines the type of confirmation e-mail that will be sent to the newly created user.␊ - */␊ - confirmation?: (("signup" | "invite") | string)␊ - /**␊ - * Email address. Must not be empty and must be unique within the service instance.␊ - */␊ - email: string␊ - /**␊ - * First name.␊ - */␊ - firstName: string␊ - /**␊ - * Collection of user identities.␊ - */␊ - identities?: (UserIdentityContract1[] | string)␊ - /**␊ - * Last name.␊ - */␊ - lastName: string␊ - /**␊ - * Optional note about a user set by the administrator.␊ - */␊ - note?: string␊ - /**␊ - * User Password. If no value is provided, a default password is generated.␊ - */␊ - password?: string␊ - /**␊ - * Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active.␊ - */␊ - state?: (("active" | "blocked" | "pending" | "deleted") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * User identity details.␊ - */␊ - export interface UserIdentityContract1 {␊ - /**␊ - * Identifier value within provider.␊ - */␊ - id?: string␊ - /**␊ - * Identity provider name.␊ - */␊ - provider?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/api-version-sets␊ - */␊ - export interface ServiceApiVersionSetsChildResource2 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Api Version Set identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Properties of an API Version Set.␊ - */␊ - properties: (ApiVersionSetContractProperties2 | string)␊ - type: "api-version-sets"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of an API Version Set.␊ - */␊ - export interface ApiVersionSetContractProperties2 {␊ - /**␊ - * Description of API Version Set.␊ - */␊ - description?: string␊ - /**␊ - * Name of API Version Set␊ - */␊ - displayName: string␊ - /**␊ - * Name of HTTP header parameter that indicates the API Version if versioningScheme is set to \`header\`.␊ - */␊ - versionHeaderName?: string␊ - /**␊ - * An value that determines where the API Version identifier will be located in a HTTP request.␊ - */␊ - versioningScheme: (("Segment" | "Query" | "Header") | string)␊ - /**␊ - * Name of query parameter that indicates the API Version if versioningScheme is set to \`query\`.␊ - */␊ - versionQueryName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis␊ - */␊ - export interface ServiceApis3 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.␊ - */␊ - name: string␊ - /**␊ - * Api Create or Update Properties.␊ - */␊ - properties: (ApiCreateOrUpdateProperties2 | string)␊ - resources?: (ServiceApisReleasesChildResource2 | ServiceApisOperationsChildResource3 | ServiceApisTagsChildResource2 | ServiceApisPoliciesChildResource2 | ServiceApisSchemasChildResource2 | ServiceApisDiagnosticsChildResource2 | ServiceApisIssuesChildResource2 | ServiceApisTagDescriptionsChildResource2)[]␊ - type: "Microsoft.ApiManagement/service/apis"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/releases␊ - */␊ - export interface ServiceApisReleasesChildResource2 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Release identifier within an API. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * API Release details␊ - */␊ - properties: (ApiReleaseContractProperties2 | string)␊ - type: "releases"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * API Release details␊ - */␊ - export interface ApiReleaseContractProperties2 {␊ - /**␊ - * Identifier of the API the release belongs to.␊ - */␊ - apiId?: string␊ - /**␊ - * Release Notes␊ - */␊ - notes?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/operations␊ - */␊ - export interface ServiceApisOperationsChildResource3 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Operation identifier within an API. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Operation Contract Properties␊ - */␊ - properties: (OperationContractProperties2 | string)␊ - type: "operations"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Operation Contract Properties␊ - */␊ - export interface OperationContractProperties2 {␊ - /**␊ - * Description of the operation. May include HTML formatting tags.␊ - */␊ - description?: string␊ - /**␊ - * Operation Name.␊ - */␊ - displayName: string␊ - /**␊ - * A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.␊ - */␊ - method: string␊ - /**␊ - * Operation Policies␊ - */␊ - policies?: string␊ - /**␊ - * Operation request details.␊ - */␊ - request?: (RequestContract3 | string)␊ - /**␊ - * Array of Operation responses.␊ - */␊ - responses?: (ResponseContract2[] | string)␊ - /**␊ - * Collection of URL template parameters.␊ - */␊ - templateParameters?: (ParameterContract3[] | string)␊ - /**␊ - * Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}␊ - */␊ - urlTemplate: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Operation request details.␊ - */␊ - export interface RequestContract3 {␊ - /**␊ - * Operation request description.␊ - */␊ - description?: string␊ - /**␊ - * Collection of operation request headers.␊ - */␊ - headers?: (ParameterContract3[] | string)␊ - /**␊ - * Collection of operation request query parameters.␊ - */␊ - queryParameters?: (ParameterContract3[] | string)␊ - /**␊ - * Collection of operation request representations.␊ - */␊ - representations?: (RepresentationContract3[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Operation parameters details.␊ - */␊ - export interface ParameterContract3 {␊ - /**␊ - * Default parameter value.␊ - */␊ - defaultValue?: string␊ - /**␊ - * Parameter description.␊ - */␊ - description?: string␊ - /**␊ - * Parameter name.␊ - */␊ - name: string␊ - /**␊ - * whether parameter is required or not.␊ - */␊ - required?: (boolean | string)␊ - /**␊ - * Parameter type.␊ - */␊ - type: string␊ - /**␊ - * Parameter values.␊ - */␊ - values?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Operation request/response representation details.␊ - */␊ - export interface RepresentationContract3 {␊ - /**␊ - * Specifies a registered or custom content type for this representation, e.g. application/xml.␊ - */␊ - contentType: string␊ - /**␊ - * Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..␊ - */␊ - formParameters?: (ParameterContract3[] | string)␊ - /**␊ - * An example of the representation.␊ - */␊ - sample?: string␊ - /**␊ - * Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.␊ - */␊ - schemaId?: string␊ - /**␊ - * Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.␊ - */␊ - typeName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Operation response details.␊ - */␊ - export interface ResponseContract2 {␊ - /**␊ - * Operation response description.␊ - */␊ - description?: string␊ - /**␊ - * Collection of operation response headers.␊ - */␊ - headers?: (ParameterContract3[] | string)␊ - /**␊ - * Collection of operation response representations.␊ - */␊ - representations?: (RepresentationContract3[] | string)␊ - /**␊ - * Operation response HTTP status code.␊ - */␊ - statusCode: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/tags␊ - */␊ - export interface ServiceApisTagsChildResource2 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Tag identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "tags"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/policies␊ - */␊ - export interface ServiceApisPoliciesChildResource2 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * The identifier of the Policy.␊ - */␊ - name: "policy"␊ - /**␊ - * Policy contract Properties.␊ - */␊ - properties: (PolicyContractProperties2 | string)␊ - type: "policies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/schemas␊ - */␊ - export interface ServiceApisSchemasChildResource2 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Schema identifier within an API. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Schema contract Properties.␊ - */␊ - properties: (SchemaContractProperties2 | string)␊ - type: "schemas"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Schema contract Properties.␊ - */␊ - export interface SchemaContractProperties2 {␊ - /**␊ - * Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml).␊ - */␊ - contentType: string␊ - /**␊ - * Schema Document Properties.␊ - */␊ - document?: (SchemaDocumentProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Schema Document Properties.␊ - */␊ - export interface SchemaDocumentProperties2 {␊ - /**␊ - * Json escaped string defining the document representing the Schema.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/diagnostics␊ - */␊ - export interface ServiceApisDiagnosticsChildResource2 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Diagnostic identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Diagnostic Entity Properties␊ - */␊ - properties: (DiagnosticContractProperties2 | string)␊ - type: "diagnostics"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/issues␊ - */␊ - export interface ServiceApisIssuesChildResource2 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Issue identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Issue contract Properties.␊ - */␊ - properties: (IssueContractProperties2 | string)␊ - type: "issues"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Issue contract Properties.␊ - */␊ - export interface IssueContractProperties2 {␊ - /**␊ - * A resource identifier for the API the issue was created for.␊ - */␊ - apiId?: string␊ - /**␊ - * Date and time when the issue was created.␊ - */␊ - createdDate?: string␊ - /**␊ - * Text describing the issue.␊ - */␊ - description: string␊ - /**␊ - * Status of the issue.␊ - */␊ - state?: (("proposed" | "open" | "removed" | "resolved" | "closed") | string)␊ - /**␊ - * The issue title.␊ - */␊ - title: string␊ - /**␊ - * A resource identifier for the user created the issue.␊ - */␊ - userId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/tagDescriptions␊ - */␊ - export interface ServiceApisTagDescriptionsChildResource2 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Tag identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Parameters supplied to the Create TagDescription operation.␊ - */␊ - properties: (TagDescriptionBaseProperties2 | string)␊ - type: "tagDescriptions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters supplied to the Create TagDescription operation.␊ - */␊ - export interface TagDescriptionBaseProperties2 {␊ - /**␊ - * Description of the Tag.␊ - */␊ - description?: string␊ - /**␊ - * Description of the external resources describing the tag.␊ - */␊ - externalDocsDescription?: string␊ - /**␊ - * Absolute URL of external resources describing the tag.␊ - */␊ - externalDocsUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/diagnostics␊ - */␊ - export interface ServiceApisDiagnostics2 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Diagnostic identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Diagnostic Entity Properties␊ - */␊ - properties: (DiagnosticContractProperties2 | string)␊ - type: "Microsoft.ApiManagement/service/apis/diagnostics"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/operations␊ - */␊ - export interface ServiceApisOperations3 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Operation identifier within an API. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Operation Contract Properties␊ - */␊ - properties: (OperationContractProperties2 | string)␊ - resources?: (ServiceApisOperationsPoliciesChildResource2 | ServiceApisOperationsTagsChildResource2)[]␊ - type: "Microsoft.ApiManagement/service/apis/operations"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/operations/policies␊ - */␊ - export interface ServiceApisOperationsPoliciesChildResource2 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * The identifier of the Policy.␊ - */␊ - name: "policy"␊ - /**␊ - * Policy contract Properties.␊ - */␊ - properties: (PolicyContractProperties2 | string)␊ - type: "policies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/operations/tags␊ - */␊ - export interface ServiceApisOperationsTagsChildResource2 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Tag identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "tags"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/operations/policies␊ - */␊ - export interface ServiceApisOperationsPolicies2 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * The identifier of the Policy.␊ - */␊ - name: string␊ - /**␊ - * Policy contract Properties.␊ - */␊ - properties: (PolicyContractProperties2 | string)␊ - type: "Microsoft.ApiManagement/service/apis/operations/policies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/operations/tags␊ - */␊ - export interface ServiceApisOperationsTags2 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Tag identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "Microsoft.ApiManagement/service/apis/operations/tags"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/policies␊ - */␊ - export interface ServiceApisPolicies2 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * The identifier of the Policy.␊ - */␊ - name: string␊ - /**␊ - * Policy contract Properties.␊ - */␊ - properties: (PolicyContractProperties2 | string)␊ - type: "Microsoft.ApiManagement/service/apis/policies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/releases␊ - */␊ - export interface ServiceApisReleases2 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Release identifier within an API. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * API Release details␊ - */␊ - properties: (ApiReleaseContractProperties2 | string)␊ - type: "Microsoft.ApiManagement/service/apis/releases"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/schemas␊ - */␊ - export interface ServiceApisSchemas2 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Schema identifier within an API. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Schema contract Properties.␊ - */␊ - properties: (SchemaContractProperties2 | string)␊ - type: "Microsoft.ApiManagement/service/apis/schemas"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/tagDescriptions␊ - */␊ - export interface ServiceApisTagDescriptions2 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Tag identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Parameters supplied to the Create TagDescription operation.␊ - */␊ - properties: (TagDescriptionBaseProperties2 | string)␊ - type: "Microsoft.ApiManagement/service/apis/tagDescriptions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/tags␊ - */␊ - export interface ServiceApisTags2 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Tag identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "Microsoft.ApiManagement/service/apis/tags"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/api-version-sets␊ - */␊ - export interface ServiceApiVersionSets2 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Api Version Set identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Properties of an API Version Set.␊ - */␊ - properties: (ApiVersionSetContractProperties2 | string)␊ - type: "Microsoft.ApiManagement/service/api-version-sets"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/authorizationServers␊ - */␊ - export interface ServiceAuthorizationServers3 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Identifier of the authorization server.␊ - */␊ - name: string␊ - /**␊ - * External OAuth authorization server settings Properties.␊ - */␊ - properties: (AuthorizationServerContractProperties2 | string)␊ - type: "Microsoft.ApiManagement/service/authorizationServers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/backends␊ - */␊ - export interface ServiceBackends3 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Identifier of the Backend entity. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Parameters supplied to the Create Backend operation.␊ - */␊ - properties: (BackendContractProperties2 | string)␊ - type: "Microsoft.ApiManagement/service/backends"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/certificates␊ - */␊ - export interface ServiceCertificates3 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Identifier of the certificate entity. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Parameters supplied to the CreateOrUpdate certificate operation.␊ - */␊ - properties: (CertificateCreateOrUpdateProperties4 | string)␊ - type: "Microsoft.ApiManagement/service/certificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/diagnostics␊ - */␊ - export interface ServiceDiagnostics2 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Diagnostic identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Diagnostic Entity Properties␊ - */␊ - properties: (DiagnosticContractProperties2 | string)␊ - type: "Microsoft.ApiManagement/service/diagnostics"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/groups␊ - */␊ - export interface ServiceGroups3 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Group identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Parameters supplied to the Create Group operation.␊ - */␊ - properties: (GroupCreateParametersProperties2 | string)␊ - resources?: ServiceGroupsUsersChildResource3[]␊ - type: "Microsoft.ApiManagement/service/groups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/groups/users␊ - */␊ - export interface ServiceGroupsUsersChildResource3 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * User identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "users"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/groups/users␊ - */␊ - export interface ServiceGroupsUsers3 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * User identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "Microsoft.ApiManagement/service/groups/users"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/identityProviders␊ - */␊ - export interface ServiceIdentityProviders3 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Identity Provider Type identifier.␊ - */␊ - name: (("facebook" | "google" | "microsoft" | "twitter" | "aad" | "aadB2C") | string)␊ - /**␊ - * The external Identity Providers like Facebook, Google, Microsoft, Twitter or Azure Active Directory which can be used to enable access to the API Management service developer portal for all users.␊ - */␊ - properties: (IdentityProviderContractProperties2 | string)␊ - type: "Microsoft.ApiManagement/service/identityProviders"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/loggers␊ - */␊ - export interface ServiceLoggers3 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Logger identifier. Must be unique in the API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * The Logger entity in API Management represents an event sink that you can use to log API Management events. Currently the Logger entity supports logging API Management events to Azure Event Hubs.␊ - */␊ - properties: (LoggerContractProperties2 | string)␊ - type: "Microsoft.ApiManagement/service/loggers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/notifications␊ - */␊ - export interface ServiceNotifications2 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Notification Name Identifier.␊ - */␊ - name: (("RequestPublisherNotificationMessage" | "PurchasePublisherNotificationMessage" | "NewApplicationNotificationMessage" | "BCC" | "NewIssuePublisherNotificationMessage" | "AccountClosedPublisher" | "QuotaLimitApproachingPublisherNotificationMessage") | string)␊ - resources?: (ServiceNotificationsRecipientUsersChildResource2 | ServiceNotificationsRecipientEmailsChildResource2)[]␊ - type: "Microsoft.ApiManagement/service/notifications"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/notifications/recipientUsers␊ - */␊ - export interface ServiceNotificationsRecipientUsersChildResource2 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * User identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "recipientUsers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/notifications/recipientEmails␊ - */␊ - export interface ServiceNotificationsRecipientEmailsChildResource2 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Email identifier.␊ - */␊ - name: string␊ - type: "recipientEmails"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/notifications/recipientEmails␊ - */␊ - export interface ServiceNotificationsRecipientEmails2 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Email identifier.␊ - */␊ - name: string␊ - type: "Microsoft.ApiManagement/service/notifications/recipientEmails"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/notifications/recipientUsers␊ - */␊ - export interface ServiceNotificationsRecipientUsers2 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * User identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "Microsoft.ApiManagement/service/notifications/recipientUsers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/openidConnectProviders␊ - */␊ - export interface ServiceOpenidConnectProviders3 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Identifier of the OpenID Connect Provider.␊ - */␊ - name: string␊ - /**␊ - * OpenID Connect Providers Contract.␊ - */␊ - properties: (OpenidConnectProviderContractProperties2 | string)␊ - type: "Microsoft.ApiManagement/service/openidConnectProviders"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/policies␊ - */␊ - export interface ServicePolicies2 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * The identifier of the Policy.␊ - */␊ - name: string␊ - /**␊ - * Policy contract Properties.␊ - */␊ - properties: (PolicyContractProperties2 | string)␊ - type: "Microsoft.ApiManagement/service/policies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/products␊ - */␊ - export interface ServiceProducts3 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Product identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Product profile.␊ - */␊ - properties: (ProductContractProperties2 | string)␊ - resources?: (ServiceProductsTagsChildResource2 | ServiceProductsApisChildResource3 | ServiceProductsGroupsChildResource3 | ServiceProductsPoliciesChildResource2)[]␊ - type: "Microsoft.ApiManagement/service/products"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/products/tags␊ - */␊ - export interface ServiceProductsTagsChildResource2 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Tag identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "tags"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/products/apis␊ - */␊ - export interface ServiceProductsApisChildResource3 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.␊ - */␊ - name: string␊ - type: "apis"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/products/groups␊ - */␊ - export interface ServiceProductsGroupsChildResource3 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Group identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "groups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/products/policies␊ - */␊ - export interface ServiceProductsPoliciesChildResource2 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * The identifier of the Policy.␊ - */␊ - name: "policy"␊ - /**␊ - * Policy contract Properties.␊ - */␊ - properties: (PolicyContractProperties2 | string)␊ - type: "policies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/products/apis␊ - */␊ - export interface ServiceProductsApis3 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.␊ - */␊ - name: string␊ - type: "Microsoft.ApiManagement/service/products/apis"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/products/groups␊ - */␊ - export interface ServiceProductsGroups3 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Group identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "Microsoft.ApiManagement/service/products/groups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/products/policies␊ - */␊ - export interface ServiceProductsPolicies2 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * The identifier of the Policy.␊ - */␊ - name: string␊ - /**␊ - * Policy contract Properties.␊ - */␊ - properties: (PolicyContractProperties2 | string)␊ - type: "Microsoft.ApiManagement/service/products/policies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/products/tags␊ - */␊ - export interface ServiceProductsTags2 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Tag identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "Microsoft.ApiManagement/service/products/tags"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/properties␊ - */␊ - export interface ServiceProperties3 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Identifier of the property.␊ - */␊ - name: string␊ - /**␊ - * Property Contract properties.␊ - */␊ - properties: (PropertyContractProperties2 | string)␊ - type: "Microsoft.ApiManagement/service/properties"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/subscriptions␊ - */␊ - export interface ServiceSubscriptions3 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Subscription entity Identifier. The entity represents the association between a user and a product in API Management.␊ - */␊ - name: string␊ - /**␊ - * Parameters supplied to the Create subscription operation.␊ - */␊ - properties: (SubscriptionCreateParameterProperties2 | string)␊ - type: "Microsoft.ApiManagement/service/subscriptions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/tags␊ - */␊ - export interface ServiceTags2 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Tag identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Tag contract Properties.␊ - */␊ - properties: (TagContractProperties2 | string)␊ - type: "Microsoft.ApiManagement/service/tags"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/templates␊ - */␊ - export interface ServiceTemplates2 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Email Template Name Identifier.␊ - */␊ - name: (("applicationApprovedNotificationMessage" | "accountClosedDeveloper" | "quotaLimitApproachingDeveloperNotificationMessage" | "newDeveloperNotificationMessage" | "emailChangeIdentityDefault" | "inviteUserNotificationMessage" | "newCommentNotificationMessage" | "confirmSignUpIdentityDefault" | "newIssueNotificationMessage" | "purchaseDeveloperNotificationMessage" | "passwordResetIdentityDefault" | "passwordResetByAdminNotificationMessage" | "rejectDeveloperNotificationMessage" | "requestDeveloperNotificationMessage") | string)␊ - /**␊ - * Email Template Update Contract properties.␊ - */␊ - properties: (EmailTemplateUpdateParameterProperties2 | string)␊ - type: "Microsoft.ApiManagement/service/templates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/users␊ - */␊ - export interface ServiceUsers3 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * User identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Parameters supplied to the Create User operation.␊ - */␊ - properties: (UserCreateParameterProperties2 | string)␊ - type: "Microsoft.ApiManagement/service/users"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service␊ - */␊ - export interface Service4 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Identity properties of the Api Management service resource.␊ - */␊ - identity?: (ApiManagementServiceIdentity3 | string)␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the API Management service.␊ - */␊ - name: string␊ - /**␊ - * Properties of an API Management service resource description.␊ - */␊ - properties: (ApiManagementServiceProperties4 | string)␊ - resources?: (ServiceApisChildResource4 | ServiceTagsChildResource3 | ServiceApiVersionSetsChildResource3 | ServiceAuthorizationServersChildResource4 | ServiceBackendsChildResource4 | ServiceCachesChildResource1 | ServiceCertificatesChildResource4 | ServiceDiagnosticsChildResource3 | ServiceTemplatesChildResource3 | ServiceGroupsChildResource4 | ServiceIdentityProvidersChildResource4 | ServiceLoggersChildResource4 | ServiceNotificationsChildResource3 | ServiceOpenidConnectProvidersChildResource4 | ServicePoliciesChildResource3 | ServicePortalsettingsChildResource3 | ServiceProductsChildResource4 | ServicePropertiesChildResource4 | ServiceSubscriptionsChildResource4 | ServiceUsersChildResource4)[]␊ - /**␊ - * API Management service resource SKU properties.␊ - */␊ - sku: (ApiManagementServiceSkuProperties4 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.ApiManagement/service"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity properties of the Api Management service resource.␊ - */␊ - export interface ApiManagementServiceIdentity3 {␊ - /**␊ - * The identity type. Currently the only supported type is 'SystemAssigned'.␊ - */␊ - type: ("SystemAssigned" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of an API Management service resource description.␊ - */␊ - export interface ApiManagementServiceProperties4 {␊ - /**␊ - * Additional datacenter locations of the API Management service.␊ - */␊ - additionalLocations?: (AdditionalLocation3[] | string)␊ - /**␊ - * List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.␊ - */␊ - certificates?: (CertificateConfiguration3[] | string)␊ - /**␊ - * Custom properties of the API Management service.
Setting \`Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168\` will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2).
Setting \`Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11\` can be used to disable just TLS 1.1.
Setting \`Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10\` can be used to disable TLS 1.0 on an API Management service.
Setting \`Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11\` can be used to disable just TLS 1.1 for communications with backends.
Setting \`Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10\` can be used to disable TLS 1.0 for communications with backends.
Setting \`Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2\` can be used to enable HTTP2 protocol on an API Management service.
Not specifying any of these properties on PATCH operation will reset omitted properties' values to their defaults. For all the settings except Http2 the default value is \`True\` if the service was created on or before April 1st 2018 and \`False\` otherwise. Http2 setting's default value is \`False\`.

You can disable any of next ciphers by using settings \`Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]\`:
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
TLS_RSA_WITH_AES_128_GCM_SHA256
TLS_RSA_WITH_AES_256_CBC_SHA256
TLS_RSA_WITH_AES_128_CBC_SHA256
TLS_RSA_WITH_AES_256_CBC_SHA
TLS_RSA_WITH_AES_128_CBC_SHA.
For example: \`Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256\`:\`false\`. The default value is \`true\` for all of them.␊ - */␊ - customProperties?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Property only meant to be used for Consumption SKU Service. This enforces a client certificate to be presented on each request to the gateway. This also enables the ability to authenticate the certificate in the policy on the gateway.␊ - */␊ - enableClientCertificate?: (boolean | string)␊ - /**␊ - * Custom hostname configuration of the API Management service.␊ - */␊ - hostnameConfigurations?: (HostnameConfiguration4[] | string)␊ - /**␊ - * Email address from which the notification will be sent.␊ - */␊ - notificationSenderEmail?: string␊ - /**␊ - * Publisher email.␊ - */␊ - publisherEmail: string␊ - /**␊ - * Publisher name.␊ - */␊ - publisherName: string␊ - /**␊ - * Configuration of a virtual network to which API Management service is deployed.␊ - */␊ - virtualNetworkConfiguration?: (VirtualNetworkConfiguration10 | string)␊ - /**␊ - * The type of VPN in which API Management service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only.␊ - */␊ - virtualNetworkType?: (("None" | "External" | "Internal") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of an additional API Management resource location.␊ - */␊ - export interface AdditionalLocation3 {␊ - /**␊ - * The location name of the additional region among Azure Data center regions.␊ - */␊ - location: string␊ - /**␊ - * API Management service resource SKU properties.␊ - */␊ - sku: (ApiManagementServiceSkuProperties4 | string)␊ - /**␊ - * Configuration of a virtual network to which API Management service is deployed.␊ - */␊ - virtualNetworkConfiguration?: (VirtualNetworkConfiguration10 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * API Management service resource SKU properties.␊ - */␊ - export interface ApiManagementServiceSkuProperties4 {␊ - /**␊ - * Capacity of the SKU (number of deployed units of the SKU).␊ - */␊ - capacity?: (number | string)␊ - /**␊ - * Name of the Sku.␊ - */␊ - name: (("Developer" | "Standard" | "Premium" | "Basic" | "Consumption") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Configuration of a virtual network to which API Management service is deployed.␊ - */␊ - export interface VirtualNetworkConfiguration10 {␊ - /**␊ - * The full resource ID of a subnet in a virtual network to deploy the API Management service in.␊ - */␊ - subnetResourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Certificate configuration which consist of non-trusted intermediates and root certificates.␊ - */␊ - export interface CertificateConfiguration3 {␊ - /**␊ - * SSL certificate information.␊ - */␊ - certificate?: (CertificateInformation3 | string)␊ - /**␊ - * Certificate Password.␊ - */␊ - certificatePassword?: string␊ - /**␊ - * Base64 Encoded certificate.␊ - */␊ - encodedCertificate?: string␊ - /**␊ - * The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations.␊ - */␊ - storeName: (("CertificateAuthority" | "Root") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSL certificate information.␊ - */␊ - export interface CertificateInformation3 {␊ - /**␊ - * Expiration date of the certificate. The date conforms to the following format: \`yyyy-MM-ddTHH:mm:ssZ\` as specified by the ISO 8601 standard.␊ - */␊ - expiry: string␊ - /**␊ - * Subject of the certificate.␊ - */␊ - subject: string␊ - /**␊ - * Thumbprint of the certificate.␊ - */␊ - thumbprint: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Custom hostname configuration.␊ - */␊ - export interface HostnameConfiguration4 {␊ - /**␊ - * SSL certificate information.␊ - */␊ - certificate?: (CertificateInformation3 | string)␊ - /**␊ - * Certificate Password.␊ - */␊ - certificatePassword?: string␊ - /**␊ - * Specify true to setup the certificate associated with this Hostname as the Default SSL Certificate. If a client does not send the SNI header, then this will be the certificate that will be challenged. The property is useful if a service has multiple custom hostname enabled and it needs to decide on the default ssl certificate. The setting only applied to Proxy Hostname Type.␊ - */␊ - defaultSslBinding?: (boolean | string)␊ - /**␊ - * Base64 Encoded certificate.␊ - */␊ - encodedCertificate?: string␊ - /**␊ - * Hostname to configure on the Api Management service.␊ - */␊ - hostName: string␊ - /**␊ - * Url to the KeyVault Secret containing the Ssl Certificate. If absolute Url containing version is provided, auto-update of ssl certificate will not work. This requires Api Management service to be configured with MSI. The secret should be of type *application/x-pkcs12*␊ - */␊ - keyVaultId?: string␊ - /**␊ - * Specify true to always negotiate client certificate on the hostname. Default Value is false.␊ - */␊ - negotiateClientCertificate?: (boolean | string)␊ - /**␊ - * Hostname type.␊ - */␊ - type: (("Proxy" | "Portal" | "Management" | "Scm" | "DeveloperPortal") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis␊ - */␊ - export interface ServiceApisChildResource4 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.␊ - */␊ - name: string␊ - /**␊ - * Api Create or Update Properties.␊ - */␊ - properties: (ApiCreateOrUpdateProperties3 | string)␊ - type: "apis"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Api Create or Update Properties.␊ - */␊ - export interface ApiCreateOrUpdateProperties3 {␊ - /**␊ - * Describes the Revision of the Api. If no value is provided, default revision 1 is created␊ - */␊ - apiRevision?: string␊ - /**␊ - * Description of the Api Revision.␊ - */␊ - apiRevisionDescription?: string␊ - /**␊ - * Type of Api to create. ␊ - * * \`http\` creates a SOAP to REST API ␊ - * * \`soap\` creates a SOAP pass-through API.␊ - */␊ - apiType?: (("http" | "soap") | string)␊ - /**␊ - * Indicates the Version identifier of the API if the API is versioned␊ - */␊ - apiVersion?: string␊ - /**␊ - * Description of the Api Version.␊ - */␊ - apiVersionDescription?: string␊ - /**␊ - * An API Version Set contains the common configuration for a set of API Versions relating ␊ - */␊ - apiVersionSet?: (ApiVersionSetContractDetails2 | string)␊ - /**␊ - * A resource identifier for the related ApiVersionSet.␊ - */␊ - apiVersionSetId?: string␊ - /**␊ - * API Authentication Settings.␊ - */␊ - authenticationSettings?: (AuthenticationSettingsContract4 | string)␊ - /**␊ - * Description of the API. May include HTML formatting tags.␊ - */␊ - description?: string␊ - /**␊ - * API name. Must be 1 to 300 characters long.␊ - */␊ - displayName?: string␊ - /**␊ - * Format of the Content in which the API is getting imported.␊ - */␊ - format?: (("wadl-xml" | "wadl-link-json" | "swagger-json" | "swagger-link-json" | "wsdl" | "wsdl-link" | "openapi" | "openapi+json" | "openapi-link" | "openapi+json-link") | string)␊ - /**␊ - * Indicates if API revision is current api revision.␊ - */␊ - isCurrent?: (boolean | string)␊ - /**␊ - * Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.␊ - */␊ - path: string␊ - /**␊ - * Describes on which protocols the operations in this API can be invoked.␊ - */␊ - protocols?: (("http" | "https")[] | string)␊ - /**␊ - * Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.␊ - */␊ - serviceUrl?: string␊ - /**␊ - * API identifier of the source API.␊ - */␊ - sourceApiId?: string␊ - /**␊ - * Subscription key parameter names details.␊ - */␊ - subscriptionKeyParameterNames?: (SubscriptionKeyParameterNamesContract4 | string)␊ - /**␊ - * Specifies whether an API or Product subscription is required for accessing the API.␊ - */␊ - subscriptionRequired?: (boolean | string)␊ - /**␊ - * Type of API.␊ - */␊ - type?: (("http" | "soap") | string)␊ - /**␊ - * Content value when Importing an API.␊ - */␊ - value?: string␊ - /**␊ - * Criteria to limit import of WSDL to a subset of the document.␊ - */␊ - wsdlSelector?: (ApiCreateOrUpdatePropertiesWsdlSelector3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An API Version Set contains the common configuration for a set of API Versions relating ␊ - */␊ - export interface ApiVersionSetContractDetails2 {␊ - /**␊ - * Description of API Version Set.␊ - */␊ - description?: string␊ - /**␊ - * Identifier for existing API Version Set. Omit this value to create a new Version Set.␊ - */␊ - id?: string␊ - /**␊ - * The display Name of the API Version Set.␊ - */␊ - name?: string␊ - /**␊ - * Name of HTTP header parameter that indicates the API Version if versioningScheme is set to \`header\`.␊ - */␊ - versionHeaderName?: string␊ - /**␊ - * An value that determines where the API Version identifier will be located in a HTTP request.␊ - */␊ - versioningScheme?: (("Segment" | "Query" | "Header") | string)␊ - /**␊ - * Name of query parameter that indicates the API Version if versioningScheme is set to \`query\`.␊ - */␊ - versionQueryName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * API Authentication Settings.␊ - */␊ - export interface AuthenticationSettingsContract4 {␊ - /**␊ - * API OAuth2 Authentication settings details.␊ - */␊ - oAuth2?: (OAuth2AuthenticationSettingsContract4 | string)␊ - /**␊ - * API OAuth2 Authentication settings details.␊ - */␊ - openid?: (OpenIdAuthenticationSettingsContract2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * API OAuth2 Authentication settings details.␊ - */␊ - export interface OAuth2AuthenticationSettingsContract4 {␊ - /**␊ - * OAuth authorization server identifier.␊ - */␊ - authorizationServerId?: string␊ - /**␊ - * operations scope.␊ - */␊ - scope?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * API OAuth2 Authentication settings details.␊ - */␊ - export interface OpenIdAuthenticationSettingsContract2 {␊ - /**␊ - * How to send token to the server.␊ - */␊ - bearerTokenSendingMethods?: (("authorizationHeader" | "query")[] | string)␊ - /**␊ - * OAuth authorization server identifier.␊ - */␊ - openidProviderId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Subscription key parameter names details.␊ - */␊ - export interface SubscriptionKeyParameterNamesContract4 {␊ - /**␊ - * Subscription key header name.␊ - */␊ - header?: string␊ - /**␊ - * Subscription key query string parameter name.␊ - */␊ - query?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Criteria to limit import of WSDL to a subset of the document.␊ - */␊ - export interface ApiCreateOrUpdatePropertiesWsdlSelector3 {␊ - /**␊ - * Name of endpoint(port) to import from WSDL␊ - */␊ - wsdlEndpointName?: string␊ - /**␊ - * Name of service to import from WSDL␊ - */␊ - wsdlServiceName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/tags␊ - */␊ - export interface ServiceTagsChildResource3 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Tag identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Tag contract Properties.␊ - */␊ - properties: (TagContractProperties3 | string)␊ - type: "tags"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Tag contract Properties.␊ - */␊ - export interface TagContractProperties3 {␊ - /**␊ - * Tag name.␊ - */␊ - displayName: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apiVersionSets␊ - */␊ - export interface ServiceApiVersionSetsChildResource3 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Api Version Set identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Properties of an API Version Set.␊ - */␊ - properties: (ApiVersionSetContractProperties3 | string)␊ - type: "apiVersionSets"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of an API Version Set.␊ - */␊ - export interface ApiVersionSetContractProperties3 {␊ - /**␊ - * Description of API Version Set.␊ - */␊ - description?: string␊ - /**␊ - * Name of API Version Set␊ - */␊ - displayName: string␊ - /**␊ - * Name of HTTP header parameter that indicates the API Version if versioningScheme is set to \`header\`.␊ - */␊ - versionHeaderName?: string␊ - /**␊ - * An value that determines where the API Version identifier will be located in a HTTP request.␊ - */␊ - versioningScheme: (("Segment" | "Query" | "Header") | string)␊ - /**␊ - * Name of query parameter that indicates the API Version if versioningScheme is set to \`query\`.␊ - */␊ - versionQueryName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/authorizationServers␊ - */␊ - export interface ServiceAuthorizationServersChildResource4 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Identifier of the authorization server.␊ - */␊ - name: string␊ - /**␊ - * External OAuth authorization server settings Properties.␊ - */␊ - properties: (AuthorizationServerContractProperties3 | string)␊ - type: "authorizationServers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * External OAuth authorization server settings Properties.␊ - */␊ - export interface AuthorizationServerContractProperties3 {␊ - /**␊ - * OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.␊ - */␊ - authorizationEndpoint: string␊ - /**␊ - * HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.␊ - */␊ - authorizationMethods?: (("HEAD" | "OPTIONS" | "TRACE" | "GET" | "POST" | "PUT" | "PATCH" | "DELETE")[] | string)␊ - /**␊ - * Specifies the mechanism by which access token is passed to the API. ␊ - */␊ - bearerTokenSendingMethods?: (("authorizationHeader" | "query")[] | string)␊ - /**␊ - * Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format.␊ - */␊ - clientAuthenticationMethod?: (("Basic" | "Body")[] | string)␊ - /**␊ - * Client or app id registered with this authorization server.␊ - */␊ - clientId: string␊ - /**␊ - * Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced.␊ - */␊ - clientRegistrationEndpoint: string␊ - /**␊ - * Client or app secret registered with this authorization server.␊ - */␊ - clientSecret?: string␊ - /**␊ - * Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values.␊ - */␊ - defaultScope?: string␊ - /**␊ - * Description of the authorization server. Can contain HTML formatting tags.␊ - */␊ - description?: string␊ - /**␊ - * User-friendly authorization server name.␊ - */␊ - displayName: string␊ - /**␊ - * Form of an authorization grant, which the client uses to request the access token.␊ - */␊ - grantTypes: (("authorizationCode" | "implicit" | "resourceOwnerPassword" | "clientCredentials")[] | string)␊ - /**␊ - * Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.␊ - */␊ - resourceOwnerPassword?: string␊ - /**␊ - * Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.␊ - */␊ - resourceOwnerUsername?: string␊ - /**␊ - * If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security.␊ - */␊ - supportState?: (boolean | string)␊ - /**␊ - * Additional parameters required by the token endpoint of this authorization server represented as an array of JSON objects with name and value string properties, i.e. {"name" : "name value", "value": "a value"}.␊ - */␊ - tokenBodyParameters?: (TokenBodyParameterContract4[] | string)␊ - /**␊ - * OAuth token endpoint. Contains absolute URI to entity being referenced.␊ - */␊ - tokenEndpoint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * OAuth acquire token request body parameter (www-url-form-encoded).␊ - */␊ - export interface TokenBodyParameterContract4 {␊ - /**␊ - * body parameter name.␊ - */␊ - name: string␊ - /**␊ - * body parameter value.␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/backends␊ - */␊ - export interface ServiceBackendsChildResource4 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Identifier of the Backend entity. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Parameters supplied to the Create Backend operation.␊ - */␊ - properties: (BackendContractProperties3 | string)␊ - type: "backends"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters supplied to the Create Backend operation.␊ - */␊ - export interface BackendContractProperties3 {␊ - /**␊ - * Details of the Credentials used to connect to Backend.␊ - */␊ - credentials?: (BackendCredentialsContract3 | string)␊ - /**␊ - * Backend Description.␊ - */␊ - description?: string␊ - /**␊ - * Properties specific to the Backend Type.␊ - */␊ - properties?: (BackendProperties3 | string)␊ - /**␊ - * Backend communication protocol.␊ - */␊ - protocol: (("http" | "soap") | string)␊ - /**␊ - * Details of the Backend WebProxy Server to use in the Request to Backend.␊ - */␊ - proxy?: (BackendProxyContract3 | string)␊ - /**␊ - * Management Uri of the Resource in External System. This url can be the Arm Resource Id of Logic Apps, Function Apps or Api Apps.␊ - */␊ - resourceId?: string␊ - /**␊ - * Backend Title.␊ - */␊ - title?: string␊ - /**␊ - * Properties controlling TLS Certificate Validation.␊ - */␊ - tls?: (BackendTlsProperties3 | string)␊ - /**␊ - * Runtime Url of the Backend.␊ - */␊ - url: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Details of the Credentials used to connect to Backend.␊ - */␊ - export interface BackendCredentialsContract3 {␊ - /**␊ - * Authorization header information.␊ - */␊ - authorization?: (BackendAuthorizationHeaderCredentials3 | string)␊ - /**␊ - * List of Client Certificate Thumbprint.␊ - */␊ - certificate?: (string[] | string)␊ - /**␊ - * Header Parameter description.␊ - */␊ - header?: ({␊ - [k: string]: string[]␊ - } | string)␊ - /**␊ - * Query Parameter description.␊ - */␊ - query?: ({␊ - [k: string]: string[]␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authorization header information.␊ - */␊ - export interface BackendAuthorizationHeaderCredentials3 {␊ - /**␊ - * Authentication Parameter value.␊ - */␊ - parameter: string␊ - /**␊ - * Authentication Scheme name.␊ - */␊ - scheme: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to the Backend Type.␊ - */␊ - export interface BackendProperties3 {␊ - /**␊ - * Properties of the Service Fabric Type Backend.␊ - */␊ - serviceFabricCluster?: (BackendServiceFabricClusterProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Service Fabric Type Backend.␊ - */␊ - export interface BackendServiceFabricClusterProperties3 {␊ - /**␊ - * The client certificate thumbprint for the management endpoint.␊ - */␊ - clientCertificatethumbprint: string␊ - /**␊ - * The cluster management endpoint.␊ - */␊ - managementEndpoints: (string[] | string)␊ - /**␊ - * Maximum number of retries while attempting resolve the partition.␊ - */␊ - maxPartitionResolutionRetries?: (number | string)␊ - /**␊ - * Thumbprints of certificates cluster management service uses for tls communication␊ - */␊ - serverCertificateThumbprints?: (string[] | string)␊ - /**␊ - * Server X509 Certificate Names Collection␊ - */␊ - serverX509Names?: (X509CertificateName3[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of server X509Names.␊ - */␊ - export interface X509CertificateName3 {␊ - /**␊ - * Thumbprint for the Issuer of the Certificate.␊ - */␊ - issuerCertificateThumbprint?: string␊ - /**␊ - * Common Name of the Certificate.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Details of the Backend WebProxy Server to use in the Request to Backend.␊ - */␊ - export interface BackendProxyContract3 {␊ - /**␊ - * Password to connect to the WebProxy Server␊ - */␊ - password?: string␊ - /**␊ - * WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings.␊ - */␊ - url: string␊ - /**␊ - * Username to connect to the WebProxy server␊ - */␊ - username?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties controlling TLS Certificate Validation.␊ - */␊ - export interface BackendTlsProperties3 {␊ - /**␊ - * Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host.␊ - */␊ - validateCertificateChain?: (boolean | string)␊ - /**␊ - * Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host.␊ - */␊ - validateCertificateName?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/caches␊ - */␊ - export interface ServiceCachesChildResource1 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Identifier of the Cache entity. Cache identifier (should be either 'default' or valid Azure region identifier).␊ - */␊ - name: string␊ - /**␊ - * Properties of the Cache contract.␊ - */␊ - properties: (CacheContractProperties1 | string)␊ - type: "caches"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Cache contract.␊ - */␊ - export interface CacheContractProperties1 {␊ - /**␊ - * Runtime connection string to cache␊ - */␊ - connectionString: string␊ - /**␊ - * Cache description␊ - */␊ - description?: string␊ - /**␊ - * Original uri of entity in external system cache points to␊ - */␊ - resourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/certificates␊ - */␊ - export interface ServiceCertificatesChildResource4 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Identifier of the certificate entity. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Parameters supplied to the CreateOrUpdate certificate operation.␊ - */␊ - properties: (CertificateCreateOrUpdateProperties5 | string)␊ - type: "certificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters supplied to the CreateOrUpdate certificate operation.␊ - */␊ - export interface CertificateCreateOrUpdateProperties5 {␊ - /**␊ - * Base 64 encoded certificate using the application/x-pkcs12 representation.␊ - */␊ - data: string␊ - /**␊ - * Password for the Certificate␊ - */␊ - password: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/diagnostics␊ - */␊ - export interface ServiceDiagnosticsChildResource3 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Diagnostic identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Diagnostic Entity Properties␊ - */␊ - properties: (DiagnosticContractProperties3 | string)␊ - type: "diagnostics"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Diagnostic Entity Properties␊ - */␊ - export interface DiagnosticContractProperties3 {␊ - /**␊ - * Specifies for what type of messages sampling settings should not apply.␊ - */␊ - alwaysLog?: ("allErrors" | string)␊ - /**␊ - * Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.␊ - */␊ - backend?: (PipelineDiagnosticSettings1 | string)␊ - /**␊ - * Whether to process Correlation Headers coming to Api Management Service. Only applicable to Application Insights diagnostics. Default is true.␊ - */␊ - enableHttpCorrelationHeaders?: (boolean | string)␊ - /**␊ - * Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.␊ - */␊ - frontend?: (PipelineDiagnosticSettings1 | string)␊ - /**␊ - * Sets correlation protocol to use for Application Insights diagnostics.␊ - */␊ - httpCorrelationProtocol?: (("None" | "Legacy" | "W3C") | string)␊ - /**␊ - * Resource Id of a target logger.␊ - */␊ - loggerId: string␊ - /**␊ - * Sampling settings for Diagnostic.␊ - */␊ - sampling?: (SamplingSettings1 | string)␊ - /**␊ - * The verbosity level applied to traces emitted by trace policies.␊ - */␊ - verbosity?: (("verbose" | "information" | "error") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.␊ - */␊ - export interface PipelineDiagnosticSettings1 {␊ - /**␊ - * Http message diagnostic settings.␊ - */␊ - request?: (HttpMessageDiagnostic1 | string)␊ - /**␊ - * Http message diagnostic settings.␊ - */␊ - response?: (HttpMessageDiagnostic1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http message diagnostic settings.␊ - */␊ - export interface HttpMessageDiagnostic1 {␊ - /**␊ - * Body logging settings.␊ - */␊ - body?: (BodyDiagnosticSettings1 | string)␊ - /**␊ - * Array of HTTP Headers to log.␊ - */␊ - headers?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Body logging settings.␊ - */␊ - export interface BodyDiagnosticSettings1 {␊ - /**␊ - * Number of request body bytes to log.␊ - */␊ - bytes?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Sampling settings for Diagnostic.␊ - */␊ - export interface SamplingSettings1 {␊ - /**␊ - * Rate of sampling for fixed-rate sampling.␊ - */␊ - percentage?: (number | string)␊ - /**␊ - * Sampling type.␊ - */␊ - samplingType?: ("fixed" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/templates␊ - */␊ - export interface ServiceTemplatesChildResource3 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Email Template Name Identifier.␊ - */␊ - name: (("applicationApprovedNotificationMessage" | "accountClosedDeveloper" | "quotaLimitApproachingDeveloperNotificationMessage" | "newDeveloperNotificationMessage" | "emailChangeIdentityDefault" | "inviteUserNotificationMessage" | "newCommentNotificationMessage" | "confirmSignUpIdentityDefault" | "newIssueNotificationMessage" | "purchaseDeveloperNotificationMessage" | "passwordResetIdentityDefault" | "passwordResetByAdminNotificationMessage" | "rejectDeveloperNotificationMessage" | "requestDeveloperNotificationMessage") | string)␊ - /**␊ - * Email Template Update Contract properties.␊ - */␊ - properties: (EmailTemplateUpdateParameterProperties3 | string)␊ - type: "templates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Email Template Update Contract properties.␊ - */␊ - export interface EmailTemplateUpdateParameterProperties3 {␊ - /**␊ - * Email Template Body. This should be a valid XDocument␊ - */␊ - body?: string␊ - /**␊ - * Description of the Email Template.␊ - */␊ - description?: string␊ - /**␊ - * Email Template Parameter values.␊ - */␊ - parameters?: (EmailTemplateParametersContractProperties3[] | string)␊ - /**␊ - * Subject of the Template.␊ - */␊ - subject?: string␊ - /**␊ - * Title of the Template.␊ - */␊ - title?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Email Template Parameter contract.␊ - */␊ - export interface EmailTemplateParametersContractProperties3 {␊ - /**␊ - * Template parameter description.␊ - */␊ - description?: string␊ - /**␊ - * Template parameter name.␊ - */␊ - name?: string␊ - /**␊ - * Template parameter title.␊ - */␊ - title?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/groups␊ - */␊ - export interface ServiceGroupsChildResource4 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Group identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Parameters supplied to the Create Group operation.␊ - */␊ - properties: (GroupCreateParametersProperties3 | string)␊ - type: "groups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters supplied to the Create Group operation.␊ - */␊ - export interface GroupCreateParametersProperties3 {␊ - /**␊ - * Group description.␊ - */␊ - description?: string␊ - /**␊ - * Group name.␊ - */␊ - displayName: string␊ - /**␊ - * Identifier of the external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory \`aad://.onmicrosoft.com/groups/\`; otherwise the value is null.␊ - */␊ - externalId?: string␊ - /**␊ - * Group type.␊ - */␊ - type?: (("custom" | "system" | "external") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/identityProviders␊ - */␊ - export interface ServiceIdentityProvidersChildResource4 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Identity Provider Type identifier.␊ - */␊ - name: (("facebook" | "google" | "microsoft" | "twitter" | "aad" | "aadB2C") | string)␊ - /**␊ - * The external Identity Providers like Facebook, Google, Microsoft, Twitter or Azure Active Directory which can be used to enable access to the API Management service developer portal for all users.␊ - */␊ - properties: (IdentityProviderContractProperties3 | string)␊ - type: "identityProviders"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The external Identity Providers like Facebook, Google, Microsoft, Twitter or Azure Active Directory which can be used to enable access to the API Management service developer portal for all users.␊ - */␊ - export interface IdentityProviderContractProperties3 {␊ - /**␊ - * List of Allowed Tenants when configuring Azure Active Directory login.␊ - */␊ - allowedTenants?: (string[] | string)␊ - /**␊ - * OpenID Connect discovery endpoint hostname for AAD or AAD B2C.␊ - */␊ - authority?: string␊ - /**␊ - * Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft.␊ - */␊ - clientId: string␊ - /**␊ - * Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft.␊ - */␊ - clientSecret: string␊ - /**␊ - * Password Reset Policy Name. Only applies to AAD B2C Identity Provider.␊ - */␊ - passwordResetPolicyName?: string␊ - /**␊ - * Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.␊ - */␊ - profileEditingPolicyName?: string␊ - /**␊ - * Signin Policy Name. Only applies to AAD B2C Identity Provider.␊ - */␊ - signinPolicyName?: string␊ - /**␊ - * The TenantId to use instead of Common when logging into Active Directory␊ - */␊ - signinTenant?: string␊ - /**␊ - * Signup Policy Name. Only applies to AAD B2C Identity Provider.␊ - */␊ - signupPolicyName?: string␊ - /**␊ - * Identity Provider Type identifier.␊ - */␊ - type?: (("facebook" | "google" | "microsoft" | "twitter" | "aad" | "aadB2C") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/loggers␊ - */␊ - export interface ServiceLoggersChildResource4 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Logger identifier. Must be unique in the API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * The Logger entity in API Management represents an event sink that you can use to log API Management events. Currently the Logger entity supports logging API Management events to Azure Event Hubs.␊ - */␊ - properties: (LoggerContractProperties3 | string)␊ - type: "loggers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Logger entity in API Management represents an event sink that you can use to log API Management events. Currently the Logger entity supports logging API Management events to Azure Event Hubs.␊ - */␊ - export interface LoggerContractProperties3 {␊ - /**␊ - * The name and SendRule connection string of the event hub for azureEventHub logger.␊ - * Instrumentation key for applicationInsights logger.␊ - */␊ - credentials: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Logger description.␊ - */␊ - description?: string␊ - /**␊ - * Whether records are buffered in the logger before publishing. Default is assumed to be true.␊ - */␊ - isBuffered?: (boolean | string)␊ - /**␊ - * Logger type.␊ - */␊ - loggerType: (("azureEventHub" | "applicationInsights") | string)␊ - /**␊ - * Azure Resource Id of a log target (either Azure Event Hub resource or Azure Application Insights resource).␊ - */␊ - resourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/notifications␊ - */␊ - export interface ServiceNotificationsChildResource3 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Notification Name Identifier.␊ - */␊ - name: (("RequestPublisherNotificationMessage" | "PurchasePublisherNotificationMessage" | "NewApplicationNotificationMessage" | "BCC" | "NewIssuePublisherNotificationMessage" | "AccountClosedPublisher" | "QuotaLimitApproachingPublisherNotificationMessage") | string)␊ - type: "notifications"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/openidConnectProviders␊ - */␊ - export interface ServiceOpenidConnectProvidersChildResource4 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Identifier of the OpenID Connect Provider.␊ - */␊ - name: string␊ - /**␊ - * OpenID Connect Providers Contract.␊ - */␊ - properties: (OpenidConnectProviderContractProperties3 | string)␊ - type: "openidConnectProviders"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * OpenID Connect Providers Contract.␊ - */␊ - export interface OpenidConnectProviderContractProperties3 {␊ - /**␊ - * Client ID of developer console which is the client application.␊ - */␊ - clientId: string␊ - /**␊ - * Client Secret of developer console which is the client application.␊ - */␊ - clientSecret?: string␊ - /**␊ - * User-friendly description of OpenID Connect Provider.␊ - */␊ - description?: string␊ - /**␊ - * User-friendly OpenID Connect Provider name.␊ - */␊ - displayName: string␊ - /**␊ - * Metadata endpoint URI.␊ - */␊ - metadataEndpoint: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/policies␊ - */␊ - export interface ServicePoliciesChildResource3 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * The identifier of the Policy.␊ - */␊ - name: "policy"␊ - /**␊ - * Policy contract Properties.␊ - */␊ - properties: (PolicyContractProperties3 | string)␊ - type: "policies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Policy contract Properties.␊ - */␊ - export interface PolicyContractProperties3 {␊ - /**␊ - * Format of the policyContent.␊ - */␊ - format?: (("xml" | "xml-link" | "rawxml" | "rawxml-link") | string)␊ - /**␊ - * Contents of the Policy as defined by the format.␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Sign-in settings contract properties.␊ - */␊ - export interface PortalSigninSettingProperties3 {␊ - /**␊ - * Redirect Anonymous users to the Sign-In page.␊ - */␊ - enabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Sign-up settings contract properties.␊ - */␊ - export interface PortalSignupSettingsProperties3 {␊ - /**␊ - * Allow users to sign up on a developer portal.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Terms of service contract properties.␊ - */␊ - termsOfService?: (TermsOfServiceProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Terms of service contract properties.␊ - */␊ - export interface TermsOfServiceProperties3 {␊ - /**␊ - * Ask user for consent to the terms of service.␊ - */␊ - consentRequired?: (boolean | string)␊ - /**␊ - * Display terms of service during a sign-up process.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * A terms of service text.␊ - */␊ - text?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Delegation settings contract properties.␊ - */␊ - export interface PortalDelegationSettingsProperties3 {␊ - /**␊ - * Subscriptions delegation settings properties.␊ - */␊ - subscriptions?: (SubscriptionsDelegationSettingsProperties3 | string)␊ - /**␊ - * A delegation Url.␊ - */␊ - url?: string␊ - /**␊ - * User registration delegation settings properties.␊ - */␊ - userRegistration?: (RegistrationDelegationSettingsProperties3 | string)␊ - /**␊ - * A base64-encoded validation key to validate, that a request is coming from Azure API Management.␊ - */␊ - validationKey?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Subscriptions delegation settings properties.␊ - */␊ - export interface SubscriptionsDelegationSettingsProperties3 {␊ - /**␊ - * Enable or disable delegation for subscriptions.␊ - */␊ - enabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * User registration delegation settings properties.␊ - */␊ - export interface RegistrationDelegationSettingsProperties3 {␊ - /**␊ - * Enable or disable delegation for user registration.␊ - */␊ - enabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/products␊ - */␊ - export interface ServiceProductsChildResource4 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Product identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Product profile.␊ - */␊ - properties: (ProductContractProperties3 | string)␊ - type: "products"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Product profile.␊ - */␊ - export interface ProductContractProperties3 {␊ - /**␊ - * whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of true.␊ - */␊ - approvalRequired?: (boolean | string)␊ - /**␊ - * Product description. May include HTML formatting tags.␊ - */␊ - description?: string␊ - /**␊ - * Product name.␊ - */␊ - displayName: string␊ - /**␊ - * whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished.␊ - */␊ - state?: (("notPublished" | "published") | string)␊ - /**␊ - * Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true.␊ - */␊ - subscriptionRequired?: (boolean | string)␊ - /**␊ - * Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of true.␊ - */␊ - subscriptionsLimit?: (number | string)␊ - /**␊ - * Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process.␊ - */␊ - terms?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/properties␊ - */␊ - export interface ServicePropertiesChildResource4 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Identifier of the property.␊ - */␊ - name: string␊ - /**␊ - * Property Contract properties.␊ - */␊ - properties: (PropertyContractProperties3 | string)␊ - type: "properties"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Property Contract properties.␊ - */␊ - export interface PropertyContractProperties3 {␊ - /**␊ - * Unique name of Property. It may contain only letters, digits, period, dash, and underscore characters.␊ - */␊ - displayName: string␊ - /**␊ - * Determines whether the value is a secret and should be encrypted or not. Default value is false.␊ - */␊ - secret?: (boolean | string)␊ - /**␊ - * Optional tags that when provided can be used to filter the property list.␊ - */␊ - tags?: (string[] | string)␊ - /**␊ - * Value of the property. Can contain policy expressions. It may not be empty or consist only of whitespace.␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/subscriptions␊ - */␊ - export interface ServiceSubscriptionsChildResource4 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Subscription entity Identifier. The entity represents the association between a user and a product in API Management.␊ - */␊ - name: string␊ - /**␊ - * Parameters supplied to the Create subscription operation.␊ - */␊ - properties: (SubscriptionCreateParameterProperties3 | string)␊ - type: "subscriptions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters supplied to the Create subscription operation.␊ - */␊ - export interface SubscriptionCreateParameterProperties3 {␊ - /**␊ - * Determines whether tracing can be enabled␊ - */␊ - allowTracing?: (boolean | string)␊ - /**␊ - * Subscription name.␊ - */␊ - displayName: string␊ - /**␊ - * User (user id path) for whom subscription is being created in form /users/{userId}␊ - */␊ - ownerId?: string␊ - /**␊ - * Primary subscription key. If not specified during request key will be generated automatically.␊ - */␊ - primaryKey?: string␊ - /**␊ - * Scope like /products/{productId} or /apis or /apis/{apiId}.␊ - */␊ - scope: string␊ - /**␊ - * Secondary subscription key. If not specified during request key will be generated automatically.␊ - */␊ - secondaryKey?: string␊ - /**␊ - * Initial subscription state. If no value is specified, subscription is created with Submitted state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated.␊ - */␊ - state?: (("suspended" | "active" | "expired" | "submitted" | "rejected" | "cancelled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/users␊ - */␊ - export interface ServiceUsersChildResource4 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * User identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Parameters supplied to the Create User operation.␊ - */␊ - properties: (UserCreateParameterProperties3 | string)␊ - type: "users"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters supplied to the Create User operation.␊ - */␊ - export interface UserCreateParameterProperties3 {␊ - /**␊ - * Determines the type of application which send the create user request. Default is legacy portal.␊ - */␊ - appType?: (("portal" | "developerPortal") | string)␊ - /**␊ - * Determines the type of confirmation e-mail that will be sent to the newly created user.␊ - */␊ - confirmation?: (("signup" | "invite") | string)␊ - /**␊ - * Email address. Must not be empty and must be unique within the service instance.␊ - */␊ - email: string␊ - /**␊ - * First name.␊ - */␊ - firstName: string␊ - /**␊ - * Collection of user identities.␊ - */␊ - identities?: (UserIdentityContract2[] | string)␊ - /**␊ - * Last name.␊ - */␊ - lastName: string␊ - /**␊ - * Optional note about a user set by the administrator.␊ - */␊ - note?: string␊ - /**␊ - * User Password. If no value is provided, a default password is generated.␊ - */␊ - password?: string␊ - /**␊ - * Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active.␊ - */␊ - state?: (("active" | "blocked" | "pending" | "deleted") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * User identity details.␊ - */␊ - export interface UserIdentityContract2 {␊ - /**␊ - * Identifier value within provider.␊ - */␊ - id?: string␊ - /**␊ - * Identity provider name.␊ - */␊ - provider?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis␊ - */␊ - export interface ServiceApis4 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.␊ - */␊ - name: string␊ - /**␊ - * Api Create or Update Properties.␊ - */␊ - properties: (ApiCreateOrUpdateProperties3 | string)␊ - resources?: (ServiceApisReleasesChildResource3 | ServiceApisOperationsChildResource4 | ServiceApisTagsChildResource3 | ServiceApisPoliciesChildResource3 | ServiceApisSchemasChildResource3 | ServiceApisDiagnosticsChildResource3 | ServiceApisIssuesChildResource3 | ServiceApisTagDescriptionsChildResource3)[]␊ - type: "Microsoft.ApiManagement/service/apis"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/releases␊ - */␊ - export interface ServiceApisReleasesChildResource3 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Release identifier within an API. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * API Release details␊ - */␊ - properties: (ApiReleaseContractProperties3 | string)␊ - type: "releases"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * API Release details␊ - */␊ - export interface ApiReleaseContractProperties3 {␊ - /**␊ - * Identifier of the API the release belongs to.␊ - */␊ - apiId?: string␊ - /**␊ - * Release Notes␊ - */␊ - notes?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/operations␊ - */␊ - export interface ServiceApisOperationsChildResource4 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Operation identifier within an API. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Operation Contract Properties␊ - */␊ - properties: (OperationContractProperties3 | string)␊ - type: "operations"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Operation Contract Properties␊ - */␊ - export interface OperationContractProperties3 {␊ - /**␊ - * Description of the operation. May include HTML formatting tags.␊ - */␊ - description?: string␊ - /**␊ - * Operation Name.␊ - */␊ - displayName: string␊ - /**␊ - * A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.␊ - */␊ - method: string␊ - /**␊ - * Operation Policies␊ - */␊ - policies?: string␊ - /**␊ - * Operation request details.␊ - */␊ - request?: (RequestContract4 | string)␊ - /**␊ - * Array of Operation responses.␊ - */␊ - responses?: (ResponseContract3[] | string)␊ - /**␊ - * Collection of URL template parameters.␊ - */␊ - templateParameters?: (ParameterContract4[] | string)␊ - /**␊ - * Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}␊ - */␊ - urlTemplate: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Operation request details.␊ - */␊ - export interface RequestContract4 {␊ - /**␊ - * Operation request description.␊ - */␊ - description?: string␊ - /**␊ - * Collection of operation request headers.␊ - */␊ - headers?: (ParameterContract4[] | string)␊ - /**␊ - * Collection of operation request query parameters.␊ - */␊ - queryParameters?: (ParameterContract4[] | string)␊ - /**␊ - * Collection of operation request representations.␊ - */␊ - representations?: (RepresentationContract4[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Operation parameters details.␊ - */␊ - export interface ParameterContract4 {␊ - /**␊ - * Default parameter value.␊ - */␊ - defaultValue?: string␊ - /**␊ - * Parameter description.␊ - */␊ - description?: string␊ - /**␊ - * Parameter name.␊ - */␊ - name: string␊ - /**␊ - * Specifies whether parameter is required or not.␊ - */␊ - required?: (boolean | string)␊ - /**␊ - * Parameter type.␊ - */␊ - type: string␊ - /**␊ - * Parameter values.␊ - */␊ - values?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Operation request/response representation details.␊ - */␊ - export interface RepresentationContract4 {␊ - /**␊ - * Specifies a registered or custom content type for this representation, e.g. application/xml.␊ - */␊ - contentType: string␊ - /**␊ - * Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..␊ - */␊ - formParameters?: (ParameterContract4[] | string)␊ - /**␊ - * An example of the representation.␊ - */␊ - sample?: string␊ - /**␊ - * Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.␊ - */␊ - schemaId?: string␊ - /**␊ - * Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.␊ - */␊ - typeName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Operation response details.␊ - */␊ - export interface ResponseContract3 {␊ - /**␊ - * Operation response description.␊ - */␊ - description?: string␊ - /**␊ - * Collection of operation response headers.␊ - */␊ - headers?: (ParameterContract4[] | string)␊ - /**␊ - * Collection of operation response representations.␊ - */␊ - representations?: (RepresentationContract4[] | string)␊ - /**␊ - * Operation response HTTP status code.␊ - */␊ - statusCode: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/tags␊ - */␊ - export interface ServiceApisTagsChildResource3 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Tag identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "tags"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/policies␊ - */␊ - export interface ServiceApisPoliciesChildResource3 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * The identifier of the Policy.␊ - */␊ - name: "policy"␊ - /**␊ - * Policy contract Properties.␊ - */␊ - properties: (PolicyContractProperties3 | string)␊ - type: "policies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/schemas␊ - */␊ - export interface ServiceApisSchemasChildResource3 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Schema identifier within an API. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * API Schema create or update contract Properties.␊ - */␊ - properties: (SchemaCreateOrUpdateProperties | string)␊ - type: "schemas"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * API Schema create or update contract Properties.␊ - */␊ - export interface SchemaCreateOrUpdateProperties {␊ - /**␊ - * Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml).
- \`Swagger\` Schema use \`application/vnd.ms-azure-apim.swagger.definitions+json\`
- \`WSDL\` Schema use \`application/vnd.ms-azure-apim.xsd+xml\`
- \`OpenApi\` Schema use \`application/vnd.oai.openapi.components+json\`
- \`WADL Schema\` use \`application/vnd.ms-azure-apim.wadl.grammars+xml\`.␊ - */␊ - contentType: string␊ - /**␊ - * Schema Document Properties.␊ - */␊ - document?: (SchemaDocumentProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Schema Document Properties.␊ - */␊ - export interface SchemaDocumentProperties3 {␊ - /**␊ - * Json escaped string defining the document representing the Schema.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/diagnostics␊ - */␊ - export interface ServiceApisDiagnosticsChildResource3 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Diagnostic identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Diagnostic Entity Properties␊ - */␊ - properties: (DiagnosticContractProperties3 | string)␊ - type: "diagnostics"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/issues␊ - */␊ - export interface ServiceApisIssuesChildResource3 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Issue identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Issue contract Properties.␊ - */␊ - properties: (IssueContractProperties3 | string)␊ - type: "issues"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Issue contract Properties.␊ - */␊ - export interface IssueContractProperties3 {␊ - /**␊ - * A resource identifier for the API the issue was created for.␊ - */␊ - apiId?: string␊ - /**␊ - * Date and time when the issue was created.␊ - */␊ - createdDate?: string␊ - /**␊ - * Text describing the issue.␊ - */␊ - description: string␊ - /**␊ - * Status of the issue.␊ - */␊ - state?: (("proposed" | "open" | "removed" | "resolved" | "closed") | string)␊ - /**␊ - * The issue title.␊ - */␊ - title: string␊ - /**␊ - * A resource identifier for the user created the issue.␊ - */␊ - userId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/tagDescriptions␊ - */␊ - export interface ServiceApisTagDescriptionsChildResource3 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Tag identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Parameters supplied to the Create TagDescription operation.␊ - */␊ - properties: (TagDescriptionBaseProperties3 | string)␊ - type: "tagDescriptions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters supplied to the Create TagDescription operation.␊ - */␊ - export interface TagDescriptionBaseProperties3 {␊ - /**␊ - * Description of the Tag.␊ - */␊ - description?: string␊ - /**␊ - * Description of the external resources describing the tag.␊ - */␊ - externalDocsDescription?: string␊ - /**␊ - * Absolute URL of external resources describing the tag.␊ - */␊ - externalDocsUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/diagnostics␊ - */␊ - export interface ServiceApisDiagnostics3 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Diagnostic identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Diagnostic Entity Properties␊ - */␊ - properties: (DiagnosticContractProperties3 | string)␊ - type: "Microsoft.ApiManagement/service/apis/diagnostics"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/operations␊ - */␊ - export interface ServiceApisOperations4 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Operation identifier within an API. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Operation Contract Properties␊ - */␊ - properties: (OperationContractProperties3 | string)␊ - resources?: (ServiceApisOperationsPoliciesChildResource3 | ServiceApisOperationsTagsChildResource3)[]␊ - type: "Microsoft.ApiManagement/service/apis/operations"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/operations/policies␊ - */␊ - export interface ServiceApisOperationsPoliciesChildResource3 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * The identifier of the Policy.␊ - */␊ - name: "policy"␊ - /**␊ - * Policy contract Properties.␊ - */␊ - properties: (PolicyContractProperties3 | string)␊ - type: "policies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/operations/tags␊ - */␊ - export interface ServiceApisOperationsTagsChildResource3 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Tag identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "tags"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/operations/policies␊ - */␊ - export interface ServiceApisOperationsPolicies3 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * The identifier of the Policy.␊ - */␊ - name: string␊ - /**␊ - * Policy contract Properties.␊ - */␊ - properties: (PolicyContractProperties3 | string)␊ - type: "Microsoft.ApiManagement/service/apis/operations/policies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/operations/tags␊ - */␊ - export interface ServiceApisOperationsTags3 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Tag identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "Microsoft.ApiManagement/service/apis/operations/tags"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/policies␊ - */␊ - export interface ServiceApisPolicies3 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * The identifier of the Policy.␊ - */␊ - name: string␊ - /**␊ - * Policy contract Properties.␊ - */␊ - properties: (PolicyContractProperties3 | string)␊ - type: "Microsoft.ApiManagement/service/apis/policies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/releases␊ - */␊ - export interface ServiceApisReleases3 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Release identifier within an API. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * API Release details␊ - */␊ - properties: (ApiReleaseContractProperties3 | string)␊ - type: "Microsoft.ApiManagement/service/apis/releases"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/schemas␊ - */␊ - export interface ServiceApisSchemas3 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Schema identifier within an API. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * API Schema create or update contract Properties.␊ - */␊ - properties: (SchemaCreateOrUpdateProperties | string)␊ - type: "Microsoft.ApiManagement/service/apis/schemas"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/tagDescriptions␊ - */␊ - export interface ServiceApisTagDescriptions3 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Tag identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Parameters supplied to the Create TagDescription operation.␊ - */␊ - properties: (TagDescriptionBaseProperties3 | string)␊ - type: "Microsoft.ApiManagement/service/apis/tagDescriptions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/tags␊ - */␊ - export interface ServiceApisTags3 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Tag identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "Microsoft.ApiManagement/service/apis/tags"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/issues␊ - */␊ - export interface ServiceApisIssues2 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Issue identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Issue contract Properties.␊ - */␊ - properties: (IssueContractProperties3 | string)␊ - resources?: (ServiceApisIssuesCommentsChildResource2 | ServiceApisIssuesAttachmentsChildResource2)[]␊ - type: "Microsoft.ApiManagement/service/apis/issues"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/issues/comments␊ - */␊ - export interface ServiceApisIssuesCommentsChildResource2 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Comment identifier within an Issue. Must be unique in the current Issue.␊ - */␊ - name: string␊ - /**␊ - * Issue Comment contract Properties.␊ - */␊ - properties: (IssueCommentContractProperties2 | string)␊ - type: "comments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Issue Comment contract Properties.␊ - */␊ - export interface IssueCommentContractProperties2 {␊ - /**␊ - * Date and time when the comment was created.␊ - */␊ - createdDate?: string␊ - /**␊ - * Comment text.␊ - */␊ - text: string␊ - /**␊ - * A resource identifier for the user who left the comment.␊ - */␊ - userId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/issues/attachments␊ - */␊ - export interface ServiceApisIssuesAttachmentsChildResource2 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Attachment identifier within an Issue. Must be unique in the current Issue.␊ - */␊ - name: string␊ - /**␊ - * Issue Attachment contract Properties.␊ - */␊ - properties: (IssueAttachmentContractProperties2 | string)␊ - type: "attachments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Issue Attachment contract Properties.␊ - */␊ - export interface IssueAttachmentContractProperties2 {␊ - /**␊ - * An HTTP link or Base64-encoded binary data.␊ - */␊ - content: string␊ - /**␊ - * Either 'link' if content is provided via an HTTP link or the MIME type of the Base64-encoded binary data provided in the 'content' property.␊ - */␊ - contentFormat: string␊ - /**␊ - * Filename by which the binary data will be saved.␊ - */␊ - title: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apiVersionSets␊ - */␊ - export interface ServiceApiVersionSets3 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Api Version Set identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Properties of an API Version Set.␊ - */␊ - properties: (ApiVersionSetContractProperties3 | string)␊ - type: "Microsoft.ApiManagement/service/apiVersionSets"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/authorizationServers␊ - */␊ - export interface ServiceAuthorizationServers4 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Identifier of the authorization server.␊ - */␊ - name: string␊ - /**␊ - * External OAuth authorization server settings Properties.␊ - */␊ - properties: (AuthorizationServerContractProperties3 | string)␊ - type: "Microsoft.ApiManagement/service/authorizationServers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/backends␊ - */␊ - export interface ServiceBackends4 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Identifier of the Backend entity. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Parameters supplied to the Create Backend operation.␊ - */␊ - properties: (BackendContractProperties3 | string)␊ - type: "Microsoft.ApiManagement/service/backends"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/caches␊ - */␊ - export interface ServiceCaches {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Identifier of the Cache entity. Cache identifier (should be either 'default' or valid Azure region identifier).␊ - */␊ - name: string␊ - /**␊ - * Properties of the Cache contract.␊ - */␊ - properties: (CacheContractProperties1 | string)␊ - type: "Microsoft.ApiManagement/service/caches"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/certificates␊ - */␊ - export interface ServiceCertificates4 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Identifier of the certificate entity. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Parameters supplied to the CreateOrUpdate certificate operation.␊ - */␊ - properties: (CertificateCreateOrUpdateProperties5 | string)␊ - type: "Microsoft.ApiManagement/service/certificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/diagnostics␊ - */␊ - export interface ServiceDiagnostics3 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Diagnostic identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Diagnostic Entity Properties␊ - */␊ - properties: (DiagnosticContractProperties3 | string)␊ - type: "Microsoft.ApiManagement/service/diagnostics"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/groups␊ - */␊ - export interface ServiceGroups4 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Group identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Parameters supplied to the Create Group operation.␊ - */␊ - properties: (GroupCreateParametersProperties3 | string)␊ - resources?: ServiceGroupsUsersChildResource4[]␊ - type: "Microsoft.ApiManagement/service/groups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/groups/users␊ - */␊ - export interface ServiceGroupsUsersChildResource4 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * User identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "users"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/groups/users␊ - */␊ - export interface ServiceGroupsUsers4 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * User identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "Microsoft.ApiManagement/service/groups/users"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/identityProviders␊ - */␊ - export interface ServiceIdentityProviders4 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Identity Provider Type identifier.␊ - */␊ - name: (("facebook" | "google" | "microsoft" | "twitter" | "aad" | "aadB2C") | string)␊ - /**␊ - * The external Identity Providers like Facebook, Google, Microsoft, Twitter or Azure Active Directory which can be used to enable access to the API Management service developer portal for all users.␊ - */␊ - properties: (IdentityProviderContractProperties3 | string)␊ - type: "Microsoft.ApiManagement/service/identityProviders"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/loggers␊ - */␊ - export interface ServiceLoggers4 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Logger identifier. Must be unique in the API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * The Logger entity in API Management represents an event sink that you can use to log API Management events. Currently the Logger entity supports logging API Management events to Azure Event Hubs.␊ - */␊ - properties: (LoggerContractProperties3 | string)␊ - type: "Microsoft.ApiManagement/service/loggers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/notifications␊ - */␊ - export interface ServiceNotifications3 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Notification Name Identifier.␊ - */␊ - name: (("RequestPublisherNotificationMessage" | "PurchasePublisherNotificationMessage" | "NewApplicationNotificationMessage" | "BCC" | "NewIssuePublisherNotificationMessage" | "AccountClosedPublisher" | "QuotaLimitApproachingPublisherNotificationMessage") | string)␊ - resources?: (ServiceNotificationsRecipientUsersChildResource3 | ServiceNotificationsRecipientEmailsChildResource3)[]␊ - type: "Microsoft.ApiManagement/service/notifications"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/notifications/recipientUsers␊ - */␊ - export interface ServiceNotificationsRecipientUsersChildResource3 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * User identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "recipientUsers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/notifications/recipientEmails␊ - */␊ - export interface ServiceNotificationsRecipientEmailsChildResource3 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Email identifier.␊ - */␊ - name: string␊ - type: "recipientEmails"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/notifications/recipientEmails␊ - */␊ - export interface ServiceNotificationsRecipientEmails3 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Email identifier.␊ - */␊ - name: string␊ - type: "Microsoft.ApiManagement/service/notifications/recipientEmails"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/notifications/recipientUsers␊ - */␊ - export interface ServiceNotificationsRecipientUsers3 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * User identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "Microsoft.ApiManagement/service/notifications/recipientUsers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/openidConnectProviders␊ - */␊ - export interface ServiceOpenidConnectProviders4 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Identifier of the OpenID Connect Provider.␊ - */␊ - name: string␊ - /**␊ - * OpenID Connect Providers Contract.␊ - */␊ - properties: (OpenidConnectProviderContractProperties3 | string)␊ - type: "Microsoft.ApiManagement/service/openidConnectProviders"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/policies␊ - */␊ - export interface ServicePolicies3 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * The identifier of the Policy.␊ - */␊ - name: string␊ - /**␊ - * Policy contract Properties.␊ - */␊ - properties: (PolicyContractProperties3 | string)␊ - type: "Microsoft.ApiManagement/service/policies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/products␊ - */␊ - export interface ServiceProducts4 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Product identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Product profile.␊ - */␊ - properties: (ProductContractProperties3 | string)␊ - resources?: (ServiceProductsTagsChildResource3 | ServiceProductsApisChildResource4 | ServiceProductsGroupsChildResource4 | ServiceProductsPoliciesChildResource3)[]␊ - type: "Microsoft.ApiManagement/service/products"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/products/tags␊ - */␊ - export interface ServiceProductsTagsChildResource3 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Tag identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "tags"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/products/apis␊ - */␊ - export interface ServiceProductsApisChildResource4 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.␊ - */␊ - name: string␊ - type: "apis"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/products/groups␊ - */␊ - export interface ServiceProductsGroupsChildResource4 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Group identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "groups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/products/policies␊ - */␊ - export interface ServiceProductsPoliciesChildResource3 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * The identifier of the Policy.␊ - */␊ - name: "policy"␊ - /**␊ - * Policy contract Properties.␊ - */␊ - properties: (PolicyContractProperties3 | string)␊ - type: "policies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/products/apis␊ - */␊ - export interface ServiceProductsApis4 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.␊ - */␊ - name: string␊ - type: "Microsoft.ApiManagement/service/products/apis"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/products/groups␊ - */␊ - export interface ServiceProductsGroups4 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Group identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "Microsoft.ApiManagement/service/products/groups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/products/policies␊ - */␊ - export interface ServiceProductsPolicies3 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * The identifier of the Policy.␊ - */␊ - name: string␊ - /**␊ - * Policy contract Properties.␊ - */␊ - properties: (PolicyContractProperties3 | string)␊ - type: "Microsoft.ApiManagement/service/products/policies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/products/tags␊ - */␊ - export interface ServiceProductsTags3 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Tag identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - type: "Microsoft.ApiManagement/service/products/tags"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/properties␊ - */␊ - export interface ServiceProperties4 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Identifier of the property.␊ - */␊ - name: string␊ - /**␊ - * Property Contract properties.␊ - */␊ - properties: (PropertyContractProperties3 | string)␊ - type: "Microsoft.ApiManagement/service/properties"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/subscriptions␊ - */␊ - export interface ServiceSubscriptions4 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Subscription entity Identifier. The entity represents the association between a user and a product in API Management.␊ - */␊ - name: string␊ - /**␊ - * Parameters supplied to the Create subscription operation.␊ - */␊ - properties: (SubscriptionCreateParameterProperties3 | string)␊ - type: "Microsoft.ApiManagement/service/subscriptions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/tags␊ - */␊ - export interface ServiceTags3 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Tag identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Tag contract Properties.␊ - */␊ - properties: (TagContractProperties3 | string)␊ - type: "Microsoft.ApiManagement/service/tags"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/templates␊ - */␊ - export interface ServiceTemplates3 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Email Template Name Identifier.␊ - */␊ - name: (("applicationApprovedNotificationMessage" | "accountClosedDeveloper" | "quotaLimitApproachingDeveloperNotificationMessage" | "newDeveloperNotificationMessage" | "emailChangeIdentityDefault" | "inviteUserNotificationMessage" | "newCommentNotificationMessage" | "confirmSignUpIdentityDefault" | "newIssueNotificationMessage" | "purchaseDeveloperNotificationMessage" | "passwordResetIdentityDefault" | "passwordResetByAdminNotificationMessage" | "rejectDeveloperNotificationMessage" | "requestDeveloperNotificationMessage") | string)␊ - /**␊ - * Email Template Update Contract properties.␊ - */␊ - properties: (EmailTemplateUpdateParameterProperties3 | string)␊ - type: "Microsoft.ApiManagement/service/templates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/users␊ - */␊ - export interface ServiceUsers4 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * User identifier. Must be unique in the current API Management service instance.␊ - */␊ - name: string␊ - /**␊ - * Parameters supplied to the Create User operation.␊ - */␊ - properties: (UserCreateParameterProperties3 | string)␊ - type: "Microsoft.ApiManagement/service/users"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/issues/attachments␊ - */␊ - export interface ServiceApisIssuesAttachments2 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Attachment identifier within an Issue. Must be unique in the current Issue.␊ - */␊ - name: string␊ - /**␊ - * Issue Attachment contract Properties.␊ - */␊ - properties: (IssueAttachmentContractProperties2 | string)␊ - type: "Microsoft.ApiManagement/service/apis/issues/attachments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ApiManagement/service/apis/issues/comments␊ - */␊ - export interface ServiceApisIssuesComments2 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Comment identifier within an Issue. Must be unique in the current Issue.␊ - */␊ - name: string␊ - /**␊ - * Issue Comment contract Properties.␊ - */␊ - properties: (IssueCommentContractProperties2 | string)␊ - type: "Microsoft.ApiManagement/service/apis/issues/comments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.NotificationHubs/namespaces␊ - */␊ - export interface Namespaces {␊ - apiVersion: "2014-09-01"␊ - /**␊ - * Gets or sets Namespace data center location.␊ - */␊ - location: string␊ - /**␊ - * The namespace name.␊ - */␊ - name: string␊ - /**␊ - * Namespace properties.␊ - */␊ - properties: (NamespaceProperties | string)␊ - resources?: (Namespaces_AuthorizationRulesChildResource | NamespacesNotificationHubsChildResource)[]␊ - /**␊ - * Gets or sets Namespace tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.NotificationHubs/namespaces"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Namespace properties.␊ - */␊ - export interface NamespaceProperties {␊ - /**␊ - * The time the namespace was created.␊ - */␊ - createdAt?: string␊ - /**␊ - * Whether or not the namespace is set as Critical.␊ - */␊ - critical?: (boolean | string)␊ - /**␊ - * Whether or not the namespace is currently enabled.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * The name of the namespace.␊ - */␊ - name?: string␊ - /**␊ - * Gets or sets the namespace type.␊ - */␊ - namespaceType?: (("Messaging" | "NotificationHub") | string)␊ - /**␊ - * Gets or sets provisioning state of the Namespace.␊ - */␊ - provisioningState?: string␊ - /**␊ - * Specifies the targeted region in which the namespace should be created. It can be any of the following values: Australia East, Australia Southeast, Central US, East US, East US 2, West US, North Central US, South Central US, East Asia, Southeast Asia, Brazil South, Japan East, Japan West, North Europe, West Europe␊ - */␊ - region?: string␊ - /**␊ - * ScaleUnit where the namespace gets created␊ - */␊ - scaleUnit?: string␊ - /**␊ - * Endpoint you can use to perform NotificationHub operations.␊ - */␊ - serviceBusEndpoint?: string␊ - /**␊ - * Status of the namespace. It can be any of these values:1 = Created/Active2 = Creating3 = Suspended4 = Deleting␊ - */␊ - status?: string␊ - /**␊ - * The Id of the Azure subscription associated with the namespace.␊ - */␊ - subscriptionId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.NotificationHubs/namespaces/AuthorizationRules␊ - */␊ - export interface Namespaces_AuthorizationRulesChildResource {␊ - apiVersion: "2014-09-01"␊ - /**␊ - * Gets or sets Namespace data center location.␊ - */␊ - location?: string␊ - /**␊ - * Authorization Rule Name.␊ - */␊ - name: string␊ - /**␊ - * SharedAccessAuthorizationRule properties.␊ - */␊ - properties: (SharedAccessAuthorizationRuleProperties1 | string)␊ - type: "AuthorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SharedAccessAuthorizationRule properties.␊ - */␊ - export interface SharedAccessAuthorizationRuleProperties1 {␊ - /**␊ - * The type of the claim.␊ - */␊ - claimType?: string␊ - /**␊ - * The value of the claim.␊ - */␊ - claimValue?: string␊ - /**␊ - * The time at which the authorization rule was created.␊ - */␊ - createdTime?: string␊ - /**␊ - * The name of the key that was used.␊ - */␊ - keyName?: string␊ - /**␊ - * The most recent time the rule was updated.␊ - */␊ - modifiedTime?: string␊ - /**␊ - * The primary key that was used.␊ - */␊ - primaryKey?: string␊ - /**␊ - * The revision number for the rule.␊ - */␊ - revision?: (number | string)␊ - /**␊ - * The rights associated with the rule.␊ - */␊ - rights?: (("Manage" | "Send" | "Listen")[] | string)␊ - /**␊ - * The secondary key that was used.␊ - */␊ - secondaryKey?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.NotificationHubs/namespaces/notificationHubs␊ - */␊ - export interface NamespacesNotificationHubsChildResource {␊ - apiVersion: "2014-09-01"␊ - /**␊ - * Gets or sets NotificationHub data center location.␊ - */␊ - location: string␊ - /**␊ - * The notification hub name.␊ - */␊ - name: string␊ - /**␊ - * NotificationHub properties.␊ - */␊ - properties: (NotificationHubProperties1 | string)␊ - /**␊ - * Gets or sets NotificationHub tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "notificationHubs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NotificationHub properties.␊ - */␊ - export interface NotificationHubProperties1 {␊ - /**␊ - * Description of a NotificationHub AdmCredential.␊ - */␊ - admCredential?: (AdmCredential1 | string)␊ - /**␊ - * Description of a NotificationHub ApnsCredential.␊ - */␊ - apnsCredential?: (ApnsCredential1 | string)␊ - /**␊ - * The AuthorizationRules of the created NotificationHub␊ - */␊ - authorizationRules?: (SharedAccessAuthorizationRuleProperties1[] | string)␊ - /**␊ - * Description of a NotificationHub BaiduCredential.␊ - */␊ - baiduCredential?: (BaiduCredential1 | string)␊ - /**␊ - * Description of a NotificationHub GcmCredential.␊ - */␊ - gcmCredential?: (GcmCredential1 | string)␊ - /**␊ - * Description of a NotificationHub MpnsCredential.␊ - */␊ - mpnsCredential?: (MpnsCredential1 | string)␊ - /**␊ - * The NotificationHub name.␊ - */␊ - name?: string␊ - /**␊ - * The RegistrationTtl of the created NotificationHub␊ - */␊ - registrationTtl?: string␊ - /**␊ - * Description of a NotificationHub WnsCredential.␊ - */␊ - wnsCredential?: (WnsCredential1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a NotificationHub AdmCredential.␊ - */␊ - export interface AdmCredential1 {␊ - /**␊ - * Description of a NotificationHub AdmCredential.␊ - */␊ - properties?: (AdmCredentialProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a NotificationHub AdmCredential.␊ - */␊ - export interface AdmCredentialProperties1 {␊ - /**␊ - * Gets or sets the URL of the authorization token.␊ - */␊ - authTokenUrl?: string␊ - /**␊ - * Gets or sets the client identifier.␊ - */␊ - clientId?: string␊ - /**␊ - * Gets or sets the credential secret access key.␊ - */␊ - clientSecret?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a NotificationHub ApnsCredential.␊ - */␊ - export interface ApnsCredential1 {␊ - /**␊ - * Description of a NotificationHub ApnsCredential.␊ - */␊ - properties?: (ApnsCredentialProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a NotificationHub ApnsCredential.␊ - */␊ - export interface ApnsCredentialProperties1 {␊ - /**␊ - * Gets or sets the APNS certificate.␊ - */␊ - apnsCertificate?: string␊ - /**␊ - * Gets or sets the certificate key.␊ - */␊ - certificateKey?: string␊ - /**␊ - * Gets or sets the endpoint of this credential.␊ - */␊ - endpoint?: string␊ - /**␊ - * Gets or sets the Apns certificate Thumbprint␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a NotificationHub BaiduCredential.␊ - */␊ - export interface BaiduCredential1 {␊ - /**␊ - * Description of a NotificationHub BaiduCredential.␊ - */␊ - properties?: (BaiduCredentialProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a NotificationHub BaiduCredential.␊ - */␊ - export interface BaiduCredentialProperties1 {␊ - /**␊ - * Get or Set Baidu Api Key.␊ - */␊ - baiduApiKey?: string␊ - /**␊ - * Get or Set Baidu Endpoint.␊ - */␊ - baiduEndPoint?: string␊ - /**␊ - * Get or Set Baidu Secret Key␊ - */␊ - baiduSecretKey?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a NotificationHub GcmCredential.␊ - */␊ - export interface GcmCredential1 {␊ - /**␊ - * Description of a NotificationHub GcmCredential.␊ - */␊ - properties?: (GcmCredentialProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a NotificationHub GcmCredential.␊ - */␊ - export interface GcmCredentialProperties1 {␊ - /**␊ - * Gets or sets the GCM endpoint.␊ - */␊ - gcmEndpoint?: string␊ - /**␊ - * Gets or sets the Google API key.␊ - */␊ - googleApiKey?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a NotificationHub MpnsCredential.␊ - */␊ - export interface MpnsCredential1 {␊ - /**␊ - * Description of a NotificationHub MpnsCredential.␊ - */␊ - properties?: (MpnsCredentialProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a NotificationHub MpnsCredential.␊ - */␊ - export interface MpnsCredentialProperties1 {␊ - /**␊ - * Gets or sets the certificate key for this credential.␊ - */␊ - certificateKey?: string␊ - /**␊ - * Gets or sets the MPNS certificate.␊ - */␊ - mpnsCertificate?: string␊ - /**␊ - * Gets or sets the Mpns certificate Thumbprint␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a NotificationHub WnsCredential.␊ - */␊ - export interface WnsCredential1 {␊ - /**␊ - * Description of a NotificationHub WnsCredential.␊ - */␊ - properties?: (WnsCredentialProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a NotificationHub WnsCredential.␊ - */␊ - export interface WnsCredentialProperties1 {␊ - /**␊ - * Gets or sets the package ID for this credential.␊ - */␊ - packageSid?: string␊ - /**␊ - * Gets or sets the secret key.␊ - */␊ - secretKey?: string␊ - /**␊ - * Gets or sets the Windows Live endpoint.␊ - */␊ - windowsLiveEndpoint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.NotificationHubs/namespaces/AuthorizationRules␊ - */␊ - export interface Namespaces_AuthorizationRules {␊ - apiVersion: "2014-09-01"␊ - /**␊ - * Gets or sets Namespace data center location.␊ - */␊ - location?: string␊ - /**␊ - * Authorization Rule Name.␊ - */␊ - name: string␊ - /**␊ - * SharedAccessAuthorizationRule properties.␊ - */␊ - properties: (SharedAccessAuthorizationRuleProperties1 | string)␊ - type: "Microsoft.NotificationHubs/namespaces/AuthorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.NotificationHubs/namespaces/notificationHubs␊ - */␊ - export interface NamespacesNotificationHubs1 {␊ - apiVersion: "2014-09-01"␊ - /**␊ - * Gets or sets NotificationHub data center location.␊ - */␊ - location: string␊ - /**␊ - * The notification hub name.␊ - */␊ - name: string␊ - /**␊ - * NotificationHub properties.␊ - */␊ - properties: (NotificationHubProperties1 | string)␊ - resources?: NamespacesNotificationHubs_AuthorizationRulesChildResource1[]␊ - /**␊ - * Gets or sets NotificationHub tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.NotificationHubs/namespaces/notificationHubs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.NotificationHubs/namespaces/notificationHubs/AuthorizationRules␊ - */␊ - export interface NamespacesNotificationHubs_AuthorizationRulesChildResource1 {␊ - apiVersion: "2014-09-01"␊ - /**␊ - * Gets or sets Namespace data center location.␊ - */␊ - location?: string␊ - /**␊ - * Authorization Rule Name.␊ - */␊ - name: string␊ - /**␊ - * SharedAccessAuthorizationRule properties.␊ - */␊ - properties: (SharedAccessAuthorizationRuleProperties1 | string)␊ - type: "AuthorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.NotificationHubs/namespaces/notificationHubs/AuthorizationRules␊ - */␊ - export interface NamespacesNotificationHubs_AuthorizationRules1 {␊ - apiVersion: "2014-09-01"␊ - /**␊ - * Gets or sets Namespace data center location.␊ - */␊ - location?: string␊ - /**␊ - * Authorization Rule Name.␊ - */␊ - name: string␊ - /**␊ - * SharedAccessAuthorizationRule properties.␊ - */␊ - properties: (SharedAccessAuthorizationRuleProperties1 | string)␊ - type: "Microsoft.NotificationHubs/namespaces/notificationHubs/AuthorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.NotificationHubs/namespaces␊ - */␊ - export interface Namespaces1 {␊ - apiVersion: "2016-03-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The namespace name.␊ - */␊ - name: string␊ - /**␊ - * Namespace properties.␊ - */␊ - properties: (NamespaceProperties1 | string)␊ - resources?: (Namespaces_AuthorizationRulesChildResource1 | NamespacesNotificationHubsChildResource1)[]␊ - /**␊ - * The Sku description for a namespace␊ - */␊ - sku?: (Sku34 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.NotificationHubs/namespaces"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Namespace properties.␊ - */␊ - export interface NamespaceProperties1 {␊ - /**␊ - * The time the namespace was created.␊ - */␊ - createdAt?: string␊ - /**␊ - * Whether or not the namespace is set as Critical.␊ - */␊ - critical?: (boolean | string)␊ - /**␊ - * Whether or not the namespace is currently enabled.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * The name of the namespace.␊ - */␊ - name?: string␊ - /**␊ - * The namespace type.␊ - */␊ - namespaceType?: (("Messaging" | "NotificationHub") | string)␊ - /**␊ - * Provisioning state of the Namespace.␊ - */␊ - provisioningState?: string␊ - /**␊ - * Specifies the targeted region in which the namespace should be created. It can be any of the following values: Australia East, Australia Southeast, Central US, East US, East US 2, West US, North Central US, South Central US, East Asia, Southeast Asia, Brazil South, Japan East, Japan West, North Europe, West Europe␊ - */␊ - region?: string␊ - /**␊ - * ScaleUnit where the namespace gets created␊ - */␊ - scaleUnit?: string␊ - /**␊ - * Endpoint you can use to perform NotificationHub operations.␊ - */␊ - serviceBusEndpoint?: string␊ - /**␊ - * Status of the namespace. It can be any of these values:1 = Created/Active2 = Creating3 = Suspended4 = Deleting␊ - */␊ - status?: string␊ - /**␊ - * The Id of the Azure subscription associated with the namespace.␊ - */␊ - subscriptionId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.NotificationHubs/namespaces/AuthorizationRules␊ - */␊ - export interface Namespaces_AuthorizationRulesChildResource1 {␊ - apiVersion: "2016-03-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * Authorization Rule Name.␊ - */␊ - name: string␊ - /**␊ - * SharedAccessAuthorizationRule properties.␊ - */␊ - properties: (SharedAccessAuthorizationRuleProperties2 | string)␊ - /**␊ - * The Sku description for a namespace␊ - */␊ - sku?: (Sku34 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "AuthorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SharedAccessAuthorizationRule properties.␊ - */␊ - export interface SharedAccessAuthorizationRuleProperties2 {␊ - /**␊ - * The rights associated with the rule.␊ - */␊ - rights?: (("Manage" | "Send" | "Listen")[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Sku description for a namespace␊ - */␊ - export interface Sku34 {␊ - /**␊ - * The capacity of the resource␊ - */␊ - capacity?: (number | string)␊ - /**␊ - * The Sku Family␊ - */␊ - family?: string␊ - /**␊ - * Name of the notification hub sku.␊ - */␊ - name: (("Free" | "Basic" | "Standard") | string)␊ - /**␊ - * The Sku size␊ - */␊ - size?: string␊ - /**␊ - * The tier of particular sku␊ - */␊ - tier?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.NotificationHubs/namespaces/notificationHubs␊ - */␊ - export interface NamespacesNotificationHubsChildResource1 {␊ - apiVersion: "2016-03-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The notification hub name.␊ - */␊ - name: string␊ - /**␊ - * NotificationHub properties.␊ - */␊ - properties: (NotificationHubProperties2 | string)␊ - /**␊ - * The Sku description for a namespace␊ - */␊ - sku?: (Sku34 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "notificationHubs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NotificationHub properties.␊ - */␊ - export interface NotificationHubProperties2 {␊ - /**␊ - * Description of a NotificationHub AdmCredential.␊ - */␊ - admCredential?: (AdmCredential2 | string)␊ - /**␊ - * Description of a NotificationHub ApnsCredential.␊ - */␊ - apnsCredential?: (ApnsCredential2 | string)␊ - /**␊ - * The AuthorizationRules of the created NotificationHub␊ - */␊ - authorizationRules?: (SharedAccessAuthorizationRuleProperties2[] | string)␊ - /**␊ - * Description of a NotificationHub BaiduCredential.␊ - */␊ - baiduCredential?: (BaiduCredential2 | string)␊ - /**␊ - * Description of a NotificationHub GcmCredential.␊ - */␊ - gcmCredential?: (GcmCredential2 | string)␊ - /**␊ - * Description of a NotificationHub MpnsCredential.␊ - */␊ - mpnsCredential?: (MpnsCredential2 | string)␊ - /**␊ - * The NotificationHub name.␊ - */␊ - name?: string␊ - /**␊ - * The RegistrationTtl of the created NotificationHub␊ - */␊ - registrationTtl?: string␊ - /**␊ - * Description of a NotificationHub WnsCredential.␊ - */␊ - wnsCredential?: (WnsCredential2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a NotificationHub AdmCredential.␊ - */␊ - export interface AdmCredential2 {␊ - /**␊ - * Description of a NotificationHub AdmCredential.␊ - */␊ - properties?: (AdmCredentialProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a NotificationHub AdmCredential.␊ - */␊ - export interface AdmCredentialProperties2 {␊ - /**␊ - * The URL of the authorization token.␊ - */␊ - authTokenUrl?: string␊ - /**␊ - * The client identifier.␊ - */␊ - clientId?: string␊ - /**␊ - * The credential secret access key.␊ - */␊ - clientSecret?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a NotificationHub ApnsCredential.␊ - */␊ - export interface ApnsCredential2 {␊ - /**␊ - * Description of a NotificationHub ApnsCredential.␊ - */␊ - properties?: (ApnsCredentialProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a NotificationHub ApnsCredential.␊ - */␊ - export interface ApnsCredentialProperties2 {␊ - /**␊ - * The APNS certificate.␊ - */␊ - apnsCertificate?: string␊ - /**␊ - * The certificate key.␊ - */␊ - certificateKey?: string␊ - /**␊ - * The endpoint of this credential.␊ - */␊ - endpoint?: string␊ - /**␊ - * The APNS certificate Thumbprint␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a NotificationHub BaiduCredential.␊ - */␊ - export interface BaiduCredential2 {␊ - /**␊ - * Description of a NotificationHub BaiduCredential.␊ - */␊ - properties?: (BaiduCredentialProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a NotificationHub BaiduCredential.␊ - */␊ - export interface BaiduCredentialProperties2 {␊ - /**␊ - * Baidu Api Key.␊ - */␊ - baiduApiKey?: string␊ - /**␊ - * Baidu Endpoint.␊ - */␊ - baiduEndPoint?: string␊ - /**␊ - * Baidu Secret Key␊ - */␊ - baiduSecretKey?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a NotificationHub GcmCredential.␊ - */␊ - export interface GcmCredential2 {␊ - /**␊ - * Description of a NotificationHub GcmCredential.␊ - */␊ - properties?: (GcmCredentialProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a NotificationHub GcmCredential.␊ - */␊ - export interface GcmCredentialProperties2 {␊ - /**␊ - * The GCM endpoint.␊ - */␊ - gcmEndpoint?: string␊ - /**␊ - * The Google API key.␊ - */␊ - googleApiKey?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a NotificationHub MpnsCredential.␊ - */␊ - export interface MpnsCredential2 {␊ - /**␊ - * Description of a NotificationHub MpnsCredential.␊ - */␊ - properties?: (MpnsCredentialProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a NotificationHub MpnsCredential.␊ - */␊ - export interface MpnsCredentialProperties2 {␊ - /**␊ - * The certificate key for this credential.␊ - */␊ - certificateKey?: string␊ - /**␊ - * The MPNS certificate.␊ - */␊ - mpnsCertificate?: string␊ - /**␊ - * The MPNS certificate Thumbprint␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a NotificationHub WnsCredential.␊ - */␊ - export interface WnsCredential2 {␊ - /**␊ - * Description of a NotificationHub WnsCredential.␊ - */␊ - properties?: (WnsCredentialProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a NotificationHub WnsCredential.␊ - */␊ - export interface WnsCredentialProperties2 {␊ - /**␊ - * The package ID for this credential.␊ - */␊ - packageSid?: string␊ - /**␊ - * The secret key.␊ - */␊ - secretKey?: string␊ - /**␊ - * The Windows Live endpoint.␊ - */␊ - windowsLiveEndpoint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.NotificationHubs/namespaces/AuthorizationRules␊ - */␊ - export interface Namespaces_AuthorizationRules1 {␊ - apiVersion: "2016-03-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * Authorization Rule Name.␊ - */␊ - name: string␊ - /**␊ - * SharedAccessAuthorizationRule properties.␊ - */␊ - properties: (SharedAccessAuthorizationRuleProperties2 | string)␊ - /**␊ - * The Sku description for a namespace␊ - */␊ - sku?: (Sku34 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.NotificationHubs/namespaces/AuthorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.NotificationHubs/namespaces/notificationHubs␊ - */␊ - export interface NamespacesNotificationHubs2 {␊ - apiVersion: "2016-03-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The notification hub name.␊ - */␊ - name: string␊ - /**␊ - * NotificationHub properties.␊ - */␊ - properties: (NotificationHubProperties2 | string)␊ - resources?: NamespacesNotificationHubs_AuthorizationRulesChildResource2[]␊ - /**␊ - * The Sku description for a namespace␊ - */␊ - sku?: (Sku34 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.NotificationHubs/namespaces/notificationHubs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.NotificationHubs/namespaces/notificationHubs/AuthorizationRules␊ - */␊ - export interface NamespacesNotificationHubs_AuthorizationRulesChildResource2 {␊ - apiVersion: "2016-03-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * Authorization Rule Name.␊ - */␊ - name: string␊ - /**␊ - * SharedAccessAuthorizationRule properties.␊ - */␊ - properties: (SharedAccessAuthorizationRuleProperties2 | string)␊ - /**␊ - * The Sku description for a namespace␊ - */␊ - sku?: (Sku34 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "AuthorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.NotificationHubs/namespaces/notificationHubs/AuthorizationRules␊ - */␊ - export interface NamespacesNotificationHubs_AuthorizationRules2 {␊ - apiVersion: "2016-03-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * Authorization Rule Name.␊ - */␊ - name: string␊ - /**␊ - * SharedAccessAuthorizationRule properties.␊ - */␊ - properties: (SharedAccessAuthorizationRuleProperties2 | string)␊ - /**␊ - * The Sku description for a namespace␊ - */␊ - sku?: (Sku34 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.NotificationHubs/namespaces/notificationHubs/AuthorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.NotificationHubs/namespaces␊ - */␊ - export interface Namespaces2 {␊ - apiVersion: "2017-04-01"␊ - /**␊ - * Resource location␊ - */␊ - location?: string␊ - /**␊ - * The namespace name.␊ - */␊ - name: string␊ - /**␊ - * Namespace properties.␊ - */␊ - properties: (NamespaceProperties2 | string)␊ - resources?: (Namespaces_AuthorizationRulesChildResource2 | NamespacesNotificationHubsChildResource2)[]␊ - /**␊ - * The Sku description for a namespace␊ - */␊ - sku?: (Sku10 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.NotificationHubs/namespaces"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Namespace properties.␊ - */␊ - export interface NamespaceProperties2 {␊ - /**␊ - * The time the namespace was created.␊ - */␊ - createdAt?: string␊ - /**␊ - * Whether or not the namespace is set as Critical.␊ - */␊ - critical?: (boolean | string)␊ - /**␊ - * Data center for the namespace␊ - */␊ - dataCenter?: string␊ - /**␊ - * Whether or not the namespace is currently enabled.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * The name of the namespace.␊ - */␊ - name?: string␊ - /**␊ - * The namespace type.␊ - */␊ - namespaceType?: (("Messaging" | "NotificationHub") | string)␊ - /**␊ - * Provisioning state of the Namespace.␊ - */␊ - provisioningState?: string␊ - /**␊ - * Specifies the targeted region in which the namespace should be created. It can be any of the following values: Australia East, Australia Southeast, Central US, East US, East US 2, West US, North Central US, South Central US, East Asia, Southeast Asia, Brazil South, Japan East, Japan West, North Europe, West Europe␊ - */␊ - region?: string␊ - /**␊ - * ScaleUnit where the namespace gets created␊ - */␊ - scaleUnit?: string␊ - /**␊ - * Endpoint you can use to perform NotificationHub operations.␊ - */␊ - serviceBusEndpoint?: string␊ - /**␊ - * Status of the namespace. It can be any of these values:1 = Created/Active2 = Creating3 = Suspended4 = Deleting␊ - */␊ - status?: string␊ - /**␊ - * The Id of the Azure subscription associated with the namespace.␊ - */␊ - subscriptionId?: string␊ - /**␊ - * The time the namespace was updated.␊ - */␊ - updatedAt?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.NotificationHubs/namespaces/AuthorizationRules␊ - */␊ - export interface Namespaces_AuthorizationRulesChildResource2 {␊ - apiVersion: "2017-04-01"␊ - /**␊ - * Authorization Rule Name.␊ - */␊ - name: string␊ - /**␊ - * SharedAccessAuthorizationRule properties.␊ - */␊ - properties: (SharedAccessAuthorizationRuleProperties | string)␊ - type: "AuthorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.NotificationHubs/namespaces/notificationHubs␊ - */␊ - export interface NamespacesNotificationHubsChildResource2 {␊ - apiVersion: "2017-04-01"␊ - /**␊ - * Resource location␊ - */␊ - location?: string␊ - /**␊ - * The notification hub name.␊ - */␊ - name: string␊ - /**␊ - * NotificationHub properties.␊ - */␊ - properties: (NotificationHubProperties | string)␊ - /**␊ - * The Sku description for a namespace␊ - */␊ - sku?: (Sku10 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "notificationHubs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.NotificationHubs/namespaces/AuthorizationRules␊ - */␊ - export interface Namespaces_AuthorizationRules2 {␊ - apiVersion: "2017-04-01"␊ - /**␊ - * Authorization Rule Name.␊ - */␊ - name: string␊ - /**␊ - * SharedAccessAuthorizationRule properties.␊ - */␊ - properties: (SharedAccessAuthorizationRuleProperties | string)␊ - type: "Microsoft.NotificationHubs/namespaces/AuthorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/disks␊ - */␊ - export interface Disks {␊ - apiVersion: "2016-04-30-preview"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters.␊ - */␊ - name: string␊ - /**␊ - * Disk resource properties.␊ - */␊ - properties: (DiskProperties1 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/disks"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Disk resource properties.␊ - */␊ - export interface DiskProperties1 {␊ - /**␊ - * the storage account type of the disk.␊ - */␊ - accountType?: (("Standard_LRS" | "Premium_LRS") | string)␊ - /**␊ - * Data used when creating a disk.␊ - */␊ - creationData: (CreationData | string)␊ - /**␊ - * If creationData.createOption is Empty, this field is mandatory and it indicates the size of the VHD to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size.␊ - */␊ - diskSizeGB?: (number | string)␊ - /**␊ - * Encryption settings for disk or snapshot␊ - */␊ - encryptionSettings?: (EncryptionSettings | string)␊ - /**␊ - * The Operating System type.␊ - */␊ - osType?: (("Windows" | "Linux") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Data used when creating a disk.␊ - */␊ - export interface CreationData {␊ - /**␊ - * This enumerates the possible sources of a disk's creation.␊ - */␊ - createOption: (("Empty" | "Attach" | "FromImage" | "Import" | "Copy" | "Restore") | string)␊ - /**␊ - * The source image used for creating the disk.␊ - */␊ - imageReference?: (ImageDiskReference | string)␊ - /**␊ - * If createOption is Copy, this is the ARM id of the source snapshot or disk. If createOption is Restore, this is the ARM-like id of the source disk restore point.␊ - */␊ - sourceResourceId?: string␊ - /**␊ - * If createOption is Import, this is a SAS URI to a blob to be imported into a managed disk. If createOption is Copy, this is a relative Uri containing the id of the source snapshot to be copied into a managed disk.␊ - */␊ - sourceUri?: string␊ - /**␊ - * If createOption is Import, the Azure Resource Manager identifier of the storage account containing the blob to import as a disk. Required only if the blob is in a different subscription␊ - */␊ - storageAccountId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The source image used for creating the disk.␊ - */␊ - export interface ImageDiskReference {␊ - /**␊ - * A relative uri containing either a Platform Image Repository or user image reference.␊ - */␊ - id: string␊ - /**␊ - * If the disk is created from an image's data disk, this is an index that indicates which of the data disks in the image to use. For OS disks, this field is null.␊ - */␊ - lun?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Encryption settings for disk or snapshot␊ - */␊ - export interface EncryptionSettings {␊ - /**␊ - * Key Vault Secret Url and vault id of the encryption key ␊ - */␊ - diskEncryptionKey?: (KeyVaultAndSecretReference | string)␊ - /**␊ - * Set this flag to true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable encryption. Set this flag to false and remove DiskEncryptionKey and KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the request object, the existing settings remain unchanged.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey␊ - */␊ - keyEncryptionKey?: (KeyVaultAndKeyReference | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Key Vault Secret Url and vault id of the encryption key ␊ - */␊ - export interface KeyVaultAndSecretReference {␊ - /**␊ - * Url pointing to a key or secret in KeyVault␊ - */␊ - secretUrl: string␊ - /**␊ - * The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}␊ - */␊ - sourceVault: (SourceVault | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}␊ - */␊ - export interface SourceVault {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey␊ - */␊ - export interface KeyVaultAndKeyReference {␊ - /**␊ - * Url pointing to a key or secret in KeyVault␊ - */␊ - keyUrl: string␊ - /**␊ - * The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}␊ - */␊ - sourceVault: (SourceVault | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/snapshots␊ - */␊ - export interface Snapshots {␊ - apiVersion: "2016-04-30-preview"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the snapshot within the given subscription and resource group.␊ - */␊ - name: string␊ - /**␊ - * Disk resource properties.␊ - */␊ - properties: (DiskProperties1 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/snapshots"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/images␊ - */␊ - export interface Images {␊ - apiVersion: "2016-04-30-preview"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the image.␊ - */␊ - name: string␊ - /**␊ - * Describes the properties of an Image.␊ - */␊ - properties: (ImageProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/images"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the properties of an Image.␊ - */␊ - export interface ImageProperties {␊ - sourceVirtualMachine?: (SubResource3 | string)␊ - /**␊ - * Describes a storage profile.␊ - */␊ - storageProfile?: (ImageStorageProfile | string)␊ - [k: string]: unknown␊ - }␊ - export interface SubResource3 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a storage profile.␊ - */␊ - export interface ImageStorageProfile {␊ - /**␊ - * 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).␊ - */␊ - dataDisks?: (ImageDataDisk[] | string)␊ - /**␊ - * Describes an Operating System disk.␊ - */␊ - osDisk: (ImageOSDisk | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a data disk.␊ - */␊ - export interface ImageDataDisk {␊ - /**␊ - * The Virtual Hard Disk.␊ - */␊ - blobUri?: string␊ - /**␊ - * Specifies the caching requirements.

Possible values are:

**None**

**ReadOnly**

**ReadWrite**

Default: **None for Standard storage. ReadOnly for Premium storage**.␊ - */␊ - caching?: (("None" | "ReadOnly" | "ReadWrite") | string)␊ - /**␊ - * 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␊ - */␊ - diskSizeGB?: (number | string)␊ - /**␊ - * 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.␊ - */␊ - lun: (number | string)␊ - managedDisk?: (SubResource3 | string)␊ - snapshot?: (SubResource3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes an Operating System disk.␊ - */␊ - export interface ImageOSDisk {␊ - /**␊ - * The Virtual Hard Disk.␊ - */␊ - blobUri?: string␊ - /**␊ - * Specifies the caching requirements.

Possible values are:

**None**

**ReadOnly**

**ReadWrite**

Default: **None for Standard storage. ReadOnly for Premium storage**.␊ - */␊ - caching?: (("None" | "ReadOnly" | "ReadWrite") | string)␊ - /**␊ - * 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␊ - */␊ - diskSizeGB?: (number | string)␊ - managedDisk?: (SubResource3 | string)␊ - /**␊ - * The OS State.␊ - */␊ - osState: (("Generalized" | "Specialized") | string)␊ - /**␊ - * 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**.␊ - */␊ - osType: (("Windows" | "Linux") | string)␊ - snapshot?: (SubResource3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/availabilitySets␊ - */␊ - export interface AvailabilitySets1 {␊ - apiVersion: "2016-04-30-preview"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the availability set.␊ - */␊ - name: string␊ - /**␊ - * The instance view of a resource.␊ - */␊ - properties: (AvailabilitySetProperties | string)␊ - /**␊ - * Describes a virtual machine scale set sku.␊ - */␊ - sku?: (Sku35 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/availabilitySets"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The instance view of a resource.␊ - */␊ - export interface AvailabilitySetProperties {␊ - /**␊ - * If the availability set supports managed disks.␊ - */␊ - managed?: (boolean | string)␊ - /**␊ - * Fault Domain count.␊ - */␊ - platformFaultDomainCount?: (number | string)␊ - /**␊ - * Update Domain count.␊ - */␊ - platformUpdateDomainCount?: (number | string)␊ - /**␊ - * A list of references to all virtual machines in the availability set.␊ - */␊ - virtualMachines?: (SubResource3[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set sku.␊ - */␊ - export interface Sku35 {␊ - /**␊ - * Specifies the number of virtual machines in the scale set.␊ - */␊ - capacity?: (number | string)␊ - /**␊ - * The sku name.␊ - */␊ - name?: string␊ - /**␊ - * Specifies the tier of virtual machines in a scale set.

Possible Values:

**Standard**

**Basic**␊ - */␊ - tier?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/virtualMachines␊ - */␊ - export interface VirtualMachines2 {␊ - apiVersion: "2016-04-30-preview"␊ - /**␊ - * Identity for the virtual machine.␊ - */␊ - identity?: (VirtualMachineIdentity | string)␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the virtual machine.␊ - */␊ - name: string␊ - /**␊ - * 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**.␊ - */␊ - plan?: (Plan1 | string)␊ - /**␊ - * Describes the properties of a Virtual Machine.␊ - */␊ - properties: (VirtualMachineProperties3 | string)␊ - resources?: VirtualMachinesExtensionsChildResource[]␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/virtualMachines"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the virtual machine.␊ - */␊ - export interface VirtualMachineIdentity {␊ - /**␊ - * The type of identity used for the virtual machine. Currently, the only supported type is 'SystemAssigned', which implicitly creates an identity.␊ - */␊ - type?: ("SystemAssigned" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * 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**.␊ - */␊ - export interface Plan1 {␊ - /**␊ - * The plan ID.␊ - */␊ - name?: string␊ - /**␊ - * Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.␊ - */␊ - product?: string␊ - /**␊ - * The promotion code.␊ - */␊ - promotionCode?: string␊ - /**␊ - * The publisher ID.␊ - */␊ - publisher?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the properties of a Virtual Machine.␊ - */␊ - export interface VirtualMachineProperties3 {␊ - availabilitySet?: (SubResource3 | string)␊ - /**␊ - * Specifies the boot diagnostic settings state.

Minimum api-version: 2015-06-15.␊ - */␊ - diagnosticsProfile?: (DiagnosticsProfile | string)␊ - /**␊ - * Specifies the hardware settings for the virtual machine.␊ - */␊ - hardwareProfile?: (HardwareProfile1 | string)␊ - /**␊ - * 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␊ - */␊ - licenseType?: string␊ - /**␊ - * Specifies the network interfaces of the virtual machine.␊ - */␊ - networkProfile?: (NetworkProfile1 | string)␊ - /**␊ - * Specifies the operating system settings for the virtual machine.␊ - */␊ - osProfile?: (OSProfile | string)␊ - /**␊ - * Specifies the storage settings for the virtual machine disks.␊ - */␊ - storageProfile?: (StorageProfile1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the boot diagnostic settings state.

Minimum api-version: 2015-06-15.␊ - */␊ - export interface DiagnosticsProfile {␊ - /**␊ - * Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

You can easily view the output of your console log.

Azure also enables you to see a screenshot of the VM from the hypervisor.␊ - */␊ - bootDiagnostics?: (BootDiagnostics | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

You can easily view the output of your console log.

Azure also enables you to see a screenshot of the VM from the hypervisor.␊ - */␊ - export interface BootDiagnostics {␊ - /**␊ - * Whether boot diagnostics should be enabled on the Virtual Machine.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Uri of the storage account to use for placing the console output and screenshot.␊ - */␊ - storageUri?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the hardware settings for the virtual machine.␊ - */␊ - export interface HardwareProfile1 {␊ - /**␊ - * 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).␊ - */␊ - vmSize?: (("Basic_A0" | "Basic_A1" | "Basic_A2" | "Basic_A3" | "Basic_A4" | "Standard_A0" | "Standard_A1" | "Standard_A2" | "Standard_A3" | "Standard_A4" | "Standard_A5" | "Standard_A6" | "Standard_A7" | "Standard_A8" | "Standard_A9" | "Standard_A10" | "Standard_A11" | "Standard_D1" | "Standard_D2" | "Standard_D3" | "Standard_D4" | "Standard_D11" | "Standard_D12" | "Standard_D13" | "Standard_D14" | "Standard_D1_v2" | "Standard_D2_v2" | "Standard_D3_v2" | "Standard_D4_v2" | "Standard_D5_v2" | "Standard_D11_v2" | "Standard_D12_v2" | "Standard_D13_v2" | "Standard_D14_v2" | "Standard_D15_v2" | "Standard_DS1" | "Standard_DS2" | "Standard_DS3" | "Standard_DS4" | "Standard_DS11" | "Standard_DS12" | "Standard_DS13" | "Standard_DS14" | "Standard_DS1_v2" | "Standard_DS2_v2" | "Standard_DS3_v2" | "Standard_DS4_v2" | "Standard_DS5_v2" | "Standard_DS11_v2" | "Standard_DS12_v2" | "Standard_DS13_v2" | "Standard_DS14_v2" | "Standard_DS15_v2" | "Standard_G1" | "Standard_G2" | "Standard_G3" | "Standard_G4" | "Standard_G5" | "Standard_GS1" | "Standard_GS2" | "Standard_GS3" | "Standard_GS4" | "Standard_GS5") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the network interfaces of the virtual machine.␊ - */␊ - export interface NetworkProfile1 {␊ - /**␊ - * Specifies the list of resource Ids for the network interfaces associated with the virtual machine.␊ - */␊ - networkInterfaces?: (NetworkInterfaceReference[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a network interface reference.␊ - */␊ - export interface NetworkInterfaceReference {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Describes a network interface reference properties.␊ - */␊ - properties?: (NetworkInterfaceReferenceProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a network interface reference properties.␊ - */␊ - export interface NetworkInterfaceReferenceProperties {␊ - /**␊ - * Specifies the primary network interface in case the virtual machine has more than 1 network interface.␊ - */␊ - primary?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the operating system settings for the virtual machine.␊ - */␊ - export interface OSProfile {␊ - /**␊ - * 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)␊ - */␊ - adminPassword?: string␊ - /**␊ - * 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)␊ - */␊ - adminUsername?: string␊ - /**␊ - * Specifies the host OS name of the virtual machine.

    This name cannot be updated after the VM is created.

    **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).␊ - */␊ - computerName?: string␊ - /**␊ - * 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)␊ - */␊ - customData?: string␊ - /**␊ - * 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).␊ - */␊ - linuxConfiguration?: (LinuxConfiguration1 | string)␊ - /**␊ - * Specifies set of certificates that should be installed onto the virtual machine.␊ - */␊ - secrets?: (VaultSecretGroup[] | string)␊ - /**␊ - * Specifies Windows operating system settings on the virtual machine.␊ - */␊ - windowsConfiguration?: (WindowsConfiguration2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * 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).␊ - */␊ - export interface LinuxConfiguration1 {␊ - /**␊ - * Specifies whether password authentication should be disabled.␊ - */␊ - disablePasswordAuthentication?: (boolean | string)␊ - /**␊ - * SSH configuration for Linux based VMs running on Azure␊ - */␊ - ssh?: (SshConfiguration | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSH configuration for Linux based VMs running on Azure␊ - */␊ - export interface SshConfiguration {␊ - /**␊ - * The list of SSH public keys used to authenticate with linux based VMs.␊ - */␊ - publicKeys?: (SshPublicKey[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed.␊ - */␊ - export interface SshPublicKey {␊ - /**␊ - * 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).␊ - */␊ - keyData?: string␊ - /**␊ - * 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␊ - */␊ - path?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a set of certificates which are all in the same Key Vault.␊ - */␊ - export interface VaultSecretGroup {␊ - sourceVault?: (SubResource3 | string)␊ - /**␊ - * The list of key vault references in SourceVault which contain certificates.␊ - */␊ - vaultCertificates?: (VaultCertificate[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM.␊ - */␊ - export interface VaultCertificate {␊ - /**␊ - * 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.␊ - */␊ - certificateStore?: string␊ - /**␊ - * 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":""
    }␊ - */␊ - certificateUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies Windows operating system settings on the virtual machine.␊ - */␊ - export interface WindowsConfiguration2 {␊ - /**␊ - * Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup.␊ - */␊ - additionalUnattendContent?: (AdditionalUnattendContent1[] | string)␊ - /**␊ - * Indicates whether virtual machine is enabled for automatic updates.␊ - */␊ - enableAutomaticUpdates?: (boolean | string)␊ - /**␊ - * 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.␊ - */␊ - provisionVMAgent?: (boolean | string)␊ - /**␊ - * Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time"␊ - */␊ - timeZone?: string␊ - /**␊ - * Describes Windows Remote Management configuration of the VM␊ - */␊ - winRM?: (WinRMConfiguration | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * 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.␊ - */␊ - export interface AdditionalUnattendContent1 {␊ - /**␊ - * The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup.␊ - */␊ - componentName?: ("Microsoft-Windows-Shell-Setup" | string)␊ - /**␊ - * 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.␊ - */␊ - content?: string␊ - /**␊ - * The pass name. Currently, the only allowable value is OobeSystem.␊ - */␊ - passName?: ("OobeSystem" | string)␊ - /**␊ - * Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.␊ - */␊ - settingName?: (("AutoLogon" | "FirstLogonCommands") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes Windows Remote Management configuration of the VM␊ - */␊ - export interface WinRMConfiguration {␊ - /**␊ - * The list of Windows Remote Management listeners␊ - */␊ - listeners?: (WinRMListener1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes Protocol and thumbprint of Windows Remote Management listener␊ - */␊ - export interface WinRMListener1 {␊ - /**␊ - * 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":""
    }␊ - */␊ - certificateUrl?: string␊ - /**␊ - * Specifies the protocol of listener.

    Possible values are:
    **http**

    **https**.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the storage settings for the virtual machine disks.␊ - */␊ - export interface StorageProfile1 {␊ - /**␊ - * 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).␊ - */␊ - dataDisks?: (DataDisk2[] | string)␊ - /**␊ - * 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.␊ - */␊ - imageReference?: (ImageReference2 | string)␊ - /**␊ - * 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).␊ - */␊ - osDisk?: (OSDisk1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a data disk.␊ - */␊ - export interface DataDisk2 {␊ - /**␊ - * Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**.␊ - */␊ - caching?: (("None" | "ReadOnly" | "ReadWrite") | string)␊ - /**␊ - * 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.␊ - */␊ - createOption: (("FromImage" | "Empty" | "Attach") | string)␊ - /**␊ - * Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB␊ - */␊ - diskSizeGB?: (number | string)␊ - /**␊ - * Describes the uri of a disk.␊ - */␊ - image?: (VirtualHardDisk | string)␊ - /**␊ - * 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.␊ - */␊ - lun: (number | string)␊ - /**␊ - * The parameters of a managed disk.␊ - */␊ - managedDisk?: (ManagedDiskParameters | string)␊ - /**␊ - * The disk name.␊ - */␊ - name?: string␊ - /**␊ - * Describes the uri of a disk.␊ - */␊ - vhd?: (VirtualHardDisk | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the uri of a disk.␊ - */␊ - export interface VirtualHardDisk {␊ - /**␊ - * Specifies the virtual hard disk's uri.␊ - */␊ - uri?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The parameters of a managed disk.␊ - */␊ - export interface ManagedDiskParameters {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS.␊ - */␊ - storageAccountType?: (("Standard_LRS" | "Premium_LRS") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * 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.␊ - */␊ - export interface ImageReference2 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Specifies the offer of the platform image or marketplace image used to create the virtual machine.␊ - */␊ - offer?: string␊ - /**␊ - * The image publisher.␊ - */␊ - publisher?: string␊ - /**␊ - * The image SKU.␊ - */␊ - sku?: string␊ - /**␊ - * 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.␊ - */␊ - version?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * 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).␊ - */␊ - export interface OSDisk1 {␊ - /**␊ - * Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**.␊ - */␊ - caching?: (("None" | "ReadOnly" | "ReadWrite") | string)␊ - /**␊ - * 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.␊ - */␊ - createOption: (("FromImage" | "Empty" | "Attach") | string)␊ - /**␊ - * Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB␊ - */␊ - diskSizeGB?: (number | string)␊ - /**␊ - * Describes a Encryption Settings for a Disk␊ - */␊ - encryptionSettings?: (DiskEncryptionSettings | string)␊ - /**␊ - * Describes the uri of a disk.␊ - */␊ - image?: (VirtualHardDisk | string)␊ - /**␊ - * The parameters of a managed disk.␊ - */␊ - managedDisk?: (ManagedDiskParameters | string)␊ - /**␊ - * The disk name.␊ - */␊ - name?: string␊ - /**␊ - * 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**.␊ - */␊ - osType?: (("Windows" | "Linux") | string)␊ - /**␊ - * Describes the uri of a disk.␊ - */␊ - vhd?: (VirtualHardDisk | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a Encryption Settings for a Disk␊ - */␊ - export interface DiskEncryptionSettings {␊ - /**␊ - * Describes a reference to Key Vault Secret␊ - */␊ - diskEncryptionKey?: (KeyVaultSecretReference | string)␊ - /**␊ - * Specifies whether disk encryption should be enabled on the virtual machine.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Describes a reference to Key Vault Key␊ - */␊ - keyEncryptionKey?: (KeyVaultKeyReference | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a reference to Key Vault Secret␊ - */␊ - export interface KeyVaultSecretReference {␊ - /**␊ - * The URL referencing a secret in a Key Vault.␊ - */␊ - secretUrl: string␊ - sourceVault: (SubResource3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a reference to Key Vault Key␊ - */␊ - export interface KeyVaultKeyReference {␊ - /**␊ - * The URL referencing a key encryption key in Key Vault.␊ - */␊ - keyUrl: string␊ - sourceVault: (SubResource3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/virtualMachines/extensions␊ - */␊ - export interface VirtualMachinesExtensionsChildResource {␊ - apiVersion: "2016-04-30-preview"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the virtual machine extension.␊ - */␊ - name: string␊ - properties: (GenericExtension1 | IaaSDiagnostics1 | IaaSAntimalware1 | CustomScriptExtension1 | CustomScriptForLinux1 | LinuxDiagnostic1 | VmAccessForLinux1 | BgInfo1 | VmAccessAgent1 | DscExtension1 | AcronisBackupLinux1 | AcronisBackup1 | LinuxChefClient1 | ChefClient1 | DatadogLinuxAgent1 | DatadogWindowsAgent1 | DockerExtension1 | DynatraceLinux1 | DynatraceWindows1 | Eset1 | HpeSecurityApplicationDefender1 | PuppetAgent1 | Site24X7LinuxServerExtn1 | Site24X7WindowsServerExtn1 | Site24X7ApmInsightExtn1 | TrendMicroDSALinux1 | TrendMicroDSA1 | BmcCtmAgentLinux1 | BmcCtmAgentWindows1 | OSPatchingForLinux1 | VMSnapshot1 | VMSnapshotLinux1 | CustomScript1 | NetworkWatcherAgentWindows1 | NetworkWatcherAgentLinux1)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "extensions"␊ - [k: string]: unknown␊ - }␊ - export interface GenericExtension1 {␊ - /**␊ - * Microsoft.Compute/extensions - Publisher␊ - */␊ - publisher: string␊ - /**␊ - * Microsoft.Compute/extensions - Type␊ - */␊ - type: string␊ - /**␊ - * Microsoft.Compute/extensions - Type handler version␊ - */␊ - typeHandlerVersion: string␊ - /**␊ - * Microsoft.Compute/extensions - Settings␊ - */␊ - settings: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - export interface IaaSDiagnostics1 {␊ - publisher: "Microsoft.Azure.Diagnostics"␊ - type: "IaaSDiagnostics"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - xmlCfg: string␊ - StorageAccount: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - storageAccountName: string␊ - storageAccountKey: string␊ - storageAccountEndPoint: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface IaaSAntimalware1 {␊ - publisher: "Microsoft.Azure.Security"␊ - type: "IaaSAntimalware"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - AntimalwareEnabled: boolean␊ - Exclusions: {␊ - Paths: string␊ - Extensions: string␊ - Processes: string␊ - [k: string]: unknown␊ - }␊ - RealtimeProtectionEnabled: ("true" | "false")␊ - ScheduledScanSettings: {␊ - isEnabled: ("true" | "false")␊ - scanType: string␊ - day: string␊ - time: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface CustomScriptExtension1 {␊ - publisher: "Microsoft.Compute"␊ - type: "CustomScriptExtension"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - fileUris?: string[]␊ - commandToExecute: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - storageAccountName?: string␊ - storageAccountKey?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface CustomScriptForLinux1 {␊ - publisher: "Microsoft.OSTCExtensions"␊ - type: "CustomScriptForLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - fileUris?: string[]␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - commandToExecute: string␊ - storageAccountName?: string␊ - storageAccountKey?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface LinuxDiagnostic1 {␊ - publisher: "Microsoft.OSTCExtensions"␊ - type: "LinuxDiagnostic"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - enableSyslog?: string␊ - mdsdHttpProxy?: string␊ - perCfg?: unknown[]␊ - fileCfg?: unknown[]␊ - xmlCfg?: string␊ - ladCfg?: {␊ - [k: string]: unknown␊ - }␊ - syslogCfg?: string␊ - eventVolume?: string␊ - mdsdCfg?: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - mdsdHttpProxy?: string␊ - storageAccountName: string␊ - storageAccountKey: string␊ - storageAccountEndPoint?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface VmAccessForLinux1 {␊ - publisher: "Microsoft.OSTCExtensions"␊ - type: "VMAccessForLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - check_disk?: boolean␊ - repair_disk?: boolean␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - username: string␊ - password: string␊ - ssh_key: string␊ - reset_ssh: string␊ - remove_user: string␊ - expiration: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface BgInfo1 {␊ - publisher: "Microsoft.Compute"␊ - type: "bginfo"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - [k: string]: unknown␊ - }␊ - export interface VmAccessAgent1 {␊ - publisher: "Microsoft.Compute"␊ - type: "VMAccessAgent"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - username?: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - password?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface DscExtension1 {␊ - publisher: "Microsoft.Powershell"␊ - type: "DSC"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - modulesUrl: string␊ - configurationFunction: string␊ - properties?: string␊ - wmfVersion?: string␊ - privacy?: {␊ - dataCollection?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - dataBlobUri?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface AcronisBackupLinux1 {␊ - publisher: "Acronis.Backup"␊ - type: "AcronisBackupLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - absURL: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - userLogin: string␊ - userPassword: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface AcronisBackup1 {␊ - publisher: "Acronis.Backup"␊ - type: "AcronisBackup"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - absURL: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - userLogin: string␊ - userPassword: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface LinuxChefClient1 {␊ - publisher: "Chef.Bootstrap.WindowsAzure"␊ - type: "LinuxChefClient"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - bootstrap_version?: string␊ - bootstrap_options?: {␊ - chef_node_name: string␊ - chef_server_url: string␊ - validation_client_name: string␊ - node_ssl_verify_mode: string␊ - environment: string␊ - [k: string]: unknown␊ - }␊ - runlist?: string␊ - client_rb?: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - validation_key: string␊ - chef_server_crt: string␊ - secret: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface ChefClient1 {␊ - publisher: "Chef.Bootstrap.WindowsAzure"␊ - type: "ChefClient"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - bootstrap_options?: {␊ - chef_node_name: string␊ - chef_server_url: string␊ - validation_client_name: string␊ - node_ssl_verify_mode: string␊ - environment: string␊ - [k: string]: unknown␊ - }␊ - runlist?: string␊ - client_rb?: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - validation_key: string␊ - chef_server_crt: string␊ - secret: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface DatadogLinuxAgent1 {␊ - publisher: "Datadog.Agent"␊ - type: "DatadogLinuxAgent"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - api_key: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface DatadogWindowsAgent1 {␊ - publisher: "Datadog.Agent"␊ - type: "DatadogWindowsAgent"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - api_key: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface DockerExtension1 {␊ - publisher: "Microsoft.Azure.Extensions"␊ - type: "DockerExtension"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - docker: {␊ - port: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - certs: {␊ - ca: string␊ - cert: string␊ - key: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface DynatraceLinux1 {␊ - publisher: "dynatrace.ruxit"␊ - type: "ruxitAgentLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - tenantId: string␊ - token: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface DynatraceWindows1 {␊ - publisher: "dynatrace.ruxit"␊ - type: "ruxitAgentWindows"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - tenantId: string␊ - token: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Eset1 {␊ - publisher: "ESET"␊ - type: "FileSecurity"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - LicenseKey: string␊ - "Install-RealtimeProtection": boolean␊ - "Install-ProtocolFiltering": boolean␊ - "Install-DeviceControl": boolean␊ - "Enable-Cloud": boolean␊ - "Enable-PUA": boolean␊ - ERAAgentCfgUrl: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface HpeSecurityApplicationDefender1 {␊ - publisher: "HPE.Security.ApplicationDefender"␊ - type: "DotnetAgent"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - protectedSettings: {␊ - key: string␊ - serverURL: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface PuppetAgent1 {␊ - publisher: "Puppet"␊ - type: "PuppetAgent"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - protectedSettings: {␊ - PUPPET_MASTER_SERVER: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Site24X7LinuxServerExtn1 {␊ - publisher: "Site24x7"␊ - type: "Site24x7LinuxServerExtn"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - site24x7AgentType?: "azurevmextnlinuxserver"␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - site24x7LicenseKey: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Site24X7WindowsServerExtn1 {␊ - publisher: "Site24x7"␊ - type: "Site24x7WindowsServerExtn"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - site24x7AgentType?: "azurevmextnwindowsserver"␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - site24x7LicenseKey: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Site24X7ApmInsightExtn1 {␊ - publisher: "Site24x7"␊ - type: "Site24x7ApmInsightExtn"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - site24x7AgentType?: "azurevmextnapminsightclassic"␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - site24x7LicenseKey: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface TrendMicroDSALinux1 {␊ - publisher: "TrendMicro.DeepSecurity"␊ - type: "TrendMicroDSALinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - DSMname: string␊ - DSMport: string␊ - policyNameorID?: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - tenantID: string␊ - tenantPassword: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface TrendMicroDSA1 {␊ - publisher: "TrendMicro.DeepSecurity"␊ - type: "TrendMicroDSA"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - DSMname: string␊ - DSMport: string␊ - policyNameorID?: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - tenantID: string␊ - tenantPassword: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface BmcCtmAgentLinux1 {␊ - publisher: "ctm.bmc.com"␊ - type: "BmcCtmAgentLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - "Control-M Server Name": string␊ - "Agent Port": string␊ - "Host Group": string␊ - "User Account": string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface BmcCtmAgentWindows1 {␊ - publisher: "bmc.ctm"␊ - type: "AgentWinExt"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - "Control-M Server Name": string␊ - "Agent Port": string␊ - "Host Group": string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface OSPatchingForLinux1 {␊ - publisher: "Microsoft.OSTCExtensions"␊ - type: "OSPatchingForLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - disabled: boolean␊ - stop: boolean␊ - installDuration?: string␊ - intervalOfWeeks?: number␊ - dayOfWeek?: string␊ - startTime?: string␊ - rebootAfterPatch?: string␊ - category?: string␊ - oneoff?: boolean␊ - local?: boolean␊ - idleTestScript?: string␊ - healthyTestScript?: string␊ - distUpgradeList?: string␊ - distUpgradeAll?: boolean␊ - vmStatusTest?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - storageAccountName?: string␊ - storageAccountKey?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface VMSnapshot1 {␊ - publisher: "Microsoft.Azure.RecoveryServices"␊ - type: "VMSnapshot"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - locale: string␊ - taskId: string␊ - commandToExecute: string␊ - objectStr: string␊ - logsBlobUri: string␊ - statusBlobUri: string␊ - commandStartTimeUTCTicks: string␊ - vmType: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface VMSnapshotLinux1 {␊ - publisher: "Microsoft.Azure.RecoveryServices"␊ - type: "VMSnapshotLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - locale: string␊ - taskId: string␊ - commandToExecute: string␊ - objectStr: string␊ - logsBlobUri: string␊ - statusBlobUri: string␊ - commandStartTimeUTCTicks: string␊ - vmType: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface CustomScript1 {␊ - publisher: "Microsoft.Azure.Extensions"␊ - type: "CustomScript"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - fileUris: string[]␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - storageAccountName: string␊ - storageAccountKey: string␊ - commandToExecute: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface NetworkWatcherAgentWindows1 {␊ - publisher: "Microsoft.Azure.NetworkWatcher"␊ - type: "NetworkWatcherAgentWindows"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - [k: string]: unknown␊ - }␊ - export interface NetworkWatcherAgentLinux1 {␊ - publisher: "Microsoft.Azure.NetworkWatcher"␊ - type: "NetworkWatcherAgentLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/virtualMachineScaleSets␊ - */␊ - export interface VirtualMachineScaleSets1 {␊ - apiVersion: "2016-04-30-preview"␊ - /**␊ - * Identity for the virtual machine scale set.␊ - */␊ - identity?: (VirtualMachineScaleSetIdentity | string)␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the VM scale set to create or update.␊ - */␊ - name: string␊ - /**␊ - * 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**.␊ - */␊ - plan?: (Plan1 | string)␊ - /**␊ - * Describes the properties of a Virtual Machine Scale Set.␊ - */␊ - properties: (VirtualMachineScaleSetProperties | string)␊ - /**␊ - * Describes a virtual machine scale set sku.␊ - */␊ - sku?: (Sku35 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/virtualMachineScaleSets"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the virtual machine scale set.␊ - */␊ - export interface VirtualMachineScaleSetIdentity {␊ - /**␊ - * The type of identity used for the virtual machine scale set. Currently, the only supported type is 'SystemAssigned', which implicitly creates an identity.␊ - */␊ - type?: ("SystemAssigned" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the properties of a Virtual Machine Scale Set.␊ - */␊ - export interface VirtualMachineScaleSetProperties {␊ - /**␊ - * Specifies whether the Virtual Machine Scale Set should be overprovisioned.␊ - */␊ - overProvision?: (boolean | string)␊ - /**␊ - * When true this limits the scale set to a single placement group, of max size 100 virtual machines.␊ - */␊ - singlePlacementGroup?: (boolean | string)␊ - /**␊ - * Describes an upgrade policy - automatic or manual.␊ - */␊ - upgradePolicy?: (UpgradePolicy1 | string)␊ - /**␊ - * Describes a virtual machine scale set virtual machine profile.␊ - */␊ - virtualMachineProfile?: (VirtualMachineScaleSetVMProfile | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes an upgrade policy - automatic or manual.␊ - */␊ - export interface UpgradePolicy1 {␊ - /**␊ - * 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.␊ - */␊ - mode?: (("Automatic" | "Manual") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set virtual machine profile.␊ - */␊ - export interface VirtualMachineScaleSetVMProfile {␊ - /**␊ - * Describes a virtual machine scale set extension profile.␊ - */␊ - extensionProfile?: (VirtualMachineScaleSetExtensionProfile1 | string)␊ - /**␊ - * Describes a virtual machine scale set network profile.␊ - */␊ - networkProfile?: (VirtualMachineScaleSetNetworkProfile1 | string)␊ - /**␊ - * Describes a virtual machine scale set OS profile.␊ - */␊ - osProfile?: (VirtualMachineScaleSetOSProfile | string)␊ - /**␊ - * Describes a virtual machine scale set storage profile.␊ - */␊ - storageProfile?: (VirtualMachineScaleSetStorageProfile1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set extension profile.␊ - */␊ - export interface VirtualMachineScaleSetExtensionProfile1 {␊ - /**␊ - * The virtual machine scale set child extension resources.␊ - */␊ - extensions?: (VirtualMachineScaleSetExtension1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a Virtual Machine Scale Set Extension.␊ - */␊ - export interface VirtualMachineScaleSetExtension1 {␊ - /**␊ - * The name of the extension.␊ - */␊ - name?: string␊ - properties?: (GenericExtension1 | IaaSDiagnostics1 | IaaSAntimalware1 | CustomScriptExtension1 | CustomScriptForLinux1 | LinuxDiagnostic1 | VmAccessForLinux1 | BgInfo1 | VmAccessAgent1 | DscExtension1 | AcronisBackupLinux1 | AcronisBackup1 | LinuxChefClient1 | ChefClient1 | DatadogLinuxAgent1 | DatadogWindowsAgent1 | DockerExtension1 | DynatraceLinux1 | DynatraceWindows1 | Eset1 | HpeSecurityApplicationDefender1 | PuppetAgent1 | Site24X7LinuxServerExtn1 | Site24X7WindowsServerExtn1 | Site24X7ApmInsightExtn1 | TrendMicroDSALinux1 | TrendMicroDSA1 | BmcCtmAgentLinux1 | BmcCtmAgentWindows1 | OSPatchingForLinux1 | VMSnapshot1 | VMSnapshotLinux1 | CustomScript1 | NetworkWatcherAgentWindows1 | NetworkWatcherAgentLinux1)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set network profile.␊ - */␊ - export interface VirtualMachineScaleSetNetworkProfile1 {␊ - /**␊ - * The list of network configurations.␊ - */␊ - networkInterfaceConfigurations?: (VirtualMachineScaleSetNetworkConfiguration[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set network profile's network configurations.␊ - */␊ - export interface VirtualMachineScaleSetNetworkConfiguration {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * The network configuration name.␊ - */␊ - name: string␊ - /**␊ - * Describes a virtual machine scale set network profile's IP configuration.␊ - */␊ - properties?: (VirtualMachineScaleSetNetworkConfigurationProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set network profile's IP configuration.␊ - */␊ - export interface VirtualMachineScaleSetNetworkConfigurationProperties {␊ - /**␊ - * The virtual machine scale set IP Configuration.␊ - */␊ - ipConfigurations: (VirtualMachineScaleSetIPConfiguration[] | string)␊ - /**␊ - * Whether this is a primary NIC on a virtual machine.␊ - */␊ - primary?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set network profile's IP configuration.␊ - */␊ - export interface VirtualMachineScaleSetIPConfiguration {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * The IP configuration name.␊ - */␊ - name: string␊ - /**␊ - * Describes a virtual machine scale set network profile's IP configuration properties.␊ - */␊ - properties?: (VirtualMachineScaleSetIPConfigurationProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set network profile's IP configuration properties.␊ - */␊ - export interface VirtualMachineScaleSetIPConfigurationProperties {␊ - /**␊ - * The application gateway backend address pools.␊ - */␊ - applicationGatewayBackendAddressPools?: (SubResource3[] | string)␊ - /**␊ - * The load balancer backend address pools.␊ - */␊ - loadBalancerBackendAddressPools?: (SubResource3[] | string)␊ - /**␊ - * The load balancer inbound nat pools.␊ - */␊ - loadBalancerInboundNatPools?: (SubResource3[] | string)␊ - /**␊ - * The API entity reference.␊ - */␊ - subnet: (ApiEntityReference | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The API entity reference.␊ - */␊ - export interface ApiEntityReference {␊ - /**␊ - * The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set OS profile.␊ - */␊ - export interface VirtualMachineScaleSetOSProfile {␊ - /**␊ - * 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)␊ - */␊ - adminPassword?: string␊ - /**␊ - * 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)␊ - */␊ - adminUsername?: string␊ - /**␊ - * 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.␊ - */␊ - computerNamePrefix?: string␊ - /**␊ - * A base-64 encoded string of custom data.␊ - */␊ - customData?: string␊ - /**␊ - * 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).␊ - */␊ - linuxConfiguration?: (LinuxConfiguration1 | string)␊ - /**␊ - * The List of certificates for addition to the VM.␊ - */␊ - secrets?: (VaultSecretGroup[] | string)␊ - /**␊ - * Specifies Windows operating system settings on the virtual machine.␊ - */␊ - windowsConfiguration?: (WindowsConfiguration2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set storage profile.␊ - */␊ - export interface VirtualMachineScaleSetStorageProfile1 {␊ - /**␊ - * The data disks.␊ - */␊ - dataDisks?: (VirtualMachineScaleSetDataDisk[] | string)␊ - /**␊ - * 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.␊ - */␊ - imageReference?: (ImageReference2 | string)␊ - /**␊ - * Describes a virtual machine scale set operating system disk.␊ - */␊ - osDisk?: (VirtualMachineScaleSetOSDisk1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set data disk.␊ - */␊ - export interface VirtualMachineScaleSetDataDisk {␊ - /**␊ - * Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**.␊ - */␊ - caching?: (("None" | "ReadOnly" | "ReadWrite") | string)␊ - /**␊ - * The create option.␊ - */␊ - createOption: (("FromImage" | "Empty" | "Attach") | string)␊ - /**␊ - * Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB␊ - */␊ - diskSizeGB?: (number | string)␊ - /**␊ - * 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.␊ - */␊ - lun: (number | string)␊ - /**␊ - * Describes the parameters of a ScaleSet managed disk.␊ - */␊ - managedDisk?: (VirtualMachineScaleSetManagedDiskParameters | string)␊ - /**␊ - * The disk name.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the parameters of a ScaleSet managed disk.␊ - */␊ - export interface VirtualMachineScaleSetManagedDiskParameters {␊ - /**␊ - * Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS.␊ - */␊ - storageAccountType?: (("Standard_LRS" | "Premium_LRS") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set operating system disk.␊ - */␊ - export interface VirtualMachineScaleSetOSDisk1 {␊ - /**␊ - * Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**.␊ - */␊ - caching?: (("None" | "ReadOnly" | "ReadWrite") | string)␊ - /**␊ - * 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.␊ - */␊ - createOption: (("FromImage" | "Empty" | "Attach") | string)␊ - /**␊ - * Describes the uri of a disk.␊ - */␊ - image?: (VirtualHardDisk | string)␊ - /**␊ - * Describes the parameters of a ScaleSet managed disk.␊ - */␊ - managedDisk?: (VirtualMachineScaleSetManagedDiskParameters | string)␊ - /**␊ - * The disk name.␊ - */␊ - name?: string␊ - /**␊ - * 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**.␊ - */␊ - osType?: (("Windows" | "Linux") | string)␊ - /**␊ - * The list of virtual hard disk container uris.␊ - */␊ - vhdContainers?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/virtualMachines/extensions␊ - */␊ - export interface VirtualMachinesExtensions {␊ - apiVersion: "2016-04-30-preview"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the virtual machine extension.␊ - */␊ - name: string␊ - properties: (GenericExtension1 | IaaSDiagnostics1 | IaaSAntimalware1 | CustomScriptExtension1 | CustomScriptForLinux1 | LinuxDiagnostic1 | VmAccessForLinux1 | BgInfo1 | VmAccessAgent1 | DscExtension1 | AcronisBackupLinux1 | AcronisBackup1 | LinuxChefClient1 | ChefClient1 | DatadogLinuxAgent1 | DatadogWindowsAgent1 | DockerExtension1 | DynatraceLinux1 | DynatraceWindows1 | Eset1 | HpeSecurityApplicationDefender1 | PuppetAgent1 | Site24X7LinuxServerExtn1 | Site24X7WindowsServerExtn1 | Site24X7ApmInsightExtn1 | TrendMicroDSALinux1 | TrendMicroDSA1 | BmcCtmAgentLinux1 | BmcCtmAgentWindows1 | OSPatchingForLinux1 | VMSnapshot1 | VMSnapshotLinux1 | CustomScript1 | NetworkWatcherAgentWindows1 | NetworkWatcherAgentLinux1)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/virtualMachines/extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ContainerRegistry/registries␊ - */␊ - export interface Registries {␊ - apiVersion: "2016-06-27-preview"␊ - /**␊ - * The location of the resource. This cannot be changed after the resource is created.␊ - */␊ - location: string␊ - /**␊ - * The name of the container registry.␊ - */␊ - name: string␊ - /**␊ - * The properties of a container registry.␊ - */␊ - properties: (RegistryProperties | string)␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.ContainerRegistry/registries"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a container registry.␊ - */␊ - export interface RegistryProperties {␊ - /**␊ - * The value that indicates whether the admin user is enabled. This value is false by default.␊ - */␊ - adminUserEnabled?: (boolean | string)␊ - /**␊ - * The properties of a storage account for a container registry.␊ - */␊ - storageAccount: (StorageAccountProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a storage account for a container registry.␊ - */␊ - export interface StorageAccountProperties2 {␊ - /**␊ - * The access key to the storage account.␊ - */␊ - accessKey: string␊ - /**␊ - * The name of the storage account.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ContainerRegistry/registries␊ - */␊ - export interface Registries1 {␊ - apiVersion: "2017-03-01"␊ - /**␊ - * The location of the container registry. This cannot be changed after the resource is created.␊ - */␊ - location: string␊ - /**␊ - * The name of the container registry.␊ - */␊ - name: string␊ - /**␊ - * The parameters for creating the properties of a container registry.␊ - */␊ - properties: (RegistryPropertiesCreateParameters | string)␊ - /**␊ - * The SKU of a container registry.␊ - */␊ - sku: (Sku36 | string)␊ - /**␊ - * The tags for the container registry.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.ContainerRegistry/registries"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The parameters for creating the properties of a container registry.␊ - */␊ - export interface RegistryPropertiesCreateParameters {␊ - /**␊ - * The value that indicates whether the admin user is enabled.␊ - */␊ - adminUserEnabled?: (boolean | string)␊ - /**␊ - * The parameters of a storage account for a container registry.␊ - */␊ - storageAccount: (StorageAccountParameters | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The parameters of a storage account for a container registry.␊ - */␊ - export interface StorageAccountParameters {␊ - /**␊ - * The access key to the storage account.␊ - */␊ - accessKey: string␊ - /**␊ - * The name of the storage account.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The SKU of a container registry.␊ - */␊ - export interface Sku36 {␊ - /**␊ - * The SKU name of the container registry. Required for registry creation. Allowed value: Basic.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ContainerRegistry/registries␊ - */␊ - export interface Registries2 {␊ - apiVersion: "2017-06-01-preview"␊ - /**␊ - * The location of the resource. This cannot be changed after the resource is created.␊ - */␊ - location: string␊ - /**␊ - * The name of the container registry.␊ - */␊ - name: string␊ - /**␊ - * The properties of a container registry.␊ - */␊ - properties: (RegistryProperties1 | string)␊ - resources?: (RegistriesReplicationsChildResource | RegistriesWebhooksChildResource)[]␊ - /**␊ - * The SKU of a container registry.␊ - */␊ - sku: (Sku37 | string)␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.ContainerRegistry/registries"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a container registry.␊ - */␊ - export interface RegistryProperties1 {␊ - /**␊ - * The value that indicates whether the admin user is enabled.␊ - */␊ - adminUserEnabled?: (boolean | string)␊ - /**␊ - * The properties of a storage account for a container registry. Only applicable to Basic SKU.␊ - */␊ - storageAccount?: (StorageAccountProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a storage account for a container registry. Only applicable to Basic SKU.␊ - */␊ - export interface StorageAccountProperties3 {␊ - /**␊ - * The resource ID of the storage account.␊ - */␊ - id: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ContainerRegistry/registries/replications␊ - */␊ - export interface RegistriesReplicationsChildResource {␊ - apiVersion: "2017-06-01-preview"␊ - /**␊ - * The location of the resource. This cannot be changed after the resource is created.␊ - */␊ - location: string␊ - /**␊ - * The name of the replication.␊ - */␊ - name: string␊ - /**␊ - * The properties of a replication.␊ - */␊ - properties: (ReplicationProperties | string)␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "replications"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a replication.␊ - */␊ - export interface ReplicationProperties {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ContainerRegistry/registries/webhooks␊ - */␊ - export interface RegistriesWebhooksChildResource {␊ - apiVersion: "2017-06-01-preview"␊ - /**␊ - * The location of the webhook. This cannot be changed after the resource is created.␊ - */␊ - location: string␊ - /**␊ - * The name of the webhook.␊ - */␊ - name: string␊ - /**␊ - * The parameters for creating the properties of a webhook.␊ - */␊ - properties: (WebhookPropertiesCreateParameters | string)␊ - /**␊ - * The tags for the webhook.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "webhooks"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The parameters for creating the properties of a webhook.␊ - */␊ - export interface WebhookPropertiesCreateParameters {␊ - /**␊ - * The list of actions that trigger the webhook to post notifications.␊ - */␊ - actions: (("push" | "delete")[] | string)␊ - /**␊ - * Custom headers that will be added to the webhook notifications.␊ - */␊ - customHeaders?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The scope of repositories where the event can be triggered. For example, 'foo:*' means events for all tags under repository 'foo'. 'foo:bar' means events for 'foo:bar' only. 'foo' is equivalent to 'foo:latest'. Empty means all events.␊ - */␊ - scope?: string␊ - /**␊ - * The service URI for the webhook to post notifications.␊ - */␊ - serviceUri: string␊ - /**␊ - * The status of the webhook at the time the operation was called.␊ - */␊ - status?: (("enabled" | "disabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The SKU of a container registry.␊ - */␊ - export interface Sku37 {␊ - /**␊ - * The SKU name of the container registry. Required for registry creation.␊ - */␊ - name: (("Basic" | "Managed_Basic" | "Managed_Standard" | "Managed_Premium") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ContainerRegistry/registries/replications␊ - */␊ - export interface RegistriesReplications {␊ - apiVersion: "2017-06-01-preview"␊ - /**␊ - * The location of the resource. This cannot be changed after the resource is created.␊ - */␊ - location: string␊ - /**␊ - * The name of the replication.␊ - */␊ - name: string␊ - /**␊ - * The properties of a replication.␊ - */␊ - properties: (ReplicationProperties | string)␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.ContainerRegistry/registries/replications"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ContainerRegistry/registries/webhooks␊ - */␊ - export interface RegistriesWebhooks {␊ - apiVersion: "2017-06-01-preview"␊ - /**␊ - * The location of the webhook. This cannot be changed after the resource is created.␊ - */␊ - location: string␊ - /**␊ - * The name of the webhook.␊ - */␊ - name: string␊ - /**␊ - * The parameters for creating the properties of a webhook.␊ - */␊ - properties: (WebhookPropertiesCreateParameters | string)␊ - /**␊ - * The tags for the webhook.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.ContainerRegistry/registries/webhooks"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ContainerRegistry/registries␊ - */␊ - export interface Registries3 {␊ - apiVersion: "2017-10-01"␊ - /**␊ - * The location of the resource. This cannot be changed after the resource is created.␊ - */␊ - location: string␊ - /**␊ - * The name of the container registry.␊ - */␊ - name: string␊ - /**␊ - * The properties of a container registry.␊ - */␊ - properties: (RegistryProperties2 | string)␊ - resources?: (RegistriesReplicationsChildResource1 | RegistriesWebhooksChildResource1)[]␊ - /**␊ - * The SKU of a container registry.␊ - */␊ - sku: (Sku38 | string)␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.ContainerRegistry/registries"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a container registry.␊ - */␊ - export interface RegistryProperties2 {␊ - /**␊ - * The value that indicates whether the admin user is enabled.␊ - */␊ - adminUserEnabled?: (boolean | string)␊ - /**␊ - * The network rule set for a container registry.␊ - */␊ - networkRuleSet?: (NetworkRuleSet13 | string)␊ - /**␊ - * The properties of a storage account for a container registry. Only applicable to Classic SKU.␊ - */␊ - storageAccount?: (StorageAccountProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The network rule set for a container registry.␊ - */␊ - export interface NetworkRuleSet13 {␊ - /**␊ - * The default action of allow or deny when no other rules match.␊ - */␊ - defaultAction: (("Allow" | "Deny") | string)␊ - /**␊ - * The IP ACL rules.␊ - */␊ - ipRules?: (IPRule12[] | string)␊ - /**␊ - * The virtual network rules.␊ - */␊ - virtualNetworkRules?: (VirtualNetworkRule14[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP rule with specific IP or IP range in CIDR format.␊ - */␊ - export interface IPRule12 {␊ - /**␊ - * The action of IP ACL rule.␊ - */␊ - action?: ("Allow" | string)␊ - /**␊ - * Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed.␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Virtual network rule.␊ - */␊ - export interface VirtualNetworkRule14 {␊ - /**␊ - * The action of virtual network rule.␊ - */␊ - action?: ("Allow" | string)␊ - /**␊ - * Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}.␊ - */␊ - id: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a storage account for a container registry. Only applicable to Classic SKU.␊ - */␊ - export interface StorageAccountProperties4 {␊ - /**␊ - * The resource ID of the storage account.␊ - */␊ - id: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ContainerRegistry/registries/replications␊ - */␊ - export interface RegistriesReplicationsChildResource1 {␊ - apiVersion: "2017-10-01"␊ - /**␊ - * The location of the resource. This cannot be changed after the resource is created.␊ - */␊ - location: string␊ - /**␊ - * The name of the replication.␊ - */␊ - name: string␊ - /**␊ - * The properties of a replication.␊ - */␊ - properties: (ReplicationProperties1 | string)␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "replications"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a replication.␊ - */␊ - export interface ReplicationProperties1 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ContainerRegistry/registries/webhooks␊ - */␊ - export interface RegistriesWebhooksChildResource1 {␊ - apiVersion: "2017-10-01"␊ - /**␊ - * The location of the webhook. This cannot be changed after the resource is created.␊ - */␊ - location: string␊ - /**␊ - * The name of the webhook.␊ - */␊ - name: string␊ - /**␊ - * The parameters for creating the properties of a webhook.␊ - */␊ - properties: (WebhookPropertiesCreateParameters1 | string)␊ - /**␊ - * The tags for the webhook.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "webhooks"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The parameters for creating the properties of a webhook.␊ - */␊ - export interface WebhookPropertiesCreateParameters1 {␊ - /**␊ - * The list of actions that trigger the webhook to post notifications.␊ - */␊ - actions: (("push" | "delete" | "quarantine" | "chart_push" | "chart_delete")[] | string)␊ - /**␊ - * Custom headers that will be added to the webhook notifications.␊ - */␊ - customHeaders?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The scope of repositories where the event can be triggered. For example, 'foo:*' means events for all tags under repository 'foo'. 'foo:bar' means events for 'foo:bar' only. 'foo' is equivalent to 'foo:latest'. Empty means all events.␊ - */␊ - scope?: string␊ - /**␊ - * The service URI for the webhook to post notifications.␊ - */␊ - serviceUri: string␊ - /**␊ - * The status of the webhook at the time the operation was called.␊ - */␊ - status?: (("enabled" | "disabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The SKU of a container registry.␊ - */␊ - export interface Sku38 {␊ - /**␊ - * The SKU name of the container registry. Required for registry creation.␊ - */␊ - name: (("Classic" | "Basic" | "Standard" | "Premium") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ContainerRegistry/registries/replications␊ - */␊ - export interface RegistriesReplications1 {␊ - apiVersion: "2017-10-01"␊ - /**␊ - * The location of the resource. This cannot be changed after the resource is created.␊ - */␊ - location: string␊ - /**␊ - * The name of the replication.␊ - */␊ - name: string␊ - /**␊ - * The properties of a replication.␊ - */␊ - properties: (ReplicationProperties1 | string)␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.ContainerRegistry/registries/replications"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ContainerRegistry/registries/webhooks␊ - */␊ - export interface RegistriesWebhooks1 {␊ - apiVersion: "2017-10-01"␊ - /**␊ - * The location of the webhook. This cannot be changed after the resource is created.␊ - */␊ - location: string␊ - /**␊ - * The name of the webhook.␊ - */␊ - name: string␊ - /**␊ - * The parameters for creating the properties of a webhook.␊ - */␊ - properties: (WebhookPropertiesCreateParameters1 | string)␊ - /**␊ - * The tags for the webhook.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.ContainerRegistry/registries/webhooks"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ContainerRegistry/registries/buildTasks␊ - */␊ - export interface RegistriesBuildTasks {␊ - apiVersion: "2018-02-01-preview"␊ - /**␊ - * The location of the resource. This cannot be changed after the resource is created.␊ - */␊ - location: string␊ - /**␊ - * The name of the container registry build task.␊ - */␊ - name: string␊ - /**␊ - * The properties of a build task.␊ - */␊ - properties: (BuildTaskProperties | string)␊ - resources?: RegistriesBuildTasksStepsChildResource[]␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.ContainerRegistry/registries/buildTasks"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a build task.␊ - */␊ - export interface BuildTaskProperties {␊ - /**␊ - * The alternative updatable name for a build task.␊ - */␊ - alias: string␊ - /**␊ - * The platform properties against which the build has to happen.␊ - */␊ - platform: (PlatformProperties | string)␊ - /**␊ - * The properties of the source code repository.␊ - */␊ - sourceRepository: (SourceRepositoryProperties | string)␊ - /**␊ - * The current status of build task.␊ - */␊ - status?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * Build timeout in seconds.␊ - */␊ - timeout?: ((number & string) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The platform properties against which the build has to happen.␊ - */␊ - export interface PlatformProperties {␊ - /**␊ - * The CPU configuration in terms of number of cores required for the build.␊ - */␊ - cpu?: (number | string)␊ - /**␊ - * The operating system type required for the build.␊ - */␊ - osType: (("Windows" | "Linux") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the source code repository.␊ - */␊ - export interface SourceRepositoryProperties {␊ - /**␊ - * The value of this property indicates whether the source control commit trigger is enabled or not.␊ - */␊ - isCommitTriggerEnabled?: (boolean | string)␊ - /**␊ - * The full URL to the source code repository␊ - */␊ - repositoryUrl: string␊ - /**␊ - * The authorization properties for accessing the source code repository.␊ - */␊ - sourceControlAuthProperties?: (SourceControlAuthInfo | string)␊ - /**␊ - * The type of source control service.␊ - */␊ - sourceControlType: (("Github" | "VisualStudioTeamService") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The authorization properties for accessing the source code repository.␊ - */␊ - export interface SourceControlAuthInfo {␊ - /**␊ - * Time in seconds that the token remains valid␊ - */␊ - expiresIn?: (number | string)␊ - /**␊ - * The refresh token used to refresh the access token.␊ - */␊ - refreshToken?: string␊ - /**␊ - * The scope of the access token.␊ - */␊ - scope?: string␊ - /**␊ - * The access token used to access the source control provider.␊ - */␊ - token: string␊ - /**␊ - * The type of Auth token.␊ - */␊ - tokenType?: (("PAT" | "OAuth") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ContainerRegistry/registries/buildTasks/steps␊ - */␊ - export interface RegistriesBuildTasksStepsChildResource {␊ - apiVersion: "2018-02-01-preview"␊ - /**␊ - * The name of a build step for a container registry build task.␊ - */␊ - name: string␊ - /**␊ - * Base properties for any build step.␊ - */␊ - properties: (BuildStepProperties | string)␊ - type: "steps"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Docker build step.␊ - */␊ - export interface DockerBuildStep {␊ - /**␊ - * The type of the auto trigger for base image dependency updates.␊ - */␊ - baseImageTrigger?: (("All" | "Runtime" | "None") | string)␊ - /**␊ - * The repository branch name.␊ - */␊ - branch?: string␊ - /**␊ - * The custom arguments for building this build step.␊ - */␊ - buildArguments?: (BuildArgument[] | string)␊ - /**␊ - * The relative context path for a docker build in the source.␊ - */␊ - contextPath?: string␊ - /**␊ - * The Docker file path relative to the source control root.␊ - */␊ - dockerFilePath?: string␊ - /**␊ - * The fully qualified image names including the repository and tag.␊ - */␊ - imageNames?: (string[] | string)␊ - /**␊ - * The value of this property indicates whether the image built should be pushed to the registry or not.␊ - */␊ - isPushEnabled?: (boolean | string)␊ - /**␊ - * The value of this property indicates whether the image cache is enabled or not.␊ - */␊ - noCache?: (boolean | string)␊ - type: "Docker"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a build argument.␊ - */␊ - export interface BuildArgument {␊ - /**␊ - * Flag to indicate whether the argument represents a secret and want to be removed from build logs.␊ - */␊ - isSecret?: (boolean | string)␊ - /**␊ - * The name of the argument.␊ - */␊ - name: string␊ - /**␊ - * The type of the argument.␊ - */␊ - type: ("DockerBuildArgument" | string)␊ - /**␊ - * The value of the argument.␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ContainerRegistry/registries/buildTasks/steps␊ - */␊ - export interface RegistriesBuildTasksSteps {␊ - apiVersion: "2018-02-01-preview"␊ - /**␊ - * The name of a build step for a container registry build task.␊ - */␊ - name: string␊ - /**␊ - * Base properties for any build step.␊ - */␊ - properties: (DockerBuildStep | string)␊ - type: "Microsoft.ContainerRegistry/registries/buildTasks/steps"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ContainerRegistry/registries/tasks␊ - */␊ - export interface RegistriesTasks {␊ - apiVersion: "2018-09-01"␊ - /**␊ - * The location of the resource. This cannot be changed after the resource is created.␊ - */␊ - location: string␊ - /**␊ - * The name of the container registry task.␊ - */␊ - name: string␊ - /**␊ - * The properties of a task.␊ - */␊ - properties: (TaskProperties1 | string)␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.ContainerRegistry/registries/tasks"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a task.␊ - */␊ - export interface TaskProperties1 {␊ - /**␊ - * The properties that determine the run agent configuration.␊ - */␊ - agentConfiguration?: (AgentProperties | string)␊ - /**␊ - * The parameters that describes a set of credentials that will be used when a run is invoked.␊ - */␊ - credentials?: (Credentials | string)␊ - /**␊ - * The platform properties against which the run has to happen.␊ - */␊ - platform: (PlatformProperties1 | string)␊ - /**␊ - * The current status of task.␊ - */␊ - status?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * Base properties for any task step.␊ - */␊ - step: (TaskStepProperties | string)␊ - /**␊ - * Run timeout in seconds.␊ - */␊ - timeout?: ((number & string) | string)␊ - /**␊ - * The properties of a trigger.␊ - */␊ - trigger?: (TriggerProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties that determine the run agent configuration.␊ - */␊ - export interface AgentProperties {␊ - /**␊ - * The CPU configuration in terms of number of cores required for the run.␊ - */␊ - cpu?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The parameters that describes a set of credentials that will be used when a run is invoked.␊ - */␊ - export interface Credentials {␊ - /**␊ - * Describes the credential parameters for accessing other custom registries. The key␍␊ - * for the dictionary item will be the registry login server (myregistry.azurecr.io) and␍␊ - * the value of the item will be the registry credentials for accessing the registry.␊ - */␊ - customRegistries?: ({␊ - [k: string]: CustomRegistryCredentials␊ - } | string)␊ - /**␊ - * Describes the credential parameters for accessing the source registry.␊ - */␊ - sourceRegistry?: (SourceRegistryCredentials | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the credentials that will be used to access a custom registry during a run.␊ - */␊ - export interface CustomRegistryCredentials {␊ - /**␊ - * Describes the properties of a secret object value.␊ - */␊ - password?: (SecretObject | string)␊ - /**␊ - * Describes the properties of a secret object value.␊ - */␊ - userName?: (SecretObject | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the properties of a secret object value.␊ - */␊ - export interface SecretObject {␊ - /**␊ - * The type of the secret object which determines how the value of the secret object has to be␍␊ - * interpreted.␊ - */␊ - type?: ("Opaque" | string)␊ - /**␊ - * The value of the secret. The format of this value will be determined␍␊ - * based on the type of the secret object. If the type is Opaque, the value will be␍␊ - * used as is without any modification.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the credential parameters for accessing the source registry.␊ - */␊ - export interface SourceRegistryCredentials {␊ - /**␊ - * The authentication mode which determines the source registry login scope. The credentials for the source registry␍␊ - * will be generated using the given scope. These credentials will be used to login to␍␊ - * the source registry during the run.␊ - */␊ - loginMode?: (("None" | "Default") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The platform properties against which the run has to happen.␊ - */␊ - export interface PlatformProperties1 {␊ - /**␊ - * The OS architecture.␊ - */␊ - architecture?: (("amd64" | "x86" | "arm") | string)␊ - /**␊ - * The operating system type required for the run.␊ - */␊ - os: (("Windows" | "Linux") | string)␊ - /**␊ - * Variant of the CPU.␊ - */␊ - variant?: (("v6" | "v7" | "v8") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Docker build step.␊ - */␊ - export interface DockerBuildStep1 {␊ - /**␊ - * The collection of override arguments to be used when executing this build step.␊ - */␊ - arguments?: (Argument[] | string)␊ - /**␊ - * The Docker file path relative to the source context.␊ - */␊ - dockerFilePath: string␊ - /**␊ - * The fully qualified image names including the repository and tag.␊ - */␊ - imageNames?: (string[] | string)␊ - /**␊ - * The value of this property indicates whether the image built should be pushed to the registry or not.␊ - */␊ - isPushEnabled?: (boolean | string)␊ - /**␊ - * The value of this property indicates whether the image cache is enabled or not.␊ - */␊ - noCache?: (boolean | string)␊ - /**␊ - * The name of the target build stage for the docker build.␊ - */␊ - target?: string␊ - type: "Docker"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a run argument.␊ - */␊ - export interface Argument {␊ - /**␊ - * Flag to indicate whether the argument represents a secret and want to be removed from build logs.␊ - */␊ - isSecret?: (boolean | string)␊ - /**␊ - * The name of the argument.␊ - */␊ - name: string␊ - /**␊ - * The value of the argument.␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a task step.␊ - */␊ - export interface FileTaskStep {␊ - /**␊ - * The task template/definition file path relative to the source context.␊ - */␊ - taskFilePath: string␊ - type: "FileTask"␊ - /**␊ - * The collection of overridable values that can be passed when running a task.␊ - */␊ - values?: (SetValue[] | string)␊ - /**␊ - * The task values/parameters file path relative to the source context.␊ - */␊ - valuesFilePath?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a overridable value that can be passed to a task template.␊ - */␊ - export interface SetValue {␊ - /**␊ - * Flag to indicate whether the value represents a secret or not.␊ - */␊ - isSecret?: (boolean | string)␊ - /**␊ - * The name of the overridable value.␊ - */␊ - name: string␊ - /**␊ - * The overridable value.␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a encoded task step.␊ - */␊ - export interface EncodedTaskStep {␊ - /**␊ - * Base64 encoded value of the template/definition file content.␊ - */␊ - encodedTaskContent: string␊ - /**␊ - * Base64 encoded value of the parameters/values file content.␊ - */␊ - encodedValuesContent?: string␊ - type: "EncodedTask"␊ - /**␊ - * The collection of overridable values that can be passed when running a task.␊ - */␊ - values?: (SetValue[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a trigger.␊ - */␊ - export interface TriggerProperties {␊ - /**␊ - * The trigger based on base image dependency.␊ - */␊ - baseImageTrigger?: (BaseImageTrigger | string)␊ - /**␊ - * The collection of triggers based on source code repository.␊ - */␊ - sourceTriggers?: (SourceTrigger[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The trigger based on base image dependency.␊ - */␊ - export interface BaseImageTrigger {␊ - /**␊ - * The type of the auto trigger for base image dependency updates.␊ - */␊ - baseImageTriggerType: (("All" | "Runtime") | string)␊ - /**␊ - * The name of the trigger.␊ - */␊ - name: string␊ - /**␊ - * The current status of trigger.␊ - */␊ - status?: (("Disabled" | "Enabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a source based trigger.␊ - */␊ - export interface SourceTrigger {␊ - /**␊ - * The name of the trigger.␊ - */␊ - name: string␊ - /**␊ - * The properties of the source code repository.␊ - */␊ - sourceRepository: (SourceProperties | string)␊ - /**␊ - * The source event corresponding to the trigger.␊ - */␊ - sourceTriggerEvents: (("commit" | "pullrequest")[] | string)␊ - /**␊ - * The current status of trigger.␊ - */␊ - status?: (("Disabled" | "Enabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the source code repository.␊ - */␊ - export interface SourceProperties {␊ - /**␊ - * The branch name of the source code.␊ - */␊ - branch?: string␊ - /**␊ - * The full URL to the source code repository␊ - */␊ - repositoryUrl: string␊ - /**␊ - * The authorization properties for accessing the source code repository.␊ - */␊ - sourceControlAuthProperties?: (AuthInfo | string)␊ - /**␊ - * The type of source control service.␊ - */␊ - sourceControlType: (("Github" | "VisualStudioTeamService") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The authorization properties for accessing the source code repository.␊ - */␊ - export interface AuthInfo {␊ - /**␊ - * Time in seconds that the token remains valid␊ - */␊ - expiresIn?: (number | string)␊ - /**␊ - * The refresh token used to refresh the access token.␊ - */␊ - refreshToken?: string␊ - /**␊ - * The scope of the access token.␊ - */␊ - scope?: string␊ - /**␊ - * The access token used to access the source control provider.␊ - */␊ - token: string␊ - /**␊ - * The type of Auth token.␊ - */␊ - tokenType: (("PAT" | "OAuth") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/publicIPAddresses␊ - */␊ - export interface PublicIPAddresses {␊ - type: "Microsoft.Network/publicIPAddresses"␊ - apiVersion: "2016-06-01"␊ - /**␊ - * Microsoft.Network/publicIPAddresses: Name␊ - */␊ - name: string␊ - properties: {␊ - /**␊ - * Microsoft.Network/publicIPAddresses: Public IP allocation method␊ - */␊ - publicIPAllocationMethod: (("Dynamic" | "Static") | string)␊ - /**␊ - * Microsoft.Network/publicIPAddresses: Idle timeout in minutes␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Microsoft.Network/publicIPAddresses: DNS settings␊ - */␊ - dnsSettings?: (PublicIPAddressDnsSettings | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface PublicIPAddressDnsSettings {␊ - domainNameLabel: string␊ - reverseFqdn?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks␊ - */␊ - export interface VirtualNetworks {␊ - type: "Microsoft.Network/virtualNetworks"␊ - apiVersion: "2016-06-01"␊ - /**␊ - * Microsoft.Network/virtualNetworks: Name␊ - */␊ - name: string␊ - properties: {␊ - /**␊ - * Microsoft.Network/virtualNetworks: Address space␊ - */␊ - addressSpace: (AddressSpace | string)␊ - /**␊ - * Microsoft.Network/virtualNetworks: DHCP options␊ - */␊ - dhcpOptions?: (DhcpOptions | string)␊ - /**␊ - * Microsoft.Network/virtualNetworks: Subnets␊ - */␊ - subnets: (Subnet2[] | string)␊ - /**␊ - * Microsoft.Network/virtualNetworks: Virtual Network Peerings␊ - */␊ - virtualNetworkPeerings?: (VirtualNetworkPeering[] | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface AddressSpace {␊ - addressPrefixes: string[]␊ - [k: string]: unknown␊ - }␊ - export interface DhcpOptions {␊ - dnsServers: string[]␊ - [k: string]: unknown␊ - }␊ - export interface Subnet2 {␊ - name: string␊ - properties: {␊ - addressPrefix: string␊ - networkSecurityGroup?: Id1␊ - routeTable?: Id1␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Id1 {␊ - id: string␊ - [k: string]: unknown␊ - }␊ - export interface VirtualNetworkPeering {␊ - /**␊ - * Gets or sets the name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name: string␊ - properties: {␊ - allowVirtualNetworkAccess?: boolean␊ - allowForwardedTraffic?: boolean␊ - allowGatewayTransit?: boolean␊ - useRemoteGateways?: boolean␊ - remoteVirtualNetwork?: Id1␊ - /**␊ - * Gets the status of the virtual network peering␊ - */␊ - peeringState?: ((("Initiated" | "Connected" | "Disconnected") | string) & string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers␊ - */␊ - export interface LoadBalancers {␊ - type: "Microsoft.Network/loadBalancers"␊ - apiVersion: "2016-06-01"␊ - name: string␊ - properties: {␊ - /**␊ - * Microsoft.Network/loadBalancers: Frontend IP configurations␊ - */␊ - frontendIPConfigurations: (FrontendIPConfigurations[] | string)␊ - /**␊ - * Microsoft.Network/loadBalancers: Backend address pools␊ - */␊ - backendAddressPools?: (BackendAddressPools[] | string)␊ - /**␊ - * Microsoft.Network/loadBalancers: Load balancing rules␊ - */␊ - loadBalancingRules?: (LoadBalancingRules[] | string)␊ - /**␊ - * Microsoft.Network/loadBalancers: Probes␊ - */␊ - probes?: (Probes[] | string)␊ - /**␊ - * Microsoft.Network/loadBalancers: Inbound NAT rules␊ - */␊ - inboundNatRules?: (InboundNatRules[] | string)␊ - /**␊ - * Microsoft.Network/loadBalancers: Inbound NAT pools␊ - */␊ - inboundNatPools?: (InboundNatPools[] | string)␊ - /**␊ - * Microsoft.Network/loadBalancers: Outbound NAT rules␊ - */␊ - outboundNatRules?: (OutboundNatRules[] | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface FrontendIPConfigurations {␊ - name: string␊ - properties: {␊ - subnet?: Id1␊ - privateIPAddress?: string␊ - privateIPAllocationMethod?: (("Dynamic" | "Static") | string)␊ - publicIPAddress?: Id1␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface BackendAddressPools {␊ - name: string␊ - }␊ - export interface LoadBalancingRules {␊ - name: string␊ - properties: {␊ - frontendIPConfiguration: Id1␊ - backendAddressPool: Id1␊ - protocol: (("Udp" | "Tcp") | string)␊ - frontendPort: (number | string)␊ - backendPort: (number | string)␊ - probe?: Id1␊ - enableFloatingIP?: (boolean | string)␊ - idleTimeoutInMinutes?: (number | string)␊ - loadDistribution?: (("Default" | "SourceIP" | "SourceIPProtocol") | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Probes {␊ - name: string␊ - properties: {␊ - protocol: (("Http" | "Tcp") | string)␊ - port: (number | string)␊ - requestPath?: string␊ - intervalInSeconds?: (number | string)␊ - numberOfProbes?: (number | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface InboundNatRules {␊ - name: string␊ - properties: {␊ - frontendIPConfiguration: Id1␊ - protocol: string␊ - frontendPort: (number | string)␊ - backendPort: (number | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface InboundNatPools {␊ - name: string␊ - properties: {␊ - frontendIPConfiguration: Id1␊ - protocol: string␊ - frontendPortRangeStart: (number | string)␊ - frontendPortRangeEnd: (number | string)␊ - backendPort: (number | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface OutboundNatRules {␊ - name: string␊ - properties: {␊ - frontendIPConfigurations: Id1[]␊ - backendAddressPool: Id1␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups␊ - */␊ - export interface NetworkSecurityGroups {␊ - type: "Microsoft.Network/networkSecurityGroups"␊ - apiVersion: "2016-06-01"␊ - name: string␊ - properties: {␊ - /**␊ - * Microsoft.Network/networkSecurityGroups: Security rules␊ - */␊ - securityRules: (SecurityRules[] | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface SecurityRules {␊ - name: string␊ - properties: {␊ - description?: string␊ - protocol: (("Tcp" | "Udp" | "*") | string)␊ - sourcePortRange: string␊ - destinationPortRange: string␊ - sourceAddressPrefix: string␊ - destinationAddressPrefix: string␊ - access: (("Allow" | "Deny") | string)␊ - priority: (number | string)␊ - direction: (("Inbound" | "Outbound") | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces␊ - */␊ - export interface NetworkInterfaces1 {␊ - type: "Microsoft.Network/networkInterfaces"␊ - apiVersion: "2016-06-01"␊ - name: string␊ - properties: {␊ - /**␊ - * Microsoft.Network/networkInterfaces: Enable IP forwarding␊ - */␊ - enableIPForwarding?: (boolean | string)␊ - /**␊ - * Microsoft.Network/networkInterfaces: Network security group␊ - */␊ - networkSecurityGroup?: (Id1 | string)␊ - /**␊ - * Microsoft.Network/networkInterfaces: IP configurations␊ - */␊ - ipConfigurations: (IpConfiguration1[] | string)␊ - /**␊ - * Microsoft.Network/networkInterfaces: DNS settings␊ - */␊ - dnsSettings?: (NetworkInterfaceDnsSettings | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface IpConfiguration1 {␊ - name: string␊ - properties: {␊ - subnet: Id1␊ - privateIPAddress?: string␊ - privateIPAllocationMethod: (("Dynamic" | "Static") | string)␊ - publicIPAddress?: Id1␊ - loadBalancerBackendAddressPools?: Id1[]␊ - loadBalancerInboundNatRules?: Id1[]␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface NetworkInterfaceDnsSettings {␊ - dnsServers?: (string | string[])␊ - internalDnsNameLabel?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables␊ - */␊ - export interface RouteTables {␊ - type: "Microsoft.Network/routeTables"␊ - apiVersion: "2016-06-01"␊ - name: string␊ - properties: {␊ - /**␊ - * Microsoft.Network/routeTables: Routes␊ - */␊ - routes: (Routes[] | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Routes {␊ - name: string␊ - properties: {␊ - addressPrefix: string␊ - nextHopType: (("VirtualNetworkGateway" | "VnetLocal" | "Internet" | "VirtualAppliance" | "HyperNetGateway" | "None") | string)␊ - nextHopIpAddress?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/publicIPAddresses␊ - */␊ - export interface PublicIPAddresses1 {␊ - type: "Microsoft.Network/publicIPAddresses"␊ - apiVersion: "2016-07-01"␊ - /**␊ - * Microsoft.Network/publicIPAddresses: Name␊ - */␊ - name: string␊ - properties: {␊ - /**␊ - * Microsoft.Network/publicIPAddresses: Public IP allocation method␊ - */␊ - publicIPAllocationMethod: (("Dynamic" | "Static") | string)␊ - /**␊ - * Microsoft.Network/publicIPAddresses: Idle timeout in minutes␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Microsoft.Network/publicIPAddresses: DNS settings␊ - */␊ - dnsSettings?: (PublicIPAddressDnsSettings1 | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface PublicIPAddressDnsSettings1 {␊ - domainNameLabel: string␊ - reverseFqdn?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks␊ - */␊ - export interface VirtualNetworks1 {␊ - type: "Microsoft.Network/virtualNetworks"␊ - apiVersion: "2016-07-01"␊ - /**␊ - * Microsoft.Network/virtualNetworks: Name␊ - */␊ - name: string␊ - properties: {␊ - /**␊ - * Microsoft.Network/virtualNetworks: Address space␊ - */␊ - addressSpace: (AddressSpace1 | string)␊ - /**␊ - * Microsoft.Network/virtualNetworks: DHCP options␊ - */␊ - dhcpOptions?: (DhcpOptions1 | string)␊ - /**␊ - * Microsoft.Network/virtualNetworks: Subnets␊ - */␊ - subnets: (Subnet3[] | string)␊ - /**␊ - * Microsoft.Network/virtualNetworks: Virtual Network Peerings␊ - */␊ - virtualNetworkPeerings?: (VirtualNetworkPeering1[] | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface AddressSpace1 {␊ - addressPrefixes: string[]␊ - [k: string]: unknown␊ - }␊ - export interface DhcpOptions1 {␊ - dnsServers: string[]␊ - [k: string]: unknown␊ - }␊ - export interface Subnet3 {␊ - name: string␊ - properties: {␊ - addressPrefix: string␊ - networkSecurityGroup?: Id2␊ - routeTable?: Id2␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Id2 {␊ - id: string␊ - [k: string]: unknown␊ - }␊ - export interface VirtualNetworkPeering1 {␊ - /**␊ - * Gets or sets the name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name: string␊ - properties: {␊ - allowVirtualNetworkAccess?: boolean␊ - allowForwardedTraffic?: boolean␊ - allowGatewayTransit?: boolean␊ - useRemoteGateways?: boolean␊ - remoteVirtualNetwork?: Id2␊ - /**␊ - * Gets the status of the virtual network peering␊ - */␊ - peeringState?: ((("Initiated" | "Connected" | "Disconnected") | string) & string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers␊ - */␊ - export interface LoadBalancers1 {␊ - type: "Microsoft.Network/loadBalancers"␊ - apiVersion: "2016-07-01"␊ - name: string␊ - properties: {␊ - /**␊ - * Microsoft.Network/loadBalancers: Frontend IP configurations␊ - */␊ - frontendIPConfigurations: (FrontendIPConfigurations1[] | string)␊ - /**␊ - * Microsoft.Network/loadBalancers: Backend address pools␊ - */␊ - backendAddressPools?: (BackendAddressPools1[] | string)␊ - /**␊ - * Microsoft.Network/loadBalancers: Load balancing rules␊ - */␊ - loadBalancingRules?: (LoadBalancingRules1[] | string)␊ - /**␊ - * Microsoft.Network/loadBalancers: Probes␊ - */␊ - probes?: (Probes1[] | string)␊ - /**␊ - * Microsoft.Network/loadBalancers: Inbound NAT rules␊ - */␊ - inboundNatRules?: (InboundNatRules1[] | string)␊ - /**␊ - * Microsoft.Network/loadBalancers: Inbound NAT pools␊ - */␊ - inboundNatPools?: (InboundNatPools1[] | string)␊ - /**␊ - * Microsoft.Network/loadBalancers: Outbound NAT rules␊ - */␊ - outboundNatRules?: (OutboundNatRules1[] | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface FrontendIPConfigurations1 {␊ - name: string␊ - properties: {␊ - subnet?: Id2␊ - privateIPAddress?: string␊ - privateIPAllocationMethod?: (("Dynamic" | "Static") | string)␊ - publicIPAddress?: Id2␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface BackendAddressPools1 {␊ - name: string␊ - }␊ - export interface LoadBalancingRules1 {␊ - name: string␊ - properties: {␊ - frontendIPConfiguration: Id2␊ - backendAddressPool: Id2␊ - protocol: (("Udp" | "Tcp") | string)␊ - frontendPort: (number | string)␊ - backendPort: (number | string)␊ - probe?: Id2␊ - enableFloatingIP?: (boolean | string)␊ - idleTimeoutInMinutes?: (number | string)␊ - loadDistribution?: (("Default" | "SourceIP" | "SourceIPProtocol") | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Probes1 {␊ - name: string␊ - properties: {␊ - protocol: (("Http" | "Tcp") | string)␊ - port: (number | string)␊ - requestPath?: string␊ - intervalInSeconds?: (number | string)␊ - numberOfProbes?: (number | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface InboundNatRules1 {␊ - name: string␊ - properties: {␊ - frontendIPConfiguration: Id2␊ - protocol: string␊ - frontendPort: (number | string)␊ - backendPort: (number | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface InboundNatPools1 {␊ - name: string␊ - properties: {␊ - frontendIPConfiguration: Id2␊ - protocol: string␊ - frontendPortRangeStart: (number | string)␊ - frontendPortRangeEnd: (number | string)␊ - backendPort: (number | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface OutboundNatRules1 {␊ - name: string␊ - properties: {␊ - frontendIPConfigurations: Id2[]␊ - backendAddressPool: Id2␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups␊ - */␊ - export interface NetworkSecurityGroups1 {␊ - type: "Microsoft.Network/networkSecurityGroups"␊ - apiVersion: "2016-07-01"␊ - name: string␊ - properties: {␊ - /**␊ - * Microsoft.Network/networkSecurityGroups: Security rules␊ - */␊ - securityRules: (SecurityRules1[] | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface SecurityRules1 {␊ - name: string␊ - properties: {␊ - description?: string␊ - protocol: (("Tcp" | "Udp" | "*") | string)␊ - sourcePortRange: string␊ - destinationPortRange: string␊ - sourceAddressPrefix: string␊ - destinationAddressPrefix: string␊ - access: (("Allow" | "Deny") | string)␊ - priority: (number | string)␊ - direction: (("Inbound" | "Outbound") | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces␊ - */␊ - export interface NetworkInterfaces2 {␊ - type: "Microsoft.Network/networkInterfaces"␊ - apiVersion: "2016-07-01"␊ - name: string␊ - properties: {␊ - /**␊ - * Microsoft.Network/networkInterfaces: Enable IP forwarding␊ - */␊ - enableIPForwarding?: (boolean | string)␊ - /**␊ - * Microsoft.Network/networkInterfaces: Network security group␊ - */␊ - networkSecurityGroup?: (Id2 | string)␊ - /**␊ - * Microsoft.Network/networkInterfaces: IP configurations␊ - */␊ - ipConfigurations: (IpConfiguration2[] | string)␊ - /**␊ - * Microsoft.Network/networkInterfaces: DNS settings␊ - */␊ - dnsSettings?: (NetworkInterfaceDnsSettings1 | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface IpConfiguration2 {␊ - name: string␊ - properties: {␊ - subnet: Id2␊ - privateIPAddress?: string␊ - privateIPAllocationMethod: (("Dynamic" | "Static") | string)␊ - publicIPAddress?: Id2␊ - loadBalancerBackendAddressPools?: Id2[]␊ - loadBalancerInboundNatRules?: Id2[]␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface NetworkInterfaceDnsSettings1 {␊ - dnsServers?: (string | string[])␊ - internalDnsNameLabel?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables␊ - */␊ - export interface RouteTables1 {␊ - type: "Microsoft.Network/routeTables"␊ - apiVersion: "2016-07-01"␊ - name: string␊ - properties: {␊ - /**␊ - * Microsoft.Network/routeTables: Routes␊ - */␊ - routes: (Routes1[] | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Routes1 {␊ - name: string␊ - properties: {␊ - addressPrefix: string␊ - nextHopType: (("VirtualNetworkGateway" | "VnetLocal" | "Internet" | "VirtualAppliance" | "HyperNetGateway" | "None") | string)␊ - nextHopIpAddress?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/publicIPAddresses␊ - */␊ - export interface PublicIPAddresses2 {␊ - type: "Microsoft.Network/publicIPAddresses"␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Microsoft.Network/publicIPAddresses: Name␊ - */␊ - name: string␊ - properties: {␊ - /**␊ - * Microsoft.Network/publicIPAddresses: Public IP allocation method␊ - */␊ - publicIPAllocationMethod: (("Dynamic" | "Static") | string)␊ - /**␊ - * Microsoft.Network/publicIPAddresses: Idle timeout in minutes␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Microsoft.Network/publicIPAddresses: DNS settings␊ - */␊ - dnsSettings?: (PublicIPAddressDnsSettings2 | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface PublicIPAddressDnsSettings2 {␊ - domainNameLabel: string␊ - reverseFqdn?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks␊ - */␊ - export interface VirtualNetworks2 {␊ - type: "Microsoft.Network/virtualNetworks"␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Microsoft.Network/virtualNetworks: Name␊ - */␊ - name: string␊ - properties: {␊ - /**␊ - * Microsoft.Network/virtualNetworks: Address space␊ - */␊ - addressSpace: (AddressSpace2 | string)␊ - /**␊ - * Microsoft.Network/virtualNetworks: DHCP options␊ - */␊ - dhcpOptions?: (DhcpOptions2 | string)␊ - /**␊ - * Microsoft.Network/virtualNetworks: Subnets␊ - */␊ - subnets: (Subnet4[] | string)␊ - /**␊ - * Microsoft.Network/virtualNetworks: Virtual Network Peerings␊ - */␊ - virtualNetworkPeerings?: (VirtualNetworkPeering2[] | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface AddressSpace2 {␊ - addressPrefixes: string[]␊ - [k: string]: unknown␊ - }␊ - export interface DhcpOptions2 {␊ - dnsServers: string[]␊ - [k: string]: unknown␊ - }␊ - export interface Subnet4 {␊ - name: string␊ - properties: {␊ - addressPrefix: string␊ - networkSecurityGroup?: Id3␊ - routeTable?: Id3␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Id3 {␊ - id: string␊ - [k: string]: unknown␊ - }␊ - export interface VirtualNetworkPeering2 {␊ - /**␊ - * Gets or sets the name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name: string␊ - properties: {␊ - allowVirtualNetworkAccess?: boolean␊ - allowForwardedTraffic?: boolean␊ - allowGatewayTransit?: boolean␊ - useRemoteGateways?: boolean␊ - remoteVirtualNetwork?: Id3␊ - /**␊ - * Gets the status of the virtual network peering␊ - */␊ - peeringState?: ((("Initiated" | "Connected" | "Disconnected") | string) & string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers␊ - */␊ - export interface LoadBalancers2 {␊ - type: "Microsoft.Network/loadBalancers"␊ - apiVersion: "2016-08-01"␊ - name: string␊ - properties: {␊ - /**␊ - * Microsoft.Network/loadBalancers: Frontend IP configurations␊ - */␊ - frontendIPConfigurations: (FrontendIPConfigurations2[] | string)␊ - /**␊ - * Microsoft.Network/loadBalancers: Backend address pools␊ - */␊ - backendAddressPools?: (BackendAddressPools2[] | string)␊ - /**␊ - * Microsoft.Network/loadBalancers: Load balancing rules␊ - */␊ - loadBalancingRules?: (LoadBalancingRules2[] | string)␊ - /**␊ - * Microsoft.Network/loadBalancers: Probes␊ - */␊ - probes?: (Probes2[] | string)␊ - /**␊ - * Microsoft.Network/loadBalancers: Inbound NAT rules␊ - */␊ - inboundNatRules?: (InboundNatRules2[] | string)␊ - /**␊ - * Microsoft.Network/loadBalancers: Inbound NAT pools␊ - */␊ - inboundNatPools?: (InboundNatPools2[] | string)␊ - /**␊ - * Microsoft.Network/loadBalancers: Outbound NAT rules␊ - */␊ - outboundNatRules?: (OutboundNatRules2[] | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface FrontendIPConfigurations2 {␊ - name: string␊ - properties: {␊ - subnet?: Id3␊ - privateIPAddress?: string␊ - privateIPAllocationMethod?: (("Dynamic" | "Static") | string)␊ - publicIPAddress?: Id3␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface BackendAddressPools2 {␊ - name: string␊ - }␊ - export interface LoadBalancingRules2 {␊ - name: string␊ - properties: {␊ - frontendIPConfiguration: Id3␊ - backendAddressPool: Id3␊ - protocol: (("Udp" | "Tcp") | string)␊ - frontendPort: (number | string)␊ - backendPort: (number | string)␊ - probe?: Id3␊ - enableFloatingIP?: (boolean | string)␊ - idleTimeoutInMinutes?: (number | string)␊ - loadDistribution?: (("Default" | "SourceIP" | "SourceIPProtocol") | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Probes2 {␊ - name: string␊ - properties: {␊ - protocol: (("Http" | "Tcp") | string)␊ - port: (number | string)␊ - requestPath?: string␊ - intervalInSeconds?: (number | string)␊ - numberOfProbes?: (number | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface InboundNatRules2 {␊ - name: string␊ - properties: {␊ - frontendIPConfiguration: Id3␊ - protocol: string␊ - frontendPort: (number | string)␊ - backendPort: (number | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface InboundNatPools2 {␊ - name: string␊ - properties: {␊ - frontendIPConfiguration: Id3␊ - protocol: string␊ - frontendPortRangeStart: (number | string)␊ - frontendPortRangeEnd: (number | string)␊ - backendPort: (number | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface OutboundNatRules2 {␊ - name: string␊ - properties: {␊ - frontendIPConfigurations: Id3[]␊ - backendAddressPool: Id3␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups␊ - */␊ - export interface NetworkSecurityGroups2 {␊ - type: "Microsoft.Network/networkSecurityGroups"␊ - apiVersion: "2016-08-01"␊ - name: string␊ - properties: {␊ - /**␊ - * Microsoft.Network/networkSecurityGroups: Security rules␊ - */␊ - securityRules: (SecurityRules2[] | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface SecurityRules2 {␊ - name: string␊ - properties: {␊ - description?: string␊ - protocol: (("Tcp" | "Udp" | "*") | string)␊ - sourcePortRange: string␊ - destinationPortRange: string␊ - sourceAddressPrefix: string␊ - destinationAddressPrefix: string␊ - access: (("Allow" | "Deny") | string)␊ - priority: (number | string)␊ - direction: (("Inbound" | "Outbound") | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces␊ - */␊ - export interface NetworkInterfaces3 {␊ - type: "Microsoft.Network/networkInterfaces"␊ - apiVersion: "2016-08-01"␊ - name: string␊ - properties: {␊ - /**␊ - * Microsoft.Network/networkInterfaces: Enable IP forwarding␊ - */␊ - enableIPForwarding?: (boolean | string)␊ - /**␊ - * Microsoft.Network/networkInterfaces: Network security group␊ - */␊ - networkSecurityGroup?: (Id3 | string)␊ - /**␊ - * Microsoft.Network/networkInterfaces: IP configurations␊ - */␊ - ipConfigurations: (IpConfiguration3[] | string)␊ - /**␊ - * Microsoft.Network/networkInterfaces: DNS settings␊ - */␊ - dnsSettings?: (NetworkInterfaceDnsSettings2 | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface IpConfiguration3 {␊ - name: string␊ - properties: {␊ - subnet: Id3␊ - privateIPAddress?: string␊ - privateIPAllocationMethod: (("Dynamic" | "Static") | string)␊ - publicIPAddress?: Id3␊ - loadBalancerBackendAddressPools?: Id3[]␊ - loadBalancerInboundNatRules?: Id3[]␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface NetworkInterfaceDnsSettings2 {␊ - dnsServers?: (string | string[])␊ - internalDnsNameLabel?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables␊ - */␊ - export interface RouteTables2 {␊ - type: "Microsoft.Network/routeTables"␊ - apiVersion: "2016-08-01"␊ - name: string␊ - properties: {␊ - /**␊ - * Microsoft.Network/routeTables: Routes␊ - */␊ - routes: (Routes2[] | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Routes2 {␊ - name: string␊ - properties: {␊ - addressPrefix: string␊ - nextHopType: (("VirtualNetworkGateway" | "VnetLocal" | "Internet" | "VirtualAppliance" | "HyperNetGateway" | "None") | string)␊ - nextHopIpAddress?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/publicIPAddresses␊ - */␊ - export interface PublicIPAddresses3 {␊ - type: "Microsoft.Network/publicIPAddresses"␊ - apiVersion: "2016-09-01"␊ - /**␊ - * Microsoft.Network/publicIPAddresses: Name␊ - */␊ - name: string␊ - properties: {␊ - /**␊ - * Microsoft.Network/publicIPAddresses: Public IP allocation method␊ - */␊ - publicIPAllocationMethod: (("Dynamic" | "Static") | string)␊ - /**␊ - * Microsoft.Network/publicIPAddresses: Idle timeout in minutes␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Microsoft.Network/publicIPAddresses: DNS settings␊ - */␊ - dnsSettings?: (PublicIPAddressDnsSettings3 | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface PublicIPAddressDnsSettings3 {␊ - domainNameLabel: string␊ - reverseFqdn?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks␊ - */␊ - export interface VirtualNetworks3 {␊ - type: "Microsoft.Network/virtualNetworks"␊ - apiVersion: "2016-09-01"␊ - /**␊ - * Microsoft.Network/virtualNetworks: Name␊ - */␊ - name: string␊ - properties: {␊ - /**␊ - * Microsoft.Network/virtualNetworks: Address space␊ - */␊ - addressSpace: (AddressSpace3 | string)␊ - /**␊ - * Microsoft.Network/virtualNetworks: DHCP options␊ - */␊ - dhcpOptions?: (DhcpOptions3 | string)␊ - /**␊ - * Microsoft.Network/virtualNetworks: Subnets␊ - */␊ - subnets: (Subnet5[] | string)␊ - /**␊ - * Microsoft.Network/virtualNetworks: Virtual Network Peerings␊ - */␊ - virtualNetworkPeerings?: (VirtualNetworkPeering3[] | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface AddressSpace3 {␊ - addressPrefixes: string[]␊ - [k: string]: unknown␊ - }␊ - export interface DhcpOptions3 {␊ - dnsServers: string[]␊ - [k: string]: unknown␊ - }␊ - export interface Subnet5 {␊ - name: string␊ - properties: {␊ - addressPrefix: string␊ - networkSecurityGroup?: Id4␊ - routeTable?: Id4␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Id4 {␊ - id: string␊ - [k: string]: unknown␊ - }␊ - export interface VirtualNetworkPeering3 {␊ - /**␊ - * Gets or sets the name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name: string␊ - properties: {␊ - allowVirtualNetworkAccess?: boolean␊ - allowForwardedTraffic?: boolean␊ - allowGatewayTransit?: boolean␊ - useRemoteGateways?: boolean␊ - remoteVirtualNetwork?: Id4␊ - /**␊ - * Gets the status of the virtual network peering␊ - */␊ - peeringState?: ((("Initiated" | "Connected" | "Disconnected") | string) & string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers␊ - */␊ - export interface LoadBalancers3 {␊ - type: "Microsoft.Network/loadBalancers"␊ - apiVersion: "2016-09-01"␊ - name: string␊ - properties: {␊ - /**␊ - * Microsoft.Network/loadBalancers: Frontend IP configurations␊ - */␊ - frontendIPConfigurations: (FrontendIPConfigurations3[] | string)␊ - /**␊ - * Microsoft.Network/loadBalancers: Backend address pools␊ - */␊ - backendAddressPools?: (BackendAddressPools3[] | string)␊ - /**␊ - * Microsoft.Network/loadBalancers: Load balancing rules␊ - */␊ - loadBalancingRules?: (LoadBalancingRules3[] | string)␊ - /**␊ - * Microsoft.Network/loadBalancers: Probes␊ - */␊ - probes?: (Probes3[] | string)␊ - /**␊ - * Microsoft.Network/loadBalancers: Inbound NAT rules␊ - */␊ - inboundNatRules?: (InboundNatRules3[] | string)␊ - /**␊ - * Microsoft.Network/loadBalancers: Inbound NAT pools␊ - */␊ - inboundNatPools?: (InboundNatPools3[] | string)␊ - /**␊ - * Microsoft.Network/loadBalancers: Outbound NAT rules␊ - */␊ - outboundNatRules?: (OutboundNatRules3[] | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface FrontendIPConfigurations3 {␊ - name: string␊ - properties: {␊ - subnet?: Id4␊ - privateIPAddress?: string␊ - privateIPAllocationMethod?: (("Dynamic" | "Static") | string)␊ - publicIPAddress?: Id4␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface BackendAddressPools3 {␊ - name: string␊ - }␊ - export interface LoadBalancingRules3 {␊ - name: string␊ - properties: {␊ - frontendIPConfiguration: Id4␊ - backendAddressPool: Id4␊ - protocol: (("Udp" | "Tcp") | string)␊ - frontendPort: (number | string)␊ - backendPort: (number | string)␊ - probe?: Id4␊ - enableFloatingIP?: (boolean | string)␊ - idleTimeoutInMinutes?: (number | string)␊ - loadDistribution?: (("Default" | "SourceIP" | "SourceIPProtocol") | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Probes3 {␊ - name: string␊ - properties: {␊ - protocol: (("Http" | "Tcp") | string)␊ - port: (number | string)␊ - requestPath?: string␊ - intervalInSeconds?: (number | string)␊ - numberOfProbes?: (number | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface InboundNatRules3 {␊ - name: string␊ - properties: {␊ - frontendIPConfiguration: Id4␊ - protocol: string␊ - frontendPort: (number | string)␊ - backendPort: (number | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface InboundNatPools3 {␊ - name: string␊ - properties: {␊ - frontendIPConfiguration: Id4␊ - protocol: string␊ - frontendPortRangeStart: (number | string)␊ - frontendPortRangeEnd: (number | string)␊ - backendPort: (number | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface OutboundNatRules3 {␊ - name: string␊ - properties: {␊ - frontendIPConfigurations: Id4[]␊ - backendAddressPool: Id4␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups␊ - */␊ - export interface NetworkSecurityGroups3 {␊ - type: "Microsoft.Network/networkSecurityGroups"␊ - apiVersion: "2016-09-01"␊ - name: string␊ - properties: {␊ - /**␊ - * Microsoft.Network/networkSecurityGroups: Security rules␊ - */␊ - securityRules: (SecurityRules3[] | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface SecurityRules3 {␊ - name: string␊ - properties: {␊ - description?: string␊ - protocol: (("Tcp" | "Udp" | "*") | string)␊ - sourcePortRange: string␊ - destinationPortRange: string␊ - sourceAddressPrefix: string␊ - destinationAddressPrefix: string␊ - access: (("Allow" | "Deny") | string)␊ - priority: (number | string)␊ - direction: (("Inbound" | "Outbound") | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces␊ - */␊ - export interface NetworkInterfaces4 {␊ - type: "Microsoft.Network/networkInterfaces"␊ - apiVersion: "2016-09-01"␊ - name: string␊ - properties: {␊ - /**␊ - * Microsoft.Network/networkInterfaces: Enable IP forwarding␊ - */␊ - enableIPForwarding?: (boolean | string)␊ - /**␊ - * Microsoft.Network/networkInterfaces: Network security group␊ - */␊ - networkSecurityGroup?: (Id4 | string)␊ - /**␊ - * Microsoft.Network/networkInterfaces: IP configurations␊ - */␊ - ipConfigurations: (IpConfiguration4[] | string)␊ - /**␊ - * Microsoft.Network/networkInterfaces: DNS settings␊ - */␊ - dnsSettings?: (NetworkInterfaceDnsSettings3 | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface IpConfiguration4 {␊ - name: string␊ - properties: {␊ - subnet: Id4␊ - privateIPAddress?: string␊ - privateIPAllocationMethod: (("Dynamic" | "Static") | string)␊ - publicIPAddress?: Id4␊ - loadBalancerBackendAddressPools?: Id4[]␊ - loadBalancerInboundNatRules?: Id4[]␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface NetworkInterfaceDnsSettings3 {␊ - dnsServers?: (string | string[])␊ - internalDnsNameLabel?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables␊ - */␊ - export interface RouteTables3 {␊ - type: "Microsoft.Network/routeTables"␊ - apiVersion: "2016-09-01"␊ - name: string␊ - properties: {␊ - /**␊ - * Microsoft.Network/routeTables: Routes␊ - */␊ - routes: (Routes3[] | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Routes3 {␊ - name: string␊ - properties: {␊ - addressPrefix: string␊ - nextHopType: (("VirtualNetworkGateway" | "VnetLocal" | "Internet" | "VirtualAppliance" | "HyperNetGateway" | "None") | string)␊ - nextHopIpAddress?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/publicIPAddresses␊ - */␊ - export interface PublicIPAddresses4 {␊ - type: "Microsoft.Network/publicIPAddresses"␊ - apiVersion: "2016-10-01"␊ - /**␊ - * Microsoft.Network/publicIPAddresses: Name␊ - */␊ - name: string␊ - properties: {␊ - /**␊ - * Microsoft.Network/publicIPAddresses: Public IP allocation method␊ - */␊ - publicIPAllocationMethod: (("Dynamic" | "Static") | string)␊ - /**␊ - * Microsoft.Network/publicIPAddresses: Idle timeout in minutes␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Microsoft.Network/publicIPAddresses: DNS settings␊ - */␊ - dnsSettings?: (PublicIPAddressDnsSettings4 | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface PublicIPAddressDnsSettings4 {␊ - domainNameLabel: string␊ - reverseFqdn?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks␊ - */␊ - export interface VirtualNetworks4 {␊ - type: "Microsoft.Network/virtualNetworks"␊ - apiVersion: "2016-10-01"␊ - /**␊ - * Microsoft.Network/virtualNetworks: Name␊ - */␊ - name: string␊ - properties: {␊ - /**␊ - * Microsoft.Network/virtualNetworks: Address space␊ - */␊ - addressSpace: (AddressSpace4 | string)␊ - /**␊ - * Microsoft.Network/virtualNetworks: DHCP options␊ - */␊ - dhcpOptions?: (DhcpOptions4 | string)␊ - /**␊ - * Microsoft.Network/virtualNetworks: Subnets␊ - */␊ - subnets: (Subnet6[] | string)␊ - /**␊ - * Microsoft.Network/virtualNetworks: Virtual Network Peerings␊ - */␊ - virtualNetworkPeerings?: (VirtualNetworkPeering4[] | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface AddressSpace4 {␊ - addressPrefixes: string[]␊ - [k: string]: unknown␊ - }␊ - export interface DhcpOptions4 {␊ - dnsServers: string[]␊ - [k: string]: unknown␊ - }␊ - export interface Subnet6 {␊ - name: string␊ - properties: {␊ - addressPrefix: string␊ - networkSecurityGroup?: Id5␊ - routeTable?: Id5␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Id5 {␊ - id: string␊ - [k: string]: unknown␊ - }␊ - export interface VirtualNetworkPeering4 {␊ - /**␊ - * Gets or sets the name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name: string␊ - properties: {␊ - allowVirtualNetworkAccess?: boolean␊ - allowForwardedTraffic?: boolean␊ - allowGatewayTransit?: boolean␊ - useRemoteGateways?: boolean␊ - remoteVirtualNetwork?: Id5␊ - /**␊ - * Gets the status of the virtual network peering␊ - */␊ - peeringState?: ((("Initiated" | "Connected" | "Disconnected") | string) & string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers␊ - */␊ - export interface LoadBalancers4 {␊ - type: "Microsoft.Network/loadBalancers"␊ - apiVersion: "2016-10-01"␊ - name: string␊ - properties: {␊ - /**␊ - * Microsoft.Network/loadBalancers: Frontend IP configurations␊ - */␊ - frontendIPConfigurations: (FrontendIPConfigurations4[] | string)␊ - /**␊ - * Microsoft.Network/loadBalancers: Backend address pools␊ - */␊ - backendAddressPools?: (BackendAddressPools4[] | string)␊ - /**␊ - * Microsoft.Network/loadBalancers: Load balancing rules␊ - */␊ - loadBalancingRules?: (LoadBalancingRules4[] | string)␊ - /**␊ - * Microsoft.Network/loadBalancers: Probes␊ - */␊ - probes?: (Probes4[] | string)␊ - /**␊ - * Microsoft.Network/loadBalancers: Inbound NAT rules␊ - */␊ - inboundNatRules?: (InboundNatRules4[] | string)␊ - /**␊ - * Microsoft.Network/loadBalancers: Inbound NAT pools␊ - */␊ - inboundNatPools?: (InboundNatPools4[] | string)␊ - /**␊ - * Microsoft.Network/loadBalancers: Outbound NAT rules␊ - */␊ - outboundNatRules?: (OutboundNatRules4[] | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface FrontendIPConfigurations4 {␊ - name: string␊ - properties: {␊ - subnet?: Id5␊ - privateIPAddress?: string␊ - privateIPAllocationMethod?: (("Dynamic" | "Static") | string)␊ - publicIPAddress?: Id5␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface BackendAddressPools4 {␊ - name: string␊ - }␊ - export interface LoadBalancingRules4 {␊ - name: string␊ - properties: {␊ - frontendIPConfiguration: Id5␊ - backendAddressPool: Id5␊ - protocol: (("Udp" | "Tcp") | string)␊ - frontendPort: (number | string)␊ - backendPort: (number | string)␊ - probe?: Id5␊ - enableFloatingIP?: (boolean | string)␊ - idleTimeoutInMinutes?: (number | string)␊ - loadDistribution?: (("Default" | "SourceIP" | "SourceIPProtocol") | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Probes4 {␊ - name: string␊ - properties: {␊ - protocol: (("Http" | "Tcp") | string)␊ - port: (number | string)␊ - requestPath?: string␊ - intervalInSeconds?: (number | string)␊ - numberOfProbes?: (number | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface InboundNatRules4 {␊ - name: string␊ - properties: {␊ - frontendIPConfiguration: Id5␊ - protocol: string␊ - frontendPort: (number | string)␊ - backendPort: (number | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface InboundNatPools4 {␊ - name: string␊ - properties: {␊ - frontendIPConfiguration: Id5␊ - protocol: string␊ - frontendPortRangeStart: (number | string)␊ - frontendPortRangeEnd: (number | string)␊ - backendPort: (number | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface OutboundNatRules4 {␊ - name: string␊ - properties: {␊ - frontendIPConfigurations: Id5[]␊ - backendAddressPool: Id5␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups␊ - */␊ - export interface NetworkSecurityGroups4 {␊ - type: "Microsoft.Network/networkSecurityGroups"␊ - apiVersion: "2016-10-01"␊ - name: string␊ - properties: {␊ - /**␊ - * Microsoft.Network/networkSecurityGroups: Security rules␊ - */␊ - securityRules: (SecurityRules4[] | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface SecurityRules4 {␊ - name: string␊ - properties: {␊ - description?: string␊ - protocol: (("Tcp" | "Udp" | "*") | string)␊ - sourcePortRange: string␊ - destinationPortRange: string␊ - sourceAddressPrefix: string␊ - destinationAddressPrefix: string␊ - access: (("Allow" | "Deny") | string)␊ - priority: (number | string)␊ - direction: (("Inbound" | "Outbound") | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces␊ - */␊ - export interface NetworkInterfaces5 {␊ - type: "Microsoft.Network/networkInterfaces"␊ - apiVersion: "2016-10-01"␊ - name: string␊ - properties: {␊ - /**␊ - * Microsoft.Network/networkInterfaces: Enable IP forwarding␊ - */␊ - enableIPForwarding?: (boolean | string)␊ - /**␊ - * Microsoft.Network/networkInterfaces: Network security group␊ - */␊ - networkSecurityGroup?: (Id5 | string)␊ - /**␊ - * Microsoft.Network/networkInterfaces: IP configurations␊ - */␊ - ipConfigurations: (IpConfiguration5[] | string)␊ - /**␊ - * Microsoft.Network/networkInterfaces: DNS settings␊ - */␊ - dnsSettings?: (NetworkInterfaceDnsSettings4 | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface IpConfiguration5 {␊ - name: string␊ - properties: {␊ - subnet: Id5␊ - privateIPAddress?: string␊ - privateIPAllocationMethod: (("Dynamic" | "Static") | string)␊ - publicIPAddress?: Id5␊ - loadBalancerBackendAddressPools?: Id5[]␊ - loadBalancerInboundNatRules?: Id5[]␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface NetworkInterfaceDnsSettings4 {␊ - dnsServers?: (string | string[])␊ - internalDnsNameLabel?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables␊ - */␊ - export interface RouteTables4 {␊ - type: "Microsoft.Network/routeTables"␊ - apiVersion: "2016-10-01"␊ - name: string␊ - properties: {␊ - /**␊ - * Microsoft.Network/routeTables: Routes␊ - */␊ - routes: (Routes4[] | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Routes4 {␊ - name: string␊ - properties: {␊ - addressPrefix: string␊ - nextHopType: (("VirtualNetworkGateway" | "VnetLocal" | "Internet" | "VirtualAppliance" | "HyperNetGateway" | "None") | string)␊ - nextHopIpAddress?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/publicIPAddresses␊ - */␊ - export interface PublicIPAddresses5 {␊ - type: "Microsoft.Network/publicIPAddresses"␊ - apiVersion: "2016-11-01"␊ - /**␊ - * Microsoft.Network/publicIPAddresses: Name␊ - */␊ - name: string␊ - properties: {␊ - /**␊ - * Microsoft.Network/publicIPAddresses: Public IP allocation method␊ - */␊ - publicIPAllocationMethod: (("Dynamic" | "Static") | string)␊ - /**␊ - * Microsoft.Network/publicIPAddresses: Idle timeout in minutes␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Microsoft.Network/publicIPAddresses: DNS settings␊ - */␊ - dnsSettings?: (PublicIPAddressDnsSettings5 | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface PublicIPAddressDnsSettings5 {␊ - domainNameLabel: string␊ - reverseFqdn?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks␊ - */␊ - export interface VirtualNetworks5 {␊ - type: "Microsoft.Network/virtualNetworks"␊ - apiVersion: "2016-11-01"␊ - /**␊ - * Microsoft.Network/virtualNetworks: Name␊ - */␊ - name: string␊ - properties: {␊ - /**␊ - * Microsoft.Network/virtualNetworks: Address space␊ - */␊ - addressSpace: (AddressSpace5 | string)␊ - /**␊ - * Microsoft.Network/virtualNetworks: DHCP options␊ - */␊ - dhcpOptions?: (DhcpOptions5 | string)␊ - /**␊ - * Microsoft.Network/virtualNetworks: Subnets␊ - */␊ - subnets: (Subnet7[] | string)␊ - /**␊ - * Microsoft.Network/virtualNetworks: Virtual Network Peerings␊ - */␊ - virtualNetworkPeerings?: (VirtualNetworkPeering5[] | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface AddressSpace5 {␊ - addressPrefixes: string[]␊ - [k: string]: unknown␊ - }␊ - export interface DhcpOptions5 {␊ - dnsServers: string[]␊ - [k: string]: unknown␊ - }␊ - export interface Subnet7 {␊ - name: string␊ - properties: {␊ - addressPrefix: string␊ - networkSecurityGroup?: Id6␊ - routeTable?: Id6␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Id6 {␊ - id: string␊ - [k: string]: unknown␊ - }␊ - export interface VirtualNetworkPeering5 {␊ - /**␊ - * Gets or sets the name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name: string␊ - properties: {␊ - allowVirtualNetworkAccess?: boolean␊ - allowForwardedTraffic?: boolean␊ - allowGatewayTransit?: boolean␊ - useRemoteGateways?: boolean␊ - remoteVirtualNetwork?: Id6␊ - /**␊ - * Gets the status of the virtual network peering␊ - */␊ - peeringState?: ((("Initiated" | "Connected" | "Disconnected") | string) & string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers␊ - */␊ - export interface LoadBalancers5 {␊ - type: "Microsoft.Network/loadBalancers"␊ - apiVersion: "2016-11-01"␊ - name: string␊ - properties: {␊ - /**␊ - * Microsoft.Network/loadBalancers: Frontend IP configurations␊ - */␊ - frontendIPConfigurations: (FrontendIPConfigurations5[] | string)␊ - /**␊ - * Microsoft.Network/loadBalancers: Backend address pools␊ - */␊ - backendAddressPools?: (BackendAddressPools5[] | string)␊ - /**␊ - * Microsoft.Network/loadBalancers: Load balancing rules␊ - */␊ - loadBalancingRules?: (LoadBalancingRules5[] | string)␊ - /**␊ - * Microsoft.Network/loadBalancers: Probes␊ - */␊ - probes?: (Probes5[] | string)␊ - /**␊ - * Microsoft.Network/loadBalancers: Inbound NAT rules␊ - */␊ - inboundNatRules?: (InboundNatRules5[] | string)␊ - /**␊ - * Microsoft.Network/loadBalancers: Inbound NAT pools␊ - */␊ - inboundNatPools?: (InboundNatPools5[] | string)␊ - /**␊ - * Microsoft.Network/loadBalancers: Outbound NAT rules␊ - */␊ - outboundNatRules?: (OutboundNatRules5[] | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface FrontendIPConfigurations5 {␊ - name: string␊ - properties: {␊ - subnet?: Id6␊ - privateIPAddress?: string␊ - privateIPAllocationMethod?: (("Dynamic" | "Static") | string)␊ - publicIPAddress?: Id6␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface BackendAddressPools5 {␊ - name: string␊ - }␊ - export interface LoadBalancingRules5 {␊ - name: string␊ - properties: {␊ - frontendIPConfiguration: Id6␊ - backendAddressPool: Id6␊ - protocol: (("Udp" | "Tcp") | string)␊ - frontendPort: (number | string)␊ - backendPort: (number | string)␊ - probe?: Id6␊ - enableFloatingIP?: (boolean | string)␊ - idleTimeoutInMinutes?: (number | string)␊ - loadDistribution?: (("Default" | "SourceIP" | "SourceIPProtocol") | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Probes5 {␊ - name: string␊ - properties: {␊ - protocol: (("Http" | "Tcp") | string)␊ - port: (number | string)␊ - requestPath?: string␊ - intervalInSeconds?: (number | string)␊ - numberOfProbes?: (number | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface InboundNatRules5 {␊ - name: string␊ - properties: {␊ - frontendIPConfiguration: Id6␊ - protocol: string␊ - frontendPort: (number | string)␊ - backendPort: (number | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface InboundNatPools5 {␊ - name: string␊ - properties: {␊ - frontendIPConfiguration: Id6␊ - protocol: string␊ - frontendPortRangeStart: (number | string)␊ - frontendPortRangeEnd: (number | string)␊ - backendPort: (number | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface OutboundNatRules5 {␊ - name: string␊ - properties: {␊ - frontendIPConfigurations: Id6[]␊ - backendAddressPool: Id6␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups␊ - */␊ - export interface NetworkSecurityGroups5 {␊ - type: "Microsoft.Network/networkSecurityGroups"␊ - apiVersion: "2016-11-01"␊ - name: string␊ - properties: {␊ - /**␊ - * Microsoft.Network/networkSecurityGroups: Security rules␊ - */␊ - securityRules: (SecurityRules5[] | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface SecurityRules5 {␊ - name: string␊ - properties: {␊ - description?: string␊ - protocol: (("Tcp" | "Udp" | "*") | string)␊ - sourcePortRange: string␊ - destinationPortRange: string␊ - sourceAddressPrefix: string␊ - destinationAddressPrefix: string␊ - access: (("Allow" | "Deny") | string)␊ - priority: (number | string)␊ - direction: (("Inbound" | "Outbound") | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces␊ - */␊ - export interface NetworkInterfaces6 {␊ - type: "Microsoft.Network/networkInterfaces"␊ - apiVersion: "2016-11-01"␊ - name: string␊ - properties: {␊ - /**␊ - * Microsoft.Network/networkInterfaces: Enable IP forwarding␊ - */␊ - enableIPForwarding?: (boolean | string)␊ - /**␊ - * Microsoft.Network/networkInterfaces: Network security group␊ - */␊ - networkSecurityGroup?: (Id6 | string)␊ - /**␊ - * Microsoft.Network/networkInterfaces: IP configurations␊ - */␊ - ipConfigurations: (IpConfiguration6[] | string)␊ - /**␊ - * Microsoft.Network/networkInterfaces: DNS settings␊ - */␊ - dnsSettings?: (NetworkInterfaceDnsSettings5 | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface IpConfiguration6 {␊ - name: string␊ - properties: {␊ - subnet: Id6␊ - privateIPAddress?: string␊ - privateIPAllocationMethod: (("Dynamic" | "Static") | string)␊ - publicIPAddress?: Id6␊ - loadBalancerBackendAddressPools?: Id6[]␊ - loadBalancerInboundNatRules?: Id6[]␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface NetworkInterfaceDnsSettings5 {␊ - dnsServers?: (string | string[])␊ - internalDnsNameLabel?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables␊ - */␊ - export interface RouteTables5 {␊ - type: "Microsoft.Network/routeTables"␊ - apiVersion: "2016-11-01"␊ - name: string␊ - properties: {␊ - /**␊ - * Microsoft.Network/routeTables: Routes␊ - */␊ - routes: (Routes5[] | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Routes5 {␊ - name: string␊ - properties: {␊ - addressPrefix: string␊ - nextHopType: (("VirtualNetworkGateway" | "VnetLocal" | "Internet" | "VirtualAppliance" | "HyperNetGateway" | "None") | string)␊ - nextHopIpAddress?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/publicIPAddresses␊ - */␊ - export interface PublicIPAddresses6 {␊ - type: "Microsoft.Network/publicIPAddresses"␊ - apiVersion: "2016-12-01"␊ - /**␊ - * Microsoft.Network/publicIPAddresses: Name␊ - */␊ - name: string␊ - properties: {␊ - /**␊ - * Microsoft.Network/publicIPAddresses: Public IP allocation method␊ - */␊ - publicIPAllocationMethod: (("Dynamic" | "Static") | string)␊ - /**␊ - * Microsoft.Network/publicIPAddresses: Idle timeout in minutes␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Microsoft.Network/publicIPAddresses: DNS settings␊ - */␊ - dnsSettings?: (PublicIPAddressDnsSettings6 | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface PublicIPAddressDnsSettings6 {␊ - domainNameLabel: string␊ - reverseFqdn?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks␊ - */␊ - export interface VirtualNetworks6 {␊ - type: "Microsoft.Network/virtualNetworks"␊ - apiVersion: "2016-12-01"␊ - /**␊ - * Microsoft.Network/virtualNetworks: Name␊ - */␊ - name: string␊ - properties: {␊ - /**␊ - * Microsoft.Network/virtualNetworks: Address space␊ - */␊ - addressSpace: (AddressSpace6 | string)␊ - /**␊ - * Microsoft.Network/virtualNetworks: DHCP options␊ - */␊ - dhcpOptions?: (DhcpOptions6 | string)␊ - /**␊ - * Microsoft.Network/virtualNetworks: Subnets␊ - */␊ - subnets: (Subnet8[] | string)␊ - /**␊ - * Microsoft.Network/virtualNetworks: Virtual Network Peerings␊ - */␊ - virtualNetworkPeerings?: (VirtualNetworkPeering6[] | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface AddressSpace6 {␊ - addressPrefixes: string[]␊ - [k: string]: unknown␊ - }␊ - export interface DhcpOptions6 {␊ - dnsServers: string[]␊ - [k: string]: unknown␊ - }␊ - export interface Subnet8 {␊ - name: string␊ - properties: {␊ - addressPrefix: string␊ - networkSecurityGroup?: Id7␊ - routeTable?: Id7␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Id7 {␊ - id: string␊ - [k: string]: unknown␊ - }␊ - export interface VirtualNetworkPeering6 {␊ - /**␊ - * Gets or sets the name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name: string␊ - properties: {␊ - allowVirtualNetworkAccess?: boolean␊ - allowForwardedTraffic?: boolean␊ - allowGatewayTransit?: boolean␊ - useRemoteGateways?: boolean␊ - remoteVirtualNetwork?: Id7␊ - /**␊ - * Gets the status of the virtual network peering␊ - */␊ - peeringState?: ((("Initiated" | "Connected" | "Disconnected") | string) & string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers␊ - */␊ - export interface LoadBalancers6 {␊ - type: "Microsoft.Network/loadBalancers"␊ - apiVersion: "2016-12-01"␊ - name: string␊ - properties: {␊ - /**␊ - * Microsoft.Network/loadBalancers: Frontend IP configurations␊ - */␊ - frontendIPConfigurations: (FrontendIPConfigurations6[] | string)␊ - /**␊ - * Microsoft.Network/loadBalancers: Backend address pools␊ - */␊ - backendAddressPools?: (BackendAddressPools6[] | string)␊ - /**␊ - * Microsoft.Network/loadBalancers: Load balancing rules␊ - */␊ - loadBalancingRules?: (LoadBalancingRules6[] | string)␊ - /**␊ - * Microsoft.Network/loadBalancers: Probes␊ - */␊ - probes?: (Probes6[] | string)␊ - /**␊ - * Microsoft.Network/loadBalancers: Inbound NAT rules␊ - */␊ - inboundNatRules?: (InboundNatRules6[] | string)␊ - /**␊ - * Microsoft.Network/loadBalancers: Inbound NAT pools␊ - */␊ - inboundNatPools?: (InboundNatPools6[] | string)␊ - /**␊ - * Microsoft.Network/loadBalancers: Outbound NAT rules␊ - */␊ - outboundNatRules?: (OutboundNatRules6[] | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface FrontendIPConfigurations6 {␊ - name: string␊ - properties: {␊ - subnet?: Id7␊ - privateIPAddress?: string␊ - privateIPAllocationMethod?: (("Dynamic" | "Static") | string)␊ - publicIPAddress?: Id7␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface BackendAddressPools6 {␊ - name: string␊ - }␊ - export interface LoadBalancingRules6 {␊ - name: string␊ - properties: {␊ - frontendIPConfiguration: Id7␊ - backendAddressPool: Id7␊ - protocol: (("Udp" | "Tcp") | string)␊ - frontendPort: (number | string)␊ - backendPort: (number | string)␊ - probe?: Id7␊ - enableFloatingIP?: (boolean | string)␊ - idleTimeoutInMinutes?: (number | string)␊ - loadDistribution?: (("Default" | "SourceIP" | "SourceIPProtocol") | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Probes6 {␊ - name: string␊ - properties: {␊ - protocol: (("Http" | "Tcp") | string)␊ - port: (number | string)␊ - requestPath?: string␊ - intervalInSeconds?: (number | string)␊ - numberOfProbes?: (number | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface InboundNatRules6 {␊ - name: string␊ - properties: {␊ - frontendIPConfiguration: Id7␊ - protocol: string␊ - frontendPort: (number | string)␊ - backendPort: (number | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface InboundNatPools6 {␊ - name: string␊ - properties: {␊ - frontendIPConfiguration: Id7␊ - protocol: string␊ - frontendPortRangeStart: (number | string)␊ - frontendPortRangeEnd: (number | string)␊ - backendPort: (number | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface OutboundNatRules6 {␊ - name: string␊ - properties: {␊ - frontendIPConfigurations: Id7[]␊ - backendAddressPool: Id7␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups␊ - */␊ - export interface NetworkSecurityGroups6 {␊ - type: "Microsoft.Network/networkSecurityGroups"␊ - apiVersion: "2016-12-01"␊ - name: string␊ - properties: {␊ - /**␊ - * Microsoft.Network/networkSecurityGroups: Security rules␊ - */␊ - securityRules: (SecurityRules6[] | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface SecurityRules6 {␊ - name: string␊ - properties: {␊ - description?: string␊ - protocol: (("Tcp" | "Udp" | "*") | string)␊ - sourcePortRange: string␊ - destinationPortRange: string␊ - sourceAddressPrefix: string␊ - destinationAddressPrefix: string␊ - access: (("Allow" | "Deny") | string)␊ - priority: (number | string)␊ - direction: (("Inbound" | "Outbound") | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces␊ - */␊ - export interface NetworkInterfaces7 {␊ - type: "Microsoft.Network/networkInterfaces"␊ - apiVersion: "2016-12-01"␊ - name: string␊ - properties: {␊ - /**␊ - * Microsoft.Network/networkInterfaces: Enable IP forwarding␊ - */␊ - enableIPForwarding?: (boolean | string)␊ - /**␊ - * Microsoft.Network/networkInterfaces: Network security group␊ - */␊ - networkSecurityGroup?: (Id7 | string)␊ - /**␊ - * Microsoft.Network/networkInterfaces: IP configurations␊ - */␊ - ipConfigurations: (IpConfiguration7[] | string)␊ - /**␊ - * Microsoft.Network/networkInterfaces: DNS settings␊ - */␊ - dnsSettings?: (NetworkInterfaceDnsSettings6 | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface IpConfiguration7 {␊ - name: string␊ - properties: {␊ - subnet: Id7␊ - privateIPAddress?: string␊ - privateIPAllocationMethod: (("Dynamic" | "Static") | string)␊ - publicIPAddress?: Id7␊ - loadBalancerBackendAddressPools?: Id7[]␊ - loadBalancerInboundNatRules?: Id7[]␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface NetworkInterfaceDnsSettings6 {␊ - dnsServers?: (string | string[])␊ - internalDnsNameLabel?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables␊ - */␊ - export interface RouteTables6 {␊ - type: "Microsoft.Network/routeTables"␊ - apiVersion: "2016-12-01"␊ - name: string␊ - properties: {␊ - /**␊ - * Microsoft.Network/routeTables: Routes␊ - */␊ - routes: (Routes6[] | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Routes6 {␊ - name: string␊ - properties: {␊ - addressPrefix: string␊ - nextHopType: (("VirtualNetworkGateway" | "VnetLocal" | "Internet" | "VirtualAppliance" | "HyperNetGateway" | "None") | string)␊ - nextHopIpAddress?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/publicIPAddresses␊ - */␊ - export interface PublicIPAddresses7 {␊ - type: "Microsoft.Network/publicIPAddresses"␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Microsoft.Network/publicIPAddresses: Name␊ - */␊ - name: string␊ - properties: {␊ - /**␊ - * Microsoft.Network/publicIPAddresses: Public IP allocation method␊ - */␊ - publicIPAllocationMethod: (("Dynamic" | "Static") | string)␊ - /**␊ - * Microsoft.Network/publicIPAddresses: Idle timeout in minutes␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Microsoft.Network/publicIPAddresses: DNS settings␊ - */␊ - dnsSettings?: (PublicIPAddressDnsSettings7 | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface PublicIPAddressDnsSettings7 {␊ - domainNameLabel: string␊ - reverseFqdn?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks␊ - */␊ - export interface VirtualNetworks7 {␊ - type: "Microsoft.Network/virtualNetworks"␊ - apiVersion: "2017-03-01"␊ - /**␊ - * Microsoft.Network/virtualNetworks: Name␊ - */␊ - name: string␊ - properties: {␊ - /**␊ - * Microsoft.Network/virtualNetworks: Address space␊ - */␊ - addressSpace: (AddressSpace7 | string)␊ - /**␊ - * Microsoft.Network/virtualNetworks: DHCP options␊ - */␊ - dhcpOptions?: (DhcpOptions7 | string)␊ - /**␊ - * Microsoft.Network/virtualNetworks: Subnets␊ - */␊ - subnets: (Subnet9[] | string)␊ - /**␊ - * Microsoft.Network/virtualNetworks: Virtual Network Peerings␊ - */␊ - virtualNetworkPeerings?: (VirtualNetworkPeering7[] | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface AddressSpace7 {␊ - addressPrefixes: string[]␊ - [k: string]: unknown␊ - }␊ - export interface DhcpOptions7 {␊ - dnsServers: string[]␊ - [k: string]: unknown␊ - }␊ - export interface Subnet9 {␊ - name: string␊ - properties: {␊ - addressPrefix: string␊ - networkSecurityGroup?: Id8␊ - routeTable?: Id8␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Id8 {␊ - id: string␊ - [k: string]: unknown␊ - }␊ - export interface VirtualNetworkPeering7 {␊ - /**␊ - * Gets or sets the name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name: string␊ - properties: {␊ - allowVirtualNetworkAccess?: boolean␊ - allowForwardedTraffic?: boolean␊ - allowGatewayTransit?: boolean␊ - useRemoteGateways?: boolean␊ - remoteVirtualNetwork?: Id8␊ - /**␊ - * Gets the status of the virtual network peering␊ - */␊ - peeringState?: ((("Initiated" | "Connected" | "Disconnected") | string) & string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers␊ - */␊ - export interface LoadBalancers7 {␊ - type: "Microsoft.Network/loadBalancers"␊ - apiVersion: "2017-03-01"␊ - name: string␊ - properties: {␊ - /**␊ - * Microsoft.Network/loadBalancers: Frontend IP configurations␊ - */␊ - frontendIPConfigurations: (FrontendIPConfigurations7[] | string)␊ - /**␊ - * Microsoft.Network/loadBalancers: Backend address pools␊ - */␊ - backendAddressPools?: (BackendAddressPools7[] | string)␊ - /**␊ - * Microsoft.Network/loadBalancers: Load balancing rules␊ - */␊ - loadBalancingRules?: (LoadBalancingRules7[] | string)␊ - /**␊ - * Microsoft.Network/loadBalancers: Probes␊ - */␊ - probes?: (Probes7[] | string)␊ - /**␊ - * Microsoft.Network/loadBalancers: Inbound NAT rules␊ - */␊ - inboundNatRules?: (InboundNatRules7[] | string)␊ - /**␊ - * Microsoft.Network/loadBalancers: Inbound NAT pools␊ - */␊ - inboundNatPools?: (InboundNatPools7[] | string)␊ - /**␊ - * Microsoft.Network/loadBalancers: Outbound NAT rules␊ - */␊ - outboundNatRules?: (OutboundNatRules7[] | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface FrontendIPConfigurations7 {␊ - name: string␊ - properties: {␊ - subnet?: Id8␊ - privateIPAddress?: string␊ - privateIPAllocationMethod?: (("Dynamic" | "Static") | string)␊ - publicIPAddress?: Id8␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface BackendAddressPools7 {␊ - name: string␊ - }␊ - export interface LoadBalancingRules7 {␊ - name: string␊ - properties: {␊ - frontendIPConfiguration: Id8␊ - backendAddressPool: Id8␊ - protocol: (("Udp" | "Tcp") | string)␊ - frontendPort: (number | string)␊ - backendPort: (number | string)␊ - probe?: Id8␊ - enableFloatingIP?: (boolean | string)␊ - idleTimeoutInMinutes?: (number | string)␊ - loadDistribution?: (("Default" | "SourceIP" | "SourceIPProtocol") | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Probes7 {␊ - name: string␊ - properties: {␊ - protocol: (("Http" | "Tcp") | string)␊ - port: (number | string)␊ - requestPath?: string␊ - intervalInSeconds?: (number | string)␊ - numberOfProbes?: (number | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface InboundNatRules7 {␊ - name: string␊ - properties: {␊ - frontendIPConfiguration: Id8␊ - protocol: string␊ - frontendPort: (number | string)␊ - backendPort: (number | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface InboundNatPools7 {␊ - name: string␊ - properties: {␊ - frontendIPConfiguration: Id8␊ - protocol: string␊ - frontendPortRangeStart: (number | string)␊ - frontendPortRangeEnd: (number | string)␊ - backendPort: (number | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface OutboundNatRules7 {␊ - name: string␊ - properties: {␊ - frontendIPConfigurations: Id8[]␊ - backendAddressPool: Id8␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups␊ - */␊ - export interface NetworkSecurityGroups7 {␊ - type: "Microsoft.Network/networkSecurityGroups"␊ - apiVersion: "2017-03-01"␊ - name: string␊ - properties: {␊ - /**␊ - * Microsoft.Network/networkSecurityGroups: Security rules␊ - */␊ - securityRules: (SecurityRules7[] | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface SecurityRules7 {␊ - name: string␊ - properties: {␊ - description?: string␊ - protocol: (("Tcp" | "Udp" | "*") | string)␊ - sourcePortRange: string␊ - destinationPortRange: string␊ - sourceAddressPrefix: string␊ - destinationAddressPrefix: string␊ - access: (("Allow" | "Deny") | string)␊ - priority: (number | string)␊ - direction: (("Inbound" | "Outbound") | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces␊ - */␊ - export interface NetworkInterfaces8 {␊ - type: "Microsoft.Network/networkInterfaces"␊ - apiVersion: "2017-03-01"␊ - name: string␊ - properties: {␊ - /**␊ - * Microsoft.Network/networkInterfaces: Enable IP forwarding␊ - */␊ - enableIPForwarding?: (boolean | string)␊ - /**␊ - * Microsoft.Network/networkInterfaces: Network security group␊ - */␊ - networkSecurityGroup?: (Id8 | string)␊ - /**␊ - * Microsoft.Network/networkInterfaces: IP configurations␊ - */␊ - ipConfigurations: (IpConfiguration8[] | string)␊ - /**␊ - * Microsoft.Network/networkInterfaces: DNS settings␊ - */␊ - dnsSettings?: (NetworkInterfaceDnsSettings7 | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface IpConfiguration8 {␊ - name: string␊ - properties: {␊ - subnet: Id8␊ - privateIPAddress?: string␊ - privateIPAllocationMethod: (("Dynamic" | "Static") | string)␊ - publicIPAddress?: Id8␊ - loadBalancerBackendAddressPools?: Id8[]␊ - loadBalancerInboundNatRules?: Id8[]␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface NetworkInterfaceDnsSettings7 {␊ - dnsServers?: (string | string[])␊ - internalDnsNameLabel?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables␊ - */␊ - export interface RouteTables7 {␊ - type: "Microsoft.Network/routeTables"␊ - apiVersion: "2017-03-01"␊ - name: string␊ - properties: {␊ - /**␊ - * Microsoft.Network/routeTables: Routes␊ - */␊ - routes: (Routes7[] | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Routes7 {␊ - name: string␊ - properties: {␊ - addressPrefix: string␊ - nextHopType: (("VirtualNetworkGateway" | "VnetLocal" | "Internet" | "VirtualAppliance" | "HyperNetGateway" | "None") | string)␊ - nextHopIpAddress?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/publicIPAddresses␊ - */␊ - export interface PublicIPAddresses8 {␊ - name: string␊ - type: "Microsoft.Network/publicIPAddresses"␊ - apiVersion: "2017-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (PublicIPAddressPropertiesFormat | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Public IP address properties.␊ - */␊ - export interface PublicIPAddressPropertiesFormat {␊ - /**␊ - * The public IP allocation method. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - publicIPAllocationMethod: (("Static" | "Dynamic") | string)␊ - /**␊ - * The public IP address version. Possible values are: 'IPv4' and 'IPv6'.␊ - */␊ - publicIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The FQDN of the DNS record associated with the public IP address.␊ - */␊ - dnsSettings?: (PublicIPAddressDnsSettings8 | string)␊ - ipAddress?: string␊ - /**␊ - * The idle timeout of the public IP address.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * The resource GUID property of the public IP resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains FQDN of the DNS record associated with the public IP address␊ - */␊ - export interface PublicIPAddressDnsSettings8 {␊ - /**␊ - * Gets or sets the Domain name label.The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.␊ - */␊ - domainNameLabel: string␊ - /**␊ - * Gets the FQDN, Fully qualified domain name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone.␊ - */␊ - fqdn?: string␊ - /**␊ - * Gets or Sets the Reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN. ␊ - */␊ - reverseFqdn?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks␊ - */␊ - export interface VirtualNetworks8 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks"␊ - apiVersion: "2017-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (VirtualNetworkPropertiesFormat | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: (VirtualNetworksVirtualNetworkPeeringsChildResource | VirtualNetworksSubnetsChildResource)[]␊ - [k: string]: unknown␊ - }␊ - export interface VirtualNetworkPropertiesFormat {␊ - /**␊ - * The AddressSpace that contains an array of IP address ranges that can be used by subnets.␊ - */␊ - addressSpace: (AddressSpace8 | string)␊ - /**␊ - * The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network.␊ - */␊ - dhcpOptions?: (DhcpOptions8 | string)␊ - /**␊ - * A list of subnets in a Virtual Network.␊ - */␊ - subnets?: (Subnet10[] | string)␊ - /**␊ - * A list of peerings in a Virtual Network.␊ - */␊ - virtualNetworkPeerings?: (VirtualNetworkPeering8[] | string)␊ - /**␊ - * The resourceGuid property of the Virtual Network resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.␊ - */␊ - export interface AddressSpace8 {␊ - /**␊ - * A list of address blocks reserved for this virtual network in CIDR notation.␊ - */␊ - addressPrefixes: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DhcpOptions contains an array of DNS servers available to VMs deployed in the virtual network. Standard DHCP option for a subnet overrides VNET DHCP options.␊ - */␊ - export interface DhcpOptions8 {␊ - /**␊ - * The list of DNS servers IP addresses.␊ - */␊ - dnsServers: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Subnet in a virtual network resource.␊ - */␊ - export interface Subnet10 {␊ - properties?: (SubnetPropertiesFormat | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - export interface SubnetPropertiesFormat {␊ - /**␊ - * The address prefix for the subnet.␊ - */␊ - addressPrefix: string␊ - /**␊ - * The reference of the NetworkSecurityGroup resource.␊ - */␊ - networkSecurityGroup?: (SubResource4 | string)␊ - /**␊ - * The reference of the RouteTable resource.␊ - */␊ - routeTable?: (SubResource4 | string)␊ - /**␊ - * An array of private access services values.␊ - */␊ - privateAccessServices?: (PrivateAccessServicePropertiesFormat[] | string)␊ - /**␊ - * Gets an array of references to the external resources using subnet.␊ - */␊ - resourceNavigationLinks?: (ResourceNavigationLink[] | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - export interface SubResource4 {␊ - /**␊ - * Resource ID.␊ - */␊ - id: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The private access service properties.␊ - */␊ - export interface PrivateAccessServicePropertiesFormat {␊ - /**␊ - * The type of the private access.␊ - */␊ - service?: string␊ - /**␊ - * A list of locations.␊ - */␊ - locations?: (string[] | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ResourceNavigationLink resource.␊ - */␊ - export interface ResourceNavigationLink {␊ - properties?: (ResourceNavigationLinkFormat | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ResourceNavigationLink.␊ - */␊ - export interface ResourceNavigationLinkFormat {␊ - /**␊ - * Resource type of the linked resource.␊ - */␊ - linkedResourceType?: string␊ - /**␊ - * Link to the external resource␊ - */␊ - link?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peerings in a virtual network resource.␊ - */␊ - export interface VirtualNetworkPeering8 {␊ - properties?: (VirtualNetworkPeeringPropertiesFormat | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - export interface VirtualNetworkPeeringPropertiesFormat {␊ - /**␊ - * Whether the VMs in the linked virtual network space would be able to access all the VMs in local Virtual network space.␊ - */␊ - allowVirtualNetworkAccess?: (boolean | string)␊ - /**␊ - * Whether the forwarded traffic from the VMs in the remote virtual network will be allowed/disallowed.␊ - */␊ - allowForwardedTraffic?: (boolean | string)␊ - /**␊ - * If gateway links can be used in remote virtual networking to link to this virtual network.␊ - */␊ - allowGatewayTransit?: (boolean | string)␊ - /**␊ - * If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway.␊ - */␊ - useRemoteGateways?: (boolean | string)␊ - /**␊ - * The reference of the remote virtual network.␊ - */␊ - remoteVirtualNetwork: (SubResource4 | string)␊ - /**␊ - * The status of the virtual network peering. Possible values are 'Initiated', 'Connected', and 'Disconnected'.␊ - */␊ - peeringState?: (("Initiated" | "Connected" | "Disconnected") | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/virtualNetworkPeerings␊ - */␊ - export interface VirtualNetworksVirtualNetworkPeeringsChildResource {␊ - name: string␊ - type: "virtualNetworkPeerings"␊ - apiVersion: "2017-06-01"␊ - properties: (VirtualNetworkPeeringPropertiesFormat | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnetsChildResource {␊ - name: string␊ - type: "subnets"␊ - apiVersion: "2017-06-01"␊ - properties: (SubnetPropertiesFormat | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers␊ - */␊ - export interface LoadBalancers8 {␊ - name: string␊ - type: "Microsoft.Network/loadBalancers"␊ - apiVersion: "2017-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (LoadBalancerPropertiesFormat | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer.␊ - */␊ - export interface LoadBalancerPropertiesFormat {␊ - /**␊ - * Object representing the frontend IPs to be used for the load balancer␊ - */␊ - frontendIPConfigurations?: (FrontendIPConfiguration[] | string)␊ - /**␊ - * Collection of backend address pools used by a load balancer␊ - */␊ - backendAddressPools?: (BackendAddressPool[] | string)␊ - /**␊ - * Object collection representing the load balancing rules Gets the provisioning ␊ - */␊ - loadBalancingRules?: (LoadBalancingRule[] | string)␊ - /**␊ - * Collection of probe objects used in the load balancer␊ - */␊ - probes?: (Probe[] | string)␊ - /**␊ - * Collection of inbound NAT Rules used by a load balancer. Defining inbound NAT rules on your load balancer is mutually exclusive with defining an inbound NAT pool. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an Inbound NAT pool. They have to reference individual inbound NAT rules.␊ - */␊ - inboundNatRules?: (InboundNatRule1[] | string)␊ - /**␊ - * Defines an external port range for inbound NAT to a single backend port on NICs associated with a load balancer. Inbound NAT rules are created automatically for each NIC associated with the Load Balancer using an external port from this range. Defining an Inbound NAT pool on your Load Balancer is mutually exclusive with defining inbound Nat rules. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an inbound NAT pool. They have to reference individual inbound NAT rules.␊ - */␊ - inboundNatPools?: (InboundNatPool1[] | string)␊ - /**␊ - * The outbound NAT rules.␊ - */␊ - outboundNatRules?: (OutboundNatRule[] | string)␊ - /**␊ - * The resource GUID property of the load balancer resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP address of the load balancer.␊ - */␊ - export interface FrontendIPConfiguration {␊ - properties?: (FrontendIPConfigurationPropertiesFormat | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP Configuration of the load balancer.␊ - */␊ - export interface FrontendIPConfigurationPropertiesFormat {␊ - /**␊ - * The private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The Private IP allocation method. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * The reference of the subnet resource.␊ - */␊ - subnet?: (SubResource4 | string)␊ - /**␊ - * The reference of the Public IP resource.␊ - */␊ - publicIPAddress?: (SubResource4 | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Pool of backend IP addresses.␊ - */␊ - export interface BackendAddressPool {␊ - properties?: (BackendAddressPoolPropertiesFormat | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the backend address pool.␊ - */␊ - export interface BackendAddressPoolPropertiesFormat {␊ - /**␊ - * Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A loag balancing rule for a load balancer.␊ - */␊ - export interface LoadBalancingRule {␊ - properties?: (LoadBalancingRulePropertiesFormat | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer.␊ - */␊ - export interface LoadBalancingRulePropertiesFormat {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource4 | string)␊ - /**␊ - * A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs.␊ - */␊ - backendAddressPool?: (SubResource4 | string)␊ - /**␊ - * The reference of the load balancer probe used by the load balancing rule.␊ - */␊ - probe?: (SubResource4 | string)␊ - /**␊ - * The transport protocol for the external endpoint. Possible values are 'Udp' or 'Tcp'.␊ - */␊ - protocol: (("Udp" | "Tcp") | string)␊ - /**␊ - * The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'.␊ - */␊ - loadDistribution?: (("Default" | "SourceIP" | "SourceIPProtocol") | string)␊ - /**␊ - * The port for the external endpoint. Port numbers for each Rule must be unique within the Load Balancer. Acceptable values are between 1 and 65534.␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. ␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A load balancer probe.␊ - */␊ - export interface Probe {␊ - properties?: (ProbePropertiesFormat | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - export interface ProbePropertiesFormat {␊ - /**␊ - * The protocol of the end point. Possible values are: 'Http' or 'Tcp'. If 'Tcp' is specified, a received ACK is required for the probe to be successful. If 'Http' is specified, a 200 OK response from the specifies URI is required for the probe to be successful.␊ - */␊ - protocol: (("Http" | "Tcp") | string)␊ - /**␊ - * The port for communicating the probe. Possible values range from 1 to 65535, inclusive.␊ - */␊ - port: (number | string)␊ - /**␊ - * The interval, in seconds, for how frequently to probe the endpoint for health status. Typically, the interval is slightly less than half the allocated timeout period (in seconds) which allows two full probes before taking the instance out of rotation. The default value is 15, the minimum value is 5.␊ - */␊ - intervalInSeconds?: (number | string)␊ - /**␊ - * The number of probes where if no response, will result in stopping further traffic from being delivered to the endpoint. This values allows endpoints to be taken out of rotation faster or slower than the typical times used in Azure.␊ - */␊ - numberOfProbes: (number | string)␊ - /**␊ - * The URI used for requesting health status from the VM. Path is required if a protocol is set to http. Otherwise, it is not allowed. There is no default value.␊ - */␊ - requestPath?: string␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT rule of the load balancer.␊ - */␊ - export interface InboundNatRule1 {␊ - properties?: (InboundNatRulePropertiesFormat | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the inbound NAT rule.␊ - */␊ - export interface InboundNatRulePropertiesFormat {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource4 | string)␊ - /**␊ - * The transport protocol for the endpoint. Possible values are: 'Udp' or 'Tcp'.␊ - */␊ - protocol: (("Udp" | "Tcp") | string)␊ - /**␊ - * The port for the external endpoint. Port numbers for each Rule must be unique within the Load Balancer. Acceptable values range from 1 to 65534.␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * The port used for the internal endpoint. Acceptable values range from 1 to 65535.␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT pool of the load balancer.␊ - */␊ - export interface InboundNatPool1 {␊ - properties?: (InboundNatPoolPropertiesFormat | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Inbound NAT pool.␊ - */␊ - export interface InboundNatPoolPropertiesFormat {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource4 | string)␊ - /**␊ - * The transport protocol for the endpoint. Possible values are: 'Udp' or 'Tcp'.␊ - */␊ - protocol: (("Udp" | "Tcp") | string)␊ - /**␊ - * The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65534.␊ - */␊ - frontendPortRangeStart: (number | string)␊ - /**␊ - * The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65535.␊ - */␊ - frontendPortRangeEnd: (number | string)␊ - /**␊ - * The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound NAT pool of the load balancer.␊ - */␊ - export interface OutboundNatRule {␊ - properties?: (OutboundNatRulePropertiesFormat | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound NAT pool of the load balancer.␊ - */␊ - export interface OutboundNatRulePropertiesFormat {␊ - /**␊ - * The number of outbound ports to be used for NAT.␊ - */␊ - allocatedOutboundPorts?: (number | string)␊ - /**␊ - * The Frontend IP addresses of the load balancer.␊ - */␊ - frontendIPConfigurations?: (SubResource4[] | string)␊ - /**␊ - * A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs.␊ - */␊ - backendAddressPool: (SubResource4 | string)␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups␊ - */␊ - export interface NetworkSecurityGroups8 {␊ - name: string␊ - type: "Microsoft.Network/networkSecurityGroups"␊ - apiVersion: "2017-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (NetworkSecurityGroupPropertiesFormat | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: NetworkSecurityGroupsSecurityRulesChildResource[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network Security Group resource.␊ - */␊ - export interface NetworkSecurityGroupPropertiesFormat {␊ - /**␊ - * A collection of security rules of the network security group.␊ - */␊ - securityRules?: (SecurityRule[] | string)␊ - /**␊ - * The default security rules of network security group.␊ - */␊ - defaultSecurityRules?: (SecurityRule[] | string)␊ - /**␊ - * The resource GUID property of the network security group resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network security rule.␊ - */␊ - export interface SecurityRule {␊ - properties?: (SecurityRulePropertiesFormat | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - export interface SecurityRulePropertiesFormat {␊ - /**␊ - * A description for this rule. Restricted to 140 chars.␊ - */␊ - description?: string␊ - /**␊ - * Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'.␊ - */␊ - protocol: (("Tcp" | "Udp" | "*") | string)␊ - /**␊ - * The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports.␊ - */␊ - sourcePortRange?: string␊ - /**␊ - * The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports.␊ - */␊ - destinationPortRange?: string␊ - /**␊ - * The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. ␊ - */␊ - sourceAddressPrefix?: string␊ - /**␊ - * The CIDR or source IP ranges.␊ - */␊ - sourceAddressPrefixes?: (string[] | string)␊ - /**␊ - * The destination address prefix. CIDR or destination IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used.␊ - */␊ - destinationAddressPrefix?: string␊ - /**␊ - * The destination address prefixes. CIDR or destination IP rangees.␊ - */␊ - destinationAddressPrefixes?: (string[] | string)␊ - /**␊ - * The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'.␊ - */␊ - access: (("Allow" | "Deny") | string)␊ - /**␊ - * The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.␊ - */␊ - priority: (number | string)␊ - /**␊ - * The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'.␊ - */␊ - direction: (("Inbound" | "Outbound") | string)␊ - /**␊ - * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRulesChildResource {␊ - name: string␊ - type: "securityRules"␊ - apiVersion: "2017-06-01"␊ - properties: (SecurityRulePropertiesFormat | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces␊ - */␊ - export interface NetworkInterfaces9 {␊ - name: string␊ - type: "Microsoft.Network/networkInterfaces"␊ - apiVersion: "2017-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (NetworkInterfacePropertiesFormat | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NetworkInterface properties. ␊ - */␊ - export interface NetworkInterfacePropertiesFormat {␊ - /**␊ - * The reference of the NetworkSecurityGroup resource.␊ - */␊ - networkSecurityGroup?: (SubResource4 | string)␊ - /**␊ - * A list of IPConfigurations of the network interface.␊ - */␊ - ipConfigurations: (NetworkInterfaceIPConfiguration[] | string)␊ - /**␊ - * The DNS settings in network interface.␊ - */␊ - dnsSettings?: (NetworkInterfaceDnsSettings8 | string)␊ - /**␊ - * The MAC address of the network interface.␊ - */␊ - macAddress?: string␊ - /**␊ - * Gets whether this is a primary network interface on a virtual machine.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * If the network interface is accelerated networking enabled.␊ - */␊ - enableAcceleratedNetworking?: (boolean | string)␊ - /**␊ - * Indicates whether IP forwarding is enabled on this network interface.␊ - */␊ - enableIPForwarding?: (boolean | string)␊ - /**␊ - * The resource GUID property of the network interface resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IPConfiguration in a network interface.␊ - */␊ - export interface NetworkInterfaceIPConfiguration {␊ - properties?: (NetworkInterfaceIPConfigurationPropertiesFormat | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration.␊ - */␊ - export interface NetworkInterfaceIPConfigurationPropertiesFormat {␊ - /**␊ - * The reference of ApplicationGatewayBackendAddressPool resource.␊ - */␊ - applicationGatewayBackendAddressPools?: (SubResource4[] | string)␊ - /**␊ - * The reference of LoadBalancerBackendAddressPool resource.␊ - */␊ - loadBalancerBackendAddressPools?: (SubResource4[] | string)␊ - /**␊ - * A list of references of LoadBalancerInboundNatRules.␊ - */␊ - loadBalancerInboundNatRules?: (SubResource4[] | string)␊ - privateIPAddress?: string␊ - /**␊ - * Defines how a private IP address is assigned. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Available from Api-Version 2016-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.␊ - */␊ - privateIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - subnet?: (SubResource4 | string)␊ - /**␊ - * Gets whether this is a primary customer address on the network interface.␊ - */␊ - primary?: (boolean | string)␊ - publicIPAddress?: (SubResource4 | string)␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DNS settings of a network interface.␊ - */␊ - export interface NetworkInterfaceDnsSettings8 {␊ - /**␊ - * List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only value in dnsServers collection.␊ - */␊ - dnsServers?: (string[] | string)␊ - /**␊ - * If the VM that uses this NIC is part of an Availability Set, then this list will have the union of all DNS servers from all NICs that are part of the Availability Set. This property is what is configured on each of those VMs.␊ - */␊ - appliedDnsServers?: (string[] | string)␊ - /**␊ - * Relative DNS name for this NIC used for internal communications between VMs in the same virtual network.␊ - */␊ - internalDnsNameLabel?: string␊ - /**␊ - * Fully qualified DNS name supporting internal communications between VMs in the same virtual network.␊ - */␊ - internalFqdn?: string␊ - /**␊ - * Even if internalDnsNameLabel is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internalDomainNameSuffix.␊ - */␊ - internalDomainNameSuffix?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables␊ - */␊ - export interface RouteTables8 {␊ - name: string␊ - type: "Microsoft.Network/routeTables"␊ - apiVersion: "2017-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (RouteTablePropertiesFormat | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: RouteTablesRoutesChildResource[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Table resource␊ - */␊ - export interface RouteTablePropertiesFormat {␊ - /**␊ - * Collection of routes contained within a route table.␊ - */␊ - routes?: (Route[] | string)␊ - /**␊ - * The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource␊ - */␊ - export interface Route {␊ - properties?: (RoutePropertiesFormat | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource␊ - */␊ - export interface RoutePropertiesFormat {␊ - /**␊ - * The destination CIDR to which the route applies.␊ - */␊ - addressPrefix: string␊ - /**␊ - * The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'.␊ - */␊ - nextHopType: (("VirtualNetworkGateway" | "VnetLocal" | "Internet" | "VirtualAppliance" | "None") | string)␊ - /**␊ - * The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.␊ - */␊ - nextHopIpAddress?: string␊ - /**␊ - * The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutesChildResource {␊ - name: string␊ - type: "routes"␊ - apiVersion: "2017-06-01"␊ - properties: (RoutePropertiesFormat | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/applicationGateways␊ - */␊ - export interface ApplicationGateways {␊ - name: string␊ - type: "Microsoft.Network/applicationGateways"␊ - apiVersion: "2017-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (ApplicationGatewayPropertiesFormat | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application gateway.␊ - */␊ - export interface ApplicationGatewayPropertiesFormat {␊ - /**␊ - * SKU of the application gateway resource.␊ - */␊ - sku?: (ApplicationGatewaySku | string)␊ - /**␊ - * SSL policy of the application gateway resource.␊ - */␊ - sslPolicy?: (ApplicationGatewaySslPolicy | string)␊ - /**␊ - * Subnets of application the gateway resource.␊ - */␊ - gatewayIPConfigurations?: (ApplicationGatewayIPConfiguration[] | string)␊ - /**␊ - * Authentication certificates of the application gateway resource.␊ - */␊ - authenticationCertificates?: (ApplicationGatewayAuthenticationCertificate[] | string)␊ - /**␊ - * SSL certificates of the application gateway resource.␊ - */␊ - sslCertificates?: (ApplicationGatewaySslCertificate[] | string)␊ - /**␊ - * Frontend IP addresses of the application gateway resource.␊ - */␊ - frontendIPConfigurations?: (ApplicationGatewayFrontendIPConfiguration[] | string)␊ - /**␊ - * Frontend ports of the application gateway resource.␊ - */␊ - frontendPorts?: (ApplicationGatewayFrontendPort[] | string)␊ - /**␊ - * Probes of the application gateway resource.␊ - */␊ - probes?: (ApplicationGatewayProbe[] | string)␊ - /**␊ - * Backend address pool of the application gateway resource.␊ - */␊ - backendAddressPools?: (ApplicationGatewayBackendAddressPool[] | string)␊ - /**␊ - * Backend http settings of the application gateway resource.␊ - */␊ - backendHttpSettingsCollection?: (ApplicationGatewayBackendHttpSettings[] | string)␊ - /**␊ - * Http listeners of the application gateway resource.␊ - */␊ - httpListeners?: (ApplicationGatewayHttpListener[] | string)␊ - /**␊ - * URL path map of the application gateway resource.␊ - */␊ - urlPathMaps?: (ApplicationGatewayUrlPathMap[] | string)␊ - /**␊ - * Request routing rules of the application gateway resource.␊ - */␊ - requestRoutingRules?: (ApplicationGatewayRequestRoutingRule[] | string)␊ - /**␊ - * Redirect configurations of the application gateway resource.␊ - */␊ - redirectConfigurations?: (ApplicationGatewayRedirectConfiguration[] | string)␊ - /**␊ - * Web application firewall configuration.␊ - */␊ - webApplicationFirewallConfiguration?: (ApplicationGatewayWebApplicationFirewallConfiguration | string)␊ - /**␊ - * Resource GUID property of the application gateway resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of an application gateway␊ - */␊ - export interface ApplicationGatewaySku {␊ - /**␊ - * Name of an application gateway SKU.␊ - */␊ - name?: (("Standard_Small" | "Standard_Medium" | "Standard_Large" | "WAF_Medium" | "WAF_Large") | string)␊ - /**␊ - * Tier of an application gateway.␊ - */␊ - tier?: (("Standard" | "WAF") | string)␊ - /**␊ - * Capacity (instance count) of an application gateway.␊ - */␊ - capacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application Gateway Ssl policy.␊ - */␊ - export interface ApplicationGatewaySslPolicy {␊ - /**␊ - * Ssl protocols to be disabled on application gateway.␊ - */␊ - disabledSslProtocols?: (("TLSv1_0" | "TLSv1_1" | "TLSv1_2")[] | string)␊ - /**␊ - * Type of Ssl Policy.␊ - */␊ - policyType?: (("Predefined" | "Custom") | string)␊ - /**␊ - * Name of Ssl predefined policy.␊ - */␊ - policyName?: (("AppGwSslPolicy20150501" | "AppGwSslPolicy20170401" | "AppGwSslPolicy20170401S") | string)␊ - /**␊ - * Ssl cipher suites to be enabled in the specified order to application gateway.␊ - */␊ - cipherSuites?: (("TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384" | "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256" | "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA" | "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA" | "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384" | "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256" | "TLS_DHE_RSA_WITH_AES_256_CBC_SHA" | "TLS_DHE_RSA_WITH_AES_128_CBC_SHA" | "TLS_RSA_WITH_AES_256_GCM_SHA384" | "TLS_RSA_WITH_AES_128_GCM_SHA256" | "TLS_RSA_WITH_AES_256_CBC_SHA256" | "TLS_RSA_WITH_AES_128_CBC_SHA256" | "TLS_RSA_WITH_AES_256_CBC_SHA" | "TLS_RSA_WITH_AES_128_CBC_SHA" | "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384" | "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256" | "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384" | "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256" | "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA" | "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA" | "TLS_DHE_DSS_WITH_AES_256_CBC_SHA256" | "TLS_DHE_DSS_WITH_AES_128_CBC_SHA256" | "TLS_DHE_DSS_WITH_AES_256_CBC_SHA" | "TLS_DHE_DSS_WITH_AES_128_CBC_SHA" | "TLS_RSA_WITH_3DES_EDE_CBC_SHA" | "TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA" | "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256" | "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384")[] | string)␊ - /**␊ - * Minimum version of Ssl protocol to be supported on application gateway.␊ - */␊ - minProtocolVersion?: (("TLSv1_0" | "TLSv1_1" | "TLSv1_2") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed.␊ - */␊ - export interface ApplicationGatewayIPConfiguration {␊ - properties?: (ApplicationGatewayIPConfigurationPropertiesFormat | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayIPConfigurationPropertiesFormat {␊ - /**␊ - * Reference of the subnet resource. A subnet from where application gateway gets its private address.␊ - */␊ - subnet?: (SubResource4 | string)␊ - /**␊ - * Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authentication certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewayAuthenticationCertificate {␊ - properties?: (ApplicationGatewayAuthenticationCertificatePropertiesFormat | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authentication certificates properties of an application gateway.␊ - */␊ - export interface ApplicationGatewayAuthenticationCertificatePropertiesFormat {␊ - /**␊ - * Certificate public data.␊ - */␊ - data?: string␊ - /**␊ - * Provisioning state of the authentication certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSL certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewaySslCertificate {␊ - properties?: (ApplicationGatewaySslCertificatePropertiesFormat | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewaySslCertificatePropertiesFormat {␊ - /**␊ - * Base-64 encoded pfx certificate. Only applicable in PUT Request.␊ - */␊ - data?: string␊ - /**␊ - * Password for the pfx file specified in data. Only applicable in PUT request.␊ - */␊ - password?: string␊ - /**␊ - * Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request.␊ - */␊ - publicCertData?: string␊ - /**␊ - * Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendIPConfiguration {␊ - properties?: (ApplicationGatewayFrontendIPConfigurationPropertiesFormat | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendIPConfigurationPropertiesFormat {␊ - /**␊ - * PrivateIPAddress of the network interface IP Configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * PrivateIP allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Reference of the subnet resource.␊ - */␊ - subnet?: (SubResource4 | string)␊ - /**␊ - * Reference of the PublicIP resource.␊ - */␊ - publicIPAddress?: (SubResource4 | string)␊ - /**␊ - * Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend port of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendPort {␊ - properties?: (ApplicationGatewayFrontendPortPropertiesFormat | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend port of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendPortPropertiesFormat {␊ - /**␊ - * Frontend port␊ - */␊ - port?: (number | string)␊ - /**␊ - * Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Probe of the application gateway.␊ - */␊ - export interface ApplicationGatewayProbe {␊ - properties?: (ApplicationGatewayProbePropertiesFormat | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of probe of an application gateway.␊ - */␊ - export interface ApplicationGatewayProbePropertiesFormat {␊ - /**␊ - * Protocol.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Host name to send the probe to.␊ - */␊ - host?: string␊ - /**␊ - * Relative path of probe. Valid path starts from '/'. Probe is sent to ://:␊ - */␊ - path?: string␊ - /**␊ - * The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - interval?: (number | string)␊ - /**␊ - * the probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - timeout?: (number | string)␊ - /**␊ - * The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20.␊ - */␊ - unhealthyThreshold?: (number | string)␊ - /**␊ - * Whether the host header should be picked from the backend http settings. Default value is false.␊ - */␊ - pickHostNameFromBackendHttpSettings?: (boolean | string)␊ - /**␊ - * Minimum number of servers that are always marked healthy. Default value is 0.␊ - */␊ - minServers?: (number | string)␊ - /**␊ - * Criterion for classifying a healthy probe response.␊ - */␊ - match?: (ApplicationGatewayProbeHealthResponseMatch | string)␊ - /**␊ - * Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application gateway probe health response match␊ - */␊ - export interface ApplicationGatewayProbeHealthResponseMatch {␊ - /**␊ - * Body that must be contained in the health response. Default value is empty.␊ - */␊ - body?: string␊ - /**␊ - * Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399.␊ - */␊ - statusCodes?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend Address Pool of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddressPool {␊ - properties?: (ApplicationGatewayBackendAddressPoolPropertiesFormat | string)␊ - /**␊ - * Resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend Address Pool of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddressPoolPropertiesFormat {␊ - /**␊ - * Collection of references to IPs defined in network interfaces.␊ - */␊ - backendIPConfigurations?: (SubResource4[] | string)␊ - /**␊ - * Backend addresses␊ - */␊ - backendAddresses?: (ApplicationGatewayBackendAddress[] | string)␊ - /**␊ - * Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddress {␊ - /**␊ - * Fully qualified domain name (FQDN).␊ - */␊ - fqdn?: string␊ - /**␊ - * IP address␊ - */␊ - ipAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address pool settings of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendHttpSettings {␊ - properties?: (ApplicationGatewayBackendHttpSettingsPropertiesFormat | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend address pool settings of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendHttpSettingsPropertiesFormat {␊ - /**␊ - * Port␊ - */␊ - port?: (number | string)␊ - /**␊ - * Protocol.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Cookie based affinity.␊ - */␊ - cookieBasedAffinity?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Request timeout in seconds. Application Gateway will fail the request if response is not received within RequestTimeout. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - requestTimeout?: (number | string)␊ - /**␊ - * Probe resource of an application gateway.␊ - */␊ - probe?: (SubResource4 | string)␊ - /**␊ - * Array of references to application gateway authentication certificates.␊ - */␊ - authenticationCertificates?: (SubResource4[] | string)␊ - /**␊ - * Connection draining of the backend http settings resource.␊ - */␊ - connectionDraining?: (ApplicationGatewayConnectionDraining | string)␊ - /**␊ - * Host header to be sent to the backend servers.␊ - */␊ - hostName?: string␊ - /**␊ - * Whether to pick host header should be picked from the host name of the backend server. Default value is false.␊ - */␊ - pickHostNameFromBackendAddress?: (boolean | string)␊ - /**␊ - * Cookie name to use for the affinity cookie.␊ - */␊ - affinityCookieName?: string␊ - /**␊ - * Whether the probe is enabled. Default value is false.␊ - */␊ - probeEnabled?: (boolean | string)␊ - /**␊ - * Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null.␊ - */␊ - path?: string␊ - /**␊ - * Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Connection draining allows open connections to a backend server to be active for a specified time after the backend server got removed from the configuration.␊ - */␊ - export interface ApplicationGatewayConnectionDraining {␊ - /**␊ - * Whether connection draining is enabled or not.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds.␊ - */␊ - drainTimeoutInSec: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http listener of an application gateway.␊ - */␊ - export interface ApplicationGatewayHttpListener {␊ - properties?: (ApplicationGatewayHttpListenerPropertiesFormat | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of HTTP listener of an application gateway.␊ - */␊ - export interface ApplicationGatewayHttpListenerPropertiesFormat {␊ - /**␊ - * Frontend IP configuration resource of an application gateway.␊ - */␊ - frontendIPConfiguration?: (SubResource4 | string)␊ - /**␊ - * Frontend port resource of an application gateway.␊ - */␊ - frontendPort?: (SubResource4 | string)␊ - /**␊ - * Protocol.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Host name of HTTP listener.␊ - */␊ - hostName?: string␊ - /**␊ - * SSL certificate resource of an application gateway.␊ - */␊ - sslCertificate?: (SubResource4 | string)␊ - /**␊ - * Applicable only if protocol is https. Enables SNI for multi-hosting.␊ - */␊ - requireServerNameIndication?: (boolean | string)␊ - /**␊ - * Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * UrlPathMaps give a url path to the backend mapping information for PathBasedRouting.␊ - */␊ - export interface ApplicationGatewayUrlPathMap {␊ - properties?: (ApplicationGatewayUrlPathMapPropertiesFormat | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of UrlPathMap of the application gateway.␊ - */␊ - export interface ApplicationGatewayUrlPathMapPropertiesFormat {␊ - /**␊ - * Default backend address pool resource of URL path map.␊ - */␊ - defaultBackendAddressPool?: (SubResource4 | string)␊ - /**␊ - * Default backend http settings resource of URL path map.␊ - */␊ - defaultBackendHttpSettings?: (SubResource4 | string)␊ - /**␊ - * Default redirect configuration resource of URL path map.␊ - */␊ - defaultRedirectConfiguration?: (SubResource4 | string)␊ - /**␊ - * Path rule of URL path map resource.␊ - */␊ - pathRules?: (ApplicationGatewayPathRule[] | string)␊ - /**␊ - * Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Path rule of URL path map of an application gateway.␊ - */␊ - export interface ApplicationGatewayPathRule {␊ - properties?: (ApplicationGatewayPathRulePropertiesFormat | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of path rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayPathRulePropertiesFormat {␊ - /**␊ - * Path rules of URL path map.␊ - */␊ - paths?: (string[] | string)␊ - /**␊ - * Backend address pool resource of URL path map path rule.␊ - */␊ - backendAddressPool?: (SubResource4 | string)␊ - /**␊ - * Backend http settings resource of URL path map path rule.␊ - */␊ - backendHttpSettings?: (SubResource4 | string)␊ - /**␊ - * Redirect configuration resource of URL path map path rule.␊ - */␊ - redirectConfiguration?: (SubResource4 | string)␊ - /**␊ - * Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Request routing rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayRequestRoutingRule {␊ - properties?: (ApplicationGatewayRequestRoutingRulePropertiesFormat | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of request routing rule of the application gateway.␊ - */␊ - export interface ApplicationGatewayRequestRoutingRulePropertiesFormat {␊ - /**␊ - * Rule type.␊ - */␊ - ruleType?: (("Basic" | "PathBasedRouting") | string)␊ - /**␊ - * Backend address pool resource of the application gateway. ␊ - */␊ - backendAddressPool?: (SubResource4 | string)␊ - /**␊ - * Frontend port resource of the application gateway.␊ - */␊ - backendHttpSettings?: (SubResource4 | string)␊ - /**␊ - * Http listener resource of the application gateway. ␊ - */␊ - httpListener?: (SubResource4 | string)␊ - /**␊ - * URL path map resource of the application gateway.␊ - */␊ - urlPathMap?: (SubResource4 | string)␊ - /**␊ - * Redirect configuration resource of the application gateway.␊ - */␊ - redirectConfiguration?: (SubResource4 | string)␊ - /**␊ - * Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Redirect configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayRedirectConfiguration {␊ - properties?: (ApplicationGatewayRedirectConfigurationPropertiesFormat | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of redirect configuration of the application gateway.␊ - */␊ - export interface ApplicationGatewayRedirectConfigurationPropertiesFormat {␊ - /**␊ - * Supported http redirection types - Permanent, Temporary, Found, SeeOther.␊ - */␊ - redirectType?: (("Permanent" | "Found" | "SeeOther" | "Temporary") | string)␊ - /**␊ - * Reference to a listener to redirect the request to.␊ - */␊ - targetListener?: (SubResource4 | string)␊ - /**␊ - * Url to redirect the request to.␊ - */␊ - targetUrl?: string␊ - /**␊ - * Include path in the redirected url.␊ - */␊ - includePath?: (boolean | string)␊ - /**␊ - * Include query string in the redirected url.␊ - */␊ - includeQueryString?: (boolean | string)␊ - /**␊ - * Request routing specifying redirect configuration.␊ - */␊ - requestRoutingRules?: (SubResource4[] | string)␊ - /**␊ - * Url path maps specifying default redirect configuration.␊ - */␊ - urlPathMaps?: (SubResource4[] | string)␊ - /**␊ - * Path rules specifying redirect configuration.␊ - */␊ - pathRules?: (SubResource4[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application gateway web application firewall configuration.␊ - */␊ - export interface ApplicationGatewayWebApplicationFirewallConfiguration {␊ - /**␊ - * Whether the web application firewall is enabled or not.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * Web application firewall mode.␊ - */␊ - firewallMode: (("Detection" | "Prevention") | string)␊ - /**␊ - * The type of the web application firewall rule set. Possible values are: 'OWASP'.␊ - */␊ - ruleSetType: string␊ - /**␊ - * The version of the rule set type.␊ - */␊ - ruleSetVersion: string␊ - /**␊ - * The disabled rule groups.␊ - */␊ - disabledRuleGroups?: (ApplicationGatewayFirewallDisabledRuleGroup[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allows to disable rules within a rule group or an entire rule group.␊ - */␊ - export interface ApplicationGatewayFirewallDisabledRuleGroup {␊ - /**␊ - * The name of the rule group that will be disabled.␊ - */␊ - ruleGroupName: string␊ - /**␊ - * The list of rules that will be disabled. If null, all rules of the rule group will be disabled.␊ - */␊ - rules?: (number[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/connections␊ - */␊ - export interface Connections {␊ - name: string␊ - type: "Microsoft.Network/connections"␊ - apiVersion: "2017-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (VirtualNetworkGatewayConnectionPropertiesFormat | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewayConnection properties␊ - */␊ - export interface VirtualNetworkGatewayConnectionPropertiesFormat {␊ - /**␊ - * The authorizationKey.␊ - */␊ - authorizationKey?: string␊ - virtualNetworkGateway1: (VirtualNetworkGateway | SubResource4 | string)␊ - virtualNetworkGateway2?: (VirtualNetworkGateway | SubResource4 | string)␊ - localNetworkGateway2?: (LocalNetworkGateway | SubResource4 | string)␊ - /**␊ - * Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.␊ - */␊ - connectionType: (("IPsec" | "Vnet2Vnet" | "ExpressRoute" | "VPNClient") | string)␊ - /**␊ - * The routing weight.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * The IPSec shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The reference to peerings resource.␊ - */␊ - peer?: (SubResource4 | string)␊ - /**␊ - * EnableBgp flag␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * Enable policy-based traffic selectors.␊ - */␊ - usePolicyBasedTrafficSelectors?: (boolean | string)␊ - /**␊ - * The IPSec Policies to be considered by this connection.␊ - */␊ - ipsecPolicies?: (IpsecPolicy[] | string)␊ - /**␊ - * The resource GUID property of the VirtualNetworkGatewayConnection resource.␊ - */␊ - resourceGuid?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A common class for general resource information␊ - */␊ - export interface VirtualNetworkGateway {␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (VirtualNetworkGatewayPropertiesFormat | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGateway properties␊ - */␊ - export interface VirtualNetworkGatewayPropertiesFormat {␊ - /**␊ - * IP configurations for virtual network gateway.␊ - */␊ - ipConfigurations?: (VirtualNetworkGatewayIPConfiguration[] | string)␊ - /**␊ - * The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'.␊ - */␊ - gatewayType?: (("Vpn" | "ExpressRoute") | string)␊ - /**␊ - * The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'.␊ - */␊ - vpnType?: (("PolicyBased" | "RouteBased") | string)␊ - /**␊ - * Whether BGP is enabled for this virtual network gateway or not.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * ActiveActive flag␊ - */␊ - activeActive?: (boolean | string)␊ - /**␊ - * The reference of the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting.␊ - */␊ - gatewayDefaultSite?: (SubResource4 | string)␊ - /**␊ - * The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.␊ - */␊ - sku?: (VirtualNetworkGatewaySku | string)␊ - /**␊ - * The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations.␊ - */␊ - vpnClientConfiguration?: (VpnClientConfiguration | string)␊ - /**␊ - * Virtual network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings | string)␊ - /**␊ - * The radius server address property of the VirtualNetworkGateway resource for vpn client connection.␊ - */␊ - radiusServer?: string␊ - /**␊ - * The radius secret property of the VirtualNetworkGateway resource for vpn client connection.␊ - */␊ - radiusSecret?: string␊ - /**␊ - * The resource GUID property of the VirtualNetworkGateway resource.␊ - */␊ - resourceGuid?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration for virtual network gateway␊ - */␊ - export interface VirtualNetworkGatewayIPConfiguration {␊ - properties?: (VirtualNetworkGatewayIPConfigurationPropertiesFormat | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of VirtualNetworkGatewayIPConfiguration␊ - */␊ - export interface VirtualNetworkGatewayIPConfigurationPropertiesFormat {␊ - /**␊ - * The private IP allocation method. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * The reference of the subnet resource.␊ - */␊ - subnet?: (SubResource4 | string)␊ - /**␊ - * The reference of the public IP resource.␊ - */␊ - publicIPAddress?: (SubResource4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewaySku details␊ - */␊ - export interface VirtualNetworkGatewaySku {␊ - /**␊ - * Gateway SKU name.␊ - */␊ - name?: (("Basic" | "HighPerformance" | "Standard" | "UltraPerformance" | "VpnGw1" | "VpnGw2" | "VpnGw3") | string)␊ - /**␊ - * Gateway SKU tier.␊ - */␊ - tier?: (("Basic" | "HighPerformance" | "Standard" | "UltraPerformance" | "VpnGw1" | "VpnGw2" | "VpnGw3") | string)␊ - /**␊ - * The capacity.␊ - */␊ - capacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnClientConfiguration for P2S client.␊ - */␊ - export interface VpnClientConfiguration {␊ - /**␊ - * The reference of the address space resource which represents Address space for P2S VpnClient.␊ - */␊ - vpnClientAddressPool?: (AddressSpace8 | string)␊ - /**␊ - * VpnClientRootCertificate for virtual network gateway.␊ - */␊ - vpnClientRootCertificates?: (VpnClientRootCertificate[] | string)␊ - /**␊ - * VpnClientRevokedCertificate for Virtual network gateway.␊ - */␊ - vpnClientRevokedCertificates?: (VpnClientRevokedCertificate[] | string)␊ - /**␊ - * VpnClientProtocols for Virtual network gateway.␊ - */␊ - vpnClientProtocols?: (("IkeV2" | "SSTP")[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client root certificate of virtual network gateway␊ - */␊ - export interface VpnClientRootCertificate {␊ - properties: (VpnClientRootCertificatePropertiesFormat | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of application gateway␊ - */␊ - export interface VpnClientRootCertificatePropertiesFormat {␊ - /**␊ - * The certificate public data.␊ - */␊ - publicCertData: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client revoked certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRevokedCertificate {␊ - properties?: (VpnClientRevokedCertificatePropertiesFormat | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the revoked VPN client certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRevokedCertificatePropertiesFormat {␊ - /**␊ - * The revoked VPN client certificate thumbprint.␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * BGP settings details␊ - */␊ - export interface BgpSettings {␊ - /**␊ - * The BGP speaker's ASN.␊ - */␊ - asn?: (number | string)␊ - /**␊ - * The BGP peering address and BGP identifier of this BGP speaker.␊ - */␊ - bgpPeeringAddress?: string␊ - /**␊ - * The weight added to routes learned from this BGP speaker.␊ - */␊ - peerWeight?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A common class for general resource information␊ - */␊ - export interface LocalNetworkGateway {␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (LocalNetworkGatewayPropertiesFormat | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * LocalNetworkGateway properties␊ - */␊ - export interface LocalNetworkGatewayPropertiesFormat {␊ - /**␊ - * Local network site address space.␊ - */␊ - localNetworkAddressSpace?: (AddressSpace8 | string)␊ - /**␊ - * IP address of local network gateway.␊ - */␊ - gatewayIpAddress?: string␊ - /**␊ - * Local network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings | string)␊ - /**␊ - * The resource GUID property of the LocalNetworkGateway resource.␊ - */␊ - resourceGuid?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An IPSec Policy configuration for a virtual network gateway connection␊ - */␊ - export interface IpsecPolicy {␊ - /**␊ - * The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.␊ - */␊ - saLifeTimeSeconds: (number | string)␊ - /**␊ - * The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.␊ - */␊ - saDataSizeKilobytes: (number | string)␊ - /**␊ - * The IPSec encryption algorithm (IKE phase 1).␊ - */␊ - ipsecEncryption: (("None" | "DES" | "DES3" | "AES128" | "AES192" | "AES256" | "GCMAES128" | "GCMAES192" | "GCMAES256") | string)␊ - /**␊ - * The IPSec integrity algorithm (IKE phase 1).␊ - */␊ - ipsecIntegrity: (("MD5" | "SHA1" | "SHA256" | "GCMAES128" | "GCMAES192" | "GCMAES256") | string)␊ - /**␊ - * The IKE encryption algorithm (IKE phase 2).␊ - */␊ - ikeEncryption: (("DES" | "DES3" | "AES128" | "AES192" | "AES256") | string)␊ - /**␊ - * The IKE integrity algorithm (IKE phase 2).␊ - */␊ - ikeIntegrity: (("MD5" | "SHA1" | "SHA256" | "SHA384") | string)␊ - /**␊ - * The DH Groups used in IKE Phase 1 for initial SA.␊ - */␊ - dhGroup: (("None" | "DHGroup1" | "DHGroup2" | "DHGroup14" | "DHGroup2048" | "ECP256" | "ECP384" | "DHGroup24") | string)␊ - /**␊ - * The DH Groups used in IKE Phase 2 for new child SA.␊ - */␊ - pfsGroup: (("None" | "PFS1" | "PFS2" | "PFS2048" | "ECP256" | "ECP384" | "PFS24") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/localNetworkGateways␊ - */␊ - export interface LocalNetworkGateways {␊ - name: string␊ - type: "Microsoft.Network/localNetworkGateways"␊ - apiVersion: "2017-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (LocalNetworkGatewayPropertiesFormat | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworkGateways␊ - */␊ - export interface VirtualNetworkGateways {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworkGateways"␊ - apiVersion: "2017-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (VirtualNetworkGatewayPropertiesFormat | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnets {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks/subnets"␊ - apiVersion: "2017-06-01"␊ - properties: (SubnetPropertiesFormat | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/virtualNetworkPeerings␊ - */␊ - export interface VirtualNetworksVirtualNetworkPeerings {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks/virtualNetworkPeerings"␊ - apiVersion: "2017-06-01"␊ - properties: (VirtualNetworkPeeringPropertiesFormat | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRules {␊ - name: string␊ - type: "Microsoft.Network/networkSecurityGroups/securityRules"␊ - apiVersion: "2017-06-01"␊ - properties: (SecurityRulePropertiesFormat | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutes {␊ - name: string␊ - type: "Microsoft.Network/routeTables/routes"␊ - apiVersion: "2017-06-01"␊ - properties: (RoutePropertiesFormat | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/disks␊ - */␊ - export interface Disks1 {␊ - apiVersion: "2017-03-30"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters.␊ - */␊ - name: string␊ - /**␊ - * Disk resource properties.␊ - */␊ - properties: (DiskProperties2 | string)␊ - /**␊ - * The disks and snapshots sku name. Can be Standard_LRS or Premium_LRS.␊ - */␊ - sku?: (DiskSku | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/disks"␊ - /**␊ - * The Logical zone list for Disk.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Disk resource properties.␊ - */␊ - export interface DiskProperties2 {␊ - /**␊ - * Data used when creating a disk.␊ - */␊ - creationData: (CreationData1 | string)␊ - /**␊ - * If creationData.createOption is Empty, this field is mandatory and it indicates the size of the VHD to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size.␊ - */␊ - diskSizeGB?: (number | string)␊ - /**␊ - * Encryption settings for disk or snapshot␊ - */␊ - encryptionSettings?: (EncryptionSettings1 | string)␊ - /**␊ - * The Operating System type.␊ - */␊ - osType?: (("Windows" | "Linux") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Data used when creating a disk.␊ - */␊ - export interface CreationData1 {␊ - /**␊ - * This enumerates the possible sources of a disk's creation.␊ - */␊ - createOption: (("Empty" | "Attach" | "FromImage" | "Import" | "Copy") | string)␊ - /**␊ - * The source image used for creating the disk.␊ - */␊ - imageReference?: (ImageDiskReference1 | string)␊ - /**␊ - * If createOption is Copy, this is the ARM id of the source snapshot or disk.␊ - */␊ - sourceResourceId?: string␊ - /**␊ - * If createOption is Import, this is the URI of a blob to be imported into a managed disk.␊ - */␊ - sourceUri?: string␊ - /**␊ - * If createOption is Import, the Azure Resource Manager identifier of the storage account containing the blob to import as a disk. Required only if the blob is in a different subscription␊ - */␊ - storageAccountId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The source image used for creating the disk.␊ - */␊ - export interface ImageDiskReference1 {␊ - /**␊ - * A relative uri containing either a Platform Image Repository or user image reference.␊ - */␊ - id: string␊ - /**␊ - * If the disk is created from an image's data disk, this is an index that indicates which of the data disks in the image to use. For OS disks, this field is null.␊ - */␊ - lun?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Encryption settings for disk or snapshot␊ - */␊ - export interface EncryptionSettings1 {␊ - /**␊ - * Key Vault Secret Url and vault id of the encryption key ␊ - */␊ - diskEncryptionKey?: (KeyVaultAndSecretReference1 | string)␊ - /**␊ - * Set this flag to true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable encryption. Set this flag to false and remove DiskEncryptionKey and KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the request object, the existing settings remain unchanged.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey␊ - */␊ - keyEncryptionKey?: (KeyVaultAndKeyReference1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Key Vault Secret Url and vault id of the encryption key ␊ - */␊ - export interface KeyVaultAndSecretReference1 {␊ - /**␊ - * Url pointing to a key or secret in KeyVault␊ - */␊ - secretUrl: string␊ - /**␊ - * The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}␊ - */␊ - sourceVault: (SourceVault1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}␊ - */␊ - export interface SourceVault1 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey␊ - */␊ - export interface KeyVaultAndKeyReference1 {␊ - /**␊ - * Url pointing to a key or secret in KeyVault␊ - */␊ - keyUrl: string␊ - /**␊ - * The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}␊ - */␊ - sourceVault: (SourceVault1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The disks and snapshots sku name. Can be Standard_LRS or Premium_LRS.␊ - */␊ - export interface DiskSku {␊ - /**␊ - * The sku name.␊ - */␊ - name?: (("Standard_LRS" | "Premium_LRS") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/snapshots␊ - */␊ - export interface Snapshots1 {␊ - apiVersion: "2017-03-30"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the snapshot that is being created. The name can't be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The max name length is 80 characters.␊ - */␊ - name: string␊ - /**␊ - * Disk resource properties.␊ - */␊ - properties: (DiskProperties2 | string)␊ - /**␊ - * The disks and snapshots sku name. Can be Standard_LRS or Premium_LRS.␊ - */␊ - sku?: (DiskSku | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/snapshots"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/images␊ - */␊ - export interface Images1 {␊ - apiVersion: "2017-03-30"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the image.␊ - */␊ - name: string␊ - /**␊ - * Describes the properties of an Image.␊ - */␊ - properties: (ImageProperties1 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/images"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the properties of an Image.␊ - */␊ - export interface ImageProperties1 {␊ - sourceVirtualMachine?: (SubResource5 | string)␊ - /**␊ - * Describes a storage profile.␊ - */␊ - storageProfile?: (ImageStorageProfile1 | string)␊ - [k: string]: unknown␊ - }␊ - export interface SubResource5 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a storage profile.␊ - */␊ - export interface ImageStorageProfile1 {␊ - /**␊ - * 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).␊ - */␊ - dataDisks?: (ImageDataDisk1[] | string)␊ - /**␊ - * Describes an Operating System disk.␊ - */␊ - osDisk: (ImageOSDisk1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a data disk.␊ - */␊ - export interface ImageDataDisk1 {␊ - /**␊ - * The Virtual Hard Disk.␊ - */␊ - blobUri?: string␊ - /**␊ - * Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**.␊ - */␊ - caching?: (("None" | "ReadOnly" | "ReadWrite") | string)␊ - /**␊ - * 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␊ - */␊ - diskSizeGB?: (number | string)␊ - /**␊ - * 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.␊ - */␊ - lun: (number | string)␊ - managedDisk?: (SubResource5 | string)␊ - snapshot?: (SubResource5 | string)␊ - /**␊ - * Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS.␊ - */␊ - storageAccountType?: (("Standard_LRS" | "Premium_LRS") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes an Operating System disk.␊ - */␊ - export interface ImageOSDisk1 {␊ - /**␊ - * The Virtual Hard Disk.␊ - */␊ - blobUri?: string␊ - /**␊ - * Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**.␊ - */␊ - caching?: (("None" | "ReadOnly" | "ReadWrite") | string)␊ - /**␊ - * 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␊ - */␊ - diskSizeGB?: (number | string)␊ - managedDisk?: (SubResource5 | string)␊ - /**␊ - * The OS State.␊ - */␊ - osState: (("Generalized" | "Specialized") | string)␊ - /**␊ - * 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**.␊ - */␊ - osType: (("Windows" | "Linux") | string)␊ - snapshot?: (SubResource5 | string)␊ - /**␊ - * Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS.␊ - */␊ - storageAccountType?: (("Standard_LRS" | "Premium_LRS") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/availabilitySets␊ - */␊ - export interface AvailabilitySets2 {␊ - apiVersion: "2017-03-30"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the availability set.␊ - */␊ - name: string␊ - /**␊ - * The instance view of a resource.␊ - */␊ - properties: (AvailabilitySetProperties1 | string)␊ - /**␊ - * Describes a virtual machine scale set sku.␊ - */␊ - sku?: (Sku39 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/availabilitySets"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The instance view of a resource.␊ - */␊ - export interface AvailabilitySetProperties1 {␊ - /**␊ - * Fault Domain count.␊ - */␊ - platformFaultDomainCount?: (number | string)␊ - /**␊ - * Update Domain count.␊ - */␊ - platformUpdateDomainCount?: (number | string)␊ - /**␊ - * A list of references to all virtual machines in the availability set.␊ - */␊ - virtualMachines?: (SubResource5[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set sku.␊ - */␊ - export interface Sku39 {␊ - /**␊ - * Specifies the number of virtual machines in the scale set. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name.␊ - */␊ - capacity?: (number | string)␊ - /**␊ - * The sku name.␊ - */␊ - name?: string␊ - /**␊ - * Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic**␊ - */␊ - tier?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/virtualMachines␊ - */␊ - export interface VirtualMachines3 {␊ - apiVersion: "2017-03-30"␊ - /**␊ - * Identity for the virtual machine.␊ - */␊ - identity?: (VirtualMachineIdentity1 | string)␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the virtual machine.␊ - */␊ - name: string␊ - /**␊ - * 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**.␊ - */␊ - plan?: (Plan2 | string)␊ - /**␊ - * Describes the properties of a Virtual Machine.␊ - */␊ - properties: (VirtualMachineProperties4 | string)␊ - resources?: VirtualMachinesExtensionsChildResource1[]␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/virtualMachines"␊ - /**␊ - * The virtual machine zones.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the virtual machine.␊ - */␊ - export interface VirtualMachineIdentity1 {␊ - /**␊ - * The type of identity used for the virtual machine. Currently, the only supported type is 'SystemAssigned', which implicitly creates an identity.␊ - */␊ - type?: ("SystemAssigned" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * 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**.␊ - */␊ - export interface Plan2 {␊ - /**␊ - * The plan ID.␊ - */␊ - name?: string␊ - /**␊ - * Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.␊ - */␊ - product?: string␊ - /**␊ - * The promotion code.␊ - */␊ - promotionCode?: string␊ - /**␊ - * The publisher ID.␊ - */␊ - publisher?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the properties of a Virtual Machine.␊ - */␊ - export interface VirtualMachineProperties4 {␊ - availabilitySet?: (SubResource5 | string)␊ - /**␊ - * Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15.␊ - */␊ - diagnosticsProfile?: (DiagnosticsProfile1 | string)␊ - /**␊ - * Specifies the hardware settings for the virtual machine.␊ - */␊ - hardwareProfile?: (HardwareProfile2 | string)␊ - /**␊ - * 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␊ - */␊ - licenseType?: string␊ - /**␊ - * Specifies the network interfaces of the virtual machine.␊ - */␊ - networkProfile?: (NetworkProfile2 | string)␊ - /**␊ - * Specifies the operating system settings for the virtual machine.␊ - */␊ - osProfile?: (OSProfile1 | string)␊ - /**␊ - * Specifies the storage settings for the virtual machine disks.␊ - */␊ - storageProfile?: (StorageProfile2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15.␊ - */␊ - export interface DiagnosticsProfile1 {␊ - /**␊ - * Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    You can easily view the output of your console log.

    Azure also enables you to see a screenshot of the VM from the hypervisor.␊ - */␊ - bootDiagnostics?: (BootDiagnostics1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    You can easily view the output of your console log.

    Azure also enables you to see a screenshot of the VM from the hypervisor.␊ - */␊ - export interface BootDiagnostics1 {␊ - /**␊ - * Whether boot diagnostics should be enabled on the Virtual Machine.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Uri of the storage account to use for placing the console output and screenshot.␊ - */␊ - storageUri?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the hardware settings for the virtual machine.␊ - */␊ - export interface HardwareProfile2 {␊ - /**␊ - * 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](https://docs.microsoft.com/rest/api/compute/availabilitysets/listavailablesizes)

    [List all available virtual machine sizes in a region](https://docs.microsoft.com/rest/api/compute/virtualmachinesizes/list)

    [List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes).␊ - */␊ - vmSize?: (("Basic_A0" | "Basic_A1" | "Basic_A2" | "Basic_A3" | "Basic_A4" | "Standard_A0" | "Standard_A1" | "Standard_A2" | "Standard_A3" | "Standard_A4" | "Standard_A5" | "Standard_A6" | "Standard_A7" | "Standard_A8" | "Standard_A9" | "Standard_A10" | "Standard_A11" | "Standard_A1_v2" | "Standard_A2_v2" | "Standard_A4_v2" | "Standard_A8_v2" | "Standard_A2m_v2" | "Standard_A4m_v2" | "Standard_A8m_v2" | "Standard_D1" | "Standard_D2" | "Standard_D3" | "Standard_D4" | "Standard_D11" | "Standard_D12" | "Standard_D13" | "Standard_D14" | "Standard_D1_v2" | "Standard_D2_v2" | "Standard_D3_v2" | "Standard_D4_v2" | "Standard_D5_v2" | "Standard_D11_v2" | "Standard_D12_v2" | "Standard_D13_v2" | "Standard_D14_v2" | "Standard_D15_v2" | "Standard_DS1" | "Standard_DS2" | "Standard_DS3" | "Standard_DS4" | "Standard_DS11" | "Standard_DS12" | "Standard_DS13" | "Standard_DS14" | "Standard_DS1_v2" | "Standard_DS2_v2" | "Standard_DS3_v2" | "Standard_DS4_v2" | "Standard_DS5_v2" | "Standard_DS11_v2" | "Standard_DS12_v2" | "Standard_DS13_v2" | "Standard_DS14_v2" | "Standard_DS15_v2" | "Standard_F1" | "Standard_F2" | "Standard_F4" | "Standard_F8" | "Standard_F16" | "Standard_F1s" | "Standard_F2s" | "Standard_F4s" | "Standard_F8s" | "Standard_F16s" | "Standard_G1" | "Standard_G2" | "Standard_G3" | "Standard_G4" | "Standard_G5" | "Standard_GS1" | "Standard_GS2" | "Standard_GS3" | "Standard_GS4" | "Standard_GS5" | "Standard_H8" | "Standard_H16" | "Standard_H8m" | "Standard_H16m" | "Standard_H16r" | "Standard_H16mr" | "Standard_L4s" | "Standard_L8s" | "Standard_L16s" | "Standard_L32s" | "Standard_NC6" | "Standard_NC12" | "Standard_NC24" | "Standard_NC24r" | "Standard_NV6" | "Standard_NV12" | "Standard_NV24") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the network interfaces of the virtual machine.␊ - */␊ - export interface NetworkProfile2 {␊ - /**␊ - * Specifies the list of resource Ids for the network interfaces associated with the virtual machine.␊ - */␊ - networkInterfaces?: (NetworkInterfaceReference1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a network interface reference.␊ - */␊ - export interface NetworkInterfaceReference1 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Describes a network interface reference properties.␊ - */␊ - properties?: (NetworkInterfaceReferenceProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a network interface reference properties.␊ - */␊ - export interface NetworkInterfaceReferenceProperties1 {␊ - /**␊ - * Specifies the primary network interface in case the virtual machine has more than 1 network interface.␊ - */␊ - primary?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the operating system settings for the virtual machine.␊ - */␊ - export interface OSProfile1 {␊ - /**␊ - * 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)␊ - */␊ - adminPassword?: string␊ - /**␊ - * 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)␊ - */␊ - adminUsername?: string␊ - /**␊ - * Specifies the host OS name of the virtual machine.

    This name cannot be updated after the VM is created.

    **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).␊ - */␊ - computerName?: string␊ - /**␊ - * 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)␊ - */␊ - customData?: string␊ - /**␊ - * 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).␊ - */␊ - linuxConfiguration?: (LinuxConfiguration2 | string)␊ - /**␊ - * Specifies set of certificates that should be installed onto the virtual machine.␊ - */␊ - secrets?: (VaultSecretGroup1[] | string)␊ - /**␊ - * Specifies Windows operating system settings on the virtual machine.␊ - */␊ - windowsConfiguration?: (WindowsConfiguration3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * 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).␊ - */␊ - export interface LinuxConfiguration2 {␊ - /**␊ - * Specifies whether password authentication should be disabled.␊ - */␊ - disablePasswordAuthentication?: (boolean | string)␊ - /**␊ - * SSH configuration for Linux based VMs running on Azure␊ - */␊ - ssh?: (SshConfiguration1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSH configuration for Linux based VMs running on Azure␊ - */␊ - export interface SshConfiguration1 {␊ - /**␊ - * The list of SSH public keys used to authenticate with linux based VMs.␊ - */␊ - publicKeys?: (SshPublicKey1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed.␊ - */␊ - export interface SshPublicKey1 {␊ - /**␊ - * 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).␊ - */␊ - keyData?: string␊ - /**␊ - * 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␊ - */␊ - path?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a set of certificates which are all in the same Key Vault.␊ - */␊ - export interface VaultSecretGroup1 {␊ - sourceVault?: (SubResource5 | string)␊ - /**␊ - * The list of key vault references in SourceVault which contain certificates.␊ - */␊ - vaultCertificates?: (VaultCertificate1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM.␊ - */␊ - export interface VaultCertificate1 {␊ - /**␊ - * 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 <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted.␊ - */␊ - certificateStore?: string␊ - /**␊ - * 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":""
    }␊ - */␊ - certificateUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies Windows operating system settings on the virtual machine.␊ - */␊ - export interface WindowsConfiguration3 {␊ - /**␊ - * Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup.␊ - */␊ - additionalUnattendContent?: (AdditionalUnattendContent2[] | string)␊ - /**␊ - * Indicates whether virtual machine is enabled for automatic updates.␊ - */␊ - enableAutomaticUpdates?: (boolean | string)␊ - /**␊ - * 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.␊ - */␊ - provisionVMAgent?: (boolean | string)␊ - /**␊ - * Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time"␊ - */␊ - timeZone?: string␊ - /**␊ - * Describes Windows Remote Management configuration of the VM␊ - */␊ - winRM?: (WinRMConfiguration1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * 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.␊ - */␊ - export interface AdditionalUnattendContent2 {␊ - /**␊ - * The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup.␊ - */␊ - componentName?: ("Microsoft-Windows-Shell-Setup" | string)␊ - /**␊ - * 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.␊ - */␊ - content?: string␊ - /**␊ - * The pass name. Currently, the only allowable value is OobeSystem.␊ - */␊ - passName?: ("OobeSystem" | string)␊ - /**␊ - * Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.␊ - */␊ - settingName?: (("AutoLogon" | "FirstLogonCommands") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes Windows Remote Management configuration of the VM␊ - */␊ - export interface WinRMConfiguration1 {␊ - /**␊ - * The list of Windows Remote Management listeners␊ - */␊ - listeners?: (WinRMListener2[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes Protocol and thumbprint of Windows Remote Management listener␊ - */␊ - export interface WinRMListener2 {␊ - /**␊ - * 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":""
    }␊ - */␊ - certificateUrl?: string␊ - /**␊ - * Specifies the protocol of listener.

    Possible values are:
    **http**

    **https**.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the storage settings for the virtual machine disks.␊ - */␊ - export interface StorageProfile2 {␊ - /**␊ - * 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).␊ - */␊ - dataDisks?: (DataDisk3[] | string)␊ - /**␊ - * 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. NOTE: Image reference publisher and offer can only be set when you create the scale set.␊ - */␊ - imageReference?: (ImageReference3 | string)␊ - /**␊ - * 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).␊ - */␊ - osDisk?: (OSDisk2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a data disk.␊ - */␊ - export interface DataDisk3 {␊ - /**␊ - * Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**.␊ - */␊ - caching?: (("None" | "ReadOnly" | "ReadWrite") | string)␊ - /**␊ - * 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.␊ - */␊ - createOption: (("FromImage" | "Empty" | "Attach") | string)␊ - /**␊ - * Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB␊ - */␊ - diskSizeGB?: (number | string)␊ - /**␊ - * Describes the uri of a disk.␊ - */␊ - image?: (VirtualHardDisk1 | string)␊ - /**␊ - * 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.␊ - */␊ - lun: (number | string)␊ - /**␊ - * The parameters of a managed disk.␊ - */␊ - managedDisk?: (ManagedDiskParameters1 | string)␊ - /**␊ - * The disk name.␊ - */␊ - name?: string␊ - /**␊ - * Describes the uri of a disk.␊ - */␊ - vhd?: (VirtualHardDisk1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the uri of a disk.␊ - */␊ - export interface VirtualHardDisk1 {␊ - /**␊ - * Specifies the virtual hard disk's uri.␊ - */␊ - uri?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The parameters of a managed disk.␊ - */␊ - export interface ManagedDiskParameters1 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS.␊ - */␊ - storageAccountType?: (("Standard_LRS" | "Premium_LRS") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * 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. NOTE: Image reference publisher and offer can only be set when you create the scale set.␊ - */␊ - export interface ImageReference3 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Specifies the offer of the platform image or marketplace image used to create the virtual machine.␊ - */␊ - offer?: string␊ - /**␊ - * The image publisher.␊ - */␊ - publisher?: string␊ - /**␊ - * The image SKU.␊ - */␊ - sku?: string␊ - /**␊ - * 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.␊ - */␊ - version?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * 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).␊ - */␊ - export interface OSDisk2 {␊ - /**␊ - * Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**.␊ - */␊ - caching?: (("None" | "ReadOnly" | "ReadWrite") | string)␊ - /**␊ - * 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.␊ - */␊ - createOption: (("FromImage" | "Empty" | "Attach") | string)␊ - /**␊ - * Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB␊ - */␊ - diskSizeGB?: (number | string)␊ - /**␊ - * Describes a Encryption Settings for a Disk␊ - */␊ - encryptionSettings?: (DiskEncryptionSettings1 | string)␊ - /**␊ - * Describes the uri of a disk.␊ - */␊ - image?: (VirtualHardDisk1 | string)␊ - /**␊ - * The parameters of a managed disk.␊ - */␊ - managedDisk?: (ManagedDiskParameters1 | string)␊ - /**␊ - * The disk name.␊ - */␊ - name?: string␊ - /**␊ - * 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**.␊ - */␊ - osType?: (("Windows" | "Linux") | string)␊ - /**␊ - * Describes the uri of a disk.␊ - */␊ - vhd?: (VirtualHardDisk1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a Encryption Settings for a Disk␊ - */␊ - export interface DiskEncryptionSettings1 {␊ - /**␊ - * Describes a reference to Key Vault Secret␊ - */␊ - diskEncryptionKey?: (KeyVaultSecretReference1 | string)␊ - /**␊ - * Specifies whether disk encryption should be enabled on the virtual machine.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Describes a reference to Key Vault Key␊ - */␊ - keyEncryptionKey?: (KeyVaultKeyReference1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a reference to Key Vault Secret␊ - */␊ - export interface KeyVaultSecretReference1 {␊ - /**␊ - * The URL referencing a secret in a Key Vault.␊ - */␊ - secretUrl: string␊ - sourceVault: (SubResource5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a reference to Key Vault Key␊ - */␊ - export interface KeyVaultKeyReference1 {␊ - /**␊ - * The URL referencing a key encryption key in Key Vault.␊ - */␊ - keyUrl: string␊ - sourceVault: (SubResource5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/virtualMachines/extensions␊ - */␊ - export interface VirtualMachinesExtensionsChildResource1 {␊ - apiVersion: "2017-03-30"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the virtual machine extension.␊ - */␊ - name: string␊ - properties: (GenericExtension2 | IaaSDiagnostics2 | IaaSAntimalware2 | CustomScriptExtension2 | CustomScriptForLinux2 | LinuxDiagnostic2 | VmAccessForLinux2 | BgInfo2 | VmAccessAgent2 | DscExtension2 | AcronisBackupLinux2 | AcronisBackup2 | LinuxChefClient2 | ChefClient2 | DatadogLinuxAgent2 | DatadogWindowsAgent2 | DockerExtension2 | DynatraceLinux2 | DynatraceWindows2 | Eset2 | HpeSecurityApplicationDefender2 | PuppetAgent2 | Site24X7LinuxServerExtn2 | Site24X7WindowsServerExtn2 | Site24X7ApmInsightExtn2 | TrendMicroDSALinux2 | TrendMicroDSA2 | BmcCtmAgentLinux2 | BmcCtmAgentWindows2 | OSPatchingForLinux2 | VMSnapshot2 | VMSnapshotLinux2 | CustomScript2 | NetworkWatcherAgentWindows2 | NetworkWatcherAgentLinux2)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "extensions"␊ - [k: string]: unknown␊ - }␊ - export interface GenericExtension2 {␊ - /**␊ - * Microsoft.Compute/extensions - Publisher␊ - */␊ - publisher: string␊ - /**␊ - * Microsoft.Compute/extensions - Type␊ - */␊ - type: string␊ - /**␊ - * Microsoft.Compute/extensions - Type handler version␊ - */␊ - typeHandlerVersion: string␊ - /**␊ - * Microsoft.Compute/extensions - Settings␊ - */␊ - settings: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - export interface IaaSDiagnostics2 {␊ - publisher: "Microsoft.Azure.Diagnostics"␊ - type: "IaaSDiagnostics"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - xmlCfg: string␊ - StorageAccount: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - storageAccountName: string␊ - storageAccountKey: string␊ - storageAccountEndPoint: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface IaaSAntimalware2 {␊ - publisher: "Microsoft.Azure.Security"␊ - type: "IaaSAntimalware"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - AntimalwareEnabled: boolean␊ - Exclusions: {␊ - Paths: string␊ - Extensions: string␊ - Processes: string␊ - [k: string]: unknown␊ - }␊ - RealtimeProtectionEnabled: ("true" | "false")␊ - ScheduledScanSettings: {␊ - isEnabled: ("true" | "false")␊ - scanType: string␊ - day: string␊ - time: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface CustomScriptExtension2 {␊ - publisher: "Microsoft.Compute"␊ - type: "CustomScriptExtension"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - fileUris?: string[]␊ - commandToExecute: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - storageAccountName?: string␊ - storageAccountKey?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface CustomScriptForLinux2 {␊ - publisher: "Microsoft.OSTCExtensions"␊ - type: "CustomScriptForLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - fileUris?: string[]␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - commandToExecute: string␊ - storageAccountName?: string␊ - storageAccountKey?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface LinuxDiagnostic2 {␊ - publisher: "Microsoft.OSTCExtensions"␊ - type: "LinuxDiagnostic"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - enableSyslog?: string␊ - mdsdHttpProxy?: string␊ - perCfg?: unknown[]␊ - fileCfg?: unknown[]␊ - xmlCfg?: string␊ - ladCfg?: {␊ - [k: string]: unknown␊ - }␊ - syslogCfg?: string␊ - eventVolume?: string␊ - mdsdCfg?: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - mdsdHttpProxy?: string␊ - storageAccountName: string␊ - storageAccountKey: string␊ - storageAccountEndPoint?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface VmAccessForLinux2 {␊ - publisher: "Microsoft.OSTCExtensions"␊ - type: "VMAccessForLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - check_disk?: boolean␊ - repair_disk?: boolean␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - username: string␊ - password: string␊ - ssh_key: string␊ - reset_ssh: string␊ - remove_user: string␊ - expiration: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface BgInfo2 {␊ - publisher: "Microsoft.Compute"␊ - type: "bginfo"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - [k: string]: unknown␊ - }␊ - export interface VmAccessAgent2 {␊ - publisher: "Microsoft.Compute"␊ - type: "VMAccessAgent"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - username?: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - password?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface DscExtension2 {␊ - publisher: "Microsoft.Powershell"␊ - type: "DSC"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - modulesUrl: string␊ - configurationFunction: string␊ - properties?: string␊ - wmfVersion?: string␊ - privacy?: {␊ - dataCollection?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - dataBlobUri?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface AcronisBackupLinux2 {␊ - publisher: "Acronis.Backup"␊ - type: "AcronisBackupLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - absURL: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - userLogin: string␊ - userPassword: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface AcronisBackup2 {␊ - publisher: "Acronis.Backup"␊ - type: "AcronisBackup"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - absURL: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - userLogin: string␊ - userPassword: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface LinuxChefClient2 {␊ - publisher: "Chef.Bootstrap.WindowsAzure"␊ - type: "LinuxChefClient"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - bootstrap_version?: string␊ - bootstrap_options?: {␊ - chef_node_name: string␊ - chef_server_url: string␊ - validation_client_name: string␊ - node_ssl_verify_mode: string␊ - environment: string␊ - [k: string]: unknown␊ - }␊ - runlist?: string␊ - client_rb?: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - validation_key: string␊ - chef_server_crt: string␊ - secret: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface ChefClient2 {␊ - publisher: "Chef.Bootstrap.WindowsAzure"␊ - type: "ChefClient"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - bootstrap_options?: {␊ - chef_node_name: string␊ - chef_server_url: string␊ - validation_client_name: string␊ - node_ssl_verify_mode: string␊ - environment: string␊ - [k: string]: unknown␊ - }␊ - runlist?: string␊ - client_rb?: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - validation_key: string␊ - chef_server_crt: string␊ - secret: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface DatadogLinuxAgent2 {␊ - publisher: "Datadog.Agent"␊ - type: "DatadogLinuxAgent"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - api_key: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface DatadogWindowsAgent2 {␊ - publisher: "Datadog.Agent"␊ - type: "DatadogWindowsAgent"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - api_key: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface DockerExtension2 {␊ - publisher: "Microsoft.Azure.Extensions"␊ - type: "DockerExtension"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - docker: {␊ - port: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - certs: {␊ - ca: string␊ - cert: string␊ - key: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface DynatraceLinux2 {␊ - publisher: "dynatrace.ruxit"␊ - type: "ruxitAgentLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - tenantId: string␊ - token: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface DynatraceWindows2 {␊ - publisher: "dynatrace.ruxit"␊ - type: "ruxitAgentWindows"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - tenantId: string␊ - token: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Eset2 {␊ - publisher: "ESET"␊ - type: "FileSecurity"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - LicenseKey: string␊ - "Install-RealtimeProtection": boolean␊ - "Install-ProtocolFiltering": boolean␊ - "Install-DeviceControl": boolean␊ - "Enable-Cloud": boolean␊ - "Enable-PUA": boolean␊ - ERAAgentCfgUrl: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface HpeSecurityApplicationDefender2 {␊ - publisher: "HPE.Security.ApplicationDefender"␊ - type: "DotnetAgent"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - protectedSettings: {␊ - key: string␊ - serverURL: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface PuppetAgent2 {␊ - publisher: "Puppet"␊ - type: "PuppetAgent"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - protectedSettings: {␊ - PUPPET_MASTER_SERVER: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Site24X7LinuxServerExtn2 {␊ - publisher: "Site24x7"␊ - type: "Site24x7LinuxServerExtn"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - site24x7AgentType?: "azurevmextnlinuxserver"␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - site24x7LicenseKey: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Site24X7WindowsServerExtn2 {␊ - publisher: "Site24x7"␊ - type: "Site24x7WindowsServerExtn"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - site24x7AgentType?: "azurevmextnwindowsserver"␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - site24x7LicenseKey: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Site24X7ApmInsightExtn2 {␊ - publisher: "Site24x7"␊ - type: "Site24x7ApmInsightExtn"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - site24x7AgentType?: "azurevmextnapminsightclassic"␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - site24x7LicenseKey: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface TrendMicroDSALinux2 {␊ - publisher: "TrendMicro.DeepSecurity"␊ - type: "TrendMicroDSALinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - DSMname: string␊ - DSMport: string␊ - policyNameorID?: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - tenantID: string␊ - tenantPassword: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface TrendMicroDSA2 {␊ - publisher: "TrendMicro.DeepSecurity"␊ - type: "TrendMicroDSA"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - DSMname: string␊ - DSMport: string␊ - policyNameorID?: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - tenantID: string␊ - tenantPassword: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface BmcCtmAgentLinux2 {␊ - publisher: "ctm.bmc.com"␊ - type: "BmcCtmAgentLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - "Control-M Server Name": string␊ - "Agent Port": string␊ - "Host Group": string␊ - "User Account": string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface BmcCtmAgentWindows2 {␊ - publisher: "bmc.ctm"␊ - type: "AgentWinExt"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - "Control-M Server Name": string␊ - "Agent Port": string␊ - "Host Group": string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface OSPatchingForLinux2 {␊ - publisher: "Microsoft.OSTCExtensions"␊ - type: "OSPatchingForLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - disabled: boolean␊ - stop: boolean␊ - installDuration?: string␊ - intervalOfWeeks?: number␊ - dayOfWeek?: string␊ - startTime?: string␊ - rebootAfterPatch?: string␊ - category?: string␊ - oneoff?: boolean␊ - local?: boolean␊ - idleTestScript?: string␊ - healthyTestScript?: string␊ - distUpgradeList?: string␊ - distUpgradeAll?: boolean␊ - vmStatusTest?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - storageAccountName?: string␊ - storageAccountKey?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface VMSnapshot2 {␊ - publisher: "Microsoft.Azure.RecoveryServices"␊ - type: "VMSnapshot"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - locale: string␊ - taskId: string␊ - commandToExecute: string␊ - objectStr: string␊ - logsBlobUri: string␊ - statusBlobUri: string␊ - commandStartTimeUTCTicks: string␊ - vmType: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface VMSnapshotLinux2 {␊ - publisher: "Microsoft.Azure.RecoveryServices"␊ - type: "VMSnapshotLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - locale: string␊ - taskId: string␊ - commandToExecute: string␊ - objectStr: string␊ - logsBlobUri: string␊ - statusBlobUri: string␊ - commandStartTimeUTCTicks: string␊ - vmType: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface CustomScript2 {␊ - publisher: "Microsoft.Azure.Extensions"␊ - type: "CustomScript"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - fileUris: string[]␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - storageAccountName: string␊ - storageAccountKey: string␊ - commandToExecute: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface NetworkWatcherAgentWindows2 {␊ - publisher: "Microsoft.Azure.NetworkWatcher"␊ - type: "NetworkWatcherAgentWindows"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - [k: string]: unknown␊ - }␊ - export interface NetworkWatcherAgentLinux2 {␊ - publisher: "Microsoft.Azure.NetworkWatcher"␊ - type: "NetworkWatcherAgentLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/virtualMachineScaleSets␊ - */␊ - export interface VirtualMachineScaleSets2 {␊ - apiVersion: "2017-03-30"␊ - /**␊ - * Identity for the virtual machine scale set.␊ - */␊ - identity?: (VirtualMachineScaleSetIdentity1 | string)␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the VM scale set to create or update.␊ - */␊ - name: string␊ - /**␊ - * 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**.␊ - */␊ - plan?: (Plan2 | string)␊ - /**␊ - * Describes the properties of a Virtual Machine Scale Set.␊ - */␊ - properties: (VirtualMachineScaleSetProperties1 | string)␊ - resources?: VirtualMachineScaleSetsExtensionsChildResource[]␊ - /**␊ - * Describes a virtual machine scale set sku.␊ - */␊ - sku?: (Sku39 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/virtualMachineScaleSets"␊ - /**␊ - * The virtual machine scale set zones. NOTE: Availability zones can only be set when you create the scale set.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the virtual machine scale set.␊ - */␊ - export interface VirtualMachineScaleSetIdentity1 {␊ - /**␊ - * The type of identity used for the virtual machine scale set. Currently, the only supported type is 'SystemAssigned', which implicitly creates an identity.␊ - */␊ - type?: ("SystemAssigned" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the properties of a Virtual Machine Scale Set.␊ - */␊ - export interface VirtualMachineScaleSetProperties1 {␊ - /**␊ - * Specifies whether the Virtual Machine Scale Set should be overprovisioned.␊ - */␊ - overprovision?: (boolean | string)␊ - /**␊ - * When true this limits the scale set to a single placement group, of max size 100 virtual machines.␊ - */␊ - singlePlacementGroup?: (boolean | string)␊ - /**␊ - * Describes an upgrade policy - automatic, manual, or rolling.␊ - */␊ - upgradePolicy?: (UpgradePolicy2 | string)␊ - /**␊ - * Describes a virtual machine scale set virtual machine profile.␊ - */␊ - virtualMachineProfile?: (VirtualMachineScaleSetVMProfile1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes an upgrade policy - automatic, manual, or rolling.␊ - */␊ - export interface UpgradePolicy2 {␊ - /**␊ - * Whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the image becomes available.␊ - */␊ - automaticOSUpgrade?: (boolean | string)␊ - /**␊ - * 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.␊ - */␊ - mode?: (("Automatic" | "Manual" | "Rolling") | string)␊ - /**␊ - * The configuration parameters used while performing a rolling upgrade.␊ - */␊ - rollingUpgradePolicy?: (RollingUpgradePolicy | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The configuration parameters used while performing a rolling upgrade.␊ - */␊ - export interface RollingUpgradePolicy {␊ - /**␊ - * 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%.␊ - */␊ - maxBatchInstancePercent?: (number | string)␊ - /**␊ - * 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%.␊ - */␊ - maxUnhealthyInstancePercent?: (number | string)␊ - /**␊ - * 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%.␊ - */␊ - maxUnhealthyUpgradedInstancePercent?: (number | string)␊ - /**␊ - * 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).␊ - */␊ - pauseTimeBetweenBatches?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set virtual machine profile.␊ - */␊ - export interface VirtualMachineScaleSetVMProfile1 {␊ - /**␊ - * Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15.␊ - */␊ - diagnosticsProfile?: (DiagnosticsProfile1 | string)␊ - /**␊ - * Describes a virtual machine scale set extension profile.␊ - */␊ - extensionProfile?: (VirtualMachineScaleSetExtensionProfile2 | string)␊ - /**␊ - * 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␊ - */␊ - licenseType?: string␊ - /**␊ - * Describes a virtual machine scale set network profile.␊ - */␊ - networkProfile?: (VirtualMachineScaleSetNetworkProfile2 | string)␊ - /**␊ - * Describes a virtual machine scale set OS profile.␊ - */␊ - osProfile?: (VirtualMachineScaleSetOSProfile1 | string)␊ - /**␊ - * Describes a virtual machine scale set storage profile.␊ - */␊ - storageProfile?: (VirtualMachineScaleSetStorageProfile2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set extension profile.␊ - */␊ - export interface VirtualMachineScaleSetExtensionProfile2 {␊ - /**␊ - * The virtual machine scale set child extension resources.␊ - */␊ - extensions?: (VirtualMachineScaleSetExtension2[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a Virtual Machine Scale Set Extension.␊ - */␊ - export interface VirtualMachineScaleSetExtension2 {␊ - /**␊ - * The name of the extension.␊ - */␊ - name?: string␊ - properties?: (GenericExtension2 | IaaSDiagnostics2 | IaaSAntimalware2 | CustomScriptExtension2 | CustomScriptForLinux2 | LinuxDiagnostic2 | VmAccessForLinux2 | BgInfo2 | VmAccessAgent2 | DscExtension2 | AcronisBackupLinux2 | AcronisBackup2 | LinuxChefClient2 | ChefClient2 | DatadogLinuxAgent2 | DatadogWindowsAgent2 | DockerExtension2 | DynatraceLinux2 | DynatraceWindows2 | Eset2 | HpeSecurityApplicationDefender2 | PuppetAgent2 | Site24X7LinuxServerExtn2 | Site24X7WindowsServerExtn2 | Site24X7ApmInsightExtn2 | TrendMicroDSALinux2 | TrendMicroDSA2 | BmcCtmAgentLinux2 | BmcCtmAgentWindows2 | OSPatchingForLinux2 | VMSnapshot2 | VMSnapshotLinux2 | CustomScript2 | NetworkWatcherAgentWindows2 | NetworkWatcherAgentLinux2)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set network profile.␊ - */␊ - export interface VirtualMachineScaleSetNetworkProfile2 {␊ - /**␊ - * The API entity reference.␊ - */␊ - healthProbe?: (ApiEntityReference1 | string)␊ - /**␊ - * The list of network configurations.␊ - */␊ - networkInterfaceConfigurations?: (VirtualMachineScaleSetNetworkConfiguration1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The API entity reference.␊ - */␊ - export interface ApiEntityReference1 {␊ - /**␊ - * The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set network profile's network configurations.␊ - */␊ - export interface VirtualMachineScaleSetNetworkConfiguration1 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * The network configuration name.␊ - */␊ - name: string␊ - /**␊ - * Describes a virtual machine scale set network profile's IP configuration.␊ - */␊ - properties?: (VirtualMachineScaleSetNetworkConfigurationProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set network profile's IP configuration.␊ - */␊ - export interface VirtualMachineScaleSetNetworkConfigurationProperties1 {␊ - /**␊ - * Describes a virtual machines scale sets network configuration's DNS settings.␊ - */␊ - dnsSettings?: (VirtualMachineScaleSetNetworkConfigurationDnsSettings | string)␊ - /**␊ - * Specifies whether the network interface is accelerated networking-enabled.␊ - */␊ - enableAcceleratedNetworking?: (boolean | string)␊ - /**␊ - * Specifies the IP configurations of the network interface.␊ - */␊ - ipConfigurations: (VirtualMachineScaleSetIPConfiguration1[] | string)␊ - networkSecurityGroup?: (SubResource5 | string)␊ - /**␊ - * Specifies the primary network interface in case the virtual machine has more than 1 network interface.␊ - */␊ - primary?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machines scale sets network configuration's DNS settings.␊ - */␊ - export interface VirtualMachineScaleSetNetworkConfigurationDnsSettings {␊ - /**␊ - * List of DNS servers IP addresses␊ - */␊ - dnsServers?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set network profile's IP configuration.␊ - */␊ - export interface VirtualMachineScaleSetIPConfiguration1 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * The IP configuration name.␊ - */␊ - name: string␊ - /**␊ - * Describes a virtual machine scale set network profile's IP configuration properties.␊ - */␊ - properties?: (VirtualMachineScaleSetIPConfigurationProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set network profile's IP configuration properties.␊ - */␊ - export interface VirtualMachineScaleSetIPConfigurationProperties1 {␊ - /**␊ - * 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.␊ - */␊ - applicationGatewayBackendAddressPools?: (SubResource5[] | string)␊ - /**␊ - * 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.␊ - */␊ - loadBalancerBackendAddressPools?: (SubResource5[] | string)␊ - /**␊ - * 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␊ - */␊ - loadBalancerInboundNatPools?: (SubResource5[] | string)␊ - /**␊ - * Specifies the primary network interface in case the virtual machine has more than 1 network interface.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * 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'.␊ - */␊ - privateIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration␊ - */␊ - publicIPAddressConfiguration?: (VirtualMachineScaleSetPublicIPAddressConfiguration | string)␊ - /**␊ - * The API entity reference.␊ - */␊ - subnet?: (ApiEntityReference1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration␊ - */␊ - export interface VirtualMachineScaleSetPublicIPAddressConfiguration {␊ - /**␊ - * The publicIP address configuration name.␊ - */␊ - name: string␊ - /**␊ - * Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration␊ - */␊ - properties?: (VirtualMachineScaleSetPublicIPAddressConfigurationProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration␊ - */␊ - export interface VirtualMachineScaleSetPublicIPAddressConfigurationProperties {␊ - /**␊ - * Describes a virtual machines scale sets network configuration's DNS settings.␊ - */␊ - dnsSettings?: (VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings | string)␊ - /**␊ - * The idle timeout of the public IP address.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machines scale sets network configuration's DNS settings.␊ - */␊ - export interface VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings {␊ - /**␊ - * 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␊ - */␊ - domainNameLabel: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set OS profile.␊ - */␊ - export interface VirtualMachineScaleSetOSProfile1 {␊ - /**␊ - * 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)␊ - */␊ - adminPassword?: string␊ - /**␊ - * 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)␊ - */␊ - adminUsername?: string␊ - /**␊ - * 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.␊ - */␊ - computerNamePrefix?: string␊ - /**␊ - * 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)␊ - */␊ - customData?: string␊ - /**␊ - * 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).␊ - */␊ - linuxConfiguration?: (LinuxConfiguration2 | string)␊ - /**␊ - * Specifies set of certificates that should be installed onto the virtual machines in the scale set.␊ - */␊ - secrets?: (VaultSecretGroup1[] | string)␊ - /**␊ - * Specifies Windows operating system settings on the virtual machine.␊ - */␊ - windowsConfiguration?: (WindowsConfiguration3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set storage profile.␊ - */␊ - export interface VirtualMachineScaleSetStorageProfile2 {␊ - /**␊ - * 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).␊ - */␊ - dataDisks?: (VirtualMachineScaleSetDataDisk1[] | string)␊ - /**␊ - * 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. NOTE: Image reference publisher and offer can only be set when you create the scale set.␊ - */␊ - imageReference?: (ImageReference3 | string)␊ - /**␊ - * Describes a virtual machine scale set operating system disk.␊ - */␊ - osDisk?: (VirtualMachineScaleSetOSDisk2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set data disk.␊ - */␊ - export interface VirtualMachineScaleSetDataDisk1 {␊ - /**␊ - * Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**.␊ - */␊ - caching?: (("None" | "ReadOnly" | "ReadWrite") | string)␊ - /**␊ - * The create option.␊ - */␊ - createOption: (("FromImage" | "Empty" | "Attach") | string)␊ - /**␊ - * Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB␊ - */␊ - diskSizeGB?: (number | string)␊ - /**␊ - * 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.␊ - */␊ - lun: (number | string)␊ - /**␊ - * Describes the parameters of a ScaleSet managed disk.␊ - */␊ - managedDisk?: (VirtualMachineScaleSetManagedDiskParameters1 | string)␊ - /**␊ - * The disk name.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the parameters of a ScaleSet managed disk.␊ - */␊ - export interface VirtualMachineScaleSetManagedDiskParameters1 {␊ - /**␊ - * Specifies the storage account type for the managed disk. Managed OS disk storage account type can only be set when you create the scale set. Possible values are: Standard_LRS or Premium_LRS.␊ - */␊ - storageAccountType?: (("Standard_LRS" | "Premium_LRS") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set operating system disk.␊ - */␊ - export interface VirtualMachineScaleSetOSDisk2 {␊ - /**␊ - * Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**.␊ - */␊ - caching?: (("None" | "ReadOnly" | "ReadWrite") | string)␊ - /**␊ - * 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.␊ - */␊ - createOption: (("FromImage" | "Empty" | "Attach") | string)␊ - /**␊ - * Describes the uri of a disk.␊ - */␊ - image?: (VirtualHardDisk1 | string)␊ - /**␊ - * Describes the parameters of a ScaleSet managed disk.␊ - */␊ - managedDisk?: (VirtualMachineScaleSetManagedDiskParameters1 | string)␊ - /**␊ - * The disk name.␊ - */␊ - name?: string␊ - /**␊ - * 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**.␊ - */␊ - osType?: (("Windows" | "Linux") | string)␊ - /**␊ - * Specifies the container urls that are used to store operating system disks for the scale set.␊ - */␊ - vhdContainers?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/virtualMachineScaleSets/extensions␊ - */␊ - export interface VirtualMachineScaleSetsExtensionsChildResource {␊ - apiVersion: "2017-03-30"␊ - /**␊ - * The name of the VM scale set extension.␊ - */␊ - name: string␊ - /**␊ - * Describes the properties of a Virtual Machine Scale Set Extension.␊ - */␊ - properties: (VirtualMachineScaleSetExtensionProperties | string)␊ - type: "extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the properties of a Virtual Machine Scale Set Extension.␊ - */␊ - export interface VirtualMachineScaleSetExtensionProperties {␊ - /**␊ - * 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.␊ - */␊ - autoUpgradeMinorVersion?: (boolean | string)␊ - /**␊ - * 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.␊ - */␊ - forceUpdateTag?: string␊ - /**␊ - * The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.␊ - */␊ - protectedSettings?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The name of the extension handler publisher.␊ - */␊ - publisher?: string␊ - /**␊ - * Json formatted public settings for the extension.␊ - */␊ - settings?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the type of the extension; an example is "CustomScriptExtension".␊ - */␊ - type?: string␊ - /**␊ - * Specifies the version of the script handler.␊ - */␊ - typeHandlerVersion?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/virtualMachines/extensions␊ - */␊ - export interface VirtualMachinesExtensions1 {␊ - apiVersion: "2017-03-30"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the virtual machine extension.␊ - */␊ - name: string␊ - properties: (GenericExtension2 | IaaSDiagnostics2 | IaaSAntimalware2 | CustomScriptExtension2 | CustomScriptForLinux2 | LinuxDiagnostic2 | VmAccessForLinux2 | BgInfo2 | VmAccessAgent2 | DscExtension2 | AcronisBackupLinux2 | AcronisBackup2 | LinuxChefClient2 | ChefClient2 | DatadogLinuxAgent2 | DatadogWindowsAgent2 | DockerExtension2 | DynatraceLinux2 | DynatraceWindows2 | Eset2 | HpeSecurityApplicationDefender2 | PuppetAgent2 | Site24X7LinuxServerExtn2 | Site24X7WindowsServerExtn2 | Site24X7ApmInsightExtn2 | TrendMicroDSALinux2 | TrendMicroDSA2 | BmcCtmAgentLinux2 | BmcCtmAgentWindows2 | OSPatchingForLinux2 | VMSnapshot2 | VMSnapshotLinux2 | CustomScript2 | NetworkWatcherAgentWindows2 | NetworkWatcherAgentLinux2)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/virtualMachines/extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers␊ - */␊ - export interface Servers2 {␊ - apiVersion: "2014-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the server.␊ - */␊ - name: string␊ - /**␊ - * Represents the properties of a server.␊ - */␊ - properties: (ServerProperties | string)␊ - resources?: (ServersDatabasesChildResource | ServersElasticPoolsChildResource | ServersCommunicationLinksChildResource | ServersConnectionPoliciesChildResource | ServersFirewallRulesChildResource | ServersAdministratorsChildResource | ServersAdvisorsChildResource | ServersDisasterRecoveryConfigurationChildResource | ServersAuditingPoliciesChildResource)[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Sql/servers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents the properties of a server.␊ - */␊ - export interface ServerProperties {␊ - /**␊ - * Administrator username for the server. Can only be specified when the server is being created (and is required for creation).␊ - */␊ - administratorLogin?: string␊ - /**␊ - * The administrator login password (required for server creation).␊ - */␊ - administratorLoginPassword?: string␊ - /**␊ - * The version of the server.␊ - */␊ - version?: (("2.0" | "12.0") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/databases␊ - */␊ - export interface ServersDatabasesChildResource {␊ - apiVersion: "2014-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the database to be operated on (updated or created).␊ - */␊ - name: string␊ - /**␊ - * Represents the properties of a database.␊ - */␊ - properties: (DatabaseProperties4 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "databases"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents the properties of a database.␊ - */␊ - export interface DatabaseProperties4 {␊ - /**␊ - * The collation of the database. If createMode is not Default, this value is ignored.␊ - */␊ - collation?: string␊ - /**␊ - * Specifies the mode of database creation.␊ - * ␊ - * Default: regular database creation.␊ - * ␊ - * Copy: creates a database as a copy of an existing database. sourceDatabaseId must be specified as the resource ID of the source database.␊ - * ␊ - * OnlineSecondary/NonReadableSecondary: creates a database as a (readable or nonreadable) secondary replica of an existing database. sourceDatabaseId must be specified as the resource ID of the existing primary database.␊ - * ␊ - * PointInTimeRestore: Creates a database by restoring a point in time backup of an existing database. sourceDatabaseId must be specified as the resource ID of the existing database, and restorePointInTime must be specified.␊ - * ␊ - * Recovery: Creates a database by restoring a geo-replicated backup. sourceDatabaseId must be specified as the recoverable database resource ID to restore.␊ - * ␊ - * Restore: Creates a database by restoring a backup of a deleted database. sourceDatabaseId must be specified. If sourceDatabaseId is the database's original resource ID, then sourceDatabaseDeletionDate must be specified. Otherwise sourceDatabaseId must be the restorable dropped database resource ID and sourceDatabaseDeletionDate is ignored. restorePointInTime may also be specified to restore from an earlier point in time.␊ - * ␊ - * RestoreLongTermRetentionBackup: Creates a database by restoring from a long term retention vault. recoveryServicesRecoveryPointResourceId must be specified as the recovery point resource ID.␊ - * ␊ - * Copy, NonReadableSecondary, OnlineSecondary and RestoreLongTermRetentionBackup are not supported for DataWarehouse edition.␊ - */␊ - createMode?: (("Copy" | "Default" | "NonReadableSecondary" | "OnlineSecondary" | "PointInTimeRestore" | "Recovery" | "Restore" | "RestoreLongTermRetentionBackup") | string)␊ - /**␊ - * The edition of the database. The DatabaseEditions enumeration contains all the valid editions. If createMode is NonReadableSecondary or OnlineSecondary, this value is ignored.␍␊ - * ␍␊ - * The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the \`Capabilities_ListByLocation\` REST API or one of the following commands:␍␊ - * ␍␊ - * \`\`\`azurecli␍␊ - * az sql db list-editions -l -o table␍␊ - * \`\`\`\`␍␊ - * ␍␊ - * \`\`\`powershell␍␊ - * Get-AzSqlServerServiceObjective -Location ␍␊ - * \`\`\`\`␍␊ - * .␊ - */␊ - edition?: (("Web" | "Business" | "Basic" | "Standard" | "Premium" | "PremiumRS" | "Free" | "Stretch" | "DataWarehouse" | "System" | "System2" | "GeneralPurpose" | "BusinessCritical" | "Hyperscale") | string)␊ - /**␊ - * The name of the elastic pool the database is in. If elasticPoolName and requestedServiceObjectiveName are both updated, the value of requestedServiceObjectiveName is ignored. Not supported for DataWarehouse edition.␊ - */␊ - elasticPoolName?: string␊ - /**␊ - * The max size of the database expressed in bytes. If createMode is not Default, this value is ignored. To see possible values, query the capabilities API (/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationID}/capabilities) referred to by operationId: "Capabilities_ListByLocation."␊ - */␊ - maxSizeBytes?: string␊ - /**␊ - * Conditional. If the database is a geo-secondary, readScale indicates whether read-only connections are allowed to this database or not. Not supported for DataWarehouse edition.␊ - */␊ - readScale?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Conditional. If createMode is RestoreLongTermRetentionBackup, then this value is required. Specifies the resource ID of the recovery point to restore from.␊ - */␊ - recoveryServicesRecoveryPointResourceId?: string␊ - /**␊ - * The configured service level objective ID of the database. This is the service level objective that is in the process of being applied to the database. Once successfully updated, it will match the value of currentServiceObjectiveId property. If requestedServiceObjectiveId and requestedServiceObjectiveName are both updated, the value of requestedServiceObjectiveId overrides the value of requestedServiceObjectiveName.␍␊ - * ␍␊ - * The list of SKUs may vary by region and support offer. To determine the service objective ids that are available to your subscription in an Azure region, use the \`Capabilities_ListByLocation\` REST API.␊ - */␊ - requestedServiceObjectiveId?: string␊ - /**␊ - * The name of the configured service level objective of the database. This is the service level objective that is in the process of being applied to the database. Once successfully updated, it will match the value of serviceLevelObjective property. ␍␊ - * ␍␊ - * The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the \`Capabilities_ListByLocation\` REST API or one of the following commands:␍␊ - * ␍␊ - * \`\`\`azurecli␍␊ - * az sql db list-editions -l -o table␍␊ - * \`\`\`\`␍␊ - * ␍␊ - * \`\`\`powershell␍␊ - * Get-AzSqlServerServiceObjective -Location ␍␊ - * \`\`\`\`␍␊ - * .␊ - */␊ - requestedServiceObjectiveName?: (("System" | "System0" | "System1" | "System2" | "System3" | "System4" | "System2L" | "System3L" | "System4L" | "Free" | "Basic" | "S0" | "S1" | "S2" | "S3" | "S4" | "S6" | "S7" | "S9" | "S12" | "P1" | "P2" | "P3" | "P4" | "P6" | "P11" | "P15" | "PRS1" | "PRS2" | "PRS4" | "PRS6" | "DW100" | "DW200" | "DW300" | "DW400" | "DW500" | "DW600" | "DW1000" | "DW1200" | "DW1000c" | "DW1500" | "DW1500c" | "DW2000" | "DW2000c" | "DW3000" | "DW2500c" | "DW3000c" | "DW6000" | "DW5000c" | "DW6000c" | "DW7500c" | "DW10000c" | "DW15000c" | "DW30000c" | "DS100" | "DS200" | "DS300" | "DS400" | "DS500" | "DS600" | "DS1000" | "DS1200" | "DS1500" | "DS2000" | "ElasticPool") | string)␊ - /**␊ - * Conditional. If createMode is PointInTimeRestore, this value is required. If createMode is Restore, this value is optional. Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. Must be greater than or equal to the source database's earliestRestoreDate value.␊ - */␊ - restorePointInTime?: string␊ - /**␊ - * Indicates the name of the sample schema to apply when creating this database. If createMode is not Default, this value is ignored. Not supported for DataWarehouse edition.␊ - */␊ - sampleName?: ("AdventureWorksLT" | string)␊ - /**␊ - * Conditional. If createMode is Restore and sourceDatabaseId is the deleted database's original resource id when it existed (as opposed to its current restorable dropped database id), then this value is required. Specifies the time that the database was deleted.␊ - */␊ - sourceDatabaseDeletionDate?: string␊ - /**␊ - * Conditional. If createMode is Copy, NonReadableSecondary, OnlineSecondary, PointInTimeRestore, Recovery, or Restore, then this value is required. Specifies the resource ID of the source database. If createMode is NonReadableSecondary or OnlineSecondary, the name of the source database must be the same as the new database being created.␊ - */␊ - sourceDatabaseId?: string␊ - /**␊ - * Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones.␊ - */␊ - zoneRedundant?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/elasticPools␊ - */␊ - export interface ServersElasticPoolsChildResource {␊ - apiVersion: "2014-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the elastic pool to be operated on (updated or created).␊ - */␊ - name: string␊ - /**␊ - * Represents the properties of an elastic pool.␊ - */␊ - properties: (ElasticPoolProperties | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "elasticPools"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents the properties of an elastic pool.␊ - */␊ - export interface ElasticPoolProperties {␊ - /**␊ - * The maximum DTU any one database can consume.␊ - */␊ - databaseDtuMax?: (number | string)␊ - /**␊ - * The minimum DTU all databases are guaranteed.␊ - */␊ - databaseDtuMin?: (number | string)␊ - /**␊ - * The total shared DTU for the database elastic pool.␊ - */␊ - dtu?: (number | string)␊ - /**␊ - * The edition of the elastic pool.␊ - */␊ - edition?: (("Basic" | "Standard" | "Premium" | "GeneralPurpose" | "BusinessCritical") | string)␊ - /**␊ - * Gets storage limit for the database elastic pool in MB.␊ - */␊ - storageMB?: (number | string)␊ - /**␊ - * Whether or not this database elastic pool is zone redundant, which means the replicas of this database will be spread across multiple availability zones.␊ - */␊ - zoneRedundant?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/communicationLinks␊ - */␊ - export interface ServersCommunicationLinksChildResource {␊ - apiVersion: "2014-04-01"␊ - /**␊ - * The name of the server communication link.␊ - */␊ - name: string␊ - /**␊ - * The properties of a server communication link.␊ - */␊ - properties: (ServerCommunicationLinkProperties | string)␊ - type: "communicationLinks"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a server communication link.␊ - */␊ - export interface ServerCommunicationLinkProperties {␊ - /**␊ - * The name of the partner server.␊ - */␊ - partnerServer: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/connectionPolicies␊ - */␊ - export interface ServersConnectionPoliciesChildResource {␊ - apiVersion: "2014-04-01"␊ - /**␊ - * The name of the connection policy.␊ - */␊ - name: "default"␊ - /**␊ - * The properties of a server secure connection policy.␊ - */␊ - properties: (ServerConnectionPolicyProperties | string)␊ - type: "connectionPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a server secure connection policy.␊ - */␊ - export interface ServerConnectionPolicyProperties {␊ - /**␊ - * The server connection type.␊ - */␊ - connectionType: (("Default" | "Proxy" | "Redirect") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/firewallRules␊ - */␊ - export interface ServersFirewallRulesChildResource {␊ - apiVersion: "2014-04-01"␊ - /**␊ - * The name of the firewall rule.␊ - */␊ - name: string␊ - /**␊ - * Represents the properties of a server firewall rule.␊ - */␊ - properties: (FirewallRuleProperties1 | string)␊ - type: "firewallRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents the properties of a server firewall rule.␊ - */␊ - export interface FirewallRuleProperties1 {␊ - /**␊ - * The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress. Use value '0.0.0.0' to represent all Azure-internal IP addresses.␊ - */␊ - endIpAddress: string␊ - /**␊ - * The start IP address of the firewall rule. Must be IPv4 format. Use value '0.0.0.0' to represent all Azure-internal IP addresses.␊ - */␊ - startIpAddress: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/administrators␊ - */␊ - export interface ServersAdministratorsChildResource {␊ - apiVersion: "2014-04-01"␊ - /**␊ - * Name of the server administrator resource.␊ - */␊ - name: "activeDirectory"␊ - /**␊ - * The properties of an server Administrator.␊ - */␊ - properties: (ServerAdministratorProperties | string)␊ - type: "administrators"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of an server Administrator.␊ - */␊ - export interface ServerAdministratorProperties {␊ - /**␊ - * The type of administrator.␊ - */␊ - administratorType: ("ActiveDirectory" | string)␊ - /**␊ - * The server administrator login value.␊ - */␊ - login: string␊ - /**␊ - * The server administrator Sid (Secure ID).␊ - */␊ - sid: string␊ - /**␊ - * The server Active Directory Administrator tenant id.␊ - */␊ - tenantId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/advisors␊ - */␊ - export interface ServersAdvisorsChildResource {␊ - apiVersion: "2014-04-01"␊ - /**␊ - * The name of the Server Advisor.␊ - */␊ - name: string␊ - /**␊ - * Properties for a Database, Server or Elastic Pool Advisor.␊ - */␊ - properties: (AdvisorProperties | string)␊ - type: "advisors"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties for a Database, Server or Elastic Pool Advisor.␊ - */␊ - export interface AdvisorProperties {␊ - /**␊ - * Gets the auto-execute status (whether to let the system execute the recommendations) of this advisor. Possible values are 'Enabled' and 'Disabled'.␊ - */␊ - autoExecuteValue: (("Enabled" | "Disabled" | "Default") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/disasterRecoveryConfiguration␊ - */␊ - export interface ServersDisasterRecoveryConfigurationChildResource {␊ - apiVersion: "2014-04-01"␊ - /**␊ - * The name of the disaster recovery configuration to be created/updated.␊ - */␊ - name: string␊ - type: "disasterRecoveryConfiguration"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/auditingPolicies␊ - */␊ - export interface ServersAuditingPoliciesChildResource {␊ - apiVersion: "2014-04-01"␊ - /**␊ - * The name of the table auditing policy.␊ - */␊ - name: "default"␊ - /**␊ - * Properties of a server table auditing policy.␊ - */␊ - properties: (ServerTableAuditingPolicyProperties | string)␊ - type: "auditingPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a server table auditing policy.␊ - */␊ - export interface ServerTableAuditingPolicyProperties {␊ - /**␊ - * The state of the policy.␊ - */␊ - auditingState?: string␊ - /**␊ - * The audit logs table name.␊ - */␊ - auditLogsTableName?: string␊ - /**␊ - * Comma-separated list of event types to audit.␊ - */␊ - eventTypesToAudit?: string␊ - /**␊ - * The full audit logs table name.␊ - */␊ - fullAuditLogsTableName?: string␊ - /**␊ - * The number of days to keep in the audit logs.␊ - */␊ - retentionDays?: string␊ - /**␊ - * The key of the auditing storage account.␊ - */␊ - storageAccountKey?: string␊ - /**␊ - * The table storage account name␊ - */␊ - storageAccountName?: string␊ - /**␊ - * The table storage account resource group name␊ - */␊ - storageAccountResourceGroupName?: string␊ - /**␊ - * The secondary key of the auditing storage account.␊ - */␊ - storageAccountSecondaryKey?: string␊ - /**␊ - * The table storage subscription Id.␊ - */␊ - storageAccountSubscriptionId?: string␊ - /**␊ - * The storage table endpoint.␊ - */␊ - storageTableEndpoint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/advisors␊ - */␊ - export interface ServersAdvisors {␊ - apiVersion: "2014-04-01"␊ - /**␊ - * The name of the Server Advisor.␊ - */␊ - name: string␊ - /**␊ - * Properties for a Database, Server or Elastic Pool Advisor.␊ - */␊ - properties: (AdvisorProperties | string)␊ - type: "Microsoft.Sql/servers/advisors"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/administrators␊ - */␊ - export interface ServersAdministrators {␊ - apiVersion: "2014-04-01"␊ - /**␊ - * Name of the server administrator resource.␊ - */␊ - name: string␊ - /**␊ - * The properties of an server Administrator.␊ - */␊ - properties: (ServerAdministratorProperties | string)␊ - type: "Microsoft.Sql/servers/administrators"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/auditingPolicies␊ - */␊ - export interface ServersAuditingPolicies {␊ - apiVersion: "2014-04-01"␊ - /**␊ - * The name of the table auditing policy.␊ - */␊ - name: string␊ - /**␊ - * Properties of a server table auditing policy.␊ - */␊ - properties: (ServerTableAuditingPolicyProperties | string)␊ - type: "Microsoft.Sql/servers/auditingPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/communicationLinks␊ - */␊ - export interface ServersCommunicationLinks {␊ - apiVersion: "2014-04-01"␊ - /**␊ - * The name of the server communication link.␊ - */␊ - name: string␊ - /**␊ - * The properties of a server communication link.␊ - */␊ - properties: (ServerCommunicationLinkProperties | string)␊ - type: "Microsoft.Sql/servers/communicationLinks"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/connectionPolicies␊ - */␊ - export interface ServersConnectionPolicies {␊ - apiVersion: "2014-04-01"␊ - /**␊ - * The name of the connection policy.␊ - */␊ - name: string␊ - /**␊ - * The properties of a server secure connection policy.␊ - */␊ - properties: (ServerConnectionPolicyProperties | string)␊ - type: "Microsoft.Sql/servers/connectionPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/databases␊ - */␊ - export interface ServersDatabases {␊ - apiVersion: "2014-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the database to be operated on (updated or created).␊ - */␊ - name: string␊ - /**␊ - * Represents the properties of a database.␊ - */␊ - properties: (DatabaseProperties4 | string)␊ - resources?: (ServersDatabasesDataMaskingPoliciesChildResource | ServersDatabasesGeoBackupPoliciesChildResource | ServersDatabasesExtensionsChildResource | ServersDatabasesSecurityAlertPoliciesChildResource | ServersDatabasesTransparentDataEncryptionChildResource | ServersDatabasesAdvisorsChildResource | ServersDatabasesAuditingPoliciesChildResource | ServersDatabasesConnectionPoliciesChildResource)[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Sql/servers/databases"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/databases/dataMaskingPolicies␊ - */␊ - export interface ServersDatabasesDataMaskingPoliciesChildResource {␊ - apiVersion: "2014-04-01"␊ - /**␊ - * The name of the database for which the data masking rule applies.␊ - */␊ - name: "Default"␊ - /**␊ - * The properties of a database data masking policy.␊ - */␊ - properties: (DataMaskingPolicyProperties | string)␊ - type: "dataMaskingPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a database data masking policy.␊ - */␊ - export interface DataMaskingPolicyProperties {␊ - /**␊ - * The state of the data masking policy.␊ - */␊ - dataMaskingState: (("Disabled" | "Enabled") | string)␊ - /**␊ - * The list of the exempt principals. Specifies the semicolon-separated list of database users for which the data masking policy does not apply. The specified users receive data results without masking for all of the database queries.␊ - */␊ - exemptPrincipals?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/databases/geoBackupPolicies␊ - */␊ - export interface ServersDatabasesGeoBackupPoliciesChildResource {␊ - apiVersion: "2014-04-01"␊ - /**␊ - * The name of the geo backup policy.␊ - */␊ - name: "Default"␊ - /**␊ - * The properties of the geo backup policy.␊ - */␊ - properties: (GeoBackupPolicyProperties | string)␊ - type: "geoBackupPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the geo backup policy.␊ - */␊ - export interface GeoBackupPolicyProperties {␊ - /**␊ - * The state of the geo backup policy.␊ - */␊ - state: (("Disabled" | "Enabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/databases/extensions␊ - */␊ - export interface ServersDatabasesExtensionsChildResource {␊ - apiVersion: "2014-04-01"␊ - /**␊ - * The name of the operation to perform␊ - */␊ - name: "import"␊ - /**␊ - * Represents the properties for an import operation␊ - */␊ - properties: (ImportExtensionProperties | string)␊ - type: "extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents the properties for an import operation␊ - */␊ - export interface ImportExtensionProperties {␊ - /**␊ - * The name of the SQL administrator.␊ - */␊ - administratorLogin: string␊ - /**␊ - * The password of the SQL administrator.␊ - */␊ - administratorLoginPassword: string␊ - /**␊ - * The authentication type.␊ - */␊ - authenticationType?: (("SQL" | "ADPassword") | string)␊ - /**␊ - * The type of import operation being performed. This is always Import.␊ - */␊ - operationMode: ("Import" | string)␊ - /**␊ - * The storage key to use. If storage key type is SharedAccessKey, it must be preceded with a "?."␊ - */␊ - storageKey: string␊ - /**␊ - * The type of the storage key to use.␊ - */␊ - storageKeyType: (("StorageAccessKey" | "SharedAccessKey") | string)␊ - /**␊ - * The storage uri to use.␊ - */␊ - storageUri: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/databases/securityAlertPolicies␊ - */␊ - export interface ServersDatabasesSecurityAlertPoliciesChildResource {␊ - apiVersion: "2014-04-01"␊ - /**␊ - * The geo-location where the resource lives␊ - */␊ - location?: string␊ - /**␊ - * The name of the security alert policy.␊ - */␊ - name: "default"␊ - /**␊ - * Properties for a database Threat Detection policy.␊ - */␊ - properties: (DatabaseSecurityAlertPolicyProperties | string)␊ - type: "securityAlertPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties for a database Threat Detection policy.␊ - */␊ - export interface DatabaseSecurityAlertPolicyProperties {␊ - /**␊ - * Specifies the semicolon-separated list of alerts that are disabled, or empty string to disable no alerts. Possible values: Sql_Injection; Sql_Injection_Vulnerability; Access_Anomaly; Data_Exfiltration; Unsafe_Action.␊ - */␊ - disabledAlerts?: string␊ - /**␊ - * Specifies that the alert is sent to the account administrators.␊ - */␊ - emailAccountAdmins?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Specifies the semicolon-separated list of e-mail addresses to which the alert is sent.␊ - */␊ - emailAddresses?: string␊ - /**␊ - * Specifies the number of days to keep in the Threat Detection audit logs.␊ - */␊ - retentionDays?: (number | string)␊ - /**␊ - * Specifies the state of the policy. If state is Enabled, storageEndpoint and storageAccountAccessKey are required.␊ - */␊ - state: (("New" | "Enabled" | "Disabled") | string)␊ - /**␊ - * Specifies the identifier key of the Threat Detection audit storage account. If state is Enabled, storageAccountAccessKey is required.␊ - */␊ - storageAccountAccessKey?: string␊ - /**␊ - * Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. If state is Enabled, storageEndpoint is required.␊ - */␊ - storageEndpoint?: string␊ - /**␊ - * Specifies whether to use the default server policy.␊ - */␊ - useServerDefault?: (("Enabled" | "Disabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/databases/transparentDataEncryption␊ - */␊ - export interface ServersDatabasesTransparentDataEncryptionChildResource {␊ - apiVersion: "2014-04-01"␊ - /**␊ - * The name of the transparent data encryption configuration.␊ - */␊ - name: "current"␊ - /**␊ - * Represents the properties of a database transparent data encryption.␊ - */␊ - properties: (TransparentDataEncryptionProperties | string)␊ - type: "transparentDataEncryption"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents the properties of a database transparent data encryption.␊ - */␊ - export interface TransparentDataEncryptionProperties {␊ - /**␊ - * The status of the database transparent data encryption.␊ - */␊ - status?: (("Enabled" | "Disabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/databases/advisors␊ - */␊ - export interface ServersDatabasesAdvisorsChildResource {␊ - apiVersion: "2014-04-01"␊ - /**␊ - * The name of the Database Advisor.␊ - */␊ - name: string␊ - /**␊ - * Properties for a Database, Server or Elastic Pool Advisor.␊ - */␊ - properties: (AdvisorProperties | string)␊ - type: "advisors"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/databases/auditingPolicies␊ - */␊ - export interface ServersDatabasesAuditingPoliciesChildResource {␊ - apiVersion: "2014-04-01"␊ - /**␊ - * The name of the table auditing policy.␊ - */␊ - name: "default"␊ - /**␊ - * Properties of a database table auditing policy.␊ - */␊ - properties: (DatabaseTableAuditingPolicyProperties | string)␊ - type: "auditingPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a database table auditing policy.␊ - */␊ - export interface DatabaseTableAuditingPolicyProperties {␊ - /**␊ - * The state of the policy.␊ - */␊ - auditingState?: string␊ - /**␊ - * The audit logs table name.␊ - */␊ - auditLogsTableName?: string␊ - /**␊ - * Comma-separated list of event types to audit.␊ - */␊ - eventTypesToAudit?: string␊ - /**␊ - * The full audit logs table name.␊ - */␊ - fullAuditLogsTableName?: string␊ - /**␊ - * The number of days to keep in the audit logs.␊ - */␊ - retentionDays?: string␊ - /**␊ - * The key of the auditing storage account.␊ - */␊ - storageAccountKey?: string␊ - /**␊ - * The table storage account name␊ - */␊ - storageAccountName?: string␊ - /**␊ - * The table storage account resource group name␊ - */␊ - storageAccountResourceGroupName?: string␊ - /**␊ - * The secondary key of the auditing storage account.␊ - */␊ - storageAccountSecondaryKey?: string␊ - /**␊ - * The table storage subscription Id.␊ - */␊ - storageAccountSubscriptionId?: string␊ - /**␊ - * The storage table endpoint.␊ - */␊ - storageTableEndpoint?: string␊ - /**␊ - * Whether server default is enabled or disabled.␊ - */␊ - useServerDefault?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/databases/connectionPolicies␊ - */␊ - export interface ServersDatabasesConnectionPoliciesChildResource {␊ - apiVersion: "2014-04-01"␊ - /**␊ - * The name of the connection policy.␊ - */␊ - name: "default"␊ - /**␊ - * Properties of a database connection policy.␊ - */␊ - properties: (DatabaseConnectionPolicyProperties | string)␊ - type: "connectionPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a database connection policy.␊ - */␊ - export interface DatabaseConnectionPolicyProperties {␊ - /**␊ - * The fully qualified host name of the auditing proxy.␊ - */␊ - proxyDnsName?: string␊ - /**␊ - * The port number of the auditing proxy.␊ - */␊ - proxyPort?: string␊ - /**␊ - * The state of proxy redirection.␊ - */␊ - redirectionState?: string␊ - /**␊ - * The state of security access.␊ - */␊ - securityEnabledAccess?: string␊ - /**␊ - * The connection policy state.␊ - */␊ - state?: string␊ - /**␊ - * Whether server default is enabled or disabled.␊ - */␊ - useServerDefault?: string␊ - /**␊ - * The visibility of the auditing proxy.␊ - */␊ - visibility?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/databases/advisors␊ - */␊ - export interface ServersDatabasesAdvisors {␊ - apiVersion: "2014-04-01"␊ - /**␊ - * The name of the Database Advisor.␊ - */␊ - name: string␊ - /**␊ - * Properties for a Database, Server or Elastic Pool Advisor.␊ - */␊ - properties: (AdvisorProperties | string)␊ - type: "Microsoft.Sql/servers/databases/advisors"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/databases/auditingPolicies␊ - */␊ - export interface ServersDatabasesAuditingPolicies {␊ - apiVersion: "2014-04-01"␊ - /**␊ - * The name of the table auditing policy.␊ - */␊ - name: string␊ - /**␊ - * Properties of a database table auditing policy.␊ - */␊ - properties: (DatabaseTableAuditingPolicyProperties | string)␊ - type: "Microsoft.Sql/servers/databases/auditingPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/databases/connectionPolicies␊ - */␊ - export interface ServersDatabasesConnectionPolicies {␊ - apiVersion: "2014-04-01"␊ - /**␊ - * The name of the connection policy.␊ - */␊ - name: string␊ - /**␊ - * Properties of a database connection policy.␊ - */␊ - properties: (DatabaseConnectionPolicyProperties | string)␊ - type: "Microsoft.Sql/servers/databases/connectionPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/databases/dataMaskingPolicies␊ - */␊ - export interface ServersDatabasesDataMaskingPolicies {␊ - apiVersion: "2014-04-01"␊ - /**␊ - * The name of the database for which the data masking rule applies.␊ - */␊ - name: string␊ - /**␊ - * The properties of a database data masking policy.␊ - */␊ - properties: (DataMaskingPolicyProperties | string)␊ - resources?: ServersDatabasesDataMaskingPoliciesRulesChildResource[]␊ - type: "Microsoft.Sql/servers/databases/dataMaskingPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/databases/dataMaskingPolicies/rules␊ - */␊ - export interface ServersDatabasesDataMaskingPoliciesRulesChildResource {␊ - apiVersion: "2014-04-01"␊ - /**␊ - * The name of the data masking rule.␊ - */␊ - name: string␊ - /**␊ - * The properties of a database data masking rule.␊ - */␊ - properties: (DataMaskingRuleProperties | string)␊ - type: "rules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a database data masking rule.␊ - */␊ - export interface DataMaskingRuleProperties {␊ - /**␊ - * The alias name. This is a legacy parameter and is no longer used.␊ - */␊ - aliasName?: string␊ - /**␊ - * The column name on which the data masking rule is applied.␊ - */␊ - columnName: string␊ - /**␊ - * The masking function that is used for the data masking rule.␊ - */␊ - maskingFunction: (("Default" | "CCN" | "Email" | "Number" | "SSN" | "Text") | string)␊ - /**␊ - * The numberFrom property of the masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored.␊ - */␊ - numberFrom?: string␊ - /**␊ - * The numberTo property of the data masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored.␊ - */␊ - numberTo?: string␊ - /**␊ - * If maskingFunction is set to Text, the number of characters to show unmasked in the beginning of the string. Otherwise, this parameter will be ignored.␊ - */␊ - prefixSize?: string␊ - /**␊ - * If maskingFunction is set to Text, the character to use for masking the unexposed part of the string. Otherwise, this parameter will be ignored.␊ - */␊ - replacementString?: string␊ - /**␊ - * The rule state. Used to delete a rule. To delete an existing rule, specify the schemaName, tableName, columnName, maskingFunction, and specify ruleState as disabled. However, if the rule doesn't already exist, the rule will be created with ruleState set to enabled, regardless of the provided value of ruleState.␊ - */␊ - ruleState?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * The schema name on which the data masking rule is applied.␊ - */␊ - schemaName: string␊ - /**␊ - * If maskingFunction is set to Text, the number of characters to show unmasked at the end of the string. Otherwise, this parameter will be ignored.␊ - */␊ - suffixSize?: string␊ - /**␊ - * The table name on which the data masking rule is applied.␊ - */␊ - tableName: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/databases/dataMaskingPolicies/rules␊ - */␊ - export interface ServersDatabasesDataMaskingPoliciesRules {␊ - apiVersion: "2014-04-01"␊ - /**␊ - * The name of the data masking rule.␊ - */␊ - name: string␊ - /**␊ - * The properties of a database data masking rule.␊ - */␊ - properties: (DataMaskingRuleProperties | string)␊ - type: "Microsoft.Sql/servers/databases/dataMaskingPolicies/rules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/databases/extensions␊ - */␊ - export interface ServersDatabasesExtensions {␊ - apiVersion: "2014-04-01"␊ - /**␊ - * The name of the operation to perform␊ - */␊ - name: string␊ - /**␊ - * Represents the properties for an import operation␊ - */␊ - properties: (ImportExtensionProperties | string)␊ - type: "Microsoft.Sql/servers/databases/extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/databases/geoBackupPolicies␊ - */␊ - export interface ServersDatabasesGeoBackupPolicies {␊ - apiVersion: "2014-04-01"␊ - /**␊ - * The name of the geo backup policy.␊ - */␊ - name: string␊ - /**␊ - * The properties of the geo backup policy.␊ - */␊ - properties: (GeoBackupPolicyProperties | string)␊ - type: "Microsoft.Sql/servers/databases/geoBackupPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/databases/securityAlertPolicies␊ - */␊ - export interface ServersDatabasesSecurityAlertPolicies {␊ - apiVersion: "2014-04-01"␊ - /**␊ - * The geo-location where the resource lives␊ - */␊ - location?: string␊ - /**␊ - * The name of the security alert policy.␊ - */␊ - name: string␊ - /**␊ - * Properties for a database Threat Detection policy.␊ - */␊ - properties: (DatabaseSecurityAlertPolicyProperties | string)␊ - type: "Microsoft.Sql/servers/databases/securityAlertPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/databases/transparentDataEncryption␊ - */␊ - export interface ServersDatabasesTransparentDataEncryption {␊ - apiVersion: "2014-04-01"␊ - /**␊ - * The name of the transparent data encryption configuration.␊ - */␊ - name: string␊ - /**␊ - * Represents the properties of a database transparent data encryption.␊ - */␊ - properties: (TransparentDataEncryptionProperties | string)␊ - type: "Microsoft.Sql/servers/databases/transparentDataEncryption"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/disasterRecoveryConfiguration␊ - */␊ - export interface ServersDisasterRecoveryConfiguration {␊ - apiVersion: "2014-04-01"␊ - /**␊ - * The name of the disaster recovery configuration to be created/updated.␊ - */␊ - name: string␊ - type: "Microsoft.Sql/servers/disasterRecoveryConfiguration"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/elasticPools␊ - */␊ - export interface ServersElasticPools {␊ - apiVersion: "2014-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the elastic pool to be operated on (updated or created).␊ - */␊ - name: string␊ - /**␊ - * Represents the properties of an elastic pool.␊ - */␊ - properties: (ElasticPoolProperties | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Sql/servers/elasticPools"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/firewallRules␊ - */␊ - export interface ServersFirewallRules {␊ - apiVersion: "2014-04-01"␊ - /**␊ - * The name of the firewall rule.␊ - */␊ - name: string␊ - /**␊ - * Represents the properties of a server firewall rule.␊ - */␊ - properties: (FirewallRuleProperties1 | string)␊ - type: "Microsoft.Sql/servers/firewallRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/managedInstances␊ - */␊ - export interface ManagedInstances {␊ - apiVersion: "2015-05-01-preview"␊ - /**␊ - * Azure Active Directory identity configuration for a resource.␊ - */␊ - identity?: (ResourceIdentity2 | string)␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the managed instance.␊ - */␊ - name: string␊ - /**␊ - * The properties of a managed instance.␊ - */␊ - properties: (ManagedInstanceProperties | string)␊ - /**␊ - * An ARM Resource SKU.␊ - */␊ - sku?: (Sku40 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Sql/managedInstances"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Active Directory identity configuration for a resource.␊ - */␊ - export interface ResourceIdentity2 {␊ - /**␊ - * The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource.␊ - */␊ - type?: (("None" | "SystemAssigned" | "UserAssigned" | "SystemAssigned,UserAssigned") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a managed instance.␊ - */␊ - export interface ManagedInstanceProperties {␊ - /**␊ - * Administrator username for the managed instance. Can only be specified when the managed instance is being created (and is required for creation).␊ - */␊ - administratorLogin?: string␊ - /**␊ - * The administrator login password (required for managed instance creation).␊ - */␊ - administratorLoginPassword?: string␊ - /**␊ - * Collation of the managed instance.␊ - */␊ - collation?: string␊ - /**␊ - * The resource id of another managed instance whose DNS zone this managed instance will share after creation.␊ - */␊ - dnsZonePartner?: string␊ - /**␊ - * The Id of the instance pool this managed server belongs to.␊ - */␊ - instancePoolId?: string␊ - /**␊ - * The license type. Possible values are 'LicenseIncluded' (regular price inclusive of a new SQL license) and 'BasePrice' (discounted AHB price for bringing your own SQL licenses).␊ - */␊ - licenseType?: (("LicenseIncluded" | "BasePrice") | string)␊ - /**␊ - * Specifies maintenance configuration id to apply to this managed instance.␊ - */␊ - maintenanceConfigurationId?: string␊ - /**␊ - * Specifies the mode of database creation.␍␊ - * ␍␊ - * Default: Regular instance creation.␍␊ - * ␍␊ - * Restore: Creates an instance by restoring a set of backups to specific point in time. RestorePointInTime and SourceManagedInstanceId must be specified.␊ - */␊ - managedInstanceCreateMode?: (("Default" | "PointInTimeRestore") | string)␊ - /**␊ - * Minimal TLS version. Allowed values: 'None', '1.0', '1.1', '1.2'␊ - */␊ - minimalTlsVersion?: string␊ - /**␊ - * Connection type used for connecting to the instance.␊ - */␊ - proxyOverride?: (("Proxy" | "Redirect" | "Default") | string)␊ - /**␊ - * Whether or not the public data endpoint is enabled.␊ - */␊ - publicDataEndpointEnabled?: (boolean | string)␊ - /**␊ - * Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database.␊ - */␊ - restorePointInTime?: string␊ - /**␊ - * The resource identifier of the source managed instance associated with create operation of this instance.␊ - */␊ - sourceManagedInstanceId?: string␊ - /**␊ - * Storage size in GB. Minimum value: 32. Maximum value: 8192. Increments of 32 GB allowed only.␊ - */␊ - storageSizeInGB?: (number | string)␊ - /**␊ - * Subnet resource ID for the managed instance.␊ - */␊ - subnetId?: string␊ - /**␊ - * Id of the timezone. Allowed values are timezones supported by Windows.␍␊ - * Windows keeps details on supported timezones, including the id, in registry under␍␊ - * KEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\Time Zones.␍␊ - * You can get those registry values via SQL Server by querying SELECT name AS timezone_id FROM sys.time_zone_info.␍␊ - * List of Ids can also be obtained by executing [System.TimeZoneInfo]::GetSystemTimeZones() in PowerShell.␍␊ - * An example of valid timezone id is "Pacific Standard Time" or "W. Europe Standard Time".␊ - */␊ - timezoneId?: string␊ - /**␊ - * The number of vCores. Allowed values: 8, 16, 24, 32, 40, 64, 80.␊ - */␊ - vCores?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An ARM Resource SKU.␊ - */␊ - export interface Sku40 {␊ - /**␊ - * Capacity of the particular SKU.␊ - */␊ - capacity?: (number | string)␊ - /**␊ - * If the service has different generations of hardware, for the same SKU, then that can be captured here.␊ - */␊ - family?: string␊ - /**␊ - * The name of the SKU, typically, a letter + Number code, e.g. P3.␊ - */␊ - name: string␊ - /**␊ - * Size of the particular SKU␊ - */␊ - size?: string␊ - /**␊ - * The tier or edition of the particular SKU, e.g. Basic, Premium.␊ - */␊ - tier?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers␊ - */␊ - export interface Servers3 {␊ - apiVersion: "2015-05-01-preview"␊ - /**␊ - * Azure Active Directory identity configuration for a resource.␊ - */␊ - identity?: (ResourceIdentity2 | string)␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the server.␊ - */␊ - name: string␊ - /**␊ - * The properties of a server.␊ - */␊ - properties: (ServerProperties1 | string)␊ - resources?: (ServersEncryptionProtectorChildResource | ServersFailoverGroupsChildResource | ServersKeysChildResource | ServersSyncAgentsChildResource | ServersVirtualNetworkRulesChildResource | ServersFirewallRulesChildResource1)[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Sql/servers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a server.␊ - */␊ - export interface ServerProperties1 {␊ - /**␊ - * Administrator username for the server. Once created it cannot be changed.␊ - */␊ - administratorLogin?: string␊ - /**␊ - * The administrator login password (required for server creation).␊ - */␊ - administratorLoginPassword?: string␊ - /**␊ - * The version of the server.␊ - */␊ - version?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/encryptionProtector␊ - */␊ - export interface ServersEncryptionProtectorChildResource {␊ - apiVersion: "2015-05-01-preview"␊ - /**␊ - * The name of the encryption protector to be updated.␊ - */␊ - name: "current"␊ - /**␊ - * Properties for an encryption protector execution.␊ - */␊ - properties: (EncryptionProtectorProperties | string)␊ - type: "encryptionProtector"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties for an encryption protector execution.␊ - */␊ - export interface EncryptionProtectorProperties {␊ - /**␊ - * The name of the server key.␊ - */␊ - serverKeyName?: string␊ - /**␊ - * The encryption protector type like 'ServiceManaged', 'AzureKeyVault'.␊ - */␊ - serverKeyType: (("ServiceManaged" | "AzureKeyVault") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/failoverGroups␊ - */␊ - export interface ServersFailoverGroupsChildResource {␊ - apiVersion: "2015-05-01-preview"␊ - /**␊ - * The name of the failover group.␊ - */␊ - name: string␊ - /**␊ - * Properties of a failover group.␊ - */␊ - properties: (FailoverGroupProperties | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "failoverGroups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a failover group.␊ - */␊ - export interface FailoverGroupProperties {␊ - /**␊ - * List of databases in the failover group.␊ - */␊ - databases?: (string[] | string)␊ - /**␊ - * List of partner server information for the failover group.␊ - */␊ - partnerServers: (PartnerInfo[] | string)␊ - /**␊ - * Read-only endpoint of the failover group instance.␊ - */␊ - readOnlyEndpoint?: (FailoverGroupReadOnlyEndpoint | string)␊ - /**␊ - * Read-write endpoint of the failover group instance.␊ - */␊ - readWriteEndpoint: (FailoverGroupReadWriteEndpoint | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Partner server information for the failover group.␊ - */␊ - export interface PartnerInfo {␊ - /**␊ - * Resource identifier of the partner server.␊ - */␊ - id: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Read-only endpoint of the failover group instance.␊ - */␊ - export interface FailoverGroupReadOnlyEndpoint {␊ - /**␊ - * Failover policy of the read-only endpoint for the failover group.␊ - */␊ - failoverPolicy?: (("Disabled" | "Enabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Read-write endpoint of the failover group instance.␊ - */␊ - export interface FailoverGroupReadWriteEndpoint {␊ - /**␊ - * Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.␊ - */␊ - failoverPolicy: (("Manual" | "Automatic") | string)␊ - /**␊ - * Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.␊ - */␊ - failoverWithDataLossGracePeriodMinutes?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/keys␊ - */␊ - export interface ServersKeysChildResource {␊ - apiVersion: "2015-05-01-preview"␊ - /**␊ - * Kind of encryption protector. This is metadata used for the Azure portal experience.␊ - */␊ - kind?: string␊ - /**␊ - * The name of the server key to be operated on (updated or created). The key name is required to be in the format of 'vault_key_version'. For example, if the keyId is https://YourVaultName.vault.azure.net/keys/YourKeyName/01234567890123456789012345678901, then the server key name should be formatted as: YourVaultName_YourKeyName_01234567890123456789012345678901␊ - */␊ - name: string␊ - /**␊ - * Properties for a server key execution.␊ - */␊ - properties: (ServerKeyProperties | string)␊ - type: "keys"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties for a server key execution.␊ - */␊ - export interface ServerKeyProperties {␊ - /**␊ - * The server key creation date.␊ - */␊ - creationDate?: string␊ - /**␊ - * The server key type like 'ServiceManaged', 'AzureKeyVault'.␊ - */␊ - serverKeyType: (("ServiceManaged" | "AzureKeyVault") | string)␊ - /**␊ - * Thumbprint of the server key.␊ - */␊ - thumbprint?: string␊ - /**␊ - * The URI of the server key.␊ - */␊ - uri?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/syncAgents␊ - */␊ - export interface ServersSyncAgentsChildResource {␊ - apiVersion: "2015-05-01-preview"␊ - /**␊ - * The name of the sync agent.␊ - */␊ - name: string␊ - /**␊ - * Properties of an Azure SQL Database sync agent.␊ - */␊ - properties: (SyncAgentProperties | string)␊ - type: "syncAgents"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of an Azure SQL Database sync agent.␊ - */␊ - export interface SyncAgentProperties {␊ - /**␊ - * ARM resource id of the sync database in the sync agent.␊ - */␊ - syncDatabaseId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/virtualNetworkRules␊ - */␊ - export interface ServersVirtualNetworkRulesChildResource {␊ - apiVersion: "2015-05-01-preview"␊ - /**␊ - * The name of the virtual network rule.␊ - */␊ - name: string␊ - /**␊ - * Properties of a virtual network rule.␊ - */␊ - properties: (VirtualNetworkRuleProperties | string)␊ - type: "virtualNetworkRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a virtual network rule.␊ - */␊ - export interface VirtualNetworkRuleProperties {␊ - /**␊ - * Create firewall rule before the virtual network has vnet service endpoint enabled.␊ - */␊ - ignoreMissingVnetServiceEndpoint?: (boolean | string)␊ - /**␊ - * The ARM resource id of the virtual network subnet.␊ - */␊ - virtualNetworkSubnetId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/firewallRules␊ - */␊ - export interface ServersFirewallRulesChildResource1 {␊ - apiVersion: "2015-05-01-preview"␊ - /**␊ - * The name of the firewall rule.␊ - */␊ - name: string␊ - /**␊ - * The properties of a server firewall rule.␊ - */␊ - properties: (ServerFirewallRuleProperties | string)␊ - type: "firewallRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a server firewall rule.␊ - */␊ - export interface ServerFirewallRuleProperties {␊ - /**␊ - * The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress. Use value '0.0.0.0' for all Azure-internal IP addresses.␊ - */␊ - endIpAddress?: string␊ - /**␊ - * The start IP address of the firewall rule. Must be IPv4 format. Use value '0.0.0.0' for all Azure-internal IP addresses.␊ - */␊ - startIpAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/databases/auditingSettings␊ - */␊ - export interface ServersDatabasesAuditingSettings {␊ - apiVersion: "2015-05-01-preview"␊ - /**␊ - * The name of the blob auditing policy.␊ - */␊ - name: string␊ - /**␊ - * Properties of a database blob auditing policy.␊ - */␊ - properties: (DatabaseBlobAuditingPolicyProperties | string)␊ - type: "Microsoft.Sql/servers/databases/auditingSettings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a database blob auditing policy.␊ - */␊ - export interface DatabaseBlobAuditingPolicyProperties {␊ - /**␊ - * Specifies the Actions-Groups and Actions to audit.␍␊ - * ␍␊ - * The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins:␍␊ - * ␍␊ - * BATCH_COMPLETED_GROUP,␍␊ - * SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP,␍␊ - * FAILED_DATABASE_AUTHENTICATION_GROUP.␍␊ - * ␍␊ - * This above combination is also the set that is configured by default when enabling auditing from the Azure portal.␍␊ - * ␍␊ - * The supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records):␍␊ - * ␍␊ - * APPLICATION_ROLE_CHANGE_PASSWORD_GROUP␍␊ - * BACKUP_RESTORE_GROUP␍␊ - * DATABASE_LOGOUT_GROUP␍␊ - * DATABASE_OBJECT_CHANGE_GROUP␍␊ - * DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP␍␊ - * DATABASE_OBJECT_PERMISSION_CHANGE_GROUP␍␊ - * DATABASE_OPERATION_GROUP␍␊ - * DATABASE_PERMISSION_CHANGE_GROUP␍␊ - * DATABASE_PRINCIPAL_CHANGE_GROUP␍␊ - * DATABASE_PRINCIPAL_IMPERSONATION_GROUP␍␊ - * DATABASE_ROLE_MEMBER_CHANGE_GROUP␍␊ - * FAILED_DATABASE_AUTHENTICATION_GROUP␍␊ - * SCHEMA_OBJECT_ACCESS_GROUP␍␊ - * SCHEMA_OBJECT_CHANGE_GROUP␍␊ - * SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP␍␊ - * SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP␍␊ - * SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP␍␊ - * USER_CHANGE_PASSWORD_GROUP␍␊ - * BATCH_STARTED_GROUP␍␊ - * BATCH_COMPLETED_GROUP␍␊ - * ␍␊ - * These are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs.␍␊ - * ␍␊ - * For more information, see [Database-Level Audit Action Groups](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups).␍␊ - * ␍␊ - * For Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are:␍␊ - * SELECT␍␊ - * UPDATE␍␊ - * INSERT␍␊ - * DELETE␍␊ - * EXECUTE␍␊ - * RECEIVE␍␊ - * REFERENCES␍␊ - * ␍␊ - * The general form for defining an action to be audited is:␍␊ - * {action} ON {object} BY {principal}␍␊ - * ␍␊ - * Note that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively.␍␊ - * ␍␊ - * For example:␍␊ - * SELECT on dbo.myTable by public␍␊ - * SELECT on DATABASE::myDatabase by public␍␊ - * SELECT on SCHEMA::mySchema by public␍␊ - * ␍␊ - * For more information, see [Database-Level Audit Actions](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions)␊ - */␊ - auditActionsAndGroups?: (string[] | string)␊ - /**␊ - * Specifies whether audit events are sent to Azure Monitor. ␍␊ - * In order to send the events to Azure Monitor, specify 'state' as 'Enabled' and 'isAzureMonitorTargetEnabled' as true.␍␊ - * ␍␊ - * When using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created.␍␊ - * Note that for server level audit you should use the 'master' database as {databaseName}.␍␊ - * ␍␊ - * Diagnostic Settings URI format:␍␊ - * PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview␍␊ - * ␍␊ - * For more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207)␍␊ - * or [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043)␍␊ - * ␊ - */␊ - isAzureMonitorTargetEnabled?: (boolean | string)␊ - /**␊ - * Specifies whether storageAccountAccessKey value is the storage's secondary key.␊ - */␊ - isStorageSecondaryKeyInUse?: (boolean | string)␊ - /**␊ - * Specifies the amount of time in milliseconds that can elapse before audit actions are forced to be processed.␍␊ - * The default minimum value is 1000 (1 second). The maximum is 2,147,483,647.␊ - */␊ - queueDelayMs?: (number | string)␊ - /**␊ - * Specifies the number of days to keep in the audit logs in the storage account.␊ - */␊ - retentionDays?: (number | string)␊ - /**␊ - * Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required.␊ - */␊ - state: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Specifies the identifier key of the auditing storage account. ␍␊ - * If state is Enabled and storageEndpoint is specified, not specifying the storageAccountAccessKey will use SQL server system-assigned managed identity to access the storage.␍␊ - * Prerequisites for using managed identity authentication:␍␊ - * 1. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD).␍␊ - * 2. Grant SQL Server identity access to the storage account by adding 'Storage Blob Data Contributor' RBAC role to the server identity.␍␊ - * For more information, see [Auditing to storage using Managed Identity authentication](https://go.microsoft.com/fwlink/?linkid=2114355)␊ - */␊ - storageAccountAccessKey?: string␊ - /**␊ - * Specifies the blob storage subscription Id.␊ - */␊ - storageAccountSubscriptionId?: string␊ - /**␊ - * Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required.␊ - */␊ - storageEndpoint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/databases/syncGroups␊ - */␊ - export interface ServersDatabasesSyncGroups {␊ - apiVersion: "2015-05-01-preview"␊ - /**␊ - * The name of the sync group.␊ - */␊ - name: string␊ - /**␊ - * Properties of a sync group.␊ - */␊ - properties: (SyncGroupProperties | string)␊ - resources?: ServersDatabasesSyncGroupsSyncMembersChildResource[]␊ - type: "Microsoft.Sql/servers/databases/syncGroups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a sync group.␊ - */␊ - export interface SyncGroupProperties {␊ - /**␊ - * Conflict resolution policy of the sync group.␊ - */␊ - conflictResolutionPolicy?: (("HubWin" | "MemberWin") | string)␊ - /**␊ - * Password for the sync group hub database credential.␊ - */␊ - hubDatabasePassword?: string␊ - /**␊ - * User name for the sync group hub database credential.␊ - */␊ - hubDatabaseUserName?: string␊ - /**␊ - * Sync interval of the sync group.␊ - */␊ - interval?: (number | string)␊ - /**␊ - * Properties of sync group schema.␊ - */␊ - schema?: (SyncGroupSchema | string)␊ - /**␊ - * ARM resource id of the sync database in the sync group.␊ - */␊ - syncDatabaseId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of sync group schema.␊ - */␊ - export interface SyncGroupSchema {␊ - /**␊ - * Name of master sync member where the schema is from.␊ - */␊ - masterSyncMemberName?: string␊ - /**␊ - * List of tables in sync group schema.␊ - */␊ - tables?: (SyncGroupSchemaTable[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of table in sync group schema.␊ - */␊ - export interface SyncGroupSchemaTable {␊ - /**␊ - * List of columns in sync group schema.␊ - */␊ - columns?: (SyncGroupSchemaTableColumn[] | string)␊ - /**␊ - * Quoted name of sync group schema table.␊ - */␊ - quotedName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of column in sync group table.␊ - */␊ - export interface SyncGroupSchemaTableColumn {␊ - /**␊ - * Data size of the column.␊ - */␊ - dataSize?: string␊ - /**␊ - * Data type of the column.␊ - */␊ - dataType?: string␊ - /**␊ - * Quoted name of sync group table column.␊ - */␊ - quotedName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/databases/syncGroups/syncMembers␊ - */␊ - export interface ServersDatabasesSyncGroupsSyncMembersChildResource {␊ - apiVersion: "2015-05-01-preview"␊ - /**␊ - * The name of the sync member.␊ - */␊ - name: string␊ - /**␊ - * Properties of a sync member.␊ - */␊ - properties: (SyncMemberProperties | string)␊ - type: "syncMembers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a sync member.␊ - */␊ - export interface SyncMemberProperties {␊ - /**␊ - * Database name of the member database in the sync member.␊ - */␊ - databaseName?: string␊ - /**␊ - * Database type of the sync member.␊ - */␊ - databaseType?: (("AzureSqlDatabase" | "SqlServerDatabase") | string)␊ - /**␊ - * Password of the member database in the sync member.␊ - */␊ - password?: string␊ - /**␊ - * Server name of the member database in the sync member␊ - */␊ - serverName?: string␊ - /**␊ - * SQL Server database id of the sync member.␊ - */␊ - sqlServerDatabaseId?: string␊ - /**␊ - * ARM resource id of the sync agent in the sync member.␊ - */␊ - syncAgentId?: string␊ - /**␊ - * Sync direction of the sync member.␊ - */␊ - syncDirection?: (("Bidirectional" | "OneWayMemberToHub" | "OneWayHubToMember") | string)␊ - /**␊ - * User name of the member database in the sync member.␊ - */␊ - userName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/databases/syncGroups/syncMembers␊ - */␊ - export interface ServersDatabasesSyncGroupsSyncMembers {␊ - apiVersion: "2015-05-01-preview"␊ - /**␊ - * The name of the sync member.␊ - */␊ - name: string␊ - /**␊ - * Properties of a sync member.␊ - */␊ - properties: (SyncMemberProperties | string)␊ - type: "Microsoft.Sql/servers/databases/syncGroups/syncMembers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/encryptionProtector␊ - */␊ - export interface ServersEncryptionProtector {␊ - apiVersion: "2015-05-01-preview"␊ - /**␊ - * The name of the encryption protector to be updated.␊ - */␊ - name: string␊ - /**␊ - * Properties for an encryption protector execution.␊ - */␊ - properties: (EncryptionProtectorProperties | string)␊ - type: "Microsoft.Sql/servers/encryptionProtector"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/failoverGroups␊ - */␊ - export interface ServersFailoverGroups {␊ - apiVersion: "2015-05-01-preview"␊ - /**␊ - * The name of the failover group.␊ - */␊ - name: string␊ - /**␊ - * Properties of a failover group.␊ - */␊ - properties: (FailoverGroupProperties | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Sql/servers/failoverGroups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/firewallRules␊ - */␊ - export interface ServersFirewallRules1 {␊ - apiVersion: "2015-05-01-preview"␊ - /**␊ - * The name of the firewall rule.␊ - */␊ - name: string␊ - /**␊ - * The properties of a server firewall rule.␊ - */␊ - properties: (ServerFirewallRuleProperties | string)␊ - type: "Microsoft.Sql/servers/firewallRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/keys␊ - */␊ - export interface ServersKeys {␊ - apiVersion: "2015-05-01-preview"␊ - /**␊ - * Kind of encryption protector. This is metadata used for the Azure portal experience.␊ - */␊ - kind?: string␊ - /**␊ - * The name of the server key to be operated on (updated or created). The key name is required to be in the format of 'vault_key_version'. For example, if the keyId is https://YourVaultName.vault.azure.net/keys/YourKeyName/01234567890123456789012345678901, then the server key name should be formatted as: YourVaultName_YourKeyName_01234567890123456789012345678901␊ - */␊ - name: string␊ - /**␊ - * Properties for a server key execution.␊ - */␊ - properties: (ServerKeyProperties | string)␊ - type: "Microsoft.Sql/servers/keys"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/syncAgents␊ - */␊ - export interface ServersSyncAgents {␊ - apiVersion: "2015-05-01-preview"␊ - /**␊ - * The name of the sync agent.␊ - */␊ - name: string␊ - /**␊ - * Properties of an Azure SQL Database sync agent.␊ - */␊ - properties: (SyncAgentProperties | string)␊ - type: "Microsoft.Sql/servers/syncAgents"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/virtualNetworkRules␊ - */␊ - export interface ServersVirtualNetworkRules {␊ - apiVersion: "2015-05-01-preview"␊ - /**␊ - * The name of the virtual network rule.␊ - */␊ - name: string␊ - /**␊ - * Properties of a virtual network rule.␊ - */␊ - properties: (VirtualNetworkRuleProperties | string)␊ - type: "Microsoft.Sql/servers/virtualNetworkRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/managedInstances/databases␊ - */␊ - export interface ManagedInstancesDatabases {␊ - apiVersion: "2017-03-01-preview"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the database.␊ - */␊ - name: string␊ - /**␊ - * The managed database's properties.␊ - */␊ - properties: (ManagedDatabaseProperties | string)␊ - resources?: (ManagedInstancesDatabasesBackupShortTermRetentionPoliciesChildResource | ManagedInstancesDatabasesSecurityAlertPoliciesChildResource)[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Sql/managedInstances/databases"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The managed database's properties.␊ - */␊ - export interface ManagedDatabaseProperties {␊ - /**␊ - * Collation of the metadata catalog.␊ - */␊ - catalogCollation?: (("DATABASE_DEFAULT" | "SQL_Latin1_General_CP1_CI_AS") | string)␊ - /**␊ - * Collation of the managed database.␊ - */␊ - collation?: string␊ - /**␊ - * Managed database create mode. PointInTimeRestore: Create a database by restoring a point in time backup of an existing database. SourceDatabaseName, SourceManagedInstanceName and PointInTime must be specified. RestoreExternalBackup: Create a database by restoring from external backup files. Collation, StorageContainerUri and StorageContainerSasToken must be specified. Recovery: Creates a database by restoring a geo-replicated backup. RecoverableDatabaseId must be specified as the recoverable database resource ID to restore.␊ - */␊ - createMode?: (("Default" | "RestoreExternalBackup" | "PointInTimeRestore" | "Recovery" | "RestoreLongTermRetentionBackup") | string)␊ - /**␊ - * The name of the Long Term Retention backup to be used for restore of this managed database.␊ - */␊ - longTermRetentionBackupResourceId?: string␊ - /**␊ - * The resource identifier of the recoverable database associated with create operation of this database.␊ - */␊ - recoverableDatabaseId?: string␊ - /**␊ - * The restorable dropped database resource id to restore when creating this database.␊ - */␊ - restorableDroppedDatabaseId?: string␊ - /**␊ - * Conditional. If createMode is PointInTimeRestore, this value is required. Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database.␊ - */␊ - restorePointInTime?: string␊ - /**␊ - * The resource identifier of the source database associated with create operation of this database.␊ - */␊ - sourceDatabaseId?: string␊ - /**␊ - * Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the storage container sas token.␊ - */␊ - storageContainerSasToken?: string␊ - /**␊ - * Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the uri of the storage container where backups for this restore are stored.␊ - */␊ - storageContainerUri?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/managedInstances/databases/backupShortTermRetentionPolicies␊ - */␊ - export interface ManagedInstancesDatabasesBackupShortTermRetentionPoliciesChildResource {␊ - apiVersion: "2017-03-01-preview"␊ - /**␊ - * The policy name. Should always be "default".␊ - */␊ - name: "default"␊ - /**␊ - * Properties of a short term retention policy␊ - */␊ - properties: (ManagedBackupShortTermRetentionPolicyProperties | string)␊ - type: "backupShortTermRetentionPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a short term retention policy␊ - */␊ - export interface ManagedBackupShortTermRetentionPolicyProperties {␊ - /**␊ - * The backup retention period in days. This is how many days Point-in-Time Restore will be supported.␊ - */␊ - retentionDays?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/managedInstances/databases/securityAlertPolicies␊ - */␊ - export interface ManagedInstancesDatabasesSecurityAlertPoliciesChildResource {␊ - apiVersion: "2017-03-01-preview"␊ - /**␊ - * The name of the security alert policy.␊ - */␊ - name: "Default"␊ - /**␊ - * Properties of a security alert policy.␊ - */␊ - properties: (SecurityAlertPolicyProperties | string)␊ - type: "securityAlertPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a security alert policy.␊ - */␊ - export interface SecurityAlertPolicyProperties {␊ - /**␊ - * Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action␊ - */␊ - disabledAlerts?: (string[] | string)␊ - /**␊ - * Specifies that the alert is sent to the account administrators.␊ - */␊ - emailAccountAdmins?: (boolean | string)␊ - /**␊ - * Specifies an array of e-mail addresses to which the alert is sent.␊ - */␊ - emailAddresses?: (string[] | string)␊ - /**␊ - * Specifies the number of days to keep in the Threat Detection audit logs.␊ - */␊ - retentionDays?: (number | string)␊ - /**␊ - * Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database.␊ - */␊ - state: (("New" | "Enabled" | "Disabled") | string)␊ - /**␊ - * Specifies the identifier key of the Threat Detection audit storage account.␊ - */␊ - storageAccountAccessKey?: string␊ - /**␊ - * Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.␊ - */␊ - storageEndpoint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/auditingSettings␊ - */␊ - export interface ServersAuditingSettings {␊ - apiVersion: "2017-03-01-preview"␊ - /**␊ - * The name of the blob auditing policy.␊ - */␊ - name: string␊ - /**␊ - * Properties of a server blob auditing policy.␊ - */␊ - properties: (ServerBlobAuditingPolicyProperties | string)␊ - type: "Microsoft.Sql/servers/auditingSettings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a server blob auditing policy.␊ - */␊ - export interface ServerBlobAuditingPolicyProperties {␊ - /**␊ - * Specifies the Actions-Groups and Actions to audit.␍␊ - * ␍␊ - * The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins:␍␊ - * ␍␊ - * BATCH_COMPLETED_GROUP,␍␊ - * SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP,␍␊ - * FAILED_DATABASE_AUTHENTICATION_GROUP.␍␊ - * ␍␊ - * This above combination is also the set that is configured by default when enabling auditing from the Azure portal.␍␊ - * ␍␊ - * The supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records):␍␊ - * ␍␊ - * APPLICATION_ROLE_CHANGE_PASSWORD_GROUP␍␊ - * BACKUP_RESTORE_GROUP␍␊ - * DATABASE_LOGOUT_GROUP␍␊ - * DATABASE_OBJECT_CHANGE_GROUP␍␊ - * DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP␍␊ - * DATABASE_OBJECT_PERMISSION_CHANGE_GROUP␍␊ - * DATABASE_OPERATION_GROUP␍␊ - * DATABASE_PERMISSION_CHANGE_GROUP␍␊ - * DATABASE_PRINCIPAL_CHANGE_GROUP␍␊ - * DATABASE_PRINCIPAL_IMPERSONATION_GROUP␍␊ - * DATABASE_ROLE_MEMBER_CHANGE_GROUP␍␊ - * FAILED_DATABASE_AUTHENTICATION_GROUP␍␊ - * SCHEMA_OBJECT_ACCESS_GROUP␍␊ - * SCHEMA_OBJECT_CHANGE_GROUP␍␊ - * SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP␍␊ - * SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP␍␊ - * SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP␍␊ - * USER_CHANGE_PASSWORD_GROUP␍␊ - * BATCH_STARTED_GROUP␍␊ - * BATCH_COMPLETED_GROUP␍␊ - * DBCC_GROUP␍␊ - * DATABASE_OWNERSHIP_CHANGE_GROUP␍␊ - * DATABASE_CHANGE_GROUP␍␊ - * ␍␊ - * These are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs.␍␊ - * ␍␊ - * For more information, see [Database-Level Audit Action Groups](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups).␍␊ - * ␍␊ - * For Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are:␍␊ - * SELECT␍␊ - * UPDATE␍␊ - * INSERT␍␊ - * DELETE␍␊ - * EXECUTE␍␊ - * RECEIVE␍␊ - * REFERENCES␍␊ - * ␍␊ - * The general form for defining an action to be audited is:␍␊ - * {action} ON {object} BY {principal}␍␊ - * ␍␊ - * Note that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively.␍␊ - * ␍␊ - * For example:␍␊ - * SELECT on dbo.myTable by public␍␊ - * SELECT on DATABASE::myDatabase by public␍␊ - * SELECT on SCHEMA::mySchema by public␍␊ - * ␍␊ - * For more information, see [Database-Level Audit Actions](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions)␊ - */␊ - auditActionsAndGroups?: (string[] | string)␊ - /**␊ - * Specifies whether audit events are sent to Azure Monitor. ␍␊ - * In order to send the events to Azure Monitor, specify 'state' as 'Enabled' and 'isAzureMonitorTargetEnabled' as true.␍␊ - * ␍␊ - * When using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created.␍␊ - * Note that for server level audit you should use the 'master' database as {databaseName}.␍␊ - * ␍␊ - * Diagnostic Settings URI format:␍␊ - * PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview␍␊ - * ␍␊ - * For more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207)␍␊ - * or [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043)␍␊ - * ␊ - */␊ - isAzureMonitorTargetEnabled?: (boolean | string)␊ - /**␊ - * Specifies whether storageAccountAccessKey value is the storage's secondary key.␊ - */␊ - isStorageSecondaryKeyInUse?: (boolean | string)␊ - /**␊ - * Specifies the amount of time in milliseconds that can elapse before audit actions are forced to be processed.␍␊ - * The default minimum value is 1000 (1 second). The maximum is 2,147,483,647.␊ - */␊ - queueDelayMs?: (number | string)␊ - /**␊ - * Specifies the number of days to keep in the audit logs in the storage account.␊ - */␊ - retentionDays?: (number | string)␊ - /**␊ - * Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required.␊ - */␊ - state: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Specifies the identifier key of the auditing storage account. ␍␊ - * If state is Enabled and storageEndpoint is specified, not specifying the storageAccountAccessKey will use SQL server system-assigned managed identity to access the storage.␍␊ - * Prerequisites for using managed identity authentication:␍␊ - * 1. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD).␍␊ - * 2. Grant SQL Server identity access to the storage account by adding 'Storage Blob Data Contributor' RBAC role to the server identity.␍␊ - * For more information, see [Auditing to storage using Managed Identity authentication](https://go.microsoft.com/fwlink/?linkid=2114355)␊ - */␊ - storageAccountAccessKey?: string␊ - /**␊ - * Specifies the blob storage subscription Id.␊ - */␊ - storageAccountSubscriptionId?: string␊ - /**␊ - * Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required.␊ - */␊ - storageEndpoint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/databases␊ - */␊ - export interface ServersDatabases1 {␊ - apiVersion: "2017-03-01-preview"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the database.␊ - */␊ - name: string␊ - /**␊ - * The database's properties.␊ - */␊ - properties: (DatabaseProperties5 | string)␊ - resources?: (ServersDatabasesExtendedAuditingSettingsChildResource | ServersDatabasesAuditingSettingsChildResource | ServersDatabasesVulnerabilityAssessmentsChildResource | ServersDatabasesBackupLongTermRetentionPoliciesChildResource)[]␊ - /**␊ - * An ARM Resource SKU.␊ - */␊ - sku?: (Sku41 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Sql/servers/databases"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The database's properties.␊ - */␊ - export interface DatabaseProperties5 {␊ - /**␊ - * Collation of the metadata catalog.␊ - */␊ - catalogCollation?: (("DATABASE_DEFAULT" | "SQL_Latin1_General_CP1_CI_AS") | string)␊ - /**␊ - * The collation of the database.␊ - */␊ - collation?: string␊ - /**␊ - * Specifies the mode of database creation.␍␊ - * ␍␊ - * Default: regular database creation.␍␊ - * ␍␊ - * Copy: creates a database as a copy of an existing database. sourceDatabaseId must be specified as the resource ID of the source database.␍␊ - * ␍␊ - * Secondary: creates a database as a secondary replica of an existing database. sourceDatabaseId must be specified as the resource ID of the existing primary database.␍␊ - * ␍␊ - * PointInTimeRestore: Creates a database by restoring a point in time backup of an existing database. sourceDatabaseId must be specified as the resource ID of the existing database, and restorePointInTime must be specified.␍␊ - * ␍␊ - * Recovery: Creates a database by restoring a geo-replicated backup. sourceDatabaseId must be specified as the recoverable database resource ID to restore.␍␊ - * ␍␊ - * Restore: Creates a database by restoring a backup of a deleted database. sourceDatabaseId must be specified. If sourceDatabaseId is the database's original resource ID, then sourceDatabaseDeletionDate must be specified. Otherwise sourceDatabaseId must be the restorable dropped database resource ID and sourceDatabaseDeletionDate is ignored. restorePointInTime may also be specified to restore from an earlier point in time.␍␊ - * ␍␊ - * RestoreLongTermRetentionBackup: Creates a database by restoring from a long term retention vault. recoveryServicesRecoveryPointResourceId must be specified as the recovery point resource ID.␍␊ - * ␍␊ - * Copy, Secondary, and RestoreLongTermRetentionBackup are not supported for DataWarehouse edition.␊ - */␊ - createMode?: (("Default" | "Copy" | "Secondary" | "OnlineSecondary" | "PointInTimeRestore" | "Restore" | "Recovery" | "RestoreExternalBackup" | "RestoreExternalBackupSecondary" | "RestoreLongTermRetentionBackup") | string)␊ - /**␊ - * The resource identifier of the elastic pool containing this database.␊ - */␊ - elasticPoolId?: string␊ - /**␊ - * The resource identifier of the long term retention backup associated with create operation of this database.␊ - */␊ - longTermRetentionBackupResourceId?: string␊ - /**␊ - * The max size of the database expressed in bytes.␊ - */␊ - maxSizeBytes?: (number | string)␊ - /**␊ - * The resource identifier of the recoverable database associated with create operation of this database.␊ - */␊ - recoverableDatabaseId?: string␊ - /**␊ - * The resource identifier of the recovery point associated with create operation of this database.␊ - */␊ - recoveryServicesRecoveryPointId?: string␊ - /**␊ - * The resource identifier of the restorable dropped database associated with create operation of this database.␊ - */␊ - restorableDroppedDatabaseId?: string␊ - /**␊ - * Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database.␊ - */␊ - restorePointInTime?: string␊ - /**␊ - * The name of the sample schema to apply when creating this database.␊ - */␊ - sampleName?: (("AdventureWorksLT" | "WideWorldImportersStd" | "WideWorldImportersFull") | string)␊ - /**␊ - * Specifies the time that the database was deleted.␊ - */␊ - sourceDatabaseDeletionDate?: string␊ - /**␊ - * The resource identifier of the source database associated with create operation of this database.␊ - */␊ - sourceDatabaseId?: string␊ - /**␊ - * Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones.␊ - */␊ - zoneRedundant?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/databases/extendedAuditingSettings␊ - */␊ - export interface ServersDatabasesExtendedAuditingSettingsChildResource {␊ - apiVersion: "2017-03-01-preview"␊ - /**␊ - * The name of the blob auditing policy.␊ - */␊ - name: "default"␊ - /**␊ - * Properties of an extended database blob auditing policy.␊ - */␊ - properties: (ExtendedDatabaseBlobAuditingPolicyProperties | string)␊ - type: "extendedAuditingSettings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of an extended database blob auditing policy.␊ - */␊ - export interface ExtendedDatabaseBlobAuditingPolicyProperties {␊ - /**␊ - * Specifies the Actions-Groups and Actions to audit.␍␊ - * ␍␊ - * The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins:␍␊ - * ␍␊ - * BATCH_COMPLETED_GROUP,␍␊ - * SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP,␍␊ - * FAILED_DATABASE_AUTHENTICATION_GROUP.␍␊ - * ␍␊ - * This above combination is also the set that is configured by default when enabling auditing from the Azure portal.␍␊ - * ␍␊ - * The supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records):␍␊ - * ␍␊ - * APPLICATION_ROLE_CHANGE_PASSWORD_GROUP␍␊ - * BACKUP_RESTORE_GROUP␍␊ - * DATABASE_LOGOUT_GROUP␍␊ - * DATABASE_OBJECT_CHANGE_GROUP␍␊ - * DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP␍␊ - * DATABASE_OBJECT_PERMISSION_CHANGE_GROUP␍␊ - * DATABASE_OPERATION_GROUP␍␊ - * DATABASE_PERMISSION_CHANGE_GROUP␍␊ - * DATABASE_PRINCIPAL_CHANGE_GROUP␍␊ - * DATABASE_PRINCIPAL_IMPERSONATION_GROUP␍␊ - * DATABASE_ROLE_MEMBER_CHANGE_GROUP␍␊ - * FAILED_DATABASE_AUTHENTICATION_GROUP␍␊ - * SCHEMA_OBJECT_ACCESS_GROUP␍␊ - * SCHEMA_OBJECT_CHANGE_GROUP␍␊ - * SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP␍␊ - * SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP␍␊ - * SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP␍␊ - * USER_CHANGE_PASSWORD_GROUP␍␊ - * BATCH_STARTED_GROUP␍␊ - * BATCH_COMPLETED_GROUP␍␊ - * DBCC_GROUP␍␊ - * DATABASE_OWNERSHIP_CHANGE_GROUP␍␊ - * DATABASE_CHANGE_GROUP␍␊ - * ␍␊ - * These are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs.␍␊ - * ␍␊ - * For more information, see [Database-Level Audit Action Groups](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups).␍␊ - * ␍␊ - * For Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are:␍␊ - * SELECT␍␊ - * UPDATE␍␊ - * INSERT␍␊ - * DELETE␍␊ - * EXECUTE␍␊ - * RECEIVE␍␊ - * REFERENCES␍␊ - * ␍␊ - * The general form for defining an action to be audited is:␍␊ - * {action} ON {object} BY {principal}␍␊ - * ␍␊ - * Note that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively.␍␊ - * ␍␊ - * For example:␍␊ - * SELECT on dbo.myTable by public␍␊ - * SELECT on DATABASE::myDatabase by public␍␊ - * SELECT on SCHEMA::mySchema by public␍␊ - * ␍␊ - * For more information, see [Database-Level Audit Actions](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions)␊ - */␊ - auditActionsAndGroups?: (string[] | string)␊ - /**␊ - * Specifies whether audit events are sent to Azure Monitor. ␍␊ - * In order to send the events to Azure Monitor, specify 'state' as 'Enabled' and 'isAzureMonitorTargetEnabled' as true.␍␊ - * ␍␊ - * When using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created.␍␊ - * Note that for server level audit you should use the 'master' database as {databaseName}.␍␊ - * ␍␊ - * Diagnostic Settings URI format:␍␊ - * PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview␍␊ - * ␍␊ - * For more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207)␍␊ - * or [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043)␍␊ - * ␊ - */␊ - isAzureMonitorTargetEnabled?: (boolean | string)␊ - /**␊ - * Specifies whether storageAccountAccessKey value is the storage's secondary key.␊ - */␊ - isStorageSecondaryKeyInUse?: (boolean | string)␊ - /**␊ - * Specifies condition of where clause when creating an audit.␊ - */␊ - predicateExpression?: string␊ - /**␊ - * Specifies the amount of time in milliseconds that can elapse before audit actions are forced to be processed.␍␊ - * The default minimum value is 1000 (1 second). The maximum is 2,147,483,647.␊ - */␊ - queueDelayMs?: (number | string)␊ - /**␊ - * Specifies the number of days to keep in the audit logs in the storage account.␊ - */␊ - retentionDays?: (number | string)␊ - /**␊ - * Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required.␊ - */␊ - state: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Specifies the identifier key of the auditing storage account. ␍␊ - * If state is Enabled and storageEndpoint is specified, not specifying the storageAccountAccessKey will use SQL server system-assigned managed identity to access the storage.␍␊ - * Prerequisites for using managed identity authentication:␍␊ - * 1. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD).␍␊ - * 2. Grant SQL Server identity access to the storage account by adding 'Storage Blob Data Contributor' RBAC role to the server identity.␍␊ - * For more information, see [Auditing to storage using Managed Identity authentication](https://go.microsoft.com/fwlink/?linkid=2114355)␊ - */␊ - storageAccountAccessKey?: string␊ - /**␊ - * Specifies the blob storage subscription Id.␊ - */␊ - storageAccountSubscriptionId?: string␊ - /**␊ - * Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required.␊ - */␊ - storageEndpoint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/databases/auditingSettings␊ - */␊ - export interface ServersDatabasesAuditingSettingsChildResource {␊ - apiVersion: "2017-03-01-preview"␊ - /**␊ - * The name of the blob auditing policy.␊ - */␊ - name: "default"␊ - /**␊ - * Properties of a database blob auditing policy.␊ - */␊ - properties: (DatabaseBlobAuditingPolicyProperties1 | string)␊ - type: "auditingSettings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a database blob auditing policy.␊ - */␊ - export interface DatabaseBlobAuditingPolicyProperties1 {␊ - /**␊ - * Specifies the Actions-Groups and Actions to audit.␍␊ - * ␍␊ - * The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins:␍␊ - * ␍␊ - * BATCH_COMPLETED_GROUP,␍␊ - * SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP,␍␊ - * FAILED_DATABASE_AUTHENTICATION_GROUP.␍␊ - * ␍␊ - * This above combination is also the set that is configured by default when enabling auditing from the Azure portal.␍␊ - * ␍␊ - * The supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records):␍␊ - * ␍␊ - * APPLICATION_ROLE_CHANGE_PASSWORD_GROUP␍␊ - * BACKUP_RESTORE_GROUP␍␊ - * DATABASE_LOGOUT_GROUP␍␊ - * DATABASE_OBJECT_CHANGE_GROUP␍␊ - * DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP␍␊ - * DATABASE_OBJECT_PERMISSION_CHANGE_GROUP␍␊ - * DATABASE_OPERATION_GROUP␍␊ - * DATABASE_PERMISSION_CHANGE_GROUP␍␊ - * DATABASE_PRINCIPAL_CHANGE_GROUP␍␊ - * DATABASE_PRINCIPAL_IMPERSONATION_GROUP␍␊ - * DATABASE_ROLE_MEMBER_CHANGE_GROUP␍␊ - * FAILED_DATABASE_AUTHENTICATION_GROUP␍␊ - * SCHEMA_OBJECT_ACCESS_GROUP␍␊ - * SCHEMA_OBJECT_CHANGE_GROUP␍␊ - * SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP␍␊ - * SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP␍␊ - * SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP␍␊ - * USER_CHANGE_PASSWORD_GROUP␍␊ - * BATCH_STARTED_GROUP␍␊ - * BATCH_COMPLETED_GROUP␍␊ - * DBCC_GROUP␍␊ - * DATABASE_OWNERSHIP_CHANGE_GROUP␍␊ - * DATABASE_CHANGE_GROUP␍␊ - * ␍␊ - * These are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs.␍␊ - * ␍␊ - * For more information, see [Database-Level Audit Action Groups](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups).␍␊ - * ␍␊ - * For Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are:␍␊ - * SELECT␍␊ - * UPDATE␍␊ - * INSERT␍␊ - * DELETE␍␊ - * EXECUTE␍␊ - * RECEIVE␍␊ - * REFERENCES␍␊ - * ␍␊ - * The general form for defining an action to be audited is:␍␊ - * {action} ON {object} BY {principal}␍␊ - * ␍␊ - * Note that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively.␍␊ - * ␍␊ - * For example:␍␊ - * SELECT on dbo.myTable by public␍␊ - * SELECT on DATABASE::myDatabase by public␍␊ - * SELECT on SCHEMA::mySchema by public␍␊ - * ␍␊ - * For more information, see [Database-Level Audit Actions](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions)␊ - */␊ - auditActionsAndGroups?: (string[] | string)␊ - /**␊ - * Specifies whether audit events are sent to Azure Monitor. ␍␊ - * In order to send the events to Azure Monitor, specify 'state' as 'Enabled' and 'isAzureMonitorTargetEnabled' as true.␍␊ - * ␍␊ - * When using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created.␍␊ - * Note that for server level audit you should use the 'master' database as {databaseName}.␍␊ - * ␍␊ - * Diagnostic Settings URI format:␍␊ - * PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview␍␊ - * ␍␊ - * For more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207)␍␊ - * or [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043)␍␊ - * ␊ - */␊ - isAzureMonitorTargetEnabled?: (boolean | string)␊ - /**␊ - * Specifies whether storageAccountAccessKey value is the storage's secondary key.␊ - */␊ - isStorageSecondaryKeyInUse?: (boolean | string)␊ - /**␊ - * Specifies the amount of time in milliseconds that can elapse before audit actions are forced to be processed.␍␊ - * The default minimum value is 1000 (1 second). The maximum is 2,147,483,647.␊ - */␊ - queueDelayMs?: (number | string)␊ - /**␊ - * Specifies the number of days to keep in the audit logs in the storage account.␊ - */␊ - retentionDays?: (number | string)␊ - /**␊ - * Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required.␊ - */␊ - state: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Specifies the identifier key of the auditing storage account. ␍␊ - * If state is Enabled and storageEndpoint is specified, not specifying the storageAccountAccessKey will use SQL server system-assigned managed identity to access the storage.␍␊ - * Prerequisites for using managed identity authentication:␍␊ - * 1. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD).␍␊ - * 2. Grant SQL Server identity access to the storage account by adding 'Storage Blob Data Contributor' RBAC role to the server identity.␍␊ - * For more information, see [Auditing to storage using Managed Identity authentication](https://go.microsoft.com/fwlink/?linkid=2114355)␊ - */␊ - storageAccountAccessKey?: string␊ - /**␊ - * Specifies the blob storage subscription Id.␊ - */␊ - storageAccountSubscriptionId?: string␊ - /**␊ - * Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required.␊ - */␊ - storageEndpoint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/databases/vulnerabilityAssessments␊ - */␊ - export interface ServersDatabasesVulnerabilityAssessmentsChildResource {␊ - apiVersion: "2017-03-01-preview"␊ - /**␊ - * The name of the vulnerability assessment.␊ - */␊ - name: "default"␊ - /**␊ - * Properties of a database Vulnerability Assessment.␊ - */␊ - properties: (DatabaseVulnerabilityAssessmentProperties | string)␊ - type: "vulnerabilityAssessments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a database Vulnerability Assessment.␊ - */␊ - export interface DatabaseVulnerabilityAssessmentProperties {␊ - /**␊ - * Properties of a Vulnerability Assessment recurring scans.␊ - */␊ - recurringScans?: (VulnerabilityAssessmentRecurringScansProperties | string)␊ - /**␊ - * Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required.␊ - */␊ - storageAccountAccessKey?: string␊ - /**␊ - * A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). It is required if server level vulnerability assessment policy doesn't set␊ - */␊ - storageContainerPath?: string␊ - /**␊ - * A shared access signature (SAS Key) that has read and write access to the blob container specified in 'storageContainerPath' parameter. If 'storageAccountAccessKey' isn't specified, StorageContainerSasKey is required.␊ - */␊ - storageContainerSasKey?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a Vulnerability Assessment recurring scans.␊ - */␊ - export interface VulnerabilityAssessmentRecurringScansProperties {␊ - /**␊ - * Specifies an array of e-mail addresses to which the scan notification is sent.␊ - */␊ - emails?: (string[] | string)␊ - /**␊ - * Specifies that the schedule scan notification will be is sent to the subscription administrators.␊ - */␊ - emailSubscriptionAdmins?: (boolean | string)␊ - /**␊ - * Recurring scans state.␊ - */␊ - isEnabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/databases/backupLongTermRetentionPolicies␊ - */␊ - export interface ServersDatabasesBackupLongTermRetentionPoliciesChildResource {␊ - apiVersion: "2017-03-01-preview"␊ - /**␊ - * The policy name. Should always be Default.␊ - */␊ - name: "default"␊ - /**␊ - * Properties of a long term retention policy␊ - */␊ - properties: (LongTermRetentionPolicyProperties | string)␊ - type: "backupLongTermRetentionPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a long term retention policy␊ - */␊ - export interface LongTermRetentionPolicyProperties {␊ - /**␊ - * The monthly retention policy for an LTR backup in an ISO 8601 format.␊ - */␊ - monthlyRetention?: string␊ - /**␊ - * The weekly retention policy for an LTR backup in an ISO 8601 format.␊ - */␊ - weeklyRetention?: string␊ - /**␊ - * The week of year to take the yearly backup in an ISO 8601 format.␊ - */␊ - weekOfYear?: (number | string)␊ - /**␊ - * The yearly retention policy for an LTR backup in an ISO 8601 format.␊ - */␊ - yearlyRetention?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An ARM Resource SKU.␊ - */␊ - export interface Sku41 {␊ - /**␊ - * Capacity of the particular SKU.␊ - */␊ - capacity?: (number | string)␊ - /**␊ - * If the service has different generations of hardware, for the same SKU, then that can be captured here.␊ - */␊ - family?: string␊ - /**␊ - * The name of the SKU, typically, a letter + Number code, e.g. P3.␊ - */␊ - name: string␊ - /**␊ - * Size of the particular SKU␊ - */␊ - size?: string␊ - /**␊ - * The tier or edition of the particular SKU, e.g. Basic, Premium.␊ - */␊ - tier?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/databases/auditingSettings␊ - */␊ - export interface ServersDatabasesAuditingSettings1 {␊ - apiVersion: "2017-03-01-preview"␊ - /**␊ - * The name of the blob auditing policy.␊ - */␊ - name: string␊ - /**␊ - * Properties of a database blob auditing policy.␊ - */␊ - properties: (DatabaseBlobAuditingPolicyProperties1 | string)␊ - type: "Microsoft.Sql/servers/databases/auditingSettings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/databases/backupLongTermRetentionPolicies␊ - */␊ - export interface ServersDatabasesBackupLongTermRetentionPolicies {␊ - apiVersion: "2017-03-01-preview"␊ - /**␊ - * The policy name. Should always be Default.␊ - */␊ - name: string␊ - /**␊ - * Properties of a long term retention policy␊ - */␊ - properties: (LongTermRetentionPolicyProperties | string)␊ - type: "Microsoft.Sql/servers/databases/backupLongTermRetentionPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/databases/extendedAuditingSettings␊ - */␊ - export interface ServersDatabasesExtendedAuditingSettings {␊ - apiVersion: "2017-03-01-preview"␊ - /**␊ - * The name of the blob auditing policy.␊ - */␊ - name: string␊ - /**␊ - * Properties of an extended database blob auditing policy.␊ - */␊ - properties: (ExtendedDatabaseBlobAuditingPolicyProperties | string)␊ - type: "Microsoft.Sql/servers/databases/extendedAuditingSettings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/databases/securityAlertPolicies␊ - */␊ - export interface ServersDatabasesSecurityAlertPolicies1 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * The name of the security alert policy.␊ - */␊ - name: string␊ - /**␊ - * Properties of a security alert policy.␊ - */␊ - properties: (SecurityAlertPolicyProperties1 | string)␊ - type: "Microsoft.Sql/servers/databases/securityAlertPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a security alert policy.␊ - */␊ - export interface SecurityAlertPolicyProperties1 {␊ - /**␊ - * Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action␊ - */␊ - disabledAlerts?: (string[] | string)␊ - /**␊ - * Specifies that the alert is sent to the account administrators.␊ - */␊ - emailAccountAdmins?: (boolean | string)␊ - /**␊ - * Specifies an array of e-mail addresses to which the alert is sent.␊ - */␊ - emailAddresses?: (string[] | string)␊ - /**␊ - * Specifies the number of days to keep in the Threat Detection audit logs.␊ - */␊ - retentionDays?: (number | string)␊ - /**␊ - * Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database.␊ - */␊ - state: (("New" | "Enabled" | "Disabled") | string)␊ - /**␊ - * Specifies the identifier key of the Threat Detection audit storage account.␊ - */␊ - storageAccountAccessKey?: string␊ - /**␊ - * Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.␊ - */␊ - storageEndpoint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/securityAlertPolicies␊ - */␊ - export interface ServersSecurityAlertPolicies {␊ - apiVersion: "2017-03-01-preview"␊ - /**␊ - * The name of the threat detection policy.␊ - */␊ - name: string␊ - /**␊ - * Properties of a security alert policy.␊ - */␊ - properties: (SecurityAlertPolicyProperties | string)␊ - type: "Microsoft.Sql/servers/securityAlertPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/managedInstances/databases/securityAlertPolicies␊ - */␊ - export interface ManagedInstancesDatabasesSecurityAlertPolicies {␊ - apiVersion: "2017-03-01-preview"␊ - /**␊ - * The name of the security alert policy.␊ - */␊ - name: string␊ - /**␊ - * Properties of a security alert policy.␊ - */␊ - properties: (SecurityAlertPolicyProperties | string)␊ - type: "Microsoft.Sql/managedInstances/databases/securityAlertPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/managedInstances/securityAlertPolicies␊ - */␊ - export interface ManagedInstancesSecurityAlertPolicies {␊ - apiVersion: "2017-03-01-preview"␊ - /**␊ - * The name of the security alert policy.␊ - */␊ - name: string␊ - /**␊ - * Properties of a security alert policy.␊ - */␊ - properties: (SecurityAlertPolicyProperties | string)␊ - type: "Microsoft.Sql/managedInstances/securityAlertPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/databases/vulnerabilityAssessments/rules/baselines␊ - */␊ - export interface ServersDatabasesVulnerabilityAssessmentsRulesBaselines {␊ - apiVersion: "2017-03-01-preview"␊ - /**␊ - * The name of the vulnerability assessment rule baseline (default implies a baseline on a database level rule and master for server level rule).␊ - */␊ - name: (("master" | "default") | string)␊ - /**␊ - * Properties of a database Vulnerability Assessment rule baseline.␊ - */␊ - properties: (DatabaseVulnerabilityAssessmentRuleBaselineProperties | string)␊ - type: "Microsoft.Sql/servers/databases/vulnerabilityAssessments/rules/baselines"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a database Vulnerability Assessment rule baseline.␊ - */␊ - export interface DatabaseVulnerabilityAssessmentRuleBaselineProperties {␊ - /**␊ - * The rule baseline result␊ - */␊ - baselineResults: (DatabaseVulnerabilityAssessmentRuleBaselineItem[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties for an Azure SQL Database Vulnerability Assessment rule baseline's result.␊ - */␊ - export interface DatabaseVulnerabilityAssessmentRuleBaselineItem {␊ - /**␊ - * The rule baseline result␊ - */␊ - result: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/databases/vulnerabilityAssessments␊ - */␊ - export interface ServersDatabasesVulnerabilityAssessments {␊ - apiVersion: "2017-03-01-preview"␊ - /**␊ - * The name of the vulnerability assessment.␊ - */␊ - name: string␊ - /**␊ - * Properties of a database Vulnerability Assessment.␊ - */␊ - properties: (DatabaseVulnerabilityAssessmentProperties | string)␊ - type: "Microsoft.Sql/servers/databases/vulnerabilityAssessments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/managedInstances/databases/vulnerabilityAssessments/rules/baselines␊ - */␊ - export interface ManagedInstancesDatabasesVulnerabilityAssessmentsRulesBaselines {␊ - apiVersion: "2017-10-01-preview"␊ - /**␊ - * The name of the vulnerability assessment rule baseline (default implies a baseline on a database level rule and master for server level rule).␊ - */␊ - name: (("master" | "default") | string)␊ - /**␊ - * Properties of a database Vulnerability Assessment rule baseline.␊ - */␊ - properties: (DatabaseVulnerabilityAssessmentRuleBaselineProperties1 | string)␊ - type: "Microsoft.Sql/managedInstances/databases/vulnerabilityAssessments/rules/baselines"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a database Vulnerability Assessment rule baseline.␊ - */␊ - export interface DatabaseVulnerabilityAssessmentRuleBaselineProperties1 {␊ - /**␊ - * The rule baseline result␊ - */␊ - baselineResults: (DatabaseVulnerabilityAssessmentRuleBaselineItem1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties for an Azure SQL Database Vulnerability Assessment rule baseline's result.␊ - */␊ - export interface DatabaseVulnerabilityAssessmentRuleBaselineItem1 {␊ - /**␊ - * The rule baseline result␊ - */␊ - result: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/managedInstances/databases/vulnerabilityAssessments␊ - */␊ - export interface ManagedInstancesDatabasesVulnerabilityAssessments {␊ - apiVersion: "2017-10-01-preview"␊ - /**␊ - * The name of the vulnerability assessment.␊ - */␊ - name: string␊ - /**␊ - * Properties of a database Vulnerability Assessment.␊ - */␊ - properties: (DatabaseVulnerabilityAssessmentProperties1 | string)␊ - type: "Microsoft.Sql/managedInstances/databases/vulnerabilityAssessments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a database Vulnerability Assessment.␊ - */␊ - export interface DatabaseVulnerabilityAssessmentProperties1 {␊ - /**␊ - * Properties of a Vulnerability Assessment recurring scans.␊ - */␊ - recurringScans?: (VulnerabilityAssessmentRecurringScansProperties1 | string)␊ - /**␊ - * Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required.␊ - */␊ - storageAccountAccessKey?: string␊ - /**␊ - * A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). It is required if server level vulnerability assessment policy doesn't set␊ - */␊ - storageContainerPath?: string␊ - /**␊ - * A shared access signature (SAS Key) that has read and write access to the blob container specified in 'storageContainerPath' parameter. If 'storageAccountAccessKey' isn't specified, StorageContainerSasKey is required.␊ - */␊ - storageContainerSasKey?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a Vulnerability Assessment recurring scans.␊ - */␊ - export interface VulnerabilityAssessmentRecurringScansProperties1 {␊ - /**␊ - * Specifies an array of e-mail addresses to which the scan notification is sent.␊ - */␊ - emails?: (string[] | string)␊ - /**␊ - * Specifies that the schedule scan notification will be is sent to the subscription administrators.␊ - */␊ - emailSubscriptionAdmins?: (boolean | string)␊ - /**␊ - * Recurring scans state.␊ - */␊ - isEnabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/vulnerabilityAssessments␊ - */␊ - export interface ServersVulnerabilityAssessments {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * The name of the vulnerability assessment.␊ - */␊ - name: string␊ - /**␊ - * Properties of a server Vulnerability Assessment.␊ - */␊ - properties: (ServerVulnerabilityAssessmentProperties | string)␊ - type: "Microsoft.Sql/servers/vulnerabilityAssessments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a server Vulnerability Assessment.␊ - */␊ - export interface ServerVulnerabilityAssessmentProperties {␊ - /**␊ - * Properties of a Vulnerability Assessment recurring scans.␊ - */␊ - recurringScans?: (VulnerabilityAssessmentRecurringScansProperties2 | string)␊ - /**␊ - * Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required.␊ - */␊ - storageAccountAccessKey?: string␊ - /**␊ - * A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/).␊ - */␊ - storageContainerPath: string␊ - /**␊ - * A shared access signature (SAS Key) that has read and write access to the blob container specified in 'storageContainerPath' parameter. If 'storageAccountAccessKey' isn't specified, StorageContainerSasKey is required.␊ - */␊ - storageContainerSasKey?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a Vulnerability Assessment recurring scans.␊ - */␊ - export interface VulnerabilityAssessmentRecurringScansProperties2 {␊ - /**␊ - * Specifies an array of e-mail addresses to which the scan notification is sent.␊ - */␊ - emails?: (string[] | string)␊ - /**␊ - * Specifies that the schedule scan notification will be is sent to the subscription administrators.␊ - */␊ - emailSubscriptionAdmins?: (boolean | string)␊ - /**␊ - * Recurring scans state.␊ - */␊ - isEnabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/managedInstances/vulnerabilityAssessments␊ - */␊ - export interface ManagedInstancesVulnerabilityAssessments {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * The name of the vulnerability assessment.␊ - */␊ - name: string␊ - /**␊ - * Properties of a managed instance vulnerability assessment.␊ - */␊ - properties: (ManagedInstanceVulnerabilityAssessmentProperties | string)␊ - type: "Microsoft.Sql/managedInstances/vulnerabilityAssessments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a managed instance vulnerability assessment.␊ - */␊ - export interface ManagedInstanceVulnerabilityAssessmentProperties {␊ - /**␊ - * Properties of a Vulnerability Assessment recurring scans.␊ - */␊ - recurringScans?: (VulnerabilityAssessmentRecurringScansProperties2 | string)␊ - /**␊ - * Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required.␊ - */␊ - storageAccountAccessKey?: string␊ - /**␊ - * A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/).␊ - */␊ - storageContainerPath: string␊ - /**␊ - * A shared access signature (SAS Key) that has read and write access to the blob container specified in 'storageContainerPath' parameter. If 'storageAccountAccessKey' isn't specified, StorageContainerSasKey is required.␊ - */␊ - storageContainerSasKey?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/dnsAliases␊ - */␊ - export interface ServersDnsAliases {␊ - apiVersion: "2017-03-01-preview"␊ - /**␊ - * The name of the server DNS alias.␊ - */␊ - name: string␊ - type: "Microsoft.Sql/servers/dnsAliases"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/extendedAuditingSettings␊ - */␊ - export interface ServersExtendedAuditingSettings {␊ - apiVersion: "2017-03-01-preview"␊ - /**␊ - * The name of the blob auditing policy.␊ - */␊ - name: string␊ - /**␊ - * Properties of an extended server blob auditing policy.␊ - */␊ - properties: (ExtendedServerBlobAuditingPolicyProperties | string)␊ - type: "Microsoft.Sql/servers/extendedAuditingSettings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of an extended server blob auditing policy.␊ - */␊ - export interface ExtendedServerBlobAuditingPolicyProperties {␊ - /**␊ - * Specifies the Actions-Groups and Actions to audit.␍␊ - * ␍␊ - * The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins:␍␊ - * ␍␊ - * BATCH_COMPLETED_GROUP,␍␊ - * SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP,␍␊ - * FAILED_DATABASE_AUTHENTICATION_GROUP.␍␊ - * ␍␊ - * This above combination is also the set that is configured by default when enabling auditing from the Azure portal.␍␊ - * ␍␊ - * The supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records):␍␊ - * ␍␊ - * APPLICATION_ROLE_CHANGE_PASSWORD_GROUP␍␊ - * BACKUP_RESTORE_GROUP␍␊ - * DATABASE_LOGOUT_GROUP␍␊ - * DATABASE_OBJECT_CHANGE_GROUP␍␊ - * DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP␍␊ - * DATABASE_OBJECT_PERMISSION_CHANGE_GROUP␍␊ - * DATABASE_OPERATION_GROUP␍␊ - * DATABASE_PERMISSION_CHANGE_GROUP␍␊ - * DATABASE_PRINCIPAL_CHANGE_GROUP␍␊ - * DATABASE_PRINCIPAL_IMPERSONATION_GROUP␍␊ - * DATABASE_ROLE_MEMBER_CHANGE_GROUP␍␊ - * FAILED_DATABASE_AUTHENTICATION_GROUP␍␊ - * SCHEMA_OBJECT_ACCESS_GROUP␍␊ - * SCHEMA_OBJECT_CHANGE_GROUP␍␊ - * SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP␍␊ - * SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP␍␊ - * SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP␍␊ - * USER_CHANGE_PASSWORD_GROUP␍␊ - * BATCH_STARTED_GROUP␍␊ - * BATCH_COMPLETED_GROUP␍␊ - * DBCC_GROUP␍␊ - * DATABASE_OWNERSHIP_CHANGE_GROUP␍␊ - * DATABASE_CHANGE_GROUP␍␊ - * ␍␊ - * These are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs.␍␊ - * ␍␊ - * For more information, see [Database-Level Audit Action Groups](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups).␍␊ - * ␍␊ - * For Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are:␍␊ - * SELECT␍␊ - * UPDATE␍␊ - * INSERT␍␊ - * DELETE␍␊ - * EXECUTE␍␊ - * RECEIVE␍␊ - * REFERENCES␍␊ - * ␍␊ - * The general form for defining an action to be audited is:␍␊ - * {action} ON {object} BY {principal}␍␊ - * ␍␊ - * Note that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively.␍␊ - * ␍␊ - * For example:␍␊ - * SELECT on dbo.myTable by public␍␊ - * SELECT on DATABASE::myDatabase by public␍␊ - * SELECT on SCHEMA::mySchema by public␍␊ - * ␍␊ - * For more information, see [Database-Level Audit Actions](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions)␊ - */␊ - auditActionsAndGroups?: (string[] | string)␊ - /**␊ - * Specifies whether audit events are sent to Azure Monitor. ␍␊ - * In order to send the events to Azure Monitor, specify 'state' as 'Enabled' and 'isAzureMonitorTargetEnabled' as true.␍␊ - * ␍␊ - * When using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created.␍␊ - * Note that for server level audit you should use the 'master' database as {databaseName}.␍␊ - * ␍␊ - * Diagnostic Settings URI format:␍␊ - * PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview␍␊ - * ␍␊ - * For more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207)␍␊ - * or [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043)␍␊ - * ␊ - */␊ - isAzureMonitorTargetEnabled?: (boolean | string)␊ - /**␊ - * Specifies whether storageAccountAccessKey value is the storage's secondary key.␊ - */␊ - isStorageSecondaryKeyInUse?: (boolean | string)␊ - /**␊ - * Specifies condition of where clause when creating an audit.␊ - */␊ - predicateExpression?: string␊ - /**␊ - * Specifies the amount of time in milliseconds that can elapse before audit actions are forced to be processed.␍␊ - * The default minimum value is 1000 (1 second). The maximum is 2,147,483,647.␊ - */␊ - queueDelayMs?: (number | string)␊ - /**␊ - * Specifies the number of days to keep in the audit logs in the storage account.␊ - */␊ - retentionDays?: (number | string)␊ - /**␊ - * Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required.␊ - */␊ - state: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Specifies the identifier key of the auditing storage account. ␍␊ - * If state is Enabled and storageEndpoint is specified, not specifying the storageAccountAccessKey will use SQL server system-assigned managed identity to access the storage.␍␊ - * Prerequisites for using managed identity authentication:␍␊ - * 1. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD).␍␊ - * 2. Grant SQL Server identity access to the storage account by adding 'Storage Blob Data Contributor' RBAC role to the server identity.␍␊ - * For more information, see [Auditing to storage using Managed Identity authentication](https://go.microsoft.com/fwlink/?linkid=2114355)␊ - */␊ - storageAccountAccessKey?: string␊ - /**␊ - * Specifies the blob storage subscription Id.␊ - */␊ - storageAccountSubscriptionId?: string␊ - /**␊ - * Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required.␊ - */␊ - storageEndpoint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/jobAgents␊ - */␊ - export interface ServersJobAgents {␊ - apiVersion: "2017-03-01-preview"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the job agent to be created or updated.␊ - */␊ - name: string␊ - /**␊ - * Properties of a job agent.␊ - */␊ - properties: (JobAgentProperties | string)␊ - resources?: (ServersJobAgentsCredentialsChildResource | ServersJobAgentsJobsChildResource | ServersJobAgentsTargetGroupsChildResource)[]␊ - /**␊ - * An ARM Resource SKU.␊ - */␊ - sku?: (Sku41 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Sql/servers/jobAgents"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a job agent.␊ - */␊ - export interface JobAgentProperties {␊ - /**␊ - * Resource ID of the database to store job metadata in.␊ - */␊ - databaseId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/jobAgents/credentials␊ - */␊ - export interface ServersJobAgentsCredentialsChildResource {␊ - apiVersion: "2017-03-01-preview"␊ - /**␊ - * The name of the credential.␊ - */␊ - name: string␊ - /**␊ - * Properties of a job credential.␊ - */␊ - properties: (JobCredentialProperties | string)␊ - type: "credentials"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a job credential.␊ - */␊ - export interface JobCredentialProperties {␊ - /**␊ - * The credential password.␊ - */␊ - password: string␊ - /**␊ - * The credential user name.␊ - */␊ - username: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/jobAgents/jobs␊ - */␊ - export interface ServersJobAgentsJobsChildResource {␊ - apiVersion: "2017-03-01-preview"␊ - /**␊ - * The name of the job to get.␊ - */␊ - name: string␊ - /**␊ - * Properties of a job.␊ - */␊ - properties: (JobProperties3 | string)␊ - type: "jobs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a job.␊ - */␊ - export interface JobProperties3 {␊ - /**␊ - * User-defined description of the job.␊ - */␊ - description?: string␊ - /**␊ - * Scheduling properties of a job.␊ - */␊ - schedule?: (JobSchedule | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Scheduling properties of a job.␊ - */␊ - export interface JobSchedule {␊ - /**␊ - * Whether or not the schedule is enabled.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Schedule end time.␊ - */␊ - endTime?: string␊ - /**␊ - * Value of the schedule's recurring interval, if the schedule type is recurring. ISO8601 duration format.␊ - */␊ - interval?: string␊ - /**␊ - * Schedule start time.␊ - */␊ - startTime?: string␊ - /**␊ - * Schedule interval type.␊ - */␊ - type?: (("Once" | "Recurring") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/jobAgents/targetGroups␊ - */␊ - export interface ServersJobAgentsTargetGroupsChildResource {␊ - apiVersion: "2017-03-01-preview"␊ - /**␊ - * The name of the target group.␊ - */␊ - name: string␊ - /**␊ - * Properties of job target group.␊ - */␊ - properties: (JobTargetGroupProperties | string)␊ - type: "targetGroups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of job target group.␊ - */␊ - export interface JobTargetGroupProperties {␊ - /**␊ - * Members of the target group.␊ - */␊ - members: (JobTarget[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A job target, for example a specific database or a container of databases that is evaluated during job execution.␊ - */␊ - export interface JobTarget {␊ - /**␊ - * The target database name.␊ - */␊ - databaseName?: string␊ - /**␊ - * The target elastic pool name.␊ - */␊ - elasticPoolName?: string␊ - /**␊ - * Whether the target is included or excluded from the group.␊ - */␊ - membershipType?: (("Include" | "Exclude") | string)␊ - /**␊ - * The resource ID of the credential that is used during job execution to connect to the target and determine the list of databases inside the target.␊ - */␊ - refreshCredential?: string␊ - /**␊ - * The target server name.␊ - */␊ - serverName?: string␊ - /**␊ - * The target shard map.␊ - */␊ - shardMapName?: string␊ - /**␊ - * The target type.␊ - */␊ - type: (("TargetGroup" | "SqlDatabase" | "SqlElasticPool" | "SqlShardMap" | "SqlServer") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/jobAgents/credentials␊ - */␊ - export interface ServersJobAgentsCredentials {␊ - apiVersion: "2017-03-01-preview"␊ - /**␊ - * The name of the credential.␊ - */␊ - name: string␊ - /**␊ - * Properties of a job credential.␊ - */␊ - properties: (JobCredentialProperties | string)␊ - type: "Microsoft.Sql/servers/jobAgents/credentials"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/jobAgents/jobs␊ - */␊ - export interface ServersJobAgentsJobs {␊ - apiVersion: "2017-03-01-preview"␊ - /**␊ - * The name of the job to get.␊ - */␊ - name: string␊ - /**␊ - * Properties of a job.␊ - */␊ - properties: (JobProperties3 | string)␊ - resources?: (ServersJobAgentsJobsExecutionsChildResource | ServersJobAgentsJobsStepsChildResource)[]␊ - type: "Microsoft.Sql/servers/jobAgents/jobs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/jobAgents/jobs/executions␊ - */␊ - export interface ServersJobAgentsJobsExecutionsChildResource {␊ - apiVersion: "2017-03-01-preview"␊ - /**␊ - * The job execution id to create the job execution under.␊ - */␊ - name: string␊ - type: "executions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/jobAgents/jobs/steps␊ - */␊ - export interface ServersJobAgentsJobsStepsChildResource {␊ - apiVersion: "2017-03-01-preview"␊ - /**␊ - * The name of the job step.␊ - */␊ - name: string␊ - /**␊ - * Properties of a job step.␊ - */␊ - properties: (JobStepProperties | string)␊ - type: "steps"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a job step.␊ - */␊ - export interface JobStepProperties {␊ - /**␊ - * The action to be executed by a job step.␊ - */␊ - action: (JobStepAction | string)␊ - /**␊ - * The resource ID of the job credential that will be used to connect to the targets.␊ - */␊ - credential: string␊ - /**␊ - * The execution options of a job step.␊ - */␊ - executionOptions?: (JobStepExecutionOptions | string)␊ - /**␊ - * The output configuration of a job step.␊ - */␊ - output?: (JobStepOutput | string)␊ - /**␊ - * The job step's index within the job. If not specified when creating the job step, it will be created as the last step. If not specified when updating the job step, the step id is not modified.␊ - */␊ - stepId?: (number | string)␊ - /**␊ - * The resource ID of the target group that the job step will be executed on.␊ - */␊ - targetGroup: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The action to be executed by a job step.␊ - */␊ - export interface JobStepAction {␊ - /**␊ - * The source of the action to execute.␊ - */␊ - source?: ("Inline" | string)␊ - /**␊ - * Type of action being executed by the job step.␊ - */␊ - type?: ("TSql" | string)␊ - /**␊ - * The action value, for example the text of the T-SQL script to execute.␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The execution options of a job step.␊ - */␊ - export interface JobStepExecutionOptions {␊ - /**␊ - * Initial delay between retries for job step execution.␊ - */␊ - initialRetryIntervalSeconds?: ((number & string) | string)␊ - /**␊ - * The maximum amount of time to wait between retries for job step execution.␊ - */␊ - maximumRetryIntervalSeconds?: ((number & string) | string)␊ - /**␊ - * Maximum number of times the job step will be reattempted if the first attempt fails.␊ - */␊ - retryAttempts?: ((number & string) | string)␊ - /**␊ - * The backoff multiplier for the time between retries.␊ - */␊ - retryIntervalBackoffMultiplier?: (number | string)␊ - /**␊ - * Execution timeout for the job step.␊ - */␊ - timeoutSeconds?: ((number & string) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The output configuration of a job step.␊ - */␊ - export interface JobStepOutput {␊ - /**␊ - * The resource ID of the credential to use to connect to the output destination.␊ - */␊ - credential: string␊ - /**␊ - * The output destination database.␊ - */␊ - databaseName: string␊ - /**␊ - * The output destination resource group.␊ - */␊ - resourceGroupName?: string␊ - /**␊ - * The output destination schema.␊ - */␊ - schemaName?: string␊ - /**␊ - * The output destination server name.␊ - */␊ - serverName: string␊ - /**␊ - * The output destination subscription id.␊ - */␊ - subscriptionId?: string␊ - /**␊ - * The output destination table.␊ - */␊ - tableName: string␊ - /**␊ - * The output destination type.␊ - */␊ - type?: ("SqlDatabase" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/jobAgents/jobs/executions␊ - */␊ - export interface ServersJobAgentsJobsExecutions {␊ - apiVersion: "2017-03-01-preview"␊ - /**␊ - * The job execution id to create the job execution under.␊ - */␊ - name: string␊ - type: "Microsoft.Sql/servers/jobAgents/jobs/executions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/jobAgents/jobs/steps␊ - */␊ - export interface ServersJobAgentsJobsSteps {␊ - apiVersion: "2017-03-01-preview"␊ - /**␊ - * The name of the job step.␊ - */␊ - name: string␊ - /**␊ - * Properties of a job step.␊ - */␊ - properties: (JobStepProperties | string)␊ - type: "Microsoft.Sql/servers/jobAgents/jobs/steps"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Sql/servers/jobAgents/targetGroups␊ - */␊ - export interface ServersJobAgentsTargetGroups {␊ - apiVersion: "2017-03-01-preview"␊ - /**␊ - * The name of the target group.␊ - */␊ - name: string␊ - /**␊ - * Properties of job target group.␊ - */␊ - properties: (JobTargetGroupProperties | string)␊ - type: "Microsoft.Sql/servers/jobAgents/targetGroups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.MachineLearning/webServices␊ - */␊ - export interface WebServices1 {␊ - apiVersion: "2017-01-01"␊ - /**␊ - * Specifies the location of the resource.␊ - */␊ - location: string␊ - /**␊ - * The name of the web service.␊ - */␊ - name: string␊ - /**␊ - * The set of properties specific to the Azure ML web service resource.␊ - */␊ - properties: (WebServiceProperties1 | string)␊ - /**␊ - * Contains resource tags defined as key/value pairs.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.MachineLearning/webServices"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about an asset associated with the web service.␊ - */␊ - export interface AssetItem1 {␊ - /**␊ - * Asset's Id.␊ - */␊ - id?: string␊ - /**␊ - * Information about the asset's input ports.␊ - */␊ - inputPorts?: ({␊ - [k: string]: InputPort1␊ - } | string)␊ - /**␊ - * Describes the access location for a blob.␊ - */␊ - locationInfo: (BlobLocation | string)␊ - /**␊ - * If the asset is a custom module, this holds the module's metadata.␊ - */␊ - metadata?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Asset's friendly name.␊ - */␊ - name: string␊ - /**␊ - * Information about the asset's output ports.␊ - */␊ - outputPorts?: ({␊ - [k: string]: OutputPort1␊ - } | string)␊ - /**␊ - * If the asset is a custom module, this holds the module's parameters.␊ - */␊ - parameters?: (ModuleAssetParameter1[] | string)␊ - /**␊ - * Asset's type.␊ - */␊ - type: (("Module" | "Resource") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Asset input port␊ - */␊ - export interface InputPort1 {␊ - /**␊ - * Port data type.␊ - */␊ - type?: ("Dataset" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the access location for a blob.␊ - */␊ - export interface BlobLocation {␊ - /**␊ - * Access credentials for the blob, if applicable (e.g. blob specified by storage account connection string + blob URI)␊ - */␊ - credentials?: string␊ - /**␊ - * The URI from which the blob is accessible from. For example, aml://abc for system assets or https://xyz for user assets or payload.␊ - */␊ - uri: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Asset output port␊ - */␊ - export interface OutputPort1 {␊ - /**␊ - * Port data type.␊ - */␊ - type?: ("Dataset" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameter definition for a module asset.␊ - */␊ - export interface ModuleAssetParameter1 {␊ - /**␊ - * Definitions for nested interface parameters if this is a complex module parameter.␊ - */␊ - modeValuesInfo?: ({␊ - [k: string]: ModeValueInfo1␊ - } | string)␊ - /**␊ - * Parameter name.␊ - */␊ - name?: string␊ - /**␊ - * Parameter type.␊ - */␊ - parameterType?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Nested parameter definition.␊ - */␊ - export interface ModeValueInfo1 {␊ - /**␊ - * The interface string name for the nested parameter.␊ - */␊ - interfaceString?: string␊ - /**␊ - * The definition of the parameter.␊ - */␊ - parameters?: ({␊ - [k: string]: unknown␊ - }[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the machine learning commitment plan associated with the web service.␊ - */␊ - export interface CommitmentPlan {␊ - /**␊ - * Specifies the Azure Resource Manager ID of the commitment plan associated with the web service.␊ - */␊ - id: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Diagnostics settings for an Azure ML web service.␊ - */␊ - export interface DiagnosticsConfiguration1 {␊ - /**␊ - * Specifies the date and time when the logging will cease. If null, diagnostic collection is not time limited.␊ - */␊ - expiry?: string␊ - /**␊ - * Specifies the verbosity of the diagnostic output. Valid values are: None - disables tracing; Error - collects only error (stderr) traces; All - collects all traces (stdout and stderr).␊ - */␊ - level: (("None" | "Error" | "All") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Sample input data for the service's input(s).␊ - */␊ - export interface ExampleRequest1 {␊ - /**␊ - * Sample input data for the web service's global parameters␊ - */␊ - globalParameters?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Sample input data for the web service's input(s) given as an input name to sample input values matrix map.␊ - */␊ - inputs?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }[][]␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The swagger 2.0 schema describing the service's inputs or outputs. See Swagger specification: http://swagger.io/specification/␊ - */␊ - export interface ServiceInputOutputSpecification1 {␊ - /**␊ - * The description of the Swagger schema.␊ - */␊ - description?: string␊ - /**␊ - * Specifies a collection that contains the column schema for each input or output of the web service. For more information, see the Swagger specification.␊ - */␊ - properties: ({␊ - [k: string]: TableSpecification1␊ - } | string)␊ - /**␊ - * The title of your Swagger schema.␊ - */␊ - title?: string␊ - /**␊ - * The type of the entity described in swagger. Always 'object'.␊ - */␊ - type: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The swagger 2.0 schema describing a single service input or output. See Swagger specification: http://swagger.io/specification/␊ - */␊ - export interface TableSpecification1 {␊ - /**␊ - * Swagger schema description.␊ - */␊ - description?: string␊ - /**␊ - * The format, if 'type' is not 'object'␊ - */␊ - format?: string␊ - /**␊ - * The set of columns within the data table.␊ - */␊ - properties?: ({␊ - [k: string]: ColumnSpecification1␊ - } | string)␊ - /**␊ - * Swagger schema title.␊ - */␊ - title?: string␊ - /**␊ - * The type of the entity described in swagger.␊ - */␊ - type: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Swagger 2.0 schema for a column within the data table representing a web service input or output. See Swagger specification: http://swagger.io/specification/␊ - */␊ - export interface ColumnSpecification1 {␊ - /**␊ - * If the data type is categorical, this provides the list of accepted categories.␊ - */␊ - enum?: ({␊ - [k: string]: unknown␊ - }[] | string)␊ - /**␊ - * Additional format information for the data type.␊ - */␊ - format?: (("Byte" | "Char" | "Complex64" | "Complex128" | "Date-time" | "Date-timeOffset" | "Double" | "Duration" | "Float" | "Int8" | "Int16" | "Int32" | "Int64" | "Uint8" | "Uint16" | "Uint32" | "Uint64") | string)␊ - /**␊ - * Data type of the column.␊ - */␊ - type: (("Boolean" | "Integer" | "Number" | "String") | string)␊ - /**␊ - * Flag indicating if the type supports null values or not.␊ - */␊ - "x-ms-isnullable"?: (boolean | string)␊ - /**␊ - * Flag indicating whether the categories are treated as an ordered set or not, if this is a categorical column.␊ - */␊ - "x-ms-isordered"?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Access keys for the web service calls.␊ - */␊ - export interface WebServiceKeys1 {␊ - /**␊ - * The primary access key.␊ - */␊ - primary?: string␊ - /**␊ - * The secondary access key.␊ - */␊ - secondary?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the machine learning workspace containing the experiment that is source for the web service.␊ - */␊ - export interface MachineLearningWorkspace1 {␊ - /**␊ - * Specifies the workspace ID of the machine learning workspace associated with the web service␊ - */␊ - id: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Web Service Parameter object for node and global parameter␊ - */␊ - export interface WebServiceParameter {␊ - /**␊ - * If the parameter value in 'value' field is encrypted, the thumbprint of the certificate should be put here.␊ - */␊ - certificateThumbprint?: string␊ - /**␊ - * The parameter value␊ - */␊ - value?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Holds the available configuration options for an Azure ML web service endpoint.␊ - */␊ - export interface RealtimeConfiguration1 {␊ - /**␊ - * Specifies the maximum concurrent calls that can be made to the web service. Minimum value: 4, Maximum value: 200.␊ - */␊ - maxConcurrentCalls?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Access information for a storage account.␊ - */␊ - export interface StorageAccount3 {␊ - /**␊ - * Specifies the key used to access the storage account.␊ - */␊ - key?: string␊ - /**␊ - * Specifies the name of the storage account.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to a Graph based web service.␊ - */␊ - export interface WebServicePropertiesForGraph1 {␊ - /**␊ - * Defines the graph of modules making up the machine learning solution.␊ - */␊ - package?: (GraphPackage1 | string)␊ - packageType: "Graph"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines the graph of modules making up the machine learning solution.␊ - */␊ - export interface GraphPackage1 {␊ - /**␊ - * The list of edges making up the graph.␊ - */␊ - edges?: (GraphEdge1[] | string)␊ - /**␊ - * The collection of global parameters for the graph, given as a global parameter name to GraphParameter map. Each parameter here has a 1:1 match with the global parameters values map declared at the WebServiceProperties level.␊ - */␊ - graphParameters?: ({␊ - [k: string]: GraphParameter1␊ - } | string)␊ - /**␊ - * The set of nodes making up the graph, provided as a nodeId to GraphNode map␊ - */␊ - nodes?: ({␊ - [k: string]: GraphNode1␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines an edge within the web service's graph.␊ - */␊ - export interface GraphEdge1 {␊ - /**␊ - * The source graph node's identifier.␊ - */␊ - sourceNodeId?: string␊ - /**␊ - * The identifier of the source node's port that the edge connects from.␊ - */␊ - sourcePortId?: string␊ - /**␊ - * The destination graph node's identifier.␊ - */␊ - targetNodeId?: string␊ - /**␊ - * The identifier of the destination node's port that the edge connects into.␊ - */␊ - targetPortId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines a global parameter in the graph.␊ - */␊ - export interface GraphParameter1 {␊ - /**␊ - * Description of this graph parameter.␊ - */␊ - description?: string␊ - /**␊ - * Association links for this parameter to nodes in the graph.␊ - */␊ - links: (GraphParameterLink1[] | string)␊ - /**␊ - * Graph parameter's type.␊ - */␊ - type: (("String" | "Int" | "Float" | "Enumerated" | "Script" | "Mode" | "Credential" | "Boolean" | "Double" | "ColumnPicker" | "ParameterRange" | "DataGatewayName") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Association link for a graph global parameter to a node in the graph.␊ - */␊ - export interface GraphParameterLink1 {␊ - /**␊ - * The graph node's identifier␊ - */␊ - nodeId: string␊ - /**␊ - * The identifier of the node parameter that the global parameter maps to.␊ - */␊ - parameterKey: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies a node in the web service graph. The node can either be an input, output or asset node, so only one of the corresponding id properties is populated at any given time.␊ - */␊ - export interface GraphNode1 {␊ - /**␊ - * The id of the asset represented by this node.␊ - */␊ - assetId?: string␊ - /**␊ - * The id of the input element represented by this node.␊ - */␊ - inputId?: string␊ - /**␊ - * The id of the output element represented by this node.␊ - */␊ - outputId?: string␊ - /**␊ - * If applicable, parameters of the node. Global graph parameters map into these, with values set at runtime.␊ - */␊ - parameters?: ({␊ - [k: string]: WebServiceParameter␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.MachineLearning/workspaces␊ - */␊ - export interface Workspaces3 {␊ - apiVersion: "2019-10-01"␊ - /**␊ - * The location of the resource. This cannot be changed after the resource is created.␊ - */␊ - location: string␊ - /**␊ - * The name of the machine learning workspace.␊ - */␊ - name: string␊ - /**␊ - * The properties of a machine learning workspace.␊ - */␊ - properties: (WorkspaceProperties4 | string)␊ - /**␊ - * Sku of the resource␊ - */␊ - sku?: (Sku42 | string)␊ - /**␊ - * The tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.MachineLearning/workspaces"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a machine learning workspace.␊ - */␊ - export interface WorkspaceProperties4 {␊ - /**␊ - * The key vault identifier used for encrypted workspaces.␊ - */␊ - keyVaultIdentifierId?: string␊ - /**␊ - * The email id of the owner for this workspace.␊ - */␊ - ownerEmail: string␊ - /**␊ - * The fully qualified arm id of the storage account associated with this workspace.␊ - */␊ - userStorageAccountId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Sku of the resource␊ - */␊ - export interface Sku42 {␊ - /**␊ - * Name of the sku␊ - */␊ - name?: string␊ - /**␊ - * Tier of the sku like Basic or Enterprise␊ - */␊ - tier?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.StreamAnalytics/streamingjobs␊ - */␊ - export interface Streamingjobs {␊ - apiVersion: "2016-03-01"␊ - /**␊ - * The geo-location where the resource lives␊ - */␊ - location?: string␊ - /**␊ - * The name of the streaming job.␊ - */␊ - name: string␊ - /**␊ - * The properties that are associated with a streaming job.␊ - */␊ - properties: (StreamingJobProperties | string)␊ - resources?: (StreamingjobsInputsChildResource | StreamingjobsOutputsChildResource | StreamingjobsTransformationsChildResource | StreamingjobsFunctionsChildResource)[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.StreamAnalytics/streamingjobs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties that are associated with a streaming job.␊ - */␊ - export interface StreamingJobProperties {␊ - /**␊ - * Controls certain runtime behaviors of the streaming job.␊ - */␊ - compatibilityLevel?: ("1.0" | string)␊ - /**␊ - * The data locale of the stream analytics job. Value should be the name of a supported .NET Culture from the set https://msdn.microsoft.com/en-us/library/system.globalization.culturetypes(v=vs.110).aspx. Defaults to 'en-US' if none specified.␊ - */␊ - dataLocale?: string␊ - /**␊ - * The maximum tolerable delay in seconds where events arriving late could be included. Supported range is -1 to 1814399 (20.23:59:59 days) and -1 is used to specify wait indefinitely. If the property is absent, it is interpreted to have a value of -1.␊ - */␊ - eventsLateArrivalMaxDelayInSeconds?: (number | string)␊ - /**␊ - * The maximum tolerable delay in seconds where out-of-order events can be adjusted to be back in order.␊ - */␊ - eventsOutOfOrderMaxDelayInSeconds?: (number | string)␊ - /**␊ - * Indicates the policy to apply to events that arrive out of order in the input event stream.␊ - */␊ - eventsOutOfOrderPolicy?: (("Adjust" | "Drop") | string)␊ - /**␊ - * A list of one or more functions for the streaming job. The name property for each function is required when specifying this property in a PUT request. This property cannot be modify via a PATCH operation. You must use the PATCH API available for the individual transformation.␊ - */␊ - functions?: (Function[] | string)␊ - /**␊ - * A list of one or more inputs to the streaming job. The name property for each input is required when specifying this property in a PUT request. This property cannot be modify via a PATCH operation. You must use the PATCH API available for the individual input.␊ - */␊ - inputs?: (Input[] | string)␊ - /**␊ - * Indicates the policy to apply to events that arrive at the output and cannot be written to the external storage due to being malformed (missing column values, column values of wrong type or size).␊ - */␊ - outputErrorPolicy?: (("Stop" | "Drop") | string)␊ - /**␊ - * A list of one or more outputs for the streaming job. The name property for each output is required when specifying this property in a PUT request. This property cannot be modify via a PATCH operation. You must use the PATCH API available for the individual output.␊ - */␊ - outputs?: (Output[] | string)␊ - /**␊ - * This property should only be utilized when it is desired that the job be started immediately upon creation. Value may be JobStartTime, CustomTime, or LastOutputEventTime to indicate whether the starting point of the output event stream should start whenever the job is started, start at a custom user time stamp specified via the outputStartTime property, or start from the last event output time.␊ - */␊ - outputStartMode?: (("JobStartTime" | "CustomTime" | "LastOutputEventTime") | string)␊ - /**␊ - * Value is either an ISO-8601 formatted time stamp that indicates the starting point of the output event stream, or null to indicate that the output event stream will start whenever the streaming job is started. This property must have a value if outputStartMode is set to CustomTime.␊ - */␊ - outputStartTime?: string␊ - /**␊ - * The properties that are associated with a SKU.␊ - */␊ - sku?: (Sku43 | string)␊ - /**␊ - * A transformation object, containing all information associated with the named transformation. All transformations are contained under a streaming job.␊ - */␊ - transformation?: (Transformation | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A function object, containing all information associated with the named function. All functions are contained under a streaming job.␊ - */␊ - export interface Function {␊ - /**␊ - * Resource name␊ - */␊ - name?: string␊ - /**␊ - * The properties that are associated with a function.␊ - */␊ - properties?: (FunctionProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties that are associated with a scalar function.␊ - */␊ - export interface ScalarFunctionProperties {␊ - /**␊ - * Describes the configuration of the scalar function.␊ - */␊ - properties?: (ScalarFunctionConfiguration | string)␊ - type: "Scalar"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the configuration of the scalar function.␊ - */␊ - export interface ScalarFunctionConfiguration {␊ - /**␊ - * The physical binding of the function. For example, in the Azure Machine Learning web service’s case, this describes the endpoint.␊ - */␊ - binding?: (FunctionBinding | string)␊ - /**␊ - * A list of inputs describing the parameters of the function.␊ - */␊ - inputs?: (FunctionInput[] | string)␊ - /**␊ - * Describes the output of a function.␊ - */␊ - output?: (FunctionOutput1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The binding to an Azure Machine Learning web service.␊ - */␊ - export interface AzureMachineLearningWebServiceFunctionBinding {␊ - /**␊ - * The binding properties associated with an Azure Machine learning web service.␊ - */␊ - properties?: (AzureMachineLearningWebServiceFunctionBindingProperties | string)␊ - type: "Microsoft.MachineLearning/WebService"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The binding properties associated with an Azure Machine learning web service.␊ - */␊ - export interface AzureMachineLearningWebServiceFunctionBindingProperties {␊ - /**␊ - * The API key used to authenticate with Request-Response endpoint.␊ - */␊ - apiKey?: string␊ - /**␊ - * Number between 1 and 10000 describing maximum number of rows for every Azure ML RRS execute request. Default is 1000.␊ - */␊ - batchSize?: (number | string)␊ - /**␊ - * The Request-Response execute endpoint of the Azure Machine Learning web service. Find out more here: https://docs.microsoft.com/en-us/azure/machine-learning/machine-learning-consume-web-services#request-response-service-rrs␊ - */␊ - endpoint?: string␊ - /**␊ - * The inputs for the Azure Machine Learning web service endpoint.␊ - */␊ - inputs?: (AzureMachineLearningWebServiceInputs | string)␊ - /**␊ - * A list of outputs from the Azure Machine Learning web service endpoint execution.␊ - */␊ - outputs?: (AzureMachineLearningWebServiceOutputColumn[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The inputs for the Azure Machine Learning web service endpoint.␊ - */␊ - export interface AzureMachineLearningWebServiceInputs {␊ - /**␊ - * A list of input columns for the Azure Machine Learning web service endpoint.␊ - */␊ - columnNames?: (AzureMachineLearningWebServiceInputColumn[] | string)␊ - /**␊ - * The name of the input. This is the name provided while authoring the endpoint.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes an input column for the Azure Machine Learning web service endpoint.␊ - */␊ - export interface AzureMachineLearningWebServiceInputColumn {␊ - /**␊ - * The (Azure Machine Learning supported) data type of the input column. A list of valid Azure Machine Learning data types are described at https://msdn.microsoft.com/en-us/library/azure/dn905923.aspx .␊ - */␊ - dataType?: string␊ - /**␊ - * The zero based index of the function parameter this input maps to.␊ - */␊ - mapTo?: (number | string)␊ - /**␊ - * The name of the input column.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes an output column for the Azure Machine Learning web service endpoint.␊ - */␊ - export interface AzureMachineLearningWebServiceOutputColumn {␊ - /**␊ - * The (Azure Machine Learning supported) data type of the output column. A list of valid Azure Machine Learning data types are described at https://msdn.microsoft.com/en-us/library/azure/dn905923.aspx .␊ - */␊ - dataType?: string␊ - /**␊ - * The name of the output column.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The binding to a JavaScript function.␊ - */␊ - export interface JavaScriptFunctionBinding {␊ - /**␊ - * The binding properties associated with a JavaScript function.␊ - */␊ - properties?: (JavaScriptFunctionBindingProperties | string)␊ - type: "Microsoft.StreamAnalytics/JavascriptUdf"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The binding properties associated with a JavaScript function.␊ - */␊ - export interface JavaScriptFunctionBindingProperties {␊ - /**␊ - * The JavaScript code containing a single function definition. For example: 'function (x, y) { return x + y; }'␊ - */␊ - script?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes one input parameter of a function.␊ - */␊ - export interface FunctionInput {␊ - /**␊ - * The (Azure Stream Analytics supported) data type of the function input parameter. A list of valid Azure Stream Analytics data types are described at https://msdn.microsoft.com/en-us/library/azure/dn835065.aspx␊ - */␊ - dataType?: string␊ - /**␊ - * A flag indicating if the parameter is a configuration parameter. True if this input parameter is expected to be a constant. Default is false.␊ - */␊ - isConfigurationParameter?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the output of a function.␊ - */␊ - export interface FunctionOutput1 {␊ - /**␊ - * The (Azure Stream Analytics supported) data type of the function output. A list of valid Azure Stream Analytics data types are described at https://msdn.microsoft.com/en-us/library/azure/dn835065.aspx␊ - */␊ - dataType?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An input object, containing all information associated with the named input. All inputs are contained under a streaming job.␊ - */␊ - export interface Input {␊ - /**␊ - * Resource name␊ - */␊ - name?: string␊ - /**␊ - * The properties that are associated with an input.␊ - */␊ - properties?: (InputProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes how data from an input is serialized or how data is serialized when written to an output in CSV format.␊ - */␊ - export interface CsvSerialization {␊ - /**␊ - * The properties that are associated with the CSV serialization type.␊ - */␊ - properties?: (CsvSerializationProperties | string)␊ - type: "Csv"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties that are associated with the CSV serialization type.␊ - */␊ - export interface CsvSerializationProperties {␊ - /**␊ - * Specifies the encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output. Required on PUT (CreateOrReplace) requests.␊ - */␊ - encoding?: ("UTF8" | string)␊ - /**␊ - * Specifies the delimiter that will be used to separate comma-separated value (CSV) records. See https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input or https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output for a list of supported values. Required on PUT (CreateOrReplace) requests.␊ - */␊ - fieldDelimiter?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes how data from an input is serialized or how data is serialized when written to an output in JSON format.␊ - */␊ - export interface JsonSerialization {␊ - /**␊ - * The properties that are associated with the JSON serialization type.␊ - */␊ - properties?: (JsonSerializationProperties | string)␊ - type: "Json"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties that are associated with the JSON serialization type.␊ - */␊ - export interface JsonSerializationProperties {␊ - /**␊ - * Specifies the encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output. Required on PUT (CreateOrReplace) requests.␊ - */␊ - encoding?: ("UTF8" | string)␊ - /**␊ - * This property only applies to JSON serialization of outputs only. It is not applicable to inputs. This property specifies the format of the JSON the output will be written in. The currently supported values are 'lineSeparated' indicating the output will be formatted by having each JSON object separated by a new line and 'array' indicating the output will be formatted as an array of JSON objects. Default value is 'lineSeparated' if left null.␊ - */␊ - format?: (("LineSeparated" | "Array") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes how data from an input is serialized or how data is serialized when written to an output in Avro format.␊ - */␊ - export interface AvroSerialization {␊ - /**␊ - * The properties that are associated with the Avro serialization type.␊ - */␊ - properties?: {␊ - [k: string]: unknown␊ - }␊ - type: "Avro"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties that are associated with an input containing stream data.␊ - */␊ - export interface StreamInputProperties {␊ - /**␊ - * Describes an input data source that contains stream data.␊ - */␊ - datasource?: (StreamInputDataSource | string)␊ - type: "Stream"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a blob input data source that contains stream data.␊ - */␊ - export interface BlobStreamInputDataSource {␊ - /**␊ - * The properties that are associated with a blob input containing stream data.␊ - */␊ - properties?: (BlobStreamInputDataSourceProperties | string)␊ - type: "Microsoft.Storage/Blob"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties that are associated with a blob input containing stream data.␊ - */␊ - export interface BlobStreamInputDataSourceProperties {␊ - /**␊ - * The name of a container within the associated Storage account. This container contains either the blob(s) to be read from or written to. Required on PUT (CreateOrReplace) requests.␊ - */␊ - container?: string␊ - /**␊ - * The date format. Wherever {date} appears in pathPattern, the value of this property is used as the date format instead.␊ - */␊ - dateFormat?: string␊ - /**␊ - * The blob path pattern. Not a regular expression. It represents a pattern against which blob names will be matched to determine whether or not they should be included as input or output to the job. See https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input or https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output for a more detailed explanation and example.␊ - */␊ - pathPattern?: string␊ - /**␊ - * The partition count of the blob input data source. Range 1 - 1024.␊ - */␊ - sourcePartitionCount?: (number | string)␊ - /**␊ - * A list of one or more Azure Storage accounts. Required on PUT (CreateOrReplace) requests.␊ - */␊ - storageAccounts?: (StorageAccount4[] | string)␊ - /**␊ - * The time format. Wherever {time} appears in pathPattern, the value of this property is used as the time format instead.␊ - */␊ - timeFormat?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties that are associated with an Azure Storage account␊ - */␊ - export interface StorageAccount4 {␊ - /**␊ - * The account key for the Azure Storage account. Required on PUT (CreateOrReplace) requests.␊ - */␊ - accountKey?: string␊ - /**␊ - * The name of the Azure Storage account. Required on PUT (CreateOrReplace) requests.␊ - */␊ - accountName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes an Event Hub input data source that contains stream data.␊ - */␊ - export interface EventHubStreamInputDataSource {␊ - /**␊ - * The properties that are associated with a Event Hub input containing stream data.␊ - */␊ - properties?: (EventHubStreamInputDataSourceProperties | string)␊ - type: "Microsoft.ServiceBus/EventHub"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties that are associated with a Event Hub input containing stream data.␊ - */␊ - export interface EventHubStreamInputDataSourceProperties {␊ - /**␊ - * The name of an Event Hub Consumer Group that should be used to read events from the Event Hub. Specifying distinct consumer group names for multiple inputs allows each of those inputs to receive the same events from the Event Hub. If not specified, the input uses the Event Hub’s default consumer group.␊ - */␊ - consumerGroupName?: string␊ - /**␊ - * The name of the Event Hub. Required on PUT (CreateOrReplace) requests.␊ - */␊ - eventHubName?: string␊ - /**␊ - * The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests.␊ - */␊ - serviceBusNamespace?: string␊ - /**␊ - * The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests.␊ - */␊ - sharedAccessPolicyKey?: string␊ - /**␊ - * The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests.␊ - */␊ - sharedAccessPolicyName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes an IoT Hub input data source that contains stream data.␊ - */␊ - export interface IoTHubStreamInputDataSource {␊ - /**␊ - * The properties that are associated with a IoT Hub input containing stream data.␊ - */␊ - properties?: (IoTHubStreamInputDataSourceProperties | string)␊ - type: "Microsoft.Devices/IotHubs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties that are associated with a IoT Hub input containing stream data.␊ - */␊ - export interface IoTHubStreamInputDataSourceProperties {␊ - /**␊ - * The name of an IoT Hub Consumer Group that should be used to read events from the IoT Hub. If not specified, the input uses the Iot Hub’s default consumer group.␊ - */␊ - consumerGroupName?: string␊ - /**␊ - * The IoT Hub endpoint to connect to (ie. messages/events, messages/operationsMonitoringEvents, etc.).␊ - */␊ - endpoint?: string␊ - /**␊ - * The name or the URI of the IoT Hub. Required on PUT (CreateOrReplace) requests.␊ - */␊ - iotHubNamespace?: string␊ - /**␊ - * The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests.␊ - */␊ - sharedAccessPolicyKey?: string␊ - /**␊ - * The shared access policy name for the IoT Hub. This policy must contain at least the Service connect permission. Required on PUT (CreateOrReplace) requests.␊ - */␊ - sharedAccessPolicyName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties that are associated with an input containing reference data.␊ - */␊ - export interface ReferenceInputProperties {␊ - /**␊ - * Describes an input data source that contains reference data.␊ - */␊ - datasource?: (ReferenceInputDataSource | string)␊ - type: "Reference"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a blob input data source that contains reference data.␊ - */␊ - export interface BlobReferenceInputDataSource {␊ - /**␊ - * The properties that are associated with a blob input containing reference data.␊ - */␊ - properties?: (BlobReferenceInputDataSourceProperties | string)␊ - type: "Microsoft.Storage/Blob"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties that are associated with a blob input containing reference data.␊ - */␊ - export interface BlobReferenceInputDataSourceProperties {␊ - /**␊ - * The name of a container within the associated Storage account. This container contains either the blob(s) to be read from or written to. Required on PUT (CreateOrReplace) requests.␊ - */␊ - container?: string␊ - /**␊ - * The date format. Wherever {date} appears in pathPattern, the value of this property is used as the date format instead.␊ - */␊ - dateFormat?: string␊ - /**␊ - * The blob path pattern. Not a regular expression. It represents a pattern against which blob names will be matched to determine whether or not they should be included as input or output to the job. See https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input or https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output for a more detailed explanation and example.␊ - */␊ - pathPattern?: string␊ - /**␊ - * A list of one or more Azure Storage accounts. Required on PUT (CreateOrReplace) requests.␊ - */␊ - storageAccounts?: (StorageAccount4[] | string)␊ - /**␊ - * The time format. Wherever {time} appears in pathPattern, the value of this property is used as the time format instead.␊ - */␊ - timeFormat?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An output object, containing all information associated with the named output. All outputs are contained under a streaming job.␊ - */␊ - export interface Output {␊ - /**␊ - * Resource name␊ - */␊ - name?: string␊ - /**␊ - * The properties that are associated with an output.␊ - */␊ - properties?: (OutputProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties that are associated with an output.␊ - */␊ - export interface OutputProperties {␊ - /**␊ - * Describes the data source that output will be written to.␊ - */␊ - datasource?: (OutputDataSource | string)␊ - /**␊ - * Describes how data from an input is serialized or how data is serialized when written to an output.␊ - */␊ - serialization?: ((CsvSerialization | JsonSerialization | AvroSerialization) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a blob output data source.␊ - */␊ - export interface BlobOutputDataSource {␊ - /**␊ - * The properties that are associated with a blob output.␊ - */␊ - properties?: (BlobOutputDataSourceProperties | string)␊ - type: "Microsoft.Storage/Blob"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties that are associated with a blob output.␊ - */␊ - export interface BlobOutputDataSourceProperties {␊ - /**␊ - * The name of a container within the associated Storage account. This container contains either the blob(s) to be read from or written to. Required on PUT (CreateOrReplace) requests.␊ - */␊ - container?: string␊ - /**␊ - * The date format. Wherever {date} appears in pathPattern, the value of this property is used as the date format instead.␊ - */␊ - dateFormat?: string␊ - /**␊ - * The blob path pattern. Not a regular expression. It represents a pattern against which blob names will be matched to determine whether or not they should be included as input or output to the job. See https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input or https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output for a more detailed explanation and example.␊ - */␊ - pathPattern?: string␊ - /**␊ - * A list of one or more Azure Storage accounts. Required on PUT (CreateOrReplace) requests.␊ - */␊ - storageAccounts?: (StorageAccount4[] | string)␊ - /**␊ - * The time format. Wherever {time} appears in pathPattern, the value of this property is used as the time format instead.␊ - */␊ - timeFormat?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes an Azure Table output data source.␊ - */␊ - export interface AzureTableOutputDataSource {␊ - /**␊ - * The properties that are associated with an Azure Table output.␊ - */␊ - properties?: (AzureTableOutputDataSourceProperties | string)␊ - type: "Microsoft.Storage/Table"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties that are associated with an Azure Table output.␊ - */␊ - export interface AzureTableOutputDataSourceProperties {␊ - /**␊ - * The account key for the Azure Storage account. Required on PUT (CreateOrReplace) requests.␊ - */␊ - accountKey?: string␊ - /**␊ - * The name of the Azure Storage account. Required on PUT (CreateOrReplace) requests.␊ - */␊ - accountName?: string␊ - /**␊ - * The number of rows to write to the Azure Table at a time.␊ - */␊ - batchSize?: (number | string)␊ - /**␊ - * If specified, each item in the array is the name of a column to remove (if present) from output event entities.␊ - */␊ - columnsToRemove?: (string[] | string)␊ - /**␊ - * This element indicates the name of a column from the SELECT statement in the query that will be used as the partition key for the Azure Table. Required on PUT (CreateOrReplace) requests.␊ - */␊ - partitionKey?: string␊ - /**␊ - * This element indicates the name of a column from the SELECT statement in the query that will be used as the row key for the Azure Table. Required on PUT (CreateOrReplace) requests.␊ - */␊ - rowKey?: string␊ - /**␊ - * The name of the Azure Table. Required on PUT (CreateOrReplace) requests.␊ - */␊ - table?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes an Event Hub output data source.␊ - */␊ - export interface EventHubOutputDataSource {␊ - /**␊ - * The properties that are associated with an Event Hub output.␊ - */␊ - properties?: (EventHubOutputDataSourceProperties | string)␊ - type: "Microsoft.ServiceBus/EventHub"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties that are associated with an Event Hub output.␊ - */␊ - export interface EventHubOutputDataSourceProperties {␊ - /**␊ - * The name of the Event Hub. Required on PUT (CreateOrReplace) requests.␊ - */␊ - eventHubName?: string␊ - /**␊ - * The key/column that is used to determine to which partition to send event data.␊ - */␊ - partitionKey?: string␊ - /**␊ - * The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests.␊ - */␊ - serviceBusNamespace?: string␊ - /**␊ - * The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests.␊ - */␊ - sharedAccessPolicyKey?: string␊ - /**␊ - * The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests.␊ - */␊ - sharedAccessPolicyName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes an Azure SQL database output data source.␊ - */␊ - export interface AzureSqlDatabaseOutputDataSource {␊ - /**␊ - * The properties that are associated with an Azure SQL database output.␊ - */␊ - properties?: (AzureSqlDatabaseOutputDataSourceProperties | string)␊ - type: "Microsoft.Sql/Server/Database"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties that are associated with an Azure SQL database output.␊ - */␊ - export interface AzureSqlDatabaseOutputDataSourceProperties {␊ - /**␊ - * The name of the Azure SQL database. Required on PUT (CreateOrReplace) requests.␊ - */␊ - database?: string␊ - /**␊ - * The password that will be used to connect to the Azure SQL database. Required on PUT (CreateOrReplace) requests.␊ - */␊ - password?: string␊ - /**␊ - * The name of the SQL server containing the Azure SQL database. Required on PUT (CreateOrReplace) requests.␊ - */␊ - server?: string␊ - /**␊ - * The name of the table in the Azure SQL database. Required on PUT (CreateOrReplace) requests.␊ - */␊ - table?: string␊ - /**␊ - * The user name that will be used to connect to the Azure SQL database. Required on PUT (CreateOrReplace) requests.␊ - */␊ - user?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a DocumentDB output data source.␊ - */␊ - export interface DocumentDbOutputDataSource {␊ - /**␊ - * The properties that are associated with a DocumentDB output.␊ - */␊ - properties?: (DocumentDbOutputDataSourceProperties | string)␊ - type: "Microsoft.Storage/DocumentDB"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties that are associated with a DocumentDB output.␊ - */␊ - export interface DocumentDbOutputDataSourceProperties {␊ - /**␊ - * The DocumentDB account name or ID. Required on PUT (CreateOrReplace) requests.␊ - */␊ - accountId?: string␊ - /**␊ - * The account key for the DocumentDB account. Required on PUT (CreateOrReplace) requests.␊ - */␊ - accountKey?: string␊ - /**␊ - * The collection name pattern for the collections to be used. The collection name format can be constructed using the optional {partition} token, where partitions start from 0. See the DocumentDB section of https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output for more information. Required on PUT (CreateOrReplace) requests.␊ - */␊ - collectionNamePattern?: string␊ - /**␊ - * The name of the DocumentDB database. Required on PUT (CreateOrReplace) requests.␊ - */␊ - database?: string␊ - /**␊ - * The name of the field in output events used to specify the primary key which insert or update operations are based on.␊ - */␊ - documentId?: string␊ - /**␊ - * The name of the field in output events used to specify the key for partitioning output across collections. If 'collectionNamePattern' contains the {partition} token, this property is required to be specified.␊ - */␊ - partitionKey?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a Service Bus Queue output data source.␊ - */␊ - export interface ServiceBusQueueOutputDataSource {␊ - /**␊ - * The properties that are associated with a Service Bus Queue output.␊ - */␊ - properties?: (ServiceBusQueueOutputDataSourceProperties | string)␊ - type: "Microsoft.ServiceBus/Queue"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties that are associated with a Service Bus Queue output.␊ - */␊ - export interface ServiceBusQueueOutputDataSourceProperties {␊ - /**␊ - * A string array of the names of output columns to be attached to Service Bus messages as custom properties.␊ - */␊ - propertyColumns?: (string[] | string)␊ - /**␊ - * The name of the Service Bus Queue. Required on PUT (CreateOrReplace) requests.␊ - */␊ - queueName?: string␊ - /**␊ - * The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests.␊ - */␊ - serviceBusNamespace?: string␊ - /**␊ - * The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests.␊ - */␊ - sharedAccessPolicyKey?: string␊ - /**␊ - * The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests.␊ - */␊ - sharedAccessPolicyName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a Service Bus Topic output data source.␊ - */␊ - export interface ServiceBusTopicOutputDataSource {␊ - /**␊ - * The properties that are associated with a Service Bus Topic output.␊ - */␊ - properties?: (ServiceBusTopicOutputDataSourceProperties | string)␊ - type: "Microsoft.ServiceBus/Topic"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties that are associated with a Service Bus Topic output.␊ - */␊ - export interface ServiceBusTopicOutputDataSourceProperties {␊ - /**␊ - * A string array of the names of output columns to be attached to Service Bus messages as custom properties.␊ - */␊ - propertyColumns?: (string[] | string)␊ - /**␊ - * The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests.␊ - */␊ - serviceBusNamespace?: string␊ - /**␊ - * The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests.␊ - */␊ - sharedAccessPolicyKey?: string␊ - /**␊ - * The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests.␊ - */␊ - sharedAccessPolicyName?: string␊ - /**␊ - * The name of the Service Bus Topic. Required on PUT (CreateOrReplace) requests.␊ - */␊ - topicName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a Power BI output data source.␊ - */␊ - export interface PowerBIOutputDataSource {␊ - /**␊ - * The properties that are associated with a Power BI output.␊ - */␊ - properties?: (PowerBIOutputDataSourceProperties | string)␊ - type: "PowerBI"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties that are associated with a Power BI output.␊ - */␊ - export interface PowerBIOutputDataSourceProperties {␊ - /**␊ - * The name of the Power BI dataset. Required on PUT (CreateOrReplace) requests.␊ - */␊ - dataset?: string␊ - /**␊ - * The ID of the Power BI group.␊ - */␊ - groupId?: string␊ - /**␊ - * The name of the Power BI group. Use this property to help remember which specific Power BI group id was used.␊ - */␊ - groupName?: string␊ - /**␊ - * A refresh token that can be used to obtain a valid access token that can then be used to authenticate with the data source. A valid refresh token is currently only obtainable via the Azure Portal. It is recommended to put a dummy string value here when creating the data source and then going to the Azure Portal to authenticate the data source which will update this property with a valid refresh token. Required on PUT (CreateOrReplace) requests.␊ - */␊ - refreshToken?: string␊ - /**␊ - * The name of the Power BI table under the specified dataset. Required on PUT (CreateOrReplace) requests.␊ - */␊ - table?: string␊ - /**␊ - * The user display name of the user that was used to obtain the refresh token. Use this property to help remember which user was used to obtain the refresh token.␊ - */␊ - tokenUserDisplayName?: string␊ - /**␊ - * The user principal name (UPN) of the user that was used to obtain the refresh token. Use this property to help remember which user was used to obtain the refresh token.␊ - */␊ - tokenUserPrincipalName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes an Azure Data Lake Store output data source.␊ - */␊ - export interface AzureDataLakeStoreOutputDataSource {␊ - /**␊ - * The properties that are associated with an Azure Data Lake Store.␊ - */␊ - properties?: (AzureDataLakeStoreOutputDataSourceProperties | string)␊ - type: "Microsoft.DataLake/Accounts"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties that are associated with an Azure Data Lake Store.␊ - */␊ - export interface AzureDataLakeStoreOutputDataSourceProperties {␊ - /**␊ - * The name of the Azure Data Lake Store account. Required on PUT (CreateOrReplace) requests.␊ - */␊ - accountName?: string␊ - /**␊ - * The date format. Wherever {date} appears in filePathPrefix, the value of this property is used as the date format instead.␊ - */␊ - dateFormat?: string␊ - /**␊ - * The location of the file to which the output should be written to. Required on PUT (CreateOrReplace) requests.␊ - */␊ - filePathPrefix?: string␊ - /**␊ - * A refresh token that can be used to obtain a valid access token that can then be used to authenticate with the data source. A valid refresh token is currently only obtainable via the Azure Portal. It is recommended to put a dummy string value here when creating the data source and then going to the Azure Portal to authenticate the data source which will update this property with a valid refresh token. Required on PUT (CreateOrReplace) requests.␊ - */␊ - refreshToken?: string␊ - /**␊ - * The tenant id of the user used to obtain the refresh token. Required on PUT (CreateOrReplace) requests.␊ - */␊ - tenantId?: string␊ - /**␊ - * The time format. Wherever {time} appears in filePathPrefix, the value of this property is used as the time format instead.␊ - */␊ - timeFormat?: string␊ - /**␊ - * The user display name of the user that was used to obtain the refresh token. Use this property to help remember which user was used to obtain the refresh token.␊ - */␊ - tokenUserDisplayName?: string␊ - /**␊ - * The user principal name (UPN) of the user that was used to obtain the refresh token. Use this property to help remember which user was used to obtain the refresh token.␊ - */␊ - tokenUserPrincipalName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties that are associated with a SKU.␊ - */␊ - export interface Sku43 {␊ - /**␊ - * The name of the SKU. Required on PUT (CreateOrReplace) requests.␊ - */␊ - name?: ("Standard" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A transformation object, containing all information associated with the named transformation. All transformations are contained under a streaming job.␊ - */␊ - export interface Transformation {␊ - /**␊ - * Resource name␊ - */␊ - name?: string␊ - /**␊ - * The properties that are associated with a transformation.␊ - */␊ - properties?: (TransformationProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties that are associated with a transformation.␊ - */␊ - export interface TransformationProperties {␊ - /**␊ - * Specifies the query that will be run in the streaming job. You can learn more about the Stream Analytics Query Language (SAQL) here: https://msdn.microsoft.com/library/azure/dn834998 . Required on PUT (CreateOrReplace) requests.␊ - */␊ - query?: string␊ - /**␊ - * Specifies the number of streaming units that the streaming job uses.␊ - */␊ - streamingUnits?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.StreamAnalytics/streamingjobs/inputs␊ - */␊ - export interface StreamingjobsInputsChildResource {␊ - apiVersion: "2016-03-01"␊ - /**␊ - * The name of the input.␊ - */␊ - name: string␊ - /**␊ - * The properties that are associated with an input.␊ - */␊ - properties: ((StreamInputProperties | ReferenceInputProperties) | string)␊ - type: "inputs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.StreamAnalytics/streamingjobs/outputs␊ - */␊ - export interface StreamingjobsOutputsChildResource {␊ - apiVersion: "2016-03-01"␊ - /**␊ - * The name of the output.␊ - */␊ - name: string␊ - /**␊ - * The properties that are associated with an output.␊ - */␊ - properties: (OutputProperties | string)␊ - type: "outputs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.StreamAnalytics/streamingjobs/transformations␊ - */␊ - export interface StreamingjobsTransformationsChildResource {␊ - apiVersion: "2016-03-01"␊ - /**␊ - * The name of the transformation.␊ - */␊ - name: string␊ - /**␊ - * The properties that are associated with a transformation.␊ - */␊ - properties: (TransformationProperties | string)␊ - type: "transformations"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.StreamAnalytics/streamingjobs/functions␊ - */␊ - export interface StreamingjobsFunctionsChildResource {␊ - apiVersion: "2016-03-01"␊ - /**␊ - * The name of the function.␊ - */␊ - name: string␊ - /**␊ - * The properties that are associated with a function.␊ - */␊ - properties: (ScalarFunctionProperties | string)␊ - type: "functions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.StreamAnalytics/streamingjobs/functions␊ - */␊ - export interface StreamingjobsFunctions {␊ - apiVersion: "2016-03-01"␊ - /**␊ - * The name of the function.␊ - */␊ - name: string␊ - /**␊ - * The properties that are associated with a function.␊ - */␊ - properties: (ScalarFunctionProperties | string)␊ - type: "Microsoft.StreamAnalytics/streamingjobs/functions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.StreamAnalytics/streamingjobs/inputs␊ - */␊ - export interface StreamingjobsInputs {␊ - apiVersion: "2016-03-01"␊ - /**␊ - * The name of the input.␊ - */␊ - name: string␊ - /**␊ - * The properties that are associated with an input.␊ - */␊ - properties: ((StreamInputProperties | ReferenceInputProperties) | string)␊ - type: "Microsoft.StreamAnalytics/streamingjobs/inputs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.StreamAnalytics/streamingjobs/outputs␊ - */␊ - export interface StreamingjobsOutputs {␊ - apiVersion: "2016-03-01"␊ - /**␊ - * The name of the output.␊ - */␊ - name: string␊ - /**␊ - * The properties that are associated with an output.␊ - */␊ - properties: (OutputProperties | string)␊ - type: "Microsoft.StreamAnalytics/streamingjobs/outputs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.StreamAnalytics/streamingjobs/transformations␊ - */␊ - export interface StreamingjobsTransformations {␊ - apiVersion: "2016-03-01"␊ - /**␊ - * The name of the transformation.␊ - */␊ - name: string␊ - /**␊ - * The properties that are associated with a transformation.␊ - */␊ - properties: (TransformationProperties | string)␊ - type: "Microsoft.StreamAnalytics/streamingjobs/transformations"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.TimeSeriesInsights/environments␊ - */␊ - export interface Environments {␊ - apiVersion: "2017-11-15"␊ - /**␊ - * The location of the resource.␊ - */␊ - location: string␊ - /**␊ - * Name of the environment␊ - */␊ - name: string␊ - /**␊ - * Properties used to create an environment.␊ - */␊ - properties: (EnvironmentCreationProperties | string)␊ - resources?: (EnvironmentsEventSourcesChildResource | EnvironmentsReferenceDataSetsChildResource | EnvironmentsAccessPoliciesChildResource)[]␊ - /**␊ - * The sku determines the capacity of the environment, the SLA (in queries-per-minute and total capacity), and the billing rate.␊ - */␊ - sku: (Sku44 | string)␊ - /**␊ - * Key-value pairs of additional properties for the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.TimeSeriesInsights/environments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties used to create an environment.␊ - */␊ - export interface EnvironmentCreationProperties {␊ - /**␊ - * ISO8601 timespan specifying the minimum number of days the environment's events will be available for query.␊ - */␊ - dataRetentionTime: string␊ - /**␊ - * The list of partition keys according to which the data in the environment will be ordered.␊ - */␊ - partitionKeyProperties?: (PartitionKeyProperty[] | string)␊ - /**␊ - * The behavior the Time Series Insights service should take when the environment's capacity has been exceeded. If "PauseIngress" is specified, new events will not be read from the event source. If "PurgeOldData" is specified, new events will continue to be read and old events will be deleted from the environment. The default behavior is PurgeOldData.␊ - */␊ - storageLimitExceededBehavior?: (("PurgeOldData" | "PauseIngress") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The structure of the property that a partition key can have. An environment can have multiple such properties.␊ - */␊ - export interface PartitionKeyProperty {␊ - /**␊ - * The name of the property.␊ - */␊ - name?: string␊ - /**␊ - * The type of the property.␊ - */␊ - type?: ("String" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters supplied to the Create or Update Event Source operation for an EventHub event source.␊ - */␊ - export interface EventHubEventSourceCreateOrUpdateParameters {␊ - kind: "Microsoft.EventHub"␊ - /**␊ - * Properties of the EventHub event source that are required on create or update requests.␊ - */␊ - properties: (EventHubEventSourceCreationProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the EventHub event source that are required on create or update requests.␊ - */␊ - export interface EventHubEventSourceCreationProperties {␊ - /**␊ - * The name of the event hub's consumer group that holds the partitions from which events will be read.␊ - */␊ - consumerGroupName: string␊ - /**␊ - * The name of the event hub.␊ - */␊ - eventHubName: string␊ - /**␊ - * The resource id of the event source in Azure Resource Manager.␊ - */␊ - eventSourceResourceId: string␊ - /**␊ - * The name of the SAS key that grants the Time Series Insights service access to the event hub. The shared access policies for this key must grant 'Listen' permissions to the event hub.␊ - */␊ - keyName: string␊ - /**␊ - * Provisioning state of the resource.␊ - */␊ - provisioningState?: (("Accepted" | "Creating" | "Updating" | "Succeeded" | "Failed" | "Deleting") | string)␊ - /**␊ - * The name of the service bus that contains the event hub.␊ - */␊ - serviceBusNamespace: string␊ - /**␊ - * The value of the shared access key that grants the Time Series Insights service read access to the event hub. This property is not shown in event source responses.␊ - */␊ - sharedAccessKey: string␊ - /**␊ - * The event property that will be used as the event source's timestamp. If a value isn't specified for timestampPropertyName, or if null or empty-string is specified, the event creation time will be used.␊ - */␊ - timestampPropertyName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters supplied to the Create or Update Event Source operation for an IoTHub event source.␊ - */␊ - export interface IoTHubEventSourceCreateOrUpdateParameters {␊ - kind: "Microsoft.IoTHub"␊ - /**␊ - * Properties of the IoTHub event source that are required on create or update requests.␊ - */␊ - properties: (IoTHubEventSourceCreationProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the IoTHub event source that are required on create or update requests.␊ - */␊ - export interface IoTHubEventSourceCreationProperties {␊ - /**␊ - * The name of the iot hub's consumer group that holds the partitions from which events will be read.␊ - */␊ - consumerGroupName: string␊ - /**␊ - * The resource id of the event source in Azure Resource Manager.␊ - */␊ - eventSourceResourceId: string␊ - /**␊ - * The name of the iot hub.␊ - */␊ - iotHubName: string␊ - /**␊ - * The name of the Shared Access Policy key that grants the Time Series Insights service access to the iot hub. This shared access policy key must grant 'service connect' permissions to the iot hub.␊ - */␊ - keyName: string␊ - /**␊ - * Provisioning state of the resource.␊ - */␊ - provisioningState?: (("Accepted" | "Creating" | "Updating" | "Succeeded" | "Failed" | "Deleting") | string)␊ - /**␊ - * The value of the Shared Access Policy key that grants the Time Series Insights service read access to the iot hub. This property is not shown in event source responses.␊ - */␊ - sharedAccessKey: string␊ - /**␊ - * The event property that will be used as the event source's timestamp. If a value isn't specified for timestampPropertyName, or if null or empty-string is specified, the event creation time will be used.␊ - */␊ - timestampPropertyName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.TimeSeriesInsights/environments/referenceDataSets␊ - */␊ - export interface EnvironmentsReferenceDataSetsChildResource {␊ - apiVersion: "2017-11-15"␊ - /**␊ - * The location of the resource.␊ - */␊ - location: string␊ - /**␊ - * Name of the reference data set.␊ - */␊ - name: string␊ - /**␊ - * Properties used to create a reference data set.␊ - */␊ - properties: (ReferenceDataSetCreationProperties | string)␊ - /**␊ - * Key-value pairs of additional properties for the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "referenceDataSets"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties used to create a reference data set.␊ - */␊ - export interface ReferenceDataSetCreationProperties {␊ - /**␊ - * The reference data set key comparison behavior can be set using this property. By default, the value is 'Ordinal' - which means case sensitive key comparison will be performed while joining reference data with events or while adding new reference data. When 'OrdinalIgnoreCase' is set, case insensitive comparison will be used.␊ - */␊ - dataStringComparisonBehavior?: (("Ordinal" | "OrdinalIgnoreCase") | string)␊ - /**␊ - * The list of key properties for the reference data set.␊ - */␊ - keyProperties: (ReferenceDataSetKeyProperty[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A key property for the reference data set. A reference data set can have multiple key properties.␊ - */␊ - export interface ReferenceDataSetKeyProperty {␊ - /**␊ - * The name of the key property.␊ - */␊ - name?: string␊ - /**␊ - * The type of the key property.␊ - */␊ - type?: (("String" | "Double" | "Bool" | "DateTime") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.TimeSeriesInsights/environments/accessPolicies␊ - */␊ - export interface EnvironmentsAccessPoliciesChildResource {␊ - apiVersion: "2017-11-15"␊ - /**␊ - * Name of the access policy.␊ - */␊ - name: string␊ - properties: (AccessPolicyResourceProperties | string)␊ - type: "accessPolicies"␊ - [k: string]: unknown␊ - }␊ - export interface AccessPolicyResourceProperties {␊ - /**␊ - * An description of the access policy.␊ - */␊ - description?: string␊ - /**␊ - * The objectId of the principal in Azure Active Directory.␊ - */␊ - principalObjectId?: string␊ - /**␊ - * The list of roles the principal is assigned on the environment.␊ - */␊ - roles?: (("Reader" | "Contributor")[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The sku determines the capacity of the environment, the SLA (in queries-per-minute and total capacity), and the billing rate.␊ - */␊ - export interface Sku44 {␊ - /**␊ - * The capacity of the sku. This value can be changed to support scale out of environments after they have been created.␊ - */␊ - capacity: (number | string)␊ - /**␊ - * The name of this SKU.␊ - */␊ - name: (("S1" | "S2") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.TimeSeriesInsights/environments/referenceDataSets␊ - */␊ - export interface EnvironmentsReferenceDataSets {␊ - apiVersion: "2017-11-15"␊ - /**␊ - * The location of the resource.␊ - */␊ - location: string␊ - /**␊ - * Name of the reference data set.␊ - */␊ - name: string␊ - /**␊ - * Properties used to create a reference data set.␊ - */␊ - properties: (ReferenceDataSetCreationProperties | string)␊ - /**␊ - * Key-value pairs of additional properties for the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.TimeSeriesInsights/environments/referenceDataSets"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.TimeSeriesInsights/environments/accessPolicies␊ - */␊ - export interface EnvironmentsAccessPolicies {␊ - apiVersion: "2017-11-15"␊ - /**␊ - * Name of the access policy.␊ - */␊ - name: string␊ - properties: (AccessPolicyResourceProperties | string)␊ - type: "Microsoft.TimeSeriesInsights/environments/accessPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An object that represents the local timestamp property. It contains the format of local timestamp that needs to be used and the corresponding timezone offset information. If a value isn't specified for localTimestamp, or if null, then the local timestamp will not be ingressed with the events.␊ - */␊ - export interface LocalTimestamp {␊ - /**␊ - * An enum that represents the format of the local timestamp property that needs to be set.␊ - */␊ - format?: ("Embedded" | string)␊ - /**␊ - * An object that represents the offset information for the local timestamp format specified. Should not be specified for LocalTimestampFormat - Embedded.␊ - */␊ - timeZoneOffset?: (LocalTimestampTimeZoneOffset | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An object that represents the offset information for the local timestamp format specified. Should not be specified for LocalTimestampFormat - Embedded.␊ - */␊ - export interface LocalTimestampTimeZoneOffset {␊ - /**␊ - * The event property that will be contain the offset information to calculate the local timestamp. When the LocalTimestampFormat is Iana, the property name will contain the name of the column which contains IANA Timezone Name (eg: Americas/Los Angeles). When LocalTimestampFormat is Timespan, it contains the name of property which contains values representing the offset (eg: P1D or 1.00:00:00)␊ - */␊ - propertyName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters supplied to the Create or Update Event Source operation for an EventHub event source.␊ - */␊ - export interface EventHubEventSourceCreateOrUpdateParameters1 {␊ - kind: "Microsoft.EventHub"␊ - /**␊ - * Properties of the EventHub event source that are required on create or update requests.␊ - */␊ - properties: (EventHubEventSourceCreationProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the EventHub event source that are required on create or update requests.␊ - */␊ - export interface EventHubEventSourceCreationProperties1 {␊ - /**␊ - * The name of the event hub's consumer group that holds the partitions from which events will be read.␊ - */␊ - consumerGroupName: string␊ - /**␊ - * The name of the event hub.␊ - */␊ - eventHubName: string␊ - /**␊ - * The resource id of the event source in Azure Resource Manager.␊ - */␊ - eventSourceResourceId: string␊ - /**␊ - * The name of the SAS key that grants the Time Series Insights service access to the event hub. The shared access policies for this key must grant 'Listen' permissions to the event hub.␊ - */␊ - keyName: string␊ - /**␊ - * Provisioning state of the resource.␊ - */␊ - provisioningState?: (("Accepted" | "Creating" | "Updating" | "Succeeded" | "Failed" | "Deleting") | string)␊ - /**␊ - * The name of the service bus that contains the event hub.␊ - */␊ - serviceBusNamespace: string␊ - /**␊ - * The value of the shared access key that grants the Time Series Insights service read access to the event hub. This property is not shown in event source responses.␊ - */␊ - sharedAccessKey: string␊ - /**␊ - * The event property that will be used as the event source's timestamp. If a value isn't specified for timestampPropertyName, or if null or empty-string is specified, the event creation time will be used.␊ - */␊ - timestampPropertyName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters supplied to the Create or Update Event Source operation for an IoTHub event source.␊ - */␊ - export interface IoTHubEventSourceCreateOrUpdateParameters1 {␊ - kind: "Microsoft.IoTHub"␊ - /**␊ - * Properties of the IoTHub event source that are required on create or update requests.␊ - */␊ - properties: (IoTHubEventSourceCreationProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the IoTHub event source that are required on create or update requests.␊ - */␊ - export interface IoTHubEventSourceCreationProperties1 {␊ - /**␊ - * The name of the iot hub's consumer group that holds the partitions from which events will be read.␊ - */␊ - consumerGroupName: string␊ - /**␊ - * The resource id of the event source in Azure Resource Manager.␊ - */␊ - eventSourceResourceId: string␊ - /**␊ - * The name of the iot hub.␊ - */␊ - iotHubName: string␊ - /**␊ - * The name of the Shared Access Policy key that grants the Time Series Insights service access to the iot hub. This shared access policy key must grant 'service connect' permissions to the iot hub.␊ - */␊ - keyName: string␊ - /**␊ - * Provisioning state of the resource.␊ - */␊ - provisioningState?: (("Accepted" | "Creating" | "Updating" | "Succeeded" | "Failed" | "Deleting") | string)␊ - /**␊ - * The value of the Shared Access Policy key that grants the Time Series Insights service read access to the iot hub. This property is not shown in event source responses.␊ - */␊ - sharedAccessKey: string␊ - /**␊ - * The event property that will be used as the event source's timestamp. If a value isn't specified for timestampPropertyName, or if null or empty-string is specified, the event creation time will be used.␊ - */␊ - timestampPropertyName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.TimeSeriesInsights/environments/referenceDataSets␊ - */␊ - export interface EnvironmentsReferenceDataSetsChildResource1 {␊ - apiVersion: "2018-08-15-preview"␊ - /**␊ - * The location of the resource.␊ - */␊ - location: string␊ - /**␊ - * Name of the reference data set.␊ - */␊ - name: string␊ - /**␊ - * Properties used to create a reference data set.␊ - */␊ - properties: (ReferenceDataSetCreationProperties1 | string)␊ - /**␊ - * Key-value pairs of additional properties for the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "referenceDataSets"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties used to create a reference data set.␊ - */␊ - export interface ReferenceDataSetCreationProperties1 {␊ - /**␊ - * The reference data set key comparison behavior can be set using this property. By default, the value is 'Ordinal' - which means case sensitive key comparison will be performed while joining reference data with events or while adding new reference data. When 'OrdinalIgnoreCase' is set, case insensitive comparison will be used.␊ - */␊ - dataStringComparisonBehavior?: (("Ordinal" | "OrdinalIgnoreCase") | string)␊ - /**␊ - * The list of key properties for the reference data set.␊ - */␊ - keyProperties: (ReferenceDataSetKeyProperty1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A key property for the reference data set. A reference data set can have multiple key properties.␊ - */␊ - export interface ReferenceDataSetKeyProperty1 {␊ - /**␊ - * The name of the key property.␊ - */␊ - name?: string␊ - /**␊ - * The type of the key property.␊ - */␊ - type?: (("String" | "Double" | "Bool" | "DateTime") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.TimeSeriesInsights/environments/accessPolicies␊ - */␊ - export interface EnvironmentsAccessPoliciesChildResource1 {␊ - apiVersion: "2018-08-15-preview"␊ - /**␊ - * Name of the access policy.␊ - */␊ - name: string␊ - properties: (AccessPolicyResourceProperties1 | string)␊ - type: "accessPolicies"␊ - [k: string]: unknown␊ - }␊ - export interface AccessPolicyResourceProperties1 {␊ - /**␊ - * An description of the access policy.␊ - */␊ - description?: string␊ - /**␊ - * The objectId of the principal in Azure Active Directory.␊ - */␊ - principalObjectId?: string␊ - /**␊ - * The list of roles the principal is assigned on the environment.␊ - */␊ - roles?: (("Reader" | "Contributor")[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The sku determines the type of environment, either standard (S1 or S2) or long-term (L1). For standard environments the sku determines the capacity of the environment, the ingress rate, and the billing rate.␊ - */␊ - export interface Sku45 {␊ - /**␊ - * The capacity of the sku. For standard environments, this value can be changed to support scale out of environments after they have been created.␊ - */␊ - capacity: (number | string)␊ - /**␊ - * The name of this SKU.␊ - */␊ - name: (("S1" | "S2" | "P1" | "L1") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters supplied to the Create or Update Environment operation for a standard environment.␊ - */␊ - export interface StandardEnvironmentCreateOrUpdateParameters {␊ - kind: "Standard"␊ - /**␊ - * Properties used to create a standard environment.␊ - */␊ - properties: (StandardEnvironmentCreationProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties used to create a standard environment.␊ - */␊ - export interface StandardEnvironmentCreationProperties {␊ - /**␊ - * ISO8601 timespan specifying the minimum number of days the environment's events will be available for query.␊ - */␊ - dataRetentionTime: string␊ - /**␊ - * The list of event properties which will be used to partition data in the environment. Currently, only a single partition key property is supported.␊ - */␊ - partitionKeyProperties?: (TimeSeriesIdProperty[] | string)␊ - /**␊ - * The behavior the Time Series Insights service should take when the environment's capacity has been exceeded. If "PauseIngress" is specified, new events will not be read from the event source. If "PurgeOldData" is specified, new events will continue to be read and old events will be deleted from the environment. The default behavior is PurgeOldData.␊ - */␊ - storageLimitExceededBehavior?: (("PurgeOldData" | "PauseIngress") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The structure of the property that a time series id can have. An environment can have multiple such properties.␊ - */␊ - export interface TimeSeriesIdProperty {␊ - /**␊ - * The name of the property.␊ - */␊ - name?: string␊ - /**␊ - * The type of the property.␊ - */␊ - type?: ("String" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters supplied to the Create or Update Environment operation for a long-term environment.␊ - */␊ - export interface LongTermEnvironmentCreateOrUpdateParameters {␊ - kind: "LongTerm"␊ - /**␊ - * Properties used to create a long-term environment.␊ - */␊ - properties: (LongTermEnvironmentCreationProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties used to create a long-term environment.␊ - */␊ - export interface LongTermEnvironmentCreationProperties {␊ - /**␊ - * The storage configuration provides the connection details that allows the Time Series Insights service to connect to the customer storage account that is used to store the environment's data.␊ - */␊ - storageConfiguration: (LongTermStorageConfigurationInput | string)␊ - /**␊ - * The list of event properties which will be used to define the environment's time series id.␊ - */␊ - timeSeriesIdProperties: (TimeSeriesIdProperty[] | string)␊ - /**␊ - * The warm store configuration provides the details to create a warm store cache that will retain a copy of the environment's data available for faster query.␊ - */␊ - warmStoreConfiguration?: (WarmStoreConfigurationProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The storage configuration provides the connection details that allows the Time Series Insights service to connect to the customer storage account that is used to store the environment's data.␊ - */␊ - export interface LongTermStorageConfigurationInput {␊ - /**␊ - * The name of the storage account that will hold the environment's long term data.␊ - */␊ - accountName: string␊ - /**␊ - * The value of the management key that grants the Time Series Insights service write access to the storage account. This property is not shown in environment responses.␊ - */␊ - managementKey: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The warm store configuration provides the details to create a warm store cache that will retain a copy of the environment's data available for faster query.␊ - */␊ - export interface WarmStoreConfigurationProperties {␊ - /**␊ - * ISO8601 timespan specifying the number of days the environment's events will be available for query from the warm store.␊ - */␊ - dataRetention: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.TimeSeriesInsights/environments/referenceDataSets␊ - */␊ - export interface EnvironmentsReferenceDataSets1 {␊ - apiVersion: "2018-08-15-preview"␊ - /**␊ - * The location of the resource.␊ - */␊ - location: string␊ - /**␊ - * Name of the reference data set.␊ - */␊ - name: string␊ - /**␊ - * Properties used to create a reference data set.␊ - */␊ - properties: (ReferenceDataSetCreationProperties1 | string)␊ - /**␊ - * Key-value pairs of additional properties for the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.TimeSeriesInsights/environments/referenceDataSets"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.TimeSeriesInsights/environments/accessPolicies␊ - */␊ - export interface EnvironmentsAccessPolicies1 {␊ - apiVersion: "2018-08-15-preview"␊ - /**␊ - * Name of the access policy.␊ - */␊ - name: string␊ - properties: (AccessPolicyResourceProperties1 | string)␊ - type: "Microsoft.TimeSeriesInsights/environments/accessPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.MachineLearningServices/workspaces/computes␊ - */␊ - export interface WorkspacesComputes1 {␊ - apiVersion: "2018-03-01-preview"␊ - /**␊ - * Identity for the resource.␊ - */␊ - identity?: (Identity16 | string)␊ - /**␊ - * Specifies the location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * Name of the Azure Machine Learning compute.␊ - */␊ - name: string␊ - /**␊ - * Machine Learning compute object.␊ - */␊ - properties: ((AKS1 | BatchAI | VirtualMachine1 | HDInsight1 | DataFactory1) | string)␊ - /**␊ - * Contains resource tags defined as key/value pairs.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.MachineLearningServices/workspaces/computes"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.MachineLearningServices/workspaces␊ - */␊ - export interface Workspaces4 {␊ - apiVersion: "2019-05-01"␊ - /**␊ - * Identity for the resource.␊ - */␊ - identity?: (Identity18 | string)␊ - /**␊ - * Specifies the location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * Name of Azure Machine Learning workspace.␊ - */␊ - name: string␊ - /**␊ - * The properties of a machine learning workspace.␊ - */␊ - properties: (WorkspaceProperties5 | string)␊ - resources?: WorkspacesComputesChildResource2[]␊ - /**␊ - * Contains resource tags defined as key/value pairs.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.MachineLearningServices/workspaces"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the resource.␊ - */␊ - export interface Identity18 {␊ - /**␊ - * The identity type.␊ - */␊ - type?: ("SystemAssigned" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a machine learning workspace.␊ - */␊ - export interface WorkspaceProperties5 {␊ - /**␊ - * ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created␊ - */␊ - applicationInsights?: string␊ - /**␊ - * ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created␊ - */␊ - containerRegistry?: string␊ - /**␊ - * The description of this workspace.␊ - */␊ - description?: string␊ - /**␊ - * Url for the discovery service to identify regional endpoints for machine learning experimentation services␊ - */␊ - discoveryUrl?: string␊ - /**␊ - * The friendly name for this workspace. This name in mutable␊ - */␊ - friendlyName?: string␊ - /**␊ - * ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created␊ - */␊ - keyVault?: string␊ - /**␊ - * ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created␊ - */␊ - storageAccount?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.MachineLearningServices/workspaces/computes␊ - */␊ - export interface WorkspacesComputesChildResource2 {␊ - apiVersion: "2019-05-01"␊ - /**␊ - * Identity for the resource.␊ - */␊ - identity?: (Identity18 | string)␊ - /**␊ - * Specifies the location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * Name of the Azure Machine Learning compute.␊ - */␊ - name: string␊ - /**␊ - * Machine Learning compute object.␊ - */␊ - properties: (Compute2 | string)␊ - /**␊ - * Contains resource tags defined as key/value pairs.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "computes"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A Machine Learning compute based on AKS.␊ - */␊ - export interface AKS2 {␊ - computeType: "AKS"␊ - /**␊ - * AKS properties␊ - */␊ - properties?: (AKSProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AKS properties␊ - */␊ - export interface AKSProperties2 {␊ - /**␊ - * Number of agents␊ - */␊ - agentCount?: (number | string)␊ - /**␊ - * Agent virtual machine size␊ - */␊ - agentVMSize?: string␊ - /**␊ - * Advance configuration for AKS networking␊ - */␊ - aksNetworkingConfiguration?: (AksNetworkingConfiguration1 | string)␊ - /**␊ - * Cluster full qualified domain name␊ - */␊ - clusterFqdn?: string␊ - /**␊ - * The ssl configuration for scoring␊ - */␊ - sslConfiguration?: (SslConfiguration2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Advance configuration for AKS networking␊ - */␊ - export interface AksNetworkingConfiguration1 {␊ - /**␊ - * An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr.␊ - */␊ - dnsServiceIP?: string␊ - /**␊ - * A CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the Kubernetes service address range.␊ - */␊ - dockerBridgeCidr?: string␊ - /**␊ - * A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges.␊ - */␊ - serviceCidr?: string␊ - /**␊ - * Virtual network subnet resource ID the compute nodes belong to␊ - */␊ - subnetId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The ssl configuration for scoring␊ - */␊ - export interface SslConfiguration2 {␊ - /**␊ - * Cert data␊ - */␊ - cert?: string␊ - /**␊ - * CNAME of the cert␊ - */␊ - cname?: string␊ - /**␊ - * Key data␊ - */␊ - key?: string␊ - /**␊ - * Enable or disable ssl for scoring.␊ - */␊ - status?: (("Disabled" | "Enabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An Azure Machine Learning compute.␊ - */␊ - export interface AmlCompute1 {␊ - computeType: "AmlCompute"␊ - /**␊ - * AML Compute properties␊ - */␊ - properties?: (AmlComputeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AML Compute properties␊ - */␊ - export interface AmlComputeProperties1 {␊ - /**␊ - * scale settings for AML Compute␊ - */␊ - scaleSettings?: (ScaleSettings3 | string)␊ - /**␊ - * Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet.␊ - */␊ - subnet?: (ResourceId1 | string)␊ - /**␊ - * Settings for user account that gets created on each on the nodes of a compute.␊ - */␊ - userAccountCredentials?: (UserAccountCredentials1 | string)␊ - /**␊ - * Virtual Machine priority.␊ - */␊ - vmPriority?: (("Dedicated" | "LowPriority") | string)␊ - /**␊ - * Virtual Machine Size␊ - */␊ - vmSize?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * scale settings for AML Compute␊ - */␊ - export interface ScaleSettings3 {␊ - /**␊ - * Max number of nodes to use␊ - */␊ - maxNodeCount: (number | string)␊ - /**␊ - * Min number of nodes to use␊ - */␊ - minNodeCount?: ((number & string) | string)␊ - /**␊ - * Node Idle Time before scaling down amlCompute␊ - */␊ - nodeIdleTimeBeforeScaleDown?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet.␊ - */␊ - export interface ResourceId1 {␊ - /**␊ - * The ID of the resource␊ - */␊ - id: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Settings for user account that gets created on each on the nodes of a compute.␊ - */␊ - export interface UserAccountCredentials1 {␊ - /**␊ - * Name of the administrator user account which can be used to SSH to nodes.␊ - */␊ - adminUserName: string␊ - /**␊ - * Password of the administrator user account.␊ - */␊ - adminUserPassword?: string␊ - /**␊ - * SSH public key of the administrator user account.␊ - */␊ - adminUserSshPublicKey?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A Machine Learning compute based on Azure Virtual Machines.␊ - */␊ - export interface VirtualMachine2 {␊ - computeType: "VirtualMachine"␊ - properties?: (VirtualMachineProperties5 | string)␊ - [k: string]: unknown␊ - }␊ - export interface VirtualMachineProperties5 {␊ - /**␊ - * Public IP address of the virtual machine.␊ - */␊ - address?: string␊ - /**␊ - * Admin credentials for virtual machine␊ - */␊ - administratorAccount?: (VirtualMachineSshCredentials2 | string)␊ - /**␊ - * Port open for ssh connections.␊ - */␊ - sshPort?: (number | string)␊ - /**␊ - * Virtual Machine size␊ - */␊ - virtualMachineSize?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Admin credentials for virtual machine␊ - */␊ - export interface VirtualMachineSshCredentials2 {␊ - /**␊ - * Password of admin account␊ - */␊ - password?: string␊ - /**␊ - * Private key data␊ - */␊ - privateKeyData?: string␊ - /**␊ - * Public key data␊ - */␊ - publicKeyData?: string␊ - /**␊ - * Username of admin account␊ - */␊ - username?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A HDInsight compute.␊ - */␊ - export interface HDInsight2 {␊ - computeType: "HDInsight"␊ - properties?: (HDInsightProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - export interface HDInsightProperties2 {␊ - /**␊ - * Public IP address of the master node of the cluster.␊ - */␊ - address?: string␊ - /**␊ - * Admin credentials for virtual machine␊ - */␊ - administratorAccount?: (VirtualMachineSshCredentials2 | string)␊ - /**␊ - * Port open for ssh connections on the master node of the cluster.␊ - */␊ - sshPort?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A DataFactory compute.␊ - */␊ - export interface DataFactory2 {␊ - computeType: "DataFactory"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A DataFactory compute.␊ - */␊ - export interface Databricks1 {␊ - computeType: "Databricks"␊ - properties?: (DatabricksProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - export interface DatabricksProperties1 {␊ - /**␊ - * Databricks access token␊ - */␊ - databricksAccessToken?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A DataLakeAnalytics compute.␊ - */␊ - export interface DataLakeAnalytics1 {␊ - computeType: "DataLakeAnalytics"␊ - properties?: (DataLakeAnalyticsProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - export interface DataLakeAnalyticsProperties1 {␊ - /**␊ - * DataLake Store Account Name␊ - */␊ - dataLakeStoreAccountName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.MachineLearningServices/workspaces/computes␊ - */␊ - export interface WorkspacesComputes2 {␊ - apiVersion: "2019-05-01"␊ - /**␊ - * Identity for the resource.␊ - */␊ - identity?: (Identity18 | string)␊ - /**␊ - * Specifies the location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * Name of the Azure Machine Learning compute.␊ - */␊ - name: string␊ - /**␊ - * Machine Learning compute object.␊ - */␊ - properties: ((AKS2 | AmlCompute1 | VirtualMachine2 | HDInsight2 | DataFactory2 | Databricks1 | DataLakeAnalytics1) | string)␊ - /**␊ - * Contains resource tags defined as key/value pairs.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.MachineLearningServices/workspaces/computes"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.MachineLearningServices/workspaces␊ - */␊ - export interface Workspaces5 {␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Identity for the resource.␊ - */␊ - identity?: (Identity19 | string)␊ - /**␊ - * Specifies the location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * Name of Azure Machine Learning workspace.␊ - */␊ - name: string␊ - /**␊ - * The properties of a machine learning workspace.␊ - */␊ - properties: (WorkspaceProperties6 | string)␊ - resources?: WorkspacesComputesChildResource3[]␊ - /**␊ - * Contains resource tags defined as key/value pairs.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.MachineLearningServices/workspaces"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the resource.␊ - */␊ - export interface Identity19 {␊ - /**␊ - * The identity type.␊ - */␊ - type?: ("SystemAssigned" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a machine learning workspace.␊ - */␊ - export interface WorkspaceProperties6 {␊ - /**␊ - * ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created␊ - */␊ - applicationInsights?: string␊ - /**␊ - * ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created␊ - */␊ - containerRegistry?: string␊ - /**␊ - * The description of this workspace.␊ - */␊ - description?: string␊ - /**␊ - * Url for the discovery service to identify regional endpoints for machine learning experimentation services␊ - */␊ - discoveryUrl?: string␊ - /**␊ - * The friendly name for this workspace. This name in mutable␊ - */␊ - friendlyName?: string␊ - /**␊ - * ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created␊ - */␊ - keyVault?: string␊ - /**␊ - * ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created␊ - */␊ - storageAccount?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.MachineLearningServices/workspaces/computes␊ - */␊ - export interface WorkspacesComputesChildResource3 {␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Identity for the resource.␊ - */␊ - identity?: (Identity19 | string)␊ - /**␊ - * Specifies the location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * Name of the Azure Machine Learning compute.␊ - */␊ - name: string␊ - /**␊ - * Machine Learning compute object.␊ - */␊ - properties: (Compute3 | string)␊ - /**␊ - * Contains resource tags defined as key/value pairs.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "computes"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A Machine Learning compute based on AKS.␊ - */␊ - export interface AKS3 {␊ - computeType: "AKS"␊ - /**␊ - * AKS properties␊ - */␊ - properties?: (AKSProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AKS properties␊ - */␊ - export interface AKSProperties3 {␊ - /**␊ - * Number of agents␊ - */␊ - agentCount?: (number | string)␊ - /**␊ - * Agent virtual machine size␊ - */␊ - agentVMSize?: string␊ - /**␊ - * Advance configuration for AKS networking␊ - */␊ - aksNetworkingConfiguration?: (AksNetworkingConfiguration2 | string)␊ - /**␊ - * Cluster full qualified domain name␊ - */␊ - clusterFqdn?: string␊ - /**␊ - * The ssl configuration for scoring␊ - */␊ - sslConfiguration?: (SslConfiguration3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Advance configuration for AKS networking␊ - */␊ - export interface AksNetworkingConfiguration2 {␊ - /**␊ - * An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr.␊ - */␊ - dnsServiceIP?: string␊ - /**␊ - * A CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the Kubernetes service address range.␊ - */␊ - dockerBridgeCidr?: string␊ - /**␊ - * A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges.␊ - */␊ - serviceCidr?: string␊ - /**␊ - * Virtual network subnet resource ID the compute nodes belong to␊ - */␊ - subnetId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The ssl configuration for scoring␊ - */␊ - export interface SslConfiguration3 {␊ - /**␊ - * Cert data␊ - */␊ - cert?: string␊ - /**␊ - * CNAME of the cert␊ - */␊ - cname?: string␊ - /**␊ - * Key data␊ - */␊ - key?: string␊ - /**␊ - * Enable or disable ssl for scoring.␊ - */␊ - status?: (("Disabled" | "Enabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An Azure Machine Learning compute.␊ - */␊ - export interface AmlCompute2 {␊ - computeType: "AmlCompute"␊ - /**␊ - * AML Compute properties␊ - */␊ - properties?: (AmlComputeProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AML Compute properties␊ - */␊ - export interface AmlComputeProperties2 {␊ - /**␊ - * State of the public SSH port. Possible values are: Disabled - Indicates that the public ssh port is closed on all nodes of the cluster. Enabled - Indicates that the public ssh port is open on all nodes of the cluster. NotSpecified - Indicates that the public ssh port is closed on all nodes of the cluster if VNet is defined, else is open all public nodes. It can be default only during cluster creation time, after creation it will be either enabled or disabled.␊ - */␊ - remoteLoginPortPublicAccess?: (("Enabled" | "Disabled" | "NotSpecified") | string)␊ - /**␊ - * scale settings for AML Compute␊ - */␊ - scaleSettings?: (ScaleSettings4 | string)␊ - /**␊ - * Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet.␊ - */␊ - subnet?: (ResourceId2 | string)␊ - /**␊ - * Settings for user account that gets created on each on the nodes of a compute.␊ - */␊ - userAccountCredentials?: (UserAccountCredentials2 | string)␊ - /**␊ - * Virtual Machine priority.␊ - */␊ - vmPriority?: (("Dedicated" | "LowPriority") | string)␊ - /**␊ - * Virtual Machine Size␊ - */␊ - vmSize?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * scale settings for AML Compute␊ - */␊ - export interface ScaleSettings4 {␊ - /**␊ - * Max number of nodes to use␊ - */␊ - maxNodeCount: (number | string)␊ - /**␊ - * Min number of nodes to use␊ - */␊ - minNodeCount?: ((number & string) | string)␊ - /**␊ - * Node Idle Time before scaling down amlCompute␊ - */␊ - nodeIdleTimeBeforeScaleDown?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet.␊ - */␊ - export interface ResourceId2 {␊ - /**␊ - * The ID of the resource␊ - */␊ - id: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Settings for user account that gets created on each on the nodes of a compute.␊ - */␊ - export interface UserAccountCredentials2 {␊ - /**␊ - * Name of the administrator user account which can be used to SSH to nodes.␊ - */␊ - adminUserName: string␊ - /**␊ - * Password of the administrator user account.␊ - */␊ - adminUserPassword?: string␊ - /**␊ - * SSH public key of the administrator user account.␊ - */␊ - adminUserSshPublicKey?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A Machine Learning compute based on Azure Virtual Machines.␊ - */␊ - export interface VirtualMachine3 {␊ - computeType: "VirtualMachine"␊ - properties?: (VirtualMachineProperties6 | string)␊ - [k: string]: unknown␊ - }␊ - export interface VirtualMachineProperties6 {␊ - /**␊ - * Public IP address of the virtual machine.␊ - */␊ - address?: string␊ - /**␊ - * Admin credentials for virtual machine␊ - */␊ - administratorAccount?: (VirtualMachineSshCredentials3 | string)␊ - /**␊ - * Port open for ssh connections.␊ - */␊ - sshPort?: (number | string)␊ - /**␊ - * Virtual Machine size␊ - */␊ - virtualMachineSize?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Admin credentials for virtual machine␊ - */␊ - export interface VirtualMachineSshCredentials3 {␊ - /**␊ - * Password of admin account␊ - */␊ - password?: string␊ - /**␊ - * Private key data␊ - */␊ - privateKeyData?: string␊ - /**␊ - * Public key data␊ - */␊ - publicKeyData?: string␊ - /**␊ - * Username of admin account␊ - */␊ - username?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A HDInsight compute.␊ - */␊ - export interface HDInsight3 {␊ - computeType: "HDInsight"␊ - properties?: (HDInsightProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - export interface HDInsightProperties3 {␊ - /**␊ - * Public IP address of the master node of the cluster.␊ - */␊ - address?: string␊ - /**␊ - * Admin credentials for virtual machine␊ - */␊ - administratorAccount?: (VirtualMachineSshCredentials3 | string)␊ - /**␊ - * Port open for ssh connections on the master node of the cluster.␊ - */␊ - sshPort?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A DataFactory compute.␊ - */␊ - export interface DataFactory3 {␊ - computeType: "DataFactory"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A DataFactory compute.␊ - */␊ - export interface Databricks2 {␊ - computeType: "Databricks"␊ - properties?: (DatabricksProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - export interface DatabricksProperties2 {␊ - /**␊ - * Databricks access token␊ - */␊ - databricksAccessToken?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A DataLakeAnalytics compute.␊ - */␊ - export interface DataLakeAnalytics2 {␊ - computeType: "DataLakeAnalytics"␊ - properties?: (DataLakeAnalyticsProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - export interface DataLakeAnalyticsProperties2 {␊ - /**␊ - * DataLake Store Account Name␊ - */␊ - dataLakeStoreAccountName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.MachineLearningServices/workspaces/computes␊ - */␊ - export interface WorkspacesComputes3 {␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Identity for the resource.␊ - */␊ - identity?: (Identity19 | string)␊ - /**␊ - * Specifies the location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * Name of the Azure Machine Learning compute.␊ - */␊ - name: string␊ - /**␊ - * Machine Learning compute object.␊ - */␊ - properties: ((AKS3 | AmlCompute2 | VirtualMachine3 | HDInsight3 | DataFactory3 | Databricks2 | DataLakeAnalytics2) | string)␊ - /**␊ - * Contains resource tags defined as key/value pairs.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.MachineLearningServices/workspaces/computes"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.MachineLearningServices/workspaces␊ - */␊ - export interface Workspaces6 {␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Identity for the resource.␊ - */␊ - identity?: (Identity20 | string)␊ - /**␊ - * Specifies the location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * Name of Azure Machine Learning workspace.␊ - */␊ - name: string␊ - /**␊ - * The properties of a machine learning workspace.␊ - */␊ - properties: (WorkspaceProperties7 | string)␊ - resources?: WorkspacesComputesChildResource4[]␊ - /**␊ - * Sku of the resource␊ - */␊ - sku?: (Sku46 | string)␊ - /**␊ - * Contains resource tags defined as key/value pairs.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.MachineLearningServices/workspaces"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the resource.␊ - */␊ - export interface Identity20 {␊ - /**␊ - * The identity type.␊ - */␊ - type?: ("SystemAssigned" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a machine learning workspace.␊ - */␊ - export interface WorkspaceProperties7 {␊ - /**␊ - * ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created␊ - */␊ - applicationInsights?: string␊ - /**␊ - * ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created␊ - */␊ - containerRegistry?: string␊ - /**␊ - * The description of this workspace.␊ - */␊ - description?: string␊ - /**␊ - * Url for the discovery service to identify regional endpoints for machine learning experimentation services␊ - */␊ - discoveryUrl?: string␊ - /**␊ - * The friendly name for this workspace. This name in mutable␊ - */␊ - friendlyName?: string␊ - /**␊ - * ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created␊ - */␊ - keyVault?: string␊ - /**␊ - * ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created␊ - */␊ - storageAccount?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.MachineLearningServices/workspaces/computes␊ - */␊ - export interface WorkspacesComputesChildResource4 {␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Identity for the resource.␊ - */␊ - identity?: (Identity20 | string)␊ - /**␊ - * Specifies the location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * Name of the Azure Machine Learning compute.␊ - */␊ - name: string␊ - /**␊ - * Machine Learning compute object.␊ - */␊ - properties: (Compute4 | string)␊ - /**␊ - * Sku of the resource␊ - */␊ - sku?: (Sku46 | string)␊ - /**␊ - * Contains resource tags defined as key/value pairs.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "computes"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A Machine Learning compute based on AKS.␊ - */␊ - export interface AKS4 {␊ - computeType: "AKS"␊ - /**␊ - * AKS properties␊ - */␊ - properties?: (AKSProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AKS properties␊ - */␊ - export interface AKSProperties4 {␊ - /**␊ - * Number of agents␊ - */␊ - agentCount?: (number | string)␊ - /**␊ - * Agent virtual machine size␊ - */␊ - agentVMSize?: string␊ - /**␊ - * Advance configuration for AKS networking␊ - */␊ - aksNetworkingConfiguration?: (AksNetworkingConfiguration3 | string)␊ - /**␊ - * Cluster full qualified domain name␊ - */␊ - clusterFqdn?: string␊ - /**␊ - * The ssl configuration for scoring␊ - */␊ - sslConfiguration?: (SslConfiguration4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Advance configuration for AKS networking␊ - */␊ - export interface AksNetworkingConfiguration3 {␊ - /**␊ - * An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr.␊ - */␊ - dnsServiceIP?: string␊ - /**␊ - * A CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the Kubernetes service address range.␊ - */␊ - dockerBridgeCidr?: string␊ - /**␊ - * A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges.␊ - */␊ - serviceCidr?: string␊ - /**␊ - * Virtual network subnet resource ID the compute nodes belong to␊ - */␊ - subnetId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The ssl configuration for scoring␊ - */␊ - export interface SslConfiguration4 {␊ - /**␊ - * Cert data␊ - */␊ - cert?: string␊ - /**␊ - * CNAME of the cert␊ - */␊ - cname?: string␊ - /**␊ - * Key data␊ - */␊ - key?: string␊ - /**␊ - * Enable or disable ssl for scoring.␊ - */␊ - status?: (("Disabled" | "Enabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An Azure Machine Learning compute.␊ - */␊ - export interface AmlCompute3 {␊ - computeType: "AmlCompute"␊ - /**␊ - * AML Compute properties␊ - */␊ - properties?: (AmlComputeProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AML Compute properties␊ - */␊ - export interface AmlComputeProperties3 {␊ - /**␊ - * State of the public SSH port. Possible values are: Disabled - Indicates that the public ssh port is closed on all nodes of the cluster. Enabled - Indicates that the public ssh port is open on all nodes of the cluster. NotSpecified - Indicates that the public ssh port is closed on all nodes of the cluster if VNet is defined, else is open all public nodes. It can be default only during cluster creation time, after creation it will be either enabled or disabled.␊ - */␊ - remoteLoginPortPublicAccess?: (("Enabled" | "Disabled" | "NotSpecified") | string)␊ - /**␊ - * scale settings for AML Compute␊ - */␊ - scaleSettings?: (ScaleSettings5 | string)␊ - /**␊ - * Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet.␊ - */␊ - subnet?: (ResourceId3 | string)␊ - /**␊ - * Settings for user account that gets created on each on the nodes of a compute.␊ - */␊ - userAccountCredentials?: (UserAccountCredentials3 | string)␊ - /**␊ - * Virtual Machine priority.␊ - */␊ - vmPriority?: (("Dedicated" | "LowPriority") | string)␊ - /**␊ - * Virtual Machine Size␊ - */␊ - vmSize?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * scale settings for AML Compute␊ - */␊ - export interface ScaleSettings5 {␊ - /**␊ - * Max number of nodes to use␊ - */␊ - maxNodeCount: (number | string)␊ - /**␊ - * Min number of nodes to use␊ - */␊ - minNodeCount?: ((number & string) | string)␊ - /**␊ - * Node Idle Time before scaling down amlCompute␊ - */␊ - nodeIdleTimeBeforeScaleDown?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet.␊ - */␊ - export interface ResourceId3 {␊ - /**␊ - * The ID of the resource␊ - */␊ - id: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Settings for user account that gets created on each on the nodes of a compute.␊ - */␊ - export interface UserAccountCredentials3 {␊ - /**␊ - * Name of the administrator user account which can be used to SSH to nodes.␊ - */␊ - adminUserName: string␊ - /**␊ - * Password of the administrator user account.␊ - */␊ - adminUserPassword?: string␊ - /**␊ - * SSH public key of the administrator user account.␊ - */␊ - adminUserSshPublicKey?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A Machine Learning compute based on Azure Virtual Machines.␊ - */␊ - export interface VirtualMachine4 {␊ - computeType: "VirtualMachine"␊ - properties?: (VirtualMachineProperties7 | string)␊ - [k: string]: unknown␊ - }␊ - export interface VirtualMachineProperties7 {␊ - /**␊ - * Public IP address of the virtual machine.␊ - */␊ - address?: string␊ - /**␊ - * Admin credentials for virtual machine␊ - */␊ - administratorAccount?: (VirtualMachineSshCredentials4 | string)␊ - /**␊ - * Port open for ssh connections.␊ - */␊ - sshPort?: (number | string)␊ - /**␊ - * Virtual Machine size␊ - */␊ - virtualMachineSize?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Admin credentials for virtual machine␊ - */␊ - export interface VirtualMachineSshCredentials4 {␊ - /**␊ - * Password of admin account␊ - */␊ - password?: string␊ - /**␊ - * Private key data␊ - */␊ - privateKeyData?: string␊ - /**␊ - * Public key data␊ - */␊ - publicKeyData?: string␊ - /**␊ - * Username of admin account␊ - */␊ - username?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A HDInsight compute.␊ - */␊ - export interface HDInsight4 {␊ - computeType: "HDInsight"␊ - properties?: (HDInsightProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - export interface HDInsightProperties4 {␊ - /**␊ - * Public IP address of the master node of the cluster.␊ - */␊ - address?: string␊ - /**␊ - * Admin credentials for virtual machine␊ - */␊ - administratorAccount?: (VirtualMachineSshCredentials4 | string)␊ - /**␊ - * Port open for ssh connections on the master node of the cluster.␊ - */␊ - sshPort?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A DataFactory compute.␊ - */␊ - export interface DataFactory4 {␊ - computeType: "DataFactory"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A DataFactory compute.␊ - */␊ - export interface Databricks3 {␊ - computeType: "Databricks"␊ - properties?: (DatabricksProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - export interface DatabricksProperties3 {␊ - /**␊ - * Databricks access token␊ - */␊ - databricksAccessToken?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A DataLakeAnalytics compute.␊ - */␊ - export interface DataLakeAnalytics3 {␊ - computeType: "DataLakeAnalytics"␊ - properties?: (DataLakeAnalyticsProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - export interface DataLakeAnalyticsProperties3 {␊ - /**␊ - * DataLake Store Account Name␊ - */␊ - dataLakeStoreAccountName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Sku of the resource␊ - */␊ - export interface Sku46 {␊ - /**␊ - * Name of the sku␊ - */␊ - name?: string␊ - /**␊ - * Tier of the sku like Basic or Enterprise␊ - */␊ - tier?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.MachineLearningServices/workspaces/computes␊ - */␊ - export interface WorkspacesComputes4 {␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Identity for the resource.␊ - */␊ - identity?: (Identity20 | string)␊ - /**␊ - * Specifies the location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * Name of the Azure Machine Learning compute.␊ - */␊ - name: string␊ - /**␊ - * Machine Learning compute object.␊ - */␊ - properties: ((AKS4 | AmlCompute3 | VirtualMachine4 | HDInsight4 | DataFactory4 | Databricks3 | DataLakeAnalytics3) | string)␊ - /**␊ - * Sku of the resource␊ - */␊ - sku?: (Sku46 | string)␊ - /**␊ - * Contains resource tags defined as key/value pairs.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.MachineLearningServices/workspaces/computes"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.MachineLearningServices/workspaces␊ - */␊ - export interface Workspaces7 {␊ - apiVersion: "2020-01-01"␊ - /**␊ - * Identity for the resource.␊ - */␊ - identity?: (Identity21 | string)␊ - /**␊ - * Specifies the location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * Name of Azure Machine Learning workspace.␊ - */␊ - name: string␊ - /**␊ - * The properties of a machine learning workspace.␊ - */␊ - properties: (WorkspaceProperties8 | string)␊ - resources?: (WorkspacesComputesChildResource5 | WorkspacesPrivateEndpointConnectionsChildResource)[]␊ - /**␊ - * Sku of the resource␊ - */␊ - sku?: (Sku47 | string)␊ - /**␊ - * Contains resource tags defined as key/value pairs.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.MachineLearningServices/workspaces"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the resource.␊ - */␊ - export interface Identity21 {␊ - /**␊ - * The identity type.␊ - */␊ - type?: ("SystemAssigned" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a machine learning workspace.␊ - */␊ - export interface WorkspaceProperties8 {␊ - /**␊ - * ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created␊ - */␊ - applicationInsights?: string␊ - /**␊ - * ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created␊ - */␊ - containerRegistry?: string␊ - /**␊ - * The description of this workspace.␊ - */␊ - description?: string␊ - /**␊ - * Url for the discovery service to identify regional endpoints for machine learning experimentation services␊ - */␊ - discoveryUrl?: string␊ - encryption?: (EncryptionProperty | string)␊ - /**␊ - * The friendly name for this workspace. This name in mutable␊ - */␊ - friendlyName?: string␊ - /**␊ - * The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service␊ - */␊ - hbiWorkspace?: (boolean | string)␊ - /**␊ - * ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created␊ - */␊ - keyVault?: string␊ - /**␊ - * ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created␊ - */␊ - storageAccount?: string␊ - [k: string]: unknown␊ - }␊ - export interface EncryptionProperty {␊ - keyVaultProperties: (KeyVaultProperties15 | string)␊ - /**␊ - * Indicates whether or not the encryption is enabled for the workspace.␊ - */␊ - status: (("Enabled" | "Disabled") | string)␊ - [k: string]: unknown␊ - }␊ - export interface KeyVaultProperties15 {␊ - /**␊ - * For future use - The client id of the identity which will be used to access key vault.␊ - */␊ - identityClientId?: string␊ - /**␊ - * Key vault uri to access the encryption key.␊ - */␊ - keyIdentifier: string␊ - /**␊ - * The ArmId of the keyVault where the customer owned encryption key is present.␊ - */␊ - keyVaultArmId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.MachineLearningServices/workspaces/computes␊ - */␊ - export interface WorkspacesComputesChildResource5 {␊ - apiVersion: "2020-01-01"␊ - /**␊ - * Identity for the resource.␊ - */␊ - identity?: (Identity21 | string)␊ - /**␊ - * Specifies the location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * Name of the Azure Machine Learning compute.␊ - */␊ - name: string␊ - /**␊ - * Machine Learning compute object.␊ - */␊ - properties: (Compute5 | string)␊ - /**␊ - * Sku of the resource␊ - */␊ - sku?: (Sku47 | string)␊ - /**␊ - * Contains resource tags defined as key/value pairs.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "computes"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A Machine Learning compute based on AKS.␊ - */␊ - export interface AKS5 {␊ - computeType: "AKS"␊ - /**␊ - * AKS properties␊ - */␊ - properties?: (AKSProperties5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AKS properties␊ - */␊ - export interface AKSProperties5 {␊ - /**␊ - * Number of agents␊ - */␊ - agentCount?: (number | string)␊ - /**␊ - * Agent virtual machine size␊ - */␊ - agentVMSize?: string␊ - /**␊ - * Advance configuration for AKS networking␊ - */␊ - aksNetworkingConfiguration?: (AksNetworkingConfiguration4 | string)␊ - /**␊ - * Cluster full qualified domain name␊ - */␊ - clusterFqdn?: string␊ - /**␊ - * The ssl configuration for scoring␊ - */␊ - sslConfiguration?: (SslConfiguration5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Advance configuration for AKS networking␊ - */␊ - export interface AksNetworkingConfiguration4 {␊ - /**␊ - * An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr.␊ - */␊ - dnsServiceIP?: string␊ - /**␊ - * A CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the Kubernetes service address range.␊ - */␊ - dockerBridgeCidr?: string␊ - /**␊ - * A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges.␊ - */␊ - serviceCidr?: string␊ - /**␊ - * Virtual network subnet resource ID the compute nodes belong to␊ - */␊ - subnetId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The ssl configuration for scoring␊ - */␊ - export interface SslConfiguration5 {␊ - /**␊ - * Cert data␊ - */␊ - cert?: string␊ - /**␊ - * CNAME of the cert␊ - */␊ - cname?: string␊ - /**␊ - * Key data␊ - */␊ - key?: string␊ - /**␊ - * Enable or disable ssl for scoring.␊ - */␊ - status?: (("Disabled" | "Enabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An Azure Machine Learning compute.␊ - */␊ - export interface AmlCompute4 {␊ - computeType: "AmlCompute"␊ - /**␊ - * AML Compute properties␊ - */␊ - properties?: (AmlComputeProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AML Compute properties␊ - */␊ - export interface AmlComputeProperties4 {␊ - /**␊ - * State of the public SSH port. Possible values are: Disabled - Indicates that the public ssh port is closed on all nodes of the cluster. Enabled - Indicates that the public ssh port is open on all nodes of the cluster. NotSpecified - Indicates that the public ssh port is closed on all nodes of the cluster if VNet is defined, else is open all public nodes. It can be default only during cluster creation time, after creation it will be either enabled or disabled.␊ - */␊ - remoteLoginPortPublicAccess?: (("Enabled" | "Disabled" | "NotSpecified") | string)␊ - /**␊ - * scale settings for AML Compute␊ - */␊ - scaleSettings?: (ScaleSettings6 | string)␊ - /**␊ - * Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet.␊ - */␊ - subnet?: (ResourceId4 | string)␊ - /**␊ - * Settings for user account that gets created on each on the nodes of a compute.␊ - */␊ - userAccountCredentials?: (UserAccountCredentials4 | string)␊ - /**␊ - * Virtual Machine priority.␊ - */␊ - vmPriority?: (("Dedicated" | "LowPriority") | string)␊ - /**␊ - * Virtual Machine Size␊ - */␊ - vmSize?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * scale settings for AML Compute␊ - */␊ - export interface ScaleSettings6 {␊ - /**␊ - * Max number of nodes to use␊ - */␊ - maxNodeCount: (number | string)␊ - /**␊ - * Min number of nodes to use␊ - */␊ - minNodeCount?: ((number & string) | string)␊ - /**␊ - * Node Idle Time before scaling down amlCompute␊ - */␊ - nodeIdleTimeBeforeScaleDown?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet.␊ - */␊ - export interface ResourceId4 {␊ - /**␊ - * The ID of the resource␊ - */␊ - id: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Settings for user account that gets created on each on the nodes of a compute.␊ - */␊ - export interface UserAccountCredentials4 {␊ - /**␊ - * Name of the administrator user account which can be used to SSH to nodes.␊ - */␊ - adminUserName: string␊ - /**␊ - * Password of the administrator user account.␊ - */␊ - adminUserPassword?: string␊ - /**␊ - * SSH public key of the administrator user account.␊ - */␊ - adminUserSshPublicKey?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A Machine Learning compute based on Azure Virtual Machines.␊ - */␊ - export interface VirtualMachine5 {␊ - computeType: "VirtualMachine"␊ - properties?: (VirtualMachineProperties8 | string)␊ - [k: string]: unknown␊ - }␊ - export interface VirtualMachineProperties8 {␊ - /**␊ - * Public IP address of the virtual machine.␊ - */␊ - address?: string␊ - /**␊ - * Admin credentials for virtual machine␊ - */␊ - administratorAccount?: (VirtualMachineSshCredentials5 | string)␊ - /**␊ - * Port open for ssh connections.␊ - */␊ - sshPort?: (number | string)␊ - /**␊ - * Virtual Machine size␊ - */␊ - virtualMachineSize?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Admin credentials for virtual machine␊ - */␊ - export interface VirtualMachineSshCredentials5 {␊ - /**␊ - * Password of admin account␊ - */␊ - password?: string␊ - /**␊ - * Private key data␊ - */␊ - privateKeyData?: string␊ - /**␊ - * Public key data␊ - */␊ - publicKeyData?: string␊ - /**␊ - * Username of admin account␊ - */␊ - username?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A HDInsight compute.␊ - */␊ - export interface HDInsight5 {␊ - computeType: "HDInsight"␊ - properties?: (HDInsightProperties5 | string)␊ - [k: string]: unknown␊ - }␊ - export interface HDInsightProperties5 {␊ - /**␊ - * Public IP address of the master node of the cluster.␊ - */␊ - address?: string␊ - /**␊ - * Admin credentials for virtual machine␊ - */␊ - administratorAccount?: (VirtualMachineSshCredentials5 | string)␊ - /**␊ - * Port open for ssh connections on the master node of the cluster.␊ - */␊ - sshPort?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A DataFactory compute.␊ - */␊ - export interface DataFactory5 {␊ - computeType: "DataFactory"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A DataFactory compute.␊ - */␊ - export interface Databricks4 {␊ - computeType: "Databricks"␊ - properties?: (DatabricksProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - export interface DatabricksProperties4 {␊ - /**␊ - * Databricks access token␊ - */␊ - databricksAccessToken?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A DataLakeAnalytics compute.␊ - */␊ - export interface DataLakeAnalytics4 {␊ - computeType: "DataLakeAnalytics"␊ - properties?: (DataLakeAnalyticsProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - export interface DataLakeAnalyticsProperties4 {␊ - /**␊ - * DataLake Store Account Name␊ - */␊ - dataLakeStoreAccountName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Sku of the resource␊ - */␊ - export interface Sku47 {␊ - /**␊ - * Name of the sku␊ - */␊ - name?: string␊ - /**␊ - * Tier of the sku like Basic or Enterprise␊ - */␊ - tier?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.MachineLearningServices/workspaces/privateEndpointConnections␊ - */␊ - export interface WorkspacesPrivateEndpointConnectionsChildResource {␊ - apiVersion: "2020-01-01"␊ - /**␊ - * Identity for the resource.␊ - */␊ - identity?: (Identity21 | string)␊ - /**␊ - * Specifies the location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * The name of the private endpoint connection associated with the workspace␊ - */␊ - name: string␊ - /**␊ - * Properties of the PrivateEndpointConnectProperties.␊ - */␊ - properties: (PrivateEndpointConnectionProperties5 | string)␊ - /**␊ - * Sku of the resource␊ - */␊ - sku?: (Sku47 | string)␊ - /**␊ - * Contains resource tags defined as key/value pairs.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "privateEndpointConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the PrivateEndpointConnectProperties.␊ - */␊ - export interface PrivateEndpointConnectionProperties5 {␊ - /**␊ - * The Private Endpoint resource.␊ - */␊ - privateEndpoint?: (PrivateEndpoint5 | string)␊ - /**␊ - * A collection of information about the state of the connection between service consumer and provider.␊ - */␊ - privateLinkServiceConnectionState: (PrivateLinkServiceConnectionState5 | string)␊ - /**␊ - * The provisioning state of the private endpoint connection resource.␊ - */␊ - provisioningState?: (("Succeeded" | "Creating" | "Deleting" | "Failed") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Private Endpoint resource.␊ - */␊ - export interface PrivateEndpoint5 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A collection of information about the state of the connection between service consumer and provider.␊ - */␊ - export interface PrivateLinkServiceConnectionState5 {␊ - /**␊ - * A message indicating if changes on the service provider require any updates on the consumer.␊ - */␊ - actionRequired?: string␊ - /**␊ - * The reason for approval/rejection of the connection.␊ - */␊ - description?: string␊ - /**␊ - * Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.␊ - */␊ - status?: (("Pending" | "Approved" | "Rejected") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.MachineLearningServices/workspaces/computes␊ - */␊ - export interface WorkspacesComputes5 {␊ - apiVersion: "2020-01-01"␊ - /**␊ - * Identity for the resource.␊ - */␊ - identity?: (Identity21 | string)␊ - /**␊ - * Specifies the location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * Name of the Azure Machine Learning compute.␊ - */␊ - name: string␊ - /**␊ - * Machine Learning compute object.␊ - */␊ - properties: ((AKS5 | AmlCompute4 | VirtualMachine5 | HDInsight5 | DataFactory5 | Databricks4 | DataLakeAnalytics4) | string)␊ - /**␊ - * Sku of the resource␊ - */␊ - sku?: (Sku47 | string)␊ - /**␊ - * Contains resource tags defined as key/value pairs.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.MachineLearningServices/workspaces/computes"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.MachineLearningServices/workspaces/privateEndpointConnections␊ - */␊ - export interface WorkspacesPrivateEndpointConnections {␊ - apiVersion: "2020-01-01"␊ - /**␊ - * Identity for the resource.␊ - */␊ - identity?: (Identity21 | string)␊ - /**␊ - * Specifies the location of the resource.␊ - */␊ - location?: string␊ - /**␊ - * The name of the private endpoint connection associated with the workspace␊ - */␊ - name: string␊ - /**␊ - * Properties of the PrivateEndpointConnectProperties.␊ - */␊ - properties: (PrivateEndpointConnectionProperties5 | string)␊ - /**␊ - * Sku of the resource␊ - */␊ - sku?: (Sku47 | string)␊ - /**␊ - * Contains resource tags defined as key/value pairs.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.MachineLearningServices/workspaces/privateEndpointConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/publicIPAddresses␊ - */␊ - export interface PublicIPAddresses9 {␊ - name: string␊ - type: "Microsoft.Network/publicIPAddresses"␊ - apiVersion: "2017-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The public IP address SKU.␊ - */␊ - sku?: (PublicIPAddressSku | string)␊ - /**␊ - * Public IP address properties.␊ - */␊ - properties: (PublicIPAddressPropertiesFormat1 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a public IP address␊ - */␊ - export interface PublicIPAddressSku {␊ - /**␊ - * Name of a public IP address SKU.␊ - */␊ - name?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Public IP address properties.␊ - */␊ - export interface PublicIPAddressPropertiesFormat1 {␊ - /**␊ - * The public IP allocation method. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - publicIPAllocationMethod: (("Static" | "Dynamic") | string)␊ - /**␊ - * The public IP address version. Possible values are: 'IPv4' and 'IPv6'.␊ - */␊ - publicIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The FQDN of the DNS record associated with the public IP address.␊ - */␊ - dnsSettings?: (PublicIPAddressDnsSettings9 | string)␊ - /**␊ - * The IP address associated with the public IP address resource.␊ - */␊ - ipAddress?: string␊ - /**␊ - * The idle timeout of the public IP address.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * The resource GUID property of the public IP resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains FQDN of the DNS record associated with the public IP address␊ - */␊ - export interface PublicIPAddressDnsSettings9 {␊ - /**␊ - * Gets or sets the Domain name label.The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.␊ - */␊ - domainNameLabel: string␊ - /**␊ - * Gets the FQDN, Fully qualified domain name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone.␊ - */␊ - fqdn?: string␊ - /**␊ - * Gets or Sets the Reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN. ␊ - */␊ - reverseFqdn?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks␊ - */␊ - export interface VirtualNetworks9 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks"␊ - apiVersion: "2017-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network.␊ - */␊ - properties: (VirtualNetworkPropertiesFormat1 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: (VirtualNetworksVirtualNetworkPeeringsChildResource1 | VirtualNetworksSubnetsChildResource1)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the virtual network.␊ - */␊ - export interface VirtualNetworkPropertiesFormat1 {␊ - /**␊ - * The AddressSpace that contains an array of IP address ranges that can be used by subnets.␊ - */␊ - addressSpace: (AddressSpace9 | string)␊ - /**␊ - * The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network.␊ - */␊ - dhcpOptions?: (DhcpOptions9 | string)␊ - /**␊ - * A list of subnets in a Virtual Network.␊ - */␊ - subnets?: (Subnet11[] | string)␊ - /**␊ - * A list of peerings in a Virtual Network.␊ - */␊ - virtualNetworkPeerings?: (VirtualNetworkPeering9[] | string)␊ - /**␊ - * The resourceGuid property of the Virtual Network resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.␊ - */␊ - export interface AddressSpace9 {␊ - /**␊ - * A list of address blocks reserved for this virtual network in CIDR notation.␊ - */␊ - addressPrefixes: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DhcpOptions contains an array of DNS servers available to VMs deployed in the virtual network. Standard DHCP option for a subnet overrides VNET DHCP options.␊ - */␊ - export interface DhcpOptions9 {␊ - /**␊ - * The list of DNS servers IP addresses.␊ - */␊ - dnsServers: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Subnet in a virtual network resource.␊ - */␊ - export interface Subnet11 {␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties?: (SubnetPropertiesFormat1 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the subnet.␊ - */␊ - export interface SubnetPropertiesFormat1 {␊ - /**␊ - * The address prefix for the subnet.␊ - */␊ - addressPrefix: string␊ - /**␊ - * The reference of the NetworkSecurityGroup resource.␊ - */␊ - networkSecurityGroup?: (SubResource6 | string)␊ - /**␊ - * The reference of the RouteTable resource.␊ - */␊ - routeTable?: (SubResource6 | string)␊ - /**␊ - * An array of service endpoints.␊ - */␊ - serviceEndpoints?: (ServiceEndpointPropertiesFormat[] | string)␊ - /**␊ - * Gets an array of references to the external resources using subnet.␊ - */␊ - resourceNavigationLinks?: (ResourceNavigationLink1[] | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Reference to another subresource.␊ - */␊ - export interface SubResource6 {␊ - /**␊ - * Resource ID.␊ - */␊ - id: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The service endpoint properties.␊ - */␊ - export interface ServiceEndpointPropertiesFormat {␊ - /**␊ - * The type of the endpoint service.␊ - */␊ - service?: string␊ - /**␊ - * A list of locations.␊ - */␊ - locations?: (string[] | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ResourceNavigationLink resource.␊ - */␊ - export interface ResourceNavigationLink1 {␊ - /**␊ - * Resource navigation link properties format.␊ - */␊ - properties?: (ResourceNavigationLinkFormat1 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ResourceNavigationLink.␊ - */␊ - export interface ResourceNavigationLinkFormat1 {␊ - /**␊ - * Resource type of the linked resource.␊ - */␊ - linkedResourceType?: string␊ - /**␊ - * Link to the external resource␊ - */␊ - link?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peerings in a virtual network resource.␊ - */␊ - export interface VirtualNetworkPeering9 {␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties?: (VirtualNetworkPeeringPropertiesFormat1 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - export interface VirtualNetworkPeeringPropertiesFormat1 {␊ - /**␊ - * Whether the VMs in the linked virtual network space would be able to access all the VMs in local Virtual network space.␊ - */␊ - allowVirtualNetworkAccess?: (boolean | string)␊ - /**␊ - * Whether the forwarded traffic from the VMs in the remote virtual network will be allowed/disallowed.␊ - */␊ - allowForwardedTraffic?: (boolean | string)␊ - /**␊ - * If gateway links can be used in remote virtual networking to link to this virtual network.␊ - */␊ - allowGatewayTransit?: (boolean | string)␊ - /**␊ - * If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway.␊ - */␊ - useRemoteGateways?: (boolean | string)␊ - /**␊ - * The reference of the remote virtual network.␊ - */␊ - remoteVirtualNetwork: (SubResource6 | string)␊ - /**␊ - * The status of the virtual network peering. Possible values are 'Initiated', 'Connected', and 'Disconnected'.␊ - */␊ - peeringState?: (("Initiated" | "Connected" | "Disconnected") | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/virtualNetworkPeerings␊ - */␊ - export interface VirtualNetworksVirtualNetworkPeeringsChildResource1 {␊ - name: string␊ - type: "virtualNetworkPeerings"␊ - apiVersion: "2017-08-01"␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties: (VirtualNetworkPeeringPropertiesFormat1 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnetsChildResource1 {␊ - name: string␊ - type: "subnets"␊ - apiVersion: "2017-08-01"␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties: (SubnetPropertiesFormat1 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers␊ - */␊ - export interface LoadBalancers9 {␊ - name: string␊ - type: "Microsoft.Network/loadBalancers"␊ - apiVersion: "2017-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The load balancer SKU.␊ - */␊ - sku?: (LoadBalancerSku | string)␊ - /**␊ - * Properties of load balancer.␊ - */␊ - properties: (LoadBalancerPropertiesFormat1 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: LoadBalancersInboundNatRulesChildResource[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a load balancer␊ - */␊ - export interface LoadBalancerSku {␊ - /**␊ - * Name of a load balancer SKU.␊ - */␊ - name?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer.␊ - */␊ - export interface LoadBalancerPropertiesFormat1 {␊ - /**␊ - * Object representing the frontend IPs to be used for the load balancer␊ - */␊ - frontendIPConfigurations?: (FrontendIPConfiguration1[] | string)␊ - /**␊ - * Collection of backend address pools used by a load balancer␊ - */␊ - backendAddressPools?: (BackendAddressPool1[] | string)␊ - /**␊ - * Object collection representing the load balancing rules Gets the provisioning ␊ - */␊ - loadBalancingRules?: (LoadBalancingRule1[] | string)␊ - /**␊ - * Collection of probe objects used in the load balancer␊ - */␊ - probes?: (Probe1[] | string)␊ - /**␊ - * Collection of inbound NAT Rules used by a load balancer. Defining inbound NAT rules on your load balancer is mutually exclusive with defining an inbound NAT pool. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an Inbound NAT pool. They have to reference individual inbound NAT rules.␊ - */␊ - inboundNatRules?: (InboundNatRule2[] | string)␊ - /**␊ - * Defines an external port range for inbound NAT to a single backend port on NICs associated with a load balancer. Inbound NAT rules are created automatically for each NIC associated with the Load Balancer using an external port from this range. Defining an Inbound NAT pool on your Load Balancer is mutually exclusive with defining inbound Nat rules. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an inbound NAT pool. They have to reference individual inbound NAT rules.␊ - */␊ - inboundNatPools?: (InboundNatPool2[] | string)␊ - /**␊ - * The outbound NAT rules.␊ - */␊ - outboundNatRules?: (OutboundNatRule1[] | string)␊ - /**␊ - * The resource GUID property of the load balancer resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP address of the load balancer.␊ - */␊ - export interface FrontendIPConfiguration1 {␊ - /**␊ - * Properties of the load balancer probe.␊ - */␊ - properties?: (FrontendIPConfigurationPropertiesFormat1 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP Configuration of the load balancer.␊ - */␊ - export interface FrontendIPConfigurationPropertiesFormat1 {␊ - /**␊ - * The private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The Private IP allocation method. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * The reference of the subnet resource.␊ - */␊ - subnet?: (SubResource6 | string)␊ - /**␊ - * The reference of the Public IP resource.␊ - */␊ - publicIPAddress?: (SubResource6 | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Pool of backend IP addresses.␊ - */␊ - export interface BackendAddressPool1 {␊ - /**␊ - * Properties of load balancer backend address pool.␊ - */␊ - properties?: (BackendAddressPoolPropertiesFormat1 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the backend address pool.␊ - */␊ - export interface BackendAddressPoolPropertiesFormat1 {␊ - /**␊ - * Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A load balancing rule for a load balancer.␊ - */␊ - export interface LoadBalancingRule1 {␊ - /**␊ - * Properties of load balancer load balancing rule.␊ - */␊ - properties?: (LoadBalancingRulePropertiesFormat1 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer.␊ - */␊ - export interface LoadBalancingRulePropertiesFormat1 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource6 | string)␊ - /**␊ - * A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs.␊ - */␊ - backendAddressPool?: (SubResource6 | string)␊ - /**␊ - * The reference of the load balancer probe used by the load balancing rule.␊ - */␊ - probe?: (SubResource6 | string)␊ - /**␊ - * The transport protocol for the external endpoint. Possible values are 'Udp' or 'Tcp'.␊ - */␊ - protocol: (("Udp" | "Tcp") | string)␊ - /**␊ - * The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'.␊ - */␊ - loadDistribution?: (("Default" | "SourceIP" | "SourceIPProtocol") | string)␊ - /**␊ - * The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 1 and 65534.␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. ␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule.␊ - */␊ - disableOutboundSnat?: (boolean | string)␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A load balancer probe.␊ - */␊ - export interface Probe1 {␊ - /**␊ - * Properties of load balancer probe.␊ - */␊ - properties?: (ProbePropertiesFormat1 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Load balancer probe resource.␊ - */␊ - export interface ProbePropertiesFormat1 {␊ - /**␊ - * The protocol of the end point. Possible values are: 'Http' or 'Tcp'. If 'Tcp' is specified, a received ACK is required for the probe to be successful. If 'Http' is specified, a 200 OK response from the specifies URI is required for the probe to be successful.␊ - */␊ - protocol: (("Http" | "Tcp") | string)␊ - /**␊ - * The port for communicating the probe. Possible values range from 1 to 65535, inclusive.␊ - */␊ - port: (number | string)␊ - /**␊ - * The interval, in seconds, for how frequently to probe the endpoint for health status. Typically, the interval is slightly less than half the allocated timeout period (in seconds) which allows two full probes before taking the instance out of rotation. The default value is 15, the minimum value is 5.␊ - */␊ - intervalInSeconds?: (number | string)␊ - /**␊ - * The number of probes where if no response, will result in stopping further traffic from being delivered to the endpoint. This values allows endpoints to be taken out of rotation faster or slower than the typical times used in Azure.␊ - */␊ - numberOfProbes: (number | string)␊ - /**␊ - * The URI used for requesting health status from the VM. Path is required if a protocol is set to http. Otherwise, it is not allowed. There is no default value.␊ - */␊ - requestPath?: string␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT rule of the load balancer.␊ - */␊ - export interface InboundNatRule2 {␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties?: (InboundNatRulePropertiesFormat1 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the inbound NAT rule.␊ - */␊ - export interface InboundNatRulePropertiesFormat1 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource6 | string)␊ - /**␊ - * The transport protocol for the endpoint. Possible values are: 'Udp' or 'Tcp'.␊ - */␊ - protocol: (("Udp" | "Tcp") | string)␊ - /**␊ - * The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values range from 1 to 65534.␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * The port used for the internal endpoint. Acceptable values range from 1 to 65535.␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT pool of the load balancer.␊ - */␊ - export interface InboundNatPool2 {␊ - /**␊ - * Properties of load balancer inbound nat pool.␊ - */␊ - properties?: (InboundNatPoolPropertiesFormat1 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Inbound NAT pool.␊ - */␊ - export interface InboundNatPoolPropertiesFormat1 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource6 | string)␊ - /**␊ - * The transport protocol for the endpoint. Possible values are: 'Udp' or 'Tcp'.␊ - */␊ - protocol: (("Udp" | "Tcp") | string)␊ - /**␊ - * The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65534.␊ - */␊ - frontendPortRangeStart: (number | string)␊ - /**␊ - * The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65535.␊ - */␊ - frontendPortRangeEnd: (number | string)␊ - /**␊ - * The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound NAT pool of the load balancer.␊ - */␊ - export interface OutboundNatRule1 {␊ - /**␊ - * Properties of load balancer outbound nat rule.␊ - */␊ - properties?: (OutboundNatRulePropertiesFormat1 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound NAT pool of the load balancer.␊ - */␊ - export interface OutboundNatRulePropertiesFormat1 {␊ - /**␊ - * The number of outbound ports to be used for NAT.␊ - */␊ - allocatedOutboundPorts?: (number | string)␊ - /**␊ - * The Frontend IP addresses of the load balancer.␊ - */␊ - frontendIPConfigurations?: (SubResource6[] | string)␊ - /**␊ - * A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs.␊ - */␊ - backendAddressPool: (SubResource6 | string)␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers/inboundNatRules␊ - */␊ - export interface LoadBalancersInboundNatRulesChildResource {␊ - name: string␊ - type: "inboundNatRules"␊ - apiVersion: "2017-08-01"␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties: (InboundNatRulePropertiesFormat1 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups␊ - */␊ - export interface NetworkSecurityGroups9 {␊ - name: string␊ - type: "Microsoft.Network/networkSecurityGroups"␊ - apiVersion: "2017-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network security group␊ - */␊ - properties: (NetworkSecurityGroupPropertiesFormat1 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: NetworkSecurityGroupsSecurityRulesChildResource1[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network Security Group resource.␊ - */␊ - export interface NetworkSecurityGroupPropertiesFormat1 {␊ - /**␊ - * A collection of security rules of the network security group.␊ - */␊ - securityRules?: (SecurityRule1[] | string)␊ - /**␊ - * The default security rules of network security group.␊ - */␊ - defaultSecurityRules?: (SecurityRule1[] | string)␊ - /**␊ - * The resource GUID property of the network security group resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network security rule.␊ - */␊ - export interface SecurityRule1 {␊ - /**␊ - * Properties of the security rule␊ - */␊ - properties?: (SecurityRulePropertiesFormat1 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Security rule resource.␊ - */␊ - export interface SecurityRulePropertiesFormat1 {␊ - /**␊ - * A description for this rule. Restricted to 140 chars.␊ - */␊ - description?: string␊ - /**␊ - * Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'.␊ - */␊ - protocol: (("Tcp" | "Udp" | "*") | string)␊ - /**␊ - * The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports.␊ - */␊ - sourcePortRange?: string␊ - /**␊ - * The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports.␊ - */␊ - destinationPortRange?: string␊ - /**␊ - * The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. ␊ - */␊ - sourceAddressPrefix?: string␊ - /**␊ - * The CIDR or source IP ranges.␊ - */␊ - sourceAddressPrefixes?: (string[] | string)␊ - /**␊ - * The destination address prefix. CIDR or destination IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used.␊ - */␊ - destinationAddressPrefix?: string␊ - /**␊ - * The destination address prefixes. CIDR or destination IP ranges.␊ - */␊ - destinationAddressPrefixes?: (string[] | string)␊ - /**␊ - * The source port ranges.␊ - */␊ - sourcePortRanges?: (string[] | string)␊ - /**␊ - * The destination port ranges.␊ - */␊ - destinationPortRanges?: (string[] | string)␊ - /**␊ - * The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'.␊ - */␊ - access: (("Allow" | "Deny") | string)␊ - /**␊ - * The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.␊ - */␊ - priority: (number | string)␊ - /**␊ - * The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'.␊ - */␊ - direction: (("Inbound" | "Outbound") | string)␊ - /**␊ - * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRulesChildResource1 {␊ - name: string␊ - type: "securityRules"␊ - apiVersion: "2017-08-01"␊ - /**␊ - * Properties of the security rule␊ - */␊ - properties: (SecurityRulePropertiesFormat1 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces␊ - */␊ - export interface NetworkInterfaces10 {␊ - name: string␊ - type: "Microsoft.Network/networkInterfaces"␊ - apiVersion: "2017-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network interface.␊ - */␊ - properties: (NetworkInterfacePropertiesFormat1 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NetworkInterface properties. ␊ - */␊ - export interface NetworkInterfacePropertiesFormat1 {␊ - /**␊ - * The reference of the NetworkSecurityGroup resource.␊ - */␊ - networkSecurityGroup?: (SubResource6 | string)␊ - /**␊ - * A list of IPConfigurations of the network interface.␊ - */␊ - ipConfigurations: (NetworkInterfaceIPConfiguration1[] | string)␊ - /**␊ - * The DNS settings in network interface.␊ - */␊ - dnsSettings?: (NetworkInterfaceDnsSettings9 | string)␊ - /**␊ - * The MAC address of the network interface.␊ - */␊ - macAddress?: string␊ - /**␊ - * Gets whether this is a primary network interface on a virtual machine.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * If the network interface is accelerated networking enabled.␊ - */␊ - enableAcceleratedNetworking?: (boolean | string)␊ - /**␊ - * Indicates whether IP forwarding is enabled on this network interface.␊ - */␊ - enableIPForwarding?: (boolean | string)␊ - /**␊ - * The resource GUID property of the network interface resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IPConfiguration in a network interface.␊ - */␊ - export interface NetworkInterfaceIPConfiguration1 {␊ - /**␊ - * Network interface IP configuration properties.␊ - */␊ - properties?: (NetworkInterfaceIPConfigurationPropertiesFormat1 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration.␊ - */␊ - export interface NetworkInterfaceIPConfigurationPropertiesFormat1 {␊ - /**␊ - * The reference of ApplicationGatewayBackendAddressPool resource.␊ - */␊ - applicationGatewayBackendAddressPools?: (SubResource6[] | string)␊ - /**␊ - * The reference of LoadBalancerBackendAddressPool resource.␊ - */␊ - loadBalancerBackendAddressPools?: (SubResource6[] | string)␊ - /**␊ - * A list of references of LoadBalancerInboundNatRules.␊ - */␊ - loadBalancerInboundNatRules?: (SubResource6[] | string)␊ - /**␊ - * Private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * Defines how a private IP address is assigned. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Available from Api-Version 2016-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.␊ - */␊ - privateIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * Subnet bound to the IP configuration.␊ - */␊ - subnet?: (SubResource6 | string)␊ - /**␊ - * Gets whether this is a primary customer address on the network interface.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * Public IP address bound to the IP configuration.␊ - */␊ - publicIPAddress?: (SubResource6 | string)␊ - /**␊ - * The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DNS settings of a network interface.␊ - */␊ - export interface NetworkInterfaceDnsSettings9 {␊ - /**␊ - * List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only value in dnsServers collection.␊ - */␊ - dnsServers?: (string[] | string)␊ - /**␊ - * If the VM that uses this NIC is part of an Availability Set, then this list will have the union of all DNS servers from all NICs that are part of the Availability Set. This property is what is configured on each of those VMs.␊ - */␊ - appliedDnsServers?: (string[] | string)␊ - /**␊ - * Relative DNS name for this NIC used for internal communications between VMs in the same virtual network.␊ - */␊ - internalDnsNameLabel?: string␊ - /**␊ - * Fully qualified DNS name supporting internal communications between VMs in the same virtual network.␊ - */␊ - internalFqdn?: string␊ - /**␊ - * Even if internalDnsNameLabel is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internalDomainNameSuffix.␊ - */␊ - internalDomainNameSuffix?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables␊ - */␊ - export interface RouteTables9 {␊ - name: string␊ - type: "Microsoft.Network/routeTables"␊ - apiVersion: "2017-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the route table.␊ - */␊ - properties: (RouteTablePropertiesFormat1 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: RouteTablesRoutesChildResource1[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Table resource␊ - */␊ - export interface RouteTablePropertiesFormat1 {␊ - /**␊ - * Collection of routes contained within a route table.␊ - */␊ - routes?: (Route1[] | string)␊ - /**␊ - * The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource␊ - */␊ - export interface Route1 {␊ - /**␊ - * Properties of the route.␊ - */␊ - properties?: (RoutePropertiesFormat1 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource␊ - */␊ - export interface RoutePropertiesFormat1 {␊ - /**␊ - * The destination CIDR to which the route applies.␊ - */␊ - addressPrefix: string␊ - /**␊ - * The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'.␊ - */␊ - nextHopType: (("VirtualNetworkGateway" | "VnetLocal" | "Internet" | "VirtualAppliance" | "None") | string)␊ - /**␊ - * The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.␊ - */␊ - nextHopIpAddress?: string␊ - /**␊ - * The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutesChildResource1 {␊ - name: string␊ - type: "routes"␊ - apiVersion: "2017-08-01"␊ - /**␊ - * Properties of the route.␊ - */␊ - properties: (RoutePropertiesFormat1 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/applicationGateways␊ - */␊ - export interface ApplicationGateways1 {␊ - name: string␊ - type: "Microsoft.Network/applicationGateways"␊ - apiVersion: "2017-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (ApplicationGatewayPropertiesFormat1 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application gateway.␊ - */␊ - export interface ApplicationGatewayPropertiesFormat1 {␊ - /**␊ - * SKU of the application gateway resource.␊ - */␊ - sku?: (ApplicationGatewaySku1 | string)␊ - /**␊ - * SSL policy of the application gateway resource.␊ - */␊ - sslPolicy?: (ApplicationGatewaySslPolicy1 | string)␊ - /**␊ - * Subnets of application the gateway resource.␊ - */␊ - gatewayIPConfigurations?: (ApplicationGatewayIPConfiguration1[] | string)␊ - /**␊ - * Authentication certificates of the application gateway resource.␊ - */␊ - authenticationCertificates?: (ApplicationGatewayAuthenticationCertificate1[] | string)␊ - /**␊ - * SSL certificates of the application gateway resource.␊ - */␊ - sslCertificates?: (ApplicationGatewaySslCertificate1[] | string)␊ - /**␊ - * Frontend IP addresses of the application gateway resource.␊ - */␊ - frontendIPConfigurations?: (ApplicationGatewayFrontendIPConfiguration1[] | string)␊ - /**␊ - * Frontend ports of the application gateway resource.␊ - */␊ - frontendPorts?: (ApplicationGatewayFrontendPort1[] | string)␊ - /**␊ - * Probes of the application gateway resource.␊ - */␊ - probes?: (ApplicationGatewayProbe1[] | string)␊ - /**␊ - * Backend address pool of the application gateway resource.␊ - */␊ - backendAddressPools?: (ApplicationGatewayBackendAddressPool1[] | string)␊ - /**␊ - * Backend http settings of the application gateway resource.␊ - */␊ - backendHttpSettingsCollection?: (ApplicationGatewayBackendHttpSettings1[] | string)␊ - /**␊ - * Http listeners of the application gateway resource.␊ - */␊ - httpListeners?: (ApplicationGatewayHttpListener1[] | string)␊ - /**␊ - * URL path map of the application gateway resource.␊ - */␊ - urlPathMaps?: (ApplicationGatewayUrlPathMap1[] | string)␊ - /**␊ - * Request routing rules of the application gateway resource.␊ - */␊ - requestRoutingRules?: (ApplicationGatewayRequestRoutingRule1[] | string)␊ - /**␊ - * Redirect configurations of the application gateway resource.␊ - */␊ - redirectConfigurations?: (ApplicationGatewayRedirectConfiguration1[] | string)␊ - /**␊ - * Web application firewall configuration.␊ - */␊ - webApplicationFirewallConfiguration?: (ApplicationGatewayWebApplicationFirewallConfiguration1 | string)␊ - /**␊ - * Resource GUID property of the application gateway resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of an application gateway␊ - */␊ - export interface ApplicationGatewaySku1 {␊ - /**␊ - * Name of an application gateway SKU.␊ - */␊ - name?: (("Standard_Small" | "Standard_Medium" | "Standard_Large" | "WAF_Medium" | "WAF_Large") | string)␊ - /**␊ - * Tier of an application gateway.␊ - */␊ - tier?: (("Standard" | "WAF") | string)␊ - /**␊ - * Capacity (instance count) of an application gateway.␊ - */␊ - capacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application Gateway Ssl policy.␊ - */␊ - export interface ApplicationGatewaySslPolicy1 {␊ - /**␊ - * Ssl protocols to be disabled on application gateway.␊ - */␊ - disabledSslProtocols?: (("TLSv1_0" | "TLSv1_1" | "TLSv1_2")[] | string)␊ - /**␊ - * Type of Ssl Policy.␊ - */␊ - policyType?: (("Predefined" | "Custom") | string)␊ - /**␊ - * Name of Ssl predefined policy.␊ - */␊ - policyName?: (("AppGwSslPolicy20150501" | "AppGwSslPolicy20170401" | "AppGwSslPolicy20170401S") | string)␊ - /**␊ - * Ssl cipher suites to be enabled in the specified order to application gateway.␊ - */␊ - cipherSuites?: (("TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384" | "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256" | "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA" | "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA" | "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384" | "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256" | "TLS_DHE_RSA_WITH_AES_256_CBC_SHA" | "TLS_DHE_RSA_WITH_AES_128_CBC_SHA" | "TLS_RSA_WITH_AES_256_GCM_SHA384" | "TLS_RSA_WITH_AES_128_GCM_SHA256" | "TLS_RSA_WITH_AES_256_CBC_SHA256" | "TLS_RSA_WITH_AES_128_CBC_SHA256" | "TLS_RSA_WITH_AES_256_CBC_SHA" | "TLS_RSA_WITH_AES_128_CBC_SHA" | "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384" | "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256" | "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384" | "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256" | "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA" | "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA" | "TLS_DHE_DSS_WITH_AES_256_CBC_SHA256" | "TLS_DHE_DSS_WITH_AES_128_CBC_SHA256" | "TLS_DHE_DSS_WITH_AES_256_CBC_SHA" | "TLS_DHE_DSS_WITH_AES_128_CBC_SHA" | "TLS_RSA_WITH_3DES_EDE_CBC_SHA" | "TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA" | "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256" | "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384")[] | string)␊ - /**␊ - * Minimum version of Ssl protocol to be supported on application gateway.␊ - */␊ - minProtocolVersion?: (("TLSv1_0" | "TLSv1_1" | "TLSv1_2") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed.␊ - */␊ - export interface ApplicationGatewayIPConfiguration1 {␊ - properties?: (ApplicationGatewayIPConfigurationPropertiesFormat1 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayIPConfigurationPropertiesFormat1 {␊ - /**␊ - * Reference of the subnet resource. A subnet from where application gateway gets its private address.␊ - */␊ - subnet?: (SubResource6 | string)␊ - /**␊ - * Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authentication certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewayAuthenticationCertificate1 {␊ - properties?: (ApplicationGatewayAuthenticationCertificatePropertiesFormat1 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authentication certificates properties of an application gateway.␊ - */␊ - export interface ApplicationGatewayAuthenticationCertificatePropertiesFormat1 {␊ - /**␊ - * Certificate public data.␊ - */␊ - data?: string␊ - /**␊ - * Provisioning state of the authentication certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSL certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewaySslCertificate1 {␊ - properties?: (ApplicationGatewaySslCertificatePropertiesFormat1 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewaySslCertificatePropertiesFormat1 {␊ - /**␊ - * Base-64 encoded pfx certificate. Only applicable in PUT Request.␊ - */␊ - data?: string␊ - /**␊ - * Password for the pfx file specified in data. Only applicable in PUT request.␊ - */␊ - password?: string␊ - /**␊ - * Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request.␊ - */␊ - publicCertData?: string␊ - /**␊ - * Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendIPConfiguration1 {␊ - properties?: (ApplicationGatewayFrontendIPConfigurationPropertiesFormat1 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendIPConfigurationPropertiesFormat1 {␊ - /**␊ - * PrivateIPAddress of the network interface IP Configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * PrivateIP allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Reference of the subnet resource.␊ - */␊ - subnet?: (SubResource6 | string)␊ - /**␊ - * Reference of the PublicIP resource.␊ - */␊ - publicIPAddress?: (SubResource6 | string)␊ - /**␊ - * Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend port of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendPort1 {␊ - properties?: (ApplicationGatewayFrontendPortPropertiesFormat1 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend port of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendPortPropertiesFormat1 {␊ - /**␊ - * Frontend port␊ - */␊ - port?: (number | string)␊ - /**␊ - * Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Probe of the application gateway.␊ - */␊ - export interface ApplicationGatewayProbe1 {␊ - properties?: (ApplicationGatewayProbePropertiesFormat1 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of probe of an application gateway.␊ - */␊ - export interface ApplicationGatewayProbePropertiesFormat1 {␊ - /**␊ - * Protocol.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Host name to send the probe to.␊ - */␊ - host?: string␊ - /**␊ - * Relative path of probe. Valid path starts from '/'. Probe is sent to ://:␊ - */␊ - path?: string␊ - /**␊ - * The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - interval?: (number | string)␊ - /**␊ - * the probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - timeout?: (number | string)␊ - /**␊ - * The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20.␊ - */␊ - unhealthyThreshold?: (number | string)␊ - /**␊ - * Whether the host header should be picked from the backend http settings. Default value is false.␊ - */␊ - pickHostNameFromBackendHttpSettings?: (boolean | string)␊ - /**␊ - * Minimum number of servers that are always marked healthy. Default value is 0.␊ - */␊ - minServers?: (number | string)␊ - /**␊ - * Criterion for classifying a healthy probe response.␊ - */␊ - match?: (ApplicationGatewayProbeHealthResponseMatch1 | string)␊ - /**␊ - * Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application gateway probe health response match␊ - */␊ - export interface ApplicationGatewayProbeHealthResponseMatch1 {␊ - /**␊ - * Body that must be contained in the health response. Default value is empty.␊ - */␊ - body?: string␊ - /**␊ - * Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399.␊ - */␊ - statusCodes?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend Address Pool of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddressPool1 {␊ - properties?: (ApplicationGatewayBackendAddressPoolPropertiesFormat1 | string)␊ - /**␊ - * Resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend Address Pool of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddressPoolPropertiesFormat1 {␊ - /**␊ - * Collection of references to IPs defined in network interfaces.␊ - */␊ - backendIPConfigurations?: (SubResource6[] | string)␊ - /**␊ - * Backend addresses␊ - */␊ - backendAddresses?: (ApplicationGatewayBackendAddress1[] | string)␊ - /**␊ - * Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddress1 {␊ - /**␊ - * Fully qualified domain name (FQDN).␊ - */␊ - fqdn?: string␊ - /**␊ - * IP address␊ - */␊ - ipAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address pool settings of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendHttpSettings1 {␊ - properties?: (ApplicationGatewayBackendHttpSettingsPropertiesFormat1 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend address pool settings of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendHttpSettingsPropertiesFormat1 {␊ - /**␊ - * Port␊ - */␊ - port?: (number | string)␊ - /**␊ - * Protocol.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Cookie based affinity.␊ - */␊ - cookieBasedAffinity?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Request timeout in seconds. Application Gateway will fail the request if response is not received within RequestTimeout. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - requestTimeout?: (number | string)␊ - /**␊ - * Probe resource of an application gateway.␊ - */␊ - probe?: (SubResource6 | string)␊ - /**␊ - * Array of references to application gateway authentication certificates.␊ - */␊ - authenticationCertificates?: (SubResource6[] | string)␊ - /**␊ - * Connection draining of the backend http settings resource.␊ - */␊ - connectionDraining?: (ApplicationGatewayConnectionDraining1 | string)␊ - /**␊ - * Host header to be sent to the backend servers.␊ - */␊ - hostName?: string␊ - /**␊ - * Whether to pick host header should be picked from the host name of the backend server. Default value is false.␊ - */␊ - pickHostNameFromBackendAddress?: (boolean | string)␊ - /**␊ - * Cookie name to use for the affinity cookie.␊ - */␊ - affinityCookieName?: string␊ - /**␊ - * Whether the probe is enabled. Default value is false.␊ - */␊ - probeEnabled?: (boolean | string)␊ - /**␊ - * Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null.␊ - */␊ - path?: string␊ - /**␊ - * Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Connection draining allows open connections to a backend server to be active for a specified time after the backend server got removed from the configuration.␊ - */␊ - export interface ApplicationGatewayConnectionDraining1 {␊ - /**␊ - * Whether connection draining is enabled or not.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds.␊ - */␊ - drainTimeoutInSec: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http listener of an application gateway.␊ - */␊ - export interface ApplicationGatewayHttpListener1 {␊ - properties?: (ApplicationGatewayHttpListenerPropertiesFormat1 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of HTTP listener of an application gateway.␊ - */␊ - export interface ApplicationGatewayHttpListenerPropertiesFormat1 {␊ - /**␊ - * Frontend IP configuration resource of an application gateway.␊ - */␊ - frontendIPConfiguration?: (SubResource6 | string)␊ - /**␊ - * Frontend port resource of an application gateway.␊ - */␊ - frontendPort?: (SubResource6 | string)␊ - /**␊ - * Protocol.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Host name of HTTP listener.␊ - */␊ - hostName?: string␊ - /**␊ - * SSL certificate resource of an application gateway.␊ - */␊ - sslCertificate?: (SubResource6 | string)␊ - /**␊ - * Applicable only if protocol is https. Enables SNI for multi-hosting.␊ - */␊ - requireServerNameIndication?: (boolean | string)␊ - /**␊ - * Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * UrlPathMaps give a url path to the backend mapping information for PathBasedRouting.␊ - */␊ - export interface ApplicationGatewayUrlPathMap1 {␊ - properties?: (ApplicationGatewayUrlPathMapPropertiesFormat1 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of UrlPathMap of the application gateway.␊ - */␊ - export interface ApplicationGatewayUrlPathMapPropertiesFormat1 {␊ - /**␊ - * Default backend address pool resource of URL path map.␊ - */␊ - defaultBackendAddressPool?: (SubResource6 | string)␊ - /**␊ - * Default backend http settings resource of URL path map.␊ - */␊ - defaultBackendHttpSettings?: (SubResource6 | string)␊ - /**␊ - * Default redirect configuration resource of URL path map.␊ - */␊ - defaultRedirectConfiguration?: (SubResource6 | string)␊ - /**␊ - * Path rule of URL path map resource.␊ - */␊ - pathRules?: (ApplicationGatewayPathRule1[] | string)␊ - /**␊ - * Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Path rule of URL path map of an application gateway.␊ - */␊ - export interface ApplicationGatewayPathRule1 {␊ - properties?: (ApplicationGatewayPathRulePropertiesFormat1 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of path rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayPathRulePropertiesFormat1 {␊ - /**␊ - * Path rules of URL path map.␊ - */␊ - paths?: (string[] | string)␊ - /**␊ - * Backend address pool resource of URL path map path rule.␊ - */␊ - backendAddressPool?: (SubResource6 | string)␊ - /**␊ - * Backend http settings resource of URL path map path rule.␊ - */␊ - backendHttpSettings?: (SubResource6 | string)␊ - /**␊ - * Redirect configuration resource of URL path map path rule.␊ - */␊ - redirectConfiguration?: (SubResource6 | string)␊ - /**␊ - * Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Request routing rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayRequestRoutingRule1 {␊ - properties?: (ApplicationGatewayRequestRoutingRulePropertiesFormat1 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of request routing rule of the application gateway.␊ - */␊ - export interface ApplicationGatewayRequestRoutingRulePropertiesFormat1 {␊ - /**␊ - * Rule type.␊ - */␊ - ruleType?: (("Basic" | "PathBasedRouting") | string)␊ - /**␊ - * Backend address pool resource of the application gateway. ␊ - */␊ - backendAddressPool?: (SubResource6 | string)␊ - /**␊ - * Frontend port resource of the application gateway.␊ - */␊ - backendHttpSettings?: (SubResource6 | string)␊ - /**␊ - * Http listener resource of the application gateway. ␊ - */␊ - httpListener?: (SubResource6 | string)␊ - /**␊ - * URL path map resource of the application gateway.␊ - */␊ - urlPathMap?: (SubResource6 | string)␊ - /**␊ - * Redirect configuration resource of the application gateway.␊ - */␊ - redirectConfiguration?: (SubResource6 | string)␊ - /**␊ - * Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Redirect configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayRedirectConfiguration1 {␊ - properties?: (ApplicationGatewayRedirectConfigurationPropertiesFormat1 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of redirect configuration of the application gateway.␊ - */␊ - export interface ApplicationGatewayRedirectConfigurationPropertiesFormat1 {␊ - /**␊ - * Supported http redirection types - Permanent, Temporary, Found, SeeOther.␊ - */␊ - redirectType?: (("Permanent" | "Found" | "SeeOther" | "Temporary") | string)␊ - /**␊ - * Reference to a listener to redirect the request to.␊ - */␊ - targetListener?: (SubResource6 | string)␊ - /**␊ - * Url to redirect the request to.␊ - */␊ - targetUrl?: string␊ - /**␊ - * Include path in the redirected url.␊ - */␊ - includePath?: (boolean | string)␊ - /**␊ - * Include query string in the redirected url.␊ - */␊ - includeQueryString?: (boolean | string)␊ - /**␊ - * Request routing specifying redirect configuration.␊ - */␊ - requestRoutingRules?: (SubResource6[] | string)␊ - /**␊ - * Url path maps specifying default redirect configuration.␊ - */␊ - urlPathMaps?: (SubResource6[] | string)␊ - /**␊ - * Path rules specifying redirect configuration.␊ - */␊ - pathRules?: (SubResource6[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application gateway web application firewall configuration.␊ - */␊ - export interface ApplicationGatewayWebApplicationFirewallConfiguration1 {␊ - /**␊ - * Whether the web application firewall is enabled or not.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * Web application firewall mode.␊ - */␊ - firewallMode: (("Detection" | "Prevention") | string)␊ - /**␊ - * The type of the web application firewall rule set. Possible values are: 'OWASP'.␊ - */␊ - ruleSetType: string␊ - /**␊ - * The version of the rule set type.␊ - */␊ - ruleSetVersion: string␊ - /**␊ - * The disabled rule groups.␊ - */␊ - disabledRuleGroups?: (ApplicationGatewayFirewallDisabledRuleGroup1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allows to disable rules within a rule group or an entire rule group.␊ - */␊ - export interface ApplicationGatewayFirewallDisabledRuleGroup1 {␊ - /**␊ - * The name of the rule group that will be disabled.␊ - */␊ - ruleGroupName: string␊ - /**␊ - * The list of rules that will be disabled. If null, all rules of the rule group will be disabled.␊ - */␊ - rules?: (number[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/connections␊ - */␊ - export interface Connections1 {␊ - name: string␊ - type: "Microsoft.Network/connections"␊ - apiVersion: "2017-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway connection.␊ - */␊ - properties: (VirtualNetworkGatewayConnectionPropertiesFormat1 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewayConnection properties␊ - */␊ - export interface VirtualNetworkGatewayConnectionPropertiesFormat1 {␊ - /**␊ - * The authorizationKey.␊ - */␊ - authorizationKey?: string␊ - /**␊ - * The reference to virtual network gateway resource.␊ - */␊ - virtualNetworkGateway1: (VirtualNetworkGateway1 | SubResource6 | string)␊ - /**␊ - * The reference to virtual network gateway resource.␊ - */␊ - virtualNetworkGateway2?: (VirtualNetworkGateway1 | SubResource6 | string)␊ - /**␊ - * The reference to local network gateway resource.␊ - */␊ - localNetworkGateway2?: (LocalNetworkGateway1 | SubResource6 | string)␊ - /**␊ - * Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.␊ - */␊ - connectionType: (("IPsec" | "Vnet2Vnet" | "ExpressRoute" | "VPNClient") | string)␊ - /**␊ - * The routing weight.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * The IPSec shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The reference to peerings resource.␊ - */␊ - peer?: (SubResource6 | string)␊ - /**␊ - * EnableBgp flag␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * Enable policy-based traffic selectors.␊ - */␊ - usePolicyBasedTrafficSelectors?: (boolean | string)␊ - /**␊ - * The IPSec Policies to be considered by this connection.␊ - */␊ - ipsecPolicies?: (IpsecPolicy1[] | string)␊ - /**␊ - * The resource GUID property of the VirtualNetworkGatewayConnection resource.␊ - */␊ - resourceGuid?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A common class for general resource information␊ - */␊ - export interface VirtualNetworkGateway1 {␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway.␊ - */␊ - properties: (VirtualNetworkGatewayPropertiesFormat1 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGateway properties␊ - */␊ - export interface VirtualNetworkGatewayPropertiesFormat1 {␊ - /**␊ - * IP configurations for virtual network gateway.␊ - */␊ - ipConfigurations?: (VirtualNetworkGatewayIPConfiguration1[] | string)␊ - /**␊ - * The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'.␊ - */␊ - gatewayType?: (("Vpn" | "ExpressRoute") | string)␊ - /**␊ - * The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'.␊ - */␊ - vpnType?: (("PolicyBased" | "RouteBased") | string)␊ - /**␊ - * Whether BGP is enabled for this virtual network gateway or not.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * ActiveActive flag␊ - */␊ - activeActive?: (boolean | string)␊ - /**␊ - * The reference of the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting.␊ - */␊ - gatewayDefaultSite?: (SubResource6 | string)␊ - /**␊ - * The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.␊ - */␊ - sku?: (VirtualNetworkGatewaySku1 | string)␊ - /**␊ - * The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations.␊ - */␊ - vpnClientConfiguration?: (VpnClientConfiguration1 | string)␊ - /**␊ - * Virtual network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings1 | string)␊ - /**␊ - * The resource GUID property of the VirtualNetworkGateway resource.␊ - */␊ - resourceGuid?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration for virtual network gateway␊ - */␊ - export interface VirtualNetworkGatewayIPConfiguration1 {␊ - /**␊ - * Properties of the virtual network gateway ip configuration.␊ - */␊ - properties?: (VirtualNetworkGatewayIPConfigurationPropertiesFormat1 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of VirtualNetworkGatewayIPConfiguration␊ - */␊ - export interface VirtualNetworkGatewayIPConfigurationPropertiesFormat1 {␊ - /**␊ - * The private IP allocation method. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * The reference of the subnet resource.␊ - */␊ - subnet?: (SubResource6 | string)␊ - /**␊ - * The reference of the public IP resource.␊ - */␊ - publicIPAddress?: (SubResource6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewaySku details␊ - */␊ - export interface VirtualNetworkGatewaySku1 {␊ - /**␊ - * Gateway SKU name.␊ - */␊ - name?: (("Basic" | "HighPerformance" | "Standard" | "UltraPerformance" | "VpnGw1" | "VpnGw2" | "VpnGw3") | string)␊ - /**␊ - * Gateway SKU tier.␊ - */␊ - tier?: (("Basic" | "HighPerformance" | "Standard" | "UltraPerformance" | "VpnGw1" | "VpnGw2" | "VpnGw3") | string)␊ - /**␊ - * The capacity.␊ - */␊ - capacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnClientConfiguration for P2S client.␊ - */␊ - export interface VpnClientConfiguration1 {␊ - /**␊ - * The reference of the address space resource which represents Address space for P2S VpnClient.␊ - */␊ - vpnClientAddressPool?: (AddressSpace9 | string)␊ - /**␊ - * VpnClientRootCertificate for virtual network gateway.␊ - */␊ - vpnClientRootCertificates?: (VpnClientRootCertificate1[] | string)␊ - /**␊ - * VpnClientRevokedCertificate for Virtual network gateway.␊ - */␊ - vpnClientRevokedCertificates?: (VpnClientRevokedCertificate1[] | string)␊ - /**␊ - * VpnClientProtocols for Virtual network gateway.␊ - */␊ - vpnClientProtocols?: (("IkeV2" | "SSTP")[] | string)␊ - /**␊ - * The radius server address property of the VirtualNetworkGateway resource for vpn client connection.␊ - */␊ - radiusServerAddress?: string␊ - /**␊ - * The radius secret property of the VirtualNetworkGateway resource for vpn client connection.␊ - */␊ - radiusServerSecret?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client root certificate of virtual network gateway␊ - */␊ - export interface VpnClientRootCertificate1 {␊ - /**␊ - * Properties of the vpn client root certificate.␊ - */␊ - properties: (VpnClientRootCertificatePropertiesFormat1 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of application gateway␊ - */␊ - export interface VpnClientRootCertificatePropertiesFormat1 {␊ - /**␊ - * The certificate public data.␊ - */␊ - publicCertData: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client revoked certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRevokedCertificate1 {␊ - /**␊ - * Properties of the vpn client revoked certificate.␊ - */␊ - properties?: (VpnClientRevokedCertificatePropertiesFormat1 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the revoked VPN client certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRevokedCertificatePropertiesFormat1 {␊ - /**␊ - * The revoked VPN client certificate thumbprint.␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * BGP settings details␊ - */␊ - export interface BgpSettings1 {␊ - /**␊ - * The BGP speaker's ASN.␊ - */␊ - asn?: (number | string)␊ - /**␊ - * The BGP peering address and BGP identifier of this BGP speaker.␊ - */␊ - bgpPeeringAddress?: string␊ - /**␊ - * The weight added to routes learned from this BGP speaker.␊ - */␊ - peerWeight?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A common class for general resource information␊ - */␊ - export interface LocalNetworkGateway1 {␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the local network gateway.␊ - */␊ - properties: (LocalNetworkGatewayPropertiesFormat1 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * LocalNetworkGateway properties␊ - */␊ - export interface LocalNetworkGatewayPropertiesFormat1 {␊ - /**␊ - * Local network site address space.␊ - */␊ - localNetworkAddressSpace?: (AddressSpace9 | string)␊ - /**␊ - * IP address of local network gateway.␊ - */␊ - gatewayIpAddress?: string␊ - /**␊ - * Local network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings1 | string)␊ - /**␊ - * The resource GUID property of the LocalNetworkGateway resource.␊ - */␊ - resourceGuid?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An IPSec Policy configuration for a virtual network gateway connection␊ - */␊ - export interface IpsecPolicy1 {␊ - /**␊ - * The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.␊ - */␊ - saLifeTimeSeconds: (number | string)␊ - /**␊ - * The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.␊ - */␊ - saDataSizeKilobytes: (number | string)␊ - /**␊ - * The IPSec encryption algorithm (IKE phase 1).␊ - */␊ - ipsecEncryption: (("None" | "DES" | "DES3" | "AES128" | "AES192" | "AES256" | "GCMAES128" | "GCMAES192" | "GCMAES256") | string)␊ - /**␊ - * The IPSec integrity algorithm (IKE phase 1).␊ - */␊ - ipsecIntegrity: (("MD5" | "SHA1" | "SHA256" | "GCMAES128" | "GCMAES192" | "GCMAES256") | string)␊ - /**␊ - * The IKE encryption algorithm (IKE phase 2).␊ - */␊ - ikeEncryption: (("DES" | "DES3" | "AES128" | "AES192" | "AES256") | string)␊ - /**␊ - * The IKE integrity algorithm (IKE phase 2).␊ - */␊ - ikeIntegrity: (("MD5" | "SHA1" | "SHA256" | "SHA384") | string)␊ - /**␊ - * The DH Groups used in IKE Phase 1 for initial SA.␊ - */␊ - dhGroup: (("None" | "DHGroup1" | "DHGroup2" | "DHGroup14" | "DHGroup2048" | "ECP256" | "ECP384" | "DHGroup24") | string)␊ - /**␊ - * The DH Groups used in IKE Phase 2 for new child SA.␊ - */␊ - pfsGroup: (("None" | "PFS1" | "PFS2" | "PFS2048" | "ECP256" | "ECP384" | "PFS24") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/localNetworkGateways␊ - */␊ - export interface LocalNetworkGateways1 {␊ - name: string␊ - type: "Microsoft.Network/localNetworkGateways"␊ - apiVersion: "2017-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the local network gateway.␊ - */␊ - properties: (LocalNetworkGatewayPropertiesFormat1 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworkGateways␊ - */␊ - export interface VirtualNetworkGateways1 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworkGateways"␊ - apiVersion: "2017-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway.␊ - */␊ - properties: (VirtualNetworkGatewayPropertiesFormat1 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnets1 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks/subnets"␊ - apiVersion: "2017-08-01"␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties: (SubnetPropertiesFormat1 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/virtualNetworkPeerings␊ - */␊ - export interface VirtualNetworksVirtualNetworkPeerings1 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks/virtualNetworkPeerings"␊ - apiVersion: "2017-08-01"␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties: (VirtualNetworkPeeringPropertiesFormat1 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers/inboundNatRules␊ - */␊ - export interface LoadBalancersInboundNatRules {␊ - name: string␊ - type: "Microsoft.Network/loadBalancers/inboundNatRules"␊ - apiVersion: "2017-08-01"␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties: (InboundNatRulePropertiesFormat1 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRules1 {␊ - name: string␊ - type: "Microsoft.Network/networkSecurityGroups/securityRules"␊ - apiVersion: "2017-08-01"␊ - /**␊ - * Properties of the security rule␊ - */␊ - properties: (SecurityRulePropertiesFormat1 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutes1 {␊ - name: string␊ - type: "Microsoft.Network/routeTables/routes"␊ - apiVersion: "2017-08-01"␊ - /**␊ - * Properties of the route.␊ - */␊ - properties: (RoutePropertiesFormat1 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/publicIPAddresses␊ - */␊ - export interface PublicIPAddresses10 {␊ - name: string␊ - type: "Microsoft.Network/publicIPAddresses"␊ - apiVersion: "2017-09-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The public IP address SKU.␊ - */␊ - sku?: (PublicIPAddressSku1 | string)␊ - /**␊ - * Public IP address properties.␊ - */␊ - properties: (PublicIPAddressPropertiesFormat2 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a public IP address␊ - */␊ - export interface PublicIPAddressSku1 {␊ - /**␊ - * Name of a public IP address SKU.␊ - */␊ - name?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Public IP address properties.␊ - */␊ - export interface PublicIPAddressPropertiesFormat2 {␊ - /**␊ - * The public IP allocation method. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - publicIPAllocationMethod: (("Static" | "Dynamic") | string)␊ - /**␊ - * The public IP address version. Possible values are: 'IPv4' and 'IPv6'.␊ - */␊ - publicIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The FQDN of the DNS record associated with the public IP address.␊ - */␊ - dnsSettings?: (PublicIPAddressDnsSettings10 | string)␊ - /**␊ - * The IP address associated with the public IP address resource.␊ - */␊ - ipAddress?: string␊ - /**␊ - * The idle timeout of the public IP address.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * The resource GUID property of the public IP resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains FQDN of the DNS record associated with the public IP address␊ - */␊ - export interface PublicIPAddressDnsSettings10 {␊ - /**␊ - * Gets or sets the Domain name label.The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.␊ - */␊ - domainNameLabel: string␊ - /**␊ - * Gets the FQDN, Fully qualified domain name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone.␊ - */␊ - fqdn?: string␊ - /**␊ - * Gets or Sets the Reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN. ␊ - */␊ - reverseFqdn?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks␊ - */␊ - export interface VirtualNetworks10 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks"␊ - apiVersion: "2017-09-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network.␊ - */␊ - properties: (VirtualNetworkPropertiesFormat2 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: (VirtualNetworksVirtualNetworkPeeringsChildResource2 | VirtualNetworksSubnetsChildResource2)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the virtual network.␊ - */␊ - export interface VirtualNetworkPropertiesFormat2 {␊ - /**␊ - * The AddressSpace that contains an array of IP address ranges that can be used by subnets.␊ - */␊ - addressSpace: (AddressSpace10 | string)␊ - /**␊ - * The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network.␊ - */␊ - dhcpOptions?: (DhcpOptions10 | string)␊ - /**␊ - * A list of subnets in a Virtual Network.␊ - */␊ - subnets?: (Subnet12[] | string)␊ - /**␊ - * A list of peerings in a Virtual Network.␊ - */␊ - virtualNetworkPeerings?: (VirtualNetworkPeering10[] | string)␊ - /**␊ - * The resourceGuid property of the Virtual Network resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - /**␊ - * Indicates if DDoS protection is enabled for all the protected resources in a Virtual Network.␊ - */␊ - enableDdosProtection?: (boolean | string)␊ - /**␊ - * Indicates if Vm protection is enabled for all the subnets in a Virtual Network.␊ - */␊ - enableVmProtection?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.␊ - */␊ - export interface AddressSpace10 {␊ - /**␊ - * A list of address blocks reserved for this virtual network in CIDR notation.␊ - */␊ - addressPrefixes: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DhcpOptions contains an array of DNS servers available to VMs deployed in the virtual network. Standard DHCP option for a subnet overrides VNET DHCP options.␊ - */␊ - export interface DhcpOptions10 {␊ - /**␊ - * The list of DNS servers IP addresses.␊ - */␊ - dnsServers: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Subnet in a virtual network resource.␊ - */␊ - export interface Subnet12 {␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties?: (SubnetPropertiesFormat2 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the subnet.␊ - */␊ - export interface SubnetPropertiesFormat2 {␊ - /**␊ - * The address prefix for the subnet.␊ - */␊ - addressPrefix: string␊ - /**␊ - * The reference of the NetworkSecurityGroup resource.␊ - */␊ - networkSecurityGroup?: (SubResource7 | string)␊ - /**␊ - * The reference of the RouteTable resource.␊ - */␊ - routeTable?: (SubResource7 | string)␊ - /**␊ - * An array of service endpoints.␊ - */␊ - serviceEndpoints?: (ServiceEndpointPropertiesFormat1[] | string)␊ - /**␊ - * Gets an array of references to the external resources using subnet.␊ - */␊ - resourceNavigationLinks?: (ResourceNavigationLink2[] | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Reference to another subresource.␊ - */␊ - export interface SubResource7 {␊ - /**␊ - * Resource ID.␊ - */␊ - id: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The service endpoint properties.␊ - */␊ - export interface ServiceEndpointPropertiesFormat1 {␊ - /**␊ - * The type of the endpoint service.␊ - */␊ - service?: string␊ - /**␊ - * A list of locations.␊ - */␊ - locations?: (string[] | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ResourceNavigationLink resource.␊ - */␊ - export interface ResourceNavigationLink2 {␊ - /**␊ - * Resource navigation link properties format.␊ - */␊ - properties?: (ResourceNavigationLinkFormat2 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ResourceNavigationLink.␊ - */␊ - export interface ResourceNavigationLinkFormat2 {␊ - /**␊ - * Resource type of the linked resource.␊ - */␊ - linkedResourceType?: string␊ - /**␊ - * Link to the external resource␊ - */␊ - link?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peerings in a virtual network resource.␊ - */␊ - export interface VirtualNetworkPeering10 {␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties?: (VirtualNetworkPeeringPropertiesFormat2 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - export interface VirtualNetworkPeeringPropertiesFormat2 {␊ - /**␊ - * Whether the VMs in the linked virtual network space would be able to access all the VMs in local Virtual network space.␊ - */␊ - allowVirtualNetworkAccess?: (boolean | string)␊ - /**␊ - * Whether the forwarded traffic from the VMs in the remote virtual network will be allowed/disallowed.␊ - */␊ - allowForwardedTraffic?: (boolean | string)␊ - /**␊ - * If gateway links can be used in remote virtual networking to link to this virtual network.␊ - */␊ - allowGatewayTransit?: (boolean | string)␊ - /**␊ - * If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway.␊ - */␊ - useRemoteGateways?: (boolean | string)␊ - /**␊ - * The reference of the remote virtual network. The remote virtual network can be in the same or different region (preview). See here to register for the preview and learn more (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering).␊ - */␊ - remoteVirtualNetwork: (SubResource7 | string)␊ - /**␊ - * The reference of the remote virtual network address space.␊ - */␊ - remoteAddressSpace?: (AddressSpace10 | string)␊ - /**␊ - * The status of the virtual network peering. Possible values are 'Initiated', 'Connected', and 'Disconnected'.␊ - */␊ - peeringState?: (("Initiated" | "Connected" | "Disconnected") | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/virtualNetworkPeerings␊ - */␊ - export interface VirtualNetworksVirtualNetworkPeeringsChildResource2 {␊ - name: string␊ - type: "virtualNetworkPeerings"␊ - apiVersion: "2017-09-01"␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties: (VirtualNetworkPeeringPropertiesFormat2 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnetsChildResource2 {␊ - name: string␊ - type: "subnets"␊ - apiVersion: "2017-09-01"␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties: (SubnetPropertiesFormat2 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers␊ - */␊ - export interface LoadBalancers10 {␊ - name: string␊ - type: "Microsoft.Network/loadBalancers"␊ - apiVersion: "2017-09-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The load balancer SKU.␊ - */␊ - sku?: (LoadBalancerSku1 | string)␊ - /**␊ - * Properties of load balancer.␊ - */␊ - properties: (LoadBalancerPropertiesFormat2 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: LoadBalancersInboundNatRulesChildResource1[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a load balancer␊ - */␊ - export interface LoadBalancerSku1 {␊ - /**␊ - * Name of a load balancer SKU.␊ - */␊ - name?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer.␊ - */␊ - export interface LoadBalancerPropertiesFormat2 {␊ - /**␊ - * Object representing the frontend IPs to be used for the load balancer␊ - */␊ - frontendIPConfigurations?: (FrontendIPConfiguration2[] | string)␊ - /**␊ - * Collection of backend address pools used by a load balancer␊ - */␊ - backendAddressPools?: (BackendAddressPool2[] | string)␊ - /**␊ - * Object collection representing the load balancing rules Gets the provisioning ␊ - */␊ - loadBalancingRules?: (LoadBalancingRule2[] | string)␊ - /**␊ - * Collection of probe objects used in the load balancer␊ - */␊ - probes?: (Probe2[] | string)␊ - /**␊ - * Collection of inbound NAT Rules used by a load balancer. Defining inbound NAT rules on your load balancer is mutually exclusive with defining an inbound NAT pool. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an Inbound NAT pool. They have to reference individual inbound NAT rules.␊ - */␊ - inboundNatRules?: (InboundNatRule3[] | string)␊ - /**␊ - * Defines an external port range for inbound NAT to a single backend port on NICs associated with a load balancer. Inbound NAT rules are created automatically for each NIC associated with the Load Balancer using an external port from this range. Defining an Inbound NAT pool on your Load Balancer is mutually exclusive with defining inbound Nat rules. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an inbound NAT pool. They have to reference individual inbound NAT rules.␊ - */␊ - inboundNatPools?: (InboundNatPool3[] | string)␊ - /**␊ - * The outbound NAT rules.␊ - */␊ - outboundNatRules?: (OutboundNatRule2[] | string)␊ - /**␊ - * The resource GUID property of the load balancer resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP address of the load balancer.␊ - */␊ - export interface FrontendIPConfiguration2 {␊ - /**␊ - * Properties of the load balancer probe.␊ - */␊ - properties?: (FrontendIPConfigurationPropertiesFormat2 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP Configuration of the load balancer.␊ - */␊ - export interface FrontendIPConfigurationPropertiesFormat2 {␊ - /**␊ - * The private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The Private IP allocation method. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * The reference of the subnet resource.␊ - */␊ - subnet?: (SubResource7 | string)␊ - /**␊ - * The reference of the Public IP resource.␊ - */␊ - publicIPAddress?: (SubResource7 | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Pool of backend IP addresses.␊ - */␊ - export interface BackendAddressPool2 {␊ - /**␊ - * Properties of load balancer backend address pool.␊ - */␊ - properties?: (BackendAddressPoolPropertiesFormat2 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the backend address pool.␊ - */␊ - export interface BackendAddressPoolPropertiesFormat2 {␊ - /**␊ - * Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A load balancing rule for a load balancer.␊ - */␊ - export interface LoadBalancingRule2 {␊ - /**␊ - * Properties of load balancer load balancing rule.␊ - */␊ - properties?: (LoadBalancingRulePropertiesFormat2 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer.␊ - */␊ - export interface LoadBalancingRulePropertiesFormat2 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource7 | string)␊ - /**␊ - * A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs.␊ - */␊ - backendAddressPool?: (SubResource7 | string)␊ - /**␊ - * The reference of the load balancer probe used by the load balancing rule.␊ - */␊ - probe?: (SubResource7 | string)␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'.␊ - */␊ - loadDistribution?: (("Default" | "SourceIP" | "SourceIPProtocol") | string)␊ - /**␊ - * The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 0 and 65534. Note that value 0 enables "Any Port"␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port"␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule.␊ - */␊ - disableOutboundSnat?: (boolean | string)␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A load balancer probe.␊ - */␊ - export interface Probe2 {␊ - /**␊ - * Properties of load balancer probe.␊ - */␊ - properties?: (ProbePropertiesFormat2 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Load balancer probe resource.␊ - */␊ - export interface ProbePropertiesFormat2 {␊ - /**␊ - * The protocol of the end point. Possible values are: 'Http' or 'Tcp'. If 'Tcp' is specified, a received ACK is required for the probe to be successful. If 'Http' is specified, a 200 OK response from the specifies URI is required for the probe to be successful.␊ - */␊ - protocol: (("Http" | "Tcp") | string)␊ - /**␊ - * The port for communicating the probe. Possible values range from 1 to 65535, inclusive.␊ - */␊ - port: (number | string)␊ - /**␊ - * The interval, in seconds, for how frequently to probe the endpoint for health status. Typically, the interval is slightly less than half the allocated timeout period (in seconds) which allows two full probes before taking the instance out of rotation. The default value is 15, the minimum value is 5.␊ - */␊ - intervalInSeconds?: (number | string)␊ - /**␊ - * The number of probes where if no response, will result in stopping further traffic from being delivered to the endpoint. This values allows endpoints to be taken out of rotation faster or slower than the typical times used in Azure.␊ - */␊ - numberOfProbes: (number | string)␊ - /**␊ - * The URI used for requesting health status from the VM. Path is required if a protocol is set to http. Otherwise, it is not allowed. There is no default value.␊ - */␊ - requestPath?: string␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT rule of the load balancer.␊ - */␊ - export interface InboundNatRule3 {␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties?: (InboundNatRulePropertiesFormat2 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the inbound NAT rule.␊ - */␊ - export interface InboundNatRulePropertiesFormat2 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource7 | string)␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values range from 1 to 65534.␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * The port used for the internal endpoint. Acceptable values range from 1 to 65535.␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT pool of the load balancer.␊ - */␊ - export interface InboundNatPool3 {␊ - /**␊ - * Properties of load balancer inbound nat pool.␊ - */␊ - properties?: (InboundNatPoolPropertiesFormat2 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Inbound NAT pool.␊ - */␊ - export interface InboundNatPoolPropertiesFormat2 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource7 | string)␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65534.␊ - */␊ - frontendPortRangeStart: (number | string)␊ - /**␊ - * The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65535.␊ - */␊ - frontendPortRangeEnd: (number | string)␊ - /**␊ - * The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound NAT pool of the load balancer.␊ - */␊ - export interface OutboundNatRule2 {␊ - /**␊ - * Properties of load balancer outbound nat rule.␊ - */␊ - properties?: (OutboundNatRulePropertiesFormat2 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound NAT pool of the load balancer.␊ - */␊ - export interface OutboundNatRulePropertiesFormat2 {␊ - /**␊ - * The number of outbound ports to be used for NAT.␊ - */␊ - allocatedOutboundPorts?: (number | string)␊ - /**␊ - * The Frontend IP addresses of the load balancer.␊ - */␊ - frontendIPConfigurations?: (SubResource7[] | string)␊ - /**␊ - * A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs.␊ - */␊ - backendAddressPool: (SubResource7 | string)␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers/inboundNatRules␊ - */␊ - export interface LoadBalancersInboundNatRulesChildResource1 {␊ - name: string␊ - type: "inboundNatRules"␊ - apiVersion: "2017-09-01"␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties: (InboundNatRulePropertiesFormat2 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups␊ - */␊ - export interface NetworkSecurityGroups10 {␊ - name: string␊ - type: "Microsoft.Network/networkSecurityGroups"␊ - apiVersion: "2017-09-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network security group␊ - */␊ - properties: (NetworkSecurityGroupPropertiesFormat2 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: NetworkSecurityGroupsSecurityRulesChildResource2[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network Security Group resource.␊ - */␊ - export interface NetworkSecurityGroupPropertiesFormat2 {␊ - /**␊ - * A collection of security rules of the network security group.␊ - */␊ - securityRules?: (SecurityRule2[] | string)␊ - /**␊ - * The default security rules of network security group.␊ - */␊ - defaultSecurityRules?: (SecurityRule2[] | string)␊ - /**␊ - * The resource GUID property of the network security group resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network security rule.␊ - */␊ - export interface SecurityRule2 {␊ - /**␊ - * Properties of the security rule␊ - */␊ - properties?: (SecurityRulePropertiesFormat2 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Security rule resource.␊ - */␊ - export interface SecurityRulePropertiesFormat2 {␊ - /**␊ - * A description for this rule. Restricted to 140 chars.␊ - */␊ - description?: string␊ - /**␊ - * Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'.␊ - */␊ - protocol: (("Tcp" | "Udp" | "*") | string)␊ - /**␊ - * The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports.␊ - */␊ - sourcePortRange?: string␊ - /**␊ - * The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports.␊ - */␊ - destinationPortRange?: string␊ - /**␊ - * The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. ␊ - */␊ - sourceAddressPrefix?: string␊ - /**␊ - * The CIDR or source IP ranges.␊ - */␊ - sourceAddressPrefixes?: (string[] | string)␊ - /**␊ - * The application security group specified as source.␊ - */␊ - sourceApplicationSecurityGroups?: (ApplicationSecurityGroup[] | string)␊ - /**␊ - * The destination address prefix. CIDR or destination IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used.␊ - */␊ - destinationAddressPrefix?: string␊ - /**␊ - * The destination address prefixes. CIDR or destination IP ranges.␊ - */␊ - destinationAddressPrefixes?: (string[] | string)␊ - /**␊ - * The application security group specified as destination.␊ - */␊ - destinationApplicationSecurityGroups?: (ApplicationSecurityGroup[] | string)␊ - /**␊ - * The source port ranges.␊ - */␊ - sourcePortRanges?: (string[] | string)␊ - /**␊ - * The destination port ranges.␊ - */␊ - destinationPortRanges?: (string[] | string)␊ - /**␊ - * The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'.␊ - */␊ - access: (("Allow" | "Deny") | string)␊ - /**␊ - * The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.␊ - */␊ - priority: (number | string)␊ - /**␊ - * The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'.␊ - */␊ - direction: (("Inbound" | "Outbound") | string)␊ - /**␊ - * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An application security group in a resource group.␊ - */␊ - export interface ApplicationSecurityGroup {␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the application security group.␊ - */␊ - properties?: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRulesChildResource2 {␊ - name: string␊ - type: "securityRules"␊ - apiVersion: "2017-09-01"␊ - /**␊ - * Properties of the security rule␊ - */␊ - properties: (SecurityRulePropertiesFormat2 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces␊ - */␊ - export interface NetworkInterfaces11 {␊ - name: string␊ - type: "Microsoft.Network/networkInterfaces"␊ - apiVersion: "2017-09-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network interface.␊ - */␊ - properties: (NetworkInterfacePropertiesFormat2 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NetworkInterface properties. ␊ - */␊ - export interface NetworkInterfacePropertiesFormat2 {␊ - /**␊ - * The reference of the NetworkSecurityGroup resource.␊ - */␊ - networkSecurityGroup?: (SubResource7 | string)␊ - /**␊ - * A list of IPConfigurations of the network interface.␊ - */␊ - ipConfigurations: (NetworkInterfaceIPConfiguration2[] | string)␊ - /**␊ - * The DNS settings in network interface.␊ - */␊ - dnsSettings?: (NetworkInterfaceDnsSettings10 | string)␊ - /**␊ - * The MAC address of the network interface.␊ - */␊ - macAddress?: string␊ - /**␊ - * Gets whether this is a primary network interface on a virtual machine.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * If the network interface is accelerated networking enabled.␊ - */␊ - enableAcceleratedNetworking?: (boolean | string)␊ - /**␊ - * Indicates whether IP forwarding is enabled on this network interface.␊ - */␊ - enableIPForwarding?: (boolean | string)␊ - /**␊ - * The resource GUID property of the network interface resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IPConfiguration in a network interface.␊ - */␊ - export interface NetworkInterfaceIPConfiguration2 {␊ - /**␊ - * Network interface IP configuration properties.␊ - */␊ - properties?: (NetworkInterfaceIPConfigurationPropertiesFormat2 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration.␊ - */␊ - export interface NetworkInterfaceIPConfigurationPropertiesFormat2 {␊ - /**␊ - * The reference of ApplicationGatewayBackendAddressPool resource.␊ - */␊ - applicationGatewayBackendAddressPools?: (SubResource7[] | string)␊ - /**␊ - * The reference of LoadBalancerBackendAddressPool resource.␊ - */␊ - loadBalancerBackendAddressPools?: (SubResource7[] | string)␊ - /**␊ - * A list of references of LoadBalancerInboundNatRules.␊ - */␊ - loadBalancerInboundNatRules?: (SubResource7[] | string)␊ - /**␊ - * Private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * Defines how a private IP address is assigned. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Available from Api-Version 2016-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.␊ - */␊ - privateIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * Subnet bound to the IP configuration.␊ - */␊ - subnet?: (SubResource7 | string)␊ - /**␊ - * Gets whether this is a primary customer address on the network interface.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * Public IP address bound to the IP configuration.␊ - */␊ - publicIPAddress?: (SubResource7 | string)␊ - /**␊ - * Application security groups in which the IP configuration is included.␊ - */␊ - applicationSecurityGroups?: (SubResource7[] | string)␊ - /**␊ - * The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DNS settings of a network interface.␊ - */␊ - export interface NetworkInterfaceDnsSettings10 {␊ - /**␊ - * List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only value in dnsServers collection.␊ - */␊ - dnsServers?: (string[] | string)␊ - /**␊ - * If the VM that uses this NIC is part of an Availability Set, then this list will have the union of all DNS servers from all NICs that are part of the Availability Set. This property is what is configured on each of those VMs.␊ - */␊ - appliedDnsServers?: (string[] | string)␊ - /**␊ - * Relative DNS name for this NIC used for internal communications between VMs in the same virtual network.␊ - */␊ - internalDnsNameLabel?: string␊ - /**␊ - * Fully qualified DNS name supporting internal communications between VMs in the same virtual network.␊ - */␊ - internalFqdn?: string␊ - /**␊ - * Even if internalDnsNameLabel is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internalDomainNameSuffix.␊ - */␊ - internalDomainNameSuffix?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables␊ - */␊ - export interface RouteTables10 {␊ - name: string␊ - type: "Microsoft.Network/routeTables"␊ - apiVersion: "2017-09-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the route table.␊ - */␊ - properties: (RouteTablePropertiesFormat2 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: RouteTablesRoutesChildResource2[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Table resource␊ - */␊ - export interface RouteTablePropertiesFormat2 {␊ - /**␊ - * Collection of routes contained within a route table.␊ - */␊ - routes?: (Route2[] | string)␊ - /**␊ - * The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource␊ - */␊ - export interface Route2 {␊ - /**␊ - * Properties of the route.␊ - */␊ - properties?: (RoutePropertiesFormat2 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource␊ - */␊ - export interface RoutePropertiesFormat2 {␊ - /**␊ - * The destination CIDR to which the route applies.␊ - */␊ - addressPrefix: string␊ - /**␊ - * The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'.␊ - */␊ - nextHopType: (("VirtualNetworkGateway" | "VnetLocal" | "Internet" | "VirtualAppliance" | "None") | string)␊ - /**␊ - * The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.␊ - */␊ - nextHopIpAddress?: string␊ - /**␊ - * The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutesChildResource2 {␊ - name: string␊ - type: "routes"␊ - apiVersion: "2017-09-01"␊ - /**␊ - * Properties of the route.␊ - */␊ - properties: (RoutePropertiesFormat2 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/applicationGateways␊ - */␊ - export interface ApplicationGateways2 {␊ - name: string␊ - type: "Microsoft.Network/applicationGateways"␊ - apiVersion: "2017-09-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (ApplicationGatewayPropertiesFormat2 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application gateway.␊ - */␊ - export interface ApplicationGatewayPropertiesFormat2 {␊ - /**␊ - * SKU of the application gateway resource.␊ - */␊ - sku?: (ApplicationGatewaySku2 | string)␊ - /**␊ - * SSL policy of the application gateway resource.␊ - */␊ - sslPolicy?: (ApplicationGatewaySslPolicy2 | string)␊ - /**␊ - * Subnets of application the gateway resource.␊ - */␊ - gatewayIPConfigurations?: (ApplicationGatewayIPConfiguration2[] | string)␊ - /**␊ - * Authentication certificates of the application gateway resource.␊ - */␊ - authenticationCertificates?: (ApplicationGatewayAuthenticationCertificate2[] | string)␊ - /**␊ - * SSL certificates of the application gateway resource.␊ - */␊ - sslCertificates?: (ApplicationGatewaySslCertificate2[] | string)␊ - /**␊ - * Frontend IP addresses of the application gateway resource.␊ - */␊ - frontendIPConfigurations?: (ApplicationGatewayFrontendIPConfiguration2[] | string)␊ - /**␊ - * Frontend ports of the application gateway resource.␊ - */␊ - frontendPorts?: (ApplicationGatewayFrontendPort2[] | string)␊ - /**␊ - * Probes of the application gateway resource.␊ - */␊ - probes?: (ApplicationGatewayProbe2[] | string)␊ - /**␊ - * Backend address pool of the application gateway resource.␊ - */␊ - backendAddressPools?: (ApplicationGatewayBackendAddressPool2[] | string)␊ - /**␊ - * Backend http settings of the application gateway resource.␊ - */␊ - backendHttpSettingsCollection?: (ApplicationGatewayBackendHttpSettings2[] | string)␊ - /**␊ - * Http listeners of the application gateway resource.␊ - */␊ - httpListeners?: (ApplicationGatewayHttpListener2[] | string)␊ - /**␊ - * URL path map of the application gateway resource.␊ - */␊ - urlPathMaps?: (ApplicationGatewayUrlPathMap2[] | string)␊ - /**␊ - * Request routing rules of the application gateway resource.␊ - */␊ - requestRoutingRules?: (ApplicationGatewayRequestRoutingRule2[] | string)␊ - /**␊ - * Redirect configurations of the application gateway resource.␊ - */␊ - redirectConfigurations?: (ApplicationGatewayRedirectConfiguration2[] | string)␊ - /**␊ - * Web application firewall configuration.␊ - */␊ - webApplicationFirewallConfiguration?: (ApplicationGatewayWebApplicationFirewallConfiguration2 | string)␊ - /**␊ - * Resource GUID property of the application gateway resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of an application gateway␊ - */␊ - export interface ApplicationGatewaySku2 {␊ - /**␊ - * Name of an application gateway SKU.␊ - */␊ - name?: (("Standard_Small" | "Standard_Medium" | "Standard_Large" | "WAF_Medium" | "WAF_Large") | string)␊ - /**␊ - * Tier of an application gateway.␊ - */␊ - tier?: (("Standard" | "WAF") | string)␊ - /**␊ - * Capacity (instance count) of an application gateway.␊ - */␊ - capacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application Gateway Ssl policy.␊ - */␊ - export interface ApplicationGatewaySslPolicy2 {␊ - /**␊ - * Ssl protocols to be disabled on application gateway.␊ - */␊ - disabledSslProtocols?: (("TLSv1_0" | "TLSv1_1" | "TLSv1_2")[] | string)␊ - /**␊ - * Type of Ssl Policy.␊ - */␊ - policyType?: (("Predefined" | "Custom") | string)␊ - /**␊ - * Name of Ssl predefined policy.␊ - */␊ - policyName?: (("AppGwSslPolicy20150501" | "AppGwSslPolicy20170401" | "AppGwSslPolicy20170401S") | string)␊ - /**␊ - * Ssl cipher suites to be enabled in the specified order to application gateway.␊ - */␊ - cipherSuites?: (("TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384" | "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256" | "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA" | "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA" | "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384" | "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256" | "TLS_DHE_RSA_WITH_AES_256_CBC_SHA" | "TLS_DHE_RSA_WITH_AES_128_CBC_SHA" | "TLS_RSA_WITH_AES_256_GCM_SHA384" | "TLS_RSA_WITH_AES_128_GCM_SHA256" | "TLS_RSA_WITH_AES_256_CBC_SHA256" | "TLS_RSA_WITH_AES_128_CBC_SHA256" | "TLS_RSA_WITH_AES_256_CBC_SHA" | "TLS_RSA_WITH_AES_128_CBC_SHA" | "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384" | "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256" | "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384" | "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256" | "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA" | "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA" | "TLS_DHE_DSS_WITH_AES_256_CBC_SHA256" | "TLS_DHE_DSS_WITH_AES_128_CBC_SHA256" | "TLS_DHE_DSS_WITH_AES_256_CBC_SHA" | "TLS_DHE_DSS_WITH_AES_128_CBC_SHA" | "TLS_RSA_WITH_3DES_EDE_CBC_SHA" | "TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA" | "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256" | "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384")[] | string)␊ - /**␊ - * Minimum version of Ssl protocol to be supported on application gateway.␊ - */␊ - minProtocolVersion?: (("TLSv1_0" | "TLSv1_1" | "TLSv1_2") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed.␊ - */␊ - export interface ApplicationGatewayIPConfiguration2 {␊ - properties?: (ApplicationGatewayIPConfigurationPropertiesFormat2 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayIPConfigurationPropertiesFormat2 {␊ - /**␊ - * Reference of the subnet resource. A subnet from where application gateway gets its private address.␊ - */␊ - subnet?: (SubResource7 | string)␊ - /**␊ - * Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authentication certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewayAuthenticationCertificate2 {␊ - properties?: (ApplicationGatewayAuthenticationCertificatePropertiesFormat2 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authentication certificates properties of an application gateway.␊ - */␊ - export interface ApplicationGatewayAuthenticationCertificatePropertiesFormat2 {␊ - /**␊ - * Certificate public data.␊ - */␊ - data?: string␊ - /**␊ - * Provisioning state of the authentication certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSL certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewaySslCertificate2 {␊ - properties?: (ApplicationGatewaySslCertificatePropertiesFormat2 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewaySslCertificatePropertiesFormat2 {␊ - /**␊ - * Base-64 encoded pfx certificate. Only applicable in PUT Request.␊ - */␊ - data?: string␊ - /**␊ - * Password for the pfx file specified in data. Only applicable in PUT request.␊ - */␊ - password?: string␊ - /**␊ - * Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request.␊ - */␊ - publicCertData?: string␊ - /**␊ - * Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendIPConfiguration2 {␊ - properties?: (ApplicationGatewayFrontendIPConfigurationPropertiesFormat2 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendIPConfigurationPropertiesFormat2 {␊ - /**␊ - * PrivateIPAddress of the network interface IP Configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * PrivateIP allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Reference of the subnet resource.␊ - */␊ - subnet?: (SubResource7 | string)␊ - /**␊ - * Reference of the PublicIP resource.␊ - */␊ - publicIPAddress?: (SubResource7 | string)␊ - /**␊ - * Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend port of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendPort2 {␊ - properties?: (ApplicationGatewayFrontendPortPropertiesFormat2 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend port of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendPortPropertiesFormat2 {␊ - /**␊ - * Frontend port␊ - */␊ - port?: (number | string)␊ - /**␊ - * Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Probe of the application gateway.␊ - */␊ - export interface ApplicationGatewayProbe2 {␊ - properties?: (ApplicationGatewayProbePropertiesFormat2 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of probe of an application gateway.␊ - */␊ - export interface ApplicationGatewayProbePropertiesFormat2 {␊ - /**␊ - * Protocol.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Host name to send the probe to.␊ - */␊ - host?: string␊ - /**␊ - * Relative path of probe. Valid path starts from '/'. Probe is sent to ://:␊ - */␊ - path?: string␊ - /**␊ - * The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - interval?: (number | string)␊ - /**␊ - * the probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - timeout?: (number | string)␊ - /**␊ - * The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20.␊ - */␊ - unhealthyThreshold?: (number | string)␊ - /**␊ - * Whether the host header should be picked from the backend http settings. Default value is false.␊ - */␊ - pickHostNameFromBackendHttpSettings?: (boolean | string)␊ - /**␊ - * Minimum number of servers that are always marked healthy. Default value is 0.␊ - */␊ - minServers?: (number | string)␊ - /**␊ - * Criterion for classifying a healthy probe response.␊ - */␊ - match?: (ApplicationGatewayProbeHealthResponseMatch2 | string)␊ - /**␊ - * Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application gateway probe health response match␊ - */␊ - export interface ApplicationGatewayProbeHealthResponseMatch2 {␊ - /**␊ - * Body that must be contained in the health response. Default value is empty.␊ - */␊ - body?: string␊ - /**␊ - * Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399.␊ - */␊ - statusCodes?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend Address Pool of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddressPool2 {␊ - properties?: (ApplicationGatewayBackendAddressPoolPropertiesFormat2 | string)␊ - /**␊ - * Resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend Address Pool of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddressPoolPropertiesFormat2 {␊ - /**␊ - * Collection of references to IPs defined in network interfaces.␊ - */␊ - backendIPConfigurations?: (SubResource7[] | string)␊ - /**␊ - * Backend addresses␊ - */␊ - backendAddresses?: (ApplicationGatewayBackendAddress2[] | string)␊ - /**␊ - * Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddress2 {␊ - /**␊ - * Fully qualified domain name (FQDN).␊ - */␊ - fqdn?: string␊ - /**␊ - * IP address␊ - */␊ - ipAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address pool settings of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendHttpSettings2 {␊ - properties?: (ApplicationGatewayBackendHttpSettingsPropertiesFormat2 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend address pool settings of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendHttpSettingsPropertiesFormat2 {␊ - /**␊ - * Port␊ - */␊ - port?: (number | string)␊ - /**␊ - * Protocol.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Cookie based affinity.␊ - */␊ - cookieBasedAffinity?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Request timeout in seconds. Application Gateway will fail the request if response is not received within RequestTimeout. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - requestTimeout?: (number | string)␊ - /**␊ - * Probe resource of an application gateway.␊ - */␊ - probe?: (SubResource7 | string)␊ - /**␊ - * Array of references to application gateway authentication certificates.␊ - */␊ - authenticationCertificates?: (SubResource7[] | string)␊ - /**␊ - * Connection draining of the backend http settings resource.␊ - */␊ - connectionDraining?: (ApplicationGatewayConnectionDraining2 | string)␊ - /**␊ - * Host header to be sent to the backend servers.␊ - */␊ - hostName?: string␊ - /**␊ - * Whether to pick host header should be picked from the host name of the backend server. Default value is false.␊ - */␊ - pickHostNameFromBackendAddress?: (boolean | string)␊ - /**␊ - * Cookie name to use for the affinity cookie.␊ - */␊ - affinityCookieName?: string␊ - /**␊ - * Whether the probe is enabled. Default value is false.␊ - */␊ - probeEnabled?: (boolean | string)␊ - /**␊ - * Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null.␊ - */␊ - path?: string␊ - /**␊ - * Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Connection draining allows open connections to a backend server to be active for a specified time after the backend server got removed from the configuration.␊ - */␊ - export interface ApplicationGatewayConnectionDraining2 {␊ - /**␊ - * Whether connection draining is enabled or not.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds.␊ - */␊ - drainTimeoutInSec: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http listener of an application gateway.␊ - */␊ - export interface ApplicationGatewayHttpListener2 {␊ - properties?: (ApplicationGatewayHttpListenerPropertiesFormat2 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of HTTP listener of an application gateway.␊ - */␊ - export interface ApplicationGatewayHttpListenerPropertiesFormat2 {␊ - /**␊ - * Frontend IP configuration resource of an application gateway.␊ - */␊ - frontendIPConfiguration?: (SubResource7 | string)␊ - /**␊ - * Frontend port resource of an application gateway.␊ - */␊ - frontendPort?: (SubResource7 | string)␊ - /**␊ - * Protocol.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Host name of HTTP listener.␊ - */␊ - hostName?: string␊ - /**␊ - * SSL certificate resource of an application gateway.␊ - */␊ - sslCertificate?: (SubResource7 | string)␊ - /**␊ - * Applicable only if protocol is https. Enables SNI for multi-hosting.␊ - */␊ - requireServerNameIndication?: (boolean | string)␊ - /**␊ - * Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * UrlPathMaps give a url path to the backend mapping information for PathBasedRouting.␊ - */␊ - export interface ApplicationGatewayUrlPathMap2 {␊ - properties?: (ApplicationGatewayUrlPathMapPropertiesFormat2 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of UrlPathMap of the application gateway.␊ - */␊ - export interface ApplicationGatewayUrlPathMapPropertiesFormat2 {␊ - /**␊ - * Default backend address pool resource of URL path map.␊ - */␊ - defaultBackendAddressPool?: (SubResource7 | string)␊ - /**␊ - * Default backend http settings resource of URL path map.␊ - */␊ - defaultBackendHttpSettings?: (SubResource7 | string)␊ - /**␊ - * Default redirect configuration resource of URL path map.␊ - */␊ - defaultRedirectConfiguration?: (SubResource7 | string)␊ - /**␊ - * Path rule of URL path map resource.␊ - */␊ - pathRules?: (ApplicationGatewayPathRule2[] | string)␊ - /**␊ - * Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Path rule of URL path map of an application gateway.␊ - */␊ - export interface ApplicationGatewayPathRule2 {␊ - properties?: (ApplicationGatewayPathRulePropertiesFormat2 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of path rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayPathRulePropertiesFormat2 {␊ - /**␊ - * Path rules of URL path map.␊ - */␊ - paths?: (string[] | string)␊ - /**␊ - * Backend address pool resource of URL path map path rule.␊ - */␊ - backendAddressPool?: (SubResource7 | string)␊ - /**␊ - * Backend http settings resource of URL path map path rule.␊ - */␊ - backendHttpSettings?: (SubResource7 | string)␊ - /**␊ - * Redirect configuration resource of URL path map path rule.␊ - */␊ - redirectConfiguration?: (SubResource7 | string)␊ - /**␊ - * Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Request routing rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayRequestRoutingRule2 {␊ - properties?: (ApplicationGatewayRequestRoutingRulePropertiesFormat2 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of request routing rule of the application gateway.␊ - */␊ - export interface ApplicationGatewayRequestRoutingRulePropertiesFormat2 {␊ - /**␊ - * Rule type.␊ - */␊ - ruleType?: (("Basic" | "PathBasedRouting") | string)␊ - /**␊ - * Backend address pool resource of the application gateway. ␊ - */␊ - backendAddressPool?: (SubResource7 | string)␊ - /**␊ - * Frontend port resource of the application gateway.␊ - */␊ - backendHttpSettings?: (SubResource7 | string)␊ - /**␊ - * Http listener resource of the application gateway. ␊ - */␊ - httpListener?: (SubResource7 | string)␊ - /**␊ - * URL path map resource of the application gateway.␊ - */␊ - urlPathMap?: (SubResource7 | string)␊ - /**␊ - * Redirect configuration resource of the application gateway.␊ - */␊ - redirectConfiguration?: (SubResource7 | string)␊ - /**␊ - * Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Redirect configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayRedirectConfiguration2 {␊ - properties?: (ApplicationGatewayRedirectConfigurationPropertiesFormat2 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of redirect configuration of the application gateway.␊ - */␊ - export interface ApplicationGatewayRedirectConfigurationPropertiesFormat2 {␊ - /**␊ - * Supported http redirection types - Permanent, Temporary, Found, SeeOther.␊ - */␊ - redirectType?: (("Permanent" | "Found" | "SeeOther" | "Temporary") | string)␊ - /**␊ - * Reference to a listener to redirect the request to.␊ - */␊ - targetListener?: (SubResource7 | string)␊ - /**␊ - * Url to redirect the request to.␊ - */␊ - targetUrl?: string␊ - /**␊ - * Include path in the redirected url.␊ - */␊ - includePath?: (boolean | string)␊ - /**␊ - * Include query string in the redirected url.␊ - */␊ - includeQueryString?: (boolean | string)␊ - /**␊ - * Request routing specifying redirect configuration.␊ - */␊ - requestRoutingRules?: (SubResource7[] | string)␊ - /**␊ - * Url path maps specifying default redirect configuration.␊ - */␊ - urlPathMaps?: (SubResource7[] | string)␊ - /**␊ - * Path rules specifying redirect configuration.␊ - */␊ - pathRules?: (SubResource7[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application gateway web application firewall configuration.␊ - */␊ - export interface ApplicationGatewayWebApplicationFirewallConfiguration2 {␊ - /**␊ - * Whether the web application firewall is enabled or not.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * Web application firewall mode.␊ - */␊ - firewallMode: (("Detection" | "Prevention") | string)␊ - /**␊ - * The type of the web application firewall rule set. Possible values are: 'OWASP'.␊ - */␊ - ruleSetType: string␊ - /**␊ - * The version of the rule set type.␊ - */␊ - ruleSetVersion: string␊ - /**␊ - * The disabled rule groups.␊ - */␊ - disabledRuleGroups?: (ApplicationGatewayFirewallDisabledRuleGroup2[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allows to disable rules within a rule group or an entire rule group.␊ - */␊ - export interface ApplicationGatewayFirewallDisabledRuleGroup2 {␊ - /**␊ - * The name of the rule group that will be disabled.␊ - */␊ - ruleGroupName: string␊ - /**␊ - * The list of rules that will be disabled. If null, all rules of the rule group will be disabled.␊ - */␊ - rules?: (number[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers/inboundNatRules␊ - */␊ - export interface LoadBalancersInboundNatRules1 {␊ - name: string␊ - type: "Microsoft.Network/loadBalancers/inboundNatRules"␊ - apiVersion: "2017-09-01"␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties: (InboundNatRulePropertiesFormat2 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRules2 {␊ - name: string␊ - type: "Microsoft.Network/networkSecurityGroups/securityRules"␊ - apiVersion: "2017-09-01"␊ - /**␊ - * Properties of the security rule␊ - */␊ - properties: (SecurityRulePropertiesFormat2 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutes2 {␊ - name: string␊ - type: "Microsoft.Network/routeTables/routes"␊ - apiVersion: "2017-09-01"␊ - /**␊ - * Properties of the route.␊ - */␊ - properties: (RoutePropertiesFormat2 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/publicIPAddresses␊ - */␊ - export interface PublicIPAddresses11 {␊ - name: string␊ - type: "Microsoft.Network/publicIPAddresses"␊ - apiVersion: "2017-10-01"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The public IP address SKU.␊ - */␊ - sku?: (PublicIPAddressSku2 | string)␊ - /**␊ - * Public IP address properties.␊ - */␊ - properties: (PublicIPAddressPropertiesFormat3 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a public IP address␊ - */␊ - export interface PublicIPAddressSku2 {␊ - /**␊ - * Name of a public IP address SKU.␊ - */␊ - name?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Public IP address properties.␊ - */␊ - export interface PublicIPAddressPropertiesFormat3 {␊ - /**␊ - * The public IP allocation method. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - publicIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * The public IP address version. Possible values are: 'IPv4' and 'IPv6'.␊ - */␊ - publicIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The FQDN of the DNS record associated with the public IP address.␊ - */␊ - dnsSettings?: (PublicIPAddressDnsSettings11 | string)␊ - /**␊ - * The IP address associated with the public IP address resource.␊ - */␊ - ipAddress?: string␊ - /**␊ - * The idle timeout of the public IP address.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * The resource GUID property of the public IP resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains FQDN of the DNS record associated with the public IP address␊ - */␊ - export interface PublicIPAddressDnsSettings11 {␊ - /**␊ - * Gets or sets the Domain name label.The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.␊ - */␊ - domainNameLabel?: string␊ - /**␊ - * Gets the FQDN, Fully qualified domain name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone.␊ - */␊ - fqdn?: string␊ - /**␊ - * Gets or Sets the Reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN. ␊ - */␊ - reverseFqdn?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks␊ - */␊ - export interface VirtualNetworks11 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks"␊ - apiVersion: "2017-10-01"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network.␊ - */␊ - properties: (VirtualNetworkPropertiesFormat3 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: (VirtualNetworksVirtualNetworkPeeringsChildResource3 | VirtualNetworksSubnetsChildResource3)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the virtual network.␊ - */␊ - export interface VirtualNetworkPropertiesFormat3 {␊ - /**␊ - * The AddressSpace that contains an array of IP address ranges that can be used by subnets.␊ - */␊ - addressSpace?: (AddressSpace11 | string)␊ - /**␊ - * The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network.␊ - */␊ - dhcpOptions?: (DhcpOptions11 | string)␊ - /**␊ - * A list of subnets in a Virtual Network.␊ - */␊ - subnets?: (Subnet13[] | string)␊ - /**␊ - * A list of peerings in a Virtual Network.␊ - */␊ - virtualNetworkPeerings?: (VirtualNetworkPeering11[] | string)␊ - /**␊ - * The resourceGuid property of the Virtual Network resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - /**␊ - * Indicates if DDoS protection is enabled for all the protected resources in a Virtual Network.␊ - */␊ - enableDdosProtection?: (boolean | string)␊ - /**␊ - * Indicates if Vm protection is enabled for all the subnets in a Virtual Network.␊ - */␊ - enableVmProtection?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.␊ - */␊ - export interface AddressSpace11 {␊ - /**␊ - * A list of address blocks reserved for this virtual network in CIDR notation.␊ - */␊ - addressPrefixes?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DhcpOptions contains an array of DNS servers available to VMs deployed in the virtual network. Standard DHCP option for a subnet overrides VNET DHCP options.␊ - */␊ - export interface DhcpOptions11 {␊ - /**␊ - * The list of DNS servers IP addresses.␊ - */␊ - dnsServers?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Subnet in a virtual network resource.␊ - */␊ - export interface Subnet13 {␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties?: (SubnetPropertiesFormat3 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the subnet.␊ - */␊ - export interface SubnetPropertiesFormat3 {␊ - /**␊ - * The address prefix for the subnet.␊ - */␊ - addressPrefix?: string␊ - /**␊ - * The reference of the NetworkSecurityGroup resource.␊ - */␊ - networkSecurityGroup?: (SubResource8 | string)␊ - /**␊ - * The reference of the RouteTable resource.␊ - */␊ - routeTable?: (SubResource8 | string)␊ - /**␊ - * An array of service endpoints.␊ - */␊ - serviceEndpoints?: (ServiceEndpointPropertiesFormat2[] | string)␊ - /**␊ - * Gets an array of references to the external resources using subnet.␊ - */␊ - resourceNavigationLinks?: (ResourceNavigationLink3[] | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Reference to another subresource.␊ - */␊ - export interface SubResource8 {␊ - /**␊ - * Resource ID.␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The service endpoint properties.␊ - */␊ - export interface ServiceEndpointPropertiesFormat2 {␊ - /**␊ - * The type of the endpoint service.␊ - */␊ - service?: string␊ - /**␊ - * A list of locations.␊ - */␊ - locations?: (string[] | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ResourceNavigationLink resource.␊ - */␊ - export interface ResourceNavigationLink3 {␊ - /**␊ - * Resource navigation link properties format.␊ - */␊ - properties?: (ResourceNavigationLinkFormat3 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ResourceNavigationLink.␊ - */␊ - export interface ResourceNavigationLinkFormat3 {␊ - /**␊ - * Resource type of the linked resource.␊ - */␊ - linkedResourceType?: string␊ - /**␊ - * Link to the external resource␊ - */␊ - link?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peerings in a virtual network resource.␊ - */␊ - export interface VirtualNetworkPeering11 {␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties?: (VirtualNetworkPeeringPropertiesFormat3 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - export interface VirtualNetworkPeeringPropertiesFormat3 {␊ - /**␊ - * Whether the VMs in the linked virtual network space would be able to access all the VMs in local Virtual network space.␊ - */␊ - allowVirtualNetworkAccess?: (boolean | string)␊ - /**␊ - * Whether the forwarded traffic from the VMs in the remote virtual network will be allowed/disallowed.␊ - */␊ - allowForwardedTraffic?: (boolean | string)␊ - /**␊ - * If gateway links can be used in remote virtual networking to link to this virtual network.␊ - */␊ - allowGatewayTransit?: (boolean | string)␊ - /**␊ - * If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway.␊ - */␊ - useRemoteGateways?: (boolean | string)␊ - /**␊ - * The reference of the remote virtual network. The remote virtual network can be in the same or different region (preview). See here to register for the preview and learn more (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering).␊ - */␊ - remoteVirtualNetwork?: (SubResource8 | string)␊ - /**␊ - * The reference of the remote virtual network address space.␊ - */␊ - remoteAddressSpace?: (AddressSpace11 | string)␊ - /**␊ - * The status of the virtual network peering. Possible values are 'Initiated', 'Connected', and 'Disconnected'.␊ - */␊ - peeringState?: (("Initiated" | "Connected" | "Disconnected") | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/virtualNetworkPeerings␊ - */␊ - export interface VirtualNetworksVirtualNetworkPeeringsChildResource3 {␊ - name: string␊ - type: "virtualNetworkPeerings"␊ - apiVersion: "2017-10-01"␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties: (VirtualNetworkPeeringPropertiesFormat3 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnetsChildResource3 {␊ - name: string␊ - type: "subnets"␊ - apiVersion: "2017-10-01"␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties: (SubnetPropertiesFormat3 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers␊ - */␊ - export interface LoadBalancers11 {␊ - name: string␊ - type: "Microsoft.Network/loadBalancers"␊ - apiVersion: "2017-10-01"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The load balancer SKU.␊ - */␊ - sku?: (LoadBalancerSku2 | string)␊ - /**␊ - * Properties of load balancer.␊ - */␊ - properties: (LoadBalancerPropertiesFormat3 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: LoadBalancersInboundNatRulesChildResource2[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a load balancer␊ - */␊ - export interface LoadBalancerSku2 {␊ - /**␊ - * Name of a load balancer SKU.␊ - */␊ - name?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer.␊ - */␊ - export interface LoadBalancerPropertiesFormat3 {␊ - /**␊ - * Object representing the frontend IPs to be used for the load balancer␊ - */␊ - frontendIPConfigurations?: (FrontendIPConfiguration3[] | string)␊ - /**␊ - * Collection of backend address pools used by a load balancer␊ - */␊ - backendAddressPools?: (BackendAddressPool3[] | string)␊ - /**␊ - * Object collection representing the load balancing rules Gets the provisioning ␊ - */␊ - loadBalancingRules?: (LoadBalancingRule3[] | string)␊ - /**␊ - * Collection of probe objects used in the load balancer␊ - */␊ - probes?: (Probe3[] | string)␊ - /**␊ - * Collection of inbound NAT Rules used by a load balancer. Defining inbound NAT rules on your load balancer is mutually exclusive with defining an inbound NAT pool. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an Inbound NAT pool. They have to reference individual inbound NAT rules.␊ - */␊ - inboundNatRules?: (InboundNatRule4[] | string)␊ - /**␊ - * Defines an external port range for inbound NAT to a single backend port on NICs associated with a load balancer. Inbound NAT rules are created automatically for each NIC associated with the Load Balancer using an external port from this range. Defining an Inbound NAT pool on your Load Balancer is mutually exclusive with defining inbound Nat rules. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an inbound NAT pool. They have to reference individual inbound NAT rules.␊ - */␊ - inboundNatPools?: (InboundNatPool4[] | string)␊ - /**␊ - * The outbound NAT rules.␊ - */␊ - outboundNatRules?: (OutboundNatRule3[] | string)␊ - /**␊ - * The resource GUID property of the load balancer resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP address of the load balancer.␊ - */␊ - export interface FrontendIPConfiguration3 {␊ - /**␊ - * Properties of the load balancer probe.␊ - */␊ - properties?: (FrontendIPConfigurationPropertiesFormat3 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP Configuration of the load balancer.␊ - */␊ - export interface FrontendIPConfigurationPropertiesFormat3 {␊ - /**␊ - * The private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The Private IP allocation method. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * The reference of the subnet resource.␊ - */␊ - subnet?: (SubResource8 | string)␊ - /**␊ - * The reference of the Public IP resource.␊ - */␊ - publicIPAddress?: (SubResource8 | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Pool of backend IP addresses.␊ - */␊ - export interface BackendAddressPool3 {␊ - /**␊ - * Properties of load balancer backend address pool.␊ - */␊ - properties?: (BackendAddressPoolPropertiesFormat3 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the backend address pool.␊ - */␊ - export interface BackendAddressPoolPropertiesFormat3 {␊ - /**␊ - * Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A load balancing rule for a load balancer.␊ - */␊ - export interface LoadBalancingRule3 {␊ - /**␊ - * Properties of load balancer load balancing rule.␊ - */␊ - properties?: (LoadBalancingRulePropertiesFormat3 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer.␊ - */␊ - export interface LoadBalancingRulePropertiesFormat3 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration?: (SubResource8 | string)␊ - /**␊ - * A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs.␊ - */␊ - backendAddressPool?: (SubResource8 | string)␊ - /**␊ - * The reference of the load balancer probe used by the load balancing rule.␊ - */␊ - probe?: (SubResource8 | string)␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'.␊ - */␊ - loadDistribution?: (("Default" | "SourceIP" | "SourceIPProtocol") | string)␊ - /**␊ - * The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 0 and 65534. Note that value 0 enables "Any Port"␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port"␊ - */␊ - backendPort?: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule.␊ - */␊ - disableOutboundSnat?: (boolean | string)␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A load balancer probe.␊ - */␊ - export interface Probe3 {␊ - /**␊ - * Properties of load balancer probe.␊ - */␊ - properties?: (ProbePropertiesFormat3 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Load balancer probe resource.␊ - */␊ - export interface ProbePropertiesFormat3 {␊ - /**␊ - * The protocol of the end point. Possible values are: 'Http' or 'Tcp'. If 'Tcp' is specified, a received ACK is required for the probe to be successful. If 'Http' is specified, a 200 OK response from the specifies URI is required for the probe to be successful.␊ - */␊ - protocol: (("Http" | "Tcp") | string)␊ - /**␊ - * The port for communicating the probe. Possible values range from 1 to 65535, inclusive.␊ - */␊ - port: (number | string)␊ - /**␊ - * The interval, in seconds, for how frequently to probe the endpoint for health status. Typically, the interval is slightly less than half the allocated timeout period (in seconds) which allows two full probes before taking the instance out of rotation. The default value is 15, the minimum value is 5.␊ - */␊ - intervalInSeconds?: (number | string)␊ - /**␊ - * The number of probes where if no response, will result in stopping further traffic from being delivered to the endpoint. This values allows endpoints to be taken out of rotation faster or slower than the typical times used in Azure.␊ - */␊ - numberOfProbes?: (number | string)␊ - /**␊ - * The URI used for requesting health status from the VM. Path is required if a protocol is set to http. Otherwise, it is not allowed. There is no default value.␊ - */␊ - requestPath?: string␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT rule of the load balancer.␊ - */␊ - export interface InboundNatRule4 {␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties?: (InboundNatRulePropertiesFormat3 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the inbound NAT rule.␊ - */␊ - export interface InboundNatRulePropertiesFormat3 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration?: (SubResource8 | string)␊ - protocol?: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values range from 1 to 65534.␊ - */␊ - frontendPort?: (number | string)␊ - /**␊ - * The port used for the internal endpoint. Acceptable values range from 1 to 65535.␊ - */␊ - backendPort?: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT pool of the load balancer.␊ - */␊ - export interface InboundNatPool4 {␊ - /**␊ - * Properties of load balancer inbound nat pool.␊ - */␊ - properties?: (InboundNatPoolPropertiesFormat3 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Inbound NAT pool.␊ - */␊ - export interface InboundNatPoolPropertiesFormat3 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration?: (SubResource8 | string)␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65534.␊ - */␊ - frontendPortRangeStart: (number | string)␊ - /**␊ - * The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65535.␊ - */␊ - frontendPortRangeEnd: (number | string)␊ - /**␊ - * The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound NAT pool of the load balancer.␊ - */␊ - export interface OutboundNatRule3 {␊ - /**␊ - * Properties of load balancer outbound nat rule.␊ - */␊ - properties?: (OutboundNatRulePropertiesFormat3 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound NAT pool of the load balancer.␊ - */␊ - export interface OutboundNatRulePropertiesFormat3 {␊ - /**␊ - * The number of outbound ports to be used for NAT.␊ - */␊ - allocatedOutboundPorts?: (number | string)␊ - /**␊ - * The Frontend IP addresses of the load balancer.␊ - */␊ - frontendIPConfigurations?: (SubResource8[] | string)␊ - /**␊ - * A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs.␊ - */␊ - backendAddressPool: (SubResource8 | string)␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers/inboundNatRules␊ - */␊ - export interface LoadBalancersInboundNatRulesChildResource2 {␊ - name: string␊ - type: "inboundNatRules"␊ - apiVersion: "2017-10-01"␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties: (InboundNatRulePropertiesFormat3 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups␊ - */␊ - export interface NetworkSecurityGroups11 {␊ - name: string␊ - type: "Microsoft.Network/networkSecurityGroups"␊ - apiVersion: "2017-10-01"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network security group␊ - */␊ - properties: (NetworkSecurityGroupPropertiesFormat3 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: NetworkSecurityGroupsSecurityRulesChildResource3[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network Security Group resource.␊ - */␊ - export interface NetworkSecurityGroupPropertiesFormat3 {␊ - /**␊ - * A collection of security rules of the network security group.␊ - */␊ - securityRules?: (SecurityRule3[] | string)␊ - /**␊ - * The default security rules of network security group.␊ - */␊ - defaultSecurityRules?: (SecurityRule3[] | string)␊ - /**␊ - * The resource GUID property of the network security group resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network security rule.␊ - */␊ - export interface SecurityRule3 {␊ - /**␊ - * Properties of the security rule␊ - */␊ - properties?: (SecurityRulePropertiesFormat3 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Security rule resource.␊ - */␊ - export interface SecurityRulePropertiesFormat3 {␊ - /**␊ - * A description for this rule. Restricted to 140 chars.␊ - */␊ - description?: string␊ - /**␊ - * Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'.␊ - */␊ - protocol: (("Tcp" | "Udp" | "*") | string)␊ - /**␊ - * The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports.␊ - */␊ - sourcePortRange?: string␊ - /**␊ - * The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports.␊ - */␊ - destinationPortRange?: string␊ - /**␊ - * The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. ␊ - */␊ - sourceAddressPrefix?: string␊ - /**␊ - * The CIDR or source IP ranges.␊ - */␊ - sourceAddressPrefixes?: (string[] | string)␊ - /**␊ - * The application security group specified as source.␊ - */␊ - sourceApplicationSecurityGroups?: (ApplicationSecurityGroup1[] | string)␊ - /**␊ - * The destination address prefix. CIDR or destination IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used.␊ - */␊ - destinationAddressPrefix?: string␊ - /**␊ - * The destination address prefixes. CIDR or destination IP ranges.␊ - */␊ - destinationAddressPrefixes?: (string[] | string)␊ - /**␊ - * The application security group specified as destination.␊ - */␊ - destinationApplicationSecurityGroups?: (ApplicationSecurityGroup1[] | string)␊ - /**␊ - * The source port ranges.␊ - */␊ - sourcePortRanges?: (string[] | string)␊ - /**␊ - * The destination port ranges.␊ - */␊ - destinationPortRanges?: (string[] | string)␊ - /**␊ - * The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'.␊ - */␊ - access: (("Allow" | "Deny") | string)␊ - /**␊ - * The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.␊ - */␊ - priority: (number | string)␊ - /**␊ - * The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'.␊ - */␊ - direction: (("Inbound" | "Outbound") | string)␊ - /**␊ - * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An application security group in a resource group.␊ - */␊ - export interface ApplicationSecurityGroup1 {␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the application security group.␊ - */␊ - properties?: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRulesChildResource3 {␊ - name: string␊ - type: "securityRules"␊ - apiVersion: "2017-10-01"␊ - /**␊ - * Properties of the security rule␊ - */␊ - properties: (SecurityRulePropertiesFormat3 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces␊ - */␊ - export interface NetworkInterfaces12 {␊ - name: string␊ - type: "Microsoft.Network/networkInterfaces"␊ - apiVersion: "2017-10-01"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network interface.␊ - */␊ - properties: (NetworkInterfacePropertiesFormat3 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NetworkInterface properties. ␊ - */␊ - export interface NetworkInterfacePropertiesFormat3 {␊ - /**␊ - * The reference of the NetworkSecurityGroup resource.␊ - */␊ - networkSecurityGroup?: (SubResource8 | string)␊ - /**␊ - * A list of IPConfigurations of the network interface.␊ - */␊ - ipConfigurations?: (NetworkInterfaceIPConfiguration3[] | string)␊ - /**␊ - * The DNS settings in network interface.␊ - */␊ - dnsSettings?: (NetworkInterfaceDnsSettings11 | string)␊ - /**␊ - * The MAC address of the network interface.␊ - */␊ - macAddress?: string␊ - /**␊ - * Gets whether this is a primary network interface on a virtual machine.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * If the network interface is accelerated networking enabled.␊ - */␊ - enableAcceleratedNetworking?: (boolean | string)␊ - /**␊ - * Indicates whether IP forwarding is enabled on this network interface.␊ - */␊ - enableIPForwarding?: (boolean | string)␊ - /**␊ - * The resource GUID property of the network interface resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IPConfiguration in a network interface.␊ - */␊ - export interface NetworkInterfaceIPConfiguration3 {␊ - /**␊ - * Network interface IP configuration properties.␊ - */␊ - properties?: (NetworkInterfaceIPConfigurationPropertiesFormat3 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration.␊ - */␊ - export interface NetworkInterfaceIPConfigurationPropertiesFormat3 {␊ - /**␊ - * The reference of ApplicationGatewayBackendAddressPool resource.␊ - */␊ - applicationGatewayBackendAddressPools?: (SubResource8[] | string)␊ - /**␊ - * The reference of LoadBalancerBackendAddressPool resource.␊ - */␊ - loadBalancerBackendAddressPools?: (SubResource8[] | string)␊ - /**␊ - * A list of references of LoadBalancerInboundNatRules.␊ - */␊ - loadBalancerInboundNatRules?: (SubResource8[] | string)␊ - /**␊ - * Private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * Defines how a private IP address is assigned. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Available from Api-Version 2016-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.␊ - */␊ - privateIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * Subnet bound to the IP configuration.␊ - */␊ - subnet?: (SubResource8 | string)␊ - /**␊ - * Gets whether this is a primary customer address on the network interface.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * Public IP address bound to the IP configuration.␊ - */␊ - publicIPAddress?: (SubResource8 | string)␊ - /**␊ - * Application security groups in which the IP configuration is included.␊ - */␊ - applicationSecurityGroups?: (SubResource8[] | string)␊ - /**␊ - * The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DNS settings of a network interface.␊ - */␊ - export interface NetworkInterfaceDnsSettings11 {␊ - /**␊ - * List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only value in dnsServers collection.␊ - */␊ - dnsServers?: (string[] | string)␊ - /**␊ - * If the VM that uses this NIC is part of an Availability Set, then this list will have the union of all DNS servers from all NICs that are part of the Availability Set. This property is what is configured on each of those VMs.␊ - */␊ - appliedDnsServers?: (string[] | string)␊ - /**␊ - * Relative DNS name for this NIC used for internal communications between VMs in the same virtual network.␊ - */␊ - internalDnsNameLabel?: string␊ - /**␊ - * Fully qualified DNS name supporting internal communications between VMs in the same virtual network.␊ - */␊ - internalFqdn?: string␊ - /**␊ - * Even if internalDnsNameLabel is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internalDomainNameSuffix.␊ - */␊ - internalDomainNameSuffix?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables␊ - */␊ - export interface RouteTables11 {␊ - name: string␊ - type: "Microsoft.Network/routeTables"␊ - apiVersion: "2017-10-01"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the route table.␊ - */␊ - properties: (RouteTablePropertiesFormat3 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: RouteTablesRoutesChildResource3[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Table resource␊ - */␊ - export interface RouteTablePropertiesFormat3 {␊ - /**␊ - * Collection of routes contained within a route table.␊ - */␊ - routes?: (Route3[] | string)␊ - /**␊ - * Gets or sets whether to disable the routes learned by BGP on that route table. True means disable.␊ - */␊ - disableBgpRoutePropagation?: (boolean | string)␊ - /**␊ - * The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource␊ - */␊ - export interface Route3 {␊ - /**␊ - * Properties of the route.␊ - */␊ - properties?: (RoutePropertiesFormat3 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource␊ - */␊ - export interface RoutePropertiesFormat3 {␊ - /**␊ - * The destination CIDR to which the route applies.␊ - */␊ - addressPrefix?: string␊ - /**␊ - * The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'.␊ - */␊ - nextHopType: (("VirtualNetworkGateway" | "VnetLocal" | "Internet" | "VirtualAppliance" | "None") | string)␊ - /**␊ - * The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.␊ - */␊ - nextHopIpAddress?: string␊ - /**␊ - * The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutesChildResource3 {␊ - name: string␊ - type: "routes"␊ - apiVersion: "2017-10-01"␊ - /**␊ - * Properties of the route.␊ - */␊ - properties: (RoutePropertiesFormat3 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/applicationGateways␊ - */␊ - export interface ApplicationGateways3 {␊ - name: string␊ - type: "Microsoft.Network/applicationGateways"␊ - apiVersion: "2017-10-01"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (ApplicationGatewayPropertiesFormat3 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application gateway.␊ - */␊ - export interface ApplicationGatewayPropertiesFormat3 {␊ - /**␊ - * SKU of the application gateway resource.␊ - */␊ - sku?: (ApplicationGatewaySku3 | string)␊ - /**␊ - * SSL policy of the application gateway resource.␊ - */␊ - sslPolicy?: (ApplicationGatewaySslPolicy3 | string)␊ - /**␊ - * Subnets of application the gateway resource.␊ - */␊ - gatewayIPConfigurations?: (ApplicationGatewayIPConfiguration3[] | string)␊ - /**␊ - * Authentication certificates of the application gateway resource.␊ - */␊ - authenticationCertificates?: (ApplicationGatewayAuthenticationCertificate3[] | string)␊ - /**␊ - * SSL certificates of the application gateway resource.␊ - */␊ - sslCertificates?: (ApplicationGatewaySslCertificate3[] | string)␊ - /**␊ - * Frontend IP addresses of the application gateway resource.␊ - */␊ - frontendIPConfigurations?: (ApplicationGatewayFrontendIPConfiguration3[] | string)␊ - /**␊ - * Frontend ports of the application gateway resource.␊ - */␊ - frontendPorts?: (ApplicationGatewayFrontendPort3[] | string)␊ - /**␊ - * Probes of the application gateway resource.␊ - */␊ - probes?: (ApplicationGatewayProbe3[] | string)␊ - /**␊ - * Backend address pool of the application gateway resource.␊ - */␊ - backendAddressPools?: (ApplicationGatewayBackendAddressPool3[] | string)␊ - /**␊ - * Backend http settings of the application gateway resource.␊ - */␊ - backendHttpSettingsCollection?: (ApplicationGatewayBackendHttpSettings3[] | string)␊ - /**␊ - * Http listeners of the application gateway resource.␊ - */␊ - httpListeners?: (ApplicationGatewayHttpListener3[] | string)␊ - /**␊ - * URL path map of the application gateway resource.␊ - */␊ - urlPathMaps?: (ApplicationGatewayUrlPathMap3[] | string)␊ - /**␊ - * Request routing rules of the application gateway resource.␊ - */␊ - requestRoutingRules?: (ApplicationGatewayRequestRoutingRule3[] | string)␊ - /**␊ - * Redirect configurations of the application gateway resource.␊ - */␊ - redirectConfigurations?: (ApplicationGatewayRedirectConfiguration3[] | string)␊ - /**␊ - * Web application firewall configuration.␊ - */␊ - webApplicationFirewallConfiguration?: (ApplicationGatewayWebApplicationFirewallConfiguration3 | string)␊ - /**␊ - * Whether HTTP2 is enabled on the application gateway resource.␊ - */␊ - enableHttp2?: (boolean | string)␊ - /**␊ - * Resource GUID property of the application gateway resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of an application gateway␊ - */␊ - export interface ApplicationGatewaySku3 {␊ - /**␊ - * Name of an application gateway SKU.␊ - */␊ - name?: (("Standard_Small" | "Standard_Medium" | "Standard_Large" | "WAF_Medium" | "WAF_Large") | string)␊ - /**␊ - * Tier of an application gateway.␊ - */␊ - tier?: (("Standard" | "WAF") | string)␊ - /**␊ - * Capacity (instance count) of an application gateway.␊ - */␊ - capacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application Gateway Ssl policy.␊ - */␊ - export interface ApplicationGatewaySslPolicy3 {␊ - /**␊ - * Ssl protocols to be disabled on application gateway.␊ - */␊ - disabledSslProtocols?: (("TLSv1_0" | "TLSv1_1" | "TLSv1_2")[] | string)␊ - /**␊ - * Type of Ssl Policy.␊ - */␊ - policyType?: (("Predefined" | "Custom") | string)␊ - /**␊ - * Name of Ssl predefined policy.␊ - */␊ - policyName?: (("AppGwSslPolicy20150501" | "AppGwSslPolicy20170401" | "AppGwSslPolicy20170401S") | string)␊ - /**␊ - * Ssl cipher suites to be enabled in the specified order to application gateway.␊ - */␊ - cipherSuites?: (("TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384" | "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256" | "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA" | "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA" | "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384" | "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256" | "TLS_DHE_RSA_WITH_AES_256_CBC_SHA" | "TLS_DHE_RSA_WITH_AES_128_CBC_SHA" | "TLS_RSA_WITH_AES_256_GCM_SHA384" | "TLS_RSA_WITH_AES_128_GCM_SHA256" | "TLS_RSA_WITH_AES_256_CBC_SHA256" | "TLS_RSA_WITH_AES_128_CBC_SHA256" | "TLS_RSA_WITH_AES_256_CBC_SHA" | "TLS_RSA_WITH_AES_128_CBC_SHA" | "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384" | "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256" | "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384" | "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256" | "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA" | "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA" | "TLS_DHE_DSS_WITH_AES_256_CBC_SHA256" | "TLS_DHE_DSS_WITH_AES_128_CBC_SHA256" | "TLS_DHE_DSS_WITH_AES_256_CBC_SHA" | "TLS_DHE_DSS_WITH_AES_128_CBC_SHA" | "TLS_RSA_WITH_3DES_EDE_CBC_SHA")[] | string)␊ - /**␊ - * Minimum version of Ssl protocol to be supported on application gateway.␊ - */␊ - minProtocolVersion?: (("TLSv1_0" | "TLSv1_1" | "TLSv1_2") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed.␊ - */␊ - export interface ApplicationGatewayIPConfiguration3 {␊ - properties?: (ApplicationGatewayIPConfigurationPropertiesFormat3 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayIPConfigurationPropertiesFormat3 {␊ - /**␊ - * Reference of the subnet resource. A subnet from where application gateway gets its private address.␊ - */␊ - subnet?: (SubResource8 | string)␊ - /**␊ - * Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authentication certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewayAuthenticationCertificate3 {␊ - properties?: (ApplicationGatewayAuthenticationCertificatePropertiesFormat3 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authentication certificates properties of an application gateway.␊ - */␊ - export interface ApplicationGatewayAuthenticationCertificatePropertiesFormat3 {␊ - /**␊ - * Certificate public data.␊ - */␊ - data?: string␊ - /**␊ - * Provisioning state of the authentication certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSL certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewaySslCertificate3 {␊ - properties?: (ApplicationGatewaySslCertificatePropertiesFormat3 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewaySslCertificatePropertiesFormat3 {␊ - /**␊ - * Base-64 encoded pfx certificate. Only applicable in PUT Request.␊ - */␊ - data?: string␊ - /**␊ - * Password for the pfx file specified in data. Only applicable in PUT request.␊ - */␊ - password?: string␊ - /**␊ - * Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request.␊ - */␊ - publicCertData?: string␊ - /**␊ - * Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendIPConfiguration3 {␊ - properties?: (ApplicationGatewayFrontendIPConfigurationPropertiesFormat3 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendIPConfigurationPropertiesFormat3 {␊ - /**␊ - * PrivateIPAddress of the network interface IP Configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * PrivateIP allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Reference of the subnet resource.␊ - */␊ - subnet?: (SubResource8 | string)␊ - /**␊ - * Reference of the PublicIP resource.␊ - */␊ - publicIPAddress?: (SubResource8 | string)␊ - /**␊ - * Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend port of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendPort3 {␊ - properties?: (ApplicationGatewayFrontendPortPropertiesFormat3 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend port of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendPortPropertiesFormat3 {␊ - /**␊ - * Frontend port␊ - */␊ - port?: (number | string)␊ - /**␊ - * Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Probe of the application gateway.␊ - */␊ - export interface ApplicationGatewayProbe3 {␊ - properties?: (ApplicationGatewayProbePropertiesFormat3 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of probe of an application gateway.␊ - */␊ - export interface ApplicationGatewayProbePropertiesFormat3 {␊ - /**␊ - * Protocol.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Host name to send the probe to.␊ - */␊ - host?: string␊ - /**␊ - * Relative path of probe. Valid path starts from '/'. Probe is sent to ://:␊ - */␊ - path?: string␊ - /**␊ - * The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - interval?: (number | string)␊ - /**␊ - * the probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - timeout?: (number | string)␊ - /**␊ - * The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20.␊ - */␊ - unhealthyThreshold?: (number | string)␊ - /**␊ - * Whether the host header should be picked from the backend http settings. Default value is false.␊ - */␊ - pickHostNameFromBackendHttpSettings?: (boolean | string)␊ - /**␊ - * Minimum number of servers that are always marked healthy. Default value is 0.␊ - */␊ - minServers?: (number | string)␊ - /**␊ - * Criterion for classifying a healthy probe response.␊ - */␊ - match?: (ApplicationGatewayProbeHealthResponseMatch3 | string)␊ - /**␊ - * Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application gateway probe health response match␊ - */␊ - export interface ApplicationGatewayProbeHealthResponseMatch3 {␊ - /**␊ - * Body that must be contained in the health response. Default value is empty.␊ - */␊ - body?: string␊ - /**␊ - * Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399.␊ - */␊ - statusCodes?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend Address Pool of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddressPool3 {␊ - properties?: (ApplicationGatewayBackendAddressPoolPropertiesFormat3 | string)␊ - /**␊ - * Resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend Address Pool of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddressPoolPropertiesFormat3 {␊ - /**␊ - * Collection of references to IPs defined in network interfaces.␊ - */␊ - backendIPConfigurations?: (SubResource8[] | string)␊ - /**␊ - * Backend addresses␊ - */␊ - backendAddresses?: (ApplicationGatewayBackendAddress3[] | string)␊ - /**␊ - * Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddress3 {␊ - /**␊ - * Fully qualified domain name (FQDN).␊ - */␊ - fqdn?: string␊ - /**␊ - * IP address␊ - */␊ - ipAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address pool settings of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendHttpSettings3 {␊ - properties?: (ApplicationGatewayBackendHttpSettingsPropertiesFormat3 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend address pool settings of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendHttpSettingsPropertiesFormat3 {␊ - /**␊ - * Port␊ - */␊ - port?: (number | string)␊ - /**␊ - * Protocol.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Cookie based affinity.␊ - */␊ - cookieBasedAffinity?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Request timeout in seconds. Application Gateway will fail the request if response is not received within RequestTimeout. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - requestTimeout?: (number | string)␊ - /**␊ - * Probe resource of an application gateway.␊ - */␊ - probe?: (SubResource8 | string)␊ - /**␊ - * Array of references to application gateway authentication certificates.␊ - */␊ - authenticationCertificates?: (SubResource8[] | string)␊ - /**␊ - * Connection draining of the backend http settings resource.␊ - */␊ - connectionDraining?: (ApplicationGatewayConnectionDraining3 | string)␊ - /**␊ - * Host header to be sent to the backend servers.␊ - */␊ - hostName?: string␊ - /**␊ - * Whether to pick host header should be picked from the host name of the backend server. Default value is false.␊ - */␊ - pickHostNameFromBackendAddress?: (boolean | string)␊ - /**␊ - * Cookie name to use for the affinity cookie.␊ - */␊ - affinityCookieName?: string␊ - /**␊ - * Whether the probe is enabled. Default value is false.␊ - */␊ - probeEnabled?: (boolean | string)␊ - /**␊ - * Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null.␊ - */␊ - path?: string␊ - /**␊ - * Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Connection draining allows open connections to a backend server to be active for a specified time after the backend server got removed from the configuration.␊ - */␊ - export interface ApplicationGatewayConnectionDraining3 {␊ - /**␊ - * Whether connection draining is enabled or not.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds.␊ - */␊ - drainTimeoutInSec: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http listener of an application gateway.␊ - */␊ - export interface ApplicationGatewayHttpListener3 {␊ - properties?: (ApplicationGatewayHttpListenerPropertiesFormat3 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of HTTP listener of an application gateway.␊ - */␊ - export interface ApplicationGatewayHttpListenerPropertiesFormat3 {␊ - /**␊ - * Frontend IP configuration resource of an application gateway.␊ - */␊ - frontendIPConfiguration?: (SubResource8 | string)␊ - /**␊ - * Frontend port resource of an application gateway.␊ - */␊ - frontendPort?: (SubResource8 | string)␊ - /**␊ - * Protocol.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Host name of HTTP listener.␊ - */␊ - hostName?: string␊ - /**␊ - * SSL certificate resource of an application gateway.␊ - */␊ - sslCertificate?: (SubResource8 | string)␊ - /**␊ - * Applicable only if protocol is https. Enables SNI for multi-hosting.␊ - */␊ - requireServerNameIndication?: (boolean | string)␊ - /**␊ - * Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * UrlPathMaps give a url path to the backend mapping information for PathBasedRouting.␊ - */␊ - export interface ApplicationGatewayUrlPathMap3 {␊ - properties?: (ApplicationGatewayUrlPathMapPropertiesFormat3 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of UrlPathMap of the application gateway.␊ - */␊ - export interface ApplicationGatewayUrlPathMapPropertiesFormat3 {␊ - /**␊ - * Default backend address pool resource of URL path map.␊ - */␊ - defaultBackendAddressPool?: (SubResource8 | string)␊ - /**␊ - * Default backend http settings resource of URL path map.␊ - */␊ - defaultBackendHttpSettings?: (SubResource8 | string)␊ - /**␊ - * Default redirect configuration resource of URL path map.␊ - */␊ - defaultRedirectConfiguration?: (SubResource8 | string)␊ - /**␊ - * Path rule of URL path map resource.␊ - */␊ - pathRules?: (ApplicationGatewayPathRule3[] | string)␊ - /**␊ - * Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Path rule of URL path map of an application gateway.␊ - */␊ - export interface ApplicationGatewayPathRule3 {␊ - properties?: (ApplicationGatewayPathRulePropertiesFormat3 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of path rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayPathRulePropertiesFormat3 {␊ - /**␊ - * Path rules of URL path map.␊ - */␊ - paths?: (string[] | string)␊ - /**␊ - * Backend address pool resource of URL path map path rule.␊ - */␊ - backendAddressPool?: (SubResource8 | string)␊ - /**␊ - * Backend http settings resource of URL path map path rule.␊ - */␊ - backendHttpSettings?: (SubResource8 | string)␊ - /**␊ - * Redirect configuration resource of URL path map path rule.␊ - */␊ - redirectConfiguration?: (SubResource8 | string)␊ - /**␊ - * Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Request routing rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayRequestRoutingRule3 {␊ - properties?: (ApplicationGatewayRequestRoutingRulePropertiesFormat3 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of request routing rule of the application gateway.␊ - */␊ - export interface ApplicationGatewayRequestRoutingRulePropertiesFormat3 {␊ - /**␊ - * Rule type.␊ - */␊ - ruleType?: (("Basic" | "PathBasedRouting") | string)␊ - /**␊ - * Backend address pool resource of the application gateway. ␊ - */␊ - backendAddressPool?: (SubResource8 | string)␊ - /**␊ - * Frontend port resource of the application gateway.␊ - */␊ - backendHttpSettings?: (SubResource8 | string)␊ - /**␊ - * Http listener resource of the application gateway. ␊ - */␊ - httpListener?: (SubResource8 | string)␊ - /**␊ - * URL path map resource of the application gateway.␊ - */␊ - urlPathMap?: (SubResource8 | string)␊ - /**␊ - * Redirect configuration resource of the application gateway.␊ - */␊ - redirectConfiguration?: (SubResource8 | string)␊ - /**␊ - * Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Redirect configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayRedirectConfiguration3 {␊ - properties?: (ApplicationGatewayRedirectConfigurationPropertiesFormat3 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of redirect configuration of the application gateway.␊ - */␊ - export interface ApplicationGatewayRedirectConfigurationPropertiesFormat3 {␊ - /**␊ - * Supported http redirection types - Permanent, Temporary, Found, SeeOther.␊ - */␊ - redirectType?: (("Permanent" | "Found" | "SeeOther" | "Temporary") | string)␊ - /**␊ - * Reference to a listener to redirect the request to.␊ - */␊ - targetListener?: (SubResource8 | string)␊ - /**␊ - * Url to redirect the request to.␊ - */␊ - targetUrl?: string␊ - /**␊ - * Include path in the redirected url.␊ - */␊ - includePath?: (boolean | string)␊ - /**␊ - * Include query string in the redirected url.␊ - */␊ - includeQueryString?: (boolean | string)␊ - /**␊ - * Request routing specifying redirect configuration.␊ - */␊ - requestRoutingRules?: (SubResource8[] | string)␊ - /**␊ - * Url path maps specifying default redirect configuration.␊ - */␊ - urlPathMaps?: (SubResource8[] | string)␊ - /**␊ - * Path rules specifying redirect configuration.␊ - */␊ - pathRules?: (SubResource8[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application gateway web application firewall configuration.␊ - */␊ - export interface ApplicationGatewayWebApplicationFirewallConfiguration3 {␊ - /**␊ - * Whether the web application firewall is enabled or not.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * Web application firewall mode.␊ - */␊ - firewallMode: (("Detection" | "Prevention") | string)␊ - /**␊ - * The type of the web application firewall rule set. Possible values are: 'OWASP'.␊ - */␊ - ruleSetType: string␊ - /**␊ - * The version of the rule set type.␊ - */␊ - ruleSetVersion: string␊ - /**␊ - * The disabled rule groups.␊ - */␊ - disabledRuleGroups?: (ApplicationGatewayFirewallDisabledRuleGroup3[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allows to disable rules within a rule group or an entire rule group.␊ - */␊ - export interface ApplicationGatewayFirewallDisabledRuleGroup3 {␊ - /**␊ - * The name of the rule group that will be disabled.␊ - */␊ - ruleGroupName: string␊ - /**␊ - * The list of rules that will be disabled. If null, all rules of the rule group will be disabled.␊ - */␊ - rules?: (number[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers/inboundNatRules␊ - */␊ - export interface LoadBalancersInboundNatRules2 {␊ - name: string␊ - type: "Microsoft.Network/loadBalancers/inboundNatRules"␊ - apiVersion: "2017-10-01"␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties: (InboundNatRulePropertiesFormat3 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRules3 {␊ - name: string␊ - type: "Microsoft.Network/networkSecurityGroups/securityRules"␊ - apiVersion: "2017-10-01"␊ - /**␊ - * Properties of the security rule␊ - */␊ - properties: (SecurityRulePropertiesFormat3 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutes3 {␊ - name: string␊ - type: "Microsoft.Network/routeTables/routes"␊ - apiVersion: "2017-10-01"␊ - /**␊ - * Properties of the route.␊ - */␊ - properties: (RoutePropertiesFormat3 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ImportExport/jobs␊ - */␊ - export interface Jobs {␊ - apiVersion: "2016-11-01"␊ - /**␊ - * Specifies the supported Azure location where the job should be created␊ - */␊ - location?: string␊ - /**␊ - * The name of the import/export job.␊ - */␊ - name: string␊ - /**␊ - * Specifies the job properties␊ - */␊ - properties: (JobDetails | string)␊ - /**␊ - * Specifies the tags that will be assigned to the job.␊ - */␊ - tags?: {␊ - [k: string]: unknown␊ - }␊ - type: "Microsoft.ImportExport/jobs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the job properties␊ - */␊ - export interface JobDetails {␊ - /**␊ - * Default value is false. Indicates whether the manifest files on the drives should be copied to block blobs.␊ - */␊ - backupDriveManifest?: (boolean | string)␊ - /**␊ - * Indicates whether a request has been submitted to cancel the job.␊ - */␊ - cancelRequested?: (boolean | string)␊ - /**␊ - * Contains information about the delivery package being shipped by the customer to the Microsoft data center.␊ - */␊ - deliveryPackage?: (DeliveryPackageInformation | string)␊ - /**␊ - * The virtual blob directory to which the copy logs and backups of drive manifest files (if enabled) will be stored.␊ - */␊ - diagnosticsPath?: string␊ - /**␊ - * List of up to ten drives that comprise the job. The drive list is a required element for an import job; it is not specified for export jobs.␊ - */␊ - driveList?: (DriveStatus[] | string)␊ - /**␊ - * Specifies the encryption key properties␊ - */␊ - encryptionKey?: (EncryptionKeyDetails | string)␊ - /**␊ - * A property containing information about the blobs to be exported for an export job. This property is required for export jobs, but must not be specified for import jobs.␊ - */␊ - export?: (Export | string)␊ - /**␊ - * A blob path that points to a block blob containing a list of blob names that were not exported due to insufficient drive space. If all blobs were exported successfully, then this element is not included in the response.␊ - */␊ - incompleteBlobListUri?: string␊ - /**␊ - * The type of job␊ - */␊ - jobType?: string␊ - /**␊ - * Default value is Error. Indicates whether error logging or verbose logging will be enabled.␊ - */␊ - logLevel?: string␊ - /**␊ - * Overall percentage completed for the job.␊ - */␊ - percentComplete?: (number | string)␊ - /**␊ - * Specifies the provisioning state of the job.␊ - */␊ - provisioningState?: string␊ - /**␊ - * Specifies the return address information for the job.␊ - */␊ - returnAddress?: (ReturnAddress | string)␊ - /**␊ - * Contains information about the package being shipped by the customer to the Microsoft data center.␊ - */␊ - returnPackage?: (PackageInfomation | string)␊ - /**␊ - * Specifies the return carrier and customer's account with the carrier.␊ - */␊ - returnShipping?: (ReturnShipping | string)␊ - /**␊ - * Contains information about the Microsoft datacenter to which the drives should be shipped.␊ - */␊ - shippingInformation?: (ShippingInformation | string)␊ - /**␊ - * Current state of the job.␊ - */␊ - state?: string␊ - /**␊ - * The resource identifier of the storage account where data will be imported to or exported from.␊ - */␊ - storageAccountId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains information about the delivery package being shipped by the customer to the Microsoft data center.␊ - */␊ - export interface DeliveryPackageInformation {␊ - /**␊ - * The name of the carrier that is used to ship the import or export drives.␊ - */␊ - carrierName: string␊ - /**␊ - * The number of drives included in the package.␊ - */␊ - driveCount?: (number | string)␊ - /**␊ - * The date when the package is shipped.␊ - */␊ - shipDate?: string␊ - /**␊ - * The tracking number of the package.␊ - */␊ - trackingNumber: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Provides information about the drive's status␊ - */␊ - export interface DriveStatus {␊ - /**␊ - * The BitLocker key used to encrypt the drive.␊ - */␊ - bitLockerKey?: string␊ - /**␊ - * Bytes successfully transferred for the drive.␊ - */␊ - bytesSucceeded?: (number | string)␊ - /**␊ - * Detailed status about the data transfer process. This field is not returned in the response until the drive is in the Transferring state.␊ - */␊ - copyStatus?: string␊ - /**␊ - * The drive header hash value.␊ - */␊ - driveHeaderHash?: string␊ - /**␊ - * The drive's hardware serial number, without spaces.␊ - */␊ - driveId?: string␊ - /**␊ - * A URI that points to the blob containing the error log for the data transfer operation.␊ - */␊ - errorLogUri?: string␊ - /**␊ - * The relative path of the manifest file on the drive. ␊ - */␊ - manifestFile?: string␊ - /**␊ - * The Base16-encoded MD5 hash of the manifest file on the drive.␊ - */␊ - manifestHash?: string␊ - /**␊ - * A URI that points to the blob containing the drive manifest file. ␊ - */␊ - manifestUri?: string␊ - /**␊ - * Percentage completed for the drive. ␊ - */␊ - percentComplete?: (number | string)␊ - /**␊ - * The drive's current state.␊ - */␊ - state?: (("Specified" | "Received" | "NeverReceived" | "Transferring" | "Completed" | "CompletedMoreInfo" | "ShippedBack") | string)␊ - /**␊ - * A URI that points to the blob containing the verbose log for the data transfer operation. ␊ - */␊ - verboseLogUri?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the encryption key properties␊ - */␊ - export interface EncryptionKeyDetails {␊ - /**␊ - * The type of kek encryption key.␊ - */␊ - kekType?: (("MicrosoftManaged" | "CustomerManaged") | string)␊ - /**␊ - * Specifies the url for kek encryption key. ␊ - */␊ - kekUrl?: string␊ - /**␊ - * Specifies the keyvault resource id for kek encryption key. ␊ - */␊ - kekVaultResourceID?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A property containing information about the blobs to be exported for an export job. This property is required for export jobs, but must not be specified for import jobs.␊ - */␊ - export interface Export {␊ - /**␊ - * A list of the blobs to be exported.␊ - */␊ - blobList?: (ExportBlobList | string)␊ - /**␊ - * The relative URI to the block blob that contains the list of blob paths or blob path prefixes as defined above, beginning with the container name. If the blob is in root container, the URI must begin with $root. ␊ - */␊ - blobListBlobPath?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A list of the blobs to be exported.␊ - */␊ - export interface ExportBlobList {␊ - /**␊ - * A collection of blob-path strings.␊ - */␊ - blobPath?: (string[] | string)␊ - /**␊ - * A collection of blob-prefix strings.␊ - */␊ - blobPathPrefix?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the return address information for the job.␊ - */␊ - export interface ReturnAddress {␊ - /**␊ - * The city name to use when returning the drives.␊ - */␊ - city: string␊ - /**␊ - * The country or region to use when returning the drives. ␊ - */␊ - countryOrRegion: string␊ - /**␊ - * Email address of the recipient of the returned drives.␊ - */␊ - email: string␊ - /**␊ - * Phone number of the recipient of the returned drives.␊ - */␊ - phone: string␊ - /**␊ - * The postal code to use when returning the drives.␊ - */␊ - postalCode: string␊ - /**␊ - * The name of the recipient who will receive the hard drives when they are returned. ␊ - */␊ - recipientName: string␊ - /**␊ - * The state or province to use when returning the drives.␊ - */␊ - stateOrProvince?: string␊ - /**␊ - * The first line of the street address to use when returning the drives. ␊ - */␊ - streetAddress1: string␊ - /**␊ - * The first line of the street address to use when returning the drives. ␊ - */␊ - streetAddress2?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains information about the package being shipped by the customer to the Microsoft data center.␊ - */␊ - export interface PackageInfomation {␊ - /**␊ - * The name of the carrier that is used to ship the import or export drives.␊ - */␊ - carrierName: string␊ - /**␊ - * The number of drives included in the package.␊ - */␊ - driveCount: (number | string)␊ - /**␊ - * The date when the package is shipped.␊ - */␊ - shipDate: string␊ - /**␊ - * The tracking number of the package.␊ - */␊ - trackingNumber: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the return carrier and customer's account with the carrier.␊ - */␊ - export interface ReturnShipping {␊ - /**␊ - * The customer's account number with the carrier.␊ - */␊ - carrierAccountNumber: string␊ - /**␊ - * The carrier's name.␊ - */␊ - carrierName: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains information about the Microsoft datacenter to which the drives should be shipped.␊ - */␊ - export interface ShippingInformation {␊ - /**␊ - * The city name to use when returning the drives.␊ - */␊ - city?: string␊ - /**␊ - * The country or region to use when returning the drives. ␊ - */␊ - countryOrRegion?: string␊ - /**␊ - * Phone number of the recipient of the returned drives.␊ - */␊ - phone?: string␊ - /**␊ - * The postal code to use when returning the drives.␊ - */␊ - postalCode?: string␊ - /**␊ - * The name of the recipient who will receive the hard drives when they are returned. ␊ - */␊ - recipientName?: string␊ - /**␊ - * The state or province to use when returning the drives.␊ - */␊ - stateOrProvince?: string␊ - /**␊ - * The first line of the street address to use when returning the drives. ␊ - */␊ - streetAddress1?: string␊ - /**␊ - * The first line of the street address to use when returning the drives. ␊ - */␊ - streetAddress2?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones␊ - */␊ - export interface DnsZones {␊ - name: string␊ - type: "Microsoft.Network/dnsZones"␊ - apiVersion: "2017-09-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The etag of the zone.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the zone.␊ - */␊ - properties: ({␊ - [k: string]: unknown␊ - } | string)␊ - resources?: (DnsZones_TXTChildResource | DnsZones_SRVChildResource | DnsZones_SOAChildResource | DnsZones_PTRChildResource | DnsZones_NSChildResource | DnsZones_MXChildResource | DnsZones_CNAMEChildResource | DnsZones_CAAChildResource | DnsZones_AAAAChildResource | DnsZones_AChildResource)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/TXT␊ - */␊ - export interface DnsZones_TXTChildResource {␊ - name: string␊ - type: "TXT"␊ - apiVersion: "2017-09-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents the properties of the records in the record set.␊ - */␊ - export interface RecordSetProperties2 {␊ - /**␊ - * The metadata attached to the record set.␊ - */␊ - metadata?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The TTL (time-to-live) of the records in the record set.␊ - */␊ - TTL?: (number | string)␊ - /**␊ - * The list of A records in the record set.␊ - */␊ - ARecords?: (ARecord2[] | string)␊ - /**␊ - * The list of AAAA records in the record set.␊ - */␊ - AAAARecords?: (AaaaRecord2[] | string)␊ - /**␊ - * The list of MX records in the record set.␊ - */␊ - MXRecords?: (MxRecord2[] | string)␊ - /**␊ - * The list of NS records in the record set.␊ - */␊ - NSRecords?: (NsRecord2[] | string)␊ - /**␊ - * The list of PTR records in the record set.␊ - */␊ - PTRRecords?: (PtrRecord2[] | string)␊ - /**␊ - * The list of SRV records in the record set.␊ - */␊ - SRVRecords?: (SrvRecord2[] | string)␊ - /**␊ - * The list of TXT records in the record set.␊ - */␊ - TXTRecords?: (TxtRecord2[] | string)␊ - /**␊ - * The CNAME record in the record set.␊ - */␊ - CNAMERecord?: (CnameRecord2 | string)␊ - /**␊ - * The SOA record in the record set.␊ - */␊ - SOARecord?: (SoaRecord2 | string)␊ - /**␊ - * The list of CAA records in the record set.␊ - */␊ - caaRecords?: (CaaRecord[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An A record.␊ - */␊ - export interface ARecord2 {␊ - /**␊ - * The IPv4 address of this A record.␊ - */␊ - ipv4Address?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An AAAA record.␊ - */␊ - export interface AaaaRecord2 {␊ - /**␊ - * The IPv6 address of this AAAA record.␊ - */␊ - ipv6Address?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An MX record.␊ - */␊ - export interface MxRecord2 {␊ - /**␊ - * The preference value for this MX record.␊ - */␊ - preference?: (number | string)␊ - /**␊ - * The domain name of the mail host for this MX record.␊ - */␊ - exchange?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An NS record.␊ - */␊ - export interface NsRecord2 {␊ - /**␊ - * The name server name for this NS record.␊ - */␊ - nsdname?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A PTR record.␊ - */␊ - export interface PtrRecord2 {␊ - /**␊ - * The PTR target domain name for this PTR record.␊ - */␊ - ptrdname?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An SRV record.␊ - */␊ - export interface SrvRecord2 {␊ - /**␊ - * The priority value for this SRV record.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * The weight value for this SRV record.␊ - */␊ - weight?: (number | string)␊ - /**␊ - * The port value for this SRV record.␊ - */␊ - port?: (number | string)␊ - /**␊ - * The target domain name for this SRV record.␊ - */␊ - target?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A TXT record.␊ - */␊ - export interface TxtRecord2 {␊ - /**␊ - * The text value of this TXT record.␊ - */␊ - value?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A CNAME record.␊ - */␊ - export interface CnameRecord2 {␊ - /**␊ - * The canonical name for this CNAME record.␊ - */␊ - cname?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An SOA record.␊ - */␊ - export interface SoaRecord2 {␊ - /**␊ - * The domain name of the authoritative name server for this SOA record.␊ - */␊ - host?: string␊ - /**␊ - * The email contact for this SOA record.␊ - */␊ - email?: string␊ - /**␊ - * The serial number for this SOA record.␊ - */␊ - serialNumber?: (number | string)␊ - /**␊ - * The refresh value for this SOA record.␊ - */␊ - refreshTime?: (number | string)␊ - /**␊ - * The retry time for this SOA record.␊ - */␊ - retryTime?: (number | string)␊ - /**␊ - * The expire time for this SOA record.␊ - */␊ - expireTime?: (number | string)␊ - /**␊ - * The minimum value for this SOA record. By convention this is used to determine the negative caching duration.␊ - */␊ - minimumTTL?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A CAA record.␊ - */␊ - export interface CaaRecord {␊ - /**␊ - * The flags for this CAA record as an integer between 0 and 255.␊ - */␊ - flags?: (number | string)␊ - /**␊ - * The tag for this CAA record.␊ - */␊ - tag?: string␊ - /**␊ - * The value for this CAA record.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/SRV␊ - */␊ - export interface DnsZones_SRVChildResource {␊ - name: string␊ - type: "SRV"␊ - apiVersion: "2017-09-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/SOA␊ - */␊ - export interface DnsZones_SOAChildResource {␊ - name: string␊ - type: "SOA"␊ - apiVersion: "2017-09-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/PTR␊ - */␊ - export interface DnsZones_PTRChildResource {␊ - name: string␊ - type: "PTR"␊ - apiVersion: "2017-09-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/NS␊ - */␊ - export interface DnsZones_NSChildResource {␊ - name: string␊ - type: "NS"␊ - apiVersion: "2017-09-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/MX␊ - */␊ - export interface DnsZones_MXChildResource {␊ - name: string␊ - type: "MX"␊ - apiVersion: "2017-09-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/CNAME␊ - */␊ - export interface DnsZones_CNAMEChildResource {␊ - name: string␊ - type: "CNAME"␊ - apiVersion: "2017-09-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/CAA␊ - */␊ - export interface DnsZones_CAAChildResource {␊ - name: string␊ - type: "CAA"␊ - apiVersion: "2017-09-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/AAAA␊ - */␊ - export interface DnsZones_AAAAChildResource {␊ - name: string␊ - type: "AAAA"␊ - apiVersion: "2017-09-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/A␊ - */␊ - export interface DnsZones_AChildResource {␊ - name: string␊ - type: "A"␊ - apiVersion: "2017-09-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/A␊ - */␊ - export interface DnsZones_A {␊ - name: string␊ - type: "Microsoft.Network/dnsZones/A"␊ - apiVersion: "2017-09-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/AAAA␊ - */␊ - export interface DnsZones_AAAA {␊ - name: string␊ - type: "Microsoft.Network/dnsZones/AAAA"␊ - apiVersion: "2017-09-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/CAA␊ - */␊ - export interface DnsZones_CAA {␊ - name: string␊ - type: "Microsoft.Network/dnsZones/CAA"␊ - apiVersion: "2017-09-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/CNAME␊ - */␊ - export interface DnsZones_CNAME {␊ - name: string␊ - type: "Microsoft.Network/dnsZones/CNAME"␊ - apiVersion: "2017-09-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/MX␊ - */␊ - export interface DnsZones_MX {␊ - name: string␊ - type: "Microsoft.Network/dnsZones/MX"␊ - apiVersion: "2017-09-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/NS␊ - */␊ - export interface DnsZones_NS {␊ - name: string␊ - type: "Microsoft.Network/dnsZones/NS"␊ - apiVersion: "2017-09-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/PTR␊ - */␊ - export interface DnsZones_PTR {␊ - name: string␊ - type: "Microsoft.Network/dnsZones/PTR"␊ - apiVersion: "2017-09-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/SOA␊ - */␊ - export interface DnsZones_SOA {␊ - name: string␊ - type: "Microsoft.Network/dnsZones/SOA"␊ - apiVersion: "2017-09-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/SRV␊ - */␊ - export interface DnsZones_SRV {␊ - name: string␊ - type: "Microsoft.Network/dnsZones/SRV"␊ - apiVersion: "2017-09-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/TXT␊ - */␊ - export interface DnsZones_TXT {␊ - name: string␊ - type: "Microsoft.Network/dnsZones/TXT"␊ - apiVersion: "2017-09-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/connections␊ - */␊ - export interface Connections2 {␊ - name: string␊ - type: "Microsoft.Network/connections"␊ - apiVersion: "2017-09-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway connection.␊ - */␊ - properties: (VirtualNetworkGatewayConnectionPropertiesFormat2 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewayConnection properties␊ - */␊ - export interface VirtualNetworkGatewayConnectionPropertiesFormat2 {␊ - /**␊ - * The authorizationKey.␊ - */␊ - authorizationKey?: string␊ - /**␊ - * The reference to virtual network gateway resource.␊ - */␊ - virtualNetworkGateway1: (VirtualNetworkGateway2 | SubResource7 | string)␊ - /**␊ - * The reference to virtual network gateway resource.␊ - */␊ - virtualNetworkGateway2?: (VirtualNetworkGateway2 | SubResource7 | string)␊ - /**␊ - * The reference to local network gateway resource.␊ - */␊ - localNetworkGateway2?: (LocalNetworkGateway2 | SubResource7 | string)␊ - /**␊ - * Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.␊ - */␊ - connectionType: (("IPsec" | "Vnet2Vnet" | "ExpressRoute" | "VPNClient") | string)␊ - /**␊ - * The routing weight.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * The IPSec shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The reference to peerings resource.␊ - */␊ - peer?: (SubResource7 | string)␊ - /**␊ - * EnableBgp flag␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * Enable policy-based traffic selectors.␊ - */␊ - usePolicyBasedTrafficSelectors?: (boolean | string)␊ - /**␊ - * The IPSec Policies to be considered by this connection.␊ - */␊ - ipsecPolicies?: (IpsecPolicy2[] | string)␊ - /**␊ - * The resource GUID property of the VirtualNetworkGatewayConnection resource.␊ - */␊ - resourceGuid?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A common class for general resource information␊ - */␊ - export interface VirtualNetworkGateway2 {␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway.␊ - */␊ - properties: (VirtualNetworkGatewayPropertiesFormat2 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGateway properties␊ - */␊ - export interface VirtualNetworkGatewayPropertiesFormat2 {␊ - /**␊ - * IP configurations for virtual network gateway.␊ - */␊ - ipConfigurations?: (VirtualNetworkGatewayIPConfiguration2[] | string)␊ - /**␊ - * The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'.␊ - */␊ - gatewayType?: (("Vpn" | "ExpressRoute") | string)␊ - /**␊ - * The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'.␊ - */␊ - vpnType?: (("PolicyBased" | "RouteBased") | string)␊ - /**␊ - * Whether BGP is enabled for this virtual network gateway or not.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * ActiveActive flag␊ - */␊ - activeActive?: (boolean | string)␊ - /**␊ - * The reference of the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting.␊ - */␊ - gatewayDefaultSite?: (SubResource7 | string)␊ - /**␊ - * The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.␊ - */␊ - sku?: (VirtualNetworkGatewaySku2 | string)␊ - /**␊ - * The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations.␊ - */␊ - vpnClientConfiguration?: (VpnClientConfiguration2 | string)␊ - /**␊ - * Virtual network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings2 | string)␊ - /**␊ - * The resource GUID property of the VirtualNetworkGateway resource.␊ - */␊ - resourceGuid?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration for virtual network gateway␊ - */␊ - export interface VirtualNetworkGatewayIPConfiguration2 {␊ - /**␊ - * Properties of the virtual network gateway ip configuration.␊ - */␊ - properties?: (VirtualNetworkGatewayIPConfigurationPropertiesFormat2 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of VirtualNetworkGatewayIPConfiguration␊ - */␊ - export interface VirtualNetworkGatewayIPConfigurationPropertiesFormat2 {␊ - /**␊ - * The private IP allocation method. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * The reference of the subnet resource.␊ - */␊ - subnet?: (SubResource7 | string)␊ - /**␊ - * The reference of the public IP resource.␊ - */␊ - publicIPAddress?: (SubResource7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewaySku details␊ - */␊ - export interface VirtualNetworkGatewaySku2 {␊ - /**␊ - * Gateway SKU name.␊ - */␊ - name?: (("Basic" | "HighPerformance" | "Standard" | "UltraPerformance" | "VpnGw1" | "VpnGw2" | "VpnGw3") | string)␊ - /**␊ - * Gateway SKU tier.␊ - */␊ - tier?: (("Basic" | "HighPerformance" | "Standard" | "UltraPerformance" | "VpnGw1" | "VpnGw2" | "VpnGw3") | string)␊ - /**␊ - * The capacity.␊ - */␊ - capacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnClientConfiguration for P2S client.␊ - */␊ - export interface VpnClientConfiguration2 {␊ - /**␊ - * The reference of the address space resource which represents Address space for P2S VpnClient.␊ - */␊ - vpnClientAddressPool?: (AddressSpace10 | string)␊ - /**␊ - * VpnClientRootCertificate for virtual network gateway.␊ - */␊ - vpnClientRootCertificates?: (VpnClientRootCertificate2[] | string)␊ - /**␊ - * VpnClientRevokedCertificate for Virtual network gateway.␊ - */␊ - vpnClientRevokedCertificates?: (VpnClientRevokedCertificate2[] | string)␊ - /**␊ - * VpnClientProtocols for Virtual network gateway.␊ - */␊ - vpnClientProtocols?: (("IkeV2" | "SSTP")[] | string)␊ - /**␊ - * The radius server address property of the VirtualNetworkGateway resource for vpn client connection.␊ - */␊ - radiusServerAddress?: string␊ - /**␊ - * The radius secret property of the VirtualNetworkGateway resource for vpn client connection.␊ - */␊ - radiusServerSecret?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client root certificate of virtual network gateway␊ - */␊ - export interface VpnClientRootCertificate2 {␊ - /**␊ - * Properties of the vpn client root certificate.␊ - */␊ - properties: (VpnClientRootCertificatePropertiesFormat2 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of application gateway␊ - */␊ - export interface VpnClientRootCertificatePropertiesFormat2 {␊ - /**␊ - * The certificate public data.␊ - */␊ - publicCertData: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client revoked certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRevokedCertificate2 {␊ - /**␊ - * Properties of the vpn client revoked certificate.␊ - */␊ - properties?: (VpnClientRevokedCertificatePropertiesFormat2 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the revoked VPN client certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRevokedCertificatePropertiesFormat2 {␊ - /**␊ - * The revoked VPN client certificate thumbprint.␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * BGP settings details␊ - */␊ - export interface BgpSettings2 {␊ - /**␊ - * The BGP speaker's ASN.␊ - */␊ - asn?: (number | string)␊ - /**␊ - * The BGP peering address and BGP identifier of this BGP speaker.␊ - */␊ - bgpPeeringAddress?: string␊ - /**␊ - * The weight added to routes learned from this BGP speaker.␊ - */␊ - peerWeight?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A common class for general resource information␊ - */␊ - export interface LocalNetworkGateway2 {␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the local network gateway.␊ - */␊ - properties: (LocalNetworkGatewayPropertiesFormat2 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * LocalNetworkGateway properties␊ - */␊ - export interface LocalNetworkGatewayPropertiesFormat2 {␊ - /**␊ - * Local network site address space.␊ - */␊ - localNetworkAddressSpace?: (AddressSpace10 | string)␊ - /**␊ - * IP address of local network gateway.␊ - */␊ - gatewayIpAddress?: string␊ - /**␊ - * Local network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings2 | string)␊ - /**␊ - * The resource GUID property of the LocalNetworkGateway resource.␊ - */␊ - resourceGuid?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An IPSec Policy configuration for a virtual network gateway connection␊ - */␊ - export interface IpsecPolicy2 {␊ - /**␊ - * The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.␊ - */␊ - saLifeTimeSeconds: (number | string)␊ - /**␊ - * The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.␊ - */␊ - saDataSizeKilobytes: (number | string)␊ - /**␊ - * The IPSec encryption algorithm (IKE phase 1).␊ - */␊ - ipsecEncryption: (("None" | "DES" | "DES3" | "AES128" | "AES192" | "AES256" | "GCMAES128" | "GCMAES192" | "GCMAES256") | string)␊ - /**␊ - * The IPSec integrity algorithm (IKE phase 1).␊ - */␊ - ipsecIntegrity: (("MD5" | "SHA1" | "SHA256" | "GCMAES128" | "GCMAES192" | "GCMAES256") | string)␊ - /**␊ - * The IKE encryption algorithm (IKE phase 2).␊ - */␊ - ikeEncryption: (("DES" | "DES3" | "AES128" | "AES192" | "AES256") | string)␊ - /**␊ - * The IKE integrity algorithm (IKE phase 2).␊ - */␊ - ikeIntegrity: (("MD5" | "SHA1" | "SHA256" | "SHA384") | string)␊ - /**␊ - * The DH Groups used in IKE Phase 1 for initial SA.␊ - */␊ - dhGroup: (("None" | "DHGroup1" | "DHGroup2" | "DHGroup14" | "DHGroup2048" | "ECP256" | "ECP384" | "DHGroup24") | string)␊ - /**␊ - * The DH Groups used in IKE Phase 2 for new child SA.␊ - */␊ - pfsGroup: (("None" | "PFS1" | "PFS2" | "PFS2048" | "ECP256" | "ECP384" | "PFS24") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/localNetworkGateways␊ - */␊ - export interface LocalNetworkGateways2 {␊ - name: string␊ - type: "Microsoft.Network/localNetworkGateways"␊ - apiVersion: "2017-09-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the local network gateway.␊ - */␊ - properties: (LocalNetworkGatewayPropertiesFormat2 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworkGateways␊ - */␊ - export interface VirtualNetworkGateways2 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworkGateways"␊ - apiVersion: "2017-09-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway.␊ - */␊ - properties: (VirtualNetworkGatewayPropertiesFormat2 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnets2 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks/subnets"␊ - apiVersion: "2017-09-01"␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties: (SubnetPropertiesFormat2 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/virtualNetworkPeerings␊ - */␊ - export interface VirtualNetworksVirtualNetworkPeerings2 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks/virtualNetworkPeerings"␊ - apiVersion: "2017-09-01"␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties: (VirtualNetworkPeeringPropertiesFormat2 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones␊ - */␊ - export interface DnsZones1 {␊ - name: string␊ - type: "Microsoft.Network/dnsZones"␊ - apiVersion: "2017-10-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The etag of the zone.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the zone.␊ - */␊ - properties: ({␊ - [k: string]: unknown␊ - } | string)␊ - resources?: (DnsZones_TXTChildResource1 | DnsZones_SRVChildResource1 | DnsZones_SOAChildResource1 | DnsZones_PTRChildResource1 | DnsZones_NSChildResource1 | DnsZones_MXChildResource1 | DnsZones_CNAMEChildResource1 | DnsZones_CAAChildResource1 | DnsZones_AAAAChildResource1 | DnsZones_AChildResource1)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/TXT␊ - */␊ - export interface DnsZones_TXTChildResource1 {␊ - name: string␊ - type: "TXT"␊ - apiVersion: "2017-10-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents the properties of the records in the record set.␊ - */␊ - export interface RecordSetProperties3 {␊ - /**␊ - * The metadata attached to the record set.␊ - */␊ - metadata?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The TTL (time-to-live) of the records in the record set.␊ - */␊ - TTL?: (number | string)␊ - /**␊ - * The list of A records in the record set.␊ - */␊ - ARecords?: (ARecord3[] | string)␊ - /**␊ - * The list of AAAA records in the record set.␊ - */␊ - AAAARecords?: (AaaaRecord3[] | string)␊ - /**␊ - * The list of MX records in the record set.␊ - */␊ - MXRecords?: (MxRecord3[] | string)␊ - /**␊ - * The list of NS records in the record set.␊ - */␊ - NSRecords?: (NsRecord3[] | string)␊ - /**␊ - * The list of PTR records in the record set.␊ - */␊ - PTRRecords?: (PtrRecord3[] | string)␊ - /**␊ - * The list of SRV records in the record set.␊ - */␊ - SRVRecords?: (SrvRecord3[] | string)␊ - /**␊ - * The list of TXT records in the record set.␊ - */␊ - TXTRecords?: (TxtRecord3[] | string)␊ - /**␊ - * The CNAME record in the record set.␊ - */␊ - CNAMERecord?: (CnameRecord3 | string)␊ - /**␊ - * The SOA record in the record set.␊ - */␊ - SOARecord?: (SoaRecord3 | string)␊ - /**␊ - * The list of CAA records in the record set.␊ - */␊ - caaRecords?: (CaaRecord1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An A record.␊ - */␊ - export interface ARecord3 {␊ - /**␊ - * The IPv4 address of this A record.␊ - */␊ - ipv4Address?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An AAAA record.␊ - */␊ - export interface AaaaRecord3 {␊ - /**␊ - * The IPv6 address of this AAAA record.␊ - */␊ - ipv6Address?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An MX record.␊ - */␊ - export interface MxRecord3 {␊ - /**␊ - * The preference value for this MX record.␊ - */␊ - preference?: (number | string)␊ - /**␊ - * The domain name of the mail host for this MX record.␊ - */␊ - exchange?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An NS record.␊ - */␊ - export interface NsRecord3 {␊ - /**␊ - * The name server name for this NS record.␊ - */␊ - nsdname?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A PTR record.␊ - */␊ - export interface PtrRecord3 {␊ - /**␊ - * The PTR target domain name for this PTR record.␊ - */␊ - ptrdname?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An SRV record.␊ - */␊ - export interface SrvRecord3 {␊ - /**␊ - * The priority value for this SRV record.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * The weight value for this SRV record.␊ - */␊ - weight?: (number | string)␊ - /**␊ - * The port value for this SRV record.␊ - */␊ - port?: (number | string)␊ - /**␊ - * The target domain name for this SRV record.␊ - */␊ - target?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A TXT record.␊ - */␊ - export interface TxtRecord3 {␊ - /**␊ - * The text value of this TXT record.␊ - */␊ - value?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A CNAME record.␊ - */␊ - export interface CnameRecord3 {␊ - /**␊ - * The canonical name for this CNAME record.␊ - */␊ - cname?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An SOA record.␊ - */␊ - export interface SoaRecord3 {␊ - /**␊ - * The domain name of the authoritative name server for this SOA record.␊ - */␊ - host?: string␊ - /**␊ - * The email contact for this SOA record.␊ - */␊ - email?: string␊ - /**␊ - * The serial number for this SOA record.␊ - */␊ - serialNumber?: (number | string)␊ - /**␊ - * The refresh value for this SOA record.␊ - */␊ - refreshTime?: (number | string)␊ - /**␊ - * The retry time for this SOA record.␊ - */␊ - retryTime?: (number | string)␊ - /**␊ - * The expire time for this SOA record.␊ - */␊ - expireTime?: (number | string)␊ - /**␊ - * The minimum value for this SOA record. By convention this is used to determine the negative caching duration.␊ - */␊ - minimumTTL?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A CAA record.␊ - */␊ - export interface CaaRecord1 {␊ - /**␊ - * The flags for this CAA record as an integer between 0 and 255.␊ - */␊ - flags?: (number | string)␊ - /**␊ - * The tag for this CAA record.␊ - */␊ - tag?: string␊ - /**␊ - * The value for this CAA record.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/SRV␊ - */␊ - export interface DnsZones_SRVChildResource1 {␊ - name: string␊ - type: "SRV"␊ - apiVersion: "2017-10-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/SOA␊ - */␊ - export interface DnsZones_SOAChildResource1 {␊ - name: string␊ - type: "SOA"␊ - apiVersion: "2017-10-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/PTR␊ - */␊ - export interface DnsZones_PTRChildResource1 {␊ - name: string␊ - type: "PTR"␊ - apiVersion: "2017-10-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/NS␊ - */␊ - export interface DnsZones_NSChildResource1 {␊ - name: string␊ - type: "NS"␊ - apiVersion: "2017-10-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/MX␊ - */␊ - export interface DnsZones_MXChildResource1 {␊ - name: string␊ - type: "MX"␊ - apiVersion: "2017-10-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/CNAME␊ - */␊ - export interface DnsZones_CNAMEChildResource1 {␊ - name: string␊ - type: "CNAME"␊ - apiVersion: "2017-10-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/CAA␊ - */␊ - export interface DnsZones_CAAChildResource1 {␊ - name: string␊ - type: "CAA"␊ - apiVersion: "2017-10-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/AAAA␊ - */␊ - export interface DnsZones_AAAAChildResource1 {␊ - name: string␊ - type: "AAAA"␊ - apiVersion: "2017-10-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/A␊ - */␊ - export interface DnsZones_AChildResource1 {␊ - name: string␊ - type: "A"␊ - apiVersion: "2017-10-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/A␊ - */␊ - export interface DnsZones_A1 {␊ - name: string␊ - type: "Microsoft.Network/dnsZones/A"␊ - apiVersion: "2017-10-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/AAAA␊ - */␊ - export interface DnsZones_AAAA1 {␊ - name: string␊ - type: "Microsoft.Network/dnsZones/AAAA"␊ - apiVersion: "2017-10-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/CAA␊ - */␊ - export interface DnsZones_CAA1 {␊ - name: string␊ - type: "Microsoft.Network/dnsZones/CAA"␊ - apiVersion: "2017-10-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/CNAME␊ - */␊ - export interface DnsZones_CNAME1 {␊ - name: string␊ - type: "Microsoft.Network/dnsZones/CNAME"␊ - apiVersion: "2017-10-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/MX␊ - */␊ - export interface DnsZones_MX1 {␊ - name: string␊ - type: "Microsoft.Network/dnsZones/MX"␊ - apiVersion: "2017-10-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/NS␊ - */␊ - export interface DnsZones_NS1 {␊ - name: string␊ - type: "Microsoft.Network/dnsZones/NS"␊ - apiVersion: "2017-10-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/PTR␊ - */␊ - export interface DnsZones_PTR1 {␊ - name: string␊ - type: "Microsoft.Network/dnsZones/PTR"␊ - apiVersion: "2017-10-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/SOA␊ - */␊ - export interface DnsZones_SOA1 {␊ - name: string␊ - type: "Microsoft.Network/dnsZones/SOA"␊ - apiVersion: "2017-10-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/SRV␊ - */␊ - export interface DnsZones_SRV1 {␊ - name: string␊ - type: "Microsoft.Network/dnsZones/SRV"␊ - apiVersion: "2017-10-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/TXT␊ - */␊ - export interface DnsZones_TXT1 {␊ - name: string␊ - type: "Microsoft.Network/dnsZones/TXT"␊ - apiVersion: "2017-10-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/connections␊ - */␊ - export interface Connections3 {␊ - name: string␊ - type: "Microsoft.Network/connections"␊ - apiVersion: "2017-10-01"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway connection.␊ - */␊ - properties: (VirtualNetworkGatewayConnectionPropertiesFormat3 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewayConnection properties␊ - */␊ - export interface VirtualNetworkGatewayConnectionPropertiesFormat3 {␊ - /**␊ - * The authorizationKey.␊ - */␊ - authorizationKey?: string␊ - /**␊ - * The reference to virtual network gateway resource.␊ - */␊ - virtualNetworkGateway1: (VirtualNetworkGateway3 | SubResource8 | string)␊ - /**␊ - * The reference to virtual network gateway resource.␊ - */␊ - virtualNetworkGateway2?: (VirtualNetworkGateway3 | SubResource8 | string)␊ - /**␊ - * The reference to local network gateway resource.␊ - */␊ - localNetworkGateway2?: (LocalNetworkGateway3 | SubResource8 | string)␊ - /**␊ - * Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.␊ - */␊ - connectionType: (("IPsec" | "Vnet2Vnet" | "ExpressRoute" | "VPNClient") | string)␊ - /**␊ - * The routing weight.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * The IPSec shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The reference to peerings resource.␊ - */␊ - peer?: (SubResource8 | string)␊ - /**␊ - * EnableBgp flag␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * Enable policy-based traffic selectors.␊ - */␊ - usePolicyBasedTrafficSelectors?: (boolean | string)␊ - /**␊ - * The IPSec Policies to be considered by this connection.␊ - */␊ - ipsecPolicies?: (IpsecPolicy3[] | string)␊ - /**␊ - * The resource GUID property of the VirtualNetworkGatewayConnection resource.␊ - */␊ - resourceGuid?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A common class for general resource information␊ - */␊ - export interface VirtualNetworkGateway3 {␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway.␊ - */␊ - properties: (VirtualNetworkGatewayPropertiesFormat3 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGateway properties␊ - */␊ - export interface VirtualNetworkGatewayPropertiesFormat3 {␊ - /**␊ - * IP configurations for virtual network gateway.␊ - */␊ - ipConfigurations?: (VirtualNetworkGatewayIPConfiguration3[] | string)␊ - /**␊ - * The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'.␊ - */␊ - gatewayType?: (("Vpn" | "ExpressRoute") | string)␊ - /**␊ - * The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'.␊ - */␊ - vpnType?: (("PolicyBased" | "RouteBased") | string)␊ - /**␊ - * Whether BGP is enabled for this virtual network gateway or not.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * ActiveActive flag␊ - */␊ - activeActive?: (boolean | string)␊ - /**␊ - * The reference of the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting.␊ - */␊ - gatewayDefaultSite?: (SubResource8 | string)␊ - /**␊ - * The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.␊ - */␊ - sku?: (VirtualNetworkGatewaySku3 | string)␊ - /**␊ - * The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations.␊ - */␊ - vpnClientConfiguration?: (VpnClientConfiguration3 | string)␊ - /**␊ - * Virtual network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings3 | string)␊ - /**␊ - * The resource GUID property of the VirtualNetworkGateway resource.␊ - */␊ - resourceGuid?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration for virtual network gateway␊ - */␊ - export interface VirtualNetworkGatewayIPConfiguration3 {␊ - /**␊ - * Properties of the virtual network gateway ip configuration.␊ - */␊ - properties?: (VirtualNetworkGatewayIPConfigurationPropertiesFormat3 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of VirtualNetworkGatewayIPConfiguration␊ - */␊ - export interface VirtualNetworkGatewayIPConfigurationPropertiesFormat3 {␊ - /**␊ - * The private IP allocation method. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * The reference of the subnet resource.␊ - */␊ - subnet?: (SubResource8 | string)␊ - /**␊ - * The reference of the public IP resource.␊ - */␊ - publicIPAddress?: (SubResource8 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewaySku details␊ - */␊ - export interface VirtualNetworkGatewaySku3 {␊ - /**␊ - * Gateway SKU name.␊ - */␊ - name?: (("Basic" | "HighPerformance" | "Standard" | "UltraPerformance" | "VpnGw1" | "VpnGw2" | "VpnGw3") | string)␊ - /**␊ - * Gateway SKU tier.␊ - */␊ - tier?: (("Basic" | "HighPerformance" | "Standard" | "UltraPerformance" | "VpnGw1" | "VpnGw2" | "VpnGw3") | string)␊ - /**␊ - * The capacity.␊ - */␊ - capacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnClientConfiguration for P2S client.␊ - */␊ - export interface VpnClientConfiguration3 {␊ - /**␊ - * The reference of the address space resource which represents Address space for P2S VpnClient.␊ - */␊ - vpnClientAddressPool?: (AddressSpace11 | string)␊ - /**␊ - * VpnClientRootCertificate for virtual network gateway.␊ - */␊ - vpnClientRootCertificates?: (VpnClientRootCertificate3[] | string)␊ - /**␊ - * VpnClientRevokedCertificate for Virtual network gateway.␊ - */␊ - vpnClientRevokedCertificates?: (VpnClientRevokedCertificate3[] | string)␊ - /**␊ - * VpnClientProtocols for Virtual network gateway.␊ - */␊ - vpnClientProtocols?: (("IkeV2" | "SSTP")[] | string)␊ - /**␊ - * The radius server address property of the VirtualNetworkGateway resource for vpn client connection.␊ - */␊ - radiusServerAddress?: string␊ - /**␊ - * The radius secret property of the VirtualNetworkGateway resource for vpn client connection.␊ - */␊ - radiusServerSecret?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client root certificate of virtual network gateway␊ - */␊ - export interface VpnClientRootCertificate3 {␊ - /**␊ - * Properties of the vpn client root certificate.␊ - */␊ - properties: (VpnClientRootCertificatePropertiesFormat3 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of application gateway␊ - */␊ - export interface VpnClientRootCertificatePropertiesFormat3 {␊ - /**␊ - * The certificate public data.␊ - */␊ - publicCertData: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client revoked certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRevokedCertificate3 {␊ - /**␊ - * Properties of the vpn client revoked certificate.␊ - */␊ - properties?: (VpnClientRevokedCertificatePropertiesFormat3 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the revoked VPN client certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRevokedCertificatePropertiesFormat3 {␊ - /**␊ - * The revoked VPN client certificate thumbprint.␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * BGP settings details␊ - */␊ - export interface BgpSettings3 {␊ - /**␊ - * The BGP speaker's ASN.␊ - */␊ - asn?: (number | string)␊ - /**␊ - * The BGP peering address and BGP identifier of this BGP speaker.␊ - */␊ - bgpPeeringAddress?: string␊ - /**␊ - * The weight added to routes learned from this BGP speaker.␊ - */␊ - peerWeight?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A common class for general resource information␊ - */␊ - export interface LocalNetworkGateway3 {␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the local network gateway.␊ - */␊ - properties: (LocalNetworkGatewayPropertiesFormat3 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * LocalNetworkGateway properties␊ - */␊ - export interface LocalNetworkGatewayPropertiesFormat3 {␊ - /**␊ - * Local network site address space.␊ - */␊ - localNetworkAddressSpace?: (AddressSpace11 | string)␊ - /**␊ - * IP address of local network gateway.␊ - */␊ - gatewayIpAddress?: string␊ - /**␊ - * Local network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings3 | string)␊ - /**␊ - * The resource GUID property of the LocalNetworkGateway resource.␊ - */␊ - resourceGuid?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An IPSec Policy configuration for a virtual network gateway connection␊ - */␊ - export interface IpsecPolicy3 {␊ - /**␊ - * The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.␊ - */␊ - saLifeTimeSeconds: (number | string)␊ - /**␊ - * The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.␊ - */␊ - saDataSizeKilobytes: (number | string)␊ - /**␊ - * The IPSec encryption algorithm (IKE phase 1).␊ - */␊ - ipsecEncryption: (("None" | "DES" | "DES3" | "AES128" | "AES192" | "AES256" | "GCMAES128" | "GCMAES192" | "GCMAES256") | string)␊ - /**␊ - * The IPSec integrity algorithm (IKE phase 1).␊ - */␊ - ipsecIntegrity: (("MD5" | "SHA1" | "SHA256" | "GCMAES128" | "GCMAES192" | "GCMAES256") | string)␊ - /**␊ - * The IKE encryption algorithm (IKE phase 2).␊ - */␊ - ikeEncryption: (("DES" | "DES3" | "AES128" | "AES192" | "AES256") | string)␊ - /**␊ - * The IKE integrity algorithm (IKE phase 2).␊ - */␊ - ikeIntegrity: (("MD5" | "SHA1" | "SHA256" | "SHA384") | string)␊ - /**␊ - * The DH Groups used in IKE Phase 1 for initial SA.␊ - */␊ - dhGroup: (("None" | "DHGroup1" | "DHGroup2" | "DHGroup14" | "DHGroup2048" | "ECP256" | "ECP384" | "DHGroup24") | string)␊ - /**␊ - * The DH Groups used in IKE Phase 2 for new child SA.␊ - */␊ - pfsGroup: (("None" | "PFS1" | "PFS2" | "PFS2048" | "ECP256" | "ECP384" | "PFS24") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/localNetworkGateways␊ - */␊ - export interface LocalNetworkGateways3 {␊ - name: string␊ - type: "Microsoft.Network/localNetworkGateways"␊ - apiVersion: "2017-10-01"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the local network gateway.␊ - */␊ - properties: (LocalNetworkGatewayPropertiesFormat3 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworkGateways␊ - */␊ - export interface VirtualNetworkGateways3 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworkGateways"␊ - apiVersion: "2017-10-01"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway.␊ - */␊ - properties: (VirtualNetworkGatewayPropertiesFormat3 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnets3 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks/subnets"␊ - apiVersion: "2017-10-01"␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties: (SubnetPropertiesFormat3 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/virtualNetworkPeerings␊ - */␊ - export interface VirtualNetworksVirtualNetworkPeerings3 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks/virtualNetworkPeerings"␊ - apiVersion: "2017-10-01"␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties: (VirtualNetworkPeeringPropertiesFormat3 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.AzureStack/registrations␊ - */␊ - export interface Registrations {␊ - apiVersion: "2017-06-01"␊ - /**␊ - * Location of the resource.␊ - */␊ - location: ("global" | string)␊ - /**␊ - * Name of the Azure Stack registration.␊ - */␊ - name: string␊ - /**␊ - * Properties of the Azure Stack registration resource␊ - */␊ - properties: (RegistrationParameterProperties | string)␊ - resources?: RegistrationsCustomerSubscriptionsChildResource[]␊ - type: "Microsoft.AzureStack/registrations"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Azure Stack registration resource␊ - */␊ - export interface RegistrationParameterProperties {␊ - /**␊ - * The token identifying registered Azure Stack␊ - */␊ - registrationToken: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.AzureStack/registrations/customerSubscriptions␊ - */␊ - export interface RegistrationsCustomerSubscriptionsChildResource {␊ - apiVersion: "2017-06-01"␊ - /**␊ - * The entity tag used for optimistic concurrency when modifying the resource.␊ - */␊ - etag?: string␊ - /**␊ - * Name of the product.␊ - */␊ - name: string␊ - /**␊ - * Customer subscription properties.␊ - */␊ - properties: (CustomerSubscriptionProperties | string)␊ - type: "customerSubscriptions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Customer subscription properties.␊ - */␊ - export interface CustomerSubscriptionProperties {␊ - /**␊ - * Tenant Id.␊ - */␊ - tenantId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.AzureStack/registrations/customerSubscriptions␊ - */␊ - export interface RegistrationsCustomerSubscriptions {␊ - apiVersion: "2017-06-01"␊ - /**␊ - * The entity tag used for optimistic concurrency when modifying the resource.␊ - */␊ - etag?: string␊ - /**␊ - * Name of the product.␊ - */␊ - name: string␊ - /**␊ - * Customer subscription properties.␊ - */␊ - properties: (CustomerSubscriptionProperties | string)␊ - type: "Microsoft.AzureStack/registrations/customerSubscriptions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/publicIPAddresses␊ - */␊ - export interface PublicIPAddresses12 {␊ - name: string␊ - type: "Microsoft.Network/publicIPAddresses"␊ - apiVersion: "2017-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The public IP address SKU.␊ - */␊ - sku?: (PublicIPAddressSku3 | string)␊ - /**␊ - * Public IP address properties.␊ - */␊ - properties: (PublicIPAddressPropertiesFormat4 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a public IP address␊ - */␊ - export interface PublicIPAddressSku3 {␊ - /**␊ - * Name of a public IP address SKU.␊ - */␊ - name?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Public IP address properties.␊ - */␊ - export interface PublicIPAddressPropertiesFormat4 {␊ - /**␊ - * The public IP allocation method. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - publicIPAllocationMethod: (("Static" | "Dynamic") | string)␊ - /**␊ - * The public IP address version. Possible values are: 'IPv4' and 'IPv6'.␊ - */␊ - publicIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The FQDN of the DNS record associated with the public IP address.␊ - */␊ - dnsSettings?: (PublicIPAddressDnsSettings12 | string)␊ - /**␊ - * The list of tags associated with the public IP address.␊ - */␊ - ipTags?: (IpTag[] | string)␊ - /**␊ - * The IP address associated with the public IP address resource.␊ - */␊ - ipAddress?: string␊ - /**␊ - * The idle timeout of the public IP address.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * The resource GUID property of the public IP resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains FQDN of the DNS record associated with the public IP address␊ - */␊ - export interface PublicIPAddressDnsSettings12 {␊ - /**␊ - * Gets or sets the Domain name label.The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.␊ - */␊ - domainNameLabel: string␊ - /**␊ - * Gets the FQDN, Fully qualified domain name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone.␊ - */␊ - fqdn?: string␊ - /**␊ - * Gets or Sets the Reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN. ␊ - */␊ - reverseFqdn?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains the IpTag associated with the public IP address␊ - */␊ - export interface IpTag {␊ - /**␊ - * Gets or sets the ipTag type: Example FirstPartyUsage.␊ - */␊ - ipTagType?: string␊ - /**␊ - * Gets or sets value of the IpTag associated with the public IP. Example SQL, Storage etc␊ - */␊ - tag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks␊ - */␊ - export interface VirtualNetworks12 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks"␊ - apiVersion: "2017-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network.␊ - */␊ - properties: (VirtualNetworkPropertiesFormat4 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: (VirtualNetworksVirtualNetworkPeeringsChildResource4 | VirtualNetworksSubnetsChildResource4)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the virtual network.␊ - */␊ - export interface VirtualNetworkPropertiesFormat4 {␊ - /**␊ - * The AddressSpace that contains an array of IP address ranges that can be used by subnets.␊ - */␊ - addressSpace: (AddressSpace12 | string)␊ - /**␊ - * The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network.␊ - */␊ - dhcpOptions?: (DhcpOptions12 | string)␊ - /**␊ - * A list of subnets in a Virtual Network.␊ - */␊ - subnets?: (Subnet14[] | string)␊ - /**␊ - * A list of peerings in a Virtual Network.␊ - */␊ - virtualNetworkPeerings?: (VirtualNetworkPeering12[] | string)␊ - /**␊ - * The resourceGuid property of the Virtual Network resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - /**␊ - * Indicates if DDoS protection is enabled for all the protected resources in a Virtual Network.␊ - */␊ - enableDdosProtection?: (boolean | string)␊ - /**␊ - * Indicates if Vm protection is enabled for all the subnets in a Virtual Network.␊ - */␊ - enableVmProtection?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.␊ - */␊ - export interface AddressSpace12 {␊ - /**␊ - * A list of address blocks reserved for this virtual network in CIDR notation.␊ - */␊ - addressPrefixes: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DhcpOptions contains an array of DNS servers available to VMs deployed in the virtual network. Standard DHCP option for a subnet overrides VNET DHCP options.␊ - */␊ - export interface DhcpOptions12 {␊ - /**␊ - * The list of DNS servers IP addresses.␊ - */␊ - dnsServers: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Subnet in a virtual network resource.␊ - */␊ - export interface Subnet14 {␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties?: (SubnetPropertiesFormat4 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the subnet.␊ - */␊ - export interface SubnetPropertiesFormat4 {␊ - /**␊ - * The address prefix for the subnet.␊ - */␊ - addressPrefix: string␊ - /**␊ - * The reference of the NetworkSecurityGroup resource.␊ - */␊ - networkSecurityGroup?: (SubResource9 | string)␊ - /**␊ - * The reference of the RouteTable resource.␊ - */␊ - routeTable?: (SubResource9 | string)␊ - /**␊ - * An array of service endpoints.␊ - */␊ - serviceEndpoints?: (ServiceEndpointPropertiesFormat3[] | string)␊ - /**␊ - * Gets an array of references to the external resources using subnet.␊ - */␊ - resourceNavigationLinks?: (ResourceNavigationLink4[] | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Reference to another subresource.␊ - */␊ - export interface SubResource9 {␊ - /**␊ - * Resource ID.␊ - */␊ - id: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The service endpoint properties.␊ - */␊ - export interface ServiceEndpointPropertiesFormat3 {␊ - /**␊ - * The type of the endpoint service.␊ - */␊ - service?: string␊ - /**␊ - * A list of locations.␊ - */␊ - locations?: (string[] | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ResourceNavigationLink resource.␊ - */␊ - export interface ResourceNavigationLink4 {␊ - /**␊ - * Resource navigation link properties format.␊ - */␊ - properties?: (ResourceNavigationLinkFormat4 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ResourceNavigationLink.␊ - */␊ - export interface ResourceNavigationLinkFormat4 {␊ - /**␊ - * Resource type of the linked resource.␊ - */␊ - linkedResourceType?: string␊ - /**␊ - * Link to the external resource␊ - */␊ - link?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peerings in a virtual network resource.␊ - */␊ - export interface VirtualNetworkPeering12 {␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties?: (VirtualNetworkPeeringPropertiesFormat4 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - export interface VirtualNetworkPeeringPropertiesFormat4 {␊ - /**␊ - * Whether the VMs in the linked virtual network space would be able to access all the VMs in local Virtual network space.␊ - */␊ - allowVirtualNetworkAccess?: (boolean | string)␊ - /**␊ - * Whether the forwarded traffic from the VMs in the remote virtual network will be allowed/disallowed.␊ - */␊ - allowForwardedTraffic?: (boolean | string)␊ - /**␊ - * If gateway links can be used in remote virtual networking to link to this virtual network.␊ - */␊ - allowGatewayTransit?: (boolean | string)␊ - /**␊ - * If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway.␊ - */␊ - useRemoteGateways?: (boolean | string)␊ - /**␊ - * The reference of the remote virtual network. The remote virtual network can be in the same or different region (preview). See here to register for the preview and learn more (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering).␊ - */␊ - remoteVirtualNetwork: (SubResource9 | string)␊ - /**␊ - * The reference of the remote virtual network address space.␊ - */␊ - remoteAddressSpace?: (AddressSpace12 | string)␊ - /**␊ - * The status of the virtual network peering. Possible values are 'Initiated', 'Connected', and 'Disconnected'.␊ - */␊ - peeringState?: (("Initiated" | "Connected" | "Disconnected") | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/virtualNetworkPeerings␊ - */␊ - export interface VirtualNetworksVirtualNetworkPeeringsChildResource4 {␊ - name: string␊ - type: "virtualNetworkPeerings"␊ - apiVersion: "2017-11-01"␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties: (VirtualNetworkPeeringPropertiesFormat4 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnetsChildResource4 {␊ - name: string␊ - type: "subnets"␊ - apiVersion: "2017-11-01"␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties: (SubnetPropertiesFormat4 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers␊ - */␊ - export interface LoadBalancers12 {␊ - name: string␊ - type: "Microsoft.Network/loadBalancers"␊ - apiVersion: "2017-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The load balancer SKU.␊ - */␊ - sku?: (LoadBalancerSku3 | string)␊ - /**␊ - * Properties of load balancer.␊ - */␊ - properties: (LoadBalancerPropertiesFormat4 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: LoadBalancersInboundNatRulesChildResource3[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a load balancer␊ - */␊ - export interface LoadBalancerSku3 {␊ - /**␊ - * Name of a load balancer SKU.␊ - */␊ - name?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer.␊ - */␊ - export interface LoadBalancerPropertiesFormat4 {␊ - /**␊ - * Object representing the frontend IPs to be used for the load balancer␊ - */␊ - frontendIPConfigurations?: (FrontendIPConfiguration4[] | string)␊ - /**␊ - * Collection of backend address pools used by a load balancer␊ - */␊ - backendAddressPools?: (BackendAddressPool4[] | string)␊ - /**␊ - * Object collection representing the load balancing rules Gets the provisioning ␊ - */␊ - loadBalancingRules?: (LoadBalancingRule4[] | string)␊ - /**␊ - * Collection of probe objects used in the load balancer␊ - */␊ - probes?: (Probe4[] | string)␊ - /**␊ - * Collection of inbound NAT Rules used by a load balancer. Defining inbound NAT rules on your load balancer is mutually exclusive with defining an inbound NAT pool. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an Inbound NAT pool. They have to reference individual inbound NAT rules.␊ - */␊ - inboundNatRules?: (InboundNatRule5[] | string)␊ - /**␊ - * Defines an external port range for inbound NAT to a single backend port on NICs associated with a load balancer. Inbound NAT rules are created automatically for each NIC associated with the Load Balancer using an external port from this range. Defining an Inbound NAT pool on your Load Balancer is mutually exclusive with defining inbound Nat rules. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an inbound NAT pool. They have to reference individual inbound NAT rules.␊ - */␊ - inboundNatPools?: (InboundNatPool5[] | string)␊ - /**␊ - * The outbound NAT rules.␊ - */␊ - outboundNatRules?: (OutboundNatRule4[] | string)␊ - /**␊ - * The resource GUID property of the load balancer resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP address of the load balancer.␊ - */␊ - export interface FrontendIPConfiguration4 {␊ - /**␊ - * Properties of the load balancer probe.␊ - */␊ - properties?: (FrontendIPConfigurationPropertiesFormat4 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP Configuration of the load balancer.␊ - */␊ - export interface FrontendIPConfigurationPropertiesFormat4 {␊ - /**␊ - * The private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The Private IP allocation method. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * The reference of the subnet resource.␊ - */␊ - subnet?: (SubResource9 | string)␊ - /**␊ - * The reference of the Public IP resource.␊ - */␊ - publicIPAddress?: (SubResource9 | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Pool of backend IP addresses.␊ - */␊ - export interface BackendAddressPool4 {␊ - /**␊ - * Properties of load balancer backend address pool.␊ - */␊ - properties?: (BackendAddressPoolPropertiesFormat4 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the backend address pool.␊ - */␊ - export interface BackendAddressPoolPropertiesFormat4 {␊ - /**␊ - * Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A load balancing rule for a load balancer.␊ - */␊ - export interface LoadBalancingRule4 {␊ - /**␊ - * Properties of load balancer load balancing rule.␊ - */␊ - properties?: (LoadBalancingRulePropertiesFormat4 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer.␊ - */␊ - export interface LoadBalancingRulePropertiesFormat4 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource9 | string)␊ - /**␊ - * A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs.␊ - */␊ - backendAddressPool?: (SubResource9 | string)␊ - /**␊ - * The reference of the load balancer probe used by the load balancing rule.␊ - */␊ - probe?: (SubResource9 | string)␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'.␊ - */␊ - loadDistribution?: (("Default" | "SourceIP" | "SourceIPProtocol") | string)␊ - /**␊ - * The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 0 and 65534. Note that value 0 enables "Any Port"␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port"␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule.␊ - */␊ - disableOutboundSnat?: (boolean | string)␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A load balancer probe.␊ - */␊ - export interface Probe4 {␊ - /**␊ - * Properties of load balancer probe.␊ - */␊ - properties?: (ProbePropertiesFormat4 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Load balancer probe resource.␊ - */␊ - export interface ProbePropertiesFormat4 {␊ - /**␊ - * The protocol of the end point. Possible values are: 'Http' or 'Tcp'. If 'Tcp' is specified, a received ACK is required for the probe to be successful. If 'Http' is specified, a 200 OK response from the specifies URI is required for the probe to be successful.␊ - */␊ - protocol: (("Http" | "Tcp") | string)␊ - /**␊ - * The port for communicating the probe. Possible values range from 1 to 65535, inclusive.␊ - */␊ - port: (number | string)␊ - /**␊ - * The interval, in seconds, for how frequently to probe the endpoint for health status. Typically, the interval is slightly less than half the allocated timeout period (in seconds) which allows two full probes before taking the instance out of rotation. The default value is 15, the minimum value is 5.␊ - */␊ - intervalInSeconds?: (number | string)␊ - /**␊ - * The number of probes where if no response, will result in stopping further traffic from being delivered to the endpoint. This values allows endpoints to be taken out of rotation faster or slower than the typical times used in Azure.␊ - */␊ - numberOfProbes: (number | string)␊ - /**␊ - * The URI used for requesting health status from the VM. Path is required if a protocol is set to http. Otherwise, it is not allowed. There is no default value.␊ - */␊ - requestPath?: string␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT rule of the load balancer.␊ - */␊ - export interface InboundNatRule5 {␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties?: (InboundNatRulePropertiesFormat4 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the inbound NAT rule.␊ - */␊ - export interface InboundNatRulePropertiesFormat4 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource9 | string)␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values range from 1 to 65534.␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * The port used for the internal endpoint. Acceptable values range from 1 to 65535.␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT pool of the load balancer.␊ - */␊ - export interface InboundNatPool5 {␊ - /**␊ - * Properties of load balancer inbound nat pool.␊ - */␊ - properties?: (InboundNatPoolPropertiesFormat4 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Inbound NAT pool.␊ - */␊ - export interface InboundNatPoolPropertiesFormat4 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource9 | string)␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65534.␊ - */␊ - frontendPortRangeStart: (number | string)␊ - /**␊ - * The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65535.␊ - */␊ - frontendPortRangeEnd: (number | string)␊ - /**␊ - * The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound NAT pool of the load balancer.␊ - */␊ - export interface OutboundNatRule4 {␊ - /**␊ - * Properties of load balancer outbound nat rule.␊ - */␊ - properties?: (OutboundNatRulePropertiesFormat4 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound NAT pool of the load balancer.␊ - */␊ - export interface OutboundNatRulePropertiesFormat4 {␊ - /**␊ - * The number of outbound ports to be used for NAT.␊ - */␊ - allocatedOutboundPorts?: (number | string)␊ - /**␊ - * The Frontend IP addresses of the load balancer.␊ - */␊ - frontendIPConfigurations?: (SubResource9[] | string)␊ - /**␊ - * A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs.␊ - */␊ - backendAddressPool: (SubResource9 | string)␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers/inboundNatRules␊ - */␊ - export interface LoadBalancersInboundNatRulesChildResource3 {␊ - name: string␊ - type: "inboundNatRules"␊ - apiVersion: "2017-11-01"␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties: (InboundNatRulePropertiesFormat4 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups␊ - */␊ - export interface NetworkSecurityGroups12 {␊ - name: string␊ - type: "Microsoft.Network/networkSecurityGroups"␊ - apiVersion: "2017-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network security group␊ - */␊ - properties: (NetworkSecurityGroupPropertiesFormat4 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: NetworkSecurityGroupsSecurityRulesChildResource4[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network Security Group resource.␊ - */␊ - export interface NetworkSecurityGroupPropertiesFormat4 {␊ - /**␊ - * A collection of security rules of the network security group.␊ - */␊ - securityRules?: (SecurityRule4[] | string)␊ - /**␊ - * The default security rules of network security group.␊ - */␊ - defaultSecurityRules?: (SecurityRule4[] | string)␊ - /**␊ - * The resource GUID property of the network security group resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network security rule.␊ - */␊ - export interface SecurityRule4 {␊ - /**␊ - * Properties of the security rule␊ - */␊ - properties?: (SecurityRulePropertiesFormat4 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Security rule resource.␊ - */␊ - export interface SecurityRulePropertiesFormat4 {␊ - /**␊ - * A description for this rule. Restricted to 140 chars.␊ - */␊ - description?: string␊ - /**␊ - * Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'.␊ - */␊ - protocol: (("Tcp" | "Udp" | "*") | string)␊ - /**␊ - * The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports.␊ - */␊ - sourcePortRange?: string␊ - /**␊ - * The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports.␊ - */␊ - destinationPortRange?: string␊ - /**␊ - * The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. ␊ - */␊ - sourceAddressPrefix?: string␊ - /**␊ - * The CIDR or source IP ranges.␊ - */␊ - sourceAddressPrefixes?: (string[] | string)␊ - /**␊ - * The application security group specified as source.␊ - */␊ - sourceApplicationSecurityGroups?: (ApplicationSecurityGroup2[] | string)␊ - /**␊ - * The destination address prefix. CIDR or destination IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used.␊ - */␊ - destinationAddressPrefix?: string␊ - /**␊ - * The destination address prefixes. CIDR or destination IP ranges.␊ - */␊ - destinationAddressPrefixes?: (string[] | string)␊ - /**␊ - * The application security group specified as destination.␊ - */␊ - destinationApplicationSecurityGroups?: (ApplicationSecurityGroup2[] | string)␊ - /**␊ - * The source port ranges.␊ - */␊ - sourcePortRanges?: (string[] | string)␊ - /**␊ - * The destination port ranges.␊ - */␊ - destinationPortRanges?: (string[] | string)␊ - /**␊ - * The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'.␊ - */␊ - access: (("Allow" | "Deny") | string)␊ - /**␊ - * The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.␊ - */␊ - priority: (number | string)␊ - /**␊ - * The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'.␊ - */␊ - direction: (("Inbound" | "Outbound") | string)␊ - /**␊ - * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An application security group in a resource group.␊ - */␊ - export interface ApplicationSecurityGroup2 {␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the application security group.␊ - */␊ - properties?: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRulesChildResource4 {␊ - name: string␊ - type: "securityRules"␊ - apiVersion: "2017-11-01"␊ - /**␊ - * Properties of the security rule␊ - */␊ - properties: (SecurityRulePropertiesFormat4 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces␊ - */␊ - export interface NetworkInterfaces13 {␊ - name: string␊ - type: "Microsoft.Network/networkInterfaces"␊ - apiVersion: "2017-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network interface.␊ - */␊ - properties: (NetworkInterfacePropertiesFormat4 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NetworkInterface properties. ␊ - */␊ - export interface NetworkInterfacePropertiesFormat4 {␊ - /**␊ - * The reference of the NetworkSecurityGroup resource.␊ - */␊ - networkSecurityGroup?: (SubResource9 | string)␊ - /**␊ - * A list of IPConfigurations of the network interface.␊ - */␊ - ipConfigurations: (NetworkInterfaceIPConfiguration4[] | string)␊ - /**␊ - * The DNS settings in network interface.␊ - */␊ - dnsSettings?: (NetworkInterfaceDnsSettings12 | string)␊ - /**␊ - * The MAC address of the network interface.␊ - */␊ - macAddress?: string␊ - /**␊ - * Gets whether this is a primary network interface on a virtual machine.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * If the network interface is accelerated networking enabled.␊ - */␊ - enableAcceleratedNetworking?: (boolean | string)␊ - /**␊ - * Indicates whether IP forwarding is enabled on this network interface.␊ - */␊ - enableIPForwarding?: (boolean | string)␊ - /**␊ - * The resource GUID property of the network interface resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IPConfiguration in a network interface.␊ - */␊ - export interface NetworkInterfaceIPConfiguration4 {␊ - /**␊ - * Network interface IP configuration properties.␊ - */␊ - properties?: (NetworkInterfaceIPConfigurationPropertiesFormat4 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration.␊ - */␊ - export interface NetworkInterfaceIPConfigurationPropertiesFormat4 {␊ - /**␊ - * The reference of ApplicationGatewayBackendAddressPool resource.␊ - */␊ - applicationGatewayBackendAddressPools?: (SubResource9[] | string)␊ - /**␊ - * The reference of LoadBalancerBackendAddressPool resource.␊ - */␊ - loadBalancerBackendAddressPools?: (SubResource9[] | string)␊ - /**␊ - * A list of references of LoadBalancerInboundNatRules.␊ - */␊ - loadBalancerInboundNatRules?: (SubResource9[] | string)␊ - /**␊ - * Private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * Defines how a private IP address is assigned. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Available from Api-Version 2016-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.␊ - */␊ - privateIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * Subnet bound to the IP configuration.␊ - */␊ - subnet?: (SubResource9 | string)␊ - /**␊ - * Gets whether this is a primary customer address on the network interface.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * Public IP address bound to the IP configuration.␊ - */␊ - publicIPAddress?: (SubResource9 | string)␊ - /**␊ - * Application security groups in which the IP configuration is included.␊ - */␊ - applicationSecurityGroups?: (SubResource9[] | string)␊ - /**␊ - * The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DNS settings of a network interface.␊ - */␊ - export interface NetworkInterfaceDnsSettings12 {␊ - /**␊ - * List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only value in dnsServers collection.␊ - */␊ - dnsServers?: (string[] | string)␊ - /**␊ - * If the VM that uses this NIC is part of an Availability Set, then this list will have the union of all DNS servers from all NICs that are part of the Availability Set. This property is what is configured on each of those VMs.␊ - */␊ - appliedDnsServers?: (string[] | string)␊ - /**␊ - * Relative DNS name for this NIC used for internal communications between VMs in the same virtual network.␊ - */␊ - internalDnsNameLabel?: string␊ - /**␊ - * Fully qualified DNS name supporting internal communications between VMs in the same virtual network.␊ - */␊ - internalFqdn?: string␊ - /**␊ - * Even if internalDnsNameLabel is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internalDomainNameSuffix.␊ - */␊ - internalDomainNameSuffix?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables␊ - */␊ - export interface RouteTables12 {␊ - name: string␊ - type: "Microsoft.Network/routeTables"␊ - apiVersion: "2017-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the route table.␊ - */␊ - properties: (RouteTablePropertiesFormat4 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: RouteTablesRoutesChildResource4[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Table resource␊ - */␊ - export interface RouteTablePropertiesFormat4 {␊ - /**␊ - * Collection of routes contained within a route table.␊ - */␊ - routes?: (Route4[] | string)␊ - /**␊ - * Gets or sets whether to disable the routes learned by BGP on that route table. True means disable.␊ - */␊ - disableBgpRoutePropagation?: (boolean | string)␊ - /**␊ - * The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource␊ - */␊ - export interface Route4 {␊ - /**␊ - * Properties of the route.␊ - */␊ - properties?: (RoutePropertiesFormat4 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource␊ - */␊ - export interface RoutePropertiesFormat4 {␊ - /**␊ - * The destination CIDR to which the route applies.␊ - */␊ - addressPrefix: string␊ - /**␊ - * The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'.␊ - */␊ - nextHopType: (("VirtualNetworkGateway" | "VnetLocal" | "Internet" | "VirtualAppliance" | "None") | string)␊ - /**␊ - * The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.␊ - */␊ - nextHopIpAddress?: string␊ - /**␊ - * The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutesChildResource4 {␊ - name: string␊ - type: "routes"␊ - apiVersion: "2017-11-01"␊ - /**␊ - * Properties of the route.␊ - */␊ - properties: (RoutePropertiesFormat4 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/applicationGateways␊ - */␊ - export interface ApplicationGateways4 {␊ - name: string␊ - type: "Microsoft.Network/applicationGateways"␊ - apiVersion: "2017-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (ApplicationGatewayPropertiesFormat4 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application gateway.␊ - */␊ - export interface ApplicationGatewayPropertiesFormat4 {␊ - /**␊ - * SKU of the application gateway resource.␊ - */␊ - sku?: (ApplicationGatewaySku4 | string)␊ - /**␊ - * SSL policy of the application gateway resource.␊ - */␊ - sslPolicy?: (ApplicationGatewaySslPolicy4 | string)␊ - /**␊ - * Subnets of application the gateway resource.␊ - */␊ - gatewayIPConfigurations?: (ApplicationGatewayIPConfiguration4[] | string)␊ - /**␊ - * Authentication certificates of the application gateway resource.␊ - */␊ - authenticationCertificates?: (ApplicationGatewayAuthenticationCertificate4[] | string)␊ - /**␊ - * SSL certificates of the application gateway resource.␊ - */␊ - sslCertificates?: (ApplicationGatewaySslCertificate4[] | string)␊ - /**␊ - * Frontend IP addresses of the application gateway resource.␊ - */␊ - frontendIPConfigurations?: (ApplicationGatewayFrontendIPConfiguration4[] | string)␊ - /**␊ - * Frontend ports of the application gateway resource.␊ - */␊ - frontendPorts?: (ApplicationGatewayFrontendPort4[] | string)␊ - /**␊ - * Probes of the application gateway resource.␊ - */␊ - probes?: (ApplicationGatewayProbe4[] | string)␊ - /**␊ - * Backend address pool of the application gateway resource.␊ - */␊ - backendAddressPools?: (ApplicationGatewayBackendAddressPool4[] | string)␊ - /**␊ - * Backend http settings of the application gateway resource.␊ - */␊ - backendHttpSettingsCollection?: (ApplicationGatewayBackendHttpSettings4[] | string)␊ - /**␊ - * Http listeners of the application gateway resource.␊ - */␊ - httpListeners?: (ApplicationGatewayHttpListener4[] | string)␊ - /**␊ - * URL path map of the application gateway resource.␊ - */␊ - urlPathMaps?: (ApplicationGatewayUrlPathMap4[] | string)␊ - /**␊ - * Request routing rules of the application gateway resource.␊ - */␊ - requestRoutingRules?: (ApplicationGatewayRequestRoutingRule4[] | string)␊ - /**␊ - * Redirect configurations of the application gateway resource.␊ - */␊ - redirectConfigurations?: (ApplicationGatewayRedirectConfiguration4[] | string)␊ - /**␊ - * Web application firewall configuration.␊ - */␊ - webApplicationFirewallConfiguration?: (ApplicationGatewayWebApplicationFirewallConfiguration4 | string)␊ - /**␊ - * Whether HTTP2 is enabled on the application gateway resource.␊ - */␊ - enableHttp2?: (boolean | string)␊ - /**␊ - * Resource GUID property of the application gateway resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of an application gateway␊ - */␊ - export interface ApplicationGatewaySku4 {␊ - /**␊ - * Name of an application gateway SKU.␊ - */␊ - name?: (("Standard_Small" | "Standard_Medium" | "Standard_Large" | "WAF_Medium" | "WAF_Large") | string)␊ - /**␊ - * Tier of an application gateway.␊ - */␊ - tier?: (("Standard" | "WAF") | string)␊ - /**␊ - * Capacity (instance count) of an application gateway.␊ - */␊ - capacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application Gateway Ssl policy.␊ - */␊ - export interface ApplicationGatewaySslPolicy4 {␊ - /**␊ - * Ssl protocols to be disabled on application gateway.␊ - */␊ - disabledSslProtocols?: (("TLSv1_0" | "TLSv1_1" | "TLSv1_2")[] | string)␊ - /**␊ - * Type of Ssl Policy.␊ - */␊ - policyType?: (("Predefined" | "Custom") | string)␊ - /**␊ - * Name of Ssl predefined policy.␊ - */␊ - policyName?: (("AppGwSslPolicy20150501" | "AppGwSslPolicy20170401" | "AppGwSslPolicy20170401S") | string)␊ - /**␊ - * Ssl cipher suites to be enabled in the specified order to application gateway.␊ - */␊ - cipherSuites?: (("TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384" | "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256" | "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA" | "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA" | "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384" | "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256" | "TLS_DHE_RSA_WITH_AES_256_CBC_SHA" | "TLS_DHE_RSA_WITH_AES_128_CBC_SHA" | "TLS_RSA_WITH_AES_256_GCM_SHA384" | "TLS_RSA_WITH_AES_128_GCM_SHA256" | "TLS_RSA_WITH_AES_256_CBC_SHA256" | "TLS_RSA_WITH_AES_128_CBC_SHA256" | "TLS_RSA_WITH_AES_256_CBC_SHA" | "TLS_RSA_WITH_AES_128_CBC_SHA" | "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384" | "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256" | "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384" | "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256" | "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA" | "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA" | "TLS_DHE_DSS_WITH_AES_256_CBC_SHA256" | "TLS_DHE_DSS_WITH_AES_128_CBC_SHA256" | "TLS_DHE_DSS_WITH_AES_256_CBC_SHA" | "TLS_DHE_DSS_WITH_AES_128_CBC_SHA" | "TLS_RSA_WITH_3DES_EDE_CBC_SHA" | "TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA" | "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256" | "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384")[] | string)␊ - /**␊ - * Minimum version of Ssl protocol to be supported on application gateway.␊ - */␊ - minProtocolVersion?: (("TLSv1_0" | "TLSv1_1" | "TLSv1_2") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed.␊ - */␊ - export interface ApplicationGatewayIPConfiguration4 {␊ - properties?: (ApplicationGatewayIPConfigurationPropertiesFormat4 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayIPConfigurationPropertiesFormat4 {␊ - /**␊ - * Reference of the subnet resource. A subnet from where application gateway gets its private address.␊ - */␊ - subnet?: (SubResource9 | string)␊ - /**␊ - * Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authentication certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewayAuthenticationCertificate4 {␊ - properties?: (ApplicationGatewayAuthenticationCertificatePropertiesFormat4 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authentication certificates properties of an application gateway.␊ - */␊ - export interface ApplicationGatewayAuthenticationCertificatePropertiesFormat4 {␊ - /**␊ - * Certificate public data.␊ - */␊ - data?: string␊ - /**␊ - * Provisioning state of the authentication certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSL certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewaySslCertificate4 {␊ - properties?: (ApplicationGatewaySslCertificatePropertiesFormat4 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewaySslCertificatePropertiesFormat4 {␊ - /**␊ - * Base-64 encoded pfx certificate. Only applicable in PUT Request.␊ - */␊ - data?: string␊ - /**␊ - * Password for the pfx file specified in data. Only applicable in PUT request.␊ - */␊ - password?: string␊ - /**␊ - * Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request.␊ - */␊ - publicCertData?: string␊ - /**␊ - * Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendIPConfiguration4 {␊ - properties?: (ApplicationGatewayFrontendIPConfigurationPropertiesFormat4 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendIPConfigurationPropertiesFormat4 {␊ - /**␊ - * PrivateIPAddress of the network interface IP Configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * PrivateIP allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Reference of the subnet resource.␊ - */␊ - subnet?: (SubResource9 | string)␊ - /**␊ - * Reference of the PublicIP resource.␊ - */␊ - publicIPAddress?: (SubResource9 | string)␊ - /**␊ - * Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend port of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendPort4 {␊ - properties?: (ApplicationGatewayFrontendPortPropertiesFormat4 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend port of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendPortPropertiesFormat4 {␊ - /**␊ - * Frontend port␊ - */␊ - port?: (number | string)␊ - /**␊ - * Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Probe of the application gateway.␊ - */␊ - export interface ApplicationGatewayProbe4 {␊ - properties?: (ApplicationGatewayProbePropertiesFormat4 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of probe of an application gateway.␊ - */␊ - export interface ApplicationGatewayProbePropertiesFormat4 {␊ - /**␊ - * Protocol.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Host name to send the probe to.␊ - */␊ - host?: string␊ - /**␊ - * Relative path of probe. Valid path starts from '/'. Probe is sent to ://:␊ - */␊ - path?: string␊ - /**␊ - * The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - interval?: (number | string)␊ - /**␊ - * the probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - timeout?: (number | string)␊ - /**␊ - * The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20.␊ - */␊ - unhealthyThreshold?: (number | string)␊ - /**␊ - * Whether the host header should be picked from the backend http settings. Default value is false.␊ - */␊ - pickHostNameFromBackendHttpSettings?: (boolean | string)␊ - /**␊ - * Minimum number of servers that are always marked healthy. Default value is 0.␊ - */␊ - minServers?: (number | string)␊ - /**␊ - * Criterion for classifying a healthy probe response.␊ - */␊ - match?: (ApplicationGatewayProbeHealthResponseMatch4 | string)␊ - /**␊ - * Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application gateway probe health response match␊ - */␊ - export interface ApplicationGatewayProbeHealthResponseMatch4 {␊ - /**␊ - * Body that must be contained in the health response. Default value is empty.␊ - */␊ - body?: string␊ - /**␊ - * Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399.␊ - */␊ - statusCodes?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend Address Pool of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddressPool4 {␊ - properties?: (ApplicationGatewayBackendAddressPoolPropertiesFormat4 | string)␊ - /**␊ - * Resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend Address Pool of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddressPoolPropertiesFormat4 {␊ - /**␊ - * Collection of references to IPs defined in network interfaces.␊ - */␊ - backendIPConfigurations?: (SubResource9[] | string)␊ - /**␊ - * Backend addresses␊ - */␊ - backendAddresses?: (ApplicationGatewayBackendAddress4[] | string)␊ - /**␊ - * Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddress4 {␊ - /**␊ - * Fully qualified domain name (FQDN).␊ - */␊ - fqdn?: string␊ - /**␊ - * IP address␊ - */␊ - ipAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address pool settings of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendHttpSettings4 {␊ - properties?: (ApplicationGatewayBackendHttpSettingsPropertiesFormat4 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend address pool settings of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendHttpSettingsPropertiesFormat4 {␊ - /**␊ - * Port␊ - */␊ - port?: (number | string)␊ - /**␊ - * Protocol.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Cookie based affinity.␊ - */␊ - cookieBasedAffinity?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Request timeout in seconds. Application Gateway will fail the request if response is not received within RequestTimeout. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - requestTimeout?: (number | string)␊ - /**␊ - * Probe resource of an application gateway.␊ - */␊ - probe?: (SubResource9 | string)␊ - /**␊ - * Array of references to application gateway authentication certificates.␊ - */␊ - authenticationCertificates?: (SubResource9[] | string)␊ - /**␊ - * Connection draining of the backend http settings resource.␊ - */␊ - connectionDraining?: (ApplicationGatewayConnectionDraining4 | string)␊ - /**␊ - * Host header to be sent to the backend servers.␊ - */␊ - hostName?: string␊ - /**␊ - * Whether to pick host header should be picked from the host name of the backend server. Default value is false.␊ - */␊ - pickHostNameFromBackendAddress?: (boolean | string)␊ - /**␊ - * Cookie name to use for the affinity cookie.␊ - */␊ - affinityCookieName?: string␊ - /**␊ - * Whether the probe is enabled. Default value is false.␊ - */␊ - probeEnabled?: (boolean | string)␊ - /**␊ - * Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null.␊ - */␊ - path?: string␊ - /**␊ - * Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Connection draining allows open connections to a backend server to be active for a specified time after the backend server got removed from the configuration.␊ - */␊ - export interface ApplicationGatewayConnectionDraining4 {␊ - /**␊ - * Whether connection draining is enabled or not.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds.␊ - */␊ - drainTimeoutInSec: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http listener of an application gateway.␊ - */␊ - export interface ApplicationGatewayHttpListener4 {␊ - properties?: (ApplicationGatewayHttpListenerPropertiesFormat4 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of HTTP listener of an application gateway.␊ - */␊ - export interface ApplicationGatewayHttpListenerPropertiesFormat4 {␊ - /**␊ - * Frontend IP configuration resource of an application gateway.␊ - */␊ - frontendIPConfiguration?: (SubResource9 | string)␊ - /**␊ - * Frontend port resource of an application gateway.␊ - */␊ - frontendPort?: (SubResource9 | string)␊ - /**␊ - * Protocol.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Host name of HTTP listener.␊ - */␊ - hostName?: string␊ - /**␊ - * SSL certificate resource of an application gateway.␊ - */␊ - sslCertificate?: (SubResource9 | string)␊ - /**␊ - * Applicable only if protocol is https. Enables SNI for multi-hosting.␊ - */␊ - requireServerNameIndication?: (boolean | string)␊ - /**␊ - * Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * UrlPathMaps give a url path to the backend mapping information for PathBasedRouting.␊ - */␊ - export interface ApplicationGatewayUrlPathMap4 {␊ - properties?: (ApplicationGatewayUrlPathMapPropertiesFormat4 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of UrlPathMap of the application gateway.␊ - */␊ - export interface ApplicationGatewayUrlPathMapPropertiesFormat4 {␊ - /**␊ - * Default backend address pool resource of URL path map.␊ - */␊ - defaultBackendAddressPool?: (SubResource9 | string)␊ - /**␊ - * Default backend http settings resource of URL path map.␊ - */␊ - defaultBackendHttpSettings?: (SubResource9 | string)␊ - /**␊ - * Default redirect configuration resource of URL path map.␊ - */␊ - defaultRedirectConfiguration?: (SubResource9 | string)␊ - /**␊ - * Path rule of URL path map resource.␊ - */␊ - pathRules?: (ApplicationGatewayPathRule4[] | string)␊ - /**␊ - * Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Path rule of URL path map of an application gateway.␊ - */␊ - export interface ApplicationGatewayPathRule4 {␊ - properties?: (ApplicationGatewayPathRulePropertiesFormat4 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of path rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayPathRulePropertiesFormat4 {␊ - /**␊ - * Path rules of URL path map.␊ - */␊ - paths?: (string[] | string)␊ - /**␊ - * Backend address pool resource of URL path map path rule.␊ - */␊ - backendAddressPool?: (SubResource9 | string)␊ - /**␊ - * Backend http settings resource of URL path map path rule.␊ - */␊ - backendHttpSettings?: (SubResource9 | string)␊ - /**␊ - * Redirect configuration resource of URL path map path rule.␊ - */␊ - redirectConfiguration?: (SubResource9 | string)␊ - /**␊ - * Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Request routing rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayRequestRoutingRule4 {␊ - properties?: (ApplicationGatewayRequestRoutingRulePropertiesFormat4 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of request routing rule of the application gateway.␊ - */␊ - export interface ApplicationGatewayRequestRoutingRulePropertiesFormat4 {␊ - /**␊ - * Rule type.␊ - */␊ - ruleType?: (("Basic" | "PathBasedRouting") | string)␊ - /**␊ - * Backend address pool resource of the application gateway. ␊ - */␊ - backendAddressPool?: (SubResource9 | string)␊ - /**␊ - * Frontend port resource of the application gateway.␊ - */␊ - backendHttpSettings?: (SubResource9 | string)␊ - /**␊ - * Http listener resource of the application gateway. ␊ - */␊ - httpListener?: (SubResource9 | string)␊ - /**␊ - * URL path map resource of the application gateway.␊ - */␊ - urlPathMap?: (SubResource9 | string)␊ - /**␊ - * Redirect configuration resource of the application gateway.␊ - */␊ - redirectConfiguration?: (SubResource9 | string)␊ - /**␊ - * Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Redirect configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayRedirectConfiguration4 {␊ - properties?: (ApplicationGatewayRedirectConfigurationPropertiesFormat4 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of redirect configuration of the application gateway.␊ - */␊ - export interface ApplicationGatewayRedirectConfigurationPropertiesFormat4 {␊ - /**␊ - * Supported http redirection types - Permanent, Temporary, Found, SeeOther.␊ - */␊ - redirectType?: (("Permanent" | "Found" | "SeeOther" | "Temporary") | string)␊ - /**␊ - * Reference to a listener to redirect the request to.␊ - */␊ - targetListener?: (SubResource9 | string)␊ - /**␊ - * Url to redirect the request to.␊ - */␊ - targetUrl?: string␊ - /**␊ - * Include path in the redirected url.␊ - */␊ - includePath?: (boolean | string)␊ - /**␊ - * Include query string in the redirected url.␊ - */␊ - includeQueryString?: (boolean | string)␊ - /**␊ - * Request routing specifying redirect configuration.␊ - */␊ - requestRoutingRules?: (SubResource9[] | string)␊ - /**␊ - * Url path maps specifying default redirect configuration.␊ - */␊ - urlPathMaps?: (SubResource9[] | string)␊ - /**␊ - * Path rules specifying redirect configuration.␊ - */␊ - pathRules?: (SubResource9[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application gateway web application firewall configuration.␊ - */␊ - export interface ApplicationGatewayWebApplicationFirewallConfiguration4 {␊ - /**␊ - * Whether the web application firewall is enabled or not.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * Web application firewall mode.␊ - */␊ - firewallMode: (("Detection" | "Prevention") | string)␊ - /**␊ - * The type of the web application firewall rule set. Possible values are: 'OWASP'.␊ - */␊ - ruleSetType: string␊ - /**␊ - * The version of the rule set type.␊ - */␊ - ruleSetVersion: string␊ - /**␊ - * The disabled rule groups.␊ - */␊ - disabledRuleGroups?: (ApplicationGatewayFirewallDisabledRuleGroup4[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allows to disable rules within a rule group or an entire rule group.␊ - */␊ - export interface ApplicationGatewayFirewallDisabledRuleGroup4 {␊ - /**␊ - * The name of the rule group that will be disabled.␊ - */␊ - ruleGroupName: string␊ - /**␊ - * The list of rules that will be disabled. If null, all rules of the rule group will be disabled.␊ - */␊ - rules?: (number[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/connections␊ - */␊ - export interface Connections4 {␊ - name: string␊ - type: "Microsoft.Network/connections"␊ - apiVersion: "2017-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway connection.␊ - */␊ - properties: (VirtualNetworkGatewayConnectionPropertiesFormat4 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewayConnection properties␊ - */␊ - export interface VirtualNetworkGatewayConnectionPropertiesFormat4 {␊ - /**␊ - * The authorizationKey.␊ - */␊ - authorizationKey?: string␊ - /**␊ - * The reference to virtual network gateway resource.␊ - */␊ - virtualNetworkGateway1: (VirtualNetworkGateway4 | SubResource9 | string)␊ - /**␊ - * The reference to virtual network gateway resource.␊ - */␊ - virtualNetworkGateway2?: (VirtualNetworkGateway4 | SubResource9 | string)␊ - /**␊ - * The reference to local network gateway resource.␊ - */␊ - localNetworkGateway2?: (LocalNetworkGateway4 | SubResource9 | string)␊ - /**␊ - * Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.␊ - */␊ - connectionType: (("IPsec" | "Vnet2Vnet" | "ExpressRoute" | "VPNClient") | string)␊ - /**␊ - * The routing weight.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * The IPSec shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The reference to peerings resource.␊ - */␊ - peer?: (SubResource9 | string)␊ - /**␊ - * EnableBgp flag␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * Enable policy-based traffic selectors.␊ - */␊ - usePolicyBasedTrafficSelectors?: (boolean | string)␊ - /**␊ - * The IPSec Policies to be considered by this connection.␊ - */␊ - ipsecPolicies?: (IpsecPolicy4[] | string)␊ - /**␊ - * The resource GUID property of the VirtualNetworkGatewayConnection resource.␊ - */␊ - resourceGuid?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A common class for general resource information␊ - */␊ - export interface VirtualNetworkGateway4 {␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway.␊ - */␊ - properties: (VirtualNetworkGatewayPropertiesFormat4 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGateway properties␊ - */␊ - export interface VirtualNetworkGatewayPropertiesFormat4 {␊ - /**␊ - * IP configurations for virtual network gateway.␊ - */␊ - ipConfigurations?: (VirtualNetworkGatewayIPConfiguration4[] | string)␊ - /**␊ - * The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'.␊ - */␊ - gatewayType?: (("Vpn" | "ExpressRoute") | string)␊ - /**␊ - * The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'.␊ - */␊ - vpnType?: (("PolicyBased" | "RouteBased") | string)␊ - /**␊ - * Whether BGP is enabled for this virtual network gateway or not.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * ActiveActive flag␊ - */␊ - activeActive?: (boolean | string)␊ - /**␊ - * The reference of the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting.␊ - */␊ - gatewayDefaultSite?: (SubResource9 | string)␊ - /**␊ - * The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.␊ - */␊ - sku?: (VirtualNetworkGatewaySku4 | string)␊ - /**␊ - * The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations.␊ - */␊ - vpnClientConfiguration?: (VpnClientConfiguration4 | string)␊ - /**␊ - * Virtual network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings4 | string)␊ - /**␊ - * The resource GUID property of the VirtualNetworkGateway resource.␊ - */␊ - resourceGuid?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration for virtual network gateway␊ - */␊ - export interface VirtualNetworkGatewayIPConfiguration4 {␊ - /**␊ - * Properties of the virtual network gateway ip configuration.␊ - */␊ - properties?: (VirtualNetworkGatewayIPConfigurationPropertiesFormat4 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of VirtualNetworkGatewayIPConfiguration␊ - */␊ - export interface VirtualNetworkGatewayIPConfigurationPropertiesFormat4 {␊ - /**␊ - * The private IP allocation method. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * The reference of the subnet resource.␊ - */␊ - subnet?: (SubResource9 | string)␊ - /**␊ - * The reference of the public IP resource.␊ - */␊ - publicIPAddress?: (SubResource9 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewaySku details␊ - */␊ - export interface VirtualNetworkGatewaySku4 {␊ - /**␊ - * Gateway SKU name.␊ - */␊ - name?: (("Basic" | "HighPerformance" | "Standard" | "UltraPerformance" | "VpnGw1" | "VpnGw2" | "VpnGw3") | string)␊ - /**␊ - * Gateway SKU tier.␊ - */␊ - tier?: (("Basic" | "HighPerformance" | "Standard" | "UltraPerformance" | "VpnGw1" | "VpnGw2" | "VpnGw3") | string)␊ - /**␊ - * The capacity.␊ - */␊ - capacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnClientConfiguration for P2S client.␊ - */␊ - export interface VpnClientConfiguration4 {␊ - /**␊ - * The reference of the address space resource which represents Address space for P2S VpnClient.␊ - */␊ - vpnClientAddressPool?: (AddressSpace12 | string)␊ - /**␊ - * VpnClientRootCertificate for virtual network gateway.␊ - */␊ - vpnClientRootCertificates?: (VpnClientRootCertificate4[] | string)␊ - /**␊ - * VpnClientRevokedCertificate for Virtual network gateway.␊ - */␊ - vpnClientRevokedCertificates?: (VpnClientRevokedCertificate4[] | string)␊ - /**␊ - * VpnClientProtocols for Virtual network gateway.␊ - */␊ - vpnClientProtocols?: (("IkeV2" | "SSTP")[] | string)␊ - /**␊ - * The radius server address property of the VirtualNetworkGateway resource for vpn client connection.␊ - */␊ - radiusServerAddress?: string␊ - /**␊ - * The radius secret property of the VirtualNetworkGateway resource for vpn client connection.␊ - */␊ - radiusServerSecret?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client root certificate of virtual network gateway␊ - */␊ - export interface VpnClientRootCertificate4 {␊ - /**␊ - * Properties of the vpn client root certificate.␊ - */␊ - properties: (VpnClientRootCertificatePropertiesFormat4 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of application gateway␊ - */␊ - export interface VpnClientRootCertificatePropertiesFormat4 {␊ - /**␊ - * The certificate public data.␊ - */␊ - publicCertData: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client revoked certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRevokedCertificate4 {␊ - /**␊ - * Properties of the vpn client revoked certificate.␊ - */␊ - properties?: (VpnClientRevokedCertificatePropertiesFormat4 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the revoked VPN client certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRevokedCertificatePropertiesFormat4 {␊ - /**␊ - * The revoked VPN client certificate thumbprint.␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * BGP settings details␊ - */␊ - export interface BgpSettings4 {␊ - /**␊ - * The BGP speaker's ASN.␊ - */␊ - asn?: (number | string)␊ - /**␊ - * The BGP peering address and BGP identifier of this BGP speaker.␊ - */␊ - bgpPeeringAddress?: string␊ - /**␊ - * The weight added to routes learned from this BGP speaker.␊ - */␊ - peerWeight?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A common class for general resource information␊ - */␊ - export interface LocalNetworkGateway4 {␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the local network gateway.␊ - */␊ - properties: (LocalNetworkGatewayPropertiesFormat4 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * LocalNetworkGateway properties␊ - */␊ - export interface LocalNetworkGatewayPropertiesFormat4 {␊ - /**␊ - * Local network site address space.␊ - */␊ - localNetworkAddressSpace?: (AddressSpace12 | string)␊ - /**␊ - * IP address of local network gateway.␊ - */␊ - gatewayIpAddress?: string␊ - /**␊ - * Local network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings4 | string)␊ - /**␊ - * The resource GUID property of the LocalNetworkGateway resource.␊ - */␊ - resourceGuid?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An IPSec Policy configuration for a virtual network gateway connection␊ - */␊ - export interface IpsecPolicy4 {␊ - /**␊ - * The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.␊ - */␊ - saLifeTimeSeconds: (number | string)␊ - /**␊ - * The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.␊ - */␊ - saDataSizeKilobytes: (number | string)␊ - /**␊ - * The IPSec encryption algorithm (IKE phase 1).␊ - */␊ - ipsecEncryption: (("None" | "DES" | "DES3" | "AES128" | "AES192" | "AES256" | "GCMAES128" | "GCMAES192" | "GCMAES256") | string)␊ - /**␊ - * The IPSec integrity algorithm (IKE phase 1).␊ - */␊ - ipsecIntegrity: (("MD5" | "SHA1" | "SHA256" | "GCMAES128" | "GCMAES192" | "GCMAES256") | string)␊ - /**␊ - * The IKE encryption algorithm (IKE phase 2).␊ - */␊ - ikeEncryption: (("DES" | "DES3" | "AES128" | "AES192" | "AES256") | string)␊ - /**␊ - * The IKE integrity algorithm (IKE phase 2).␊ - */␊ - ikeIntegrity: (("MD5" | "SHA1" | "SHA256" | "SHA384") | string)␊ - /**␊ - * The DH Groups used in IKE Phase 1 for initial SA.␊ - */␊ - dhGroup: (("None" | "DHGroup1" | "DHGroup2" | "DHGroup14" | "DHGroup2048" | "ECP256" | "ECP384" | "DHGroup24") | string)␊ - /**␊ - * The DH Groups used in IKE Phase 2 for new child SA.␊ - */␊ - pfsGroup: (("None" | "PFS1" | "PFS2" | "PFS2048" | "ECP256" | "ECP384" | "PFS24") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/localNetworkGateways␊ - */␊ - export interface LocalNetworkGateways4 {␊ - name: string␊ - type: "Microsoft.Network/localNetworkGateways"␊ - apiVersion: "2017-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the local network gateway.␊ - */␊ - properties: (LocalNetworkGatewayPropertiesFormat4 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworkGateways␊ - */␊ - export interface VirtualNetworkGateways4 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworkGateways"␊ - apiVersion: "2017-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway.␊ - */␊ - properties: (VirtualNetworkGatewayPropertiesFormat4 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnets4 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks/subnets"␊ - apiVersion: "2017-11-01"␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties: (SubnetPropertiesFormat4 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/virtualNetworkPeerings␊ - */␊ - export interface VirtualNetworksVirtualNetworkPeerings4 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks/virtualNetworkPeerings"␊ - apiVersion: "2017-11-01"␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties: (VirtualNetworkPeeringPropertiesFormat4 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers/inboundNatRules␊ - */␊ - export interface LoadBalancersInboundNatRules3 {␊ - name: string␊ - type: "Microsoft.Network/loadBalancers/inboundNatRules"␊ - apiVersion: "2017-11-01"␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties: (InboundNatRulePropertiesFormat4 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRules4 {␊ - name: string␊ - type: "Microsoft.Network/networkSecurityGroups/securityRules"␊ - apiVersion: "2017-11-01"␊ - /**␊ - * Properties of the security rule␊ - */␊ - properties: (SecurityRulePropertiesFormat4 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutes4 {␊ - name: string␊ - type: "Microsoft.Network/routeTables/routes"␊ - apiVersion: "2017-11-01"␊ - /**␊ - * Properties of the route.␊ - */␊ - properties: (RoutePropertiesFormat4 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/images␊ - */␊ - export interface Images2 {␊ - apiVersion: "2017-12-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the image.␊ - */␊ - name: string␊ - /**␊ - * Describes the properties of an Image.␊ - */␊ - properties: (ImageProperties2 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/images"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the properties of an Image.␊ - */␊ - export interface ImageProperties2 {␊ - sourceVirtualMachine?: (SubResource10 | string)␊ - /**␊ - * Describes a storage profile.␊ - */␊ - storageProfile?: (ImageStorageProfile2 | string)␊ - [k: string]: unknown␊ - }␊ - export interface SubResource10 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a storage profile.␊ - */␊ - export interface ImageStorageProfile2 {␊ - /**␊ - * 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).␊ - */␊ - dataDisks?: (ImageDataDisk2[] | string)␊ - /**␊ - * Describes an Operating System disk.␊ - */␊ - osDisk?: (ImageOSDisk2 | string)␊ - /**␊ - * Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS).␊ - */␊ - zoneResilient?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a data disk.␊ - */␊ - export interface ImageDataDisk2 {␊ - /**␊ - * The Virtual Hard Disk.␊ - */␊ - blobUri?: string␊ - /**␊ - * Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**.␊ - */␊ - caching?: (("None" | "ReadOnly" | "ReadWrite") | string)␊ - /**␊ - * 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␊ - */␊ - diskSizeGB?: (number | string)␊ - /**␊ - * 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.␊ - */␊ - lun: (number | string)␊ - managedDisk?: (SubResource10 | string)␊ - snapshot?: (SubResource10 | string)␊ - /**␊ - * Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS.␊ - */␊ - storageAccountType?: (("Standard_LRS" | "Premium_LRS") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes an Operating System disk.␊ - */␊ - export interface ImageOSDisk2 {␊ - /**␊ - * The Virtual Hard Disk.␊ - */␊ - blobUri?: string␊ - /**␊ - * Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**.␊ - */␊ - caching?: (("None" | "ReadOnly" | "ReadWrite") | string)␊ - /**␊ - * 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␊ - */␊ - diskSizeGB?: (number | string)␊ - managedDisk?: (SubResource10 | string)␊ - /**␊ - * The OS State.␊ - */␊ - osState: (("Generalized" | "Specialized") | string)␊ - /**␊ - * 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**.␊ - */␊ - osType: (("Windows" | "Linux") | string)␊ - snapshot?: (SubResource10 | string)␊ - /**␊ - * Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS.␊ - */␊ - storageAccountType?: (("Standard_LRS" | "Premium_LRS") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/availabilitySets␊ - */␊ - export interface AvailabilitySets3 {␊ - apiVersion: "2017-12-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the availability set.␊ - */␊ - name: string␊ - /**␊ - * The instance view of a resource.␊ - */␊ - properties: (AvailabilitySetProperties2 | string)␊ - /**␊ - * Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name.␊ - */␊ - sku?: (Sku48 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/availabilitySets"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The instance view of a resource.␊ - */␊ - export interface AvailabilitySetProperties2 {␊ - /**␊ - * Fault Domain count.␊ - */␊ - platformFaultDomainCount?: (number | string)␊ - /**␊ - * Update Domain count.␊ - */␊ - platformUpdateDomainCount?: (number | string)␊ - /**␊ - * A list of references to all virtual machines in the availability set.␊ - */␊ - virtualMachines?: (SubResource10[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name.␊ - */␊ - export interface Sku48 {␊ - /**␊ - * Specifies the number of virtual machines in the scale set.␊ - */␊ - capacity?: (number | string)␊ - /**␊ - * The sku name.␊ - */␊ - name?: string␊ - /**␊ - * Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic**␊ - */␊ - tier?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/virtualMachines␊ - */␊ - export interface VirtualMachines4 {␊ - apiVersion: "2017-12-01"␊ - /**␊ - * Identity for the virtual machine.␊ - */␊ - identity?: (VirtualMachineIdentity2 | string)␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the virtual machine.␊ - */␊ - name: string␊ - /**␊ - * 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**.␊ - */␊ - plan?: (Plan3 | string)␊ - /**␊ - * Describes the properties of a Virtual Machine.␊ - */␊ - properties: (VirtualMachineProperties9 | string)␊ - resources?: VirtualMachinesExtensionsChildResource2[]␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/virtualMachines"␊ - /**␊ - * The virtual machine zones.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the virtual machine.␊ - */␊ - export interface VirtualMachineIdentity2 {␊ - /**␊ - * The list of user identities associated with the Virtual Machine. The user identity references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/identities/{identityName}'.␊ - */␊ - identityIds?: (string[] | string)␊ - /**␊ - * The type of identity used for the virtual machine. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.␊ - */␊ - type?: (("SystemAssigned" | "UserAssigned" | "SystemAssigned, UserAssigned" | "None") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * 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**.␊ - */␊ - export interface Plan3 {␊ - /**␊ - * The plan ID.␊ - */␊ - name?: string␊ - /**␊ - * Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.␊ - */␊ - product?: string␊ - /**␊ - * The promotion code.␊ - */␊ - promotionCode?: string␊ - /**␊ - * The publisher ID.␊ - */␊ - publisher?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the properties of a Virtual Machine.␊ - */␊ - export interface VirtualMachineProperties9 {␊ - availabilitySet?: (SubResource10 | string)␊ - /**␊ - * Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15.␊ - */␊ - diagnosticsProfile?: (DiagnosticsProfile2 | string)␊ - /**␊ - * Specifies the hardware settings for the virtual machine.␊ - */␊ - hardwareProfile?: (HardwareProfile3 | string)␊ - /**␊ - * 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␊ - */␊ - licenseType?: string␊ - /**␊ - * Specifies the network interfaces of the virtual machine.␊ - */␊ - networkProfile?: (NetworkProfile3 | string)␊ - /**␊ - * Specifies the operating system settings for the virtual machine.␊ - */␊ - osProfile?: (OSProfile2 | string)␊ - /**␊ - * Specifies the storage settings for the virtual machine disks.␊ - */␊ - storageProfile?: (StorageProfile3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15.␊ - */␊ - export interface DiagnosticsProfile2 {␊ - /**␊ - * Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    You can easily view the output of your console log.

    Azure also enables you to see a screenshot of the VM from the hypervisor.␊ - */␊ - bootDiagnostics?: (BootDiagnostics2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    You can easily view the output of your console log.

    Azure also enables you to see a screenshot of the VM from the hypervisor.␊ - */␊ - export interface BootDiagnostics2 {␊ - /**␊ - * Whether boot diagnostics should be enabled on the Virtual Machine.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Uri of the storage account to use for placing the console output and screenshot.␊ - */␊ - storageUri?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the hardware settings for the virtual machine.␊ - */␊ - export interface HardwareProfile3 {␊ - /**␊ - * 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](https://docs.microsoft.com/rest/api/compute/availabilitysets/listavailablesizes)

    [List all available virtual machine sizes in a region](https://docs.microsoft.com/rest/api/compute/virtualmachinesizes/list)

    [List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes).␊ - */␊ - vmSize?: (("Basic_A0" | "Basic_A1" | "Basic_A2" | "Basic_A3" | "Basic_A4" | "Standard_A0" | "Standard_A1" | "Standard_A2" | "Standard_A3" | "Standard_A4" | "Standard_A5" | "Standard_A6" | "Standard_A7" | "Standard_A8" | "Standard_A9" | "Standard_A10" | "Standard_A11" | "Standard_A1_v2" | "Standard_A2_v2" | "Standard_A4_v2" | "Standard_A8_v2" | "Standard_A2m_v2" | "Standard_A4m_v2" | "Standard_A8m_v2" | "Standard_B1s" | "Standard_B1ms" | "Standard_B2s" | "Standard_B2ms" | "Standard_B4ms" | "Standard_B8ms" | "Standard_D1" | "Standard_D2" | "Standard_D3" | "Standard_D4" | "Standard_D11" | "Standard_D12" | "Standard_D13" | "Standard_D14" | "Standard_D1_v2" | "Standard_D2_v2" | "Standard_D3_v2" | "Standard_D4_v2" | "Standard_D5_v2" | "Standard_D2_v3" | "Standard_D4_v3" | "Standard_D8_v3" | "Standard_D16_v3" | "Standard_D32_v3" | "Standard_D64_v3" | "Standard_D2s_v3" | "Standard_D4s_v3" | "Standard_D8s_v3" | "Standard_D16s_v3" | "Standard_D32s_v3" | "Standard_D64s_v3" | "Standard_D11_v2" | "Standard_D12_v2" | "Standard_D13_v2" | "Standard_D14_v2" | "Standard_D15_v2" | "Standard_DS1" | "Standard_DS2" | "Standard_DS3" | "Standard_DS4" | "Standard_DS11" | "Standard_DS12" | "Standard_DS13" | "Standard_DS14" | "Standard_DS1_v2" | "Standard_DS2_v2" | "Standard_DS3_v2" | "Standard_DS4_v2" | "Standard_DS5_v2" | "Standard_DS11_v2" | "Standard_DS12_v2" | "Standard_DS13_v2" | "Standard_DS14_v2" | "Standard_DS15_v2" | "Standard_DS13-4_v2" | "Standard_DS13-2_v2" | "Standard_DS14-8_v2" | "Standard_DS14-4_v2" | "Standard_E2_v3" | "Standard_E4_v3" | "Standard_E8_v3" | "Standard_E16_v3" | "Standard_E32_v3" | "Standard_E64_v3" | "Standard_E2s_v3" | "Standard_E4s_v3" | "Standard_E8s_v3" | "Standard_E16s_v3" | "Standard_E32s_v3" | "Standard_E64s_v3" | "Standard_E32-16_v3" | "Standard_E32-8s_v3" | "Standard_E64-32s_v3" | "Standard_E64-16s_v3" | "Standard_F1" | "Standard_F2" | "Standard_F4" | "Standard_F8" | "Standard_F16" | "Standard_F1s" | "Standard_F2s" | "Standard_F4s" | "Standard_F8s" | "Standard_F16s" | "Standard_F2s_v2" | "Standard_F4s_v2" | "Standard_F8s_v2" | "Standard_F16s_v2" | "Standard_F32s_v2" | "Standard_F64s_v2" | "Standard_F72s_v2" | "Standard_G1" | "Standard_G2" | "Standard_G3" | "Standard_G4" | "Standard_G5" | "Standard_GS1" | "Standard_GS2" | "Standard_GS3" | "Standard_GS4" | "Standard_GS5" | "Standard_GS4-8" | "Standard_GS4-4" | "Standard_GS5-16" | "Standard_GS5-8" | "Standard_H8" | "Standard_H16" | "Standard_H8m" | "Standard_H16m" | "Standard_H16r" | "Standard_H16mr" | "Standard_L4s" | "Standard_L8s" | "Standard_L16s" | "Standard_L32s" | "Standard_M64s" | "Standard_M64ms" | "Standard_M128s" | "Standard_M128ms" | "Standard_M64-32ms" | "Standard_M64-16ms" | "Standard_M128-64ms" | "Standard_M128-32ms" | "Standard_NC6" | "Standard_NC12" | "Standard_NC24" | "Standard_NC24r" | "Standard_NC6s_v2" | "Standard_NC12s_v2" | "Standard_NC24s_v2" | "Standard_NC24rs_v2" | "Standard_NC6s_v3" | "Standard_NC12s_v3" | "Standard_NC24s_v3" | "Standard_NC24rs_v3" | "Standard_ND6s" | "Standard_ND12s" | "Standard_ND24s" | "Standard_ND24rs" | "Standard_NV6" | "Standard_NV12" | "Standard_NV24") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the network interfaces of the virtual machine.␊ - */␊ - export interface NetworkProfile3 {␊ - /**␊ - * Specifies the list of resource Ids for the network interfaces associated with the virtual machine.␊ - */␊ - networkInterfaces?: (NetworkInterfaceReference2[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a network interface reference.␊ - */␊ - export interface NetworkInterfaceReference2 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Describes a network interface reference properties.␊ - */␊ - properties?: (NetworkInterfaceReferenceProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a network interface reference properties.␊ - */␊ - export interface NetworkInterfaceReferenceProperties2 {␊ - /**␊ - * Specifies the primary network interface in case the virtual machine has more than 1 network interface.␊ - */␊ - primary?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the operating system settings for the virtual machine.␊ - */␊ - export interface OSProfile2 {␊ - /**␊ - * 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)␊ - */␊ - adminPassword?: string␊ - /**␊ - * 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)␊ - */␊ - adminUsername?: string␊ - /**␊ - * Specifies the host OS name of the virtual machine.

    This name cannot be updated after the VM is created.

    **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).␊ - */␊ - computerName?: string␊ - /**␊ - * 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)␊ - */␊ - customData?: string␊ - /**␊ - * 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).␊ - */␊ - linuxConfiguration?: (LinuxConfiguration3 | string)␊ - /**␊ - * Specifies set of certificates that should be installed onto the virtual machine.␊ - */␊ - secrets?: (VaultSecretGroup2[] | string)␊ - /**␊ - * Specifies Windows operating system settings on the virtual machine.␊ - */␊ - windowsConfiguration?: (WindowsConfiguration4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * 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).␊ - */␊ - export interface LinuxConfiguration3 {␊ - /**␊ - * Specifies whether password authentication should be disabled.␊ - */␊ - disablePasswordAuthentication?: (boolean | string)␊ - /**␊ - * SSH configuration for Linux based VMs running on Azure␊ - */␊ - ssh?: (SshConfiguration2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSH configuration for Linux based VMs running on Azure␊ - */␊ - export interface SshConfiguration2 {␊ - /**␊ - * The list of SSH public keys used to authenticate with linux based VMs.␊ - */␊ - publicKeys?: (SshPublicKey2[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed.␊ - */␊ - export interface SshPublicKey2 {␊ - /**␊ - * 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).␊ - */␊ - keyData?: string␊ - /**␊ - * 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␊ - */␊ - path?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a set of certificates which are all in the same Key Vault.␊ - */␊ - export interface VaultSecretGroup2 {␊ - sourceVault?: (SubResource10 | string)␊ - /**␊ - * The list of key vault references in SourceVault which contain certificates.␊ - */␊ - vaultCertificates?: (VaultCertificate2[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM.␊ - */␊ - export interface VaultCertificate2 {␊ - /**␊ - * 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 <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted.␊ - */␊ - certificateStore?: string␊ - /**␊ - * 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":""
    }␊ - */␊ - certificateUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies Windows operating system settings on the virtual machine.␊ - */␊ - export interface WindowsConfiguration4 {␊ - /**␊ - * Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup.␊ - */␊ - additionalUnattendContent?: (AdditionalUnattendContent3[] | string)␊ - /**␊ - * Indicates whether virtual machine is enabled for automatic updates.␊ - */␊ - enableAutomaticUpdates?: (boolean | string)␊ - /**␊ - * 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.␊ - */␊ - provisionVMAgent?: (boolean | string)␊ - /**␊ - * Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time"␊ - */␊ - timeZone?: string␊ - /**␊ - * Describes Windows Remote Management configuration of the VM␊ - */␊ - winRM?: (WinRMConfiguration2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * 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.␊ - */␊ - export interface AdditionalUnattendContent3 {␊ - /**␊ - * The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup.␊ - */␊ - componentName?: ("Microsoft-Windows-Shell-Setup" | string)␊ - /**␊ - * 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.␊ - */␊ - content?: string␊ - /**␊ - * The pass name. Currently, the only allowable value is OobeSystem.␊ - */␊ - passName?: ("OobeSystem" | string)␊ - /**␊ - * Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.␊ - */␊ - settingName?: (("AutoLogon" | "FirstLogonCommands") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes Windows Remote Management configuration of the VM␊ - */␊ - export interface WinRMConfiguration2 {␊ - /**␊ - * The list of Windows Remote Management listeners␊ - */␊ - listeners?: (WinRMListener3[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes Protocol and thumbprint of Windows Remote Management listener␊ - */␊ - export interface WinRMListener3 {␊ - /**␊ - * 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":""
    }␊ - */␊ - certificateUrl?: string␊ - /**␊ - * Specifies the protocol of listener.

    Possible values are:
    **http**

    **https**.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the storage settings for the virtual machine disks.␊ - */␊ - export interface StorageProfile3 {␊ - /**␊ - * 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).␊ - */␊ - dataDisks?: (DataDisk4[] | string)␊ - /**␊ - * 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. NOTE: Image reference publisher and offer can only be set when you create the scale set.␊ - */␊ - imageReference?: (ImageReference4 | string)␊ - /**␊ - * 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).␊ - */␊ - osDisk?: (OSDisk3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a data disk.␊ - */␊ - export interface DataDisk4 {␊ - /**␊ - * Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**.␊ - */␊ - caching?: (("None" | "ReadOnly" | "ReadWrite") | string)␊ - /**␊ - * 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.␊ - */␊ - createOption: (("FromImage" | "Empty" | "Attach") | string)␊ - /**␊ - * Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB␊ - */␊ - diskSizeGB?: (number | string)␊ - /**␊ - * Describes the uri of a disk.␊ - */␊ - image?: (VirtualHardDisk2 | string)␊ - /**␊ - * 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.␊ - */␊ - lun: (number | string)␊ - /**␊ - * The parameters of a managed disk.␊ - */␊ - managedDisk?: (ManagedDiskParameters2 | string)␊ - /**␊ - * The disk name.␊ - */␊ - name?: string␊ - /**␊ - * Describes the uri of a disk.␊ - */␊ - vhd?: (VirtualHardDisk2 | string)␊ - /**␊ - * Specifies whether writeAccelerator should be enabled or disabled on the disk.␊ - */␊ - writeAcceleratorEnabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the uri of a disk.␊ - */␊ - export interface VirtualHardDisk2 {␊ - /**␊ - * Specifies the virtual hard disk's uri.␊ - */␊ - uri?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The parameters of a managed disk.␊ - */␊ - export interface ManagedDiskParameters2 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS.␊ - */␊ - storageAccountType?: (("Standard_LRS" | "Premium_LRS") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * 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. NOTE: Image reference publisher and offer can only be set when you create the scale set.␊ - */␊ - export interface ImageReference4 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Specifies the offer of the platform image or marketplace image used to create the virtual machine.␊ - */␊ - offer?: string␊ - /**␊ - * The image publisher.␊ - */␊ - publisher?: string␊ - /**␊ - * The image SKU.␊ - */␊ - sku?: string␊ - /**␊ - * 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.␊ - */␊ - version?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * 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).␊ - */␊ - export interface OSDisk3 {␊ - /**␊ - * Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**.␊ - */␊ - caching?: (("None" | "ReadOnly" | "ReadWrite") | string)␊ - /**␊ - * 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.␊ - */␊ - createOption: (("FromImage" | "Empty" | "Attach") | string)␊ - /**␊ - * Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB␊ - */␊ - diskSizeGB?: (number | string)␊ - /**␊ - * Describes a Encryption Settings for a Disk␊ - */␊ - encryptionSettings?: (DiskEncryptionSettings2 | string)␊ - /**␊ - * Describes the uri of a disk.␊ - */␊ - image?: (VirtualHardDisk2 | string)␊ - /**␊ - * The parameters of a managed disk.␊ - */␊ - managedDisk?: (ManagedDiskParameters2 | string)␊ - /**␊ - * The disk name.␊ - */␊ - name?: string␊ - /**␊ - * 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**.␊ - */␊ - osType?: (("Windows" | "Linux") | string)␊ - /**␊ - * Describes the uri of a disk.␊ - */␊ - vhd?: (VirtualHardDisk2 | string)␊ - /**␊ - * Specifies whether writeAccelerator should be enabled or disabled on the disk.␊ - */␊ - writeAcceleratorEnabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a Encryption Settings for a Disk␊ - */␊ - export interface DiskEncryptionSettings2 {␊ - /**␊ - * Describes a reference to Key Vault Secret␊ - */␊ - diskEncryptionKey?: (KeyVaultSecretReference2 | string)␊ - /**␊ - * Specifies whether disk encryption should be enabled on the virtual machine.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Describes a reference to Key Vault Key␊ - */␊ - keyEncryptionKey?: (KeyVaultKeyReference2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a reference to Key Vault Secret␊ - */␊ - export interface KeyVaultSecretReference2 {␊ - /**␊ - * The URL referencing a secret in a Key Vault.␊ - */␊ - secretUrl: string␊ - sourceVault: (SubResource10 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a reference to Key Vault Key␊ - */␊ - export interface KeyVaultKeyReference2 {␊ - /**␊ - * The URL referencing a key encryption key in Key Vault.␊ - */␊ - keyUrl: string␊ - sourceVault: (SubResource10 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/virtualMachines/extensions␊ - */␊ - export interface VirtualMachinesExtensionsChildResource2 {␊ - apiVersion: "2017-12-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the virtual machine extension.␊ - */␊ - name: string␊ - properties: (GenericExtension3 | IaaSDiagnostics3 | IaaSAntimalware3 | CustomScriptExtension3 | CustomScriptForLinux3 | LinuxDiagnostic3 | VmAccessForLinux3 | BgInfo3 | VmAccessAgent3 | DscExtension3 | AcronisBackupLinux3 | AcronisBackup3 | LinuxChefClient3 | ChefClient3 | DatadogLinuxAgent3 | DatadogWindowsAgent3 | DockerExtension3 | DynatraceLinux3 | DynatraceWindows3 | Eset3 | HpeSecurityApplicationDefender3 | PuppetAgent3 | Site24X7LinuxServerExtn3 | Site24X7WindowsServerExtn3 | Site24X7ApmInsightExtn3 | TrendMicroDSALinux3 | TrendMicroDSA3 | BmcCtmAgentLinux3 | BmcCtmAgentWindows3 | OSPatchingForLinux3 | VMSnapshot3 | VMSnapshotLinux3 | CustomScript3 | NetworkWatcherAgentWindows3 | NetworkWatcherAgentLinux3)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "extensions"␊ - [k: string]: unknown␊ - }␊ - export interface GenericExtension3 {␊ - /**␊ - * Microsoft.Compute/extensions - Publisher␊ - */␊ - publisher: string␊ - /**␊ - * Microsoft.Compute/extensions - Type␊ - */␊ - type: string␊ - /**␊ - * Microsoft.Compute/extensions - Type handler version␊ - */␊ - typeHandlerVersion: string␊ - /**␊ - * Microsoft.Compute/extensions - Settings␊ - */␊ - settings: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - export interface IaaSDiagnostics3 {␊ - publisher: "Microsoft.Azure.Diagnostics"␊ - type: "IaaSDiagnostics"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - xmlCfg: string␊ - StorageAccount: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - storageAccountName: string␊ - storageAccountKey: string␊ - storageAccountEndPoint: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface IaaSAntimalware3 {␊ - publisher: "Microsoft.Azure.Security"␊ - type: "IaaSAntimalware"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - AntimalwareEnabled: boolean␊ - Exclusions: {␊ - Paths: string␊ - Extensions: string␊ - Processes: string␊ - [k: string]: unknown␊ - }␊ - RealtimeProtectionEnabled: ("true" | "false")␊ - ScheduledScanSettings: {␊ - isEnabled: ("true" | "false")␊ - scanType: string␊ - day: string␊ - time: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface CustomScriptExtension3 {␊ - publisher: "Microsoft.Compute"␊ - type: "CustomScriptExtension"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - fileUris?: string[]␊ - commandToExecute: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - storageAccountName?: string␊ - storageAccountKey?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface CustomScriptForLinux3 {␊ - publisher: "Microsoft.OSTCExtensions"␊ - type: "CustomScriptForLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - fileUris?: string[]␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - commandToExecute: string␊ - storageAccountName?: string␊ - storageAccountKey?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface LinuxDiagnostic3 {␊ - publisher: "Microsoft.OSTCExtensions"␊ - type: "LinuxDiagnostic"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - enableSyslog?: string␊ - mdsdHttpProxy?: string␊ - perCfg?: unknown[]␊ - fileCfg?: unknown[]␊ - xmlCfg?: string␊ - ladCfg?: {␊ - [k: string]: unknown␊ - }␊ - syslogCfg?: string␊ - eventVolume?: string␊ - mdsdCfg?: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - mdsdHttpProxy?: string␊ - storageAccountName: string␊ - storageAccountKey: string␊ - storageAccountEndPoint?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface VmAccessForLinux3 {␊ - publisher: "Microsoft.OSTCExtensions"␊ - type: "VMAccessForLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - check_disk?: boolean␊ - repair_disk?: boolean␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - username: string␊ - password: string␊ - ssh_key: string␊ - reset_ssh: string␊ - remove_user: string␊ - expiration: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface BgInfo3 {␊ - publisher: "Microsoft.Compute"␊ - type: "bginfo"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - [k: string]: unknown␊ - }␊ - export interface VmAccessAgent3 {␊ - publisher: "Microsoft.Compute"␊ - type: "VMAccessAgent"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - username?: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - password?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface DscExtension3 {␊ - publisher: "Microsoft.Powershell"␊ - type: "DSC"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - modulesUrl: string␊ - configurationFunction: string␊ - properties?: string␊ - wmfVersion?: string␊ - privacy?: {␊ - dataCollection?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - dataBlobUri?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface AcronisBackupLinux3 {␊ - publisher: "Acronis.Backup"␊ - type: "AcronisBackupLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - absURL: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - userLogin: string␊ - userPassword: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface AcronisBackup3 {␊ - publisher: "Acronis.Backup"␊ - type: "AcronisBackup"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - absURL: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - userLogin: string␊ - userPassword: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface LinuxChefClient3 {␊ - publisher: "Chef.Bootstrap.WindowsAzure"␊ - type: "LinuxChefClient"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - bootstrap_version?: string␊ - bootstrap_options?: {␊ - chef_node_name: string␊ - chef_server_url: string␊ - validation_client_name: string␊ - node_ssl_verify_mode: string␊ - environment: string␊ - [k: string]: unknown␊ - }␊ - runlist?: string␊ - client_rb?: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - validation_key: string␊ - chef_server_crt: string␊ - secret: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface ChefClient3 {␊ - publisher: "Chef.Bootstrap.WindowsAzure"␊ - type: "ChefClient"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - bootstrap_options?: {␊ - chef_node_name: string␊ - chef_server_url: string␊ - validation_client_name: string␊ - node_ssl_verify_mode: string␊ - environment: string␊ - [k: string]: unknown␊ - }␊ - runlist?: string␊ - client_rb?: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - validation_key: string␊ - chef_server_crt: string␊ - secret: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface DatadogLinuxAgent3 {␊ - publisher: "Datadog.Agent"␊ - type: "DatadogLinuxAgent"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - api_key: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface DatadogWindowsAgent3 {␊ - publisher: "Datadog.Agent"␊ - type: "DatadogWindowsAgent"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - api_key: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface DockerExtension3 {␊ - publisher: "Microsoft.Azure.Extensions"␊ - type: "DockerExtension"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - docker: {␊ - port: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - certs: {␊ - ca: string␊ - cert: string␊ - key: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface DynatraceLinux3 {␊ - publisher: "dynatrace.ruxit"␊ - type: "ruxitAgentLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - tenantId: string␊ - token: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface DynatraceWindows3 {␊ - publisher: "dynatrace.ruxit"␊ - type: "ruxitAgentWindows"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - tenantId: string␊ - token: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Eset3 {␊ - publisher: "ESET"␊ - type: "FileSecurity"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - LicenseKey: string␊ - "Install-RealtimeProtection": boolean␊ - "Install-ProtocolFiltering": boolean␊ - "Install-DeviceControl": boolean␊ - "Enable-Cloud": boolean␊ - "Enable-PUA": boolean␊ - ERAAgentCfgUrl: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface HpeSecurityApplicationDefender3 {␊ - publisher: "HPE.Security.ApplicationDefender"␊ - type: "DotnetAgent"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - protectedSettings: {␊ - key: string␊ - serverURL: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface PuppetAgent3 {␊ - publisher: "Puppet"␊ - type: "PuppetAgent"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - protectedSettings: {␊ - PUPPET_MASTER_SERVER: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Site24X7LinuxServerExtn3 {␊ - publisher: "Site24x7"␊ - type: "Site24x7LinuxServerExtn"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - site24x7AgentType?: "azurevmextnlinuxserver"␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - site24x7LicenseKey: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Site24X7WindowsServerExtn3 {␊ - publisher: "Site24x7"␊ - type: "Site24x7WindowsServerExtn"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - site24x7AgentType?: "azurevmextnwindowsserver"␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - site24x7LicenseKey: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Site24X7ApmInsightExtn3 {␊ - publisher: "Site24x7"␊ - type: "Site24x7ApmInsightExtn"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - site24x7AgentType?: "azurevmextnapminsightclassic"␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - site24x7LicenseKey: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface TrendMicroDSALinux3 {␊ - publisher: "TrendMicro.DeepSecurity"␊ - type: "TrendMicroDSALinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - DSMname: string␊ - DSMport: string␊ - policyNameorID?: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - tenantID: string␊ - tenantPassword: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface TrendMicroDSA3 {␊ - publisher: "TrendMicro.DeepSecurity"␊ - type: "TrendMicroDSA"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - DSMname: string␊ - DSMport: string␊ - policyNameorID?: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - tenantID: string␊ - tenantPassword: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface BmcCtmAgentLinux3 {␊ - publisher: "ctm.bmc.com"␊ - type: "BmcCtmAgentLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - "Control-M Server Name": string␊ - "Agent Port": string␊ - "Host Group": string␊ - "User Account": string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface BmcCtmAgentWindows3 {␊ - publisher: "bmc.ctm"␊ - type: "AgentWinExt"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - "Control-M Server Name": string␊ - "Agent Port": string␊ - "Host Group": string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface OSPatchingForLinux3 {␊ - publisher: "Microsoft.OSTCExtensions"␊ - type: "OSPatchingForLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - disabled: boolean␊ - stop: boolean␊ - installDuration?: string␊ - intervalOfWeeks?: number␊ - dayOfWeek?: string␊ - startTime?: string␊ - rebootAfterPatch?: string␊ - category?: string␊ - oneoff?: boolean␊ - local?: boolean␊ - idleTestScript?: string␊ - healthyTestScript?: string␊ - distUpgradeList?: string␊ - distUpgradeAll?: boolean␊ - vmStatusTest?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - storageAccountName?: string␊ - storageAccountKey?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface VMSnapshot3 {␊ - publisher: "Microsoft.Azure.RecoveryServices"␊ - type: "VMSnapshot"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - locale: string␊ - taskId: string␊ - commandToExecute: string␊ - objectStr: string␊ - logsBlobUri: string␊ - statusBlobUri: string␊ - commandStartTimeUTCTicks: string␊ - vmType: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface VMSnapshotLinux3 {␊ - publisher: "Microsoft.Azure.RecoveryServices"␊ - type: "VMSnapshotLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - locale: string␊ - taskId: string␊ - commandToExecute: string␊ - objectStr: string␊ - logsBlobUri: string␊ - statusBlobUri: string␊ - commandStartTimeUTCTicks: string␊ - vmType: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface CustomScript3 {␊ - publisher: "Microsoft.Azure.Extensions"␊ - type: "CustomScript"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - fileUris: string[]␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - storageAccountName: string␊ - storageAccountKey: string␊ - commandToExecute: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface NetworkWatcherAgentWindows3 {␊ - publisher: "Microsoft.Azure.NetworkWatcher"␊ - type: "NetworkWatcherAgentWindows"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - [k: string]: unknown␊ - }␊ - export interface NetworkWatcherAgentLinux3 {␊ - publisher: "Microsoft.Azure.NetworkWatcher"␊ - type: "NetworkWatcherAgentLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/virtualMachineScaleSets␊ - */␊ - export interface VirtualMachineScaleSets3 {␊ - apiVersion: "2017-12-01"␊ - /**␊ - * Identity for the virtual machine scale set.␊ - */␊ - identity?: (VirtualMachineScaleSetIdentity2 | string)␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the VM scale set to create or update.␊ - */␊ - name: string␊ - /**␊ - * 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**.␊ - */␊ - plan?: (Plan3 | string)␊ - /**␊ - * Describes the properties of a Virtual Machine Scale Set.␊ - */␊ - properties: (VirtualMachineScaleSetProperties2 | string)␊ - resources?: (VirtualMachineScaleSetsExtensionsChildResource1 | VirtualMachineScaleSetsVirtualmachinesChildResource)[]␊ - /**␊ - * Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name.␊ - */␊ - sku?: (Sku48 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/virtualMachineScaleSets"␊ - /**␊ - * The virtual machine scale set zones. NOTE: Availability zones can only be set when you create the scale set.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the virtual machine scale set.␊ - */␊ - export interface VirtualMachineScaleSetIdentity2 {␊ - /**␊ - * The list of user identities associated with the virtual machine scale set. The user identity references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/identities/{identityName}'.␊ - */␊ - identityIds?: (string[] | string)␊ - /**␊ - * The type of identity used for the virtual machine scale set. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine scale set.␊ - */␊ - type?: (("SystemAssigned" | "UserAssigned" | "SystemAssigned, UserAssigned" | "None") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the properties of a Virtual Machine Scale Set.␊ - */␊ - export interface VirtualMachineScaleSetProperties2 {␊ - /**␊ - * Specifies whether the Virtual Machine Scale Set should be overprovisioned.␊ - */␊ - overprovision?: (boolean | string)␊ - /**␊ - * Fault Domain count for each placement group.␊ - */␊ - platformFaultDomainCount?: (number | string)␊ - /**␊ - * When true this limits the scale set to a single placement group, of max size 100 virtual machines.␊ - */␊ - singlePlacementGroup?: (boolean | string)␊ - /**␊ - * Describes an upgrade policy - automatic, manual, or rolling.␊ - */␊ - upgradePolicy?: (UpgradePolicy3 | string)␊ - /**␊ - * Describes a virtual machine scale set virtual machine profile.␊ - */␊ - virtualMachineProfile?: (VirtualMachineScaleSetVMProfile2 | string)␊ - /**␊ - * Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage.␊ - */␊ - zoneBalance?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes an upgrade policy - automatic, manual, or rolling.␊ - */␊ - export interface UpgradePolicy3 {␊ - /**␊ - * Whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the image becomes available.␊ - */␊ - automaticOSUpgrade?: (boolean | string)␊ - /**␊ - * The configuration parameters used for performing automatic OS upgrade.␊ - */␊ - autoOSUpgradePolicy?: (AutoOSUpgradePolicy | string)␊ - /**␊ - * 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.␊ - */␊ - mode?: (("Automatic" | "Manual" | "Rolling") | string)␊ - /**␊ - * The configuration parameters used while performing a rolling upgrade.␊ - */␊ - rollingUpgradePolicy?: (RollingUpgradePolicy1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The configuration parameters used for performing automatic OS upgrade.␊ - */␊ - export interface AutoOSUpgradePolicy {␊ - /**␊ - * Whether OS image rollback feature should be disabled. Default value is false.␊ - */␊ - disableAutoRollback?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The configuration parameters used while performing a rolling upgrade.␊ - */␊ - export interface RollingUpgradePolicy1 {␊ - /**␊ - * 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%.␊ - */␊ - maxBatchInstancePercent?: (number | string)␊ - /**␊ - * 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%.␊ - */␊ - maxUnhealthyInstancePercent?: (number | string)␊ - /**␊ - * 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%.␊ - */␊ - maxUnhealthyUpgradedInstancePercent?: (number | string)␊ - /**␊ - * 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).␊ - */␊ - pauseTimeBetweenBatches?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set virtual machine profile.␊ - */␊ - export interface VirtualMachineScaleSetVMProfile2 {␊ - /**␊ - * Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15.␊ - */␊ - diagnosticsProfile?: (DiagnosticsProfile2 | string)␊ - /**␊ - * Specifies the eviction policy for virtual machines in a low priority scale set.

    Minimum api-version: 2017-10-30-preview.␊ - */␊ - evictionPolicy?: (("Deallocate" | "Delete") | string)␊ - /**␊ - * Describes a virtual machine scale set extension profile.␊ - */␊ - extensionProfile?: (VirtualMachineScaleSetExtensionProfile3 | string)␊ - /**␊ - * 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␊ - */␊ - licenseType?: string␊ - /**␊ - * Describes a virtual machine scale set network profile.␊ - */␊ - networkProfile?: (VirtualMachineScaleSetNetworkProfile3 | string)␊ - /**␊ - * Describes a virtual machine scale set OS profile.␊ - */␊ - osProfile?: (VirtualMachineScaleSetOSProfile2 | string)␊ - /**␊ - * Specifies the priority for the virtual machines in the scale set.

    Minimum api-version: 2017-10-30-preview.␊ - */␊ - priority?: (("Regular" | "Low") | string)␊ - /**␊ - * Describes a virtual machine scale set storage profile.␊ - */␊ - storageProfile?: (VirtualMachineScaleSetStorageProfile3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set extension profile.␊ - */␊ - export interface VirtualMachineScaleSetExtensionProfile3 {␊ - /**␊ - * The virtual machine scale set child extension resources.␊ - */␊ - extensions?: (VirtualMachineScaleSetExtension3[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a Virtual Machine Scale Set Extension.␊ - */␊ - export interface VirtualMachineScaleSetExtension3 {␊ - /**␊ - * The name of the extension.␊ - */␊ - name?: string␊ - properties?: (GenericExtension3 | IaaSDiagnostics3 | IaaSAntimalware3 | CustomScriptExtension3 | CustomScriptForLinux3 | LinuxDiagnostic3 | VmAccessForLinux3 | BgInfo3 | VmAccessAgent3 | DscExtension3 | AcronisBackupLinux3 | AcronisBackup3 | LinuxChefClient3 | ChefClient3 | DatadogLinuxAgent3 | DatadogWindowsAgent3 | DockerExtension3 | DynatraceLinux3 | DynatraceWindows3 | Eset3 | HpeSecurityApplicationDefender3 | PuppetAgent3 | Site24X7LinuxServerExtn3 | Site24X7WindowsServerExtn3 | Site24X7ApmInsightExtn3 | TrendMicroDSALinux3 | TrendMicroDSA3 | BmcCtmAgentLinux3 | BmcCtmAgentWindows3 | OSPatchingForLinux3 | VMSnapshot3 | VMSnapshotLinux3 | CustomScript3 | NetworkWatcherAgentWindows3 | NetworkWatcherAgentLinux3)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set network profile.␊ - */␊ - export interface VirtualMachineScaleSetNetworkProfile3 {␊ - /**␊ - * The API entity reference.␊ - */␊ - healthProbe?: (ApiEntityReference2 | string)␊ - /**␊ - * The list of network configurations.␊ - */␊ - networkInterfaceConfigurations?: (VirtualMachineScaleSetNetworkConfiguration2[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The API entity reference.␊ - */␊ - export interface ApiEntityReference2 {␊ - /**␊ - * The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set network profile's network configurations.␊ - */␊ - export interface VirtualMachineScaleSetNetworkConfiguration2 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * The network configuration name.␊ - */␊ - name: string␊ - /**␊ - * Describes a virtual machine scale set network profile's IP configuration.␊ - */␊ - properties?: (VirtualMachineScaleSetNetworkConfigurationProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set network profile's IP configuration.␊ - */␊ - export interface VirtualMachineScaleSetNetworkConfigurationProperties2 {␊ - /**␊ - * Describes a virtual machines scale sets network configuration's DNS settings.␊ - */␊ - dnsSettings?: (VirtualMachineScaleSetNetworkConfigurationDnsSettings1 | string)␊ - /**␊ - * Specifies whether the network interface is accelerated networking-enabled.␊ - */␊ - enableAcceleratedNetworking?: (boolean | string)␊ - /**␊ - * Whether IP forwarding enabled on this NIC.␊ - */␊ - enableIPForwarding?: (boolean | string)␊ - /**␊ - * Specifies the IP configurations of the network interface.␊ - */␊ - ipConfigurations: (VirtualMachineScaleSetIPConfiguration2[] | string)␊ - networkSecurityGroup?: (SubResource10 | string)␊ - /**␊ - * Specifies the primary network interface in case the virtual machine has more than 1 network interface.␊ - */␊ - primary?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machines scale sets network configuration's DNS settings.␊ - */␊ - export interface VirtualMachineScaleSetNetworkConfigurationDnsSettings1 {␊ - /**␊ - * List of DNS servers IP addresses␊ - */␊ - dnsServers?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set network profile's IP configuration.␊ - */␊ - export interface VirtualMachineScaleSetIPConfiguration2 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * The IP configuration name.␊ - */␊ - name: string␊ - /**␊ - * Describes a virtual machine scale set network profile's IP configuration properties.␊ - */␊ - properties?: (VirtualMachineScaleSetIPConfigurationProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set network profile's IP configuration properties.␊ - */␊ - export interface VirtualMachineScaleSetIPConfigurationProperties2 {␊ - /**␊ - * 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.␊ - */␊ - applicationGatewayBackendAddressPools?: (SubResource10[] | string)␊ - /**␊ - * 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.␊ - */␊ - loadBalancerBackendAddressPools?: (SubResource10[] | string)␊ - /**␊ - * 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␊ - */␊ - loadBalancerInboundNatPools?: (SubResource10[] | string)␊ - /**␊ - * Specifies the primary network interface in case the virtual machine has more than 1 network interface.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * 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'.␊ - */␊ - privateIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration␊ - */␊ - publicIPAddressConfiguration?: (VirtualMachineScaleSetPublicIPAddressConfiguration1 | string)␊ - /**␊ - * The API entity reference.␊ - */␊ - subnet?: (ApiEntityReference2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration␊ - */␊ - export interface VirtualMachineScaleSetPublicIPAddressConfiguration1 {␊ - /**␊ - * The publicIP address configuration name.␊ - */␊ - name: string␊ - /**␊ - * Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration␊ - */␊ - properties?: (VirtualMachineScaleSetPublicIPAddressConfigurationProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration␊ - */␊ - export interface VirtualMachineScaleSetPublicIPAddressConfigurationProperties1 {␊ - /**␊ - * Describes a virtual machines scale sets network configuration's DNS settings.␊ - */␊ - dnsSettings?: (VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings1 | string)␊ - /**␊ - * The idle timeout of the public IP address.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machines scale sets network configuration's DNS settings.␊ - */␊ - export interface VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings1 {␊ - /**␊ - * 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␊ - */␊ - domainNameLabel: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set OS profile.␊ - */␊ - export interface VirtualMachineScaleSetOSProfile2 {␊ - /**␊ - * 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)␊ - */␊ - adminPassword?: string␊ - /**␊ - * 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)␊ - */␊ - adminUsername?: string␊ - /**␊ - * 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.␊ - */␊ - computerNamePrefix?: string␊ - /**␊ - * 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)␊ - */␊ - customData?: string␊ - /**␊ - * 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).␊ - */␊ - linuxConfiguration?: (LinuxConfiguration3 | string)␊ - /**␊ - * Specifies set of certificates that should be installed onto the virtual machines in the scale set.␊ - */␊ - secrets?: (VaultSecretGroup2[] | string)␊ - /**␊ - * Specifies Windows operating system settings on the virtual machine.␊ - */␊ - windowsConfiguration?: (WindowsConfiguration4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set storage profile.␊ - */␊ - export interface VirtualMachineScaleSetStorageProfile3 {␊ - /**␊ - * 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).␊ - */␊ - dataDisks?: (VirtualMachineScaleSetDataDisk2[] | string)␊ - /**␊ - * 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. NOTE: Image reference publisher and offer can only be set when you create the scale set.␊ - */␊ - imageReference?: (ImageReference4 | string)␊ - /**␊ - * Describes a virtual machine scale set operating system disk.␊ - */␊ - osDisk?: (VirtualMachineScaleSetOSDisk3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set data disk.␊ - */␊ - export interface VirtualMachineScaleSetDataDisk2 {␊ - /**␊ - * Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**.␊ - */␊ - caching?: (("None" | "ReadOnly" | "ReadWrite") | string)␊ - /**␊ - * The create option.␊ - */␊ - createOption: (("FromImage" | "Empty" | "Attach") | string)␊ - /**␊ - * Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB␊ - */␊ - diskSizeGB?: (number | string)␊ - /**␊ - * 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.␊ - */␊ - lun: (number | string)␊ - /**␊ - * Describes the parameters of a ScaleSet managed disk.␊ - */␊ - managedDisk?: (VirtualMachineScaleSetManagedDiskParameters2 | string)␊ - /**␊ - * The disk name.␊ - */␊ - name?: string␊ - /**␊ - * Specifies whether writeAccelerator should be enabled or disabled on the disk.␊ - */␊ - writeAcceleratorEnabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the parameters of a ScaleSet managed disk.␊ - */␊ - export interface VirtualMachineScaleSetManagedDiskParameters2 {␊ - /**␊ - * Specifies the storage account type for the managed disk. Managed OS disk storage account type can only be set when you create the scale set. Possible values are: Standard_LRS or Premium_LRS.␊ - */␊ - storageAccountType?: (("Standard_LRS" | "Premium_LRS") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set operating system disk.␊ - */␊ - export interface VirtualMachineScaleSetOSDisk3 {␊ - /**␊ - * Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**.␊ - */␊ - caching?: (("None" | "ReadOnly" | "ReadWrite") | string)␊ - /**␊ - * 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.␊ - */␊ - createOption: (("FromImage" | "Empty" | "Attach") | string)␊ - /**␊ - * Describes the uri of a disk.␊ - */␊ - image?: (VirtualHardDisk2 | string)␊ - /**␊ - * Describes the parameters of a ScaleSet managed disk.␊ - */␊ - managedDisk?: (VirtualMachineScaleSetManagedDiskParameters2 | string)␊ - /**␊ - * The disk name.␊ - */␊ - name?: string␊ - /**␊ - * 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**.␊ - */␊ - osType?: (("Windows" | "Linux") | string)␊ - /**␊ - * Specifies the container urls that are used to store operating system disks for the scale set.␊ - */␊ - vhdContainers?: (string[] | string)␊ - /**␊ - * Specifies whether writeAccelerator should be enabled or disabled on the disk.␊ - */␊ - writeAcceleratorEnabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/virtualMachineScaleSets/extensions␊ - */␊ - export interface VirtualMachineScaleSetsExtensionsChildResource1 {␊ - apiVersion: "2017-12-01"␊ - /**␊ - * The name of the VM scale set extension.␊ - */␊ - name: string␊ - /**␊ - * Describes the properties of a Virtual Machine Scale Set Extension.␊ - */␊ - properties: (VirtualMachineScaleSetExtensionProperties1 | string)␊ - type: "extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the properties of a Virtual Machine Scale Set Extension.␊ - */␊ - export interface VirtualMachineScaleSetExtensionProperties1 {␊ - /**␊ - * 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.␊ - */␊ - autoUpgradeMinorVersion?: (boolean | string)␊ - /**␊ - * 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.␊ - */␊ - forceUpdateTag?: string␊ - /**␊ - * The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.␊ - */␊ - protectedSettings?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The name of the extension handler publisher.␊ - */␊ - publisher?: string␊ - /**␊ - * Json formatted public settings for the extension.␊ - */␊ - settings?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the type of the extension; an example is "CustomScriptExtension".␊ - */␊ - type?: string␊ - /**␊ - * Specifies the version of the script handler.␊ - */␊ - typeHandlerVersion?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/virtualMachineScaleSets/virtualmachines␊ - */␊ - export interface VirtualMachineScaleSetsVirtualmachinesChildResource {␊ - apiVersion: "2017-12-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The instance ID of the virtual machine.␊ - */␊ - name: string␊ - /**␊ - * 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**.␊ - */␊ - plan?: (Plan3 | string)␊ - /**␊ - * Describes the properties of a virtual machine scale set virtual machine.␊ - */␊ - properties: (VirtualMachineScaleSetVMProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "virtualmachines"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the properties of a virtual machine scale set virtual machine.␊ - */␊ - export interface VirtualMachineScaleSetVMProperties {␊ - availabilitySet?: (SubResource10 | string)␊ - /**␊ - * Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15.␊ - */␊ - diagnosticsProfile?: (DiagnosticsProfile2 | string)␊ - /**␊ - * Specifies the hardware settings for the virtual machine.␊ - */␊ - hardwareProfile?: (HardwareProfile3 | string)␊ - /**␊ - * 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␊ - */␊ - licenseType?: string␊ - /**␊ - * Specifies the network interfaces of the virtual machine.␊ - */␊ - networkProfile?: (NetworkProfile3 | string)␊ - /**␊ - * Specifies the operating system settings for the virtual machine.␊ - */␊ - osProfile?: (OSProfile2 | string)␊ - /**␊ - * Specifies the storage settings for the virtual machine disks.␊ - */␊ - storageProfile?: (StorageProfile3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/virtualMachines/extensions␊ - */␊ - export interface VirtualMachinesExtensions2 {␊ - apiVersion: "2017-12-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the virtual machine extension.␊ - */␊ - name: string␊ - properties: (GenericExtension3 | IaaSDiagnostics3 | IaaSAntimalware3 | CustomScriptExtension3 | CustomScriptForLinux3 | LinuxDiagnostic3 | VmAccessForLinux3 | BgInfo3 | VmAccessAgent3 | DscExtension3 | AcronisBackupLinux3 | AcronisBackup3 | LinuxChefClient3 | ChefClient3 | DatadogLinuxAgent3 | DatadogWindowsAgent3 | DockerExtension3 | DynatraceLinux3 | DynatraceWindows3 | Eset3 | HpeSecurityApplicationDefender3 | PuppetAgent3 | Site24X7LinuxServerExtn3 | Site24X7WindowsServerExtn3 | Site24X7ApmInsightExtn3 | TrendMicroDSALinux3 | TrendMicroDSA3 | BmcCtmAgentLinux3 | BmcCtmAgentWindows3 | OSPatchingForLinux3 | VMSnapshot3 | VMSnapshotLinux3 | CustomScript3 | NetworkWatcherAgentWindows3 | NetworkWatcherAgentLinux3)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/virtualMachines/extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/virtualMachineScaleSets/extensions␊ - */␊ - export interface VirtualMachineScaleSetsExtensions {␊ - apiVersion: "2017-12-01"␊ - /**␊ - * The name of the VM scale set extension.␊ - */␊ - name: string␊ - properties: (GenericExtension3 | IaaSDiagnostics3 | IaaSAntimalware3 | CustomScriptExtension3 | CustomScriptForLinux3 | LinuxDiagnostic3 | VmAccessForLinux3 | BgInfo3 | VmAccessAgent3 | DscExtension3 | AcronisBackupLinux3 | AcronisBackup3 | LinuxChefClient3 | ChefClient3 | DatadogLinuxAgent3 | DatadogWindowsAgent3 | DockerExtension3 | DynatraceLinux3 | DynatraceWindows3 | Eset3 | HpeSecurityApplicationDefender3 | PuppetAgent3 | Site24X7LinuxServerExtn3 | Site24X7WindowsServerExtn3 | Site24X7ApmInsightExtn3 | TrendMicroDSALinux3 | TrendMicroDSA3 | BmcCtmAgentLinux3 | BmcCtmAgentWindows3 | OSPatchingForLinux3 | VMSnapshot3 | VMSnapshotLinux3 | CustomScript3 | NetworkWatcherAgentWindows3 | NetworkWatcherAgentLinux3)␊ - type: "Microsoft.Compute/virtualMachineScaleSets/extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforMariaDB/servers␊ - */␊ - export interface Servers4 {␊ - apiVersion: "2018-06-01"␊ - /**␊ - * The location the resource resides in.␊ - */␊ - location: string␊ - /**␊ - * The name of the server.␊ - */␊ - name: string␊ - /**␊ - * The properties used to create a new server.␊ - */␊ - properties: (ServerPropertiesForCreate | string)␊ - resources?: (ServersFirewallRulesChildResource2 | ServersVirtualNetworkRulesChildResource1 | ServersDatabasesChildResource1 | ServersConfigurationsChildResource | ServersPrivateEndpointConnectionsChildResource | ServersSecurityAlertPoliciesChildResource)[]␊ - /**␊ - * Billing information related properties of a server.␊ - */␊ - sku?: (Sku49 | string)␊ - /**␊ - * Application-specific metadata in the form of key-value pairs.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.DBforMariaDB/servers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Storage Profile properties of a server␊ - */␊ - export interface StorageProfile4 {␊ - /**␊ - * Backup retention days for the server.␊ - */␊ - backupRetentionDays?: (number | string)␊ - /**␊ - * Enable Geo-redundant or not for server backup.␊ - */␊ - geoRedundantBackup?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Enable Storage Auto Grow.␊ - */␊ - storageAutogrow?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Max storage allowed for a server.␊ - */␊ - storageMB?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties used to create a new server.␊ - */␊ - export interface ServerPropertiesForDefaultCreate {␊ - /**␊ - * The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation).␊ - */␊ - administratorLogin: string␊ - /**␊ - * The password of the administrator login.␊ - */␊ - administratorLoginPassword: string␊ - createMode: "Default"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties used to create a new server by restoring from a backup.␊ - */␊ - export interface ServerPropertiesForRestore {␊ - createMode: "PointInTimeRestore"␊ - /**␊ - * Restore point creation time (ISO8601 format), specifying the time to restore from.␊ - */␊ - restorePointInTime: string␊ - /**␊ - * The source server id to restore from.␊ - */␊ - sourceServerId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties used to create a new server by restoring to a different region from a geo replicated backup.␊ - */␊ - export interface ServerPropertiesForGeoRestore {␊ - createMode: "GeoRestore"␊ - /**␊ - * The source server id to restore from.␊ - */␊ - sourceServerId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties to create a new replica.␊ - */␊ - export interface ServerPropertiesForReplica {␊ - createMode: "Replica"␊ - /**␊ - * The master server id to create replica from.␊ - */␊ - sourceServerId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforMariaDB/servers/firewallRules␊ - */␊ - export interface ServersFirewallRulesChildResource2 {␊ - apiVersion: "2018-06-01"␊ - /**␊ - * The name of the server firewall rule.␊ - */␊ - name: string␊ - /**␊ - * The properties of a server firewall rule.␊ - */␊ - properties: (FirewallRuleProperties2 | string)␊ - type: "firewallRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a server firewall rule.␊ - */␊ - export interface FirewallRuleProperties2 {␊ - /**␊ - * The end IP address of the server firewall rule. Must be IPv4 format.␊ - */␊ - endIpAddress: string␊ - /**␊ - * The start IP address of the server firewall rule. Must be IPv4 format.␊ - */␊ - startIpAddress: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforMariaDB/servers/virtualNetworkRules␊ - */␊ - export interface ServersVirtualNetworkRulesChildResource1 {␊ - apiVersion: "2018-06-01"␊ - /**␊ - * The name of the virtual network rule.␊ - */␊ - name: string␊ - /**␊ - * Properties of a virtual network rule.␊ - */␊ - properties: (VirtualNetworkRuleProperties1 | string)␊ - type: "virtualNetworkRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a virtual network rule.␊ - */␊ - export interface VirtualNetworkRuleProperties1 {␊ - /**␊ - * Create firewall rule before the virtual network has vnet service endpoint enabled.␊ - */␊ - ignoreMissingVnetServiceEndpoint?: (boolean | string)␊ - /**␊ - * The ARM resource id of the virtual network subnet.␊ - */␊ - virtualNetworkSubnetId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforMariaDB/servers/databases␊ - */␊ - export interface ServersDatabasesChildResource1 {␊ - apiVersion: "2018-06-01"␊ - /**␊ - * The name of the database.␊ - */␊ - name: string␊ - /**␊ - * The properties of a database.␊ - */␊ - properties: (DatabaseProperties6 | string)␊ - type: "databases"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a database.␊ - */␊ - export interface DatabaseProperties6 {␊ - /**␊ - * The charset of the database.␊ - */␊ - charset?: string␊ - /**␊ - * The collation of the database.␊ - */␊ - collation?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforMariaDB/servers/configurations␊ - */␊ - export interface ServersConfigurationsChildResource {␊ - apiVersion: "2018-06-01"␊ - /**␊ - * The name of the server configuration.␊ - */␊ - name: string␊ - /**␊ - * The properties of a configuration.␊ - */␊ - properties: (ConfigurationProperties | string)␊ - type: "configurations"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a configuration.␊ - */␊ - export interface ConfigurationProperties {␊ - /**␊ - * Source of the configuration.␊ - */␊ - source?: string␊ - /**␊ - * Value of the configuration.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforMariaDB/servers/privateEndpointConnections␊ - */␊ - export interface ServersPrivateEndpointConnectionsChildResource {␊ - apiVersion: "2018-06-01"␊ - /**␊ - * The name of the private endpoint connection.␊ - */␊ - name: string␊ - /**␊ - * Properties of a private endpoint connection.␊ - */␊ - properties: (PrivateEndpointConnectionProperties6 | string)␊ - type: "privateEndpointConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a private endpoint connection.␊ - */␊ - export interface PrivateEndpointConnectionProperties6 {␊ - privateEndpoint?: (PrivateEndpointProperty | string)␊ - privateLinkServiceConnectionState?: (PrivateLinkServiceConnectionStateProperty | string)␊ - [k: string]: unknown␊ - }␊ - export interface PrivateEndpointProperty {␊ - /**␊ - * Resource id of the private endpoint.␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - export interface PrivateLinkServiceConnectionStateProperty {␊ - /**␊ - * The private link service connection description.␊ - */␊ - description: string␊ - /**␊ - * The private link service connection status.␊ - */␊ - status: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforMariaDB/servers/securityAlertPolicies␊ - */␊ - export interface ServersSecurityAlertPoliciesChildResource {␊ - apiVersion: "2018-06-01"␊ - /**␊ - * The name of the threat detection policy.␊ - */␊ - name: "Default"␊ - /**␊ - * Properties of a security alert policy.␊ - */␊ - properties: (SecurityAlertPolicyProperties2 | string)␊ - type: "securityAlertPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a security alert policy.␊ - */␊ - export interface SecurityAlertPolicyProperties2 {␊ - /**␊ - * Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly␊ - */␊ - disabledAlerts?: (string[] | string)␊ - /**␊ - * Specifies that the alert is sent to the account administrators.␊ - */␊ - emailAccountAdmins?: (boolean | string)␊ - /**␊ - * Specifies an array of e-mail addresses to which the alert is sent.␊ - */␊ - emailAddresses?: (string[] | string)␊ - /**␊ - * Specifies the number of days to keep in the Threat Detection audit logs.␊ - */␊ - retentionDays?: (number | string)␊ - /**␊ - * Specifies the state of the policy, whether it is enabled or disabled.␊ - */␊ - state: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Specifies the identifier key of the Threat Detection audit storage account.␊ - */␊ - storageAccountAccessKey?: string␊ - /**␊ - * Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.␊ - */␊ - storageEndpoint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Billing information related properties of a server.␊ - */␊ - export interface Sku49 {␊ - /**␊ - * The scale up/out capacity, representing server's compute units.␊ - */␊ - capacity?: (number | string)␊ - /**␊ - * The family of hardware.␊ - */␊ - family?: string␊ - /**␊ - * The name of the sku, typically, tier + family + cores, e.g. B_Gen4_1, GP_Gen5_8.␊ - */␊ - name: string␊ - /**␊ - * The size code, to be interpreted by resource as appropriate.␊ - */␊ - size?: string␊ - /**␊ - * The tier of the particular SKU, e.g. Basic.␊ - */␊ - tier?: (("Basic" | "GeneralPurpose" | "MemoryOptimized") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforMariaDB/servers/configurations␊ - */␊ - export interface ServersConfigurations {␊ - apiVersion: "2018-06-01"␊ - /**␊ - * The name of the server configuration.␊ - */␊ - name: string␊ - /**␊ - * The properties of a configuration.␊ - */␊ - properties: (ConfigurationProperties | string)␊ - type: "Microsoft.DBforMariaDB/servers/configurations"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforMariaDB/servers/databases␊ - */␊ - export interface ServersDatabases2 {␊ - apiVersion: "2018-06-01"␊ - /**␊ - * The name of the database.␊ - */␊ - name: string␊ - /**␊ - * The properties of a database.␊ - */␊ - properties: (DatabaseProperties6 | string)␊ - type: "Microsoft.DBforMariaDB/servers/databases"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforMariaDB/servers/firewallRules␊ - */␊ - export interface ServersFirewallRules2 {␊ - apiVersion: "2018-06-01"␊ - /**␊ - * The name of the server firewall rule.␊ - */␊ - name: string␊ - /**␊ - * The properties of a server firewall rule.␊ - */␊ - properties: (FirewallRuleProperties2 | string)␊ - type: "Microsoft.DBforMariaDB/servers/firewallRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforMariaDB/servers/virtualNetworkRules␊ - */␊ - export interface ServersVirtualNetworkRules1 {␊ - apiVersion: "2018-06-01"␊ - /**␊ - * The name of the virtual network rule.␊ - */␊ - name: string␊ - /**␊ - * Properties of a virtual network rule.␊ - */␊ - properties: (VirtualNetworkRuleProperties1 | string)␊ - type: "Microsoft.DBforMariaDB/servers/virtualNetworkRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforMariaDB/servers/securityAlertPolicies␊ - */␊ - export interface ServersSecurityAlertPolicies1 {␊ - apiVersion: "2018-06-01"␊ - /**␊ - * The name of the threat detection policy.␊ - */␊ - name: string␊ - /**␊ - * Properties of a security alert policy.␊ - */␊ - properties: (SecurityAlertPolicyProperties2 | string)␊ - type: "Microsoft.DBforMariaDB/servers/securityAlertPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforMariaDB/servers/privateEndpointConnections␊ - */␊ - export interface ServersPrivateEndpointConnections {␊ - apiVersion: "2018-06-01"␊ - /**␊ - * The name of the private endpoint connection.␊ - */␊ - name: string␊ - /**␊ - * Properties of a private endpoint connection.␊ - */␊ - properties: (PrivateEndpointConnectionProperties6 | string)␊ - type: "Microsoft.DBforMariaDB/servers/privateEndpointConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforMySQL/servers␊ - */␊ - export interface Servers5 {␊ - apiVersion: "2017-12-01"␊ - /**␊ - * Azure Active Directory identity configuration for a resource.␊ - */␊ - identity?: (ResourceIdentity3 | string)␊ - /**␊ - * The location the resource resides in.␊ - */␊ - location: string␊ - /**␊ - * The name of the server.␊ - */␊ - name: string␊ - /**␊ - * The properties used to create a new server.␊ - */␊ - properties: (ServerPropertiesForCreate1 | string)␊ - resources?: (ServersFirewallRulesChildResource3 | ServersVirtualNetworkRulesChildResource2 | ServersDatabasesChildResource2 | ServersConfigurationsChildResource1 | ServersAdministratorsChildResource1 | ServersSecurityAlertPoliciesChildResource1)[]␊ - /**␊ - * Billing information related properties of a server.␊ - */␊ - sku?: (Sku50 | string)␊ - /**␊ - * Application-specific metadata in the form of key-value pairs.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.DBforMySQL/servers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Active Directory identity configuration for a resource.␊ - */␊ - export interface ResourceIdentity3 {␊ - /**␊ - * The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource.␊ - */␊ - type?: ("SystemAssigned" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Storage Profile properties of a server␊ - */␊ - export interface StorageProfile5 {␊ - /**␊ - * Backup retention days for the server.␊ - */␊ - backupRetentionDays?: (number | string)␊ - /**␊ - * Enable Geo-redundant or not for server backup.␊ - */␊ - geoRedundantBackup?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Enable Storage Auto Grow.␊ - */␊ - storageAutogrow?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Max storage allowed for a server.␊ - */␊ - storageMB?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties used to create a new server.␊ - */␊ - export interface ServerPropertiesForDefaultCreate1 {␊ - /**␊ - * The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation). The login name is required when updating password.␊ - */␊ - administratorLogin: string␊ - /**␊ - * The password of the administrator login.␊ - */␊ - administratorLoginPassword: string␊ - createMode: "Default"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties used to create a new server by restoring from a backup.␊ - */␊ - export interface ServerPropertiesForRestore1 {␊ - createMode: "PointInTimeRestore"␊ - /**␊ - * Restore point creation time (ISO8601 format), specifying the time to restore from.␊ - */␊ - restorePointInTime: string␊ - /**␊ - * The source server id to restore from.␊ - */␊ - sourceServerId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties used to create a new server by restoring to a different region from a geo replicated backup.␊ - */␊ - export interface ServerPropertiesForGeoRestore1 {␊ - createMode: "GeoRestore"␊ - /**␊ - * The source server id to restore from.␊ - */␊ - sourceServerId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties to create a new replica.␊ - */␊ - export interface ServerPropertiesForReplica1 {␊ - createMode: "Replica"␊ - /**␊ - * The master server id to create replica from.␊ - */␊ - sourceServerId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforMySQL/servers/firewallRules␊ - */␊ - export interface ServersFirewallRulesChildResource3 {␊ - apiVersion: "2017-12-01"␊ - /**␊ - * The name of the server firewall rule.␊ - */␊ - name: string␊ - /**␊ - * The properties of a server firewall rule.␊ - */␊ - properties: (FirewallRuleProperties3 | string)␊ - type: "firewallRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a server firewall rule.␊ - */␊ - export interface FirewallRuleProperties3 {␊ - /**␊ - * The end IP address of the server firewall rule. Must be IPv4 format.␊ - */␊ - endIpAddress: string␊ - /**␊ - * The start IP address of the server firewall rule. Must be IPv4 format.␊ - */␊ - startIpAddress: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforMySQL/servers/virtualNetworkRules␊ - */␊ - export interface ServersVirtualNetworkRulesChildResource2 {␊ - apiVersion: "2017-12-01"␊ - /**␊ - * The name of the virtual network rule.␊ - */␊ - name: string␊ - /**␊ - * Properties of a virtual network rule.␊ - */␊ - properties: (VirtualNetworkRuleProperties2 | string)␊ - type: "virtualNetworkRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a virtual network rule.␊ - */␊ - export interface VirtualNetworkRuleProperties2 {␊ - /**␊ - * Create firewall rule before the virtual network has vnet service endpoint enabled.␊ - */␊ - ignoreMissingVnetServiceEndpoint?: (boolean | string)␊ - /**␊ - * The ARM resource id of the virtual network subnet.␊ - */␊ - virtualNetworkSubnetId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforMySQL/servers/databases␊ - */␊ - export interface ServersDatabasesChildResource2 {␊ - apiVersion: "2017-12-01"␊ - /**␊ - * The name of the database.␊ - */␊ - name: string␊ - /**␊ - * The properties of a database.␊ - */␊ - properties: (DatabaseProperties7 | string)␊ - type: "databases"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a database.␊ - */␊ - export interface DatabaseProperties7 {␊ - /**␊ - * The charset of the database.␊ - */␊ - charset?: string␊ - /**␊ - * The collation of the database.␊ - */␊ - collation?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforMySQL/servers/configurations␊ - */␊ - export interface ServersConfigurationsChildResource1 {␊ - apiVersion: "2017-12-01"␊ - /**␊ - * The name of the server configuration.␊ - */␊ - name: string␊ - /**␊ - * The properties of a configuration.␊ - */␊ - properties: (ConfigurationProperties1 | string)␊ - type: "configurations"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a configuration.␊ - */␊ - export interface ConfigurationProperties1 {␊ - /**␊ - * Source of the configuration.␊ - */␊ - source?: string␊ - /**␊ - * Value of the configuration.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforMySQL/servers/administrators␊ - */␊ - export interface ServersAdministratorsChildResource1 {␊ - apiVersion: "2017-12-01"␊ - name: "activeDirectory"␊ - /**␊ - * The properties of an server Administrator.␊ - */␊ - properties: (ServerAdministratorProperties1 | string)␊ - type: "administrators"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of an server Administrator.␊ - */␊ - export interface ServerAdministratorProperties1 {␊ - /**␊ - * The type of administrator.␊ - */␊ - administratorType: ("ActiveDirectory" | string)␊ - /**␊ - * The server administrator login account name.␊ - */␊ - login: string␊ - /**␊ - * The server administrator Sid (Secure ID).␊ - */␊ - sid: string␊ - /**␊ - * The server Active Directory Administrator tenant id.␊ - */␊ - tenantId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforMySQL/servers/securityAlertPolicies␊ - */␊ - export interface ServersSecurityAlertPoliciesChildResource1 {␊ - apiVersion: "2017-12-01"␊ - /**␊ - * The name of the threat detection policy.␊ - */␊ - name: "Default"␊ - /**␊ - * Properties of a security alert policy.␊ - */␊ - properties: (SecurityAlertPolicyProperties3 | string)␊ - type: "securityAlertPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a security alert policy.␊ - */␊ - export interface SecurityAlertPolicyProperties3 {␊ - /**␊ - * Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly␊ - */␊ - disabledAlerts?: (string[] | string)␊ - /**␊ - * Specifies that the alert is sent to the account administrators.␊ - */␊ - emailAccountAdmins?: (boolean | string)␊ - /**␊ - * Specifies an array of e-mail addresses to which the alert is sent.␊ - */␊ - emailAddresses?: (string[] | string)␊ - /**␊ - * Specifies the number of days to keep in the Threat Detection audit logs.␊ - */␊ - retentionDays?: (number | string)␊ - /**␊ - * Specifies the state of the policy, whether it is enabled or disabled.␊ - */␊ - state: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Specifies the identifier key of the Threat Detection audit storage account.␊ - */␊ - storageAccountAccessKey?: string␊ - /**␊ - * Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.␊ - */␊ - storageEndpoint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Billing information related properties of a server.␊ - */␊ - export interface Sku50 {␊ - /**␊ - * The scale up/out capacity, representing server's compute units.␊ - */␊ - capacity?: (number | string)␊ - /**␊ - * The family of hardware.␊ - */␊ - family?: string␊ - /**␊ - * The name of the sku, typically, tier + family + cores, e.g. B_Gen4_1, GP_Gen5_8.␊ - */␊ - name: string␊ - /**␊ - * The size code, to be interpreted by resource as appropriate.␊ - */␊ - size?: string␊ - /**␊ - * The tier of the particular SKU, e.g. Basic.␊ - */␊ - tier?: (("Basic" | "GeneralPurpose" | "MemoryOptimized") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforMySQL/servers/configurations␊ - */␊ - export interface ServersConfigurations1 {␊ - apiVersion: "2017-12-01"␊ - /**␊ - * The name of the server configuration.␊ - */␊ - name: string␊ - /**␊ - * The properties of a configuration.␊ - */␊ - properties: (ConfigurationProperties1 | string)␊ - type: "Microsoft.DBforMySQL/servers/configurations"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforMySQL/servers/databases␊ - */␊ - export interface ServersDatabases3 {␊ - apiVersion: "2017-12-01"␊ - /**␊ - * The name of the database.␊ - */␊ - name: string␊ - /**␊ - * The properties of a database.␊ - */␊ - properties: (DatabaseProperties7 | string)␊ - type: "Microsoft.DBforMySQL/servers/databases"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforMySQL/servers/firewallRules␊ - */␊ - export interface ServersFirewallRules3 {␊ - apiVersion: "2017-12-01"␊ - /**␊ - * The name of the server firewall rule.␊ - */␊ - name: string␊ - /**␊ - * The properties of a server firewall rule.␊ - */␊ - properties: (FirewallRuleProperties3 | string)␊ - type: "Microsoft.DBforMySQL/servers/firewallRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforMySQL/servers/virtualNetworkRules␊ - */␊ - export interface ServersVirtualNetworkRules2 {␊ - apiVersion: "2017-12-01"␊ - /**␊ - * The name of the virtual network rule.␊ - */␊ - name: string␊ - /**␊ - * Properties of a virtual network rule.␊ - */␊ - properties: (VirtualNetworkRuleProperties2 | string)␊ - type: "Microsoft.DBforMySQL/servers/virtualNetworkRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforMySQL/servers/securityAlertPolicies␊ - */␊ - export interface ServersSecurityAlertPolicies2 {␊ - apiVersion: "2017-12-01"␊ - /**␊ - * The name of the threat detection policy.␊ - */␊ - name: string␊ - /**␊ - * Properties of a security alert policy.␊ - */␊ - properties: (SecurityAlertPolicyProperties3 | string)␊ - type: "Microsoft.DBforMySQL/servers/securityAlertPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforMySQL/servers/administrators␊ - */␊ - export interface ServersAdministrators1 {␊ - apiVersion: "2017-12-01"␊ - name: string␊ - /**␊ - * The properties of an server Administrator.␊ - */␊ - properties: (ServerAdministratorProperties1 | string)␊ - type: "Microsoft.DBforMySQL/servers/administrators"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforPostgreSQL/servers␊ - */␊ - export interface Servers6 {␊ - apiVersion: "2017-12-01"␊ - /**␊ - * Azure Active Directory identity configuration for a resource.␊ - */␊ - identity?: (ResourceIdentity4 | string)␊ - /**␊ - * The location the resource resides in.␊ - */␊ - location: string␊ - /**␊ - * The name of the server.␊ - */␊ - name: string␊ - /**␊ - * The properties used to create a new server.␊ - */␊ - properties: (ServerPropertiesForCreate2 | string)␊ - resources?: (ServersFirewallRulesChildResource4 | ServersVirtualNetworkRulesChildResource3 | ServersDatabasesChildResource3 | ServersConfigurationsChildResource2 | ServersAdministratorsChildResource2 | ServersSecurityAlertPoliciesChildResource2)[]␊ - /**␊ - * Billing information related properties of a server.␊ - */␊ - sku?: (Sku51 | string)␊ - /**␊ - * Application-specific metadata in the form of key-value pairs.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.DBforPostgreSQL/servers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Active Directory identity configuration for a resource.␊ - */␊ - export interface ResourceIdentity4 {␊ - /**␊ - * The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource.␊ - */␊ - type?: ("SystemAssigned" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Storage Profile properties of a server␊ - */␊ - export interface StorageProfile6 {␊ - /**␊ - * Backup retention days for the server.␊ - */␊ - backupRetentionDays?: (number | string)␊ - /**␊ - * Enable Geo-redundant or not for server backup.␊ - */␊ - geoRedundantBackup?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Enable Storage Auto Grow.␊ - */␊ - storageAutogrow?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Max storage allowed for a server.␊ - */␊ - storageMB?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties used to create a new server.␊ - */␊ - export interface ServerPropertiesForDefaultCreate2 {␊ - /**␊ - * The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation).␊ - */␊ - administratorLogin: string␊ - /**␊ - * The password of the administrator login.␊ - */␊ - administratorLoginPassword: string␊ - createMode: "Default"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties used to create a new server by restoring from a backup.␊ - */␊ - export interface ServerPropertiesForRestore2 {␊ - createMode: "PointInTimeRestore"␊ - /**␊ - * Restore point creation time (ISO8601 format), specifying the time to restore from.␊ - */␊ - restorePointInTime: string␊ - /**␊ - * The source server id to restore from.␊ - */␊ - sourceServerId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties used to create a new server by restoring to a different region from a geo replicated backup.␊ - */␊ - export interface ServerPropertiesForGeoRestore2 {␊ - createMode: "GeoRestore"␊ - /**␊ - * The source server id to restore from.␊ - */␊ - sourceServerId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties to create a new replica.␊ - */␊ - export interface ServerPropertiesForReplica2 {␊ - createMode: "Replica"␊ - /**␊ - * The master server id to create replica from.␊ - */␊ - sourceServerId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforPostgreSQL/servers/firewallRules␊ - */␊ - export interface ServersFirewallRulesChildResource4 {␊ - apiVersion: "2017-12-01"␊ - /**␊ - * The name of the server firewall rule.␊ - */␊ - name: string␊ - /**␊ - * The properties of a server firewall rule.␊ - */␊ - properties: (FirewallRuleProperties4 | string)␊ - type: "firewallRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a server firewall rule.␊ - */␊ - export interface FirewallRuleProperties4 {␊ - /**␊ - * The end IP address of the server firewall rule. Must be IPv4 format.␊ - */␊ - endIpAddress: string␊ - /**␊ - * The start IP address of the server firewall rule. Must be IPv4 format.␊ - */␊ - startIpAddress: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforPostgreSQL/servers/virtualNetworkRules␊ - */␊ - export interface ServersVirtualNetworkRulesChildResource3 {␊ - apiVersion: "2017-12-01"␊ - /**␊ - * The name of the virtual network rule.␊ - */␊ - name: string␊ - /**␊ - * Properties of a virtual network rule.␊ - */␊ - properties: (VirtualNetworkRuleProperties3 | string)␊ - type: "virtualNetworkRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a virtual network rule.␊ - */␊ - export interface VirtualNetworkRuleProperties3 {␊ - /**␊ - * Create firewall rule before the virtual network has vnet service endpoint enabled.␊ - */␊ - ignoreMissingVnetServiceEndpoint?: (boolean | string)␊ - /**␊ - * The ARM resource id of the virtual network subnet.␊ - */␊ - virtualNetworkSubnetId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforPostgreSQL/servers/databases␊ - */␊ - export interface ServersDatabasesChildResource3 {␊ - apiVersion: "2017-12-01"␊ - /**␊ - * The name of the database.␊ - */␊ - name: string␊ - /**␊ - * The properties of a database.␊ - */␊ - properties: (DatabaseProperties8 | string)␊ - type: "databases"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a database.␊ - */␊ - export interface DatabaseProperties8 {␊ - /**␊ - * The charset of the database.␊ - */␊ - charset?: string␊ - /**␊ - * The collation of the database.␊ - */␊ - collation?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforPostgreSQL/servers/configurations␊ - */␊ - export interface ServersConfigurationsChildResource2 {␊ - apiVersion: "2017-12-01"␊ - /**␊ - * The name of the server configuration.␊ - */␊ - name: string␊ - /**␊ - * The properties of a configuration.␊ - */␊ - properties: (ConfigurationProperties2 | string)␊ - type: "configurations"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a configuration.␊ - */␊ - export interface ConfigurationProperties2 {␊ - /**␊ - * Source of the configuration.␊ - */␊ - source?: string␊ - /**␊ - * Value of the configuration.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforPostgreSQL/servers/administrators␊ - */␊ - export interface ServersAdministratorsChildResource2 {␊ - apiVersion: "2017-12-01"␊ - name: "activeDirectory"␊ - /**␊ - * The properties of an server Administrator.␊ - */␊ - properties: (ServerAdministratorProperties2 | string)␊ - type: "administrators"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of an server Administrator.␊ - */␊ - export interface ServerAdministratorProperties2 {␊ - /**␊ - * The type of administrator.␊ - */␊ - administratorType: ("ActiveDirectory" | string)␊ - /**␊ - * The server administrator login account name.␊ - */␊ - login: string␊ - /**␊ - * The server administrator Sid (Secure ID).␊ - */␊ - sid: string␊ - /**␊ - * The server Active Directory Administrator tenant id.␊ - */␊ - tenantId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforPostgreSQL/servers/securityAlertPolicies␊ - */␊ - export interface ServersSecurityAlertPoliciesChildResource2 {␊ - apiVersion: "2017-12-01"␊ - /**␊ - * The name of the threat detection policy.␊ - */␊ - name: "default"␊ - /**␊ - * Properties of a security alert policy.␊ - */␊ - properties: (SecurityAlertPolicyProperties4 | string)␊ - type: "securityAlertPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a security alert policy.␊ - */␊ - export interface SecurityAlertPolicyProperties4 {␊ - /**␊ - * Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly␊ - */␊ - disabledAlerts?: (string[] | string)␊ - /**␊ - * Specifies that the alert is sent to the account administrators.␊ - */␊ - emailAccountAdmins?: (boolean | string)␊ - /**␊ - * Specifies an array of e-mail addresses to which the alert is sent.␊ - */␊ - emailAddresses?: (string[] | string)␊ - /**␊ - * Specifies the number of days to keep in the Threat Detection audit logs.␊ - */␊ - retentionDays?: (number | string)␊ - /**␊ - * Specifies the state of the policy, whether it is enabled or disabled.␊ - */␊ - state: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Specifies the identifier key of the Threat Detection audit storage account.␊ - */␊ - storageAccountAccessKey?: string␊ - /**␊ - * Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.␊ - */␊ - storageEndpoint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Billing information related properties of a server.␊ - */␊ - export interface Sku51 {␊ - /**␊ - * The scale up/out capacity, representing server's compute units.␊ - */␊ - capacity?: (number | string)␊ - /**␊ - * The family of hardware.␊ - */␊ - family?: string␊ - /**␊ - * The name of the sku, typically, tier + family + cores, e.g. B_Gen4_1, GP_Gen5_8.␊ - */␊ - name: string␊ - /**␊ - * The size code, to be interpreted by resource as appropriate.␊ - */␊ - size?: string␊ - /**␊ - * The tier of the particular SKU, e.g. Basic.␊ - */␊ - tier?: (("Basic" | "GeneralPurpose" | "MemoryOptimized") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforPostgreSQL/servers/configurations␊ - */␊ - export interface ServersConfigurations2 {␊ - apiVersion: "2017-12-01"␊ - /**␊ - * The name of the server configuration.␊ - */␊ - name: string␊ - /**␊ - * The properties of a configuration.␊ - */␊ - properties: (ConfigurationProperties2 | string)␊ - type: "Microsoft.DBforPostgreSQL/servers/configurations"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforPostgreSQL/servers/databases␊ - */␊ - export interface ServersDatabases4 {␊ - apiVersion: "2017-12-01"␊ - /**␊ - * The name of the database.␊ - */␊ - name: string␊ - /**␊ - * The properties of a database.␊ - */␊ - properties: (DatabaseProperties8 | string)␊ - type: "Microsoft.DBforPostgreSQL/servers/databases"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforPostgreSQL/servers/firewallRules␊ - */␊ - export interface ServersFirewallRules4 {␊ - apiVersion: "2017-12-01"␊ - /**␊ - * The name of the server firewall rule.␊ - */␊ - name: string␊ - /**␊ - * The properties of a server firewall rule.␊ - */␊ - properties: (FirewallRuleProperties4 | string)␊ - type: "Microsoft.DBforPostgreSQL/servers/firewallRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforPostgreSQL/servers/virtualNetworkRules␊ - */␊ - export interface ServersVirtualNetworkRules3 {␊ - apiVersion: "2017-12-01"␊ - /**␊ - * The name of the virtual network rule.␊ - */␊ - name: string␊ - /**␊ - * Properties of a virtual network rule.␊ - */␊ - properties: (VirtualNetworkRuleProperties3 | string)␊ - type: "Microsoft.DBforPostgreSQL/servers/virtualNetworkRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforPostgreSQL/servers/securityAlertPolicies␊ - */␊ - export interface ServersSecurityAlertPolicies3 {␊ - apiVersion: "2017-12-01"␊ - /**␊ - * The name of the threat detection policy.␊ - */␊ - name: string␊ - /**␊ - * Properties of a security alert policy.␊ - */␊ - properties: (SecurityAlertPolicyProperties4 | string)␊ - type: "Microsoft.DBforPostgreSQL/servers/securityAlertPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforPostgreSQL/servers/administrators␊ - */␊ - export interface ServersAdministrators2 {␊ - apiVersion: "2017-12-01"␊ - name: string␊ - /**␊ - * The properties of an server Administrator.␊ - */␊ - properties: (ServerAdministratorProperties2 | string)␊ - type: "Microsoft.DBforPostgreSQL/servers/administrators"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforMySQL/servers␊ - */␊ - export interface Servers7 {␊ - apiVersion: "2017-12-01-preview"␊ - /**␊ - * The location the resource resides in.␊ - */␊ - location: string␊ - /**␊ - * The name of the server.␊ - */␊ - name: string␊ - /**␊ - * The properties used to create a new server.␊ - */␊ - properties: (ServerPropertiesForCreate3 | string)␊ - resources?: (ServersFirewallRulesChildResource5 | ServersVirtualNetworkRulesChildResource4 | ServersDatabasesChildResource4 | ServersConfigurationsChildResource3 | ServersAdministratorsChildResource3 | ServersSecurityAlertPoliciesChildResource3)[]␊ - /**␊ - * Billing information related properties of a server.␊ - */␊ - sku?: (Sku52 | string)␊ - /**␊ - * Application-specific metadata in the form of key-value pairs.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.DBforMySQL/servers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Storage Profile properties of a server␊ - */␊ - export interface StorageProfile7 {␊ - /**␊ - * Backup retention days for the server.␊ - */␊ - backupRetentionDays?: (number | string)␊ - /**␊ - * Enable Geo-redundant or not for server backup.␊ - */␊ - geoRedundantBackup?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Enable Storage Auto Grow.␊ - */␊ - storageAutogrow?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Max storage allowed for a server.␊ - */␊ - storageMB?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties used to create a new server.␊ - */␊ - export interface ServerPropertiesForDefaultCreate3 {␊ - /**␊ - * The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation).␊ - */␊ - administratorLogin: string␊ - /**␊ - * The password of the administrator login.␊ - */␊ - administratorLoginPassword: string␊ - createMode: "Default"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties used to create a new server by restoring from a backup.␊ - */␊ - export interface ServerPropertiesForRestore3 {␊ - createMode: "PointInTimeRestore"␊ - /**␊ - * Restore point creation time (ISO8601 format), specifying the time to restore from.␊ - */␊ - restorePointInTime: string␊ - /**␊ - * The source server id to restore from.␊ - */␊ - sourceServerId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties used to create a new server by restoring to a different region from a geo replicated backup.␊ - */␊ - export interface ServerPropertiesForGeoRestore3 {␊ - createMode: "GeoRestore"␊ - /**␊ - * The source server id to restore from.␊ - */␊ - sourceServerId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties to create a new replica.␊ - */␊ - export interface ServerPropertiesForReplica3 {␊ - createMode: "Replica"␊ - /**␊ - * The master server id to create replica from.␊ - */␊ - sourceServerId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforMySQL/servers/firewallRules␊ - */␊ - export interface ServersFirewallRulesChildResource5 {␊ - apiVersion: "2017-12-01-preview"␊ - /**␊ - * The name of the server firewall rule.␊ - */␊ - name: string␊ - /**␊ - * The properties of a server firewall rule.␊ - */␊ - properties: (FirewallRuleProperties5 | string)␊ - type: "firewallRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a server firewall rule.␊ - */␊ - export interface FirewallRuleProperties5 {␊ - /**␊ - * The end IP address of the server firewall rule. Must be IPv4 format.␊ - */␊ - endIpAddress: string␊ - /**␊ - * The start IP address of the server firewall rule. Must be IPv4 format.␊ - */␊ - startIpAddress: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforMySQL/servers/virtualNetworkRules␊ - */␊ - export interface ServersVirtualNetworkRulesChildResource4 {␊ - apiVersion: "2017-12-01-preview"␊ - /**␊ - * The name of the virtual network rule.␊ - */␊ - name: string␊ - /**␊ - * Properties of a virtual network rule.␊ - */␊ - properties: (VirtualNetworkRuleProperties4 | string)␊ - type: "virtualNetworkRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a virtual network rule.␊ - */␊ - export interface VirtualNetworkRuleProperties4 {␊ - /**␊ - * Create firewall rule before the virtual network has vnet service endpoint enabled.␊ - */␊ - ignoreMissingVnetServiceEndpoint?: (boolean | string)␊ - /**␊ - * The ARM resource id of the virtual network subnet.␊ - */␊ - virtualNetworkSubnetId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforMySQL/servers/databases␊ - */␊ - export interface ServersDatabasesChildResource4 {␊ - apiVersion: "2017-12-01-preview"␊ - /**␊ - * The name of the database.␊ - */␊ - name: string␊ - /**␊ - * The properties of a database.␊ - */␊ - properties: (DatabaseProperties9 | string)␊ - type: "databases"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a database.␊ - */␊ - export interface DatabaseProperties9 {␊ - /**␊ - * The charset of the database.␊ - */␊ - charset?: string␊ - /**␊ - * The collation of the database.␊ - */␊ - collation?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforMySQL/servers/configurations␊ - */␊ - export interface ServersConfigurationsChildResource3 {␊ - apiVersion: "2017-12-01-preview"␊ - /**␊ - * The name of the server configuration.␊ - */␊ - name: string␊ - /**␊ - * The properties of a configuration.␊ - */␊ - properties: (ConfigurationProperties3 | string)␊ - type: "configurations"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a configuration.␊ - */␊ - export interface ConfigurationProperties3 {␊ - /**␊ - * Source of the configuration.␊ - */␊ - source?: string␊ - /**␊ - * Value of the configuration.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforMySQL/servers/administrators␊ - */␊ - export interface ServersAdministratorsChildResource3 {␊ - apiVersion: "2017-12-01-preview"␊ - name: "activeDirectory"␊ - /**␊ - * The properties of an server Administrator.␊ - */␊ - properties: (ServerAdministratorProperties3 | string)␊ - type: "administrators"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of an server Administrator.␊ - */␊ - export interface ServerAdministratorProperties3 {␊ - /**␊ - * The type of administrator.␊ - */␊ - administratorType: ("ActiveDirectory" | string)␊ - /**␊ - * The server administrator login account name.␊ - */␊ - login: string␊ - /**␊ - * The server administrator Sid (Secure ID).␊ - */␊ - sid: string␊ - /**␊ - * The server Active Directory Administrator tenant id.␊ - */␊ - tenantId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforMySQL/servers/securityAlertPolicies␊ - */␊ - export interface ServersSecurityAlertPoliciesChildResource3 {␊ - apiVersion: "2017-12-01-preview"␊ - /**␊ - * The name of the threat detection policy.␊ - */␊ - name: "Default"␊ - /**␊ - * Properties of a security alert policy.␊ - */␊ - properties: (SecurityAlertPolicyProperties5 | string)␊ - type: "securityAlertPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a security alert policy.␊ - */␊ - export interface SecurityAlertPolicyProperties5 {␊ - /**␊ - * Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly␊ - */␊ - disabledAlerts?: (string[] | string)␊ - /**␊ - * Specifies that the alert is sent to the account administrators.␊ - */␊ - emailAccountAdmins?: (boolean | string)␊ - /**␊ - * Specifies an array of e-mail addresses to which the alert is sent.␊ - */␊ - emailAddresses?: (string[] | string)␊ - /**␊ - * Specifies the number of days to keep in the Threat Detection audit logs.␊ - */␊ - retentionDays?: (number | string)␊ - /**␊ - * Specifies the state of the policy, whether it is enabled or disabled.␊ - */␊ - state: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Specifies the identifier key of the Threat Detection audit storage account.␊ - */␊ - storageAccountAccessKey?: string␊ - /**␊ - * Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.␊ - */␊ - storageEndpoint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Billing information related properties of a server.␊ - */␊ - export interface Sku52 {␊ - /**␊ - * The scale up/out capacity, representing server's compute units.␊ - */␊ - capacity?: (number | string)␊ - /**␊ - * The family of hardware.␊ - */␊ - family?: string␊ - /**␊ - * The name of the sku, typically, tier + family + cores, e.g. B_Gen4_1, GP_Gen5_8.␊ - */␊ - name: string␊ - /**␊ - * The size code, to be interpreted by resource as appropriate.␊ - */␊ - size?: string␊ - /**␊ - * The tier of the particular SKU, e.g. Basic.␊ - */␊ - tier?: (("Basic" | "GeneralPurpose" | "MemoryOptimized") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforMySQL/servers/configurations␊ - */␊ - export interface ServersConfigurations3 {␊ - apiVersion: "2017-12-01-preview"␊ - /**␊ - * The name of the server configuration.␊ - */␊ - name: string␊ - /**␊ - * The properties of a configuration.␊ - */␊ - properties: (ConfigurationProperties3 | string)␊ - type: "Microsoft.DBforMySQL/servers/configurations"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforMySQL/servers/databases␊ - */␊ - export interface ServersDatabases5 {␊ - apiVersion: "2017-12-01-preview"␊ - /**␊ - * The name of the database.␊ - */␊ - name: string␊ - /**␊ - * The properties of a database.␊ - */␊ - properties: (DatabaseProperties9 | string)␊ - type: "Microsoft.DBforMySQL/servers/databases"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforMySQL/servers/firewallRules␊ - */␊ - export interface ServersFirewallRules5 {␊ - apiVersion: "2017-12-01-preview"␊ - /**␊ - * The name of the server firewall rule.␊ - */␊ - name: string␊ - /**␊ - * The properties of a server firewall rule.␊ - */␊ - properties: (FirewallRuleProperties5 | string)␊ - type: "Microsoft.DBforMySQL/servers/firewallRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforPostgreSQL/servers␊ - */␊ - export interface Servers8 {␊ - apiVersion: "2017-12-01-preview"␊ - /**␊ - * The location the resource resides in.␊ - */␊ - location: string␊ - /**␊ - * The name of the server.␊ - */␊ - name: string␊ - /**␊ - * The properties used to create a new server.␊ - */␊ - properties: (ServerPropertiesForCreate4 | string)␊ - resources?: (ServersFirewallRulesChildResource6 | ServersVirtualNetworkRulesChildResource5 | ServersDatabasesChildResource5 | ServersConfigurationsChildResource4 | ServersAdministratorsChildResource4 | ServersSecurityAlertPoliciesChildResource4)[]␊ - /**␊ - * Billing information related properties of a server.␊ - */␊ - sku?: (Sku53 | string)␊ - /**␊ - * Application-specific metadata in the form of key-value pairs.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.DBforPostgreSQL/servers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Storage Profile properties of a server␊ - */␊ - export interface StorageProfile8 {␊ - /**␊ - * Backup retention days for the server.␊ - */␊ - backupRetentionDays?: (number | string)␊ - /**␊ - * Enable Geo-redundant or not for server backup.␊ - */␊ - geoRedundantBackup?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Enable Storage Auto Grow.␊ - */␊ - storageAutogrow?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Max storage allowed for a server.␊ - */␊ - storageMB?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties used to create a new server.␊ - */␊ - export interface ServerPropertiesForDefaultCreate4 {␊ - /**␊ - * The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation).␊ - */␊ - administratorLogin: string␊ - /**␊ - * The password of the administrator login.␊ - */␊ - administratorLoginPassword: string␊ - createMode: "Default"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties used to create a new server by restoring from a backup.␊ - */␊ - export interface ServerPropertiesForRestore4 {␊ - createMode: "PointInTimeRestore"␊ - /**␊ - * Restore point creation time (ISO8601 format), specifying the time to restore from.␊ - */␊ - restorePointInTime: string␊ - /**␊ - * The source server id to restore from.␊ - */␊ - sourceServerId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties used to create a new server by restoring to a different region from a geo replicated backup.␊ - */␊ - export interface ServerPropertiesForGeoRestore4 {␊ - createMode: "GeoRestore"␊ - /**␊ - * The source server id to restore from.␊ - */␊ - sourceServerId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties to create a new replica.␊ - */␊ - export interface ServerPropertiesForReplica4 {␊ - createMode: "Replica"␊ - /**␊ - * The master server id to create replica from.␊ - */␊ - sourceServerId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforPostgreSQL/servers/firewallRules␊ - */␊ - export interface ServersFirewallRulesChildResource6 {␊ - apiVersion: "2017-12-01-preview"␊ - /**␊ - * The name of the server firewall rule.␊ - */␊ - name: string␊ - /**␊ - * The properties of a server firewall rule.␊ - */␊ - properties: (FirewallRuleProperties6 | string)␊ - type: "firewallRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a server firewall rule.␊ - */␊ - export interface FirewallRuleProperties6 {␊ - /**␊ - * The end IP address of the server firewall rule. Must be IPv4 format.␊ - */␊ - endIpAddress: string␊ - /**␊ - * The start IP address of the server firewall rule. Must be IPv4 format.␊ - */␊ - startIpAddress: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforPostgreSQL/servers/virtualNetworkRules␊ - */␊ - export interface ServersVirtualNetworkRulesChildResource5 {␊ - apiVersion: "2017-12-01-preview"␊ - /**␊ - * The name of the virtual network rule.␊ - */␊ - name: string␊ - /**␊ - * Properties of a virtual network rule.␊ - */␊ - properties: (VirtualNetworkRuleProperties5 | string)␊ - type: "virtualNetworkRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a virtual network rule.␊ - */␊ - export interface VirtualNetworkRuleProperties5 {␊ - /**␊ - * Create firewall rule before the virtual network has vnet service endpoint enabled.␊ - */␊ - ignoreMissingVnetServiceEndpoint?: (boolean | string)␊ - /**␊ - * The ARM resource id of the virtual network subnet.␊ - */␊ - virtualNetworkSubnetId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforPostgreSQL/servers/databases␊ - */␊ - export interface ServersDatabasesChildResource5 {␊ - apiVersion: "2017-12-01-preview"␊ - /**␊ - * The name of the database.␊ - */␊ - name: string␊ - /**␊ - * The properties of a database.␊ - */␊ - properties: (DatabaseProperties10 | string)␊ - type: "databases"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a database.␊ - */␊ - export interface DatabaseProperties10 {␊ - /**␊ - * The charset of the database.␊ - */␊ - charset?: string␊ - /**␊ - * The collation of the database.␊ - */␊ - collation?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforPostgreSQL/servers/configurations␊ - */␊ - export interface ServersConfigurationsChildResource4 {␊ - apiVersion: "2017-12-01-preview"␊ - /**␊ - * The name of the server configuration.␊ - */␊ - name: string␊ - /**␊ - * The properties of a configuration.␊ - */␊ - properties: (ConfigurationProperties4 | string)␊ - type: "configurations"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a configuration.␊ - */␊ - export interface ConfigurationProperties4 {␊ - /**␊ - * Source of the configuration.␊ - */␊ - source?: string␊ - /**␊ - * Value of the configuration.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforPostgreSQL/servers/administrators␊ - */␊ - export interface ServersAdministratorsChildResource4 {␊ - apiVersion: "2017-12-01-preview"␊ - name: "activeDirectory"␊ - /**␊ - * The properties of an server Administrator.␊ - */␊ - properties: (ServerAdministratorProperties4 | string)␊ - type: "administrators"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of an server Administrator.␊ - */␊ - export interface ServerAdministratorProperties4 {␊ - /**␊ - * The type of administrator.␊ - */␊ - administratorType: ("ActiveDirectory" | string)␊ - /**␊ - * The server administrator login account name.␊ - */␊ - login: string␊ - /**␊ - * The server administrator Sid (Secure ID).␊ - */␊ - sid: string␊ - /**␊ - * The server Active Directory Administrator tenant id.␊ - */␊ - tenantId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforPostgreSQL/servers/securityAlertPolicies␊ - */␊ - export interface ServersSecurityAlertPoliciesChildResource4 {␊ - apiVersion: "2017-12-01-preview"␊ - /**␊ - * The name of the threat detection policy.␊ - */␊ - name: "default"␊ - /**␊ - * Properties of a security alert policy.␊ - */␊ - properties: (SecurityAlertPolicyProperties6 | string)␊ - type: "securityAlertPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a security alert policy.␊ - */␊ - export interface SecurityAlertPolicyProperties6 {␊ - /**␊ - * Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly␊ - */␊ - disabledAlerts?: (string[] | string)␊ - /**␊ - * Specifies that the alert is sent to the account administrators.␊ - */␊ - emailAccountAdmins?: (boolean | string)␊ - /**␊ - * Specifies an array of e-mail addresses to which the alert is sent.␊ - */␊ - emailAddresses?: (string[] | string)␊ - /**␊ - * Specifies the number of days to keep in the Threat Detection audit logs.␊ - */␊ - retentionDays?: (number | string)␊ - /**␊ - * Specifies the state of the policy, whether it is enabled or disabled.␊ - */␊ - state: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Specifies the identifier key of the Threat Detection audit storage account.␊ - */␊ - storageAccountAccessKey?: string␊ - /**␊ - * Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.␊ - */␊ - storageEndpoint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Billing information related properties of a server.␊ - */␊ - export interface Sku53 {␊ - /**␊ - * The scale up/out capacity, representing server's compute units.␊ - */␊ - capacity?: (number | string)␊ - /**␊ - * The family of hardware.␊ - */␊ - family?: string␊ - /**␊ - * The name of the sku, typically, tier + family + cores, e.g. B_Gen4_1, GP_Gen5_8.␊ - */␊ - name: string␊ - /**␊ - * The size code, to be interpreted by resource as appropriate.␊ - */␊ - size?: string␊ - /**␊ - * The tier of the particular SKU, e.g. Basic.␊ - */␊ - tier?: (("Basic" | "GeneralPurpose" | "MemoryOptimized") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforPostgreSQL/servers/configurations␊ - */␊ - export interface ServersConfigurations4 {␊ - apiVersion: "2017-12-01-preview"␊ - /**␊ - * The name of the server configuration.␊ - */␊ - name: string␊ - /**␊ - * The properties of a configuration.␊ - */␊ - properties: (ConfigurationProperties4 | string)␊ - type: "Microsoft.DBforPostgreSQL/servers/configurations"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforPostgreSQL/servers/databases␊ - */␊ - export interface ServersDatabases6 {␊ - apiVersion: "2017-12-01-preview"␊ - /**␊ - * The name of the database.␊ - */␊ - name: string␊ - /**␊ - * The properties of a database.␊ - */␊ - properties: (DatabaseProperties10 | string)␊ - type: "Microsoft.DBforPostgreSQL/servers/databases"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DBforPostgreSQL/servers/firewallRules␊ - */␊ - export interface ServersFirewallRules6 {␊ - apiVersion: "2017-12-01-preview"␊ - /**␊ - * The name of the server firewall rule.␊ - */␊ - name: string␊ - /**␊ - * The properties of a server firewall rule.␊ - */␊ - properties: (FirewallRuleProperties6 | string)␊ - type: "Microsoft.DBforPostgreSQL/servers/firewallRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/applicationGateways␊ - */␊ - export interface ApplicationGateways5 {␊ - name: string␊ - type: "Microsoft.Network/applicationGateways"␊ - apiVersion: "2015-05-01-preview"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (ApplicationGatewayPropertiesFormat5 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Application Gateway␊ - */␊ - export interface ApplicationGatewayPropertiesFormat5 {␊ - /**␊ - * Gets or sets sku of application gateway resource␊ - */␊ - sku?: (ApplicationGatewaySku5 | string)␊ - /**␊ - * Gets or sets subnets of application gateway resource␊ - */␊ - gatewayIPConfigurations?: (ApplicationGatewayIPConfiguration5[] | string)␊ - /**␊ - * Gets or sets ssl certificates of application gateway resource␊ - */␊ - sslCertificates?: (ApplicationGatewaySslCertificate5[] | string)␊ - /**␊ - * Gets or sets frontend IP addresses of application gateway resource␊ - */␊ - frontendIPConfigurations?: (ApplicationGatewayFrontendIPConfiguration5[] | string)␊ - /**␊ - * Gets or sets frontend ports of application gateway resource␊ - */␊ - frontendPorts?: (ApplicationGatewayFrontendPort5[] | string)␊ - /**␊ - * Gets or sets backend address pool of application gateway resource␊ - */␊ - backendAddressPools?: (ApplicationGatewayBackendAddressPool5[] | string)␊ - /**␊ - * Gets or sets backend http settings of application gateway resource␊ - */␊ - backendHttpSettingsCollection?: (ApplicationGatewayBackendHttpSettings5[] | string)␊ - /**␊ - * Gets or sets HTTP listeners of application gateway resource␊ - */␊ - httpListeners?: (ApplicationGatewayHttpListener5[] | string)␊ - /**␊ - * Gets or sets request routing rules of application gateway resource␊ - */␊ - requestRoutingRules?: (ApplicationGatewayRequestRoutingRule5[] | string)␊ - /**␊ - * Gets or sets resource guid property of the ApplicationGateway resource␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Gets or sets Provisioning state of the ApplicationGateway resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of application gateway␊ - */␊ - export interface ApplicationGatewaySku5 {␊ - /**␊ - * Gets or sets name of application gateway SKU.␊ - */␊ - name?: (("Standard_Small" | "Standard_Medium" | "Standard_Large") | string)␊ - /**␊ - * Gets or sets tier of application gateway.␊ - */␊ - tier?: ("Standard" | string)␊ - /**␊ - * Gets or sets capacity (instance count) of application gateway␊ - */␊ - capacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration of application gateway␊ - */␊ - export interface ApplicationGatewayIPConfiguration5 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties?: (ApplicationGatewayIPConfigurationPropertiesFormat5 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration of application gateway␊ - */␊ - export interface ApplicationGatewayIPConfigurationPropertiesFormat5 {␊ - /**␊ - * Gets or sets the reference of the subnet resource.A subnet from where application gateway gets its private address ␊ - */␊ - subnet?: (SubResource11 | string)␊ - /**␊ - * Gets or sets Provisioning state of the application gateway subnet resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - export interface SubResource11 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSL certificates of application gateway␊ - */␊ - export interface ApplicationGatewaySslCertificate5 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties?: (ApplicationGatewaySslCertificatePropertiesFormat5 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of application gateway␊ - */␊ - export interface ApplicationGatewaySslCertificatePropertiesFormat5 {␊ - /**␊ - * Gets or sets the certificate data ␊ - */␊ - data?: string␊ - /**␊ - * Gets or sets the certificate password ␊ - */␊ - password?: string␊ - /**␊ - * Gets or sets the certificate public data ␊ - */␊ - publicCertData?: string␊ - /**␊ - * Gets or sets Provisioning state of the ssl certificate resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP configuration of application gateway␊ - */␊ - export interface ApplicationGatewayFrontendIPConfiguration5 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties?: (ApplicationGatewayFrontendIPConfigurationPropertiesFormat5 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP configuration of application gateway␊ - */␊ - export interface ApplicationGatewayFrontendIPConfigurationPropertiesFormat5 {␊ - /**␊ - * Gets or sets the privateIPAddress of the Network Interface IP Configuration␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * Gets or sets PrivateIP allocation method (Static/Dynamic).␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Gets or sets the reference of the subnet resource␊ - */␊ - subnet?: (SubResource11 | string)␊ - /**␊ - * Gets or sets the reference of the PublicIP resource␊ - */␊ - publicIPAddress?: (SubResource11 | string)␊ - /**␊ - * Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend Port of application gateway␊ - */␊ - export interface ApplicationGatewayFrontendPort5 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties?: (ApplicationGatewayFrontendPortPropertiesFormat5 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend Port of application gateway␊ - */␊ - export interface ApplicationGatewayFrontendPortPropertiesFormat5 {␊ - /**␊ - * Gets or sets the frontend port␊ - */␊ - port?: (number | string)␊ - /**␊ - * Gets or sets Provisioning state of the frontend port resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend Address Pool of application gateway␊ - */␊ - export interface ApplicationGatewayBackendAddressPool5 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties?: (ApplicationGatewayBackendAddressPoolPropertiesFormat5 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend Address Pool of application gateway␊ - */␊ - export interface ApplicationGatewayBackendAddressPoolPropertiesFormat5 {␊ - /**␊ - * Gets or sets backendIPConfiguration of application gateway ␊ - */␊ - backendIPConfigurations?: (SubResource11[] | string)␊ - /**␊ - * Gets or sets the backend addresses␊ - */␊ - backendAddresses?: (ApplicationGatewayBackendAddress5[] | string)␊ - /**␊ - * Gets or sets Provisioning state of the backend address pool resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend Address of application gateway␊ - */␊ - export interface ApplicationGatewayBackendAddress5 {␊ - /**␊ - * Gets or sets the dns name␊ - */␊ - fqdn?: string␊ - /**␊ - * Gets or sets the ip address␊ - */␊ - ipAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address pool settings of application gateway␊ - */␊ - export interface ApplicationGatewayBackendHttpSettings5 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties?: (ApplicationGatewayBackendHttpSettingsPropertiesFormat5 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend address pool settings of application gateway␊ - */␊ - export interface ApplicationGatewayBackendHttpSettingsPropertiesFormat5 {␊ - /**␊ - * Gets or sets the port␊ - */␊ - port?: (number | string)␊ - /**␊ - * Gets or sets the protocol.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Gets or sets the cookie affinity.␊ - */␊ - cookieBasedAffinity?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Gets or sets Provisioning state of the backend http settings resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http listener of application gateway␊ - */␊ - export interface ApplicationGatewayHttpListener5 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties?: (ApplicationGatewayHttpListenerPropertiesFormat5 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Http listener of application gateway␊ - */␊ - export interface ApplicationGatewayHttpListenerPropertiesFormat5 {␊ - /**␊ - * Gets or sets frontend IP configuration resource of application gateway ␊ - */␊ - frontendIPConfiguration?: (SubResource11 | string)␊ - /**␊ - * Gets or sets frontend port resource of application gateway ␊ - */␊ - frontendPort?: (SubResource11 | string)␊ - /**␊ - * Gets or sets the protocol.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Gets or sets ssl certificate resource of application gateway ␊ - */␊ - sslCertificate?: (SubResource11 | string)␊ - /**␊ - * Gets or sets Provisioning state of the http listener resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Request routing rule of application gateway␊ - */␊ - export interface ApplicationGatewayRequestRoutingRule5 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties?: (ApplicationGatewayRequestRoutingRulePropertiesFormat5 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Request routing rule of application gateway␊ - */␊ - export interface ApplicationGatewayRequestRoutingRulePropertiesFormat5 {␊ - /**␊ - * Gets or sets the rule type.␊ - */␊ - ruleType?: ("Basic" | string)␊ - /**␊ - * Gets or sets backend address pool resource of application gateway ␊ - */␊ - backendAddressPool?: (SubResource11 | string)␊ - /**␊ - * Gets or sets frontend port resource of application gateway ␊ - */␊ - backendHttpSettings?: (SubResource11 | string)␊ - /**␊ - * Gets or sets http listener resource of application gateway ␊ - */␊ - httpListener?: (SubResource11 | string)␊ - /**␊ - * Gets or sets Provisioning state of the request routing rule resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/connections␊ - */␊ - export interface Connections5 {␊ - name: string␊ - type: "Microsoft.Network/connections"␊ - apiVersion: "2015-05-01-preview"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (VirtualNetworkGatewayConnectionPropertiesFormat5 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewayConnection properties␊ - */␊ - export interface VirtualNetworkGatewayConnectionPropertiesFormat5 {␊ - virtualNetworkGateway1?: (SubResource11 | string)␊ - virtualNetworkGateway2?: (SubResource11 | string)␊ - localNetworkGateway2?: (SubResource11 | string)␊ - /**␊ - * Gateway connection type IPsec/Dedicated/VpnClient/Vnet2Vnet.␊ - */␊ - connectionType?: (("IPsec" | "Vnet2Vnet" | "ExpressRoute" | "VPNClient") | string)␊ - /**␊ - * The Routing weight.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * The IPsec share key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * Virtual network Gateway connection status.␊ - */␊ - connectionStatus?: (("Unknown" | "Connecting" | "Connected" | "NotConnected") | string)␊ - /**␊ - * The Egress Bytes Transferred in this connection␊ - */␊ - egressBytesTransferred?: (number | string)␊ - /**␊ - * The Ingress Bytes Transferred in this connection␊ - */␊ - ingressBytesTransferred?: (number | string)␊ - /**␊ - * The reference to peerings resource.␊ - */␊ - peer?: (SubResource11 | string)␊ - /**␊ - * Gets or sets resource guid property of the VirtualNetworkGatewayConnection resource␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Gets or sets Provisioning state of the VirtualNetworkGatewayConnection resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/authorizations␊ - */␊ - export interface ExpressRouteCircuitsAuthorizations {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/authorizations"␊ - apiVersion: "2015-05-01-preview"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties: (AuthorizationPropertiesFormat | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - export interface AuthorizationPropertiesFormat {␊ - /**␊ - * Gets or sets the authorization key␊ - */␊ - authorizationKey?: string␊ - /**␊ - * Gets or sets AuthorizationUseStatus.␊ - */␊ - authorizationUseStatus?: (("Available" | "InUse") | string)␊ - /**␊ - * Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings␊ - */␊ - export interface ExpressRouteCircuitsPeerings {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/peerings"␊ - apiVersion: "2015-05-01-preview"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties: (ExpressRouteCircuitPeeringPropertiesFormat | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - export interface ExpressRouteCircuitPeeringPropertiesFormat {␊ - /**␊ - * Gets or sets PeeringType.␊ - */␊ - peeringType?: (("AzurePublicPeering" | "AzurePrivatePeering" | "MicrosoftPeering") | string)␊ - /**␊ - * Gets or sets state of Peering.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * Gets or sets the azure ASN␊ - */␊ - azureASN?: (number | string)␊ - /**␊ - * Gets or sets the peer ASN␊ - */␊ - peerASN?: (number | string)␊ - /**␊ - * Gets or sets the primary address prefix␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * Gets or sets the secondary address prefix␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * Gets or sets the primary port␊ - */␊ - primaryAzurePort?: string␊ - /**␊ - * Gets or sets the secondary port␊ - */␊ - secondaryAzurePort?: string␊ - /**␊ - * Gets or sets the shared key␊ - */␊ - sharedKey?: string␊ - /**␊ - * Gets or sets the vlan id␊ - */␊ - vlanId?: (number | string)␊ - /**␊ - * Gets or sets the Microsoft peering config␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig | string)␊ - /**␊ - * Gets or peering stats␊ - */␊ - stats?: (ExpressRouteCircuitStats | string)␊ - /**␊ - * Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the peering config␊ - */␊ - export interface ExpressRouteCircuitPeeringConfig {␊ - /**␊ - * Gets or sets the reference of AdvertisedPublicPrefixes␊ - */␊ - advertisedPublicPrefixes?: (string[] | string)␊ - /**␊ - * Gets or sets AdvertisedPublicPrefixState of the Peering resource.␊ - */␊ - advertisedPublicPrefixesState?: (("NotConfigured" | "Configuring" | "Configured" | "ValidationNeeded") | string)␊ - /**␊ - * Gets or Sets CustomerAsn of the peering.␊ - */␊ - customerASN?: (number | string)␊ - /**␊ - * Gets or Sets RoutingRegistryName of the config.␊ - */␊ - routingRegistryName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains Stats associated with the peering␊ - */␊ - export interface ExpressRouteCircuitStats {␊ - /**␊ - * Gets BytesIn of the peering.␊ - */␊ - bytesIn?: (number | string)␊ - /**␊ - * Gets BytesOut of the peering.␊ - */␊ - bytesOut?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers␊ - */␊ - export interface LoadBalancers13 {␊ - name: string␊ - type: "Microsoft.Network/loadBalancers"␊ - apiVersion: "2015-05-01-preview"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (LoadBalancerPropertiesFormat5 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Load Balancer␊ - */␊ - export interface LoadBalancerPropertiesFormat5 {␊ - /**␊ - * Gets or sets frontend IP addresses of the load balancer␊ - */␊ - frontendIPConfigurations?: (FrontendIpConfiguration[] | string)␊ - /**␊ - * Gets or sets Pools of backend IP addresses␊ - */␊ - backendAddressPools?: (BackendAddressPool5[] | string)␊ - /**␊ - * Gets or sets load balancing rules␊ - */␊ - loadBalancingRules?: (LoadBalancingRule5[] | string)␊ - /**␊ - * Gets or sets list of Load balancer probes␊ - */␊ - probes?: (Probe5[] | string)␊ - /**␊ - * Gets or sets list of inbound rules␊ - */␊ - inboundNatRules?: (InboundNatRule6[] | string)␊ - /**␊ - * Gets or sets inbound NAT pools␊ - */␊ - inboundNatPools?: (InboundNatPool6[] | string)␊ - /**␊ - * Gets or sets outbound NAT rules␊ - */␊ - outboundNatRules?: (OutboundNatRule5[] | string)␊ - /**␊ - * Gets or sets resource guid property of the Load balancer resource␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP address of the load balancer␊ - */␊ - export interface FrontendIpConfiguration {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties?: (FrontendIpConfigurationPropertiesFormat | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP Configuration of the load balancer␊ - */␊ - export interface FrontendIpConfigurationPropertiesFormat {␊ - /**␊ - * Gets or sets the IP address of the Load Balancer.This is only specified if a specific private IP address shall be allocated from the subnet specified in subnetRef␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * Gets or sets PrivateIP allocation method (Static/Dynamic).␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Gets or sets the reference of the subnet resource.A subnet from where the load balancer gets its private frontend address ␊ - */␊ - subnet?: (SubResource11 | string)␊ - /**␊ - * Gets or sets the reference of the PublicIP resource␊ - */␊ - publicIPAddress?: (SubResource11 | string)␊ - /**␊ - * Read only.Inbound rules URIs that use this frontend IP␊ - */␊ - inboundNatRules?: (SubResource11[] | string)␊ - /**␊ - * Read only.Inbound pools URIs that use this frontend IP␊ - */␊ - inboundNatPools?: (SubResource11[] | string)␊ - /**␊ - * Read only.Outbound rules URIs that use this frontend IP␊ - */␊ - outboundNatRules?: (SubResource11[] | string)␊ - /**␊ - * Gets Load Balancing rules URIs that use this frontend IP␊ - */␊ - loadBalancingRules?: (SubResource11[] | string)␊ - /**␊ - * Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Pool of backend IP addresses␊ - */␊ - export interface BackendAddressPool5 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties?: (BackendAddressPoolPropertiesFormat5 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of BackendAddressPool␊ - */␊ - export interface BackendAddressPoolPropertiesFormat5 {␊ - /**␊ - * Gets collection of references to IPs defined in NICs␊ - */␊ - backendIPConfigurations?: (SubResource11[] | string)␊ - /**␊ - * Gets Load Balancing rules that use this Backend Address Pool␊ - */␊ - loadBalancingRules?: (SubResource11[] | string)␊ - /**␊ - * Gets outbound rules that use this Backend Address Pool␊ - */␊ - outboundNatRule?: (SubResource11 | string)␊ - /**␊ - * Provisioning state of the PublicIP resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Rules of the load balancer␊ - */␊ - export interface LoadBalancingRule5 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties?: (LoadBalancingRulePropertiesFormat5 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer␊ - */␊ - export interface LoadBalancingRulePropertiesFormat5 {␊ - /**␊ - * Gets or sets a reference to frontend IP Addresses␊ - */␊ - frontendIPConfiguration: (SubResource11 | string)␊ - /**␊ - * Gets or sets a reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs␊ - */␊ - backendAddressPool: (SubResource11 | string)␊ - /**␊ - * Gets or sets the reference of the load balancer probe used by the Load Balancing rule.␊ - */␊ - probe?: (SubResource11 | string)␊ - /**␊ - * Gets or sets the transport protocol for the external endpoint. Possible values are Udp or Tcp.␊ - */␊ - protocol: (("Udp" | "Tcp") | string)␊ - /**␊ - * Gets or sets the load distribution policy for this rule.␊ - */␊ - loadDistribution?: (("Default" | "SourceIP" | "SourceIPProtocol") | string)␊ - /**␊ - * Gets or sets the port for the external endpoint. You can specify any port number you choose, but the port numbers specified for each role in the service must be unique. Possible values range between 1 and 65535, inclusive␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * Gets or sets a port used for internal connections on the endpoint. The localPort attribute maps the eternal port of the endpoint to an internal port on a role. This is useful in scenarios where a role must communicate to an internal component on a port that is different from the one that is exposed externally. If not specified, the value of localPort is the same as the port attribute. Set the value of localPort to '*' to automatically assign an unallocated port that is discoverable using the runtime API␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * Gets or sets the timeout for the Tcp idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to Tcp␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn availability Group. This setting is required when using the SQL Always ON availability Groups in SQL server. This setting can't be changed after you create the endpoint␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Load balancer Probe␊ - */␊ - export interface Probe5 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties?: (ProbePropertiesFormat5 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - export interface ProbePropertiesFormat5 {␊ - /**␊ - * Gets Load balancer rules that use this probe␊ - */␊ - loadBalancingRules?: (SubResource11[] | string)␊ - /**␊ - * Gets or sets the protocol of the end point. Possible values are http pr Tcp. If Tcp is specified, a received ACK is required for the probe to be successful. If http is specified,a 200 OK response from the specifies URI is required for the probe to be successful.␊ - */␊ - protocol: (("Http" | "Tcp") | string)␊ - /**␊ - * Gets or sets Port for communicating the probe. Possible values range from 1 to 65535, inclusive.␊ - */␊ - port: (number | string)␊ - /**␊ - * Gets or sets the interval, in seconds, for how frequently to probe the endpoint for health status. Typically, the interval is slightly less than half the allocated timeout period (in seconds) which allows two full probes before taking the instance out of rotation. The default value is 15, the minimum value is 5␊ - */␊ - intervalInSeconds?: (number | string)␊ - /**␊ - * Gets or sets the number of probes where if no response, will result in stopping further traffic from being delivered to the endpoint. This values allows endpoints to be taken out of rotation faster or slower than the typical times used in Azure. ␊ - */␊ - numberOfProbes: (number | string)␊ - /**␊ - * Gets or sets the URI used for requesting health status from the VM. Path is required if a protocol is set to http. Otherwise, it is not allowed. There is no default value␊ - */␊ - requestPath?: string␊ - /**␊ - * Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT rule of the loadbalancer␊ - */␊ - export interface InboundNatRule6 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties?: (InboundNatRulePropertiesFormat5 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Inbound NAT rule␊ - */␊ - export interface InboundNatRulePropertiesFormat5 {␊ - /**␊ - * Gets or sets a reference to frontend IP Addresses␊ - */␊ - frontendIPConfiguration: (SubResource11 | string)␊ - /**␊ - * Gets or sets a reference to a private ip address defined on a NetworkInterface of a VM. Traffic sent to frontendPort of each of the frontendIPConfigurations is forwarded to the backed IP␊ - */␊ - backendIPConfiguration?: (SubResource11 | string)␊ - /**␊ - * Gets or sets the transport protocol for the external endpoint. Possible values are Udp or Tcp.␊ - */␊ - protocol: (("Udp" | "Tcp") | string)␊ - /**␊ - * Gets or sets the port for the external endpoint. You can specify any port number you choose, but the port numbers specified for each role in the service must be unique. Possible values range between 1 and 65535, inclusive␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * Gets or sets a port used for internal connections on the endpoint. The localPort attribute maps the eternal port of the endpoint to an internal port on a role. This is useful in scenarios where a role must communicate to an internal component on a port that is different from the one that is exposed externally. If not specified, the value of localPort is the same as the port attribute. Set the value of localPort to '*' to automatically assign an unallocated port that is discoverable using the runtime API␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * Gets or sets the timeout for the Tcp idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to Tcp␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn availability Group. This setting is required when using the SQL Always ON availability Groups in SQL server. This setting can't be changed after you create the endpoint␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT pool of the loadbalancer␊ - */␊ - export interface InboundNatPool6 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties?: (InboundNatPoolPropertiesFormat5 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Inbound NAT pool␊ - */␊ - export interface InboundNatPoolPropertiesFormat5 {␊ - /**␊ - * Gets or sets a reference to frontend IP Addresses␊ - */␊ - frontendIPConfiguration: (SubResource11 | string)␊ - /**␊ - * Gets or sets the transport protocol for the external endpoint. Possible values are Udp or Tcp.␊ - */␊ - protocol: (("Udp" | "Tcp") | string)␊ - /**␊ - * Gets or sets the starting port range for the NAT pool. You can specify any port number you choose, but the port numbers specified for each role in the service must be unique. Possible values range between 1 and 65535, inclusive␊ - */␊ - frontendPortRangeStart: (number | string)␊ - /**␊ - * Gets or sets the ending port range for the NAT pool. You can specify any port number you choose, but the port numbers specified for each role in the service must be unique. Possible values range between 1 and 65535, inclusive␊ - */␊ - frontendPortRangeEnd: (number | string)␊ - /**␊ - * Gets or sets a port used for internal connections on the endpoint. The localPort attribute maps the eternal port of the endpoint to an internal port on a role. This is useful in scenarios where a role must communicate to an internal component on a port that is different from the one that is exposed externally. If not specified, the value of localPort is the same as the port attribute. Set the value of localPort to '*' to automatically assign an unallocated port that is discoverable using the runtime API␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound NAT pool of the loadbalancer␊ - */␊ - export interface OutboundNatRule5 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties?: (OutboundNatRulePropertiesFormat5 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound NAT pool of the loadbalancer␊ - */␊ - export interface OutboundNatRulePropertiesFormat5 {␊ - /**␊ - * Gets or sets the number of outbound ports to be used for SNAT␊ - */␊ - allocatedOutboundPorts: (number | string)␊ - /**␊ - * Gets or sets Frontend IP addresses of the load balancer␊ - */␊ - frontendIPConfigurations?: (SubResource11[] | string)␊ - /**␊ - * Gets or sets a reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs␊ - */␊ - backendAddressPool: (SubResource11 | string)␊ - /**␊ - * Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/localNetworkGateways␊ - */␊ - export interface LocalNetworkGateways5 {␊ - name: string␊ - type: "Microsoft.Network/localNetworkGateways"␊ - apiVersion: "2015-05-01-preview"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (LocalNetworkGatewayPropertiesFormat5 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * LocalNetworkGateway properties␊ - */␊ - export interface LocalNetworkGatewayPropertiesFormat5 {␊ - /**␊ - * Local network site Address space␊ - */␊ - localNetworkAddressSpace?: (AddressSpace13 | string)␊ - /**␊ - * IP address of local network gateway.␊ - */␊ - gatewayIpAddress?: string␊ - /**␊ - * Gets or sets resource guid property of the LocalNetworkGateway resource␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Gets or sets Provisioning state of the LocalNetworkGateway resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AddressSpace contains an array of IP address ranges that can be used by subnets␊ - */␊ - export interface AddressSpace13 {␊ - /**␊ - * Gets or sets List of address blocks reserved for this virtual network in CIDR notation␊ - */␊ - addressPrefixes: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces␊ - */␊ - export interface NetworkInterfaces14 {␊ - name: string␊ - type: "Microsoft.Network/networkInterfaces"␊ - apiVersion: "2015-05-01-preview"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (NetworkInterfacePropertiesFormat5 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NetworkInterface properties. ␊ - */␊ - export interface NetworkInterfacePropertiesFormat5 {␊ - /**␊ - * Gets or sets the reference of a VirtualMachine␊ - */␊ - virtualMachine?: (SubResource11 | string)␊ - /**␊ - * Gets or sets the reference of the NetworkSecurityGroup resource␊ - */␊ - networkSecurityGroup?: (SubResource11 | string)␊ - /**␊ - * Gets or sets list of IPConfigurations of the NetworkInterface␊ - */␊ - ipConfigurations: (NetworkInterfaceIpConfiguration[] | string)␊ - /**␊ - * Gets or sets DNS Settings in NetworkInterface␊ - */␊ - dnsSettings?: (NetworkInterfaceDnsSettings13 | string)␊ - /**␊ - * Gets the MAC Address of the network interface␊ - */␊ - macAddress?: string␊ - /**␊ - * Gets whether this is a primary NIC on a virtual machine␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * Gets or sets whether IPForwarding is enabled on the NIC␊ - */␊ - enableIPForwarding?: (boolean | string)␊ - /**␊ - * Gets or sets resource guid property of the network interface resource␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IPConfiguration in a NetworkInterface␊ - */␊ - export interface NetworkInterfaceIpConfiguration {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties?: (NetworkInterfaceIpConfigurationPropertiesFormat | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IPConfiguration␊ - */␊ - export interface NetworkInterfaceIpConfigurationPropertiesFormat {␊ - /**␊ - * Gets or sets the privateIPAddress of the Network Interface IP Configuration␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * Gets or sets PrivateIP allocation method (Static/Dynamic).␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Gets or sets the reference of the subnet resource␊ - */␊ - subnet?: (SubResource11 | string)␊ - /**␊ - * Gets or sets the reference of the PublicIP resource␊ - */␊ - publicIPAddress?: (SubResource11 | string)␊ - /**␊ - * Gets or sets the reference of LoadBalancerBackendAddressPool resource␊ - */␊ - loadBalancerBackendAddressPools?: (SubResource11[] | string)␊ - /**␊ - * Gets or sets list of references of LoadBalancerInboundNatRules␊ - */␊ - loadBalancerInboundNatRules?: (SubResource11[] | string)␊ - /**␊ - * Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Dns Settings of a network interface␊ - */␊ - export interface NetworkInterfaceDnsSettings13 {␊ - /**␊ - * Gets or sets list of DNS servers IP addresses␊ - */␊ - dnsServers?: (string[] | string)␊ - /**␊ - * Gets or sets list of Applied DNS servers IP addresses␊ - */␊ - appliedDnsServers?: (string[] | string)␊ - /**␊ - * Gets or sets the Internal DNS name␊ - */␊ - internalDnsNameLabel?: string␊ - /**␊ - * Gets or sets full IDNS name in the form, DnsName.VnetId.ZoneId.TopLevelSuffix. This is set when the NIC is associated to a VM␊ - */␊ - internalFqdn?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups␊ - */␊ - export interface NetworkSecurityGroups13 {␊ - name: string␊ - type: "Microsoft.Network/networkSecurityGroups"␊ - apiVersion: "2015-05-01-preview"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (NetworkSecurityGroupPropertiesFormat5 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - resources?: NetworkSecurityGroupsSecurityRulesChildResource5[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network Security Group resource␊ - */␊ - export interface NetworkSecurityGroupPropertiesFormat5 {␊ - /**␊ - * Gets or sets Security rules of network security group␊ - */␊ - securityRules?: (SecurityRule5[] | string)␊ - /**␊ - * Gets or sets Default security rules of network security group␊ - */␊ - defaultSecurityRules?: (SecurityRule5[] | string)␊ - /**␊ - * Gets collection of references to Network Interfaces␊ - */␊ - networkInterfaces?: (SubResource11[] | string)␊ - /**␊ - * Gets collection of references to subnets␊ - */␊ - subnets?: (SubResource11[] | string)␊ - /**␊ - * Gets or sets resource guid property of the network security group resource␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network security rule␊ - */␊ - export interface SecurityRule5 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties?: (SecurityRulePropertiesFormat5 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - export interface SecurityRulePropertiesFormat5 {␊ - /**␊ - * Gets or sets a description for this rule. Restricted to 140 chars.␊ - */␊ - description?: string␊ - /**␊ - * Gets or sets Network protocol this rule applies to. Can be Tcp, Udp or All(*).␊ - */␊ - protocol: (("Tcp" | "Udp" | "*") | string)␊ - /**␊ - * Gets or sets Source Port or Range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.␊ - */␊ - sourcePortRange?: string␊ - /**␊ - * Gets or sets Destination Port or Range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.␊ - */␊ - destinationPortRange?: string␊ - /**␊ - * Gets or sets source address prefix. CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. ␊ - */␊ - sourceAddressPrefix: string␊ - /**␊ - * Gets or sets destination address prefix. CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. ␊ - */␊ - destinationAddressPrefix: string␊ - /**␊ - * Gets or sets network traffic is allowed or denied. Possible values are 'Allow' and 'Deny'.␊ - */␊ - access: (("Allow" | "Deny") | string)␊ - /**␊ - * Gets or sets the priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.␊ - */␊ - priority: (number | string)␊ - /**␊ - * Gets or sets the direction of the rule.InBound or Outbound. The direction specifies if rule will be evaluated on incoming or outgoing traffic.␊ - */␊ - direction: (("Inbound" | "Outbound") | string)␊ - /**␊ - * Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRulesChildResource5 {␊ - name: string␊ - type: "securityRules"␊ - apiVersion: "2015-05-01-preview"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties: (SecurityRulePropertiesFormat5 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRules5 {␊ - name: string␊ - type: "Microsoft.Network/networkSecurityGroups/securityRules"␊ - apiVersion: "2015-05-01-preview"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties: (SecurityRulePropertiesFormat5 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/publicIPAddresses␊ - */␊ - export interface PublicIPAddresses13 {␊ - name: string␊ - type: "Microsoft.Network/publicIPAddresses"␊ - apiVersion: "2015-05-01-preview"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (PublicIpAddressPropertiesFormat | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * PublicIpAddress properties␊ - */␊ - export interface PublicIpAddressPropertiesFormat {␊ - /**␊ - * Gets or sets PublicIP allocation method (Static/Dynamic).␊ - */␊ - publicIPAllocationMethod: (("Static" | "Dynamic") | string)␊ - /**␊ - * Gets a reference to the network interface IP configurations using this public IP address␊ - */␊ - ipConfiguration?: (SubResource11 | string)␊ - /**␊ - * Gets or sets FQDN of the DNS record associated with the public IP address␊ - */␊ - dnsSettings?: (PublicIpAddressDnsSettings | string)␊ - /**␊ - * Gets the assigned public IP address␊ - */␊ - ipAddress?: string␊ - /**␊ - * Gets or sets the idle timeout of the public IP address␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Gets or sets resource guid property of the PublicIP resource␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains FQDN of the DNS record associated with the public IP address␊ - */␊ - export interface PublicIpAddressDnsSettings {␊ - /**␊ - * Gets or sets the Domain name label.The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.␊ - */␊ - domainNameLabel: string␊ - /**␊ - * Gets the FQDN, Fully qualified domain name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone.␊ - */␊ - fqdn?: string␊ - /**␊ - * Gets or Sets the Reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN. ␊ - */␊ - reverseFqdn?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables␊ - */␊ - export interface RouteTables13 {␊ - name: string␊ - type: "Microsoft.Network/routeTables"␊ - apiVersion: "2015-05-01-preview"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (RouteTablePropertiesFormat5 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - resources?: RouteTablesRoutesChildResource5[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Table resource␊ - */␊ - export interface RouteTablePropertiesFormat5 {␊ - /**␊ - * Gets or sets Routes in a Route Table␊ - */␊ - routes?: (Route5[] | string)␊ - /**␊ - * Gets collection of references to subnets␊ - */␊ - subnets?: (SubResource11[] | string)␊ - /**␊ - * Gets or sets Provisioning state of the resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource␊ - */␊ - export interface Route5 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties?: (RoutePropertiesFormat5 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource␊ - */␊ - export interface RoutePropertiesFormat5 {␊ - /**␊ - * Gets or sets the destination CIDR to which the route applies.␊ - */␊ - addressPrefix: string␊ - /**␊ - * Gets or sets the type of Azure hop the packet should be sent to.␊ - */␊ - nextHopType: (("VirtualNetworkGateway" | "VnetLocal" | "Internet" | "VirtualAppliance" | "None" | "HyperNetGateway") | string)␊ - /**␊ - * Gets or sets the IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.␊ - */␊ - nextHopIpAddress?: string␊ - /**␊ - * Gets or sets Provisioning state of the resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutesChildResource5 {␊ - name: string␊ - type: "routes"␊ - apiVersion: "2015-05-01-preview"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties: (RoutePropertiesFormat5 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutes5 {␊ - name: string␊ - type: "Microsoft.Network/routeTables/routes"␊ - apiVersion: "2015-05-01-preview"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties: (RoutePropertiesFormat5 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworkGateways␊ - */␊ - export interface VirtualNetworkGateways5 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworkGateways"␊ - apiVersion: "2015-05-01-preview"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (VirtualNetworkGatewayPropertiesFormat5 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGateway properties␊ - */␊ - export interface VirtualNetworkGatewayPropertiesFormat5 {␊ - /**␊ - * IpConfigurations for Virtual network gateway.␊ - */␊ - ipConfigurations?: (VirtualNetworkGatewayIpConfiguration[] | string)␊ - /**␊ - * The type of this virtual network gateway.␊ - */␊ - gatewayType?: (("Vpn" | "ExpressRoute") | string)␊ - /**␊ - * The type of this virtual network gateway.␊ - */␊ - vpnType?: (("PolicyBased" | "RouteBased") | string)␊ - /**␊ - * EnableBgp Flag␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * Gets or sets the reference of the LocalNetworkGateway resource which represents Local network site having default routes. Assign Null value in case of removing existing default site setting.␊ - */␊ - gatewayDefaultSite?: (SubResource11 | string)␊ - /**␊ - * Gets or sets resource guid property of the VirtualNetworkGateway resource␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Gets or sets Provisioning state of the VirtualNetworkGateway resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IpConfiguration for Virtual network gateway␊ - */␊ - export interface VirtualNetworkGatewayIpConfiguration {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties?: (VirtualNetworkGatewayIpConfigurationPropertiesFormat | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of VirtualNetworkGatewayIPConfiguration␊ - */␊ - export interface VirtualNetworkGatewayIpConfigurationPropertiesFormat {␊ - /**␊ - * Gets or sets the privateIPAddress of the Network Interface IP Configuration␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * Gets or sets PrivateIP allocation method (Static/Dynamic).␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Gets or sets the reference of the subnet resource␊ - */␊ - subnet?: (SubResource11 | string)␊ - /**␊ - * Gets or sets the reference of the PublicIP resource␊ - */␊ - publicIPAddress?: (SubResource11 | string)␊ - /**␊ - * Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks␊ - */␊ - export interface VirtualNetworks13 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks"␊ - apiVersion: "2015-05-01-preview"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (VirtualNetworkPropertiesFormat5 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - resources?: VirtualNetworksSubnetsChildResource5[]␊ - [k: string]: unknown␊ - }␊ - export interface VirtualNetworkPropertiesFormat5 {␊ - /**␊ - * Gets or sets AddressSpace that contains an array of IP address ranges that can be used by subnets␊ - */␊ - addressSpace: (AddressSpace13 | string)␊ - /**␊ - * Gets or sets DHCPOptions that contains an array of DNS servers available to VMs deployed in the virtual network␊ - */␊ - dhcpOptions?: (DhcpOptions13 | string)␊ - /**␊ - * Gets or sets List of subnets in a VirtualNetwork␊ - */␊ - subnets?: (Subnet15[] | string)␊ - /**␊ - * Gets or sets resource guid property of the VirtualNetwork resource␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DHCPOptions contains an array of DNS servers available to VMs deployed in the virtual networkStandard DHCP option for a subnet overrides VNET DHCP options.␊ - */␊ - export interface DhcpOptions13 {␊ - /**␊ - * Gets or sets list of DNS servers IP addresses␊ - */␊ - dnsServers: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Subnet in a VirtualNetwork resource␊ - */␊ - export interface Subnet15 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties?: (SubnetPropertiesFormat5 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - export interface SubnetPropertiesFormat5 {␊ - /**␊ - * Gets or sets Address prefix for the subnet.␊ - */␊ - addressPrefix: string␊ - /**␊ - * Gets or sets the reference of the NetworkSecurityGroup resource␊ - */␊ - networkSecurityGroup?: (SubResource11 | string)␊ - /**␊ - * Gets or sets the reference of the RouteTable resource␊ - */␊ - routeTable?: (SubResource11 | string)␊ - /**␊ - * Gets array of references to the network interface IP configurations using subnet␊ - */␊ - ipConfigurations?: (SubResource11[] | string)␊ - /**␊ - * Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnetsChildResource5 {␊ - name: string␊ - type: "subnets"␊ - apiVersion: "2015-05-01-preview"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties: (SubnetPropertiesFormat5 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnets5 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks/subnets"␊ - apiVersion: "2015-05-01-preview"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties: (SubnetPropertiesFormat5 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/applicationGateways␊ - */␊ - export interface ApplicationGateways6 {␊ - name: string␊ - type: "Microsoft.Network/applicationGateways"␊ - apiVersion: "2015-06-15"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (ApplicationGatewayPropertiesFormat6 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application gateway.␊ - */␊ - export interface ApplicationGatewayPropertiesFormat6 {␊ - /**␊ - * SKU of the application gateway resource.␊ - */␊ - sku?: (ApplicationGatewaySku6 | string)␊ - /**␊ - * Gets or sets subnets of application gateway resource␊ - */␊ - gatewayIPConfigurations?: (ApplicationGatewayIPConfiguration6[] | string)␊ - /**␊ - * SSL certificates of the application gateway resource.␊ - */␊ - sslCertificates?: (ApplicationGatewaySslCertificate6[] | string)␊ - /**␊ - * Frontend IP addresses of the application gateway resource.␊ - */␊ - frontendIPConfigurations?: (ApplicationGatewayFrontendIPConfiguration6[] | string)␊ - /**␊ - * Frontend ports of the application gateway resource.␊ - */␊ - frontendPorts?: (ApplicationGatewayFrontendPort6[] | string)␊ - /**␊ - * Probes of the application gateway resource.␊ - */␊ - probes?: (ApplicationGatewayProbe5[] | string)␊ - /**␊ - * Backend address pool of the application gateway resource.␊ - */␊ - backendAddressPools?: (ApplicationGatewayBackendAddressPool6[] | string)␊ - /**␊ - * Backend http settings of the application gateway resource.␊ - */␊ - backendHttpSettingsCollection?: (ApplicationGatewayBackendHttpSettings6[] | string)␊ - /**␊ - * Http listeners of the application gateway resource.␊ - */␊ - httpListeners?: (ApplicationGatewayHttpListener6[] | string)␊ - /**␊ - * URL path map of the application gateway resource.␊ - */␊ - urlPathMaps?: (ApplicationGatewayUrlPathMap5[] | string)␊ - /**␊ - * Request routing rules of the application gateway resource.␊ - */␊ - requestRoutingRules?: (ApplicationGatewayRequestRoutingRule6[] | string)␊ - /**␊ - * Resource GUID property of the application gateway resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of application gateway␊ - */␊ - export interface ApplicationGatewaySku6 {␊ - /**␊ - * Name of an application gateway SKU. Possible values are: 'Standard_Small', 'Standard_Medium', 'Standard_Large', 'WAF_Medium', and 'WAF_Large'.␊ - */␊ - name?: (("Standard_Small" | "Standard_Medium" | "Standard_Large") | string)␊ - /**␊ - * Tier of an application gateway.␊ - */␊ - tier?: ("Standard" | string)␊ - /**␊ - * Capacity (instance count) of an application gateway.␊ - */␊ - capacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed.␊ - */␊ - export interface ApplicationGatewayIPConfiguration6 {␊ - properties?: (ApplicationGatewayIPConfigurationPropertiesFormat6 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayIPConfigurationPropertiesFormat6 {␊ - /**␊ - * Reference of the subnet resource. A subnet from where application gateway gets its private address.␊ - */␊ - subnet?: (SubResource12 | string)␊ - /**␊ - * Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure resource manager sub resource properties.␊ - */␊ - export interface SubResource12 {␊ - /**␊ - * Resource Identifier.␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSL certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewaySslCertificate6 {␊ - properties?: (ApplicationGatewaySslCertificatePropertiesFormat6 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewaySslCertificatePropertiesFormat6 {␊ - /**␊ - * Base-64 encoded pfx certificate. Only applicable in PUT Request.␊ - */␊ - data?: string␊ - /**␊ - * Password for the pfx file specified in data. Only applicable in PUT request.␊ - */␊ - password?: string␊ - /**␊ - * Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request.␊ - */␊ - publicCertData?: string␊ - /**␊ - * Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendIPConfiguration6 {␊ - properties?: (ApplicationGatewayFrontendIPConfigurationPropertiesFormat6 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendIPConfigurationPropertiesFormat6 {␊ - /**␊ - * PrivateIPAddress of the network interface IP Configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * PrivateIP allocation method. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Reference of the subnet resource.␊ - */␊ - subnet?: (SubResource12 | string)␊ - /**␊ - * Reference of the PublicIP resource.␊ - */␊ - publicIPAddress?: (SubResource12 | string)␊ - /**␊ - * Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend port of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendPort6 {␊ - properties?: (ApplicationGatewayFrontendPortPropertiesFormat6 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend port of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendPortPropertiesFormat6 {␊ - /**␊ - * Frontend port␊ - */␊ - port?: (number | string)␊ - /**␊ - * Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Probe of the application gateway.␊ - */␊ - export interface ApplicationGatewayProbe5 {␊ - properties?: (ApplicationGatewayProbePropertiesFormat5 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of probe of an application gateway.␊ - */␊ - export interface ApplicationGatewayProbePropertiesFormat5 {␊ - /**␊ - * Protocol. Possible values are: 'Http' and 'Https'.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Host name to send the probe to.␊ - */␊ - host?: string␊ - /**␊ - * Relative path of probe. Valid path starts from '/'. Probe is sent to ://:␊ - */␊ - path?: string␊ - /**␊ - * The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - interval?: (number | string)␊ - /**␊ - * the probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - timeout?: (number | string)␊ - /**␊ - * The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20.␊ - */␊ - unhealthyThreshold?: (number | string)␊ - /**␊ - * Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend Address Pool of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddressPool6 {␊ - properties?: (ApplicationGatewayBackendAddressPoolPropertiesFormat6 | string)␊ - /**␊ - * Resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend Address Pool of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddressPoolPropertiesFormat6 {␊ - /**␊ - * Collection of references to IPs defined in network interfaces.␊ - */␊ - backendIPConfigurations?: (SubResource12[] | string)␊ - /**␊ - * Backend addresses␊ - */␊ - backendAddresses?: (ApplicationGatewayBackendAddress6[] | string)␊ - /**␊ - * Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddress6 {␊ - /**␊ - * Fully qualified domain name (FQDN).␊ - */␊ - fqdn?: string␊ - /**␊ - * IP address␊ - */␊ - ipAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address pool settings of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendHttpSettings6 {␊ - properties?: (ApplicationGatewayBackendHttpSettingsPropertiesFormat6 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend address pool settings of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendHttpSettingsPropertiesFormat6 {␊ - /**␊ - * Port␊ - */␊ - port?: (number | string)␊ - /**␊ - * Protocol. Possible values are: 'Http' and 'Https'.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Cookie based affinity. Possible values are: 'Enabled' and 'Disabled'.␊ - */␊ - cookieBasedAffinity?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Request timeout in seconds. Application Gateway will fail the request if response is not received within RequestTimeout. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - requestTimeout?: (number | string)␊ - /**␊ - * Probe resource of an application gateway.␊ - */␊ - probe?: (SubResource12 | string)␊ - /**␊ - * Gets or sets Provisioning state of the backend http settings resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http listener of an application gateway.␊ - */␊ - export interface ApplicationGatewayHttpListener6 {␊ - properties?: (ApplicationGatewayHttpListenerPropertiesFormat6 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of HTTP listener of an application gateway.␊ - */␊ - export interface ApplicationGatewayHttpListenerPropertiesFormat6 {␊ - /**␊ - * Frontend IP configuration resource of an application gateway.␊ - */␊ - frontendIPConfiguration?: (SubResource12 | string)␊ - /**␊ - * Frontend port resource of an application gateway.␊ - */␊ - frontendPort?: (SubResource12 | string)␊ - /**␊ - * Protocol. Possible values are: 'Http' and 'Https'.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Host name of HTTP listener.␊ - */␊ - hostName?: string␊ - /**␊ - * SSL certificate resource of an application gateway.␊ - */␊ - sslCertificate?: (SubResource12 | string)␊ - /**␊ - * Applicable only if protocol is https. Enables SNI for multi-hosting.␊ - */␊ - requireServerNameIndication?: (boolean | string)␊ - /**␊ - * Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * UrlPathMaps give a url path to the backend mapping information for PathBasedRouting.␊ - */␊ - export interface ApplicationGatewayUrlPathMap5 {␊ - properties?: (ApplicationGatewayUrlPathMapPropertiesFormat5 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of UrlPathMap of the application gateway.␊ - */␊ - export interface ApplicationGatewayUrlPathMapPropertiesFormat5 {␊ - /**␊ - * Default backend address pool resource of URL path map.␊ - */␊ - defaultBackendAddressPool?: (SubResource12 | string)␊ - /**␊ - * Default backend http settings resource of URL path map.␊ - */␊ - defaultBackendHttpSettings?: (SubResource12 | string)␊ - /**␊ - * Path rule of URL path map resource.␊ - */␊ - pathRules?: (ApplicationGatewayPathRule5[] | string)␊ - /**␊ - * Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Path rule of URL path map of an application gateway.␊ - */␊ - export interface ApplicationGatewayPathRule5 {␊ - properties?: (ApplicationGatewayPathRulePropertiesFormat5 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of probe of an application gateway.␊ - */␊ - export interface ApplicationGatewayPathRulePropertiesFormat5 {␊ - /**␊ - * Path rules of URL path map.␊ - */␊ - paths?: (string[] | string)␊ - /**␊ - * Backend address pool resource of URL path map.␊ - */␊ - backendAddressPool?: (SubResource12 | string)␊ - /**␊ - * Backend http settings resource of URL path map.␊ - */␊ - backendHttpSettings?: (SubResource12 | string)␊ - /**␊ - * Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Request routing rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayRequestRoutingRule6 {␊ - properties?: (ApplicationGatewayRequestRoutingRulePropertiesFormat6 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of request routing rule of the application gateway.␊ - */␊ - export interface ApplicationGatewayRequestRoutingRulePropertiesFormat6 {␊ - /**␊ - * Rule type. Possible values are: 'Basic' and 'PathBasedRouting'.␊ - */␊ - ruleType?: (("Basic" | "PathBasedRouting") | string)␊ - /**␊ - * Backend address pool resource of the application gateway. ␊ - */␊ - backendAddressPool?: (SubResource12 | string)␊ - /**␊ - * Frontend port resource of the application gateway.␊ - */␊ - backendHttpSettings?: (SubResource12 | string)␊ - /**␊ - * Http listener resource of the application gateway. ␊ - */␊ - httpListener?: (SubResource12 | string)␊ - /**␊ - * URL path map resource of the application gateway.␊ - */␊ - urlPathMap?: (SubResource12 | string)␊ - /**␊ - * Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/connections␊ - */␊ - export interface Connections6 {␊ - name: string␊ - type: "Microsoft.Network/connections"␊ - apiVersion: "2015-06-15"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (VirtualNetworkGatewayConnectionPropertiesFormat6 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewayConnection properties␊ - */␊ - export interface VirtualNetworkGatewayConnectionPropertiesFormat6 {␊ - /**␊ - * The authorizationKey.␊ - */␊ - authorizationKey?: string␊ - virtualNetworkGateway1?: (SubResource12 | string)␊ - virtualNetworkGateway2?: (SubResource12 | string)␊ - localNetworkGateway2?: (SubResource12 | string)␊ - /**␊ - * Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.␊ - */␊ - connectionType?: (("IPsec" | "Vnet2Vnet" | "ExpressRoute" | "VPNClient") | string)␊ - /**␊ - * The routing weight.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * The IPSec shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * Virtual network Gateway connection status. Possible values are 'Unknown', 'Connecting', 'Connected' and 'NotConnected'.␊ - */␊ - connectionStatus?: (("Unknown" | "Connecting" | "Connected" | "NotConnected") | string)␊ - /**␊ - * The egress bytes transferred in this connection.␊ - */␊ - egressBytesTransferred?: (number | string)␊ - /**␊ - * The ingress bytes transferred in this connection.␊ - */␊ - ingressBytesTransferred?: (number | string)␊ - /**␊ - * The reference to peerings resource.␊ - */␊ - peer?: (SubResource12 | string)␊ - /**␊ - * EnableBgp flag␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * The resource GUID property of the VirtualNetworkGatewayConnection resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits␊ - */␊ - export interface ExpressRouteCircuits {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits"␊ - apiVersion: "2015-06-15"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The SKU.␊ - */␊ - sku?: (ExpressRouteCircuitSku | string)␊ - properties: (ExpressRouteCircuitPropertiesFormat | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: (ExpressRouteCircuitsPeeringsChildResource | ExpressRouteCircuitsAuthorizationsChildResource)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains SKU in an ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitSku {␊ - /**␊ - * The name of the SKU.␊ - */␊ - name?: string␊ - /**␊ - * The tier of the SKU. Possible values are 'Standard' and 'Premium'.␊ - */␊ - tier?: (("Standard" | "Premium") | string)␊ - /**␊ - * The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'.␊ - */␊ - family?: (("UnlimitedData" | "MeteredData") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitPropertiesFormat {␊ - /**␊ - * The CircuitProvisioningState state of the resource.␊ - */␊ - circuitProvisioningState?: string␊ - /**␊ - * The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'.␊ - */␊ - serviceProviderProvisioningState?: (("NotProvisioned" | "Provisioning" | "Provisioned" | "Deprovisioning") | string)␊ - /**␊ - * The list of authorizations.␊ - */␊ - authorizations?: (ExpressRouteCircuitAuthorization[] | string)␊ - /**␊ - * The list of peerings.␊ - */␊ - peerings?: (ExpressRouteCircuitPeering[] | string)␊ - /**␊ - * The ServiceKey.␊ - */␊ - serviceKey?: string␊ - /**␊ - * The ServiceProviderNotes.␊ - */␊ - serviceProviderNotes?: string␊ - /**␊ - * The ServiceProviderProperties.␊ - */␊ - serviceProviderProperties?: (ExpressRouteCircuitServiceProviderProperties | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authorization in an ExpressRouteCircuit resource.␊ - */␊ - export interface ExpressRouteCircuitAuthorization {␊ - properties?: (AuthorizationPropertiesFormat1 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - export interface AuthorizationPropertiesFormat1 {␊ - /**␊ - * The authorization key.␊ - */␊ - authorizationKey?: string␊ - /**␊ - * AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'.␊ - */␊ - authorizationUseStatus?: (("Available" | "InUse") | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peering in an ExpressRouteCircuit resource.␊ - */␊ - export interface ExpressRouteCircuitPeering {␊ - properties?: (ExpressRouteCircuitPeeringPropertiesFormat1 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - export interface ExpressRouteCircuitPeeringPropertiesFormat1 {␊ - /**␊ - * The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'.␊ - */␊ - peeringType?: (("AzurePublicPeering" | "AzurePrivatePeering" | "MicrosoftPeering") | string)␊ - /**␊ - * The state of peering. Possible values are: 'Disabled' and 'Enabled'.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * The Azure ASN.␊ - */␊ - azureASN?: (number | string)␊ - /**␊ - * The peer ASN.␊ - */␊ - peerASN?: (number | string)␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The primary port.␊ - */␊ - primaryAzurePort?: string␊ - /**␊ - * The secondary port.␊ - */␊ - secondaryAzurePort?: string␊ - /**␊ - * The shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The VLAN ID.␊ - */␊ - vlanId?: (number | string)␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig1 | string)␊ - /**␊ - * Gets peering stats.␊ - */␊ - stats?: (ExpressRouteCircuitStats1 | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the peering configuration.␊ - */␊ - export interface ExpressRouteCircuitPeeringConfig1 {␊ - /**␊ - * The reference of AdvertisedPublicPrefixes.␊ - */␊ - advertisedPublicPrefixes?: (string[] | string)␊ - /**␊ - * AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'.␊ - */␊ - advertisedPublicPrefixesState?: (("NotConfigured" | "Configuring" | "Configured" | "ValidationNeeded") | string)␊ - /**␊ - * The CustomerASN of the peering.␊ - */␊ - customerASN?: (number | string)␊ - /**␊ - * The RoutingRegistryName of the configuration.␊ - */␊ - routingRegistryName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains stats associated with the peering.␊ - */␊ - export interface ExpressRouteCircuitStats1 {␊ - /**␊ - * Gets BytesIn of the peering.␊ - */␊ - bytesIn?: (number | string)␊ - /**␊ - * Gets BytesOut of the peering.␊ - */␊ - bytesOut?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains ServiceProviderProperties in an ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitServiceProviderProperties {␊ - /**␊ - * The serviceProviderName.␊ - */␊ - serviceProviderName?: string␊ - /**␊ - * The peering location.␊ - */␊ - peeringLocation?: string␊ - /**␊ - * The BandwidthInMbps.␊ - */␊ - bandwidthInMbps?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings␊ - */␊ - export interface ExpressRouteCircuitsPeeringsChildResource {␊ - name: string␊ - type: "peerings"␊ - apiVersion: "2015-06-15"␊ - properties: (ExpressRouteCircuitPeeringPropertiesFormat1 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/authorizations␊ - */␊ - export interface ExpressRouteCircuitsAuthorizationsChildResource {␊ - name: string␊ - type: "authorizations"␊ - apiVersion: "2015-06-15"␊ - properties: (AuthorizationPropertiesFormat1 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/authorizations␊ - */␊ - export interface ExpressRouteCircuitsAuthorizations1 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/authorizations"␊ - apiVersion: "2015-06-15"␊ - properties: (AuthorizationPropertiesFormat1 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings␊ - */␊ - export interface ExpressRouteCircuitsPeerings1 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/peerings"␊ - apiVersion: "2015-06-15"␊ - properties: (ExpressRouteCircuitPeeringPropertiesFormat1 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers␊ - */␊ - export interface LoadBalancers14 {␊ - name: string␊ - type: "Microsoft.Network/loadBalancers"␊ - apiVersion: "2015-06-15"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (LoadBalancerPropertiesFormat6 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer.␊ - */␊ - export interface LoadBalancerPropertiesFormat6 {␊ - /**␊ - * Object representing the frontend IPs to be used for the load balancer␊ - */␊ - frontendIPConfigurations?: (FrontendIPConfiguration5[] | string)␊ - /**␊ - * Collection of backend address pools used by a load balancer␊ - */␊ - backendAddressPools?: (BackendAddressPool6[] | string)␊ - /**␊ - * Object collection representing the load balancing rules Gets the provisioning ␊ - */␊ - loadBalancingRules?: (LoadBalancingRule6[] | string)␊ - /**␊ - * Collection of probe objects used in the load balancer␊ - */␊ - probes?: (Probe6[] | string)␊ - /**␊ - * Collection of inbound NAT Rules used by a load balancer. Defining inbound NAT rules on your load balancer is mutually exclusive with defining an inbound NAT pool. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an Inbound NAT pool. They have to reference individual inbound NAT rules.␊ - */␊ - inboundNatRules?: (InboundNatRule7[] | string)␊ - /**␊ - * Defines an external port range for inbound NAT to a single backend port on NICs associated with a load balancer. Inbound NAT rules are created automatically for each NIC associated with the Load Balancer using an external port from this range. Defining an Inbound NAT pool on your Load Balancer is mutually exclusive with defining inbound Nat rules. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an inbound NAT pool. They have to reference individual inbound NAT rules.␊ - */␊ - inboundNatPools?: (InboundNatPool7[] | string)␊ - /**␊ - * The outbound NAT rules.␊ - */␊ - outboundNatRules?: (OutboundNatRule6[] | string)␊ - /**␊ - * The resource GUID property of the load balancer resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP address of the load balancer.␊ - */␊ - export interface FrontendIPConfiguration5 {␊ - properties?: (FrontendIPConfigurationPropertiesFormat5 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP Configuration of the load balancer.␊ - */␊ - export interface FrontendIPConfigurationPropertiesFormat5 {␊ - /**␊ - * Read only. Inbound rules URIs that use this frontend IP.␊ - */␊ - inboundNatRules?: (SubResource12[] | string)␊ - /**␊ - * Read only. Inbound pools URIs that use this frontend IP.␊ - */␊ - inboundNatPools?: (SubResource12[] | string)␊ - /**␊ - * Read only. Outbound rules URIs that use this frontend IP.␊ - */␊ - outboundNatRules?: (SubResource12[] | string)␊ - /**␊ - * Gets load balancing rules URIs that use this frontend IP.␊ - */␊ - loadBalancingRules?: (SubResource12[] | string)␊ - /**␊ - * The private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The Private IP allocation method. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * The reference of the subnet resource.␊ - */␊ - subnet?: (SubResource12 | string)␊ - /**␊ - * The reference of the Public IP resource.␊ - */␊ - publicIPAddress?: (SubResource12 | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Pool of backend IP addresses.␊ - */␊ - export interface BackendAddressPool6 {␊ - properties?: (BackendAddressPoolPropertiesFormat6 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the backend address pool.␊ - */␊ - export interface BackendAddressPoolPropertiesFormat6 {␊ - /**␊ - * Gets collection of references to IP addresses defined in network interfaces.␊ - */␊ - backendIPConfigurations?: (SubResource12[] | string)␊ - /**␊ - * Gets outbound rules that use this backend address pool.␊ - */␊ - outboundNatRule?: (SubResource12 | string)␊ - /**␊ - * Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A load balancing rule for a load balancer.␊ - */␊ - export interface LoadBalancingRule6 {␊ - properties?: (LoadBalancingRulePropertiesFormat6 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer.␊ - */␊ - export interface LoadBalancingRulePropertiesFormat6 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource12 | string)␊ - /**␊ - * A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs.␊ - */␊ - backendAddressPool?: (SubResource12 | string)␊ - /**␊ - * The reference of the load balancer probe used by the load balancing rule.␊ - */␊ - probe?: (SubResource12 | string)␊ - /**␊ - * The transport protocol for the external endpoint. Possible values are 'Udp' or 'Tcp'.␊ - */␊ - protocol: (("Udp" | "Tcp") | string)␊ - /**␊ - * The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'.␊ - */␊ - loadDistribution?: (("Default" | "SourceIP" | "SourceIPProtocol") | string)␊ - /**␊ - * The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 1 and 65534.␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. ␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A load balancer probe.␊ - */␊ - export interface Probe6 {␊ - properties?: (ProbePropertiesFormat6 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - export interface ProbePropertiesFormat6 {␊ - /**␊ - * The load balancer rules that use this probe.␊ - */␊ - loadBalancingRules?: (SubResource12[] | string)␊ - /**␊ - * The protocol of the end point. Possible values are: 'Http' or 'Tcp'. If 'Tcp' is specified, a received ACK is required for the probe to be successful. If 'Http' is specified, a 200 OK response from the specifies URI is required for the probe to be successful.␊ - */␊ - protocol: (("Http" | "Tcp") | string)␊ - /**␊ - * The port for communicating the probe. Possible values range from 1 to 65535, inclusive.␊ - */␊ - port: (number | string)␊ - /**␊ - * The interval, in seconds, for how frequently to probe the endpoint for health status. Typically, the interval is slightly less than half the allocated timeout period (in seconds) which allows two full probes before taking the instance out of rotation. The default value is 15, the minimum value is 5.␊ - */␊ - intervalInSeconds?: (number | string)␊ - /**␊ - * The number of probes where if no response, will result in stopping further traffic from being delivered to the endpoint. This values allows endpoints to be taken out of rotation faster or slower than the typical times used in Azure.␊ - */␊ - numberOfProbes: (number | string)␊ - /**␊ - * The URI used for requesting health status from the VM. Path is required if a protocol is set to http. Otherwise, it is not allowed. There is no default value.␊ - */␊ - requestPath?: string␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT rule of the load balancer.␊ - */␊ - export interface InboundNatRule7 {␊ - properties?: (InboundNatRulePropertiesFormat6 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the inbound NAT rule.␊ - */␊ - export interface InboundNatRulePropertiesFormat6 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource12 | string)␊ - /**␊ - * A reference to a private IP address defined on a network interface of a VM. Traffic sent to the frontend port of each of the frontend IP configurations is forwarded to the backed IP.␊ - */␊ - backendIPConfiguration?: (SubResource12 | string)␊ - /**␊ - * The transport protocol for the endpoint. Possible values are: 'Udp' or 'Tcp'.␊ - */␊ - protocol: (("Udp" | "Tcp") | string)␊ - /**␊ - * The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values range from 1 to 65534.␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * The port used for the internal endpoint. Acceptable values range from 1 to 65535.␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT pool of the load balancer.␊ - */␊ - export interface InboundNatPool7 {␊ - properties?: (InboundNatPoolPropertiesFormat6 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Inbound NAT pool.␊ - */␊ - export interface InboundNatPoolPropertiesFormat6 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource12 | string)␊ - /**␊ - * The transport protocol for the endpoint. Possible values are: 'Udp' or 'Tcp'.␊ - */␊ - protocol: (("Udp" | "Tcp") | string)␊ - /**␊ - * The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65534.␊ - */␊ - frontendPortRangeStart: (number | string)␊ - /**␊ - * The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65535.␊ - */␊ - frontendPortRangeEnd: (number | string)␊ - /**␊ - * The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound NAT pool of the load balancer.␊ - */␊ - export interface OutboundNatRule6 {␊ - properties?: (OutboundNatRulePropertiesFormat6 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound NAT pool of the load balancer.␊ - */␊ - export interface OutboundNatRulePropertiesFormat6 {␊ - /**␊ - * The number of outbound ports to be used for NAT.␊ - */␊ - allocatedOutboundPorts?: (number | string)␊ - /**␊ - * The Frontend IP addresses of the load balancer.␊ - */␊ - frontendIPConfigurations?: (SubResource12[] | string)␊ - /**␊ - * A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs.␊ - */␊ - backendAddressPool: (SubResource12 | string)␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/localNetworkGateways␊ - */␊ - export interface LocalNetworkGateways6 {␊ - name: string␊ - type: "Microsoft.Network/localNetworkGateways"␊ - apiVersion: "2015-06-15"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (LocalNetworkGatewayPropertiesFormat6 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * LocalNetworkGateway properties␊ - */␊ - export interface LocalNetworkGatewayPropertiesFormat6 {␊ - /**␊ - * Local network site address space.␊ - */␊ - localNetworkAddressSpace?: (AddressSpace14 | string)␊ - /**␊ - * IP address of local network gateway.␊ - */␊ - gatewayIpAddress?: string␊ - /**␊ - * Local network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings5 | string)␊ - /**␊ - * The resource GUID property of the LocalNetworkGateway resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Gets or sets Provisioning state of the LocalNetworkGateway resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.␊ - */␊ - export interface AddressSpace14 {␊ - /**␊ - * A list of address blocks reserved for this virtual network in CIDR notation.␊ - */␊ - addressPrefixes: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - export interface BgpSettings5 {␊ - /**␊ - * Gets or sets this BGP speaker's ASN␊ - */␊ - asn?: (number | string)␊ - /**␊ - * Gets or sets the BGP peering address and BGP identifier of this BGP speaker␊ - */␊ - bgpPeeringAddress?: string␊ - /**␊ - * Gets or sets the weight added to routes learned from this BGP speaker␊ - */␊ - peerWeight?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces␊ - */␊ - export interface NetworkInterfaces15 {␊ - name: string␊ - type: "Microsoft.Network/networkInterfaces"␊ - apiVersion: "2015-06-15"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (NetworkInterfacePropertiesFormat6 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NetworkInterface properties. ␊ - */␊ - export interface NetworkInterfacePropertiesFormat6 {␊ - /**␊ - * The reference of a virtual machine.␊ - */␊ - virtualMachine?: (SubResource12 | string)␊ - /**␊ - * The reference of the NetworkSecurityGroup resource.␊ - */␊ - networkSecurityGroup?: (SubResource12 | string)␊ - /**␊ - * A list of IPConfigurations of the network interface.␊ - */␊ - ipConfigurations: (NetworkInterfaceIPConfiguration5[] | string)␊ - /**␊ - * The DNS settings in network interface.␊ - */␊ - dnsSettings?: (NetworkInterfaceDnsSettings14 | string)␊ - /**␊ - * The MAC address of the network interface.␊ - */␊ - macAddress?: string␊ - /**␊ - * Gets whether this is a primary network interface on a virtual machine.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * Indicates whether IP forwarding is enabled on this network interface.␊ - */␊ - enableIPForwarding?: (boolean | string)␊ - /**␊ - * The resource GUID property of the network interface resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IPConfiguration in a network interface.␊ - */␊ - export interface NetworkInterfaceIPConfiguration5 {␊ - properties?: (NetworkInterfaceIPConfigurationPropertiesFormat5 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration.␊ - */␊ - export interface NetworkInterfaceIPConfigurationPropertiesFormat5 {␊ - /**␊ - * The reference of LoadBalancerBackendAddressPool resource.␊ - */␊ - loadBalancerBackendAddressPools?: (SubResource12[] | string)␊ - /**␊ - * A list of references of LoadBalancerInboundNatRules.␊ - */␊ - loadBalancerInboundNatRules?: (SubResource12[] | string)␊ - privateIPAddress?: string␊ - /**␊ - * Defines how a private IP address is assigned. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - subnet?: (SubResource12 | string)␊ - /**␊ - * Gets whether this is a primary customer address on the network interface.␊ - */␊ - primary?: (boolean | string)␊ - publicIPAddress?: (SubResource12 | string)␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DNS settings of a network interface.␊ - */␊ - export interface NetworkInterfaceDnsSettings14 {␊ - /**␊ - * List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only value in dnsServers collection.␊ - */␊ - dnsServers?: (string[] | string)␊ - /**␊ - * If the VM that uses this NIC is part of an Availability Set, then this list will have the union of all DNS servers from all NICs that are part of the Availability Set. This property is what is configured on each of those VMs.␊ - */␊ - appliedDnsServers?: (string[] | string)␊ - /**␊ - * Relative DNS name for this NIC used for internal communications between VMs in the same virtual network.␊ - */␊ - internalDnsNameLabel?: string␊ - /**␊ - * Fully qualified DNS name supporting internal communications between VMs in the same virtual network.␊ - */␊ - internalFqdn?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups␊ - */␊ - export interface NetworkSecurityGroups14 {␊ - name: string␊ - type: "Microsoft.Network/networkSecurityGroups"␊ - apiVersion: "2015-06-15"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (NetworkSecurityGroupPropertiesFormat6 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: NetworkSecurityGroupsSecurityRulesChildResource6[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network Security Group resource.␊ - */␊ - export interface NetworkSecurityGroupPropertiesFormat6 {␊ - /**␊ - * A collection of security rules of the network security group.␊ - */␊ - securityRules?: (SecurityRule6[] | string)␊ - /**␊ - * The default security rules of network security group.␊ - */␊ - defaultSecurityRules?: (SecurityRule6[] | string)␊ - /**␊ - * A collection of references to network interfaces.␊ - */␊ - networkInterfaces?: (SubResource12[] | string)␊ - /**␊ - * A collection of references to subnets.␊ - */␊ - subnets?: (SubResource12[] | string)␊ - /**␊ - * The resource GUID property of the network security group resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network security rule.␊ - */␊ - export interface SecurityRule6 {␊ - properties?: (SecurityRulePropertiesFormat6 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - export interface SecurityRulePropertiesFormat6 {␊ - /**␊ - * A description for this rule. Restricted to 140 chars.␊ - */␊ - description?: string␊ - /**␊ - * Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'.␊ - */␊ - protocol: (("Tcp" | "Udp" | "*") | string)␊ - /**␊ - * The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.␊ - */␊ - sourcePortRange?: string␊ - /**␊ - * The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.␊ - */␊ - destinationPortRange?: string␊ - /**␊ - * The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. ␊ - */␊ - sourceAddressPrefix: string␊ - /**␊ - * The destination address prefix. CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used.␊ - */␊ - destinationAddressPrefix: string␊ - /**␊ - * The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'.␊ - */␊ - access: (("Allow" | "Deny") | string)␊ - /**␊ - * The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.␊ - */␊ - priority: (number | string)␊ - /**␊ - * The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. Possible values are: 'Inbound' and 'Outbound'.␊ - */␊ - direction: (("Inbound" | "Outbound") | string)␊ - /**␊ - * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRulesChildResource6 {␊ - name: string␊ - type: "securityRules"␊ - apiVersion: "2015-06-15"␊ - properties: (SecurityRulePropertiesFormat6 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRules6 {␊ - name: string␊ - type: "Microsoft.Network/networkSecurityGroups/securityRules"␊ - apiVersion: "2015-06-15"␊ - properties: (SecurityRulePropertiesFormat6 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/publicIPAddresses␊ - */␊ - export interface PublicIPAddresses14 {␊ - name: string␊ - type: "Microsoft.Network/publicIPAddresses"␊ - apiVersion: "2015-06-15"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (PublicIPAddressPropertiesFormat5 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Public IP address properties.␊ - */␊ - export interface PublicIPAddressPropertiesFormat5 {␊ - /**␊ - * The public IP allocation method. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - publicIPAllocationMethod: (("Static" | "Dynamic") | string)␊ - ipConfiguration?: (SubResource12 | string)␊ - /**␊ - * The FQDN of the DNS record associated with the public IP address.␊ - */␊ - dnsSettings?: (PublicIPAddressDnsSettings13 | string)␊ - ipAddress?: string␊ - /**␊ - * The idle timeout of the public IP address.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * The resource GUID property of the public IP resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains FQDN of the DNS record associated with the public IP address␊ - */␊ - export interface PublicIPAddressDnsSettings13 {␊ - /**␊ - * Gets or sets the Domain name label.The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.␊ - */␊ - domainNameLabel: string␊ - /**␊ - * Gets the FQDN, Fully qualified domain name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone.␊ - */␊ - fqdn?: string␊ - /**␊ - * Gets or Sets the Reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN. ␊ - */␊ - reverseFqdn?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables␊ - */␊ - export interface RouteTables14 {␊ - name: string␊ - type: "Microsoft.Network/routeTables"␊ - apiVersion: "2015-06-15"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (RouteTablePropertiesFormat6 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: RouteTablesRoutesChildResource6[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Table resource␊ - */␊ - export interface RouteTablePropertiesFormat6 {␊ - /**␊ - * Collection of routes contained within a route table.␊ - */␊ - routes?: (Route6[] | string)␊ - /**␊ - * A collection of references to subnets.␊ - */␊ - subnets?: (SubResource12[] | string)␊ - /**␊ - * The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource␊ - */␊ - export interface Route6 {␊ - properties?: (RoutePropertiesFormat6 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource␊ - */␊ - export interface RoutePropertiesFormat6 {␊ - /**␊ - * The destination CIDR to which the route applies.␊ - */␊ - addressPrefix: string␊ - /**␊ - * The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'.␊ - */␊ - nextHopType: (("VirtualNetworkGateway" | "VnetLocal" | "Internet" | "VirtualAppliance" | "None" | "HyperNetGateway") | string)␊ - /**␊ - * The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.␊ - */␊ - nextHopIpAddress?: string␊ - /**␊ - * The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutesChildResource6 {␊ - name: string␊ - type: "routes"␊ - apiVersion: "2015-06-15"␊ - properties: (RoutePropertiesFormat6 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutes6 {␊ - name: string␊ - type: "Microsoft.Network/routeTables/routes"␊ - apiVersion: "2015-06-15"␊ - properties: (RoutePropertiesFormat6 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworkGateways␊ - */␊ - export interface VirtualNetworkGateways6 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworkGateways"␊ - apiVersion: "2015-06-15"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (VirtualNetworkGatewayPropertiesFormat6 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGateway properties␊ - */␊ - export interface VirtualNetworkGatewayPropertiesFormat6 {␊ - /**␊ - * IP configurations for virtual network gateway.␊ - */␊ - ipConfigurations?: (VirtualNetworkGatewayIPConfiguration5[] | string)␊ - /**␊ - * The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'.␊ - */␊ - gatewayType?: (("Vpn" | "ExpressRoute") | string)␊ - /**␊ - * The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'.␊ - */␊ - vpnType?: (("PolicyBased" | "RouteBased") | string)␊ - /**␊ - * Whether BGP is enabled for this virtual network gateway or not.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * The reference of the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting.␊ - */␊ - gatewayDefaultSite?: (SubResource12 | string)␊ - /**␊ - * The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.␊ - */␊ - sku?: (VirtualNetworkGatewaySku5 | string)␊ - /**␊ - * The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations.␊ - */␊ - vpnClientConfiguration?: (VpnClientConfiguration5 | string)␊ - /**␊ - * Virtual network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings5 | string)␊ - /**␊ - * The resource GUID property of the VirtualNetworkGateway resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration for virtual network gateway␊ - */␊ - export interface VirtualNetworkGatewayIPConfiguration5 {␊ - properties?: (VirtualNetworkGatewayIPConfigurationPropertiesFormat5 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of VirtualNetworkGatewayIPConfiguration␊ - */␊ - export interface VirtualNetworkGatewayIPConfigurationPropertiesFormat5 {␊ - /**␊ - * Gets or sets the privateIPAddress of the IP Configuration␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The private IP allocation method. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * The reference of the subnet resource.␊ - */␊ - subnet?: (SubResource12 | string)␊ - /**␊ - * The reference of the public IP resource.␊ - */␊ - publicIPAddress?: (SubResource12 | string)␊ - /**␊ - * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewaySku details␊ - */␊ - export interface VirtualNetworkGatewaySku5 {␊ - /**␊ - * Gateway sku name -Basic/HighPerformance/Standard.␊ - */␊ - name?: (("Basic" | "HighPerformance" | "Standard") | string)␊ - /**␊ - * Gateway sku tier -Basic/HighPerformance/Standard.␊ - */␊ - tier?: (("Basic" | "HighPerformance" | "Standard") | string)␊ - /**␊ - * The capacity␊ - */␊ - capacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnClientConfiguration for P2S client␊ - */␊ - export interface VpnClientConfiguration5 {␊ - /**␊ - * Gets or sets the reference of the Address space resource which represents Address space for P2S VpnClient.␊ - */␊ - vpnClientAddressPool?: (AddressSpace14 | string)␊ - /**␊ - * VpnClientRootCertificate for Virtual network gateway.␊ - */␊ - vpnClientRootCertificates?: (VpnClientRootCertificate5[] | string)␊ - /**␊ - * VpnClientRevokedCertificate for Virtual network gateway.␊ - */␊ - vpnClientRevokedCertificates?: (VpnClientRevokedCertificate5[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client root certificate of virtual network gateway␊ - */␊ - export interface VpnClientRootCertificate5 {␊ - properties?: (VpnClientRootCertificatePropertiesFormat5 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of application gateway␊ - */␊ - export interface VpnClientRootCertificatePropertiesFormat5 {␊ - /**␊ - * Gets or sets the certificate public data␊ - */␊ - publicCertData?: string␊ - /**␊ - * The provisioning state of the VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client revoked certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRevokedCertificate5 {␊ - properties?: (VpnClientRevokedCertificatePropertiesFormat5 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the revoked VPN client certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRevokedCertificatePropertiesFormat5 {␊ - /**␊ - * The revoked VPN client certificate thumbprint.␊ - */␊ - thumbprint?: string␊ - /**␊ - * The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks␊ - */␊ - export interface VirtualNetworks14 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks"␊ - apiVersion: "2015-06-15"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (VirtualNetworkPropertiesFormat6 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: VirtualNetworksSubnetsChildResource6[]␊ - [k: string]: unknown␊ - }␊ - export interface VirtualNetworkPropertiesFormat6 {␊ - /**␊ - * The AddressSpace that contains an array of IP address ranges that can be used by subnets.␊ - */␊ - addressSpace: (AddressSpace14 | string)␊ - /**␊ - * The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network.␊ - */␊ - dhcpOptions?: (DhcpOptions14 | string)␊ - /**␊ - * A list of subnets in a Virtual Network.␊ - */␊ - subnets?: (Subnet16[] | string)␊ - /**␊ - * The resourceGuid property of the Virtual Network resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DhcpOptions contains an array of DNS servers available to VMs deployed in the virtual network. Standard DHCP option for a subnet overrides VNET DHCP options.␊ - */␊ - export interface DhcpOptions14 {␊ - /**␊ - * The list of DNS servers IP addresses.␊ - */␊ - dnsServers: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Subnet in a virtual network resource.␊ - */␊ - export interface Subnet16 {␊ - properties?: (SubnetPropertiesFormat6 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - export interface SubnetPropertiesFormat6 {␊ - /**␊ - * The address prefix for the subnet.␊ - */␊ - addressPrefix: string␊ - /**␊ - * The reference of the NetworkSecurityGroup resource.␊ - */␊ - networkSecurityGroup?: (SubResource12 | string)␊ - /**␊ - * The reference of the RouteTable resource.␊ - */␊ - routeTable?: (SubResource12 | string)␊ - /**␊ - * Gets an array of references to the network interface IP configurations using subnet.␊ - */␊ - ipConfigurations?: (SubResource12[] | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnetsChildResource6 {␊ - name: string␊ - type: "subnets"␊ - apiVersion: "2015-06-15"␊ - properties: (SubnetPropertiesFormat6 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnets6 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks/subnets"␊ - apiVersion: "2015-06-15"␊ - properties: (SubnetPropertiesFormat6 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/applicationGateways␊ - */␊ - export interface ApplicationGateways7 {␊ - name: string␊ - type: "Microsoft.Network/applicationGateways"␊ - apiVersion: "2016-03-30"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (ApplicationGatewayPropertiesFormat7 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Application Gateway␊ - */␊ - export interface ApplicationGatewayPropertiesFormat7 {␊ - /**␊ - * Gets or sets sku of application gateway resource␊ - */␊ - sku?: (ApplicationGatewaySku7 | string)␊ - /**␊ - * Gets or sets subnets of application gateway resource␊ - */␊ - gatewayIPConfigurations?: (ApplicationGatewayIPConfiguration7[] | string)␊ - /**␊ - * Gets or sets ssl certificates of application gateway resource␊ - */␊ - sslCertificates?: (ApplicationGatewaySslCertificate7[] | string)␊ - /**␊ - * Gets or sets frontend IP addresses of application gateway resource␊ - */␊ - frontendIPConfigurations?: (ApplicationGatewayFrontendIPConfiguration7[] | string)␊ - /**␊ - * Gets or sets frontend ports of application gateway resource␊ - */␊ - frontendPorts?: (ApplicationGatewayFrontendPort7[] | string)␊ - /**␊ - * Gets or sets probes of application gateway resource␊ - */␊ - probes?: (ApplicationGatewayProbe6[] | string)␊ - /**␊ - * Gets or sets backend address pool of application gateway resource␊ - */␊ - backendAddressPools?: (ApplicationGatewayBackendAddressPool7[] | string)␊ - /**␊ - * Gets or sets backend http settings of application gateway resource␊ - */␊ - backendHttpSettingsCollection?: (ApplicationGatewayBackendHttpSettings7[] | string)␊ - /**␊ - * Gets or sets HTTP listeners of application gateway resource␊ - */␊ - httpListeners?: (ApplicationGatewayHttpListener7[] | string)␊ - /**␊ - * Gets or sets URL path map of application gateway resource␊ - */␊ - urlPathMaps?: (ApplicationGatewayUrlPathMap6[] | string)␊ - /**␊ - * Gets or sets request routing rules of application gateway resource␊ - */␊ - requestRoutingRules?: (ApplicationGatewayRequestRoutingRule7[] | string)␊ - /**␊ - * Gets or sets resource GUID property of the ApplicationGateway resource␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Gets or sets Provisioning state of the ApplicationGateway resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of application gateway␊ - */␊ - export interface ApplicationGatewaySku7 {␊ - /**␊ - * Gets or sets name of application gateway SKU.␊ - */␊ - name?: (("Standard_Small" | "Standard_Medium" | "Standard_Large") | string)␊ - /**␊ - * Gets or sets tier of application gateway.␊ - */␊ - tier?: ("Standard" | string)␊ - /**␊ - * Gets or sets capacity (instance count) of application gateway␊ - */␊ - capacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration of application gateway␊ - */␊ - export interface ApplicationGatewayIPConfiguration7 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties?: (ApplicationGatewayIPConfigurationPropertiesFormat7 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration of application gateway␊ - */␊ - export interface ApplicationGatewayIPConfigurationPropertiesFormat7 {␊ - /**␊ - * Gets or sets the reference of the subnet resource.A subnet from where application gateway gets its private address ␊ - */␊ - subnet?: (SubResource13 | string)␊ - /**␊ - * Gets or sets Provisioning state of the application gateway subnet resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - export interface SubResource13 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSL certificates of application gateway␊ - */␊ - export interface ApplicationGatewaySslCertificate7 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties?: (ApplicationGatewaySslCertificatePropertiesFormat7 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of application gateway␊ - */␊ - export interface ApplicationGatewaySslCertificatePropertiesFormat7 {␊ - /**␊ - * Gets or sets the certificate data ␊ - */␊ - data?: string␊ - /**␊ - * Gets or sets the certificate password ␊ - */␊ - password?: string␊ - /**␊ - * Gets or sets the certificate public data ␊ - */␊ - publicCertData?: string␊ - /**␊ - * Gets or sets Provisioning state of the ssl certificate resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP configuration of application gateway␊ - */␊ - export interface ApplicationGatewayFrontendIPConfiguration7 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties?: (ApplicationGatewayFrontendIPConfigurationPropertiesFormat7 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP configuration of application gateway␊ - */␊ - export interface ApplicationGatewayFrontendIPConfigurationPropertiesFormat7 {␊ - /**␊ - * Gets or sets the privateIPAddress of the Network Interface IP Configuration␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * Gets or sets PrivateIP allocation method (Static/Dynamic).␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Gets or sets the reference of the subnet resource␊ - */␊ - subnet?: (SubResource13 | string)␊ - /**␊ - * Gets or sets the reference of the PublicIP resource␊ - */␊ - publicIPAddress?: (SubResource13 | string)␊ - /**␊ - * Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend Port of application gateway␊ - */␊ - export interface ApplicationGatewayFrontendPort7 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties?: (ApplicationGatewayFrontendPortPropertiesFormat7 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend Port of application gateway␊ - */␊ - export interface ApplicationGatewayFrontendPortPropertiesFormat7 {␊ - /**␊ - * Gets or sets the frontend port␊ - */␊ - port?: (number | string)␊ - /**␊ - * Gets or sets Provisioning state of the frontend port resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Probe of application gateway␊ - */␊ - export interface ApplicationGatewayProbe6 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties?: (ApplicationGatewayProbePropertiesFormat6 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of probe of application gateway␊ - */␊ - export interface ApplicationGatewayProbePropertiesFormat6 {␊ - /**␊ - * Gets or sets the protocol.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Gets or sets the host to send probe to ␊ - */␊ - host?: string␊ - /**␊ - * Gets or sets the relative path of probe ␊ - */␊ - path?: string␊ - /**␊ - * Gets or sets probing interval in seconds ␊ - */␊ - interval?: (number | string)␊ - /**␊ - * Gets or sets probing timeout in seconds ␊ - */␊ - timeout?: (number | string)␊ - /**␊ - * Gets or sets probing unhealthy threshold ␊ - */␊ - unhealthyThreshold?: (number | string)␊ - /**␊ - * Gets or sets Provisioning state of the backend http settings resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend Address Pool of application gateway␊ - */␊ - export interface ApplicationGatewayBackendAddressPool7 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties?: (ApplicationGatewayBackendAddressPoolPropertiesFormat7 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend Address Pool of application gateway␊ - */␊ - export interface ApplicationGatewayBackendAddressPoolPropertiesFormat7 {␊ - /**␊ - * Gets collection of references to IPs defined in NICs␊ - */␊ - backendIPConfigurations?: (SubResource13[] | string)␊ - /**␊ - * Gets or sets the backend addresses␊ - */␊ - backendAddresses?: (ApplicationGatewayBackendAddress7[] | string)␊ - /**␊ - * Gets or sets Provisioning state of the backend address pool resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend Address of application gateway␊ - */␊ - export interface ApplicationGatewayBackendAddress7 {␊ - /**␊ - * Gets or sets the dns name␊ - */␊ - fqdn?: string␊ - /**␊ - * Gets or sets the ip address␊ - */␊ - ipAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address pool settings of application gateway␊ - */␊ - export interface ApplicationGatewayBackendHttpSettings7 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties?: (ApplicationGatewayBackendHttpSettingsPropertiesFormat7 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend address pool settings of application gateway␊ - */␊ - export interface ApplicationGatewayBackendHttpSettingsPropertiesFormat7 {␊ - /**␊ - * Gets or sets the port␊ - */␊ - port?: (number | string)␊ - /**␊ - * Gets or sets the protocol.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Gets or sets the cookie affinity.␊ - */␊ - cookieBasedAffinity?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Gets or sets request timeout␊ - */␊ - requestTimeout?: (number | string)␊ - /**␊ - * Gets or sets probe resource of application gateway ␊ - */␊ - probe?: (SubResource13 | string)␊ - /**␊ - * Gets or sets Provisioning state of the backend http settings resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http listener of application gateway␊ - */␊ - export interface ApplicationGatewayHttpListener7 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties?: (ApplicationGatewayHttpListenerPropertiesFormat7 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Http listener of application gateway␊ - */␊ - export interface ApplicationGatewayHttpListenerPropertiesFormat7 {␊ - /**␊ - * Gets or sets frontend IP configuration resource of application gateway ␊ - */␊ - frontendIPConfiguration?: (SubResource13 | string)␊ - /**␊ - * Gets or sets frontend port resource of application gateway ␊ - */␊ - frontendPort?: (SubResource13 | string)␊ - /**␊ - * Gets or sets the protocol.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Gets or sets the host name of http listener ␊ - */␊ - hostName?: string␊ - /**␊ - * Gets or sets ssl certificate resource of application gateway ␊ - */␊ - sslCertificate?: (SubResource13 | string)␊ - /**␊ - * Gets or sets the requireServerNameIndication of http listener ␊ - */␊ - requireServerNameIndication?: (boolean | string)␊ - /**␊ - * Gets or sets Provisioning state of the http listener resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * UrlPathMap of application gateway␊ - */␊ - export interface ApplicationGatewayUrlPathMap6 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties?: (ApplicationGatewayUrlPathMapPropertiesFormat6 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of probe of application gateway␊ - */␊ - export interface ApplicationGatewayUrlPathMapPropertiesFormat6 {␊ - /**␊ - * Gets or sets default backend address pool resource of URL path map ␊ - */␊ - defaultBackendAddressPool?: (SubResource13 | string)␊ - /**␊ - * Gets or sets default backend http settings resource of URL path map ␊ - */␊ - defaultBackendHttpSettings?: (SubResource13 | string)␊ - /**␊ - * Gets or sets path rule of URL path map resource␊ - */␊ - pathRules?: (ApplicationGatewayPathRule6[] | string)␊ - /**␊ - * Gets or sets Provisioning state of the backend http settings resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Path rule of URL path map of application gateway␊ - */␊ - export interface ApplicationGatewayPathRule6 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties?: (ApplicationGatewayPathRulePropertiesFormat6 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of probe of application gateway␊ - */␊ - export interface ApplicationGatewayPathRulePropertiesFormat6 {␊ - /**␊ - * Gets or sets the path rules of URL path map␊ - */␊ - paths?: (string[] | string)␊ - /**␊ - * Gets or sets backend address pool resource of URL path map ␊ - */␊ - backendAddressPool?: (SubResource13 | string)␊ - /**␊ - * Gets or sets backend http settings resource of URL path map ␊ - */␊ - backendHttpSettings?: (SubResource13 | string)␊ - /**␊ - * Gets or sets path rule of URL path map resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Request routing rule of application gateway␊ - */␊ - export interface ApplicationGatewayRequestRoutingRule7 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties?: (ApplicationGatewayRequestRoutingRulePropertiesFormat7 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Request routing rule of application gateway␊ - */␊ - export interface ApplicationGatewayRequestRoutingRulePropertiesFormat7 {␊ - /**␊ - * Gets or sets the rule type.␊ - */␊ - ruleType?: (("Basic" | "PathBasedRouting") | string)␊ - /**␊ - * Gets or sets backend address pool resource of application gateway ␊ - */␊ - backendAddressPool?: (SubResource13 | string)␊ - /**␊ - * Gets or sets frontend port resource of application gateway ␊ - */␊ - backendHttpSettings?: (SubResource13 | string)␊ - /**␊ - * Gets or sets http listener resource of application gateway ␊ - */␊ - httpListener?: (SubResource13 | string)␊ - /**␊ - * Gets or sets url path map resource of application gateway ␊ - */␊ - urlPathMap?: (SubResource13 | string)␊ - /**␊ - * Gets or sets Provisioning state of the request routing rule resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/connections␊ - */␊ - export interface Connections7 {␊ - name: string␊ - type: "Microsoft.Network/connections"␊ - apiVersion: "2016-03-30"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (VirtualNetworkGatewayConnectionPropertiesFormat7 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewayConnection properties␊ - */␊ - export interface VirtualNetworkGatewayConnectionPropertiesFormat7 {␊ - /**␊ - * The authorizationKey.␊ - */␊ - authorizationKey?: string␊ - virtualNetworkGateway1?: (SubResource13 | string)␊ - virtualNetworkGateway2?: (SubResource13 | string)␊ - localNetworkGateway2?: (SubResource13 | string)␊ - /**␊ - * Gateway connection type IPsec/Dedicated/VpnClient/Vnet2Vnet.␊ - */␊ - connectionType?: (("IPsec" | "Vnet2Vnet" | "ExpressRoute" | "VPNClient") | string)␊ - /**␊ - * The Routing weight.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * The IPsec share key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * Virtual network Gateway connection status.␊ - */␊ - connectionStatus?: (("Unknown" | "Connecting" | "Connected" | "NotConnected") | string)␊ - /**␊ - * The Egress Bytes Transferred in this connection␊ - */␊ - egressBytesTransferred?: (number | string)␊ - /**␊ - * The Ingress Bytes Transferred in this connection␊ - */␊ - ingressBytesTransferred?: (number | string)␊ - /**␊ - * The reference to peerings resource.␊ - */␊ - peer?: (SubResource13 | string)␊ - /**␊ - * EnableBgp Flag␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * Gets or sets resource GUID property of the VirtualNetworkGatewayConnection resource␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Gets or sets Provisioning state of the VirtualNetworkGatewayConnection resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits␊ - */␊ - export interface ExpressRouteCircuits1 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits"␊ - apiVersion: "2016-03-30"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Gets or sets sku␊ - */␊ - sku?: (ExpressRouteCircuitSku1 | string)␊ - properties: (ExpressRouteCircuitPropertiesFormat1 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - resources?: (ExpressRouteCircuitsPeeringsChildResource1 | ExpressRouteCircuitsAuthorizationsChildResource1)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains sku in an ExpressRouteCircuit␊ - */␊ - export interface ExpressRouteCircuitSku1 {␊ - /**␊ - * Gets or sets name of the sku.␊ - */␊ - name?: string␊ - /**␊ - * Gets or sets tier of the sku.␊ - */␊ - tier?: (("Standard" | "Premium") | string)␊ - /**␊ - * Gets or sets family of the sku.␊ - */␊ - family?: (("UnlimitedData" | "MeteredData") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ExpressRouteCircuit␊ - */␊ - export interface ExpressRouteCircuitPropertiesFormat1 {␊ - /**␊ - * allow classic operations␊ - */␊ - allowClassicOperations?: (boolean | string)␊ - /**␊ - * Gets or sets CircuitProvisioningState state of the resource ␊ - */␊ - circuitProvisioningState?: string␊ - /**␊ - * Gets or sets ServiceProviderProvisioningState state of the resource.␊ - */␊ - serviceProviderProvisioningState?: (("NotProvisioned" | "Provisioning" | "Provisioned" | "Deprovisioning") | string)␊ - /**␊ - * Gets or sets list of authorizations␊ - */␊ - authorizations?: (ExpressRouteCircuitAuthorization1[] | string)␊ - /**␊ - * Gets or sets list of peerings␊ - */␊ - peerings?: (ExpressRouteCircuitPeering1[] | string)␊ - /**␊ - * Gets or sets ServiceKey␊ - */␊ - serviceKey?: string␊ - /**␊ - * Gets or sets ServiceProviderNotes␊ - */␊ - serviceProviderNotes?: string␊ - /**␊ - * Gets or sets ServiceProviderProperties␊ - */␊ - serviceProviderProperties?: (ExpressRouteCircuitServiceProviderProperties1 | string)␊ - /**␊ - * Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authorization in a ExpressRouteCircuit resource␊ - */␊ - export interface ExpressRouteCircuitAuthorization1 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties?: (AuthorizationPropertiesFormat2 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - export interface AuthorizationPropertiesFormat2 {␊ - /**␊ - * Gets or sets the authorization key␊ - */␊ - authorizationKey?: string␊ - /**␊ - * Gets or sets AuthorizationUseStatus.␊ - */␊ - authorizationUseStatus?: (("Available" | "InUse") | string)␊ - /**␊ - * Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peering in a ExpressRouteCircuit resource␊ - */␊ - export interface ExpressRouteCircuitPeering1 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties?: (ExpressRouteCircuitPeeringPropertiesFormat2 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - export interface ExpressRouteCircuitPeeringPropertiesFormat2 {␊ - /**␊ - * Gets or sets PeeringType.␊ - */␊ - peeringType?: (("AzurePublicPeering" | "AzurePrivatePeering" | "MicrosoftPeering") | string)␊ - /**␊ - * Gets or sets state of Peering.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * Gets or sets the azure ASN␊ - */␊ - azureASN?: (number | string)␊ - /**␊ - * Gets or sets the peer ASN␊ - */␊ - peerASN?: (number | string)␊ - /**␊ - * Gets or sets the primary address prefix␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * Gets or sets the secondary address prefix␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * Gets or sets the primary port␊ - */␊ - primaryAzurePort?: string␊ - /**␊ - * Gets or sets the secondary port␊ - */␊ - secondaryAzurePort?: string␊ - /**␊ - * Gets or sets the shared key␊ - */␊ - sharedKey?: string␊ - /**␊ - * Gets or sets the vlan id␊ - */␊ - vlanId?: (number | string)␊ - /**␊ - * Gets or sets the Microsoft peering config␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig2 | string)␊ - /**␊ - * Gets or peering stats␊ - */␊ - stats?: (ExpressRouteCircuitStats2 | string)␊ - /**␊ - * Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the peering config␊ - */␊ - export interface ExpressRouteCircuitPeeringConfig2 {␊ - /**␊ - * Gets or sets the reference of AdvertisedPublicPrefixes␊ - */␊ - advertisedPublicPrefixes?: (string[] | string)␊ - /**␊ - * Gets or sets AdvertisedPublicPrefixState of the Peering resource.␊ - */␊ - advertisedPublicPrefixesState?: (("NotConfigured" | "Configuring" | "Configured" | "ValidationNeeded") | string)␊ - /**␊ - * Gets or Sets CustomerAsn of the peering.␊ - */␊ - customerASN?: (number | string)␊ - /**␊ - * Gets or Sets RoutingRegistryName of the config.␊ - */␊ - routingRegistryName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains Stats associated with the peering␊ - */␊ - export interface ExpressRouteCircuitStats2 {␊ - /**␊ - * Gets BytesIn of the peering.␊ - */␊ - primarybytesIn?: (number | string)␊ - /**␊ - * Gets BytesOut of the peering.␊ - */␊ - primarybytesOut?: (number | string)␊ - /**␊ - * Gets BytesIn of the peering.␊ - */␊ - secondarybytesIn?: (number | string)␊ - /**␊ - * Gets BytesOut of the peering.␊ - */␊ - secondarybytesOut?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains ServiceProviderProperties in an ExpressRouteCircuit␊ - */␊ - export interface ExpressRouteCircuitServiceProviderProperties1 {␊ - /**␊ - * Gets or sets serviceProviderName.␊ - */␊ - serviceProviderName?: string␊ - /**␊ - * Gets or sets peering location.␊ - */␊ - peeringLocation?: string␊ - /**␊ - * Gets or sets BandwidthInMbps.␊ - */␊ - bandwidthInMbps?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings␊ - */␊ - export interface ExpressRouteCircuitsPeeringsChildResource1 {␊ - name: string␊ - type: "peerings"␊ - apiVersion: "2016-03-30"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties: (ExpressRouteCircuitPeeringPropertiesFormat2 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/authorizations␊ - */␊ - export interface ExpressRouteCircuitsAuthorizationsChildResource1 {␊ - name: string␊ - type: "authorizations"␊ - apiVersion: "2016-03-30"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties: (AuthorizationPropertiesFormat2 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/authorizations␊ - */␊ - export interface ExpressRouteCircuitsAuthorizations2 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/authorizations"␊ - apiVersion: "2016-03-30"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties: (AuthorizationPropertiesFormat2 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings␊ - */␊ - export interface ExpressRouteCircuitsPeerings2 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/peerings"␊ - apiVersion: "2016-03-30"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties: (ExpressRouteCircuitPeeringPropertiesFormat2 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers␊ - */␊ - export interface LoadBalancers15 {␊ - name: string␊ - type: "Microsoft.Network/loadBalancers"␊ - apiVersion: "2016-03-30"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (LoadBalancerPropertiesFormat7 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Load Balancer␊ - */␊ - export interface LoadBalancerPropertiesFormat7 {␊ - /**␊ - * Gets or sets frontend IP addresses of the load balancer␊ - */␊ - frontendIPConfigurations?: (FrontendIPConfiguration6[] | string)␊ - /**␊ - * Gets or sets Pools of backend IP addresses␊ - */␊ - backendAddressPools?: (BackendAddressPool7[] | string)␊ - /**␊ - * Gets or sets load balancing rules␊ - */␊ - loadBalancingRules?: (LoadBalancingRule7[] | string)␊ - /**␊ - * Gets or sets list of Load balancer probes␊ - */␊ - probes?: (Probe7[] | string)␊ - /**␊ - * Gets or sets list of inbound rules␊ - */␊ - inboundNatRules?: (InboundNatRule8[] | string)␊ - /**␊ - * Gets or sets inbound NAT pools␊ - */␊ - inboundNatPools?: (InboundNatPool8[] | string)␊ - /**␊ - * Gets or sets outbound NAT rules␊ - */␊ - outboundNatRules?: (OutboundNatRule7[] | string)␊ - /**␊ - * Gets or sets resource GUID property of the Load balancer resource␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP address of the load balancer␊ - */␊ - export interface FrontendIPConfiguration6 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties?: (FrontendIPConfigurationPropertiesFormat6 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP Configuration of the load balancer␊ - */␊ - export interface FrontendIPConfigurationPropertiesFormat6 {␊ - /**␊ - * Read only.Inbound rules URIs that use this frontend IP␊ - */␊ - inboundNatRules?: (SubResource13[] | string)␊ - /**␊ - * Read only.Inbound pools URIs that use this frontend IP␊ - */␊ - inboundNatPools?: (SubResource13[] | string)␊ - /**␊ - * Read only.Outbound rules URIs that use this frontend IP␊ - */␊ - outboundNatRules?: (SubResource13[] | string)␊ - /**␊ - * Gets Load Balancing rules URIs that use this frontend IP␊ - */␊ - loadBalancingRules?: (SubResource13[] | string)␊ - /**␊ - * Gets or sets the privateIPAddress of the IP Configuration␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * Gets or sets PrivateIP allocation method (Static/Dynamic).␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Gets or sets the reference of the subnet resource␊ - */␊ - subnet?: (SubResource13 | string)␊ - /**␊ - * Gets or sets the reference of the PublicIP resource␊ - */␊ - publicIPAddress?: (SubResource13 | string)␊ - /**␊ - * Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Pool of backend IP addresses␊ - */␊ - export interface BackendAddressPool7 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties?: (BackendAddressPoolPropertiesFormat7 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of BackendAddressPool␊ - */␊ - export interface BackendAddressPoolPropertiesFormat7 {␊ - /**␊ - * Gets collection of references to IPs defined in NICs␊ - */␊ - backendIPConfigurations?: (SubResource13[] | string)␊ - /**␊ - * Gets Load Balancing rules that use this Backend Address Pool␊ - */␊ - loadBalancingRules?: (SubResource13[] | string)␊ - /**␊ - * Gets outbound rules that use this Backend Address Pool␊ - */␊ - outboundNatRule?: (SubResource13 | string)␊ - /**␊ - * Provisioning state of the PublicIP resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Rules of the load balancer␊ - */␊ - export interface LoadBalancingRule7 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties?: (LoadBalancingRulePropertiesFormat7 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer␊ - */␊ - export interface LoadBalancingRulePropertiesFormat7 {␊ - /**␊ - * Gets or sets a reference to frontend IP Addresses␊ - */␊ - frontendIPConfiguration: (SubResource13 | string)␊ - /**␊ - * Gets or sets a reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs␊ - */␊ - backendAddressPool?: (SubResource13 | string)␊ - /**␊ - * Gets or sets the reference of the load balancer probe used by the Load Balancing rule.␊ - */␊ - probe?: (SubResource13 | string)␊ - /**␊ - * Gets or sets the transport protocol for the external endpoint. Possible values are Udp or Tcp.␊ - */␊ - protocol: (("Udp" | "Tcp") | string)␊ - /**␊ - * Gets or sets the load distribution policy for this rule.␊ - */␊ - loadDistribution?: (("Default" | "SourceIP" | "SourceIPProtocol") | string)␊ - /**␊ - * Gets or sets the port for the external endpoint. You can specify any port number you choose, but the port numbers specified for each role in the service must be unique. Possible values range between 1 and 65535, inclusive␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * Gets or sets a port used for internal connections on the endpoint. The localPort attribute maps the eternal port of the endpoint to an internal port on a role. This is useful in scenarios where a role must communicate to an internal component on a port that is different from the one that is exposed externally. If not specified, the value of localPort is the same as the port attribute. Set the value of localPort to '*' to automatically assign an unallocated port that is discoverable using the runtime API␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * Gets or sets the timeout for the Tcp idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to Tcp␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn availability Group. This setting is required when using the SQL Always ON availability Groups in SQL server. This setting can't be changed after you create the endpoint␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Load balancer Probe␊ - */␊ - export interface Probe7 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties?: (ProbePropertiesFormat7 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - export interface ProbePropertiesFormat7 {␊ - /**␊ - * Gets Load balancer rules that use this probe␊ - */␊ - loadBalancingRules?: (SubResource13[] | string)␊ - /**␊ - * Gets or sets the protocol of the end point. Possible values are http pr Tcp. If Tcp is specified, a received ACK is required for the probe to be successful. If http is specified,a 200 OK response from the specifies URI is required for the probe to be successful.␊ - */␊ - protocol: (("Http" | "Tcp") | string)␊ - /**␊ - * Gets or sets Port for communicating the probe. Possible values range from 1 to 65535, inclusive.␊ - */␊ - port: (number | string)␊ - /**␊ - * Gets or sets the interval, in seconds, for how frequently to probe the endpoint for health status. Typically, the interval is slightly less than half the allocated timeout period (in seconds) which allows two full probes before taking the instance out of rotation. The default value is 15, the minimum value is 5␊ - */␊ - intervalInSeconds?: (number | string)␊ - /**␊ - * Gets or sets the number of probes where if no response, will result in stopping further traffic from being delivered to the endpoint. This values allows endpoints to be taken out of rotation faster or slower than the typical times used in Azure. ␊ - */␊ - numberOfProbes: (number | string)␊ - /**␊ - * Gets or sets the URI used for requesting health status from the VM. Path is required if a protocol is set to http. Otherwise, it is not allowed. There is no default value␊ - */␊ - requestPath?: string␊ - /**␊ - * Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT rule of the loadbalancer␊ - */␊ - export interface InboundNatRule8 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties?: (InboundNatRulePropertiesFormat7 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Inbound NAT rule␊ - */␊ - export interface InboundNatRulePropertiesFormat7 {␊ - /**␊ - * Gets or sets a reference to frontend IP Addresses␊ - */␊ - frontendIPConfiguration: (SubResource13 | string)␊ - /**␊ - * Gets or sets a reference to a private ip address defined on a NetworkInterface of a VM. Traffic sent to frontendPort of each of the frontendIPConfigurations is forwarded to the backed IP␊ - */␊ - backendIPConfiguration?: (SubResource13 | string)␊ - /**␊ - * Gets or sets the transport protocol for the external endpoint. Possible values are Udp or Tcp.␊ - */␊ - protocol: (("Udp" | "Tcp") | string)␊ - /**␊ - * Gets or sets the port for the external endpoint. You can specify any port number you choose, but the port numbers specified for each role in the service must be unique. Possible values range between 1 and 65535, inclusive␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * Gets or sets a port used for internal connections on the endpoint. The localPort attribute maps the eternal port of the endpoint to an internal port on a role. This is useful in scenarios where a role must communicate to an internal component on a port that is different from the one that is exposed externally. If not specified, the value of localPort is the same as the port attribute. Set the value of localPort to '*' to automatically assign an unallocated port that is discoverable using the runtime API␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * Gets or sets the timeout for the Tcp idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to Tcp␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn availability Group. This setting is required when using the SQL Always ON availability Groups in SQL server. This setting can't be changed after you create the endpoint␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT pool of the loadbalancer␊ - */␊ - export interface InboundNatPool8 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties?: (InboundNatPoolPropertiesFormat7 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Inbound NAT pool␊ - */␊ - export interface InboundNatPoolPropertiesFormat7 {␊ - /**␊ - * Gets or sets a reference to frontend IP Addresses␊ - */␊ - frontendIPConfiguration: (SubResource13 | string)␊ - /**␊ - * Gets or sets the transport protocol for the external endpoint. Possible values are Udp or Tcp.␊ - */␊ - protocol: (("Udp" | "Tcp") | string)␊ - /**␊ - * Gets or sets the starting port range for the NAT pool. You can specify any port number you choose, but the port numbers specified for each role in the service must be unique. Possible values range between 1 and 65535, inclusive␊ - */␊ - frontendPortRangeStart: (number | string)␊ - /**␊ - * Gets or sets the ending port range for the NAT pool. You can specify any port number you choose, but the port numbers specified for each role in the service must be unique. Possible values range between 1 and 65535, inclusive␊ - */␊ - frontendPortRangeEnd: (number | string)␊ - /**␊ - * Gets or sets a port used for internal connections on the endpoint. The localPort attribute maps the eternal port of the endpoint to an internal port on a role. This is useful in scenarios where a role must communicate to an internal component on a port that is different from the one that is exposed externally. If not specified, the value of localPort is the same as the port attribute. Set the value of localPort to '*' to automatically assign an unallocated port that is discoverable using the runtime API␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound NAT pool of the loadbalancer␊ - */␊ - export interface OutboundNatRule7 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties?: (OutboundNatRulePropertiesFormat7 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound NAT pool of the loadbalancer␊ - */␊ - export interface OutboundNatRulePropertiesFormat7 {␊ - /**␊ - * Gets or sets the number of outbound ports to be used for SNAT␊ - */␊ - allocatedOutboundPorts?: (number | string)␊ - /**␊ - * Gets or sets Frontend IP addresses of the load balancer␊ - */␊ - frontendIPConfigurations?: (SubResource13[] | string)␊ - /**␊ - * Gets or sets a reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs␊ - */␊ - backendAddressPool: (SubResource13 | string)␊ - /**␊ - * Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/localNetworkGateways␊ - */␊ - export interface LocalNetworkGateways7 {␊ - name: string␊ - type: "Microsoft.Network/localNetworkGateways"␊ - apiVersion: "2016-03-30"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (LocalNetworkGatewayPropertiesFormat7 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * LocalNetworkGateway properties␊ - */␊ - export interface LocalNetworkGatewayPropertiesFormat7 {␊ - /**␊ - * Local network site Address space␊ - */␊ - localNetworkAddressSpace?: (AddressSpace15 | string)␊ - /**␊ - * IP address of local network gateway.␊ - */␊ - gatewayIpAddress?: string␊ - /**␊ - * Local network gateway's BGP speaker settings␊ - */␊ - bgpSettings?: (BgpSettings6 | string)␊ - /**␊ - * Gets or sets resource GUID property of the LocalNetworkGateway resource␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Gets or sets Provisioning state of the LocalNetworkGateway resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AddressSpace contains an array of IP address ranges that can be used by subnets␊ - */␊ - export interface AddressSpace15 {␊ - /**␊ - * Gets or sets List of address blocks reserved for this virtual network in CIDR notation␊ - */␊ - addressPrefixes: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - export interface BgpSettings6 {␊ - /**␊ - * Gets or sets this BGP speaker's ASN␊ - */␊ - asn?: (number | string)␊ - /**␊ - * Gets or sets the BGP peering address and BGP identifier of this BGP speaker␊ - */␊ - bgpPeeringAddress?: string␊ - /**␊ - * Gets or sets the weight added to routes learned from this BGP speaker␊ - */␊ - peerWeight?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces␊ - */␊ - export interface NetworkInterfaces16 {␊ - name: string␊ - type: "Microsoft.Network/networkInterfaces"␊ - apiVersion: "2016-03-30"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (NetworkInterfacePropertiesFormat7 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NetworkInterface properties. ␊ - */␊ - export interface NetworkInterfacePropertiesFormat7 {␊ - /**␊ - * Gets or sets the reference of a VirtualMachine␊ - */␊ - virtualMachine?: (SubResource13 | string)␊ - /**␊ - * Gets or sets the reference of the NetworkSecurityGroup resource␊ - */␊ - networkSecurityGroup?: (SubResource13 | string)␊ - /**␊ - * Gets or sets list of IPConfigurations of the NetworkInterface␊ - */␊ - ipConfigurations: (NetworkInterfaceIPConfiguration6[] | string)␊ - /**␊ - * Gets or sets DNS Settings in NetworkInterface␊ - */␊ - dnsSettings?: (NetworkInterfaceDnsSettings15 | string)␊ - /**␊ - * Gets the MAC Address of the network interface␊ - */␊ - macAddress?: string␊ - /**␊ - * Gets whether this is a primary NIC on a virtual machine␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * Gets or sets whether IPForwarding is enabled on the NIC␊ - */␊ - enableIPForwarding?: (boolean | string)␊ - /**␊ - * Gets or sets resource GUID property of the network interface resource␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IPConfiguration in a NetworkInterface␊ - */␊ - export interface NetworkInterfaceIPConfiguration6 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties?: (NetworkInterfaceIPConfigurationPropertiesFormat6 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IPConfiguration␊ - */␊ - export interface NetworkInterfaceIPConfigurationPropertiesFormat6 {␊ - /**␊ - * Gets or sets the reference of ApplicationGatewayBackendAddressPool resource␊ - */␊ - applicationGatewayBackendAddressPools?: (SubResource13[] | string)␊ - /**␊ - * Gets or sets the reference of LoadBalancerBackendAddressPool resource␊ - */␊ - loadBalancerBackendAddressPools?: (SubResource13[] | string)␊ - /**␊ - * Gets or sets list of references of LoadBalancerInboundNatRules␊ - */␊ - loadBalancerInboundNatRules?: (SubResource13[] | string)␊ - privateIPAddress?: string␊ - /**␊ - * Gets or sets PrivateIP allocation method (Static/Dynamic).␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Gets or sets PrivateIP address version (IPv4/IPv6).␊ - */␊ - privateIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - subnet?: (SubResource13 | string)␊ - /**␊ - * Gets whether this is a primary customer address on the NIC␊ - */␊ - primary?: (boolean | string)␊ - publicIPAddress?: (SubResource13 | string)␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Dns Settings of a network interface␊ - */␊ - export interface NetworkInterfaceDnsSettings15 {␊ - /**␊ - * Gets or sets list of DNS servers IP addresses␊ - */␊ - dnsServers?: (string[] | string)␊ - /**␊ - * Gets or sets list of Applied DNS servers IP addresses␊ - */␊ - appliedDnsServers?: (string[] | string)␊ - /**␊ - * Gets or sets the Internal DNS name␊ - */␊ - internalDnsNameLabel?: string␊ - /**␊ - * Gets or sets the internal FQDN.␊ - */␊ - internalFqdn?: string␊ - /**␊ - * Gets or sets internal domain name suffix of the NIC.␊ - */␊ - internalDomainNameSuffix?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups␊ - */␊ - export interface NetworkSecurityGroups15 {␊ - name: string␊ - type: "Microsoft.Network/networkSecurityGroups"␊ - apiVersion: "2016-03-30"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (NetworkSecurityGroupPropertiesFormat7 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - resources?: NetworkSecurityGroupsSecurityRulesChildResource7[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network Security Group resource␊ - */␊ - export interface NetworkSecurityGroupPropertiesFormat7 {␊ - /**␊ - * Gets or sets Security rules of network security group␊ - */␊ - securityRules?: (SecurityRule7[] | string)␊ - /**␊ - * Gets or sets Default security rules of network security group␊ - */␊ - defaultSecurityRules?: (SecurityRule7[] | string)␊ - /**␊ - * Gets collection of references to Network Interfaces␊ - */␊ - networkInterfaces?: (SubResource13[] | string)␊ - /**␊ - * Gets collection of references to subnets␊ - */␊ - subnets?: (SubResource13[] | string)␊ - /**␊ - * Gets or sets resource GUID property of the network security group resource␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network security rule␊ - */␊ - export interface SecurityRule7 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties?: (SecurityRulePropertiesFormat7 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - export interface SecurityRulePropertiesFormat7 {␊ - /**␊ - * Gets or sets a description for this rule. Restricted to 140 chars.␊ - */␊ - description?: string␊ - /**␊ - * Gets or sets Network protocol this rule applies to. Can be Tcp, Udp or All(*).␊ - */␊ - protocol: (("Tcp" | "Udp" | "*") | string)␊ - /**␊ - * Gets or sets Source Port or Range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.␊ - */␊ - sourcePortRange?: string␊ - /**␊ - * Gets or sets Destination Port or Range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.␊ - */␊ - destinationPortRange?: string␊ - /**␊ - * Gets or sets source address prefix. CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. ␊ - */␊ - sourceAddressPrefix: string␊ - /**␊ - * Gets or sets destination address prefix. CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. ␊ - */␊ - destinationAddressPrefix: string␊ - /**␊ - * Gets or sets network traffic is allowed or denied. Possible values are 'Allow' and 'Deny'.␊ - */␊ - access: (("Allow" | "Deny") | string)␊ - /**␊ - * Gets or sets the priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.␊ - */␊ - priority: (number | string)␊ - /**␊ - * Gets or sets the direction of the rule.InBound or Outbound. The direction specifies if rule will be evaluated on incoming or outgoing traffic.␊ - */␊ - direction: (("Inbound" | "Outbound") | string)␊ - /**␊ - * Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRulesChildResource7 {␊ - name: string␊ - type: "securityRules"␊ - apiVersion: "2016-03-30"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties: (SecurityRulePropertiesFormat7 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRules7 {␊ - name: string␊ - type: "Microsoft.Network/networkSecurityGroups/securityRules"␊ - apiVersion: "2016-03-30"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties: (SecurityRulePropertiesFormat7 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/publicIPAddresses␊ - */␊ - export interface PublicIPAddresses15 {␊ - name: string␊ - type: "Microsoft.Network/publicIPAddresses"␊ - apiVersion: "2016-03-30"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (PublicIPAddressPropertiesFormat6 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * PublicIpAddress properties␊ - */␊ - export interface PublicIPAddressPropertiesFormat6 {␊ - /**␊ - * Gets or sets PublicIP allocation method (Static/Dynamic).␊ - */␊ - publicIPAllocationMethod: (("Static" | "Dynamic") | string)␊ - /**␊ - * Gets or sets PublicIP address version (IPv4/IPv6).␊ - */␊ - publicIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - ipConfiguration?: (SubResource13 | string)␊ - /**␊ - * Gets or sets FQDN of the DNS record associated with the public IP address␊ - */␊ - dnsSettings?: (PublicIPAddressDnsSettings14 | string)␊ - ipAddress?: string␊ - /**␊ - * Gets or sets the idle timeout of the public IP address␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Gets or sets resource GUID property of the PublicIP resource␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains FQDN of the DNS record associated with the public IP address␊ - */␊ - export interface PublicIPAddressDnsSettings14 {␊ - /**␊ - * Gets or sets the Domain name label.The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.␊ - */␊ - domainNameLabel: string␊ - /**␊ - * Gets the FQDN, Fully qualified domain name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone.␊ - */␊ - fqdn?: string␊ - /**␊ - * Gets or Sets the Reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN. ␊ - */␊ - reverseFqdn?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables␊ - */␊ - export interface RouteTables15 {␊ - name: string␊ - type: "Microsoft.Network/routeTables"␊ - apiVersion: "2016-03-30"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (RouteTablePropertiesFormat7 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - resources?: RouteTablesRoutesChildResource7[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Table resource␊ - */␊ - export interface RouteTablePropertiesFormat7 {␊ - /**␊ - * Gets or sets Routes in a Route Table␊ - */␊ - routes?: (Route7[] | string)␊ - /**␊ - * Gets collection of references to subnets␊ - */␊ - subnets?: (SubResource13[] | string)␊ - /**␊ - * Gets or sets Provisioning state of the resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource␊ - */␊ - export interface Route7 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties?: (RoutePropertiesFormat7 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource␊ - */␊ - export interface RoutePropertiesFormat7 {␊ - /**␊ - * Gets or sets the destination CIDR to which the route applies.␊ - */␊ - addressPrefix: string␊ - /**␊ - * Gets or sets the type of Azure hop the packet should be sent to.␊ - */␊ - nextHopType: (("VirtualNetworkGateway" | "VnetLocal" | "Internet" | "VirtualAppliance" | "None" | "HyperNetGateway") | string)␊ - /**␊ - * Gets or sets the IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.␊ - */␊ - nextHopIpAddress?: string␊ - /**␊ - * Gets or sets Provisioning state of the resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutesChildResource7 {␊ - name: string␊ - type: "routes"␊ - apiVersion: "2016-03-30"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties: (RoutePropertiesFormat7 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutes7 {␊ - name: string␊ - type: "Microsoft.Network/routeTables/routes"␊ - apiVersion: "2016-03-30"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties: (RoutePropertiesFormat7 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworkGateways␊ - */␊ - export interface VirtualNetworkGateways7 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworkGateways"␊ - apiVersion: "2016-03-30"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (VirtualNetworkGatewayPropertiesFormat7 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGateway properties␊ - */␊ - export interface VirtualNetworkGatewayPropertiesFormat7 {␊ - /**␊ - * IpConfigurations for Virtual network gateway.␊ - */␊ - ipConfigurations?: (VirtualNetworkGatewayIPConfiguration6[] | string)␊ - /**␊ - * The type of this virtual network gateway.␊ - */␊ - gatewayType?: (("Vpn" | "ExpressRoute") | string)␊ - /**␊ - * The type of this virtual network gateway.␊ - */␊ - vpnType?: (("PolicyBased" | "RouteBased") | string)␊ - /**␊ - * EnableBgp Flag␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * Gets or sets the reference of the LocalNetworkGateway resource which represents Local network site having default routes. Assign Null value in case of removing existing default site setting.␊ - */␊ - gatewayDefaultSite?: (SubResource13 | string)␊ - /**␊ - * Gets or sets the reference of the VirtualNetworkGatewaySku resource which represents the sku selected for Virtual network gateway.␊ - */␊ - sku?: (VirtualNetworkGatewaySku6 | string)␊ - /**␊ - * Gets or sets the reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations.␊ - */␊ - vpnClientConfiguration?: (VpnClientConfiguration6 | string)␊ - /**␊ - * Virtual network gateway's BGP speaker settings␊ - */␊ - bgpSettings?: (BgpSettings6 | string)␊ - /**␊ - * Gets or sets resource GUID property of the VirtualNetworkGateway resource␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Gets or sets Provisioning state of the VirtualNetworkGateway resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IpConfiguration for Virtual network gateway␊ - */␊ - export interface VirtualNetworkGatewayIPConfiguration6 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties?: (VirtualNetworkGatewayIPConfigurationPropertiesFormat6 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of VirtualNetworkGatewayIPConfiguration␊ - */␊ - export interface VirtualNetworkGatewayIPConfigurationPropertiesFormat6 {␊ - /**␊ - * Gets or sets the privateIPAddress of the IP Configuration␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * Gets or sets PrivateIP allocation method (Static/Dynamic).␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Gets or sets the reference of the subnet resource␊ - */␊ - subnet?: (SubResource13 | string)␊ - /**␊ - * Gets or sets the reference of the PublicIP resource␊ - */␊ - publicIPAddress?: (SubResource13 | string)␊ - /**␊ - * Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewaySku details␊ - */␊ - export interface VirtualNetworkGatewaySku6 {␊ - /**␊ - * Gateway sku name -Basic/HighPerformance/Standard.␊ - */␊ - name?: (("Basic" | "HighPerformance" | "Standard") | string)␊ - /**␊ - * Gateway sku tier -Basic/HighPerformance/Standard.␊ - */␊ - tier?: (("Basic" | "HighPerformance" | "Standard") | string)␊ - /**␊ - * The capacity␊ - */␊ - capacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnClientConfiguration for P2S client␊ - */␊ - export interface VpnClientConfiguration6 {␊ - /**␊ - * Gets or sets the reference of the Address space resource which represents Address space for P2S VpnClient.␊ - */␊ - vpnClientAddressPool?: (AddressSpace15 | string)␊ - /**␊ - * VpnClientRootCertificate for Virtual network gateway.␊ - */␊ - vpnClientRootCertificates?: (VpnClientRootCertificate6[] | string)␊ - /**␊ - * VpnClientRevokedCertificate for Virtual network gateway.␊ - */␊ - vpnClientRevokedCertificates?: (VpnClientRevokedCertificate6[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client root certificate of virtual network gateway␊ - */␊ - export interface VpnClientRootCertificate6 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties?: (VpnClientRootCertificatePropertiesFormat6 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of application gateway␊ - */␊ - export interface VpnClientRootCertificatePropertiesFormat6 {␊ - /**␊ - * Gets or sets the certificate public data␊ - */␊ - publicCertData?: string␊ - /**␊ - * Gets or sets Provisioning state of the VPN client root certificate resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client revoked certificate of virtual network gateway␊ - */␊ - export interface VpnClientRevokedCertificate6 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties?: (VpnClientRevokedCertificatePropertiesFormat6 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the revoked VPN client certificate of virtual network gateway␊ - */␊ - export interface VpnClientRevokedCertificatePropertiesFormat6 {␊ - /**␊ - * Gets or sets the revoked Vpn client certificate thumbprint␊ - */␊ - thumbprint?: string␊ - /**␊ - * Gets or sets Provisioning state of the VPN client revoked certificate resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks␊ - */␊ - export interface VirtualNetworks15 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks"␊ - apiVersion: "2016-03-30"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (VirtualNetworkPropertiesFormat7 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - resources?: VirtualNetworksSubnetsChildResource7[]␊ - [k: string]: unknown␊ - }␊ - export interface VirtualNetworkPropertiesFormat7 {␊ - /**␊ - * Gets or sets AddressSpace that contains an array of IP address ranges that can be used by subnets␊ - */␊ - addressSpace: (AddressSpace15 | string)␊ - /**␊ - * Gets or sets DHCPOptions that contains an array of DNS servers available to VMs deployed in the virtual network␊ - */␊ - dhcpOptions?: (DhcpOptions15 | string)␊ - /**␊ - * Gets or sets List of subnets in a VirtualNetwork␊ - */␊ - subnets?: (Subnet17[] | string)␊ - /**␊ - * Gets or sets resource GUID property of the VirtualNetwork resource␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DHCPOptions contains an array of DNS servers available to VMs deployed in the virtual networkStandard DHCP option for a subnet overrides VNET DHCP options.␊ - */␊ - export interface DhcpOptions15 {␊ - /**␊ - * Gets or sets list of DNS servers IP addresses␊ - */␊ - dnsServers: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Subnet in a VirtualNetwork resource␊ - */␊ - export interface Subnet17 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties?: (SubnetPropertiesFormat7 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - export interface SubnetPropertiesFormat7 {␊ - /**␊ - * Gets or sets Address prefix for the subnet.␊ - */␊ - addressPrefix: string␊ - /**␊ - * Gets or sets the reference of the NetworkSecurityGroup resource␊ - */␊ - networkSecurityGroup?: (SubResource13 | string)␊ - /**␊ - * Gets or sets the reference of the RouteTable resource␊ - */␊ - routeTable?: (SubResource13 | string)␊ - /**␊ - * Gets array of references to the network interface IP configurations using subnet␊ - */␊ - ipConfigurations?: (SubResource13[] | string)␊ - /**␊ - * Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnetsChildResource7 {␊ - name: string␊ - type: "subnets"␊ - apiVersion: "2016-03-30"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties: (SubnetPropertiesFormat7 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnets7 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks/subnets"␊ - apiVersion: "2016-03-30"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - properties: (SubnetPropertiesFormat7 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/applicationSecurityGroups␊ - */␊ - export interface ApplicationSecurityGroups {␊ - name: string␊ - type: "Microsoft.Network/applicationSecurityGroups"␊ - apiVersion: "2017-09-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the application security group.␊ - */␊ - properties: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/applicationSecurityGroups␊ - */␊ - export interface ApplicationSecurityGroups1 {␊ - name: string␊ - type: "Microsoft.Network/applicationSecurityGroups"␊ - apiVersion: "2017-10-01"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the application security group.␊ - */␊ - properties: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/applicationSecurityGroups␊ - */␊ - export interface ApplicationSecurityGroups2 {␊ - name: string␊ - type: "Microsoft.Network/applicationSecurityGroups"␊ - apiVersion: "2017-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the application security group.␊ - */␊ - properties: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/applicationSecurityGroups␊ - */␊ - export interface ApplicationSecurityGroups3 {␊ - name: string␊ - type: "Microsoft.Network/applicationSecurityGroups"␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the application security group.␊ - */␊ - properties: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/publicIPAddresses␊ - */␊ - export interface PublicIPAddresses16 {␊ - name: string␊ - type: "Microsoft.Network/publicIPAddresses"␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The public IP address SKU.␊ - */␊ - sku?: (PublicIPAddressSku4 | string)␊ - /**␊ - * Public IP address properties.␊ - */␊ - properties: (PublicIPAddressPropertiesFormat7 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a public IP address␊ - */␊ - export interface PublicIPAddressSku4 {␊ - /**␊ - * Name of a public IP address SKU.␊ - */␊ - name?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Public IP address properties.␊ - */␊ - export interface PublicIPAddressPropertiesFormat7 {␊ - /**␊ - * The public IP allocation method. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - publicIPAllocationMethod: (("Static" | "Dynamic") | string)␊ - /**␊ - * The public IP address version. Possible values are: 'IPv4' and 'IPv6'.␊ - */␊ - publicIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The FQDN of the DNS record associated with the public IP address.␊ - */␊ - dnsSettings?: (PublicIPAddressDnsSettings15 | string)␊ - /**␊ - * The list of tags associated with the public IP address.␊ - */␊ - ipTags?: (IpTag1[] | string)␊ - /**␊ - * The IP address associated with the public IP address resource.␊ - */␊ - ipAddress?: string␊ - /**␊ - * The idle timeout of the public IP address.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * The resource GUID property of the public IP resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains FQDN of the DNS record associated with the public IP address␊ - */␊ - export interface PublicIPAddressDnsSettings15 {␊ - /**␊ - * Gets or sets the Domain name label.The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.␊ - */␊ - domainNameLabel: string␊ - /**␊ - * Gets the FQDN, Fully qualified domain name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone.␊ - */␊ - fqdn?: string␊ - /**␊ - * Gets or Sets the Reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN. ␊ - */␊ - reverseFqdn?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains the IpTag associated with the public IP address␊ - */␊ - export interface IpTag1 {␊ - /**␊ - * Gets or sets the ipTag type: Example FirstPartyUsage.␊ - */␊ - ipTagType?: string␊ - /**␊ - * Gets or sets value of the IpTag associated with the public IP. Example SQL, Storage etc␊ - */␊ - tag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks␊ - */␊ - export interface VirtualNetworks16 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks"␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network.␊ - */␊ - properties: (VirtualNetworkPropertiesFormat8 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: (VirtualNetworksVirtualNetworkPeeringsChildResource5 | VirtualNetworksSubnetsChildResource8)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the virtual network.␊ - */␊ - export interface VirtualNetworkPropertiesFormat8 {␊ - /**␊ - * The AddressSpace that contains an array of IP address ranges that can be used by subnets.␊ - */␊ - addressSpace: (AddressSpace16 | string)␊ - /**␊ - * The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network.␊ - */␊ - dhcpOptions?: (DhcpOptions16 | string)␊ - /**␊ - * A list of subnets in a Virtual Network.␊ - */␊ - subnets?: (Subnet18[] | string)␊ - /**␊ - * A list of peerings in a Virtual Network.␊ - */␊ - virtualNetworkPeerings?: (VirtualNetworkPeering13[] | string)␊ - /**␊ - * The resourceGuid property of the Virtual Network resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - /**␊ - * Indicates if DDoS protection is enabled for all the protected resources in a Virtual Network.␊ - */␊ - enableDdosProtection?: (boolean | string)␊ - /**␊ - * Indicates if Vm protection is enabled for all the subnets in a Virtual Network.␊ - */␊ - enableVmProtection?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.␊ - */␊ - export interface AddressSpace16 {␊ - /**␊ - * A list of address blocks reserved for this virtual network in CIDR notation.␊ - */␊ - addressPrefixes: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DhcpOptions contains an array of DNS servers available to VMs deployed in the virtual network. Standard DHCP option for a subnet overrides VNET DHCP options.␊ - */␊ - export interface DhcpOptions16 {␊ - /**␊ - * The list of DNS servers IP addresses.␊ - */␊ - dnsServers: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Subnet in a virtual network resource.␊ - */␊ - export interface Subnet18 {␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties?: (SubnetPropertiesFormat8 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the subnet.␊ - */␊ - export interface SubnetPropertiesFormat8 {␊ - /**␊ - * The address prefix for the subnet.␊ - */␊ - addressPrefix: string␊ - /**␊ - * The reference of the NetworkSecurityGroup resource.␊ - */␊ - networkSecurityGroup?: (SubResource14 | string)␊ - /**␊ - * The reference of the RouteTable resource.␊ - */␊ - routeTable?: (SubResource14 | string)␊ - /**␊ - * An array of service endpoints.␊ - */␊ - serviceEndpoints?: (ServiceEndpointPropertiesFormat4[] | string)␊ - /**␊ - * Gets an array of references to the external resources using subnet.␊ - */␊ - resourceNavigationLinks?: (ResourceNavigationLink5[] | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Reference to another subresource.␊ - */␊ - export interface SubResource14 {␊ - /**␊ - * Resource ID.␊ - */␊ - id: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The service endpoint properties.␊ - */␊ - export interface ServiceEndpointPropertiesFormat4 {␊ - /**␊ - * The type of the endpoint service.␊ - */␊ - service?: string␊ - /**␊ - * A list of locations.␊ - */␊ - locations?: (string[] | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ResourceNavigationLink resource.␊ - */␊ - export interface ResourceNavigationLink5 {␊ - /**␊ - * Resource navigation link properties format.␊ - */␊ - properties?: (ResourceNavigationLinkFormat5 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ResourceNavigationLink.␊ - */␊ - export interface ResourceNavigationLinkFormat5 {␊ - /**␊ - * Resource type of the linked resource.␊ - */␊ - linkedResourceType?: string␊ - /**␊ - * Link to the external resource␊ - */␊ - link?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peerings in a virtual network resource.␊ - */␊ - export interface VirtualNetworkPeering13 {␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties?: (VirtualNetworkPeeringPropertiesFormat5 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - export interface VirtualNetworkPeeringPropertiesFormat5 {␊ - /**␊ - * Whether the VMs in the linked virtual network space would be able to access all the VMs in local Virtual network space.␊ - */␊ - allowVirtualNetworkAccess?: (boolean | string)␊ - /**␊ - * Whether the forwarded traffic from the VMs in the remote virtual network will be allowed/disallowed.␊ - */␊ - allowForwardedTraffic?: (boolean | string)␊ - /**␊ - * If gateway links can be used in remote virtual networking to link to this virtual network.␊ - */␊ - allowGatewayTransit?: (boolean | string)␊ - /**␊ - * If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway.␊ - */␊ - useRemoteGateways?: (boolean | string)␊ - /**␊ - * The reference of the remote virtual network. The remote virtual network can be in the same or different region (preview). See here to register for the preview and learn more (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering).␊ - */␊ - remoteVirtualNetwork: (SubResource14 | string)␊ - /**␊ - * The reference of the remote virtual network address space.␊ - */␊ - remoteAddressSpace?: (AddressSpace16 | string)␊ - /**␊ - * The status of the virtual network peering. Possible values are 'Initiated', 'Connected', and 'Disconnected'.␊ - */␊ - peeringState?: (("Initiated" | "Connected" | "Disconnected") | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/virtualNetworkPeerings␊ - */␊ - export interface VirtualNetworksVirtualNetworkPeeringsChildResource5 {␊ - name: string␊ - type: "virtualNetworkPeerings"␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties: (VirtualNetworkPeeringPropertiesFormat5 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnetsChildResource8 {␊ - name: string␊ - type: "subnets"␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties: (SubnetPropertiesFormat8 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers␊ - */␊ - export interface LoadBalancers16 {␊ - name: string␊ - type: "Microsoft.Network/loadBalancers"␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The load balancer SKU.␊ - */␊ - sku?: (LoadBalancerSku4 | string)␊ - /**␊ - * Properties of load balancer.␊ - */␊ - properties: (LoadBalancerPropertiesFormat8 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: LoadBalancersInboundNatRulesChildResource4[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a load balancer␊ - */␊ - export interface LoadBalancerSku4 {␊ - /**␊ - * Name of a load balancer SKU.␊ - */␊ - name?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer.␊ - */␊ - export interface LoadBalancerPropertiesFormat8 {␊ - /**␊ - * Object representing the frontend IPs to be used for the load balancer␊ - */␊ - frontendIPConfigurations?: (FrontendIPConfiguration7[] | string)␊ - /**␊ - * Collection of backend address pools used by a load balancer␊ - */␊ - backendAddressPools?: (BackendAddressPool8[] | string)␊ - /**␊ - * Object collection representing the load balancing rules Gets the provisioning ␊ - */␊ - loadBalancingRules?: (LoadBalancingRule8[] | string)␊ - /**␊ - * Collection of probe objects used in the load balancer␊ - */␊ - probes?: (Probe8[] | string)␊ - /**␊ - * Collection of inbound NAT Rules used by a load balancer. Defining inbound NAT rules on your load balancer is mutually exclusive with defining an inbound NAT pool. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an Inbound NAT pool. They have to reference individual inbound NAT rules.␊ - */␊ - inboundNatRules?: (InboundNatRule9[] | string)␊ - /**␊ - * Defines an external port range for inbound NAT to a single backend port on NICs associated with a load balancer. Inbound NAT rules are created automatically for each NIC associated with the Load Balancer using an external port from this range. Defining an Inbound NAT pool on your Load Balancer is mutually exclusive with defining inbound Nat rules. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an inbound NAT pool. They have to reference individual inbound NAT rules.␊ - */␊ - inboundNatPools?: (InboundNatPool9[] | string)␊ - /**␊ - * The outbound NAT rules.␊ - */␊ - outboundNatRules?: (OutboundNatRule8[] | string)␊ - /**␊ - * The resource GUID property of the load balancer resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP address of the load balancer.␊ - */␊ - export interface FrontendIPConfiguration7 {␊ - /**␊ - * Properties of the load balancer probe.␊ - */␊ - properties?: (FrontendIPConfigurationPropertiesFormat7 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP Configuration of the load balancer.␊ - */␊ - export interface FrontendIPConfigurationPropertiesFormat7 {␊ - /**␊ - * The private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The Private IP allocation method. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * The reference of the subnet resource.␊ - */␊ - subnet?: (SubResource14 | string)␊ - /**␊ - * The reference of the Public IP resource.␊ - */␊ - publicIPAddress?: (SubResource14 | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Pool of backend IP addresses.␊ - */␊ - export interface BackendAddressPool8 {␊ - /**␊ - * Properties of load balancer backend address pool.␊ - */␊ - properties?: (BackendAddressPoolPropertiesFormat8 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the backend address pool.␊ - */␊ - export interface BackendAddressPoolPropertiesFormat8 {␊ - /**␊ - * Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A load balancing rule for a load balancer.␊ - */␊ - export interface LoadBalancingRule8 {␊ - /**␊ - * Properties of load balancer load balancing rule.␊ - */␊ - properties?: (LoadBalancingRulePropertiesFormat8 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer.␊ - */␊ - export interface LoadBalancingRulePropertiesFormat8 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource14 | string)␊ - /**␊ - * A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs.␊ - */␊ - backendAddressPool?: (SubResource14 | string)␊ - /**␊ - * The reference of the load balancer probe used by the load balancing rule.␊ - */␊ - probe?: (SubResource14 | string)␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'.␊ - */␊ - loadDistribution?: (("Default" | "SourceIP" | "SourceIPProtocol") | string)␊ - /**␊ - * The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 0 and 65534. Note that value 0 enables "Any Port"␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port"␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule.␊ - */␊ - disableOutboundSnat?: (boolean | string)␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A load balancer probe.␊ - */␊ - export interface Probe8 {␊ - /**␊ - * Properties of load balancer probe.␊ - */␊ - properties?: (ProbePropertiesFormat8 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Load balancer probe resource.␊ - */␊ - export interface ProbePropertiesFormat8 {␊ - /**␊ - * The protocol of the end point. Possible values are: 'Http' or 'Tcp'. If 'Tcp' is specified, a received ACK is required for the probe to be successful. If 'Http' is specified, a 200 OK response from the specifies URI is required for the probe to be successful.␊ - */␊ - protocol: (("Http" | "Tcp") | string)␊ - /**␊ - * The port for communicating the probe. Possible values range from 1 to 65535, inclusive.␊ - */␊ - port: (number | string)␊ - /**␊ - * The interval, in seconds, for how frequently to probe the endpoint for health status. Typically, the interval is slightly less than half the allocated timeout period (in seconds) which allows two full probes before taking the instance out of rotation. The default value is 15, the minimum value is 5.␊ - */␊ - intervalInSeconds?: (number | string)␊ - /**␊ - * The number of probes where if no response, will result in stopping further traffic from being delivered to the endpoint. This values allows endpoints to be taken out of rotation faster or slower than the typical times used in Azure.␊ - */␊ - numberOfProbes: (number | string)␊ - /**␊ - * The URI used for requesting health status from the VM. Path is required if a protocol is set to http. Otherwise, it is not allowed. There is no default value.␊ - */␊ - requestPath?: string␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT rule of the load balancer.␊ - */␊ - export interface InboundNatRule9 {␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties?: (InboundNatRulePropertiesFormat8 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the inbound NAT rule.␊ - */␊ - export interface InboundNatRulePropertiesFormat8 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource14 | string)␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values range from 1 to 65534.␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * The port used for the internal endpoint. Acceptable values range from 1 to 65535.␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT pool of the load balancer.␊ - */␊ - export interface InboundNatPool9 {␊ - /**␊ - * Properties of load balancer inbound nat pool.␊ - */␊ - properties?: (InboundNatPoolPropertiesFormat8 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Inbound NAT pool.␊ - */␊ - export interface InboundNatPoolPropertiesFormat8 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource14 | string)␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65534.␊ - */␊ - frontendPortRangeStart: (number | string)␊ - /**␊ - * The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65535.␊ - */␊ - frontendPortRangeEnd: (number | string)␊ - /**␊ - * The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound NAT pool of the load balancer.␊ - */␊ - export interface OutboundNatRule8 {␊ - /**␊ - * Properties of load balancer outbound nat rule.␊ - */␊ - properties?: (OutboundNatRulePropertiesFormat8 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound NAT pool of the load balancer.␊ - */␊ - export interface OutboundNatRulePropertiesFormat8 {␊ - /**␊ - * The number of outbound ports to be used for NAT.␊ - */␊ - allocatedOutboundPorts?: (number | string)␊ - /**␊ - * The Frontend IP addresses of the load balancer.␊ - */␊ - frontendIPConfigurations?: (SubResource14[] | string)␊ - /**␊ - * A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs.␊ - */␊ - backendAddressPool: (SubResource14 | string)␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers/inboundNatRules␊ - */␊ - export interface LoadBalancersInboundNatRulesChildResource4 {␊ - name: string␊ - type: "inboundNatRules"␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties: (InboundNatRulePropertiesFormat8 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups␊ - */␊ - export interface NetworkSecurityGroups16 {␊ - name: string␊ - type: "Microsoft.Network/networkSecurityGroups"␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network security group␊ - */␊ - properties: (NetworkSecurityGroupPropertiesFormat8 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: NetworkSecurityGroupsSecurityRulesChildResource8[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network Security Group resource.␊ - */␊ - export interface NetworkSecurityGroupPropertiesFormat8 {␊ - /**␊ - * A collection of security rules of the network security group.␊ - */␊ - securityRules?: (SecurityRule8[] | string)␊ - /**␊ - * The default security rules of network security group.␊ - */␊ - defaultSecurityRules?: (SecurityRule8[] | string)␊ - /**␊ - * The resource GUID property of the network security group resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network security rule.␊ - */␊ - export interface SecurityRule8 {␊ - /**␊ - * Properties of the security rule␊ - */␊ - properties?: (SecurityRulePropertiesFormat8 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Security rule resource.␊ - */␊ - export interface SecurityRulePropertiesFormat8 {␊ - /**␊ - * A description for this rule. Restricted to 140 chars.␊ - */␊ - description?: string␊ - /**␊ - * Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'.␊ - */␊ - protocol: (("Tcp" | "Udp" | "*") | string)␊ - /**␊ - * The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports.␊ - */␊ - sourcePortRange?: string␊ - /**␊ - * The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports.␊ - */␊ - destinationPortRange?: string␊ - /**␊ - * The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. ␊ - */␊ - sourceAddressPrefix?: string␊ - /**␊ - * The CIDR or source IP ranges.␊ - */␊ - sourceAddressPrefixes?: (string[] | string)␊ - /**␊ - * The application security group specified as source.␊ - */␊ - sourceApplicationSecurityGroups?: (ApplicationSecurityGroup3[] | string)␊ - /**␊ - * The destination address prefix. CIDR or destination IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used.␊ - */␊ - destinationAddressPrefix?: string␊ - /**␊ - * The destination address prefixes. CIDR or destination IP ranges.␊ - */␊ - destinationAddressPrefixes?: (string[] | string)␊ - /**␊ - * The application security group specified as destination.␊ - */␊ - destinationApplicationSecurityGroups?: (ApplicationSecurityGroup3[] | string)␊ - /**␊ - * The source port ranges.␊ - */␊ - sourcePortRanges?: (string[] | string)␊ - /**␊ - * The destination port ranges.␊ - */␊ - destinationPortRanges?: (string[] | string)␊ - /**␊ - * The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'.␊ - */␊ - access: (("Allow" | "Deny") | string)␊ - /**␊ - * The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.␊ - */␊ - priority: (number | string)␊ - /**␊ - * The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'.␊ - */␊ - direction: (("Inbound" | "Outbound") | string)␊ - /**␊ - * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An application security group in a resource group.␊ - */␊ - export interface ApplicationSecurityGroup3 {␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the application security group.␊ - */␊ - properties?: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRulesChildResource8 {␊ - name: string␊ - type: "securityRules"␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Properties of the security rule␊ - */␊ - properties: (SecurityRulePropertiesFormat8 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces␊ - */␊ - export interface NetworkInterfaces17 {␊ - name: string␊ - type: "Microsoft.Network/networkInterfaces"␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network interface.␊ - */␊ - properties: (NetworkInterfacePropertiesFormat8 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NetworkInterface properties. ␊ - */␊ - export interface NetworkInterfacePropertiesFormat8 {␊ - /**␊ - * The reference of the NetworkSecurityGroup resource.␊ - */␊ - networkSecurityGroup?: (SubResource14 | string)␊ - /**␊ - * A list of IPConfigurations of the network interface.␊ - */␊ - ipConfigurations: (NetworkInterfaceIPConfiguration7[] | string)␊ - /**␊ - * The DNS settings in network interface.␊ - */␊ - dnsSettings?: (NetworkInterfaceDnsSettings16 | string)␊ - /**␊ - * The MAC address of the network interface.␊ - */␊ - macAddress?: string␊ - /**␊ - * Gets whether this is a primary network interface on a virtual machine.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * If the network interface is accelerated networking enabled.␊ - */␊ - enableAcceleratedNetworking?: (boolean | string)␊ - /**␊ - * Indicates whether IP forwarding is enabled on this network interface.␊ - */␊ - enableIPForwarding?: (boolean | string)␊ - /**␊ - * The resource GUID property of the network interface resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IPConfiguration in a network interface.␊ - */␊ - export interface NetworkInterfaceIPConfiguration7 {␊ - /**␊ - * Network interface IP configuration properties.␊ - */␊ - properties?: (NetworkInterfaceIPConfigurationPropertiesFormat7 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration.␊ - */␊ - export interface NetworkInterfaceIPConfigurationPropertiesFormat7 {␊ - /**␊ - * The reference of ApplicationGatewayBackendAddressPool resource.␊ - */␊ - applicationGatewayBackendAddressPools?: (SubResource14[] | string)␊ - /**␊ - * The reference of LoadBalancerBackendAddressPool resource.␊ - */␊ - loadBalancerBackendAddressPools?: (SubResource14[] | string)␊ - /**␊ - * A list of references of LoadBalancerInboundNatRules.␊ - */␊ - loadBalancerInboundNatRules?: (SubResource14[] | string)␊ - /**␊ - * Private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * Defines how a private IP address is assigned. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Available from Api-Version 2016-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.␊ - */␊ - privateIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * Subnet bound to the IP configuration.␊ - */␊ - subnet?: (SubResource14 | string)␊ - /**␊ - * Gets whether this is a primary customer address on the network interface.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * Public IP address bound to the IP configuration.␊ - */␊ - publicIPAddress?: (SubResource14 | string)␊ - /**␊ - * Application security groups in which the IP configuration is included.␊ - */␊ - applicationSecurityGroups?: (SubResource14[] | string)␊ - /**␊ - * The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DNS settings of a network interface.␊ - */␊ - export interface NetworkInterfaceDnsSettings16 {␊ - /**␊ - * List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only value in dnsServers collection.␊ - */␊ - dnsServers?: (string[] | string)␊ - /**␊ - * If the VM that uses this NIC is part of an Availability Set, then this list will have the union of all DNS servers from all NICs that are part of the Availability Set. This property is what is configured on each of those VMs.␊ - */␊ - appliedDnsServers?: (string[] | string)␊ - /**␊ - * Relative DNS name for this NIC used for internal communications between VMs in the same virtual network.␊ - */␊ - internalDnsNameLabel?: string␊ - /**␊ - * Fully qualified DNS name supporting internal communications between VMs in the same virtual network.␊ - */␊ - internalFqdn?: string␊ - /**␊ - * Even if internalDnsNameLabel is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internalDomainNameSuffix.␊ - */␊ - internalDomainNameSuffix?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables␊ - */␊ - export interface RouteTables16 {␊ - name: string␊ - type: "Microsoft.Network/routeTables"␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the route table.␊ - */␊ - properties: (RouteTablePropertiesFormat8 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: RouteTablesRoutesChildResource8[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Table resource␊ - */␊ - export interface RouteTablePropertiesFormat8 {␊ - /**␊ - * Collection of routes contained within a route table.␊ - */␊ - routes?: (Route8[] | string)␊ - /**␊ - * Gets or sets whether to disable the routes learned by BGP on that route table. True means disable.␊ - */␊ - disableBgpRoutePropagation?: (boolean | string)␊ - /**␊ - * The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource␊ - */␊ - export interface Route8 {␊ - /**␊ - * Properties of the route.␊ - */␊ - properties?: (RoutePropertiesFormat8 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource␊ - */␊ - export interface RoutePropertiesFormat8 {␊ - /**␊ - * The destination CIDR to which the route applies.␊ - */␊ - addressPrefix: string␊ - /**␊ - * The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'.␊ - */␊ - nextHopType: (("VirtualNetworkGateway" | "VnetLocal" | "Internet" | "VirtualAppliance" | "None") | string)␊ - /**␊ - * The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.␊ - */␊ - nextHopIpAddress?: string␊ - /**␊ - * The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutesChildResource8 {␊ - name: string␊ - type: "routes"␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Properties of the route.␊ - */␊ - properties: (RoutePropertiesFormat8 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/applicationGateways␊ - */␊ - export interface ApplicationGateways8 {␊ - name: string␊ - type: "Microsoft.Network/applicationGateways"␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (ApplicationGatewayPropertiesFormat8 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application gateway.␊ - */␊ - export interface ApplicationGatewayPropertiesFormat8 {␊ - /**␊ - * SKU of the application gateway resource.␊ - */␊ - sku?: (ApplicationGatewaySku8 | string)␊ - /**␊ - * SSL policy of the application gateway resource.␊ - */␊ - sslPolicy?: (ApplicationGatewaySslPolicy5 | string)␊ - /**␊ - * Subnets of application the gateway resource.␊ - */␊ - gatewayIPConfigurations?: (ApplicationGatewayIPConfiguration8[] | string)␊ - /**␊ - * Authentication certificates of the application gateway resource.␊ - */␊ - authenticationCertificates?: (ApplicationGatewayAuthenticationCertificate5[] | string)␊ - /**␊ - * SSL certificates of the application gateway resource.␊ - */␊ - sslCertificates?: (ApplicationGatewaySslCertificate8[] | string)␊ - /**␊ - * Frontend IP addresses of the application gateway resource.␊ - */␊ - frontendIPConfigurations?: (ApplicationGatewayFrontendIPConfiguration8[] | string)␊ - /**␊ - * Frontend ports of the application gateway resource.␊ - */␊ - frontendPorts?: (ApplicationGatewayFrontendPort8[] | string)␊ - /**␊ - * Probes of the application gateway resource.␊ - */␊ - probes?: (ApplicationGatewayProbe7[] | string)␊ - /**␊ - * Backend address pool of the application gateway resource.␊ - */␊ - backendAddressPools?: (ApplicationGatewayBackendAddressPool8[] | string)␊ - /**␊ - * Backend http settings of the application gateway resource.␊ - */␊ - backendHttpSettingsCollection?: (ApplicationGatewayBackendHttpSettings8[] | string)␊ - /**␊ - * Http listeners of the application gateway resource.␊ - */␊ - httpListeners?: (ApplicationGatewayHttpListener8[] | string)␊ - /**␊ - * URL path map of the application gateway resource.␊ - */␊ - urlPathMaps?: (ApplicationGatewayUrlPathMap7[] | string)␊ - /**␊ - * Request routing rules of the application gateway resource.␊ - */␊ - requestRoutingRules?: (ApplicationGatewayRequestRoutingRule8[] | string)␊ - /**␊ - * Redirect configurations of the application gateway resource.␊ - */␊ - redirectConfigurations?: (ApplicationGatewayRedirectConfiguration5[] | string)␊ - /**␊ - * Web application firewall configuration.␊ - */␊ - webApplicationFirewallConfiguration?: (ApplicationGatewayWebApplicationFirewallConfiguration5 | string)␊ - /**␊ - * Whether HTTP2 is enabled on the application gateway resource.␊ - */␊ - enableHttp2?: (boolean | string)␊ - /**␊ - * Resource GUID property of the application gateway resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of an application gateway␊ - */␊ - export interface ApplicationGatewaySku8 {␊ - /**␊ - * Name of an application gateway SKU.␊ - */␊ - name?: (("Standard_Small" | "Standard_Medium" | "Standard_Large" | "WAF_Medium" | "WAF_Large") | string)␊ - /**␊ - * Tier of an application gateway.␊ - */␊ - tier?: (("Standard" | "WAF") | string)␊ - /**␊ - * Capacity (instance count) of an application gateway.␊ - */␊ - capacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application Gateway Ssl policy.␊ - */␊ - export interface ApplicationGatewaySslPolicy5 {␊ - /**␊ - * Ssl protocols to be disabled on application gateway.␊ - */␊ - disabledSslProtocols?: (("TLSv1_0" | "TLSv1_1" | "TLSv1_2")[] | string)␊ - /**␊ - * Type of Ssl Policy.␊ - */␊ - policyType?: (("Predefined" | "Custom") | string)␊ - /**␊ - * Name of Ssl predefined policy.␊ - */␊ - policyName?: (("AppGwSslPolicy20150501" | "AppGwSslPolicy20170401" | "AppGwSslPolicy20170401S") | string)␊ - /**␊ - * Ssl cipher suites to be enabled in the specified order to application gateway.␊ - */␊ - cipherSuites?: (("TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384" | "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256" | "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA" | "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA" | "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384" | "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256" | "TLS_DHE_RSA_WITH_AES_256_CBC_SHA" | "TLS_DHE_RSA_WITH_AES_128_CBC_SHA" | "TLS_RSA_WITH_AES_256_GCM_SHA384" | "TLS_RSA_WITH_AES_128_GCM_SHA256" | "TLS_RSA_WITH_AES_256_CBC_SHA256" | "TLS_RSA_WITH_AES_128_CBC_SHA256" | "TLS_RSA_WITH_AES_256_CBC_SHA" | "TLS_RSA_WITH_AES_128_CBC_SHA" | "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384" | "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256" | "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384" | "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256" | "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA" | "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA" | "TLS_DHE_DSS_WITH_AES_256_CBC_SHA256" | "TLS_DHE_DSS_WITH_AES_128_CBC_SHA256" | "TLS_DHE_DSS_WITH_AES_256_CBC_SHA" | "TLS_DHE_DSS_WITH_AES_128_CBC_SHA" | "TLS_RSA_WITH_3DES_EDE_CBC_SHA" | "TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA" | "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256" | "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384")[] | string)␊ - /**␊ - * Minimum version of Ssl protocol to be supported on application gateway.␊ - */␊ - minProtocolVersion?: (("TLSv1_0" | "TLSv1_1" | "TLSv1_2") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed.␊ - */␊ - export interface ApplicationGatewayIPConfiguration8 {␊ - properties?: (ApplicationGatewayIPConfigurationPropertiesFormat8 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayIPConfigurationPropertiesFormat8 {␊ - /**␊ - * Reference of the subnet resource. A subnet from where application gateway gets its private address.␊ - */␊ - subnet?: (SubResource14 | string)␊ - /**␊ - * Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authentication certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewayAuthenticationCertificate5 {␊ - properties?: (ApplicationGatewayAuthenticationCertificatePropertiesFormat5 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authentication certificates properties of an application gateway.␊ - */␊ - export interface ApplicationGatewayAuthenticationCertificatePropertiesFormat5 {␊ - /**␊ - * Certificate public data.␊ - */␊ - data?: string␊ - /**␊ - * Provisioning state of the authentication certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSL certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewaySslCertificate8 {␊ - properties?: (ApplicationGatewaySslCertificatePropertiesFormat8 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewaySslCertificatePropertiesFormat8 {␊ - /**␊ - * Base-64 encoded pfx certificate. Only applicable in PUT Request.␊ - */␊ - data?: string␊ - /**␊ - * Password for the pfx file specified in data. Only applicable in PUT request.␊ - */␊ - password?: string␊ - /**␊ - * Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request.␊ - */␊ - publicCertData?: string␊ - /**␊ - * Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendIPConfiguration8 {␊ - properties?: (ApplicationGatewayFrontendIPConfigurationPropertiesFormat8 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendIPConfigurationPropertiesFormat8 {␊ - /**␊ - * PrivateIPAddress of the network interface IP Configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * PrivateIP allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Reference of the subnet resource.␊ - */␊ - subnet?: (SubResource14 | string)␊ - /**␊ - * Reference of the PublicIP resource.␊ - */␊ - publicIPAddress?: (SubResource14 | string)␊ - /**␊ - * Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend port of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendPort8 {␊ - properties?: (ApplicationGatewayFrontendPortPropertiesFormat8 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend port of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendPortPropertiesFormat8 {␊ - /**␊ - * Frontend port␊ - */␊ - port?: (number | string)␊ - /**␊ - * Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Probe of the application gateway.␊ - */␊ - export interface ApplicationGatewayProbe7 {␊ - properties?: (ApplicationGatewayProbePropertiesFormat7 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of probe of an application gateway.␊ - */␊ - export interface ApplicationGatewayProbePropertiesFormat7 {␊ - /**␊ - * Protocol.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Host name to send the probe to.␊ - */␊ - host?: string␊ - /**␊ - * Relative path of probe. Valid path starts from '/'. Probe is sent to ://:␊ - */␊ - path?: string␊ - /**␊ - * The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - interval?: (number | string)␊ - /**␊ - * the probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - timeout?: (number | string)␊ - /**␊ - * The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20.␊ - */␊ - unhealthyThreshold?: (number | string)␊ - /**␊ - * Whether the host header should be picked from the backend http settings. Default value is false.␊ - */␊ - pickHostNameFromBackendHttpSettings?: (boolean | string)␊ - /**␊ - * Minimum number of servers that are always marked healthy. Default value is 0.␊ - */␊ - minServers?: (number | string)␊ - /**␊ - * Criterion for classifying a healthy probe response.␊ - */␊ - match?: (ApplicationGatewayProbeHealthResponseMatch5 | string)␊ - /**␊ - * Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application gateway probe health response match␊ - */␊ - export interface ApplicationGatewayProbeHealthResponseMatch5 {␊ - /**␊ - * Body that must be contained in the health response. Default value is empty.␊ - */␊ - body?: string␊ - /**␊ - * Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399.␊ - */␊ - statusCodes?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend Address Pool of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddressPool8 {␊ - properties?: (ApplicationGatewayBackendAddressPoolPropertiesFormat8 | string)␊ - /**␊ - * Resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend Address Pool of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddressPoolPropertiesFormat8 {␊ - /**␊ - * Collection of references to IPs defined in network interfaces.␊ - */␊ - backendIPConfigurations?: (SubResource14[] | string)␊ - /**␊ - * Backend addresses␊ - */␊ - backendAddresses?: (ApplicationGatewayBackendAddress8[] | string)␊ - /**␊ - * Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddress8 {␊ - /**␊ - * Fully qualified domain name (FQDN).␊ - */␊ - fqdn?: string␊ - /**␊ - * IP address␊ - */␊ - ipAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address pool settings of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendHttpSettings8 {␊ - properties?: (ApplicationGatewayBackendHttpSettingsPropertiesFormat8 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend address pool settings of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendHttpSettingsPropertiesFormat8 {␊ - /**␊ - * Port␊ - */␊ - port?: (number | string)␊ - /**␊ - * Protocol.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Cookie based affinity.␊ - */␊ - cookieBasedAffinity?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Request timeout in seconds. Application Gateway will fail the request if response is not received within RequestTimeout. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - requestTimeout?: (number | string)␊ - /**␊ - * Probe resource of an application gateway.␊ - */␊ - probe?: (SubResource14 | string)␊ - /**␊ - * Array of references to application gateway authentication certificates.␊ - */␊ - authenticationCertificates?: (SubResource14[] | string)␊ - /**␊ - * Connection draining of the backend http settings resource.␊ - */␊ - connectionDraining?: (ApplicationGatewayConnectionDraining5 | string)␊ - /**␊ - * Host header to be sent to the backend servers.␊ - */␊ - hostName?: string␊ - /**␊ - * Whether to pick host header should be picked from the host name of the backend server. Default value is false.␊ - */␊ - pickHostNameFromBackendAddress?: (boolean | string)␊ - /**␊ - * Cookie name to use for the affinity cookie.␊ - */␊ - affinityCookieName?: string␊ - /**␊ - * Whether the probe is enabled. Default value is false.␊ - */␊ - probeEnabled?: (boolean | string)␊ - /**␊ - * Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null.␊ - */␊ - path?: string␊ - /**␊ - * Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Connection draining allows open connections to a backend server to be active for a specified time after the backend server got removed from the configuration.␊ - */␊ - export interface ApplicationGatewayConnectionDraining5 {␊ - /**␊ - * Whether connection draining is enabled or not.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds.␊ - */␊ - drainTimeoutInSec: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http listener of an application gateway.␊ - */␊ - export interface ApplicationGatewayHttpListener8 {␊ - properties?: (ApplicationGatewayHttpListenerPropertiesFormat8 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of HTTP listener of an application gateway.␊ - */␊ - export interface ApplicationGatewayHttpListenerPropertiesFormat8 {␊ - /**␊ - * Frontend IP configuration resource of an application gateway.␊ - */␊ - frontendIPConfiguration?: (SubResource14 | string)␊ - /**␊ - * Frontend port resource of an application gateway.␊ - */␊ - frontendPort?: (SubResource14 | string)␊ - /**␊ - * Protocol.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Host name of HTTP listener.␊ - */␊ - hostName?: string␊ - /**␊ - * SSL certificate resource of an application gateway.␊ - */␊ - sslCertificate?: (SubResource14 | string)␊ - /**␊ - * Applicable only if protocol is https. Enables SNI for multi-hosting.␊ - */␊ - requireServerNameIndication?: (boolean | string)␊ - /**␊ - * Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * UrlPathMaps give a url path to the backend mapping information for PathBasedRouting.␊ - */␊ - export interface ApplicationGatewayUrlPathMap7 {␊ - properties?: (ApplicationGatewayUrlPathMapPropertiesFormat7 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of UrlPathMap of the application gateway.␊ - */␊ - export interface ApplicationGatewayUrlPathMapPropertiesFormat7 {␊ - /**␊ - * Default backend address pool resource of URL path map.␊ - */␊ - defaultBackendAddressPool?: (SubResource14 | string)␊ - /**␊ - * Default backend http settings resource of URL path map.␊ - */␊ - defaultBackendHttpSettings?: (SubResource14 | string)␊ - /**␊ - * Default redirect configuration resource of URL path map.␊ - */␊ - defaultRedirectConfiguration?: (SubResource14 | string)␊ - /**␊ - * Path rule of URL path map resource.␊ - */␊ - pathRules?: (ApplicationGatewayPathRule7[] | string)␊ - /**␊ - * Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Path rule of URL path map of an application gateway.␊ - */␊ - export interface ApplicationGatewayPathRule7 {␊ - properties?: (ApplicationGatewayPathRulePropertiesFormat7 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of path rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayPathRulePropertiesFormat7 {␊ - /**␊ - * Path rules of URL path map.␊ - */␊ - paths?: (string[] | string)␊ - /**␊ - * Backend address pool resource of URL path map path rule.␊ - */␊ - backendAddressPool?: (SubResource14 | string)␊ - /**␊ - * Backend http settings resource of URL path map path rule.␊ - */␊ - backendHttpSettings?: (SubResource14 | string)␊ - /**␊ - * Redirect configuration resource of URL path map path rule.␊ - */␊ - redirectConfiguration?: (SubResource14 | string)␊ - /**␊ - * Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Request routing rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayRequestRoutingRule8 {␊ - properties?: (ApplicationGatewayRequestRoutingRulePropertiesFormat8 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of request routing rule of the application gateway.␊ - */␊ - export interface ApplicationGatewayRequestRoutingRulePropertiesFormat8 {␊ - /**␊ - * Rule type.␊ - */␊ - ruleType?: (("Basic" | "PathBasedRouting") | string)␊ - /**␊ - * Backend address pool resource of the application gateway. ␊ - */␊ - backendAddressPool?: (SubResource14 | string)␊ - /**␊ - * Frontend port resource of the application gateway.␊ - */␊ - backendHttpSettings?: (SubResource14 | string)␊ - /**␊ - * Http listener resource of the application gateway. ␊ - */␊ - httpListener?: (SubResource14 | string)␊ - /**␊ - * URL path map resource of the application gateway.␊ - */␊ - urlPathMap?: (SubResource14 | string)␊ - /**␊ - * Redirect configuration resource of the application gateway.␊ - */␊ - redirectConfiguration?: (SubResource14 | string)␊ - /**␊ - * Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Redirect configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayRedirectConfiguration5 {␊ - properties?: (ApplicationGatewayRedirectConfigurationPropertiesFormat5 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of redirect configuration of the application gateway.␊ - */␊ - export interface ApplicationGatewayRedirectConfigurationPropertiesFormat5 {␊ - /**␊ - * Supported http redirection types - Permanent, Temporary, Found, SeeOther.␊ - */␊ - redirectType?: (("Permanent" | "Found" | "SeeOther" | "Temporary") | string)␊ - /**␊ - * Reference to a listener to redirect the request to.␊ - */␊ - targetListener?: (SubResource14 | string)␊ - /**␊ - * Url to redirect the request to.␊ - */␊ - targetUrl?: string␊ - /**␊ - * Include path in the redirected url.␊ - */␊ - includePath?: (boolean | string)␊ - /**␊ - * Include query string in the redirected url.␊ - */␊ - includeQueryString?: (boolean | string)␊ - /**␊ - * Request routing specifying redirect configuration.␊ - */␊ - requestRoutingRules?: (SubResource14[] | string)␊ - /**␊ - * Url path maps specifying default redirect configuration.␊ - */␊ - urlPathMaps?: (SubResource14[] | string)␊ - /**␊ - * Path rules specifying redirect configuration.␊ - */␊ - pathRules?: (SubResource14[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application gateway web application firewall configuration.␊ - */␊ - export interface ApplicationGatewayWebApplicationFirewallConfiguration5 {␊ - /**␊ - * Whether the web application firewall is enabled or not.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * Web application firewall mode.␊ - */␊ - firewallMode: (("Detection" | "Prevention") | string)␊ - /**␊ - * The type of the web application firewall rule set. Possible values are: 'OWASP'.␊ - */␊ - ruleSetType: string␊ - /**␊ - * The version of the rule set type.␊ - */␊ - ruleSetVersion: string␊ - /**␊ - * The disabled rule groups.␊ - */␊ - disabledRuleGroups?: (ApplicationGatewayFirewallDisabledRuleGroup5[] | string)␊ - /**␊ - * Whether allow WAF to check request Body.␊ - */␊ - requestBodyCheck?: (boolean | string)␊ - /**␊ - * Maxium request body size for WAF.␊ - */␊ - maxRequestBodySize?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allows to disable rules within a rule group or an entire rule group.␊ - */␊ - export interface ApplicationGatewayFirewallDisabledRuleGroup5 {␊ - /**␊ - * The name of the rule group that will be disabled.␊ - */␊ - ruleGroupName: string␊ - /**␊ - * The list of rules that will be disabled. If null, all rules of the rule group will be disabled.␊ - */␊ - rules?: (number[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/connections␊ - */␊ - export interface Connections8 {␊ - name: string␊ - type: "Microsoft.Network/connections"␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway connection.␊ - */␊ - properties: (VirtualNetworkGatewayConnectionPropertiesFormat8 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewayConnection properties␊ - */␊ - export interface VirtualNetworkGatewayConnectionPropertiesFormat8 {␊ - /**␊ - * The authorizationKey.␊ - */␊ - authorizationKey?: string␊ - /**␊ - * The reference to virtual network gateway resource.␊ - */␊ - virtualNetworkGateway1: (VirtualNetworkGateway5 | SubResource14 | string)␊ - /**␊ - * The reference to virtual network gateway resource.␊ - */␊ - virtualNetworkGateway2?: (VirtualNetworkGateway5 | SubResource14 | string)␊ - /**␊ - * The reference to local network gateway resource.␊ - */␊ - localNetworkGateway2?: (LocalNetworkGateway5 | SubResource14 | string)␊ - /**␊ - * Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.␊ - */␊ - connectionType: (("IPsec" | "Vnet2Vnet" | "ExpressRoute" | "VPNClient") | string)␊ - /**␊ - * The routing weight.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * The IPSec shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The reference to peerings resource.␊ - */␊ - peer?: (SubResource14 | string)␊ - /**␊ - * EnableBgp flag␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * Enable policy-based traffic selectors.␊ - */␊ - usePolicyBasedTrafficSelectors?: (boolean | string)␊ - /**␊ - * The IPSec Policies to be considered by this connection.␊ - */␊ - ipsecPolicies?: (IpsecPolicy5[] | string)␊ - /**␊ - * The resource GUID property of the VirtualNetworkGatewayConnection resource.␊ - */␊ - resourceGuid?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A common class for general resource information␊ - */␊ - export interface VirtualNetworkGateway5 {␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway.␊ - */␊ - properties: (VirtualNetworkGatewayPropertiesFormat8 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGateway properties␊ - */␊ - export interface VirtualNetworkGatewayPropertiesFormat8 {␊ - /**␊ - * IP configurations for virtual network gateway.␊ - */␊ - ipConfigurations?: (VirtualNetworkGatewayIPConfiguration7[] | string)␊ - /**␊ - * The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'.␊ - */␊ - gatewayType?: (("Vpn" | "ExpressRoute") | string)␊ - /**␊ - * The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'.␊ - */␊ - vpnType?: (("PolicyBased" | "RouteBased") | string)␊ - /**␊ - * Whether BGP is enabled for this virtual network gateway or not.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * ActiveActive flag␊ - */␊ - activeActive?: (boolean | string)␊ - /**␊ - * The reference of the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting.␊ - */␊ - gatewayDefaultSite?: (SubResource14 | string)␊ - /**␊ - * The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.␊ - */␊ - sku?: (VirtualNetworkGatewaySku7 | string)␊ - /**␊ - * The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations.␊ - */␊ - vpnClientConfiguration?: (VpnClientConfiguration7 | string)␊ - /**␊ - * Virtual network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings7 | string)␊ - /**␊ - * The resource GUID property of the VirtualNetworkGateway resource.␊ - */␊ - resourceGuid?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration for virtual network gateway␊ - */␊ - export interface VirtualNetworkGatewayIPConfiguration7 {␊ - /**␊ - * Properties of the virtual network gateway ip configuration.␊ - */␊ - properties?: (VirtualNetworkGatewayIPConfigurationPropertiesFormat7 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of VirtualNetworkGatewayIPConfiguration␊ - */␊ - export interface VirtualNetworkGatewayIPConfigurationPropertiesFormat7 {␊ - /**␊ - * The private IP allocation method. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * The reference of the subnet resource.␊ - */␊ - subnet?: (SubResource14 | string)␊ - /**␊ - * The reference of the public IP resource.␊ - */␊ - publicIPAddress?: (SubResource14 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewaySku details␊ - */␊ - export interface VirtualNetworkGatewaySku7 {␊ - /**␊ - * Gateway SKU name.␊ - */␊ - name?: (("Basic" | "HighPerformance" | "Standard" | "UltraPerformance" | "VpnGw1" | "VpnGw2" | "VpnGw3") | string)␊ - /**␊ - * Gateway SKU tier.␊ - */␊ - tier?: (("Basic" | "HighPerformance" | "Standard" | "UltraPerformance" | "VpnGw1" | "VpnGw2" | "VpnGw3") | string)␊ - /**␊ - * The capacity.␊ - */␊ - capacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnClientConfiguration for P2S client.␊ - */␊ - export interface VpnClientConfiguration7 {␊ - /**␊ - * The reference of the address space resource which represents Address space for P2S VpnClient.␊ - */␊ - vpnClientAddressPool?: (AddressSpace16 | string)␊ - /**␊ - * VpnClientRootCertificate for virtual network gateway.␊ - */␊ - vpnClientRootCertificates?: (VpnClientRootCertificate7[] | string)␊ - /**␊ - * VpnClientRevokedCertificate for Virtual network gateway.␊ - */␊ - vpnClientRevokedCertificates?: (VpnClientRevokedCertificate7[] | string)␊ - /**␊ - * VpnClientProtocols for Virtual network gateway.␊ - */␊ - vpnClientProtocols?: (("IkeV2" | "SSTP")[] | string)␊ - /**␊ - * The radius server address property of the VirtualNetworkGateway resource for vpn client connection.␊ - */␊ - radiusServerAddress?: string␊ - /**␊ - * The radius secret property of the VirtualNetworkGateway resource for vpn client connection.␊ - */␊ - radiusServerSecret?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client root certificate of virtual network gateway␊ - */␊ - export interface VpnClientRootCertificate7 {␊ - /**␊ - * Properties of the vpn client root certificate.␊ - */␊ - properties: (VpnClientRootCertificatePropertiesFormat7 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of application gateway␊ - */␊ - export interface VpnClientRootCertificatePropertiesFormat7 {␊ - /**␊ - * The certificate public data.␊ - */␊ - publicCertData: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client revoked certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRevokedCertificate7 {␊ - /**␊ - * Properties of the vpn client revoked certificate.␊ - */␊ - properties?: (VpnClientRevokedCertificatePropertiesFormat7 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the revoked VPN client certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRevokedCertificatePropertiesFormat7 {␊ - /**␊ - * The revoked VPN client certificate thumbprint.␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * BGP settings details␊ - */␊ - export interface BgpSettings7 {␊ - /**␊ - * The BGP speaker's ASN.␊ - */␊ - asn?: (number | string)␊ - /**␊ - * The BGP peering address and BGP identifier of this BGP speaker.␊ - */␊ - bgpPeeringAddress?: string␊ - /**␊ - * The weight added to routes learned from this BGP speaker.␊ - */␊ - peerWeight?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A common class for general resource information␊ - */␊ - export interface LocalNetworkGateway5 {␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the local network gateway.␊ - */␊ - properties: (LocalNetworkGatewayPropertiesFormat8 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * LocalNetworkGateway properties␊ - */␊ - export interface LocalNetworkGatewayPropertiesFormat8 {␊ - /**␊ - * Local network site address space.␊ - */␊ - localNetworkAddressSpace?: (AddressSpace16 | string)␊ - /**␊ - * IP address of local network gateway.␊ - */␊ - gatewayIpAddress?: string␊ - /**␊ - * Local network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings7 | string)␊ - /**␊ - * The resource GUID property of the LocalNetworkGateway resource.␊ - */␊ - resourceGuid?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An IPSec Policy configuration for a virtual network gateway connection␊ - */␊ - export interface IpsecPolicy5 {␊ - /**␊ - * The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.␊ - */␊ - saLifeTimeSeconds: (number | string)␊ - /**␊ - * The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.␊ - */␊ - saDataSizeKilobytes: (number | string)␊ - /**␊ - * The IPSec encryption algorithm (IKE phase 1).␊ - */␊ - ipsecEncryption: (("None" | "DES" | "DES3" | "AES128" | "AES192" | "AES256" | "GCMAES128" | "GCMAES192" | "GCMAES256") | string)␊ - /**␊ - * The IPSec integrity algorithm (IKE phase 1).␊ - */␊ - ipsecIntegrity: (("MD5" | "SHA1" | "SHA256" | "GCMAES128" | "GCMAES192" | "GCMAES256") | string)␊ - /**␊ - * The IKE encryption algorithm (IKE phase 2).␊ - */␊ - ikeEncryption: (("DES" | "DES3" | "AES128" | "AES192" | "AES256") | string)␊ - /**␊ - * The IKE integrity algorithm (IKE phase 2).␊ - */␊ - ikeIntegrity: (("MD5" | "SHA1" | "SHA256" | "SHA384") | string)␊ - /**␊ - * The DH Groups used in IKE Phase 1 for initial SA.␊ - */␊ - dhGroup: (("None" | "DHGroup1" | "DHGroup2" | "DHGroup14" | "DHGroup2048" | "ECP256" | "ECP384" | "DHGroup24") | string)␊ - /**␊ - * The DH Groups used in IKE Phase 2 for new child SA.␊ - */␊ - pfsGroup: (("None" | "PFS1" | "PFS2" | "PFS2048" | "ECP256" | "ECP384" | "PFS24") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/localNetworkGateways␊ - */␊ - export interface LocalNetworkGateways8 {␊ - name: string␊ - type: "Microsoft.Network/localNetworkGateways"␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the local network gateway.␊ - */␊ - properties: (LocalNetworkGatewayPropertiesFormat8 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworkGateways␊ - */␊ - export interface VirtualNetworkGateways8 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworkGateways"␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway.␊ - */␊ - properties: (VirtualNetworkGatewayPropertiesFormat8 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnets8 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks/subnets"␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties: (SubnetPropertiesFormat8 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/virtualNetworkPeerings␊ - */␊ - export interface VirtualNetworksVirtualNetworkPeerings5 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks/virtualNetworkPeerings"␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties: (VirtualNetworkPeeringPropertiesFormat5 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers/inboundNatRules␊ - */␊ - export interface LoadBalancersInboundNatRules4 {␊ - name: string␊ - type: "Microsoft.Network/loadBalancers/inboundNatRules"␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties: (InboundNatRulePropertiesFormat8 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRules8 {␊ - name: string␊ - type: "Microsoft.Network/networkSecurityGroups/securityRules"␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Properties of the security rule␊ - */␊ - properties: (SecurityRulePropertiesFormat8 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutes8 {␊ - name: string␊ - type: "Microsoft.Network/routeTables/routes"␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Properties of the route.␊ - */␊ - properties: (RoutePropertiesFormat8 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/applicationSecurityGroups␊ - */␊ - export interface ApplicationSecurityGroups4 {␊ - name: string␊ - type: "Microsoft.Network/applicationSecurityGroups"␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the application security group.␊ - */␊ - properties: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ddosProtectionPlans␊ - */␊ - export interface DdosProtectionPlans {␊ - name: string␊ - type: "Microsoft.Network/ddosProtectionPlans"␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the DDoS protection plan.␊ - */␊ - properties: (DdosProtectionPlanPropertiesFormat | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DDoS protection plan properties.␊ - */␊ - export interface DdosProtectionPlanPropertiesFormat {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits␊ - */␊ - export interface ExpressRouteCircuits2 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits"␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The SKU.␊ - */␊ - sku?: (ExpressRouteCircuitSku2 | string)␊ - properties: (ExpressRouteCircuitPropertiesFormat2 | string)␊ - resources?: (ExpressRouteCircuitsPeeringsChildResource2 | ExpressRouteCircuitsAuthorizationsChildResource2)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains SKU in an ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitSku2 {␊ - /**␊ - * The name of the SKU.␊ - */␊ - name?: string␊ - /**␊ - * The tier of the SKU. Possible values are 'Standard' and 'Premium'.␊ - */␊ - tier?: (("Standard" | "Premium") | string)␊ - /**␊ - * The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'.␊ - */␊ - family?: (("UnlimitedData" | "MeteredData") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitPropertiesFormat2 {␊ - /**␊ - * Allow classic operations␊ - */␊ - allowClassicOperations?: (boolean | string)␊ - /**␊ - * The CircuitProvisioningState state of the resource.␊ - */␊ - circuitProvisioningState?: string␊ - /**␊ - * The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'.␊ - */␊ - serviceProviderProvisioningState?: (("NotProvisioned" | "Provisioning" | "Provisioned" | "Deprovisioning") | string)␊ - /**␊ - * The list of authorizations.␊ - */␊ - authorizations?: (ExpressRouteCircuitAuthorization2[] | string)␊ - /**␊ - * The list of peerings.␊ - */␊ - peerings?: (ExpressRouteCircuitPeering2[] | string)␊ - /**␊ - * The ServiceKey.␊ - */␊ - serviceKey?: string␊ - /**␊ - * The ServiceProviderNotes.␊ - */␊ - serviceProviderNotes?: string␊ - /**␊ - * The ServiceProviderProperties.␊ - */␊ - serviceProviderProperties?: (ExpressRouteCircuitServiceProviderProperties2 | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authorization in an ExpressRouteCircuit resource.␊ - */␊ - export interface ExpressRouteCircuitAuthorization2 {␊ - properties?: (AuthorizationPropertiesFormat3 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - export interface AuthorizationPropertiesFormat3 {␊ - /**␊ - * The authorization key.␊ - */␊ - authorizationKey?: string␊ - /**␊ - * AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'.␊ - */␊ - authorizationUseStatus?: (("Available" | "InUse") | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peering in an ExpressRouteCircuit resource.␊ - */␊ - export interface ExpressRouteCircuitPeering2 {␊ - properties?: (ExpressRouteCircuitPeeringPropertiesFormat3 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - export interface ExpressRouteCircuitPeeringPropertiesFormat3 {␊ - /**␊ - * The peering type.␊ - */␊ - peeringType?: (("AzurePublicPeering" | "AzurePrivatePeering" | "MicrosoftPeering") | string)␊ - /**␊ - * The peering state.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * The Azure ASN.␊ - */␊ - azureASN?: (number | string)␊ - /**␊ - * The peer ASN.␊ - */␊ - peerASN?: (number | string)␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The primary port.␊ - */␊ - primaryAzurePort?: string␊ - /**␊ - * The secondary port.␊ - */␊ - secondaryAzurePort?: string␊ - /**␊ - * The shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The VLAN ID.␊ - */␊ - vlanId?: (number | string)␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig3 | string)␊ - /**␊ - * Gets peering stats.␊ - */␊ - stats?: (ExpressRouteCircuitStats3 | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - /**␊ - * Gets whether the provider or the customer last modified the peering.␊ - */␊ - lastModifiedBy?: string␊ - /**␊ - * The reference of the RouteFilter resource.␊ - */␊ - routeFilter?: (SubResource15 | string)␊ - /**␊ - * The IPv6 peering configuration.␊ - */␊ - ipv6PeeringConfig?: (Ipv6ExpressRouteCircuitPeeringConfig | string)␊ - /**␊ - * The list of circuit connections associated with Azure Private Peering for this circuit.␊ - */␊ - connections?: (ExpressRouteCircuitConnection[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the peering configuration.␊ - */␊ - export interface ExpressRouteCircuitPeeringConfig3 {␊ - /**␊ - * The reference of AdvertisedPublicPrefixes.␊ - */␊ - advertisedPublicPrefixes?: (string[] | string)␊ - /**␊ - * The communities of bgp peering. Spepcified for microsoft peering␊ - */␊ - advertisedCommunities?: (string[] | string)␊ - /**␊ - * AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'.␊ - */␊ - advertisedPublicPrefixesState?: (("NotConfigured" | "Configuring" | "Configured" | "ValidationNeeded") | string)␊ - /**␊ - * The legacy mode of the peering.␊ - */␊ - legacyMode?: (number | string)␊ - /**␊ - * The CustomerASN of the peering.␊ - */␊ - customerASN?: (number | string)␊ - /**␊ - * The RoutingRegistryName of the configuration.␊ - */␊ - routingRegistryName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains stats associated with the peering.␊ - */␊ - export interface ExpressRouteCircuitStats3 {␊ - /**␊ - * Gets BytesIn of the peering.␊ - */␊ - primarybytesIn?: (number | string)␊ - /**␊ - * Gets BytesOut of the peering.␊ - */␊ - primarybytesOut?: (number | string)␊ - /**␊ - * Gets BytesIn of the peering.␊ - */␊ - secondarybytesIn?: (number | string)␊ - /**␊ - * Gets BytesOut of the peering.␊ - */␊ - secondarybytesOut?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Reference to another subresource.␊ - */␊ - export interface SubResource15 {␊ - /**␊ - * Resource ID.␊ - */␊ - id: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains IPv6 peering config.␊ - */␊ - export interface Ipv6ExpressRouteCircuitPeeringConfig {␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig3 | string)␊ - /**␊ - * The reference of the RouteFilter resource.␊ - */␊ - routeFilter?: (SubResource15 | string)␊ - /**␊ - * The state of peering. Possible values are: 'Disabled' and 'Enabled'.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Express Route Circuit Connection in an ExpressRouteCircuitPeering resource.␊ - */␊ - export interface ExpressRouteCircuitConnection {␊ - properties?: (ExpressRouteCircuitConnectionPropertiesFormat | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - export interface ExpressRouteCircuitConnectionPropertiesFormat {␊ - /**␊ - * Reference to Express Route Circuit Private Peering Resource of the circuit initiating connection.␊ - */␊ - expressRouteCircuitPeering?: (SubResource15 | string)␊ - /**␊ - * Reference to Express Route Circuit Private Peering Resource of the peered circuit.␊ - */␊ - peerExpressRouteCircuitPeering?: (SubResource15 | string)␊ - /**␊ - * /29 IP address space to carve out Customer addresses for tunnels.␊ - */␊ - addressPrefix?: string␊ - /**␊ - * The authorization key.␊ - */␊ - authorizationKey?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains ServiceProviderProperties in an ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitServiceProviderProperties2 {␊ - /**␊ - * The serviceProviderName.␊ - */␊ - serviceProviderName?: string␊ - /**␊ - * The peering location.␊ - */␊ - peeringLocation?: string␊ - /**␊ - * The BandwidthInMbps.␊ - */␊ - bandwidthInMbps?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings␊ - */␊ - export interface ExpressRouteCircuitsPeeringsChildResource2 {␊ - name: string␊ - type: "peerings"␊ - apiVersion: "2018-02-01"␊ - properties: (ExpressRouteCircuitPeeringPropertiesFormat3 | string)␊ - resources?: ExpressRouteCircuitsPeeringsConnectionsChildResource[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings/connections␊ - */␊ - export interface ExpressRouteCircuitsPeeringsConnectionsChildResource {␊ - name: string␊ - type: "connections"␊ - apiVersion: "2018-02-01"␊ - properties: (ExpressRouteCircuitConnectionPropertiesFormat | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/authorizations␊ - */␊ - export interface ExpressRouteCircuitsAuthorizationsChildResource2 {␊ - name: string␊ - type: "authorizations"␊ - apiVersion: "2018-02-01"␊ - properties: (AuthorizationPropertiesFormat3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections␊ - */␊ - export interface ExpressRouteCrossConnections {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCrossConnections"␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (ExpressRouteCrossConnectionProperties | string)␊ - resources?: ExpressRouteCrossConnectionsPeeringsChildResource[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ExpressRouteCrossConnection.␊ - */␊ - export interface ExpressRouteCrossConnectionProperties {␊ - /**␊ - * The provisioning state of the circuit in the connectivity provider system. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned'.␊ - */␊ - serviceProviderProvisioningState?: (("NotProvisioned" | "Provisioning" | "Provisioned" | "Deprovisioning") | string)␊ - /**␊ - * Additional read only notes set by the connectivity provider.␊ - */␊ - serviceProviderNotes?: string␊ - /**␊ - * The list of peerings.␊ - */␊ - peerings?: (ExpressRouteCrossConnectionPeering[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peering in an ExpressRoute Cross Connection resource.␊ - */␊ - export interface ExpressRouteCrossConnectionPeering {␊ - properties?: (ExpressRouteCrossConnectionPeeringProperties | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - export interface ExpressRouteCrossConnectionPeeringProperties {␊ - /**␊ - * The peering type.␊ - */␊ - peeringType?: (("AzurePublicPeering" | "AzurePrivatePeering" | "MicrosoftPeering") | string)␊ - /**␊ - * The peering state.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * The peer ASN.␊ - */␊ - peerASN?: (number | string)␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The VLAN ID.␊ - */␊ - vlanId?: (number | string)␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig3 | string)␊ - /**␊ - * Gets whether the provider or the customer last modified the peering.␊ - */␊ - lastModifiedBy?: string␊ - /**␊ - * The IPv6 peering configuration.␊ - */␊ - ipv6PeeringConfig?: (Ipv6ExpressRouteCircuitPeeringConfig | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections/peerings␊ - */␊ - export interface ExpressRouteCrossConnectionsPeeringsChildResource {␊ - name: string␊ - type: "peerings"␊ - apiVersion: "2018-02-01"␊ - properties: (ExpressRouteCrossConnectionPeeringProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/publicIPAddresses␊ - */␊ - export interface PublicIPAddresses17 {␊ - name: string␊ - type: "Microsoft.Network/publicIPAddresses"␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The public IP address SKU.␊ - */␊ - sku?: (PublicIPAddressSku5 | string)␊ - /**␊ - * Public IP address properties.␊ - */␊ - properties: (PublicIPAddressPropertiesFormat8 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a public IP address␊ - */␊ - export interface PublicIPAddressSku5 {␊ - /**␊ - * Name of a public IP address SKU.␊ - */␊ - name?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Public IP address properties.␊ - */␊ - export interface PublicIPAddressPropertiesFormat8 {␊ - /**␊ - * The public IP allocation method. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - publicIPAllocationMethod: (("Static" | "Dynamic") | string)␊ - /**␊ - * The public IP address version. Possible values are: 'IPv4' and 'IPv6'.␊ - */␊ - publicIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The FQDN of the DNS record associated with the public IP address.␊ - */␊ - dnsSettings?: (PublicIPAddressDnsSettings16 | string)␊ - /**␊ - * The list of tags associated with the public IP address.␊ - */␊ - ipTags?: (IpTag2[] | string)␊ - /**␊ - * The IP address associated with the public IP address resource.␊ - */␊ - ipAddress?: string␊ - /**␊ - * The idle timeout of the public IP address.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * The resource GUID property of the public IP resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains FQDN of the DNS record associated with the public IP address␊ - */␊ - export interface PublicIPAddressDnsSettings16 {␊ - /**␊ - * Gets or sets the Domain name label.The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.␊ - */␊ - domainNameLabel: string␊ - /**␊ - * Gets the FQDN, Fully qualified domain name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone.␊ - */␊ - fqdn?: string␊ - /**␊ - * Gets or Sets the Reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN. ␊ - */␊ - reverseFqdn?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains the IpTag associated with the public IP address␊ - */␊ - export interface IpTag2 {␊ - /**␊ - * Gets or sets the ipTag type: Example FirstPartyUsage.␊ - */␊ - ipTagType?: string␊ - /**␊ - * Gets or sets value of the IpTag associated with the public IP. Example SQL, Storage etc␊ - */␊ - tag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks␊ - */␊ - export interface VirtualNetworks17 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks"␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network.␊ - */␊ - properties: (VirtualNetworkPropertiesFormat9 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: (VirtualNetworksVirtualNetworkPeeringsChildResource6 | VirtualNetworksSubnetsChildResource9)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the virtual network.␊ - */␊ - export interface VirtualNetworkPropertiesFormat9 {␊ - /**␊ - * The AddressSpace that contains an array of IP address ranges that can be used by subnets.␊ - */␊ - addressSpace: (AddressSpace17 | string)␊ - /**␊ - * The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network.␊ - */␊ - dhcpOptions?: (DhcpOptions17 | string)␊ - /**␊ - * A list of subnets in a Virtual Network.␊ - */␊ - subnets?: (Subnet19[] | string)␊ - /**␊ - * A list of peerings in a Virtual Network.␊ - */␊ - virtualNetworkPeerings?: (VirtualNetworkPeering14[] | string)␊ - /**␊ - * The resourceGuid property of the Virtual Network resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - /**␊ - * Indicates if DDoS protection is enabled for all the protected resources in the virtual network. It requires a DDoS protection plan associated with the resource.␊ - */␊ - enableDdosProtection?: (boolean | string)␊ - /**␊ - * Indicates if VM protection is enabled for all the subnets in the virtual network.␊ - */␊ - enableVmProtection?: (boolean | string)␊ - /**␊ - * The DDoS protection plan associated with the virtual network.␊ - */␊ - ddosProtectionPlan?: (SubResource15 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.␊ - */␊ - export interface AddressSpace17 {␊ - /**␊ - * A list of address blocks reserved for this virtual network in CIDR notation.␊ - */␊ - addressPrefixes: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DhcpOptions contains an array of DNS servers available to VMs deployed in the virtual network. Standard DHCP option for a subnet overrides VNET DHCP options.␊ - */␊ - export interface DhcpOptions17 {␊ - /**␊ - * The list of DNS servers IP addresses.␊ - */␊ - dnsServers: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Subnet in a virtual network resource.␊ - */␊ - export interface Subnet19 {␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties?: (SubnetPropertiesFormat9 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the subnet.␊ - */␊ - export interface SubnetPropertiesFormat9 {␊ - /**␊ - * The address prefix for the subnet.␊ - */␊ - addressPrefix: string␊ - /**␊ - * The reference of the NetworkSecurityGroup resource.␊ - */␊ - networkSecurityGroup?: (SubResource15 | string)␊ - /**␊ - * The reference of the RouteTable resource.␊ - */␊ - routeTable?: (SubResource15 | string)␊ - /**␊ - * An array of service endpoints.␊ - */␊ - serviceEndpoints?: (ServiceEndpointPropertiesFormat5[] | string)␊ - /**␊ - * Gets an array of references to the external resources using subnet.␊ - */␊ - resourceNavigationLinks?: (ResourceNavigationLink6[] | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The service endpoint properties.␊ - */␊ - export interface ServiceEndpointPropertiesFormat5 {␊ - /**␊ - * The type of the endpoint service.␊ - */␊ - service?: string␊ - /**␊ - * A list of locations.␊ - */␊ - locations?: (string[] | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ResourceNavigationLink resource.␊ - */␊ - export interface ResourceNavigationLink6 {␊ - /**␊ - * Resource navigation link properties format.␊ - */␊ - properties?: (ResourceNavigationLinkFormat6 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ResourceNavigationLink.␊ - */␊ - export interface ResourceNavigationLinkFormat6 {␊ - /**␊ - * Resource type of the linked resource.␊ - */␊ - linkedResourceType?: string␊ - /**␊ - * Link to the external resource␊ - */␊ - link?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peerings in a virtual network resource.␊ - */␊ - export interface VirtualNetworkPeering14 {␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties?: (VirtualNetworkPeeringPropertiesFormat6 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - export interface VirtualNetworkPeeringPropertiesFormat6 {␊ - /**␊ - * Whether the VMs in the linked virtual network space would be able to access all the VMs in local Virtual network space.␊ - */␊ - allowVirtualNetworkAccess?: (boolean | string)␊ - /**␊ - * Whether the forwarded traffic from the VMs in the remote virtual network will be allowed/disallowed.␊ - */␊ - allowForwardedTraffic?: (boolean | string)␊ - /**␊ - * If gateway links can be used in remote virtual networking to link to this virtual network.␊ - */␊ - allowGatewayTransit?: (boolean | string)␊ - /**␊ - * If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway.␊ - */␊ - useRemoteGateways?: (boolean | string)␊ - /**␊ - * The reference of the remote virtual network. The remote virtual network can be in the same or different region (preview). See here to register for the preview and learn more (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering).␊ - */␊ - remoteVirtualNetwork: (SubResource15 | string)␊ - /**␊ - * The reference of the remote virtual network address space.␊ - */␊ - remoteAddressSpace?: (AddressSpace17 | string)␊ - /**␊ - * The status of the virtual network peering. Possible values are 'Initiated', 'Connected', and 'Disconnected'.␊ - */␊ - peeringState?: (("Initiated" | "Connected" | "Disconnected") | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/virtualNetworkPeerings␊ - */␊ - export interface VirtualNetworksVirtualNetworkPeeringsChildResource6 {␊ - name: string␊ - type: "virtualNetworkPeerings"␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties: (VirtualNetworkPeeringPropertiesFormat6 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnetsChildResource9 {␊ - name: string␊ - type: "subnets"␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties: (SubnetPropertiesFormat9 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers␊ - */␊ - export interface LoadBalancers17 {␊ - name: string␊ - type: "Microsoft.Network/loadBalancers"␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The load balancer SKU.␊ - */␊ - sku?: (LoadBalancerSku5 | string)␊ - /**␊ - * Properties of load balancer.␊ - */␊ - properties: (LoadBalancerPropertiesFormat9 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: LoadBalancersInboundNatRulesChildResource5[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a load balancer␊ - */␊ - export interface LoadBalancerSku5 {␊ - /**␊ - * Name of a load balancer SKU.␊ - */␊ - name?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer.␊ - */␊ - export interface LoadBalancerPropertiesFormat9 {␊ - /**␊ - * Object representing the frontend IPs to be used for the load balancer␊ - */␊ - frontendIPConfigurations?: (FrontendIPConfiguration8[] | string)␊ - /**␊ - * Collection of backend address pools used by a load balancer␊ - */␊ - backendAddressPools?: (BackendAddressPool9[] | string)␊ - /**␊ - * Object collection representing the load balancing rules Gets the provisioning ␊ - */␊ - loadBalancingRules?: (LoadBalancingRule9[] | string)␊ - /**␊ - * Collection of probe objects used in the load balancer␊ - */␊ - probes?: (Probe9[] | string)␊ - /**␊ - * Collection of inbound NAT Rules used by a load balancer. Defining inbound NAT rules on your load balancer is mutually exclusive with defining an inbound NAT pool. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an Inbound NAT pool. They have to reference individual inbound NAT rules.␊ - */␊ - inboundNatRules?: (InboundNatRule10[] | string)␊ - /**␊ - * Defines an external port range for inbound NAT to a single backend port on NICs associated with a load balancer. Inbound NAT rules are created automatically for each NIC associated with the Load Balancer using an external port from this range. Defining an Inbound NAT pool on your Load Balancer is mutually exclusive with defining inbound Nat rules. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an inbound NAT pool. They have to reference individual inbound NAT rules.␊ - */␊ - inboundNatPools?: (InboundNatPool10[] | string)␊ - /**␊ - * The outbound NAT rules.␊ - */␊ - outboundNatRules?: (OutboundNatRule9[] | string)␊ - /**␊ - * The resource GUID property of the load balancer resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP address of the load balancer.␊ - */␊ - export interface FrontendIPConfiguration8 {␊ - /**␊ - * Properties of the load balancer probe.␊ - */␊ - properties?: (FrontendIPConfigurationPropertiesFormat8 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP Configuration of the load balancer.␊ - */␊ - export interface FrontendIPConfigurationPropertiesFormat8 {␊ - /**␊ - * The private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The Private IP allocation method. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * The reference of the subnet resource.␊ - */␊ - subnet?: (SubResource15 | string)␊ - /**␊ - * The reference of the Public IP resource.␊ - */␊ - publicIPAddress?: (SubResource15 | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Pool of backend IP addresses.␊ - */␊ - export interface BackendAddressPool9 {␊ - /**␊ - * Properties of load balancer backend address pool.␊ - */␊ - properties?: (BackendAddressPoolPropertiesFormat9 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the backend address pool.␊ - */␊ - export interface BackendAddressPoolPropertiesFormat9 {␊ - /**␊ - * Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A load balancing rule for a load balancer.␊ - */␊ - export interface LoadBalancingRule9 {␊ - /**␊ - * Properties of load balancer load balancing rule.␊ - */␊ - properties?: (LoadBalancingRulePropertiesFormat9 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer.␊ - */␊ - export interface LoadBalancingRulePropertiesFormat9 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource15 | string)␊ - /**␊ - * A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs.␊ - */␊ - backendAddressPool?: (SubResource15 | string)␊ - /**␊ - * The reference of the load balancer probe used by the load balancing rule.␊ - */␊ - probe?: (SubResource15 | string)␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'.␊ - */␊ - loadDistribution?: (("Default" | "SourceIP" | "SourceIPProtocol") | string)␊ - /**␊ - * The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 0 and 65534. Note that value 0 enables "Any Port"␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port"␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule.␊ - */␊ - disableOutboundSnat?: (boolean | string)␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A load balancer probe.␊ - */␊ - export interface Probe9 {␊ - /**␊ - * Properties of load balancer probe.␊ - */␊ - properties?: (ProbePropertiesFormat9 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Load balancer probe resource.␊ - */␊ - export interface ProbePropertiesFormat9 {␊ - /**␊ - * The protocol of the end point. Possible values are: 'Http' or 'Tcp'. If 'Tcp' is specified, a received ACK is required for the probe to be successful. If 'Http' is specified, a 200 OK response from the specifies URI is required for the probe to be successful.␊ - */␊ - protocol: (("Http" | "Tcp") | string)␊ - /**␊ - * The port for communicating the probe. Possible values range from 1 to 65535, inclusive.␊ - */␊ - port: (number | string)␊ - /**␊ - * The interval, in seconds, for how frequently to probe the endpoint for health status. Typically, the interval is slightly less than half the allocated timeout period (in seconds) which allows two full probes before taking the instance out of rotation. The default value is 15, the minimum value is 5.␊ - */␊ - intervalInSeconds?: (number | string)␊ - /**␊ - * The number of probes where if no response, will result in stopping further traffic from being delivered to the endpoint. This values allows endpoints to be taken out of rotation faster or slower than the typical times used in Azure.␊ - */␊ - numberOfProbes: (number | string)␊ - /**␊ - * The URI used for requesting health status from the VM. Path is required if a protocol is set to http. Otherwise, it is not allowed. There is no default value.␊ - */␊ - requestPath?: string␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT rule of the load balancer.␊ - */␊ - export interface InboundNatRule10 {␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties?: (InboundNatRulePropertiesFormat9 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the inbound NAT rule.␊ - */␊ - export interface InboundNatRulePropertiesFormat9 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource15 | string)␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values range from 1 to 65534.␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * The port used for the internal endpoint. Acceptable values range from 1 to 65535.␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT pool of the load balancer.␊ - */␊ - export interface InboundNatPool10 {␊ - /**␊ - * Properties of load balancer inbound nat pool.␊ - */␊ - properties?: (InboundNatPoolPropertiesFormat9 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Inbound NAT pool.␊ - */␊ - export interface InboundNatPoolPropertiesFormat9 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource15 | string)␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65534.␊ - */␊ - frontendPortRangeStart: (number | string)␊ - /**␊ - * The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65535.␊ - */␊ - frontendPortRangeEnd: (number | string)␊ - /**␊ - * The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound NAT pool of the load balancer.␊ - */␊ - export interface OutboundNatRule9 {␊ - /**␊ - * Properties of load balancer outbound nat rule.␊ - */␊ - properties?: (OutboundNatRulePropertiesFormat9 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound NAT pool of the load balancer.␊ - */␊ - export interface OutboundNatRulePropertiesFormat9 {␊ - /**␊ - * The number of outbound ports to be used for NAT.␊ - */␊ - allocatedOutboundPorts?: (number | string)␊ - /**␊ - * The Frontend IP addresses of the load balancer.␊ - */␊ - frontendIPConfigurations?: (SubResource15[] | string)␊ - /**␊ - * A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs.␊ - */␊ - backendAddressPool: (SubResource15 | string)␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers/inboundNatRules␊ - */␊ - export interface LoadBalancersInboundNatRulesChildResource5 {␊ - name: string␊ - type: "inboundNatRules"␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties: (InboundNatRulePropertiesFormat9 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups␊ - */␊ - export interface NetworkSecurityGroups17 {␊ - name: string␊ - type: "Microsoft.Network/networkSecurityGroups"␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network security group␊ - */␊ - properties: (NetworkSecurityGroupPropertiesFormat9 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: NetworkSecurityGroupsSecurityRulesChildResource9[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network Security Group resource.␊ - */␊ - export interface NetworkSecurityGroupPropertiesFormat9 {␊ - /**␊ - * A collection of security rules of the network security group.␊ - */␊ - securityRules?: (SecurityRule9[] | string)␊ - /**␊ - * The default security rules of network security group.␊ - */␊ - defaultSecurityRules?: (SecurityRule9[] | string)␊ - /**␊ - * The resource GUID property of the network security group resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network security rule.␊ - */␊ - export interface SecurityRule9 {␊ - /**␊ - * Properties of the security rule␊ - */␊ - properties?: (SecurityRulePropertiesFormat9 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Security rule resource.␊ - */␊ - export interface SecurityRulePropertiesFormat9 {␊ - /**␊ - * A description for this rule. Restricted to 140 chars.␊ - */␊ - description?: string␊ - /**␊ - * Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'.␊ - */␊ - protocol: (("Tcp" | "Udp" | "*") | string)␊ - /**␊ - * The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports.␊ - */␊ - sourcePortRange?: string␊ - /**␊ - * The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports.␊ - */␊ - destinationPortRange?: string␊ - /**␊ - * The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. ␊ - */␊ - sourceAddressPrefix?: string␊ - /**␊ - * The CIDR or source IP ranges.␊ - */␊ - sourceAddressPrefixes?: (string[] | string)␊ - /**␊ - * The application security group specified as source.␊ - */␊ - sourceApplicationSecurityGroups?: (ApplicationSecurityGroup4[] | string)␊ - /**␊ - * The destination address prefix. CIDR or destination IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used.␊ - */␊ - destinationAddressPrefix?: string␊ - /**␊ - * The destination address prefixes. CIDR or destination IP ranges.␊ - */␊ - destinationAddressPrefixes?: (string[] | string)␊ - /**␊ - * The application security group specified as destination.␊ - */␊ - destinationApplicationSecurityGroups?: (ApplicationSecurityGroup4[] | string)␊ - /**␊ - * The source port ranges.␊ - */␊ - sourcePortRanges?: (string[] | string)␊ - /**␊ - * The destination port ranges.␊ - */␊ - destinationPortRanges?: (string[] | string)␊ - /**␊ - * The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'.␊ - */␊ - access: (("Allow" | "Deny") | string)␊ - /**␊ - * The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.␊ - */␊ - priority: (number | string)␊ - /**␊ - * The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'.␊ - */␊ - direction: (("Inbound" | "Outbound") | string)␊ - /**␊ - * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An application security group in a resource group.␊ - */␊ - export interface ApplicationSecurityGroup4 {␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the application security group.␊ - */␊ - properties?: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRulesChildResource9 {␊ - name: string␊ - type: "securityRules"␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Properties of the security rule␊ - */␊ - properties: (SecurityRulePropertiesFormat9 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces␊ - */␊ - export interface NetworkInterfaces18 {␊ - name: string␊ - type: "Microsoft.Network/networkInterfaces"␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network interface.␊ - */␊ - properties: (NetworkInterfacePropertiesFormat9 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NetworkInterface properties. ␊ - */␊ - export interface NetworkInterfacePropertiesFormat9 {␊ - /**␊ - * The reference of the NetworkSecurityGroup resource.␊ - */␊ - networkSecurityGroup?: (SubResource15 | string)␊ - /**␊ - * A list of IPConfigurations of the network interface.␊ - */␊ - ipConfigurations: (NetworkInterfaceIPConfiguration8[] | string)␊ - /**␊ - * The DNS settings in network interface.␊ - */␊ - dnsSettings?: (NetworkInterfaceDnsSettings17 | string)␊ - /**␊ - * The MAC address of the network interface.␊ - */␊ - macAddress?: string␊ - /**␊ - * Gets whether this is a primary network interface on a virtual machine.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * If the network interface is accelerated networking enabled.␊ - */␊ - enableAcceleratedNetworking?: (boolean | string)␊ - /**␊ - * Indicates whether IP forwarding is enabled on this network interface.␊ - */␊ - enableIPForwarding?: (boolean | string)␊ - /**␊ - * The resource GUID property of the network interface resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IPConfiguration in a network interface.␊ - */␊ - export interface NetworkInterfaceIPConfiguration8 {␊ - /**␊ - * Network interface IP configuration properties.␊ - */␊ - properties?: (NetworkInterfaceIPConfigurationPropertiesFormat8 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration.␊ - */␊ - export interface NetworkInterfaceIPConfigurationPropertiesFormat8 {␊ - /**␊ - * The reference of ApplicationGatewayBackendAddressPool resource.␊ - */␊ - applicationGatewayBackendAddressPools?: (SubResource15[] | string)␊ - /**␊ - * The reference of LoadBalancerBackendAddressPool resource.␊ - */␊ - loadBalancerBackendAddressPools?: (SubResource15[] | string)␊ - /**␊ - * A list of references of LoadBalancerInboundNatRules.␊ - */␊ - loadBalancerInboundNatRules?: (SubResource15[] | string)␊ - /**␊ - * Private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * Defines how a private IP address is assigned. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Available from Api-Version 2016-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.␊ - */␊ - privateIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * Subnet bound to the IP configuration.␊ - */␊ - subnet?: (SubResource15 | string)␊ - /**␊ - * Gets whether this is a primary customer address on the network interface.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * Public IP address bound to the IP configuration.␊ - */␊ - publicIPAddress?: (SubResource15 | string)␊ - /**␊ - * Application security groups in which the IP configuration is included.␊ - */␊ - applicationSecurityGroups?: (SubResource15[] | string)␊ - /**␊ - * The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DNS settings of a network interface.␊ - */␊ - export interface NetworkInterfaceDnsSettings17 {␊ - /**␊ - * List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only value in dnsServers collection.␊ - */␊ - dnsServers?: (string[] | string)␊ - /**␊ - * If the VM that uses this NIC is part of an Availability Set, then this list will have the union of all DNS servers from all NICs that are part of the Availability Set. This property is what is configured on each of those VMs.␊ - */␊ - appliedDnsServers?: (string[] | string)␊ - /**␊ - * Relative DNS name for this NIC used for internal communications between VMs in the same virtual network.␊ - */␊ - internalDnsNameLabel?: string␊ - /**␊ - * Fully qualified DNS name supporting internal communications between VMs in the same virtual network.␊ - */␊ - internalFqdn?: string␊ - /**␊ - * Even if internalDnsNameLabel is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internalDomainNameSuffix.␊ - */␊ - internalDomainNameSuffix?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables␊ - */␊ - export interface RouteTables17 {␊ - name: string␊ - type: "Microsoft.Network/routeTables"␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the route table.␊ - */␊ - properties: (RouteTablePropertiesFormat9 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: RouteTablesRoutesChildResource9[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Table resource␊ - */␊ - export interface RouteTablePropertiesFormat9 {␊ - /**␊ - * Collection of routes contained within a route table.␊ - */␊ - routes?: (Route9[] | string)␊ - /**␊ - * Gets or sets whether to disable the routes learned by BGP on that route table. True means disable.␊ - */␊ - disableBgpRoutePropagation?: (boolean | string)␊ - /**␊ - * The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource␊ - */␊ - export interface Route9 {␊ - /**␊ - * Properties of the route.␊ - */␊ - properties?: (RoutePropertiesFormat9 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource␊ - */␊ - export interface RoutePropertiesFormat9 {␊ - /**␊ - * The destination CIDR to which the route applies.␊ - */␊ - addressPrefix: string␊ - /**␊ - * The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'.␊ - */␊ - nextHopType: (("VirtualNetworkGateway" | "VnetLocal" | "Internet" | "VirtualAppliance" | "None") | string)␊ - /**␊ - * The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.␊ - */␊ - nextHopIpAddress?: string␊ - /**␊ - * The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutesChildResource9 {␊ - name: string␊ - type: "routes"␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Properties of the route.␊ - */␊ - properties: (RoutePropertiesFormat9 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers/inboundNatRules␊ - */␊ - export interface LoadBalancersInboundNatRules5 {␊ - name: string␊ - type: "Microsoft.Network/loadBalancers/inboundNatRules"␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties: (InboundNatRulePropertiesFormat9 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRules9 {␊ - name: string␊ - type: "Microsoft.Network/networkSecurityGroups/securityRules"␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Properties of the security rule␊ - */␊ - properties: (SecurityRulePropertiesFormat9 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutes9 {␊ - name: string␊ - type: "Microsoft.Network/routeTables/routes"␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Properties of the route.␊ - */␊ - properties: (RoutePropertiesFormat9 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/authorizations␊ - */␊ - export interface ExpressRouteCircuitsAuthorizations3 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/authorizations"␊ - apiVersion: "2018-02-01"␊ - properties: (AuthorizationPropertiesFormat3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings␊ - */␊ - export interface ExpressRouteCircuitsPeerings3 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/peerings"␊ - apiVersion: "2018-02-01"␊ - properties: (ExpressRouteCircuitPeeringPropertiesFormat3 | string)␊ - resources?: ExpressRouteCircuitsPeeringsConnectionsChildResource[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections/peerings␊ - */␊ - export interface ExpressRouteCrossConnectionsPeerings {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCrossConnections/peerings"␊ - apiVersion: "2018-02-01"␊ - properties: (ExpressRouteCrossConnectionPeeringProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings/connections␊ - */␊ - export interface ExpressRouteCircuitsPeeringsConnections {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/peerings/connections"␊ - apiVersion: "2018-02-01"␊ - properties: (ExpressRouteCircuitConnectionPropertiesFormat | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/applicationGateways␊ - */␊ - export interface ApplicationGateways9 {␊ - name: string␊ - type: "Microsoft.Network/applicationGateways"␊ - apiVersion: "2018-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (ApplicationGatewayPropertiesFormat9 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * A list of availability zones denoting where the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application gateway.␊ - */␊ - export interface ApplicationGatewayPropertiesFormat9 {␊ - /**␊ - * SKU of the application gateway resource.␊ - */␊ - sku?: (ApplicationGatewaySku9 | string)␊ - /**␊ - * SSL policy of the application gateway resource.␊ - */␊ - sslPolicy?: (ApplicationGatewaySslPolicy6 | string)␊ - /**␊ - * Subnets of application the gateway resource.␊ - */␊ - gatewayIPConfigurations?: (ApplicationGatewayIPConfiguration9[] | string)␊ - /**␊ - * Authentication certificates of the application gateway resource.␊ - */␊ - authenticationCertificates?: (ApplicationGatewayAuthenticationCertificate6[] | string)␊ - /**␊ - * SSL certificates of the application gateway resource.␊ - */␊ - sslCertificates?: (ApplicationGatewaySslCertificate9[] | string)␊ - /**␊ - * Frontend IP addresses of the application gateway resource.␊ - */␊ - frontendIPConfigurations?: (ApplicationGatewayFrontendIPConfiguration9[] | string)␊ - /**␊ - * Frontend ports of the application gateway resource.␊ - */␊ - frontendPorts?: (ApplicationGatewayFrontendPort9[] | string)␊ - /**␊ - * Probes of the application gateway resource.␊ - */␊ - probes?: (ApplicationGatewayProbe8[] | string)␊ - /**␊ - * Backend address pool of the application gateway resource.␊ - */␊ - backendAddressPools?: (ApplicationGatewayBackendAddressPool9[] | string)␊ - /**␊ - * Backend http settings of the application gateway resource.␊ - */␊ - backendHttpSettingsCollection?: (ApplicationGatewayBackendHttpSettings9[] | string)␊ - /**␊ - * Http listeners of the application gateway resource.␊ - */␊ - httpListeners?: (ApplicationGatewayHttpListener9[] | string)␊ - /**␊ - * URL path map of the application gateway resource.␊ - */␊ - urlPathMaps?: (ApplicationGatewayUrlPathMap8[] | string)␊ - /**␊ - * Request routing rules of the application gateway resource.␊ - */␊ - requestRoutingRules?: (ApplicationGatewayRequestRoutingRule9[] | string)␊ - /**␊ - * Redirect configurations of the application gateway resource.␊ - */␊ - redirectConfigurations?: (ApplicationGatewayRedirectConfiguration6[] | string)␊ - /**␊ - * Web application firewall configuration.␊ - */␊ - webApplicationFirewallConfiguration?: (ApplicationGatewayWebApplicationFirewallConfiguration6 | string)␊ - /**␊ - * Whether HTTP2 is enabled on the application gateway resource.␊ - */␊ - enableHttp2?: (boolean | string)␊ - /**␊ - * Whether FIPS is enabled on the application gateway resource.␊ - */␊ - enableFips?: (boolean | string)␊ - /**␊ - * Autoscale Configuration.␊ - */␊ - autoscaleConfiguration?: (ApplicationGatewayAutoscaleConfiguration | string)␊ - /**␊ - * Resource GUID property of the application gateway resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of an application gateway␊ - */␊ - export interface ApplicationGatewaySku9 {␊ - /**␊ - * Name of an application gateway SKU.␊ - */␊ - name?: (("Standard_Small" | "Standard_Medium" | "Standard_Large" | "WAF_Medium" | "WAF_Large" | "Standard_v2" | "WAF_v2") | string)␊ - /**␊ - * Tier of an application gateway.␊ - */␊ - tier?: (("Standard" | "WAF" | "Standard_v2" | "WAF_v2") | string)␊ - /**␊ - * Capacity (instance count) of an application gateway.␊ - */␊ - capacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application Gateway Ssl policy.␊ - */␊ - export interface ApplicationGatewaySslPolicy6 {␊ - /**␊ - * Ssl protocols to be disabled on application gateway.␊ - */␊ - disabledSslProtocols?: (("TLSv1_0" | "TLSv1_1" | "TLSv1_2")[] | string)␊ - /**␊ - * Type of Ssl Policy.␊ - */␊ - policyType?: (("Predefined" | "Custom") | string)␊ - /**␊ - * Name of Ssl predefined policy.␊ - */␊ - policyName?: (("AppGwSslPolicy20150501" | "AppGwSslPolicy20170401" | "AppGwSslPolicy20170401S") | string)␊ - /**␊ - * Ssl cipher suites to be enabled in the specified order to application gateway.␊ - */␊ - cipherSuites?: (("TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384" | "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256" | "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA" | "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA" | "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384" | "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256" | "TLS_DHE_RSA_WITH_AES_256_CBC_SHA" | "TLS_DHE_RSA_WITH_AES_128_CBC_SHA" | "TLS_RSA_WITH_AES_256_GCM_SHA384" | "TLS_RSA_WITH_AES_128_GCM_SHA256" | "TLS_RSA_WITH_AES_256_CBC_SHA256" | "TLS_RSA_WITH_AES_128_CBC_SHA256" | "TLS_RSA_WITH_AES_256_CBC_SHA" | "TLS_RSA_WITH_AES_128_CBC_SHA" | "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384" | "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256" | "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384" | "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256" | "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA" | "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA" | "TLS_DHE_DSS_WITH_AES_256_CBC_SHA256" | "TLS_DHE_DSS_WITH_AES_128_CBC_SHA256" | "TLS_DHE_DSS_WITH_AES_256_CBC_SHA" | "TLS_DHE_DSS_WITH_AES_128_CBC_SHA" | "TLS_RSA_WITH_3DES_EDE_CBC_SHA" | "TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA" | "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256" | "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384")[] | string)␊ - /**␊ - * Minimum version of Ssl protocol to be supported on application gateway.␊ - */␊ - minProtocolVersion?: (("TLSv1_0" | "TLSv1_1" | "TLSv1_2") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed.␊ - */␊ - export interface ApplicationGatewayIPConfiguration9 {␊ - properties?: (ApplicationGatewayIPConfigurationPropertiesFormat9 | string)␊ - /**␊ - * Name of the IP configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayIPConfigurationPropertiesFormat9 {␊ - /**␊ - * Reference of the subnet resource. A subnet from where application gateway gets its private address.␊ - */␊ - subnet?: (SubResource16 | string)␊ - /**␊ - * Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Reference to another subresource.␊ - */␊ - export interface SubResource16 {␊ - /**␊ - * Resource ID.␊ - */␊ - id: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authentication certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewayAuthenticationCertificate6 {␊ - properties?: (ApplicationGatewayAuthenticationCertificatePropertiesFormat6 | string)␊ - /**␊ - * Name of the authentication certificate that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authentication certificates properties of an application gateway.␊ - */␊ - export interface ApplicationGatewayAuthenticationCertificatePropertiesFormat6 {␊ - /**␊ - * Certificate public data.␊ - */␊ - data?: string␊ - /**␊ - * Provisioning state of the authentication certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSL certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewaySslCertificate9 {␊ - properties?: (ApplicationGatewaySslCertificatePropertiesFormat9 | string)␊ - /**␊ - * Name of the SSL certificate that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewaySslCertificatePropertiesFormat9 {␊ - /**␊ - * Base-64 encoded pfx certificate. Only applicable in PUT Request.␊ - */␊ - data?: string␊ - /**␊ - * Password for the pfx file specified in data. Only applicable in PUT request.␊ - */␊ - password?: string␊ - /**␊ - * Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request.␊ - */␊ - publicCertData?: string␊ - /**␊ - * Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendIPConfiguration9 {␊ - properties?: (ApplicationGatewayFrontendIPConfigurationPropertiesFormat9 | string)␊ - /**␊ - * Name of the frontend IP configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendIPConfigurationPropertiesFormat9 {␊ - /**␊ - * PrivateIPAddress of the network interface IP Configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * PrivateIP allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Reference of the subnet resource.␊ - */␊ - subnet?: (SubResource16 | string)␊ - /**␊ - * Reference of the PublicIP resource.␊ - */␊ - publicIPAddress?: (SubResource16 | string)␊ - /**␊ - * Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend port of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendPort9 {␊ - properties?: (ApplicationGatewayFrontendPortPropertiesFormat9 | string)␊ - /**␊ - * Name of the frontend port that is unique within an Application Gateway␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend port of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendPortPropertiesFormat9 {␊ - /**␊ - * Frontend port␊ - */␊ - port?: (number | string)␊ - /**␊ - * Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Probe of the application gateway.␊ - */␊ - export interface ApplicationGatewayProbe8 {␊ - properties?: (ApplicationGatewayProbePropertiesFormat8 | string)␊ - /**␊ - * Name of the probe that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of probe of an application gateway.␊ - */␊ - export interface ApplicationGatewayProbePropertiesFormat8 {␊ - /**␊ - * The protocol used for the probe. Possible values are 'Http' and 'Https'.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Host name to send the probe to.␊ - */␊ - host?: string␊ - /**␊ - * Relative path of probe. Valid path starts from '/'. Probe is sent to ://:␊ - */␊ - path?: string␊ - /**␊ - * The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - interval?: (number | string)␊ - /**␊ - * the probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - timeout?: (number | string)␊ - /**␊ - * The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20.␊ - */␊ - unhealthyThreshold?: (number | string)␊ - /**␊ - * Whether the host header should be picked from the backend http settings. Default value is false.␊ - */␊ - pickHostNameFromBackendHttpSettings?: (boolean | string)␊ - /**␊ - * Minimum number of servers that are always marked healthy. Default value is 0.␊ - */␊ - minServers?: (number | string)␊ - /**␊ - * Criterion for classifying a healthy probe response.␊ - */␊ - match?: (ApplicationGatewayProbeHealthResponseMatch6 | string)␊ - /**␊ - * Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application gateway probe health response match␊ - */␊ - export interface ApplicationGatewayProbeHealthResponseMatch6 {␊ - /**␊ - * Body that must be contained in the health response. Default value is empty.␊ - */␊ - body?: string␊ - /**␊ - * Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399.␊ - */␊ - statusCodes?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend Address Pool of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddressPool9 {␊ - properties?: (ApplicationGatewayBackendAddressPoolPropertiesFormat9 | string)␊ - /**␊ - * Name of the backend address pool that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend Address Pool of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddressPoolPropertiesFormat9 {␊ - /**␊ - * Collection of references to IPs defined in network interfaces.␊ - */␊ - backendIPConfigurations?: (SubResource16[] | string)␊ - /**␊ - * Backend addresses␊ - */␊ - backendAddresses?: (ApplicationGatewayBackendAddress9[] | string)␊ - /**␊ - * Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddress9 {␊ - /**␊ - * Fully qualified domain name (FQDN).␊ - */␊ - fqdn?: string␊ - /**␊ - * IP address␊ - */␊ - ipAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address pool settings of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendHttpSettings9 {␊ - properties?: (ApplicationGatewayBackendHttpSettingsPropertiesFormat9 | string)␊ - /**␊ - * Name of the backend http settings that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend address pool settings of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendHttpSettingsPropertiesFormat9 {␊ - /**␊ - * The destination port on the backend.␊ - */␊ - port?: (number | string)␊ - /**␊ - * The protocol used to communicate with the backend. Possible values are 'Http' and 'Https'.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Cookie based affinity.␊ - */␊ - cookieBasedAffinity?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Request timeout in seconds. Application Gateway will fail the request if response is not received within RequestTimeout. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - requestTimeout?: (number | string)␊ - /**␊ - * Probe resource of an application gateway.␊ - */␊ - probe?: (SubResource16 | string)␊ - /**␊ - * Array of references to application gateway authentication certificates.␊ - */␊ - authenticationCertificates?: (SubResource16[] | string)␊ - /**␊ - * Connection draining of the backend http settings resource.␊ - */␊ - connectionDraining?: (ApplicationGatewayConnectionDraining6 | string)␊ - /**␊ - * Host header to be sent to the backend servers.␊ - */␊ - hostName?: string␊ - /**␊ - * Whether to pick host header should be picked from the host name of the backend server. Default value is false.␊ - */␊ - pickHostNameFromBackendAddress?: (boolean | string)␊ - /**␊ - * Cookie name to use for the affinity cookie.␊ - */␊ - affinityCookieName?: string␊ - /**␊ - * Whether the probe is enabled. Default value is false.␊ - */␊ - probeEnabled?: (boolean | string)␊ - /**␊ - * Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null.␊ - */␊ - path?: string␊ - /**␊ - * Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Connection draining allows open connections to a backend server to be active for a specified time after the backend server got removed from the configuration.␊ - */␊ - export interface ApplicationGatewayConnectionDraining6 {␊ - /**␊ - * Whether connection draining is enabled or not.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds.␊ - */␊ - drainTimeoutInSec: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http listener of an application gateway.␊ - */␊ - export interface ApplicationGatewayHttpListener9 {␊ - properties?: (ApplicationGatewayHttpListenerPropertiesFormat9 | string)␊ - /**␊ - * Name of the HTTP listener that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of HTTP listener of an application gateway.␊ - */␊ - export interface ApplicationGatewayHttpListenerPropertiesFormat9 {␊ - /**␊ - * Frontend IP configuration resource of an application gateway.␊ - */␊ - frontendIPConfiguration?: (SubResource16 | string)␊ - /**␊ - * Frontend port resource of an application gateway.␊ - */␊ - frontendPort?: (SubResource16 | string)␊ - /**␊ - * Protocol of the HTTP listener. Possible values are 'Http' and 'Https'.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Host name of HTTP listener.␊ - */␊ - hostName?: string␊ - /**␊ - * SSL certificate resource of an application gateway.␊ - */␊ - sslCertificate?: (SubResource16 | string)␊ - /**␊ - * Applicable only if protocol is https. Enables SNI for multi-hosting.␊ - */␊ - requireServerNameIndication?: (boolean | string)␊ - /**␊ - * Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * UrlPathMaps give a url path to the backend mapping information for PathBasedRouting.␊ - */␊ - export interface ApplicationGatewayUrlPathMap8 {␊ - properties?: (ApplicationGatewayUrlPathMapPropertiesFormat8 | string)␊ - /**␊ - * Name of the URL path map that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of UrlPathMap of the application gateway.␊ - */␊ - export interface ApplicationGatewayUrlPathMapPropertiesFormat8 {␊ - /**␊ - * Default backend address pool resource of URL path map.␊ - */␊ - defaultBackendAddressPool?: (SubResource16 | string)␊ - /**␊ - * Default backend http settings resource of URL path map.␊ - */␊ - defaultBackendHttpSettings?: (SubResource16 | string)␊ - /**␊ - * Default redirect configuration resource of URL path map.␊ - */␊ - defaultRedirectConfiguration?: (SubResource16 | string)␊ - /**␊ - * Path rule of URL path map resource.␊ - */␊ - pathRules?: (ApplicationGatewayPathRule8[] | string)␊ - /**␊ - * Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Path rule of URL path map of an application gateway.␊ - */␊ - export interface ApplicationGatewayPathRule8 {␊ - properties?: (ApplicationGatewayPathRulePropertiesFormat8 | string)␊ - /**␊ - * Name of the path rule that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of path rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayPathRulePropertiesFormat8 {␊ - /**␊ - * Path rules of URL path map.␊ - */␊ - paths?: (string[] | string)␊ - /**␊ - * Backend address pool resource of URL path map path rule.␊ - */␊ - backendAddressPool?: (SubResource16 | string)␊ - /**␊ - * Backend http settings resource of URL path map path rule.␊ - */␊ - backendHttpSettings?: (SubResource16 | string)␊ - /**␊ - * Redirect configuration resource of URL path map path rule.␊ - */␊ - redirectConfiguration?: (SubResource16 | string)␊ - /**␊ - * Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Request routing rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayRequestRoutingRule9 {␊ - properties?: (ApplicationGatewayRequestRoutingRulePropertiesFormat9 | string)␊ - /**␊ - * Name of the request routing rule that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of request routing rule of the application gateway.␊ - */␊ - export interface ApplicationGatewayRequestRoutingRulePropertiesFormat9 {␊ - /**␊ - * Rule type.␊ - */␊ - ruleType?: (("Basic" | "PathBasedRouting") | string)␊ - /**␊ - * Backend address pool resource of the application gateway. ␊ - */␊ - backendAddressPool?: (SubResource16 | string)␊ - /**␊ - * Backend http settings resource of the application gateway.␊ - */␊ - backendHttpSettings?: (SubResource16 | string)␊ - /**␊ - * Http listener resource of the application gateway. ␊ - */␊ - httpListener?: (SubResource16 | string)␊ - /**␊ - * URL path map resource of the application gateway.␊ - */␊ - urlPathMap?: (SubResource16 | string)␊ - /**␊ - * Redirect configuration resource of the application gateway.␊ - */␊ - redirectConfiguration?: (SubResource16 | string)␊ - /**␊ - * Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Redirect configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayRedirectConfiguration6 {␊ - properties?: (ApplicationGatewayRedirectConfigurationPropertiesFormat6 | string)␊ - /**␊ - * Name of the redirect configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of redirect configuration of the application gateway.␊ - */␊ - export interface ApplicationGatewayRedirectConfigurationPropertiesFormat6 {␊ - /**␊ - * Supported http redirection types - Permanent, Temporary, Found, SeeOther.␊ - */␊ - redirectType?: (("Permanent" | "Found" | "SeeOther" | "Temporary") | string)␊ - /**␊ - * Reference to a listener to redirect the request to.␊ - */␊ - targetListener?: (SubResource16 | string)␊ - /**␊ - * Url to redirect the request to.␊ - */␊ - targetUrl?: string␊ - /**␊ - * Include path in the redirected url.␊ - */␊ - includePath?: (boolean | string)␊ - /**␊ - * Include query string in the redirected url.␊ - */␊ - includeQueryString?: (boolean | string)␊ - /**␊ - * Request routing specifying redirect configuration.␊ - */␊ - requestRoutingRules?: (SubResource16[] | string)␊ - /**␊ - * Url path maps specifying default redirect configuration.␊ - */␊ - urlPathMaps?: (SubResource16[] | string)␊ - /**␊ - * Path rules specifying redirect configuration.␊ - */␊ - pathRules?: (SubResource16[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application gateway web application firewall configuration.␊ - */␊ - export interface ApplicationGatewayWebApplicationFirewallConfiguration6 {␊ - /**␊ - * Whether the web application firewall is enabled or not.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * Web application firewall mode.␊ - */␊ - firewallMode: (("Detection" | "Prevention") | string)␊ - /**␊ - * The type of the web application firewall rule set. Possible values are: 'OWASP'.␊ - */␊ - ruleSetType: string␊ - /**␊ - * The version of the rule set type.␊ - */␊ - ruleSetVersion: string␊ - /**␊ - * The disabled rule groups.␊ - */␊ - disabledRuleGroups?: (ApplicationGatewayFirewallDisabledRuleGroup6[] | string)␊ - /**␊ - * Whether allow WAF to check request Body.␊ - */␊ - requestBodyCheck?: (boolean | string)␊ - /**␊ - * Maximum request body size for WAF.␊ - */␊ - maxRequestBodySize?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allows to disable rules within a rule group or an entire rule group.␊ - */␊ - export interface ApplicationGatewayFirewallDisabledRuleGroup6 {␊ - /**␊ - * The name of the rule group that will be disabled.␊ - */␊ - ruleGroupName: string␊ - /**␊ - * The list of rules that will be disabled. If null, all rules of the rule group will be disabled.␊ - */␊ - rules?: (number[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application Gateway autoscale configuration.␊ - */␊ - export interface ApplicationGatewayAutoscaleConfiguration {␊ - /**␊ - * Autoscale bounds␊ - */␊ - bounds: (ApplicationGatewayAutoscaleBounds | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application Gateway autoscale bounds on number of Application Gateway instance.␊ - */␊ - export interface ApplicationGatewayAutoscaleBounds {␊ - /**␊ - * Lower bound on number of Application Gateway instances.␊ - */␊ - min: (number | string)␊ - /**␊ - * Upper bound on number of Application Gateway instances.␊ - */␊ - max: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/applicationSecurityGroups␊ - */␊ - export interface ApplicationSecurityGroups5 {␊ - name: string␊ - type: "Microsoft.Network/applicationSecurityGroups"␊ - apiVersion: "2018-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the application security group.␊ - */␊ - properties: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/azureFirewalls␊ - */␊ - export interface AzureFirewalls {␊ - name: string␊ - type: "Microsoft.Network/azureFirewalls"␊ - apiVersion: "2018-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (AzureFirewallPropertiesFormat | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Azure Firewall.␊ - */␊ - export interface AzureFirewallPropertiesFormat {␊ - /**␊ - * Collection of application rule collections used by a Azure Firewall.␊ - */␊ - applicationRuleCollections?: (AzureFirewallApplicationRuleCollection[] | string)␊ - /**␊ - * Collection of network rule collections used by a Azure Firewall.␊ - */␊ - networkRuleCollections?: (AzureFirewallNetworkRuleCollection[] | string)␊ - /**␊ - * IP configuration of the Azure Firewall resource.␊ - */␊ - ipConfigurations?: (AzureFirewallIPConfiguration[] | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: (("Succeeded" | "Updating" | "Deleting" | "Failed") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application rule collection resource␊ - */␊ - export interface AzureFirewallApplicationRuleCollection {␊ - properties?: (AzureFirewallApplicationRuleCollectionPropertiesFormat | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application rule collection.␊ - */␊ - export interface AzureFirewallApplicationRuleCollectionPropertiesFormat {␊ - /**␊ - * Priority of the application rule collection resource.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * The action type of a rule collection␊ - */␊ - action?: (AzureFirewallRCAction | string)␊ - /**␊ - * Collection of rules used by a application rule collection.␊ - */␊ - rules?: (AzureFirewallApplicationRule[] | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: (("Succeeded" | "Updating" | "Deleting" | "Failed") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the AzureFirewallRCAction.␊ - */␊ - export interface AzureFirewallRCAction {␊ - /**␊ - * The type of action.␊ - */␊ - type?: ("Allow" | "Deny")␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of an application rule.␊ - */␊ - export interface AzureFirewallApplicationRule {␊ - /**␊ - * Name of the application rule.␊ - */␊ - name?: string␊ - /**␊ - * Description of the rule.␊ - */␊ - description?: string␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * Array of ApplicationRuleProtocols.␊ - */␊ - protocols?: (AzureFirewallApplicationRuleProtocol[] | string)␊ - /**␊ - * List of URLs for this rule.␊ - */␊ - targetUrls?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application rule protocol.␊ - */␊ - export interface AzureFirewallApplicationRuleProtocol {␊ - /**␊ - * Protocol type.␊ - */␊ - protocolType?: (("Http" | "Https") | string)␊ - /**␊ - * Port number for the protocol, cannot be greater than 64000. This field is optional.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network rule collection resource␊ - */␊ - export interface AzureFirewallNetworkRuleCollection {␊ - properties?: (AzureFirewallNetworkRuleCollectionPropertiesFormat | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the network rule collection.␊ - */␊ - export interface AzureFirewallNetworkRuleCollectionPropertiesFormat {␊ - /**␊ - * Priority of the network rule collection resource.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * The action type of a rule collection␊ - */␊ - action?: (AzureFirewallRCAction | string)␊ - /**␊ - * Collection of rules used by a network rule collection.␊ - */␊ - rules?: (AzureFirewallNetworkRule[] | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: (("Succeeded" | "Updating" | "Deleting" | "Failed") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the network rule.␊ - */␊ - export interface AzureFirewallNetworkRule {␊ - /**␊ - * Name of the network rule.␊ - */␊ - name?: string␊ - /**␊ - * Description of the rule.␊ - */␊ - description?: string␊ - /**␊ - * Array of AzureFirewallNetworkRuleProtocols.␊ - */␊ - protocols?: (("TCP" | "UDP" | "Any" | "ICMP")[] | string)␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * List of destination IP addresses.␊ - */␊ - destinationAddresses?: (string[] | string)␊ - /**␊ - * List of destination ports.␊ - */␊ - destinationPorts?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration of an Azure Firewall.␊ - */␊ - export interface AzureFirewallIPConfiguration {␊ - properties?: (AzureFirewallIPConfigurationPropertiesFormat | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration of an Azure Firewall.␊ - */␊ - export interface AzureFirewallIPConfigurationPropertiesFormat {␊ - /**␊ - * The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * Reference of the subnet resource. This resource must be named 'AzureFirewallSubnet'.␊ - */␊ - subnet?: (SubResource16 | string)␊ - /**␊ - * Reference of the PublicIP resource. This field is a mandatory input.␊ - */␊ - internalPublicIpAddress?: (SubResource16 | string)␊ - /**␊ - * Reference of the PublicIP resource. This field is populated in the output.␊ - */␊ - publicIPAddress?: (SubResource16 | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: (("Succeeded" | "Updating" | "Deleting" | "Failed") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/connections␊ - */␊ - export interface Connections9 {␊ - name: string␊ - type: "Microsoft.Network/connections"␊ - apiVersion: "2018-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway connection.␊ - */␊ - properties: (VirtualNetworkGatewayConnectionPropertiesFormat9 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewayConnection properties␊ - */␊ - export interface VirtualNetworkGatewayConnectionPropertiesFormat9 {␊ - /**␊ - * The authorizationKey.␊ - */␊ - authorizationKey?: string␊ - /**␊ - * The reference to virtual network gateway resource.␊ - */␊ - virtualNetworkGateway1: (SubResource16 | string)␊ - /**␊ - * The reference to virtual network gateway resource.␊ - */␊ - virtualNetworkGateway2?: (SubResource16 | string)␊ - /**␊ - * The reference to local network gateway resource.␊ - */␊ - localNetworkGateway2?: (SubResource16 | string)␊ - /**␊ - * Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.␊ - */␊ - connectionType: (("IPsec" | "Vnet2Vnet" | "ExpressRoute" | "VPNClient") | string)␊ - /**␊ - * The routing weight.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * The IPSec shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The reference to peerings resource.␊ - */␊ - peer?: (SubResource16 | string)␊ - /**␊ - * EnableBgp flag␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * Enable policy-based traffic selectors.␊ - */␊ - usePolicyBasedTrafficSelectors?: (boolean | string)␊ - /**␊ - * The IPSec Policies to be considered by this connection.␊ - */␊ - ipsecPolicies?: (IpsecPolicy6[] | string)␊ - /**␊ - * The resource GUID property of the VirtualNetworkGatewayConnection resource.␊ - */␊ - resourceGuid?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An IPSec Policy configuration for a virtual network gateway connection␊ - */␊ - export interface IpsecPolicy6 {␊ - /**␊ - * The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.␊ - */␊ - saLifeTimeSeconds: (number | string)␊ - /**␊ - * The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.␊ - */␊ - saDataSizeKilobytes: (number | string)␊ - /**␊ - * The IPSec encryption algorithm (IKE phase 1).␊ - */␊ - ipsecEncryption: (("None" | "DES" | "DES3" | "AES128" | "AES192" | "AES256" | "GCMAES128" | "GCMAES192" | "GCMAES256") | string)␊ - /**␊ - * The IPSec integrity algorithm (IKE phase 1).␊ - */␊ - ipsecIntegrity: (("MD5" | "SHA1" | "SHA256" | "GCMAES128" | "GCMAES192" | "GCMAES256") | string)␊ - /**␊ - * The IKE encryption algorithm (IKE phase 2).␊ - */␊ - ikeEncryption: (("DES" | "DES3" | "AES128" | "AES192" | "AES256" | "GCMAES256" | "GCMAES128") | string)␊ - /**␊ - * The IKE integrity algorithm (IKE phase 2).␊ - */␊ - ikeIntegrity: (("MD5" | "SHA1" | "SHA256" | "SHA384" | "GCMAES256" | "GCMAES128") | string)␊ - /**␊ - * The DH Groups used in IKE Phase 1 for initial SA.␊ - */␊ - dhGroup: (("None" | "DHGroup1" | "DHGroup2" | "DHGroup14" | "DHGroup2048" | "ECP256" | "ECP384" | "DHGroup24") | string)␊ - /**␊ - * The Pfs Groups used in IKE Phase 2 for new child SA.␊ - */␊ - pfsGroup: (("None" | "PFS1" | "PFS2" | "PFS2048" | "ECP256" | "ECP384" | "PFS24" | "PFS14" | "PFSMM") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ddosProtectionPlans␊ - */␊ - export interface DdosProtectionPlans1 {␊ - name: string␊ - type: "Microsoft.Network/ddosProtectionPlans"␊ - apiVersion: "2018-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the DDoS protection plan.␊ - */␊ - properties: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits␊ - */␊ - export interface ExpressRouteCircuits3 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits"␊ - apiVersion: "2018-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The SKU.␊ - */␊ - sku?: (ExpressRouteCircuitSku3 | string)␊ - properties: (ExpressRouteCircuitPropertiesFormat3 | string)␊ - resources?: (ExpressRouteCircuitsPeeringsChildResource3 | ExpressRouteCircuitsAuthorizationsChildResource3)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains SKU in an ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitSku3 {␊ - /**␊ - * The name of the SKU.␊ - */␊ - name?: string␊ - /**␊ - * The tier of the SKU. Possible values are 'Standard' and 'Premium'.␊ - */␊ - tier?: (("Standard" | "Premium") | string)␊ - /**␊ - * The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'.␊ - */␊ - family?: (("UnlimitedData" | "MeteredData") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitPropertiesFormat3 {␊ - /**␊ - * Allow classic operations␊ - */␊ - allowClassicOperations?: (boolean | string)␊ - /**␊ - * The CircuitProvisioningState state of the resource.␊ - */␊ - circuitProvisioningState?: string␊ - /**␊ - * The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'.␊ - */␊ - serviceProviderProvisioningState?: (("NotProvisioned" | "Provisioning" | "Provisioned" | "Deprovisioning") | string)␊ - /**␊ - * The list of authorizations.␊ - */␊ - authorizations?: (ExpressRouteCircuitAuthorization3[] | string)␊ - /**␊ - * The list of peerings.␊ - */␊ - peerings?: (ExpressRouteCircuitPeering3[] | string)␊ - /**␊ - * The ServiceKey.␊ - */␊ - serviceKey?: string␊ - /**␊ - * The ServiceProviderNotes.␊ - */␊ - serviceProviderNotes?: string␊ - /**␊ - * The ServiceProviderProperties.␊ - */␊ - serviceProviderProperties?: (ExpressRouteCircuitServiceProviderProperties3 | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authorization in an ExpressRouteCircuit resource.␊ - */␊ - export interface ExpressRouteCircuitAuthorization3 {␊ - properties?: (AuthorizationPropertiesFormat4 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - export interface AuthorizationPropertiesFormat4 {␊ - /**␊ - * The authorization key.␊ - */␊ - authorizationKey?: string␊ - /**␊ - * AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'.␊ - */␊ - authorizationUseStatus?: (("Available" | "InUse") | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peering in an ExpressRouteCircuit resource.␊ - */␊ - export interface ExpressRouteCircuitPeering3 {␊ - properties?: (ExpressRouteCircuitPeeringPropertiesFormat4 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - export interface ExpressRouteCircuitPeeringPropertiesFormat4 {␊ - /**␊ - * The peering type.␊ - */␊ - peeringType?: (("AzurePublicPeering" | "AzurePrivatePeering" | "MicrosoftPeering") | string)␊ - /**␊ - * The peering state.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * The Azure ASN.␊ - */␊ - azureASN?: (number | string)␊ - /**␊ - * The peer ASN.␊ - */␊ - peerASN?: (number | string)␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The primary port.␊ - */␊ - primaryAzurePort?: string␊ - /**␊ - * The secondary port.␊ - */␊ - secondaryAzurePort?: string␊ - /**␊ - * The shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The VLAN ID.␊ - */␊ - vlanId?: (number | string)␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig4 | string)␊ - /**␊ - * Gets peering stats.␊ - */␊ - stats?: (ExpressRouteCircuitStats4 | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - /**␊ - * Gets whether the provider or the customer last modified the peering.␊ - */␊ - lastModifiedBy?: string␊ - /**␊ - * The reference of the RouteFilter resource.␊ - */␊ - routeFilter?: (SubResource16 | string)␊ - /**␊ - * The IPv6 peering configuration.␊ - */␊ - ipv6PeeringConfig?: (Ipv6ExpressRouteCircuitPeeringConfig1 | string)␊ - /**␊ - * The list of circuit connections associated with Azure Private Peering for this circuit.␊ - */␊ - connections?: (ExpressRouteCircuitConnection1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the peering configuration.␊ - */␊ - export interface ExpressRouteCircuitPeeringConfig4 {␊ - /**␊ - * The reference of AdvertisedPublicPrefixes.␊ - */␊ - advertisedPublicPrefixes?: (string[] | string)␊ - /**␊ - * The communities of bgp peering. Specified for microsoft peering␊ - */␊ - advertisedCommunities?: (string[] | string)␊ - /**␊ - * AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'.␊ - */␊ - advertisedPublicPrefixesState?: (("NotConfigured" | "Configuring" | "Configured" | "ValidationNeeded") | string)␊ - /**␊ - * The legacy mode of the peering.␊ - */␊ - legacyMode?: (number | string)␊ - /**␊ - * The CustomerASN of the peering.␊ - */␊ - customerASN?: (number | string)␊ - /**␊ - * The RoutingRegistryName of the configuration.␊ - */␊ - routingRegistryName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains stats associated with the peering.␊ - */␊ - export interface ExpressRouteCircuitStats4 {␊ - /**␊ - * Gets BytesIn of the peering.␊ - */␊ - primarybytesIn?: (number | string)␊ - /**␊ - * Gets BytesOut of the peering.␊ - */␊ - primarybytesOut?: (number | string)␊ - /**␊ - * Gets BytesIn of the peering.␊ - */␊ - secondarybytesIn?: (number | string)␊ - /**␊ - * Gets BytesOut of the peering.␊ - */␊ - secondarybytesOut?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains IPv6 peering config.␊ - */␊ - export interface Ipv6ExpressRouteCircuitPeeringConfig1 {␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig4 | string)␊ - /**␊ - * The reference of the RouteFilter resource.␊ - */␊ - routeFilter?: (SubResource16 | string)␊ - /**␊ - * The state of peering. Possible values are: 'Disabled' and 'Enabled'.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Express Route Circuit Connection in an ExpressRouteCircuitPeering resource.␊ - */␊ - export interface ExpressRouteCircuitConnection1 {␊ - properties?: (ExpressRouteCircuitConnectionPropertiesFormat1 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - export interface ExpressRouteCircuitConnectionPropertiesFormat1 {␊ - /**␊ - * Reference to Express Route Circuit Private Peering Resource of the circuit initiating connection.␊ - */␊ - expressRouteCircuitPeering?: (SubResource16 | string)␊ - /**␊ - * Reference to Express Route Circuit Private Peering Resource of the peered circuit.␊ - */␊ - peerExpressRouteCircuitPeering?: (SubResource16 | string)␊ - /**␊ - * /29 IP address space to carve out Customer addresses for tunnels.␊ - */␊ - addressPrefix?: string␊ - /**␊ - * The authorization key.␊ - */␊ - authorizationKey?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains ServiceProviderProperties in an ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitServiceProviderProperties3 {␊ - /**␊ - * The serviceProviderName.␊ - */␊ - serviceProviderName?: string␊ - /**␊ - * The peering location.␊ - */␊ - peeringLocation?: string␊ - /**␊ - * The BandwidthInMbps.␊ - */␊ - bandwidthInMbps?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings␊ - */␊ - export interface ExpressRouteCircuitsPeeringsChildResource3 {␊ - name: string␊ - type: "peerings"␊ - apiVersion: "2018-04-01"␊ - properties: (ExpressRouteCircuitPeeringPropertiesFormat4 | string)␊ - resources?: ExpressRouteCircuitsPeeringsConnectionsChildResource1[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings/connections␊ - */␊ - export interface ExpressRouteCircuitsPeeringsConnectionsChildResource1 {␊ - name: string␊ - type: "connections"␊ - apiVersion: "2018-04-01"␊ - properties: (ExpressRouteCircuitConnectionPropertiesFormat1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/authorizations␊ - */␊ - export interface ExpressRouteCircuitsAuthorizationsChildResource3 {␊ - name: string␊ - type: "authorizations"␊ - apiVersion: "2018-04-01"␊ - properties: (AuthorizationPropertiesFormat4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/authorizations␊ - */␊ - export interface ExpressRouteCircuitsAuthorizations4 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/authorizations"␊ - apiVersion: "2018-04-01"␊ - properties: (AuthorizationPropertiesFormat4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings␊ - */␊ - export interface ExpressRouteCircuitsPeerings4 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/peerings"␊ - apiVersion: "2018-04-01"␊ - properties: (ExpressRouteCircuitPeeringPropertiesFormat4 | string)␊ - resources?: ExpressRouteCircuitsPeeringsConnectionsChildResource1[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings/connections␊ - */␊ - export interface ExpressRouteCircuitsPeeringsConnections1 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/peerings/connections"␊ - apiVersion: "2018-04-01"␊ - properties: (ExpressRouteCircuitConnectionPropertiesFormat1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections␊ - */␊ - export interface ExpressRouteCrossConnections1 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCrossConnections"␊ - apiVersion: "2018-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (ExpressRouteCrossConnectionProperties1 | string)␊ - resources?: ExpressRouteCrossConnectionsPeeringsChildResource1[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ExpressRouteCrossConnection.␊ - */␊ - export interface ExpressRouteCrossConnectionProperties1 {␊ - /**␊ - * The peering location of the ExpressRoute circuit.␊ - */␊ - peeringLocation?: string␊ - /**␊ - * The circuit bandwidth In Mbps.␊ - */␊ - bandwidthInMbps?: (number | string)␊ - /**␊ - * The ExpressRouteCircuit␊ - */␊ - expressRouteCircuit?: (ExpressRouteCircuitReference | string)␊ - /**␊ - * The provisioning state of the circuit in the connectivity provider system. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned'.␊ - */␊ - serviceProviderProvisioningState?: (("NotProvisioned" | "Provisioning" | "Provisioned" | "Deprovisioning") | string)␊ - /**␊ - * Additional read only notes set by the connectivity provider.␊ - */␊ - serviceProviderNotes?: string␊ - /**␊ - * The list of peerings.␊ - */␊ - peerings?: (ExpressRouteCrossConnectionPeering1[] | string)␊ - [k: string]: unknown␊ - }␊ - export interface ExpressRouteCircuitReference {␊ - /**␊ - * Corresponding Express Route Circuit Id.␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peering in an ExpressRoute Cross Connection resource.␊ - */␊ - export interface ExpressRouteCrossConnectionPeering1 {␊ - properties?: (ExpressRouteCrossConnectionPeeringProperties1 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - export interface ExpressRouteCrossConnectionPeeringProperties1 {␊ - /**␊ - * The peering type.␊ - */␊ - peeringType?: (("AzurePublicPeering" | "AzurePrivatePeering" | "MicrosoftPeering") | string)␊ - /**␊ - * The peering state.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * The peer ASN.␊ - */␊ - peerASN?: (number | string)␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The VLAN ID.␊ - */␊ - vlanId?: (number | string)␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig4 | string)␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - /**␊ - * Gets whether the provider or the customer last modified the peering.␊ - */␊ - lastModifiedBy?: string␊ - /**␊ - * The IPv6 peering configuration.␊ - */␊ - ipv6PeeringConfig?: (Ipv6ExpressRouteCircuitPeeringConfig1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections/peerings␊ - */␊ - export interface ExpressRouteCrossConnectionsPeeringsChildResource1 {␊ - name: string␊ - type: "peerings"␊ - apiVersion: "2018-04-01"␊ - properties: (ExpressRouteCrossConnectionPeeringProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections/peerings␊ - */␊ - export interface ExpressRouteCrossConnectionsPeerings1 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCrossConnections/peerings"␊ - apiVersion: "2018-04-01"␊ - properties: (ExpressRouteCrossConnectionPeeringProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers␊ - */␊ - export interface LoadBalancers18 {␊ - name: string␊ - type: "Microsoft.Network/loadBalancers"␊ - apiVersion: "2018-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The load balancer SKU.␊ - */␊ - sku?: (LoadBalancerSku6 | string)␊ - /**␊ - * Properties of load balancer.␊ - */␊ - properties: (LoadBalancerPropertiesFormat10 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: LoadBalancersInboundNatRulesChildResource6[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a load balancer␊ - */␊ - export interface LoadBalancerSku6 {␊ - /**␊ - * Name of a load balancer SKU.␊ - */␊ - name?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer.␊ - */␊ - export interface LoadBalancerPropertiesFormat10 {␊ - /**␊ - * Object representing the frontend IPs to be used for the load balancer␊ - */␊ - frontendIPConfigurations?: (FrontendIPConfiguration9[] | string)␊ - /**␊ - * Collection of backend address pools used by a load balancer␊ - */␊ - backendAddressPools?: (BackendAddressPool10[] | string)␊ - /**␊ - * Object collection representing the load balancing rules Gets the provisioning ␊ - */␊ - loadBalancingRules?: (LoadBalancingRule10[] | string)␊ - /**␊ - * Collection of probe objects used in the load balancer␊ - */␊ - probes?: (Probe10[] | string)␊ - /**␊ - * Collection of inbound NAT Rules used by a load balancer. Defining inbound NAT rules on your load balancer is mutually exclusive with defining an inbound NAT pool. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an Inbound NAT pool. They have to reference individual inbound NAT rules.␊ - */␊ - inboundNatRules?: (InboundNatRule11[] | string)␊ - /**␊ - * Defines an external port range for inbound NAT to a single backend port on NICs associated with a load balancer. Inbound NAT rules are created automatically for each NIC associated with the Load Balancer using an external port from this range. Defining an Inbound NAT pool on your Load Balancer is mutually exclusive with defining inbound Nat rules. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an inbound NAT pool. They have to reference individual inbound NAT rules.␊ - */␊ - inboundNatPools?: (InboundNatPool11[] | string)␊ - /**␊ - * The outbound NAT rules.␊ - */␊ - outboundNatRules?: (OutboundNatRule10[] | string)␊ - /**␊ - * The resource GUID property of the load balancer resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP address of the load balancer.␊ - */␊ - export interface FrontendIPConfiguration9 {␊ - /**␊ - * Properties of the load balancer probe.␊ - */␊ - properties?: (FrontendIPConfigurationPropertiesFormat9 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP Configuration of the load balancer.␊ - */␊ - export interface FrontendIPConfigurationPropertiesFormat9 {␊ - /**␊ - * The private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The Private IP allocation method. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * The reference of the subnet resource.␊ - */␊ - subnet?: (SubResource16 | string)␊ - /**␊ - * The reference of the Public IP resource.␊ - */␊ - publicIPAddress?: (SubResource16 | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Pool of backend IP addresses.␊ - */␊ - export interface BackendAddressPool10 {␊ - /**␊ - * Properties of load balancer backend address pool.␊ - */␊ - properties?: (BackendAddressPoolPropertiesFormat10 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the backend address pool.␊ - */␊ - export interface BackendAddressPoolPropertiesFormat10 {␊ - /**␊ - * Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A load balancing rule for a load balancer.␊ - */␊ - export interface LoadBalancingRule10 {␊ - /**␊ - * Properties of load balancer load balancing rule.␊ - */␊ - properties?: (LoadBalancingRulePropertiesFormat10 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer.␊ - */␊ - export interface LoadBalancingRulePropertiesFormat10 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource16 | string)␊ - /**␊ - * A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs.␊ - */␊ - backendAddressPool?: (SubResource16 | string)␊ - /**␊ - * The reference of the load balancer probe used by the load balancing rule.␊ - */␊ - probe?: (SubResource16 | string)␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'.␊ - */␊ - loadDistribution?: (("Default" | "SourceIP" | "SourceIPProtocol") | string)␊ - /**␊ - * The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 0 and 65534. Note that value 0 enables "Any Port"␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port"␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule.␊ - */␊ - disableOutboundSnat?: (boolean | string)␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A load balancer probe.␊ - */␊ - export interface Probe10 {␊ - /**␊ - * Properties of load balancer probe.␊ - */␊ - properties?: (ProbePropertiesFormat10 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Load balancer probe resource.␊ - */␊ - export interface ProbePropertiesFormat10 {␊ - /**␊ - * The protocol of the end point. Possible values are: 'Http', 'Tcp', or 'Https'. If 'Tcp' is specified, a received ACK is required for the probe to be successful. If 'Http' or 'Https' is specified, a 200 OK response from the specifies URI is required for the probe to be successful.␊ - */␊ - protocol: (("Http" | "Tcp" | "Https") | string)␊ - /**␊ - * The port for communicating the probe. Possible values range from 1 to 65535, inclusive.␊ - */␊ - port: (number | string)␊ - /**␊ - * The interval, in seconds, for how frequently to probe the endpoint for health status. Typically, the interval is slightly less than half the allocated timeout period (in seconds) which allows two full probes before taking the instance out of rotation. The default value is 15, the minimum value is 5.␊ - */␊ - intervalInSeconds?: (number | string)␊ - /**␊ - * The number of probes where if no response, will result in stopping further traffic from being delivered to the endpoint. This values allows endpoints to be taken out of rotation faster or slower than the typical times used in Azure.␊ - */␊ - numberOfProbes: (number | string)␊ - /**␊ - * The URI used for requesting health status from the VM. Path is required if a protocol is set to http. Otherwise, it is not allowed. There is no default value.␊ - */␊ - requestPath?: string␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT rule of the load balancer.␊ - */␊ - export interface InboundNatRule11 {␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties?: (InboundNatRulePropertiesFormat10 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the inbound NAT rule.␊ - */␊ - export interface InboundNatRulePropertiesFormat10 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource16 | string)␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values range from 1 to 65534.␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * The port used for the internal endpoint. Acceptable values range from 1 to 65535.␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT pool of the load balancer.␊ - */␊ - export interface InboundNatPool11 {␊ - /**␊ - * Properties of load balancer inbound nat pool.␊ - */␊ - properties?: (InboundNatPoolPropertiesFormat10 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Inbound NAT pool.␊ - */␊ - export interface InboundNatPoolPropertiesFormat10 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource16 | string)␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65534.␊ - */␊ - frontendPortRangeStart: (number | string)␊ - /**␊ - * The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65535.␊ - */␊ - frontendPortRangeEnd: (number | string)␊ - /**␊ - * The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound NAT pool of the load balancer.␊ - */␊ - export interface OutboundNatRule10 {␊ - /**␊ - * Properties of load balancer outbound nat rule.␊ - */␊ - properties?: (OutboundNatRulePropertiesFormat10 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound NAT pool of the load balancer.␊ - */␊ - export interface OutboundNatRulePropertiesFormat10 {␊ - /**␊ - * The number of outbound ports to be used for NAT.␊ - */␊ - allocatedOutboundPorts?: (number | string)␊ - /**␊ - * The Frontend IP addresses of the load balancer.␊ - */␊ - frontendIPConfigurations?: (SubResource16[] | string)␊ - /**␊ - * A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs.␊ - */␊ - backendAddressPool: (SubResource16 | string)␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers/inboundNatRules␊ - */␊ - export interface LoadBalancersInboundNatRulesChildResource6 {␊ - name: string␊ - type: "inboundNatRules"␊ - apiVersion: "2018-04-01"␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties: (InboundNatRulePropertiesFormat10 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers/inboundNatRules␊ - */␊ - export interface LoadBalancersInboundNatRules6 {␊ - name: string␊ - type: "Microsoft.Network/loadBalancers/inboundNatRules"␊ - apiVersion: "2018-04-01"␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties: (InboundNatRulePropertiesFormat10 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/localNetworkGateways␊ - */␊ - export interface LocalNetworkGateways9 {␊ - name: string␊ - type: "Microsoft.Network/localNetworkGateways"␊ - apiVersion: "2018-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the local network gateway.␊ - */␊ - properties: (LocalNetworkGatewayPropertiesFormat9 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * LocalNetworkGateway properties␊ - */␊ - export interface LocalNetworkGatewayPropertiesFormat9 {␊ - /**␊ - * Local network site address space.␊ - */␊ - localNetworkAddressSpace?: (AddressSpace18 | string)␊ - /**␊ - * IP address of local network gateway.␊ - */␊ - gatewayIpAddress?: string␊ - /**␊ - * Local network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings8 | string)␊ - /**␊ - * The resource GUID property of the LocalNetworkGateway resource.␊ - */␊ - resourceGuid?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.␊ - */␊ - export interface AddressSpace18 {␊ - /**␊ - * A list of address blocks reserved for this virtual network in CIDR notation.␊ - */␊ - addressPrefixes: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * BGP settings details␊ - */␊ - export interface BgpSettings8 {␊ - /**␊ - * The BGP speaker's ASN.␊ - */␊ - asn?: (number | string)␊ - /**␊ - * The BGP peering address and BGP identifier of this BGP speaker.␊ - */␊ - bgpPeeringAddress?: string␊ - /**␊ - * The weight added to routes learned from this BGP speaker.␊ - */␊ - peerWeight?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces␊ - */␊ - export interface NetworkInterfaces19 {␊ - name: string␊ - type: "Microsoft.Network/networkInterfaces"␊ - apiVersion: "2018-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network interface.␊ - */␊ - properties: (NetworkInterfacePropertiesFormat10 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NetworkInterface properties. ␊ - */␊ - export interface NetworkInterfacePropertiesFormat10 {␊ - /**␊ - * The reference of a virtual machine.␊ - */␊ - virtualMachine?: (SubResource16 | string)␊ - /**␊ - * The reference of the NetworkSecurityGroup resource.␊ - */␊ - networkSecurityGroup?: (SubResource16 | string)␊ - /**␊ - * A list of IPConfigurations of the network interface.␊ - */␊ - ipConfigurations: (NetworkInterfaceIPConfiguration9[] | string)␊ - /**␊ - * The DNS settings in network interface.␊ - */␊ - dnsSettings?: (NetworkInterfaceDnsSettings18 | string)␊ - /**␊ - * The MAC address of the network interface.␊ - */␊ - macAddress?: string␊ - /**␊ - * Gets whether this is a primary network interface on a virtual machine.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * If the network interface is accelerated networking enabled.␊ - */␊ - enableAcceleratedNetworking?: (boolean | string)␊ - /**␊ - * Indicates whether IP forwarding is enabled on this network interface.␊ - */␊ - enableIPForwarding?: (boolean | string)␊ - /**␊ - * The resource GUID property of the network interface resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IPConfiguration in a network interface.␊ - */␊ - export interface NetworkInterfaceIPConfiguration9 {␊ - /**␊ - * Network interface IP configuration properties.␊ - */␊ - properties?: (NetworkInterfaceIPConfigurationPropertiesFormat9 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration.␊ - */␊ - export interface NetworkInterfaceIPConfigurationPropertiesFormat9 {␊ - /**␊ - * The reference of ApplicationGatewayBackendAddressPool resource.␊ - */␊ - applicationGatewayBackendAddressPools?: (SubResource16[] | string)␊ - /**␊ - * The reference of LoadBalancerBackendAddressPool resource.␊ - */␊ - loadBalancerBackendAddressPools?: (SubResource16[] | string)␊ - /**␊ - * A list of references of LoadBalancerInboundNatRules.␊ - */␊ - loadBalancerInboundNatRules?: (SubResource16[] | string)␊ - /**␊ - * Private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * Defines how a private IP address is assigned. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Available from Api-Version 2016-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.␊ - */␊ - privateIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * Subnet bound to the IP configuration.␊ - */␊ - subnet?: (SubResource16 | string)␊ - /**␊ - * Gets whether this is a primary customer address on the network interface.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * Public IP address bound to the IP configuration.␊ - */␊ - publicIPAddress?: (SubResource16 | string)␊ - /**␊ - * Application security groups in which the IP configuration is included.␊ - */␊ - applicationSecurityGroups?: (SubResource16[] | string)␊ - /**␊ - * The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DNS settings of a network interface.␊ - */␊ - export interface NetworkInterfaceDnsSettings18 {␊ - /**␊ - * List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only value in dnsServers collection.␊ - */␊ - dnsServers?: (string[] | string)␊ - /**␊ - * If the VM that uses this NIC is part of an Availability Set, then this list will have the union of all DNS servers from all NICs that are part of the Availability Set. This property is what is configured on each of those VMs.␊ - */␊ - appliedDnsServers?: (string[] | string)␊ - /**␊ - * Relative DNS name for this NIC used for internal communications between VMs in the same virtual network.␊ - */␊ - internalDnsNameLabel?: string␊ - /**␊ - * Fully qualified DNS name supporting internal communications between VMs in the same virtual network.␊ - */␊ - internalFqdn?: string␊ - /**␊ - * Even if internalDnsNameLabel is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internalDomainNameSuffix.␊ - */␊ - internalDomainNameSuffix?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups␊ - */␊ - export interface NetworkSecurityGroups18 {␊ - name: string␊ - type: "Microsoft.Network/networkSecurityGroups"␊ - apiVersion: "2018-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network security group␊ - */␊ - properties: (NetworkSecurityGroupPropertiesFormat10 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: NetworkSecurityGroupsSecurityRulesChildResource10[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network Security Group resource.␊ - */␊ - export interface NetworkSecurityGroupPropertiesFormat10 {␊ - /**␊ - * A collection of security rules of the network security group.␊ - */␊ - securityRules?: (SecurityRule10[] | string)␊ - /**␊ - * The default security rules of network security group.␊ - */␊ - defaultSecurityRules?: (SecurityRule10[] | string)␊ - /**␊ - * The resource GUID property of the network security group resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network security rule.␊ - */␊ - export interface SecurityRule10 {␊ - /**␊ - * Properties of the security rule␊ - */␊ - properties?: (SecurityRulePropertiesFormat10 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Security rule resource.␊ - */␊ - export interface SecurityRulePropertiesFormat10 {␊ - /**␊ - * A description for this rule. Restricted to 140 chars.␊ - */␊ - description?: string␊ - /**␊ - * Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'.␊ - */␊ - protocol: (("Tcp" | "Udp" | "*") | string)␊ - /**␊ - * The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.␊ - */␊ - sourcePortRange?: string␊ - /**␊ - * The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.␊ - */␊ - destinationPortRange?: string␊ - /**␊ - * The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. ␊ - */␊ - sourceAddressPrefix?: string␊ - /**␊ - * The CIDR or source IP ranges.␊ - */␊ - sourceAddressPrefixes?: (string[] | string)␊ - /**␊ - * The application security group specified as source.␊ - */␊ - sourceApplicationSecurityGroups?: (SubResource16[] | string)␊ - /**␊ - * The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used.␊ - */␊ - destinationAddressPrefix?: string␊ - /**␊ - * The destination address prefixes. CIDR or destination IP ranges.␊ - */␊ - destinationAddressPrefixes?: (string[] | string)␊ - /**␊ - * The application security group specified as destination.␊ - */␊ - destinationApplicationSecurityGroups?: (SubResource16[] | string)␊ - /**␊ - * The source port ranges.␊ - */␊ - sourcePortRanges?: (string[] | string)␊ - /**␊ - * The destination port ranges.␊ - */␊ - destinationPortRanges?: (string[] | string)␊ - /**␊ - * The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'.␊ - */␊ - access: (("Allow" | "Deny") | string)␊ - /**␊ - * The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.␊ - */␊ - priority: (number | string)␊ - /**␊ - * The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. Possible values are: 'Inbound' and 'Outbound'.␊ - */␊ - direction: (("Inbound" | "Outbound") | string)␊ - /**␊ - * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRulesChildResource10 {␊ - name: string␊ - type: "securityRules"␊ - apiVersion: "2018-04-01"␊ - /**␊ - * Properties of the security rule␊ - */␊ - properties: (SecurityRulePropertiesFormat10 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRules10 {␊ - name: string␊ - type: "Microsoft.Network/networkSecurityGroups/securityRules"␊ - apiVersion: "2018-04-01"␊ - /**␊ - * Properties of the security rule␊ - */␊ - properties: (SecurityRulePropertiesFormat10 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers␊ - */␊ - export interface NetworkWatchers {␊ - name: string␊ - type: "Microsoft.Network/networkWatchers"␊ - apiVersion: "2018-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - properties: ({␊ - [k: string]: unknown␊ - } | string)␊ - resources?: (NetworkWatchersConnectionMonitorsChildResource | NetworkWatchersPacketCapturesChildResource)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/connectionMonitors␊ - */␊ - export interface NetworkWatchersConnectionMonitorsChildResource {␊ - name: string␊ - type: "connectionMonitors"␊ - apiVersion: "2018-04-01"␊ - /**␊ - * Connection monitor location.␊ - */␊ - location?: string␊ - /**␊ - * Connection monitor tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (ConnectionMonitorParameters | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters that define the operation to create a connection monitor.␊ - */␊ - export interface ConnectionMonitorParameters {␊ - source: (ConnectionMonitorSource | string)␊ - destination: (ConnectionMonitorDestination | string)␊ - /**␊ - * Determines if the connection monitor will start automatically once created.␊ - */␊ - autoStart?: (boolean | string)␊ - /**␊ - * Monitoring interval in seconds.␊ - */␊ - monitoringIntervalInSeconds?: ((number & string) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the source of connection monitor.␊ - */␊ - export interface ConnectionMonitorSource {␊ - /**␊ - * The ID of the resource used as the source by connection monitor.␊ - */␊ - resourceId: string␊ - /**␊ - * The source port used by connection monitor.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the destination of connection monitor.␊ - */␊ - export interface ConnectionMonitorDestination {␊ - /**␊ - * The ID of the resource used as the destination by connection monitor.␊ - */␊ - resourceId?: string␊ - /**␊ - * Address of the connection monitor destination (IP or domain name).␊ - */␊ - address?: string␊ - /**␊ - * The destination port used by connection monitor.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/packetCaptures␊ - */␊ - export interface NetworkWatchersPacketCapturesChildResource {␊ - name: string␊ - type: "packetCaptures"␊ - apiVersion: "2018-04-01"␊ - properties: (PacketCaptureParameters | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters that define the create packet capture operation.␊ - */␊ - export interface PacketCaptureParameters {␊ - /**␊ - * The ID of the targeted resource, only VM is currently supported.␊ - */␊ - target: string␊ - /**␊ - * Number of bytes captured per packet, the remaining bytes are truncated.␊ - */␊ - bytesToCapturePerPacket?: ((number & string) | string)␊ - /**␊ - * Maximum size of the capture output.␊ - */␊ - totalBytesPerSession?: ((number & string) | string)␊ - /**␊ - * Maximum duration of the capture session in seconds.␊ - */␊ - timeLimitInSeconds?: ((number & string) | string)␊ - storageLocation: (PacketCaptureStorageLocation | string)␊ - filters?: (PacketCaptureFilter[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the storage location for a packet capture session.␊ - */␊ - export interface PacketCaptureStorageLocation {␊ - /**␊ - * The ID of the storage account to save the packet capture session. Required if no local file path is provided.␊ - */␊ - storageId?: string␊ - /**␊ - * The URI of the storage path to save the packet capture. Must be a well-formed URI describing the location to save the packet capture.␊ - */␊ - storagePath?: string␊ - /**␊ - * A valid local path on the targeting VM. Must include the name of the capture file (*.cap). For linux virtual machine it must start with /var/captures. Required if no storage ID is provided, otherwise optional.␊ - */␊ - filePath?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Filter that is applied to packet capture request. Multiple filters can be applied.␊ - */␊ - export interface PacketCaptureFilter {␊ - /**␊ - * Protocol to be filtered on.␊ - */␊ - protocol?: (("TCP" | "UDP" | "Any") | string)␊ - /**␊ - * Local IP Address to be filtered on. Notation: "127.0.0.1" for single address entry. "127.0.0.1-127.0.0.255" for range. "127.0.0.1;127.0.0.5"? for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.␊ - */␊ - localIPAddress?: string␊ - /**␊ - * Local IP Address to be filtered on. Notation: "127.0.0.1" for single address entry. "127.0.0.1-127.0.0.255" for range. "127.0.0.1;127.0.0.5;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.␊ - */␊ - remoteIPAddress?: string␊ - /**␊ - * Local port to be filtered on. Notation: "80" for single port entry."80-85" for range. "80;443;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.␊ - */␊ - localPort?: string␊ - /**␊ - * Remote port to be filtered on. Notation: "80" for single port entry."80-85" for range. "80;443;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.␊ - */␊ - remotePort?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/connectionMonitors␊ - */␊ - export interface NetworkWatchersConnectionMonitors {␊ - name: string␊ - type: "Microsoft.Network/networkWatchers/connectionMonitors"␊ - apiVersion: "2018-04-01"␊ - /**␊ - * Connection monitor location.␊ - */␊ - location?: string␊ - /**␊ - * Connection monitor tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (ConnectionMonitorParameters | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/packetCaptures␊ - */␊ - export interface NetworkWatchersPacketCaptures {␊ - name: string␊ - type: "Microsoft.Network/networkWatchers/packetCaptures"␊ - apiVersion: "2018-04-01"␊ - properties: (PacketCaptureParameters | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/publicIPAddresses␊ - */␊ - export interface PublicIPAddresses18 {␊ - name: string␊ - type: "Microsoft.Network/publicIPAddresses"␊ - apiVersion: "2018-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The public IP address SKU.␊ - */␊ - sku?: (PublicIPAddressSku6 | string)␊ - /**␊ - * Public IP address properties.␊ - */␊ - properties: (PublicIPAddressPropertiesFormat9 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a public IP address␊ - */␊ - export interface PublicIPAddressSku6 {␊ - /**␊ - * Name of a public IP address SKU.␊ - */␊ - name?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Public IP address properties.␊ - */␊ - export interface PublicIPAddressPropertiesFormat9 {␊ - /**␊ - * The public IP allocation method. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - publicIPAllocationMethod: (("Static" | "Dynamic") | string)␊ - /**␊ - * The public IP address version. Possible values are: 'IPv4' and 'IPv6'.␊ - */␊ - publicIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The FQDN of the DNS record associated with the public IP address.␊ - */␊ - dnsSettings?: (PublicIPAddressDnsSettings17 | string)␊ - /**␊ - * The list of tags associated with the public IP address.␊ - */␊ - ipTags?: (IpTag3[] | string)␊ - /**␊ - * The IP address associated with the public IP address resource.␊ - */␊ - ipAddress?: string␊ - /**␊ - * The idle timeout of the public IP address.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * The resource GUID property of the public IP resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains FQDN of the DNS record associated with the public IP address␊ - */␊ - export interface PublicIPAddressDnsSettings17 {␊ - /**␊ - * Gets or sets the Domain name label.The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.␊ - */␊ - domainNameLabel: string␊ - /**␊ - * Gets the FQDN, Fully qualified domain name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone.␊ - */␊ - fqdn?: string␊ - /**␊ - * Gets or Sets the Reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN. ␊ - */␊ - reverseFqdn?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains the IpTag associated with the public IP address␊ - */␊ - export interface IpTag3 {␊ - /**␊ - * Gets or sets the ipTag type: Example FirstPartyUsage.␊ - */␊ - ipTagType?: string␊ - /**␊ - * Gets or sets value of the IpTag associated with the public IP. Example SQL, Storage etc␊ - */␊ - tag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeFilters␊ - */␊ - export interface RouteFilters {␊ - name: string␊ - type: "Microsoft.Network/routeFilters"␊ - apiVersion: "2018-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (RouteFilterPropertiesFormat | string)␊ - resources?: RouteFiltersRouteFilterRulesChildResource[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Filter Resource␊ - */␊ - export interface RouteFilterPropertiesFormat {␊ - /**␊ - * Collection of RouteFilterRules contained within a route filter.␊ - */␊ - rules?: (RouteFilterRule[] | string)␊ - /**␊ - * A collection of references to express route circuit peerings.␊ - */␊ - peerings?: (SubResource16[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Filter Rule Resource␊ - */␊ - export interface RouteFilterRule {␊ - properties?: (RouteFilterRulePropertiesFormat | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Filter Rule Resource␊ - */␊ - export interface RouteFilterRulePropertiesFormat {␊ - /**␊ - * The access type of the rule. Valid values are: 'Allow', 'Deny'.␊ - */␊ - access: (("Allow" | "Deny") | string)␊ - /**␊ - * The rule type of the rule. Valid value is: 'Community'␊ - */␊ - routeFilterRuleType: ("Community" | string)␊ - /**␊ - * The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020']␊ - */␊ - communities: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeFilters/routeFilterRules␊ - */␊ - export interface RouteFiltersRouteFilterRulesChildResource {␊ - name: string␊ - type: "routeFilterRules"␊ - apiVersion: "2018-04-01"␊ - properties: (RouteFilterRulePropertiesFormat | string)␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeFilters/routeFilterRules␊ - */␊ - export interface RouteFiltersRouteFilterRules {␊ - name: string␊ - type: "Microsoft.Network/routeFilters/routeFilterRules"␊ - apiVersion: "2018-04-01"␊ - properties: (RouteFilterRulePropertiesFormat | string)␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables␊ - */␊ - export interface RouteTables18 {␊ - name: string␊ - type: "Microsoft.Network/routeTables"␊ - apiVersion: "2018-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the route table.␊ - */␊ - properties: (RouteTablePropertiesFormat10 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: RouteTablesRoutesChildResource10[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Table resource␊ - */␊ - export interface RouteTablePropertiesFormat10 {␊ - /**␊ - * Collection of routes contained within a route table.␊ - */␊ - routes?: (Route10[] | string)␊ - /**␊ - * Gets or sets whether to disable the routes learned by BGP on that route table. True means disable.␊ - */␊ - disableBgpRoutePropagation?: (boolean | string)␊ - /**␊ - * The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource␊ - */␊ - export interface Route10 {␊ - /**␊ - * Properties of the route.␊ - */␊ - properties?: (RoutePropertiesFormat10 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource␊ - */␊ - export interface RoutePropertiesFormat10 {␊ - /**␊ - * The destination CIDR to which the route applies.␊ - */␊ - addressPrefix: string␊ - /**␊ - * The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'.␊ - */␊ - nextHopType: (("VirtualNetworkGateway" | "VnetLocal" | "Internet" | "VirtualAppliance" | "None" | "HyperNetGateway") | string)␊ - /**␊ - * The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.␊ - */␊ - nextHopIpAddress?: string␊ - /**␊ - * The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutesChildResource10 {␊ - name: string␊ - type: "routes"␊ - apiVersion: "2018-04-01"␊ - /**␊ - * Properties of the route.␊ - */␊ - properties: (RoutePropertiesFormat10 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutes10 {␊ - name: string␊ - type: "Microsoft.Network/routeTables/routes"␊ - apiVersion: "2018-04-01"␊ - /**␊ - * Properties of the route.␊ - */␊ - properties: (RoutePropertiesFormat10 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualHubs␊ - */␊ - export interface VirtualHubs {␊ - name: string␊ - type: "Microsoft.Network/virtualHubs"␊ - apiVersion: "2018-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (VirtualHubProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VirtualHub␊ - */␊ - export interface VirtualHubProperties {␊ - /**␊ - * The VirtualWAN to which the VirtualHub belongs␊ - */␊ - virtualWan?: (SubResource16 | string)␊ - /**␊ - * list of all vnet connections with this VirtualHub.␊ - */␊ - hubVirtualNetworkConnections?: (HubVirtualNetworkConnection[] | string)␊ - /**␊ - * Address-prefix for this VirtualHub.␊ - */␊ - addressPrefix?: string␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: (("Succeeded" | "Updating" | "Deleting" | "Failed") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HubVirtualNetworkConnection Resource.␊ - */␊ - export interface HubVirtualNetworkConnection {␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties?: (HubVirtualNetworkConnectionProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for HubVirtualNetworkConnection␊ - */␊ - export interface HubVirtualNetworkConnectionProperties {␊ - /**␊ - * Reference to the remote virtual network.␊ - */␊ - remoteVirtualNetwork?: (SubResource16 | string)␊ - /**␊ - * VirtualHub to RemoteVnet transit to enabled or not.␊ - */␊ - allowHubToRemoteVnetTransit?: (boolean | string)␊ - /**␊ - * Allow RemoteVnet to use Virtual Hub's gateways.␊ - */␊ - allowRemoteVnetToUseHubVnetGateways?: (boolean | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: (("Succeeded" | "Updating" | "Deleting" | "Failed") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworkGateways␊ - */␊ - export interface VirtualNetworkGateways9 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworkGateways"␊ - apiVersion: "2018-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway.␊ - */␊ - properties: (VirtualNetworkGatewayPropertiesFormat9 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGateway properties␊ - */␊ - export interface VirtualNetworkGatewayPropertiesFormat9 {␊ - /**␊ - * IP configurations for virtual network gateway.␊ - */␊ - ipConfigurations?: (VirtualNetworkGatewayIPConfiguration8[] | string)␊ - /**␊ - * The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'.␊ - */␊ - gatewayType?: (("Vpn" | "ExpressRoute") | string)␊ - /**␊ - * The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'.␊ - */␊ - vpnType?: (("PolicyBased" | "RouteBased") | string)␊ - /**␊ - * Whether BGP is enabled for this virtual network gateway or not.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * ActiveActive flag␊ - */␊ - activeActive?: (boolean | string)␊ - /**␊ - * The reference of the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting.␊ - */␊ - gatewayDefaultSite?: (SubResource16 | string)␊ - /**␊ - * The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.␊ - */␊ - sku?: (VirtualNetworkGatewaySku8 | string)␊ - /**␊ - * The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations.␊ - */␊ - vpnClientConfiguration?: (VpnClientConfiguration8 | string)␊ - /**␊ - * Virtual network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings8 | string)␊ - /**␊ - * The resource GUID property of the VirtualNetworkGateway resource.␊ - */␊ - resourceGuid?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration for virtual network gateway␊ - */␊ - export interface VirtualNetworkGatewayIPConfiguration8 {␊ - /**␊ - * Properties of the virtual network gateway ip configuration.␊ - */␊ - properties?: (VirtualNetworkGatewayIPConfigurationPropertiesFormat8 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of VirtualNetworkGatewayIPConfiguration␊ - */␊ - export interface VirtualNetworkGatewayIPConfigurationPropertiesFormat8 {␊ - /**␊ - * The private IP allocation method. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * The reference of the subnet resource.␊ - */␊ - subnet?: (SubResource16 | string)␊ - /**␊ - * The reference of the public IP resource.␊ - */␊ - publicIPAddress?: (SubResource16 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewaySku details␊ - */␊ - export interface VirtualNetworkGatewaySku8 {␊ - /**␊ - * Gateway SKU name.␊ - */␊ - name?: (("Basic" | "HighPerformance" | "Standard" | "UltraPerformance" | "VpnGw1" | "VpnGw2" | "VpnGw3" | "VpnGw1AZ" | "VpnGw2AZ" | "VpnGw3AZ" | "ErGw1AZ" | "ErGw2AZ" | "ErGw3AZ") | string)␊ - /**␊ - * Gateway SKU tier.␊ - */␊ - tier?: (("Basic" | "HighPerformance" | "Standard" | "UltraPerformance" | "VpnGw1" | "VpnGw2" | "VpnGw3" | "VpnGw1AZ" | "VpnGw2AZ" | "VpnGw3AZ" | "ErGw1AZ" | "ErGw2AZ" | "ErGw3AZ") | string)␊ - /**␊ - * The capacity.␊ - */␊ - capacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnClientConfiguration for P2S client.␊ - */␊ - export interface VpnClientConfiguration8 {␊ - /**␊ - * The reference of the address space resource which represents Address space for P2S VpnClient.␊ - */␊ - vpnClientAddressPool?: (AddressSpace18 | string)␊ - /**␊ - * VpnClientRootCertificate for virtual network gateway.␊ - */␊ - vpnClientRootCertificates?: (VpnClientRootCertificate8[] | string)␊ - /**␊ - * VpnClientRevokedCertificate for Virtual network gateway.␊ - */␊ - vpnClientRevokedCertificates?: (VpnClientRevokedCertificate8[] | string)␊ - /**␊ - * VpnClientProtocols for Virtual network gateway.␊ - */␊ - vpnClientProtocols?: (("IkeV2" | "SSTP" | "OpenVPN")[] | string)␊ - /**␊ - * VpnClientIpsecPolicies for virtual network gateway P2S client.␊ - */␊ - vpnClientIpsecPolicies?: (IpsecPolicy6[] | string)␊ - /**␊ - * The radius server address property of the VirtualNetworkGateway resource for vpn client connection.␊ - */␊ - radiusServerAddress?: string␊ - /**␊ - * The radius secret property of the VirtualNetworkGateway resource for vpn client connection.␊ - */␊ - radiusServerSecret?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client root certificate of virtual network gateway␊ - */␊ - export interface VpnClientRootCertificate8 {␊ - /**␊ - * Properties of the vpn client root certificate.␊ - */␊ - properties: (VpnClientRootCertificatePropertiesFormat8 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of application gateway␊ - */␊ - export interface VpnClientRootCertificatePropertiesFormat8 {␊ - /**␊ - * The certificate public data.␊ - */␊ - publicCertData: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client revoked certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRevokedCertificate8 {␊ - /**␊ - * Properties of the vpn client revoked certificate.␊ - */␊ - properties?: (VpnClientRevokedCertificatePropertiesFormat8 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the revoked VPN client certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRevokedCertificatePropertiesFormat8 {␊ - /**␊ - * The revoked VPN client certificate thumbprint.␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks␊ - */␊ - export interface VirtualNetworks18 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks"␊ - apiVersion: "2018-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network.␊ - */␊ - properties: (VirtualNetworkPropertiesFormat10 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: (VirtualNetworksVirtualNetworkPeeringsChildResource7 | VirtualNetworksSubnetsChildResource10)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the virtual network.␊ - */␊ - export interface VirtualNetworkPropertiesFormat10 {␊ - /**␊ - * The AddressSpace that contains an array of IP address ranges that can be used by subnets.␊ - */␊ - addressSpace: (AddressSpace18 | string)␊ - /**␊ - * The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network.␊ - */␊ - dhcpOptions?: (DhcpOptions18 | string)␊ - /**␊ - * A list of subnets in a Virtual Network.␊ - */␊ - subnets?: (Subnet20[] | string)␊ - /**␊ - * A list of peerings in a Virtual Network.␊ - */␊ - virtualNetworkPeerings?: (VirtualNetworkPeering15[] | string)␊ - /**␊ - * The resourceGuid property of the Virtual Network resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - /**␊ - * Indicates if DDoS protection is enabled for all the protected resources in the virtual network. It requires a DDoS protection plan associated with the resource.␊ - */␊ - enableDdosProtection?: (boolean | string)␊ - /**␊ - * Indicates if VM protection is enabled for all the subnets in the virtual network.␊ - */␊ - enableVmProtection?: (boolean | string)␊ - /**␊ - * The DDoS protection plan associated with the virtual network.␊ - */␊ - ddosProtectionPlan?: (SubResource16 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DhcpOptions contains an array of DNS servers available to VMs deployed in the virtual network. Standard DHCP option for a subnet overrides VNET DHCP options.␊ - */␊ - export interface DhcpOptions18 {␊ - /**␊ - * The list of DNS servers IP addresses.␊ - */␊ - dnsServers: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Subnet in a virtual network resource.␊ - */␊ - export interface Subnet20 {␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties?: (SubnetPropertiesFormat10 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the subnet.␊ - */␊ - export interface SubnetPropertiesFormat10 {␊ - /**␊ - * The address prefix for the subnet.␊ - */␊ - addressPrefix: string␊ - /**␊ - * The reference of the NetworkSecurityGroup resource.␊ - */␊ - networkSecurityGroup?: (SubResource16 | string)␊ - /**␊ - * The reference of the RouteTable resource.␊ - */␊ - routeTable?: (SubResource16 | string)␊ - /**␊ - * An array of service endpoints.␊ - */␊ - serviceEndpoints?: (ServiceEndpointPropertiesFormat6[] | string)␊ - /**␊ - * Gets an array of references to the external resources using subnet.␊ - */␊ - resourceNavigationLinks?: (ResourceNavigationLink7[] | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The service endpoint properties.␊ - */␊ - export interface ServiceEndpointPropertiesFormat6 {␊ - /**␊ - * The type of the endpoint service.␊ - */␊ - service?: string␊ - /**␊ - * A list of locations.␊ - */␊ - locations?: (string[] | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ResourceNavigationLink resource.␊ - */␊ - export interface ResourceNavigationLink7 {␊ - /**␊ - * Resource navigation link properties format.␊ - */␊ - properties?: (ResourceNavigationLinkFormat7 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ResourceNavigationLink.␊ - */␊ - export interface ResourceNavigationLinkFormat7 {␊ - /**␊ - * Resource type of the linked resource.␊ - */␊ - linkedResourceType?: string␊ - /**␊ - * Link to the external resource␊ - */␊ - link?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peerings in a virtual network resource.␊ - */␊ - export interface VirtualNetworkPeering15 {␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties?: (VirtualNetworkPeeringPropertiesFormat7 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - export interface VirtualNetworkPeeringPropertiesFormat7 {␊ - /**␊ - * Whether the VMs in the linked virtual network space would be able to access all the VMs in local Virtual network space.␊ - */␊ - allowVirtualNetworkAccess?: (boolean | string)␊ - /**␊ - * Whether the forwarded traffic from the VMs in the remote virtual network will be allowed/disallowed.␊ - */␊ - allowForwardedTraffic?: (boolean | string)␊ - /**␊ - * If gateway links can be used in remote virtual networking to link to this virtual network.␊ - */␊ - allowGatewayTransit?: (boolean | string)␊ - /**␊ - * If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway.␊ - */␊ - useRemoteGateways?: (boolean | string)␊ - /**␊ - * The reference of the remote virtual network. The remote virtual network can be in the same or different region (preview). See here to register for the preview and learn more (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering).␊ - */␊ - remoteVirtualNetwork: (SubResource16 | string)␊ - /**␊ - * The reference of the remote virtual network address space.␊ - */␊ - remoteAddressSpace?: (AddressSpace18 | string)␊ - /**␊ - * The status of the virtual network peering. Possible values are 'Initiated', 'Connected', and 'Disconnected'.␊ - */␊ - peeringState?: (("Initiated" | "Connected" | "Disconnected") | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/virtualNetworkPeerings␊ - */␊ - export interface VirtualNetworksVirtualNetworkPeeringsChildResource7 {␊ - name: string␊ - type: "virtualNetworkPeerings"␊ - apiVersion: "2018-04-01"␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties: (VirtualNetworkPeeringPropertiesFormat7 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnetsChildResource10 {␊ - name: string␊ - type: "subnets"␊ - apiVersion: "2018-04-01"␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties: (SubnetPropertiesFormat10 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnets9 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks/subnets"␊ - apiVersion: "2018-04-01"␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties: (SubnetPropertiesFormat10 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/virtualNetworkPeerings␊ - */␊ - export interface VirtualNetworksVirtualNetworkPeerings6 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks/virtualNetworkPeerings"␊ - apiVersion: "2018-04-01"␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties: (VirtualNetworkPeeringPropertiesFormat7 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualWans␊ - */␊ - export interface VirtualWans {␊ - name: string␊ - type: "Microsoft.Network/virtualWans"␊ - apiVersion: "2018-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (VirtualWanProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VirtualWAN␊ - */␊ - export interface VirtualWanProperties {␊ - /**␊ - * Vpn encryption to be disabled or not.␊ - */␊ - disableVpnEncryption?: (boolean | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: (("Succeeded" | "Updating" | "Deleting" | "Failed") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnGateways␊ - */␊ - export interface VpnGateways {␊ - name: string␊ - type: "Microsoft.Network/vpnGateways"␊ - apiVersion: "2018-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (VpnGatewayProperties | string)␊ - resources?: VpnGatewaysVpnConnectionsChildResource[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnGateway␊ - */␊ - export interface VpnGatewayProperties {␊ - /**␊ - * The VirtualHub to which the gateway belongs␊ - */␊ - virtualHub?: (SubResource16 | string)␊ - /**␊ - * list of all vpn connections to the gateway.␊ - */␊ - connections?: (VpnConnection[] | string)␊ - /**␊ - * Local network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings8 | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: (("Succeeded" | "Updating" | "Deleting" | "Failed") | string)␊ - /**␊ - * The policies applied to this vpn gateway.␊ - */␊ - policies?: (Policies | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnConnection Resource.␊ - */␊ - export interface VpnConnection {␊ - properties?: (VpnConnectionProperties | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnConnection␊ - */␊ - export interface VpnConnectionProperties {␊ - /**␊ - * Id of the connected vpn site.␊ - */␊ - remoteVpnSite?: (SubResource16 | string)␊ - /**␊ - * routing weight for vpn connection.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * The connection status.␊ - */␊ - connectionStatus?: (("Unknown" | "Connecting" | "Connected" | "NotConnected") | string)␊ - /**␊ - * SharedKey for the vpn connection.␊ - */␊ - sharedKey?: string␊ - /**␊ - * EnableBgp flag␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * The IPSec Policies to be considered by this connection.␊ - */␊ - ipsecPolicies?: (IpsecPolicy6[] | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: (("Succeeded" | "Updating" | "Deleting" | "Failed") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Policies for vpn gateway.␊ - */␊ - export interface Policies {␊ - /**␊ - * True if branch to branch traffic is allowed.␊ - */␊ - allowBranchToBranchTraffic?: (boolean | string)␊ - /**␊ - * True if Vnet to Vnet traffic is allowed.␊ - */␊ - allowVnetToVnetTraffic?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnGateways/vpnConnections␊ - */␊ - export interface VpnGatewaysVpnConnectionsChildResource {␊ - name: string␊ - type: "vpnConnections"␊ - apiVersion: "2018-04-01"␊ - properties: (VpnConnectionProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnGateways/vpnConnections␊ - */␊ - export interface VpnGatewaysVpnConnections {␊ - name: string␊ - type: "Microsoft.Network/vpnGateways/vpnConnections"␊ - apiVersion: "2018-04-01"␊ - properties: (VpnConnectionProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnSites␊ - */␊ - export interface VpnSites {␊ - name: string␊ - type: "Microsoft.Network/vpnSites"␊ - apiVersion: "2018-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (VpnSiteProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnSite␊ - */␊ - export interface VpnSiteProperties {␊ - /**␊ - * The VirtualWAN to which the vpnSite belongs␊ - */␊ - virtualWAN?: (SubResource16 | string)␊ - /**␊ - * The device properties␊ - */␊ - deviceProperties?: (DeviceProperties | string)␊ - /**␊ - * The ip-address for the vpn-site.␊ - */␊ - ipAddress?: string␊ - /**␊ - * The key for vpn-site that can be used for connections.␊ - */␊ - siteKey?: string␊ - /**␊ - * The AddressSpace that contains an array of IP address ranges.␊ - */␊ - addressSpace?: (AddressSpace18 | string)␊ - /**␊ - * The set of bgp properties.␊ - */␊ - bgpProperties?: (BgpSettings8 | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: (("Succeeded" | "Updating" | "Deleting" | "Failed") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * List of properties of the device.␊ - */␊ - export interface DeviceProperties {␊ - /**␊ - * Name of the device Vendor.␊ - */␊ - deviceVendor?: string␊ - /**␊ - * Model of the device.␊ - */␊ - deviceModel?: string␊ - /**␊ - * Link speed.␊ - */␊ - linkSpeedInMbps?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/applicationGateways␊ - */␊ - export interface ApplicationGateways10 {␊ - name: string␊ - type: "Microsoft.Network/applicationGateways"␊ - apiVersion: "2018-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (ApplicationGatewayPropertiesFormat10 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * A list of availability zones denoting where the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application gateway.␊ - */␊ - export interface ApplicationGatewayPropertiesFormat10 {␊ - /**␊ - * SKU of the application gateway resource.␊ - */␊ - sku?: (ApplicationGatewaySku10 | string)␊ - /**␊ - * SSL policy of the application gateway resource.␊ - */␊ - sslPolicy?: (ApplicationGatewaySslPolicy7 | string)␊ - /**␊ - * Subnets of application the gateway resource.␊ - */␊ - gatewayIPConfigurations?: (ApplicationGatewayIPConfiguration10[] | string)␊ - /**␊ - * Authentication certificates of the application gateway resource.␊ - */␊ - authenticationCertificates?: (ApplicationGatewayAuthenticationCertificate7[] | string)␊ - /**␊ - * SSL certificates of the application gateway resource.␊ - */␊ - sslCertificates?: (ApplicationGatewaySslCertificate10[] | string)␊ - /**␊ - * Frontend IP addresses of the application gateway resource.␊ - */␊ - frontendIPConfigurations?: (ApplicationGatewayFrontendIPConfiguration10[] | string)␊ - /**␊ - * Frontend ports of the application gateway resource.␊ - */␊ - frontendPorts?: (ApplicationGatewayFrontendPort10[] | string)␊ - /**␊ - * Probes of the application gateway resource.␊ - */␊ - probes?: (ApplicationGatewayProbe9[] | string)␊ - /**␊ - * Backend address pool of the application gateway resource.␊ - */␊ - backendAddressPools?: (ApplicationGatewayBackendAddressPool10[] | string)␊ - /**␊ - * Backend http settings of the application gateway resource.␊ - */␊ - backendHttpSettingsCollection?: (ApplicationGatewayBackendHttpSettings10[] | string)␊ - /**␊ - * Http listeners of the application gateway resource.␊ - */␊ - httpListeners?: (ApplicationGatewayHttpListener10[] | string)␊ - /**␊ - * URL path map of the application gateway resource.␊ - */␊ - urlPathMaps?: (ApplicationGatewayUrlPathMap9[] | string)␊ - /**␊ - * Request routing rules of the application gateway resource.␊ - */␊ - requestRoutingRules?: (ApplicationGatewayRequestRoutingRule10[] | string)␊ - /**␊ - * Redirect configurations of the application gateway resource.␊ - */␊ - redirectConfigurations?: (ApplicationGatewayRedirectConfiguration7[] | string)␊ - /**␊ - * Web application firewall configuration.␊ - */␊ - webApplicationFirewallConfiguration?: (ApplicationGatewayWebApplicationFirewallConfiguration7 | string)␊ - /**␊ - * Whether HTTP2 is enabled on the application gateway resource.␊ - */␊ - enableHttp2?: (boolean | string)␊ - /**␊ - * Whether FIPS is enabled on the application gateway resource.␊ - */␊ - enableFips?: (boolean | string)␊ - /**␊ - * Autoscale Configuration.␊ - */␊ - autoscaleConfiguration?: (ApplicationGatewayAutoscaleConfiguration1 | string)␊ - /**␊ - * Resource GUID property of the application gateway resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of an application gateway␊ - */␊ - export interface ApplicationGatewaySku10 {␊ - /**␊ - * Name of an application gateway SKU.␊ - */␊ - name?: (("Standard_Small" | "Standard_Medium" | "Standard_Large" | "WAF_Medium" | "WAF_Large" | "Standard_v2" | "WAF_v2") | string)␊ - /**␊ - * Tier of an application gateway.␊ - */␊ - tier?: (("Standard" | "WAF" | "Standard_v2" | "WAF_v2") | string)␊ - /**␊ - * Capacity (instance count) of an application gateway.␊ - */␊ - capacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application Gateway Ssl policy.␊ - */␊ - export interface ApplicationGatewaySslPolicy7 {␊ - /**␊ - * Ssl protocols to be disabled on application gateway.␊ - */␊ - disabledSslProtocols?: (("TLSv1_0" | "TLSv1_1" | "TLSv1_2")[] | string)␊ - /**␊ - * Type of Ssl Policy.␊ - */␊ - policyType?: (("Predefined" | "Custom") | string)␊ - /**␊ - * Name of Ssl predefined policy.␊ - */␊ - policyName?: (("AppGwSslPolicy20150501" | "AppGwSslPolicy20170401" | "AppGwSslPolicy20170401S") | string)␊ - /**␊ - * Ssl cipher suites to be enabled in the specified order to application gateway.␊ - */␊ - cipherSuites?: (("TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384" | "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256" | "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA" | "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA" | "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384" | "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256" | "TLS_DHE_RSA_WITH_AES_256_CBC_SHA" | "TLS_DHE_RSA_WITH_AES_128_CBC_SHA" | "TLS_RSA_WITH_AES_256_GCM_SHA384" | "TLS_RSA_WITH_AES_128_GCM_SHA256" | "TLS_RSA_WITH_AES_256_CBC_SHA256" | "TLS_RSA_WITH_AES_128_CBC_SHA256" | "TLS_RSA_WITH_AES_256_CBC_SHA" | "TLS_RSA_WITH_AES_128_CBC_SHA" | "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384" | "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256" | "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384" | "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256" | "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA" | "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA" | "TLS_DHE_DSS_WITH_AES_256_CBC_SHA256" | "TLS_DHE_DSS_WITH_AES_128_CBC_SHA256" | "TLS_DHE_DSS_WITH_AES_256_CBC_SHA" | "TLS_DHE_DSS_WITH_AES_128_CBC_SHA" | "TLS_RSA_WITH_3DES_EDE_CBC_SHA" | "TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA" | "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256" | "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384")[] | string)␊ - /**␊ - * Minimum version of Ssl protocol to be supported on application gateway.␊ - */␊ - minProtocolVersion?: (("TLSv1_0" | "TLSv1_1" | "TLSv1_2") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed.␊ - */␊ - export interface ApplicationGatewayIPConfiguration10 {␊ - properties?: (ApplicationGatewayIPConfigurationPropertiesFormat10 | string)␊ - /**␊ - * Name of the IP configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayIPConfigurationPropertiesFormat10 {␊ - /**␊ - * Reference of the subnet resource. A subnet from where application gateway gets its private address.␊ - */␊ - subnet?: (SubResource17 | string)␊ - /**␊ - * Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Reference to another subresource.␊ - */␊ - export interface SubResource17 {␊ - /**␊ - * Resource ID.␊ - */␊ - id: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authentication certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewayAuthenticationCertificate7 {␊ - properties?: (ApplicationGatewayAuthenticationCertificatePropertiesFormat7 | string)␊ - /**␊ - * Name of the authentication certificate that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authentication certificates properties of an application gateway.␊ - */␊ - export interface ApplicationGatewayAuthenticationCertificatePropertiesFormat7 {␊ - /**␊ - * Certificate public data.␊ - */␊ - data?: string␊ - /**␊ - * Provisioning state of the authentication certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSL certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewaySslCertificate10 {␊ - properties?: (ApplicationGatewaySslCertificatePropertiesFormat10 | string)␊ - /**␊ - * Name of the SSL certificate that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewaySslCertificatePropertiesFormat10 {␊ - /**␊ - * Base-64 encoded pfx certificate. Only applicable in PUT Request.␊ - */␊ - data?: string␊ - /**␊ - * Password for the pfx file specified in data. Only applicable in PUT request.␊ - */␊ - password?: string␊ - /**␊ - * Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request.␊ - */␊ - publicCertData?: string␊ - /**␊ - * Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendIPConfiguration10 {␊ - properties?: (ApplicationGatewayFrontendIPConfigurationPropertiesFormat10 | string)␊ - /**␊ - * Name of the frontend IP configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendIPConfigurationPropertiesFormat10 {␊ - /**␊ - * PrivateIPAddress of the network interface IP Configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * PrivateIP allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Reference of the subnet resource.␊ - */␊ - subnet?: (SubResource17 | string)␊ - /**␊ - * Reference of the PublicIP resource.␊ - */␊ - publicIPAddress?: (SubResource17 | string)␊ - /**␊ - * Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend port of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendPort10 {␊ - properties?: (ApplicationGatewayFrontendPortPropertiesFormat10 | string)␊ - /**␊ - * Name of the frontend port that is unique within an Application Gateway␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend port of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendPortPropertiesFormat10 {␊ - /**␊ - * Frontend port␊ - */␊ - port?: (number | string)␊ - /**␊ - * Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Probe of the application gateway.␊ - */␊ - export interface ApplicationGatewayProbe9 {␊ - properties?: (ApplicationGatewayProbePropertiesFormat9 | string)␊ - /**␊ - * Name of the probe that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of probe of an application gateway.␊ - */␊ - export interface ApplicationGatewayProbePropertiesFormat9 {␊ - /**␊ - * The protocol used for the probe. Possible values are 'Http' and 'Https'.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Host name to send the probe to.␊ - */␊ - host?: string␊ - /**␊ - * Relative path of probe. Valid path starts from '/'. Probe is sent to ://:␊ - */␊ - path?: string␊ - /**␊ - * The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - interval?: (number | string)␊ - /**␊ - * the probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - timeout?: (number | string)␊ - /**␊ - * The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20.␊ - */␊ - unhealthyThreshold?: (number | string)␊ - /**␊ - * Whether the host header should be picked from the backend http settings. Default value is false.␊ - */␊ - pickHostNameFromBackendHttpSettings?: (boolean | string)␊ - /**␊ - * Minimum number of servers that are always marked healthy. Default value is 0.␊ - */␊ - minServers?: (number | string)␊ - /**␊ - * Criterion for classifying a healthy probe response.␊ - */␊ - match?: (ApplicationGatewayProbeHealthResponseMatch7 | string)␊ - /**␊ - * Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application gateway probe health response match␊ - */␊ - export interface ApplicationGatewayProbeHealthResponseMatch7 {␊ - /**␊ - * Body that must be contained in the health response. Default value is empty.␊ - */␊ - body?: string␊ - /**␊ - * Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399.␊ - */␊ - statusCodes?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend Address Pool of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddressPool10 {␊ - properties?: (ApplicationGatewayBackendAddressPoolPropertiesFormat10 | string)␊ - /**␊ - * Name of the backend address pool that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend Address Pool of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddressPoolPropertiesFormat10 {␊ - /**␊ - * Collection of references to IPs defined in network interfaces.␊ - */␊ - backendIPConfigurations?: (SubResource17[] | string)␊ - /**␊ - * Backend addresses␊ - */␊ - backendAddresses?: (ApplicationGatewayBackendAddress10[] | string)␊ - /**␊ - * Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddress10 {␊ - /**␊ - * Fully qualified domain name (FQDN).␊ - */␊ - fqdn?: string␊ - /**␊ - * IP address␊ - */␊ - ipAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address pool settings of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendHttpSettings10 {␊ - properties?: (ApplicationGatewayBackendHttpSettingsPropertiesFormat10 | string)␊ - /**␊ - * Name of the backend http settings that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend address pool settings of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendHttpSettingsPropertiesFormat10 {␊ - /**␊ - * The destination port on the backend.␊ - */␊ - port?: (number | string)␊ - /**␊ - * The protocol used to communicate with the backend. Possible values are 'Http' and 'Https'.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Cookie based affinity.␊ - */␊ - cookieBasedAffinity?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Request timeout in seconds. Application Gateway will fail the request if response is not received within RequestTimeout. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - requestTimeout?: (number | string)␊ - /**␊ - * Probe resource of an application gateway.␊ - */␊ - probe?: (SubResource17 | string)␊ - /**␊ - * Array of references to application gateway authentication certificates.␊ - */␊ - authenticationCertificates?: (SubResource17[] | string)␊ - /**␊ - * Connection draining of the backend http settings resource.␊ - */␊ - connectionDraining?: (ApplicationGatewayConnectionDraining7 | string)␊ - /**␊ - * Host header to be sent to the backend servers.␊ - */␊ - hostName?: string␊ - /**␊ - * Whether to pick host header should be picked from the host name of the backend server. Default value is false.␊ - */␊ - pickHostNameFromBackendAddress?: (boolean | string)␊ - /**␊ - * Cookie name to use for the affinity cookie.␊ - */␊ - affinityCookieName?: string␊ - /**␊ - * Whether the probe is enabled. Default value is false.␊ - */␊ - probeEnabled?: (boolean | string)␊ - /**␊ - * Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null.␊ - */␊ - path?: string␊ - /**␊ - * Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Connection draining allows open connections to a backend server to be active for a specified time after the backend server got removed from the configuration.␊ - */␊ - export interface ApplicationGatewayConnectionDraining7 {␊ - /**␊ - * Whether connection draining is enabled or not.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds.␊ - */␊ - drainTimeoutInSec: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http listener of an application gateway.␊ - */␊ - export interface ApplicationGatewayHttpListener10 {␊ - properties?: (ApplicationGatewayHttpListenerPropertiesFormat10 | string)␊ - /**␊ - * Name of the HTTP listener that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of HTTP listener of an application gateway.␊ - */␊ - export interface ApplicationGatewayHttpListenerPropertiesFormat10 {␊ - /**␊ - * Frontend IP configuration resource of an application gateway.␊ - */␊ - frontendIPConfiguration?: (SubResource17 | string)␊ - /**␊ - * Frontend port resource of an application gateway.␊ - */␊ - frontendPort?: (SubResource17 | string)␊ - /**␊ - * Protocol of the HTTP listener. Possible values are 'Http' and 'Https'.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Host name of HTTP listener.␊ - */␊ - hostName?: string␊ - /**␊ - * SSL certificate resource of an application gateway.␊ - */␊ - sslCertificate?: (SubResource17 | string)␊ - /**␊ - * Applicable only if protocol is https. Enables SNI for multi-hosting.␊ - */␊ - requireServerNameIndication?: (boolean | string)␊ - /**␊ - * Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * UrlPathMaps give a url path to the backend mapping information for PathBasedRouting.␊ - */␊ - export interface ApplicationGatewayUrlPathMap9 {␊ - properties?: (ApplicationGatewayUrlPathMapPropertiesFormat9 | string)␊ - /**␊ - * Name of the URL path map that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of UrlPathMap of the application gateway.␊ - */␊ - export interface ApplicationGatewayUrlPathMapPropertiesFormat9 {␊ - /**␊ - * Default backend address pool resource of URL path map.␊ - */␊ - defaultBackendAddressPool?: (SubResource17 | string)␊ - /**␊ - * Default backend http settings resource of URL path map.␊ - */␊ - defaultBackendHttpSettings?: (SubResource17 | string)␊ - /**␊ - * Default redirect configuration resource of URL path map.␊ - */␊ - defaultRedirectConfiguration?: (SubResource17 | string)␊ - /**␊ - * Path rule of URL path map resource.␊ - */␊ - pathRules?: (ApplicationGatewayPathRule9[] | string)␊ - /**␊ - * Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Path rule of URL path map of an application gateway.␊ - */␊ - export interface ApplicationGatewayPathRule9 {␊ - properties?: (ApplicationGatewayPathRulePropertiesFormat9 | string)␊ - /**␊ - * Name of the path rule that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of path rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayPathRulePropertiesFormat9 {␊ - /**␊ - * Path rules of URL path map.␊ - */␊ - paths?: (string[] | string)␊ - /**␊ - * Backend address pool resource of URL path map path rule.␊ - */␊ - backendAddressPool?: (SubResource17 | string)␊ - /**␊ - * Backend http settings resource of URL path map path rule.␊ - */␊ - backendHttpSettings?: (SubResource17 | string)␊ - /**␊ - * Redirect configuration resource of URL path map path rule.␊ - */␊ - redirectConfiguration?: (SubResource17 | string)␊ - /**␊ - * Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Request routing rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayRequestRoutingRule10 {␊ - properties?: (ApplicationGatewayRequestRoutingRulePropertiesFormat10 | string)␊ - /**␊ - * Name of the request routing rule that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of request routing rule of the application gateway.␊ - */␊ - export interface ApplicationGatewayRequestRoutingRulePropertiesFormat10 {␊ - /**␊ - * Rule type.␊ - */␊ - ruleType?: (("Basic" | "PathBasedRouting") | string)␊ - /**␊ - * Backend address pool resource of the application gateway. ␊ - */␊ - backendAddressPool?: (SubResource17 | string)␊ - /**␊ - * Backend http settings resource of the application gateway.␊ - */␊ - backendHttpSettings?: (SubResource17 | string)␊ - /**␊ - * Http listener resource of the application gateway. ␊ - */␊ - httpListener?: (SubResource17 | string)␊ - /**␊ - * URL path map resource of the application gateway.␊ - */␊ - urlPathMap?: (SubResource17 | string)␊ - /**␊ - * Redirect configuration resource of the application gateway.␊ - */␊ - redirectConfiguration?: (SubResource17 | string)␊ - /**␊ - * Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Redirect configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayRedirectConfiguration7 {␊ - properties?: (ApplicationGatewayRedirectConfigurationPropertiesFormat7 | string)␊ - /**␊ - * Name of the redirect configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of redirect configuration of the application gateway.␊ - */␊ - export interface ApplicationGatewayRedirectConfigurationPropertiesFormat7 {␊ - /**␊ - * Supported http redirection types - Permanent, Temporary, Found, SeeOther.␊ - */␊ - redirectType?: (("Permanent" | "Found" | "SeeOther" | "Temporary") | string)␊ - /**␊ - * Reference to a listener to redirect the request to.␊ - */␊ - targetListener?: (SubResource17 | string)␊ - /**␊ - * Url to redirect the request to.␊ - */␊ - targetUrl?: string␊ - /**␊ - * Include path in the redirected url.␊ - */␊ - includePath?: (boolean | string)␊ - /**␊ - * Include query string in the redirected url.␊ - */␊ - includeQueryString?: (boolean | string)␊ - /**␊ - * Request routing specifying redirect configuration.␊ - */␊ - requestRoutingRules?: (SubResource17[] | string)␊ - /**␊ - * Url path maps specifying default redirect configuration.␊ - */␊ - urlPathMaps?: (SubResource17[] | string)␊ - /**␊ - * Path rules specifying redirect configuration.␊ - */␊ - pathRules?: (SubResource17[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application gateway web application firewall configuration.␊ - */␊ - export interface ApplicationGatewayWebApplicationFirewallConfiguration7 {␊ - /**␊ - * Whether the web application firewall is enabled or not.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * Web application firewall mode.␊ - */␊ - firewallMode: (("Detection" | "Prevention") | string)␊ - /**␊ - * The type of the web application firewall rule set. Possible values are: 'OWASP'.␊ - */␊ - ruleSetType: string␊ - /**␊ - * The version of the rule set type.␊ - */␊ - ruleSetVersion: string␊ - /**␊ - * The disabled rule groups.␊ - */␊ - disabledRuleGroups?: (ApplicationGatewayFirewallDisabledRuleGroup7[] | string)␊ - /**␊ - * Whether allow WAF to check request Body.␊ - */␊ - requestBodyCheck?: (boolean | string)␊ - /**␊ - * Maximum request body size for WAF.␊ - */␊ - maxRequestBodySize?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allows to disable rules within a rule group or an entire rule group.␊ - */␊ - export interface ApplicationGatewayFirewallDisabledRuleGroup7 {␊ - /**␊ - * The name of the rule group that will be disabled.␊ - */␊ - ruleGroupName: string␊ - /**␊ - * The list of rules that will be disabled. If null, all rules of the rule group will be disabled.␊ - */␊ - rules?: (number[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application Gateway autoscale configuration.␊ - */␊ - export interface ApplicationGatewayAutoscaleConfiguration1 {␊ - /**␊ - * Autoscale bounds␊ - */␊ - bounds: (ApplicationGatewayAutoscaleBounds1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application Gateway autoscale bounds on number of Application Gateway instance.␊ - */␊ - export interface ApplicationGatewayAutoscaleBounds1 {␊ - /**␊ - * Lower bound on number of Application Gateway instances.␊ - */␊ - min: (number | string)␊ - /**␊ - * Upper bound on number of Application Gateway instances.␊ - */␊ - max: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/applicationSecurityGroups␊ - */␊ - export interface ApplicationSecurityGroups6 {␊ - name: string␊ - type: "Microsoft.Network/applicationSecurityGroups"␊ - apiVersion: "2018-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the application security group.␊ - */␊ - properties: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/azureFirewalls␊ - */␊ - export interface AzureFirewalls1 {␊ - name: string␊ - type: "Microsoft.Network/azureFirewalls"␊ - apiVersion: "2018-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (AzureFirewallPropertiesFormat1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Azure Firewall.␊ - */␊ - export interface AzureFirewallPropertiesFormat1 {␊ - /**␊ - * Collection of application rule collections used by a Azure Firewall.␊ - */␊ - applicationRuleCollections?: (AzureFirewallApplicationRuleCollection1[] | string)␊ - /**␊ - * Collection of network rule collections used by a Azure Firewall.␊ - */␊ - networkRuleCollections?: (AzureFirewallNetworkRuleCollection1[] | string)␊ - /**␊ - * IP configuration of the Azure Firewall resource.␊ - */␊ - ipConfigurations?: (AzureFirewallIPConfiguration1[] | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: (("Succeeded" | "Updating" | "Deleting" | "Failed") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application rule collection resource␊ - */␊ - export interface AzureFirewallApplicationRuleCollection1 {␊ - properties?: (AzureFirewallApplicationRuleCollectionPropertiesFormat1 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application rule collection.␊ - */␊ - export interface AzureFirewallApplicationRuleCollectionPropertiesFormat1 {␊ - /**␊ - * Priority of the application rule collection resource.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * The action type of a rule collection␊ - */␊ - action?: (AzureFirewallRCAction1 | string)␊ - /**␊ - * Collection of rules used by a application rule collection.␊ - */␊ - rules?: (AzureFirewallApplicationRule1[] | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: (("Succeeded" | "Updating" | "Deleting" | "Failed") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the AzureFirewallRCAction.␊ - */␊ - export interface AzureFirewallRCAction1 {␊ - /**␊ - * The type of action.␊ - */␊ - type?: ("Allow" | "Deny")␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of an application rule.␊ - */␊ - export interface AzureFirewallApplicationRule1 {␊ - /**␊ - * Name of the application rule.␊ - */␊ - name?: string␊ - /**␊ - * Description of the rule.␊ - */␊ - description?: string␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * Array of ApplicationRuleProtocols.␊ - */␊ - protocols?: (AzureFirewallApplicationRuleProtocol1[] | string)␊ - /**␊ - * List of URLs for this rule.␊ - */␊ - targetUrls?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application rule protocol.␊ - */␊ - export interface AzureFirewallApplicationRuleProtocol1 {␊ - /**␊ - * Protocol type.␊ - */␊ - protocolType?: (("Http" | "Https") | string)␊ - /**␊ - * Port number for the protocol, cannot be greater than 64000. This field is optional.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network rule collection resource␊ - */␊ - export interface AzureFirewallNetworkRuleCollection1 {␊ - properties?: (AzureFirewallNetworkRuleCollectionPropertiesFormat1 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the network rule collection.␊ - */␊ - export interface AzureFirewallNetworkRuleCollectionPropertiesFormat1 {␊ - /**␊ - * Priority of the network rule collection resource.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * The action type of a rule collection␊ - */␊ - action?: (AzureFirewallRCAction1 | string)␊ - /**␊ - * Collection of rules used by a network rule collection.␊ - */␊ - rules?: (AzureFirewallNetworkRule1[] | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: (("Succeeded" | "Updating" | "Deleting" | "Failed") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the network rule.␊ - */␊ - export interface AzureFirewallNetworkRule1 {␊ - /**␊ - * Name of the network rule.␊ - */␊ - name?: string␊ - /**␊ - * Description of the rule.␊ - */␊ - description?: string␊ - /**␊ - * Array of AzureFirewallNetworkRuleProtocols.␊ - */␊ - protocols?: (("TCP" | "UDP" | "Any" | "ICMP")[] | string)␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * List of destination IP addresses.␊ - */␊ - destinationAddresses?: (string[] | string)␊ - /**␊ - * List of destination ports.␊ - */␊ - destinationPorts?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration of an Azure Firewall.␊ - */␊ - export interface AzureFirewallIPConfiguration1 {␊ - properties?: (AzureFirewallIPConfigurationPropertiesFormat1 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration of an Azure Firewall.␊ - */␊ - export interface AzureFirewallIPConfigurationPropertiesFormat1 {␊ - /**␊ - * The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * Reference of the subnet resource. This resource must be named 'AzureFirewallSubnet'.␊ - */␊ - subnet?: (SubResource17 | string)␊ - /**␊ - * Reference of the PublicIP resource. This field is a mandatory input.␊ - */␊ - internalPublicIpAddress?: (SubResource17 | string)␊ - /**␊ - * Reference of the PublicIP resource. This field is populated in the output.␊ - */␊ - publicIPAddress?: (SubResource17 | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: (("Succeeded" | "Updating" | "Deleting" | "Failed") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/connections␊ - */␊ - export interface Connections10 {␊ - name: string␊ - type: "Microsoft.Network/connections"␊ - apiVersion: "2018-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway connection.␊ - */␊ - properties: (VirtualNetworkGatewayConnectionPropertiesFormat10 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewayConnection properties␊ - */␊ - export interface VirtualNetworkGatewayConnectionPropertiesFormat10 {␊ - /**␊ - * The authorizationKey.␊ - */␊ - authorizationKey?: string␊ - /**␊ - * The reference to virtual network gateway resource.␊ - */␊ - virtualNetworkGateway1: (VirtualNetworkGateway6 | SubResource17 | string)␊ - /**␊ - * The reference to virtual network gateway resource.␊ - */␊ - virtualNetworkGateway2?: (VirtualNetworkGateway6 | SubResource17 | string)␊ - /**␊ - * The reference to local network gateway resource.␊ - */␊ - localNetworkGateway2?: (LocalNetworkGateway6 | SubResource17 | string)␊ - /**␊ - * Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.␊ - */␊ - connectionType: (("IPsec" | "Vnet2Vnet" | "ExpressRoute" | "VPNClient") | string)␊ - /**␊ - * The routing weight.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * The IPSec shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The reference to peerings resource.␊ - */␊ - peer?: (SubResource17 | string)␊ - /**␊ - * EnableBgp flag␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * Enable policy-based traffic selectors.␊ - */␊ - usePolicyBasedTrafficSelectors?: (boolean | string)␊ - /**␊ - * The IPSec Policies to be considered by this connection.␊ - */␊ - ipsecPolicies?: (IpsecPolicy7[] | string)␊ - /**␊ - * The resource GUID property of the VirtualNetworkGatewayConnection resource.␊ - */␊ - resourceGuid?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A common class for general resource information␊ - */␊ - export interface VirtualNetworkGateway6 {␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway.␊ - */␊ - properties: (VirtualNetworkGatewayPropertiesFormat10 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGateway properties␊ - */␊ - export interface VirtualNetworkGatewayPropertiesFormat10 {␊ - /**␊ - * IP configurations for virtual network gateway.␊ - */␊ - ipConfigurations?: (VirtualNetworkGatewayIPConfiguration9[] | string)␊ - /**␊ - * The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'.␊ - */␊ - gatewayType?: (("Vpn" | "ExpressRoute") | string)␊ - /**␊ - * The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'.␊ - */␊ - vpnType?: (("PolicyBased" | "RouteBased") | string)␊ - /**␊ - * Whether BGP is enabled for this virtual network gateway or not.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * ActiveActive flag␊ - */␊ - activeActive?: (boolean | string)␊ - /**␊ - * The reference of the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting.␊ - */␊ - gatewayDefaultSite?: (SubResource17 | string)␊ - /**␊ - * The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.␊ - */␊ - sku?: (VirtualNetworkGatewaySku9 | string)␊ - /**␊ - * The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations.␊ - */␊ - vpnClientConfiguration?: (VpnClientConfiguration9 | string)␊ - /**␊ - * Virtual network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings9 | string)␊ - /**␊ - * The resource GUID property of the VirtualNetworkGateway resource.␊ - */␊ - resourceGuid?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration for virtual network gateway␊ - */␊ - export interface VirtualNetworkGatewayIPConfiguration9 {␊ - /**␊ - * Properties of the virtual network gateway ip configuration.␊ - */␊ - properties?: (VirtualNetworkGatewayIPConfigurationPropertiesFormat9 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of VirtualNetworkGatewayIPConfiguration␊ - */␊ - export interface VirtualNetworkGatewayIPConfigurationPropertiesFormat9 {␊ - /**␊ - * The private IP allocation method. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * The reference of the subnet resource.␊ - */␊ - subnet?: (SubResource17 | string)␊ - /**␊ - * The reference of the public IP resource.␊ - */␊ - publicIPAddress?: (SubResource17 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewaySku details␊ - */␊ - export interface VirtualNetworkGatewaySku9 {␊ - /**␊ - * Gateway SKU name.␊ - */␊ - name?: (("Basic" | "HighPerformance" | "Standard" | "UltraPerformance" | "VpnGw1" | "VpnGw2" | "VpnGw3" | "VpnGw1AZ" | "VpnGw2AZ" | "VpnGw3AZ" | "ErGw1AZ" | "ErGw2AZ" | "ErGw3AZ") | string)␊ - /**␊ - * Gateway SKU tier.␊ - */␊ - tier?: (("Basic" | "HighPerformance" | "Standard" | "UltraPerformance" | "VpnGw1" | "VpnGw2" | "VpnGw3" | "VpnGw1AZ" | "VpnGw2AZ" | "VpnGw3AZ" | "ErGw1AZ" | "ErGw2AZ" | "ErGw3AZ") | string)␊ - /**␊ - * The capacity.␊ - */␊ - capacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnClientConfiguration for P2S client.␊ - */␊ - export interface VpnClientConfiguration9 {␊ - /**␊ - * The reference of the address space resource which represents Address space for P2S VpnClient.␊ - */␊ - vpnClientAddressPool?: (AddressSpace19 | string)␊ - /**␊ - * VpnClientRootCertificate for virtual network gateway.␊ - */␊ - vpnClientRootCertificates?: (VpnClientRootCertificate9[] | string)␊ - /**␊ - * VpnClientRevokedCertificate for Virtual network gateway.␊ - */␊ - vpnClientRevokedCertificates?: (VpnClientRevokedCertificate9[] | string)␊ - /**␊ - * VpnClientProtocols for Virtual network gateway.␊ - */␊ - vpnClientProtocols?: (("IkeV2" | "SSTP" | "OpenVPN")[] | string)␊ - /**␊ - * VpnClientIpsecPolicies for virtual network gateway P2S client.␊ - */␊ - vpnClientIpsecPolicies?: (IpsecPolicy7[] | string)␊ - /**␊ - * The radius server address property of the VirtualNetworkGateway resource for vpn client connection.␊ - */␊ - radiusServerAddress?: string␊ - /**␊ - * The radius secret property of the VirtualNetworkGateway resource for vpn client connection.␊ - */␊ - radiusServerSecret?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.␊ - */␊ - export interface AddressSpace19 {␊ - /**␊ - * A list of address blocks reserved for this virtual network in CIDR notation.␊ - */␊ - addressPrefixes: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client root certificate of virtual network gateway␊ - */␊ - export interface VpnClientRootCertificate9 {␊ - /**␊ - * Properties of the vpn client root certificate.␊ - */␊ - properties: (VpnClientRootCertificatePropertiesFormat9 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of application gateway␊ - */␊ - export interface VpnClientRootCertificatePropertiesFormat9 {␊ - /**␊ - * The certificate public data.␊ - */␊ - publicCertData: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client revoked certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRevokedCertificate9 {␊ - /**␊ - * Properties of the vpn client revoked certificate.␊ - */␊ - properties?: (VpnClientRevokedCertificatePropertiesFormat9 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the revoked VPN client certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRevokedCertificatePropertiesFormat9 {␊ - /**␊ - * The revoked VPN client certificate thumbprint.␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An IPSec Policy configuration for a virtual network gateway connection␊ - */␊ - export interface IpsecPolicy7 {␊ - /**␊ - * The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.␊ - */␊ - saLifeTimeSeconds: (number | string)␊ - /**␊ - * The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.␊ - */␊ - saDataSizeKilobytes: (number | string)␊ - /**␊ - * The IPSec encryption algorithm (IKE phase 1).␊ - */␊ - ipsecEncryption: (("None" | "DES" | "DES3" | "AES128" | "AES192" | "AES256" | "GCMAES128" | "GCMAES192" | "GCMAES256") | string)␊ - /**␊ - * The IPSec integrity algorithm (IKE phase 1).␊ - */␊ - ipsecIntegrity: (("MD5" | "SHA1" | "SHA256" | "GCMAES128" | "GCMAES192" | "GCMAES256") | string)␊ - /**␊ - * The IKE encryption algorithm (IKE phase 2).␊ - */␊ - ikeEncryption: (("DES" | "DES3" | "AES128" | "AES192" | "AES256" | "GCMAES256" | "GCMAES128") | string)␊ - /**␊ - * The IKE integrity algorithm (IKE phase 2).␊ - */␊ - ikeIntegrity: (("MD5" | "SHA1" | "SHA256" | "SHA384" | "GCMAES256" | "GCMAES128") | string)␊ - /**␊ - * The DH Groups used in IKE Phase 1 for initial SA.␊ - */␊ - dhGroup: (("None" | "DHGroup1" | "DHGroup2" | "DHGroup14" | "DHGroup2048" | "ECP256" | "ECP384" | "DHGroup24") | string)␊ - /**␊ - * The Pfs Groups used in IKE Phase 2 for new child SA.␊ - */␊ - pfsGroup: (("None" | "PFS1" | "PFS2" | "PFS2048" | "ECP256" | "ECP384" | "PFS24" | "PFS14" | "PFSMM") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * BGP settings details␊ - */␊ - export interface BgpSettings9 {␊ - /**␊ - * The BGP speaker's ASN.␊ - */␊ - asn?: (number | string)␊ - /**␊ - * The BGP peering address and BGP identifier of this BGP speaker.␊ - */␊ - bgpPeeringAddress?: string␊ - /**␊ - * The weight added to routes learned from this BGP speaker.␊ - */␊ - peerWeight?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A common class for general resource information␊ - */␊ - export interface LocalNetworkGateway6 {␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the local network gateway.␊ - */␊ - properties: (LocalNetworkGatewayPropertiesFormat10 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * LocalNetworkGateway properties␊ - */␊ - export interface LocalNetworkGatewayPropertiesFormat10 {␊ - /**␊ - * Local network site address space.␊ - */␊ - localNetworkAddressSpace?: (AddressSpace19 | string)␊ - /**␊ - * IP address of local network gateway.␊ - */␊ - gatewayIpAddress?: string␊ - /**␊ - * Local network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings9 | string)␊ - /**␊ - * The resource GUID property of the LocalNetworkGateway resource.␊ - */␊ - resourceGuid?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ddosProtectionPlans␊ - */␊ - export interface DdosProtectionPlans2 {␊ - name: string␊ - type: "Microsoft.Network/ddosProtectionPlans"␊ - apiVersion: "2018-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the DDoS protection plan.␊ - */␊ - properties: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits␊ - */␊ - export interface ExpressRouteCircuits4 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits"␊ - apiVersion: "2018-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The SKU.␊ - */␊ - sku?: (ExpressRouteCircuitSku4 | string)␊ - properties: (ExpressRouteCircuitPropertiesFormat4 | string)␊ - resources?: (ExpressRouteCircuitsPeeringsChildResource4 | ExpressRouteCircuitsAuthorizationsChildResource4)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains SKU in an ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitSku4 {␊ - /**␊ - * The name of the SKU.␊ - */␊ - name?: string␊ - /**␊ - * The tier of the SKU. Possible values are 'Standard' and 'Premium'.␊ - */␊ - tier?: (("Standard" | "Premium") | string)␊ - /**␊ - * The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'.␊ - */␊ - family?: (("UnlimitedData" | "MeteredData") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitPropertiesFormat4 {␊ - /**␊ - * Allow classic operations␊ - */␊ - allowClassicOperations?: (boolean | string)␊ - /**␊ - * The CircuitProvisioningState state of the resource.␊ - */␊ - circuitProvisioningState?: string␊ - /**␊ - * The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'.␊ - */␊ - serviceProviderProvisioningState?: (("NotProvisioned" | "Provisioning" | "Provisioned" | "Deprovisioning") | string)␊ - /**␊ - * The list of authorizations.␊ - */␊ - authorizations?: (ExpressRouteCircuitAuthorization4[] | string)␊ - /**␊ - * The list of peerings.␊ - */␊ - peerings?: (ExpressRouteCircuitPeering4[] | string)␊ - /**␊ - * The ServiceKey.␊ - */␊ - serviceKey?: string␊ - /**␊ - * The ServiceProviderNotes.␊ - */␊ - serviceProviderNotes?: string␊ - /**␊ - * The ServiceProviderProperties.␊ - */␊ - serviceProviderProperties?: (ExpressRouteCircuitServiceProviderProperties4 | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authorization in an ExpressRouteCircuit resource.␊ - */␊ - export interface ExpressRouteCircuitAuthorization4 {␊ - properties?: (AuthorizationPropertiesFormat5 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - export interface AuthorizationPropertiesFormat5 {␊ - /**␊ - * The authorization key.␊ - */␊ - authorizationKey?: string␊ - /**␊ - * AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'.␊ - */␊ - authorizationUseStatus?: (("Available" | "InUse") | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peering in an ExpressRouteCircuit resource.␊ - */␊ - export interface ExpressRouteCircuitPeering4 {␊ - properties?: (ExpressRouteCircuitPeeringPropertiesFormat5 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - export interface ExpressRouteCircuitPeeringPropertiesFormat5 {␊ - /**␊ - * The peering type.␊ - */␊ - peeringType?: (("AzurePublicPeering" | "AzurePrivatePeering" | "MicrosoftPeering") | string)␊ - /**␊ - * The peering state.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * The Azure ASN.␊ - */␊ - azureASN?: (number | string)␊ - /**␊ - * The peer ASN.␊ - */␊ - peerASN?: (number | string)␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The primary port.␊ - */␊ - primaryAzurePort?: string␊ - /**␊ - * The secondary port.␊ - */␊ - secondaryAzurePort?: string␊ - /**␊ - * The shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The VLAN ID.␊ - */␊ - vlanId?: (number | string)␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig5 | string)␊ - /**␊ - * Gets peering stats.␊ - */␊ - stats?: (ExpressRouteCircuitStats5 | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - /**␊ - * Gets whether the provider or the customer last modified the peering.␊ - */␊ - lastModifiedBy?: string␊ - /**␊ - * The reference of the RouteFilter resource.␊ - */␊ - routeFilter?: (SubResource17 | string)␊ - /**␊ - * The IPv6 peering configuration.␊ - */␊ - ipv6PeeringConfig?: (Ipv6ExpressRouteCircuitPeeringConfig2 | string)␊ - /**␊ - * The list of circuit connections associated with Azure Private Peering for this circuit.␊ - */␊ - connections?: (ExpressRouteCircuitConnection2[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the peering configuration.␊ - */␊ - export interface ExpressRouteCircuitPeeringConfig5 {␊ - /**␊ - * The reference of AdvertisedPublicPrefixes.␊ - */␊ - advertisedPublicPrefixes?: (string[] | string)␊ - /**␊ - * The communities of bgp peering. Specified for microsoft peering␊ - */␊ - advertisedCommunities?: (string[] | string)␊ - /**␊ - * AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'.␊ - */␊ - advertisedPublicPrefixesState?: (("NotConfigured" | "Configuring" | "Configured" | "ValidationNeeded") | string)␊ - /**␊ - * The legacy mode of the peering.␊ - */␊ - legacyMode?: (number | string)␊ - /**␊ - * The CustomerASN of the peering.␊ - */␊ - customerASN?: (number | string)␊ - /**␊ - * The RoutingRegistryName of the configuration.␊ - */␊ - routingRegistryName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains stats associated with the peering.␊ - */␊ - export interface ExpressRouteCircuitStats5 {␊ - /**␊ - * Gets BytesIn of the peering.␊ - */␊ - primarybytesIn?: (number | string)␊ - /**␊ - * Gets BytesOut of the peering.␊ - */␊ - primarybytesOut?: (number | string)␊ - /**␊ - * Gets BytesIn of the peering.␊ - */␊ - secondarybytesIn?: (number | string)␊ - /**␊ - * Gets BytesOut of the peering.␊ - */␊ - secondarybytesOut?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains IPv6 peering config.␊ - */␊ - export interface Ipv6ExpressRouteCircuitPeeringConfig2 {␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig5 | string)␊ - /**␊ - * The reference of the RouteFilter resource.␊ - */␊ - routeFilter?: (SubResource17 | string)␊ - /**␊ - * The state of peering. Possible values are: 'Disabled' and 'Enabled'.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Express Route Circuit Connection in an ExpressRouteCircuitPeering resource.␊ - */␊ - export interface ExpressRouteCircuitConnection2 {␊ - properties?: (ExpressRouteCircuitConnectionPropertiesFormat2 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - export interface ExpressRouteCircuitConnectionPropertiesFormat2 {␊ - /**␊ - * Reference to Express Route Circuit Private Peering Resource of the circuit initiating connection.␊ - */␊ - expressRouteCircuitPeering?: (SubResource17 | string)␊ - /**␊ - * Reference to Express Route Circuit Private Peering Resource of the peered circuit.␊ - */␊ - peerExpressRouteCircuitPeering?: (SubResource17 | string)␊ - /**␊ - * /29 IP address space to carve out Customer addresses for tunnels.␊ - */␊ - addressPrefix?: string␊ - /**␊ - * The authorization key.␊ - */␊ - authorizationKey?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains ServiceProviderProperties in an ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitServiceProviderProperties4 {␊ - /**␊ - * The serviceProviderName.␊ - */␊ - serviceProviderName?: string␊ - /**␊ - * The peering location.␊ - */␊ - peeringLocation?: string␊ - /**␊ - * The BandwidthInMbps.␊ - */␊ - bandwidthInMbps?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings␊ - */␊ - export interface ExpressRouteCircuitsPeeringsChildResource4 {␊ - name: string␊ - type: "peerings"␊ - apiVersion: "2018-06-01"␊ - properties: (ExpressRouteCircuitPeeringPropertiesFormat5 | string)␊ - resources?: ExpressRouteCircuitsPeeringsConnectionsChildResource2[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings/connections␊ - */␊ - export interface ExpressRouteCircuitsPeeringsConnectionsChildResource2 {␊ - name: string␊ - type: "connections"␊ - apiVersion: "2018-06-01"␊ - properties: (ExpressRouteCircuitConnectionPropertiesFormat2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/authorizations␊ - */␊ - export interface ExpressRouteCircuitsAuthorizationsChildResource4 {␊ - name: string␊ - type: "authorizations"␊ - apiVersion: "2018-06-01"␊ - properties: (AuthorizationPropertiesFormat5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/authorizations␊ - */␊ - export interface ExpressRouteCircuitsAuthorizations5 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/authorizations"␊ - apiVersion: "2018-06-01"␊ - properties: (AuthorizationPropertiesFormat5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings␊ - */␊ - export interface ExpressRouteCircuitsPeerings5 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/peerings"␊ - apiVersion: "2018-06-01"␊ - properties: (ExpressRouteCircuitPeeringPropertiesFormat5 | string)␊ - resources?: ExpressRouteCircuitsPeeringsConnectionsChildResource2[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings/connections␊ - */␊ - export interface ExpressRouteCircuitsPeeringsConnections2 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/peerings/connections"␊ - apiVersion: "2018-06-01"␊ - properties: (ExpressRouteCircuitConnectionPropertiesFormat2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections␊ - */␊ - export interface ExpressRouteCrossConnections2 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCrossConnections"␊ - apiVersion: "2018-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (ExpressRouteCrossConnectionProperties2 | string)␊ - resources?: ExpressRouteCrossConnectionsPeeringsChildResource2[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ExpressRouteCrossConnection.␊ - */␊ - export interface ExpressRouteCrossConnectionProperties2 {␊ - /**␊ - * The peering location of the ExpressRoute circuit.␊ - */␊ - peeringLocation?: string␊ - /**␊ - * The circuit bandwidth In Mbps.␊ - */␊ - bandwidthInMbps?: (number | string)␊ - /**␊ - * The ExpressRouteCircuit␊ - */␊ - expressRouteCircuit?: (ExpressRouteCircuitReference1 | string)␊ - /**␊ - * The provisioning state of the circuit in the connectivity provider system. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned'.␊ - */␊ - serviceProviderProvisioningState?: (("NotProvisioned" | "Provisioning" | "Provisioned" | "Deprovisioning") | string)␊ - /**␊ - * Additional read only notes set by the connectivity provider.␊ - */␊ - serviceProviderNotes?: string␊ - /**␊ - * The list of peerings.␊ - */␊ - peerings?: (ExpressRouteCrossConnectionPeering2[] | string)␊ - [k: string]: unknown␊ - }␊ - export interface ExpressRouteCircuitReference1 {␊ - /**␊ - * Corresponding Express Route Circuit Id.␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peering in an ExpressRoute Cross Connection resource.␊ - */␊ - export interface ExpressRouteCrossConnectionPeering2 {␊ - properties?: (ExpressRouteCrossConnectionPeeringProperties2 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - export interface ExpressRouteCrossConnectionPeeringProperties2 {␊ - /**␊ - * The peering type.␊ - */␊ - peeringType?: (("AzurePublicPeering" | "AzurePrivatePeering" | "MicrosoftPeering") | string)␊ - /**␊ - * The peering state.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * The peer ASN.␊ - */␊ - peerASN?: (number | string)␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The VLAN ID.␊ - */␊ - vlanId?: (number | string)␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig5 | string)␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - /**␊ - * Gets whether the provider or the customer last modified the peering.␊ - */␊ - lastModifiedBy?: string␊ - /**␊ - * The IPv6 peering configuration.␊ - */␊ - ipv6PeeringConfig?: (Ipv6ExpressRouteCircuitPeeringConfig2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections/peerings␊ - */␊ - export interface ExpressRouteCrossConnectionsPeeringsChildResource2 {␊ - name: string␊ - type: "peerings"␊ - apiVersion: "2018-06-01"␊ - properties: (ExpressRouteCrossConnectionPeeringProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections/peerings␊ - */␊ - export interface ExpressRouteCrossConnectionsPeerings2 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCrossConnections/peerings"␊ - apiVersion: "2018-06-01"␊ - properties: (ExpressRouteCrossConnectionPeeringProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers␊ - */␊ - export interface LoadBalancers19 {␊ - name: string␊ - type: "Microsoft.Network/loadBalancers"␊ - apiVersion: "2018-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The load balancer SKU.␊ - */␊ - sku?: (LoadBalancerSku7 | string)␊ - /**␊ - * Properties of load balancer.␊ - */␊ - properties: (LoadBalancerPropertiesFormat11 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: LoadBalancersInboundNatRulesChildResource7[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a load balancer␊ - */␊ - export interface LoadBalancerSku7 {␊ - /**␊ - * Name of a load balancer SKU.␊ - */␊ - name?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer.␊ - */␊ - export interface LoadBalancerPropertiesFormat11 {␊ - /**␊ - * Object representing the frontend IPs to be used for the load balancer␊ - */␊ - frontendIPConfigurations?: (FrontendIPConfiguration10[] | string)␊ - /**␊ - * Collection of backend address pools used by a load balancer␊ - */␊ - backendAddressPools?: (BackendAddressPool11[] | string)␊ - /**␊ - * Object collection representing the load balancing rules Gets the provisioning ␊ - */␊ - loadBalancingRules?: (LoadBalancingRule11[] | string)␊ - /**␊ - * Collection of probe objects used in the load balancer␊ - */␊ - probes?: (Probe11[] | string)␊ - /**␊ - * Collection of inbound NAT Rules used by a load balancer. Defining inbound NAT rules on your load balancer is mutually exclusive with defining an inbound NAT pool. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an Inbound NAT pool. They have to reference individual inbound NAT rules.␊ - */␊ - inboundNatRules?: (InboundNatRule12[] | string)␊ - /**␊ - * Defines an external port range for inbound NAT to a single backend port on NICs associated with a load balancer. Inbound NAT rules are created automatically for each NIC associated with the Load Balancer using an external port from this range. Defining an Inbound NAT pool on your Load Balancer is mutually exclusive with defining inbound Nat rules. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an inbound NAT pool. They have to reference individual inbound NAT rules.␊ - */␊ - inboundNatPools?: (InboundNatPool12[] | string)␊ - /**␊ - * The outbound NAT rules.␊ - */␊ - outboundNatRules?: (OutboundNatRule11[] | string)␊ - /**␊ - * The resource GUID property of the load balancer resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP address of the load balancer.␊ - */␊ - export interface FrontendIPConfiguration10 {␊ - /**␊ - * Properties of the load balancer probe.␊ - */␊ - properties?: (FrontendIPConfigurationPropertiesFormat10 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP Configuration of the load balancer.␊ - */␊ - export interface FrontendIPConfigurationPropertiesFormat10 {␊ - /**␊ - * The private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The Private IP allocation method. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * The reference of the subnet resource.␊ - */␊ - subnet?: (SubResource17 | string)␊ - /**␊ - * The reference of the Public IP resource.␊ - */␊ - publicIPAddress?: (SubResource17 | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Pool of backend IP addresses.␊ - */␊ - export interface BackendAddressPool11 {␊ - /**␊ - * Properties of load balancer backend address pool.␊ - */␊ - properties?: (BackendAddressPoolPropertiesFormat11 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the backend address pool.␊ - */␊ - export interface BackendAddressPoolPropertiesFormat11 {␊ - /**␊ - * Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A load balancing rule for a load balancer.␊ - */␊ - export interface LoadBalancingRule11 {␊ - /**␊ - * Properties of load balancer load balancing rule.␊ - */␊ - properties?: (LoadBalancingRulePropertiesFormat11 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer.␊ - */␊ - export interface LoadBalancingRulePropertiesFormat11 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource17 | string)␊ - /**␊ - * A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs.␊ - */␊ - backendAddressPool?: (SubResource17 | string)␊ - /**␊ - * The reference of the load balancer probe used by the load balancing rule.␊ - */␊ - probe?: (SubResource17 | string)␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'.␊ - */␊ - loadDistribution?: (("Default" | "SourceIP" | "SourceIPProtocol") | string)␊ - /**␊ - * The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 0 and 65534. Note that value 0 enables "Any Port"␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port"␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule.␊ - */␊ - disableOutboundSnat?: (boolean | string)␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A load balancer probe.␊ - */␊ - export interface Probe11 {␊ - /**␊ - * Properties of load balancer probe.␊ - */␊ - properties?: (ProbePropertiesFormat11 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Load balancer probe resource.␊ - */␊ - export interface ProbePropertiesFormat11 {␊ - /**␊ - * The protocol of the end point. Possible values are: 'Http', 'Tcp', or 'Https'. If 'Tcp' is specified, a received ACK is required for the probe to be successful. If 'Http' or 'Https' is specified, a 200 OK response from the specifies URI is required for the probe to be successful.␊ - */␊ - protocol: (("Http" | "Tcp" | "Https") | string)␊ - /**␊ - * The port for communicating the probe. Possible values range from 1 to 65535, inclusive.␊ - */␊ - port: (number | string)␊ - /**␊ - * The interval, in seconds, for how frequently to probe the endpoint for health status. Typically, the interval is slightly less than half the allocated timeout period (in seconds) which allows two full probes before taking the instance out of rotation. The default value is 15, the minimum value is 5.␊ - */␊ - intervalInSeconds?: (number | string)␊ - /**␊ - * The number of probes where if no response, will result in stopping further traffic from being delivered to the endpoint. This values allows endpoints to be taken out of rotation faster or slower than the typical times used in Azure.␊ - */␊ - numberOfProbes: (number | string)␊ - /**␊ - * The URI used for requesting health status from the VM. Path is required if a protocol is set to http. Otherwise, it is not allowed. There is no default value.␊ - */␊ - requestPath?: string␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT rule of the load balancer.␊ - */␊ - export interface InboundNatRule12 {␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties?: (InboundNatRulePropertiesFormat11 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the inbound NAT rule.␊ - */␊ - export interface InboundNatRulePropertiesFormat11 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource17 | string)␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values range from 1 to 65534.␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * The port used for the internal endpoint. Acceptable values range from 1 to 65535.␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT pool of the load balancer.␊ - */␊ - export interface InboundNatPool12 {␊ - /**␊ - * Properties of load balancer inbound nat pool.␊ - */␊ - properties?: (InboundNatPoolPropertiesFormat11 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Inbound NAT pool.␊ - */␊ - export interface InboundNatPoolPropertiesFormat11 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource17 | string)␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65534.␊ - */␊ - frontendPortRangeStart: (number | string)␊ - /**␊ - * The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65535.␊ - */␊ - frontendPortRangeEnd: (number | string)␊ - /**␊ - * The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound NAT pool of the load balancer.␊ - */␊ - export interface OutboundNatRule11 {␊ - /**␊ - * Properties of load balancer outbound nat rule.␊ - */␊ - properties?: (OutboundNatRulePropertiesFormat11 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound NAT pool of the load balancer.␊ - */␊ - export interface OutboundNatRulePropertiesFormat11 {␊ - /**␊ - * The number of outbound ports to be used for NAT.␊ - */␊ - allocatedOutboundPorts?: (number | string)␊ - /**␊ - * The Frontend IP addresses of the load balancer.␊ - */␊ - frontendIPConfigurations?: (SubResource17[] | string)␊ - /**␊ - * A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs.␊ - */␊ - backendAddressPool: (SubResource17 | string)␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers/inboundNatRules␊ - */␊ - export interface LoadBalancersInboundNatRulesChildResource7 {␊ - name: string␊ - type: "inboundNatRules"␊ - apiVersion: "2018-06-01"␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties: (InboundNatRulePropertiesFormat11 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers/inboundNatRules␊ - */␊ - export interface LoadBalancersInboundNatRules7 {␊ - name: string␊ - type: "Microsoft.Network/loadBalancers/inboundNatRules"␊ - apiVersion: "2018-06-01"␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties: (InboundNatRulePropertiesFormat11 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/localNetworkGateways␊ - */␊ - export interface LocalNetworkGateways10 {␊ - name: string␊ - type: "Microsoft.Network/localNetworkGateways"␊ - apiVersion: "2018-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the local network gateway.␊ - */␊ - properties: (LocalNetworkGatewayPropertiesFormat10 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces␊ - */␊ - export interface NetworkInterfaces20 {␊ - name: string␊ - type: "Microsoft.Network/networkInterfaces"␊ - apiVersion: "2018-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network interface.␊ - */␊ - properties: (NetworkInterfacePropertiesFormat11 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NetworkInterface properties. ␊ - */␊ - export interface NetworkInterfacePropertiesFormat11 {␊ - /**␊ - * The reference of a virtual machine.␊ - */␊ - virtualMachine?: (SubResource17 | string)␊ - /**␊ - * The reference of the NetworkSecurityGroup resource.␊ - */␊ - networkSecurityGroup?: (SubResource17 | string)␊ - /**␊ - * A list of IPConfigurations of the network interface.␊ - */␊ - ipConfigurations: (NetworkInterfaceIPConfiguration10[] | string)␊ - /**␊ - * The DNS settings in network interface.␊ - */␊ - dnsSettings?: (NetworkInterfaceDnsSettings19 | string)␊ - /**␊ - * The MAC address of the network interface.␊ - */␊ - macAddress?: string␊ - /**␊ - * Gets whether this is a primary network interface on a virtual machine.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * If the network interface is accelerated networking enabled.␊ - */␊ - enableAcceleratedNetworking?: (boolean | string)␊ - /**␊ - * Indicates whether IP forwarding is enabled on this network interface.␊ - */␊ - enableIPForwarding?: (boolean | string)␊ - /**␊ - * The resource GUID property of the network interface resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IPConfiguration in a network interface.␊ - */␊ - export interface NetworkInterfaceIPConfiguration10 {␊ - /**␊ - * Network interface IP configuration properties.␊ - */␊ - properties?: (NetworkInterfaceIPConfigurationPropertiesFormat10 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration.␊ - */␊ - export interface NetworkInterfaceIPConfigurationPropertiesFormat10 {␊ - /**␊ - * The reference of ApplicationGatewayBackendAddressPool resource.␊ - */␊ - applicationGatewayBackendAddressPools?: (SubResource17[] | string)␊ - /**␊ - * The reference of LoadBalancerBackendAddressPool resource.␊ - */␊ - loadBalancerBackendAddressPools?: (SubResource17[] | string)␊ - /**␊ - * A list of references of LoadBalancerInboundNatRules.␊ - */␊ - loadBalancerInboundNatRules?: (SubResource17[] | string)␊ - /**␊ - * Private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * Defines how a private IP address is assigned. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Available from Api-Version 2016-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.␊ - */␊ - privateIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * Subnet bound to the IP configuration.␊ - */␊ - subnet?: (SubResource17 | string)␊ - /**␊ - * Gets whether this is a primary customer address on the network interface.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * Public IP address bound to the IP configuration.␊ - */␊ - publicIPAddress?: (SubResource17 | string)␊ - /**␊ - * Application security groups in which the IP configuration is included.␊ - */␊ - applicationSecurityGroups?: (SubResource17[] | string)␊ - /**␊ - * The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DNS settings of a network interface.␊ - */␊ - export interface NetworkInterfaceDnsSettings19 {␊ - /**␊ - * List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only value in dnsServers collection.␊ - */␊ - dnsServers?: (string[] | string)␊ - /**␊ - * If the VM that uses this NIC is part of an Availability Set, then this list will have the union of all DNS servers from all NICs that are part of the Availability Set. This property is what is configured on each of those VMs.␊ - */␊ - appliedDnsServers?: (string[] | string)␊ - /**␊ - * Relative DNS name for this NIC used for internal communications between VMs in the same virtual network.␊ - */␊ - internalDnsNameLabel?: string␊ - /**␊ - * Fully qualified DNS name supporting internal communications between VMs in the same virtual network.␊ - */␊ - internalFqdn?: string␊ - /**␊ - * Even if internalDnsNameLabel is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internalDomainNameSuffix.␊ - */␊ - internalDomainNameSuffix?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups␊ - */␊ - export interface NetworkSecurityGroups19 {␊ - name: string␊ - type: "Microsoft.Network/networkSecurityGroups"␊ - apiVersion: "2018-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network security group␊ - */␊ - properties: (NetworkSecurityGroupPropertiesFormat11 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: NetworkSecurityGroupsSecurityRulesChildResource11[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network Security Group resource.␊ - */␊ - export interface NetworkSecurityGroupPropertiesFormat11 {␊ - /**␊ - * A collection of security rules of the network security group.␊ - */␊ - securityRules?: (SecurityRule11[] | string)␊ - /**␊ - * The default security rules of network security group.␊ - */␊ - defaultSecurityRules?: (SecurityRule11[] | string)␊ - /**␊ - * The resource GUID property of the network security group resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network security rule.␊ - */␊ - export interface SecurityRule11 {␊ - /**␊ - * Properties of the security rule␊ - */␊ - properties?: (SecurityRulePropertiesFormat11 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Security rule resource.␊ - */␊ - export interface SecurityRulePropertiesFormat11 {␊ - /**␊ - * A description for this rule. Restricted to 140 chars.␊ - */␊ - description?: string␊ - /**␊ - * Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'.␊ - */␊ - protocol: (("Tcp" | "Udp" | "*") | string)␊ - /**␊ - * The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.␊ - */␊ - sourcePortRange?: string␊ - /**␊ - * The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.␊ - */␊ - destinationPortRange?: string␊ - /**␊ - * The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. ␊ - */␊ - sourceAddressPrefix?: string␊ - /**␊ - * The CIDR or source IP ranges.␊ - */␊ - sourceAddressPrefixes?: (string[] | string)␊ - /**␊ - * The application security group specified as source.␊ - */␊ - sourceApplicationSecurityGroups?: (SubResource17[] | string)␊ - /**␊ - * The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used.␊ - */␊ - destinationAddressPrefix?: string␊ - /**␊ - * The destination address prefixes. CIDR or destination IP ranges.␊ - */␊ - destinationAddressPrefixes?: (string[] | string)␊ - /**␊ - * The application security group specified as destination.␊ - */␊ - destinationApplicationSecurityGroups?: (SubResource17[] | string)␊ - /**␊ - * The source port ranges.␊ - */␊ - sourcePortRanges?: (string[] | string)␊ - /**␊ - * The destination port ranges.␊ - */␊ - destinationPortRanges?: (string[] | string)␊ - /**␊ - * The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'.␊ - */␊ - access: (("Allow" | "Deny") | string)␊ - /**␊ - * The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.␊ - */␊ - priority: (number | string)␊ - /**␊ - * The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. Possible values are: 'Inbound' and 'Outbound'.␊ - */␊ - direction: (("Inbound" | "Outbound") | string)␊ - /**␊ - * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRulesChildResource11 {␊ - name: string␊ - type: "securityRules"␊ - apiVersion: "2018-06-01"␊ - /**␊ - * Properties of the security rule␊ - */␊ - properties: (SecurityRulePropertiesFormat11 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRules11 {␊ - name: string␊ - type: "Microsoft.Network/networkSecurityGroups/securityRules"␊ - apiVersion: "2018-06-01"␊ - /**␊ - * Properties of the security rule␊ - */␊ - properties: (SecurityRulePropertiesFormat11 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers␊ - */␊ - export interface NetworkWatchers1 {␊ - name: string␊ - type: "Microsoft.Network/networkWatchers"␊ - apiVersion: "2018-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - properties: ({␊ - [k: string]: unknown␊ - } | string)␊ - resources?: (NetworkWatchersConnectionMonitorsChildResource1 | NetworkWatchersPacketCapturesChildResource1)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/connectionMonitors␊ - */␊ - export interface NetworkWatchersConnectionMonitorsChildResource1 {␊ - name: string␊ - type: "connectionMonitors"␊ - apiVersion: "2018-06-01"␊ - /**␊ - * Connection monitor location.␊ - */␊ - location?: string␊ - /**␊ - * Connection monitor tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (ConnectionMonitorParameters1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters that define the operation to create a connection monitor.␊ - */␊ - export interface ConnectionMonitorParameters1 {␊ - source: (ConnectionMonitorSource1 | string)␊ - destination: (ConnectionMonitorDestination1 | string)␊ - /**␊ - * Determines if the connection monitor will start automatically once created.␊ - */␊ - autoStart?: (boolean | string)␊ - /**␊ - * Monitoring interval in seconds.␊ - */␊ - monitoringIntervalInSeconds?: ((number & string) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the source of connection monitor.␊ - */␊ - export interface ConnectionMonitorSource1 {␊ - /**␊ - * The ID of the resource used as the source by connection monitor.␊ - */␊ - resourceId: string␊ - /**␊ - * The source port used by connection monitor.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the destination of connection monitor.␊ - */␊ - export interface ConnectionMonitorDestination1 {␊ - /**␊ - * The ID of the resource used as the destination by connection monitor.␊ - */␊ - resourceId?: string␊ - /**␊ - * Address of the connection monitor destination (IP or domain name).␊ - */␊ - address?: string␊ - /**␊ - * The destination port used by connection monitor.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/packetCaptures␊ - */␊ - export interface NetworkWatchersPacketCapturesChildResource1 {␊ - name: string␊ - type: "packetCaptures"␊ - apiVersion: "2018-06-01"␊ - properties: (PacketCaptureParameters1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters that define the create packet capture operation.␊ - */␊ - export interface PacketCaptureParameters1 {␊ - /**␊ - * The ID of the targeted resource, only VM is currently supported.␊ - */␊ - target: string␊ - /**␊ - * Number of bytes captured per packet, the remaining bytes are truncated.␊ - */␊ - bytesToCapturePerPacket?: ((number & string) | string)␊ - /**␊ - * Maximum size of the capture output.␊ - */␊ - totalBytesPerSession?: ((number & string) | string)␊ - /**␊ - * Maximum duration of the capture session in seconds.␊ - */␊ - timeLimitInSeconds?: ((number & string) | string)␊ - storageLocation: (PacketCaptureStorageLocation1 | string)␊ - filters?: (PacketCaptureFilter1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the storage location for a packet capture session.␊ - */␊ - export interface PacketCaptureStorageLocation1 {␊ - /**␊ - * The ID of the storage account to save the packet capture session. Required if no local file path is provided.␊ - */␊ - storageId?: string␊ - /**␊ - * The URI of the storage path to save the packet capture. Must be a well-formed URI describing the location to save the packet capture.␊ - */␊ - storagePath?: string␊ - /**␊ - * A valid local path on the targeting VM. Must include the name of the capture file (*.cap). For linux virtual machine it must start with /var/captures. Required if no storage ID is provided, otherwise optional.␊ - */␊ - filePath?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Filter that is applied to packet capture request. Multiple filters can be applied.␊ - */␊ - export interface PacketCaptureFilter1 {␊ - /**␊ - * Protocol to be filtered on.␊ - */␊ - protocol?: (("TCP" | "UDP" | "Any") | string)␊ - /**␊ - * Local IP Address to be filtered on. Notation: "127.0.0.1" for single address entry. "127.0.0.1-127.0.0.255" for range. "127.0.0.1;127.0.0.5"? for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.␊ - */␊ - localIPAddress?: string␊ - /**␊ - * Local IP Address to be filtered on. Notation: "127.0.0.1" for single address entry. "127.0.0.1-127.0.0.255" for range. "127.0.0.1;127.0.0.5;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.␊ - */␊ - remoteIPAddress?: string␊ - /**␊ - * Local port to be filtered on. Notation: "80" for single port entry."80-85" for range. "80;443;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.␊ - */␊ - localPort?: string␊ - /**␊ - * Remote port to be filtered on. Notation: "80" for single port entry."80-85" for range. "80;443;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.␊ - */␊ - remotePort?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/connectionMonitors␊ - */␊ - export interface NetworkWatchersConnectionMonitors1 {␊ - name: string␊ - type: "Microsoft.Network/networkWatchers/connectionMonitors"␊ - apiVersion: "2018-06-01"␊ - /**␊ - * Connection monitor location.␊ - */␊ - location?: string␊ - /**␊ - * Connection monitor tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (ConnectionMonitorParameters1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/packetCaptures␊ - */␊ - export interface NetworkWatchersPacketCaptures1 {␊ - name: string␊ - type: "Microsoft.Network/networkWatchers/packetCaptures"␊ - apiVersion: "2018-06-01"␊ - properties: (PacketCaptureParameters1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/publicIPAddresses␊ - */␊ - export interface PublicIPAddresses19 {␊ - name: string␊ - type: "Microsoft.Network/publicIPAddresses"␊ - apiVersion: "2018-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The public IP address SKU.␊ - */␊ - sku?: (PublicIPAddressSku7 | string)␊ - /**␊ - * Public IP address properties.␊ - */␊ - properties: (PublicIPAddressPropertiesFormat10 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a public IP address␊ - */␊ - export interface PublicIPAddressSku7 {␊ - /**␊ - * Name of a public IP address SKU.␊ - */␊ - name?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Public IP address properties.␊ - */␊ - export interface PublicIPAddressPropertiesFormat10 {␊ - /**␊ - * The public IP allocation method. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - publicIPAllocationMethod: (("Static" | "Dynamic") | string)␊ - /**␊ - * The public IP address version. Possible values are: 'IPv4' and 'IPv6'.␊ - */␊ - publicIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The FQDN of the DNS record associated with the public IP address.␊ - */␊ - dnsSettings?: (PublicIPAddressDnsSettings18 | string)␊ - /**␊ - * The list of tags associated with the public IP address.␊ - */␊ - ipTags?: (IpTag4[] | string)␊ - /**␊ - * The IP address associated with the public IP address resource.␊ - */␊ - ipAddress?: string␊ - /**␊ - * The idle timeout of the public IP address.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * The resource GUID property of the public IP resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains FQDN of the DNS record associated with the public IP address␊ - */␊ - export interface PublicIPAddressDnsSettings18 {␊ - /**␊ - * Gets or sets the Domain name label.The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.␊ - */␊ - domainNameLabel: string␊ - /**␊ - * Gets the FQDN, Fully qualified domain name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone.␊ - */␊ - fqdn?: string␊ - /**␊ - * Gets or Sets the Reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN. ␊ - */␊ - reverseFqdn?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains the IpTag associated with the public IP address␊ - */␊ - export interface IpTag4 {␊ - /**␊ - * Gets or sets the ipTag type: Example FirstPartyUsage.␊ - */␊ - ipTagType?: string␊ - /**␊ - * Gets or sets value of the IpTag associated with the public IP. Example SQL, Storage etc␊ - */␊ - tag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeFilters␊ - */␊ - export interface RouteFilters1 {␊ - name: string␊ - type: "Microsoft.Network/routeFilters"␊ - apiVersion: "2018-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (RouteFilterPropertiesFormat1 | string)␊ - resources?: RouteFiltersRouteFilterRulesChildResource1[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Filter Resource␊ - */␊ - export interface RouteFilterPropertiesFormat1 {␊ - /**␊ - * Collection of RouteFilterRules contained within a route filter.␊ - */␊ - rules?: (RouteFilterRule1[] | string)␊ - /**␊ - * A collection of references to express route circuit peerings.␊ - */␊ - peerings?: (SubResource17[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Filter Rule Resource␊ - */␊ - export interface RouteFilterRule1 {␊ - properties?: (RouteFilterRulePropertiesFormat1 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Filter Rule Resource␊ - */␊ - export interface RouteFilterRulePropertiesFormat1 {␊ - /**␊ - * The access type of the rule. Valid values are: 'Allow', 'Deny'.␊ - */␊ - access: (("Allow" | "Deny") | string)␊ - /**␊ - * The rule type of the rule. Valid value is: 'Community'␊ - */␊ - routeFilterRuleType: ("Community" | string)␊ - /**␊ - * The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020']␊ - */␊ - communities: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeFilters/routeFilterRules␊ - */␊ - export interface RouteFiltersRouteFilterRulesChildResource1 {␊ - name: string␊ - type: "routeFilterRules"␊ - apiVersion: "2018-06-01"␊ - properties: (RouteFilterRulePropertiesFormat1 | string)␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeFilters/routeFilterRules␊ - */␊ - export interface RouteFiltersRouteFilterRules1 {␊ - name: string␊ - type: "Microsoft.Network/routeFilters/routeFilterRules"␊ - apiVersion: "2018-06-01"␊ - properties: (RouteFilterRulePropertiesFormat1 | string)␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables␊ - */␊ - export interface RouteTables19 {␊ - name: string␊ - type: "Microsoft.Network/routeTables"␊ - apiVersion: "2018-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the route table.␊ - */␊ - properties: (RouteTablePropertiesFormat11 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: RouteTablesRoutesChildResource11[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Table resource␊ - */␊ - export interface RouteTablePropertiesFormat11 {␊ - /**␊ - * Collection of routes contained within a route table.␊ - */␊ - routes?: (Route11[] | string)␊ - /**␊ - * Gets or sets whether to disable the routes learned by BGP on that route table. True means disable.␊ - */␊ - disableBgpRoutePropagation?: (boolean | string)␊ - /**␊ - * The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource␊ - */␊ - export interface Route11 {␊ - /**␊ - * Properties of the route.␊ - */␊ - properties?: (RoutePropertiesFormat11 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource␊ - */␊ - export interface RoutePropertiesFormat11 {␊ - /**␊ - * The destination CIDR to which the route applies.␊ - */␊ - addressPrefix: string␊ - /**␊ - * The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'.␊ - */␊ - nextHopType: (("VirtualNetworkGateway" | "VnetLocal" | "Internet" | "VirtualAppliance" | "None") | string)␊ - /**␊ - * The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.␊ - */␊ - nextHopIpAddress?: string␊ - /**␊ - * The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutesChildResource11 {␊ - name: string␊ - type: "routes"␊ - apiVersion: "2018-06-01"␊ - /**␊ - * Properties of the route.␊ - */␊ - properties: (RoutePropertiesFormat11 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutes11 {␊ - name: string␊ - type: "Microsoft.Network/routeTables/routes"␊ - apiVersion: "2018-06-01"␊ - /**␊ - * Properties of the route.␊ - */␊ - properties: (RoutePropertiesFormat11 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualHubs␊ - */␊ - export interface VirtualHubs1 {␊ - name: string␊ - type: "Microsoft.Network/virtualHubs"␊ - apiVersion: "2018-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (VirtualHubProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VirtualHub␊ - */␊ - export interface VirtualHubProperties1 {␊ - /**␊ - * The VirtualWAN to which the VirtualHub belongs␊ - */␊ - virtualWan?: (SubResource17 | string)␊ - /**␊ - * list of all vnet connections with this VirtualHub.␊ - */␊ - hubVirtualNetworkConnections?: (HubVirtualNetworkConnection1[] | string)␊ - /**␊ - * Address-prefix for this VirtualHub.␊ - */␊ - addressPrefix?: string␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: (("Succeeded" | "Updating" | "Deleting" | "Failed") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HubVirtualNetworkConnection Resource.␊ - */␊ - export interface HubVirtualNetworkConnection1 {␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties?: (HubVirtualNetworkConnectionProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for HubVirtualNetworkConnection␊ - */␊ - export interface HubVirtualNetworkConnectionProperties1 {␊ - /**␊ - * Reference to the remote virtual network.␊ - */␊ - remoteVirtualNetwork?: (SubResource17 | string)␊ - /**␊ - * VirtualHub to RemoteVnet transit to enabled or not.␊ - */␊ - allowHubToRemoteVnetTransit?: (boolean | string)␊ - /**␊ - * Allow RemoteVnet to use Virtual Hub's gateways.␊ - */␊ - allowRemoteVnetToUseHubVnetGateways?: (boolean | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: (("Succeeded" | "Updating" | "Deleting" | "Failed") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworkGateways␊ - */␊ - export interface VirtualNetworkGateways10 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworkGateways"␊ - apiVersion: "2018-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway.␊ - */␊ - properties: (VirtualNetworkGatewayPropertiesFormat10 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks␊ - */␊ - export interface VirtualNetworks19 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks"␊ - apiVersion: "2018-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network.␊ - */␊ - properties: (VirtualNetworkPropertiesFormat11 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: (VirtualNetworksVirtualNetworkPeeringsChildResource8 | VirtualNetworksSubnetsChildResource11)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the virtual network.␊ - */␊ - export interface VirtualNetworkPropertiesFormat11 {␊ - /**␊ - * The AddressSpace that contains an array of IP address ranges that can be used by subnets.␊ - */␊ - addressSpace: (AddressSpace19 | string)␊ - /**␊ - * The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network.␊ - */␊ - dhcpOptions?: (DhcpOptions19 | string)␊ - /**␊ - * A list of subnets in a Virtual Network.␊ - */␊ - subnets?: (Subnet21[] | string)␊ - /**␊ - * A list of peerings in a Virtual Network.␊ - */␊ - virtualNetworkPeerings?: (VirtualNetworkPeering16[] | string)␊ - /**␊ - * The resourceGuid property of the Virtual Network resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - /**␊ - * Indicates if DDoS protection is enabled for all the protected resources in the virtual network. It requires a DDoS protection plan associated with the resource.␊ - */␊ - enableDdosProtection?: (boolean | string)␊ - /**␊ - * Indicates if VM protection is enabled for all the subnets in the virtual network.␊ - */␊ - enableVmProtection?: (boolean | string)␊ - /**␊ - * The DDoS protection plan associated with the virtual network.␊ - */␊ - ddosProtectionPlan?: (SubResource17 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DhcpOptions contains an array of DNS servers available to VMs deployed in the virtual network. Standard DHCP option for a subnet overrides VNET DHCP options.␊ - */␊ - export interface DhcpOptions19 {␊ - /**␊ - * The list of DNS servers IP addresses.␊ - */␊ - dnsServers: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Subnet in a virtual network resource.␊ - */␊ - export interface Subnet21 {␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties?: (SubnetPropertiesFormat11 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the subnet.␊ - */␊ - export interface SubnetPropertiesFormat11 {␊ - /**␊ - * The address prefix for the subnet.␊ - */␊ - addressPrefix: string␊ - /**␊ - * The reference of the NetworkSecurityGroup resource.␊ - */␊ - networkSecurityGroup?: (SubResource17 | string)␊ - /**␊ - * The reference of the RouteTable resource.␊ - */␊ - routeTable?: (SubResource17 | string)␊ - /**␊ - * An array of service endpoints.␊ - */␊ - serviceEndpoints?: (ServiceEndpointPropertiesFormat7[] | string)␊ - /**␊ - * Gets an array of references to the external resources using subnet.␊ - */␊ - resourceNavigationLinks?: (ResourceNavigationLink8[] | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The service endpoint properties.␊ - */␊ - export interface ServiceEndpointPropertiesFormat7 {␊ - /**␊ - * The type of the endpoint service.␊ - */␊ - service?: string␊ - /**␊ - * A list of locations.␊ - */␊ - locations?: (string[] | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ResourceNavigationLink resource.␊ - */␊ - export interface ResourceNavigationLink8 {␊ - /**␊ - * Resource navigation link properties format.␊ - */␊ - properties?: (ResourceNavigationLinkFormat8 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ResourceNavigationLink.␊ - */␊ - export interface ResourceNavigationLinkFormat8 {␊ - /**␊ - * Resource type of the linked resource.␊ - */␊ - linkedResourceType?: string␊ - /**␊ - * Link to the external resource␊ - */␊ - link?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peerings in a virtual network resource.␊ - */␊ - export interface VirtualNetworkPeering16 {␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties?: (VirtualNetworkPeeringPropertiesFormat8 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - export interface VirtualNetworkPeeringPropertiesFormat8 {␊ - /**␊ - * Whether the VMs in the linked virtual network space would be able to access all the VMs in local Virtual network space.␊ - */␊ - allowVirtualNetworkAccess?: (boolean | string)␊ - /**␊ - * Whether the forwarded traffic from the VMs in the remote virtual network will be allowed/disallowed.␊ - */␊ - allowForwardedTraffic?: (boolean | string)␊ - /**␊ - * If gateway links can be used in remote virtual networking to link to this virtual network.␊ - */␊ - allowGatewayTransit?: (boolean | string)␊ - /**␊ - * If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway.␊ - */␊ - useRemoteGateways?: (boolean | string)␊ - /**␊ - * The reference of the remote virtual network. The remote virtual network can be in the same or different region (preview). See here to register for the preview and learn more (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering).␊ - */␊ - remoteVirtualNetwork: (SubResource17 | string)␊ - /**␊ - * The reference of the remote virtual network address space.␊ - */␊ - remoteAddressSpace?: (AddressSpace19 | string)␊ - /**␊ - * The status of the virtual network peering. Possible values are 'Initiated', 'Connected', and 'Disconnected'.␊ - */␊ - peeringState?: (("Initiated" | "Connected" | "Disconnected") | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/virtualNetworkPeerings␊ - */␊ - export interface VirtualNetworksVirtualNetworkPeeringsChildResource8 {␊ - name: string␊ - type: "virtualNetworkPeerings"␊ - apiVersion: "2018-06-01"␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties: (VirtualNetworkPeeringPropertiesFormat8 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnetsChildResource11 {␊ - name: string␊ - type: "subnets"␊ - apiVersion: "2018-06-01"␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties: (SubnetPropertiesFormat11 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnets10 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks/subnets"␊ - apiVersion: "2018-06-01"␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties: (SubnetPropertiesFormat11 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/virtualNetworkPeerings␊ - */␊ - export interface VirtualNetworksVirtualNetworkPeerings7 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks/virtualNetworkPeerings"␊ - apiVersion: "2018-06-01"␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties: (VirtualNetworkPeeringPropertiesFormat8 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualWans␊ - */␊ - export interface VirtualWans1 {␊ - name: string␊ - type: "Microsoft.Network/virtualWans"␊ - apiVersion: "2018-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (VirtualWanProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VirtualWAN␊ - */␊ - export interface VirtualWanProperties1 {␊ - /**␊ - * Vpn encryption to be disabled or not.␊ - */␊ - disableVpnEncryption?: (boolean | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: (("Succeeded" | "Updating" | "Deleting" | "Failed") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnGateways␊ - */␊ - export interface VpnGateways1 {␊ - name: string␊ - type: "Microsoft.Network/vpnGateways"␊ - apiVersion: "2018-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (VpnGatewayProperties1 | string)␊ - resources?: VpnGatewaysVpnConnectionsChildResource1[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnGateway␊ - */␊ - export interface VpnGatewayProperties1 {␊ - /**␊ - * The VirtualHub to which the gateway belongs␊ - */␊ - virtualHub?: (SubResource17 | string)␊ - /**␊ - * list of all vpn connections to the gateway.␊ - */␊ - connections?: (VpnConnection1[] | string)␊ - /**␊ - * Local network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings9 | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: (("Succeeded" | "Updating" | "Deleting" | "Failed") | string)␊ - /**␊ - * The policies applied to this vpn gateway.␊ - */␊ - policies?: (Policies1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnConnection Resource.␊ - */␊ - export interface VpnConnection1 {␊ - properties?: (VpnConnectionProperties1 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnConnection␊ - */␊ - export interface VpnConnectionProperties1 {␊ - /**␊ - * Id of the connected vpn site.␊ - */␊ - remoteVpnSite?: (SubResource17 | string)␊ - /**␊ - * routing weight for vpn connection.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * The connection status.␊ - */␊ - connectionStatus?: (("Unknown" | "Connecting" | "Connected" | "NotConnected") | string)␊ - /**␊ - * SharedKey for the vpn connection.␊ - */␊ - sharedKey?: string␊ - /**␊ - * EnableBgp flag␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * The IPSec Policies to be considered by this connection.␊ - */␊ - ipsecPolicies?: (IpsecPolicy7[] | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: (("Succeeded" | "Updating" | "Deleting" | "Failed") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Policies for vpn gateway.␊ - */␊ - export interface Policies1 {␊ - /**␊ - * True if branch to branch traffic is allowed.␊ - */␊ - allowBranchToBranchTraffic?: (boolean | string)␊ - /**␊ - * True if Vnet to Vnet traffic is allowed.␊ - */␊ - allowVnetToVnetTraffic?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnGateways/vpnConnections␊ - */␊ - export interface VpnGatewaysVpnConnectionsChildResource1 {␊ - name: string␊ - type: "vpnConnections"␊ - apiVersion: "2018-06-01"␊ - properties: (VpnConnectionProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnGateways/vpnConnections␊ - */␊ - export interface VpnGatewaysVpnConnections1 {␊ - name: string␊ - type: "Microsoft.Network/vpnGateways/vpnConnections"␊ - apiVersion: "2018-06-01"␊ - properties: (VpnConnectionProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnSites␊ - */␊ - export interface VpnSites1 {␊ - name: string␊ - type: "Microsoft.Network/vpnSites"␊ - apiVersion: "2018-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (VpnSiteProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnSite␊ - */␊ - export interface VpnSiteProperties1 {␊ - /**␊ - * The VirtualWAN to which the vpnSite belongs␊ - */␊ - virtualWAN?: (SubResource17 | string)␊ - /**␊ - * The device properties␊ - */␊ - deviceProperties?: (DeviceProperties1 | string)␊ - /**␊ - * The ip-address for the vpn-site.␊ - */␊ - ipAddress?: string␊ - /**␊ - * The key for vpn-site that can be used for connections.␊ - */␊ - siteKey?: string␊ - /**␊ - * The AddressSpace that contains an array of IP address ranges.␊ - */␊ - addressSpace?: (AddressSpace19 | string)␊ - /**␊ - * The set of bgp properties.␊ - */␊ - bgpProperties?: (BgpSettings9 | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: (("Succeeded" | "Updating" | "Deleting" | "Failed") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * List of properties of the device.␊ - */␊ - export interface DeviceProperties1 {␊ - /**␊ - * Name of the device Vendor.␊ - */␊ - deviceVendor?: string␊ - /**␊ - * Model of the device.␊ - */␊ - deviceModel?: string␊ - /**␊ - * Link speed.␊ - */␊ - linkSpeedInMbps?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/applicationGateways␊ - */␊ - export interface ApplicationGateways11 {␊ - name: string␊ - type: "Microsoft.Network/applicationGateways"␊ - apiVersion: "2018-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (ApplicationGatewayPropertiesFormat11 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * A list of availability zones denoting where the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application gateway.␊ - */␊ - export interface ApplicationGatewayPropertiesFormat11 {␊ - /**␊ - * SKU of the application gateway resource.␊ - */␊ - sku?: (ApplicationGatewaySku11 | string)␊ - /**␊ - * SSL policy of the application gateway resource.␊ - */␊ - sslPolicy?: (ApplicationGatewaySslPolicy8 | string)␊ - /**␊ - * Subnets of application the gateway resource.␊ - */␊ - gatewayIPConfigurations?: (ApplicationGatewayIPConfiguration11[] | string)␊ - /**␊ - * Authentication certificates of the application gateway resource.␊ - */␊ - authenticationCertificates?: (ApplicationGatewayAuthenticationCertificate8[] | string)␊ - /**␊ - * SSL certificates of the application gateway resource.␊ - */␊ - sslCertificates?: (ApplicationGatewaySslCertificate11[] | string)␊ - /**␊ - * Frontend IP addresses of the application gateway resource.␊ - */␊ - frontendIPConfigurations?: (ApplicationGatewayFrontendIPConfiguration11[] | string)␊ - /**␊ - * Frontend ports of the application gateway resource.␊ - */␊ - frontendPorts?: (ApplicationGatewayFrontendPort11[] | string)␊ - /**␊ - * Probes of the application gateway resource.␊ - */␊ - probes?: (ApplicationGatewayProbe10[] | string)␊ - /**␊ - * Backend address pool of the application gateway resource.␊ - */␊ - backendAddressPools?: (ApplicationGatewayBackendAddressPool11[] | string)␊ - /**␊ - * Backend http settings of the application gateway resource.␊ - */␊ - backendHttpSettingsCollection?: (ApplicationGatewayBackendHttpSettings11[] | string)␊ - /**␊ - * Http listeners of the application gateway resource.␊ - */␊ - httpListeners?: (ApplicationGatewayHttpListener11[] | string)␊ - /**␊ - * URL path map of the application gateway resource.␊ - */␊ - urlPathMaps?: (ApplicationGatewayUrlPathMap10[] | string)␊ - /**␊ - * Request routing rules of the application gateway resource.␊ - */␊ - requestRoutingRules?: (ApplicationGatewayRequestRoutingRule11[] | string)␊ - /**␊ - * Redirect configurations of the application gateway resource.␊ - */␊ - redirectConfigurations?: (ApplicationGatewayRedirectConfiguration8[] | string)␊ - /**␊ - * Web application firewall configuration.␊ - */␊ - webApplicationFirewallConfiguration?: (ApplicationGatewayWebApplicationFirewallConfiguration8 | string)␊ - /**␊ - * Whether HTTP2 is enabled on the application gateway resource.␊ - */␊ - enableHttp2?: (boolean | string)␊ - /**␊ - * Whether FIPS is enabled on the application gateway resource.␊ - */␊ - enableFips?: (boolean | string)␊ - /**␊ - * Autoscale Configuration.␊ - */␊ - autoscaleConfiguration?: (ApplicationGatewayAutoscaleConfiguration2 | string)␊ - /**␊ - * Resource GUID property of the application gateway resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of an application gateway␊ - */␊ - export interface ApplicationGatewaySku11 {␊ - /**␊ - * Name of an application gateway SKU.␊ - */␊ - name?: (("Standard_Small" | "Standard_Medium" | "Standard_Large" | "WAF_Medium" | "WAF_Large" | "Standard_v2" | "WAF_v2") | string)␊ - /**␊ - * Tier of an application gateway.␊ - */␊ - tier?: (("Standard" | "WAF" | "Standard_v2" | "WAF_v2") | string)␊ - /**␊ - * Capacity (instance count) of an application gateway.␊ - */␊ - capacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application Gateway Ssl policy.␊ - */␊ - export interface ApplicationGatewaySslPolicy8 {␊ - /**␊ - * Ssl protocols to be disabled on application gateway.␊ - */␊ - disabledSslProtocols?: (("TLSv1_0" | "TLSv1_1" | "TLSv1_2")[] | string)␊ - /**␊ - * Type of Ssl Policy.␊ - */␊ - policyType?: (("Predefined" | "Custom") | string)␊ - /**␊ - * Name of Ssl predefined policy.␊ - */␊ - policyName?: (("AppGwSslPolicy20150501" | "AppGwSslPolicy20170401" | "AppGwSslPolicy20170401S") | string)␊ - /**␊ - * Ssl cipher suites to be enabled in the specified order to application gateway.␊ - */␊ - cipherSuites?: (("TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384" | "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256" | "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA" | "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA" | "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384" | "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256" | "TLS_DHE_RSA_WITH_AES_256_CBC_SHA" | "TLS_DHE_RSA_WITH_AES_128_CBC_SHA" | "TLS_RSA_WITH_AES_256_GCM_SHA384" | "TLS_RSA_WITH_AES_128_GCM_SHA256" | "TLS_RSA_WITH_AES_256_CBC_SHA256" | "TLS_RSA_WITH_AES_128_CBC_SHA256" | "TLS_RSA_WITH_AES_256_CBC_SHA" | "TLS_RSA_WITH_AES_128_CBC_SHA" | "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384" | "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256" | "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384" | "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256" | "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA" | "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA" | "TLS_DHE_DSS_WITH_AES_256_CBC_SHA256" | "TLS_DHE_DSS_WITH_AES_128_CBC_SHA256" | "TLS_DHE_DSS_WITH_AES_256_CBC_SHA" | "TLS_DHE_DSS_WITH_AES_128_CBC_SHA" | "TLS_RSA_WITH_3DES_EDE_CBC_SHA" | "TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA" | "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256" | "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384")[] | string)␊ - /**␊ - * Minimum version of Ssl protocol to be supported on application gateway.␊ - */␊ - minProtocolVersion?: (("TLSv1_0" | "TLSv1_1" | "TLSv1_2") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed.␊ - */␊ - export interface ApplicationGatewayIPConfiguration11 {␊ - properties?: (ApplicationGatewayIPConfigurationPropertiesFormat11 | string)␊ - /**␊ - * Name of the IP configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayIPConfigurationPropertiesFormat11 {␊ - /**␊ - * Reference of the subnet resource. A subnet from where application gateway gets its private address.␊ - */␊ - subnet?: (SubResource18 | string)␊ - /**␊ - * Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Reference to another subresource.␊ - */␊ - export interface SubResource18 {␊ - /**␊ - * Resource ID.␊ - */␊ - id: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authentication certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewayAuthenticationCertificate8 {␊ - properties?: (ApplicationGatewayAuthenticationCertificatePropertiesFormat8 | string)␊ - /**␊ - * Name of the authentication certificate that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authentication certificates properties of an application gateway.␊ - */␊ - export interface ApplicationGatewayAuthenticationCertificatePropertiesFormat8 {␊ - /**␊ - * Certificate public data.␊ - */␊ - data?: string␊ - /**␊ - * Provisioning state of the authentication certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSL certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewaySslCertificate11 {␊ - properties?: (ApplicationGatewaySslCertificatePropertiesFormat11 | string)␊ - /**␊ - * Name of the SSL certificate that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewaySslCertificatePropertiesFormat11 {␊ - /**␊ - * Base-64 encoded pfx certificate. Only applicable in PUT Request.␊ - */␊ - data?: string␊ - /**␊ - * Password for the pfx file specified in data. Only applicable in PUT request.␊ - */␊ - password?: string␊ - /**␊ - * Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request.␊ - */␊ - publicCertData?: string␊ - /**␊ - * Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendIPConfiguration11 {␊ - properties?: (ApplicationGatewayFrontendIPConfigurationPropertiesFormat11 | string)␊ - /**␊ - * Name of the frontend IP configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendIPConfigurationPropertiesFormat11 {␊ - /**␊ - * PrivateIPAddress of the network interface IP Configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * PrivateIP allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Reference of the subnet resource.␊ - */␊ - subnet?: (SubResource18 | string)␊ - /**␊ - * Reference of the PublicIP resource.␊ - */␊ - publicIPAddress?: (SubResource18 | string)␊ - /**␊ - * Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend port of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendPort11 {␊ - properties?: (ApplicationGatewayFrontendPortPropertiesFormat11 | string)␊ - /**␊ - * Name of the frontend port that is unique within an Application Gateway␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend port of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendPortPropertiesFormat11 {␊ - /**␊ - * Frontend port␊ - */␊ - port?: (number | string)␊ - /**␊ - * Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Probe of the application gateway.␊ - */␊ - export interface ApplicationGatewayProbe10 {␊ - properties?: (ApplicationGatewayProbePropertiesFormat10 | string)␊ - /**␊ - * Name of the probe that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of probe of an application gateway.␊ - */␊ - export interface ApplicationGatewayProbePropertiesFormat10 {␊ - /**␊ - * The protocol used for the probe. Possible values are 'Http' and 'Https'.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Host name to send the probe to.␊ - */␊ - host?: string␊ - /**␊ - * Relative path of probe. Valid path starts from '/'. Probe is sent to ://:␊ - */␊ - path?: string␊ - /**␊ - * The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - interval?: (number | string)␊ - /**␊ - * the probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - timeout?: (number | string)␊ - /**␊ - * The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20.␊ - */␊ - unhealthyThreshold?: (number | string)␊ - /**␊ - * Whether the host header should be picked from the backend http settings. Default value is false.␊ - */␊ - pickHostNameFromBackendHttpSettings?: (boolean | string)␊ - /**␊ - * Minimum number of servers that are always marked healthy. Default value is 0.␊ - */␊ - minServers?: (number | string)␊ - /**␊ - * Criterion for classifying a healthy probe response.␊ - */␊ - match?: (ApplicationGatewayProbeHealthResponseMatch8 | string)␊ - /**␊ - * Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application gateway probe health response match␊ - */␊ - export interface ApplicationGatewayProbeHealthResponseMatch8 {␊ - /**␊ - * Body that must be contained in the health response. Default value is empty.␊ - */␊ - body?: string␊ - /**␊ - * Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399.␊ - */␊ - statusCodes?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend Address Pool of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddressPool11 {␊ - properties?: (ApplicationGatewayBackendAddressPoolPropertiesFormat11 | string)␊ - /**␊ - * Name of the backend address pool that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend Address Pool of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddressPoolPropertiesFormat11 {␊ - /**␊ - * Collection of references to IPs defined in network interfaces.␊ - */␊ - backendIPConfigurations?: (SubResource18[] | string)␊ - /**␊ - * Backend addresses␊ - */␊ - backendAddresses?: (ApplicationGatewayBackendAddress11[] | string)␊ - /**␊ - * Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddress11 {␊ - /**␊ - * Fully qualified domain name (FQDN).␊ - */␊ - fqdn?: string␊ - /**␊ - * IP address␊ - */␊ - ipAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address pool settings of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendHttpSettings11 {␊ - properties?: (ApplicationGatewayBackendHttpSettingsPropertiesFormat11 | string)␊ - /**␊ - * Name of the backend http settings that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend address pool settings of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendHttpSettingsPropertiesFormat11 {␊ - /**␊ - * The destination port on the backend.␊ - */␊ - port?: (number | string)␊ - /**␊ - * The protocol used to communicate with the backend. Possible values are 'Http' and 'Https'.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Cookie based affinity.␊ - */␊ - cookieBasedAffinity?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Request timeout in seconds. Application Gateway will fail the request if response is not received within RequestTimeout. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - requestTimeout?: (number | string)␊ - /**␊ - * Probe resource of an application gateway.␊ - */␊ - probe?: (SubResource18 | string)␊ - /**␊ - * Array of references to application gateway authentication certificates.␊ - */␊ - authenticationCertificates?: (SubResource18[] | string)␊ - /**␊ - * Connection draining of the backend http settings resource.␊ - */␊ - connectionDraining?: (ApplicationGatewayConnectionDraining8 | string)␊ - /**␊ - * Host header to be sent to the backend servers.␊ - */␊ - hostName?: string␊ - /**␊ - * Whether to pick host header should be picked from the host name of the backend server. Default value is false.␊ - */␊ - pickHostNameFromBackendAddress?: (boolean | string)␊ - /**␊ - * Cookie name to use for the affinity cookie.␊ - */␊ - affinityCookieName?: string␊ - /**␊ - * Whether the probe is enabled. Default value is false.␊ - */␊ - probeEnabled?: (boolean | string)␊ - /**␊ - * Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null.␊ - */␊ - path?: string␊ - /**␊ - * Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Connection draining allows open connections to a backend server to be active for a specified time after the backend server got removed from the configuration.␊ - */␊ - export interface ApplicationGatewayConnectionDraining8 {␊ - /**␊ - * Whether connection draining is enabled or not.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds.␊ - */␊ - drainTimeoutInSec: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http listener of an application gateway.␊ - */␊ - export interface ApplicationGatewayHttpListener11 {␊ - properties?: (ApplicationGatewayHttpListenerPropertiesFormat11 | string)␊ - /**␊ - * Name of the HTTP listener that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of HTTP listener of an application gateway.␊ - */␊ - export interface ApplicationGatewayHttpListenerPropertiesFormat11 {␊ - /**␊ - * Frontend IP configuration resource of an application gateway.␊ - */␊ - frontendIPConfiguration?: (SubResource18 | string)␊ - /**␊ - * Frontend port resource of an application gateway.␊ - */␊ - frontendPort?: (SubResource18 | string)␊ - /**␊ - * Protocol of the HTTP listener. Possible values are 'Http' and 'Https'.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Host name of HTTP listener.␊ - */␊ - hostName?: string␊ - /**␊ - * SSL certificate resource of an application gateway.␊ - */␊ - sslCertificate?: (SubResource18 | string)␊ - /**␊ - * Applicable only if protocol is https. Enables SNI for multi-hosting.␊ - */␊ - requireServerNameIndication?: (boolean | string)␊ - /**␊ - * Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * UrlPathMaps give a url path to the backend mapping information for PathBasedRouting.␊ - */␊ - export interface ApplicationGatewayUrlPathMap10 {␊ - properties?: (ApplicationGatewayUrlPathMapPropertiesFormat10 | string)␊ - /**␊ - * Name of the URL path map that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of UrlPathMap of the application gateway.␊ - */␊ - export interface ApplicationGatewayUrlPathMapPropertiesFormat10 {␊ - /**␊ - * Default backend address pool resource of URL path map.␊ - */␊ - defaultBackendAddressPool?: (SubResource18 | string)␊ - /**␊ - * Default backend http settings resource of URL path map.␊ - */␊ - defaultBackendHttpSettings?: (SubResource18 | string)␊ - /**␊ - * Default redirect configuration resource of URL path map.␊ - */␊ - defaultRedirectConfiguration?: (SubResource18 | string)␊ - /**␊ - * Path rule of URL path map resource.␊ - */␊ - pathRules?: (ApplicationGatewayPathRule10[] | string)␊ - /**␊ - * Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Path rule of URL path map of an application gateway.␊ - */␊ - export interface ApplicationGatewayPathRule10 {␊ - properties?: (ApplicationGatewayPathRulePropertiesFormat10 | string)␊ - /**␊ - * Name of the path rule that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of path rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayPathRulePropertiesFormat10 {␊ - /**␊ - * Path rules of URL path map.␊ - */␊ - paths?: (string[] | string)␊ - /**␊ - * Backend address pool resource of URL path map path rule.␊ - */␊ - backendAddressPool?: (SubResource18 | string)␊ - /**␊ - * Backend http settings resource of URL path map path rule.␊ - */␊ - backendHttpSettings?: (SubResource18 | string)␊ - /**␊ - * Redirect configuration resource of URL path map path rule.␊ - */␊ - redirectConfiguration?: (SubResource18 | string)␊ - /**␊ - * Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Request routing rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayRequestRoutingRule11 {␊ - properties?: (ApplicationGatewayRequestRoutingRulePropertiesFormat11 | string)␊ - /**␊ - * Name of the request routing rule that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of request routing rule of the application gateway.␊ - */␊ - export interface ApplicationGatewayRequestRoutingRulePropertiesFormat11 {␊ - /**␊ - * Rule type.␊ - */␊ - ruleType?: (("Basic" | "PathBasedRouting") | string)␊ - /**␊ - * Backend address pool resource of the application gateway. ␊ - */␊ - backendAddressPool?: (SubResource18 | string)␊ - /**␊ - * Backend http settings resource of the application gateway.␊ - */␊ - backendHttpSettings?: (SubResource18 | string)␊ - /**␊ - * Http listener resource of the application gateway. ␊ - */␊ - httpListener?: (SubResource18 | string)␊ - /**␊ - * URL path map resource of the application gateway.␊ - */␊ - urlPathMap?: (SubResource18 | string)␊ - /**␊ - * Redirect configuration resource of the application gateway.␊ - */␊ - redirectConfiguration?: (SubResource18 | string)␊ - /**␊ - * Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Redirect configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayRedirectConfiguration8 {␊ - properties?: (ApplicationGatewayRedirectConfigurationPropertiesFormat8 | string)␊ - /**␊ - * Name of the redirect configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of redirect configuration of the application gateway.␊ - */␊ - export interface ApplicationGatewayRedirectConfigurationPropertiesFormat8 {␊ - /**␊ - * Supported http redirection types - Permanent, Temporary, Found, SeeOther.␊ - */␊ - redirectType?: (("Permanent" | "Found" | "SeeOther" | "Temporary") | string)␊ - /**␊ - * Reference to a listener to redirect the request to.␊ - */␊ - targetListener?: (SubResource18 | string)␊ - /**␊ - * Url to redirect the request to.␊ - */␊ - targetUrl?: string␊ - /**␊ - * Include path in the redirected url.␊ - */␊ - includePath?: (boolean | string)␊ - /**␊ - * Include query string in the redirected url.␊ - */␊ - includeQueryString?: (boolean | string)␊ - /**␊ - * Request routing specifying redirect configuration.␊ - */␊ - requestRoutingRules?: (SubResource18[] | string)␊ - /**␊ - * Url path maps specifying default redirect configuration.␊ - */␊ - urlPathMaps?: (SubResource18[] | string)␊ - /**␊ - * Path rules specifying redirect configuration.␊ - */␊ - pathRules?: (SubResource18[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application gateway web application firewall configuration.␊ - */␊ - export interface ApplicationGatewayWebApplicationFirewallConfiguration8 {␊ - /**␊ - * Whether the web application firewall is enabled or not.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * Web application firewall mode.␊ - */␊ - firewallMode: (("Detection" | "Prevention") | string)␊ - /**␊ - * The type of the web application firewall rule set. Possible values are: 'OWASP'.␊ - */␊ - ruleSetType: string␊ - /**␊ - * The version of the rule set type.␊ - */␊ - ruleSetVersion: string␊ - /**␊ - * The disabled rule groups.␊ - */␊ - disabledRuleGroups?: (ApplicationGatewayFirewallDisabledRuleGroup8[] | string)␊ - /**␊ - * Whether allow WAF to check request Body.␊ - */␊ - requestBodyCheck?: (boolean | string)␊ - /**␊ - * Maximum request body size for WAF.␊ - */␊ - maxRequestBodySize?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allows to disable rules within a rule group or an entire rule group.␊ - */␊ - export interface ApplicationGatewayFirewallDisabledRuleGroup8 {␊ - /**␊ - * The name of the rule group that will be disabled.␊ - */␊ - ruleGroupName: string␊ - /**␊ - * The list of rules that will be disabled. If null, all rules of the rule group will be disabled.␊ - */␊ - rules?: (number[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application Gateway autoscale configuration.␊ - */␊ - export interface ApplicationGatewayAutoscaleConfiguration2 {␊ - /**␊ - * Autoscale bounds␊ - */␊ - bounds: (ApplicationGatewayAutoscaleBounds2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application Gateway autoscale bounds on number of Application Gateway instance.␊ - */␊ - export interface ApplicationGatewayAutoscaleBounds2 {␊ - /**␊ - * Lower bound on number of Application Gateway instances.␊ - */␊ - min: (number | string)␊ - /**␊ - * Upper bound on number of Application Gateway instances.␊ - */␊ - max: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/applicationSecurityGroups␊ - */␊ - export interface ApplicationSecurityGroups7 {␊ - name: string␊ - type: "Microsoft.Network/applicationSecurityGroups"␊ - apiVersion: "2018-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the application security group.␊ - */␊ - properties: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/azureFirewalls␊ - */␊ - export interface AzureFirewalls2 {␊ - name: string␊ - type: "Microsoft.Network/azureFirewalls"␊ - apiVersion: "2018-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (AzureFirewallPropertiesFormat2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Azure Firewall.␊ - */␊ - export interface AzureFirewallPropertiesFormat2 {␊ - /**␊ - * Collection of application rule collections used by a Azure Firewall.␊ - */␊ - applicationRuleCollections?: (AzureFirewallApplicationRuleCollection2[] | string)␊ - /**␊ - * Collection of network rule collections used by a Azure Firewall.␊ - */␊ - networkRuleCollections?: (AzureFirewallNetworkRuleCollection2[] | string)␊ - /**␊ - * IP configuration of the Azure Firewall resource.␊ - */␊ - ipConfigurations?: (AzureFirewallIPConfiguration2[] | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: (("Succeeded" | "Updating" | "Deleting" | "Failed") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application rule collection resource␊ - */␊ - export interface AzureFirewallApplicationRuleCollection2 {␊ - properties?: (AzureFirewallApplicationRuleCollectionPropertiesFormat2 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application rule collection.␊ - */␊ - export interface AzureFirewallApplicationRuleCollectionPropertiesFormat2 {␊ - /**␊ - * Priority of the application rule collection resource.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * The action type of a rule collection␊ - */␊ - action?: (AzureFirewallRCAction2 | string)␊ - /**␊ - * Collection of rules used by a application rule collection.␊ - */␊ - rules?: (AzureFirewallApplicationRule2[] | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: (("Succeeded" | "Updating" | "Deleting" | "Failed") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the AzureFirewallRCAction.␊ - */␊ - export interface AzureFirewallRCAction2 {␊ - /**␊ - * The type of action.␊ - */␊ - type?: ("Allow" | "Deny")␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of an application rule.␊ - */␊ - export interface AzureFirewallApplicationRule2 {␊ - /**␊ - * Name of the application rule.␊ - */␊ - name?: string␊ - /**␊ - * Description of the rule.␊ - */␊ - description?: string␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * Array of ApplicationRuleProtocols.␊ - */␊ - protocols?: (AzureFirewallApplicationRuleProtocol2[] | string)␊ - /**␊ - * List of URLs for this rule.␊ - */␊ - targetUrls?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application rule protocol.␊ - */␊ - export interface AzureFirewallApplicationRuleProtocol2 {␊ - /**␊ - * Protocol type.␊ - */␊ - protocolType?: (("Http" | "Https") | string)␊ - /**␊ - * Port number for the protocol, cannot be greater than 64000. This field is optional.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network rule collection resource␊ - */␊ - export interface AzureFirewallNetworkRuleCollection2 {␊ - properties?: (AzureFirewallNetworkRuleCollectionPropertiesFormat2 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the network rule collection.␊ - */␊ - export interface AzureFirewallNetworkRuleCollectionPropertiesFormat2 {␊ - /**␊ - * Priority of the network rule collection resource.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * The action type of a rule collection␊ - */␊ - action?: (AzureFirewallRCAction2 | string)␊ - /**␊ - * Collection of rules used by a network rule collection.␊ - */␊ - rules?: (AzureFirewallNetworkRule2[] | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: (("Succeeded" | "Updating" | "Deleting" | "Failed") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the network rule.␊ - */␊ - export interface AzureFirewallNetworkRule2 {␊ - /**␊ - * Name of the network rule.␊ - */␊ - name?: string␊ - /**␊ - * Description of the rule.␊ - */␊ - description?: string␊ - /**␊ - * Array of AzureFirewallNetworkRuleProtocols.␊ - */␊ - protocols?: (("TCP" | "UDP" | "Any" | "ICMP")[] | string)␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * List of destination IP addresses.␊ - */␊ - destinationAddresses?: (string[] | string)␊ - /**␊ - * List of destination ports.␊ - */␊ - destinationPorts?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration of an Azure Firewall.␊ - */␊ - export interface AzureFirewallIPConfiguration2 {␊ - properties?: (AzureFirewallIPConfigurationPropertiesFormat2 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration of an Azure Firewall.␊ - */␊ - export interface AzureFirewallIPConfigurationPropertiesFormat2 {␊ - /**␊ - * The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * Reference of the subnet resource. This resource must be named 'AzureFirewallSubnet'.␊ - */␊ - subnet?: (SubResource18 | string)␊ - /**␊ - * Reference of the PublicIP resource. This field is a mandatory input.␊ - */␊ - internalPublicIpAddress?: (SubResource18 | string)␊ - /**␊ - * Reference of the PublicIP resource. This field is populated in the output.␊ - */␊ - publicIPAddress?: (SubResource18 | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: (("Succeeded" | "Updating" | "Deleting" | "Failed") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/connections␊ - */␊ - export interface Connections11 {␊ - name: string␊ - type: "Microsoft.Network/connections"␊ - apiVersion: "2018-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway connection.␊ - */␊ - properties: (VirtualNetworkGatewayConnectionPropertiesFormat11 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewayConnection properties␊ - */␊ - export interface VirtualNetworkGatewayConnectionPropertiesFormat11 {␊ - /**␊ - * The authorizationKey.␊ - */␊ - authorizationKey?: string␊ - /**␊ - * The reference to virtual network gateway resource.␊ - */␊ - virtualNetworkGateway1: (VirtualNetworkGateway7 | SubResource18 | string)␊ - /**␊ - * The reference to virtual network gateway resource.␊ - */␊ - virtualNetworkGateway2?: (VirtualNetworkGateway7 | SubResource18 | string)␊ - /**␊ - * The reference to local network gateway resource.␊ - */␊ - localNetworkGateway2?: (LocalNetworkGateway7 | SubResource18 | string)␊ - /**␊ - * Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.␊ - */␊ - connectionType: (("IPsec" | "Vnet2Vnet" | "ExpressRoute" | "VPNClient") | string)␊ - /**␊ - * The routing weight.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * The IPSec shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The reference to peerings resource.␊ - */␊ - peer?: (SubResource18 | string)␊ - /**␊ - * EnableBgp flag␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * Enable policy-based traffic selectors.␊ - */␊ - usePolicyBasedTrafficSelectors?: (boolean | string)␊ - /**␊ - * The IPSec Policies to be considered by this connection.␊ - */␊ - ipsecPolicies?: (IpsecPolicy8[] | string)␊ - /**␊ - * The resource GUID property of the VirtualNetworkGatewayConnection resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Bypass ExpressRoute Gateway for data forwarding␊ - */␊ - expressRouteGatewayBypass?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A common class for general resource information␊ - */␊ - export interface VirtualNetworkGateway7 {␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway.␊ - */␊ - properties: (VirtualNetworkGatewayPropertiesFormat11 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGateway properties␊ - */␊ - export interface VirtualNetworkGatewayPropertiesFormat11 {␊ - /**␊ - * IP configurations for virtual network gateway.␊ - */␊ - ipConfigurations?: (VirtualNetworkGatewayIPConfiguration10[] | string)␊ - /**␊ - * The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'.␊ - */␊ - gatewayType?: (("Vpn" | "ExpressRoute") | string)␊ - /**␊ - * The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'.␊ - */␊ - vpnType?: (("PolicyBased" | "RouteBased") | string)␊ - /**␊ - * Whether BGP is enabled for this virtual network gateway or not.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * ActiveActive flag␊ - */␊ - activeActive?: (boolean | string)␊ - /**␊ - * The reference of the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting.␊ - */␊ - gatewayDefaultSite?: (SubResource18 | string)␊ - /**␊ - * The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.␊ - */␊ - sku?: (VirtualNetworkGatewaySku10 | string)␊ - /**␊ - * The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations.␊ - */␊ - vpnClientConfiguration?: (VpnClientConfiguration10 | string)␊ - /**␊ - * Virtual network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings10 | string)␊ - /**␊ - * The resource GUID property of the VirtualNetworkGateway resource.␊ - */␊ - resourceGuid?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration for virtual network gateway␊ - */␊ - export interface VirtualNetworkGatewayIPConfiguration10 {␊ - /**␊ - * Properties of the virtual network gateway ip configuration.␊ - */␊ - properties?: (VirtualNetworkGatewayIPConfigurationPropertiesFormat10 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of VirtualNetworkGatewayIPConfiguration␊ - */␊ - export interface VirtualNetworkGatewayIPConfigurationPropertiesFormat10 {␊ - /**␊ - * The private IP allocation method. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * The reference of the subnet resource.␊ - */␊ - subnet?: (SubResource18 | string)␊ - /**␊ - * The reference of the public IP resource.␊ - */␊ - publicIPAddress?: (SubResource18 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewaySku details␊ - */␊ - export interface VirtualNetworkGatewaySku10 {␊ - /**␊ - * Gateway SKU name.␊ - */␊ - name?: (("Basic" | "HighPerformance" | "Standard" | "UltraPerformance" | "VpnGw1" | "VpnGw2" | "VpnGw3" | "VpnGw1AZ" | "VpnGw2AZ" | "VpnGw3AZ" | "ErGw1AZ" | "ErGw2AZ" | "ErGw3AZ") | string)␊ - /**␊ - * Gateway SKU tier.␊ - */␊ - tier?: (("Basic" | "HighPerformance" | "Standard" | "UltraPerformance" | "VpnGw1" | "VpnGw2" | "VpnGw3" | "VpnGw1AZ" | "VpnGw2AZ" | "VpnGw3AZ" | "ErGw1AZ" | "ErGw2AZ" | "ErGw3AZ") | string)␊ - /**␊ - * The capacity.␊ - */␊ - capacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnClientConfiguration for P2S client.␊ - */␊ - export interface VpnClientConfiguration10 {␊ - /**␊ - * The reference of the address space resource which represents Address space for P2S VpnClient.␊ - */␊ - vpnClientAddressPool?: (AddressSpace20 | string)␊ - /**␊ - * VpnClientRootCertificate for virtual network gateway.␊ - */␊ - vpnClientRootCertificates?: (VpnClientRootCertificate10[] | string)␊ - /**␊ - * VpnClientRevokedCertificate for Virtual network gateway.␊ - */␊ - vpnClientRevokedCertificates?: (VpnClientRevokedCertificate10[] | string)␊ - /**␊ - * VpnClientProtocols for Virtual network gateway.␊ - */␊ - vpnClientProtocols?: (("IkeV2" | "SSTP" | "OpenVPN")[] | string)␊ - /**␊ - * VpnClientIpsecPolicies for virtual network gateway P2S client.␊ - */␊ - vpnClientIpsecPolicies?: (IpsecPolicy8[] | string)␊ - /**␊ - * The radius server address property of the VirtualNetworkGateway resource for vpn client connection.␊ - */␊ - radiusServerAddress?: string␊ - /**␊ - * The radius secret property of the VirtualNetworkGateway resource for vpn client connection.␊ - */␊ - radiusServerSecret?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.␊ - */␊ - export interface AddressSpace20 {␊ - /**␊ - * A list of address blocks reserved for this virtual network in CIDR notation.␊ - */␊ - addressPrefixes: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client root certificate of virtual network gateway␊ - */␊ - export interface VpnClientRootCertificate10 {␊ - /**␊ - * Properties of the vpn client root certificate.␊ - */␊ - properties: (VpnClientRootCertificatePropertiesFormat10 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of application gateway␊ - */␊ - export interface VpnClientRootCertificatePropertiesFormat10 {␊ - /**␊ - * The certificate public data.␊ - */␊ - publicCertData: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client revoked certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRevokedCertificate10 {␊ - /**␊ - * Properties of the vpn client revoked certificate.␊ - */␊ - properties?: (VpnClientRevokedCertificatePropertiesFormat10 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the revoked VPN client certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRevokedCertificatePropertiesFormat10 {␊ - /**␊ - * The revoked VPN client certificate thumbprint.␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An IPSec Policy configuration for a virtual network gateway connection␊ - */␊ - export interface IpsecPolicy8 {␊ - /**␊ - * The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.␊ - */␊ - saLifeTimeSeconds: (number | string)␊ - /**␊ - * The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.␊ - */␊ - saDataSizeKilobytes: (number | string)␊ - /**␊ - * The IPSec encryption algorithm (IKE phase 1).␊ - */␊ - ipsecEncryption: (("None" | "DES" | "DES3" | "AES128" | "AES192" | "AES256" | "GCMAES128" | "GCMAES192" | "GCMAES256") | string)␊ - /**␊ - * The IPSec integrity algorithm (IKE phase 1).␊ - */␊ - ipsecIntegrity: (("MD5" | "SHA1" | "SHA256" | "GCMAES128" | "GCMAES192" | "GCMAES256") | string)␊ - /**␊ - * The IKE encryption algorithm (IKE phase 2).␊ - */␊ - ikeEncryption: (("DES" | "DES3" | "AES128" | "AES192" | "AES256" | "GCMAES256" | "GCMAES128") | string)␊ - /**␊ - * The IKE integrity algorithm (IKE phase 2).␊ - */␊ - ikeIntegrity: (("MD5" | "SHA1" | "SHA256" | "SHA384" | "GCMAES256" | "GCMAES128") | string)␊ - /**␊ - * The DH Groups used in IKE Phase 1 for initial SA.␊ - */␊ - dhGroup: (("None" | "DHGroup1" | "DHGroup2" | "DHGroup14" | "DHGroup2048" | "ECP256" | "ECP384" | "DHGroup24") | string)␊ - /**␊ - * The Pfs Groups used in IKE Phase 2 for new child SA.␊ - */␊ - pfsGroup: (("None" | "PFS1" | "PFS2" | "PFS2048" | "ECP256" | "ECP384" | "PFS24" | "PFS14" | "PFSMM") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * BGP settings details␊ - */␊ - export interface BgpSettings10 {␊ - /**␊ - * The BGP speaker's ASN.␊ - */␊ - asn?: (number | string)␊ - /**␊ - * The BGP peering address and BGP identifier of this BGP speaker.␊ - */␊ - bgpPeeringAddress?: string␊ - /**␊ - * The weight added to routes learned from this BGP speaker.␊ - */␊ - peerWeight?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A common class for general resource information␊ - */␊ - export interface LocalNetworkGateway7 {␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the local network gateway.␊ - */␊ - properties: (LocalNetworkGatewayPropertiesFormat11 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * LocalNetworkGateway properties␊ - */␊ - export interface LocalNetworkGatewayPropertiesFormat11 {␊ - /**␊ - * Local network site address space.␊ - */␊ - localNetworkAddressSpace?: (AddressSpace20 | string)␊ - /**␊ - * IP address of local network gateway.␊ - */␊ - gatewayIpAddress?: string␊ - /**␊ - * Local network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings10 | string)␊ - /**␊ - * The resource GUID property of the LocalNetworkGateway resource.␊ - */␊ - resourceGuid?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ddosProtectionPlans␊ - */␊ - export interface DdosProtectionPlans3 {␊ - name: string␊ - type: "Microsoft.Network/ddosProtectionPlans"␊ - apiVersion: "2018-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the DDoS protection plan.␊ - */␊ - properties: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits␊ - */␊ - export interface ExpressRouteCircuits5 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits"␊ - apiVersion: "2018-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The SKU.␊ - */␊ - sku?: (ExpressRouteCircuitSku5 | string)␊ - properties: (ExpressRouteCircuitPropertiesFormat5 | string)␊ - resources?: (ExpressRouteCircuitsPeeringsChildResource5 | ExpressRouteCircuitsAuthorizationsChildResource5)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains SKU in an ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitSku5 {␊ - /**␊ - * The name of the SKU.␊ - */␊ - name?: string␊ - /**␊ - * The tier of the SKU. Possible values are 'Standard' and 'Premium'.␊ - */␊ - tier?: (("Standard" | "Premium") | string)␊ - /**␊ - * The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'.␊ - */␊ - family?: (("UnlimitedData" | "MeteredData") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitPropertiesFormat5 {␊ - /**␊ - * Allow classic operations␊ - */␊ - allowClassicOperations?: (boolean | string)␊ - /**␊ - * The CircuitProvisioningState state of the resource.␊ - */␊ - circuitProvisioningState?: string␊ - /**␊ - * The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'.␊ - */␊ - serviceProviderProvisioningState?: (("NotProvisioned" | "Provisioning" | "Provisioned" | "Deprovisioning") | string)␊ - /**␊ - * The list of authorizations.␊ - */␊ - authorizations?: (ExpressRouteCircuitAuthorization5[] | string)␊ - /**␊ - * The list of peerings.␊ - */␊ - peerings?: (ExpressRouteCircuitPeering5[] | string)␊ - /**␊ - * The ServiceKey.␊ - */␊ - serviceKey?: string␊ - /**␊ - * The ServiceProviderNotes.␊ - */␊ - serviceProviderNotes?: string␊ - /**␊ - * The ServiceProviderProperties.␊ - */␊ - serviceProviderProperties?: (ExpressRouteCircuitServiceProviderProperties5 | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - /**␊ - * Flag to enable Global Reach on the circuit.␊ - */␊ - allowGlobalReach?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authorization in an ExpressRouteCircuit resource.␊ - */␊ - export interface ExpressRouteCircuitAuthorization5 {␊ - properties?: (AuthorizationPropertiesFormat6 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - export interface AuthorizationPropertiesFormat6 {␊ - /**␊ - * The authorization key.␊ - */␊ - authorizationKey?: string␊ - /**␊ - * AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'.␊ - */␊ - authorizationUseStatus?: (("Available" | "InUse") | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peering in an ExpressRouteCircuit resource.␊ - */␊ - export interface ExpressRouteCircuitPeering5 {␊ - properties?: (ExpressRouteCircuitPeeringPropertiesFormat6 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - export interface ExpressRouteCircuitPeeringPropertiesFormat6 {␊ - /**␊ - * The peering type.␊ - */␊ - peeringType?: (("AzurePublicPeering" | "AzurePrivatePeering" | "MicrosoftPeering") | string)␊ - /**␊ - * The peering state.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * The Azure ASN.␊ - */␊ - azureASN?: (number | string)␊ - /**␊ - * The peer ASN.␊ - */␊ - peerASN?: (number | string)␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The primary port.␊ - */␊ - primaryAzurePort?: string␊ - /**␊ - * The secondary port.␊ - */␊ - secondaryAzurePort?: string␊ - /**␊ - * The shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The VLAN ID.␊ - */␊ - vlanId?: (number | string)␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig6 | string)␊ - /**␊ - * Gets peering stats.␊ - */␊ - stats?: (ExpressRouteCircuitStats6 | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - /**␊ - * Gets whether the provider or the customer last modified the peering.␊ - */␊ - lastModifiedBy?: string␊ - /**␊ - * The reference of the RouteFilter resource.␊ - */␊ - routeFilter?: (SubResource18 | string)␊ - /**␊ - * The IPv6 peering configuration.␊ - */␊ - ipv6PeeringConfig?: (Ipv6ExpressRouteCircuitPeeringConfig3 | string)␊ - /**␊ - * The list of circuit connections associated with Azure Private Peering for this circuit.␊ - */␊ - connections?: (ExpressRouteCircuitConnection3[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the peering configuration.␊ - */␊ - export interface ExpressRouteCircuitPeeringConfig6 {␊ - /**␊ - * The reference of AdvertisedPublicPrefixes.␊ - */␊ - advertisedPublicPrefixes?: (string[] | string)␊ - /**␊ - * The communities of bgp peering. Specified for microsoft peering␊ - */␊ - advertisedCommunities?: (string[] | string)␊ - /**␊ - * AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'.␊ - */␊ - advertisedPublicPrefixesState?: (("NotConfigured" | "Configuring" | "Configured" | "ValidationNeeded") | string)␊ - /**␊ - * The legacy mode of the peering.␊ - */␊ - legacyMode?: (number | string)␊ - /**␊ - * The CustomerASN of the peering.␊ - */␊ - customerASN?: (number | string)␊ - /**␊ - * The RoutingRegistryName of the configuration.␊ - */␊ - routingRegistryName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains stats associated with the peering.␊ - */␊ - export interface ExpressRouteCircuitStats6 {␊ - /**␊ - * Gets BytesIn of the peering.␊ - */␊ - primarybytesIn?: (number | string)␊ - /**␊ - * Gets BytesOut of the peering.␊ - */␊ - primarybytesOut?: (number | string)␊ - /**␊ - * Gets BytesIn of the peering.␊ - */␊ - secondarybytesIn?: (number | string)␊ - /**␊ - * Gets BytesOut of the peering.␊ - */␊ - secondarybytesOut?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains IPv6 peering config.␊ - */␊ - export interface Ipv6ExpressRouteCircuitPeeringConfig3 {␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig6 | string)␊ - /**␊ - * The reference of the RouteFilter resource.␊ - */␊ - routeFilter?: (SubResource18 | string)␊ - /**␊ - * The state of peering. Possible values are: 'Disabled' and 'Enabled'.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Express Route Circuit Connection in an ExpressRouteCircuitPeering resource.␊ - */␊ - export interface ExpressRouteCircuitConnection3 {␊ - properties?: (ExpressRouteCircuitConnectionPropertiesFormat3 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - export interface ExpressRouteCircuitConnectionPropertiesFormat3 {␊ - /**␊ - * Reference to Express Route Circuit Private Peering Resource of the circuit initiating connection.␊ - */␊ - expressRouteCircuitPeering?: (SubResource18 | string)␊ - /**␊ - * Reference to Express Route Circuit Private Peering Resource of the peered circuit.␊ - */␊ - peerExpressRouteCircuitPeering?: (SubResource18 | string)␊ - /**␊ - * /29 IP address space to carve out Customer addresses for tunnels.␊ - */␊ - addressPrefix?: string␊ - /**␊ - * The authorization key.␊ - */␊ - authorizationKey?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains ServiceProviderProperties in an ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitServiceProviderProperties5 {␊ - /**␊ - * The serviceProviderName.␊ - */␊ - serviceProviderName?: string␊ - /**␊ - * The peering location.␊ - */␊ - peeringLocation?: string␊ - /**␊ - * The BandwidthInMbps.␊ - */␊ - bandwidthInMbps?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings␊ - */␊ - export interface ExpressRouteCircuitsPeeringsChildResource5 {␊ - name: string␊ - type: "peerings"␊ - apiVersion: "2018-07-01"␊ - properties: (ExpressRouteCircuitPeeringPropertiesFormat6 | string)␊ - resources?: ExpressRouteCircuitsPeeringsConnectionsChildResource3[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings/connections␊ - */␊ - export interface ExpressRouteCircuitsPeeringsConnectionsChildResource3 {␊ - name: string␊ - type: "connections"␊ - apiVersion: "2018-07-01"␊ - properties: (ExpressRouteCircuitConnectionPropertiesFormat3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/authorizations␊ - */␊ - export interface ExpressRouteCircuitsAuthorizationsChildResource5 {␊ - name: string␊ - type: "authorizations"␊ - apiVersion: "2018-07-01"␊ - properties: (AuthorizationPropertiesFormat6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/authorizations␊ - */␊ - export interface ExpressRouteCircuitsAuthorizations6 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/authorizations"␊ - apiVersion: "2018-07-01"␊ - properties: (AuthorizationPropertiesFormat6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings␊ - */␊ - export interface ExpressRouteCircuitsPeerings6 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/peerings"␊ - apiVersion: "2018-07-01"␊ - properties: (ExpressRouteCircuitPeeringPropertiesFormat6 | string)␊ - resources?: ExpressRouteCircuitsPeeringsConnectionsChildResource3[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings/connections␊ - */␊ - export interface ExpressRouteCircuitsPeeringsConnections3 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/peerings/connections"␊ - apiVersion: "2018-07-01"␊ - properties: (ExpressRouteCircuitConnectionPropertiesFormat3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections␊ - */␊ - export interface ExpressRouteCrossConnections3 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCrossConnections"␊ - apiVersion: "2018-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (ExpressRouteCrossConnectionProperties3 | string)␊ - resources?: ExpressRouteCrossConnectionsPeeringsChildResource3[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ExpressRouteCrossConnection.␊ - */␊ - export interface ExpressRouteCrossConnectionProperties3 {␊ - /**␊ - * The peering location of the ExpressRoute circuit.␊ - */␊ - peeringLocation?: string␊ - /**␊ - * The circuit bandwidth In Mbps.␊ - */␊ - bandwidthInMbps?: (number | string)␊ - /**␊ - * The ExpressRouteCircuit␊ - */␊ - expressRouteCircuit?: (ExpressRouteCircuitReference2 | string)␊ - /**␊ - * The provisioning state of the circuit in the connectivity provider system. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned'.␊ - */␊ - serviceProviderProvisioningState?: (("NotProvisioned" | "Provisioning" | "Provisioned" | "Deprovisioning") | string)␊ - /**␊ - * Additional read only notes set by the connectivity provider.␊ - */␊ - serviceProviderNotes?: string␊ - /**␊ - * The list of peerings.␊ - */␊ - peerings?: (ExpressRouteCrossConnectionPeering3[] | string)␊ - [k: string]: unknown␊ - }␊ - export interface ExpressRouteCircuitReference2 {␊ - /**␊ - * Corresponding Express Route Circuit Id.␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peering in an ExpressRoute Cross Connection resource.␊ - */␊ - export interface ExpressRouteCrossConnectionPeering3 {␊ - properties?: (ExpressRouteCrossConnectionPeeringProperties3 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - export interface ExpressRouteCrossConnectionPeeringProperties3 {␊ - /**␊ - * The peering type.␊ - */␊ - peeringType?: (("AzurePublicPeering" | "AzurePrivatePeering" | "MicrosoftPeering") | string)␊ - /**␊ - * The peering state.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * The peer ASN.␊ - */␊ - peerASN?: (number | string)␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The VLAN ID.␊ - */␊ - vlanId?: (number | string)␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig6 | string)␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - /**␊ - * Gets whether the provider or the customer last modified the peering.␊ - */␊ - lastModifiedBy?: string␊ - /**␊ - * The IPv6 peering configuration.␊ - */␊ - ipv6PeeringConfig?: (Ipv6ExpressRouteCircuitPeeringConfig3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections/peerings␊ - */␊ - export interface ExpressRouteCrossConnectionsPeeringsChildResource3 {␊ - name: string␊ - type: "peerings"␊ - apiVersion: "2018-07-01"␊ - properties: (ExpressRouteCrossConnectionPeeringProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections/peerings␊ - */␊ - export interface ExpressRouteCrossConnectionsPeerings3 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCrossConnections/peerings"␊ - apiVersion: "2018-07-01"␊ - properties: (ExpressRouteCrossConnectionPeeringProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers␊ - */␊ - export interface LoadBalancers20 {␊ - name: string␊ - type: "Microsoft.Network/loadBalancers"␊ - apiVersion: "2018-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The load balancer SKU.␊ - */␊ - sku?: (LoadBalancerSku8 | string)␊ - /**␊ - * Properties of load balancer.␊ - */␊ - properties: (LoadBalancerPropertiesFormat12 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: LoadBalancersInboundNatRulesChildResource8[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a load balancer␊ - */␊ - export interface LoadBalancerSku8 {␊ - /**␊ - * Name of a load balancer SKU.␊ - */␊ - name?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer.␊ - */␊ - export interface LoadBalancerPropertiesFormat12 {␊ - /**␊ - * Object representing the frontend IPs to be used for the load balancer␊ - */␊ - frontendIPConfigurations?: (FrontendIPConfiguration11[] | string)␊ - /**␊ - * Collection of backend address pools used by a load balancer␊ - */␊ - backendAddressPools?: (BackendAddressPool12[] | string)␊ - /**␊ - * Object collection representing the load balancing rules Gets the provisioning ␊ - */␊ - loadBalancingRules?: (LoadBalancingRule12[] | string)␊ - /**␊ - * Collection of probe objects used in the load balancer␊ - */␊ - probes?: (Probe12[] | string)␊ - /**␊ - * Collection of inbound NAT Rules used by a load balancer. Defining inbound NAT rules on your load balancer is mutually exclusive with defining an inbound NAT pool. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an Inbound NAT pool. They have to reference individual inbound NAT rules.␊ - */␊ - inboundNatRules?: (InboundNatRule13[] | string)␊ - /**␊ - * Defines an external port range for inbound NAT to a single backend port on NICs associated with a load balancer. Inbound NAT rules are created automatically for each NIC associated with the Load Balancer using an external port from this range. Defining an Inbound NAT pool on your Load Balancer is mutually exclusive with defining inbound Nat rules. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an inbound NAT pool. They have to reference individual inbound NAT rules.␊ - */␊ - inboundNatPools?: (InboundNatPool13[] | string)␊ - /**␊ - * The outbound rules.␊ - */␊ - outboundRules?: (OutboundRule[] | string)␊ - /**␊ - * The resource GUID property of the load balancer resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP address of the load balancer.␊ - */␊ - export interface FrontendIPConfiguration11 {␊ - /**␊ - * Properties of the load balancer probe.␊ - */␊ - properties?: (FrontendIPConfigurationPropertiesFormat11 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP Configuration of the load balancer.␊ - */␊ - export interface FrontendIPConfigurationPropertiesFormat11 {␊ - /**␊ - * The private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The Private IP allocation method. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * The reference of the subnet resource.␊ - */␊ - subnet?: (SubResource18 | string)␊ - /**␊ - * The reference of the Public IP resource.␊ - */␊ - publicIPAddress?: (SubResource18 | string)␊ - /**␊ - * The reference of the Public IP Prefix resource.␊ - */␊ - publicIPPrefix?: (SubResource18 | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Pool of backend IP addresses.␊ - */␊ - export interface BackendAddressPool12 {␊ - /**␊ - * Properties of load balancer backend address pool.␊ - */␊ - properties?: (BackendAddressPoolPropertiesFormat12 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the backend address pool.␊ - */␊ - export interface BackendAddressPoolPropertiesFormat12 {␊ - /**␊ - * Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A load balancing rule for a load balancer.␊ - */␊ - export interface LoadBalancingRule12 {␊ - /**␊ - * Properties of load balancer load balancing rule.␊ - */␊ - properties?: (LoadBalancingRulePropertiesFormat12 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer.␊ - */␊ - export interface LoadBalancingRulePropertiesFormat12 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource18 | string)␊ - /**␊ - * A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs.␊ - */␊ - backendAddressPool?: (SubResource18 | string)␊ - /**␊ - * The reference of the load balancer probe used by the load balancing rule.␊ - */␊ - probe?: (SubResource18 | string)␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'.␊ - */␊ - loadDistribution?: (("Default" | "SourceIP" | "SourceIPProtocol") | string)␊ - /**␊ - * The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 0 and 65534. Note that value 0 enables "Any Port"␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port"␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - /**␊ - * Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule.␊ - */␊ - disableOutboundSnat?: (boolean | string)␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A load balancer probe.␊ - */␊ - export interface Probe12 {␊ - /**␊ - * Properties of load balancer probe.␊ - */␊ - properties?: (ProbePropertiesFormat12 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Load balancer probe resource.␊ - */␊ - export interface ProbePropertiesFormat12 {␊ - /**␊ - * The protocol of the end point. Possible values are: 'Http', 'Tcp', or 'Https'. If 'Tcp' is specified, a received ACK is required for the probe to be successful. If 'Http' or 'Https' is specified, a 200 OK response from the specifies URI is required for the probe to be successful.␊ - */␊ - protocol: (("Http" | "Tcp" | "Https") | string)␊ - /**␊ - * The port for communicating the probe. Possible values range from 1 to 65535, inclusive.␊ - */␊ - port: (number | string)␊ - /**␊ - * The interval, in seconds, for how frequently to probe the endpoint for health status. Typically, the interval is slightly less than half the allocated timeout period (in seconds) which allows two full probes before taking the instance out of rotation. The default value is 15, the minimum value is 5.␊ - */␊ - intervalInSeconds?: (number | string)␊ - /**␊ - * The number of probes where if no response, will result in stopping further traffic from being delivered to the endpoint. This values allows endpoints to be taken out of rotation faster or slower than the typical times used in Azure.␊ - */␊ - numberOfProbes: (number | string)␊ - /**␊ - * The URI used for requesting health status from the VM. Path is required if a protocol is set to http. Otherwise, it is not allowed. There is no default value.␊ - */␊ - requestPath?: string␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT rule of the load balancer.␊ - */␊ - export interface InboundNatRule13 {␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties?: (InboundNatRulePropertiesFormat12 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the inbound NAT rule.␊ - */␊ - export interface InboundNatRulePropertiesFormat12 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource18 | string)␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values range from 1 to 65534.␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * The port used for the internal endpoint. Acceptable values range from 1 to 65535.␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT pool of the load balancer.␊ - */␊ - export interface InboundNatPool13 {␊ - /**␊ - * Properties of load balancer inbound nat pool.␊ - */␊ - properties?: (InboundNatPoolPropertiesFormat12 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Inbound NAT pool.␊ - */␊ - export interface InboundNatPoolPropertiesFormat12 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource18 | string)␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65534.␊ - */␊ - frontendPortRangeStart: (number | string)␊ - /**␊ - * The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65535.␊ - */␊ - frontendPortRangeEnd: (number | string)␊ - /**␊ - * The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound pool of the load balancer.␊ - */␊ - export interface OutboundRule {␊ - /**␊ - * Properties of load balancer outbound rule.␊ - */␊ - properties?: (OutboundRulePropertiesFormat | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound pool of the load balancer.␊ - */␊ - export interface OutboundRulePropertiesFormat {␊ - /**␊ - * The number of outbound ports to be used for NAT.␊ - */␊ - allocatedOutboundPorts?: (number | string)␊ - /**␊ - * The Frontend IP addresses of the load balancer.␊ - */␊ - frontendIPConfigurations: (SubResource18[] | string)␊ - /**␊ - * A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs.␊ - */␊ - backendAddressPool: (SubResource18 | string)␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - /**␊ - * Protocol - TCP, UDP or All.␊ - */␊ - protocol: (("Tcp" | "Udp" | "All") | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - /**␊ - * The timeout for the TCP idle connection␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers/inboundNatRules␊ - */␊ - export interface LoadBalancersInboundNatRulesChildResource8 {␊ - name: string␊ - type: "inboundNatRules"␊ - apiVersion: "2018-07-01"␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties: (InboundNatRulePropertiesFormat12 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers/inboundNatRules␊ - */␊ - export interface LoadBalancersInboundNatRules8 {␊ - name: string␊ - type: "Microsoft.Network/loadBalancers/inboundNatRules"␊ - apiVersion: "2018-07-01"␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties: (InboundNatRulePropertiesFormat12 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/localNetworkGateways␊ - */␊ - export interface LocalNetworkGateways11 {␊ - name: string␊ - type: "Microsoft.Network/localNetworkGateways"␊ - apiVersion: "2018-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the local network gateway.␊ - */␊ - properties: (LocalNetworkGatewayPropertiesFormat11 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces␊ - */␊ - export interface NetworkInterfaces21 {␊ - name: string␊ - type: "Microsoft.Network/networkInterfaces"␊ - apiVersion: "2018-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network interface.␊ - */␊ - properties: (NetworkInterfacePropertiesFormat12 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NetworkInterface properties. ␊ - */␊ - export interface NetworkInterfacePropertiesFormat12 {␊ - /**␊ - * The reference of a virtual machine.␊ - */␊ - virtualMachine?: (SubResource18 | string)␊ - /**␊ - * The reference of the NetworkSecurityGroup resource.␊ - */␊ - networkSecurityGroup?: (SubResource18 | string)␊ - /**␊ - * A list of IPConfigurations of the network interface.␊ - */␊ - ipConfigurations: (NetworkInterfaceIPConfiguration11[] | string)␊ - /**␊ - * The DNS settings in network interface.␊ - */␊ - dnsSettings?: (NetworkInterfaceDnsSettings20 | string)␊ - /**␊ - * The MAC address of the network interface.␊ - */␊ - macAddress?: string␊ - /**␊ - * Gets whether this is a primary network interface on a virtual machine.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * If the network interface is accelerated networking enabled.␊ - */␊ - enableAcceleratedNetworking?: (boolean | string)␊ - /**␊ - * Indicates whether IP forwarding is enabled on this network interface.␊ - */␊ - enableIPForwarding?: (boolean | string)␊ - /**␊ - * The resource GUID property of the network interface resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IPConfiguration in a network interface.␊ - */␊ - export interface NetworkInterfaceIPConfiguration11 {␊ - /**␊ - * Network interface IP configuration properties.␊ - */␊ - properties?: (NetworkInterfaceIPConfigurationPropertiesFormat11 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration.␊ - */␊ - export interface NetworkInterfaceIPConfigurationPropertiesFormat11 {␊ - /**␊ - * The reference of ApplicationGatewayBackendAddressPool resource.␊ - */␊ - applicationGatewayBackendAddressPools?: (SubResource18[] | string)␊ - /**␊ - * The reference of LoadBalancerBackendAddressPool resource.␊ - */␊ - loadBalancerBackendAddressPools?: (SubResource18[] | string)␊ - /**␊ - * A list of references of LoadBalancerInboundNatRules.␊ - */␊ - loadBalancerInboundNatRules?: (SubResource18[] | string)␊ - /**␊ - * Private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * Defines how a private IP address is assigned. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Available from Api-Version 2016-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.␊ - */␊ - privateIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * Subnet bound to the IP configuration.␊ - */␊ - subnet?: (SubResource18 | string)␊ - /**␊ - * Gets whether this is a primary customer address on the network interface.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * Public IP address bound to the IP configuration.␊ - */␊ - publicIPAddress?: (SubResource18 | string)␊ - /**␊ - * Application security groups in which the IP configuration is included.␊ - */␊ - applicationSecurityGroups?: (SubResource18[] | string)␊ - /**␊ - * The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DNS settings of a network interface.␊ - */␊ - export interface NetworkInterfaceDnsSettings20 {␊ - /**␊ - * List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only value in dnsServers collection.␊ - */␊ - dnsServers?: (string[] | string)␊ - /**␊ - * If the VM that uses this NIC is part of an Availability Set, then this list will have the union of all DNS servers from all NICs that are part of the Availability Set. This property is what is configured on each of those VMs.␊ - */␊ - appliedDnsServers?: (string[] | string)␊ - /**␊ - * Relative DNS name for this NIC used for internal communications between VMs in the same virtual network.␊ - */␊ - internalDnsNameLabel?: string␊ - /**␊ - * Fully qualified DNS name supporting internal communications between VMs in the same virtual network.␊ - */␊ - internalFqdn?: string␊ - /**␊ - * Even if internalDnsNameLabel is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internalDomainNameSuffix.␊ - */␊ - internalDomainNameSuffix?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups␊ - */␊ - export interface NetworkSecurityGroups20 {␊ - name: string␊ - type: "Microsoft.Network/networkSecurityGroups"␊ - apiVersion: "2018-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network security group␊ - */␊ - properties: (NetworkSecurityGroupPropertiesFormat12 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: NetworkSecurityGroupsSecurityRulesChildResource12[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network Security Group resource.␊ - */␊ - export interface NetworkSecurityGroupPropertiesFormat12 {␊ - /**␊ - * A collection of security rules of the network security group.␊ - */␊ - securityRules?: (SecurityRule12[] | string)␊ - /**␊ - * The default security rules of network security group.␊ - */␊ - defaultSecurityRules?: (SecurityRule12[] | string)␊ - /**␊ - * The resource GUID property of the network security group resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network security rule.␊ - */␊ - export interface SecurityRule12 {␊ - /**␊ - * Properties of the security rule␊ - */␊ - properties?: (SecurityRulePropertiesFormat12 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Security rule resource.␊ - */␊ - export interface SecurityRulePropertiesFormat12 {␊ - /**␊ - * A description for this rule. Restricted to 140 chars.␊ - */␊ - description?: string␊ - /**␊ - * Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'.␊ - */␊ - protocol: (("Tcp" | "Udp" | "*") | string)␊ - /**␊ - * The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.␊ - */␊ - sourcePortRange?: string␊ - /**␊ - * The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.␊ - */␊ - destinationPortRange?: string␊ - /**␊ - * The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. ␊ - */␊ - sourceAddressPrefix?: string␊ - /**␊ - * The CIDR or source IP ranges.␊ - */␊ - sourceAddressPrefixes?: (string[] | string)␊ - /**␊ - * The application security group specified as source.␊ - */␊ - sourceApplicationSecurityGroups?: (SubResource18[] | string)␊ - /**␊ - * The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used.␊ - */␊ - destinationAddressPrefix?: string␊ - /**␊ - * The destination address prefixes. CIDR or destination IP ranges.␊ - */␊ - destinationAddressPrefixes?: (string[] | string)␊ - /**␊ - * The application security group specified as destination.␊ - */␊ - destinationApplicationSecurityGroups?: (SubResource18[] | string)␊ - /**␊ - * The source port ranges.␊ - */␊ - sourcePortRanges?: (string[] | string)␊ - /**␊ - * The destination port ranges.␊ - */␊ - destinationPortRanges?: (string[] | string)␊ - /**␊ - * The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'.␊ - */␊ - access: (("Allow" | "Deny") | string)␊ - /**␊ - * The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.␊ - */␊ - priority: (number | string)␊ - /**␊ - * The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. Possible values are: 'Inbound' and 'Outbound'.␊ - */␊ - direction: (("Inbound" | "Outbound") | string)␊ - /**␊ - * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRulesChildResource12 {␊ - name: string␊ - type: "securityRules"␊ - apiVersion: "2018-07-01"␊ - /**␊ - * Properties of the security rule␊ - */␊ - properties: (SecurityRulePropertiesFormat12 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRules12 {␊ - name: string␊ - type: "Microsoft.Network/networkSecurityGroups/securityRules"␊ - apiVersion: "2018-07-01"␊ - /**␊ - * Properties of the security rule␊ - */␊ - properties: (SecurityRulePropertiesFormat12 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers␊ - */␊ - export interface NetworkWatchers2 {␊ - name: string␊ - type: "Microsoft.Network/networkWatchers"␊ - apiVersion: "2018-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - properties: ({␊ - [k: string]: unknown␊ - } | string)␊ - resources?: (NetworkWatchersConnectionMonitorsChildResource2 | NetworkWatchersPacketCapturesChildResource2)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/connectionMonitors␊ - */␊ - export interface NetworkWatchersConnectionMonitorsChildResource2 {␊ - name: string␊ - type: "connectionMonitors"␊ - apiVersion: "2018-07-01"␊ - /**␊ - * Connection monitor location.␊ - */␊ - location?: string␊ - /**␊ - * Connection monitor tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (ConnectionMonitorParameters2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters that define the operation to create a connection monitor.␊ - */␊ - export interface ConnectionMonitorParameters2 {␊ - source: (ConnectionMonitorSource2 | string)␊ - destination: (ConnectionMonitorDestination2 | string)␊ - /**␊ - * Determines if the connection monitor will start automatically once created.␊ - */␊ - autoStart?: (boolean | string)␊ - /**␊ - * Monitoring interval in seconds.␊ - */␊ - monitoringIntervalInSeconds?: ((number & string) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the source of connection monitor.␊ - */␊ - export interface ConnectionMonitorSource2 {␊ - /**␊ - * The ID of the resource used as the source by connection monitor.␊ - */␊ - resourceId: string␊ - /**␊ - * The source port used by connection monitor.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the destination of connection monitor.␊ - */␊ - export interface ConnectionMonitorDestination2 {␊ - /**␊ - * The ID of the resource used as the destination by connection monitor.␊ - */␊ - resourceId?: string␊ - /**␊ - * Address of the connection monitor destination (IP or domain name).␊ - */␊ - address?: string␊ - /**␊ - * The destination port used by connection monitor.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/packetCaptures␊ - */␊ - export interface NetworkWatchersPacketCapturesChildResource2 {␊ - name: string␊ - type: "packetCaptures"␊ - apiVersion: "2018-07-01"␊ - properties: (PacketCaptureParameters2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters that define the create packet capture operation.␊ - */␊ - export interface PacketCaptureParameters2 {␊ - /**␊ - * The ID of the targeted resource, only VM is currently supported.␊ - */␊ - target: string␊ - /**␊ - * Number of bytes captured per packet, the remaining bytes are truncated.␊ - */␊ - bytesToCapturePerPacket?: ((number & string) | string)␊ - /**␊ - * Maximum size of the capture output.␊ - */␊ - totalBytesPerSession?: ((number & string) | string)␊ - /**␊ - * Maximum duration of the capture session in seconds.␊ - */␊ - timeLimitInSeconds?: ((number & string) | string)␊ - storageLocation: (PacketCaptureStorageLocation2 | string)␊ - filters?: (PacketCaptureFilter2[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the storage location for a packet capture session.␊ - */␊ - export interface PacketCaptureStorageLocation2 {␊ - /**␊ - * The ID of the storage account to save the packet capture session. Required if no local file path is provided.␊ - */␊ - storageId?: string␊ - /**␊ - * The URI of the storage path to save the packet capture. Must be a well-formed URI describing the location to save the packet capture.␊ - */␊ - storagePath?: string␊ - /**␊ - * A valid local path on the targeting VM. Must include the name of the capture file (*.cap). For linux virtual machine it must start with /var/captures. Required if no storage ID is provided, otherwise optional.␊ - */␊ - filePath?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Filter that is applied to packet capture request. Multiple filters can be applied.␊ - */␊ - export interface PacketCaptureFilter2 {␊ - /**␊ - * Protocol to be filtered on.␊ - */␊ - protocol?: (("TCP" | "UDP" | "Any") | string)␊ - /**␊ - * Local IP Address to be filtered on. Notation: "127.0.0.1" for single address entry. "127.0.0.1-127.0.0.255" for range. "127.0.0.1;127.0.0.5"? for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.␊ - */␊ - localIPAddress?: string␊ - /**␊ - * Local IP Address to be filtered on. Notation: "127.0.0.1" for single address entry. "127.0.0.1-127.0.0.255" for range. "127.0.0.1;127.0.0.5;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.␊ - */␊ - remoteIPAddress?: string␊ - /**␊ - * Local port to be filtered on. Notation: "80" for single port entry."80-85" for range. "80;443;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.␊ - */␊ - localPort?: string␊ - /**␊ - * Remote port to be filtered on. Notation: "80" for single port entry."80-85" for range. "80;443;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.␊ - */␊ - remotePort?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/connectionMonitors␊ - */␊ - export interface NetworkWatchersConnectionMonitors2 {␊ - name: string␊ - type: "Microsoft.Network/networkWatchers/connectionMonitors"␊ - apiVersion: "2018-07-01"␊ - /**␊ - * Connection monitor location.␊ - */␊ - location?: string␊ - /**␊ - * Connection monitor tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (ConnectionMonitorParameters2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/packetCaptures␊ - */␊ - export interface NetworkWatchersPacketCaptures2 {␊ - name: string␊ - type: "Microsoft.Network/networkWatchers/packetCaptures"␊ - apiVersion: "2018-07-01"␊ - properties: (PacketCaptureParameters2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/publicIPAddresses␊ - */␊ - export interface PublicIPAddresses20 {␊ - name: string␊ - type: "Microsoft.Network/publicIPAddresses"␊ - apiVersion: "2018-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The public IP address SKU.␊ - */␊ - sku?: (PublicIPAddressSku8 | string)␊ - /**␊ - * Public IP address properties.␊ - */␊ - properties: (PublicIPAddressPropertiesFormat11 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a public IP address␊ - */␊ - export interface PublicIPAddressSku8 {␊ - /**␊ - * Name of a public IP address SKU.␊ - */␊ - name?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Public IP address properties.␊ - */␊ - export interface PublicIPAddressPropertiesFormat11 {␊ - /**␊ - * The public IP allocation method. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - publicIPAllocationMethod: (("Static" | "Dynamic") | string)␊ - /**␊ - * The public IP address version. Possible values are: 'IPv4' and 'IPv6'.␊ - */␊ - publicIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The FQDN of the DNS record associated with the public IP address.␊ - */␊ - dnsSettings?: (PublicIPAddressDnsSettings19 | string)␊ - /**␊ - * The list of tags associated with the public IP address.␊ - */␊ - ipTags?: (IpTag5[] | string)␊ - /**␊ - * The IP address associated with the public IP address resource.␊ - */␊ - ipAddress?: string␊ - /**␊ - * The Public IP Prefix this Public IP Address should be allocated from.␊ - */␊ - publicIPPrefix?: (SubResource18 | string)␊ - /**␊ - * The idle timeout of the public IP address.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * The resource GUID property of the public IP resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains FQDN of the DNS record associated with the public IP address␊ - */␊ - export interface PublicIPAddressDnsSettings19 {␊ - /**␊ - * Gets or sets the Domain name label.The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.␊ - */␊ - domainNameLabel: string␊ - /**␊ - * Gets the FQDN, Fully qualified domain name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone.␊ - */␊ - fqdn?: string␊ - /**␊ - * Gets or Sets the Reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN. ␊ - */␊ - reverseFqdn?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains the IpTag associated with the object␊ - */␊ - export interface IpTag5 {␊ - /**␊ - * Gets or sets the ipTag type: Example FirstPartyUsage.␊ - */␊ - ipTagType?: string␊ - /**␊ - * Gets or sets value of the IpTag associated with the public IP. Example SQL, Storage etc␊ - */␊ - tag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/publicIPPrefixes␊ - */␊ - export interface PublicIPPrefixes {␊ - name: string␊ - type: "Microsoft.Network/publicIPPrefixes"␊ - apiVersion: "2018-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The public IP prefix SKU.␊ - */␊ - sku?: (PublicIPPrefixSku | string)␊ - /**␊ - * Public IP prefix properties.␊ - */␊ - properties: (PublicIPPrefixPropertiesFormat | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a public IP prefix␊ - */␊ - export interface PublicIPPrefixSku {␊ - /**␊ - * Name of a public IP prefix SKU.␊ - */␊ - name?: ("Standard" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Public IP prefix properties.␊ - */␊ - export interface PublicIPPrefixPropertiesFormat {␊ - /**␊ - * The public IP address version. Possible values are: 'IPv4' and 'IPv6'.␊ - */␊ - publicIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The list of tags associated with the public IP prefix.␊ - */␊ - ipTags?: (IpTag5[] | string)␊ - /**␊ - * The Length of the Public IP Prefix.␊ - */␊ - prefixLength?: (number | string)␊ - /**␊ - * The allocated Prefix␊ - */␊ - ipPrefix?: string␊ - /**␊ - * The list of all referenced PublicIPAddresses␊ - */␊ - publicIPAddresses?: (ReferencedPublicIpAddress[] | string)␊ - /**␊ - * The resource GUID property of the public IP prefix resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the Public IP prefix resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - export interface ReferencedPublicIpAddress {␊ - /**␊ - * The PublicIPAddress Reference␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeFilters␊ - */␊ - export interface RouteFilters2 {␊ - name: string␊ - type: "Microsoft.Network/routeFilters"␊ - apiVersion: "2018-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (RouteFilterPropertiesFormat2 | string)␊ - resources?: RouteFiltersRouteFilterRulesChildResource2[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Filter Resource␊ - */␊ - export interface RouteFilterPropertiesFormat2 {␊ - /**␊ - * Collection of RouteFilterRules contained within a route filter.␊ - */␊ - rules?: (RouteFilterRule2[] | string)␊ - /**␊ - * A collection of references to express route circuit peerings.␊ - */␊ - peerings?: (SubResource18[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Filter Rule Resource␊ - */␊ - export interface RouteFilterRule2 {␊ - properties?: (RouteFilterRulePropertiesFormat2 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Filter Rule Resource␊ - */␊ - export interface RouteFilterRulePropertiesFormat2 {␊ - /**␊ - * The access type of the rule. Valid values are: 'Allow', 'Deny'.␊ - */␊ - access: (("Allow" | "Deny") | string)␊ - /**␊ - * The rule type of the rule. Valid value is: 'Community'␊ - */␊ - routeFilterRuleType: ("Community" | string)␊ - /**␊ - * The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020']␊ - */␊ - communities: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeFilters/routeFilterRules␊ - */␊ - export interface RouteFiltersRouteFilterRulesChildResource2 {␊ - name: string␊ - type: "routeFilterRules"␊ - apiVersion: "2018-07-01"␊ - properties: (RouteFilterRulePropertiesFormat2 | string)␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeFilters/routeFilterRules␊ - */␊ - export interface RouteFiltersRouteFilterRules2 {␊ - name: string␊ - type: "Microsoft.Network/routeFilters/routeFilterRules"␊ - apiVersion: "2018-07-01"␊ - properties: (RouteFilterRulePropertiesFormat2 | string)␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables␊ - */␊ - export interface RouteTables20 {␊ - name: string␊ - type: "Microsoft.Network/routeTables"␊ - apiVersion: "2018-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the route table.␊ - */␊ - properties: (RouteTablePropertiesFormat12 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: RouteTablesRoutesChildResource12[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Table resource␊ - */␊ - export interface RouteTablePropertiesFormat12 {␊ - /**␊ - * Collection of routes contained within a route table.␊ - */␊ - routes?: (Route12[] | string)␊ - /**␊ - * Gets or sets whether to disable the routes learned by BGP on that route table. True means disable.␊ - */␊ - disableBgpRoutePropagation?: (boolean | string)␊ - /**␊ - * The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource␊ - */␊ - export interface Route12 {␊ - /**␊ - * Properties of the route.␊ - */␊ - properties?: (RoutePropertiesFormat12 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource␊ - */␊ - export interface RoutePropertiesFormat12 {␊ - /**␊ - * The destination CIDR to which the route applies.␊ - */␊ - addressPrefix: string␊ - /**␊ - * The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'.␊ - */␊ - nextHopType: (("VirtualNetworkGateway" | "VnetLocal" | "Internet" | "VirtualAppliance" | "None") | string)␊ - /**␊ - * The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.␊ - */␊ - nextHopIpAddress?: string␊ - /**␊ - * The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutesChildResource12 {␊ - name: string␊ - type: "routes"␊ - apiVersion: "2018-07-01"␊ - /**␊ - * Properties of the route.␊ - */␊ - properties: (RoutePropertiesFormat12 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutes12 {␊ - name: string␊ - type: "Microsoft.Network/routeTables/routes"␊ - apiVersion: "2018-07-01"␊ - /**␊ - * Properties of the route.␊ - */␊ - properties: (RoutePropertiesFormat12 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/serviceEndpointPolicies␊ - */␊ - export interface ServiceEndpointPolicies {␊ - name: string␊ - type: "Microsoft.Network/serviceEndpointPolicies"␊ - apiVersion: "2018-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the service end point policy␊ - */␊ - properties: (ServiceEndpointPolicyPropertiesFormat | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: ServiceEndpointPoliciesServiceEndpointPolicyDefinitionsChildResource[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Service Endpoint Policy resource.␊ - */␊ - export interface ServiceEndpointPolicyPropertiesFormat {␊ - /**␊ - * A collection of service endpoint policy definitions of the service endpoint policy.␊ - */␊ - serviceEndpointPolicyDefinitions?: (ServiceEndpointPolicyDefinition[] | string)␊ - /**␊ - * The resource GUID property of the service endpoint policy resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the service endpoint policy. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Service Endpoint policy definitions.␊ - */␊ - export interface ServiceEndpointPolicyDefinition {␊ - /**␊ - * Properties of the service endpoint policy definition␊ - */␊ - properties?: (ServiceEndpointPolicyDefinitionPropertiesFormat | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Service Endpoint policy definition resource.␊ - */␊ - export interface ServiceEndpointPolicyDefinitionPropertiesFormat {␊ - /**␊ - * A description for this rule. Restricted to 140 chars.␊ - */␊ - description?: string␊ - /**␊ - * service endpoint name.␊ - */␊ - service?: string␊ - /**␊ - * A list of service resources.␊ - */␊ - serviceResources?: (string[] | string)␊ - /**␊ - * The provisioning state of the service end point policy definition. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions␊ - */␊ - export interface ServiceEndpointPoliciesServiceEndpointPolicyDefinitionsChildResource {␊ - name: string␊ - type: "serviceEndpointPolicyDefinitions"␊ - apiVersion: "2018-07-01"␊ - /**␊ - * Properties of the service endpoint policy definition␊ - */␊ - properties: (ServiceEndpointPolicyDefinitionPropertiesFormat | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions␊ - */␊ - export interface ServiceEndpointPoliciesServiceEndpointPolicyDefinitions {␊ - name: string␊ - type: "Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions"␊ - apiVersion: "2018-07-01"␊ - /**␊ - * Properties of the service endpoint policy definition␊ - */␊ - properties: (ServiceEndpointPolicyDefinitionPropertiesFormat | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualHubs␊ - */␊ - export interface VirtualHubs2 {␊ - name: string␊ - type: "Microsoft.Network/virtualHubs"␊ - apiVersion: "2018-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (VirtualHubProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VirtualHub␊ - */␊ - export interface VirtualHubProperties2 {␊ - /**␊ - * The VirtualWAN to which the VirtualHub belongs␊ - */␊ - virtualWan?: (SubResource18 | string)␊ - /**␊ - * list of all vnet connections with this VirtualHub.␊ - */␊ - hubVirtualNetworkConnections?: (HubVirtualNetworkConnection2[] | string)␊ - /**␊ - * Address-prefix for this VirtualHub.␊ - */␊ - addressPrefix?: string␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: (("Succeeded" | "Updating" | "Deleting" | "Failed") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HubVirtualNetworkConnection Resource.␊ - */␊ - export interface HubVirtualNetworkConnection2 {␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties?: (HubVirtualNetworkConnectionProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for HubVirtualNetworkConnection␊ - */␊ - export interface HubVirtualNetworkConnectionProperties2 {␊ - /**␊ - * Reference to the remote virtual network.␊ - */␊ - remoteVirtualNetwork?: (SubResource18 | string)␊ - /**␊ - * VirtualHub to RemoteVnet transit to enabled or not.␊ - */␊ - allowHubToRemoteVnetTransit?: (boolean | string)␊ - /**␊ - * Allow RemoteVnet to use Virtual Hub's gateways.␊ - */␊ - allowRemoteVnetToUseHubVnetGateways?: (boolean | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: (("Succeeded" | "Updating" | "Deleting" | "Failed") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworkGateways␊ - */␊ - export interface VirtualNetworkGateways11 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworkGateways"␊ - apiVersion: "2018-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway.␊ - */␊ - properties: (VirtualNetworkGatewayPropertiesFormat11 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks␊ - */␊ - export interface VirtualNetworks20 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks"␊ - apiVersion: "2018-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network.␊ - */␊ - properties: (VirtualNetworkPropertiesFormat12 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: (VirtualNetworksVirtualNetworkPeeringsChildResource9 | VirtualNetworksSubnetsChildResource12)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the virtual network.␊ - */␊ - export interface VirtualNetworkPropertiesFormat12 {␊ - /**␊ - * The AddressSpace that contains an array of IP address ranges that can be used by subnets.␊ - */␊ - addressSpace: (AddressSpace20 | string)␊ - /**␊ - * The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network.␊ - */␊ - dhcpOptions?: (DhcpOptions20 | string)␊ - /**␊ - * A list of subnets in a Virtual Network.␊ - */␊ - subnets?: (Subnet22[] | string)␊ - /**␊ - * A list of peerings in a Virtual Network.␊ - */␊ - virtualNetworkPeerings?: (VirtualNetworkPeering17[] | string)␊ - /**␊ - * The resourceGuid property of the Virtual Network resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - /**␊ - * Indicates if DDoS protection is enabled for all the protected resources in the virtual network. It requires a DDoS protection plan associated with the resource.␊ - */␊ - enableDdosProtection?: (boolean | string)␊ - /**␊ - * Indicates if VM protection is enabled for all the subnets in the virtual network.␊ - */␊ - enableVmProtection?: (boolean | string)␊ - /**␊ - * The DDoS protection plan associated with the virtual network.␊ - */␊ - ddosProtectionPlan?: (SubResource18 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DhcpOptions contains an array of DNS servers available to VMs deployed in the virtual network. Standard DHCP option for a subnet overrides VNET DHCP options.␊ - */␊ - export interface DhcpOptions20 {␊ - /**␊ - * The list of DNS servers IP addresses.␊ - */␊ - dnsServers: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Subnet in a virtual network resource.␊ - */␊ - export interface Subnet22 {␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties?: (SubnetPropertiesFormat12 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the subnet.␊ - */␊ - export interface SubnetPropertiesFormat12 {␊ - /**␊ - * The address prefix for the subnet.␊ - */␊ - addressPrefix: string␊ - /**␊ - * The reference of the NetworkSecurityGroup resource.␊ - */␊ - networkSecurityGroup?: (SubResource18 | string)␊ - /**␊ - * The reference of the RouteTable resource.␊ - */␊ - routeTable?: (SubResource18 | string)␊ - /**␊ - * An array of service endpoints.␊ - */␊ - serviceEndpoints?: (ServiceEndpointPropertiesFormat8[] | string)␊ - /**␊ - * An array of service endpoint policies.␊ - */␊ - serviceEndpointPolicies?: (SubResource18[] | string)␊ - /**␊ - * Gets an array of references to the external resources using subnet.␊ - */␊ - resourceNavigationLinks?: (ResourceNavigationLink9[] | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The service endpoint properties.␊ - */␊ - export interface ServiceEndpointPropertiesFormat8 {␊ - /**␊ - * The type of the endpoint service.␊ - */␊ - service?: string␊ - /**␊ - * A list of locations.␊ - */␊ - locations?: (string[] | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ResourceNavigationLink resource.␊ - */␊ - export interface ResourceNavigationLink9 {␊ - /**␊ - * Resource navigation link properties format.␊ - */␊ - properties?: (ResourceNavigationLinkFormat9 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ResourceNavigationLink.␊ - */␊ - export interface ResourceNavigationLinkFormat9 {␊ - /**␊ - * Resource type of the linked resource.␊ - */␊ - linkedResourceType?: string␊ - /**␊ - * Link to the external resource␊ - */␊ - link?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peerings in a virtual network resource.␊ - */␊ - export interface VirtualNetworkPeering17 {␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties?: (VirtualNetworkPeeringPropertiesFormat9 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - export interface VirtualNetworkPeeringPropertiesFormat9 {␊ - /**␊ - * Whether the VMs in the linked virtual network space would be able to access all the VMs in local Virtual network space.␊ - */␊ - allowVirtualNetworkAccess?: (boolean | string)␊ - /**␊ - * Whether the forwarded traffic from the VMs in the remote virtual network will be allowed/disallowed.␊ - */␊ - allowForwardedTraffic?: (boolean | string)␊ - /**␊ - * If gateway links can be used in remote virtual networking to link to this virtual network.␊ - */␊ - allowGatewayTransit?: (boolean | string)␊ - /**␊ - * If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway.␊ - */␊ - useRemoteGateways?: (boolean | string)␊ - /**␊ - * The reference of the remote virtual network. The remote virtual network can be in the same or different region (preview). See here to register for the preview and learn more (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering).␊ - */␊ - remoteVirtualNetwork: (SubResource18 | string)␊ - /**␊ - * The reference of the remote virtual network address space.␊ - */␊ - remoteAddressSpace?: (AddressSpace20 | string)␊ - /**␊ - * The status of the virtual network peering. Possible values are 'Initiated', 'Connected', and 'Disconnected'.␊ - */␊ - peeringState?: (("Initiated" | "Connected" | "Disconnected") | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/virtualNetworkPeerings␊ - */␊ - export interface VirtualNetworksVirtualNetworkPeeringsChildResource9 {␊ - name: string␊ - type: "virtualNetworkPeerings"␊ - apiVersion: "2018-07-01"␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties: (VirtualNetworkPeeringPropertiesFormat9 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnetsChildResource12 {␊ - name: string␊ - type: "subnets"␊ - apiVersion: "2018-07-01"␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties: (SubnetPropertiesFormat12 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnets11 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks/subnets"␊ - apiVersion: "2018-07-01"␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties: (SubnetPropertiesFormat12 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/virtualNetworkPeerings␊ - */␊ - export interface VirtualNetworksVirtualNetworkPeerings8 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks/virtualNetworkPeerings"␊ - apiVersion: "2018-07-01"␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties: (VirtualNetworkPeeringPropertiesFormat9 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualWans␊ - */␊ - export interface VirtualWans2 {␊ - name: string␊ - type: "Microsoft.Network/virtualWans"␊ - apiVersion: "2018-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (VirtualWanProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VirtualWAN␊ - */␊ - export interface VirtualWanProperties2 {␊ - /**␊ - * Vpn encryption to be disabled or not.␊ - */␊ - disableVpnEncryption?: (boolean | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: (("Succeeded" | "Updating" | "Deleting" | "Failed") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnGateways␊ - */␊ - export interface VpnGateways2 {␊ - name: string␊ - type: "Microsoft.Network/vpnGateways"␊ - apiVersion: "2018-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (VpnGatewayProperties2 | string)␊ - resources?: VpnGatewaysVpnConnectionsChildResource2[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnGateway␊ - */␊ - export interface VpnGatewayProperties2 {␊ - /**␊ - * The VirtualHub to which the gateway belongs␊ - */␊ - virtualHub?: (SubResource18 | string)␊ - /**␊ - * list of all vpn connections to the gateway.␊ - */␊ - connections?: (VpnConnection2[] | string)␊ - /**␊ - * Local network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings10 | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: (("Succeeded" | "Updating" | "Deleting" | "Failed") | string)␊ - /**␊ - * The policies applied to this vpn gateway.␊ - */␊ - policies?: (Policies2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnConnection Resource.␊ - */␊ - export interface VpnConnection2 {␊ - properties?: (VpnConnectionProperties2 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnConnection␊ - */␊ - export interface VpnConnectionProperties2 {␊ - /**␊ - * Id of the connected vpn site.␊ - */␊ - remoteVpnSite?: (SubResource18 | string)␊ - /**␊ - * routing weight for vpn connection.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * The connection status.␊ - */␊ - connectionStatus?: (("Unknown" | "Connecting" | "Connected" | "NotConnected") | string)␊ - /**␊ - * SharedKey for the vpn connection.␊ - */␊ - sharedKey?: string␊ - /**␊ - * EnableBgp flag␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * The IPSec Policies to be considered by this connection.␊ - */␊ - ipsecPolicies?: (IpsecPolicy8[] | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: (("Succeeded" | "Updating" | "Deleting" | "Failed") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Policies for vpn gateway.␊ - */␊ - export interface Policies2 {␊ - /**␊ - * True if branch to branch traffic is allowed.␊ - */␊ - allowBranchToBranchTraffic?: (boolean | string)␊ - /**␊ - * True if Vnet to Vnet traffic is allowed.␊ - */␊ - allowVnetToVnetTraffic?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnGateways/vpnConnections␊ - */␊ - export interface VpnGatewaysVpnConnectionsChildResource2 {␊ - name: string␊ - type: "vpnConnections"␊ - apiVersion: "2018-07-01"␊ - properties: (VpnConnectionProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnGateways/vpnConnections␊ - */␊ - export interface VpnGatewaysVpnConnections2 {␊ - name: string␊ - type: "Microsoft.Network/vpnGateways/vpnConnections"␊ - apiVersion: "2018-07-01"␊ - properties: (VpnConnectionProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnSites␊ - */␊ - export interface VpnSites2 {␊ - name: string␊ - type: "Microsoft.Network/vpnSites"␊ - apiVersion: "2018-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (VpnSiteProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnSite␊ - */␊ - export interface VpnSiteProperties2 {␊ - /**␊ - * The VirtualWAN to which the vpnSite belongs␊ - */␊ - virtualWAN?: (SubResource18 | string)␊ - /**␊ - * The device properties␊ - */␊ - deviceProperties?: (DeviceProperties2 | string)␊ - /**␊ - * The ip-address for the vpn-site.␊ - */␊ - ipAddress?: string␊ - /**␊ - * The key for vpn-site that can be used for connections.␊ - */␊ - siteKey?: string␊ - /**␊ - * The AddressSpace that contains an array of IP address ranges.␊ - */␊ - addressSpace?: (AddressSpace20 | string)␊ - /**␊ - * The set of bgp properties.␊ - */␊ - bgpProperties?: (BgpSettings10 | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: (("Succeeded" | "Updating" | "Deleting" | "Failed") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * List of properties of the device.␊ - */␊ - export interface DeviceProperties2 {␊ - /**␊ - * Name of the device Vendor.␊ - */␊ - deviceVendor?: string␊ - /**␊ - * Model of the device.␊ - */␊ - deviceModel?: string␊ - /**␊ - * Link speed.␊ - */␊ - linkSpeedInMbps?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/applicationSecurityGroups␊ - */␊ - export interface ApplicationSecurityGroups8 {␊ - name: string␊ - type: "Microsoft.Network/applicationSecurityGroups"␊ - apiVersion: "2018-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the application security group.␊ - */␊ - properties: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ddosProtectionPlans␊ - */␊ - export interface DdosProtectionPlans4 {␊ - name: string␊ - type: "Microsoft.Network/ddosProtectionPlans"␊ - apiVersion: "2018-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the DDoS protection plan.␊ - */␊ - properties: (DdosProtectionPlanPropertiesFormat1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DDoS protection plan properties.␊ - */␊ - export interface DdosProtectionPlanPropertiesFormat1 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits␊ - */␊ - export interface ExpressRouteCircuits6 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits"␊ - apiVersion: "2018-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The SKU.␊ - */␊ - sku?: (ExpressRouteCircuitSku6 | string)␊ - properties: (ExpressRouteCircuitPropertiesFormat6 | string)␊ - resources?: (ExpressRouteCircuitsPeeringsChildResource6 | ExpressRouteCircuitsAuthorizationsChildResource6)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains SKU in an ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitSku6 {␊ - /**␊ - * The name of the SKU.␊ - */␊ - name?: string␊ - /**␊ - * The tier of the SKU. Possible values are 'Standard', 'Premium' or 'Basic'.␊ - */␊ - tier?: (("Standard" | "Premium" | "Basic") | string)␊ - /**␊ - * The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'.␊ - */␊ - family?: (("UnlimitedData" | "MeteredData") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitPropertiesFormat6 {␊ - /**␊ - * Allow classic operations␊ - */␊ - allowClassicOperations?: (boolean | string)␊ - /**␊ - * The CircuitProvisioningState state of the resource.␊ - */␊ - circuitProvisioningState?: string␊ - /**␊ - * The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'.␊ - */␊ - serviceProviderProvisioningState?: (("NotProvisioned" | "Provisioning" | "Provisioned" | "Deprovisioning") | string)␊ - /**␊ - * The list of authorizations.␊ - */␊ - authorizations?: (ExpressRouteCircuitAuthorization6[] | string)␊ - /**␊ - * The list of peerings.␊ - */␊ - peerings?: (ExpressRouteCircuitPeering6[] | string)␊ - /**␊ - * The ServiceKey.␊ - */␊ - serviceKey?: string␊ - /**␊ - * The ServiceProviderNotes.␊ - */␊ - serviceProviderNotes?: string␊ - /**␊ - * The ServiceProviderProperties.␊ - */␊ - serviceProviderProperties?: (ExpressRouteCircuitServiceProviderProperties6 | string)␊ - /**␊ - * The reference to the ExpressRoutePort resource when the circuit is provisioned on an ExpressRoutePort resource.␊ - */␊ - expressRoutePort?: (SubResource19 | string)␊ - /**␊ - * The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource.␊ - */␊ - bandwidthInGbps?: (number | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - /**␊ - * Flag to enable Global Reach on the circuit.␊ - */␊ - allowGlobalReach?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authorization in an ExpressRouteCircuit resource.␊ - */␊ - export interface ExpressRouteCircuitAuthorization6 {␊ - properties?: (AuthorizationPropertiesFormat7 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - export interface AuthorizationPropertiesFormat7 {␊ - /**␊ - * The authorization key.␊ - */␊ - authorizationKey?: string␊ - /**␊ - * AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'.␊ - */␊ - authorizationUseStatus?: (("Available" | "InUse") | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peering in an ExpressRouteCircuit resource.␊ - */␊ - export interface ExpressRouteCircuitPeering6 {␊ - properties?: (ExpressRouteCircuitPeeringPropertiesFormat7 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - export interface ExpressRouteCircuitPeeringPropertiesFormat7 {␊ - /**␊ - * The peering type.␊ - */␊ - peeringType?: (("AzurePublicPeering" | "AzurePrivatePeering" | "MicrosoftPeering") | string)␊ - /**␊ - * The peering state.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * The Azure ASN.␊ - */␊ - azureASN?: (number | string)␊ - /**␊ - * The peer ASN.␊ - */␊ - peerASN?: (number | string)␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The primary port.␊ - */␊ - primaryAzurePort?: string␊ - /**␊ - * The secondary port.␊ - */␊ - secondaryAzurePort?: string␊ - /**␊ - * The shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The VLAN ID.␊ - */␊ - vlanId?: (number | string)␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig7 | string)␊ - /**␊ - * Gets peering stats.␊ - */␊ - stats?: (ExpressRouteCircuitStats7 | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - /**␊ - * Gets whether the provider or the customer last modified the peering.␊ - */␊ - lastModifiedBy?: string␊ - /**␊ - * The reference of the RouteFilter resource.␊ - */␊ - routeFilter?: (SubResource19 | string)␊ - /**␊ - * The IPv6 peering configuration.␊ - */␊ - ipv6PeeringConfig?: (Ipv6ExpressRouteCircuitPeeringConfig4 | string)␊ - /**␊ - * The ExpressRoute connection.␊ - */␊ - expressRouteConnection?: ({␊ - [k: string]: unknown␊ - } | string)␊ - /**␊ - * The list of circuit connections associated with Azure Private Peering for this circuit.␊ - */␊ - connections?: (ExpressRouteCircuitConnection4[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the peering configuration.␊ - */␊ - export interface ExpressRouteCircuitPeeringConfig7 {␊ - /**␊ - * The reference of AdvertisedPublicPrefixes.␊ - */␊ - advertisedPublicPrefixes?: (string[] | string)␊ - /**␊ - * The communities of bgp peering. Spepcified for microsoft peering␊ - */␊ - advertisedCommunities?: (string[] | string)␊ - /**␊ - * AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'.␊ - */␊ - advertisedPublicPrefixesState?: (("NotConfigured" | "Configuring" | "Configured" | "ValidationNeeded") | string)␊ - /**␊ - * The legacy mode of the peering.␊ - */␊ - legacyMode?: (number | string)␊ - /**␊ - * The CustomerASN of the peering.␊ - */␊ - customerASN?: (number | string)␊ - /**␊ - * The RoutingRegistryName of the configuration.␊ - */␊ - routingRegistryName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains stats associated with the peering.␊ - */␊ - export interface ExpressRouteCircuitStats7 {␊ - /**␊ - * Gets BytesIn of the peering.␊ - */␊ - primarybytesIn?: (number | string)␊ - /**␊ - * Gets BytesOut of the peering.␊ - */␊ - primarybytesOut?: (number | string)␊ - /**␊ - * Gets BytesIn of the peering.␊ - */␊ - secondarybytesIn?: (number | string)␊ - /**␊ - * Gets BytesOut of the peering.␊ - */␊ - secondarybytesOut?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Reference to another subresource.␊ - */␊ - export interface SubResource19 {␊ - /**␊ - * Resource ID.␊ - */␊ - id: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains IPv6 peering config.␊ - */␊ - export interface Ipv6ExpressRouteCircuitPeeringConfig4 {␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig7 | string)␊ - /**␊ - * The reference of the RouteFilter resource.␊ - */␊ - routeFilter?: (SubResource19 | string)␊ - /**␊ - * The state of peering. Possible values are: 'Disabled' and 'Enabled'.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Express Route Circuit Connection in an ExpressRouteCircuitPeering resource.␊ - */␊ - export interface ExpressRouteCircuitConnection4 {␊ - properties?: (ExpressRouteCircuitConnectionPropertiesFormat4 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - export interface ExpressRouteCircuitConnectionPropertiesFormat4 {␊ - /**␊ - * Reference to Express Route Circuit Private Peering Resource of the circuit initiating connection.␊ - */␊ - expressRouteCircuitPeering?: (SubResource19 | string)␊ - /**␊ - * Reference to Express Route Circuit Private Peering Resource of the peered circuit.␊ - */␊ - peerExpressRouteCircuitPeering?: (SubResource19 | string)␊ - /**␊ - * /29 IP address space to carve out Customer addresses for tunnels.␊ - */␊ - addressPrefix?: string␊ - /**␊ - * The authorization key.␊ - */␊ - authorizationKey?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains ServiceProviderProperties in an ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitServiceProviderProperties6 {␊ - /**␊ - * The serviceProviderName.␊ - */␊ - serviceProviderName?: string␊ - /**␊ - * The peering location.␊ - */␊ - peeringLocation?: string␊ - /**␊ - * The BandwidthInMbps.␊ - */␊ - bandwidthInMbps?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings␊ - */␊ - export interface ExpressRouteCircuitsPeeringsChildResource6 {␊ - name: string␊ - type: "peerings"␊ - apiVersion: "2018-08-01"␊ - properties: (ExpressRouteCircuitPeeringPropertiesFormat7 | string)␊ - resources?: ExpressRouteCircuitsPeeringsConnectionsChildResource4[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings/connections␊ - */␊ - export interface ExpressRouteCircuitsPeeringsConnectionsChildResource4 {␊ - name: string␊ - type: "connections"␊ - apiVersion: "2018-08-01"␊ - properties: (ExpressRouteCircuitConnectionPropertiesFormat4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/authorizations␊ - */␊ - export interface ExpressRouteCircuitsAuthorizationsChildResource6 {␊ - name: string␊ - type: "authorizations"␊ - apiVersion: "2018-08-01"␊ - properties: (AuthorizationPropertiesFormat7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections␊ - */␊ - export interface ExpressRouteCrossConnections4 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCrossConnections"␊ - apiVersion: "2018-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (ExpressRouteCrossConnectionProperties4 | string)␊ - resources?: ExpressRouteCrossConnectionsPeeringsChildResource4[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ExpressRouteCrossConnection.␊ - */␊ - export interface ExpressRouteCrossConnectionProperties4 {␊ - /**␊ - * The peering location of the ExpressRoute circuit.␊ - */␊ - peeringLocation?: string␊ - /**␊ - * The circuit bandwidth In Mbps.␊ - */␊ - bandwidthInMbps?: (number | string)␊ - /**␊ - * The ExpressRouteCircuit␊ - */␊ - expressRouteCircuit?: (ExpressRouteCircuitReference3 | string)␊ - /**␊ - * The provisioning state of the circuit in the connectivity provider system. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned'.␊ - */␊ - serviceProviderProvisioningState?: (("NotProvisioned" | "Provisioning" | "Provisioned" | "Deprovisioning") | string)␊ - /**␊ - * Additional read only notes set by the connectivity provider.␊ - */␊ - serviceProviderNotes?: string␊ - /**␊ - * The list of peerings.␊ - */␊ - peerings?: (ExpressRouteCrossConnectionPeering4[] | string)␊ - [k: string]: unknown␊ - }␊ - export interface ExpressRouteCircuitReference3 {␊ - /**␊ - * Corresponding Express Route Circuit Id.␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peering in an ExpressRoute Cross Connection resource.␊ - */␊ - export interface ExpressRouteCrossConnectionPeering4 {␊ - properties?: (ExpressRouteCrossConnectionPeeringProperties4 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - export interface ExpressRouteCrossConnectionPeeringProperties4 {␊ - /**␊ - * The peering type.␊ - */␊ - peeringType?: (("AzurePublicPeering" | "AzurePrivatePeering" | "MicrosoftPeering") | string)␊ - /**␊ - * The peering state.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * The peer ASN.␊ - */␊ - peerASN?: (number | string)␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The VLAN ID.␊ - */␊ - vlanId?: (number | string)␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig7 | string)␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - /**␊ - * Gets whether the provider or the customer last modified the peering.␊ - */␊ - lastModifiedBy?: string␊ - /**␊ - * The IPv6 peering configuration.␊ - */␊ - ipv6PeeringConfig?: (Ipv6ExpressRouteCircuitPeeringConfig4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections/peerings␊ - */␊ - export interface ExpressRouteCrossConnectionsPeeringsChildResource4 {␊ - name: string␊ - type: "peerings"␊ - apiVersion: "2018-08-01"␊ - properties: (ExpressRouteCrossConnectionPeeringProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/publicIPAddresses␊ - */␊ - export interface PublicIPAddresses21 {␊ - name: string␊ - type: "Microsoft.Network/publicIPAddresses"␊ - apiVersion: "2018-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The public IP address SKU.␊ - */␊ - sku?: (PublicIPAddressSku9 | string)␊ - /**␊ - * Public IP address properties.␊ - */␊ - properties: (PublicIPAddressPropertiesFormat12 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a public IP address␊ - */␊ - export interface PublicIPAddressSku9 {␊ - /**␊ - * Name of a public IP address SKU.␊ - */␊ - name?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Public IP address properties.␊ - */␊ - export interface PublicIPAddressPropertiesFormat12 {␊ - /**␊ - * The public IP allocation method. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - publicIPAllocationMethod: (("Static" | "Dynamic") | string)␊ - /**␊ - * The public IP address version. Possible values are: 'IPv4' and 'IPv6'.␊ - */␊ - publicIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The FQDN of the DNS record associated with the public IP address.␊ - */␊ - dnsSettings?: (PublicIPAddressDnsSettings20 | string)␊ - /**␊ - * The list of tags associated with the public IP address.␊ - */␊ - ipTags?: (IpTag6[] | string)␊ - /**␊ - * The IP address associated with the public IP address resource.␊ - */␊ - ipAddress?: string␊ - /**␊ - * The Public IP Prefix this Public IP Address should be allocated from.␊ - */␊ - publicIPPrefix?: (SubResource19 | string)␊ - /**␊ - * The idle timeout of the public IP address.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * The resource GUID property of the public IP resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains FQDN of the DNS record associated with the public IP address␊ - */␊ - export interface PublicIPAddressDnsSettings20 {␊ - /**␊ - * Gets or sets the Domain name label.The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.␊ - */␊ - domainNameLabel: string␊ - /**␊ - * Gets the FQDN, Fully qualified domain name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone.␊ - */␊ - fqdn?: string␊ - /**␊ - * Gets or Sets the Reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN. ␊ - */␊ - reverseFqdn?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains the IpTag associated with the object␊ - */␊ - export interface IpTag6 {␊ - /**␊ - * Gets or sets the ipTag type: Example FirstPartyUsage.␊ - */␊ - ipTagType?: string␊ - /**␊ - * Gets or sets value of the IpTag associated with the public IP. Example SQL, Storage etc␊ - */␊ - tag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks␊ - */␊ - export interface VirtualNetworks21 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks"␊ - apiVersion: "2018-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network.␊ - */␊ - properties: (VirtualNetworkPropertiesFormat13 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: (VirtualNetworksVirtualNetworkPeeringsChildResource10 | VirtualNetworksSubnetsChildResource13)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the virtual network.␊ - */␊ - export interface VirtualNetworkPropertiesFormat13 {␊ - /**␊ - * The AddressSpace that contains an array of IP address ranges that can be used by subnets.␊ - */␊ - addressSpace: (AddressSpace21 | string)␊ - /**␊ - * The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network.␊ - */␊ - dhcpOptions?: (DhcpOptions21 | string)␊ - /**␊ - * A list of subnets in a Virtual Network.␊ - */␊ - subnets?: (Subnet23[] | string)␊ - /**␊ - * A list of peerings in a Virtual Network.␊ - */␊ - virtualNetworkPeerings?: (VirtualNetworkPeering18[] | string)␊ - /**␊ - * The resourceGuid property of the Virtual Network resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - /**␊ - * Indicates if DDoS protection is enabled for all the protected resources in the virtual network. It requires a DDoS protection plan associated with the resource.␊ - */␊ - enableDdosProtection?: (boolean | string)␊ - /**␊ - * Indicates if VM protection is enabled for all the subnets in the virtual network.␊ - */␊ - enableVmProtection?: (boolean | string)␊ - /**␊ - * The DDoS protection plan associated with the virtual network.␊ - */␊ - ddosProtectionPlan?: (SubResource19 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.␊ - */␊ - export interface AddressSpace21 {␊ - /**␊ - * A list of address blocks reserved for this virtual network in CIDR notation.␊ - */␊ - addressPrefixes: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DhcpOptions contains an array of DNS servers available to VMs deployed in the virtual network. Standard DHCP option for a subnet overrides VNET DHCP options.␊ - */␊ - export interface DhcpOptions21 {␊ - /**␊ - * The list of DNS servers IP addresses.␊ - */␊ - dnsServers: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Subnet in a virtual network resource.␊ - */␊ - export interface Subnet23 {␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties?: (SubnetPropertiesFormat13 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the subnet.␊ - */␊ - export interface SubnetPropertiesFormat13 {␊ - /**␊ - * The address prefix for the subnet.␊ - */␊ - addressPrefix: string␊ - /**␊ - * List of address prefixes for the subnet.␊ - */␊ - addressPrefixes?: (string[] | string)␊ - /**␊ - * The reference of the NetworkSecurityGroup resource.␊ - */␊ - networkSecurityGroup?: (SubResource19 | string)␊ - /**␊ - * The reference of the RouteTable resource.␊ - */␊ - routeTable?: (SubResource19 | string)␊ - /**␊ - * An array of service endpoints.␊ - */␊ - serviceEndpoints?: (ServiceEndpointPropertiesFormat9[] | string)␊ - /**␊ - * An array of service endpoint policies.␊ - */␊ - serviceEndpointPolicies?: (SubResource19[] | string)␊ - /**␊ - * Gets an array of references to the external resources using subnet.␊ - */␊ - resourceNavigationLinks?: (ResourceNavigationLink10[] | string)␊ - /**␊ - * Gets an array of references to services injecting into this subnet.␊ - */␊ - serviceAssociationLinks?: (ServiceAssociationLink[] | string)␊ - /**␊ - * Gets an array of references to the delegations on the subnet.␊ - */␊ - delegations?: (Delegation[] | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The service endpoint properties.␊ - */␊ - export interface ServiceEndpointPropertiesFormat9 {␊ - /**␊ - * The type of the endpoint service.␊ - */␊ - service?: string␊ - /**␊ - * A list of locations.␊ - */␊ - locations?: (string[] | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ResourceNavigationLink resource.␊ - */␊ - export interface ResourceNavigationLink10 {␊ - /**␊ - * Resource navigation link properties format.␊ - */␊ - properties?: (ResourceNavigationLinkFormat10 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ResourceNavigationLink.␊ - */␊ - export interface ResourceNavigationLinkFormat10 {␊ - /**␊ - * Resource type of the linked resource.␊ - */␊ - linkedResourceType?: string␊ - /**␊ - * Link to the external resource␊ - */␊ - link?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ServiceAssociationLink resource.␊ - */␊ - export interface ServiceAssociationLink {␊ - /**␊ - * Resource navigation link properties format.␊ - */␊ - properties?: (ServiceAssociationLinkPropertiesFormat | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ServiceAssociationLink.␊ - */␊ - export interface ServiceAssociationLinkPropertiesFormat {␊ - /**␊ - * Resource type of the linked resource.␊ - */␊ - linkedResourceType?: string␊ - /**␊ - * Link to the external resource.␊ - */␊ - link?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Details the service to which the subnet is delegated.␊ - */␊ - export interface Delegation {␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties?: (ServiceDelegationPropertiesFormat | string)␊ - /**␊ - * The name of the resource that is unique within a subnet. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a service delegation.␊ - */␊ - export interface ServiceDelegationPropertiesFormat {␊ - /**␊ - * The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers)␊ - */␊ - serviceName?: string␊ - /**␊ - * Describes the actions permitted to the service upon delegation␊ - */␊ - actions?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peerings in a virtual network resource.␊ - */␊ - export interface VirtualNetworkPeering18 {␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties?: (VirtualNetworkPeeringPropertiesFormat10 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - export interface VirtualNetworkPeeringPropertiesFormat10 {␊ - /**␊ - * Whether the VMs in the linked virtual network space would be able to access all the VMs in local Virtual network space.␊ - */␊ - allowVirtualNetworkAccess?: (boolean | string)␊ - /**␊ - * Whether the forwarded traffic from the VMs in the remote virtual network will be allowed/disallowed.␊ - */␊ - allowForwardedTraffic?: (boolean | string)␊ - /**␊ - * If gateway links can be used in remote virtual networking to link to this virtual network.␊ - */␊ - allowGatewayTransit?: (boolean | string)␊ - /**␊ - * If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway.␊ - */␊ - useRemoteGateways?: (boolean | string)␊ - /**␊ - * The reference of the remote virtual network. The remote virtual network can be in the same or different region (preview). See here to register for the preview and learn more (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering).␊ - */␊ - remoteVirtualNetwork: (SubResource19 | string)␊ - /**␊ - * The reference of the remote virtual network address space.␊ - */␊ - remoteAddressSpace?: (AddressSpace21 | string)␊ - /**␊ - * The status of the virtual network peering. Possible values are 'Initiated', 'Connected', and 'Disconnected'.␊ - */␊ - peeringState?: (("Initiated" | "Connected" | "Disconnected") | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/virtualNetworkPeerings␊ - */␊ - export interface VirtualNetworksVirtualNetworkPeeringsChildResource10 {␊ - name: string␊ - type: "virtualNetworkPeerings"␊ - apiVersion: "2018-08-01"␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties: (VirtualNetworkPeeringPropertiesFormat10 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnetsChildResource13 {␊ - name: string␊ - type: "subnets"␊ - apiVersion: "2018-08-01"␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties: (SubnetPropertiesFormat13 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers␊ - */␊ - export interface LoadBalancers21 {␊ - name: string␊ - type: "Microsoft.Network/loadBalancers"␊ - apiVersion: "2018-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The load balancer SKU.␊ - */␊ - sku?: (LoadBalancerSku9 | string)␊ - /**␊ - * Properties of load balancer.␊ - */␊ - properties: (LoadBalancerPropertiesFormat13 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: LoadBalancersInboundNatRulesChildResource9[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a load balancer␊ - */␊ - export interface LoadBalancerSku9 {␊ - /**␊ - * Name of a load balancer SKU.␊ - */␊ - name?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer.␊ - */␊ - export interface LoadBalancerPropertiesFormat13 {␊ - /**␊ - * Object representing the frontend IPs to be used for the load balancer␊ - */␊ - frontendIPConfigurations?: (FrontendIPConfiguration12[] | string)␊ - /**␊ - * Collection of backend address pools used by a load balancer␊ - */␊ - backendAddressPools?: (BackendAddressPool13[] | string)␊ - /**␊ - * Object collection representing the load balancing rules Gets the provisioning ␊ - */␊ - loadBalancingRules?: (LoadBalancingRule13[] | string)␊ - /**␊ - * Collection of probe objects used in the load balancer␊ - */␊ - probes?: (Probe13[] | string)␊ - /**␊ - * Collection of inbound NAT Rules used by a load balancer. Defining inbound NAT rules on your load balancer is mutually exclusive with defining an inbound NAT pool. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an Inbound NAT pool. They have to reference individual inbound NAT rules.␊ - */␊ - inboundNatRules?: (InboundNatRule14[] | string)␊ - /**␊ - * Defines an external port range for inbound NAT to a single backend port on NICs associated with a load balancer. Inbound NAT rules are created automatically for each NIC associated with the Load Balancer using an external port from this range. Defining an Inbound NAT pool on your Load Balancer is mutually exclusive with defining inbound Nat rules. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an inbound NAT pool. They have to reference individual inbound NAT rules.␊ - */␊ - inboundNatPools?: (InboundNatPool14[] | string)␊ - /**␊ - * The outbound rules.␊ - */␊ - outboundRules?: (OutboundRule1[] | string)␊ - /**␊ - * The resource GUID property of the load balancer resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP address of the load balancer.␊ - */␊ - export interface FrontendIPConfiguration12 {␊ - /**␊ - * Properties of the load balancer probe.␊ - */␊ - properties?: (FrontendIPConfigurationPropertiesFormat12 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP Configuration of the load balancer.␊ - */␊ - export interface FrontendIPConfigurationPropertiesFormat12 {␊ - /**␊ - * The private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The Private IP allocation method. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * The reference of the subnet resource.␊ - */␊ - subnet?: (SubResource19 | string)␊ - /**␊ - * The reference of the Public IP resource.␊ - */␊ - publicIPAddress?: (SubResource19 | string)␊ - /**␊ - * The reference of the Public IP Prefix resource.␊ - */␊ - publicIPPrefix?: (SubResource19 | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Pool of backend IP addresses.␊ - */␊ - export interface BackendAddressPool13 {␊ - /**␊ - * Properties of load balancer backend address pool.␊ - */␊ - properties?: (BackendAddressPoolPropertiesFormat13 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the backend address pool.␊ - */␊ - export interface BackendAddressPoolPropertiesFormat13 {␊ - /**␊ - * Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A load balancing rule for a load balancer.␊ - */␊ - export interface LoadBalancingRule13 {␊ - /**␊ - * Properties of load balancer load balancing rule.␊ - */␊ - properties?: (LoadBalancingRulePropertiesFormat13 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer.␊ - */␊ - export interface LoadBalancingRulePropertiesFormat13 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource19 | string)␊ - /**␊ - * A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs.␊ - */␊ - backendAddressPool?: (SubResource19 | string)␊ - /**␊ - * The reference of the load balancer probe used by the load balancing rule.␊ - */␊ - probe?: (SubResource19 | string)␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'.␊ - */␊ - loadDistribution?: (("Default" | "SourceIP" | "SourceIPProtocol") | string)␊ - /**␊ - * The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 0 and 65534. Note that value 0 enables "Any Port"␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port"␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - /**␊ - * Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule.␊ - */␊ - disableOutboundSnat?: (boolean | string)␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A load balancer probe.␊ - */␊ - export interface Probe13 {␊ - /**␊ - * Properties of load balancer probe.␊ - */␊ - properties?: (ProbePropertiesFormat13 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Load balancer probe resource.␊ - */␊ - export interface ProbePropertiesFormat13 {␊ - /**␊ - * The protocol of the end point. Possible values are: 'Http', 'Tcp', or 'Https'. If 'Tcp' is specified, a received ACK is required for the probe to be successful. If 'Http' or 'Https' is specified, a 200 OK response from the specifies URI is required for the probe to be successful.␊ - */␊ - protocol: (("Http" | "Tcp" | "Https") | string)␊ - /**␊ - * The port for communicating the probe. Possible values range from 1 to 65535, inclusive.␊ - */␊ - port: (number | string)␊ - /**␊ - * The interval, in seconds, for how frequently to probe the endpoint for health status. Typically, the interval is slightly less than half the allocated timeout period (in seconds) which allows two full probes before taking the instance out of rotation. The default value is 15, the minimum value is 5.␊ - */␊ - intervalInSeconds?: (number | string)␊ - /**␊ - * The number of probes where if no response, will result in stopping further traffic from being delivered to the endpoint. This values allows endpoints to be taken out of rotation faster or slower than the typical times used in Azure.␊ - */␊ - numberOfProbes: (number | string)␊ - /**␊ - * The URI used for requesting health status from the VM. Path is required if a protocol is set to http. Otherwise, it is not allowed. There is no default value.␊ - */␊ - requestPath?: string␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT rule of the load balancer.␊ - */␊ - export interface InboundNatRule14 {␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties?: (InboundNatRulePropertiesFormat13 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the inbound NAT rule.␊ - */␊ - export interface InboundNatRulePropertiesFormat13 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource19 | string)␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values range from 1 to 65534.␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * The port used for the internal endpoint. Acceptable values range from 1 to 65535.␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT pool of the load balancer.␊ - */␊ - export interface InboundNatPool14 {␊ - /**␊ - * Properties of load balancer inbound nat pool.␊ - */␊ - properties?: (InboundNatPoolPropertiesFormat13 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Inbound NAT pool.␊ - */␊ - export interface InboundNatPoolPropertiesFormat13 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource19 | string)␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65534.␊ - */␊ - frontendPortRangeStart: (number | string)␊ - /**␊ - * The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65535.␊ - */␊ - frontendPortRangeEnd: (number | string)␊ - /**␊ - * The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound pool of the load balancer.␊ - */␊ - export interface OutboundRule1 {␊ - /**␊ - * Properties of load balancer outbound rule.␊ - */␊ - properties?: (OutboundRulePropertiesFormat1 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound pool of the load balancer.␊ - */␊ - export interface OutboundRulePropertiesFormat1 {␊ - /**␊ - * The number of outbound ports to be used for NAT.␊ - */␊ - allocatedOutboundPorts?: (number | string)␊ - /**␊ - * The Frontend IP addresses of the load balancer.␊ - */␊ - frontendIPConfigurations: (SubResource19[] | string)␊ - /**␊ - * A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs.␊ - */␊ - backendAddressPool: (SubResource19 | string)␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - /**␊ - * Protocol - TCP, UDP or All.␊ - */␊ - protocol: (("Tcp" | "Udp" | "All") | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - /**␊ - * The timeout for the TCP idle connection␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers/inboundNatRules␊ - */␊ - export interface LoadBalancersInboundNatRulesChildResource9 {␊ - name: string␊ - type: "inboundNatRules"␊ - apiVersion: "2018-08-01"␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties: (InboundNatRulePropertiesFormat13 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups␊ - */␊ - export interface NetworkSecurityGroups21 {␊ - name: string␊ - type: "Microsoft.Network/networkSecurityGroups"␊ - apiVersion: "2018-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network security group␊ - */␊ - properties: (NetworkSecurityGroupPropertiesFormat13 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: NetworkSecurityGroupsSecurityRulesChildResource13[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network Security Group resource.␊ - */␊ - export interface NetworkSecurityGroupPropertiesFormat13 {␊ - /**␊ - * A collection of security rules of the network security group.␊ - */␊ - securityRules?: (SecurityRule13[] | string)␊ - /**␊ - * The default security rules of network security group.␊ - */␊ - defaultSecurityRules?: (SecurityRule13[] | string)␊ - /**␊ - * The resource GUID property of the network security group resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network security rule.␊ - */␊ - export interface SecurityRule13 {␊ - /**␊ - * Properties of the security rule␊ - */␊ - properties?: (SecurityRulePropertiesFormat13 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Security rule resource.␊ - */␊ - export interface SecurityRulePropertiesFormat13 {␊ - /**␊ - * A description for this rule. Restricted to 140 chars.␊ - */␊ - description?: string␊ - /**␊ - * Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'.␊ - */␊ - protocol: (("Tcp" | "Udp" | "*") | string)␊ - /**␊ - * The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports.␊ - */␊ - sourcePortRange?: string␊ - /**␊ - * The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports.␊ - */␊ - destinationPortRange?: string␊ - /**␊ - * The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. ␊ - */␊ - sourceAddressPrefix?: string␊ - /**␊ - * The CIDR or source IP ranges.␊ - */␊ - sourceAddressPrefixes?: (string[] | string)␊ - /**␊ - * The application security group specified as source.␊ - */␊ - sourceApplicationSecurityGroups?: (SubResource19[] | string)␊ - /**␊ - * The destination address prefix. CIDR or destination IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used.␊ - */␊ - destinationAddressPrefix?: string␊ - /**␊ - * The destination address prefixes. CIDR or destination IP ranges.␊ - */␊ - destinationAddressPrefixes?: (string[] | string)␊ - /**␊ - * The application security group specified as destination.␊ - */␊ - destinationApplicationSecurityGroups?: (SubResource19[] | string)␊ - /**␊ - * The source port ranges.␊ - */␊ - sourcePortRanges?: (string[] | string)␊ - /**␊ - * The destination port ranges.␊ - */␊ - destinationPortRanges?: (string[] | string)␊ - /**␊ - * The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'.␊ - */␊ - access: (("Allow" | "Deny") | string)␊ - /**␊ - * The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.␊ - */␊ - priority: (number | string)␊ - /**␊ - * The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'.␊ - */␊ - direction: (("Inbound" | "Outbound") | string)␊ - /**␊ - * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRulesChildResource13 {␊ - name: string␊ - type: "securityRules"␊ - apiVersion: "2018-08-01"␊ - /**␊ - * Properties of the security rule␊ - */␊ - properties: (SecurityRulePropertiesFormat13 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces␊ - */␊ - export interface NetworkInterfaces22 {␊ - name: string␊ - type: "Microsoft.Network/networkInterfaces"␊ - apiVersion: "2018-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network interface.␊ - */␊ - properties: (NetworkInterfacePropertiesFormat13 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: NetworkInterfacesTapConfigurationsChildResource[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NetworkInterface properties. ␊ - */␊ - export interface NetworkInterfacePropertiesFormat13 {␊ - /**␊ - * The reference of the NetworkSecurityGroup resource.␊ - */␊ - networkSecurityGroup?: (SubResource19 | string)␊ - /**␊ - * A list of IPConfigurations of the network interface.␊ - */␊ - ipConfigurations: (NetworkInterfaceIPConfiguration12[] | string)␊ - /**␊ - * A list of TapConfigurations of the network interface.␊ - */␊ - tapConfigurations?: (NetworkInterfaceTapConfiguration[] | string)␊ - /**␊ - * The DNS settings in network interface.␊ - */␊ - dnsSettings?: (NetworkInterfaceDnsSettings21 | string)␊ - /**␊ - * The MAC address of the network interface.␊ - */␊ - macAddress?: string␊ - /**␊ - * Gets whether this is a primary network interface on a virtual machine.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * If the network interface is accelerated networking enabled.␊ - */␊ - enableAcceleratedNetworking?: (boolean | string)␊ - /**␊ - * Indicates whether IP forwarding is enabled on this network interface.␊ - */␊ - enableIPForwarding?: (boolean | string)␊ - /**␊ - * The resource GUID property of the network interface resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IPConfiguration in a network interface.␊ - */␊ - export interface NetworkInterfaceIPConfiguration12 {␊ - /**␊ - * Network interface IP configuration properties.␊ - */␊ - properties?: (NetworkInterfaceIPConfigurationPropertiesFormat12 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration.␊ - */␊ - export interface NetworkInterfaceIPConfigurationPropertiesFormat12 {␊ - /**␊ - * The reference to Virtual Network Taps.␊ - */␊ - virtualNetworkTaps?: (SubResource19[] | string)␊ - /**␊ - * The reference of ApplicationGatewayBackendAddressPool resource.␊ - */␊ - applicationGatewayBackendAddressPools?: (SubResource19[] | string)␊ - /**␊ - * The reference of LoadBalancerBackendAddressPool resource.␊ - */␊ - loadBalancerBackendAddressPools?: (SubResource19[] | string)␊ - /**␊ - * A list of references of LoadBalancerInboundNatRules.␊ - */␊ - loadBalancerInboundNatRules?: (SubResource19[] | string)␊ - /**␊ - * Private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * Defines how a private IP address is assigned. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Available from Api-Version 2016-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.␊ - */␊ - privateIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * Subnet bound to the IP configuration.␊ - */␊ - subnet?: (SubResource19 | string)␊ - /**␊ - * Gets whether this is a primary customer address on the network interface.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * Public IP address bound to the IP configuration.␊ - */␊ - publicIPAddress?: (SubResource19 | string)␊ - /**␊ - * Application security groups in which the IP configuration is included.␊ - */␊ - applicationSecurityGroups?: (SubResource19[] | string)␊ - /**␊ - * The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Tap configuration in a Network Interface␊ - */␊ - export interface NetworkInterfaceTapConfiguration {␊ - /**␊ - * Properties of the Virtual Network Tap configuration␊ - */␊ - properties?: (NetworkInterfaceTapConfigurationPropertiesFormat | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Virtual Network Tap configuration.␊ - */␊ - export interface NetworkInterfaceTapConfigurationPropertiesFormat {␊ - /**␊ - * The reference of the Virtual Network Tap resource.␊ - */␊ - virtualNetworkTap?: (SubResource19 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DNS settings of a network interface.␊ - */␊ - export interface NetworkInterfaceDnsSettings21 {␊ - /**␊ - * List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only value in dnsServers collection.␊ - */␊ - dnsServers?: (string[] | string)␊ - /**␊ - * If the VM that uses this NIC is part of an Availability Set, then this list will have the union of all DNS servers from all NICs that are part of the Availability Set. This property is what is configured on each of those VMs.␊ - */␊ - appliedDnsServers?: (string[] | string)␊ - /**␊ - * Relative DNS name for this NIC used for internal communications between VMs in the same virtual network.␊ - */␊ - internalDnsNameLabel?: string␊ - /**␊ - * Fully qualified DNS name supporting internal communications between VMs in the same virtual network.␊ - */␊ - internalFqdn?: string␊ - /**␊ - * Even if internalDnsNameLabel is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internalDomainNameSuffix.␊ - */␊ - internalDomainNameSuffix?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces/tapConfigurations␊ - */␊ - export interface NetworkInterfacesTapConfigurationsChildResource {␊ - name: string␊ - type: "tapConfigurations"␊ - apiVersion: "2018-08-01"␊ - /**␊ - * Properties of the Virtual Network Tap configuration␊ - */␊ - properties: (NetworkInterfaceTapConfigurationPropertiesFormat | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables␊ - */␊ - export interface RouteTables21 {␊ - name: string␊ - type: "Microsoft.Network/routeTables"␊ - apiVersion: "2018-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the route table.␊ - */␊ - properties: (RouteTablePropertiesFormat13 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: RouteTablesRoutesChildResource13[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Table resource␊ - */␊ - export interface RouteTablePropertiesFormat13 {␊ - /**␊ - * Collection of routes contained within a route table.␊ - */␊ - routes?: (Route13[] | string)␊ - /**␊ - * Gets or sets whether to disable the routes learned by BGP on that route table. True means disable.␊ - */␊ - disableBgpRoutePropagation?: (boolean | string)␊ - /**␊ - * The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource␊ - */␊ - export interface Route13 {␊ - /**␊ - * Properties of the route.␊ - */␊ - properties?: (RoutePropertiesFormat13 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource␊ - */␊ - export interface RoutePropertiesFormat13 {␊ - /**␊ - * The destination CIDR to which the route applies.␊ - */␊ - addressPrefix: string␊ - /**␊ - * The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'.␊ - */␊ - nextHopType: (("VirtualNetworkGateway" | "VnetLocal" | "Internet" | "VirtualAppliance" | "None") | string)␊ - /**␊ - * The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.␊ - */␊ - nextHopIpAddress?: string␊ - /**␊ - * The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutesChildResource13 {␊ - name: string␊ - type: "routes"␊ - apiVersion: "2018-08-01"␊ - /**␊ - * Properties of the route.␊ - */␊ - properties: (RoutePropertiesFormat13 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/applicationGateways␊ - */␊ - export interface ApplicationGateways12 {␊ - name: string␊ - type: "Microsoft.Network/applicationGateways"␊ - apiVersion: "2018-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (ApplicationGatewayPropertiesFormat12 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * A list of availability zones denoting where the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application gateway.␊ - */␊ - export interface ApplicationGatewayPropertiesFormat12 {␊ - /**␊ - * SKU of the application gateway resource.␊ - */␊ - sku?: (ApplicationGatewaySku12 | string)␊ - /**␊ - * SSL policy of the application gateway resource.␊ - */␊ - sslPolicy?: (ApplicationGatewaySslPolicy9 | string)␊ - /**␊ - * Subnets of application the gateway resource.␊ - */␊ - gatewayIPConfigurations?: (ApplicationGatewayIPConfiguration12[] | string)␊ - /**␊ - * Authentication certificates of the application gateway resource.␊ - */␊ - authenticationCertificates?: (ApplicationGatewayAuthenticationCertificate9[] | string)␊ - /**␊ - * Trusted Root certificates of the application gateway resource.␊ - */␊ - trustedRootCertificates?: (ApplicationGatewayTrustedRootCertificate[] | string)␊ - /**␊ - * SSL certificates of the application gateway resource.␊ - */␊ - sslCertificates?: (ApplicationGatewaySslCertificate12[] | string)␊ - /**␊ - * Frontend IP addresses of the application gateway resource.␊ - */␊ - frontendIPConfigurations?: (ApplicationGatewayFrontendIPConfiguration12[] | string)␊ - /**␊ - * Frontend ports of the application gateway resource.␊ - */␊ - frontendPorts?: (ApplicationGatewayFrontendPort12[] | string)␊ - /**␊ - * Probes of the application gateway resource.␊ - */␊ - probes?: (ApplicationGatewayProbe11[] | string)␊ - /**␊ - * Backend address pool of the application gateway resource.␊ - */␊ - backendAddressPools?: (ApplicationGatewayBackendAddressPool12[] | string)␊ - /**␊ - * Backend http settings of the application gateway resource.␊ - */␊ - backendHttpSettingsCollection?: (ApplicationGatewayBackendHttpSettings12[] | string)␊ - /**␊ - * Http listeners of the application gateway resource.␊ - */␊ - httpListeners?: (ApplicationGatewayHttpListener12[] | string)␊ - /**␊ - * URL path map of the application gateway resource.␊ - */␊ - urlPathMaps?: (ApplicationGatewayUrlPathMap11[] | string)␊ - /**␊ - * Request routing rules of the application gateway resource.␊ - */␊ - requestRoutingRules?: (ApplicationGatewayRequestRoutingRule12[] | string)␊ - /**␊ - * Redirect configurations of the application gateway resource.␊ - */␊ - redirectConfigurations?: (ApplicationGatewayRedirectConfiguration9[] | string)␊ - /**␊ - * Web application firewall configuration.␊ - */␊ - webApplicationFirewallConfiguration?: (ApplicationGatewayWebApplicationFirewallConfiguration9 | string)␊ - /**␊ - * Whether HTTP2 is enabled on the application gateway resource.␊ - */␊ - enableHttp2?: (boolean | string)␊ - /**␊ - * Whether FIPS is enabled on the application gateway resource.␊ - */␊ - enableFips?: (boolean | string)␊ - /**␊ - * Autoscale Configuration.␊ - */␊ - autoscaleConfiguration?: (ApplicationGatewayAutoscaleConfiguration3 | string)␊ - /**␊ - * Resource GUID property of the application gateway resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - /**␊ - * Custom error configurations of the application gateway resource.␊ - */␊ - customErrorConfigurations?: (ApplicationGatewayCustomError[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of an application gateway␊ - */␊ - export interface ApplicationGatewaySku12 {␊ - /**␊ - * Name of an application gateway SKU.␊ - */␊ - name?: (("Standard_Small" | "Standard_Medium" | "Standard_Large" | "WAF_Medium" | "WAF_Large" | "Standard_v2" | "WAF_v2") | string)␊ - /**␊ - * Tier of an application gateway.␊ - */␊ - tier?: (("Standard" | "WAF" | "Standard_v2" | "WAF_v2") | string)␊ - /**␊ - * Capacity (instance count) of an application gateway.␊ - */␊ - capacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application Gateway Ssl policy.␊ - */␊ - export interface ApplicationGatewaySslPolicy9 {␊ - /**␊ - * Ssl protocols to be disabled on application gateway.␊ - */␊ - disabledSslProtocols?: (("TLSv1_0" | "TLSv1_1" | "TLSv1_2")[] | string)␊ - /**␊ - * Type of Ssl Policy.␊ - */␊ - policyType?: (("Predefined" | "Custom") | string)␊ - /**␊ - * Name of Ssl predefined policy.␊ - */␊ - policyName?: (("AppGwSslPolicy20150501" | "AppGwSslPolicy20170401" | "AppGwSslPolicy20170401S") | string)␊ - /**␊ - * Ssl cipher suites to be enabled in the specified order to application gateway.␊ - */␊ - cipherSuites?: (("TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384" | "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256" | "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA" | "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA" | "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384" | "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256" | "TLS_DHE_RSA_WITH_AES_256_CBC_SHA" | "TLS_DHE_RSA_WITH_AES_128_CBC_SHA" | "TLS_RSA_WITH_AES_256_GCM_SHA384" | "TLS_RSA_WITH_AES_128_GCM_SHA256" | "TLS_RSA_WITH_AES_256_CBC_SHA256" | "TLS_RSA_WITH_AES_128_CBC_SHA256" | "TLS_RSA_WITH_AES_256_CBC_SHA" | "TLS_RSA_WITH_AES_128_CBC_SHA" | "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384" | "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256" | "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384" | "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256" | "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA" | "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA" | "TLS_DHE_DSS_WITH_AES_256_CBC_SHA256" | "TLS_DHE_DSS_WITH_AES_128_CBC_SHA256" | "TLS_DHE_DSS_WITH_AES_256_CBC_SHA" | "TLS_DHE_DSS_WITH_AES_128_CBC_SHA" | "TLS_RSA_WITH_3DES_EDE_CBC_SHA" | "TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA" | "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256" | "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384")[] | string)␊ - /**␊ - * Minimum version of Ssl protocol to be supported on application gateway.␊ - */␊ - minProtocolVersion?: (("TLSv1_0" | "TLSv1_1" | "TLSv1_2") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed.␊ - */␊ - export interface ApplicationGatewayIPConfiguration12 {␊ - properties?: (ApplicationGatewayIPConfigurationPropertiesFormat12 | string)␊ - /**␊ - * Name of the IP configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayIPConfigurationPropertiesFormat12 {␊ - /**␊ - * Reference of the subnet resource. A subnet from where application gateway gets its private address.␊ - */␊ - subnet?: (SubResource19 | string)␊ - /**␊ - * Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authentication certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewayAuthenticationCertificate9 {␊ - properties?: (ApplicationGatewayAuthenticationCertificatePropertiesFormat9 | string)␊ - /**␊ - * Name of the authentication certificate that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authentication certificates properties of an application gateway.␊ - */␊ - export interface ApplicationGatewayAuthenticationCertificatePropertiesFormat9 {␊ - /**␊ - * Certificate public data.␊ - */␊ - data?: string␊ - /**␊ - * Provisioning state of the authentication certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trusted Root certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewayTrustedRootCertificate {␊ - properties?: (ApplicationGatewayTrustedRootCertificatePropertiesFormat | string)␊ - /**␊ - * Name of the trusted root certificate that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trusted Root certificates properties of an application gateway.␊ - */␊ - export interface ApplicationGatewayTrustedRootCertificatePropertiesFormat {␊ - /**␊ - * Certificate public data.␊ - */␊ - data?: string␊ - /**␊ - * KeyVault Secret Id for certificate.␊ - */␊ - keyvaultSecretId?: string␊ - /**␊ - * Provisioning state of the trusted root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSL certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewaySslCertificate12 {␊ - properties?: (ApplicationGatewaySslCertificatePropertiesFormat12 | string)␊ - /**␊ - * Name of the SSL certificate that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewaySslCertificatePropertiesFormat12 {␊ - /**␊ - * Base-64 encoded pfx certificate. Only applicable in PUT Request.␊ - */␊ - data?: string␊ - /**␊ - * Password for the pfx file specified in data. Only applicable in PUT request.␊ - */␊ - password?: string␊ - /**␊ - * Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request.␊ - */␊ - publicCertData?: string␊ - /**␊ - * Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendIPConfiguration12 {␊ - properties?: (ApplicationGatewayFrontendIPConfigurationPropertiesFormat12 | string)␊ - /**␊ - * Name of the frontend IP configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendIPConfigurationPropertiesFormat12 {␊ - /**␊ - * PrivateIPAddress of the network interface IP Configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * PrivateIP allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Reference of the subnet resource.␊ - */␊ - subnet?: (SubResource19 | string)␊ - /**␊ - * Reference of the PublicIP resource.␊ - */␊ - publicIPAddress?: (SubResource19 | string)␊ - /**␊ - * Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend port of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendPort12 {␊ - properties?: (ApplicationGatewayFrontendPortPropertiesFormat12 | string)␊ - /**␊ - * Name of the frontend port that is unique within an Application Gateway␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend port of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendPortPropertiesFormat12 {␊ - /**␊ - * Frontend port␊ - */␊ - port?: (number | string)␊ - /**␊ - * Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Probe of the application gateway.␊ - */␊ - export interface ApplicationGatewayProbe11 {␊ - properties?: (ApplicationGatewayProbePropertiesFormat11 | string)␊ - /**␊ - * Name of the probe that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of probe of an application gateway.␊ - */␊ - export interface ApplicationGatewayProbePropertiesFormat11 {␊ - /**␊ - * The protocol used for the probe. Possible values are 'Http' and 'Https'.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Host name to send the probe to.␊ - */␊ - host?: string␊ - /**␊ - * Relative path of probe. Valid path starts from '/'. Probe is sent to ://:␊ - */␊ - path?: string␊ - /**␊ - * The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - interval?: (number | string)␊ - /**␊ - * the probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - timeout?: (number | string)␊ - /**␊ - * The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20.␊ - */␊ - unhealthyThreshold?: (number | string)␊ - /**␊ - * Whether the host header should be picked from the backend http settings. Default value is false.␊ - */␊ - pickHostNameFromBackendHttpSettings?: (boolean | string)␊ - /**␊ - * Minimum number of servers that are always marked healthy. Default value is 0.␊ - */␊ - minServers?: (number | string)␊ - /**␊ - * Criterion for classifying a healthy probe response.␊ - */␊ - match?: (ApplicationGatewayProbeHealthResponseMatch9 | string)␊ - /**␊ - * Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application gateway probe health response match␊ - */␊ - export interface ApplicationGatewayProbeHealthResponseMatch9 {␊ - /**␊ - * Body that must be contained in the health response. Default value is empty.␊ - */␊ - body?: string␊ - /**␊ - * Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399.␊ - */␊ - statusCodes?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend Address Pool of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddressPool12 {␊ - properties?: (ApplicationGatewayBackendAddressPoolPropertiesFormat12 | string)␊ - /**␊ - * Name of the backend address pool that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend Address Pool of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddressPoolPropertiesFormat12 {␊ - /**␊ - * Collection of references to IPs defined in network interfaces.␊ - */␊ - backendIPConfigurations?: (SubResource19[] | string)␊ - /**␊ - * Backend addresses␊ - */␊ - backendAddresses?: (ApplicationGatewayBackendAddress12[] | string)␊ - /**␊ - * Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddress12 {␊ - /**␊ - * Fully qualified domain name (FQDN).␊ - */␊ - fqdn?: string␊ - /**␊ - * IP address␊ - */␊ - ipAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address pool settings of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendHttpSettings12 {␊ - properties?: (ApplicationGatewayBackendHttpSettingsPropertiesFormat12 | string)␊ - /**␊ - * Name of the backend http settings that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend address pool settings of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendHttpSettingsPropertiesFormat12 {␊ - /**␊ - * The destination port on the backend.␊ - */␊ - port?: (number | string)␊ - /**␊ - * The protocol used to communicate with the backend. Possible values are 'Http' and 'Https'.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Cookie based affinity.␊ - */␊ - cookieBasedAffinity?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Request timeout in seconds. Application Gateway will fail the request if response is not received within RequestTimeout. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - requestTimeout?: (number | string)␊ - /**␊ - * Probe resource of an application gateway.␊ - */␊ - probe?: (SubResource19 | string)␊ - /**␊ - * Array of references to application gateway authentication certificates.␊ - */␊ - authenticationCertificates?: (SubResource19[] | string)␊ - /**␊ - * Array of references to application gateway trusted root certificates.␊ - */␊ - trustedRootCertificates?: (SubResource19[] | string)␊ - /**␊ - * Connection draining of the backend http settings resource.␊ - */␊ - connectionDraining?: (ApplicationGatewayConnectionDraining9 | string)␊ - /**␊ - * Host header to be sent to the backend servers.␊ - */␊ - hostName?: string␊ - /**␊ - * Whether to pick host header should be picked from the host name of the backend server. Default value is false.␊ - */␊ - pickHostNameFromBackendAddress?: (boolean | string)␊ - /**␊ - * Cookie name to use for the affinity cookie.␊ - */␊ - affinityCookieName?: string␊ - /**␊ - * Whether the probe is enabled. Default value is false.␊ - */␊ - probeEnabled?: (boolean | string)␊ - /**␊ - * Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null.␊ - */␊ - path?: string␊ - /**␊ - * Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Connection draining allows open connections to a backend server to be active for a specified time after the backend server got removed from the configuration.␊ - */␊ - export interface ApplicationGatewayConnectionDraining9 {␊ - /**␊ - * Whether connection draining is enabled or not.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds.␊ - */␊ - drainTimeoutInSec: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http listener of an application gateway.␊ - */␊ - export interface ApplicationGatewayHttpListener12 {␊ - properties?: (ApplicationGatewayHttpListenerPropertiesFormat12 | string)␊ - /**␊ - * Name of the HTTP listener that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of HTTP listener of an application gateway.␊ - */␊ - export interface ApplicationGatewayHttpListenerPropertiesFormat12 {␊ - /**␊ - * Frontend IP configuration resource of an application gateway.␊ - */␊ - frontendIPConfiguration?: (SubResource19 | string)␊ - /**␊ - * Frontend port resource of an application gateway.␊ - */␊ - frontendPort?: (SubResource19 | string)␊ - /**␊ - * Protocol of the HTTP listener. Possible values are 'Http' and 'Https'.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Host name of HTTP listener.␊ - */␊ - hostName?: string␊ - /**␊ - * SSL certificate resource of an application gateway.␊ - */␊ - sslCertificate?: (SubResource19 | string)␊ - /**␊ - * Applicable only if protocol is https. Enables SNI for multi-hosting.␊ - */␊ - requireServerNameIndication?: (boolean | string)␊ - /**␊ - * Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - /**␊ - * Custom error configurations of the HTTP listener.␊ - */␊ - customErrorConfigurations?: (ApplicationGatewayCustomError[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Customer error of an application gateway.␊ - */␊ - export interface ApplicationGatewayCustomError {␊ - /**␊ - * Status code of the application gateway customer error.␊ - */␊ - statusCode?: (("HttpStatus403" | "HttpStatus502") | string)␊ - /**␊ - * Error page URL of the application gateway customer error.␊ - */␊ - customErrorPageUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * UrlPathMaps give a url path to the backend mapping information for PathBasedRouting.␊ - */␊ - export interface ApplicationGatewayUrlPathMap11 {␊ - properties?: (ApplicationGatewayUrlPathMapPropertiesFormat11 | string)␊ - /**␊ - * Name of the URL path map that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of UrlPathMap of the application gateway.␊ - */␊ - export interface ApplicationGatewayUrlPathMapPropertiesFormat11 {␊ - /**␊ - * Default backend address pool resource of URL path map.␊ - */␊ - defaultBackendAddressPool?: (SubResource19 | string)␊ - /**␊ - * Default backend http settings resource of URL path map.␊ - */␊ - defaultBackendHttpSettings?: (SubResource19 | string)␊ - /**␊ - * Default redirect configuration resource of URL path map.␊ - */␊ - defaultRedirectConfiguration?: (SubResource19 | string)␊ - /**␊ - * Path rule of URL path map resource.␊ - */␊ - pathRules?: (ApplicationGatewayPathRule11[] | string)␊ - /**␊ - * Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Path rule of URL path map of an application gateway.␊ - */␊ - export interface ApplicationGatewayPathRule11 {␊ - properties?: (ApplicationGatewayPathRulePropertiesFormat11 | string)␊ - /**␊ - * Name of the path rule that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of path rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayPathRulePropertiesFormat11 {␊ - /**␊ - * Path rules of URL path map.␊ - */␊ - paths?: (string[] | string)␊ - /**␊ - * Backend address pool resource of URL path map path rule.␊ - */␊ - backendAddressPool?: (SubResource19 | string)␊ - /**␊ - * Backend http settings resource of URL path map path rule.␊ - */␊ - backendHttpSettings?: (SubResource19 | string)␊ - /**␊ - * Redirect configuration resource of URL path map path rule.␊ - */␊ - redirectConfiguration?: (SubResource19 | string)␊ - /**␊ - * Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Request routing rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayRequestRoutingRule12 {␊ - properties?: (ApplicationGatewayRequestRoutingRulePropertiesFormat12 | string)␊ - /**␊ - * Name of the request routing rule that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of request routing rule of the application gateway.␊ - */␊ - export interface ApplicationGatewayRequestRoutingRulePropertiesFormat12 {␊ - /**␊ - * Rule type.␊ - */␊ - ruleType?: (("Basic" | "PathBasedRouting") | string)␊ - /**␊ - * Backend address pool resource of the application gateway. ␊ - */␊ - backendAddressPool?: (SubResource19 | string)␊ - /**␊ - * Backend http settings resource of the application gateway.␊ - */␊ - backendHttpSettings?: (SubResource19 | string)␊ - /**␊ - * Http listener resource of the application gateway. ␊ - */␊ - httpListener?: (SubResource19 | string)␊ - /**␊ - * URL path map resource of the application gateway.␊ - */␊ - urlPathMap?: (SubResource19 | string)␊ - /**␊ - * Redirect configuration resource of the application gateway.␊ - */␊ - redirectConfiguration?: (SubResource19 | string)␊ - /**␊ - * Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Redirect configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayRedirectConfiguration9 {␊ - properties?: (ApplicationGatewayRedirectConfigurationPropertiesFormat9 | string)␊ - /**␊ - * Name of the redirect configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of redirect configuration of the application gateway.␊ - */␊ - export interface ApplicationGatewayRedirectConfigurationPropertiesFormat9 {␊ - /**␊ - * Supported http redirection types - Permanent, Temporary, Found, SeeOther.␊ - */␊ - redirectType?: (("Permanent" | "Found" | "SeeOther" | "Temporary") | string)␊ - /**␊ - * Reference to a listener to redirect the request to.␊ - */␊ - targetListener?: (SubResource19 | string)␊ - /**␊ - * Url to redirect the request to.␊ - */␊ - targetUrl?: string␊ - /**␊ - * Include path in the redirected url.␊ - */␊ - includePath?: (boolean | string)␊ - /**␊ - * Include query string in the redirected url.␊ - */␊ - includeQueryString?: (boolean | string)␊ - /**␊ - * Request routing specifying redirect configuration.␊ - */␊ - requestRoutingRules?: (SubResource19[] | string)␊ - /**␊ - * Url path maps specifying default redirect configuration.␊ - */␊ - urlPathMaps?: (SubResource19[] | string)␊ - /**␊ - * Path rules specifying redirect configuration.␊ - */␊ - pathRules?: (SubResource19[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application gateway web application firewall configuration.␊ - */␊ - export interface ApplicationGatewayWebApplicationFirewallConfiguration9 {␊ - /**␊ - * Whether the web application firewall is enabled or not.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * Web application firewall mode.␊ - */␊ - firewallMode: (("Detection" | "Prevention") | string)␊ - /**␊ - * The type of the web application firewall rule set. Possible values are: 'OWASP'.␊ - */␊ - ruleSetType: string␊ - /**␊ - * The version of the rule set type.␊ - */␊ - ruleSetVersion: string␊ - /**␊ - * The disabled rule groups.␊ - */␊ - disabledRuleGroups?: (ApplicationGatewayFirewallDisabledRuleGroup9[] | string)␊ - /**␊ - * Whether allow WAF to check request Body.␊ - */␊ - requestBodyCheck?: (boolean | string)␊ - /**␊ - * Maxium request body size for WAF.␊ - */␊ - maxRequestBodySize?: (number | string)␊ - /**␊ - * Maxium request body size in Kb for WAF.␊ - */␊ - maxRequestBodySizeInKb?: (number | string)␊ - /**␊ - * Maxium file upload size in Mb for WAF.␊ - */␊ - fileUploadLimitInMb?: (number | string)␊ - /**␊ - * The exclusion list.␊ - */␊ - exclusions?: (ApplicationGatewayFirewallExclusion[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allows to disable rules within a rule group or an entire rule group.␊ - */␊ - export interface ApplicationGatewayFirewallDisabledRuleGroup9 {␊ - /**␊ - * The name of the rule group that will be disabled.␊ - */␊ - ruleGroupName: string␊ - /**␊ - * The list of rules that will be disabled. If null, all rules of the rule group will be disabled.␊ - */␊ - rules?: (number[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allow to exclude some variable satisfy the condition for the WAF check␊ - */␊ - export interface ApplicationGatewayFirewallExclusion {␊ - /**␊ - * The variable to be excluded.␊ - */␊ - matchVariable: string␊ - /**␊ - * When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to.␊ - */␊ - selectorMatchOperator: string␊ - /**␊ - * When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to.␊ - */␊ - selector: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application Gateway autoscale configuration.␊ - */␊ - export interface ApplicationGatewayAutoscaleConfiguration3 {␊ - /**␊ - * Lower bound on number of Application Gateway instances␊ - */␊ - minCapacity: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/authorizations␊ - */␊ - export interface ExpressRouteCircuitsAuthorizations7 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/authorizations"␊ - apiVersion: "2018-08-01"␊ - properties: (AuthorizationPropertiesFormat7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ExpressRoutePorts␊ - */␊ - export interface ExpressRoutePorts {␊ - name: string␊ - type: "Microsoft.Network/ExpressRoutePorts"␊ - apiVersion: "2018-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * ExpressRoutePort properties␊ - */␊ - properties: (ExpressRoutePortPropertiesFormat | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to ExpressRoutePort resources.␊ - */␊ - export interface ExpressRoutePortPropertiesFormat {␊ - /**␊ - * The name of the peering location that the ExpressRoutePort is mapped to physically.␊ - */␊ - peeringLocation?: string␊ - /**␊ - * Bandwidth of procured ports in Gbps␊ - */␊ - bandwidthInGbps?: (number | string)␊ - /**␊ - * Encapsulation method on physical ports.␊ - */␊ - encapsulation?: (("Dot1Q" | "QinQ") | string)␊ - /**␊ - * The set of physical links of the ExpressRoutePort resource␊ - */␊ - links?: (ExpressRouteLink[] | string)␊ - /**␊ - * The resource GUID property of the ExpressRoutePort resource.␊ - */␊ - resourceGuid?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ExpressRouteLink child resource definition.␊ - */␊ - export interface ExpressRouteLink {␊ - /**␊ - * ExpressRouteLink properties␊ - */␊ - properties?: (ExpressRouteLinkPropertiesFormat | string)␊ - /**␊ - * Name of child port resource that is unique among child port resources of the parent.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to ExpressRouteLink resources.␊ - */␊ - export interface ExpressRouteLinkPropertiesFormat {␊ - /**␊ - * Administrative state of the physical port.␊ - */␊ - adminState?: (("Enabled" | "Disabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/connections␊ - */␊ - export interface Connections12 {␊ - name: string␊ - type: "Microsoft.Network/connections"␊ - apiVersion: "2018-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway connection.␊ - */␊ - properties: (VirtualNetworkGatewayConnectionPropertiesFormat12 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewayConnection properties␊ - */␊ - export interface VirtualNetworkGatewayConnectionPropertiesFormat12 {␊ - /**␊ - * The authorizationKey.␊ - */␊ - authorizationKey?: string␊ - /**␊ - * The reference to virtual network gateway resource.␊ - */␊ - virtualNetworkGateway1: (VirtualNetworkGateway8 | SubResource19 | string)␊ - /**␊ - * The reference to virtual network gateway resource.␊ - */␊ - virtualNetworkGateway2?: (VirtualNetworkGateway8 | SubResource19 | string)␊ - /**␊ - * The reference to local network gateway resource.␊ - */␊ - localNetworkGateway2?: (LocalNetworkGateway8 | SubResource19 | string)␊ - /**␊ - * Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.␊ - */␊ - connectionType: (("IPsec" | "Vnet2Vnet" | "ExpressRoute" | "VPNClient") | string)␊ - /**␊ - * Connection protocol used for this connection.␊ - */␊ - connectionProtocol?: (("IKEv2" | "IKEv1") | string)␊ - /**␊ - * The routing weight.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * The IPSec shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The reference to peerings resource.␊ - */␊ - peer?: (SubResource19 | string)␊ - /**␊ - * EnableBgp flag␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * Enable policy-based traffic selectors.␊ - */␊ - usePolicyBasedTrafficSelectors?: (boolean | string)␊ - /**␊ - * The IPSec Policies to be considered by this connection.␊ - */␊ - ipsecPolicies?: (IpsecPolicy9[] | string)␊ - /**␊ - * The resource GUID property of the VirtualNetworkGatewayConnection resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Bypass ExpressRoute Gateway for data forwarding␊ - */␊ - expressRouteGatewayBypass?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A common class for general resource information␊ - */␊ - export interface VirtualNetworkGateway8 {␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway.␊ - */␊ - properties: (VirtualNetworkGatewayPropertiesFormat12 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGateway properties␊ - */␊ - export interface VirtualNetworkGatewayPropertiesFormat12 {␊ - /**␊ - * IP configurations for virtual network gateway.␊ - */␊ - ipConfigurations?: (VirtualNetworkGatewayIPConfiguration11[] | string)␊ - /**␊ - * The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'.␊ - */␊ - gatewayType?: (("Vpn" | "ExpressRoute") | string)␊ - /**␊ - * The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'.␊ - */␊ - vpnType?: (("PolicyBased" | "RouteBased") | string)␊ - /**␊ - * Whether BGP is enabled for this virtual network gateway or not.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * ActiveActive flag␊ - */␊ - activeActive?: (boolean | string)␊ - /**␊ - * The reference of the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting.␊ - */␊ - gatewayDefaultSite?: (SubResource19 | string)␊ - /**␊ - * The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.␊ - */␊ - sku?: (VirtualNetworkGatewaySku11 | string)␊ - /**␊ - * The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations.␊ - */␊ - vpnClientConfiguration?: (VpnClientConfiguration11 | string)␊ - /**␊ - * Virtual network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings11 | string)␊ - /**␊ - * The resource GUID property of the VirtualNetworkGateway resource.␊ - */␊ - resourceGuid?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration for virtual network gateway␊ - */␊ - export interface VirtualNetworkGatewayIPConfiguration11 {␊ - /**␊ - * Properties of the virtual network gateway ip configuration.␊ - */␊ - properties?: (VirtualNetworkGatewayIPConfigurationPropertiesFormat11 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of VirtualNetworkGatewayIPConfiguration␊ - */␊ - export interface VirtualNetworkGatewayIPConfigurationPropertiesFormat11 {␊ - /**␊ - * The private IP allocation method. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * The reference of the subnet resource.␊ - */␊ - subnet?: (SubResource19 | string)␊ - /**␊ - * The reference of the public IP resource.␊ - */␊ - publicIPAddress?: (SubResource19 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewaySku details␊ - */␊ - export interface VirtualNetworkGatewaySku11 {␊ - /**␊ - * Gateway SKU name.␊ - */␊ - name?: (("Basic" | "HighPerformance" | "Standard" | "UltraPerformance" | "VpnGw1" | "VpnGw2" | "VpnGw3" | "VpnGw1AZ" | "VpnGw2AZ" | "VpnGw3AZ" | "ErGw1AZ" | "ErGw2AZ" | "ErGw3AZ") | string)␊ - /**␊ - * Gateway SKU tier.␊ - */␊ - tier?: (("Basic" | "HighPerformance" | "Standard" | "UltraPerformance" | "VpnGw1" | "VpnGw2" | "VpnGw3" | "VpnGw1AZ" | "VpnGw2AZ" | "VpnGw3AZ" | "ErGw1AZ" | "ErGw2AZ" | "ErGw3AZ") | string)␊ - /**␊ - * The capacity.␊ - */␊ - capacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnClientConfiguration for P2S client.␊ - */␊ - export interface VpnClientConfiguration11 {␊ - /**␊ - * The reference of the address space resource which represents Address space for P2S VpnClient.␊ - */␊ - vpnClientAddressPool?: (AddressSpace21 | string)␊ - /**␊ - * VpnClientRootCertificate for virtual network gateway.␊ - */␊ - vpnClientRootCertificates?: (VpnClientRootCertificate11[] | string)␊ - /**␊ - * VpnClientRevokedCertificate for Virtual network gateway.␊ - */␊ - vpnClientRevokedCertificates?: (VpnClientRevokedCertificate11[] | string)␊ - /**␊ - * VpnClientProtocols for Virtual network gateway.␊ - */␊ - vpnClientProtocols?: (("IkeV2" | "SSTP" | "OpenVPN")[] | string)␊ - /**␊ - * VpnClientIpsecPolicies for virtual network gateway P2S client.␊ - */␊ - vpnClientIpsecPolicies?: (IpsecPolicy9[] | string)␊ - /**␊ - * The radius server address property of the VirtualNetworkGateway resource for vpn client connection.␊ - */␊ - radiusServerAddress?: string␊ - /**␊ - * The radius secret property of the VirtualNetworkGateway resource for vpn client connection.␊ - */␊ - radiusServerSecret?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client root certificate of virtual network gateway␊ - */␊ - export interface VpnClientRootCertificate11 {␊ - /**␊ - * Properties of the vpn client root certificate.␊ - */␊ - properties: (VpnClientRootCertificatePropertiesFormat11 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of application gateway␊ - */␊ - export interface VpnClientRootCertificatePropertiesFormat11 {␊ - /**␊ - * The certificate public data.␊ - */␊ - publicCertData: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client revoked certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRevokedCertificate11 {␊ - /**␊ - * Properties of the vpn client revoked certificate.␊ - */␊ - properties?: (VpnClientRevokedCertificatePropertiesFormat11 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the revoked VPN client certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRevokedCertificatePropertiesFormat11 {␊ - /**␊ - * The revoked VPN client certificate thumbprint.␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An IPSec Policy configuration for a virtual network gateway connection␊ - */␊ - export interface IpsecPolicy9 {␊ - /**␊ - * The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.␊ - */␊ - saLifeTimeSeconds: (number | string)␊ - /**␊ - * The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.␊ - */␊ - saDataSizeKilobytes: (number | string)␊ - /**␊ - * The IPSec encryption algorithm (IKE phase 1).␊ - */␊ - ipsecEncryption: (("None" | "DES" | "DES3" | "AES128" | "AES192" | "AES256" | "GCMAES128" | "GCMAES192" | "GCMAES256") | string)␊ - /**␊ - * The IPSec integrity algorithm (IKE phase 1).␊ - */␊ - ipsecIntegrity: (("MD5" | "SHA1" | "SHA256" | "GCMAES128" | "GCMAES192" | "GCMAES256") | string)␊ - /**␊ - * The IKE encryption algorithm (IKE phase 2).␊ - */␊ - ikeEncryption: (("DES" | "DES3" | "AES128" | "AES192" | "AES256" | "GCMAES256" | "GCMAES128") | string)␊ - /**␊ - * The IKE integrity algorithm (IKE phase 2).␊ - */␊ - ikeIntegrity: (("MD5" | "SHA1" | "SHA256" | "SHA384" | "GCMAES256" | "GCMAES128") | string)␊ - /**␊ - * The DH Groups used in IKE Phase 1 for initial SA.␊ - */␊ - dhGroup: (("None" | "DHGroup1" | "DHGroup2" | "DHGroup14" | "DHGroup2048" | "ECP256" | "ECP384" | "DHGroup24") | string)␊ - /**␊ - * The Pfs Groups used in IKE Phase 2 for new child SA.␊ - */␊ - pfsGroup: (("None" | "PFS1" | "PFS2" | "PFS2048" | "ECP256" | "ECP384" | "PFS24" | "PFS14" | "PFSMM") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * BGP settings details␊ - */␊ - export interface BgpSettings11 {␊ - /**␊ - * The BGP speaker's ASN.␊ - */␊ - asn?: (number | string)␊ - /**␊ - * The BGP peering address and BGP identifier of this BGP speaker.␊ - */␊ - bgpPeeringAddress?: string␊ - /**␊ - * The weight added to routes learned from this BGP speaker.␊ - */␊ - peerWeight?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A common class for general resource information␊ - */␊ - export interface LocalNetworkGateway8 {␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the local network gateway.␊ - */␊ - properties: (LocalNetworkGatewayPropertiesFormat12 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * LocalNetworkGateway properties␊ - */␊ - export interface LocalNetworkGatewayPropertiesFormat12 {␊ - /**␊ - * Local network site address space.␊ - */␊ - localNetworkAddressSpace?: (AddressSpace21 | string)␊ - /**␊ - * IP address of local network gateway.␊ - */␊ - gatewayIpAddress?: string␊ - /**␊ - * Local network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings11 | string)␊ - /**␊ - * The resource GUID property of the LocalNetworkGateway resource.␊ - */␊ - resourceGuid?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/localNetworkGateways␊ - */␊ - export interface LocalNetworkGateways12 {␊ - name: string␊ - type: "Microsoft.Network/localNetworkGateways"␊ - apiVersion: "2018-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the local network gateway.␊ - */␊ - properties: (LocalNetworkGatewayPropertiesFormat12 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworkGateways␊ - */␊ - export interface VirtualNetworkGateways12 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworkGateways"␊ - apiVersion: "2018-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway.␊ - */␊ - properties: (VirtualNetworkGatewayPropertiesFormat12 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnets12 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks/subnets"␊ - apiVersion: "2018-08-01"␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties: (SubnetPropertiesFormat13 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/virtualNetworkPeerings␊ - */␊ - export interface VirtualNetworksVirtualNetworkPeerings9 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks/virtualNetworkPeerings"␊ - apiVersion: "2018-08-01"␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties: (VirtualNetworkPeeringPropertiesFormat10 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings␊ - */␊ - export interface ExpressRouteCircuitsPeerings7 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/peerings"␊ - apiVersion: "2018-08-01"␊ - properties: (ExpressRouteCircuitPeeringPropertiesFormat7 | string)␊ - resources?: ExpressRouteCircuitsPeeringsConnectionsChildResource4[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections/peerings␊ - */␊ - export interface ExpressRouteCrossConnectionsPeerings4 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCrossConnections/peerings"␊ - apiVersion: "2018-08-01"␊ - properties: (ExpressRouteCrossConnectionPeeringProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers/inboundNatRules␊ - */␊ - export interface LoadBalancersInboundNatRules9 {␊ - name: string␊ - type: "Microsoft.Network/loadBalancers/inboundNatRules"␊ - apiVersion: "2018-08-01"␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties: (InboundNatRulePropertiesFormat13 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces/tapConfigurations␊ - */␊ - export interface NetworkInterfacesTapConfigurations {␊ - name: string␊ - type: "Microsoft.Network/networkInterfaces/tapConfigurations"␊ - apiVersion: "2018-08-01"␊ - /**␊ - * Properties of the Virtual Network Tap configuration␊ - */␊ - properties: (NetworkInterfaceTapConfigurationPropertiesFormat | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRules13 {␊ - name: string␊ - type: "Microsoft.Network/networkSecurityGroups/securityRules"␊ - apiVersion: "2018-08-01"␊ - /**␊ - * Properties of the security rule␊ - */␊ - properties: (SecurityRulePropertiesFormat13 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutes13 {␊ - name: string␊ - type: "Microsoft.Network/routeTables/routes"␊ - apiVersion: "2018-08-01"␊ - /**␊ - * Properties of the route.␊ - */␊ - properties: (RoutePropertiesFormat13 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings/connections␊ - */␊ - export interface ExpressRouteCircuitsPeeringsConnections4 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/peerings/connections"␊ - apiVersion: "2018-08-01"␊ - properties: (ExpressRouteCircuitConnectionPropertiesFormat4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/applicationSecurityGroups␊ - */␊ - export interface ApplicationSecurityGroups9 {␊ - name: string␊ - type: "Microsoft.Network/applicationSecurityGroups"␊ - apiVersion: "2018-10-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the application security group.␊ - */␊ - properties: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ddosProtectionPlans␊ - */␊ - export interface DdosProtectionPlans5 {␊ - name: string␊ - type: "Microsoft.Network/ddosProtectionPlans"␊ - apiVersion: "2018-10-01"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the DDoS protection plan.␊ - */␊ - properties: (DdosProtectionPlanPropertiesFormat2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DDoS protection plan properties.␊ - */␊ - export interface DdosProtectionPlanPropertiesFormat2 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits␊ - */␊ - export interface ExpressRouteCircuits7 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits"␊ - apiVersion: "2018-10-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The SKU.␊ - */␊ - sku?: (ExpressRouteCircuitSku7 | string)␊ - properties: (ExpressRouteCircuitPropertiesFormat7 | string)␊ - resources?: (ExpressRouteCircuitsPeeringsChildResource7 | ExpressRouteCircuitsAuthorizationsChildResource7)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains SKU in an ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitSku7 {␊ - /**␊ - * The name of the SKU.␊ - */␊ - name?: string␊ - /**␊ - * The tier of the SKU. Possible values are 'Standard', 'Premium' or 'Basic'.␊ - */␊ - tier?: (("Standard" | "Premium" | "Basic") | string)␊ - /**␊ - * The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'.␊ - */␊ - family?: (("UnlimitedData" | "MeteredData") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitPropertiesFormat7 {␊ - /**␊ - * Allow classic operations␊ - */␊ - allowClassicOperations?: (boolean | string)␊ - /**␊ - * The CircuitProvisioningState state of the resource.␊ - */␊ - circuitProvisioningState?: string␊ - /**␊ - * The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'.␊ - */␊ - serviceProviderProvisioningState?: (("NotProvisioned" | "Provisioning" | "Provisioned" | "Deprovisioning") | string)␊ - /**␊ - * The list of authorizations.␊ - */␊ - authorizations?: (ExpressRouteCircuitAuthorization7[] | string)␊ - /**␊ - * The list of peerings.␊ - */␊ - peerings?: (ExpressRouteCircuitPeering7[] | string)␊ - /**␊ - * The ServiceKey.␊ - */␊ - serviceKey?: string␊ - /**␊ - * The ServiceProviderNotes.␊ - */␊ - serviceProviderNotes?: string␊ - /**␊ - * The ServiceProviderProperties.␊ - */␊ - serviceProviderProperties?: (ExpressRouteCircuitServiceProviderProperties7 | string)␊ - /**␊ - * The reference to the ExpressRoutePort resource when the circuit is provisioned on an ExpressRoutePort resource.␊ - */␊ - expressRoutePort?: (SubResource20 | string)␊ - /**␊ - * The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource.␊ - */␊ - bandwidthInGbps?: (number | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - /**␊ - * Flag to enable Global Reach on the circuit.␊ - */␊ - allowGlobalReach?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authorization in an ExpressRouteCircuit resource.␊ - */␊ - export interface ExpressRouteCircuitAuthorization7 {␊ - properties?: (AuthorizationPropertiesFormat8 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - export interface AuthorizationPropertiesFormat8 {␊ - /**␊ - * The authorization key.␊ - */␊ - authorizationKey?: string␊ - /**␊ - * AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'.␊ - */␊ - authorizationUseStatus?: (("Available" | "InUse") | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peering in an ExpressRouteCircuit resource.␊ - */␊ - export interface ExpressRouteCircuitPeering7 {␊ - properties?: (ExpressRouteCircuitPeeringPropertiesFormat8 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - export interface ExpressRouteCircuitPeeringPropertiesFormat8 {␊ - /**␊ - * The peering type.␊ - */␊ - peeringType?: (("AzurePublicPeering" | "AzurePrivatePeering" | "MicrosoftPeering") | string)␊ - /**␊ - * The peering state.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * The Azure ASN.␊ - */␊ - azureASN?: (number | string)␊ - /**␊ - * The peer ASN.␊ - */␊ - peerASN?: (number | string)␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The primary port.␊ - */␊ - primaryAzurePort?: string␊ - /**␊ - * The secondary port.␊ - */␊ - secondaryAzurePort?: string␊ - /**␊ - * The shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The VLAN ID.␊ - */␊ - vlanId?: (number | string)␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig8 | string)␊ - /**␊ - * Gets peering stats.␊ - */␊ - stats?: (ExpressRouteCircuitStats8 | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - /**␊ - * Gets whether the provider or the customer last modified the peering.␊ - */␊ - lastModifiedBy?: string␊ - /**␊ - * The reference of the RouteFilter resource.␊ - */␊ - routeFilter?: (SubResource20 | string)␊ - /**␊ - * The IPv6 peering configuration.␊ - */␊ - ipv6PeeringConfig?: (Ipv6ExpressRouteCircuitPeeringConfig5 | string)␊ - /**␊ - * The ExpressRoute connection.␊ - */␊ - expressRouteConnection?: ({␊ - [k: string]: unknown␊ - } | string)␊ - /**␊ - * The list of circuit connections associated with Azure Private Peering for this circuit.␊ - */␊ - connections?: (ExpressRouteCircuitConnection5[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the peering configuration.␊ - */␊ - export interface ExpressRouteCircuitPeeringConfig8 {␊ - /**␊ - * The reference of AdvertisedPublicPrefixes.␊ - */␊ - advertisedPublicPrefixes?: (string[] | string)␊ - /**␊ - * The communities of bgp peering. Spepcified for microsoft peering␊ - */␊ - advertisedCommunities?: (string[] | string)␊ - /**␊ - * AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'.␊ - */␊ - advertisedPublicPrefixesState?: (("NotConfigured" | "Configuring" | "Configured" | "ValidationNeeded") | string)␊ - /**␊ - * The legacy mode of the peering.␊ - */␊ - legacyMode?: (number | string)␊ - /**␊ - * The CustomerASN of the peering.␊ - */␊ - customerASN?: (number | string)␊ - /**␊ - * The RoutingRegistryName of the configuration.␊ - */␊ - routingRegistryName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains stats associated with the peering.␊ - */␊ - export interface ExpressRouteCircuitStats8 {␊ - /**␊ - * Gets BytesIn of the peering.␊ - */␊ - primarybytesIn?: (number | string)␊ - /**␊ - * Gets BytesOut of the peering.␊ - */␊ - primarybytesOut?: (number | string)␊ - /**␊ - * Gets BytesIn of the peering.␊ - */␊ - secondarybytesIn?: (number | string)␊ - /**␊ - * Gets BytesOut of the peering.␊ - */␊ - secondarybytesOut?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Reference to another subresource.␊ - */␊ - export interface SubResource20 {␊ - /**␊ - * Resource ID.␊ - */␊ - id: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains IPv6 peering config.␊ - */␊ - export interface Ipv6ExpressRouteCircuitPeeringConfig5 {␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig8 | string)␊ - /**␊ - * The reference of the RouteFilter resource.␊ - */␊ - routeFilter?: (SubResource20 | string)␊ - /**␊ - * The state of peering. Possible values are: 'Disabled' and 'Enabled'.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Express Route Circuit Connection in an ExpressRouteCircuitPeering resource.␊ - */␊ - export interface ExpressRouteCircuitConnection5 {␊ - properties?: (ExpressRouteCircuitConnectionPropertiesFormat5 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - export interface ExpressRouteCircuitConnectionPropertiesFormat5 {␊ - /**␊ - * Reference to Express Route Circuit Private Peering Resource of the circuit initiating connection.␊ - */␊ - expressRouteCircuitPeering?: (SubResource20 | string)␊ - /**␊ - * Reference to Express Route Circuit Private Peering Resource of the peered circuit.␊ - */␊ - peerExpressRouteCircuitPeering?: (SubResource20 | string)␊ - /**␊ - * /29 IP address space to carve out Customer addresses for tunnels.␊ - */␊ - addressPrefix?: string␊ - /**␊ - * The authorization key.␊ - */␊ - authorizationKey?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains ServiceProviderProperties in an ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitServiceProviderProperties7 {␊ - /**␊ - * The serviceProviderName.␊ - */␊ - serviceProviderName?: string␊ - /**␊ - * The peering location.␊ - */␊ - peeringLocation?: string␊ - /**␊ - * The BandwidthInMbps.␊ - */␊ - bandwidthInMbps?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings␊ - */␊ - export interface ExpressRouteCircuitsPeeringsChildResource7 {␊ - name: string␊ - type: "peerings"␊ - apiVersion: "2018-10-01"␊ - properties: (ExpressRouteCircuitPeeringPropertiesFormat8 | string)␊ - resources?: ExpressRouteCircuitsPeeringsConnectionsChildResource5[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings/connections␊ - */␊ - export interface ExpressRouteCircuitsPeeringsConnectionsChildResource5 {␊ - name: string␊ - type: "connections"␊ - apiVersion: "2018-10-01"␊ - properties: (ExpressRouteCircuitConnectionPropertiesFormat5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/authorizations␊ - */␊ - export interface ExpressRouteCircuitsAuthorizationsChildResource7 {␊ - name: string␊ - type: "authorizations"␊ - apiVersion: "2018-10-01"␊ - properties: (AuthorizationPropertiesFormat8 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections␊ - */␊ - export interface ExpressRouteCrossConnections5 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCrossConnections"␊ - apiVersion: "2018-10-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (ExpressRouteCrossConnectionProperties5 | string)␊ - resources?: ExpressRouteCrossConnectionsPeeringsChildResource5[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ExpressRouteCrossConnection.␊ - */␊ - export interface ExpressRouteCrossConnectionProperties5 {␊ - /**␊ - * The peering location of the ExpressRoute circuit.␊ - */␊ - peeringLocation?: string␊ - /**␊ - * The circuit bandwidth In Mbps.␊ - */␊ - bandwidthInMbps?: (number | string)␊ - /**␊ - * The ExpressRouteCircuit␊ - */␊ - expressRouteCircuit?: (ExpressRouteCircuitReference4 | string)␊ - /**␊ - * The provisioning state of the circuit in the connectivity provider system. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned'.␊ - */␊ - serviceProviderProvisioningState?: (("NotProvisioned" | "Provisioning" | "Provisioned" | "Deprovisioning") | string)␊ - /**␊ - * Additional read only notes set by the connectivity provider.␊ - */␊ - serviceProviderNotes?: string␊ - /**␊ - * The list of peerings.␊ - */␊ - peerings?: (ExpressRouteCrossConnectionPeering5[] | string)␊ - [k: string]: unknown␊ - }␊ - export interface ExpressRouteCircuitReference4 {␊ - /**␊ - * Corresponding Express Route Circuit Id.␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peering in an ExpressRoute Cross Connection resource.␊ - */␊ - export interface ExpressRouteCrossConnectionPeering5 {␊ - properties?: (ExpressRouteCrossConnectionPeeringProperties5 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - export interface ExpressRouteCrossConnectionPeeringProperties5 {␊ - /**␊ - * The peering type.␊ - */␊ - peeringType?: (("AzurePublicPeering" | "AzurePrivatePeering" | "MicrosoftPeering") | string)␊ - /**␊ - * The peering state.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * The peer ASN.␊ - */␊ - peerASN?: (number | string)␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The VLAN ID.␊ - */␊ - vlanId?: (number | string)␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig8 | string)␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - /**␊ - * Gets whether the provider or the customer last modified the peering.␊ - */␊ - lastModifiedBy?: string␊ - /**␊ - * The IPv6 peering configuration.␊ - */␊ - ipv6PeeringConfig?: (Ipv6ExpressRouteCircuitPeeringConfig5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections/peerings␊ - */␊ - export interface ExpressRouteCrossConnectionsPeeringsChildResource5 {␊ - name: string␊ - type: "peerings"␊ - apiVersion: "2018-10-01"␊ - properties: (ExpressRouteCrossConnectionPeeringProperties5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/publicIPAddresses␊ - */␊ - export interface PublicIPAddresses22 {␊ - name: string␊ - type: "Microsoft.Network/publicIPAddresses"␊ - apiVersion: "2018-10-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The public IP address SKU.␊ - */␊ - sku?: (PublicIPAddressSku10 | string)␊ - /**␊ - * Public IP address properties.␊ - */␊ - properties: (PublicIPAddressPropertiesFormat13 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a public IP address␊ - */␊ - export interface PublicIPAddressSku10 {␊ - /**␊ - * Name of a public IP address SKU.␊ - */␊ - name?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Public IP address properties.␊ - */␊ - export interface PublicIPAddressPropertiesFormat13 {␊ - /**␊ - * The public IP allocation method. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - publicIPAllocationMethod: (("Static" | "Dynamic") | string)␊ - /**␊ - * The public IP address version. Possible values are: 'IPv4' and 'IPv6'.␊ - */␊ - publicIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The FQDN of the DNS record associated with the public IP address.␊ - */␊ - dnsSettings?: (PublicIPAddressDnsSettings21 | string)␊ - /**␊ - * The list of tags associated with the public IP address.␊ - */␊ - ipTags?: (IpTag7[] | string)␊ - /**␊ - * The IP address associated with the public IP address resource.␊ - */␊ - ipAddress?: string␊ - /**␊ - * The Public IP Prefix this Public IP Address should be allocated from.␊ - */␊ - publicIPPrefix?: (SubResource20 | string)␊ - /**␊ - * The idle timeout of the public IP address.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * The resource GUID property of the public IP resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains FQDN of the DNS record associated with the public IP address␊ - */␊ - export interface PublicIPAddressDnsSettings21 {␊ - /**␊ - * Gets or sets the Domain name label.The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.␊ - */␊ - domainNameLabel: string␊ - /**␊ - * Gets the FQDN, Fully qualified domain name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone.␊ - */␊ - fqdn?: string␊ - /**␊ - * Gets or Sets the Reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN. ␊ - */␊ - reverseFqdn?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains the IpTag associated with the object␊ - */␊ - export interface IpTag7 {␊ - /**␊ - * Gets or sets the ipTag type: Example FirstPartyUsage.␊ - */␊ - ipTagType?: string␊ - /**␊ - * Gets or sets value of the IpTag associated with the public IP. Example SQL, Storage etc␊ - */␊ - tag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks␊ - */␊ - export interface VirtualNetworks22 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks"␊ - apiVersion: "2018-10-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network.␊ - */␊ - properties: (VirtualNetworkPropertiesFormat14 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: (VirtualNetworksVirtualNetworkPeeringsChildResource11 | VirtualNetworksSubnetsChildResource14)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the virtual network.␊ - */␊ - export interface VirtualNetworkPropertiesFormat14 {␊ - /**␊ - * The AddressSpace that contains an array of IP address ranges that can be used by subnets.␊ - */␊ - addressSpace: (AddressSpace22 | string)␊ - /**␊ - * The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network.␊ - */␊ - dhcpOptions?: (DhcpOptions22 | string)␊ - /**␊ - * A list of subnets in a Virtual Network.␊ - */␊ - subnets?: (Subnet24[] | string)␊ - /**␊ - * A list of peerings in a Virtual Network.␊ - */␊ - virtualNetworkPeerings?: (VirtualNetworkPeering19[] | string)␊ - /**␊ - * The resourceGuid property of the Virtual Network resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - /**␊ - * Indicates if DDoS protection is enabled for all the protected resources in the virtual network. It requires a DDoS protection plan associated with the resource.␊ - */␊ - enableDdosProtection?: (boolean | string)␊ - /**␊ - * Indicates if VM protection is enabled for all the subnets in the virtual network.␊ - */␊ - enableVmProtection?: (boolean | string)␊ - /**␊ - * The DDoS protection plan associated with the virtual network.␊ - */␊ - ddosProtectionPlan?: (SubResource20 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.␊ - */␊ - export interface AddressSpace22 {␊ - /**␊ - * A list of address blocks reserved for this virtual network in CIDR notation.␊ - */␊ - addressPrefixes: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DhcpOptions contains an array of DNS servers available to VMs deployed in the virtual network. Standard DHCP option for a subnet overrides VNET DHCP options.␊ - */␊ - export interface DhcpOptions22 {␊ - /**␊ - * The list of DNS servers IP addresses.␊ - */␊ - dnsServers: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Subnet in a virtual network resource.␊ - */␊ - export interface Subnet24 {␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties?: (SubnetPropertiesFormat14 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the subnet.␊ - */␊ - export interface SubnetPropertiesFormat14 {␊ - /**␊ - * The address prefix for the subnet.␊ - */␊ - addressPrefix: string␊ - /**␊ - * List of address prefixes for the subnet.␊ - */␊ - addressPrefixes?: (string[] | string)␊ - /**␊ - * The reference of the NetworkSecurityGroup resource.␊ - */␊ - networkSecurityGroup?: (SubResource20 | string)␊ - /**␊ - * The reference of the RouteTable resource.␊ - */␊ - routeTable?: (SubResource20 | string)␊ - /**␊ - * An array of service endpoints.␊ - */␊ - serviceEndpoints?: (ServiceEndpointPropertiesFormat10[] | string)␊ - /**␊ - * An array of service endpoint policies.␊ - */␊ - serviceEndpointPolicies?: (SubResource20[] | string)␊ - /**␊ - * Gets an array of references to the external resources using subnet.␊ - */␊ - resourceNavigationLinks?: (ResourceNavigationLink11[] | string)␊ - /**␊ - * Gets an array of references to services injecting into this subnet.␊ - */␊ - serviceAssociationLinks?: (ServiceAssociationLink1[] | string)␊ - /**␊ - * Gets an array of references to the delegations on the subnet.␊ - */␊ - delegations?: (Delegation1[] | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The service endpoint properties.␊ - */␊ - export interface ServiceEndpointPropertiesFormat10 {␊ - /**␊ - * The type of the endpoint service.␊ - */␊ - service?: string␊ - /**␊ - * A list of locations.␊ - */␊ - locations?: (string[] | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ResourceNavigationLink resource.␊ - */␊ - export interface ResourceNavigationLink11 {␊ - /**␊ - * Resource navigation link properties format.␊ - */␊ - properties?: (ResourceNavigationLinkFormat11 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ResourceNavigationLink.␊ - */␊ - export interface ResourceNavigationLinkFormat11 {␊ - /**␊ - * Resource type of the linked resource.␊ - */␊ - linkedResourceType?: string␊ - /**␊ - * Link to the external resource␊ - */␊ - link?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ServiceAssociationLink resource.␊ - */␊ - export interface ServiceAssociationLink1 {␊ - /**␊ - * Resource navigation link properties format.␊ - */␊ - properties?: (ServiceAssociationLinkPropertiesFormat1 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ServiceAssociationLink.␊ - */␊ - export interface ServiceAssociationLinkPropertiesFormat1 {␊ - /**␊ - * Resource type of the linked resource.␊ - */␊ - linkedResourceType?: string␊ - /**␊ - * Link to the external resource.␊ - */␊ - link?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Details the service to which the subnet is delegated.␊ - */␊ - export interface Delegation1 {␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties?: (ServiceDelegationPropertiesFormat1 | string)␊ - /**␊ - * The name of the resource that is unique within a subnet. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a service delegation.␊ - */␊ - export interface ServiceDelegationPropertiesFormat1 {␊ - /**␊ - * The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers)␊ - */␊ - serviceName?: string␊ - /**␊ - * Describes the actions permitted to the service upon delegation␊ - */␊ - actions?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peerings in a virtual network resource.␊ - */␊ - export interface VirtualNetworkPeering19 {␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties?: (VirtualNetworkPeeringPropertiesFormat11 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - export interface VirtualNetworkPeeringPropertiesFormat11 {␊ - /**␊ - * Whether the VMs in the linked virtual network space would be able to access all the VMs in local Virtual network space.␊ - */␊ - allowVirtualNetworkAccess?: (boolean | string)␊ - /**␊ - * Whether the forwarded traffic from the VMs in the remote virtual network will be allowed/disallowed.␊ - */␊ - allowForwardedTraffic?: (boolean | string)␊ - /**␊ - * If gateway links can be used in remote virtual networking to link to this virtual network.␊ - */␊ - allowGatewayTransit?: (boolean | string)␊ - /**␊ - * If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway.␊ - */␊ - useRemoteGateways?: (boolean | string)␊ - /**␊ - * The reference of the remote virtual network. The remote virtual network can be in the same or different region (preview). See here to register for the preview and learn more (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering).␊ - */␊ - remoteVirtualNetwork: (SubResource20 | string)␊ - /**␊ - * The reference of the remote virtual network address space.␊ - */␊ - remoteAddressSpace?: (AddressSpace22 | string)␊ - /**␊ - * The status of the virtual network peering. Possible values are 'Initiated', 'Connected', and 'Disconnected'.␊ - */␊ - peeringState?: (("Initiated" | "Connected" | "Disconnected") | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/virtualNetworkPeerings␊ - */␊ - export interface VirtualNetworksVirtualNetworkPeeringsChildResource11 {␊ - name: string␊ - type: "virtualNetworkPeerings"␊ - apiVersion: "2018-10-01"␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties: (VirtualNetworkPeeringPropertiesFormat11 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnetsChildResource14 {␊ - name: string␊ - type: "subnets"␊ - apiVersion: "2018-10-01"␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties: (SubnetPropertiesFormat14 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers␊ - */␊ - export interface LoadBalancers22 {␊ - name: string␊ - type: "Microsoft.Network/loadBalancers"␊ - apiVersion: "2018-10-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The load balancer SKU.␊ - */␊ - sku?: (LoadBalancerSku10 | string)␊ - /**␊ - * Properties of load balancer.␊ - */␊ - properties: (LoadBalancerPropertiesFormat14 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: LoadBalancersInboundNatRulesChildResource10[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a load balancer␊ - */␊ - export interface LoadBalancerSku10 {␊ - /**␊ - * Name of a load balancer SKU.␊ - */␊ - name?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer.␊ - */␊ - export interface LoadBalancerPropertiesFormat14 {␊ - /**␊ - * Object representing the frontend IPs to be used for the load balancer␊ - */␊ - frontendIPConfigurations?: (FrontendIPConfiguration13[] | string)␊ - /**␊ - * Collection of backend address pools used by a load balancer␊ - */␊ - backendAddressPools?: (BackendAddressPool14[] | string)␊ - /**␊ - * Object collection representing the load balancing rules Gets the provisioning ␊ - */␊ - loadBalancingRules?: (LoadBalancingRule14[] | string)␊ - /**␊ - * Collection of probe objects used in the load balancer␊ - */␊ - probes?: (Probe14[] | string)␊ - /**␊ - * Collection of inbound NAT Rules used by a load balancer. Defining inbound NAT rules on your load balancer is mutually exclusive with defining an inbound NAT pool. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an Inbound NAT pool. They have to reference individual inbound NAT rules.␊ - */␊ - inboundNatRules?: (InboundNatRule15[] | string)␊ - /**␊ - * Defines an external port range for inbound NAT to a single backend port on NICs associated with a load balancer. Inbound NAT rules are created automatically for each NIC associated with the Load Balancer using an external port from this range. Defining an Inbound NAT pool on your Load Balancer is mutually exclusive with defining inbound Nat rules. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an inbound NAT pool. They have to reference individual inbound NAT rules.␊ - */␊ - inboundNatPools?: (InboundNatPool15[] | string)␊ - /**␊ - * The outbound rules.␊ - */␊ - outboundRules?: (OutboundRule2[] | string)␊ - /**␊ - * The resource GUID property of the load balancer resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP address of the load balancer.␊ - */␊ - export interface FrontendIPConfiguration13 {␊ - /**␊ - * Properties of the load balancer probe.␊ - */␊ - properties?: (FrontendIPConfigurationPropertiesFormat13 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP Configuration of the load balancer.␊ - */␊ - export interface FrontendIPConfigurationPropertiesFormat13 {␊ - /**␊ - * The private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The Private IP allocation method. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * The reference of the subnet resource.␊ - */␊ - subnet?: (SubResource20 | string)␊ - /**␊ - * The reference of the Public IP resource.␊ - */␊ - publicIPAddress?: (SubResource20 | string)␊ - /**␊ - * The reference of the Public IP Prefix resource.␊ - */␊ - publicIPPrefix?: (SubResource20 | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Pool of backend IP addresses.␊ - */␊ - export interface BackendAddressPool14 {␊ - /**␊ - * Properties of load balancer backend address pool.␊ - */␊ - properties?: (BackendAddressPoolPropertiesFormat14 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the backend address pool.␊ - */␊ - export interface BackendAddressPoolPropertiesFormat14 {␊ - /**␊ - * Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A load balancing rule for a load balancer.␊ - */␊ - export interface LoadBalancingRule14 {␊ - /**␊ - * Properties of load balancer load balancing rule.␊ - */␊ - properties?: (LoadBalancingRulePropertiesFormat14 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer.␊ - */␊ - export interface LoadBalancingRulePropertiesFormat14 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource20 | string)␊ - /**␊ - * A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs.␊ - */␊ - backendAddressPool?: (SubResource20 | string)␊ - /**␊ - * The reference of the load balancer probe used by the load balancing rule.␊ - */␊ - probe?: (SubResource20 | string)␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'.␊ - */␊ - loadDistribution?: (("Default" | "SourceIP" | "SourceIPProtocol") | string)␊ - /**␊ - * The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 0 and 65534. Note that value 0 enables "Any Port"␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port"␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - /**␊ - * Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule.␊ - */␊ - disableOutboundSnat?: (boolean | string)␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A load balancer probe.␊ - */␊ - export interface Probe14 {␊ - /**␊ - * Properties of load balancer probe.␊ - */␊ - properties?: (ProbePropertiesFormat14 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Load balancer probe resource.␊ - */␊ - export interface ProbePropertiesFormat14 {␊ - /**␊ - * The protocol of the end point. Possible values are: 'Http', 'Tcp', or 'Https'. If 'Tcp' is specified, a received ACK is required for the probe to be successful. If 'Http' or 'Https' is specified, a 200 OK response from the specifies URI is required for the probe to be successful.␊ - */␊ - protocol: (("Http" | "Tcp" | "Https") | string)␊ - /**␊ - * The port for communicating the probe. Possible values range from 1 to 65535, inclusive.␊ - */␊ - port: (number | string)␊ - /**␊ - * The interval, in seconds, for how frequently to probe the endpoint for health status. Typically, the interval is slightly less than half the allocated timeout period (in seconds) which allows two full probes before taking the instance out of rotation. The default value is 15, the minimum value is 5.␊ - */␊ - intervalInSeconds?: (number | string)␊ - /**␊ - * The number of probes where if no response, will result in stopping further traffic from being delivered to the endpoint. This values allows endpoints to be taken out of rotation faster or slower than the typical times used in Azure.␊ - */␊ - numberOfProbes: (number | string)␊ - /**␊ - * The URI used for requesting health status from the VM. Path is required if a protocol is set to http. Otherwise, it is not allowed. There is no default value.␊ - */␊ - requestPath?: string␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT rule of the load balancer.␊ - */␊ - export interface InboundNatRule15 {␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties?: (InboundNatRulePropertiesFormat14 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the inbound NAT rule.␊ - */␊ - export interface InboundNatRulePropertiesFormat14 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource20 | string)␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values range from 1 to 65534.␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * The port used for the internal endpoint. Acceptable values range from 1 to 65535.␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT pool of the load balancer.␊ - */␊ - export interface InboundNatPool15 {␊ - /**␊ - * Properties of load balancer inbound nat pool.␊ - */␊ - properties?: (InboundNatPoolPropertiesFormat14 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Inbound NAT pool.␊ - */␊ - export interface InboundNatPoolPropertiesFormat14 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource20 | string)␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65534.␊ - */␊ - frontendPortRangeStart: (number | string)␊ - /**␊ - * The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65535.␊ - */␊ - frontendPortRangeEnd: (number | string)␊ - /**␊ - * The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound pool of the load balancer.␊ - */␊ - export interface OutboundRule2 {␊ - /**␊ - * Properties of load balancer outbound rule.␊ - */␊ - properties?: (OutboundRulePropertiesFormat2 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound pool of the load balancer.␊ - */␊ - export interface OutboundRulePropertiesFormat2 {␊ - /**␊ - * The number of outbound ports to be used for NAT.␊ - */␊ - allocatedOutboundPorts?: (number | string)␊ - /**␊ - * The Frontend IP addresses of the load balancer.␊ - */␊ - frontendIPConfigurations: (SubResource20[] | string)␊ - /**␊ - * A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs.␊ - */␊ - backendAddressPool: (SubResource20 | string)␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - /**␊ - * Protocol - TCP, UDP or All.␊ - */␊ - protocol: (("Tcp" | "Udp" | "All") | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - /**␊ - * The timeout for the TCP idle connection␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers/inboundNatRules␊ - */␊ - export interface LoadBalancersInboundNatRulesChildResource10 {␊ - name: string␊ - type: "inboundNatRules"␊ - apiVersion: "2018-10-01"␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties: (InboundNatRulePropertiesFormat14 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups␊ - */␊ - export interface NetworkSecurityGroups22 {␊ - name: string␊ - type: "Microsoft.Network/networkSecurityGroups"␊ - apiVersion: "2018-10-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network security group␊ - */␊ - properties: (NetworkSecurityGroupPropertiesFormat14 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: NetworkSecurityGroupsSecurityRulesChildResource14[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network Security Group resource.␊ - */␊ - export interface NetworkSecurityGroupPropertiesFormat14 {␊ - /**␊ - * A collection of security rules of the network security group.␊ - */␊ - securityRules?: (SecurityRule14[] | string)␊ - /**␊ - * The default security rules of network security group.␊ - */␊ - defaultSecurityRules?: (SecurityRule14[] | string)␊ - /**␊ - * The resource GUID property of the network security group resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network security rule.␊ - */␊ - export interface SecurityRule14 {␊ - /**␊ - * Properties of the security rule␊ - */␊ - properties?: (SecurityRulePropertiesFormat14 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Security rule resource.␊ - */␊ - export interface SecurityRulePropertiesFormat14 {␊ - /**␊ - * A description for this rule. Restricted to 140 chars.␊ - */␊ - description?: string␊ - /**␊ - * Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'.␊ - */␊ - protocol: (("Tcp" | "Udp" | "*") | string)␊ - /**␊ - * The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports.␊ - */␊ - sourcePortRange?: string␊ - /**␊ - * The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports.␊ - */␊ - destinationPortRange?: string␊ - /**␊ - * The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. ␊ - */␊ - sourceAddressPrefix?: string␊ - /**␊ - * The CIDR or source IP ranges.␊ - */␊ - sourceAddressPrefixes?: (string[] | string)␊ - /**␊ - * The application security group specified as source.␊ - */␊ - sourceApplicationSecurityGroups?: (SubResource20[] | string)␊ - /**␊ - * The destination address prefix. CIDR or destination IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used.␊ - */␊ - destinationAddressPrefix?: string␊ - /**␊ - * The destination address prefixes. CIDR or destination IP ranges.␊ - */␊ - destinationAddressPrefixes?: (string[] | string)␊ - /**␊ - * The application security group specified as destination.␊ - */␊ - destinationApplicationSecurityGroups?: (SubResource20[] | string)␊ - /**␊ - * The source port ranges.␊ - */␊ - sourcePortRanges?: (string[] | string)␊ - /**␊ - * The destination port ranges.␊ - */␊ - destinationPortRanges?: (string[] | string)␊ - /**␊ - * The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'.␊ - */␊ - access: (("Allow" | "Deny") | string)␊ - /**␊ - * The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.␊ - */␊ - priority: (number | string)␊ - /**␊ - * The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'.␊ - */␊ - direction: (("Inbound" | "Outbound") | string)␊ - /**␊ - * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRulesChildResource14 {␊ - name: string␊ - type: "securityRules"␊ - apiVersion: "2018-10-01"␊ - /**␊ - * Properties of the security rule␊ - */␊ - properties: (SecurityRulePropertiesFormat14 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces␊ - */␊ - export interface NetworkInterfaces23 {␊ - name: string␊ - type: "Microsoft.Network/networkInterfaces"␊ - apiVersion: "2018-10-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network interface.␊ - */␊ - properties: (NetworkInterfacePropertiesFormat14 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: NetworkInterfacesTapConfigurationsChildResource1[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NetworkInterface properties. ␊ - */␊ - export interface NetworkInterfacePropertiesFormat14 {␊ - /**␊ - * The reference of the NetworkSecurityGroup resource.␊ - */␊ - networkSecurityGroup?: (SubResource20 | string)␊ - /**␊ - * A list of IPConfigurations of the network interface.␊ - */␊ - ipConfigurations: (NetworkInterfaceIPConfiguration13[] | string)␊ - /**␊ - * A list of TapConfigurations of the network interface.␊ - */␊ - tapConfigurations?: (NetworkInterfaceTapConfiguration1[] | string)␊ - /**␊ - * The DNS settings in network interface.␊ - */␊ - dnsSettings?: (NetworkInterfaceDnsSettings22 | string)␊ - /**␊ - * The MAC address of the network interface.␊ - */␊ - macAddress?: string␊ - /**␊ - * Gets whether this is a primary network interface on a virtual machine.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * If the network interface is accelerated networking enabled.␊ - */␊ - enableAcceleratedNetworking?: (boolean | string)␊ - /**␊ - * Indicates whether IP forwarding is enabled on this network interface.␊ - */␊ - enableIPForwarding?: (boolean | string)␊ - /**␊ - * The resource GUID property of the network interface resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IPConfiguration in a network interface.␊ - */␊ - export interface NetworkInterfaceIPConfiguration13 {␊ - /**␊ - * Network interface IP configuration properties.␊ - */␊ - properties?: (NetworkInterfaceIPConfigurationPropertiesFormat13 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration.␊ - */␊ - export interface NetworkInterfaceIPConfigurationPropertiesFormat13 {␊ - /**␊ - * The reference to Virtual Network Taps.␊ - */␊ - virtualNetworkTaps?: (SubResource20[] | string)␊ - /**␊ - * The reference of ApplicationGatewayBackendAddressPool resource.␊ - */␊ - applicationGatewayBackendAddressPools?: (SubResource20[] | string)␊ - /**␊ - * The reference of LoadBalancerBackendAddressPool resource.␊ - */␊ - loadBalancerBackendAddressPools?: (SubResource20[] | string)␊ - /**␊ - * A list of references of LoadBalancerInboundNatRules.␊ - */␊ - loadBalancerInboundNatRules?: (SubResource20[] | string)␊ - /**␊ - * Private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * Defines how a private IP address is assigned. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Available from Api-Version 2016-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.␊ - */␊ - privateIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * Subnet bound to the IP configuration.␊ - */␊ - subnet?: (SubResource20 | string)␊ - /**␊ - * Gets whether this is a primary customer address on the network interface.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * Public IP address bound to the IP configuration.␊ - */␊ - publicIPAddress?: (SubResource20 | string)␊ - /**␊ - * Application security groups in which the IP configuration is included.␊ - */␊ - applicationSecurityGroups?: (SubResource20[] | string)␊ - /**␊ - * The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Tap configuration in a Network Interface␊ - */␊ - export interface NetworkInterfaceTapConfiguration1 {␊ - /**␊ - * Properties of the Virtual Network Tap configuration␊ - */␊ - properties?: (NetworkInterfaceTapConfigurationPropertiesFormat1 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Virtual Network Tap configuration.␊ - */␊ - export interface NetworkInterfaceTapConfigurationPropertiesFormat1 {␊ - /**␊ - * The reference of the Virtual Network Tap resource.␊ - */␊ - virtualNetworkTap?: (SubResource20 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DNS settings of a network interface.␊ - */␊ - export interface NetworkInterfaceDnsSettings22 {␊ - /**␊ - * List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only value in dnsServers collection.␊ - */␊ - dnsServers?: (string[] | string)␊ - /**␊ - * If the VM that uses this NIC is part of an Availability Set, then this list will have the union of all DNS servers from all NICs that are part of the Availability Set. This property is what is configured on each of those VMs.␊ - */␊ - appliedDnsServers?: (string[] | string)␊ - /**␊ - * Relative DNS name for this NIC used for internal communications between VMs in the same virtual network.␊ - */␊ - internalDnsNameLabel?: string␊ - /**␊ - * Fully qualified DNS name supporting internal communications between VMs in the same virtual network.␊ - */␊ - internalFqdn?: string␊ - /**␊ - * Even if internalDnsNameLabel is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internalDomainNameSuffix.␊ - */␊ - internalDomainNameSuffix?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces/tapConfigurations␊ - */␊ - export interface NetworkInterfacesTapConfigurationsChildResource1 {␊ - name: string␊ - type: "tapConfigurations"␊ - apiVersion: "2018-10-01"␊ - /**␊ - * Properties of the Virtual Network Tap configuration␊ - */␊ - properties: (NetworkInterfaceTapConfigurationPropertiesFormat1 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables␊ - */␊ - export interface RouteTables22 {␊ - name: string␊ - type: "Microsoft.Network/routeTables"␊ - apiVersion: "2018-10-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the route table.␊ - */␊ - properties: (RouteTablePropertiesFormat14 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: RouteTablesRoutesChildResource14[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Table resource␊ - */␊ - export interface RouteTablePropertiesFormat14 {␊ - /**␊ - * Collection of routes contained within a route table.␊ - */␊ - routes?: (Route14[] | string)␊ - /**␊ - * Gets or sets whether to disable the routes learned by BGP on that route table. True means disable.␊ - */␊ - disableBgpRoutePropagation?: (boolean | string)␊ - /**␊ - * The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource␊ - */␊ - export interface Route14 {␊ - /**␊ - * Properties of the route.␊ - */␊ - properties?: (RoutePropertiesFormat14 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource␊ - */␊ - export interface RoutePropertiesFormat14 {␊ - /**␊ - * The destination CIDR to which the route applies.␊ - */␊ - addressPrefix: string␊ - /**␊ - * The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'.␊ - */␊ - nextHopType: (("VirtualNetworkGateway" | "VnetLocal" | "Internet" | "VirtualAppliance" | "None") | string)␊ - /**␊ - * The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.␊ - */␊ - nextHopIpAddress?: string␊ - /**␊ - * The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutesChildResource14 {␊ - name: string␊ - type: "routes"␊ - apiVersion: "2018-10-01"␊ - /**␊ - * Properties of the route.␊ - */␊ - properties: (RoutePropertiesFormat14 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/applicationGateways␊ - */␊ - export interface ApplicationGateways13 {␊ - name: string␊ - type: "Microsoft.Network/applicationGateways"␊ - apiVersion: "2018-10-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (ApplicationGatewayPropertiesFormat13 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * A list of availability zones denoting where the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - /**␊ - * The identity of the application gateway, if configured.␊ - */␊ - identity?: (ManagedServiceIdentity | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application gateway.␊ - */␊ - export interface ApplicationGatewayPropertiesFormat13 {␊ - /**␊ - * SKU of the application gateway resource.␊ - */␊ - sku?: (ApplicationGatewaySku13 | string)␊ - /**␊ - * SSL policy of the application gateway resource.␊ - */␊ - sslPolicy?: (ApplicationGatewaySslPolicy10 | string)␊ - /**␊ - * Subnets of application the gateway resource.␊ - */␊ - gatewayIPConfigurations?: (ApplicationGatewayIPConfiguration13[] | string)␊ - /**␊ - * Authentication certificates of the application gateway resource.␊ - */␊ - authenticationCertificates?: (ApplicationGatewayAuthenticationCertificate10[] | string)␊ - /**␊ - * Trusted Root certificates of the application gateway resource.␊ - */␊ - trustedRootCertificates?: (ApplicationGatewayTrustedRootCertificate1[] | string)␊ - /**␊ - * SSL certificates of the application gateway resource.␊ - */␊ - sslCertificates?: (ApplicationGatewaySslCertificate13[] | string)␊ - /**␊ - * Frontend IP addresses of the application gateway resource.␊ - */␊ - frontendIPConfigurations?: (ApplicationGatewayFrontendIPConfiguration13[] | string)␊ - /**␊ - * Frontend ports of the application gateway resource.␊ - */␊ - frontendPorts?: (ApplicationGatewayFrontendPort13[] | string)␊ - /**␊ - * Probes of the application gateway resource.␊ - */␊ - probes?: (ApplicationGatewayProbe12[] | string)␊ - /**␊ - * Backend address pool of the application gateway resource.␊ - */␊ - backendAddressPools?: (ApplicationGatewayBackendAddressPool13[] | string)␊ - /**␊ - * Backend http settings of the application gateway resource.␊ - */␊ - backendHttpSettingsCollection?: (ApplicationGatewayBackendHttpSettings13[] | string)␊ - /**␊ - * Http listeners of the application gateway resource.␊ - */␊ - httpListeners?: (ApplicationGatewayHttpListener13[] | string)␊ - /**␊ - * URL path map of the application gateway resource.␊ - */␊ - urlPathMaps?: (ApplicationGatewayUrlPathMap12[] | string)␊ - /**␊ - * Request routing rules of the application gateway resource.␊ - */␊ - requestRoutingRules?: (ApplicationGatewayRequestRoutingRule13[] | string)␊ - /**␊ - * Rewrite rules for the application gateway resource.␊ - */␊ - rewriteRuleSets?: (ApplicationGatewayRewriteRuleSet[] | string)␊ - /**␊ - * Redirect configurations of the application gateway resource.␊ - */␊ - redirectConfigurations?: (ApplicationGatewayRedirectConfiguration10[] | string)␊ - /**␊ - * Web application firewall configuration.␊ - */␊ - webApplicationFirewallConfiguration?: (ApplicationGatewayWebApplicationFirewallConfiguration10 | string)␊ - /**␊ - * Whether HTTP2 is enabled on the application gateway resource.␊ - */␊ - enableHttp2?: (boolean | string)␊ - /**␊ - * Whether FIPS is enabled on the application gateway resource.␊ - */␊ - enableFips?: (boolean | string)␊ - /**␊ - * Autoscale Configuration.␊ - */␊ - autoscaleConfiguration?: (ApplicationGatewayAutoscaleConfiguration4 | string)␊ - /**␊ - * Resource GUID property of the application gateway resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - /**␊ - * Custom error configurations of the application gateway resource.␊ - */␊ - customErrorConfigurations?: (ApplicationGatewayCustomError1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of an application gateway␊ - */␊ - export interface ApplicationGatewaySku13 {␊ - /**␊ - * Name of an application gateway SKU.␊ - */␊ - name?: (("Standard_Small" | "Standard_Medium" | "Standard_Large" | "WAF_Medium" | "WAF_Large" | "Standard_v2" | "WAF_v2") | string)␊ - /**␊ - * Tier of an application gateway.␊ - */␊ - tier?: (("Standard" | "WAF" | "Standard_v2" | "WAF_v2") | string)␊ - /**␊ - * Capacity (instance count) of an application gateway.␊ - */␊ - capacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application Gateway Ssl policy.␊ - */␊ - export interface ApplicationGatewaySslPolicy10 {␊ - /**␊ - * Ssl protocols to be disabled on application gateway.␊ - */␊ - disabledSslProtocols?: (("TLSv1_0" | "TLSv1_1" | "TLSv1_2")[] | string)␊ - /**␊ - * Type of Ssl Policy.␊ - */␊ - policyType?: (("Predefined" | "Custom") | string)␊ - /**␊ - * Name of Ssl predefined policy.␊ - */␊ - policyName?: (("AppGwSslPolicy20150501" | "AppGwSslPolicy20170401" | "AppGwSslPolicy20170401S") | string)␊ - /**␊ - * Ssl cipher suites to be enabled in the specified order to application gateway.␊ - */␊ - cipherSuites?: (("TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384" | "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256" | "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA" | "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA" | "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384" | "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256" | "TLS_DHE_RSA_WITH_AES_256_CBC_SHA" | "TLS_DHE_RSA_WITH_AES_128_CBC_SHA" | "TLS_RSA_WITH_AES_256_GCM_SHA384" | "TLS_RSA_WITH_AES_128_GCM_SHA256" | "TLS_RSA_WITH_AES_256_CBC_SHA256" | "TLS_RSA_WITH_AES_128_CBC_SHA256" | "TLS_RSA_WITH_AES_256_CBC_SHA" | "TLS_RSA_WITH_AES_128_CBC_SHA" | "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384" | "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256" | "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384" | "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256" | "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA" | "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA" | "TLS_DHE_DSS_WITH_AES_256_CBC_SHA256" | "TLS_DHE_DSS_WITH_AES_128_CBC_SHA256" | "TLS_DHE_DSS_WITH_AES_256_CBC_SHA" | "TLS_DHE_DSS_WITH_AES_128_CBC_SHA" | "TLS_RSA_WITH_3DES_EDE_CBC_SHA" | "TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA" | "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256" | "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384")[] | string)␊ - /**␊ - * Minimum version of Ssl protocol to be supported on application gateway.␊ - */␊ - minProtocolVersion?: (("TLSv1_0" | "TLSv1_1" | "TLSv1_2") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed.␊ - */␊ - export interface ApplicationGatewayIPConfiguration13 {␊ - properties?: (ApplicationGatewayIPConfigurationPropertiesFormat13 | string)␊ - /**␊ - * Name of the IP configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayIPConfigurationPropertiesFormat13 {␊ - /**␊ - * Reference of the subnet resource. A subnet from where application gateway gets its private address.␊ - */␊ - subnet?: (SubResource20 | string)␊ - /**␊ - * Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authentication certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewayAuthenticationCertificate10 {␊ - properties?: (ApplicationGatewayAuthenticationCertificatePropertiesFormat10 | string)␊ - /**␊ - * Name of the authentication certificate that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authentication certificates properties of an application gateway.␊ - */␊ - export interface ApplicationGatewayAuthenticationCertificatePropertiesFormat10 {␊ - /**␊ - * Certificate public data.␊ - */␊ - data?: string␊ - /**␊ - * Provisioning state of the authentication certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trusted Root certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewayTrustedRootCertificate1 {␊ - properties?: (ApplicationGatewayTrustedRootCertificatePropertiesFormat1 | string)␊ - /**␊ - * Name of the trusted root certificate that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trusted Root certificates properties of an application gateway.␊ - */␊ - export interface ApplicationGatewayTrustedRootCertificatePropertiesFormat1 {␊ - /**␊ - * Certificate public data.␊ - */␊ - data?: string␊ - /**␊ - * Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault.␊ - */␊ - keyVaultSecretId?: string␊ - /**␊ - * Provisioning state of the trusted root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSL certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewaySslCertificate13 {␊ - properties?: (ApplicationGatewaySslCertificatePropertiesFormat13 | string)␊ - /**␊ - * Name of the SSL certificate that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewaySslCertificatePropertiesFormat13 {␊ - /**␊ - * Base-64 encoded pfx certificate. Only applicable in PUT Request.␊ - */␊ - data?: string␊ - /**␊ - * Password for the pfx file specified in data. Only applicable in PUT request.␊ - */␊ - password?: string␊ - /**␊ - * Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request.␊ - */␊ - publicCertData?: string␊ - /**␊ - * Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault.␊ - */␊ - keyVaultSecretId?: string␊ - /**␊ - * Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendIPConfiguration13 {␊ - properties?: (ApplicationGatewayFrontendIPConfigurationPropertiesFormat13 | string)␊ - /**␊ - * Name of the frontend IP configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendIPConfigurationPropertiesFormat13 {␊ - /**␊ - * PrivateIPAddress of the network interface IP Configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * PrivateIP allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Reference of the subnet resource.␊ - */␊ - subnet?: (SubResource20 | string)␊ - /**␊ - * Reference of the PublicIP resource.␊ - */␊ - publicIPAddress?: (SubResource20 | string)␊ - /**␊ - * Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend port of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendPort13 {␊ - properties?: (ApplicationGatewayFrontendPortPropertiesFormat13 | string)␊ - /**␊ - * Name of the frontend port that is unique within an Application Gateway␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend port of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendPortPropertiesFormat13 {␊ - /**␊ - * Frontend port␊ - */␊ - port?: (number | string)␊ - /**␊ - * Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Probe of the application gateway.␊ - */␊ - export interface ApplicationGatewayProbe12 {␊ - properties?: (ApplicationGatewayProbePropertiesFormat12 | string)␊ - /**␊ - * Name of the probe that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of probe of an application gateway.␊ - */␊ - export interface ApplicationGatewayProbePropertiesFormat12 {␊ - /**␊ - * The protocol used for the probe. Possible values are 'Http' and 'Https'.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Host name to send the probe to.␊ - */␊ - host?: string␊ - /**␊ - * Relative path of probe. Valid path starts from '/'. Probe is sent to ://:␊ - */␊ - path?: string␊ - /**␊ - * The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - interval?: (number | string)␊ - /**␊ - * the probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - timeout?: (number | string)␊ - /**␊ - * The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20.␊ - */␊ - unhealthyThreshold?: (number | string)␊ - /**␊ - * Whether the host header should be picked from the backend http settings. Default value is false.␊ - */␊ - pickHostNameFromBackendHttpSettings?: (boolean | string)␊ - /**␊ - * Minimum number of servers that are always marked healthy. Default value is 0.␊ - */␊ - minServers?: (number | string)␊ - /**␊ - * Criterion for classifying a healthy probe response.␊ - */␊ - match?: (ApplicationGatewayProbeHealthResponseMatch10 | string)␊ - /**␊ - * Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application gateway probe health response match␊ - */␊ - export interface ApplicationGatewayProbeHealthResponseMatch10 {␊ - /**␊ - * Body that must be contained in the health response. Default value is empty.␊ - */␊ - body?: string␊ - /**␊ - * Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399.␊ - */␊ - statusCodes?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend Address Pool of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddressPool13 {␊ - properties?: (ApplicationGatewayBackendAddressPoolPropertiesFormat13 | string)␊ - /**␊ - * Name of the backend address pool that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend Address Pool of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddressPoolPropertiesFormat13 {␊ - /**␊ - * Collection of references to IPs defined in network interfaces.␊ - */␊ - backendIPConfigurations?: (SubResource20[] | string)␊ - /**␊ - * Backend addresses␊ - */␊ - backendAddresses?: (ApplicationGatewayBackendAddress13[] | string)␊ - /**␊ - * Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddress13 {␊ - /**␊ - * Fully qualified domain name (FQDN).␊ - */␊ - fqdn?: string␊ - /**␊ - * IP address␊ - */␊ - ipAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address pool settings of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendHttpSettings13 {␊ - properties?: (ApplicationGatewayBackendHttpSettingsPropertiesFormat13 | string)␊ - /**␊ - * Name of the backend http settings that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend address pool settings of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendHttpSettingsPropertiesFormat13 {␊ - /**␊ - * The destination port on the backend.␊ - */␊ - port?: (number | string)␊ - /**␊ - * The protocol used to communicate with the backend. Possible values are 'Http' and 'Https'.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Cookie based affinity.␊ - */␊ - cookieBasedAffinity?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Request timeout in seconds. Application Gateway will fail the request if response is not received within RequestTimeout. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - requestTimeout?: (number | string)␊ - /**␊ - * Probe resource of an application gateway.␊ - */␊ - probe?: (SubResource20 | string)␊ - /**␊ - * Array of references to application gateway authentication certificates.␊ - */␊ - authenticationCertificates?: (SubResource20[] | string)␊ - /**␊ - * Array of references to application gateway trusted root certificates.␊ - */␊ - trustedRootCertificates?: (SubResource20[] | string)␊ - /**␊ - * Connection draining of the backend http settings resource.␊ - */␊ - connectionDraining?: (ApplicationGatewayConnectionDraining10 | string)␊ - /**␊ - * Host header to be sent to the backend servers.␊ - */␊ - hostName?: string␊ - /**␊ - * Whether to pick host header should be picked from the host name of the backend server. Default value is false.␊ - */␊ - pickHostNameFromBackendAddress?: (boolean | string)␊ - /**␊ - * Cookie name to use for the affinity cookie.␊ - */␊ - affinityCookieName?: string␊ - /**␊ - * Whether the probe is enabled. Default value is false.␊ - */␊ - probeEnabled?: (boolean | string)␊ - /**␊ - * Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null.␊ - */␊ - path?: string␊ - /**␊ - * Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Connection draining allows open connections to a backend server to be active for a specified time after the backend server got removed from the configuration.␊ - */␊ - export interface ApplicationGatewayConnectionDraining10 {␊ - /**␊ - * Whether connection draining is enabled or not.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds.␊ - */␊ - drainTimeoutInSec: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http listener of an application gateway.␊ - */␊ - export interface ApplicationGatewayHttpListener13 {␊ - properties?: (ApplicationGatewayHttpListenerPropertiesFormat13 | string)␊ - /**␊ - * Name of the HTTP listener that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of HTTP listener of an application gateway.␊ - */␊ - export interface ApplicationGatewayHttpListenerPropertiesFormat13 {␊ - /**␊ - * Frontend IP configuration resource of an application gateway.␊ - */␊ - frontendIPConfiguration?: (SubResource20 | string)␊ - /**␊ - * Frontend port resource of an application gateway.␊ - */␊ - frontendPort?: (SubResource20 | string)␊ - /**␊ - * Protocol of the HTTP listener. Possible values are 'Http' and 'Https'.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Host name of HTTP listener.␊ - */␊ - hostName?: string␊ - /**␊ - * SSL certificate resource of an application gateway.␊ - */␊ - sslCertificate?: (SubResource20 | string)␊ - /**␊ - * Applicable only if protocol is https. Enables SNI for multi-hosting.␊ - */␊ - requireServerNameIndication?: (boolean | string)␊ - /**␊ - * Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - /**␊ - * Custom error configurations of the HTTP listener.␊ - */␊ - customErrorConfigurations?: (ApplicationGatewayCustomError1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Customer error of an application gateway.␊ - */␊ - export interface ApplicationGatewayCustomError1 {␊ - /**␊ - * Status code of the application gateway customer error.␊ - */␊ - statusCode?: (("HttpStatus403" | "HttpStatus502") | string)␊ - /**␊ - * Error page URL of the application gateway customer error.␊ - */␊ - customErrorPageUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * UrlPathMaps give a url path to the backend mapping information for PathBasedRouting.␊ - */␊ - export interface ApplicationGatewayUrlPathMap12 {␊ - properties?: (ApplicationGatewayUrlPathMapPropertiesFormat12 | string)␊ - /**␊ - * Name of the URL path map that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of UrlPathMap of the application gateway.␊ - */␊ - export interface ApplicationGatewayUrlPathMapPropertiesFormat12 {␊ - /**␊ - * Default backend address pool resource of URL path map.␊ - */␊ - defaultBackendAddressPool?: (SubResource20 | string)␊ - /**␊ - * Default backend http settings resource of URL path map.␊ - */␊ - defaultBackendHttpSettings?: (SubResource20 | string)␊ - /**␊ - * Default Rewrite rule set resource of URL path map.␊ - */␊ - defaultRewriteRuleSet?: (SubResource20 | string)␊ - /**␊ - * Default redirect configuration resource of URL path map.␊ - */␊ - defaultRedirectConfiguration?: (SubResource20 | string)␊ - /**␊ - * Path rule of URL path map resource.␊ - */␊ - pathRules?: (ApplicationGatewayPathRule12[] | string)␊ - /**␊ - * Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Path rule of URL path map of an application gateway.␊ - */␊ - export interface ApplicationGatewayPathRule12 {␊ - properties?: (ApplicationGatewayPathRulePropertiesFormat12 | string)␊ - /**␊ - * Name of the path rule that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of path rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayPathRulePropertiesFormat12 {␊ - /**␊ - * Path rules of URL path map.␊ - */␊ - paths?: (string[] | string)␊ - /**␊ - * Backend address pool resource of URL path map path rule.␊ - */␊ - backendAddressPool?: (SubResource20 | string)␊ - /**␊ - * Backend http settings resource of URL path map path rule.␊ - */␊ - backendHttpSettings?: (SubResource20 | string)␊ - /**␊ - * Redirect configuration resource of URL path map path rule.␊ - */␊ - redirectConfiguration?: (SubResource20 | string)␊ - /**␊ - * Rewrite rule set resource of URL path map path rule.␊ - */␊ - rewriteRuleSet?: (SubResource20 | string)␊ - /**␊ - * Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Request routing rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayRequestRoutingRule13 {␊ - properties?: (ApplicationGatewayRequestRoutingRulePropertiesFormat13 | string)␊ - /**␊ - * Name of the request routing rule that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of request routing rule of the application gateway.␊ - */␊ - export interface ApplicationGatewayRequestRoutingRulePropertiesFormat13 {␊ - /**␊ - * Rule type.␊ - */␊ - ruleType?: (("Basic" | "PathBasedRouting") | string)␊ - /**␊ - * Backend address pool resource of the application gateway. ␊ - */␊ - backendAddressPool?: (SubResource20 | string)␊ - /**␊ - * Backend http settings resource of the application gateway.␊ - */␊ - backendHttpSettings?: (SubResource20 | string)␊ - /**␊ - * Http listener resource of the application gateway. ␊ - */␊ - httpListener?: (SubResource20 | string)␊ - /**␊ - * URL path map resource of the application gateway.␊ - */␊ - urlPathMap?: (SubResource20 | string)␊ - /**␊ - * Rewrite Rule Set resource in Basic rule of the application gateway.␊ - */␊ - rewriteRuleSet?: (SubResource20 | string)␊ - /**␊ - * Redirect configuration resource of the application gateway.␊ - */␊ - redirectConfiguration?: (SubResource20 | string)␊ - /**␊ - * Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Rewrite rule set of an application gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRuleSet {␊ - properties?: (ApplicationGatewayRewriteRuleSetPropertiesFormat | string)␊ - /**␊ - * Name of the rewrite rule set that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of rewrite rule set of the application gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRuleSetPropertiesFormat {␊ - /**␊ - * Rewrite rules in the rewrite rule set.␊ - */␊ - rewriteRules?: (ApplicationGatewayRewriteRule[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Rewrite rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRule {␊ - /**␊ - * Name of the rewrite rule that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * Set of actions to be done as part of the rewrite Rule.␊ - */␊ - actionSet?: (ApplicationGatewayRewriteRuleActionSet | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Set of actions in the Rewrite Rule in Application Gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRuleActionSet {␊ - /**␊ - * Request Header Actions in the Action Set␊ - */␊ - requestHeaderConfigurations?: (ApplicationGatewayHeaderConfiguration[] | string)␊ - /**␊ - * Response Header Actions in the Action Set␊ - */␊ - responseHeaderConfigurations?: (ApplicationGatewayHeaderConfiguration[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Header configuration of the Actions set in Application Gateway.␊ - */␊ - export interface ApplicationGatewayHeaderConfiguration {␊ - /**␊ - * Header name of the header configuration␊ - */␊ - headerName?: string␊ - /**␊ - * Header value of the header configuration␊ - */␊ - headerValue?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Redirect configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayRedirectConfiguration10 {␊ - properties?: (ApplicationGatewayRedirectConfigurationPropertiesFormat10 | string)␊ - /**␊ - * Name of the redirect configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of redirect configuration of the application gateway.␊ - */␊ - export interface ApplicationGatewayRedirectConfigurationPropertiesFormat10 {␊ - /**␊ - * Supported http redirection types - Permanent, Temporary, Found, SeeOther.␊ - */␊ - redirectType?: (("Permanent" | "Found" | "SeeOther" | "Temporary") | string)␊ - /**␊ - * Reference to a listener to redirect the request to.␊ - */␊ - targetListener?: (SubResource20 | string)␊ - /**␊ - * Url to redirect the request to.␊ - */␊ - targetUrl?: string␊ - /**␊ - * Include path in the redirected url.␊ - */␊ - includePath?: (boolean | string)␊ - /**␊ - * Include query string in the redirected url.␊ - */␊ - includeQueryString?: (boolean | string)␊ - /**␊ - * Request routing specifying redirect configuration.␊ - */␊ - requestRoutingRules?: (SubResource20[] | string)␊ - /**␊ - * Url path maps specifying default redirect configuration.␊ - */␊ - urlPathMaps?: (SubResource20[] | string)␊ - /**␊ - * Path rules specifying redirect configuration.␊ - */␊ - pathRules?: (SubResource20[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application gateway web application firewall configuration.␊ - */␊ - export interface ApplicationGatewayWebApplicationFirewallConfiguration10 {␊ - /**␊ - * Whether the web application firewall is enabled or not.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * Web application firewall mode.␊ - */␊ - firewallMode: (("Detection" | "Prevention") | string)␊ - /**␊ - * The type of the web application firewall rule set. Possible values are: 'OWASP'.␊ - */␊ - ruleSetType: string␊ - /**␊ - * The version of the rule set type.␊ - */␊ - ruleSetVersion: string␊ - /**␊ - * The disabled rule groups.␊ - */␊ - disabledRuleGroups?: (ApplicationGatewayFirewallDisabledRuleGroup10[] | string)␊ - /**␊ - * Whether allow WAF to check request Body.␊ - */␊ - requestBodyCheck?: (boolean | string)␊ - /**␊ - * Maxium request body size for WAF.␊ - */␊ - maxRequestBodySize?: (number | string)␊ - /**␊ - * Maxium request body size in Kb for WAF.␊ - */␊ - maxRequestBodySizeInKb?: (number | string)␊ - /**␊ - * Maxium file upload size in Mb for WAF.␊ - */␊ - fileUploadLimitInMb?: (number | string)␊ - /**␊ - * The exclusion list.␊ - */␊ - exclusions?: (ApplicationGatewayFirewallExclusion1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allows to disable rules within a rule group or an entire rule group.␊ - */␊ - export interface ApplicationGatewayFirewallDisabledRuleGroup10 {␊ - /**␊ - * The name of the rule group that will be disabled.␊ - */␊ - ruleGroupName: string␊ - /**␊ - * The list of rules that will be disabled. If null, all rules of the rule group will be disabled.␊ - */␊ - rules?: (number[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allow to exclude some variable satisfy the condition for the WAF check␊ - */␊ - export interface ApplicationGatewayFirewallExclusion1 {␊ - /**␊ - * The variable to be excluded.␊ - */␊ - matchVariable: string␊ - /**␊ - * When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to.␊ - */␊ - selectorMatchOperator: string␊ - /**␊ - * When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to.␊ - */␊ - selector: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application Gateway autoscale configuration.␊ - */␊ - export interface ApplicationGatewayAutoscaleConfiguration4 {␊ - /**␊ - * Lower bound on number of Application Gateway instances␊ - */␊ - minCapacity: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the resource.␊ - */␊ - export interface ManagedServiceIdentity {␊ - /**␊ - * The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.␊ - */␊ - type?: ("SystemAssigned" | "UserAssigned" | "SystemAssigned, UserAssigned" | "None")␊ - /**␊ - * The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.␊ - */␊ - userAssignedIdentities?: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/authorizations␊ - */␊ - export interface ExpressRouteCircuitsAuthorizations8 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/authorizations"␊ - apiVersion: "2018-10-01"␊ - properties: (AuthorizationPropertiesFormat8 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings/connections␊ - */␊ - export interface ExpressRouteCircuitsPeeringsConnections5 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/peerings/connections"␊ - apiVersion: "2018-10-01"␊ - properties: (ExpressRouteCircuitConnectionPropertiesFormat5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/applicationSecurityGroups␊ - */␊ - export interface ApplicationSecurityGroups10 {␊ - name: string␊ - type: "Microsoft.Network/applicationSecurityGroups"␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the application security group.␊ - */␊ - properties: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/applicationSecurityGroups␊ - */␊ - export interface ApplicationSecurityGroups11 {␊ - name: string␊ - type: "Microsoft.Network/applicationSecurityGroups"␊ - apiVersion: "2018-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the application security group.␊ - */␊ - properties: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ddosProtectionPlans␊ - */␊ - export interface DdosProtectionPlans6 {␊ - name: string␊ - type: "Microsoft.Network/ddosProtectionPlans"␊ - apiVersion: "2018-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the DDoS protection plan.␊ - */␊ - properties: (DdosProtectionPlanPropertiesFormat3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DDoS protection plan properties.␊ - */␊ - export interface DdosProtectionPlanPropertiesFormat3 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits␊ - */␊ - export interface ExpressRouteCircuits8 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits"␊ - apiVersion: "2018-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The SKU.␊ - */␊ - sku?: (ExpressRouteCircuitSku8 | string)␊ - properties: (ExpressRouteCircuitPropertiesFormat8 | string)␊ - resources?: (ExpressRouteCircuitsPeeringsChildResource8 | ExpressRouteCircuitsAuthorizationsChildResource8)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains SKU in an ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitSku8 {␊ - /**␊ - * The name of the SKU.␊ - */␊ - name?: string␊ - /**␊ - * The tier of the SKU. Possible values are 'Standard', 'Premium' or 'Local'.␊ - */␊ - tier?: (("Standard" | "Premium" | "Basic" | "Local") | string)␊ - /**␊ - * The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'.␊ - */␊ - family?: (("UnlimitedData" | "MeteredData") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitPropertiesFormat8 {␊ - /**␊ - * Allow classic operations␊ - */␊ - allowClassicOperations?: (boolean | string)␊ - /**␊ - * The CircuitProvisioningState state of the resource.␊ - */␊ - circuitProvisioningState?: string␊ - /**␊ - * The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'.␊ - */␊ - serviceProviderProvisioningState?: (("NotProvisioned" | "Provisioning" | "Provisioned" | "Deprovisioning") | string)␊ - /**␊ - * The list of authorizations.␊ - */␊ - authorizations?: (ExpressRouteCircuitAuthorization8[] | string)␊ - /**␊ - * The list of peerings.␊ - */␊ - peerings?: (ExpressRouteCircuitPeering8[] | string)␊ - /**␊ - * The ServiceKey.␊ - */␊ - serviceKey?: string␊ - /**␊ - * The ServiceProviderNotes.␊ - */␊ - serviceProviderNotes?: string␊ - /**␊ - * The ServiceProviderProperties.␊ - */␊ - serviceProviderProperties?: (ExpressRouteCircuitServiceProviderProperties8 | string)␊ - /**␊ - * The reference to the ExpressRoutePort resource when the circuit is provisioned on an ExpressRoutePort resource.␊ - */␊ - expressRoutePort?: (SubResource21 | string)␊ - /**␊ - * The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource.␊ - */␊ - bandwidthInGbps?: (number | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - /**␊ - * Flag to enable Global Reach on the circuit.␊ - */␊ - allowGlobalReach?: (boolean | string)␊ - /**␊ - * Flag denoting Global reach status.␊ - */␊ - globalReachEnabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authorization in an ExpressRouteCircuit resource.␊ - */␊ - export interface ExpressRouteCircuitAuthorization8 {␊ - properties?: (AuthorizationPropertiesFormat9 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - export interface AuthorizationPropertiesFormat9 {␊ - /**␊ - * The authorization key.␊ - */␊ - authorizationKey?: string␊ - /**␊ - * AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'.␊ - */␊ - authorizationUseStatus?: (("Available" | "InUse") | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peering in an ExpressRouteCircuit resource.␊ - */␊ - export interface ExpressRouteCircuitPeering8 {␊ - properties?: (ExpressRouteCircuitPeeringPropertiesFormat9 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - export interface ExpressRouteCircuitPeeringPropertiesFormat9 {␊ - /**␊ - * The peering type.␊ - */␊ - peeringType?: (("AzurePublicPeering" | "AzurePrivatePeering" | "MicrosoftPeering") | string)␊ - /**␊ - * The peering state.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * The Azure ASN.␊ - */␊ - azureASN?: (number | string)␊ - /**␊ - * The peer ASN.␊ - */␊ - peerASN?: (number | string)␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The primary port.␊ - */␊ - primaryAzurePort?: string␊ - /**␊ - * The secondary port.␊ - */␊ - secondaryAzurePort?: string␊ - /**␊ - * The shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The VLAN ID.␊ - */␊ - vlanId?: (number | string)␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig9 | string)␊ - /**␊ - * Gets peering stats.␊ - */␊ - stats?: (ExpressRouteCircuitStats9 | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - /**␊ - * Gets whether the provider or the customer last modified the peering.␊ - */␊ - lastModifiedBy?: string␊ - /**␊ - * The reference of the RouteFilter resource.␊ - */␊ - routeFilter?: (SubResource21 | string)␊ - /**␊ - * The IPv6 peering configuration.␊ - */␊ - ipv6PeeringConfig?: (Ipv6ExpressRouteCircuitPeeringConfig6 | string)␊ - /**␊ - * The ExpressRoute connection.␊ - */␊ - expressRouteConnection?: ({␊ - [k: string]: unknown␊ - } | string)␊ - /**␊ - * The list of circuit connections associated with Azure Private Peering for this circuit.␊ - */␊ - connections?: (ExpressRouteCircuitConnection6[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the peering configuration.␊ - */␊ - export interface ExpressRouteCircuitPeeringConfig9 {␊ - /**␊ - * The reference of AdvertisedPublicPrefixes.␊ - */␊ - advertisedPublicPrefixes?: (string[] | string)␊ - /**␊ - * The communities of bgp peering. Specified for microsoft peering␊ - */␊ - advertisedCommunities?: (string[] | string)␊ - /**␊ - * AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'.␊ - */␊ - advertisedPublicPrefixesState?: (("NotConfigured" | "Configuring" | "Configured" | "ValidationNeeded") | string)␊ - /**␊ - * The legacy mode of the peering.␊ - */␊ - legacyMode?: (number | string)␊ - /**␊ - * The CustomerASN of the peering.␊ - */␊ - customerASN?: (number | string)␊ - /**␊ - * The RoutingRegistryName of the configuration.␊ - */␊ - routingRegistryName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains stats associated with the peering.␊ - */␊ - export interface ExpressRouteCircuitStats9 {␊ - /**␊ - * Gets BytesIn of the peering.␊ - */␊ - primarybytesIn?: (number | string)␊ - /**␊ - * Gets BytesOut of the peering.␊ - */␊ - primarybytesOut?: (number | string)␊ - /**␊ - * Gets BytesIn of the peering.␊ - */␊ - secondarybytesIn?: (number | string)␊ - /**␊ - * Gets BytesOut of the peering.␊ - */␊ - secondarybytesOut?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Reference to another subresource.␊ - */␊ - export interface SubResource21 {␊ - /**␊ - * Resource ID.␊ - */␊ - id: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains IPv6 peering config.␊ - */␊ - export interface Ipv6ExpressRouteCircuitPeeringConfig6 {␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig9 | string)␊ - /**␊ - * The reference of the RouteFilter resource.␊ - */␊ - routeFilter?: (SubResource21 | string)␊ - /**␊ - * The state of peering. Possible values are: 'Disabled' and 'Enabled'.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Express Route Circuit Connection in an ExpressRouteCircuitPeering resource.␊ - */␊ - export interface ExpressRouteCircuitConnection6 {␊ - properties?: (ExpressRouteCircuitConnectionPropertiesFormat6 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - export interface ExpressRouteCircuitConnectionPropertiesFormat6 {␊ - /**␊ - * Reference to Express Route Circuit Private Peering Resource of the circuit initiating connection.␊ - */␊ - expressRouteCircuitPeering?: (SubResource21 | string)␊ - /**␊ - * Reference to Express Route Circuit Private Peering Resource of the peered circuit.␊ - */␊ - peerExpressRouteCircuitPeering?: (SubResource21 | string)␊ - /**␊ - * /29 IP address space to carve out Customer addresses for tunnels.␊ - */␊ - addressPrefix?: string␊ - /**␊ - * The authorization key.␊ - */␊ - authorizationKey?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains ServiceProviderProperties in an ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitServiceProviderProperties8 {␊ - /**␊ - * The serviceProviderName.␊ - */␊ - serviceProviderName?: string␊ - /**␊ - * The peering location.␊ - */␊ - peeringLocation?: string␊ - /**␊ - * The BandwidthInMbps.␊ - */␊ - bandwidthInMbps?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings␊ - */␊ - export interface ExpressRouteCircuitsPeeringsChildResource8 {␊ - name: string␊ - type: "peerings"␊ - apiVersion: "2018-12-01"␊ - properties: (ExpressRouteCircuitPeeringPropertiesFormat9 | string)␊ - resources?: ExpressRouteCircuitsPeeringsConnectionsChildResource6[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings/connections␊ - */␊ - export interface ExpressRouteCircuitsPeeringsConnectionsChildResource6 {␊ - name: string␊ - type: "connections"␊ - apiVersion: "2018-12-01"␊ - properties: (ExpressRouteCircuitConnectionPropertiesFormat6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/authorizations␊ - */␊ - export interface ExpressRouteCircuitsAuthorizationsChildResource8 {␊ - name: string␊ - type: "authorizations"␊ - apiVersion: "2018-12-01"␊ - properties: (AuthorizationPropertiesFormat9 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections␊ - */␊ - export interface ExpressRouteCrossConnections6 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCrossConnections"␊ - apiVersion: "2018-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (ExpressRouteCrossConnectionProperties6 | string)␊ - resources?: ExpressRouteCrossConnectionsPeeringsChildResource6[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ExpressRouteCrossConnection.␊ - */␊ - export interface ExpressRouteCrossConnectionProperties6 {␊ - /**␊ - * The peering location of the ExpressRoute circuit.␊ - */␊ - peeringLocation?: string␊ - /**␊ - * The circuit bandwidth In Mbps.␊ - */␊ - bandwidthInMbps?: (number | string)␊ - /**␊ - * The ExpressRouteCircuit␊ - */␊ - expressRouteCircuit?: (ExpressRouteCircuitReference5 | string)␊ - /**␊ - * The provisioning state of the circuit in the connectivity provider system. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned'.␊ - */␊ - serviceProviderProvisioningState?: (("NotProvisioned" | "Provisioning" | "Provisioned" | "Deprovisioning") | string)␊ - /**␊ - * Additional read only notes set by the connectivity provider.␊ - */␊ - serviceProviderNotes?: string␊ - /**␊ - * The list of peerings.␊ - */␊ - peerings?: (ExpressRouteCrossConnectionPeering6[] | string)␊ - [k: string]: unknown␊ - }␊ - export interface ExpressRouteCircuitReference5 {␊ - /**␊ - * Corresponding Express Route Circuit Id.␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peering in an ExpressRoute Cross Connection resource.␊ - */␊ - export interface ExpressRouteCrossConnectionPeering6 {␊ - properties?: (ExpressRouteCrossConnectionPeeringProperties6 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - export interface ExpressRouteCrossConnectionPeeringProperties6 {␊ - /**␊ - * The peering type.␊ - */␊ - peeringType?: (("AzurePublicPeering" | "AzurePrivatePeering" | "MicrosoftPeering") | string)␊ - /**␊ - * The peering state.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * The peer ASN.␊ - */␊ - peerASN?: (number | string)␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The VLAN ID.␊ - */␊ - vlanId?: (number | string)␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig9 | string)␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - /**␊ - * Gets whether the provider or the customer last modified the peering.␊ - */␊ - lastModifiedBy?: string␊ - /**␊ - * The IPv6 peering configuration.␊ - */␊ - ipv6PeeringConfig?: (Ipv6ExpressRouteCircuitPeeringConfig6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections/peerings␊ - */␊ - export interface ExpressRouteCrossConnectionsPeeringsChildResource6 {␊ - name: string␊ - type: "peerings"␊ - apiVersion: "2018-12-01"␊ - properties: (ExpressRouteCrossConnectionPeeringProperties6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/publicIPAddresses␊ - */␊ - export interface PublicIPAddresses23 {␊ - name: string␊ - type: "Microsoft.Network/publicIPAddresses"␊ - apiVersion: "2018-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The public IP address SKU.␊ - */␊ - sku?: (PublicIPAddressSku11 | string)␊ - /**␊ - * Public IP address properties.␊ - */␊ - properties: (PublicIPAddressPropertiesFormat14 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a public IP address␊ - */␊ - export interface PublicIPAddressSku11 {␊ - /**␊ - * Name of a public IP address SKU.␊ - */␊ - name?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Public IP address properties.␊ - */␊ - export interface PublicIPAddressPropertiesFormat14 {␊ - /**␊ - * The public IP allocation method. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - publicIPAllocationMethod: (("Static" | "Dynamic") | string)␊ - /**␊ - * The public IP address version. Possible values are: 'IPv4' and 'IPv6'.␊ - */␊ - publicIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The FQDN of the DNS record associated with the public IP address.␊ - */␊ - dnsSettings?: (PublicIPAddressDnsSettings22 | string)␊ - /**␊ - * The DDoS protection custom policy associated with the public IP address.␊ - */␊ - ddosSettings?: (DdosSettings | string)␊ - /**␊ - * The list of tags associated with the public IP address.␊ - */␊ - ipTags?: (IpTag8[] | string)␊ - /**␊ - * The IP address associated with the public IP address resource.␊ - */␊ - ipAddress?: string␊ - /**␊ - * The Public IP Prefix this Public IP Address should be allocated from.␊ - */␊ - publicIPPrefix?: (SubResource21 | string)␊ - /**␊ - * The idle timeout of the public IP address.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * The resource GUID property of the public IP resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains FQDN of the DNS record associated with the public IP address␊ - */␊ - export interface PublicIPAddressDnsSettings22 {␊ - /**␊ - * Gets or sets the Domain name label.The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.␊ - */␊ - domainNameLabel: string␊ - /**␊ - * Gets the FQDN, Fully qualified domain name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone.␊ - */␊ - fqdn?: string␊ - /**␊ - * Gets or Sets the Reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN. ␊ - */␊ - reverseFqdn?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains the DDoS protection settings of the public IP.␊ - */␊ - export interface DdosSettings {␊ - /**␊ - * The DDoS custom policy associated with the public IP.␊ - */␊ - ddosCustomPolicy?: (SubResource21 | string)␊ - /**␊ - * The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized.␊ - */␊ - protectionCoverage?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains the IpTag associated with the object␊ - */␊ - export interface IpTag8 {␊ - /**␊ - * Gets or sets the ipTag type: Example FirstPartyUsage.␊ - */␊ - ipTagType?: string␊ - /**␊ - * Gets or sets value of the IpTag associated with the public IP. Example SQL, Storage etc␊ - */␊ - tag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks␊ - */␊ - export interface VirtualNetworks23 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks"␊ - apiVersion: "2018-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network.␊ - */␊ - properties: (VirtualNetworkPropertiesFormat15 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: (VirtualNetworksVirtualNetworkPeeringsChildResource12 | VirtualNetworksSubnetsChildResource15)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the virtual network.␊ - */␊ - export interface VirtualNetworkPropertiesFormat15 {␊ - /**␊ - * The AddressSpace that contains an array of IP address ranges that can be used by subnets.␊ - */␊ - addressSpace: (AddressSpace23 | string)␊ - /**␊ - * The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network.␊ - */␊ - dhcpOptions?: (DhcpOptions23 | string)␊ - /**␊ - * A list of subnets in a Virtual Network.␊ - */␊ - subnets?: (Subnet25[] | string)␊ - /**␊ - * A list of peerings in a Virtual Network.␊ - */␊ - virtualNetworkPeerings?: (VirtualNetworkPeering20[] | string)␊ - /**␊ - * The resourceGuid property of the Virtual Network resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - /**␊ - * Indicates if DDoS protection is enabled for all the protected resources in the virtual network. It requires a DDoS protection plan associated with the resource.␊ - */␊ - enableDdosProtection?: (boolean | string)␊ - /**␊ - * Indicates if VM protection is enabled for all the subnets in the virtual network.␊ - */␊ - enableVmProtection?: (boolean | string)␊ - /**␊ - * The DDoS protection plan associated with the virtual network.␊ - */␊ - ddosProtectionPlan?: (SubResource21 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.␊ - */␊ - export interface AddressSpace23 {␊ - /**␊ - * A list of address blocks reserved for this virtual network in CIDR notation.␊ - */␊ - addressPrefixes: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DhcpOptions contains an array of DNS servers available to VMs deployed in the virtual network. Standard DHCP option for a subnet overrides VNET DHCP options.␊ - */␊ - export interface DhcpOptions23 {␊ - /**␊ - * The list of DNS servers IP addresses.␊ - */␊ - dnsServers: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Subnet in a virtual network resource.␊ - */␊ - export interface Subnet25 {␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties?: (SubnetPropertiesFormat15 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the subnet.␊ - */␊ - export interface SubnetPropertiesFormat15 {␊ - /**␊ - * The address prefix for the subnet.␊ - */␊ - addressPrefix: string␊ - /**␊ - * List of address prefixes for the subnet.␊ - */␊ - addressPrefixes?: (string[] | string)␊ - /**␊ - * The reference of the NetworkSecurityGroup resource.␊ - */␊ - networkSecurityGroup?: (SubResource21 | string)␊ - /**␊ - * The reference of the RouteTable resource.␊ - */␊ - routeTable?: (SubResource21 | string)␊ - /**␊ - * An array of service endpoints.␊ - */␊ - serviceEndpoints?: (ServiceEndpointPropertiesFormat11[] | string)␊ - /**␊ - * An array of service endpoint policies.␊ - */␊ - serviceEndpointPolicies?: (SubResource21[] | string)␊ - /**␊ - * Gets an array of references to the external resources using subnet.␊ - */␊ - resourceNavigationLinks?: (ResourceNavigationLink12[] | string)␊ - /**␊ - * Gets an array of references to services injecting into this subnet.␊ - */␊ - serviceAssociationLinks?: (ServiceAssociationLink2[] | string)␊ - /**␊ - * Gets an array of references to the delegations on the subnet.␊ - */␊ - delegations?: (Delegation2[] | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The service endpoint properties.␊ - */␊ - export interface ServiceEndpointPropertiesFormat11 {␊ - /**␊ - * The type of the endpoint service.␊ - */␊ - service?: string␊ - /**␊ - * A list of locations.␊ - */␊ - locations?: (string[] | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ResourceNavigationLink resource.␊ - */␊ - export interface ResourceNavigationLink12 {␊ - /**␊ - * Resource navigation link properties format.␊ - */␊ - properties?: (ResourceNavigationLinkFormat12 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ResourceNavigationLink.␊ - */␊ - export interface ResourceNavigationLinkFormat12 {␊ - /**␊ - * Resource type of the linked resource.␊ - */␊ - linkedResourceType?: string␊ - /**␊ - * Link to the external resource␊ - */␊ - link?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ServiceAssociationLink resource.␊ - */␊ - export interface ServiceAssociationLink2 {␊ - /**␊ - * Resource navigation link properties format.␊ - */␊ - properties?: (ServiceAssociationLinkPropertiesFormat2 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ServiceAssociationLink.␊ - */␊ - export interface ServiceAssociationLinkPropertiesFormat2 {␊ - /**␊ - * Resource type of the linked resource.␊ - */␊ - linkedResourceType?: string␊ - /**␊ - * Link to the external resource.␊ - */␊ - link?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Details the service to which the subnet is delegated.␊ - */␊ - export interface Delegation2 {␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties?: (ServiceDelegationPropertiesFormat2 | string)␊ - /**␊ - * The name of the resource that is unique within a subnet. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a service delegation.␊ - */␊ - export interface ServiceDelegationPropertiesFormat2 {␊ - /**␊ - * The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers)␊ - */␊ - serviceName?: string␊ - /**␊ - * Describes the actions permitted to the service upon delegation␊ - */␊ - actions?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peerings in a virtual network resource.␊ - */␊ - export interface VirtualNetworkPeering20 {␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties?: (VirtualNetworkPeeringPropertiesFormat12 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - export interface VirtualNetworkPeeringPropertiesFormat12 {␊ - /**␊ - * Whether the VMs in the linked virtual network space would be able to access all the VMs in local Virtual network space.␊ - */␊ - allowVirtualNetworkAccess?: (boolean | string)␊ - /**␊ - * Whether the forwarded traffic from the VMs in the remote virtual network will be allowed/disallowed.␊ - */␊ - allowForwardedTraffic?: (boolean | string)␊ - /**␊ - * If gateway links can be used in remote virtual networking to link to this virtual network.␊ - */␊ - allowGatewayTransit?: (boolean | string)␊ - /**␊ - * If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway.␊ - */␊ - useRemoteGateways?: (boolean | string)␊ - /**␊ - * The reference of the remote virtual network. The remote virtual network can be in the same or different region (preview). See here to register for the preview and learn more (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering).␊ - */␊ - remoteVirtualNetwork: (SubResource21 | string)␊ - /**␊ - * The reference of the remote virtual network address space.␊ - */␊ - remoteAddressSpace?: (AddressSpace23 | string)␊ - /**␊ - * The status of the virtual network peering. Possible values are 'Initiated', 'Connected', and 'Disconnected'.␊ - */␊ - peeringState?: (("Initiated" | "Connected" | "Disconnected") | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/virtualNetworkPeerings␊ - */␊ - export interface VirtualNetworksVirtualNetworkPeeringsChildResource12 {␊ - name: string␊ - type: "virtualNetworkPeerings"␊ - apiVersion: "2018-12-01"␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties: (VirtualNetworkPeeringPropertiesFormat12 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnetsChildResource15 {␊ - name: string␊ - type: "subnets"␊ - apiVersion: "2018-12-01"␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties: (SubnetPropertiesFormat15 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers␊ - */␊ - export interface LoadBalancers23 {␊ - name: string␊ - type: "Microsoft.Network/loadBalancers"␊ - apiVersion: "2018-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The load balancer SKU.␊ - */␊ - sku?: (LoadBalancerSku11 | string)␊ - /**␊ - * Properties of load balancer.␊ - */␊ - properties: (LoadBalancerPropertiesFormat15 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: LoadBalancersInboundNatRulesChildResource11[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a load balancer␊ - */␊ - export interface LoadBalancerSku11 {␊ - /**␊ - * Name of a load balancer SKU.␊ - */␊ - name?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer.␊ - */␊ - export interface LoadBalancerPropertiesFormat15 {␊ - /**␊ - * Object representing the frontend IPs to be used for the load balancer␊ - */␊ - frontendIPConfigurations?: (FrontendIPConfiguration14[] | string)␊ - /**␊ - * Collection of backend address pools used by a load balancer␊ - */␊ - backendAddressPools?: (BackendAddressPool15[] | string)␊ - /**␊ - * Object collection representing the load balancing rules Gets the provisioning ␊ - */␊ - loadBalancingRules?: (LoadBalancingRule15[] | string)␊ - /**␊ - * Collection of probe objects used in the load balancer␊ - */␊ - probes?: (Probe15[] | string)␊ - /**␊ - * Collection of inbound NAT Rules used by a load balancer. Defining inbound NAT rules on your load balancer is mutually exclusive with defining an inbound NAT pool. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an Inbound NAT pool. They have to reference individual inbound NAT rules.␊ - */␊ - inboundNatRules?: (InboundNatRule16[] | string)␊ - /**␊ - * Defines an external port range for inbound NAT to a single backend port on NICs associated with a load balancer. Inbound NAT rules are created automatically for each NIC associated with the Load Balancer using an external port from this range. Defining an Inbound NAT pool on your Load Balancer is mutually exclusive with defining inbound Nat rules. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an inbound NAT pool. They have to reference individual inbound NAT rules.␊ - */␊ - inboundNatPools?: (InboundNatPool16[] | string)␊ - /**␊ - * The outbound rules.␊ - */␊ - outboundRules?: (OutboundRule3[] | string)␊ - /**␊ - * The resource GUID property of the load balancer resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP address of the load balancer.␊ - */␊ - export interface FrontendIPConfiguration14 {␊ - /**␊ - * Properties of the load balancer probe.␊ - */␊ - properties?: (FrontendIPConfigurationPropertiesFormat14 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP Configuration of the load balancer.␊ - */␊ - export interface FrontendIPConfigurationPropertiesFormat14 {␊ - /**␊ - * The private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The Private IP allocation method. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * The reference of the subnet resource.␊ - */␊ - subnet?: (SubResource21 | string)␊ - /**␊ - * The reference of the Public IP resource.␊ - */␊ - publicIPAddress?: (SubResource21 | string)␊ - /**␊ - * The reference of the Public IP Prefix resource.␊ - */␊ - publicIPPrefix?: (SubResource21 | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Pool of backend IP addresses.␊ - */␊ - export interface BackendAddressPool15 {␊ - /**␊ - * Properties of load balancer backend address pool.␊ - */␊ - properties?: (BackendAddressPoolPropertiesFormat15 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the backend address pool.␊ - */␊ - export interface BackendAddressPoolPropertiesFormat15 {␊ - /**␊ - * Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A load balancing rule for a load balancer.␊ - */␊ - export interface LoadBalancingRule15 {␊ - /**␊ - * Properties of load balancer load balancing rule.␊ - */␊ - properties?: (LoadBalancingRulePropertiesFormat15 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer.␊ - */␊ - export interface LoadBalancingRulePropertiesFormat15 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource21 | string)␊ - /**␊ - * A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs.␊ - */␊ - backendAddressPool?: (SubResource21 | string)␊ - /**␊ - * The reference of the load balancer probe used by the load balancing rule.␊ - */␊ - probe?: (SubResource21 | string)␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'.␊ - */␊ - loadDistribution?: (("Default" | "SourceIP" | "SourceIPProtocol") | string)␊ - /**␊ - * The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 0 and 65534. Note that value 0 enables "Any Port"␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port"␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - /**␊ - * Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule.␊ - */␊ - disableOutboundSnat?: (boolean | string)␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A load balancer probe.␊ - */␊ - export interface Probe15 {␊ - /**␊ - * Properties of load balancer probe.␊ - */␊ - properties?: (ProbePropertiesFormat15 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Load balancer probe resource.␊ - */␊ - export interface ProbePropertiesFormat15 {␊ - /**␊ - * The protocol of the end point. Possible values are: 'Http', 'Tcp', or 'Https'. If 'Tcp' is specified, a received ACK is required for the probe to be successful. If 'Http' or 'Https' is specified, a 200 OK response from the specifies URI is required for the probe to be successful.␊ - */␊ - protocol: (("Http" | "Tcp" | "Https") | string)␊ - /**␊ - * The port for communicating the probe. Possible values range from 1 to 65535, inclusive.␊ - */␊ - port: (number | string)␊ - /**␊ - * The interval, in seconds, for how frequently to probe the endpoint for health status. Typically, the interval is slightly less than half the allocated timeout period (in seconds) which allows two full probes before taking the instance out of rotation. The default value is 15, the minimum value is 5.␊ - */␊ - intervalInSeconds?: (number | string)␊ - /**␊ - * The number of probes where if no response, will result in stopping further traffic from being delivered to the endpoint. This values allows endpoints to be taken out of rotation faster or slower than the typical times used in Azure.␊ - */␊ - numberOfProbes: (number | string)␊ - /**␊ - * The URI used for requesting health status from the VM. Path is required if a protocol is set to http. Otherwise, it is not allowed. There is no default value.␊ - */␊ - requestPath?: string␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT rule of the load balancer.␊ - */␊ - export interface InboundNatRule16 {␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties?: (InboundNatRulePropertiesFormat15 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the inbound NAT rule.␊ - */␊ - export interface InboundNatRulePropertiesFormat15 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource21 | string)␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values range from 1 to 65534.␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * The port used for the internal endpoint. Acceptable values range from 1 to 65535.␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT pool of the load balancer.␊ - */␊ - export interface InboundNatPool16 {␊ - /**␊ - * Properties of load balancer inbound nat pool.␊ - */␊ - properties?: (InboundNatPoolPropertiesFormat15 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Inbound NAT pool.␊ - */␊ - export interface InboundNatPoolPropertiesFormat15 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource21 | string)␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65534.␊ - */␊ - frontendPortRangeStart: (number | string)␊ - /**␊ - * The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65535.␊ - */␊ - frontendPortRangeEnd: (number | string)␊ - /**␊ - * The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound pool of the load balancer.␊ - */␊ - export interface OutboundRule3 {␊ - /**␊ - * Properties of load balancer outbound rule.␊ - */␊ - properties?: (OutboundRulePropertiesFormat3 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound pool of the load balancer.␊ - */␊ - export interface OutboundRulePropertiesFormat3 {␊ - /**␊ - * The number of outbound ports to be used for NAT.␊ - */␊ - allocatedOutboundPorts?: (number | string)␊ - /**␊ - * The Frontend IP addresses of the load balancer.␊ - */␊ - frontendIPConfigurations: (SubResource21[] | string)␊ - /**␊ - * A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs.␊ - */␊ - backendAddressPool: (SubResource21 | string)␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - /**␊ - * Protocol - TCP, UDP or All.␊ - */␊ - protocol: (("Tcp" | "Udp" | "All") | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - /**␊ - * The timeout for the TCP idle connection␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers/inboundNatRules␊ - */␊ - export interface LoadBalancersInboundNatRulesChildResource11 {␊ - name: string␊ - type: "inboundNatRules"␊ - apiVersion: "2018-12-01"␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties: (InboundNatRulePropertiesFormat15 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups␊ - */␊ - export interface NetworkSecurityGroups23 {␊ - name: string␊ - type: "Microsoft.Network/networkSecurityGroups"␊ - apiVersion: "2018-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network security group␊ - */␊ - properties: (NetworkSecurityGroupPropertiesFormat15 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: NetworkSecurityGroupsSecurityRulesChildResource15[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network Security Group resource.␊ - */␊ - export interface NetworkSecurityGroupPropertiesFormat15 {␊ - /**␊ - * A collection of security rules of the network security group.␊ - */␊ - securityRules?: (SecurityRule15[] | string)␊ - /**␊ - * The default security rules of network security group.␊ - */␊ - defaultSecurityRules?: (SecurityRule15[] | string)␊ - /**␊ - * The resource GUID property of the network security group resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network security rule.␊ - */␊ - export interface SecurityRule15 {␊ - /**␊ - * Properties of the security rule␊ - */␊ - properties?: (SecurityRulePropertiesFormat15 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Security rule resource.␊ - */␊ - export interface SecurityRulePropertiesFormat15 {␊ - /**␊ - * A description for this rule. Restricted to 140 chars.␊ - */␊ - description?: string␊ - /**␊ - * Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'.␊ - */␊ - protocol: (("Tcp" | "Udp" | "*") | string)␊ - /**␊ - * The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.␊ - */␊ - sourcePortRange?: string␊ - /**␊ - * The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.␊ - */␊ - destinationPortRange?: string␊ - /**␊ - * The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. ␊ - */␊ - sourceAddressPrefix?: string␊ - /**␊ - * The CIDR or source IP ranges.␊ - */␊ - sourceAddressPrefixes?: (string[] | string)␊ - /**␊ - * The application security group specified as source.␊ - */␊ - sourceApplicationSecurityGroups?: (SubResource21[] | string)␊ - /**␊ - * The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used.␊ - */␊ - destinationAddressPrefix?: string␊ - /**␊ - * The destination address prefixes. CIDR or destination IP ranges.␊ - */␊ - destinationAddressPrefixes?: (string[] | string)␊ - /**␊ - * The application security group specified as destination.␊ - */␊ - destinationApplicationSecurityGroups?: (SubResource21[] | string)␊ - /**␊ - * The source port ranges.␊ - */␊ - sourcePortRanges?: (string[] | string)␊ - /**␊ - * The destination port ranges.␊ - */␊ - destinationPortRanges?: (string[] | string)␊ - /**␊ - * The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'.␊ - */␊ - access: (("Allow" | "Deny") | string)␊ - /**␊ - * The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.␊ - */␊ - priority: (number | string)␊ - /**␊ - * The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. Possible values are: 'Inbound' and 'Outbound'.␊ - */␊ - direction: (("Inbound" | "Outbound") | string)␊ - /**␊ - * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRulesChildResource15 {␊ - name: string␊ - type: "securityRules"␊ - apiVersion: "2018-12-01"␊ - /**␊ - * Properties of the security rule␊ - */␊ - properties: (SecurityRulePropertiesFormat15 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces␊ - */␊ - export interface NetworkInterfaces24 {␊ - name: string␊ - type: "Microsoft.Network/networkInterfaces"␊ - apiVersion: "2018-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network interface.␊ - */␊ - properties: (NetworkInterfacePropertiesFormat15 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: NetworkInterfacesTapConfigurationsChildResource2[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NetworkInterface properties. ␊ - */␊ - export interface NetworkInterfacePropertiesFormat15 {␊ - /**␊ - * The reference of the NetworkSecurityGroup resource.␊ - */␊ - networkSecurityGroup?: (SubResource21 | string)␊ - /**␊ - * A list of IPConfigurations of the network interface.␊ - */␊ - ipConfigurations: (NetworkInterfaceIPConfiguration14[] | string)␊ - /**␊ - * A list of TapConfigurations of the network interface.␊ - */␊ - tapConfigurations?: (NetworkInterfaceTapConfiguration2[] | string)␊ - /**␊ - * The DNS settings in network interface.␊ - */␊ - dnsSettings?: (NetworkInterfaceDnsSettings23 | string)␊ - /**␊ - * The MAC address of the network interface.␊ - */␊ - macAddress?: string␊ - /**␊ - * Gets whether this is a primary network interface on a virtual machine.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * If the network interface is accelerated networking enabled.␊ - */␊ - enableAcceleratedNetworking?: (boolean | string)␊ - /**␊ - * Indicates whether IP forwarding is enabled on this network interface.␊ - */␊ - enableIPForwarding?: (boolean | string)␊ - /**␊ - * The resource GUID property of the network interface resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IPConfiguration in a network interface.␊ - */␊ - export interface NetworkInterfaceIPConfiguration14 {␊ - /**␊ - * Network interface IP configuration properties.␊ - */␊ - properties?: (NetworkInterfaceIPConfigurationPropertiesFormat14 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration.␊ - */␊ - export interface NetworkInterfaceIPConfigurationPropertiesFormat14 {␊ - /**␊ - * The reference to Virtual Network Taps.␊ - */␊ - virtualNetworkTaps?: (SubResource21[] | string)␊ - /**␊ - * The reference of ApplicationGatewayBackendAddressPool resource.␊ - */␊ - applicationGatewayBackendAddressPools?: (SubResource21[] | string)␊ - /**␊ - * The reference of LoadBalancerBackendAddressPool resource.␊ - */␊ - loadBalancerBackendAddressPools?: (SubResource21[] | string)␊ - /**␊ - * A list of references of LoadBalancerInboundNatRules.␊ - */␊ - loadBalancerInboundNatRules?: (SubResource21[] | string)␊ - /**␊ - * Private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * Defines how a private IP address is assigned. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Available from Api-Version 2016-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.␊ - */␊ - privateIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * Subnet bound to the IP configuration.␊ - */␊ - subnet?: (SubResource21 | string)␊ - /**␊ - * Gets whether this is a primary customer address on the network interface.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * Public IP address bound to the IP configuration.␊ - */␊ - publicIPAddress?: (SubResource21 | string)␊ - /**␊ - * Application security groups in which the IP configuration is included.␊ - */␊ - applicationSecurityGroups?: (SubResource21[] | string)␊ - /**␊ - * The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Tap configuration in a Network Interface␊ - */␊ - export interface NetworkInterfaceTapConfiguration2 {␊ - /**␊ - * Properties of the Virtual Network Tap configuration␊ - */␊ - properties?: (NetworkInterfaceTapConfigurationPropertiesFormat2 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Virtual Network Tap configuration.␊ - */␊ - export interface NetworkInterfaceTapConfigurationPropertiesFormat2 {␊ - /**␊ - * The reference of the Virtual Network Tap resource.␊ - */␊ - virtualNetworkTap?: (SubResource21 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DNS settings of a network interface.␊ - */␊ - export interface NetworkInterfaceDnsSettings23 {␊ - /**␊ - * List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only value in dnsServers collection.␊ - */␊ - dnsServers?: (string[] | string)␊ - /**␊ - * If the VM that uses this NIC is part of an Availability Set, then this list will have the union of all DNS servers from all NICs that are part of the Availability Set. This property is what is configured on each of those VMs.␊ - */␊ - appliedDnsServers?: (string[] | string)␊ - /**␊ - * Relative DNS name for this NIC used for internal communications between VMs in the same virtual network.␊ - */␊ - internalDnsNameLabel?: string␊ - /**␊ - * Fully qualified DNS name supporting internal communications between VMs in the same virtual network.␊ - */␊ - internalFqdn?: string␊ - /**␊ - * Even if internalDnsNameLabel is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internalDomainNameSuffix.␊ - */␊ - internalDomainNameSuffix?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces/tapConfigurations␊ - */␊ - export interface NetworkInterfacesTapConfigurationsChildResource2 {␊ - name: string␊ - type: "tapConfigurations"␊ - apiVersion: "2018-12-01"␊ - /**␊ - * Properties of the Virtual Network Tap configuration␊ - */␊ - properties: (NetworkInterfaceTapConfigurationPropertiesFormat2 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables␊ - */␊ - export interface RouteTables23 {␊ - name: string␊ - type: "Microsoft.Network/routeTables"␊ - apiVersion: "2018-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the route table.␊ - */␊ - properties: (RouteTablePropertiesFormat15 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: RouteTablesRoutesChildResource15[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Table resource␊ - */␊ - export interface RouteTablePropertiesFormat15 {␊ - /**␊ - * Collection of routes contained within a route table.␊ - */␊ - routes?: (Route15[] | string)␊ - /**␊ - * Gets or sets whether to disable the routes learned by BGP on that route table. True means disable.␊ - */␊ - disableBgpRoutePropagation?: (boolean | string)␊ - /**␊ - * The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource␊ - */␊ - export interface Route15 {␊ - /**␊ - * Properties of the route.␊ - */␊ - properties?: (RoutePropertiesFormat15 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource␊ - */␊ - export interface RoutePropertiesFormat15 {␊ - /**␊ - * The destination CIDR to which the route applies.␊ - */␊ - addressPrefix: string␊ - /**␊ - * The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'.␊ - */␊ - nextHopType: (("VirtualNetworkGateway" | "VnetLocal" | "Internet" | "VirtualAppliance" | "None") | string)␊ - /**␊ - * The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.␊ - */␊ - nextHopIpAddress?: string␊ - /**␊ - * The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutesChildResource15 {␊ - name: string␊ - type: "routes"␊ - apiVersion: "2018-12-01"␊ - /**␊ - * Properties of the route.␊ - */␊ - properties: (RoutePropertiesFormat15 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/applicationGateways␊ - */␊ - export interface ApplicationGateways14 {␊ - name: string␊ - type: "Microsoft.Network/applicationGateways"␊ - apiVersion: "2018-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (ApplicationGatewayPropertiesFormat14 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * A list of availability zones denoting where the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - /**␊ - * The identity of the application gateway, if configured.␊ - */␊ - identity?: (ManagedServiceIdentity1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application gateway.␊ - */␊ - export interface ApplicationGatewayPropertiesFormat14 {␊ - /**␊ - * SKU of the application gateway resource.␊ - */␊ - sku?: (ApplicationGatewaySku14 | string)␊ - /**␊ - * SSL policy of the application gateway resource.␊ - */␊ - sslPolicy?: (ApplicationGatewaySslPolicy11 | string)␊ - /**␊ - * Subnets of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - gatewayIPConfigurations?: (ApplicationGatewayIPConfiguration14[] | string)␊ - /**␊ - * Authentication certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - authenticationCertificates?: (ApplicationGatewayAuthenticationCertificate11[] | string)␊ - /**␊ - * Trusted Root certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - trustedRootCertificates?: (ApplicationGatewayTrustedRootCertificate2[] | string)␊ - /**␊ - * SSL certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - sslCertificates?: (ApplicationGatewaySslCertificate14[] | string)␊ - /**␊ - * Frontend IP addresses of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - frontendIPConfigurations?: (ApplicationGatewayFrontendIPConfiguration14[] | string)␊ - /**␊ - * Frontend ports of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - frontendPorts?: (ApplicationGatewayFrontendPort14[] | string)␊ - /**␊ - * Probes of the application gateway resource.␊ - */␊ - probes?: (ApplicationGatewayProbe13[] | string)␊ - /**␊ - * Backend address pool of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - backendAddressPools?: (ApplicationGatewayBackendAddressPool14[] | string)␊ - /**␊ - * Backend http settings of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - backendHttpSettingsCollection?: (ApplicationGatewayBackendHttpSettings14[] | string)␊ - /**␊ - * Http listeners of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - httpListeners?: (ApplicationGatewayHttpListener14[] | string)␊ - /**␊ - * URL path map of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - urlPathMaps?: (ApplicationGatewayUrlPathMap13[] | string)␊ - /**␊ - * Request routing rules of the application gateway resource.␊ - */␊ - requestRoutingRules?: (ApplicationGatewayRequestRoutingRule14[] | string)␊ - /**␊ - * Rewrite rules for the application gateway resource.␊ - */␊ - rewriteRuleSets?: (ApplicationGatewayRewriteRuleSet1[] | string)␊ - /**␊ - * Redirect configurations of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - redirectConfigurations?: (ApplicationGatewayRedirectConfiguration11[] | string)␊ - /**␊ - * Web application firewall configuration.␊ - */␊ - webApplicationFirewallConfiguration?: (ApplicationGatewayWebApplicationFirewallConfiguration11 | string)␊ - /**␊ - * Reference of the FirewallPolicy resource.␊ - */␊ - firewallPolicy?: (SubResource21 | string)␊ - /**␊ - * Whether HTTP2 is enabled on the application gateway resource.␊ - */␊ - enableHttp2?: (boolean | string)␊ - /**␊ - * Whether FIPS is enabled on the application gateway resource.␊ - */␊ - enableFips?: (boolean | string)␊ - /**␊ - * Autoscale Configuration.␊ - */␊ - autoscaleConfiguration?: (ApplicationGatewayAutoscaleConfiguration5 | string)␊ - /**␊ - * Resource GUID property of the application gateway resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - /**␊ - * Custom error configurations of the application gateway resource.␊ - */␊ - customErrorConfigurations?: (ApplicationGatewayCustomError2[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of an application gateway␊ - */␊ - export interface ApplicationGatewaySku14 {␊ - /**␊ - * Name of an application gateway SKU.␊ - */␊ - name?: (("Standard_Small" | "Standard_Medium" | "Standard_Large" | "WAF_Medium" | "WAF_Large" | "Standard_v2" | "WAF_v2") | string)␊ - /**␊ - * Tier of an application gateway.␊ - */␊ - tier?: (("Standard" | "WAF" | "Standard_v2" | "WAF_v2") | string)␊ - /**␊ - * Capacity (instance count) of an application gateway.␊ - */␊ - capacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application Gateway Ssl policy.␊ - */␊ - export interface ApplicationGatewaySslPolicy11 {␊ - /**␊ - * Ssl protocols to be disabled on application gateway.␊ - */␊ - disabledSslProtocols?: (("TLSv1_0" | "TLSv1_1" | "TLSv1_2")[] | string)␊ - /**␊ - * Type of Ssl Policy.␊ - */␊ - policyType?: (("Predefined" | "Custom") | string)␊ - /**␊ - * Name of Ssl predefined policy.␊ - */␊ - policyName?: (("AppGwSslPolicy20150501" | "AppGwSslPolicy20170401" | "AppGwSslPolicy20170401S") | string)␊ - /**␊ - * Ssl cipher suites to be enabled in the specified order to application gateway.␊ - */␊ - cipherSuites?: (("TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384" | "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256" | "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA" | "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA" | "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384" | "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256" | "TLS_DHE_RSA_WITH_AES_256_CBC_SHA" | "TLS_DHE_RSA_WITH_AES_128_CBC_SHA" | "TLS_RSA_WITH_AES_256_GCM_SHA384" | "TLS_RSA_WITH_AES_128_GCM_SHA256" | "TLS_RSA_WITH_AES_256_CBC_SHA256" | "TLS_RSA_WITH_AES_128_CBC_SHA256" | "TLS_RSA_WITH_AES_256_CBC_SHA" | "TLS_RSA_WITH_AES_128_CBC_SHA" | "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384" | "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256" | "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384" | "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256" | "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA" | "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA" | "TLS_DHE_DSS_WITH_AES_256_CBC_SHA256" | "TLS_DHE_DSS_WITH_AES_128_CBC_SHA256" | "TLS_DHE_DSS_WITH_AES_256_CBC_SHA" | "TLS_DHE_DSS_WITH_AES_128_CBC_SHA" | "TLS_RSA_WITH_3DES_EDE_CBC_SHA" | "TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA" | "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256" | "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384")[] | string)␊ - /**␊ - * Minimum version of Ssl protocol to be supported on application gateway.␊ - */␊ - minProtocolVersion?: (("TLSv1_0" | "TLSv1_1" | "TLSv1_2") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed.␊ - */␊ - export interface ApplicationGatewayIPConfiguration14 {␊ - properties?: (ApplicationGatewayIPConfigurationPropertiesFormat14 | string)␊ - /**␊ - * Name of the IP configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayIPConfigurationPropertiesFormat14 {␊ - /**␊ - * Reference of the subnet resource. A subnet from where application gateway gets its private address.␊ - */␊ - subnet?: (SubResource21 | string)␊ - /**␊ - * Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authentication certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewayAuthenticationCertificate11 {␊ - properties?: (ApplicationGatewayAuthenticationCertificatePropertiesFormat11 | string)␊ - /**␊ - * Name of the authentication certificate that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authentication certificates properties of an application gateway.␊ - */␊ - export interface ApplicationGatewayAuthenticationCertificatePropertiesFormat11 {␊ - /**␊ - * Certificate public data.␊ - */␊ - data?: string␊ - /**␊ - * Provisioning state of the authentication certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trusted Root certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewayTrustedRootCertificate2 {␊ - properties?: (ApplicationGatewayTrustedRootCertificatePropertiesFormat2 | string)␊ - /**␊ - * Name of the trusted root certificate that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trusted Root certificates properties of an application gateway.␊ - */␊ - export interface ApplicationGatewayTrustedRootCertificatePropertiesFormat2 {␊ - /**␊ - * Certificate public data.␊ - */␊ - data?: string␊ - /**␊ - * Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault.␊ - */␊ - keyVaultSecretId?: string␊ - /**␊ - * Provisioning state of the trusted root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSL certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewaySslCertificate14 {␊ - properties?: (ApplicationGatewaySslCertificatePropertiesFormat14 | string)␊ - /**␊ - * Name of the SSL certificate that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewaySslCertificatePropertiesFormat14 {␊ - /**␊ - * Base-64 encoded pfx certificate. Only applicable in PUT Request.␊ - */␊ - data?: string␊ - /**␊ - * Password for the pfx file specified in data. Only applicable in PUT request.␊ - */␊ - password?: string␊ - /**␊ - * Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request.␊ - */␊ - publicCertData?: string␊ - /**␊ - * Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault.␊ - */␊ - keyVaultSecretId?: string␊ - /**␊ - * Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendIPConfiguration14 {␊ - properties?: (ApplicationGatewayFrontendIPConfigurationPropertiesFormat14 | string)␊ - /**␊ - * Name of the frontend IP configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendIPConfigurationPropertiesFormat14 {␊ - /**␊ - * PrivateIPAddress of the network interface IP Configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * PrivateIP allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Reference of the subnet resource.␊ - */␊ - subnet?: (SubResource21 | string)␊ - /**␊ - * Reference of the PublicIP resource.␊ - */␊ - publicIPAddress?: (SubResource21 | string)␊ - /**␊ - * Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend port of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendPort14 {␊ - properties?: (ApplicationGatewayFrontendPortPropertiesFormat14 | string)␊ - /**␊ - * Name of the frontend port that is unique within an Application Gateway␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend port of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendPortPropertiesFormat14 {␊ - /**␊ - * Frontend port␊ - */␊ - port?: (number | string)␊ - /**␊ - * Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Probe of the application gateway.␊ - */␊ - export interface ApplicationGatewayProbe13 {␊ - properties?: (ApplicationGatewayProbePropertiesFormat13 | string)␊ - /**␊ - * Name of the probe that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of probe of an application gateway.␊ - */␊ - export interface ApplicationGatewayProbePropertiesFormat13 {␊ - /**␊ - * The protocol used for the probe. Possible values are 'Http' and 'Https'.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Host name to send the probe to.␊ - */␊ - host?: string␊ - /**␊ - * Relative path of probe. Valid path starts from '/'. Probe is sent to ://:␊ - */␊ - path?: string␊ - /**␊ - * The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - interval?: (number | string)␊ - /**␊ - * The probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - timeout?: (number | string)␊ - /**␊ - * The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20.␊ - */␊ - unhealthyThreshold?: (number | string)␊ - /**␊ - * Whether the host header should be picked from the backend http settings. Default value is false.␊ - */␊ - pickHostNameFromBackendHttpSettings?: (boolean | string)␊ - /**␊ - * Minimum number of servers that are always marked healthy. Default value is 0.␊ - */␊ - minServers?: (number | string)␊ - /**␊ - * Criterion for classifying a healthy probe response.␊ - */␊ - match?: (ApplicationGatewayProbeHealthResponseMatch11 | string)␊ - /**␊ - * Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application gateway probe health response match␊ - */␊ - export interface ApplicationGatewayProbeHealthResponseMatch11 {␊ - /**␊ - * Body that must be contained in the health response. Default value is empty.␊ - */␊ - body?: string␊ - /**␊ - * Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399.␊ - */␊ - statusCodes?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend Address Pool of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddressPool14 {␊ - properties?: (ApplicationGatewayBackendAddressPoolPropertiesFormat14 | string)␊ - /**␊ - * Name of the backend address pool that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend Address Pool of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddressPoolPropertiesFormat14 {␊ - /**␊ - * Collection of references to IPs defined in network interfaces.␊ - */␊ - backendIPConfigurations?: (SubResource21[] | string)␊ - /**␊ - * Backend addresses␊ - */␊ - backendAddresses?: (ApplicationGatewayBackendAddress14[] | string)␊ - /**␊ - * Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddress14 {␊ - /**␊ - * Fully qualified domain name (FQDN).␊ - */␊ - fqdn?: string␊ - /**␊ - * IP address␊ - */␊ - ipAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address pool settings of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendHttpSettings14 {␊ - properties?: (ApplicationGatewayBackendHttpSettingsPropertiesFormat14 | string)␊ - /**␊ - * Name of the backend http settings that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend address pool settings of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendHttpSettingsPropertiesFormat14 {␊ - /**␊ - * The destination port on the backend.␊ - */␊ - port?: (number | string)␊ - /**␊ - * The protocol used to communicate with the backend. Possible values are 'Http' and 'Https'.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Cookie based affinity.␊ - */␊ - cookieBasedAffinity?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Request timeout in seconds. Application Gateway will fail the request if response is not received within RequestTimeout. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - requestTimeout?: (number | string)␊ - /**␊ - * Probe resource of an application gateway.␊ - */␊ - probe?: (SubResource21 | string)␊ - /**␊ - * Array of references to application gateway authentication certificates.␊ - */␊ - authenticationCertificates?: (SubResource21[] | string)␊ - /**␊ - * Array of references to application gateway trusted root certificates.␊ - */␊ - trustedRootCertificates?: (SubResource21[] | string)␊ - /**␊ - * Connection draining of the backend http settings resource.␊ - */␊ - connectionDraining?: (ApplicationGatewayConnectionDraining11 | string)␊ - /**␊ - * Host header to be sent to the backend servers.␊ - */␊ - hostName?: string␊ - /**␊ - * Whether to pick host header should be picked from the host name of the backend server. Default value is false.␊ - */␊ - pickHostNameFromBackendAddress?: (boolean | string)␊ - /**␊ - * Cookie name to use for the affinity cookie.␊ - */␊ - affinityCookieName?: string␊ - /**␊ - * Whether the probe is enabled. Default value is false.␊ - */␊ - probeEnabled?: (boolean | string)␊ - /**␊ - * Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null.␊ - */␊ - path?: string␊ - /**␊ - * Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Connection draining allows open connections to a backend server to be active for a specified time after the backend server got removed from the configuration.␊ - */␊ - export interface ApplicationGatewayConnectionDraining11 {␊ - /**␊ - * Whether connection draining is enabled or not.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds.␊ - */␊ - drainTimeoutInSec: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http listener of an application gateway.␊ - */␊ - export interface ApplicationGatewayHttpListener14 {␊ - properties?: (ApplicationGatewayHttpListenerPropertiesFormat14 | string)␊ - /**␊ - * Name of the HTTP listener that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of HTTP listener of an application gateway.␊ - */␊ - export interface ApplicationGatewayHttpListenerPropertiesFormat14 {␊ - /**␊ - * Frontend IP configuration resource of an application gateway.␊ - */␊ - frontendIPConfiguration?: (SubResource21 | string)␊ - /**␊ - * Frontend port resource of an application gateway.␊ - */␊ - frontendPort?: (SubResource21 | string)␊ - /**␊ - * Protocol of the HTTP listener. Possible values are 'Http' and 'Https'.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Host name of HTTP listener.␊ - */␊ - hostName?: string␊ - /**␊ - * SSL certificate resource of an application gateway.␊ - */␊ - sslCertificate?: (SubResource21 | string)␊ - /**␊ - * Applicable only if protocol is https. Enables SNI for multi-hosting.␊ - */␊ - requireServerNameIndication?: (boolean | string)␊ - /**␊ - * Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - /**␊ - * Custom error configurations of the HTTP listener.␊ - */␊ - customErrorConfigurations?: (ApplicationGatewayCustomError2[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Customer error of an application gateway.␊ - */␊ - export interface ApplicationGatewayCustomError2 {␊ - /**␊ - * Status code of the application gateway customer error.␊ - */␊ - statusCode?: (("HttpStatus403" | "HttpStatus502") | string)␊ - /**␊ - * Error page URL of the application gateway customer error.␊ - */␊ - customErrorPageUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * UrlPathMaps give a url path to the backend mapping information for PathBasedRouting.␊ - */␊ - export interface ApplicationGatewayUrlPathMap13 {␊ - properties?: (ApplicationGatewayUrlPathMapPropertiesFormat13 | string)␊ - /**␊ - * Name of the URL path map that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of UrlPathMap of the application gateway.␊ - */␊ - export interface ApplicationGatewayUrlPathMapPropertiesFormat13 {␊ - /**␊ - * Default backend address pool resource of URL path map.␊ - */␊ - defaultBackendAddressPool?: (SubResource21 | string)␊ - /**␊ - * Default backend http settings resource of URL path map.␊ - */␊ - defaultBackendHttpSettings?: (SubResource21 | string)␊ - /**␊ - * Default Rewrite rule set resource of URL path map.␊ - */␊ - defaultRewriteRuleSet?: (SubResource21 | string)␊ - /**␊ - * Default redirect configuration resource of URL path map.␊ - */␊ - defaultRedirectConfiguration?: (SubResource21 | string)␊ - /**␊ - * Path rule of URL path map resource.␊ - */␊ - pathRules?: (ApplicationGatewayPathRule13[] | string)␊ - /**␊ - * Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Path rule of URL path map of an application gateway.␊ - */␊ - export interface ApplicationGatewayPathRule13 {␊ - properties?: (ApplicationGatewayPathRulePropertiesFormat13 | string)␊ - /**␊ - * Name of the path rule that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of path rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayPathRulePropertiesFormat13 {␊ - /**␊ - * Path rules of URL path map.␊ - */␊ - paths?: (string[] | string)␊ - /**␊ - * Backend address pool resource of URL path map path rule.␊ - */␊ - backendAddressPool?: (SubResource21 | string)␊ - /**␊ - * Backend http settings resource of URL path map path rule.␊ - */␊ - backendHttpSettings?: (SubResource21 | string)␊ - /**␊ - * Redirect configuration resource of URL path map path rule.␊ - */␊ - redirectConfiguration?: (SubResource21 | string)␊ - /**␊ - * Rewrite rule set resource of URL path map path rule.␊ - */␊ - rewriteRuleSet?: (SubResource21 | string)␊ - /**␊ - * Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Request routing rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayRequestRoutingRule14 {␊ - properties?: (ApplicationGatewayRequestRoutingRulePropertiesFormat14 | string)␊ - /**␊ - * Name of the request routing rule that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of request routing rule of the application gateway.␊ - */␊ - export interface ApplicationGatewayRequestRoutingRulePropertiesFormat14 {␊ - /**␊ - * Rule type.␊ - */␊ - ruleType?: (("Basic" | "PathBasedRouting") | string)␊ - /**␊ - * Backend address pool resource of the application gateway. ␊ - */␊ - backendAddressPool?: (SubResource21 | string)␊ - /**␊ - * Backend http settings resource of the application gateway.␊ - */␊ - backendHttpSettings?: (SubResource21 | string)␊ - /**␊ - * Http listener resource of the application gateway. ␊ - */␊ - httpListener?: (SubResource21 | string)␊ - /**␊ - * URL path map resource of the application gateway.␊ - */␊ - urlPathMap?: (SubResource21 | string)␊ - /**␊ - * Rewrite Rule Set resource in Basic rule of the application gateway.␊ - */␊ - rewriteRuleSet?: (SubResource21 | string)␊ - /**␊ - * Redirect configuration resource of the application gateway.␊ - */␊ - redirectConfiguration?: (SubResource21 | string)␊ - /**␊ - * Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Rewrite rule set of an application gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRuleSet1 {␊ - properties?: (ApplicationGatewayRewriteRuleSetPropertiesFormat1 | string)␊ - /**␊ - * Name of the rewrite rule set that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of rewrite rule set of the application gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRuleSetPropertiesFormat1 {␊ - /**␊ - * Rewrite rules in the rewrite rule set.␊ - */␊ - rewriteRules?: (ApplicationGatewayRewriteRule1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Rewrite rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRule1 {␊ - /**␊ - * Name of the rewrite rule that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet.␊ - */␊ - ruleSequence?: (number | string)␊ - /**␊ - * Conditions based on which the action set execution will be evaluated.␊ - */␊ - conditions?: (ApplicationGatewayRewriteRuleCondition[] | string)␊ - /**␊ - * Set of actions to be done as part of the rewrite Rule.␊ - */␊ - actionSet?: (ApplicationGatewayRewriteRuleActionSet1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Set of conditions in the Rewrite Rule in Application Gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRuleCondition {␊ - /**␊ - * The condition parameter of the RewriteRuleCondition.␊ - */␊ - variable?: string␊ - /**␊ - * The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition␊ - */␊ - pattern?: string␊ - /**␊ - * Setting this paramter to truth value with force the pattern to do a case in-sensitive comparison.␊ - */␊ - ignoreCase?: (boolean | string)␊ - /**␊ - * Setting this value as truth will force to check the negation of the condition given by the user.␊ - */␊ - negate?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Set of actions in the Rewrite Rule in Application Gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRuleActionSet1 {␊ - /**␊ - * Request Header Actions in the Action Set␊ - */␊ - requestHeaderConfigurations?: (ApplicationGatewayHeaderConfiguration1[] | string)␊ - /**␊ - * Response Header Actions in the Action Set␊ - */␊ - responseHeaderConfigurations?: (ApplicationGatewayHeaderConfiguration1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Header configuration of the Actions set in Application Gateway.␊ - */␊ - export interface ApplicationGatewayHeaderConfiguration1 {␊ - /**␊ - * Header name of the header configuration␊ - */␊ - headerName?: string␊ - /**␊ - * Header value of the header configuration␊ - */␊ - headerValue?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Redirect configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayRedirectConfiguration11 {␊ - properties?: (ApplicationGatewayRedirectConfigurationPropertiesFormat11 | string)␊ - /**␊ - * Name of the redirect configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of redirect configuration of the application gateway.␊ - */␊ - export interface ApplicationGatewayRedirectConfigurationPropertiesFormat11 {␊ - /**␊ - * Supported http redirection types - Permanent, Temporary, Found, SeeOther.␊ - */␊ - redirectType?: (("Permanent" | "Found" | "SeeOther" | "Temporary") | string)␊ - /**␊ - * Reference to a listener to redirect the request to.␊ - */␊ - targetListener?: (SubResource21 | string)␊ - /**␊ - * Url to redirect the request to.␊ - */␊ - targetUrl?: string␊ - /**␊ - * Include path in the redirected url.␊ - */␊ - includePath?: (boolean | string)␊ - /**␊ - * Include query string in the redirected url.␊ - */␊ - includeQueryString?: (boolean | string)␊ - /**␊ - * Request routing specifying redirect configuration.␊ - */␊ - requestRoutingRules?: (SubResource21[] | string)␊ - /**␊ - * Url path maps specifying default redirect configuration.␊ - */␊ - urlPathMaps?: (SubResource21[] | string)␊ - /**␊ - * Path rules specifying redirect configuration.␊ - */␊ - pathRules?: (SubResource21[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application gateway web application firewall configuration.␊ - */␊ - export interface ApplicationGatewayWebApplicationFirewallConfiguration11 {␊ - /**␊ - * Whether the web application firewall is enabled or not.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * Web application firewall mode.␊ - */␊ - firewallMode: (("Detection" | "Prevention") | string)␊ - /**␊ - * The type of the web application firewall rule set. Possible values are: 'OWASP'.␊ - */␊ - ruleSetType: string␊ - /**␊ - * The version of the rule set type.␊ - */␊ - ruleSetVersion: string␊ - /**␊ - * The disabled rule groups.␊ - */␊ - disabledRuleGroups?: (ApplicationGatewayFirewallDisabledRuleGroup11[] | string)␊ - /**␊ - * Whether allow WAF to check request Body.␊ - */␊ - requestBodyCheck?: (boolean | string)␊ - /**␊ - * Maximum request body size for WAF.␊ - */␊ - maxRequestBodySize?: (number | string)␊ - /**␊ - * Maximum request body size in Kb for WAF.␊ - */␊ - maxRequestBodySizeInKb?: (number | string)␊ - /**␊ - * Maximum file upload size in Mb for WAF.␊ - */␊ - fileUploadLimitInMb?: (number | string)␊ - /**␊ - * The exclusion list.␊ - */␊ - exclusions?: (ApplicationGatewayFirewallExclusion2[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allows to disable rules within a rule group or an entire rule group.␊ - */␊ - export interface ApplicationGatewayFirewallDisabledRuleGroup11 {␊ - /**␊ - * The name of the rule group that will be disabled.␊ - */␊ - ruleGroupName: string␊ - /**␊ - * The list of rules that will be disabled. If null, all rules of the rule group will be disabled.␊ - */␊ - rules?: (number[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allow to exclude some variable satisfy the condition for the WAF check␊ - */␊ - export interface ApplicationGatewayFirewallExclusion2 {␊ - /**␊ - * The variable to be excluded.␊ - */␊ - matchVariable: string␊ - /**␊ - * When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to.␊ - */␊ - selectorMatchOperator: string␊ - /**␊ - * When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to.␊ - */␊ - selector: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application Gateway autoscale configuration.␊ - */␊ - export interface ApplicationGatewayAutoscaleConfiguration5 {␊ - /**␊ - * Lower bound on number of Application Gateway capacity␊ - */␊ - minCapacity: (number | string)␊ - /**␊ - * Upper bound on number of Application Gateway capacity␊ - */␊ - maxCapacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the resource.␊ - */␊ - export interface ManagedServiceIdentity1 {␊ - /**␊ - * The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.␊ - */␊ - type?: ("SystemAssigned" | "UserAssigned" | "SystemAssigned, UserAssigned" | "None")␊ - /**␊ - * The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.␊ - */␊ - userAssignedIdentities?: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/authorizations␊ - */␊ - export interface ExpressRouteCircuitsAuthorizations9 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/authorizations"␊ - apiVersion: "2018-12-01"␊ - properties: (AuthorizationPropertiesFormat9 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings␊ - */␊ - export interface ExpressRouteCircuitsPeerings8 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/peerings"␊ - apiVersion: "2018-12-01"␊ - properties: (ExpressRouteCircuitPeeringPropertiesFormat9 | string)␊ - resources?: ExpressRouteCircuitsPeeringsConnectionsChildResource6[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections/peerings␊ - */␊ - export interface ExpressRouteCrossConnectionsPeerings5 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCrossConnections/peerings"␊ - apiVersion: "2018-12-01"␊ - properties: (ExpressRouteCrossConnectionPeeringProperties6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers/inboundNatRules␊ - */␊ - export interface LoadBalancersInboundNatRules10 {␊ - name: string␊ - type: "Microsoft.Network/loadBalancers/inboundNatRules"␊ - apiVersion: "2018-12-01"␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties: (InboundNatRulePropertiesFormat15 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces/tapConfigurations␊ - */␊ - export interface NetworkInterfacesTapConfigurations1 {␊ - name: string␊ - type: "Microsoft.Network/networkInterfaces/tapConfigurations"␊ - apiVersion: "2018-12-01"␊ - /**␊ - * Properties of the Virtual Network Tap configuration␊ - */␊ - properties: (NetworkInterfaceTapConfigurationPropertiesFormat2 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRules14 {␊ - name: string␊ - type: "Microsoft.Network/networkSecurityGroups/securityRules"␊ - apiVersion: "2018-12-01"␊ - /**␊ - * Properties of the security rule␊ - */␊ - properties: (SecurityRulePropertiesFormat15 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutes14 {␊ - name: string␊ - type: "Microsoft.Network/routeTables/routes"␊ - apiVersion: "2018-12-01"␊ - /**␊ - * Properties of the route.␊ - */␊ - properties: (RoutePropertiesFormat15 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ExpressRoutePorts␊ - */␊ - export interface ExpressRoutePorts1 {␊ - name: string␊ - type: "Microsoft.Network/ExpressRoutePorts"␊ - apiVersion: "2018-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * ExpressRoutePort properties␊ - */␊ - properties: (ExpressRoutePortPropertiesFormat1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to ExpressRoutePort resources.␊ - */␊ - export interface ExpressRoutePortPropertiesFormat1 {␊ - /**␊ - * The name of the peering location that the ExpressRoutePort is mapped to physically.␊ - */␊ - peeringLocation?: string␊ - /**␊ - * Bandwidth of procured ports in Gbps␊ - */␊ - bandwidthInGbps?: (number | string)␊ - /**␊ - * Encapsulation method on physical ports.␊ - */␊ - encapsulation?: (("Dot1Q" | "QinQ") | string)␊ - /**␊ - * The set of physical links of the ExpressRoutePort resource␊ - */␊ - links?: (ExpressRouteLink1[] | string)␊ - /**␊ - * The resource GUID property of the ExpressRoutePort resource.␊ - */␊ - resourceGuid?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ExpressRouteLink child resource definition.␊ - */␊ - export interface ExpressRouteLink1 {␊ - /**␊ - * ExpressRouteLink properties␊ - */␊ - properties?: (ExpressRouteLinkPropertiesFormat1 | string)␊ - /**␊ - * Name of child port resource that is unique among child port resources of the parent.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to ExpressRouteLink resources.␊ - */␊ - export interface ExpressRouteLinkPropertiesFormat1 {␊ - /**␊ - * Administrative state of the physical port.␊ - */␊ - adminState?: (("Enabled" | "Disabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings/connections␊ - */␊ - export interface ExpressRouteCircuitsPeeringsConnections6 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/peerings/connections"␊ - apiVersion: "2018-12-01"␊ - properties: (ExpressRouteCircuitConnectionPropertiesFormat6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/applicationSecurityGroups␊ - */␊ - export interface ApplicationSecurityGroups12 {␊ - name: string␊ - type: "Microsoft.Network/applicationSecurityGroups"␊ - apiVersion: "2019-02-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the application security group.␊ - */␊ - properties: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ddosProtectionPlans␊ - */␊ - export interface DdosProtectionPlans7 {␊ - name: string␊ - type: "Microsoft.Network/ddosProtectionPlans"␊ - apiVersion: "2019-02-01"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the DDoS protection plan.␊ - */␊ - properties: (DdosProtectionPlanPropertiesFormat4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DDoS protection plan properties.␊ - */␊ - export interface DdosProtectionPlanPropertiesFormat4 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits␊ - */␊ - export interface ExpressRouteCircuits9 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits"␊ - apiVersion: "2019-02-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The SKU.␊ - */␊ - sku?: (ExpressRouteCircuitSku9 | string)␊ - /**␊ - * Properties of the express route circuit.␊ - */␊ - properties: (ExpressRouteCircuitPropertiesFormat9 | string)␊ - resources?: (ExpressRouteCircuitsPeeringsChildResource9 | ExpressRouteCircuitsAuthorizationsChildResource9)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains SKU in an ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitSku9 {␊ - /**␊ - * The name of the SKU.␊ - */␊ - name?: string␊ - /**␊ - * The tier of the SKU. Possible values are 'Standard', 'Premium' or 'Local'.␊ - */␊ - tier?: (("Standard" | "Premium" | "Basic" | "Local") | string)␊ - /**␊ - * The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'.␊ - */␊ - family?: (("UnlimitedData" | "MeteredData") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitPropertiesFormat9 {␊ - /**␊ - * Allow classic operations␊ - */␊ - allowClassicOperations?: (boolean | string)␊ - /**␊ - * The CircuitProvisioningState state of the resource.␊ - */␊ - circuitProvisioningState?: string␊ - /**␊ - * The ServiceProviderProvisioningState state of the resource.␊ - */␊ - serviceProviderProvisioningState?: (("NotProvisioned" | "Provisioning" | "Provisioned" | "Deprovisioning") | string)␊ - /**␊ - * The list of authorizations.␊ - */␊ - authorizations?: (ExpressRouteCircuitAuthorization9[] | string)␊ - /**␊ - * The list of peerings.␊ - */␊ - peerings?: (ExpressRouteCircuitPeering9[] | string)␊ - /**␊ - * The ServiceKey.␊ - */␊ - serviceKey?: string␊ - /**␊ - * The ServiceProviderNotes.␊ - */␊ - serviceProviderNotes?: string␊ - /**␊ - * The ServiceProviderProperties.␊ - */␊ - serviceProviderProperties?: (ExpressRouteCircuitServiceProviderProperties9 | string)␊ - /**␊ - * The reference to the ExpressRoutePort resource when the circuit is provisioned on an ExpressRoutePort resource.␊ - */␊ - expressRoutePort?: (SubResource22 | string)␊ - /**␊ - * The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource.␊ - */␊ - bandwidthInGbps?: (number | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - /**␊ - * Flag denoting Global reach status.␊ - */␊ - globalReachEnabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authorization in an ExpressRouteCircuit resource.␊ - */␊ - export interface ExpressRouteCircuitAuthorization9 {␊ - /**␊ - * Properties of the express route circuit authorization.␊ - */␊ - properties?: (AuthorizationPropertiesFormat10 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ExpressRouteCircuitAuthorization.␊ - */␊ - export interface AuthorizationPropertiesFormat10 {␊ - /**␊ - * The authorization key.␊ - */␊ - authorizationKey?: string␊ - /**␊ - * AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'.␊ - */␊ - authorizationUseStatus?: (("Available" | "InUse") | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peering in an ExpressRouteCircuit resource.␊ - */␊ - export interface ExpressRouteCircuitPeering9 {␊ - /**␊ - * Properties of the express route circuit peering.␊ - */␊ - properties?: (ExpressRouteCircuitPeeringPropertiesFormat10 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the express route circuit peering.␊ - */␊ - export interface ExpressRouteCircuitPeeringPropertiesFormat10 {␊ - /**␊ - * The peering type.␊ - */␊ - peeringType?: (("AzurePublicPeering" | "AzurePrivatePeering" | "MicrosoftPeering") | string)␊ - /**␊ - * The peering state.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * The Azure ASN.␊ - */␊ - azureASN?: (number | string)␊ - /**␊ - * The peer ASN.␊ - */␊ - peerASN?: (number | string)␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The primary port.␊ - */␊ - primaryAzurePort?: string␊ - /**␊ - * The secondary port.␊ - */␊ - secondaryAzurePort?: string␊ - /**␊ - * The shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The VLAN ID.␊ - */␊ - vlanId?: (number | string)␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig10 | string)␊ - /**␊ - * Gets peering stats.␊ - */␊ - stats?: (ExpressRouteCircuitStats10 | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - /**␊ - * Gets whether the provider or the customer last modified the peering.␊ - */␊ - lastModifiedBy?: string␊ - /**␊ - * The reference of the RouteFilter resource.␊ - */␊ - routeFilter?: (SubResource22 | string)␊ - /**␊ - * The IPv6 peering configuration.␊ - */␊ - ipv6PeeringConfig?: (Ipv6ExpressRouteCircuitPeeringConfig7 | string)␊ - /**␊ - * The ExpressRoute connection.␊ - */␊ - expressRouteConnection?: ({␊ - [k: string]: unknown␊ - } | string)␊ - /**␊ - * The list of circuit connections associated with Azure Private Peering for this circuit.␊ - */␊ - connections?: (ExpressRouteCircuitConnection7[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the peering configuration.␊ - */␊ - export interface ExpressRouteCircuitPeeringConfig10 {␊ - /**␊ - * The reference of AdvertisedPublicPrefixes.␊ - */␊ - advertisedPublicPrefixes?: (string[] | string)␊ - /**␊ - * The communities of bgp peering. Specified for microsoft peering␊ - */␊ - advertisedCommunities?: (string[] | string)␊ - /**␊ - * AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'.␊ - */␊ - advertisedPublicPrefixesState?: (("NotConfigured" | "Configuring" | "Configured" | "ValidationNeeded") | string)␊ - /**␊ - * The legacy mode of the peering.␊ - */␊ - legacyMode?: (number | string)␊ - /**␊ - * The CustomerASN of the peering.␊ - */␊ - customerASN?: (number | string)␊ - /**␊ - * The RoutingRegistryName of the configuration.␊ - */␊ - routingRegistryName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains stats associated with the peering.␊ - */␊ - export interface ExpressRouteCircuitStats10 {␊ - /**␊ - * Gets BytesIn of the peering.␊ - */␊ - primarybytesIn?: (number | string)␊ - /**␊ - * Gets BytesOut of the peering.␊ - */␊ - primarybytesOut?: (number | string)␊ - /**␊ - * Gets BytesIn of the peering.␊ - */␊ - secondarybytesIn?: (number | string)␊ - /**␊ - * Gets BytesOut of the peering.␊ - */␊ - secondarybytesOut?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Reference to another subresource.␊ - */␊ - export interface SubResource22 {␊ - /**␊ - * Resource ID.␊ - */␊ - id: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains IPv6 peering config.␊ - */␊ - export interface Ipv6ExpressRouteCircuitPeeringConfig7 {␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig10 | string)␊ - /**␊ - * The reference of the RouteFilter resource.␊ - */␊ - routeFilter?: (SubResource22 | string)␊ - /**␊ - * The state of peering. Possible values are: 'Disabled' and 'Enabled'.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Express Route Circuit Connection in an ExpressRouteCircuitPeering resource.␊ - */␊ - export interface ExpressRouteCircuitConnection7 {␊ - /**␊ - * Properties of the express route circuit connection.␊ - */␊ - properties?: (ExpressRouteCircuitConnectionPropertiesFormat7 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the express route circuit connection.␊ - */␊ - export interface ExpressRouteCircuitConnectionPropertiesFormat7 {␊ - /**␊ - * Reference to Express Route Circuit Private Peering Resource of the circuit initiating connection.␊ - */␊ - expressRouteCircuitPeering?: (SubResource22 | string)␊ - /**␊ - * Reference to Express Route Circuit Private Peering Resource of the peered circuit.␊ - */␊ - peerExpressRouteCircuitPeering?: (SubResource22 | string)␊ - /**␊ - * /29 IP address space to carve out Customer addresses for tunnels.␊ - */␊ - addressPrefix?: string␊ - /**␊ - * The authorization key.␊ - */␊ - authorizationKey?: string␊ - /**␊ - * Express Route Circuit connection state.␊ - */␊ - circuitConnectionStatus?: (("Connected" | "Connecting" | "Disconnected") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains ServiceProviderProperties in an ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitServiceProviderProperties9 {␊ - /**␊ - * The serviceProviderName.␊ - */␊ - serviceProviderName?: string␊ - /**␊ - * The peering location.␊ - */␊ - peeringLocation?: string␊ - /**␊ - * The BandwidthInMbps.␊ - */␊ - bandwidthInMbps?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings␊ - */␊ - export interface ExpressRouteCircuitsPeeringsChildResource9 {␊ - name: string␊ - type: "peerings"␊ - apiVersion: "2019-02-01"␊ - /**␊ - * Properties of the express route circuit peering.␊ - */␊ - properties: (ExpressRouteCircuitPeeringPropertiesFormat10 | string)␊ - resources?: ExpressRouteCircuitsPeeringsConnectionsChildResource7[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings/connections␊ - */␊ - export interface ExpressRouteCircuitsPeeringsConnectionsChildResource7 {␊ - name: string␊ - type: "connections"␊ - apiVersion: "2019-02-01"␊ - /**␊ - * Properties of the express route circuit connection.␊ - */␊ - properties: (ExpressRouteCircuitConnectionPropertiesFormat7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/authorizations␊ - */␊ - export interface ExpressRouteCircuitsAuthorizationsChildResource9 {␊ - name: string␊ - type: "authorizations"␊ - apiVersion: "2019-02-01"␊ - /**␊ - * Properties of the express route circuit authorization.␊ - */␊ - properties: (AuthorizationPropertiesFormat10 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections␊ - */␊ - export interface ExpressRouteCrossConnections7 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCrossConnections"␊ - apiVersion: "2019-02-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the express route cross connection.␊ - */␊ - properties: (ExpressRouteCrossConnectionProperties7 | string)␊ - resources?: ExpressRouteCrossConnectionsPeeringsChildResource7[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ExpressRouteCrossConnection.␊ - */␊ - export interface ExpressRouteCrossConnectionProperties7 {␊ - /**␊ - * The peering location of the ExpressRoute circuit.␊ - */␊ - peeringLocation?: string␊ - /**␊ - * The circuit bandwidth In Mbps.␊ - */␊ - bandwidthInMbps?: (number | string)␊ - /**␊ - * The ExpressRouteCircuit␊ - */␊ - expressRouteCircuit?: (ExpressRouteCircuitReference6 | string)␊ - /**␊ - * The provisioning state of the circuit in the connectivity provider system.␊ - */␊ - serviceProviderProvisioningState?: (("NotProvisioned" | "Provisioning" | "Provisioned" | "Deprovisioning") | string)␊ - /**␊ - * Additional read only notes set by the connectivity provider.␊ - */␊ - serviceProviderNotes?: string␊ - /**␊ - * The list of peerings.␊ - */␊ - peerings?: (ExpressRouteCrossConnectionPeering7[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Reference to an express route circuit.␊ - */␊ - export interface ExpressRouteCircuitReference6 {␊ - /**␊ - * Corresponding Express Route Circuit Id.␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peering in an ExpressRoute Cross Connection resource.␊ - */␊ - export interface ExpressRouteCrossConnectionPeering7 {␊ - /**␊ - * Properties of the express route cross connection peering.␊ - */␊ - properties?: (ExpressRouteCrossConnectionPeeringProperties7 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of express route cross connection peering.␊ - */␊ - export interface ExpressRouteCrossConnectionPeeringProperties7 {␊ - /**␊ - * The peering type.␊ - */␊ - peeringType?: (("AzurePublicPeering" | "AzurePrivatePeering" | "MicrosoftPeering") | string)␊ - /**␊ - * The peering state.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * The peer ASN.␊ - */␊ - peerASN?: (number | string)␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The VLAN ID.␊ - */␊ - vlanId?: (number | string)␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig10 | string)␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - /**␊ - * Gets whether the provider or the customer last modified the peering.␊ - */␊ - lastModifiedBy?: string␊ - /**␊ - * The IPv6 peering configuration.␊ - */␊ - ipv6PeeringConfig?: (Ipv6ExpressRouteCircuitPeeringConfig7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections/peerings␊ - */␊ - export interface ExpressRouteCrossConnectionsPeeringsChildResource7 {␊ - name: string␊ - type: "peerings"␊ - apiVersion: "2019-02-01"␊ - /**␊ - * Properties of the express route cross connection peering.␊ - */␊ - properties: (ExpressRouteCrossConnectionPeeringProperties7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/publicIPAddresses␊ - */␊ - export interface PublicIPAddresses24 {␊ - name: string␊ - type: "Microsoft.Network/publicIPAddresses"␊ - apiVersion: "2019-02-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The public IP address SKU.␊ - */␊ - sku?: (PublicIPAddressSku12 | string)␊ - /**␊ - * Public IP address properties.␊ - */␊ - properties: (PublicIPAddressPropertiesFormat15 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a public IP address␊ - */␊ - export interface PublicIPAddressSku12 {␊ - /**␊ - * Name of a public IP address SKU.␊ - */␊ - name?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Public IP address properties.␊ - */␊ - export interface PublicIPAddressPropertiesFormat15 {␊ - /**␊ - * The public IP address allocation method.␊ - */␊ - publicIPAllocationMethod: (("Static" | "Dynamic") | string)␊ - /**␊ - * The public IP address version.␊ - */␊ - publicIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The FQDN of the DNS record associated with the public IP address.␊ - */␊ - dnsSettings?: (PublicIPAddressDnsSettings23 | string)␊ - /**␊ - * The DDoS protection custom policy associated with the public IP address.␊ - */␊ - ddosSettings?: (DdosSettings1 | string)␊ - /**␊ - * The list of tags associated with the public IP address.␊ - */␊ - ipTags?: (IpTag9[] | string)␊ - /**␊ - * The IP address associated with the public IP address resource.␊ - */␊ - ipAddress?: string␊ - /**␊ - * The Public IP Prefix this Public IP Address should be allocated from.␊ - */␊ - publicIPPrefix?: (SubResource22 | string)␊ - /**␊ - * The idle timeout of the public IP address.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * The resource GUID property of the public IP resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains FQDN of the DNS record associated with the public IP address␊ - */␊ - export interface PublicIPAddressDnsSettings23 {␊ - /**␊ - * Gets or sets the Domain name label.The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.␊ - */␊ - domainNameLabel: string␊ - /**␊ - * Gets the FQDN, Fully qualified domain name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone.␊ - */␊ - fqdn?: string␊ - /**␊ - * Gets or Sets the Reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN. ␊ - */␊ - reverseFqdn?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains the DDoS protection settings of the public IP.␊ - */␊ - export interface DdosSettings1 {␊ - /**␊ - * The DDoS custom policy associated with the public IP.␊ - */␊ - ddosCustomPolicy?: (SubResource22 | string)␊ - /**␊ - * The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized.␊ - */␊ - protectionCoverage?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains the IpTag associated with the object␊ - */␊ - export interface IpTag9 {␊ - /**␊ - * Gets or sets the ipTag type: Example FirstPartyUsage.␊ - */␊ - ipTagType?: string␊ - /**␊ - * Gets or sets value of the IpTag associated with the public IP. Example SQL, Storage etc␊ - */␊ - tag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks␊ - */␊ - export interface VirtualNetworks24 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks"␊ - apiVersion: "2019-02-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network.␊ - */␊ - properties: (VirtualNetworkPropertiesFormat16 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: (VirtualNetworksVirtualNetworkPeeringsChildResource13 | VirtualNetworksSubnetsChildResource16)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the virtual network.␊ - */␊ - export interface VirtualNetworkPropertiesFormat16 {␊ - /**␊ - * The AddressSpace that contains an array of IP address ranges that can be used by subnets.␊ - */␊ - addressSpace: (AddressSpace24 | string)␊ - /**␊ - * The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network.␊ - */␊ - dhcpOptions?: (DhcpOptions24 | string)␊ - /**␊ - * A list of subnets in a Virtual Network.␊ - */␊ - subnets?: (Subnet26[] | string)␊ - /**␊ - * A list of peerings in a Virtual Network.␊ - */␊ - virtualNetworkPeerings?: (VirtualNetworkPeering21[] | string)␊ - /**␊ - * The resourceGuid property of the Virtual Network resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - /**␊ - * Indicates if DDoS protection is enabled for all the protected resources in the virtual network. It requires a DDoS protection plan associated with the resource.␊ - */␊ - enableDdosProtection?: (boolean | string)␊ - /**␊ - * Indicates if VM protection is enabled for all the subnets in the virtual network.␊ - */␊ - enableVmProtection?: (boolean | string)␊ - /**␊ - * The DDoS protection plan associated with the virtual network.␊ - */␊ - ddosProtectionPlan?: (SubResource22 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.␊ - */␊ - export interface AddressSpace24 {␊ - /**␊ - * A list of address blocks reserved for this virtual network in CIDR notation.␊ - */␊ - addressPrefixes: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DhcpOptions contains an array of DNS servers available to VMs deployed in the virtual network. Standard DHCP option for a subnet overrides VNET DHCP options.␊ - */␊ - export interface DhcpOptions24 {␊ - /**␊ - * The list of DNS servers IP addresses.␊ - */␊ - dnsServers: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Subnet in a virtual network resource.␊ - */␊ - export interface Subnet26 {␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties?: (SubnetPropertiesFormat16 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the subnet.␊ - */␊ - export interface SubnetPropertiesFormat16 {␊ - /**␊ - * The address prefix for the subnet.␊ - */␊ - addressPrefix: string␊ - /**␊ - * List of address prefixes for the subnet.␊ - */␊ - addressPrefixes?: (string[] | string)␊ - /**␊ - * The reference of the NetworkSecurityGroup resource.␊ - */␊ - networkSecurityGroup?: (SubResource22 | string)␊ - /**␊ - * The reference of the RouteTable resource.␊ - */␊ - routeTable?: (SubResource22 | string)␊ - /**␊ - * Nat gateway associated with this subnet.␊ - */␊ - natGateway?: (SubResource22 | string)␊ - /**␊ - * An array of service endpoints.␊ - */␊ - serviceEndpoints?: (ServiceEndpointPropertiesFormat12[] | string)␊ - /**␊ - * An array of service endpoint policies.␊ - */␊ - serviceEndpointPolicies?: (SubResource22[] | string)␊ - /**␊ - * Gets an array of references to the external resources using subnet.␊ - */␊ - resourceNavigationLinks?: (ResourceNavigationLink13[] | string)␊ - /**␊ - * Gets an array of references to services injecting into this subnet.␊ - */␊ - serviceAssociationLinks?: (ServiceAssociationLink3[] | string)␊ - /**␊ - * Gets an array of references to the delegations on the subnet.␊ - */␊ - delegations?: (Delegation3[] | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The service endpoint properties.␊ - */␊ - export interface ServiceEndpointPropertiesFormat12 {␊ - /**␊ - * The type of the endpoint service.␊ - */␊ - service?: string␊ - /**␊ - * A list of locations.␊ - */␊ - locations?: (string[] | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ResourceNavigationLink resource.␊ - */␊ - export interface ResourceNavigationLink13 {␊ - /**␊ - * Resource navigation link properties format.␊ - */␊ - properties?: (ResourceNavigationLinkFormat13 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ResourceNavigationLink.␊ - */␊ - export interface ResourceNavigationLinkFormat13 {␊ - /**␊ - * Resource type of the linked resource.␊ - */␊ - linkedResourceType?: string␊ - /**␊ - * Link to the external resource␊ - */␊ - link?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ServiceAssociationLink resource.␊ - */␊ - export interface ServiceAssociationLink3 {␊ - /**␊ - * Resource navigation link properties format.␊ - */␊ - properties?: (ServiceAssociationLinkPropertiesFormat3 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ServiceAssociationLink.␊ - */␊ - export interface ServiceAssociationLinkPropertiesFormat3 {␊ - /**␊ - * Resource type of the linked resource.␊ - */␊ - linkedResourceType?: string␊ - /**␊ - * Link to the external resource.␊ - */␊ - link?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Details the service to which the subnet is delegated.␊ - */␊ - export interface Delegation3 {␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties?: (ServiceDelegationPropertiesFormat3 | string)␊ - /**␊ - * The name of the resource that is unique within a subnet. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a service delegation.␊ - */␊ - export interface ServiceDelegationPropertiesFormat3 {␊ - /**␊ - * The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers)␊ - */␊ - serviceName?: string␊ - /**␊ - * Describes the actions permitted to the service upon delegation␊ - */␊ - actions?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peerings in a virtual network resource.␊ - */␊ - export interface VirtualNetworkPeering21 {␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties?: (VirtualNetworkPeeringPropertiesFormat13 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - export interface VirtualNetworkPeeringPropertiesFormat13 {␊ - /**␊ - * Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space.␊ - */␊ - allowVirtualNetworkAccess?: (boolean | string)␊ - /**␊ - * Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network.␊ - */␊ - allowForwardedTraffic?: (boolean | string)␊ - /**␊ - * If gateway links can be used in remote virtual networking to link to this virtual network.␊ - */␊ - allowGatewayTransit?: (boolean | string)␊ - /**␊ - * If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway.␊ - */␊ - useRemoteGateways?: (boolean | string)␊ - /**␊ - * The reference of the remote virtual network. The remote virtual network can be in the same or different region (preview). See here to register for the preview and learn more (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering).␊ - */␊ - remoteVirtualNetwork: (SubResource22 | string)␊ - /**␊ - * The reference of the remote virtual network address space.␊ - */␊ - remoteAddressSpace?: (AddressSpace24 | string)␊ - /**␊ - * The status of the virtual network peering. Possible values are 'Initiated', 'Connected', and 'Disconnected'.␊ - */␊ - peeringState?: (("Initiated" | "Connected" | "Disconnected") | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/virtualNetworkPeerings␊ - */␊ - export interface VirtualNetworksVirtualNetworkPeeringsChildResource13 {␊ - name: string␊ - type: "virtualNetworkPeerings"␊ - apiVersion: "2019-02-01"␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties: (VirtualNetworkPeeringPropertiesFormat13 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnetsChildResource16 {␊ - name: string␊ - type: "subnets"␊ - apiVersion: "2019-02-01"␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties: (SubnetPropertiesFormat16 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers␊ - */␊ - export interface LoadBalancers24 {␊ - name: string␊ - type: "Microsoft.Network/loadBalancers"␊ - apiVersion: "2019-02-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The load balancer SKU.␊ - */␊ - sku?: (LoadBalancerSku12 | string)␊ - /**␊ - * Properties of load balancer.␊ - */␊ - properties: (LoadBalancerPropertiesFormat16 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: LoadBalancersInboundNatRulesChildResource12[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a load balancer␊ - */␊ - export interface LoadBalancerSku12 {␊ - /**␊ - * Name of a load balancer SKU.␊ - */␊ - name?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer.␊ - */␊ - export interface LoadBalancerPropertiesFormat16 {␊ - /**␊ - * Object representing the frontend IPs to be used for the load balancer␊ - */␊ - frontendIPConfigurations?: (FrontendIPConfiguration15[] | string)␊ - /**␊ - * Collection of backend address pools used by a load balancer␊ - */␊ - backendAddressPools?: (BackendAddressPool16[] | string)␊ - /**␊ - * Object collection representing the load balancing rules Gets the provisioning ␊ - */␊ - loadBalancingRules?: (LoadBalancingRule16[] | string)␊ - /**␊ - * Collection of probe objects used in the load balancer␊ - */␊ - probes?: (Probe16[] | string)␊ - /**␊ - * Collection of inbound NAT Rules used by a load balancer. Defining inbound NAT rules on your load balancer is mutually exclusive with defining an inbound NAT pool. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an Inbound NAT pool. They have to reference individual inbound NAT rules.␊ - */␊ - inboundNatRules?: (InboundNatRule17[] | string)␊ - /**␊ - * Defines an external port range for inbound NAT to a single backend port on NICs associated with a load balancer. Inbound NAT rules are created automatically for each NIC associated with the Load Balancer using an external port from this range. Defining an Inbound NAT pool on your Load Balancer is mutually exclusive with defining inbound Nat rules. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an inbound NAT pool. They have to reference individual inbound NAT rules.␊ - */␊ - inboundNatPools?: (InboundNatPool17[] | string)␊ - /**␊ - * The outbound rules.␊ - */␊ - outboundRules?: (OutboundRule4[] | string)␊ - /**␊ - * The resource GUID property of the load balancer resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP address of the load balancer.␊ - */␊ - export interface FrontendIPConfiguration15 {␊ - /**␊ - * Properties of the load balancer probe.␊ - */␊ - properties?: (FrontendIPConfigurationPropertiesFormat15 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP Configuration of the load balancer.␊ - */␊ - export interface FrontendIPConfigurationPropertiesFormat15 {␊ - /**␊ - * The private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The Private IP allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * The reference of the subnet resource.␊ - */␊ - subnet?: (SubResource22 | string)␊ - /**␊ - * The reference of the Public IP resource.␊ - */␊ - publicIPAddress?: (SubResource22 | string)␊ - /**␊ - * The reference of the Public IP Prefix resource.␊ - */␊ - publicIPPrefix?: (SubResource22 | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Pool of backend IP addresses.␊ - */␊ - export interface BackendAddressPool16 {␊ - /**␊ - * Properties of load balancer backend address pool.␊ - */␊ - properties?: (BackendAddressPoolPropertiesFormat16 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the backend address pool.␊ - */␊ - export interface BackendAddressPoolPropertiesFormat16 {␊ - /**␊ - * Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A load balancing rule for a load balancer.␊ - */␊ - export interface LoadBalancingRule16 {␊ - /**␊ - * Properties of load balancer load balancing rule.␊ - */␊ - properties?: (LoadBalancingRulePropertiesFormat16 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer.␊ - */␊ - export interface LoadBalancingRulePropertiesFormat16 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource22 | string)␊ - /**␊ - * A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs.␊ - */␊ - backendAddressPool?: (SubResource22 | string)␊ - /**␊ - * The reference of the load balancer probe used by the load balancing rule.␊ - */␊ - probe?: (SubResource22 | string)␊ - /**␊ - * The reference to the transport protocol used by the load balancing rule.␊ - */␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'.␊ - */␊ - loadDistribution?: (("Default" | "SourceIP" | "SourceIPProtocol") | string)␊ - /**␊ - * The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 0 and 65534. Note that value 0 enables "Any Port"␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port"␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - /**␊ - * Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule.␊ - */␊ - disableOutboundSnat?: (boolean | string)␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A load balancer probe.␊ - */␊ - export interface Probe16 {␊ - /**␊ - * Properties of load balancer probe.␊ - */␊ - properties?: (ProbePropertiesFormat16 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Load balancer probe resource.␊ - */␊ - export interface ProbePropertiesFormat16 {␊ - /**␊ - * The protocol of the end point. Possible values are: 'Http', 'Tcp', or 'Https'. If 'Tcp' is specified, a received ACK is required for the probe to be successful. If 'Http' or 'Https' is specified, a 200 OK response from the specifies URI is required for the probe to be successful.␊ - */␊ - protocol: (("Http" | "Tcp" | "Https") | string)␊ - /**␊ - * The port for communicating the probe. Possible values range from 1 to 65535, inclusive.␊ - */␊ - port: (number | string)␊ - /**␊ - * The interval, in seconds, for how frequently to probe the endpoint for health status. Typically, the interval is slightly less than half the allocated timeout period (in seconds) which allows two full probes before taking the instance out of rotation. The default value is 15, the minimum value is 5.␊ - */␊ - intervalInSeconds?: (number | string)␊ - /**␊ - * The number of probes where if no response, will result in stopping further traffic from being delivered to the endpoint. This values allows endpoints to be taken out of rotation faster or slower than the typical times used in Azure.␊ - */␊ - numberOfProbes: (number | string)␊ - /**␊ - * The URI used for requesting health status from the VM. Path is required if a protocol is set to http. Otherwise, it is not allowed. There is no default value.␊ - */␊ - requestPath?: string␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT rule of the load balancer.␊ - */␊ - export interface InboundNatRule17 {␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties?: (InboundNatRulePropertiesFormat16 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the inbound NAT rule.␊ - */␊ - export interface InboundNatRulePropertiesFormat16 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource22 | string)␊ - /**␊ - * The reference to the transport protocol used by the load balancing rule.␊ - */␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values range from 1 to 65534.␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * The port used for the internal endpoint. Acceptable values range from 1 to 65535.␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT pool of the load balancer.␊ - */␊ - export interface InboundNatPool17 {␊ - /**␊ - * Properties of load balancer inbound nat pool.␊ - */␊ - properties?: (InboundNatPoolPropertiesFormat16 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Inbound NAT pool.␊ - */␊ - export interface InboundNatPoolPropertiesFormat16 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource22 | string)␊ - /**␊ - * The reference to the transport protocol used by the inbound NAT pool.␊ - */␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65534.␊ - */␊ - frontendPortRangeStart: (number | string)␊ - /**␊ - * The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65535.␊ - */␊ - frontendPortRangeEnd: (number | string)␊ - /**␊ - * The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound pool of the load balancer.␊ - */␊ - export interface OutboundRule4 {␊ - /**␊ - * Properties of load balancer outbound rule.␊ - */␊ - properties?: (OutboundRulePropertiesFormat4 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound pool of the load balancer.␊ - */␊ - export interface OutboundRulePropertiesFormat4 {␊ - /**␊ - * The number of outbound ports to be used for NAT.␊ - */␊ - allocatedOutboundPorts?: (number | string)␊ - /**␊ - * The Frontend IP addresses of the load balancer.␊ - */␊ - frontendIPConfigurations: (SubResource22[] | string)␊ - /**␊ - * A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs.␊ - */␊ - backendAddressPool: (SubResource22 | string)␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - /**␊ - * The protocol for the outbound rule in load balancer. Possible values are: 'Tcp', 'Udp', and 'All'.␊ - */␊ - protocol: (("Tcp" | "Udp" | "All") | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - /**␊ - * The timeout for the TCP idle connection␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers/inboundNatRules␊ - */␊ - export interface LoadBalancersInboundNatRulesChildResource12 {␊ - name: string␊ - type: "inboundNatRules"␊ - apiVersion: "2019-02-01"␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties: (InboundNatRulePropertiesFormat16 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups␊ - */␊ - export interface NetworkSecurityGroups24 {␊ - name: string␊ - type: "Microsoft.Network/networkSecurityGroups"␊ - apiVersion: "2019-02-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network security group␊ - */␊ - properties: (NetworkSecurityGroupPropertiesFormat16 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: NetworkSecurityGroupsSecurityRulesChildResource16[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network Security Group resource.␊ - */␊ - export interface NetworkSecurityGroupPropertiesFormat16 {␊ - /**␊ - * A collection of security rules of the network security group.␊ - */␊ - securityRules?: (SecurityRule16[] | string)␊ - /**␊ - * The default security rules of network security group.␊ - */␊ - defaultSecurityRules?: (SecurityRule16[] | string)␊ - /**␊ - * The resource GUID property of the network security group resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network security rule.␊ - */␊ - export interface SecurityRule16 {␊ - /**␊ - * Properties of the security rule␊ - */␊ - properties?: (SecurityRulePropertiesFormat16 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Security rule resource.␊ - */␊ - export interface SecurityRulePropertiesFormat16 {␊ - /**␊ - * A description for this rule. Restricted to 140 chars.␊ - */␊ - description?: string␊ - /**␊ - * Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', 'Icmp', 'Esp', and '*'.␊ - */␊ - protocol: (("Tcp" | "Udp" | "Icmp" | "Esp" | "*") | string)␊ - /**␊ - * The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.␊ - */␊ - sourcePortRange?: string␊ - /**␊ - * The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.␊ - */␊ - destinationPortRange?: string␊ - /**␊ - * The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. ␊ - */␊ - sourceAddressPrefix?: string␊ - /**␊ - * The CIDR or source IP ranges.␊ - */␊ - sourceAddressPrefixes?: (string[] | string)␊ - /**␊ - * The application security group specified as source.␊ - */␊ - sourceApplicationSecurityGroups?: (SubResource22[] | string)␊ - /**␊ - * The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used.␊ - */␊ - destinationAddressPrefix?: string␊ - /**␊ - * The destination address prefixes. CIDR or destination IP ranges.␊ - */␊ - destinationAddressPrefixes?: (string[] | string)␊ - /**␊ - * The application security group specified as destination.␊ - */␊ - destinationApplicationSecurityGroups?: (SubResource22[] | string)␊ - /**␊ - * The source port ranges.␊ - */␊ - sourcePortRanges?: (string[] | string)␊ - /**␊ - * The destination port ranges.␊ - */␊ - destinationPortRanges?: (string[] | string)␊ - /**␊ - * The network traffic is allowed or denied.␊ - */␊ - access: (("Allow" | "Deny") | string)␊ - /**␊ - * The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.␊ - */␊ - priority: (number | string)␊ - /**␊ - * The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic.␊ - */␊ - direction: (("Inbound" | "Outbound") | string)␊ - /**␊ - * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRulesChildResource16 {␊ - name: string␊ - type: "securityRules"␊ - apiVersion: "2019-02-01"␊ - /**␊ - * Properties of the security rule␊ - */␊ - properties: (SecurityRulePropertiesFormat16 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces␊ - */␊ - export interface NetworkInterfaces25 {␊ - name: string␊ - type: "Microsoft.Network/networkInterfaces"␊ - apiVersion: "2019-02-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network interface.␊ - */␊ - properties: (NetworkInterfacePropertiesFormat16 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: NetworkInterfacesTapConfigurationsChildResource3[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NetworkInterface properties. ␊ - */␊ - export interface NetworkInterfacePropertiesFormat16 {␊ - /**␊ - * The reference of the NetworkSecurityGroup resource.␊ - */␊ - networkSecurityGroup?: (SubResource22 | string)␊ - /**␊ - * A list of IPConfigurations of the network interface.␊ - */␊ - ipConfigurations: (NetworkInterfaceIPConfiguration15[] | string)␊ - /**␊ - * A list of TapConfigurations of the network interface.␊ - */␊ - tapConfigurations?: (NetworkInterfaceTapConfiguration3[] | string)␊ - /**␊ - * The DNS settings in network interface.␊ - */␊ - dnsSettings?: (NetworkInterfaceDnsSettings24 | string)␊ - /**␊ - * The MAC address of the network interface.␊ - */␊ - macAddress?: string␊ - /**␊ - * Gets whether this is a primary network interface on a virtual machine.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * If the network interface is accelerated networking enabled.␊ - */␊ - enableAcceleratedNetworking?: (boolean | string)␊ - /**␊ - * Indicates whether IP forwarding is enabled on this network interface.␊ - */␊ - enableIPForwarding?: (boolean | string)␊ - /**␊ - * The resource GUID property of the network interface resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IPConfiguration in a network interface.␊ - */␊ - export interface NetworkInterfaceIPConfiguration15 {␊ - /**␊ - * Network interface IP configuration properties.␊ - */␊ - properties?: (NetworkInterfaceIPConfigurationPropertiesFormat15 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration.␊ - */␊ - export interface NetworkInterfaceIPConfigurationPropertiesFormat15 {␊ - /**␊ - * The reference to Virtual Network Taps.␊ - */␊ - virtualNetworkTaps?: (SubResource22[] | string)␊ - /**␊ - * The reference of ApplicationGatewayBackendAddressPool resource.␊ - */␊ - applicationGatewayBackendAddressPools?: (SubResource22[] | string)␊ - /**␊ - * The reference of LoadBalancerBackendAddressPool resource.␊ - */␊ - loadBalancerBackendAddressPools?: (SubResource22[] | string)␊ - /**␊ - * A list of references of LoadBalancerInboundNatRules.␊ - */␊ - loadBalancerInboundNatRules?: (SubResource22[] | string)␊ - /**␊ - * Private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The private IP address allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Available from Api-Version 2016-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4.␊ - */␊ - privateIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * Subnet bound to the IP configuration.␊ - */␊ - subnet?: (SubResource22 | string)␊ - /**␊ - * Gets whether this is a primary customer address on the network interface.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * Public IP address bound to the IP configuration.␊ - */␊ - publicIPAddress?: (SubResource22 | string)␊ - /**␊ - * Application security groups in which the IP configuration is included.␊ - */␊ - applicationSecurityGroups?: (SubResource22[] | string)␊ - /**␊ - * The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Tap configuration in a Network Interface␊ - */␊ - export interface NetworkInterfaceTapConfiguration3 {␊ - /**␊ - * Properties of the Virtual Network Tap configuration␊ - */␊ - properties?: (NetworkInterfaceTapConfigurationPropertiesFormat3 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Virtual Network Tap configuration.␊ - */␊ - export interface NetworkInterfaceTapConfigurationPropertiesFormat3 {␊ - /**␊ - * The reference of the Virtual Network Tap resource.␊ - */␊ - virtualNetworkTap?: (SubResource22 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DNS settings of a network interface.␊ - */␊ - export interface NetworkInterfaceDnsSettings24 {␊ - /**␊ - * List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only value in dnsServers collection.␊ - */␊ - dnsServers?: (string[] | string)␊ - /**␊ - * If the VM that uses this NIC is part of an Availability Set, then this list will have the union of all DNS servers from all NICs that are part of the Availability Set. This property is what is configured on each of those VMs.␊ - */␊ - appliedDnsServers?: (string[] | string)␊ - /**␊ - * Relative DNS name for this NIC used for internal communications between VMs in the same virtual network.␊ - */␊ - internalDnsNameLabel?: string␊ - /**␊ - * Fully qualified DNS name supporting internal communications between VMs in the same virtual network.␊ - */␊ - internalFqdn?: string␊ - /**␊ - * Even if internalDnsNameLabel is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internalDomainNameSuffix.␊ - */␊ - internalDomainNameSuffix?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces/tapConfigurations␊ - */␊ - export interface NetworkInterfacesTapConfigurationsChildResource3 {␊ - name: string␊ - type: "tapConfigurations"␊ - apiVersion: "2019-02-01"␊ - /**␊ - * Properties of the Virtual Network Tap configuration␊ - */␊ - properties: (NetworkInterfaceTapConfigurationPropertiesFormat3 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables␊ - */␊ - export interface RouteTables24 {␊ - name: string␊ - type: "Microsoft.Network/routeTables"␊ - apiVersion: "2019-02-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the route table.␊ - */␊ - properties: (RouteTablePropertiesFormat16 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: RouteTablesRoutesChildResource16[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Table resource␊ - */␊ - export interface RouteTablePropertiesFormat16 {␊ - /**␊ - * Collection of routes contained within a route table.␊ - */␊ - routes?: (Route16[] | string)␊ - /**␊ - * Gets or sets whether to disable the routes learned by BGP on that route table. True means disable.␊ - */␊ - disableBgpRoutePropagation?: (boolean | string)␊ - /**␊ - * The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource␊ - */␊ - export interface Route16 {␊ - /**␊ - * Properties of the route.␊ - */␊ - properties?: (RoutePropertiesFormat16 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource␊ - */␊ - export interface RoutePropertiesFormat16 {␊ - /**␊ - * The destination CIDR to which the route applies.␊ - */␊ - addressPrefix: string␊ - /**␊ - * The type of Azure hop the packet should be sent to.␊ - */␊ - nextHopType: (("VirtualNetworkGateway" | "VnetLocal" | "Internet" | "VirtualAppliance" | "None") | string)␊ - /**␊ - * The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.␊ - */␊ - nextHopIpAddress?: string␊ - /**␊ - * The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutesChildResource16 {␊ - name: string␊ - type: "routes"␊ - apiVersion: "2019-02-01"␊ - /**␊ - * Properties of the route.␊ - */␊ - properties: (RoutePropertiesFormat16 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/applicationGateways␊ - */␊ - export interface ApplicationGateways15 {␊ - name: string␊ - type: "Microsoft.Network/applicationGateways"␊ - apiVersion: "2019-02-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the application gateway.␊ - */␊ - properties: (ApplicationGatewayPropertiesFormat15 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * A list of availability zones denoting where the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - /**␊ - * The identity of the application gateway, if configured.␊ - */␊ - identity?: (ManagedServiceIdentity2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application gateway.␊ - */␊ - export interface ApplicationGatewayPropertiesFormat15 {␊ - /**␊ - * SKU of the application gateway resource.␊ - */␊ - sku?: (ApplicationGatewaySku15 | string)␊ - /**␊ - * SSL policy of the application gateway resource.␊ - */␊ - sslPolicy?: (ApplicationGatewaySslPolicy12 | string)␊ - /**␊ - * Subnets of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - gatewayIPConfigurations?: (ApplicationGatewayIPConfiguration15[] | string)␊ - /**␊ - * Authentication certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - authenticationCertificates?: (ApplicationGatewayAuthenticationCertificate12[] | string)␊ - /**␊ - * Trusted Root certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - trustedRootCertificates?: (ApplicationGatewayTrustedRootCertificate3[] | string)␊ - /**␊ - * SSL certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - sslCertificates?: (ApplicationGatewaySslCertificate15[] | string)␊ - /**␊ - * Frontend IP addresses of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - frontendIPConfigurations?: (ApplicationGatewayFrontendIPConfiguration15[] | string)␊ - /**␊ - * Frontend ports of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - frontendPorts?: (ApplicationGatewayFrontendPort15[] | string)␊ - /**␊ - * Probes of the application gateway resource.␊ - */␊ - probes?: (ApplicationGatewayProbe14[] | string)␊ - /**␊ - * Backend address pool of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - backendAddressPools?: (ApplicationGatewayBackendAddressPool15[] | string)␊ - /**␊ - * Backend http settings of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - backendHttpSettingsCollection?: (ApplicationGatewayBackendHttpSettings15[] | string)␊ - /**␊ - * Http listeners of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - httpListeners?: (ApplicationGatewayHttpListener15[] | string)␊ - /**␊ - * URL path map of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - urlPathMaps?: (ApplicationGatewayUrlPathMap14[] | string)␊ - /**␊ - * Request routing rules of the application gateway resource.␊ - */␊ - requestRoutingRules?: (ApplicationGatewayRequestRoutingRule15[] | string)␊ - /**␊ - * Rewrite rules for the application gateway resource.␊ - */␊ - rewriteRuleSets?: (ApplicationGatewayRewriteRuleSet2[] | string)␊ - /**␊ - * Redirect configurations of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - redirectConfigurations?: (ApplicationGatewayRedirectConfiguration12[] | string)␊ - /**␊ - * Web application firewall configuration.␊ - */␊ - webApplicationFirewallConfiguration?: (ApplicationGatewayWebApplicationFirewallConfiguration12 | string)␊ - /**␊ - * Reference of the FirewallPolicy resource.␊ - */␊ - firewallPolicy?: (SubResource22 | string)␊ - /**␊ - * Whether HTTP2 is enabled on the application gateway resource.␊ - */␊ - enableHttp2?: (boolean | string)␊ - /**␊ - * Whether FIPS is enabled on the application gateway resource.␊ - */␊ - enableFips?: (boolean | string)␊ - /**␊ - * Autoscale Configuration.␊ - */␊ - autoscaleConfiguration?: (ApplicationGatewayAutoscaleConfiguration6 | string)␊ - /**␊ - * Resource GUID property of the application gateway resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - /**␊ - * Custom error configurations of the application gateway resource.␊ - */␊ - customErrorConfigurations?: (ApplicationGatewayCustomError3[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of an application gateway␊ - */␊ - export interface ApplicationGatewaySku15 {␊ - /**␊ - * Name of an application gateway SKU.␊ - */␊ - name?: (("Standard_Small" | "Standard_Medium" | "Standard_Large" | "WAF_Medium" | "WAF_Large" | "Standard_v2" | "WAF_v2") | string)␊ - /**␊ - * Tier of an application gateway.␊ - */␊ - tier?: (("Standard" | "WAF" | "Standard_v2" | "WAF_v2") | string)␊ - /**␊ - * Capacity (instance count) of an application gateway.␊ - */␊ - capacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application Gateway Ssl policy.␊ - */␊ - export interface ApplicationGatewaySslPolicy12 {␊ - /**␊ - * Ssl protocols to be disabled on application gateway.␊ - */␊ - disabledSslProtocols?: (("TLSv1_0" | "TLSv1_1" | "TLSv1_2")[] | string)␊ - /**␊ - * Type of Ssl Policy.␊ - */␊ - policyType?: (("Predefined" | "Custom") | string)␊ - /**␊ - * Name of Ssl predefined policy.␊ - */␊ - policyName?: (("AppGwSslPolicy20150501" | "AppGwSslPolicy20170401" | "AppGwSslPolicy20170401S") | string)␊ - /**␊ - * Ssl cipher suites to be enabled in the specified order to application gateway.␊ - */␊ - cipherSuites?: (("TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384" | "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256" | "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA" | "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA" | "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384" | "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256" | "TLS_DHE_RSA_WITH_AES_256_CBC_SHA" | "TLS_DHE_RSA_WITH_AES_128_CBC_SHA" | "TLS_RSA_WITH_AES_256_GCM_SHA384" | "TLS_RSA_WITH_AES_128_GCM_SHA256" | "TLS_RSA_WITH_AES_256_CBC_SHA256" | "TLS_RSA_WITH_AES_128_CBC_SHA256" | "TLS_RSA_WITH_AES_256_CBC_SHA" | "TLS_RSA_WITH_AES_128_CBC_SHA" | "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384" | "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256" | "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384" | "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256" | "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA" | "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA" | "TLS_DHE_DSS_WITH_AES_256_CBC_SHA256" | "TLS_DHE_DSS_WITH_AES_128_CBC_SHA256" | "TLS_DHE_DSS_WITH_AES_256_CBC_SHA" | "TLS_DHE_DSS_WITH_AES_128_CBC_SHA" | "TLS_RSA_WITH_3DES_EDE_CBC_SHA" | "TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA" | "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256" | "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384")[] | string)␊ - /**␊ - * Minimum version of Ssl protocol to be supported on application gateway.␊ - */␊ - minProtocolVersion?: (("TLSv1_0" | "TLSv1_1" | "TLSv1_2") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed.␊ - */␊ - export interface ApplicationGatewayIPConfiguration15 {␊ - /**␊ - * Properties of the application gateway IP configuration.␊ - */␊ - properties?: (ApplicationGatewayIPConfigurationPropertiesFormat15 | string)␊ - /**␊ - * Name of the IP configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayIPConfigurationPropertiesFormat15 {␊ - /**␊ - * Reference of the subnet resource. A subnet from where application gateway gets its private address.␊ - */␊ - subnet?: (SubResource22 | string)␊ - /**␊ - * Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authentication certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewayAuthenticationCertificate12 {␊ - /**␊ - * Properties of the application gateway authentication certificate.␊ - */␊ - properties?: (ApplicationGatewayAuthenticationCertificatePropertiesFormat12 | string)␊ - /**␊ - * Name of the authentication certificate that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authentication certificates properties of an application gateway.␊ - */␊ - export interface ApplicationGatewayAuthenticationCertificatePropertiesFormat12 {␊ - /**␊ - * Certificate public data.␊ - */␊ - data?: string␊ - /**␊ - * Provisioning state of the authentication certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trusted Root certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewayTrustedRootCertificate3 {␊ - /**␊ - * Properties of the application gateway trusted root certificate.␊ - */␊ - properties?: (ApplicationGatewayTrustedRootCertificatePropertiesFormat3 | string)␊ - /**␊ - * Name of the trusted root certificate that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trusted Root certificates properties of an application gateway.␊ - */␊ - export interface ApplicationGatewayTrustedRootCertificatePropertiesFormat3 {␊ - /**␊ - * Certificate public data.␊ - */␊ - data?: string␊ - /**␊ - * Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault.␊ - */␊ - keyVaultSecretId?: string␊ - /**␊ - * Provisioning state of the trusted root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSL certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewaySslCertificate15 {␊ - /**␊ - * Properties of the application gateway SSL certificate.␊ - */␊ - properties?: (ApplicationGatewaySslCertificatePropertiesFormat15 | string)␊ - /**␊ - * Name of the SSL certificate that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewaySslCertificatePropertiesFormat15 {␊ - /**␊ - * Base-64 encoded pfx certificate. Only applicable in PUT Request.␊ - */␊ - data?: string␊ - /**␊ - * Password for the pfx file specified in data. Only applicable in PUT request.␊ - */␊ - password?: string␊ - /**␊ - * Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request.␊ - */␊ - publicCertData?: string␊ - /**␊ - * Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault.␊ - */␊ - keyVaultSecretId?: string␊ - /**␊ - * Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendIPConfiguration15 {␊ - /**␊ - * Properties of the application gateway frontend IP configuration.␊ - */␊ - properties?: (ApplicationGatewayFrontendIPConfigurationPropertiesFormat15 | string)␊ - /**␊ - * Name of the frontend IP configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendIPConfigurationPropertiesFormat15 {␊ - /**␊ - * PrivateIPAddress of the network interface IP Configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The private IP address allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Reference of the subnet resource.␊ - */␊ - subnet?: (SubResource22 | string)␊ - /**␊ - * Reference of the PublicIP resource.␊ - */␊ - publicIPAddress?: (SubResource22 | string)␊ - /**␊ - * Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend port of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendPort15 {␊ - /**␊ - * Properties of the application gateway frontend port.␊ - */␊ - properties?: (ApplicationGatewayFrontendPortPropertiesFormat15 | string)␊ - /**␊ - * Name of the frontend port that is unique within an Application Gateway␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend port of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendPortPropertiesFormat15 {␊ - /**␊ - * Frontend port␊ - */␊ - port?: (number | string)␊ - /**␊ - * Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Probe of the application gateway.␊ - */␊ - export interface ApplicationGatewayProbe14 {␊ - /**␊ - * Properties of the application gateway probe.␊ - */␊ - properties?: (ApplicationGatewayProbePropertiesFormat14 | string)␊ - /**␊ - * Name of the probe that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of probe of an application gateway.␊ - */␊ - export interface ApplicationGatewayProbePropertiesFormat14 {␊ - /**␊ - * The protocol used for the probe.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Host name to send the probe to.␊ - */␊ - host?: string␊ - /**␊ - * Relative path of probe. Valid path starts from '/'. Probe is sent to ://:␊ - */␊ - path?: string␊ - /**␊ - * The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - interval?: (number | string)␊ - /**␊ - * The probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - timeout?: (number | string)␊ - /**␊ - * The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20.␊ - */␊ - unhealthyThreshold?: (number | string)␊ - /**␊ - * Whether the host header should be picked from the backend http settings. Default value is false.␊ - */␊ - pickHostNameFromBackendHttpSettings?: (boolean | string)␊ - /**␊ - * Minimum number of servers that are always marked healthy. Default value is 0.␊ - */␊ - minServers?: (number | string)␊ - /**␊ - * Criterion for classifying a healthy probe response.␊ - */␊ - match?: (ApplicationGatewayProbeHealthResponseMatch12 | string)␊ - /**␊ - * Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application gateway probe health response match␊ - */␊ - export interface ApplicationGatewayProbeHealthResponseMatch12 {␊ - /**␊ - * Body that must be contained in the health response. Default value is empty.␊ - */␊ - body?: string␊ - /**␊ - * Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399.␊ - */␊ - statusCodes?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend Address Pool of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddressPool15 {␊ - /**␊ - * Properties of the application gateway backend address pool.␊ - */␊ - properties?: (ApplicationGatewayBackendAddressPoolPropertiesFormat15 | string)␊ - /**␊ - * Name of the backend address pool that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend Address Pool of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddressPoolPropertiesFormat15 {␊ - /**␊ - * Collection of references to IPs defined in network interfaces.␊ - */␊ - backendIPConfigurations?: (SubResource22[] | string)␊ - /**␊ - * Backend addresses␊ - */␊ - backendAddresses?: (ApplicationGatewayBackendAddress15[] | string)␊ - /**␊ - * Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddress15 {␊ - /**␊ - * Fully qualified domain name (FQDN).␊ - */␊ - fqdn?: string␊ - /**␊ - * IP address␊ - */␊ - ipAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address pool settings of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendHttpSettings15 {␊ - /**␊ - * Properties of the application gateway backend HTTP settings.␊ - */␊ - properties?: (ApplicationGatewayBackendHttpSettingsPropertiesFormat15 | string)␊ - /**␊ - * Name of the backend http settings that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend address pool settings of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendHttpSettingsPropertiesFormat15 {␊ - /**␊ - * The destination port on the backend.␊ - */␊ - port?: (number | string)␊ - /**␊ - * The protocol used to communicate with the backend.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Cookie based affinity.␊ - */␊ - cookieBasedAffinity?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Request timeout in seconds. Application Gateway will fail the request if response is not received within RequestTimeout. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - requestTimeout?: (number | string)␊ - /**␊ - * Probe resource of an application gateway.␊ - */␊ - probe?: (SubResource22 | string)␊ - /**␊ - * Array of references to application gateway authentication certificates.␊ - */␊ - authenticationCertificates?: (SubResource22[] | string)␊ - /**␊ - * Array of references to application gateway trusted root certificates.␊ - */␊ - trustedRootCertificates?: (SubResource22[] | string)␊ - /**␊ - * Connection draining of the backend http settings resource.␊ - */␊ - connectionDraining?: (ApplicationGatewayConnectionDraining12 | string)␊ - /**␊ - * Host header to be sent to the backend servers.␊ - */␊ - hostName?: string␊ - /**␊ - * Whether to pick host header should be picked from the host name of the backend server. Default value is false.␊ - */␊ - pickHostNameFromBackendAddress?: (boolean | string)␊ - /**␊ - * Cookie name to use for the affinity cookie.␊ - */␊ - affinityCookieName?: string␊ - /**␊ - * Whether the probe is enabled. Default value is false.␊ - */␊ - probeEnabled?: (boolean | string)␊ - /**␊ - * Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null.␊ - */␊ - path?: string␊ - /**␊ - * Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Connection draining allows open connections to a backend server to be active for a specified time after the backend server got removed from the configuration.␊ - */␊ - export interface ApplicationGatewayConnectionDraining12 {␊ - /**␊ - * Whether connection draining is enabled or not.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds.␊ - */␊ - drainTimeoutInSec: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http listener of an application gateway.␊ - */␊ - export interface ApplicationGatewayHttpListener15 {␊ - /**␊ - * Properties of the application gateway HTTP listener.␊ - */␊ - properties?: (ApplicationGatewayHttpListenerPropertiesFormat15 | string)␊ - /**␊ - * Name of the HTTP listener that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of HTTP listener of an application gateway.␊ - */␊ - export interface ApplicationGatewayHttpListenerPropertiesFormat15 {␊ - /**␊ - * Frontend IP configuration resource of an application gateway.␊ - */␊ - frontendIPConfiguration?: (SubResource22 | string)␊ - /**␊ - * Frontend port resource of an application gateway.␊ - */␊ - frontendPort?: (SubResource22 | string)␊ - /**␊ - * Protocol of the HTTP listener.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Host name of HTTP listener.␊ - */␊ - hostName?: string␊ - /**␊ - * SSL certificate resource of an application gateway.␊ - */␊ - sslCertificate?: (SubResource22 | string)␊ - /**␊ - * Applicable only if protocol is https. Enables SNI for multi-hosting.␊ - */␊ - requireServerNameIndication?: (boolean | string)␊ - /**␊ - * Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - /**␊ - * Custom error configurations of the HTTP listener.␊ - */␊ - customErrorConfigurations?: (ApplicationGatewayCustomError3[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Customer error of an application gateway.␊ - */␊ - export interface ApplicationGatewayCustomError3 {␊ - /**␊ - * Status code of the application gateway customer error.␊ - */␊ - statusCode?: (("HttpStatus403" | "HttpStatus502") | string)␊ - /**␊ - * Error page URL of the application gateway customer error.␊ - */␊ - customErrorPageUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * UrlPathMaps give a url path to the backend mapping information for PathBasedRouting.␊ - */␊ - export interface ApplicationGatewayUrlPathMap14 {␊ - /**␊ - * Properties of the application gateway URL path map.␊ - */␊ - properties?: (ApplicationGatewayUrlPathMapPropertiesFormat14 | string)␊ - /**␊ - * Name of the URL path map that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of UrlPathMap of the application gateway.␊ - */␊ - export interface ApplicationGatewayUrlPathMapPropertiesFormat14 {␊ - /**␊ - * Default backend address pool resource of URL path map.␊ - */␊ - defaultBackendAddressPool?: (SubResource22 | string)␊ - /**␊ - * Default backend http settings resource of URL path map.␊ - */␊ - defaultBackendHttpSettings?: (SubResource22 | string)␊ - /**␊ - * Default Rewrite rule set resource of URL path map.␊ - */␊ - defaultRewriteRuleSet?: (SubResource22 | string)␊ - /**␊ - * Default redirect configuration resource of URL path map.␊ - */␊ - defaultRedirectConfiguration?: (SubResource22 | string)␊ - /**␊ - * Path rule of URL path map resource.␊ - */␊ - pathRules?: (ApplicationGatewayPathRule14[] | string)␊ - /**␊ - * Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Path rule of URL path map of an application gateway.␊ - */␊ - export interface ApplicationGatewayPathRule14 {␊ - /**␊ - * Properties of the application gateway path rule.␊ - */␊ - properties?: (ApplicationGatewayPathRulePropertiesFormat14 | string)␊ - /**␊ - * Name of the path rule that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of path rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayPathRulePropertiesFormat14 {␊ - /**␊ - * Path rules of URL path map.␊ - */␊ - paths?: (string[] | string)␊ - /**␊ - * Backend address pool resource of URL path map path rule.␊ - */␊ - backendAddressPool?: (SubResource22 | string)␊ - /**␊ - * Backend http settings resource of URL path map path rule.␊ - */␊ - backendHttpSettings?: (SubResource22 | string)␊ - /**␊ - * Redirect configuration resource of URL path map path rule.␊ - */␊ - redirectConfiguration?: (SubResource22 | string)␊ - /**␊ - * Rewrite rule set resource of URL path map path rule.␊ - */␊ - rewriteRuleSet?: (SubResource22 | string)␊ - /**␊ - * Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Request routing rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayRequestRoutingRule15 {␊ - /**␊ - * Properties of the application gateway request routing rule.␊ - */␊ - properties?: (ApplicationGatewayRequestRoutingRulePropertiesFormat15 | string)␊ - /**␊ - * Name of the request routing rule that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of request routing rule of the application gateway.␊ - */␊ - export interface ApplicationGatewayRequestRoutingRulePropertiesFormat15 {␊ - /**␊ - * Rule type.␊ - */␊ - ruleType?: (("Basic" | "PathBasedRouting") | string)␊ - /**␊ - * Backend address pool resource of the application gateway. ␊ - */␊ - backendAddressPool?: (SubResource22 | string)␊ - /**␊ - * Backend http settings resource of the application gateway.␊ - */␊ - backendHttpSettings?: (SubResource22 | string)␊ - /**␊ - * Http listener resource of the application gateway. ␊ - */␊ - httpListener?: (SubResource22 | string)␊ - /**␊ - * URL path map resource of the application gateway.␊ - */␊ - urlPathMap?: (SubResource22 | string)␊ - /**␊ - * Rewrite Rule Set resource in Basic rule of the application gateway.␊ - */␊ - rewriteRuleSet?: (SubResource22 | string)␊ - /**␊ - * Redirect configuration resource of the application gateway.␊ - */␊ - redirectConfiguration?: (SubResource22 | string)␊ - /**␊ - * Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Rewrite rule set of an application gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRuleSet2 {␊ - /**␊ - * Properties of the application gateway rewrite rule set.␊ - */␊ - properties?: (ApplicationGatewayRewriteRuleSetPropertiesFormat2 | string)␊ - /**␊ - * Name of the rewrite rule set that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of rewrite rule set of the application gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRuleSetPropertiesFormat2 {␊ - /**␊ - * Rewrite rules in the rewrite rule set.␊ - */␊ - rewriteRules?: (ApplicationGatewayRewriteRule2[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Rewrite rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRule2 {␊ - /**␊ - * Name of the rewrite rule that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet.␊ - */␊ - ruleSequence?: (number | string)␊ - /**␊ - * Conditions based on which the action set execution will be evaluated.␊ - */␊ - conditions?: (ApplicationGatewayRewriteRuleCondition1[] | string)␊ - /**␊ - * Set of actions to be done as part of the rewrite Rule.␊ - */␊ - actionSet?: (ApplicationGatewayRewriteRuleActionSet2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Set of conditions in the Rewrite Rule in Application Gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRuleCondition1 {␊ - /**␊ - * The condition parameter of the RewriteRuleCondition.␊ - */␊ - variable?: string␊ - /**␊ - * The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition␊ - */␊ - pattern?: string␊ - /**␊ - * Setting this paramter to truth value with force the pattern to do a case in-sensitive comparison.␊ - */␊ - ignoreCase?: (boolean | string)␊ - /**␊ - * Setting this value as truth will force to check the negation of the condition given by the user.␊ - */␊ - negate?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Set of actions in the Rewrite Rule in Application Gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRuleActionSet2 {␊ - /**␊ - * Request Header Actions in the Action Set␊ - */␊ - requestHeaderConfigurations?: (ApplicationGatewayHeaderConfiguration2[] | string)␊ - /**␊ - * Response Header Actions in the Action Set␊ - */␊ - responseHeaderConfigurations?: (ApplicationGatewayHeaderConfiguration2[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Header configuration of the Actions set in Application Gateway.␊ - */␊ - export interface ApplicationGatewayHeaderConfiguration2 {␊ - /**␊ - * Header name of the header configuration␊ - */␊ - headerName?: string␊ - /**␊ - * Header value of the header configuration␊ - */␊ - headerValue?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Redirect configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayRedirectConfiguration12 {␊ - /**␊ - * Properties of the application gateway redirect configuration.␊ - */␊ - properties?: (ApplicationGatewayRedirectConfigurationPropertiesFormat12 | string)␊ - /**␊ - * Name of the redirect configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of redirect configuration of the application gateway.␊ - */␊ - export interface ApplicationGatewayRedirectConfigurationPropertiesFormat12 {␊ - /**␊ - * HTTP redirection type.␊ - */␊ - redirectType?: (("Permanent" | "Found" | "SeeOther" | "Temporary") | string)␊ - /**␊ - * Reference to a listener to redirect the request to.␊ - */␊ - targetListener?: (SubResource22 | string)␊ - /**␊ - * Url to redirect the request to.␊ - */␊ - targetUrl?: string␊ - /**␊ - * Include path in the redirected url.␊ - */␊ - includePath?: (boolean | string)␊ - /**␊ - * Include query string in the redirected url.␊ - */␊ - includeQueryString?: (boolean | string)␊ - /**␊ - * Request routing specifying redirect configuration.␊ - */␊ - requestRoutingRules?: (SubResource22[] | string)␊ - /**␊ - * Url path maps specifying default redirect configuration.␊ - */␊ - urlPathMaps?: (SubResource22[] | string)␊ - /**␊ - * Path rules specifying redirect configuration.␊ - */␊ - pathRules?: (SubResource22[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application gateway web application firewall configuration.␊ - */␊ - export interface ApplicationGatewayWebApplicationFirewallConfiguration12 {␊ - /**␊ - * Whether the web application firewall is enabled or not.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * Web application firewall mode.␊ - */␊ - firewallMode: (("Detection" | "Prevention") | string)␊ - /**␊ - * The type of the web application firewall rule set. Possible values are: 'OWASP'.␊ - */␊ - ruleSetType: string␊ - /**␊ - * The version of the rule set type.␊ - */␊ - ruleSetVersion: string␊ - /**␊ - * The disabled rule groups.␊ - */␊ - disabledRuleGroups?: (ApplicationGatewayFirewallDisabledRuleGroup12[] | string)␊ - /**␊ - * Whether allow WAF to check request Body.␊ - */␊ - requestBodyCheck?: (boolean | string)␊ - /**␊ - * Maximum request body size for WAF.␊ - */␊ - maxRequestBodySize?: (number | string)␊ - /**␊ - * Maximum request body size in Kb for WAF.␊ - */␊ - maxRequestBodySizeInKb?: (number | string)␊ - /**␊ - * Maximum file upload size in Mb for WAF.␊ - */␊ - fileUploadLimitInMb?: (number | string)␊ - /**␊ - * The exclusion list.␊ - */␊ - exclusions?: (ApplicationGatewayFirewallExclusion3[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allows to disable rules within a rule group or an entire rule group.␊ - */␊ - export interface ApplicationGatewayFirewallDisabledRuleGroup12 {␊ - /**␊ - * The name of the rule group that will be disabled.␊ - */␊ - ruleGroupName: string␊ - /**␊ - * The list of rules that will be disabled. If null, all rules of the rule group will be disabled.␊ - */␊ - rules?: (number[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allow to exclude some variable satisfy the condition for the WAF check␊ - */␊ - export interface ApplicationGatewayFirewallExclusion3 {␊ - /**␊ - * The variable to be excluded.␊ - */␊ - matchVariable: string␊ - /**␊ - * When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to.␊ - */␊ - selectorMatchOperator: string␊ - /**␊ - * When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to.␊ - */␊ - selector: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application Gateway autoscale configuration.␊ - */␊ - export interface ApplicationGatewayAutoscaleConfiguration6 {␊ - /**␊ - * Lower bound on number of Application Gateway capacity␊ - */␊ - minCapacity: (number | string)␊ - /**␊ - * Upper bound on number of Application Gateway capacity␊ - */␊ - maxCapacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the resource.␊ - */␊ - export interface ManagedServiceIdentity2 {␊ - /**␊ - * The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.␊ - */␊ - type?: ("SystemAssigned" | "UserAssigned" | "SystemAssigned, UserAssigned" | "None")␊ - /**␊ - * The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.␊ - */␊ - userAssignedIdentities?: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/authorizations␊ - */␊ - export interface ExpressRouteCircuitsAuthorizations10 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/authorizations"␊ - apiVersion: "2019-02-01"␊ - /**␊ - * Properties of the express route circuit authorization.␊ - */␊ - properties: (AuthorizationPropertiesFormat10 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ExpressRoutePorts␊ - */␊ - export interface ExpressRoutePorts2 {␊ - name: string␊ - type: "Microsoft.Network/ExpressRoutePorts"␊ - apiVersion: "2019-02-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * ExpressRoutePort properties␊ - */␊ - properties: (ExpressRoutePortPropertiesFormat2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to ExpressRoutePort resources.␊ - */␊ - export interface ExpressRoutePortPropertiesFormat2 {␊ - /**␊ - * The name of the peering location that the ExpressRoutePort is mapped to physically.␊ - */␊ - peeringLocation?: string␊ - /**␊ - * Bandwidth of procured ports in Gbps␊ - */␊ - bandwidthInGbps?: (number | string)␊ - /**␊ - * Encapsulation method on physical ports.␊ - */␊ - encapsulation?: (("Dot1Q" | "QinQ") | string)␊ - /**␊ - * The set of physical links of the ExpressRoutePort resource␊ - */␊ - links?: (ExpressRouteLink2[] | string)␊ - /**␊ - * The resource GUID property of the ExpressRoutePort resource.␊ - */␊ - resourceGuid?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ExpressRouteLink child resource definition.␊ - */␊ - export interface ExpressRouteLink2 {␊ - /**␊ - * ExpressRouteLink properties␊ - */␊ - properties?: (ExpressRouteLinkPropertiesFormat2 | string)␊ - /**␊ - * Name of child port resource that is unique among child port resources of the parent.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to ExpressRouteLink resources.␊ - */␊ - export interface ExpressRouteLinkPropertiesFormat2 {␊ - /**␊ - * Administrative state of the physical port.␊ - */␊ - adminState?: (("Enabled" | "Disabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies␊ - */␊ - export interface ApplicationGatewayWebApplicationFirewallPolicies {␊ - name: string␊ - type: "Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies"␊ - apiVersion: "2019-02-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the web application firewall policy.␊ - */␊ - properties: (WebApplicationFirewallPolicyPropertiesFormat | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines web application firewall policy properties␊ - */␊ - export interface WebApplicationFirewallPolicyPropertiesFormat {␊ - /**␊ - * Describes policySettings for policy␊ - */␊ - policySettings?: (PolicySettings2 | string)␊ - /**␊ - * Describes custom rules inside the policy␊ - */␊ - customRules?: (WebApplicationFirewallCustomRule[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines contents of a web application firewall global configuration␊ - */␊ - export interface PolicySettings2 {␊ - /**␊ - * Describes if the policy is in enabled state or disabled state.␊ - */␊ - enabledState?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * Describes if it is in detection mode or prevention mode at policy level.␊ - */␊ - mode?: (("Prevention" | "Detection") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines contents of a web application rule␊ - */␊ - export interface WebApplicationFirewallCustomRule {␊ - /**␊ - * Gets name of the resource that is unique within a policy. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value␊ - */␊ - priority: (number | string)␊ - /**␊ - * Describes type of rule.␊ - */␊ - ruleType: (("MatchRule" | "Invalid") | string)␊ - /**␊ - * List of match conditions␊ - */␊ - matchConditions: (MatchCondition2[] | string)␊ - /**␊ - * Type of Actions.␊ - */␊ - action: (("Allow" | "Block" | "Log") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Define match conditions␊ - */␊ - export interface MatchCondition2 {␊ - /**␊ - * List of match variables␊ - */␊ - matchVariables: (MatchVariable[] | string)␊ - /**␊ - * Describes operator to be matched.␊ - */␊ - operator: (("IPMatch" | "Equal" | "Contains" | "LessThan" | "GreaterThan" | "LessThanOrEqual" | "GreaterThanOrEqual" | "BeginsWith" | "EndsWith" | "Regex") | string)␊ - /**␊ - * Describes if this is negate condition or not␊ - */␊ - negationConditon?: (boolean | string)␊ - /**␊ - * Match value␊ - */␊ - matchValues: (string[] | string)␊ - /**␊ - * List of transforms␊ - */␊ - transforms?: (("Lowercase" | "Trim" | "UrlDecode" | "UrlEncode" | "RemoveNulls" | "HtmlEntityDecode")[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Define match variables␊ - */␊ - export interface MatchVariable {␊ - /**␊ - * Match Variable.␊ - */␊ - variableName: (("RemoteAddr" | "RequestMethod" | "QueryString" | "PostArgs" | "RequestUri" | "RequestHeaders" | "RequestBody" | "RequestCookies") | string)␊ - /**␊ - * Describes field of the matchVariable collection␊ - */␊ - selector?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings␊ - */␊ - export interface ExpressRouteCircuitsPeerings9 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/peerings"␊ - apiVersion: "2019-02-01"␊ - /**␊ - * Properties of the express route circuit peering.␊ - */␊ - properties: (ExpressRouteCircuitPeeringPropertiesFormat10 | string)␊ - resources?: ExpressRouteCircuitsPeeringsConnectionsChildResource7[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections/peerings␊ - */␊ - export interface ExpressRouteCrossConnectionsPeerings6 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCrossConnections/peerings"␊ - apiVersion: "2019-02-01"␊ - /**␊ - * Properties of the express route cross connection peering.␊ - */␊ - properties: (ExpressRouteCrossConnectionPeeringProperties7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers/inboundNatRules␊ - */␊ - export interface LoadBalancersInboundNatRules11 {␊ - name: string␊ - type: "Microsoft.Network/loadBalancers/inboundNatRules"␊ - apiVersion: "2019-02-01"␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties: (InboundNatRulePropertiesFormat16 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces/tapConfigurations␊ - */␊ - export interface NetworkInterfacesTapConfigurations2 {␊ - name: string␊ - type: "Microsoft.Network/networkInterfaces/tapConfigurations"␊ - apiVersion: "2019-02-01"␊ - /**␊ - * Properties of the Virtual Network Tap configuration␊ - */␊ - properties: (NetworkInterfaceTapConfigurationPropertiesFormat3 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRules15 {␊ - name: string␊ - type: "Microsoft.Network/networkSecurityGroups/securityRules"␊ - apiVersion: "2019-02-01"␊ - /**␊ - * Properties of the security rule␊ - */␊ - properties: (SecurityRulePropertiesFormat16 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutes15 {␊ - name: string␊ - type: "Microsoft.Network/routeTables/routes"␊ - apiVersion: "2019-02-01"␊ - /**␊ - * Properties of the route.␊ - */␊ - properties: (RoutePropertiesFormat16 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings/connections␊ - */␊ - export interface ExpressRouteCircuitsPeeringsConnections7 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/peerings/connections"␊ - apiVersion: "2019-02-01"␊ - /**␊ - * Properties of the express route circuit connection.␊ - */␊ - properties: (ExpressRouteCircuitConnectionPropertiesFormat7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/applicationGateways␊ - */␊ - export interface ApplicationGateways16 {␊ - name: string␊ - type: "Microsoft.Network/applicationGateways"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the application gateway.␊ - */␊ - properties: (ApplicationGatewayPropertiesFormat16 | string)␊ - /**␊ - * A list of availability zones denoting where the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - /**␊ - * The identity of the application gateway, if configured.␊ - */␊ - identity?: (ManagedServiceIdentity3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application gateway.␊ - */␊ - export interface ApplicationGatewayPropertiesFormat16 {␊ - /**␊ - * SKU of the application gateway resource.␊ - */␊ - sku?: (ApplicationGatewaySku16 | string)␊ - /**␊ - * SSL policy of the application gateway resource.␊ - */␊ - sslPolicy?: (ApplicationGatewaySslPolicy13 | string)␊ - /**␊ - * Subnets of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - gatewayIPConfigurations?: (ApplicationGatewayIPConfiguration16[] | string)␊ - /**␊ - * Authentication certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - authenticationCertificates?: (ApplicationGatewayAuthenticationCertificate13[] | string)␊ - /**␊ - * Trusted Root certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - trustedRootCertificates?: (ApplicationGatewayTrustedRootCertificate4[] | string)␊ - /**␊ - * SSL certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - sslCertificates?: (ApplicationGatewaySslCertificate16[] | string)␊ - /**␊ - * Frontend IP addresses of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - frontendIPConfigurations?: (ApplicationGatewayFrontendIPConfiguration16[] | string)␊ - /**␊ - * Frontend ports of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - frontendPorts?: (ApplicationGatewayFrontendPort16[] | string)␊ - /**␊ - * Probes of the application gateway resource.␊ - */␊ - probes?: (ApplicationGatewayProbe15[] | string)␊ - /**␊ - * Backend address pool of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - backendAddressPools?: (ApplicationGatewayBackendAddressPool16[] | string)␊ - /**␊ - * Backend http settings of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - backendHttpSettingsCollection?: (ApplicationGatewayBackendHttpSettings16[] | string)␊ - /**␊ - * Http listeners of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - httpListeners?: (ApplicationGatewayHttpListener16[] | string)␊ - /**␊ - * URL path map of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - urlPathMaps?: (ApplicationGatewayUrlPathMap15[] | string)␊ - /**␊ - * Request routing rules of the application gateway resource.␊ - */␊ - requestRoutingRules?: (ApplicationGatewayRequestRoutingRule16[] | string)␊ - /**␊ - * Rewrite rules for the application gateway resource.␊ - */␊ - rewriteRuleSets?: (ApplicationGatewayRewriteRuleSet3[] | string)␊ - /**␊ - * Redirect configurations of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - redirectConfigurations?: (ApplicationGatewayRedirectConfiguration13[] | string)␊ - /**␊ - * Web application firewall configuration.␊ - */␊ - webApplicationFirewallConfiguration?: (ApplicationGatewayWebApplicationFirewallConfiguration13 | string)␊ - /**␊ - * Reference of the FirewallPolicy resource.␊ - */␊ - firewallPolicy?: (SubResource23 | string)␊ - /**␊ - * Whether HTTP2 is enabled on the application gateway resource.␊ - */␊ - enableHttp2?: (boolean | string)␊ - /**␊ - * Whether FIPS is enabled on the application gateway resource.␊ - */␊ - enableFips?: (boolean | string)␊ - /**␊ - * Autoscale Configuration.␊ - */␊ - autoscaleConfiguration?: (ApplicationGatewayAutoscaleConfiguration7 | string)␊ - /**␊ - * Custom error configurations of the application gateway resource.␊ - */␊ - customErrorConfigurations?: (ApplicationGatewayCustomError4[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of an application gateway.␊ - */␊ - export interface ApplicationGatewaySku16 {␊ - /**␊ - * Name of an application gateway SKU.␊ - */␊ - name?: (("Standard_Small" | "Standard_Medium" | "Standard_Large" | "WAF_Medium" | "WAF_Large" | "Standard_v2" | "WAF_v2") | string)␊ - /**␊ - * Tier of an application gateway.␊ - */␊ - tier?: (("Standard" | "WAF" | "Standard_v2" | "WAF_v2") | string)␊ - /**␊ - * Capacity (instance count) of an application gateway.␊ - */␊ - capacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application Gateway Ssl policy.␊ - */␊ - export interface ApplicationGatewaySslPolicy13 {␊ - /**␊ - * Ssl protocols to be disabled on application gateway.␊ - */␊ - disabledSslProtocols?: (("TLSv1_0" | "TLSv1_1" | "TLSv1_2")[] | string)␊ - /**␊ - * Type of Ssl Policy.␊ - */␊ - policyType?: (("Predefined" | "Custom") | string)␊ - /**␊ - * Name of Ssl predefined policy.␊ - */␊ - policyName?: (("AppGwSslPolicy20150501" | "AppGwSslPolicy20170401" | "AppGwSslPolicy20170401S") | string)␊ - /**␊ - * Ssl cipher suites to be enabled in the specified order to application gateway.␊ - */␊ - cipherSuites?: (("TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384" | "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256" | "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA" | "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA" | "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384" | "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256" | "TLS_DHE_RSA_WITH_AES_256_CBC_SHA" | "TLS_DHE_RSA_WITH_AES_128_CBC_SHA" | "TLS_RSA_WITH_AES_256_GCM_SHA384" | "TLS_RSA_WITH_AES_128_GCM_SHA256" | "TLS_RSA_WITH_AES_256_CBC_SHA256" | "TLS_RSA_WITH_AES_128_CBC_SHA256" | "TLS_RSA_WITH_AES_256_CBC_SHA" | "TLS_RSA_WITH_AES_128_CBC_SHA" | "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384" | "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256" | "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384" | "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256" | "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA" | "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA" | "TLS_DHE_DSS_WITH_AES_256_CBC_SHA256" | "TLS_DHE_DSS_WITH_AES_128_CBC_SHA256" | "TLS_DHE_DSS_WITH_AES_256_CBC_SHA" | "TLS_DHE_DSS_WITH_AES_128_CBC_SHA" | "TLS_RSA_WITH_3DES_EDE_CBC_SHA" | "TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA" | "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256" | "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384")[] | string)␊ - /**␊ - * Minimum version of Ssl protocol to be supported on application gateway.␊ - */␊ - minProtocolVersion?: (("TLSv1_0" | "TLSv1_1" | "TLSv1_2") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed.␊ - */␊ - export interface ApplicationGatewayIPConfiguration16 {␊ - /**␊ - * Properties of the application gateway IP configuration.␊ - */␊ - properties?: (ApplicationGatewayIPConfigurationPropertiesFormat16 | string)␊ - /**␊ - * Name of the IP configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayIPConfigurationPropertiesFormat16 {␊ - /**␊ - * Reference of the subnet resource. A subnet from where application gateway gets its private address.␊ - */␊ - subnet?: (SubResource23 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Reference to another subresource.␊ - */␊ - export interface SubResource23 {␊ - /**␊ - * Resource ID.␊ - */␊ - id: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authentication certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewayAuthenticationCertificate13 {␊ - /**␊ - * Properties of the application gateway authentication certificate.␊ - */␊ - properties?: (ApplicationGatewayAuthenticationCertificatePropertiesFormat13 | string)␊ - /**␊ - * Name of the authentication certificate that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authentication certificates properties of an application gateway.␊ - */␊ - export interface ApplicationGatewayAuthenticationCertificatePropertiesFormat13 {␊ - /**␊ - * Certificate public data.␊ - */␊ - data?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trusted Root certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewayTrustedRootCertificate4 {␊ - /**␊ - * Properties of the application gateway trusted root certificate.␊ - */␊ - properties?: (ApplicationGatewayTrustedRootCertificatePropertiesFormat4 | string)␊ - /**␊ - * Name of the trusted root certificate that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trusted Root certificates properties of an application gateway.␊ - */␊ - export interface ApplicationGatewayTrustedRootCertificatePropertiesFormat4 {␊ - /**␊ - * Certificate public data.␊ - */␊ - data?: string␊ - /**␊ - * Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault.␊ - */␊ - keyVaultSecretId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSL certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewaySslCertificate16 {␊ - /**␊ - * Properties of the application gateway SSL certificate.␊ - */␊ - properties?: (ApplicationGatewaySslCertificatePropertiesFormat16 | string)␊ - /**␊ - * Name of the SSL certificate that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewaySslCertificatePropertiesFormat16 {␊ - /**␊ - * Base-64 encoded pfx certificate. Only applicable in PUT Request.␊ - */␊ - data?: string␊ - /**␊ - * Password for the pfx file specified in data. Only applicable in PUT request.␊ - */␊ - password?: string␊ - /**␊ - * Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault.␊ - */␊ - keyVaultSecretId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendIPConfiguration16 {␊ - /**␊ - * Properties of the application gateway frontend IP configuration.␊ - */␊ - properties?: (ApplicationGatewayFrontendIPConfigurationPropertiesFormat16 | string)␊ - /**␊ - * Name of the frontend IP configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendIPConfigurationPropertiesFormat16 {␊ - /**␊ - * PrivateIPAddress of the network interface IP Configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The private IP address allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Reference of the subnet resource.␊ - */␊ - subnet?: (SubResource23 | string)␊ - /**␊ - * Reference of the PublicIP resource.␊ - */␊ - publicIPAddress?: (SubResource23 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend port of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendPort16 {␊ - /**␊ - * Properties of the application gateway frontend port.␊ - */␊ - properties?: (ApplicationGatewayFrontendPortPropertiesFormat16 | string)␊ - /**␊ - * Name of the frontend port that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend port of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendPortPropertiesFormat16 {␊ - /**␊ - * Frontend port.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Probe of the application gateway.␊ - */␊ - export interface ApplicationGatewayProbe15 {␊ - /**␊ - * Properties of the application gateway probe.␊ - */␊ - properties?: (ApplicationGatewayProbePropertiesFormat15 | string)␊ - /**␊ - * Name of the probe that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of probe of an application gateway.␊ - */␊ - export interface ApplicationGatewayProbePropertiesFormat15 {␊ - /**␊ - * The protocol used for the probe.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Host name to send the probe to.␊ - */␊ - host?: string␊ - /**␊ - * Relative path of probe. Valid path starts from '/'. Probe is sent to ://:.␊ - */␊ - path?: string␊ - /**␊ - * The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - interval?: (number | string)␊ - /**␊ - * The probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - timeout?: (number | string)␊ - /**␊ - * The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20.␊ - */␊ - unhealthyThreshold?: (number | string)␊ - /**␊ - * Whether the host header should be picked from the backend http settings. Default value is false.␊ - */␊ - pickHostNameFromBackendHttpSettings?: (boolean | string)␊ - /**␊ - * Minimum number of servers that are always marked healthy. Default value is 0.␊ - */␊ - minServers?: (number | string)␊ - /**␊ - * Criterion for classifying a healthy probe response.␊ - */␊ - match?: (ApplicationGatewayProbeHealthResponseMatch13 | string)␊ - /**␊ - * Custom port which will be used for probing the backend servers. The valid value ranges from 1 to 65535. In case not set, port from http settings will be used. This property is valid for Standard_v2 and WAF_v2 only.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application gateway probe health response match.␊ - */␊ - export interface ApplicationGatewayProbeHealthResponseMatch13 {␊ - /**␊ - * Body that must be contained in the health response. Default value is empty.␊ - */␊ - body?: string␊ - /**␊ - * Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399.␊ - */␊ - statusCodes?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend Address Pool of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddressPool16 {␊ - /**␊ - * Properties of the application gateway backend address pool.␊ - */␊ - properties?: (ApplicationGatewayBackendAddressPoolPropertiesFormat16 | string)␊ - /**␊ - * Name of the backend address pool that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend Address Pool of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddressPoolPropertiesFormat16 {␊ - /**␊ - * Backend addresses.␊ - */␊ - backendAddresses?: (ApplicationGatewayBackendAddress16[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddress16 {␊ - /**␊ - * Fully qualified domain name (FQDN).␊ - */␊ - fqdn?: string␊ - /**␊ - * IP address.␊ - */␊ - ipAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address pool settings of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendHttpSettings16 {␊ - /**␊ - * Properties of the application gateway backend HTTP settings.␊ - */␊ - properties?: (ApplicationGatewayBackendHttpSettingsPropertiesFormat16 | string)␊ - /**␊ - * Name of the backend http settings that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend address pool settings of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendHttpSettingsPropertiesFormat16 {␊ - /**␊ - * The destination port on the backend.␊ - */␊ - port?: (number | string)␊ - /**␊ - * The protocol used to communicate with the backend.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Cookie based affinity.␊ - */␊ - cookieBasedAffinity?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Request timeout in seconds. Application Gateway will fail the request if response is not received within RequestTimeout. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - requestTimeout?: (number | string)␊ - /**␊ - * Probe resource of an application gateway.␊ - */␊ - probe?: (SubResource23 | string)␊ - /**␊ - * Array of references to application gateway authentication certificates.␊ - */␊ - authenticationCertificates?: (SubResource23[] | string)␊ - /**␊ - * Array of references to application gateway trusted root certificates.␊ - */␊ - trustedRootCertificates?: (SubResource23[] | string)␊ - /**␊ - * Connection draining of the backend http settings resource.␊ - */␊ - connectionDraining?: (ApplicationGatewayConnectionDraining13 | string)␊ - /**␊ - * Host header to be sent to the backend servers.␊ - */␊ - hostName?: string␊ - /**␊ - * Whether to pick host header should be picked from the host name of the backend server. Default value is false.␊ - */␊ - pickHostNameFromBackendAddress?: (boolean | string)␊ - /**␊ - * Cookie name to use for the affinity cookie.␊ - */␊ - affinityCookieName?: string␊ - /**␊ - * Whether the probe is enabled. Default value is false.␊ - */␊ - probeEnabled?: (boolean | string)␊ - /**␊ - * Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null.␊ - */␊ - path?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Connection draining allows open connections to a backend server to be active for a specified time after the backend server got removed from the configuration.␊ - */␊ - export interface ApplicationGatewayConnectionDraining13 {␊ - /**␊ - * Whether connection draining is enabled or not.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds.␊ - */␊ - drainTimeoutInSec: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http listener of an application gateway.␊ - */␊ - export interface ApplicationGatewayHttpListener16 {␊ - /**␊ - * Properties of the application gateway HTTP listener.␊ - */␊ - properties?: (ApplicationGatewayHttpListenerPropertiesFormat16 | string)␊ - /**␊ - * Name of the HTTP listener that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of HTTP listener of an application gateway.␊ - */␊ - export interface ApplicationGatewayHttpListenerPropertiesFormat16 {␊ - /**␊ - * Frontend IP configuration resource of an application gateway.␊ - */␊ - frontendIPConfiguration?: (SubResource23 | string)␊ - /**␊ - * Frontend port resource of an application gateway.␊ - */␊ - frontendPort?: (SubResource23 | string)␊ - /**␊ - * Protocol of the HTTP listener.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Host name of HTTP listener.␊ - */␊ - hostName?: string␊ - /**␊ - * SSL certificate resource of an application gateway.␊ - */␊ - sslCertificate?: (SubResource23 | string)␊ - /**␊ - * Applicable only if protocol is https. Enables SNI for multi-hosting.␊ - */␊ - requireServerNameIndication?: (boolean | string)␊ - /**␊ - * Custom error configurations of the HTTP listener.␊ - */␊ - customErrorConfigurations?: (ApplicationGatewayCustomError4[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Customer error of an application gateway.␊ - */␊ - export interface ApplicationGatewayCustomError4 {␊ - /**␊ - * Status code of the application gateway customer error.␊ - */␊ - statusCode?: (("HttpStatus403" | "HttpStatus502") | string)␊ - /**␊ - * Error page URL of the application gateway customer error.␊ - */␊ - customErrorPageUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * UrlPathMaps give a url path to the backend mapping information for PathBasedRouting.␊ - */␊ - export interface ApplicationGatewayUrlPathMap15 {␊ - /**␊ - * Properties of the application gateway URL path map.␊ - */␊ - properties?: (ApplicationGatewayUrlPathMapPropertiesFormat15 | string)␊ - /**␊ - * Name of the URL path map that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of UrlPathMap of the application gateway.␊ - */␊ - export interface ApplicationGatewayUrlPathMapPropertiesFormat15 {␊ - /**␊ - * Default backend address pool resource of URL path map.␊ - */␊ - defaultBackendAddressPool?: (SubResource23 | string)␊ - /**␊ - * Default backend http settings resource of URL path map.␊ - */␊ - defaultBackendHttpSettings?: (SubResource23 | string)␊ - /**␊ - * Default Rewrite rule set resource of URL path map.␊ - */␊ - defaultRewriteRuleSet?: (SubResource23 | string)␊ - /**␊ - * Default redirect configuration resource of URL path map.␊ - */␊ - defaultRedirectConfiguration?: (SubResource23 | string)␊ - /**␊ - * Path rule of URL path map resource.␊ - */␊ - pathRules?: (ApplicationGatewayPathRule15[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Path rule of URL path map of an application gateway.␊ - */␊ - export interface ApplicationGatewayPathRule15 {␊ - /**␊ - * Properties of the application gateway path rule.␊ - */␊ - properties?: (ApplicationGatewayPathRulePropertiesFormat15 | string)␊ - /**␊ - * Name of the path rule that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of path rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayPathRulePropertiesFormat15 {␊ - /**␊ - * Path rules of URL path map.␊ - */␊ - paths?: (string[] | string)␊ - /**␊ - * Backend address pool resource of URL path map path rule.␊ - */␊ - backendAddressPool?: (SubResource23 | string)␊ - /**␊ - * Backend http settings resource of URL path map path rule.␊ - */␊ - backendHttpSettings?: (SubResource23 | string)␊ - /**␊ - * Redirect configuration resource of URL path map path rule.␊ - */␊ - redirectConfiguration?: (SubResource23 | string)␊ - /**␊ - * Rewrite rule set resource of URL path map path rule.␊ - */␊ - rewriteRuleSet?: (SubResource23 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Request routing rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayRequestRoutingRule16 {␊ - /**␊ - * Properties of the application gateway request routing rule.␊ - */␊ - properties?: (ApplicationGatewayRequestRoutingRulePropertiesFormat16 | string)␊ - /**␊ - * Name of the request routing rule that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of request routing rule of the application gateway.␊ - */␊ - export interface ApplicationGatewayRequestRoutingRulePropertiesFormat16 {␊ - /**␊ - * Rule type.␊ - */␊ - ruleType?: (("Basic" | "PathBasedRouting") | string)␊ - /**␊ - * Backend address pool resource of the application gateway.␊ - */␊ - backendAddressPool?: (SubResource23 | string)␊ - /**␊ - * Backend http settings resource of the application gateway.␊ - */␊ - backendHttpSettings?: (SubResource23 | string)␊ - /**␊ - * Http listener resource of the application gateway.␊ - */␊ - httpListener?: (SubResource23 | string)␊ - /**␊ - * URL path map resource of the application gateway.␊ - */␊ - urlPathMap?: (SubResource23 | string)␊ - /**␊ - * Rewrite Rule Set resource in Basic rule of the application gateway.␊ - */␊ - rewriteRuleSet?: (SubResource23 | string)␊ - /**␊ - * Redirect configuration resource of the application gateway.␊ - */␊ - redirectConfiguration?: (SubResource23 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Rewrite rule set of an application gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRuleSet3 {␊ - /**␊ - * Properties of the application gateway rewrite rule set.␊ - */␊ - properties?: (ApplicationGatewayRewriteRuleSetPropertiesFormat3 | string)␊ - /**␊ - * Name of the rewrite rule set that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of rewrite rule set of the application gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRuleSetPropertiesFormat3 {␊ - /**␊ - * Rewrite rules in the rewrite rule set.␊ - */␊ - rewriteRules?: (ApplicationGatewayRewriteRule3[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Rewrite rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRule3 {␊ - /**␊ - * Name of the rewrite rule that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet.␊ - */␊ - ruleSequence?: (number | string)␊ - /**␊ - * Conditions based on which the action set execution will be evaluated.␊ - */␊ - conditions?: (ApplicationGatewayRewriteRuleCondition2[] | string)␊ - /**␊ - * Set of actions to be done as part of the rewrite Rule.␊ - */␊ - actionSet?: (ApplicationGatewayRewriteRuleActionSet3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Set of conditions in the Rewrite Rule in Application Gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRuleCondition2 {␊ - /**␊ - * The condition parameter of the RewriteRuleCondition.␊ - */␊ - variable?: string␊ - /**␊ - * The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition.␊ - */␊ - pattern?: string␊ - /**␊ - * Setting this paramter to truth value with force the pattern to do a case in-sensitive comparison.␊ - */␊ - ignoreCase?: (boolean | string)␊ - /**␊ - * Setting this value as truth will force to check the negation of the condition given by the user.␊ - */␊ - negate?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Set of actions in the Rewrite Rule in Application Gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRuleActionSet3 {␊ - /**␊ - * Request Header Actions in the Action Set.␊ - */␊ - requestHeaderConfigurations?: (ApplicationGatewayHeaderConfiguration3[] | string)␊ - /**␊ - * Response Header Actions in the Action Set.␊ - */␊ - responseHeaderConfigurations?: (ApplicationGatewayHeaderConfiguration3[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Header configuration of the Actions set in Application Gateway.␊ - */␊ - export interface ApplicationGatewayHeaderConfiguration3 {␊ - /**␊ - * Header name of the header configuration.␊ - */␊ - headerName?: string␊ - /**␊ - * Header value of the header configuration.␊ - */␊ - headerValue?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Redirect configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayRedirectConfiguration13 {␊ - /**␊ - * Properties of the application gateway redirect configuration.␊ - */␊ - properties?: (ApplicationGatewayRedirectConfigurationPropertiesFormat13 | string)␊ - /**␊ - * Name of the redirect configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of redirect configuration of the application gateway.␊ - */␊ - export interface ApplicationGatewayRedirectConfigurationPropertiesFormat13 {␊ - /**␊ - * HTTP redirection type.␊ - */␊ - redirectType?: (("Permanent" | "Found" | "SeeOther" | "Temporary") | string)␊ - /**␊ - * Reference to a listener to redirect the request to.␊ - */␊ - targetListener?: (SubResource23 | string)␊ - /**␊ - * Url to redirect the request to.␊ - */␊ - targetUrl?: string␊ - /**␊ - * Include path in the redirected url.␊ - */␊ - includePath?: (boolean | string)␊ - /**␊ - * Include query string in the redirected url.␊ - */␊ - includeQueryString?: (boolean | string)␊ - /**␊ - * Request routing specifying redirect configuration.␊ - */␊ - requestRoutingRules?: (SubResource23[] | string)␊ - /**␊ - * Url path maps specifying default redirect configuration.␊ - */␊ - urlPathMaps?: (SubResource23[] | string)␊ - /**␊ - * Path rules specifying redirect configuration.␊ - */␊ - pathRules?: (SubResource23[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application gateway web application firewall configuration.␊ - */␊ - export interface ApplicationGatewayWebApplicationFirewallConfiguration13 {␊ - /**␊ - * Whether the web application firewall is enabled or not.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * Web application firewall mode.␊ - */␊ - firewallMode: (("Detection" | "Prevention") | string)␊ - /**␊ - * The type of the web application firewall rule set. Possible values are: 'OWASP'.␊ - */␊ - ruleSetType: string␊ - /**␊ - * The version of the rule set type.␊ - */␊ - ruleSetVersion: string␊ - /**␊ - * The disabled rule groups.␊ - */␊ - disabledRuleGroups?: (ApplicationGatewayFirewallDisabledRuleGroup13[] | string)␊ - /**␊ - * Whether allow WAF to check request Body.␊ - */␊ - requestBodyCheck?: (boolean | string)␊ - /**␊ - * Maximum request body size for WAF.␊ - */␊ - maxRequestBodySize?: (number | string)␊ - /**␊ - * Maximum request body size in Kb for WAF.␊ - */␊ - maxRequestBodySizeInKb?: (number | string)␊ - /**␊ - * Maximum file upload size in Mb for WAF.␊ - */␊ - fileUploadLimitInMb?: (number | string)␊ - /**␊ - * The exclusion list.␊ - */␊ - exclusions?: (ApplicationGatewayFirewallExclusion4[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allows to disable rules within a rule group or an entire rule group.␊ - */␊ - export interface ApplicationGatewayFirewallDisabledRuleGroup13 {␊ - /**␊ - * The name of the rule group that will be disabled.␊ - */␊ - ruleGroupName: string␊ - /**␊ - * The list of rules that will be disabled. If null, all rules of the rule group will be disabled.␊ - */␊ - rules?: (number[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allow to exclude some variable satisfy the condition for the WAF check.␊ - */␊ - export interface ApplicationGatewayFirewallExclusion4 {␊ - /**␊ - * The variable to be excluded.␊ - */␊ - matchVariable: string␊ - /**␊ - * When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to.␊ - */␊ - selectorMatchOperator: string␊ - /**␊ - * When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to.␊ - */␊ - selector: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application Gateway autoscale configuration.␊ - */␊ - export interface ApplicationGatewayAutoscaleConfiguration7 {␊ - /**␊ - * Lower bound on number of Application Gateway capacity.␊ - */␊ - minCapacity: (number | string)␊ - /**␊ - * Upper bound on number of Application Gateway capacity.␊ - */␊ - maxCapacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the resource.␊ - */␊ - export interface ManagedServiceIdentity3 {␊ - /**␊ - * The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.␊ - */␊ - type?: ("SystemAssigned" | "UserAssigned" | "SystemAssigned, UserAssigned" | "None")␊ - /**␊ - * The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.␊ - */␊ - userAssignedIdentities?: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies␊ - */␊ - export interface ApplicationGatewayWebApplicationFirewallPolicies1 {␊ - name: string␊ - type: "Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the web application firewall policy.␊ - */␊ - properties: (WebApplicationFirewallPolicyPropertiesFormat1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines web application firewall policy properties.␊ - */␊ - export interface WebApplicationFirewallPolicyPropertiesFormat1 {␊ - /**␊ - * Describes policySettings for policy.␊ - */␊ - policySettings?: (PolicySettings3 | string)␊ - /**␊ - * Describes custom rules inside the policy.␊ - */␊ - customRules?: (WebApplicationFirewallCustomRule1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines contents of a web application firewall global configuration.␊ - */␊ - export interface PolicySettings3 {␊ - /**␊ - * Describes if the policy is in enabled state or disabled state.␊ - */␊ - enabledState?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * Describes if it is in detection mode or prevention mode at policy level.␊ - */␊ - mode?: (("Prevention" | "Detection") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines contents of a web application rule.␊ - */␊ - export interface WebApplicationFirewallCustomRule1 {␊ - /**␊ - * Gets name of the resource that is unique within a policy. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value.␊ - */␊ - priority: (number | string)␊ - /**␊ - * Describes type of rule.␊ - */␊ - ruleType: (("MatchRule" | "Invalid") | string)␊ - /**␊ - * List of match conditions.␊ - */␊ - matchConditions: (MatchCondition3[] | string)␊ - /**␊ - * Type of Actions.␊ - */␊ - action: (("Allow" | "Block" | "Log") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Define match conditions.␊ - */␊ - export interface MatchCondition3 {␊ - /**␊ - * List of match variables.␊ - */␊ - matchVariables: (MatchVariable1[] | string)␊ - /**␊ - * Describes operator to be matched.␊ - */␊ - operator: (("IPMatch" | "Equal" | "Contains" | "LessThan" | "GreaterThan" | "LessThanOrEqual" | "GreaterThanOrEqual" | "BeginsWith" | "EndsWith" | "Regex") | string)␊ - /**␊ - * Describes if this is negate condition or not.␊ - */␊ - negationConditon?: (boolean | string)␊ - /**␊ - * Match value.␊ - */␊ - matchValues: (string[] | string)␊ - /**␊ - * List of transforms.␊ - */␊ - transforms?: (("Lowercase" | "Trim" | "UrlDecode" | "UrlEncode" | "RemoveNulls" | "HtmlEntityDecode")[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Define match variables.␊ - */␊ - export interface MatchVariable1 {␊ - /**␊ - * Match Variable.␊ - */␊ - variableName: (("RemoteAddr" | "RequestMethod" | "QueryString" | "PostArgs" | "RequestUri" | "RequestHeaders" | "RequestBody" | "RequestCookies") | string)␊ - /**␊ - * Describes field of the matchVariable collection.␊ - */␊ - selector?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/applicationSecurityGroups␊ - */␊ - export interface ApplicationSecurityGroups13 {␊ - name: string␊ - type: "Microsoft.Network/applicationSecurityGroups"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the application security group.␊ - */␊ - properties: (ApplicationSecurityGroupPropertiesFormat | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application security group properties.␊ - */␊ - export interface ApplicationSecurityGroupPropertiesFormat {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/azureFirewalls␊ - */␊ - export interface AzureFirewalls3 {␊ - name: string␊ - type: "Microsoft.Network/azureFirewalls"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the azure firewall.␊ - */␊ - properties: (AzureFirewallPropertiesFormat3 | string)␊ - /**␊ - * A list of availability zones denoting where the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Azure Firewall.␊ - */␊ - export interface AzureFirewallPropertiesFormat3 {␊ - /**␊ - * Collection of application rule collections used by Azure Firewall.␊ - */␊ - applicationRuleCollections?: (AzureFirewallApplicationRuleCollection3[] | string)␊ - /**␊ - * Collection of NAT rule collections used by Azure Firewall.␊ - */␊ - natRuleCollections?: (AzureFirewallNatRuleCollection[] | string)␊ - /**␊ - * Collection of network rule collections used by Azure Firewall.␊ - */␊ - networkRuleCollections?: (AzureFirewallNetworkRuleCollection3[] | string)␊ - /**␊ - * IP configuration of the Azure Firewall resource.␊ - */␊ - ipConfigurations?: (AzureFirewallIPConfiguration3[] | string)␊ - /**␊ - * The operation mode for Threat Intelligence.␊ - */␊ - threatIntelMode?: (("Alert" | "Deny" | "Off") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application rule collection resource.␊ - */␊ - export interface AzureFirewallApplicationRuleCollection3 {␊ - /**␊ - * Properties of the azure firewall application rule collection.␊ - */␊ - properties?: (AzureFirewallApplicationRuleCollectionPropertiesFormat3 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application rule collection.␊ - */␊ - export interface AzureFirewallApplicationRuleCollectionPropertiesFormat3 {␊ - /**␊ - * Priority of the application rule collection resource.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * The action type of a rule collection.␊ - */␊ - action?: (AzureFirewallRCAction3 | string)␊ - /**␊ - * Collection of rules used by a application rule collection.␊ - */␊ - rules?: (AzureFirewallApplicationRule3[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the AzureFirewallRCAction.␊ - */␊ - export interface AzureFirewallRCAction3 {␊ - /**␊ - * The type of action.␊ - */␊ - type?: ("Allow" | "Deny")␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of an application rule.␊ - */␊ - export interface AzureFirewallApplicationRule3 {␊ - /**␊ - * Name of the application rule.␊ - */␊ - name?: string␊ - /**␊ - * Description of the rule.␊ - */␊ - description?: string␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * Array of ApplicationRuleProtocols.␊ - */␊ - protocols?: (AzureFirewallApplicationRuleProtocol3[] | string)␊ - /**␊ - * List of FQDNs for this rule.␊ - */␊ - targetFqdns?: (string[] | string)␊ - /**␊ - * List of FQDN Tags for this rule.␊ - */␊ - fqdnTags?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application rule protocol.␊ - */␊ - export interface AzureFirewallApplicationRuleProtocol3 {␊ - /**␊ - * Protocol type.␊ - */␊ - protocolType?: (("Http" | "Https") | string)␊ - /**␊ - * Port number for the protocol, cannot be greater than 64000. This field is optional.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NAT rule collection resource.␊ - */␊ - export interface AzureFirewallNatRuleCollection {␊ - /**␊ - * Properties of the azure firewall NAT rule collection.␊ - */␊ - properties?: (AzureFirewallNatRuleCollectionProperties | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the NAT rule collection.␊ - */␊ - export interface AzureFirewallNatRuleCollectionProperties {␊ - /**␊ - * Priority of the NAT rule collection resource.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * The action type of a NAT rule collection.␊ - */␊ - action?: (AzureFirewallNatRCAction | string)␊ - /**␊ - * Collection of rules used by a NAT rule collection.␊ - */␊ - rules?: (AzureFirewallNatRule[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AzureFirewall NAT Rule Collection Action.␊ - */␊ - export interface AzureFirewallNatRCAction {␊ - /**␊ - * The type of action.␊ - */␊ - type?: ("Snat" | "Dnat")␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a NAT rule.␊ - */␊ - export interface AzureFirewallNatRule {␊ - /**␊ - * Name of the NAT rule.␊ - */␊ - name?: string␊ - /**␊ - * Description of the rule.␊ - */␊ - description?: string␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags.␊ - */␊ - destinationAddresses?: (string[] | string)␊ - /**␊ - * List of destination ports.␊ - */␊ - destinationPorts?: (string[] | string)␊ - /**␊ - * Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule.␊ - */␊ - protocols?: (("TCP" | "UDP" | "Any" | "ICMP")[] | string)␊ - /**␊ - * The translated address for this NAT rule.␊ - */␊ - translatedAddress?: string␊ - /**␊ - * The translated port for this NAT rule.␊ - */␊ - translatedPort?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network rule collection resource.␊ - */␊ - export interface AzureFirewallNetworkRuleCollection3 {␊ - /**␊ - * Properties of the azure firewall network rule collection.␊ - */␊ - properties?: (AzureFirewallNetworkRuleCollectionPropertiesFormat3 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the network rule collection.␊ - */␊ - export interface AzureFirewallNetworkRuleCollectionPropertiesFormat3 {␊ - /**␊ - * Priority of the network rule collection resource.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * The action type of a rule collection.␊ - */␊ - action?: (AzureFirewallRCAction3 | string)␊ - /**␊ - * Collection of rules used by a network rule collection.␊ - */␊ - rules?: (AzureFirewallNetworkRule3[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the network rule.␊ - */␊ - export interface AzureFirewallNetworkRule3 {␊ - /**␊ - * Name of the network rule.␊ - */␊ - name?: string␊ - /**␊ - * Description of the rule.␊ - */␊ - description?: string␊ - /**␊ - * Array of AzureFirewallNetworkRuleProtocols.␊ - */␊ - protocols?: (("TCP" | "UDP" | "Any" | "ICMP")[] | string)␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * List of destination IP addresses.␊ - */␊ - destinationAddresses?: (string[] | string)␊ - /**␊ - * List of destination ports.␊ - */␊ - destinationPorts?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration of an Azure Firewall.␊ - */␊ - export interface AzureFirewallIPConfiguration3 {␊ - /**␊ - * Properties of the azure firewall IP configuration.␊ - */␊ - properties?: (AzureFirewallIPConfigurationPropertiesFormat3 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration of an Azure Firewall.␊ - */␊ - export interface AzureFirewallIPConfigurationPropertiesFormat3 {␊ - /**␊ - * Reference of the subnet resource. This resource must be named 'AzureFirewallSubnet'.␊ - */␊ - subnet?: (SubResource23 | string)␊ - /**␊ - * Reference of the PublicIP resource. This field is a mandatory input if subnet is not null.␊ - */␊ - publicIPAddress?: (SubResource23 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/bastionHosts␊ - */␊ - export interface BastionHosts {␊ - name: string␊ - type: "Microsoft.Network/bastionHosts"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Represents the bastion host resource.␊ - */␊ - properties: (BastionHostPropertiesFormat | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Bastion Host.␊ - */␊ - export interface BastionHostPropertiesFormat {␊ - /**␊ - * IP configuration of the Bastion Host resource.␊ - */␊ - ipConfigurations?: (BastionHostIPConfiguration[] | string)␊ - /**␊ - * FQDN for the endpoint on which bastion host is accessible.␊ - */␊ - dnsName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration of an Bastion Host.␊ - */␊ - export interface BastionHostIPConfiguration {␊ - /**␊ - * Represents the ip configuration associated with the resource.␊ - */␊ - properties?: (BastionHostIPConfigurationPropertiesFormat | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration of an Bastion Host.␊ - */␊ - export interface BastionHostIPConfigurationPropertiesFormat {␊ - /**␊ - * Reference of the subnet resource.␊ - */␊ - subnet: (SubResource23 | string)␊ - /**␊ - * Reference of the PublicIP resource.␊ - */␊ - publicIPAddress: (SubResource23 | string)␊ - /**␊ - * Private IP allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/connections␊ - */␊ - export interface Connections13 {␊ - name: string␊ - type: "Microsoft.Network/connections"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway connection.␊ - */␊ - properties: (VirtualNetworkGatewayConnectionPropertiesFormat13 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewayConnection properties.␊ - */␊ - export interface VirtualNetworkGatewayConnectionPropertiesFormat13 {␊ - /**␊ - * The authorizationKey.␊ - */␊ - authorizationKey?: string␊ - /**␊ - * The reference to virtual network gateway resource.␊ - */␊ - virtualNetworkGateway1: (SubResource23 | string)␊ - /**␊ - * The reference to virtual network gateway resource.␊ - */␊ - virtualNetworkGateway2?: (SubResource23 | string)␊ - /**␊ - * The reference to local network gateway resource.␊ - */␊ - localNetworkGateway2?: (SubResource23 | string)␊ - /**␊ - * Gateway connection type.␊ - */␊ - connectionType: (("IPsec" | "Vnet2Vnet" | "ExpressRoute" | "VPNClient") | string)␊ - /**␊ - * Connection protocol used for this connection.␊ - */␊ - connectionProtocol?: (("IKEv2" | "IKEv1") | string)␊ - /**␊ - * The routing weight.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * The IPSec shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The reference to peerings resource.␊ - */␊ - peer?: (SubResource23 | string)␊ - /**␊ - * EnableBgp flag.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * Enable policy-based traffic selectors.␊ - */␊ - usePolicyBasedTrafficSelectors?: (boolean | string)␊ - /**␊ - * The IPSec Policies to be considered by this connection.␊ - */␊ - ipsecPolicies?: (IpsecPolicy10[] | string)␊ - /**␊ - * Bypass ExpressRoute Gateway for data forwarding.␊ - */␊ - expressRouteGatewayBypass?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An IPSec Policy configuration for a virtual network gateway connection.␊ - */␊ - export interface IpsecPolicy10 {␊ - /**␊ - * The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.␊ - */␊ - saLifeTimeSeconds: (number | string)␊ - /**␊ - * The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.␊ - */␊ - saDataSizeKilobytes: (number | string)␊ - /**␊ - * The IPSec encryption algorithm (IKE phase 1).␊ - */␊ - ipsecEncryption: (("None" | "DES" | "DES3" | "AES128" | "AES192" | "AES256" | "GCMAES128" | "GCMAES192" | "GCMAES256") | string)␊ - /**␊ - * The IPSec integrity algorithm (IKE phase 1).␊ - */␊ - ipsecIntegrity: (("MD5" | "SHA1" | "SHA256" | "GCMAES128" | "GCMAES192" | "GCMAES256") | string)␊ - /**␊ - * The IKE encryption algorithm (IKE phase 2).␊ - */␊ - ikeEncryption: (("DES" | "DES3" | "AES128" | "AES192" | "AES256" | "GCMAES256" | "GCMAES128") | string)␊ - /**␊ - * The IKE integrity algorithm (IKE phase 2).␊ - */␊ - ikeIntegrity: (("MD5" | "SHA1" | "SHA256" | "SHA384" | "GCMAES256" | "GCMAES128") | string)␊ - /**␊ - * The DH Group used in IKE Phase 1 for initial SA.␊ - */␊ - dhGroup: (("None" | "DHGroup1" | "DHGroup2" | "DHGroup14" | "DHGroup2048" | "ECP256" | "ECP384" | "DHGroup24") | string)␊ - /**␊ - * The Pfs Group used in IKE Phase 2 for new child SA.␊ - */␊ - pfsGroup: (("None" | "PFS1" | "PFS2" | "PFS2048" | "ECP256" | "ECP384" | "PFS24" | "PFS14" | "PFSMM") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ddosCustomPolicies␊ - */␊ - export interface DdosCustomPolicies {␊ - name: string␊ - type: "Microsoft.Network/ddosCustomPolicies"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the DDoS custom policy.␊ - */␊ - properties: (DdosCustomPolicyPropertiesFormat | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DDoS custom policy properties.␊ - */␊ - export interface DdosCustomPolicyPropertiesFormat {␊ - /**␊ - * The protocol-specific DDoS policy customization parameters.␊ - */␊ - protocolCustomSettings?: (ProtocolCustomSettingsFormat[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DDoS custom policy properties.␊ - */␊ - export interface ProtocolCustomSettingsFormat {␊ - /**␊ - * The protocol for which the DDoS protection policy is being customized.␊ - */␊ - protocol?: (("Tcp" | "Udp" | "Syn") | string)␊ - /**␊ - * The customized DDoS protection trigger rate.␊ - */␊ - triggerRateOverride?: string␊ - /**␊ - * The customized DDoS protection source rate.␊ - */␊ - sourceRateOverride?: string␊ - /**␊ - * The customized DDoS protection trigger rate sensitivity degrees. High: Trigger rate set with most sensitivity w.r.t. normal traffic. Default: Trigger rate set with moderate sensitivity w.r.t. normal traffic. Low: Trigger rate set with less sensitivity w.r.t. normal traffic. Relaxed: Trigger rate set with least sensitivity w.r.t. normal traffic.␊ - */␊ - triggerSensitivityOverride?: (("Relaxed" | "Low" | "Default" | "High") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ddosProtectionPlans␊ - */␊ - export interface DdosProtectionPlans8 {␊ - name: string␊ - type: "Microsoft.Network/ddosProtectionPlans"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the DDoS protection plan.␊ - */␊ - properties: (DdosProtectionPlanPropertiesFormat5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DDoS protection plan properties.␊ - */␊ - export interface DdosProtectionPlanPropertiesFormat5 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits␊ - */␊ - export interface ExpressRouteCircuits10 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The SKU.␊ - */␊ - sku?: (ExpressRouteCircuitSku10 | string)␊ - /**␊ - * Properties of the express route circuit.␊ - */␊ - properties: (ExpressRouteCircuitPropertiesFormat10 | string)␊ - resources?: (ExpressRouteCircuitsPeeringsChildResource10 | ExpressRouteCircuitsAuthorizationsChildResource10)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains SKU in an ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitSku10 {␊ - /**␊ - * The name of the SKU.␊ - */␊ - name?: string␊ - /**␊ - * The tier of the SKU.␊ - */␊ - tier?: (("Standard" | "Premium" | "Basic" | "Local") | string)␊ - /**␊ - * The family of the SKU.␊ - */␊ - family?: (("UnlimitedData" | "MeteredData") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitPropertiesFormat10 {␊ - /**␊ - * Allow classic operations.␊ - */␊ - allowClassicOperations?: (boolean | string)␊ - /**␊ - * The list of authorizations.␊ - */␊ - authorizations?: (ExpressRouteCircuitAuthorization10[] | string)␊ - /**␊ - * The list of peerings.␊ - */␊ - peerings?: (ExpressRouteCircuitPeering10[] | string)␊ - /**␊ - * The ServiceProviderNotes.␊ - */␊ - serviceProviderNotes?: string␊ - /**␊ - * The ServiceProviderProperties.␊ - */␊ - serviceProviderProperties?: (ExpressRouteCircuitServiceProviderProperties10 | string)␊ - /**␊ - * The reference to the ExpressRoutePort resource when the circuit is provisioned on an ExpressRoutePort resource.␊ - */␊ - expressRoutePort?: (SubResource23 | string)␊ - /**␊ - * The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource.␊ - */␊ - bandwidthInGbps?: (number | string)␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authorization in an ExpressRouteCircuit resource.␊ - */␊ - export interface ExpressRouteCircuitAuthorization10 {␊ - /**␊ - * Properties of the express route circuit authorization.␊ - */␊ - properties?: (AuthorizationPropertiesFormat11 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ExpressRouteCircuitAuthorization.␊ - */␊ - export interface AuthorizationPropertiesFormat11 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peering in an ExpressRouteCircuit resource.␊ - */␊ - export interface ExpressRouteCircuitPeering10 {␊ - /**␊ - * Properties of the express route circuit peering.␊ - */␊ - properties?: (ExpressRouteCircuitPeeringPropertiesFormat11 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the express route circuit peering.␊ - */␊ - export interface ExpressRouteCircuitPeeringPropertiesFormat11 {␊ - /**␊ - * The peering type.␊ - */␊ - peeringType?: (("AzurePublicPeering" | "AzurePrivatePeering" | "MicrosoftPeering") | string)␊ - /**␊ - * The peering state.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * The peer ASN.␊ - */␊ - peerASN?: (number | string)␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The VLAN ID.␊ - */␊ - vlanId?: (number | string)␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig11 | string)␊ - /**␊ - * Gets peering stats.␊ - */␊ - stats?: (ExpressRouteCircuitStats11 | string)␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - /**␊ - * The reference of the RouteFilter resource.␊ - */␊ - routeFilter?: (SubResource23 | string)␊ - /**␊ - * The IPv6 peering configuration.␊ - */␊ - ipv6PeeringConfig?: (Ipv6ExpressRouteCircuitPeeringConfig8 | string)␊ - /**␊ - * The ExpressRoute connection.␊ - */␊ - expressRouteConnection?: (SubResource23 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the peering configuration.␊ - */␊ - export interface ExpressRouteCircuitPeeringConfig11 {␊ - /**␊ - * The reference of AdvertisedPublicPrefixes.␊ - */␊ - advertisedPublicPrefixes?: (string[] | string)␊ - /**␊ - * The communities of bgp peering. Specified for microsoft peering.␊ - */␊ - advertisedCommunities?: (string[] | string)␊ - /**␊ - * The legacy mode of the peering.␊ - */␊ - legacyMode?: (number | string)␊ - /**␊ - * The CustomerASN of the peering.␊ - */␊ - customerASN?: (number | string)␊ - /**␊ - * The RoutingRegistryName of the configuration.␊ - */␊ - routingRegistryName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains stats associated with the peering.␊ - */␊ - export interface ExpressRouteCircuitStats11 {␊ - /**␊ - * Gets BytesIn of the peering.␊ - */␊ - primarybytesIn?: (number | string)␊ - /**␊ - * Gets BytesOut of the peering.␊ - */␊ - primarybytesOut?: (number | string)␊ - /**␊ - * Gets BytesIn of the peering.␊ - */␊ - secondarybytesIn?: (number | string)␊ - /**␊ - * Gets BytesOut of the peering.␊ - */␊ - secondarybytesOut?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains IPv6 peering config.␊ - */␊ - export interface Ipv6ExpressRouteCircuitPeeringConfig8 {␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig11 | string)␊ - /**␊ - * The reference of the RouteFilter resource.␊ - */␊ - routeFilter?: (SubResource23 | string)␊ - /**␊ - * The state of peering.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains ServiceProviderProperties in an ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitServiceProviderProperties10 {␊ - /**␊ - * The serviceProviderName.␊ - */␊ - serviceProviderName?: string␊ - /**␊ - * The peering location.␊ - */␊ - peeringLocation?: string␊ - /**␊ - * The BandwidthInMbps.␊ - */␊ - bandwidthInMbps?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings␊ - */␊ - export interface ExpressRouteCircuitsPeeringsChildResource10 {␊ - name: string␊ - type: "peerings"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Properties of the express route circuit peering.␊ - */␊ - properties: (ExpressRouteCircuitPeeringPropertiesFormat11 | string)␊ - resources?: ExpressRouteCircuitsPeeringsConnectionsChildResource8[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings/connections␊ - */␊ - export interface ExpressRouteCircuitsPeeringsConnectionsChildResource8 {␊ - name: string␊ - type: "connections"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Properties of the express route circuit connection.␊ - */␊ - properties: (ExpressRouteCircuitConnectionPropertiesFormat8 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the express route circuit connection.␊ - */␊ - export interface ExpressRouteCircuitConnectionPropertiesFormat8 {␊ - /**␊ - * Reference to Express Route Circuit Private Peering Resource of the circuit initiating connection.␊ - */␊ - expressRouteCircuitPeering?: (SubResource23 | string)␊ - /**␊ - * Reference to Express Route Circuit Private Peering Resource of the peered circuit.␊ - */␊ - peerExpressRouteCircuitPeering?: (SubResource23 | string)␊ - /**␊ - * /29 IP address space to carve out Customer addresses for tunnels.␊ - */␊ - addressPrefix?: string␊ - /**␊ - * The authorization key.␊ - */␊ - authorizationKey?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/authorizations␊ - */␊ - export interface ExpressRouteCircuitsAuthorizationsChildResource10 {␊ - name: string␊ - type: "authorizations"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Properties of the express route circuit authorization.␊ - */␊ - properties: (AuthorizationPropertiesFormat11 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/authorizations␊ - */␊ - export interface ExpressRouteCircuitsAuthorizations11 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/authorizations"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Properties of the express route circuit authorization.␊ - */␊ - properties: (AuthorizationPropertiesFormat11 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings␊ - */␊ - export interface ExpressRouteCircuitsPeerings10 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/peerings"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Properties of the express route circuit peering.␊ - */␊ - properties: (ExpressRouteCircuitPeeringPropertiesFormat11 | string)␊ - resources?: ExpressRouteCircuitsPeeringsConnectionsChildResource8[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings/connections␊ - */␊ - export interface ExpressRouteCircuitsPeeringsConnections8 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/peerings/connections"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Properties of the express route circuit connection.␊ - */␊ - properties: (ExpressRouteCircuitConnectionPropertiesFormat8 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections␊ - */␊ - export interface ExpressRouteCrossConnections8 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCrossConnections"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the express route cross connection.␊ - */␊ - properties: (ExpressRouteCrossConnectionProperties8 | string)␊ - resources?: ExpressRouteCrossConnectionsPeeringsChildResource8[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ExpressRouteCrossConnection.␊ - */␊ - export interface ExpressRouteCrossConnectionProperties8 {␊ - /**␊ - * The peering location of the ExpressRoute circuit.␊ - */␊ - peeringLocation?: string␊ - /**␊ - * The circuit bandwidth In Mbps.␊ - */␊ - bandwidthInMbps?: (number | string)␊ - /**␊ - * The ExpressRouteCircuit.␊ - */␊ - expressRouteCircuit?: (SubResource23 | string)␊ - /**␊ - * The provisioning state of the circuit in the connectivity provider system.␊ - */␊ - serviceProviderProvisioningState?: (("NotProvisioned" | "Provisioning" | "Provisioned" | "Deprovisioning") | string)␊ - /**␊ - * Additional read only notes set by the connectivity provider.␊ - */␊ - serviceProviderNotes?: string␊ - /**␊ - * The list of peerings.␊ - */␊ - peerings?: (ExpressRouteCrossConnectionPeering8[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peering in an ExpressRoute Cross Connection resource.␊ - */␊ - export interface ExpressRouteCrossConnectionPeering8 {␊ - /**␊ - * Properties of the express route cross connection peering.␊ - */␊ - properties?: (ExpressRouteCrossConnectionPeeringProperties8 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of express route cross connection peering.␊ - */␊ - export interface ExpressRouteCrossConnectionPeeringProperties8 {␊ - /**␊ - * The peering type.␊ - */␊ - peeringType?: (("AzurePublicPeering" | "AzurePrivatePeering" | "MicrosoftPeering") | string)␊ - /**␊ - * The peering state.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * The peer ASN.␊ - */␊ - peerASN?: (number | string)␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The VLAN ID.␊ - */␊ - vlanId?: (number | string)␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig11 | string)␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - /**␊ - * The IPv6 peering configuration.␊ - */␊ - ipv6PeeringConfig?: (Ipv6ExpressRouteCircuitPeeringConfig8 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections/peerings␊ - */␊ - export interface ExpressRouteCrossConnectionsPeeringsChildResource8 {␊ - name: string␊ - type: "peerings"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Properties of the express route cross connection peering.␊ - */␊ - properties: (ExpressRouteCrossConnectionPeeringProperties8 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections/peerings␊ - */␊ - export interface ExpressRouteCrossConnectionsPeerings7 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCrossConnections/peerings"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Properties of the express route cross connection peering.␊ - */␊ - properties: (ExpressRouteCrossConnectionPeeringProperties8 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteGateways␊ - */␊ - export interface ExpressRouteGateways {␊ - name: string␊ - type: "Microsoft.Network/expressRouteGateways"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the express route gateway.␊ - */␊ - properties: (ExpressRouteGatewayProperties | string)␊ - resources?: ExpressRouteGatewaysExpressRouteConnectionsChildResource[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ExpressRoute gateway resource properties.␊ - */␊ - export interface ExpressRouteGatewayProperties {␊ - /**␊ - * Configuration for auto scaling.␊ - */␊ - autoScaleConfiguration?: (ExpressRouteGatewayPropertiesAutoScaleConfiguration | string)␊ - /**␊ - * The Virtual Hub where the ExpressRoute gateway is or will be deployed.␊ - */␊ - virtualHub: (SubResource23 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Configuration for auto scaling.␊ - */␊ - export interface ExpressRouteGatewayPropertiesAutoScaleConfiguration {␊ - /**␊ - * Minimum and maximum number of scale units to deploy.␊ - */␊ - bounds?: (ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Minimum and maximum number of scale units to deploy.␊ - */␊ - export interface ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds {␊ - /**␊ - * Minimum number of scale units deployed for ExpressRoute gateway.␊ - */␊ - min?: (number | string)␊ - /**␊ - * Maximum number of scale units deployed for ExpressRoute gateway.␊ - */␊ - max?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteGateways/expressRouteConnections␊ - */␊ - export interface ExpressRouteGatewaysExpressRouteConnectionsChildResource {␊ - name: string␊ - type: "expressRouteConnections"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Properties of the express route connection.␊ - */␊ - properties: (ExpressRouteConnectionProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the ExpressRouteConnection subresource.␊ - */␊ - export interface ExpressRouteConnectionProperties {␊ - /**␊ - * The ExpressRoute circuit peering.␊ - */␊ - expressRouteCircuitPeering: (SubResource23 | string)␊ - /**␊ - * Authorization key to establish the connection.␊ - */␊ - authorizationKey?: string␊ - /**␊ - * The routing weight associated to the connection.␊ - */␊ - routingWeight?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteGateways/expressRouteConnections␊ - */␊ - export interface ExpressRouteGatewaysExpressRouteConnections {␊ - name: string␊ - type: "Microsoft.Network/expressRouteGateways/expressRouteConnections"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Properties of the express route connection.␊ - */␊ - properties: (ExpressRouteConnectionProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ExpressRoutePorts␊ - */␊ - export interface ExpressRoutePorts3 {␊ - name: string␊ - type: "Microsoft.Network/ExpressRoutePorts"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * ExpressRoutePort properties.␊ - */␊ - properties: (ExpressRoutePortPropertiesFormat3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to ExpressRoutePort resources.␊ - */␊ - export interface ExpressRoutePortPropertiesFormat3 {␊ - /**␊ - * The name of the peering location that the ExpressRoutePort is mapped to physically.␊ - */␊ - peeringLocation?: string␊ - /**␊ - * Bandwidth of procured ports in Gbps.␊ - */␊ - bandwidthInGbps?: (number | string)␊ - /**␊ - * Encapsulation method on physical ports.␊ - */␊ - encapsulation?: (("Dot1Q" | "QinQ") | string)␊ - /**␊ - * The set of physical links of the ExpressRoutePort resource.␊ - */␊ - links?: (ExpressRouteLink3[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ExpressRouteLink child resource definition.␊ - */␊ - export interface ExpressRouteLink3 {␊ - /**␊ - * ExpressRouteLink properties.␊ - */␊ - properties?: (ExpressRouteLinkPropertiesFormat3 | string)␊ - /**␊ - * Name of child port resource that is unique among child port resources of the parent.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to ExpressRouteLink resources.␊ - */␊ - export interface ExpressRouteLinkPropertiesFormat3 {␊ - /**␊ - * Administrative state of the physical port.␊ - */␊ - adminState?: (("Enabled" | "Disabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers␊ - */␊ - export interface LoadBalancers25 {␊ - name: string␊ - type: "Microsoft.Network/loadBalancers"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The load balancer SKU.␊ - */␊ - sku?: (LoadBalancerSku13 | string)␊ - /**␊ - * Properties of load balancer.␊ - */␊ - properties: (LoadBalancerPropertiesFormat17 | string)␊ - resources?: LoadBalancersInboundNatRulesChildResource13[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a load balancer.␊ - */␊ - export interface LoadBalancerSku13 {␊ - /**␊ - * Name of a load balancer SKU.␊ - */␊ - name?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer.␊ - */␊ - export interface LoadBalancerPropertiesFormat17 {␊ - /**␊ - * Object representing the frontend IPs to be used for the load balancer.␊ - */␊ - frontendIPConfigurations?: (FrontendIPConfiguration16[] | string)␊ - /**␊ - * Collection of backend address pools used by a load balancer.␊ - */␊ - backendAddressPools?: (BackendAddressPool17[] | string)␊ - /**␊ - * Object collection representing the load balancing rules Gets the provisioning.␊ - */␊ - loadBalancingRules?: (LoadBalancingRule17[] | string)␊ - /**␊ - * Collection of probe objects used in the load balancer.␊ - */␊ - probes?: (Probe17[] | string)␊ - /**␊ - * Collection of inbound NAT Rules used by a load balancer. Defining inbound NAT rules on your load balancer is mutually exclusive with defining an inbound NAT pool. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an Inbound NAT pool. They have to reference individual inbound NAT rules.␊ - */␊ - inboundNatRules?: (InboundNatRule18[] | string)␊ - /**␊ - * Defines an external port range for inbound NAT to a single backend port on NICs associated with a load balancer. Inbound NAT rules are created automatically for each NIC associated with the Load Balancer using an external port from this range. Defining an Inbound NAT pool on your Load Balancer is mutually exclusive with defining inbound Nat rules. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an inbound NAT pool. They have to reference individual inbound NAT rules.␊ - */␊ - inboundNatPools?: (InboundNatPool18[] | string)␊ - /**␊ - * The outbound rules.␊ - */␊ - outboundRules?: (OutboundRule5[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP address of the load balancer.␊ - */␊ - export interface FrontendIPConfiguration16 {␊ - /**␊ - * Properties of the load balancer probe.␊ - */␊ - properties?: (FrontendIPConfigurationPropertiesFormat16 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP Configuration of the load balancer.␊ - */␊ - export interface FrontendIPConfigurationPropertiesFormat16 {␊ - /**␊ - * The private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The Private IP allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * It represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4.␊ - */␊ - privateIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The reference of the subnet resource.␊ - */␊ - subnet?: (SubResource23 | string)␊ - /**␊ - * The reference of the Public IP resource.␊ - */␊ - publicIPAddress?: (SubResource23 | string)␊ - /**␊ - * The reference of the Public IP Prefix resource.␊ - */␊ - publicIPPrefix?: (SubResource23 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Pool of backend IP addresses.␊ - */␊ - export interface BackendAddressPool17 {␊ - /**␊ - * Properties of load balancer backend address pool.␊ - */␊ - properties?: (BackendAddressPoolPropertiesFormat17 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the backend address pool.␊ - */␊ - export interface BackendAddressPoolPropertiesFormat17 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A load balancing rule for a load balancer.␊ - */␊ - export interface LoadBalancingRule17 {␊ - /**␊ - * Properties of load balancer load balancing rule.␊ - */␊ - properties?: (LoadBalancingRulePropertiesFormat17 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer.␊ - */␊ - export interface LoadBalancingRulePropertiesFormat17 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource23 | string)␊ - /**␊ - * A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs.␊ - */␊ - backendAddressPool?: (SubResource23 | string)␊ - /**␊ - * The reference of the load balancer probe used by the load balancing rule.␊ - */␊ - probe?: (SubResource23 | string)␊ - /**␊ - * The reference to the transport protocol used by the load balancing rule.␊ - */␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The load distribution policy for this rule.␊ - */␊ - loadDistribution?: (("Default" | "SourceIP" | "SourceIPProtocol") | string)␊ - /**␊ - * The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 0 and 65534. Note that value 0 enables "Any Port".␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port".␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - /**␊ - * Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule.␊ - */␊ - disableOutboundSnat?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A load balancer probe.␊ - */␊ - export interface Probe17 {␊ - /**␊ - * Properties of load balancer probe.␊ - */␊ - properties?: (ProbePropertiesFormat17 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Load balancer probe resource.␊ - */␊ - export interface ProbePropertiesFormat17 {␊ - /**␊ - * The protocol of the end point. If 'Tcp' is specified, a received ACK is required for the probe to be successful. If 'Http' or 'Https' is specified, a 200 OK response from the specifies URI is required for the probe to be successful.␊ - */␊ - protocol: (("Http" | "Tcp" | "Https") | string)␊ - /**␊ - * The port for communicating the probe. Possible values range from 1 to 65535, inclusive.␊ - */␊ - port: (number | string)␊ - /**␊ - * The interval, in seconds, for how frequently to probe the endpoint for health status. Typically, the interval is slightly less than half the allocated timeout period (in seconds) which allows two full probes before taking the instance out of rotation. The default value is 15, the minimum value is 5.␊ - */␊ - intervalInSeconds?: (number | string)␊ - /**␊ - * The number of probes where if no response, will result in stopping further traffic from being delivered to the endpoint. This values allows endpoints to be taken out of rotation faster or slower than the typical times used in Azure.␊ - */␊ - numberOfProbes: (number | string)␊ - /**␊ - * The URI used for requesting health status from the VM. Path is required if a protocol is set to http. Otherwise, it is not allowed. There is no default value.␊ - */␊ - requestPath?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT rule of the load balancer.␊ - */␊ - export interface InboundNatRule18 {␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties?: (InboundNatRulePropertiesFormat17 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the inbound NAT rule.␊ - */␊ - export interface InboundNatRulePropertiesFormat17 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource23 | string)␊ - /**␊ - * The reference to the transport protocol used by the load balancing rule.␊ - */␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values range from 1 to 65534.␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * The port used for the internal endpoint. Acceptable values range from 1 to 65535.␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT pool of the load balancer.␊ - */␊ - export interface InboundNatPool18 {␊ - /**␊ - * Properties of load balancer inbound nat pool.␊ - */␊ - properties?: (InboundNatPoolPropertiesFormat17 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Inbound NAT pool.␊ - */␊ - export interface InboundNatPoolPropertiesFormat17 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource23 | string)␊ - /**␊ - * The reference to the transport protocol used by the inbound NAT pool.␊ - */␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65534.␊ - */␊ - frontendPortRangeStart: (number | string)␊ - /**␊ - * The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65535.␊ - */␊ - frontendPortRangeEnd: (number | string)␊ - /**␊ - * The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound rule of the load balancer.␊ - */␊ - export interface OutboundRule5 {␊ - /**␊ - * Properties of load balancer outbound rule.␊ - */␊ - properties?: (OutboundRulePropertiesFormat5 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound rule of the load balancer.␊ - */␊ - export interface OutboundRulePropertiesFormat5 {␊ - /**␊ - * The number of outbound ports to be used for NAT.␊ - */␊ - allocatedOutboundPorts?: (number | string)␊ - /**␊ - * The Frontend IP addresses of the load balancer.␊ - */␊ - frontendIPConfigurations: (SubResource23[] | string)␊ - /**␊ - * A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs.␊ - */␊ - backendAddressPool: (SubResource23 | string)␊ - /**␊ - * The protocol for the outbound rule in load balancer.␊ - */␊ - protocol: (("Tcp" | "Udp" | "All") | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - /**␊ - * The timeout for the TCP idle connection.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers/inboundNatRules␊ - */␊ - export interface LoadBalancersInboundNatRulesChildResource13 {␊ - name: string␊ - type: "inboundNatRules"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties: (InboundNatRulePropertiesFormat17 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers/inboundNatRules␊ - */␊ - export interface LoadBalancersInboundNatRules12 {␊ - name: string␊ - type: "Microsoft.Network/loadBalancers/inboundNatRules"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties: (InboundNatRulePropertiesFormat17 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/localNetworkGateways␊ - */␊ - export interface LocalNetworkGateways13 {␊ - name: string␊ - type: "Microsoft.Network/localNetworkGateways"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the local network gateway.␊ - */␊ - properties: (LocalNetworkGatewayPropertiesFormat13 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * LocalNetworkGateway properties.␊ - */␊ - export interface LocalNetworkGatewayPropertiesFormat13 {␊ - /**␊ - * Local network site address space.␊ - */␊ - localNetworkAddressSpace?: (AddressSpace25 | string)␊ - /**␊ - * IP address of local network gateway.␊ - */␊ - gatewayIpAddress?: string␊ - /**␊ - * Local network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings12 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.␊ - */␊ - export interface AddressSpace25 {␊ - /**␊ - * A list of address blocks reserved for this virtual network in CIDR notation.␊ - */␊ - addressPrefixes: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * BGP settings details.␊ - */␊ - export interface BgpSettings12 {␊ - /**␊ - * The BGP speaker's ASN.␊ - */␊ - asn?: (number | string)␊ - /**␊ - * The BGP peering address and BGP identifier of this BGP speaker.␊ - */␊ - bgpPeeringAddress?: string␊ - /**␊ - * The weight added to routes learned from this BGP speaker.␊ - */␊ - peerWeight?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/natGateways␊ - */␊ - export interface NatGateways {␊ - name: string␊ - type: "Microsoft.Network/natGateways"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The nat gateway SKU.␊ - */␊ - sku?: (NatGatewaySku | string)␊ - /**␊ - * Nat Gateway properties.␊ - */␊ - properties: (NatGatewayPropertiesFormat | string)␊ - /**␊ - * A list of availability zones denoting the zone in which Nat Gateway should be deployed.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of nat gateway.␊ - */␊ - export interface NatGatewaySku {␊ - /**␊ - * Name of Nat Gateway SKU.␊ - */␊ - name?: ("Standard" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Nat Gateway properties.␊ - */␊ - export interface NatGatewayPropertiesFormat {␊ - /**␊ - * The idle timeout of the nat gateway.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * An array of public ip addresses associated with the nat gateway resource.␊ - */␊ - publicIpAddresses?: (SubResource23[] | string)␊ - /**␊ - * An array of public ip prefixes associated with the nat gateway resource.␊ - */␊ - publicIpPrefixes?: (SubResource23[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces␊ - */␊ - export interface NetworkInterfaces26 {␊ - name: string␊ - type: "Microsoft.Network/networkInterfaces"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network interface.␊ - */␊ - properties: (NetworkInterfacePropertiesFormat17 | string)␊ - resources?: NetworkInterfacesTapConfigurationsChildResource4[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NetworkInterface properties.␊ - */␊ - export interface NetworkInterfacePropertiesFormat17 {␊ - /**␊ - * The reference of the NetworkSecurityGroup resource.␊ - */␊ - networkSecurityGroup?: (SubResource23 | string)␊ - /**␊ - * A list of IPConfigurations of the network interface.␊ - */␊ - ipConfigurations: (NetworkInterfaceIPConfiguration16[] | string)␊ - /**␊ - * The DNS settings in network interface.␊ - */␊ - dnsSettings?: (NetworkInterfaceDnsSettings25 | string)␊ - /**␊ - * If the network interface is accelerated networking enabled.␊ - */␊ - enableAcceleratedNetworking?: (boolean | string)␊ - /**␊ - * Indicates whether IP forwarding is enabled on this network interface.␊ - */␊ - enableIPForwarding?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IPConfiguration in a network interface.␊ - */␊ - export interface NetworkInterfaceIPConfiguration16 {␊ - /**␊ - * Network interface IP configuration properties.␊ - */␊ - properties?: (NetworkInterfaceIPConfigurationPropertiesFormat16 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration.␊ - */␊ - export interface NetworkInterfaceIPConfigurationPropertiesFormat16 {␊ - /**␊ - * The reference to Virtual Network Taps.␊ - */␊ - virtualNetworkTaps?: (SubResource23[] | string)␊ - /**␊ - * The reference of ApplicationGatewayBackendAddressPool resource.␊ - */␊ - applicationGatewayBackendAddressPools?: (SubResource23[] | string)␊ - /**␊ - * The reference of LoadBalancerBackendAddressPool resource.␊ - */␊ - loadBalancerBackendAddressPools?: (SubResource23[] | string)␊ - /**␊ - * A list of references of LoadBalancerInboundNatRules.␊ - */␊ - loadBalancerInboundNatRules?: (SubResource23[] | string)␊ - /**␊ - * Private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The private IP address allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Available from Api-Version 2016-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4.␊ - */␊ - privateIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * Subnet bound to the IP configuration.␊ - */␊ - subnet?: (SubResource23 | string)␊ - /**␊ - * Gets whether this is a primary customer address on the network interface.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * Public IP address bound to the IP configuration.␊ - */␊ - publicIPAddress?: (SubResource23 | string)␊ - /**␊ - * Application security groups in which the IP configuration is included.␊ - */␊ - applicationSecurityGroups?: (SubResource23[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DNS settings of a network interface.␊ - */␊ - export interface NetworkInterfaceDnsSettings25 {␊ - /**␊ - * List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only value in dnsServers collection.␊ - */␊ - dnsServers?: (string[] | string)␊ - /**␊ - * Relative DNS name for this NIC used for internal communications between VMs in the same virtual network.␊ - */␊ - internalDnsNameLabel?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces/tapConfigurations␊ - */␊ - export interface NetworkInterfacesTapConfigurationsChildResource4 {␊ - name: string␊ - type: "tapConfigurations"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Properties of the Virtual Network Tap configuration.␊ - */␊ - properties: (NetworkInterfaceTapConfigurationPropertiesFormat4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Virtual Network Tap configuration.␊ - */␊ - export interface NetworkInterfaceTapConfigurationPropertiesFormat4 {␊ - /**␊ - * The reference of the Virtual Network Tap resource.␊ - */␊ - virtualNetworkTap?: (SubResource23 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces/tapConfigurations␊ - */␊ - export interface NetworkInterfacesTapConfigurations3 {␊ - name: string␊ - type: "Microsoft.Network/networkInterfaces/tapConfigurations"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Properties of the Virtual Network Tap configuration.␊ - */␊ - properties: (NetworkInterfaceTapConfigurationPropertiesFormat4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkProfiles␊ - */␊ - export interface NetworkProfiles {␊ - name: string␊ - type: "Microsoft.Network/networkProfiles"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Network profile properties.␊ - */␊ - properties: (NetworkProfilePropertiesFormat | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network profile properties.␊ - */␊ - export interface NetworkProfilePropertiesFormat {␊ - /**␊ - * List of chid container network interface configurations.␊ - */␊ - containerNetworkInterfaceConfigurations?: (ContainerNetworkInterfaceConfiguration[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Container network interface configuration child resource.␊ - */␊ - export interface ContainerNetworkInterfaceConfiguration {␊ - /**␊ - * Container network interface configuration properties.␊ - */␊ - properties?: (ContainerNetworkInterfaceConfigurationPropertiesFormat | string)␊ - /**␊ - * The name of the resource. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Container network interface configuration properties.␊ - */␊ - export interface ContainerNetworkInterfaceConfigurationPropertiesFormat {␊ - /**␊ - * A list of ip configurations of the container network interface configuration.␊ - */␊ - ipConfigurations?: (IPConfigurationProfile[] | string)␊ - /**␊ - * A list of container network interfaces created from this container network interface configuration.␊ - */␊ - containerNetworkInterfaces?: (SubResource23[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration profile child resource.␊ - */␊ - export interface IPConfigurationProfile {␊ - /**␊ - * Properties of the IP configuration profile.␊ - */␊ - properties?: (IPConfigurationProfilePropertiesFormat | string)␊ - /**␊ - * The name of the resource. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration profile properties.␊ - */␊ - export interface IPConfigurationProfilePropertiesFormat {␊ - /**␊ - * The reference of the subnet resource to create a container network interface ip configuration.␊ - */␊ - subnet?: (SubResource23 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups␊ - */␊ - export interface NetworkSecurityGroups25 {␊ - name: string␊ - type: "Microsoft.Network/networkSecurityGroups"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network security group.␊ - */␊ - properties: (NetworkSecurityGroupPropertiesFormat17 | string)␊ - resources?: NetworkSecurityGroupsSecurityRulesChildResource17[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network Security Group resource.␊ - */␊ - export interface NetworkSecurityGroupPropertiesFormat17 {␊ - /**␊ - * A collection of security rules of the network security group.␊ - */␊ - securityRules?: (SecurityRule17[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network security rule.␊ - */␊ - export interface SecurityRule17 {␊ - /**␊ - * Properties of the security rule.␊ - */␊ - properties?: (SecurityRulePropertiesFormat17 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Security rule resource.␊ - */␊ - export interface SecurityRulePropertiesFormat17 {␊ - /**␊ - * A description for this rule. Restricted to 140 chars.␊ - */␊ - description?: string␊ - /**␊ - * Network protocol this rule applies to.␊ - */␊ - protocol: (("Tcp" | "Udp" | "Icmp" | "Esp" | "*") | string)␊ - /**␊ - * The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.␊ - */␊ - sourcePortRange?: string␊ - /**␊ - * The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.␊ - */␊ - destinationPortRange?: string␊ - /**␊ - * The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from.␊ - */␊ - sourceAddressPrefix?: string␊ - /**␊ - * The CIDR or source IP ranges.␊ - */␊ - sourceAddressPrefixes?: (string[] | string)␊ - /**␊ - * The application security group specified as source.␊ - */␊ - sourceApplicationSecurityGroups?: (SubResource23[] | string)␊ - /**␊ - * The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used.␊ - */␊ - destinationAddressPrefix?: string␊ - /**␊ - * The destination address prefixes. CIDR or destination IP ranges.␊ - */␊ - destinationAddressPrefixes?: (string[] | string)␊ - /**␊ - * The application security group specified as destination.␊ - */␊ - destinationApplicationSecurityGroups?: (SubResource23[] | string)␊ - /**␊ - * The source port ranges.␊ - */␊ - sourcePortRanges?: (string[] | string)␊ - /**␊ - * The destination port ranges.␊ - */␊ - destinationPortRanges?: (string[] | string)␊ - /**␊ - * The network traffic is allowed or denied.␊ - */␊ - access: (("Allow" | "Deny") | string)␊ - /**␊ - * The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.␊ - */␊ - priority: (number | string)␊ - /**␊ - * The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic.␊ - */␊ - direction: (("Inbound" | "Outbound") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRulesChildResource17 {␊ - name: string␊ - type: "securityRules"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Properties of the security rule.␊ - */␊ - properties: (SecurityRulePropertiesFormat17 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRules16 {␊ - name: string␊ - type: "Microsoft.Network/networkSecurityGroups/securityRules"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Properties of the security rule.␊ - */␊ - properties: (SecurityRulePropertiesFormat17 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers␊ - */␊ - export interface NetworkWatchers3 {␊ - name: string␊ - type: "Microsoft.Network/networkWatchers"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network watcher.␊ - */␊ - properties: (NetworkWatcherPropertiesFormat | string)␊ - resources?: (NetworkWatchersConnectionMonitorsChildResource3 | NetworkWatchersPacketCapturesChildResource3)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The network watcher properties.␊ - */␊ - export interface NetworkWatcherPropertiesFormat {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/connectionMonitors␊ - */␊ - export interface NetworkWatchersConnectionMonitorsChildResource3 {␊ - name: string␊ - type: "connectionMonitors"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Connection monitor location.␊ - */␊ - location?: string␊ - /**␊ - * Connection monitor tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the connection monitor.␊ - */␊ - properties: (ConnectionMonitorParameters3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters that define the operation to create a connection monitor.␊ - */␊ - export interface ConnectionMonitorParameters3 {␊ - /**␊ - * Describes the source of connection monitor.␊ - */␊ - source: (ConnectionMonitorSource3 | string)␊ - /**␊ - * Describes the destination of connection monitor.␊ - */␊ - destination: (ConnectionMonitorDestination3 | string)␊ - /**␊ - * Determines if the connection monitor will start automatically once created.␊ - */␊ - autoStart?: (boolean | string)␊ - /**␊ - * Monitoring interval in seconds.␊ - */␊ - monitoringIntervalInSeconds?: ((number & string) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the source of connection monitor.␊ - */␊ - export interface ConnectionMonitorSource3 {␊ - /**␊ - * The ID of the resource used as the source by connection monitor.␊ - */␊ - resourceId: string␊ - /**␊ - * The source port used by connection monitor.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the destination of connection monitor.␊ - */␊ - export interface ConnectionMonitorDestination3 {␊ - /**␊ - * The ID of the resource used as the destination by connection monitor.␊ - */␊ - resourceId?: string␊ - /**␊ - * Address of the connection monitor destination (IP or domain name).␊ - */␊ - address?: string␊ - /**␊ - * The destination port used by connection monitor.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/packetCaptures␊ - */␊ - export interface NetworkWatchersPacketCapturesChildResource3 {␊ - name: string␊ - type: "packetCaptures"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Properties of the packet capture.␊ - */␊ - properties: (PacketCaptureParameters3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters that define the create packet capture operation.␊ - */␊ - export interface PacketCaptureParameters3 {␊ - /**␊ - * The ID of the targeted resource, only VM is currently supported.␊ - */␊ - target: string␊ - /**␊ - * Number of bytes captured per packet, the remaining bytes are truncated.␊ - */␊ - bytesToCapturePerPacket?: ((number & string) | string)␊ - /**␊ - * Maximum size of the capture output.␊ - */␊ - totalBytesPerSession?: ((number & string) | string)␊ - /**␊ - * Maximum duration of the capture session in seconds.␊ - */␊ - timeLimitInSeconds?: ((number & string) | string)␊ - /**␊ - * Describes the storage location for a packet capture session.␊ - */␊ - storageLocation: (PacketCaptureStorageLocation3 | string)␊ - /**␊ - * A list of packet capture filters.␊ - */␊ - filters?: (PacketCaptureFilter3[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the storage location for a packet capture session.␊ - */␊ - export interface PacketCaptureStorageLocation3 {␊ - /**␊ - * The ID of the storage account to save the packet capture session. Required if no local file path is provided.␊ - */␊ - storageId?: string␊ - /**␊ - * The URI of the storage path to save the packet capture. Must be a well-formed URI describing the location to save the packet capture.␊ - */␊ - storagePath?: string␊ - /**␊ - * A valid local path on the targeting VM. Must include the name of the capture file (*.cap). For linux virtual machine it must start with /var/captures. Required if no storage ID is provided, otherwise optional.␊ - */␊ - filePath?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Filter that is applied to packet capture request. Multiple filters can be applied.␊ - */␊ - export interface PacketCaptureFilter3 {␊ - /**␊ - * Protocol to be filtered on.␊ - */␊ - protocol?: (("TCP" | "UDP" | "Any") | string)␊ - /**␊ - * Local IP Address to be filtered on. Notation: "127.0.0.1" for single address entry. "127.0.0.1-127.0.0.255" for range. "127.0.0.1;127.0.0.5"? for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.␊ - */␊ - localIPAddress?: string␊ - /**␊ - * Local IP Address to be filtered on. Notation: "127.0.0.1" for single address entry. "127.0.0.1-127.0.0.255" for range. "127.0.0.1;127.0.0.5;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.␊ - */␊ - remoteIPAddress?: string␊ - /**␊ - * Local port to be filtered on. Notation: "80" for single port entry."80-85" for range. "80;443;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.␊ - */␊ - localPort?: string␊ - /**␊ - * Remote port to be filtered on. Notation: "80" for single port entry."80-85" for range. "80;443;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.␊ - */␊ - remotePort?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/connectionMonitors␊ - */␊ - export interface NetworkWatchersConnectionMonitors3 {␊ - name: string␊ - type: "Microsoft.Network/networkWatchers/connectionMonitors"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Connection monitor location.␊ - */␊ - location?: string␊ - /**␊ - * Connection monitor tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the connection monitor.␊ - */␊ - properties: (ConnectionMonitorParameters3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/packetCaptures␊ - */␊ - export interface NetworkWatchersPacketCaptures3 {␊ - name: string␊ - type: "Microsoft.Network/networkWatchers/packetCaptures"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Properties of the packet capture.␊ - */␊ - properties: (PacketCaptureParameters3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/p2svpnGateways␊ - */␊ - export interface P2SvpnGateways {␊ - name: string␊ - type: "Microsoft.Network/p2svpnGateways"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the P2SVpnGateway.␊ - */␊ - properties: (P2SVpnGatewayProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for P2SVpnGateway.␊ - */␊ - export interface P2SVpnGatewayProperties {␊ - /**␊ - * The VirtualHub to which the gateway belongs.␊ - */␊ - virtualHub?: (SubResource23 | string)␊ - /**␊ - * The scale unit for this p2s vpn gateway.␊ - */␊ - vpnGatewayScaleUnit?: (number | string)␊ - /**␊ - * The P2SVpnServerConfiguration to which the p2sVpnGateway is attached to.␊ - */␊ - p2SVpnServerConfiguration?: (SubResource23 | string)␊ - /**␊ - * The reference of the address space resource which represents Address space for P2S VpnClient.␊ - */␊ - vpnClientAddressPool?: (AddressSpace25 | string)␊ - /**␊ - * The reference of the address space resource which represents the custom routes specified by the customer for P2SVpnGateway and P2S VpnClient.␊ - */␊ - customRoutes?: (AddressSpace25 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateEndpoints␊ - */␊ - export interface PrivateEndpoints {␊ - name: string␊ - type: "Microsoft.Network/privateEndpoints"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the private endpoint.␊ - */␊ - properties: (PrivateEndpointProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the private endpoint.␊ - */␊ - export interface PrivateEndpointProperties {␊ - /**␊ - * The ID of the subnet from which the private IP will be allocated.␊ - */␊ - subnet?: (SubResource23 | string)␊ - /**␊ - * A grouping of information about the connection to the remote resource.␊ - */␊ - privateLinkServiceConnections?: (PrivateLinkServiceConnection[] | string)␊ - /**␊ - * A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource.␊ - */␊ - manualPrivateLinkServiceConnections?: (PrivateLinkServiceConnection[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * PrivateLinkServiceConnection resource.␊ - */␊ - export interface PrivateLinkServiceConnection {␊ - /**␊ - * Properties of the private link service connection.␊ - */␊ - properties?: (PrivateLinkServiceConnectionProperties | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the PrivateLinkServiceConnection.␊ - */␊ - export interface PrivateLinkServiceConnectionProperties {␊ - /**␊ - * The resource id of private link service.␊ - */␊ - privateLinkServiceId?: string␊ - /**␊ - * The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to.␊ - */␊ - groupIds?: (string[] | string)␊ - /**␊ - * A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars.␊ - */␊ - requestMessage?: string␊ - /**␊ - * A collection of read-only information about the state of the connection to the remote resource.␊ - */␊ - privateLinkServiceConnectionState?: (PrivateLinkServiceConnectionState6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A collection of information about the state of the connection between service consumer and provider.␊ - */␊ - export interface PrivateLinkServiceConnectionState6 {␊ - /**␊ - * Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.␊ - */␊ - status?: string␊ - /**␊ - * The reason for approval/rejection of the connection.␊ - */␊ - description?: string␊ - /**␊ - * A message indicating if changes on the service provider require any updates on the consumer.␊ - */␊ - actionRequired?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateLinkServices␊ - */␊ - export interface PrivateLinkServices {␊ - name: string␊ - type: "Microsoft.Network/privateLinkServices"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the private link service.␊ - */␊ - properties: (PrivateLinkServiceProperties | string)␊ - resources?: PrivateLinkServicesPrivateEndpointConnectionsChildResource[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the private link service.␊ - */␊ - export interface PrivateLinkServiceProperties {␊ - /**␊ - * An array of references to the load balancer IP configurations.␊ - */␊ - loadBalancerFrontendIpConfigurations?: (SubResource23[] | string)␊ - /**␊ - * An array of references to the private link service IP configuration.␊ - */␊ - ipConfigurations?: (PrivateLinkServiceIpConfiguration[] | string)␊ - /**␊ - * The visibility list of the private link service.␊ - */␊ - visibility?: (PrivateLinkServicePropertiesVisibility | string)␊ - /**␊ - * The auto-approval list of the private link service.␊ - */␊ - autoApproval?: (PrivateLinkServicePropertiesAutoApproval | string)␊ - /**␊ - * The list of Fqdn.␊ - */␊ - fqdns?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The private link service ip configuration.␊ - */␊ - export interface PrivateLinkServiceIpConfiguration {␊ - /**␊ - * Properties of the private link service ip configuration.␊ - */␊ - properties?: (PrivateLinkServiceIpConfigurationProperties | string)␊ - /**␊ - * The name of private link service ip configuration.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of private link service IP configuration.␊ - */␊ - export interface PrivateLinkServiceIpConfigurationProperties {␊ - /**␊ - * The private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The private IP address allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * The reference of the subnet resource.␊ - */␊ - subnet?: (SubResource23 | string)␊ - /**␊ - * Whether the ip configuration is primary or not.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * Available from Api-Version 2016-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4.␊ - */␊ - privateIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The visibility list of the private link service.␊ - */␊ - export interface PrivateLinkServicePropertiesVisibility {␊ - /**␊ - * The list of subscriptions.␊ - */␊ - subscriptions?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The auto-approval list of the private link service.␊ - */␊ - export interface PrivateLinkServicePropertiesAutoApproval {␊ - /**␊ - * The list of subscriptions.␊ - */␊ - subscriptions?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateLinkServices/privateEndpointConnections␊ - */␊ - export interface PrivateLinkServicesPrivateEndpointConnectionsChildResource {␊ - name: string␊ - type: "privateEndpointConnections"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Properties of the private end point connection.␊ - */␊ - properties: (PrivateEndpointConnectionProperties7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the PrivateEndpointConnectProperties.␊ - */␊ - export interface PrivateEndpointConnectionProperties7 {␊ - /**␊ - * A collection of information about the state of the connection between service consumer and provider.␊ - */␊ - privateLinkServiceConnectionState?: (PrivateLinkServiceConnectionState6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateLinkServices/privateEndpointConnections␊ - */␊ - export interface PrivateLinkServicesPrivateEndpointConnections {␊ - name: string␊ - type: "Microsoft.Network/privateLinkServices/privateEndpointConnections"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Properties of the private end point connection.␊ - */␊ - properties: (PrivateEndpointConnectionProperties7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/publicIPAddresses␊ - */␊ - export interface PublicIPAddresses25 {␊ - name: string␊ - type: "Microsoft.Network/publicIPAddresses"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The public IP address SKU.␊ - */␊ - sku?: (PublicIPAddressSku13 | string)␊ - /**␊ - * Public IP address properties.␊ - */␊ - properties: (PublicIPAddressPropertiesFormat16 | string)␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a public IP address.␊ - */␊ - export interface PublicIPAddressSku13 {␊ - /**␊ - * Name of a public IP address SKU.␊ - */␊ - name?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Public IP address properties.␊ - */␊ - export interface PublicIPAddressPropertiesFormat16 {␊ - /**␊ - * The public IP address allocation method.␊ - */␊ - publicIPAllocationMethod: (("Static" | "Dynamic") | string)␊ - /**␊ - * The public IP address version.␊ - */␊ - publicIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The FQDN of the DNS record associated with the public IP address.␊ - */␊ - dnsSettings?: (PublicIPAddressDnsSettings24 | string)␊ - /**␊ - * The DDoS protection custom policy associated with the public IP address.␊ - */␊ - ddosSettings?: (DdosSettings2 | string)␊ - /**␊ - * The list of tags associated with the public IP address.␊ - */␊ - ipTags?: (IpTag10[] | string)␊ - /**␊ - * The IP address associated with the public IP address resource.␊ - */␊ - ipAddress?: string␊ - /**␊ - * The Public IP Prefix this Public IP Address should be allocated from.␊ - */␊ - publicIPPrefix?: (SubResource23 | string)␊ - /**␊ - * The idle timeout of the public IP address.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains FQDN of the DNS record associated with the public IP address.␊ - */␊ - export interface PublicIPAddressDnsSettings24 {␊ - /**␊ - * Gets or sets the Domain name label.The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.␊ - */␊ - domainNameLabel: string␊ - /**␊ - * Gets the FQDN, Fully qualified domain name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone.␊ - */␊ - fqdn?: string␊ - /**␊ - * Gets or Sets the Reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN.␊ - */␊ - reverseFqdn?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains the DDoS protection settings of the public IP.␊ - */␊ - export interface DdosSettings2 {␊ - /**␊ - * The DDoS custom policy associated with the public IP.␊ - */␊ - ddosCustomPolicy?: (SubResource23 | string)␊ - /**␊ - * The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized.␊ - */␊ - protectionCoverage?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains the IpTag associated with the object.␊ - */␊ - export interface IpTag10 {␊ - /**␊ - * Gets or sets the ipTag type: Example FirstPartyUsage.␊ - */␊ - ipTagType?: string␊ - /**␊ - * Gets or sets value of the IpTag associated with the public IP. Example SQL, Storage etc.␊ - */␊ - tag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/publicIPPrefixes␊ - */␊ - export interface PublicIPPrefixes1 {␊ - name: string␊ - type: "Microsoft.Network/publicIPPrefixes"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The public IP prefix SKU.␊ - */␊ - sku?: (PublicIPPrefixSku1 | string)␊ - /**␊ - * Public IP prefix properties.␊ - */␊ - properties: (PublicIPPrefixPropertiesFormat1 | string)␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a public IP prefix.␊ - */␊ - export interface PublicIPPrefixSku1 {␊ - /**␊ - * Name of a public IP prefix SKU.␊ - */␊ - name?: ("Standard" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Public IP prefix properties.␊ - */␊ - export interface PublicIPPrefixPropertiesFormat1 {␊ - /**␊ - * The public IP address version.␊ - */␊ - publicIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The list of tags associated with the public IP prefix.␊ - */␊ - ipTags?: (IpTag10[] | string)␊ - /**␊ - * The Length of the Public IP Prefix.␊ - */␊ - prefixLength?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeFilters␊ - */␊ - export interface RouteFilters3 {␊ - name: string␊ - type: "Microsoft.Network/routeFilters"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the route filter.␊ - */␊ - properties: (RouteFilterPropertiesFormat3 | string)␊ - resources?: RouteFiltersRouteFilterRulesChildResource3[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Filter Resource.␊ - */␊ - export interface RouteFilterPropertiesFormat3 {␊ - /**␊ - * Collection of RouteFilterRules contained within a route filter.␊ - */␊ - rules?: (RouteFilterRule3[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Filter Rule Resource.␊ - */␊ - export interface RouteFilterRule3 {␊ - /**␊ - * Properties of the route filter rule.␊ - */␊ - properties?: (RouteFilterRulePropertiesFormat3 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Filter Rule Resource.␊ - */␊ - export interface RouteFilterRulePropertiesFormat3 {␊ - /**␊ - * The access type of the rule.␊ - */␊ - access: (("Allow" | "Deny") | string)␊ - /**␊ - * The rule type of the rule.␊ - */␊ - routeFilterRuleType: ("Community" | string)␊ - /**␊ - * The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'].␊ - */␊ - communities: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeFilters/routeFilterRules␊ - */␊ - export interface RouteFiltersRouteFilterRulesChildResource3 {␊ - name: string␊ - type: "routeFilterRules"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Properties of the route filter rule.␊ - */␊ - properties: (RouteFilterRulePropertiesFormat3 | string)␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeFilters/routeFilterRules␊ - */␊ - export interface RouteFiltersRouteFilterRules3 {␊ - name: string␊ - type: "Microsoft.Network/routeFilters/routeFilterRules"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Properties of the route filter rule.␊ - */␊ - properties: (RouteFilterRulePropertiesFormat3 | string)␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables␊ - */␊ - export interface RouteTables25 {␊ - name: string␊ - type: "Microsoft.Network/routeTables"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the route table.␊ - */␊ - properties: (RouteTablePropertiesFormat17 | string)␊ - resources?: RouteTablesRoutesChildResource17[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Table resource.␊ - */␊ - export interface RouteTablePropertiesFormat17 {␊ - /**␊ - * Collection of routes contained within a route table.␊ - */␊ - routes?: (Route17[] | string)␊ - /**␊ - * Gets or sets whether to disable the routes learned by BGP on that route table. True means disable.␊ - */␊ - disableBgpRoutePropagation?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource.␊ - */␊ - export interface Route17 {␊ - /**␊ - * Properties of the route.␊ - */␊ - properties?: (RoutePropertiesFormat17 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource.␊ - */␊ - export interface RoutePropertiesFormat17 {␊ - /**␊ - * The destination CIDR to which the route applies.␊ - */␊ - addressPrefix: string␊ - /**␊ - * The type of Azure hop the packet should be sent to.␊ - */␊ - nextHopType: (("VirtualNetworkGateway" | "VnetLocal" | "Internet" | "VirtualAppliance" | "None") | string)␊ - /**␊ - * The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.␊ - */␊ - nextHopIpAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutesChildResource17 {␊ - name: string␊ - type: "routes"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Properties of the route.␊ - */␊ - properties: (RoutePropertiesFormat17 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutes16 {␊ - name: string␊ - type: "Microsoft.Network/routeTables/routes"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Properties of the route.␊ - */␊ - properties: (RoutePropertiesFormat17 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/serviceEndpointPolicies␊ - */␊ - export interface ServiceEndpointPolicies1 {␊ - name: string␊ - type: "Microsoft.Network/serviceEndpointPolicies"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the service end point policy.␊ - */␊ - properties: (ServiceEndpointPolicyPropertiesFormat1 | string)␊ - resources?: ServiceEndpointPoliciesServiceEndpointPolicyDefinitionsChildResource1[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Service Endpoint Policy resource.␊ - */␊ - export interface ServiceEndpointPolicyPropertiesFormat1 {␊ - /**␊ - * A collection of service endpoint policy definitions of the service endpoint policy.␊ - */␊ - serviceEndpointPolicyDefinitions?: (ServiceEndpointPolicyDefinition1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Service Endpoint policy definitions.␊ - */␊ - export interface ServiceEndpointPolicyDefinition1 {␊ - /**␊ - * Properties of the service endpoint policy definition.␊ - */␊ - properties?: (ServiceEndpointPolicyDefinitionPropertiesFormat1 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Service Endpoint policy definition resource.␊ - */␊ - export interface ServiceEndpointPolicyDefinitionPropertiesFormat1 {␊ - /**␊ - * A description for this rule. Restricted to 140 chars.␊ - */␊ - description?: string␊ - /**␊ - * Service endpoint name.␊ - */␊ - service?: string␊ - /**␊ - * A list of service resources.␊ - */␊ - serviceResources?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions␊ - */␊ - export interface ServiceEndpointPoliciesServiceEndpointPolicyDefinitionsChildResource1 {␊ - name: string␊ - type: "serviceEndpointPolicyDefinitions"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Properties of the service endpoint policy definition.␊ - */␊ - properties: (ServiceEndpointPolicyDefinitionPropertiesFormat1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions␊ - */␊ - export interface ServiceEndpointPoliciesServiceEndpointPolicyDefinitions1 {␊ - name: string␊ - type: "Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Properties of the service endpoint policy definition.␊ - */␊ - properties: (ServiceEndpointPolicyDefinitionPropertiesFormat1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualHubs␊ - */␊ - export interface VirtualHubs3 {␊ - name: string␊ - type: "Microsoft.Network/virtualHubs"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual hub.␊ - */␊ - properties: (VirtualHubProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VirtualHub.␊ - */␊ - export interface VirtualHubProperties3 {␊ - /**␊ - * The VirtualWAN to which the VirtualHub belongs.␊ - */␊ - virtualWan?: (SubResource23 | string)␊ - /**␊ - * The VpnGateway associated with this VirtualHub.␊ - */␊ - vpnGateway?: (SubResource23 | string)␊ - /**␊ - * The P2SVpnGateway associated with this VirtualHub.␊ - */␊ - p2SVpnGateway?: (SubResource23 | string)␊ - /**␊ - * The expressRouteGateway associated with this VirtualHub.␊ - */␊ - expressRouteGateway?: (SubResource23 | string)␊ - /**␊ - * List of all vnet connections with this VirtualHub.␊ - */␊ - virtualNetworkConnections?: (HubVirtualNetworkConnection3[] | string)␊ - /**␊ - * Address-prefix for this VirtualHub.␊ - */␊ - addressPrefix?: string␊ - /**␊ - * The routeTable associated with this virtual hub.␊ - */␊ - routeTable?: (VirtualHubRouteTable | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HubVirtualNetworkConnection Resource.␊ - */␊ - export interface HubVirtualNetworkConnection3 {␊ - /**␊ - * Properties of the hub virtual network connection.␊ - */␊ - properties?: (HubVirtualNetworkConnectionProperties3 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for HubVirtualNetworkConnection.␊ - */␊ - export interface HubVirtualNetworkConnectionProperties3 {␊ - /**␊ - * Reference to the remote virtual network.␊ - */␊ - remoteVirtualNetwork?: (SubResource23 | string)␊ - /**␊ - * VirtualHub to RemoteVnet transit to enabled or not.␊ - */␊ - allowHubToRemoteVnetTransit?: (boolean | string)␊ - /**␊ - * Allow RemoteVnet to use Virtual Hub's gateways.␊ - */␊ - allowRemoteVnetToUseHubVnetGateways?: (boolean | string)␊ - /**␊ - * Enable internet security.␊ - */␊ - enableInternetSecurity?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualHub route table.␊ - */␊ - export interface VirtualHubRouteTable {␊ - /**␊ - * List of all routes.␊ - */␊ - routes?: (VirtualHubRoute[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualHub route.␊ - */␊ - export interface VirtualHubRoute {␊ - /**␊ - * List of all addressPrefixes.␊ - */␊ - addressPrefixes?: (string[] | string)␊ - /**␊ - * NextHop ip address.␊ - */␊ - nextHopIpAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworkGateways␊ - */␊ - export interface VirtualNetworkGateways13 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworkGateways"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway.␊ - */␊ - properties: (VirtualNetworkGatewayPropertiesFormat13 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGateway properties.␊ - */␊ - export interface VirtualNetworkGatewayPropertiesFormat13 {␊ - /**␊ - * IP configurations for virtual network gateway.␊ - */␊ - ipConfigurations?: (VirtualNetworkGatewayIPConfiguration12[] | string)␊ - /**␊ - * The type of this virtual network gateway.␊ - */␊ - gatewayType?: (("Vpn" | "ExpressRoute" | "HyperNet") | string)␊ - /**␊ - * The type of this virtual network gateway.␊ - */␊ - vpnType?: (("PolicyBased" | "RouteBased") | string)␊ - /**␊ - * Whether BGP is enabled for this virtual network gateway or not.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * ActiveActive flag.␊ - */␊ - activeActive?: (boolean | string)␊ - /**␊ - * The reference of the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting.␊ - */␊ - gatewayDefaultSite?: (SubResource23 | string)␊ - /**␊ - * The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.␊ - */␊ - sku?: (VirtualNetworkGatewaySku12 | string)␊ - /**␊ - * The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations.␊ - */␊ - vpnClientConfiguration?: (VpnClientConfiguration12 | string)␊ - /**␊ - * Virtual network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings12 | string)␊ - /**␊ - * The reference of the address space resource which represents the custom routes address space specified by the customer for virtual network gateway and VpnClient.␊ - */␊ - customRoutes?: (AddressSpace25 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration for virtual network gateway.␊ - */␊ - export interface VirtualNetworkGatewayIPConfiguration12 {␊ - /**␊ - * Properties of the virtual network gateway ip configuration.␊ - */␊ - properties?: (VirtualNetworkGatewayIPConfigurationPropertiesFormat12 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of VirtualNetworkGatewayIPConfiguration.␊ - */␊ - export interface VirtualNetworkGatewayIPConfigurationPropertiesFormat12 {␊ - /**␊ - * The private IP address allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * The reference of the subnet resource.␊ - */␊ - subnet?: (SubResource23 | string)␊ - /**␊ - * The reference of the public IP resource.␊ - */␊ - publicIPAddress?: (SubResource23 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewaySku details.␊ - */␊ - export interface VirtualNetworkGatewaySku12 {␊ - /**␊ - * Gateway SKU name.␊ - */␊ - name?: (("Basic" | "HighPerformance" | "Standard" | "UltraPerformance" | "VpnGw1" | "VpnGw2" | "VpnGw3" | "VpnGw1AZ" | "VpnGw2AZ" | "VpnGw3AZ" | "ErGw1AZ" | "ErGw2AZ" | "ErGw3AZ") | string)␊ - /**␊ - * Gateway SKU tier.␊ - */␊ - tier?: (("Basic" | "HighPerformance" | "Standard" | "UltraPerformance" | "VpnGw1" | "VpnGw2" | "VpnGw3" | "VpnGw1AZ" | "VpnGw2AZ" | "VpnGw3AZ" | "ErGw1AZ" | "ErGw2AZ" | "ErGw3AZ") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnClientConfiguration for P2S client.␊ - */␊ - export interface VpnClientConfiguration12 {␊ - /**␊ - * The reference of the address space resource which represents Address space for P2S VpnClient.␊ - */␊ - vpnClientAddressPool?: (AddressSpace25 | string)␊ - /**␊ - * VpnClientRootCertificate for virtual network gateway.␊ - */␊ - vpnClientRootCertificates?: (VpnClientRootCertificate12[] | string)␊ - /**␊ - * VpnClientRevokedCertificate for Virtual network gateway.␊ - */␊ - vpnClientRevokedCertificates?: (VpnClientRevokedCertificate12[] | string)␊ - /**␊ - * VpnClientProtocols for Virtual network gateway.␊ - */␊ - vpnClientProtocols?: (("IkeV2" | "SSTP" | "OpenVPN")[] | string)␊ - /**␊ - * VpnClientIpsecPolicies for virtual network gateway P2S client.␊ - */␊ - vpnClientIpsecPolicies?: (IpsecPolicy10[] | string)␊ - /**␊ - * The radius server address property of the VirtualNetworkGateway resource for vpn client connection.␊ - */␊ - radiusServerAddress?: string␊ - /**␊ - * The radius secret property of the VirtualNetworkGateway resource for vpn client connection.␊ - */␊ - radiusServerSecret?: string␊ - /**␊ - * The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication.␊ - */␊ - aadTenant?: string␊ - /**␊ - * The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication.␊ - */␊ - aadAudience?: string␊ - /**␊ - * The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication.␊ - */␊ - aadIssuer?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client root certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRootCertificate12 {␊ - /**␊ - * Properties of the vpn client root certificate.␊ - */␊ - properties: (VpnClientRootCertificatePropertiesFormat12 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of application gateway.␊ - */␊ - export interface VpnClientRootCertificatePropertiesFormat12 {␊ - /**␊ - * The certificate public data.␊ - */␊ - publicCertData: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client revoked certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRevokedCertificate12 {␊ - /**␊ - * Properties of the vpn client revoked certificate.␊ - */␊ - properties?: (VpnClientRevokedCertificatePropertiesFormat12 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the revoked VPN client certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRevokedCertificatePropertiesFormat12 {␊ - /**␊ - * The revoked VPN client certificate thumbprint.␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks␊ - */␊ - export interface VirtualNetworks25 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network.␊ - */␊ - properties: (VirtualNetworkPropertiesFormat17 | string)␊ - resources?: (VirtualNetworksVirtualNetworkPeeringsChildResource14 | VirtualNetworksSubnetsChildResource17)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the virtual network.␊ - */␊ - export interface VirtualNetworkPropertiesFormat17 {␊ - /**␊ - * The AddressSpace that contains an array of IP address ranges that can be used by subnets.␊ - */␊ - addressSpace: (AddressSpace25 | string)␊ - /**␊ - * The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network.␊ - */␊ - dhcpOptions?: (DhcpOptions25 | string)␊ - /**␊ - * A list of subnets in a Virtual Network.␊ - */␊ - subnets?: (Subnet27[] | string)␊ - /**␊ - * A list of peerings in a Virtual Network.␊ - */␊ - virtualNetworkPeerings?: (VirtualNetworkPeering22[] | string)␊ - /**␊ - * Indicates if DDoS protection is enabled for all the protected resources in the virtual network. It requires a DDoS protection plan associated with the resource.␊ - */␊ - enableDdosProtection?: (boolean | string)␊ - /**␊ - * Indicates if VM protection is enabled for all the subnets in the virtual network.␊ - */␊ - enableVmProtection?: (boolean | string)␊ - /**␊ - * The DDoS protection plan associated with the virtual network.␊ - */␊ - ddosProtectionPlan?: (SubResource23 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DhcpOptions contains an array of DNS servers available to VMs deployed in the virtual network. Standard DHCP option for a subnet overrides VNET DHCP options.␊ - */␊ - export interface DhcpOptions25 {␊ - /**␊ - * The list of DNS servers IP addresses.␊ - */␊ - dnsServers: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Subnet in a virtual network resource.␊ - */␊ - export interface Subnet27 {␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties?: (SubnetPropertiesFormat17 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the subnet.␊ - */␊ - export interface SubnetPropertiesFormat17 {␊ - /**␊ - * The address prefix for the subnet.␊ - */␊ - addressPrefix: string␊ - /**␊ - * List of address prefixes for the subnet.␊ - */␊ - addressPrefixes?: (string[] | string)␊ - /**␊ - * The reference of the NetworkSecurityGroup resource.␊ - */␊ - networkSecurityGroup?: (SubResource23 | string)␊ - /**␊ - * The reference of the RouteTable resource.␊ - */␊ - routeTable?: (SubResource23 | string)␊ - /**␊ - * Nat gateway associated with this subnet.␊ - */␊ - natGateway?: (SubResource23 | string)␊ - /**␊ - * An array of service endpoints.␊ - */␊ - serviceEndpoints?: (ServiceEndpointPropertiesFormat13[] | string)␊ - /**␊ - * An array of service endpoint policies.␊ - */␊ - serviceEndpointPolicies?: (SubResource23[] | string)␊ - /**␊ - * Gets an array of references to the delegations on the subnet.␊ - */␊ - delegations?: (Delegation4[] | string)␊ - /**␊ - * Enable or Disable private end point on the subnet.␊ - */␊ - privateEndpointNetworkPolicies?: string␊ - /**␊ - * Enable or Disable private link service on the subnet.␊ - */␊ - privateLinkServiceNetworkPolicies?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The service endpoint properties.␊ - */␊ - export interface ServiceEndpointPropertiesFormat13 {␊ - /**␊ - * The type of the endpoint service.␊ - */␊ - service?: string␊ - /**␊ - * A list of locations.␊ - */␊ - locations?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Details the service to which the subnet is delegated.␊ - */␊ - export interface Delegation4 {␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties?: (ServiceDelegationPropertiesFormat4 | string)␊ - /**␊ - * The name of the resource that is unique within a subnet. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a service delegation.␊ - */␊ - export interface ServiceDelegationPropertiesFormat4 {␊ - /**␊ - * The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers).␊ - */␊ - serviceName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peerings in a virtual network resource.␊ - */␊ - export interface VirtualNetworkPeering22 {␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties?: (VirtualNetworkPeeringPropertiesFormat14 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - export interface VirtualNetworkPeeringPropertiesFormat14 {␊ - /**␊ - * Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space.␊ - */␊ - allowVirtualNetworkAccess?: (boolean | string)␊ - /**␊ - * Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network.␊ - */␊ - allowForwardedTraffic?: (boolean | string)␊ - /**␊ - * If gateway links can be used in remote virtual networking to link to this virtual network.␊ - */␊ - allowGatewayTransit?: (boolean | string)␊ - /**␊ - * If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway.␊ - */␊ - useRemoteGateways?: (boolean | string)␊ - /**␊ - * The reference of the remote virtual network. The remote virtual network can be in the same or different region (preview). See here to register for the preview and learn more (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering).␊ - */␊ - remoteVirtualNetwork: (SubResource23 | string)␊ - /**␊ - * The reference of the remote virtual network address space.␊ - */␊ - remoteAddressSpace?: (AddressSpace25 | string)␊ - /**␊ - * The status of the virtual network peering.␊ - */␊ - peeringState?: (("Initiated" | "Connected" | "Disconnected") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/virtualNetworkPeerings␊ - */␊ - export interface VirtualNetworksVirtualNetworkPeeringsChildResource14 {␊ - name: string␊ - type: "virtualNetworkPeerings"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties: (VirtualNetworkPeeringPropertiesFormat14 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnetsChildResource17 {␊ - name: string␊ - type: "subnets"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties: (SubnetPropertiesFormat17 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnets13 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks/subnets"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties: (SubnetPropertiesFormat17 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/virtualNetworkPeerings␊ - */␊ - export interface VirtualNetworksVirtualNetworkPeerings10 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks/virtualNetworkPeerings"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties: (VirtualNetworkPeeringPropertiesFormat14 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworkTaps␊ - */␊ - export interface VirtualNetworkTaps {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworkTaps"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Virtual Network Tap Properties.␊ - */␊ - properties: (VirtualNetworkTapPropertiesFormat | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Virtual Network Tap properties.␊ - */␊ - export interface VirtualNetworkTapPropertiesFormat {␊ - /**␊ - * The reference to the private IP Address of the collector nic that will receive the tap.␊ - */␊ - destinationNetworkInterfaceIPConfiguration?: (SubResource23 | string)␊ - /**␊ - * The reference to the private IP address on the internal Load Balancer that will receive the tap.␊ - */␊ - destinationLoadBalancerFrontEndIPConfiguration?: (SubResource23 | string)␊ - /**␊ - * The VXLAN destination port that will receive the tapped traffic.␊ - */␊ - destinationPort?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualWans␊ - */␊ - export interface VirtualWans3 {␊ - name: string␊ - type: "Microsoft.Network/virtualWans"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual WAN.␊ - */␊ - properties: (VirtualWanProperties3 | string)␊ - resources?: VirtualWansP2SVpnServerConfigurationsChildResource[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VirtualWAN.␊ - */␊ - export interface VirtualWanProperties3 {␊ - /**␊ - * Vpn encryption to be disabled or not.␊ - */␊ - disableVpnEncryption?: (boolean | string)␊ - /**␊ - * The Security Provider name.␊ - */␊ - securityProviderName?: string␊ - /**␊ - * True if branch to branch traffic is allowed.␊ - */␊ - allowBranchToBranchTraffic?: (boolean | string)␊ - /**␊ - * True if Vnet to Vnet traffic is allowed.␊ - */␊ - allowVnetToVnetTraffic?: (boolean | string)␊ - /**␊ - * The office local breakout category.␊ - */␊ - office365LocalBreakoutCategory?: (("Optimize" | "OptimizeAndAllow" | "All" | "None") | string)␊ - /**␊ - * List of all P2SVpnServerConfigurations associated with the virtual wan.␊ - */␊ - p2SVpnServerConfigurations?: (P2SVpnServerConfiguration[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * P2SVpnServerConfiguration Resource.␊ - */␊ - export interface P2SVpnServerConfiguration {␊ - /**␊ - * Properties of the P2SVpnServer configuration.␊ - */␊ - properties?: (P2SVpnServerConfigurationProperties | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for P2SVpnServerConfiguration.␊ - */␊ - export interface P2SVpnServerConfigurationProperties {␊ - /**␊ - * The name of the P2SVpnServerConfiguration that is unique within a VirtualWan in a resource group. This name can be used to access the resource along with Paren VirtualWan resource name.␊ - */␊ - name?: string␊ - /**␊ - * VPN protocols for the P2SVpnServerConfiguration.␊ - */␊ - vpnProtocols?: (("IkeV2" | "OpenVPN")[] | string)␊ - /**␊ - * VPN client root certificate of P2SVpnServerConfiguration.␊ - */␊ - p2SVpnServerConfigVpnClientRootCertificates?: (P2SVpnServerConfigVpnClientRootCertificate[] | string)␊ - /**␊ - * VPN client revoked certificate of P2SVpnServerConfiguration.␊ - */␊ - p2SVpnServerConfigVpnClientRevokedCertificates?: (P2SVpnServerConfigVpnClientRevokedCertificate[] | string)␊ - /**␊ - * Radius Server root certificate of P2SVpnServerConfiguration.␊ - */␊ - p2SVpnServerConfigRadiusServerRootCertificates?: (P2SVpnServerConfigRadiusServerRootCertificate[] | string)␊ - /**␊ - * Radius client root certificate of P2SVpnServerConfiguration.␊ - */␊ - p2SVpnServerConfigRadiusClientRootCertificates?: (P2SVpnServerConfigRadiusClientRootCertificate[] | string)␊ - /**␊ - * VpnClientIpsecPolicies for P2SVpnServerConfiguration.␊ - */␊ - vpnClientIpsecPolicies?: (IpsecPolicy10[] | string)␊ - /**␊ - * The radius server address property of the P2SVpnServerConfiguration resource for point to site client connection.␊ - */␊ - radiusServerAddress?: string␊ - /**␊ - * The radius secret property of the P2SVpnServerConfiguration resource for point to site client connection.␊ - */␊ - radiusServerSecret?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client root certificate of P2SVpnServerConfiguration.␊ - */␊ - export interface P2SVpnServerConfigVpnClientRootCertificate {␊ - /**␊ - * Properties of the P2SVpnServerConfiguration VPN client root certificate.␊ - */␊ - properties: (P2SVpnServerConfigVpnClientRootCertificatePropertiesFormat | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of VPN client root certificate of P2SVpnServerConfiguration.␊ - */␊ - export interface P2SVpnServerConfigVpnClientRootCertificatePropertiesFormat {␊ - /**␊ - * The certificate public data.␊ - */␊ - publicCertData: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client revoked certificate of P2SVpnServerConfiguration.␊ - */␊ - export interface P2SVpnServerConfigVpnClientRevokedCertificate {␊ - /**␊ - * Properties of the vpn client revoked certificate.␊ - */␊ - properties?: (P2SVpnServerConfigVpnClientRevokedCertificatePropertiesFormat | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the revoked VPN client certificate of P2SVpnServerConfiguration.␊ - */␊ - export interface P2SVpnServerConfigVpnClientRevokedCertificatePropertiesFormat {␊ - /**␊ - * The revoked VPN client certificate thumbprint.␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Radius Server root certificate of P2SVpnServerConfiguration.␊ - */␊ - export interface P2SVpnServerConfigRadiusServerRootCertificate {␊ - /**␊ - * Properties of the P2SVpnServerConfiguration Radius Server root certificate.␊ - */␊ - properties: (P2SVpnServerConfigRadiusServerRootCertificatePropertiesFormat | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Radius Server root certificate of P2SVpnServerConfiguration.␊ - */␊ - export interface P2SVpnServerConfigRadiusServerRootCertificatePropertiesFormat {␊ - /**␊ - * The certificate public data.␊ - */␊ - publicCertData: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Radius client root certificate of P2SVpnServerConfiguration.␊ - */␊ - export interface P2SVpnServerConfigRadiusClientRootCertificate {␊ - /**␊ - * Properties of the Radius client root certificate.␊ - */␊ - properties?: (P2SVpnServerConfigRadiusClientRootCertificatePropertiesFormat | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Radius client root certificate of P2SVpnServerConfiguration.␊ - */␊ - export interface P2SVpnServerConfigRadiusClientRootCertificatePropertiesFormat {␊ - /**␊ - * The Radius client root certificate thumbprint.␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualWans/p2sVpnServerConfigurations␊ - */␊ - export interface VirtualWansP2SVpnServerConfigurationsChildResource {␊ - name: string␊ - type: "p2sVpnServerConfigurations"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Properties of the P2SVpnServer configuration.␊ - */␊ - properties: (P2SVpnServerConfigurationProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualWans/p2sVpnServerConfigurations␊ - */␊ - export interface VirtualWansP2SVpnServerConfigurations {␊ - name: string␊ - type: "Microsoft.Network/virtualWans/p2sVpnServerConfigurations"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Properties of the P2SVpnServer configuration.␊ - */␊ - properties: (P2SVpnServerConfigurationProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnGateways␊ - */␊ - export interface VpnGateways3 {␊ - name: string␊ - type: "Microsoft.Network/vpnGateways"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the VPN gateway.␊ - */␊ - properties: (VpnGatewayProperties3 | string)␊ - resources?: VpnGatewaysVpnConnectionsChildResource3[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnGateway.␊ - */␊ - export interface VpnGatewayProperties3 {␊ - /**␊ - * The VirtualHub to which the gateway belongs.␊ - */␊ - virtualHub?: (SubResource23 | string)␊ - /**␊ - * List of all vpn connections to the gateway.␊ - */␊ - connections?: (VpnConnection3[] | string)␊ - /**␊ - * Local network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings12 | string)␊ - /**␊ - * The scale unit for this vpn gateway.␊ - */␊ - vpnGatewayScaleUnit?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnConnection Resource.␊ - */␊ - export interface VpnConnection3 {␊ - /**␊ - * Properties of the VPN connection.␊ - */␊ - properties?: (VpnConnectionProperties3 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnConnection.␊ - */␊ - export interface VpnConnectionProperties3 {␊ - /**␊ - * Id of the connected vpn site.␊ - */␊ - remoteVpnSite?: (SubResource23 | string)␊ - /**␊ - * Routing weight for vpn connection.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * The connection status.␊ - */␊ - connectionStatus?: (("Unknown" | "Connecting" | "Connected" | "NotConnected") | string)␊ - /**␊ - * Connection protocol used for this connection.␊ - */␊ - vpnConnectionProtocolType?: (("IKEv2" | "IKEv1") | string)␊ - /**␊ - * Expected bandwidth in MBPS.␊ - */␊ - connectionBandwidth?: (number | string)␊ - /**␊ - * SharedKey for the vpn connection.␊ - */␊ - sharedKey?: string␊ - /**␊ - * EnableBgp flag.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * Enable policy-based traffic selectors.␊ - */␊ - usePolicyBasedTrafficSelectors?: (boolean | string)␊ - /**␊ - * The IPSec Policies to be considered by this connection.␊ - */␊ - ipsecPolicies?: (IpsecPolicy10[] | string)␊ - /**␊ - * EnableBgp flag.␊ - */␊ - enableRateLimiting?: (boolean | string)␊ - /**␊ - * Enable internet security.␊ - */␊ - enableInternetSecurity?: (boolean | string)␊ - /**␊ - * Use local azure ip to initiate connection.␊ - */␊ - useLocalAzureIpAddress?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnGateways/vpnConnections␊ - */␊ - export interface VpnGatewaysVpnConnectionsChildResource3 {␊ - name: string␊ - type: "vpnConnections"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Properties of the VPN connection.␊ - */␊ - properties: (VpnConnectionProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnGateways/vpnConnections␊ - */␊ - export interface VpnGatewaysVpnConnections3 {␊ - name: string␊ - type: "Microsoft.Network/vpnGateways/vpnConnections"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Properties of the VPN connection.␊ - */␊ - properties: (VpnConnectionProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnSites␊ - */␊ - export interface VpnSites3 {␊ - name: string␊ - type: "Microsoft.Network/vpnSites"␊ - apiVersion: "2019-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the VPN site.␊ - */␊ - properties: (VpnSiteProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnSite.␊ - */␊ - export interface VpnSiteProperties3 {␊ - /**␊ - * The VirtualWAN to which the vpnSite belongs.␊ - */␊ - virtualWan?: (SubResource23 | string)␊ - /**␊ - * The device properties.␊ - */␊ - deviceProperties?: (DeviceProperties3 | string)␊ - /**␊ - * The ip-address for the vpn-site.␊ - */␊ - ipAddress?: string␊ - /**␊ - * The key for vpn-site that can be used for connections.␊ - */␊ - siteKey?: string␊ - /**␊ - * The AddressSpace that contains an array of IP address ranges.␊ - */␊ - addressSpace?: (AddressSpace25 | string)␊ - /**␊ - * The set of bgp properties.␊ - */␊ - bgpProperties?: (BgpSettings12 | string)␊ - /**␊ - * IsSecuritySite flag.␊ - */␊ - isSecuritySite?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * List of properties of the device.␊ - */␊ - export interface DeviceProperties3 {␊ - /**␊ - * Name of the device Vendor.␊ - */␊ - deviceVendor?: string␊ - /**␊ - * Model of the device.␊ - */␊ - deviceModel?: string␊ - /**␊ - * Link speed.␊ - */␊ - linkSpeedInMbps?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/applicationGateways␊ - */␊ - export interface ApplicationGateways17 {␊ - name: string␊ - type: "Microsoft.Network/applicationGateways"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the application gateway.␊ - */␊ - properties: (ApplicationGatewayPropertiesFormat17 | string)␊ - /**␊ - * A list of availability zones denoting where the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - /**␊ - * The identity of the application gateway, if configured.␊ - */␊ - identity?: (ManagedServiceIdentity4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application gateway.␊ - */␊ - export interface ApplicationGatewayPropertiesFormat17 {␊ - /**␊ - * SKU of the application gateway resource.␊ - */␊ - sku?: (ApplicationGatewaySku17 | string)␊ - /**␊ - * SSL policy of the application gateway resource.␊ - */␊ - sslPolicy?: (ApplicationGatewaySslPolicy14 | string)␊ - /**␊ - * Subnets of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - gatewayIPConfigurations?: (ApplicationGatewayIPConfiguration17[] | string)␊ - /**␊ - * Authentication certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - authenticationCertificates?: (ApplicationGatewayAuthenticationCertificate14[] | string)␊ - /**␊ - * Trusted Root certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - trustedRootCertificates?: (ApplicationGatewayTrustedRootCertificate5[] | string)␊ - /**␊ - * SSL certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - sslCertificates?: (ApplicationGatewaySslCertificate17[] | string)␊ - /**␊ - * Frontend IP addresses of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - frontendIPConfigurations?: (ApplicationGatewayFrontendIPConfiguration17[] | string)␊ - /**␊ - * Frontend ports of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - frontendPorts?: (ApplicationGatewayFrontendPort17[] | string)␊ - /**␊ - * Probes of the application gateway resource.␊ - */␊ - probes?: (ApplicationGatewayProbe16[] | string)␊ - /**␊ - * Backend address pool of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - backendAddressPools?: (ApplicationGatewayBackendAddressPool17[] | string)␊ - /**␊ - * Backend http settings of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - backendHttpSettingsCollection?: (ApplicationGatewayBackendHttpSettings17[] | string)␊ - /**␊ - * Http listeners of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - httpListeners?: (ApplicationGatewayHttpListener17[] | string)␊ - /**␊ - * URL path map of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - urlPathMaps?: (ApplicationGatewayUrlPathMap16[] | string)␊ - /**␊ - * Request routing rules of the application gateway resource.␊ - */␊ - requestRoutingRules?: (ApplicationGatewayRequestRoutingRule17[] | string)␊ - /**␊ - * Rewrite rules for the application gateway resource.␊ - */␊ - rewriteRuleSets?: (ApplicationGatewayRewriteRuleSet4[] | string)␊ - /**␊ - * Redirect configurations of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - redirectConfigurations?: (ApplicationGatewayRedirectConfiguration14[] | string)␊ - /**␊ - * Web application firewall configuration.␊ - */␊ - webApplicationFirewallConfiguration?: (ApplicationGatewayWebApplicationFirewallConfiguration14 | string)␊ - /**␊ - * Reference of the FirewallPolicy resource.␊ - */␊ - firewallPolicy?: (SubResource24 | string)␊ - /**␊ - * Whether HTTP2 is enabled on the application gateway resource.␊ - */␊ - enableHttp2?: (boolean | string)␊ - /**␊ - * Whether FIPS is enabled on the application gateway resource.␊ - */␊ - enableFips?: (boolean | string)␊ - /**␊ - * Autoscale Configuration.␊ - */␊ - autoscaleConfiguration?: (ApplicationGatewayAutoscaleConfiguration8 | string)␊ - /**␊ - * Custom error configurations of the application gateway resource.␊ - */␊ - customErrorConfigurations?: (ApplicationGatewayCustomError5[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of an application gateway.␊ - */␊ - export interface ApplicationGatewaySku17 {␊ - /**␊ - * Name of an application gateway SKU.␊ - */␊ - name?: (("Standard_Small" | "Standard_Medium" | "Standard_Large" | "WAF_Medium" | "WAF_Large" | "Standard_v2" | "WAF_v2") | string)␊ - /**␊ - * Tier of an application gateway.␊ - */␊ - tier?: (("Standard" | "WAF" | "Standard_v2" | "WAF_v2") | string)␊ - /**␊ - * Capacity (instance count) of an application gateway.␊ - */␊ - capacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application Gateway Ssl policy.␊ - */␊ - export interface ApplicationGatewaySslPolicy14 {␊ - /**␊ - * Ssl protocols to be disabled on application gateway.␊ - */␊ - disabledSslProtocols?: (("TLSv1_0" | "TLSv1_1" | "TLSv1_2")[] | string)␊ - /**␊ - * Type of Ssl Policy.␊ - */␊ - policyType?: (("Predefined" | "Custom") | string)␊ - /**␊ - * Name of Ssl predefined policy.␊ - */␊ - policyName?: (("AppGwSslPolicy20150501" | "AppGwSslPolicy20170401" | "AppGwSslPolicy20170401S") | string)␊ - /**␊ - * Ssl cipher suites to be enabled in the specified order to application gateway.␊ - */␊ - cipherSuites?: (("TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384" | "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256" | "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA" | "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA" | "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384" | "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256" | "TLS_DHE_RSA_WITH_AES_256_CBC_SHA" | "TLS_DHE_RSA_WITH_AES_128_CBC_SHA" | "TLS_RSA_WITH_AES_256_GCM_SHA384" | "TLS_RSA_WITH_AES_128_GCM_SHA256" | "TLS_RSA_WITH_AES_256_CBC_SHA256" | "TLS_RSA_WITH_AES_128_CBC_SHA256" | "TLS_RSA_WITH_AES_256_CBC_SHA" | "TLS_RSA_WITH_AES_128_CBC_SHA" | "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384" | "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256" | "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384" | "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256" | "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA" | "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA" | "TLS_DHE_DSS_WITH_AES_256_CBC_SHA256" | "TLS_DHE_DSS_WITH_AES_128_CBC_SHA256" | "TLS_DHE_DSS_WITH_AES_256_CBC_SHA" | "TLS_DHE_DSS_WITH_AES_128_CBC_SHA" | "TLS_RSA_WITH_3DES_EDE_CBC_SHA" | "TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA" | "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256" | "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384")[] | string)␊ - /**␊ - * Minimum version of Ssl protocol to be supported on application gateway.␊ - */␊ - minProtocolVersion?: (("TLSv1_0" | "TLSv1_1" | "TLSv1_2") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed.␊ - */␊ - export interface ApplicationGatewayIPConfiguration17 {␊ - /**␊ - * Properties of the application gateway IP configuration.␊ - */␊ - properties?: (ApplicationGatewayIPConfigurationPropertiesFormat17 | string)␊ - /**␊ - * Name of the IP configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayIPConfigurationPropertiesFormat17 {␊ - /**␊ - * Reference of the subnet resource. A subnet from where application gateway gets its private address.␊ - */␊ - subnet?: (SubResource24 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Reference to another subresource.␊ - */␊ - export interface SubResource24 {␊ - /**␊ - * Resource ID.␊ - */␊ - id: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authentication certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewayAuthenticationCertificate14 {␊ - /**␊ - * Properties of the application gateway authentication certificate.␊ - */␊ - properties?: (ApplicationGatewayAuthenticationCertificatePropertiesFormat14 | string)␊ - /**␊ - * Name of the authentication certificate that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authentication certificates properties of an application gateway.␊ - */␊ - export interface ApplicationGatewayAuthenticationCertificatePropertiesFormat14 {␊ - /**␊ - * Certificate public data.␊ - */␊ - data?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trusted Root certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewayTrustedRootCertificate5 {␊ - /**␊ - * Properties of the application gateway trusted root certificate.␊ - */␊ - properties?: (ApplicationGatewayTrustedRootCertificatePropertiesFormat5 | string)␊ - /**␊ - * Name of the trusted root certificate that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trusted Root certificates properties of an application gateway.␊ - */␊ - export interface ApplicationGatewayTrustedRootCertificatePropertiesFormat5 {␊ - /**␊ - * Certificate public data.␊ - */␊ - data?: string␊ - /**␊ - * Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault.␊ - */␊ - keyVaultSecretId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSL certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewaySslCertificate17 {␊ - /**␊ - * Properties of the application gateway SSL certificate.␊ - */␊ - properties?: (ApplicationGatewaySslCertificatePropertiesFormat17 | string)␊ - /**␊ - * Name of the SSL certificate that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewaySslCertificatePropertiesFormat17 {␊ - /**␊ - * Base-64 encoded pfx certificate. Only applicable in PUT Request.␊ - */␊ - data?: string␊ - /**␊ - * Password for the pfx file specified in data. Only applicable in PUT request.␊ - */␊ - password?: string␊ - /**␊ - * Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault.␊ - */␊ - keyVaultSecretId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendIPConfiguration17 {␊ - /**␊ - * Properties of the application gateway frontend IP configuration.␊ - */␊ - properties?: (ApplicationGatewayFrontendIPConfigurationPropertiesFormat17 | string)␊ - /**␊ - * Name of the frontend IP configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendIPConfigurationPropertiesFormat17 {␊ - /**␊ - * PrivateIPAddress of the network interface IP Configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The private IP address allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Reference of the subnet resource.␊ - */␊ - subnet?: (SubResource24 | string)␊ - /**␊ - * Reference of the PublicIP resource.␊ - */␊ - publicIPAddress?: (SubResource24 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend port of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendPort17 {␊ - /**␊ - * Properties of the application gateway frontend port.␊ - */␊ - properties?: (ApplicationGatewayFrontendPortPropertiesFormat17 | string)␊ - /**␊ - * Name of the frontend port that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend port of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendPortPropertiesFormat17 {␊ - /**␊ - * Frontend port.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Probe of the application gateway.␊ - */␊ - export interface ApplicationGatewayProbe16 {␊ - /**␊ - * Properties of the application gateway probe.␊ - */␊ - properties?: (ApplicationGatewayProbePropertiesFormat16 | string)␊ - /**␊ - * Name of the probe that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of probe of an application gateway.␊ - */␊ - export interface ApplicationGatewayProbePropertiesFormat16 {␊ - /**␊ - * The protocol used for the probe.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Host name to send the probe to.␊ - */␊ - host?: string␊ - /**␊ - * Relative path of probe. Valid path starts from '/'. Probe is sent to ://:.␊ - */␊ - path?: string␊ - /**␊ - * The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - interval?: (number | string)␊ - /**␊ - * The probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - timeout?: (number | string)␊ - /**␊ - * The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20.␊ - */␊ - unhealthyThreshold?: (number | string)␊ - /**␊ - * Whether the host header should be picked from the backend http settings. Default value is false.␊ - */␊ - pickHostNameFromBackendHttpSettings?: (boolean | string)␊ - /**␊ - * Minimum number of servers that are always marked healthy. Default value is 0.␊ - */␊ - minServers?: (number | string)␊ - /**␊ - * Criterion for classifying a healthy probe response.␊ - */␊ - match?: (ApplicationGatewayProbeHealthResponseMatch14 | string)␊ - /**␊ - * Custom port which will be used for probing the backend servers. The valid value ranges from 1 to 65535. In case not set, port from http settings will be used. This property is valid for Standard_v2 and WAF_v2 only.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application gateway probe health response match.␊ - */␊ - export interface ApplicationGatewayProbeHealthResponseMatch14 {␊ - /**␊ - * Body that must be contained in the health response. Default value is empty.␊ - */␊ - body?: string␊ - /**␊ - * Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399.␊ - */␊ - statusCodes?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend Address Pool of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddressPool17 {␊ - /**␊ - * Properties of the application gateway backend address pool.␊ - */␊ - properties?: (ApplicationGatewayBackendAddressPoolPropertiesFormat17 | string)␊ - /**␊ - * Name of the backend address pool that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend Address Pool of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddressPoolPropertiesFormat17 {␊ - /**␊ - * Backend addresses.␊ - */␊ - backendAddresses?: (ApplicationGatewayBackendAddress17[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddress17 {␊ - /**␊ - * Fully qualified domain name (FQDN).␊ - */␊ - fqdn?: string␊ - /**␊ - * IP address.␊ - */␊ - ipAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address pool settings of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendHttpSettings17 {␊ - /**␊ - * Properties of the application gateway backend HTTP settings.␊ - */␊ - properties?: (ApplicationGatewayBackendHttpSettingsPropertiesFormat17 | string)␊ - /**␊ - * Name of the backend http settings that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend address pool settings of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendHttpSettingsPropertiesFormat17 {␊ - /**␊ - * The destination port on the backend.␊ - */␊ - port?: (number | string)␊ - /**␊ - * The protocol used to communicate with the backend.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Cookie based affinity.␊ - */␊ - cookieBasedAffinity?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Request timeout in seconds. Application Gateway will fail the request if response is not received within RequestTimeout. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - requestTimeout?: (number | string)␊ - /**␊ - * Probe resource of an application gateway.␊ - */␊ - probe?: (SubResource24 | string)␊ - /**␊ - * Array of references to application gateway authentication certificates.␊ - */␊ - authenticationCertificates?: (SubResource24[] | string)␊ - /**␊ - * Array of references to application gateway trusted root certificates.␊ - */␊ - trustedRootCertificates?: (SubResource24[] | string)␊ - /**␊ - * Connection draining of the backend http settings resource.␊ - */␊ - connectionDraining?: (ApplicationGatewayConnectionDraining14 | string)␊ - /**␊ - * Host header to be sent to the backend servers.␊ - */␊ - hostName?: string␊ - /**␊ - * Whether to pick host header should be picked from the host name of the backend server. Default value is false.␊ - */␊ - pickHostNameFromBackendAddress?: (boolean | string)␊ - /**␊ - * Cookie name to use for the affinity cookie.␊ - */␊ - affinityCookieName?: string␊ - /**␊ - * Whether the probe is enabled. Default value is false.␊ - */␊ - probeEnabled?: (boolean | string)␊ - /**␊ - * Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null.␊ - */␊ - path?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Connection draining allows open connections to a backend server to be active for a specified time after the backend server got removed from the configuration.␊ - */␊ - export interface ApplicationGatewayConnectionDraining14 {␊ - /**␊ - * Whether connection draining is enabled or not.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds.␊ - */␊ - drainTimeoutInSec: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http listener of an application gateway.␊ - */␊ - export interface ApplicationGatewayHttpListener17 {␊ - /**␊ - * Properties of the application gateway HTTP listener.␊ - */␊ - properties?: (ApplicationGatewayHttpListenerPropertiesFormat17 | string)␊ - /**␊ - * Name of the HTTP listener that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of HTTP listener of an application gateway.␊ - */␊ - export interface ApplicationGatewayHttpListenerPropertiesFormat17 {␊ - /**␊ - * Frontend IP configuration resource of an application gateway.␊ - */␊ - frontendIPConfiguration?: (SubResource24 | string)␊ - /**␊ - * Frontend port resource of an application gateway.␊ - */␊ - frontendPort?: (SubResource24 | string)␊ - /**␊ - * Protocol of the HTTP listener.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Host name of HTTP listener.␊ - */␊ - hostName?: string␊ - /**␊ - * SSL certificate resource of an application gateway.␊ - */␊ - sslCertificate?: (SubResource24 | string)␊ - /**␊ - * Applicable only if protocol is https. Enables SNI for multi-hosting.␊ - */␊ - requireServerNameIndication?: (boolean | string)␊ - /**␊ - * Custom error configurations of the HTTP listener.␊ - */␊ - customErrorConfigurations?: (ApplicationGatewayCustomError5[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Customer error of an application gateway.␊ - */␊ - export interface ApplicationGatewayCustomError5 {␊ - /**␊ - * Status code of the application gateway customer error.␊ - */␊ - statusCode?: (("HttpStatus403" | "HttpStatus502") | string)␊ - /**␊ - * Error page URL of the application gateway customer error.␊ - */␊ - customErrorPageUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * UrlPathMaps give a url path to the backend mapping information for PathBasedRouting.␊ - */␊ - export interface ApplicationGatewayUrlPathMap16 {␊ - /**␊ - * Properties of the application gateway URL path map.␊ - */␊ - properties?: (ApplicationGatewayUrlPathMapPropertiesFormat16 | string)␊ - /**␊ - * Name of the URL path map that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of UrlPathMap of the application gateway.␊ - */␊ - export interface ApplicationGatewayUrlPathMapPropertiesFormat16 {␊ - /**␊ - * Default backend address pool resource of URL path map.␊ - */␊ - defaultBackendAddressPool?: (SubResource24 | string)␊ - /**␊ - * Default backend http settings resource of URL path map.␊ - */␊ - defaultBackendHttpSettings?: (SubResource24 | string)␊ - /**␊ - * Default Rewrite rule set resource of URL path map.␊ - */␊ - defaultRewriteRuleSet?: (SubResource24 | string)␊ - /**␊ - * Default redirect configuration resource of URL path map.␊ - */␊ - defaultRedirectConfiguration?: (SubResource24 | string)␊ - /**␊ - * Path rule of URL path map resource.␊ - */␊ - pathRules?: (ApplicationGatewayPathRule16[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Path rule of URL path map of an application gateway.␊ - */␊ - export interface ApplicationGatewayPathRule16 {␊ - /**␊ - * Properties of the application gateway path rule.␊ - */␊ - properties?: (ApplicationGatewayPathRulePropertiesFormat16 | string)␊ - /**␊ - * Name of the path rule that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of path rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayPathRulePropertiesFormat16 {␊ - /**␊ - * Path rules of URL path map.␊ - */␊ - paths?: (string[] | string)␊ - /**␊ - * Backend address pool resource of URL path map path rule.␊ - */␊ - backendAddressPool?: (SubResource24 | string)␊ - /**␊ - * Backend http settings resource of URL path map path rule.␊ - */␊ - backendHttpSettings?: (SubResource24 | string)␊ - /**␊ - * Redirect configuration resource of URL path map path rule.␊ - */␊ - redirectConfiguration?: (SubResource24 | string)␊ - /**␊ - * Rewrite rule set resource of URL path map path rule.␊ - */␊ - rewriteRuleSet?: (SubResource24 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Request routing rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayRequestRoutingRule17 {␊ - /**␊ - * Properties of the application gateway request routing rule.␊ - */␊ - properties?: (ApplicationGatewayRequestRoutingRulePropertiesFormat17 | string)␊ - /**␊ - * Name of the request routing rule that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of request routing rule of the application gateway.␊ - */␊ - export interface ApplicationGatewayRequestRoutingRulePropertiesFormat17 {␊ - /**␊ - * Rule type.␊ - */␊ - ruleType?: (("Basic" | "PathBasedRouting") | string)␊ - /**␊ - * Backend address pool resource of the application gateway.␊ - */␊ - backendAddressPool?: (SubResource24 | string)␊ - /**␊ - * Backend http settings resource of the application gateway.␊ - */␊ - backendHttpSettings?: (SubResource24 | string)␊ - /**␊ - * Http listener resource of the application gateway.␊ - */␊ - httpListener?: (SubResource24 | string)␊ - /**␊ - * URL path map resource of the application gateway.␊ - */␊ - urlPathMap?: (SubResource24 | string)␊ - /**␊ - * Rewrite Rule Set resource in Basic rule of the application gateway.␊ - */␊ - rewriteRuleSet?: (SubResource24 | string)␊ - /**␊ - * Redirect configuration resource of the application gateway.␊ - */␊ - redirectConfiguration?: (SubResource24 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Rewrite rule set of an application gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRuleSet4 {␊ - /**␊ - * Properties of the application gateway rewrite rule set.␊ - */␊ - properties?: (ApplicationGatewayRewriteRuleSetPropertiesFormat4 | string)␊ - /**␊ - * Name of the rewrite rule set that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of rewrite rule set of the application gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRuleSetPropertiesFormat4 {␊ - /**␊ - * Rewrite rules in the rewrite rule set.␊ - */␊ - rewriteRules?: (ApplicationGatewayRewriteRule4[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Rewrite rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRule4 {␊ - /**␊ - * Name of the rewrite rule that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet.␊ - */␊ - ruleSequence?: (number | string)␊ - /**␊ - * Conditions based on which the action set execution will be evaluated.␊ - */␊ - conditions?: (ApplicationGatewayRewriteRuleCondition3[] | string)␊ - /**␊ - * Set of actions to be done as part of the rewrite Rule.␊ - */␊ - actionSet?: (ApplicationGatewayRewriteRuleActionSet4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Set of conditions in the Rewrite Rule in Application Gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRuleCondition3 {␊ - /**␊ - * The condition parameter of the RewriteRuleCondition.␊ - */␊ - variable?: string␊ - /**␊ - * The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition.␊ - */␊ - pattern?: string␊ - /**␊ - * Setting this paramter to truth value with force the pattern to do a case in-sensitive comparison.␊ - */␊ - ignoreCase?: (boolean | string)␊ - /**␊ - * Setting this value as truth will force to check the negation of the condition given by the user.␊ - */␊ - negate?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Set of actions in the Rewrite Rule in Application Gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRuleActionSet4 {␊ - /**␊ - * Request Header Actions in the Action Set.␊ - */␊ - requestHeaderConfigurations?: (ApplicationGatewayHeaderConfiguration4[] | string)␊ - /**␊ - * Response Header Actions in the Action Set.␊ - */␊ - responseHeaderConfigurations?: (ApplicationGatewayHeaderConfiguration4[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Header configuration of the Actions set in Application Gateway.␊ - */␊ - export interface ApplicationGatewayHeaderConfiguration4 {␊ - /**␊ - * Header name of the header configuration.␊ - */␊ - headerName?: string␊ - /**␊ - * Header value of the header configuration.␊ - */␊ - headerValue?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Redirect configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayRedirectConfiguration14 {␊ - /**␊ - * Properties of the application gateway redirect configuration.␊ - */␊ - properties?: (ApplicationGatewayRedirectConfigurationPropertiesFormat14 | string)␊ - /**␊ - * Name of the redirect configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of redirect configuration of the application gateway.␊ - */␊ - export interface ApplicationGatewayRedirectConfigurationPropertiesFormat14 {␊ - /**␊ - * HTTP redirection type.␊ - */␊ - redirectType?: (("Permanent" | "Found" | "SeeOther" | "Temporary") | string)␊ - /**␊ - * Reference to a listener to redirect the request to.␊ - */␊ - targetListener?: (SubResource24 | string)␊ - /**␊ - * Url to redirect the request to.␊ - */␊ - targetUrl?: string␊ - /**␊ - * Include path in the redirected url.␊ - */␊ - includePath?: (boolean | string)␊ - /**␊ - * Include query string in the redirected url.␊ - */␊ - includeQueryString?: (boolean | string)␊ - /**␊ - * Request routing specifying redirect configuration.␊ - */␊ - requestRoutingRules?: (SubResource24[] | string)␊ - /**␊ - * Url path maps specifying default redirect configuration.␊ - */␊ - urlPathMaps?: (SubResource24[] | string)␊ - /**␊ - * Path rules specifying redirect configuration.␊ - */␊ - pathRules?: (SubResource24[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application gateway web application firewall configuration.␊ - */␊ - export interface ApplicationGatewayWebApplicationFirewallConfiguration14 {␊ - /**␊ - * Whether the web application firewall is enabled or not.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * Web application firewall mode.␊ - */␊ - firewallMode: (("Detection" | "Prevention") | string)␊ - /**␊ - * The type of the web application firewall rule set. Possible values are: 'OWASP'.␊ - */␊ - ruleSetType: string␊ - /**␊ - * The version of the rule set type.␊ - */␊ - ruleSetVersion: string␊ - /**␊ - * The disabled rule groups.␊ - */␊ - disabledRuleGroups?: (ApplicationGatewayFirewallDisabledRuleGroup14[] | string)␊ - /**␊ - * Whether allow WAF to check request Body.␊ - */␊ - requestBodyCheck?: (boolean | string)␊ - /**␊ - * Maximum request body size for WAF.␊ - */␊ - maxRequestBodySize?: (number | string)␊ - /**␊ - * Maximum request body size in Kb for WAF.␊ - */␊ - maxRequestBodySizeInKb?: (number | string)␊ - /**␊ - * Maximum file upload size in Mb for WAF.␊ - */␊ - fileUploadLimitInMb?: (number | string)␊ - /**␊ - * The exclusion list.␊ - */␊ - exclusions?: (ApplicationGatewayFirewallExclusion5[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allows to disable rules within a rule group or an entire rule group.␊ - */␊ - export interface ApplicationGatewayFirewallDisabledRuleGroup14 {␊ - /**␊ - * The name of the rule group that will be disabled.␊ - */␊ - ruleGroupName: string␊ - /**␊ - * The list of rules that will be disabled. If null, all rules of the rule group will be disabled.␊ - */␊ - rules?: (number[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allow to exclude some variable satisfy the condition for the WAF check.␊ - */␊ - export interface ApplicationGatewayFirewallExclusion5 {␊ - /**␊ - * The variable to be excluded.␊ - */␊ - matchVariable: string␊ - /**␊ - * When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to.␊ - */␊ - selectorMatchOperator: string␊ - /**␊ - * When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to.␊ - */␊ - selector: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application Gateway autoscale configuration.␊ - */␊ - export interface ApplicationGatewayAutoscaleConfiguration8 {␊ - /**␊ - * Lower bound on number of Application Gateway capacity.␊ - */␊ - minCapacity: (number | string)␊ - /**␊ - * Upper bound on number of Application Gateway capacity.␊ - */␊ - maxCapacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the resource.␊ - */␊ - export interface ManagedServiceIdentity4 {␊ - /**␊ - * The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.␊ - */␊ - type?: ("SystemAssigned" | "UserAssigned" | "SystemAssigned, UserAssigned" | "None")␊ - /**␊ - * The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.␊ - */␊ - userAssignedIdentities?: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies␊ - */␊ - export interface ApplicationGatewayWebApplicationFirewallPolicies2 {␊ - name: string␊ - type: "Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the web application firewall policy.␊ - */␊ - properties: (WebApplicationFirewallPolicyPropertiesFormat2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines web application firewall policy properties.␊ - */␊ - export interface WebApplicationFirewallPolicyPropertiesFormat2 {␊ - /**␊ - * Describes policySettings for policy.␊ - */␊ - policySettings?: (PolicySettings4 | string)␊ - /**␊ - * Describes custom rules inside the policy.␊ - */␊ - customRules?: (WebApplicationFirewallCustomRule2[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines contents of a web application firewall global configuration.␊ - */␊ - export interface PolicySettings4 {␊ - /**␊ - * Describes if the policy is in enabled state or disabled state.␊ - */␊ - enabledState?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * Describes if it is in detection mode or prevention mode at policy level.␊ - */␊ - mode?: (("Prevention" | "Detection") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines contents of a web application rule.␊ - */␊ - export interface WebApplicationFirewallCustomRule2 {␊ - /**␊ - * Gets name of the resource that is unique within a policy. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value.␊ - */␊ - priority: (number | string)␊ - /**␊ - * Describes type of rule.␊ - */␊ - ruleType: (("MatchRule" | "Invalid") | string)␊ - /**␊ - * List of match conditions.␊ - */␊ - matchConditions: (MatchCondition4[] | string)␊ - /**␊ - * Type of Actions.␊ - */␊ - action: (("Allow" | "Block" | "Log") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Define match conditions.␊ - */␊ - export interface MatchCondition4 {␊ - /**␊ - * List of match variables.␊ - */␊ - matchVariables: (MatchVariable2[] | string)␊ - /**␊ - * Describes operator to be matched.␊ - */␊ - operator: (("IPMatch" | "Equal" | "Contains" | "LessThan" | "GreaterThan" | "LessThanOrEqual" | "GreaterThanOrEqual" | "BeginsWith" | "EndsWith" | "Regex") | string)␊ - /**␊ - * Describes if this is negate condition or not.␊ - */␊ - negationConditon?: (boolean | string)␊ - /**␊ - * Match value.␊ - */␊ - matchValues: (string[] | string)␊ - /**␊ - * List of transforms.␊ - */␊ - transforms?: (("Lowercase" | "Trim" | "UrlDecode" | "UrlEncode" | "RemoveNulls" | "HtmlEntityDecode")[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Define match variables.␊ - */␊ - export interface MatchVariable2 {␊ - /**␊ - * Match Variable.␊ - */␊ - variableName: (("RemoteAddr" | "RequestMethod" | "QueryString" | "PostArgs" | "RequestUri" | "RequestHeaders" | "RequestBody" | "RequestCookies") | string)␊ - /**␊ - * Describes field of the matchVariable collection.␊ - */␊ - selector?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/applicationSecurityGroups␊ - */␊ - export interface ApplicationSecurityGroups14 {␊ - name: string␊ - type: "Microsoft.Network/applicationSecurityGroups"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the application security group.␊ - */␊ - properties: (ApplicationSecurityGroupPropertiesFormat1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application security group properties.␊ - */␊ - export interface ApplicationSecurityGroupPropertiesFormat1 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/azureFirewalls␊ - */␊ - export interface AzureFirewalls4 {␊ - name: string␊ - type: "Microsoft.Network/azureFirewalls"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the azure firewall.␊ - */␊ - properties: (AzureFirewallPropertiesFormat4 | string)␊ - /**␊ - * A list of availability zones denoting where the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Azure Firewall.␊ - */␊ - export interface AzureFirewallPropertiesFormat4 {␊ - /**␊ - * Collection of application rule collections used by Azure Firewall.␊ - */␊ - applicationRuleCollections?: (AzureFirewallApplicationRuleCollection4[] | string)␊ - /**␊ - * Collection of NAT rule collections used by Azure Firewall.␊ - */␊ - natRuleCollections?: (AzureFirewallNatRuleCollection1[] | string)␊ - /**␊ - * Collection of network rule collections used by Azure Firewall.␊ - */␊ - networkRuleCollections?: (AzureFirewallNetworkRuleCollection4[] | string)␊ - /**␊ - * IP configuration of the Azure Firewall resource.␊ - */␊ - ipConfigurations?: (AzureFirewallIPConfiguration4[] | string)␊ - /**␊ - * The operation mode for Threat Intelligence.␊ - */␊ - threatIntelMode?: (("Alert" | "Deny" | "Off") | string)␊ - /**␊ - * The virtualHub to which the firewall belongs.␊ - */␊ - virtualHub?: (SubResource24 | string)␊ - /**␊ - * The firewallPolicy associated with this azure firewall.␊ - */␊ - firewallPolicy?: (SubResource24 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application rule collection resource.␊ - */␊ - export interface AzureFirewallApplicationRuleCollection4 {␊ - /**␊ - * Properties of the azure firewall application rule collection.␊ - */␊ - properties?: (AzureFirewallApplicationRuleCollectionPropertiesFormat4 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application rule collection.␊ - */␊ - export interface AzureFirewallApplicationRuleCollectionPropertiesFormat4 {␊ - /**␊ - * Priority of the application rule collection resource.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * The action type of a rule collection.␊ - */␊ - action?: (AzureFirewallRCAction4 | string)␊ - /**␊ - * Collection of rules used by a application rule collection.␊ - */␊ - rules?: (AzureFirewallApplicationRule4[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the AzureFirewallRCAction.␊ - */␊ - export interface AzureFirewallRCAction4 {␊ - /**␊ - * The type of action.␊ - */␊ - type?: ("Allow" | "Deny")␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of an application rule.␊ - */␊ - export interface AzureFirewallApplicationRule4 {␊ - /**␊ - * Name of the application rule.␊ - */␊ - name?: string␊ - /**␊ - * Description of the rule.␊ - */␊ - description?: string␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * Array of ApplicationRuleProtocols.␊ - */␊ - protocols?: (AzureFirewallApplicationRuleProtocol4[] | string)␊ - /**␊ - * List of FQDNs for this rule.␊ - */␊ - targetFqdns?: (string[] | string)␊ - /**␊ - * List of FQDN Tags for this rule.␊ - */␊ - fqdnTags?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application rule protocol.␊ - */␊ - export interface AzureFirewallApplicationRuleProtocol4 {␊ - /**␊ - * Protocol type.␊ - */␊ - protocolType?: (("Http" | "Https") | string)␊ - /**␊ - * Port number for the protocol, cannot be greater than 64000. This field is optional.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NAT rule collection resource.␊ - */␊ - export interface AzureFirewallNatRuleCollection1 {␊ - /**␊ - * Properties of the azure firewall NAT rule collection.␊ - */␊ - properties?: (AzureFirewallNatRuleCollectionProperties1 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the NAT rule collection.␊ - */␊ - export interface AzureFirewallNatRuleCollectionProperties1 {␊ - /**␊ - * Priority of the NAT rule collection resource.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * The action type of a NAT rule collection.␊ - */␊ - action?: (AzureFirewallNatRCAction1 | string)␊ - /**␊ - * Collection of rules used by a NAT rule collection.␊ - */␊ - rules?: (AzureFirewallNatRule1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AzureFirewall NAT Rule Collection Action.␊ - */␊ - export interface AzureFirewallNatRCAction1 {␊ - /**␊ - * The type of action.␊ - */␊ - type?: ("Snat" | "Dnat")␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a NAT rule.␊ - */␊ - export interface AzureFirewallNatRule1 {␊ - /**␊ - * Name of the NAT rule.␊ - */␊ - name?: string␊ - /**␊ - * Description of the rule.␊ - */␊ - description?: string␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags.␊ - */␊ - destinationAddresses?: (string[] | string)␊ - /**␊ - * List of destination ports.␊ - */␊ - destinationPorts?: (string[] | string)␊ - /**␊ - * Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule.␊ - */␊ - protocols?: (("TCP" | "UDP" | "Any" | "ICMP")[] | string)␊ - /**␊ - * The translated address for this NAT rule.␊ - */␊ - translatedAddress?: string␊ - /**␊ - * The translated port for this NAT rule.␊ - */␊ - translatedPort?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network rule collection resource.␊ - */␊ - export interface AzureFirewallNetworkRuleCollection4 {␊ - /**␊ - * Properties of the azure firewall network rule collection.␊ - */␊ - properties?: (AzureFirewallNetworkRuleCollectionPropertiesFormat4 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the network rule collection.␊ - */␊ - export interface AzureFirewallNetworkRuleCollectionPropertiesFormat4 {␊ - /**␊ - * Priority of the network rule collection resource.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * The action type of a rule collection.␊ - */␊ - action?: (AzureFirewallRCAction4 | string)␊ - /**␊ - * Collection of rules used by a network rule collection.␊ - */␊ - rules?: (AzureFirewallNetworkRule4[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the network rule.␊ - */␊ - export interface AzureFirewallNetworkRule4 {␊ - /**␊ - * Name of the network rule.␊ - */␊ - name?: string␊ - /**␊ - * Description of the rule.␊ - */␊ - description?: string␊ - /**␊ - * Array of AzureFirewallNetworkRuleProtocols.␊ - */␊ - protocols?: (("TCP" | "UDP" | "Any" | "ICMP")[] | string)␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * List of destination IP addresses.␊ - */␊ - destinationAddresses?: (string[] | string)␊ - /**␊ - * List of destination ports.␊ - */␊ - destinationPorts?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration of an Azure Firewall.␊ - */␊ - export interface AzureFirewallIPConfiguration4 {␊ - /**␊ - * Properties of the azure firewall IP configuration.␊ - */␊ - properties?: (AzureFirewallIPConfigurationPropertiesFormat4 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration of an Azure Firewall.␊ - */␊ - export interface AzureFirewallIPConfigurationPropertiesFormat4 {␊ - /**␊ - * Reference of the subnet resource. This resource must be named 'AzureFirewallSubnet'.␊ - */␊ - subnet?: (SubResource24 | string)␊ - /**␊ - * Reference of the PublicIP resource. This field is a mandatory input if subnet is not null.␊ - */␊ - publicIPAddress?: (SubResource24 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/bastionHosts␊ - */␊ - export interface BastionHosts1 {␊ - name: string␊ - type: "Microsoft.Network/bastionHosts"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Represents the bastion host resource.␊ - */␊ - properties: (BastionHostPropertiesFormat1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Bastion Host.␊ - */␊ - export interface BastionHostPropertiesFormat1 {␊ - /**␊ - * IP configuration of the Bastion Host resource.␊ - */␊ - ipConfigurations?: (BastionHostIPConfiguration1[] | string)␊ - /**␊ - * FQDN for the endpoint on which bastion host is accessible.␊ - */␊ - dnsName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration of an Bastion Host.␊ - */␊ - export interface BastionHostIPConfiguration1 {␊ - /**␊ - * Represents the ip configuration associated with the resource.␊ - */␊ - properties?: (BastionHostIPConfigurationPropertiesFormat1 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration of an Bastion Host.␊ - */␊ - export interface BastionHostIPConfigurationPropertiesFormat1 {␊ - /**␊ - * Reference of the subnet resource.␊ - */␊ - subnet: (SubResource24 | string)␊ - /**␊ - * Reference of the PublicIP resource.␊ - */␊ - publicIPAddress: (SubResource24 | string)␊ - /**␊ - * Private IP allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/connections␊ - */␊ - export interface Connections14 {␊ - name: string␊ - type: "Microsoft.Network/connections"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway connection.␊ - */␊ - properties: (VirtualNetworkGatewayConnectionPropertiesFormat14 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewayConnection properties.␊ - */␊ - export interface VirtualNetworkGatewayConnectionPropertiesFormat14 {␊ - /**␊ - * The authorizationKey.␊ - */␊ - authorizationKey?: string␊ - /**␊ - * The reference to virtual network gateway resource.␊ - */␊ - virtualNetworkGateway1: (SubResource24 | string)␊ - /**␊ - * The reference to virtual network gateway resource.␊ - */␊ - virtualNetworkGateway2?: (SubResource24 | string)␊ - /**␊ - * The reference to local network gateway resource.␊ - */␊ - localNetworkGateway2?: (SubResource24 | string)␊ - /**␊ - * Gateway connection type.␊ - */␊ - connectionType: (("IPsec" | "Vnet2Vnet" | "ExpressRoute" | "VPNClient") | string)␊ - /**␊ - * Connection protocol used for this connection.␊ - */␊ - connectionProtocol?: (("IKEv2" | "IKEv1") | string)␊ - /**␊ - * The routing weight.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * The IPSec shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The reference to peerings resource.␊ - */␊ - peer?: (SubResource24 | string)␊ - /**␊ - * EnableBgp flag.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * Enable policy-based traffic selectors.␊ - */␊ - usePolicyBasedTrafficSelectors?: (boolean | string)␊ - /**␊ - * The IPSec Policies to be considered by this connection.␊ - */␊ - ipsecPolicies?: (IpsecPolicy11[] | string)␊ - /**␊ - * Bypass ExpressRoute Gateway for data forwarding.␊ - */␊ - expressRouteGatewayBypass?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An IPSec Policy configuration for a virtual network gateway connection.␊ - */␊ - export interface IpsecPolicy11 {␊ - /**␊ - * The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.␊ - */␊ - saLifeTimeSeconds: (number | string)␊ - /**␊ - * The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.␊ - */␊ - saDataSizeKilobytes: (number | string)␊ - /**␊ - * The IPSec encryption algorithm (IKE phase 1).␊ - */␊ - ipsecEncryption: (("None" | "DES" | "DES3" | "AES128" | "AES192" | "AES256" | "GCMAES128" | "GCMAES192" | "GCMAES256") | string)␊ - /**␊ - * The IPSec integrity algorithm (IKE phase 1).␊ - */␊ - ipsecIntegrity: (("MD5" | "SHA1" | "SHA256" | "GCMAES128" | "GCMAES192" | "GCMAES256") | string)␊ - /**␊ - * The IKE encryption algorithm (IKE phase 2).␊ - */␊ - ikeEncryption: (("DES" | "DES3" | "AES128" | "AES192" | "AES256" | "GCMAES256" | "GCMAES128") | string)␊ - /**␊ - * The IKE integrity algorithm (IKE phase 2).␊ - */␊ - ikeIntegrity: (("MD5" | "SHA1" | "SHA256" | "SHA384" | "GCMAES256" | "GCMAES128") | string)␊ - /**␊ - * The DH Group used in IKE Phase 1 for initial SA.␊ - */␊ - dhGroup: (("None" | "DHGroup1" | "DHGroup2" | "DHGroup14" | "DHGroup2048" | "ECP256" | "ECP384" | "DHGroup24") | string)␊ - /**␊ - * The Pfs Group used in IKE Phase 2 for new child SA.␊ - */␊ - pfsGroup: (("None" | "PFS1" | "PFS2" | "PFS2048" | "ECP256" | "ECP384" | "PFS24" | "PFS14" | "PFSMM") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ddosCustomPolicies␊ - */␊ - export interface DdosCustomPolicies1 {␊ - name: string␊ - type: "Microsoft.Network/ddosCustomPolicies"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the DDoS custom policy.␊ - */␊ - properties: (DdosCustomPolicyPropertiesFormat1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DDoS custom policy properties.␊ - */␊ - export interface DdosCustomPolicyPropertiesFormat1 {␊ - /**␊ - * The protocol-specific DDoS policy customization parameters.␊ - */␊ - protocolCustomSettings?: (ProtocolCustomSettingsFormat1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DDoS custom policy properties.␊ - */␊ - export interface ProtocolCustomSettingsFormat1 {␊ - /**␊ - * The protocol for which the DDoS protection policy is being customized.␊ - */␊ - protocol?: (("Tcp" | "Udp" | "Syn") | string)␊ - /**␊ - * The customized DDoS protection trigger rate.␊ - */␊ - triggerRateOverride?: string␊ - /**␊ - * The customized DDoS protection source rate.␊ - */␊ - sourceRateOverride?: string␊ - /**␊ - * The customized DDoS protection trigger rate sensitivity degrees. High: Trigger rate set with most sensitivity w.r.t. normal traffic. Default: Trigger rate set with moderate sensitivity w.r.t. normal traffic. Low: Trigger rate set with less sensitivity w.r.t. normal traffic. Relaxed: Trigger rate set with least sensitivity w.r.t. normal traffic.␊ - */␊ - triggerSensitivityOverride?: (("Relaxed" | "Low" | "Default" | "High") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ddosProtectionPlans␊ - */␊ - export interface DdosProtectionPlans9 {␊ - name: string␊ - type: "Microsoft.Network/ddosProtectionPlans"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the DDoS protection plan.␊ - */␊ - properties: (DdosProtectionPlanPropertiesFormat6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DDoS protection plan properties.␊ - */␊ - export interface DdosProtectionPlanPropertiesFormat6 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits␊ - */␊ - export interface ExpressRouteCircuits11 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The SKU.␊ - */␊ - sku?: (ExpressRouteCircuitSku11 | string)␊ - /**␊ - * Properties of the express route circuit.␊ - */␊ - properties: (ExpressRouteCircuitPropertiesFormat11 | string)␊ - resources?: (ExpressRouteCircuitsPeeringsChildResource11 | ExpressRouteCircuitsAuthorizationsChildResource11)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains SKU in an ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitSku11 {␊ - /**␊ - * The name of the SKU.␊ - */␊ - name?: string␊ - /**␊ - * The tier of the SKU.␊ - */␊ - tier?: (("Standard" | "Premium" | "Basic" | "Local") | string)␊ - /**␊ - * The family of the SKU.␊ - */␊ - family?: (("UnlimitedData" | "MeteredData") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitPropertiesFormat11 {␊ - /**␊ - * Allow classic operations.␊ - */␊ - allowClassicOperations?: (boolean | string)␊ - /**␊ - * The list of authorizations.␊ - */␊ - authorizations?: (ExpressRouteCircuitAuthorization11[] | string)␊ - /**␊ - * The list of peerings.␊ - */␊ - peerings?: (ExpressRouteCircuitPeering11[] | string)␊ - /**␊ - * The ServiceProviderNotes.␊ - */␊ - serviceProviderNotes?: string␊ - /**␊ - * The ServiceProviderProperties.␊ - */␊ - serviceProviderProperties?: (ExpressRouteCircuitServiceProviderProperties11 | string)␊ - /**␊ - * The reference to the ExpressRoutePort resource when the circuit is provisioned on an ExpressRoutePort resource.␊ - */␊ - expressRoutePort?: (SubResource24 | string)␊ - /**␊ - * The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource.␊ - */␊ - bandwidthInGbps?: (number | string)␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authorization in an ExpressRouteCircuit resource.␊ - */␊ - export interface ExpressRouteCircuitAuthorization11 {␊ - /**␊ - * Properties of the express route circuit authorization.␊ - */␊ - properties?: (AuthorizationPropertiesFormat12 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ExpressRouteCircuitAuthorization.␊ - */␊ - export interface AuthorizationPropertiesFormat12 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peering in an ExpressRouteCircuit resource.␊ - */␊ - export interface ExpressRouteCircuitPeering11 {␊ - /**␊ - * Properties of the express route circuit peering.␊ - */␊ - properties?: (ExpressRouteCircuitPeeringPropertiesFormat12 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the express route circuit peering.␊ - */␊ - export interface ExpressRouteCircuitPeeringPropertiesFormat12 {␊ - /**␊ - * The peering type.␊ - */␊ - peeringType?: (("AzurePublicPeering" | "AzurePrivatePeering" | "MicrosoftPeering") | string)␊ - /**␊ - * The peering state.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * The peer ASN.␊ - */␊ - peerASN?: (number | string)␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The VLAN ID.␊ - */␊ - vlanId?: (number | string)␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig12 | string)␊ - /**␊ - * Gets peering stats.␊ - */␊ - stats?: (ExpressRouteCircuitStats12 | string)␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - /**␊ - * The reference of the RouteFilter resource.␊ - */␊ - routeFilter?: (SubResource24 | string)␊ - /**␊ - * The IPv6 peering configuration.␊ - */␊ - ipv6PeeringConfig?: (Ipv6ExpressRouteCircuitPeeringConfig9 | string)␊ - /**␊ - * The ExpressRoute connection.␊ - */␊ - expressRouteConnection?: (SubResource24 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the peering configuration.␊ - */␊ - export interface ExpressRouteCircuitPeeringConfig12 {␊ - /**␊ - * The reference of AdvertisedPublicPrefixes.␊ - */␊ - advertisedPublicPrefixes?: (string[] | string)␊ - /**␊ - * The communities of bgp peering. Specified for microsoft peering.␊ - */␊ - advertisedCommunities?: (string[] | string)␊ - /**␊ - * The legacy mode of the peering.␊ - */␊ - legacyMode?: (number | string)␊ - /**␊ - * The CustomerASN of the peering.␊ - */␊ - customerASN?: (number | string)␊ - /**␊ - * The RoutingRegistryName of the configuration.␊ - */␊ - routingRegistryName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains stats associated with the peering.␊ - */␊ - export interface ExpressRouteCircuitStats12 {␊ - /**␊ - * Gets BytesIn of the peering.␊ - */␊ - primarybytesIn?: (number | string)␊ - /**␊ - * Gets BytesOut of the peering.␊ - */␊ - primarybytesOut?: (number | string)␊ - /**␊ - * Gets BytesIn of the peering.␊ - */␊ - secondarybytesIn?: (number | string)␊ - /**␊ - * Gets BytesOut of the peering.␊ - */␊ - secondarybytesOut?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains IPv6 peering config.␊ - */␊ - export interface Ipv6ExpressRouteCircuitPeeringConfig9 {␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig12 | string)␊ - /**␊ - * The reference of the RouteFilter resource.␊ - */␊ - routeFilter?: (SubResource24 | string)␊ - /**␊ - * The state of peering.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains ServiceProviderProperties in an ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitServiceProviderProperties11 {␊ - /**␊ - * The serviceProviderName.␊ - */␊ - serviceProviderName?: string␊ - /**␊ - * The peering location.␊ - */␊ - peeringLocation?: string␊ - /**␊ - * The BandwidthInMbps.␊ - */␊ - bandwidthInMbps?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings␊ - */␊ - export interface ExpressRouteCircuitsPeeringsChildResource11 {␊ - name: string␊ - type: "peerings"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Properties of the express route circuit peering.␊ - */␊ - properties: (ExpressRouteCircuitPeeringPropertiesFormat12 | string)␊ - resources?: ExpressRouteCircuitsPeeringsConnectionsChildResource9[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings/connections␊ - */␊ - export interface ExpressRouteCircuitsPeeringsConnectionsChildResource9 {␊ - name: string␊ - type: "connections"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Properties of the express route circuit connection.␊ - */␊ - properties: (ExpressRouteCircuitConnectionPropertiesFormat9 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the express route circuit connection.␊ - */␊ - export interface ExpressRouteCircuitConnectionPropertiesFormat9 {␊ - /**␊ - * Reference to Express Route Circuit Private Peering Resource of the circuit initiating connection.␊ - */␊ - expressRouteCircuitPeering?: (SubResource24 | string)␊ - /**␊ - * Reference to Express Route Circuit Private Peering Resource of the peered circuit.␊ - */␊ - peerExpressRouteCircuitPeering?: (SubResource24 | string)␊ - /**␊ - * /29 IP address space to carve out Customer addresses for tunnels.␊ - */␊ - addressPrefix?: string␊ - /**␊ - * The authorization key.␊ - */␊ - authorizationKey?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/authorizations␊ - */␊ - export interface ExpressRouteCircuitsAuthorizationsChildResource11 {␊ - name: string␊ - type: "authorizations"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Properties of the express route circuit authorization.␊ - */␊ - properties: (AuthorizationPropertiesFormat12 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/authorizations␊ - */␊ - export interface ExpressRouteCircuitsAuthorizations12 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/authorizations"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Properties of the express route circuit authorization.␊ - */␊ - properties: (AuthorizationPropertiesFormat12 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings␊ - */␊ - export interface ExpressRouteCircuitsPeerings11 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/peerings"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Properties of the express route circuit peering.␊ - */␊ - properties: (ExpressRouteCircuitPeeringPropertiesFormat12 | string)␊ - resources?: ExpressRouteCircuitsPeeringsConnectionsChildResource9[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings/connections␊ - */␊ - export interface ExpressRouteCircuitsPeeringsConnections9 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/peerings/connections"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Properties of the express route circuit connection.␊ - */␊ - properties: (ExpressRouteCircuitConnectionPropertiesFormat9 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections␊ - */␊ - export interface ExpressRouteCrossConnections9 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCrossConnections"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the express route cross connection.␊ - */␊ - properties: (ExpressRouteCrossConnectionProperties9 | string)␊ - resources?: ExpressRouteCrossConnectionsPeeringsChildResource9[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ExpressRouteCrossConnection.␊ - */␊ - export interface ExpressRouteCrossConnectionProperties9 {␊ - /**␊ - * The peering location of the ExpressRoute circuit.␊ - */␊ - peeringLocation?: string␊ - /**␊ - * The circuit bandwidth In Mbps.␊ - */␊ - bandwidthInMbps?: (number | string)␊ - /**␊ - * The ExpressRouteCircuit.␊ - */␊ - expressRouteCircuit?: (SubResource24 | string)␊ - /**␊ - * The provisioning state of the circuit in the connectivity provider system.␊ - */␊ - serviceProviderProvisioningState?: (("NotProvisioned" | "Provisioning" | "Provisioned" | "Deprovisioning") | string)␊ - /**␊ - * Additional read only notes set by the connectivity provider.␊ - */␊ - serviceProviderNotes?: string␊ - /**␊ - * The list of peerings.␊ - */␊ - peerings?: (ExpressRouteCrossConnectionPeering9[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peering in an ExpressRoute Cross Connection resource.␊ - */␊ - export interface ExpressRouteCrossConnectionPeering9 {␊ - /**␊ - * Properties of the express route cross connection peering.␊ - */␊ - properties?: (ExpressRouteCrossConnectionPeeringProperties9 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of express route cross connection peering.␊ - */␊ - export interface ExpressRouteCrossConnectionPeeringProperties9 {␊ - /**␊ - * The peering type.␊ - */␊ - peeringType?: (("AzurePublicPeering" | "AzurePrivatePeering" | "MicrosoftPeering") | string)␊ - /**␊ - * The peering state.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * The peer ASN.␊ - */␊ - peerASN?: (number | string)␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The VLAN ID.␊ - */␊ - vlanId?: (number | string)␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig12 | string)␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - /**␊ - * The IPv6 peering configuration.␊ - */␊ - ipv6PeeringConfig?: (Ipv6ExpressRouteCircuitPeeringConfig9 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections/peerings␊ - */␊ - export interface ExpressRouteCrossConnectionsPeeringsChildResource9 {␊ - name: string␊ - type: "peerings"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Properties of the express route cross connection peering.␊ - */␊ - properties: (ExpressRouteCrossConnectionPeeringProperties9 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections/peerings␊ - */␊ - export interface ExpressRouteCrossConnectionsPeerings8 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCrossConnections/peerings"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Properties of the express route cross connection peering.␊ - */␊ - properties: (ExpressRouteCrossConnectionPeeringProperties9 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteGateways␊ - */␊ - export interface ExpressRouteGateways1 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteGateways"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the express route gateway.␊ - */␊ - properties: (ExpressRouteGatewayProperties1 | string)␊ - resources?: ExpressRouteGatewaysExpressRouteConnectionsChildResource1[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ExpressRoute gateway resource properties.␊ - */␊ - export interface ExpressRouteGatewayProperties1 {␊ - /**␊ - * Configuration for auto scaling.␊ - */␊ - autoScaleConfiguration?: (ExpressRouteGatewayPropertiesAutoScaleConfiguration1 | string)␊ - /**␊ - * The Virtual Hub where the ExpressRoute gateway is or will be deployed.␊ - */␊ - virtualHub: (SubResource24 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Configuration for auto scaling.␊ - */␊ - export interface ExpressRouteGatewayPropertiesAutoScaleConfiguration1 {␊ - /**␊ - * Minimum and maximum number of scale units to deploy.␊ - */␊ - bounds?: (ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Minimum and maximum number of scale units to deploy.␊ - */␊ - export interface ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds1 {␊ - /**␊ - * Minimum number of scale units deployed for ExpressRoute gateway.␊ - */␊ - min?: (number | string)␊ - /**␊ - * Maximum number of scale units deployed for ExpressRoute gateway.␊ - */␊ - max?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteGateways/expressRouteConnections␊ - */␊ - export interface ExpressRouteGatewaysExpressRouteConnectionsChildResource1 {␊ - name: string␊ - type: "expressRouteConnections"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Properties of the express route connection.␊ - */␊ - properties: (ExpressRouteConnectionProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the ExpressRouteConnection subresource.␊ - */␊ - export interface ExpressRouteConnectionProperties1 {␊ - /**␊ - * The ExpressRoute circuit peering.␊ - */␊ - expressRouteCircuitPeering: (SubResource24 | string)␊ - /**␊ - * Authorization key to establish the connection.␊ - */␊ - authorizationKey?: string␊ - /**␊ - * The routing weight associated to the connection.␊ - */␊ - routingWeight?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteGateways/expressRouteConnections␊ - */␊ - export interface ExpressRouteGatewaysExpressRouteConnections1 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteGateways/expressRouteConnections"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Properties of the express route connection.␊ - */␊ - properties: (ExpressRouteConnectionProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ExpressRoutePorts␊ - */␊ - export interface ExpressRoutePorts4 {␊ - name: string␊ - type: "Microsoft.Network/ExpressRoutePorts"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * ExpressRoutePort properties.␊ - */␊ - properties: (ExpressRoutePortPropertiesFormat4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to ExpressRoutePort resources.␊ - */␊ - export interface ExpressRoutePortPropertiesFormat4 {␊ - /**␊ - * The name of the peering location that the ExpressRoutePort is mapped to physically.␊ - */␊ - peeringLocation?: string␊ - /**␊ - * Bandwidth of procured ports in Gbps.␊ - */␊ - bandwidthInGbps?: (number | string)␊ - /**␊ - * Encapsulation method on physical ports.␊ - */␊ - encapsulation?: (("Dot1Q" | "QinQ") | string)␊ - /**␊ - * The set of physical links of the ExpressRoutePort resource.␊ - */␊ - links?: (ExpressRouteLink4[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ExpressRouteLink child resource definition.␊ - */␊ - export interface ExpressRouteLink4 {␊ - /**␊ - * ExpressRouteLink properties.␊ - */␊ - properties?: (ExpressRouteLinkPropertiesFormat4 | string)␊ - /**␊ - * Name of child port resource that is unique among child port resources of the parent.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to ExpressRouteLink resources.␊ - */␊ - export interface ExpressRouteLinkPropertiesFormat4 {␊ - /**␊ - * Administrative state of the physical port.␊ - */␊ - adminState?: (("Enabled" | "Disabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/firewallPolicies␊ - */␊ - export interface FirewallPolicies {␊ - name: string␊ - type: "Microsoft.Network/firewallPolicies"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the firewall policy.␊ - */␊ - properties: (FirewallPolicyPropertiesFormat | string)␊ - resources?: FirewallPoliciesRuleGroupsChildResource[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Firewall Policy definition␊ - */␊ - export interface FirewallPolicyPropertiesFormat {␊ - /**␊ - * The parent firewall policy from which rules are inherited.␊ - */␊ - basePolicy?: (SubResource24 | string)␊ - /**␊ - * The operation mode for Threat Intelligence.␊ - */␊ - threatIntelMode?: (("Alert" | "Deny" | "Off") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/firewallPolicies/ruleGroups␊ - */␊ - export interface FirewallPoliciesRuleGroupsChildResource {␊ - name: string␊ - type: "ruleGroups"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * The properties of the firewall policy rule group.␊ - */␊ - properties: (FirewallPolicyRuleGroupProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the rule group.␊ - */␊ - export interface FirewallPolicyRuleGroupProperties {␊ - /**␊ - * Priority of the Firewall Policy Rule Group resource.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * Group of Firewall Policy rules.␊ - */␊ - rules?: (FirewallPolicyRule[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the FirewallPolicyNatRuleAction.␊ - */␊ - export interface FirewallPolicyNatRuleAction {␊ - /**␊ - * The type of action.␊ - */␊ - type?: ("DNAT" | "SNAT")␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application rule protocol.␊ - */␊ - export interface FirewallPolicyRuleConditionApplicationProtocol {␊ - /**␊ - * Protocol type.␊ - */␊ - protocolType?: (("Http" | "Https") | string)␊ - /**␊ - * Port number for the protocol, cannot be greater than 64000.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the FirewallPolicyFilterRuleAction.␊ - */␊ - export interface FirewallPolicyFilterRuleAction {␊ - /**␊ - * The type of action.␊ - */␊ - type?: ("Allow" | "Deny" | "Alert ")␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/firewallPolicies/ruleGroups␊ - */␊ - export interface FirewallPoliciesRuleGroups {␊ - name: string␊ - type: "Microsoft.Network/firewallPolicies/ruleGroups"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * The properties of the firewall policy rule group.␊ - */␊ - properties: (FirewallPolicyRuleGroupProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers␊ - */␊ - export interface LoadBalancers26 {␊ - name: string␊ - type: "Microsoft.Network/loadBalancers"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The load balancer SKU.␊ - */␊ - sku?: (LoadBalancerSku14 | string)␊ - /**␊ - * Properties of load balancer.␊ - */␊ - properties: (LoadBalancerPropertiesFormat18 | string)␊ - resources?: LoadBalancersInboundNatRulesChildResource14[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a load balancer.␊ - */␊ - export interface LoadBalancerSku14 {␊ - /**␊ - * Name of a load balancer SKU.␊ - */␊ - name?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer.␊ - */␊ - export interface LoadBalancerPropertiesFormat18 {␊ - /**␊ - * Object representing the frontend IPs to be used for the load balancer.␊ - */␊ - frontendIPConfigurations?: (FrontendIPConfiguration17[] | string)␊ - /**␊ - * Collection of backend address pools used by a load balancer.␊ - */␊ - backendAddressPools?: (BackendAddressPool18[] | string)␊ - /**␊ - * Object collection representing the load balancing rules Gets the provisioning.␊ - */␊ - loadBalancingRules?: (LoadBalancingRule18[] | string)␊ - /**␊ - * Collection of probe objects used in the load balancer.␊ - */␊ - probes?: (Probe18[] | string)␊ - /**␊ - * Collection of inbound NAT Rules used by a load balancer. Defining inbound NAT rules on your load balancer is mutually exclusive with defining an inbound NAT pool. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an Inbound NAT pool. They have to reference individual inbound NAT rules.␊ - */␊ - inboundNatRules?: (InboundNatRule19[] | string)␊ - /**␊ - * Defines an external port range for inbound NAT to a single backend port on NICs associated with a load balancer. Inbound NAT rules are created automatically for each NIC associated with the Load Balancer using an external port from this range. Defining an Inbound NAT pool on your Load Balancer is mutually exclusive with defining inbound Nat rules. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an inbound NAT pool. They have to reference individual inbound NAT rules.␊ - */␊ - inboundNatPools?: (InboundNatPool19[] | string)␊ - /**␊ - * The outbound rules.␊ - */␊ - outboundRules?: (OutboundRule6[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP address of the load balancer.␊ - */␊ - export interface FrontendIPConfiguration17 {␊ - /**␊ - * Properties of the load balancer probe.␊ - */␊ - properties?: (FrontendIPConfigurationPropertiesFormat17 | string)␊ - /**␊ - * The name of the resource that is unique within the set of frontend IP configurations used by the load balancer. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP Configuration of the load balancer.␊ - */␊ - export interface FrontendIPConfigurationPropertiesFormat17 {␊ - /**␊ - * The private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The Private IP allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * It represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4.␊ - */␊ - privateIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The reference of the subnet resource.␊ - */␊ - subnet?: (SubResource24 | string)␊ - /**␊ - * The reference of the Public IP resource.␊ - */␊ - publicIPAddress?: (SubResource24 | string)␊ - /**␊ - * The reference of the Public IP Prefix resource.␊ - */␊ - publicIPPrefix?: (SubResource24 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Pool of backend IP addresses.␊ - */␊ - export interface BackendAddressPool18 {␊ - /**␊ - * Properties of load balancer backend address pool.␊ - */␊ - properties?: (BackendAddressPoolPropertiesFormat18 | string)␊ - /**␊ - * Gets name of the resource that is unique within the set of backend address pools used by the load balancer. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the backend address pool.␊ - */␊ - export interface BackendAddressPoolPropertiesFormat18 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A load balancing rule for a load balancer.␊ - */␊ - export interface LoadBalancingRule18 {␊ - /**␊ - * Properties of load balancer load balancing rule.␊ - */␊ - properties?: (LoadBalancingRulePropertiesFormat18 | string)␊ - /**␊ - * The name of the resource that is unique within the set of load balancing rules used by the load balancer. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer.␊ - */␊ - export interface LoadBalancingRulePropertiesFormat18 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource24 | string)␊ - /**␊ - * A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs.␊ - */␊ - backendAddressPool?: (SubResource24 | string)␊ - /**␊ - * The reference of the load balancer probe used by the load balancing rule.␊ - */␊ - probe?: (SubResource24 | string)␊ - /**␊ - * The reference to the transport protocol used by the load balancing rule.␊ - */␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The load distribution policy for this rule.␊ - */␊ - loadDistribution?: (("Default" | "SourceIP" | "SourceIPProtocol") | string)␊ - /**␊ - * The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 0 and 65534. Note that value 0 enables "Any Port".␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port".␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - /**␊ - * Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule.␊ - */␊ - disableOutboundSnat?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A load balancer probe.␊ - */␊ - export interface Probe18 {␊ - /**␊ - * Properties of load balancer probe.␊ - */␊ - properties?: (ProbePropertiesFormat18 | string)␊ - /**␊ - * Gets name of the resource that is unique within the set of probes used by the load balancer. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Load balancer probe resource.␊ - */␊ - export interface ProbePropertiesFormat18 {␊ - /**␊ - * The protocol of the end point. If 'Tcp' is specified, a received ACK is required for the probe to be successful. If 'Http' or 'Https' is specified, a 200 OK response from the specifies URI is required for the probe to be successful.␊ - */␊ - protocol: (("Http" | "Tcp" | "Https") | string)␊ - /**␊ - * The port for communicating the probe. Possible values range from 1 to 65535, inclusive.␊ - */␊ - port: (number | string)␊ - /**␊ - * The interval, in seconds, for how frequently to probe the endpoint for health status. Typically, the interval is slightly less than half the allocated timeout period (in seconds) which allows two full probes before taking the instance out of rotation. The default value is 15, the minimum value is 5.␊ - */␊ - intervalInSeconds?: (number | string)␊ - /**␊ - * The number of probes where if no response, will result in stopping further traffic from being delivered to the endpoint. This values allows endpoints to be taken out of rotation faster or slower than the typical times used in Azure.␊ - */␊ - numberOfProbes: (number | string)␊ - /**␊ - * The URI used for requesting health status from the VM. Path is required if a protocol is set to http. Otherwise, it is not allowed. There is no default value.␊ - */␊ - requestPath?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT rule of the load balancer.␊ - */␊ - export interface InboundNatRule19 {␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties?: (InboundNatRulePropertiesFormat18 | string)␊ - /**␊ - * Gets name of the resource that is unique within the set of inbound NAT rules used by the load balancer. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the inbound NAT rule.␊ - */␊ - export interface InboundNatRulePropertiesFormat18 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource24 | string)␊ - /**␊ - * The reference to the transport protocol used by the load balancing rule.␊ - */␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values range from 1 to 65534.␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * The port used for the internal endpoint. Acceptable values range from 1 to 65535.␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT pool of the load balancer.␊ - */␊ - export interface InboundNatPool19 {␊ - /**␊ - * Properties of load balancer inbound nat pool.␊ - */␊ - properties?: (InboundNatPoolPropertiesFormat18 | string)␊ - /**␊ - * The name of the resource that is unique within the set of inbound NAT pools used by the load balancer. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Inbound NAT pool.␊ - */␊ - export interface InboundNatPoolPropertiesFormat18 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource24 | string)␊ - /**␊ - * The reference to the transport protocol used by the inbound NAT pool.␊ - */␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65534.␊ - */␊ - frontendPortRangeStart: (number | string)␊ - /**␊ - * The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65535.␊ - */␊ - frontendPortRangeEnd: (number | string)␊ - /**␊ - * The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound rule of the load balancer.␊ - */␊ - export interface OutboundRule6 {␊ - /**␊ - * Properties of load balancer outbound rule.␊ - */␊ - properties?: (OutboundRulePropertiesFormat6 | string)␊ - /**␊ - * The name of the resource that is unique within the set of outbound rules used by the load balancer. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound rule of the load balancer.␊ - */␊ - export interface OutboundRulePropertiesFormat6 {␊ - /**␊ - * The number of outbound ports to be used for NAT.␊ - */␊ - allocatedOutboundPorts?: (number | string)␊ - /**␊ - * The Frontend IP addresses of the load balancer.␊ - */␊ - frontendIPConfigurations: (SubResource24[] | string)␊ - /**␊ - * A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs.␊ - */␊ - backendAddressPool: (SubResource24 | string)␊ - /**␊ - * The protocol for the outbound rule in load balancer.␊ - */␊ - protocol: (("Tcp" | "Udp" | "All") | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - /**␊ - * The timeout for the TCP idle connection.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers/inboundNatRules␊ - */␊ - export interface LoadBalancersInboundNatRulesChildResource14 {␊ - name: string␊ - type: "inboundNatRules"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties: (InboundNatRulePropertiesFormat18 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers/inboundNatRules␊ - */␊ - export interface LoadBalancersInboundNatRules13 {␊ - name: string␊ - type: "Microsoft.Network/loadBalancers/inboundNatRules"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties: (InboundNatRulePropertiesFormat18 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/localNetworkGateways␊ - */␊ - export interface LocalNetworkGateways14 {␊ - name: string␊ - type: "Microsoft.Network/localNetworkGateways"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the local network gateway.␊ - */␊ - properties: (LocalNetworkGatewayPropertiesFormat14 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * LocalNetworkGateway properties.␊ - */␊ - export interface LocalNetworkGatewayPropertiesFormat14 {␊ - /**␊ - * Local network site address space.␊ - */␊ - localNetworkAddressSpace?: (AddressSpace26 | string)␊ - /**␊ - * IP address of local network gateway.␊ - */␊ - gatewayIpAddress?: string␊ - /**␊ - * Local network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings13 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.␊ - */␊ - export interface AddressSpace26 {␊ - /**␊ - * A list of address blocks reserved for this virtual network in CIDR notation.␊ - */␊ - addressPrefixes: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * BGP settings details.␊ - */␊ - export interface BgpSettings13 {␊ - /**␊ - * The BGP speaker's ASN.␊ - */␊ - asn?: (number | string)␊ - /**␊ - * The BGP peering address and BGP identifier of this BGP speaker.␊ - */␊ - bgpPeeringAddress?: string␊ - /**␊ - * The weight added to routes learned from this BGP speaker.␊ - */␊ - peerWeight?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/natGateways␊ - */␊ - export interface NatGateways1 {␊ - name: string␊ - type: "Microsoft.Network/natGateways"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The nat gateway SKU.␊ - */␊ - sku?: (NatGatewaySku1 | string)␊ - /**␊ - * Nat Gateway properties.␊ - */␊ - properties: (NatGatewayPropertiesFormat1 | string)␊ - /**␊ - * A list of availability zones denoting the zone in which Nat Gateway should be deployed.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of nat gateway.␊ - */␊ - export interface NatGatewaySku1 {␊ - /**␊ - * Name of Nat Gateway SKU.␊ - */␊ - name?: ("Standard" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Nat Gateway properties.␊ - */␊ - export interface NatGatewayPropertiesFormat1 {␊ - /**␊ - * The idle timeout of the nat gateway.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * An array of public ip addresses associated with the nat gateway resource.␊ - */␊ - publicIpAddresses?: (SubResource24[] | string)␊ - /**␊ - * An array of public ip prefixes associated with the nat gateway resource.␊ - */␊ - publicIpPrefixes?: (SubResource24[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces␊ - */␊ - export interface NetworkInterfaces27 {␊ - name: string␊ - type: "Microsoft.Network/networkInterfaces"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network interface.␊ - */␊ - properties: (NetworkInterfacePropertiesFormat18 | string)␊ - resources?: NetworkInterfacesTapConfigurationsChildResource5[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NetworkInterface properties.␊ - */␊ - export interface NetworkInterfacePropertiesFormat18 {␊ - /**␊ - * The reference of the NetworkSecurityGroup resource.␊ - */␊ - networkSecurityGroup?: (SubResource24 | string)␊ - /**␊ - * A list of IPConfigurations of the network interface.␊ - */␊ - ipConfigurations: (NetworkInterfaceIPConfiguration17[] | string)␊ - /**␊ - * The DNS settings in network interface.␊ - */␊ - dnsSettings?: (NetworkInterfaceDnsSettings26 | string)␊ - /**␊ - * If the network interface is accelerated networking enabled.␊ - */␊ - enableAcceleratedNetworking?: (boolean | string)␊ - /**␊ - * Indicates whether IP forwarding is enabled on this network interface.␊ - */␊ - enableIPForwarding?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IPConfiguration in a network interface.␊ - */␊ - export interface NetworkInterfaceIPConfiguration17 {␊ - /**␊ - * Network interface IP configuration properties.␊ - */␊ - properties?: (NetworkInterfaceIPConfigurationPropertiesFormat17 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration.␊ - */␊ - export interface NetworkInterfaceIPConfigurationPropertiesFormat17 {␊ - /**␊ - * The reference to Virtual Network Taps.␊ - */␊ - virtualNetworkTaps?: (SubResource24[] | string)␊ - /**␊ - * The reference of ApplicationGatewayBackendAddressPool resource.␊ - */␊ - applicationGatewayBackendAddressPools?: (SubResource24[] | string)␊ - /**␊ - * The reference of LoadBalancerBackendAddressPool resource.␊ - */␊ - loadBalancerBackendAddressPools?: (SubResource24[] | string)␊ - /**␊ - * A list of references of LoadBalancerInboundNatRules.␊ - */␊ - loadBalancerInboundNatRules?: (SubResource24[] | string)␊ - /**␊ - * Private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The private IP address allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Available from Api-Version 2016-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4.␊ - */␊ - privateIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * Subnet bound to the IP configuration.␊ - */␊ - subnet?: (SubResource24 | string)␊ - /**␊ - * Gets whether this is a primary customer address on the network interface.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * Public IP address bound to the IP configuration.␊ - */␊ - publicIPAddress?: (SubResource24 | string)␊ - /**␊ - * Application security groups in which the IP configuration is included.␊ - */␊ - applicationSecurityGroups?: (SubResource24[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DNS settings of a network interface.␊ - */␊ - export interface NetworkInterfaceDnsSettings26 {␊ - /**␊ - * List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only value in dnsServers collection.␊ - */␊ - dnsServers?: (string[] | string)␊ - /**␊ - * Relative DNS name for this NIC used for internal communications between VMs in the same virtual network.␊ - */␊ - internalDnsNameLabel?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces/tapConfigurations␊ - */␊ - export interface NetworkInterfacesTapConfigurationsChildResource5 {␊ - name: string␊ - type: "tapConfigurations"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Properties of the Virtual Network Tap configuration.␊ - */␊ - properties: (NetworkInterfaceTapConfigurationPropertiesFormat5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Virtual Network Tap configuration.␊ - */␊ - export interface NetworkInterfaceTapConfigurationPropertiesFormat5 {␊ - /**␊ - * The reference of the Virtual Network Tap resource.␊ - */␊ - virtualNetworkTap?: (SubResource24 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces/tapConfigurations␊ - */␊ - export interface NetworkInterfacesTapConfigurations4 {␊ - name: string␊ - type: "Microsoft.Network/networkInterfaces/tapConfigurations"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Properties of the Virtual Network Tap configuration.␊ - */␊ - properties: (NetworkInterfaceTapConfigurationPropertiesFormat5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkProfiles␊ - */␊ - export interface NetworkProfiles1 {␊ - name: string␊ - type: "Microsoft.Network/networkProfiles"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Network profile properties.␊ - */␊ - properties: (NetworkProfilePropertiesFormat1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network profile properties.␊ - */␊ - export interface NetworkProfilePropertiesFormat1 {␊ - /**␊ - * List of chid container network interface configurations.␊ - */␊ - containerNetworkInterfaceConfigurations?: (ContainerNetworkInterfaceConfiguration1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Container network interface configuration child resource.␊ - */␊ - export interface ContainerNetworkInterfaceConfiguration1 {␊ - /**␊ - * Container network interface configuration properties.␊ - */␊ - properties?: (ContainerNetworkInterfaceConfigurationPropertiesFormat1 | string)␊ - /**␊ - * The name of the resource. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Container network interface configuration properties.␊ - */␊ - export interface ContainerNetworkInterfaceConfigurationPropertiesFormat1 {␊ - /**␊ - * A list of ip configurations of the container network interface configuration.␊ - */␊ - ipConfigurations?: (IPConfigurationProfile1[] | string)␊ - /**␊ - * A list of container network interfaces created from this container network interface configuration.␊ - */␊ - containerNetworkInterfaces?: (SubResource24[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration profile child resource.␊ - */␊ - export interface IPConfigurationProfile1 {␊ - /**␊ - * Properties of the IP configuration profile.␊ - */␊ - properties?: (IPConfigurationProfilePropertiesFormat1 | string)␊ - /**␊ - * The name of the resource. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration profile properties.␊ - */␊ - export interface IPConfigurationProfilePropertiesFormat1 {␊ - /**␊ - * The reference of the subnet resource to create a container network interface ip configuration.␊ - */␊ - subnet?: (SubResource24 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups␊ - */␊ - export interface NetworkSecurityGroups26 {␊ - name: string␊ - type: "Microsoft.Network/networkSecurityGroups"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network security group.␊ - */␊ - properties: (NetworkSecurityGroupPropertiesFormat18 | string)␊ - resources?: NetworkSecurityGroupsSecurityRulesChildResource18[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network Security Group resource.␊ - */␊ - export interface NetworkSecurityGroupPropertiesFormat18 {␊ - /**␊ - * A collection of security rules of the network security group.␊ - */␊ - securityRules?: (SecurityRule18[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network security rule.␊ - */␊ - export interface SecurityRule18 {␊ - /**␊ - * Properties of the security rule.␊ - */␊ - properties?: (SecurityRulePropertiesFormat18 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Security rule resource.␊ - */␊ - export interface SecurityRulePropertiesFormat18 {␊ - /**␊ - * A description for this rule. Restricted to 140 chars.␊ - */␊ - description?: string␊ - /**␊ - * Network protocol this rule applies to.␊ - */␊ - protocol: (("Tcp" | "Udp" | "Icmp" | "Esp" | "*") | string)␊ - /**␊ - * The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.␊ - */␊ - sourcePortRange?: string␊ - /**␊ - * The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.␊ - */␊ - destinationPortRange?: string␊ - /**␊ - * The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from.␊ - */␊ - sourceAddressPrefix?: string␊ - /**␊ - * The CIDR or source IP ranges.␊ - */␊ - sourceAddressPrefixes?: (string[] | string)␊ - /**␊ - * The application security group specified as source.␊ - */␊ - sourceApplicationSecurityGroups?: (SubResource24[] | string)␊ - /**␊ - * The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used.␊ - */␊ - destinationAddressPrefix?: string␊ - /**␊ - * The destination address prefixes. CIDR or destination IP ranges.␊ - */␊ - destinationAddressPrefixes?: (string[] | string)␊ - /**␊ - * The application security group specified as destination.␊ - */␊ - destinationApplicationSecurityGroups?: (SubResource24[] | string)␊ - /**␊ - * The source port ranges.␊ - */␊ - sourcePortRanges?: (string[] | string)␊ - /**␊ - * The destination port ranges.␊ - */␊ - destinationPortRanges?: (string[] | string)␊ - /**␊ - * The network traffic is allowed or denied.␊ - */␊ - access: (("Allow" | "Deny") | string)␊ - /**␊ - * The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.␊ - */␊ - priority: (number | string)␊ - /**␊ - * The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic.␊ - */␊ - direction: (("Inbound" | "Outbound") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRulesChildResource18 {␊ - name: string␊ - type: "securityRules"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Properties of the security rule.␊ - */␊ - properties: (SecurityRulePropertiesFormat18 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRules17 {␊ - name: string␊ - type: "Microsoft.Network/networkSecurityGroups/securityRules"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Properties of the security rule.␊ - */␊ - properties: (SecurityRulePropertiesFormat18 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers␊ - */␊ - export interface NetworkWatchers4 {␊ - name: string␊ - type: "Microsoft.Network/networkWatchers"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network watcher.␊ - */␊ - properties: (NetworkWatcherPropertiesFormat1 | string)␊ - resources?: (NetworkWatchersConnectionMonitorsChildResource4 | NetworkWatchersPacketCapturesChildResource4)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The network watcher properties.␊ - */␊ - export interface NetworkWatcherPropertiesFormat1 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/connectionMonitors␊ - */␊ - export interface NetworkWatchersConnectionMonitorsChildResource4 {␊ - name: string␊ - type: "connectionMonitors"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Connection monitor location.␊ - */␊ - location?: string␊ - /**␊ - * Connection monitor tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the connection monitor.␊ - */␊ - properties: (ConnectionMonitorParameters4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters that define the operation to create a connection monitor.␊ - */␊ - export interface ConnectionMonitorParameters4 {␊ - /**␊ - * Describes the source of connection monitor.␊ - */␊ - source: (ConnectionMonitorSource4 | string)␊ - /**␊ - * Describes the destination of connection monitor.␊ - */␊ - destination: (ConnectionMonitorDestination4 | string)␊ - /**␊ - * Determines if the connection monitor will start automatically once created.␊ - */␊ - autoStart?: (boolean | string)␊ - /**␊ - * Monitoring interval in seconds.␊ - */␊ - monitoringIntervalInSeconds?: ((number & string) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the source of connection monitor.␊ - */␊ - export interface ConnectionMonitorSource4 {␊ - /**␊ - * The ID of the resource used as the source by connection monitor.␊ - */␊ - resourceId: string␊ - /**␊ - * The source port used by connection monitor.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the destination of connection monitor.␊ - */␊ - export interface ConnectionMonitorDestination4 {␊ - /**␊ - * The ID of the resource used as the destination by connection monitor.␊ - */␊ - resourceId?: string␊ - /**␊ - * Address of the connection monitor destination (IP or domain name).␊ - */␊ - address?: string␊ - /**␊ - * The destination port used by connection monitor.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/packetCaptures␊ - */␊ - export interface NetworkWatchersPacketCapturesChildResource4 {␊ - name: string␊ - type: "packetCaptures"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Properties of the packet capture.␊ - */␊ - properties: (PacketCaptureParameters4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters that define the create packet capture operation.␊ - */␊ - export interface PacketCaptureParameters4 {␊ - /**␊ - * The ID of the targeted resource, only VM is currently supported.␊ - */␊ - target: string␊ - /**␊ - * Number of bytes captured per packet, the remaining bytes are truncated.␊ - */␊ - bytesToCapturePerPacket?: ((number & string) | string)␊ - /**␊ - * Maximum size of the capture output.␊ - */␊ - totalBytesPerSession?: ((number & string) | string)␊ - /**␊ - * Maximum duration of the capture session in seconds.␊ - */␊ - timeLimitInSeconds?: ((number & string) | string)␊ - /**␊ - * Describes the storage location for a packet capture session.␊ - */␊ - storageLocation: (PacketCaptureStorageLocation4 | string)␊ - /**␊ - * A list of packet capture filters.␊ - */␊ - filters?: (PacketCaptureFilter4[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the storage location for a packet capture session.␊ - */␊ - export interface PacketCaptureStorageLocation4 {␊ - /**␊ - * The ID of the storage account to save the packet capture session. Required if no local file path is provided.␊ - */␊ - storageId?: string␊ - /**␊ - * The URI of the storage path to save the packet capture. Must be a well-formed URI describing the location to save the packet capture.␊ - */␊ - storagePath?: string␊ - /**␊ - * A valid local path on the targeting VM. Must include the name of the capture file (*.cap). For linux virtual machine it must start with /var/captures. Required if no storage ID is provided, otherwise optional.␊ - */␊ - filePath?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Filter that is applied to packet capture request. Multiple filters can be applied.␊ - */␊ - export interface PacketCaptureFilter4 {␊ - /**␊ - * Protocol to be filtered on.␊ - */␊ - protocol?: (("TCP" | "UDP" | "Any") | string)␊ - /**␊ - * Local IP Address to be filtered on. Notation: "127.0.0.1" for single address entry. "127.0.0.1-127.0.0.255" for range. "127.0.0.1;127.0.0.5"? for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.␊ - */␊ - localIPAddress?: string␊ - /**␊ - * Local IP Address to be filtered on. Notation: "127.0.0.1" for single address entry. "127.0.0.1-127.0.0.255" for range. "127.0.0.1;127.0.0.5;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.␊ - */␊ - remoteIPAddress?: string␊ - /**␊ - * Local port to be filtered on. Notation: "80" for single port entry."80-85" for range. "80;443;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.␊ - */␊ - localPort?: string␊ - /**␊ - * Remote port to be filtered on. Notation: "80" for single port entry."80-85" for range. "80;443;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.␊ - */␊ - remotePort?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/connectionMonitors␊ - */␊ - export interface NetworkWatchersConnectionMonitors4 {␊ - name: string␊ - type: "Microsoft.Network/networkWatchers/connectionMonitors"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Connection monitor location.␊ - */␊ - location?: string␊ - /**␊ - * Connection monitor tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the connection monitor.␊ - */␊ - properties: (ConnectionMonitorParameters4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/packetCaptures␊ - */␊ - export interface NetworkWatchersPacketCaptures4 {␊ - name: string␊ - type: "Microsoft.Network/networkWatchers/packetCaptures"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Properties of the packet capture.␊ - */␊ - properties: (PacketCaptureParameters4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/p2svpnGateways␊ - */␊ - export interface P2SvpnGateways1 {␊ - name: string␊ - type: "Microsoft.Network/p2svpnGateways"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the P2SVpnGateway.␊ - */␊ - properties: (P2SVpnGatewayProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for P2SVpnGateway.␊ - */␊ - export interface P2SVpnGatewayProperties1 {␊ - /**␊ - * The VirtualHub to which the gateway belongs.␊ - */␊ - virtualHub?: (SubResource24 | string)␊ - /**␊ - * The scale unit for this p2s vpn gateway.␊ - */␊ - vpnGatewayScaleUnit?: (number | string)␊ - /**␊ - * The P2SVpnServerConfiguration to which the p2sVpnGateway is attached to.␊ - */␊ - p2SVpnServerConfiguration?: (SubResource24 | string)␊ - /**␊ - * The reference of the address space resource which represents Address space for P2S VpnClient.␊ - */␊ - vpnClientAddressPool?: (AddressSpace26 | string)␊ - /**␊ - * The reference of the address space resource which represents the custom routes specified by the customer for P2SVpnGateway and P2S VpnClient.␊ - */␊ - customRoutes?: (AddressSpace26 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateEndpoints␊ - */␊ - export interface PrivateEndpoints1 {␊ - name: string␊ - type: "Microsoft.Network/privateEndpoints"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the private endpoint.␊ - */␊ - properties: (PrivateEndpointProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the private endpoint.␊ - */␊ - export interface PrivateEndpointProperties1 {␊ - /**␊ - * The ID of the subnet from which the private IP will be allocated.␊ - */␊ - subnet?: (SubResource24 | string)␊ - /**␊ - * A grouping of information about the connection to the remote resource.␊ - */␊ - privateLinkServiceConnections?: (PrivateLinkServiceConnection1[] | string)␊ - /**␊ - * A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource.␊ - */␊ - manualPrivateLinkServiceConnections?: (PrivateLinkServiceConnection1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * PrivateLinkServiceConnection resource.␊ - */␊ - export interface PrivateLinkServiceConnection1 {␊ - /**␊ - * Properties of the private link service connection.␊ - */␊ - properties?: (PrivateLinkServiceConnectionProperties1 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the PrivateLinkServiceConnection.␊ - */␊ - export interface PrivateLinkServiceConnectionProperties1 {␊ - /**␊ - * The resource id of private link service.␊ - */␊ - privateLinkServiceId?: string␊ - /**␊ - * The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to.␊ - */␊ - groupIds?: (string[] | string)␊ - /**␊ - * A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars.␊ - */␊ - requestMessage?: string␊ - /**␊ - * A collection of read-only information about the state of the connection to the remote resource.␊ - */␊ - privateLinkServiceConnectionState?: (PrivateLinkServiceConnectionState7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A collection of information about the state of the connection between service consumer and provider.␊ - */␊ - export interface PrivateLinkServiceConnectionState7 {␊ - /**␊ - * Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.␊ - */␊ - status?: string␊ - /**␊ - * The reason for approval/rejection of the connection.␊ - */␊ - description?: string␊ - /**␊ - * A message indicating if changes on the service provider require any updates on the consumer.␊ - */␊ - actionRequired?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateLinkServices␊ - */␊ - export interface PrivateLinkServices1 {␊ - name: string␊ - type: "Microsoft.Network/privateLinkServices"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the private link service.␊ - */␊ - properties: (PrivateLinkServiceProperties1 | string)␊ - resources?: PrivateLinkServicesPrivateEndpointConnectionsChildResource1[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the private link service.␊ - */␊ - export interface PrivateLinkServiceProperties1 {␊ - /**␊ - * An array of references to the load balancer IP configurations.␊ - */␊ - loadBalancerFrontendIpConfigurations?: (SubResource24[] | string)␊ - /**␊ - * An array of references to the private link service IP configuration.␊ - */␊ - ipConfigurations?: (PrivateLinkServiceIpConfiguration1[] | string)␊ - /**␊ - * The visibility list of the private link service.␊ - */␊ - visibility?: (PrivateLinkServicePropertiesVisibility1 | string)␊ - /**␊ - * The auto-approval list of the private link service.␊ - */␊ - autoApproval?: (PrivateLinkServicePropertiesAutoApproval1 | string)␊ - /**␊ - * The list of Fqdn.␊ - */␊ - fqdns?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The private link service ip configuration.␊ - */␊ - export interface PrivateLinkServiceIpConfiguration1 {␊ - /**␊ - * Properties of the private link service ip configuration.␊ - */␊ - properties?: (PrivateLinkServiceIpConfigurationProperties1 | string)␊ - /**␊ - * The name of private link service ip configuration.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of private link service IP configuration.␊ - */␊ - export interface PrivateLinkServiceIpConfigurationProperties1 {␊ - /**␊ - * The private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The private IP address allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * The reference of the subnet resource.␊ - */␊ - subnet?: (SubResource24 | string)␊ - /**␊ - * Whether the ip configuration is primary or not.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * Available from Api-Version 2016-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4.␊ - */␊ - privateIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The visibility list of the private link service.␊ - */␊ - export interface PrivateLinkServicePropertiesVisibility1 {␊ - /**␊ - * The list of subscriptions.␊ - */␊ - subscriptions?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The auto-approval list of the private link service.␊ - */␊ - export interface PrivateLinkServicePropertiesAutoApproval1 {␊ - /**␊ - * The list of subscriptions.␊ - */␊ - subscriptions?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateLinkServices/privateEndpointConnections␊ - */␊ - export interface PrivateLinkServicesPrivateEndpointConnectionsChildResource1 {␊ - name: string␊ - type: "privateEndpointConnections"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Properties of the private end point connection.␊ - */␊ - properties: (PrivateEndpointConnectionProperties8 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the PrivateEndpointConnectProperties.␊ - */␊ - export interface PrivateEndpointConnectionProperties8 {␊ - /**␊ - * A collection of information about the state of the connection between service consumer and provider.␊ - */␊ - privateLinkServiceConnectionState?: (PrivateLinkServiceConnectionState7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateLinkServices/privateEndpointConnections␊ - */␊ - export interface PrivateLinkServicesPrivateEndpointConnections1 {␊ - name: string␊ - type: "Microsoft.Network/privateLinkServices/privateEndpointConnections"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Properties of the private end point connection.␊ - */␊ - properties: (PrivateEndpointConnectionProperties8 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/publicIPAddresses␊ - */␊ - export interface PublicIPAddresses26 {␊ - name: string␊ - type: "Microsoft.Network/publicIPAddresses"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The public IP address SKU.␊ - */␊ - sku?: (PublicIPAddressSku14 | string)␊ - /**␊ - * Public IP address properties.␊ - */␊ - properties: (PublicIPAddressPropertiesFormat17 | string)␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a public IP address.␊ - */␊ - export interface PublicIPAddressSku14 {␊ - /**␊ - * Name of a public IP address SKU.␊ - */␊ - name?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Public IP address properties.␊ - */␊ - export interface PublicIPAddressPropertiesFormat17 {␊ - /**␊ - * The public IP address allocation method.␊ - */␊ - publicIPAllocationMethod: (("Static" | "Dynamic") | string)␊ - /**␊ - * The public IP address version.␊ - */␊ - publicIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The FQDN of the DNS record associated with the public IP address.␊ - */␊ - dnsSettings?: (PublicIPAddressDnsSettings25 | string)␊ - /**␊ - * The DDoS protection custom policy associated with the public IP address.␊ - */␊ - ddosSettings?: (DdosSettings3 | string)␊ - /**␊ - * The list of tags associated with the public IP address.␊ - */␊ - ipTags?: (IpTag11[] | string)␊ - /**␊ - * The IP address associated with the public IP address resource.␊ - */␊ - ipAddress?: string␊ - /**␊ - * The Public IP Prefix this Public IP Address should be allocated from.␊ - */␊ - publicIPPrefix?: (SubResource24 | string)␊ - /**␊ - * The idle timeout of the public IP address.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains FQDN of the DNS record associated with the public IP address.␊ - */␊ - export interface PublicIPAddressDnsSettings25 {␊ - /**␊ - * Gets or sets the Domain name label.The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.␊ - */␊ - domainNameLabel: string␊ - /**␊ - * Gets the FQDN, Fully qualified domain name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone.␊ - */␊ - fqdn?: string␊ - /**␊ - * Gets or Sets the Reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN.␊ - */␊ - reverseFqdn?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains the DDoS protection settings of the public IP.␊ - */␊ - export interface DdosSettings3 {␊ - /**␊ - * The DDoS custom policy associated with the public IP.␊ - */␊ - ddosCustomPolicy?: (SubResource24 | string)␊ - /**␊ - * The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized.␊ - */␊ - protectionCoverage?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains the IpTag associated with the object.␊ - */␊ - export interface IpTag11 {␊ - /**␊ - * Gets or sets the ipTag type: Example FirstPartyUsage.␊ - */␊ - ipTagType?: string␊ - /**␊ - * Gets or sets value of the IpTag associated with the public IP. Example SQL, Storage etc.␊ - */␊ - tag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/publicIPPrefixes␊ - */␊ - export interface PublicIPPrefixes2 {␊ - name: string␊ - type: "Microsoft.Network/publicIPPrefixes"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The public IP prefix SKU.␊ - */␊ - sku?: (PublicIPPrefixSku2 | string)␊ - /**␊ - * Public IP prefix properties.␊ - */␊ - properties: (PublicIPPrefixPropertiesFormat2 | string)␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a public IP prefix.␊ - */␊ - export interface PublicIPPrefixSku2 {␊ - /**␊ - * Name of a public IP prefix SKU.␊ - */␊ - name?: ("Standard" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Public IP prefix properties.␊ - */␊ - export interface PublicIPPrefixPropertiesFormat2 {␊ - /**␊ - * The public IP address version.␊ - */␊ - publicIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The list of tags associated with the public IP prefix.␊ - */␊ - ipTags?: (IpTag11[] | string)␊ - /**␊ - * The Length of the Public IP Prefix.␊ - */␊ - prefixLength?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeFilters␊ - */␊ - export interface RouteFilters4 {␊ - name: string␊ - type: "Microsoft.Network/routeFilters"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the route filter.␊ - */␊ - properties: (RouteFilterPropertiesFormat4 | string)␊ - resources?: RouteFiltersRouteFilterRulesChildResource4[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Filter Resource.␊ - */␊ - export interface RouteFilterPropertiesFormat4 {␊ - /**␊ - * Collection of RouteFilterRules contained within a route filter.␊ - */␊ - rules?: (RouteFilterRule4[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Filter Rule Resource.␊ - */␊ - export interface RouteFilterRule4 {␊ - /**␊ - * Properties of the route filter rule.␊ - */␊ - properties?: (RouteFilterRulePropertiesFormat4 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Filter Rule Resource.␊ - */␊ - export interface RouteFilterRulePropertiesFormat4 {␊ - /**␊ - * The access type of the rule.␊ - */␊ - access: (("Allow" | "Deny") | string)␊ - /**␊ - * The rule type of the rule.␊ - */␊ - routeFilterRuleType: ("Community" | string)␊ - /**␊ - * The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'].␊ - */␊ - communities: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeFilters/routeFilterRules␊ - */␊ - export interface RouteFiltersRouteFilterRulesChildResource4 {␊ - name: string␊ - type: "routeFilterRules"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Properties of the route filter rule.␊ - */␊ - properties: (RouteFilterRulePropertiesFormat4 | string)␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeFilters/routeFilterRules␊ - */␊ - export interface RouteFiltersRouteFilterRules4 {␊ - name: string␊ - type: "Microsoft.Network/routeFilters/routeFilterRules"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Properties of the route filter rule.␊ - */␊ - properties: (RouteFilterRulePropertiesFormat4 | string)␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables␊ - */␊ - export interface RouteTables26 {␊ - name: string␊ - type: "Microsoft.Network/routeTables"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the route table.␊ - */␊ - properties: (RouteTablePropertiesFormat18 | string)␊ - resources?: RouteTablesRoutesChildResource18[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Table resource.␊ - */␊ - export interface RouteTablePropertiesFormat18 {␊ - /**␊ - * Collection of routes contained within a route table.␊ - */␊ - routes?: (Route18[] | string)␊ - /**␊ - * Gets or sets whether to disable the routes learned by BGP on that route table. True means disable.␊ - */␊ - disableBgpRoutePropagation?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource.␊ - */␊ - export interface Route18 {␊ - /**␊ - * Properties of the route.␊ - */␊ - properties?: (RoutePropertiesFormat18 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource.␊ - */␊ - export interface RoutePropertiesFormat18 {␊ - /**␊ - * The destination CIDR to which the route applies.␊ - */␊ - addressPrefix: string␊ - /**␊ - * The type of Azure hop the packet should be sent to.␊ - */␊ - nextHopType: (("VirtualNetworkGateway" | "VnetLocal" | "Internet" | "VirtualAppliance" | "None") | string)␊ - /**␊ - * The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.␊ - */␊ - nextHopIpAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutesChildResource18 {␊ - name: string␊ - type: "routes"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Properties of the route.␊ - */␊ - properties: (RoutePropertiesFormat18 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutes17 {␊ - name: string␊ - type: "Microsoft.Network/routeTables/routes"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Properties of the route.␊ - */␊ - properties: (RoutePropertiesFormat18 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/serviceEndpointPolicies␊ - */␊ - export interface ServiceEndpointPolicies2 {␊ - name: string␊ - type: "Microsoft.Network/serviceEndpointPolicies"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the service end point policy.␊ - */␊ - properties: (ServiceEndpointPolicyPropertiesFormat2 | string)␊ - resources?: ServiceEndpointPoliciesServiceEndpointPolicyDefinitionsChildResource2[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Service Endpoint Policy resource.␊ - */␊ - export interface ServiceEndpointPolicyPropertiesFormat2 {␊ - /**␊ - * A collection of service endpoint policy definitions of the service endpoint policy.␊ - */␊ - serviceEndpointPolicyDefinitions?: (ServiceEndpointPolicyDefinition2[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Service Endpoint policy definitions.␊ - */␊ - export interface ServiceEndpointPolicyDefinition2 {␊ - /**␊ - * Properties of the service endpoint policy definition.␊ - */␊ - properties?: (ServiceEndpointPolicyDefinitionPropertiesFormat2 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Service Endpoint policy definition resource.␊ - */␊ - export interface ServiceEndpointPolicyDefinitionPropertiesFormat2 {␊ - /**␊ - * A description for this rule. Restricted to 140 chars.␊ - */␊ - description?: string␊ - /**␊ - * Service endpoint name.␊ - */␊ - service?: string␊ - /**␊ - * A list of service resources.␊ - */␊ - serviceResources?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions␊ - */␊ - export interface ServiceEndpointPoliciesServiceEndpointPolicyDefinitionsChildResource2 {␊ - name: string␊ - type: "serviceEndpointPolicyDefinitions"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Properties of the service endpoint policy definition.␊ - */␊ - properties: (ServiceEndpointPolicyDefinitionPropertiesFormat2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions␊ - */␊ - export interface ServiceEndpointPoliciesServiceEndpointPolicyDefinitions2 {␊ - name: string␊ - type: "Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Properties of the service endpoint policy definition.␊ - */␊ - properties: (ServiceEndpointPolicyDefinitionPropertiesFormat2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualHubs␊ - */␊ - export interface VirtualHubs4 {␊ - name: string␊ - type: "Microsoft.Network/virtualHubs"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual hub.␊ - */␊ - properties: (VirtualHubProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VirtualHub.␊ - */␊ - export interface VirtualHubProperties4 {␊ - /**␊ - * The VirtualWAN to which the VirtualHub belongs.␊ - */␊ - virtualWan?: (SubResource24 | string)␊ - /**␊ - * The VpnGateway associated with this VirtualHub.␊ - */␊ - vpnGateway?: (SubResource24 | string)␊ - /**␊ - * The P2SVpnGateway associated with this VirtualHub.␊ - */␊ - p2SVpnGateway?: (SubResource24 | string)␊ - /**␊ - * The expressRouteGateway associated with this VirtualHub.␊ - */␊ - expressRouteGateway?: (SubResource24 | string)␊ - /**␊ - * List of all vnet connections with this VirtualHub.␊ - */␊ - virtualNetworkConnections?: (HubVirtualNetworkConnection4[] | string)␊ - /**␊ - * Address-prefix for this VirtualHub.␊ - */␊ - addressPrefix?: string␊ - /**␊ - * The routeTable associated with this virtual hub.␊ - */␊ - routeTable?: (VirtualHubRouteTable1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HubVirtualNetworkConnection Resource.␊ - */␊ - export interface HubVirtualNetworkConnection4 {␊ - /**␊ - * Properties of the hub virtual network connection.␊ - */␊ - properties?: (HubVirtualNetworkConnectionProperties4 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for HubVirtualNetworkConnection.␊ - */␊ - export interface HubVirtualNetworkConnectionProperties4 {␊ - /**␊ - * Reference to the remote virtual network.␊ - */␊ - remoteVirtualNetwork?: (SubResource24 | string)␊ - /**␊ - * VirtualHub to RemoteVnet transit to enabled or not.␊ - */␊ - allowHubToRemoteVnetTransit?: (boolean | string)␊ - /**␊ - * Allow RemoteVnet to use Virtual Hub's gateways.␊ - */␊ - allowRemoteVnetToUseHubVnetGateways?: (boolean | string)␊ - /**␊ - * Enable internet security.␊ - */␊ - enableInternetSecurity?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualHub route table.␊ - */␊ - export interface VirtualHubRouteTable1 {␊ - /**␊ - * List of all routes.␊ - */␊ - routes?: (VirtualHubRoute1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualHub route.␊ - */␊ - export interface VirtualHubRoute1 {␊ - /**␊ - * List of all addressPrefixes.␊ - */␊ - addressPrefixes?: (string[] | string)␊ - /**␊ - * NextHop ip address.␊ - */␊ - nextHopIpAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworkGateways␊ - */␊ - export interface VirtualNetworkGateways14 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworkGateways"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway.␊ - */␊ - properties: (VirtualNetworkGatewayPropertiesFormat14 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGateway properties.␊ - */␊ - export interface VirtualNetworkGatewayPropertiesFormat14 {␊ - /**␊ - * IP configurations for virtual network gateway.␊ - */␊ - ipConfigurations?: (VirtualNetworkGatewayIPConfiguration13[] | string)␊ - /**␊ - * The type of this virtual network gateway.␊ - */␊ - gatewayType?: (("Vpn" | "ExpressRoute" | "HyperNet") | string)␊ - /**␊ - * The type of this virtual network gateway.␊ - */␊ - vpnType?: (("PolicyBased" | "RouteBased") | string)␊ - /**␊ - * Whether BGP is enabled for this virtual network gateway or not.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * ActiveActive flag.␊ - */␊ - activeActive?: (boolean | string)␊ - /**␊ - * The reference of the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting.␊ - */␊ - gatewayDefaultSite?: (SubResource24 | string)␊ - /**␊ - * The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.␊ - */␊ - sku?: (VirtualNetworkGatewaySku13 | string)␊ - /**␊ - * The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations.␊ - */␊ - vpnClientConfiguration?: (VpnClientConfiguration13 | string)␊ - /**␊ - * Virtual network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings13 | string)␊ - /**␊ - * The reference of the address space resource which represents the custom routes address space specified by the customer for virtual network gateway and VpnClient.␊ - */␊ - customRoutes?: (AddressSpace26 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration for virtual network gateway.␊ - */␊ - export interface VirtualNetworkGatewayIPConfiguration13 {␊ - /**␊ - * Properties of the virtual network gateway ip configuration.␊ - */␊ - properties?: (VirtualNetworkGatewayIPConfigurationPropertiesFormat13 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of VirtualNetworkGatewayIPConfiguration.␊ - */␊ - export interface VirtualNetworkGatewayIPConfigurationPropertiesFormat13 {␊ - /**␊ - * The private IP address allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * The reference of the subnet resource.␊ - */␊ - subnet?: (SubResource24 | string)␊ - /**␊ - * The reference of the public IP resource.␊ - */␊ - publicIPAddress?: (SubResource24 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewaySku details.␊ - */␊ - export interface VirtualNetworkGatewaySku13 {␊ - /**␊ - * Gateway SKU name.␊ - */␊ - name?: (("Basic" | "HighPerformance" | "Standard" | "UltraPerformance" | "VpnGw1" | "VpnGw2" | "VpnGw3" | "VpnGw1AZ" | "VpnGw2AZ" | "VpnGw3AZ" | "ErGw1AZ" | "ErGw2AZ" | "ErGw3AZ") | string)␊ - /**␊ - * Gateway SKU tier.␊ - */␊ - tier?: (("Basic" | "HighPerformance" | "Standard" | "UltraPerformance" | "VpnGw1" | "VpnGw2" | "VpnGw3" | "VpnGw1AZ" | "VpnGw2AZ" | "VpnGw3AZ" | "ErGw1AZ" | "ErGw2AZ" | "ErGw3AZ") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnClientConfiguration for P2S client.␊ - */␊ - export interface VpnClientConfiguration13 {␊ - /**␊ - * The reference of the address space resource which represents Address space for P2S VpnClient.␊ - */␊ - vpnClientAddressPool?: (AddressSpace26 | string)␊ - /**␊ - * VpnClientRootCertificate for virtual network gateway.␊ - */␊ - vpnClientRootCertificates?: (VpnClientRootCertificate13[] | string)␊ - /**␊ - * VpnClientRevokedCertificate for Virtual network gateway.␊ - */␊ - vpnClientRevokedCertificates?: (VpnClientRevokedCertificate13[] | string)␊ - /**␊ - * VpnClientProtocols for Virtual network gateway.␊ - */␊ - vpnClientProtocols?: (("IkeV2" | "SSTP" | "OpenVPN")[] | string)␊ - /**␊ - * VpnClientIpsecPolicies for virtual network gateway P2S client.␊ - */␊ - vpnClientIpsecPolicies?: (IpsecPolicy11[] | string)␊ - /**␊ - * The radius server address property of the VirtualNetworkGateway resource for vpn client connection.␊ - */␊ - radiusServerAddress?: string␊ - /**␊ - * The radius secret property of the VirtualNetworkGateway resource for vpn client connection.␊ - */␊ - radiusServerSecret?: string␊ - /**␊ - * The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication.␊ - */␊ - aadTenant?: string␊ - /**␊ - * The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication.␊ - */␊ - aadAudience?: string␊ - /**␊ - * The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication.␊ - */␊ - aadIssuer?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client root certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRootCertificate13 {␊ - /**␊ - * Properties of the vpn client root certificate.␊ - */␊ - properties: (VpnClientRootCertificatePropertiesFormat13 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of application gateway.␊ - */␊ - export interface VpnClientRootCertificatePropertiesFormat13 {␊ - /**␊ - * The certificate public data.␊ - */␊ - publicCertData: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client revoked certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRevokedCertificate13 {␊ - /**␊ - * Properties of the vpn client revoked certificate.␊ - */␊ - properties?: (VpnClientRevokedCertificatePropertiesFormat13 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the revoked VPN client certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRevokedCertificatePropertiesFormat13 {␊ - /**␊ - * The revoked VPN client certificate thumbprint.␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks␊ - */␊ - export interface VirtualNetworks26 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network.␊ - */␊ - properties: (VirtualNetworkPropertiesFormat18 | string)␊ - resources?: (VirtualNetworksVirtualNetworkPeeringsChildResource15 | VirtualNetworksSubnetsChildResource18)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the virtual network.␊ - */␊ - export interface VirtualNetworkPropertiesFormat18 {␊ - /**␊ - * The AddressSpace that contains an array of IP address ranges that can be used by subnets.␊ - */␊ - addressSpace: (AddressSpace26 | string)␊ - /**␊ - * The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network.␊ - */␊ - dhcpOptions?: (DhcpOptions26 | string)␊ - /**␊ - * A list of subnets in a Virtual Network.␊ - */␊ - subnets?: (Subnet28[] | string)␊ - /**␊ - * A list of peerings in a Virtual Network.␊ - */␊ - virtualNetworkPeerings?: (VirtualNetworkPeering23[] | string)␊ - /**␊ - * Indicates if DDoS protection is enabled for all the protected resources in the virtual network. It requires a DDoS protection plan associated with the resource.␊ - */␊ - enableDdosProtection?: (boolean | string)␊ - /**␊ - * Indicates if VM protection is enabled for all the subnets in the virtual network.␊ - */␊ - enableVmProtection?: (boolean | string)␊ - /**␊ - * The DDoS protection plan associated with the virtual network.␊ - */␊ - ddosProtectionPlan?: (SubResource24 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DhcpOptions contains an array of DNS servers available to VMs deployed in the virtual network. Standard DHCP option for a subnet overrides VNET DHCP options.␊ - */␊ - export interface DhcpOptions26 {␊ - /**␊ - * The list of DNS servers IP addresses.␊ - */␊ - dnsServers: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Subnet in a virtual network resource.␊ - */␊ - export interface Subnet28 {␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties?: (SubnetPropertiesFormat18 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the subnet.␊ - */␊ - export interface SubnetPropertiesFormat18 {␊ - /**␊ - * The address prefix for the subnet.␊ - */␊ - addressPrefix: string␊ - /**␊ - * List of address prefixes for the subnet.␊ - */␊ - addressPrefixes?: (string[] | string)␊ - /**␊ - * The reference of the NetworkSecurityGroup resource.␊ - */␊ - networkSecurityGroup?: (SubResource24 | string)␊ - /**␊ - * The reference of the RouteTable resource.␊ - */␊ - routeTable?: (SubResource24 | string)␊ - /**␊ - * Nat gateway associated with this subnet.␊ - */␊ - natGateway?: (SubResource24 | string)␊ - /**␊ - * An array of service endpoints.␊ - */␊ - serviceEndpoints?: (ServiceEndpointPropertiesFormat14[] | string)␊ - /**␊ - * An array of service endpoint policies.␊ - */␊ - serviceEndpointPolicies?: (SubResource24[] | string)␊ - /**␊ - * Gets an array of references to the delegations on the subnet.␊ - */␊ - delegations?: (Delegation5[] | string)␊ - /**␊ - * Enable or Disable apply network policies on private end point in the subnet.␊ - */␊ - privateEndpointNetworkPolicies?: string␊ - /**␊ - * Enable or Disable apply network policies on private link service in the subnet.␊ - */␊ - privateLinkServiceNetworkPolicies?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The service endpoint properties.␊ - */␊ - export interface ServiceEndpointPropertiesFormat14 {␊ - /**␊ - * The type of the endpoint service.␊ - */␊ - service?: string␊ - /**␊ - * A list of locations.␊ - */␊ - locations?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Details the service to which the subnet is delegated.␊ - */␊ - export interface Delegation5 {␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties?: (ServiceDelegationPropertiesFormat5 | string)␊ - /**␊ - * The name of the resource that is unique within a subnet. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a service delegation.␊ - */␊ - export interface ServiceDelegationPropertiesFormat5 {␊ - /**␊ - * The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers).␊ - */␊ - serviceName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peerings in a virtual network resource.␊ - */␊ - export interface VirtualNetworkPeering23 {␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties?: (VirtualNetworkPeeringPropertiesFormat15 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - export interface VirtualNetworkPeeringPropertiesFormat15 {␊ - /**␊ - * Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space.␊ - */␊ - allowVirtualNetworkAccess?: (boolean | string)␊ - /**␊ - * Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network.␊ - */␊ - allowForwardedTraffic?: (boolean | string)␊ - /**␊ - * If gateway links can be used in remote virtual networking to link to this virtual network.␊ - */␊ - allowGatewayTransit?: (boolean | string)␊ - /**␊ - * If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway.␊ - */␊ - useRemoteGateways?: (boolean | string)␊ - /**␊ - * The reference of the remote virtual network. The remote virtual network can be in the same or different region (preview). See here to register for the preview and learn more (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering).␊ - */␊ - remoteVirtualNetwork: (SubResource24 | string)␊ - /**␊ - * The reference of the remote virtual network address space.␊ - */␊ - remoteAddressSpace?: (AddressSpace26 | string)␊ - /**␊ - * The status of the virtual network peering.␊ - */␊ - peeringState?: (("Initiated" | "Connected" | "Disconnected") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/virtualNetworkPeerings␊ - */␊ - export interface VirtualNetworksVirtualNetworkPeeringsChildResource15 {␊ - name: string␊ - type: "virtualNetworkPeerings"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties: (VirtualNetworkPeeringPropertiesFormat15 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnetsChildResource18 {␊ - name: string␊ - type: "subnets"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties: (SubnetPropertiesFormat18 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnets14 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks/subnets"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties: (SubnetPropertiesFormat18 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/virtualNetworkPeerings␊ - */␊ - export interface VirtualNetworksVirtualNetworkPeerings11 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks/virtualNetworkPeerings"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties: (VirtualNetworkPeeringPropertiesFormat15 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworkTaps␊ - */␊ - export interface VirtualNetworkTaps1 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworkTaps"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Virtual Network Tap Properties.␊ - */␊ - properties: (VirtualNetworkTapPropertiesFormat1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Virtual Network Tap properties.␊ - */␊ - export interface VirtualNetworkTapPropertiesFormat1 {␊ - /**␊ - * The reference to the private IP Address of the collector nic that will receive the tap.␊ - */␊ - destinationNetworkInterfaceIPConfiguration?: (SubResource24 | string)␊ - /**␊ - * The reference to the private IP address on the internal Load Balancer that will receive the tap.␊ - */␊ - destinationLoadBalancerFrontEndIPConfiguration?: (SubResource24 | string)␊ - /**␊ - * The VXLAN destination port that will receive the tapped traffic.␊ - */␊ - destinationPort?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualWans␊ - */␊ - export interface VirtualWans4 {␊ - name: string␊ - type: "Microsoft.Network/virtualWans"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual WAN.␊ - */␊ - properties: (VirtualWanProperties4 | string)␊ - resources?: VirtualWansP2SVpnServerConfigurationsChildResource1[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VirtualWAN.␊ - */␊ - export interface VirtualWanProperties4 {␊ - /**␊ - * Vpn encryption to be disabled or not.␊ - */␊ - disableVpnEncryption?: (boolean | string)␊ - /**␊ - * The Security Provider name.␊ - */␊ - securityProviderName?: string␊ - /**␊ - * True if branch to branch traffic is allowed.␊ - */␊ - allowBranchToBranchTraffic?: (boolean | string)␊ - /**␊ - * True if Vnet to Vnet traffic is allowed.␊ - */␊ - allowVnetToVnetTraffic?: (boolean | string)␊ - /**␊ - * The office local breakout category.␊ - */␊ - office365LocalBreakoutCategory?: (("Optimize" | "OptimizeAndAllow" | "All" | "None") | string)␊ - /**␊ - * List of all P2SVpnServerConfigurations associated with the virtual wan.␊ - */␊ - p2SVpnServerConfigurations?: (P2SVpnServerConfiguration1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * P2SVpnServerConfiguration Resource.␊ - */␊ - export interface P2SVpnServerConfiguration1 {␊ - /**␊ - * Properties of the P2SVpnServer configuration.␊ - */␊ - properties?: (P2SVpnServerConfigurationProperties1 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for P2SVpnServerConfiguration.␊ - */␊ - export interface P2SVpnServerConfigurationProperties1 {␊ - /**␊ - * The name of the P2SVpnServerConfiguration that is unique within a VirtualWan in a resource group. This name can be used to access the resource along with Paren VirtualWan resource name.␊ - */␊ - name?: string␊ - /**␊ - * VPN protocols for the P2SVpnServerConfiguration.␊ - */␊ - vpnProtocols?: (("IkeV2" | "OpenVPN")[] | string)␊ - /**␊ - * VPN client root certificate of P2SVpnServerConfiguration.␊ - */␊ - p2SVpnServerConfigVpnClientRootCertificates?: (P2SVpnServerConfigVpnClientRootCertificate1[] | string)␊ - /**␊ - * VPN client revoked certificate of P2SVpnServerConfiguration.␊ - */␊ - p2SVpnServerConfigVpnClientRevokedCertificates?: (P2SVpnServerConfigVpnClientRevokedCertificate1[] | string)␊ - /**␊ - * Radius Server root certificate of P2SVpnServerConfiguration.␊ - */␊ - p2SVpnServerConfigRadiusServerRootCertificates?: (P2SVpnServerConfigRadiusServerRootCertificate1[] | string)␊ - /**␊ - * Radius client root certificate of P2SVpnServerConfiguration.␊ - */␊ - p2SVpnServerConfigRadiusClientRootCertificates?: (P2SVpnServerConfigRadiusClientRootCertificate1[] | string)␊ - /**␊ - * VpnClientIpsecPolicies for P2SVpnServerConfiguration.␊ - */␊ - vpnClientIpsecPolicies?: (IpsecPolicy11[] | string)␊ - /**␊ - * The radius server address property of the P2SVpnServerConfiguration resource for point to site client connection.␊ - */␊ - radiusServerAddress?: string␊ - /**␊ - * The radius secret property of the P2SVpnServerConfiguration resource for point to site client connection.␊ - */␊ - radiusServerSecret?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client root certificate of P2SVpnServerConfiguration.␊ - */␊ - export interface P2SVpnServerConfigVpnClientRootCertificate1 {␊ - /**␊ - * Properties of the P2SVpnServerConfiguration VPN client root certificate.␊ - */␊ - properties: (P2SVpnServerConfigVpnClientRootCertificatePropertiesFormat1 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of VPN client root certificate of P2SVpnServerConfiguration.␊ - */␊ - export interface P2SVpnServerConfigVpnClientRootCertificatePropertiesFormat1 {␊ - /**␊ - * The certificate public data.␊ - */␊ - publicCertData: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client revoked certificate of P2SVpnServerConfiguration.␊ - */␊ - export interface P2SVpnServerConfigVpnClientRevokedCertificate1 {␊ - /**␊ - * Properties of the vpn client revoked certificate.␊ - */␊ - properties?: (P2SVpnServerConfigVpnClientRevokedCertificatePropertiesFormat1 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the revoked VPN client certificate of P2SVpnServerConfiguration.␊ - */␊ - export interface P2SVpnServerConfigVpnClientRevokedCertificatePropertiesFormat1 {␊ - /**␊ - * The revoked VPN client certificate thumbprint.␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Radius Server root certificate of P2SVpnServerConfiguration.␊ - */␊ - export interface P2SVpnServerConfigRadiusServerRootCertificate1 {␊ - /**␊ - * Properties of the P2SVpnServerConfiguration Radius Server root certificate.␊ - */␊ - properties: (P2SVpnServerConfigRadiusServerRootCertificatePropertiesFormat1 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Radius Server root certificate of P2SVpnServerConfiguration.␊ - */␊ - export interface P2SVpnServerConfigRadiusServerRootCertificatePropertiesFormat1 {␊ - /**␊ - * The certificate public data.␊ - */␊ - publicCertData: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Radius client root certificate of P2SVpnServerConfiguration.␊ - */␊ - export interface P2SVpnServerConfigRadiusClientRootCertificate1 {␊ - /**␊ - * Properties of the Radius client root certificate.␊ - */␊ - properties?: (P2SVpnServerConfigRadiusClientRootCertificatePropertiesFormat1 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Radius client root certificate of P2SVpnServerConfiguration.␊ - */␊ - export interface P2SVpnServerConfigRadiusClientRootCertificatePropertiesFormat1 {␊ - /**␊ - * The Radius client root certificate thumbprint.␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualWans/p2sVpnServerConfigurations␊ - */␊ - export interface VirtualWansP2SVpnServerConfigurationsChildResource1 {␊ - name: string␊ - type: "p2sVpnServerConfigurations"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Properties of the P2SVpnServer configuration.␊ - */␊ - properties: (P2SVpnServerConfigurationProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualWans/p2sVpnServerConfigurations␊ - */␊ - export interface VirtualWansP2SVpnServerConfigurations1 {␊ - name: string␊ - type: "Microsoft.Network/virtualWans/p2sVpnServerConfigurations"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Properties of the P2SVpnServer configuration.␊ - */␊ - properties: (P2SVpnServerConfigurationProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnGateways␊ - */␊ - export interface VpnGateways4 {␊ - name: string␊ - type: "Microsoft.Network/vpnGateways"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the VPN gateway.␊ - */␊ - properties: (VpnGatewayProperties4 | string)␊ - resources?: VpnGatewaysVpnConnectionsChildResource4[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnGateway.␊ - */␊ - export interface VpnGatewayProperties4 {␊ - /**␊ - * The VirtualHub to which the gateway belongs.␊ - */␊ - virtualHub?: (SubResource24 | string)␊ - /**␊ - * List of all vpn connections to the gateway.␊ - */␊ - connections?: (VpnConnection4[] | string)␊ - /**␊ - * Local network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings13 | string)␊ - /**␊ - * The scale unit for this vpn gateway.␊ - */␊ - vpnGatewayScaleUnit?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnConnection Resource.␊ - */␊ - export interface VpnConnection4 {␊ - /**␊ - * Properties of the VPN connection.␊ - */␊ - properties?: (VpnConnectionProperties4 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnConnection.␊ - */␊ - export interface VpnConnectionProperties4 {␊ - /**␊ - * Id of the connected vpn site.␊ - */␊ - remoteVpnSite?: (SubResource24 | string)␊ - /**␊ - * Routing weight for vpn connection.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * The connection status.␊ - */␊ - connectionStatus?: (("Unknown" | "Connecting" | "Connected" | "NotConnected") | string)␊ - /**␊ - * Connection protocol used for this connection.␊ - */␊ - vpnConnectionProtocolType?: (("IKEv2" | "IKEv1") | string)␊ - /**␊ - * Expected bandwidth in MBPS.␊ - */␊ - connectionBandwidth?: (number | string)␊ - /**␊ - * SharedKey for the vpn connection.␊ - */␊ - sharedKey?: string␊ - /**␊ - * EnableBgp flag.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * Enable policy-based traffic selectors.␊ - */␊ - usePolicyBasedTrafficSelectors?: (boolean | string)␊ - /**␊ - * The IPSec Policies to be considered by this connection.␊ - */␊ - ipsecPolicies?: (IpsecPolicy11[] | string)␊ - /**␊ - * EnableBgp flag.␊ - */␊ - enableRateLimiting?: (boolean | string)␊ - /**␊ - * Enable internet security.␊ - */␊ - enableInternetSecurity?: (boolean | string)␊ - /**␊ - * Use local azure ip to initiate connection.␊ - */␊ - useLocalAzureIpAddress?: (boolean | string)␊ - /**␊ - * List of all vpn site link connections to the gateway.␊ - */␊ - vpnLinkConnections?: (VpnSiteLinkConnection[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnSiteLinkConnection Resource.␊ - */␊ - export interface VpnSiteLinkConnection {␊ - /**␊ - * Properties of the VPN site link connection.␊ - */␊ - properties?: (VpnSiteLinkConnectionProperties | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnConnection.␊ - */␊ - export interface VpnSiteLinkConnectionProperties {␊ - /**␊ - * Id of the connected vpn site link.␊ - */␊ - vpnSiteLink?: (SubResource24 | string)␊ - /**␊ - * Routing weight for vpn connection.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * The connection status.␊ - */␊ - connectionStatus?: (("Unknown" | "Connecting" | "Connected" | "NotConnected") | string)␊ - /**␊ - * Connection protocol used for this connection.␊ - */␊ - vpnConnectionProtocolType?: (("IKEv2" | "IKEv1") | string)␊ - /**␊ - * Expected bandwidth in MBPS.␊ - */␊ - connectionBandwidth?: (number | string)␊ - /**␊ - * SharedKey for the vpn connection.␊ - */␊ - sharedKey?: string␊ - /**␊ - * EnableBgp flag.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * Enable policy-based traffic selectors.␊ - */␊ - usePolicyBasedTrafficSelectors?: (boolean | string)␊ - /**␊ - * The IPSec Policies to be considered by this connection.␊ - */␊ - ipsecPolicies?: (IpsecPolicy11[] | string)␊ - /**␊ - * EnableBgp flag.␊ - */␊ - enableRateLimiting?: (boolean | string)␊ - /**␊ - * Use local azure ip to initiate connection.␊ - */␊ - useLocalAzureIpAddress?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnGateways/vpnConnections␊ - */␊ - export interface VpnGatewaysVpnConnectionsChildResource4 {␊ - name: string␊ - type: "vpnConnections"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Properties of the VPN connection.␊ - */␊ - properties: (VpnConnectionProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnGateways/vpnConnections␊ - */␊ - export interface VpnGatewaysVpnConnections4 {␊ - name: string␊ - type: "Microsoft.Network/vpnGateways/vpnConnections"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Properties of the VPN connection.␊ - */␊ - properties: (VpnConnectionProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnSites␊ - */␊ - export interface VpnSites4 {␊ - name: string␊ - type: "Microsoft.Network/vpnSites"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the VPN site.␊ - */␊ - properties: (VpnSiteProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnSite.␊ - */␊ - export interface VpnSiteProperties4 {␊ - /**␊ - * The VirtualWAN to which the vpnSite belongs.␊ - */␊ - virtualWan?: (SubResource24 | string)␊ - /**␊ - * The device properties.␊ - */␊ - deviceProperties?: (DeviceProperties4 | string)␊ - /**␊ - * The ip-address for the vpn-site.␊ - */␊ - ipAddress?: string␊ - /**␊ - * The key for vpn-site that can be used for connections.␊ - */␊ - siteKey?: string␊ - /**␊ - * The AddressSpace that contains an array of IP address ranges.␊ - */␊ - addressSpace?: (AddressSpace26 | string)␊ - /**␊ - * The set of bgp properties.␊ - */␊ - bgpProperties?: (BgpSettings13 | string)␊ - /**␊ - * IsSecuritySite flag.␊ - */␊ - isSecuritySite?: (boolean | string)␊ - /**␊ - * List of all vpn site links␊ - */␊ - vpnSiteLinks?: (VpnSiteLink[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * List of properties of the device.␊ - */␊ - export interface DeviceProperties4 {␊ - /**␊ - * Name of the device Vendor.␊ - */␊ - deviceVendor?: string␊ - /**␊ - * Model of the device.␊ - */␊ - deviceModel?: string␊ - /**␊ - * Link speed.␊ - */␊ - linkSpeedInMbps?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnSiteLink Resource.␊ - */␊ - export interface VpnSiteLink {␊ - /**␊ - * Properties of the VPN site link.␊ - */␊ - properties?: (VpnSiteLinkProperties | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnSite.␊ - */␊ - export interface VpnSiteLinkProperties {␊ - /**␊ - * The link provider properties.␊ - */␊ - linkProperties?: (VpnLinkProviderProperties | string)␊ - /**␊ - * The ip-address for the vpn-site-link.␊ - */␊ - ipAddress?: string␊ - /**␊ - * The set of bgp properties.␊ - */␊ - bgpProperties?: (VpnLinkBgpSettings | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * List of properties of a link provider.␊ - */␊ - export interface VpnLinkProviderProperties {␊ - /**␊ - * Name of the link provider.␊ - */␊ - linkProviderName?: string␊ - /**␊ - * Link speed.␊ - */␊ - linkSpeedInMbps?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * BGP settings details for a link.␊ - */␊ - export interface VpnLinkBgpSettings {␊ - /**␊ - * The BGP speaker's ASN.␊ - */␊ - asn?: (number | string)␊ - /**␊ - * The BGP peering address and BGP identifier of this BGP speaker.␊ - */␊ - bgpPeeringAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/applicationGateways␊ - */␊ - export interface ApplicationGateways18 {␊ - name: string␊ - type: "Microsoft.Network/applicationGateways"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the application gateway.␊ - */␊ - properties: (ApplicationGatewayPropertiesFormat18 | string)␊ - /**␊ - * A list of availability zones denoting where the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - /**␊ - * The identity of the application gateway, if configured.␊ - */␊ - identity?: (ManagedServiceIdentity5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application gateway.␊ - */␊ - export interface ApplicationGatewayPropertiesFormat18 {␊ - /**␊ - * SKU of the application gateway resource.␊ - */␊ - sku?: (ApplicationGatewaySku18 | string)␊ - /**␊ - * SSL policy of the application gateway resource.␊ - */␊ - sslPolicy?: (ApplicationGatewaySslPolicy15 | string)␊ - /**␊ - * Subnets of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - gatewayIPConfigurations?: (ApplicationGatewayIPConfiguration18[] | string)␊ - /**␊ - * Authentication certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - authenticationCertificates?: (ApplicationGatewayAuthenticationCertificate15[] | string)␊ - /**␊ - * Trusted Root certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - trustedRootCertificates?: (ApplicationGatewayTrustedRootCertificate6[] | string)␊ - /**␊ - * SSL certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - sslCertificates?: (ApplicationGatewaySslCertificate18[] | string)␊ - /**␊ - * Frontend IP addresses of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - frontendIPConfigurations?: (ApplicationGatewayFrontendIPConfiguration18[] | string)␊ - /**␊ - * Frontend ports of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - frontendPorts?: (ApplicationGatewayFrontendPort18[] | string)␊ - /**␊ - * Probes of the application gateway resource.␊ - */␊ - probes?: (ApplicationGatewayProbe17[] | string)␊ - /**␊ - * Backend address pool of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - backendAddressPools?: (ApplicationGatewayBackendAddressPool18[] | string)␊ - /**␊ - * Backend http settings of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - backendHttpSettingsCollection?: (ApplicationGatewayBackendHttpSettings18[] | string)␊ - /**␊ - * Http listeners of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - httpListeners?: (ApplicationGatewayHttpListener18[] | string)␊ - /**␊ - * URL path map of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - urlPathMaps?: (ApplicationGatewayUrlPathMap17[] | string)␊ - /**␊ - * Request routing rules of the application gateway resource.␊ - */␊ - requestRoutingRules?: (ApplicationGatewayRequestRoutingRule18[] | string)␊ - /**␊ - * Rewrite rules for the application gateway resource.␊ - */␊ - rewriteRuleSets?: (ApplicationGatewayRewriteRuleSet5[] | string)␊ - /**␊ - * Redirect configurations of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - redirectConfigurations?: (ApplicationGatewayRedirectConfiguration15[] | string)␊ - /**␊ - * Web application firewall configuration.␊ - */␊ - webApplicationFirewallConfiguration?: (ApplicationGatewayWebApplicationFirewallConfiguration15 | string)␊ - /**␊ - * Reference of the FirewallPolicy resource.␊ - */␊ - firewallPolicy?: (SubResource25 | string)␊ - /**␊ - * Whether HTTP2 is enabled on the application gateway resource.␊ - */␊ - enableHttp2?: (boolean | string)␊ - /**␊ - * Whether FIPS is enabled on the application gateway resource.␊ - */␊ - enableFips?: (boolean | string)␊ - /**␊ - * Autoscale Configuration.␊ - */␊ - autoscaleConfiguration?: (ApplicationGatewayAutoscaleConfiguration9 | string)␊ - /**␊ - * Custom error configurations of the application gateway resource.␊ - */␊ - customErrorConfigurations?: (ApplicationGatewayCustomError6[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of an application gateway.␊ - */␊ - export interface ApplicationGatewaySku18 {␊ - /**␊ - * Name of an application gateway SKU.␊ - */␊ - name?: (("Standard_Small" | "Standard_Medium" | "Standard_Large" | "WAF_Medium" | "WAF_Large" | "Standard_v2" | "WAF_v2") | string)␊ - /**␊ - * Tier of an application gateway.␊ - */␊ - tier?: (("Standard" | "WAF" | "Standard_v2" | "WAF_v2") | string)␊ - /**␊ - * Capacity (instance count) of an application gateway.␊ - */␊ - capacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application Gateway Ssl policy.␊ - */␊ - export interface ApplicationGatewaySslPolicy15 {␊ - /**␊ - * Ssl protocols to be disabled on application gateway.␊ - */␊ - disabledSslProtocols?: (("TLSv1_0" | "TLSv1_1" | "TLSv1_2")[] | string)␊ - /**␊ - * Type of Ssl Policy.␊ - */␊ - policyType?: (("Predefined" | "Custom") | string)␊ - /**␊ - * Name of Ssl predefined policy.␊ - */␊ - policyName?: (("AppGwSslPolicy20150501" | "AppGwSslPolicy20170401" | "AppGwSslPolicy20170401S") | string)␊ - /**␊ - * Ssl cipher suites to be enabled in the specified order to application gateway.␊ - */␊ - cipherSuites?: (("TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384" | "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256" | "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA" | "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA" | "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384" | "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256" | "TLS_DHE_RSA_WITH_AES_256_CBC_SHA" | "TLS_DHE_RSA_WITH_AES_128_CBC_SHA" | "TLS_RSA_WITH_AES_256_GCM_SHA384" | "TLS_RSA_WITH_AES_128_GCM_SHA256" | "TLS_RSA_WITH_AES_256_CBC_SHA256" | "TLS_RSA_WITH_AES_128_CBC_SHA256" | "TLS_RSA_WITH_AES_256_CBC_SHA" | "TLS_RSA_WITH_AES_128_CBC_SHA" | "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384" | "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256" | "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384" | "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256" | "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA" | "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA" | "TLS_DHE_DSS_WITH_AES_256_CBC_SHA256" | "TLS_DHE_DSS_WITH_AES_128_CBC_SHA256" | "TLS_DHE_DSS_WITH_AES_256_CBC_SHA" | "TLS_DHE_DSS_WITH_AES_128_CBC_SHA" | "TLS_RSA_WITH_3DES_EDE_CBC_SHA" | "TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA" | "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256" | "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384")[] | string)␊ - /**␊ - * Minimum version of Ssl protocol to be supported on application gateway.␊ - */␊ - minProtocolVersion?: (("TLSv1_0" | "TLSv1_1" | "TLSv1_2") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed.␊ - */␊ - export interface ApplicationGatewayIPConfiguration18 {␊ - /**␊ - * Properties of the application gateway IP configuration.␊ - */␊ - properties?: (ApplicationGatewayIPConfigurationPropertiesFormat18 | string)␊ - /**␊ - * Name of the IP configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayIPConfigurationPropertiesFormat18 {␊ - /**␊ - * Reference of the subnet resource. A subnet from where application gateway gets its private address.␊ - */␊ - subnet?: (SubResource25 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Reference to another subresource.␊ - */␊ - export interface SubResource25 {␊ - /**␊ - * Resource ID.␊ - */␊ - id: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authentication certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewayAuthenticationCertificate15 {␊ - /**␊ - * Properties of the application gateway authentication certificate.␊ - */␊ - properties?: (ApplicationGatewayAuthenticationCertificatePropertiesFormat15 | string)␊ - /**␊ - * Name of the authentication certificate that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authentication certificates properties of an application gateway.␊ - */␊ - export interface ApplicationGatewayAuthenticationCertificatePropertiesFormat15 {␊ - /**␊ - * Certificate public data.␊ - */␊ - data?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trusted Root certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewayTrustedRootCertificate6 {␊ - /**␊ - * Properties of the application gateway trusted root certificate.␊ - */␊ - properties?: (ApplicationGatewayTrustedRootCertificatePropertiesFormat6 | string)␊ - /**␊ - * Name of the trusted root certificate that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trusted Root certificates properties of an application gateway.␊ - */␊ - export interface ApplicationGatewayTrustedRootCertificatePropertiesFormat6 {␊ - /**␊ - * Certificate public data.␊ - */␊ - data?: string␊ - /**␊ - * Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault.␊ - */␊ - keyVaultSecretId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSL certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewaySslCertificate18 {␊ - /**␊ - * Properties of the application gateway SSL certificate.␊ - */␊ - properties?: (ApplicationGatewaySslCertificatePropertiesFormat18 | string)␊ - /**␊ - * Name of the SSL certificate that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewaySslCertificatePropertiesFormat18 {␊ - /**␊ - * Base-64 encoded pfx certificate. Only applicable in PUT Request.␊ - */␊ - data?: string␊ - /**␊ - * Password for the pfx file specified in data. Only applicable in PUT request.␊ - */␊ - password?: string␊ - /**␊ - * Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault.␊ - */␊ - keyVaultSecretId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendIPConfiguration18 {␊ - /**␊ - * Properties of the application gateway frontend IP configuration.␊ - */␊ - properties?: (ApplicationGatewayFrontendIPConfigurationPropertiesFormat18 | string)␊ - /**␊ - * Name of the frontend IP configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendIPConfigurationPropertiesFormat18 {␊ - /**␊ - * PrivateIPAddress of the network interface IP Configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The private IP address allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Reference of the subnet resource.␊ - */␊ - subnet?: (SubResource25 | string)␊ - /**␊ - * Reference of the PublicIP resource.␊ - */␊ - publicIPAddress?: (SubResource25 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend port of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendPort18 {␊ - /**␊ - * Properties of the application gateway frontend port.␊ - */␊ - properties?: (ApplicationGatewayFrontendPortPropertiesFormat18 | string)␊ - /**␊ - * Name of the frontend port that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend port of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendPortPropertiesFormat18 {␊ - /**␊ - * Frontend port.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Probe of the application gateway.␊ - */␊ - export interface ApplicationGatewayProbe17 {␊ - /**␊ - * Properties of the application gateway probe.␊ - */␊ - properties?: (ApplicationGatewayProbePropertiesFormat17 | string)␊ - /**␊ - * Name of the probe that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of probe of an application gateway.␊ - */␊ - export interface ApplicationGatewayProbePropertiesFormat17 {␊ - /**␊ - * The protocol used for the probe.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Host name to send the probe to.␊ - */␊ - host?: string␊ - /**␊ - * Relative path of probe. Valid path starts from '/'. Probe is sent to ://:.␊ - */␊ - path?: string␊ - /**␊ - * The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - interval?: (number | string)␊ - /**␊ - * The probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - timeout?: (number | string)␊ - /**␊ - * The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20.␊ - */␊ - unhealthyThreshold?: (number | string)␊ - /**␊ - * Whether the host header should be picked from the backend http settings. Default value is false.␊ - */␊ - pickHostNameFromBackendHttpSettings?: (boolean | string)␊ - /**␊ - * Minimum number of servers that are always marked healthy. Default value is 0.␊ - */␊ - minServers?: (number | string)␊ - /**␊ - * Criterion for classifying a healthy probe response.␊ - */␊ - match?: (ApplicationGatewayProbeHealthResponseMatch15 | string)␊ - /**␊ - * Custom port which will be used for probing the backend servers. The valid value ranges from 1 to 65535. In case not set, port from http settings will be used. This property is valid for Standard_v2 and WAF_v2 only.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application gateway probe health response match.␊ - */␊ - export interface ApplicationGatewayProbeHealthResponseMatch15 {␊ - /**␊ - * Body that must be contained in the health response. Default value is empty.␊ - */␊ - body?: string␊ - /**␊ - * Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399.␊ - */␊ - statusCodes?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend Address Pool of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddressPool18 {␊ - /**␊ - * Properties of the application gateway backend address pool.␊ - */␊ - properties?: (ApplicationGatewayBackendAddressPoolPropertiesFormat18 | string)␊ - /**␊ - * Name of the backend address pool that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend Address Pool of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddressPoolPropertiesFormat18 {␊ - /**␊ - * Backend addresses.␊ - */␊ - backendAddresses?: (ApplicationGatewayBackendAddress18[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddress18 {␊ - /**␊ - * Fully qualified domain name (FQDN).␊ - */␊ - fqdn?: string␊ - /**␊ - * IP address.␊ - */␊ - ipAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address pool settings of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendHttpSettings18 {␊ - /**␊ - * Properties of the application gateway backend HTTP settings.␊ - */␊ - properties?: (ApplicationGatewayBackendHttpSettingsPropertiesFormat18 | string)␊ - /**␊ - * Name of the backend http settings that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend address pool settings of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendHttpSettingsPropertiesFormat18 {␊ - /**␊ - * The destination port on the backend.␊ - */␊ - port?: (number | string)␊ - /**␊ - * The protocol used to communicate with the backend.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Cookie based affinity.␊ - */␊ - cookieBasedAffinity?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Request timeout in seconds. Application Gateway will fail the request if response is not received within RequestTimeout. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - requestTimeout?: (number | string)␊ - /**␊ - * Probe resource of an application gateway.␊ - */␊ - probe?: (SubResource25 | string)␊ - /**␊ - * Array of references to application gateway authentication certificates.␊ - */␊ - authenticationCertificates?: (SubResource25[] | string)␊ - /**␊ - * Array of references to application gateway trusted root certificates.␊ - */␊ - trustedRootCertificates?: (SubResource25[] | string)␊ - /**␊ - * Connection draining of the backend http settings resource.␊ - */␊ - connectionDraining?: (ApplicationGatewayConnectionDraining15 | string)␊ - /**␊ - * Host header to be sent to the backend servers.␊ - */␊ - hostName?: string␊ - /**␊ - * Whether to pick host header should be picked from the host name of the backend server. Default value is false.␊ - */␊ - pickHostNameFromBackendAddress?: (boolean | string)␊ - /**␊ - * Cookie name to use for the affinity cookie.␊ - */␊ - affinityCookieName?: string␊ - /**␊ - * Whether the probe is enabled. Default value is false.␊ - */␊ - probeEnabled?: (boolean | string)␊ - /**␊ - * Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null.␊ - */␊ - path?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Connection draining allows open connections to a backend server to be active for a specified time after the backend server got removed from the configuration.␊ - */␊ - export interface ApplicationGatewayConnectionDraining15 {␊ - /**␊ - * Whether connection draining is enabled or not.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds.␊ - */␊ - drainTimeoutInSec: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http listener of an application gateway.␊ - */␊ - export interface ApplicationGatewayHttpListener18 {␊ - /**␊ - * Properties of the application gateway HTTP listener.␊ - */␊ - properties?: (ApplicationGatewayHttpListenerPropertiesFormat18 | string)␊ - /**␊ - * Name of the HTTP listener that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of HTTP listener of an application gateway.␊ - */␊ - export interface ApplicationGatewayHttpListenerPropertiesFormat18 {␊ - /**␊ - * Frontend IP configuration resource of an application gateway.␊ - */␊ - frontendIPConfiguration?: (SubResource25 | string)␊ - /**␊ - * Frontend port resource of an application gateway.␊ - */␊ - frontendPort?: (SubResource25 | string)␊ - /**␊ - * Protocol of the HTTP listener.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Host name of HTTP listener.␊ - */␊ - hostName?: string␊ - /**␊ - * SSL certificate resource of an application gateway.␊ - */␊ - sslCertificate?: (SubResource25 | string)␊ - /**␊ - * Applicable only if protocol is https. Enables SNI for multi-hosting.␊ - */␊ - requireServerNameIndication?: (boolean | string)␊ - /**␊ - * Custom error configurations of the HTTP listener.␊ - */␊ - customErrorConfigurations?: (ApplicationGatewayCustomError6[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Customer error of an application gateway.␊ - */␊ - export interface ApplicationGatewayCustomError6 {␊ - /**␊ - * Status code of the application gateway customer error.␊ - */␊ - statusCode?: (("HttpStatus403" | "HttpStatus502") | string)␊ - /**␊ - * Error page URL of the application gateway customer error.␊ - */␊ - customErrorPageUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * UrlPathMaps give a url path to the backend mapping information for PathBasedRouting.␊ - */␊ - export interface ApplicationGatewayUrlPathMap17 {␊ - /**␊ - * Properties of the application gateway URL path map.␊ - */␊ - properties?: (ApplicationGatewayUrlPathMapPropertiesFormat17 | string)␊ - /**␊ - * Name of the URL path map that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of UrlPathMap of the application gateway.␊ - */␊ - export interface ApplicationGatewayUrlPathMapPropertiesFormat17 {␊ - /**␊ - * Default backend address pool resource of URL path map.␊ - */␊ - defaultBackendAddressPool?: (SubResource25 | string)␊ - /**␊ - * Default backend http settings resource of URL path map.␊ - */␊ - defaultBackendHttpSettings?: (SubResource25 | string)␊ - /**␊ - * Default Rewrite rule set resource of URL path map.␊ - */␊ - defaultRewriteRuleSet?: (SubResource25 | string)␊ - /**␊ - * Default redirect configuration resource of URL path map.␊ - */␊ - defaultRedirectConfiguration?: (SubResource25 | string)␊ - /**␊ - * Path rule of URL path map resource.␊ - */␊ - pathRules?: (ApplicationGatewayPathRule17[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Path rule of URL path map of an application gateway.␊ - */␊ - export interface ApplicationGatewayPathRule17 {␊ - /**␊ - * Properties of the application gateway path rule.␊ - */␊ - properties?: (ApplicationGatewayPathRulePropertiesFormat17 | string)␊ - /**␊ - * Name of the path rule that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of path rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayPathRulePropertiesFormat17 {␊ - /**␊ - * Path rules of URL path map.␊ - */␊ - paths?: (string[] | string)␊ - /**␊ - * Backend address pool resource of URL path map path rule.␊ - */␊ - backendAddressPool?: (SubResource25 | string)␊ - /**␊ - * Backend http settings resource of URL path map path rule.␊ - */␊ - backendHttpSettings?: (SubResource25 | string)␊ - /**␊ - * Redirect configuration resource of URL path map path rule.␊ - */␊ - redirectConfiguration?: (SubResource25 | string)␊ - /**␊ - * Rewrite rule set resource of URL path map path rule.␊ - */␊ - rewriteRuleSet?: (SubResource25 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Request routing rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayRequestRoutingRule18 {␊ - /**␊ - * Properties of the application gateway request routing rule.␊ - */␊ - properties?: (ApplicationGatewayRequestRoutingRulePropertiesFormat18 | string)␊ - /**␊ - * Name of the request routing rule that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of request routing rule of the application gateway.␊ - */␊ - export interface ApplicationGatewayRequestRoutingRulePropertiesFormat18 {␊ - /**␊ - * Rule type.␊ - */␊ - ruleType?: (("Basic" | "PathBasedRouting") | string)␊ - /**␊ - * Priority of the request routing rule.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * Backend address pool resource of the application gateway.␊ - */␊ - backendAddressPool?: (SubResource25 | string)␊ - /**␊ - * Backend http settings resource of the application gateway.␊ - */␊ - backendHttpSettings?: (SubResource25 | string)␊ - /**␊ - * Http listener resource of the application gateway.␊ - */␊ - httpListener?: (SubResource25 | string)␊ - /**␊ - * URL path map resource of the application gateway.␊ - */␊ - urlPathMap?: (SubResource25 | string)␊ - /**␊ - * Rewrite Rule Set resource in Basic rule of the application gateway.␊ - */␊ - rewriteRuleSet?: (SubResource25 | string)␊ - /**␊ - * Redirect configuration resource of the application gateway.␊ - */␊ - redirectConfiguration?: (SubResource25 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Rewrite rule set of an application gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRuleSet5 {␊ - /**␊ - * Properties of the application gateway rewrite rule set.␊ - */␊ - properties?: (ApplicationGatewayRewriteRuleSetPropertiesFormat5 | string)␊ - /**␊ - * Name of the rewrite rule set that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of rewrite rule set of the application gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRuleSetPropertiesFormat5 {␊ - /**␊ - * Rewrite rules in the rewrite rule set.␊ - */␊ - rewriteRules?: (ApplicationGatewayRewriteRule5[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Rewrite rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRule5 {␊ - /**␊ - * Name of the rewrite rule that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet.␊ - */␊ - ruleSequence?: (number | string)␊ - /**␊ - * Conditions based on which the action set execution will be evaluated.␊ - */␊ - conditions?: (ApplicationGatewayRewriteRuleCondition4[] | string)␊ - /**␊ - * Set of actions to be done as part of the rewrite Rule.␊ - */␊ - actionSet?: (ApplicationGatewayRewriteRuleActionSet5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Set of conditions in the Rewrite Rule in Application Gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRuleCondition4 {␊ - /**␊ - * The condition parameter of the RewriteRuleCondition.␊ - */␊ - variable?: string␊ - /**␊ - * The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition.␊ - */␊ - pattern?: string␊ - /**␊ - * Setting this paramter to truth value with force the pattern to do a case in-sensitive comparison.␊ - */␊ - ignoreCase?: (boolean | string)␊ - /**␊ - * Setting this value as truth will force to check the negation of the condition given by the user.␊ - */␊ - negate?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Set of actions in the Rewrite Rule in Application Gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRuleActionSet5 {␊ - /**␊ - * Request Header Actions in the Action Set.␊ - */␊ - requestHeaderConfigurations?: (ApplicationGatewayHeaderConfiguration5[] | string)␊ - /**␊ - * Response Header Actions in the Action Set.␊ - */␊ - responseHeaderConfigurations?: (ApplicationGatewayHeaderConfiguration5[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Header configuration of the Actions set in Application Gateway.␊ - */␊ - export interface ApplicationGatewayHeaderConfiguration5 {␊ - /**␊ - * Header name of the header configuration.␊ - */␊ - headerName?: string␊ - /**␊ - * Header value of the header configuration.␊ - */␊ - headerValue?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Redirect configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayRedirectConfiguration15 {␊ - /**␊ - * Properties of the application gateway redirect configuration.␊ - */␊ - properties?: (ApplicationGatewayRedirectConfigurationPropertiesFormat15 | string)␊ - /**␊ - * Name of the redirect configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of redirect configuration of the application gateway.␊ - */␊ - export interface ApplicationGatewayRedirectConfigurationPropertiesFormat15 {␊ - /**␊ - * HTTP redirection type.␊ - */␊ - redirectType?: (("Permanent" | "Found" | "SeeOther" | "Temporary") | string)␊ - /**␊ - * Reference to a listener to redirect the request to.␊ - */␊ - targetListener?: (SubResource25 | string)␊ - /**␊ - * Url to redirect the request to.␊ - */␊ - targetUrl?: string␊ - /**␊ - * Include path in the redirected url.␊ - */␊ - includePath?: (boolean | string)␊ - /**␊ - * Include query string in the redirected url.␊ - */␊ - includeQueryString?: (boolean | string)␊ - /**␊ - * Request routing specifying redirect configuration.␊ - */␊ - requestRoutingRules?: (SubResource25[] | string)␊ - /**␊ - * Url path maps specifying default redirect configuration.␊ - */␊ - urlPathMaps?: (SubResource25[] | string)␊ - /**␊ - * Path rules specifying redirect configuration.␊ - */␊ - pathRules?: (SubResource25[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application gateway web application firewall configuration.␊ - */␊ - export interface ApplicationGatewayWebApplicationFirewallConfiguration15 {␊ - /**␊ - * Whether the web application firewall is enabled or not.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * Web application firewall mode.␊ - */␊ - firewallMode: (("Detection" | "Prevention") | string)␊ - /**␊ - * The type of the web application firewall rule set. Possible values are: 'OWASP'.␊ - */␊ - ruleSetType: string␊ - /**␊ - * The version of the rule set type.␊ - */␊ - ruleSetVersion: string␊ - /**␊ - * The disabled rule groups.␊ - */␊ - disabledRuleGroups?: (ApplicationGatewayFirewallDisabledRuleGroup15[] | string)␊ - /**␊ - * Whether allow WAF to check request Body.␊ - */␊ - requestBodyCheck?: (boolean | string)␊ - /**␊ - * Maximum request body size for WAF.␊ - */␊ - maxRequestBodySize?: (number | string)␊ - /**␊ - * Maximum request body size in Kb for WAF.␊ - */␊ - maxRequestBodySizeInKb?: (number | string)␊ - /**␊ - * Maximum file upload size in Mb for WAF.␊ - */␊ - fileUploadLimitInMb?: (number | string)␊ - /**␊ - * The exclusion list.␊ - */␊ - exclusions?: (ApplicationGatewayFirewallExclusion6[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allows to disable rules within a rule group or an entire rule group.␊ - */␊ - export interface ApplicationGatewayFirewallDisabledRuleGroup15 {␊ - /**␊ - * The name of the rule group that will be disabled.␊ - */␊ - ruleGroupName: string␊ - /**␊ - * The list of rules that will be disabled. If null, all rules of the rule group will be disabled.␊ - */␊ - rules?: (number[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allow to exclude some variable satisfy the condition for the WAF check.␊ - */␊ - export interface ApplicationGatewayFirewallExclusion6 {␊ - /**␊ - * The variable to be excluded.␊ - */␊ - matchVariable: string␊ - /**␊ - * When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to.␊ - */␊ - selectorMatchOperator: string␊ - /**␊ - * When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to.␊ - */␊ - selector: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application Gateway autoscale configuration.␊ - */␊ - export interface ApplicationGatewayAutoscaleConfiguration9 {␊ - /**␊ - * Lower bound on number of Application Gateway capacity.␊ - */␊ - minCapacity: (number | string)␊ - /**␊ - * Upper bound on number of Application Gateway capacity.␊ - */␊ - maxCapacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the resource.␊ - */␊ - export interface ManagedServiceIdentity5 {␊ - /**␊ - * The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.␊ - */␊ - type?: ("SystemAssigned" | "UserAssigned" | "SystemAssigned, UserAssigned" | "None")␊ - /**␊ - * The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.␊ - */␊ - userAssignedIdentities?: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies␊ - */␊ - export interface ApplicationGatewayWebApplicationFirewallPolicies3 {␊ - name: string␊ - type: "Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the web application firewall policy.␊ - */␊ - properties: (WebApplicationFirewallPolicyPropertiesFormat3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines web application firewall policy properties.␊ - */␊ - export interface WebApplicationFirewallPolicyPropertiesFormat3 {␊ - /**␊ - * Describes policySettings for policy.␊ - */␊ - policySettings?: (PolicySettings5 | string)␊ - /**␊ - * Describes custom rules inside the policy.␊ - */␊ - customRules?: (WebApplicationFirewallCustomRule3[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines contents of a web application firewall global configuration.␊ - */␊ - export interface PolicySettings5 {␊ - /**␊ - * Describes if the policy is in enabled state or disabled state.␊ - */␊ - enabledState?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * Describes if it is in detection mode or prevention mode at policy level.␊ - */␊ - mode?: (("Prevention" | "Detection") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines contents of a web application rule.␊ - */␊ - export interface WebApplicationFirewallCustomRule3 {␊ - /**␊ - * The name of the resource that is unique within a policy. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value.␊ - */␊ - priority: (number | string)␊ - /**␊ - * Describes type of rule.␊ - */␊ - ruleType: (("MatchRule" | "Invalid") | string)␊ - /**␊ - * List of match conditions.␊ - */␊ - matchConditions: (MatchCondition5[] | string)␊ - /**␊ - * Type of Actions.␊ - */␊ - action: (("Allow" | "Block" | "Log") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Define match conditions.␊ - */␊ - export interface MatchCondition5 {␊ - /**␊ - * List of match variables.␊ - */␊ - matchVariables: (MatchVariable3[] | string)␊ - /**␊ - * Describes operator to be matched.␊ - */␊ - operator: (("IPMatch" | "Equal" | "Contains" | "LessThan" | "GreaterThan" | "LessThanOrEqual" | "GreaterThanOrEqual" | "BeginsWith" | "EndsWith" | "Regex") | string)␊ - /**␊ - * Describes if this is negate condition or not.␊ - */␊ - negationConditon?: (boolean | string)␊ - /**␊ - * Match value.␊ - */␊ - matchValues: (string[] | string)␊ - /**␊ - * List of transforms.␊ - */␊ - transforms?: (("Lowercase" | "Trim" | "UrlDecode" | "UrlEncode" | "RemoveNulls" | "HtmlEntityDecode")[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Define match variables.␊ - */␊ - export interface MatchVariable3 {␊ - /**␊ - * Match Variable.␊ - */␊ - variableName: (("RemoteAddr" | "RequestMethod" | "QueryString" | "PostArgs" | "RequestUri" | "RequestHeaders" | "RequestBody" | "RequestCookies") | string)␊ - /**␊ - * Describes field of the matchVariable collection.␊ - */␊ - selector?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/applicationSecurityGroups␊ - */␊ - export interface ApplicationSecurityGroups15 {␊ - name: string␊ - type: "Microsoft.Network/applicationSecurityGroups"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the application security group.␊ - */␊ - properties: (ApplicationSecurityGroupPropertiesFormat2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application security group properties.␊ - */␊ - export interface ApplicationSecurityGroupPropertiesFormat2 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/azureFirewalls␊ - */␊ - export interface AzureFirewalls5 {␊ - name: string␊ - type: "Microsoft.Network/azureFirewalls"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the azure firewall.␊ - */␊ - properties: (AzureFirewallPropertiesFormat5 | string)␊ - /**␊ - * A list of availability zones denoting where the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Azure Firewall.␊ - */␊ - export interface AzureFirewallPropertiesFormat5 {␊ - /**␊ - * Collection of application rule collections used by Azure Firewall.␊ - */␊ - applicationRuleCollections?: (AzureFirewallApplicationRuleCollection5[] | string)␊ - /**␊ - * Collection of NAT rule collections used by Azure Firewall.␊ - */␊ - natRuleCollections?: (AzureFirewallNatRuleCollection2[] | string)␊ - /**␊ - * Collection of network rule collections used by Azure Firewall.␊ - */␊ - networkRuleCollections?: (AzureFirewallNetworkRuleCollection5[] | string)␊ - /**␊ - * IP configuration of the Azure Firewall resource.␊ - */␊ - ipConfigurations?: (AzureFirewallIPConfiguration5[] | string)␊ - /**␊ - * The operation mode for Threat Intelligence.␊ - */␊ - threatIntelMode?: (("Alert" | "Deny" | "Off") | string)␊ - /**␊ - * The virtualHub to which the firewall belongs.␊ - */␊ - virtualHub?: (SubResource25 | string)␊ - /**␊ - * The firewallPolicy associated with this azure firewall.␊ - */␊ - firewallPolicy?: (SubResource25 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application rule collection resource.␊ - */␊ - export interface AzureFirewallApplicationRuleCollection5 {␊ - /**␊ - * Properties of the azure firewall application rule collection.␊ - */␊ - properties?: (AzureFirewallApplicationRuleCollectionPropertiesFormat5 | string)␊ - /**␊ - * The name of the resource that is unique within the Azure firewall. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application rule collection.␊ - */␊ - export interface AzureFirewallApplicationRuleCollectionPropertiesFormat5 {␊ - /**␊ - * Priority of the application rule collection resource.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * The action type of a rule collection.␊ - */␊ - action?: (AzureFirewallRCAction5 | string)␊ - /**␊ - * Collection of rules used by a application rule collection.␊ - */␊ - rules?: (AzureFirewallApplicationRule5[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the AzureFirewallRCAction.␊ - */␊ - export interface AzureFirewallRCAction5 {␊ - /**␊ - * The type of action.␊ - */␊ - type?: ("Allow" | "Deny")␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of an application rule.␊ - */␊ - export interface AzureFirewallApplicationRule5 {␊ - /**␊ - * Name of the application rule.␊ - */␊ - name?: string␊ - /**␊ - * Description of the rule.␊ - */␊ - description?: string␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * Array of ApplicationRuleProtocols.␊ - */␊ - protocols?: (AzureFirewallApplicationRuleProtocol5[] | string)␊ - /**␊ - * List of FQDNs for this rule.␊ - */␊ - targetFqdns?: (string[] | string)␊ - /**␊ - * List of FQDN Tags for this rule.␊ - */␊ - fqdnTags?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application rule protocol.␊ - */␊ - export interface AzureFirewallApplicationRuleProtocol5 {␊ - /**␊ - * Protocol type.␊ - */␊ - protocolType?: (("Http" | "Https" | "Mssql") | string)␊ - /**␊ - * Port number for the protocol, cannot be greater than 64000. This field is optional.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NAT rule collection resource.␊ - */␊ - export interface AzureFirewallNatRuleCollection2 {␊ - /**␊ - * Properties of the azure firewall NAT rule collection.␊ - */␊ - properties?: (AzureFirewallNatRuleCollectionProperties2 | string)␊ - /**␊ - * The name of the resource that is unique within the Azure firewall. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the NAT rule collection.␊ - */␊ - export interface AzureFirewallNatRuleCollectionProperties2 {␊ - /**␊ - * Priority of the NAT rule collection resource.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * The action type of a NAT rule collection.␊ - */␊ - action?: (AzureFirewallNatRCAction2 | string)␊ - /**␊ - * Collection of rules used by a NAT rule collection.␊ - */␊ - rules?: (AzureFirewallNatRule2[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AzureFirewall NAT Rule Collection Action.␊ - */␊ - export interface AzureFirewallNatRCAction2 {␊ - /**␊ - * The type of action.␊ - */␊ - type?: ("Snat" | "Dnat")␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a NAT rule.␊ - */␊ - export interface AzureFirewallNatRule2 {␊ - /**␊ - * Name of the NAT rule.␊ - */␊ - name?: string␊ - /**␊ - * Description of the rule.␊ - */␊ - description?: string␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags.␊ - */␊ - destinationAddresses?: (string[] | string)␊ - /**␊ - * List of destination ports.␊ - */␊ - destinationPorts?: (string[] | string)␊ - /**␊ - * Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule.␊ - */␊ - protocols?: (("TCP" | "UDP" | "Any" | "ICMP")[] | string)␊ - /**␊ - * The translated address for this NAT rule.␊ - */␊ - translatedAddress?: string␊ - /**␊ - * The translated port for this NAT rule.␊ - */␊ - translatedPort?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network rule collection resource.␊ - */␊ - export interface AzureFirewallNetworkRuleCollection5 {␊ - /**␊ - * Properties of the azure firewall network rule collection.␊ - */␊ - properties?: (AzureFirewallNetworkRuleCollectionPropertiesFormat5 | string)␊ - /**␊ - * The name of the resource that is unique within the Azure firewall. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the network rule collection.␊ - */␊ - export interface AzureFirewallNetworkRuleCollectionPropertiesFormat5 {␊ - /**␊ - * Priority of the network rule collection resource.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * The action type of a rule collection.␊ - */␊ - action?: (AzureFirewallRCAction5 | string)␊ - /**␊ - * Collection of rules used by a network rule collection.␊ - */␊ - rules?: (AzureFirewallNetworkRule5[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the network rule.␊ - */␊ - export interface AzureFirewallNetworkRule5 {␊ - /**␊ - * Name of the network rule.␊ - */␊ - name?: string␊ - /**␊ - * Description of the rule.␊ - */␊ - description?: string␊ - /**␊ - * Array of AzureFirewallNetworkRuleProtocols.␊ - */␊ - protocols?: (("TCP" | "UDP" | "Any" | "ICMP")[] | string)␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * List of destination IP addresses.␊ - */␊ - destinationAddresses?: (string[] | string)␊ - /**␊ - * List of destination ports.␊ - */␊ - destinationPorts?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration of an Azure Firewall.␊ - */␊ - export interface AzureFirewallIPConfiguration5 {␊ - /**␊ - * Properties of the azure firewall IP configuration.␊ - */␊ - properties?: (AzureFirewallIPConfigurationPropertiesFormat5 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration of an Azure Firewall.␊ - */␊ - export interface AzureFirewallIPConfigurationPropertiesFormat5 {␊ - /**␊ - * Reference of the subnet resource. This resource must be named 'AzureFirewallSubnet'.␊ - */␊ - subnet?: (SubResource25 | string)␊ - /**␊ - * Reference of the PublicIP resource. This field is a mandatory input if subnet is not null.␊ - */␊ - publicIPAddress?: (SubResource25 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/bastionHosts␊ - */␊ - export interface BastionHosts2 {␊ - name: string␊ - type: "Microsoft.Network/bastionHosts"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Represents the bastion host resource.␊ - */␊ - properties: (BastionHostPropertiesFormat2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Bastion Host.␊ - */␊ - export interface BastionHostPropertiesFormat2 {␊ - /**␊ - * IP configuration of the Bastion Host resource.␊ - */␊ - ipConfigurations?: (BastionHostIPConfiguration2[] | string)␊ - /**␊ - * FQDN for the endpoint on which bastion host is accessible.␊ - */␊ - dnsName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration of an Bastion Host.␊ - */␊ - export interface BastionHostIPConfiguration2 {␊ - /**␊ - * Represents the ip configuration associated with the resource.␊ - */␊ - properties?: (BastionHostIPConfigurationPropertiesFormat2 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration of an Bastion Host.␊ - */␊ - export interface BastionHostIPConfigurationPropertiesFormat2 {␊ - /**␊ - * Reference of the subnet resource.␊ - */␊ - subnet: (SubResource25 | string)␊ - /**␊ - * Reference of the PublicIP resource.␊ - */␊ - publicIPAddress: (SubResource25 | string)␊ - /**␊ - * Private IP allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/connections␊ - */␊ - export interface Connections15 {␊ - name: string␊ - type: "Microsoft.Network/connections"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway connection.␊ - */␊ - properties: (VirtualNetworkGatewayConnectionPropertiesFormat15 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewayConnection properties.␊ - */␊ - export interface VirtualNetworkGatewayConnectionPropertiesFormat15 {␊ - /**␊ - * The authorizationKey.␊ - */␊ - authorizationKey?: string␊ - /**␊ - * The reference to virtual network gateway resource.␊ - */␊ - virtualNetworkGateway1: (SubResource25 | string)␊ - /**␊ - * The reference to virtual network gateway resource.␊ - */␊ - virtualNetworkGateway2?: (SubResource25 | string)␊ - /**␊ - * The reference to local network gateway resource.␊ - */␊ - localNetworkGateway2?: (SubResource25 | string)␊ - /**␊ - * Gateway connection type.␊ - */␊ - connectionType: (("IPsec" | "Vnet2Vnet" | "ExpressRoute" | "VPNClient") | string)␊ - /**␊ - * Connection protocol used for this connection.␊ - */␊ - connectionProtocol?: (("IKEv2" | "IKEv1") | string)␊ - /**␊ - * The routing weight.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * The IPSec shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The reference to peerings resource.␊ - */␊ - peer?: (SubResource25 | string)␊ - /**␊ - * EnableBgp flag.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * Enable policy-based traffic selectors.␊ - */␊ - usePolicyBasedTrafficSelectors?: (boolean | string)␊ - /**␊ - * The IPSec Policies to be considered by this connection.␊ - */␊ - ipsecPolicies?: (IpsecPolicy12[] | string)␊ - /**␊ - * The Traffic Selector Policies to be considered by this connection.␊ - */␊ - trafficSelectorPolicies?: (TrafficSelectorPolicy[] | string)␊ - /**␊ - * Bypass ExpressRoute Gateway for data forwarding.␊ - */␊ - expressRouteGatewayBypass?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An IPSec Policy configuration for a virtual network gateway connection.␊ - */␊ - export interface IpsecPolicy12 {␊ - /**␊ - * The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.␊ - */␊ - saLifeTimeSeconds: (number | string)␊ - /**␊ - * The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.␊ - */␊ - saDataSizeKilobytes: (number | string)␊ - /**␊ - * The IPSec encryption algorithm (IKE phase 1).␊ - */␊ - ipsecEncryption: (("None" | "DES" | "DES3" | "AES128" | "AES192" | "AES256" | "GCMAES128" | "GCMAES192" | "GCMAES256") | string)␊ - /**␊ - * The IPSec integrity algorithm (IKE phase 1).␊ - */␊ - ipsecIntegrity: (("MD5" | "SHA1" | "SHA256" | "GCMAES128" | "GCMAES192" | "GCMAES256") | string)␊ - /**␊ - * The IKE encryption algorithm (IKE phase 2).␊ - */␊ - ikeEncryption: (("DES" | "DES3" | "AES128" | "AES192" | "AES256" | "GCMAES256" | "GCMAES128") | string)␊ - /**␊ - * The IKE integrity algorithm (IKE phase 2).␊ - */␊ - ikeIntegrity: (("MD5" | "SHA1" | "SHA256" | "SHA384" | "GCMAES256" | "GCMAES128") | string)␊ - /**␊ - * The DH Group used in IKE Phase 1 for initial SA.␊ - */␊ - dhGroup: (("None" | "DHGroup1" | "DHGroup2" | "DHGroup14" | "DHGroup2048" | "ECP256" | "ECP384" | "DHGroup24") | string)␊ - /**␊ - * The Pfs Group used in IKE Phase 2 for new child SA.␊ - */␊ - pfsGroup: (("None" | "PFS1" | "PFS2" | "PFS2048" | "ECP256" | "ECP384" | "PFS24" | "PFS14" | "PFSMM") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An traffic selector policy for a virtual network gateway connection.␊ - */␊ - export interface TrafficSelectorPolicy {␊ - /**␊ - * A collection of local address spaces in CIDR format␊ - */␊ - localAddressRanges: (string[] | string)␊ - /**␊ - * A collection of remote address spaces in CIDR format␊ - */␊ - remoteAddressRanges: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ddosCustomPolicies␊ - */␊ - export interface DdosCustomPolicies2 {␊ - name: string␊ - type: "Microsoft.Network/ddosCustomPolicies"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the DDoS custom policy.␊ - */␊ - properties: (DdosCustomPolicyPropertiesFormat2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DDoS custom policy properties.␊ - */␊ - export interface DdosCustomPolicyPropertiesFormat2 {␊ - /**␊ - * The protocol-specific DDoS policy customization parameters.␊ - */␊ - protocolCustomSettings?: (ProtocolCustomSettingsFormat2[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DDoS custom policy properties.␊ - */␊ - export interface ProtocolCustomSettingsFormat2 {␊ - /**␊ - * The protocol for which the DDoS protection policy is being customized.␊ - */␊ - protocol?: (("Tcp" | "Udp" | "Syn") | string)␊ - /**␊ - * The customized DDoS protection trigger rate.␊ - */␊ - triggerRateOverride?: string␊ - /**␊ - * The customized DDoS protection source rate.␊ - */␊ - sourceRateOverride?: string␊ - /**␊ - * The customized DDoS protection trigger rate sensitivity degrees. High: Trigger rate set with most sensitivity w.r.t. normal traffic. Default: Trigger rate set with moderate sensitivity w.r.t. normal traffic. Low: Trigger rate set with less sensitivity w.r.t. normal traffic. Relaxed: Trigger rate set with least sensitivity w.r.t. normal traffic.␊ - */␊ - triggerSensitivityOverride?: (("Relaxed" | "Low" | "Default" | "High") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ddosProtectionPlans␊ - */␊ - export interface DdosProtectionPlans10 {␊ - name: string␊ - type: "Microsoft.Network/ddosProtectionPlans"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the DDoS protection plan.␊ - */␊ - properties: (DdosProtectionPlanPropertiesFormat7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DDoS protection plan properties.␊ - */␊ - export interface DdosProtectionPlanPropertiesFormat7 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits␊ - */␊ - export interface ExpressRouteCircuits12 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The SKU.␊ - */␊ - sku?: (ExpressRouteCircuitSku12 | string)␊ - /**␊ - * Properties of the express route circuit.␊ - */␊ - properties: (ExpressRouteCircuitPropertiesFormat12 | string)␊ - resources?: (ExpressRouteCircuitsPeeringsChildResource12 | ExpressRouteCircuitsAuthorizationsChildResource12)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains SKU in an ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitSku12 {␊ - /**␊ - * The name of the SKU.␊ - */␊ - name?: string␊ - /**␊ - * The tier of the SKU.␊ - */␊ - tier?: (("Standard" | "Premium" | "Basic" | "Local") | string)␊ - /**␊ - * The family of the SKU.␊ - */␊ - family?: (("UnlimitedData" | "MeteredData") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitPropertiesFormat12 {␊ - /**␊ - * Allow classic operations.␊ - */␊ - allowClassicOperations?: (boolean | string)␊ - /**␊ - * The list of authorizations.␊ - */␊ - authorizations?: (ExpressRouteCircuitAuthorization12[] | string)␊ - /**␊ - * The list of peerings.␊ - */␊ - peerings?: (ExpressRouteCircuitPeering12[] | string)␊ - /**␊ - * The ServiceProviderNotes.␊ - */␊ - serviceProviderNotes?: string␊ - /**␊ - * The ServiceProviderProperties.␊ - */␊ - serviceProviderProperties?: (ExpressRouteCircuitServiceProviderProperties12 | string)␊ - /**␊ - * The reference to the ExpressRoutePort resource when the circuit is provisioned on an ExpressRoutePort resource.␊ - */␊ - expressRoutePort?: (SubResource25 | string)␊ - /**␊ - * The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource.␊ - */␊ - bandwidthInGbps?: (number | string)␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authorization in an ExpressRouteCircuit resource.␊ - */␊ - export interface ExpressRouteCircuitAuthorization12 {␊ - /**␊ - * Properties of the express route circuit authorization.␊ - */␊ - properties?: (AuthorizationPropertiesFormat13 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ExpressRouteCircuitAuthorization.␊ - */␊ - export interface AuthorizationPropertiesFormat13 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peering in an ExpressRouteCircuit resource.␊ - */␊ - export interface ExpressRouteCircuitPeering12 {␊ - /**␊ - * Properties of the express route circuit peering.␊ - */␊ - properties?: (ExpressRouteCircuitPeeringPropertiesFormat13 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the express route circuit peering.␊ - */␊ - export interface ExpressRouteCircuitPeeringPropertiesFormat13 {␊ - /**␊ - * The peering type.␊ - */␊ - peeringType?: (("AzurePublicPeering" | "AzurePrivatePeering" | "MicrosoftPeering") | string)␊ - /**␊ - * The peering state.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * The peer ASN.␊ - */␊ - peerASN?: (number | string)␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The VLAN ID.␊ - */␊ - vlanId?: (number | string)␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig13 | string)␊ - /**␊ - * The peering stats of express route circuit.␊ - */␊ - stats?: (ExpressRouteCircuitStats13 | string)␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - /**␊ - * The reference of the RouteFilter resource.␊ - */␊ - routeFilter?: (SubResource25 | string)␊ - /**␊ - * The IPv6 peering configuration.␊ - */␊ - ipv6PeeringConfig?: (Ipv6ExpressRouteCircuitPeeringConfig10 | string)␊ - /**␊ - * The ExpressRoute connection.␊ - */␊ - expressRouteConnection?: (SubResource25 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the peering configuration.␊ - */␊ - export interface ExpressRouteCircuitPeeringConfig13 {␊ - /**␊ - * The reference of AdvertisedPublicPrefixes.␊ - */␊ - advertisedPublicPrefixes?: (string[] | string)␊ - /**␊ - * The communities of bgp peering. Specified for microsoft peering.␊ - */␊ - advertisedCommunities?: (string[] | string)␊ - /**␊ - * The legacy mode of the peering.␊ - */␊ - legacyMode?: (number | string)␊ - /**␊ - * The CustomerASN of the peering.␊ - */␊ - customerASN?: (number | string)␊ - /**␊ - * The RoutingRegistryName of the configuration.␊ - */␊ - routingRegistryName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains stats associated with the peering.␊ - */␊ - export interface ExpressRouteCircuitStats13 {␊ - /**␊ - * The Primary BytesIn of the peering.␊ - */␊ - primarybytesIn?: (number | string)␊ - /**␊ - * The primary BytesOut of the peering.␊ - */␊ - primarybytesOut?: (number | string)␊ - /**␊ - * The secondary BytesIn of the peering.␊ - */␊ - secondarybytesIn?: (number | string)␊ - /**␊ - * The secondary BytesOut of the peering.␊ - */␊ - secondarybytesOut?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains IPv6 peering config.␊ - */␊ - export interface Ipv6ExpressRouteCircuitPeeringConfig10 {␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig13 | string)␊ - /**␊ - * The reference of the RouteFilter resource.␊ - */␊ - routeFilter?: (SubResource25 | string)␊ - /**␊ - * The state of peering.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains ServiceProviderProperties in an ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitServiceProviderProperties12 {␊ - /**␊ - * The serviceProviderName.␊ - */␊ - serviceProviderName?: string␊ - /**␊ - * The peering location.␊ - */␊ - peeringLocation?: string␊ - /**␊ - * The BandwidthInMbps.␊ - */␊ - bandwidthInMbps?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings␊ - */␊ - export interface ExpressRouteCircuitsPeeringsChildResource12 {␊ - name: string␊ - type: "peerings"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Properties of the express route circuit peering.␊ - */␊ - properties: (ExpressRouteCircuitPeeringPropertiesFormat13 | string)␊ - resources?: ExpressRouteCircuitsPeeringsConnectionsChildResource10[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings/connections␊ - */␊ - export interface ExpressRouteCircuitsPeeringsConnectionsChildResource10 {␊ - name: string␊ - type: "connections"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Properties of the express route circuit connection.␊ - */␊ - properties: (ExpressRouteCircuitConnectionPropertiesFormat10 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the express route circuit connection.␊ - */␊ - export interface ExpressRouteCircuitConnectionPropertiesFormat10 {␊ - /**␊ - * Reference to Express Route Circuit Private Peering Resource of the circuit initiating connection.␊ - */␊ - expressRouteCircuitPeering?: (SubResource25 | string)␊ - /**␊ - * Reference to Express Route Circuit Private Peering Resource of the peered circuit.␊ - */␊ - peerExpressRouteCircuitPeering?: (SubResource25 | string)␊ - /**␊ - * /29 IP address space to carve out Customer addresses for tunnels.␊ - */␊ - addressPrefix?: string␊ - /**␊ - * The authorization key.␊ - */␊ - authorizationKey?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/authorizations␊ - */␊ - export interface ExpressRouteCircuitsAuthorizationsChildResource12 {␊ - name: string␊ - type: "authorizations"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Properties of the express route circuit authorization.␊ - */␊ - properties: (AuthorizationPropertiesFormat13 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/authorizations␊ - */␊ - export interface ExpressRouteCircuitsAuthorizations13 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/authorizations"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Properties of the express route circuit authorization.␊ - */␊ - properties: (AuthorizationPropertiesFormat13 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings␊ - */␊ - export interface ExpressRouteCircuitsPeerings12 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/peerings"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Properties of the express route circuit peering.␊ - */␊ - properties: (ExpressRouteCircuitPeeringPropertiesFormat13 | string)␊ - resources?: ExpressRouteCircuitsPeeringsConnectionsChildResource10[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings/connections␊ - */␊ - export interface ExpressRouteCircuitsPeeringsConnections10 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/peerings/connections"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Properties of the express route circuit connection.␊ - */␊ - properties: (ExpressRouteCircuitConnectionPropertiesFormat10 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections␊ - */␊ - export interface ExpressRouteCrossConnections10 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCrossConnections"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the express route cross connection.␊ - */␊ - properties: (ExpressRouteCrossConnectionProperties10 | string)␊ - resources?: ExpressRouteCrossConnectionsPeeringsChildResource10[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ExpressRouteCrossConnection.␊ - */␊ - export interface ExpressRouteCrossConnectionProperties10 {␊ - /**␊ - * The peering location of the ExpressRoute circuit.␊ - */␊ - peeringLocation?: string␊ - /**␊ - * The circuit bandwidth In Mbps.␊ - */␊ - bandwidthInMbps?: (number | string)␊ - /**␊ - * The ExpressRouteCircuit.␊ - */␊ - expressRouteCircuit?: (SubResource25 | string)␊ - /**␊ - * The provisioning state of the circuit in the connectivity provider system.␊ - */␊ - serviceProviderProvisioningState?: (("NotProvisioned" | "Provisioning" | "Provisioned" | "Deprovisioning") | string)␊ - /**␊ - * Additional read only notes set by the connectivity provider.␊ - */␊ - serviceProviderNotes?: string␊ - /**␊ - * The list of peerings.␊ - */␊ - peerings?: (ExpressRouteCrossConnectionPeering10[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peering in an ExpressRoute Cross Connection resource.␊ - */␊ - export interface ExpressRouteCrossConnectionPeering10 {␊ - /**␊ - * Properties of the express route cross connection peering.␊ - */␊ - properties?: (ExpressRouteCrossConnectionPeeringProperties10 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of express route cross connection peering.␊ - */␊ - export interface ExpressRouteCrossConnectionPeeringProperties10 {␊ - /**␊ - * The peering type.␊ - */␊ - peeringType?: (("AzurePublicPeering" | "AzurePrivatePeering" | "MicrosoftPeering") | string)␊ - /**␊ - * The peering state.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * The peer ASN.␊ - */␊ - peerASN?: (number | string)␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The VLAN ID.␊ - */␊ - vlanId?: (number | string)␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig13 | string)␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - /**␊ - * The IPv6 peering configuration.␊ - */␊ - ipv6PeeringConfig?: (Ipv6ExpressRouteCircuitPeeringConfig10 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections/peerings␊ - */␊ - export interface ExpressRouteCrossConnectionsPeeringsChildResource10 {␊ - name: string␊ - type: "peerings"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Properties of the express route cross connection peering.␊ - */␊ - properties: (ExpressRouteCrossConnectionPeeringProperties10 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections/peerings␊ - */␊ - export interface ExpressRouteCrossConnectionsPeerings9 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCrossConnections/peerings"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Properties of the express route cross connection peering.␊ - */␊ - properties: (ExpressRouteCrossConnectionPeeringProperties10 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteGateways␊ - */␊ - export interface ExpressRouteGateways2 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteGateways"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the express route gateway.␊ - */␊ - properties: (ExpressRouteGatewayProperties2 | string)␊ - resources?: ExpressRouteGatewaysExpressRouteConnectionsChildResource2[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ExpressRoute gateway resource properties.␊ - */␊ - export interface ExpressRouteGatewayProperties2 {␊ - /**␊ - * Configuration for auto scaling.␊ - */␊ - autoScaleConfiguration?: (ExpressRouteGatewayPropertiesAutoScaleConfiguration2 | string)␊ - /**␊ - * The Virtual Hub where the ExpressRoute gateway is or will be deployed.␊ - */␊ - virtualHub: (SubResource25 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Configuration for auto scaling.␊ - */␊ - export interface ExpressRouteGatewayPropertiesAutoScaleConfiguration2 {␊ - /**␊ - * Minimum and maximum number of scale units to deploy.␊ - */␊ - bounds?: (ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Minimum and maximum number of scale units to deploy.␊ - */␊ - export interface ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds2 {␊ - /**␊ - * Minimum number of scale units deployed for ExpressRoute gateway.␊ - */␊ - min?: (number | string)␊ - /**␊ - * Maximum number of scale units deployed for ExpressRoute gateway.␊ - */␊ - max?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteGateways/expressRouteConnections␊ - */␊ - export interface ExpressRouteGatewaysExpressRouteConnectionsChildResource2 {␊ - name: string␊ - type: "expressRouteConnections"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Properties of the express route connection.␊ - */␊ - properties: (ExpressRouteConnectionProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the ExpressRouteConnection subresource.␊ - */␊ - export interface ExpressRouteConnectionProperties2 {␊ - /**␊ - * The ExpressRoute circuit peering.␊ - */␊ - expressRouteCircuitPeering: (SubResource25 | string)␊ - /**␊ - * Authorization key to establish the connection.␊ - */␊ - authorizationKey?: string␊ - /**␊ - * The routing weight associated to the connection.␊ - */␊ - routingWeight?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteGateways/expressRouteConnections␊ - */␊ - export interface ExpressRouteGatewaysExpressRouteConnections2 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteGateways/expressRouteConnections"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Properties of the express route connection.␊ - */␊ - properties: (ExpressRouteConnectionProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ExpressRoutePorts␊ - */␊ - export interface ExpressRoutePorts5 {␊ - name: string␊ - type: "Microsoft.Network/ExpressRoutePorts"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * ExpressRoutePort properties.␊ - */␊ - properties: (ExpressRoutePortPropertiesFormat5 | string)␊ - /**␊ - * The identity of ExpressRoutePort, if configured.␊ - */␊ - identity?: (ManagedServiceIdentity5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to ExpressRoutePort resources.␊ - */␊ - export interface ExpressRoutePortPropertiesFormat5 {␊ - /**␊ - * The name of the peering location that the ExpressRoutePort is mapped to physically.␊ - */␊ - peeringLocation?: string␊ - /**␊ - * Bandwidth of procured ports in Gbps.␊ - */␊ - bandwidthInGbps?: (number | string)␊ - /**␊ - * Encapsulation method on physical ports.␊ - */␊ - encapsulation?: (("Dot1Q" | "QinQ") | string)␊ - /**␊ - * The set of physical links of the ExpressRoutePort resource.␊ - */␊ - links?: (ExpressRouteLink5[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ExpressRouteLink child resource definition.␊ - */␊ - export interface ExpressRouteLink5 {␊ - /**␊ - * ExpressRouteLink properties.␊ - */␊ - properties?: (ExpressRouteLinkPropertiesFormat5 | string)␊ - /**␊ - * Name of child port resource that is unique among child port resources of the parent.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to ExpressRouteLink resources.␊ - */␊ - export interface ExpressRouteLinkPropertiesFormat5 {␊ - /**␊ - * Administrative state of the physical port.␊ - */␊ - adminState?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * MacSec configuration.␊ - */␊ - macSecConfig?: (ExpressRouteLinkMacSecConfig | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ExpressRouteLink Mac Security Configuration.␊ - */␊ - export interface ExpressRouteLinkMacSecConfig {␊ - /**␊ - * Keyvault Secret Identifier URL containing Mac security CKN key.␊ - */␊ - cknSecretIdentifier?: string␊ - /**␊ - * Keyvault Secret Identifier URL containing Mac security CAK key.␊ - */␊ - cakSecretIdentifier?: string␊ - /**␊ - * Mac security cipher.␊ - */␊ - cipher?: (("gcm-aes-128" | "gcm-aes-256") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/firewallPolicies␊ - */␊ - export interface FirewallPolicies1 {␊ - name: string␊ - type: "Microsoft.Network/firewallPolicies"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the firewall policy.␊ - */␊ - properties: (FirewallPolicyPropertiesFormat1 | string)␊ - resources?: FirewallPoliciesRuleGroupsChildResource1[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Firewall Policy definition.␊ - */␊ - export interface FirewallPolicyPropertiesFormat1 {␊ - /**␊ - * The parent firewall policy from which rules are inherited.␊ - */␊ - basePolicy?: (SubResource25 | string)␊ - /**␊ - * The operation mode for Threat Intelligence.␊ - */␊ - threatIntelMode?: (("Alert" | "Deny" | "Off") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/firewallPolicies/ruleGroups␊ - */␊ - export interface FirewallPoliciesRuleGroupsChildResource1 {␊ - name: string␊ - type: "ruleGroups"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * The properties of the firewall policy rule group.␊ - */␊ - properties: (FirewallPolicyRuleGroupProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the rule group.␊ - */␊ - export interface FirewallPolicyRuleGroupProperties1 {␊ - /**␊ - * Priority of the Firewall Policy Rule Group resource.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * Group of Firewall Policy rules.␊ - */␊ - rules?: (FirewallPolicyRule1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the FirewallPolicyNatRuleAction.␊ - */␊ - export interface FirewallPolicyNatRuleAction1 {␊ - /**␊ - * The type of action.␊ - */␊ - type?: ("DNAT" | "SNAT")␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application rule protocol.␊ - */␊ - export interface FirewallPolicyRuleConditionApplicationProtocol1 {␊ - /**␊ - * Protocol type.␊ - */␊ - protocolType?: (("Http" | "Https") | string)␊ - /**␊ - * Port number for the protocol, cannot be greater than 64000.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the FirewallPolicyFilterRuleAction.␊ - */␊ - export interface FirewallPolicyFilterRuleAction1 {␊ - /**␊ - * The type of action.␊ - */␊ - type?: ("Allow" | "Deny" | "Alert ")␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/firewallPolicies/ruleGroups␊ - */␊ - export interface FirewallPoliciesRuleGroups1 {␊ - name: string␊ - type: "Microsoft.Network/firewallPolicies/ruleGroups"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * The properties of the firewall policy rule group.␊ - */␊ - properties: (FirewallPolicyRuleGroupProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers␊ - */␊ - export interface LoadBalancers27 {␊ - name: string␊ - type: "Microsoft.Network/loadBalancers"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The load balancer SKU.␊ - */␊ - sku?: (LoadBalancerSku15 | string)␊ - /**␊ - * Properties of load balancer.␊ - */␊ - properties: (LoadBalancerPropertiesFormat19 | string)␊ - resources?: LoadBalancersInboundNatRulesChildResource15[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a load balancer.␊ - */␊ - export interface LoadBalancerSku15 {␊ - /**␊ - * Name of a load balancer SKU.␊ - */␊ - name?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer.␊ - */␊ - export interface LoadBalancerPropertiesFormat19 {␊ - /**␊ - * Object representing the frontend IPs to be used for the load balancer.␊ - */␊ - frontendIPConfigurations?: (FrontendIPConfiguration18[] | string)␊ - /**␊ - * Collection of backend address pools used by a load balancer.␊ - */␊ - backendAddressPools?: (BackendAddressPool19[] | string)␊ - /**␊ - * Object collection representing the load balancing rules Gets the provisioning.␊ - */␊ - loadBalancingRules?: (LoadBalancingRule19[] | string)␊ - /**␊ - * Collection of probe objects used in the load balancer.␊ - */␊ - probes?: (Probe19[] | string)␊ - /**␊ - * Collection of inbound NAT Rules used by a load balancer. Defining inbound NAT rules on your load balancer is mutually exclusive with defining an inbound NAT pool. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an Inbound NAT pool. They have to reference individual inbound NAT rules.␊ - */␊ - inboundNatRules?: (InboundNatRule20[] | string)␊ - /**␊ - * Defines an external port range for inbound NAT to a single backend port on NICs associated with a load balancer. Inbound NAT rules are created automatically for each NIC associated with the Load Balancer using an external port from this range. Defining an Inbound NAT pool on your Load Balancer is mutually exclusive with defining inbound Nat rules. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an inbound NAT pool. They have to reference individual inbound NAT rules.␊ - */␊ - inboundNatPools?: (InboundNatPool20[] | string)␊ - /**␊ - * The outbound rules.␊ - */␊ - outboundRules?: (OutboundRule7[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP address of the load balancer.␊ - */␊ - export interface FrontendIPConfiguration18 {␊ - /**␊ - * Properties of the load balancer probe.␊ - */␊ - properties?: (FrontendIPConfigurationPropertiesFormat18 | string)␊ - /**␊ - * The name of the resource that is unique within the set of frontend IP configurations used by the load balancer. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP Configuration of the load balancer.␊ - */␊ - export interface FrontendIPConfigurationPropertiesFormat18 {␊ - /**␊ - * The private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The Private IP allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4.␊ - */␊ - privateIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The reference of the subnet resource.␊ - */␊ - subnet?: (SubResource25 | string)␊ - /**␊ - * The reference of the Public IP resource.␊ - */␊ - publicIPAddress?: (SubResource25 | string)␊ - /**␊ - * The reference of the Public IP Prefix resource.␊ - */␊ - publicIPPrefix?: (SubResource25 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Pool of backend IP addresses.␊ - */␊ - export interface BackendAddressPool19 {␊ - /**␊ - * Properties of load balancer backend address pool.␊ - */␊ - properties?: (BackendAddressPoolPropertiesFormat19 | string)␊ - /**␊ - * The name of the resource that is unique within the set of backend address pools used by the load balancer. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the backend address pool.␊ - */␊ - export interface BackendAddressPoolPropertiesFormat19 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A load balancing rule for a load balancer.␊ - */␊ - export interface LoadBalancingRule19 {␊ - /**␊ - * Properties of load balancer load balancing rule.␊ - */␊ - properties?: (LoadBalancingRulePropertiesFormat19 | string)␊ - /**␊ - * The name of the resource that is unique within the set of load balancing rules used by the load balancer. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer.␊ - */␊ - export interface LoadBalancingRulePropertiesFormat19 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource25 | string)␊ - /**␊ - * A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs.␊ - */␊ - backendAddressPool?: (SubResource25 | string)␊ - /**␊ - * The reference of the load balancer probe used by the load balancing rule.␊ - */␊ - probe?: (SubResource25 | string)␊ - /**␊ - * The reference to the transport protocol used by the load balancing rule.␊ - */␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The load distribution policy for this rule.␊ - */␊ - loadDistribution?: (("Default" | "SourceIP" | "SourceIPProtocol") | string)␊ - /**␊ - * The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 0 and 65534. Note that value 0 enables "Any Port".␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port".␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - /**␊ - * Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule.␊ - */␊ - disableOutboundSnat?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A load balancer probe.␊ - */␊ - export interface Probe19 {␊ - /**␊ - * Properties of load balancer probe.␊ - */␊ - properties?: (ProbePropertiesFormat19 | string)␊ - /**␊ - * The name of the resource that is unique within the set of probes used by the load balancer. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Load balancer probe resource.␊ - */␊ - export interface ProbePropertiesFormat19 {␊ - /**␊ - * The protocol of the end point. If 'Tcp' is specified, a received ACK is required for the probe to be successful. If 'Http' or 'Https' is specified, a 200 OK response from the specifies URI is required for the probe to be successful.␊ - */␊ - protocol: (("Http" | "Tcp" | "Https") | string)␊ - /**␊ - * The port for communicating the probe. Possible values range from 1 to 65535, inclusive.␊ - */␊ - port: (number | string)␊ - /**␊ - * The interval, in seconds, for how frequently to probe the endpoint for health status. Typically, the interval is slightly less than half the allocated timeout period (in seconds) which allows two full probes before taking the instance out of rotation. The default value is 15, the minimum value is 5.␊ - */␊ - intervalInSeconds?: (number | string)␊ - /**␊ - * The number of probes where if no response, will result in stopping further traffic from being delivered to the endpoint. This values allows endpoints to be taken out of rotation faster or slower than the typical times used in Azure.␊ - */␊ - numberOfProbes: (number | string)␊ - /**␊ - * The URI used for requesting health status from the VM. Path is required if a protocol is set to http. Otherwise, it is not allowed. There is no default value.␊ - */␊ - requestPath?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT rule of the load balancer.␊ - */␊ - export interface InboundNatRule20 {␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties?: (InboundNatRulePropertiesFormat19 | string)␊ - /**␊ - * The name of the resource that is unique within the set of inbound NAT rules used by the load balancer. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the inbound NAT rule.␊ - */␊ - export interface InboundNatRulePropertiesFormat19 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource25 | string)␊ - /**␊ - * The reference to the transport protocol used by the load balancing rule.␊ - */␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values range from 1 to 65534.␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * The port used for the internal endpoint. Acceptable values range from 1 to 65535.␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT pool of the load balancer.␊ - */␊ - export interface InboundNatPool20 {␊ - /**␊ - * Properties of load balancer inbound nat pool.␊ - */␊ - properties?: (InboundNatPoolPropertiesFormat19 | string)␊ - /**␊ - * The name of the resource that is unique within the set of inbound NAT pools used by the load balancer. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Inbound NAT pool.␊ - */␊ - export interface InboundNatPoolPropertiesFormat19 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource25 | string)␊ - /**␊ - * The reference to the transport protocol used by the inbound NAT pool.␊ - */␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65534.␊ - */␊ - frontendPortRangeStart: (number | string)␊ - /**␊ - * The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65535.␊ - */␊ - frontendPortRangeEnd: (number | string)␊ - /**␊ - * The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound rule of the load balancer.␊ - */␊ - export interface OutboundRule7 {␊ - /**␊ - * Properties of load balancer outbound rule.␊ - */␊ - properties?: (OutboundRulePropertiesFormat7 | string)␊ - /**␊ - * The name of the resource that is unique within the set of outbound rules used by the load balancer. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound rule of the load balancer.␊ - */␊ - export interface OutboundRulePropertiesFormat7 {␊ - /**␊ - * The number of outbound ports to be used for NAT.␊ - */␊ - allocatedOutboundPorts?: (number | string)␊ - /**␊ - * The Frontend IP addresses of the load balancer.␊ - */␊ - frontendIPConfigurations: (SubResource25[] | string)␊ - /**␊ - * A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs.␊ - */␊ - backendAddressPool: (SubResource25 | string)␊ - /**␊ - * The protocol for the outbound rule in load balancer.␊ - */␊ - protocol: (("Tcp" | "Udp" | "All") | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - /**␊ - * The timeout for the TCP idle connection.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers/inboundNatRules␊ - */␊ - export interface LoadBalancersInboundNatRulesChildResource15 {␊ - name: string␊ - type: "inboundNatRules"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties: (InboundNatRulePropertiesFormat19 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers/inboundNatRules␊ - */␊ - export interface LoadBalancersInboundNatRules14 {␊ - name: string␊ - type: "Microsoft.Network/loadBalancers/inboundNatRules"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties: (InboundNatRulePropertiesFormat19 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/localNetworkGateways␊ - */␊ - export interface LocalNetworkGateways15 {␊ - name: string␊ - type: "Microsoft.Network/localNetworkGateways"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the local network gateway.␊ - */␊ - properties: (LocalNetworkGatewayPropertiesFormat15 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * LocalNetworkGateway properties.␊ - */␊ - export interface LocalNetworkGatewayPropertiesFormat15 {␊ - /**␊ - * Local network site address space.␊ - */␊ - localNetworkAddressSpace?: (AddressSpace27 | string)␊ - /**␊ - * IP address of local network gateway.␊ - */␊ - gatewayIpAddress?: string␊ - /**␊ - * Local network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings14 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.␊ - */␊ - export interface AddressSpace27 {␊ - /**␊ - * A list of address blocks reserved for this virtual network in CIDR notation.␊ - */␊ - addressPrefixes: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * BGP settings details.␊ - */␊ - export interface BgpSettings14 {␊ - /**␊ - * The BGP speaker's ASN.␊ - */␊ - asn?: (number | string)␊ - /**␊ - * The BGP peering address and BGP identifier of this BGP speaker.␊ - */␊ - bgpPeeringAddress?: string␊ - /**␊ - * The weight added to routes learned from this BGP speaker.␊ - */␊ - peerWeight?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/natGateways␊ - */␊ - export interface NatGateways2 {␊ - name: string␊ - type: "Microsoft.Network/natGateways"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The nat gateway SKU.␊ - */␊ - sku?: (NatGatewaySku2 | string)␊ - /**␊ - * Nat Gateway properties.␊ - */␊ - properties: (NatGatewayPropertiesFormat2 | string)␊ - /**␊ - * A list of availability zones denoting the zone in which Nat Gateway should be deployed.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of nat gateway.␊ - */␊ - export interface NatGatewaySku2 {␊ - /**␊ - * Name of Nat Gateway SKU.␊ - */␊ - name?: ("Standard" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Nat Gateway properties.␊ - */␊ - export interface NatGatewayPropertiesFormat2 {␊ - /**␊ - * The idle timeout of the nat gateway.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * An array of public ip addresses associated with the nat gateway resource.␊ - */␊ - publicIpAddresses?: (SubResource25[] | string)␊ - /**␊ - * An array of public ip prefixes associated with the nat gateway resource.␊ - */␊ - publicIpPrefixes?: (SubResource25[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces␊ - */␊ - export interface NetworkInterfaces28 {␊ - name: string␊ - type: "Microsoft.Network/networkInterfaces"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network interface.␊ - */␊ - properties: (NetworkInterfacePropertiesFormat19 | string)␊ - resources?: NetworkInterfacesTapConfigurationsChildResource6[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NetworkInterface properties.␊ - */␊ - export interface NetworkInterfacePropertiesFormat19 {␊ - /**␊ - * The reference of the NetworkSecurityGroup resource.␊ - */␊ - networkSecurityGroup?: (SubResource25 | string)␊ - /**␊ - * A list of IPConfigurations of the network interface.␊ - */␊ - ipConfigurations: (NetworkInterfaceIPConfiguration18[] | string)␊ - /**␊ - * The DNS settings in network interface.␊ - */␊ - dnsSettings?: (NetworkInterfaceDnsSettings27 | string)␊ - /**␊ - * If the network interface is accelerated networking enabled.␊ - */␊ - enableAcceleratedNetworking?: (boolean | string)␊ - /**␊ - * Indicates whether IP forwarding is enabled on this network interface.␊ - */␊ - enableIPForwarding?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IPConfiguration in a network interface.␊ - */␊ - export interface NetworkInterfaceIPConfiguration18 {␊ - /**␊ - * Network interface IP configuration properties.␊ - */␊ - properties?: (NetworkInterfaceIPConfigurationPropertiesFormat18 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration.␊ - */␊ - export interface NetworkInterfaceIPConfigurationPropertiesFormat18 {␊ - /**␊ - * The reference to Virtual Network Taps.␊ - */␊ - virtualNetworkTaps?: (SubResource25[] | string)␊ - /**␊ - * The reference of ApplicationGatewayBackendAddressPool resource.␊ - */␊ - applicationGatewayBackendAddressPools?: (SubResource25[] | string)␊ - /**␊ - * The reference of LoadBalancerBackendAddressPool resource.␊ - */␊ - loadBalancerBackendAddressPools?: (SubResource25[] | string)␊ - /**␊ - * A list of references of LoadBalancerInboundNatRules.␊ - */␊ - loadBalancerInboundNatRules?: (SubResource25[] | string)␊ - /**␊ - * Private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The private IP address allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4.␊ - */␊ - privateIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * Subnet bound to the IP configuration.␊ - */␊ - subnet?: (SubResource25 | string)␊ - /**␊ - * Whether this is a primary customer address on the network interface.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * Public IP address bound to the IP configuration.␊ - */␊ - publicIPAddress?: (SubResource25 | string)␊ - /**␊ - * Application security groups in which the IP configuration is included.␊ - */␊ - applicationSecurityGroups?: (SubResource25[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DNS settings of a network interface.␊ - */␊ - export interface NetworkInterfaceDnsSettings27 {␊ - /**␊ - * List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only value in dnsServers collection.␊ - */␊ - dnsServers?: (string[] | string)␊ - /**␊ - * Relative DNS name for this NIC used for internal communications between VMs in the same virtual network.␊ - */␊ - internalDnsNameLabel?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces/tapConfigurations␊ - */␊ - export interface NetworkInterfacesTapConfigurationsChildResource6 {␊ - name: string␊ - type: "tapConfigurations"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Properties of the Virtual Network Tap configuration.␊ - */␊ - properties: (NetworkInterfaceTapConfigurationPropertiesFormat6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Virtual Network Tap configuration.␊ - */␊ - export interface NetworkInterfaceTapConfigurationPropertiesFormat6 {␊ - /**␊ - * The reference of the Virtual Network Tap resource.␊ - */␊ - virtualNetworkTap?: (SubResource25 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces/tapConfigurations␊ - */␊ - export interface NetworkInterfacesTapConfigurations5 {␊ - name: string␊ - type: "Microsoft.Network/networkInterfaces/tapConfigurations"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Properties of the Virtual Network Tap configuration.␊ - */␊ - properties: (NetworkInterfaceTapConfigurationPropertiesFormat6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkProfiles␊ - */␊ - export interface NetworkProfiles2 {␊ - name: string␊ - type: "Microsoft.Network/networkProfiles"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Network profile properties.␊ - */␊ - properties: (NetworkProfilePropertiesFormat2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network profile properties.␊ - */␊ - export interface NetworkProfilePropertiesFormat2 {␊ - /**␊ - * List of chid container network interface configurations.␊ - */␊ - containerNetworkInterfaceConfigurations?: (ContainerNetworkInterfaceConfiguration2[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Container network interface configuration child resource.␊ - */␊ - export interface ContainerNetworkInterfaceConfiguration2 {␊ - /**␊ - * Container network interface configuration properties.␊ - */␊ - properties?: (ContainerNetworkInterfaceConfigurationPropertiesFormat2 | string)␊ - /**␊ - * The name of the resource. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Container network interface configuration properties.␊ - */␊ - export interface ContainerNetworkInterfaceConfigurationPropertiesFormat2 {␊ - /**␊ - * A list of ip configurations of the container network interface configuration.␊ - */␊ - ipConfigurations?: (IPConfigurationProfile2[] | string)␊ - /**␊ - * A list of container network interfaces created from this container network interface configuration.␊ - */␊ - containerNetworkInterfaces?: (SubResource25[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration profile child resource.␊ - */␊ - export interface IPConfigurationProfile2 {␊ - /**␊ - * Properties of the IP configuration profile.␊ - */␊ - properties?: (IPConfigurationProfilePropertiesFormat2 | string)␊ - /**␊ - * The name of the resource. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration profile properties.␊ - */␊ - export interface IPConfigurationProfilePropertiesFormat2 {␊ - /**␊ - * The reference of the subnet resource to create a container network interface ip configuration.␊ - */␊ - subnet?: (SubResource25 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups␊ - */␊ - export interface NetworkSecurityGroups27 {␊ - name: string␊ - type: "Microsoft.Network/networkSecurityGroups"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network security group.␊ - */␊ - properties: (NetworkSecurityGroupPropertiesFormat19 | string)␊ - resources?: NetworkSecurityGroupsSecurityRulesChildResource19[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network Security Group resource.␊ - */␊ - export interface NetworkSecurityGroupPropertiesFormat19 {␊ - /**␊ - * A collection of security rules of the network security group.␊ - */␊ - securityRules?: (SecurityRule19[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network security rule.␊ - */␊ - export interface SecurityRule19 {␊ - /**␊ - * Properties of the security rule.␊ - */␊ - properties?: (SecurityRulePropertiesFormat19 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Security rule resource.␊ - */␊ - export interface SecurityRulePropertiesFormat19 {␊ - /**␊ - * A description for this rule. Restricted to 140 chars.␊ - */␊ - description?: string␊ - /**␊ - * Network protocol this rule applies to.␊ - */␊ - protocol: (("Tcp" | "Udp" | "Icmp" | "Esp" | "*") | string)␊ - /**␊ - * The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.␊ - */␊ - sourcePortRange?: string␊ - /**␊ - * The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.␊ - */␊ - destinationPortRange?: string␊ - /**␊ - * The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from.␊ - */␊ - sourceAddressPrefix?: string␊ - /**␊ - * The CIDR or source IP ranges.␊ - */␊ - sourceAddressPrefixes?: (string[] | string)␊ - /**␊ - * The application security group specified as source.␊ - */␊ - sourceApplicationSecurityGroups?: (SubResource25[] | string)␊ - /**␊ - * The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used.␊ - */␊ - destinationAddressPrefix?: string␊ - /**␊ - * The destination address prefixes. CIDR or destination IP ranges.␊ - */␊ - destinationAddressPrefixes?: (string[] | string)␊ - /**␊ - * The application security group specified as destination.␊ - */␊ - destinationApplicationSecurityGroups?: (SubResource25[] | string)␊ - /**␊ - * The source port ranges.␊ - */␊ - sourcePortRanges?: (string[] | string)␊ - /**␊ - * The destination port ranges.␊ - */␊ - destinationPortRanges?: (string[] | string)␊ - /**␊ - * The network traffic is allowed or denied.␊ - */␊ - access: (("Allow" | "Deny") | string)␊ - /**␊ - * The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.␊ - */␊ - priority: (number | string)␊ - /**␊ - * The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic.␊ - */␊ - direction: (("Inbound" | "Outbound") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRulesChildResource19 {␊ - name: string␊ - type: "securityRules"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Properties of the security rule.␊ - */␊ - properties: (SecurityRulePropertiesFormat19 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRules18 {␊ - name: string␊ - type: "Microsoft.Network/networkSecurityGroups/securityRules"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Properties of the security rule.␊ - */␊ - properties: (SecurityRulePropertiesFormat19 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers␊ - */␊ - export interface NetworkWatchers5 {␊ - name: string␊ - type: "Microsoft.Network/networkWatchers"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network watcher.␊ - */␊ - properties: (NetworkWatcherPropertiesFormat2 | string)␊ - resources?: NetworkWatchersPacketCapturesChildResource5[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The network watcher properties.␊ - */␊ - export interface NetworkWatcherPropertiesFormat2 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/packetCaptures␊ - */␊ - export interface NetworkWatchersPacketCapturesChildResource5 {␊ - name: string␊ - type: "packetCaptures"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Properties of the packet capture.␊ - */␊ - properties: (PacketCaptureParameters5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters that define the create packet capture operation.␊ - */␊ - export interface PacketCaptureParameters5 {␊ - /**␊ - * The ID of the targeted resource, only VM is currently supported.␊ - */␊ - target: string␊ - /**␊ - * Number of bytes captured per packet, the remaining bytes are truncated.␊ - */␊ - bytesToCapturePerPacket?: ((number & string) | string)␊ - /**␊ - * Maximum size of the capture output.␊ - */␊ - totalBytesPerSession?: ((number & string) | string)␊ - /**␊ - * Maximum duration of the capture session in seconds.␊ - */␊ - timeLimitInSeconds?: ((number & string) | string)␊ - /**␊ - * Describes the storage location for a packet capture session.␊ - */␊ - storageLocation: (PacketCaptureStorageLocation5 | string)␊ - /**␊ - * A list of packet capture filters.␊ - */␊ - filters?: (PacketCaptureFilter5[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the storage location for a packet capture session.␊ - */␊ - export interface PacketCaptureStorageLocation5 {␊ - /**␊ - * The ID of the storage account to save the packet capture session. Required if no local file path is provided.␊ - */␊ - storageId?: string␊ - /**␊ - * The URI of the storage path to save the packet capture. Must be a well-formed URI describing the location to save the packet capture.␊ - */␊ - storagePath?: string␊ - /**␊ - * A valid local path on the targeting VM. Must include the name of the capture file (*.cap). For linux virtual machine it must start with /var/captures. Required if no storage ID is provided, otherwise optional.␊ - */␊ - filePath?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Filter that is applied to packet capture request. Multiple filters can be applied.␊ - */␊ - export interface PacketCaptureFilter5 {␊ - /**␊ - * Protocol to be filtered on.␊ - */␊ - protocol?: (("TCP" | "UDP" | "Any") | string)␊ - /**␊ - * Local IP Address to be filtered on. Notation: "127.0.0.1" for single address entry. "127.0.0.1-127.0.0.255" for range. "127.0.0.1;127.0.0.5"? for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.␊ - */␊ - localIPAddress?: string␊ - /**␊ - * Local IP Address to be filtered on. Notation: "127.0.0.1" for single address entry. "127.0.0.1-127.0.0.255" for range. "127.0.0.1;127.0.0.5;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.␊ - */␊ - remoteIPAddress?: string␊ - /**␊ - * Local port to be filtered on. Notation: "80" for single port entry."80-85" for range. "80;443;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.␊ - */␊ - localPort?: string␊ - /**␊ - * Remote port to be filtered on. Notation: "80" for single port entry."80-85" for range. "80;443;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.␊ - */␊ - remotePort?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/packetCaptures␊ - */␊ - export interface NetworkWatchersPacketCaptures5 {␊ - name: string␊ - type: "Microsoft.Network/networkWatchers/packetCaptures"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Properties of the packet capture.␊ - */␊ - properties: (PacketCaptureParameters5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/p2svpnGateways␊ - */␊ - export interface P2SvpnGateways2 {␊ - name: string␊ - type: "Microsoft.Network/p2svpnGateways"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the P2SVpnGateway.␊ - */␊ - properties: (P2SVpnGatewayProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for P2SVpnGateway.␊ - */␊ - export interface P2SVpnGatewayProperties2 {␊ - /**␊ - * The VirtualHub to which the gateway belongs.␊ - */␊ - virtualHub?: (SubResource25 | string)␊ - /**␊ - * The scale unit for this p2s vpn gateway.␊ - */␊ - vpnGatewayScaleUnit?: (number | string)␊ - /**␊ - * The P2SVpnServerConfiguration to which the p2sVpnGateway is attached to.␊ - */␊ - p2SVpnServerConfiguration?: (SubResource25 | string)␊ - /**␊ - * The reference of the address space resource which represents Address space for P2S VpnClient.␊ - */␊ - vpnClientAddressPool?: (AddressSpace27 | string)␊ - /**␊ - * The reference of the address space resource which represents the custom routes specified by the customer for P2SVpnGateway and P2S VpnClient.␊ - */␊ - customRoutes?: (AddressSpace27 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateEndpoints␊ - */␊ - export interface PrivateEndpoints2 {␊ - name: string␊ - type: "Microsoft.Network/privateEndpoints"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the private endpoint.␊ - */␊ - properties: (PrivateEndpointProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the private endpoint.␊ - */␊ - export interface PrivateEndpointProperties2 {␊ - /**␊ - * The ID of the subnet from which the private IP will be allocated.␊ - */␊ - subnet?: (SubResource25 | string)␊ - /**␊ - * A grouping of information about the connection to the remote resource.␊ - */␊ - privateLinkServiceConnections?: (PrivateLinkServiceConnection2[] | string)␊ - /**␊ - * A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource.␊ - */␊ - manualPrivateLinkServiceConnections?: (PrivateLinkServiceConnection2[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * PrivateLinkServiceConnection resource.␊ - */␊ - export interface PrivateLinkServiceConnection2 {␊ - /**␊ - * Properties of the private link service connection.␊ - */␊ - properties?: (PrivateLinkServiceConnectionProperties2 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the PrivateLinkServiceConnection.␊ - */␊ - export interface PrivateLinkServiceConnectionProperties2 {␊ - /**␊ - * The resource id of private link service.␊ - */␊ - privateLinkServiceId?: string␊ - /**␊ - * The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to.␊ - */␊ - groupIds?: (string[] | string)␊ - /**␊ - * A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars.␊ - */␊ - requestMessage?: string␊ - /**␊ - * A collection of read-only information about the state of the connection to the remote resource.␊ - */␊ - privateLinkServiceConnectionState?: (PrivateLinkServiceConnectionState8 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A collection of information about the state of the connection between service consumer and provider.␊ - */␊ - export interface PrivateLinkServiceConnectionState8 {␊ - /**␊ - * Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.␊ - */␊ - status?: string␊ - /**␊ - * The reason for approval/rejection of the connection.␊ - */␊ - description?: string␊ - /**␊ - * A message indicating if changes on the service provider require any updates on the consumer.␊ - */␊ - actionRequired?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateLinkServices␊ - */␊ - export interface PrivateLinkServices2 {␊ - name: string␊ - type: "Microsoft.Network/privateLinkServices"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the private link service.␊ - */␊ - properties: (PrivateLinkServiceProperties2 | string)␊ - resources?: PrivateLinkServicesPrivateEndpointConnectionsChildResource2[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the private link service.␊ - */␊ - export interface PrivateLinkServiceProperties2 {␊ - /**␊ - * An array of references to the load balancer IP configurations.␊ - */␊ - loadBalancerFrontendIpConfigurations?: (SubResource25[] | string)␊ - /**␊ - * An array of private link service IP configurations.␊ - */␊ - ipConfigurations?: (PrivateLinkServiceIpConfiguration2[] | string)␊ - /**␊ - * The visibility list of the private link service.␊ - */␊ - visibility?: (PrivateLinkServicePropertiesVisibility2 | string)␊ - /**␊ - * The auto-approval list of the private link service.␊ - */␊ - autoApproval?: (PrivateLinkServicePropertiesAutoApproval2 | string)␊ - /**␊ - * The list of Fqdn.␊ - */␊ - fqdns?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The private link service ip configuration.␊ - */␊ - export interface PrivateLinkServiceIpConfiguration2 {␊ - /**␊ - * Properties of the private link service ip configuration.␊ - */␊ - properties?: (PrivateLinkServiceIpConfigurationProperties2 | string)␊ - /**␊ - * The name of private link service ip configuration.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of private link service IP configuration.␊ - */␊ - export interface PrivateLinkServiceIpConfigurationProperties2 {␊ - /**␊ - * The private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The private IP address allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * The reference to the subnet resource.␊ - */␊ - subnet?: (SubResource25 | string)␊ - /**␊ - * Whether the ip configuration is primary or not.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4.␊ - */␊ - privateIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The visibility list of the private link service.␊ - */␊ - export interface PrivateLinkServicePropertiesVisibility2 {␊ - /**␊ - * The list of subscriptions.␊ - */␊ - subscriptions?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The auto-approval list of the private link service.␊ - */␊ - export interface PrivateLinkServicePropertiesAutoApproval2 {␊ - /**␊ - * The list of subscriptions.␊ - */␊ - subscriptions?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateLinkServices/privateEndpointConnections␊ - */␊ - export interface PrivateLinkServicesPrivateEndpointConnectionsChildResource2 {␊ - name: string␊ - type: "privateEndpointConnections"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Properties of the private end point connection.␊ - */␊ - properties: (PrivateEndpointConnectionProperties9 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the PrivateEndpointConnectProperties.␊ - */␊ - export interface PrivateEndpointConnectionProperties9 {␊ - /**␊ - * A collection of information about the state of the connection between service consumer and provider.␊ - */␊ - privateLinkServiceConnectionState?: (PrivateLinkServiceConnectionState8 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateLinkServices/privateEndpointConnections␊ - */␊ - export interface PrivateLinkServicesPrivateEndpointConnections2 {␊ - name: string␊ - type: "Microsoft.Network/privateLinkServices/privateEndpointConnections"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Properties of the private end point connection.␊ - */␊ - properties: (PrivateEndpointConnectionProperties9 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/publicIPAddresses␊ - */␊ - export interface PublicIPAddresses27 {␊ - name: string␊ - type: "Microsoft.Network/publicIPAddresses"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The public IP address SKU.␊ - */␊ - sku?: (PublicIPAddressSku15 | string)␊ - /**␊ - * Public IP address properties.␊ - */␊ - properties: (PublicIPAddressPropertiesFormat18 | string)␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a public IP address.␊ - */␊ - export interface PublicIPAddressSku15 {␊ - /**␊ - * Name of a public IP address SKU.␊ - */␊ - name?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Public IP address properties.␊ - */␊ - export interface PublicIPAddressPropertiesFormat18 {␊ - /**␊ - * The public IP address allocation method.␊ - */␊ - publicIPAllocationMethod: (("Static" | "Dynamic") | string)␊ - /**␊ - * The public IP address version.␊ - */␊ - publicIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The FQDN of the DNS record associated with the public IP address.␊ - */␊ - dnsSettings?: (PublicIPAddressDnsSettings26 | string)␊ - /**␊ - * The DDoS protection custom policy associated with the public IP address.␊ - */␊ - ddosSettings?: (DdosSettings4 | string)␊ - /**␊ - * The list of tags associated with the public IP address.␊ - */␊ - ipTags?: (IpTag12[] | string)␊ - /**␊ - * The IP address associated with the public IP address resource.␊ - */␊ - ipAddress?: string␊ - /**␊ - * The Public IP Prefix this Public IP Address should be allocated from.␊ - */␊ - publicIPPrefix?: (SubResource25 | string)␊ - /**␊ - * The idle timeout of the public IP address.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains FQDN of the DNS record associated with the public IP address.␊ - */␊ - export interface PublicIPAddressDnsSettings26 {␊ - /**␊ - * The domain name label. The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.␊ - */␊ - domainNameLabel: string␊ - /**␊ - * The Fully Qualified Domain Name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone.␊ - */␊ - fqdn?: string␊ - /**␊ - * The reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN.␊ - */␊ - reverseFqdn?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains the DDoS protection settings of the public IP.␊ - */␊ - export interface DdosSettings4 {␊ - /**␊ - * The DDoS custom policy associated with the public IP.␊ - */␊ - ddosCustomPolicy?: (SubResource25 | string)␊ - /**␊ - * The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized.␊ - */␊ - protectionCoverage?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains the IpTag associated with the object.␊ - */␊ - export interface IpTag12 {␊ - /**␊ - * The IP tag type. Example: FirstPartyUsage.␊ - */␊ - ipTagType?: string␊ - /**␊ - * The value of the IP tag associated with the public IP. Example: SQL.␊ - */␊ - tag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/publicIPPrefixes␊ - */␊ - export interface PublicIPPrefixes3 {␊ - name: string␊ - type: "Microsoft.Network/publicIPPrefixes"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The public IP prefix SKU.␊ - */␊ - sku?: (PublicIPPrefixSku3 | string)␊ - /**␊ - * Public IP prefix properties.␊ - */␊ - properties: (PublicIPPrefixPropertiesFormat3 | string)␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a public IP prefix.␊ - */␊ - export interface PublicIPPrefixSku3 {␊ - /**␊ - * Name of a public IP prefix SKU.␊ - */␊ - name?: ("Standard" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Public IP prefix properties.␊ - */␊ - export interface PublicIPPrefixPropertiesFormat3 {␊ - /**␊ - * The public IP address version.␊ - */␊ - publicIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The list of tags associated with the public IP prefix.␊ - */␊ - ipTags?: (IpTag12[] | string)␊ - /**␊ - * The Length of the Public IP Prefix.␊ - */␊ - prefixLength?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeFilters␊ - */␊ - export interface RouteFilters5 {␊ - name: string␊ - type: "Microsoft.Network/routeFilters"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the route filter.␊ - */␊ - properties: (RouteFilterPropertiesFormat5 | string)␊ - resources?: RouteFiltersRouteFilterRulesChildResource5[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Filter Resource.␊ - */␊ - export interface RouteFilterPropertiesFormat5 {␊ - /**␊ - * Collection of RouteFilterRules contained within a route filter.␊ - */␊ - rules?: (RouteFilterRule5[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Filter Rule Resource.␊ - */␊ - export interface RouteFilterRule5 {␊ - /**␊ - * Properties of the route filter rule.␊ - */␊ - properties?: (RouteFilterRulePropertiesFormat5 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Filter Rule Resource.␊ - */␊ - export interface RouteFilterRulePropertiesFormat5 {␊ - /**␊ - * The access type of the rule.␊ - */␊ - access: (("Allow" | "Deny") | string)␊ - /**␊ - * The rule type of the rule.␊ - */␊ - routeFilterRuleType: ("Community" | string)␊ - /**␊ - * The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'].␊ - */␊ - communities: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeFilters/routeFilterRules␊ - */␊ - export interface RouteFiltersRouteFilterRulesChildResource5 {␊ - name: string␊ - type: "routeFilterRules"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Properties of the route filter rule.␊ - */␊ - properties: (RouteFilterRulePropertiesFormat5 | string)␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeFilters/routeFilterRules␊ - */␊ - export interface RouteFiltersRouteFilterRules5 {␊ - name: string␊ - type: "Microsoft.Network/routeFilters/routeFilterRules"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Properties of the route filter rule.␊ - */␊ - properties: (RouteFilterRulePropertiesFormat5 | string)␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables␊ - */␊ - export interface RouteTables27 {␊ - name: string␊ - type: "Microsoft.Network/routeTables"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the route table.␊ - */␊ - properties: (RouteTablePropertiesFormat19 | string)␊ - resources?: RouteTablesRoutesChildResource19[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Table resource.␊ - */␊ - export interface RouteTablePropertiesFormat19 {␊ - /**␊ - * Collection of routes contained within a route table.␊ - */␊ - routes?: (Route19[] | string)␊ - /**␊ - * Whether to disable the routes learned by BGP on that route table. True means disable.␊ - */␊ - disableBgpRoutePropagation?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource.␊ - */␊ - export interface Route19 {␊ - /**␊ - * Properties of the route.␊ - */␊ - properties?: (RoutePropertiesFormat19 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource.␊ - */␊ - export interface RoutePropertiesFormat19 {␊ - /**␊ - * The destination CIDR to which the route applies.␊ - */␊ - addressPrefix: string␊ - /**␊ - * The type of Azure hop the packet should be sent to.␊ - */␊ - nextHopType: (("VirtualNetworkGateway" | "VnetLocal" | "Internet" | "VirtualAppliance" | "None") | string)␊ - /**␊ - * The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.␊ - */␊ - nextHopIpAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutesChildResource19 {␊ - name: string␊ - type: "routes"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Properties of the route.␊ - */␊ - properties: (RoutePropertiesFormat19 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutes18 {␊ - name: string␊ - type: "Microsoft.Network/routeTables/routes"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Properties of the route.␊ - */␊ - properties: (RoutePropertiesFormat19 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/serviceEndpointPolicies␊ - */␊ - export interface ServiceEndpointPolicies3 {␊ - name: string␊ - type: "Microsoft.Network/serviceEndpointPolicies"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the service end point policy.␊ - */␊ - properties: (ServiceEndpointPolicyPropertiesFormat3 | string)␊ - resources?: ServiceEndpointPoliciesServiceEndpointPolicyDefinitionsChildResource3[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Service Endpoint Policy resource.␊ - */␊ - export interface ServiceEndpointPolicyPropertiesFormat3 {␊ - /**␊ - * A collection of service endpoint policy definitions of the service endpoint policy.␊ - */␊ - serviceEndpointPolicyDefinitions?: (ServiceEndpointPolicyDefinition3[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Service Endpoint policy definitions.␊ - */␊ - export interface ServiceEndpointPolicyDefinition3 {␊ - /**␊ - * Properties of the service endpoint policy definition.␊ - */␊ - properties?: (ServiceEndpointPolicyDefinitionPropertiesFormat3 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Service Endpoint policy definition resource.␊ - */␊ - export interface ServiceEndpointPolicyDefinitionPropertiesFormat3 {␊ - /**␊ - * A description for this rule. Restricted to 140 chars.␊ - */␊ - description?: string␊ - /**␊ - * Service endpoint name.␊ - */␊ - service?: string␊ - /**␊ - * A list of service resources.␊ - */␊ - serviceResources?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions␊ - */␊ - export interface ServiceEndpointPoliciesServiceEndpointPolicyDefinitionsChildResource3 {␊ - name: string␊ - type: "serviceEndpointPolicyDefinitions"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Properties of the service endpoint policy definition.␊ - */␊ - properties: (ServiceEndpointPolicyDefinitionPropertiesFormat3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions␊ - */␊ - export interface ServiceEndpointPoliciesServiceEndpointPolicyDefinitions3 {␊ - name: string␊ - type: "Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Properties of the service endpoint policy definition.␊ - */␊ - properties: (ServiceEndpointPolicyDefinitionPropertiesFormat3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualHubs␊ - */␊ - export interface VirtualHubs5 {␊ - name: string␊ - type: "Microsoft.Network/virtualHubs"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual hub.␊ - */␊ - properties: (VirtualHubProperties5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VirtualHub.␊ - */␊ - export interface VirtualHubProperties5 {␊ - /**␊ - * The VirtualWAN to which the VirtualHub belongs.␊ - */␊ - virtualWan?: (SubResource25 | string)␊ - /**␊ - * The VpnGateway associated with this VirtualHub.␊ - */␊ - vpnGateway?: (SubResource25 | string)␊ - /**␊ - * The P2SVpnGateway associated with this VirtualHub.␊ - */␊ - p2SVpnGateway?: (SubResource25 | string)␊ - /**␊ - * The expressRouteGateway associated with this VirtualHub.␊ - */␊ - expressRouteGateway?: (SubResource25 | string)␊ - /**␊ - * List of all vnet connections with this VirtualHub.␊ - */␊ - virtualNetworkConnections?: (HubVirtualNetworkConnection5[] | string)␊ - /**␊ - * Address-prefix for this VirtualHub.␊ - */␊ - addressPrefix?: string␊ - /**␊ - * The routeTable associated with this virtual hub.␊ - */␊ - routeTable?: (VirtualHubRouteTable2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HubVirtualNetworkConnection Resource.␊ - */␊ - export interface HubVirtualNetworkConnection5 {␊ - /**␊ - * Properties of the hub virtual network connection.␊ - */␊ - properties?: (HubVirtualNetworkConnectionProperties5 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for HubVirtualNetworkConnection.␊ - */␊ - export interface HubVirtualNetworkConnectionProperties5 {␊ - /**␊ - * Reference to the remote virtual network.␊ - */␊ - remoteVirtualNetwork?: (SubResource25 | string)␊ - /**␊ - * VirtualHub to RemoteVnet transit to enabled or not.␊ - */␊ - allowHubToRemoteVnetTransit?: (boolean | string)␊ - /**␊ - * Allow RemoteVnet to use Virtual Hub's gateways.␊ - */␊ - allowRemoteVnetToUseHubVnetGateways?: (boolean | string)␊ - /**␊ - * Enable internet security.␊ - */␊ - enableInternetSecurity?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualHub route table.␊ - */␊ - export interface VirtualHubRouteTable2 {␊ - /**␊ - * List of all routes.␊ - */␊ - routes?: (VirtualHubRoute2[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualHub route.␊ - */␊ - export interface VirtualHubRoute2 {␊ - /**␊ - * List of all addressPrefixes.␊ - */␊ - addressPrefixes?: (string[] | string)␊ - /**␊ - * NextHop ip address.␊ - */␊ - nextHopIpAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworkGateways␊ - */␊ - export interface VirtualNetworkGateways15 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworkGateways"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway.␊ - */␊ - properties: (VirtualNetworkGatewayPropertiesFormat15 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGateway properties.␊ - */␊ - export interface VirtualNetworkGatewayPropertiesFormat15 {␊ - /**␊ - * IP configurations for virtual network gateway.␊ - */␊ - ipConfigurations?: (VirtualNetworkGatewayIPConfiguration14[] | string)␊ - /**␊ - * The type of this virtual network gateway.␊ - */␊ - gatewayType?: (("Vpn" | "ExpressRoute" | "HyperNet") | string)␊ - /**␊ - * The type of this virtual network gateway.␊ - */␊ - vpnType?: (("PolicyBased" | "RouteBased") | string)␊ - /**␊ - * The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN.␊ - */␊ - vpnGatewayGeneration?: (("None" | "Generation1" | "Generation2") | string)␊ - /**␊ - * Whether BGP is enabled for this virtual network gateway or not.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * ActiveActive flag.␊ - */␊ - activeActive?: (boolean | string)␊ - /**␊ - * The reference of the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting.␊ - */␊ - gatewayDefaultSite?: (SubResource25 | string)␊ - /**␊ - * The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.␊ - */␊ - sku?: (VirtualNetworkGatewaySku14 | string)␊ - /**␊ - * The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations.␊ - */␊ - vpnClientConfiguration?: (VpnClientConfiguration14 | string)␊ - /**␊ - * Virtual network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings14 | string)␊ - /**␊ - * The reference of the address space resource which represents the custom routes address space specified by the customer for virtual network gateway and VpnClient.␊ - */␊ - customRoutes?: (AddressSpace27 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration for virtual network gateway.␊ - */␊ - export interface VirtualNetworkGatewayIPConfiguration14 {␊ - /**␊ - * Properties of the virtual network gateway ip configuration.␊ - */␊ - properties?: (VirtualNetworkGatewayIPConfigurationPropertiesFormat14 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of VirtualNetworkGatewayIPConfiguration.␊ - */␊ - export interface VirtualNetworkGatewayIPConfigurationPropertiesFormat14 {␊ - /**␊ - * The private IP address allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * The reference of the subnet resource.␊ - */␊ - subnet?: (SubResource25 | string)␊ - /**␊ - * The reference of the public IP resource.␊ - */␊ - publicIPAddress?: (SubResource25 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewaySku details.␊ - */␊ - export interface VirtualNetworkGatewaySku14 {␊ - /**␊ - * Gateway SKU name.␊ - */␊ - name?: (("Basic" | "HighPerformance" | "Standard" | "UltraPerformance" | "VpnGw1" | "VpnGw2" | "VpnGw3" | "VpnGw4" | "VpnGw5" | "VpnGw1AZ" | "VpnGw2AZ" | "VpnGw3AZ" | "VpnGw4AZ" | "VpnGw5AZ" | "ErGw1AZ" | "ErGw2AZ" | "ErGw3AZ") | string)␊ - /**␊ - * Gateway SKU tier.␊ - */␊ - tier?: (("Basic" | "HighPerformance" | "Standard" | "UltraPerformance" | "VpnGw1" | "VpnGw2" | "VpnGw3" | "VpnGw4" | "VpnGw5" | "VpnGw1AZ" | "VpnGw2AZ" | "VpnGw3AZ" | "VpnGw4AZ" | "VpnGw5AZ" | "ErGw1AZ" | "ErGw2AZ" | "ErGw3AZ") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnClientConfiguration for P2S client.␊ - */␊ - export interface VpnClientConfiguration14 {␊ - /**␊ - * The reference of the address space resource which represents Address space for P2S VpnClient.␊ - */␊ - vpnClientAddressPool?: (AddressSpace27 | string)␊ - /**␊ - * VpnClientRootCertificate for virtual network gateway.␊ - */␊ - vpnClientRootCertificates?: (VpnClientRootCertificate14[] | string)␊ - /**␊ - * VpnClientRevokedCertificate for Virtual network gateway.␊ - */␊ - vpnClientRevokedCertificates?: (VpnClientRevokedCertificate14[] | string)␊ - /**␊ - * VpnClientProtocols for Virtual network gateway.␊ - */␊ - vpnClientProtocols?: (("IkeV2" | "SSTP" | "OpenVPN")[] | string)␊ - /**␊ - * VpnClientIpsecPolicies for virtual network gateway P2S client.␊ - */␊ - vpnClientIpsecPolicies?: (IpsecPolicy12[] | string)␊ - /**␊ - * The radius server address property of the VirtualNetworkGateway resource for vpn client connection.␊ - */␊ - radiusServerAddress?: string␊ - /**␊ - * The radius secret property of the VirtualNetworkGateway resource for vpn client connection.␊ - */␊ - radiusServerSecret?: string␊ - /**␊ - * The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication.␊ - */␊ - aadTenant?: string␊ - /**␊ - * The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication.␊ - */␊ - aadAudience?: string␊ - /**␊ - * The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication.␊ - */␊ - aadIssuer?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client root certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRootCertificate14 {␊ - /**␊ - * Properties of the vpn client root certificate.␊ - */␊ - properties: (VpnClientRootCertificatePropertiesFormat14 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of application gateway.␊ - */␊ - export interface VpnClientRootCertificatePropertiesFormat14 {␊ - /**␊ - * The certificate public data.␊ - */␊ - publicCertData: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client revoked certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRevokedCertificate14 {␊ - /**␊ - * Properties of the vpn client revoked certificate.␊ - */␊ - properties?: (VpnClientRevokedCertificatePropertiesFormat14 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the revoked VPN client certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRevokedCertificatePropertiesFormat14 {␊ - /**␊ - * The revoked VPN client certificate thumbprint.␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks␊ - */␊ - export interface VirtualNetworks27 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network.␊ - */␊ - properties: (VirtualNetworkPropertiesFormat19 | string)␊ - resources?: (VirtualNetworksVirtualNetworkPeeringsChildResource16 | VirtualNetworksSubnetsChildResource19)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the virtual network.␊ - */␊ - export interface VirtualNetworkPropertiesFormat19 {␊ - /**␊ - * The AddressSpace that contains an array of IP address ranges that can be used by subnets.␊ - */␊ - addressSpace: (AddressSpace27 | string)␊ - /**␊ - * The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network.␊ - */␊ - dhcpOptions?: (DhcpOptions27 | string)␊ - /**␊ - * A list of subnets in a Virtual Network.␊ - */␊ - subnets?: (Subnet29[] | string)␊ - /**␊ - * A list of peerings in a Virtual Network.␊ - */␊ - virtualNetworkPeerings?: (VirtualNetworkPeering24[] | string)␊ - /**␊ - * Indicates if DDoS protection is enabled for all the protected resources in the virtual network. It requires a DDoS protection plan associated with the resource.␊ - */␊ - enableDdosProtection?: (boolean | string)␊ - /**␊ - * Indicates if VM protection is enabled for all the subnets in the virtual network.␊ - */␊ - enableVmProtection?: (boolean | string)␊ - /**␊ - * The DDoS protection plan associated with the virtual network.␊ - */␊ - ddosProtectionPlan?: (SubResource25 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DhcpOptions contains an array of DNS servers available to VMs deployed in the virtual network. Standard DHCP option for a subnet overrides VNET DHCP options.␊ - */␊ - export interface DhcpOptions27 {␊ - /**␊ - * The list of DNS servers IP addresses.␊ - */␊ - dnsServers: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Subnet in a virtual network resource.␊ - */␊ - export interface Subnet29 {␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties?: (SubnetPropertiesFormat19 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the subnet.␊ - */␊ - export interface SubnetPropertiesFormat19 {␊ - /**␊ - * The address prefix for the subnet.␊ - */␊ - addressPrefix: string␊ - /**␊ - * List of address prefixes for the subnet.␊ - */␊ - addressPrefixes?: (string[] | string)␊ - /**␊ - * The reference of the NetworkSecurityGroup resource.␊ - */␊ - networkSecurityGroup?: (SubResource25 | string)␊ - /**␊ - * The reference of the RouteTable resource.␊ - */␊ - routeTable?: (SubResource25 | string)␊ - /**␊ - * Nat gateway associated with this subnet.␊ - */␊ - natGateway?: (SubResource25 | string)␊ - /**␊ - * An array of service endpoints.␊ - */␊ - serviceEndpoints?: (ServiceEndpointPropertiesFormat15[] | string)␊ - /**␊ - * An array of service endpoint policies.␊ - */␊ - serviceEndpointPolicies?: (SubResource25[] | string)␊ - /**␊ - * An array of references to the delegations on the subnet.␊ - */␊ - delegations?: (Delegation6[] | string)␊ - /**␊ - * Enable or Disable apply network policies on private end point in the subnet.␊ - */␊ - privateEndpointNetworkPolicies?: string␊ - /**␊ - * Enable or Disable apply network policies on private link service in the subnet.␊ - */␊ - privateLinkServiceNetworkPolicies?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The service endpoint properties.␊ - */␊ - export interface ServiceEndpointPropertiesFormat15 {␊ - /**␊ - * The type of the endpoint service.␊ - */␊ - service?: string␊ - /**␊ - * A list of locations.␊ - */␊ - locations?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Details the service to which the subnet is delegated.␊ - */␊ - export interface Delegation6 {␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties?: (ServiceDelegationPropertiesFormat6 | string)␊ - /**␊ - * The name of the resource that is unique within a subnet. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a service delegation.␊ - */␊ - export interface ServiceDelegationPropertiesFormat6 {␊ - /**␊ - * The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers).␊ - */␊ - serviceName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peerings in a virtual network resource.␊ - */␊ - export interface VirtualNetworkPeering24 {␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties?: (VirtualNetworkPeeringPropertiesFormat16 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - export interface VirtualNetworkPeeringPropertiesFormat16 {␊ - /**␊ - * Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space.␊ - */␊ - allowVirtualNetworkAccess?: (boolean | string)␊ - /**␊ - * Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network.␊ - */␊ - allowForwardedTraffic?: (boolean | string)␊ - /**␊ - * If gateway links can be used in remote virtual networking to link to this virtual network.␊ - */␊ - allowGatewayTransit?: (boolean | string)␊ - /**␊ - * If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway.␊ - */␊ - useRemoteGateways?: (boolean | string)␊ - /**␊ - * The reference of the remote virtual network. The remote virtual network can be in the same or different region (preview). See here to register for the preview and learn more (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering).␊ - */␊ - remoteVirtualNetwork: (SubResource25 | string)␊ - /**␊ - * The reference of the remote virtual network address space.␊ - */␊ - remoteAddressSpace?: (AddressSpace27 | string)␊ - /**␊ - * The status of the virtual network peering.␊ - */␊ - peeringState?: (("Initiated" | "Connected" | "Disconnected") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/virtualNetworkPeerings␊ - */␊ - export interface VirtualNetworksVirtualNetworkPeeringsChildResource16 {␊ - name: string␊ - type: "virtualNetworkPeerings"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties: (VirtualNetworkPeeringPropertiesFormat16 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnetsChildResource19 {␊ - name: string␊ - type: "subnets"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties: (SubnetPropertiesFormat19 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnets15 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks/subnets"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties: (SubnetPropertiesFormat19 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/virtualNetworkPeerings␊ - */␊ - export interface VirtualNetworksVirtualNetworkPeerings12 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks/virtualNetworkPeerings"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties: (VirtualNetworkPeeringPropertiesFormat16 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworkTaps␊ - */␊ - export interface VirtualNetworkTaps2 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworkTaps"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Virtual Network Tap Properties.␊ - */␊ - properties: (VirtualNetworkTapPropertiesFormat2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Virtual Network Tap properties.␊ - */␊ - export interface VirtualNetworkTapPropertiesFormat2 {␊ - /**␊ - * The reference to the private IP Address of the collector nic that will receive the tap.␊ - */␊ - destinationNetworkInterfaceIPConfiguration?: (SubResource25 | string)␊ - /**␊ - * The reference to the private IP address on the internal Load Balancer that will receive the tap.␊ - */␊ - destinationLoadBalancerFrontEndIPConfiguration?: (SubResource25 | string)␊ - /**␊ - * The VXLAN destination port that will receive the tapped traffic.␊ - */␊ - destinationPort?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualRouters␊ - */␊ - export interface VirtualRouters {␊ - name: string␊ - type: "Microsoft.Network/virtualRouters"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the Virtual Router.␊ - */␊ - properties: (VirtualRouterPropertiesFormat | string)␊ - resources?: VirtualRoutersPeeringsChildResource[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Virtual Router definition␊ - */␊ - export interface VirtualRouterPropertiesFormat {␊ - /**␊ - * VirtualRouter ASN.␊ - */␊ - virtualRouterAsn?: (number | string)␊ - /**␊ - * VirtualRouter IPs␊ - */␊ - virtualRouterIps?: (string[] | string)␊ - /**␊ - * The Subnet on which VirtualRouter is hosted.␊ - */␊ - hostedSubnet?: (SubResource25 | string)␊ - /**␊ - * The Gateway on which VirtualRouter is hosted.␊ - */␊ - hostedGateway?: (SubResource25 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualRouters/peerings␊ - */␊ - export interface VirtualRoutersPeeringsChildResource {␊ - name: string␊ - type: "peerings"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * The properties of the Virtual Router Peering.␊ - */␊ - properties: (VirtualRouterPeeringProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the rule group.␊ - */␊ - export interface VirtualRouterPeeringProperties {␊ - /**␊ - * Peer ASN.␊ - */␊ - peerAsn?: (number | string)␊ - /**␊ - * Peer IP.␊ - */␊ - peerIp?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualRouters/peerings␊ - */␊ - export interface VirtualRoutersPeerings {␊ - name: string␊ - type: "Microsoft.Network/virtualRouters/peerings"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * The properties of the Virtual Router Peering.␊ - */␊ - properties: (VirtualRouterPeeringProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualWans␊ - */␊ - export interface VirtualWans5 {␊ - name: string␊ - type: "Microsoft.Network/virtualWans"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual WAN.␊ - */␊ - properties: (VirtualWanProperties5 | string)␊ - resources?: VirtualWansP2SVpnServerConfigurationsChildResource2[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VirtualWAN.␊ - */␊ - export interface VirtualWanProperties5 {␊ - /**␊ - * Vpn encryption to be disabled or not.␊ - */␊ - disableVpnEncryption?: (boolean | string)␊ - /**␊ - * The Security Provider name.␊ - */␊ - securityProviderName?: string␊ - /**␊ - * True if branch to branch traffic is allowed.␊ - */␊ - allowBranchToBranchTraffic?: (boolean | string)␊ - /**␊ - * True if Vnet to Vnet traffic is allowed.␊ - */␊ - allowVnetToVnetTraffic?: (boolean | string)␊ - /**␊ - * The office local breakout category.␊ - */␊ - office365LocalBreakoutCategory?: (("Optimize" | "OptimizeAndAllow" | "All" | "None") | string)␊ - /**␊ - * List of all P2SVpnServerConfigurations associated with the virtual wan.␊ - */␊ - p2SVpnServerConfigurations?: (P2SVpnServerConfiguration2[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * P2SVpnServerConfiguration Resource.␊ - */␊ - export interface P2SVpnServerConfiguration2 {␊ - /**␊ - * Properties of the P2SVpnServer configuration.␊ - */␊ - properties?: (P2SVpnServerConfigurationProperties2 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for P2SVpnServerConfiguration.␊ - */␊ - export interface P2SVpnServerConfigurationProperties2 {␊ - /**␊ - * The name of the P2SVpnServerConfiguration that is unique within a VirtualWan in a resource group. This name can be used to access the resource along with Paren VirtualWan resource name.␊ - */␊ - name?: string␊ - /**␊ - * VPN protocols for the P2SVpnServerConfiguration.␊ - */␊ - vpnProtocols?: (("IkeV2" | "OpenVPN")[] | string)␊ - /**␊ - * VPN client root certificate of P2SVpnServerConfiguration.␊ - */␊ - p2SVpnServerConfigVpnClientRootCertificates?: (P2SVpnServerConfigVpnClientRootCertificate2[] | string)␊ - /**␊ - * VPN client revoked certificate of P2SVpnServerConfiguration.␊ - */␊ - p2SVpnServerConfigVpnClientRevokedCertificates?: (P2SVpnServerConfigVpnClientRevokedCertificate2[] | string)␊ - /**␊ - * Radius Server root certificate of P2SVpnServerConfiguration.␊ - */␊ - p2SVpnServerConfigRadiusServerRootCertificates?: (P2SVpnServerConfigRadiusServerRootCertificate2[] | string)␊ - /**␊ - * Radius client root certificate of P2SVpnServerConfiguration.␊ - */␊ - p2SVpnServerConfigRadiusClientRootCertificates?: (P2SVpnServerConfigRadiusClientRootCertificate2[] | string)␊ - /**␊ - * VpnClientIpsecPolicies for P2SVpnServerConfiguration.␊ - */␊ - vpnClientIpsecPolicies?: (IpsecPolicy12[] | string)␊ - /**␊ - * The radius server address property of the P2SVpnServerConfiguration resource for point to site client connection.␊ - */␊ - radiusServerAddress?: string␊ - /**␊ - * The radius secret property of the P2SVpnServerConfiguration resource for point to site client connection.␊ - */␊ - radiusServerSecret?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client root certificate of P2SVpnServerConfiguration.␊ - */␊ - export interface P2SVpnServerConfigVpnClientRootCertificate2 {␊ - /**␊ - * Properties of the P2SVpnServerConfiguration VPN client root certificate.␊ - */␊ - properties: (P2SVpnServerConfigVpnClientRootCertificatePropertiesFormat2 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of VPN client root certificate of P2SVpnServerConfiguration.␊ - */␊ - export interface P2SVpnServerConfigVpnClientRootCertificatePropertiesFormat2 {␊ - /**␊ - * The certificate public data.␊ - */␊ - publicCertData: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client revoked certificate of P2SVpnServerConfiguration.␊ - */␊ - export interface P2SVpnServerConfigVpnClientRevokedCertificate2 {␊ - /**␊ - * Properties of the vpn client revoked certificate.␊ - */␊ - properties?: (P2SVpnServerConfigVpnClientRevokedCertificatePropertiesFormat2 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the revoked VPN client certificate of P2SVpnServerConfiguration.␊ - */␊ - export interface P2SVpnServerConfigVpnClientRevokedCertificatePropertiesFormat2 {␊ - /**␊ - * The revoked VPN client certificate thumbprint.␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Radius Server root certificate of P2SVpnServerConfiguration.␊ - */␊ - export interface P2SVpnServerConfigRadiusServerRootCertificate2 {␊ - /**␊ - * Properties of the P2SVpnServerConfiguration Radius Server root certificate.␊ - */␊ - properties: (P2SVpnServerConfigRadiusServerRootCertificatePropertiesFormat2 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Radius Server root certificate of P2SVpnServerConfiguration.␊ - */␊ - export interface P2SVpnServerConfigRadiusServerRootCertificatePropertiesFormat2 {␊ - /**␊ - * The certificate public data.␊ - */␊ - publicCertData: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Radius client root certificate of P2SVpnServerConfiguration.␊ - */␊ - export interface P2SVpnServerConfigRadiusClientRootCertificate2 {␊ - /**␊ - * Properties of the Radius client root certificate.␊ - */␊ - properties?: (P2SVpnServerConfigRadiusClientRootCertificatePropertiesFormat2 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Radius client root certificate of P2SVpnServerConfiguration.␊ - */␊ - export interface P2SVpnServerConfigRadiusClientRootCertificatePropertiesFormat2 {␊ - /**␊ - * The Radius client root certificate thumbprint.␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualWans/p2sVpnServerConfigurations␊ - */␊ - export interface VirtualWansP2SVpnServerConfigurationsChildResource2 {␊ - name: string␊ - type: "p2sVpnServerConfigurations"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Properties of the P2SVpnServer configuration.␊ - */␊ - properties: (P2SVpnServerConfigurationProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualWans/p2sVpnServerConfigurations␊ - */␊ - export interface VirtualWansP2SVpnServerConfigurations2 {␊ - name: string␊ - type: "Microsoft.Network/virtualWans/p2sVpnServerConfigurations"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Properties of the P2SVpnServer configuration.␊ - */␊ - properties: (P2SVpnServerConfigurationProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnGateways␊ - */␊ - export interface VpnGateways5 {␊ - name: string␊ - type: "Microsoft.Network/vpnGateways"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the VPN gateway.␊ - */␊ - properties: (VpnGatewayProperties5 | string)␊ - resources?: VpnGatewaysVpnConnectionsChildResource5[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnGateway.␊ - */␊ - export interface VpnGatewayProperties5 {␊ - /**␊ - * The VirtualHub to which the gateway belongs.␊ - */␊ - virtualHub?: (SubResource25 | string)␊ - /**␊ - * List of all vpn connections to the gateway.␊ - */␊ - connections?: (VpnConnection5[] | string)␊ - /**␊ - * Local network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings14 | string)␊ - /**␊ - * The scale unit for this vpn gateway.␊ - */␊ - vpnGatewayScaleUnit?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnConnection Resource.␊ - */␊ - export interface VpnConnection5 {␊ - /**␊ - * Properties of the VPN connection.␊ - */␊ - properties?: (VpnConnectionProperties5 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnConnection.␊ - */␊ - export interface VpnConnectionProperties5 {␊ - /**␊ - * Id of the connected vpn site.␊ - */␊ - remoteVpnSite?: (SubResource25 | string)␊ - /**␊ - * Routing weight for vpn connection.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * The connection status.␊ - */␊ - connectionStatus?: (("Unknown" | "Connecting" | "Connected" | "NotConnected") | string)␊ - /**␊ - * Connection protocol used for this connection.␊ - */␊ - vpnConnectionProtocolType?: (("IKEv2" | "IKEv1") | string)␊ - /**␊ - * Expected bandwidth in MBPS.␊ - */␊ - connectionBandwidth?: (number | string)␊ - /**␊ - * SharedKey for the vpn connection.␊ - */␊ - sharedKey?: string␊ - /**␊ - * EnableBgp flag.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * Enable policy-based traffic selectors.␊ - */␊ - usePolicyBasedTrafficSelectors?: (boolean | string)␊ - /**␊ - * The IPSec Policies to be considered by this connection.␊ - */␊ - ipsecPolicies?: (IpsecPolicy12[] | string)␊ - /**␊ - * EnableBgp flag.␊ - */␊ - enableRateLimiting?: (boolean | string)␊ - /**␊ - * Enable internet security.␊ - */␊ - enableInternetSecurity?: (boolean | string)␊ - /**␊ - * Use local azure ip to initiate connection.␊ - */␊ - useLocalAzureIpAddress?: (boolean | string)␊ - /**␊ - * List of all vpn site link connections to the gateway.␊ - */␊ - vpnLinkConnections?: (VpnSiteLinkConnection1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnSiteLinkConnection Resource.␊ - */␊ - export interface VpnSiteLinkConnection1 {␊ - /**␊ - * Properties of the VPN site link connection.␊ - */␊ - properties?: (VpnSiteLinkConnectionProperties1 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnConnection.␊ - */␊ - export interface VpnSiteLinkConnectionProperties1 {␊ - /**␊ - * Id of the connected vpn site link.␊ - */␊ - vpnSiteLink?: (SubResource25 | string)␊ - /**␊ - * Routing weight for vpn connection.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * The connection status.␊ - */␊ - connectionStatus?: (("Unknown" | "Connecting" | "Connected" | "NotConnected") | string)␊ - /**␊ - * Connection protocol used for this connection.␊ - */␊ - vpnConnectionProtocolType?: (("IKEv2" | "IKEv1") | string)␊ - /**␊ - * Expected bandwidth in MBPS.␊ - */␊ - connectionBandwidth?: (number | string)␊ - /**␊ - * SharedKey for the vpn connection.␊ - */␊ - sharedKey?: string␊ - /**␊ - * EnableBgp flag.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * Enable policy-based traffic selectors.␊ - */␊ - usePolicyBasedTrafficSelectors?: (boolean | string)␊ - /**␊ - * The IPSec Policies to be considered by this connection.␊ - */␊ - ipsecPolicies?: (IpsecPolicy12[] | string)␊ - /**␊ - * EnableBgp flag.␊ - */␊ - enableRateLimiting?: (boolean | string)␊ - /**␊ - * Use local azure ip to initiate connection.␊ - */␊ - useLocalAzureIpAddress?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnGateways/vpnConnections␊ - */␊ - export interface VpnGatewaysVpnConnectionsChildResource5 {␊ - name: string␊ - type: "vpnConnections"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Properties of the VPN connection.␊ - */␊ - properties: (VpnConnectionProperties5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnGateways/vpnConnections␊ - */␊ - export interface VpnGatewaysVpnConnections5 {␊ - name: string␊ - type: "Microsoft.Network/vpnGateways/vpnConnections"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Properties of the VPN connection.␊ - */␊ - properties: (VpnConnectionProperties5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnSites␊ - */␊ - export interface VpnSites5 {␊ - name: string␊ - type: "Microsoft.Network/vpnSites"␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the VPN site.␊ - */␊ - properties: (VpnSiteProperties5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnSite.␊ - */␊ - export interface VpnSiteProperties5 {␊ - /**␊ - * The VirtualWAN to which the vpnSite belongs.␊ - */␊ - virtualWan?: (SubResource25 | string)␊ - /**␊ - * The device properties.␊ - */␊ - deviceProperties?: (DeviceProperties5 | string)␊ - /**␊ - * The ip-address for the vpn-site.␊ - */␊ - ipAddress?: string␊ - /**␊ - * The key for vpn-site that can be used for connections.␊ - */␊ - siteKey?: string␊ - /**␊ - * The AddressSpace that contains an array of IP address ranges.␊ - */␊ - addressSpace?: (AddressSpace27 | string)␊ - /**␊ - * The set of bgp properties.␊ - */␊ - bgpProperties?: (BgpSettings14 | string)␊ - /**␊ - * IsSecuritySite flag.␊ - */␊ - isSecuritySite?: (boolean | string)␊ - /**␊ - * List of all vpn site links.␊ - */␊ - vpnSiteLinks?: (VpnSiteLink1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * List of properties of the device.␊ - */␊ - export interface DeviceProperties5 {␊ - /**␊ - * Name of the device Vendor.␊ - */␊ - deviceVendor?: string␊ - /**␊ - * Model of the device.␊ - */␊ - deviceModel?: string␊ - /**␊ - * Link speed.␊ - */␊ - linkSpeedInMbps?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnSiteLink Resource.␊ - */␊ - export interface VpnSiteLink1 {␊ - /**␊ - * Properties of the VPN site link.␊ - */␊ - properties?: (VpnSiteLinkProperties1 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnSite.␊ - */␊ - export interface VpnSiteLinkProperties1 {␊ - /**␊ - * The link provider properties.␊ - */␊ - linkProperties?: (VpnLinkProviderProperties1 | string)␊ - /**␊ - * The ip-address for the vpn-site-link.␊ - */␊ - ipAddress?: string␊ - /**␊ - * The set of bgp properties.␊ - */␊ - bgpProperties?: (VpnLinkBgpSettings1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * List of properties of a link provider.␊ - */␊ - export interface VpnLinkProviderProperties1 {␊ - /**␊ - * Name of the link provider.␊ - */␊ - linkProviderName?: string␊ - /**␊ - * Link speed.␊ - */␊ - linkSpeedInMbps?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * BGP settings details for a link.␊ - */␊ - export interface VpnLinkBgpSettings1 {␊ - /**␊ - * The BGP speaker's ASN.␊ - */␊ - asn?: (number | string)␊ - /**␊ - * The BGP peering address and BGP identifier of this BGP speaker.␊ - */␊ - bgpPeeringAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/applicationGateways␊ - */␊ - export interface ApplicationGateways19 {␊ - name: string␊ - type: "Microsoft.Network/applicationGateways"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the application gateway.␊ - */␊ - properties: (ApplicationGatewayPropertiesFormat19 | string)␊ - /**␊ - * A list of availability zones denoting where the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - /**␊ - * The identity of the application gateway, if configured.␊ - */␊ - identity?: (ManagedServiceIdentity6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application gateway.␊ - */␊ - export interface ApplicationGatewayPropertiesFormat19 {␊ - /**␊ - * SKU of the application gateway resource.␊ - */␊ - sku?: (ApplicationGatewaySku19 | string)␊ - /**␊ - * SSL policy of the application gateway resource.␊ - */␊ - sslPolicy?: (ApplicationGatewaySslPolicy16 | string)␊ - /**␊ - * Subnets of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - gatewayIPConfigurations?: (ApplicationGatewayIPConfiguration19[] | string)␊ - /**␊ - * Authentication certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - authenticationCertificates?: (ApplicationGatewayAuthenticationCertificate16[] | string)␊ - /**␊ - * Trusted Root certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - trustedRootCertificates?: (ApplicationGatewayTrustedRootCertificate7[] | string)␊ - /**␊ - * SSL certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - sslCertificates?: (ApplicationGatewaySslCertificate19[] | string)␊ - /**␊ - * Frontend IP addresses of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - frontendIPConfigurations?: (ApplicationGatewayFrontendIPConfiguration19[] | string)␊ - /**␊ - * Frontend ports of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - frontendPorts?: (ApplicationGatewayFrontendPort19[] | string)␊ - /**␊ - * Probes of the application gateway resource.␊ - */␊ - probes?: (ApplicationGatewayProbe18[] | string)␊ - /**␊ - * Backend address pool of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - backendAddressPools?: (ApplicationGatewayBackendAddressPool19[] | string)␊ - /**␊ - * Backend http settings of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - backendHttpSettingsCollection?: (ApplicationGatewayBackendHttpSettings19[] | string)␊ - /**␊ - * Http listeners of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - httpListeners?: (ApplicationGatewayHttpListener19[] | string)␊ - /**␊ - * URL path map of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - urlPathMaps?: (ApplicationGatewayUrlPathMap18[] | string)␊ - /**␊ - * Request routing rules of the application gateway resource.␊ - */␊ - requestRoutingRules?: (ApplicationGatewayRequestRoutingRule19[] | string)␊ - /**␊ - * Rewrite rules for the application gateway resource.␊ - */␊ - rewriteRuleSets?: (ApplicationGatewayRewriteRuleSet6[] | string)␊ - /**␊ - * Redirect configurations of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - redirectConfigurations?: (ApplicationGatewayRedirectConfiguration16[] | string)␊ - /**␊ - * Web application firewall configuration.␊ - */␊ - webApplicationFirewallConfiguration?: (ApplicationGatewayWebApplicationFirewallConfiguration16 | string)␊ - /**␊ - * Reference of the FirewallPolicy resource.␊ - */␊ - firewallPolicy?: (SubResource26 | string)␊ - /**␊ - * Whether HTTP2 is enabled on the application gateway resource.␊ - */␊ - enableHttp2?: (boolean | string)␊ - /**␊ - * Whether FIPS is enabled on the application gateway resource.␊ - */␊ - enableFips?: (boolean | string)␊ - /**␊ - * Autoscale Configuration.␊ - */␊ - autoscaleConfiguration?: (ApplicationGatewayAutoscaleConfiguration10 | string)␊ - /**␊ - * Custom error configurations of the application gateway resource.␊ - */␊ - customErrorConfigurations?: (ApplicationGatewayCustomError7[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of an application gateway.␊ - */␊ - export interface ApplicationGatewaySku19 {␊ - /**␊ - * Name of an application gateway SKU.␊ - */␊ - name?: (("Standard_Small" | "Standard_Medium" | "Standard_Large" | "WAF_Medium" | "WAF_Large" | "Standard_v2" | "WAF_v2") | string)␊ - /**␊ - * Tier of an application gateway.␊ - */␊ - tier?: (("Standard" | "WAF" | "Standard_v2" | "WAF_v2") | string)␊ - /**␊ - * Capacity (instance count) of an application gateway.␊ - */␊ - capacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application Gateway Ssl policy.␊ - */␊ - export interface ApplicationGatewaySslPolicy16 {␊ - /**␊ - * Ssl protocols to be disabled on application gateway.␊ - */␊ - disabledSslProtocols?: (("TLSv1_0" | "TLSv1_1" | "TLSv1_2")[] | string)␊ - /**␊ - * Type of Ssl Policy.␊ - */␊ - policyType?: (("Predefined" | "Custom") | string)␊ - /**␊ - * Name of Ssl predefined policy.␊ - */␊ - policyName?: (("AppGwSslPolicy20150501" | "AppGwSslPolicy20170401" | "AppGwSslPolicy20170401S") | string)␊ - /**␊ - * Ssl cipher suites to be enabled in the specified order to application gateway.␊ - */␊ - cipherSuites?: (("TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384" | "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256" | "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA" | "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA" | "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384" | "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256" | "TLS_DHE_RSA_WITH_AES_256_CBC_SHA" | "TLS_DHE_RSA_WITH_AES_128_CBC_SHA" | "TLS_RSA_WITH_AES_256_GCM_SHA384" | "TLS_RSA_WITH_AES_128_GCM_SHA256" | "TLS_RSA_WITH_AES_256_CBC_SHA256" | "TLS_RSA_WITH_AES_128_CBC_SHA256" | "TLS_RSA_WITH_AES_256_CBC_SHA" | "TLS_RSA_WITH_AES_128_CBC_SHA" | "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384" | "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256" | "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384" | "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256" | "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA" | "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA" | "TLS_DHE_DSS_WITH_AES_256_CBC_SHA256" | "TLS_DHE_DSS_WITH_AES_128_CBC_SHA256" | "TLS_DHE_DSS_WITH_AES_256_CBC_SHA" | "TLS_DHE_DSS_WITH_AES_128_CBC_SHA" | "TLS_RSA_WITH_3DES_EDE_CBC_SHA" | "TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA" | "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256" | "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384")[] | string)␊ - /**␊ - * Minimum version of Ssl protocol to be supported on application gateway.␊ - */␊ - minProtocolVersion?: (("TLSv1_0" | "TLSv1_1" | "TLSv1_2") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed.␊ - */␊ - export interface ApplicationGatewayIPConfiguration19 {␊ - /**␊ - * Properties of the application gateway IP configuration.␊ - */␊ - properties?: (ApplicationGatewayIPConfigurationPropertiesFormat19 | string)␊ - /**␊ - * Name of the IP configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayIPConfigurationPropertiesFormat19 {␊ - /**␊ - * Reference of the subnet resource. A subnet from where application gateway gets its private address.␊ - */␊ - subnet?: (SubResource26 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Reference to another subresource.␊ - */␊ - export interface SubResource26 {␊ - /**␊ - * Resource ID.␊ - */␊ - id: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authentication certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewayAuthenticationCertificate16 {␊ - /**␊ - * Properties of the application gateway authentication certificate.␊ - */␊ - properties?: (ApplicationGatewayAuthenticationCertificatePropertiesFormat16 | string)␊ - /**␊ - * Name of the authentication certificate that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authentication certificates properties of an application gateway.␊ - */␊ - export interface ApplicationGatewayAuthenticationCertificatePropertiesFormat16 {␊ - /**␊ - * Certificate public data.␊ - */␊ - data?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trusted Root certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewayTrustedRootCertificate7 {␊ - /**␊ - * Properties of the application gateway trusted root certificate.␊ - */␊ - properties?: (ApplicationGatewayTrustedRootCertificatePropertiesFormat7 | string)␊ - /**␊ - * Name of the trusted root certificate that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trusted Root certificates properties of an application gateway.␊ - */␊ - export interface ApplicationGatewayTrustedRootCertificatePropertiesFormat7 {␊ - /**␊ - * Certificate public data.␊ - */␊ - data?: string␊ - /**␊ - * Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault.␊ - */␊ - keyVaultSecretId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSL certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewaySslCertificate19 {␊ - /**␊ - * Properties of the application gateway SSL certificate.␊ - */␊ - properties?: (ApplicationGatewaySslCertificatePropertiesFormat19 | string)␊ - /**␊ - * Name of the SSL certificate that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewaySslCertificatePropertiesFormat19 {␊ - /**␊ - * Base-64 encoded pfx certificate. Only applicable in PUT Request.␊ - */␊ - data?: string␊ - /**␊ - * Password for the pfx file specified in data. Only applicable in PUT request.␊ - */␊ - password?: string␊ - /**␊ - * Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault.␊ - */␊ - keyVaultSecretId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendIPConfiguration19 {␊ - /**␊ - * Properties of the application gateway frontend IP configuration.␊ - */␊ - properties?: (ApplicationGatewayFrontendIPConfigurationPropertiesFormat19 | string)␊ - /**␊ - * Name of the frontend IP configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendIPConfigurationPropertiesFormat19 {␊ - /**␊ - * PrivateIPAddress of the network interface IP Configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The private IP address allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Reference of the subnet resource.␊ - */␊ - subnet?: (SubResource26 | string)␊ - /**␊ - * Reference of the PublicIP resource.␊ - */␊ - publicIPAddress?: (SubResource26 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend port of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendPort19 {␊ - /**␊ - * Properties of the application gateway frontend port.␊ - */␊ - properties?: (ApplicationGatewayFrontendPortPropertiesFormat19 | string)␊ - /**␊ - * Name of the frontend port that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend port of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendPortPropertiesFormat19 {␊ - /**␊ - * Frontend port.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Probe of the application gateway.␊ - */␊ - export interface ApplicationGatewayProbe18 {␊ - /**␊ - * Properties of the application gateway probe.␊ - */␊ - properties?: (ApplicationGatewayProbePropertiesFormat18 | string)␊ - /**␊ - * Name of the probe that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of probe of an application gateway.␊ - */␊ - export interface ApplicationGatewayProbePropertiesFormat18 {␊ - /**␊ - * The protocol used for the probe.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Host name to send the probe to.␊ - */␊ - host?: string␊ - /**␊ - * Relative path of probe. Valid path starts from '/'. Probe is sent to ://:.␊ - */␊ - path?: string␊ - /**␊ - * The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - interval?: (number | string)␊ - /**␊ - * The probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - timeout?: (number | string)␊ - /**␊ - * The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20.␊ - */␊ - unhealthyThreshold?: (number | string)␊ - /**␊ - * Whether the host header should be picked from the backend http settings. Default value is false.␊ - */␊ - pickHostNameFromBackendHttpSettings?: (boolean | string)␊ - /**␊ - * Minimum number of servers that are always marked healthy. Default value is 0.␊ - */␊ - minServers?: (number | string)␊ - /**␊ - * Criterion for classifying a healthy probe response.␊ - */␊ - match?: (ApplicationGatewayProbeHealthResponseMatch16 | string)␊ - /**␊ - * Custom port which will be used for probing the backend servers. The valid value ranges from 1 to 65535. In case not set, port from http settings will be used. This property is valid for Standard_v2 and WAF_v2 only.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application gateway probe health response match.␊ - */␊ - export interface ApplicationGatewayProbeHealthResponseMatch16 {␊ - /**␊ - * Body that must be contained in the health response. Default value is empty.␊ - */␊ - body?: string␊ - /**␊ - * Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399.␊ - */␊ - statusCodes?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend Address Pool of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddressPool19 {␊ - /**␊ - * Properties of the application gateway backend address pool.␊ - */␊ - properties?: (ApplicationGatewayBackendAddressPoolPropertiesFormat19 | string)␊ - /**␊ - * Name of the backend address pool that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend Address Pool of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddressPoolPropertiesFormat19 {␊ - /**␊ - * Backend addresses.␊ - */␊ - backendAddresses?: (ApplicationGatewayBackendAddress19[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddress19 {␊ - /**␊ - * Fully qualified domain name (FQDN).␊ - */␊ - fqdn?: string␊ - /**␊ - * IP address.␊ - */␊ - ipAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address pool settings of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendHttpSettings19 {␊ - /**␊ - * Properties of the application gateway backend HTTP settings.␊ - */␊ - properties?: (ApplicationGatewayBackendHttpSettingsPropertiesFormat19 | string)␊ - /**␊ - * Name of the backend http settings that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend address pool settings of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendHttpSettingsPropertiesFormat19 {␊ - /**␊ - * The destination port on the backend.␊ - */␊ - port?: (number | string)␊ - /**␊ - * The protocol used to communicate with the backend.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Cookie based affinity.␊ - */␊ - cookieBasedAffinity?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Request timeout in seconds. Application Gateway will fail the request if response is not received within RequestTimeout. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - requestTimeout?: (number | string)␊ - /**␊ - * Probe resource of an application gateway.␊ - */␊ - probe?: (SubResource26 | string)␊ - /**␊ - * Array of references to application gateway authentication certificates.␊ - */␊ - authenticationCertificates?: (SubResource26[] | string)␊ - /**␊ - * Array of references to application gateway trusted root certificates.␊ - */␊ - trustedRootCertificates?: (SubResource26[] | string)␊ - /**␊ - * Connection draining of the backend http settings resource.␊ - */␊ - connectionDraining?: (ApplicationGatewayConnectionDraining16 | string)␊ - /**␊ - * Host header to be sent to the backend servers.␊ - */␊ - hostName?: string␊ - /**␊ - * Whether to pick host header should be picked from the host name of the backend server. Default value is false.␊ - */␊ - pickHostNameFromBackendAddress?: (boolean | string)␊ - /**␊ - * Cookie name to use for the affinity cookie.␊ - */␊ - affinityCookieName?: string␊ - /**␊ - * Whether the probe is enabled. Default value is false.␊ - */␊ - probeEnabled?: (boolean | string)␊ - /**␊ - * Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null.␊ - */␊ - path?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Connection draining allows open connections to a backend server to be active for a specified time after the backend server got removed from the configuration.␊ - */␊ - export interface ApplicationGatewayConnectionDraining16 {␊ - /**␊ - * Whether connection draining is enabled or not.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds.␊ - */␊ - drainTimeoutInSec: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http listener of an application gateway.␊ - */␊ - export interface ApplicationGatewayHttpListener19 {␊ - /**␊ - * Properties of the application gateway HTTP listener.␊ - */␊ - properties?: (ApplicationGatewayHttpListenerPropertiesFormat19 | string)␊ - /**␊ - * Name of the HTTP listener that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of HTTP listener of an application gateway.␊ - */␊ - export interface ApplicationGatewayHttpListenerPropertiesFormat19 {␊ - /**␊ - * Frontend IP configuration resource of an application gateway.␊ - */␊ - frontendIPConfiguration?: (SubResource26 | string)␊ - /**␊ - * Frontend port resource of an application gateway.␊ - */␊ - frontendPort?: (SubResource26 | string)␊ - /**␊ - * Protocol of the HTTP listener.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Host name of HTTP listener.␊ - */␊ - hostName?: string␊ - /**␊ - * SSL certificate resource of an application gateway.␊ - */␊ - sslCertificate?: (SubResource26 | string)␊ - /**␊ - * Applicable only if protocol is https. Enables SNI for multi-hosting.␊ - */␊ - requireServerNameIndication?: (boolean | string)␊ - /**␊ - * Custom error configurations of the HTTP listener.␊ - */␊ - customErrorConfigurations?: (ApplicationGatewayCustomError7[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Customer error of an application gateway.␊ - */␊ - export interface ApplicationGatewayCustomError7 {␊ - /**␊ - * Status code of the application gateway customer error.␊ - */␊ - statusCode?: (("HttpStatus403" | "HttpStatus502") | string)␊ - /**␊ - * Error page URL of the application gateway customer error.␊ - */␊ - customErrorPageUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * UrlPathMaps give a url path to the backend mapping information for PathBasedRouting.␊ - */␊ - export interface ApplicationGatewayUrlPathMap18 {␊ - /**␊ - * Properties of the application gateway URL path map.␊ - */␊ - properties?: (ApplicationGatewayUrlPathMapPropertiesFormat18 | string)␊ - /**␊ - * Name of the URL path map that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of UrlPathMap of the application gateway.␊ - */␊ - export interface ApplicationGatewayUrlPathMapPropertiesFormat18 {␊ - /**␊ - * Default backend address pool resource of URL path map.␊ - */␊ - defaultBackendAddressPool?: (SubResource26 | string)␊ - /**␊ - * Default backend http settings resource of URL path map.␊ - */␊ - defaultBackendHttpSettings?: (SubResource26 | string)␊ - /**␊ - * Default Rewrite rule set resource of URL path map.␊ - */␊ - defaultRewriteRuleSet?: (SubResource26 | string)␊ - /**␊ - * Default redirect configuration resource of URL path map.␊ - */␊ - defaultRedirectConfiguration?: (SubResource26 | string)␊ - /**␊ - * Path rule of URL path map resource.␊ - */␊ - pathRules?: (ApplicationGatewayPathRule18[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Path rule of URL path map of an application gateway.␊ - */␊ - export interface ApplicationGatewayPathRule18 {␊ - /**␊ - * Properties of the application gateway path rule.␊ - */␊ - properties?: (ApplicationGatewayPathRulePropertiesFormat18 | string)␊ - /**␊ - * Name of the path rule that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of path rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayPathRulePropertiesFormat18 {␊ - /**␊ - * Path rules of URL path map.␊ - */␊ - paths?: (string[] | string)␊ - /**␊ - * Backend address pool resource of URL path map path rule.␊ - */␊ - backendAddressPool?: (SubResource26 | string)␊ - /**␊ - * Backend http settings resource of URL path map path rule.␊ - */␊ - backendHttpSettings?: (SubResource26 | string)␊ - /**␊ - * Redirect configuration resource of URL path map path rule.␊ - */␊ - redirectConfiguration?: (SubResource26 | string)␊ - /**␊ - * Rewrite rule set resource of URL path map path rule.␊ - */␊ - rewriteRuleSet?: (SubResource26 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Request routing rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayRequestRoutingRule19 {␊ - /**␊ - * Properties of the application gateway request routing rule.␊ - */␊ - properties?: (ApplicationGatewayRequestRoutingRulePropertiesFormat19 | string)␊ - /**␊ - * Name of the request routing rule that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of request routing rule of the application gateway.␊ - */␊ - export interface ApplicationGatewayRequestRoutingRulePropertiesFormat19 {␊ - /**␊ - * Rule type.␊ - */␊ - ruleType?: (("Basic" | "PathBasedRouting") | string)␊ - /**␊ - * Priority of the request routing rule.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * Backend address pool resource of the application gateway.␊ - */␊ - backendAddressPool?: (SubResource26 | string)␊ - /**␊ - * Backend http settings resource of the application gateway.␊ - */␊ - backendHttpSettings?: (SubResource26 | string)␊ - /**␊ - * Http listener resource of the application gateway.␊ - */␊ - httpListener?: (SubResource26 | string)␊ - /**␊ - * URL path map resource of the application gateway.␊ - */␊ - urlPathMap?: (SubResource26 | string)␊ - /**␊ - * Rewrite Rule Set resource in Basic rule of the application gateway.␊ - */␊ - rewriteRuleSet?: (SubResource26 | string)␊ - /**␊ - * Redirect configuration resource of the application gateway.␊ - */␊ - redirectConfiguration?: (SubResource26 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Rewrite rule set of an application gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRuleSet6 {␊ - /**␊ - * Properties of the application gateway rewrite rule set.␊ - */␊ - properties?: (ApplicationGatewayRewriteRuleSetPropertiesFormat6 | string)␊ - /**␊ - * Name of the rewrite rule set that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of rewrite rule set of the application gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRuleSetPropertiesFormat6 {␊ - /**␊ - * Rewrite rules in the rewrite rule set.␊ - */␊ - rewriteRules?: (ApplicationGatewayRewriteRule6[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Rewrite rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRule6 {␊ - /**␊ - * Name of the rewrite rule that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet.␊ - */␊ - ruleSequence?: (number | string)␊ - /**␊ - * Conditions based on which the action set execution will be evaluated.␊ - */␊ - conditions?: (ApplicationGatewayRewriteRuleCondition5[] | string)␊ - /**␊ - * Set of actions to be done as part of the rewrite Rule.␊ - */␊ - actionSet?: (ApplicationGatewayRewriteRuleActionSet6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Set of conditions in the Rewrite Rule in Application Gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRuleCondition5 {␊ - /**␊ - * The condition parameter of the RewriteRuleCondition.␊ - */␊ - variable?: string␊ - /**␊ - * The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition.␊ - */␊ - pattern?: string␊ - /**␊ - * Setting this paramter to truth value with force the pattern to do a case in-sensitive comparison.␊ - */␊ - ignoreCase?: (boolean | string)␊ - /**␊ - * Setting this value as truth will force to check the negation of the condition given by the user.␊ - */␊ - negate?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Set of actions in the Rewrite Rule in Application Gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRuleActionSet6 {␊ - /**␊ - * Request Header Actions in the Action Set.␊ - */␊ - requestHeaderConfigurations?: (ApplicationGatewayHeaderConfiguration6[] | string)␊ - /**␊ - * Response Header Actions in the Action Set.␊ - */␊ - responseHeaderConfigurations?: (ApplicationGatewayHeaderConfiguration6[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Header configuration of the Actions set in Application Gateway.␊ - */␊ - export interface ApplicationGatewayHeaderConfiguration6 {␊ - /**␊ - * Header name of the header configuration.␊ - */␊ - headerName?: string␊ - /**␊ - * Header value of the header configuration.␊ - */␊ - headerValue?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Redirect configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayRedirectConfiguration16 {␊ - /**␊ - * Properties of the application gateway redirect configuration.␊ - */␊ - properties?: (ApplicationGatewayRedirectConfigurationPropertiesFormat16 | string)␊ - /**␊ - * Name of the redirect configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of redirect configuration of the application gateway.␊ - */␊ - export interface ApplicationGatewayRedirectConfigurationPropertiesFormat16 {␊ - /**␊ - * HTTP redirection type.␊ - */␊ - redirectType?: (("Permanent" | "Found" | "SeeOther" | "Temporary") | string)␊ - /**␊ - * Reference to a listener to redirect the request to.␊ - */␊ - targetListener?: (SubResource26 | string)␊ - /**␊ - * Url to redirect the request to.␊ - */␊ - targetUrl?: string␊ - /**␊ - * Include path in the redirected url.␊ - */␊ - includePath?: (boolean | string)␊ - /**␊ - * Include query string in the redirected url.␊ - */␊ - includeQueryString?: (boolean | string)␊ - /**␊ - * Request routing specifying redirect configuration.␊ - */␊ - requestRoutingRules?: (SubResource26[] | string)␊ - /**␊ - * Url path maps specifying default redirect configuration.␊ - */␊ - urlPathMaps?: (SubResource26[] | string)␊ - /**␊ - * Path rules specifying redirect configuration.␊ - */␊ - pathRules?: (SubResource26[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application gateway web application firewall configuration.␊ - */␊ - export interface ApplicationGatewayWebApplicationFirewallConfiguration16 {␊ - /**␊ - * Whether the web application firewall is enabled or not.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * Web application firewall mode.␊ - */␊ - firewallMode: (("Detection" | "Prevention") | string)␊ - /**␊ - * The type of the web application firewall rule set. Possible values are: 'OWASP'.␊ - */␊ - ruleSetType: string␊ - /**␊ - * The version of the rule set type.␊ - */␊ - ruleSetVersion: string␊ - /**␊ - * The disabled rule groups.␊ - */␊ - disabledRuleGroups?: (ApplicationGatewayFirewallDisabledRuleGroup16[] | string)␊ - /**␊ - * Whether allow WAF to check request Body.␊ - */␊ - requestBodyCheck?: (boolean | string)␊ - /**␊ - * Maximum request body size for WAF.␊ - */␊ - maxRequestBodySize?: (number | string)␊ - /**␊ - * Maximum request body size in Kb for WAF.␊ - */␊ - maxRequestBodySizeInKb?: (number | string)␊ - /**␊ - * Maximum file upload size in Mb for WAF.␊ - */␊ - fileUploadLimitInMb?: (number | string)␊ - /**␊ - * The exclusion list.␊ - */␊ - exclusions?: (ApplicationGatewayFirewallExclusion7[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allows to disable rules within a rule group or an entire rule group.␊ - */␊ - export interface ApplicationGatewayFirewallDisabledRuleGroup16 {␊ - /**␊ - * The name of the rule group that will be disabled.␊ - */␊ - ruleGroupName: string␊ - /**␊ - * The list of rules that will be disabled. If null, all rules of the rule group will be disabled.␊ - */␊ - rules?: (number[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allow to exclude some variable satisfy the condition for the WAF check.␊ - */␊ - export interface ApplicationGatewayFirewallExclusion7 {␊ - /**␊ - * The variable to be excluded.␊ - */␊ - matchVariable: string␊ - /**␊ - * When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to.␊ - */␊ - selectorMatchOperator: string␊ - /**␊ - * When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to.␊ - */␊ - selector: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application Gateway autoscale configuration.␊ - */␊ - export interface ApplicationGatewayAutoscaleConfiguration10 {␊ - /**␊ - * Lower bound on number of Application Gateway capacity.␊ - */␊ - minCapacity: (number | string)␊ - /**␊ - * Upper bound on number of Application Gateway capacity.␊ - */␊ - maxCapacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the resource.␊ - */␊ - export interface ManagedServiceIdentity6 {␊ - /**␊ - * The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.␊ - */␊ - type?: ("SystemAssigned" | "UserAssigned" | "SystemAssigned, UserAssigned" | "None")␊ - /**␊ - * The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.␊ - */␊ - userAssignedIdentities?: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies␊ - */␊ - export interface ApplicationGatewayWebApplicationFirewallPolicies4 {␊ - name: string␊ - type: "Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the web application firewall policy.␊ - */␊ - properties: (WebApplicationFirewallPolicyPropertiesFormat4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines web application firewall policy properties.␊ - */␊ - export interface WebApplicationFirewallPolicyPropertiesFormat4 {␊ - /**␊ - * Describes policySettings for policy.␊ - */␊ - policySettings?: (PolicySettings6 | string)␊ - /**␊ - * Describes custom rules inside the policy.␊ - */␊ - customRules?: (WebApplicationFirewallCustomRule4[] | string)␊ - /**␊ - * Describes the managedRules structure␊ - */␊ - managedRules: (ManagedRulesDefinition | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines contents of a web application firewall global configuration.␊ - */␊ - export interface PolicySettings6 {␊ - /**␊ - * Describes if the policy is in enabled state or disabled state.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * Describes if it is in detection mode or prevention mode at policy level.␊ - */␊ - mode?: (("Prevention" | "Detection") | string)␊ - /**␊ - * Whether to allow WAF to check request Body.␊ - */␊ - requestBodyCheck?: (boolean | string)␊ - /**␊ - * Maximum request body size in Kb for WAF.␊ - */␊ - maxRequestBodySizeInKb?: (number | string)␊ - /**␊ - * Maximum file upload size in Mb for WAF.␊ - */␊ - fileUploadLimitInMb?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines contents of a web application rule.␊ - */␊ - export interface WebApplicationFirewallCustomRule4 {␊ - /**␊ - * The name of the resource that is unique within a policy. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value.␊ - */␊ - priority: (number | string)␊ - /**␊ - * Describes type of rule.␊ - */␊ - ruleType: (("MatchRule" | "Invalid") | string)␊ - /**␊ - * List of match conditions.␊ - */␊ - matchConditions: (MatchCondition6[] | string)␊ - /**␊ - * Type of Actions.␊ - */␊ - action: (("Allow" | "Block" | "Log") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Define match conditions.␊ - */␊ - export interface MatchCondition6 {␊ - /**␊ - * List of match variables.␊ - */␊ - matchVariables: (MatchVariable4[] | string)␊ - /**␊ - * Describes operator to be matched.␊ - */␊ - operator: (("IPMatch" | "Equal" | "Contains" | "LessThan" | "GreaterThan" | "LessThanOrEqual" | "GreaterThanOrEqual" | "BeginsWith" | "EndsWith" | "Regex") | string)␊ - /**␊ - * Describes if this is negate condition or not.␊ - */␊ - negationConditon?: (boolean | string)␊ - /**␊ - * Match value.␊ - */␊ - matchValues: (string[] | string)␊ - /**␊ - * List of transforms.␊ - */␊ - transforms?: (("Lowercase" | "Trim" | "UrlDecode" | "UrlEncode" | "RemoveNulls" | "HtmlEntityDecode")[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Define match variables.␊ - */␊ - export interface MatchVariable4 {␊ - /**␊ - * Match Variable.␊ - */␊ - variableName: (("RemoteAddr" | "RequestMethod" | "QueryString" | "PostArgs" | "RequestUri" | "RequestHeaders" | "RequestBody" | "RequestCookies") | string)␊ - /**␊ - * Describes field of the matchVariable collection.␊ - */␊ - selector?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allow to exclude some variable satisfy the condition for the WAF check.␊ - */␊ - export interface ManagedRulesDefinition {␊ - /**␊ - * Describes the Exclusions that are applied on the policy.␊ - */␊ - exclusions?: (OwaspCrsExclusionEntry[] | string)␊ - /**␊ - * Describes the ruleSets that are associated with the policy.␊ - */␊ - managedRuleSets: (ManagedRuleSet2[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allow to exclude some variable satisfy the condition for the WAF check.␊ - */␊ - export interface OwaspCrsExclusionEntry {␊ - /**␊ - * The variable to be excluded.␊ - */␊ - matchVariable: (("RequestHeaderNames" | "RequestCookieNames" | "RequestArgNames") | string)␊ - /**␊ - * When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to.␊ - */␊ - selectorMatchOperator: (("Equals" | "Contains" | "StartsWith" | "EndsWith" | "EqualsAny") | string)␊ - /**␊ - * When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to.␊ - */␊ - selector: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines a managed rule set.␊ - */␊ - export interface ManagedRuleSet2 {␊ - /**␊ - * Defines the rule set type to use.␊ - */␊ - ruleSetType: string␊ - /**␊ - * Defines the version of the rule set to use.␊ - */␊ - ruleSetVersion: string␊ - /**␊ - * Defines the rule group overrides to apply to the rule set.␊ - */␊ - ruleGroupOverrides?: (ManagedRuleGroupOverride2[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines a managed rule group override setting.␊ - */␊ - export interface ManagedRuleGroupOverride2 {␊ - /**␊ - * Describes the managed rule group to override.␊ - */␊ - ruleGroupName: string␊ - /**␊ - * List of rules that will be disabled. If none specified, all rules in the group will be disabled.␊ - */␊ - rules?: (ManagedRuleOverride2[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines a managed rule group override setting.␊ - */␊ - export interface ManagedRuleOverride2 {␊ - /**␊ - * Identifier for the managed rule.␊ - */␊ - ruleId: string␊ - /**␊ - * Describes the state of the managed rule. Defaults to Disabled if not specified.␊ - */␊ - state?: ("Disabled" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/applicationSecurityGroups␊ - */␊ - export interface ApplicationSecurityGroups16 {␊ - name: string␊ - type: "Microsoft.Network/applicationSecurityGroups"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the application security group.␊ - */␊ - properties: (ApplicationSecurityGroupPropertiesFormat3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application security group properties.␊ - */␊ - export interface ApplicationSecurityGroupPropertiesFormat3 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/azureFirewalls␊ - */␊ - export interface AzureFirewalls6 {␊ - name: string␊ - type: "Microsoft.Network/azureFirewalls"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the azure firewall.␊ - */␊ - properties: (AzureFirewallPropertiesFormat6 | string)␊ - /**␊ - * A list of availability zones denoting where the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Azure Firewall.␊ - */␊ - export interface AzureFirewallPropertiesFormat6 {␊ - /**␊ - * Collection of application rule collections used by Azure Firewall.␊ - */␊ - applicationRuleCollections?: (AzureFirewallApplicationRuleCollection6[] | string)␊ - /**␊ - * Collection of NAT rule collections used by Azure Firewall.␊ - */␊ - natRuleCollections?: (AzureFirewallNatRuleCollection3[] | string)␊ - /**␊ - * Collection of network rule collections used by Azure Firewall.␊ - */␊ - networkRuleCollections?: (AzureFirewallNetworkRuleCollection6[] | string)␊ - /**␊ - * IP configuration of the Azure Firewall resource.␊ - */␊ - ipConfigurations?: (AzureFirewallIPConfiguration6[] | string)␊ - /**␊ - * The operation mode for Threat Intelligence.␊ - */␊ - threatIntelMode?: (("Alert" | "Deny" | "Off") | string)␊ - /**␊ - * The virtualHub to which the firewall belongs.␊ - */␊ - virtualHub?: (SubResource26 | string)␊ - /**␊ - * The firewallPolicy associated with this azure firewall.␊ - */␊ - firewallPolicy?: (SubResource26 | string)␊ - /**␊ - * The Azure Firewall Resource SKU.␊ - */␊ - sku?: (AzureFirewallSku | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application rule collection resource.␊ - */␊ - export interface AzureFirewallApplicationRuleCollection6 {␊ - /**␊ - * Properties of the azure firewall application rule collection.␊ - */␊ - properties?: (AzureFirewallApplicationRuleCollectionPropertiesFormat6 | string)␊ - /**␊ - * The name of the resource that is unique within the Azure firewall. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application rule collection.␊ - */␊ - export interface AzureFirewallApplicationRuleCollectionPropertiesFormat6 {␊ - /**␊ - * Priority of the application rule collection resource.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * The action type of a rule collection.␊ - */␊ - action?: (AzureFirewallRCAction6 | string)␊ - /**␊ - * Collection of rules used by a application rule collection.␊ - */␊ - rules?: (AzureFirewallApplicationRule6[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the AzureFirewallRCAction.␊ - */␊ - export interface AzureFirewallRCAction6 {␊ - /**␊ - * The type of action.␊ - */␊ - type?: ("Allow" | "Deny")␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of an application rule.␊ - */␊ - export interface AzureFirewallApplicationRule6 {␊ - /**␊ - * Name of the application rule.␊ - */␊ - name?: string␊ - /**␊ - * Description of the rule.␊ - */␊ - description?: string␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * Array of ApplicationRuleProtocols.␊ - */␊ - protocols?: (AzureFirewallApplicationRuleProtocol6[] | string)␊ - /**␊ - * List of FQDNs for this rule.␊ - */␊ - targetFqdns?: (string[] | string)␊ - /**␊ - * List of FQDN Tags for this rule.␊ - */␊ - fqdnTags?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application rule protocol.␊ - */␊ - export interface AzureFirewallApplicationRuleProtocol6 {␊ - /**␊ - * Protocol type.␊ - */␊ - protocolType?: (("Http" | "Https" | "Mssql") | string)␊ - /**␊ - * Port number for the protocol, cannot be greater than 64000. This field is optional.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NAT rule collection resource.␊ - */␊ - export interface AzureFirewallNatRuleCollection3 {␊ - /**␊ - * Properties of the azure firewall NAT rule collection.␊ - */␊ - properties?: (AzureFirewallNatRuleCollectionProperties3 | string)␊ - /**␊ - * The name of the resource that is unique within the Azure firewall. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the NAT rule collection.␊ - */␊ - export interface AzureFirewallNatRuleCollectionProperties3 {␊ - /**␊ - * Priority of the NAT rule collection resource.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * The action type of a NAT rule collection.␊ - */␊ - action?: (AzureFirewallNatRCAction3 | string)␊ - /**␊ - * Collection of rules used by a NAT rule collection.␊ - */␊ - rules?: (AzureFirewallNatRule3[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AzureFirewall NAT Rule Collection Action.␊ - */␊ - export interface AzureFirewallNatRCAction3 {␊ - /**␊ - * The type of action.␊ - */␊ - type?: ("Snat" | "Dnat")␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a NAT rule.␊ - */␊ - export interface AzureFirewallNatRule3 {␊ - /**␊ - * Name of the NAT rule.␊ - */␊ - name?: string␊ - /**␊ - * Description of the rule.␊ - */␊ - description?: string␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags.␊ - */␊ - destinationAddresses?: (string[] | string)␊ - /**␊ - * List of destination ports.␊ - */␊ - destinationPorts?: (string[] | string)␊ - /**␊ - * Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule.␊ - */␊ - protocols?: (("TCP" | "UDP" | "Any" | "ICMP")[] | string)␊ - /**␊ - * The translated address for this NAT rule.␊ - */␊ - translatedAddress?: string␊ - /**␊ - * The translated port for this NAT rule.␊ - */␊ - translatedPort?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network rule collection resource.␊ - */␊ - export interface AzureFirewallNetworkRuleCollection6 {␊ - /**␊ - * Properties of the azure firewall network rule collection.␊ - */␊ - properties?: (AzureFirewallNetworkRuleCollectionPropertiesFormat6 | string)␊ - /**␊ - * The name of the resource that is unique within the Azure firewall. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the network rule collection.␊ - */␊ - export interface AzureFirewallNetworkRuleCollectionPropertiesFormat6 {␊ - /**␊ - * Priority of the network rule collection resource.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * The action type of a rule collection.␊ - */␊ - action?: (AzureFirewallRCAction6 | string)␊ - /**␊ - * Collection of rules used by a network rule collection.␊ - */␊ - rules?: (AzureFirewallNetworkRule6[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the network rule.␊ - */␊ - export interface AzureFirewallNetworkRule6 {␊ - /**␊ - * Name of the network rule.␊ - */␊ - name?: string␊ - /**␊ - * Description of the rule.␊ - */␊ - description?: string␊ - /**␊ - * Array of AzureFirewallNetworkRuleProtocols.␊ - */␊ - protocols?: (("TCP" | "UDP" | "Any" | "ICMP")[] | string)␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * List of destination IP addresses.␊ - */␊ - destinationAddresses?: (string[] | string)␊ - /**␊ - * List of destination ports.␊ - */␊ - destinationPorts?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration of an Azure Firewall.␊ - */␊ - export interface AzureFirewallIPConfiguration6 {␊ - /**␊ - * Properties of the azure firewall IP configuration.␊ - */␊ - properties?: (AzureFirewallIPConfigurationPropertiesFormat6 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration of an Azure Firewall.␊ - */␊ - export interface AzureFirewallIPConfigurationPropertiesFormat6 {␊ - /**␊ - * Reference of the subnet resource. This resource must be named 'AzureFirewallSubnet'.␊ - */␊ - subnet?: (SubResource26 | string)␊ - /**␊ - * Reference of the PublicIP resource. This field is a mandatory input if subnet is not null.␊ - */␊ - publicIPAddress?: (SubResource26 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of an Azure Firewall.␊ - */␊ - export interface AzureFirewallSku {␊ - /**␊ - * Name of an Azure Firewall SKU.␊ - */␊ - name?: (("AZFW_VNet" | "AZFW_Hub") | string)␊ - /**␊ - * Tier of an Azure Firewall.␊ - */␊ - tier?: ("Standard" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/bastionHosts␊ - */␊ - export interface BastionHosts3 {␊ - name: string␊ - type: "Microsoft.Network/bastionHosts"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Represents the bastion host resource.␊ - */␊ - properties: (BastionHostPropertiesFormat3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Bastion Host.␊ - */␊ - export interface BastionHostPropertiesFormat3 {␊ - /**␊ - * IP configuration of the Bastion Host resource.␊ - */␊ - ipConfigurations?: (BastionHostIPConfiguration3[] | string)␊ - /**␊ - * FQDN for the endpoint on which bastion host is accessible.␊ - */␊ - dnsName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration of an Bastion Host.␊ - */␊ - export interface BastionHostIPConfiguration3 {␊ - /**␊ - * Represents the ip configuration associated with the resource.␊ - */␊ - properties?: (BastionHostIPConfigurationPropertiesFormat3 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration of an Bastion Host.␊ - */␊ - export interface BastionHostIPConfigurationPropertiesFormat3 {␊ - /**␊ - * Reference of the subnet resource.␊ - */␊ - subnet: (SubResource26 | string)␊ - /**␊ - * Reference of the PublicIP resource.␊ - */␊ - publicIPAddress: (SubResource26 | string)␊ - /**␊ - * Private IP allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/connections␊ - */␊ - export interface Connections16 {␊ - name: string␊ - type: "Microsoft.Network/connections"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway connection.␊ - */␊ - properties: (VirtualNetworkGatewayConnectionPropertiesFormat16 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewayConnection properties.␊ - */␊ - export interface VirtualNetworkGatewayConnectionPropertiesFormat16 {␊ - /**␊ - * The authorizationKey.␊ - */␊ - authorizationKey?: string␊ - /**␊ - * The reference to virtual network gateway resource.␊ - */␊ - virtualNetworkGateway1: (SubResource26 | string)␊ - /**␊ - * The reference to virtual network gateway resource.␊ - */␊ - virtualNetworkGateway2?: (SubResource26 | string)␊ - /**␊ - * The reference to local network gateway resource.␊ - */␊ - localNetworkGateway2?: (SubResource26 | string)␊ - /**␊ - * Gateway connection type.␊ - */␊ - connectionType: (("IPsec" | "Vnet2Vnet" | "ExpressRoute" | "VPNClient") | string)␊ - /**␊ - * Connection protocol used for this connection.␊ - */␊ - connectionProtocol?: (("IKEv2" | "IKEv1") | string)␊ - /**␊ - * The routing weight.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * The IPSec shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The reference to peerings resource.␊ - */␊ - peer?: (SubResource26 | string)␊ - /**␊ - * EnableBgp flag.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * Enable policy-based traffic selectors.␊ - */␊ - usePolicyBasedTrafficSelectors?: (boolean | string)␊ - /**␊ - * The IPSec Policies to be considered by this connection.␊ - */␊ - ipsecPolicies?: (IpsecPolicy13[] | string)␊ - /**␊ - * The Traffic Selector Policies to be considered by this connection.␊ - */␊ - trafficSelectorPolicies?: (TrafficSelectorPolicy1[] | string)␊ - /**␊ - * Bypass ExpressRoute Gateway for data forwarding.␊ - */␊ - expressRouteGatewayBypass?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An IPSec Policy configuration for a virtual network gateway connection.␊ - */␊ - export interface IpsecPolicy13 {␊ - /**␊ - * The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.␊ - */␊ - saLifeTimeSeconds: (number | string)␊ - /**␊ - * The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.␊ - */␊ - saDataSizeKilobytes: (number | string)␊ - /**␊ - * The IPSec encryption algorithm (IKE phase 1).␊ - */␊ - ipsecEncryption: (("None" | "DES" | "DES3" | "AES128" | "AES192" | "AES256" | "GCMAES128" | "GCMAES192" | "GCMAES256") | string)␊ - /**␊ - * The IPSec integrity algorithm (IKE phase 1).␊ - */␊ - ipsecIntegrity: (("MD5" | "SHA1" | "SHA256" | "GCMAES128" | "GCMAES192" | "GCMAES256") | string)␊ - /**␊ - * The IKE encryption algorithm (IKE phase 2).␊ - */␊ - ikeEncryption: (("DES" | "DES3" | "AES128" | "AES192" | "AES256" | "GCMAES256" | "GCMAES128") | string)␊ - /**␊ - * The IKE integrity algorithm (IKE phase 2).␊ - */␊ - ikeIntegrity: (("MD5" | "SHA1" | "SHA256" | "SHA384" | "GCMAES256" | "GCMAES128") | string)␊ - /**␊ - * The DH Group used in IKE Phase 1 for initial SA.␊ - */␊ - dhGroup: (("None" | "DHGroup1" | "DHGroup2" | "DHGroup14" | "DHGroup2048" | "ECP256" | "ECP384" | "DHGroup24") | string)␊ - /**␊ - * The Pfs Group used in IKE Phase 2 for new child SA.␊ - */␊ - pfsGroup: (("None" | "PFS1" | "PFS2" | "PFS2048" | "ECP256" | "ECP384" | "PFS24" | "PFS14" | "PFSMM") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An traffic selector policy for a virtual network gateway connection.␊ - */␊ - export interface TrafficSelectorPolicy1 {␊ - /**␊ - * A collection of local address spaces in CIDR format␊ - */␊ - localAddressRanges: (string[] | string)␊ - /**␊ - * A collection of remote address spaces in CIDR format␊ - */␊ - remoteAddressRanges: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ddosCustomPolicies␊ - */␊ - export interface DdosCustomPolicies3 {␊ - name: string␊ - type: "Microsoft.Network/ddosCustomPolicies"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the DDoS custom policy.␊ - */␊ - properties: (DdosCustomPolicyPropertiesFormat3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DDoS custom policy properties.␊ - */␊ - export interface DdosCustomPolicyPropertiesFormat3 {␊ - /**␊ - * The protocol-specific DDoS policy customization parameters.␊ - */␊ - protocolCustomSettings?: (ProtocolCustomSettingsFormat3[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DDoS custom policy properties.␊ - */␊ - export interface ProtocolCustomSettingsFormat3 {␊ - /**␊ - * The protocol for which the DDoS protection policy is being customized.␊ - */␊ - protocol?: (("Tcp" | "Udp" | "Syn") | string)␊ - /**␊ - * The customized DDoS protection trigger rate.␊ - */␊ - triggerRateOverride?: string␊ - /**␊ - * The customized DDoS protection source rate.␊ - */␊ - sourceRateOverride?: string␊ - /**␊ - * The customized DDoS protection trigger rate sensitivity degrees. High: Trigger rate set with most sensitivity w.r.t. normal traffic. Default: Trigger rate set with moderate sensitivity w.r.t. normal traffic. Low: Trigger rate set with less sensitivity w.r.t. normal traffic. Relaxed: Trigger rate set with least sensitivity w.r.t. normal traffic.␊ - */␊ - triggerSensitivityOverride?: (("Relaxed" | "Low" | "Default" | "High") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ddosProtectionPlans␊ - */␊ - export interface DdosProtectionPlans11 {␊ - name: string␊ - type: "Microsoft.Network/ddosProtectionPlans"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the DDoS protection plan.␊ - */␊ - properties: (DdosProtectionPlanPropertiesFormat8 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DDoS protection plan properties.␊ - */␊ - export interface DdosProtectionPlanPropertiesFormat8 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits␊ - */␊ - export interface ExpressRouteCircuits13 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The SKU.␊ - */␊ - sku?: (ExpressRouteCircuitSku13 | string)␊ - /**␊ - * Properties of the express route circuit.␊ - */␊ - properties: (ExpressRouteCircuitPropertiesFormat13 | string)␊ - resources?: (ExpressRouteCircuitsPeeringsChildResource13 | ExpressRouteCircuitsAuthorizationsChildResource13)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains SKU in an ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitSku13 {␊ - /**␊ - * The name of the SKU.␊ - */␊ - name?: string␊ - /**␊ - * The tier of the SKU.␊ - */␊ - tier?: (("Standard" | "Premium" | "Basic" | "Local") | string)␊ - /**␊ - * The family of the SKU.␊ - */␊ - family?: (("UnlimitedData" | "MeteredData") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitPropertiesFormat13 {␊ - /**␊ - * Allow classic operations.␊ - */␊ - allowClassicOperations?: (boolean | string)␊ - /**␊ - * The list of authorizations.␊ - */␊ - authorizations?: (ExpressRouteCircuitAuthorization13[] | string)␊ - /**␊ - * The list of peerings.␊ - */␊ - peerings?: (ExpressRouteCircuitPeering13[] | string)␊ - /**␊ - * The ServiceProviderNotes.␊ - */␊ - serviceProviderNotes?: string␊ - /**␊ - * The ServiceProviderProperties.␊ - */␊ - serviceProviderProperties?: (ExpressRouteCircuitServiceProviderProperties13 | string)␊ - /**␊ - * The reference to the ExpressRoutePort resource when the circuit is provisioned on an ExpressRoutePort resource.␊ - */␊ - expressRoutePort?: (SubResource26 | string)␊ - /**␊ - * The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource.␊ - */␊ - bandwidthInGbps?: (number | string)␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authorization in an ExpressRouteCircuit resource.␊ - */␊ - export interface ExpressRouteCircuitAuthorization13 {␊ - /**␊ - * Properties of the express route circuit authorization.␊ - */␊ - properties?: (AuthorizationPropertiesFormat14 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ExpressRouteCircuitAuthorization.␊ - */␊ - export interface AuthorizationPropertiesFormat14 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peering in an ExpressRouteCircuit resource.␊ - */␊ - export interface ExpressRouteCircuitPeering13 {␊ - /**␊ - * Properties of the express route circuit peering.␊ - */␊ - properties?: (ExpressRouteCircuitPeeringPropertiesFormat14 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the express route circuit peering.␊ - */␊ - export interface ExpressRouteCircuitPeeringPropertiesFormat14 {␊ - /**␊ - * The peering type.␊ - */␊ - peeringType?: (("AzurePublicPeering" | "AzurePrivatePeering" | "MicrosoftPeering") | string)␊ - /**␊ - * The peering state.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * The peer ASN.␊ - */␊ - peerASN?: (number | string)␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The VLAN ID.␊ - */␊ - vlanId?: (number | string)␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig14 | string)␊ - /**␊ - * The peering stats of express route circuit.␊ - */␊ - stats?: (ExpressRouteCircuitStats14 | string)␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - /**␊ - * The reference of the RouteFilter resource.␊ - */␊ - routeFilter?: (SubResource26 | string)␊ - /**␊ - * The IPv6 peering configuration.␊ - */␊ - ipv6PeeringConfig?: (Ipv6ExpressRouteCircuitPeeringConfig11 | string)␊ - /**␊ - * The ExpressRoute connection.␊ - */␊ - expressRouteConnection?: (SubResource26 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the peering configuration.␊ - */␊ - export interface ExpressRouteCircuitPeeringConfig14 {␊ - /**␊ - * The reference of AdvertisedPublicPrefixes.␊ - */␊ - advertisedPublicPrefixes?: (string[] | string)␊ - /**␊ - * The communities of bgp peering. Specified for microsoft peering.␊ - */␊ - advertisedCommunities?: (string[] | string)␊ - /**␊ - * The legacy mode of the peering.␊ - */␊ - legacyMode?: (number | string)␊ - /**␊ - * The CustomerASN of the peering.␊ - */␊ - customerASN?: (number | string)␊ - /**␊ - * The RoutingRegistryName of the configuration.␊ - */␊ - routingRegistryName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains stats associated with the peering.␊ - */␊ - export interface ExpressRouteCircuitStats14 {␊ - /**␊ - * The Primary BytesIn of the peering.␊ - */␊ - primarybytesIn?: (number | string)␊ - /**␊ - * The primary BytesOut of the peering.␊ - */␊ - primarybytesOut?: (number | string)␊ - /**␊ - * The secondary BytesIn of the peering.␊ - */␊ - secondarybytesIn?: (number | string)␊ - /**␊ - * The secondary BytesOut of the peering.␊ - */␊ - secondarybytesOut?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains IPv6 peering config.␊ - */␊ - export interface Ipv6ExpressRouteCircuitPeeringConfig11 {␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig14 | string)␊ - /**␊ - * The reference of the RouteFilter resource.␊ - */␊ - routeFilter?: (SubResource26 | string)␊ - /**␊ - * The state of peering.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains ServiceProviderProperties in an ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitServiceProviderProperties13 {␊ - /**␊ - * The serviceProviderName.␊ - */␊ - serviceProviderName?: string␊ - /**␊ - * The peering location.␊ - */␊ - peeringLocation?: string␊ - /**␊ - * The BandwidthInMbps.␊ - */␊ - bandwidthInMbps?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings␊ - */␊ - export interface ExpressRouteCircuitsPeeringsChildResource13 {␊ - name: string␊ - type: "peerings"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Properties of the express route circuit peering.␊ - */␊ - properties: (ExpressRouteCircuitPeeringPropertiesFormat14 | string)␊ - resources?: ExpressRouteCircuitsPeeringsConnectionsChildResource11[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings/connections␊ - */␊ - export interface ExpressRouteCircuitsPeeringsConnectionsChildResource11 {␊ - name: string␊ - type: "connections"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Properties of the express route circuit connection.␊ - */␊ - properties: (ExpressRouteCircuitConnectionPropertiesFormat11 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the express route circuit connection.␊ - */␊ - export interface ExpressRouteCircuitConnectionPropertiesFormat11 {␊ - /**␊ - * Reference to Express Route Circuit Private Peering Resource of the circuit initiating connection.␊ - */␊ - expressRouteCircuitPeering?: (SubResource26 | string)␊ - /**␊ - * Reference to Express Route Circuit Private Peering Resource of the peered circuit.␊ - */␊ - peerExpressRouteCircuitPeering?: (SubResource26 | string)␊ - /**␊ - * /29 IP address space to carve out Customer addresses for tunnels.␊ - */␊ - addressPrefix?: string␊ - /**␊ - * The authorization key.␊ - */␊ - authorizationKey?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/authorizations␊ - */␊ - export interface ExpressRouteCircuitsAuthorizationsChildResource13 {␊ - name: string␊ - type: "authorizations"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Properties of the express route circuit authorization.␊ - */␊ - properties: (AuthorizationPropertiesFormat14 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/authorizations␊ - */␊ - export interface ExpressRouteCircuitsAuthorizations14 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/authorizations"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Properties of the express route circuit authorization.␊ - */␊ - properties: (AuthorizationPropertiesFormat14 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings␊ - */␊ - export interface ExpressRouteCircuitsPeerings13 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/peerings"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Properties of the express route circuit peering.␊ - */␊ - properties: (ExpressRouteCircuitPeeringPropertiesFormat14 | string)␊ - resources?: ExpressRouteCircuitsPeeringsConnectionsChildResource11[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings/connections␊ - */␊ - export interface ExpressRouteCircuitsPeeringsConnections11 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/peerings/connections"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Properties of the express route circuit connection.␊ - */␊ - properties: (ExpressRouteCircuitConnectionPropertiesFormat11 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections␊ - */␊ - export interface ExpressRouteCrossConnections11 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCrossConnections"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the express route cross connection.␊ - */␊ - properties: (ExpressRouteCrossConnectionProperties11 | string)␊ - resources?: ExpressRouteCrossConnectionsPeeringsChildResource11[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ExpressRouteCrossConnection.␊ - */␊ - export interface ExpressRouteCrossConnectionProperties11 {␊ - /**␊ - * The peering location of the ExpressRoute circuit.␊ - */␊ - peeringLocation?: string␊ - /**␊ - * The circuit bandwidth In Mbps.␊ - */␊ - bandwidthInMbps?: (number | string)␊ - /**␊ - * The ExpressRouteCircuit.␊ - */␊ - expressRouteCircuit?: (SubResource26 | string)␊ - /**␊ - * The provisioning state of the circuit in the connectivity provider system.␊ - */␊ - serviceProviderProvisioningState?: (("NotProvisioned" | "Provisioning" | "Provisioned" | "Deprovisioning") | string)␊ - /**␊ - * Additional read only notes set by the connectivity provider.␊ - */␊ - serviceProviderNotes?: string␊ - /**␊ - * The list of peerings.␊ - */␊ - peerings?: (ExpressRouteCrossConnectionPeering11[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peering in an ExpressRoute Cross Connection resource.␊ - */␊ - export interface ExpressRouteCrossConnectionPeering11 {␊ - /**␊ - * Properties of the express route cross connection peering.␊ - */␊ - properties?: (ExpressRouteCrossConnectionPeeringProperties11 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of express route cross connection peering.␊ - */␊ - export interface ExpressRouteCrossConnectionPeeringProperties11 {␊ - /**␊ - * The peering type.␊ - */␊ - peeringType?: (("AzurePublicPeering" | "AzurePrivatePeering" | "MicrosoftPeering") | string)␊ - /**␊ - * The peering state.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * The peer ASN.␊ - */␊ - peerASN?: (number | string)␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The VLAN ID.␊ - */␊ - vlanId?: (number | string)␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig14 | string)␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - /**␊ - * The IPv6 peering configuration.␊ - */␊ - ipv6PeeringConfig?: (Ipv6ExpressRouteCircuitPeeringConfig11 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections/peerings␊ - */␊ - export interface ExpressRouteCrossConnectionsPeeringsChildResource11 {␊ - name: string␊ - type: "peerings"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Properties of the express route cross connection peering.␊ - */␊ - properties: (ExpressRouteCrossConnectionPeeringProperties11 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections/peerings␊ - */␊ - export interface ExpressRouteCrossConnectionsPeerings10 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCrossConnections/peerings"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Properties of the express route cross connection peering.␊ - */␊ - properties: (ExpressRouteCrossConnectionPeeringProperties11 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteGateways␊ - */␊ - export interface ExpressRouteGateways3 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteGateways"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the express route gateway.␊ - */␊ - properties: (ExpressRouteGatewayProperties3 | string)␊ - resources?: ExpressRouteGatewaysExpressRouteConnectionsChildResource3[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ExpressRoute gateway resource properties.␊ - */␊ - export interface ExpressRouteGatewayProperties3 {␊ - /**␊ - * Configuration for auto scaling.␊ - */␊ - autoScaleConfiguration?: (ExpressRouteGatewayPropertiesAutoScaleConfiguration3 | string)␊ - /**␊ - * The Virtual Hub where the ExpressRoute gateway is or will be deployed.␊ - */␊ - virtualHub: (SubResource26 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Configuration for auto scaling.␊ - */␊ - export interface ExpressRouteGatewayPropertiesAutoScaleConfiguration3 {␊ - /**␊ - * Minimum and maximum number of scale units to deploy.␊ - */␊ - bounds?: (ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Minimum and maximum number of scale units to deploy.␊ - */␊ - export interface ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds3 {␊ - /**␊ - * Minimum number of scale units deployed for ExpressRoute gateway.␊ - */␊ - min?: (number | string)␊ - /**␊ - * Maximum number of scale units deployed for ExpressRoute gateway.␊ - */␊ - max?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteGateways/expressRouteConnections␊ - */␊ - export interface ExpressRouteGatewaysExpressRouteConnectionsChildResource3 {␊ - name: string␊ - type: "expressRouteConnections"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Properties of the express route connection.␊ - */␊ - properties: (ExpressRouteConnectionProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the ExpressRouteConnection subresource.␊ - */␊ - export interface ExpressRouteConnectionProperties3 {␊ - /**␊ - * The ExpressRoute circuit peering.␊ - */␊ - expressRouteCircuitPeering: (SubResource26 | string)␊ - /**␊ - * Authorization key to establish the connection.␊ - */␊ - authorizationKey?: string␊ - /**␊ - * The routing weight associated to the connection.␊ - */␊ - routingWeight?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteGateways/expressRouteConnections␊ - */␊ - export interface ExpressRouteGatewaysExpressRouteConnections3 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteGateways/expressRouteConnections"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Properties of the express route connection.␊ - */␊ - properties: (ExpressRouteConnectionProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ExpressRoutePorts␊ - */␊ - export interface ExpressRoutePorts6 {␊ - name: string␊ - type: "Microsoft.Network/ExpressRoutePorts"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * ExpressRoutePort properties.␊ - */␊ - properties: (ExpressRoutePortPropertiesFormat6 | string)␊ - /**␊ - * The identity of ExpressRoutePort, if configured.␊ - */␊ - identity?: (ManagedServiceIdentity6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to ExpressRoutePort resources.␊ - */␊ - export interface ExpressRoutePortPropertiesFormat6 {␊ - /**␊ - * The name of the peering location that the ExpressRoutePort is mapped to physically.␊ - */␊ - peeringLocation?: string␊ - /**␊ - * Bandwidth of procured ports in Gbps.␊ - */␊ - bandwidthInGbps?: (number | string)␊ - /**␊ - * Encapsulation method on physical ports.␊ - */␊ - encapsulation?: (("Dot1Q" | "QinQ") | string)␊ - /**␊ - * The set of physical links of the ExpressRoutePort resource.␊ - */␊ - links?: (ExpressRouteLink6[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ExpressRouteLink child resource definition.␊ - */␊ - export interface ExpressRouteLink6 {␊ - /**␊ - * ExpressRouteLink properties.␊ - */␊ - properties?: (ExpressRouteLinkPropertiesFormat6 | string)␊ - /**␊ - * Name of child port resource that is unique among child port resources of the parent.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to ExpressRouteLink resources.␊ - */␊ - export interface ExpressRouteLinkPropertiesFormat6 {␊ - /**␊ - * Administrative state of the physical port.␊ - */␊ - adminState?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * MacSec configuration.␊ - */␊ - macSecConfig?: (ExpressRouteLinkMacSecConfig1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ExpressRouteLink Mac Security Configuration.␊ - */␊ - export interface ExpressRouteLinkMacSecConfig1 {␊ - /**␊ - * Keyvault Secret Identifier URL containing Mac security CKN key.␊ - */␊ - cknSecretIdentifier?: string␊ - /**␊ - * Keyvault Secret Identifier URL containing Mac security CAK key.␊ - */␊ - cakSecretIdentifier?: string␊ - /**␊ - * Mac security cipher.␊ - */␊ - cipher?: (("gcm-aes-128" | "gcm-aes-256") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/firewallPolicies␊ - */␊ - export interface FirewallPolicies2 {␊ - name: string␊ - type: "Microsoft.Network/firewallPolicies"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the firewall policy.␊ - */␊ - properties: (FirewallPolicyPropertiesFormat2 | string)␊ - resources?: FirewallPoliciesRuleGroupsChildResource2[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Firewall Policy definition.␊ - */␊ - export interface FirewallPolicyPropertiesFormat2 {␊ - /**␊ - * The parent firewall policy from which rules are inherited.␊ - */␊ - basePolicy?: (SubResource26 | string)␊ - /**␊ - * The operation mode for Threat Intelligence.␊ - */␊ - threatIntelMode?: (("Alert" | "Deny" | "Off") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/firewallPolicies/ruleGroups␊ - */␊ - export interface FirewallPoliciesRuleGroupsChildResource2 {␊ - name: string␊ - type: "ruleGroups"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * The properties of the firewall policy rule group.␊ - */␊ - properties: (FirewallPolicyRuleGroupProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the rule group.␊ - */␊ - export interface FirewallPolicyRuleGroupProperties2 {␊ - /**␊ - * Priority of the Firewall Policy Rule Group resource.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * Group of Firewall Policy rules.␊ - */␊ - rules?: (FirewallPolicyRule2[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the FirewallPolicyNatRuleAction.␊ - */␊ - export interface FirewallPolicyNatRuleAction2 {␊ - /**␊ - * The type of action.␊ - */␊ - type?: "DNAT"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application rule protocol.␊ - */␊ - export interface FirewallPolicyRuleConditionApplicationProtocol2 {␊ - /**␊ - * Protocol type.␊ - */␊ - protocolType?: (("Http" | "Https") | string)␊ - /**␊ - * Port number for the protocol, cannot be greater than 64000.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the FirewallPolicyFilterRuleAction.␊ - */␊ - export interface FirewallPolicyFilterRuleAction2 {␊ - /**␊ - * The type of action.␊ - */␊ - type?: ("Allow" | "Deny")␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/firewallPolicies/ruleGroups␊ - */␊ - export interface FirewallPoliciesRuleGroups2 {␊ - name: string␊ - type: "Microsoft.Network/firewallPolicies/ruleGroups"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * The properties of the firewall policy rule group.␊ - */␊ - properties: (FirewallPolicyRuleGroupProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers␊ - */␊ - export interface LoadBalancers28 {␊ - name: string␊ - type: "Microsoft.Network/loadBalancers"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The load balancer SKU.␊ - */␊ - sku?: (LoadBalancerSku16 | string)␊ - /**␊ - * Properties of load balancer.␊ - */␊ - properties: (LoadBalancerPropertiesFormat20 | string)␊ - resources?: LoadBalancersInboundNatRulesChildResource16[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a load balancer.␊ - */␊ - export interface LoadBalancerSku16 {␊ - /**␊ - * Name of a load balancer SKU.␊ - */␊ - name?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer.␊ - */␊ - export interface LoadBalancerPropertiesFormat20 {␊ - /**␊ - * Object representing the frontend IPs to be used for the load balancer.␊ - */␊ - frontendIPConfigurations?: (FrontendIPConfiguration19[] | string)␊ - /**␊ - * Collection of backend address pools used by a load balancer.␊ - */␊ - backendAddressPools?: (BackendAddressPool20[] | string)␊ - /**␊ - * Object collection representing the load balancing rules Gets the provisioning.␊ - */␊ - loadBalancingRules?: (LoadBalancingRule20[] | string)␊ - /**␊ - * Collection of probe objects used in the load balancer.␊ - */␊ - probes?: (Probe20[] | string)␊ - /**␊ - * Collection of inbound NAT Rules used by a load balancer. Defining inbound NAT rules on your load balancer is mutually exclusive with defining an inbound NAT pool. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an Inbound NAT pool. They have to reference individual inbound NAT rules.␊ - */␊ - inboundNatRules?: (InboundNatRule21[] | string)␊ - /**␊ - * Defines an external port range for inbound NAT to a single backend port on NICs associated with a load balancer. Inbound NAT rules are created automatically for each NIC associated with the Load Balancer using an external port from this range. Defining an Inbound NAT pool on your Load Balancer is mutually exclusive with defining inbound Nat rules. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an inbound NAT pool. They have to reference individual inbound NAT rules.␊ - */␊ - inboundNatPools?: (InboundNatPool21[] | string)␊ - /**␊ - * The outbound rules.␊ - */␊ - outboundRules?: (OutboundRule8[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP address of the load balancer.␊ - */␊ - export interface FrontendIPConfiguration19 {␊ - /**␊ - * Properties of the load balancer probe.␊ - */␊ - properties?: (FrontendIPConfigurationPropertiesFormat19 | string)␊ - /**␊ - * The name of the resource that is unique within the set of frontend IP configurations used by the load balancer. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP Configuration of the load balancer.␊ - */␊ - export interface FrontendIPConfigurationPropertiesFormat19 {␊ - /**␊ - * The private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The Private IP allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4.␊ - */␊ - privateIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The reference of the subnet resource.␊ - */␊ - subnet?: (SubResource26 | string)␊ - /**␊ - * The reference of the Public IP resource.␊ - */␊ - publicIPAddress?: (SubResource26 | string)␊ - /**␊ - * The reference of the Public IP Prefix resource.␊ - */␊ - publicIPPrefix?: (SubResource26 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Pool of backend IP addresses.␊ - */␊ - export interface BackendAddressPool20 {␊ - /**␊ - * Properties of load balancer backend address pool.␊ - */␊ - properties?: (BackendAddressPoolPropertiesFormat20 | string)␊ - /**␊ - * The name of the resource that is unique within the set of backend address pools used by the load balancer. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the backend address pool.␊ - */␊ - export interface BackendAddressPoolPropertiesFormat20 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A load balancing rule for a load balancer.␊ - */␊ - export interface LoadBalancingRule20 {␊ - /**␊ - * Properties of load balancer load balancing rule.␊ - */␊ - properties?: (LoadBalancingRulePropertiesFormat20 | string)␊ - /**␊ - * The name of the resource that is unique within the set of load balancing rules used by the load balancer. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer.␊ - */␊ - export interface LoadBalancingRulePropertiesFormat20 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource26 | string)␊ - /**␊ - * A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs.␊ - */␊ - backendAddressPool?: (SubResource26 | string)␊ - /**␊ - * The reference of the load balancer probe used by the load balancing rule.␊ - */␊ - probe?: (SubResource26 | string)␊ - /**␊ - * The reference to the transport protocol used by the load balancing rule.␊ - */␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The load distribution policy for this rule.␊ - */␊ - loadDistribution?: (("Default" | "SourceIP" | "SourceIPProtocol") | string)␊ - /**␊ - * The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 0 and 65534. Note that value 0 enables "Any Port".␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port".␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - /**␊ - * Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule.␊ - */␊ - disableOutboundSnat?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A load balancer probe.␊ - */␊ - export interface Probe20 {␊ - /**␊ - * Properties of load balancer probe.␊ - */␊ - properties?: (ProbePropertiesFormat20 | string)␊ - /**␊ - * The name of the resource that is unique within the set of probes used by the load balancer. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Load balancer probe resource.␊ - */␊ - export interface ProbePropertiesFormat20 {␊ - /**␊ - * The protocol of the end point. If 'Tcp' is specified, a received ACK is required for the probe to be successful. If 'Http' or 'Https' is specified, a 200 OK response from the specifies URI is required for the probe to be successful.␊ - */␊ - protocol: (("Http" | "Tcp" | "Https") | string)␊ - /**␊ - * The port for communicating the probe. Possible values range from 1 to 65535, inclusive.␊ - */␊ - port: (number | string)␊ - /**␊ - * The interval, in seconds, for how frequently to probe the endpoint for health status. Typically, the interval is slightly less than half the allocated timeout period (in seconds) which allows two full probes before taking the instance out of rotation. The default value is 15, the minimum value is 5.␊ - */␊ - intervalInSeconds?: (number | string)␊ - /**␊ - * The number of probes where if no response, will result in stopping further traffic from being delivered to the endpoint. This values allows endpoints to be taken out of rotation faster or slower than the typical times used in Azure.␊ - */␊ - numberOfProbes: (number | string)␊ - /**␊ - * The URI used for requesting health status from the VM. Path is required if a protocol is set to http. Otherwise, it is not allowed. There is no default value.␊ - */␊ - requestPath?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT rule of the load balancer.␊ - */␊ - export interface InboundNatRule21 {␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties?: (InboundNatRulePropertiesFormat20 | string)␊ - /**␊ - * The name of the resource that is unique within the set of inbound NAT rules used by the load balancer. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the inbound NAT rule.␊ - */␊ - export interface InboundNatRulePropertiesFormat20 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource26 | string)␊ - /**␊ - * The reference to the transport protocol used by the load balancing rule.␊ - */␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values range from 1 to 65534.␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * The port used for the internal endpoint. Acceptable values range from 1 to 65535.␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT pool of the load balancer.␊ - */␊ - export interface InboundNatPool21 {␊ - /**␊ - * Properties of load balancer inbound nat pool.␊ - */␊ - properties?: (InboundNatPoolPropertiesFormat20 | string)␊ - /**␊ - * The name of the resource that is unique within the set of inbound NAT pools used by the load balancer. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Inbound NAT pool.␊ - */␊ - export interface InboundNatPoolPropertiesFormat20 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource26 | string)␊ - /**␊ - * The reference to the transport protocol used by the inbound NAT pool.␊ - */␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65534.␊ - */␊ - frontendPortRangeStart: (number | string)␊ - /**␊ - * The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65535.␊ - */␊ - frontendPortRangeEnd: (number | string)␊ - /**␊ - * The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound rule of the load balancer.␊ - */␊ - export interface OutboundRule8 {␊ - /**␊ - * Properties of load balancer outbound rule.␊ - */␊ - properties?: (OutboundRulePropertiesFormat8 | string)␊ - /**␊ - * The name of the resource that is unique within the set of outbound rules used by the load balancer. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound rule of the load balancer.␊ - */␊ - export interface OutboundRulePropertiesFormat8 {␊ - /**␊ - * The number of outbound ports to be used for NAT.␊ - */␊ - allocatedOutboundPorts?: (number | string)␊ - /**␊ - * The Frontend IP addresses of the load balancer.␊ - */␊ - frontendIPConfigurations: (SubResource26[] | string)␊ - /**␊ - * A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs.␊ - */␊ - backendAddressPool: (SubResource26 | string)␊ - /**␊ - * The protocol for the outbound rule in load balancer.␊ - */␊ - protocol: (("Tcp" | "Udp" | "All") | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - /**␊ - * The timeout for the TCP idle connection.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers/inboundNatRules␊ - */␊ - export interface LoadBalancersInboundNatRulesChildResource16 {␊ - name: string␊ - type: "inboundNatRules"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties: (InboundNatRulePropertiesFormat20 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers/inboundNatRules␊ - */␊ - export interface LoadBalancersInboundNatRules15 {␊ - name: string␊ - type: "Microsoft.Network/loadBalancers/inboundNatRules"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties: (InboundNatRulePropertiesFormat20 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/localNetworkGateways␊ - */␊ - export interface LocalNetworkGateways16 {␊ - name: string␊ - type: "Microsoft.Network/localNetworkGateways"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the local network gateway.␊ - */␊ - properties: (LocalNetworkGatewayPropertiesFormat16 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * LocalNetworkGateway properties.␊ - */␊ - export interface LocalNetworkGatewayPropertiesFormat16 {␊ - /**␊ - * Local network site address space.␊ - */␊ - localNetworkAddressSpace?: (AddressSpace28 | string)␊ - /**␊ - * IP address of local network gateway.␊ - */␊ - gatewayIpAddress?: string␊ - /**␊ - * Local network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings15 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.␊ - */␊ - export interface AddressSpace28 {␊ - /**␊ - * A list of address blocks reserved for this virtual network in CIDR notation.␊ - */␊ - addressPrefixes: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * BGP settings details.␊ - */␊ - export interface BgpSettings15 {␊ - /**␊ - * The BGP speaker's ASN.␊ - */␊ - asn?: (number | string)␊ - /**␊ - * The BGP peering address and BGP identifier of this BGP speaker.␊ - */␊ - bgpPeeringAddress?: string␊ - /**␊ - * The weight added to routes learned from this BGP speaker.␊ - */␊ - peerWeight?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/natGateways␊ - */␊ - export interface NatGateways3 {␊ - name: string␊ - type: "Microsoft.Network/natGateways"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The nat gateway SKU.␊ - */␊ - sku?: (NatGatewaySku3 | string)␊ - /**␊ - * Nat Gateway properties.␊ - */␊ - properties: (NatGatewayPropertiesFormat3 | string)␊ - /**␊ - * A list of availability zones denoting the zone in which Nat Gateway should be deployed.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of nat gateway.␊ - */␊ - export interface NatGatewaySku3 {␊ - /**␊ - * Name of Nat Gateway SKU.␊ - */␊ - name?: ("Standard" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Nat Gateway properties.␊ - */␊ - export interface NatGatewayPropertiesFormat3 {␊ - /**␊ - * The idle timeout of the nat gateway.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * An array of public ip addresses associated with the nat gateway resource.␊ - */␊ - publicIpAddresses?: (SubResource26[] | string)␊ - /**␊ - * An array of public ip prefixes associated with the nat gateway resource.␊ - */␊ - publicIpPrefixes?: (SubResource26[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces␊ - */␊ - export interface NetworkInterfaces29 {␊ - name: string␊ - type: "Microsoft.Network/networkInterfaces"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network interface.␊ - */␊ - properties: (NetworkInterfacePropertiesFormat20 | string)␊ - resources?: NetworkInterfacesTapConfigurationsChildResource7[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NetworkInterface properties.␊ - */␊ - export interface NetworkInterfacePropertiesFormat20 {␊ - /**␊ - * The reference of the NetworkSecurityGroup resource.␊ - */␊ - networkSecurityGroup?: (SubResource26 | string)␊ - /**␊ - * A list of IPConfigurations of the network interface.␊ - */␊ - ipConfigurations: (NetworkInterfaceIPConfiguration19[] | string)␊ - /**␊ - * The DNS settings in network interface.␊ - */␊ - dnsSettings?: (NetworkInterfaceDnsSettings28 | string)␊ - /**␊ - * If the network interface is accelerated networking enabled.␊ - */␊ - enableAcceleratedNetworking?: (boolean | string)␊ - /**␊ - * Indicates whether IP forwarding is enabled on this network interface.␊ - */␊ - enableIPForwarding?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IPConfiguration in a network interface.␊ - */␊ - export interface NetworkInterfaceIPConfiguration19 {␊ - /**␊ - * Network interface IP configuration properties.␊ - */␊ - properties?: (NetworkInterfaceIPConfigurationPropertiesFormat19 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration.␊ - */␊ - export interface NetworkInterfaceIPConfigurationPropertiesFormat19 {␊ - /**␊ - * The reference to Virtual Network Taps.␊ - */␊ - virtualNetworkTaps?: (SubResource26[] | string)␊ - /**␊ - * The reference of ApplicationGatewayBackendAddressPool resource.␊ - */␊ - applicationGatewayBackendAddressPools?: (SubResource26[] | string)␊ - /**␊ - * The reference of LoadBalancerBackendAddressPool resource.␊ - */␊ - loadBalancerBackendAddressPools?: (SubResource26[] | string)␊ - /**␊ - * A list of references of LoadBalancerInboundNatRules.␊ - */␊ - loadBalancerInboundNatRules?: (SubResource26[] | string)␊ - /**␊ - * Private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The private IP address allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4.␊ - */␊ - privateIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * Subnet bound to the IP configuration.␊ - */␊ - subnet?: (SubResource26 | string)␊ - /**␊ - * Whether this is a primary customer address on the network interface.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * Public IP address bound to the IP configuration.␊ - */␊ - publicIPAddress?: (SubResource26 | string)␊ - /**␊ - * Application security groups in which the IP configuration is included.␊ - */␊ - applicationSecurityGroups?: (SubResource26[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DNS settings of a network interface.␊ - */␊ - export interface NetworkInterfaceDnsSettings28 {␊ - /**␊ - * List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only value in dnsServers collection.␊ - */␊ - dnsServers?: (string[] | string)␊ - /**␊ - * Relative DNS name for this NIC used for internal communications between VMs in the same virtual network.␊ - */␊ - internalDnsNameLabel?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces/tapConfigurations␊ - */␊ - export interface NetworkInterfacesTapConfigurationsChildResource7 {␊ - name: string␊ - type: "tapConfigurations"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Properties of the Virtual Network Tap configuration.␊ - */␊ - properties: (NetworkInterfaceTapConfigurationPropertiesFormat7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Virtual Network Tap configuration.␊ - */␊ - export interface NetworkInterfaceTapConfigurationPropertiesFormat7 {␊ - /**␊ - * The reference of the Virtual Network Tap resource.␊ - */␊ - virtualNetworkTap?: (SubResource26 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces/tapConfigurations␊ - */␊ - export interface NetworkInterfacesTapConfigurations6 {␊ - name: string␊ - type: "Microsoft.Network/networkInterfaces/tapConfigurations"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Properties of the Virtual Network Tap configuration.␊ - */␊ - properties: (NetworkInterfaceTapConfigurationPropertiesFormat7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkProfiles␊ - */␊ - export interface NetworkProfiles3 {␊ - name: string␊ - type: "Microsoft.Network/networkProfiles"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Network profile properties.␊ - */␊ - properties: (NetworkProfilePropertiesFormat3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network profile properties.␊ - */␊ - export interface NetworkProfilePropertiesFormat3 {␊ - /**␊ - * List of chid container network interface configurations.␊ - */␊ - containerNetworkInterfaceConfigurations?: (ContainerNetworkInterfaceConfiguration3[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Container network interface configuration child resource.␊ - */␊ - export interface ContainerNetworkInterfaceConfiguration3 {␊ - /**␊ - * Container network interface configuration properties.␊ - */␊ - properties?: (ContainerNetworkInterfaceConfigurationPropertiesFormat3 | string)␊ - /**␊ - * The name of the resource. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Container network interface configuration properties.␊ - */␊ - export interface ContainerNetworkInterfaceConfigurationPropertiesFormat3 {␊ - /**␊ - * A list of ip configurations of the container network interface configuration.␊ - */␊ - ipConfigurations?: (IPConfigurationProfile3[] | string)␊ - /**␊ - * A list of container network interfaces created from this container network interface configuration.␊ - */␊ - containerNetworkInterfaces?: (SubResource26[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration profile child resource.␊ - */␊ - export interface IPConfigurationProfile3 {␊ - /**␊ - * Properties of the IP configuration profile.␊ - */␊ - properties?: (IPConfigurationProfilePropertiesFormat3 | string)␊ - /**␊ - * The name of the resource. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration profile properties.␊ - */␊ - export interface IPConfigurationProfilePropertiesFormat3 {␊ - /**␊ - * The reference of the subnet resource to create a container network interface ip configuration.␊ - */␊ - subnet?: (SubResource26 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups␊ - */␊ - export interface NetworkSecurityGroups28 {␊ - name: string␊ - type: "Microsoft.Network/networkSecurityGroups"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network security group.␊ - */␊ - properties: (NetworkSecurityGroupPropertiesFormat20 | string)␊ - resources?: NetworkSecurityGroupsSecurityRulesChildResource20[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network Security Group resource.␊ - */␊ - export interface NetworkSecurityGroupPropertiesFormat20 {␊ - /**␊ - * A collection of security rules of the network security group.␊ - */␊ - securityRules?: (SecurityRule20[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network security rule.␊ - */␊ - export interface SecurityRule20 {␊ - /**␊ - * Properties of the security rule.␊ - */␊ - properties?: (SecurityRulePropertiesFormat20 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Security rule resource.␊ - */␊ - export interface SecurityRulePropertiesFormat20 {␊ - /**␊ - * A description for this rule. Restricted to 140 chars.␊ - */␊ - description?: string␊ - /**␊ - * Network protocol this rule applies to.␊ - */␊ - protocol: (("Tcp" | "Udp" | "Icmp" | "Esp" | "*" | "Ah") | string)␊ - /**␊ - * The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.␊ - */␊ - sourcePortRange?: string␊ - /**␊ - * The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.␊ - */␊ - destinationPortRange?: string␊ - /**␊ - * The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from.␊ - */␊ - sourceAddressPrefix?: string␊ - /**␊ - * The CIDR or source IP ranges.␊ - */␊ - sourceAddressPrefixes?: (string[] | string)␊ - /**␊ - * The application security group specified as source.␊ - */␊ - sourceApplicationSecurityGroups?: (SubResource26[] | string)␊ - /**␊ - * The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used.␊ - */␊ - destinationAddressPrefix?: string␊ - /**␊ - * The destination address prefixes. CIDR or destination IP ranges.␊ - */␊ - destinationAddressPrefixes?: (string[] | string)␊ - /**␊ - * The application security group specified as destination.␊ - */␊ - destinationApplicationSecurityGroups?: (SubResource26[] | string)␊ - /**␊ - * The source port ranges.␊ - */␊ - sourcePortRanges?: (string[] | string)␊ - /**␊ - * The destination port ranges.␊ - */␊ - destinationPortRanges?: (string[] | string)␊ - /**␊ - * The network traffic is allowed or denied.␊ - */␊ - access: (("Allow" | "Deny") | string)␊ - /**␊ - * The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.␊ - */␊ - priority: (number | string)␊ - /**␊ - * The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic.␊ - */␊ - direction: (("Inbound" | "Outbound") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRulesChildResource20 {␊ - name: string␊ - type: "securityRules"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Properties of the security rule.␊ - */␊ - properties: (SecurityRulePropertiesFormat20 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRules19 {␊ - name: string␊ - type: "Microsoft.Network/networkSecurityGroups/securityRules"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Properties of the security rule.␊ - */␊ - properties: (SecurityRulePropertiesFormat20 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers␊ - */␊ - export interface NetworkWatchers6 {␊ - name: string␊ - type: "Microsoft.Network/networkWatchers"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network watcher.␊ - */␊ - properties: (NetworkWatcherPropertiesFormat3 | string)␊ - resources?: NetworkWatchersPacketCapturesChildResource6[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The network watcher properties.␊ - */␊ - export interface NetworkWatcherPropertiesFormat3 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/packetCaptures␊ - */␊ - export interface NetworkWatchersPacketCapturesChildResource6 {␊ - name: string␊ - type: "packetCaptures"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Properties of the packet capture.␊ - */␊ - properties: (PacketCaptureParameters6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters that define the create packet capture operation.␊ - */␊ - export interface PacketCaptureParameters6 {␊ - /**␊ - * The ID of the targeted resource, only VM is currently supported.␊ - */␊ - target: string␊ - /**␊ - * Number of bytes captured per packet, the remaining bytes are truncated.␊ - */␊ - bytesToCapturePerPacket?: ((number & string) | string)␊ - /**␊ - * Maximum size of the capture output.␊ - */␊ - totalBytesPerSession?: ((number & string) | string)␊ - /**␊ - * Maximum duration of the capture session in seconds.␊ - */␊ - timeLimitInSeconds?: ((number & string) | string)␊ - /**␊ - * Describes the storage location for a packet capture session.␊ - */␊ - storageLocation: (PacketCaptureStorageLocation6 | string)␊ - /**␊ - * A list of packet capture filters.␊ - */␊ - filters?: (PacketCaptureFilter6[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the storage location for a packet capture session.␊ - */␊ - export interface PacketCaptureStorageLocation6 {␊ - /**␊ - * The ID of the storage account to save the packet capture session. Required if no local file path is provided.␊ - */␊ - storageId?: string␊ - /**␊ - * The URI of the storage path to save the packet capture. Must be a well-formed URI describing the location to save the packet capture.␊ - */␊ - storagePath?: string␊ - /**␊ - * A valid local path on the targeting VM. Must include the name of the capture file (*.cap). For linux virtual machine it must start with /var/captures. Required if no storage ID is provided, otherwise optional.␊ - */␊ - filePath?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Filter that is applied to packet capture request. Multiple filters can be applied.␊ - */␊ - export interface PacketCaptureFilter6 {␊ - /**␊ - * Protocol to be filtered on.␊ - */␊ - protocol?: (("TCP" | "UDP" | "Any") | string)␊ - /**␊ - * Local IP Address to be filtered on. Notation: "127.0.0.1" for single address entry. "127.0.0.1-127.0.0.255" for range. "127.0.0.1;127.0.0.5"? for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.␊ - */␊ - localIPAddress?: string␊ - /**␊ - * Local IP Address to be filtered on. Notation: "127.0.0.1" for single address entry. "127.0.0.1-127.0.0.255" for range. "127.0.0.1;127.0.0.5;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.␊ - */␊ - remoteIPAddress?: string␊ - /**␊ - * Local port to be filtered on. Notation: "80" for single port entry."80-85" for range. "80;443;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.␊ - */␊ - localPort?: string␊ - /**␊ - * Remote port to be filtered on. Notation: "80" for single port entry."80-85" for range. "80;443;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.␊ - */␊ - remotePort?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/packetCaptures␊ - */␊ - export interface NetworkWatchersPacketCaptures6 {␊ - name: string␊ - type: "Microsoft.Network/networkWatchers/packetCaptures"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Properties of the packet capture.␊ - */␊ - properties: (PacketCaptureParameters6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/p2svpnGateways␊ - */␊ - export interface P2SvpnGateways3 {␊ - name: string␊ - type: "Microsoft.Network/p2svpnGateways"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the P2SVpnGateway.␊ - */␊ - properties: (P2SVpnGatewayProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for P2SVpnGateway.␊ - */␊ - export interface P2SVpnGatewayProperties3 {␊ - /**␊ - * The VirtualHub to which the gateway belongs.␊ - */␊ - virtualHub?: (SubResource26 | string)␊ - /**␊ - * List of all p2s connection configurations of the gateway.␊ - */␊ - p2sConnectionConfigurations?: (P2SConnectionConfiguration[] | string)␊ - /**␊ - * The scale unit for this p2s vpn gateway.␊ - */␊ - vpnGatewayScaleUnit?: (number | string)␊ - /**␊ - * The VpnServerConfiguration to which the p2sVpnGateway is attached to.␊ - */␊ - vpnServerConfiguration?: (VpnServerConfiguration | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * P2SConnectionConfiguration Resource.␊ - */␊ - export interface P2SConnectionConfiguration {␊ - /**␊ - * Properties of the P2S connection configuration.␊ - */␊ - properties?: (P2SConnectionConfigurationProperties | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for P2SConnectionConfiguration.␊ - */␊ - export interface P2SConnectionConfigurationProperties {␊ - /**␊ - * The reference of the address space resource which represents Address space for P2S VpnClient.␊ - */␊ - vpnClientAddressPool?: (AddressSpace28 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnServerConfiguration Resource.␊ - */␊ - export interface VpnServerConfiguration {␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the P2SVpnServer configuration.␊ - */␊ - properties?: (VpnServerConfigurationProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnServerConfiguration.␊ - */␊ - export interface VpnServerConfigurationProperties {␊ - /**␊ - * The name of the VpnServerConfiguration that is unique within a resource group.␊ - */␊ - name?: string␊ - /**␊ - * VPN protocols for the VpnServerConfiguration.␊ - */␊ - vpnProtocols?: (("IkeV2" | "OpenVPN")[] | string)␊ - /**␊ - * VPN authentication types for the VpnServerConfiguration.␊ - */␊ - vpnAuthenticationTypes?: (("Certificate" | "Radius" | "AAD")[] | string)␊ - /**␊ - * VPN client root certificate of VpnServerConfiguration.␊ - */␊ - vpnServerConfigVpnClientRootCertificates?: (VpnServerConfigVpnClientRootCertificate[] | string)␊ - /**␊ - * VPN client revoked certificate of VpnServerConfiguration.␊ - */␊ - vpnServerConfigVpnClientRevokedCertificates?: (VpnServerConfigVpnClientRevokedCertificate[] | string)␊ - /**␊ - * Radius Server root certificate of VpnServerConfiguration.␊ - */␊ - vpnServerConfigRadiusServerRootCertificates?: (VpnServerConfigRadiusServerRootCertificate[] | string)␊ - /**␊ - * Radius client root certificate of VpnServerConfiguration.␊ - */␊ - vpnServerConfigRadiusClientRootCertificates?: (VpnServerConfigRadiusClientRootCertificate[] | string)␊ - /**␊ - * VpnClientIpsecPolicies for VpnServerConfiguration.␊ - */␊ - vpnClientIpsecPolicies?: (IpsecPolicy13[] | string)␊ - /**␊ - * The radius server address property of the VpnServerConfiguration resource for point to site client connection.␊ - */␊ - radiusServerAddress?: string␊ - /**␊ - * The radius secret property of the VpnServerConfiguration resource for point to site client connection.␊ - */␊ - radiusServerSecret?: string␊ - /**␊ - * The set of aad vpn authentication parameters.␊ - */␊ - aadAuthenticationParameters?: (AadAuthenticationParameters | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of VPN client root certificate of VpnServerConfiguration.␊ - */␊ - export interface VpnServerConfigVpnClientRootCertificate {␊ - /**␊ - * The certificate name.␊ - */␊ - name?: string␊ - /**␊ - * The certificate public data.␊ - */␊ - publicCertData?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the revoked VPN client certificate of VpnServerConfiguration.␊ - */␊ - export interface VpnServerConfigVpnClientRevokedCertificate {␊ - /**␊ - * The certificate name.␊ - */␊ - name?: string␊ - /**␊ - * The revoked VPN client certificate thumbprint.␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Radius Server root certificate of VpnServerConfiguration.␊ - */␊ - export interface VpnServerConfigRadiusServerRootCertificate {␊ - /**␊ - * The certificate name.␊ - */␊ - name?: string␊ - /**␊ - * The certificate public data.␊ - */␊ - publicCertData?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Radius client root certificate of VpnServerConfiguration.␊ - */␊ - export interface VpnServerConfigRadiusClientRootCertificate {␊ - /**␊ - * The certificate name.␊ - */␊ - name?: string␊ - /**␊ - * The Radius client root certificate thumbprint.␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AAD Vpn authentication type related parameters.␊ - */␊ - export interface AadAuthenticationParameters {␊ - /**␊ - * AAD Vpn authentication parameter AAD tenant.␊ - */␊ - aadTenant?: string␊ - /**␊ - * AAD Vpn authentication parameter AAD audience.␊ - */␊ - aadAudience?: string␊ - /**␊ - * AAD Vpn authentication parameter AAD issuer.␊ - */␊ - aadIssuer?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateEndpoints␊ - */␊ - export interface PrivateEndpoints3 {␊ - name: string␊ - type: "Microsoft.Network/privateEndpoints"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the private endpoint.␊ - */␊ - properties: (PrivateEndpointProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the private endpoint.␊ - */␊ - export interface PrivateEndpointProperties3 {␊ - /**␊ - * The ID of the subnet from which the private IP will be allocated.␊ - */␊ - subnet?: (SubResource26 | string)␊ - /**␊ - * A grouping of information about the connection to the remote resource.␊ - */␊ - privateLinkServiceConnections?: (PrivateLinkServiceConnection3[] | string)␊ - /**␊ - * A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource.␊ - */␊ - manualPrivateLinkServiceConnections?: (PrivateLinkServiceConnection3[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * PrivateLinkServiceConnection resource.␊ - */␊ - export interface PrivateLinkServiceConnection3 {␊ - /**␊ - * Properties of the private link service connection.␊ - */␊ - properties?: (PrivateLinkServiceConnectionProperties3 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the PrivateLinkServiceConnection.␊ - */␊ - export interface PrivateLinkServiceConnectionProperties3 {␊ - /**␊ - * The resource id of private link service.␊ - */␊ - privateLinkServiceId?: string␊ - /**␊ - * The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to.␊ - */␊ - groupIds?: (string[] | string)␊ - /**␊ - * A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars.␊ - */␊ - requestMessage?: string␊ - /**␊ - * A collection of read-only information about the state of the connection to the remote resource.␊ - */␊ - privateLinkServiceConnectionState?: (PrivateLinkServiceConnectionState9 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A collection of information about the state of the connection between service consumer and provider.␊ - */␊ - export interface PrivateLinkServiceConnectionState9 {␊ - /**␊ - * Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.␊ - */␊ - status?: string␊ - /**␊ - * The reason for approval/rejection of the connection.␊ - */␊ - description?: string␊ - /**␊ - * A message indicating if changes on the service provider require any updates on the consumer.␊ - */␊ - actionRequired?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateLinkServices␊ - */␊ - export interface PrivateLinkServices3 {␊ - name: string␊ - type: "Microsoft.Network/privateLinkServices"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the private link service.␊ - */␊ - properties: (PrivateLinkServiceProperties3 | string)␊ - resources?: PrivateLinkServicesPrivateEndpointConnectionsChildResource3[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the private link service.␊ - */␊ - export interface PrivateLinkServiceProperties3 {␊ - /**␊ - * An array of references to the load balancer IP configurations.␊ - */␊ - loadBalancerFrontendIpConfigurations?: (SubResource26[] | string)␊ - /**␊ - * An array of private link service IP configurations.␊ - */␊ - ipConfigurations?: (PrivateLinkServiceIpConfiguration3[] | string)␊ - /**␊ - * The visibility list of the private link service.␊ - */␊ - visibility?: (PrivateLinkServicePropertiesVisibility3 | string)␊ - /**␊ - * The auto-approval list of the private link service.␊ - */␊ - autoApproval?: (PrivateLinkServicePropertiesAutoApproval3 | string)␊ - /**␊ - * The list of Fqdn.␊ - */␊ - fqdns?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The private link service ip configuration.␊ - */␊ - export interface PrivateLinkServiceIpConfiguration3 {␊ - /**␊ - * Properties of the private link service ip configuration.␊ - */␊ - properties?: (PrivateLinkServiceIpConfigurationProperties3 | string)␊ - /**␊ - * The name of private link service ip configuration.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of private link service IP configuration.␊ - */␊ - export interface PrivateLinkServiceIpConfigurationProperties3 {␊ - /**␊ - * The private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The private IP address allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * The reference to the subnet resource.␊ - */␊ - subnet?: (SubResource26 | string)␊ - /**␊ - * Whether the ip configuration is primary or not.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4.␊ - */␊ - privateIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The visibility list of the private link service.␊ - */␊ - export interface PrivateLinkServicePropertiesVisibility3 {␊ - /**␊ - * The list of subscriptions.␊ - */␊ - subscriptions?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The auto-approval list of the private link service.␊ - */␊ - export interface PrivateLinkServicePropertiesAutoApproval3 {␊ - /**␊ - * The list of subscriptions.␊ - */␊ - subscriptions?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateLinkServices/privateEndpointConnections␊ - */␊ - export interface PrivateLinkServicesPrivateEndpointConnectionsChildResource3 {␊ - name: string␊ - type: "privateEndpointConnections"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Properties of the private end point connection.␊ - */␊ - properties: (PrivateEndpointConnectionProperties10 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the PrivateEndpointConnectProperties.␊ - */␊ - export interface PrivateEndpointConnectionProperties10 {␊ - /**␊ - * A collection of information about the state of the connection between service consumer and provider.␊ - */␊ - privateLinkServiceConnectionState?: (PrivateLinkServiceConnectionState9 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateLinkServices/privateEndpointConnections␊ - */␊ - export interface PrivateLinkServicesPrivateEndpointConnections3 {␊ - name: string␊ - type: "Microsoft.Network/privateLinkServices/privateEndpointConnections"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Properties of the private end point connection.␊ - */␊ - properties: (PrivateEndpointConnectionProperties10 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/publicIPAddresses␊ - */␊ - export interface PublicIPAddresses28 {␊ - name: string␊ - type: "Microsoft.Network/publicIPAddresses"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The public IP address SKU.␊ - */␊ - sku?: (PublicIPAddressSku16 | string)␊ - /**␊ - * Public IP address properties.␊ - */␊ - properties: (PublicIPAddressPropertiesFormat19 | string)␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a public IP address.␊ - */␊ - export interface PublicIPAddressSku16 {␊ - /**␊ - * Name of a public IP address SKU.␊ - */␊ - name?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Public IP address properties.␊ - */␊ - export interface PublicIPAddressPropertiesFormat19 {␊ - /**␊ - * The public IP address allocation method.␊ - */␊ - publicIPAllocationMethod: (("Static" | "Dynamic") | string)␊ - /**␊ - * The public IP address version.␊ - */␊ - publicIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The FQDN of the DNS record associated with the public IP address.␊ - */␊ - dnsSettings?: (PublicIPAddressDnsSettings27 | string)␊ - /**␊ - * The DDoS protection custom policy associated with the public IP address.␊ - */␊ - ddosSettings?: (DdosSettings5 | string)␊ - /**␊ - * The list of tags associated with the public IP address.␊ - */␊ - ipTags?: (IpTag13[] | string)␊ - /**␊ - * The IP address associated with the public IP address resource.␊ - */␊ - ipAddress?: string␊ - /**␊ - * The Public IP Prefix this Public IP Address should be allocated from.␊ - */␊ - publicIPPrefix?: (SubResource26 | string)␊ - /**␊ - * The idle timeout of the public IP address.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains FQDN of the DNS record associated with the public IP address.␊ - */␊ - export interface PublicIPAddressDnsSettings27 {␊ - /**␊ - * The domain name label. The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.␊ - */␊ - domainNameLabel: string␊ - /**␊ - * The Fully Qualified Domain Name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone.␊ - */␊ - fqdn?: string␊ - /**␊ - * The reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN.␊ - */␊ - reverseFqdn?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains the DDoS protection settings of the public IP.␊ - */␊ - export interface DdosSettings5 {␊ - /**␊ - * The DDoS custom policy associated with the public IP.␊ - */␊ - ddosCustomPolicy?: (SubResource26 | string)␊ - /**␊ - * The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized.␊ - */␊ - protectionCoverage?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains the IpTag associated with the object.␊ - */␊ - export interface IpTag13 {␊ - /**␊ - * The IP tag type. Example: FirstPartyUsage.␊ - */␊ - ipTagType?: string␊ - /**␊ - * The value of the IP tag associated with the public IP. Example: SQL.␊ - */␊ - tag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/publicIPPrefixes␊ - */␊ - export interface PublicIPPrefixes4 {␊ - name: string␊ - type: "Microsoft.Network/publicIPPrefixes"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The public IP prefix SKU.␊ - */␊ - sku?: (PublicIPPrefixSku4 | string)␊ - /**␊ - * Public IP prefix properties.␊ - */␊ - properties: (PublicIPPrefixPropertiesFormat4 | string)␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a public IP prefix.␊ - */␊ - export interface PublicIPPrefixSku4 {␊ - /**␊ - * Name of a public IP prefix SKU.␊ - */␊ - name?: ("Standard" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Public IP prefix properties.␊ - */␊ - export interface PublicIPPrefixPropertiesFormat4 {␊ - /**␊ - * The public IP address version.␊ - */␊ - publicIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The list of tags associated with the public IP prefix.␊ - */␊ - ipTags?: (IpTag13[] | string)␊ - /**␊ - * The Length of the Public IP Prefix.␊ - */␊ - prefixLength?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeFilters␊ - */␊ - export interface RouteFilters6 {␊ - name: string␊ - type: "Microsoft.Network/routeFilters"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the route filter.␊ - */␊ - properties: (RouteFilterPropertiesFormat6 | string)␊ - resources?: RouteFiltersRouteFilterRulesChildResource6[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Filter Resource.␊ - */␊ - export interface RouteFilterPropertiesFormat6 {␊ - /**␊ - * Collection of RouteFilterRules contained within a route filter.␊ - */␊ - rules?: (RouteFilterRule6[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Filter Rule Resource.␊ - */␊ - export interface RouteFilterRule6 {␊ - /**␊ - * Properties of the route filter rule.␊ - */␊ - properties?: (RouteFilterRulePropertiesFormat6 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Filter Rule Resource.␊ - */␊ - export interface RouteFilterRulePropertiesFormat6 {␊ - /**␊ - * The access type of the rule.␊ - */␊ - access: (("Allow" | "Deny") | string)␊ - /**␊ - * The rule type of the rule.␊ - */␊ - routeFilterRuleType: ("Community" | string)␊ - /**␊ - * The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'].␊ - */␊ - communities: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeFilters/routeFilterRules␊ - */␊ - export interface RouteFiltersRouteFilterRulesChildResource6 {␊ - name: string␊ - type: "routeFilterRules"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Properties of the route filter rule.␊ - */␊ - properties: (RouteFilterRulePropertiesFormat6 | string)␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeFilters/routeFilterRules␊ - */␊ - export interface RouteFiltersRouteFilterRules6 {␊ - name: string␊ - type: "Microsoft.Network/routeFilters/routeFilterRules"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Properties of the route filter rule.␊ - */␊ - properties: (RouteFilterRulePropertiesFormat6 | string)␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables␊ - */␊ - export interface RouteTables28 {␊ - name: string␊ - type: "Microsoft.Network/routeTables"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the route table.␊ - */␊ - properties: (RouteTablePropertiesFormat20 | string)␊ - resources?: RouteTablesRoutesChildResource20[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Table resource.␊ - */␊ - export interface RouteTablePropertiesFormat20 {␊ - /**␊ - * Collection of routes contained within a route table.␊ - */␊ - routes?: (Route20[] | string)␊ - /**␊ - * Whether to disable the routes learned by BGP on that route table. True means disable.␊ - */␊ - disableBgpRoutePropagation?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource.␊ - */␊ - export interface Route20 {␊ - /**␊ - * Properties of the route.␊ - */␊ - properties?: (RoutePropertiesFormat20 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource.␊ - */␊ - export interface RoutePropertiesFormat20 {␊ - /**␊ - * The destination CIDR to which the route applies.␊ - */␊ - addressPrefix: string␊ - /**␊ - * The type of Azure hop the packet should be sent to.␊ - */␊ - nextHopType: (("VirtualNetworkGateway" | "VnetLocal" | "Internet" | "VirtualAppliance" | "None") | string)␊ - /**␊ - * The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.␊ - */␊ - nextHopIpAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutesChildResource20 {␊ - name: string␊ - type: "routes"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Properties of the route.␊ - */␊ - properties: (RoutePropertiesFormat20 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutes19 {␊ - name: string␊ - type: "Microsoft.Network/routeTables/routes"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Properties of the route.␊ - */␊ - properties: (RoutePropertiesFormat20 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/serviceEndpointPolicies␊ - */␊ - export interface ServiceEndpointPolicies4 {␊ - name: string␊ - type: "Microsoft.Network/serviceEndpointPolicies"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the service end point policy.␊ - */␊ - properties: (ServiceEndpointPolicyPropertiesFormat4 | string)␊ - resources?: ServiceEndpointPoliciesServiceEndpointPolicyDefinitionsChildResource4[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Service Endpoint Policy resource.␊ - */␊ - export interface ServiceEndpointPolicyPropertiesFormat4 {␊ - /**␊ - * A collection of service endpoint policy definitions of the service endpoint policy.␊ - */␊ - serviceEndpointPolicyDefinitions?: (ServiceEndpointPolicyDefinition4[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Service Endpoint policy definitions.␊ - */␊ - export interface ServiceEndpointPolicyDefinition4 {␊ - /**␊ - * Properties of the service endpoint policy definition.␊ - */␊ - properties?: (ServiceEndpointPolicyDefinitionPropertiesFormat4 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Service Endpoint policy definition resource.␊ - */␊ - export interface ServiceEndpointPolicyDefinitionPropertiesFormat4 {␊ - /**␊ - * A description for this rule. Restricted to 140 chars.␊ - */␊ - description?: string␊ - /**␊ - * Service endpoint name.␊ - */␊ - service?: string␊ - /**␊ - * A list of service resources.␊ - */␊ - serviceResources?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions␊ - */␊ - export interface ServiceEndpointPoliciesServiceEndpointPolicyDefinitionsChildResource4 {␊ - name: string␊ - type: "serviceEndpointPolicyDefinitions"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Properties of the service endpoint policy definition.␊ - */␊ - properties: (ServiceEndpointPolicyDefinitionPropertiesFormat4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions␊ - */␊ - export interface ServiceEndpointPoliciesServiceEndpointPolicyDefinitions4 {␊ - name: string␊ - type: "Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Properties of the service endpoint policy definition.␊ - */␊ - properties: (ServiceEndpointPolicyDefinitionPropertiesFormat4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualHubs␊ - */␊ - export interface VirtualHubs6 {␊ - name: string␊ - type: "Microsoft.Network/virtualHubs"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual hub.␊ - */␊ - properties: (VirtualHubProperties6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VirtualHub.␊ - */␊ - export interface VirtualHubProperties6 {␊ - /**␊ - * The VirtualWAN to which the VirtualHub belongs.␊ - */␊ - virtualWan?: (SubResource26 | string)␊ - /**␊ - * The VpnGateway associated with this VirtualHub.␊ - */␊ - vpnGateway?: (SubResource26 | string)␊ - /**␊ - * The P2SVpnGateway associated with this VirtualHub.␊ - */␊ - p2SVpnGateway?: (SubResource26 | string)␊ - /**␊ - * The expressRouteGateway associated with this VirtualHub.␊ - */␊ - expressRouteGateway?: (SubResource26 | string)␊ - /**␊ - * The azureFirewall associated with this VirtualHub.␊ - */␊ - azureFirewall?: (SubResource26 | string)␊ - /**␊ - * List of all vnet connections with this VirtualHub.␊ - */␊ - virtualNetworkConnections?: (HubVirtualNetworkConnection6[] | string)␊ - /**␊ - * Address-prefix for this VirtualHub.␊ - */␊ - addressPrefix?: string␊ - /**␊ - * The routeTable associated with this virtual hub.␊ - */␊ - routeTable?: (VirtualHubRouteTable3 | string)␊ - /**␊ - * The Security Provider name.␊ - */␊ - securityProviderName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HubVirtualNetworkConnection Resource.␊ - */␊ - export interface HubVirtualNetworkConnection6 {␊ - /**␊ - * Properties of the hub virtual network connection.␊ - */␊ - properties?: (HubVirtualNetworkConnectionProperties6 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for HubVirtualNetworkConnection.␊ - */␊ - export interface HubVirtualNetworkConnectionProperties6 {␊ - /**␊ - * Reference to the remote virtual network.␊ - */␊ - remoteVirtualNetwork?: (SubResource26 | string)␊ - /**␊ - * VirtualHub to RemoteVnet transit to enabled or not.␊ - */␊ - allowHubToRemoteVnetTransit?: (boolean | string)␊ - /**␊ - * Allow RemoteVnet to use Virtual Hub's gateways.␊ - */␊ - allowRemoteVnetToUseHubVnetGateways?: (boolean | string)␊ - /**␊ - * Enable internet security.␊ - */␊ - enableInternetSecurity?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualHub route table.␊ - */␊ - export interface VirtualHubRouteTable3 {␊ - /**␊ - * List of all routes.␊ - */␊ - routes?: (VirtualHubRoute3[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualHub route.␊ - */␊ - export interface VirtualHubRoute3 {␊ - /**␊ - * List of all addressPrefixes.␊ - */␊ - addressPrefixes?: (string[] | string)␊ - /**␊ - * NextHop ip address.␊ - */␊ - nextHopIpAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworkGateways␊ - */␊ - export interface VirtualNetworkGateways16 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworkGateways"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway.␊ - */␊ - properties: (VirtualNetworkGatewayPropertiesFormat16 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGateway properties.␊ - */␊ - export interface VirtualNetworkGatewayPropertiesFormat16 {␊ - /**␊ - * IP configurations for virtual network gateway.␊ - */␊ - ipConfigurations?: (VirtualNetworkGatewayIPConfiguration15[] | string)␊ - /**␊ - * The type of this virtual network gateway.␊ - */␊ - gatewayType?: (("Vpn" | "ExpressRoute" | "HyperNet") | string)␊ - /**␊ - * The type of this virtual network gateway.␊ - */␊ - vpnType?: (("PolicyBased" | "RouteBased") | string)␊ - /**␊ - * The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN.␊ - */␊ - vpnGatewayGeneration?: (("None" | "Generation1" | "Generation2") | string)␊ - /**␊ - * Whether BGP is enabled for this virtual network gateway or not.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * ActiveActive flag.␊ - */␊ - activeActive?: (boolean | string)␊ - /**␊ - * The reference of the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting.␊ - */␊ - gatewayDefaultSite?: (SubResource26 | string)␊ - /**␊ - * The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.␊ - */␊ - sku?: (VirtualNetworkGatewaySku15 | string)␊ - /**␊ - * The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations.␊ - */␊ - vpnClientConfiguration?: (VpnClientConfiguration15 | string)␊ - /**␊ - * Virtual network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings15 | string)␊ - /**␊ - * The reference of the address space resource which represents the custom routes address space specified by the customer for virtual network gateway and VpnClient.␊ - */␊ - customRoutes?: (AddressSpace28 | string)␊ - /**␊ - * Whether dns forwarding is enabled or not.␊ - */␊ - enableDnsForwarding?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration for virtual network gateway.␊ - */␊ - export interface VirtualNetworkGatewayIPConfiguration15 {␊ - /**␊ - * Properties of the virtual network gateway ip configuration.␊ - */␊ - properties?: (VirtualNetworkGatewayIPConfigurationPropertiesFormat15 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of VirtualNetworkGatewayIPConfiguration.␊ - */␊ - export interface VirtualNetworkGatewayIPConfigurationPropertiesFormat15 {␊ - /**␊ - * The private IP address allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * The reference of the subnet resource.␊ - */␊ - subnet?: (SubResource26 | string)␊ - /**␊ - * The reference of the public IP resource.␊ - */␊ - publicIPAddress?: (SubResource26 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewaySku details.␊ - */␊ - export interface VirtualNetworkGatewaySku15 {␊ - /**␊ - * Gateway SKU name.␊ - */␊ - name?: (("Basic" | "HighPerformance" | "Standard" | "UltraPerformance" | "VpnGw1" | "VpnGw2" | "VpnGw3" | "VpnGw4" | "VpnGw5" | "VpnGw1AZ" | "VpnGw2AZ" | "VpnGw3AZ" | "VpnGw4AZ" | "VpnGw5AZ" | "ErGw1AZ" | "ErGw2AZ" | "ErGw3AZ") | string)␊ - /**␊ - * Gateway SKU tier.␊ - */␊ - tier?: (("Basic" | "HighPerformance" | "Standard" | "UltraPerformance" | "VpnGw1" | "VpnGw2" | "VpnGw3" | "VpnGw4" | "VpnGw5" | "VpnGw1AZ" | "VpnGw2AZ" | "VpnGw3AZ" | "VpnGw4AZ" | "VpnGw5AZ" | "ErGw1AZ" | "ErGw2AZ" | "ErGw3AZ") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnClientConfiguration for P2S client.␊ - */␊ - export interface VpnClientConfiguration15 {␊ - /**␊ - * The reference of the address space resource which represents Address space for P2S VpnClient.␊ - */␊ - vpnClientAddressPool?: (AddressSpace28 | string)␊ - /**␊ - * VpnClientRootCertificate for virtual network gateway.␊ - */␊ - vpnClientRootCertificates?: (VpnClientRootCertificate15[] | string)␊ - /**␊ - * VpnClientRevokedCertificate for Virtual network gateway.␊ - */␊ - vpnClientRevokedCertificates?: (VpnClientRevokedCertificate15[] | string)␊ - /**␊ - * VpnClientProtocols for Virtual network gateway.␊ - */␊ - vpnClientProtocols?: (("IkeV2" | "SSTP" | "OpenVPN")[] | string)␊ - /**␊ - * VpnClientIpsecPolicies for virtual network gateway P2S client.␊ - */␊ - vpnClientIpsecPolicies?: (IpsecPolicy13[] | string)␊ - /**␊ - * The radius server address property of the VirtualNetworkGateway resource for vpn client connection.␊ - */␊ - radiusServerAddress?: string␊ - /**␊ - * The radius secret property of the VirtualNetworkGateway resource for vpn client connection.␊ - */␊ - radiusServerSecret?: string␊ - /**␊ - * The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication.␊ - */␊ - aadTenant?: string␊ - /**␊ - * The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication.␊ - */␊ - aadAudience?: string␊ - /**␊ - * The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication.␊ - */␊ - aadIssuer?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client root certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRootCertificate15 {␊ - /**␊ - * Properties of the vpn client root certificate.␊ - */␊ - properties: (VpnClientRootCertificatePropertiesFormat15 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of application gateway.␊ - */␊ - export interface VpnClientRootCertificatePropertiesFormat15 {␊ - /**␊ - * The certificate public data.␊ - */␊ - publicCertData: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client revoked certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRevokedCertificate15 {␊ - /**␊ - * Properties of the vpn client revoked certificate.␊ - */␊ - properties?: (VpnClientRevokedCertificatePropertiesFormat15 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the revoked VPN client certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRevokedCertificatePropertiesFormat15 {␊ - /**␊ - * The revoked VPN client certificate thumbprint.␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks␊ - */␊ - export interface VirtualNetworks28 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network.␊ - */␊ - properties: (VirtualNetworkPropertiesFormat20 | string)␊ - resources?: (VirtualNetworksVirtualNetworkPeeringsChildResource17 | VirtualNetworksSubnetsChildResource20)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the virtual network.␊ - */␊ - export interface VirtualNetworkPropertiesFormat20 {␊ - /**␊ - * The AddressSpace that contains an array of IP address ranges that can be used by subnets.␊ - */␊ - addressSpace: (AddressSpace28 | string)␊ - /**␊ - * The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network.␊ - */␊ - dhcpOptions?: (DhcpOptions28 | string)␊ - /**␊ - * A list of subnets in a Virtual Network.␊ - */␊ - subnets?: (Subnet30[] | string)␊ - /**␊ - * A list of peerings in a Virtual Network.␊ - */␊ - virtualNetworkPeerings?: (VirtualNetworkPeering25[] | string)␊ - /**␊ - * Indicates if DDoS protection is enabled for all the protected resources in the virtual network. It requires a DDoS protection plan associated with the resource.␊ - */␊ - enableDdosProtection?: (boolean | string)␊ - /**␊ - * Indicates if VM protection is enabled for all the subnets in the virtual network.␊ - */␊ - enableVmProtection?: (boolean | string)␊ - /**␊ - * The DDoS protection plan associated with the virtual network.␊ - */␊ - ddosProtectionPlan?: (SubResource26 | string)␊ - /**␊ - * Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET.␊ - */␊ - bgpCommunities?: (VirtualNetworkBgpCommunities | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DhcpOptions contains an array of DNS servers available to VMs deployed in the virtual network. Standard DHCP option for a subnet overrides VNET DHCP options.␊ - */␊ - export interface DhcpOptions28 {␊ - /**␊ - * The list of DNS servers IP addresses.␊ - */␊ - dnsServers: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Subnet in a virtual network resource.␊ - */␊ - export interface Subnet30 {␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties?: (SubnetPropertiesFormat20 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the subnet.␊ - */␊ - export interface SubnetPropertiesFormat20 {␊ - /**␊ - * The address prefix for the subnet.␊ - */␊ - addressPrefix: string␊ - /**␊ - * List of address prefixes for the subnet.␊ - */␊ - addressPrefixes?: (string[] | string)␊ - /**␊ - * The reference of the NetworkSecurityGroup resource.␊ - */␊ - networkSecurityGroup?: (SubResource26 | string)␊ - /**␊ - * The reference of the RouteTable resource.␊ - */␊ - routeTable?: (SubResource26 | string)␊ - /**␊ - * Nat gateway associated with this subnet.␊ - */␊ - natGateway?: (SubResource26 | string)␊ - /**␊ - * An array of service endpoints.␊ - */␊ - serviceEndpoints?: (ServiceEndpointPropertiesFormat16[] | string)␊ - /**␊ - * An array of service endpoint policies.␊ - */␊ - serviceEndpointPolicies?: (SubResource26[] | string)␊ - /**␊ - * An array of references to the delegations on the subnet.␊ - */␊ - delegations?: (Delegation7[] | string)␊ - /**␊ - * Enable or Disable apply network policies on private end point in the subnet.␊ - */␊ - privateEndpointNetworkPolicies?: string␊ - /**␊ - * Enable or Disable apply network policies on private link service in the subnet.␊ - */␊ - privateLinkServiceNetworkPolicies?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The service endpoint properties.␊ - */␊ - export interface ServiceEndpointPropertiesFormat16 {␊ - /**␊ - * The type of the endpoint service.␊ - */␊ - service?: string␊ - /**␊ - * A list of locations.␊ - */␊ - locations?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Details the service to which the subnet is delegated.␊ - */␊ - export interface Delegation7 {␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties?: (ServiceDelegationPropertiesFormat7 | string)␊ - /**␊ - * The name of the resource that is unique within a subnet. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a service delegation.␊ - */␊ - export interface ServiceDelegationPropertiesFormat7 {␊ - /**␊ - * The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers).␊ - */␊ - serviceName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peerings in a virtual network resource.␊ - */␊ - export interface VirtualNetworkPeering25 {␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties?: (VirtualNetworkPeeringPropertiesFormat17 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - export interface VirtualNetworkPeeringPropertiesFormat17 {␊ - /**␊ - * Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space.␊ - */␊ - allowVirtualNetworkAccess?: (boolean | string)␊ - /**␊ - * Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network.␊ - */␊ - allowForwardedTraffic?: (boolean | string)␊ - /**␊ - * If gateway links can be used in remote virtual networking to link to this virtual network.␊ - */␊ - allowGatewayTransit?: (boolean | string)␊ - /**␊ - * If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway.␊ - */␊ - useRemoteGateways?: (boolean | string)␊ - /**␊ - * The reference of the remote virtual network. The remote virtual network can be in the same or different region (preview). See here to register for the preview and learn more (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering).␊ - */␊ - remoteVirtualNetwork: (SubResource26 | string)␊ - /**␊ - * The reference of the remote virtual network address space.␊ - */␊ - remoteAddressSpace?: (AddressSpace28 | string)␊ - /**␊ - * The status of the virtual network peering.␊ - */␊ - peeringState?: (("Initiated" | "Connected" | "Disconnected") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET.␊ - */␊ - export interface VirtualNetworkBgpCommunities {␊ - /**␊ - * The BGP community associated with the virtual network␊ - */␊ - virtualNetworkCommunity: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/virtualNetworkPeerings␊ - */␊ - export interface VirtualNetworksVirtualNetworkPeeringsChildResource17 {␊ - name: string␊ - type: "virtualNetworkPeerings"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties: (VirtualNetworkPeeringPropertiesFormat17 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnetsChildResource20 {␊ - name: string␊ - type: "subnets"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties: (SubnetPropertiesFormat20 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnets16 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks/subnets"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties: (SubnetPropertiesFormat20 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/virtualNetworkPeerings␊ - */␊ - export interface VirtualNetworksVirtualNetworkPeerings13 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks/virtualNetworkPeerings"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties: (VirtualNetworkPeeringPropertiesFormat17 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworkTaps␊ - */␊ - export interface VirtualNetworkTaps3 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworkTaps"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Virtual Network Tap Properties.␊ - */␊ - properties: (VirtualNetworkTapPropertiesFormat3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Virtual Network Tap properties.␊ - */␊ - export interface VirtualNetworkTapPropertiesFormat3 {␊ - /**␊ - * The reference to the private IP Address of the collector nic that will receive the tap.␊ - */␊ - destinationNetworkInterfaceIPConfiguration?: (SubResource26 | string)␊ - /**␊ - * The reference to the private IP address on the internal Load Balancer that will receive the tap.␊ - */␊ - destinationLoadBalancerFrontEndIPConfiguration?: (SubResource26 | string)␊ - /**␊ - * The VXLAN destination port that will receive the tapped traffic.␊ - */␊ - destinationPort?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualRouters␊ - */␊ - export interface VirtualRouters1 {␊ - name: string␊ - type: "Microsoft.Network/virtualRouters"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the Virtual Router.␊ - */␊ - properties: (VirtualRouterPropertiesFormat1 | string)␊ - resources?: VirtualRoutersPeeringsChildResource1[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Virtual Router definition␊ - */␊ - export interface VirtualRouterPropertiesFormat1 {␊ - /**␊ - * VirtualRouter ASN.␊ - */␊ - virtualRouterAsn?: (number | string)␊ - /**␊ - * VirtualRouter IPs␊ - */␊ - virtualRouterIps?: (string[] | string)␊ - /**␊ - * The Subnet on which VirtualRouter is hosted.␊ - */␊ - hostedSubnet?: (SubResource26 | string)␊ - /**␊ - * The Gateway on which VirtualRouter is hosted.␊ - */␊ - hostedGateway?: (SubResource26 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualRouters/peerings␊ - */␊ - export interface VirtualRoutersPeeringsChildResource1 {␊ - name: string␊ - type: "peerings"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * The properties of the Virtual Router Peering.␊ - */␊ - properties: (VirtualRouterPeeringProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the rule group.␊ - */␊ - export interface VirtualRouterPeeringProperties1 {␊ - /**␊ - * Peer ASN.␊ - */␊ - peerAsn?: (number | string)␊ - /**␊ - * Peer IP.␊ - */␊ - peerIp?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualRouters/peerings␊ - */␊ - export interface VirtualRoutersPeerings1 {␊ - name: string␊ - type: "Microsoft.Network/virtualRouters/peerings"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * The properties of the Virtual Router Peering.␊ - */␊ - properties: (VirtualRouterPeeringProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualWans␊ - */␊ - export interface VirtualWans6 {␊ - name: string␊ - type: "Microsoft.Network/virtualWans"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual WAN.␊ - */␊ - properties: (VirtualWanProperties6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VirtualWAN.␊ - */␊ - export interface VirtualWanProperties6 {␊ - /**␊ - * Vpn encryption to be disabled or not.␊ - */␊ - disableVpnEncryption?: (boolean | string)␊ - /**␊ - * True if branch to branch traffic is allowed.␊ - */␊ - allowBranchToBranchTraffic?: (boolean | string)␊ - /**␊ - * True if Vnet to Vnet traffic is allowed.␊ - */␊ - allowVnetToVnetTraffic?: (boolean | string)␊ - /**␊ - * The office local breakout category.␊ - */␊ - office365LocalBreakoutCategory?: (("Optimize" | "OptimizeAndAllow" | "All" | "None") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnGateways␊ - */␊ - export interface VpnGateways6 {␊ - name: string␊ - type: "Microsoft.Network/vpnGateways"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the VPN gateway.␊ - */␊ - properties: (VpnGatewayProperties6 | string)␊ - resources?: VpnGatewaysVpnConnectionsChildResource6[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnGateway.␊ - */␊ - export interface VpnGatewayProperties6 {␊ - /**␊ - * The VirtualHub to which the gateway belongs.␊ - */␊ - virtualHub?: (SubResource26 | string)␊ - /**␊ - * List of all vpn connections to the gateway.␊ - */␊ - connections?: (VpnConnection6[] | string)␊ - /**␊ - * Local network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings15 | string)␊ - /**␊ - * The scale unit for this vpn gateway.␊ - */␊ - vpnGatewayScaleUnit?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnConnection Resource.␊ - */␊ - export interface VpnConnection6 {␊ - /**␊ - * Properties of the VPN connection.␊ - */␊ - properties?: (VpnConnectionProperties6 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnConnection.␊ - */␊ - export interface VpnConnectionProperties6 {␊ - /**␊ - * Id of the connected vpn site.␊ - */␊ - remoteVpnSite?: (SubResource26 | string)␊ - /**␊ - * Routing weight for vpn connection.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * The connection status.␊ - */␊ - connectionStatus?: (("Unknown" | "Connecting" | "Connected" | "NotConnected") | string)␊ - /**␊ - * Connection protocol used for this connection.␊ - */␊ - vpnConnectionProtocolType?: (("IKEv2" | "IKEv1") | string)␊ - /**␊ - * Expected bandwidth in MBPS.␊ - */␊ - connectionBandwidth?: (number | string)␊ - /**␊ - * SharedKey for the vpn connection.␊ - */␊ - sharedKey?: string␊ - /**␊ - * EnableBgp flag.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * Enable policy-based traffic selectors.␊ - */␊ - usePolicyBasedTrafficSelectors?: (boolean | string)␊ - /**␊ - * The IPSec Policies to be considered by this connection.␊ - */␊ - ipsecPolicies?: (IpsecPolicy13[] | string)␊ - /**␊ - * EnableBgp flag.␊ - */␊ - enableRateLimiting?: (boolean | string)␊ - /**␊ - * Enable internet security.␊ - */␊ - enableInternetSecurity?: (boolean | string)␊ - /**␊ - * Use local azure ip to initiate connection.␊ - */␊ - useLocalAzureIpAddress?: (boolean | string)␊ - /**␊ - * List of all vpn site link connections to the gateway.␊ - */␊ - vpnLinkConnections?: (VpnSiteLinkConnection2[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnSiteLinkConnection Resource.␊ - */␊ - export interface VpnSiteLinkConnection2 {␊ - /**␊ - * Properties of the VPN site link connection.␊ - */␊ - properties?: (VpnSiteLinkConnectionProperties2 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnConnection.␊ - */␊ - export interface VpnSiteLinkConnectionProperties2 {␊ - /**␊ - * Id of the connected vpn site link.␊ - */␊ - vpnSiteLink?: (SubResource26 | string)␊ - /**␊ - * Routing weight for vpn connection.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * The connection status.␊ - */␊ - connectionStatus?: (("Unknown" | "Connecting" | "Connected" | "NotConnected") | string)␊ - /**␊ - * Connection protocol used for this connection.␊ - */␊ - vpnConnectionProtocolType?: (("IKEv2" | "IKEv1") | string)␊ - /**␊ - * Expected bandwidth in MBPS.␊ - */␊ - connectionBandwidth?: (number | string)␊ - /**␊ - * SharedKey for the vpn connection.␊ - */␊ - sharedKey?: string␊ - /**␊ - * EnableBgp flag.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * Enable policy-based traffic selectors.␊ - */␊ - usePolicyBasedTrafficSelectors?: (boolean | string)␊ - /**␊ - * The IPSec Policies to be considered by this connection.␊ - */␊ - ipsecPolicies?: (IpsecPolicy13[] | string)␊ - /**␊ - * EnableBgp flag.␊ - */␊ - enableRateLimiting?: (boolean | string)␊ - /**␊ - * Use local azure ip to initiate connection.␊ - */␊ - useLocalAzureIpAddress?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnGateways/vpnConnections␊ - */␊ - export interface VpnGatewaysVpnConnectionsChildResource6 {␊ - name: string␊ - type: "vpnConnections"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Properties of the VPN connection.␊ - */␊ - properties: (VpnConnectionProperties6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnGateways/vpnConnections␊ - */␊ - export interface VpnGatewaysVpnConnections6 {␊ - name: string␊ - type: "Microsoft.Network/vpnGateways/vpnConnections"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Properties of the VPN connection.␊ - */␊ - properties: (VpnConnectionProperties6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnServerConfigurations␊ - */␊ - export interface VpnServerConfigurations {␊ - name: string␊ - type: "Microsoft.Network/vpnServerConfigurations"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the P2SVpnServer configuration.␊ - */␊ - properties: (VpnServerConfigurationProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnSites␊ - */␊ - export interface VpnSites6 {␊ - name: string␊ - type: "Microsoft.Network/vpnSites"␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the VPN site.␊ - */␊ - properties: (VpnSiteProperties6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnSite.␊ - */␊ - export interface VpnSiteProperties6 {␊ - /**␊ - * The VirtualWAN to which the vpnSite belongs.␊ - */␊ - virtualWan?: (SubResource26 | string)␊ - /**␊ - * The device properties.␊ - */␊ - deviceProperties?: (DeviceProperties6 | string)␊ - /**␊ - * The ip-address for the vpn-site.␊ - */␊ - ipAddress?: string␊ - /**␊ - * The key for vpn-site that can be used for connections.␊ - */␊ - siteKey?: string␊ - /**␊ - * The AddressSpace that contains an array of IP address ranges.␊ - */␊ - addressSpace?: (AddressSpace28 | string)␊ - /**␊ - * The set of bgp properties.␊ - */␊ - bgpProperties?: (BgpSettings15 | string)␊ - /**␊ - * IsSecuritySite flag.␊ - */␊ - isSecuritySite?: (boolean | string)␊ - /**␊ - * List of all vpn site links.␊ - */␊ - vpnSiteLinks?: (VpnSiteLink2[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * List of properties of the device.␊ - */␊ - export interface DeviceProperties6 {␊ - /**␊ - * Name of the device Vendor.␊ - */␊ - deviceVendor?: string␊ - /**␊ - * Model of the device.␊ - */␊ - deviceModel?: string␊ - /**␊ - * Link speed.␊ - */␊ - linkSpeedInMbps?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnSiteLink Resource.␊ - */␊ - export interface VpnSiteLink2 {␊ - /**␊ - * Properties of the VPN site link.␊ - */␊ - properties?: (VpnSiteLinkProperties2 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnSite.␊ - */␊ - export interface VpnSiteLinkProperties2 {␊ - /**␊ - * The link provider properties.␊ - */␊ - linkProperties?: (VpnLinkProviderProperties2 | string)␊ - /**␊ - * The ip-address for the vpn-site-link.␊ - */␊ - ipAddress?: string␊ - /**␊ - * The set of bgp properties.␊ - */␊ - bgpProperties?: (VpnLinkBgpSettings2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * List of properties of a link provider.␊ - */␊ - export interface VpnLinkProviderProperties2 {␊ - /**␊ - * Name of the link provider.␊ - */␊ - linkProviderName?: string␊ - /**␊ - * Link speed.␊ - */␊ - linkSpeedInMbps?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * BGP settings details for a link.␊ - */␊ - export interface VpnLinkBgpSettings2 {␊ - /**␊ - * The BGP speaker's ASN.␊ - */␊ - asn?: (number | string)␊ - /**␊ - * The BGP peering address and BGP identifier of this BGP speaker.␊ - */␊ - bgpPeeringAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/applicationGateways␊ - */␊ - export interface ApplicationGateways20 {␊ - name: string␊ - type: "Microsoft.Network/applicationGateways"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the application gateway.␊ - */␊ - properties: (ApplicationGatewayPropertiesFormat20 | string)␊ - /**␊ - * A list of availability zones denoting where the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - /**␊ - * The identity of the application gateway, if configured.␊ - */␊ - identity?: (ManagedServiceIdentity7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application gateway.␊ - */␊ - export interface ApplicationGatewayPropertiesFormat20 {␊ - /**␊ - * SKU of the application gateway resource.␊ - */␊ - sku?: (ApplicationGatewaySku20 | string)␊ - /**␊ - * SSL policy of the application gateway resource.␊ - */␊ - sslPolicy?: (ApplicationGatewaySslPolicy17 | string)␊ - /**␊ - * Subnets of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - gatewayIPConfigurations?: (ApplicationGatewayIPConfiguration20[] | string)␊ - /**␊ - * Authentication certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - authenticationCertificates?: (ApplicationGatewayAuthenticationCertificate17[] | string)␊ - /**␊ - * Trusted Root certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - trustedRootCertificates?: (ApplicationGatewayTrustedRootCertificate8[] | string)␊ - /**␊ - * SSL certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - sslCertificates?: (ApplicationGatewaySslCertificate20[] | string)␊ - /**␊ - * Frontend IP addresses of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - frontendIPConfigurations?: (ApplicationGatewayFrontendIPConfiguration20[] | string)␊ - /**␊ - * Frontend ports of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - frontendPorts?: (ApplicationGatewayFrontendPort20[] | string)␊ - /**␊ - * Probes of the application gateway resource.␊ - */␊ - probes?: (ApplicationGatewayProbe19[] | string)␊ - /**␊ - * Backend address pool of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - backendAddressPools?: (ApplicationGatewayBackendAddressPool20[] | string)␊ - /**␊ - * Backend http settings of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - backendHttpSettingsCollection?: (ApplicationGatewayBackendHttpSettings20[] | string)␊ - /**␊ - * Http listeners of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - httpListeners?: (ApplicationGatewayHttpListener20[] | string)␊ - /**␊ - * URL path map of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - urlPathMaps?: (ApplicationGatewayUrlPathMap19[] | string)␊ - /**␊ - * Request routing rules of the application gateway resource.␊ - */␊ - requestRoutingRules?: (ApplicationGatewayRequestRoutingRule20[] | string)␊ - /**␊ - * Rewrite rules for the application gateway resource.␊ - */␊ - rewriteRuleSets?: (ApplicationGatewayRewriteRuleSet7[] | string)␊ - /**␊ - * Redirect configurations of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - redirectConfigurations?: (ApplicationGatewayRedirectConfiguration17[] | string)␊ - /**␊ - * Web application firewall configuration.␊ - */␊ - webApplicationFirewallConfiguration?: (ApplicationGatewayWebApplicationFirewallConfiguration17 | string)␊ - /**␊ - * Reference of the FirewallPolicy resource.␊ - */␊ - firewallPolicy?: (SubResource27 | string)␊ - /**␊ - * Whether HTTP2 is enabled on the application gateway resource.␊ - */␊ - enableHttp2?: (boolean | string)␊ - /**␊ - * Whether FIPS is enabled on the application gateway resource.␊ - */␊ - enableFips?: (boolean | string)␊ - /**␊ - * Autoscale Configuration.␊ - */␊ - autoscaleConfiguration?: (ApplicationGatewayAutoscaleConfiguration11 | string)␊ - /**␊ - * Custom error configurations of the application gateway resource.␊ - */␊ - customErrorConfigurations?: (ApplicationGatewayCustomError8[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of an application gateway.␊ - */␊ - export interface ApplicationGatewaySku20 {␊ - /**␊ - * Name of an application gateway SKU.␊ - */␊ - name?: (("Standard_Small" | "Standard_Medium" | "Standard_Large" | "WAF_Medium" | "WAF_Large" | "Standard_v2" | "WAF_v2") | string)␊ - /**␊ - * Tier of an application gateway.␊ - */␊ - tier?: (("Standard" | "WAF" | "Standard_v2" | "WAF_v2") | string)␊ - /**␊ - * Capacity (instance count) of an application gateway.␊ - */␊ - capacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application Gateway Ssl policy.␊ - */␊ - export interface ApplicationGatewaySslPolicy17 {␊ - /**␊ - * Ssl protocols to be disabled on application gateway.␊ - */␊ - disabledSslProtocols?: (("TLSv1_0" | "TLSv1_1" | "TLSv1_2")[] | string)␊ - /**␊ - * Type of Ssl Policy.␊ - */␊ - policyType?: (("Predefined" | "Custom") | string)␊ - /**␊ - * Name of Ssl predefined policy.␊ - */␊ - policyName?: (("AppGwSslPolicy20150501" | "AppGwSslPolicy20170401" | "AppGwSslPolicy20170401S") | string)␊ - /**␊ - * Ssl cipher suites to be enabled in the specified order to application gateway.␊ - */␊ - cipherSuites?: (("TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384" | "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256" | "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA" | "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA" | "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384" | "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256" | "TLS_DHE_RSA_WITH_AES_256_CBC_SHA" | "TLS_DHE_RSA_WITH_AES_128_CBC_SHA" | "TLS_RSA_WITH_AES_256_GCM_SHA384" | "TLS_RSA_WITH_AES_128_GCM_SHA256" | "TLS_RSA_WITH_AES_256_CBC_SHA256" | "TLS_RSA_WITH_AES_128_CBC_SHA256" | "TLS_RSA_WITH_AES_256_CBC_SHA" | "TLS_RSA_WITH_AES_128_CBC_SHA" | "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384" | "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256" | "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384" | "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256" | "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA" | "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA" | "TLS_DHE_DSS_WITH_AES_256_CBC_SHA256" | "TLS_DHE_DSS_WITH_AES_128_CBC_SHA256" | "TLS_DHE_DSS_WITH_AES_256_CBC_SHA" | "TLS_DHE_DSS_WITH_AES_128_CBC_SHA" | "TLS_RSA_WITH_3DES_EDE_CBC_SHA" | "TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA" | "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256" | "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384")[] | string)␊ - /**␊ - * Minimum version of Ssl protocol to be supported on application gateway.␊ - */␊ - minProtocolVersion?: (("TLSv1_0" | "TLSv1_1" | "TLSv1_2") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed.␊ - */␊ - export interface ApplicationGatewayIPConfiguration20 {␊ - /**␊ - * Properties of the application gateway IP configuration.␊ - */␊ - properties?: (ApplicationGatewayIPConfigurationPropertiesFormat20 | string)␊ - /**␊ - * Name of the IP configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayIPConfigurationPropertiesFormat20 {␊ - /**␊ - * Reference of the subnet resource. A subnet from where application gateway gets its private address.␊ - */␊ - subnet?: (SubResource27 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Reference to another subresource.␊ - */␊ - export interface SubResource27 {␊ - /**␊ - * Resource ID.␊ - */␊ - id: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authentication certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewayAuthenticationCertificate17 {␊ - /**␊ - * Properties of the application gateway authentication certificate.␊ - */␊ - properties?: (ApplicationGatewayAuthenticationCertificatePropertiesFormat17 | string)␊ - /**␊ - * Name of the authentication certificate that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authentication certificates properties of an application gateway.␊ - */␊ - export interface ApplicationGatewayAuthenticationCertificatePropertiesFormat17 {␊ - /**␊ - * Certificate public data.␊ - */␊ - data?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trusted Root certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewayTrustedRootCertificate8 {␊ - /**␊ - * Properties of the application gateway trusted root certificate.␊ - */␊ - properties?: (ApplicationGatewayTrustedRootCertificatePropertiesFormat8 | string)␊ - /**␊ - * Name of the trusted root certificate that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trusted Root certificates properties of an application gateway.␊ - */␊ - export interface ApplicationGatewayTrustedRootCertificatePropertiesFormat8 {␊ - /**␊ - * Certificate public data.␊ - */␊ - data?: string␊ - /**␊ - * Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault.␊ - */␊ - keyVaultSecretId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSL certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewaySslCertificate20 {␊ - /**␊ - * Properties of the application gateway SSL certificate.␊ - */␊ - properties?: (ApplicationGatewaySslCertificatePropertiesFormat20 | string)␊ - /**␊ - * Name of the SSL certificate that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewaySslCertificatePropertiesFormat20 {␊ - /**␊ - * Base-64 encoded pfx certificate. Only applicable in PUT Request.␊ - */␊ - data?: string␊ - /**␊ - * Password for the pfx file specified in data. Only applicable in PUT request.␊ - */␊ - password?: string␊ - /**␊ - * Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault.␊ - */␊ - keyVaultSecretId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendIPConfiguration20 {␊ - /**␊ - * Properties of the application gateway frontend IP configuration.␊ - */␊ - properties?: (ApplicationGatewayFrontendIPConfigurationPropertiesFormat20 | string)␊ - /**␊ - * Name of the frontend IP configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendIPConfigurationPropertiesFormat20 {␊ - /**␊ - * PrivateIPAddress of the network interface IP Configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The private IP address allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Reference of the subnet resource.␊ - */␊ - subnet?: (SubResource27 | string)␊ - /**␊ - * Reference of the PublicIP resource.␊ - */␊ - publicIPAddress?: (SubResource27 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend port of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendPort20 {␊ - /**␊ - * Properties of the application gateway frontend port.␊ - */␊ - properties?: (ApplicationGatewayFrontendPortPropertiesFormat20 | string)␊ - /**␊ - * Name of the frontend port that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend port of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendPortPropertiesFormat20 {␊ - /**␊ - * Frontend port.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Probe of the application gateway.␊ - */␊ - export interface ApplicationGatewayProbe19 {␊ - /**␊ - * Properties of the application gateway probe.␊ - */␊ - properties?: (ApplicationGatewayProbePropertiesFormat19 | string)␊ - /**␊ - * Name of the probe that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of probe of an application gateway.␊ - */␊ - export interface ApplicationGatewayProbePropertiesFormat19 {␊ - /**␊ - * The protocol used for the probe.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Host name to send the probe to.␊ - */␊ - host?: string␊ - /**␊ - * Relative path of probe. Valid path starts from '/'. Probe is sent to ://:.␊ - */␊ - path?: string␊ - /**␊ - * The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - interval?: (number | string)␊ - /**␊ - * The probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - timeout?: (number | string)␊ - /**␊ - * The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20.␊ - */␊ - unhealthyThreshold?: (number | string)␊ - /**␊ - * Whether the host header should be picked from the backend http settings. Default value is false.␊ - */␊ - pickHostNameFromBackendHttpSettings?: (boolean | string)␊ - /**␊ - * Minimum number of servers that are always marked healthy. Default value is 0.␊ - */␊ - minServers?: (number | string)␊ - /**␊ - * Criterion for classifying a healthy probe response.␊ - */␊ - match?: (ApplicationGatewayProbeHealthResponseMatch17 | string)␊ - /**␊ - * Custom port which will be used for probing the backend servers. The valid value ranges from 1 to 65535. In case not set, port from http settings will be used. This property is valid for Standard_v2 and WAF_v2 only.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application gateway probe health response match.␊ - */␊ - export interface ApplicationGatewayProbeHealthResponseMatch17 {␊ - /**␊ - * Body that must be contained in the health response. Default value is empty.␊ - */␊ - body?: string␊ - /**␊ - * Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399.␊ - */␊ - statusCodes?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend Address Pool of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddressPool20 {␊ - /**␊ - * Properties of the application gateway backend address pool.␊ - */␊ - properties?: (ApplicationGatewayBackendAddressPoolPropertiesFormat20 | string)␊ - /**␊ - * Name of the backend address pool that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend Address Pool of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddressPoolPropertiesFormat20 {␊ - /**␊ - * Backend addresses.␊ - */␊ - backendAddresses?: (ApplicationGatewayBackendAddress20[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddress20 {␊ - /**␊ - * Fully qualified domain name (FQDN).␊ - */␊ - fqdn?: string␊ - /**␊ - * IP address.␊ - */␊ - ipAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address pool settings of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendHttpSettings20 {␊ - /**␊ - * Properties of the application gateway backend HTTP settings.␊ - */␊ - properties?: (ApplicationGatewayBackendHttpSettingsPropertiesFormat20 | string)␊ - /**␊ - * Name of the backend http settings that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend address pool settings of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendHttpSettingsPropertiesFormat20 {␊ - /**␊ - * The destination port on the backend.␊ - */␊ - port?: (number | string)␊ - /**␊ - * The protocol used to communicate with the backend.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Cookie based affinity.␊ - */␊ - cookieBasedAffinity?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Request timeout in seconds. Application Gateway will fail the request if response is not received within RequestTimeout. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - requestTimeout?: (number | string)␊ - /**␊ - * Probe resource of an application gateway.␊ - */␊ - probe?: (SubResource27 | string)␊ - /**␊ - * Array of references to application gateway authentication certificates.␊ - */␊ - authenticationCertificates?: (SubResource27[] | string)␊ - /**␊ - * Array of references to application gateway trusted root certificates.␊ - */␊ - trustedRootCertificates?: (SubResource27[] | string)␊ - /**␊ - * Connection draining of the backend http settings resource.␊ - */␊ - connectionDraining?: (ApplicationGatewayConnectionDraining17 | string)␊ - /**␊ - * Host header to be sent to the backend servers.␊ - */␊ - hostName?: string␊ - /**␊ - * Whether to pick host header should be picked from the host name of the backend server. Default value is false.␊ - */␊ - pickHostNameFromBackendAddress?: (boolean | string)␊ - /**␊ - * Cookie name to use for the affinity cookie.␊ - */␊ - affinityCookieName?: string␊ - /**␊ - * Whether the probe is enabled. Default value is false.␊ - */␊ - probeEnabled?: (boolean | string)␊ - /**␊ - * Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null.␊ - */␊ - path?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Connection draining allows open connections to a backend server to be active for a specified time after the backend server got removed from the configuration.␊ - */␊ - export interface ApplicationGatewayConnectionDraining17 {␊ - /**␊ - * Whether connection draining is enabled or not.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds.␊ - */␊ - drainTimeoutInSec: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http listener of an application gateway.␊ - */␊ - export interface ApplicationGatewayHttpListener20 {␊ - /**␊ - * Properties of the application gateway HTTP listener.␊ - */␊ - properties?: (ApplicationGatewayHttpListenerPropertiesFormat20 | string)␊ - /**␊ - * Name of the HTTP listener that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of HTTP listener of an application gateway.␊ - */␊ - export interface ApplicationGatewayHttpListenerPropertiesFormat20 {␊ - /**␊ - * Frontend IP configuration resource of an application gateway.␊ - */␊ - frontendIPConfiguration?: (SubResource27 | string)␊ - /**␊ - * Frontend port resource of an application gateway.␊ - */␊ - frontendPort?: (SubResource27 | string)␊ - /**␊ - * Protocol of the HTTP listener.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Host name of HTTP listener.␊ - */␊ - hostName?: string␊ - /**␊ - * SSL certificate resource of an application gateway.␊ - */␊ - sslCertificate?: (SubResource27 | string)␊ - /**␊ - * Applicable only if protocol is https. Enables SNI for multi-hosting.␊ - */␊ - requireServerNameIndication?: (boolean | string)␊ - /**␊ - * Custom error configurations of the HTTP listener.␊ - */␊ - customErrorConfigurations?: (ApplicationGatewayCustomError8[] | string)␊ - /**␊ - * Reference to the FirewallPolicy resource.␊ - */␊ - firewallPolicy?: (SubResource27 | string)␊ - /**␊ - * List of Host names for HTTP Listener that allows special wildcard characters as well.␊ - */␊ - hostnames?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Customer error of an application gateway.␊ - */␊ - export interface ApplicationGatewayCustomError8 {␊ - /**␊ - * Status code of the application gateway customer error.␊ - */␊ - statusCode?: (("HttpStatus403" | "HttpStatus502") | string)␊ - /**␊ - * Error page URL of the application gateway customer error.␊ - */␊ - customErrorPageUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * UrlPathMaps give a url path to the backend mapping information for PathBasedRouting.␊ - */␊ - export interface ApplicationGatewayUrlPathMap19 {␊ - /**␊ - * Properties of the application gateway URL path map.␊ - */␊ - properties?: (ApplicationGatewayUrlPathMapPropertiesFormat19 | string)␊ - /**␊ - * Name of the URL path map that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of UrlPathMap of the application gateway.␊ - */␊ - export interface ApplicationGatewayUrlPathMapPropertiesFormat19 {␊ - /**␊ - * Default backend address pool resource of URL path map.␊ - */␊ - defaultBackendAddressPool?: (SubResource27 | string)␊ - /**␊ - * Default backend http settings resource of URL path map.␊ - */␊ - defaultBackendHttpSettings?: (SubResource27 | string)␊ - /**␊ - * Default Rewrite rule set resource of URL path map.␊ - */␊ - defaultRewriteRuleSet?: (SubResource27 | string)␊ - /**␊ - * Default redirect configuration resource of URL path map.␊ - */␊ - defaultRedirectConfiguration?: (SubResource27 | string)␊ - /**␊ - * Path rule of URL path map resource.␊ - */␊ - pathRules?: (ApplicationGatewayPathRule19[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Path rule of URL path map of an application gateway.␊ - */␊ - export interface ApplicationGatewayPathRule19 {␊ - /**␊ - * Properties of the application gateway path rule.␊ - */␊ - properties?: (ApplicationGatewayPathRulePropertiesFormat19 | string)␊ - /**␊ - * Name of the path rule that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of path rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayPathRulePropertiesFormat19 {␊ - /**␊ - * Path rules of URL path map.␊ - */␊ - paths?: (string[] | string)␊ - /**␊ - * Backend address pool resource of URL path map path rule.␊ - */␊ - backendAddressPool?: (SubResource27 | string)␊ - /**␊ - * Backend http settings resource of URL path map path rule.␊ - */␊ - backendHttpSettings?: (SubResource27 | string)␊ - /**␊ - * Redirect configuration resource of URL path map path rule.␊ - */␊ - redirectConfiguration?: (SubResource27 | string)␊ - /**␊ - * Rewrite rule set resource of URL path map path rule.␊ - */␊ - rewriteRuleSet?: (SubResource27 | string)␊ - /**␊ - * Reference to the FirewallPolicy resource.␊ - */␊ - firewallPolicy?: (SubResource27 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Request routing rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayRequestRoutingRule20 {␊ - /**␊ - * Properties of the application gateway request routing rule.␊ - */␊ - properties?: (ApplicationGatewayRequestRoutingRulePropertiesFormat20 | string)␊ - /**␊ - * Name of the request routing rule that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of request routing rule of the application gateway.␊ - */␊ - export interface ApplicationGatewayRequestRoutingRulePropertiesFormat20 {␊ - /**␊ - * Rule type.␊ - */␊ - ruleType?: (("Basic" | "PathBasedRouting") | string)␊ - /**␊ - * Priority of the request routing rule.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * Backend address pool resource of the application gateway.␊ - */␊ - backendAddressPool?: (SubResource27 | string)␊ - /**␊ - * Backend http settings resource of the application gateway.␊ - */␊ - backendHttpSettings?: (SubResource27 | string)␊ - /**␊ - * Http listener resource of the application gateway.␊ - */␊ - httpListener?: (SubResource27 | string)␊ - /**␊ - * URL path map resource of the application gateway.␊ - */␊ - urlPathMap?: (SubResource27 | string)␊ - /**␊ - * Rewrite Rule Set resource in Basic rule of the application gateway.␊ - */␊ - rewriteRuleSet?: (SubResource27 | string)␊ - /**␊ - * Redirect configuration resource of the application gateway.␊ - */␊ - redirectConfiguration?: (SubResource27 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Rewrite rule set of an application gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRuleSet7 {␊ - /**␊ - * Properties of the application gateway rewrite rule set.␊ - */␊ - properties?: (ApplicationGatewayRewriteRuleSetPropertiesFormat7 | string)␊ - /**␊ - * Name of the rewrite rule set that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of rewrite rule set of the application gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRuleSetPropertiesFormat7 {␊ - /**␊ - * Rewrite rules in the rewrite rule set.␊ - */␊ - rewriteRules?: (ApplicationGatewayRewriteRule7[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Rewrite rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRule7 {␊ - /**␊ - * Name of the rewrite rule that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet.␊ - */␊ - ruleSequence?: (number | string)␊ - /**␊ - * Conditions based on which the action set execution will be evaluated.␊ - */␊ - conditions?: (ApplicationGatewayRewriteRuleCondition6[] | string)␊ - /**␊ - * Set of actions to be done as part of the rewrite Rule.␊ - */␊ - actionSet?: (ApplicationGatewayRewriteRuleActionSet7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Set of conditions in the Rewrite Rule in Application Gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRuleCondition6 {␊ - /**␊ - * The condition parameter of the RewriteRuleCondition.␊ - */␊ - variable?: string␊ - /**␊ - * The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition.␊ - */␊ - pattern?: string␊ - /**␊ - * Setting this paramter to truth value with force the pattern to do a case in-sensitive comparison.␊ - */␊ - ignoreCase?: (boolean | string)␊ - /**␊ - * Setting this value as truth will force to check the negation of the condition given by the user.␊ - */␊ - negate?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Set of actions in the Rewrite Rule in Application Gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRuleActionSet7 {␊ - /**␊ - * Request Header Actions in the Action Set.␊ - */␊ - requestHeaderConfigurations?: (ApplicationGatewayHeaderConfiguration7[] | string)␊ - /**␊ - * Response Header Actions in the Action Set.␊ - */␊ - responseHeaderConfigurations?: (ApplicationGatewayHeaderConfiguration7[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Header configuration of the Actions set in Application Gateway.␊ - */␊ - export interface ApplicationGatewayHeaderConfiguration7 {␊ - /**␊ - * Header name of the header configuration.␊ - */␊ - headerName?: string␊ - /**␊ - * Header value of the header configuration.␊ - */␊ - headerValue?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Redirect configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayRedirectConfiguration17 {␊ - /**␊ - * Properties of the application gateway redirect configuration.␊ - */␊ - properties?: (ApplicationGatewayRedirectConfigurationPropertiesFormat17 | string)␊ - /**␊ - * Name of the redirect configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of redirect configuration of the application gateway.␊ - */␊ - export interface ApplicationGatewayRedirectConfigurationPropertiesFormat17 {␊ - /**␊ - * HTTP redirection type.␊ - */␊ - redirectType?: (("Permanent" | "Found" | "SeeOther" | "Temporary") | string)␊ - /**␊ - * Reference to a listener to redirect the request to.␊ - */␊ - targetListener?: (SubResource27 | string)␊ - /**␊ - * Url to redirect the request to.␊ - */␊ - targetUrl?: string␊ - /**␊ - * Include path in the redirected url.␊ - */␊ - includePath?: (boolean | string)␊ - /**␊ - * Include query string in the redirected url.␊ - */␊ - includeQueryString?: (boolean | string)␊ - /**␊ - * Request routing specifying redirect configuration.␊ - */␊ - requestRoutingRules?: (SubResource27[] | string)␊ - /**␊ - * Url path maps specifying default redirect configuration.␊ - */␊ - urlPathMaps?: (SubResource27[] | string)␊ - /**␊ - * Path rules specifying redirect configuration.␊ - */␊ - pathRules?: (SubResource27[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application gateway web application firewall configuration.␊ - */␊ - export interface ApplicationGatewayWebApplicationFirewallConfiguration17 {␊ - /**␊ - * Whether the web application firewall is enabled or not.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * Web application firewall mode.␊ - */␊ - firewallMode: (("Detection" | "Prevention") | string)␊ - /**␊ - * The type of the web application firewall rule set. Possible values are: 'OWASP'.␊ - */␊ - ruleSetType: string␊ - /**␊ - * The version of the rule set type.␊ - */␊ - ruleSetVersion: string␊ - /**␊ - * The disabled rule groups.␊ - */␊ - disabledRuleGroups?: (ApplicationGatewayFirewallDisabledRuleGroup17[] | string)␊ - /**␊ - * Whether allow WAF to check request Body.␊ - */␊ - requestBodyCheck?: (boolean | string)␊ - /**␊ - * Maximum request body size for WAF.␊ - */␊ - maxRequestBodySize?: (number | string)␊ - /**␊ - * Maximum request body size in Kb for WAF.␊ - */␊ - maxRequestBodySizeInKb?: (number | string)␊ - /**␊ - * Maximum file upload size in Mb for WAF.␊ - */␊ - fileUploadLimitInMb?: (number | string)␊ - /**␊ - * The exclusion list.␊ - */␊ - exclusions?: (ApplicationGatewayFirewallExclusion8[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allows to disable rules within a rule group or an entire rule group.␊ - */␊ - export interface ApplicationGatewayFirewallDisabledRuleGroup17 {␊ - /**␊ - * The name of the rule group that will be disabled.␊ - */␊ - ruleGroupName: string␊ - /**␊ - * The list of rules that will be disabled. If null, all rules of the rule group will be disabled.␊ - */␊ - rules?: (number[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allow to exclude some variable satisfy the condition for the WAF check.␊ - */␊ - export interface ApplicationGatewayFirewallExclusion8 {␊ - /**␊ - * The variable to be excluded.␊ - */␊ - matchVariable: string␊ - /**␊ - * When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to.␊ - */␊ - selectorMatchOperator: string␊ - /**␊ - * When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to.␊ - */␊ - selector: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application Gateway autoscale configuration.␊ - */␊ - export interface ApplicationGatewayAutoscaleConfiguration11 {␊ - /**␊ - * Lower bound on number of Application Gateway capacity.␊ - */␊ - minCapacity: (number | string)␊ - /**␊ - * Upper bound on number of Application Gateway capacity.␊ - */␊ - maxCapacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the resource.␊ - */␊ - export interface ManagedServiceIdentity7 {␊ - /**␊ - * The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.␊ - */␊ - type?: ("SystemAssigned" | "UserAssigned" | "SystemAssigned, UserAssigned" | "None")␊ - /**␊ - * The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.␊ - */␊ - userAssignedIdentities?: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies␊ - */␊ - export interface ApplicationGatewayWebApplicationFirewallPolicies5 {␊ - name: string␊ - type: "Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the web application firewall policy.␊ - */␊ - properties: (WebApplicationFirewallPolicyPropertiesFormat5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines web application firewall policy properties.␊ - */␊ - export interface WebApplicationFirewallPolicyPropertiesFormat5 {␊ - /**␊ - * Describes policySettings for policy.␊ - */␊ - policySettings?: (PolicySettings7 | string)␊ - /**␊ - * Describes custom rules inside the policy.␊ - */␊ - customRules?: (WebApplicationFirewallCustomRule5[] | string)␊ - /**␊ - * Describes the managedRules structure␊ - */␊ - managedRules: (ManagedRulesDefinition1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines contents of a web application firewall global configuration.␊ - */␊ - export interface PolicySettings7 {␊ - /**␊ - * Describes if the policy is in enabled state or disabled state.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * Describes if it is in detection mode or prevention mode at policy level.␊ - */␊ - mode?: (("Prevention" | "Detection") | string)␊ - /**␊ - * Whether to allow WAF to check request Body.␊ - */␊ - requestBodyCheck?: (boolean | string)␊ - /**␊ - * Maximum request body size in Kb for WAF.␊ - */␊ - maxRequestBodySizeInKb?: (number | string)␊ - /**␊ - * Maximum file upload size in Mb for WAF.␊ - */␊ - fileUploadLimitInMb?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines contents of a web application rule.␊ - */␊ - export interface WebApplicationFirewallCustomRule5 {␊ - /**␊ - * The name of the resource that is unique within a policy. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value.␊ - */␊ - priority: (number | string)␊ - /**␊ - * Describes type of rule.␊ - */␊ - ruleType: (("MatchRule" | "Invalid") | string)␊ - /**␊ - * List of match conditions.␊ - */␊ - matchConditions: (MatchCondition7[] | string)␊ - /**␊ - * Type of Actions.␊ - */␊ - action: (("Allow" | "Block" | "Log") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Define match conditions.␊ - */␊ - export interface MatchCondition7 {␊ - /**␊ - * List of match variables.␊ - */␊ - matchVariables: (MatchVariable5[] | string)␊ - /**␊ - * Describes operator to be matched.␊ - */␊ - operator: (("IPMatch" | "Equal" | "Contains" | "LessThan" | "GreaterThan" | "LessThanOrEqual" | "GreaterThanOrEqual" | "BeginsWith" | "EndsWith" | "Regex" | "GeoMatch") | string)␊ - /**␊ - * Describes if this is negate condition or not.␊ - */␊ - negationConditon?: (boolean | string)␊ - /**␊ - * Match value.␊ - */␊ - matchValues: (string[] | string)␊ - /**␊ - * List of transforms.␊ - */␊ - transforms?: (("Lowercase" | "Trim" | "UrlDecode" | "UrlEncode" | "RemoveNulls" | "HtmlEntityDecode")[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Define match variables.␊ - */␊ - export interface MatchVariable5 {␊ - /**␊ - * Match Variable.␊ - */␊ - variableName: (("RemoteAddr" | "RequestMethod" | "QueryString" | "PostArgs" | "RequestUri" | "RequestHeaders" | "RequestBody" | "RequestCookies") | string)␊ - /**␊ - * Describes field of the matchVariable collection.␊ - */␊ - selector?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allow to exclude some variable satisfy the condition for the WAF check.␊ - */␊ - export interface ManagedRulesDefinition1 {␊ - /**␊ - * Describes the Exclusions that are applied on the policy.␊ - */␊ - exclusions?: (OwaspCrsExclusionEntry1[] | string)␊ - /**␊ - * Describes the ruleSets that are associated with the policy.␊ - */␊ - managedRuleSets: (ManagedRuleSet3[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allow to exclude some variable satisfy the condition for the WAF check.␊ - */␊ - export interface OwaspCrsExclusionEntry1 {␊ - /**␊ - * The variable to be excluded.␊ - */␊ - matchVariable: (("RequestHeaderNames" | "RequestCookieNames" | "RequestArgNames") | string)␊ - /**␊ - * When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to.␊ - */␊ - selectorMatchOperator: (("Equals" | "Contains" | "StartsWith" | "EndsWith" | "EqualsAny") | string)␊ - /**␊ - * When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to.␊ - */␊ - selector: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines a managed rule set.␊ - */␊ - export interface ManagedRuleSet3 {␊ - /**␊ - * Defines the rule set type to use.␊ - */␊ - ruleSetType: string␊ - /**␊ - * Defines the version of the rule set to use.␊ - */␊ - ruleSetVersion: string␊ - /**␊ - * Defines the rule group overrides to apply to the rule set.␊ - */␊ - ruleGroupOverrides?: (ManagedRuleGroupOverride3[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines a managed rule group override setting.␊ - */␊ - export interface ManagedRuleGroupOverride3 {␊ - /**␊ - * Describes the managed rule group to override.␊ - */␊ - ruleGroupName: string␊ - /**␊ - * List of rules that will be disabled. If none specified, all rules in the group will be disabled.␊ - */␊ - rules?: (ManagedRuleOverride3[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines a managed rule group override setting.␊ - */␊ - export interface ManagedRuleOverride3 {␊ - /**␊ - * Identifier for the managed rule.␊ - */␊ - ruleId: string␊ - /**␊ - * Describes the state of the managed rule. Defaults to Disabled if not specified.␊ - */␊ - state?: ("Disabled" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/applicationSecurityGroups␊ - */␊ - export interface ApplicationSecurityGroups17 {␊ - name: string␊ - type: "Microsoft.Network/applicationSecurityGroups"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the application security group.␊ - */␊ - properties: (ApplicationSecurityGroupPropertiesFormat4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application security group properties.␊ - */␊ - export interface ApplicationSecurityGroupPropertiesFormat4 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/azureFirewalls␊ - */␊ - export interface AzureFirewalls7 {␊ - name: string␊ - type: "Microsoft.Network/azureFirewalls"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the azure firewall.␊ - */␊ - properties: (AzureFirewallPropertiesFormat7 | string)␊ - /**␊ - * A list of availability zones denoting where the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Azure Firewall.␊ - */␊ - export interface AzureFirewallPropertiesFormat7 {␊ - /**␊ - * Collection of application rule collections used by Azure Firewall.␊ - */␊ - applicationRuleCollections?: (AzureFirewallApplicationRuleCollection7[] | string)␊ - /**␊ - * Collection of NAT rule collections used by Azure Firewall.␊ - */␊ - natRuleCollections?: (AzureFirewallNatRuleCollection4[] | string)␊ - /**␊ - * Collection of network rule collections used by Azure Firewall.␊ - */␊ - networkRuleCollections?: (AzureFirewallNetworkRuleCollection7[] | string)␊ - /**␊ - * IP configuration of the Azure Firewall resource.␊ - */␊ - ipConfigurations?: (AzureFirewallIPConfiguration7[] | string)␊ - /**␊ - * The operation mode for Threat Intelligence.␊ - */␊ - threatIntelMode?: (("Alert" | "Deny" | "Off") | string)␊ - /**␊ - * The virtualHub to which the firewall belongs.␊ - */␊ - virtualHub?: (SubResource27 | string)␊ - /**␊ - * The firewallPolicy associated with this azure firewall.␊ - */␊ - firewallPolicy?: (SubResource27 | string)␊ - /**␊ - * The Azure Firewall Resource SKU.␊ - */␊ - sku?: (AzureFirewallSku1 | string)␊ - /**␊ - * The additional properties used to further config this azure firewall ␊ - */␊ - additionalProperties?: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application rule collection resource.␊ - */␊ - export interface AzureFirewallApplicationRuleCollection7 {␊ - /**␊ - * Properties of the azure firewall application rule collection.␊ - */␊ - properties?: (AzureFirewallApplicationRuleCollectionPropertiesFormat7 | string)␊ - /**␊ - * The name of the resource that is unique within the Azure firewall. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application rule collection.␊ - */␊ - export interface AzureFirewallApplicationRuleCollectionPropertiesFormat7 {␊ - /**␊ - * Priority of the application rule collection resource.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * The action type of a rule collection.␊ - */␊ - action?: (AzureFirewallRCAction7 | string)␊ - /**␊ - * Collection of rules used by a application rule collection.␊ - */␊ - rules?: (AzureFirewallApplicationRule7[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the AzureFirewallRCAction.␊ - */␊ - export interface AzureFirewallRCAction7 {␊ - /**␊ - * The type of action.␊ - */␊ - type?: ("Allow" | "Deny")␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of an application rule.␊ - */␊ - export interface AzureFirewallApplicationRule7 {␊ - /**␊ - * Name of the application rule.␊ - */␊ - name?: string␊ - /**␊ - * Description of the rule.␊ - */␊ - description?: string␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * Array of ApplicationRuleProtocols.␊ - */␊ - protocols?: (AzureFirewallApplicationRuleProtocol7[] | string)␊ - /**␊ - * List of FQDNs for this rule.␊ - */␊ - targetFqdns?: (string[] | string)␊ - /**␊ - * List of FQDN Tags for this rule.␊ - */␊ - fqdnTags?: (string[] | string)␊ - /**␊ - * List of source IpGroups for this rule.␊ - */␊ - sourceIpGroups?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application rule protocol.␊ - */␊ - export interface AzureFirewallApplicationRuleProtocol7 {␊ - /**␊ - * Protocol type.␊ - */␊ - protocolType?: (("Http" | "Https" | "Mssql") | string)␊ - /**␊ - * Port number for the protocol, cannot be greater than 64000. This field is optional.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NAT rule collection resource.␊ - */␊ - export interface AzureFirewallNatRuleCollection4 {␊ - /**␊ - * Properties of the azure firewall NAT rule collection.␊ - */␊ - properties?: (AzureFirewallNatRuleCollectionProperties4 | string)␊ - /**␊ - * The name of the resource that is unique within the Azure firewall. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the NAT rule collection.␊ - */␊ - export interface AzureFirewallNatRuleCollectionProperties4 {␊ - /**␊ - * Priority of the NAT rule collection resource.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * The action type of a NAT rule collection.␊ - */␊ - action?: (AzureFirewallNatRCAction4 | string)␊ - /**␊ - * Collection of rules used by a NAT rule collection.␊ - */␊ - rules?: (AzureFirewallNatRule4[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AzureFirewall NAT Rule Collection Action.␊ - */␊ - export interface AzureFirewallNatRCAction4 {␊ - /**␊ - * The type of action.␊ - */␊ - type?: ("Snat" | "Dnat")␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a NAT rule.␊ - */␊ - export interface AzureFirewallNatRule4 {␊ - /**␊ - * Name of the NAT rule.␊ - */␊ - name?: string␊ - /**␊ - * Description of the rule.␊ - */␊ - description?: string␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags.␊ - */␊ - destinationAddresses?: (string[] | string)␊ - /**␊ - * List of destination ports.␊ - */␊ - destinationPorts?: (string[] | string)␊ - /**␊ - * Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule.␊ - */␊ - protocols?: (("TCP" | "UDP" | "Any" | "ICMP")[] | string)␊ - /**␊ - * The translated address for this NAT rule.␊ - */␊ - translatedAddress?: string␊ - /**␊ - * The translated port for this NAT rule.␊ - */␊ - translatedPort?: string␊ - /**␊ - * The translated FQDN for this NAT rule.␊ - */␊ - translatedFqdn?: string␊ - /**␊ - * List of source IpGroups for this rule.␊ - */␊ - sourceIpGroups?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network rule collection resource.␊ - */␊ - export interface AzureFirewallNetworkRuleCollection7 {␊ - /**␊ - * Properties of the azure firewall network rule collection.␊ - */␊ - properties?: (AzureFirewallNetworkRuleCollectionPropertiesFormat7 | string)␊ - /**␊ - * The name of the resource that is unique within the Azure firewall. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the network rule collection.␊ - */␊ - export interface AzureFirewallNetworkRuleCollectionPropertiesFormat7 {␊ - /**␊ - * Priority of the network rule collection resource.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * The action type of a rule collection.␊ - */␊ - action?: (AzureFirewallRCAction7 | string)␊ - /**␊ - * Collection of rules used by a network rule collection.␊ - */␊ - rules?: (AzureFirewallNetworkRule7[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the network rule.␊ - */␊ - export interface AzureFirewallNetworkRule7 {␊ - /**␊ - * Name of the network rule.␊ - */␊ - name?: string␊ - /**␊ - * Description of the rule.␊ - */␊ - description?: string␊ - /**␊ - * Array of AzureFirewallNetworkRuleProtocols.␊ - */␊ - protocols?: (("TCP" | "UDP" | "Any" | "ICMP")[] | string)␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * List of destination IP addresses.␊ - */␊ - destinationAddresses?: (string[] | string)␊ - /**␊ - * List of destination ports.␊ - */␊ - destinationPorts?: (string[] | string)␊ - /**␊ - * List of destination FQDNs.␊ - */␊ - destinationFqdns?: (string[] | string)␊ - /**␊ - * List of source IpGroups for this rule.␊ - */␊ - sourceIpGroups?: (string[] | string)␊ - /**␊ - * List of destination IpGroups for this rule.␊ - */␊ - destinationIpGroups?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration of an Azure Firewall.␊ - */␊ - export interface AzureFirewallIPConfiguration7 {␊ - /**␊ - * Properties of the azure firewall IP configuration.␊ - */␊ - properties?: (AzureFirewallIPConfigurationPropertiesFormat7 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration of an Azure Firewall.␊ - */␊ - export interface AzureFirewallIPConfigurationPropertiesFormat7 {␊ - /**␊ - * Reference of the subnet resource. This resource must be named 'AzureFirewallSubnet'.␊ - */␊ - subnet?: (SubResource27 | string)␊ - /**␊ - * Reference of the PublicIP resource. This field is a mandatory input if subnet is not null.␊ - */␊ - publicIPAddress?: (SubResource27 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of an Azure Firewall.␊ - */␊ - export interface AzureFirewallSku1 {␊ - /**␊ - * Name of an Azure Firewall SKU.␊ - */␊ - name?: (("AZFW_VNet" | "AZFW_Hub") | string)␊ - /**␊ - * Tier of an Azure Firewall.␊ - */␊ - tier?: ("Standard" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/bastionHosts␊ - */␊ - export interface BastionHosts4 {␊ - name: string␊ - type: "Microsoft.Network/bastionHosts"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Represents the bastion host resource.␊ - */␊ - properties: (BastionHostPropertiesFormat4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Bastion Host.␊ - */␊ - export interface BastionHostPropertiesFormat4 {␊ - /**␊ - * IP configuration of the Bastion Host resource.␊ - */␊ - ipConfigurations?: (BastionHostIPConfiguration4[] | string)␊ - /**␊ - * FQDN for the endpoint on which bastion host is accessible.␊ - */␊ - dnsName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration of an Bastion Host.␊ - */␊ - export interface BastionHostIPConfiguration4 {␊ - /**␊ - * Represents the ip configuration associated with the resource.␊ - */␊ - properties?: (BastionHostIPConfigurationPropertiesFormat4 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration of an Bastion Host.␊ - */␊ - export interface BastionHostIPConfigurationPropertiesFormat4 {␊ - /**␊ - * Reference of the subnet resource.␊ - */␊ - subnet: (SubResource27 | string)␊ - /**␊ - * Reference of the PublicIP resource.␊ - */␊ - publicIPAddress: (SubResource27 | string)␊ - /**␊ - * Private IP allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/connections␊ - */␊ - export interface Connections17 {␊ - name: string␊ - type: "Microsoft.Network/connections"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway connection.␊ - */␊ - properties: (VirtualNetworkGatewayConnectionPropertiesFormat17 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewayConnection properties.␊ - */␊ - export interface VirtualNetworkGatewayConnectionPropertiesFormat17 {␊ - /**␊ - * The authorizationKey.␊ - */␊ - authorizationKey?: string␊ - /**␊ - * The reference to virtual network gateway resource.␊ - */␊ - virtualNetworkGateway1: (SubResource27 | string)␊ - /**␊ - * The reference to virtual network gateway resource.␊ - */␊ - virtualNetworkGateway2?: (SubResource27 | string)␊ - /**␊ - * The reference to local network gateway resource.␊ - */␊ - localNetworkGateway2?: (SubResource27 | string)␊ - /**␊ - * Gateway connection type.␊ - */␊ - connectionType: (("IPsec" | "Vnet2Vnet" | "ExpressRoute" | "VPNClient") | string)␊ - /**␊ - * Connection protocol used for this connection.␊ - */␊ - connectionProtocol?: (("IKEv2" | "IKEv1") | string)␊ - /**␊ - * The routing weight.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * The IPSec shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The reference to peerings resource.␊ - */␊ - peer?: (SubResource27 | string)␊ - /**␊ - * EnableBgp flag.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * Enable policy-based traffic selectors.␊ - */␊ - usePolicyBasedTrafficSelectors?: (boolean | string)␊ - /**␊ - * The IPSec Policies to be considered by this connection.␊ - */␊ - ipsecPolicies?: (IpsecPolicy14[] | string)␊ - /**␊ - * The Traffic Selector Policies to be considered by this connection.␊ - */␊ - trafficSelectorPolicies?: (TrafficSelectorPolicy2[] | string)␊ - /**␊ - * Bypass ExpressRoute Gateway for data forwarding.␊ - */␊ - expressRouteGatewayBypass?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An IPSec Policy configuration for a virtual network gateway connection.␊ - */␊ - export interface IpsecPolicy14 {␊ - /**␊ - * The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.␊ - */␊ - saLifeTimeSeconds: (number | string)␊ - /**␊ - * The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.␊ - */␊ - saDataSizeKilobytes: (number | string)␊ - /**␊ - * The IPSec encryption algorithm (IKE phase 1).␊ - */␊ - ipsecEncryption: (("None" | "DES" | "DES3" | "AES128" | "AES192" | "AES256" | "GCMAES128" | "GCMAES192" | "GCMAES256") | string)␊ - /**␊ - * The IPSec integrity algorithm (IKE phase 1).␊ - */␊ - ipsecIntegrity: (("MD5" | "SHA1" | "SHA256" | "GCMAES128" | "GCMAES192" | "GCMAES256") | string)␊ - /**␊ - * The IKE encryption algorithm (IKE phase 2).␊ - */␊ - ikeEncryption: (("DES" | "DES3" | "AES128" | "AES192" | "AES256" | "GCMAES256" | "GCMAES128") | string)␊ - /**␊ - * The IKE integrity algorithm (IKE phase 2).␊ - */␊ - ikeIntegrity: (("MD5" | "SHA1" | "SHA256" | "SHA384" | "GCMAES256" | "GCMAES128") | string)␊ - /**␊ - * The DH Group used in IKE Phase 1 for initial SA.␊ - */␊ - dhGroup: (("None" | "DHGroup1" | "DHGroup2" | "DHGroup14" | "DHGroup2048" | "ECP256" | "ECP384" | "DHGroup24") | string)␊ - /**␊ - * The Pfs Group used in IKE Phase 2 for new child SA.␊ - */␊ - pfsGroup: (("None" | "PFS1" | "PFS2" | "PFS2048" | "ECP256" | "ECP384" | "PFS24" | "PFS14" | "PFSMM") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An traffic selector policy for a virtual network gateway connection.␊ - */␊ - export interface TrafficSelectorPolicy2 {␊ - /**␊ - * A collection of local address spaces in CIDR format␊ - */␊ - localAddressRanges: (string[] | string)␊ - /**␊ - * A collection of remote address spaces in CIDR format␊ - */␊ - remoteAddressRanges: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ddosCustomPolicies␊ - */␊ - export interface DdosCustomPolicies4 {␊ - name: string␊ - type: "Microsoft.Network/ddosCustomPolicies"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the DDoS custom policy.␊ - */␊ - properties: (DdosCustomPolicyPropertiesFormat4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DDoS custom policy properties.␊ - */␊ - export interface DdosCustomPolicyPropertiesFormat4 {␊ - /**␊ - * The protocol-specific DDoS policy customization parameters.␊ - */␊ - protocolCustomSettings?: (ProtocolCustomSettingsFormat4[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DDoS custom policy properties.␊ - */␊ - export interface ProtocolCustomSettingsFormat4 {␊ - /**␊ - * The protocol for which the DDoS protection policy is being customized.␊ - */␊ - protocol?: (("Tcp" | "Udp" | "Syn") | string)␊ - /**␊ - * The customized DDoS protection trigger rate.␊ - */␊ - triggerRateOverride?: string␊ - /**␊ - * The customized DDoS protection source rate.␊ - */␊ - sourceRateOverride?: string␊ - /**␊ - * The customized DDoS protection trigger rate sensitivity degrees. High: Trigger rate set with most sensitivity w.r.t. normal traffic. Default: Trigger rate set with moderate sensitivity w.r.t. normal traffic. Low: Trigger rate set with less sensitivity w.r.t. normal traffic. Relaxed: Trigger rate set with least sensitivity w.r.t. normal traffic.␊ - */␊ - triggerSensitivityOverride?: (("Relaxed" | "Low" | "Default" | "High") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ddosProtectionPlans␊ - */␊ - export interface DdosProtectionPlans12 {␊ - name: string␊ - type: "Microsoft.Network/ddosProtectionPlans"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the DDoS protection plan.␊ - */␊ - properties: (DdosProtectionPlanPropertiesFormat9 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DDoS protection plan properties.␊ - */␊ - export interface DdosProtectionPlanPropertiesFormat9 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits␊ - */␊ - export interface ExpressRouteCircuits14 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The SKU.␊ - */␊ - sku?: (ExpressRouteCircuitSku14 | string)␊ - /**␊ - * Properties of the express route circuit.␊ - */␊ - properties: (ExpressRouteCircuitPropertiesFormat14 | string)␊ - resources?: (ExpressRouteCircuitsPeeringsChildResource14 | ExpressRouteCircuitsAuthorizationsChildResource14)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains SKU in an ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitSku14 {␊ - /**␊ - * The name of the SKU.␊ - */␊ - name?: string␊ - /**␊ - * The tier of the SKU.␊ - */␊ - tier?: (("Standard" | "Premium" | "Basic" | "Local") | string)␊ - /**␊ - * The family of the SKU.␊ - */␊ - family?: (("UnlimitedData" | "MeteredData") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitPropertiesFormat14 {␊ - /**␊ - * Allow classic operations.␊ - */␊ - allowClassicOperations?: (boolean | string)␊ - /**␊ - * The list of authorizations.␊ - */␊ - authorizations?: (ExpressRouteCircuitAuthorization14[] | string)␊ - /**␊ - * The list of peerings.␊ - */␊ - peerings?: (ExpressRouteCircuitPeering14[] | string)␊ - /**␊ - * The ServiceProviderNotes.␊ - */␊ - serviceProviderNotes?: string␊ - /**␊ - * The ServiceProviderProperties.␊ - */␊ - serviceProviderProperties?: (ExpressRouteCircuitServiceProviderProperties14 | string)␊ - /**␊ - * The reference to the ExpressRoutePort resource when the circuit is provisioned on an ExpressRoutePort resource.␊ - */␊ - expressRoutePort?: (SubResource27 | string)␊ - /**␊ - * The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource.␊ - */␊ - bandwidthInGbps?: (number | string)␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authorization in an ExpressRouteCircuit resource.␊ - */␊ - export interface ExpressRouteCircuitAuthorization14 {␊ - /**␊ - * Properties of the express route circuit authorization.␊ - */␊ - properties?: (AuthorizationPropertiesFormat15 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ExpressRouteCircuitAuthorization.␊ - */␊ - export interface AuthorizationPropertiesFormat15 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peering in an ExpressRouteCircuit resource.␊ - */␊ - export interface ExpressRouteCircuitPeering14 {␊ - /**␊ - * Properties of the express route circuit peering.␊ - */␊ - properties?: (ExpressRouteCircuitPeeringPropertiesFormat15 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the express route circuit peering.␊ - */␊ - export interface ExpressRouteCircuitPeeringPropertiesFormat15 {␊ - /**␊ - * The peering type.␊ - */␊ - peeringType?: (("AzurePublicPeering" | "AzurePrivatePeering" | "MicrosoftPeering") | string)␊ - /**␊ - * The peering state.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * The peer ASN.␊ - */␊ - peerASN?: (number | string)␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The VLAN ID.␊ - */␊ - vlanId?: (number | string)␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig15 | string)␊ - /**␊ - * The peering stats of express route circuit.␊ - */␊ - stats?: (ExpressRouteCircuitStats15 | string)␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - /**␊ - * The reference of the RouteFilter resource.␊ - */␊ - routeFilter?: (SubResource27 | string)␊ - /**␊ - * The IPv6 peering configuration.␊ - */␊ - ipv6PeeringConfig?: (Ipv6ExpressRouteCircuitPeeringConfig12 | string)␊ - /**␊ - * The ExpressRoute connection.␊ - */␊ - expressRouteConnection?: (SubResource27 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the peering configuration.␊ - */␊ - export interface ExpressRouteCircuitPeeringConfig15 {␊ - /**␊ - * The reference of AdvertisedPublicPrefixes.␊ - */␊ - advertisedPublicPrefixes?: (string[] | string)␊ - /**␊ - * The communities of bgp peering. Specified for microsoft peering.␊ - */␊ - advertisedCommunities?: (string[] | string)␊ - /**␊ - * The legacy mode of the peering.␊ - */␊ - legacyMode?: (number | string)␊ - /**␊ - * The CustomerASN of the peering.␊ - */␊ - customerASN?: (number | string)␊ - /**␊ - * The RoutingRegistryName of the configuration.␊ - */␊ - routingRegistryName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains stats associated with the peering.␊ - */␊ - export interface ExpressRouteCircuitStats15 {␊ - /**␊ - * The Primary BytesIn of the peering.␊ - */␊ - primarybytesIn?: (number | string)␊ - /**␊ - * The primary BytesOut of the peering.␊ - */␊ - primarybytesOut?: (number | string)␊ - /**␊ - * The secondary BytesIn of the peering.␊ - */␊ - secondarybytesIn?: (number | string)␊ - /**␊ - * The secondary BytesOut of the peering.␊ - */␊ - secondarybytesOut?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains IPv6 peering config.␊ - */␊ - export interface Ipv6ExpressRouteCircuitPeeringConfig12 {␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig15 | string)␊ - /**␊ - * The reference of the RouteFilter resource.␊ - */␊ - routeFilter?: (SubResource27 | string)␊ - /**␊ - * The state of peering.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains ServiceProviderProperties in an ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitServiceProviderProperties14 {␊ - /**␊ - * The serviceProviderName.␊ - */␊ - serviceProviderName?: string␊ - /**␊ - * The peering location.␊ - */␊ - peeringLocation?: string␊ - /**␊ - * The BandwidthInMbps.␊ - */␊ - bandwidthInMbps?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings␊ - */␊ - export interface ExpressRouteCircuitsPeeringsChildResource14 {␊ - name: string␊ - type: "peerings"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Properties of the express route circuit peering.␊ - */␊ - properties: (ExpressRouteCircuitPeeringPropertiesFormat15 | string)␊ - resources?: ExpressRouteCircuitsPeeringsConnectionsChildResource12[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings/connections␊ - */␊ - export interface ExpressRouteCircuitsPeeringsConnectionsChildResource12 {␊ - name: string␊ - type: "connections"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Properties of the express route circuit connection.␊ - */␊ - properties: (ExpressRouteCircuitConnectionPropertiesFormat12 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the express route circuit connection.␊ - */␊ - export interface ExpressRouteCircuitConnectionPropertiesFormat12 {␊ - /**␊ - * Reference to Express Route Circuit Private Peering Resource of the circuit initiating connection.␊ - */␊ - expressRouteCircuitPeering?: (SubResource27 | string)␊ - /**␊ - * Reference to Express Route Circuit Private Peering Resource of the peered circuit.␊ - */␊ - peerExpressRouteCircuitPeering?: (SubResource27 | string)␊ - /**␊ - * /29 IP address space to carve out Customer addresses for tunnels.␊ - */␊ - addressPrefix?: string␊ - /**␊ - * The authorization key.␊ - */␊ - authorizationKey?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/authorizations␊ - */␊ - export interface ExpressRouteCircuitsAuthorizationsChildResource14 {␊ - name: string␊ - type: "authorizations"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Properties of the express route circuit authorization.␊ - */␊ - properties: (AuthorizationPropertiesFormat15 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/authorizations␊ - */␊ - export interface ExpressRouteCircuitsAuthorizations15 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/authorizations"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Properties of the express route circuit authorization.␊ - */␊ - properties: (AuthorizationPropertiesFormat15 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings␊ - */␊ - export interface ExpressRouteCircuitsPeerings14 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/peerings"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Properties of the express route circuit peering.␊ - */␊ - properties: (ExpressRouteCircuitPeeringPropertiesFormat15 | string)␊ - resources?: ExpressRouteCircuitsPeeringsConnectionsChildResource12[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings/connections␊ - */␊ - export interface ExpressRouteCircuitsPeeringsConnections12 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/peerings/connections"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Properties of the express route circuit connection.␊ - */␊ - properties: (ExpressRouteCircuitConnectionPropertiesFormat12 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections␊ - */␊ - export interface ExpressRouteCrossConnections12 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCrossConnections"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the express route cross connection.␊ - */␊ - properties: (ExpressRouteCrossConnectionProperties12 | string)␊ - resources?: ExpressRouteCrossConnectionsPeeringsChildResource12[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ExpressRouteCrossConnection.␊ - */␊ - export interface ExpressRouteCrossConnectionProperties12 {␊ - /**␊ - * The peering location of the ExpressRoute circuit.␊ - */␊ - peeringLocation?: string␊ - /**␊ - * The circuit bandwidth In Mbps.␊ - */␊ - bandwidthInMbps?: (number | string)␊ - /**␊ - * The ExpressRouteCircuit.␊ - */␊ - expressRouteCircuit?: (SubResource27 | string)␊ - /**␊ - * The provisioning state of the circuit in the connectivity provider system.␊ - */␊ - serviceProviderProvisioningState?: (("NotProvisioned" | "Provisioning" | "Provisioned" | "Deprovisioning") | string)␊ - /**␊ - * Additional read only notes set by the connectivity provider.␊ - */␊ - serviceProviderNotes?: string␊ - /**␊ - * The list of peerings.␊ - */␊ - peerings?: (ExpressRouteCrossConnectionPeering12[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peering in an ExpressRoute Cross Connection resource.␊ - */␊ - export interface ExpressRouteCrossConnectionPeering12 {␊ - /**␊ - * Properties of the express route cross connection peering.␊ - */␊ - properties?: (ExpressRouteCrossConnectionPeeringProperties12 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of express route cross connection peering.␊ - */␊ - export interface ExpressRouteCrossConnectionPeeringProperties12 {␊ - /**␊ - * The peering type.␊ - */␊ - peeringType?: (("AzurePublicPeering" | "AzurePrivatePeering" | "MicrosoftPeering") | string)␊ - /**␊ - * The peering state.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * The peer ASN.␊ - */␊ - peerASN?: (number | string)␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The VLAN ID.␊ - */␊ - vlanId?: (number | string)␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig15 | string)␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - /**␊ - * The IPv6 peering configuration.␊ - */␊ - ipv6PeeringConfig?: (Ipv6ExpressRouteCircuitPeeringConfig12 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections/peerings␊ - */␊ - export interface ExpressRouteCrossConnectionsPeeringsChildResource12 {␊ - name: string␊ - type: "peerings"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Properties of the express route cross connection peering.␊ - */␊ - properties: (ExpressRouteCrossConnectionPeeringProperties12 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections/peerings␊ - */␊ - export interface ExpressRouteCrossConnectionsPeerings11 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCrossConnections/peerings"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Properties of the express route cross connection peering.␊ - */␊ - properties: (ExpressRouteCrossConnectionPeeringProperties12 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteGateways␊ - */␊ - export interface ExpressRouteGateways4 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteGateways"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the express route gateway.␊ - */␊ - properties: (ExpressRouteGatewayProperties4 | string)␊ - resources?: ExpressRouteGatewaysExpressRouteConnectionsChildResource4[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ExpressRoute gateway resource properties.␊ - */␊ - export interface ExpressRouteGatewayProperties4 {␊ - /**␊ - * Configuration for auto scaling.␊ - */␊ - autoScaleConfiguration?: (ExpressRouteGatewayPropertiesAutoScaleConfiguration4 | string)␊ - /**␊ - * The Virtual Hub where the ExpressRoute gateway is or will be deployed.␊ - */␊ - virtualHub: (SubResource27 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Configuration for auto scaling.␊ - */␊ - export interface ExpressRouteGatewayPropertiesAutoScaleConfiguration4 {␊ - /**␊ - * Minimum and maximum number of scale units to deploy.␊ - */␊ - bounds?: (ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Minimum and maximum number of scale units to deploy.␊ - */␊ - export interface ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds4 {␊ - /**␊ - * Minimum number of scale units deployed for ExpressRoute gateway.␊ - */␊ - min?: (number | string)␊ - /**␊ - * Maximum number of scale units deployed for ExpressRoute gateway.␊ - */␊ - max?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteGateways/expressRouteConnections␊ - */␊ - export interface ExpressRouteGatewaysExpressRouteConnectionsChildResource4 {␊ - name: string␊ - type: "expressRouteConnections"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Properties of the express route connection.␊ - */␊ - properties: (ExpressRouteConnectionProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the ExpressRouteConnection subresource.␊ - */␊ - export interface ExpressRouteConnectionProperties4 {␊ - /**␊ - * The ExpressRoute circuit peering.␊ - */␊ - expressRouteCircuitPeering: (SubResource27 | string)␊ - /**␊ - * Authorization key to establish the connection.␊ - */␊ - authorizationKey?: string␊ - /**␊ - * The routing weight associated to the connection.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * Enable internet security.␊ - */␊ - enableInternetSecurity?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteGateways/expressRouteConnections␊ - */␊ - export interface ExpressRouteGatewaysExpressRouteConnections4 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteGateways/expressRouteConnections"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Properties of the express route connection.␊ - */␊ - properties: (ExpressRouteConnectionProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ExpressRoutePorts␊ - */␊ - export interface ExpressRoutePorts7 {␊ - name: string␊ - type: "Microsoft.Network/ExpressRoutePorts"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * ExpressRoutePort properties.␊ - */␊ - properties: (ExpressRoutePortPropertiesFormat7 | string)␊ - /**␊ - * The identity of ExpressRoutePort, if configured.␊ - */␊ - identity?: (ManagedServiceIdentity7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to ExpressRoutePort resources.␊ - */␊ - export interface ExpressRoutePortPropertiesFormat7 {␊ - /**␊ - * The name of the peering location that the ExpressRoutePort is mapped to physically.␊ - */␊ - peeringLocation?: string␊ - /**␊ - * Bandwidth of procured ports in Gbps.␊ - */␊ - bandwidthInGbps?: (number | string)␊ - /**␊ - * Encapsulation method on physical ports.␊ - */␊ - encapsulation?: (("Dot1Q" | "QinQ") | string)␊ - /**␊ - * The set of physical links of the ExpressRoutePort resource.␊ - */␊ - links?: (ExpressRouteLink7[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ExpressRouteLink child resource definition.␊ - */␊ - export interface ExpressRouteLink7 {␊ - /**␊ - * ExpressRouteLink properties.␊ - */␊ - properties?: (ExpressRouteLinkPropertiesFormat7 | string)␊ - /**␊ - * Name of child port resource that is unique among child port resources of the parent.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to ExpressRouteLink resources.␊ - */␊ - export interface ExpressRouteLinkPropertiesFormat7 {␊ - /**␊ - * Administrative state of the physical port.␊ - */␊ - adminState?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * MacSec configuration.␊ - */␊ - macSecConfig?: (ExpressRouteLinkMacSecConfig2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ExpressRouteLink Mac Security Configuration.␊ - */␊ - export interface ExpressRouteLinkMacSecConfig2 {␊ - /**␊ - * Keyvault Secret Identifier URL containing Mac security CKN key.␊ - */␊ - cknSecretIdentifier?: string␊ - /**␊ - * Keyvault Secret Identifier URL containing Mac security CAK key.␊ - */␊ - cakSecretIdentifier?: string␊ - /**␊ - * Mac security cipher.␊ - */␊ - cipher?: (("gcm-aes-128" | "gcm-aes-256") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/firewallPolicies␊ - */␊ - export interface FirewallPolicies3 {␊ - name: string␊ - type: "Microsoft.Network/firewallPolicies"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the firewall policy.␊ - */␊ - properties: (FirewallPolicyPropertiesFormat3 | string)␊ - resources?: FirewallPoliciesRuleGroupsChildResource3[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Firewall Policy definition.␊ - */␊ - export interface FirewallPolicyPropertiesFormat3 {␊ - /**␊ - * The parent firewall policy from which rules are inherited.␊ - */␊ - basePolicy?: (SubResource27 | string)␊ - /**␊ - * The operation mode for Threat Intelligence.␊ - */␊ - threatIntelMode?: (("Alert" | "Deny" | "Off") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/firewallPolicies/ruleGroups␊ - */␊ - export interface FirewallPoliciesRuleGroupsChildResource3 {␊ - name: string␊ - type: "ruleGroups"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * The properties of the firewall policy rule group.␊ - */␊ - properties: (FirewallPolicyRuleGroupProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the rule group.␊ - */␊ - export interface FirewallPolicyRuleGroupProperties3 {␊ - /**␊ - * Priority of the Firewall Policy Rule Group resource.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * Group of Firewall Policy rules.␊ - */␊ - rules?: (FirewallPolicyRule3[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the FirewallPolicyNatRuleAction.␊ - */␊ - export interface FirewallPolicyNatRuleAction3 {␊ - /**␊ - * The type of action.␊ - */␊ - type?: "DNAT"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application rule protocol.␊ - */␊ - export interface FirewallPolicyRuleConditionApplicationProtocol3 {␊ - /**␊ - * Protocol type.␊ - */␊ - protocolType?: (("Http" | "Https") | string)␊ - /**␊ - * Port number for the protocol, cannot be greater than 64000.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the FirewallPolicyFilterRuleAction.␊ - */␊ - export interface FirewallPolicyFilterRuleAction3 {␊ - /**␊ - * The type of action.␊ - */␊ - type?: ("Allow" | "Deny")␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/firewallPolicies/ruleGroups␊ - */␊ - export interface FirewallPoliciesRuleGroups3 {␊ - name: string␊ - type: "Microsoft.Network/firewallPolicies/ruleGroups"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * The properties of the firewall policy rule group.␊ - */␊ - properties: (FirewallPolicyRuleGroupProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ipGroups␊ - */␊ - export interface IpGroups {␊ - name: string␊ - type: "Microsoft.Network/ipGroups"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the IpGroups.␊ - */␊ - properties: (IpGroupPropertiesFormat | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The IpGroups property information.␊ - */␊ - export interface IpGroupPropertiesFormat {␊ - /**␊ - * IpAddresses/IpAddressPrefixes in the IpGroups resource.␊ - */␊ - ipAddresses?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers␊ - */␊ - export interface LoadBalancers29 {␊ - name: string␊ - type: "Microsoft.Network/loadBalancers"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The load balancer SKU.␊ - */␊ - sku?: (LoadBalancerSku17 | string)␊ - /**␊ - * Properties of load balancer.␊ - */␊ - properties: (LoadBalancerPropertiesFormat21 | string)␊ - resources?: LoadBalancersInboundNatRulesChildResource17[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a load balancer.␊ - */␊ - export interface LoadBalancerSku17 {␊ - /**␊ - * Name of a load balancer SKU.␊ - */␊ - name?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer.␊ - */␊ - export interface LoadBalancerPropertiesFormat21 {␊ - /**␊ - * Object representing the frontend IPs to be used for the load balancer.␊ - */␊ - frontendIPConfigurations?: (FrontendIPConfiguration20[] | string)␊ - /**␊ - * Collection of backend address pools used by a load balancer.␊ - */␊ - backendAddressPools?: (BackendAddressPool21[] | string)␊ - /**␊ - * Object collection representing the load balancing rules Gets the provisioning.␊ - */␊ - loadBalancingRules?: (LoadBalancingRule21[] | string)␊ - /**␊ - * Collection of probe objects used in the load balancer.␊ - */␊ - probes?: (Probe21[] | string)␊ - /**␊ - * Collection of inbound NAT Rules used by a load balancer. Defining inbound NAT rules on your load balancer is mutually exclusive with defining an inbound NAT pool. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an Inbound NAT pool. They have to reference individual inbound NAT rules.␊ - */␊ - inboundNatRules?: (InboundNatRule22[] | string)␊ - /**␊ - * Defines an external port range for inbound NAT to a single backend port on NICs associated with a load balancer. Inbound NAT rules are created automatically for each NIC associated with the Load Balancer using an external port from this range. Defining an Inbound NAT pool on your Load Balancer is mutually exclusive with defining inbound Nat rules. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an inbound NAT pool. They have to reference individual inbound NAT rules.␊ - */␊ - inboundNatPools?: (InboundNatPool22[] | string)␊ - /**␊ - * The outbound rules.␊ - */␊ - outboundRules?: (OutboundRule9[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP address of the load balancer.␊ - */␊ - export interface FrontendIPConfiguration20 {␊ - /**␊ - * Properties of the load balancer probe.␊ - */␊ - properties?: (FrontendIPConfigurationPropertiesFormat20 | string)␊ - /**␊ - * The name of the resource that is unique within the set of frontend IP configurations used by the load balancer. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP Configuration of the load balancer.␊ - */␊ - export interface FrontendIPConfigurationPropertiesFormat20 {␊ - /**␊ - * The private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The Private IP allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4.␊ - */␊ - privateIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The reference of the subnet resource.␊ - */␊ - subnet?: (SubResource27 | string)␊ - /**␊ - * The reference of the Public IP resource.␊ - */␊ - publicIPAddress?: (SubResource27 | string)␊ - /**␊ - * The reference of the Public IP Prefix resource.␊ - */␊ - publicIPPrefix?: (SubResource27 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Pool of backend IP addresses.␊ - */␊ - export interface BackendAddressPool21 {␊ - /**␊ - * Properties of load balancer backend address pool.␊ - */␊ - properties?: (BackendAddressPoolPropertiesFormat21 | string)␊ - /**␊ - * The name of the resource that is unique within the set of backend address pools used by the load balancer. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the backend address pool.␊ - */␊ - export interface BackendAddressPoolPropertiesFormat21 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A load balancing rule for a load balancer.␊ - */␊ - export interface LoadBalancingRule21 {␊ - /**␊ - * Properties of load balancer load balancing rule.␊ - */␊ - properties?: (LoadBalancingRulePropertiesFormat21 | string)␊ - /**␊ - * The name of the resource that is unique within the set of load balancing rules used by the load balancer. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer.␊ - */␊ - export interface LoadBalancingRulePropertiesFormat21 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource27 | string)␊ - /**␊ - * A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs.␊ - */␊ - backendAddressPool?: (SubResource27 | string)␊ - /**␊ - * The reference of the load balancer probe used by the load balancing rule.␊ - */␊ - probe?: (SubResource27 | string)␊ - /**␊ - * The reference to the transport protocol used by the load balancing rule.␊ - */␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The load distribution policy for this rule.␊ - */␊ - loadDistribution?: (("Default" | "SourceIP" | "SourceIPProtocol") | string)␊ - /**␊ - * The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 0 and 65534. Note that value 0 enables "Any Port".␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port".␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - /**␊ - * Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule.␊ - */␊ - disableOutboundSnat?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A load balancer probe.␊ - */␊ - export interface Probe21 {␊ - /**␊ - * Properties of load balancer probe.␊ - */␊ - properties?: (ProbePropertiesFormat21 | string)␊ - /**␊ - * The name of the resource that is unique within the set of probes used by the load balancer. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Load balancer probe resource.␊ - */␊ - export interface ProbePropertiesFormat21 {␊ - /**␊ - * The protocol of the end point. If 'Tcp' is specified, a received ACK is required for the probe to be successful. If 'Http' or 'Https' is specified, a 200 OK response from the specifies URI is required for the probe to be successful.␊ - */␊ - protocol: (("Http" | "Tcp" | "Https") | string)␊ - /**␊ - * The port for communicating the probe. Possible values range from 1 to 65535, inclusive.␊ - */␊ - port: (number | string)␊ - /**␊ - * The interval, in seconds, for how frequently to probe the endpoint for health status. Typically, the interval is slightly less than half the allocated timeout period (in seconds) which allows two full probes before taking the instance out of rotation. The default value is 15, the minimum value is 5.␊ - */␊ - intervalInSeconds?: (number | string)␊ - /**␊ - * The number of probes where if no response, will result in stopping further traffic from being delivered to the endpoint. This values allows endpoints to be taken out of rotation faster or slower than the typical times used in Azure.␊ - */␊ - numberOfProbes: (number | string)␊ - /**␊ - * The URI used for requesting health status from the VM. Path is required if a protocol is set to http. Otherwise, it is not allowed. There is no default value.␊ - */␊ - requestPath?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT rule of the load balancer.␊ - */␊ - export interface InboundNatRule22 {␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties?: (InboundNatRulePropertiesFormat21 | string)␊ - /**␊ - * The name of the resource that is unique within the set of inbound NAT rules used by the load balancer. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the inbound NAT rule.␊ - */␊ - export interface InboundNatRulePropertiesFormat21 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource27 | string)␊ - /**␊ - * The reference to the transport protocol used by the load balancing rule.␊ - */␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values range from 1 to 65534.␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * The port used for the internal endpoint. Acceptable values range from 1 to 65535.␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT pool of the load balancer.␊ - */␊ - export interface InboundNatPool22 {␊ - /**␊ - * Properties of load balancer inbound nat pool.␊ - */␊ - properties?: (InboundNatPoolPropertiesFormat21 | string)␊ - /**␊ - * The name of the resource that is unique within the set of inbound NAT pools used by the load balancer. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Inbound NAT pool.␊ - */␊ - export interface InboundNatPoolPropertiesFormat21 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource27 | string)␊ - /**␊ - * The reference to the transport protocol used by the inbound NAT pool.␊ - */␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65534.␊ - */␊ - frontendPortRangeStart: (number | string)␊ - /**␊ - * The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65535.␊ - */␊ - frontendPortRangeEnd: (number | string)␊ - /**␊ - * The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound rule of the load balancer.␊ - */␊ - export interface OutboundRule9 {␊ - /**␊ - * Properties of load balancer outbound rule.␊ - */␊ - properties?: (OutboundRulePropertiesFormat9 | string)␊ - /**␊ - * The name of the resource that is unique within the set of outbound rules used by the load balancer. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound rule of the load balancer.␊ - */␊ - export interface OutboundRulePropertiesFormat9 {␊ - /**␊ - * The number of outbound ports to be used for NAT.␊ - */␊ - allocatedOutboundPorts?: (number | string)␊ - /**␊ - * The Frontend IP addresses of the load balancer.␊ - */␊ - frontendIPConfigurations: (SubResource27[] | string)␊ - /**␊ - * A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs.␊ - */␊ - backendAddressPool: (SubResource27 | string)␊ - /**␊ - * The protocol for the outbound rule in load balancer.␊ - */␊ - protocol: (("Tcp" | "Udp" | "All") | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - /**␊ - * The timeout for the TCP idle connection.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers/inboundNatRules␊ - */␊ - export interface LoadBalancersInboundNatRulesChildResource17 {␊ - name: string␊ - type: "inboundNatRules"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties: (InboundNatRulePropertiesFormat21 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers/inboundNatRules␊ - */␊ - export interface LoadBalancersInboundNatRules16 {␊ - name: string␊ - type: "Microsoft.Network/loadBalancers/inboundNatRules"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties: (InboundNatRulePropertiesFormat21 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/localNetworkGateways␊ - */␊ - export interface LocalNetworkGateways17 {␊ - name: string␊ - type: "Microsoft.Network/localNetworkGateways"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the local network gateway.␊ - */␊ - properties: (LocalNetworkGatewayPropertiesFormat17 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * LocalNetworkGateway properties.␊ - */␊ - export interface LocalNetworkGatewayPropertiesFormat17 {␊ - /**␊ - * Local network site address space.␊ - */␊ - localNetworkAddressSpace?: (AddressSpace29 | string)␊ - /**␊ - * IP address of local network gateway.␊ - */␊ - gatewayIpAddress?: string␊ - /**␊ - * Local network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings16 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.␊ - */␊ - export interface AddressSpace29 {␊ - /**␊ - * A list of address blocks reserved for this virtual network in CIDR notation.␊ - */␊ - addressPrefixes: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * BGP settings details.␊ - */␊ - export interface BgpSettings16 {␊ - /**␊ - * The BGP speaker's ASN.␊ - */␊ - asn?: (number | string)␊ - /**␊ - * The BGP peering address and BGP identifier of this BGP speaker.␊ - */␊ - bgpPeeringAddress?: string␊ - /**␊ - * The weight added to routes learned from this BGP speaker.␊ - */␊ - peerWeight?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/natGateways␊ - */␊ - export interface NatGateways4 {␊ - name: string␊ - type: "Microsoft.Network/natGateways"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The nat gateway SKU.␊ - */␊ - sku?: (NatGatewaySku4 | string)␊ - /**␊ - * Nat Gateway properties.␊ - */␊ - properties: (NatGatewayPropertiesFormat4 | string)␊ - /**␊ - * A list of availability zones denoting the zone in which Nat Gateway should be deployed.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of nat gateway.␊ - */␊ - export interface NatGatewaySku4 {␊ - /**␊ - * Name of Nat Gateway SKU.␊ - */␊ - name?: ("Standard" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Nat Gateway properties.␊ - */␊ - export interface NatGatewayPropertiesFormat4 {␊ - /**␊ - * The idle timeout of the nat gateway.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * An array of public ip addresses associated with the nat gateway resource.␊ - */␊ - publicIpAddresses?: (SubResource27[] | string)␊ - /**␊ - * An array of public ip prefixes associated with the nat gateway resource.␊ - */␊ - publicIpPrefixes?: (SubResource27[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces␊ - */␊ - export interface NetworkInterfaces30 {␊ - name: string␊ - type: "Microsoft.Network/networkInterfaces"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network interface.␊ - */␊ - properties: (NetworkInterfacePropertiesFormat21 | string)␊ - resources?: NetworkInterfacesTapConfigurationsChildResource8[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NetworkInterface properties.␊ - */␊ - export interface NetworkInterfacePropertiesFormat21 {␊ - /**␊ - * The reference of the NetworkSecurityGroup resource.␊ - */␊ - networkSecurityGroup?: (SubResource27 | string)␊ - /**␊ - * A list of IPConfigurations of the network interface.␊ - */␊ - ipConfigurations: (NetworkInterfaceIPConfiguration20[] | string)␊ - /**␊ - * The DNS settings in network interface.␊ - */␊ - dnsSettings?: (NetworkInterfaceDnsSettings29 | string)␊ - /**␊ - * If the network interface is accelerated networking enabled.␊ - */␊ - enableAcceleratedNetworking?: (boolean | string)␊ - /**␊ - * Indicates whether IP forwarding is enabled on this network interface.␊ - */␊ - enableIPForwarding?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IPConfiguration in a network interface.␊ - */␊ - export interface NetworkInterfaceIPConfiguration20 {␊ - /**␊ - * Network interface IP configuration properties.␊ - */␊ - properties?: (NetworkInterfaceIPConfigurationPropertiesFormat20 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration.␊ - */␊ - export interface NetworkInterfaceIPConfigurationPropertiesFormat20 {␊ - /**␊ - * The reference to Virtual Network Taps.␊ - */␊ - virtualNetworkTaps?: (SubResource27[] | string)␊ - /**␊ - * The reference of ApplicationGatewayBackendAddressPool resource.␊ - */␊ - applicationGatewayBackendAddressPools?: (SubResource27[] | string)␊ - /**␊ - * The reference of LoadBalancerBackendAddressPool resource.␊ - */␊ - loadBalancerBackendAddressPools?: (SubResource27[] | string)␊ - /**␊ - * A list of references of LoadBalancerInboundNatRules.␊ - */␊ - loadBalancerInboundNatRules?: (SubResource27[] | string)␊ - /**␊ - * Private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The private IP address allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4.␊ - */␊ - privateIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * Subnet bound to the IP configuration.␊ - */␊ - subnet?: (SubResource27 | string)␊ - /**␊ - * Whether this is a primary customer address on the network interface.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * Public IP address bound to the IP configuration.␊ - */␊ - publicIPAddress?: (SubResource27 | string)␊ - /**␊ - * Application security groups in which the IP configuration is included.␊ - */␊ - applicationSecurityGroups?: (SubResource27[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DNS settings of a network interface.␊ - */␊ - export interface NetworkInterfaceDnsSettings29 {␊ - /**␊ - * List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only value in dnsServers collection.␊ - */␊ - dnsServers?: (string[] | string)␊ - /**␊ - * Relative DNS name for this NIC used for internal communications between VMs in the same virtual network.␊ - */␊ - internalDnsNameLabel?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces/tapConfigurations␊ - */␊ - export interface NetworkInterfacesTapConfigurationsChildResource8 {␊ - name: string␊ - type: "tapConfigurations"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Properties of the Virtual Network Tap configuration.␊ - */␊ - properties: (NetworkInterfaceTapConfigurationPropertiesFormat8 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Virtual Network Tap configuration.␊ - */␊ - export interface NetworkInterfaceTapConfigurationPropertiesFormat8 {␊ - /**␊ - * The reference of the Virtual Network Tap resource.␊ - */␊ - virtualNetworkTap?: (SubResource27 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces/tapConfigurations␊ - */␊ - export interface NetworkInterfacesTapConfigurations7 {␊ - name: string␊ - type: "Microsoft.Network/networkInterfaces/tapConfigurations"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Properties of the Virtual Network Tap configuration.␊ - */␊ - properties: (NetworkInterfaceTapConfigurationPropertiesFormat8 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkProfiles␊ - */␊ - export interface NetworkProfiles4 {␊ - name: string␊ - type: "Microsoft.Network/networkProfiles"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Network profile properties.␊ - */␊ - properties: (NetworkProfilePropertiesFormat4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network profile properties.␊ - */␊ - export interface NetworkProfilePropertiesFormat4 {␊ - /**␊ - * List of chid container network interface configurations.␊ - */␊ - containerNetworkInterfaceConfigurations?: (ContainerNetworkInterfaceConfiguration4[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Container network interface configuration child resource.␊ - */␊ - export interface ContainerNetworkInterfaceConfiguration4 {␊ - /**␊ - * Container network interface configuration properties.␊ - */␊ - properties?: (ContainerNetworkInterfaceConfigurationPropertiesFormat4 | string)␊ - /**␊ - * The name of the resource. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Container network interface configuration properties.␊ - */␊ - export interface ContainerNetworkInterfaceConfigurationPropertiesFormat4 {␊ - /**␊ - * A list of ip configurations of the container network interface configuration.␊ - */␊ - ipConfigurations?: (IPConfigurationProfile4[] | string)␊ - /**␊ - * A list of container network interfaces created from this container network interface configuration.␊ - */␊ - containerNetworkInterfaces?: (SubResource27[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration profile child resource.␊ - */␊ - export interface IPConfigurationProfile4 {␊ - /**␊ - * Properties of the IP configuration profile.␊ - */␊ - properties?: (IPConfigurationProfilePropertiesFormat4 | string)␊ - /**␊ - * The name of the resource. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration profile properties.␊ - */␊ - export interface IPConfigurationProfilePropertiesFormat4 {␊ - /**␊ - * The reference of the subnet resource to create a container network interface ip configuration.␊ - */␊ - subnet?: (SubResource27 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups␊ - */␊ - export interface NetworkSecurityGroups29 {␊ - name: string␊ - type: "Microsoft.Network/networkSecurityGroups"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network security group.␊ - */␊ - properties: (NetworkSecurityGroupPropertiesFormat21 | string)␊ - resources?: NetworkSecurityGroupsSecurityRulesChildResource21[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network Security Group resource.␊ - */␊ - export interface NetworkSecurityGroupPropertiesFormat21 {␊ - /**␊ - * A collection of security rules of the network security group.␊ - */␊ - securityRules?: (SecurityRule21[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network security rule.␊ - */␊ - export interface SecurityRule21 {␊ - /**␊ - * Properties of the security rule.␊ - */␊ - properties?: (SecurityRulePropertiesFormat21 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Security rule resource.␊ - */␊ - export interface SecurityRulePropertiesFormat21 {␊ - /**␊ - * A description for this rule. Restricted to 140 chars.␊ - */␊ - description?: string␊ - /**␊ - * Network protocol this rule applies to.␊ - */␊ - protocol: (("Tcp" | "Udp" | "Icmp" | "Esp" | "*" | "Ah") | string)␊ - /**␊ - * The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.␊ - */␊ - sourcePortRange?: string␊ - /**␊ - * The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.␊ - */␊ - destinationPortRange?: string␊ - /**␊ - * The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from.␊ - */␊ - sourceAddressPrefix?: string␊ - /**␊ - * The CIDR or source IP ranges.␊ - */␊ - sourceAddressPrefixes?: (string[] | string)␊ - /**␊ - * The application security group specified as source.␊ - */␊ - sourceApplicationSecurityGroups?: (SubResource27[] | string)␊ - /**␊ - * The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used.␊ - */␊ - destinationAddressPrefix?: string␊ - /**␊ - * The destination address prefixes. CIDR or destination IP ranges.␊ - */␊ - destinationAddressPrefixes?: (string[] | string)␊ - /**␊ - * The application security group specified as destination.␊ - */␊ - destinationApplicationSecurityGroups?: (SubResource27[] | string)␊ - /**␊ - * The source port ranges.␊ - */␊ - sourcePortRanges?: (string[] | string)␊ - /**␊ - * The destination port ranges.␊ - */␊ - destinationPortRanges?: (string[] | string)␊ - /**␊ - * The network traffic is allowed or denied.␊ - */␊ - access: (("Allow" | "Deny") | string)␊ - /**␊ - * The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.␊ - */␊ - priority: (number | string)␊ - /**␊ - * The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic.␊ - */␊ - direction: (("Inbound" | "Outbound") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRulesChildResource21 {␊ - name: string␊ - type: "securityRules"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Properties of the security rule.␊ - */␊ - properties: (SecurityRulePropertiesFormat21 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRules20 {␊ - name: string␊ - type: "Microsoft.Network/networkSecurityGroups/securityRules"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Properties of the security rule.␊ - */␊ - properties: (SecurityRulePropertiesFormat21 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers␊ - */␊ - export interface NetworkWatchers7 {␊ - name: string␊ - type: "Microsoft.Network/networkWatchers"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network watcher.␊ - */␊ - properties: (NetworkWatcherPropertiesFormat4 | string)␊ - resources?: NetworkWatchersPacketCapturesChildResource7[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The network watcher properties.␊ - */␊ - export interface NetworkWatcherPropertiesFormat4 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/packetCaptures␊ - */␊ - export interface NetworkWatchersPacketCapturesChildResource7 {␊ - name: string␊ - type: "packetCaptures"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Properties of the packet capture.␊ - */␊ - properties: (PacketCaptureParameters7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters that define the create packet capture operation.␊ - */␊ - export interface PacketCaptureParameters7 {␊ - /**␊ - * The ID of the targeted resource, only VM is currently supported.␊ - */␊ - target: string␊ - /**␊ - * Number of bytes captured per packet, the remaining bytes are truncated.␊ - */␊ - bytesToCapturePerPacket?: ((number & string) | string)␊ - /**␊ - * Maximum size of the capture output.␊ - */␊ - totalBytesPerSession?: ((number & string) | string)␊ - /**␊ - * Maximum duration of the capture session in seconds.␊ - */␊ - timeLimitInSeconds?: ((number & string) | string)␊ - /**␊ - * Describes the storage location for a packet capture session.␊ - */␊ - storageLocation: (PacketCaptureStorageLocation7 | string)␊ - /**␊ - * A list of packet capture filters.␊ - */␊ - filters?: (PacketCaptureFilter7[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the storage location for a packet capture session.␊ - */␊ - export interface PacketCaptureStorageLocation7 {␊ - /**␊ - * The ID of the storage account to save the packet capture session. Required if no local file path is provided.␊ - */␊ - storageId?: string␊ - /**␊ - * The URI of the storage path to save the packet capture. Must be a well-formed URI describing the location to save the packet capture.␊ - */␊ - storagePath?: string␊ - /**␊ - * A valid local path on the targeting VM. Must include the name of the capture file (*.cap). For linux virtual machine it must start with /var/captures. Required if no storage ID is provided, otherwise optional.␊ - */␊ - filePath?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Filter that is applied to packet capture request. Multiple filters can be applied.␊ - */␊ - export interface PacketCaptureFilter7 {␊ - /**␊ - * Protocol to be filtered on.␊ - */␊ - protocol?: (("TCP" | "UDP" | "Any") | string)␊ - /**␊ - * Local IP Address to be filtered on. Notation: "127.0.0.1" for single address entry. "127.0.0.1-127.0.0.255" for range. "127.0.0.1;127.0.0.5"? for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.␊ - */␊ - localIPAddress?: string␊ - /**␊ - * Local IP Address to be filtered on. Notation: "127.0.0.1" for single address entry. "127.0.0.1-127.0.0.255" for range. "127.0.0.1;127.0.0.5;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.␊ - */␊ - remoteIPAddress?: string␊ - /**␊ - * Local port to be filtered on. Notation: "80" for single port entry."80-85" for range. "80;443;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.␊ - */␊ - localPort?: string␊ - /**␊ - * Remote port to be filtered on. Notation: "80" for single port entry."80-85" for range. "80;443;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.␊ - */␊ - remotePort?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/packetCaptures␊ - */␊ - export interface NetworkWatchersPacketCaptures7 {␊ - name: string␊ - type: "Microsoft.Network/networkWatchers/packetCaptures"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Properties of the packet capture.␊ - */␊ - properties: (PacketCaptureParameters7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/p2svpnGateways␊ - */␊ - export interface P2SvpnGateways4 {␊ - name: string␊ - type: "Microsoft.Network/p2svpnGateways"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the P2SVpnGateway.␊ - */␊ - properties: (P2SVpnGatewayProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for P2SVpnGateway.␊ - */␊ - export interface P2SVpnGatewayProperties4 {␊ - /**␊ - * The VirtualHub to which the gateway belongs.␊ - */␊ - virtualHub?: (SubResource27 | string)␊ - /**␊ - * List of all p2s connection configurations of the gateway.␊ - */␊ - p2SConnectionConfigurations?: (P2SConnectionConfiguration1[] | string)␊ - /**␊ - * The scale unit for this p2s vpn gateway.␊ - */␊ - vpnGatewayScaleUnit?: (number | string)␊ - /**␊ - * The VpnServerConfiguration to which the p2sVpnGateway is attached to.␊ - */␊ - vpnServerConfiguration?: (SubResource27 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * P2SConnectionConfiguration Resource.␊ - */␊ - export interface P2SConnectionConfiguration1 {␊ - /**␊ - * Properties of the P2S connection configuration.␊ - */␊ - properties?: (P2SConnectionConfigurationProperties1 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for P2SConnectionConfiguration.␊ - */␊ - export interface P2SConnectionConfigurationProperties1 {␊ - /**␊ - * The reference of the address space resource which represents Address space for P2S VpnClient.␊ - */␊ - vpnClientAddressPool?: (AddressSpace29 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateEndpoints␊ - */␊ - export interface PrivateEndpoints4 {␊ - name: string␊ - type: "Microsoft.Network/privateEndpoints"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the private endpoint.␊ - */␊ - properties: (PrivateEndpointProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the private endpoint.␊ - */␊ - export interface PrivateEndpointProperties4 {␊ - /**␊ - * The ID of the subnet from which the private IP will be allocated.␊ - */␊ - subnet?: (SubResource27 | string)␊ - /**␊ - * A grouping of information about the connection to the remote resource.␊ - */␊ - privateLinkServiceConnections?: (PrivateLinkServiceConnection4[] | string)␊ - /**␊ - * A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource.␊ - */␊ - manualPrivateLinkServiceConnections?: (PrivateLinkServiceConnection4[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * PrivateLinkServiceConnection resource.␊ - */␊ - export interface PrivateLinkServiceConnection4 {␊ - /**␊ - * Properties of the private link service connection.␊ - */␊ - properties?: (PrivateLinkServiceConnectionProperties4 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the PrivateLinkServiceConnection.␊ - */␊ - export interface PrivateLinkServiceConnectionProperties4 {␊ - /**␊ - * The resource id of private link service.␊ - */␊ - privateLinkServiceId?: string␊ - /**␊ - * The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to.␊ - */␊ - groupIds?: (string[] | string)␊ - /**␊ - * A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars.␊ - */␊ - requestMessage?: string␊ - /**␊ - * A collection of read-only information about the state of the connection to the remote resource.␊ - */␊ - privateLinkServiceConnectionState?: (PrivateLinkServiceConnectionState10 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A collection of information about the state of the connection between service consumer and provider.␊ - */␊ - export interface PrivateLinkServiceConnectionState10 {␊ - /**␊ - * Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.␊ - */␊ - status?: string␊ - /**␊ - * The reason for approval/rejection of the connection.␊ - */␊ - description?: string␊ - /**␊ - * A message indicating if changes on the service provider require any updates on the consumer.␊ - */␊ - actionRequired?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateLinkServices␊ - */␊ - export interface PrivateLinkServices4 {␊ - name: string␊ - type: "Microsoft.Network/privateLinkServices"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the private link service.␊ - */␊ - properties: (PrivateLinkServiceProperties4 | string)␊ - resources?: PrivateLinkServicesPrivateEndpointConnectionsChildResource4[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the private link service.␊ - */␊ - export interface PrivateLinkServiceProperties4 {␊ - /**␊ - * An array of references to the load balancer IP configurations.␊ - */␊ - loadBalancerFrontendIpConfigurations?: (SubResource27[] | string)␊ - /**␊ - * An array of private link service IP configurations.␊ - */␊ - ipConfigurations?: (PrivateLinkServiceIpConfiguration4[] | string)␊ - /**␊ - * The visibility list of the private link service.␊ - */␊ - visibility?: (PrivateLinkServicePropertiesVisibility4 | string)␊ - /**␊ - * The auto-approval list of the private link service.␊ - */␊ - autoApproval?: (PrivateLinkServicePropertiesAutoApproval4 | string)␊ - /**␊ - * The list of Fqdn.␊ - */␊ - fqdns?: (string[] | string)␊ - /**␊ - * Whether the private link service is enabled for proxy protocol or not.␊ - */␊ - enableProxyProtocol?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The private link service ip configuration.␊ - */␊ - export interface PrivateLinkServiceIpConfiguration4 {␊ - /**␊ - * Properties of the private link service ip configuration.␊ - */␊ - properties?: (PrivateLinkServiceIpConfigurationProperties4 | string)␊ - /**␊ - * The name of private link service ip configuration.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of private link service IP configuration.␊ - */␊ - export interface PrivateLinkServiceIpConfigurationProperties4 {␊ - /**␊ - * The private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The private IP address allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * The reference to the subnet resource.␊ - */␊ - subnet?: (SubResource27 | string)␊ - /**␊ - * Whether the ip configuration is primary or not.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4.␊ - */␊ - privateIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The visibility list of the private link service.␊ - */␊ - export interface PrivateLinkServicePropertiesVisibility4 {␊ - /**␊ - * The list of subscriptions.␊ - */␊ - subscriptions?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The auto-approval list of the private link service.␊ - */␊ - export interface PrivateLinkServicePropertiesAutoApproval4 {␊ - /**␊ - * The list of subscriptions.␊ - */␊ - subscriptions?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateLinkServices/privateEndpointConnections␊ - */␊ - export interface PrivateLinkServicesPrivateEndpointConnectionsChildResource4 {␊ - name: string␊ - type: "privateEndpointConnections"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Properties of the private end point connection.␊ - */␊ - properties: (PrivateEndpointConnectionProperties11 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the PrivateEndpointConnectProperties.␊ - */␊ - export interface PrivateEndpointConnectionProperties11 {␊ - /**␊ - * A collection of information about the state of the connection between service consumer and provider.␊ - */␊ - privateLinkServiceConnectionState?: (PrivateLinkServiceConnectionState10 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateLinkServices/privateEndpointConnections␊ - */␊ - export interface PrivateLinkServicesPrivateEndpointConnections4 {␊ - name: string␊ - type: "Microsoft.Network/privateLinkServices/privateEndpointConnections"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Properties of the private end point connection.␊ - */␊ - properties: (PrivateEndpointConnectionProperties11 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/publicIPAddresses␊ - */␊ - export interface PublicIPAddresses29 {␊ - name: string␊ - type: "Microsoft.Network/publicIPAddresses"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The public IP address SKU.␊ - */␊ - sku?: (PublicIPAddressSku17 | string)␊ - /**␊ - * Public IP address properties.␊ - */␊ - properties: (PublicIPAddressPropertiesFormat20 | string)␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a public IP address.␊ - */␊ - export interface PublicIPAddressSku17 {␊ - /**␊ - * Name of a public IP address SKU.␊ - */␊ - name?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Public IP address properties.␊ - */␊ - export interface PublicIPAddressPropertiesFormat20 {␊ - /**␊ - * The public IP address allocation method.␊ - */␊ - publicIPAllocationMethod: (("Static" | "Dynamic") | string)␊ - /**␊ - * The public IP address version.␊ - */␊ - publicIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The FQDN of the DNS record associated with the public IP address.␊ - */␊ - dnsSettings?: (PublicIPAddressDnsSettings28 | string)␊ - /**␊ - * The DDoS protection custom policy associated with the public IP address.␊ - */␊ - ddosSettings?: (DdosSettings6 | string)␊ - /**␊ - * The list of tags associated with the public IP address.␊ - */␊ - ipTags?: (IpTag14[] | string)␊ - /**␊ - * The IP address associated with the public IP address resource.␊ - */␊ - ipAddress?: string␊ - /**␊ - * The Public IP Prefix this Public IP Address should be allocated from.␊ - */␊ - publicIPPrefix?: (SubResource27 | string)␊ - /**␊ - * The idle timeout of the public IP address.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains FQDN of the DNS record associated with the public IP address.␊ - */␊ - export interface PublicIPAddressDnsSettings28 {␊ - /**␊ - * The domain name label. The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.␊ - */␊ - domainNameLabel: string␊ - /**␊ - * The Fully Qualified Domain Name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone.␊ - */␊ - fqdn?: string␊ - /**␊ - * The reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN.␊ - */␊ - reverseFqdn?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains the DDoS protection settings of the public IP.␊ - */␊ - export interface DdosSettings6 {␊ - /**␊ - * The DDoS custom policy associated with the public IP.␊ - */␊ - ddosCustomPolicy?: (SubResource27 | string)␊ - /**␊ - * The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized.␊ - */␊ - protectionCoverage?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains the IpTag associated with the object.␊ - */␊ - export interface IpTag14 {␊ - /**␊ - * The IP tag type. Example: FirstPartyUsage.␊ - */␊ - ipTagType?: string␊ - /**␊ - * The value of the IP tag associated with the public IP. Example: SQL.␊ - */␊ - tag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/publicIPPrefixes␊ - */␊ - export interface PublicIPPrefixes5 {␊ - name: string␊ - type: "Microsoft.Network/publicIPPrefixes"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The public IP prefix SKU.␊ - */␊ - sku?: (PublicIPPrefixSku5 | string)␊ - /**␊ - * Public IP prefix properties.␊ - */␊ - properties: (PublicIPPrefixPropertiesFormat5 | string)␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a public IP prefix.␊ - */␊ - export interface PublicIPPrefixSku5 {␊ - /**␊ - * Name of a public IP prefix SKU.␊ - */␊ - name?: ("Standard" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Public IP prefix properties.␊ - */␊ - export interface PublicIPPrefixPropertiesFormat5 {␊ - /**␊ - * The public IP address version.␊ - */␊ - publicIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The list of tags associated with the public IP prefix.␊ - */␊ - ipTags?: (IpTag14[] | string)␊ - /**␊ - * The Length of the Public IP Prefix.␊ - */␊ - prefixLength?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeFilters␊ - */␊ - export interface RouteFilters7 {␊ - name: string␊ - type: "Microsoft.Network/routeFilters"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the route filter.␊ - */␊ - properties: (RouteFilterPropertiesFormat7 | string)␊ - resources?: RouteFiltersRouteFilterRulesChildResource7[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Filter Resource.␊ - */␊ - export interface RouteFilterPropertiesFormat7 {␊ - /**␊ - * Collection of RouteFilterRules contained within a route filter.␊ - */␊ - rules?: (RouteFilterRule7[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Filter Rule Resource.␊ - */␊ - export interface RouteFilterRule7 {␊ - /**␊ - * Properties of the route filter rule.␊ - */␊ - properties?: (RouteFilterRulePropertiesFormat7 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Filter Rule Resource.␊ - */␊ - export interface RouteFilterRulePropertiesFormat7 {␊ - /**␊ - * The access type of the rule.␊ - */␊ - access: (("Allow" | "Deny") | string)␊ - /**␊ - * The rule type of the rule.␊ - */␊ - routeFilterRuleType: ("Community" | string)␊ - /**␊ - * The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'].␊ - */␊ - communities: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeFilters/routeFilterRules␊ - */␊ - export interface RouteFiltersRouteFilterRulesChildResource7 {␊ - name: string␊ - type: "routeFilterRules"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Properties of the route filter rule.␊ - */␊ - properties: (RouteFilterRulePropertiesFormat7 | string)␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeFilters/routeFilterRules␊ - */␊ - export interface RouteFiltersRouteFilterRules7 {␊ - name: string␊ - type: "Microsoft.Network/routeFilters/routeFilterRules"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Properties of the route filter rule.␊ - */␊ - properties: (RouteFilterRulePropertiesFormat7 | string)␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables␊ - */␊ - export interface RouteTables29 {␊ - name: string␊ - type: "Microsoft.Network/routeTables"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the route table.␊ - */␊ - properties: (RouteTablePropertiesFormat21 | string)␊ - resources?: RouteTablesRoutesChildResource21[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Table resource.␊ - */␊ - export interface RouteTablePropertiesFormat21 {␊ - /**␊ - * Collection of routes contained within a route table.␊ - */␊ - routes?: (Route21[] | string)␊ - /**␊ - * Whether to disable the routes learned by BGP on that route table. True means disable.␊ - */␊ - disableBgpRoutePropagation?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource.␊ - */␊ - export interface Route21 {␊ - /**␊ - * Properties of the route.␊ - */␊ - properties?: (RoutePropertiesFormat21 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource.␊ - */␊ - export interface RoutePropertiesFormat21 {␊ - /**␊ - * The destination CIDR to which the route applies.␊ - */␊ - addressPrefix: string␊ - /**␊ - * The type of Azure hop the packet should be sent to.␊ - */␊ - nextHopType: (("VirtualNetworkGateway" | "VnetLocal" | "Internet" | "VirtualAppliance" | "None") | string)␊ - /**␊ - * The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.␊ - */␊ - nextHopIpAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutesChildResource21 {␊ - name: string␊ - type: "routes"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Properties of the route.␊ - */␊ - properties: (RoutePropertiesFormat21 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutes20 {␊ - name: string␊ - type: "Microsoft.Network/routeTables/routes"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Properties of the route.␊ - */␊ - properties: (RoutePropertiesFormat21 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/serviceEndpointPolicies␊ - */␊ - export interface ServiceEndpointPolicies5 {␊ - name: string␊ - type: "Microsoft.Network/serviceEndpointPolicies"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the service end point policy.␊ - */␊ - properties: (ServiceEndpointPolicyPropertiesFormat5 | string)␊ - resources?: ServiceEndpointPoliciesServiceEndpointPolicyDefinitionsChildResource5[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Service Endpoint Policy resource.␊ - */␊ - export interface ServiceEndpointPolicyPropertiesFormat5 {␊ - /**␊ - * A collection of service endpoint policy definitions of the service endpoint policy.␊ - */␊ - serviceEndpointPolicyDefinitions?: (ServiceEndpointPolicyDefinition5[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Service Endpoint policy definitions.␊ - */␊ - export interface ServiceEndpointPolicyDefinition5 {␊ - /**␊ - * Properties of the service endpoint policy definition.␊ - */␊ - properties?: (ServiceEndpointPolicyDefinitionPropertiesFormat5 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Service Endpoint policy definition resource.␊ - */␊ - export interface ServiceEndpointPolicyDefinitionPropertiesFormat5 {␊ - /**␊ - * A description for this rule. Restricted to 140 chars.␊ - */␊ - description?: string␊ - /**␊ - * Service endpoint name.␊ - */␊ - service?: string␊ - /**␊ - * A list of service resources.␊ - */␊ - serviceResources?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions␊ - */␊ - export interface ServiceEndpointPoliciesServiceEndpointPolicyDefinitionsChildResource5 {␊ - name: string␊ - type: "serviceEndpointPolicyDefinitions"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Properties of the service endpoint policy definition.␊ - */␊ - properties: (ServiceEndpointPolicyDefinitionPropertiesFormat5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions␊ - */␊ - export interface ServiceEndpointPoliciesServiceEndpointPolicyDefinitions5 {␊ - name: string␊ - type: "Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Properties of the service endpoint policy definition.␊ - */␊ - properties: (ServiceEndpointPolicyDefinitionPropertiesFormat5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualHubs␊ - */␊ - export interface VirtualHubs7 {␊ - name: string␊ - type: "Microsoft.Network/virtualHubs"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual hub.␊ - */␊ - properties: (VirtualHubProperties7 | string)␊ - resources?: VirtualHubsRouteTablesChildResource[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VirtualHub.␊ - */␊ - export interface VirtualHubProperties7 {␊ - /**␊ - * The VirtualWAN to which the VirtualHub belongs.␊ - */␊ - virtualWan?: (SubResource27 | string)␊ - /**␊ - * The VpnGateway associated with this VirtualHub.␊ - */␊ - vpnGateway?: (SubResource27 | string)␊ - /**␊ - * The P2SVpnGateway associated with this VirtualHub.␊ - */␊ - p2SVpnGateway?: (SubResource27 | string)␊ - /**␊ - * The expressRouteGateway associated with this VirtualHub.␊ - */␊ - expressRouteGateway?: (SubResource27 | string)␊ - /**␊ - * The azureFirewall associated with this VirtualHub.␊ - */␊ - azureFirewall?: (SubResource27 | string)␊ - /**␊ - * List of all vnet connections with this VirtualHub.␊ - */␊ - virtualNetworkConnections?: (HubVirtualNetworkConnection7[] | string)␊ - /**␊ - * Address-prefix for this VirtualHub.␊ - */␊ - addressPrefix?: string␊ - /**␊ - * The routeTable associated with this virtual hub.␊ - */␊ - routeTable?: (VirtualHubRouteTable4 | string)␊ - /**␊ - * The Security Provider name.␊ - */␊ - securityProviderName?: string␊ - /**␊ - * List of all virtual hub route table v2s associated with this VirtualHub.␊ - */␊ - virtualHubRouteTableV2s?: (VirtualHubRouteTableV2[] | string)␊ - /**␊ - * The sku of this VirtualHub.␊ - */␊ - sku?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HubVirtualNetworkConnection Resource.␊ - */␊ - export interface HubVirtualNetworkConnection7 {␊ - /**␊ - * Properties of the hub virtual network connection.␊ - */␊ - properties?: (HubVirtualNetworkConnectionProperties7 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for HubVirtualNetworkConnection.␊ - */␊ - export interface HubVirtualNetworkConnectionProperties7 {␊ - /**␊ - * Reference to the remote virtual network.␊ - */␊ - remoteVirtualNetwork?: (SubResource27 | string)␊ - /**␊ - * VirtualHub to RemoteVnet transit to enabled or not.␊ - */␊ - allowHubToRemoteVnetTransit?: (boolean | string)␊ - /**␊ - * Allow RemoteVnet to use Virtual Hub's gateways.␊ - */␊ - allowRemoteVnetToUseHubVnetGateways?: (boolean | string)␊ - /**␊ - * Enable internet security.␊ - */␊ - enableInternetSecurity?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualHub route table.␊ - */␊ - export interface VirtualHubRouteTable4 {␊ - /**␊ - * List of all routes.␊ - */␊ - routes?: (VirtualHubRoute4[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualHub route.␊ - */␊ - export interface VirtualHubRoute4 {␊ - /**␊ - * List of all addressPrefixes.␊ - */␊ - addressPrefixes?: (string[] | string)␊ - /**␊ - * NextHop ip address.␊ - */␊ - nextHopIpAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualHubRouteTableV2 Resource.␊ - */␊ - export interface VirtualHubRouteTableV2 {␊ - /**␊ - * Properties of the virtual hub route table v2.␊ - */␊ - properties?: (VirtualHubRouteTableV2Properties | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VirtualHubRouteTableV2.␊ - */␊ - export interface VirtualHubRouteTableV2Properties {␊ - /**␊ - * List of all routes.␊ - */␊ - routes?: (VirtualHubRouteV2[] | string)␊ - /**␊ - * List of all connections attached to this route table v2.␊ - */␊ - attachedConnections?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualHubRouteTableV2 route.␊ - */␊ - export interface VirtualHubRouteV2 {␊ - /**␊ - * The type of destinations␊ - */␊ - destinationType?: string␊ - /**␊ - * List of all destinations.␊ - */␊ - destinations?: (string[] | string)␊ - /**␊ - * The type of next hops␊ - */␊ - nextHopType?: string␊ - /**␊ - * NextHops ip address.␊ - */␊ - nextHops?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualHubs/routeTables␊ - */␊ - export interface VirtualHubsRouteTablesChildResource {␊ - name: string␊ - type: "routeTables"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Properties of the virtual hub route table v2.␊ - */␊ - properties: (VirtualHubRouteTableV2Properties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualHubs/routeTables␊ - */␊ - export interface VirtualHubsRouteTables {␊ - name: string␊ - type: "Microsoft.Network/virtualHubs/routeTables"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Properties of the virtual hub route table v2.␊ - */␊ - properties: (VirtualHubRouteTableV2Properties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworkGateways␊ - */␊ - export interface VirtualNetworkGateways17 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworkGateways"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway.␊ - */␊ - properties: (VirtualNetworkGatewayPropertiesFormat17 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGateway properties.␊ - */␊ - export interface VirtualNetworkGatewayPropertiesFormat17 {␊ - /**␊ - * IP configurations for virtual network gateway.␊ - */␊ - ipConfigurations?: (VirtualNetworkGatewayIPConfiguration16[] | string)␊ - /**␊ - * The type of this virtual network gateway.␊ - */␊ - gatewayType?: (("Vpn" | "ExpressRoute" | "HyperNet") | string)␊ - /**␊ - * The type of this virtual network gateway.␊ - */␊ - vpnType?: (("PolicyBased" | "RouteBased") | string)␊ - /**␊ - * The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN.␊ - */␊ - vpnGatewayGeneration?: (("None" | "Generation1" | "Generation2") | string)␊ - /**␊ - * Whether BGP is enabled for this virtual network gateway or not.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * ActiveActive flag.␊ - */␊ - activeActive?: (boolean | string)␊ - /**␊ - * The reference of the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting.␊ - */␊ - gatewayDefaultSite?: (SubResource27 | string)␊ - /**␊ - * The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.␊ - */␊ - sku?: (VirtualNetworkGatewaySku16 | string)␊ - /**␊ - * The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations.␊ - */␊ - vpnClientConfiguration?: (VpnClientConfiguration16 | string)␊ - /**␊ - * Virtual network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings16 | string)␊ - /**␊ - * The reference of the address space resource which represents the custom routes address space specified by the customer for virtual network gateway and VpnClient.␊ - */␊ - customRoutes?: (AddressSpace29 | string)␊ - /**␊ - * Whether dns forwarding is enabled or not.␊ - */␊ - enableDnsForwarding?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration for virtual network gateway.␊ - */␊ - export interface VirtualNetworkGatewayIPConfiguration16 {␊ - /**␊ - * Properties of the virtual network gateway ip configuration.␊ - */␊ - properties?: (VirtualNetworkGatewayIPConfigurationPropertiesFormat16 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of VirtualNetworkGatewayIPConfiguration.␊ - */␊ - export interface VirtualNetworkGatewayIPConfigurationPropertiesFormat16 {␊ - /**␊ - * The private IP address allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * The reference of the subnet resource.␊ - */␊ - subnet?: (SubResource27 | string)␊ - /**␊ - * The reference of the public IP resource.␊ - */␊ - publicIPAddress?: (SubResource27 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewaySku details.␊ - */␊ - export interface VirtualNetworkGatewaySku16 {␊ - /**␊ - * Gateway SKU name.␊ - */␊ - name?: (("Basic" | "HighPerformance" | "Standard" | "UltraPerformance" | "VpnGw1" | "VpnGw2" | "VpnGw3" | "VpnGw4" | "VpnGw5" | "VpnGw1AZ" | "VpnGw2AZ" | "VpnGw3AZ" | "VpnGw4AZ" | "VpnGw5AZ" | "ErGw1AZ" | "ErGw2AZ" | "ErGw3AZ") | string)␊ - /**␊ - * Gateway SKU tier.␊ - */␊ - tier?: (("Basic" | "HighPerformance" | "Standard" | "UltraPerformance" | "VpnGw1" | "VpnGw2" | "VpnGw3" | "VpnGw4" | "VpnGw5" | "VpnGw1AZ" | "VpnGw2AZ" | "VpnGw3AZ" | "VpnGw4AZ" | "VpnGw5AZ" | "ErGw1AZ" | "ErGw2AZ" | "ErGw3AZ") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnClientConfiguration for P2S client.␊ - */␊ - export interface VpnClientConfiguration16 {␊ - /**␊ - * The reference of the address space resource which represents Address space for P2S VpnClient.␊ - */␊ - vpnClientAddressPool?: (AddressSpace29 | string)␊ - /**␊ - * VpnClientRootCertificate for virtual network gateway.␊ - */␊ - vpnClientRootCertificates?: (VpnClientRootCertificate16[] | string)␊ - /**␊ - * VpnClientRevokedCertificate for Virtual network gateway.␊ - */␊ - vpnClientRevokedCertificates?: (VpnClientRevokedCertificate16[] | string)␊ - /**␊ - * VpnClientProtocols for Virtual network gateway.␊ - */␊ - vpnClientProtocols?: (("IkeV2" | "SSTP" | "OpenVPN")[] | string)␊ - /**␊ - * VpnClientIpsecPolicies for virtual network gateway P2S client.␊ - */␊ - vpnClientIpsecPolicies?: (IpsecPolicy14[] | string)␊ - /**␊ - * The radius server address property of the VirtualNetworkGateway resource for vpn client connection.␊ - */␊ - radiusServerAddress?: string␊ - /**␊ - * The radius secret property of the VirtualNetworkGateway resource for vpn client connection.␊ - */␊ - radiusServerSecret?: string␊ - /**␊ - * The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication.␊ - */␊ - aadTenant?: string␊ - /**␊ - * The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication.␊ - */␊ - aadAudience?: string␊ - /**␊ - * The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication.␊ - */␊ - aadIssuer?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client root certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRootCertificate16 {␊ - /**␊ - * Properties of the vpn client root certificate.␊ - */␊ - properties: (VpnClientRootCertificatePropertiesFormat16 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of application gateway.␊ - */␊ - export interface VpnClientRootCertificatePropertiesFormat16 {␊ - /**␊ - * The certificate public data.␊ - */␊ - publicCertData: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client revoked certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRevokedCertificate16 {␊ - /**␊ - * Properties of the vpn client revoked certificate.␊ - */␊ - properties?: (VpnClientRevokedCertificatePropertiesFormat16 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the revoked VPN client certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRevokedCertificatePropertiesFormat16 {␊ - /**␊ - * The revoked VPN client certificate thumbprint.␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks␊ - */␊ - export interface VirtualNetworks29 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network.␊ - */␊ - properties: (VirtualNetworkPropertiesFormat21 | string)␊ - resources?: (VirtualNetworksVirtualNetworkPeeringsChildResource18 | VirtualNetworksSubnetsChildResource21)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the virtual network.␊ - */␊ - export interface VirtualNetworkPropertiesFormat21 {␊ - /**␊ - * The AddressSpace that contains an array of IP address ranges that can be used by subnets.␊ - */␊ - addressSpace: (AddressSpace29 | string)␊ - /**␊ - * The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network.␊ - */␊ - dhcpOptions?: (DhcpOptions29 | string)␊ - /**␊ - * A list of subnets in a Virtual Network.␊ - */␊ - subnets?: (Subnet31[] | string)␊ - /**␊ - * A list of peerings in a Virtual Network.␊ - */␊ - virtualNetworkPeerings?: (VirtualNetworkPeering26[] | string)␊ - /**␊ - * Indicates if DDoS protection is enabled for all the protected resources in the virtual network. It requires a DDoS protection plan associated with the resource.␊ - */␊ - enableDdosProtection?: (boolean | string)␊ - /**␊ - * Indicates if VM protection is enabled for all the subnets in the virtual network.␊ - */␊ - enableVmProtection?: (boolean | string)␊ - /**␊ - * The DDoS protection plan associated with the virtual network.␊ - */␊ - ddosProtectionPlan?: (SubResource27 | string)␊ - /**␊ - * Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET.␊ - */␊ - bgpCommunities?: (VirtualNetworkBgpCommunities1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DhcpOptions contains an array of DNS servers available to VMs deployed in the virtual network. Standard DHCP option for a subnet overrides VNET DHCP options.␊ - */␊ - export interface DhcpOptions29 {␊ - /**␊ - * The list of DNS servers IP addresses.␊ - */␊ - dnsServers: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Subnet in a virtual network resource.␊ - */␊ - export interface Subnet31 {␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties?: (SubnetPropertiesFormat21 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the subnet.␊ - */␊ - export interface SubnetPropertiesFormat21 {␊ - /**␊ - * The address prefix for the subnet.␊ - */␊ - addressPrefix: string␊ - /**␊ - * List of address prefixes for the subnet.␊ - */␊ - addressPrefixes?: (string[] | string)␊ - /**␊ - * The reference of the NetworkSecurityGroup resource.␊ - */␊ - networkSecurityGroup?: (SubResource27 | string)␊ - /**␊ - * The reference of the RouteTable resource.␊ - */␊ - routeTable?: (SubResource27 | string)␊ - /**␊ - * Nat gateway associated with this subnet.␊ - */␊ - natGateway?: (SubResource27 | string)␊ - /**␊ - * An array of service endpoints.␊ - */␊ - serviceEndpoints?: (ServiceEndpointPropertiesFormat17[] | string)␊ - /**␊ - * An array of service endpoint policies.␊ - */␊ - serviceEndpointPolicies?: (SubResource27[] | string)␊ - /**␊ - * An array of references to the delegations on the subnet.␊ - */␊ - delegations?: (Delegation8[] | string)␊ - /**␊ - * Enable or Disable apply network policies on private end point in the subnet.␊ - */␊ - privateEndpointNetworkPolicies?: string␊ - /**␊ - * Enable or Disable apply network policies on private link service in the subnet.␊ - */␊ - privateLinkServiceNetworkPolicies?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The service endpoint properties.␊ - */␊ - export interface ServiceEndpointPropertiesFormat17 {␊ - /**␊ - * The type of the endpoint service.␊ - */␊ - service?: string␊ - /**␊ - * A list of locations.␊ - */␊ - locations?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Details the service to which the subnet is delegated.␊ - */␊ - export interface Delegation8 {␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties?: (ServiceDelegationPropertiesFormat8 | string)␊ - /**␊ - * The name of the resource that is unique within a subnet. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a service delegation.␊ - */␊ - export interface ServiceDelegationPropertiesFormat8 {␊ - /**␊ - * The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers).␊ - */␊ - serviceName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peerings in a virtual network resource.␊ - */␊ - export interface VirtualNetworkPeering26 {␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties?: (VirtualNetworkPeeringPropertiesFormat18 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - export interface VirtualNetworkPeeringPropertiesFormat18 {␊ - /**␊ - * Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space.␊ - */␊ - allowVirtualNetworkAccess?: (boolean | string)␊ - /**␊ - * Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network.␊ - */␊ - allowForwardedTraffic?: (boolean | string)␊ - /**␊ - * If gateway links can be used in remote virtual networking to link to this virtual network.␊ - */␊ - allowGatewayTransit?: (boolean | string)␊ - /**␊ - * If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway.␊ - */␊ - useRemoteGateways?: (boolean | string)␊ - /**␊ - * The reference of the remote virtual network. The remote virtual network can be in the same or different region (preview). See here to register for the preview and learn more (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering).␊ - */␊ - remoteVirtualNetwork: (SubResource27 | string)␊ - /**␊ - * The reference of the remote virtual network address space.␊ - */␊ - remoteAddressSpace?: (AddressSpace29 | string)␊ - /**␊ - * The status of the virtual network peering.␊ - */␊ - peeringState?: (("Initiated" | "Connected" | "Disconnected") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET.␊ - */␊ - export interface VirtualNetworkBgpCommunities1 {␊ - /**␊ - * The BGP community associated with the virtual network␊ - */␊ - virtualNetworkCommunity: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/virtualNetworkPeerings␊ - */␊ - export interface VirtualNetworksVirtualNetworkPeeringsChildResource18 {␊ - name: string␊ - type: "virtualNetworkPeerings"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties: (VirtualNetworkPeeringPropertiesFormat18 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnetsChildResource21 {␊ - name: string␊ - type: "subnets"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties: (SubnetPropertiesFormat21 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnets17 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks/subnets"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties: (SubnetPropertiesFormat21 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/virtualNetworkPeerings␊ - */␊ - export interface VirtualNetworksVirtualNetworkPeerings14 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks/virtualNetworkPeerings"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties: (VirtualNetworkPeeringPropertiesFormat18 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworkTaps␊ - */␊ - export interface VirtualNetworkTaps4 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworkTaps"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Virtual Network Tap Properties.␊ - */␊ - properties: (VirtualNetworkTapPropertiesFormat4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Virtual Network Tap properties.␊ - */␊ - export interface VirtualNetworkTapPropertiesFormat4 {␊ - /**␊ - * The reference to the private IP Address of the collector nic that will receive the tap.␊ - */␊ - destinationNetworkInterfaceIPConfiguration?: (SubResource27 | string)␊ - /**␊ - * The reference to the private IP address on the internal Load Balancer that will receive the tap.␊ - */␊ - destinationLoadBalancerFrontEndIPConfiguration?: (SubResource27 | string)␊ - /**␊ - * The VXLAN destination port that will receive the tapped traffic.␊ - */␊ - destinationPort?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualRouters␊ - */␊ - export interface VirtualRouters2 {␊ - name: string␊ - type: "Microsoft.Network/virtualRouters"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the Virtual Router.␊ - */␊ - properties: (VirtualRouterPropertiesFormat2 | string)␊ - resources?: VirtualRoutersPeeringsChildResource2[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Virtual Router definition␊ - */␊ - export interface VirtualRouterPropertiesFormat2 {␊ - /**␊ - * VirtualRouter ASN.␊ - */␊ - virtualRouterAsn?: (number | string)␊ - /**␊ - * VirtualRouter IPs␊ - */␊ - virtualRouterIps?: (string[] | string)␊ - /**␊ - * The Subnet on which VirtualRouter is hosted.␊ - */␊ - hostedSubnet?: (SubResource27 | string)␊ - /**␊ - * The Gateway on which VirtualRouter is hosted.␊ - */␊ - hostedGateway?: (SubResource27 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualRouters/peerings␊ - */␊ - export interface VirtualRoutersPeeringsChildResource2 {␊ - name: string␊ - type: "peerings"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * The properties of the Virtual Router Peering.␊ - */␊ - properties: (VirtualRouterPeeringProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the rule group.␊ - */␊ - export interface VirtualRouterPeeringProperties2 {␊ - /**␊ - * Peer ASN.␊ - */␊ - peerAsn?: (number | string)␊ - /**␊ - * Peer IP.␊ - */␊ - peerIp?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualRouters/peerings␊ - */␊ - export interface VirtualRoutersPeerings2 {␊ - name: string␊ - type: "Microsoft.Network/virtualRouters/peerings"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * The properties of the Virtual Router Peering.␊ - */␊ - properties: (VirtualRouterPeeringProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualWans␊ - */␊ - export interface VirtualWans7 {␊ - name: string␊ - type: "Microsoft.Network/virtualWans"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual WAN.␊ - */␊ - properties: (VirtualWanProperties7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VirtualWAN.␊ - */␊ - export interface VirtualWanProperties7 {␊ - /**␊ - * Vpn encryption to be disabled or not.␊ - */␊ - disableVpnEncryption?: (boolean | string)␊ - /**␊ - * True if branch to branch traffic is allowed.␊ - */␊ - allowBranchToBranchTraffic?: (boolean | string)␊ - /**␊ - * True if Vnet to Vnet traffic is allowed.␊ - */␊ - allowVnetToVnetTraffic?: (boolean | string)␊ - /**␊ - * The office local breakout category.␊ - */␊ - office365LocalBreakoutCategory?: (("Optimize" | "OptimizeAndAllow" | "All" | "None") | string)␊ - /**␊ - * The type of the VirtualWAN.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnGateways␊ - */␊ - export interface VpnGateways7 {␊ - name: string␊ - type: "Microsoft.Network/vpnGateways"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the VPN gateway.␊ - */␊ - properties: (VpnGatewayProperties7 | string)␊ - resources?: VpnGatewaysVpnConnectionsChildResource7[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnGateway.␊ - */␊ - export interface VpnGatewayProperties7 {␊ - /**␊ - * The VirtualHub to which the gateway belongs.␊ - */␊ - virtualHub?: (SubResource27 | string)␊ - /**␊ - * List of all vpn connections to the gateway.␊ - */␊ - connections?: (VpnConnection7[] | string)␊ - /**␊ - * Local network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings16 | string)␊ - /**␊ - * The scale unit for this vpn gateway.␊ - */␊ - vpnGatewayScaleUnit?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnConnection Resource.␊ - */␊ - export interface VpnConnection7 {␊ - /**␊ - * Properties of the VPN connection.␊ - */␊ - properties?: (VpnConnectionProperties7 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnConnection.␊ - */␊ - export interface VpnConnectionProperties7 {␊ - /**␊ - * Id of the connected vpn site.␊ - */␊ - remoteVpnSite?: (SubResource27 | string)␊ - /**␊ - * Routing weight for vpn connection.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * The connection status.␊ - */␊ - connectionStatus?: (("Unknown" | "Connecting" | "Connected" | "NotConnected") | string)␊ - /**␊ - * Connection protocol used for this connection.␊ - */␊ - vpnConnectionProtocolType?: (("IKEv2" | "IKEv1") | string)␊ - /**␊ - * Expected bandwidth in MBPS.␊ - */␊ - connectionBandwidth?: (number | string)␊ - /**␊ - * SharedKey for the vpn connection.␊ - */␊ - sharedKey?: string␊ - /**␊ - * EnableBgp flag.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * Enable policy-based traffic selectors.␊ - */␊ - usePolicyBasedTrafficSelectors?: (boolean | string)␊ - /**␊ - * The IPSec Policies to be considered by this connection.␊ - */␊ - ipsecPolicies?: (IpsecPolicy14[] | string)␊ - /**␊ - * EnableBgp flag.␊ - */␊ - enableRateLimiting?: (boolean | string)␊ - /**␊ - * Enable internet security.␊ - */␊ - enableInternetSecurity?: (boolean | string)␊ - /**␊ - * Use local azure ip to initiate connection.␊ - */␊ - useLocalAzureIpAddress?: (boolean | string)␊ - /**␊ - * List of all vpn site link connections to the gateway.␊ - */␊ - vpnLinkConnections?: (VpnSiteLinkConnection3[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnSiteLinkConnection Resource.␊ - */␊ - export interface VpnSiteLinkConnection3 {␊ - /**␊ - * Properties of the VPN site link connection.␊ - */␊ - properties?: (VpnSiteLinkConnectionProperties3 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnConnection.␊ - */␊ - export interface VpnSiteLinkConnectionProperties3 {␊ - /**␊ - * Id of the connected vpn site link.␊ - */␊ - vpnSiteLink?: (SubResource27 | string)␊ - /**␊ - * Routing weight for vpn connection.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * The connection status.␊ - */␊ - connectionStatus?: (("Unknown" | "Connecting" | "Connected" | "NotConnected") | string)␊ - /**␊ - * Connection protocol used for this connection.␊ - */␊ - vpnConnectionProtocolType?: (("IKEv2" | "IKEv1") | string)␊ - /**␊ - * Expected bandwidth in MBPS.␊ - */␊ - connectionBandwidth?: (number | string)␊ - /**␊ - * SharedKey for the vpn connection.␊ - */␊ - sharedKey?: string␊ - /**␊ - * EnableBgp flag.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * Enable policy-based traffic selectors.␊ - */␊ - usePolicyBasedTrafficSelectors?: (boolean | string)␊ - /**␊ - * The IPSec Policies to be considered by this connection.␊ - */␊ - ipsecPolicies?: (IpsecPolicy14[] | string)␊ - /**␊ - * EnableBgp flag.␊ - */␊ - enableRateLimiting?: (boolean | string)␊ - /**␊ - * Use local azure ip to initiate connection.␊ - */␊ - useLocalAzureIpAddress?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnGateways/vpnConnections␊ - */␊ - export interface VpnGatewaysVpnConnectionsChildResource7 {␊ - name: string␊ - type: "vpnConnections"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Properties of the VPN connection.␊ - */␊ - properties: (VpnConnectionProperties7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnGateways/vpnConnections␊ - */␊ - export interface VpnGatewaysVpnConnections7 {␊ - name: string␊ - type: "Microsoft.Network/vpnGateways/vpnConnections"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Properties of the VPN connection.␊ - */␊ - properties: (VpnConnectionProperties7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnServerConfigurations␊ - */␊ - export interface VpnServerConfigurations1 {␊ - name: string␊ - type: "Microsoft.Network/vpnServerConfigurations"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the P2SVpnServer configuration.␊ - */␊ - properties: (VpnServerConfigurationProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnServerConfiguration.␊ - */␊ - export interface VpnServerConfigurationProperties1 {␊ - /**␊ - * The name of the VpnServerConfiguration that is unique within a resource group.␊ - */␊ - name?: string␊ - /**␊ - * VPN protocols for the VpnServerConfiguration.␊ - */␊ - vpnProtocols?: (("IkeV2" | "OpenVPN")[] | string)␊ - /**␊ - * VPN authentication types for the VpnServerConfiguration.␊ - */␊ - vpnAuthenticationTypes?: (("Certificate" | "Radius" | "AAD")[] | string)␊ - /**␊ - * VPN client root certificate of VpnServerConfiguration.␊ - */␊ - vpnClientRootCertificates?: (VpnServerConfigVpnClientRootCertificate1[] | string)␊ - /**␊ - * VPN client revoked certificate of VpnServerConfiguration.␊ - */␊ - vpnClientRevokedCertificates?: (VpnServerConfigVpnClientRevokedCertificate1[] | string)␊ - /**␊ - * Radius Server root certificate of VpnServerConfiguration.␊ - */␊ - radiusServerRootCertificates?: (VpnServerConfigRadiusServerRootCertificate1[] | string)␊ - /**␊ - * Radius client root certificate of VpnServerConfiguration.␊ - */␊ - radiusClientRootCertificates?: (VpnServerConfigRadiusClientRootCertificate1[] | string)␊ - /**␊ - * VpnClientIpsecPolicies for VpnServerConfiguration.␊ - */␊ - vpnClientIpsecPolicies?: (IpsecPolicy14[] | string)␊ - /**␊ - * The radius server address property of the VpnServerConfiguration resource for point to site client connection.␊ - */␊ - radiusServerAddress?: string␊ - /**␊ - * The radius secret property of the VpnServerConfiguration resource for point to site client connection.␊ - */␊ - radiusServerSecret?: string␊ - /**␊ - * The set of aad vpn authentication parameters.␊ - */␊ - aadAuthenticationParameters?: (AadAuthenticationParameters1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of VPN client root certificate of VpnServerConfiguration.␊ - */␊ - export interface VpnServerConfigVpnClientRootCertificate1 {␊ - /**␊ - * The certificate name.␊ - */␊ - name?: string␊ - /**␊ - * The certificate public data.␊ - */␊ - publicCertData?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the revoked VPN client certificate of VpnServerConfiguration.␊ - */␊ - export interface VpnServerConfigVpnClientRevokedCertificate1 {␊ - /**␊ - * The certificate name.␊ - */␊ - name?: string␊ - /**␊ - * The revoked VPN client certificate thumbprint.␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Radius Server root certificate of VpnServerConfiguration.␊ - */␊ - export interface VpnServerConfigRadiusServerRootCertificate1 {␊ - /**␊ - * The certificate name.␊ - */␊ - name?: string␊ - /**␊ - * The certificate public data.␊ - */␊ - publicCertData?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Radius client root certificate of VpnServerConfiguration.␊ - */␊ - export interface VpnServerConfigRadiusClientRootCertificate1 {␊ - /**␊ - * The certificate name.␊ - */␊ - name?: string␊ - /**␊ - * The Radius client root certificate thumbprint.␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AAD Vpn authentication type related parameters.␊ - */␊ - export interface AadAuthenticationParameters1 {␊ - /**␊ - * AAD Vpn authentication parameter AAD tenant.␊ - */␊ - aadTenant?: string␊ - /**␊ - * AAD Vpn authentication parameter AAD audience.␊ - */␊ - aadAudience?: string␊ - /**␊ - * AAD Vpn authentication parameter AAD issuer.␊ - */␊ - aadIssuer?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnSites␊ - */␊ - export interface VpnSites7 {␊ - name: string␊ - type: "Microsoft.Network/vpnSites"␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the VPN site.␊ - */␊ - properties: (VpnSiteProperties7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnSite.␊ - */␊ - export interface VpnSiteProperties7 {␊ - /**␊ - * The VirtualWAN to which the vpnSite belongs.␊ - */␊ - virtualWan?: (SubResource27 | string)␊ - /**␊ - * The device properties.␊ - */␊ - deviceProperties?: (DeviceProperties7 | string)␊ - /**␊ - * The ip-address for the vpn-site.␊ - */␊ - ipAddress?: string␊ - /**␊ - * The key for vpn-site that can be used for connections.␊ - */␊ - siteKey?: string␊ - /**␊ - * The AddressSpace that contains an array of IP address ranges.␊ - */␊ - addressSpace?: (AddressSpace29 | string)␊ - /**␊ - * The set of bgp properties.␊ - */␊ - bgpProperties?: (BgpSettings16 | string)␊ - /**␊ - * IsSecuritySite flag.␊ - */␊ - isSecuritySite?: (boolean | string)␊ - /**␊ - * List of all vpn site links.␊ - */␊ - vpnSiteLinks?: (VpnSiteLink3[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * List of properties of the device.␊ - */␊ - export interface DeviceProperties7 {␊ - /**␊ - * Name of the device Vendor.␊ - */␊ - deviceVendor?: string␊ - /**␊ - * Model of the device.␊ - */␊ - deviceModel?: string␊ - /**␊ - * Link speed.␊ - */␊ - linkSpeedInMbps?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnSiteLink Resource.␊ - */␊ - export interface VpnSiteLink3 {␊ - /**␊ - * Properties of the VPN site link.␊ - */␊ - properties?: (VpnSiteLinkProperties3 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnSite.␊ - */␊ - export interface VpnSiteLinkProperties3 {␊ - /**␊ - * The link provider properties.␊ - */␊ - linkProperties?: (VpnLinkProviderProperties3 | string)␊ - /**␊ - * The ip-address for the vpn-site-link.␊ - */␊ - ipAddress?: string␊ - /**␊ - * The set of bgp properties.␊ - */␊ - bgpProperties?: (VpnLinkBgpSettings3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * List of properties of a link provider.␊ - */␊ - export interface VpnLinkProviderProperties3 {␊ - /**␊ - * Name of the link provider.␊ - */␊ - linkProviderName?: string␊ - /**␊ - * Link speed.␊ - */␊ - linkSpeedInMbps?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * BGP settings details for a link.␊ - */␊ - export interface VpnLinkBgpSettings3 {␊ - /**␊ - * The BGP speaker's ASN.␊ - */␊ - asn?: (number | string)␊ - /**␊ - * The BGP peering address and BGP identifier of this BGP speaker.␊ - */␊ - bgpPeeringAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/natGateways␊ - */␊ - export interface NatGateways5 {␊ - name: string␊ - type: "Microsoft.Network/natGateways"␊ - apiVersion: "2019-02-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The nat gateway SKU.␊ - */␊ - sku?: (NatGatewaySku5 | string)␊ - /**␊ - * Nat Gateway properties.␊ - */␊ - properties: (NatGatewayPropertiesFormat5 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of nat gateway␊ - */␊ - export interface NatGatewaySku5 {␊ - /**␊ - * Name of Nat Gateway SKU.␊ - */␊ - name?: ("Standard" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Nat Gateway properties.␊ - */␊ - export interface NatGatewayPropertiesFormat5 {␊ - /**␊ - * The idle timeout of the nat gateway.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * An array of public ip addresses associated with the nat gateway resource.␊ - */␊ - publicIpAddresses?: (SubResource22[] | string)␊ - /**␊ - * An array of public ip prefixes associated with the nat gateway resource.␊ - */␊ - publicIpPrefixes?: (SubResource22[] | string)␊ - /**␊ - * The resource GUID property of the nat gateway resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the NatGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/connections␊ - */␊ - export interface Connections18 {␊ - name: string␊ - type: "Microsoft.Network/connections"␊ - apiVersion: "2019-02-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway connection.␊ - */␊ - properties: (VirtualNetworkGatewayConnectionPropertiesFormat18 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewayConnection properties␊ - */␊ - export interface VirtualNetworkGatewayConnectionPropertiesFormat18 {␊ - /**␊ - * The authorizationKey.␊ - */␊ - authorizationKey?: string␊ - /**␊ - * The reference to virtual network gateway resource.␊ - */␊ - virtualNetworkGateway1: (VirtualNetworkGateway9 | SubResource22 | string)␊ - /**␊ - * The reference to virtual network gateway resource.␊ - */␊ - virtualNetworkGateway2?: (VirtualNetworkGateway9 | SubResource22 | string)␊ - /**␊ - * The reference to local network gateway resource.␊ - */␊ - localNetworkGateway2?: (LocalNetworkGateway9 | SubResource22 | string)␊ - /**␊ - * Gateway connection type.␊ - */␊ - connectionType: (("IPsec" | "Vnet2Vnet" | "ExpressRoute" | "VPNClient") | string)␊ - /**␊ - * Connection protocol used for this connection.␊ - */␊ - connectionProtocol?: (("IKEv2" | "IKEv1") | string)␊ - /**␊ - * The routing weight.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * The IPSec shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The reference to peerings resource.␊ - */␊ - peer?: (SubResource22 | string)␊ - /**␊ - * EnableBgp flag␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * Enable policy-based traffic selectors.␊ - */␊ - usePolicyBasedTrafficSelectors?: (boolean | string)␊ - /**␊ - * The IPSec Policies to be considered by this connection.␊ - */␊ - ipsecPolicies?: (IpsecPolicy15[] | string)␊ - /**␊ - * The resource GUID property of the VirtualNetworkGatewayConnection resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Bypass ExpressRoute Gateway for data forwarding␊ - */␊ - expressRouteGatewayBypass?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A common class for general resource information␊ - */␊ - export interface VirtualNetworkGateway9 {␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway.␊ - */␊ - properties: (VirtualNetworkGatewayPropertiesFormat18 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGateway properties␊ - */␊ - export interface VirtualNetworkGatewayPropertiesFormat18 {␊ - /**␊ - * IP configurations for virtual network gateway.␊ - */␊ - ipConfigurations?: (VirtualNetworkGatewayIPConfiguration17[] | string)␊ - /**␊ - * The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'.␊ - */␊ - gatewayType?: (("Vpn" | "ExpressRoute") | string)␊ - /**␊ - * The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'.␊ - */␊ - vpnType?: (("PolicyBased" | "RouteBased") | string)␊ - /**␊ - * Whether BGP is enabled for this virtual network gateway or not.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * ActiveActive flag␊ - */␊ - activeActive?: (boolean | string)␊ - /**␊ - * The reference of the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting.␊ - */␊ - gatewayDefaultSite?: (SubResource22 | string)␊ - /**␊ - * The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.␊ - */␊ - sku?: (VirtualNetworkGatewaySku17 | string)␊ - /**␊ - * The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations.␊ - */␊ - vpnClientConfiguration?: (VpnClientConfiguration17 | string)␊ - /**␊ - * Virtual network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings17 | string)␊ - /**␊ - * The reference of the address space resource which represents the custom routes address space specified by the the customer for virtual network gateway and VpnClient.␊ - */␊ - customRoutes?: (AddressSpace24 | string)␊ - /**␊ - * The resource GUID property of the VirtualNetworkGateway resource.␊ - */␊ - resourceGuid?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration for virtual network gateway␊ - */␊ - export interface VirtualNetworkGatewayIPConfiguration17 {␊ - /**␊ - * Properties of the virtual network gateway ip configuration.␊ - */␊ - properties?: (VirtualNetworkGatewayIPConfigurationPropertiesFormat17 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of VirtualNetworkGatewayIPConfiguration␊ - */␊ - export interface VirtualNetworkGatewayIPConfigurationPropertiesFormat17 {␊ - /**␊ - * The private IP address allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * The reference of the subnet resource.␊ - */␊ - subnet?: (SubResource22 | string)␊ - /**␊ - * The reference of the public IP resource.␊ - */␊ - publicIPAddress?: (SubResource22 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewaySku details␊ - */␊ - export interface VirtualNetworkGatewaySku17 {␊ - /**␊ - * Gateway SKU name.␊ - */␊ - name?: (("Basic" | "HighPerformance" | "Standard" | "UltraPerformance" | "VpnGw1" | "VpnGw2" | "VpnGw3" | "VpnGw1AZ" | "VpnGw2AZ" | "VpnGw3AZ" | "ErGw1AZ" | "ErGw2AZ" | "ErGw3AZ") | string)␊ - /**␊ - * Gateway SKU tier.␊ - */␊ - tier?: (("Basic" | "HighPerformance" | "Standard" | "UltraPerformance" | "VpnGw1" | "VpnGw2" | "VpnGw3" | "VpnGw1AZ" | "VpnGw2AZ" | "VpnGw3AZ" | "ErGw1AZ" | "ErGw2AZ" | "ErGw3AZ") | string)␊ - /**␊ - * The capacity.␊ - */␊ - capacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnClientConfiguration for P2S client.␊ - */␊ - export interface VpnClientConfiguration17 {␊ - /**␊ - * The reference of the address space resource which represents Address space for P2S VpnClient.␊ - */␊ - vpnClientAddressPool?: (AddressSpace24 | string)␊ - /**␊ - * VpnClientRootCertificate for virtual network gateway.␊ - */␊ - vpnClientRootCertificates?: (VpnClientRootCertificate17[] | string)␊ - /**␊ - * VpnClientRevokedCertificate for Virtual network gateway.␊ - */␊ - vpnClientRevokedCertificates?: (VpnClientRevokedCertificate17[] | string)␊ - /**␊ - * VpnClientProtocols for Virtual network gateway.␊ - */␊ - vpnClientProtocols?: (("IkeV2" | "SSTP" | "OpenVPN")[] | string)␊ - /**␊ - * VpnClientIpsecPolicies for virtual network gateway P2S client.␊ - */␊ - vpnClientIpsecPolicies?: (IpsecPolicy15[] | string)␊ - /**␊ - * The radius server address property of the VirtualNetworkGateway resource for vpn client connection.␊ - */␊ - radiusServerAddress?: string␊ - /**␊ - * The radius secret property of the VirtualNetworkGateway resource for vpn client connection.␊ - */␊ - radiusServerSecret?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client root certificate of virtual network gateway␊ - */␊ - export interface VpnClientRootCertificate17 {␊ - /**␊ - * Properties of the vpn client root certificate.␊ - */␊ - properties: (VpnClientRootCertificatePropertiesFormat17 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of application gateway␊ - */␊ - export interface VpnClientRootCertificatePropertiesFormat17 {␊ - /**␊ - * The certificate public data.␊ - */␊ - publicCertData: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client revoked certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRevokedCertificate17 {␊ - /**␊ - * Properties of the vpn client revoked certificate.␊ - */␊ - properties?: (VpnClientRevokedCertificatePropertiesFormat17 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the revoked VPN client certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRevokedCertificatePropertiesFormat17 {␊ - /**␊ - * The revoked VPN client certificate thumbprint.␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An IPSec Policy configuration for a virtual network gateway connection␊ - */␊ - export interface IpsecPolicy15 {␊ - /**␊ - * The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.␊ - */␊ - saLifeTimeSeconds: (number | string)␊ - /**␊ - * The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.␊ - */␊ - saDataSizeKilobytes: (number | string)␊ - /**␊ - * The IPSec encryption algorithm (IKE phase 1).␊ - */␊ - ipsecEncryption: (("None" | "DES" | "DES3" | "AES128" | "AES192" | "AES256" | "GCMAES128" | "GCMAES192" | "GCMAES256") | string)␊ - /**␊ - * The IPSec integrity algorithm (IKE phase 1).␊ - */␊ - ipsecIntegrity: (("MD5" | "SHA1" | "SHA256" | "GCMAES128" | "GCMAES192" | "GCMAES256") | string)␊ - /**␊ - * The IKE encryption algorithm (IKE phase 2).␊ - */␊ - ikeEncryption: (("DES" | "DES3" | "AES128" | "AES192" | "AES256" | "GCMAES256" | "GCMAES128") | string)␊ - /**␊ - * The IKE integrity algorithm (IKE phase 2).␊ - */␊ - ikeIntegrity: (("MD5" | "SHA1" | "SHA256" | "SHA384" | "GCMAES256" | "GCMAES128") | string)␊ - /**␊ - * The DH Group used in IKE Phase 1 for initial SA.␊ - */␊ - dhGroup: (("None" | "DHGroup1" | "DHGroup2" | "DHGroup14" | "DHGroup2048" | "ECP256" | "ECP384" | "DHGroup24") | string)␊ - /**␊ - * The Pfs Group used in IKE Phase 2 for new child SA.␊ - */␊ - pfsGroup: (("None" | "PFS1" | "PFS2" | "PFS2048" | "ECP256" | "ECP384" | "PFS24" | "PFS14" | "PFSMM") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * BGP settings details␊ - */␊ - export interface BgpSettings17 {␊ - /**␊ - * The BGP speaker's ASN.␊ - */␊ - asn?: (number | string)␊ - /**␊ - * The BGP peering address and BGP identifier of this BGP speaker.␊ - */␊ - bgpPeeringAddress?: string␊ - /**␊ - * The weight added to routes learned from this BGP speaker.␊ - */␊ - peerWeight?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A common class for general resource information␊ - */␊ - export interface LocalNetworkGateway9 {␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the local network gateway.␊ - */␊ - properties: (LocalNetworkGatewayPropertiesFormat18 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * LocalNetworkGateway properties␊ - */␊ - export interface LocalNetworkGatewayPropertiesFormat18 {␊ - /**␊ - * Local network site address space.␊ - */␊ - localNetworkAddressSpace?: (AddressSpace24 | string)␊ - /**␊ - * IP address of local network gateway.␊ - */␊ - gatewayIpAddress?: string␊ - /**␊ - * Local network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings17 | string)␊ - /**␊ - * The resource GUID property of the LocalNetworkGateway resource.␊ - */␊ - resourceGuid?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/localNetworkGateways␊ - */␊ - export interface LocalNetworkGateways18 {␊ - name: string␊ - type: "Microsoft.Network/localNetworkGateways"␊ - apiVersion: "2019-02-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the local network gateway.␊ - */␊ - properties: (LocalNetworkGatewayPropertiesFormat18 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworkGateways␊ - */␊ - export interface VirtualNetworkGateways18 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworkGateways"␊ - apiVersion: "2019-02-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway.␊ - */␊ - properties: (VirtualNetworkGatewayPropertiesFormat18 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnets18 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks/subnets"␊ - apiVersion: "2019-02-01"␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties: (SubnetPropertiesFormat16 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/virtualNetworkPeerings␊ - */␊ - export interface VirtualNetworksVirtualNetworkPeerings15 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks/virtualNetworkPeerings"␊ - apiVersion: "2019-02-01"␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties: (VirtualNetworkPeeringPropertiesFormat13 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies␊ - */␊ - export interface ApplicationGatewayWebApplicationFirewallPolicies6 {␊ - name: string␊ - type: "Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies"␊ - apiVersion: "2018-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the web application firewall policy.␊ - */␊ - properties: (WebApplicationFirewallPolicyPropertiesFormat6 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines web application firewall policy properties␊ - */␊ - export interface WebApplicationFirewallPolicyPropertiesFormat6 {␊ - /**␊ - * Describes policySettings for policy␊ - */␊ - policySettings?: (PolicySettings8 | string)␊ - /**␊ - * Describes custom rules inside the policy␊ - */␊ - customRules?: (WebApplicationFirewallCustomRule6[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines contents of a web application firewall global configuration␊ - */␊ - export interface PolicySettings8 {␊ - /**␊ - * Describes if the policy is in enabled state or disabled state.␊ - */␊ - enabledState?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * Describes if it is in detection mode or prevention mode at policy level.␊ - */␊ - mode?: (("Prevention" | "Detection") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines contents of a web application rule␊ - */␊ - export interface WebApplicationFirewallCustomRule6 {␊ - /**␊ - * Gets name of the resource that is unique within a policy. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value␊ - */␊ - priority: (number | string)␊ - /**␊ - * Describes type of rule.␊ - */␊ - ruleType: (("MatchRule" | "Invalid") | string)␊ - /**␊ - * List of match conditions␊ - */␊ - matchConditions: (MatchCondition8[] | string)␊ - /**␊ - * Type of Actions.␊ - */␊ - action: (("Allow" | "Block" | "Log") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Define match conditions␊ - */␊ - export interface MatchCondition8 {␊ - /**␊ - * List of match variables␊ - */␊ - matchVariables: (MatchVariable6[] | string)␊ - /**␊ - * Describes operator to be matched.␊ - */␊ - operator: (("IPMatch" | "Equal" | "Contains" | "LessThan" | "GreaterThan" | "LessThanOrEqual" | "GreaterThanOrEqual" | "BeginsWith" | "EndsWith" | "Regex") | string)␊ - /**␊ - * Describes if this is negate condition or not␊ - */␊ - negationConditon?: (boolean | string)␊ - /**␊ - * Match value␊ - */␊ - matchValues: (string[] | string)␊ - /**␊ - * List of transforms␊ - */␊ - transforms?: (("Lowercase" | "Trim" | "UrlDecode" | "UrlEncode" | "RemoveNulls" | "HtmlEntityDecode")[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Define match variables␊ - */␊ - export interface MatchVariable6 {␊ - /**␊ - * Match Variable.␊ - */␊ - variableName: (("RemoteAddr" | "RequestMethod" | "QueryString" | "PostArgs" | "RequestUri" | "RequestHeaders" | "RequestBody" | "RequestCookies") | string)␊ - /**␊ - * Describes field of the matchVariable collection␊ - */␊ - selector?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/connections␊ - */␊ - export interface Connections19 {␊ - name: string␊ - type: "Microsoft.Network/connections"␊ - apiVersion: "2018-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway connection.␊ - */␊ - properties: (VirtualNetworkGatewayConnectionPropertiesFormat19 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewayConnection properties␊ - */␊ - export interface VirtualNetworkGatewayConnectionPropertiesFormat19 {␊ - /**␊ - * The authorizationKey.␊ - */␊ - authorizationKey?: string␊ - /**␊ - * The reference to virtual network gateway resource.␊ - */␊ - virtualNetworkGateway1: (VirtualNetworkGateway10 | SubResource21 | string)␊ - /**␊ - * The reference to virtual network gateway resource.␊ - */␊ - virtualNetworkGateway2?: (VirtualNetworkGateway10 | SubResource21 | string)␊ - /**␊ - * The reference to local network gateway resource.␊ - */␊ - localNetworkGateway2?: (LocalNetworkGateway10 | SubResource21 | string)␊ - /**␊ - * Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.␊ - */␊ - connectionType: (("IPsec" | "Vnet2Vnet" | "ExpressRoute" | "VPNClient") | string)␊ - /**␊ - * Connection protocol used for this connection.␊ - */␊ - connectionProtocol?: (("IKEv2" | "IKEv1") | string)␊ - /**␊ - * The routing weight.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * The IPSec shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The reference to peerings resource.␊ - */␊ - peer?: (SubResource21 | string)␊ - /**␊ - * EnableBgp flag␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * Enable policy-based traffic selectors.␊ - */␊ - usePolicyBasedTrafficSelectors?: (boolean | string)␊ - /**␊ - * The IPSec Policies to be considered by this connection.␊ - */␊ - ipsecPolicies?: (IpsecPolicy16[] | string)␊ - /**␊ - * The resource GUID property of the VirtualNetworkGatewayConnection resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Bypass ExpressRoute Gateway for data forwarding␊ - */␊ - expressRouteGatewayBypass?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A common class for general resource information␊ - */␊ - export interface VirtualNetworkGateway10 {␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway.␊ - */␊ - properties: (VirtualNetworkGatewayPropertiesFormat19 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGateway properties␊ - */␊ - export interface VirtualNetworkGatewayPropertiesFormat19 {␊ - /**␊ - * IP configurations for virtual network gateway.␊ - */␊ - ipConfigurations?: (VirtualNetworkGatewayIPConfiguration18[] | string)␊ - /**␊ - * The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'.␊ - */␊ - gatewayType?: (("Vpn" | "ExpressRoute") | string)␊ - /**␊ - * The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'.␊ - */␊ - vpnType?: (("PolicyBased" | "RouteBased") | string)␊ - /**␊ - * Whether BGP is enabled for this virtual network gateway or not.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * ActiveActive flag␊ - */␊ - activeActive?: (boolean | string)␊ - /**␊ - * The reference of the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting.␊ - */␊ - gatewayDefaultSite?: (SubResource21 | string)␊ - /**␊ - * The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.␊ - */␊ - sku?: (VirtualNetworkGatewaySku18 | string)␊ - /**␊ - * The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations.␊ - */␊ - vpnClientConfiguration?: (VpnClientConfiguration18 | string)␊ - /**␊ - * Virtual network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings18 | string)␊ - /**␊ - * The resource GUID property of the VirtualNetworkGateway resource.␊ - */␊ - resourceGuid?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration for virtual network gateway␊ - */␊ - export interface VirtualNetworkGatewayIPConfiguration18 {␊ - /**␊ - * Properties of the virtual network gateway ip configuration.␊ - */␊ - properties?: (VirtualNetworkGatewayIPConfigurationPropertiesFormat18 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of VirtualNetworkGatewayIPConfiguration␊ - */␊ - export interface VirtualNetworkGatewayIPConfigurationPropertiesFormat18 {␊ - /**␊ - * The private IP allocation method. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * The reference of the subnet resource.␊ - */␊ - subnet?: (SubResource21 | string)␊ - /**␊ - * The reference of the public IP resource.␊ - */␊ - publicIPAddress?: (SubResource21 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewaySku details␊ - */␊ - export interface VirtualNetworkGatewaySku18 {␊ - /**␊ - * Gateway SKU name.␊ - */␊ - name?: (("Basic" | "HighPerformance" | "Standard" | "UltraPerformance" | "VpnGw1" | "VpnGw2" | "VpnGw3" | "VpnGw1AZ" | "VpnGw2AZ" | "VpnGw3AZ" | "ErGw1AZ" | "ErGw2AZ" | "ErGw3AZ") | string)␊ - /**␊ - * Gateway SKU tier.␊ - */␊ - tier?: (("Basic" | "HighPerformance" | "Standard" | "UltraPerformance" | "VpnGw1" | "VpnGw2" | "VpnGw3" | "VpnGw1AZ" | "VpnGw2AZ" | "VpnGw3AZ" | "ErGw1AZ" | "ErGw2AZ" | "ErGw3AZ") | string)␊ - /**␊ - * The capacity.␊ - */␊ - capacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnClientConfiguration for P2S client.␊ - */␊ - export interface VpnClientConfiguration18 {␊ - /**␊ - * The reference of the address space resource which represents Address space for P2S VpnClient.␊ - */␊ - vpnClientAddressPool?: (AddressSpace23 | string)␊ - /**␊ - * VpnClientRootCertificate for virtual network gateway.␊ - */␊ - vpnClientRootCertificates?: (VpnClientRootCertificate18[] | string)␊ - /**␊ - * VpnClientRevokedCertificate for Virtual network gateway.␊ - */␊ - vpnClientRevokedCertificates?: (VpnClientRevokedCertificate18[] | string)␊ - /**␊ - * VpnClientProtocols for Virtual network gateway.␊ - */␊ - vpnClientProtocols?: (("IkeV2" | "SSTP" | "OpenVPN")[] | string)␊ - /**␊ - * VpnClientIpsecPolicies for virtual network gateway P2S client.␊ - */␊ - vpnClientIpsecPolicies?: (IpsecPolicy16[] | string)␊ - /**␊ - * The radius server address property of the VirtualNetworkGateway resource for vpn client connection.␊ - */␊ - radiusServerAddress?: string␊ - /**␊ - * The radius secret property of the VirtualNetworkGateway resource for vpn client connection.␊ - */␊ - radiusServerSecret?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client root certificate of virtual network gateway␊ - */␊ - export interface VpnClientRootCertificate18 {␊ - /**␊ - * Properties of the vpn client root certificate.␊ - */␊ - properties: (VpnClientRootCertificatePropertiesFormat18 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of application gateway␊ - */␊ - export interface VpnClientRootCertificatePropertiesFormat18 {␊ - /**␊ - * The certificate public data.␊ - */␊ - publicCertData: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client revoked certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRevokedCertificate18 {␊ - /**␊ - * Properties of the vpn client revoked certificate.␊ - */␊ - properties?: (VpnClientRevokedCertificatePropertiesFormat18 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the revoked VPN client certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRevokedCertificatePropertiesFormat18 {␊ - /**␊ - * The revoked VPN client certificate thumbprint.␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An IPSec Policy configuration for a virtual network gateway connection␊ - */␊ - export interface IpsecPolicy16 {␊ - /**␊ - * The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.␊ - */␊ - saLifeTimeSeconds: (number | string)␊ - /**␊ - * The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.␊ - */␊ - saDataSizeKilobytes: (number | string)␊ - /**␊ - * The IPSec encryption algorithm (IKE phase 1).␊ - */␊ - ipsecEncryption: (("None" | "DES" | "DES3" | "AES128" | "AES192" | "AES256" | "GCMAES128" | "GCMAES192" | "GCMAES256") | string)␊ - /**␊ - * The IPSec integrity algorithm (IKE phase 1).␊ - */␊ - ipsecIntegrity: (("MD5" | "SHA1" | "SHA256" | "GCMAES128" | "GCMAES192" | "GCMAES256") | string)␊ - /**␊ - * The IKE encryption algorithm (IKE phase 2).␊ - */␊ - ikeEncryption: (("DES" | "DES3" | "AES128" | "AES192" | "AES256" | "GCMAES256" | "GCMAES128") | string)␊ - /**␊ - * The IKE integrity algorithm (IKE phase 2).␊ - */␊ - ikeIntegrity: (("MD5" | "SHA1" | "SHA256" | "SHA384" | "GCMAES256" | "GCMAES128") | string)␊ - /**␊ - * The DH Groups used in IKE Phase 1 for initial SA.␊ - */␊ - dhGroup: (("None" | "DHGroup1" | "DHGroup2" | "DHGroup14" | "DHGroup2048" | "ECP256" | "ECP384" | "DHGroup24") | string)␊ - /**␊ - * The Pfs Groups used in IKE Phase 2 for new child SA.␊ - */␊ - pfsGroup: (("None" | "PFS1" | "PFS2" | "PFS2048" | "ECP256" | "ECP384" | "PFS24" | "PFS14" | "PFSMM") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * BGP settings details␊ - */␊ - export interface BgpSettings18 {␊ - /**␊ - * The BGP speaker's ASN.␊ - */␊ - asn?: (number | string)␊ - /**␊ - * The BGP peering address and BGP identifier of this BGP speaker.␊ - */␊ - bgpPeeringAddress?: string␊ - /**␊ - * The weight added to routes learned from this BGP speaker.␊ - */␊ - peerWeight?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A common class for general resource information␊ - */␊ - export interface LocalNetworkGateway10 {␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the local network gateway.␊ - */␊ - properties: (LocalNetworkGatewayPropertiesFormat19 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * LocalNetworkGateway properties␊ - */␊ - export interface LocalNetworkGatewayPropertiesFormat19 {␊ - /**␊ - * Local network site address space.␊ - */␊ - localNetworkAddressSpace?: (AddressSpace23 | string)␊ - /**␊ - * IP address of local network gateway.␊ - */␊ - gatewayIpAddress?: string␊ - /**␊ - * Local network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings18 | string)␊ - /**␊ - * The resource GUID property of the LocalNetworkGateway resource.␊ - */␊ - resourceGuid?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/localNetworkGateways␊ - */␊ - export interface LocalNetworkGateways19 {␊ - name: string␊ - type: "Microsoft.Network/localNetworkGateways"␊ - apiVersion: "2018-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the local network gateway.␊ - */␊ - properties: (LocalNetworkGatewayPropertiesFormat19 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworkGateways␊ - */␊ - export interface VirtualNetworkGateways19 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworkGateways"␊ - apiVersion: "2018-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway.␊ - */␊ - properties: (VirtualNetworkGatewayPropertiesFormat19 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnets19 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks/subnets"␊ - apiVersion: "2018-12-01"␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties: (SubnetPropertiesFormat15 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/virtualNetworkPeerings␊ - */␊ - export interface VirtualNetworksVirtualNetworkPeerings16 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks/virtualNetworkPeerings"␊ - apiVersion: "2018-12-01"␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties: (VirtualNetworkPeeringPropertiesFormat12 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ddosProtectionPlans␊ - */␊ - export interface DdosProtectionPlans13 {␊ - name: string␊ - type: "Microsoft.Network/ddosProtectionPlans"␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the DDoS protection plan.␊ - */␊ - properties: (DdosProtectionPlanPropertiesFormat10 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DDoS protection plan properties.␊ - */␊ - export interface DdosProtectionPlanPropertiesFormat10 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits␊ - */␊ - export interface ExpressRouteCircuits15 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits"␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The SKU.␊ - */␊ - sku?: (ExpressRouteCircuitSku15 | string)␊ - properties: (ExpressRouteCircuitPropertiesFormat15 | string)␊ - resources?: (ExpressRouteCircuitsPeeringsChildResource15 | ExpressRouteCircuitsAuthorizationsChildResource15)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains SKU in an ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitSku15 {␊ - /**␊ - * The name of the SKU.␊ - */␊ - name?: string␊ - /**␊ - * The tier of the SKU. Possible values are 'Standard', 'Premium' or 'Basic'.␊ - */␊ - tier?: (("Standard" | "Premium" | "Basic") | string)␊ - /**␊ - * The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'.␊ - */␊ - family?: (("UnlimitedData" | "MeteredData") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitPropertiesFormat15 {␊ - /**␊ - * Allow classic operations␊ - */␊ - allowClassicOperations?: (boolean | string)␊ - /**␊ - * The CircuitProvisioningState state of the resource.␊ - */␊ - circuitProvisioningState?: string␊ - /**␊ - * The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'.␊ - */␊ - serviceProviderProvisioningState?: (("NotProvisioned" | "Provisioning" | "Provisioned" | "Deprovisioning") | string)␊ - /**␊ - * The list of authorizations.␊ - */␊ - authorizations?: (ExpressRouteCircuitAuthorization15[] | string)␊ - /**␊ - * The list of peerings.␊ - */␊ - peerings?: (ExpressRouteCircuitPeering15[] | string)␊ - /**␊ - * The ServiceKey.␊ - */␊ - serviceKey?: string␊ - /**␊ - * The ServiceProviderNotes.␊ - */␊ - serviceProviderNotes?: string␊ - /**␊ - * The ServiceProviderProperties.␊ - */␊ - serviceProviderProperties?: (ExpressRouteCircuitServiceProviderProperties15 | string)␊ - /**␊ - * The reference to the ExpressRoutePort resource when the circuit is provisioned on an ExpressRoutePort resource.␊ - */␊ - expressRoutePort?: (SubResource28 | string)␊ - /**␊ - * The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource.␊ - */␊ - bandwidthInGbps?: (number | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - /**␊ - * Flag to enable Global Reach on the circuit.␊ - */␊ - allowGlobalReach?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authorization in an ExpressRouteCircuit resource.␊ - */␊ - export interface ExpressRouteCircuitAuthorization15 {␊ - properties?: (AuthorizationPropertiesFormat16 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - export interface AuthorizationPropertiesFormat16 {␊ - /**␊ - * The authorization key.␊ - */␊ - authorizationKey?: string␊ - /**␊ - * AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'.␊ - */␊ - authorizationUseStatus?: (("Available" | "InUse") | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peering in an ExpressRouteCircuit resource.␊ - */␊ - export interface ExpressRouteCircuitPeering15 {␊ - properties?: (ExpressRouteCircuitPeeringPropertiesFormat16 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - export interface ExpressRouteCircuitPeeringPropertiesFormat16 {␊ - /**␊ - * The peering type.␊ - */␊ - peeringType?: (("AzurePublicPeering" | "AzurePrivatePeering" | "MicrosoftPeering") | string)␊ - /**␊ - * The peering state.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * The Azure ASN.␊ - */␊ - azureASN?: (number | string)␊ - /**␊ - * The peer ASN.␊ - */␊ - peerASN?: (number | string)␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The primary port.␊ - */␊ - primaryAzurePort?: string␊ - /**␊ - * The secondary port.␊ - */␊ - secondaryAzurePort?: string␊ - /**␊ - * The shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The VLAN ID.␊ - */␊ - vlanId?: (number | string)␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig16 | string)␊ - /**␊ - * Gets peering stats.␊ - */␊ - stats?: (ExpressRouteCircuitStats16 | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - /**␊ - * Gets whether the provider or the customer last modified the peering.␊ - */␊ - lastModifiedBy?: string␊ - /**␊ - * The reference of the RouteFilter resource.␊ - */␊ - routeFilter?: (SubResource28 | string)␊ - /**␊ - * The IPv6 peering configuration.␊ - */␊ - ipv6PeeringConfig?: (Ipv6ExpressRouteCircuitPeeringConfig13 | string)␊ - /**␊ - * The ExpressRoute connection.␊ - */␊ - expressRouteConnection?: ({␊ - [k: string]: unknown␊ - } | string)␊ - /**␊ - * The list of circuit connections associated with Azure Private Peering for this circuit.␊ - */␊ - connections?: (ExpressRouteCircuitConnection8[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the peering configuration.␊ - */␊ - export interface ExpressRouteCircuitPeeringConfig16 {␊ - /**␊ - * The reference of AdvertisedPublicPrefixes.␊ - */␊ - advertisedPublicPrefixes?: (string[] | string)␊ - /**␊ - * The communities of bgp peering. Specified for microsoft peering␊ - */␊ - advertisedCommunities?: (string[] | string)␊ - /**␊ - * AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'.␊ - */␊ - advertisedPublicPrefixesState?: (("NotConfigured" | "Configuring" | "Configured" | "ValidationNeeded") | string)␊ - /**␊ - * The legacy mode of the peering.␊ - */␊ - legacyMode?: (number | string)␊ - /**␊ - * The CustomerASN of the peering.␊ - */␊ - customerASN?: (number | string)␊ - /**␊ - * The RoutingRegistryName of the configuration.␊ - */␊ - routingRegistryName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains stats associated with the peering.␊ - */␊ - export interface ExpressRouteCircuitStats16 {␊ - /**␊ - * Gets BytesIn of the peering.␊ - */␊ - primarybytesIn?: (number | string)␊ - /**␊ - * Gets BytesOut of the peering.␊ - */␊ - primarybytesOut?: (number | string)␊ - /**␊ - * Gets BytesIn of the peering.␊ - */␊ - secondarybytesIn?: (number | string)␊ - /**␊ - * Gets BytesOut of the peering.␊ - */␊ - secondarybytesOut?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Reference to another subresource.␊ - */␊ - export interface SubResource28 {␊ - /**␊ - * Resource ID.␊ - */␊ - id: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains IPv6 peering config.␊ - */␊ - export interface Ipv6ExpressRouteCircuitPeeringConfig13 {␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig16 | string)␊ - /**␊ - * The reference of the RouteFilter resource.␊ - */␊ - routeFilter?: (SubResource28 | string)␊ - /**␊ - * The state of peering. Possible values are: 'Disabled' and 'Enabled'.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Express Route Circuit Connection in an ExpressRouteCircuitPeering resource.␊ - */␊ - export interface ExpressRouteCircuitConnection8 {␊ - properties?: (ExpressRouteCircuitConnectionPropertiesFormat13 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - export interface ExpressRouteCircuitConnectionPropertiesFormat13 {␊ - /**␊ - * Reference to Express Route Circuit Private Peering Resource of the circuit initiating connection.␊ - */␊ - expressRouteCircuitPeering?: (SubResource28 | string)␊ - /**␊ - * Reference to Express Route Circuit Private Peering Resource of the peered circuit.␊ - */␊ - peerExpressRouteCircuitPeering?: (SubResource28 | string)␊ - /**␊ - * /29 IP address space to carve out Customer addresses for tunnels.␊ - */␊ - addressPrefix?: string␊ - /**␊ - * The authorization key.␊ - */␊ - authorizationKey?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains ServiceProviderProperties in an ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitServiceProviderProperties15 {␊ - /**␊ - * The serviceProviderName.␊ - */␊ - serviceProviderName?: string␊ - /**␊ - * The peering location.␊ - */␊ - peeringLocation?: string␊ - /**␊ - * The BandwidthInMbps.␊ - */␊ - bandwidthInMbps?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings␊ - */␊ - export interface ExpressRouteCircuitsPeeringsChildResource15 {␊ - name: string␊ - type: "peerings"␊ - apiVersion: "2018-11-01"␊ - properties: (ExpressRouteCircuitPeeringPropertiesFormat16 | string)␊ - resources?: ExpressRouteCircuitsPeeringsConnectionsChildResource13[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings/connections␊ - */␊ - export interface ExpressRouteCircuitsPeeringsConnectionsChildResource13 {␊ - name: string␊ - type: "connections"␊ - apiVersion: "2018-11-01"␊ - properties: (ExpressRouteCircuitConnectionPropertiesFormat13 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/authorizations␊ - */␊ - export interface ExpressRouteCircuitsAuthorizationsChildResource15 {␊ - name: string␊ - type: "authorizations"␊ - apiVersion: "2018-11-01"␊ - properties: (AuthorizationPropertiesFormat16 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections␊ - */␊ - export interface ExpressRouteCrossConnections13 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCrossConnections"␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (ExpressRouteCrossConnectionProperties13 | string)␊ - resources?: ExpressRouteCrossConnectionsPeeringsChildResource13[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ExpressRouteCrossConnection.␊ - */␊ - export interface ExpressRouteCrossConnectionProperties13 {␊ - /**␊ - * The peering location of the ExpressRoute circuit.␊ - */␊ - peeringLocation?: string␊ - /**␊ - * The circuit bandwidth In Mbps.␊ - */␊ - bandwidthInMbps?: (number | string)␊ - /**␊ - * The ExpressRouteCircuit␊ - */␊ - expressRouteCircuit?: (ExpressRouteCircuitReference7 | string)␊ - /**␊ - * The provisioning state of the circuit in the connectivity provider system. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned'.␊ - */␊ - serviceProviderProvisioningState?: (("NotProvisioned" | "Provisioning" | "Provisioned" | "Deprovisioning") | string)␊ - /**␊ - * Additional read only notes set by the connectivity provider.␊ - */␊ - serviceProviderNotes?: string␊ - /**␊ - * The list of peerings.␊ - */␊ - peerings?: (ExpressRouteCrossConnectionPeering13[] | string)␊ - [k: string]: unknown␊ - }␊ - export interface ExpressRouteCircuitReference7 {␊ - /**␊ - * Corresponding Express Route Circuit Id.␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peering in an ExpressRoute Cross Connection resource.␊ - */␊ - export interface ExpressRouteCrossConnectionPeering13 {␊ - properties?: (ExpressRouteCrossConnectionPeeringProperties13 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - export interface ExpressRouteCrossConnectionPeeringProperties13 {␊ - /**␊ - * The peering type.␊ - */␊ - peeringType?: (("AzurePublicPeering" | "AzurePrivatePeering" | "MicrosoftPeering") | string)␊ - /**␊ - * The peering state.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * The peer ASN.␊ - */␊ - peerASN?: (number | string)␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The VLAN ID.␊ - */␊ - vlanId?: (number | string)␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig16 | string)␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - /**␊ - * Gets whether the provider or the customer last modified the peering.␊ - */␊ - lastModifiedBy?: string␊ - /**␊ - * The IPv6 peering configuration.␊ - */␊ - ipv6PeeringConfig?: (Ipv6ExpressRouteCircuitPeeringConfig13 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections/peerings␊ - */␊ - export interface ExpressRouteCrossConnectionsPeeringsChildResource13 {␊ - name: string␊ - type: "peerings"␊ - apiVersion: "2018-11-01"␊ - properties: (ExpressRouteCrossConnectionPeeringProperties13 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/publicIPAddresses␊ - */␊ - export interface PublicIPAddresses30 {␊ - name: string␊ - type: "Microsoft.Network/publicIPAddresses"␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The public IP address SKU.␊ - */␊ - sku?: (PublicIPAddressSku18 | string)␊ - /**␊ - * Public IP address properties.␊ - */␊ - properties: (PublicIPAddressPropertiesFormat21 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a public IP address␊ - */␊ - export interface PublicIPAddressSku18 {␊ - /**␊ - * Name of a public IP address SKU.␊ - */␊ - name?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Public IP address properties.␊ - */␊ - export interface PublicIPAddressPropertiesFormat21 {␊ - /**␊ - * The public IP allocation method. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - publicIPAllocationMethod: (("Static" | "Dynamic") | string)␊ - /**␊ - * The public IP address version. Possible values are: 'IPv4' and 'IPv6'.␊ - */␊ - publicIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The FQDN of the DNS record associated with the public IP address.␊ - */␊ - dnsSettings?: (PublicIPAddressDnsSettings29 | string)␊ - /**␊ - * The DDoS protection custom policy associated with the public IP address.␊ - */␊ - ddosSettings?: (DdosSettings7 | string)␊ - /**␊ - * The list of tags associated with the public IP address.␊ - */␊ - ipTags?: (IpTag15[] | string)␊ - /**␊ - * The IP address associated with the public IP address resource.␊ - */␊ - ipAddress?: string␊ - /**␊ - * The Public IP Prefix this Public IP Address should be allocated from.␊ - */␊ - publicIPPrefix?: (SubResource28 | string)␊ - /**␊ - * The idle timeout of the public IP address.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * The resource GUID property of the public IP resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains FQDN of the DNS record associated with the public IP address␊ - */␊ - export interface PublicIPAddressDnsSettings29 {␊ - /**␊ - * Gets or sets the Domain name label.The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.␊ - */␊ - domainNameLabel: string␊ - /**␊ - * Gets the FQDN, Fully qualified domain name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone.␊ - */␊ - fqdn?: string␊ - /**␊ - * Gets or Sets the Reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN. ␊ - */␊ - reverseFqdn?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains the DDoS protection settings of the public IP.␊ - */␊ - export interface DdosSettings7 {␊ - /**␊ - * The DDoS custom policy associated with the public IP.␊ - */␊ - ddosCustomPolicy?: (SubResource28 | string)␊ - /**␊ - * The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized.␊ - */␊ - protectionCoverage?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains the IpTag associated with the object␊ - */␊ - export interface IpTag15 {␊ - /**␊ - * Gets or sets the ipTag type: Example FirstPartyUsage.␊ - */␊ - ipTagType?: string␊ - /**␊ - * Gets or sets value of the IpTag associated with the public IP. Example SQL, Storage etc␊ - */␊ - tag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks␊ - */␊ - export interface VirtualNetworks30 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks"␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network.␊ - */␊ - properties: (VirtualNetworkPropertiesFormat22 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: (VirtualNetworksVirtualNetworkPeeringsChildResource19 | VirtualNetworksSubnetsChildResource22)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the virtual network.␊ - */␊ - export interface VirtualNetworkPropertiesFormat22 {␊ - /**␊ - * The AddressSpace that contains an array of IP address ranges that can be used by subnets.␊ - */␊ - addressSpace: (AddressSpace30 | string)␊ - /**␊ - * The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network.␊ - */␊ - dhcpOptions?: (DhcpOptions30 | string)␊ - /**␊ - * A list of subnets in a Virtual Network.␊ - */␊ - subnets?: (Subnet32[] | string)␊ - /**␊ - * A list of peerings in a Virtual Network.␊ - */␊ - virtualNetworkPeerings?: (VirtualNetworkPeering27[] | string)␊ - /**␊ - * The resourceGuid property of the Virtual Network resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - /**␊ - * Indicates if DDoS protection is enabled for all the protected resources in the virtual network. It requires a DDoS protection plan associated with the resource.␊ - */␊ - enableDdosProtection?: (boolean | string)␊ - /**␊ - * Indicates if VM protection is enabled for all the subnets in the virtual network.␊ - */␊ - enableVmProtection?: (boolean | string)␊ - /**␊ - * The DDoS protection plan associated with the virtual network.␊ - */␊ - ddosProtectionPlan?: (SubResource28 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.␊ - */␊ - export interface AddressSpace30 {␊ - /**␊ - * A list of address blocks reserved for this virtual network in CIDR notation.␊ - */␊ - addressPrefixes: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DhcpOptions contains an array of DNS servers available to VMs deployed in the virtual network. Standard DHCP option for a subnet overrides VNET DHCP options.␊ - */␊ - export interface DhcpOptions30 {␊ - /**␊ - * The list of DNS servers IP addresses.␊ - */␊ - dnsServers: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Subnet in a virtual network resource.␊ - */␊ - export interface Subnet32 {␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties?: (SubnetPropertiesFormat22 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the subnet.␊ - */␊ - export interface SubnetPropertiesFormat22 {␊ - /**␊ - * The address prefix for the subnet.␊ - */␊ - addressPrefix: string␊ - /**␊ - * List of address prefixes for the subnet.␊ - */␊ - addressPrefixes?: (string[] | string)␊ - /**␊ - * The reference of the NetworkSecurityGroup resource.␊ - */␊ - networkSecurityGroup?: (SubResource28 | string)␊ - /**␊ - * The reference of the RouteTable resource.␊ - */␊ - routeTable?: (SubResource28 | string)␊ - /**␊ - * An array of service endpoints.␊ - */␊ - serviceEndpoints?: (ServiceEndpointPropertiesFormat18[] | string)␊ - /**␊ - * An array of service endpoint policies.␊ - */␊ - serviceEndpointPolicies?: (SubResource28[] | string)␊ - /**␊ - * Gets an array of references to the external resources using subnet.␊ - */␊ - resourceNavigationLinks?: (ResourceNavigationLink14[] | string)␊ - /**␊ - * Gets an array of references to services injecting into this subnet.␊ - */␊ - serviceAssociationLinks?: (ServiceAssociationLink4[] | string)␊ - /**␊ - * Gets an array of references to the delegations on the subnet.␊ - */␊ - delegations?: (Delegation9[] | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The service endpoint properties.␊ - */␊ - export interface ServiceEndpointPropertiesFormat18 {␊ - /**␊ - * The type of the endpoint service.␊ - */␊ - service?: string␊ - /**␊ - * A list of locations.␊ - */␊ - locations?: (string[] | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ResourceNavigationLink resource.␊ - */␊ - export interface ResourceNavigationLink14 {␊ - /**␊ - * Resource navigation link properties format.␊ - */␊ - properties?: (ResourceNavigationLinkFormat14 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ResourceNavigationLink.␊ - */␊ - export interface ResourceNavigationLinkFormat14 {␊ - /**␊ - * Resource type of the linked resource.␊ - */␊ - linkedResourceType?: string␊ - /**␊ - * Link to the external resource␊ - */␊ - link?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ServiceAssociationLink resource.␊ - */␊ - export interface ServiceAssociationLink4 {␊ - /**␊ - * Resource navigation link properties format.␊ - */␊ - properties?: (ServiceAssociationLinkPropertiesFormat4 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ServiceAssociationLink.␊ - */␊ - export interface ServiceAssociationLinkPropertiesFormat4 {␊ - /**␊ - * Resource type of the linked resource.␊ - */␊ - linkedResourceType?: string␊ - /**␊ - * Link to the external resource.␊ - */␊ - link?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Details the service to which the subnet is delegated.␊ - */␊ - export interface Delegation9 {␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties?: (ServiceDelegationPropertiesFormat9 | string)␊ - /**␊ - * The name of the resource that is unique within a subnet. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a service delegation.␊ - */␊ - export interface ServiceDelegationPropertiesFormat9 {␊ - /**␊ - * The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers)␊ - */␊ - serviceName?: string␊ - /**␊ - * Describes the actions permitted to the service upon delegation␊ - */␊ - actions?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peerings in a virtual network resource.␊ - */␊ - export interface VirtualNetworkPeering27 {␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties?: (VirtualNetworkPeeringPropertiesFormat19 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - export interface VirtualNetworkPeeringPropertiesFormat19 {␊ - /**␊ - * Whether the VMs in the linked virtual network space would be able to access all the VMs in local Virtual network space.␊ - */␊ - allowVirtualNetworkAccess?: (boolean | string)␊ - /**␊ - * Whether the forwarded traffic from the VMs in the remote virtual network will be allowed/disallowed.␊ - */␊ - allowForwardedTraffic?: (boolean | string)␊ - /**␊ - * If gateway links can be used in remote virtual networking to link to this virtual network.␊ - */␊ - allowGatewayTransit?: (boolean | string)␊ - /**␊ - * If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway.␊ - */␊ - useRemoteGateways?: (boolean | string)␊ - /**␊ - * The reference of the remote virtual network. The remote virtual network can be in the same or different region (preview). See here to register for the preview and learn more (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering).␊ - */␊ - remoteVirtualNetwork: (SubResource28 | string)␊ - /**␊ - * The reference of the remote virtual network address space.␊ - */␊ - remoteAddressSpace?: (AddressSpace30 | string)␊ - /**␊ - * The status of the virtual network peering. Possible values are 'Initiated', 'Connected', and 'Disconnected'.␊ - */␊ - peeringState?: (("Initiated" | "Connected" | "Disconnected") | string)␊ - /**␊ - * The provisioning state of the resource.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/virtualNetworkPeerings␊ - */␊ - export interface VirtualNetworksVirtualNetworkPeeringsChildResource19 {␊ - name: string␊ - type: "virtualNetworkPeerings"␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties: (VirtualNetworkPeeringPropertiesFormat19 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnetsChildResource22 {␊ - name: string␊ - type: "subnets"␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties: (SubnetPropertiesFormat22 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers␊ - */␊ - export interface LoadBalancers30 {␊ - name: string␊ - type: "Microsoft.Network/loadBalancers"␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The load balancer SKU.␊ - */␊ - sku?: (LoadBalancerSku18 | string)␊ - /**␊ - * Properties of load balancer.␊ - */␊ - properties: (LoadBalancerPropertiesFormat22 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: LoadBalancersInboundNatRulesChildResource18[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a load balancer␊ - */␊ - export interface LoadBalancerSku18 {␊ - /**␊ - * Name of a load balancer SKU.␊ - */␊ - name?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer.␊ - */␊ - export interface LoadBalancerPropertiesFormat22 {␊ - /**␊ - * Object representing the frontend IPs to be used for the load balancer␊ - */␊ - frontendIPConfigurations?: (FrontendIPConfiguration21[] | string)␊ - /**␊ - * Collection of backend address pools used by a load balancer␊ - */␊ - backendAddressPools?: (BackendAddressPool22[] | string)␊ - /**␊ - * Object collection representing the load balancing rules Gets the provisioning ␊ - */␊ - loadBalancingRules?: (LoadBalancingRule22[] | string)␊ - /**␊ - * Collection of probe objects used in the load balancer␊ - */␊ - probes?: (Probe22[] | string)␊ - /**␊ - * Collection of inbound NAT Rules used by a load balancer. Defining inbound NAT rules on your load balancer is mutually exclusive with defining an inbound NAT pool. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an Inbound NAT pool. They have to reference individual inbound NAT rules.␊ - */␊ - inboundNatRules?: (InboundNatRule23[] | string)␊ - /**␊ - * Defines an external port range for inbound NAT to a single backend port on NICs associated with a load balancer. Inbound NAT rules are created automatically for each NIC associated with the Load Balancer using an external port from this range. Defining an Inbound NAT pool on your Load Balancer is mutually exclusive with defining inbound Nat rules. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an inbound NAT pool. They have to reference individual inbound NAT rules.␊ - */␊ - inboundNatPools?: (InboundNatPool23[] | string)␊ - /**␊ - * The outbound rules.␊ - */␊ - outboundRules?: (OutboundRule10[] | string)␊ - /**␊ - * The resource GUID property of the load balancer resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP address of the load balancer.␊ - */␊ - export interface FrontendIPConfiguration21 {␊ - /**␊ - * Properties of the load balancer probe.␊ - */␊ - properties?: (FrontendIPConfigurationPropertiesFormat21 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP Configuration of the load balancer.␊ - */␊ - export interface FrontendIPConfigurationPropertiesFormat21 {␊ - /**␊ - * The private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The Private IP allocation method. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * The reference of the subnet resource.␊ - */␊ - subnet?: (SubResource28 | string)␊ - /**␊ - * The reference of the Public IP resource.␊ - */␊ - publicIPAddress?: (SubResource28 | string)␊ - /**␊ - * The reference of the Public IP Prefix resource.␊ - */␊ - publicIPPrefix?: (SubResource28 | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Pool of backend IP addresses.␊ - */␊ - export interface BackendAddressPool22 {␊ - /**␊ - * Properties of load balancer backend address pool.␊ - */␊ - properties?: (BackendAddressPoolPropertiesFormat22 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the backend address pool.␊ - */␊ - export interface BackendAddressPoolPropertiesFormat22 {␊ - /**␊ - * Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A load balancing rule for a load balancer.␊ - */␊ - export interface LoadBalancingRule22 {␊ - /**␊ - * Properties of load balancer load balancing rule.␊ - */␊ - properties?: (LoadBalancingRulePropertiesFormat22 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer.␊ - */␊ - export interface LoadBalancingRulePropertiesFormat22 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource28 | string)␊ - /**␊ - * A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs.␊ - */␊ - backendAddressPool?: (SubResource28 | string)␊ - /**␊ - * The reference of the load balancer probe used by the load balancing rule.␊ - */␊ - probe?: (SubResource28 | string)␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'.␊ - */␊ - loadDistribution?: (("Default" | "SourceIP" | "SourceIPProtocol") | string)␊ - /**␊ - * The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 0 and 65534. Note that value 0 enables "Any Port"␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port"␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - /**␊ - * Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule.␊ - */␊ - disableOutboundSnat?: (boolean | string)␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A load balancer probe.␊ - */␊ - export interface Probe22 {␊ - /**␊ - * Properties of load balancer probe.␊ - */␊ - properties?: (ProbePropertiesFormat22 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Load balancer probe resource.␊ - */␊ - export interface ProbePropertiesFormat22 {␊ - /**␊ - * The protocol of the end point. Possible values are: 'Http', 'Tcp', or 'Https'. If 'Tcp' is specified, a received ACK is required for the probe to be successful. If 'Http' or 'Https' is specified, a 200 OK response from the specifies URI is required for the probe to be successful.␊ - */␊ - protocol: (("Http" | "Tcp" | "Https") | string)␊ - /**␊ - * The port for communicating the probe. Possible values range from 1 to 65535, inclusive.␊ - */␊ - port: (number | string)␊ - /**␊ - * The interval, in seconds, for how frequently to probe the endpoint for health status. Typically, the interval is slightly less than half the allocated timeout period (in seconds) which allows two full probes before taking the instance out of rotation. The default value is 15, the minimum value is 5.␊ - */␊ - intervalInSeconds?: (number | string)␊ - /**␊ - * The number of probes where if no response, will result in stopping further traffic from being delivered to the endpoint. This values allows endpoints to be taken out of rotation faster or slower than the typical times used in Azure.␊ - */␊ - numberOfProbes: (number | string)␊ - /**␊ - * The URI used for requesting health status from the VM. Path is required if a protocol is set to http. Otherwise, it is not allowed. There is no default value.␊ - */␊ - requestPath?: string␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT rule of the load balancer.␊ - */␊ - export interface InboundNatRule23 {␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties?: (InboundNatRulePropertiesFormat22 | string)␊ - /**␊ - * Gets name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the inbound NAT rule.␊ - */␊ - export interface InboundNatRulePropertiesFormat22 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource28 | string)␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values range from 1 to 65534.␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * The port used for the internal endpoint. Acceptable values range from 1 to 65535.␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - /**␊ - * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT pool of the load balancer.␊ - */␊ - export interface InboundNatPool23 {␊ - /**␊ - * Properties of load balancer inbound nat pool.␊ - */␊ - properties?: (InboundNatPoolPropertiesFormat22 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Inbound NAT pool.␊ - */␊ - export interface InboundNatPoolPropertiesFormat22 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource28 | string)␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65534.␊ - */␊ - frontendPortRangeStart: (number | string)␊ - /**␊ - * The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65535.␊ - */␊ - frontendPortRangeEnd: (number | string)␊ - /**␊ - * The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound pool of the load balancer.␊ - */␊ - export interface OutboundRule10 {␊ - /**␊ - * Properties of load balancer outbound rule.␊ - */␊ - properties?: (OutboundRulePropertiesFormat10 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound pool of the load balancer.␊ - */␊ - export interface OutboundRulePropertiesFormat10 {␊ - /**␊ - * The number of outbound ports to be used for NAT.␊ - */␊ - allocatedOutboundPorts?: (number | string)␊ - /**␊ - * The Frontend IP addresses of the load balancer.␊ - */␊ - frontendIPConfigurations: (SubResource28[] | string)␊ - /**␊ - * A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs.␊ - */␊ - backendAddressPool: (SubResource28 | string)␊ - /**␊ - * Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - /**␊ - * Protocol - TCP, UDP or All.␊ - */␊ - protocol: (("Tcp" | "Udp" | "All") | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - /**␊ - * The timeout for the TCP idle connection␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers/inboundNatRules␊ - */␊ - export interface LoadBalancersInboundNatRulesChildResource18 {␊ - name: string␊ - type: "inboundNatRules"␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties: (InboundNatRulePropertiesFormat22 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups␊ - */␊ - export interface NetworkSecurityGroups30 {␊ - name: string␊ - type: "Microsoft.Network/networkSecurityGroups"␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network security group␊ - */␊ - properties: (NetworkSecurityGroupPropertiesFormat22 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: NetworkSecurityGroupsSecurityRulesChildResource22[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network Security Group resource.␊ - */␊ - export interface NetworkSecurityGroupPropertiesFormat22 {␊ - /**␊ - * A collection of security rules of the network security group.␊ - */␊ - securityRules?: (SecurityRule22[] | string)␊ - /**␊ - * The default security rules of network security group.␊ - */␊ - defaultSecurityRules?: (SecurityRule22[] | string)␊ - /**␊ - * The resource GUID property of the network security group resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network security rule.␊ - */␊ - export interface SecurityRule22 {␊ - /**␊ - * Properties of the security rule␊ - */␊ - properties?: (SecurityRulePropertiesFormat22 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Security rule resource.␊ - */␊ - export interface SecurityRulePropertiesFormat22 {␊ - /**␊ - * A description for this rule. Restricted to 140 chars.␊ - */␊ - description?: string␊ - /**␊ - * Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'.␊ - */␊ - protocol: (("Tcp" | "Udp" | "*") | string)␊ - /**␊ - * The source port or range. Integer or range between 0 and 65535. Asterisks '*' can also be used to match all ports.␊ - */␊ - sourcePortRange: string␊ - /**␊ - * The destination port or range. Integer or range between 0 and 65535. Asterisks '*' can also be used to match all ports.␊ - */␊ - destinationPortRange: string␊ - /**␊ - * The CIDR or source IP range. Asterisks '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. ␊ - */␊ - sourceAddressPrefix: string␊ - /**␊ - * The CIDR or source IP ranges.␊ - */␊ - sourceAddressPrefixes?: (string[] | string)␊ - /**␊ - * The application security group specified as source.␊ - */␊ - sourceApplicationSecurityGroups?: (SubResource28[] | string)␊ - /**␊ - * The destination address prefix. CIDR or destination IP range. Asterisks '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used.␊ - */␊ - destinationAddressPrefix: string␊ - /**␊ - * The destination address prefixes. CIDR or destination IP ranges.␊ - */␊ - destinationAddressPrefixes?: (string[] | string)␊ - /**␊ - * The application security group specified as destination.␊ - */␊ - destinationApplicationSecurityGroups?: (SubResource28[] | string)␊ - /**␊ - * The source port ranges.␊ - */␊ - sourcePortRanges?: (string[] | string)␊ - /**␊ - * The destination port ranges.␊ - */␊ - destinationPortRanges?: (string[] | string)␊ - /**␊ - * The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'.␊ - */␊ - access: (("Allow" | "Deny") | string)␊ - /**␊ - * The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.␊ - */␊ - priority: (number | string)␊ - /**␊ - * The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. Possible values are: 'Inbound' and 'Outbound'.␊ - */␊ - direction: (("Inbound" | "Outbound") | string)␊ - /**␊ - * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRulesChildResource22 {␊ - name: string␊ - type: "securityRules"␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Properties of the security rule␊ - */␊ - properties: (SecurityRulePropertiesFormat22 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces␊ - */␊ - export interface NetworkInterfaces31 {␊ - name: string␊ - type: "Microsoft.Network/networkInterfaces"␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network interface.␊ - */␊ - properties: (NetworkInterfacePropertiesFormat22 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: NetworkInterfacesTapConfigurationsChildResource9[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NetworkInterface properties. ␊ - */␊ - export interface NetworkInterfacePropertiesFormat22 {␊ - /**␊ - * The reference of the NetworkSecurityGroup resource.␊ - */␊ - networkSecurityGroup?: (SubResource28 | string)␊ - /**␊ - * A list of IPConfigurations of the network interface.␊ - */␊ - ipConfigurations: (NetworkInterfaceIPConfiguration21[] | string)␊ - /**␊ - * A list of TapConfigurations of the network interface.␊ - */␊ - tapConfigurations?: (NetworkInterfaceTapConfiguration4[] | string)␊ - /**␊ - * The DNS settings in network interface.␊ - */␊ - dnsSettings?: (NetworkInterfaceDnsSettings30 | string)␊ - /**␊ - * The MAC address of the network interface.␊ - */␊ - macAddress?: string␊ - /**␊ - * Gets whether this is a primary network interface on a virtual machine.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * If the network interface is accelerated networking enabled.␊ - */␊ - enableAcceleratedNetworking?: (boolean | string)␊ - /**␊ - * Indicates whether IP forwarding is enabled on this network interface.␊ - */␊ - enableIPForwarding?: (boolean | string)␊ - /**␊ - * The resource GUID property of the network interface resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IPConfiguration in a network interface.␊ - */␊ - export interface NetworkInterfaceIPConfiguration21 {␊ - /**␊ - * Network interface IP configuration properties.␊ - */␊ - properties?: (NetworkInterfaceIPConfigurationPropertiesFormat21 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration.␊ - */␊ - export interface NetworkInterfaceIPConfigurationPropertiesFormat21 {␊ - /**␊ - * The reference to Virtual Network Taps.␊ - */␊ - virtualNetworkTaps?: (SubResource28[] | string)␊ - /**␊ - * The reference of ApplicationGatewayBackendAddressPool resource.␊ - */␊ - applicationGatewayBackendAddressPools?: (SubResource28[] | string)␊ - /**␊ - * The reference of LoadBalancerBackendAddressPool resource.␊ - */␊ - loadBalancerBackendAddressPools?: (SubResource28[] | string)␊ - /**␊ - * A list of references of LoadBalancerInboundNatRules.␊ - */␊ - loadBalancerInboundNatRules?: (SubResource28[] | string)␊ - /**␊ - * Private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * Defines how a private IP address is assigned. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Available from Api-Version 2016-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.␊ - */␊ - privateIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * Subnet bound to the IP configuration.␊ - */␊ - subnet?: (SubResource28 | string)␊ - /**␊ - * Gets whether this is a primary customer address on the network interface.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * Public IP address bound to the IP configuration.␊ - */␊ - publicIPAddress?: (SubResource28 | string)␊ - /**␊ - * Application security groups in which the IP configuration is included.␊ - */␊ - applicationSecurityGroups?: (SubResource28[] | string)␊ - /**␊ - * The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Tap configuration in a Network Interface␊ - */␊ - export interface NetworkInterfaceTapConfiguration4 {␊ - /**␊ - * Properties of the Virtual Network Tap configuration␊ - */␊ - properties?: (NetworkInterfaceTapConfigurationPropertiesFormat9 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Virtual Network Tap configuration.␊ - */␊ - export interface NetworkInterfaceTapConfigurationPropertiesFormat9 {␊ - /**␊ - * The reference of the Virtual Network Tap resource.␊ - */␊ - virtualNetworkTap?: (SubResource28 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DNS settings of a network interface.␊ - */␊ - export interface NetworkInterfaceDnsSettings30 {␊ - /**␊ - * List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only value in dnsServers collection.␊ - */␊ - dnsServers?: (string[] | string)␊ - /**␊ - * If the VM that uses this NIC is part of an Availability Set, then this list will have the union of all DNS servers from all NICs that are part of the Availability Set. This property is what is configured on each of those VMs.␊ - */␊ - appliedDnsServers?: (string[] | string)␊ - /**␊ - * Relative DNS name for this NIC used for internal communications between VMs in the same virtual network.␊ - */␊ - internalDnsNameLabel?: string␊ - /**␊ - * Fully qualified DNS name supporting internal communications between VMs in the same virtual network.␊ - */␊ - internalFqdn?: string␊ - /**␊ - * Even if internalDnsNameLabel is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internalDomainNameSuffix.␊ - */␊ - internalDomainNameSuffix?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces/tapConfigurations␊ - */␊ - export interface NetworkInterfacesTapConfigurationsChildResource9 {␊ - name: string␊ - type: "tapConfigurations"␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Properties of the Virtual Network Tap configuration␊ - */␊ - properties: (NetworkInterfaceTapConfigurationPropertiesFormat9 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables␊ - */␊ - export interface RouteTables30 {␊ - name: string␊ - type: "Microsoft.Network/routeTables"␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the route table.␊ - */␊ - properties: (RouteTablePropertiesFormat22 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - resources?: RouteTablesRoutesChildResource22[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Table resource␊ - */␊ - export interface RouteTablePropertiesFormat22 {␊ - /**␊ - * Collection of routes contained within a route table.␊ - */␊ - routes?: (Route22[] | string)␊ - /**␊ - * Gets or sets whether to disable the routes learned by BGP on that route table. True means disable.␊ - */␊ - disableBgpRoutePropagation?: (boolean | string)␊ - /**␊ - * The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource␊ - */␊ - export interface Route22 {␊ - /**␊ - * Properties of the route.␊ - */␊ - properties?: (RoutePropertiesFormat22 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource␊ - */␊ - export interface RoutePropertiesFormat22 {␊ - /**␊ - * The destination CIDR to which the route applies.␊ - */␊ - addressPrefix: string␊ - /**␊ - * The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'.␊ - */␊ - nextHopType: (("VirtualNetworkGateway" | "VnetLocal" | "Internet" | "VirtualAppliance" | "None") | string)␊ - /**␊ - * The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.␊ - */␊ - nextHopIpAddress?: string␊ - /**␊ - * The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutesChildResource22 {␊ - name: string␊ - type: "routes"␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Properties of the route.␊ - */␊ - properties: (RoutePropertiesFormat22 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/applicationGateways␊ - */␊ - export interface ApplicationGateways21 {␊ - name: string␊ - type: "Microsoft.Network/applicationGateways"␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (ApplicationGatewayPropertiesFormat21 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * A list of availability zones denoting where the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - /**␊ - * The identity of the application gateway, if configured.␊ - */␊ - identity?: (ManagedServiceIdentity8 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application gateway.␊ - */␊ - export interface ApplicationGatewayPropertiesFormat21 {␊ - /**␊ - * SKU of the application gateway resource.␊ - */␊ - sku?: (ApplicationGatewaySku21 | string)␊ - /**␊ - * SSL policy of the application gateway resource.␊ - */␊ - sslPolicy?: (ApplicationGatewaySslPolicy18 | string)␊ - /**␊ - * Subnets of application the gateway resource.␊ - */␊ - gatewayIPConfigurations?: (ApplicationGatewayIPConfiguration21[] | string)␊ - /**␊ - * Authentication certificates of the application gateway resource.␊ - */␊ - authenticationCertificates?: (ApplicationGatewayAuthenticationCertificate18[] | string)␊ - /**␊ - * Trusted Root certificates of the application gateway resource.␊ - */␊ - trustedRootCertificates?: (ApplicationGatewayTrustedRootCertificate9[] | string)␊ - /**␊ - * SSL certificates of the application gateway resource.␊ - */␊ - sslCertificates?: (ApplicationGatewaySslCertificate21[] | string)␊ - /**␊ - * Frontend IP addresses of the application gateway resource.␊ - */␊ - frontendIPConfigurations?: (ApplicationGatewayFrontendIPConfiguration21[] | string)␊ - /**␊ - * Frontend ports of the application gateway resource.␊ - */␊ - frontendPorts?: (ApplicationGatewayFrontendPort21[] | string)␊ - /**␊ - * Probes of the application gateway resource.␊ - */␊ - probes?: (ApplicationGatewayProbe20[] | string)␊ - /**␊ - * Backend address pool of the application gateway resource.␊ - */␊ - backendAddressPools?: (ApplicationGatewayBackendAddressPool21[] | string)␊ - /**␊ - * Backend http settings of the application gateway resource.␊ - */␊ - backendHttpSettingsCollection?: (ApplicationGatewayBackendHttpSettings21[] | string)␊ - /**␊ - * Http listeners of the application gateway resource.␊ - */␊ - httpListeners?: (ApplicationGatewayHttpListener21[] | string)␊ - /**␊ - * URL path map of the application gateway resource.␊ - */␊ - urlPathMaps?: (ApplicationGatewayUrlPathMap20[] | string)␊ - /**␊ - * Request routing rules of the application gateway resource.␊ - */␊ - requestRoutingRules?: (ApplicationGatewayRequestRoutingRule21[] | string)␊ - /**␊ - * Rewrite rules for the application gateway resource.␊ - */␊ - rewriteRuleSets?: (ApplicationGatewayRewriteRuleSet8[] | string)␊ - /**␊ - * Redirect configurations of the application gateway resource.␊ - */␊ - redirectConfigurations?: (ApplicationGatewayRedirectConfiguration18[] | string)␊ - /**␊ - * Web application firewall configuration.␊ - */␊ - webApplicationFirewallConfiguration?: (ApplicationGatewayWebApplicationFirewallConfiguration18 | string)␊ - /**␊ - * Whether HTTP2 is enabled on the application gateway resource.␊ - */␊ - enableHttp2?: (boolean | string)␊ - /**␊ - * Whether FIPS is enabled on the application gateway resource.␊ - */␊ - enableFips?: (boolean | string)␊ - /**␊ - * Autoscale Configuration.␊ - */␊ - autoscaleConfiguration?: (ApplicationGatewayAutoscaleConfiguration12 | string)␊ - /**␊ - * Resource GUID property of the application gateway resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - /**␊ - * Custom error configurations of the application gateway resource.␊ - */␊ - customErrorConfigurations?: (ApplicationGatewayCustomError9[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of an application gateway␊ - */␊ - export interface ApplicationGatewaySku21 {␊ - /**␊ - * Name of an application gateway SKU.␊ - */␊ - name?: (("Standard_Small" | "Standard_Medium" | "Standard_Large" | "WAF_Medium" | "WAF_Large" | "Standard_v2" | "WAF_v2") | string)␊ - /**␊ - * Tier of an application gateway.␊ - */␊ - tier?: (("Standard" | "WAF" | "Standard_v2" | "WAF_v2") | string)␊ - /**␊ - * Capacity (instance count) of an application gateway.␊ - */␊ - capacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application Gateway Ssl policy.␊ - */␊ - export interface ApplicationGatewaySslPolicy18 {␊ - /**␊ - * Ssl protocols to be disabled on application gateway.␊ - */␊ - disabledSslProtocols?: (("TLSv1_0" | "TLSv1_1" | "TLSv1_2")[] | string)␊ - /**␊ - * Type of Ssl Policy.␊ - */␊ - policyType?: (("Predefined" | "Custom") | string)␊ - /**␊ - * Name of Ssl predefined policy.␊ - */␊ - policyName?: (("AppGwSslPolicy20150501" | "AppGwSslPolicy20170401" | "AppGwSslPolicy20170401S") | string)␊ - /**␊ - * Ssl cipher suites to be enabled in the specified order to application gateway.␊ - */␊ - cipherSuites?: (("TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384" | "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256" | "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA" | "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA" | "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384" | "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256" | "TLS_DHE_RSA_WITH_AES_256_CBC_SHA" | "TLS_DHE_RSA_WITH_AES_128_CBC_SHA" | "TLS_RSA_WITH_AES_256_GCM_SHA384" | "TLS_RSA_WITH_AES_128_GCM_SHA256" | "TLS_RSA_WITH_AES_256_CBC_SHA256" | "TLS_RSA_WITH_AES_128_CBC_SHA256" | "TLS_RSA_WITH_AES_256_CBC_SHA" | "TLS_RSA_WITH_AES_128_CBC_SHA" | "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384" | "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256" | "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384" | "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256" | "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA" | "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA" | "TLS_DHE_DSS_WITH_AES_256_CBC_SHA256" | "TLS_DHE_DSS_WITH_AES_128_CBC_SHA256" | "TLS_DHE_DSS_WITH_AES_256_CBC_SHA" | "TLS_DHE_DSS_WITH_AES_128_CBC_SHA" | "TLS_RSA_WITH_3DES_EDE_CBC_SHA" | "TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA" | "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256" | "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384")[] | string)␊ - /**␊ - * Minimum version of Ssl protocol to be supported on application gateway.␊ - */␊ - minProtocolVersion?: (("TLSv1_0" | "TLSv1_1" | "TLSv1_2") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed.␊ - */␊ - export interface ApplicationGatewayIPConfiguration21 {␊ - properties?: (ApplicationGatewayIPConfigurationPropertiesFormat21 | string)␊ - /**␊ - * Name of the IP configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayIPConfigurationPropertiesFormat21 {␊ - /**␊ - * Reference of the subnet resource. A subnet from where application gateway gets its private address.␊ - */␊ - subnet?: (SubResource28 | string)␊ - /**␊ - * Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authentication certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewayAuthenticationCertificate18 {␊ - properties?: (ApplicationGatewayAuthenticationCertificatePropertiesFormat18 | string)␊ - /**␊ - * Name of the authentication certificate that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authentication certificates properties of an application gateway.␊ - */␊ - export interface ApplicationGatewayAuthenticationCertificatePropertiesFormat18 {␊ - /**␊ - * Certificate public data.␊ - */␊ - data?: string␊ - /**␊ - * Provisioning state of the authentication certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trusted Root certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewayTrustedRootCertificate9 {␊ - properties?: (ApplicationGatewayTrustedRootCertificatePropertiesFormat9 | string)␊ - /**␊ - * Name of the trusted root certificate that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trusted Root certificates properties of an application gateway.␊ - */␊ - export interface ApplicationGatewayTrustedRootCertificatePropertiesFormat9 {␊ - /**␊ - * Certificate public data.␊ - */␊ - data?: string␊ - /**␊ - * Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault.␊ - */␊ - keyVaultSecretId?: string␊ - /**␊ - * Provisioning state of the trusted root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSL certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewaySslCertificate21 {␊ - properties?: (ApplicationGatewaySslCertificatePropertiesFormat21 | string)␊ - /**␊ - * Name of the SSL certificate that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewaySslCertificatePropertiesFormat21 {␊ - /**␊ - * Base-64 encoded pfx certificate. Only applicable in PUT Request.␊ - */␊ - data?: string␊ - /**␊ - * Password for the pfx file specified in data. Only applicable in PUT request.␊ - */␊ - password?: string␊ - /**␊ - * Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request.␊ - */␊ - publicCertData?: string␊ - /**␊ - * Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault.␊ - */␊ - keyVaultSecretId?: string␊ - /**␊ - * Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendIPConfiguration21 {␊ - properties?: (ApplicationGatewayFrontendIPConfigurationPropertiesFormat21 | string)␊ - /**␊ - * Name of the frontend IP configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendIPConfigurationPropertiesFormat21 {␊ - /**␊ - * PrivateIPAddress of the network interface IP Configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * PrivateIP allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Reference of the subnet resource.␊ - */␊ - subnet?: (SubResource28 | string)␊ - /**␊ - * Reference of the PublicIP resource.␊ - */␊ - publicIPAddress?: (SubResource28 | string)␊ - /**␊ - * Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend port of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendPort21 {␊ - properties?: (ApplicationGatewayFrontendPortPropertiesFormat21 | string)␊ - /**␊ - * Name of the frontend port that is unique within an Application Gateway␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend port of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendPortPropertiesFormat21 {␊ - /**␊ - * Frontend port␊ - */␊ - port?: (number | string)␊ - /**␊ - * Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Probe of the application gateway.␊ - */␊ - export interface ApplicationGatewayProbe20 {␊ - properties?: (ApplicationGatewayProbePropertiesFormat20 | string)␊ - /**␊ - * Name of the probe that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of probe of an application gateway.␊ - */␊ - export interface ApplicationGatewayProbePropertiesFormat20 {␊ - /**␊ - * The protocol used for the probe. Possible values are 'Http' and 'Https'.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Host name to send the probe to.␊ - */␊ - host?: string␊ - /**␊ - * Relative path of probe. Valid path starts from '/'. Probe is sent to ://:␊ - */␊ - path?: string␊ - /**␊ - * The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - interval?: (number | string)␊ - /**␊ - * the probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - timeout?: (number | string)␊ - /**␊ - * The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20.␊ - */␊ - unhealthyThreshold?: (number | string)␊ - /**␊ - * Whether the host header should be picked from the backend http settings. Default value is false.␊ - */␊ - pickHostNameFromBackendHttpSettings?: (boolean | string)␊ - /**␊ - * Minimum number of servers that are always marked healthy. Default value is 0.␊ - */␊ - minServers?: (number | string)␊ - /**␊ - * Criterion for classifying a healthy probe response.␊ - */␊ - match?: (ApplicationGatewayProbeHealthResponseMatch18 | string)␊ - /**␊ - * Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application gateway probe health response match␊ - */␊ - export interface ApplicationGatewayProbeHealthResponseMatch18 {␊ - /**␊ - * Body that must be contained in the health response. Default value is empty.␊ - */␊ - body?: string␊ - /**␊ - * Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399.␊ - */␊ - statusCodes?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend Address Pool of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddressPool21 {␊ - properties?: (ApplicationGatewayBackendAddressPoolPropertiesFormat21 | string)␊ - /**␊ - * Name of the backend address pool that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend Address Pool of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddressPoolPropertiesFormat21 {␊ - /**␊ - * Collection of references to IPs defined in network interfaces.␊ - */␊ - backendIPConfigurations?: (SubResource28[] | string)␊ - /**␊ - * Backend addresses␊ - */␊ - backendAddresses?: (ApplicationGatewayBackendAddress21[] | string)␊ - /**␊ - * Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddress21 {␊ - /**␊ - * Fully qualified domain name (FQDN).␊ - */␊ - fqdn?: string␊ - /**␊ - * IP address␊ - */␊ - ipAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address pool settings of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendHttpSettings21 {␊ - properties?: (ApplicationGatewayBackendHttpSettingsPropertiesFormat21 | string)␊ - /**␊ - * Name of the backend http settings that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend address pool settings of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendHttpSettingsPropertiesFormat21 {␊ - /**␊ - * The destination port on the backend.␊ - */␊ - port?: (number | string)␊ - /**␊ - * The protocol used to communicate with the backend. Possible values are 'Http' and 'Https'.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Cookie based affinity.␊ - */␊ - cookieBasedAffinity?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Request timeout in seconds. Application Gateway will fail the request if response is not received within RequestTimeout. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - requestTimeout?: (number | string)␊ - /**␊ - * Probe resource of an application gateway.␊ - */␊ - probe?: (SubResource28 | string)␊ - /**␊ - * Array of references to application gateway authentication certificates.␊ - */␊ - authenticationCertificates?: (SubResource28[] | string)␊ - /**␊ - * Array of references to application gateway trusted root certificates.␊ - */␊ - trustedRootCertificates?: (SubResource28[] | string)␊ - /**␊ - * Connection draining of the backend http settings resource.␊ - */␊ - connectionDraining?: (ApplicationGatewayConnectionDraining18 | string)␊ - /**␊ - * Host header to be sent to the backend servers.␊ - */␊ - hostName?: string␊ - /**␊ - * Whether to pick host header should be picked from the host name of the backend server. Default value is false.␊ - */␊ - pickHostNameFromBackendAddress?: (boolean | string)␊ - /**␊ - * Cookie name to use for the affinity cookie.␊ - */␊ - affinityCookieName?: string␊ - /**␊ - * Whether the probe is enabled. Default value is false.␊ - */␊ - probeEnabled?: (boolean | string)␊ - /**␊ - * Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null.␊ - */␊ - path?: string␊ - /**␊ - * Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Connection draining allows open connections to a backend server to be active for a specified time after the backend server got removed from the configuration.␊ - */␊ - export interface ApplicationGatewayConnectionDraining18 {␊ - /**␊ - * Whether connection draining is enabled or not.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds.␊ - */␊ - drainTimeoutInSec: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http listener of an application gateway.␊ - */␊ - export interface ApplicationGatewayHttpListener21 {␊ - properties?: (ApplicationGatewayHttpListenerPropertiesFormat21 | string)␊ - /**␊ - * Name of the HTTP listener that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of HTTP listener of an application gateway.␊ - */␊ - export interface ApplicationGatewayHttpListenerPropertiesFormat21 {␊ - /**␊ - * Frontend IP configuration resource of an application gateway.␊ - */␊ - frontendIPConfiguration?: (SubResource28 | string)␊ - /**␊ - * Frontend port resource of an application gateway.␊ - */␊ - frontendPort?: (SubResource28 | string)␊ - /**␊ - * Protocol of the HTTP listener. Possible values are 'Http' and 'Https'.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Host name of HTTP listener.␊ - */␊ - hostName?: string␊ - /**␊ - * SSL certificate resource of an application gateway.␊ - */␊ - sslCertificate?: (SubResource28 | string)␊ - /**␊ - * Applicable only if protocol is https. Enables SNI for multi-hosting.␊ - */␊ - requireServerNameIndication?: (boolean | string)␊ - /**␊ - * Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - /**␊ - * Custom error configurations of the HTTP listener.␊ - */␊ - customErrorConfigurations?: (ApplicationGatewayCustomError9[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Customer error of an application gateway.␊ - */␊ - export interface ApplicationGatewayCustomError9 {␊ - /**␊ - * Status code of the application gateway customer error.␊ - */␊ - statusCode?: (("HttpStatus403" | "HttpStatus502") | string)␊ - /**␊ - * Error page URL of the application gateway customer error.␊ - */␊ - customErrorPageUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * UrlPathMaps give a url path to the backend mapping information for PathBasedRouting.␊ - */␊ - export interface ApplicationGatewayUrlPathMap20 {␊ - properties?: (ApplicationGatewayUrlPathMapPropertiesFormat20 | string)␊ - /**␊ - * Name of the URL path map that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of UrlPathMap of the application gateway.␊ - */␊ - export interface ApplicationGatewayUrlPathMapPropertiesFormat20 {␊ - /**␊ - * Default backend address pool resource of URL path map.␊ - */␊ - defaultBackendAddressPool?: (SubResource28 | string)␊ - /**␊ - * Default backend http settings resource of URL path map.␊ - */␊ - defaultBackendHttpSettings?: (SubResource28 | string)␊ - /**␊ - * Default Rewrite rule set resource of URL path map.␊ - */␊ - defaultRewriteRuleSet?: (SubResource28 | string)␊ - /**␊ - * Default redirect configuration resource of URL path map.␊ - */␊ - defaultRedirectConfiguration?: (SubResource28 | string)␊ - /**␊ - * Path rule of URL path map resource.␊ - */␊ - pathRules?: (ApplicationGatewayPathRule20[] | string)␊ - /**␊ - * Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Path rule of URL path map of an application gateway.␊ - */␊ - export interface ApplicationGatewayPathRule20 {␊ - properties?: (ApplicationGatewayPathRulePropertiesFormat20 | string)␊ - /**␊ - * Name of the path rule that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of path rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayPathRulePropertiesFormat20 {␊ - /**␊ - * Path rules of URL path map.␊ - */␊ - paths?: (string[] | string)␊ - /**␊ - * Backend address pool resource of URL path map path rule.␊ - */␊ - backendAddressPool?: (SubResource28 | string)␊ - /**␊ - * Backend http settings resource of URL path map path rule.␊ - */␊ - backendHttpSettings?: (SubResource28 | string)␊ - /**␊ - * Redirect configuration resource of URL path map path rule.␊ - */␊ - redirectConfiguration?: (SubResource28 | string)␊ - /**␊ - * Rewrite rule set resource of URL path map path rule.␊ - */␊ - rewriteRuleSet?: (SubResource28 | string)␊ - /**␊ - * Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Request routing rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayRequestRoutingRule21 {␊ - properties?: (ApplicationGatewayRequestRoutingRulePropertiesFormat21 | string)␊ - /**␊ - * Name of the request routing rule that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of request routing rule of the application gateway.␊ - */␊ - export interface ApplicationGatewayRequestRoutingRulePropertiesFormat21 {␊ - /**␊ - * Rule type.␊ - */␊ - ruleType?: (("Basic" | "PathBasedRouting") | string)␊ - /**␊ - * Backend address pool resource of the application gateway. ␊ - */␊ - backendAddressPool?: (SubResource28 | string)␊ - /**␊ - * Backend http settings resource of the application gateway.␊ - */␊ - backendHttpSettings?: (SubResource28 | string)␊ - /**␊ - * Http listener resource of the application gateway. ␊ - */␊ - httpListener?: (SubResource28 | string)␊ - /**␊ - * URL path map resource of the application gateway.␊ - */␊ - urlPathMap?: (SubResource28 | string)␊ - /**␊ - * Rewrite Rule Set resource in Basic rule of the application gateway.␊ - */␊ - rewriteRuleSet?: (SubResource28 | string)␊ - /**␊ - * Redirect configuration resource of the application gateway.␊ - */␊ - redirectConfiguration?: (SubResource28 | string)␊ - /**␊ - * Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Rewrite rule set of an application gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRuleSet8 {␊ - properties?: (ApplicationGatewayRewriteRuleSetPropertiesFormat8 | string)␊ - /**␊ - * Name of the rewrite rule set that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of rewrite rule set of the application gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRuleSetPropertiesFormat8 {␊ - /**␊ - * Rewrite rules in the rewrite rule set.␊ - */␊ - rewriteRules?: (ApplicationGatewayRewriteRule8[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Rewrite rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRule8 {␊ - /**␊ - * Name of the rewrite rule that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * Set of actions to be done as part of the rewrite Rule.␊ - */␊ - actionSet?: (ApplicationGatewayRewriteRuleActionSet8 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Set of actions in the Rewrite Rule in Application Gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRuleActionSet8 {␊ - /**␊ - * Request Header Actions in the Action Set␊ - */␊ - requestHeaderConfigurations?: (ApplicationGatewayHeaderConfiguration8[] | string)␊ - /**␊ - * Response Header Actions in the Action Set␊ - */␊ - responseHeaderConfigurations?: (ApplicationGatewayHeaderConfiguration8[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Header configuration of the Actions set in Application Gateway.␊ - */␊ - export interface ApplicationGatewayHeaderConfiguration8 {␊ - /**␊ - * Header name of the header configuration␊ - */␊ - headerName?: string␊ - /**␊ - * Header value of the header configuration␊ - */␊ - headerValue?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Redirect configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayRedirectConfiguration18 {␊ - properties?: (ApplicationGatewayRedirectConfigurationPropertiesFormat18 | string)␊ - /**␊ - * Name of the redirect configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of redirect configuration of the application gateway.␊ - */␊ - export interface ApplicationGatewayRedirectConfigurationPropertiesFormat18 {␊ - /**␊ - * Supported http redirection types - Permanent, Temporary, Found, SeeOther.␊ - */␊ - redirectType?: (("Permanent" | "Found" | "SeeOther" | "Temporary") | string)␊ - /**␊ - * Reference to a listener to redirect the request to.␊ - */␊ - targetListener?: (SubResource28 | string)␊ - /**␊ - * Url to redirect the request to.␊ - */␊ - targetUrl?: string␊ - /**␊ - * Include path in the redirected url.␊ - */␊ - includePath?: (boolean | string)␊ - /**␊ - * Include query string in the redirected url.␊ - */␊ - includeQueryString?: (boolean | string)␊ - /**␊ - * Request routing specifying redirect configuration.␊ - */␊ - requestRoutingRules?: (SubResource28[] | string)␊ - /**␊ - * Url path maps specifying default redirect configuration.␊ - */␊ - urlPathMaps?: (SubResource28[] | string)␊ - /**␊ - * Path rules specifying redirect configuration.␊ - */␊ - pathRules?: (SubResource28[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application gateway web application firewall configuration.␊ - */␊ - export interface ApplicationGatewayWebApplicationFirewallConfiguration18 {␊ - /**␊ - * Whether the web application firewall is enabled or not.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * Web application firewall mode.␊ - */␊ - firewallMode: (("Detection" | "Prevention") | string)␊ - /**␊ - * The type of the web application firewall rule set. Possible values are: 'OWASP'.␊ - */␊ - ruleSetType: string␊ - /**␊ - * The version of the rule set type.␊ - */␊ - ruleSetVersion: string␊ - /**␊ - * The disabled rule groups.␊ - */␊ - disabledRuleGroups?: (ApplicationGatewayFirewallDisabledRuleGroup18[] | string)␊ - /**␊ - * Whether allow WAF to check request Body.␊ - */␊ - requestBodyCheck?: (boolean | string)␊ - /**␊ - * Maximum request body size for WAF.␊ - */␊ - maxRequestBodySize?: (number | string)␊ - /**␊ - * Maximum request body size in Kb for WAF.␊ - */␊ - maxRequestBodySizeInKb?: (number | string)␊ - /**␊ - * Maximum file upload size in Mb for WAF.␊ - */␊ - fileUploadLimitInMb?: (number | string)␊ - /**␊ - * The exclusion list.␊ - */␊ - exclusions?: (ApplicationGatewayFirewallExclusion9[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allows to disable rules within a rule group or an entire rule group.␊ - */␊ - export interface ApplicationGatewayFirewallDisabledRuleGroup18 {␊ - /**␊ - * The name of the rule group that will be disabled.␊ - */␊ - ruleGroupName: string␊ - /**␊ - * The list of rules that will be disabled. If null, all rules of the rule group will be disabled.␊ - */␊ - rules?: (number[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allow to exclude some variable satisfy the condition for the WAF check␊ - */␊ - export interface ApplicationGatewayFirewallExclusion9 {␊ - /**␊ - * The variable to be excluded.␊ - */␊ - matchVariable: string␊ - /**␊ - * When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to.␊ - */␊ - selectorMatchOperator: string␊ - /**␊ - * When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to.␊ - */␊ - selector: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application Gateway autoscale configuration.␊ - */␊ - export interface ApplicationGatewayAutoscaleConfiguration12 {␊ - /**␊ - * Lower bound on number of Application Gateway capacity␊ - */␊ - minCapacity: (number | string)␊ - /**␊ - * Upper bound on number of Application Gateway capacity␊ - */␊ - maxCapacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the resource.␊ - */␊ - export interface ManagedServiceIdentity8 {␊ - /**␊ - * The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.␊ - */␊ - type?: ("SystemAssigned" | "UserAssigned" | "SystemAssigned, UserAssigned" | "None")␊ - /**␊ - * The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.␊ - */␊ - userAssignedIdentities?: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/authorizations␊ - */␊ - export interface ExpressRouteCircuitsAuthorizations16 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/authorizations"␊ - apiVersion: "2018-11-01"␊ - properties: (AuthorizationPropertiesFormat16 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ExpressRoutePorts␊ - */␊ - export interface ExpressRoutePorts8 {␊ - name: string␊ - type: "Microsoft.Network/ExpressRoutePorts"␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * ExpressRoutePort properties␊ - */␊ - properties: (ExpressRoutePortPropertiesFormat8 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to ExpressRoutePort resources.␊ - */␊ - export interface ExpressRoutePortPropertiesFormat8 {␊ - /**␊ - * The name of the peering location that the ExpressRoutePort is mapped to physically.␊ - */␊ - peeringLocation?: string␊ - /**␊ - * Bandwidth of procured ports in Gbps␊ - */␊ - bandwidthInGbps?: (number | string)␊ - /**␊ - * Encapsulation method on physical ports.␊ - */␊ - encapsulation?: (("Dot1Q" | "QinQ") | string)␊ - /**␊ - * The set of physical links of the ExpressRoutePort resource␊ - */␊ - links?: (ExpressRouteLink8[] | string)␊ - /**␊ - * The resource GUID property of the ExpressRoutePort resource.␊ - */␊ - resourceGuid?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ExpressRouteLink child resource definition.␊ - */␊ - export interface ExpressRouteLink8 {␊ - /**␊ - * ExpressRouteLink properties␊ - */␊ - properties?: (ExpressRouteLinkPropertiesFormat8 | string)␊ - /**␊ - * Name of child port resource that is unique among child port resources of the parent.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to ExpressRouteLink resources.␊ - */␊ - export interface ExpressRouteLinkPropertiesFormat8 {␊ - /**␊ - * Administrative state of the physical port.␊ - */␊ - adminState?: (("Enabled" | "Disabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/connections␊ - */␊ - export interface Connections20 {␊ - name: string␊ - type: "Microsoft.Network/connections"␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway connection.␊ - */␊ - properties: (VirtualNetworkGatewayConnectionPropertiesFormat20 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewayConnection properties␊ - */␊ - export interface VirtualNetworkGatewayConnectionPropertiesFormat20 {␊ - /**␊ - * The authorizationKey.␊ - */␊ - authorizationKey?: string␊ - /**␊ - * The reference to virtual network gateway resource.␊ - */␊ - virtualNetworkGateway1: (VirtualNetworkGateway11 | SubResource28 | string)␊ - /**␊ - * The reference to virtual network gateway resource.␊ - */␊ - virtualNetworkGateway2?: (VirtualNetworkGateway11 | SubResource28 | string)␊ - /**␊ - * The reference to local network gateway resource.␊ - */␊ - localNetworkGateway2?: (LocalNetworkGateway11 | SubResource28 | string)␊ - /**␊ - * Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.␊ - */␊ - connectionType: (("IPsec" | "Vnet2Vnet" | "ExpressRoute" | "VPNClient") | string)␊ - /**␊ - * Connection protocol used for this connection.␊ - */␊ - connectionProtocol?: (("IKEv2" | "IKEv1") | string)␊ - /**␊ - * The routing weight.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * The IPSec shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The reference to peerings resource.␊ - */␊ - peer?: (SubResource28 | string)␊ - /**␊ - * EnableBgp flag␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * Enable policy-based traffic selectors.␊ - */␊ - usePolicyBasedTrafficSelectors?: (boolean | string)␊ - /**␊ - * The IPSec Policies to be considered by this connection.␊ - */␊ - ipsecPolicies?: (IpsecPolicy17[] | string)␊ - /**␊ - * The resource GUID property of the VirtualNetworkGatewayConnection resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Bypass ExpressRoute Gateway for data forwarding␊ - */␊ - expressRouteGatewayBypass?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A common class for general resource information␊ - */␊ - export interface VirtualNetworkGateway11 {␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway.␊ - */␊ - properties: (VirtualNetworkGatewayPropertiesFormat20 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGateway properties␊ - */␊ - export interface VirtualNetworkGatewayPropertiesFormat20 {␊ - /**␊ - * IP configurations for virtual network gateway.␊ - */␊ - ipConfigurations?: (VirtualNetworkGatewayIPConfiguration19[] | string)␊ - /**␊ - * The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'.␊ - */␊ - gatewayType?: (("Vpn" | "ExpressRoute") | string)␊ - /**␊ - * The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'.␊ - */␊ - vpnType?: (("PolicyBased" | "RouteBased") | string)␊ - /**␊ - * Whether BGP is enabled for this virtual network gateway or not.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * ActiveActive flag␊ - */␊ - activeActive?: (boolean | string)␊ - /**␊ - * The reference of the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting.␊ - */␊ - gatewayDefaultSite?: (SubResource28 | string)␊ - /**␊ - * The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.␊ - */␊ - sku?: (VirtualNetworkGatewaySku19 | string)␊ - /**␊ - * The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations.␊ - */␊ - vpnClientConfiguration?: (VpnClientConfiguration19 | string)␊ - /**␊ - * Virtual network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings19 | string)␊ - /**␊ - * The resource GUID property of the VirtualNetworkGateway resource.␊ - */␊ - resourceGuid?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration for virtual network gateway␊ - */␊ - export interface VirtualNetworkGatewayIPConfiguration19 {␊ - /**␊ - * Properties of the virtual network gateway ip configuration.␊ - */␊ - properties?: (VirtualNetworkGatewayIPConfigurationPropertiesFormat19 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of VirtualNetworkGatewayIPConfiguration␊ - */␊ - export interface VirtualNetworkGatewayIPConfigurationPropertiesFormat19 {␊ - /**␊ - * The private IP allocation method. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * The reference of the subnet resource.␊ - */␊ - subnet?: (SubResource28 | string)␊ - /**␊ - * The reference of the public IP resource.␊ - */␊ - publicIPAddress?: (SubResource28 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewaySku details␊ - */␊ - export interface VirtualNetworkGatewaySku19 {␊ - /**␊ - * Gateway SKU name.␊ - */␊ - name?: (("Basic" | "HighPerformance" | "Standard" | "UltraPerformance" | "VpnGw1" | "VpnGw2" | "VpnGw3" | "VpnGw1AZ" | "VpnGw2AZ" | "VpnGw3AZ" | "ErGw1AZ" | "ErGw2AZ" | "ErGw3AZ") | string)␊ - /**␊ - * Gateway SKU tier.␊ - */␊ - tier?: (("Basic" | "HighPerformance" | "Standard" | "UltraPerformance" | "VpnGw1" | "VpnGw2" | "VpnGw3" | "VpnGw1AZ" | "VpnGw2AZ" | "VpnGw3AZ" | "ErGw1AZ" | "ErGw2AZ" | "ErGw3AZ") | string)␊ - /**␊ - * The capacity.␊ - */␊ - capacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnClientConfiguration for P2S client.␊ - */␊ - export interface VpnClientConfiguration19 {␊ - /**␊ - * The reference of the address space resource which represents Address space for P2S VpnClient.␊ - */␊ - vpnClientAddressPool?: (AddressSpace30 | string)␊ - /**␊ - * VpnClientRootCertificate for virtual network gateway.␊ - */␊ - vpnClientRootCertificates?: (VpnClientRootCertificate19[] | string)␊ - /**␊ - * VpnClientRevokedCertificate for Virtual network gateway.␊ - */␊ - vpnClientRevokedCertificates?: (VpnClientRevokedCertificate19[] | string)␊ - /**␊ - * VpnClientProtocols for Virtual network gateway.␊ - */␊ - vpnClientProtocols?: (("IkeV2" | "SSTP" | "OpenVPN")[] | string)␊ - /**␊ - * VpnClientIpsecPolicies for virtual network gateway P2S client.␊ - */␊ - vpnClientIpsecPolicies?: (IpsecPolicy17[] | string)␊ - /**␊ - * The radius server address property of the VirtualNetworkGateway resource for vpn client connection.␊ - */␊ - radiusServerAddress?: string␊ - /**␊ - * The radius secret property of the VirtualNetworkGateway resource for vpn client connection.␊ - */␊ - radiusServerSecret?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client root certificate of virtual network gateway␊ - */␊ - export interface VpnClientRootCertificate19 {␊ - /**␊ - * Properties of the vpn client root certificate.␊ - */␊ - properties: (VpnClientRootCertificatePropertiesFormat19 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of application gateway␊ - */␊ - export interface VpnClientRootCertificatePropertiesFormat19 {␊ - /**␊ - * The certificate public data.␊ - */␊ - publicCertData: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client revoked certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRevokedCertificate19 {␊ - /**␊ - * Properties of the vpn client revoked certificate.␊ - */␊ - properties?: (VpnClientRevokedCertificatePropertiesFormat19 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the revoked VPN client certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRevokedCertificatePropertiesFormat19 {␊ - /**␊ - * The revoked VPN client certificate thumbprint.␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An IPSec Policy configuration for a virtual network gateway connection␊ - */␊ - export interface IpsecPolicy17 {␊ - /**␊ - * The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.␊ - */␊ - saLifeTimeSeconds: (number | string)␊ - /**␊ - * The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.␊ - */␊ - saDataSizeKilobytes: (number | string)␊ - /**␊ - * The IPSec encryption algorithm (IKE phase 1).␊ - */␊ - ipsecEncryption: (("None" | "DES" | "DES3" | "AES128" | "AES192" | "AES256" | "GCMAES128" | "GCMAES192" | "GCMAES256") | string)␊ - /**␊ - * The IPSec integrity algorithm (IKE phase 1).␊ - */␊ - ipsecIntegrity: (("MD5" | "SHA1" | "SHA256" | "GCMAES128" | "GCMAES192" | "GCMAES256") | string)␊ - /**␊ - * The IKE encryption algorithm (IKE phase 2).␊ - */␊ - ikeEncryption: (("DES" | "DES3" | "AES128" | "AES192" | "AES256" | "GCMAES256" | "GCMAES128") | string)␊ - /**␊ - * The IKE integrity algorithm (IKE phase 2).␊ - */␊ - ikeIntegrity: (("MD5" | "SHA1" | "SHA256" | "SHA384" | "GCMAES256" | "GCMAES128") | string)␊ - /**␊ - * The DH Groups used in IKE Phase 1 for initial SA.␊ - */␊ - dhGroup: (("None" | "DHGroup1" | "DHGroup2" | "DHGroup14" | "DHGroup2048" | "ECP256" | "ECP384" | "DHGroup24") | string)␊ - /**␊ - * The Pfs Groups used in IKE Phase 2 for new child SA.␊ - */␊ - pfsGroup: (("None" | "PFS1" | "PFS2" | "PFS2048" | "ECP256" | "ECP384" | "PFS24" | "PFS14" | "PFSMM") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * BGP settings details␊ - */␊ - export interface BgpSettings19 {␊ - /**␊ - * The BGP speaker's ASN.␊ - */␊ - asn?: (number | string)␊ - /**␊ - * The BGP peering address and BGP identifier of this BGP speaker.␊ - */␊ - bgpPeeringAddress?: string␊ - /**␊ - * The weight added to routes learned from this BGP speaker.␊ - */␊ - peerWeight?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A common class for general resource information␊ - */␊ - export interface LocalNetworkGateway11 {␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the local network gateway.␊ - */␊ - properties: (LocalNetworkGatewayPropertiesFormat20 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * LocalNetworkGateway properties␊ - */␊ - export interface LocalNetworkGatewayPropertiesFormat20 {␊ - /**␊ - * Local network site address space.␊ - */␊ - localNetworkAddressSpace?: (AddressSpace30 | string)␊ - /**␊ - * IP address of local network gateway.␊ - */␊ - gatewayIpAddress?: string␊ - /**␊ - * Local network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings19 | string)␊ - /**␊ - * The resource GUID property of the LocalNetworkGateway resource.␊ - */␊ - resourceGuid?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/localNetworkGateways␊ - */␊ - export interface LocalNetworkGateways20 {␊ - name: string␊ - type: "Microsoft.Network/localNetworkGateways"␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the local network gateway.␊ - */␊ - properties: (LocalNetworkGatewayPropertiesFormat20 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworkGateways␊ - */␊ - export interface VirtualNetworkGateways20 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworkGateways"␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway.␊ - */␊ - properties: (VirtualNetworkGatewayPropertiesFormat20 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnets20 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks/subnets"␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties: (SubnetPropertiesFormat22 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/virtualNetworkPeerings␊ - */␊ - export interface VirtualNetworksVirtualNetworkPeerings17 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks/virtualNetworkPeerings"␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties: (VirtualNetworkPeeringPropertiesFormat19 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings␊ - */␊ - export interface ExpressRouteCircuitsPeerings15 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/peerings"␊ - apiVersion: "2018-11-01"␊ - properties: (ExpressRouteCircuitPeeringPropertiesFormat16 | string)␊ - resources?: ExpressRouteCircuitsPeeringsConnectionsChildResource13[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections/peerings␊ - */␊ - export interface ExpressRouteCrossConnectionsPeerings12 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCrossConnections/peerings"␊ - apiVersion: "2018-11-01"␊ - properties: (ExpressRouteCrossConnectionPeeringProperties13 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers/inboundNatRules␊ - */␊ - export interface LoadBalancersInboundNatRules17 {␊ - name: string␊ - type: "Microsoft.Network/loadBalancers/inboundNatRules"␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties: (InboundNatRulePropertiesFormat22 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces/tapConfigurations␊ - */␊ - export interface NetworkInterfacesTapConfigurations8 {␊ - name: string␊ - type: "Microsoft.Network/networkInterfaces/tapConfigurations"␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Properties of the Virtual Network Tap configuration␊ - */␊ - properties: (NetworkInterfaceTapConfigurationPropertiesFormat9 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRules21 {␊ - name: string␊ - type: "Microsoft.Network/networkSecurityGroups/securityRules"␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Properties of the security rule␊ - */␊ - properties: (SecurityRulePropertiesFormat22 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutes21 {␊ - name: string␊ - type: "Microsoft.Network/routeTables/routes"␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Properties of the route.␊ - */␊ - properties: (RoutePropertiesFormat22 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings/connections␊ - */␊ - export interface ExpressRouteCircuitsPeeringsConnections13 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/peerings/connections"␊ - apiVersion: "2018-11-01"␊ - properties: (ExpressRouteCircuitConnectionPropertiesFormat13 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ExpressRoutePorts␊ - */␊ - export interface ExpressRoutePorts9 {␊ - name: string␊ - type: "Microsoft.Network/ExpressRoutePorts"␊ - apiVersion: "2018-10-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * ExpressRoutePort properties␊ - */␊ - properties: (ExpressRoutePortPropertiesFormat9 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to ExpressRoutePort resources.␊ - */␊ - export interface ExpressRoutePortPropertiesFormat9 {␊ - /**␊ - * The name of the peering location that the ExpressRoutePort is mapped to physically.␊ - */␊ - peeringLocation?: string␊ - /**␊ - * Bandwidth of procured ports in Gbps␊ - */␊ - bandwidthInGbps?: (number | string)␊ - /**␊ - * Encapsulation method on physical ports.␊ - */␊ - encapsulation?: (("Dot1Q" | "QinQ") | string)␊ - /**␊ - * The set of physical links of the ExpressRoutePort resource␊ - */␊ - links?: (ExpressRouteLink9[] | string)␊ - /**␊ - * The resource GUID property of the ExpressRoutePort resource.␊ - */␊ - resourceGuid?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ExpressRouteLink child resource definition.␊ - */␊ - export interface ExpressRouteLink9 {␊ - /**␊ - * ExpressRouteLink properties␊ - */␊ - properties?: (ExpressRouteLinkPropertiesFormat9 | string)␊ - /**␊ - * Name of child port resource that is unique among child port resources of the parent.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to ExpressRouteLink resources.␊ - */␊ - export interface ExpressRouteLinkPropertiesFormat9 {␊ - /**␊ - * Administrative state of the physical port.␊ - */␊ - adminState?: (("Enabled" | "Disabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/connections␊ - */␊ - export interface Connections21 {␊ - name: string␊ - type: "Microsoft.Network/connections"␊ - apiVersion: "2018-10-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway connection.␊ - */␊ - properties: (VirtualNetworkGatewayConnectionPropertiesFormat21 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewayConnection properties␊ - */␊ - export interface VirtualNetworkGatewayConnectionPropertiesFormat21 {␊ - /**␊ - * The authorizationKey.␊ - */␊ - authorizationKey?: string␊ - /**␊ - * The reference to virtual network gateway resource.␊ - */␊ - virtualNetworkGateway1: (VirtualNetworkGateway12 | SubResource20 | string)␊ - /**␊ - * The reference to virtual network gateway resource.␊ - */␊ - virtualNetworkGateway2?: (VirtualNetworkGateway12 | SubResource20 | string)␊ - /**␊ - * The reference to local network gateway resource.␊ - */␊ - localNetworkGateway2?: (LocalNetworkGateway12 | SubResource20 | string)␊ - /**␊ - * Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.␊ - */␊ - connectionType: (("IPsec" | "Vnet2Vnet" | "ExpressRoute" | "VPNClient") | string)␊ - /**␊ - * Connection protocol used for this connection.␊ - */␊ - connectionProtocol?: (("IKEv2" | "IKEv1") | string)␊ - /**␊ - * The routing weight.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * The IPSec shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The reference to peerings resource.␊ - */␊ - peer?: (SubResource20 | string)␊ - /**␊ - * EnableBgp flag␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * Enable policy-based traffic selectors.␊ - */␊ - usePolicyBasedTrafficSelectors?: (boolean | string)␊ - /**␊ - * The IPSec Policies to be considered by this connection.␊ - */␊ - ipsecPolicies?: (IpsecPolicy18[] | string)␊ - /**␊ - * The resource GUID property of the VirtualNetworkGatewayConnection resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Bypass ExpressRoute Gateway for data forwarding␊ - */␊ - expressRouteGatewayBypass?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A common class for general resource information␊ - */␊ - export interface VirtualNetworkGateway12 {␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway.␊ - */␊ - properties: (VirtualNetworkGatewayPropertiesFormat21 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGateway properties␊ - */␊ - export interface VirtualNetworkGatewayPropertiesFormat21 {␊ - /**␊ - * IP configurations for virtual network gateway.␊ - */␊ - ipConfigurations?: (VirtualNetworkGatewayIPConfiguration20[] | string)␊ - /**␊ - * The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'.␊ - */␊ - gatewayType?: (("Vpn" | "ExpressRoute") | string)␊ - /**␊ - * The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'.␊ - */␊ - vpnType?: (("PolicyBased" | "RouteBased") | string)␊ - /**␊ - * Whether BGP is enabled for this virtual network gateway or not.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * ActiveActive flag␊ - */␊ - activeActive?: (boolean | string)␊ - /**␊ - * The reference of the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting.␊ - */␊ - gatewayDefaultSite?: (SubResource20 | string)␊ - /**␊ - * The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.␊ - */␊ - sku?: (VirtualNetworkGatewaySku20 | string)␊ - /**␊ - * The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations.␊ - */␊ - vpnClientConfiguration?: (VpnClientConfiguration20 | string)␊ - /**␊ - * Virtual network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings20 | string)␊ - /**␊ - * The resource GUID property of the VirtualNetworkGateway resource.␊ - */␊ - resourceGuid?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration for virtual network gateway␊ - */␊ - export interface VirtualNetworkGatewayIPConfiguration20 {␊ - /**␊ - * Properties of the virtual network gateway ip configuration.␊ - */␊ - properties?: (VirtualNetworkGatewayIPConfigurationPropertiesFormat20 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of VirtualNetworkGatewayIPConfiguration␊ - */␊ - export interface VirtualNetworkGatewayIPConfigurationPropertiesFormat20 {␊ - /**␊ - * The private IP allocation method. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * The reference of the subnet resource.␊ - */␊ - subnet?: (SubResource20 | string)␊ - /**␊ - * The reference of the public IP resource.␊ - */␊ - publicIPAddress?: (SubResource20 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewaySku details␊ - */␊ - export interface VirtualNetworkGatewaySku20 {␊ - /**␊ - * Gateway SKU name.␊ - */␊ - name?: (("Basic" | "HighPerformance" | "Standard" | "UltraPerformance" | "VpnGw1" | "VpnGw2" | "VpnGw3" | "VpnGw1AZ" | "VpnGw2AZ" | "VpnGw3AZ" | "ErGw1AZ" | "ErGw2AZ" | "ErGw3AZ") | string)␊ - /**␊ - * Gateway SKU tier.␊ - */␊ - tier?: (("Basic" | "HighPerformance" | "Standard" | "UltraPerformance" | "VpnGw1" | "VpnGw2" | "VpnGw3" | "VpnGw1AZ" | "VpnGw2AZ" | "VpnGw3AZ" | "ErGw1AZ" | "ErGw2AZ" | "ErGw3AZ") | string)␊ - /**␊ - * The capacity.␊ - */␊ - capacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnClientConfiguration for P2S client.␊ - */␊ - export interface VpnClientConfiguration20 {␊ - /**␊ - * The reference of the address space resource which represents Address space for P2S VpnClient.␊ - */␊ - vpnClientAddressPool?: (AddressSpace22 | string)␊ - /**␊ - * VpnClientRootCertificate for virtual network gateway.␊ - */␊ - vpnClientRootCertificates?: (VpnClientRootCertificate20[] | string)␊ - /**␊ - * VpnClientRevokedCertificate for Virtual network gateway.␊ - */␊ - vpnClientRevokedCertificates?: (VpnClientRevokedCertificate20[] | string)␊ - /**␊ - * VpnClientProtocols for Virtual network gateway.␊ - */␊ - vpnClientProtocols?: (("IkeV2" | "SSTP" | "OpenVPN")[] | string)␊ - /**␊ - * VpnClientIpsecPolicies for virtual network gateway P2S client.␊ - */␊ - vpnClientIpsecPolicies?: (IpsecPolicy18[] | string)␊ - /**␊ - * The radius server address property of the VirtualNetworkGateway resource for vpn client connection.␊ - */␊ - radiusServerAddress?: string␊ - /**␊ - * The radius secret property of the VirtualNetworkGateway resource for vpn client connection.␊ - */␊ - radiusServerSecret?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client root certificate of virtual network gateway␊ - */␊ - export interface VpnClientRootCertificate20 {␊ - /**␊ - * Properties of the vpn client root certificate.␊ - */␊ - properties: (VpnClientRootCertificatePropertiesFormat20 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of application gateway␊ - */␊ - export interface VpnClientRootCertificatePropertiesFormat20 {␊ - /**␊ - * The certificate public data.␊ - */␊ - publicCertData: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client revoked certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRevokedCertificate20 {␊ - /**␊ - * Properties of the vpn client revoked certificate.␊ - */␊ - properties?: (VpnClientRevokedCertificatePropertiesFormat20 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the revoked VPN client certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRevokedCertificatePropertiesFormat20 {␊ - /**␊ - * The revoked VPN client certificate thumbprint.␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An IPSec Policy configuration for a virtual network gateway connection␊ - */␊ - export interface IpsecPolicy18 {␊ - /**␊ - * The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.␊ - */␊ - saLifeTimeSeconds: (number | string)␊ - /**␊ - * The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.␊ - */␊ - saDataSizeKilobytes: (number | string)␊ - /**␊ - * The IPSec encryption algorithm (IKE phase 1).␊ - */␊ - ipsecEncryption: (("None" | "DES" | "DES3" | "AES128" | "AES192" | "AES256" | "GCMAES128" | "GCMAES192" | "GCMAES256") | string)␊ - /**␊ - * The IPSec integrity algorithm (IKE phase 1).␊ - */␊ - ipsecIntegrity: (("MD5" | "SHA1" | "SHA256" | "GCMAES128" | "GCMAES192" | "GCMAES256") | string)␊ - /**␊ - * The IKE encryption algorithm (IKE phase 2).␊ - */␊ - ikeEncryption: (("DES" | "DES3" | "AES128" | "AES192" | "AES256" | "GCMAES256" | "GCMAES128") | string)␊ - /**␊ - * The IKE integrity algorithm (IKE phase 2).␊ - */␊ - ikeIntegrity: (("MD5" | "SHA1" | "SHA256" | "SHA384" | "GCMAES256" | "GCMAES128") | string)␊ - /**␊ - * The DH Groups used in IKE Phase 1 for initial SA.␊ - */␊ - dhGroup: (("None" | "DHGroup1" | "DHGroup2" | "DHGroup14" | "DHGroup2048" | "ECP256" | "ECP384" | "DHGroup24") | string)␊ - /**␊ - * The Pfs Groups used in IKE Phase 2 for new child SA.␊ - */␊ - pfsGroup: (("None" | "PFS1" | "PFS2" | "PFS2048" | "ECP256" | "ECP384" | "PFS24" | "PFS14" | "PFSMM") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * BGP settings details␊ - */␊ - export interface BgpSettings20 {␊ - /**␊ - * The BGP speaker's ASN.␊ - */␊ - asn?: (number | string)␊ - /**␊ - * The BGP peering address and BGP identifier of this BGP speaker.␊ - */␊ - bgpPeeringAddress?: string␊ - /**␊ - * The weight added to routes learned from this BGP speaker.␊ - */␊ - peerWeight?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A common class for general resource information␊ - */␊ - export interface LocalNetworkGateway12 {␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the local network gateway.␊ - */␊ - properties: (LocalNetworkGatewayPropertiesFormat21 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * LocalNetworkGateway properties␊ - */␊ - export interface LocalNetworkGatewayPropertiesFormat21 {␊ - /**␊ - * Local network site address space.␊ - */␊ - localNetworkAddressSpace?: (AddressSpace22 | string)␊ - /**␊ - * IP address of local network gateway.␊ - */␊ - gatewayIpAddress?: string␊ - /**␊ - * Local network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings20 | string)␊ - /**␊ - * The resource GUID property of the LocalNetworkGateway resource.␊ - */␊ - resourceGuid?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/localNetworkGateways␊ - */␊ - export interface LocalNetworkGateways21 {␊ - name: string␊ - type: "Microsoft.Network/localNetworkGateways"␊ - apiVersion: "2018-10-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the local network gateway.␊ - */␊ - properties: (LocalNetworkGatewayPropertiesFormat21 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworkGateways␊ - */␊ - export interface VirtualNetworkGateways21 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworkGateways"␊ - apiVersion: "2018-10-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway.␊ - */␊ - properties: (VirtualNetworkGatewayPropertiesFormat21 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnets21 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks/subnets"␊ - apiVersion: "2018-10-01"␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties: (SubnetPropertiesFormat14 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/virtualNetworkPeerings␊ - */␊ - export interface VirtualNetworksVirtualNetworkPeerings18 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks/virtualNetworkPeerings"␊ - apiVersion: "2018-10-01"␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties: (VirtualNetworkPeeringPropertiesFormat11 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings␊ - */␊ - export interface ExpressRouteCircuitsPeerings16 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/peerings"␊ - apiVersion: "2018-10-01"␊ - properties: (ExpressRouteCircuitPeeringPropertiesFormat8 | string)␊ - resources?: ExpressRouteCircuitsPeeringsConnectionsChildResource5[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections/peerings␊ - */␊ - export interface ExpressRouteCrossConnectionsPeerings13 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCrossConnections/peerings"␊ - apiVersion: "2018-10-01"␊ - properties: (ExpressRouteCrossConnectionPeeringProperties5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers/inboundNatRules␊ - */␊ - export interface LoadBalancersInboundNatRules18 {␊ - name: string␊ - type: "Microsoft.Network/loadBalancers/inboundNatRules"␊ - apiVersion: "2018-10-01"␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties: (InboundNatRulePropertiesFormat14 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces/tapConfigurations␊ - */␊ - export interface NetworkInterfacesTapConfigurations9 {␊ - name: string␊ - type: "Microsoft.Network/networkInterfaces/tapConfigurations"␊ - apiVersion: "2018-10-01"␊ - /**␊ - * Properties of the Virtual Network Tap configuration␊ - */␊ - properties: (NetworkInterfaceTapConfigurationPropertiesFormat1 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRules22 {␊ - name: string␊ - type: "Microsoft.Network/networkSecurityGroups/securityRules"␊ - apiVersion: "2018-10-01"␊ - /**␊ - * Properties of the security rule␊ - */␊ - properties: (SecurityRulePropertiesFormat14 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutes22 {␊ - name: string␊ - type: "Microsoft.Network/routeTables/routes"␊ - apiVersion: "2018-10-01"␊ - /**␊ - * Properties of the route.␊ - */␊ - properties: (RoutePropertiesFormat14 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/applicationGateways␊ - */␊ - export interface ApplicationGateways22 {␊ - name: string␊ - type: "Microsoft.Network/applicationGateways"␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (ApplicationGatewayPropertiesFormat22 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application gateway.␊ - */␊ - export interface ApplicationGatewayPropertiesFormat22 {␊ - /**␊ - * SKU of the application gateway resource.␊ - */␊ - sku?: (ApplicationGatewaySku22 | string)␊ - /**␊ - * SSL policy of the application gateway resource.␊ - */␊ - sslPolicy?: (ApplicationGatewaySslPolicy19 | string)␊ - /**␊ - * Subnets of application the gateway resource.␊ - */␊ - gatewayIPConfigurations?: (ApplicationGatewayIPConfiguration22[] | string)␊ - /**␊ - * Authentication certificates of the application gateway resource.␊ - */␊ - authenticationCertificates?: (ApplicationGatewayAuthenticationCertificate19[] | string)␊ - /**␊ - * SSL certificates of the application gateway resource.␊ - */␊ - sslCertificates?: (ApplicationGatewaySslCertificate22[] | string)␊ - /**␊ - * Frontend IP addresses of the application gateway resource.␊ - */␊ - frontendIPConfigurations?: (ApplicationGatewayFrontendIPConfiguration22[] | string)␊ - /**␊ - * Frontend ports of the application gateway resource.␊ - */␊ - frontendPorts?: (ApplicationGatewayFrontendPort22[] | string)␊ - /**␊ - * Probes of the application gateway resource.␊ - */␊ - probes?: (ApplicationGatewayProbe21[] | string)␊ - /**␊ - * Backend address pool of the application gateway resource.␊ - */␊ - backendAddressPools?: (ApplicationGatewayBackendAddressPool22[] | string)␊ - /**␊ - * Backend http settings of the application gateway resource.␊ - */␊ - backendHttpSettingsCollection?: (ApplicationGatewayBackendHttpSettings22[] | string)␊ - /**␊ - * Http listeners of the application gateway resource.␊ - */␊ - httpListeners?: (ApplicationGatewayHttpListener22[] | string)␊ - /**␊ - * URL path map of the application gateway resource.␊ - */␊ - urlPathMaps?: (ApplicationGatewayUrlPathMap21[] | string)␊ - /**␊ - * Request routing rules of the application gateway resource.␊ - */␊ - requestRoutingRules?: (ApplicationGatewayRequestRoutingRule22[] | string)␊ - /**␊ - * Redirect configurations of the application gateway resource.␊ - */␊ - redirectConfigurations?: (ApplicationGatewayRedirectConfiguration19[] | string)␊ - /**␊ - * Web application firewall configuration.␊ - */␊ - webApplicationFirewallConfiguration?: (ApplicationGatewayWebApplicationFirewallConfiguration19 | string)␊ - /**␊ - * Whether HTTP2 is enabled on the application gateway resource.␊ - */␊ - enableHttp2?: (boolean | string)␊ - /**␊ - * Resource GUID property of the application gateway resource.␊ - */␊ - resourceGuid?: string␊ - /**␊ - * Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of an application gateway␊ - */␊ - export interface ApplicationGatewaySku22 {␊ - /**␊ - * Name of an application gateway SKU.␊ - */␊ - name?: (("Standard_Small" | "Standard_Medium" | "Standard_Large" | "WAF_Medium" | "WAF_Large") | string)␊ - /**␊ - * Tier of an application gateway.␊ - */␊ - tier?: (("Standard" | "WAF") | string)␊ - /**␊ - * Capacity (instance count) of an application gateway.␊ - */␊ - capacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application Gateway Ssl policy.␊ - */␊ - export interface ApplicationGatewaySslPolicy19 {␊ - /**␊ - * Ssl protocols to be disabled on application gateway.␊ - */␊ - disabledSslProtocols?: (("TLSv1_0" | "TLSv1_1" | "TLSv1_2")[] | string)␊ - /**␊ - * Type of Ssl Policy.␊ - */␊ - policyType?: (("Predefined" | "Custom") | string)␊ - /**␊ - * Name of Ssl predefined policy.␊ - */␊ - policyName?: (("AppGwSslPolicy20150501" | "AppGwSslPolicy20170401" | "AppGwSslPolicy20170401S") | string)␊ - /**␊ - * Ssl cipher suites to be enabled in the specified order to application gateway.␊ - */␊ - cipherSuites?: (("TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384" | "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256" | "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA" | "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA" | "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384" | "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256" | "TLS_DHE_RSA_WITH_AES_256_CBC_SHA" | "TLS_DHE_RSA_WITH_AES_128_CBC_SHA" | "TLS_RSA_WITH_AES_256_GCM_SHA384" | "TLS_RSA_WITH_AES_128_GCM_SHA256" | "TLS_RSA_WITH_AES_256_CBC_SHA256" | "TLS_RSA_WITH_AES_128_CBC_SHA256" | "TLS_RSA_WITH_AES_256_CBC_SHA" | "TLS_RSA_WITH_AES_128_CBC_SHA" | "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384" | "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256" | "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384" | "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256" | "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA" | "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA" | "TLS_DHE_DSS_WITH_AES_256_CBC_SHA256" | "TLS_DHE_DSS_WITH_AES_128_CBC_SHA256" | "TLS_DHE_DSS_WITH_AES_256_CBC_SHA" | "TLS_DHE_DSS_WITH_AES_128_CBC_SHA" | "TLS_RSA_WITH_3DES_EDE_CBC_SHA" | "TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA" | "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256" | "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384")[] | string)␊ - /**␊ - * Minimum version of Ssl protocol to be supported on application gateway.␊ - */␊ - minProtocolVersion?: (("TLSv1_0" | "TLSv1_1" | "TLSv1_2") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed.␊ - */␊ - export interface ApplicationGatewayIPConfiguration22 {␊ - properties?: (ApplicationGatewayIPConfigurationPropertiesFormat22 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayIPConfigurationPropertiesFormat22 {␊ - /**␊ - * Reference of the subnet resource. A subnet from where application gateway gets its private address.␊ - */␊ - subnet?: (SubResource15 | string)␊ - /**␊ - * Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authentication certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewayAuthenticationCertificate19 {␊ - properties?: (ApplicationGatewayAuthenticationCertificatePropertiesFormat19 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authentication certificates properties of an application gateway.␊ - */␊ - export interface ApplicationGatewayAuthenticationCertificatePropertiesFormat19 {␊ - /**␊ - * Certificate public data.␊ - */␊ - data?: string␊ - /**␊ - * Provisioning state of the authentication certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSL certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewaySslCertificate22 {␊ - properties?: (ApplicationGatewaySslCertificatePropertiesFormat22 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewaySslCertificatePropertiesFormat22 {␊ - /**␊ - * Base-64 encoded pfx certificate. Only applicable in PUT Request.␊ - */␊ - data?: string␊ - /**␊ - * Password for the pfx file specified in data. Only applicable in PUT request.␊ - */␊ - password?: string␊ - /**␊ - * Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request.␊ - */␊ - publicCertData?: string␊ - /**␊ - * Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendIPConfiguration22 {␊ - properties?: (ApplicationGatewayFrontendIPConfigurationPropertiesFormat22 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendIPConfigurationPropertiesFormat22 {␊ - /**␊ - * PrivateIPAddress of the network interface IP Configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * PrivateIP allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Reference of the subnet resource.␊ - */␊ - subnet?: (SubResource15 | string)␊ - /**␊ - * Reference of the PublicIP resource.␊ - */␊ - publicIPAddress?: (SubResource15 | string)␊ - /**␊ - * Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend port of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendPort22 {␊ - properties?: (ApplicationGatewayFrontendPortPropertiesFormat22 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend port of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendPortPropertiesFormat22 {␊ - /**␊ - * Frontend port␊ - */␊ - port?: (number | string)␊ - /**␊ - * Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Probe of the application gateway.␊ - */␊ - export interface ApplicationGatewayProbe21 {␊ - properties?: (ApplicationGatewayProbePropertiesFormat21 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of probe of an application gateway.␊ - */␊ - export interface ApplicationGatewayProbePropertiesFormat21 {␊ - /**␊ - * Protocol.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Host name to send the probe to.␊ - */␊ - host?: string␊ - /**␊ - * Relative path of probe. Valid path starts from '/'. Probe is sent to ://:␊ - */␊ - path?: string␊ - /**␊ - * The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - interval?: (number | string)␊ - /**␊ - * the probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - timeout?: (number | string)␊ - /**␊ - * The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20.␊ - */␊ - unhealthyThreshold?: (number | string)␊ - /**␊ - * Whether the host header should be picked from the backend http settings. Default value is false.␊ - */␊ - pickHostNameFromBackendHttpSettings?: (boolean | string)␊ - /**␊ - * Minimum number of servers that are always marked healthy. Default value is 0.␊ - */␊ - minServers?: (number | string)␊ - /**␊ - * Criterion for classifying a healthy probe response.␊ - */␊ - match?: (ApplicationGatewayProbeHealthResponseMatch19 | string)␊ - /**␊ - * Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application gateway probe health response match␊ - */␊ - export interface ApplicationGatewayProbeHealthResponseMatch19 {␊ - /**␊ - * Body that must be contained in the health response. Default value is empty.␊ - */␊ - body?: string␊ - /**␊ - * Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399.␊ - */␊ - statusCodes?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend Address Pool of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddressPool22 {␊ - properties?: (ApplicationGatewayBackendAddressPoolPropertiesFormat22 | string)␊ - /**␊ - * Resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend Address Pool of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddressPoolPropertiesFormat22 {␊ - /**␊ - * Collection of references to IPs defined in network interfaces.␊ - */␊ - backendIPConfigurations?: (SubResource15[] | string)␊ - /**␊ - * Backend addresses␊ - */␊ - backendAddresses?: (ApplicationGatewayBackendAddress22[] | string)␊ - /**␊ - * Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddress22 {␊ - /**␊ - * Fully qualified domain name (FQDN).␊ - */␊ - fqdn?: string␊ - /**␊ - * IP address␊ - */␊ - ipAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address pool settings of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendHttpSettings22 {␊ - properties?: (ApplicationGatewayBackendHttpSettingsPropertiesFormat22 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend address pool settings of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendHttpSettingsPropertiesFormat22 {␊ - /**␊ - * Port␊ - */␊ - port?: (number | string)␊ - /**␊ - * Protocol.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Cookie based affinity.␊ - */␊ - cookieBasedAffinity?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Request timeout in seconds. Application Gateway will fail the request if response is not received within RequestTimeout. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - requestTimeout?: (number | string)␊ - /**␊ - * Probe resource of an application gateway.␊ - */␊ - probe?: (SubResource15 | string)␊ - /**␊ - * Array of references to application gateway authentication certificates.␊ - */␊ - authenticationCertificates?: (SubResource15[] | string)␊ - /**␊ - * Connection draining of the backend http settings resource.␊ - */␊ - connectionDraining?: (ApplicationGatewayConnectionDraining19 | string)␊ - /**␊ - * Host header to be sent to the backend servers.␊ - */␊ - hostName?: string␊ - /**␊ - * Whether to pick host header should be picked from the host name of the backend server. Default value is false.␊ - */␊ - pickHostNameFromBackendAddress?: (boolean | string)␊ - /**␊ - * Cookie name to use for the affinity cookie.␊ - */␊ - affinityCookieName?: string␊ - /**␊ - * Whether the probe is enabled. Default value is false.␊ - */␊ - probeEnabled?: (boolean | string)␊ - /**␊ - * Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null.␊ - */␊ - path?: string␊ - /**␊ - * Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Connection draining allows open connections to a backend server to be active for a specified time after the backend server got removed from the configuration.␊ - */␊ - export interface ApplicationGatewayConnectionDraining19 {␊ - /**␊ - * Whether connection draining is enabled or not.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds.␊ - */␊ - drainTimeoutInSec: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http listener of an application gateway.␊ - */␊ - export interface ApplicationGatewayHttpListener22 {␊ - properties?: (ApplicationGatewayHttpListenerPropertiesFormat22 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of HTTP listener of an application gateway.␊ - */␊ - export interface ApplicationGatewayHttpListenerPropertiesFormat22 {␊ - /**␊ - * Frontend IP configuration resource of an application gateway.␊ - */␊ - frontendIPConfiguration?: (SubResource15 | string)␊ - /**␊ - * Frontend port resource of an application gateway.␊ - */␊ - frontendPort?: (SubResource15 | string)␊ - /**␊ - * Protocol.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Host name of HTTP listener.␊ - */␊ - hostName?: string␊ - /**␊ - * SSL certificate resource of an application gateway.␊ - */␊ - sslCertificate?: (SubResource15 | string)␊ - /**␊ - * Applicable only if protocol is https. Enables SNI for multi-hosting.␊ - */␊ - requireServerNameIndication?: (boolean | string)␊ - /**␊ - * Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * UrlPathMaps give a url path to the backend mapping information for PathBasedRouting.␊ - */␊ - export interface ApplicationGatewayUrlPathMap21 {␊ - properties?: (ApplicationGatewayUrlPathMapPropertiesFormat21 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of UrlPathMap of the application gateway.␊ - */␊ - export interface ApplicationGatewayUrlPathMapPropertiesFormat21 {␊ - /**␊ - * Default backend address pool resource of URL path map.␊ - */␊ - defaultBackendAddressPool?: (SubResource15 | string)␊ - /**␊ - * Default backend http settings resource of URL path map.␊ - */␊ - defaultBackendHttpSettings?: (SubResource15 | string)␊ - /**␊ - * Default redirect configuration resource of URL path map.␊ - */␊ - defaultRedirectConfiguration?: (SubResource15 | string)␊ - /**␊ - * Path rule of URL path map resource.␊ - */␊ - pathRules?: (ApplicationGatewayPathRule21[] | string)␊ - /**␊ - * Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Path rule of URL path map of an application gateway.␊ - */␊ - export interface ApplicationGatewayPathRule21 {␊ - properties?: (ApplicationGatewayPathRulePropertiesFormat21 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of path rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayPathRulePropertiesFormat21 {␊ - /**␊ - * Path rules of URL path map.␊ - */␊ - paths?: (string[] | string)␊ - /**␊ - * Backend address pool resource of URL path map path rule.␊ - */␊ - backendAddressPool?: (SubResource15 | string)␊ - /**␊ - * Backend http settings resource of URL path map path rule.␊ - */␊ - backendHttpSettings?: (SubResource15 | string)␊ - /**␊ - * Redirect configuration resource of URL path map path rule.␊ - */␊ - redirectConfiguration?: (SubResource15 | string)␊ - /**␊ - * Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Request routing rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayRequestRoutingRule22 {␊ - properties?: (ApplicationGatewayRequestRoutingRulePropertiesFormat22 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of request routing rule of the application gateway.␊ - */␊ - export interface ApplicationGatewayRequestRoutingRulePropertiesFormat22 {␊ - /**␊ - * Rule type.␊ - */␊ - ruleType?: (("Basic" | "PathBasedRouting") | string)␊ - /**␊ - * Backend address pool resource of the application gateway. ␊ - */␊ - backendAddressPool?: (SubResource15 | string)␊ - /**␊ - * Frontend port resource of the application gateway.␊ - */␊ - backendHttpSettings?: (SubResource15 | string)␊ - /**␊ - * Http listener resource of the application gateway. ␊ - */␊ - httpListener?: (SubResource15 | string)␊ - /**␊ - * URL path map resource of the application gateway.␊ - */␊ - urlPathMap?: (SubResource15 | string)␊ - /**␊ - * Redirect configuration resource of the application gateway.␊ - */␊ - redirectConfiguration?: (SubResource15 | string)␊ - /**␊ - * Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Redirect configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayRedirectConfiguration19 {␊ - properties?: (ApplicationGatewayRedirectConfigurationPropertiesFormat19 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - /**␊ - * Type of the resource.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of redirect configuration of the application gateway.␊ - */␊ - export interface ApplicationGatewayRedirectConfigurationPropertiesFormat19 {␊ - /**␊ - * Supported http redirection types - Permanent, Temporary, Found, SeeOther.␊ - */␊ - redirectType?: (("Permanent" | "Found" | "SeeOther" | "Temporary") | string)␊ - /**␊ - * Reference to a listener to redirect the request to.␊ - */␊ - targetListener?: (SubResource15 | string)␊ - /**␊ - * Url to redirect the request to.␊ - */␊ - targetUrl?: string␊ - /**␊ - * Include path in the redirected url.␊ - */␊ - includePath?: (boolean | string)␊ - /**␊ - * Include query string in the redirected url.␊ - */␊ - includeQueryString?: (boolean | string)␊ - /**␊ - * Request routing specifying redirect configuration.␊ - */␊ - requestRoutingRules?: (SubResource15[] | string)␊ - /**␊ - * Url path maps specifying default redirect configuration.␊ - */␊ - urlPathMaps?: (SubResource15[] | string)␊ - /**␊ - * Path rules specifying redirect configuration.␊ - */␊ - pathRules?: (SubResource15[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application gateway web application firewall configuration.␊ - */␊ - export interface ApplicationGatewayWebApplicationFirewallConfiguration19 {␊ - /**␊ - * Whether the web application firewall is enabled or not.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * Web application firewall mode.␊ - */␊ - firewallMode: (("Detection" | "Prevention") | string)␊ - /**␊ - * The type of the web application firewall rule set. Possible values are: 'OWASP'.␊ - */␊ - ruleSetType: string␊ - /**␊ - * The version of the rule set type.␊ - */␊ - ruleSetVersion: string␊ - /**␊ - * The disabled rule groups.␊ - */␊ - disabledRuleGroups?: (ApplicationGatewayFirewallDisabledRuleGroup19[] | string)␊ - /**␊ - * Whether allow WAF to check request Body.␊ - */␊ - requestBodyCheck?: (boolean | string)␊ - /**␊ - * Maxium request body size for WAF.␊ - */␊ - maxRequestBodySize?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allows to disable rules within a rule group or an entire rule group.␊ - */␊ - export interface ApplicationGatewayFirewallDisabledRuleGroup19 {␊ - /**␊ - * The name of the rule group that will be disabled.␊ - */␊ - ruleGroupName: string␊ - /**␊ - * The list of rules that will be disabled. If null, all rules of the rule group will be disabled.␊ - */␊ - rules?: (number[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/connections␊ - */␊ - export interface Connections22 {␊ - name: string␊ - type: "Microsoft.Network/connections"␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway connection.␊ - */␊ - properties: (VirtualNetworkGatewayConnectionPropertiesFormat22 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewayConnection properties␊ - */␊ - export interface VirtualNetworkGatewayConnectionPropertiesFormat22 {␊ - /**␊ - * The authorizationKey.␊ - */␊ - authorizationKey?: string␊ - /**␊ - * The reference to virtual network gateway resource.␊ - */␊ - virtualNetworkGateway1: (VirtualNetworkGateway13 | SubResource15 | string)␊ - /**␊ - * The reference to virtual network gateway resource.␊ - */␊ - virtualNetworkGateway2?: (VirtualNetworkGateway13 | SubResource15 | string)␊ - /**␊ - * The reference to local network gateway resource.␊ - */␊ - localNetworkGateway2?: (LocalNetworkGateway13 | SubResource15 | string)␊ - /**␊ - * Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.␊ - */␊ - connectionType: (("IPsec" | "Vnet2Vnet" | "ExpressRoute" | "VPNClient") | string)␊ - /**␊ - * The routing weight.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * The IPSec shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The reference to peerings resource.␊ - */␊ - peer?: (SubResource15 | string)␊ - /**␊ - * EnableBgp flag␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * Enable policy-based traffic selectors.␊ - */␊ - usePolicyBasedTrafficSelectors?: (boolean | string)␊ - /**␊ - * The IPSec Policies to be considered by this connection.␊ - */␊ - ipsecPolicies?: (IpsecPolicy19[] | string)␊ - /**␊ - * The resource GUID property of the VirtualNetworkGatewayConnection resource.␊ - */␊ - resourceGuid?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A common class for general resource information␊ - */␊ - export interface VirtualNetworkGateway13 {␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway.␊ - */␊ - properties: (VirtualNetworkGatewayPropertiesFormat22 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGateway properties␊ - */␊ - export interface VirtualNetworkGatewayPropertiesFormat22 {␊ - /**␊ - * IP configurations for virtual network gateway.␊ - */␊ - ipConfigurations?: (VirtualNetworkGatewayIPConfiguration21[] | string)␊ - /**␊ - * The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'.␊ - */␊ - gatewayType?: (("Vpn" | "ExpressRoute") | string)␊ - /**␊ - * The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'.␊ - */␊ - vpnType?: (("PolicyBased" | "RouteBased") | string)␊ - /**␊ - * Whether BGP is enabled for this virtual network gateway or not.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * ActiveActive flag␊ - */␊ - activeActive?: (boolean | string)␊ - /**␊ - * The reference of the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting.␊ - */␊ - gatewayDefaultSite?: (SubResource15 | string)␊ - /**␊ - * The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.␊ - */␊ - sku?: (VirtualNetworkGatewaySku21 | string)␊ - /**␊ - * The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations.␊ - */␊ - vpnClientConfiguration?: (VpnClientConfiguration21 | string)␊ - /**␊ - * Virtual network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings21 | string)␊ - /**␊ - * The resource GUID property of the VirtualNetworkGateway resource.␊ - */␊ - resourceGuid?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration for virtual network gateway␊ - */␊ - export interface VirtualNetworkGatewayIPConfiguration21 {␊ - /**␊ - * Properties of the virtual network gateway ip configuration.␊ - */␊ - properties?: (VirtualNetworkGatewayIPConfigurationPropertiesFormat21 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of VirtualNetworkGatewayIPConfiguration␊ - */␊ - export interface VirtualNetworkGatewayIPConfigurationPropertiesFormat21 {␊ - /**␊ - * The private IP allocation method. Possible values are: 'Static' and 'Dynamic'.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * The reference of the subnet resource.␊ - */␊ - subnet?: (SubResource15 | string)␊ - /**␊ - * The reference of the public IP resource.␊ - */␊ - publicIPAddress?: (SubResource15 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewaySku details␊ - */␊ - export interface VirtualNetworkGatewaySku21 {␊ - /**␊ - * Gateway SKU name.␊ - */␊ - name?: (("Basic" | "HighPerformance" | "Standard" | "UltraPerformance" | "VpnGw1" | "VpnGw2" | "VpnGw3") | string)␊ - /**␊ - * Gateway SKU tier.␊ - */␊ - tier?: (("Basic" | "HighPerformance" | "Standard" | "UltraPerformance" | "VpnGw1" | "VpnGw2" | "VpnGw3") | string)␊ - /**␊ - * The capacity.␊ - */␊ - capacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnClientConfiguration for P2S client.␊ - */␊ - export interface VpnClientConfiguration21 {␊ - /**␊ - * The reference of the address space resource which represents Address space for P2S VpnClient.␊ - */␊ - vpnClientAddressPool?: (AddressSpace17 | string)␊ - /**␊ - * VpnClientRootCertificate for virtual network gateway.␊ - */␊ - vpnClientRootCertificates?: (VpnClientRootCertificate21[] | string)␊ - /**␊ - * VpnClientRevokedCertificate for Virtual network gateway.␊ - */␊ - vpnClientRevokedCertificates?: (VpnClientRevokedCertificate21[] | string)␊ - /**␊ - * VpnClientProtocols for Virtual network gateway.␊ - */␊ - vpnClientProtocols?: (("IkeV2" | "SSTP")[] | string)␊ - /**␊ - * VpnClientIpsecPolicies for virtual network gateway P2S client.␊ - */␊ - vpnClientIpsecPolicies?: (IpsecPolicy19[] | string)␊ - /**␊ - * The radius server address property of the VirtualNetworkGateway resource for vpn client connection.␊ - */␊ - radiusServerAddress?: string␊ - /**␊ - * The radius secret property of the VirtualNetworkGateway resource for vpn client connection.␊ - */␊ - radiusServerSecret?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client root certificate of virtual network gateway␊ - */␊ - export interface VpnClientRootCertificate21 {␊ - /**␊ - * Properties of the vpn client root certificate.␊ - */␊ - properties: (VpnClientRootCertificatePropertiesFormat21 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of application gateway␊ - */␊ - export interface VpnClientRootCertificatePropertiesFormat21 {␊ - /**␊ - * The certificate public data.␊ - */␊ - publicCertData: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client revoked certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRevokedCertificate21 {␊ - /**␊ - * Properties of the vpn client revoked certificate.␊ - */␊ - properties?: (VpnClientRevokedCertificatePropertiesFormat21 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the revoked VPN client certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRevokedCertificatePropertiesFormat21 {␊ - /**␊ - * The revoked VPN client certificate thumbprint.␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An IPSec Policy configuration for a virtual network gateway connection␊ - */␊ - export interface IpsecPolicy19 {␊ - /**␊ - * The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.␊ - */␊ - saLifeTimeSeconds: (number | string)␊ - /**␊ - * The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.␊ - */␊ - saDataSizeKilobytes: (number | string)␊ - /**␊ - * The IPSec encryption algorithm (IKE phase 1).␊ - */␊ - ipsecEncryption: (("None" | "DES" | "DES3" | "AES128" | "AES192" | "AES256" | "GCMAES128" | "GCMAES192" | "GCMAES256") | string)␊ - /**␊ - * The IPSec integrity algorithm (IKE phase 1).␊ - */␊ - ipsecIntegrity: (("MD5" | "SHA1" | "SHA256" | "GCMAES128" | "GCMAES192" | "GCMAES256") | string)␊ - /**␊ - * The IKE encryption algorithm (IKE phase 2).␊ - */␊ - ikeEncryption: (("DES" | "DES3" | "AES128" | "AES192" | "AES256" | "GCMAES256" | "GCMAES128") | string)␊ - /**␊ - * The IKE integrity algorithm (IKE phase 2).␊ - */␊ - ikeIntegrity: (("MD5" | "SHA1" | "SHA256" | "SHA384" | "GCMAES256" | "GCMAES128") | string)␊ - /**␊ - * The DH Groups used in IKE Phase 1 for initial SA.␊ - */␊ - dhGroup: (("None" | "DHGroup1" | "DHGroup2" | "DHGroup14" | "DHGroup2048" | "ECP256" | "ECP384" | "DHGroup24") | string)␊ - /**␊ - * The Pfs Groups used in IKE Phase 2 for new child SA.␊ - */␊ - pfsGroup: (("None" | "PFS1" | "PFS2" | "PFS2048" | "ECP256" | "ECP384" | "PFS24" | "PFS14" | "PFSMM") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * BGP settings details␊ - */␊ - export interface BgpSettings21 {␊ - /**␊ - * The BGP speaker's ASN.␊ - */␊ - asn?: (number | string)␊ - /**␊ - * The BGP peering address and BGP identifier of this BGP speaker.␊ - */␊ - bgpPeeringAddress?: string␊ - /**␊ - * The weight added to routes learned from this BGP speaker.␊ - */␊ - peerWeight?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A common class for general resource information␊ - */␊ - export interface LocalNetworkGateway13 {␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the local network gateway.␊ - */␊ - properties: (LocalNetworkGatewayPropertiesFormat22 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * LocalNetworkGateway properties␊ - */␊ - export interface LocalNetworkGatewayPropertiesFormat22 {␊ - /**␊ - * Local network site address space.␊ - */␊ - localNetworkAddressSpace?: (AddressSpace17 | string)␊ - /**␊ - * IP address of local network gateway.␊ - */␊ - gatewayIpAddress?: string␊ - /**␊ - * Local network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings21 | string)␊ - /**␊ - * The resource GUID property of the LocalNetworkGateway resource.␊ - */␊ - resourceGuid?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/localNetworkGateways␊ - */␊ - export interface LocalNetworkGateways22 {␊ - name: string␊ - type: "Microsoft.Network/localNetworkGateways"␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the local network gateway.␊ - */␊ - properties: (LocalNetworkGatewayPropertiesFormat22 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworkGateways␊ - */␊ - export interface VirtualNetworkGateways22 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworkGateways"␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway.␊ - */␊ - properties: (VirtualNetworkGatewayPropertiesFormat22 | string)␊ - /**␊ - * Gets a unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnets22 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks/subnets"␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties: (SubnetPropertiesFormat9 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/virtualNetworkPeerings␊ - */␊ - export interface VirtualNetworksVirtualNetworkPeerings19 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks/virtualNetworkPeerings"␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties: (VirtualNetworkPeeringPropertiesFormat6 | string)␊ - /**␊ - * A unique read-only string that changes whenever the resource is updated.␊ - */␊ - etag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones␊ - */␊ - export interface DnsZones2 {␊ - name: string␊ - type: "Microsoft.Network/dnsZones"␊ - apiVersion: "2018-05-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The etag of the zone.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the zone.␊ - */␊ - properties: (ZoneProperties2 | string)␊ - resources?: (DnsZones_TXTChildResource2 | DnsZones_SRVChildResource2 | DnsZones_SOAChildResource2 | DnsZones_PTRChildResource2 | DnsZones_NSChildResource2 | DnsZones_MXChildResource2 | DnsZones_CNAMEChildResource2 | DnsZones_CAAChildResource2 | DnsZones_AAAAChildResource2 | DnsZones_AChildResource2)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents the properties of the zone.␊ - */␊ - export interface ZoneProperties2 {␊ - /**␊ - * The type of this DNS zone (Public or Private).␊ - */␊ - zoneType?: (("Public" | "Private") | string)␊ - /**␊ - * A list of references to virtual networks that register hostnames in this DNS zone. This is a only when ZoneType is Private.␊ - */␊ - registrationVirtualNetworks?: (SubResource29[] | string)␊ - /**␊ - * A list of references to virtual networks that resolve records in this DNS zone. This is a only when ZoneType is Private.␊ - */␊ - resolutionVirtualNetworks?: (SubResource29[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A reference to a another resource␊ - */␊ - export interface SubResource29 {␊ - /**␊ - * Resource Id.␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/TXT␊ - */␊ - export interface DnsZones_TXTChildResource2 {␊ - name: string␊ - type: "TXT"␊ - apiVersion: "2018-05-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents the properties of the records in the record set.␊ - */␊ - export interface RecordSetProperties4 {␊ - /**␊ - * The metadata attached to the record set.␊ - */␊ - metadata?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The TTL (time-to-live) of the records in the record set.␊ - */␊ - TTL?: (number | string)␊ - /**␊ - * A reference to an azure resource from where the dns resource value is taken.␊ - */␊ - targetResource?: (SubResource29 | string)␊ - /**␊ - * The list of A records in the record set.␊ - */␊ - ARecords?: (ARecord4[] | string)␊ - /**␊ - * The list of AAAA records in the record set.␊ - */␊ - AAAARecords?: (AaaaRecord4[] | string)␊ - /**␊ - * The list of MX records in the record set.␊ - */␊ - MXRecords?: (MxRecord4[] | string)␊ - /**␊ - * The list of NS records in the record set.␊ - */␊ - NSRecords?: (NsRecord4[] | string)␊ - /**␊ - * The list of PTR records in the record set.␊ - */␊ - PTRRecords?: (PtrRecord4[] | string)␊ - /**␊ - * The list of SRV records in the record set.␊ - */␊ - SRVRecords?: (SrvRecord4[] | string)␊ - /**␊ - * The list of TXT records in the record set.␊ - */␊ - TXTRecords?: (TxtRecord4[] | string)␊ - /**␊ - * The CNAME record in the record set.␊ - */␊ - CNAMERecord?: (CnameRecord4 | string)␊ - /**␊ - * The SOA record in the record set.␊ - */␊ - SOARecord?: (SoaRecord4 | string)␊ - /**␊ - * The list of CAA records in the record set.␊ - */␊ - caaRecords?: (CaaRecord2[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An A record.␊ - */␊ - export interface ARecord4 {␊ - /**␊ - * The IPv4 address of this A record.␊ - */␊ - ipv4Address?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An AAAA record.␊ - */␊ - export interface AaaaRecord4 {␊ - /**␊ - * The IPv6 address of this AAAA record.␊ - */␊ - ipv6Address?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An MX record.␊ - */␊ - export interface MxRecord4 {␊ - /**␊ - * The preference value for this MX record.␊ - */␊ - preference?: (number | string)␊ - /**␊ - * The domain name of the mail host for this MX record.␊ - */␊ - exchange?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An NS record.␊ - */␊ - export interface NsRecord4 {␊ - /**␊ - * The name server name for this NS record.␊ - */␊ - nsdname?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A PTR record.␊ - */␊ - export interface PtrRecord4 {␊ - /**␊ - * The PTR target domain name for this PTR record.␊ - */␊ - ptrdname?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An SRV record.␊ - */␊ - export interface SrvRecord4 {␊ - /**␊ - * The priority value for this SRV record.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * The weight value for this SRV record.␊ - */␊ - weight?: (number | string)␊ - /**␊ - * The port value for this SRV record.␊ - */␊ - port?: (number | string)␊ - /**␊ - * The target domain name for this SRV record.␊ - */␊ - target?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A TXT record.␊ - */␊ - export interface TxtRecord4 {␊ - /**␊ - * The text value of this TXT record.␊ - */␊ - value?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A CNAME record.␊ - */␊ - export interface CnameRecord4 {␊ - /**␊ - * The canonical name for this CNAME record.␊ - */␊ - cname?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An SOA record.␊ - */␊ - export interface SoaRecord4 {␊ - /**␊ - * The domain name of the authoritative name server for this SOA record.␊ - */␊ - host?: string␊ - /**␊ - * The email contact for this SOA record.␊ - */␊ - email?: string␊ - /**␊ - * The serial number for this SOA record.␊ - */␊ - serialNumber?: (number | string)␊ - /**␊ - * The refresh value for this SOA record.␊ - */␊ - refreshTime?: (number | string)␊ - /**␊ - * The retry time for this SOA record.␊ - */␊ - retryTime?: (number | string)␊ - /**␊ - * The expire time for this SOA record.␊ - */␊ - expireTime?: (number | string)␊ - /**␊ - * The minimum value for this SOA record. By convention this is used to determine the negative caching duration.␊ - */␊ - minimumTTL?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A CAA record.␊ - */␊ - export interface CaaRecord2 {␊ - /**␊ - * The flags for this CAA record as an integer between 0 and 255.␊ - */␊ - flags?: (number | string)␊ - /**␊ - * The tag for this CAA record.␊ - */␊ - tag?: string␊ - /**␊ - * The value for this CAA record.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/SRV␊ - */␊ - export interface DnsZones_SRVChildResource2 {␊ - name: string␊ - type: "SRV"␊ - apiVersion: "2018-05-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/SOA␊ - */␊ - export interface DnsZones_SOAChildResource2 {␊ - name: string␊ - type: "SOA"␊ - apiVersion: "2018-05-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/PTR␊ - */␊ - export interface DnsZones_PTRChildResource2 {␊ - name: string␊ - type: "PTR"␊ - apiVersion: "2018-05-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/NS␊ - */␊ - export interface DnsZones_NSChildResource2 {␊ - name: string␊ - type: "NS"␊ - apiVersion: "2018-05-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/MX␊ - */␊ - export interface DnsZones_MXChildResource2 {␊ - name: string␊ - type: "MX"␊ - apiVersion: "2018-05-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/CNAME␊ - */␊ - export interface DnsZones_CNAMEChildResource2 {␊ - name: string␊ - type: "CNAME"␊ - apiVersion: "2018-05-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/CAA␊ - */␊ - export interface DnsZones_CAAChildResource2 {␊ - name: string␊ - type: "CAA"␊ - apiVersion: "2018-05-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/AAAA␊ - */␊ - export interface DnsZones_AAAAChildResource2 {␊ - name: string␊ - type: "AAAA"␊ - apiVersion: "2018-05-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/A␊ - */␊ - export interface DnsZones_AChildResource2 {␊ - name: string␊ - type: "A"␊ - apiVersion: "2018-05-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/A␊ - */␊ - export interface DnsZones_A2 {␊ - name: string␊ - type: "Microsoft.Network/dnsZones/A"␊ - apiVersion: "2018-05-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/AAAA␊ - */␊ - export interface DnsZones_AAAA2 {␊ - name: string␊ - type: "Microsoft.Network/dnsZones/AAAA"␊ - apiVersion: "2018-05-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/CAA␊ - */␊ - export interface DnsZones_CAA2 {␊ - name: string␊ - type: "Microsoft.Network/dnsZones/CAA"␊ - apiVersion: "2018-05-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/CNAME␊ - */␊ - export interface DnsZones_CNAME2 {␊ - name: string␊ - type: "Microsoft.Network/dnsZones/CNAME"␊ - apiVersion: "2018-05-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/MX␊ - */␊ - export interface DnsZones_MX2 {␊ - name: string␊ - type: "Microsoft.Network/dnsZones/MX"␊ - apiVersion: "2018-05-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/NS␊ - */␊ - export interface DnsZones_NS2 {␊ - name: string␊ - type: "Microsoft.Network/dnsZones/NS"␊ - apiVersion: "2018-05-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/PTR␊ - */␊ - export interface DnsZones_PTR2 {␊ - name: string␊ - type: "Microsoft.Network/dnsZones/PTR"␊ - apiVersion: "2018-05-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/SOA␊ - */␊ - export interface DnsZones_SOA2 {␊ - name: string␊ - type: "Microsoft.Network/dnsZones/SOA"␊ - apiVersion: "2018-05-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/SRV␊ - */␊ - export interface DnsZones_SRV2 {␊ - name: string␊ - type: "Microsoft.Network/dnsZones/SRV"␊ - apiVersion: "2018-05-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/dnsZones/TXT␊ - */␊ - export interface DnsZones_TXT2 {␊ - name: string␊ - type: "Microsoft.Network/dnsZones/TXT"␊ - apiVersion: "2018-05-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateDnsZones␊ - */␊ - export interface PrivateDnsZones {␊ - name: string␊ - type: "Microsoft.Network/privateDnsZones"␊ - apiVersion: "2018-09-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The ETag of the Private DNS zone.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the Private DNS zone.␊ - */␊ - properties: ({␊ - [k: string]: unknown␊ - } | string)␊ - resources?: (PrivateDnsZonesVirtualNetworkLinksChildResource | PrivateDnsZones_AChildResource | PrivateDnsZones_AAAAChildResource | PrivateDnsZones_CNAMEChildResource | PrivateDnsZones_MXChildResource | PrivateDnsZones_PTRChildResource | PrivateDnsZones_SOAChildResource | PrivateDnsZones_SRVChildResource | PrivateDnsZones_TXTChildResource)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateDnsZones/virtualNetworkLinks␊ - */␊ - export interface PrivateDnsZonesVirtualNetworkLinksChildResource {␊ - name: string␊ - type: "Microsoft.Network/privateDnsZones/virtualNetworkLinks"␊ - apiVersion: "2018-09-01"␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The etag of the virtual network link.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the virtual network link.␊ - */␊ - properties: (VirtualNetworkLinkProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents the properties of the virtual network link to the Private DNS zone.␊ - */␊ - export interface VirtualNetworkLinkProperties {␊ - /**␊ - * The reference to the virtual network.␊ - */␊ - virtualNetwork?: (SubResource30 | string)␊ - /**␊ - * Is auto-registration of virtual machine records in the virtual network in the Private DNS zone enabled?␊ - */␊ - registrationEnabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A reference to a another resource.␊ - */␊ - export interface SubResource30 {␊ - /**␊ - * Resource ID.␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateDnsZones/A␊ - */␊ - export interface PrivateDnsZones_AChildResource {␊ - name: string␊ - type: "A"␊ - apiVersion: "2018-09-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents the properties of the records in the record set.␊ - */␊ - export interface RecordSetProperties5 {␊ - /**␊ - * The metadata attached to the record set.␊ - */␊ - metadata?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The TTL (time-to-live) of the records in the record set.␊ - */␊ - ttl?: (number | string)␊ - /**␊ - * The list of A records in the record set.␊ - */␊ - aRecords?: (ARecord5[] | string)␊ - /**␊ - * The list of AAAA records in the record set.␊ - */␊ - aaaaRecords?: (AaaaRecord5[] | string)␊ - /**␊ - * The CNAME record in the record set.␊ - */␊ - cnameRecord?: (CnameRecord5 | string)␊ - /**␊ - * The list of MX records in the record set.␊ - */␊ - mxRecords?: (MxRecord5[] | string)␊ - /**␊ - * The list of PTR records in the record set.␊ - */␊ - ptrRecords?: (PtrRecord5[] | string)␊ - /**␊ - * The SOA record in the record set.␊ - */␊ - soaRecord?: (SoaRecord5 | string)␊ - /**␊ - * The list of SRV records in the record set.␊ - */␊ - srvRecords?: (SrvRecord5[] | string)␊ - /**␊ - * The list of TXT records in the record set.␊ - */␊ - txtRecords?: (TxtRecord5[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An A record.␊ - */␊ - export interface ARecord5 {␊ - /**␊ - * The IPv4 address of this A record.␊ - */␊ - ipv4Address?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An AAAA record.␊ - */␊ - export interface AaaaRecord5 {␊ - /**␊ - * The IPv6 address of this AAAA record.␊ - */␊ - ipv6Address?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A CNAME record.␊ - */␊ - export interface CnameRecord5 {␊ - /**␊ - * The canonical name for this CNAME record.␊ - */␊ - cname?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An MX record.␊ - */␊ - export interface MxRecord5 {␊ - /**␊ - * The preference value for this MX record.␊ - */␊ - preference?: (number | string)␊ - /**␊ - * The domain name of the mail host for this MX record.␊ - */␊ - exchange?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A PTR record.␊ - */␊ - export interface PtrRecord5 {␊ - /**␊ - * The PTR target domain name for this PTR record.␊ - */␊ - ptrdname?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An SOA record.␊ - */␊ - export interface SoaRecord5 {␊ - /**␊ - * The domain name of the authoritative name server for this SOA record.␊ - */␊ - host?: string␊ - /**␊ - * The email contact for this SOA record.␊ - */␊ - email?: string␊ - /**␊ - * The serial number for this SOA record.␊ - */␊ - serialNumber?: (number | string)␊ - /**␊ - * The refresh value for this SOA record.␊ - */␊ - refreshTime?: (number | string)␊ - /**␊ - * The retry time for this SOA record.␊ - */␊ - retryTime?: (number | string)␊ - /**␊ - * The expire time for this SOA record.␊ - */␊ - expireTime?: (number | string)␊ - /**␊ - * The minimum value for this SOA record. By convention this is used to determine the negative caching duration.␊ - */␊ - minimumTtl?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An SRV record.␊ - */␊ - export interface SrvRecord5 {␊ - /**␊ - * The priority value for this SRV record.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * The weight value for this SRV record.␊ - */␊ - weight?: (number | string)␊ - /**␊ - * The port value for this SRV record.␊ - */␊ - port?: (number | string)␊ - /**␊ - * The target domain name for this SRV record.␊ - */␊ - target?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A TXT record.␊ - */␊ - export interface TxtRecord5 {␊ - /**␊ - * The text value of this TXT record.␊ - */␊ - value?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateDnsZones/AAAA␊ - */␊ - export interface PrivateDnsZones_AAAAChildResource {␊ - name: string␊ - type: "AAAA"␊ - apiVersion: "2018-09-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateDnsZones/CNAME␊ - */␊ - export interface PrivateDnsZones_CNAMEChildResource {␊ - name: string␊ - type: "CNAME"␊ - apiVersion: "2018-09-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateDnsZones/MX␊ - */␊ - export interface PrivateDnsZones_MXChildResource {␊ - name: string␊ - type: "MX"␊ - apiVersion: "2018-09-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateDnsZones/PTR␊ - */␊ - export interface PrivateDnsZones_PTRChildResource {␊ - name: string␊ - type: "PTR"␊ - apiVersion: "2018-09-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateDnsZones/SOA␊ - */␊ - export interface PrivateDnsZones_SOAChildResource {␊ - name: string␊ - type: "SOA"␊ - apiVersion: "2018-09-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateDnsZones/SRV␊ - */␊ - export interface PrivateDnsZones_SRVChildResource {␊ - name: string␊ - type: "SRV"␊ - apiVersion: "2018-09-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateDnsZones/TXT␊ - */␊ - export interface PrivateDnsZones_TXTChildResource {␊ - name: string␊ - type: "TXT"␊ - apiVersion: "2018-09-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateDnsZones/virtualNetworkLinks␊ - */␊ - export interface PrivateDnsZonesVirtualNetworkLinks {␊ - name: string␊ - type: "Microsoft.Network/privateDnsZones/virtualNetworkLinks"␊ - apiVersion: "2018-09-01"␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The etag of the virtual network link.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the virtual network link.␊ - */␊ - properties: (VirtualNetworkLinkProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateDnsZones/A␊ - */␊ - export interface PrivateDnsZones_A {␊ - name: string␊ - type: "Microsoft.Network/privateDnsZones/A"␊ - apiVersion: "2018-09-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateDnsZones/AAAA␊ - */␊ - export interface PrivateDnsZones_AAAA {␊ - name: string␊ - type: "Microsoft.Network/privateDnsZones/AAAA"␊ - apiVersion: "2018-09-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateDnsZones/CNAME␊ - */␊ - export interface PrivateDnsZones_CNAME {␊ - name: string␊ - type: "Microsoft.Network/privateDnsZones/CNAME"␊ - apiVersion: "2018-09-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateDnsZones/MX␊ - */␊ - export interface PrivateDnsZones_MX {␊ - name: string␊ - type: "Microsoft.Network/privateDnsZones/MX"␊ - apiVersion: "2018-09-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateDnsZones/PTR␊ - */␊ - export interface PrivateDnsZones_PTR {␊ - name: string␊ - type: "Microsoft.Network/privateDnsZones/PTR"␊ - apiVersion: "2018-09-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateDnsZones/SOA␊ - */␊ - export interface PrivateDnsZones_SOA {␊ - name: string␊ - type: "Microsoft.Network/privateDnsZones/SOA"␊ - apiVersion: "2018-09-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateDnsZones/SRV␊ - */␊ - export interface PrivateDnsZones_SRV {␊ - name: string␊ - type: "Microsoft.Network/privateDnsZones/SRV"␊ - apiVersion: "2018-09-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateDnsZones/TXT␊ - */␊ - export interface PrivateDnsZones_TXT {␊ - name: string␊ - type: "Microsoft.Network/privateDnsZones/TXT"␊ - apiVersion: "2018-09-01"␊ - /**␊ - * The etag of the record set.␊ - */␊ - etag?: string␊ - /**␊ - * The properties of the record set.␊ - */␊ - properties: (RecordSetProperties5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/applicationGateways␊ - */␊ - export interface ApplicationGateways23 {␊ - name: string␊ - type: "Microsoft.Network/applicationGateways"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the application gateway.␊ - */␊ - properties: (ApplicationGatewayPropertiesFormat23 | string)␊ - /**␊ - * A list of availability zones denoting where the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - /**␊ - * The identity of the application gateway, if configured.␊ - */␊ - identity?: (ManagedServiceIdentity9 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application gateway.␊ - */␊ - export interface ApplicationGatewayPropertiesFormat23 {␊ - /**␊ - * SKU of the application gateway resource.␊ - */␊ - sku?: (ApplicationGatewaySku23 | string)␊ - /**␊ - * SSL policy of the application gateway resource.␊ - */␊ - sslPolicy?: (ApplicationGatewaySslPolicy20 | string)␊ - /**␊ - * Subnets of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - gatewayIPConfigurations?: (ApplicationGatewayIPConfiguration23[] | string)␊ - /**␊ - * Authentication certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - authenticationCertificates?: (ApplicationGatewayAuthenticationCertificate20[] | string)␊ - /**␊ - * Trusted Root certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - trustedRootCertificates?: (ApplicationGatewayTrustedRootCertificate10[] | string)␊ - /**␊ - * SSL certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - sslCertificates?: (ApplicationGatewaySslCertificate23[] | string)␊ - /**␊ - * Frontend IP addresses of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - frontendIPConfigurations?: (ApplicationGatewayFrontendIPConfiguration23[] | string)␊ - /**␊ - * Frontend ports of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - frontendPorts?: (ApplicationGatewayFrontendPort23[] | string)␊ - /**␊ - * Probes of the application gateway resource.␊ - */␊ - probes?: (ApplicationGatewayProbe22[] | string)␊ - /**␊ - * Backend address pool of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - backendAddressPools?: (ApplicationGatewayBackendAddressPool23[] | string)␊ - /**␊ - * Backend http settings of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - backendHttpSettingsCollection?: (ApplicationGatewayBackendHttpSettings23[] | string)␊ - /**␊ - * Http listeners of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - httpListeners?: (ApplicationGatewayHttpListener23[] | string)␊ - /**␊ - * URL path map of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - urlPathMaps?: (ApplicationGatewayUrlPathMap22[] | string)␊ - /**␊ - * Request routing rules of the application gateway resource.␊ - */␊ - requestRoutingRules?: (ApplicationGatewayRequestRoutingRule23[] | string)␊ - /**␊ - * Rewrite rules for the application gateway resource.␊ - */␊ - rewriteRuleSets?: (ApplicationGatewayRewriteRuleSet9[] | string)␊ - /**␊ - * Redirect configurations of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - redirectConfigurations?: (ApplicationGatewayRedirectConfiguration20[] | string)␊ - /**␊ - * Web application firewall configuration.␊ - */␊ - webApplicationFirewallConfiguration?: (ApplicationGatewayWebApplicationFirewallConfiguration20 | string)␊ - /**␊ - * Reference to the FirewallPolicy resource.␊ - */␊ - firewallPolicy?: (SubResource31 | string)␊ - /**␊ - * Whether HTTP2 is enabled on the application gateway resource.␊ - */␊ - enableHttp2?: (boolean | string)␊ - /**␊ - * Whether FIPS is enabled on the application gateway resource.␊ - */␊ - enableFips?: (boolean | string)␊ - /**␊ - * Autoscale Configuration.␊ - */␊ - autoscaleConfiguration?: (ApplicationGatewayAutoscaleConfiguration13 | string)␊ - /**␊ - * Custom error configurations of the application gateway resource.␊ - */␊ - customErrorConfigurations?: (ApplicationGatewayCustomError10[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of an application gateway.␊ - */␊ - export interface ApplicationGatewaySku23 {␊ - /**␊ - * Name of an application gateway SKU.␊ - */␊ - name?: (("Standard_Small" | "Standard_Medium" | "Standard_Large" | "WAF_Medium" | "WAF_Large" | "Standard_v2" | "WAF_v2") | string)␊ - /**␊ - * Tier of an application gateway.␊ - */␊ - tier?: (("Standard" | "WAF" | "Standard_v2" | "WAF_v2") | string)␊ - /**␊ - * Capacity (instance count) of an application gateway.␊ - */␊ - capacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application Gateway Ssl policy.␊ - */␊ - export interface ApplicationGatewaySslPolicy20 {␊ - /**␊ - * Ssl protocols to be disabled on application gateway.␊ - */␊ - disabledSslProtocols?: (("TLSv1_0" | "TLSv1_1" | "TLSv1_2")[] | string)␊ - /**␊ - * Type of Ssl Policy.␊ - */␊ - policyType?: (("Predefined" | "Custom") | string)␊ - /**␊ - * Name of Ssl predefined policy.␊ - */␊ - policyName?: (("AppGwSslPolicy20150501" | "AppGwSslPolicy20170401" | "AppGwSslPolicy20170401S") | string)␊ - /**␊ - * Ssl cipher suites to be enabled in the specified order to application gateway.␊ - */␊ - cipherSuites?: (("TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384" | "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256" | "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA" | "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA" | "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384" | "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256" | "TLS_DHE_RSA_WITH_AES_256_CBC_SHA" | "TLS_DHE_RSA_WITH_AES_128_CBC_SHA" | "TLS_RSA_WITH_AES_256_GCM_SHA384" | "TLS_RSA_WITH_AES_128_GCM_SHA256" | "TLS_RSA_WITH_AES_256_CBC_SHA256" | "TLS_RSA_WITH_AES_128_CBC_SHA256" | "TLS_RSA_WITH_AES_256_CBC_SHA" | "TLS_RSA_WITH_AES_128_CBC_SHA" | "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384" | "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256" | "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384" | "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256" | "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA" | "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA" | "TLS_DHE_DSS_WITH_AES_256_CBC_SHA256" | "TLS_DHE_DSS_WITH_AES_128_CBC_SHA256" | "TLS_DHE_DSS_WITH_AES_256_CBC_SHA" | "TLS_DHE_DSS_WITH_AES_128_CBC_SHA" | "TLS_RSA_WITH_3DES_EDE_CBC_SHA" | "TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA" | "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256" | "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384")[] | string)␊ - /**␊ - * Minimum version of Ssl protocol to be supported on application gateway.␊ - */␊ - minProtocolVersion?: (("TLSv1_0" | "TLSv1_1" | "TLSv1_2") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed.␊ - */␊ - export interface ApplicationGatewayIPConfiguration23 {␊ - /**␊ - * Properties of the application gateway IP configuration.␊ - */␊ - properties?: (ApplicationGatewayIPConfigurationPropertiesFormat23 | string)␊ - /**␊ - * Name of the IP configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayIPConfigurationPropertiesFormat23 {␊ - /**␊ - * Reference to the subnet resource. A subnet from where application gateway gets its private address.␊ - */␊ - subnet?: (SubResource31 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Reference to another subresource.␊ - */␊ - export interface SubResource31 {␊ - /**␊ - * Resource ID.␊ - */␊ - id: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authentication certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewayAuthenticationCertificate20 {␊ - /**␊ - * Properties of the application gateway authentication certificate.␊ - */␊ - properties?: (ApplicationGatewayAuthenticationCertificatePropertiesFormat20 | string)␊ - /**␊ - * Name of the authentication certificate that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authentication certificates properties of an application gateway.␊ - */␊ - export interface ApplicationGatewayAuthenticationCertificatePropertiesFormat20 {␊ - /**␊ - * Certificate public data.␊ - */␊ - data?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trusted Root certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewayTrustedRootCertificate10 {␊ - /**␊ - * Properties of the application gateway trusted root certificate.␊ - */␊ - properties?: (ApplicationGatewayTrustedRootCertificatePropertiesFormat10 | string)␊ - /**␊ - * Name of the trusted root certificate that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trusted Root certificates properties of an application gateway.␊ - */␊ - export interface ApplicationGatewayTrustedRootCertificatePropertiesFormat10 {␊ - /**␊ - * Certificate public data.␊ - */␊ - data?: string␊ - /**␊ - * Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault.␊ - */␊ - keyVaultSecretId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSL certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewaySslCertificate23 {␊ - /**␊ - * Properties of the application gateway SSL certificate.␊ - */␊ - properties?: (ApplicationGatewaySslCertificatePropertiesFormat23 | string)␊ - /**␊ - * Name of the SSL certificate that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewaySslCertificatePropertiesFormat23 {␊ - /**␊ - * Base-64 encoded pfx certificate. Only applicable in PUT Request.␊ - */␊ - data?: string␊ - /**␊ - * Password for the pfx file specified in data. Only applicable in PUT request.␊ - */␊ - password?: string␊ - /**␊ - * Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault.␊ - */␊ - keyVaultSecretId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendIPConfiguration23 {␊ - /**␊ - * Properties of the application gateway frontend IP configuration.␊ - */␊ - properties?: (ApplicationGatewayFrontendIPConfigurationPropertiesFormat23 | string)␊ - /**␊ - * Name of the frontend IP configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendIPConfigurationPropertiesFormat23 {␊ - /**␊ - * PrivateIPAddress of the network interface IP Configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The private IP address allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Reference to the subnet resource.␊ - */␊ - subnet?: (SubResource31 | string)␊ - /**␊ - * Reference to the PublicIP resource.␊ - */␊ - publicIPAddress?: (SubResource31 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend port of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendPort23 {␊ - /**␊ - * Properties of the application gateway frontend port.␊ - */␊ - properties?: (ApplicationGatewayFrontendPortPropertiesFormat23 | string)␊ - /**␊ - * Name of the frontend port that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend port of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendPortPropertiesFormat23 {␊ - /**␊ - * Frontend port.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Probe of the application gateway.␊ - */␊ - export interface ApplicationGatewayProbe22 {␊ - /**␊ - * Properties of the application gateway probe.␊ - */␊ - properties?: (ApplicationGatewayProbePropertiesFormat22 | string)␊ - /**␊ - * Name of the probe that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of probe of an application gateway.␊ - */␊ - export interface ApplicationGatewayProbePropertiesFormat22 {␊ - /**␊ - * The protocol used for the probe.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Host name to send the probe to.␊ - */␊ - host?: string␊ - /**␊ - * Relative path of probe. Valid path starts from '/'. Probe is sent to ://:.␊ - */␊ - path?: string␊ - /**␊ - * The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - interval?: (number | string)␊ - /**␊ - * The probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - timeout?: (number | string)␊ - /**␊ - * The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20.␊ - */␊ - unhealthyThreshold?: (number | string)␊ - /**␊ - * Whether the host header should be picked from the backend http settings. Default value is false.␊ - */␊ - pickHostNameFromBackendHttpSettings?: (boolean | string)␊ - /**␊ - * Minimum number of servers that are always marked healthy. Default value is 0.␊ - */␊ - minServers?: (number | string)␊ - /**␊ - * Criterion for classifying a healthy probe response.␊ - */␊ - match?: (ApplicationGatewayProbeHealthResponseMatch20 | string)␊ - /**␊ - * Custom port which will be used for probing the backend servers. The valid value ranges from 1 to 65535. In case not set, port from http settings will be used. This property is valid for Standard_v2 and WAF_v2 only.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application gateway probe health response match.␊ - */␊ - export interface ApplicationGatewayProbeHealthResponseMatch20 {␊ - /**␊ - * Body that must be contained in the health response. Default value is empty.␊ - */␊ - body?: string␊ - /**␊ - * Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399.␊ - */␊ - statusCodes?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend Address Pool of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddressPool23 {␊ - /**␊ - * Properties of the application gateway backend address pool.␊ - */␊ - properties?: (ApplicationGatewayBackendAddressPoolPropertiesFormat23 | string)␊ - /**␊ - * Name of the backend address pool that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend Address Pool of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddressPoolPropertiesFormat23 {␊ - /**␊ - * Backend addresses.␊ - */␊ - backendAddresses?: (ApplicationGatewayBackendAddress23[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddress23 {␊ - /**␊ - * Fully qualified domain name (FQDN).␊ - */␊ - fqdn?: string␊ - /**␊ - * IP address.␊ - */␊ - ipAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address pool settings of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendHttpSettings23 {␊ - /**␊ - * Properties of the application gateway backend HTTP settings.␊ - */␊ - properties?: (ApplicationGatewayBackendHttpSettingsPropertiesFormat23 | string)␊ - /**␊ - * Name of the backend http settings that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend address pool settings of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendHttpSettingsPropertiesFormat23 {␊ - /**␊ - * The destination port on the backend.␊ - */␊ - port?: (number | string)␊ - /**␊ - * The protocol used to communicate with the backend.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Cookie based affinity.␊ - */␊ - cookieBasedAffinity?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Request timeout in seconds. Application Gateway will fail the request if response is not received within RequestTimeout. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - requestTimeout?: (number | string)␊ - /**␊ - * Probe resource of an application gateway.␊ - */␊ - probe?: (SubResource31 | string)␊ - /**␊ - * Array of references to application gateway authentication certificates.␊ - */␊ - authenticationCertificates?: (SubResource31[] | string)␊ - /**␊ - * Array of references to application gateway trusted root certificates.␊ - */␊ - trustedRootCertificates?: (SubResource31[] | string)␊ - /**␊ - * Connection draining of the backend http settings resource.␊ - */␊ - connectionDraining?: (ApplicationGatewayConnectionDraining20 | string)␊ - /**␊ - * Host header to be sent to the backend servers.␊ - */␊ - hostName?: string␊ - /**␊ - * Whether to pick host header should be picked from the host name of the backend server. Default value is false.␊ - */␊ - pickHostNameFromBackendAddress?: (boolean | string)␊ - /**␊ - * Cookie name to use for the affinity cookie.␊ - */␊ - affinityCookieName?: string␊ - /**␊ - * Whether the probe is enabled. Default value is false.␊ - */␊ - probeEnabled?: (boolean | string)␊ - /**␊ - * Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null.␊ - */␊ - path?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Connection draining allows open connections to a backend server to be active for a specified time after the backend server got removed from the configuration.␊ - */␊ - export interface ApplicationGatewayConnectionDraining20 {␊ - /**␊ - * Whether connection draining is enabled or not.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds.␊ - */␊ - drainTimeoutInSec: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http listener of an application gateway.␊ - */␊ - export interface ApplicationGatewayHttpListener23 {␊ - /**␊ - * Properties of the application gateway HTTP listener.␊ - */␊ - properties?: (ApplicationGatewayHttpListenerPropertiesFormat23 | string)␊ - /**␊ - * Name of the HTTP listener that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of HTTP listener of an application gateway.␊ - */␊ - export interface ApplicationGatewayHttpListenerPropertiesFormat23 {␊ - /**␊ - * Frontend IP configuration resource of an application gateway.␊ - */␊ - frontendIPConfiguration?: (SubResource31 | string)␊ - /**␊ - * Frontend port resource of an application gateway.␊ - */␊ - frontendPort?: (SubResource31 | string)␊ - /**␊ - * Protocol of the HTTP listener.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Host name of HTTP listener.␊ - */␊ - hostName?: string␊ - /**␊ - * SSL certificate resource of an application gateway.␊ - */␊ - sslCertificate?: (SubResource31 | string)␊ - /**␊ - * Applicable only if protocol is https. Enables SNI for multi-hosting.␊ - */␊ - requireServerNameIndication?: (boolean | string)␊ - /**␊ - * Custom error configurations of the HTTP listener.␊ - */␊ - customErrorConfigurations?: (ApplicationGatewayCustomError10[] | string)␊ - /**␊ - * Reference to the FirewallPolicy resource.␊ - */␊ - firewallPolicy?: (SubResource31 | string)␊ - /**␊ - * List of Host names for HTTP Listener that allows special wildcard characters as well.␊ - */␊ - hostnames?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Customer error of an application gateway.␊ - */␊ - export interface ApplicationGatewayCustomError10 {␊ - /**␊ - * Status code of the application gateway customer error.␊ - */␊ - statusCode?: (("HttpStatus403" | "HttpStatus502") | string)␊ - /**␊ - * Error page URL of the application gateway customer error.␊ - */␊ - customErrorPageUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * UrlPathMaps give a url path to the backend mapping information for PathBasedRouting.␊ - */␊ - export interface ApplicationGatewayUrlPathMap22 {␊ - /**␊ - * Properties of the application gateway URL path map.␊ - */␊ - properties?: (ApplicationGatewayUrlPathMapPropertiesFormat22 | string)␊ - /**␊ - * Name of the URL path map that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of UrlPathMap of the application gateway.␊ - */␊ - export interface ApplicationGatewayUrlPathMapPropertiesFormat22 {␊ - /**␊ - * Default backend address pool resource of URL path map.␊ - */␊ - defaultBackendAddressPool?: (SubResource31 | string)␊ - /**␊ - * Default backend http settings resource of URL path map.␊ - */␊ - defaultBackendHttpSettings?: (SubResource31 | string)␊ - /**␊ - * Default Rewrite rule set resource of URL path map.␊ - */␊ - defaultRewriteRuleSet?: (SubResource31 | string)␊ - /**␊ - * Default redirect configuration resource of URL path map.␊ - */␊ - defaultRedirectConfiguration?: (SubResource31 | string)␊ - /**␊ - * Path rule of URL path map resource.␊ - */␊ - pathRules?: (ApplicationGatewayPathRule22[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Path rule of URL path map of an application gateway.␊ - */␊ - export interface ApplicationGatewayPathRule22 {␊ - /**␊ - * Properties of the application gateway path rule.␊ - */␊ - properties?: (ApplicationGatewayPathRulePropertiesFormat22 | string)␊ - /**␊ - * Name of the path rule that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of path rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayPathRulePropertiesFormat22 {␊ - /**␊ - * Path rules of URL path map.␊ - */␊ - paths?: (string[] | string)␊ - /**␊ - * Backend address pool resource of URL path map path rule.␊ - */␊ - backendAddressPool?: (SubResource31 | string)␊ - /**␊ - * Backend http settings resource of URL path map path rule.␊ - */␊ - backendHttpSettings?: (SubResource31 | string)␊ - /**␊ - * Redirect configuration resource of URL path map path rule.␊ - */␊ - redirectConfiguration?: (SubResource31 | string)␊ - /**␊ - * Rewrite rule set resource of URL path map path rule.␊ - */␊ - rewriteRuleSet?: (SubResource31 | string)␊ - /**␊ - * Reference to the FirewallPolicy resource.␊ - */␊ - firewallPolicy?: (SubResource31 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Request routing rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayRequestRoutingRule23 {␊ - /**␊ - * Properties of the application gateway request routing rule.␊ - */␊ - properties?: (ApplicationGatewayRequestRoutingRulePropertiesFormat23 | string)␊ - /**␊ - * Name of the request routing rule that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of request routing rule of the application gateway.␊ - */␊ - export interface ApplicationGatewayRequestRoutingRulePropertiesFormat23 {␊ - /**␊ - * Rule type.␊ - */␊ - ruleType?: (("Basic" | "PathBasedRouting") | string)␊ - /**␊ - * Priority of the request routing rule.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * Backend address pool resource of the application gateway.␊ - */␊ - backendAddressPool?: (SubResource31 | string)␊ - /**␊ - * Backend http settings resource of the application gateway.␊ - */␊ - backendHttpSettings?: (SubResource31 | string)␊ - /**␊ - * Http listener resource of the application gateway.␊ - */␊ - httpListener?: (SubResource31 | string)␊ - /**␊ - * URL path map resource of the application gateway.␊ - */␊ - urlPathMap?: (SubResource31 | string)␊ - /**␊ - * Rewrite Rule Set resource in Basic rule of the application gateway.␊ - */␊ - rewriteRuleSet?: (SubResource31 | string)␊ - /**␊ - * Redirect configuration resource of the application gateway.␊ - */␊ - redirectConfiguration?: (SubResource31 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Rewrite rule set of an application gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRuleSet9 {␊ - /**␊ - * Properties of the application gateway rewrite rule set.␊ - */␊ - properties?: (ApplicationGatewayRewriteRuleSetPropertiesFormat9 | string)␊ - /**␊ - * Name of the rewrite rule set that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of rewrite rule set of the application gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRuleSetPropertiesFormat9 {␊ - /**␊ - * Rewrite rules in the rewrite rule set.␊ - */␊ - rewriteRules?: (ApplicationGatewayRewriteRule9[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Rewrite rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRule9 {␊ - /**␊ - * Name of the rewrite rule that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet.␊ - */␊ - ruleSequence?: (number | string)␊ - /**␊ - * Conditions based on which the action set execution will be evaluated.␊ - */␊ - conditions?: (ApplicationGatewayRewriteRuleCondition7[] | string)␊ - /**␊ - * Set of actions to be done as part of the rewrite Rule.␊ - */␊ - actionSet?: (ApplicationGatewayRewriteRuleActionSet9 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Set of conditions in the Rewrite Rule in Application Gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRuleCondition7 {␊ - /**␊ - * The condition parameter of the RewriteRuleCondition.␊ - */␊ - variable?: string␊ - /**␊ - * The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition.␊ - */␊ - pattern?: string␊ - /**␊ - * Setting this paramter to truth value with force the pattern to do a case in-sensitive comparison.␊ - */␊ - ignoreCase?: (boolean | string)␊ - /**␊ - * Setting this value as truth will force to check the negation of the condition given by the user.␊ - */␊ - negate?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Set of actions in the Rewrite Rule in Application Gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRuleActionSet9 {␊ - /**␊ - * Request Header Actions in the Action Set.␊ - */␊ - requestHeaderConfigurations?: (ApplicationGatewayHeaderConfiguration9[] | string)␊ - /**␊ - * Response Header Actions in the Action Set.␊ - */␊ - responseHeaderConfigurations?: (ApplicationGatewayHeaderConfiguration9[] | string)␊ - /**␊ - * Url Configuration Action in the Action Set.␊ - */␊ - urlConfiguration?: (ApplicationGatewayUrlConfiguration | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Header configuration of the Actions set in Application Gateway.␊ - */␊ - export interface ApplicationGatewayHeaderConfiguration9 {␊ - /**␊ - * Header name of the header configuration.␊ - */␊ - headerName?: string␊ - /**␊ - * Header value of the header configuration.␊ - */␊ - headerValue?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Url configuration of the Actions set in Application Gateway.␊ - */␊ - export interface ApplicationGatewayUrlConfiguration {␊ - /**␊ - * Url path which user has provided for url rewrite. Null means no path will be updated. Default value is null.␊ - */␊ - modifiedPath?: string␊ - /**␊ - * Query string which user has provided for url rewrite. Null means no query string will be updated. Default value is null.␊ - */␊ - modifiedQueryString?: string␊ - /**␊ - * If set as true, it will re-evaluate the url path map provided in path based request routing rules using modified path. Default value is false.␊ - */␊ - reroute?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Redirect configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayRedirectConfiguration20 {␊ - /**␊ - * Properties of the application gateway redirect configuration.␊ - */␊ - properties?: (ApplicationGatewayRedirectConfigurationPropertiesFormat20 | string)␊ - /**␊ - * Name of the redirect configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of redirect configuration of the application gateway.␊ - */␊ - export interface ApplicationGatewayRedirectConfigurationPropertiesFormat20 {␊ - /**␊ - * HTTP redirection type.␊ - */␊ - redirectType?: (("Permanent" | "Found" | "SeeOther" | "Temporary") | string)␊ - /**␊ - * Reference to a listener to redirect the request to.␊ - */␊ - targetListener?: (SubResource31 | string)␊ - /**␊ - * Url to redirect the request to.␊ - */␊ - targetUrl?: string␊ - /**␊ - * Include path in the redirected url.␊ - */␊ - includePath?: (boolean | string)␊ - /**␊ - * Include query string in the redirected url.␊ - */␊ - includeQueryString?: (boolean | string)␊ - /**␊ - * Request routing specifying redirect configuration.␊ - */␊ - requestRoutingRules?: (SubResource31[] | string)␊ - /**␊ - * Url path maps specifying default redirect configuration.␊ - */␊ - urlPathMaps?: (SubResource31[] | string)␊ - /**␊ - * Path rules specifying redirect configuration.␊ - */␊ - pathRules?: (SubResource31[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application gateway web application firewall configuration.␊ - */␊ - export interface ApplicationGatewayWebApplicationFirewallConfiguration20 {␊ - /**␊ - * Whether the web application firewall is enabled or not.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * Web application firewall mode.␊ - */␊ - firewallMode: (("Detection" | "Prevention") | string)␊ - /**␊ - * The type of the web application firewall rule set. Possible values are: 'OWASP'.␊ - */␊ - ruleSetType: string␊ - /**␊ - * The version of the rule set type.␊ - */␊ - ruleSetVersion: string␊ - /**␊ - * The disabled rule groups.␊ - */␊ - disabledRuleGroups?: (ApplicationGatewayFirewallDisabledRuleGroup20[] | string)␊ - /**␊ - * Whether allow WAF to check request Body.␊ - */␊ - requestBodyCheck?: (boolean | string)␊ - /**␊ - * Maximum request body size for WAF.␊ - */␊ - maxRequestBodySize?: (number | string)␊ - /**␊ - * Maximum request body size in Kb for WAF.␊ - */␊ - maxRequestBodySizeInKb?: (number | string)␊ - /**␊ - * Maximum file upload size in Mb for WAF.␊ - */␊ - fileUploadLimitInMb?: (number | string)␊ - /**␊ - * The exclusion list.␊ - */␊ - exclusions?: (ApplicationGatewayFirewallExclusion10[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allows to disable rules within a rule group or an entire rule group.␊ - */␊ - export interface ApplicationGatewayFirewallDisabledRuleGroup20 {␊ - /**␊ - * The name of the rule group that will be disabled.␊ - */␊ - ruleGroupName: string␊ - /**␊ - * The list of rules that will be disabled. If null, all rules of the rule group will be disabled.␊ - */␊ - rules?: (number[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allow to exclude some variable satisfy the condition for the WAF check.␊ - */␊ - export interface ApplicationGatewayFirewallExclusion10 {␊ - /**␊ - * The variable to be excluded.␊ - */␊ - matchVariable: string␊ - /**␊ - * When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to.␊ - */␊ - selectorMatchOperator: string␊ - /**␊ - * When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to.␊ - */␊ - selector: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application Gateway autoscale configuration.␊ - */␊ - export interface ApplicationGatewayAutoscaleConfiguration13 {␊ - /**␊ - * Lower bound on number of Application Gateway capacity.␊ - */␊ - minCapacity: (number | string)␊ - /**␊ - * Upper bound on number of Application Gateway capacity.␊ - */␊ - maxCapacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the resource.␊ - */␊ - export interface ManagedServiceIdentity9 {␊ - /**␊ - * The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.␊ - */␊ - type?: ("SystemAssigned" | "UserAssigned" | "SystemAssigned, UserAssigned" | "None")␊ - /**␊ - * The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.␊ - */␊ - userAssignedIdentities?: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies␊ - */␊ - export interface ApplicationGatewayWebApplicationFirewallPolicies7 {␊ - name: string␊ - type: "Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the web application firewall policy.␊ - */␊ - properties: (WebApplicationFirewallPolicyPropertiesFormat7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines web application firewall policy properties.␊ - */␊ - export interface WebApplicationFirewallPolicyPropertiesFormat7 {␊ - /**␊ - * The PolicySettings for policy.␊ - */␊ - policySettings?: (PolicySettings9 | string)␊ - /**␊ - * The custom rules inside the policy.␊ - */␊ - customRules?: (WebApplicationFirewallCustomRule7[] | string)␊ - /**␊ - * Describes the managedRules structure.␊ - */␊ - managedRules: (ManagedRulesDefinition2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines contents of a web application firewall global configuration.␊ - */␊ - export interface PolicySettings9 {␊ - /**␊ - * The state of the policy.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * The mode of the policy.␊ - */␊ - mode?: (("Prevention" | "Detection") | string)␊ - /**␊ - * Whether to allow WAF to check request Body.␊ - */␊ - requestBodyCheck?: (boolean | string)␊ - /**␊ - * Maximum request body size in Kb for WAF.␊ - */␊ - maxRequestBodySizeInKb?: (number | string)␊ - /**␊ - * Maximum file upload size in Mb for WAF.␊ - */␊ - fileUploadLimitInMb?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines contents of a web application rule.␊ - */␊ - export interface WebApplicationFirewallCustomRule7 {␊ - /**␊ - * The name of the resource that is unique within a policy. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * Priority of the rule. Rules with a lower value will be evaluated before rules with a higher value.␊ - */␊ - priority: (number | string)␊ - /**␊ - * The rule type.␊ - */␊ - ruleType: (("MatchRule" | "Invalid") | string)␊ - /**␊ - * List of match conditions.␊ - */␊ - matchConditions: (MatchCondition9[] | string)␊ - /**␊ - * Type of Actions.␊ - */␊ - action: (("Allow" | "Block" | "Log") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Define match conditions.␊ - */␊ - export interface MatchCondition9 {␊ - /**␊ - * List of match variables.␊ - */␊ - matchVariables: (MatchVariable7[] | string)␊ - /**␊ - * The operator to be matched.␊ - */␊ - operator: (("IPMatch" | "Equal" | "Contains" | "LessThan" | "GreaterThan" | "LessThanOrEqual" | "GreaterThanOrEqual" | "BeginsWith" | "EndsWith" | "Regex" | "GeoMatch") | string)␊ - /**␊ - * Whether this is negate condition or not.␊ - */␊ - negationConditon?: (boolean | string)␊ - /**␊ - * Match value.␊ - */␊ - matchValues: (string[] | string)␊ - /**␊ - * List of transforms.␊ - */␊ - transforms?: (("Lowercase" | "Trim" | "UrlDecode" | "UrlEncode" | "RemoveNulls" | "HtmlEntityDecode")[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Define match variables.␊ - */␊ - export interface MatchVariable7 {␊ - /**␊ - * Match Variable.␊ - */␊ - variableName: (("RemoteAddr" | "RequestMethod" | "QueryString" | "PostArgs" | "RequestUri" | "RequestHeaders" | "RequestBody" | "RequestCookies") | string)␊ - /**␊ - * The selector of match variable.␊ - */␊ - selector?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allow to exclude some variable satisfy the condition for the WAF check.␊ - */␊ - export interface ManagedRulesDefinition2 {␊ - /**␊ - * The Exclusions that are applied on the policy.␊ - */␊ - exclusions?: (OwaspCrsExclusionEntry2[] | string)␊ - /**␊ - * The managed rule sets that are associated with the policy.␊ - */␊ - managedRuleSets: (ManagedRuleSet4[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allow to exclude some variable satisfy the condition for the WAF check.␊ - */␊ - export interface OwaspCrsExclusionEntry2 {␊ - /**␊ - * The variable to be excluded.␊ - */␊ - matchVariable: (("RequestHeaderNames" | "RequestCookieNames" | "RequestArgNames") | string)␊ - /**␊ - * When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to.␊ - */␊ - selectorMatchOperator: (("Equals" | "Contains" | "StartsWith" | "EndsWith" | "EqualsAny") | string)␊ - /**␊ - * When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to.␊ - */␊ - selector: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines a managed rule set.␊ - */␊ - export interface ManagedRuleSet4 {␊ - /**␊ - * Defines the rule set type to use.␊ - */␊ - ruleSetType: string␊ - /**␊ - * Defines the version of the rule set to use.␊ - */␊ - ruleSetVersion: string␊ - /**␊ - * Defines the rule group overrides to apply to the rule set.␊ - */␊ - ruleGroupOverrides?: (ManagedRuleGroupOverride4[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines a managed rule group override setting.␊ - */␊ - export interface ManagedRuleGroupOverride4 {␊ - /**␊ - * The managed rule group to override.␊ - */␊ - ruleGroupName: string␊ - /**␊ - * List of rules that will be disabled. If none specified, all rules in the group will be disabled.␊ - */␊ - rules?: (ManagedRuleOverride4[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines a managed rule group override setting.␊ - */␊ - export interface ManagedRuleOverride4 {␊ - /**␊ - * Identifier for the managed rule.␊ - */␊ - ruleId: string␊ - /**␊ - * The state of the managed rule. Defaults to Disabled if not specified.␊ - */␊ - state?: ("Disabled" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/applicationSecurityGroups␊ - */␊ - export interface ApplicationSecurityGroups18 {␊ - name: string␊ - type: "Microsoft.Network/applicationSecurityGroups"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the application security group.␊ - */␊ - properties: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/azureFirewalls␊ - */␊ - export interface AzureFirewalls8 {␊ - name: string␊ - type: "Microsoft.Network/azureFirewalls"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the azure firewall.␊ - */␊ - properties: (AzureFirewallPropertiesFormat8 | string)␊ - /**␊ - * A list of availability zones denoting where the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Azure Firewall.␊ - */␊ - export interface AzureFirewallPropertiesFormat8 {␊ - /**␊ - * Collection of application rule collections used by Azure Firewall.␊ - */␊ - applicationRuleCollections?: (AzureFirewallApplicationRuleCollection8[] | string)␊ - /**␊ - * Collection of NAT rule collections used by Azure Firewall.␊ - */␊ - natRuleCollections?: (AzureFirewallNatRuleCollection5[] | string)␊ - /**␊ - * Collection of network rule collections used by Azure Firewall.␊ - */␊ - networkRuleCollections?: (AzureFirewallNetworkRuleCollection8[] | string)␊ - /**␊ - * IP configuration of the Azure Firewall resource.␊ - */␊ - ipConfigurations?: (AzureFirewallIPConfiguration8[] | string)␊ - /**␊ - * IP configuration of the Azure Firewall used for management traffic.␊ - */␊ - managementIpConfiguration?: (AzureFirewallIPConfiguration8 | string)␊ - /**␊ - * The operation mode for Threat Intelligence.␊ - */␊ - threatIntelMode?: (("Alert" | "Deny" | "Off") | string)␊ - /**␊ - * The virtualHub to which the firewall belongs.␊ - */␊ - virtualHub?: (SubResource31 | string)␊ - /**␊ - * The firewallPolicy associated with this azure firewall.␊ - */␊ - firewallPolicy?: (SubResource31 | string)␊ - /**␊ - * The Azure Firewall Resource SKU.␊ - */␊ - sku?: (AzureFirewallSku2 | string)␊ - /**␊ - * The additional properties used to further config this azure firewall.␊ - */␊ - additionalProperties?: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application rule collection resource.␊ - */␊ - export interface AzureFirewallApplicationRuleCollection8 {␊ - /**␊ - * Properties of the azure firewall application rule collection.␊ - */␊ - properties?: (AzureFirewallApplicationRuleCollectionPropertiesFormat8 | string)␊ - /**␊ - * The name of the resource that is unique within the Azure firewall. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application rule collection.␊ - */␊ - export interface AzureFirewallApplicationRuleCollectionPropertiesFormat8 {␊ - /**␊ - * Priority of the application rule collection resource.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * The action type of a rule collection.␊ - */␊ - action?: (AzureFirewallRCAction8 | string)␊ - /**␊ - * Collection of rules used by a application rule collection.␊ - */␊ - rules?: (AzureFirewallApplicationRule8[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the AzureFirewallRCAction.␊ - */␊ - export interface AzureFirewallRCAction8 {␊ - /**␊ - * The type of action.␊ - */␊ - type?: ("Allow" | "Deny")␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of an application rule.␊ - */␊ - export interface AzureFirewallApplicationRule8 {␊ - /**␊ - * Name of the application rule.␊ - */␊ - name?: string␊ - /**␊ - * Description of the rule.␊ - */␊ - description?: string␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * Array of ApplicationRuleProtocols.␊ - */␊ - protocols?: (AzureFirewallApplicationRuleProtocol8[] | string)␊ - /**␊ - * List of FQDNs for this rule.␊ - */␊ - targetFqdns?: (string[] | string)␊ - /**␊ - * List of FQDN Tags for this rule.␊ - */␊ - fqdnTags?: (string[] | string)␊ - /**␊ - * List of source IpGroups for this rule.␊ - */␊ - sourceIpGroups?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application rule protocol.␊ - */␊ - export interface AzureFirewallApplicationRuleProtocol8 {␊ - /**␊ - * Protocol type.␊ - */␊ - protocolType?: (("Http" | "Https" | "Mssql") | string)␊ - /**␊ - * Port number for the protocol, cannot be greater than 64000. This field is optional.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NAT rule collection resource.␊ - */␊ - export interface AzureFirewallNatRuleCollection5 {␊ - /**␊ - * Properties of the azure firewall NAT rule collection.␊ - */␊ - properties?: (AzureFirewallNatRuleCollectionProperties5 | string)␊ - /**␊ - * The name of the resource that is unique within the Azure firewall. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the NAT rule collection.␊ - */␊ - export interface AzureFirewallNatRuleCollectionProperties5 {␊ - /**␊ - * Priority of the NAT rule collection resource.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * The action type of a NAT rule collection.␊ - */␊ - action?: (AzureFirewallNatRCAction5 | string)␊ - /**␊ - * Collection of rules used by a NAT rule collection.␊ - */␊ - rules?: (AzureFirewallNatRule5[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AzureFirewall NAT Rule Collection Action.␊ - */␊ - export interface AzureFirewallNatRCAction5 {␊ - /**␊ - * The type of action.␊ - */␊ - type?: ("Snat" | "Dnat")␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a NAT rule.␊ - */␊ - export interface AzureFirewallNatRule5 {␊ - /**␊ - * Name of the NAT rule.␊ - */␊ - name?: string␊ - /**␊ - * Description of the rule.␊ - */␊ - description?: string␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags.␊ - */␊ - destinationAddresses?: (string[] | string)␊ - /**␊ - * List of destination ports.␊ - */␊ - destinationPorts?: (string[] | string)␊ - /**␊ - * Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule.␊ - */␊ - protocols?: (("TCP" | "UDP" | "Any" | "ICMP")[] | string)␊ - /**␊ - * The translated address for this NAT rule.␊ - */␊ - translatedAddress?: string␊ - /**␊ - * The translated port for this NAT rule.␊ - */␊ - translatedPort?: string␊ - /**␊ - * The translated FQDN for this NAT rule.␊ - */␊ - translatedFqdn?: string␊ - /**␊ - * List of source IpGroups for this rule.␊ - */␊ - sourceIpGroups?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network rule collection resource.␊ - */␊ - export interface AzureFirewallNetworkRuleCollection8 {␊ - /**␊ - * Properties of the azure firewall network rule collection.␊ - */␊ - properties?: (AzureFirewallNetworkRuleCollectionPropertiesFormat8 | string)␊ - /**␊ - * The name of the resource that is unique within the Azure firewall. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the network rule collection.␊ - */␊ - export interface AzureFirewallNetworkRuleCollectionPropertiesFormat8 {␊ - /**␊ - * Priority of the network rule collection resource.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * The action type of a rule collection.␊ - */␊ - action?: (AzureFirewallRCAction8 | string)␊ - /**␊ - * Collection of rules used by a network rule collection.␊ - */␊ - rules?: (AzureFirewallNetworkRule8[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the network rule.␊ - */␊ - export interface AzureFirewallNetworkRule8 {␊ - /**␊ - * Name of the network rule.␊ - */␊ - name?: string␊ - /**␊ - * Description of the rule.␊ - */␊ - description?: string␊ - /**␊ - * Array of AzureFirewallNetworkRuleProtocols.␊ - */␊ - protocols?: (("TCP" | "UDP" | "Any" | "ICMP")[] | string)␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * List of destination IP addresses.␊ - */␊ - destinationAddresses?: (string[] | string)␊ - /**␊ - * List of destination ports.␊ - */␊ - destinationPorts?: (string[] | string)␊ - /**␊ - * List of destination FQDNs.␊ - */␊ - destinationFqdns?: (string[] | string)␊ - /**␊ - * List of source IpGroups for this rule.␊ - */␊ - sourceIpGroups?: (string[] | string)␊ - /**␊ - * List of destination IpGroups for this rule.␊ - */␊ - destinationIpGroups?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration of an Azure Firewall.␊ - */␊ - export interface AzureFirewallIPConfiguration8 {␊ - /**␊ - * Properties of the azure firewall IP configuration.␊ - */␊ - properties?: (AzureFirewallIPConfigurationPropertiesFormat8 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration of an Azure Firewall.␊ - */␊ - export interface AzureFirewallIPConfigurationPropertiesFormat8 {␊ - /**␊ - * Reference to the subnet resource. This resource must be named 'AzureFirewallSubnet' or 'AzureFirewallManagementSubnet'.␊ - */␊ - subnet?: (SubResource31 | string)␊ - /**␊ - * Reference to the PublicIP resource. This field is a mandatory input if subnet is not null.␊ - */␊ - publicIPAddress?: (SubResource31 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of an Azure Firewall.␊ - */␊ - export interface AzureFirewallSku2 {␊ - /**␊ - * Name of an Azure Firewall SKU.␊ - */␊ - name?: (("AZFW_VNet" | "AZFW_Hub") | string)␊ - /**␊ - * Tier of an Azure Firewall.␊ - */␊ - tier?: ("Standard" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/bastionHosts␊ - */␊ - export interface BastionHosts5 {␊ - name: string␊ - type: "Microsoft.Network/bastionHosts"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Represents the bastion host resource.␊ - */␊ - properties: (BastionHostPropertiesFormat5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Bastion Host.␊ - */␊ - export interface BastionHostPropertiesFormat5 {␊ - /**␊ - * IP configuration of the Bastion Host resource.␊ - */␊ - ipConfigurations?: (BastionHostIPConfiguration5[] | string)␊ - /**␊ - * FQDN for the endpoint on which bastion host is accessible.␊ - */␊ - dnsName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration of an Bastion Host.␊ - */␊ - export interface BastionHostIPConfiguration5 {␊ - /**␊ - * Represents the ip configuration associated with the resource.␊ - */␊ - properties?: (BastionHostIPConfigurationPropertiesFormat5 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration of an Bastion Host.␊ - */␊ - export interface BastionHostIPConfigurationPropertiesFormat5 {␊ - /**␊ - * Reference to the subnet resource.␊ - */␊ - subnet: (SubResource31 | string)␊ - /**␊ - * Reference to the PublicIP resource.␊ - */␊ - publicIPAddress: (SubResource31 | string)␊ - /**␊ - * Private IP allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/connections␊ - */␊ - export interface Connections23 {␊ - name: string␊ - type: "Microsoft.Network/connections"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway connection.␊ - */␊ - properties: (VirtualNetworkGatewayConnectionPropertiesFormat23 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewayConnection properties.␊ - */␊ - export interface VirtualNetworkGatewayConnectionPropertiesFormat23 {␊ - /**␊ - * The authorizationKey.␊ - */␊ - authorizationKey?: string␊ - /**␊ - * The reference to virtual network gateway resource.␊ - */␊ - virtualNetworkGateway1: (SubResource31 | string)␊ - /**␊ - * The reference to virtual network gateway resource.␊ - */␊ - virtualNetworkGateway2?: (SubResource31 | string)␊ - /**␊ - * The reference to local network gateway resource.␊ - */␊ - localNetworkGateway2?: (SubResource31 | string)␊ - /**␊ - * Gateway connection type.␊ - */␊ - connectionType: (("IPsec" | "Vnet2Vnet" | "ExpressRoute" | "VPNClient") | string)␊ - /**␊ - * Connection protocol used for this connection.␊ - */␊ - connectionProtocol?: (("IKEv2" | "IKEv1") | string)␊ - /**␊ - * The routing weight.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * The IPSec shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The reference to peerings resource.␊ - */␊ - peer?: (SubResource31 | string)␊ - /**␊ - * EnableBgp flag.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * Enable policy-based traffic selectors.␊ - */␊ - usePolicyBasedTrafficSelectors?: (boolean | string)␊ - /**␊ - * The IPSec Policies to be considered by this connection.␊ - */␊ - ipsecPolicies?: (IpsecPolicy20[] | string)␊ - /**␊ - * The Traffic Selector Policies to be considered by this connection.␊ - */␊ - trafficSelectorPolicies?: (TrafficSelectorPolicy3[] | string)␊ - /**␊ - * Bypass ExpressRoute Gateway for data forwarding.␊ - */␊ - expressRouteGatewayBypass?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An IPSec Policy configuration for a virtual network gateway connection.␊ - */␊ - export interface IpsecPolicy20 {␊ - /**␊ - * The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.␊ - */␊ - saLifeTimeSeconds: (number | string)␊ - /**␊ - * The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.␊ - */␊ - saDataSizeKilobytes: (number | string)␊ - /**␊ - * The IPSec encryption algorithm (IKE phase 1).␊ - */␊ - ipsecEncryption: (("None" | "DES" | "DES3" | "AES128" | "AES192" | "AES256" | "GCMAES128" | "GCMAES192" | "GCMAES256") | string)␊ - /**␊ - * The IPSec integrity algorithm (IKE phase 1).␊ - */␊ - ipsecIntegrity: (("MD5" | "SHA1" | "SHA256" | "GCMAES128" | "GCMAES192" | "GCMAES256") | string)␊ - /**␊ - * The IKE encryption algorithm (IKE phase 2).␊ - */␊ - ikeEncryption: (("DES" | "DES3" | "AES128" | "AES192" | "AES256" | "GCMAES256" | "GCMAES128") | string)␊ - /**␊ - * The IKE integrity algorithm (IKE phase 2).␊ - */␊ - ikeIntegrity: (("MD5" | "SHA1" | "SHA256" | "SHA384" | "GCMAES256" | "GCMAES128") | string)␊ - /**␊ - * The DH Group used in IKE Phase 1 for initial SA.␊ - */␊ - dhGroup: (("None" | "DHGroup1" | "DHGroup2" | "DHGroup14" | "DHGroup2048" | "ECP256" | "ECP384" | "DHGroup24") | string)␊ - /**␊ - * The Pfs Group used in IKE Phase 2 for new child SA.␊ - */␊ - pfsGroup: (("None" | "PFS1" | "PFS2" | "PFS2048" | "ECP256" | "ECP384" | "PFS24" | "PFS14" | "PFSMM") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An traffic selector policy for a virtual network gateway connection.␊ - */␊ - export interface TrafficSelectorPolicy3 {␊ - /**␊ - * A collection of local address spaces in CIDR format.␊ - */␊ - localAddressRanges: (string[] | string)␊ - /**␊ - * A collection of remote address spaces in CIDR format.␊ - */␊ - remoteAddressRanges: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ddosCustomPolicies␊ - */␊ - export interface DdosCustomPolicies5 {␊ - name: string␊ - type: "Microsoft.Network/ddosCustomPolicies"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the DDoS custom policy.␊ - */␊ - properties: (DdosCustomPolicyPropertiesFormat5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DDoS custom policy properties.␊ - */␊ - export interface DdosCustomPolicyPropertiesFormat5 {␊ - /**␊ - * The protocol-specific DDoS policy customization parameters.␊ - */␊ - protocolCustomSettings?: (ProtocolCustomSettingsFormat5[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DDoS custom policy properties.␊ - */␊ - export interface ProtocolCustomSettingsFormat5 {␊ - /**␊ - * The protocol for which the DDoS protection policy is being customized.␊ - */␊ - protocol?: (("Tcp" | "Udp" | "Syn") | string)␊ - /**␊ - * The customized DDoS protection trigger rate.␊ - */␊ - triggerRateOverride?: string␊ - /**␊ - * The customized DDoS protection source rate.␊ - */␊ - sourceRateOverride?: string␊ - /**␊ - * The customized DDoS protection trigger rate sensitivity degrees. High: Trigger rate set with most sensitivity w.r.t. normal traffic. Default: Trigger rate set with moderate sensitivity w.r.t. normal traffic. Low: Trigger rate set with less sensitivity w.r.t. normal traffic. Relaxed: Trigger rate set with least sensitivity w.r.t. normal traffic.␊ - */␊ - triggerSensitivityOverride?: (("Relaxed" | "Low" | "Default" | "High") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ddosProtectionPlans␊ - */␊ - export interface DdosProtectionPlans14 {␊ - name: string␊ - type: "Microsoft.Network/ddosProtectionPlans"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the DDoS protection plan.␊ - */␊ - properties: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits␊ - */␊ - export interface ExpressRouteCircuits16 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The SKU.␊ - */␊ - sku?: (ExpressRouteCircuitSku16 | string)␊ - /**␊ - * Properties of the express route circuit.␊ - */␊ - properties: (ExpressRouteCircuitPropertiesFormat16 | string)␊ - resources?: (ExpressRouteCircuitsPeeringsChildResource16 | ExpressRouteCircuitsAuthorizationsChildResource16)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains SKU in an ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitSku16 {␊ - /**␊ - * The name of the SKU.␊ - */␊ - name?: string␊ - /**␊ - * The tier of the SKU.␊ - */␊ - tier?: (("Standard" | "Premium" | "Basic" | "Local") | string)␊ - /**␊ - * The family of the SKU.␊ - */␊ - family?: (("UnlimitedData" | "MeteredData") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitPropertiesFormat16 {␊ - /**␊ - * Allow classic operations.␊ - */␊ - allowClassicOperations?: (boolean | string)␊ - /**␊ - * The list of authorizations.␊ - */␊ - authorizations?: (ExpressRouteCircuitAuthorization16[] | string)␊ - /**␊ - * The list of peerings.␊ - */␊ - peerings?: (ExpressRouteCircuitPeering16[] | string)␊ - /**␊ - * The ServiceProviderNotes.␊ - */␊ - serviceProviderNotes?: string␊ - /**␊ - * The ServiceProviderProperties.␊ - */␊ - serviceProviderProperties?: (ExpressRouteCircuitServiceProviderProperties16 | string)␊ - /**␊ - * The reference to the ExpressRoutePort resource when the circuit is provisioned on an ExpressRoutePort resource.␊ - */␊ - expressRoutePort?: (SubResource31 | string)␊ - /**␊ - * The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource.␊ - */␊ - bandwidthInGbps?: (number | string)␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authorization in an ExpressRouteCircuit resource.␊ - */␊ - export interface ExpressRouteCircuitAuthorization16 {␊ - /**␊ - * Properties of the express route circuit authorization.␊ - */␊ - properties?: ({␊ - [k: string]: unknown␊ - } | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peering in an ExpressRouteCircuit resource.␊ - */␊ - export interface ExpressRouteCircuitPeering16 {␊ - /**␊ - * Properties of the express route circuit peering.␊ - */␊ - properties?: (ExpressRouteCircuitPeeringPropertiesFormat17 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the express route circuit peering.␊ - */␊ - export interface ExpressRouteCircuitPeeringPropertiesFormat17 {␊ - /**␊ - * The peering type.␊ - */␊ - peeringType?: (("AzurePublicPeering" | "AzurePrivatePeering" | "MicrosoftPeering") | string)␊ - /**␊ - * The peering state.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * The peer ASN.␊ - */␊ - peerASN?: (number | string)␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The VLAN ID.␊ - */␊ - vlanId?: (number | string)␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig17 | string)␊ - /**␊ - * The peering stats of express route circuit.␊ - */␊ - stats?: (ExpressRouteCircuitStats17 | string)␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - /**␊ - * The reference to the RouteFilter resource.␊ - */␊ - routeFilter?: (SubResource31 | string)␊ - /**␊ - * The IPv6 peering configuration.␊ - */␊ - ipv6PeeringConfig?: (Ipv6ExpressRouteCircuitPeeringConfig14 | string)␊ - /**␊ - * The ExpressRoute connection.␊ - */␊ - expressRouteConnection?: (SubResource31 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the peering configuration.␊ - */␊ - export interface ExpressRouteCircuitPeeringConfig17 {␊ - /**␊ - * The reference to AdvertisedPublicPrefixes.␊ - */␊ - advertisedPublicPrefixes?: (string[] | string)␊ - /**␊ - * The communities of bgp peering. Specified for microsoft peering.␊ - */␊ - advertisedCommunities?: (string[] | string)␊ - /**␊ - * The legacy mode of the peering.␊ - */␊ - legacyMode?: (number | string)␊ - /**␊ - * The CustomerASN of the peering.␊ - */␊ - customerASN?: (number | string)␊ - /**␊ - * The RoutingRegistryName of the configuration.␊ - */␊ - routingRegistryName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains stats associated with the peering.␊ - */␊ - export interface ExpressRouteCircuitStats17 {␊ - /**␊ - * The Primary BytesIn of the peering.␊ - */␊ - primarybytesIn?: (number | string)␊ - /**␊ - * The primary BytesOut of the peering.␊ - */␊ - primarybytesOut?: (number | string)␊ - /**␊ - * The secondary BytesIn of the peering.␊ - */␊ - secondarybytesIn?: (number | string)␊ - /**␊ - * The secondary BytesOut of the peering.␊ - */␊ - secondarybytesOut?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains IPv6 peering config.␊ - */␊ - export interface Ipv6ExpressRouteCircuitPeeringConfig14 {␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig17 | string)␊ - /**␊ - * The reference to the RouteFilter resource.␊ - */␊ - routeFilter?: (SubResource31 | string)␊ - /**␊ - * The state of peering.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains ServiceProviderProperties in an ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitServiceProviderProperties16 {␊ - /**␊ - * The serviceProviderName.␊ - */␊ - serviceProviderName?: string␊ - /**␊ - * The peering location.␊ - */␊ - peeringLocation?: string␊ - /**␊ - * The BandwidthInMbps.␊ - */␊ - bandwidthInMbps?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings␊ - */␊ - export interface ExpressRouteCircuitsPeeringsChildResource16 {␊ - name: string␊ - type: "peerings"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Properties of the express route circuit peering.␊ - */␊ - properties: (ExpressRouteCircuitPeeringPropertiesFormat17 | string)␊ - resources?: ExpressRouteCircuitsPeeringsConnectionsChildResource14[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings/connections␊ - */␊ - export interface ExpressRouteCircuitsPeeringsConnectionsChildResource14 {␊ - name: string␊ - type: "connections"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Properties of the express route circuit connection.␊ - */␊ - properties: (ExpressRouteCircuitConnectionPropertiesFormat14 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the express route circuit connection.␊ - */␊ - export interface ExpressRouteCircuitConnectionPropertiesFormat14 {␊ - /**␊ - * Reference to Express Route Circuit Private Peering Resource of the circuit initiating connection.␊ - */␊ - expressRouteCircuitPeering?: (SubResource31 | string)␊ - /**␊ - * Reference to Express Route Circuit Private Peering Resource of the peered circuit.␊ - */␊ - peerExpressRouteCircuitPeering?: (SubResource31 | string)␊ - /**␊ - * /29 IP address space to carve out Customer addresses for tunnels.␊ - */␊ - addressPrefix?: string␊ - /**␊ - * The authorization key.␊ - */␊ - authorizationKey?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/authorizations␊ - */␊ - export interface ExpressRouteCircuitsAuthorizationsChildResource16 {␊ - name: string␊ - type: "authorizations"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Properties of the express route circuit authorization.␊ - */␊ - properties: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/authorizations␊ - */␊ - export interface ExpressRouteCircuitsAuthorizations17 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/authorizations"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Properties of the express route circuit authorization.␊ - */␊ - properties: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings␊ - */␊ - export interface ExpressRouteCircuitsPeerings17 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/peerings"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Properties of the express route circuit peering.␊ - */␊ - properties: (ExpressRouteCircuitPeeringPropertiesFormat17 | string)␊ - resources?: ExpressRouteCircuitsPeeringsConnectionsChildResource14[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings/connections␊ - */␊ - export interface ExpressRouteCircuitsPeeringsConnections14 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/peerings/connections"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Properties of the express route circuit connection.␊ - */␊ - properties: (ExpressRouteCircuitConnectionPropertiesFormat14 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections␊ - */␊ - export interface ExpressRouteCrossConnections14 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCrossConnections"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the express route cross connection.␊ - */␊ - properties: (ExpressRouteCrossConnectionProperties14 | string)␊ - resources?: ExpressRouteCrossConnectionsPeeringsChildResource14[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ExpressRouteCrossConnection.␊ - */␊ - export interface ExpressRouteCrossConnectionProperties14 {␊ - /**␊ - * The peering location of the ExpressRoute circuit.␊ - */␊ - peeringLocation?: string␊ - /**␊ - * The circuit bandwidth In Mbps.␊ - */␊ - bandwidthInMbps?: (number | string)␊ - /**␊ - * The ExpressRouteCircuit.␊ - */␊ - expressRouteCircuit?: (SubResource31 | string)␊ - /**␊ - * The provisioning state of the circuit in the connectivity provider system.␊ - */␊ - serviceProviderProvisioningState?: (("NotProvisioned" | "Provisioning" | "Provisioned" | "Deprovisioning") | string)␊ - /**␊ - * Additional read only notes set by the connectivity provider.␊ - */␊ - serviceProviderNotes?: string␊ - /**␊ - * The list of peerings.␊ - */␊ - peerings?: (ExpressRouteCrossConnectionPeering14[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peering in an ExpressRoute Cross Connection resource.␊ - */␊ - export interface ExpressRouteCrossConnectionPeering14 {␊ - /**␊ - * Properties of the express route cross connection peering.␊ - */␊ - properties?: (ExpressRouteCrossConnectionPeeringProperties14 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of express route cross connection peering.␊ - */␊ - export interface ExpressRouteCrossConnectionPeeringProperties14 {␊ - /**␊ - * The peering type.␊ - */␊ - peeringType?: (("AzurePublicPeering" | "AzurePrivatePeering" | "MicrosoftPeering") | string)␊ - /**␊ - * The peering state.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * The peer ASN.␊ - */␊ - peerASN?: (number | string)␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The VLAN ID.␊ - */␊ - vlanId?: (number | string)␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig17 | string)␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - /**␊ - * The IPv6 peering configuration.␊ - */␊ - ipv6PeeringConfig?: (Ipv6ExpressRouteCircuitPeeringConfig14 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections/peerings␊ - */␊ - export interface ExpressRouteCrossConnectionsPeeringsChildResource14 {␊ - name: string␊ - type: "peerings"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Properties of the express route cross connection peering.␊ - */␊ - properties: (ExpressRouteCrossConnectionPeeringProperties14 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections/peerings␊ - */␊ - export interface ExpressRouteCrossConnectionsPeerings14 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCrossConnections/peerings"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Properties of the express route cross connection peering.␊ - */␊ - properties: (ExpressRouteCrossConnectionPeeringProperties14 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteGateways␊ - */␊ - export interface ExpressRouteGateways5 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteGateways"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the express route gateway.␊ - */␊ - properties: (ExpressRouteGatewayProperties5 | string)␊ - resources?: ExpressRouteGatewaysExpressRouteConnectionsChildResource5[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ExpressRoute gateway resource properties.␊ - */␊ - export interface ExpressRouteGatewayProperties5 {␊ - /**␊ - * Configuration for auto scaling.␊ - */␊ - autoScaleConfiguration?: (ExpressRouteGatewayPropertiesAutoScaleConfiguration5 | string)␊ - /**␊ - * The Virtual Hub where the ExpressRoute gateway is or will be deployed.␊ - */␊ - virtualHub: (SubResource31 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Configuration for auto scaling.␊ - */␊ - export interface ExpressRouteGatewayPropertiesAutoScaleConfiguration5 {␊ - /**␊ - * Minimum and maximum number of scale units to deploy.␊ - */␊ - bounds?: (ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Minimum and maximum number of scale units to deploy.␊ - */␊ - export interface ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds5 {␊ - /**␊ - * Minimum number of scale units deployed for ExpressRoute gateway.␊ - */␊ - min?: (number | string)␊ - /**␊ - * Maximum number of scale units deployed for ExpressRoute gateway.␊ - */␊ - max?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteGateways/expressRouteConnections␊ - */␊ - export interface ExpressRouteGatewaysExpressRouteConnectionsChildResource5 {␊ - name: string␊ - type: "expressRouteConnections"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Properties of the express route connection.␊ - */␊ - properties: (ExpressRouteConnectionProperties5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the ExpressRouteConnection subresource.␊ - */␊ - export interface ExpressRouteConnectionProperties5 {␊ - /**␊ - * The ExpressRoute circuit peering.␊ - */␊ - expressRouteCircuitPeering: (SubResource31 | string)␊ - /**␊ - * Authorization key to establish the connection.␊ - */␊ - authorizationKey?: string␊ - /**␊ - * The routing weight associated to the connection.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * Enable internet security.␊ - */␊ - enableInternetSecurity?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteGateways/expressRouteConnections␊ - */␊ - export interface ExpressRouteGatewaysExpressRouteConnections5 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteGateways/expressRouteConnections"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Properties of the express route connection.␊ - */␊ - properties: (ExpressRouteConnectionProperties5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ExpressRoutePorts␊ - */␊ - export interface ExpressRoutePorts10 {␊ - name: string␊ - type: "Microsoft.Network/ExpressRoutePorts"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * ExpressRoutePort properties.␊ - */␊ - properties: (ExpressRoutePortPropertiesFormat10 | string)␊ - /**␊ - * The identity of ExpressRoutePort, if configured.␊ - */␊ - identity?: (ManagedServiceIdentity9 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to ExpressRoutePort resources.␊ - */␊ - export interface ExpressRoutePortPropertiesFormat10 {␊ - /**␊ - * The name of the peering location that the ExpressRoutePort is mapped to physically.␊ - */␊ - peeringLocation?: string␊ - /**␊ - * Bandwidth of procured ports in Gbps.␊ - */␊ - bandwidthInGbps?: (number | string)␊ - /**␊ - * Encapsulation method on physical ports.␊ - */␊ - encapsulation?: (("Dot1Q" | "QinQ") | string)␊ - /**␊ - * The set of physical links of the ExpressRoutePort resource.␊ - */␊ - links?: (ExpressRouteLink10[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ExpressRouteLink child resource definition.␊ - */␊ - export interface ExpressRouteLink10 {␊ - /**␊ - * ExpressRouteLink properties.␊ - */␊ - properties?: (ExpressRouteLinkPropertiesFormat10 | string)␊ - /**␊ - * Name of child port resource that is unique among child port resources of the parent.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to ExpressRouteLink resources.␊ - */␊ - export interface ExpressRouteLinkPropertiesFormat10 {␊ - /**␊ - * Administrative state of the physical port.␊ - */␊ - adminState?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * MacSec configuration.␊ - */␊ - macSecConfig?: (ExpressRouteLinkMacSecConfig3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ExpressRouteLink Mac Security Configuration.␊ - */␊ - export interface ExpressRouteLinkMacSecConfig3 {␊ - /**␊ - * Keyvault Secret Identifier URL containing Mac security CKN key.␊ - */␊ - cknSecretIdentifier?: string␊ - /**␊ - * Keyvault Secret Identifier URL containing Mac security CAK key.␊ - */␊ - cakSecretIdentifier?: string␊ - /**␊ - * Mac security cipher.␊ - */␊ - cipher?: (("gcm-aes-128" | "gcm-aes-256") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/firewallPolicies␊ - */␊ - export interface FirewallPolicies4 {␊ - name: string␊ - type: "Microsoft.Network/firewallPolicies"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the firewall policy.␊ - */␊ - properties: (FirewallPolicyPropertiesFormat4 | string)␊ - resources?: FirewallPoliciesRuleGroupsChildResource4[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Firewall Policy definition.␊ - */␊ - export interface FirewallPolicyPropertiesFormat4 {␊ - /**␊ - * The parent firewall policy from which rules are inherited.␊ - */␊ - basePolicy?: (SubResource31 | string)␊ - /**␊ - * The operation mode for Threat Intelligence.␊ - */␊ - threatIntelMode?: (("Alert" | "Deny" | "Off") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/firewallPolicies/ruleGroups␊ - */␊ - export interface FirewallPoliciesRuleGroupsChildResource4 {␊ - name: string␊ - type: "ruleGroups"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * The properties of the firewall policy rule group.␊ - */␊ - properties: (FirewallPolicyRuleGroupProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the rule group.␊ - */␊ - export interface FirewallPolicyRuleGroupProperties4 {␊ - /**␊ - * Priority of the Firewall Policy Rule Group resource.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * Group of Firewall Policy rules.␊ - */␊ - rules?: (FirewallPolicyRule4[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the FirewallPolicyNatRuleAction.␊ - */␊ - export interface FirewallPolicyNatRuleAction4 {␊ - /**␊ - * The type of action.␊ - */␊ - type?: "DNAT"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application rule protocol.␊ - */␊ - export interface FirewallPolicyRuleConditionApplicationProtocol4 {␊ - /**␊ - * Protocol type.␊ - */␊ - protocolType?: (("Http" | "Https") | string)␊ - /**␊ - * Port number for the protocol, cannot be greater than 64000.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the FirewallPolicyFilterRuleAction.␊ - */␊ - export interface FirewallPolicyFilterRuleAction4 {␊ - /**␊ - * The type of action.␊ - */␊ - type?: ("Allow" | "Deny")␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/firewallPolicies/ruleGroups␊ - */␊ - export interface FirewallPoliciesRuleGroups4 {␊ - name: string␊ - type: "Microsoft.Network/firewallPolicies/ruleGroups"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * The properties of the firewall policy rule group.␊ - */␊ - properties: (FirewallPolicyRuleGroupProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ipGroups␊ - */␊ - export interface IpGroups1 {␊ - name: string␊ - type: "Microsoft.Network/ipGroups"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the IpGroups.␊ - */␊ - properties: (IpGroupPropertiesFormat1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The IpGroups property information.␊ - */␊ - export interface IpGroupPropertiesFormat1 {␊ - /**␊ - * IpAddresses/IpAddressPrefixes in the IpGroups resource.␊ - */␊ - ipAddresses?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers␊ - */␊ - export interface LoadBalancers31 {␊ - name: string␊ - type: "Microsoft.Network/loadBalancers"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The load balancer SKU.␊ - */␊ - sku?: (LoadBalancerSku19 | string)␊ - /**␊ - * Properties of load balancer.␊ - */␊ - properties: (LoadBalancerPropertiesFormat23 | string)␊ - resources?: LoadBalancersInboundNatRulesChildResource19[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a load balancer.␊ - */␊ - export interface LoadBalancerSku19 {␊ - /**␊ - * Name of a load balancer SKU.␊ - */␊ - name?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer.␊ - */␊ - export interface LoadBalancerPropertiesFormat23 {␊ - /**␊ - * Object representing the frontend IPs to be used for the load balancer.␊ - */␊ - frontendIPConfigurations?: (FrontendIPConfiguration22[] | string)␊ - /**␊ - * Collection of backend address pools used by a load balancer.␊ - */␊ - backendAddressPools?: (BackendAddressPool23[] | string)␊ - /**␊ - * Object collection representing the load balancing rules Gets the provisioning.␊ - */␊ - loadBalancingRules?: (LoadBalancingRule23[] | string)␊ - /**␊ - * Collection of probe objects used in the load balancer.␊ - */␊ - probes?: (Probe23[] | string)␊ - /**␊ - * Collection of inbound NAT Rules used by a load balancer. Defining inbound NAT rules on your load balancer is mutually exclusive with defining an inbound NAT pool. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an Inbound NAT pool. They have to reference individual inbound NAT rules.␊ - */␊ - inboundNatRules?: (InboundNatRule24[] | string)␊ - /**␊ - * Defines an external port range for inbound NAT to a single backend port on NICs associated with a load balancer. Inbound NAT rules are created automatically for each NIC associated with the Load Balancer using an external port from this range. Defining an Inbound NAT pool on your Load Balancer is mutually exclusive with defining inbound Nat rules. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an inbound NAT pool. They have to reference individual inbound NAT rules.␊ - */␊ - inboundNatPools?: (InboundNatPool24[] | string)␊ - /**␊ - * The outbound rules.␊ - */␊ - outboundRules?: (OutboundRule11[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP address of the load balancer.␊ - */␊ - export interface FrontendIPConfiguration22 {␊ - /**␊ - * Properties of the load balancer probe.␊ - */␊ - properties?: (FrontendIPConfigurationPropertiesFormat22 | string)␊ - /**␊ - * The name of the resource that is unique within the set of frontend IP configurations used by the load balancer. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP Configuration of the load balancer.␊ - */␊ - export interface FrontendIPConfigurationPropertiesFormat22 {␊ - /**␊ - * The private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The Private IP allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4.␊ - */␊ - privateIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The reference to the subnet resource.␊ - */␊ - subnet?: (SubResource31 | string)␊ - /**␊ - * The reference to the Public IP resource.␊ - */␊ - publicIPAddress?: (SubResource31 | string)␊ - /**␊ - * The reference to the Public IP Prefix resource.␊ - */␊ - publicIPPrefix?: (SubResource31 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Pool of backend IP addresses.␊ - */␊ - export interface BackendAddressPool23 {␊ - /**␊ - * Properties of load balancer backend address pool.␊ - */␊ - properties?: ({␊ - [k: string]: unknown␊ - } | string)␊ - /**␊ - * The name of the resource that is unique within the set of backend address pools used by the load balancer. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A load balancing rule for a load balancer.␊ - */␊ - export interface LoadBalancingRule23 {␊ - /**␊ - * Properties of load balancer load balancing rule.␊ - */␊ - properties?: (LoadBalancingRulePropertiesFormat23 | string)␊ - /**␊ - * The name of the resource that is unique within the set of load balancing rules used by the load balancer. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer.␊ - */␊ - export interface LoadBalancingRulePropertiesFormat23 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource31 | string)␊ - /**␊ - * A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs.␊ - */␊ - backendAddressPool?: (SubResource31 | string)␊ - /**␊ - * The reference to the load balancer probe used by the load balancing rule.␊ - */␊ - probe?: (SubResource31 | string)␊ - /**␊ - * The reference to the transport protocol used by the load balancing rule.␊ - */␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The load distribution policy for this rule.␊ - */␊ - loadDistribution?: (("Default" | "SourceIP" | "SourceIPProtocol") | string)␊ - /**␊ - * The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 0 and 65534. Note that value 0 enables "Any Port".␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port".␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - /**␊ - * Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule.␊ - */␊ - disableOutboundSnat?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A load balancer probe.␊ - */␊ - export interface Probe23 {␊ - /**␊ - * Properties of load balancer probe.␊ - */␊ - properties?: (ProbePropertiesFormat23 | string)␊ - /**␊ - * The name of the resource that is unique within the set of probes used by the load balancer. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Load balancer probe resource.␊ - */␊ - export interface ProbePropertiesFormat23 {␊ - /**␊ - * The protocol of the end point. If 'Tcp' is specified, a received ACK is required for the probe to be successful. If 'Http' or 'Https' is specified, a 200 OK response from the specifies URI is required for the probe to be successful.␊ - */␊ - protocol: (("Http" | "Tcp" | "Https") | string)␊ - /**␊ - * The port for communicating the probe. Possible values range from 1 to 65535, inclusive.␊ - */␊ - port: (number | string)␊ - /**␊ - * The interval, in seconds, for how frequently to probe the endpoint for health status. Typically, the interval is slightly less than half the allocated timeout period (in seconds) which allows two full probes before taking the instance out of rotation. The default value is 15, the minimum value is 5.␊ - */␊ - intervalInSeconds?: (number | string)␊ - /**␊ - * The number of probes where if no response, will result in stopping further traffic from being delivered to the endpoint. This values allows endpoints to be taken out of rotation faster or slower than the typical times used in Azure.␊ - */␊ - numberOfProbes: (number | string)␊ - /**␊ - * The URI used for requesting health status from the VM. Path is required if a protocol is set to http. Otherwise, it is not allowed. There is no default value.␊ - */␊ - requestPath?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT rule of the load balancer.␊ - */␊ - export interface InboundNatRule24 {␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties?: (InboundNatRulePropertiesFormat23 | string)␊ - /**␊ - * The name of the resource that is unique within the set of inbound NAT rules used by the load balancer. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the inbound NAT rule.␊ - */␊ - export interface InboundNatRulePropertiesFormat23 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource31 | string)␊ - /**␊ - * The reference to the transport protocol used by the load balancing rule.␊ - */␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values range from 1 to 65534.␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * The port used for the internal endpoint. Acceptable values range from 1 to 65535.␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT pool of the load balancer.␊ - */␊ - export interface InboundNatPool24 {␊ - /**␊ - * Properties of load balancer inbound nat pool.␊ - */␊ - properties?: (InboundNatPoolPropertiesFormat23 | string)␊ - /**␊ - * The name of the resource that is unique within the set of inbound NAT pools used by the load balancer. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Inbound NAT pool.␊ - */␊ - export interface InboundNatPoolPropertiesFormat23 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource31 | string)␊ - /**␊ - * The reference to the transport protocol used by the inbound NAT pool.␊ - */␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65534.␊ - */␊ - frontendPortRangeStart: (number | string)␊ - /**␊ - * The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65535.␊ - */␊ - frontendPortRangeEnd: (number | string)␊ - /**␊ - * The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound rule of the load balancer.␊ - */␊ - export interface OutboundRule11 {␊ - /**␊ - * Properties of load balancer outbound rule.␊ - */␊ - properties?: (OutboundRulePropertiesFormat11 | string)␊ - /**␊ - * The name of the resource that is unique within the set of outbound rules used by the load balancer. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound rule of the load balancer.␊ - */␊ - export interface OutboundRulePropertiesFormat11 {␊ - /**␊ - * The number of outbound ports to be used for NAT.␊ - */␊ - allocatedOutboundPorts?: (number | string)␊ - /**␊ - * The Frontend IP addresses of the load balancer.␊ - */␊ - frontendIPConfigurations: (SubResource31[] | string)␊ - /**␊ - * A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs.␊ - */␊ - backendAddressPool: (SubResource31 | string)␊ - /**␊ - * The protocol for the outbound rule in load balancer.␊ - */␊ - protocol: (("Tcp" | "Udp" | "All") | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - /**␊ - * The timeout for the TCP idle connection.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers/inboundNatRules␊ - */␊ - export interface LoadBalancersInboundNatRulesChildResource19 {␊ - name: string␊ - type: "inboundNatRules"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties: (InboundNatRulePropertiesFormat23 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers/inboundNatRules␊ - */␊ - export interface LoadBalancersInboundNatRules19 {␊ - name: string␊ - type: "Microsoft.Network/loadBalancers/inboundNatRules"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties: (InboundNatRulePropertiesFormat23 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/localNetworkGateways␊ - */␊ - export interface LocalNetworkGateways23 {␊ - name: string␊ - type: "Microsoft.Network/localNetworkGateways"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the local network gateway.␊ - */␊ - properties: (LocalNetworkGatewayPropertiesFormat23 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * LocalNetworkGateway properties.␊ - */␊ - export interface LocalNetworkGatewayPropertiesFormat23 {␊ - /**␊ - * Local network site address space.␊ - */␊ - localNetworkAddressSpace?: (AddressSpace31 | string)␊ - /**␊ - * IP address of local network gateway.␊ - */␊ - gatewayIpAddress?: string␊ - /**␊ - * Local network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings22 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.␊ - */␊ - export interface AddressSpace31 {␊ - /**␊ - * A list of address blocks reserved for this virtual network in CIDR notation.␊ - */␊ - addressPrefixes: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * BGP settings details.␊ - */␊ - export interface BgpSettings22 {␊ - /**␊ - * The BGP speaker's ASN.␊ - */␊ - asn?: (number | string)␊ - /**␊ - * The BGP peering address and BGP identifier of this BGP speaker.␊ - */␊ - bgpPeeringAddress?: string␊ - /**␊ - * The weight added to routes learned from this BGP speaker.␊ - */␊ - peerWeight?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/natGateways␊ - */␊ - export interface NatGateways6 {␊ - name: string␊ - type: "Microsoft.Network/natGateways"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The nat gateway SKU.␊ - */␊ - sku?: (NatGatewaySku6 | string)␊ - /**␊ - * Nat Gateway properties.␊ - */␊ - properties: (NatGatewayPropertiesFormat6 | string)␊ - /**␊ - * A list of availability zones denoting the zone in which Nat Gateway should be deployed.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of nat gateway.␊ - */␊ - export interface NatGatewaySku6 {␊ - /**␊ - * Name of Nat Gateway SKU.␊ - */␊ - name?: ("Standard" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Nat Gateway properties.␊ - */␊ - export interface NatGatewayPropertiesFormat6 {␊ - /**␊ - * The idle timeout of the nat gateway.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * An array of public ip addresses associated with the nat gateway resource.␊ - */␊ - publicIpAddresses?: (SubResource31[] | string)␊ - /**␊ - * An array of public ip prefixes associated with the nat gateway resource.␊ - */␊ - publicIpPrefixes?: (SubResource31[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces␊ - */␊ - export interface NetworkInterfaces32 {␊ - name: string␊ - type: "Microsoft.Network/networkInterfaces"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network interface.␊ - */␊ - properties: (NetworkInterfacePropertiesFormat23 | string)␊ - resources?: NetworkInterfacesTapConfigurationsChildResource10[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NetworkInterface properties.␊ - */␊ - export interface NetworkInterfacePropertiesFormat23 {␊ - /**␊ - * The reference to the NetworkSecurityGroup resource.␊ - */␊ - networkSecurityGroup?: (SubResource31 | string)␊ - /**␊ - * A list of IPConfigurations of the network interface.␊ - */␊ - ipConfigurations: (NetworkInterfaceIPConfiguration22[] | string)␊ - /**␊ - * The DNS settings in network interface.␊ - */␊ - dnsSettings?: (NetworkInterfaceDnsSettings31 | string)␊ - /**␊ - * If the network interface is accelerated networking enabled.␊ - */␊ - enableAcceleratedNetworking?: (boolean | string)␊ - /**␊ - * Indicates whether IP forwarding is enabled on this network interface.␊ - */␊ - enableIPForwarding?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IPConfiguration in a network interface.␊ - */␊ - export interface NetworkInterfaceIPConfiguration22 {␊ - /**␊ - * Network interface IP configuration properties.␊ - */␊ - properties?: (NetworkInterfaceIPConfigurationPropertiesFormat22 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration.␊ - */␊ - export interface NetworkInterfaceIPConfigurationPropertiesFormat22 {␊ - /**␊ - * The reference to Virtual Network Taps.␊ - */␊ - virtualNetworkTaps?: (SubResource31[] | string)␊ - /**␊ - * The reference to ApplicationGatewayBackendAddressPool resource.␊ - */␊ - applicationGatewayBackendAddressPools?: (SubResource31[] | string)␊ - /**␊ - * The reference to LoadBalancerBackendAddressPool resource.␊ - */␊ - loadBalancerBackendAddressPools?: (SubResource31[] | string)␊ - /**␊ - * A list of references of LoadBalancerInboundNatRules.␊ - */␊ - loadBalancerInboundNatRules?: (SubResource31[] | string)␊ - /**␊ - * Private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The private IP address allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4.␊ - */␊ - privateIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * Subnet bound to the IP configuration.␊ - */␊ - subnet?: (SubResource31 | string)␊ - /**␊ - * Whether this is a primary customer address on the network interface.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * Public IP address bound to the IP configuration.␊ - */␊ - publicIPAddress?: (SubResource31 | string)␊ - /**␊ - * Application security groups in which the IP configuration is included.␊ - */␊ - applicationSecurityGroups?: (SubResource31[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DNS settings of a network interface.␊ - */␊ - export interface NetworkInterfaceDnsSettings31 {␊ - /**␊ - * List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only value in dnsServers collection.␊ - */␊ - dnsServers?: (string[] | string)␊ - /**␊ - * Relative DNS name for this NIC used for internal communications between VMs in the same virtual network.␊ - */␊ - internalDnsNameLabel?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces/tapConfigurations␊ - */␊ - export interface NetworkInterfacesTapConfigurationsChildResource10 {␊ - name: string␊ - type: "tapConfigurations"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Properties of the Virtual Network Tap configuration.␊ - */␊ - properties: (NetworkInterfaceTapConfigurationPropertiesFormat10 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Virtual Network Tap configuration.␊ - */␊ - export interface NetworkInterfaceTapConfigurationPropertiesFormat10 {␊ - /**␊ - * The reference to the Virtual Network Tap resource.␊ - */␊ - virtualNetworkTap?: (SubResource31 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces/tapConfigurations␊ - */␊ - export interface NetworkInterfacesTapConfigurations10 {␊ - name: string␊ - type: "Microsoft.Network/networkInterfaces/tapConfigurations"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Properties of the Virtual Network Tap configuration.␊ - */␊ - properties: (NetworkInterfaceTapConfigurationPropertiesFormat10 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkProfiles␊ - */␊ - export interface NetworkProfiles5 {␊ - name: string␊ - type: "Microsoft.Network/networkProfiles"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Network profile properties.␊ - */␊ - properties: (NetworkProfilePropertiesFormat5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network profile properties.␊ - */␊ - export interface NetworkProfilePropertiesFormat5 {␊ - /**␊ - * List of chid container network interface configurations.␊ - */␊ - containerNetworkInterfaceConfigurations?: (ContainerNetworkInterfaceConfiguration5[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Container network interface configuration child resource.␊ - */␊ - export interface ContainerNetworkInterfaceConfiguration5 {␊ - /**␊ - * Container network interface configuration properties.␊ - */␊ - properties?: (ContainerNetworkInterfaceConfigurationPropertiesFormat5 | string)␊ - /**␊ - * The name of the resource. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Container network interface configuration properties.␊ - */␊ - export interface ContainerNetworkInterfaceConfigurationPropertiesFormat5 {␊ - /**␊ - * A list of ip configurations of the container network interface configuration.␊ - */␊ - ipConfigurations?: (IPConfigurationProfile5[] | string)␊ - /**␊ - * A list of container network interfaces created from this container network interface configuration.␊ - */␊ - containerNetworkInterfaces?: (SubResource31[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration profile child resource.␊ - */␊ - export interface IPConfigurationProfile5 {␊ - /**␊ - * Properties of the IP configuration profile.␊ - */␊ - properties?: (IPConfigurationProfilePropertiesFormat5 | string)␊ - /**␊ - * The name of the resource. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration profile properties.␊ - */␊ - export interface IPConfigurationProfilePropertiesFormat5 {␊ - /**␊ - * The reference to the subnet resource to create a container network interface ip configuration.␊ - */␊ - subnet?: (SubResource31 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups␊ - */␊ - export interface NetworkSecurityGroups31 {␊ - name: string␊ - type: "Microsoft.Network/networkSecurityGroups"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network security group.␊ - */␊ - properties: (NetworkSecurityGroupPropertiesFormat23 | string)␊ - resources?: NetworkSecurityGroupsSecurityRulesChildResource23[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network Security Group resource.␊ - */␊ - export interface NetworkSecurityGroupPropertiesFormat23 {␊ - /**␊ - * A collection of security rules of the network security group.␊ - */␊ - securityRules?: (SecurityRule23[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network security rule.␊ - */␊ - export interface SecurityRule23 {␊ - /**␊ - * Properties of the security rule.␊ - */␊ - properties?: (SecurityRulePropertiesFormat23 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Security rule resource.␊ - */␊ - export interface SecurityRulePropertiesFormat23 {␊ - /**␊ - * A description for this rule. Restricted to 140 chars.␊ - */␊ - description?: string␊ - /**␊ - * Network protocol this rule applies to.␊ - */␊ - protocol: (("Tcp" | "Udp" | "Icmp" | "Esp" | "*" | "Ah") | string)␊ - /**␊ - * The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.␊ - */␊ - sourcePortRange?: string␊ - /**␊ - * The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.␊ - */␊ - destinationPortRange?: string␊ - /**␊ - * The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from.␊ - */␊ - sourceAddressPrefix?: string␊ - /**␊ - * The CIDR or source IP ranges.␊ - */␊ - sourceAddressPrefixes?: (string[] | string)␊ - /**␊ - * The application security group specified as source.␊ - */␊ - sourceApplicationSecurityGroups?: (SubResource31[] | string)␊ - /**␊ - * The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used.␊ - */␊ - destinationAddressPrefix?: string␊ - /**␊ - * The destination address prefixes. CIDR or destination IP ranges.␊ - */␊ - destinationAddressPrefixes?: (string[] | string)␊ - /**␊ - * The application security group specified as destination.␊ - */␊ - destinationApplicationSecurityGroups?: (SubResource31[] | string)␊ - /**␊ - * The source port ranges.␊ - */␊ - sourcePortRanges?: (string[] | string)␊ - /**␊ - * The destination port ranges.␊ - */␊ - destinationPortRanges?: (string[] | string)␊ - /**␊ - * The network traffic is allowed or denied.␊ - */␊ - access: (("Allow" | "Deny") | string)␊ - /**␊ - * The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.␊ - */␊ - priority: (number | string)␊ - /**␊ - * The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic.␊ - */␊ - direction: (("Inbound" | "Outbound") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRulesChildResource23 {␊ - name: string␊ - type: "securityRules"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Properties of the security rule.␊ - */␊ - properties: (SecurityRulePropertiesFormat23 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRules23 {␊ - name: string␊ - type: "Microsoft.Network/networkSecurityGroups/securityRules"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Properties of the security rule.␊ - */␊ - properties: (SecurityRulePropertiesFormat23 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers␊ - */␊ - export interface NetworkWatchers8 {␊ - name: string␊ - type: "Microsoft.Network/networkWatchers"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network watcher.␊ - */␊ - properties: ({␊ - [k: string]: unknown␊ - } | string)␊ - resources?: (NetworkWatchersFlowLogsChildResource | NetworkWatchersConnectionMonitorsChildResource5 | NetworkWatchersPacketCapturesChildResource8)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/flowLogs␊ - */␊ - export interface NetworkWatchersFlowLogsChildResource {␊ - name: string␊ - type: "flowLogs"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the flow log.␊ - */␊ - properties: (FlowLogPropertiesFormat | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters that define the configuration of flow log.␊ - */␊ - export interface FlowLogPropertiesFormat {␊ - /**␊ - * ID of network security group to which flow log will be applied.␊ - */␊ - targetResourceId: string␊ - /**␊ - * ID of the storage account which is used to store the flow log.␊ - */␊ - storageId: string␊ - /**␊ - * Flag to enable/disable flow logging.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Parameters that define the retention policy for flow log.␊ - */␊ - retentionPolicy?: (RetentionPolicyParameters | string)␊ - /**␊ - * Parameters that define the flow log format.␊ - */␊ - format?: (FlowLogFormatParameters | string)␊ - /**␊ - * Parameters that define the configuration of traffic analytics.␊ - */␊ - flowAnalyticsConfiguration?: (TrafficAnalyticsProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters that define the retention policy for flow log.␊ - */␊ - export interface RetentionPolicyParameters {␊ - /**␊ - * Number of days to retain flow log records.␊ - */␊ - days?: ((number & string) | string)␊ - /**␊ - * Flag to enable/disable retention.␊ - */␊ - enabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters that define the flow log format.␊ - */␊ - export interface FlowLogFormatParameters {␊ - /**␊ - * The file type of flow log.␊ - */␊ - type?: "JSON"␊ - /**␊ - * The version (revision) of the flow log.␊ - */␊ - version?: ((number & string) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters that define the configuration of traffic analytics.␊ - */␊ - export interface TrafficAnalyticsProperties {␊ - /**␊ - * Parameters that define the configuration of traffic analytics.␊ - */␊ - networkWatcherFlowAnalyticsConfiguration?: (TrafficAnalyticsConfigurationProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters that define the configuration of traffic analytics.␊ - */␊ - export interface TrafficAnalyticsConfigurationProperties {␊ - /**␊ - * Flag to enable/disable traffic analytics.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * The resource guid of the attached workspace.␊ - */␊ - workspaceId?: string␊ - /**␊ - * The location of the attached workspace.␊ - */␊ - workspaceRegion?: string␊ - /**␊ - * Resource Id of the attached workspace.␊ - */␊ - workspaceResourceId?: string␊ - /**␊ - * The interval in minutes which would decide how frequently TA service should do flow analytics.␊ - */␊ - trafficAnalyticsInterval?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/connectionMonitors␊ - */␊ - export interface NetworkWatchersConnectionMonitorsChildResource5 {␊ - name: string␊ - type: "connectionMonitors"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Connection monitor location.␊ - */␊ - location?: string␊ - /**␊ - * Connection monitor tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the connection monitor.␊ - */␊ - properties: (ConnectionMonitorParameters5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters that define the operation to create a connection monitor.␊ - */␊ - export interface ConnectionMonitorParameters5 {␊ - /**␊ - * Describes the source of connection monitor.␊ - */␊ - source?: (ConnectionMonitorSource5 | string)␊ - /**␊ - * Describes the destination of connection monitor.␊ - */␊ - destination?: (ConnectionMonitorDestination5 | string)␊ - /**␊ - * Determines if the connection monitor will start automatically once created.␊ - */␊ - autoStart?: (boolean | string)␊ - /**␊ - * Monitoring interval in seconds.␊ - */␊ - monitoringIntervalInSeconds?: ((number & string) | string)␊ - /**␊ - * List of connection monitor endpoints.␊ - */␊ - endpoints?: (ConnectionMonitorEndpoint[] | string)␊ - /**␊ - * List of connection monitor test configurations.␊ - */␊ - testConfigurations?: (ConnectionMonitorTestConfiguration[] | string)␊ - /**␊ - * List of connection monitor test groups.␊ - */␊ - testGroups?: (ConnectionMonitorTestGroup[] | string)␊ - /**␊ - * List of connection monitor outputs.␊ - */␊ - outputs?: (ConnectionMonitorOutput[] | string)␊ - /**␊ - * Optional notes to be associated with the connection monitor.␊ - */␊ - notes?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the source of connection monitor.␊ - */␊ - export interface ConnectionMonitorSource5 {␊ - /**␊ - * The ID of the resource used as the source by connection monitor.␊ - */␊ - resourceId: string␊ - /**␊ - * The source port used by connection monitor.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the destination of connection monitor.␊ - */␊ - export interface ConnectionMonitorDestination5 {␊ - /**␊ - * The ID of the resource used as the destination by connection monitor.␊ - */␊ - resourceId?: string␊ - /**␊ - * Address of the connection monitor destination (IP or domain name).␊ - */␊ - address?: string␊ - /**␊ - * The destination port used by connection monitor.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the connection monitor endpoint.␊ - */␊ - export interface ConnectionMonitorEndpoint {␊ - /**␊ - * The name of the connection monitor endpoint.␊ - */␊ - name: string␊ - /**␊ - * Resource ID of the connection monitor endpoint.␊ - */␊ - resourceId?: string␊ - /**␊ - * Address of the connection monitor endpoint (IP or domain name).␊ - */␊ - address?: string␊ - /**␊ - * Filter for sub-items within the endpoint.␊ - */␊ - filter?: (ConnectionMonitorEndpointFilter | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the connection monitor endpoint filter.␊ - */␊ - export interface ConnectionMonitorEndpointFilter {␊ - /**␊ - * The behavior of the endpoint filter. Currently only 'Include' is supported.␊ - */␊ - type?: "Include"␊ - /**␊ - * List of items in the filter.␊ - */␊ - items?: (ConnectionMonitorEndpointFilterItem[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the connection monitor endpoint filter item.␊ - */␊ - export interface ConnectionMonitorEndpointFilterItem {␊ - /**␊ - * The type of item included in the filter. Currently only 'AgentAddress' is supported.␊ - */␊ - type?: "AgentAddress"␊ - /**␊ - * The address of the filter item.␊ - */␊ - address?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a connection monitor test configuration.␊ - */␊ - export interface ConnectionMonitorTestConfiguration {␊ - /**␊ - * The name of the connection monitor test configuration.␊ - */␊ - name: string␊ - /**␊ - * The frequency of test evaluation, in seconds.␊ - */␊ - testFrequencySec?: (number | string)␊ - /**␊ - * The protocol to use in test evaluation.␊ - */␊ - protocol: (("Tcp" | "Http" | "Icmp") | string)␊ - /**␊ - * The preferred IP version to use in test evaluation. The connection monitor may choose to use a different version depending on other parameters.␊ - */␊ - preferredIPVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The parameters used to perform test evaluation over HTTP.␊ - */␊ - httpConfiguration?: (ConnectionMonitorHttpConfiguration | string)␊ - /**␊ - * The parameters used to perform test evaluation over TCP.␊ - */␊ - tcpConfiguration?: (ConnectionMonitorTcpConfiguration | string)␊ - /**␊ - * The parameters used to perform test evaluation over ICMP.␊ - */␊ - icmpConfiguration?: (ConnectionMonitorIcmpConfiguration | string)␊ - /**␊ - * The threshold for declaring a test successful.␊ - */␊ - successThreshold?: (ConnectionMonitorSuccessThreshold | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the HTTP configuration.␊ - */␊ - export interface ConnectionMonitorHttpConfiguration {␊ - /**␊ - * The port to connect to.␊ - */␊ - port?: (number | string)␊ - /**␊ - * The HTTP method to use.␊ - */␊ - method?: (("Get" | "Post") | string)␊ - /**␊ - * The path component of the URI. For instance, "/dir1/dir2".␊ - */␊ - path?: string␊ - /**␊ - * The HTTP headers to transmit with the request.␊ - */␊ - requestHeaders?: (HTTPHeader[] | string)␊ - /**␊ - * HTTP status codes to consider successful. For instance, "2xx,301-304,418".␊ - */␊ - validStatusCodeRanges?: (string[] | string)␊ - /**␊ - * Value indicating whether HTTPS is preferred over HTTP in cases where the choice is not explicit.␊ - */␊ - preferHTTPS?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The HTTP header.␊ - */␊ - export interface HTTPHeader {␊ - /**␊ - * The name in HTTP header.␊ - */␊ - name?: string␊ - /**␊ - * The value in HTTP header.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the TCP configuration.␊ - */␊ - export interface ConnectionMonitorTcpConfiguration {␊ - /**␊ - * The port to connect to.␊ - */␊ - port?: (number | string)␊ - /**␊ - * Value indicating whether path evaluation with trace route should be disabled.␊ - */␊ - disableTraceRoute?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the ICMP configuration.␊ - */␊ - export interface ConnectionMonitorIcmpConfiguration {␊ - /**␊ - * Value indicating whether path evaluation with trace route should be disabled.␊ - */␊ - disableTraceRoute?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the threshold for declaring a test successful.␊ - */␊ - export interface ConnectionMonitorSuccessThreshold {␊ - /**␊ - * The maximum percentage of failed checks permitted for a test to evaluate as successful.␊ - */␊ - checksFailedPercent?: (number | string)␊ - /**␊ - * The maximum round-trip time in milliseconds permitted for a test to evaluate as successful.␊ - */␊ - roundTripTimeMs?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the connection monitor test group.␊ - */␊ - export interface ConnectionMonitorTestGroup {␊ - /**␊ - * The name of the connection monitor test group.␊ - */␊ - name: string␊ - /**␊ - * Value indicating whether test group is disabled.␊ - */␊ - disable?: (boolean | string)␊ - /**␊ - * List of test configuration names.␊ - */␊ - testConfigurations: (string[] | string)␊ - /**␊ - * List of source endpoint names.␊ - */␊ - sources: (string[] | string)␊ - /**␊ - * List of destination endpoint names.␊ - */␊ - destinations: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a connection monitor output destination.␊ - */␊ - export interface ConnectionMonitorOutput {␊ - /**␊ - * Connection monitor output destination type. Currently, only "Workspace" is supported.␊ - */␊ - type?: "Workspace"␊ - /**␊ - * Describes the settings for producing output into a log analytics workspace.␊ - */␊ - workspaceSettings?: (ConnectionMonitorWorkspaceSettings | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the settings for producing output into a log analytics workspace.␊ - */␊ - export interface ConnectionMonitorWorkspaceSettings {␊ - /**␊ - * Log analytics workspace resource ID.␊ - */␊ - workspaceResourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/packetCaptures␊ - */␊ - export interface NetworkWatchersPacketCapturesChildResource8 {␊ - name: string␊ - type: "packetCaptures"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Properties of the packet capture.␊ - */␊ - properties: (PacketCaptureParameters8 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters that define the create packet capture operation.␊ - */␊ - export interface PacketCaptureParameters8 {␊ - /**␊ - * The ID of the targeted resource, only VM is currently supported.␊ - */␊ - target: string␊ - /**␊ - * Number of bytes captured per packet, the remaining bytes are truncated.␊ - */␊ - bytesToCapturePerPacket?: ((number & string) | string)␊ - /**␊ - * Maximum size of the capture output.␊ - */␊ - totalBytesPerSession?: ((number & string) | string)␊ - /**␊ - * Maximum duration of the capture session in seconds.␊ - */␊ - timeLimitInSeconds?: ((number & string) | string)␊ - /**␊ - * The storage location for a packet capture session.␊ - */␊ - storageLocation: (PacketCaptureStorageLocation8 | string)␊ - /**␊ - * A list of packet capture filters.␊ - */␊ - filters?: (PacketCaptureFilter8[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The storage location for a packet capture session.␊ - */␊ - export interface PacketCaptureStorageLocation8 {␊ - /**␊ - * The ID of the storage account to save the packet capture session. Required if no local file path is provided.␊ - */␊ - storageId?: string␊ - /**␊ - * The URI of the storage path to save the packet capture. Must be a well-formed URI describing the location to save the packet capture.␊ - */␊ - storagePath?: string␊ - /**␊ - * A valid local path on the targeting VM. Must include the name of the capture file (*.cap). For linux virtual machine it must start with /var/captures. Required if no storage ID is provided, otherwise optional.␊ - */␊ - filePath?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Filter that is applied to packet capture request. Multiple filters can be applied.␊ - */␊ - export interface PacketCaptureFilter8 {␊ - /**␊ - * Protocol to be filtered on.␊ - */␊ - protocol?: (("TCP" | "UDP" | "Any") | string)␊ - /**␊ - * Local IP Address to be filtered on. Notation: "127.0.0.1" for single address entry. "127.0.0.1-127.0.0.255" for range. "127.0.0.1;127.0.0.5"? for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.␊ - */␊ - localIPAddress?: string␊ - /**␊ - * Local IP Address to be filtered on. Notation: "127.0.0.1" for single address entry. "127.0.0.1-127.0.0.255" for range. "127.0.0.1;127.0.0.5;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.␊ - */␊ - remoteIPAddress?: string␊ - /**␊ - * Local port to be filtered on. Notation: "80" for single port entry."80-85" for range. "80;443;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.␊ - */␊ - localPort?: string␊ - /**␊ - * Remote port to be filtered on. Notation: "80" for single port entry."80-85" for range. "80;443;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.␊ - */␊ - remotePort?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/packetCaptures␊ - */␊ - export interface NetworkWatchersPacketCaptures8 {␊ - name: string␊ - type: "Microsoft.Network/networkWatchers/packetCaptures"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Properties of the packet capture.␊ - */␊ - properties: (PacketCaptureParameters8 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/p2svpnGateways␊ - */␊ - export interface P2SvpnGateways5 {␊ - name: string␊ - type: "Microsoft.Network/p2svpnGateways"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the P2SVpnGateway.␊ - */␊ - properties: (P2SVpnGatewayProperties5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for P2SVpnGateway.␊ - */␊ - export interface P2SVpnGatewayProperties5 {␊ - /**␊ - * The VirtualHub to which the gateway belongs.␊ - */␊ - virtualHub?: (SubResource31 | string)␊ - /**␊ - * List of all p2s connection configurations of the gateway.␊ - */␊ - p2SConnectionConfigurations?: (P2SConnectionConfiguration2[] | string)␊ - /**␊ - * The scale unit for this p2s vpn gateway.␊ - */␊ - vpnGatewayScaleUnit?: (number | string)␊ - /**␊ - * The VpnServerConfiguration to which the p2sVpnGateway is attached to.␊ - */␊ - vpnServerConfiguration?: (SubResource31 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * P2SConnectionConfiguration Resource.␊ - */␊ - export interface P2SConnectionConfiguration2 {␊ - /**␊ - * Properties of the P2S connection configuration.␊ - */␊ - properties?: (P2SConnectionConfigurationProperties2 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for P2SConnectionConfiguration.␊ - */␊ - export interface P2SConnectionConfigurationProperties2 {␊ - /**␊ - * The reference to the address space resource which represents Address space for P2S VpnClient.␊ - */␊ - vpnClientAddressPool?: (AddressSpace31 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateEndpoints␊ - */␊ - export interface PrivateEndpoints5 {␊ - name: string␊ - type: "Microsoft.Network/privateEndpoints"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the private endpoint.␊ - */␊ - properties: (PrivateEndpointProperties5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the private endpoint.␊ - */␊ - export interface PrivateEndpointProperties5 {␊ - /**␊ - * The ID of the subnet from which the private IP will be allocated.␊ - */␊ - subnet?: (SubResource31 | string)␊ - /**␊ - * A grouping of information about the connection to the remote resource.␊ - */␊ - privateLinkServiceConnections?: (PrivateLinkServiceConnection5[] | string)␊ - /**␊ - * A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource.␊ - */␊ - manualPrivateLinkServiceConnections?: (PrivateLinkServiceConnection5[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * PrivateLinkServiceConnection resource.␊ - */␊ - export interface PrivateLinkServiceConnection5 {␊ - /**␊ - * Properties of the private link service connection.␊ - */␊ - properties?: (PrivateLinkServiceConnectionProperties5 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the PrivateLinkServiceConnection.␊ - */␊ - export interface PrivateLinkServiceConnectionProperties5 {␊ - /**␊ - * The resource id of private link service.␊ - */␊ - privateLinkServiceId?: string␊ - /**␊ - * The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to.␊ - */␊ - groupIds?: (string[] | string)␊ - /**␊ - * A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars.␊ - */␊ - requestMessage?: string␊ - /**␊ - * A collection of read-only information about the state of the connection to the remote resource.␊ - */␊ - privateLinkServiceConnectionState?: (PrivateLinkServiceConnectionState11 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A collection of information about the state of the connection between service consumer and provider.␊ - */␊ - export interface PrivateLinkServiceConnectionState11 {␊ - /**␊ - * Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.␊ - */␊ - status?: string␊ - /**␊ - * The reason for approval/rejection of the connection.␊ - */␊ - description?: string␊ - /**␊ - * A message indicating if changes on the service provider require any updates on the consumer.␊ - */␊ - actionsRequired?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateLinkServices␊ - */␊ - export interface PrivateLinkServices5 {␊ - name: string␊ - type: "Microsoft.Network/privateLinkServices"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the private link service.␊ - */␊ - properties: (PrivateLinkServiceProperties5 | string)␊ - resources?: PrivateLinkServicesPrivateEndpointConnectionsChildResource5[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the private link service.␊ - */␊ - export interface PrivateLinkServiceProperties5 {␊ - /**␊ - * An array of references to the load balancer IP configurations.␊ - */␊ - loadBalancerFrontendIpConfigurations?: (SubResource31[] | string)␊ - /**␊ - * An array of private link service IP configurations.␊ - */␊ - ipConfigurations?: (PrivateLinkServiceIpConfiguration5[] | string)␊ - /**␊ - * The visibility list of the private link service.␊ - */␊ - visibility?: (PrivateLinkServicePropertiesVisibility5 | string)␊ - /**␊ - * The auto-approval list of the private link service.␊ - */␊ - autoApproval?: (PrivateLinkServicePropertiesAutoApproval5 | string)␊ - /**␊ - * The list of Fqdn.␊ - */␊ - fqdns?: (string[] | string)␊ - /**␊ - * Whether the private link service is enabled for proxy protocol or not.␊ - */␊ - enableProxyProtocol?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The private link service ip configuration.␊ - */␊ - export interface PrivateLinkServiceIpConfiguration5 {␊ - /**␊ - * Properties of the private link service ip configuration.␊ - */␊ - properties?: (PrivateLinkServiceIpConfigurationProperties5 | string)␊ - /**␊ - * The name of private link service ip configuration.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of private link service IP configuration.␊ - */␊ - export interface PrivateLinkServiceIpConfigurationProperties5 {␊ - /**␊ - * The private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The private IP address allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * The reference to the subnet resource.␊ - */␊ - subnet?: (SubResource31 | string)␊ - /**␊ - * Whether the ip configuration is primary or not.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4.␊ - */␊ - privateIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The visibility list of the private link service.␊ - */␊ - export interface PrivateLinkServicePropertiesVisibility5 {␊ - /**␊ - * The list of subscriptions.␊ - */␊ - subscriptions?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The auto-approval list of the private link service.␊ - */␊ - export interface PrivateLinkServicePropertiesAutoApproval5 {␊ - /**␊ - * The list of subscriptions.␊ - */␊ - subscriptions?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateLinkServices/privateEndpointConnections␊ - */␊ - export interface PrivateLinkServicesPrivateEndpointConnectionsChildResource5 {␊ - name: string␊ - type: "privateEndpointConnections"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Properties of the private end point connection.␊ - */␊ - properties: (PrivateEndpointConnectionProperties12 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the PrivateEndpointConnectProperties.␊ - */␊ - export interface PrivateEndpointConnectionProperties12 {␊ - /**␊ - * A collection of information about the state of the connection between service consumer and provider.␊ - */␊ - privateLinkServiceConnectionState?: (PrivateLinkServiceConnectionState11 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateLinkServices/privateEndpointConnections␊ - */␊ - export interface PrivateLinkServicesPrivateEndpointConnections5 {␊ - name: string␊ - type: "Microsoft.Network/privateLinkServices/privateEndpointConnections"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Properties of the private end point connection.␊ - */␊ - properties: (PrivateEndpointConnectionProperties12 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/publicIPAddresses␊ - */␊ - export interface PublicIPAddresses31 {␊ - name: string␊ - type: "Microsoft.Network/publicIPAddresses"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The public IP address SKU.␊ - */␊ - sku?: (PublicIPAddressSku19 | string)␊ - /**␊ - * Public IP address properties.␊ - */␊ - properties: (PublicIPAddressPropertiesFormat22 | string)␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a public IP address.␊ - */␊ - export interface PublicIPAddressSku19 {␊ - /**␊ - * Name of a public IP address SKU.␊ - */␊ - name?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Public IP address properties.␊ - */␊ - export interface PublicIPAddressPropertiesFormat22 {␊ - /**␊ - * The public IP address allocation method.␊ - */␊ - publicIPAllocationMethod: (("Static" | "Dynamic") | string)␊ - /**␊ - * The public IP address version.␊ - */␊ - publicIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The FQDN of the DNS record associated with the public IP address.␊ - */␊ - dnsSettings?: (PublicIPAddressDnsSettings30 | string)␊ - /**␊ - * The DDoS protection custom policy associated with the public IP address.␊ - */␊ - ddosSettings?: (DdosSettings8 | string)␊ - /**␊ - * The list of tags associated with the public IP address.␊ - */␊ - ipTags?: (IpTag16[] | string)␊ - /**␊ - * The IP address associated with the public IP address resource.␊ - */␊ - ipAddress?: string␊ - /**␊ - * The Public IP Prefix this Public IP Address should be allocated from.␊ - */␊ - publicIPPrefix?: (SubResource31 | string)␊ - /**␊ - * The idle timeout of the public IP address.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains FQDN of the DNS record associated with the public IP address.␊ - */␊ - export interface PublicIPAddressDnsSettings30 {␊ - /**␊ - * The domain name label. The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.␊ - */␊ - domainNameLabel: string␊ - /**␊ - * The Fully Qualified Domain Name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone.␊ - */␊ - fqdn?: string␊ - /**␊ - * The reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN.␊ - */␊ - reverseFqdn?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains the DDoS protection settings of the public IP.␊ - */␊ - export interface DdosSettings8 {␊ - /**␊ - * The DDoS custom policy associated with the public IP.␊ - */␊ - ddosCustomPolicy?: (SubResource31 | string)␊ - /**␊ - * The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized.␊ - */␊ - protectionCoverage?: (("Basic" | "Standard") | string)␊ - /**␊ - * Enables DDoS protection on the public IP.␊ - */␊ - protectedIP?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains the IpTag associated with the object.␊ - */␊ - export interface IpTag16 {␊ - /**␊ - * The IP tag type. Example: FirstPartyUsage.␊ - */␊ - ipTagType?: string␊ - /**␊ - * The value of the IP tag associated with the public IP. Example: SQL.␊ - */␊ - tag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/publicIPPrefixes␊ - */␊ - export interface PublicIPPrefixes6 {␊ - name: string␊ - type: "Microsoft.Network/publicIPPrefixes"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The public IP prefix SKU.␊ - */␊ - sku?: (PublicIPPrefixSku6 | string)␊ - /**␊ - * Public IP prefix properties.␊ - */␊ - properties: (PublicIPPrefixPropertiesFormat6 | string)␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a public IP prefix.␊ - */␊ - export interface PublicIPPrefixSku6 {␊ - /**␊ - * Name of a public IP prefix SKU.␊ - */␊ - name?: ("Standard" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Public IP prefix properties.␊ - */␊ - export interface PublicIPPrefixPropertiesFormat6 {␊ - /**␊ - * The public IP address version.␊ - */␊ - publicIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The list of tags associated with the public IP prefix.␊ - */␊ - ipTags?: (IpTag16[] | string)␊ - /**␊ - * The Length of the Public IP Prefix.␊ - */␊ - prefixLength?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeFilters␊ - */␊ - export interface RouteFilters8 {␊ - name: string␊ - type: "Microsoft.Network/routeFilters"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the route filter.␊ - */␊ - properties: (RouteFilterPropertiesFormat8 | string)␊ - resources?: RouteFiltersRouteFilterRulesChildResource8[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Filter Resource.␊ - */␊ - export interface RouteFilterPropertiesFormat8 {␊ - /**␊ - * Collection of RouteFilterRules contained within a route filter.␊ - */␊ - rules?: (RouteFilterRule8[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Filter Rule Resource.␊ - */␊ - export interface RouteFilterRule8 {␊ - /**␊ - * Properties of the route filter rule.␊ - */␊ - properties?: (RouteFilterRulePropertiesFormat8 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Filter Rule Resource.␊ - */␊ - export interface RouteFilterRulePropertiesFormat8 {␊ - /**␊ - * The access type of the rule.␊ - */␊ - access: (("Allow" | "Deny") | string)␊ - /**␊ - * The rule type of the rule.␊ - */␊ - routeFilterRuleType: ("Community" | string)␊ - /**␊ - * The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'].␊ - */␊ - communities: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeFilters/routeFilterRules␊ - */␊ - export interface RouteFiltersRouteFilterRulesChildResource8 {␊ - name: string␊ - type: "routeFilterRules"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Properties of the route filter rule.␊ - */␊ - properties: (RouteFilterRulePropertiesFormat8 | string)␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeFilters/routeFilterRules␊ - */␊ - export interface RouteFiltersRouteFilterRules8 {␊ - name: string␊ - type: "Microsoft.Network/routeFilters/routeFilterRules"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Properties of the route filter rule.␊ - */␊ - properties: (RouteFilterRulePropertiesFormat8 | string)␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables␊ - */␊ - export interface RouteTables31 {␊ - name: string␊ - type: "Microsoft.Network/routeTables"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the route table.␊ - */␊ - properties: (RouteTablePropertiesFormat23 | string)␊ - resources?: RouteTablesRoutesChildResource23[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Table resource.␊ - */␊ - export interface RouteTablePropertiesFormat23 {␊ - /**␊ - * Collection of routes contained within a route table.␊ - */␊ - routes?: (Route23[] | string)␊ - /**␊ - * Whether to disable the routes learned by BGP on that route table. True means disable.␊ - */␊ - disableBgpRoutePropagation?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource.␊ - */␊ - export interface Route23 {␊ - /**␊ - * Properties of the route.␊ - */␊ - properties?: (RoutePropertiesFormat23 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource.␊ - */␊ - export interface RoutePropertiesFormat23 {␊ - /**␊ - * The destination CIDR to which the route applies.␊ - */␊ - addressPrefix: string␊ - /**␊ - * The type of Azure hop the packet should be sent to.␊ - */␊ - nextHopType: (("VirtualNetworkGateway" | "VnetLocal" | "Internet" | "VirtualAppliance" | "None") | string)␊ - /**␊ - * The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.␊ - */␊ - nextHopIpAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutesChildResource23 {␊ - name: string␊ - type: "routes"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Properties of the route.␊ - */␊ - properties: (RoutePropertiesFormat23 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutes23 {␊ - name: string␊ - type: "Microsoft.Network/routeTables/routes"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Properties of the route.␊ - */␊ - properties: (RoutePropertiesFormat23 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/serviceEndpointPolicies␊ - */␊ - export interface ServiceEndpointPolicies6 {␊ - name: string␊ - type: "Microsoft.Network/serviceEndpointPolicies"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the service end point policy.␊ - */␊ - properties: (ServiceEndpointPolicyPropertiesFormat6 | string)␊ - resources?: ServiceEndpointPoliciesServiceEndpointPolicyDefinitionsChildResource6[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Service Endpoint Policy resource.␊ - */␊ - export interface ServiceEndpointPolicyPropertiesFormat6 {␊ - /**␊ - * A collection of service endpoint policy definitions of the service endpoint policy.␊ - */␊ - serviceEndpointPolicyDefinitions?: (ServiceEndpointPolicyDefinition6[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Service Endpoint policy definitions.␊ - */␊ - export interface ServiceEndpointPolicyDefinition6 {␊ - /**␊ - * Properties of the service endpoint policy definition.␊ - */␊ - properties?: (ServiceEndpointPolicyDefinitionPropertiesFormat6 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Service Endpoint policy definition resource.␊ - */␊ - export interface ServiceEndpointPolicyDefinitionPropertiesFormat6 {␊ - /**␊ - * A description for this rule. Restricted to 140 chars.␊ - */␊ - description?: string␊ - /**␊ - * Service endpoint name.␊ - */␊ - service?: string␊ - /**␊ - * A list of service resources.␊ - */␊ - serviceResources?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions␊ - */␊ - export interface ServiceEndpointPoliciesServiceEndpointPolicyDefinitionsChildResource6 {␊ - name: string␊ - type: "serviceEndpointPolicyDefinitions"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Properties of the service endpoint policy definition.␊ - */␊ - properties: (ServiceEndpointPolicyDefinitionPropertiesFormat6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions␊ - */␊ - export interface ServiceEndpointPoliciesServiceEndpointPolicyDefinitions6 {␊ - name: string␊ - type: "Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Properties of the service endpoint policy definition.␊ - */␊ - properties: (ServiceEndpointPolicyDefinitionPropertiesFormat6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualHubs␊ - */␊ - export interface VirtualHubs8 {␊ - name: string␊ - type: "Microsoft.Network/virtualHubs"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual hub.␊ - */␊ - properties: (VirtualHubProperties8 | string)␊ - resources?: VirtualHubsRouteTablesChildResource1[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VirtualHub.␊ - */␊ - export interface VirtualHubProperties8 {␊ - /**␊ - * The VirtualWAN to which the VirtualHub belongs.␊ - */␊ - virtualWan?: (SubResource31 | string)␊ - /**␊ - * The VpnGateway associated with this VirtualHub.␊ - */␊ - vpnGateway?: (SubResource31 | string)␊ - /**␊ - * The P2SVpnGateway associated with this VirtualHub.␊ - */␊ - p2SVpnGateway?: (SubResource31 | string)␊ - /**␊ - * The expressRouteGateway associated with this VirtualHub.␊ - */␊ - expressRouteGateway?: (SubResource31 | string)␊ - /**␊ - * The azureFirewall associated with this VirtualHub.␊ - */␊ - azureFirewall?: (SubResource31 | string)␊ - /**␊ - * List of all vnet connections with this VirtualHub.␊ - */␊ - virtualNetworkConnections?: (HubVirtualNetworkConnection8[] | string)␊ - /**␊ - * Address-prefix for this VirtualHub.␊ - */␊ - addressPrefix?: string␊ - /**␊ - * The routeTable associated with this virtual hub.␊ - */␊ - routeTable?: (VirtualHubRouteTable5 | string)␊ - /**␊ - * The Security Provider name.␊ - */␊ - securityProviderName?: string␊ - /**␊ - * List of all virtual hub route table v2s associated with this VirtualHub.␊ - */␊ - virtualHubRouteTableV2s?: (VirtualHubRouteTableV21[] | string)␊ - /**␊ - * The sku of this VirtualHub.␊ - */␊ - sku?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HubVirtualNetworkConnection Resource.␊ - */␊ - export interface HubVirtualNetworkConnection8 {␊ - /**␊ - * Properties of the hub virtual network connection.␊ - */␊ - properties?: (HubVirtualNetworkConnectionProperties8 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for HubVirtualNetworkConnection.␊ - */␊ - export interface HubVirtualNetworkConnectionProperties8 {␊ - /**␊ - * Reference to the remote virtual network.␊ - */␊ - remoteVirtualNetwork?: (SubResource31 | string)␊ - /**␊ - * VirtualHub to RemoteVnet transit to enabled or not.␊ - */␊ - allowHubToRemoteVnetTransit?: (boolean | string)␊ - /**␊ - * Allow RemoteVnet to use Virtual Hub's gateways.␊ - */␊ - allowRemoteVnetToUseHubVnetGateways?: (boolean | string)␊ - /**␊ - * Enable internet security.␊ - */␊ - enableInternetSecurity?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualHub route table.␊ - */␊ - export interface VirtualHubRouteTable5 {␊ - /**␊ - * List of all routes.␊ - */␊ - routes?: (VirtualHubRoute5[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualHub route.␊ - */␊ - export interface VirtualHubRoute5 {␊ - /**␊ - * List of all addressPrefixes.␊ - */␊ - addressPrefixes?: (string[] | string)␊ - /**␊ - * NextHop ip address.␊ - */␊ - nextHopIpAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualHubRouteTableV2 Resource.␊ - */␊ - export interface VirtualHubRouteTableV21 {␊ - /**␊ - * Properties of the virtual hub route table v2.␊ - */␊ - properties?: (VirtualHubRouteTableV2Properties1 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VirtualHubRouteTableV2.␊ - */␊ - export interface VirtualHubRouteTableV2Properties1 {␊ - /**␊ - * List of all routes.␊ - */␊ - routes?: (VirtualHubRouteV21[] | string)␊ - /**␊ - * List of all connections attached to this route table v2.␊ - */␊ - attachedConnections?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualHubRouteTableV2 route.␊ - */␊ - export interface VirtualHubRouteV21 {␊ - /**␊ - * The type of destinations.␊ - */␊ - destinationType?: string␊ - /**␊ - * List of all destinations.␊ - */␊ - destinations?: (string[] | string)␊ - /**␊ - * The type of next hops.␊ - */␊ - nextHopType?: string␊ - /**␊ - * NextHops ip address.␊ - */␊ - nextHops?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualHubs/routeTables␊ - */␊ - export interface VirtualHubsRouteTablesChildResource1 {␊ - name: string␊ - type: "routeTables"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Properties of the virtual hub route table v2.␊ - */␊ - properties: (VirtualHubRouteTableV2Properties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualHubs/routeTables␊ - */␊ - export interface VirtualHubsRouteTables1 {␊ - name: string␊ - type: "Microsoft.Network/virtualHubs/routeTables"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Properties of the virtual hub route table v2.␊ - */␊ - properties: (VirtualHubRouteTableV2Properties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworkGateways␊ - */␊ - export interface VirtualNetworkGateways23 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworkGateways"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway.␊ - */␊ - properties: (VirtualNetworkGatewayPropertiesFormat23 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGateway properties.␊ - */␊ - export interface VirtualNetworkGatewayPropertiesFormat23 {␊ - /**␊ - * IP configurations for virtual network gateway.␊ - */␊ - ipConfigurations?: (VirtualNetworkGatewayIPConfiguration22[] | string)␊ - /**␊ - * The type of this virtual network gateway.␊ - */␊ - gatewayType?: (("Vpn" | "ExpressRoute" | "HyperNet") | string)␊ - /**␊ - * The type of this virtual network gateway.␊ - */␊ - vpnType?: (("PolicyBased" | "RouteBased") | string)␊ - /**␊ - * The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN.␊ - */␊ - vpnGatewayGeneration?: (("None" | "Generation1" | "Generation2") | string)␊ - /**␊ - * Whether BGP is enabled for this virtual network gateway or not.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * ActiveActive flag.␊ - */␊ - activeActive?: (boolean | string)␊ - /**␊ - * The reference to the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting.␊ - */␊ - gatewayDefaultSite?: (SubResource31 | string)␊ - /**␊ - * The reference to the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.␊ - */␊ - sku?: (VirtualNetworkGatewaySku22 | string)␊ - /**␊ - * The reference to the VpnClientConfiguration resource which represents the P2S VpnClient configurations.␊ - */␊ - vpnClientConfiguration?: (VpnClientConfiguration22 | string)␊ - /**␊ - * Virtual network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings22 | string)␊ - /**␊ - * The reference to the address space resource which represents the custom routes address space specified by the customer for virtual network gateway and VpnClient.␊ - */␊ - customRoutes?: (AddressSpace31 | string)␊ - /**␊ - * Whether dns forwarding is enabled or not.␊ - */␊ - enableDnsForwarding?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration for virtual network gateway.␊ - */␊ - export interface VirtualNetworkGatewayIPConfiguration22 {␊ - /**␊ - * Properties of the virtual network gateway ip configuration.␊ - */␊ - properties?: (VirtualNetworkGatewayIPConfigurationPropertiesFormat22 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of VirtualNetworkGatewayIPConfiguration.␊ - */␊ - export interface VirtualNetworkGatewayIPConfigurationPropertiesFormat22 {␊ - /**␊ - * The private IP address allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * The reference to the subnet resource.␊ - */␊ - subnet?: (SubResource31 | string)␊ - /**␊ - * The reference to the public IP resource.␊ - */␊ - publicIPAddress?: (SubResource31 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewaySku details.␊ - */␊ - export interface VirtualNetworkGatewaySku22 {␊ - /**␊ - * Gateway SKU name.␊ - */␊ - name?: (("Basic" | "HighPerformance" | "Standard" | "UltraPerformance" | "VpnGw1" | "VpnGw2" | "VpnGw3" | "VpnGw4" | "VpnGw5" | "VpnGw1AZ" | "VpnGw2AZ" | "VpnGw3AZ" | "VpnGw4AZ" | "VpnGw5AZ" | "ErGw1AZ" | "ErGw2AZ" | "ErGw3AZ") | string)␊ - /**␊ - * Gateway SKU tier.␊ - */␊ - tier?: (("Basic" | "HighPerformance" | "Standard" | "UltraPerformance" | "VpnGw1" | "VpnGw2" | "VpnGw3" | "VpnGw4" | "VpnGw5" | "VpnGw1AZ" | "VpnGw2AZ" | "VpnGw3AZ" | "VpnGw4AZ" | "VpnGw5AZ" | "ErGw1AZ" | "ErGw2AZ" | "ErGw3AZ") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnClientConfiguration for P2S client.␊ - */␊ - export interface VpnClientConfiguration22 {␊ - /**␊ - * The reference to the address space resource which represents Address space for P2S VpnClient.␊ - */␊ - vpnClientAddressPool?: (AddressSpace31 | string)␊ - /**␊ - * VpnClientRootCertificate for virtual network gateway.␊ - */␊ - vpnClientRootCertificates?: (VpnClientRootCertificate22[] | string)␊ - /**␊ - * VpnClientRevokedCertificate for Virtual network gateway.␊ - */␊ - vpnClientRevokedCertificates?: (VpnClientRevokedCertificate22[] | string)␊ - /**␊ - * VpnClientProtocols for Virtual network gateway.␊ - */␊ - vpnClientProtocols?: (("IkeV2" | "SSTP" | "OpenVPN")[] | string)␊ - /**␊ - * VpnClientIpsecPolicies for virtual network gateway P2S client.␊ - */␊ - vpnClientIpsecPolicies?: (IpsecPolicy20[] | string)␊ - /**␊ - * The radius server address property of the VirtualNetworkGateway resource for vpn client connection.␊ - */␊ - radiusServerAddress?: string␊ - /**␊ - * The radius secret property of the VirtualNetworkGateway resource for vpn client connection.␊ - */␊ - radiusServerSecret?: string␊ - /**␊ - * The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication.␊ - */␊ - aadTenant?: string␊ - /**␊ - * The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication.␊ - */␊ - aadAudience?: string␊ - /**␊ - * The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication.␊ - */␊ - aadIssuer?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client root certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRootCertificate22 {␊ - /**␊ - * Properties of the vpn client root certificate.␊ - */␊ - properties: (VpnClientRootCertificatePropertiesFormat22 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of application gateway.␊ - */␊ - export interface VpnClientRootCertificatePropertiesFormat22 {␊ - /**␊ - * The certificate public data.␊ - */␊ - publicCertData: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client revoked certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRevokedCertificate22 {␊ - /**␊ - * Properties of the vpn client revoked certificate.␊ - */␊ - properties?: (VpnClientRevokedCertificatePropertiesFormat22 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the revoked VPN client certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRevokedCertificatePropertiesFormat22 {␊ - /**␊ - * The revoked VPN client certificate thumbprint.␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks␊ - */␊ - export interface VirtualNetworks31 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network.␊ - */␊ - properties: (VirtualNetworkPropertiesFormat23 | string)␊ - resources?: (VirtualNetworksVirtualNetworkPeeringsChildResource20 | VirtualNetworksSubnetsChildResource23)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the virtual network.␊ - */␊ - export interface VirtualNetworkPropertiesFormat23 {␊ - /**␊ - * The AddressSpace that contains an array of IP address ranges that can be used by subnets.␊ - */␊ - addressSpace: (AddressSpace31 | string)␊ - /**␊ - * The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network.␊ - */␊ - dhcpOptions?: (DhcpOptions31 | string)␊ - /**␊ - * A list of subnets in a Virtual Network.␊ - */␊ - subnets?: (Subnet33[] | string)␊ - /**␊ - * A list of peerings in a Virtual Network.␊ - */␊ - virtualNetworkPeerings?: (VirtualNetworkPeering28[] | string)␊ - /**␊ - * Indicates if DDoS protection is enabled for all the protected resources in the virtual network. It requires a DDoS protection plan associated with the resource.␊ - */␊ - enableDdosProtection?: (boolean | string)␊ - /**␊ - * Indicates if VM protection is enabled for all the subnets in the virtual network.␊ - */␊ - enableVmProtection?: (boolean | string)␊ - /**␊ - * The DDoS protection plan associated with the virtual network.␊ - */␊ - ddosProtectionPlan?: (SubResource31 | string)␊ - /**␊ - * Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET.␊ - */␊ - bgpCommunities?: (VirtualNetworkBgpCommunities2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DhcpOptions contains an array of DNS servers available to VMs deployed in the virtual network. Standard DHCP option for a subnet overrides VNET DHCP options.␊ - */␊ - export interface DhcpOptions31 {␊ - /**␊ - * The list of DNS servers IP addresses.␊ - */␊ - dnsServers: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Subnet in a virtual network resource.␊ - */␊ - export interface Subnet33 {␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties?: (SubnetPropertiesFormat23 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the subnet.␊ - */␊ - export interface SubnetPropertiesFormat23 {␊ - /**␊ - * The address prefix for the subnet.␊ - */␊ - addressPrefix: string␊ - /**␊ - * List of address prefixes for the subnet.␊ - */␊ - addressPrefixes?: (string[] | string)␊ - /**␊ - * The reference to the NetworkSecurityGroup resource.␊ - */␊ - networkSecurityGroup?: (SubResource31 | string)␊ - /**␊ - * The reference to the RouteTable resource.␊ - */␊ - routeTable?: (SubResource31 | string)␊ - /**␊ - * Nat gateway associated with this subnet.␊ - */␊ - natGateway?: (SubResource31 | string)␊ - /**␊ - * An array of service endpoints.␊ - */␊ - serviceEndpoints?: (ServiceEndpointPropertiesFormat19[] | string)␊ - /**␊ - * An array of service endpoint policies.␊ - */␊ - serviceEndpointPolicies?: (SubResource31[] | string)␊ - /**␊ - * An array of references to the delegations on the subnet.␊ - */␊ - delegations?: (Delegation10[] | string)␊ - /**␊ - * Enable or Disable apply network policies on private end point in the subnet.␊ - */␊ - privateEndpointNetworkPolicies?: string␊ - /**␊ - * Enable or Disable apply network policies on private link service in the subnet.␊ - */␊ - privateLinkServiceNetworkPolicies?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The service endpoint properties.␊ - */␊ - export interface ServiceEndpointPropertiesFormat19 {␊ - /**␊ - * The type of the endpoint service.␊ - */␊ - service?: string␊ - /**␊ - * A list of locations.␊ - */␊ - locations?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Details the service to which the subnet is delegated.␊ - */␊ - export interface Delegation10 {␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties?: (ServiceDelegationPropertiesFormat10 | string)␊ - /**␊ - * The name of the resource that is unique within a subnet. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a service delegation.␊ - */␊ - export interface ServiceDelegationPropertiesFormat10 {␊ - /**␊ - * The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers).␊ - */␊ - serviceName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peerings in a virtual network resource.␊ - */␊ - export interface VirtualNetworkPeering28 {␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties?: (VirtualNetworkPeeringPropertiesFormat20 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - export interface VirtualNetworkPeeringPropertiesFormat20 {␊ - /**␊ - * Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space.␊ - */␊ - allowVirtualNetworkAccess?: (boolean | string)␊ - /**␊ - * Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network.␊ - */␊ - allowForwardedTraffic?: (boolean | string)␊ - /**␊ - * If gateway links can be used in remote virtual networking to link to this virtual network.␊ - */␊ - allowGatewayTransit?: (boolean | string)␊ - /**␊ - * If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway.␊ - */␊ - useRemoteGateways?: (boolean | string)␊ - /**␊ - * The reference to the remote virtual network. The remote virtual network can be in the same or different region (preview). See here to register for the preview and learn more (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering).␊ - */␊ - remoteVirtualNetwork: (SubResource31 | string)␊ - /**␊ - * The reference to the remote virtual network address space.␊ - */␊ - remoteAddressSpace?: (AddressSpace31 | string)␊ - /**␊ - * The status of the virtual network peering.␊ - */␊ - peeringState?: (("Initiated" | "Connected" | "Disconnected") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET.␊ - */␊ - export interface VirtualNetworkBgpCommunities2 {␊ - /**␊ - * The BGP community associated with the virtual network.␊ - */␊ - virtualNetworkCommunity: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/virtualNetworkPeerings␊ - */␊ - export interface VirtualNetworksVirtualNetworkPeeringsChildResource20 {␊ - name: string␊ - type: "virtualNetworkPeerings"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties: (VirtualNetworkPeeringPropertiesFormat20 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnetsChildResource23 {␊ - name: string␊ - type: "subnets"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties: (SubnetPropertiesFormat23 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnets23 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks/subnets"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties: (SubnetPropertiesFormat23 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/virtualNetworkPeerings␊ - */␊ - export interface VirtualNetworksVirtualNetworkPeerings20 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks/virtualNetworkPeerings"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties: (VirtualNetworkPeeringPropertiesFormat20 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworkTaps␊ - */␊ - export interface VirtualNetworkTaps5 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworkTaps"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Virtual Network Tap Properties.␊ - */␊ - properties: (VirtualNetworkTapPropertiesFormat5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Virtual Network Tap properties.␊ - */␊ - export interface VirtualNetworkTapPropertiesFormat5 {␊ - /**␊ - * The reference to the private IP Address of the collector nic that will receive the tap.␊ - */␊ - destinationNetworkInterfaceIPConfiguration?: (SubResource31 | string)␊ - /**␊ - * The reference to the private IP address on the internal Load Balancer that will receive the tap.␊ - */␊ - destinationLoadBalancerFrontEndIPConfiguration?: (SubResource31 | string)␊ - /**␊ - * The VXLAN destination port that will receive the tapped traffic.␊ - */␊ - destinationPort?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualRouters␊ - */␊ - export interface VirtualRouters3 {␊ - name: string␊ - type: "Microsoft.Network/virtualRouters"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the Virtual Router.␊ - */␊ - properties: (VirtualRouterPropertiesFormat3 | string)␊ - resources?: VirtualRoutersPeeringsChildResource3[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Virtual Router definition.␊ - */␊ - export interface VirtualRouterPropertiesFormat3 {␊ - /**␊ - * VirtualRouter ASN.␊ - */␊ - virtualRouterAsn?: (number | string)␊ - /**␊ - * VirtualRouter IPs.␊ - */␊ - virtualRouterIps?: (string[] | string)␊ - /**␊ - * The Subnet on which VirtualRouter is hosted.␊ - */␊ - hostedSubnet?: (SubResource31 | string)␊ - /**␊ - * The Gateway on which VirtualRouter is hosted.␊ - */␊ - hostedGateway?: (SubResource31 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualRouters/peerings␊ - */␊ - export interface VirtualRoutersPeeringsChildResource3 {␊ - name: string␊ - type: "peerings"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * The properties of the Virtual Router Peering.␊ - */␊ - properties: (VirtualRouterPeeringProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the rule group.␊ - */␊ - export interface VirtualRouterPeeringProperties3 {␊ - /**␊ - * Peer ASN.␊ - */␊ - peerAsn?: (number | string)␊ - /**␊ - * Peer IP.␊ - */␊ - peerIp?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualRouters/peerings␊ - */␊ - export interface VirtualRoutersPeerings3 {␊ - name: string␊ - type: "Microsoft.Network/virtualRouters/peerings"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * The properties of the Virtual Router Peering.␊ - */␊ - properties: (VirtualRouterPeeringProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualWans␊ - */␊ - export interface VirtualWans8 {␊ - name: string␊ - type: "Microsoft.Network/virtualWans"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual WAN.␊ - */␊ - properties: (VirtualWanProperties8 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VirtualWAN.␊ - */␊ - export interface VirtualWanProperties8 {␊ - /**␊ - * Vpn encryption to be disabled or not.␊ - */␊ - disableVpnEncryption?: (boolean | string)␊ - /**␊ - * True if branch to branch traffic is allowed.␊ - */␊ - allowBranchToBranchTraffic?: (boolean | string)␊ - /**␊ - * True if Vnet to Vnet traffic is allowed.␊ - */␊ - allowVnetToVnetTraffic?: (boolean | string)␊ - /**␊ - * The office local breakout category.␊ - */␊ - office365LocalBreakoutCategory?: (("Optimize" | "OptimizeAndAllow" | "All" | "None") | string)␊ - /**␊ - * The type of the VirtualWAN.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnGateways␊ - */␊ - export interface VpnGateways8 {␊ - name: string␊ - type: "Microsoft.Network/vpnGateways"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the VPN gateway.␊ - */␊ - properties: (VpnGatewayProperties8 | string)␊ - resources?: VpnGatewaysVpnConnectionsChildResource8[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnGateway.␊ - */␊ - export interface VpnGatewayProperties8 {␊ - /**␊ - * The VirtualHub to which the gateway belongs.␊ - */␊ - virtualHub?: (SubResource31 | string)␊ - /**␊ - * List of all vpn connections to the gateway.␊ - */␊ - connections?: (VpnConnection8[] | string)␊ - /**␊ - * Local network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings22 | string)␊ - /**␊ - * The scale unit for this vpn gateway.␊ - */␊ - vpnGatewayScaleUnit?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnConnection Resource.␊ - */␊ - export interface VpnConnection8 {␊ - /**␊ - * Properties of the VPN connection.␊ - */␊ - properties?: (VpnConnectionProperties8 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnConnection.␊ - */␊ - export interface VpnConnectionProperties8 {␊ - /**␊ - * Id of the connected vpn site.␊ - */␊ - remoteVpnSite?: (SubResource31 | string)␊ - /**␊ - * Routing weight for vpn connection.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * The connection status.␊ - */␊ - connectionStatus?: (("Unknown" | "Connecting" | "Connected" | "NotConnected") | string)␊ - /**␊ - * Connection protocol used for this connection.␊ - */␊ - vpnConnectionProtocolType?: (("IKEv2" | "IKEv1") | string)␊ - /**␊ - * Expected bandwidth in MBPS.␊ - */␊ - connectionBandwidth?: (number | string)␊ - /**␊ - * SharedKey for the vpn connection.␊ - */␊ - sharedKey?: string␊ - /**␊ - * EnableBgp flag.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * Enable policy-based traffic selectors.␊ - */␊ - usePolicyBasedTrafficSelectors?: (boolean | string)␊ - /**␊ - * The IPSec Policies to be considered by this connection.␊ - */␊ - ipsecPolicies?: (IpsecPolicy20[] | string)␊ - /**␊ - * EnableBgp flag.␊ - */␊ - enableRateLimiting?: (boolean | string)␊ - /**␊ - * Enable internet security.␊ - */␊ - enableInternetSecurity?: (boolean | string)␊ - /**␊ - * Use local azure ip to initiate connection.␊ - */␊ - useLocalAzureIpAddress?: (boolean | string)␊ - /**␊ - * List of all vpn site link connections to the gateway.␊ - */␊ - vpnLinkConnections?: (VpnSiteLinkConnection4[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnSiteLinkConnection Resource.␊ - */␊ - export interface VpnSiteLinkConnection4 {␊ - /**␊ - * Properties of the VPN site link connection.␊ - */␊ - properties?: (VpnSiteLinkConnectionProperties4 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnConnection.␊ - */␊ - export interface VpnSiteLinkConnectionProperties4 {␊ - /**␊ - * Id of the connected vpn site link.␊ - */␊ - vpnSiteLink?: (SubResource31 | string)␊ - /**␊ - * Routing weight for vpn connection.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * The connection status.␊ - */␊ - connectionStatus?: (("Unknown" | "Connecting" | "Connected" | "NotConnected") | string)␊ - /**␊ - * Connection protocol used for this connection.␊ - */␊ - vpnConnectionProtocolType?: (("IKEv2" | "IKEv1") | string)␊ - /**␊ - * Expected bandwidth in MBPS.␊ - */␊ - connectionBandwidth?: (number | string)␊ - /**␊ - * SharedKey for the vpn connection.␊ - */␊ - sharedKey?: string␊ - /**␊ - * EnableBgp flag.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * Enable policy-based traffic selectors.␊ - */␊ - usePolicyBasedTrafficSelectors?: (boolean | string)␊ - /**␊ - * The IPSec Policies to be considered by this connection.␊ - */␊ - ipsecPolicies?: (IpsecPolicy20[] | string)␊ - /**␊ - * EnableBgp flag.␊ - */␊ - enableRateLimiting?: (boolean | string)␊ - /**␊ - * Use local azure ip to initiate connection.␊ - */␊ - useLocalAzureIpAddress?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnGateways/vpnConnections␊ - */␊ - export interface VpnGatewaysVpnConnectionsChildResource8 {␊ - name: string␊ - type: "vpnConnections"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Properties of the VPN connection.␊ - */␊ - properties: (VpnConnectionProperties8 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnGateways/vpnConnections␊ - */␊ - export interface VpnGatewaysVpnConnections8 {␊ - name: string␊ - type: "Microsoft.Network/vpnGateways/vpnConnections"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Properties of the VPN connection.␊ - */␊ - properties: (VpnConnectionProperties8 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnServerConfigurations␊ - */␊ - export interface VpnServerConfigurations2 {␊ - name: string␊ - type: "Microsoft.Network/vpnServerConfigurations"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the P2SVpnServer configuration.␊ - */␊ - properties: (VpnServerConfigurationProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnServerConfiguration.␊ - */␊ - export interface VpnServerConfigurationProperties2 {␊ - /**␊ - * The name of the VpnServerConfiguration that is unique within a resource group.␊ - */␊ - name?: string␊ - /**␊ - * VPN protocols for the VpnServerConfiguration.␊ - */␊ - vpnProtocols?: (("IkeV2" | "OpenVPN")[] | string)␊ - /**␊ - * VPN authentication types for the VpnServerConfiguration.␊ - */␊ - vpnAuthenticationTypes?: (("Certificate" | "Radius" | "AAD")[] | string)␊ - /**␊ - * VPN client root certificate of VpnServerConfiguration.␊ - */␊ - vpnClientRootCertificates?: (VpnServerConfigVpnClientRootCertificate2[] | string)␊ - /**␊ - * VPN client revoked certificate of VpnServerConfiguration.␊ - */␊ - vpnClientRevokedCertificates?: (VpnServerConfigVpnClientRevokedCertificate2[] | string)␊ - /**␊ - * Radius Server root certificate of VpnServerConfiguration.␊ - */␊ - radiusServerRootCertificates?: (VpnServerConfigRadiusServerRootCertificate2[] | string)␊ - /**␊ - * Radius client root certificate of VpnServerConfiguration.␊ - */␊ - radiusClientRootCertificates?: (VpnServerConfigRadiusClientRootCertificate2[] | string)␊ - /**␊ - * VpnClientIpsecPolicies for VpnServerConfiguration.␊ - */␊ - vpnClientIpsecPolicies?: (IpsecPolicy20[] | string)␊ - /**␊ - * The radius server address property of the VpnServerConfiguration resource for point to site client connection.␊ - */␊ - radiusServerAddress?: string␊ - /**␊ - * The radius secret property of the VpnServerConfiguration resource for point to site client connection.␊ - */␊ - radiusServerSecret?: string␊ - /**␊ - * The set of aad vpn authentication parameters.␊ - */␊ - aadAuthenticationParameters?: (AadAuthenticationParameters2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of VPN client root certificate of VpnServerConfiguration.␊ - */␊ - export interface VpnServerConfigVpnClientRootCertificate2 {␊ - /**␊ - * The certificate name.␊ - */␊ - name?: string␊ - /**␊ - * The certificate public data.␊ - */␊ - publicCertData?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the revoked VPN client certificate of VpnServerConfiguration.␊ - */␊ - export interface VpnServerConfigVpnClientRevokedCertificate2 {␊ - /**␊ - * The certificate name.␊ - */␊ - name?: string␊ - /**␊ - * The revoked VPN client certificate thumbprint.␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Radius Server root certificate of VpnServerConfiguration.␊ - */␊ - export interface VpnServerConfigRadiusServerRootCertificate2 {␊ - /**␊ - * The certificate name.␊ - */␊ - name?: string␊ - /**␊ - * The certificate public data.␊ - */␊ - publicCertData?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Radius client root certificate of VpnServerConfiguration.␊ - */␊ - export interface VpnServerConfigRadiusClientRootCertificate2 {␊ - /**␊ - * The certificate name.␊ - */␊ - name?: string␊ - /**␊ - * The Radius client root certificate thumbprint.␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AAD Vpn authentication type related parameters.␊ - */␊ - export interface AadAuthenticationParameters2 {␊ - /**␊ - * AAD Vpn authentication parameter AAD tenant.␊ - */␊ - aadTenant?: string␊ - /**␊ - * AAD Vpn authentication parameter AAD audience.␊ - */␊ - aadAudience?: string␊ - /**␊ - * AAD Vpn authentication parameter AAD issuer.␊ - */␊ - aadIssuer?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnSites␊ - */␊ - export interface VpnSites8 {␊ - name: string␊ - type: "Microsoft.Network/vpnSites"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the VPN site.␊ - */␊ - properties: (VpnSiteProperties8 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnSite.␊ - */␊ - export interface VpnSiteProperties8 {␊ - /**␊ - * The VirtualWAN to which the vpnSite belongs.␊ - */␊ - virtualWan?: (SubResource31 | string)␊ - /**␊ - * The device properties.␊ - */␊ - deviceProperties?: (DeviceProperties8 | string)␊ - /**␊ - * The ip-address for the vpn-site.␊ - */␊ - ipAddress?: string␊ - /**␊ - * The key for vpn-site that can be used for connections.␊ - */␊ - siteKey?: string␊ - /**␊ - * The AddressSpace that contains an array of IP address ranges.␊ - */␊ - addressSpace?: (AddressSpace31 | string)␊ - /**␊ - * The set of bgp properties.␊ - */␊ - bgpProperties?: (BgpSettings22 | string)␊ - /**␊ - * IsSecuritySite flag.␊ - */␊ - isSecuritySite?: (boolean | string)␊ - /**␊ - * List of all vpn site links.␊ - */␊ - vpnSiteLinks?: (VpnSiteLink4[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * List of properties of the device.␊ - */␊ - export interface DeviceProperties8 {␊ - /**␊ - * Name of the device Vendor.␊ - */␊ - deviceVendor?: string␊ - /**␊ - * Model of the device.␊ - */␊ - deviceModel?: string␊ - /**␊ - * Link speed.␊ - */␊ - linkSpeedInMbps?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnSiteLink Resource.␊ - */␊ - export interface VpnSiteLink4 {␊ - /**␊ - * Properties of the VPN site link.␊ - */␊ - properties?: (VpnSiteLinkProperties4 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnSite.␊ - */␊ - export interface VpnSiteLinkProperties4 {␊ - /**␊ - * The link provider properties.␊ - */␊ - linkProperties?: (VpnLinkProviderProperties4 | string)␊ - /**␊ - * The ip-address for the vpn-site-link.␊ - */␊ - ipAddress?: string␊ - /**␊ - * The set of bgp properties.␊ - */␊ - bgpProperties?: (VpnLinkBgpSettings4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * List of properties of a link provider.␊ - */␊ - export interface VpnLinkProviderProperties4 {␊ - /**␊ - * Name of the link provider.␊ - */␊ - linkProviderName?: string␊ - /**␊ - * Link speed.␊ - */␊ - linkSpeedInMbps?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * BGP settings details for a link.␊ - */␊ - export interface VpnLinkBgpSettings4 {␊ - /**␊ - * The BGP speaker's ASN.␊ - */␊ - asn?: (number | string)␊ - /**␊ - * The BGP peering address and BGP identifier of this BGP speaker.␊ - */␊ - bgpPeeringAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/connectionMonitors␊ - */␊ - export interface NetworkWatchersConnectionMonitors5 {␊ - name: string␊ - type: "Microsoft.Network/networkWatchers/connectionMonitors"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Connection monitor location.␊ - */␊ - location?: string␊ - /**␊ - * Connection monitor tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the connection monitor.␊ - */␊ - properties: (ConnectionMonitorParameters5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/flowLogs␊ - */␊ - export interface NetworkWatchersFlowLogs {␊ - name: string␊ - type: "Microsoft.Network/networkWatchers/flowLogs"␊ - apiVersion: "2019-11-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the flow log.␊ - */␊ - properties: (FlowLogPropertiesFormat | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/applicationGateways␊ - */␊ - export interface ApplicationGateways24 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * Identity for the resource.␊ - */␊ - identity?: (ManagedServiceIdentity10 | string)␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the application gateway.␊ - */␊ - name: string␊ - /**␊ - * Properties of the application gateway.␊ - */␊ - properties: (ApplicationGatewayPropertiesFormat24 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Network/applicationGateways"␊ - /**␊ - * A list of availability zones denoting where the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the resource.␊ - */␊ - export interface ManagedServiceIdentity10 {␊ - /**␊ - * The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.␊ - */␊ - type?: (("SystemAssigned" | "UserAssigned" | "SystemAssigned, UserAssigned" | "None") | string)␊ - /**␊ - * The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.␊ - */␊ - userAssignedIdentities?: ({␊ - [k: string]: Components1Jq1T4Ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - export interface Components1Jq1T4Ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application gateway.␊ - */␊ - export interface ApplicationGatewayPropertiesFormat24 {␊ - /**␊ - * Authentication certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - authenticationCertificates?: (ApplicationGatewayAuthenticationCertificate21[] | string)␊ - /**␊ - * Application Gateway autoscale configuration.␊ - */␊ - autoscaleConfiguration?: (ApplicationGatewayAutoscaleConfiguration14 | string)␊ - /**␊ - * Backend address pool of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - backendAddressPools?: (ApplicationGatewayBackendAddressPool24[] | string)␊ - /**␊ - * Backend http settings of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - backendHttpSettingsCollection?: (ApplicationGatewayBackendHttpSettings24[] | string)␊ - /**␊ - * Custom error configurations of the application gateway resource.␊ - */␊ - customErrorConfigurations?: (ApplicationGatewayCustomError11[] | string)␊ - /**␊ - * Whether FIPS is enabled on the application gateway resource.␊ - */␊ - enableFips?: (boolean | string)␊ - /**␊ - * Whether HTTP2 is enabled on the application gateway resource.␊ - */␊ - enableHttp2?: (boolean | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - firewallPolicy?: (SubResource32 | string)␊ - /**␊ - * Frontend IP addresses of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - frontendIPConfigurations?: (ApplicationGatewayFrontendIPConfiguration24[] | string)␊ - /**␊ - * Frontend ports of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - frontendPorts?: (ApplicationGatewayFrontendPort24[] | string)␊ - /**␊ - * Subnets of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - gatewayIPConfigurations?: (ApplicationGatewayIPConfiguration24[] | string)␊ - /**␊ - * Http listeners of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - httpListeners?: (ApplicationGatewayHttpListener24[] | string)␊ - /**␊ - * Probes of the application gateway resource.␊ - */␊ - probes?: (ApplicationGatewayProbe23[] | string)␊ - /**␊ - * Redirect configurations of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - redirectConfigurations?: (ApplicationGatewayRedirectConfiguration21[] | string)␊ - /**␊ - * Request routing rules of the application gateway resource.␊ - */␊ - requestRoutingRules?: (ApplicationGatewayRequestRoutingRule24[] | string)␊ - /**␊ - * Rewrite rules for the application gateway resource.␊ - */␊ - rewriteRuleSets?: (ApplicationGatewayRewriteRuleSet10[] | string)␊ - /**␊ - * SKU of an application gateway.␊ - */␊ - sku?: (ApplicationGatewaySku24 | string)␊ - /**␊ - * SSL certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - sslCertificates?: (ApplicationGatewaySslCertificate24[] | string)␊ - /**␊ - * Application Gateway Ssl policy.␊ - */␊ - sslPolicy?: (ApplicationGatewaySslPolicy21 | string)␊ - /**␊ - * Trusted Root certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - trustedRootCertificates?: (ApplicationGatewayTrustedRootCertificate11[] | string)␊ - /**␊ - * URL path map of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - urlPathMaps?: (ApplicationGatewayUrlPathMap23[] | string)␊ - /**␊ - * Application gateway web application firewall configuration.␊ - */␊ - webApplicationFirewallConfiguration?: (ApplicationGatewayWebApplicationFirewallConfiguration21 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authentication certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewayAuthenticationCertificate21 {␊ - /**␊ - * Name of the authentication certificate that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * Authentication certificates properties of an application gateway.␊ - */␊ - properties?: (ApplicationGatewayAuthenticationCertificatePropertiesFormat21 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authentication certificates properties of an application gateway.␊ - */␊ - export interface ApplicationGatewayAuthenticationCertificatePropertiesFormat21 {␊ - /**␊ - * Certificate public data.␊ - */␊ - data?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application Gateway autoscale configuration.␊ - */␊ - export interface ApplicationGatewayAutoscaleConfiguration14 {␊ - /**␊ - * Upper bound on number of Application Gateway capacity.␊ - */␊ - maxCapacity?: (number | string)␊ - /**␊ - * Lower bound on number of Application Gateway capacity.␊ - */␊ - minCapacity: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend Address Pool of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddressPool24 {␊ - /**␊ - * Name of the backend address pool that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * Properties of Backend Address Pool of an application gateway.␊ - */␊ - properties?: (ApplicationGatewayBackendAddressPoolPropertiesFormat24 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend Address Pool of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddressPoolPropertiesFormat24 {␊ - /**␊ - * Backend addresses.␊ - */␊ - backendAddresses?: (ApplicationGatewayBackendAddress24[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddress24 {␊ - /**␊ - * Fully qualified domain name (FQDN).␊ - */␊ - fqdn?: string␊ - /**␊ - * IP address.␊ - */␊ - ipAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address pool settings of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendHttpSettings24 {␊ - /**␊ - * Name of the backend http settings that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * Properties of Backend address pool settings of an application gateway.␊ - */␊ - properties?: (ApplicationGatewayBackendHttpSettingsPropertiesFormat24 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend address pool settings of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendHttpSettingsPropertiesFormat24 {␊ - /**␊ - * Cookie name to use for the affinity cookie.␊ - */␊ - affinityCookieName?: string␊ - /**␊ - * Array of references to application gateway authentication certificates.␊ - */␊ - authenticationCertificates?: (SubResource32[] | string)␊ - /**␊ - * Connection draining allows open connections to a backend server to be active for a specified time after the backend server got removed from the configuration.␊ - */␊ - connectionDraining?: (ApplicationGatewayConnectionDraining21 | string)␊ - /**␊ - * Cookie based affinity.␊ - */␊ - cookieBasedAffinity?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Host header to be sent to the backend servers.␊ - */␊ - hostName?: string␊ - /**␊ - * Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null.␊ - */␊ - path?: string␊ - /**␊ - * Whether to pick host header should be picked from the host name of the backend server. Default value is false.␊ - */␊ - pickHostNameFromBackendAddress?: (boolean | string)␊ - /**␊ - * The destination port on the backend.␊ - */␊ - port?: (number | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - probe?: (SubResource32 | string)␊ - /**␊ - * Whether the probe is enabled. Default value is false.␊ - */␊ - probeEnabled?: (boolean | string)␊ - /**␊ - * The protocol used to communicate with the backend.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Request timeout in seconds. Application Gateway will fail the request if response is not received within RequestTimeout. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - requestTimeout?: (number | string)␊ - /**␊ - * Array of references to application gateway trusted root certificates.␊ - */␊ - trustedRootCertificates?: (SubResource32[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Reference to another subresource.␊ - */␊ - export interface SubResource32 {␊ - /**␊ - * Resource ID.␊ - */␊ - id: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Connection draining allows open connections to a backend server to be active for a specified time after the backend server got removed from the configuration.␊ - */␊ - export interface ApplicationGatewayConnectionDraining21 {␊ - /**␊ - * The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds.␊ - */␊ - drainTimeoutInSec: (number | string)␊ - /**␊ - * Whether connection draining is enabled or not.␊ - */␊ - enabled: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Customer error of an application gateway.␊ - */␊ - export interface ApplicationGatewayCustomError11 {␊ - /**␊ - * Error page URL of the application gateway customer error.␊ - */␊ - customErrorPageUrl?: string␊ - /**␊ - * Status code of the application gateway customer error.␊ - */␊ - statusCode?: (("HttpStatus403" | "HttpStatus502") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendIPConfiguration24 {␊ - /**␊ - * Name of the frontend IP configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * Properties of Frontend IP configuration of an application gateway.␊ - */␊ - properties?: (ApplicationGatewayFrontendIPConfigurationPropertiesFormat24 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendIPConfigurationPropertiesFormat24 {␊ - /**␊ - * PrivateIPAddress of the network interface IP Configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The private IP address allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - publicIPAddress?: (SubResource32 | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - subnet?: (SubResource32 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend port of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendPort24 {␊ - /**␊ - * Name of the frontend port that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * Properties of Frontend port of an application gateway.␊ - */␊ - properties?: (ApplicationGatewayFrontendPortPropertiesFormat24 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend port of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendPortPropertiesFormat24 {␊ - /**␊ - * Frontend port.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed.␊ - */␊ - export interface ApplicationGatewayIPConfiguration24 {␊ - /**␊ - * Name of the IP configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * Properties of IP configuration of an application gateway.␊ - */␊ - properties?: (ApplicationGatewayIPConfigurationPropertiesFormat24 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayIPConfigurationPropertiesFormat24 {␊ - /**␊ - * Reference to another subresource.␊ - */␊ - subnet?: (SubResource32 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http listener of an application gateway.␊ - */␊ - export interface ApplicationGatewayHttpListener24 {␊ - /**␊ - * Name of the HTTP listener that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * Properties of HTTP listener of an application gateway.␊ - */␊ - properties?: (ApplicationGatewayHttpListenerPropertiesFormat24 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of HTTP listener of an application gateway.␊ - */␊ - export interface ApplicationGatewayHttpListenerPropertiesFormat24 {␊ - /**␊ - * Custom error configurations of the HTTP listener.␊ - */␊ - customErrorConfigurations?: (ApplicationGatewayCustomError11[] | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - firewallPolicy?: (SubResource32 | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - frontendIPConfiguration?: (SubResource32 | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - frontendPort?: (SubResource32 | string)␊ - /**␊ - * Host name of HTTP listener.␊ - */␊ - hostName?: string␊ - /**␊ - * List of Host names for HTTP Listener that allows special wildcard characters as well.␊ - */␊ - hostNames?: (string[] | string)␊ - /**␊ - * Protocol of the HTTP listener.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Applicable only if protocol is https. Enables SNI for multi-hosting.␊ - */␊ - requireServerNameIndication?: (boolean | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - sslCertificate?: (SubResource32 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Probe of the application gateway.␊ - */␊ - export interface ApplicationGatewayProbe23 {␊ - /**␊ - * Name of the probe that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * Properties of probe of an application gateway.␊ - */␊ - properties?: (ApplicationGatewayProbePropertiesFormat23 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of probe of an application gateway.␊ - */␊ - export interface ApplicationGatewayProbePropertiesFormat23 {␊ - /**␊ - * Host name to send the probe to.␊ - */␊ - host?: string␊ - /**␊ - * The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - interval?: (number | string)␊ - /**␊ - * Application gateway probe health response match.␊ - */␊ - match?: (ApplicationGatewayProbeHealthResponseMatch21 | string)␊ - /**␊ - * Minimum number of servers that are always marked healthy. Default value is 0.␊ - */␊ - minServers?: (number | string)␊ - /**␊ - * Relative path of probe. Valid path starts from '/'. Probe is sent to ://:.␊ - */␊ - path?: string␊ - /**␊ - * Whether the host header should be picked from the backend http settings. Default value is false.␊ - */␊ - pickHostNameFromBackendHttpSettings?: (boolean | string)␊ - /**␊ - * Custom port which will be used for probing the backend servers. The valid value ranges from 1 to 65535. In case not set, port from http settings will be used. This property is valid for Standard_v2 and WAF_v2 only.␊ - */␊ - port?: (number | string)␊ - /**␊ - * The protocol used for the probe.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * The probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - timeout?: (number | string)␊ - /**␊ - * The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20.␊ - */␊ - unhealthyThreshold?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application gateway probe health response match.␊ - */␊ - export interface ApplicationGatewayProbeHealthResponseMatch21 {␊ - /**␊ - * Body that must be contained in the health response. Default value is empty.␊ - */␊ - body?: string␊ - /**␊ - * Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399.␊ - */␊ - statusCodes?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Redirect configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayRedirectConfiguration21 {␊ - /**␊ - * Name of the redirect configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * Properties of redirect configuration of the application gateway.␊ - */␊ - properties?: (ApplicationGatewayRedirectConfigurationPropertiesFormat21 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of redirect configuration of the application gateway.␊ - */␊ - export interface ApplicationGatewayRedirectConfigurationPropertiesFormat21 {␊ - /**␊ - * Include path in the redirected url.␊ - */␊ - includePath?: (boolean | string)␊ - /**␊ - * Include query string in the redirected url.␊ - */␊ - includeQueryString?: (boolean | string)␊ - /**␊ - * Path rules specifying redirect configuration.␊ - */␊ - pathRules?: (SubResource32[] | string)␊ - /**␊ - * HTTP redirection type.␊ - */␊ - redirectType?: (("Permanent" | "Found" | "SeeOther" | "Temporary") | string)␊ - /**␊ - * Request routing specifying redirect configuration.␊ - */␊ - requestRoutingRules?: (SubResource32[] | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - targetListener?: (SubResource32 | string)␊ - /**␊ - * Url to redirect the request to.␊ - */␊ - targetUrl?: string␊ - /**␊ - * Url path maps specifying default redirect configuration.␊ - */␊ - urlPathMaps?: (SubResource32[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Request routing rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayRequestRoutingRule24 {␊ - /**␊ - * Name of the request routing rule that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * Properties of request routing rule of the application gateway.␊ - */␊ - properties?: (ApplicationGatewayRequestRoutingRulePropertiesFormat24 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of request routing rule of the application gateway.␊ - */␊ - export interface ApplicationGatewayRequestRoutingRulePropertiesFormat24 {␊ - /**␊ - * Reference to another subresource.␊ - */␊ - backendAddressPool?: (SubResource32 | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - backendHttpSettings?: (SubResource32 | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - httpListener?: (SubResource32 | string)␊ - /**␊ - * Priority of the request routing rule.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - redirectConfiguration?: (SubResource32 | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - rewriteRuleSet?: (SubResource32 | string)␊ - /**␊ - * Rule type.␊ - */␊ - ruleType?: (("Basic" | "PathBasedRouting") | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - urlPathMap?: (SubResource32 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Rewrite rule set of an application gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRuleSet10 {␊ - /**␊ - * Name of the rewrite rule set that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * Properties of rewrite rule set of the application gateway.␊ - */␊ - properties?: (ApplicationGatewayRewriteRuleSetPropertiesFormat10 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of rewrite rule set of the application gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRuleSetPropertiesFormat10 {␊ - /**␊ - * Rewrite rules in the rewrite rule set.␊ - */␊ - rewriteRules?: (ApplicationGatewayRewriteRule10[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Rewrite rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRule10 {␊ - /**␊ - * Set of actions in the Rewrite Rule in Application Gateway.␊ - */␊ - actionSet?: (ApplicationGatewayRewriteRuleActionSet10 | string)␊ - /**␊ - * Conditions based on which the action set execution will be evaluated.␊ - */␊ - conditions?: (ApplicationGatewayRewriteRuleCondition8[] | string)␊ - /**␊ - * Name of the rewrite rule that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet.␊ - */␊ - ruleSequence?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Set of actions in the Rewrite Rule in Application Gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRuleActionSet10 {␊ - /**␊ - * Request Header Actions in the Action Set.␊ - */␊ - requestHeaderConfigurations?: (ApplicationGatewayHeaderConfiguration10[] | string)␊ - /**␊ - * Response Header Actions in the Action Set.␊ - */␊ - responseHeaderConfigurations?: (ApplicationGatewayHeaderConfiguration10[] | string)␊ - /**␊ - * Url configuration of the Actions set in Application Gateway.␊ - */␊ - urlConfiguration?: (ApplicationGatewayUrlConfiguration1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Header configuration of the Actions set in Application Gateway.␊ - */␊ - export interface ApplicationGatewayHeaderConfiguration10 {␊ - /**␊ - * Header name of the header configuration.␊ - */␊ - headerName?: string␊ - /**␊ - * Header value of the header configuration.␊ - */␊ - headerValue?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Url configuration of the Actions set in Application Gateway.␊ - */␊ - export interface ApplicationGatewayUrlConfiguration1 {␊ - /**␊ - * Url path which user has provided for url rewrite. Null means no path will be updated. Default value is null.␊ - */␊ - modifiedPath?: string␊ - /**␊ - * Query string which user has provided for url rewrite. Null means no query string will be updated. Default value is null.␊ - */␊ - modifiedQueryString?: string␊ - /**␊ - * If set as true, it will re-evaluate the url path map provided in path based request routing rules using modified path. Default value is false.␊ - */␊ - reroute?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Set of conditions in the Rewrite Rule in Application Gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRuleCondition8 {␊ - /**␊ - * Setting this paramter to truth value with force the pattern to do a case in-sensitive comparison.␊ - */␊ - ignoreCase?: (boolean | string)␊ - /**␊ - * Setting this value as truth will force to check the negation of the condition given by the user.␊ - */␊ - negate?: (boolean | string)␊ - /**␊ - * The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition.␊ - */␊ - pattern?: string␊ - /**␊ - * The condition parameter of the RewriteRuleCondition.␊ - */␊ - variable?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of an application gateway.␊ - */␊ - export interface ApplicationGatewaySku24 {␊ - /**␊ - * Capacity (instance count) of an application gateway.␊ - */␊ - capacity?: (number | string)␊ - /**␊ - * Name of an application gateway SKU.␊ - */␊ - name?: (("Standard_Small" | "Standard_Medium" | "Standard_Large" | "WAF_Medium" | "WAF_Large" | "Standard_v2" | "WAF_v2") | string)␊ - /**␊ - * Tier of an application gateway.␊ - */␊ - tier?: (("Standard" | "WAF" | "Standard_v2" | "WAF_v2") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSL certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewaySslCertificate24 {␊ - /**␊ - * Name of the SSL certificate that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * Properties of SSL certificates of an application gateway.␊ - */␊ - properties?: (ApplicationGatewaySslCertificatePropertiesFormat24 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewaySslCertificatePropertiesFormat24 {␊ - /**␊ - * Base-64 encoded pfx certificate. Only applicable in PUT Request.␊ - */␊ - data?: string␊ - /**␊ - * Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault.␊ - */␊ - keyVaultSecretId?: string␊ - /**␊ - * Password for the pfx file specified in data. Only applicable in PUT request.␊ - */␊ - password?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application Gateway Ssl policy.␊ - */␊ - export interface ApplicationGatewaySslPolicy21 {␊ - /**␊ - * Ssl cipher suites to be enabled in the specified order to application gateway.␊ - */␊ - cipherSuites?: (("TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384" | "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256" | "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA" | "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA" | "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384" | "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256" | "TLS_DHE_RSA_WITH_AES_256_CBC_SHA" | "TLS_DHE_RSA_WITH_AES_128_CBC_SHA" | "TLS_RSA_WITH_AES_256_GCM_SHA384" | "TLS_RSA_WITH_AES_128_GCM_SHA256" | "TLS_RSA_WITH_AES_256_CBC_SHA256" | "TLS_RSA_WITH_AES_128_CBC_SHA256" | "TLS_RSA_WITH_AES_256_CBC_SHA" | "TLS_RSA_WITH_AES_128_CBC_SHA" | "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384" | "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256" | "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384" | "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256" | "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA" | "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA" | "TLS_DHE_DSS_WITH_AES_256_CBC_SHA256" | "TLS_DHE_DSS_WITH_AES_128_CBC_SHA256" | "TLS_DHE_DSS_WITH_AES_256_CBC_SHA" | "TLS_DHE_DSS_WITH_AES_128_CBC_SHA" | "TLS_RSA_WITH_3DES_EDE_CBC_SHA" | "TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA" | "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256" | "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384")[] | string)␊ - /**␊ - * Ssl protocols to be disabled on application gateway.␊ - */␊ - disabledSslProtocols?: (("TLSv1_0" | "TLSv1_1" | "TLSv1_2")[] | string)␊ - /**␊ - * Minimum version of Ssl protocol to be supported on application gateway.␊ - */␊ - minProtocolVersion?: (("TLSv1_0" | "TLSv1_1" | "TLSv1_2") | string)␊ - /**␊ - * Name of Ssl predefined policy.␊ - */␊ - policyName?: (("AppGwSslPolicy20150501" | "AppGwSslPolicy20170401" | "AppGwSslPolicy20170401S") | string)␊ - /**␊ - * Type of Ssl Policy.␊ - */␊ - policyType?: (("Predefined" | "Custom") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trusted Root certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewayTrustedRootCertificate11 {␊ - /**␊ - * Name of the trusted root certificate that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * Trusted Root certificates properties of an application gateway.␊ - */␊ - properties?: (ApplicationGatewayTrustedRootCertificatePropertiesFormat11 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trusted Root certificates properties of an application gateway.␊ - */␊ - export interface ApplicationGatewayTrustedRootCertificatePropertiesFormat11 {␊ - /**␊ - * Certificate public data.␊ - */␊ - data?: string␊ - /**␊ - * Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault.␊ - */␊ - keyVaultSecretId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * UrlPathMaps give a url path to the backend mapping information for PathBasedRouting.␊ - */␊ - export interface ApplicationGatewayUrlPathMap23 {␊ - /**␊ - * Name of the URL path map that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * Properties of UrlPathMap of the application gateway.␊ - */␊ - properties?: (ApplicationGatewayUrlPathMapPropertiesFormat23 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of UrlPathMap of the application gateway.␊ - */␊ - export interface ApplicationGatewayUrlPathMapPropertiesFormat23 {␊ - /**␊ - * Reference to another subresource.␊ - */␊ - defaultBackendAddressPool?: (SubResource32 | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - defaultBackendHttpSettings?: (SubResource32 | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - defaultRedirectConfiguration?: (SubResource32 | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - defaultRewriteRuleSet?: (SubResource32 | string)␊ - /**␊ - * Path rule of URL path map resource.␊ - */␊ - pathRules?: (ApplicationGatewayPathRule23[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Path rule of URL path map of an application gateway.␊ - */␊ - export interface ApplicationGatewayPathRule23 {␊ - /**␊ - * Name of the path rule that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * Properties of path rule of an application gateway.␊ - */␊ - properties?: (ApplicationGatewayPathRulePropertiesFormat23 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of path rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayPathRulePropertiesFormat23 {␊ - /**␊ - * Reference to another subresource.␊ - */␊ - backendAddressPool?: (SubResource32 | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - backendHttpSettings?: (SubResource32 | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - firewallPolicy?: (SubResource32 | string)␊ - /**␊ - * Path rules of URL path map.␊ - */␊ - paths?: (string[] | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - redirectConfiguration?: (SubResource32 | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - rewriteRuleSet?: (SubResource32 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application gateway web application firewall configuration.␊ - */␊ - export interface ApplicationGatewayWebApplicationFirewallConfiguration21 {␊ - /**␊ - * The disabled rule groups.␊ - */␊ - disabledRuleGroups?: (ApplicationGatewayFirewallDisabledRuleGroup21[] | string)␊ - /**␊ - * Whether the web application firewall is enabled or not.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * The exclusion list.␊ - */␊ - exclusions?: (ApplicationGatewayFirewallExclusion11[] | string)␊ - /**␊ - * Maximum file upload size in Mb for WAF.␊ - */␊ - fileUploadLimitInMb?: (number | string)␊ - /**␊ - * Web application firewall mode.␊ - */␊ - firewallMode: (("Detection" | "Prevention") | string)␊ - /**␊ - * Maximum request body size for WAF.␊ - */␊ - maxRequestBodySize?: (number | string)␊ - /**␊ - * Maximum request body size in Kb for WAF.␊ - */␊ - maxRequestBodySizeInKb?: (number | string)␊ - /**␊ - * Whether allow WAF to check request Body.␊ - */␊ - requestBodyCheck?: (boolean | string)␊ - /**␊ - * The type of the web application firewall rule set. Possible values are: 'OWASP'.␊ - */␊ - ruleSetType: string␊ - /**␊ - * The version of the rule set type.␊ - */␊ - ruleSetVersion: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allows to disable rules within a rule group or an entire rule group.␊ - */␊ - export interface ApplicationGatewayFirewallDisabledRuleGroup21 {␊ - /**␊ - * The name of the rule group that will be disabled.␊ - */␊ - ruleGroupName: string␊ - /**␊ - * The list of rules that will be disabled. If null, all rules of the rule group will be disabled.␊ - */␊ - rules?: (number[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allow to exclude some variable satisfy the condition for the WAF check.␊ - */␊ - export interface ApplicationGatewayFirewallExclusion11 {␊ - /**␊ - * The variable to be excluded.␊ - */␊ - matchVariable: string␊ - /**␊ - * When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to.␊ - */␊ - selector: string␊ - /**␊ - * When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to.␊ - */␊ - selectorMatchOperator: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies␊ - */␊ - export interface ApplicationGatewayWebApplicationFirewallPolicies8 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the policy.␊ - */␊ - name: string␊ - /**␊ - * Defines web application firewall policy properties.␊ - */␊ - properties: (WebApplicationFirewallPolicyPropertiesFormat8 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines web application firewall policy properties.␊ - */␊ - export interface WebApplicationFirewallPolicyPropertiesFormat8 {␊ - /**␊ - * The custom rules inside the policy.␊ - */␊ - customRules?: (WebApplicationFirewallCustomRule8[] | string)␊ - /**␊ - * Allow to exclude some variable satisfy the condition for the WAF check.␊ - */␊ - managedRules: (ManagedRulesDefinition3 | string)␊ - /**␊ - * Defines contents of a web application firewall global configuration.␊ - */␊ - policySettings?: (PolicySettings10 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines contents of a web application rule.␊ - */␊ - export interface WebApplicationFirewallCustomRule8 {␊ - /**␊ - * Type of Actions.␊ - */␊ - action: (("Allow" | "Block" | "Log") | string)␊ - /**␊ - * List of match conditions.␊ - */␊ - matchConditions: (MatchCondition10[] | string)␊ - /**␊ - * The name of the resource that is unique within a policy. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * Priority of the rule. Rules with a lower value will be evaluated before rules with a higher value.␊ - */␊ - priority: (number | string)␊ - /**␊ - * The rule type.␊ - */␊ - ruleType: (("MatchRule" | "Invalid") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Define match conditions.␊ - */␊ - export interface MatchCondition10 {␊ - /**␊ - * Match value.␊ - */␊ - matchValues: (string[] | string)␊ - /**␊ - * List of match variables.␊ - */␊ - matchVariables: (MatchVariable8[] | string)␊ - /**␊ - * Whether this is negate condition or not.␊ - */␊ - negationConditon?: (boolean | string)␊ - /**␊ - * The operator to be matched.␊ - */␊ - operator: (("IPMatch" | "Equal" | "Contains" | "LessThan" | "GreaterThan" | "LessThanOrEqual" | "GreaterThanOrEqual" | "BeginsWith" | "EndsWith" | "Regex" | "GeoMatch") | string)␊ - /**␊ - * List of transforms.␊ - */␊ - transforms?: (("Lowercase" | "Trim" | "UrlDecode" | "UrlEncode" | "RemoveNulls" | "HtmlEntityDecode")[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Define match variables.␊ - */␊ - export interface MatchVariable8 {␊ - /**␊ - * The selector of match variable.␊ - */␊ - selector?: string␊ - /**␊ - * Match Variable.␊ - */␊ - variableName: (("RemoteAddr" | "RequestMethod" | "QueryString" | "PostArgs" | "RequestUri" | "RequestHeaders" | "RequestBody" | "RequestCookies") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allow to exclude some variable satisfy the condition for the WAF check.␊ - */␊ - export interface ManagedRulesDefinition3 {␊ - /**␊ - * The Exclusions that are applied on the policy.␊ - */␊ - exclusions?: (OwaspCrsExclusionEntry3[] | string)␊ - /**␊ - * The managed rule sets that are associated with the policy.␊ - */␊ - managedRuleSets: (ManagedRuleSet5[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allow to exclude some variable satisfy the condition for the WAF check.␊ - */␊ - export interface OwaspCrsExclusionEntry3 {␊ - /**␊ - * The variable to be excluded.␊ - */␊ - matchVariable: (("RequestHeaderNames" | "RequestCookieNames" | "RequestArgNames") | string)␊ - /**␊ - * When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to.␊ - */␊ - selector: string␊ - /**␊ - * When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to.␊ - */␊ - selectorMatchOperator: (("Equals" | "Contains" | "StartsWith" | "EndsWith" | "EqualsAny") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines a managed rule set.␊ - */␊ - export interface ManagedRuleSet5 {␊ - /**␊ - * Defines the rule group overrides to apply to the rule set.␊ - */␊ - ruleGroupOverrides?: (ManagedRuleGroupOverride5[] | string)␊ - /**␊ - * Defines the rule set type to use.␊ - */␊ - ruleSetType: string␊ - /**␊ - * Defines the version of the rule set to use.␊ - */␊ - ruleSetVersion: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines a managed rule group override setting.␊ - */␊ - export interface ManagedRuleGroupOverride5 {␊ - /**␊ - * The managed rule group to override.␊ - */␊ - ruleGroupName: string␊ - /**␊ - * List of rules that will be disabled. If none specified, all rules in the group will be disabled.␊ - */␊ - rules?: (ManagedRuleOverride5[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines a managed rule group override setting.␊ - */␊ - export interface ManagedRuleOverride5 {␊ - /**␊ - * Identifier for the managed rule.␊ - */␊ - ruleId: string␊ - /**␊ - * The state of the managed rule. Defaults to Disabled if not specified.␊ - */␊ - state?: ("Disabled" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines contents of a web application firewall global configuration.␊ - */␊ - export interface PolicySettings10 {␊ - /**␊ - * Maximum file upload size in Mb for WAF.␊ - */␊ - fileUploadLimitInMb?: (number | string)␊ - /**␊ - * Maximum request body size in Kb for WAF.␊ - */␊ - maxRequestBodySizeInKb?: (number | string)␊ - /**␊ - * The mode of the policy.␊ - */␊ - mode?: (("Prevention" | "Detection") | string)␊ - /**␊ - * Whether to allow WAF to check request Body.␊ - */␊ - requestBodyCheck?: (boolean | string)␊ - /**␊ - * The state of the policy.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/applicationSecurityGroups␊ - */␊ - export interface ApplicationSecurityGroups19 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the application security group.␊ - */␊ - name: string␊ - /**␊ - * Application security group properties.␊ - */␊ - properties: (ApplicationSecurityGroupPropertiesFormat5 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Network/applicationSecurityGroups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application security group properties.␊ - */␊ - export interface ApplicationSecurityGroupPropertiesFormat5 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/azureFirewalls␊ - */␊ - export interface AzureFirewalls9 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the Azure Firewall.␊ - */␊ - name: string␊ - /**␊ - * Properties of the Azure Firewall.␊ - */␊ - properties: (AzureFirewallPropertiesFormat9 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Network/azureFirewalls"␊ - /**␊ - * A list of availability zones denoting where the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Azure Firewall.␊ - */␊ - export interface AzureFirewallPropertiesFormat9 {␊ - /**␊ - * The additional properties of azure firewall.␊ - */␊ - additionalProperties?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Collection of application rule collections used by Azure Firewall.␊ - */␊ - applicationRuleCollections?: (AzureFirewallApplicationRuleCollection9[] | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - firewallPolicy?: (SubResource32 | string)␊ - /**␊ - * IP configuration of the Azure Firewall resource.␊ - */␊ - ipConfigurations?: (AzureFirewallIPConfiguration9[] | string)␊ - /**␊ - * IP configuration of an Azure Firewall.␊ - */␊ - managementIpConfiguration?: (AzureFirewallIPConfiguration9 | string)␊ - /**␊ - * Collection of NAT rule collections used by Azure Firewall.␊ - */␊ - natRuleCollections?: (AzureFirewallNatRuleCollection6[] | string)␊ - /**␊ - * Collection of network rule collections used by Azure Firewall.␊ - */␊ - networkRuleCollections?: (AzureFirewallNetworkRuleCollection9[] | string)␊ - /**␊ - * SKU of an Azure Firewall.␊ - */␊ - sku?: (AzureFirewallSku3 | string)␊ - /**␊ - * The operation mode for Threat Intelligence.␊ - */␊ - threatIntelMode?: (("Alert" | "Deny" | "Off") | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - virtualHub?: (SubResource32 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application rule collection resource.␊ - */␊ - export interface AzureFirewallApplicationRuleCollection9 {␊ - /**␊ - * The name of the resource that is unique within the Azure firewall. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * Properties of the application rule collection.␊ - */␊ - properties?: (AzureFirewallApplicationRuleCollectionPropertiesFormat9 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application rule collection.␊ - */␊ - export interface AzureFirewallApplicationRuleCollectionPropertiesFormat9 {␊ - /**␊ - * Properties of the AzureFirewallRCAction.␊ - */␊ - action?: (AzureFirewallRCAction9 | string)␊ - /**␊ - * Priority of the application rule collection resource.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * Collection of rules used by a application rule collection.␊ - */␊ - rules?: (AzureFirewallApplicationRule9[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the AzureFirewallRCAction.␊ - */␊ - export interface AzureFirewallRCAction9 {␊ - /**␊ - * The type of action.␊ - */␊ - type?: (("Allow" | "Deny") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of an application rule.␊ - */␊ - export interface AzureFirewallApplicationRule9 {␊ - /**␊ - * Description of the rule.␊ - */␊ - description?: string␊ - /**␊ - * List of FQDN Tags for this rule.␊ - */␊ - fqdnTags?: (string[] | string)␊ - /**␊ - * Name of the application rule.␊ - */␊ - name?: string␊ - /**␊ - * Array of ApplicationRuleProtocols.␊ - */␊ - protocols?: (AzureFirewallApplicationRuleProtocol9[] | string)␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * List of source IpGroups for this rule.␊ - */␊ - sourceIpGroups?: (string[] | string)␊ - /**␊ - * List of FQDNs for this rule.␊ - */␊ - targetFqdns?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application rule protocol.␊ - */␊ - export interface AzureFirewallApplicationRuleProtocol9 {␊ - /**␊ - * Port number for the protocol, cannot be greater than 64000. This field is optional.␊ - */␊ - port?: (number | string)␊ - /**␊ - * Protocol type.␊ - */␊ - protocolType?: (("Http" | "Https" | "Mssql") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration of an Azure Firewall.␊ - */␊ - export interface AzureFirewallIPConfiguration9 {␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * Properties of IP configuration of an Azure Firewall.␊ - */␊ - properties?: (AzureFirewallIPConfigurationPropertiesFormat9 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration of an Azure Firewall.␊ - */␊ - export interface AzureFirewallIPConfigurationPropertiesFormat9 {␊ - /**␊ - * Reference to another subresource.␊ - */␊ - publicIPAddress?: (SubResource32 | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - subnet?: (SubResource32 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NAT rule collection resource.␊ - */␊ - export interface AzureFirewallNatRuleCollection6 {␊ - /**␊ - * The name of the resource that is unique within the Azure firewall. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * Properties of the NAT rule collection.␊ - */␊ - properties?: (AzureFirewallNatRuleCollectionProperties6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the NAT rule collection.␊ - */␊ - export interface AzureFirewallNatRuleCollectionProperties6 {␊ - /**␊ - * AzureFirewall NAT Rule Collection Action.␊ - */␊ - action?: (AzureFirewallNatRCAction6 | string)␊ - /**␊ - * Priority of the NAT rule collection resource.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * Collection of rules used by a NAT rule collection.␊ - */␊ - rules?: (AzureFirewallNatRule6[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AzureFirewall NAT Rule Collection Action.␊ - */␊ - export interface AzureFirewallNatRCAction6 {␊ - /**␊ - * The type of action.␊ - */␊ - type?: (("Snat" | "Dnat") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a NAT rule.␊ - */␊ - export interface AzureFirewallNatRule6 {␊ - /**␊ - * Description of the rule.␊ - */␊ - description?: string␊ - /**␊ - * List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags.␊ - */␊ - destinationAddresses?: (string[] | string)␊ - /**␊ - * List of destination ports.␊ - */␊ - destinationPorts?: (string[] | string)␊ - /**␊ - * Name of the NAT rule.␊ - */␊ - name?: string␊ - /**␊ - * Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule.␊ - */␊ - protocols?: (("TCP" | "UDP" | "Any" | "ICMP")[] | string)␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * List of source IpGroups for this rule.␊ - */␊ - sourceIpGroups?: (string[] | string)␊ - /**␊ - * The translated address for this NAT rule.␊ - */␊ - translatedAddress?: string␊ - /**␊ - * The translated FQDN for this NAT rule.␊ - */␊ - translatedFqdn?: string␊ - /**␊ - * The translated port for this NAT rule.␊ - */␊ - translatedPort?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network rule collection resource.␊ - */␊ - export interface AzureFirewallNetworkRuleCollection9 {␊ - /**␊ - * The name of the resource that is unique within the Azure firewall. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * Properties of the network rule collection.␊ - */␊ - properties?: (AzureFirewallNetworkRuleCollectionPropertiesFormat9 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the network rule collection.␊ - */␊ - export interface AzureFirewallNetworkRuleCollectionPropertiesFormat9 {␊ - /**␊ - * Properties of the AzureFirewallRCAction.␊ - */␊ - action?: (AzureFirewallRCAction9 | string)␊ - /**␊ - * Priority of the network rule collection resource.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * Collection of rules used by a network rule collection.␊ - */␊ - rules?: (AzureFirewallNetworkRule9[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the network rule.␊ - */␊ - export interface AzureFirewallNetworkRule9 {␊ - /**␊ - * Description of the rule.␊ - */␊ - description?: string␊ - /**␊ - * List of destination IP addresses.␊ - */␊ - destinationAddresses?: (string[] | string)␊ - /**␊ - * List of destination FQDNs.␊ - */␊ - destinationFqdns?: (string[] | string)␊ - /**␊ - * List of destination IpGroups for this rule.␊ - */␊ - destinationIpGroups?: (string[] | string)␊ - /**␊ - * List of destination ports.␊ - */␊ - destinationPorts?: (string[] | string)␊ - /**␊ - * Name of the network rule.␊ - */␊ - name?: string␊ - /**␊ - * Array of AzureFirewallNetworkRuleProtocols.␊ - */␊ - protocols?: (("TCP" | "UDP" | "Any" | "ICMP")[] | string)␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * List of source IpGroups for this rule.␊ - */␊ - sourceIpGroups?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of an Azure Firewall.␊ - */␊ - export interface AzureFirewallSku3 {␊ - /**␊ - * Name of an Azure Firewall SKU.␊ - */␊ - name?: (("AZFW_VNet" | "AZFW_Hub") | string)␊ - /**␊ - * Tier of an Azure Firewall.␊ - */␊ - tier?: ("Standard" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/bastionHosts␊ - */␊ - export interface BastionHosts6 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the Bastion Host.␊ - */␊ - name: string␊ - /**␊ - * Properties of the Bastion Host.␊ - */␊ - properties: (BastionHostPropertiesFormat6 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Network/bastionHosts"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Bastion Host.␊ - */␊ - export interface BastionHostPropertiesFormat6 {␊ - /**␊ - * FQDN for the endpoint on which bastion host is accessible.␊ - */␊ - dnsName?: string␊ - /**␊ - * IP configuration of the Bastion Host resource.␊ - */␊ - ipConfigurations?: (BastionHostIPConfiguration6[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration of an Bastion Host.␊ - */␊ - export interface BastionHostIPConfiguration6 {␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * Properties of IP configuration of an Bastion Host.␊ - */␊ - properties?: (BastionHostIPConfigurationPropertiesFormat6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration of an Bastion Host.␊ - */␊ - export interface BastionHostIPConfigurationPropertiesFormat6 {␊ - /**␊ - * Private IP allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - publicIPAddress: (SubResource32 | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - subnet: (SubResource32 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/connections␊ - */␊ - export interface Connections24 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the virtual network gateway connection.␊ - */␊ - name: string␊ - /**␊ - * VirtualNetworkGatewayConnection properties.␊ - */␊ - properties: (VirtualNetworkGatewayConnectionPropertiesFormat24 | string)␊ - resources?: ConnectionsSharedkeyChildResource[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Network/connections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewayConnection properties.␊ - */␊ - export interface VirtualNetworkGatewayConnectionPropertiesFormat24 {␊ - /**␊ - * The authorizationKey.␊ - */␊ - authorizationKey?: string␊ - /**␊ - * Connection protocol used for this connection.␊ - */␊ - connectionProtocol?: (("IKEv2" | "IKEv1") | string)␊ - /**␊ - * Gateway connection type.␊ - */␊ - connectionType: (("IPsec" | "Vnet2Vnet" | "ExpressRoute" | "VPNClient") | string)␊ - /**␊ - * EnableBgp flag.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * Bypass ExpressRoute Gateway for data forwarding.␊ - */␊ - expressRouteGatewayBypass?: (boolean | string)␊ - /**␊ - * The IPSec Policies to be considered by this connection.␊ - */␊ - ipsecPolicies?: (IpsecPolicy21[] | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - localNetworkGateway2?: (SubResource32 | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - peer?: (SubResource32 | string)␊ - /**␊ - * The routing weight.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * The IPSec shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The Traffic Selector Policies to be considered by this connection.␊ - */␊ - trafficSelectorPolicies?: (TrafficSelectorPolicy4[] | string)␊ - /**␊ - * Use private local Azure IP for the connection.␊ - */␊ - useLocalAzureIpAddress?: (boolean | string)␊ - /**␊ - * Enable policy-based traffic selectors.␊ - */␊ - usePolicyBasedTrafficSelectors?: (boolean | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - virtualNetworkGateway1: (SubResource32 | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - virtualNetworkGateway2?: (SubResource32 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An IPSec Policy configuration for a virtual network gateway connection.␊ - */␊ - export interface IpsecPolicy21 {␊ - /**␊ - * The DH Group used in IKE Phase 1 for initial SA.␊ - */␊ - dhGroup: (("None" | "DHGroup1" | "DHGroup2" | "DHGroup14" | "DHGroup2048" | "ECP256" | "ECP384" | "DHGroup24") | string)␊ - /**␊ - * The IKE encryption algorithm (IKE phase 2).␊ - */␊ - ikeEncryption: (("DES" | "DES3" | "AES128" | "AES192" | "AES256" | "GCMAES256" | "GCMAES128") | string)␊ - /**␊ - * The IKE integrity algorithm (IKE phase 2).␊ - */␊ - ikeIntegrity: (("MD5" | "SHA1" | "SHA256" | "SHA384" | "GCMAES256" | "GCMAES128") | string)␊ - /**␊ - * The IPSec encryption algorithm (IKE phase 1).␊ - */␊ - ipsecEncryption: (("None" | "DES" | "DES3" | "AES128" | "AES192" | "AES256" | "GCMAES128" | "GCMAES192" | "GCMAES256") | string)␊ - /**␊ - * The IPSec integrity algorithm (IKE phase 1).␊ - */␊ - ipsecIntegrity: (("MD5" | "SHA1" | "SHA256" | "GCMAES128" | "GCMAES192" | "GCMAES256") | string)␊ - /**␊ - * The Pfs Group used in IKE Phase 2 for new child SA.␊ - */␊ - pfsGroup: (("None" | "PFS1" | "PFS2" | "PFS2048" | "ECP256" | "ECP384" | "PFS24" | "PFS14" | "PFSMM") | string)␊ - /**␊ - * The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.␊ - */␊ - saDataSizeKilobytes: (number | string)␊ - /**␊ - * The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.␊ - */␊ - saLifeTimeSeconds: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An traffic selector policy for a virtual network gateway connection.␊ - */␊ - export interface TrafficSelectorPolicy4 {␊ - /**␊ - * A collection of local address spaces in CIDR format.␊ - */␊ - localAddressRanges: (string[] | string)␊ - /**␊ - * A collection of remote address spaces in CIDR format.␊ - */␊ - remoteAddressRanges: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/connections/sharedkey␊ - */␊ - export interface ConnectionsSharedkeyChildResource {␊ - apiVersion: "2019-12-01"␊ - name: "sharedkey"␊ - type: "sharedkey"␊ - /**␊ - * The virtual network connection shared key value.␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/connections/sharedkey␊ - */␊ - export interface ConnectionsSharedkey {␊ - apiVersion: "2019-12-01"␊ - name: string␊ - type: "Microsoft.Network/connections/sharedkey"␊ - /**␊ - * The virtual network connection shared key value.␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ddosCustomPolicies␊ - */␊ - export interface DdosCustomPolicies6 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the DDoS custom policy.␊ - */␊ - name: string␊ - /**␊ - * DDoS custom policy properties.␊ - */␊ - properties: (DdosCustomPolicyPropertiesFormat6 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Network/ddosCustomPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DDoS custom policy properties.␊ - */␊ - export interface DdosCustomPolicyPropertiesFormat6 {␊ - /**␊ - * The protocol-specific DDoS policy customization parameters.␊ - */␊ - protocolCustomSettings?: (ProtocolCustomSettingsFormat6[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DDoS custom policy properties.␊ - */␊ - export interface ProtocolCustomSettingsFormat6 {␊ - /**␊ - * The protocol for which the DDoS protection policy is being customized.␊ - */␊ - protocol?: (("Tcp" | "Udp" | "Syn") | string)␊ - /**␊ - * The customized DDoS protection source rate.␊ - */␊ - sourceRateOverride?: string␊ - /**␊ - * The customized DDoS protection trigger rate.␊ - */␊ - triggerRateOverride?: string␊ - /**␊ - * The customized DDoS protection trigger rate sensitivity degrees. High: Trigger rate set with most sensitivity w.r.t. normal traffic. Default: Trigger rate set with moderate sensitivity w.r.t. normal traffic. Low: Trigger rate set with less sensitivity w.r.t. normal traffic. Relaxed: Trigger rate set with least sensitivity w.r.t. normal traffic.␊ - */␊ - triggerSensitivityOverride?: (("Relaxed" | "Low" | "Default" | "High") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ddosProtectionPlans␊ - */␊ - export interface DdosProtectionPlans15 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the DDoS protection plan.␊ - */␊ - name: string␊ - /**␊ - * DDoS protection plan properties.␊ - */␊ - properties: (DdosProtectionPlanPropertiesFormat11 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Network/ddosProtectionPlans"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DDoS protection plan properties.␊ - */␊ - export interface DdosProtectionPlanPropertiesFormat11 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits␊ - */␊ - export interface ExpressRouteCircuits17 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the circuit.␊ - */␊ - name: string␊ - /**␊ - * Properties of ExpressRouteCircuit.␊ - */␊ - properties: (ExpressRouteCircuitPropertiesFormat17 | string)␊ - resources?: (ExpressRouteCircuitsAuthorizationsChildResource17 | ExpressRouteCircuitsPeeringsChildResource17)[]␊ - /**␊ - * Contains SKU in an ExpressRouteCircuit.␊ - */␊ - sku?: (ExpressRouteCircuitSku17 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Network/expressRouteCircuits"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitPropertiesFormat17 {␊ - /**␊ - * Allow classic operations.␊ - */␊ - allowClassicOperations?: (boolean | string)␊ - /**␊ - * The list of authorizations.␊ - */␊ - authorizations?: (ExpressRouteCircuitAuthorization17[] | string)␊ - /**␊ - * The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource.␊ - */␊ - bandwidthInGbps?: (number | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - expressRoutePort?: (SubResource32 | string)␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - /**␊ - * The list of peerings.␊ - */␊ - peerings?: (ExpressRouteCircuitPeering17[] | string)␊ - /**␊ - * The ServiceProviderNotes.␊ - */␊ - serviceProviderNotes?: string␊ - /**␊ - * Contains ServiceProviderProperties in an ExpressRouteCircuit.␊ - */␊ - serviceProviderProperties?: (ExpressRouteCircuitServiceProviderProperties17 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authorization in an ExpressRouteCircuit resource.␊ - */␊ - export interface ExpressRouteCircuitAuthorization17 {␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * Properties of ExpressRouteCircuitAuthorization.␊ - */␊ - properties?: (AuthorizationPropertiesFormat17 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ExpressRouteCircuitAuthorization.␊ - */␊ - export interface AuthorizationPropertiesFormat17 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peering in an ExpressRouteCircuit resource.␊ - */␊ - export interface ExpressRouteCircuitPeering17 {␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * Properties of the express route circuit peering.␊ - */␊ - properties?: (ExpressRouteCircuitPeeringPropertiesFormat18 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the express route circuit peering.␊ - */␊ - export interface ExpressRouteCircuitPeeringPropertiesFormat18 {␊ - /**␊ - * Reference to another subresource.␊ - */␊ - expressRouteConnection?: (SubResource32 | string)␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - /**␊ - * Contains IPv6 peering config.␊ - */␊ - ipv6PeeringConfig?: (Ipv6ExpressRouteCircuitPeeringConfig15 | string)␊ - /**␊ - * Specifies the peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig18 | string)␊ - /**␊ - * The peer ASN.␊ - */␊ - peerASN?: (number | string)␊ - /**␊ - * The peering type.␊ - */␊ - peeringType?: (("AzurePublicPeering" | "AzurePrivatePeering" | "MicrosoftPeering") | string)␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * Reference to another subresource.␊ - */␊ - routeFilter?: (SubResource32 | string)␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The peering state.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * Contains stats associated with the peering.␊ - */␊ - stats?: (ExpressRouteCircuitStats18 | string)␊ - /**␊ - * The VLAN ID.␊ - */␊ - vlanId?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains IPv6 peering config.␊ - */␊ - export interface Ipv6ExpressRouteCircuitPeeringConfig15 {␊ - /**␊ - * Specifies the peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig18 | string)␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * Reference to another subresource.␊ - */␊ - routeFilter?: (SubResource32 | string)␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The state of peering.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the peering configuration.␊ - */␊ - export interface ExpressRouteCircuitPeeringConfig18 {␊ - /**␊ - * The communities of bgp peering. Specified for microsoft peering.␊ - */␊ - advertisedCommunities?: (string[] | string)␊ - /**␊ - * The reference to AdvertisedPublicPrefixes.␊ - */␊ - advertisedPublicPrefixes?: (string[] | string)␊ - /**␊ - * The CustomerASN of the peering.␊ - */␊ - customerASN?: (number | string)␊ - /**␊ - * The legacy mode of the peering.␊ - */␊ - legacyMode?: (number | string)␊ - /**␊ - * The RoutingRegistryName of the configuration.␊ - */␊ - routingRegistryName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains stats associated with the peering.␊ - */␊ - export interface ExpressRouteCircuitStats18 {␊ - /**␊ - * The Primary BytesIn of the peering.␊ - */␊ - primarybytesIn?: (number | string)␊ - /**␊ - * The primary BytesOut of the peering.␊ - */␊ - primarybytesOut?: (number | string)␊ - /**␊ - * The secondary BytesIn of the peering.␊ - */␊ - secondarybytesIn?: (number | string)␊ - /**␊ - * The secondary BytesOut of the peering.␊ - */␊ - secondarybytesOut?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains ServiceProviderProperties in an ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitServiceProviderProperties17 {␊ - /**␊ - * The BandwidthInMbps.␊ - */␊ - bandwidthInMbps?: (number | string)␊ - /**␊ - * The peering location.␊ - */␊ - peeringLocation?: string␊ - /**␊ - * The serviceProviderName.␊ - */␊ - serviceProviderName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/authorizations␊ - */␊ - export interface ExpressRouteCircuitsAuthorizationsChildResource17 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * The name of the authorization.␊ - */␊ - name: string␊ - /**␊ - * Properties of ExpressRouteCircuitAuthorization.␊ - */␊ - properties: (AuthorizationPropertiesFormat17 | string)␊ - type: "authorizations"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings␊ - */␊ - export interface ExpressRouteCircuitsPeeringsChildResource17 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * The name of the peering.␊ - */␊ - name: string␊ - /**␊ - * Properties of the express route circuit peering.␊ - */␊ - properties: (ExpressRouteCircuitPeeringPropertiesFormat18 | string)␊ - type: "peerings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains SKU in an ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitSku17 {␊ - /**␊ - * The family of the SKU.␊ - */␊ - family?: (("UnlimitedData" | "MeteredData") | string)␊ - /**␊ - * The name of the SKU.␊ - */␊ - name?: string␊ - /**␊ - * The tier of the SKU.␊ - */␊ - tier?: (("Standard" | "Premium" | "Basic" | "Local") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/authorizations␊ - */␊ - export interface ExpressRouteCircuitsAuthorizations18 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * The name of the authorization.␊ - */␊ - name: string␊ - /**␊ - * Properties of ExpressRouteCircuitAuthorization.␊ - */␊ - properties: (AuthorizationPropertiesFormat17 | string)␊ - type: "Microsoft.Network/expressRouteCircuits/authorizations"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings␊ - */␊ - export interface ExpressRouteCircuitsPeerings18 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * The name of the peering.␊ - */␊ - name: string␊ - /**␊ - * Properties of the express route circuit peering.␊ - */␊ - properties: (ExpressRouteCircuitPeeringPropertiesFormat18 | string)␊ - resources?: ExpressRouteCircuitsPeeringsConnectionsChildResource15[]␊ - type: "Microsoft.Network/expressRouteCircuits/peerings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings/connections␊ - */␊ - export interface ExpressRouteCircuitsPeeringsConnectionsChildResource15 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * The name of the express route circuit connection.␊ - */␊ - name: string␊ - /**␊ - * Properties of the express route circuit connection.␊ - */␊ - properties: (ExpressRouteCircuitConnectionPropertiesFormat15 | string)␊ - type: "connections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the express route circuit connection.␊ - */␊ - export interface ExpressRouteCircuitConnectionPropertiesFormat15 {␊ - /**␊ - * /29 IP address space to carve out Customer addresses for tunnels.␊ - */␊ - addressPrefix?: string␊ - /**␊ - * The authorization key.␊ - */␊ - authorizationKey?: string␊ - /**␊ - * Reference to another subresource.␊ - */␊ - expressRouteCircuitPeering?: (SubResource32 | string)␊ - /**␊ - * IPv6 Circuit Connection properties for global reach.␊ - */␊ - ipv6CircuitConnectionConfig?: (Ipv6CircuitConnectionConfig | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - peerExpressRouteCircuitPeering?: (SubResource32 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IPv6 Circuit Connection properties for global reach.␊ - */␊ - export interface Ipv6CircuitConnectionConfig {␊ - /**␊ - * /125 IP address space to carve out customer addresses for global reach.␊ - */␊ - addressPrefix?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings/connections␊ - */␊ - export interface ExpressRouteCircuitsPeeringsConnections15 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * The name of the express route circuit connection.␊ - */␊ - name: string␊ - /**␊ - * Properties of the express route circuit connection.␊ - */␊ - properties: (ExpressRouteCircuitConnectionPropertiesFormat15 | string)␊ - type: "Microsoft.Network/expressRouteCircuits/peerings/connections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections␊ - */␊ - export interface ExpressRouteCrossConnections15 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the ExpressRouteCrossConnection.␊ - */␊ - name: string␊ - /**␊ - * Properties of ExpressRouteCrossConnection.␊ - */␊ - properties: (ExpressRouteCrossConnectionProperties15 | string)␊ - resources?: ExpressRouteCrossConnectionsPeeringsChildResource15[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Network/expressRouteCrossConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ExpressRouteCrossConnection.␊ - */␊ - export interface ExpressRouteCrossConnectionProperties15 {␊ - /**␊ - * The circuit bandwidth In Mbps.␊ - */␊ - bandwidthInMbps?: (number | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - expressRouteCircuit?: (SubResource32 | string)␊ - /**␊ - * The peering location of the ExpressRoute circuit.␊ - */␊ - peeringLocation?: string␊ - /**␊ - * The list of peerings.␊ - */␊ - peerings?: (ExpressRouteCrossConnectionPeering15[] | string)␊ - /**␊ - * Additional read only notes set by the connectivity provider.␊ - */␊ - serviceProviderNotes?: string␊ - /**␊ - * The provisioning state of the circuit in the connectivity provider system.␊ - */␊ - serviceProviderProvisioningState?: (("NotProvisioned" | "Provisioning" | "Provisioned" | "Deprovisioning") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peering in an ExpressRoute Cross Connection resource.␊ - */␊ - export interface ExpressRouteCrossConnectionPeering15 {␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * Properties of express route cross connection peering.␊ - */␊ - properties?: (ExpressRouteCrossConnectionPeeringProperties15 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of express route cross connection peering.␊ - */␊ - export interface ExpressRouteCrossConnectionPeeringProperties15 {␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - /**␊ - * Contains IPv6 peering config.␊ - */␊ - ipv6PeeringConfig?: (Ipv6ExpressRouteCircuitPeeringConfig15 | string)␊ - /**␊ - * Specifies the peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig18 | string)␊ - /**␊ - * The peer ASN.␊ - */␊ - peerASN?: (number | string)␊ - /**␊ - * The peering type.␊ - */␊ - peeringType?: (("AzurePublicPeering" | "AzurePrivatePeering" | "MicrosoftPeering") | string)␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The peering state.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * The VLAN ID.␊ - */␊ - vlanId?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections/peerings␊ - */␊ - export interface ExpressRouteCrossConnectionsPeeringsChildResource15 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * The name of the peering.␊ - */␊ - name: string␊ - /**␊ - * Properties of express route cross connection peering.␊ - */␊ - properties: (ExpressRouteCrossConnectionPeeringProperties15 | string)␊ - type: "peerings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections/peerings␊ - */␊ - export interface ExpressRouteCrossConnectionsPeerings15 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * The name of the peering.␊ - */␊ - name: string␊ - /**␊ - * Properties of express route cross connection peering.␊ - */␊ - properties: (ExpressRouteCrossConnectionPeeringProperties15 | string)␊ - type: "Microsoft.Network/expressRouteCrossConnections/peerings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteGateways␊ - */␊ - export interface ExpressRouteGateways6 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the ExpressRoute gateway.␊ - */␊ - name: string␊ - /**␊ - * ExpressRoute gateway resource properties.␊ - */␊ - properties: (ExpressRouteGatewayProperties6 | string)␊ - resources?: ExpressRouteGatewaysExpressRouteConnectionsChildResource6[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Network/expressRouteGateways"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ExpressRoute gateway resource properties.␊ - */␊ - export interface ExpressRouteGatewayProperties6 {␊ - /**␊ - * Configuration for auto scaling.␊ - */␊ - autoScaleConfiguration?: (ExpressRouteGatewayPropertiesAutoScaleConfiguration6 | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - virtualHub: (SubResource32 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Configuration for auto scaling.␊ - */␊ - export interface ExpressRouteGatewayPropertiesAutoScaleConfiguration6 {␊ - /**␊ - * Minimum and maximum number of scale units to deploy.␊ - */␊ - bounds?: (ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Minimum and maximum number of scale units to deploy.␊ - */␊ - export interface ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds6 {␊ - /**␊ - * Maximum number of scale units deployed for ExpressRoute gateway.␊ - */␊ - max?: (number | string)␊ - /**␊ - * Minimum number of scale units deployed for ExpressRoute gateway.␊ - */␊ - min?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteGateways/expressRouteConnections␊ - */␊ - export interface ExpressRouteGatewaysExpressRouteConnectionsChildResource6 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * The name of the connection subresource.␊ - */␊ - name: string␊ - /**␊ - * Properties of the ExpressRouteConnection subresource.␊ - */␊ - properties: (ExpressRouteConnectionProperties6 | string)␊ - type: "expressRouteConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the ExpressRouteConnection subresource.␊ - */␊ - export interface ExpressRouteConnectionProperties6 {␊ - /**␊ - * Authorization key to establish the connection.␊ - */␊ - authorizationKey?: string␊ - /**␊ - * Enable internet security.␊ - */␊ - enableInternetSecurity?: (boolean | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - expressRouteCircuitPeering: (SubResource32 | string)␊ - /**␊ - * The routing weight associated to the connection.␊ - */␊ - routingWeight?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteGateways/expressRouteConnections␊ - */␊ - export interface ExpressRouteGatewaysExpressRouteConnections6 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * The name of the connection subresource.␊ - */␊ - name: string␊ - /**␊ - * Properties of the ExpressRouteConnection subresource.␊ - */␊ - properties: (ExpressRouteConnectionProperties6 | string)␊ - type: "Microsoft.Network/expressRouteGateways/expressRouteConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ExpressRoutePorts␊ - */␊ - export interface ExpressRoutePorts11 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * Identity for the resource.␊ - */␊ - identity?: (ManagedServiceIdentity10 | string)␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the ExpressRoutePort resource.␊ - */␊ - name: string␊ - /**␊ - * Properties specific to ExpressRoutePort resources.␊ - */␊ - properties: (ExpressRoutePortPropertiesFormat11 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Network/ExpressRoutePorts"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to ExpressRoutePort resources.␊ - */␊ - export interface ExpressRoutePortPropertiesFormat11 {␊ - /**␊ - * Bandwidth of procured ports in Gbps.␊ - */␊ - bandwidthInGbps?: (number | string)␊ - /**␊ - * Encapsulation method on physical ports.␊ - */␊ - encapsulation?: (("Dot1Q" | "QinQ") | string)␊ - /**␊ - * The set of physical links of the ExpressRoutePort resource.␊ - */␊ - links?: (ExpressRouteLink11[] | string)␊ - /**␊ - * The name of the peering location that the ExpressRoutePort is mapped to physically.␊ - */␊ - peeringLocation?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ExpressRouteLink child resource definition.␊ - */␊ - export interface ExpressRouteLink11 {␊ - /**␊ - * Name of child port resource that is unique among child port resources of the parent.␊ - */␊ - name?: string␊ - /**␊ - * Properties specific to ExpressRouteLink resources.␊ - */␊ - properties?: (ExpressRouteLinkPropertiesFormat11 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to ExpressRouteLink resources.␊ - */␊ - export interface ExpressRouteLinkPropertiesFormat11 {␊ - /**␊ - * Administrative state of the physical port.␊ - */␊ - adminState?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * ExpressRouteLink Mac Security Configuration.␊ - */␊ - macSecConfig?: (ExpressRouteLinkMacSecConfig4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ExpressRouteLink Mac Security Configuration.␊ - */␊ - export interface ExpressRouteLinkMacSecConfig4 {␊ - /**␊ - * Keyvault Secret Identifier URL containing Mac security CAK key.␊ - */␊ - cakSecretIdentifier?: string␊ - /**␊ - * Mac security cipher.␊ - */␊ - cipher?: (("gcm-aes-128" | "gcm-aes-256") | string)␊ - /**␊ - * Keyvault Secret Identifier URL containing Mac security CKN key.␊ - */␊ - cknSecretIdentifier?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/firewallPolicies␊ - */␊ - export interface FirewallPolicies5 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the Firewall Policy.␊ - */␊ - name: string␊ - /**␊ - * Firewall Policy definition.␊ - */␊ - properties: (FirewallPolicyPropertiesFormat5 | string)␊ - resources?: FirewallPoliciesRuleGroupsChildResource5[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Network/firewallPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Firewall Policy definition.␊ - */␊ - export interface FirewallPolicyPropertiesFormat5 {␊ - /**␊ - * Reference to another subresource.␊ - */␊ - basePolicy?: (SubResource32 | string)␊ - /**␊ - * The operation mode for Threat Intelligence.␊ - */␊ - threatIntelMode?: (("Alert" | "Deny" | "Off") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/firewallPolicies/ruleGroups␊ - */␊ - export interface FirewallPoliciesRuleGroupsChildResource5 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * The name of the FirewallPolicyRuleGroup.␊ - */␊ - name: string␊ - /**␊ - * Properties of the rule group.␊ - */␊ - properties: (FirewallPolicyRuleGroupProperties5 | string)␊ - type: "ruleGroups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the rule group.␊ - */␊ - export interface FirewallPolicyRuleGroupProperties5 {␊ - /**␊ - * Priority of the Firewall Policy Rule Group resource.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * Group of Firewall Policy rules.␊ - */␊ - rules?: (FirewallPolicyRule5[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Firewall Policy NAT Rule.␊ - */␊ - export interface FirewallPolicyNatRule5 {␊ - /**␊ - * Properties of the FirewallPolicyNatRuleAction.␊ - */␊ - action?: (FirewallPolicyNatRuleAction5 | string)␊ - /**␊ - * Properties of a rule.␊ - */␊ - ruleCondition?: (FirewallPolicyRuleCondition5 | string)␊ - ruleType: "FirewallPolicyNatRule"␊ - /**␊ - * The translated address for this NAT rule.␊ - */␊ - translatedAddress?: string␊ - /**␊ - * The translated port for this NAT rule.␊ - */␊ - translatedPort?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the FirewallPolicyNatRuleAction.␊ - */␊ - export interface FirewallPolicyNatRuleAction5 {␊ - /**␊ - * The type of action.␊ - */␊ - type?: ("DNAT" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Rule condition of type application.␊ - */␊ - export interface ApplicationRuleCondition5 {␊ - /**␊ - * List of destination IP addresses or Service Tags.␊ - */␊ - destinationAddresses?: (string[] | string)␊ - /**␊ - * List of FQDN Tags for this rule condition.␊ - */␊ - fqdnTags?: (string[] | string)␊ - /**␊ - * Array of Application Protocols.␊ - */␊ - protocols?: (FirewallPolicyRuleConditionApplicationProtocol5[] | string)␊ - ruleConditionType: "ApplicationRuleCondition"␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * List of source IpGroups for this rule.␊ - */␊ - sourceIpGroups?: (string[] | string)␊ - /**␊ - * List of FQDNs for this rule condition.␊ - */␊ - targetFqdns?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application rule protocol.␊ - */␊ - export interface FirewallPolicyRuleConditionApplicationProtocol5 {␊ - /**␊ - * Port number for the protocol, cannot be greater than 64000.␊ - */␊ - port?: (number | string)␊ - /**␊ - * Protocol type.␊ - */␊ - protocolType?: (("Http" | "Https") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Rule condition of type nat.␊ - */␊ - export interface NatRuleCondition {␊ - /**␊ - * List of destination IP addresses or Service Tags.␊ - */␊ - destinationAddresses?: (string[] | string)␊ - /**␊ - * List of destination ports.␊ - */␊ - destinationPorts?: (string[] | string)␊ - /**␊ - * Array of FirewallPolicyRuleConditionNetworkProtocols.␊ - */␊ - ipProtocols?: (("TCP" | "UDP" | "Any" | "ICMP")[] | string)␊ - ruleConditionType: "NatRuleCondition"␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * List of source IpGroups for this rule.␊ - */␊ - sourceIpGroups?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Rule condition of type network.␊ - */␊ - export interface NetworkRuleCondition5 {␊ - /**␊ - * List of destination IP addresses or Service Tags.␊ - */␊ - destinationAddresses?: (string[] | string)␊ - /**␊ - * List of destination IpGroups for this rule.␊ - */␊ - destinationIpGroups?: (string[] | string)␊ - /**␊ - * List of destination ports.␊ - */␊ - destinationPorts?: (string[] | string)␊ - /**␊ - * Array of FirewallPolicyRuleConditionNetworkProtocols.␊ - */␊ - ipProtocols?: (("TCP" | "UDP" | "Any" | "ICMP")[] | string)␊ - ruleConditionType: "NetworkRuleCondition"␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * List of source IpGroups for this rule.␊ - */␊ - sourceIpGroups?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Firewall Policy Filter Rule.␊ - */␊ - export interface FirewallPolicyFilterRule5 {␊ - /**␊ - * Properties of the FirewallPolicyFilterRuleAction.␊ - */␊ - action?: (FirewallPolicyFilterRuleAction5 | string)␊ - /**␊ - * Collection of rule conditions used by a rule.␊ - */␊ - ruleConditions?: ((ApplicationRuleCondition5 | NatRuleCondition | NetworkRuleCondition5)[] | string)␊ - ruleType: "FirewallPolicyFilterRule"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the FirewallPolicyFilterRuleAction.␊ - */␊ - export interface FirewallPolicyFilterRuleAction5 {␊ - /**␊ - * The type of action.␊ - */␊ - type?: (("Allow" | "Deny") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/firewallPolicies/ruleGroups␊ - */␊ - export interface FirewallPoliciesRuleGroups5 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * The name of the FirewallPolicyRuleGroup.␊ - */␊ - name: string␊ - /**␊ - * Properties of the rule group.␊ - */␊ - properties: (FirewallPolicyRuleGroupProperties5 | string)␊ - type: "Microsoft.Network/firewallPolicies/ruleGroups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ipGroups␊ - */␊ - export interface IpGroups2 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the ipGroups.␊ - */␊ - name: string␊ - /**␊ - * The IpGroups property information.␊ - */␊ - properties: (IpGroupPropertiesFormat2 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Network/ipGroups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The IpGroups property information.␊ - */␊ - export interface IpGroupPropertiesFormat2 {␊ - /**␊ - * IpAddresses/IpAddressPrefixes in the IpGroups resource.␊ - */␊ - ipAddresses?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers␊ - */␊ - export interface LoadBalancers32 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the load balancer.␊ - */␊ - name: string␊ - /**␊ - * Properties of the load balancer.␊ - */␊ - properties: (LoadBalancerPropertiesFormat24 | string)␊ - resources?: LoadBalancersInboundNatRulesChildResource20[]␊ - /**␊ - * SKU of a load balancer.␊ - */␊ - sku?: (LoadBalancerSku20 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Network/loadBalancers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer.␊ - */␊ - export interface LoadBalancerPropertiesFormat24 {␊ - /**␊ - * Collection of backend address pools used by a load balancer.␊ - */␊ - backendAddressPools?: (BackendAddressPool24[] | string)␊ - /**␊ - * Object representing the frontend IPs to be used for the load balancer.␊ - */␊ - frontendIPConfigurations?: (FrontendIPConfiguration23[] | string)␊ - /**␊ - * Defines an external port range for inbound NAT to a single backend port on NICs associated with a load balancer. Inbound NAT rules are created automatically for each NIC associated with the Load Balancer using an external port from this range. Defining an Inbound NAT pool on your Load Balancer is mutually exclusive with defining inbound Nat rules. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an inbound NAT pool. They have to reference individual inbound NAT rules.␊ - */␊ - inboundNatPools?: (InboundNatPool25[] | string)␊ - /**␊ - * Collection of inbound NAT Rules used by a load balancer. Defining inbound NAT rules on your load balancer is mutually exclusive with defining an inbound NAT pool. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an Inbound NAT pool. They have to reference individual inbound NAT rules.␊ - */␊ - inboundNatRules?: (InboundNatRule25[] | string)␊ - /**␊ - * Object collection representing the load balancing rules Gets the provisioning.␊ - */␊ - loadBalancingRules?: (LoadBalancingRule24[] | string)␊ - /**␊ - * The outbound rules.␊ - */␊ - outboundRules?: (OutboundRule12[] | string)␊ - /**␊ - * Collection of probe objects used in the load balancer.␊ - */␊ - probes?: (Probe24[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Pool of backend IP addresses.␊ - */␊ - export interface BackendAddressPool24 {␊ - /**␊ - * The name of the resource that is unique within the set of backend address pools used by the load balancer. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * Properties of the backend address pool.␊ - */␊ - properties?: (BackendAddressPoolPropertiesFormat23 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the backend address pool.␊ - */␊ - export interface BackendAddressPoolPropertiesFormat23 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP address of the load balancer.␊ - */␊ - export interface FrontendIPConfiguration23 {␊ - /**␊ - * The name of the resource that is unique within the set of frontend IP configurations used by the load balancer. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * Properties of Frontend IP Configuration of the load balancer.␊ - */␊ - properties?: (FrontendIPConfigurationPropertiesFormat23 | string)␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP Configuration of the load balancer.␊ - */␊ - export interface FrontendIPConfigurationPropertiesFormat23 {␊ - /**␊ - * The private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * Whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4.␊ - */␊ - privateIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The Private IP allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - publicIPAddress?: (SubResource32 | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - publicIPPrefix?: (SubResource32 | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - subnet?: (SubResource32 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT pool of the load balancer.␊ - */␊ - export interface InboundNatPool25 {␊ - /**␊ - * The name of the resource that is unique within the set of inbound NAT pools used by the load balancer. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * Properties of Inbound NAT pool.␊ - */␊ - properties?: (InboundNatPoolPropertiesFormat24 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Inbound NAT pool.␊ - */␊ - export interface InboundNatPoolPropertiesFormat24 {␊ - /**␊ - * The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - frontendIPConfiguration: (SubResource32 | string)␊ - /**␊ - * The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65535.␊ - */␊ - frontendPortRangeEnd: (number | string)␊ - /**␊ - * The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65534.␊ - */␊ - frontendPortRangeStart: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * The reference to the transport protocol used by the inbound NAT pool.␊ - */␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT rule of the load balancer.␊ - */␊ - export interface InboundNatRule25 {␊ - /**␊ - * The name of the resource that is unique within the set of inbound NAT rules used by the load balancer. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * Properties of the inbound NAT rule.␊ - */␊ - properties?: (InboundNatRulePropertiesFormat24 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the inbound NAT rule.␊ - */␊ - export interface InboundNatRulePropertiesFormat24 {␊ - /**␊ - * The port used for the internal endpoint. Acceptable values range from 1 to 65535.␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - frontendIPConfiguration: (SubResource32 | string)␊ - /**␊ - * The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values range from 1 to 65534.␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * The reference to the transport protocol used by the load balancing rule.␊ - */␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A load balancing rule for a load balancer.␊ - */␊ - export interface LoadBalancingRule24 {␊ - /**␊ - * The name of the resource that is unique within the set of load balancing rules used by the load balancer. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * Properties of the load balancer.␊ - */␊ - properties?: (LoadBalancingRulePropertiesFormat24 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer.␊ - */␊ - export interface LoadBalancingRulePropertiesFormat24 {␊ - /**␊ - * Reference to another subresource.␊ - */␊ - backendAddressPool?: (SubResource32 | string)␊ - /**␊ - * The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port".␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule.␊ - */␊ - disableOutboundSnat?: (boolean | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - frontendIPConfiguration: (SubResource32 | string)␊ - /**␊ - * The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 0 and 65534. Note that value 0 enables "Any Port".␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * The load distribution policy for this rule.␊ - */␊ - loadDistribution?: (("Default" | "SourceIP" | "SourceIPProtocol") | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - probe?: (SubResource32 | string)␊ - /**␊ - * The reference to the transport protocol used by the load balancing rule.␊ - */␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound rule of the load balancer.␊ - */␊ - export interface OutboundRule12 {␊ - /**␊ - * The name of the resource that is unique within the set of outbound rules used by the load balancer. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * Outbound rule of the load balancer.␊ - */␊ - properties?: (OutboundRulePropertiesFormat12 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound rule of the load balancer.␊ - */␊ - export interface OutboundRulePropertiesFormat12 {␊ - /**␊ - * The number of outbound ports to be used for NAT.␊ - */␊ - allocatedOutboundPorts?: (number | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - backendAddressPool: (SubResource32 | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - /**␊ - * The Frontend IP addresses of the load balancer.␊ - */␊ - frontendIPConfigurations: (SubResource32[] | string)␊ - /**␊ - * The timeout for the TCP idle connection.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * The protocol for the outbound rule in load balancer.␊ - */␊ - protocol: (("Tcp" | "Udp" | "All") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A load balancer probe.␊ - */␊ - export interface Probe24 {␊ - /**␊ - * The name of the resource that is unique within the set of probes used by the load balancer. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * Load balancer probe resource.␊ - */␊ - properties?: (ProbePropertiesFormat24 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Load balancer probe resource.␊ - */␊ - export interface ProbePropertiesFormat24 {␊ - /**␊ - * The interval, in seconds, for how frequently to probe the endpoint for health status. Typically, the interval is slightly less than half the allocated timeout period (in seconds) which allows two full probes before taking the instance out of rotation. The default value is 15, the minimum value is 5.␊ - */␊ - intervalInSeconds?: (number | string)␊ - /**␊ - * The number of probes where if no response, will result in stopping further traffic from being delivered to the endpoint. This values allows endpoints to be taken out of rotation faster or slower than the typical times used in Azure.␊ - */␊ - numberOfProbes: (number | string)␊ - /**␊ - * The port for communicating the probe. Possible values range from 1 to 65535, inclusive.␊ - */␊ - port: (number | string)␊ - /**␊ - * The protocol of the end point. If 'Tcp' is specified, a received ACK is required for the probe to be successful. If 'Http' or 'Https' is specified, a 200 OK response from the specifies URI is required for the probe to be successful.␊ - */␊ - protocol: (("Http" | "Tcp" | "Https") | string)␊ - /**␊ - * The URI used for requesting health status from the VM. Path is required if a protocol is set to http. Otherwise, it is not allowed. There is no default value.␊ - */␊ - requestPath?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers/inboundNatRules␊ - */␊ - export interface LoadBalancersInboundNatRulesChildResource20 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * The name of the inbound nat rule.␊ - */␊ - name: string␊ - /**␊ - * Properties of the inbound NAT rule.␊ - */␊ - properties: (InboundNatRulePropertiesFormat24 | string)␊ - type: "inboundNatRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a load balancer.␊ - */␊ - export interface LoadBalancerSku20 {␊ - /**␊ - * Name of a load balancer SKU.␊ - */␊ - name?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers/inboundNatRules␊ - */␊ - export interface LoadBalancersInboundNatRules20 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * The name of the inbound nat rule.␊ - */␊ - name: string␊ - /**␊ - * Properties of the inbound NAT rule.␊ - */␊ - properties: (InboundNatRulePropertiesFormat24 | string)␊ - type: "Microsoft.Network/loadBalancers/inboundNatRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/localNetworkGateways␊ - */␊ - export interface LocalNetworkGateways24 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the local network gateway.␊ - */␊ - name: string␊ - /**␊ - * LocalNetworkGateway properties.␊ - */␊ - properties: (LocalNetworkGatewayPropertiesFormat24 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Network/localNetworkGateways"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * LocalNetworkGateway properties.␊ - */␊ - export interface LocalNetworkGatewayPropertiesFormat24 {␊ - /**␊ - * BGP settings details.␊ - */␊ - bgpSettings?: (BgpSettings23 | string)␊ - /**␊ - * FQDN of local network gateway.␊ - */␊ - fqdn?: string␊ - /**␊ - * IP address of local network gateway.␊ - */␊ - gatewayIpAddress?: string␊ - /**␊ - * AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.␊ - */␊ - localNetworkAddressSpace?: (AddressSpace32 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * BGP settings details.␊ - */␊ - export interface BgpSettings23 {␊ - /**␊ - * The BGP speaker's ASN.␊ - */␊ - asn?: (number | string)␊ - /**␊ - * The BGP peering address and BGP identifier of this BGP speaker.␊ - */␊ - bgpPeeringAddress?: string␊ - /**␊ - * BGP peering address with IP configuration ID for virtual network gateway.␊ - */␊ - bgpPeeringAddresses?: (IPConfigurationBgpPeeringAddress[] | string)␊ - /**␊ - * The weight added to routes learned from this BGP speaker.␊ - */␊ - peerWeight?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IPConfigurationBgpPeeringAddress.␊ - */␊ - export interface IPConfigurationBgpPeeringAddress {␊ - /**␊ - * The list of custom BGP peering addresses which belong to IP configuration.␊ - */␊ - customBgpIpAddresses?: (string[] | string)␊ - /**␊ - * The ID of IP configuration which belongs to gateway.␊ - */␊ - ipconfigurationId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.␊ - */␊ - export interface AddressSpace32 {␊ - /**␊ - * A list of address blocks reserved for this virtual network in CIDR notation.␊ - */␊ - addressPrefixes: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/natGateways␊ - */␊ - export interface NatGateways7 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the nat gateway.␊ - */␊ - name: string␊ - /**␊ - * Nat Gateway properties.␊ - */␊ - properties: (NatGatewayPropertiesFormat7 | string)␊ - /**␊ - * SKU of nat gateway.␊ - */␊ - sku?: (NatGatewaySku7 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Network/natGateways"␊ - /**␊ - * A list of availability zones denoting the zone in which Nat Gateway should be deployed.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Nat Gateway properties.␊ - */␊ - export interface NatGatewayPropertiesFormat7 {␊ - /**␊ - * The idle timeout of the nat gateway.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * An array of public ip addresses associated with the nat gateway resource.␊ - */␊ - publicIpAddresses?: (SubResource32[] | string)␊ - /**␊ - * An array of public ip prefixes associated with the nat gateway resource.␊ - */␊ - publicIpPrefixes?: (SubResource32[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of nat gateway.␊ - */␊ - export interface NatGatewaySku7 {␊ - /**␊ - * Name of Nat Gateway SKU.␊ - */␊ - name?: ("Standard" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces␊ - */␊ - export interface NetworkInterfaces33 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the network interface.␊ - */␊ - name: string␊ - /**␊ - * NetworkInterface properties.␊ - */␊ - properties: (NetworkInterfacePropertiesFormat24 | string)␊ - resources?: NetworkInterfacesTapConfigurationsChildResource11[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Network/networkInterfaces"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NetworkInterface properties.␊ - */␊ - export interface NetworkInterfacePropertiesFormat24 {␊ - /**␊ - * DNS settings of a network interface.␊ - */␊ - dnsSettings?: (NetworkInterfaceDnsSettings32 | string)␊ - /**␊ - * If the network interface is accelerated networking enabled.␊ - */␊ - enableAcceleratedNetworking?: (boolean | string)␊ - /**␊ - * Indicates whether IP forwarding is enabled on this network interface.␊ - */␊ - enableIPForwarding?: (boolean | string)␊ - /**␊ - * A list of IPConfigurations of the network interface.␊ - */␊ - ipConfigurations: (NetworkInterfaceIPConfiguration23[] | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - networkSecurityGroup?: (SubResource32 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DNS settings of a network interface.␊ - */␊ - export interface NetworkInterfaceDnsSettings32 {␊ - /**␊ - * List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only value in dnsServers collection.␊ - */␊ - dnsServers?: (string[] | string)␊ - /**␊ - * Relative DNS name for this NIC used for internal communications between VMs in the same virtual network.␊ - */␊ - internalDnsNameLabel?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IPConfiguration in a network interface.␊ - */␊ - export interface NetworkInterfaceIPConfiguration23 {␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * Properties of IP configuration.␊ - */␊ - properties?: (NetworkInterfaceIPConfigurationPropertiesFormat23 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration.␊ - */␊ - export interface NetworkInterfaceIPConfigurationPropertiesFormat23 {␊ - /**␊ - * The reference to ApplicationGatewayBackendAddressPool resource.␊ - */␊ - applicationGatewayBackendAddressPools?: (SubResource32[] | string)␊ - /**␊ - * Application security groups in which the IP configuration is included.␊ - */␊ - applicationSecurityGroups?: (SubResource32[] | string)␊ - /**␊ - * The reference to LoadBalancerBackendAddressPool resource.␊ - */␊ - loadBalancerBackendAddressPools?: (SubResource32[] | string)␊ - /**␊ - * A list of references of LoadBalancerInboundNatRules.␊ - */␊ - loadBalancerInboundNatRules?: (SubResource32[] | string)␊ - /**␊ - * Whether this is a primary customer address on the network interface.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * Private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4.␊ - */␊ - privateIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The private IP address allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - publicIPAddress?: (SubResource32 | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - subnet?: (SubResource32 | string)␊ - /**␊ - * The reference to Virtual Network Taps.␊ - */␊ - virtualNetworkTaps?: (SubResource32[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces/tapConfigurations␊ - */␊ - export interface NetworkInterfacesTapConfigurationsChildResource11 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * The name of the tap configuration.␊ - */␊ - name: string␊ - /**␊ - * Properties of Virtual Network Tap configuration.␊ - */␊ - properties: (NetworkInterfaceTapConfigurationPropertiesFormat11 | string)␊ - type: "tapConfigurations"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Virtual Network Tap configuration.␊ - */␊ - export interface NetworkInterfaceTapConfigurationPropertiesFormat11 {␊ - /**␊ - * Reference to another subresource.␊ - */␊ - virtualNetworkTap?: (SubResource32 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces/tapConfigurations␊ - */␊ - export interface NetworkInterfacesTapConfigurations11 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * The name of the tap configuration.␊ - */␊ - name: string␊ - /**␊ - * Properties of Virtual Network Tap configuration.␊ - */␊ - properties: (NetworkInterfaceTapConfigurationPropertiesFormat11 | string)␊ - type: "Microsoft.Network/networkInterfaces/tapConfigurations"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkProfiles␊ - */␊ - export interface NetworkProfiles6 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the network profile.␊ - */␊ - name: string␊ - /**␊ - * Network profile properties.␊ - */␊ - properties: (NetworkProfilePropertiesFormat6 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Network/networkProfiles"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network profile properties.␊ - */␊ - export interface NetworkProfilePropertiesFormat6 {␊ - /**␊ - * List of chid container network interface configurations.␊ - */␊ - containerNetworkInterfaceConfigurations?: (ContainerNetworkInterfaceConfiguration6[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Container network interface configuration child resource.␊ - */␊ - export interface ContainerNetworkInterfaceConfiguration6 {␊ - /**␊ - * The name of the resource. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * Container network interface configuration properties.␊ - */␊ - properties?: (ContainerNetworkInterfaceConfigurationPropertiesFormat6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Container network interface configuration properties.␊ - */␊ - export interface ContainerNetworkInterfaceConfigurationPropertiesFormat6 {␊ - /**␊ - * A list of container network interfaces created from this container network interface configuration.␊ - */␊ - containerNetworkInterfaces?: (SubResource32[] | string)␊ - /**␊ - * A list of ip configurations of the container network interface configuration.␊ - */␊ - ipConfigurations?: (IPConfigurationProfile6[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration profile child resource.␊ - */␊ - export interface IPConfigurationProfile6 {␊ - /**␊ - * The name of the resource. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * IP configuration profile properties.␊ - */␊ - properties?: (IPConfigurationProfilePropertiesFormat6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration profile properties.␊ - */␊ - export interface IPConfigurationProfilePropertiesFormat6 {␊ - /**␊ - * Reference to another subresource.␊ - */␊ - subnet?: (SubResource32 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups␊ - */␊ - export interface NetworkSecurityGroups32 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the network security group.␊ - */␊ - name: string␊ - /**␊ - * Network Security Group resource.␊ - */␊ - properties: (NetworkSecurityGroupPropertiesFormat24 | string)␊ - resources?: NetworkSecurityGroupsSecurityRulesChildResource24[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Network/networkSecurityGroups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network Security Group resource.␊ - */␊ - export interface NetworkSecurityGroupPropertiesFormat24 {␊ - /**␊ - * A collection of security rules of the network security group.␊ - */␊ - securityRules?: (SecurityRule24[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network security rule.␊ - */␊ - export interface SecurityRule24 {␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * Security rule resource.␊ - */␊ - properties?: (SecurityRulePropertiesFormat24 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Security rule resource.␊ - */␊ - export interface SecurityRulePropertiesFormat24 {␊ - /**␊ - * The network traffic is allowed or denied.␊ - */␊ - access: (("Allow" | "Deny") | string)␊ - /**␊ - * A description for this rule. Restricted to 140 chars.␊ - */␊ - description?: string␊ - /**␊ - * The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used.␊ - */␊ - destinationAddressPrefix?: string␊ - /**␊ - * The destination address prefixes. CIDR or destination IP ranges.␊ - */␊ - destinationAddressPrefixes?: (string[] | string)␊ - /**␊ - * The application security group specified as destination.␊ - */␊ - destinationApplicationSecurityGroups?: (SubResource32[] | string)␊ - /**␊ - * The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.␊ - */␊ - destinationPortRange?: string␊ - /**␊ - * The destination port ranges.␊ - */␊ - destinationPortRanges?: (string[] | string)␊ - /**␊ - * The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic.␊ - */␊ - direction: (("Inbound" | "Outbound") | string)␊ - /**␊ - * The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.␊ - */␊ - priority: (number | string)␊ - /**␊ - * Network protocol this rule applies to.␊ - */␊ - protocol: (("Tcp" | "Udp" | "Icmp" | "Esp" | "*" | "Ah") | string)␊ - /**␊ - * The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from.␊ - */␊ - sourceAddressPrefix?: string␊ - /**␊ - * The CIDR or source IP ranges.␊ - */␊ - sourceAddressPrefixes?: (string[] | string)␊ - /**␊ - * The application security group specified as source.␊ - */␊ - sourceApplicationSecurityGroups?: (SubResource32[] | string)␊ - /**␊ - * The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.␊ - */␊ - sourcePortRange?: string␊ - /**␊ - * The source port ranges.␊ - */␊ - sourcePortRanges?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRulesChildResource24 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * The name of the security rule.␊ - */␊ - name: string␊ - /**␊ - * Security rule resource.␊ - */␊ - properties: (SecurityRulePropertiesFormat24 | string)␊ - type: "securityRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRules24 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * The name of the security rule.␊ - */␊ - name: string␊ - /**␊ - * Security rule resource.␊ - */␊ - properties: (SecurityRulePropertiesFormat24 | string)␊ - type: "Microsoft.Network/networkSecurityGroups/securityRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkVirtualAppliances␊ - */␊ - export interface NetworkVirtualAppliances {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * Identity for the resource.␊ - */␊ - identity?: (ManagedServiceIdentity10 | string)␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of Network Virtual Appliance.␊ - */␊ - name: string␊ - /**␊ - * Network Virtual Appliance definition.␊ - */␊ - properties: (NetworkVirtualAppliancePropertiesFormat | string)␊ - /**␊ - * Network Virtual Appliance Sku Properties.␊ - */␊ - sku?: (VirtualApplianceSkuProperties | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Network/networkVirtualAppliances"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network Virtual Appliance definition.␊ - */␊ - export interface NetworkVirtualAppliancePropertiesFormat {␊ - /**␊ - * BootStrapConfigurationBlob storage URLs.␊ - */␊ - bootStrapConfigurationBlob?: (string[] | string)␊ - /**␊ - * CloudInitConfigurationBlob storage URLs.␊ - */␊ - cloudInitConfigurationBlob?: (string[] | string)␊ - /**␊ - * VirtualAppliance ASN.␊ - */␊ - virtualApplianceAsn?: (number | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - virtualHub?: (SubResource32 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network Virtual Appliance Sku Properties.␊ - */␊ - export interface VirtualApplianceSkuProperties {␊ - /**␊ - * Virtual Appliance Scale Unit.␊ - */␊ - bundledScaleUnit?: string␊ - /**␊ - * Virtual Appliance Version.␊ - */␊ - marketPlaceVersion?: string␊ - /**␊ - * Virtual Appliance Vendor.␊ - */␊ - vendor?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers␊ - */␊ - export interface NetworkWatchers9 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the network watcher.␊ - */␊ - name: string␊ - /**␊ - * The network watcher properties.␊ - */␊ - properties: (NetworkWatcherPropertiesFormat5 | string)␊ - resources?: (NetworkWatchersPacketCapturesChildResource9 | NetworkWatchersConnectionMonitorsChildResource6 | NetworkWatchersFlowLogsChildResource1)[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Network/networkWatchers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The network watcher properties.␊ - */␊ - export interface NetworkWatcherPropertiesFormat5 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/packetCaptures␊ - */␊ - export interface NetworkWatchersPacketCapturesChildResource9 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * The name of the packet capture session.␊ - */␊ - name: string␊ - /**␊ - * Parameters that define the create packet capture operation.␊ - */␊ - properties: (PacketCaptureParameters9 | string)␊ - type: "packetCaptures"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters that define the create packet capture operation.␊ - */␊ - export interface PacketCaptureParameters9 {␊ - /**␊ - * Number of bytes captured per packet, the remaining bytes are truncated.␊ - */␊ - bytesToCapturePerPacket?: ((number & string) | string)␊ - /**␊ - * A list of packet capture filters.␊ - */␊ - filters?: (PacketCaptureFilter9[] | string)␊ - /**␊ - * The storage location for a packet capture session.␊ - */␊ - storageLocation: (PacketCaptureStorageLocation9 | string)␊ - /**␊ - * The ID of the targeted resource, only VM is currently supported.␊ - */␊ - target: string␊ - /**␊ - * Maximum duration of the capture session in seconds.␊ - */␊ - timeLimitInSeconds?: ((number & string) | string)␊ - /**␊ - * Maximum size of the capture output.␊ - */␊ - totalBytesPerSession?: ((number & string) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Filter that is applied to packet capture request. Multiple filters can be applied.␊ - */␊ - export interface PacketCaptureFilter9 {␊ - /**␊ - * Local IP Address to be filtered on. Notation: "127.0.0.1" for single address entry. "127.0.0.1-127.0.0.255" for range. "127.0.0.1;127.0.0.5"? for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.␊ - */␊ - localIPAddress?: string␊ - /**␊ - * Local port to be filtered on. Notation: "80" for single port entry."80-85" for range. "80;443;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.␊ - */␊ - localPort?: string␊ - /**␊ - * Protocol to be filtered on.␊ - */␊ - protocol?: (("TCP" | "UDP" | "Any") | string)␊ - /**␊ - * Local IP Address to be filtered on. Notation: "127.0.0.1" for single address entry. "127.0.0.1-127.0.0.255" for range. "127.0.0.1;127.0.0.5;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.␊ - */␊ - remoteIPAddress?: string␊ - /**␊ - * Remote port to be filtered on. Notation: "80" for single port entry."80-85" for range. "80;443;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.␊ - */␊ - remotePort?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The storage location for a packet capture session.␊ - */␊ - export interface PacketCaptureStorageLocation9 {␊ - /**␊ - * A valid local path on the targeting VM. Must include the name of the capture file (*.cap). For linux virtual machine it must start with /var/captures. Required if no storage ID is provided, otherwise optional.␊ - */␊ - filePath?: string␊ - /**␊ - * The ID of the storage account to save the packet capture session. Required if no local file path is provided.␊ - */␊ - storageId?: string␊ - /**␊ - * The URI of the storage path to save the packet capture. Must be a well-formed URI describing the location to save the packet capture.␊ - */␊ - storagePath?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/connectionMonitors␊ - */␊ - export interface NetworkWatchersConnectionMonitorsChildResource6 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * Connection monitor location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the connection monitor.␊ - */␊ - name: string␊ - /**␊ - * Parameters that define the operation to create a connection monitor.␊ - */␊ - properties: (ConnectionMonitorParameters6 | string)␊ - /**␊ - * Connection monitor tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "connectionMonitors"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters that define the operation to create a connection monitor.␊ - */␊ - export interface ConnectionMonitorParameters6 {␊ - /**␊ - * Determines if the connection monitor will start automatically once created.␊ - */␊ - autoStart?: (boolean | string)␊ - /**␊ - * Describes the destination of connection monitor.␊ - */␊ - destination?: (ConnectionMonitorDestination6 | string)␊ - /**␊ - * List of connection monitor endpoints.␊ - */␊ - endpoints?: (ConnectionMonitorEndpoint1[] | string)␊ - /**␊ - * Monitoring interval in seconds.␊ - */␊ - monitoringIntervalInSeconds?: ((number & string) | string)␊ - /**␊ - * Optional notes to be associated with the connection monitor.␊ - */␊ - notes?: string␊ - /**␊ - * List of connection monitor outputs.␊ - */␊ - outputs?: (ConnectionMonitorOutput1[] | string)␊ - /**␊ - * Describes the source of connection monitor.␊ - */␊ - source?: (ConnectionMonitorSource6 | string)␊ - /**␊ - * List of connection monitor test configurations.␊ - */␊ - testConfigurations?: (ConnectionMonitorTestConfiguration1[] | string)␊ - /**␊ - * List of connection monitor test groups.␊ - */␊ - testGroups?: (ConnectionMonitorTestGroup1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the destination of connection monitor.␊ - */␊ - export interface ConnectionMonitorDestination6 {␊ - /**␊ - * Address of the connection monitor destination (IP or domain name).␊ - */␊ - address?: string␊ - /**␊ - * The destination port used by connection monitor.␊ - */␊ - port?: (number | string)␊ - /**␊ - * The ID of the resource used as the destination by connection monitor.␊ - */␊ - resourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the connection monitor endpoint.␊ - */␊ - export interface ConnectionMonitorEndpoint1 {␊ - /**␊ - * Address of the connection monitor endpoint (IP or domain name).␊ - */␊ - address?: string␊ - /**␊ - * Describes the connection monitor endpoint filter.␊ - */␊ - filter?: (ConnectionMonitorEndpointFilter1 | string)␊ - /**␊ - * The name of the connection monitor endpoint.␊ - */␊ - name: string␊ - /**␊ - * Resource ID of the connection monitor endpoint.␊ - */␊ - resourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the connection monitor endpoint filter.␊ - */␊ - export interface ConnectionMonitorEndpointFilter1 {␊ - /**␊ - * List of items in the filter.␊ - */␊ - items?: (ConnectionMonitorEndpointFilterItem1[] | string)␊ - /**␊ - * The behavior of the endpoint filter. Currently only 'Include' is supported.␊ - */␊ - type?: ("Include" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the connection monitor endpoint filter item.␊ - */␊ - export interface ConnectionMonitorEndpointFilterItem1 {␊ - /**␊ - * The address of the filter item.␊ - */␊ - address?: string␊ - /**␊ - * The type of item included in the filter. Currently only 'AgentAddress' is supported.␊ - */␊ - type?: ("AgentAddress" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a connection monitor output destination.␊ - */␊ - export interface ConnectionMonitorOutput1 {␊ - /**␊ - * Connection monitor output destination type. Currently, only "Workspace" is supported.␊ - */␊ - type?: ("Workspace" | string)␊ - /**␊ - * Describes the settings for producing output into a log analytics workspace.␊ - */␊ - workspaceSettings?: (ConnectionMonitorWorkspaceSettings1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the settings for producing output into a log analytics workspace.␊ - */␊ - export interface ConnectionMonitorWorkspaceSettings1 {␊ - /**␊ - * Log analytics workspace resource ID.␊ - */␊ - workspaceResourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the source of connection monitor.␊ - */␊ - export interface ConnectionMonitorSource6 {␊ - /**␊ - * The source port used by connection monitor.␊ - */␊ - port?: (number | string)␊ - /**␊ - * The ID of the resource used as the source by connection monitor.␊ - */␊ - resourceId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a connection monitor test configuration.␊ - */␊ - export interface ConnectionMonitorTestConfiguration1 {␊ - /**␊ - * Describes the HTTP configuration.␊ - */␊ - httpConfiguration?: (ConnectionMonitorHttpConfiguration1 | string)␊ - /**␊ - * Describes the ICMP configuration.␊ - */␊ - icmpConfiguration?: (ConnectionMonitorIcmpConfiguration1 | string)␊ - /**␊ - * The name of the connection monitor test configuration.␊ - */␊ - name: string␊ - /**␊ - * The preferred IP version to use in test evaluation. The connection monitor may choose to use a different version depending on other parameters.␊ - */␊ - preferredIPVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The protocol to use in test evaluation.␊ - */␊ - protocol: (("Tcp" | "Http" | "Icmp") | string)␊ - /**␊ - * Describes the threshold for declaring a test successful.␊ - */␊ - successThreshold?: (ConnectionMonitorSuccessThreshold1 | string)␊ - /**␊ - * Describes the TCP configuration.␊ - */␊ - tcpConfiguration?: (ConnectionMonitorTcpConfiguration1 | string)␊ - /**␊ - * The frequency of test evaluation, in seconds.␊ - */␊ - testFrequencySec?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the HTTP configuration.␊ - */␊ - export interface ConnectionMonitorHttpConfiguration1 {␊ - /**␊ - * The HTTP method to use.␊ - */␊ - method?: (("Get" | "Post") | string)␊ - /**␊ - * The path component of the URI. For instance, "/dir1/dir2".␊ - */␊ - path?: string␊ - /**␊ - * The port to connect to.␊ - */␊ - port?: (number | string)␊ - /**␊ - * Value indicating whether HTTPS is preferred over HTTP in cases where the choice is not explicit.␊ - */␊ - preferHTTPS?: (boolean | string)␊ - /**␊ - * The HTTP headers to transmit with the request.␊ - */␊ - requestHeaders?: (HTTPHeader1[] | string)␊ - /**␊ - * HTTP status codes to consider successful. For instance, "2xx,301-304,418".␊ - */␊ - validStatusCodeRanges?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The HTTP header.␊ - */␊ - export interface HTTPHeader1 {␊ - /**␊ - * The name in HTTP header.␊ - */␊ - name?: string␊ - /**␊ - * The value in HTTP header.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the ICMP configuration.␊ - */␊ - export interface ConnectionMonitorIcmpConfiguration1 {␊ - /**␊ - * Value indicating whether path evaluation with trace route should be disabled.␊ - */␊ - disableTraceRoute?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the threshold for declaring a test successful.␊ - */␊ - export interface ConnectionMonitorSuccessThreshold1 {␊ - /**␊ - * The maximum percentage of failed checks permitted for a test to evaluate as successful.␊ - */␊ - checksFailedPercent?: (number | string)␊ - /**␊ - * The maximum round-trip time in milliseconds permitted for a test to evaluate as successful.␊ - */␊ - roundTripTimeMs?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the TCP configuration.␊ - */␊ - export interface ConnectionMonitorTcpConfiguration1 {␊ - /**␊ - * Value indicating whether path evaluation with trace route should be disabled.␊ - */␊ - disableTraceRoute?: (boolean | string)␊ - /**␊ - * The port to connect to.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the connection monitor test group.␊ - */␊ - export interface ConnectionMonitorTestGroup1 {␊ - /**␊ - * List of destination endpoint names.␊ - */␊ - destinations: (string[] | string)␊ - /**␊ - * Value indicating whether test group is disabled.␊ - */␊ - disable?: (boolean | string)␊ - /**␊ - * The name of the connection monitor test group.␊ - */␊ - name: string␊ - /**␊ - * List of source endpoint names.␊ - */␊ - sources: (string[] | string)␊ - /**␊ - * List of test configuration names.␊ - */␊ - testConfigurations: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/flowLogs␊ - */␊ - export interface NetworkWatchersFlowLogsChildResource1 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the flow log.␊ - */␊ - name: string␊ - /**␊ - * Parameters that define the configuration of flow log.␊ - */␊ - properties: (FlowLogPropertiesFormat1 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "flowLogs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters that define the configuration of flow log.␊ - */␊ - export interface FlowLogPropertiesFormat1 {␊ - /**␊ - * Flag to enable/disable flow logging.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Parameters that define the configuration of traffic analytics.␊ - */␊ - flowAnalyticsConfiguration?: (TrafficAnalyticsProperties1 | string)␊ - /**␊ - * Parameters that define the flow log format.␊ - */␊ - format?: (FlowLogFormatParameters1 | string)␊ - /**␊ - * Parameters that define the retention policy for flow log.␊ - */␊ - retentionPolicy?: (RetentionPolicyParameters1 | string)␊ - /**␊ - * ID of the storage account which is used to store the flow log.␊ - */␊ - storageId: string␊ - /**␊ - * ID of network security group to which flow log will be applied.␊ - */␊ - targetResourceId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters that define the configuration of traffic analytics.␊ - */␊ - export interface TrafficAnalyticsProperties1 {␊ - /**␊ - * Parameters that define the configuration of traffic analytics.␊ - */␊ - networkWatcherFlowAnalyticsConfiguration?: (TrafficAnalyticsConfigurationProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters that define the configuration of traffic analytics.␊ - */␊ - export interface TrafficAnalyticsConfigurationProperties1 {␊ - /**␊ - * Flag to enable/disable traffic analytics.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * The interval in minutes which would decide how frequently TA service should do flow analytics.␊ - */␊ - trafficAnalyticsInterval?: (number | string)␊ - /**␊ - * The resource guid of the attached workspace.␊ - */␊ - workspaceId?: string␊ - /**␊ - * The location of the attached workspace.␊ - */␊ - workspaceRegion?: string␊ - /**␊ - * Resource Id of the attached workspace.␊ - */␊ - workspaceResourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters that define the flow log format.␊ - */␊ - export interface FlowLogFormatParameters1 {␊ - /**␊ - * The file type of flow log.␊ - */␊ - type?: ("JSON" | string)␊ - /**␊ - * The version (revision) of the flow log.␊ - */␊ - version?: ((number & string) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters that define the retention policy for flow log.␊ - */␊ - export interface RetentionPolicyParameters1 {␊ - /**␊ - * Number of days to retain flow log records.␊ - */␊ - days?: ((number & string) | string)␊ - /**␊ - * Flag to enable/disable retention.␊ - */␊ - enabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/connectionMonitors␊ - */␊ - export interface NetworkWatchersConnectionMonitors6 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * Connection monitor location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the connection monitor.␊ - */␊ - name: string␊ - /**␊ - * Parameters that define the operation to create a connection monitor.␊ - */␊ - properties: (ConnectionMonitorParameters6 | string)␊ - /**␊ - * Connection monitor tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Network/networkWatchers/connectionMonitors"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/flowLogs␊ - */␊ - export interface NetworkWatchersFlowLogs1 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the flow log.␊ - */␊ - name: string␊ - /**␊ - * Parameters that define the configuration of flow log.␊ - */␊ - properties: (FlowLogPropertiesFormat1 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Network/networkWatchers/flowLogs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/packetCaptures␊ - */␊ - export interface NetworkWatchersPacketCaptures9 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * The name of the packet capture session.␊ - */␊ - name: string␊ - /**␊ - * Parameters that define the create packet capture operation.␊ - */␊ - properties: (PacketCaptureParameters9 | string)␊ - type: "Microsoft.Network/networkWatchers/packetCaptures"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/p2svpnGateways␊ - */␊ - export interface P2SvpnGateways6 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the gateway.␊ - */␊ - name: string␊ - /**␊ - * Parameters for P2SVpnGateway.␊ - */␊ - properties: (P2SVpnGatewayProperties6 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Network/p2svpnGateways"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for P2SVpnGateway.␊ - */␊ - export interface P2SVpnGatewayProperties6 {␊ - /**␊ - * List of all p2s connection configurations of the gateway.␊ - */␊ - p2SConnectionConfigurations?: (P2SConnectionConfiguration3[] | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - virtualHub?: (SubResource32 | string)␊ - /**␊ - * The scale unit for this p2s vpn gateway.␊ - */␊ - vpnGatewayScaleUnit?: (number | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - vpnServerConfiguration?: (SubResource32 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * P2SConnectionConfiguration Resource.␊ - */␊ - export interface P2SConnectionConfiguration3 {␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * Parameters for P2SConnectionConfiguration.␊ - */␊ - properties?: (P2SConnectionConfigurationProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for P2SConnectionConfiguration.␊ - */␊ - export interface P2SConnectionConfigurationProperties3 {␊ - /**␊ - * AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.␊ - */␊ - vpnClientAddressPool?: (AddressSpace32 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateEndpoints␊ - */␊ - export interface PrivateEndpoints6 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the private endpoint.␊ - */␊ - name: string␊ - /**␊ - * Properties of the private endpoint.␊ - */␊ - properties: (PrivateEndpointProperties6 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Network/privateEndpoints"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the private endpoint.␊ - */␊ - export interface PrivateEndpointProperties6 {␊ - /**␊ - * A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource.␊ - */␊ - manualPrivateLinkServiceConnections?: (PrivateLinkServiceConnection6[] | string)␊ - /**␊ - * A grouping of information about the connection to the remote resource.␊ - */␊ - privateLinkServiceConnections?: (PrivateLinkServiceConnection6[] | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - subnet?: (SubResource32 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * PrivateLinkServiceConnection resource.␊ - */␊ - export interface PrivateLinkServiceConnection6 {␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * Properties of the PrivateLinkServiceConnection.␊ - */␊ - properties?: (PrivateLinkServiceConnectionProperties6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the PrivateLinkServiceConnection.␊ - */␊ - export interface PrivateLinkServiceConnectionProperties6 {␊ - /**␊ - * The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to.␊ - */␊ - groupIds?: (string[] | string)␊ - /**␊ - * A collection of information about the state of the connection between service consumer and provider.␊ - */␊ - privateLinkServiceConnectionState?: (PrivateLinkServiceConnectionState12 | string)␊ - /**␊ - * The resource id of private link service.␊ - */␊ - privateLinkServiceId?: string␊ - /**␊ - * A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars.␊ - */␊ - requestMessage?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A collection of information about the state of the connection between service consumer and provider.␊ - */␊ - export interface PrivateLinkServiceConnectionState12 {␊ - /**␊ - * A message indicating if changes on the service provider require any updates on the consumer.␊ - */␊ - actionsRequired?: string␊ - /**␊ - * The reason for approval/rejection of the connection.␊ - */␊ - description?: string␊ - /**␊ - * Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.␊ - */␊ - status?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateLinkServices␊ - */␊ - export interface PrivateLinkServices6 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the private link service.␊ - */␊ - name: string␊ - /**␊ - * Properties of the private link service.␊ - */␊ - properties: (PrivateLinkServiceProperties6 | string)␊ - resources?: PrivateLinkServicesPrivateEndpointConnectionsChildResource6[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Network/privateLinkServices"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the private link service.␊ - */␊ - export interface PrivateLinkServiceProperties6 {␊ - /**␊ - * The auto-approval list of the private link service.␊ - */␊ - autoApproval?: (PrivateLinkServicePropertiesAutoApproval6 | string)␊ - /**␊ - * Whether the private link service is enabled for proxy protocol or not.␊ - */␊ - enableProxyProtocol?: (boolean | string)␊ - /**␊ - * The list of Fqdn.␊ - */␊ - fqdns?: (string[] | string)␊ - /**␊ - * An array of private link service IP configurations.␊ - */␊ - ipConfigurations?: (PrivateLinkServiceIpConfiguration6[] | string)␊ - /**␊ - * An array of references to the load balancer IP configurations.␊ - */␊ - loadBalancerFrontendIpConfigurations?: (SubResource32[] | string)␊ - /**␊ - * The visibility list of the private link service.␊ - */␊ - visibility?: (PrivateLinkServicePropertiesVisibility6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The auto-approval list of the private link service.␊ - */␊ - export interface PrivateLinkServicePropertiesAutoApproval6 {␊ - /**␊ - * The list of subscriptions.␊ - */␊ - subscriptions?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The private link service ip configuration.␊ - */␊ - export interface PrivateLinkServiceIpConfiguration6 {␊ - /**␊ - * The name of private link service ip configuration.␊ - */␊ - name?: string␊ - /**␊ - * Properties of private link service IP configuration.␊ - */␊ - properties?: (PrivateLinkServiceIpConfigurationProperties6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of private link service IP configuration.␊ - */␊ - export interface PrivateLinkServiceIpConfigurationProperties6 {␊ - /**␊ - * Whether the ip configuration is primary or not.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * The private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4.␊ - */␊ - privateIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The private IP address allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - subnet?: (SubResource32 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The visibility list of the private link service.␊ - */␊ - export interface PrivateLinkServicePropertiesVisibility6 {␊ - /**␊ - * The list of subscriptions.␊ - */␊ - subscriptions?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateLinkServices/privateEndpointConnections␊ - */␊ - export interface PrivateLinkServicesPrivateEndpointConnectionsChildResource6 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * The name of the private end point connection.␊ - */␊ - name: string␊ - /**␊ - * Properties of the PrivateEndpointConnectProperties.␊ - */␊ - properties: (PrivateEndpointConnectionProperties13 | string)␊ - type: "privateEndpointConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the PrivateEndpointConnectProperties.␊ - */␊ - export interface PrivateEndpointConnectionProperties13 {␊ - /**␊ - * A collection of information about the state of the connection between service consumer and provider.␊ - */␊ - privateLinkServiceConnectionState?: (PrivateLinkServiceConnectionState12 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateLinkServices/privateEndpointConnections␊ - */␊ - export interface PrivateLinkServicesPrivateEndpointConnections6 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * The name of the private end point connection.␊ - */␊ - name: string␊ - /**␊ - * Properties of the PrivateEndpointConnectProperties.␊ - */␊ - properties: (PrivateEndpointConnectionProperties13 | string)␊ - type: "Microsoft.Network/privateLinkServices/privateEndpointConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/publicIPAddresses␊ - */␊ - export interface PublicIPAddresses32 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the public IP address.␊ - */␊ - name: string␊ - /**␊ - * Public IP address properties.␊ - */␊ - properties: (PublicIPAddressPropertiesFormat23 | string)␊ - /**␊ - * SKU of a public IP address.␊ - */␊ - sku?: (PublicIPAddressSku20 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Network/publicIPAddresses"␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Public IP address properties.␊ - */␊ - export interface PublicIPAddressPropertiesFormat23 {␊ - /**␊ - * Contains the DDoS protection settings of the public IP.␊ - */␊ - ddosSettings?: (DdosSettings9 | string)␊ - /**␊ - * Contains FQDN of the DNS record associated with the public IP address.␊ - */␊ - dnsSettings?: (PublicIPAddressDnsSettings31 | string)␊ - /**␊ - * The idle timeout of the public IP address.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * The IP address associated with the public IP address resource.␊ - */␊ - ipAddress?: string␊ - /**␊ - * The list of tags associated with the public IP address.␊ - */␊ - ipTags?: (IpTag17[] | string)␊ - /**␊ - * The public IP address version.␊ - */␊ - publicIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The public IP address allocation method.␊ - */␊ - publicIPAllocationMethod: (("Static" | "Dynamic") | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - publicIPPrefix?: (SubResource32 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains the DDoS protection settings of the public IP.␊ - */␊ - export interface DdosSettings9 {␊ - /**␊ - * Reference to another subresource.␊ - */␊ - ddosCustomPolicy?: (SubResource32 | string)␊ - /**␊ - * Enables DDoS protection on the public IP.␊ - */␊ - protectedIP?: (boolean | string)␊ - /**␊ - * The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized.␊ - */␊ - protectionCoverage?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains FQDN of the DNS record associated with the public IP address.␊ - */␊ - export interface PublicIPAddressDnsSettings31 {␊ - /**␊ - * The domain name label. The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.␊ - */␊ - domainNameLabel: string␊ - /**␊ - * The Fully Qualified Domain Name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone.␊ - */␊ - fqdn?: string␊ - /**␊ - * The reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN.␊ - */␊ - reverseFqdn?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains the IpTag associated with the object.␊ - */␊ - export interface IpTag17 {␊ - /**␊ - * The IP tag type. Example: FirstPartyUsage.␊ - */␊ - ipTagType?: string␊ - /**␊ - * The value of the IP tag associated with the public IP. Example: SQL.␊ - */␊ - tag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a public IP address.␊ - */␊ - export interface PublicIPAddressSku20 {␊ - /**␊ - * Name of a public IP address SKU.␊ - */␊ - name?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/publicIPPrefixes␊ - */␊ - export interface PublicIPPrefixes7 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the public IP prefix.␊ - */␊ - name: string␊ - /**␊ - * Public IP prefix properties.␊ - */␊ - properties: (PublicIPPrefixPropertiesFormat7 | string)␊ - /**␊ - * SKU of a public IP prefix.␊ - */␊ - sku?: (PublicIPPrefixSku7 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Network/publicIPPrefixes"␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Public IP prefix properties.␊ - */␊ - export interface PublicIPPrefixPropertiesFormat7 {␊ - /**␊ - * The list of tags associated with the public IP prefix.␊ - */␊ - ipTags?: (IpTag17[] | string)␊ - /**␊ - * The Length of the Public IP Prefix.␊ - */␊ - prefixLength?: (number | string)␊ - /**␊ - * The public IP address version.␊ - */␊ - publicIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a public IP prefix.␊ - */␊ - export interface PublicIPPrefixSku7 {␊ - /**␊ - * Name of a public IP prefix SKU.␊ - */␊ - name?: ("Standard" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeFilters␊ - */␊ - export interface RouteFilters9 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the route filter.␊ - */␊ - name: string␊ - /**␊ - * Route Filter Resource.␊ - */␊ - properties: (RouteFilterPropertiesFormat9 | string)␊ - resources?: RouteFiltersRouteFilterRulesChildResource9[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Network/routeFilters"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Filter Resource.␊ - */␊ - export interface RouteFilterPropertiesFormat9 {␊ - /**␊ - * Collection of RouteFilterRules contained within a route filter.␊ - */␊ - rules?: (RouteFilterRule9[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Filter Rule Resource.␊ - */␊ - export interface RouteFilterRule9 {␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * Route Filter Rule Resource.␊ - */␊ - properties?: (RouteFilterRulePropertiesFormat9 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Filter Rule Resource.␊ - */␊ - export interface RouteFilterRulePropertiesFormat9 {␊ - /**␊ - * The access type of the rule.␊ - */␊ - access: (("Allow" | "Deny") | string)␊ - /**␊ - * The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'].␊ - */␊ - communities: (string[] | string)␊ - /**␊ - * The rule type of the rule.␊ - */␊ - routeFilterRuleType: ("Community" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeFilters/routeFilterRules␊ - */␊ - export interface RouteFiltersRouteFilterRulesChildResource9 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the route filter rule.␊ - */␊ - name: string␊ - /**␊ - * Route Filter Rule Resource.␊ - */␊ - properties: (RouteFilterRulePropertiesFormat9 | string)␊ - type: "routeFilterRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeFilters/routeFilterRules␊ - */␊ - export interface RouteFiltersRouteFilterRules9 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the route filter rule.␊ - */␊ - name: string␊ - /**␊ - * Route Filter Rule Resource.␊ - */␊ - properties: (RouteFilterRulePropertiesFormat9 | string)␊ - type: "Microsoft.Network/routeFilters/routeFilterRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables␊ - */␊ - export interface RouteTables32 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the route table.␊ - */␊ - name: string␊ - /**␊ - * Route Table resource.␊ - */␊ - properties: (RouteTablePropertiesFormat24 | string)␊ - resources?: RouteTablesRoutesChildResource24[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Network/routeTables"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Table resource.␊ - */␊ - export interface RouteTablePropertiesFormat24 {␊ - /**␊ - * Whether to disable the routes learned by BGP on that route table. True means disable.␊ - */␊ - disableBgpRoutePropagation?: (boolean | string)␊ - /**␊ - * Collection of routes contained within a route table.␊ - */␊ - routes?: (Route24[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource.␊ - */␊ - export interface Route24 {␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * Route resource.␊ - */␊ - properties?: (RoutePropertiesFormat24 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource.␊ - */␊ - export interface RoutePropertiesFormat24 {␊ - /**␊ - * The destination CIDR to which the route applies.␊ - */␊ - addressPrefix: string␊ - /**␊ - * The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.␊ - */␊ - nextHopIpAddress?: string␊ - /**␊ - * The type of Azure hop the packet should be sent to.␊ - */␊ - nextHopType: (("VirtualNetworkGateway" | "VnetLocal" | "Internet" | "VirtualAppliance" | "None") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutesChildResource24 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * The name of the route.␊ - */␊ - name: string␊ - /**␊ - * Route resource.␊ - */␊ - properties: (RoutePropertiesFormat24 | string)␊ - type: "routes"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutes24 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * The name of the route.␊ - */␊ - name: string␊ - /**␊ - * Route resource.␊ - */␊ - properties: (RoutePropertiesFormat24 | string)␊ - type: "Microsoft.Network/routeTables/routes"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/serviceEndpointPolicies␊ - */␊ - export interface ServiceEndpointPolicies7 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the service endpoint policy.␊ - */␊ - name: string␊ - /**␊ - * Service Endpoint Policy resource.␊ - */␊ - properties: (ServiceEndpointPolicyPropertiesFormat7 | string)␊ - resources?: ServiceEndpointPoliciesServiceEndpointPolicyDefinitionsChildResource7[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Network/serviceEndpointPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Service Endpoint Policy resource.␊ - */␊ - export interface ServiceEndpointPolicyPropertiesFormat7 {␊ - /**␊ - * A collection of service endpoint policy definitions of the service endpoint policy.␊ - */␊ - serviceEndpointPolicyDefinitions?: (ServiceEndpointPolicyDefinition7[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Service Endpoint policy definitions.␊ - */␊ - export interface ServiceEndpointPolicyDefinition7 {␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * Service Endpoint policy definition resource.␊ - */␊ - properties?: (ServiceEndpointPolicyDefinitionPropertiesFormat7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Service Endpoint policy definition resource.␊ - */␊ - export interface ServiceEndpointPolicyDefinitionPropertiesFormat7 {␊ - /**␊ - * A description for this rule. Restricted to 140 chars.␊ - */␊ - description?: string␊ - /**␊ - * Service endpoint name.␊ - */␊ - service?: string␊ - /**␊ - * A list of service resources.␊ - */␊ - serviceResources?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions␊ - */␊ - export interface ServiceEndpointPoliciesServiceEndpointPolicyDefinitionsChildResource7 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * The name of the service endpoint policy definition name.␊ - */␊ - name: string␊ - /**␊ - * Service Endpoint policy definition resource.␊ - */␊ - properties: (ServiceEndpointPolicyDefinitionPropertiesFormat7 | string)␊ - type: "serviceEndpointPolicyDefinitions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions␊ - */␊ - export interface ServiceEndpointPoliciesServiceEndpointPolicyDefinitions7 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * The name of the service endpoint policy definition name.␊ - */␊ - name: string␊ - /**␊ - * Service Endpoint policy definition resource.␊ - */␊ - properties: (ServiceEndpointPolicyDefinitionPropertiesFormat7 | string)␊ - type: "Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualHubs␊ - */␊ - export interface VirtualHubs9 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the VirtualHub.␊ - */␊ - name: string␊ - /**␊ - * Parameters for VirtualHub.␊ - */␊ - properties: (VirtualHubProperties9 | string)␊ - resources?: VirtualHubsRouteTablesChildResource2[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Network/virtualHubs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VirtualHub.␊ - */␊ - export interface VirtualHubProperties9 {␊ - /**␊ - * Address-prefix for this VirtualHub.␊ - */␊ - addressPrefix?: string␊ - /**␊ - * Reference to another subresource.␊ - */␊ - azureFirewall?: (SubResource32 | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - expressRouteGateway?: (SubResource32 | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - p2SVpnGateway?: (SubResource32 | string)␊ - /**␊ - * VirtualHub route table.␊ - */␊ - routeTable?: (VirtualHubRouteTable6 | string)␊ - /**␊ - * The Security Provider name.␊ - */␊ - securityProviderName?: string␊ - /**␊ - * The sku of this VirtualHub.␊ - */␊ - sku?: string␊ - /**␊ - * List of all virtual hub route table v2s associated with this VirtualHub.␊ - */␊ - virtualHubRouteTableV2s?: (VirtualHubRouteTableV22[] | string)␊ - /**␊ - * List of all vnet connections with this VirtualHub.␊ - */␊ - virtualNetworkConnections?: (HubVirtualNetworkConnection9[] | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - virtualWan?: (SubResource32 | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - vpnGateway?: (SubResource32 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualHub route table.␊ - */␊ - export interface VirtualHubRouteTable6 {␊ - /**␊ - * List of all routes.␊ - */␊ - routes?: (VirtualHubRoute6[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualHub route.␊ - */␊ - export interface VirtualHubRoute6 {␊ - /**␊ - * List of all addressPrefixes.␊ - */␊ - addressPrefixes?: (string[] | string)␊ - /**␊ - * NextHop ip address.␊ - */␊ - nextHopIpAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualHubRouteTableV2 Resource.␊ - */␊ - export interface VirtualHubRouteTableV22 {␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * Parameters for VirtualHubRouteTableV2.␊ - */␊ - properties?: (VirtualHubRouteTableV2Properties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VirtualHubRouteTableV2.␊ - */␊ - export interface VirtualHubRouteTableV2Properties2 {␊ - /**␊ - * List of all connections attached to this route table v2.␊ - */␊ - attachedConnections?: (string[] | string)␊ - /**␊ - * List of all routes.␊ - */␊ - routes?: (VirtualHubRouteV22[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualHubRouteTableV2 route.␊ - */␊ - export interface VirtualHubRouteV22 {␊ - /**␊ - * List of all destinations.␊ - */␊ - destinations?: (string[] | string)␊ - /**␊ - * The type of destinations.␊ - */␊ - destinationType?: string␊ - /**␊ - * NextHops ip address.␊ - */␊ - nextHops?: (string[] | string)␊ - /**␊ - * The type of next hops.␊ - */␊ - nextHopType?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HubVirtualNetworkConnection Resource.␊ - */␊ - export interface HubVirtualNetworkConnection9 {␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * Parameters for HubVirtualNetworkConnection.␊ - */␊ - properties?: (HubVirtualNetworkConnectionProperties9 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for HubVirtualNetworkConnection.␊ - */␊ - export interface HubVirtualNetworkConnectionProperties9 {␊ - /**␊ - * VirtualHub to RemoteVnet transit to enabled or not.␊ - */␊ - allowHubToRemoteVnetTransit?: (boolean | string)␊ - /**␊ - * Allow RemoteVnet to use Virtual Hub's gateways.␊ - */␊ - allowRemoteVnetToUseHubVnetGateways?: (boolean | string)␊ - /**␊ - * Enable internet security.␊ - */␊ - enableInternetSecurity?: (boolean | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - remoteVirtualNetwork?: (SubResource32 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualHubs/routeTables␊ - */␊ - export interface VirtualHubsRouteTablesChildResource2 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * The name of the VirtualHubRouteTableV2.␊ - */␊ - name: string␊ - /**␊ - * Parameters for VirtualHubRouteTableV2.␊ - */␊ - properties: (VirtualHubRouteTableV2Properties2 | string)␊ - type: "routeTables"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualHubs/routeTables␊ - */␊ - export interface VirtualHubsRouteTables2 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * The name of the VirtualHubRouteTableV2.␊ - */␊ - name: string␊ - /**␊ - * Parameters for VirtualHubRouteTableV2.␊ - */␊ - properties: (VirtualHubRouteTableV2Properties2 | string)␊ - type: "Microsoft.Network/virtualHubs/routeTables"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworkGateways␊ - */␊ - export interface VirtualNetworkGateways24 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the virtual network gateway.␊ - */␊ - name: string␊ - /**␊ - * VirtualNetworkGateway properties.␊ - */␊ - properties: (VirtualNetworkGatewayPropertiesFormat24 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Network/virtualNetworkGateways"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGateway properties.␊ - */␊ - export interface VirtualNetworkGatewayPropertiesFormat24 {␊ - /**␊ - * ActiveActive flag.␊ - */␊ - activeActive?: (boolean | string)␊ - /**␊ - * BGP settings details.␊ - */␊ - bgpSettings?: (BgpSettings23 | string)␊ - /**␊ - * AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.␊ - */␊ - customRoutes?: (AddressSpace32 | string)␊ - /**␊ - * Whether BGP is enabled for this virtual network gateway or not.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * Whether dns forwarding is enabled or not.␊ - */␊ - enableDnsForwarding?: (boolean | string)␊ - /**␊ - * Whether private IP needs to be enabled on this gateway for connections or not.␊ - */␊ - enablePrivateIpAddress?: (boolean | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - gatewayDefaultSite?: (SubResource32 | string)␊ - /**␊ - * The type of this virtual network gateway.␊ - */␊ - gatewayType?: (("Vpn" | "ExpressRoute" | "HyperNet") | string)␊ - /**␊ - * IP configurations for virtual network gateway.␊ - */␊ - ipConfigurations?: (VirtualNetworkGatewayIPConfiguration23[] | string)␊ - /**␊ - * VirtualNetworkGatewaySku details.␊ - */␊ - sku?: (VirtualNetworkGatewaySku23 | string)␊ - /**␊ - * VpnClientConfiguration for P2S client.␊ - */␊ - vpnClientConfiguration?: (VpnClientConfiguration23 | string)␊ - /**␊ - * The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN.␊ - */␊ - vpnGatewayGeneration?: (("None" | "Generation1" | "Generation2") | string)␊ - /**␊ - * The type of this virtual network gateway.␊ - */␊ - vpnType?: (("PolicyBased" | "RouteBased") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration for virtual network gateway.␊ - */␊ - export interface VirtualNetworkGatewayIPConfiguration23 {␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * Properties of VirtualNetworkGatewayIPConfiguration.␊ - */␊ - properties?: (VirtualNetworkGatewayIPConfigurationPropertiesFormat23 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of VirtualNetworkGatewayIPConfiguration.␊ - */␊ - export interface VirtualNetworkGatewayIPConfigurationPropertiesFormat23 {␊ - /**␊ - * The private IP address allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - publicIPAddress?: (SubResource32 | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - subnet?: (SubResource32 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewaySku details.␊ - */␊ - export interface VirtualNetworkGatewaySku23 {␊ - /**␊ - * Gateway SKU name.␊ - */␊ - name?: (("Basic" | "HighPerformance" | "Standard" | "UltraPerformance" | "VpnGw1" | "VpnGw2" | "VpnGw3" | "VpnGw4" | "VpnGw5" | "VpnGw1AZ" | "VpnGw2AZ" | "VpnGw3AZ" | "VpnGw4AZ" | "VpnGw5AZ" | "ErGw1AZ" | "ErGw2AZ" | "ErGw3AZ") | string)␊ - /**␊ - * Gateway SKU tier.␊ - */␊ - tier?: (("Basic" | "HighPerformance" | "Standard" | "UltraPerformance" | "VpnGw1" | "VpnGw2" | "VpnGw3" | "VpnGw4" | "VpnGw5" | "VpnGw1AZ" | "VpnGw2AZ" | "VpnGw3AZ" | "VpnGw4AZ" | "VpnGw5AZ" | "ErGw1AZ" | "ErGw2AZ" | "ErGw3AZ") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnClientConfiguration for P2S client.␊ - */␊ - export interface VpnClientConfiguration23 {␊ - /**␊ - * The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication.␊ - */␊ - aadAudience?: string␊ - /**␊ - * The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication.␊ - */␊ - aadIssuer?: string␊ - /**␊ - * The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication.␊ - */␊ - aadTenant?: string␊ - /**␊ - * The radius server address property of the VirtualNetworkGateway resource for vpn client connection.␊ - */␊ - radiusServerAddress?: string␊ - /**␊ - * The radius secret property of the VirtualNetworkGateway resource for vpn client connection.␊ - */␊ - radiusServerSecret?: string␊ - /**␊ - * AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.␊ - */␊ - vpnClientAddressPool?: (AddressSpace32 | string)␊ - /**␊ - * VpnClientIpsecPolicies for virtual network gateway P2S client.␊ - */␊ - vpnClientIpsecPolicies?: (IpsecPolicy21[] | string)␊ - /**␊ - * VpnClientProtocols for Virtual network gateway.␊ - */␊ - vpnClientProtocols?: (("IkeV2" | "SSTP" | "OpenVPN")[] | string)␊ - /**␊ - * VpnClientRevokedCertificate for Virtual network gateway.␊ - */␊ - vpnClientRevokedCertificates?: (VpnClientRevokedCertificate23[] | string)␊ - /**␊ - * VpnClientRootCertificate for virtual network gateway.␊ - */␊ - vpnClientRootCertificates?: (VpnClientRootCertificate23[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client revoked certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRevokedCertificate23 {␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * Properties of the revoked VPN client certificate of virtual network gateway.␊ - */␊ - properties?: (VpnClientRevokedCertificatePropertiesFormat23 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the revoked VPN client certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRevokedCertificatePropertiesFormat23 {␊ - /**␊ - * The revoked VPN client certificate thumbprint.␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client root certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRootCertificate23 {␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * Properties of SSL certificates of application gateway.␊ - */␊ - properties: (VpnClientRootCertificatePropertiesFormat23 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of application gateway.␊ - */␊ - export interface VpnClientRootCertificatePropertiesFormat23 {␊ - /**␊ - * The certificate public data.␊ - */␊ - publicCertData: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks␊ - */␊ - export interface VirtualNetworks32 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the virtual network.␊ - */␊ - name: string␊ - /**␊ - * Properties of the virtual network.␊ - */␊ - properties: (VirtualNetworkPropertiesFormat24 | string)␊ - resources?: (VirtualNetworksSubnetsChildResource24 | VirtualNetworksVirtualNetworkPeeringsChildResource21)[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Network/virtualNetworks"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the virtual network.␊ - */␊ - export interface VirtualNetworkPropertiesFormat24 {␊ - /**␊ - * AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.␊ - */␊ - addressSpace: (AddressSpace32 | string)␊ - /**␊ - * Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET.␊ - */␊ - bgpCommunities?: (VirtualNetworkBgpCommunities3 | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - ddosProtectionPlan?: (SubResource32 | string)␊ - /**␊ - * DhcpOptions contains an array of DNS servers available to VMs deployed in the virtual network. Standard DHCP option for a subnet overrides VNET DHCP options.␊ - */␊ - dhcpOptions?: (DhcpOptions32 | string)␊ - /**␊ - * Indicates if DDoS protection is enabled for all the protected resources in the virtual network. It requires a DDoS protection plan associated with the resource.␊ - */␊ - enableDdosProtection?: (boolean | string)␊ - /**␊ - * Indicates if VM protection is enabled for all the subnets in the virtual network.␊ - */␊ - enableVmProtection?: (boolean | string)␊ - /**␊ - * A list of subnets in a Virtual Network.␊ - */␊ - subnets?: (Subnet34[] | string)␊ - /**␊ - * A list of peerings in a Virtual Network.␊ - */␊ - virtualNetworkPeerings?: (VirtualNetworkPeering29[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET.␊ - */␊ - export interface VirtualNetworkBgpCommunities3 {␊ - /**␊ - * The BGP community associated with the virtual network.␊ - */␊ - virtualNetworkCommunity: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DhcpOptions contains an array of DNS servers available to VMs deployed in the virtual network. Standard DHCP option for a subnet overrides VNET DHCP options.␊ - */␊ - export interface DhcpOptions32 {␊ - /**␊ - * The list of DNS servers IP addresses.␊ - */␊ - dnsServers: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Subnet in a virtual network resource.␊ - */␊ - export interface Subnet34 {␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties?: (SubnetPropertiesFormat24 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the subnet.␊ - */␊ - export interface SubnetPropertiesFormat24 {␊ - /**␊ - * The address prefix for the subnet.␊ - */␊ - addressPrefix: string␊ - /**␊ - * List of address prefixes for the subnet.␊ - */␊ - addressPrefixes?: (string[] | string)␊ - /**␊ - * An array of references to the delegations on the subnet.␊ - */␊ - delegations?: (Delegation11[] | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - natGateway?: (SubResource32 | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - networkSecurityGroup?: (SubResource32 | string)␊ - /**␊ - * Enable or Disable apply network policies on private end point in the subnet.␊ - */␊ - privateEndpointNetworkPolicies?: string␊ - /**␊ - * Enable or Disable apply network policies on private link service in the subnet.␊ - */␊ - privateLinkServiceNetworkPolicies?: string␊ - /**␊ - * Reference to another subresource.␊ - */␊ - routeTable?: (SubResource32 | string)␊ - /**␊ - * An array of service endpoint policies.␊ - */␊ - serviceEndpointPolicies?: (SubResource32[] | string)␊ - /**␊ - * An array of service endpoints.␊ - */␊ - serviceEndpoints?: (ServiceEndpointPropertiesFormat20[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Details the service to which the subnet is delegated.␊ - */␊ - export interface Delegation11 {␊ - /**␊ - * The name of the resource that is unique within a subnet. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * Properties of a service delegation.␊ - */␊ - properties?: (ServiceDelegationPropertiesFormat11 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a service delegation.␊ - */␊ - export interface ServiceDelegationPropertiesFormat11 {␊ - /**␊ - * The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers).␊ - */␊ - serviceName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The service endpoint properties.␊ - */␊ - export interface ServiceEndpointPropertiesFormat20 {␊ - /**␊ - * A list of locations.␊ - */␊ - locations?: (string[] | string)␊ - /**␊ - * The type of the endpoint service.␊ - */␊ - service?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peerings in a virtual network resource.␊ - */␊ - export interface VirtualNetworkPeering29 {␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties?: (VirtualNetworkPeeringPropertiesFormat21 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - export interface VirtualNetworkPeeringPropertiesFormat21 {␊ - /**␊ - * Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network.␊ - */␊ - allowForwardedTraffic?: (boolean | string)␊ - /**␊ - * If gateway links can be used in remote virtual networking to link to this virtual network.␊ - */␊ - allowGatewayTransit?: (boolean | string)␊ - /**␊ - * Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space.␊ - */␊ - allowVirtualNetworkAccess?: (boolean | string)␊ - /**␊ - * The status of the virtual network peering.␊ - */␊ - peeringState?: (("Initiated" | "Connected" | "Disconnected") | string)␊ - /**␊ - * AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.␊ - */␊ - remoteAddressSpace?: (AddressSpace32 | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - remoteVirtualNetwork: (SubResource32 | string)␊ - /**␊ - * If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway.␊ - */␊ - useRemoteGateways?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnetsChildResource24 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * The name of the subnet.␊ - */␊ - name: string␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties: (SubnetPropertiesFormat24 | string)␊ - type: "subnets"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/virtualNetworkPeerings␊ - */␊ - export interface VirtualNetworksVirtualNetworkPeeringsChildResource21 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * The name of the peering.␊ - */␊ - name: string␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties: (VirtualNetworkPeeringPropertiesFormat21 | string)␊ - type: "virtualNetworkPeerings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnets24 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * The name of the subnet.␊ - */␊ - name: string␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties: (SubnetPropertiesFormat24 | string)␊ - type: "Microsoft.Network/virtualNetworks/subnets"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/virtualNetworkPeerings␊ - */␊ - export interface VirtualNetworksVirtualNetworkPeerings21 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * The name of the peering.␊ - */␊ - name: string␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties: (VirtualNetworkPeeringPropertiesFormat21 | string)␊ - type: "Microsoft.Network/virtualNetworks/virtualNetworkPeerings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworkTaps␊ - */␊ - export interface VirtualNetworkTaps6 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the virtual network tap.␊ - */␊ - name: string␊ - /**␊ - * Virtual Network Tap properties.␊ - */␊ - properties: (VirtualNetworkTapPropertiesFormat6 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Network/virtualNetworkTaps"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Virtual Network Tap properties.␊ - */␊ - export interface VirtualNetworkTapPropertiesFormat6 {␊ - /**␊ - * Reference to another subresource.␊ - */␊ - destinationLoadBalancerFrontEndIPConfiguration?: (SubResource32 | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - destinationNetworkInterfaceIPConfiguration?: (SubResource32 | string)␊ - /**␊ - * The VXLAN destination port that will receive the tapped traffic.␊ - */␊ - destinationPort?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualRouters␊ - */␊ - export interface VirtualRouters4 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the Virtual Router.␊ - */␊ - name: string␊ - /**␊ - * Virtual Router definition.␊ - */␊ - properties: (VirtualRouterPropertiesFormat4 | string)␊ - resources?: VirtualRoutersPeeringsChildResource4[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Network/virtualRouters"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Virtual Router definition.␊ - */␊ - export interface VirtualRouterPropertiesFormat4 {␊ - /**␊ - * Reference to another subresource.␊ - */␊ - hostedGateway?: (SubResource32 | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - hostedSubnet?: (SubResource32 | string)␊ - /**␊ - * VirtualRouter ASN.␊ - */␊ - virtualRouterAsn?: (number | string)␊ - /**␊ - * VirtualRouter IPs.␊ - */␊ - virtualRouterIps?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualRouters/peerings␊ - */␊ - export interface VirtualRoutersPeeringsChildResource4 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * The name of the Virtual Router Peering.␊ - */␊ - name: string␊ - /**␊ - * Properties of the rule group.␊ - */␊ - properties: (VirtualRouterPeeringProperties4 | string)␊ - type: "peerings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the rule group.␊ - */␊ - export interface VirtualRouterPeeringProperties4 {␊ - /**␊ - * Peer ASN.␊ - */␊ - peerAsn?: (number | string)␊ - /**␊ - * Peer IP.␊ - */␊ - peerIp?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualRouters/peerings␊ - */␊ - export interface VirtualRoutersPeerings4 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * The name of the Virtual Router Peering.␊ - */␊ - name: string␊ - /**␊ - * Properties of the rule group.␊ - */␊ - properties: (VirtualRouterPeeringProperties4 | string)␊ - type: "Microsoft.Network/virtualRouters/peerings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualWans␊ - */␊ - export interface VirtualWans9 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the VirtualWAN being created or updated.␊ - */␊ - name: string␊ - /**␊ - * Parameters for VirtualWAN.␊ - */␊ - properties: (VirtualWanProperties9 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Network/virtualWans"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VirtualWAN.␊ - */␊ - export interface VirtualWanProperties9 {␊ - /**␊ - * True if branch to branch traffic is allowed.␊ - */␊ - allowBranchToBranchTraffic?: (boolean | string)␊ - /**␊ - * True if Vnet to Vnet traffic is allowed.␊ - */␊ - allowVnetToVnetTraffic?: (boolean | string)␊ - /**␊ - * Vpn encryption to be disabled or not.␊ - */␊ - disableVpnEncryption?: (boolean | string)␊ - /**␊ - * The office local breakout category.␊ - */␊ - office365LocalBreakoutCategory?: (("Optimize" | "OptimizeAndAllow" | "All" | "None") | string)␊ - /**␊ - * The type of the VirtualWAN.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnGateways␊ - */␊ - export interface VpnGateways9 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the gateway.␊ - */␊ - name: string␊ - /**␊ - * Parameters for VpnGateway.␊ - */␊ - properties: (VpnGatewayProperties9 | string)␊ - resources?: VpnGatewaysVpnConnectionsChildResource9[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Network/vpnGateways"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnGateway.␊ - */␊ - export interface VpnGatewayProperties9 {␊ - /**␊ - * BGP settings details.␊ - */␊ - bgpSettings?: (BgpSettings23 | string)␊ - /**␊ - * List of all vpn connections to the gateway.␊ - */␊ - connections?: (VpnConnection9[] | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - virtualHub?: (SubResource32 | string)␊ - /**␊ - * The scale unit for this vpn gateway.␊ - */␊ - vpnGatewayScaleUnit?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnConnection Resource.␊ - */␊ - export interface VpnConnection9 {␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * Parameters for VpnConnection.␊ - */␊ - properties?: (VpnConnectionProperties9 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnConnection.␊ - */␊ - export interface VpnConnectionProperties9 {␊ - /**␊ - * Expected bandwidth in MBPS.␊ - */␊ - connectionBandwidth?: (number | string)␊ - /**␊ - * The connection status.␊ - */␊ - connectionStatus?: (("Unknown" | "Connecting" | "Connected" | "NotConnected") | string)␊ - /**␊ - * EnableBgp flag.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * Enable internet security.␊ - */␊ - enableInternetSecurity?: (boolean | string)␊ - /**␊ - * EnableBgp flag.␊ - */␊ - enableRateLimiting?: (boolean | string)␊ - /**␊ - * The IPSec Policies to be considered by this connection.␊ - */␊ - ipsecPolicies?: (IpsecPolicy21[] | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - remoteVpnSite?: (SubResource32 | string)␊ - /**␊ - * Routing weight for vpn connection.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * SharedKey for the vpn connection.␊ - */␊ - sharedKey?: string␊ - /**␊ - * Use local azure ip to initiate connection.␊ - */␊ - useLocalAzureIpAddress?: (boolean | string)␊ - /**␊ - * Enable policy-based traffic selectors.␊ - */␊ - usePolicyBasedTrafficSelectors?: (boolean | string)␊ - /**␊ - * Connection protocol used for this connection.␊ - */␊ - vpnConnectionProtocolType?: (("IKEv2" | "IKEv1") | string)␊ - /**␊ - * List of all vpn site link connections to the gateway.␊ - */␊ - vpnLinkConnections?: (VpnSiteLinkConnection5[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnSiteLinkConnection Resource.␊ - */␊ - export interface VpnSiteLinkConnection5 {␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * Parameters for VpnConnection.␊ - */␊ - properties?: (VpnSiteLinkConnectionProperties5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnConnection.␊ - */␊ - export interface VpnSiteLinkConnectionProperties5 {␊ - /**␊ - * Expected bandwidth in MBPS.␊ - */␊ - connectionBandwidth?: (number | string)␊ - /**␊ - * The connection status.␊ - */␊ - connectionStatus?: (("Unknown" | "Connecting" | "Connected" | "NotConnected") | string)␊ - /**␊ - * EnableBgp flag.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * EnableBgp flag.␊ - */␊ - enableRateLimiting?: (boolean | string)␊ - /**␊ - * The IPSec Policies to be considered by this connection.␊ - */␊ - ipsecPolicies?: (IpsecPolicy21[] | string)␊ - /**␊ - * Routing weight for vpn connection.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * SharedKey for the vpn connection.␊ - */␊ - sharedKey?: string␊ - /**␊ - * Use local azure ip to initiate connection.␊ - */␊ - useLocalAzureIpAddress?: (boolean | string)␊ - /**␊ - * Enable policy-based traffic selectors.␊ - */␊ - usePolicyBasedTrafficSelectors?: (boolean | string)␊ - /**␊ - * Connection protocol used for this connection.␊ - */␊ - vpnConnectionProtocolType?: (("IKEv2" | "IKEv1") | string)␊ - /**␊ - * Reference to another subresource.␊ - */␊ - vpnSiteLink?: (SubResource32 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnGateways/vpnConnections␊ - */␊ - export interface VpnGatewaysVpnConnectionsChildResource9 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * The name of the connection.␊ - */␊ - name: string␊ - /**␊ - * Parameters for VpnConnection.␊ - */␊ - properties: (VpnConnectionProperties9 | string)␊ - type: "vpnConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnGateways/vpnConnections␊ - */␊ - export interface VpnGatewaysVpnConnections9 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * The name of the connection.␊ - */␊ - name: string␊ - /**␊ - * Parameters for VpnConnection.␊ - */␊ - properties: (VpnConnectionProperties9 | string)␊ - type: "Microsoft.Network/vpnGateways/vpnConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnServerConfigurations␊ - */␊ - export interface VpnServerConfigurations3 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the VpnServerConfiguration being created or updated.␊ - */␊ - name: string␊ - /**␊ - * Parameters for VpnServerConfiguration.␊ - */␊ - properties: (VpnServerConfigurationProperties3 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Network/vpnServerConfigurations"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnServerConfiguration.␊ - */␊ - export interface VpnServerConfigurationProperties3 {␊ - /**␊ - * AAD Vpn authentication type related parameters.␊ - */␊ - aadAuthenticationParameters?: (AadAuthenticationParameters3 | string)␊ - /**␊ - * The name of the VpnServerConfiguration that is unique within a resource group.␊ - */␊ - name?: string␊ - /**␊ - * Radius client root certificate of VpnServerConfiguration.␊ - */␊ - radiusClientRootCertificates?: (VpnServerConfigRadiusClientRootCertificate3[] | string)␊ - /**␊ - * The radius server address property of the VpnServerConfiguration resource for point to site client connection.␊ - */␊ - radiusServerAddress?: string␊ - /**␊ - * Radius Server root certificate of VpnServerConfiguration.␊ - */␊ - radiusServerRootCertificates?: (VpnServerConfigRadiusServerRootCertificate3[] | string)␊ - /**␊ - * The radius secret property of the VpnServerConfiguration resource for point to site client connection.␊ - */␊ - radiusServerSecret?: string␊ - /**␊ - * VPN authentication types for the VpnServerConfiguration.␊ - */␊ - vpnAuthenticationTypes?: (("Certificate" | "Radius" | "AAD")[] | string)␊ - /**␊ - * VpnClientIpsecPolicies for VpnServerConfiguration.␊ - */␊ - vpnClientIpsecPolicies?: (IpsecPolicy21[] | string)␊ - /**␊ - * VPN client revoked certificate of VpnServerConfiguration.␊ - */␊ - vpnClientRevokedCertificates?: (VpnServerConfigVpnClientRevokedCertificate3[] | string)␊ - /**␊ - * VPN client root certificate of VpnServerConfiguration.␊ - */␊ - vpnClientRootCertificates?: (VpnServerConfigVpnClientRootCertificate3[] | string)␊ - /**␊ - * VPN protocols for the VpnServerConfiguration.␊ - */␊ - vpnProtocols?: (("IkeV2" | "OpenVPN")[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AAD Vpn authentication type related parameters.␊ - */␊ - export interface AadAuthenticationParameters3 {␊ - /**␊ - * AAD Vpn authentication parameter AAD audience.␊ - */␊ - aadAudience?: string␊ - /**␊ - * AAD Vpn authentication parameter AAD issuer.␊ - */␊ - aadIssuer?: string␊ - /**␊ - * AAD Vpn authentication parameter AAD tenant.␊ - */␊ - aadTenant?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Radius client root certificate of VpnServerConfiguration.␊ - */␊ - export interface VpnServerConfigRadiusClientRootCertificate3 {␊ - /**␊ - * The certificate name.␊ - */␊ - name?: string␊ - /**␊ - * The Radius client root certificate thumbprint.␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Radius Server root certificate of VpnServerConfiguration.␊ - */␊ - export interface VpnServerConfigRadiusServerRootCertificate3 {␊ - /**␊ - * The certificate name.␊ - */␊ - name?: string␊ - /**␊ - * The certificate public data.␊ - */␊ - publicCertData?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the revoked VPN client certificate of VpnServerConfiguration.␊ - */␊ - export interface VpnServerConfigVpnClientRevokedCertificate3 {␊ - /**␊ - * The certificate name.␊ - */␊ - name?: string␊ - /**␊ - * The revoked VPN client certificate thumbprint.␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of VPN client root certificate of VpnServerConfiguration.␊ - */␊ - export interface VpnServerConfigVpnClientRootCertificate3 {␊ - /**␊ - * The certificate name.␊ - */␊ - name?: string␊ - /**␊ - * The certificate public data.␊ - */␊ - publicCertData?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnSites␊ - */␊ - export interface VpnSites9 {␊ - apiVersion: "2019-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The name of the VpnSite being created or updated.␊ - */␊ - name: string␊ - /**␊ - * Parameters for VpnSite.␊ - */␊ - properties: (VpnSiteProperties9 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Network/vpnSites"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnSite.␊ - */␊ - export interface VpnSiteProperties9 {␊ - /**␊ - * AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.␊ - */␊ - addressSpace?: (AddressSpace32 | string)␊ - /**␊ - * BGP settings details.␊ - */␊ - bgpProperties?: (BgpSettings23 | string)␊ - /**␊ - * List of properties of the device.␊ - */␊ - deviceProperties?: (DeviceProperties9 | string)␊ - /**␊ - * The ip-address for the vpn-site.␊ - */␊ - ipAddress?: string␊ - /**␊ - * IsSecuritySite flag.␊ - */␊ - isSecuritySite?: (boolean | string)␊ - /**␊ - * The key for vpn-site that can be used for connections.␊ - */␊ - siteKey?: string␊ - /**␊ - * Reference to another subresource.␊ - */␊ - virtualWan?: (SubResource32 | string)␊ - /**␊ - * List of all vpn site links.␊ - */␊ - vpnSiteLinks?: (VpnSiteLink5[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * List of properties of the device.␊ - */␊ - export interface DeviceProperties9 {␊ - /**␊ - * Model of the device.␊ - */␊ - deviceModel?: string␊ - /**␊ - * Name of the device Vendor.␊ - */␊ - deviceVendor?: string␊ - /**␊ - * Link speed.␊ - */␊ - linkSpeedInMbps?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnSiteLink Resource.␊ - */␊ - export interface VpnSiteLink5 {␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * Parameters for VpnSite.␊ - */␊ - properties?: (VpnSiteLinkProperties5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnSite.␊ - */␊ - export interface VpnSiteLinkProperties5 {␊ - /**␊ - * BGP settings details for a link.␊ - */␊ - bgpProperties?: (VpnLinkBgpSettings5 | string)␊ - /**␊ - * FQDN of vpn-site-link.␊ - */␊ - fqdn?: string␊ - /**␊ - * The ip-address for the vpn-site-link.␊ - */␊ - ipAddress?: string␊ - /**␊ - * List of properties of a link provider.␊ - */␊ - linkProperties?: (VpnLinkProviderProperties5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * BGP settings details for a link.␊ - */␊ - export interface VpnLinkBgpSettings5 {␊ - /**␊ - * The BGP speaker's ASN.␊ - */␊ - asn?: (number | string)␊ - /**␊ - * The BGP peering address and BGP identifier of this BGP speaker.␊ - */␊ - bgpPeeringAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * List of properties of a link provider.␊ - */␊ - export interface VpnLinkProviderProperties5 {␊ - /**␊ - * Name of the link provider.␊ - */␊ - linkProviderName?: string␊ - /**␊ - * Link speed.␊ - */␊ - linkSpeedInMbps?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/applicationGateways␊ - */␊ - export interface ApplicationGateways25 {␊ - name: string␊ - type: "Microsoft.Network/applicationGateways"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the application gateway.␊ - */␊ - properties: (ApplicationGatewayPropertiesFormat25 | string)␊ - /**␊ - * A list of availability zones denoting where the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - /**␊ - * The identity of the application gateway, if configured.␊ - */␊ - identity?: (ManagedServiceIdentity11 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application gateway.␊ - */␊ - export interface ApplicationGatewayPropertiesFormat25 {␊ - /**␊ - * SKU of the application gateway resource.␊ - */␊ - sku?: (ApplicationGatewaySku25 | string)␊ - /**␊ - * SSL policy of the application gateway resource.␊ - */␊ - sslPolicy?: (ApplicationGatewaySslPolicy22 | string)␊ - /**␊ - * Subnets of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - gatewayIPConfigurations?: (ApplicationGatewayIPConfiguration25[] | string)␊ - /**␊ - * Authentication certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - authenticationCertificates?: (ApplicationGatewayAuthenticationCertificate22[] | string)␊ - /**␊ - * Trusted Root certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - trustedRootCertificates?: (ApplicationGatewayTrustedRootCertificate12[] | string)␊ - /**␊ - * SSL certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - sslCertificates?: (ApplicationGatewaySslCertificate25[] | string)␊ - /**␊ - * Frontend IP addresses of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - frontendIPConfigurations?: (ApplicationGatewayFrontendIPConfiguration25[] | string)␊ - /**␊ - * Frontend ports of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - frontendPorts?: (ApplicationGatewayFrontendPort25[] | string)␊ - /**␊ - * Probes of the application gateway resource.␊ - */␊ - probes?: (ApplicationGatewayProbe24[] | string)␊ - /**␊ - * Backend address pool of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - backendAddressPools?: (ApplicationGatewayBackendAddressPool25[] | string)␊ - /**␊ - * Backend http settings of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - backendHttpSettingsCollection?: (ApplicationGatewayBackendHttpSettings25[] | string)␊ - /**␊ - * Http listeners of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - httpListeners?: (ApplicationGatewayHttpListener25[] | string)␊ - /**␊ - * URL path map of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - urlPathMaps?: (ApplicationGatewayUrlPathMap24[] | string)␊ - /**␊ - * Request routing rules of the application gateway resource.␊ - */␊ - requestRoutingRules?: (ApplicationGatewayRequestRoutingRule25[] | string)␊ - /**␊ - * Rewrite rules for the application gateway resource.␊ - */␊ - rewriteRuleSets?: (ApplicationGatewayRewriteRuleSet11[] | string)␊ - /**␊ - * Redirect configurations of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - redirectConfigurations?: (ApplicationGatewayRedirectConfiguration22[] | string)␊ - /**␊ - * Web application firewall configuration.␊ - */␊ - webApplicationFirewallConfiguration?: (ApplicationGatewayWebApplicationFirewallConfiguration22 | string)␊ - /**␊ - * Reference to the FirewallPolicy resource.␊ - */␊ - firewallPolicy?: (SubResource33 | string)␊ - /**␊ - * Whether HTTP2 is enabled on the application gateway resource.␊ - */␊ - enableHttp2?: (boolean | string)␊ - /**␊ - * Whether FIPS is enabled on the application gateway resource.␊ - */␊ - enableFips?: (boolean | string)␊ - /**␊ - * Autoscale Configuration.␊ - */␊ - autoscaleConfiguration?: (ApplicationGatewayAutoscaleConfiguration15 | string)␊ - /**␊ - * Custom error configurations of the application gateway resource.␊ - */␊ - customErrorConfigurations?: (ApplicationGatewayCustomError12[] | string)␊ - /**␊ - * If true, associates a firewall policy with an application gateway regardless whether the policy differs from the WAF Config.␊ - */␊ - forceFirewallPolicyAssociation?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of an application gateway.␊ - */␊ - export interface ApplicationGatewaySku25 {␊ - /**␊ - * Name of an application gateway SKU.␊ - */␊ - name?: (("Standard_Small" | "Standard_Medium" | "Standard_Large" | "WAF_Medium" | "WAF_Large" | "Standard_v2" | "WAF_v2") | string)␊ - /**␊ - * Tier of an application gateway.␊ - */␊ - tier?: (("Standard" | "WAF" | "Standard_v2" | "WAF_v2") | string)␊ - /**␊ - * Capacity (instance count) of an application gateway.␊ - */␊ - capacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application Gateway Ssl policy.␊ - */␊ - export interface ApplicationGatewaySslPolicy22 {␊ - /**␊ - * Ssl protocols to be disabled on application gateway.␊ - */␊ - disabledSslProtocols?: (("TLSv1_0" | "TLSv1_1" | "TLSv1_2")[] | string)␊ - /**␊ - * Type of Ssl Policy.␊ - */␊ - policyType?: (("Predefined" | "Custom") | string)␊ - /**␊ - * Name of Ssl predefined policy.␊ - */␊ - policyName?: (("AppGwSslPolicy20150501" | "AppGwSslPolicy20170401" | "AppGwSslPolicy20170401S") | string)␊ - /**␊ - * Ssl cipher suites to be enabled in the specified order to application gateway.␊ - */␊ - cipherSuites?: (("TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384" | "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256" | "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA" | "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA" | "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384" | "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256" | "TLS_DHE_RSA_WITH_AES_256_CBC_SHA" | "TLS_DHE_RSA_WITH_AES_128_CBC_SHA" | "TLS_RSA_WITH_AES_256_GCM_SHA384" | "TLS_RSA_WITH_AES_128_GCM_SHA256" | "TLS_RSA_WITH_AES_256_CBC_SHA256" | "TLS_RSA_WITH_AES_128_CBC_SHA256" | "TLS_RSA_WITH_AES_256_CBC_SHA" | "TLS_RSA_WITH_AES_128_CBC_SHA" | "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384" | "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256" | "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384" | "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256" | "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA" | "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA" | "TLS_DHE_DSS_WITH_AES_256_CBC_SHA256" | "TLS_DHE_DSS_WITH_AES_128_CBC_SHA256" | "TLS_DHE_DSS_WITH_AES_256_CBC_SHA" | "TLS_DHE_DSS_WITH_AES_128_CBC_SHA" | "TLS_RSA_WITH_3DES_EDE_CBC_SHA" | "TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA" | "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256" | "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384")[] | string)␊ - /**␊ - * Minimum version of Ssl protocol to be supported on application gateway.␊ - */␊ - minProtocolVersion?: (("TLSv1_0" | "TLSv1_1" | "TLSv1_2") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed.␊ - */␊ - export interface ApplicationGatewayIPConfiguration25 {␊ - /**␊ - * Properties of the application gateway IP configuration.␊ - */␊ - properties?: (ApplicationGatewayIPConfigurationPropertiesFormat25 | string)␊ - /**␊ - * Name of the IP configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayIPConfigurationPropertiesFormat25 {␊ - /**␊ - * Reference to the subnet resource. A subnet from where application gateway gets its private address.␊ - */␊ - subnet?: (SubResource33 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Reference to another subresource.␊ - */␊ - export interface SubResource33 {␊ - /**␊ - * Resource ID.␊ - */␊ - id: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authentication certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewayAuthenticationCertificate22 {␊ - /**␊ - * Properties of the application gateway authentication certificate.␊ - */␊ - properties?: (ApplicationGatewayAuthenticationCertificatePropertiesFormat22 | string)␊ - /**␊ - * Name of the authentication certificate that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authentication certificates properties of an application gateway.␊ - */␊ - export interface ApplicationGatewayAuthenticationCertificatePropertiesFormat22 {␊ - /**␊ - * Certificate public data.␊ - */␊ - data?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trusted Root certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewayTrustedRootCertificate12 {␊ - /**␊ - * Properties of the application gateway trusted root certificate.␊ - */␊ - properties?: (ApplicationGatewayTrustedRootCertificatePropertiesFormat12 | string)␊ - /**␊ - * Name of the trusted root certificate that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trusted Root certificates properties of an application gateway.␊ - */␊ - export interface ApplicationGatewayTrustedRootCertificatePropertiesFormat12 {␊ - /**␊ - * Certificate public data.␊ - */␊ - data?: string␊ - /**␊ - * Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault.␊ - */␊ - keyVaultSecretId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSL certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewaySslCertificate25 {␊ - /**␊ - * Properties of the application gateway SSL certificate.␊ - */␊ - properties?: (ApplicationGatewaySslCertificatePropertiesFormat25 | string)␊ - /**␊ - * Name of the SSL certificate that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewaySslCertificatePropertiesFormat25 {␊ - /**␊ - * Base-64 encoded pfx certificate. Only applicable in PUT Request.␊ - */␊ - data?: string␊ - /**␊ - * Password for the pfx file specified in data. Only applicable in PUT request.␊ - */␊ - password?: string␊ - /**␊ - * Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault.␊ - */␊ - keyVaultSecretId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendIPConfiguration25 {␊ - /**␊ - * Properties of the application gateway frontend IP configuration.␊ - */␊ - properties?: (ApplicationGatewayFrontendIPConfigurationPropertiesFormat25 | string)␊ - /**␊ - * Name of the frontend IP configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendIPConfigurationPropertiesFormat25 {␊ - /**␊ - * PrivateIPAddress of the network interface IP Configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The private IP address allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Reference to the subnet resource.␊ - */␊ - subnet?: (SubResource33 | string)␊ - /**␊ - * Reference to the PublicIP resource.␊ - */␊ - publicIPAddress?: (SubResource33 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend port of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendPort25 {␊ - /**␊ - * Properties of the application gateway frontend port.␊ - */␊ - properties?: (ApplicationGatewayFrontendPortPropertiesFormat25 | string)␊ - /**␊ - * Name of the frontend port that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend port of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendPortPropertiesFormat25 {␊ - /**␊ - * Frontend port.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Probe of the application gateway.␊ - */␊ - export interface ApplicationGatewayProbe24 {␊ - /**␊ - * Properties of the application gateway probe.␊ - */␊ - properties?: (ApplicationGatewayProbePropertiesFormat24 | string)␊ - /**␊ - * Name of the probe that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of probe of an application gateway.␊ - */␊ - export interface ApplicationGatewayProbePropertiesFormat24 {␊ - /**␊ - * The protocol used for the probe.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Host name to send the probe to.␊ - */␊ - host?: string␊ - /**␊ - * Relative path of probe. Valid path starts from '/'. Probe is sent to ://:.␊ - */␊ - path?: string␊ - /**␊ - * The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - interval?: (number | string)␊ - /**␊ - * The probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - timeout?: (number | string)␊ - /**␊ - * The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20.␊ - */␊ - unhealthyThreshold?: (number | string)␊ - /**␊ - * Whether the host header should be picked from the backend http settings. Default value is false.␊ - */␊ - pickHostNameFromBackendHttpSettings?: (boolean | string)␊ - /**␊ - * Minimum number of servers that are always marked healthy. Default value is 0.␊ - */␊ - minServers?: (number | string)␊ - /**␊ - * Criterion for classifying a healthy probe response.␊ - */␊ - match?: (ApplicationGatewayProbeHealthResponseMatch22 | string)␊ - /**␊ - * Custom port which will be used for probing the backend servers. The valid value ranges from 1 to 65535. In case not set, port from http settings will be used. This property is valid for Standard_v2 and WAF_v2 only.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application gateway probe health response match.␊ - */␊ - export interface ApplicationGatewayProbeHealthResponseMatch22 {␊ - /**␊ - * Body that must be contained in the health response. Default value is empty.␊ - */␊ - body?: string␊ - /**␊ - * Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399.␊ - */␊ - statusCodes?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend Address Pool of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddressPool25 {␊ - /**␊ - * Properties of the application gateway backend address pool.␊ - */␊ - properties?: (ApplicationGatewayBackendAddressPoolPropertiesFormat25 | string)␊ - /**␊ - * Name of the backend address pool that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend Address Pool of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddressPoolPropertiesFormat25 {␊ - /**␊ - * Backend addresses.␊ - */␊ - backendAddresses?: (ApplicationGatewayBackendAddress25[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddress25 {␊ - /**␊ - * Fully qualified domain name (FQDN).␊ - */␊ - fqdn?: string␊ - /**␊ - * IP address.␊ - */␊ - ipAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address pool settings of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendHttpSettings25 {␊ - /**␊ - * Properties of the application gateway backend HTTP settings.␊ - */␊ - properties?: (ApplicationGatewayBackendHttpSettingsPropertiesFormat25 | string)␊ - /**␊ - * Name of the backend http settings that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend address pool settings of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendHttpSettingsPropertiesFormat25 {␊ - /**␊ - * The destination port on the backend.␊ - */␊ - port?: (number | string)␊ - /**␊ - * The protocol used to communicate with the backend.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Cookie based affinity.␊ - */␊ - cookieBasedAffinity?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Request timeout in seconds. Application Gateway will fail the request if response is not received within RequestTimeout. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - requestTimeout?: (number | string)␊ - /**␊ - * Probe resource of an application gateway.␊ - */␊ - probe?: (SubResource33 | string)␊ - /**␊ - * Array of references to application gateway authentication certificates.␊ - */␊ - authenticationCertificates?: (SubResource33[] | string)␊ - /**␊ - * Array of references to application gateway trusted root certificates.␊ - */␊ - trustedRootCertificates?: (SubResource33[] | string)␊ - /**␊ - * Connection draining of the backend http settings resource.␊ - */␊ - connectionDraining?: (ApplicationGatewayConnectionDraining22 | string)␊ - /**␊ - * Host header to be sent to the backend servers.␊ - */␊ - hostName?: string␊ - /**␊ - * Whether to pick host header should be picked from the host name of the backend server. Default value is false.␊ - */␊ - pickHostNameFromBackendAddress?: (boolean | string)␊ - /**␊ - * Cookie name to use for the affinity cookie.␊ - */␊ - affinityCookieName?: string␊ - /**␊ - * Whether the probe is enabled. Default value is false.␊ - */␊ - probeEnabled?: (boolean | string)␊ - /**␊ - * Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null.␊ - */␊ - path?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Connection draining allows open connections to a backend server to be active for a specified time after the backend server got removed from the configuration.␊ - */␊ - export interface ApplicationGatewayConnectionDraining22 {␊ - /**␊ - * Whether connection draining is enabled or not.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds.␊ - */␊ - drainTimeoutInSec: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http listener of an application gateway.␊ - */␊ - export interface ApplicationGatewayHttpListener25 {␊ - /**␊ - * Properties of the application gateway HTTP listener.␊ - */␊ - properties?: (ApplicationGatewayHttpListenerPropertiesFormat25 | string)␊ - /**␊ - * Name of the HTTP listener that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of HTTP listener of an application gateway.␊ - */␊ - export interface ApplicationGatewayHttpListenerPropertiesFormat25 {␊ - /**␊ - * Frontend IP configuration resource of an application gateway.␊ - */␊ - frontendIPConfiguration?: (SubResource33 | string)␊ - /**␊ - * Frontend port resource of an application gateway.␊ - */␊ - frontendPort?: (SubResource33 | string)␊ - /**␊ - * Protocol of the HTTP listener.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Host name of HTTP listener.␊ - */␊ - hostName?: string␊ - /**␊ - * SSL certificate resource of an application gateway.␊ - */␊ - sslCertificate?: (SubResource33 | string)␊ - /**␊ - * Applicable only if protocol is https. Enables SNI for multi-hosting.␊ - */␊ - requireServerNameIndication?: (boolean | string)␊ - /**␊ - * Custom error configurations of the HTTP listener.␊ - */␊ - customErrorConfigurations?: (ApplicationGatewayCustomError12[] | string)␊ - /**␊ - * Reference to the FirewallPolicy resource.␊ - */␊ - firewallPolicy?: (SubResource33 | string)␊ - /**␊ - * List of Host names for HTTP Listener that allows special wildcard characters as well.␊ - */␊ - hostNames?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Customer error of an application gateway.␊ - */␊ - export interface ApplicationGatewayCustomError12 {␊ - /**␊ - * Status code of the application gateway customer error.␊ - */␊ - statusCode?: (("HttpStatus403" | "HttpStatus502") | string)␊ - /**␊ - * Error page URL of the application gateway customer error.␊ - */␊ - customErrorPageUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * UrlPathMaps give a url path to the backend mapping information for PathBasedRouting.␊ - */␊ - export interface ApplicationGatewayUrlPathMap24 {␊ - /**␊ - * Properties of the application gateway URL path map.␊ - */␊ - properties?: (ApplicationGatewayUrlPathMapPropertiesFormat24 | string)␊ - /**␊ - * Name of the URL path map that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of UrlPathMap of the application gateway.␊ - */␊ - export interface ApplicationGatewayUrlPathMapPropertiesFormat24 {␊ - /**␊ - * Default backend address pool resource of URL path map.␊ - */␊ - defaultBackendAddressPool?: (SubResource33 | string)␊ - /**␊ - * Default backend http settings resource of URL path map.␊ - */␊ - defaultBackendHttpSettings?: (SubResource33 | string)␊ - /**␊ - * Default Rewrite rule set resource of URL path map.␊ - */␊ - defaultRewriteRuleSet?: (SubResource33 | string)␊ - /**␊ - * Default redirect configuration resource of URL path map.␊ - */␊ - defaultRedirectConfiguration?: (SubResource33 | string)␊ - /**␊ - * Path rule of URL path map resource.␊ - */␊ - pathRules?: (ApplicationGatewayPathRule24[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Path rule of URL path map of an application gateway.␊ - */␊ - export interface ApplicationGatewayPathRule24 {␊ - /**␊ - * Properties of the application gateway path rule.␊ - */␊ - properties?: (ApplicationGatewayPathRulePropertiesFormat24 | string)␊ - /**␊ - * Name of the path rule that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of path rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayPathRulePropertiesFormat24 {␊ - /**␊ - * Path rules of URL path map.␊ - */␊ - paths?: (string[] | string)␊ - /**␊ - * Backend address pool resource of URL path map path rule.␊ - */␊ - backendAddressPool?: (SubResource33 | string)␊ - /**␊ - * Backend http settings resource of URL path map path rule.␊ - */␊ - backendHttpSettings?: (SubResource33 | string)␊ - /**␊ - * Redirect configuration resource of URL path map path rule.␊ - */␊ - redirectConfiguration?: (SubResource33 | string)␊ - /**␊ - * Rewrite rule set resource of URL path map path rule.␊ - */␊ - rewriteRuleSet?: (SubResource33 | string)␊ - /**␊ - * Reference to the FirewallPolicy resource.␊ - */␊ - firewallPolicy?: (SubResource33 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Request routing rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayRequestRoutingRule25 {␊ - /**␊ - * Properties of the application gateway request routing rule.␊ - */␊ - properties?: (ApplicationGatewayRequestRoutingRulePropertiesFormat25 | string)␊ - /**␊ - * Name of the request routing rule that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of request routing rule of the application gateway.␊ - */␊ - export interface ApplicationGatewayRequestRoutingRulePropertiesFormat25 {␊ - /**␊ - * Rule type.␊ - */␊ - ruleType?: (("Basic" | "PathBasedRouting") | string)␊ - /**␊ - * Priority of the request routing rule.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * Backend address pool resource of the application gateway.␊ - */␊ - backendAddressPool?: (SubResource33 | string)␊ - /**␊ - * Backend http settings resource of the application gateway.␊ - */␊ - backendHttpSettings?: (SubResource33 | string)␊ - /**␊ - * Http listener resource of the application gateway.␊ - */␊ - httpListener?: (SubResource33 | string)␊ - /**␊ - * URL path map resource of the application gateway.␊ - */␊ - urlPathMap?: (SubResource33 | string)␊ - /**␊ - * Rewrite Rule Set resource in Basic rule of the application gateway.␊ - */␊ - rewriteRuleSet?: (SubResource33 | string)␊ - /**␊ - * Redirect configuration resource of the application gateway.␊ - */␊ - redirectConfiguration?: (SubResource33 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Rewrite rule set of an application gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRuleSet11 {␊ - /**␊ - * Properties of the application gateway rewrite rule set.␊ - */␊ - properties?: (ApplicationGatewayRewriteRuleSetPropertiesFormat11 | string)␊ - /**␊ - * Name of the rewrite rule set that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of rewrite rule set of the application gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRuleSetPropertiesFormat11 {␊ - /**␊ - * Rewrite rules in the rewrite rule set.␊ - */␊ - rewriteRules?: (ApplicationGatewayRewriteRule11[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Rewrite rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRule11 {␊ - /**␊ - * Name of the rewrite rule that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet.␊ - */␊ - ruleSequence?: (number | string)␊ - /**␊ - * Conditions based on which the action set execution will be evaluated.␊ - */␊ - conditions?: (ApplicationGatewayRewriteRuleCondition9[] | string)␊ - /**␊ - * Set of actions to be done as part of the rewrite Rule.␊ - */␊ - actionSet?: (ApplicationGatewayRewriteRuleActionSet11 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Set of conditions in the Rewrite Rule in Application Gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRuleCondition9 {␊ - /**␊ - * The condition parameter of the RewriteRuleCondition.␊ - */␊ - variable?: string␊ - /**␊ - * The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition.␊ - */␊ - pattern?: string␊ - /**␊ - * Setting this paramter to truth value with force the pattern to do a case in-sensitive comparison.␊ - */␊ - ignoreCase?: (boolean | string)␊ - /**␊ - * Setting this value as truth will force to check the negation of the condition given by the user.␊ - */␊ - negate?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Set of actions in the Rewrite Rule in Application Gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRuleActionSet11 {␊ - /**␊ - * Request Header Actions in the Action Set.␊ - */␊ - requestHeaderConfigurations?: (ApplicationGatewayHeaderConfiguration11[] | string)␊ - /**␊ - * Response Header Actions in the Action Set.␊ - */␊ - responseHeaderConfigurations?: (ApplicationGatewayHeaderConfiguration11[] | string)␊ - /**␊ - * Url Configuration Action in the Action Set.␊ - */␊ - urlConfiguration?: (ApplicationGatewayUrlConfiguration2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Header configuration of the Actions set in Application Gateway.␊ - */␊ - export interface ApplicationGatewayHeaderConfiguration11 {␊ - /**␊ - * Header name of the header configuration.␊ - */␊ - headerName?: string␊ - /**␊ - * Header value of the header configuration.␊ - */␊ - headerValue?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Url configuration of the Actions set in Application Gateway.␊ - */␊ - export interface ApplicationGatewayUrlConfiguration2 {␊ - /**␊ - * Url path which user has provided for url rewrite. Null means no path will be updated. Default value is null.␊ - */␊ - modifiedPath?: string␊ - /**␊ - * Query string which user has provided for url rewrite. Null means no query string will be updated. Default value is null.␊ - */␊ - modifiedQueryString?: string␊ - /**␊ - * If set as true, it will re-evaluate the url path map provided in path based request routing rules using modified path. Default value is false.␊ - */␊ - reroute?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Redirect configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayRedirectConfiguration22 {␊ - /**␊ - * Properties of the application gateway redirect configuration.␊ - */␊ - properties?: (ApplicationGatewayRedirectConfigurationPropertiesFormat22 | string)␊ - /**␊ - * Name of the redirect configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of redirect configuration of the application gateway.␊ - */␊ - export interface ApplicationGatewayRedirectConfigurationPropertiesFormat22 {␊ - /**␊ - * HTTP redirection type.␊ - */␊ - redirectType?: (("Permanent" | "Found" | "SeeOther" | "Temporary") | string)␊ - /**␊ - * Reference to a listener to redirect the request to.␊ - */␊ - targetListener?: (SubResource33 | string)␊ - /**␊ - * Url to redirect the request to.␊ - */␊ - targetUrl?: string␊ - /**␊ - * Include path in the redirected url.␊ - */␊ - includePath?: (boolean | string)␊ - /**␊ - * Include query string in the redirected url.␊ - */␊ - includeQueryString?: (boolean | string)␊ - /**␊ - * Request routing specifying redirect configuration.␊ - */␊ - requestRoutingRules?: (SubResource33[] | string)␊ - /**␊ - * Url path maps specifying default redirect configuration.␊ - */␊ - urlPathMaps?: (SubResource33[] | string)␊ - /**␊ - * Path rules specifying redirect configuration.␊ - */␊ - pathRules?: (SubResource33[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application gateway web application firewall configuration.␊ - */␊ - export interface ApplicationGatewayWebApplicationFirewallConfiguration22 {␊ - /**␊ - * Whether the web application firewall is enabled or not.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * Web application firewall mode.␊ - */␊ - firewallMode: (("Detection" | "Prevention") | string)␊ - /**␊ - * The type of the web application firewall rule set. Possible values are: 'OWASP'.␊ - */␊ - ruleSetType: string␊ - /**␊ - * The version of the rule set type.␊ - */␊ - ruleSetVersion: string␊ - /**␊ - * The disabled rule groups.␊ - */␊ - disabledRuleGroups?: (ApplicationGatewayFirewallDisabledRuleGroup22[] | string)␊ - /**␊ - * Whether allow WAF to check request Body.␊ - */␊ - requestBodyCheck?: (boolean | string)␊ - /**␊ - * Maximum request body size for WAF.␊ - */␊ - maxRequestBodySize?: (number | string)␊ - /**␊ - * Maximum request body size in Kb for WAF.␊ - */␊ - maxRequestBodySizeInKb?: (number | string)␊ - /**␊ - * Maximum file upload size in Mb for WAF.␊ - */␊ - fileUploadLimitInMb?: (number | string)␊ - /**␊ - * The exclusion list.␊ - */␊ - exclusions?: (ApplicationGatewayFirewallExclusion12[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allows to disable rules within a rule group or an entire rule group.␊ - */␊ - export interface ApplicationGatewayFirewallDisabledRuleGroup22 {␊ - /**␊ - * The name of the rule group that will be disabled.␊ - */␊ - ruleGroupName: string␊ - /**␊ - * The list of rules that will be disabled. If null, all rules of the rule group will be disabled.␊ - */␊ - rules?: (number[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allow to exclude some variable satisfy the condition for the WAF check.␊ - */␊ - export interface ApplicationGatewayFirewallExclusion12 {␊ - /**␊ - * The variable to be excluded.␊ - */␊ - matchVariable: string␊ - /**␊ - * When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to.␊ - */␊ - selectorMatchOperator: string␊ - /**␊ - * When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to.␊ - */␊ - selector: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application Gateway autoscale configuration.␊ - */␊ - export interface ApplicationGatewayAutoscaleConfiguration15 {␊ - /**␊ - * Lower bound on number of Application Gateway capacity.␊ - */␊ - minCapacity: (number | string)␊ - /**␊ - * Upper bound on number of Application Gateway capacity.␊ - */␊ - maxCapacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the resource.␊ - */␊ - export interface ManagedServiceIdentity11 {␊ - /**␊ - * The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.␊ - */␊ - type?: ("SystemAssigned" | "UserAssigned" | "SystemAssigned, UserAssigned" | "None")␊ - /**␊ - * The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.␊ - */␊ - userAssignedIdentities?: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies␊ - */␊ - export interface ApplicationGatewayWebApplicationFirewallPolicies9 {␊ - name: string␊ - type: "Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the web application firewall policy.␊ - */␊ - properties: (WebApplicationFirewallPolicyPropertiesFormat9 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines web application firewall policy properties.␊ - */␊ - export interface WebApplicationFirewallPolicyPropertiesFormat9 {␊ - /**␊ - * The PolicySettings for policy.␊ - */␊ - policySettings?: (PolicySettings11 | string)␊ - /**␊ - * The custom rules inside the policy.␊ - */␊ - customRules?: (WebApplicationFirewallCustomRule9[] | string)␊ - /**␊ - * Describes the managedRules structure.␊ - */␊ - managedRules: (ManagedRulesDefinition4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines contents of a web application firewall global configuration.␊ - */␊ - export interface PolicySettings11 {␊ - /**␊ - * The state of the policy.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * The mode of the policy.␊ - */␊ - mode?: (("Prevention" | "Detection") | string)␊ - /**␊ - * Whether to allow WAF to check request Body.␊ - */␊ - requestBodyCheck?: (boolean | string)␊ - /**␊ - * Maximum request body size in Kb for WAF.␊ - */␊ - maxRequestBodySizeInKb?: (number | string)␊ - /**␊ - * Maximum file upload size in Mb for WAF.␊ - */␊ - fileUploadLimitInMb?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines contents of a web application rule.␊ - */␊ - export interface WebApplicationFirewallCustomRule9 {␊ - /**␊ - * The name of the resource that is unique within a policy. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * Priority of the rule. Rules with a lower value will be evaluated before rules with a higher value.␊ - */␊ - priority: (number | string)␊ - /**␊ - * The rule type.␊ - */␊ - ruleType: (("MatchRule" | "Invalid") | string)␊ - /**␊ - * List of match conditions.␊ - */␊ - matchConditions: (MatchCondition11[] | string)␊ - /**␊ - * Type of Actions.␊ - */␊ - action: (("Allow" | "Block" | "Log") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Define match conditions.␊ - */␊ - export interface MatchCondition11 {␊ - /**␊ - * List of match variables.␊ - */␊ - matchVariables: (MatchVariable9[] | string)␊ - /**␊ - * The operator to be matched.␊ - */␊ - operator: (("IPMatch" | "Equal" | "Contains" | "LessThan" | "GreaterThan" | "LessThanOrEqual" | "GreaterThanOrEqual" | "BeginsWith" | "EndsWith" | "Regex" | "GeoMatch") | string)␊ - /**␊ - * Whether this is negate condition or not.␊ - */␊ - negationConditon?: (boolean | string)␊ - /**␊ - * Match value.␊ - */␊ - matchValues: (string[] | string)␊ - /**␊ - * List of transforms.␊ - */␊ - transforms?: (("Lowercase" | "Trim" | "UrlDecode" | "UrlEncode" | "RemoveNulls" | "HtmlEntityDecode")[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Define match variables.␊ - */␊ - export interface MatchVariable9 {␊ - /**␊ - * Match Variable.␊ - */␊ - variableName: (("RemoteAddr" | "RequestMethod" | "QueryString" | "PostArgs" | "RequestUri" | "RequestHeaders" | "RequestBody" | "RequestCookies") | string)␊ - /**␊ - * The selector of match variable.␊ - */␊ - selector?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allow to exclude some variable satisfy the condition for the WAF check.␊ - */␊ - export interface ManagedRulesDefinition4 {␊ - /**␊ - * The Exclusions that are applied on the policy.␊ - */␊ - exclusions?: (OwaspCrsExclusionEntry4[] | string)␊ - /**␊ - * The managed rule sets that are associated with the policy.␊ - */␊ - managedRuleSets: (ManagedRuleSet6[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allow to exclude some variable satisfy the condition for the WAF check.␊ - */␊ - export interface OwaspCrsExclusionEntry4 {␊ - /**␊ - * The variable to be excluded.␊ - */␊ - matchVariable: (("RequestHeaderNames" | "RequestCookieNames" | "RequestArgNames") | string)␊ - /**␊ - * When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to.␊ - */␊ - selectorMatchOperator: (("Equals" | "Contains" | "StartsWith" | "EndsWith" | "EqualsAny") | string)␊ - /**␊ - * When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to.␊ - */␊ - selector: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines a managed rule set.␊ - */␊ - export interface ManagedRuleSet6 {␊ - /**␊ - * Defines the rule set type to use.␊ - */␊ - ruleSetType: string␊ - /**␊ - * Defines the version of the rule set to use.␊ - */␊ - ruleSetVersion: string␊ - /**␊ - * Defines the rule group overrides to apply to the rule set.␊ - */␊ - ruleGroupOverrides?: (ManagedRuleGroupOverride6[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines a managed rule group override setting.␊ - */␊ - export interface ManagedRuleGroupOverride6 {␊ - /**␊ - * The managed rule group to override.␊ - */␊ - ruleGroupName: string␊ - /**␊ - * List of rules that will be disabled. If none specified, all rules in the group will be disabled.␊ - */␊ - rules?: (ManagedRuleOverride6[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines a managed rule group override setting.␊ - */␊ - export interface ManagedRuleOverride6 {␊ - /**␊ - * Identifier for the managed rule.␊ - */␊ - ruleId: string␊ - /**␊ - * The state of the managed rule. Defaults to Disabled if not specified.␊ - */␊ - state?: ("Disabled" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/applicationSecurityGroups␊ - */␊ - export interface ApplicationSecurityGroups20 {␊ - name: string␊ - type: "Microsoft.Network/applicationSecurityGroups"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the application security group.␊ - */␊ - properties: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/azureFirewalls␊ - */␊ - export interface AzureFirewalls10 {␊ - name: string␊ - type: "Microsoft.Network/azureFirewalls"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the azure firewall.␊ - */␊ - properties: (AzureFirewallPropertiesFormat10 | string)␊ - /**␊ - * A list of availability zones denoting where the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Azure Firewall.␊ - */␊ - export interface AzureFirewallPropertiesFormat10 {␊ - /**␊ - * Collection of application rule collections used by Azure Firewall.␊ - */␊ - applicationRuleCollections?: (AzureFirewallApplicationRuleCollection10[] | string)␊ - /**␊ - * Collection of NAT rule collections used by Azure Firewall.␊ - */␊ - natRuleCollections?: (AzureFirewallNatRuleCollection7[] | string)␊ - /**␊ - * Collection of network rule collections used by Azure Firewall.␊ - */␊ - networkRuleCollections?: (AzureFirewallNetworkRuleCollection10[] | string)␊ - /**␊ - * IP configuration of the Azure Firewall resource.␊ - */␊ - ipConfigurations?: (AzureFirewallIPConfiguration10[] | string)␊ - /**␊ - * IP configuration of the Azure Firewall used for management traffic.␊ - */␊ - managementIpConfiguration?: (AzureFirewallIPConfiguration10 | string)␊ - /**␊ - * The operation mode for Threat Intelligence.␊ - */␊ - threatIntelMode?: (("Alert" | "Deny" | "Off") | string)␊ - /**␊ - * The virtualHub to which the firewall belongs.␊ - */␊ - virtualHub?: (SubResource33 | string)␊ - /**␊ - * The firewallPolicy associated with this azure firewall.␊ - */␊ - firewallPolicy?: (SubResource33 | string)␊ - /**␊ - * The Azure Firewall Resource SKU.␊ - */␊ - sku?: (AzureFirewallSku4 | string)␊ - /**␊ - * The additional properties used to further config this azure firewall.␊ - */␊ - additionalProperties?: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application rule collection resource.␊ - */␊ - export interface AzureFirewallApplicationRuleCollection10 {␊ - /**␊ - * Properties of the azure firewall application rule collection.␊ - */␊ - properties?: (AzureFirewallApplicationRuleCollectionPropertiesFormat10 | string)␊ - /**␊ - * The name of the resource that is unique within the Azure firewall. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application rule collection.␊ - */␊ - export interface AzureFirewallApplicationRuleCollectionPropertiesFormat10 {␊ - /**␊ - * Priority of the application rule collection resource.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * The action type of a rule collection.␊ - */␊ - action?: (AzureFirewallRCAction10 | string)␊ - /**␊ - * Collection of rules used by a application rule collection.␊ - */␊ - rules?: (AzureFirewallApplicationRule10[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the AzureFirewallRCAction.␊ - */␊ - export interface AzureFirewallRCAction10 {␊ - /**␊ - * The type of action.␊ - */␊ - type?: ("Allow" | "Deny")␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of an application rule.␊ - */␊ - export interface AzureFirewallApplicationRule10 {␊ - /**␊ - * Name of the application rule.␊ - */␊ - name?: string␊ - /**␊ - * Description of the rule.␊ - */␊ - description?: string␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * Array of ApplicationRuleProtocols.␊ - */␊ - protocols?: (AzureFirewallApplicationRuleProtocol10[] | string)␊ - /**␊ - * List of FQDNs for this rule.␊ - */␊ - targetFqdns?: (string[] | string)␊ - /**␊ - * List of FQDN Tags for this rule.␊ - */␊ - fqdnTags?: (string[] | string)␊ - /**␊ - * List of source IpGroups for this rule.␊ - */␊ - sourceIpGroups?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application rule protocol.␊ - */␊ - export interface AzureFirewallApplicationRuleProtocol10 {␊ - /**␊ - * Protocol type.␊ - */␊ - protocolType?: (("Http" | "Https" | "Mssql") | string)␊ - /**␊ - * Port number for the protocol, cannot be greater than 64000. This field is optional.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NAT rule collection resource.␊ - */␊ - export interface AzureFirewallNatRuleCollection7 {␊ - /**␊ - * Properties of the azure firewall NAT rule collection.␊ - */␊ - properties?: (AzureFirewallNatRuleCollectionProperties7 | string)␊ - /**␊ - * The name of the resource that is unique within the Azure firewall. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the NAT rule collection.␊ - */␊ - export interface AzureFirewallNatRuleCollectionProperties7 {␊ - /**␊ - * Priority of the NAT rule collection resource.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * The action type of a NAT rule collection.␊ - */␊ - action?: (AzureFirewallNatRCAction7 | string)␊ - /**␊ - * Collection of rules used by a NAT rule collection.␊ - */␊ - rules?: (AzureFirewallNatRule7[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AzureFirewall NAT Rule Collection Action.␊ - */␊ - export interface AzureFirewallNatRCAction7 {␊ - /**␊ - * The type of action.␊ - */␊ - type?: ("Snat" | "Dnat")␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a NAT rule.␊ - */␊ - export interface AzureFirewallNatRule7 {␊ - /**␊ - * Name of the NAT rule.␊ - */␊ - name?: string␊ - /**␊ - * Description of the rule.␊ - */␊ - description?: string␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags.␊ - */␊ - destinationAddresses?: (string[] | string)␊ - /**␊ - * List of destination ports.␊ - */␊ - destinationPorts?: (string[] | string)␊ - /**␊ - * Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule.␊ - */␊ - protocols?: (("TCP" | "UDP" | "Any" | "ICMP")[] | string)␊ - /**␊ - * The translated address for this NAT rule.␊ - */␊ - translatedAddress?: string␊ - /**␊ - * The translated port for this NAT rule.␊ - */␊ - translatedPort?: string␊ - /**␊ - * The translated FQDN for this NAT rule.␊ - */␊ - translatedFqdn?: string␊ - /**␊ - * List of source IpGroups for this rule.␊ - */␊ - sourceIpGroups?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network rule collection resource.␊ - */␊ - export interface AzureFirewallNetworkRuleCollection10 {␊ - /**␊ - * Properties of the azure firewall network rule collection.␊ - */␊ - properties?: (AzureFirewallNetworkRuleCollectionPropertiesFormat10 | string)␊ - /**␊ - * The name of the resource that is unique within the Azure firewall. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the network rule collection.␊ - */␊ - export interface AzureFirewallNetworkRuleCollectionPropertiesFormat10 {␊ - /**␊ - * Priority of the network rule collection resource.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * The action type of a rule collection.␊ - */␊ - action?: (AzureFirewallRCAction10 | string)␊ - /**␊ - * Collection of rules used by a network rule collection.␊ - */␊ - rules?: (AzureFirewallNetworkRule10[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the network rule.␊ - */␊ - export interface AzureFirewallNetworkRule10 {␊ - /**␊ - * Name of the network rule.␊ - */␊ - name?: string␊ - /**␊ - * Description of the rule.␊ - */␊ - description?: string␊ - /**␊ - * Array of AzureFirewallNetworkRuleProtocols.␊ - */␊ - protocols?: (("TCP" | "UDP" | "Any" | "ICMP")[] | string)␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * List of destination IP addresses.␊ - */␊ - destinationAddresses?: (string[] | string)␊ - /**␊ - * List of destination ports.␊ - */␊ - destinationPorts?: (string[] | string)␊ - /**␊ - * List of destination FQDNs.␊ - */␊ - destinationFqdns?: (string[] | string)␊ - /**␊ - * List of source IpGroups for this rule.␊ - */␊ - sourceIpGroups?: (string[] | string)␊ - /**␊ - * List of destination IpGroups for this rule.␊ - */␊ - destinationIpGroups?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration of an Azure Firewall.␊ - */␊ - export interface AzureFirewallIPConfiguration10 {␊ - /**␊ - * Properties of the azure firewall IP configuration.␊ - */␊ - properties?: (AzureFirewallIPConfigurationPropertiesFormat10 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration of an Azure Firewall.␊ - */␊ - export interface AzureFirewallIPConfigurationPropertiesFormat10 {␊ - /**␊ - * Reference to the subnet resource. This resource must be named 'AzureFirewallSubnet' or 'AzureFirewallManagementSubnet'.␊ - */␊ - subnet?: (SubResource33 | string)␊ - /**␊ - * Reference to the PublicIP resource. This field is a mandatory input if subnet is not null.␊ - */␊ - publicIPAddress?: (SubResource33 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of an Azure Firewall.␊ - */␊ - export interface AzureFirewallSku4 {␊ - /**␊ - * Name of an Azure Firewall SKU.␊ - */␊ - name?: (("AZFW_VNet" | "AZFW_Hub") | string)␊ - /**␊ - * Tier of an Azure Firewall.␊ - */␊ - tier?: ("Standard" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/bastionHosts␊ - */␊ - export interface BastionHosts7 {␊ - /**␊ - * The name of the Bastion Host.␊ - */␊ - name: string␊ - type: "Microsoft.Network/bastionHosts"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Represents the bastion host resource.␊ - */␊ - properties: (BastionHostPropertiesFormat7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Bastion Host.␊ - */␊ - export interface BastionHostPropertiesFormat7 {␊ - /**␊ - * IP configuration of the Bastion Host resource.␊ - */␊ - ipConfigurations?: (BastionHostIPConfiguration7[] | string)␊ - /**␊ - * FQDN for the endpoint on which bastion host is accessible.␊ - */␊ - dnsName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration of an Bastion Host.␊ - */␊ - export interface BastionHostIPConfiguration7 {␊ - /**␊ - * Represents the ip configuration associated with the resource.␊ - */␊ - properties?: (BastionHostIPConfigurationPropertiesFormat7 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration of an Bastion Host.␊ - */␊ - export interface BastionHostIPConfigurationPropertiesFormat7 {␊ - /**␊ - * Reference of the subnet resource.␊ - */␊ - subnet: (SubResource33 | string)␊ - /**␊ - * Reference of the PublicIP resource.␊ - */␊ - publicIPAddress: (SubResource33 | string)␊ - /**␊ - * Private IP allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/connections␊ - */␊ - export interface Connections25 {␊ - name: string␊ - type: "Microsoft.Network/connections"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway connection.␊ - */␊ - properties: (VirtualNetworkGatewayConnectionPropertiesFormat25 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewayConnection properties.␊ - */␊ - export interface VirtualNetworkGatewayConnectionPropertiesFormat25 {␊ - /**␊ - * The authorizationKey.␊ - */␊ - authorizationKey?: string␊ - /**␊ - * The reference to virtual network gateway resource.␊ - */␊ - virtualNetworkGateway1: (SubResource33 | string)␊ - /**␊ - * The reference to virtual network gateway resource.␊ - */␊ - virtualNetworkGateway2?: (SubResource33 | string)␊ - /**␊ - * The reference to local network gateway resource.␊ - */␊ - localNetworkGateway2?: (SubResource33 | string)␊ - /**␊ - * Gateway connection type.␊ - */␊ - connectionType: (("IPsec" | "Vnet2Vnet" | "ExpressRoute" | "VPNClient") | string)␊ - /**␊ - * Connection protocol used for this connection.␊ - */␊ - connectionProtocol?: (("IKEv2" | "IKEv1") | string)␊ - /**␊ - * The routing weight.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * The dead peer detection timeout of this connection in seconds.␊ - */␊ - dpdTimeoutSeconds?: (number | string)␊ - /**␊ - * The IPSec shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The reference to peerings resource.␊ - */␊ - peer?: (SubResource33 | string)␊ - /**␊ - * EnableBgp flag.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * Use private local Azure IP for the connection.␊ - */␊ - useLocalAzureIpAddress?: (boolean | string)␊ - /**␊ - * Enable policy-based traffic selectors.␊ - */␊ - usePolicyBasedTrafficSelectors?: (boolean | string)␊ - /**␊ - * The IPSec Policies to be considered by this connection.␊ - */␊ - ipsecPolicies?: (IpsecPolicy22[] | string)␊ - /**␊ - * The Traffic Selector Policies to be considered by this connection.␊ - */␊ - trafficSelectorPolicies?: (TrafficSelectorPolicy5[] | string)␊ - /**␊ - * Bypass ExpressRoute Gateway for data forwarding.␊ - */␊ - expressRouteGatewayBypass?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An IPSec Policy configuration for a virtual network gateway connection.␊ - */␊ - export interface IpsecPolicy22 {␊ - /**␊ - * The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.␊ - */␊ - saLifeTimeSeconds: (number | string)␊ - /**␊ - * The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.␊ - */␊ - saDataSizeKilobytes: (number | string)␊ - /**␊ - * The IPSec encryption algorithm (IKE phase 1).␊ - */␊ - ipsecEncryption: (("None" | "DES" | "DES3" | "AES128" | "AES192" | "AES256" | "GCMAES128" | "GCMAES192" | "GCMAES256") | string)␊ - /**␊ - * The IPSec integrity algorithm (IKE phase 1).␊ - */␊ - ipsecIntegrity: (("MD5" | "SHA1" | "SHA256" | "GCMAES128" | "GCMAES192" | "GCMAES256") | string)␊ - /**␊ - * The IKE encryption algorithm (IKE phase 2).␊ - */␊ - ikeEncryption: (("DES" | "DES3" | "AES128" | "AES192" | "AES256" | "GCMAES256" | "GCMAES128") | string)␊ - /**␊ - * The IKE integrity algorithm (IKE phase 2).␊ - */␊ - ikeIntegrity: (("MD5" | "SHA1" | "SHA256" | "SHA384" | "GCMAES256" | "GCMAES128") | string)␊ - /**␊ - * The DH Group used in IKE Phase 1 for initial SA.␊ - */␊ - dhGroup: (("None" | "DHGroup1" | "DHGroup2" | "DHGroup14" | "DHGroup2048" | "ECP256" | "ECP384" | "DHGroup24") | string)␊ - /**␊ - * The Pfs Group used in IKE Phase 2 for new child SA.␊ - */␊ - pfsGroup: (("None" | "PFS1" | "PFS2" | "PFS2048" | "ECP256" | "ECP384" | "PFS24" | "PFS14" | "PFSMM") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An traffic selector policy for a virtual network gateway connection.␊ - */␊ - export interface TrafficSelectorPolicy5 {␊ - /**␊ - * A collection of local address spaces in CIDR format.␊ - */␊ - localAddressRanges: (string[] | string)␊ - /**␊ - * A collection of remote address spaces in CIDR format.␊ - */␊ - remoteAddressRanges: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ddosCustomPolicies␊ - */␊ - export interface DdosCustomPolicies7 {␊ - name: string␊ - type: "Microsoft.Network/ddosCustomPolicies"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the DDoS custom policy.␊ - */␊ - properties: (DdosCustomPolicyPropertiesFormat7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DDoS custom policy properties.␊ - */␊ - export interface DdosCustomPolicyPropertiesFormat7 {␊ - /**␊ - * The protocol-specific DDoS policy customization parameters.␊ - */␊ - protocolCustomSettings?: (ProtocolCustomSettingsFormat7[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DDoS custom policy properties.␊ - */␊ - export interface ProtocolCustomSettingsFormat7 {␊ - /**␊ - * The protocol for which the DDoS protection policy is being customized.␊ - */␊ - protocol?: (("Tcp" | "Udp" | "Syn") | string)␊ - /**␊ - * The customized DDoS protection trigger rate.␊ - */␊ - triggerRateOverride?: string␊ - /**␊ - * The customized DDoS protection source rate.␊ - */␊ - sourceRateOverride?: string␊ - /**␊ - * The customized DDoS protection trigger rate sensitivity degrees. High: Trigger rate set with most sensitivity w.r.t. normal traffic. Default: Trigger rate set with moderate sensitivity w.r.t. normal traffic. Low: Trigger rate set with less sensitivity w.r.t. normal traffic. Relaxed: Trigger rate set with least sensitivity w.r.t. normal traffic.␊ - */␊ - triggerSensitivityOverride?: (("Relaxed" | "Low" | "Default" | "High") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ddosProtectionPlans␊ - */␊ - export interface DdosProtectionPlans16 {␊ - name: string␊ - type: "Microsoft.Network/ddosProtectionPlans"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the DDoS protection plan.␊ - */␊ - properties: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits␊ - */␊ - export interface ExpressRouteCircuits18 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The SKU.␊ - */␊ - sku?: (ExpressRouteCircuitSku18 | string)␊ - /**␊ - * Properties of the express route circuit.␊ - */␊ - properties: (ExpressRouteCircuitPropertiesFormat18 | string)␊ - resources?: (ExpressRouteCircuitsPeeringsChildResource18 | ExpressRouteCircuitsAuthorizationsChildResource18)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains SKU in an ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitSku18 {␊ - /**␊ - * The name of the SKU.␊ - */␊ - name?: string␊ - /**␊ - * The tier of the SKU.␊ - */␊ - tier?: (("Standard" | "Premium" | "Basic" | "Local") | string)␊ - /**␊ - * The family of the SKU.␊ - */␊ - family?: (("UnlimitedData" | "MeteredData") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitPropertiesFormat18 {␊ - /**␊ - * Allow classic operations.␊ - */␊ - allowClassicOperations?: (boolean | string)␊ - /**␊ - * The list of authorizations.␊ - */␊ - authorizations?: (ExpressRouteCircuitAuthorization18[] | string)␊ - /**␊ - * The list of peerings.␊ - */␊ - peerings?: (ExpressRouteCircuitPeering18[] | string)␊ - /**␊ - * The ServiceProviderNotes.␊ - */␊ - serviceProviderNotes?: string␊ - /**␊ - * The ServiceProviderProperties.␊ - */␊ - serviceProviderProperties?: (ExpressRouteCircuitServiceProviderProperties18 | string)␊ - /**␊ - * The reference to the ExpressRoutePort resource when the circuit is provisioned on an ExpressRoutePort resource.␊ - */␊ - expressRoutePort?: (SubResource33 | string)␊ - /**␊ - * The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource.␊ - */␊ - bandwidthInGbps?: (number | string)␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authorization in an ExpressRouteCircuit resource.␊ - */␊ - export interface ExpressRouteCircuitAuthorization18 {␊ - /**␊ - * Properties of the express route circuit authorization.␊ - */␊ - properties?: ({␊ - [k: string]: unknown␊ - } | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peering in an ExpressRouteCircuit resource.␊ - */␊ - export interface ExpressRouteCircuitPeering18 {␊ - /**␊ - * Properties of the express route circuit peering.␊ - */␊ - properties?: (ExpressRouteCircuitPeeringPropertiesFormat19 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the express route circuit peering.␊ - */␊ - export interface ExpressRouteCircuitPeeringPropertiesFormat19 {␊ - /**␊ - * The peering type.␊ - */␊ - peeringType?: (("AzurePublicPeering" | "AzurePrivatePeering" | "MicrosoftPeering") | string)␊ - /**␊ - * The peering state.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * The peer ASN.␊ - */␊ - peerASN?: (number | string)␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The VLAN ID.␊ - */␊ - vlanId?: (number | string)␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig19 | string)␊ - /**␊ - * The peering stats of express route circuit.␊ - */␊ - stats?: (ExpressRouteCircuitStats19 | string)␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - /**␊ - * The reference to the RouteFilter resource.␊ - */␊ - routeFilter?: (SubResource33 | string)␊ - /**␊ - * The IPv6 peering configuration.␊ - */␊ - ipv6PeeringConfig?: (Ipv6ExpressRouteCircuitPeeringConfig16 | string)␊ - /**␊ - * The ExpressRoute connection.␊ - */␊ - expressRouteConnection?: (SubResource33 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the peering configuration.␊ - */␊ - export interface ExpressRouteCircuitPeeringConfig19 {␊ - /**␊ - * The reference to AdvertisedPublicPrefixes.␊ - */␊ - advertisedPublicPrefixes?: (string[] | string)␊ - /**␊ - * The communities of bgp peering. Specified for microsoft peering.␊ - */␊ - advertisedCommunities?: (string[] | string)␊ - /**␊ - * The legacy mode of the peering.␊ - */␊ - legacyMode?: (number | string)␊ - /**␊ - * The CustomerASN of the peering.␊ - */␊ - customerASN?: (number | string)␊ - /**␊ - * The RoutingRegistryName of the configuration.␊ - */␊ - routingRegistryName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains stats associated with the peering.␊ - */␊ - export interface ExpressRouteCircuitStats19 {␊ - /**␊ - * The Primary BytesIn of the peering.␊ - */␊ - primarybytesIn?: (number | string)␊ - /**␊ - * The primary BytesOut of the peering.␊ - */␊ - primarybytesOut?: (number | string)␊ - /**␊ - * The secondary BytesIn of the peering.␊ - */␊ - secondarybytesIn?: (number | string)␊ - /**␊ - * The secondary BytesOut of the peering.␊ - */␊ - secondarybytesOut?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains IPv6 peering config.␊ - */␊ - export interface Ipv6ExpressRouteCircuitPeeringConfig16 {␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig19 | string)␊ - /**␊ - * The reference to the RouteFilter resource.␊ - */␊ - routeFilter?: (SubResource33 | string)␊ - /**␊ - * The state of peering.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains ServiceProviderProperties in an ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitServiceProviderProperties18 {␊ - /**␊ - * The serviceProviderName.␊ - */␊ - serviceProviderName?: string␊ - /**␊ - * The peering location.␊ - */␊ - peeringLocation?: string␊ - /**␊ - * The BandwidthInMbps.␊ - */␊ - bandwidthInMbps?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings␊ - */␊ - export interface ExpressRouteCircuitsPeeringsChildResource18 {␊ - name: string␊ - type: "peerings"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Properties of the express route circuit peering.␊ - */␊ - properties: (ExpressRouteCircuitPeeringPropertiesFormat19 | string)␊ - resources?: ExpressRouteCircuitsPeeringsConnectionsChildResource16[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings/connections␊ - */␊ - export interface ExpressRouteCircuitsPeeringsConnectionsChildResource16 {␊ - name: string␊ - type: "connections"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Properties of the express route circuit connection.␊ - */␊ - properties: (ExpressRouteCircuitConnectionPropertiesFormat16 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the express route circuit connection.␊ - */␊ - export interface ExpressRouteCircuitConnectionPropertiesFormat16 {␊ - /**␊ - * Reference to Express Route Circuit Private Peering Resource of the circuit initiating connection.␊ - */␊ - expressRouteCircuitPeering?: (SubResource33 | string)␊ - /**␊ - * Reference to Express Route Circuit Private Peering Resource of the peered circuit.␊ - */␊ - peerExpressRouteCircuitPeering?: (SubResource33 | string)␊ - /**␊ - * /29 IP address space to carve out Customer addresses for tunnels.␊ - */␊ - addressPrefix?: string␊ - /**␊ - * The authorization key.␊ - */␊ - authorizationKey?: string␊ - /**␊ - * IPv6 Address PrefixProperties of the express route circuit connection.␊ - */␊ - ipv6CircuitConnectionConfig?: (Ipv6CircuitConnectionConfig1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IPv6 Circuit Connection properties for global reach.␊ - */␊ - export interface Ipv6CircuitConnectionConfig1 {␊ - /**␊ - * /125 IP address space to carve out customer addresses for global reach.␊ - */␊ - addressPrefix?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/authorizations␊ - */␊ - export interface ExpressRouteCircuitsAuthorizationsChildResource18 {␊ - name: string␊ - type: "authorizations"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Properties of the express route circuit authorization.␊ - */␊ - properties: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/authorizations␊ - */␊ - export interface ExpressRouteCircuitsAuthorizations19 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/authorizations"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Properties of the express route circuit authorization.␊ - */␊ - properties: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings␊ - */␊ - export interface ExpressRouteCircuitsPeerings19 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/peerings"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Properties of the express route circuit peering.␊ - */␊ - properties: (ExpressRouteCircuitPeeringPropertiesFormat19 | string)␊ - resources?: ExpressRouteCircuitsPeeringsConnectionsChildResource16[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings/connections␊ - */␊ - export interface ExpressRouteCircuitsPeeringsConnections16 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/peerings/connections"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Properties of the express route circuit connection.␊ - */␊ - properties: (ExpressRouteCircuitConnectionPropertiesFormat16 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections␊ - */␊ - export interface ExpressRouteCrossConnections16 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCrossConnections"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the express route cross connection.␊ - */␊ - properties: (ExpressRouteCrossConnectionProperties16 | string)␊ - resources?: ExpressRouteCrossConnectionsPeeringsChildResource16[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ExpressRouteCrossConnection.␊ - */␊ - export interface ExpressRouteCrossConnectionProperties16 {␊ - /**␊ - * The peering location of the ExpressRoute circuit.␊ - */␊ - peeringLocation?: string␊ - /**␊ - * The circuit bandwidth In Mbps.␊ - */␊ - bandwidthInMbps?: (number | string)␊ - /**␊ - * The ExpressRouteCircuit.␊ - */␊ - expressRouteCircuit?: (SubResource33 | string)␊ - /**␊ - * The provisioning state of the circuit in the connectivity provider system.␊ - */␊ - serviceProviderProvisioningState?: (("NotProvisioned" | "Provisioning" | "Provisioned" | "Deprovisioning") | string)␊ - /**␊ - * Additional read only notes set by the connectivity provider.␊ - */␊ - serviceProviderNotes?: string␊ - /**␊ - * The list of peerings.␊ - */␊ - peerings?: (ExpressRouteCrossConnectionPeering16[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peering in an ExpressRoute Cross Connection resource.␊ - */␊ - export interface ExpressRouteCrossConnectionPeering16 {␊ - /**␊ - * Properties of the express route cross connection peering.␊ - */␊ - properties?: (ExpressRouteCrossConnectionPeeringProperties16 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of express route cross connection peering.␊ - */␊ - export interface ExpressRouteCrossConnectionPeeringProperties16 {␊ - /**␊ - * The peering type.␊ - */␊ - peeringType?: (("AzurePublicPeering" | "AzurePrivatePeering" | "MicrosoftPeering") | string)␊ - /**␊ - * The peering state.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * The peer ASN.␊ - */␊ - peerASN?: (number | string)␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The VLAN ID.␊ - */␊ - vlanId?: (number | string)␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig19 | string)␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - /**␊ - * The IPv6 peering configuration.␊ - */␊ - ipv6PeeringConfig?: (Ipv6ExpressRouteCircuitPeeringConfig16 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections/peerings␊ - */␊ - export interface ExpressRouteCrossConnectionsPeeringsChildResource16 {␊ - name: string␊ - type: "peerings"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Properties of the express route cross connection peering.␊ - */␊ - properties: (ExpressRouteCrossConnectionPeeringProperties16 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections/peerings␊ - */␊ - export interface ExpressRouteCrossConnectionsPeerings16 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCrossConnections/peerings"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Properties of the express route cross connection peering.␊ - */␊ - properties: (ExpressRouteCrossConnectionPeeringProperties16 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteGateways␊ - */␊ - export interface ExpressRouteGateways7 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteGateways"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the express route gateway.␊ - */␊ - properties: (ExpressRouteGatewayProperties7 | string)␊ - resources?: ExpressRouteGatewaysExpressRouteConnectionsChildResource7[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ExpressRoute gateway resource properties.␊ - */␊ - export interface ExpressRouteGatewayProperties7 {␊ - /**␊ - * Configuration for auto scaling.␊ - */␊ - autoScaleConfiguration?: (ExpressRouteGatewayPropertiesAutoScaleConfiguration7 | string)␊ - /**␊ - * The Virtual Hub where the ExpressRoute gateway is or will be deployed.␊ - */␊ - virtualHub: (SubResource33 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Configuration for auto scaling.␊ - */␊ - export interface ExpressRouteGatewayPropertiesAutoScaleConfiguration7 {␊ - /**␊ - * Minimum and maximum number of scale units to deploy.␊ - */␊ - bounds?: (ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Minimum and maximum number of scale units to deploy.␊ - */␊ - export interface ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds7 {␊ - /**␊ - * Minimum number of scale units deployed for ExpressRoute gateway.␊ - */␊ - min?: (number | string)␊ - /**␊ - * Maximum number of scale units deployed for ExpressRoute gateway.␊ - */␊ - max?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteGateways/expressRouteConnections␊ - */␊ - export interface ExpressRouteGatewaysExpressRouteConnectionsChildResource7 {␊ - name: string␊ - type: "expressRouteConnections"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Properties of the express route connection.␊ - */␊ - properties: (ExpressRouteConnectionProperties7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the ExpressRouteConnection subresource.␊ - */␊ - export interface ExpressRouteConnectionProperties7 {␊ - /**␊ - * The ExpressRoute circuit peering.␊ - */␊ - expressRouteCircuitPeering: (SubResource33 | string)␊ - /**␊ - * Authorization key to establish the connection.␊ - */␊ - authorizationKey?: string␊ - /**␊ - * The routing weight associated to the connection.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * Enable internet security.␊ - */␊ - enableInternetSecurity?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteGateways/expressRouteConnections␊ - */␊ - export interface ExpressRouteGatewaysExpressRouteConnections7 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteGateways/expressRouteConnections"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Properties of the express route connection.␊ - */␊ - properties: (ExpressRouteConnectionProperties7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ExpressRoutePorts␊ - */␊ - export interface ExpressRoutePorts12 {␊ - name: string␊ - type: "Microsoft.Network/ExpressRoutePorts"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * ExpressRoutePort properties.␊ - */␊ - properties: (ExpressRoutePortPropertiesFormat12 | string)␊ - /**␊ - * The identity of ExpressRoutePort, if configured.␊ - */␊ - identity?: (ManagedServiceIdentity11 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to ExpressRoutePort resources.␊ - */␊ - export interface ExpressRoutePortPropertiesFormat12 {␊ - /**␊ - * The name of the peering location that the ExpressRoutePort is mapped to physically.␊ - */␊ - peeringLocation?: string␊ - /**␊ - * Bandwidth of procured ports in Gbps.␊ - */␊ - bandwidthInGbps?: (number | string)␊ - /**␊ - * Encapsulation method on physical ports.␊ - */␊ - encapsulation?: (("Dot1Q" | "QinQ") | string)␊ - /**␊ - * The set of physical links of the ExpressRoutePort resource.␊ - */␊ - links?: (ExpressRouteLink12[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ExpressRouteLink child resource definition.␊ - */␊ - export interface ExpressRouteLink12 {␊ - /**␊ - * ExpressRouteLink properties.␊ - */␊ - properties?: (ExpressRouteLinkPropertiesFormat12 | string)␊ - /**␊ - * Name of child port resource that is unique among child port resources of the parent.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to ExpressRouteLink resources.␊ - */␊ - export interface ExpressRouteLinkPropertiesFormat12 {␊ - /**␊ - * Administrative state of the physical port.␊ - */␊ - adminState?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * MacSec configuration.␊ - */␊ - macSecConfig?: (ExpressRouteLinkMacSecConfig5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ExpressRouteLink Mac Security Configuration.␊ - */␊ - export interface ExpressRouteLinkMacSecConfig5 {␊ - /**␊ - * Keyvault Secret Identifier URL containing Mac security CKN key.␊ - */␊ - cknSecretIdentifier?: string␊ - /**␊ - * Keyvault Secret Identifier URL containing Mac security CAK key.␊ - */␊ - cakSecretIdentifier?: string␊ - /**␊ - * Mac security cipher.␊ - */␊ - cipher?: (("gcm-aes-128" | "gcm-aes-256") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/firewallPolicies␊ - */␊ - export interface FirewallPolicies6 {␊ - name: string␊ - type: "Microsoft.Network/firewallPolicies"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the firewall policy.␊ - */␊ - properties: (FirewallPolicyPropertiesFormat6 | string)␊ - resources?: FirewallPoliciesRuleGroupsChildResource6[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Firewall Policy definition.␊ - */␊ - export interface FirewallPolicyPropertiesFormat6 {␊ - /**␊ - * The parent firewall policy from which rules are inherited.␊ - */␊ - basePolicy?: (SubResource33 | string)␊ - /**␊ - * The operation mode for Threat Intelligence.␊ - */␊ - threatIntelMode?: (("Alert" | "Deny" | "Off") | string)␊ - /**␊ - * The operation mode for Intrusion system.␊ - */␊ - intrusionSystemMode?: (("Enabled" | "Disabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/firewallPolicies/ruleGroups␊ - */␊ - export interface FirewallPoliciesRuleGroupsChildResource6 {␊ - name: string␊ - type: "ruleGroups"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * The properties of the firewall policy rule group.␊ - */␊ - properties: (FirewallPolicyRuleGroupProperties6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the rule group.␊ - */␊ - export interface FirewallPolicyRuleGroupProperties6 {␊ - /**␊ - * Priority of the Firewall Policy Rule Group resource.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * Group of Firewall Policy rules.␊ - */␊ - rules?: (FirewallPolicyRule6[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the FirewallPolicyNatRuleAction.␊ - */␊ - export interface FirewallPolicyNatRuleAction6 {␊ - /**␊ - * The type of action.␊ - */␊ - type?: "DNAT"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application rule protocol.␊ - */␊ - export interface FirewallPolicyRuleConditionApplicationProtocol6 {␊ - /**␊ - * Protocol type.␊ - */␊ - protocolType?: (("Http" | "Https") | string)␊ - /**␊ - * Port number for the protocol, cannot be greater than 64000.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the FirewallPolicyFilterRuleAction.␊ - */␊ - export interface FirewallPolicyFilterRuleAction6 {␊ - /**␊ - * The type of action.␊ - */␊ - type?: ("Allow" | "Deny")␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/firewallPolicies/ruleGroups␊ - */␊ - export interface FirewallPoliciesRuleGroups6 {␊ - name: string␊ - type: "Microsoft.Network/firewallPolicies/ruleGroups"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * The properties of the firewall policy rule group.␊ - */␊ - properties: (FirewallPolicyRuleGroupProperties6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/IpAllocations␊ - */␊ - export interface IpAllocations {␊ - name: string␊ - type: "Microsoft.Network/IpAllocations"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the IpAllocation.␊ - */␊ - properties: (IpAllocationPropertiesFormat | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the IpAllocation.␊ - */␊ - export interface IpAllocationPropertiesFormat {␊ - /**␊ - * The type for the IpAllocation.␊ - */␊ - type?: ("Undefined" | "Hypernet")␊ - /**␊ - * The address prefix for the IpAllocation.␊ - */␊ - prefix?: string␊ - /**␊ - * The address prefix length for the IpAllocation.␊ - */␊ - prefixLength?: ((number & string) | string)␊ - /**␊ - * The address prefix Type for the IpAllocation.␊ - */␊ - prefixType?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The IPAM allocation ID.␊ - */␊ - ipamAllocationId?: string␊ - /**␊ - * IpAllocation tags.␊ - */␊ - allocationTags?: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ipGroups␊ - */␊ - export interface IpGroups3 {␊ - name: string␊ - type: "Microsoft.Network/ipGroups"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the IpGroups.␊ - */␊ - properties: (IpGroupPropertiesFormat3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The IpGroups property information.␊ - */␊ - export interface IpGroupPropertiesFormat3 {␊ - /**␊ - * IpAddresses/IpAddressPrefixes in the IpGroups resource.␊ - */␊ - ipAddresses?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers␊ - */␊ - export interface LoadBalancers33 {␊ - name: string␊ - type: "Microsoft.Network/loadBalancers"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The load balancer SKU.␊ - */␊ - sku?: (LoadBalancerSku21 | string)␊ - /**␊ - * Properties of load balancer.␊ - */␊ - properties: (LoadBalancerPropertiesFormat25 | string)␊ - resources?: LoadBalancersInboundNatRulesChildResource21[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a load balancer.␊ - */␊ - export interface LoadBalancerSku21 {␊ - /**␊ - * Name of a load balancer SKU.␊ - */␊ - name?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer.␊ - */␊ - export interface LoadBalancerPropertiesFormat25 {␊ - /**␊ - * Object representing the frontend IPs to be used for the load balancer.␊ - */␊ - frontendIPConfigurations?: (FrontendIPConfiguration24[] | string)␊ - /**␊ - * Collection of backend address pools used by a load balancer.␊ - */␊ - backendAddressPools?: (BackendAddressPool25[] | string)␊ - /**␊ - * Object collection representing the load balancing rules Gets the provisioning.␊ - */␊ - loadBalancingRules?: (LoadBalancingRule25[] | string)␊ - /**␊ - * Collection of probe objects used in the load balancer.␊ - */␊ - probes?: (Probe25[] | string)␊ - /**␊ - * Collection of inbound NAT Rules used by a load balancer. Defining inbound NAT rules on your load balancer is mutually exclusive with defining an inbound NAT pool. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an Inbound NAT pool. They have to reference individual inbound NAT rules.␊ - */␊ - inboundNatRules?: (InboundNatRule26[] | string)␊ - /**␊ - * Defines an external port range for inbound NAT to a single backend port on NICs associated with a load balancer. Inbound NAT rules are created automatically for each NIC associated with the Load Balancer using an external port from this range. Defining an Inbound NAT pool on your Load Balancer is mutually exclusive with defining inbound Nat rules. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an inbound NAT pool. They have to reference individual inbound NAT rules.␊ - */␊ - inboundNatPools?: (InboundNatPool26[] | string)␊ - /**␊ - * The outbound rules.␊ - */␊ - outboundRules?: (OutboundRule13[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP address of the load balancer.␊ - */␊ - export interface FrontendIPConfiguration24 {␊ - /**␊ - * Properties of the load balancer probe.␊ - */␊ - properties?: (FrontendIPConfigurationPropertiesFormat24 | string)␊ - /**␊ - * The name of the resource that is unique within the set of frontend IP configurations used by the load balancer. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP Configuration of the load balancer.␊ - */␊ - export interface FrontendIPConfigurationPropertiesFormat24 {␊ - /**␊ - * The private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The Private IP allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4.␊ - */␊ - privateIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The reference to the subnet resource.␊ - */␊ - subnet?: (SubResource33 | string)␊ - /**␊ - * The reference to the Public IP resource.␊ - */␊ - publicIPAddress?: (SubResource33 | string)␊ - /**␊ - * The reference to the Public IP Prefix resource.␊ - */␊ - publicIPPrefix?: (SubResource33 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Pool of backend IP addresses.␊ - */␊ - export interface BackendAddressPool25 {␊ - /**␊ - * Properties of load balancer backend address pool.␊ - */␊ - properties?: ({␊ - [k: string]: unknown␊ - } | string)␊ - /**␊ - * The name of the resource that is unique within the set of backend address pools used by the load balancer. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A load balancing rule for a load balancer.␊ - */␊ - export interface LoadBalancingRule25 {␊ - /**␊ - * Properties of load balancer load balancing rule.␊ - */␊ - properties?: (LoadBalancingRulePropertiesFormat25 | string)␊ - /**␊ - * The name of the resource that is unique within the set of load balancing rules used by the load balancer. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer.␊ - */␊ - export interface LoadBalancingRulePropertiesFormat25 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource33 | string)␊ - /**␊ - * A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs.␊ - */␊ - backendAddressPool?: (SubResource33 | string)␊ - /**␊ - * The reference to the load balancer probe used by the load balancing rule.␊ - */␊ - probe?: (SubResource33 | string)␊ - /**␊ - * The reference to the transport protocol used by the load balancing rule.␊ - */␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The load distribution policy for this rule.␊ - */␊ - loadDistribution?: (("Default" | "SourceIP" | "SourceIPProtocol") | string)␊ - /**␊ - * The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 0 and 65534. Note that value 0 enables "Any Port".␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port".␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - /**␊ - * Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule.␊ - */␊ - disableOutboundSnat?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A load balancer probe.␊ - */␊ - export interface Probe25 {␊ - /**␊ - * Properties of load balancer probe.␊ - */␊ - properties?: (ProbePropertiesFormat25 | string)␊ - /**␊ - * The name of the resource that is unique within the set of probes used by the load balancer. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Load balancer probe resource.␊ - */␊ - export interface ProbePropertiesFormat25 {␊ - /**␊ - * The protocol of the end point. If 'Tcp' is specified, a received ACK is required for the probe to be successful. If 'Http' or 'Https' is specified, a 200 OK response from the specifies URI is required for the probe to be successful.␊ - */␊ - protocol: (("Http" | "Tcp" | "Https") | string)␊ - /**␊ - * The port for communicating the probe. Possible values range from 1 to 65535, inclusive.␊ - */␊ - port: (number | string)␊ - /**␊ - * The interval, in seconds, for how frequently to probe the endpoint for health status. Typically, the interval is slightly less than half the allocated timeout period (in seconds) which allows two full probes before taking the instance out of rotation. The default value is 15, the minimum value is 5.␊ - */␊ - intervalInSeconds?: (number | string)␊ - /**␊ - * The number of probes where if no response, will result in stopping further traffic from being delivered to the endpoint. This values allows endpoints to be taken out of rotation faster or slower than the typical times used in Azure.␊ - */␊ - numberOfProbes: (number | string)␊ - /**␊ - * The URI used for requesting health status from the VM. Path is required if a protocol is set to http. Otherwise, it is not allowed. There is no default value.␊ - */␊ - requestPath?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT rule of the load balancer.␊ - */␊ - export interface InboundNatRule26 {␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties?: (InboundNatRulePropertiesFormat25 | string)␊ - /**␊ - * The name of the resource that is unique within the set of inbound NAT rules used by the load balancer. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the inbound NAT rule.␊ - */␊ - export interface InboundNatRulePropertiesFormat25 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource33 | string)␊ - /**␊ - * The reference to the transport protocol used by the load balancing rule.␊ - */␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values range from 1 to 65534.␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * The port used for the internal endpoint. Acceptable values range from 1 to 65535.␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT pool of the load balancer.␊ - */␊ - export interface InboundNatPool26 {␊ - /**␊ - * Properties of load balancer inbound nat pool.␊ - */␊ - properties?: (InboundNatPoolPropertiesFormat25 | string)␊ - /**␊ - * The name of the resource that is unique within the set of inbound NAT pools used by the load balancer. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Inbound NAT pool.␊ - */␊ - export interface InboundNatPoolPropertiesFormat25 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource33 | string)␊ - /**␊ - * The reference to the transport protocol used by the inbound NAT pool.␊ - */␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65534.␊ - */␊ - frontendPortRangeStart: (number | string)␊ - /**␊ - * The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65535.␊ - */␊ - frontendPortRangeEnd: (number | string)␊ - /**␊ - * The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound rule of the load balancer.␊ - */␊ - export interface OutboundRule13 {␊ - /**␊ - * Properties of load balancer outbound rule.␊ - */␊ - properties?: (OutboundRulePropertiesFormat13 | string)␊ - /**␊ - * The name of the resource that is unique within the set of outbound rules used by the load balancer. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound rule of the load balancer.␊ - */␊ - export interface OutboundRulePropertiesFormat13 {␊ - /**␊ - * The number of outbound ports to be used for NAT.␊ - */␊ - allocatedOutboundPorts?: (number | string)␊ - /**␊ - * The Frontend IP addresses of the load balancer.␊ - */␊ - frontendIPConfigurations: (SubResource33[] | string)␊ - /**␊ - * A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs.␊ - */␊ - backendAddressPool: (SubResource33 | string)␊ - /**␊ - * The protocol for the outbound rule in load balancer.␊ - */␊ - protocol: (("Tcp" | "Udp" | "All") | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - /**␊ - * The timeout for the TCP idle connection.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers/inboundNatRules␊ - */␊ - export interface LoadBalancersInboundNatRulesChildResource21 {␊ - name: string␊ - type: "inboundNatRules"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties: (InboundNatRulePropertiesFormat25 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers/inboundNatRules␊ - */␊ - export interface LoadBalancersInboundNatRules21 {␊ - name: string␊ - type: "Microsoft.Network/loadBalancers/inboundNatRules"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties: (InboundNatRulePropertiesFormat25 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/localNetworkGateways␊ - */␊ - export interface LocalNetworkGateways25 {␊ - name: string␊ - type: "Microsoft.Network/localNetworkGateways"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the local network gateway.␊ - */␊ - properties: (LocalNetworkGatewayPropertiesFormat25 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * LocalNetworkGateway properties.␊ - */␊ - export interface LocalNetworkGatewayPropertiesFormat25 {␊ - /**␊ - * Local network site address space.␊ - */␊ - localNetworkAddressSpace?: (AddressSpace33 | string)␊ - /**␊ - * IP address of local network gateway.␊ - */␊ - gatewayIpAddress?: string␊ - /**␊ - * FQDN of local network gateway.␊ - */␊ - fqdn?: string␊ - /**␊ - * Local network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings24 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.␊ - */␊ - export interface AddressSpace33 {␊ - /**␊ - * A list of address blocks reserved for this virtual network in CIDR notation.␊ - */␊ - addressPrefixes: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * BGP settings details.␊ - */␊ - export interface BgpSettings24 {␊ - /**␊ - * The BGP speaker's ASN.␊ - */␊ - asn?: (number | string)␊ - /**␊ - * The BGP peering address and BGP identifier of this BGP speaker.␊ - */␊ - bgpPeeringAddress?: string␊ - /**␊ - * The weight added to routes learned from this BGP speaker.␊ - */␊ - peerWeight?: (number | string)␊ - /**␊ - * BGP peering address with IP configuration ID for virtual network gateway.␊ - */␊ - bgpPeeringAddresses?: (IPConfigurationBgpPeeringAddress1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IPConfigurationBgpPeeringAddress.␊ - */␊ - export interface IPConfigurationBgpPeeringAddress1 {␊ - /**␊ - * The ID of IP configuration which belongs to gateway.␊ - */␊ - ipconfigurationId?: string␊ - /**␊ - * The list of custom BGP peering addresses which belong to IP configuration.␊ - */␊ - customBgpIpAddresses?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/natGateways␊ - */␊ - export interface NatGateways8 {␊ - name: string␊ - type: "Microsoft.Network/natGateways"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The nat gateway SKU.␊ - */␊ - sku?: (NatGatewaySku8 | string)␊ - /**␊ - * Nat Gateway properties.␊ - */␊ - properties: (NatGatewayPropertiesFormat8 | string)␊ - /**␊ - * A list of availability zones denoting the zone in which Nat Gateway should be deployed.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of nat gateway.␊ - */␊ - export interface NatGatewaySku8 {␊ - /**␊ - * Name of Nat Gateway SKU.␊ - */␊ - name?: ("Standard" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Nat Gateway properties.␊ - */␊ - export interface NatGatewayPropertiesFormat8 {␊ - /**␊ - * The idle timeout of the nat gateway.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * An array of public ip addresses associated with the nat gateway resource.␊ - */␊ - publicIpAddresses?: (SubResource33[] | string)␊ - /**␊ - * An array of public ip prefixes associated with the nat gateway resource.␊ - */␊ - publicIpPrefixes?: (SubResource33[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces␊ - */␊ - export interface NetworkInterfaces34 {␊ - name: string␊ - type: "Microsoft.Network/networkInterfaces"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network interface.␊ - */␊ - properties: (NetworkInterfacePropertiesFormat25 | string)␊ - resources?: NetworkInterfacesTapConfigurationsChildResource12[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NetworkInterface properties.␊ - */␊ - export interface NetworkInterfacePropertiesFormat25 {␊ - /**␊ - * The reference to the NetworkSecurityGroup resource.␊ - */␊ - networkSecurityGroup?: (SubResource33 | string)␊ - /**␊ - * A list of IPConfigurations of the network interface.␊ - */␊ - ipConfigurations: (NetworkInterfaceIPConfiguration24[] | string)␊ - /**␊ - * The DNS settings in network interface.␊ - */␊ - dnsSettings?: (NetworkInterfaceDnsSettings33 | string)␊ - /**␊ - * If the network interface is accelerated networking enabled.␊ - */␊ - enableAcceleratedNetworking?: (boolean | string)␊ - /**␊ - * Indicates whether IP forwarding is enabled on this network interface.␊ - */␊ - enableIPForwarding?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IPConfiguration in a network interface.␊ - */␊ - export interface NetworkInterfaceIPConfiguration24 {␊ - /**␊ - * Network interface IP configuration properties.␊ - */␊ - properties?: (NetworkInterfaceIPConfigurationPropertiesFormat24 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration.␊ - */␊ - export interface NetworkInterfaceIPConfigurationPropertiesFormat24 {␊ - /**␊ - * The reference to Virtual Network Taps.␊ - */␊ - virtualNetworkTaps?: (SubResource33[] | string)␊ - /**␊ - * The reference to ApplicationGatewayBackendAddressPool resource.␊ - */␊ - applicationGatewayBackendAddressPools?: (SubResource33[] | string)␊ - /**␊ - * The reference to LoadBalancerBackendAddressPool resource.␊ - */␊ - loadBalancerBackendAddressPools?: (SubResource33[] | string)␊ - /**␊ - * A list of references of LoadBalancerInboundNatRules.␊ - */␊ - loadBalancerInboundNatRules?: (SubResource33[] | string)␊ - /**␊ - * Private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The private IP address allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4.␊ - */␊ - privateIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * Subnet bound to the IP configuration.␊ - */␊ - subnet?: (SubResource33 | string)␊ - /**␊ - * Whether this is a primary customer address on the network interface.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * Public IP address bound to the IP configuration.␊ - */␊ - publicIPAddress?: (SubResource33 | string)␊ - /**␊ - * Application security groups in which the IP configuration is included.␊ - */␊ - applicationSecurityGroups?: (SubResource33[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DNS settings of a network interface.␊ - */␊ - export interface NetworkInterfaceDnsSettings33 {␊ - /**␊ - * List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only value in dnsServers collection.␊ - */␊ - dnsServers?: (string[] | string)␊ - /**␊ - * Relative DNS name for this NIC used for internal communications between VMs in the same virtual network.␊ - */␊ - internalDnsNameLabel?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces/tapConfigurations␊ - */␊ - export interface NetworkInterfacesTapConfigurationsChildResource12 {␊ - name: string␊ - type: "tapConfigurations"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Properties of the Virtual Network Tap configuration.␊ - */␊ - properties: (NetworkInterfaceTapConfigurationPropertiesFormat12 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Virtual Network Tap configuration.␊ - */␊ - export interface NetworkInterfaceTapConfigurationPropertiesFormat12 {␊ - /**␊ - * The reference to the Virtual Network Tap resource.␊ - */␊ - virtualNetworkTap?: (SubResource33 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces/tapConfigurations␊ - */␊ - export interface NetworkInterfacesTapConfigurations12 {␊ - name: string␊ - type: "Microsoft.Network/networkInterfaces/tapConfigurations"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Properties of the Virtual Network Tap configuration.␊ - */␊ - properties: (NetworkInterfaceTapConfigurationPropertiesFormat12 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkProfiles␊ - */␊ - export interface NetworkProfiles7 {␊ - name: string␊ - type: "Microsoft.Network/networkProfiles"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Network profile properties.␊ - */␊ - properties: (NetworkProfilePropertiesFormat7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network profile properties.␊ - */␊ - export interface NetworkProfilePropertiesFormat7 {␊ - /**␊ - * List of chid container network interface configurations.␊ - */␊ - containerNetworkInterfaceConfigurations?: (ContainerNetworkInterfaceConfiguration7[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Container network interface configuration child resource.␊ - */␊ - export interface ContainerNetworkInterfaceConfiguration7 {␊ - /**␊ - * Container network interface configuration properties.␊ - */␊ - properties?: (ContainerNetworkInterfaceConfigurationPropertiesFormat7 | string)␊ - /**␊ - * The name of the resource. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Container network interface configuration properties.␊ - */␊ - export interface ContainerNetworkInterfaceConfigurationPropertiesFormat7 {␊ - /**␊ - * A list of ip configurations of the container network interface configuration.␊ - */␊ - ipConfigurations?: (IPConfigurationProfile7[] | string)␊ - /**␊ - * A list of container network interfaces created from this container network interface configuration.␊ - */␊ - containerNetworkInterfaces?: (SubResource33[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration profile child resource.␊ - */␊ - export interface IPConfigurationProfile7 {␊ - /**␊ - * Properties of the IP configuration profile.␊ - */␊ - properties?: (IPConfigurationProfilePropertiesFormat7 | string)␊ - /**␊ - * The name of the resource. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration profile properties.␊ - */␊ - export interface IPConfigurationProfilePropertiesFormat7 {␊ - /**␊ - * The reference to the subnet resource to create a container network interface ip configuration.␊ - */␊ - subnet?: (SubResource33 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups␊ - */␊ - export interface NetworkSecurityGroups33 {␊ - name: string␊ - type: "Microsoft.Network/networkSecurityGroups"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network security group.␊ - */␊ - properties: (NetworkSecurityGroupPropertiesFormat25 | string)␊ - resources?: NetworkSecurityGroupsSecurityRulesChildResource25[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network Security Group resource.␊ - */␊ - export interface NetworkSecurityGroupPropertiesFormat25 {␊ - /**␊ - * A collection of security rules of the network security group.␊ - */␊ - securityRules?: (SecurityRule25[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network security rule.␊ - */␊ - export interface SecurityRule25 {␊ - /**␊ - * Properties of the security rule.␊ - */␊ - properties?: (SecurityRulePropertiesFormat25 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Security rule resource.␊ - */␊ - export interface SecurityRulePropertiesFormat25 {␊ - /**␊ - * A description for this rule. Restricted to 140 chars.␊ - */␊ - description?: string␊ - /**␊ - * Network protocol this rule applies to.␊ - */␊ - protocol: (("Tcp" | "Udp" | "Icmp" | "Esp" | "*" | "Ah") | string)␊ - /**␊ - * The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.␊ - */␊ - sourcePortRange?: string␊ - /**␊ - * The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.␊ - */␊ - destinationPortRange?: string␊ - /**␊ - * The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from.␊ - */␊ - sourceAddressPrefix?: string␊ - /**␊ - * The CIDR or source IP ranges.␊ - */␊ - sourceAddressPrefixes?: (string[] | string)␊ - /**␊ - * The application security group specified as source.␊ - */␊ - sourceApplicationSecurityGroups?: (SubResource33[] | string)␊ - /**␊ - * The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used.␊ - */␊ - destinationAddressPrefix?: string␊ - /**␊ - * The destination address prefixes. CIDR or destination IP ranges.␊ - */␊ - destinationAddressPrefixes?: (string[] | string)␊ - /**␊ - * The application security group specified as destination.␊ - */␊ - destinationApplicationSecurityGroups?: (SubResource33[] | string)␊ - /**␊ - * The source port ranges.␊ - */␊ - sourcePortRanges?: (string[] | string)␊ - /**␊ - * The destination port ranges.␊ - */␊ - destinationPortRanges?: (string[] | string)␊ - /**␊ - * The network traffic is allowed or denied.␊ - */␊ - access: (("Allow" | "Deny") | string)␊ - /**␊ - * The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.␊ - */␊ - priority: (number | string)␊ - /**␊ - * The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic.␊ - */␊ - direction: (("Inbound" | "Outbound") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRulesChildResource25 {␊ - name: string␊ - type: "securityRules"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Properties of the security rule.␊ - */␊ - properties: (SecurityRulePropertiesFormat25 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRules25 {␊ - name: string␊ - type: "Microsoft.Network/networkSecurityGroups/securityRules"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Properties of the security rule.␊ - */␊ - properties: (SecurityRulePropertiesFormat25 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkVirtualAppliances␊ - */␊ - export interface NetworkVirtualAppliances1 {␊ - name: string␊ - type: "Microsoft.Network/networkVirtualAppliances"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the Network Virtual Appliance.␊ - */␊ - properties: (NetworkVirtualAppliancePropertiesFormat1 | string)␊ - /**␊ - * The service principal that has read access to cloud-init and config blob.␊ - */␊ - identity?: (ManagedServiceIdentity11 | string)␊ - /**␊ - * Network Virtual Appliance SKU.␊ - */␊ - sku?: (VirtualApplianceSkuProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network Virtual Appliance definition.␊ - */␊ - export interface NetworkVirtualAppliancePropertiesFormat1 {␊ - /**␊ - * BootStrapConfigurationBlob storage URLs.␊ - */␊ - bootStrapConfigurationBlob?: (string[] | string)␊ - /**␊ - * The Virtual Hub where Network Virtual Appliance is being deployed.␊ - */␊ - virtualHub?: (SubResource33 | string)␊ - /**␊ - * CloudInitConfigurationBlob storage URLs.␊ - */␊ - cloudInitConfigurationBlob?: (string[] | string)␊ - /**␊ - * VirtualAppliance ASN.␊ - */␊ - virtualApplianceAsn?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network Virtual Appliance Sku Properties.␊ - */␊ - export interface VirtualApplianceSkuProperties1 {␊ - /**␊ - * Virtual Appliance Vendor.␊ - */␊ - vendor?: string␊ - /**␊ - * Virtual Appliance Scale Unit.␊ - */␊ - bundledScaleUnit?: string␊ - /**␊ - * Virtual Appliance Version.␊ - */␊ - marketPlaceVersion?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers␊ - */␊ - export interface NetworkWatchers10 {␊ - name: string␊ - type: "Microsoft.Network/networkWatchers"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network watcher.␊ - */␊ - properties: ({␊ - [k: string]: unknown␊ - } | string)␊ - resources?: (NetworkWatchersFlowLogsChildResource2 | NetworkWatchersConnectionMonitorsChildResource7 | NetworkWatchersPacketCapturesChildResource10)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/flowLogs␊ - */␊ - export interface NetworkWatchersFlowLogsChildResource2 {␊ - name: string␊ - type: "flowLogs"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the flow log.␊ - */␊ - properties: (FlowLogPropertiesFormat2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters that define the configuration of flow log.␊ - */␊ - export interface FlowLogPropertiesFormat2 {␊ - /**␊ - * ID of network security group to which flow log will be applied.␊ - */␊ - targetResourceId: string␊ - /**␊ - * ID of the storage account which is used to store the flow log.␊ - */␊ - storageId: string␊ - /**␊ - * Flag to enable/disable flow logging.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Parameters that define the retention policy for flow log.␊ - */␊ - retentionPolicy?: (RetentionPolicyParameters2 | string)␊ - /**␊ - * Parameters that define the flow log format.␊ - */␊ - format?: (FlowLogFormatParameters2 | string)␊ - /**␊ - * Parameters that define the configuration of traffic analytics.␊ - */␊ - flowAnalyticsConfiguration?: (TrafficAnalyticsProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters that define the retention policy for flow log.␊ - */␊ - export interface RetentionPolicyParameters2 {␊ - /**␊ - * Number of days to retain flow log records.␊ - */␊ - days?: ((number & string) | string)␊ - /**␊ - * Flag to enable/disable retention.␊ - */␊ - enabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters that define the flow log format.␊ - */␊ - export interface FlowLogFormatParameters2 {␊ - /**␊ - * The file type of flow log.␊ - */␊ - type?: "JSON"␊ - /**␊ - * The version (revision) of the flow log.␊ - */␊ - version?: ((number & string) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters that define the configuration of traffic analytics.␊ - */␊ - export interface TrafficAnalyticsProperties2 {␊ - /**␊ - * Parameters that define the configuration of traffic analytics.␊ - */␊ - networkWatcherFlowAnalyticsConfiguration?: (TrafficAnalyticsConfigurationProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters that define the configuration of traffic analytics.␊ - */␊ - export interface TrafficAnalyticsConfigurationProperties2 {␊ - /**␊ - * Flag to enable/disable traffic analytics.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * The resource guid of the attached workspace.␊ - */␊ - workspaceId?: string␊ - /**␊ - * The location of the attached workspace.␊ - */␊ - workspaceRegion?: string␊ - /**␊ - * Resource Id of the attached workspace.␊ - */␊ - workspaceResourceId?: string␊ - /**␊ - * The interval in minutes which would decide how frequently TA service should do flow analytics.␊ - */␊ - trafficAnalyticsInterval?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/connectionMonitors␊ - */␊ - export interface NetworkWatchersConnectionMonitorsChildResource7 {␊ - name: string␊ - type: "connectionMonitors"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Connection monitor location.␊ - */␊ - location?: string␊ - /**␊ - * Connection monitor tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the connection monitor.␊ - */␊ - properties: (ConnectionMonitorParameters7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters that define the operation to create a connection monitor.␊ - */␊ - export interface ConnectionMonitorParameters7 {␊ - /**␊ - * Describes the source of connection monitor.␊ - */␊ - source?: (ConnectionMonitorSource7 | string)␊ - /**␊ - * Describes the destination of connection monitor.␊ - */␊ - destination?: (ConnectionMonitorDestination7 | string)␊ - /**␊ - * Determines if the connection monitor will start automatically once created.␊ - */␊ - autoStart?: (boolean | string)␊ - /**␊ - * Monitoring interval in seconds.␊ - */␊ - monitoringIntervalInSeconds?: ((number & string) | string)␊ - /**␊ - * List of connection monitor endpoints.␊ - */␊ - endpoints?: (ConnectionMonitorEndpoint2[] | string)␊ - /**␊ - * List of connection monitor test configurations.␊ - */␊ - testConfigurations?: (ConnectionMonitorTestConfiguration2[] | string)␊ - /**␊ - * List of connection monitor test groups.␊ - */␊ - testGroups?: (ConnectionMonitorTestGroup2[] | string)␊ - /**␊ - * List of connection monitor outputs.␊ - */␊ - outputs?: (ConnectionMonitorOutput2[] | string)␊ - /**␊ - * Optional notes to be associated with the connection monitor.␊ - */␊ - notes?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the source of connection monitor.␊ - */␊ - export interface ConnectionMonitorSource7 {␊ - /**␊ - * The ID of the resource used as the source by connection monitor.␊ - */␊ - resourceId: string␊ - /**␊ - * The source port used by connection monitor.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the destination of connection monitor.␊ - */␊ - export interface ConnectionMonitorDestination7 {␊ - /**␊ - * The ID of the resource used as the destination by connection monitor.␊ - */␊ - resourceId?: string␊ - /**␊ - * Address of the connection monitor destination (IP or domain name).␊ - */␊ - address?: string␊ - /**␊ - * The destination port used by connection monitor.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the connection monitor endpoint.␊ - */␊ - export interface ConnectionMonitorEndpoint2 {␊ - /**␊ - * The name of the connection monitor endpoint.␊ - */␊ - name: string␊ - /**␊ - * Resource ID of the connection monitor endpoint.␊ - */␊ - resourceId?: string␊ - /**␊ - * Address of the connection monitor endpoint (IP or domain name).␊ - */␊ - address?: string␊ - /**␊ - * Filter for sub-items within the endpoint.␊ - */␊ - filter?: (ConnectionMonitorEndpointFilter2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the connection monitor endpoint filter.␊ - */␊ - export interface ConnectionMonitorEndpointFilter2 {␊ - /**␊ - * The behavior of the endpoint filter. Currently only 'Include' is supported.␊ - */␊ - type?: "Include"␊ - /**␊ - * List of items in the filter.␊ - */␊ - items?: (ConnectionMonitorEndpointFilterItem2[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the connection monitor endpoint filter item.␊ - */␊ - export interface ConnectionMonitorEndpointFilterItem2 {␊ - /**␊ - * The type of item included in the filter. Currently only 'AgentAddress' is supported.␊ - */␊ - type?: "AgentAddress"␊ - /**␊ - * The address of the filter item.␊ - */␊ - address?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a connection monitor test configuration.␊ - */␊ - export interface ConnectionMonitorTestConfiguration2 {␊ - /**␊ - * The name of the connection monitor test configuration.␊ - */␊ - name: string␊ - /**␊ - * The frequency of test evaluation, in seconds.␊ - */␊ - testFrequencySec?: (number | string)␊ - /**␊ - * The protocol to use in test evaluation.␊ - */␊ - protocol: (("Tcp" | "Http" | "Icmp") | string)␊ - /**␊ - * The preferred IP version to use in test evaluation. The connection monitor may choose to use a different version depending on other parameters.␊ - */␊ - preferredIPVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The parameters used to perform test evaluation over HTTP.␊ - */␊ - httpConfiguration?: (ConnectionMonitorHttpConfiguration2 | string)␊ - /**␊ - * The parameters used to perform test evaluation over TCP.␊ - */␊ - tcpConfiguration?: (ConnectionMonitorTcpConfiguration2 | string)␊ - /**␊ - * The parameters used to perform test evaluation over ICMP.␊ - */␊ - icmpConfiguration?: (ConnectionMonitorIcmpConfiguration2 | string)␊ - /**␊ - * The threshold for declaring a test successful.␊ - */␊ - successThreshold?: (ConnectionMonitorSuccessThreshold2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the HTTP configuration.␊ - */␊ - export interface ConnectionMonitorHttpConfiguration2 {␊ - /**␊ - * The port to connect to.␊ - */␊ - port?: (number | string)␊ - /**␊ - * The HTTP method to use.␊ - */␊ - method?: (("Get" | "Post") | string)␊ - /**␊ - * The path component of the URI. For instance, "/dir1/dir2".␊ - */␊ - path?: string␊ - /**␊ - * The HTTP headers to transmit with the request.␊ - */␊ - requestHeaders?: (HTTPHeader2[] | string)␊ - /**␊ - * HTTP status codes to consider successful. For instance, "2xx,301-304,418".␊ - */␊ - validStatusCodeRanges?: (string[] | string)␊ - /**␊ - * Value indicating whether HTTPS is preferred over HTTP in cases where the choice is not explicit.␊ - */␊ - preferHTTPS?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The HTTP header.␊ - */␊ - export interface HTTPHeader2 {␊ - /**␊ - * The name in HTTP header.␊ - */␊ - name?: string␊ - /**␊ - * The value in HTTP header.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the TCP configuration.␊ - */␊ - export interface ConnectionMonitorTcpConfiguration2 {␊ - /**␊ - * The port to connect to.␊ - */␊ - port?: (number | string)␊ - /**␊ - * Value indicating whether path evaluation with trace route should be disabled.␊ - */␊ - disableTraceRoute?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the ICMP configuration.␊ - */␊ - export interface ConnectionMonitorIcmpConfiguration2 {␊ - /**␊ - * Value indicating whether path evaluation with trace route should be disabled.␊ - */␊ - disableTraceRoute?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the threshold for declaring a test successful.␊ - */␊ - export interface ConnectionMonitorSuccessThreshold2 {␊ - /**␊ - * The maximum percentage of failed checks permitted for a test to evaluate as successful.␊ - */␊ - checksFailedPercent?: (number | string)␊ - /**␊ - * The maximum round-trip time in milliseconds permitted for a test to evaluate as successful.␊ - */␊ - roundTripTimeMs?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the connection monitor test group.␊ - */␊ - export interface ConnectionMonitorTestGroup2 {␊ - /**␊ - * The name of the connection monitor test group.␊ - */␊ - name: string␊ - /**␊ - * Value indicating whether test group is disabled.␊ - */␊ - disable?: (boolean | string)␊ - /**␊ - * List of test configuration names.␊ - */␊ - testConfigurations: (string[] | string)␊ - /**␊ - * List of source endpoint names.␊ - */␊ - sources: (string[] | string)␊ - /**␊ - * List of destination endpoint names.␊ - */␊ - destinations: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a connection monitor output destination.␊ - */␊ - export interface ConnectionMonitorOutput2 {␊ - /**␊ - * Connection monitor output destination type. Currently, only "Workspace" is supported.␊ - */␊ - type?: "Workspace"␊ - /**␊ - * Describes the settings for producing output into a log analytics workspace.␊ - */␊ - workspaceSettings?: (ConnectionMonitorWorkspaceSettings2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the settings for producing output into a log analytics workspace.␊ - */␊ - export interface ConnectionMonitorWorkspaceSettings2 {␊ - /**␊ - * Log analytics workspace resource ID.␊ - */␊ - workspaceResourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/packetCaptures␊ - */␊ - export interface NetworkWatchersPacketCapturesChildResource10 {␊ - name: string␊ - type: "packetCaptures"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Properties of the packet capture.␊ - */␊ - properties: (PacketCaptureParameters10 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters that define the create packet capture operation.␊ - */␊ - export interface PacketCaptureParameters10 {␊ - /**␊ - * The ID of the targeted resource, only VM is currently supported.␊ - */␊ - target: string␊ - /**␊ - * Number of bytes captured per packet, the remaining bytes are truncated.␊ - */␊ - bytesToCapturePerPacket?: ((number & string) | string)␊ - /**␊ - * Maximum size of the capture output.␊ - */␊ - totalBytesPerSession?: ((number & string) | string)␊ - /**␊ - * Maximum duration of the capture session in seconds.␊ - */␊ - timeLimitInSeconds?: ((number & string) | string)␊ - /**␊ - * The storage location for a packet capture session.␊ - */␊ - storageLocation: (PacketCaptureStorageLocation10 | string)␊ - /**␊ - * A list of packet capture filters.␊ - */␊ - filters?: (PacketCaptureFilter10[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The storage location for a packet capture session.␊ - */␊ - export interface PacketCaptureStorageLocation10 {␊ - /**␊ - * The ID of the storage account to save the packet capture session. Required if no local file path is provided.␊ - */␊ - storageId?: string␊ - /**␊ - * The URI of the storage path to save the packet capture. Must be a well-formed URI describing the location to save the packet capture.␊ - */␊ - storagePath?: string␊ - /**␊ - * A valid local path on the targeting VM. Must include the name of the capture file (*.cap). For linux virtual machine it must start with /var/captures. Required if no storage ID is provided, otherwise optional.␊ - */␊ - filePath?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Filter that is applied to packet capture request. Multiple filters can be applied.␊ - */␊ - export interface PacketCaptureFilter10 {␊ - /**␊ - * Protocol to be filtered on.␊ - */␊ - protocol?: (("TCP" | "UDP" | "Any") | string)␊ - /**␊ - * Local IP Address to be filtered on. Notation: "127.0.0.1" for single address entry. "127.0.0.1-127.0.0.255" for range. "127.0.0.1;127.0.0.5"? for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.␊ - */␊ - localIPAddress?: string␊ - /**␊ - * Local IP Address to be filtered on. Notation: "127.0.0.1" for single address entry. "127.0.0.1-127.0.0.255" for range. "127.0.0.1;127.0.0.5;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.␊ - */␊ - remoteIPAddress?: string␊ - /**␊ - * Local port to be filtered on. Notation: "80" for single port entry."80-85" for range. "80;443;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.␊ - */␊ - localPort?: string␊ - /**␊ - * Remote port to be filtered on. Notation: "80" for single port entry."80-85" for range. "80;443;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.␊ - */␊ - remotePort?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/connectionMonitors␊ - */␊ - export interface NetworkWatchersConnectionMonitors7 {␊ - name: string␊ - type: "Microsoft.Network/networkWatchers/connectionMonitors"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Connection monitor location.␊ - */␊ - location?: string␊ - /**␊ - * Connection monitor tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the connection monitor.␊ - */␊ - properties: (ConnectionMonitorParameters7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/flowLogs␊ - */␊ - export interface NetworkWatchersFlowLogs2 {␊ - name: string␊ - type: "Microsoft.Network/networkWatchers/flowLogs"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the flow log.␊ - */␊ - properties: (FlowLogPropertiesFormat2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/packetCaptures␊ - */␊ - export interface NetworkWatchersPacketCaptures10 {␊ - name: string␊ - type: "Microsoft.Network/networkWatchers/packetCaptures"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Properties of the packet capture.␊ - */␊ - properties: (PacketCaptureParameters10 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/p2svpnGateways␊ - */␊ - export interface P2SvpnGateways7 {␊ - name: string␊ - type: "Microsoft.Network/p2svpnGateways"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the P2SVpnGateway.␊ - */␊ - properties: (P2SVpnGatewayProperties7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for P2SVpnGateway.␊ - */␊ - export interface P2SVpnGatewayProperties7 {␊ - /**␊ - * The VirtualHub to which the gateway belongs.␊ - */␊ - virtualHub?: (SubResource33 | string)␊ - /**␊ - * List of all p2s connection configurations of the gateway.␊ - */␊ - p2SConnectionConfigurations?: (P2SConnectionConfiguration4[] | string)␊ - /**␊ - * The scale unit for this p2s vpn gateway.␊ - */␊ - vpnGatewayScaleUnit?: (number | string)␊ - /**␊ - * The VpnServerConfiguration to which the p2sVpnGateway is attached to.␊ - */␊ - vpnServerConfiguration?: (SubResource33 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * P2SConnectionConfiguration Resource.␊ - */␊ - export interface P2SConnectionConfiguration4 {␊ - /**␊ - * Properties of the P2S connection configuration.␊ - */␊ - properties?: (P2SConnectionConfigurationProperties4 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for P2SConnectionConfiguration.␊ - */␊ - export interface P2SConnectionConfigurationProperties4 {␊ - /**␊ - * The reference to the address space resource which represents Address space for P2S VpnClient.␊ - */␊ - vpnClientAddressPool?: (AddressSpace33 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateEndpoints␊ - */␊ - export interface PrivateEndpoints7 {␊ - name: string␊ - type: "Microsoft.Network/privateEndpoints"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the private endpoint.␊ - */␊ - properties: (PrivateEndpointProperties7 | string)␊ - resources?: PrivateEndpointsPrivateDnsZoneGroupsChildResource[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the private endpoint.␊ - */␊ - export interface PrivateEndpointProperties7 {␊ - /**␊ - * The ID of the subnet from which the private IP will be allocated.␊ - */␊ - subnet?: (SubResource33 | string)␊ - /**␊ - * A grouping of information about the connection to the remote resource.␊ - */␊ - privateLinkServiceConnections?: (PrivateLinkServiceConnection7[] | string)␊ - /**␊ - * A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource.␊ - */␊ - manualPrivateLinkServiceConnections?: (PrivateLinkServiceConnection7[] | string)␊ - /**␊ - * An array of custom dns configurations.␊ - */␊ - customDnsConfigs?: (CustomDnsConfigPropertiesFormat[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * PrivateLinkServiceConnection resource.␊ - */␊ - export interface PrivateLinkServiceConnection7 {␊ - /**␊ - * Properties of the private link service connection.␊ - */␊ - properties?: (PrivateLinkServiceConnectionProperties7 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the PrivateLinkServiceConnection.␊ - */␊ - export interface PrivateLinkServiceConnectionProperties7 {␊ - /**␊ - * The resource id of private link service.␊ - */␊ - privateLinkServiceId?: string␊ - /**␊ - * The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to.␊ - */␊ - groupIds?: (string[] | string)␊ - /**␊ - * A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars.␊ - */␊ - requestMessage?: string␊ - /**␊ - * A collection of read-only information about the state of the connection to the remote resource.␊ - */␊ - privateLinkServiceConnectionState?: (PrivateLinkServiceConnectionState13 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A collection of information about the state of the connection between service consumer and provider.␊ - */␊ - export interface PrivateLinkServiceConnectionState13 {␊ - /**␊ - * Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.␊ - */␊ - status?: string␊ - /**␊ - * The reason for approval/rejection of the connection.␊ - */␊ - description?: string␊ - /**␊ - * A message indicating if changes on the service provider require any updates on the consumer.␊ - */␊ - actionsRequired?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains custom Dns resolution configuration from customer.␊ - */␊ - export interface CustomDnsConfigPropertiesFormat {␊ - /**␊ - * Fqdn that resolves to private endpoint ip address.␊ - */␊ - fqdn?: string␊ - /**␊ - * A list of private ip addresses of the private endpoint.␊ - */␊ - ipAddresses?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateEndpoints/privateDnsZoneGroups␊ - */␊ - export interface PrivateEndpointsPrivateDnsZoneGroupsChildResource {␊ - name: string␊ - type: "privateDnsZoneGroups"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Properties of the private dns zone group.␊ - */␊ - properties: (PrivateDnsZoneGroupPropertiesFormat | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the private dns zone group.␊ - */␊ - export interface PrivateDnsZoneGroupPropertiesFormat {␊ - /**␊ - * A collection of private dns zone configurations of the private dns zone group.␊ - */␊ - privateDnsZoneConfigs?: (PrivateDnsZoneConfig[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * PrivateDnsZoneConfig resource.␊ - */␊ - export interface PrivateDnsZoneConfig {␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * Properties of the private dns zone configuration.␊ - */␊ - properties?: (PrivateDnsZonePropertiesFormat | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the private dns zone configuration resource.␊ - */␊ - export interface PrivateDnsZonePropertiesFormat {␊ - /**␊ - * The resource id of the private dns zone.␊ - */␊ - privateDnsZoneId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateEndpoints/privateDnsZoneGroups␊ - */␊ - export interface PrivateEndpointsPrivateDnsZoneGroups {␊ - name: string␊ - type: "Microsoft.Network/privateEndpoints/privateDnsZoneGroups"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Properties of the private dns zone group.␊ - */␊ - properties: (PrivateDnsZoneGroupPropertiesFormat | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateLinkServices␊ - */␊ - export interface PrivateLinkServices7 {␊ - name: string␊ - type: "Microsoft.Network/privateLinkServices"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the private link service.␊ - */␊ - properties: (PrivateLinkServiceProperties7 | string)␊ - resources?: PrivateLinkServicesPrivateEndpointConnectionsChildResource7[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the private link service.␊ - */␊ - export interface PrivateLinkServiceProperties7 {␊ - /**␊ - * An array of references to the load balancer IP configurations.␊ - */␊ - loadBalancerFrontendIpConfigurations?: (SubResource33[] | string)␊ - /**␊ - * An array of private link service IP configurations.␊ - */␊ - ipConfigurations?: (PrivateLinkServiceIpConfiguration7[] | string)␊ - /**␊ - * The visibility list of the private link service.␊ - */␊ - visibility?: (PrivateLinkServicePropertiesVisibility7 | string)␊ - /**␊ - * The auto-approval list of the private link service.␊ - */␊ - autoApproval?: (PrivateLinkServicePropertiesAutoApproval7 | string)␊ - /**␊ - * The list of Fqdn.␊ - */␊ - fqdns?: (string[] | string)␊ - /**␊ - * Whether the private link service is enabled for proxy protocol or not.␊ - */␊ - enableProxyProtocol?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The private link service ip configuration.␊ - */␊ - export interface PrivateLinkServiceIpConfiguration7 {␊ - /**␊ - * Properties of the private link service ip configuration.␊ - */␊ - properties?: (PrivateLinkServiceIpConfigurationProperties7 | string)␊ - /**␊ - * The name of private link service ip configuration.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of private link service IP configuration.␊ - */␊ - export interface PrivateLinkServiceIpConfigurationProperties7 {␊ - /**␊ - * The private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The private IP address allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * The reference to the subnet resource.␊ - */␊ - subnet?: (SubResource33 | string)␊ - /**␊ - * Whether the ip configuration is primary or not.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4.␊ - */␊ - privateIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The visibility list of the private link service.␊ - */␊ - export interface PrivateLinkServicePropertiesVisibility7 {␊ - /**␊ - * The list of subscriptions.␊ - */␊ - subscriptions?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The auto-approval list of the private link service.␊ - */␊ - export interface PrivateLinkServicePropertiesAutoApproval7 {␊ - /**␊ - * The list of subscriptions.␊ - */␊ - subscriptions?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateLinkServices/privateEndpointConnections␊ - */␊ - export interface PrivateLinkServicesPrivateEndpointConnectionsChildResource7 {␊ - name: string␊ - type: "privateEndpointConnections"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Properties of the private end point connection.␊ - */␊ - properties: (PrivateEndpointConnectionProperties14 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the PrivateEndpointConnectProperties.␊ - */␊ - export interface PrivateEndpointConnectionProperties14 {␊ - /**␊ - * A collection of information about the state of the connection between service consumer and provider.␊ - */␊ - privateLinkServiceConnectionState?: (PrivateLinkServiceConnectionState13 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateLinkServices/privateEndpointConnections␊ - */␊ - export interface PrivateLinkServicesPrivateEndpointConnections7 {␊ - name: string␊ - type: "Microsoft.Network/privateLinkServices/privateEndpointConnections"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Properties of the private end point connection.␊ - */␊ - properties: (PrivateEndpointConnectionProperties14 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/publicIPAddresses␊ - */␊ - export interface PublicIPAddresses33 {␊ - name: string␊ - type: "Microsoft.Network/publicIPAddresses"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The public IP address SKU.␊ - */␊ - sku?: (PublicIPAddressSku21 | string)␊ - /**␊ - * Public IP address properties.␊ - */␊ - properties: (PublicIPAddressPropertiesFormat24 | string)␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a public IP address.␊ - */␊ - export interface PublicIPAddressSku21 {␊ - /**␊ - * Name of a public IP address SKU.␊ - */␊ - name?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Public IP address properties.␊ - */␊ - export interface PublicIPAddressPropertiesFormat24 {␊ - /**␊ - * The public IP address allocation method.␊ - */␊ - publicIPAllocationMethod: (("Static" | "Dynamic") | string)␊ - /**␊ - * The public IP address version.␊ - */␊ - publicIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The FQDN of the DNS record associated with the public IP address.␊ - */␊ - dnsSettings?: (PublicIPAddressDnsSettings32 | string)␊ - /**␊ - * The DDoS protection custom policy associated with the public IP address.␊ - */␊ - ddosSettings?: (DdosSettings10 | string)␊ - /**␊ - * The list of tags associated with the public IP address.␊ - */␊ - ipTags?: (IpTag18[] | string)␊ - /**␊ - * The IP address associated with the public IP address resource.␊ - */␊ - ipAddress?: string␊ - /**␊ - * The Public IP Prefix this Public IP Address should be allocated from.␊ - */␊ - publicIPPrefix?: (SubResource33 | string)␊ - /**␊ - * The idle timeout of the public IP address.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains FQDN of the DNS record associated with the public IP address.␊ - */␊ - export interface PublicIPAddressDnsSettings32 {␊ - /**␊ - * The domain name label. The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.␊ - */␊ - domainNameLabel: string␊ - /**␊ - * The Fully Qualified Domain Name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone.␊ - */␊ - fqdn?: string␊ - /**␊ - * The reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN.␊ - */␊ - reverseFqdn?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains the DDoS protection settings of the public IP.␊ - */␊ - export interface DdosSettings10 {␊ - /**␊ - * The DDoS custom policy associated with the public IP.␊ - */␊ - ddosCustomPolicy?: (SubResource33 | string)␊ - /**␊ - * The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized.␊ - */␊ - protectionCoverage?: (("Basic" | "Standard") | string)␊ - /**␊ - * Enables DDoS protection on the public IP.␊ - */␊ - protectedIP?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains the IpTag associated with the object.␊ - */␊ - export interface IpTag18 {␊ - /**␊ - * The IP tag type. Example: FirstPartyUsage.␊ - */␊ - ipTagType?: string␊ - /**␊ - * The value of the IP tag associated with the public IP. Example: SQL.␊ - */␊ - tag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/publicIPPrefixes␊ - */␊ - export interface PublicIPPrefixes8 {␊ - name: string␊ - type: "Microsoft.Network/publicIPPrefixes"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The public IP prefix SKU.␊ - */␊ - sku?: (PublicIPPrefixSku8 | string)␊ - /**␊ - * Public IP prefix properties.␊ - */␊ - properties: (PublicIPPrefixPropertiesFormat8 | string)␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a public IP prefix.␊ - */␊ - export interface PublicIPPrefixSku8 {␊ - /**␊ - * Name of a public IP prefix SKU.␊ - */␊ - name?: ("Standard" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Public IP prefix properties.␊ - */␊ - export interface PublicIPPrefixPropertiesFormat8 {␊ - /**␊ - * The public IP address version.␊ - */␊ - publicIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The list of tags associated with the public IP prefix.␊ - */␊ - ipTags?: (IpTag18[] | string)␊ - /**␊ - * The Length of the Public IP Prefix.␊ - */␊ - prefixLength?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeFilters␊ - */␊ - export interface RouteFilters10 {␊ - name: string␊ - type: "Microsoft.Network/routeFilters"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the route filter.␊ - */␊ - properties: (RouteFilterPropertiesFormat10 | string)␊ - resources?: RouteFiltersRouteFilterRulesChildResource10[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Filter Resource.␊ - */␊ - export interface RouteFilterPropertiesFormat10 {␊ - /**␊ - * Collection of RouteFilterRules contained within a route filter.␊ - */␊ - rules?: (RouteFilterRule10[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Filter Rule Resource.␊ - */␊ - export interface RouteFilterRule10 {␊ - /**␊ - * Properties of the route filter rule.␊ - */␊ - properties?: (RouteFilterRulePropertiesFormat10 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Filter Rule Resource.␊ - */␊ - export interface RouteFilterRulePropertiesFormat10 {␊ - /**␊ - * The access type of the rule.␊ - */␊ - access: (("Allow" | "Deny") | string)␊ - /**␊ - * The rule type of the rule.␊ - */␊ - routeFilterRuleType: ("Community" | string)␊ - /**␊ - * The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'].␊ - */␊ - communities: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeFilters/routeFilterRules␊ - */␊ - export interface RouteFiltersRouteFilterRulesChildResource10 {␊ - name: string␊ - type: "routeFilterRules"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Properties of the route filter rule.␊ - */␊ - properties: (RouteFilterRulePropertiesFormat10 | string)␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeFilters/routeFilterRules␊ - */␊ - export interface RouteFiltersRouteFilterRules10 {␊ - name: string␊ - type: "Microsoft.Network/routeFilters/routeFilterRules"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Properties of the route filter rule.␊ - */␊ - properties: (RouteFilterRulePropertiesFormat10 | string)␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables␊ - */␊ - export interface RouteTables33 {␊ - name: string␊ - type: "Microsoft.Network/routeTables"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the route table.␊ - */␊ - properties: (RouteTablePropertiesFormat25 | string)␊ - resources?: RouteTablesRoutesChildResource25[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Table resource.␊ - */␊ - export interface RouteTablePropertiesFormat25 {␊ - /**␊ - * Collection of routes contained within a route table.␊ - */␊ - routes?: (Route25[] | string)␊ - /**␊ - * Whether to disable the routes learned by BGP on that route table. True means disable.␊ - */␊ - disableBgpRoutePropagation?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource.␊ - */␊ - export interface Route25 {␊ - /**␊ - * Properties of the route.␊ - */␊ - properties?: (RoutePropertiesFormat25 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource.␊ - */␊ - export interface RoutePropertiesFormat25 {␊ - /**␊ - * The destination CIDR to which the route applies.␊ - */␊ - addressPrefix: string␊ - /**␊ - * The type of Azure hop the packet should be sent to.␊ - */␊ - nextHopType: (("VirtualNetworkGateway" | "VnetLocal" | "Internet" | "VirtualAppliance" | "None") | string)␊ - /**␊ - * The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.␊ - */␊ - nextHopIpAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutesChildResource25 {␊ - name: string␊ - type: "routes"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Properties of the route.␊ - */␊ - properties: (RoutePropertiesFormat25 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutes25 {␊ - name: string␊ - type: "Microsoft.Network/routeTables/routes"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Properties of the route.␊ - */␊ - properties: (RoutePropertiesFormat25 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/securityPartnerProviders␊ - */␊ - export interface SecurityPartnerProviders {␊ - name: string␊ - type: "Microsoft.Network/securityPartnerProviders"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the Security Partner Provider.␊ - */␊ - properties: (SecurityPartnerProviderPropertiesFormat | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Security Partner Provider.␊ - */␊ - export interface SecurityPartnerProviderPropertiesFormat {␊ - /**␊ - * The security provider name.␊ - */␊ - securityProviderName?: (("ZScaler" | "IBoss" | "Checkpoint") | string)␊ - /**␊ - * The virtualHub to which the Security Partner Provider belongs.␊ - */␊ - virtualHub?: (SubResource33 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/serviceEndpointPolicies␊ - */␊ - export interface ServiceEndpointPolicies8 {␊ - name: string␊ - type: "Microsoft.Network/serviceEndpointPolicies"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the service end point policy.␊ - */␊ - properties: (ServiceEndpointPolicyPropertiesFormat8 | string)␊ - resources?: ServiceEndpointPoliciesServiceEndpointPolicyDefinitionsChildResource8[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Service Endpoint Policy resource.␊ - */␊ - export interface ServiceEndpointPolicyPropertiesFormat8 {␊ - /**␊ - * A collection of service endpoint policy definitions of the service endpoint policy.␊ - */␊ - serviceEndpointPolicyDefinitions?: (ServiceEndpointPolicyDefinition8[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Service Endpoint policy definitions.␊ - */␊ - export interface ServiceEndpointPolicyDefinition8 {␊ - /**␊ - * Properties of the service endpoint policy definition.␊ - */␊ - properties?: (ServiceEndpointPolicyDefinitionPropertiesFormat8 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Service Endpoint policy definition resource.␊ - */␊ - export interface ServiceEndpointPolicyDefinitionPropertiesFormat8 {␊ - /**␊ - * A description for this rule. Restricted to 140 chars.␊ - */␊ - description?: string␊ - /**␊ - * Service endpoint name.␊ - */␊ - service?: string␊ - /**␊ - * A list of service resources.␊ - */␊ - serviceResources?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions␊ - */␊ - export interface ServiceEndpointPoliciesServiceEndpointPolicyDefinitionsChildResource8 {␊ - name: string␊ - type: "serviceEndpointPolicyDefinitions"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Properties of the service endpoint policy definition.␊ - */␊ - properties: (ServiceEndpointPolicyDefinitionPropertiesFormat8 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions␊ - */␊ - export interface ServiceEndpointPoliciesServiceEndpointPolicyDefinitions8 {␊ - name: string␊ - type: "Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Properties of the service endpoint policy definition.␊ - */␊ - properties: (ServiceEndpointPolicyDefinitionPropertiesFormat8 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualHubs␊ - */␊ - export interface VirtualHubs10 {␊ - name: string␊ - type: "Microsoft.Network/virtualHubs"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual hub.␊ - */␊ - properties: (VirtualHubProperties10 | string)␊ - resources?: VirtualHubsRouteTablesChildResource3[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VirtualHub.␊ - */␊ - export interface VirtualHubProperties10 {␊ - /**␊ - * The VirtualWAN to which the VirtualHub belongs.␊ - */␊ - virtualWan?: (SubResource33 | string)␊ - /**␊ - * The VpnGateway associated with this VirtualHub.␊ - */␊ - vpnGateway?: (SubResource33 | string)␊ - /**␊ - * The P2SVpnGateway associated with this VirtualHub.␊ - */␊ - p2SVpnGateway?: (SubResource33 | string)␊ - /**␊ - * The expressRouteGateway associated with this VirtualHub.␊ - */␊ - expressRouteGateway?: (SubResource33 | string)␊ - /**␊ - * The azureFirewall associated with this VirtualHub.␊ - */␊ - azureFirewall?: (SubResource33 | string)␊ - /**␊ - * The securityPartnerProvider associated with this VirtualHub.␊ - */␊ - securityPartnerProvider?: (SubResource33 | string)␊ - /**␊ - * List of all vnet connections with this VirtualHub.␊ - */␊ - virtualNetworkConnections?: (HubVirtualNetworkConnection10[] | string)␊ - /**␊ - * Address-prefix for this VirtualHub.␊ - */␊ - addressPrefix?: string␊ - /**␊ - * The routeTable associated with this virtual hub.␊ - */␊ - routeTable?: (VirtualHubRouteTable7 | string)␊ - /**␊ - * The Security Provider name.␊ - */␊ - securityProviderName?: string␊ - /**␊ - * List of all virtual hub route table v2s associated with this VirtualHub.␊ - */␊ - virtualHubRouteTableV2s?: (VirtualHubRouteTableV23[] | string)␊ - /**␊ - * The sku of this VirtualHub.␊ - */␊ - sku?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HubVirtualNetworkConnection Resource.␊ - */␊ - export interface HubVirtualNetworkConnection10 {␊ - /**␊ - * Properties of the hub virtual network connection.␊ - */␊ - properties?: (HubVirtualNetworkConnectionProperties10 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for HubVirtualNetworkConnection.␊ - */␊ - export interface HubVirtualNetworkConnectionProperties10 {␊ - /**␊ - * Reference to the remote virtual network.␊ - */␊ - remoteVirtualNetwork?: (SubResource33 | string)␊ - /**␊ - * VirtualHub to RemoteVnet transit to enabled or not.␊ - */␊ - allowHubToRemoteVnetTransit?: (boolean | string)␊ - /**␊ - * Allow RemoteVnet to use Virtual Hub's gateways.␊ - */␊ - allowRemoteVnetToUseHubVnetGateways?: (boolean | string)␊ - /**␊ - * Enable internet security.␊ - */␊ - enableInternetSecurity?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualHub route table.␊ - */␊ - export interface VirtualHubRouteTable7 {␊ - /**␊ - * List of all routes.␊ - */␊ - routes?: (VirtualHubRoute7[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualHub route.␊ - */␊ - export interface VirtualHubRoute7 {␊ - /**␊ - * List of all addressPrefixes.␊ - */␊ - addressPrefixes?: (string[] | string)␊ - /**␊ - * NextHop ip address.␊ - */␊ - nextHopIpAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualHubRouteTableV2 Resource.␊ - */␊ - export interface VirtualHubRouteTableV23 {␊ - /**␊ - * Properties of the virtual hub route table v2.␊ - */␊ - properties?: (VirtualHubRouteTableV2Properties3 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VirtualHubRouteTableV2.␊ - */␊ - export interface VirtualHubRouteTableV2Properties3 {␊ - /**␊ - * List of all routes.␊ - */␊ - routes?: (VirtualHubRouteV23[] | string)␊ - /**␊ - * List of all connections attached to this route table v2.␊ - */␊ - attachedConnections?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualHubRouteTableV2 route.␊ - */␊ - export interface VirtualHubRouteV23 {␊ - /**␊ - * The type of destinations.␊ - */␊ - destinationType?: string␊ - /**␊ - * List of all destinations.␊ - */␊ - destinations?: (string[] | string)␊ - /**␊ - * The type of next hops.␊ - */␊ - nextHopType?: string␊ - /**␊ - * NextHops ip address.␊ - */␊ - nextHops?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualHubs/routeTables␊ - */␊ - export interface VirtualHubsRouteTablesChildResource3 {␊ - name: string␊ - type: "routeTables"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Properties of the virtual hub route table v2.␊ - */␊ - properties: (VirtualHubRouteTableV2Properties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualHubs/routeTables␊ - */␊ - export interface VirtualHubsRouteTables3 {␊ - name: string␊ - type: "Microsoft.Network/virtualHubs/routeTables"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Properties of the virtual hub route table v2.␊ - */␊ - properties: (VirtualHubRouteTableV2Properties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworkGateways␊ - */␊ - export interface VirtualNetworkGateways25 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworkGateways"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway.␊ - */␊ - properties: (VirtualNetworkGatewayPropertiesFormat25 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGateway properties.␊ - */␊ - export interface VirtualNetworkGatewayPropertiesFormat25 {␊ - /**␊ - * IP configurations for virtual network gateway.␊ - */␊ - ipConfigurations?: (VirtualNetworkGatewayIPConfiguration24[] | string)␊ - /**␊ - * The type of this virtual network gateway.␊ - */␊ - gatewayType?: (("Vpn" | "ExpressRoute" | "HyperNet") | string)␊ - /**␊ - * The type of this virtual network gateway.␊ - */␊ - vpnType?: (("PolicyBased" | "RouteBased") | string)␊ - /**␊ - * The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN.␊ - */␊ - vpnGatewayGeneration?: (("None" | "Generation1" | "Generation2") | string)␊ - /**␊ - * Whether BGP is enabled for this virtual network gateway or not.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * Whether private IP needs to be enabled on this gateway for connections or not.␊ - */␊ - enablePrivateIpAddress?: (boolean | string)␊ - /**␊ - * ActiveActive flag.␊ - */␊ - activeActive?: (boolean | string)␊ - /**␊ - * The reference to the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting.␊ - */␊ - gatewayDefaultSite?: (SubResource33 | string)␊ - /**␊ - * The reference to the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.␊ - */␊ - sku?: (VirtualNetworkGatewaySku24 | string)␊ - /**␊ - * The reference to the VpnClientConfiguration resource which represents the P2S VpnClient configurations.␊ - */␊ - vpnClientConfiguration?: (VpnClientConfiguration24 | string)␊ - /**␊ - * Virtual network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings24 | string)␊ - /**␊ - * The reference to the address space resource which represents the custom routes address space specified by the customer for virtual network gateway and VpnClient.␊ - */␊ - customRoutes?: (AddressSpace33 | string)␊ - /**␊ - * Whether dns forwarding is enabled or not.␊ - */␊ - enableDnsForwarding?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration for virtual network gateway.␊ - */␊ - export interface VirtualNetworkGatewayIPConfiguration24 {␊ - /**␊ - * Properties of the virtual network gateway ip configuration.␊ - */␊ - properties?: (VirtualNetworkGatewayIPConfigurationPropertiesFormat24 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of VirtualNetworkGatewayIPConfiguration.␊ - */␊ - export interface VirtualNetworkGatewayIPConfigurationPropertiesFormat24 {␊ - /**␊ - * The private IP address allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * The reference to the subnet resource.␊ - */␊ - subnet?: (SubResource33 | string)␊ - /**␊ - * The reference to the public IP resource.␊ - */␊ - publicIPAddress?: (SubResource33 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewaySku details.␊ - */␊ - export interface VirtualNetworkGatewaySku24 {␊ - /**␊ - * Gateway SKU name.␊ - */␊ - name?: (("Basic" | "HighPerformance" | "Standard" | "UltraPerformance" | "VpnGw1" | "VpnGw2" | "VpnGw3" | "VpnGw4" | "VpnGw5" | "VpnGw1AZ" | "VpnGw2AZ" | "VpnGw3AZ" | "VpnGw4AZ" | "VpnGw5AZ" | "ErGw1AZ" | "ErGw2AZ" | "ErGw3AZ") | string)␊ - /**␊ - * Gateway SKU tier.␊ - */␊ - tier?: (("Basic" | "HighPerformance" | "Standard" | "UltraPerformance" | "VpnGw1" | "VpnGw2" | "VpnGw3" | "VpnGw4" | "VpnGw5" | "VpnGw1AZ" | "VpnGw2AZ" | "VpnGw3AZ" | "VpnGw4AZ" | "VpnGw5AZ" | "ErGw1AZ" | "ErGw2AZ" | "ErGw3AZ") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnClientConfiguration for P2S client.␊ - */␊ - export interface VpnClientConfiguration24 {␊ - /**␊ - * The reference to the address space resource which represents Address space for P2S VpnClient.␊ - */␊ - vpnClientAddressPool?: (AddressSpace33 | string)␊ - /**␊ - * VpnClientRootCertificate for virtual network gateway.␊ - */␊ - vpnClientRootCertificates?: (VpnClientRootCertificate24[] | string)␊ - /**␊ - * VpnClientRevokedCertificate for Virtual network gateway.␊ - */␊ - vpnClientRevokedCertificates?: (VpnClientRevokedCertificate24[] | string)␊ - /**␊ - * VpnClientProtocols for Virtual network gateway.␊ - */␊ - vpnClientProtocols?: (("IkeV2" | "SSTP" | "OpenVPN")[] | string)␊ - /**␊ - * VpnClientIpsecPolicies for virtual network gateway P2S client.␊ - */␊ - vpnClientIpsecPolicies?: (IpsecPolicy22[] | string)␊ - /**␊ - * The radius server address property of the VirtualNetworkGateway resource for vpn client connection.␊ - */␊ - radiusServerAddress?: string␊ - /**␊ - * The radius secret property of the VirtualNetworkGateway resource for vpn client connection.␊ - */␊ - radiusServerSecret?: string␊ - /**␊ - * The radiusServers property for multiple radius server configuration.␊ - */␊ - radiusServers?: (RadiusServer[] | string)␊ - /**␊ - * The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication.␊ - */␊ - aadTenant?: string␊ - /**␊ - * The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication.␊ - */␊ - aadAudience?: string␊ - /**␊ - * The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication.␊ - */␊ - aadIssuer?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client root certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRootCertificate24 {␊ - /**␊ - * Properties of the vpn client root certificate.␊ - */␊ - properties: (VpnClientRootCertificatePropertiesFormat24 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of application gateway.␊ - */␊ - export interface VpnClientRootCertificatePropertiesFormat24 {␊ - /**␊ - * The certificate public data.␊ - */␊ - publicCertData: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client revoked certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRevokedCertificate24 {␊ - /**␊ - * Properties of the vpn client revoked certificate.␊ - */␊ - properties?: (VpnClientRevokedCertificatePropertiesFormat24 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the revoked VPN client certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRevokedCertificatePropertiesFormat24 {␊ - /**␊ - * The revoked VPN client certificate thumbprint.␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Radius Server Settings.␊ - */␊ - export interface RadiusServer {␊ - /**␊ - * The address of this radius server.␊ - */␊ - radiusServerAddress: string␊ - /**␊ - * The initial score assigned to this radius server.␊ - */␊ - radiusServerScore?: (number | string)␊ - /**␊ - * The secret used for this radius server.␊ - */␊ - radiusServerSecret?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks␊ - */␊ - export interface VirtualNetworks33 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network.␊ - */␊ - properties: (VirtualNetworkPropertiesFormat25 | string)␊ - resources?: (VirtualNetworksVirtualNetworkPeeringsChildResource22 | VirtualNetworksSubnetsChildResource25)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the virtual network.␊ - */␊ - export interface VirtualNetworkPropertiesFormat25 {␊ - /**␊ - * The AddressSpace that contains an array of IP address ranges that can be used by subnets.␊ - */␊ - addressSpace: (AddressSpace33 | string)␊ - /**␊ - * The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network.␊ - */␊ - dhcpOptions?: (DhcpOptions33 | string)␊ - /**␊ - * A list of subnets in a Virtual Network.␊ - */␊ - subnets?: (Subnet35[] | string)␊ - /**␊ - * A list of peerings in a Virtual Network.␊ - */␊ - virtualNetworkPeerings?: (VirtualNetworkPeering30[] | string)␊ - /**␊ - * Indicates if DDoS protection is enabled for all the protected resources in the virtual network. It requires a DDoS protection plan associated with the resource.␊ - */␊ - enableDdosProtection?: (boolean | string)␊ - /**␊ - * Indicates if VM protection is enabled for all the subnets in the virtual network.␊ - */␊ - enableVmProtection?: (boolean | string)␊ - /**␊ - * The DDoS protection plan associated with the virtual network.␊ - */␊ - ddosProtectionPlan?: (SubResource33 | string)␊ - /**␊ - * Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET.␊ - */␊ - bgpCommunities?: (VirtualNetworkBgpCommunities4 | string)␊ - /**␊ - * Array of IpAllocation which reference this VNET.␊ - */␊ - ipAllocations?: (SubResource33[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DhcpOptions contains an array of DNS servers available to VMs deployed in the virtual network. Standard DHCP option for a subnet overrides VNET DHCP options.␊ - */␊ - export interface DhcpOptions33 {␊ - /**␊ - * The list of DNS servers IP addresses.␊ - */␊ - dnsServers: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Subnet in a virtual network resource.␊ - */␊ - export interface Subnet35 {␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties?: (SubnetPropertiesFormat25 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the subnet.␊ - */␊ - export interface SubnetPropertiesFormat25 {␊ - /**␊ - * The address prefix for the subnet.␊ - */␊ - addressPrefix: string␊ - /**␊ - * List of address prefixes for the subnet.␊ - */␊ - addressPrefixes?: (string[] | string)␊ - /**␊ - * The reference to the NetworkSecurityGroup resource.␊ - */␊ - networkSecurityGroup?: (SubResource33 | string)␊ - /**␊ - * The reference to the RouteTable resource.␊ - */␊ - routeTable?: (SubResource33 | string)␊ - /**␊ - * Nat gateway associated with this subnet.␊ - */␊ - natGateway?: (SubResource33 | string)␊ - /**␊ - * An array of service endpoints.␊ - */␊ - serviceEndpoints?: (ServiceEndpointPropertiesFormat21[] | string)␊ - /**␊ - * An array of service endpoint policies.␊ - */␊ - serviceEndpointPolicies?: (SubResource33[] | string)␊ - /**␊ - * Array of IpAllocation which reference this subnet.␊ - */␊ - ipAllocations?: (SubResource33[] | string)␊ - /**␊ - * An array of references to the delegations on the subnet.␊ - */␊ - delegations?: (Delegation12[] | string)␊ - /**␊ - * Enable or Disable apply network policies on private end point in the subnet.␊ - */␊ - privateEndpointNetworkPolicies?: string␊ - /**␊ - * Enable or Disable apply network policies on private link service in the subnet.␊ - */␊ - privateLinkServiceNetworkPolicies?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The service endpoint properties.␊ - */␊ - export interface ServiceEndpointPropertiesFormat21 {␊ - /**␊ - * The type of the endpoint service.␊ - */␊ - service?: string␊ - /**␊ - * A list of locations.␊ - */␊ - locations?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Details the service to which the subnet is delegated.␊ - */␊ - export interface Delegation12 {␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties?: (ServiceDelegationPropertiesFormat12 | string)␊ - /**␊ - * The name of the resource that is unique within a subnet. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a service delegation.␊ - */␊ - export interface ServiceDelegationPropertiesFormat12 {␊ - /**␊ - * The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers).␊ - */␊ - serviceName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peerings in a virtual network resource.␊ - */␊ - export interface VirtualNetworkPeering30 {␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties?: (VirtualNetworkPeeringPropertiesFormat22 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - export interface VirtualNetworkPeeringPropertiesFormat22 {␊ - /**␊ - * Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space.␊ - */␊ - allowVirtualNetworkAccess?: (boolean | string)␊ - /**␊ - * Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network.␊ - */␊ - allowForwardedTraffic?: (boolean | string)␊ - /**␊ - * If gateway links can be used in remote virtual networking to link to this virtual network.␊ - */␊ - allowGatewayTransit?: (boolean | string)␊ - /**␊ - * If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway.␊ - */␊ - useRemoteGateways?: (boolean | string)␊ - /**␊ - * The reference to the remote virtual network. The remote virtual network can be in the same or different region (preview). See here to register for the preview and learn more (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering).␊ - */␊ - remoteVirtualNetwork: (SubResource33 | string)␊ - /**␊ - * The reference to the remote virtual network address space.␊ - */␊ - remoteAddressSpace?: (AddressSpace33 | string)␊ - /**␊ - * The status of the virtual network peering.␊ - */␊ - peeringState?: (("Initiated" | "Connected" | "Disconnected") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET.␊ - */␊ - export interface VirtualNetworkBgpCommunities4 {␊ - /**␊ - * The BGP community associated with the virtual network.␊ - */␊ - virtualNetworkCommunity: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/virtualNetworkPeerings␊ - */␊ - export interface VirtualNetworksVirtualNetworkPeeringsChildResource22 {␊ - name: string␊ - type: "virtualNetworkPeerings"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties: (VirtualNetworkPeeringPropertiesFormat22 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnetsChildResource25 {␊ - name: string␊ - type: "subnets"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties: (SubnetPropertiesFormat25 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnets25 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks/subnets"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties: (SubnetPropertiesFormat25 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/virtualNetworkPeerings␊ - */␊ - export interface VirtualNetworksVirtualNetworkPeerings22 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks/virtualNetworkPeerings"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties: (VirtualNetworkPeeringPropertiesFormat22 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworkTaps␊ - */␊ - export interface VirtualNetworkTaps7 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworkTaps"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Virtual Network Tap Properties.␊ - */␊ - properties: (VirtualNetworkTapPropertiesFormat7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Virtual Network Tap properties.␊ - */␊ - export interface VirtualNetworkTapPropertiesFormat7 {␊ - /**␊ - * The reference to the private IP Address of the collector nic that will receive the tap.␊ - */␊ - destinationNetworkInterfaceIPConfiguration?: (SubResource33 | string)␊ - /**␊ - * The reference to the private IP address on the internal Load Balancer that will receive the tap.␊ - */␊ - destinationLoadBalancerFrontEndIPConfiguration?: (SubResource33 | string)␊ - /**␊ - * The VXLAN destination port that will receive the tapped traffic.␊ - */␊ - destinationPort?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualRouters␊ - */␊ - export interface VirtualRouters5 {␊ - name: string␊ - type: "Microsoft.Network/virtualRouters"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the Virtual Router.␊ - */␊ - properties: (VirtualRouterPropertiesFormat5 | string)␊ - resources?: VirtualRoutersPeeringsChildResource5[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Virtual Router definition.␊ - */␊ - export interface VirtualRouterPropertiesFormat5 {␊ - /**␊ - * VirtualRouter ASN.␊ - */␊ - virtualRouterAsn?: (number | string)␊ - /**␊ - * VirtualRouter IPs.␊ - */␊ - virtualRouterIps?: (string[] | string)␊ - /**␊ - * The Subnet on which VirtualRouter is hosted.␊ - */␊ - hostedSubnet?: (SubResource33 | string)␊ - /**␊ - * The Gateway on which VirtualRouter is hosted.␊ - */␊ - hostedGateway?: (SubResource33 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualRouters/peerings␊ - */␊ - export interface VirtualRoutersPeeringsChildResource5 {␊ - name: string␊ - type: "peerings"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * The properties of the Virtual Router Peering.␊ - */␊ - properties: (VirtualRouterPeeringProperties5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the rule group.␊ - */␊ - export interface VirtualRouterPeeringProperties5 {␊ - /**␊ - * Peer ASN.␊ - */␊ - peerAsn?: (number | string)␊ - /**␊ - * Peer IP.␊ - */␊ - peerIp?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualRouters/peerings␊ - */␊ - export interface VirtualRoutersPeerings5 {␊ - name: string␊ - type: "Microsoft.Network/virtualRouters/peerings"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * The properties of the Virtual Router Peering.␊ - */␊ - properties: (VirtualRouterPeeringProperties5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualWans␊ - */␊ - export interface VirtualWans10 {␊ - name: string␊ - type: "Microsoft.Network/virtualWans"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual WAN.␊ - */␊ - properties: (VirtualWanProperties10 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VirtualWAN.␊ - */␊ - export interface VirtualWanProperties10 {␊ - /**␊ - * Vpn encryption to be disabled or not.␊ - */␊ - disableVpnEncryption?: (boolean | string)␊ - /**␊ - * True if branch to branch traffic is allowed.␊ - */␊ - allowBranchToBranchTraffic?: (boolean | string)␊ - /**␊ - * True if Vnet to Vnet traffic is allowed.␊ - */␊ - allowVnetToVnetTraffic?: (boolean | string)␊ - /**␊ - * The office local breakout category.␊ - */␊ - office365LocalBreakoutCategory?: (("Optimize" | "OptimizeAndAllow" | "All" | "None") | string)␊ - /**␊ - * The type of the VirtualWAN.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnGateways␊ - */␊ - export interface VpnGateways10 {␊ - name: string␊ - type: "Microsoft.Network/vpnGateways"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the VPN gateway.␊ - */␊ - properties: (VpnGatewayProperties10 | string)␊ - resources?: VpnGatewaysVpnConnectionsChildResource10[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnGateway.␊ - */␊ - export interface VpnGatewayProperties10 {␊ - /**␊ - * The VirtualHub to which the gateway belongs.␊ - */␊ - virtualHub?: (SubResource33 | string)␊ - /**␊ - * List of all vpn connections to the gateway.␊ - */␊ - connections?: (VpnConnection10[] | string)␊ - /**␊ - * Local network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings24 | string)␊ - /**␊ - * The scale unit for this vpn gateway.␊ - */␊ - vpnGatewayScaleUnit?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnConnection Resource.␊ - */␊ - export interface VpnConnection10 {␊ - /**␊ - * Properties of the VPN connection.␊ - */␊ - properties?: (VpnConnectionProperties10 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnConnection.␊ - */␊ - export interface VpnConnectionProperties10 {␊ - /**␊ - * Id of the connected vpn site.␊ - */␊ - remoteVpnSite?: (SubResource33 | string)␊ - /**␊ - * Routing weight for vpn connection.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * The dead peer detection timeout for a vpn connection in seconds.␊ - */␊ - dpdTimeoutSeconds?: (number | string)␊ - /**␊ - * The connection status.␊ - */␊ - connectionStatus?: (("Unknown" | "Connecting" | "Connected" | "NotConnected") | string)␊ - /**␊ - * Connection protocol used for this connection.␊ - */␊ - vpnConnectionProtocolType?: (("IKEv2" | "IKEv1") | string)␊ - /**␊ - * Expected bandwidth in MBPS.␊ - */␊ - connectionBandwidth?: (number | string)␊ - /**␊ - * SharedKey for the vpn connection.␊ - */␊ - sharedKey?: string␊ - /**␊ - * EnableBgp flag.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * Enable policy-based traffic selectors.␊ - */␊ - usePolicyBasedTrafficSelectors?: (boolean | string)␊ - /**␊ - * The IPSec Policies to be considered by this connection.␊ - */␊ - ipsecPolicies?: (IpsecPolicy22[] | string)␊ - /**␊ - * EnableBgp flag.␊ - */␊ - enableRateLimiting?: (boolean | string)␊ - /**␊ - * Enable internet security.␊ - */␊ - enableInternetSecurity?: (boolean | string)␊ - /**␊ - * Use local azure ip to initiate connection.␊ - */␊ - useLocalAzureIpAddress?: (boolean | string)␊ - /**␊ - * List of all vpn site link connections to the gateway.␊ - */␊ - vpnLinkConnections?: (VpnSiteLinkConnection6[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnSiteLinkConnection Resource.␊ - */␊ - export interface VpnSiteLinkConnection6 {␊ - /**␊ - * Properties of the VPN site link connection.␊ - */␊ - properties?: (VpnSiteLinkConnectionProperties6 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnConnection.␊ - */␊ - export interface VpnSiteLinkConnectionProperties6 {␊ - /**␊ - * Id of the connected vpn site link.␊ - */␊ - vpnSiteLink?: (SubResource33 | string)␊ - /**␊ - * Routing weight for vpn connection.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * The connection status.␊ - */␊ - connectionStatus?: (("Unknown" | "Connecting" | "Connected" | "NotConnected") | string)␊ - /**␊ - * Connection protocol used for this connection.␊ - */␊ - vpnConnectionProtocolType?: (("IKEv2" | "IKEv1") | string)␊ - /**␊ - * Expected bandwidth in MBPS.␊ - */␊ - connectionBandwidth?: (number | string)␊ - /**␊ - * SharedKey for the vpn connection.␊ - */␊ - sharedKey?: string␊ - /**␊ - * EnableBgp flag.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * Enable policy-based traffic selectors.␊ - */␊ - usePolicyBasedTrafficSelectors?: (boolean | string)␊ - /**␊ - * The IPSec Policies to be considered by this connection.␊ - */␊ - ipsecPolicies?: (IpsecPolicy22[] | string)␊ - /**␊ - * EnableBgp flag.␊ - */␊ - enableRateLimiting?: (boolean | string)␊ - /**␊ - * Use local azure ip to initiate connection.␊ - */␊ - useLocalAzureIpAddress?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnGateways/vpnConnections␊ - */␊ - export interface VpnGatewaysVpnConnectionsChildResource10 {␊ - name: string␊ - type: "vpnConnections"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Properties of the VPN connection.␊ - */␊ - properties: (VpnConnectionProperties10 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnGateways/vpnConnections␊ - */␊ - export interface VpnGatewaysVpnConnections10 {␊ - name: string␊ - type: "Microsoft.Network/vpnGateways/vpnConnections"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Properties of the VPN connection.␊ - */␊ - properties: (VpnConnectionProperties10 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnServerConfigurations␊ - */␊ - export interface VpnServerConfigurations4 {␊ - name: string␊ - type: "Microsoft.Network/vpnServerConfigurations"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the P2SVpnServer configuration.␊ - */␊ - properties: (VpnServerConfigurationProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnServerConfiguration.␊ - */␊ - export interface VpnServerConfigurationProperties4 {␊ - /**␊ - * The name of the VpnServerConfiguration that is unique within a resource group.␊ - */␊ - name?: string␊ - /**␊ - * VPN protocols for the VpnServerConfiguration.␊ - */␊ - vpnProtocols?: (("IkeV2" | "OpenVPN")[] | string)␊ - /**␊ - * VPN authentication types for the VpnServerConfiguration.␊ - */␊ - vpnAuthenticationTypes?: (("Certificate" | "Radius" | "AAD")[] | string)␊ - /**␊ - * VPN client root certificate of VpnServerConfiguration.␊ - */␊ - vpnClientRootCertificates?: (VpnServerConfigVpnClientRootCertificate4[] | string)␊ - /**␊ - * VPN client revoked certificate of VpnServerConfiguration.␊ - */␊ - vpnClientRevokedCertificates?: (VpnServerConfigVpnClientRevokedCertificate4[] | string)␊ - /**␊ - * Radius Server root certificate of VpnServerConfiguration.␊ - */␊ - radiusServerRootCertificates?: (VpnServerConfigRadiusServerRootCertificate4[] | string)␊ - /**␊ - * Radius client root certificate of VpnServerConfiguration.␊ - */␊ - radiusClientRootCertificates?: (VpnServerConfigRadiusClientRootCertificate4[] | string)␊ - /**␊ - * VpnClientIpsecPolicies for VpnServerConfiguration.␊ - */␊ - vpnClientIpsecPolicies?: (IpsecPolicy22[] | string)␊ - /**␊ - * The radius server address property of the VpnServerConfiguration resource for point to site client connection.␊ - */␊ - radiusServerAddress?: string␊ - /**␊ - * The radius secret property of the VpnServerConfiguration resource for point to site client connection.␊ - */␊ - radiusServerSecret?: string␊ - /**␊ - * Multiple Radius Server configuration for VpnServerConfiguration.␊ - */␊ - radiusServers?: (RadiusServer[] | string)␊ - /**␊ - * The set of aad vpn authentication parameters.␊ - */␊ - aadAuthenticationParameters?: (AadAuthenticationParameters4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of VPN client root certificate of VpnServerConfiguration.␊ - */␊ - export interface VpnServerConfigVpnClientRootCertificate4 {␊ - /**␊ - * The certificate name.␊ - */␊ - name?: string␊ - /**␊ - * The certificate public data.␊ - */␊ - publicCertData?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the revoked VPN client certificate of VpnServerConfiguration.␊ - */␊ - export interface VpnServerConfigVpnClientRevokedCertificate4 {␊ - /**␊ - * The certificate name.␊ - */␊ - name?: string␊ - /**␊ - * The revoked VPN client certificate thumbprint.␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Radius Server root certificate of VpnServerConfiguration.␊ - */␊ - export interface VpnServerConfigRadiusServerRootCertificate4 {␊ - /**␊ - * The certificate name.␊ - */␊ - name?: string␊ - /**␊ - * The certificate public data.␊ - */␊ - publicCertData?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Radius client root certificate of VpnServerConfiguration.␊ - */␊ - export interface VpnServerConfigRadiusClientRootCertificate4 {␊ - /**␊ - * The certificate name.␊ - */␊ - name?: string␊ - /**␊ - * The Radius client root certificate thumbprint.␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AAD Vpn authentication type related parameters.␊ - */␊ - export interface AadAuthenticationParameters4 {␊ - /**␊ - * AAD Vpn authentication parameter AAD tenant.␊ - */␊ - aadTenant?: string␊ - /**␊ - * AAD Vpn authentication parameter AAD audience.␊ - */␊ - aadAudience?: string␊ - /**␊ - * AAD Vpn authentication parameter AAD issuer.␊ - */␊ - aadIssuer?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnSites␊ - */␊ - export interface VpnSites10 {␊ - name: string␊ - type: "Microsoft.Network/vpnSites"␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the VPN site.␊ - */␊ - properties: (VpnSiteProperties10 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnSite.␊ - */␊ - export interface VpnSiteProperties10 {␊ - /**␊ - * The VirtualWAN to which the vpnSite belongs.␊ - */␊ - virtualWan?: (SubResource33 | string)␊ - /**␊ - * The device properties.␊ - */␊ - deviceProperties?: (DeviceProperties10 | string)␊ - /**␊ - * The ip-address for the vpn-site.␊ - */␊ - ipAddress?: string␊ - /**␊ - * The key for vpn-site that can be used for connections.␊ - */␊ - siteKey?: string␊ - /**␊ - * The AddressSpace that contains an array of IP address ranges.␊ - */␊ - addressSpace?: (AddressSpace33 | string)␊ - /**␊ - * The set of bgp properties.␊ - */␊ - bgpProperties?: (BgpSettings24 | string)␊ - /**␊ - * IsSecuritySite flag.␊ - */␊ - isSecuritySite?: (boolean | string)␊ - /**␊ - * List of all vpn site links.␊ - */␊ - vpnSiteLinks?: (VpnSiteLink6[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * List of properties of the device.␊ - */␊ - export interface DeviceProperties10 {␊ - /**␊ - * Name of the device Vendor.␊ - */␊ - deviceVendor?: string␊ - /**␊ - * Model of the device.␊ - */␊ - deviceModel?: string␊ - /**␊ - * Link speed.␊ - */␊ - linkSpeedInMbps?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnSiteLink Resource.␊ - */␊ - export interface VpnSiteLink6 {␊ - /**␊ - * Properties of the VPN site link.␊ - */␊ - properties?: (VpnSiteLinkProperties6 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnSite.␊ - */␊ - export interface VpnSiteLinkProperties6 {␊ - /**␊ - * The link provider properties.␊ - */␊ - linkProperties?: (VpnLinkProviderProperties6 | string)␊ - /**␊ - * The ip-address for the vpn-site-link.␊ - */␊ - ipAddress?: string␊ - /**␊ - * FQDN of vpn-site-link.␊ - */␊ - fqdn?: string␊ - /**␊ - * The set of bgp properties.␊ - */␊ - bgpProperties?: (VpnLinkBgpSettings6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * List of properties of a link provider.␊ - */␊ - export interface VpnLinkProviderProperties6 {␊ - /**␊ - * Name of the link provider.␊ - */␊ - linkProviderName?: string␊ - /**␊ - * Link speed.␊ - */␊ - linkSpeedInMbps?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * BGP settings details for a link.␊ - */␊ - export interface VpnLinkBgpSettings6 {␊ - /**␊ - * The BGP speaker's ASN.␊ - */␊ - asn?: (number | string)␊ - /**␊ - * The BGP peering address and BGP identifier of this BGP speaker.␊ - */␊ - bgpPeeringAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/applicationGateways␊ - */␊ - export interface ApplicationGateways26 {␊ - name: string␊ - type: "Microsoft.Network/applicationGateways"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the application gateway.␊ - */␊ - properties: (ApplicationGatewayPropertiesFormat26 | string)␊ - /**␊ - * A list of availability zones denoting where the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - /**␊ - * The identity of the application gateway, if configured.␊ - */␊ - identity?: (ManagedServiceIdentity12 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application gateway.␊ - */␊ - export interface ApplicationGatewayPropertiesFormat26 {␊ - /**␊ - * SKU of the application gateway resource.␊ - */␊ - sku?: (ApplicationGatewaySku26 | string)␊ - /**␊ - * SSL policy of the application gateway resource.␊ - */␊ - sslPolicy?: (ApplicationGatewaySslPolicy23 | string)␊ - /**␊ - * Subnets of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - gatewayIPConfigurations?: (ApplicationGatewayIPConfiguration26[] | string)␊ - /**␊ - * Authentication certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - authenticationCertificates?: (ApplicationGatewayAuthenticationCertificate23[] | string)␊ - /**␊ - * Trusted Root certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - trustedRootCertificates?: (ApplicationGatewayTrustedRootCertificate13[] | string)␊ - /**␊ - * SSL certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - sslCertificates?: (ApplicationGatewaySslCertificate26[] | string)␊ - /**␊ - * Frontend IP addresses of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - frontendIPConfigurations?: (ApplicationGatewayFrontendIPConfiguration26[] | string)␊ - /**␊ - * Frontend ports of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - frontendPorts?: (ApplicationGatewayFrontendPort26[] | string)␊ - /**␊ - * Probes of the application gateway resource.␊ - */␊ - probes?: (ApplicationGatewayProbe25[] | string)␊ - /**␊ - * Backend address pool of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - backendAddressPools?: (ApplicationGatewayBackendAddressPool26[] | string)␊ - /**␊ - * Backend http settings of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - backendHttpSettingsCollection?: (ApplicationGatewayBackendHttpSettings26[] | string)␊ - /**␊ - * Http listeners of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - httpListeners?: (ApplicationGatewayHttpListener26[] | string)␊ - /**␊ - * URL path map of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - urlPathMaps?: (ApplicationGatewayUrlPathMap25[] | string)␊ - /**␊ - * Request routing rules of the application gateway resource.␊ - */␊ - requestRoutingRules?: (ApplicationGatewayRequestRoutingRule26[] | string)␊ - /**␊ - * Rewrite rules for the application gateway resource.␊ - */␊ - rewriteRuleSets?: (ApplicationGatewayRewriteRuleSet12[] | string)␊ - /**␊ - * Redirect configurations of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - redirectConfigurations?: (ApplicationGatewayRedirectConfiguration23[] | string)␊ - /**␊ - * Web application firewall configuration.␊ - */␊ - webApplicationFirewallConfiguration?: (ApplicationGatewayWebApplicationFirewallConfiguration23 | string)␊ - /**␊ - * Reference to the FirewallPolicy resource.␊ - */␊ - firewallPolicy?: (SubResource34 | string)␊ - /**␊ - * Whether HTTP2 is enabled on the application gateway resource.␊ - */␊ - enableHttp2?: (boolean | string)␊ - /**␊ - * Whether FIPS is enabled on the application gateway resource.␊ - */␊ - enableFips?: (boolean | string)␊ - /**␊ - * Autoscale Configuration.␊ - */␊ - autoscaleConfiguration?: (ApplicationGatewayAutoscaleConfiguration16 | string)␊ - /**␊ - * Custom error configurations of the application gateway resource.␊ - */␊ - customErrorConfigurations?: (ApplicationGatewayCustomError13[] | string)␊ - /**␊ - * If true, associates a firewall policy with an application gateway regardless whether the policy differs from the WAF Config.␊ - */␊ - forceFirewallPolicyAssociation?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of an application gateway.␊ - */␊ - export interface ApplicationGatewaySku26 {␊ - /**␊ - * Name of an application gateway SKU.␊ - */␊ - name?: (("Standard_Small" | "Standard_Medium" | "Standard_Large" | "WAF_Medium" | "WAF_Large" | "Standard_v2" | "WAF_v2") | string)␊ - /**␊ - * Tier of an application gateway.␊ - */␊ - tier?: (("Standard" | "WAF" | "Standard_v2" | "WAF_v2") | string)␊ - /**␊ - * Capacity (instance count) of an application gateway.␊ - */␊ - capacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application Gateway Ssl policy.␊ - */␊ - export interface ApplicationGatewaySslPolicy23 {␊ - /**␊ - * Ssl protocols to be disabled on application gateway.␊ - */␊ - disabledSslProtocols?: (("TLSv1_0" | "TLSv1_1" | "TLSv1_2")[] | string)␊ - /**␊ - * Type of Ssl Policy.␊ - */␊ - policyType?: (("Predefined" | "Custom") | string)␊ - /**␊ - * Name of Ssl predefined policy.␊ - */␊ - policyName?: (("AppGwSslPolicy20150501" | "AppGwSslPolicy20170401" | "AppGwSslPolicy20170401S") | string)␊ - /**␊ - * Ssl cipher suites to be enabled in the specified order to application gateway.␊ - */␊ - cipherSuites?: (("TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384" | "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256" | "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA" | "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA" | "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384" | "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256" | "TLS_DHE_RSA_WITH_AES_256_CBC_SHA" | "TLS_DHE_RSA_WITH_AES_128_CBC_SHA" | "TLS_RSA_WITH_AES_256_GCM_SHA384" | "TLS_RSA_WITH_AES_128_GCM_SHA256" | "TLS_RSA_WITH_AES_256_CBC_SHA256" | "TLS_RSA_WITH_AES_128_CBC_SHA256" | "TLS_RSA_WITH_AES_256_CBC_SHA" | "TLS_RSA_WITH_AES_128_CBC_SHA" | "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384" | "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256" | "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384" | "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256" | "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA" | "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA" | "TLS_DHE_DSS_WITH_AES_256_CBC_SHA256" | "TLS_DHE_DSS_WITH_AES_128_CBC_SHA256" | "TLS_DHE_DSS_WITH_AES_256_CBC_SHA" | "TLS_DHE_DSS_WITH_AES_128_CBC_SHA" | "TLS_RSA_WITH_3DES_EDE_CBC_SHA" | "TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA" | "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256" | "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384")[] | string)␊ - /**␊ - * Minimum version of Ssl protocol to be supported on application gateway.␊ - */␊ - minProtocolVersion?: (("TLSv1_0" | "TLSv1_1" | "TLSv1_2") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed.␊ - */␊ - export interface ApplicationGatewayIPConfiguration26 {␊ - /**␊ - * Properties of the application gateway IP configuration.␊ - */␊ - properties?: (ApplicationGatewayIPConfigurationPropertiesFormat26 | string)␊ - /**␊ - * Name of the IP configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayIPConfigurationPropertiesFormat26 {␊ - /**␊ - * Reference to the subnet resource. A subnet from where application gateway gets its private address.␊ - */␊ - subnet?: (SubResource34 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Reference to another subresource.␊ - */␊ - export interface SubResource34 {␊ - /**␊ - * Resource ID.␊ - */␊ - id: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authentication certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewayAuthenticationCertificate23 {␊ - /**␊ - * Properties of the application gateway authentication certificate.␊ - */␊ - properties?: (ApplicationGatewayAuthenticationCertificatePropertiesFormat23 | string)␊ - /**␊ - * Name of the authentication certificate that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authentication certificates properties of an application gateway.␊ - */␊ - export interface ApplicationGatewayAuthenticationCertificatePropertiesFormat23 {␊ - /**␊ - * Certificate public data.␊ - */␊ - data?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trusted Root certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewayTrustedRootCertificate13 {␊ - /**␊ - * Properties of the application gateway trusted root certificate.␊ - */␊ - properties?: (ApplicationGatewayTrustedRootCertificatePropertiesFormat13 | string)␊ - /**␊ - * Name of the trusted root certificate that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trusted Root certificates properties of an application gateway.␊ - */␊ - export interface ApplicationGatewayTrustedRootCertificatePropertiesFormat13 {␊ - /**␊ - * Certificate public data.␊ - */␊ - data?: string␊ - /**␊ - * Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault.␊ - */␊ - keyVaultSecretId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSL certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewaySslCertificate26 {␊ - /**␊ - * Properties of the application gateway SSL certificate.␊ - */␊ - properties?: (ApplicationGatewaySslCertificatePropertiesFormat26 | string)␊ - /**␊ - * Name of the SSL certificate that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewaySslCertificatePropertiesFormat26 {␊ - /**␊ - * Base-64 encoded pfx certificate. Only applicable in PUT Request.␊ - */␊ - data?: string␊ - /**␊ - * Password for the pfx file specified in data. Only applicable in PUT request.␊ - */␊ - password?: string␊ - /**␊ - * Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault.␊ - */␊ - keyVaultSecretId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendIPConfiguration26 {␊ - /**␊ - * Properties of the application gateway frontend IP configuration.␊ - */␊ - properties?: (ApplicationGatewayFrontendIPConfigurationPropertiesFormat26 | string)␊ - /**␊ - * Name of the frontend IP configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendIPConfigurationPropertiesFormat26 {␊ - /**␊ - * PrivateIPAddress of the network interface IP Configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The private IP address allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Reference to the subnet resource.␊ - */␊ - subnet?: (SubResource34 | string)␊ - /**␊ - * Reference to the PublicIP resource.␊ - */␊ - publicIPAddress?: (SubResource34 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend port of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendPort26 {␊ - /**␊ - * Properties of the application gateway frontend port.␊ - */␊ - properties?: (ApplicationGatewayFrontendPortPropertiesFormat26 | string)␊ - /**␊ - * Name of the frontend port that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend port of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendPortPropertiesFormat26 {␊ - /**␊ - * Frontend port.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Probe of the application gateway.␊ - */␊ - export interface ApplicationGatewayProbe25 {␊ - /**␊ - * Properties of the application gateway probe.␊ - */␊ - properties?: (ApplicationGatewayProbePropertiesFormat25 | string)␊ - /**␊ - * Name of the probe that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of probe of an application gateway.␊ - */␊ - export interface ApplicationGatewayProbePropertiesFormat25 {␊ - /**␊ - * The protocol used for the probe.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Host name to send the probe to.␊ - */␊ - host?: string␊ - /**␊ - * Relative path of probe. Valid path starts from '/'. Probe is sent to ://:.␊ - */␊ - path?: string␊ - /**␊ - * The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - interval?: (number | string)␊ - /**␊ - * The probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - timeout?: (number | string)␊ - /**␊ - * The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20.␊ - */␊ - unhealthyThreshold?: (number | string)␊ - /**␊ - * Whether the host header should be picked from the backend http settings. Default value is false.␊ - */␊ - pickHostNameFromBackendHttpSettings?: (boolean | string)␊ - /**␊ - * Minimum number of servers that are always marked healthy. Default value is 0.␊ - */␊ - minServers?: (number | string)␊ - /**␊ - * Criterion for classifying a healthy probe response.␊ - */␊ - match?: (ApplicationGatewayProbeHealthResponseMatch23 | string)␊ - /**␊ - * Custom port which will be used for probing the backend servers. The valid value ranges from 1 to 65535. In case not set, port from http settings will be used. This property is valid for Standard_v2 and WAF_v2 only.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application gateway probe health response match.␊ - */␊ - export interface ApplicationGatewayProbeHealthResponseMatch23 {␊ - /**␊ - * Body that must be contained in the health response. Default value is empty.␊ - */␊ - body?: string␊ - /**␊ - * Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399.␊ - */␊ - statusCodes?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend Address Pool of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddressPool26 {␊ - /**␊ - * Properties of the application gateway backend address pool.␊ - */␊ - properties?: (ApplicationGatewayBackendAddressPoolPropertiesFormat26 | string)␊ - /**␊ - * Name of the backend address pool that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend Address Pool of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddressPoolPropertiesFormat26 {␊ - /**␊ - * Backend addresses.␊ - */␊ - backendAddresses?: (ApplicationGatewayBackendAddress26[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddress26 {␊ - /**␊ - * Fully qualified domain name (FQDN).␊ - */␊ - fqdn?: string␊ - /**␊ - * IP address.␊ - */␊ - ipAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address pool settings of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendHttpSettings26 {␊ - /**␊ - * Properties of the application gateway backend HTTP settings.␊ - */␊ - properties?: (ApplicationGatewayBackendHttpSettingsPropertiesFormat26 | string)␊ - /**␊ - * Name of the backend http settings that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend address pool settings of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendHttpSettingsPropertiesFormat26 {␊ - /**␊ - * The destination port on the backend.␊ - */␊ - port?: (number | string)␊ - /**␊ - * The protocol used to communicate with the backend.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Cookie based affinity.␊ - */␊ - cookieBasedAffinity?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Request timeout in seconds. Application Gateway will fail the request if response is not received within RequestTimeout. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - requestTimeout?: (number | string)␊ - /**␊ - * Probe resource of an application gateway.␊ - */␊ - probe?: (SubResource34 | string)␊ - /**␊ - * Array of references to application gateway authentication certificates.␊ - */␊ - authenticationCertificates?: (SubResource34[] | string)␊ - /**␊ - * Array of references to application gateway trusted root certificates.␊ - */␊ - trustedRootCertificates?: (SubResource34[] | string)␊ - /**␊ - * Connection draining of the backend http settings resource.␊ - */␊ - connectionDraining?: (ApplicationGatewayConnectionDraining23 | string)␊ - /**␊ - * Host header to be sent to the backend servers.␊ - */␊ - hostName?: string␊ - /**␊ - * Whether to pick host header should be picked from the host name of the backend server. Default value is false.␊ - */␊ - pickHostNameFromBackendAddress?: (boolean | string)␊ - /**␊ - * Cookie name to use for the affinity cookie.␊ - */␊ - affinityCookieName?: string␊ - /**␊ - * Whether the probe is enabled. Default value is false.␊ - */␊ - probeEnabled?: (boolean | string)␊ - /**␊ - * Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null.␊ - */␊ - path?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Connection draining allows open connections to a backend server to be active for a specified time after the backend server got removed from the configuration.␊ - */␊ - export interface ApplicationGatewayConnectionDraining23 {␊ - /**␊ - * Whether connection draining is enabled or not.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds.␊ - */␊ - drainTimeoutInSec: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http listener of an application gateway.␊ - */␊ - export interface ApplicationGatewayHttpListener26 {␊ - /**␊ - * Properties of the application gateway HTTP listener.␊ - */␊ - properties?: (ApplicationGatewayHttpListenerPropertiesFormat26 | string)␊ - /**␊ - * Name of the HTTP listener that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of HTTP listener of an application gateway.␊ - */␊ - export interface ApplicationGatewayHttpListenerPropertiesFormat26 {␊ - /**␊ - * Frontend IP configuration resource of an application gateway.␊ - */␊ - frontendIPConfiguration?: (SubResource34 | string)␊ - /**␊ - * Frontend port resource of an application gateway.␊ - */␊ - frontendPort?: (SubResource34 | string)␊ - /**␊ - * Protocol of the HTTP listener.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Host name of HTTP listener.␊ - */␊ - hostName?: string␊ - /**␊ - * SSL certificate resource of an application gateway.␊ - */␊ - sslCertificate?: (SubResource34 | string)␊ - /**␊ - * Applicable only if protocol is https. Enables SNI for multi-hosting.␊ - */␊ - requireServerNameIndication?: (boolean | string)␊ - /**␊ - * Custom error configurations of the HTTP listener.␊ - */␊ - customErrorConfigurations?: (ApplicationGatewayCustomError13[] | string)␊ - /**␊ - * Reference to the FirewallPolicy resource.␊ - */␊ - firewallPolicy?: (SubResource34 | string)␊ - /**␊ - * List of Host names for HTTP Listener that allows special wildcard characters as well.␊ - */␊ - hostNames?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Customer error of an application gateway.␊ - */␊ - export interface ApplicationGatewayCustomError13 {␊ - /**␊ - * Status code of the application gateway customer error.␊ - */␊ - statusCode?: (("HttpStatus403" | "HttpStatus502") | string)␊ - /**␊ - * Error page URL of the application gateway customer error.␊ - */␊ - customErrorPageUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * UrlPathMaps give a url path to the backend mapping information for PathBasedRouting.␊ - */␊ - export interface ApplicationGatewayUrlPathMap25 {␊ - /**␊ - * Properties of the application gateway URL path map.␊ - */␊ - properties?: (ApplicationGatewayUrlPathMapPropertiesFormat25 | string)␊ - /**␊ - * Name of the URL path map that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of UrlPathMap of the application gateway.␊ - */␊ - export interface ApplicationGatewayUrlPathMapPropertiesFormat25 {␊ - /**␊ - * Default backend address pool resource of URL path map.␊ - */␊ - defaultBackendAddressPool?: (SubResource34 | string)␊ - /**␊ - * Default backend http settings resource of URL path map.␊ - */␊ - defaultBackendHttpSettings?: (SubResource34 | string)␊ - /**␊ - * Default Rewrite rule set resource of URL path map.␊ - */␊ - defaultRewriteRuleSet?: (SubResource34 | string)␊ - /**␊ - * Default redirect configuration resource of URL path map.␊ - */␊ - defaultRedirectConfiguration?: (SubResource34 | string)␊ - /**␊ - * Path rule of URL path map resource.␊ - */␊ - pathRules?: (ApplicationGatewayPathRule25[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Path rule of URL path map of an application gateway.␊ - */␊ - export interface ApplicationGatewayPathRule25 {␊ - /**␊ - * Properties of the application gateway path rule.␊ - */␊ - properties?: (ApplicationGatewayPathRulePropertiesFormat25 | string)␊ - /**␊ - * Name of the path rule that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of path rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayPathRulePropertiesFormat25 {␊ - /**␊ - * Path rules of URL path map.␊ - */␊ - paths?: (string[] | string)␊ - /**␊ - * Backend address pool resource of URL path map path rule.␊ - */␊ - backendAddressPool?: (SubResource34 | string)␊ - /**␊ - * Backend http settings resource of URL path map path rule.␊ - */␊ - backendHttpSettings?: (SubResource34 | string)␊ - /**␊ - * Redirect configuration resource of URL path map path rule.␊ - */␊ - redirectConfiguration?: (SubResource34 | string)␊ - /**␊ - * Rewrite rule set resource of URL path map path rule.␊ - */␊ - rewriteRuleSet?: (SubResource34 | string)␊ - /**␊ - * Reference to the FirewallPolicy resource.␊ - */␊ - firewallPolicy?: (SubResource34 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Request routing rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayRequestRoutingRule26 {␊ - /**␊ - * Properties of the application gateway request routing rule.␊ - */␊ - properties?: (ApplicationGatewayRequestRoutingRulePropertiesFormat26 | string)␊ - /**␊ - * Name of the request routing rule that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of request routing rule of the application gateway.␊ - */␊ - export interface ApplicationGatewayRequestRoutingRulePropertiesFormat26 {␊ - /**␊ - * Rule type.␊ - */␊ - ruleType?: (("Basic" | "PathBasedRouting") | string)␊ - /**␊ - * Priority of the request routing rule.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * Backend address pool resource of the application gateway.␊ - */␊ - backendAddressPool?: (SubResource34 | string)␊ - /**␊ - * Backend http settings resource of the application gateway.␊ - */␊ - backendHttpSettings?: (SubResource34 | string)␊ - /**␊ - * Http listener resource of the application gateway.␊ - */␊ - httpListener?: (SubResource34 | string)␊ - /**␊ - * URL path map resource of the application gateway.␊ - */␊ - urlPathMap?: (SubResource34 | string)␊ - /**␊ - * Rewrite Rule Set resource in Basic rule of the application gateway.␊ - */␊ - rewriteRuleSet?: (SubResource34 | string)␊ - /**␊ - * Redirect configuration resource of the application gateway.␊ - */␊ - redirectConfiguration?: (SubResource34 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Rewrite rule set of an application gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRuleSet12 {␊ - /**␊ - * Properties of the application gateway rewrite rule set.␊ - */␊ - properties?: (ApplicationGatewayRewriteRuleSetPropertiesFormat12 | string)␊ - /**␊ - * Name of the rewrite rule set that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of rewrite rule set of the application gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRuleSetPropertiesFormat12 {␊ - /**␊ - * Rewrite rules in the rewrite rule set.␊ - */␊ - rewriteRules?: (ApplicationGatewayRewriteRule12[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Rewrite rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRule12 {␊ - /**␊ - * Name of the rewrite rule that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet.␊ - */␊ - ruleSequence?: (number | string)␊ - /**␊ - * Conditions based on which the action set execution will be evaluated.␊ - */␊ - conditions?: (ApplicationGatewayRewriteRuleCondition10[] | string)␊ - /**␊ - * Set of actions to be done as part of the rewrite Rule.␊ - */␊ - actionSet?: (ApplicationGatewayRewriteRuleActionSet12 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Set of conditions in the Rewrite Rule in Application Gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRuleCondition10 {␊ - /**␊ - * The condition parameter of the RewriteRuleCondition.␊ - */␊ - variable?: string␊ - /**␊ - * The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition.␊ - */␊ - pattern?: string␊ - /**␊ - * Setting this paramter to truth value with force the pattern to do a case in-sensitive comparison.␊ - */␊ - ignoreCase?: (boolean | string)␊ - /**␊ - * Setting this value as truth will force to check the negation of the condition given by the user.␊ - */␊ - negate?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Set of actions in the Rewrite Rule in Application Gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRuleActionSet12 {␊ - /**␊ - * Request Header Actions in the Action Set.␊ - */␊ - requestHeaderConfigurations?: (ApplicationGatewayHeaderConfiguration12[] | string)␊ - /**␊ - * Response Header Actions in the Action Set.␊ - */␊ - responseHeaderConfigurations?: (ApplicationGatewayHeaderConfiguration12[] | string)␊ - /**␊ - * Url Configuration Action in the Action Set.␊ - */␊ - urlConfiguration?: (ApplicationGatewayUrlConfiguration3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Header configuration of the Actions set in Application Gateway.␊ - */␊ - export interface ApplicationGatewayHeaderConfiguration12 {␊ - /**␊ - * Header name of the header configuration.␊ - */␊ - headerName?: string␊ - /**␊ - * Header value of the header configuration.␊ - */␊ - headerValue?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Url configuration of the Actions set in Application Gateway.␊ - */␊ - export interface ApplicationGatewayUrlConfiguration3 {␊ - /**␊ - * Url path which user has provided for url rewrite. Null means no path will be updated. Default value is null.␊ - */␊ - modifiedPath?: string␊ - /**␊ - * Query string which user has provided for url rewrite. Null means no query string will be updated. Default value is null.␊ - */␊ - modifiedQueryString?: string␊ - /**␊ - * If set as true, it will re-evaluate the url path map provided in path based request routing rules using modified path. Default value is false.␊ - */␊ - reroute?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Redirect configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayRedirectConfiguration23 {␊ - /**␊ - * Properties of the application gateway redirect configuration.␊ - */␊ - properties?: (ApplicationGatewayRedirectConfigurationPropertiesFormat23 | string)␊ - /**␊ - * Name of the redirect configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of redirect configuration of the application gateway.␊ - */␊ - export interface ApplicationGatewayRedirectConfigurationPropertiesFormat23 {␊ - /**␊ - * HTTP redirection type.␊ - */␊ - redirectType?: (("Permanent" | "Found" | "SeeOther" | "Temporary") | string)␊ - /**␊ - * Reference to a listener to redirect the request to.␊ - */␊ - targetListener?: (SubResource34 | string)␊ - /**␊ - * Url to redirect the request to.␊ - */␊ - targetUrl?: string␊ - /**␊ - * Include path in the redirected url.␊ - */␊ - includePath?: (boolean | string)␊ - /**␊ - * Include query string in the redirected url.␊ - */␊ - includeQueryString?: (boolean | string)␊ - /**␊ - * Request routing specifying redirect configuration.␊ - */␊ - requestRoutingRules?: (SubResource34[] | string)␊ - /**␊ - * Url path maps specifying default redirect configuration.␊ - */␊ - urlPathMaps?: (SubResource34[] | string)␊ - /**␊ - * Path rules specifying redirect configuration.␊ - */␊ - pathRules?: (SubResource34[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application gateway web application firewall configuration.␊ - */␊ - export interface ApplicationGatewayWebApplicationFirewallConfiguration23 {␊ - /**␊ - * Whether the web application firewall is enabled or not.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * Web application firewall mode.␊ - */␊ - firewallMode: (("Detection" | "Prevention") | string)␊ - /**␊ - * The type of the web application firewall rule set. Possible values are: 'OWASP'.␊ - */␊ - ruleSetType: string␊ - /**␊ - * The version of the rule set type.␊ - */␊ - ruleSetVersion: string␊ - /**␊ - * The disabled rule groups.␊ - */␊ - disabledRuleGroups?: (ApplicationGatewayFirewallDisabledRuleGroup23[] | string)␊ - /**␊ - * Whether allow WAF to check request Body.␊ - */␊ - requestBodyCheck?: (boolean | string)␊ - /**␊ - * Maximum request body size for WAF.␊ - */␊ - maxRequestBodySize?: (number | string)␊ - /**␊ - * Maximum request body size in Kb for WAF.␊ - */␊ - maxRequestBodySizeInKb?: (number | string)␊ - /**␊ - * Maximum file upload size in Mb for WAF.␊ - */␊ - fileUploadLimitInMb?: (number | string)␊ - /**␊ - * The exclusion list.␊ - */␊ - exclusions?: (ApplicationGatewayFirewallExclusion13[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allows to disable rules within a rule group or an entire rule group.␊ - */␊ - export interface ApplicationGatewayFirewallDisabledRuleGroup23 {␊ - /**␊ - * The name of the rule group that will be disabled.␊ - */␊ - ruleGroupName: string␊ - /**␊ - * The list of rules that will be disabled. If null, all rules of the rule group will be disabled.␊ - */␊ - rules?: (number[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allow to exclude some variable satisfy the condition for the WAF check.␊ - */␊ - export interface ApplicationGatewayFirewallExclusion13 {␊ - /**␊ - * The variable to be excluded.␊ - */␊ - matchVariable: string␊ - /**␊ - * When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to.␊ - */␊ - selectorMatchOperator: string␊ - /**␊ - * When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to.␊ - */␊ - selector: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application Gateway autoscale configuration.␊ - */␊ - export interface ApplicationGatewayAutoscaleConfiguration16 {␊ - /**␊ - * Lower bound on number of Application Gateway capacity.␊ - */␊ - minCapacity: (number | string)␊ - /**␊ - * Upper bound on number of Application Gateway capacity.␊ - */␊ - maxCapacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the resource.␊ - */␊ - export interface ManagedServiceIdentity12 {␊ - /**␊ - * The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.␊ - */␊ - type?: ("SystemAssigned" | "UserAssigned" | "SystemAssigned, UserAssigned" | "None")␊ - /**␊ - * The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.␊ - */␊ - userAssignedIdentities?: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies␊ - */␊ - export interface ApplicationGatewayWebApplicationFirewallPolicies10 {␊ - name: string␊ - type: "Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the web application firewall policy.␊ - */␊ - properties: (WebApplicationFirewallPolicyPropertiesFormat10 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines web application firewall policy properties.␊ - */␊ - export interface WebApplicationFirewallPolicyPropertiesFormat10 {␊ - /**␊ - * The PolicySettings for policy.␊ - */␊ - policySettings?: (PolicySettings12 | string)␊ - /**␊ - * The custom rules inside the policy.␊ - */␊ - customRules?: (WebApplicationFirewallCustomRule10[] | string)␊ - /**␊ - * Describes the managedRules structure.␊ - */␊ - managedRules: (ManagedRulesDefinition5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines contents of a web application firewall global configuration.␊ - */␊ - export interface PolicySettings12 {␊ - /**␊ - * The state of the policy.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * The mode of the policy.␊ - */␊ - mode?: (("Prevention" | "Detection") | string)␊ - /**␊ - * Whether to allow WAF to check request Body.␊ - */␊ - requestBodyCheck?: (boolean | string)␊ - /**␊ - * Maximum request body size in Kb for WAF.␊ - */␊ - maxRequestBodySizeInKb?: (number | string)␊ - /**␊ - * Maximum file upload size in Mb for WAF.␊ - */␊ - fileUploadLimitInMb?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines contents of a web application rule.␊ - */␊ - export interface WebApplicationFirewallCustomRule10 {␊ - /**␊ - * The name of the resource that is unique within a policy. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * Priority of the rule. Rules with a lower value will be evaluated before rules with a higher value.␊ - */␊ - priority: (number | string)␊ - /**␊ - * The rule type.␊ - */␊ - ruleType: (("MatchRule" | "Invalid") | string)␊ - /**␊ - * List of match conditions.␊ - */␊ - matchConditions: (MatchCondition12[] | string)␊ - /**␊ - * Type of Actions.␊ - */␊ - action: (("Allow" | "Block" | "Log") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Define match conditions.␊ - */␊ - export interface MatchCondition12 {␊ - /**␊ - * List of match variables.␊ - */␊ - matchVariables: (MatchVariable10[] | string)␊ - /**␊ - * The operator to be matched.␊ - */␊ - operator: (("IPMatch" | "Equal" | "Contains" | "LessThan" | "GreaterThan" | "LessThanOrEqual" | "GreaterThanOrEqual" | "BeginsWith" | "EndsWith" | "Regex" | "GeoMatch") | string)␊ - /**␊ - * Whether this is negate condition or not.␊ - */␊ - negationConditon?: (boolean | string)␊ - /**␊ - * Match value.␊ - */␊ - matchValues: (string[] | string)␊ - /**␊ - * List of transforms.␊ - */␊ - transforms?: (("Lowercase" | "Trim" | "UrlDecode" | "UrlEncode" | "RemoveNulls" | "HtmlEntityDecode")[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Define match variables.␊ - */␊ - export interface MatchVariable10 {␊ - /**␊ - * Match Variable.␊ - */␊ - variableName: (("RemoteAddr" | "RequestMethod" | "QueryString" | "PostArgs" | "RequestUri" | "RequestHeaders" | "RequestBody" | "RequestCookies") | string)␊ - /**␊ - * The selector of match variable.␊ - */␊ - selector?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allow to exclude some variable satisfy the condition for the WAF check.␊ - */␊ - export interface ManagedRulesDefinition5 {␊ - /**␊ - * The Exclusions that are applied on the policy.␊ - */␊ - exclusions?: (OwaspCrsExclusionEntry5[] | string)␊ - /**␊ - * The managed rule sets that are associated with the policy.␊ - */␊ - managedRuleSets: (ManagedRuleSet7[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allow to exclude some variable satisfy the condition for the WAF check.␊ - */␊ - export interface OwaspCrsExclusionEntry5 {␊ - /**␊ - * The variable to be excluded.␊ - */␊ - matchVariable: (("RequestHeaderNames" | "RequestCookieNames" | "RequestArgNames") | string)␊ - /**␊ - * When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to.␊ - */␊ - selectorMatchOperator: (("Equals" | "Contains" | "StartsWith" | "EndsWith" | "EqualsAny") | string)␊ - /**␊ - * When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to.␊ - */␊ - selector: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines a managed rule set.␊ - */␊ - export interface ManagedRuleSet7 {␊ - /**␊ - * Defines the rule set type to use.␊ - */␊ - ruleSetType: string␊ - /**␊ - * Defines the version of the rule set to use.␊ - */␊ - ruleSetVersion: string␊ - /**␊ - * Defines the rule group overrides to apply to the rule set.␊ - */␊ - ruleGroupOverrides?: (ManagedRuleGroupOverride7[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines a managed rule group override setting.␊ - */␊ - export interface ManagedRuleGroupOverride7 {␊ - /**␊ - * The managed rule group to override.␊ - */␊ - ruleGroupName: string␊ - /**␊ - * List of rules that will be disabled. If none specified, all rules in the group will be disabled.␊ - */␊ - rules?: (ManagedRuleOverride7[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines a managed rule group override setting.␊ - */␊ - export interface ManagedRuleOverride7 {␊ - /**␊ - * Identifier for the managed rule.␊ - */␊ - ruleId: string␊ - /**␊ - * The state of the managed rule. Defaults to Disabled if not specified.␊ - */␊ - state?: ("Disabled" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/applicationSecurityGroups␊ - */␊ - export interface ApplicationSecurityGroups21 {␊ - name: string␊ - type: "Microsoft.Network/applicationSecurityGroups"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the application security group.␊ - */␊ - properties: (ApplicationSecurityGroupPropertiesFormat6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application security group properties.␊ - */␊ - export interface ApplicationSecurityGroupPropertiesFormat6 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/azureFirewalls␊ - */␊ - export interface AzureFirewalls11 {␊ - name: string␊ - type: "Microsoft.Network/azureFirewalls"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the azure firewall.␊ - */␊ - properties: (AzureFirewallPropertiesFormat11 | string)␊ - /**␊ - * A list of availability zones denoting where the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Azure Firewall.␊ - */␊ - export interface AzureFirewallPropertiesFormat11 {␊ - /**␊ - * Collection of application rule collections used by Azure Firewall.␊ - */␊ - applicationRuleCollections?: (AzureFirewallApplicationRuleCollection11[] | string)␊ - /**␊ - * Collection of NAT rule collections used by Azure Firewall.␊ - */␊ - natRuleCollections?: (AzureFirewallNatRuleCollection8[] | string)␊ - /**␊ - * Collection of network rule collections used by Azure Firewall.␊ - */␊ - networkRuleCollections?: (AzureFirewallNetworkRuleCollection11[] | string)␊ - /**␊ - * IP configuration of the Azure Firewall resource.␊ - */␊ - ipConfigurations?: (AzureFirewallIPConfiguration11[] | string)␊ - /**␊ - * IP configuration of the Azure Firewall used for management traffic.␊ - */␊ - managementIpConfiguration?: (AzureFirewallIPConfiguration11 | string)␊ - /**␊ - * The operation mode for Threat Intelligence.␊ - */␊ - threatIntelMode?: (("Alert" | "Deny" | "Off") | string)␊ - /**␊ - * The virtualHub to which the firewall belongs.␊ - */␊ - virtualHub?: (SubResource34 | string)␊ - /**␊ - * The firewallPolicy associated with this azure firewall.␊ - */␊ - firewallPolicy?: (SubResource34 | string)␊ - /**␊ - * The Azure Firewall Resource SKU.␊ - */␊ - sku?: (AzureFirewallSku5 | string)␊ - /**␊ - * The additional properties used to further config this azure firewall.␊ - */␊ - additionalProperties?: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application rule collection resource.␊ - */␊ - export interface AzureFirewallApplicationRuleCollection11 {␊ - /**␊ - * Properties of the azure firewall application rule collection.␊ - */␊ - properties?: (AzureFirewallApplicationRuleCollectionPropertiesFormat11 | string)␊ - /**␊ - * The name of the resource that is unique within the Azure firewall. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application rule collection.␊ - */␊ - export interface AzureFirewallApplicationRuleCollectionPropertiesFormat11 {␊ - /**␊ - * Priority of the application rule collection resource.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * The action type of a rule collection.␊ - */␊ - action?: (AzureFirewallRCAction11 | string)␊ - /**␊ - * Collection of rules used by a application rule collection.␊ - */␊ - rules?: (AzureFirewallApplicationRule11[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the AzureFirewallRCAction.␊ - */␊ - export interface AzureFirewallRCAction11 {␊ - /**␊ - * The type of action.␊ - */␊ - type?: ("Allow" | "Deny")␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of an application rule.␊ - */␊ - export interface AzureFirewallApplicationRule11 {␊ - /**␊ - * Name of the application rule.␊ - */␊ - name?: string␊ - /**␊ - * Description of the rule.␊ - */␊ - description?: string␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * Array of ApplicationRuleProtocols.␊ - */␊ - protocols?: (AzureFirewallApplicationRuleProtocol11[] | string)␊ - /**␊ - * List of FQDNs for this rule.␊ - */␊ - targetFqdns?: (string[] | string)␊ - /**␊ - * List of FQDN Tags for this rule.␊ - */␊ - fqdnTags?: (string[] | string)␊ - /**␊ - * List of source IpGroups for this rule.␊ - */␊ - sourceIpGroups?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application rule protocol.␊ - */␊ - export interface AzureFirewallApplicationRuleProtocol11 {␊ - /**␊ - * Protocol type.␊ - */␊ - protocolType?: (("Http" | "Https" | "Mssql") | string)␊ - /**␊ - * Port number for the protocol, cannot be greater than 64000. This field is optional.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NAT rule collection resource.␊ - */␊ - export interface AzureFirewallNatRuleCollection8 {␊ - /**␊ - * Properties of the azure firewall NAT rule collection.␊ - */␊ - properties?: (AzureFirewallNatRuleCollectionProperties8 | string)␊ - /**␊ - * The name of the resource that is unique within the Azure firewall. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the NAT rule collection.␊ - */␊ - export interface AzureFirewallNatRuleCollectionProperties8 {␊ - /**␊ - * Priority of the NAT rule collection resource.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * The action type of a NAT rule collection.␊ - */␊ - action?: (AzureFirewallNatRCAction8 | string)␊ - /**␊ - * Collection of rules used by a NAT rule collection.␊ - */␊ - rules?: (AzureFirewallNatRule8[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AzureFirewall NAT Rule Collection Action.␊ - */␊ - export interface AzureFirewallNatRCAction8 {␊ - /**␊ - * The type of action.␊ - */␊ - type?: ("Snat" | "Dnat")␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a NAT rule.␊ - */␊ - export interface AzureFirewallNatRule8 {␊ - /**␊ - * Name of the NAT rule.␊ - */␊ - name?: string␊ - /**␊ - * Description of the rule.␊ - */␊ - description?: string␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags.␊ - */␊ - destinationAddresses?: (string[] | string)␊ - /**␊ - * List of destination ports.␊ - */␊ - destinationPorts?: (string[] | string)␊ - /**␊ - * Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule.␊ - */␊ - protocols?: (("TCP" | "UDP" | "Any" | "ICMP")[] | string)␊ - /**␊ - * The translated address for this NAT rule.␊ - */␊ - translatedAddress?: string␊ - /**␊ - * The translated port for this NAT rule.␊ - */␊ - translatedPort?: string␊ - /**␊ - * The translated FQDN for this NAT rule.␊ - */␊ - translatedFqdn?: string␊ - /**␊ - * List of source IpGroups for this rule.␊ - */␊ - sourceIpGroups?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network rule collection resource.␊ - */␊ - export interface AzureFirewallNetworkRuleCollection11 {␊ - /**␊ - * Properties of the azure firewall network rule collection.␊ - */␊ - properties?: (AzureFirewallNetworkRuleCollectionPropertiesFormat11 | string)␊ - /**␊ - * The name of the resource that is unique within the Azure firewall. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the network rule collection.␊ - */␊ - export interface AzureFirewallNetworkRuleCollectionPropertiesFormat11 {␊ - /**␊ - * Priority of the network rule collection resource.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * The action type of a rule collection.␊ - */␊ - action?: (AzureFirewallRCAction11 | string)␊ - /**␊ - * Collection of rules used by a network rule collection.␊ - */␊ - rules?: (AzureFirewallNetworkRule11[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the network rule.␊ - */␊ - export interface AzureFirewallNetworkRule11 {␊ - /**␊ - * Name of the network rule.␊ - */␊ - name?: string␊ - /**␊ - * Description of the rule.␊ - */␊ - description?: string␊ - /**␊ - * Array of AzureFirewallNetworkRuleProtocols.␊ - */␊ - protocols?: (("TCP" | "UDP" | "Any" | "ICMP")[] | string)␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * List of destination IP addresses.␊ - */␊ - destinationAddresses?: (string[] | string)␊ - /**␊ - * List of destination ports.␊ - */␊ - destinationPorts?: (string[] | string)␊ - /**␊ - * List of destination FQDNs.␊ - */␊ - destinationFqdns?: (string[] | string)␊ - /**␊ - * List of source IpGroups for this rule.␊ - */␊ - sourceIpGroups?: (string[] | string)␊ - /**␊ - * List of destination IpGroups for this rule.␊ - */␊ - destinationIpGroups?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration of an Azure Firewall.␊ - */␊ - export interface AzureFirewallIPConfiguration11 {␊ - /**␊ - * Properties of the azure firewall IP configuration.␊ - */␊ - properties?: (AzureFirewallIPConfigurationPropertiesFormat11 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration of an Azure Firewall.␊ - */␊ - export interface AzureFirewallIPConfigurationPropertiesFormat11 {␊ - /**␊ - * Reference to the subnet resource. This resource must be named 'AzureFirewallSubnet' or 'AzureFirewallManagementSubnet'.␊ - */␊ - subnet?: (SubResource34 | string)␊ - /**␊ - * Reference to the PublicIP resource. This field is a mandatory input if subnet is not null.␊ - */␊ - publicIPAddress?: (SubResource34 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of an Azure Firewall.␊ - */␊ - export interface AzureFirewallSku5 {␊ - /**␊ - * Name of an Azure Firewall SKU.␊ - */␊ - name?: (("AZFW_VNet" | "AZFW_Hub") | string)␊ - /**␊ - * Tier of an Azure Firewall.␊ - */␊ - tier?: (("Standard" | "Premium") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/bastionHosts␊ - */␊ - export interface BastionHosts8 {␊ - /**␊ - * The name of the Bastion Host.␊ - */␊ - name: string␊ - type: "Microsoft.Network/bastionHosts"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Represents the bastion host resource.␊ - */␊ - properties: (BastionHostPropertiesFormat8 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Bastion Host.␊ - */␊ - export interface BastionHostPropertiesFormat8 {␊ - /**␊ - * IP configuration of the Bastion Host resource.␊ - */␊ - ipConfigurations?: (BastionHostIPConfiguration8[] | string)␊ - /**␊ - * FQDN for the endpoint on which bastion host is accessible.␊ - */␊ - dnsName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration of an Bastion Host.␊ - */␊ - export interface BastionHostIPConfiguration8 {␊ - /**␊ - * Represents the ip configuration associated with the resource.␊ - */␊ - properties?: (BastionHostIPConfigurationPropertiesFormat8 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration of an Bastion Host.␊ - */␊ - export interface BastionHostIPConfigurationPropertiesFormat8 {␊ - /**␊ - * Reference of the subnet resource.␊ - */␊ - subnet: (SubResource34 | string)␊ - /**␊ - * Reference of the PublicIP resource.␊ - */␊ - publicIPAddress: (SubResource34 | string)␊ - /**␊ - * Private IP allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/connections␊ - */␊ - export interface Connections26 {␊ - name: string␊ - type: "Microsoft.Network/connections"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway connection.␊ - */␊ - properties: (VirtualNetworkGatewayConnectionPropertiesFormat26 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewayConnection properties.␊ - */␊ - export interface VirtualNetworkGatewayConnectionPropertiesFormat26 {␊ - /**␊ - * The authorizationKey.␊ - */␊ - authorizationKey?: string␊ - /**␊ - * The reference to virtual network gateway resource.␊ - */␊ - virtualNetworkGateway1: (SubResource34 | string)␊ - /**␊ - * The reference to virtual network gateway resource.␊ - */␊ - virtualNetworkGateway2?: (SubResource34 | string)␊ - /**␊ - * The reference to local network gateway resource.␊ - */␊ - localNetworkGateway2?: (SubResource34 | string)␊ - /**␊ - * Gateway connection type.␊ - */␊ - connectionType: (("IPsec" | "Vnet2Vnet" | "ExpressRoute" | "VPNClient") | string)␊ - /**␊ - * Connection protocol used for this connection.␊ - */␊ - connectionProtocol?: (("IKEv2" | "IKEv1") | string)␊ - /**␊ - * The routing weight.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * The dead peer detection timeout of this connection in seconds.␊ - */␊ - dpdTimeoutSeconds?: (number | string)␊ - /**␊ - * The IPSec shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The reference to peerings resource.␊ - */␊ - peer?: (SubResource34 | string)␊ - /**␊ - * EnableBgp flag.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * Use private local Azure IP for the connection.␊ - */␊ - useLocalAzureIpAddress?: (boolean | string)␊ - /**␊ - * Enable policy-based traffic selectors.␊ - */␊ - usePolicyBasedTrafficSelectors?: (boolean | string)␊ - /**␊ - * The IPSec Policies to be considered by this connection.␊ - */␊ - ipsecPolicies?: (IpsecPolicy23[] | string)␊ - /**␊ - * The Traffic Selector Policies to be considered by this connection.␊ - */␊ - trafficSelectorPolicies?: (TrafficSelectorPolicy6[] | string)␊ - /**␊ - * Bypass ExpressRoute Gateway for data forwarding.␊ - */␊ - expressRouteGatewayBypass?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An IPSec Policy configuration for a virtual network gateway connection.␊ - */␊ - export interface IpsecPolicy23 {␊ - /**␊ - * The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.␊ - */␊ - saLifeTimeSeconds: (number | string)␊ - /**␊ - * The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.␊ - */␊ - saDataSizeKilobytes: (number | string)␊ - /**␊ - * The IPSec encryption algorithm (IKE phase 1).␊ - */␊ - ipsecEncryption: (("None" | "DES" | "DES3" | "AES128" | "AES192" | "AES256" | "GCMAES128" | "GCMAES192" | "GCMAES256") | string)␊ - /**␊ - * The IPSec integrity algorithm (IKE phase 1).␊ - */␊ - ipsecIntegrity: (("MD5" | "SHA1" | "SHA256" | "GCMAES128" | "GCMAES192" | "GCMAES256") | string)␊ - /**␊ - * The IKE encryption algorithm (IKE phase 2).␊ - */␊ - ikeEncryption: (("DES" | "DES3" | "AES128" | "AES192" | "AES256" | "GCMAES256" | "GCMAES128") | string)␊ - /**␊ - * The IKE integrity algorithm (IKE phase 2).␊ - */␊ - ikeIntegrity: (("MD5" | "SHA1" | "SHA256" | "SHA384" | "GCMAES256" | "GCMAES128") | string)␊ - /**␊ - * The DH Group used in IKE Phase 1 for initial SA.␊ - */␊ - dhGroup: (("None" | "DHGroup1" | "DHGroup2" | "DHGroup14" | "DHGroup2048" | "ECP256" | "ECP384" | "DHGroup24") | string)␊ - /**␊ - * The Pfs Group used in IKE Phase 2 for new child SA.␊ - */␊ - pfsGroup: (("None" | "PFS1" | "PFS2" | "PFS2048" | "ECP256" | "ECP384" | "PFS24" | "PFS14" | "PFSMM") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An traffic selector policy for a virtual network gateway connection.␊ - */␊ - export interface TrafficSelectorPolicy6 {␊ - /**␊ - * A collection of local address spaces in CIDR format.␊ - */␊ - localAddressRanges: (string[] | string)␊ - /**␊ - * A collection of remote address spaces in CIDR format.␊ - */␊ - remoteAddressRanges: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ddosCustomPolicies␊ - */␊ - export interface DdosCustomPolicies8 {␊ - name: string␊ - type: "Microsoft.Network/ddosCustomPolicies"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the DDoS custom policy.␊ - */␊ - properties: (DdosCustomPolicyPropertiesFormat8 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DDoS custom policy properties.␊ - */␊ - export interface DdosCustomPolicyPropertiesFormat8 {␊ - /**␊ - * The protocol-specific DDoS policy customization parameters.␊ - */␊ - protocolCustomSettings?: (ProtocolCustomSettingsFormat8[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DDoS custom policy properties.␊ - */␊ - export interface ProtocolCustomSettingsFormat8 {␊ - /**␊ - * The protocol for which the DDoS protection policy is being customized.␊ - */␊ - protocol?: (("Tcp" | "Udp" | "Syn") | string)␊ - /**␊ - * The customized DDoS protection trigger rate.␊ - */␊ - triggerRateOverride?: string␊ - /**␊ - * The customized DDoS protection source rate.␊ - */␊ - sourceRateOverride?: string␊ - /**␊ - * The customized DDoS protection trigger rate sensitivity degrees. High: Trigger rate set with most sensitivity w.r.t. normal traffic. Default: Trigger rate set with moderate sensitivity w.r.t. normal traffic. Low: Trigger rate set with less sensitivity w.r.t. normal traffic. Relaxed: Trigger rate set with least sensitivity w.r.t. normal traffic.␊ - */␊ - triggerSensitivityOverride?: (("Relaxed" | "Low" | "Default" | "High") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ddosProtectionPlans␊ - */␊ - export interface DdosProtectionPlans17 {␊ - name: string␊ - type: "Microsoft.Network/ddosProtectionPlans"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the DDoS protection plan.␊ - */␊ - properties: (DdosProtectionPlanPropertiesFormat12 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DDoS protection plan properties.␊ - */␊ - export interface DdosProtectionPlanPropertiesFormat12 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits␊ - */␊ - export interface ExpressRouteCircuits19 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The SKU.␊ - */␊ - sku?: (ExpressRouteCircuitSku19 | string)␊ - /**␊ - * Properties of the express route circuit.␊ - */␊ - properties: (ExpressRouteCircuitPropertiesFormat19 | string)␊ - resources?: (ExpressRouteCircuitsPeeringsChildResource19 | ExpressRouteCircuitsAuthorizationsChildResource19)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains SKU in an ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitSku19 {␊ - /**␊ - * The name of the SKU.␊ - */␊ - name?: string␊ - /**␊ - * The tier of the SKU.␊ - */␊ - tier?: (("Standard" | "Premium" | "Basic" | "Local") | string)␊ - /**␊ - * The family of the SKU.␊ - */␊ - family?: (("UnlimitedData" | "MeteredData") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitPropertiesFormat19 {␊ - /**␊ - * Allow classic operations.␊ - */␊ - allowClassicOperations?: (boolean | string)␊ - /**␊ - * The list of authorizations.␊ - */␊ - authorizations?: (ExpressRouteCircuitAuthorization19[] | string)␊ - /**␊ - * The list of peerings.␊ - */␊ - peerings?: (ExpressRouteCircuitPeering19[] | string)␊ - /**␊ - * The ServiceProviderNotes.␊ - */␊ - serviceProviderNotes?: string␊ - /**␊ - * The ServiceProviderProperties.␊ - */␊ - serviceProviderProperties?: (ExpressRouteCircuitServiceProviderProperties19 | string)␊ - /**␊ - * The reference to the ExpressRoutePort resource when the circuit is provisioned on an ExpressRoutePort resource.␊ - */␊ - expressRoutePort?: (SubResource34 | string)␊ - /**␊ - * The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource.␊ - */␊ - bandwidthInGbps?: (number | string)␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authorization in an ExpressRouteCircuit resource.␊ - */␊ - export interface ExpressRouteCircuitAuthorization19 {␊ - /**␊ - * Properties of the express route circuit authorization.␊ - */␊ - properties?: (AuthorizationPropertiesFormat18 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ExpressRouteCircuitAuthorization.␊ - */␊ - export interface AuthorizationPropertiesFormat18 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peering in an ExpressRouteCircuit resource.␊ - */␊ - export interface ExpressRouteCircuitPeering19 {␊ - /**␊ - * Properties of the express route circuit peering.␊ - */␊ - properties?: (ExpressRouteCircuitPeeringPropertiesFormat20 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the express route circuit peering.␊ - */␊ - export interface ExpressRouteCircuitPeeringPropertiesFormat20 {␊ - /**␊ - * The peering type.␊ - */␊ - peeringType?: (("AzurePublicPeering" | "AzurePrivatePeering" | "MicrosoftPeering") | string)␊ - /**␊ - * The peering state.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * The peer ASN.␊ - */␊ - peerASN?: (number | string)␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The VLAN ID.␊ - */␊ - vlanId?: (number | string)␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig20 | string)␊ - /**␊ - * The peering stats of express route circuit.␊ - */␊ - stats?: (ExpressRouteCircuitStats20 | string)␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - /**␊ - * The reference to the RouteFilter resource.␊ - */␊ - routeFilter?: (SubResource34 | string)␊ - /**␊ - * The IPv6 peering configuration.␊ - */␊ - ipv6PeeringConfig?: (Ipv6ExpressRouteCircuitPeeringConfig17 | string)␊ - /**␊ - * The ExpressRoute connection.␊ - */␊ - expressRouteConnection?: (SubResource34 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the peering configuration.␊ - */␊ - export interface ExpressRouteCircuitPeeringConfig20 {␊ - /**␊ - * The reference to AdvertisedPublicPrefixes.␊ - */␊ - advertisedPublicPrefixes?: (string[] | string)␊ - /**␊ - * The communities of bgp peering. Specified for microsoft peering.␊ - */␊ - advertisedCommunities?: (string[] | string)␊ - /**␊ - * The legacy mode of the peering.␊ - */␊ - legacyMode?: (number | string)␊ - /**␊ - * The CustomerASN of the peering.␊ - */␊ - customerASN?: (number | string)␊ - /**␊ - * The RoutingRegistryName of the configuration.␊ - */␊ - routingRegistryName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains stats associated with the peering.␊ - */␊ - export interface ExpressRouteCircuitStats20 {␊ - /**␊ - * The Primary BytesIn of the peering.␊ - */␊ - primarybytesIn?: (number | string)␊ - /**␊ - * The primary BytesOut of the peering.␊ - */␊ - primarybytesOut?: (number | string)␊ - /**␊ - * The secondary BytesIn of the peering.␊ - */␊ - secondarybytesIn?: (number | string)␊ - /**␊ - * The secondary BytesOut of the peering.␊ - */␊ - secondarybytesOut?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains IPv6 peering config.␊ - */␊ - export interface Ipv6ExpressRouteCircuitPeeringConfig17 {␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig20 | string)␊ - /**␊ - * The reference to the RouteFilter resource.␊ - */␊ - routeFilter?: (SubResource34 | string)␊ - /**␊ - * The state of peering.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains ServiceProviderProperties in an ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitServiceProviderProperties19 {␊ - /**␊ - * The serviceProviderName.␊ - */␊ - serviceProviderName?: string␊ - /**␊ - * The peering location.␊ - */␊ - peeringLocation?: string␊ - /**␊ - * The BandwidthInMbps.␊ - */␊ - bandwidthInMbps?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings␊ - */␊ - export interface ExpressRouteCircuitsPeeringsChildResource19 {␊ - name: string␊ - type: "peerings"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Properties of the express route circuit peering.␊ - */␊ - properties: (ExpressRouteCircuitPeeringPropertiesFormat20 | string)␊ - resources?: ExpressRouteCircuitsPeeringsConnectionsChildResource17[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings/connections␊ - */␊ - export interface ExpressRouteCircuitsPeeringsConnectionsChildResource17 {␊ - name: string␊ - type: "connections"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Properties of the express route circuit connection.␊ - */␊ - properties: (ExpressRouteCircuitConnectionPropertiesFormat17 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the express route circuit connection.␊ - */␊ - export interface ExpressRouteCircuitConnectionPropertiesFormat17 {␊ - /**␊ - * Reference to Express Route Circuit Private Peering Resource of the circuit initiating connection.␊ - */␊ - expressRouteCircuitPeering?: (SubResource34 | string)␊ - /**␊ - * Reference to Express Route Circuit Private Peering Resource of the peered circuit.␊ - */␊ - peerExpressRouteCircuitPeering?: (SubResource34 | string)␊ - /**␊ - * /29 IP address space to carve out Customer addresses for tunnels.␊ - */␊ - addressPrefix?: string␊ - /**␊ - * The authorization key.␊ - */␊ - authorizationKey?: string␊ - /**␊ - * IPv6 Address PrefixProperties of the express route circuit connection.␊ - */␊ - ipv6CircuitConnectionConfig?: (Ipv6CircuitConnectionConfig2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IPv6 Circuit Connection properties for global reach.␊ - */␊ - export interface Ipv6CircuitConnectionConfig2 {␊ - /**␊ - * /125 IP address space to carve out customer addresses for global reach.␊ - */␊ - addressPrefix?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/authorizations␊ - */␊ - export interface ExpressRouteCircuitsAuthorizationsChildResource19 {␊ - name: string␊ - type: "authorizations"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Properties of the express route circuit authorization.␊ - */␊ - properties: (AuthorizationPropertiesFormat18 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/authorizations␊ - */␊ - export interface ExpressRouteCircuitsAuthorizations20 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/authorizations"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Properties of the express route circuit authorization.␊ - */␊ - properties: (AuthorizationPropertiesFormat18 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings␊ - */␊ - export interface ExpressRouteCircuitsPeerings20 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/peerings"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Properties of the express route circuit peering.␊ - */␊ - properties: (ExpressRouteCircuitPeeringPropertiesFormat20 | string)␊ - resources?: ExpressRouteCircuitsPeeringsConnectionsChildResource17[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings/connections␊ - */␊ - export interface ExpressRouteCircuitsPeeringsConnections17 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/peerings/connections"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Properties of the express route circuit connection.␊ - */␊ - properties: (ExpressRouteCircuitConnectionPropertiesFormat17 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections␊ - */␊ - export interface ExpressRouteCrossConnections17 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCrossConnections"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the express route cross connection.␊ - */␊ - properties: (ExpressRouteCrossConnectionProperties17 | string)␊ - resources?: ExpressRouteCrossConnectionsPeeringsChildResource17[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ExpressRouteCrossConnection.␊ - */␊ - export interface ExpressRouteCrossConnectionProperties17 {␊ - /**␊ - * The peering location of the ExpressRoute circuit.␊ - */␊ - peeringLocation?: string␊ - /**␊ - * The circuit bandwidth In Mbps.␊ - */␊ - bandwidthInMbps?: (number | string)␊ - /**␊ - * The ExpressRouteCircuit.␊ - */␊ - expressRouteCircuit?: (SubResource34 | string)␊ - /**␊ - * The provisioning state of the circuit in the connectivity provider system.␊ - */␊ - serviceProviderProvisioningState?: (("NotProvisioned" | "Provisioning" | "Provisioned" | "Deprovisioning") | string)␊ - /**␊ - * Additional read only notes set by the connectivity provider.␊ - */␊ - serviceProviderNotes?: string␊ - /**␊ - * The list of peerings.␊ - */␊ - peerings?: (ExpressRouteCrossConnectionPeering17[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peering in an ExpressRoute Cross Connection resource.␊ - */␊ - export interface ExpressRouteCrossConnectionPeering17 {␊ - /**␊ - * Properties of the express route cross connection peering.␊ - */␊ - properties?: (ExpressRouteCrossConnectionPeeringProperties17 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of express route cross connection peering.␊ - */␊ - export interface ExpressRouteCrossConnectionPeeringProperties17 {␊ - /**␊ - * The peering type.␊ - */␊ - peeringType?: (("AzurePublicPeering" | "AzurePrivatePeering" | "MicrosoftPeering") | string)␊ - /**␊ - * The peering state.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * The peer ASN.␊ - */␊ - peerASN?: (number | string)␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The VLAN ID.␊ - */␊ - vlanId?: (number | string)␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig20 | string)␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - /**␊ - * The IPv6 peering configuration.␊ - */␊ - ipv6PeeringConfig?: (Ipv6ExpressRouteCircuitPeeringConfig17 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections/peerings␊ - */␊ - export interface ExpressRouteCrossConnectionsPeeringsChildResource17 {␊ - name: string␊ - type: "peerings"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Properties of the express route cross connection peering.␊ - */␊ - properties: (ExpressRouteCrossConnectionPeeringProperties17 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections/peerings␊ - */␊ - export interface ExpressRouteCrossConnectionsPeerings17 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCrossConnections/peerings"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Properties of the express route cross connection peering.␊ - */␊ - properties: (ExpressRouteCrossConnectionPeeringProperties17 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteGateways␊ - */␊ - export interface ExpressRouteGateways8 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteGateways"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the express route gateway.␊ - */␊ - properties: (ExpressRouteGatewayProperties8 | string)␊ - resources?: ExpressRouteGatewaysExpressRouteConnectionsChildResource8[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ExpressRoute gateway resource properties.␊ - */␊ - export interface ExpressRouteGatewayProperties8 {␊ - /**␊ - * Configuration for auto scaling.␊ - */␊ - autoScaleConfiguration?: (ExpressRouteGatewayPropertiesAutoScaleConfiguration8 | string)␊ - /**␊ - * The Virtual Hub where the ExpressRoute gateway is or will be deployed.␊ - */␊ - virtualHub: (SubResource34 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Configuration for auto scaling.␊ - */␊ - export interface ExpressRouteGatewayPropertiesAutoScaleConfiguration8 {␊ - /**␊ - * Minimum and maximum number of scale units to deploy.␊ - */␊ - bounds?: (ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds8 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Minimum and maximum number of scale units to deploy.␊ - */␊ - export interface ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds8 {␊ - /**␊ - * Minimum number of scale units deployed for ExpressRoute gateway.␊ - */␊ - min?: (number | string)␊ - /**␊ - * Maximum number of scale units deployed for ExpressRoute gateway.␊ - */␊ - max?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteGateways/expressRouteConnections␊ - */␊ - export interface ExpressRouteGatewaysExpressRouteConnectionsChildResource8 {␊ - name: string␊ - type: "expressRouteConnections"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Properties of the express route connection.␊ - */␊ - properties: (ExpressRouteConnectionProperties8 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the ExpressRouteConnection subresource.␊ - */␊ - export interface ExpressRouteConnectionProperties8 {␊ - /**␊ - * The ExpressRoute circuit peering.␊ - */␊ - expressRouteCircuitPeering: (SubResource34 | string)␊ - /**␊ - * Authorization key to establish the connection.␊ - */␊ - authorizationKey?: string␊ - /**␊ - * The routing weight associated to the connection.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * Enable internet security.␊ - */␊ - enableInternetSecurity?: (boolean | string)␊ - /**␊ - * The Routing Configuration indicating the associated and propagated route tables on this connection.␊ - */␊ - routingConfiguration?: (RoutingConfiguration | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Routing Configuration indicating the associated and propagated route tables for this connection.␊ - */␊ - export interface RoutingConfiguration {␊ - /**␊ - * The resource id RouteTable associated with this RoutingConfiguration.␊ - */␊ - associatedRouteTable?: (SubResource34 | string)␊ - /**␊ - * The list of RouteTables to advertise the routes to.␊ - */␊ - propagatedRouteTables?: (PropagatedRouteTable | string)␊ - /**␊ - * List of routes that control routing from VirtualHub into a virtual network connection.␊ - */␊ - vnetRoutes?: (VnetRoute | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The list of RouteTables to advertise the routes to.␊ - */␊ - export interface PropagatedRouteTable {␊ - /**␊ - * The list of labels.␊ - */␊ - labels?: (string[] | string)␊ - /**␊ - * The list of resource ids of all the RouteTables.␊ - */␊ - ids?: (SubResource34[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * List of routes that control routing from VirtualHub into a virtual network connection.␊ - */␊ - export interface VnetRoute {␊ - /**␊ - * List of all Static Routes.␊ - */␊ - staticRoutes?: (StaticRoute[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * List of all Static Routes.␊ - */␊ - export interface StaticRoute {␊ - /**␊ - * The name of the StaticRoute that is unique within a VnetRoute.␊ - */␊ - name?: string␊ - /**␊ - * List of all address prefixes.␊ - */␊ - addressPrefixes?: (string[] | string)␊ - /**␊ - * The ip address of the next hop.␊ - */␊ - nextHopIpAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteGateways/expressRouteConnections␊ - */␊ - export interface ExpressRouteGatewaysExpressRouteConnections8 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteGateways/expressRouteConnections"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Properties of the express route connection.␊ - */␊ - properties: (ExpressRouteConnectionProperties8 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ExpressRoutePorts␊ - */␊ - export interface ExpressRoutePorts13 {␊ - name: string␊ - type: "Microsoft.Network/ExpressRoutePorts"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * ExpressRoutePort properties.␊ - */␊ - properties: (ExpressRoutePortPropertiesFormat13 | string)␊ - /**␊ - * The identity of ExpressRoutePort, if configured.␊ - */␊ - identity?: (ManagedServiceIdentity12 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to ExpressRoutePort resources.␊ - */␊ - export interface ExpressRoutePortPropertiesFormat13 {␊ - /**␊ - * The name of the peering location that the ExpressRoutePort is mapped to physically.␊ - */␊ - peeringLocation?: string␊ - /**␊ - * Bandwidth of procured ports in Gbps.␊ - */␊ - bandwidthInGbps?: (number | string)␊ - /**␊ - * Encapsulation method on physical ports.␊ - */␊ - encapsulation?: (("Dot1Q" | "QinQ") | string)␊ - /**␊ - * The set of physical links of the ExpressRoutePort resource.␊ - */␊ - links?: (ExpressRouteLink13[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ExpressRouteLink child resource definition.␊ - */␊ - export interface ExpressRouteLink13 {␊ - /**␊ - * ExpressRouteLink properties.␊ - */␊ - properties?: (ExpressRouteLinkPropertiesFormat13 | string)␊ - /**␊ - * Name of child port resource that is unique among child port resources of the parent.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to ExpressRouteLink resources.␊ - */␊ - export interface ExpressRouteLinkPropertiesFormat13 {␊ - /**␊ - * Administrative state of the physical port.␊ - */␊ - adminState?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * MacSec configuration.␊ - */␊ - macSecConfig?: (ExpressRouteLinkMacSecConfig6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ExpressRouteLink Mac Security Configuration.␊ - */␊ - export interface ExpressRouteLinkMacSecConfig6 {␊ - /**␊ - * Keyvault Secret Identifier URL containing Mac security CKN key.␊ - */␊ - cknSecretIdentifier?: string␊ - /**␊ - * Keyvault Secret Identifier URL containing Mac security CAK key.␊ - */␊ - cakSecretIdentifier?: string␊ - /**␊ - * Mac security cipher.␊ - */␊ - cipher?: (("gcm-aes-128" | "gcm-aes-256") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/firewallPolicies␊ - */␊ - export interface FirewallPolicies7 {␊ - name: string␊ - type: "Microsoft.Network/firewallPolicies"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the firewall policy.␊ - */␊ - properties: (FirewallPolicyPropertiesFormat7 | string)␊ - /**␊ - * The identity of the firewall policy.␊ - */␊ - identity?: (ManagedServiceIdentity12 | string)␊ - resources?: FirewallPoliciesRuleGroupsChildResource7[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Firewall Policy definition.␊ - */␊ - export interface FirewallPolicyPropertiesFormat7 {␊ - /**␊ - * The parent firewall policy from which rules are inherited.␊ - */␊ - basePolicy?: (SubResource34 | string)␊ - /**␊ - * The operation mode for Threat Intelligence.␊ - */␊ - threatIntelMode?: (("Alert" | "Deny" | "Off") | string)␊ - /**␊ - * ThreatIntel Whitelist for Firewall Policy.␊ - */␊ - threatIntelWhitelist?: (FirewallPolicyThreatIntelWhitelist | string)␊ - /**␊ - * The operation mode for Intrusion system.␊ - */␊ - intrusionSystemMode?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * TLS Configuration definition.␊ - */␊ - transportSecurity?: (FirewallPolicyTransportSecurity | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ThreatIntel Whitelist for Firewall Policy.␊ - */␊ - export interface FirewallPolicyThreatIntelWhitelist {␊ - /**␊ - * List of IP addresses for the ThreatIntel Whitelist.␊ - */␊ - ipAddresses?: (string[] | string)␊ - /**␊ - * List of FQDNs for the ThreatIntel Whitelist.␊ - */␊ - fqdns?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Configuration needed to perform TLS termination & initiation.␊ - */␊ - export interface FirewallPolicyTransportSecurity {␊ - /**␊ - * The CA used for intermediate CA generation.␊ - */␊ - certificateAuthority?: (FirewallPolicyCertificateAuthority | string)␊ - /**␊ - * List of domains which are excluded from TLS termination.␊ - */␊ - excludedDomains?: (string[] | string)␊ - /**␊ - * Certificates which are to be trusted by the firewall.␊ - */␊ - trustedRootCertificates?: (FirewallPolicyTrustedRootCertificate[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trusted Root certificates properties for tls.␊ - */␊ - export interface FirewallPolicyCertificateAuthority {␊ - /**␊ - * Properties of the certificate authority.␊ - */␊ - properties?: (FirewallPolicyCertificateAuthorityPropertiesFormat | string)␊ - /**␊ - * Name of the CA certificate.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trusted Root certificates properties for tls.␊ - */␊ - export interface FirewallPolicyCertificateAuthorityPropertiesFormat {␊ - /**␊ - * Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault.␊ - */␊ - keyVaultSecretId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trusted Root certificates of a firewall policy.␊ - */␊ - export interface FirewallPolicyTrustedRootCertificate {␊ - /**␊ - * Properties of the trusted root authorities.␊ - */␊ - properties?: (FirewallPolicyTrustedRootCertificatePropertiesFormat | string)␊ - /**␊ - * Name of the trusted root certificate that is unique within a firewall policy.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trusted Root certificates properties for tls.␊ - */␊ - export interface FirewallPolicyTrustedRootCertificatePropertiesFormat {␊ - /**␊ - * Secret Id of (base-64 encoded unencrypted pfx) the public certificate data stored in KeyVault.␊ - */␊ - keyVaultSecretId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/firewallPolicies/ruleGroups␊ - */␊ - export interface FirewallPoliciesRuleGroupsChildResource7 {␊ - name: string␊ - type: "ruleGroups"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * The properties of the firewall policy rule group.␊ - */␊ - properties: (FirewallPolicyRuleGroupProperties7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the rule group.␊ - */␊ - export interface FirewallPolicyRuleGroupProperties7 {␊ - /**␊ - * Priority of the Firewall Policy Rule Group resource.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * Group of Firewall Policy rules.␊ - */␊ - rules?: (FirewallPolicyRule7[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the FirewallPolicyNatRuleAction.␊ - */␊ - export interface FirewallPolicyNatRuleAction7 {␊ - /**␊ - * The type of action.␊ - */␊ - type?: "DNAT"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application rule protocol.␊ - */␊ - export interface FirewallPolicyRuleConditionApplicationProtocol7 {␊ - /**␊ - * Protocol type.␊ - */␊ - protocolType?: (("Http" | "Https") | string)␊ - /**␊ - * Port number for the protocol, cannot be greater than 64000.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the FirewallPolicyFilterRuleAction.␊ - */␊ - export interface FirewallPolicyFilterRuleAction7 {␊ - /**␊ - * The type of action.␊ - */␊ - type?: ("Allow" | "Deny")␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/firewallPolicies/ruleGroups␊ - */␊ - export interface FirewallPoliciesRuleGroups7 {␊ - name: string␊ - type: "Microsoft.Network/firewallPolicies/ruleGroups"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * The properties of the firewall policy rule group.␊ - */␊ - properties: (FirewallPolicyRuleGroupProperties7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/IpAllocations␊ - */␊ - export interface IpAllocations1 {␊ - name: string␊ - type: "Microsoft.Network/IpAllocations"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the IpAllocation.␊ - */␊ - properties: (IpAllocationPropertiesFormat1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the IpAllocation.␊ - */␊ - export interface IpAllocationPropertiesFormat1 {␊ - /**␊ - * The type for the IpAllocation.␊ - */␊ - type?: ("Undefined" | "Hypernet")␊ - /**␊ - * The address prefix for the IpAllocation.␊ - */␊ - prefix?: string␊ - /**␊ - * The address prefix length for the IpAllocation.␊ - */␊ - prefixLength?: ((number & string) | string)␊ - /**␊ - * The address prefix Type for the IpAllocation.␊ - */␊ - prefixType?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The IPAM allocation ID.␊ - */␊ - ipamAllocationId?: string␊ - /**␊ - * IpAllocation tags.␊ - */␊ - allocationTags?: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ipGroups␊ - */␊ - export interface IpGroups4 {␊ - name: string␊ - type: "Microsoft.Network/ipGroups"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the IpGroups.␊ - */␊ - properties: (IpGroupPropertiesFormat4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The IpGroups property information.␊ - */␊ - export interface IpGroupPropertiesFormat4 {␊ - /**␊ - * IpAddresses/IpAddressPrefixes in the IpGroups resource.␊ - */␊ - ipAddresses?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers␊ - */␊ - export interface LoadBalancers34 {␊ - name: string␊ - type: "Microsoft.Network/loadBalancers"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The load balancer SKU.␊ - */␊ - sku?: (LoadBalancerSku22 | string)␊ - /**␊ - * Properties of load balancer.␊ - */␊ - properties: (LoadBalancerPropertiesFormat26 | string)␊ - resources?: (LoadBalancersInboundNatRulesChildResource22 | LoadBalancersBackendAddressPoolsChildResource)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a load balancer.␊ - */␊ - export interface LoadBalancerSku22 {␊ - /**␊ - * Name of a load balancer SKU.␊ - */␊ - name?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer.␊ - */␊ - export interface LoadBalancerPropertiesFormat26 {␊ - /**␊ - * Object representing the frontend IPs to be used for the load balancer.␊ - */␊ - frontendIPConfigurations?: (FrontendIPConfiguration25[] | string)␊ - /**␊ - * Collection of backend address pools used by a load balancer.␊ - */␊ - backendAddressPools?: (BackendAddressPool26[] | string)␊ - /**␊ - * Object collection representing the load balancing rules Gets the provisioning.␊ - */␊ - loadBalancingRules?: (LoadBalancingRule26[] | string)␊ - /**␊ - * Collection of probe objects used in the load balancer.␊ - */␊ - probes?: (Probe26[] | string)␊ - /**␊ - * Collection of inbound NAT Rules used by a load balancer. Defining inbound NAT rules on your load balancer is mutually exclusive with defining an inbound NAT pool. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an Inbound NAT pool. They have to reference individual inbound NAT rules.␊ - */␊ - inboundNatRules?: (InboundNatRule27[] | string)␊ - /**␊ - * Defines an external port range for inbound NAT to a single backend port on NICs associated with a load balancer. Inbound NAT rules are created automatically for each NIC associated with the Load Balancer using an external port from this range. Defining an Inbound NAT pool on your Load Balancer is mutually exclusive with defining inbound Nat rules. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an inbound NAT pool. They have to reference individual inbound NAT rules.␊ - */␊ - inboundNatPools?: (InboundNatPool27[] | string)␊ - /**␊ - * The outbound rules.␊ - */␊ - outboundRules?: (OutboundRule14[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP address of the load balancer.␊ - */␊ - export interface FrontendIPConfiguration25 {␊ - /**␊ - * Properties of the load balancer probe.␊ - */␊ - properties?: (FrontendIPConfigurationPropertiesFormat25 | string)␊ - /**␊ - * The name of the resource that is unique within the set of frontend IP configurations used by the load balancer. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP Configuration of the load balancer.␊ - */␊ - export interface FrontendIPConfigurationPropertiesFormat25 {␊ - /**␊ - * The private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The Private IP allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4.␊ - */␊ - privateIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The reference to the subnet resource.␊ - */␊ - subnet?: (SubResource34 | string)␊ - /**␊ - * The reference to the Public IP resource.␊ - */␊ - publicIPAddress?: (SubResource34 | string)␊ - /**␊ - * The reference to the Public IP Prefix resource.␊ - */␊ - publicIPPrefix?: (SubResource34 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Pool of backend IP addresses.␊ - */␊ - export interface BackendAddressPool26 {␊ - /**␊ - * Properties of load balancer backend address pool.␊ - */␊ - properties?: (BackendAddressPoolPropertiesFormat24 | string)␊ - /**␊ - * The name of the resource that is unique within the set of backend address pools used by the load balancer. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the backend address pool.␊ - */␊ - export interface BackendAddressPoolPropertiesFormat24 {␊ - /**␊ - * An array of backend addresses.␊ - */␊ - loadBalancerBackendAddresses?: (LoadBalancerBackendAddress[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Load balancer backend addresses.␊ - */␊ - export interface LoadBalancerBackendAddress {␊ - /**␊ - * Properties of load balancer backend address pool.␊ - */␊ - properties?: (LoadBalancerBackendAddressPropertiesFormat | string)␊ - /**␊ - * Name of the backend address.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer backend addresses.␊ - */␊ - export interface LoadBalancerBackendAddressPropertiesFormat {␊ - /**␊ - * Reference to an existing virtual network.␊ - */␊ - virtualNetwork?: (VirtualNetwork1 | string)␊ - /**␊ - * IP Address belonging to the referenced virtual network.␊ - */␊ - ipAddress?: string␊ - /**␊ - * Reference to IP address defined in network interfaces.␊ - */␊ - networkInterfaceIPConfiguration?: (NetworkInterfaceIPConfiguration25 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Virtual Network resource.␊ - */␊ - export interface VirtualNetwork1 {␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network.␊ - */␊ - properties?: (VirtualNetworkPropertiesFormat26 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the virtual network.␊ - */␊ - export interface VirtualNetworkPropertiesFormat26 {␊ - /**␊ - * The AddressSpace that contains an array of IP address ranges that can be used by subnets.␊ - */␊ - addressSpace: (AddressSpace34 | string)␊ - /**␊ - * The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network.␊ - */␊ - dhcpOptions?: (DhcpOptions34 | string)␊ - /**␊ - * A list of subnets in a Virtual Network.␊ - */␊ - subnets?: (Subnet36[] | string)␊ - /**␊ - * A list of peerings in a Virtual Network.␊ - */␊ - virtualNetworkPeerings?: (VirtualNetworkPeering31[] | string)␊ - /**␊ - * Indicates if DDoS protection is enabled for all the protected resources in the virtual network. It requires a DDoS protection plan associated with the resource.␊ - */␊ - enableDdosProtection?: (boolean | string)␊ - /**␊ - * Indicates if VM protection is enabled for all the subnets in the virtual network.␊ - */␊ - enableVmProtection?: (boolean | string)␊ - /**␊ - * The DDoS protection plan associated with the virtual network.␊ - */␊ - ddosProtectionPlan?: (SubResource34 | string)␊ - /**␊ - * Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET.␊ - */␊ - bgpCommunities?: (VirtualNetworkBgpCommunities5 | string)␊ - /**␊ - * Array of IpAllocation which reference this VNET.␊ - */␊ - ipAllocations?: (SubResource34[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.␊ - */␊ - export interface AddressSpace34 {␊ - /**␊ - * A list of address blocks reserved for this virtual network in CIDR notation.␊ - */␊ - addressPrefixes: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DhcpOptions contains an array of DNS servers available to VMs deployed in the virtual network. Standard DHCP option for a subnet overrides VNET DHCP options.␊ - */␊ - export interface DhcpOptions34 {␊ - /**␊ - * The list of DNS servers IP addresses.␊ - */␊ - dnsServers: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Subnet in a virtual network resource.␊ - */␊ - export interface Subnet36 {␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties?: (SubnetPropertiesFormat26 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the subnet.␊ - */␊ - export interface SubnetPropertiesFormat26 {␊ - /**␊ - * The address prefix for the subnet.␊ - */␊ - addressPrefix: string␊ - /**␊ - * List of address prefixes for the subnet.␊ - */␊ - addressPrefixes?: (string[] | string)␊ - /**␊ - * The reference to the NetworkSecurityGroup resource.␊ - */␊ - networkSecurityGroup?: (SubResource34 | string)␊ - /**␊ - * The reference to the RouteTable resource.␊ - */␊ - routeTable?: (SubResource34 | string)␊ - /**␊ - * Nat gateway associated with this subnet.␊ - */␊ - natGateway?: (SubResource34 | string)␊ - /**␊ - * An array of service endpoints.␊ - */␊ - serviceEndpoints?: (ServiceEndpointPropertiesFormat22[] | string)␊ - /**␊ - * An array of service endpoint policies.␊ - */␊ - serviceEndpointPolicies?: (SubResource34[] | string)␊ - /**␊ - * Array of IpAllocation which reference this subnet.␊ - */␊ - ipAllocations?: (SubResource34[] | string)␊ - /**␊ - * An array of references to the delegations on the subnet.␊ - */␊ - delegations?: (Delegation13[] | string)␊ - /**␊ - * Enable or Disable apply network policies on private end point in the subnet.␊ - */␊ - privateEndpointNetworkPolicies?: string␊ - /**␊ - * Enable or Disable apply network policies on private link service in the subnet.␊ - */␊ - privateLinkServiceNetworkPolicies?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The service endpoint properties.␊ - */␊ - export interface ServiceEndpointPropertiesFormat22 {␊ - /**␊ - * The type of the endpoint service.␊ - */␊ - service?: string␊ - /**␊ - * A list of locations.␊ - */␊ - locations?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Details the service to which the subnet is delegated.␊ - */␊ - export interface Delegation13 {␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties?: (ServiceDelegationPropertiesFormat13 | string)␊ - /**␊ - * The name of the resource that is unique within a subnet. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a service delegation.␊ - */␊ - export interface ServiceDelegationPropertiesFormat13 {␊ - /**␊ - * The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers).␊ - */␊ - serviceName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peerings in a virtual network resource.␊ - */␊ - export interface VirtualNetworkPeering31 {␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties?: (VirtualNetworkPeeringPropertiesFormat23 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - export interface VirtualNetworkPeeringPropertiesFormat23 {␊ - /**␊ - * Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space.␊ - */␊ - allowVirtualNetworkAccess?: (boolean | string)␊ - /**␊ - * Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network.␊ - */␊ - allowForwardedTraffic?: (boolean | string)␊ - /**␊ - * If gateway links can be used in remote virtual networking to link to this virtual network.␊ - */␊ - allowGatewayTransit?: (boolean | string)␊ - /**␊ - * If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway.␊ - */␊ - useRemoteGateways?: (boolean | string)␊ - /**␊ - * The reference to the remote virtual network. The remote virtual network can be in the same or different region (preview). See here to register for the preview and learn more (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering).␊ - */␊ - remoteVirtualNetwork: (SubResource34 | string)␊ - /**␊ - * The reference to the remote virtual network address space.␊ - */␊ - remoteAddressSpace?: (AddressSpace34 | string)␊ - /**␊ - * The status of the virtual network peering.␊ - */␊ - peeringState?: (("Initiated" | "Connected" | "Disconnected") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET.␊ - */␊ - export interface VirtualNetworkBgpCommunities5 {␊ - /**␊ - * The BGP community associated with the virtual network.␊ - */␊ - virtualNetworkCommunity: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IPConfiguration in a network interface.␊ - */␊ - export interface NetworkInterfaceIPConfiguration25 {␊ - /**␊ - * Network interface IP configuration properties.␊ - */␊ - properties?: (NetworkInterfaceIPConfigurationPropertiesFormat25 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration.␊ - */␊ - export interface NetworkInterfaceIPConfigurationPropertiesFormat25 {␊ - /**␊ - * The reference to Virtual Network Taps.␊ - */␊ - virtualNetworkTaps?: (SubResource34[] | string)␊ - /**␊ - * The reference to ApplicationGatewayBackendAddressPool resource.␊ - */␊ - applicationGatewayBackendAddressPools?: (SubResource34[] | string)␊ - /**␊ - * The reference to LoadBalancerBackendAddressPool resource.␊ - */␊ - loadBalancerBackendAddressPools?: (SubResource34[] | string)␊ - /**␊ - * A list of references of LoadBalancerInboundNatRules.␊ - */␊ - loadBalancerInboundNatRules?: (SubResource34[] | string)␊ - /**␊ - * Private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The private IP address allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4.␊ - */␊ - privateIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * Subnet bound to the IP configuration.␊ - */␊ - subnet?: (SubResource34 | string)␊ - /**␊ - * Whether this is a primary customer address on the network interface.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * Public IP address bound to the IP configuration.␊ - */␊ - publicIPAddress?: (SubResource34 | string)␊ - /**␊ - * Application security groups in which the IP configuration is included.␊ - */␊ - applicationSecurityGroups?: (SubResource34[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A load balancing rule for a load balancer.␊ - */␊ - export interface LoadBalancingRule26 {␊ - /**␊ - * Properties of load balancer load balancing rule.␊ - */␊ - properties?: (LoadBalancingRulePropertiesFormat26 | string)␊ - /**␊ - * The name of the resource that is unique within the set of load balancing rules used by the load balancer. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer.␊ - */␊ - export interface LoadBalancingRulePropertiesFormat26 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource34 | string)␊ - /**␊ - * A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs.␊ - */␊ - backendAddressPool?: (SubResource34 | string)␊ - /**␊ - * The reference to the load balancer probe used by the load balancing rule.␊ - */␊ - probe?: (SubResource34 | string)␊ - /**␊ - * The reference to the transport protocol used by the load balancing rule.␊ - */␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The load distribution policy for this rule.␊ - */␊ - loadDistribution?: (("Default" | "SourceIP" | "SourceIPProtocol") | string)␊ - /**␊ - * The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 0 and 65534. Note that value 0 enables "Any Port".␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port".␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - /**␊ - * Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule.␊ - */␊ - disableOutboundSnat?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A load balancer probe.␊ - */␊ - export interface Probe26 {␊ - /**␊ - * Properties of load balancer probe.␊ - */␊ - properties?: (ProbePropertiesFormat26 | string)␊ - /**␊ - * The name of the resource that is unique within the set of probes used by the load balancer. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Load balancer probe resource.␊ - */␊ - export interface ProbePropertiesFormat26 {␊ - /**␊ - * The protocol of the end point. If 'Tcp' is specified, a received ACK is required for the probe to be successful. If 'Http' or 'Https' is specified, a 200 OK response from the specifies URI is required for the probe to be successful.␊ - */␊ - protocol: (("Http" | "Tcp" | "Https") | string)␊ - /**␊ - * The port for communicating the probe. Possible values range from 1 to 65535, inclusive.␊ - */␊ - port: (number | string)␊ - /**␊ - * The interval, in seconds, for how frequently to probe the endpoint for health status. Typically, the interval is slightly less than half the allocated timeout period (in seconds) which allows two full probes before taking the instance out of rotation. The default value is 15, the minimum value is 5.␊ - */␊ - intervalInSeconds?: (number | string)␊ - /**␊ - * The number of probes where if no response, will result in stopping further traffic from being delivered to the endpoint. This values allows endpoints to be taken out of rotation faster or slower than the typical times used in Azure.␊ - */␊ - numberOfProbes: (number | string)␊ - /**␊ - * The URI used for requesting health status from the VM. Path is required if a protocol is set to http. Otherwise, it is not allowed. There is no default value.␊ - */␊ - requestPath?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT rule of the load balancer.␊ - */␊ - export interface InboundNatRule27 {␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties?: (InboundNatRulePropertiesFormat26 | string)␊ - /**␊ - * The name of the resource that is unique within the set of inbound NAT rules used by the load balancer. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the inbound NAT rule.␊ - */␊ - export interface InboundNatRulePropertiesFormat26 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource34 | string)␊ - /**␊ - * The reference to the transport protocol used by the load balancing rule.␊ - */␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values range from 1 to 65534.␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * The port used for the internal endpoint. Acceptable values range from 1 to 65535.␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT pool of the load balancer.␊ - */␊ - export interface InboundNatPool27 {␊ - /**␊ - * Properties of load balancer inbound nat pool.␊ - */␊ - properties?: (InboundNatPoolPropertiesFormat26 | string)␊ - /**␊ - * The name of the resource that is unique within the set of inbound NAT pools used by the load balancer. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Inbound NAT pool.␊ - */␊ - export interface InboundNatPoolPropertiesFormat26 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource34 | string)␊ - /**␊ - * The reference to the transport protocol used by the inbound NAT pool.␊ - */␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65534.␊ - */␊ - frontendPortRangeStart: (number | string)␊ - /**␊ - * The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65535.␊ - */␊ - frontendPortRangeEnd: (number | string)␊ - /**␊ - * The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound rule of the load balancer.␊ - */␊ - export interface OutboundRule14 {␊ - /**␊ - * Properties of load balancer outbound rule.␊ - */␊ - properties?: (OutboundRulePropertiesFormat14 | string)␊ - /**␊ - * The name of the resource that is unique within the set of outbound rules used by the load balancer. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound rule of the load balancer.␊ - */␊ - export interface OutboundRulePropertiesFormat14 {␊ - /**␊ - * The number of outbound ports to be used for NAT.␊ - */␊ - allocatedOutboundPorts?: (number | string)␊ - /**␊ - * The Frontend IP addresses of the load balancer.␊ - */␊ - frontendIPConfigurations: (SubResource34[] | string)␊ - /**␊ - * A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs.␊ - */␊ - backendAddressPool: (SubResource34 | string)␊ - /**␊ - * The protocol for the outbound rule in load balancer.␊ - */␊ - protocol: (("Tcp" | "Udp" | "All") | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - /**␊ - * The timeout for the TCP idle connection.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers/inboundNatRules␊ - */␊ - export interface LoadBalancersInboundNatRulesChildResource22 {␊ - name: string␊ - type: "inboundNatRules"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties: (InboundNatRulePropertiesFormat26 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers/backendAddressPools␊ - */␊ - export interface LoadBalancersBackendAddressPoolsChildResource {␊ - name: string␊ - type: "backendAddressPools"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Properties of load balancer backend address pool.␊ - */␊ - properties: (BackendAddressPoolPropertiesFormat24 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers/backendAddressPools␊ - */␊ - export interface LoadBalancersBackendAddressPools {␊ - name: string␊ - type: "Microsoft.Network/loadBalancers/backendAddressPools"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Properties of load balancer backend address pool.␊ - */␊ - properties: (BackendAddressPoolPropertiesFormat24 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers/inboundNatRules␊ - */␊ - export interface LoadBalancersInboundNatRules22 {␊ - name: string␊ - type: "Microsoft.Network/loadBalancers/inboundNatRules"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties: (InboundNatRulePropertiesFormat26 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/localNetworkGateways␊ - */␊ - export interface LocalNetworkGateways26 {␊ - name: string␊ - type: "Microsoft.Network/localNetworkGateways"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the local network gateway.␊ - */␊ - properties: (LocalNetworkGatewayPropertiesFormat26 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * LocalNetworkGateway properties.␊ - */␊ - export interface LocalNetworkGatewayPropertiesFormat26 {␊ - /**␊ - * Local network site address space.␊ - */␊ - localNetworkAddressSpace?: (AddressSpace34 | string)␊ - /**␊ - * IP address of local network gateway.␊ - */␊ - gatewayIpAddress?: string␊ - /**␊ - * FQDN of local network gateway.␊ - */␊ - fqdn?: string␊ - /**␊ - * Local network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings25 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * BGP settings details.␊ - */␊ - export interface BgpSettings25 {␊ - /**␊ - * The BGP speaker's ASN.␊ - */␊ - asn?: (number | string)␊ - /**␊ - * The BGP peering address and BGP identifier of this BGP speaker.␊ - */␊ - bgpPeeringAddress?: string␊ - /**␊ - * The weight added to routes learned from this BGP speaker.␊ - */␊ - peerWeight?: (number | string)␊ - /**␊ - * BGP peering address with IP configuration ID for virtual network gateway.␊ - */␊ - bgpPeeringAddresses?: (IPConfigurationBgpPeeringAddress2[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IPConfigurationBgpPeeringAddress.␊ - */␊ - export interface IPConfigurationBgpPeeringAddress2 {␊ - /**␊ - * The ID of IP configuration which belongs to gateway.␊ - */␊ - ipconfigurationId?: string␊ - /**␊ - * The list of custom BGP peering addresses which belong to IP configuration.␊ - */␊ - customBgpIpAddresses?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/natGateways␊ - */␊ - export interface NatGateways9 {␊ - name: string␊ - type: "Microsoft.Network/natGateways"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The nat gateway SKU.␊ - */␊ - sku?: (NatGatewaySku9 | string)␊ - /**␊ - * Nat Gateway properties.␊ - */␊ - properties: (NatGatewayPropertiesFormat9 | string)␊ - /**␊ - * A list of availability zones denoting the zone in which Nat Gateway should be deployed.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of nat gateway.␊ - */␊ - export interface NatGatewaySku9 {␊ - /**␊ - * Name of Nat Gateway SKU.␊ - */␊ - name?: ("Standard" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Nat Gateway properties.␊ - */␊ - export interface NatGatewayPropertiesFormat9 {␊ - /**␊ - * The idle timeout of the nat gateway.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * An array of public ip addresses associated with the nat gateway resource.␊ - */␊ - publicIpAddresses?: (SubResource34[] | string)␊ - /**␊ - * An array of public ip prefixes associated with the nat gateway resource.␊ - */␊ - publicIpPrefixes?: (SubResource34[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces␊ - */␊ - export interface NetworkInterfaces35 {␊ - name: string␊ - type: "Microsoft.Network/networkInterfaces"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network interface.␊ - */␊ - properties: (NetworkInterfacePropertiesFormat26 | string)␊ - resources?: NetworkInterfacesTapConfigurationsChildResource13[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NetworkInterface properties.␊ - */␊ - export interface NetworkInterfacePropertiesFormat26 {␊ - /**␊ - * The reference to the NetworkSecurityGroup resource.␊ - */␊ - networkSecurityGroup?: (SubResource34 | string)␊ - /**␊ - * A list of IPConfigurations of the network interface.␊ - */␊ - ipConfigurations: (NetworkInterfaceIPConfiguration25[] | string)␊ - /**␊ - * The DNS settings in network interface.␊ - */␊ - dnsSettings?: (NetworkInterfaceDnsSettings34 | string)␊ - /**␊ - * If the network interface is accelerated networking enabled.␊ - */␊ - enableAcceleratedNetworking?: (boolean | string)␊ - /**␊ - * Indicates whether IP forwarding is enabled on this network interface.␊ - */␊ - enableIPForwarding?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DNS settings of a network interface.␊ - */␊ - export interface NetworkInterfaceDnsSettings34 {␊ - /**␊ - * List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only value in dnsServers collection.␊ - */␊ - dnsServers?: (string[] | string)␊ - /**␊ - * Relative DNS name for this NIC used for internal communications between VMs in the same virtual network.␊ - */␊ - internalDnsNameLabel?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces/tapConfigurations␊ - */␊ - export interface NetworkInterfacesTapConfigurationsChildResource13 {␊ - name: string␊ - type: "tapConfigurations"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Properties of the Virtual Network Tap configuration.␊ - */␊ - properties: (NetworkInterfaceTapConfigurationPropertiesFormat13 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Virtual Network Tap configuration.␊ - */␊ - export interface NetworkInterfaceTapConfigurationPropertiesFormat13 {␊ - /**␊ - * The reference to the Virtual Network Tap resource.␊ - */␊ - virtualNetworkTap?: (SubResource34 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces/tapConfigurations␊ - */␊ - export interface NetworkInterfacesTapConfigurations13 {␊ - name: string␊ - type: "Microsoft.Network/networkInterfaces/tapConfigurations"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Properties of the Virtual Network Tap configuration.␊ - */␊ - properties: (NetworkInterfaceTapConfigurationPropertiesFormat13 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkProfiles␊ - */␊ - export interface NetworkProfiles8 {␊ - name: string␊ - type: "Microsoft.Network/networkProfiles"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Network profile properties.␊ - */␊ - properties: (NetworkProfilePropertiesFormat8 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network profile properties.␊ - */␊ - export interface NetworkProfilePropertiesFormat8 {␊ - /**␊ - * List of chid container network interface configurations.␊ - */␊ - containerNetworkInterfaceConfigurations?: (ContainerNetworkInterfaceConfiguration8[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Container network interface configuration child resource.␊ - */␊ - export interface ContainerNetworkInterfaceConfiguration8 {␊ - /**␊ - * Container network interface configuration properties.␊ - */␊ - properties?: (ContainerNetworkInterfaceConfigurationPropertiesFormat8 | string)␊ - /**␊ - * The name of the resource. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Container network interface configuration properties.␊ - */␊ - export interface ContainerNetworkInterfaceConfigurationPropertiesFormat8 {␊ - /**␊ - * A list of ip configurations of the container network interface configuration.␊ - */␊ - ipConfigurations?: (IPConfigurationProfile8[] | string)␊ - /**␊ - * A list of container network interfaces created from this container network interface configuration.␊ - */␊ - containerNetworkInterfaces?: (SubResource34[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration profile child resource.␊ - */␊ - export interface IPConfigurationProfile8 {␊ - /**␊ - * Properties of the IP configuration profile.␊ - */␊ - properties?: (IPConfigurationProfilePropertiesFormat8 | string)␊ - /**␊ - * The name of the resource. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration profile properties.␊ - */␊ - export interface IPConfigurationProfilePropertiesFormat8 {␊ - /**␊ - * The reference to the subnet resource to create a container network interface ip configuration.␊ - */␊ - subnet?: (SubResource34 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups␊ - */␊ - export interface NetworkSecurityGroups34 {␊ - name: string␊ - type: "Microsoft.Network/networkSecurityGroups"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network security group.␊ - */␊ - properties: (NetworkSecurityGroupPropertiesFormat26 | string)␊ - resources?: NetworkSecurityGroupsSecurityRulesChildResource26[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network Security Group resource.␊ - */␊ - export interface NetworkSecurityGroupPropertiesFormat26 {␊ - /**␊ - * A collection of security rules of the network security group.␊ - */␊ - securityRules?: (SecurityRule26[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network security rule.␊ - */␊ - export interface SecurityRule26 {␊ - /**␊ - * Properties of the security rule.␊ - */␊ - properties?: (SecurityRulePropertiesFormat26 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Security rule resource.␊ - */␊ - export interface SecurityRulePropertiesFormat26 {␊ - /**␊ - * A description for this rule. Restricted to 140 chars.␊ - */␊ - description?: string␊ - /**␊ - * Network protocol this rule applies to.␊ - */␊ - protocol: (("Tcp" | "Udp" | "Icmp" | "Esp" | "*" | "Ah") | string)␊ - /**␊ - * The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.␊ - */␊ - sourcePortRange?: string␊ - /**␊ - * The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.␊ - */␊ - destinationPortRange?: string␊ - /**␊ - * The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from.␊ - */␊ - sourceAddressPrefix?: string␊ - /**␊ - * The CIDR or source IP ranges.␊ - */␊ - sourceAddressPrefixes?: (string[] | string)␊ - /**␊ - * The application security group specified as source.␊ - */␊ - sourceApplicationSecurityGroups?: (SubResource34[] | string)␊ - /**␊ - * The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used.␊ - */␊ - destinationAddressPrefix?: string␊ - /**␊ - * The destination address prefixes. CIDR or destination IP ranges.␊ - */␊ - destinationAddressPrefixes?: (string[] | string)␊ - /**␊ - * The application security group specified as destination.␊ - */␊ - destinationApplicationSecurityGroups?: (SubResource34[] | string)␊ - /**␊ - * The source port ranges.␊ - */␊ - sourcePortRanges?: (string[] | string)␊ - /**␊ - * The destination port ranges.␊ - */␊ - destinationPortRanges?: (string[] | string)␊ - /**␊ - * The network traffic is allowed or denied.␊ - */␊ - access: (("Allow" | "Deny") | string)␊ - /**␊ - * The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.␊ - */␊ - priority: (number | string)␊ - /**␊ - * The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic.␊ - */␊ - direction: (("Inbound" | "Outbound") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRulesChildResource26 {␊ - name: string␊ - type: "securityRules"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Properties of the security rule.␊ - */␊ - properties: (SecurityRulePropertiesFormat26 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRules26 {␊ - name: string␊ - type: "Microsoft.Network/networkSecurityGroups/securityRules"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Properties of the security rule.␊ - */␊ - properties: (SecurityRulePropertiesFormat26 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkVirtualAppliances␊ - */␊ - export interface NetworkVirtualAppliances2 {␊ - name: string␊ - type: "Microsoft.Network/networkVirtualAppliances"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the Network Virtual Appliance.␊ - */␊ - properties: (NetworkVirtualAppliancePropertiesFormat2 | string)␊ - /**␊ - * The service principal that has read access to cloud-init and config blob.␊ - */␊ - identity?: (ManagedServiceIdentity12 | string)␊ - /**␊ - * Network Virtual Appliance SKU.␊ - */␊ - sku?: (VirtualApplianceSkuProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network Virtual Appliance definition.␊ - */␊ - export interface NetworkVirtualAppliancePropertiesFormat2 {␊ - /**␊ - * BootStrapConfigurationBlob storage URLs.␊ - */␊ - bootStrapConfigurationBlob?: (string[] | string)␊ - /**␊ - * The Virtual Hub where Network Virtual Appliance is being deployed.␊ - */␊ - virtualHub?: (SubResource34 | string)␊ - /**␊ - * CloudInitConfigurationBlob storage URLs.␊ - */␊ - cloudInitConfigurationBlob?: (string[] | string)␊ - /**␊ - * VirtualAppliance ASN.␊ - */␊ - virtualApplianceAsn?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network Virtual Appliance Sku Properties.␊ - */␊ - export interface VirtualApplianceSkuProperties2 {␊ - /**␊ - * Virtual Appliance Vendor.␊ - */␊ - vendor?: string␊ - /**␊ - * Virtual Appliance Scale Unit.␊ - */␊ - bundledScaleUnit?: string␊ - /**␊ - * Virtual Appliance Version.␊ - */␊ - marketPlaceVersion?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers␊ - */␊ - export interface NetworkWatchers11 {␊ - name: string␊ - type: "Microsoft.Network/networkWatchers"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network watcher.␊ - */␊ - properties: (NetworkWatcherPropertiesFormat6 | string)␊ - resources?: (NetworkWatchersFlowLogsChildResource3 | NetworkWatchersConnectionMonitorsChildResource8 | NetworkWatchersPacketCapturesChildResource11)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The network watcher properties.␊ - */␊ - export interface NetworkWatcherPropertiesFormat6 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/flowLogs␊ - */␊ - export interface NetworkWatchersFlowLogsChildResource3 {␊ - name: string␊ - type: "flowLogs"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the flow log.␊ - */␊ - properties: (FlowLogPropertiesFormat3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters that define the configuration of flow log.␊ - */␊ - export interface FlowLogPropertiesFormat3 {␊ - /**␊ - * ID of network security group to which flow log will be applied.␊ - */␊ - targetResourceId: string␊ - /**␊ - * ID of the storage account which is used to store the flow log.␊ - */␊ - storageId: string␊ - /**␊ - * Flag to enable/disable flow logging.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Parameters that define the retention policy for flow log.␊ - */␊ - retentionPolicy?: (RetentionPolicyParameters3 | string)␊ - /**␊ - * Parameters that define the flow log format.␊ - */␊ - format?: (FlowLogFormatParameters3 | string)␊ - /**␊ - * Parameters that define the configuration of traffic analytics.␊ - */␊ - flowAnalyticsConfiguration?: (TrafficAnalyticsProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters that define the retention policy for flow log.␊ - */␊ - export interface RetentionPolicyParameters3 {␊ - /**␊ - * Number of days to retain flow log records.␊ - */␊ - days?: ((number & string) | string)␊ - /**␊ - * Flag to enable/disable retention.␊ - */␊ - enabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters that define the flow log format.␊ - */␊ - export interface FlowLogFormatParameters3 {␊ - /**␊ - * The file type of flow log.␊ - */␊ - type?: "JSON"␊ - /**␊ - * The version (revision) of the flow log.␊ - */␊ - version?: ((number & string) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters that define the configuration of traffic analytics.␊ - */␊ - export interface TrafficAnalyticsProperties3 {␊ - /**␊ - * Parameters that define the configuration of traffic analytics.␊ - */␊ - networkWatcherFlowAnalyticsConfiguration?: (TrafficAnalyticsConfigurationProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters that define the configuration of traffic analytics.␊ - */␊ - export interface TrafficAnalyticsConfigurationProperties3 {␊ - /**␊ - * Flag to enable/disable traffic analytics.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * The resource guid of the attached workspace.␊ - */␊ - workspaceId?: string␊ - /**␊ - * The location of the attached workspace.␊ - */␊ - workspaceRegion?: string␊ - /**␊ - * Resource Id of the attached workspace.␊ - */␊ - workspaceResourceId?: string␊ - /**␊ - * The interval in minutes which would decide how frequently TA service should do flow analytics.␊ - */␊ - trafficAnalyticsInterval?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/connectionMonitors␊ - */␊ - export interface NetworkWatchersConnectionMonitorsChildResource8 {␊ - name: string␊ - type: "connectionMonitors"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Connection monitor location.␊ - */␊ - location?: string␊ - /**␊ - * Connection monitor tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the connection monitor.␊ - */␊ - properties: (ConnectionMonitorParameters8 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters that define the operation to create a connection monitor.␊ - */␊ - export interface ConnectionMonitorParameters8 {␊ - /**␊ - * Describes the source of connection monitor.␊ - */␊ - source?: (ConnectionMonitorSource8 | string)␊ - /**␊ - * Describes the destination of connection monitor.␊ - */␊ - destination?: (ConnectionMonitorDestination8 | string)␊ - /**␊ - * Determines if the connection monitor will start automatically once created.␊ - */␊ - autoStart?: (boolean | string)␊ - /**␊ - * Monitoring interval in seconds.␊ - */␊ - monitoringIntervalInSeconds?: ((number & string) | string)␊ - /**␊ - * List of connection monitor endpoints.␊ - */␊ - endpoints?: (ConnectionMonitorEndpoint3[] | string)␊ - /**␊ - * List of connection monitor test configurations.␊ - */␊ - testConfigurations?: (ConnectionMonitorTestConfiguration3[] | string)␊ - /**␊ - * List of connection monitor test groups.␊ - */␊ - testGroups?: (ConnectionMonitorTestGroup3[] | string)␊ - /**␊ - * List of connection monitor outputs.␊ - */␊ - outputs?: (ConnectionMonitorOutput3[] | string)␊ - /**␊ - * Optional notes to be associated with the connection monitor.␊ - */␊ - notes?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the source of connection monitor.␊ - */␊ - export interface ConnectionMonitorSource8 {␊ - /**␊ - * The ID of the resource used as the source by connection monitor.␊ - */␊ - resourceId: string␊ - /**␊ - * The source port used by connection monitor.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the destination of connection monitor.␊ - */␊ - export interface ConnectionMonitorDestination8 {␊ - /**␊ - * The ID of the resource used as the destination by connection monitor.␊ - */␊ - resourceId?: string␊ - /**␊ - * Address of the connection monitor destination (IP or domain name).␊ - */␊ - address?: string␊ - /**␊ - * The destination port used by connection monitor.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the connection monitor endpoint.␊ - */␊ - export interface ConnectionMonitorEndpoint3 {␊ - /**␊ - * The name of the connection monitor endpoint.␊ - */␊ - name: string␊ - /**␊ - * Resource ID of the connection monitor endpoint.␊ - */␊ - resourceId?: string␊ - /**␊ - * Address of the connection monitor endpoint (IP or domain name).␊ - */␊ - address?: string␊ - /**␊ - * Filter for sub-items within the endpoint.␊ - */␊ - filter?: (ConnectionMonitorEndpointFilter3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the connection monitor endpoint filter.␊ - */␊ - export interface ConnectionMonitorEndpointFilter3 {␊ - /**␊ - * The behavior of the endpoint filter. Currently only 'Include' is supported.␊ - */␊ - type?: "Include"␊ - /**␊ - * List of items in the filter.␊ - */␊ - items?: (ConnectionMonitorEndpointFilterItem3[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the connection monitor endpoint filter item.␊ - */␊ - export interface ConnectionMonitorEndpointFilterItem3 {␊ - /**␊ - * The type of item included in the filter. Currently only 'AgentAddress' is supported.␊ - */␊ - type?: "AgentAddress"␊ - /**␊ - * The address of the filter item.␊ - */␊ - address?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a connection monitor test configuration.␊ - */␊ - export interface ConnectionMonitorTestConfiguration3 {␊ - /**␊ - * The name of the connection monitor test configuration.␊ - */␊ - name: string␊ - /**␊ - * The frequency of test evaluation, in seconds.␊ - */␊ - testFrequencySec?: (number | string)␊ - /**␊ - * The protocol to use in test evaluation.␊ - */␊ - protocol: (("Tcp" | "Http" | "Icmp") | string)␊ - /**␊ - * The preferred IP version to use in test evaluation. The connection monitor may choose to use a different version depending on other parameters.␊ - */␊ - preferredIPVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The parameters used to perform test evaluation over HTTP.␊ - */␊ - httpConfiguration?: (ConnectionMonitorHttpConfiguration3 | string)␊ - /**␊ - * The parameters used to perform test evaluation over TCP.␊ - */␊ - tcpConfiguration?: (ConnectionMonitorTcpConfiguration3 | string)␊ - /**␊ - * The parameters used to perform test evaluation over ICMP.␊ - */␊ - icmpConfiguration?: (ConnectionMonitorIcmpConfiguration3 | string)␊ - /**␊ - * The threshold for declaring a test successful.␊ - */␊ - successThreshold?: (ConnectionMonitorSuccessThreshold3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the HTTP configuration.␊ - */␊ - export interface ConnectionMonitorHttpConfiguration3 {␊ - /**␊ - * The port to connect to.␊ - */␊ - port?: (number | string)␊ - /**␊ - * The HTTP method to use.␊ - */␊ - method?: (("Get" | "Post") | string)␊ - /**␊ - * The path component of the URI. For instance, "/dir1/dir2".␊ - */␊ - path?: string␊ - /**␊ - * The HTTP headers to transmit with the request.␊ - */␊ - requestHeaders?: (HTTPHeader3[] | string)␊ - /**␊ - * HTTP status codes to consider successful. For instance, "2xx,301-304,418".␊ - */␊ - validStatusCodeRanges?: (string[] | string)␊ - /**␊ - * Value indicating whether HTTPS is preferred over HTTP in cases where the choice is not explicit.␊ - */␊ - preferHTTPS?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The HTTP header.␊ - */␊ - export interface HTTPHeader3 {␊ - /**␊ - * The name in HTTP header.␊ - */␊ - name?: string␊ - /**␊ - * The value in HTTP header.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the TCP configuration.␊ - */␊ - export interface ConnectionMonitorTcpConfiguration3 {␊ - /**␊ - * The port to connect to.␊ - */␊ - port?: (number | string)␊ - /**␊ - * Value indicating whether path evaluation with trace route should be disabled.␊ - */␊ - disableTraceRoute?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the ICMP configuration.␊ - */␊ - export interface ConnectionMonitorIcmpConfiguration3 {␊ - /**␊ - * Value indicating whether path evaluation with trace route should be disabled.␊ - */␊ - disableTraceRoute?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the threshold for declaring a test successful.␊ - */␊ - export interface ConnectionMonitorSuccessThreshold3 {␊ - /**␊ - * The maximum percentage of failed checks permitted for a test to evaluate as successful.␊ - */␊ - checksFailedPercent?: (number | string)␊ - /**␊ - * The maximum round-trip time in milliseconds permitted for a test to evaluate as successful.␊ - */␊ - roundTripTimeMs?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the connection monitor test group.␊ - */␊ - export interface ConnectionMonitorTestGroup3 {␊ - /**␊ - * The name of the connection monitor test group.␊ - */␊ - name: string␊ - /**␊ - * Value indicating whether test group is disabled.␊ - */␊ - disable?: (boolean | string)␊ - /**␊ - * List of test configuration names.␊ - */␊ - testConfigurations: (string[] | string)␊ - /**␊ - * List of source endpoint names.␊ - */␊ - sources: (string[] | string)␊ - /**␊ - * List of destination endpoint names.␊ - */␊ - destinations: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a connection monitor output destination.␊ - */␊ - export interface ConnectionMonitorOutput3 {␊ - /**␊ - * Connection monitor output destination type. Currently, only "Workspace" is supported.␊ - */␊ - type?: "Workspace"␊ - /**␊ - * Describes the settings for producing output into a log analytics workspace.␊ - */␊ - workspaceSettings?: (ConnectionMonitorWorkspaceSettings3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the settings for producing output into a log analytics workspace.␊ - */␊ - export interface ConnectionMonitorWorkspaceSettings3 {␊ - /**␊ - * Log analytics workspace resource ID.␊ - */␊ - workspaceResourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/packetCaptures␊ - */␊ - export interface NetworkWatchersPacketCapturesChildResource11 {␊ - name: string␊ - type: "packetCaptures"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Properties of the packet capture.␊ - */␊ - properties: (PacketCaptureParameters11 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters that define the create packet capture operation.␊ - */␊ - export interface PacketCaptureParameters11 {␊ - /**␊ - * The ID of the targeted resource, only VM is currently supported.␊ - */␊ - target: string␊ - /**␊ - * Number of bytes captured per packet, the remaining bytes are truncated.␊ - */␊ - bytesToCapturePerPacket?: ((number & string) | string)␊ - /**␊ - * Maximum size of the capture output.␊ - */␊ - totalBytesPerSession?: ((number & string) | string)␊ - /**␊ - * Maximum duration of the capture session in seconds.␊ - */␊ - timeLimitInSeconds?: ((number & string) | string)␊ - /**␊ - * The storage location for a packet capture session.␊ - */␊ - storageLocation: (PacketCaptureStorageLocation11 | string)␊ - /**␊ - * A list of packet capture filters.␊ - */␊ - filters?: (PacketCaptureFilter11[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The storage location for a packet capture session.␊ - */␊ - export interface PacketCaptureStorageLocation11 {␊ - /**␊ - * The ID of the storage account to save the packet capture session. Required if no local file path is provided.␊ - */␊ - storageId?: string␊ - /**␊ - * The URI of the storage path to save the packet capture. Must be a well-formed URI describing the location to save the packet capture.␊ - */␊ - storagePath?: string␊ - /**␊ - * A valid local path on the targeting VM. Must include the name of the capture file (*.cap). For linux virtual machine it must start with /var/captures. Required if no storage ID is provided, otherwise optional.␊ - */␊ - filePath?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Filter that is applied to packet capture request. Multiple filters can be applied.␊ - */␊ - export interface PacketCaptureFilter11 {␊ - /**␊ - * Protocol to be filtered on.␊ - */␊ - protocol?: (("TCP" | "UDP" | "Any") | string)␊ - /**␊ - * Local IP Address to be filtered on. Notation: "127.0.0.1" for single address entry. "127.0.0.1-127.0.0.255" for range. "127.0.0.1;127.0.0.5"? for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.␊ - */␊ - localIPAddress?: string␊ - /**␊ - * Local IP Address to be filtered on. Notation: "127.0.0.1" for single address entry. "127.0.0.1-127.0.0.255" for range. "127.0.0.1;127.0.0.5;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.␊ - */␊ - remoteIPAddress?: string␊ - /**␊ - * Local port to be filtered on. Notation: "80" for single port entry."80-85" for range. "80;443;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.␊ - */␊ - localPort?: string␊ - /**␊ - * Remote port to be filtered on. Notation: "80" for single port entry."80-85" for range. "80;443;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.␊ - */␊ - remotePort?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/connectionMonitors␊ - */␊ - export interface NetworkWatchersConnectionMonitors8 {␊ - name: string␊ - type: "Microsoft.Network/networkWatchers/connectionMonitors"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Connection monitor location.␊ - */␊ - location?: string␊ - /**␊ - * Connection monitor tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the connection monitor.␊ - */␊ - properties: (ConnectionMonitorParameters8 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/flowLogs␊ - */␊ - export interface NetworkWatchersFlowLogs3 {␊ - name: string␊ - type: "Microsoft.Network/networkWatchers/flowLogs"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the flow log.␊ - */␊ - properties: (FlowLogPropertiesFormat3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/packetCaptures␊ - */␊ - export interface NetworkWatchersPacketCaptures11 {␊ - name: string␊ - type: "Microsoft.Network/networkWatchers/packetCaptures"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Properties of the packet capture.␊ - */␊ - properties: (PacketCaptureParameters11 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/p2svpnGateways␊ - */␊ - export interface P2SvpnGateways8 {␊ - name: string␊ - type: "Microsoft.Network/p2svpnGateways"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the P2SVpnGateway.␊ - */␊ - properties: (P2SVpnGatewayProperties8 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for P2SVpnGateway.␊ - */␊ - export interface P2SVpnGatewayProperties8 {␊ - /**␊ - * The VirtualHub to which the gateway belongs.␊ - */␊ - virtualHub?: (SubResource34 | string)␊ - /**␊ - * List of all p2s connection configurations of the gateway.␊ - */␊ - p2SConnectionConfigurations?: (P2SConnectionConfiguration5[] | string)␊ - /**␊ - * The scale unit for this p2s vpn gateway.␊ - */␊ - vpnGatewayScaleUnit?: (number | string)␊ - /**␊ - * The VpnServerConfiguration to which the p2sVpnGateway is attached to.␊ - */␊ - vpnServerConfiguration?: (SubResource34 | string)␊ - /**␊ - * List of all customer specified DNS servers IP addresses.␊ - */␊ - customDnsServers?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * P2SConnectionConfiguration Resource.␊ - */␊ - export interface P2SConnectionConfiguration5 {␊ - /**␊ - * Properties of the P2S connection configuration.␊ - */␊ - properties?: (P2SConnectionConfigurationProperties5 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for P2SConnectionConfiguration.␊ - */␊ - export interface P2SConnectionConfigurationProperties5 {␊ - /**␊ - * The reference to the address space resource which represents Address space for P2S VpnClient.␊ - */␊ - vpnClientAddressPool?: (AddressSpace34 | string)␊ - /**␊ - * The Routing Configuration indicating the associated and propagated route tables on this connection.␊ - */␊ - routingConfiguration?: (RoutingConfiguration | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateEndpoints␊ - */␊ - export interface PrivateEndpoints8 {␊ - name: string␊ - type: "Microsoft.Network/privateEndpoints"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the private endpoint.␊ - */␊ - properties: (PrivateEndpointProperties8 | string)␊ - resources?: PrivateEndpointsPrivateDnsZoneGroupsChildResource1[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the private endpoint.␊ - */␊ - export interface PrivateEndpointProperties8 {␊ - /**␊ - * The ID of the subnet from which the private IP will be allocated.␊ - */␊ - subnet?: (SubResource34 | string)␊ - /**␊ - * A grouping of information about the connection to the remote resource.␊ - */␊ - privateLinkServiceConnections?: (PrivateLinkServiceConnection8[] | string)␊ - /**␊ - * A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource.␊ - */␊ - manualPrivateLinkServiceConnections?: (PrivateLinkServiceConnection8[] | string)␊ - /**␊ - * An array of custom dns configurations.␊ - */␊ - customDnsConfigs?: (CustomDnsConfigPropertiesFormat1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * PrivateLinkServiceConnection resource.␊ - */␊ - export interface PrivateLinkServiceConnection8 {␊ - /**␊ - * Properties of the private link service connection.␊ - */␊ - properties?: (PrivateLinkServiceConnectionProperties8 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the PrivateLinkServiceConnection.␊ - */␊ - export interface PrivateLinkServiceConnectionProperties8 {␊ - /**␊ - * The resource id of private link service.␊ - */␊ - privateLinkServiceId?: string␊ - /**␊ - * The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to.␊ - */␊ - groupIds?: (string[] | string)␊ - /**␊ - * A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars.␊ - */␊ - requestMessage?: string␊ - /**␊ - * A collection of read-only information about the state of the connection to the remote resource.␊ - */␊ - privateLinkServiceConnectionState?: (PrivateLinkServiceConnectionState14 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A collection of information about the state of the connection between service consumer and provider.␊ - */␊ - export interface PrivateLinkServiceConnectionState14 {␊ - /**␊ - * Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.␊ - */␊ - status?: string␊ - /**␊ - * The reason for approval/rejection of the connection.␊ - */␊ - description?: string␊ - /**␊ - * A message indicating if changes on the service provider require any updates on the consumer.␊ - */␊ - actionsRequired?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains custom Dns resolution configuration from customer.␊ - */␊ - export interface CustomDnsConfigPropertiesFormat1 {␊ - /**␊ - * Fqdn that resolves to private endpoint ip address.␊ - */␊ - fqdn?: string␊ - /**␊ - * A list of private ip addresses of the private endpoint.␊ - */␊ - ipAddresses?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateEndpoints/privateDnsZoneGroups␊ - */␊ - export interface PrivateEndpointsPrivateDnsZoneGroupsChildResource1 {␊ - name: string␊ - type: "privateDnsZoneGroups"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Properties of the private dns zone group.␊ - */␊ - properties: (PrivateDnsZoneGroupPropertiesFormat1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the private dns zone group.␊ - */␊ - export interface PrivateDnsZoneGroupPropertiesFormat1 {␊ - /**␊ - * A collection of private dns zone configurations of the private dns zone group.␊ - */␊ - privateDnsZoneConfigs?: (PrivateDnsZoneConfig1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * PrivateDnsZoneConfig resource.␊ - */␊ - export interface PrivateDnsZoneConfig1 {␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * Properties of the private dns zone configuration.␊ - */␊ - properties?: (PrivateDnsZonePropertiesFormat1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the private dns zone configuration resource.␊ - */␊ - export interface PrivateDnsZonePropertiesFormat1 {␊ - /**␊ - * The resource id of the private dns zone.␊ - */␊ - privateDnsZoneId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateEndpoints/privateDnsZoneGroups␊ - */␊ - export interface PrivateEndpointsPrivateDnsZoneGroups1 {␊ - name: string␊ - type: "Microsoft.Network/privateEndpoints/privateDnsZoneGroups"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Properties of the private dns zone group.␊ - */␊ - properties: (PrivateDnsZoneGroupPropertiesFormat1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateLinkServices␊ - */␊ - export interface PrivateLinkServices8 {␊ - name: string␊ - type: "Microsoft.Network/privateLinkServices"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the private link service.␊ - */␊ - properties: (PrivateLinkServiceProperties8 | string)␊ - resources?: PrivateLinkServicesPrivateEndpointConnectionsChildResource8[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the private link service.␊ - */␊ - export interface PrivateLinkServiceProperties8 {␊ - /**␊ - * An array of references to the load balancer IP configurations.␊ - */␊ - loadBalancerFrontendIpConfigurations?: (SubResource34[] | string)␊ - /**␊ - * An array of private link service IP configurations.␊ - */␊ - ipConfigurations?: (PrivateLinkServiceIpConfiguration8[] | string)␊ - /**␊ - * The visibility list of the private link service.␊ - */␊ - visibility?: (PrivateLinkServicePropertiesVisibility8 | string)␊ - /**␊ - * The auto-approval list of the private link service.␊ - */␊ - autoApproval?: (PrivateLinkServicePropertiesAutoApproval8 | string)␊ - /**␊ - * The list of Fqdn.␊ - */␊ - fqdns?: (string[] | string)␊ - /**␊ - * Whether the private link service is enabled for proxy protocol or not.␊ - */␊ - enableProxyProtocol?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The private link service ip configuration.␊ - */␊ - export interface PrivateLinkServiceIpConfiguration8 {␊ - /**␊ - * Properties of the private link service ip configuration.␊ - */␊ - properties?: (PrivateLinkServiceIpConfigurationProperties8 | string)␊ - /**␊ - * The name of private link service ip configuration.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of private link service IP configuration.␊ - */␊ - export interface PrivateLinkServiceIpConfigurationProperties8 {␊ - /**␊ - * The private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The private IP address allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * The reference to the subnet resource.␊ - */␊ - subnet?: (SubResource34 | string)␊ - /**␊ - * Whether the ip configuration is primary or not.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4.␊ - */␊ - privateIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The visibility list of the private link service.␊ - */␊ - export interface PrivateLinkServicePropertiesVisibility8 {␊ - /**␊ - * The list of subscriptions.␊ - */␊ - subscriptions?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The auto-approval list of the private link service.␊ - */␊ - export interface PrivateLinkServicePropertiesAutoApproval8 {␊ - /**␊ - * The list of subscriptions.␊ - */␊ - subscriptions?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateLinkServices/privateEndpointConnections␊ - */␊ - export interface PrivateLinkServicesPrivateEndpointConnectionsChildResource8 {␊ - name: string␊ - type: "privateEndpointConnections"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Properties of the private end point connection.␊ - */␊ - properties: (PrivateEndpointConnectionProperties15 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the PrivateEndpointConnectProperties.␊ - */␊ - export interface PrivateEndpointConnectionProperties15 {␊ - /**␊ - * A collection of information about the state of the connection between service consumer and provider.␊ - */␊ - privateLinkServiceConnectionState?: (PrivateLinkServiceConnectionState14 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateLinkServices/privateEndpointConnections␊ - */␊ - export interface PrivateLinkServicesPrivateEndpointConnections8 {␊ - name: string␊ - type: "Microsoft.Network/privateLinkServices/privateEndpointConnections"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Properties of the private end point connection.␊ - */␊ - properties: (PrivateEndpointConnectionProperties15 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/publicIPAddresses␊ - */␊ - export interface PublicIPAddresses34 {␊ - name: string␊ - type: "Microsoft.Network/publicIPAddresses"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The public IP address SKU.␊ - */␊ - sku?: (PublicIPAddressSku22 | string)␊ - /**␊ - * Public IP address properties.␊ - */␊ - properties: (PublicIPAddressPropertiesFormat25 | string)␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a public IP address.␊ - */␊ - export interface PublicIPAddressSku22 {␊ - /**␊ - * Name of a public IP address SKU.␊ - */␊ - name?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Public IP address properties.␊ - */␊ - export interface PublicIPAddressPropertiesFormat25 {␊ - /**␊ - * The public IP address allocation method.␊ - */␊ - publicIPAllocationMethod: (("Static" | "Dynamic") | string)␊ - /**␊ - * The public IP address version.␊ - */␊ - publicIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The FQDN of the DNS record associated with the public IP address.␊ - */␊ - dnsSettings?: (PublicIPAddressDnsSettings33 | string)␊ - /**␊ - * The DDoS protection custom policy associated with the public IP address.␊ - */␊ - ddosSettings?: (DdosSettings11 | string)␊ - /**␊ - * The list of tags associated with the public IP address.␊ - */␊ - ipTags?: (IpTag19[] | string)␊ - /**␊ - * The IP address associated with the public IP address resource.␊ - */␊ - ipAddress?: string␊ - /**␊ - * The Public IP Prefix this Public IP Address should be allocated from.␊ - */␊ - publicIPPrefix?: (SubResource34 | string)␊ - /**␊ - * The idle timeout of the public IP address.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains FQDN of the DNS record associated with the public IP address.␊ - */␊ - export interface PublicIPAddressDnsSettings33 {␊ - /**␊ - * The domain name label. The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.␊ - */␊ - domainNameLabel: string␊ - /**␊ - * The Fully Qualified Domain Name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone.␊ - */␊ - fqdn?: string␊ - /**␊ - * The reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN.␊ - */␊ - reverseFqdn?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains the DDoS protection settings of the public IP.␊ - */␊ - export interface DdosSettings11 {␊ - /**␊ - * The DDoS custom policy associated with the public IP.␊ - */␊ - ddosCustomPolicy?: (SubResource34 | string)␊ - /**␊ - * The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized.␊ - */␊ - protectionCoverage?: (("Basic" | "Standard") | string)␊ - /**␊ - * Enables DDoS protection on the public IP.␊ - */␊ - protectedIP?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains the IpTag associated with the object.␊ - */␊ - export interface IpTag19 {␊ - /**␊ - * The IP tag type. Example: FirstPartyUsage.␊ - */␊ - ipTagType?: string␊ - /**␊ - * The value of the IP tag associated with the public IP. Example: SQL.␊ - */␊ - tag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/publicIPPrefixes␊ - */␊ - export interface PublicIPPrefixes9 {␊ - name: string␊ - type: "Microsoft.Network/publicIPPrefixes"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The public IP prefix SKU.␊ - */␊ - sku?: (PublicIPPrefixSku9 | string)␊ - /**␊ - * Public IP prefix properties.␊ - */␊ - properties: (PublicIPPrefixPropertiesFormat9 | string)␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a public IP prefix.␊ - */␊ - export interface PublicIPPrefixSku9 {␊ - /**␊ - * Name of a public IP prefix SKU.␊ - */␊ - name?: ("Standard" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Public IP prefix properties.␊ - */␊ - export interface PublicIPPrefixPropertiesFormat9 {␊ - /**␊ - * The public IP address version.␊ - */␊ - publicIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The list of tags associated with the public IP prefix.␊ - */␊ - ipTags?: (IpTag19[] | string)␊ - /**␊ - * The Length of the Public IP Prefix.␊ - */␊ - prefixLength?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeFilters␊ - */␊ - export interface RouteFilters11 {␊ - name: string␊ - type: "Microsoft.Network/routeFilters"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the route filter.␊ - */␊ - properties: (RouteFilterPropertiesFormat11 | string)␊ - resources?: RouteFiltersRouteFilterRulesChildResource11[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Filter Resource.␊ - */␊ - export interface RouteFilterPropertiesFormat11 {␊ - /**␊ - * Collection of RouteFilterRules contained within a route filter.␊ - */␊ - rules?: (RouteFilterRule11[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Filter Rule Resource.␊ - */␊ - export interface RouteFilterRule11 {␊ - /**␊ - * Properties of the route filter rule.␊ - */␊ - properties?: (RouteFilterRulePropertiesFormat11 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Filter Rule Resource.␊ - */␊ - export interface RouteFilterRulePropertiesFormat11 {␊ - /**␊ - * The access type of the rule.␊ - */␊ - access: (("Allow" | "Deny") | string)␊ - /**␊ - * The rule type of the rule.␊ - */␊ - routeFilterRuleType: ("Community" | string)␊ - /**␊ - * The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'].␊ - */␊ - communities: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeFilters/routeFilterRules␊ - */␊ - export interface RouteFiltersRouteFilterRulesChildResource11 {␊ - name: string␊ - type: "routeFilterRules"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Properties of the route filter rule.␊ - */␊ - properties: (RouteFilterRulePropertiesFormat11 | string)␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeFilters/routeFilterRules␊ - */␊ - export interface RouteFiltersRouteFilterRules11 {␊ - name: string␊ - type: "Microsoft.Network/routeFilters/routeFilterRules"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Properties of the route filter rule.␊ - */␊ - properties: (RouteFilterRulePropertiesFormat11 | string)␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables␊ - */␊ - export interface RouteTables34 {␊ - name: string␊ - type: "Microsoft.Network/routeTables"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the route table.␊ - */␊ - properties: (RouteTablePropertiesFormat26 | string)␊ - resources?: RouteTablesRoutesChildResource26[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Table resource.␊ - */␊ - export interface RouteTablePropertiesFormat26 {␊ - /**␊ - * Collection of routes contained within a route table.␊ - */␊ - routes?: (Route26[] | string)␊ - /**␊ - * Whether to disable the routes learned by BGP on that route table. True means disable.␊ - */␊ - disableBgpRoutePropagation?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource.␊ - */␊ - export interface Route26 {␊ - /**␊ - * Properties of the route.␊ - */␊ - properties?: (RoutePropertiesFormat26 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource.␊ - */␊ - export interface RoutePropertiesFormat26 {␊ - /**␊ - * The destination CIDR to which the route applies.␊ - */␊ - addressPrefix: string␊ - /**␊ - * The type of Azure hop the packet should be sent to.␊ - */␊ - nextHopType: (("VirtualNetworkGateway" | "VnetLocal" | "Internet" | "VirtualAppliance" | "None") | string)␊ - /**␊ - * The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.␊ - */␊ - nextHopIpAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutesChildResource26 {␊ - name: string␊ - type: "routes"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Properties of the route.␊ - */␊ - properties: (RoutePropertiesFormat26 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutes26 {␊ - name: string␊ - type: "Microsoft.Network/routeTables/routes"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Properties of the route.␊ - */␊ - properties: (RoutePropertiesFormat26 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/securityPartnerProviders␊ - */␊ - export interface SecurityPartnerProviders1 {␊ - name: string␊ - type: "Microsoft.Network/securityPartnerProviders"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the Security Partner Provider.␊ - */␊ - properties: (SecurityPartnerProviderPropertiesFormat1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Security Partner Provider.␊ - */␊ - export interface SecurityPartnerProviderPropertiesFormat1 {␊ - /**␊ - * The security provider name.␊ - */␊ - securityProviderName?: (("ZScaler" | "IBoss" | "Checkpoint") | string)␊ - /**␊ - * The virtualHub to which the Security Partner Provider belongs.␊ - */␊ - virtualHub?: (SubResource34 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/serviceEndpointPolicies␊ - */␊ - export interface ServiceEndpointPolicies9 {␊ - name: string␊ - type: "Microsoft.Network/serviceEndpointPolicies"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the service end point policy.␊ - */␊ - properties: (ServiceEndpointPolicyPropertiesFormat9 | string)␊ - resources?: ServiceEndpointPoliciesServiceEndpointPolicyDefinitionsChildResource9[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Service Endpoint Policy resource.␊ - */␊ - export interface ServiceEndpointPolicyPropertiesFormat9 {␊ - /**␊ - * A collection of service endpoint policy definitions of the service endpoint policy.␊ - */␊ - serviceEndpointPolicyDefinitions?: (ServiceEndpointPolicyDefinition9[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Service Endpoint policy definitions.␊ - */␊ - export interface ServiceEndpointPolicyDefinition9 {␊ - /**␊ - * Properties of the service endpoint policy definition.␊ - */␊ - properties?: (ServiceEndpointPolicyDefinitionPropertiesFormat9 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Service Endpoint policy definition resource.␊ - */␊ - export interface ServiceEndpointPolicyDefinitionPropertiesFormat9 {␊ - /**␊ - * A description for this rule. Restricted to 140 chars.␊ - */␊ - description?: string␊ - /**␊ - * Service endpoint name.␊ - */␊ - service?: string␊ - /**␊ - * A list of service resources.␊ - */␊ - serviceResources?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions␊ - */␊ - export interface ServiceEndpointPoliciesServiceEndpointPolicyDefinitionsChildResource9 {␊ - name: string␊ - type: "serviceEndpointPolicyDefinitions"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Properties of the service endpoint policy definition.␊ - */␊ - properties: (ServiceEndpointPolicyDefinitionPropertiesFormat9 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions␊ - */␊ - export interface ServiceEndpointPoliciesServiceEndpointPolicyDefinitions9 {␊ - name: string␊ - type: "Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Properties of the service endpoint policy definition.␊ - */␊ - properties: (ServiceEndpointPolicyDefinitionPropertiesFormat9 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualHubs␊ - */␊ - export interface VirtualHubs11 {␊ - name: string␊ - type: "Microsoft.Network/virtualHubs"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual hub.␊ - */␊ - properties: (VirtualHubProperties11 | string)␊ - resources?: (VirtualHubsHubRouteTablesChildResource | VirtualHubsRouteTablesChildResource4)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VirtualHub.␊ - */␊ - export interface VirtualHubProperties11 {␊ - /**␊ - * The VirtualWAN to which the VirtualHub belongs.␊ - */␊ - virtualWan?: (SubResource34 | string)␊ - /**␊ - * The VpnGateway associated with this VirtualHub.␊ - */␊ - vpnGateway?: (SubResource34 | string)␊ - /**␊ - * The P2SVpnGateway associated with this VirtualHub.␊ - */␊ - p2SVpnGateway?: (SubResource34 | string)␊ - /**␊ - * The expressRouteGateway associated with this VirtualHub.␊ - */␊ - expressRouteGateway?: (SubResource34 | string)␊ - /**␊ - * The azureFirewall associated with this VirtualHub.␊ - */␊ - azureFirewall?: (SubResource34 | string)␊ - /**␊ - * The securityPartnerProvider associated with this VirtualHub.␊ - */␊ - securityPartnerProvider?: (SubResource34 | string)␊ - /**␊ - * List of all vnet connections with this VirtualHub.␊ - */␊ - virtualNetworkConnections?: (HubVirtualNetworkConnection11[] | string)␊ - /**␊ - * Address-prefix for this VirtualHub.␊ - */␊ - addressPrefix?: string␊ - /**␊ - * The routeTable associated with this virtual hub.␊ - */␊ - routeTable?: (VirtualHubRouteTable8 | string)␊ - /**␊ - * The Security Provider name.␊ - */␊ - securityProviderName?: string␊ - /**␊ - * List of all virtual hub route table v2s associated with this VirtualHub.␊ - */␊ - virtualHubRouteTableV2s?: (VirtualHubRouteTableV24[] | string)␊ - /**␊ - * The sku of this VirtualHub.␊ - */␊ - sku?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HubVirtualNetworkConnection Resource.␊ - */␊ - export interface HubVirtualNetworkConnection11 {␊ - /**␊ - * Properties of the hub virtual network connection.␊ - */␊ - properties?: (HubVirtualNetworkConnectionProperties11 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for HubVirtualNetworkConnection.␊ - */␊ - export interface HubVirtualNetworkConnectionProperties11 {␊ - /**␊ - * Reference to the remote virtual network.␊ - */␊ - remoteVirtualNetwork?: (SubResource34 | string)␊ - /**␊ - * VirtualHub to RemoteVnet transit to enabled or not.␊ - */␊ - allowHubToRemoteVnetTransit?: (boolean | string)␊ - /**␊ - * Allow RemoteVnet to use Virtual Hub's gateways.␊ - */␊ - allowRemoteVnetToUseHubVnetGateways?: (boolean | string)␊ - /**␊ - * Enable internet security.␊ - */␊ - enableInternetSecurity?: (boolean | string)␊ - /**␊ - * The Routing Configuration indicating the associated and propagated route tables on this connection.␊ - */␊ - routingConfiguration?: (RoutingConfiguration | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualHub route table.␊ - */␊ - export interface VirtualHubRouteTable8 {␊ - /**␊ - * List of all routes.␊ - */␊ - routes?: (VirtualHubRoute8[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualHub route.␊ - */␊ - export interface VirtualHubRoute8 {␊ - /**␊ - * List of all addressPrefixes.␊ - */␊ - addressPrefixes?: (string[] | string)␊ - /**␊ - * NextHop ip address.␊ - */␊ - nextHopIpAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualHubRouteTableV2 Resource.␊ - */␊ - export interface VirtualHubRouteTableV24 {␊ - /**␊ - * Properties of the virtual hub route table v2.␊ - */␊ - properties?: (VirtualHubRouteTableV2Properties4 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VirtualHubRouteTableV2.␊ - */␊ - export interface VirtualHubRouteTableV2Properties4 {␊ - /**␊ - * List of all routes.␊ - */␊ - routes?: (VirtualHubRouteV24[] | string)␊ - /**␊ - * List of all connections attached to this route table v2.␊ - */␊ - attachedConnections?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualHubRouteTableV2 route.␊ - */␊ - export interface VirtualHubRouteV24 {␊ - /**␊ - * The type of destinations.␊ - */␊ - destinationType?: string␊ - /**␊ - * List of all destinations.␊ - */␊ - destinations?: (string[] | string)␊ - /**␊ - * The type of next hops.␊ - */␊ - nextHopType?: string␊ - /**␊ - * NextHops ip address.␊ - */␊ - nextHops?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualHubs/hubRouteTables␊ - */␊ - export interface VirtualHubsHubRouteTablesChildResource {␊ - name: string␊ - type: "hubRouteTables"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Properties of the RouteTable resource.␊ - */␊ - properties: (HubRouteTableProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for RouteTable.␊ - */␊ - export interface HubRouteTableProperties {␊ - /**␊ - * List of all routes.␊ - */␊ - routes?: (HubRoute[] | string)␊ - /**␊ - * List of labels associated with this route table.␊ - */␊ - labels?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * RouteTable route.␊ - */␊ - export interface HubRoute {␊ - /**␊ - * The name of the Route that is unique within a RouteTable. This name can be used to access this route.␊ - */␊ - name: string␊ - /**␊ - * The type of destinations (eg: CIDR, ResourceId, Service).␊ - */␊ - destinationType: string␊ - /**␊ - * List of all destinations.␊ - */␊ - destinations: (string[] | string)␊ - /**␊ - * The type of next hop (eg: ResourceId).␊ - */␊ - nextHopType: string␊ - /**␊ - * NextHop resource ID.␊ - */␊ - nextHop: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualHubs/routeTables␊ - */␊ - export interface VirtualHubsRouteTablesChildResource4 {␊ - name: string␊ - type: "routeTables"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Properties of the virtual hub route table v2.␊ - */␊ - properties: (VirtualHubRouteTableV2Properties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualHubs/hubRouteTables␊ - */␊ - export interface VirtualHubsHubRouteTables {␊ - name: string␊ - type: "Microsoft.Network/virtualHubs/hubRouteTables"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Properties of the RouteTable resource.␊ - */␊ - properties: (HubRouteTableProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualHubs/routeTables␊ - */␊ - export interface VirtualHubsRouteTables4 {␊ - name: string␊ - type: "Microsoft.Network/virtualHubs/routeTables"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Properties of the virtual hub route table v2.␊ - */␊ - properties: (VirtualHubRouteTableV2Properties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworkGateways␊ - */␊ - export interface VirtualNetworkGateways26 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworkGateways"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway.␊ - */␊ - properties: (VirtualNetworkGatewayPropertiesFormat26 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGateway properties.␊ - */␊ - export interface VirtualNetworkGatewayPropertiesFormat26 {␊ - /**␊ - * IP configurations for virtual network gateway.␊ - */␊ - ipConfigurations?: (VirtualNetworkGatewayIPConfiguration25[] | string)␊ - /**␊ - * The type of this virtual network gateway.␊ - */␊ - gatewayType?: (("Vpn" | "ExpressRoute" | "HyperNet") | string)␊ - /**␊ - * The type of this virtual network gateway.␊ - */␊ - vpnType?: (("PolicyBased" | "RouteBased") | string)␊ - /**␊ - * The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN.␊ - */␊ - vpnGatewayGeneration?: (("None" | "Generation1" | "Generation2") | string)␊ - /**␊ - * Whether BGP is enabled for this virtual network gateway or not.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * Whether private IP needs to be enabled on this gateway for connections or not.␊ - */␊ - enablePrivateIpAddress?: (boolean | string)␊ - /**␊ - * ActiveActive flag.␊ - */␊ - activeActive?: (boolean | string)␊ - /**␊ - * The reference to the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting.␊ - */␊ - gatewayDefaultSite?: (SubResource34 | string)␊ - /**␊ - * The reference to the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.␊ - */␊ - sku?: (VirtualNetworkGatewaySku25 | string)␊ - /**␊ - * The reference to the VpnClientConfiguration resource which represents the P2S VpnClient configurations.␊ - */␊ - vpnClientConfiguration?: (VpnClientConfiguration25 | string)␊ - /**␊ - * Virtual network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings25 | string)␊ - /**␊ - * The reference to the address space resource which represents the custom routes address space specified by the customer for virtual network gateway and VpnClient.␊ - */␊ - customRoutes?: (AddressSpace34 | string)␊ - /**␊ - * Whether dns forwarding is enabled or not.␊ - */␊ - enableDnsForwarding?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration for virtual network gateway.␊ - */␊ - export interface VirtualNetworkGatewayIPConfiguration25 {␊ - /**␊ - * Properties of the virtual network gateway ip configuration.␊ - */␊ - properties?: (VirtualNetworkGatewayIPConfigurationPropertiesFormat25 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of VirtualNetworkGatewayIPConfiguration.␊ - */␊ - export interface VirtualNetworkGatewayIPConfigurationPropertiesFormat25 {␊ - /**␊ - * The private IP address allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * The reference to the subnet resource.␊ - */␊ - subnet?: (SubResource34 | string)␊ - /**␊ - * The reference to the public IP resource.␊ - */␊ - publicIPAddress?: (SubResource34 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewaySku details.␊ - */␊ - export interface VirtualNetworkGatewaySku25 {␊ - /**␊ - * Gateway SKU name.␊ - */␊ - name?: (("Basic" | "HighPerformance" | "Standard" | "UltraPerformance" | "VpnGw1" | "VpnGw2" | "VpnGw3" | "VpnGw4" | "VpnGw5" | "VpnGw1AZ" | "VpnGw2AZ" | "VpnGw3AZ" | "VpnGw4AZ" | "VpnGw5AZ" | "ErGw1AZ" | "ErGw2AZ" | "ErGw3AZ") | string)␊ - /**␊ - * Gateway SKU tier.␊ - */␊ - tier?: (("Basic" | "HighPerformance" | "Standard" | "UltraPerformance" | "VpnGw1" | "VpnGw2" | "VpnGw3" | "VpnGw4" | "VpnGw5" | "VpnGw1AZ" | "VpnGw2AZ" | "VpnGw3AZ" | "VpnGw4AZ" | "VpnGw5AZ" | "ErGw1AZ" | "ErGw2AZ" | "ErGw3AZ") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnClientConfiguration for P2S client.␊ - */␊ - export interface VpnClientConfiguration25 {␊ - /**␊ - * The reference to the address space resource which represents Address space for P2S VpnClient.␊ - */␊ - vpnClientAddressPool?: (AddressSpace34 | string)␊ - /**␊ - * VpnClientRootCertificate for virtual network gateway.␊ - */␊ - vpnClientRootCertificates?: (VpnClientRootCertificate25[] | string)␊ - /**␊ - * VpnClientRevokedCertificate for Virtual network gateway.␊ - */␊ - vpnClientRevokedCertificates?: (VpnClientRevokedCertificate25[] | string)␊ - /**␊ - * VpnClientProtocols for Virtual network gateway.␊ - */␊ - vpnClientProtocols?: (("IkeV2" | "SSTP" | "OpenVPN")[] | string)␊ - /**␊ - * VpnClientIpsecPolicies for virtual network gateway P2S client.␊ - */␊ - vpnClientIpsecPolicies?: (IpsecPolicy23[] | string)␊ - /**␊ - * The radius server address property of the VirtualNetworkGateway resource for vpn client connection.␊ - */␊ - radiusServerAddress?: string␊ - /**␊ - * The radius secret property of the VirtualNetworkGateway resource for vpn client connection.␊ - */␊ - radiusServerSecret?: string␊ - /**␊ - * The radiusServers property for multiple radius server configuration.␊ - */␊ - radiusServers?: (RadiusServer1[] | string)␊ - /**␊ - * The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication.␊ - */␊ - aadTenant?: string␊ - /**␊ - * The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication.␊ - */␊ - aadAudience?: string␊ - /**␊ - * The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication.␊ - */␊ - aadIssuer?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client root certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRootCertificate25 {␊ - /**␊ - * Properties of the vpn client root certificate.␊ - */␊ - properties: (VpnClientRootCertificatePropertiesFormat25 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of application gateway.␊ - */␊ - export interface VpnClientRootCertificatePropertiesFormat25 {␊ - /**␊ - * The certificate public data.␊ - */␊ - publicCertData: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client revoked certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRevokedCertificate25 {␊ - /**␊ - * Properties of the vpn client revoked certificate.␊ - */␊ - properties?: (VpnClientRevokedCertificatePropertiesFormat25 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the revoked VPN client certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRevokedCertificatePropertiesFormat25 {␊ - /**␊ - * The revoked VPN client certificate thumbprint.␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Radius Server Settings.␊ - */␊ - export interface RadiusServer1 {␊ - /**␊ - * The address of this radius server.␊ - */␊ - radiusServerAddress: string␊ - /**␊ - * The initial score assigned to this radius server.␊ - */␊ - radiusServerScore?: (number | string)␊ - /**␊ - * The secret used for this radius server.␊ - */␊ - radiusServerSecret?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks␊ - */␊ - export interface VirtualNetworks34 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network.␊ - */␊ - properties: (VirtualNetworkPropertiesFormat26 | string)␊ - resources?: (VirtualNetworksVirtualNetworkPeeringsChildResource23 | VirtualNetworksSubnetsChildResource26)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/virtualNetworkPeerings␊ - */␊ - export interface VirtualNetworksVirtualNetworkPeeringsChildResource23 {␊ - name: string␊ - type: "virtualNetworkPeerings"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties: (VirtualNetworkPeeringPropertiesFormat23 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnetsChildResource26 {␊ - name: string␊ - type: "subnets"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties: (SubnetPropertiesFormat26 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnets26 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks/subnets"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties: (SubnetPropertiesFormat26 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/virtualNetworkPeerings␊ - */␊ - export interface VirtualNetworksVirtualNetworkPeerings23 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks/virtualNetworkPeerings"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties: (VirtualNetworkPeeringPropertiesFormat23 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworkTaps␊ - */␊ - export interface VirtualNetworkTaps8 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworkTaps"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Virtual Network Tap Properties.␊ - */␊ - properties: (VirtualNetworkTapPropertiesFormat8 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Virtual Network Tap properties.␊ - */␊ - export interface VirtualNetworkTapPropertiesFormat8 {␊ - /**␊ - * The reference to the private IP Address of the collector nic that will receive the tap.␊ - */␊ - destinationNetworkInterfaceIPConfiguration?: (SubResource34 | string)␊ - /**␊ - * The reference to the private IP address on the internal Load Balancer that will receive the tap.␊ - */␊ - destinationLoadBalancerFrontEndIPConfiguration?: (SubResource34 | string)␊ - /**␊ - * The VXLAN destination port that will receive the tapped traffic.␊ - */␊ - destinationPort?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualRouters␊ - */␊ - export interface VirtualRouters6 {␊ - name: string␊ - type: "Microsoft.Network/virtualRouters"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the Virtual Router.␊ - */␊ - properties: (VirtualRouterPropertiesFormat6 | string)␊ - resources?: VirtualRoutersPeeringsChildResource6[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Virtual Router definition.␊ - */␊ - export interface VirtualRouterPropertiesFormat6 {␊ - /**␊ - * VirtualRouter ASN.␊ - */␊ - virtualRouterAsn?: (number | string)␊ - /**␊ - * VirtualRouter IPs.␊ - */␊ - virtualRouterIps?: (string[] | string)␊ - /**␊ - * The Subnet on which VirtualRouter is hosted.␊ - */␊ - hostedSubnet?: (SubResource34 | string)␊ - /**␊ - * The Gateway on which VirtualRouter is hosted.␊ - */␊ - hostedGateway?: (SubResource34 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualRouters/peerings␊ - */␊ - export interface VirtualRoutersPeeringsChildResource6 {␊ - name: string␊ - type: "peerings"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * The properties of the Virtual Router Peering.␊ - */␊ - properties: (VirtualRouterPeeringProperties6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the rule group.␊ - */␊ - export interface VirtualRouterPeeringProperties6 {␊ - /**␊ - * Peer ASN.␊ - */␊ - peerAsn?: (number | string)␊ - /**␊ - * Peer IP.␊ - */␊ - peerIp?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualRouters/peerings␊ - */␊ - export interface VirtualRoutersPeerings6 {␊ - name: string␊ - type: "Microsoft.Network/virtualRouters/peerings"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * The properties of the Virtual Router Peering.␊ - */␊ - properties: (VirtualRouterPeeringProperties6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualWans␊ - */␊ - export interface VirtualWans11 {␊ - name: string␊ - type: "Microsoft.Network/virtualWans"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual WAN.␊ - */␊ - properties: (VirtualWanProperties11 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VirtualWAN.␊ - */␊ - export interface VirtualWanProperties11 {␊ - /**␊ - * Vpn encryption to be disabled or not.␊ - */␊ - disableVpnEncryption?: (boolean | string)␊ - /**␊ - * True if branch to branch traffic is allowed.␊ - */␊ - allowBranchToBranchTraffic?: (boolean | string)␊ - /**␊ - * True if Vnet to Vnet traffic is allowed.␊ - */␊ - allowVnetToVnetTraffic?: (boolean | string)␊ - /**␊ - * The office local breakout category.␊ - */␊ - office365LocalBreakoutCategory?: (("Optimize" | "OptimizeAndAllow" | "All" | "None") | string)␊ - /**␊ - * The type of the VirtualWAN.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnGateways␊ - */␊ - export interface VpnGateways11 {␊ - name: string␊ - type: "Microsoft.Network/vpnGateways"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the VPN gateway.␊ - */␊ - properties: (VpnGatewayProperties11 | string)␊ - resources?: VpnGatewaysVpnConnectionsChildResource11[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnGateway.␊ - */␊ - export interface VpnGatewayProperties11 {␊ - /**␊ - * The VirtualHub to which the gateway belongs.␊ - */␊ - virtualHub?: (SubResource34 | string)␊ - /**␊ - * List of all vpn connections to the gateway.␊ - */␊ - connections?: (VpnConnection11[] | string)␊ - /**␊ - * Local network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings25 | string)␊ - /**␊ - * The scale unit for this vpn gateway.␊ - */␊ - vpnGatewayScaleUnit?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnConnection Resource.␊ - */␊ - export interface VpnConnection11 {␊ - /**␊ - * Properties of the VPN connection.␊ - */␊ - properties?: (VpnConnectionProperties11 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnConnection.␊ - */␊ - export interface VpnConnectionProperties11 {␊ - /**␊ - * Id of the connected vpn site.␊ - */␊ - remoteVpnSite?: (SubResource34 | string)␊ - /**␊ - * Routing weight for vpn connection.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * The dead peer detection timeout for a vpn connection in seconds.␊ - */␊ - dpdTimeoutSeconds?: (number | string)␊ - /**␊ - * The connection status.␊ - */␊ - connectionStatus?: (("Unknown" | "Connecting" | "Connected" | "NotConnected") | string)␊ - /**␊ - * Connection protocol used for this connection.␊ - */␊ - vpnConnectionProtocolType?: (("IKEv2" | "IKEv1") | string)␊ - /**␊ - * Expected bandwidth in MBPS.␊ - */␊ - connectionBandwidth?: (number | string)␊ - /**␊ - * SharedKey for the vpn connection.␊ - */␊ - sharedKey?: string␊ - /**␊ - * EnableBgp flag.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * Enable policy-based traffic selectors.␊ - */␊ - usePolicyBasedTrafficSelectors?: (boolean | string)␊ - /**␊ - * The IPSec Policies to be considered by this connection.␊ - */␊ - ipsecPolicies?: (IpsecPolicy23[] | string)␊ - /**␊ - * EnableBgp flag.␊ - */␊ - enableRateLimiting?: (boolean | string)␊ - /**␊ - * Enable internet security.␊ - */␊ - enableInternetSecurity?: (boolean | string)␊ - /**␊ - * Use local azure ip to initiate connection.␊ - */␊ - useLocalAzureIpAddress?: (boolean | string)␊ - /**␊ - * List of all vpn site link connections to the gateway.␊ - */␊ - vpnLinkConnections?: (VpnSiteLinkConnection7[] | string)␊ - /**␊ - * The Routing Configuration indicating the associated and propagated route tables on this connection.␊ - */␊ - routingConfiguration?: (RoutingConfiguration | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnSiteLinkConnection Resource.␊ - */␊ - export interface VpnSiteLinkConnection7 {␊ - /**␊ - * Properties of the VPN site link connection.␊ - */␊ - properties?: (VpnSiteLinkConnectionProperties7 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnConnection.␊ - */␊ - export interface VpnSiteLinkConnectionProperties7 {␊ - /**␊ - * Id of the connected vpn site link.␊ - */␊ - vpnSiteLink?: (SubResource34 | string)␊ - /**␊ - * Routing weight for vpn connection.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * The connection status.␊ - */␊ - connectionStatus?: (("Unknown" | "Connecting" | "Connected" | "NotConnected") | string)␊ - /**␊ - * Connection protocol used for this connection.␊ - */␊ - vpnConnectionProtocolType?: (("IKEv2" | "IKEv1") | string)␊ - /**␊ - * Expected bandwidth in MBPS.␊ - */␊ - connectionBandwidth?: (number | string)␊ - /**␊ - * SharedKey for the vpn connection.␊ - */␊ - sharedKey?: string␊ - /**␊ - * EnableBgp flag.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * Enable policy-based traffic selectors.␊ - */␊ - usePolicyBasedTrafficSelectors?: (boolean | string)␊ - /**␊ - * The IPSec Policies to be considered by this connection.␊ - */␊ - ipsecPolicies?: (IpsecPolicy23[] | string)␊ - /**␊ - * EnableBgp flag.␊ - */␊ - enableRateLimiting?: (boolean | string)␊ - /**␊ - * Use local azure ip to initiate connection.␊ - */␊ - useLocalAzureIpAddress?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnGateways/vpnConnections␊ - */␊ - export interface VpnGatewaysVpnConnectionsChildResource11 {␊ - name: string␊ - type: "vpnConnections"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Properties of the VPN connection.␊ - */␊ - properties: (VpnConnectionProperties11 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnGateways/vpnConnections␊ - */␊ - export interface VpnGatewaysVpnConnections11 {␊ - name: string␊ - type: "Microsoft.Network/vpnGateways/vpnConnections"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Properties of the VPN connection.␊ - */␊ - properties: (VpnConnectionProperties11 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnServerConfigurations␊ - */␊ - export interface VpnServerConfigurations5 {␊ - name: string␊ - type: "Microsoft.Network/vpnServerConfigurations"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the P2SVpnServer configuration.␊ - */␊ - properties: (VpnServerConfigurationProperties5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnServerConfiguration.␊ - */␊ - export interface VpnServerConfigurationProperties5 {␊ - /**␊ - * The name of the VpnServerConfiguration that is unique within a resource group.␊ - */␊ - name?: string␊ - /**␊ - * VPN protocols for the VpnServerConfiguration.␊ - */␊ - vpnProtocols?: (("IkeV2" | "OpenVPN")[] | string)␊ - /**␊ - * VPN authentication types for the VpnServerConfiguration.␊ - */␊ - vpnAuthenticationTypes?: (("Certificate" | "Radius" | "AAD")[] | string)␊ - /**␊ - * VPN client root certificate of VpnServerConfiguration.␊ - */␊ - vpnClientRootCertificates?: (VpnServerConfigVpnClientRootCertificate5[] | string)␊ - /**␊ - * VPN client revoked certificate of VpnServerConfiguration.␊ - */␊ - vpnClientRevokedCertificates?: (VpnServerConfigVpnClientRevokedCertificate5[] | string)␊ - /**␊ - * Radius Server root certificate of VpnServerConfiguration.␊ - */␊ - radiusServerRootCertificates?: (VpnServerConfigRadiusServerRootCertificate5[] | string)␊ - /**␊ - * Radius client root certificate of VpnServerConfiguration.␊ - */␊ - radiusClientRootCertificates?: (VpnServerConfigRadiusClientRootCertificate5[] | string)␊ - /**␊ - * VpnClientIpsecPolicies for VpnServerConfiguration.␊ - */␊ - vpnClientIpsecPolicies?: (IpsecPolicy23[] | string)␊ - /**␊ - * The radius server address property of the VpnServerConfiguration resource for point to site client connection.␊ - */␊ - radiusServerAddress?: string␊ - /**␊ - * The radius secret property of the VpnServerConfiguration resource for point to site client connection.␊ - */␊ - radiusServerSecret?: string␊ - /**␊ - * Multiple Radius Server configuration for VpnServerConfiguration.␊ - */␊ - radiusServers?: (RadiusServer1[] | string)␊ - /**␊ - * The set of aad vpn authentication parameters.␊ - */␊ - aadAuthenticationParameters?: (AadAuthenticationParameters5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of VPN client root certificate of VpnServerConfiguration.␊ - */␊ - export interface VpnServerConfigVpnClientRootCertificate5 {␊ - /**␊ - * The certificate name.␊ - */␊ - name?: string␊ - /**␊ - * The certificate public data.␊ - */␊ - publicCertData?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the revoked VPN client certificate of VpnServerConfiguration.␊ - */␊ - export interface VpnServerConfigVpnClientRevokedCertificate5 {␊ - /**␊ - * The certificate name.␊ - */␊ - name?: string␊ - /**␊ - * The revoked VPN client certificate thumbprint.␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Radius Server root certificate of VpnServerConfiguration.␊ - */␊ - export interface VpnServerConfigRadiusServerRootCertificate5 {␊ - /**␊ - * The certificate name.␊ - */␊ - name?: string␊ - /**␊ - * The certificate public data.␊ - */␊ - publicCertData?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Radius client root certificate of VpnServerConfiguration.␊ - */␊ - export interface VpnServerConfigRadiusClientRootCertificate5 {␊ - /**␊ - * The certificate name.␊ - */␊ - name?: string␊ - /**␊ - * The Radius client root certificate thumbprint.␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AAD Vpn authentication type related parameters.␊ - */␊ - export interface AadAuthenticationParameters5 {␊ - /**␊ - * AAD Vpn authentication parameter AAD tenant.␊ - */␊ - aadTenant?: string␊ - /**␊ - * AAD Vpn authentication parameter AAD audience.␊ - */␊ - aadAudience?: string␊ - /**␊ - * AAD Vpn authentication parameter AAD issuer.␊ - */␊ - aadIssuer?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnSites␊ - */␊ - export interface VpnSites11 {␊ - name: string␊ - type: "Microsoft.Network/vpnSites"␊ - apiVersion: "2020-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the VPN site.␊ - */␊ - properties: (VpnSiteProperties11 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnSite.␊ - */␊ - export interface VpnSiteProperties11 {␊ - /**␊ - * The VirtualWAN to which the vpnSite belongs.␊ - */␊ - virtualWan?: (SubResource34 | string)␊ - /**␊ - * The device properties.␊ - */␊ - deviceProperties?: (DeviceProperties11 | string)␊ - /**␊ - * The ip-address for the vpn-site.␊ - */␊ - ipAddress?: string␊ - /**␊ - * The key for vpn-site that can be used for connections.␊ - */␊ - siteKey?: string␊ - /**␊ - * The AddressSpace that contains an array of IP address ranges.␊ - */␊ - addressSpace?: (AddressSpace34 | string)␊ - /**␊ - * The set of bgp properties.␊ - */␊ - bgpProperties?: (BgpSettings25 | string)␊ - /**␊ - * IsSecuritySite flag.␊ - */␊ - isSecuritySite?: (boolean | string)␊ - /**␊ - * List of all vpn site links.␊ - */␊ - vpnSiteLinks?: (VpnSiteLink7[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * List of properties of the device.␊ - */␊ - export interface DeviceProperties11 {␊ - /**␊ - * Name of the device Vendor.␊ - */␊ - deviceVendor?: string␊ - /**␊ - * Model of the device.␊ - */␊ - deviceModel?: string␊ - /**␊ - * Link speed.␊ - */␊ - linkSpeedInMbps?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnSiteLink Resource.␊ - */␊ - export interface VpnSiteLink7 {␊ - /**␊ - * Properties of the VPN site link.␊ - */␊ - properties?: (VpnSiteLinkProperties7 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnSite.␊ - */␊ - export interface VpnSiteLinkProperties7 {␊ - /**␊ - * The link provider properties.␊ - */␊ - linkProperties?: (VpnLinkProviderProperties7 | string)␊ - /**␊ - * The ip-address for the vpn-site-link.␊ - */␊ - ipAddress?: string␊ - /**␊ - * FQDN of vpn-site-link.␊ - */␊ - fqdn?: string␊ - /**␊ - * The set of bgp properties.␊ - */␊ - bgpProperties?: (VpnLinkBgpSettings7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * List of properties of a link provider.␊ - */␊ - export interface VpnLinkProviderProperties7 {␊ - /**␊ - * Name of the link provider.␊ - */␊ - linkProviderName?: string␊ - /**␊ - * Link speed.␊ - */␊ - linkSpeedInMbps?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * BGP settings details for a link.␊ - */␊ - export interface VpnLinkBgpSettings7 {␊ - /**␊ - * The BGP speaker's ASN.␊ - */␊ - asn?: (number | string)␊ - /**␊ - * The BGP peering address and BGP identifier of this BGP speaker.␊ - */␊ - bgpPeeringAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/applicationGateways␊ - */␊ - export interface ApplicationGateways27 {␊ - name: string␊ - type: "Microsoft.Network/applicationGateways"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the application gateway.␊ - */␊ - properties: (ApplicationGatewayPropertiesFormat27 | string)␊ - /**␊ - * A list of availability zones denoting where the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - /**␊ - * The identity of the application gateway, if configured.␊ - */␊ - identity?: (ManagedServiceIdentity13 | string)␊ - resources?: ApplicationGatewaysPrivateEndpointConnectionsChildResource[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application gateway.␊ - */␊ - export interface ApplicationGatewayPropertiesFormat27 {␊ - /**␊ - * SKU of the application gateway resource.␊ - */␊ - sku?: (ApplicationGatewaySku27 | string)␊ - /**␊ - * SSL policy of the application gateway resource.␊ - */␊ - sslPolicy?: (ApplicationGatewaySslPolicy24 | string)␊ - /**␊ - * Subnets of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - gatewayIPConfigurations?: (ApplicationGatewayIPConfiguration27[] | string)␊ - /**␊ - * Authentication certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - authenticationCertificates?: (ApplicationGatewayAuthenticationCertificate24[] | string)␊ - /**␊ - * Trusted Root certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - trustedRootCertificates?: (ApplicationGatewayTrustedRootCertificate14[] | string)␊ - /**␊ - * SSL certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - sslCertificates?: (ApplicationGatewaySslCertificate27[] | string)␊ - /**␊ - * Frontend IP addresses of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - frontendIPConfigurations?: (ApplicationGatewayFrontendIPConfiguration27[] | string)␊ - /**␊ - * Frontend ports of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - frontendPorts?: (ApplicationGatewayFrontendPort27[] | string)␊ - /**␊ - * Probes of the application gateway resource.␊ - */␊ - probes?: (ApplicationGatewayProbe26[] | string)␊ - /**␊ - * Backend address pool of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - backendAddressPools?: (ApplicationGatewayBackendAddressPool27[] | string)␊ - /**␊ - * Backend http settings of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - backendHttpSettingsCollection?: (ApplicationGatewayBackendHttpSettings27[] | string)␊ - /**␊ - * Http listeners of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - httpListeners?: (ApplicationGatewayHttpListener27[] | string)␊ - /**␊ - * URL path map of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - urlPathMaps?: (ApplicationGatewayUrlPathMap26[] | string)␊ - /**␊ - * Request routing rules of the application gateway resource.␊ - */␊ - requestRoutingRules?: (ApplicationGatewayRequestRoutingRule27[] | string)␊ - /**␊ - * Rewrite rules for the application gateway resource.␊ - */␊ - rewriteRuleSets?: (ApplicationGatewayRewriteRuleSet13[] | string)␊ - /**␊ - * Redirect configurations of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).␊ - */␊ - redirectConfigurations?: (ApplicationGatewayRedirectConfiguration24[] | string)␊ - /**␊ - * Web application firewall configuration.␊ - */␊ - webApplicationFirewallConfiguration?: (ApplicationGatewayWebApplicationFirewallConfiguration24 | string)␊ - /**␊ - * Reference to the FirewallPolicy resource.␊ - */␊ - firewallPolicy?: (SubResource35 | string)␊ - /**␊ - * Whether HTTP2 is enabled on the application gateway resource.␊ - */␊ - enableHttp2?: (boolean | string)␊ - /**␊ - * Whether FIPS is enabled on the application gateway resource.␊ - */␊ - enableFips?: (boolean | string)␊ - /**␊ - * Autoscale Configuration.␊ - */␊ - autoscaleConfiguration?: (ApplicationGatewayAutoscaleConfiguration17 | string)␊ - /**␊ - * PrivateLink configurations on application gateway.␊ - */␊ - privateLinkConfigurations?: (ApplicationGatewayPrivateLinkConfiguration[] | string)␊ - /**␊ - * Custom error configurations of the application gateway resource.␊ - */␊ - customErrorConfigurations?: (ApplicationGatewayCustomError14[] | string)␊ - /**␊ - * If true, associates a firewall policy with an application gateway regardless whether the policy differs from the WAF Config.␊ - */␊ - forceFirewallPolicyAssociation?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of an application gateway.␊ - */␊ - export interface ApplicationGatewaySku27 {␊ - /**␊ - * Name of an application gateway SKU.␊ - */␊ - name?: (("Standard_Small" | "Standard_Medium" | "Standard_Large" | "WAF_Medium" | "WAF_Large" | "Standard_v2" | "WAF_v2") | string)␊ - /**␊ - * Tier of an application gateway.␊ - */␊ - tier?: (("Standard" | "WAF" | "Standard_v2" | "WAF_v2") | string)␊ - /**␊ - * Capacity (instance count) of an application gateway.␊ - */␊ - capacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application Gateway Ssl policy.␊ - */␊ - export interface ApplicationGatewaySslPolicy24 {␊ - /**␊ - * Ssl protocols to be disabled on application gateway.␊ - */␊ - disabledSslProtocols?: (("TLSv1_0" | "TLSv1_1" | "TLSv1_2")[] | string)␊ - /**␊ - * Type of Ssl Policy.␊ - */␊ - policyType?: (("Predefined" | "Custom") | string)␊ - /**␊ - * Name of Ssl predefined policy.␊ - */␊ - policyName?: (("AppGwSslPolicy20150501" | "AppGwSslPolicy20170401" | "AppGwSslPolicy20170401S") | string)␊ - /**␊ - * Ssl cipher suites to be enabled in the specified order to application gateway.␊ - */␊ - cipherSuites?: (("TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384" | "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256" | "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA" | "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA" | "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384" | "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256" | "TLS_DHE_RSA_WITH_AES_256_CBC_SHA" | "TLS_DHE_RSA_WITH_AES_128_CBC_SHA" | "TLS_RSA_WITH_AES_256_GCM_SHA384" | "TLS_RSA_WITH_AES_128_GCM_SHA256" | "TLS_RSA_WITH_AES_256_CBC_SHA256" | "TLS_RSA_WITH_AES_128_CBC_SHA256" | "TLS_RSA_WITH_AES_256_CBC_SHA" | "TLS_RSA_WITH_AES_128_CBC_SHA" | "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384" | "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256" | "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384" | "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256" | "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA" | "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA" | "TLS_DHE_DSS_WITH_AES_256_CBC_SHA256" | "TLS_DHE_DSS_WITH_AES_128_CBC_SHA256" | "TLS_DHE_DSS_WITH_AES_256_CBC_SHA" | "TLS_DHE_DSS_WITH_AES_128_CBC_SHA" | "TLS_RSA_WITH_3DES_EDE_CBC_SHA" | "TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA" | "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256" | "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384")[] | string)␊ - /**␊ - * Minimum version of Ssl protocol to be supported on application gateway.␊ - */␊ - minProtocolVersion?: (("TLSv1_0" | "TLSv1_1" | "TLSv1_2") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed.␊ - */␊ - export interface ApplicationGatewayIPConfiguration27 {␊ - /**␊ - * Properties of the application gateway IP configuration.␊ - */␊ - properties?: (ApplicationGatewayIPConfigurationPropertiesFormat27 | string)␊ - /**␊ - * Name of the IP configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayIPConfigurationPropertiesFormat27 {␊ - /**␊ - * Reference to the subnet resource. A subnet from where application gateway gets its private address.␊ - */␊ - subnet?: (SubResource35 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Reference to another subresource.␊ - */␊ - export interface SubResource35 {␊ - /**␊ - * Resource ID.␊ - */␊ - id: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authentication certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewayAuthenticationCertificate24 {␊ - /**␊ - * Properties of the application gateway authentication certificate.␊ - */␊ - properties?: (ApplicationGatewayAuthenticationCertificatePropertiesFormat24 | string)␊ - /**␊ - * Name of the authentication certificate that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authentication certificates properties of an application gateway.␊ - */␊ - export interface ApplicationGatewayAuthenticationCertificatePropertiesFormat24 {␊ - /**␊ - * Certificate public data.␊ - */␊ - data?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trusted Root certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewayTrustedRootCertificate14 {␊ - /**␊ - * Properties of the application gateway trusted root certificate.␊ - */␊ - properties?: (ApplicationGatewayTrustedRootCertificatePropertiesFormat14 | string)␊ - /**␊ - * Name of the trusted root certificate that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trusted Root certificates properties of an application gateway.␊ - */␊ - export interface ApplicationGatewayTrustedRootCertificatePropertiesFormat14 {␊ - /**␊ - * Certificate public data.␊ - */␊ - data?: string␊ - /**␊ - * Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault.␊ - */␊ - keyVaultSecretId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSL certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewaySslCertificate27 {␊ - /**␊ - * Properties of the application gateway SSL certificate.␊ - */␊ - properties?: (ApplicationGatewaySslCertificatePropertiesFormat27 | string)␊ - /**␊ - * Name of the SSL certificate that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of an application gateway.␊ - */␊ - export interface ApplicationGatewaySslCertificatePropertiesFormat27 {␊ - /**␊ - * Base-64 encoded pfx certificate. Only applicable in PUT Request.␊ - */␊ - data?: string␊ - /**␊ - * Password for the pfx file specified in data. Only applicable in PUT request.␊ - */␊ - password?: string␊ - /**␊ - * Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault.␊ - */␊ - keyVaultSecretId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendIPConfiguration27 {␊ - /**␊ - * Properties of the application gateway frontend IP configuration.␊ - */␊ - properties?: (ApplicationGatewayFrontendIPConfigurationPropertiesFormat27 | string)␊ - /**␊ - * Name of the frontend IP configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendIPConfigurationPropertiesFormat27 {␊ - /**␊ - * PrivateIPAddress of the network interface IP Configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The private IP address allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Reference to the subnet resource.␊ - */␊ - subnet?: (SubResource35 | string)␊ - /**␊ - * Reference to the PublicIP resource.␊ - */␊ - publicIPAddress?: (SubResource35 | string)␊ - /**␊ - * Reference to the application gateway private link configuration.␊ - */␊ - privateLinkConfiguration?: (SubResource35 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend port of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendPort27 {␊ - /**␊ - * Properties of the application gateway frontend port.␊ - */␊ - properties?: (ApplicationGatewayFrontendPortPropertiesFormat27 | string)␊ - /**␊ - * Name of the frontend port that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend port of an application gateway.␊ - */␊ - export interface ApplicationGatewayFrontendPortPropertiesFormat27 {␊ - /**␊ - * Frontend port.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Probe of the application gateway.␊ - */␊ - export interface ApplicationGatewayProbe26 {␊ - /**␊ - * Properties of the application gateway probe.␊ - */␊ - properties?: (ApplicationGatewayProbePropertiesFormat26 | string)␊ - /**␊ - * Name of the probe that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of probe of an application gateway.␊ - */␊ - export interface ApplicationGatewayProbePropertiesFormat26 {␊ - /**␊ - * The protocol used for the probe.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Host name to send the probe to.␊ - */␊ - host?: string␊ - /**␊ - * Relative path of probe. Valid path starts from '/'. Probe is sent to ://:.␊ - */␊ - path?: string␊ - /**␊ - * The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - interval?: (number | string)␊ - /**␊ - * The probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - timeout?: (number | string)␊ - /**␊ - * The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20.␊ - */␊ - unhealthyThreshold?: (number | string)␊ - /**␊ - * Whether the host header should be picked from the backend http settings. Default value is false.␊ - */␊ - pickHostNameFromBackendHttpSettings?: (boolean | string)␊ - /**␊ - * Minimum number of servers that are always marked healthy. Default value is 0.␊ - */␊ - minServers?: (number | string)␊ - /**␊ - * Criterion for classifying a healthy probe response.␊ - */␊ - match?: (ApplicationGatewayProbeHealthResponseMatch24 | string)␊ - /**␊ - * Custom port which will be used for probing the backend servers. The valid value ranges from 1 to 65535. In case not set, port from http settings will be used. This property is valid for Standard_v2 and WAF_v2 only.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application gateway probe health response match.␊ - */␊ - export interface ApplicationGatewayProbeHealthResponseMatch24 {␊ - /**␊ - * Body that must be contained in the health response. Default value is empty.␊ - */␊ - body?: string␊ - /**␊ - * Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399.␊ - */␊ - statusCodes?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend Address Pool of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddressPool27 {␊ - /**␊ - * Properties of the application gateway backend address pool.␊ - */␊ - properties?: (ApplicationGatewayBackendAddressPoolPropertiesFormat27 | string)␊ - /**␊ - * Name of the backend address pool that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend Address Pool of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddressPoolPropertiesFormat27 {␊ - /**␊ - * Backend addresses.␊ - */␊ - backendAddresses?: (ApplicationGatewayBackendAddress27[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendAddress27 {␊ - /**␊ - * Fully qualified domain name (FQDN).␊ - */␊ - fqdn?: string␊ - /**␊ - * IP address.␊ - */␊ - ipAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Backend address pool settings of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendHttpSettings27 {␊ - /**␊ - * Properties of the application gateway backend HTTP settings.␊ - */␊ - properties?: (ApplicationGatewayBackendHttpSettingsPropertiesFormat27 | string)␊ - /**␊ - * Name of the backend http settings that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Backend address pool settings of an application gateway.␊ - */␊ - export interface ApplicationGatewayBackendHttpSettingsPropertiesFormat27 {␊ - /**␊ - * The destination port on the backend.␊ - */␊ - port?: (number | string)␊ - /**␊ - * The protocol used to communicate with the backend.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Cookie based affinity.␊ - */␊ - cookieBasedAffinity?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Request timeout in seconds. Application Gateway will fail the request if response is not received within RequestTimeout. Acceptable values are from 1 second to 86400 seconds.␊ - */␊ - requestTimeout?: (number | string)␊ - /**␊ - * Probe resource of an application gateway.␊ - */␊ - probe?: (SubResource35 | string)␊ - /**␊ - * Array of references to application gateway authentication certificates.␊ - */␊ - authenticationCertificates?: (SubResource35[] | string)␊ - /**␊ - * Array of references to application gateway trusted root certificates.␊ - */␊ - trustedRootCertificates?: (SubResource35[] | string)␊ - /**␊ - * Connection draining of the backend http settings resource.␊ - */␊ - connectionDraining?: (ApplicationGatewayConnectionDraining24 | string)␊ - /**␊ - * Host header to be sent to the backend servers.␊ - */␊ - hostName?: string␊ - /**␊ - * Whether to pick host header should be picked from the host name of the backend server. Default value is false.␊ - */␊ - pickHostNameFromBackendAddress?: (boolean | string)␊ - /**␊ - * Cookie name to use for the affinity cookie.␊ - */␊ - affinityCookieName?: string␊ - /**␊ - * Whether the probe is enabled. Default value is false.␊ - */␊ - probeEnabled?: (boolean | string)␊ - /**␊ - * Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null.␊ - */␊ - path?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Connection draining allows open connections to a backend server to be active for a specified time after the backend server got removed from the configuration.␊ - */␊ - export interface ApplicationGatewayConnectionDraining24 {␊ - /**␊ - * Whether connection draining is enabled or not.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds.␊ - */␊ - drainTimeoutInSec: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http listener of an application gateway.␊ - */␊ - export interface ApplicationGatewayHttpListener27 {␊ - /**␊ - * Properties of the application gateway HTTP listener.␊ - */␊ - properties?: (ApplicationGatewayHttpListenerPropertiesFormat27 | string)␊ - /**␊ - * Name of the HTTP listener that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of HTTP listener of an application gateway.␊ - */␊ - export interface ApplicationGatewayHttpListenerPropertiesFormat27 {␊ - /**␊ - * Frontend IP configuration resource of an application gateway.␊ - */␊ - frontendIPConfiguration?: (SubResource35 | string)␊ - /**␊ - * Frontend port resource of an application gateway.␊ - */␊ - frontendPort?: (SubResource35 | string)␊ - /**␊ - * Protocol of the HTTP listener.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - /**␊ - * Host name of HTTP listener.␊ - */␊ - hostName?: string␊ - /**␊ - * SSL certificate resource of an application gateway.␊ - */␊ - sslCertificate?: (SubResource35 | string)␊ - /**␊ - * Applicable only if protocol is https. Enables SNI for multi-hosting.␊ - */␊ - requireServerNameIndication?: (boolean | string)␊ - /**␊ - * Custom error configurations of the HTTP listener.␊ - */␊ - customErrorConfigurations?: (ApplicationGatewayCustomError14[] | string)␊ - /**␊ - * Reference to the FirewallPolicy resource.␊ - */␊ - firewallPolicy?: (SubResource35 | string)␊ - /**␊ - * List of Host names for HTTP Listener that allows special wildcard characters as well.␊ - */␊ - hostNames?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Customer error of an application gateway.␊ - */␊ - export interface ApplicationGatewayCustomError14 {␊ - /**␊ - * Status code of the application gateway customer error.␊ - */␊ - statusCode?: (("HttpStatus403" | "HttpStatus502") | string)␊ - /**␊ - * Error page URL of the application gateway customer error.␊ - */␊ - customErrorPageUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * UrlPathMaps give a url path to the backend mapping information for PathBasedRouting.␊ - */␊ - export interface ApplicationGatewayUrlPathMap26 {␊ - /**␊ - * Properties of the application gateway URL path map.␊ - */␊ - properties?: (ApplicationGatewayUrlPathMapPropertiesFormat26 | string)␊ - /**␊ - * Name of the URL path map that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of UrlPathMap of the application gateway.␊ - */␊ - export interface ApplicationGatewayUrlPathMapPropertiesFormat26 {␊ - /**␊ - * Default backend address pool resource of URL path map.␊ - */␊ - defaultBackendAddressPool?: (SubResource35 | string)␊ - /**␊ - * Default backend http settings resource of URL path map.␊ - */␊ - defaultBackendHttpSettings?: (SubResource35 | string)␊ - /**␊ - * Default Rewrite rule set resource of URL path map.␊ - */␊ - defaultRewriteRuleSet?: (SubResource35 | string)␊ - /**␊ - * Default redirect configuration resource of URL path map.␊ - */␊ - defaultRedirectConfiguration?: (SubResource35 | string)␊ - /**␊ - * Path rule of URL path map resource.␊ - */␊ - pathRules?: (ApplicationGatewayPathRule26[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Path rule of URL path map of an application gateway.␊ - */␊ - export interface ApplicationGatewayPathRule26 {␊ - /**␊ - * Properties of the application gateway path rule.␊ - */␊ - properties?: (ApplicationGatewayPathRulePropertiesFormat26 | string)␊ - /**␊ - * Name of the path rule that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of path rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayPathRulePropertiesFormat26 {␊ - /**␊ - * Path rules of URL path map.␊ - */␊ - paths?: (string[] | string)␊ - /**␊ - * Backend address pool resource of URL path map path rule.␊ - */␊ - backendAddressPool?: (SubResource35 | string)␊ - /**␊ - * Backend http settings resource of URL path map path rule.␊ - */␊ - backendHttpSettings?: (SubResource35 | string)␊ - /**␊ - * Redirect configuration resource of URL path map path rule.␊ - */␊ - redirectConfiguration?: (SubResource35 | string)␊ - /**␊ - * Rewrite rule set resource of URL path map path rule.␊ - */␊ - rewriteRuleSet?: (SubResource35 | string)␊ - /**␊ - * Reference to the FirewallPolicy resource.␊ - */␊ - firewallPolicy?: (SubResource35 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Request routing rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayRequestRoutingRule27 {␊ - /**␊ - * Properties of the application gateway request routing rule.␊ - */␊ - properties?: (ApplicationGatewayRequestRoutingRulePropertiesFormat27 | string)␊ - /**␊ - * Name of the request routing rule that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of request routing rule of the application gateway.␊ - */␊ - export interface ApplicationGatewayRequestRoutingRulePropertiesFormat27 {␊ - /**␊ - * Rule type.␊ - */␊ - ruleType?: (("Basic" | "PathBasedRouting") | string)␊ - /**␊ - * Priority of the request routing rule.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * Backend address pool resource of the application gateway.␊ - */␊ - backendAddressPool?: (SubResource35 | string)␊ - /**␊ - * Backend http settings resource of the application gateway.␊ - */␊ - backendHttpSettings?: (SubResource35 | string)␊ - /**␊ - * Http listener resource of the application gateway.␊ - */␊ - httpListener?: (SubResource35 | string)␊ - /**␊ - * URL path map resource of the application gateway.␊ - */␊ - urlPathMap?: (SubResource35 | string)␊ - /**␊ - * Rewrite Rule Set resource in Basic rule of the application gateway.␊ - */␊ - rewriteRuleSet?: (SubResource35 | string)␊ - /**␊ - * Redirect configuration resource of the application gateway.␊ - */␊ - redirectConfiguration?: (SubResource35 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Rewrite rule set of an application gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRuleSet13 {␊ - /**␊ - * Properties of the application gateway rewrite rule set.␊ - */␊ - properties?: (ApplicationGatewayRewriteRuleSetPropertiesFormat13 | string)␊ - /**␊ - * Name of the rewrite rule set that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of rewrite rule set of the application gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRuleSetPropertiesFormat13 {␊ - /**␊ - * Rewrite rules in the rewrite rule set.␊ - */␊ - rewriteRules?: (ApplicationGatewayRewriteRule13[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Rewrite rule of an application gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRule13 {␊ - /**␊ - * Name of the rewrite rule that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - /**␊ - * Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet.␊ - */␊ - ruleSequence?: (number | string)␊ - /**␊ - * Conditions based on which the action set execution will be evaluated.␊ - */␊ - conditions?: (ApplicationGatewayRewriteRuleCondition11[] | string)␊ - /**␊ - * Set of actions to be done as part of the rewrite Rule.␊ - */␊ - actionSet?: (ApplicationGatewayRewriteRuleActionSet13 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Set of conditions in the Rewrite Rule in Application Gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRuleCondition11 {␊ - /**␊ - * The condition parameter of the RewriteRuleCondition.␊ - */␊ - variable?: string␊ - /**␊ - * The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition.␊ - */␊ - pattern?: string␊ - /**␊ - * Setting this paramter to truth value with force the pattern to do a case in-sensitive comparison.␊ - */␊ - ignoreCase?: (boolean | string)␊ - /**␊ - * Setting this value as truth will force to check the negation of the condition given by the user.␊ - */␊ - negate?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Set of actions in the Rewrite Rule in Application Gateway.␊ - */␊ - export interface ApplicationGatewayRewriteRuleActionSet13 {␊ - /**␊ - * Request Header Actions in the Action Set.␊ - */␊ - requestHeaderConfigurations?: (ApplicationGatewayHeaderConfiguration13[] | string)␊ - /**␊ - * Response Header Actions in the Action Set.␊ - */␊ - responseHeaderConfigurations?: (ApplicationGatewayHeaderConfiguration13[] | string)␊ - /**␊ - * Url Configuration Action in the Action Set.␊ - */␊ - urlConfiguration?: (ApplicationGatewayUrlConfiguration4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Header configuration of the Actions set in Application Gateway.␊ - */␊ - export interface ApplicationGatewayHeaderConfiguration13 {␊ - /**␊ - * Header name of the header configuration.␊ - */␊ - headerName?: string␊ - /**␊ - * Header value of the header configuration.␊ - */␊ - headerValue?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Url configuration of the Actions set in Application Gateway.␊ - */␊ - export interface ApplicationGatewayUrlConfiguration4 {␊ - /**␊ - * Url path which user has provided for url rewrite. Null means no path will be updated. Default value is null.␊ - */␊ - modifiedPath?: string␊ - /**␊ - * Query string which user has provided for url rewrite. Null means no query string will be updated. Default value is null.␊ - */␊ - modifiedQueryString?: string␊ - /**␊ - * If set as true, it will re-evaluate the url path map provided in path based request routing rules using modified path. Default value is false.␊ - */␊ - reroute?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Redirect configuration of an application gateway.␊ - */␊ - export interface ApplicationGatewayRedirectConfiguration24 {␊ - /**␊ - * Properties of the application gateway redirect configuration.␊ - */␊ - properties?: (ApplicationGatewayRedirectConfigurationPropertiesFormat24 | string)␊ - /**␊ - * Name of the redirect configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of redirect configuration of the application gateway.␊ - */␊ - export interface ApplicationGatewayRedirectConfigurationPropertiesFormat24 {␊ - /**␊ - * HTTP redirection type.␊ - */␊ - redirectType?: (("Permanent" | "Found" | "SeeOther" | "Temporary") | string)␊ - /**␊ - * Reference to a listener to redirect the request to.␊ - */␊ - targetListener?: (SubResource35 | string)␊ - /**␊ - * Url to redirect the request to.␊ - */␊ - targetUrl?: string␊ - /**␊ - * Include path in the redirected url.␊ - */␊ - includePath?: (boolean | string)␊ - /**␊ - * Include query string in the redirected url.␊ - */␊ - includeQueryString?: (boolean | string)␊ - /**␊ - * Request routing specifying redirect configuration.␊ - */␊ - requestRoutingRules?: (SubResource35[] | string)␊ - /**␊ - * Url path maps specifying default redirect configuration.␊ - */␊ - urlPathMaps?: (SubResource35[] | string)␊ - /**␊ - * Path rules specifying redirect configuration.␊ - */␊ - pathRules?: (SubResource35[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application gateway web application firewall configuration.␊ - */␊ - export interface ApplicationGatewayWebApplicationFirewallConfiguration24 {␊ - /**␊ - * Whether the web application firewall is enabled or not.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * Web application firewall mode.␊ - */␊ - firewallMode: (("Detection" | "Prevention") | string)␊ - /**␊ - * The type of the web application firewall rule set. Possible values are: 'OWASP'.␊ - */␊ - ruleSetType: string␊ - /**␊ - * The version of the rule set type.␊ - */␊ - ruleSetVersion: string␊ - /**␊ - * The disabled rule groups.␊ - */␊ - disabledRuleGroups?: (ApplicationGatewayFirewallDisabledRuleGroup24[] | string)␊ - /**␊ - * Whether allow WAF to check request Body.␊ - */␊ - requestBodyCheck?: (boolean | string)␊ - /**␊ - * Maximum request body size for WAF.␊ - */␊ - maxRequestBodySize?: (number | string)␊ - /**␊ - * Maximum request body size in Kb for WAF.␊ - */␊ - maxRequestBodySizeInKb?: (number | string)␊ - /**␊ - * Maximum file upload size in Mb for WAF.␊ - */␊ - fileUploadLimitInMb?: (number | string)␊ - /**␊ - * The exclusion list.␊ - */␊ - exclusions?: (ApplicationGatewayFirewallExclusion14[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allows to disable rules within a rule group or an entire rule group.␊ - */␊ - export interface ApplicationGatewayFirewallDisabledRuleGroup24 {␊ - /**␊ - * The name of the rule group that will be disabled.␊ - */␊ - ruleGroupName: string␊ - /**␊ - * The list of rules that will be disabled. If null, all rules of the rule group will be disabled.␊ - */␊ - rules?: (number[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allow to exclude some variable satisfy the condition for the WAF check.␊ - */␊ - export interface ApplicationGatewayFirewallExclusion14 {␊ - /**␊ - * The variable to be excluded.␊ - */␊ - matchVariable: string␊ - /**␊ - * When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to.␊ - */␊ - selectorMatchOperator: string␊ - /**␊ - * When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to.␊ - */␊ - selector: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application Gateway autoscale configuration.␊ - */␊ - export interface ApplicationGatewayAutoscaleConfiguration17 {␊ - /**␊ - * Lower bound on number of Application Gateway capacity.␊ - */␊ - minCapacity: (number | string)␊ - /**␊ - * Upper bound on number of Application Gateway capacity.␊ - */␊ - maxCapacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Private Link Configuration on an application gateway.␊ - */␊ - export interface ApplicationGatewayPrivateLinkConfiguration {␊ - /**␊ - * Properties of the application gateway private link configuration.␊ - */␊ - properties?: (ApplicationGatewayPrivateLinkConfigurationProperties | string)␊ - /**␊ - * Name of the private link configuration that is unique within an Application Gateway.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of private link configuration on an application gateway.␊ - */␊ - export interface ApplicationGatewayPrivateLinkConfigurationProperties {␊ - /**␊ - * An array of application gateway private link ip configurations.␊ - */␊ - ipConfigurations?: (ApplicationGatewayPrivateLinkIpConfiguration[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The application gateway private link ip configuration.␊ - */␊ - export interface ApplicationGatewayPrivateLinkIpConfiguration {␊ - /**␊ - * Properties of an application gateway private link ip configuration.␊ - */␊ - properties?: (ApplicationGatewayPrivateLinkIpConfigurationProperties | string)␊ - /**␊ - * The name of application gateway private link ip configuration.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of an application gateway private link IP configuration.␊ - */␊ - export interface ApplicationGatewayPrivateLinkIpConfigurationProperties {␊ - /**␊ - * The private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The private IP address allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Reference to the subnet resource.␊ - */␊ - subnet?: (SubResource35 | string)␊ - /**␊ - * Whether the ip configuration is primary or not.␊ - */␊ - primary?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the resource.␊ - */␊ - export interface ManagedServiceIdentity13 {␊ - /**␊ - * The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.␊ - */␊ - type?: ("SystemAssigned" | "UserAssigned" | "SystemAssigned, UserAssigned" | "None")␊ - /**␊ - * The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.␊ - */␊ - userAssignedIdentities?: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/applicationGateways/privateEndpointConnections␊ - */␊ - export interface ApplicationGatewaysPrivateEndpointConnectionsChildResource {␊ - name: string␊ - type: "privateEndpointConnections"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Properties of the application gateway private endpoint connection.␊ - */␊ - properties: (ApplicationGatewayPrivateEndpointConnectionProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Private Link Resource of an application gateway.␊ - */␊ - export interface ApplicationGatewayPrivateEndpointConnectionProperties {␊ - /**␊ - * A collection of information about the state of the connection between service consumer and provider.␊ - */␊ - privateLinkServiceConnectionState?: (PrivateLinkServiceConnectionState15 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A collection of information about the state of the connection between service consumer and provider.␊ - */␊ - export interface PrivateLinkServiceConnectionState15 {␊ - /**␊ - * Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.␊ - */␊ - status?: string␊ - /**␊ - * The reason for approval/rejection of the connection.␊ - */␊ - description?: string␊ - /**␊ - * A message indicating if changes on the service provider require any updates on the consumer.␊ - */␊ - actionsRequired?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/applicationGateways/privateEndpointConnections␊ - */␊ - export interface ApplicationGatewaysPrivateEndpointConnections {␊ - name: string␊ - type: "Microsoft.Network/applicationGateways/privateEndpointConnections"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Properties of the application gateway private endpoint connection.␊ - */␊ - properties: (ApplicationGatewayPrivateEndpointConnectionProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies␊ - */␊ - export interface ApplicationGatewayWebApplicationFirewallPolicies11 {␊ - name: string␊ - type: "Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the web application firewall policy.␊ - */␊ - properties: (WebApplicationFirewallPolicyPropertiesFormat11 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines web application firewall policy properties.␊ - */␊ - export interface WebApplicationFirewallPolicyPropertiesFormat11 {␊ - /**␊ - * The PolicySettings for policy.␊ - */␊ - policySettings?: (PolicySettings13 | string)␊ - /**␊ - * The custom rules inside the policy.␊ - */␊ - customRules?: (WebApplicationFirewallCustomRule11[] | string)␊ - /**␊ - * Describes the managedRules structure.␊ - */␊ - managedRules: (ManagedRulesDefinition6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines contents of a web application firewall global configuration.␊ - */␊ - export interface PolicySettings13 {␊ - /**␊ - * The state of the policy.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * The mode of the policy.␊ - */␊ - mode?: (("Prevention" | "Detection") | string)␊ - /**␊ - * Whether to allow WAF to check request Body.␊ - */␊ - requestBodyCheck?: (boolean | string)␊ - /**␊ - * Maximum request body size in Kb for WAF.␊ - */␊ - maxRequestBodySizeInKb?: (number | string)␊ - /**␊ - * Maximum file upload size in Mb for WAF.␊ - */␊ - fileUploadLimitInMb?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines contents of a web application rule.␊ - */␊ - export interface WebApplicationFirewallCustomRule11 {␊ - /**␊ - * The name of the resource that is unique within a policy. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * Priority of the rule. Rules with a lower value will be evaluated before rules with a higher value.␊ - */␊ - priority: (number | string)␊ - /**␊ - * The rule type.␊ - */␊ - ruleType: (("MatchRule" | "Invalid") | string)␊ - /**␊ - * List of match conditions.␊ - */␊ - matchConditions: (MatchCondition13[] | string)␊ - /**␊ - * Type of Actions.␊ - */␊ - action: (("Allow" | "Block" | "Log") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Define match conditions.␊ - */␊ - export interface MatchCondition13 {␊ - /**␊ - * List of match variables.␊ - */␊ - matchVariables: (MatchVariable11[] | string)␊ - /**␊ - * The operator to be matched.␊ - */␊ - operator: (("IPMatch" | "Equal" | "Contains" | "LessThan" | "GreaterThan" | "LessThanOrEqual" | "GreaterThanOrEqual" | "BeginsWith" | "EndsWith" | "Regex" | "GeoMatch") | string)␊ - /**␊ - * Whether this is negate condition or not.␊ - */␊ - negationConditon?: (boolean | string)␊ - /**␊ - * Match value.␊ - */␊ - matchValues: (string[] | string)␊ - /**␊ - * List of transforms.␊ - */␊ - transforms?: (("Lowercase" | "Trim" | "UrlDecode" | "UrlEncode" | "RemoveNulls" | "HtmlEntityDecode")[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Define match variables.␊ - */␊ - export interface MatchVariable11 {␊ - /**␊ - * Match Variable.␊ - */␊ - variableName: (("RemoteAddr" | "RequestMethod" | "QueryString" | "PostArgs" | "RequestUri" | "RequestHeaders" | "RequestBody" | "RequestCookies") | string)␊ - /**␊ - * The selector of match variable.␊ - */␊ - selector?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allow to exclude some variable satisfy the condition for the WAF check.␊ - */␊ - export interface ManagedRulesDefinition6 {␊ - /**␊ - * The Exclusions that are applied on the policy.␊ - */␊ - exclusions?: (OwaspCrsExclusionEntry6[] | string)␊ - /**␊ - * The managed rule sets that are associated with the policy.␊ - */␊ - managedRuleSets: (ManagedRuleSet8[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allow to exclude some variable satisfy the condition for the WAF check.␊ - */␊ - export interface OwaspCrsExclusionEntry6 {␊ - /**␊ - * The variable to be excluded.␊ - */␊ - matchVariable: (("RequestHeaderNames" | "RequestCookieNames" | "RequestArgNames") | string)␊ - /**␊ - * When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to.␊ - */␊ - selectorMatchOperator: (("Equals" | "Contains" | "StartsWith" | "EndsWith" | "EqualsAny") | string)␊ - /**␊ - * When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to.␊ - */␊ - selector: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines a managed rule set.␊ - */␊ - export interface ManagedRuleSet8 {␊ - /**␊ - * Defines the rule set type to use.␊ - */␊ - ruleSetType: string␊ - /**␊ - * Defines the version of the rule set to use.␊ - */␊ - ruleSetVersion: string␊ - /**␊ - * Defines the rule group overrides to apply to the rule set.␊ - */␊ - ruleGroupOverrides?: (ManagedRuleGroupOverride8[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines a managed rule group override setting.␊ - */␊ - export interface ManagedRuleGroupOverride8 {␊ - /**␊ - * The managed rule group to override.␊ - */␊ - ruleGroupName: string␊ - /**␊ - * List of rules that will be disabled. If none specified, all rules in the group will be disabled.␊ - */␊ - rules?: (ManagedRuleOverride8[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines a managed rule group override setting.␊ - */␊ - export interface ManagedRuleOverride8 {␊ - /**␊ - * Identifier for the managed rule.␊ - */␊ - ruleId: string␊ - /**␊ - * The state of the managed rule. Defaults to Disabled if not specified.␊ - */␊ - state?: ("Disabled" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/applicationSecurityGroups␊ - */␊ - export interface ApplicationSecurityGroups22 {␊ - name: string␊ - type: "Microsoft.Network/applicationSecurityGroups"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the application security group.␊ - */␊ - properties: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/azureFirewalls␊ - */␊ - export interface AzureFirewalls12 {␊ - name: string␊ - type: "Microsoft.Network/azureFirewalls"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the azure firewall.␊ - */␊ - properties: (AzureFirewallPropertiesFormat12 | string)␊ - /**␊ - * A list of availability zones denoting where the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Azure Firewall.␊ - */␊ - export interface AzureFirewallPropertiesFormat12 {␊ - /**␊ - * Collection of application rule collections used by Azure Firewall.␊ - */␊ - applicationRuleCollections?: (AzureFirewallApplicationRuleCollection12[] | string)␊ - /**␊ - * Collection of NAT rule collections used by Azure Firewall.␊ - */␊ - natRuleCollections?: (AzureFirewallNatRuleCollection9[] | string)␊ - /**␊ - * Collection of network rule collections used by Azure Firewall.␊ - */␊ - networkRuleCollections?: (AzureFirewallNetworkRuleCollection12[] | string)␊ - /**␊ - * IP configuration of the Azure Firewall resource.␊ - */␊ - ipConfigurations?: (AzureFirewallIPConfiguration12[] | string)␊ - /**␊ - * IP configuration of the Azure Firewall used for management traffic.␊ - */␊ - managementIpConfiguration?: (AzureFirewallIPConfiguration12 | string)␊ - /**␊ - * The operation mode for Threat Intelligence.␊ - */␊ - threatIntelMode?: (("Alert" | "Deny" | "Off") | string)␊ - /**␊ - * The virtualHub to which the firewall belongs.␊ - */␊ - virtualHub?: (SubResource35 | string)␊ - /**␊ - * The firewallPolicy associated with this azure firewall.␊ - */␊ - firewallPolicy?: (SubResource35 | string)␊ - /**␊ - * IP addresses associated with AzureFirewall.␊ - */␊ - hubIPAddresses?: (HubIPAddresses | string)␊ - /**␊ - * The Azure Firewall Resource SKU.␊ - */␊ - sku?: (AzureFirewallSku6 | string)␊ - /**␊ - * The additional properties used to further config this azure firewall.␊ - */␊ - additionalProperties?: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application rule collection resource.␊ - */␊ - export interface AzureFirewallApplicationRuleCollection12 {␊ - /**␊ - * Properties of the azure firewall application rule collection.␊ - */␊ - properties?: (AzureFirewallApplicationRuleCollectionPropertiesFormat12 | string)␊ - /**␊ - * The name of the resource that is unique within the Azure firewall. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application rule collection.␊ - */␊ - export interface AzureFirewallApplicationRuleCollectionPropertiesFormat12 {␊ - /**␊ - * Priority of the application rule collection resource.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * The action type of a rule collection.␊ - */␊ - action?: (AzureFirewallRCAction12 | string)␊ - /**␊ - * Collection of rules used by a application rule collection.␊ - */␊ - rules?: (AzureFirewallApplicationRule12[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the AzureFirewallRCAction.␊ - */␊ - export interface AzureFirewallRCAction12 {␊ - /**␊ - * The type of action.␊ - */␊ - type?: ("Allow" | "Deny")␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of an application rule.␊ - */␊ - export interface AzureFirewallApplicationRule12 {␊ - /**␊ - * Name of the application rule.␊ - */␊ - name?: string␊ - /**␊ - * Description of the rule.␊ - */␊ - description?: string␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * Array of ApplicationRuleProtocols.␊ - */␊ - protocols?: (AzureFirewallApplicationRuleProtocol12[] | string)␊ - /**␊ - * List of FQDNs for this rule.␊ - */␊ - targetFqdns?: (string[] | string)␊ - /**␊ - * List of FQDN Tags for this rule.␊ - */␊ - fqdnTags?: (string[] | string)␊ - /**␊ - * List of source IpGroups for this rule.␊ - */␊ - sourceIpGroups?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application rule protocol.␊ - */␊ - export interface AzureFirewallApplicationRuleProtocol12 {␊ - /**␊ - * Protocol type.␊ - */␊ - protocolType?: (("Http" | "Https" | "Mssql") | string)␊ - /**␊ - * Port number for the protocol, cannot be greater than 64000. This field is optional.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NAT rule collection resource.␊ - */␊ - export interface AzureFirewallNatRuleCollection9 {␊ - /**␊ - * Properties of the azure firewall NAT rule collection.␊ - */␊ - properties?: (AzureFirewallNatRuleCollectionProperties9 | string)␊ - /**␊ - * The name of the resource that is unique within the Azure firewall. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the NAT rule collection.␊ - */␊ - export interface AzureFirewallNatRuleCollectionProperties9 {␊ - /**␊ - * Priority of the NAT rule collection resource.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * The action type of a NAT rule collection.␊ - */␊ - action?: (AzureFirewallNatRCAction9 | string)␊ - /**␊ - * Collection of rules used by a NAT rule collection.␊ - */␊ - rules?: (AzureFirewallNatRule9[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AzureFirewall NAT Rule Collection Action.␊ - */␊ - export interface AzureFirewallNatRCAction9 {␊ - /**␊ - * The type of action.␊ - */␊ - type?: ("Snat" | "Dnat")␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a NAT rule.␊ - */␊ - export interface AzureFirewallNatRule9 {␊ - /**␊ - * Name of the NAT rule.␊ - */␊ - name?: string␊ - /**␊ - * Description of the rule.␊ - */␊ - description?: string␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags.␊ - */␊ - destinationAddresses?: (string[] | string)␊ - /**␊ - * List of destination ports.␊ - */␊ - destinationPorts?: (string[] | string)␊ - /**␊ - * Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule.␊ - */␊ - protocols?: (("TCP" | "UDP" | "Any" | "ICMP")[] | string)␊ - /**␊ - * The translated address for this NAT rule.␊ - */␊ - translatedAddress?: string␊ - /**␊ - * The translated port for this NAT rule.␊ - */␊ - translatedPort?: string␊ - /**␊ - * The translated FQDN for this NAT rule.␊ - */␊ - translatedFqdn?: string␊ - /**␊ - * List of source IpGroups for this rule.␊ - */␊ - sourceIpGroups?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network rule collection resource.␊ - */␊ - export interface AzureFirewallNetworkRuleCollection12 {␊ - /**␊ - * Properties of the azure firewall network rule collection.␊ - */␊ - properties?: (AzureFirewallNetworkRuleCollectionPropertiesFormat12 | string)␊ - /**␊ - * The name of the resource that is unique within the Azure firewall. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the network rule collection.␊ - */␊ - export interface AzureFirewallNetworkRuleCollectionPropertiesFormat12 {␊ - /**␊ - * Priority of the network rule collection resource.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * The action type of a rule collection.␊ - */␊ - action?: (AzureFirewallRCAction12 | string)␊ - /**␊ - * Collection of rules used by a network rule collection.␊ - */␊ - rules?: (AzureFirewallNetworkRule12[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the network rule.␊ - */␊ - export interface AzureFirewallNetworkRule12 {␊ - /**␊ - * Name of the network rule.␊ - */␊ - name?: string␊ - /**␊ - * Description of the rule.␊ - */␊ - description?: string␊ - /**␊ - * Array of AzureFirewallNetworkRuleProtocols.␊ - */␊ - protocols?: (("TCP" | "UDP" | "Any" | "ICMP")[] | string)␊ - /**␊ - * List of source IP addresses for this rule.␊ - */␊ - sourceAddresses?: (string[] | string)␊ - /**␊ - * List of destination IP addresses.␊ - */␊ - destinationAddresses?: (string[] | string)␊ - /**␊ - * List of destination ports.␊ - */␊ - destinationPorts?: (string[] | string)␊ - /**␊ - * List of destination FQDNs.␊ - */␊ - destinationFqdns?: (string[] | string)␊ - /**␊ - * List of source IpGroups for this rule.␊ - */␊ - sourceIpGroups?: (string[] | string)␊ - /**␊ - * List of destination IpGroups for this rule.␊ - */␊ - destinationIpGroups?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration of an Azure Firewall.␊ - */␊ - export interface AzureFirewallIPConfiguration12 {␊ - /**␊ - * Properties of the azure firewall IP configuration.␊ - */␊ - properties?: (AzureFirewallIPConfigurationPropertiesFormat12 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration of an Azure Firewall.␊ - */␊ - export interface AzureFirewallIPConfigurationPropertiesFormat12 {␊ - /**␊ - * Reference to the subnet resource. This resource must be named 'AzureFirewallSubnet' or 'AzureFirewallManagementSubnet'.␊ - */␊ - subnet?: (SubResource35 | string)␊ - /**␊ - * Reference to the PublicIP resource. This field is a mandatory input if subnet is not null.␊ - */␊ - publicIPAddress?: (SubResource35 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP addresses associated with azure firewall.␊ - */␊ - export interface HubIPAddresses {␊ - /**␊ - * Public IP addresses associated with azure firewall.␊ - */␊ - publicIPs?: (HubPublicIPAddresses | string)␊ - /**␊ - * Private IP Address associated with azure firewall.␊ - */␊ - privateIPAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Public IP addresses associated with azure firewall.␊ - */␊ - export interface HubPublicIPAddresses {␊ - /**␊ - * The number of Public IP addresses associated with azure firewall.␊ - */␊ - addresses?: (AzureFirewallPublicIPAddress[] | string)␊ - /**␊ - * Private IP Address associated with azure firewall.␊ - */␊ - count?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Public IP Address associated with azure firewall.␊ - */␊ - export interface AzureFirewallPublicIPAddress {␊ - /**␊ - * Public IP Address value.␊ - */␊ - address?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of an Azure Firewall.␊ - */␊ - export interface AzureFirewallSku6 {␊ - /**␊ - * Name of an Azure Firewall SKU.␊ - */␊ - name?: (("AZFW_VNet" | "AZFW_Hub") | string)␊ - /**␊ - * Tier of an Azure Firewall.␊ - */␊ - tier?: (("Standard" | "Premium") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/bastionHosts␊ - */␊ - export interface BastionHosts9 {␊ - /**␊ - * The name of the Bastion Host.␊ - */␊ - name: string␊ - type: "Microsoft.Network/bastionHosts"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Represents the bastion host resource.␊ - */␊ - properties: (BastionHostPropertiesFormat9 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Bastion Host.␊ - */␊ - export interface BastionHostPropertiesFormat9 {␊ - /**␊ - * IP configuration of the Bastion Host resource.␊ - */␊ - ipConfigurations?: (BastionHostIPConfiguration9[] | string)␊ - /**␊ - * FQDN for the endpoint on which bastion host is accessible.␊ - */␊ - dnsName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration of an Bastion Host.␊ - */␊ - export interface BastionHostIPConfiguration9 {␊ - /**␊ - * Represents the ip configuration associated with the resource.␊ - */␊ - properties?: (BastionHostIPConfigurationPropertiesFormat9 | string)␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration of an Bastion Host.␊ - */␊ - export interface BastionHostIPConfigurationPropertiesFormat9 {␊ - /**␊ - * Reference of the subnet resource.␊ - */␊ - subnet: (SubResource35 | string)␊ - /**␊ - * Reference of the PublicIP resource.␊ - */␊ - publicIPAddress: (SubResource35 | string)␊ - /**␊ - * Private IP allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/connections␊ - */␊ - export interface Connections27 {␊ - name: string␊ - type: "Microsoft.Network/connections"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway connection.␊ - */␊ - properties: (VirtualNetworkGatewayConnectionPropertiesFormat27 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewayConnection properties.␊ - */␊ - export interface VirtualNetworkGatewayConnectionPropertiesFormat27 {␊ - /**␊ - * The authorizationKey.␊ - */␊ - authorizationKey?: string␊ - /**␊ - * The reference to virtual network gateway resource.␊ - */␊ - virtualNetworkGateway1: (SubResource35 | string)␊ - /**␊ - * The reference to virtual network gateway resource.␊ - */␊ - virtualNetworkGateway2?: (SubResource35 | string)␊ - /**␊ - * The reference to local network gateway resource.␊ - */␊ - localNetworkGateway2?: (SubResource35 | string)␊ - /**␊ - * Gateway connection type.␊ - */␊ - connectionType: (("IPsec" | "Vnet2Vnet" | "ExpressRoute" | "VPNClient") | string)␊ - /**␊ - * Connection protocol used for this connection.␊ - */␊ - connectionProtocol?: (("IKEv2" | "IKEv1") | string)␊ - /**␊ - * The routing weight.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * The dead peer detection timeout of this connection in seconds.␊ - */␊ - dpdTimeoutSeconds?: (number | string)␊ - /**␊ - * The IPSec shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The reference to peerings resource.␊ - */␊ - peer?: (SubResource35 | string)␊ - /**␊ - * EnableBgp flag.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * Use private local Azure IP for the connection.␊ - */␊ - useLocalAzureIpAddress?: (boolean | string)␊ - /**␊ - * Enable policy-based traffic selectors.␊ - */␊ - usePolicyBasedTrafficSelectors?: (boolean | string)␊ - /**␊ - * The IPSec Policies to be considered by this connection.␊ - */␊ - ipsecPolicies?: (IpsecPolicy24[] | string)␊ - /**␊ - * The Traffic Selector Policies to be considered by this connection.␊ - */␊ - trafficSelectorPolicies?: (TrafficSelectorPolicy7[] | string)␊ - /**␊ - * Bypass ExpressRoute Gateway for data forwarding.␊ - */␊ - expressRouteGatewayBypass?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An IPSec Policy configuration for a virtual network gateway connection.␊ - */␊ - export interface IpsecPolicy24 {␊ - /**␊ - * The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.␊ - */␊ - saLifeTimeSeconds: (number | string)␊ - /**␊ - * The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.␊ - */␊ - saDataSizeKilobytes: (number | string)␊ - /**␊ - * The IPSec encryption algorithm (IKE phase 1).␊ - */␊ - ipsecEncryption: (("None" | "DES" | "DES3" | "AES128" | "AES192" | "AES256" | "GCMAES128" | "GCMAES192" | "GCMAES256") | string)␊ - /**␊ - * The IPSec integrity algorithm (IKE phase 1).␊ - */␊ - ipsecIntegrity: (("MD5" | "SHA1" | "SHA256" | "GCMAES128" | "GCMAES192" | "GCMAES256") | string)␊ - /**␊ - * The IKE encryption algorithm (IKE phase 2).␊ - */␊ - ikeEncryption: (("DES" | "DES3" | "AES128" | "AES192" | "AES256" | "GCMAES256" | "GCMAES128") | string)␊ - /**␊ - * The IKE integrity algorithm (IKE phase 2).␊ - */␊ - ikeIntegrity: (("MD5" | "SHA1" | "SHA256" | "SHA384" | "GCMAES256" | "GCMAES128") | string)␊ - /**␊ - * The DH Group used in IKE Phase 1 for initial SA.␊ - */␊ - dhGroup: (("None" | "DHGroup1" | "DHGroup2" | "DHGroup14" | "DHGroup2048" | "ECP256" | "ECP384" | "DHGroup24") | string)␊ - /**␊ - * The Pfs Group used in IKE Phase 2 for new child SA.␊ - */␊ - pfsGroup: (("None" | "PFS1" | "PFS2" | "PFS2048" | "ECP256" | "ECP384" | "PFS24" | "PFS14" | "PFSMM") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An traffic selector policy for a virtual network gateway connection.␊ - */␊ - export interface TrafficSelectorPolicy7 {␊ - /**␊ - * A collection of local address spaces in CIDR format.␊ - */␊ - localAddressRanges: (string[] | string)␊ - /**␊ - * A collection of remote address spaces in CIDR format.␊ - */␊ - remoteAddressRanges: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ddosCustomPolicies␊ - */␊ - export interface DdosCustomPolicies9 {␊ - name: string␊ - type: "Microsoft.Network/ddosCustomPolicies"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the DDoS custom policy.␊ - */␊ - properties: (DdosCustomPolicyPropertiesFormat9 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DDoS custom policy properties.␊ - */␊ - export interface DdosCustomPolicyPropertiesFormat9 {␊ - /**␊ - * The protocol-specific DDoS policy customization parameters.␊ - */␊ - protocolCustomSettings?: (ProtocolCustomSettingsFormat9[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DDoS custom policy properties.␊ - */␊ - export interface ProtocolCustomSettingsFormat9 {␊ - /**␊ - * The protocol for which the DDoS protection policy is being customized.␊ - */␊ - protocol?: (("Tcp" | "Udp" | "Syn") | string)␊ - /**␊ - * The customized DDoS protection trigger rate.␊ - */␊ - triggerRateOverride?: string␊ - /**␊ - * The customized DDoS protection source rate.␊ - */␊ - sourceRateOverride?: string␊ - /**␊ - * The customized DDoS protection trigger rate sensitivity degrees. High: Trigger rate set with most sensitivity w.r.t. normal traffic. Default: Trigger rate set with moderate sensitivity w.r.t. normal traffic. Low: Trigger rate set with less sensitivity w.r.t. normal traffic. Relaxed: Trigger rate set with least sensitivity w.r.t. normal traffic.␊ - */␊ - triggerSensitivityOverride?: (("Relaxed" | "Low" | "Default" | "High") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ddosProtectionPlans␊ - */␊ - export interface DdosProtectionPlans18 {␊ - name: string␊ - type: "Microsoft.Network/ddosProtectionPlans"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the DDoS protection plan.␊ - */␊ - properties: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits␊ - */␊ - export interface ExpressRouteCircuits20 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The SKU.␊ - */␊ - sku?: (ExpressRouteCircuitSku20 | string)␊ - /**␊ - * Properties of the express route circuit.␊ - */␊ - properties: (ExpressRouteCircuitPropertiesFormat20 | string)␊ - resources?: (ExpressRouteCircuitsPeeringsChildResource20 | ExpressRouteCircuitsAuthorizationsChildResource20)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains SKU in an ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitSku20 {␊ - /**␊ - * The name of the SKU.␊ - */␊ - name?: string␊ - /**␊ - * The tier of the SKU.␊ - */␊ - tier?: (("Standard" | "Premium" | "Basic" | "Local") | string)␊ - /**␊ - * The family of the SKU.␊ - */␊ - family?: (("UnlimitedData" | "MeteredData") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitPropertiesFormat20 {␊ - /**␊ - * Allow classic operations.␊ - */␊ - allowClassicOperations?: (boolean | string)␊ - /**␊ - * The list of authorizations.␊ - */␊ - authorizations?: (ExpressRouteCircuitAuthorization20[] | string)␊ - /**␊ - * The list of peerings.␊ - */␊ - peerings?: (ExpressRouteCircuitPeering20[] | string)␊ - /**␊ - * The ServiceProviderNotes.␊ - */␊ - serviceProviderNotes?: string␊ - /**␊ - * The ServiceProviderProperties.␊ - */␊ - serviceProviderProperties?: (ExpressRouteCircuitServiceProviderProperties20 | string)␊ - /**␊ - * The reference to the ExpressRoutePort resource when the circuit is provisioned on an ExpressRoutePort resource.␊ - */␊ - expressRoutePort?: (SubResource35 | string)␊ - /**␊ - * The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource.␊ - */␊ - bandwidthInGbps?: (number | string)␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authorization in an ExpressRouteCircuit resource.␊ - */␊ - export interface ExpressRouteCircuitAuthorization20 {␊ - /**␊ - * Properties of the express route circuit authorization.␊ - */␊ - properties?: ({␊ - [k: string]: unknown␊ - } | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peering in an ExpressRouteCircuit resource.␊ - */␊ - export interface ExpressRouteCircuitPeering20 {␊ - /**␊ - * Properties of the express route circuit peering.␊ - */␊ - properties?: (ExpressRouteCircuitPeeringPropertiesFormat21 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the express route circuit peering.␊ - */␊ - export interface ExpressRouteCircuitPeeringPropertiesFormat21 {␊ - /**␊ - * The peering type.␊ - */␊ - peeringType?: (("AzurePublicPeering" | "AzurePrivatePeering" | "MicrosoftPeering") | string)␊ - /**␊ - * The peering state.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * The peer ASN.␊ - */␊ - peerASN?: (number | string)␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The VLAN ID.␊ - */␊ - vlanId?: (number | string)␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig21 | string)␊ - /**␊ - * The peering stats of express route circuit.␊ - */␊ - stats?: (ExpressRouteCircuitStats21 | string)␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - /**␊ - * The reference to the RouteFilter resource.␊ - */␊ - routeFilter?: (SubResource35 | string)␊ - /**␊ - * The IPv6 peering configuration.␊ - */␊ - ipv6PeeringConfig?: (Ipv6ExpressRouteCircuitPeeringConfig18 | string)␊ - /**␊ - * The ExpressRoute connection.␊ - */␊ - expressRouteConnection?: (SubResource35 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the peering configuration.␊ - */␊ - export interface ExpressRouteCircuitPeeringConfig21 {␊ - /**␊ - * The reference to AdvertisedPublicPrefixes.␊ - */␊ - advertisedPublicPrefixes?: (string[] | string)␊ - /**␊ - * The communities of bgp peering. Specified for microsoft peering.␊ - */␊ - advertisedCommunities?: (string[] | string)␊ - /**␊ - * The legacy mode of the peering.␊ - */␊ - legacyMode?: (number | string)␊ - /**␊ - * The CustomerASN of the peering.␊ - */␊ - customerASN?: (number | string)␊ - /**␊ - * The RoutingRegistryName of the configuration.␊ - */␊ - routingRegistryName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains stats associated with the peering.␊ - */␊ - export interface ExpressRouteCircuitStats21 {␊ - /**␊ - * The Primary BytesIn of the peering.␊ - */␊ - primarybytesIn?: (number | string)␊ - /**␊ - * The primary BytesOut of the peering.␊ - */␊ - primarybytesOut?: (number | string)␊ - /**␊ - * The secondary BytesIn of the peering.␊ - */␊ - secondarybytesIn?: (number | string)␊ - /**␊ - * The secondary BytesOut of the peering.␊ - */␊ - secondarybytesOut?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains IPv6 peering config.␊ - */␊ - export interface Ipv6ExpressRouteCircuitPeeringConfig18 {␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig21 | string)␊ - /**␊ - * The reference to the RouteFilter resource.␊ - */␊ - routeFilter?: (SubResource35 | string)␊ - /**␊ - * The state of peering.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains ServiceProviderProperties in an ExpressRouteCircuit.␊ - */␊ - export interface ExpressRouteCircuitServiceProviderProperties20 {␊ - /**␊ - * The serviceProviderName.␊ - */␊ - serviceProviderName?: string␊ - /**␊ - * The peering location.␊ - */␊ - peeringLocation?: string␊ - /**␊ - * The BandwidthInMbps.␊ - */␊ - bandwidthInMbps?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings␊ - */␊ - export interface ExpressRouteCircuitsPeeringsChildResource20 {␊ - name: string␊ - type: "peerings"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Properties of the express route circuit peering.␊ - */␊ - properties: (ExpressRouteCircuitPeeringPropertiesFormat21 | string)␊ - resources?: ExpressRouteCircuitsPeeringsConnectionsChildResource18[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings/connections␊ - */␊ - export interface ExpressRouteCircuitsPeeringsConnectionsChildResource18 {␊ - name: string␊ - type: "connections"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Properties of the express route circuit connection.␊ - */␊ - properties: (ExpressRouteCircuitConnectionPropertiesFormat18 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the express route circuit connection.␊ - */␊ - export interface ExpressRouteCircuitConnectionPropertiesFormat18 {␊ - /**␊ - * Reference to Express Route Circuit Private Peering Resource of the circuit initiating connection.␊ - */␊ - expressRouteCircuitPeering?: (SubResource35 | string)␊ - /**␊ - * Reference to Express Route Circuit Private Peering Resource of the peered circuit.␊ - */␊ - peerExpressRouteCircuitPeering?: (SubResource35 | string)␊ - /**␊ - * /29 IP address space to carve out Customer addresses for tunnels.␊ - */␊ - addressPrefix?: string␊ - /**␊ - * The authorization key.␊ - */␊ - authorizationKey?: string␊ - /**␊ - * IPv6 Address PrefixProperties of the express route circuit connection.␊ - */␊ - ipv6CircuitConnectionConfig?: (Ipv6CircuitConnectionConfig3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IPv6 Circuit Connection properties for global reach.␊ - */␊ - export interface Ipv6CircuitConnectionConfig3 {␊ - /**␊ - * /125 IP address space to carve out customer addresses for global reach.␊ - */␊ - addressPrefix?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/authorizations␊ - */␊ - export interface ExpressRouteCircuitsAuthorizationsChildResource20 {␊ - name: string␊ - type: "authorizations"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Properties of the express route circuit authorization.␊ - */␊ - properties: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/authorizations␊ - */␊ - export interface ExpressRouteCircuitsAuthorizations21 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/authorizations"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Properties of the express route circuit authorization.␊ - */␊ - properties: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings␊ - */␊ - export interface ExpressRouteCircuitsPeerings21 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/peerings"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Properties of the express route circuit peering.␊ - */␊ - properties: (ExpressRouteCircuitPeeringPropertiesFormat21 | string)␊ - resources?: ExpressRouteCircuitsPeeringsConnectionsChildResource18[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCircuits/peerings/connections␊ - */␊ - export interface ExpressRouteCircuitsPeeringsConnections18 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCircuits/peerings/connections"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Properties of the express route circuit connection.␊ - */␊ - properties: (ExpressRouteCircuitConnectionPropertiesFormat18 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections␊ - */␊ - export interface ExpressRouteCrossConnections18 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCrossConnections"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the express route cross connection.␊ - */␊ - properties: (ExpressRouteCrossConnectionProperties18 | string)␊ - resources?: ExpressRouteCrossConnectionsPeeringsChildResource18[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of ExpressRouteCrossConnection.␊ - */␊ - export interface ExpressRouteCrossConnectionProperties18 {␊ - /**␊ - * The peering location of the ExpressRoute circuit.␊ - */␊ - peeringLocation?: string␊ - /**␊ - * The circuit bandwidth In Mbps.␊ - */␊ - bandwidthInMbps?: (number | string)␊ - /**␊ - * The ExpressRouteCircuit.␊ - */␊ - expressRouteCircuit?: (SubResource35 | string)␊ - /**␊ - * The provisioning state of the circuit in the connectivity provider system.␊ - */␊ - serviceProviderProvisioningState?: (("NotProvisioned" | "Provisioning" | "Provisioned" | "Deprovisioning") | string)␊ - /**␊ - * Additional read only notes set by the connectivity provider.␊ - */␊ - serviceProviderNotes?: string␊ - /**␊ - * The list of peerings.␊ - */␊ - peerings?: (ExpressRouteCrossConnectionPeering18[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peering in an ExpressRoute Cross Connection resource.␊ - */␊ - export interface ExpressRouteCrossConnectionPeering18 {␊ - /**␊ - * Properties of the express route cross connection peering.␊ - */␊ - properties?: (ExpressRouteCrossConnectionPeeringProperties18 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of express route cross connection peering.␊ - */␊ - export interface ExpressRouteCrossConnectionPeeringProperties18 {␊ - /**␊ - * The peering type.␊ - */␊ - peeringType?: (("AzurePublicPeering" | "AzurePrivatePeering" | "MicrosoftPeering") | string)␊ - /**␊ - * The peering state.␊ - */␊ - state?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * The peer ASN.␊ - */␊ - peerASN?: (number | string)␊ - /**␊ - * The primary address prefix.␊ - */␊ - primaryPeerAddressPrefix?: string␊ - /**␊ - * The secondary address prefix.␊ - */␊ - secondaryPeerAddressPrefix?: string␊ - /**␊ - * The shared key.␊ - */␊ - sharedKey?: string␊ - /**␊ - * The VLAN ID.␊ - */␊ - vlanId?: (number | string)␊ - /**␊ - * The Microsoft peering configuration.␊ - */␊ - microsoftPeeringConfig?: (ExpressRouteCircuitPeeringConfig21 | string)␊ - /**␊ - * The GatewayManager Etag.␊ - */␊ - gatewayManagerEtag?: string␊ - /**␊ - * The IPv6 peering configuration.␊ - */␊ - ipv6PeeringConfig?: (Ipv6ExpressRouteCircuitPeeringConfig18 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections/peerings␊ - */␊ - export interface ExpressRouteCrossConnectionsPeeringsChildResource18 {␊ - name: string␊ - type: "peerings"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Properties of the express route cross connection peering.␊ - */␊ - properties: (ExpressRouteCrossConnectionPeeringProperties18 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteCrossConnections/peerings␊ - */␊ - export interface ExpressRouteCrossConnectionsPeerings18 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteCrossConnections/peerings"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Properties of the express route cross connection peering.␊ - */␊ - properties: (ExpressRouteCrossConnectionPeeringProperties18 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteGateways␊ - */␊ - export interface ExpressRouteGateways9 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteGateways"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the express route gateway.␊ - */␊ - properties: (ExpressRouteGatewayProperties9 | string)␊ - resources?: ExpressRouteGatewaysExpressRouteConnectionsChildResource9[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ExpressRoute gateway resource properties.␊ - */␊ - export interface ExpressRouteGatewayProperties9 {␊ - /**␊ - * Configuration for auto scaling.␊ - */␊ - autoScaleConfiguration?: (ExpressRouteGatewayPropertiesAutoScaleConfiguration9 | string)␊ - /**␊ - * The Virtual Hub where the ExpressRoute gateway is or will be deployed.␊ - */␊ - virtualHub: (SubResource35 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Configuration for auto scaling.␊ - */␊ - export interface ExpressRouteGatewayPropertiesAutoScaleConfiguration9 {␊ - /**␊ - * Minimum and maximum number of scale units to deploy.␊ - */␊ - bounds?: (ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds9 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Minimum and maximum number of scale units to deploy.␊ - */␊ - export interface ExpressRouteGatewayPropertiesAutoScaleConfigurationBounds9 {␊ - /**␊ - * Minimum number of scale units deployed for ExpressRoute gateway.␊ - */␊ - min?: (number | string)␊ - /**␊ - * Maximum number of scale units deployed for ExpressRoute gateway.␊ - */␊ - max?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteGateways/expressRouteConnections␊ - */␊ - export interface ExpressRouteGatewaysExpressRouteConnectionsChildResource9 {␊ - name: string␊ - type: "expressRouteConnections"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Properties of the express route connection.␊ - */␊ - properties: (ExpressRouteConnectionProperties9 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the ExpressRouteConnection subresource.␊ - */␊ - export interface ExpressRouteConnectionProperties9 {␊ - /**␊ - * The ExpressRoute circuit peering.␊ - */␊ - expressRouteCircuitPeering: (SubResource35 | string)␊ - /**␊ - * Authorization key to establish the connection.␊ - */␊ - authorizationKey?: string␊ - /**␊ - * The routing weight associated to the connection.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * Enable internet security.␊ - */␊ - enableInternetSecurity?: (boolean | string)␊ - /**␊ - * The Routing Configuration indicating the associated and propagated route tables on this connection.␊ - */␊ - routingConfiguration?: (RoutingConfiguration1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Routing Configuration indicating the associated and propagated route tables for this connection.␊ - */␊ - export interface RoutingConfiguration1 {␊ - /**␊ - * The resource id RouteTable associated with this RoutingConfiguration.␊ - */␊ - associatedRouteTable?: (SubResource35 | string)␊ - /**␊ - * The list of RouteTables to advertise the routes to.␊ - */␊ - propagatedRouteTables?: (PropagatedRouteTable1 | string)␊ - /**␊ - * List of routes that control routing from VirtualHub into a virtual network connection.␊ - */␊ - vnetRoutes?: (VnetRoute1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The list of RouteTables to advertise the routes to.␊ - */␊ - export interface PropagatedRouteTable1 {␊ - /**␊ - * The list of labels.␊ - */␊ - labels?: (string[] | string)␊ - /**␊ - * The list of resource ids of all the RouteTables.␊ - */␊ - ids?: (SubResource35[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * List of routes that control routing from VirtualHub into a virtual network connection.␊ - */␊ - export interface VnetRoute1 {␊ - /**␊ - * List of all Static Routes.␊ - */␊ - staticRoutes?: (StaticRoute1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * List of all Static Routes.␊ - */␊ - export interface StaticRoute1 {␊ - /**␊ - * The name of the StaticRoute that is unique within a VnetRoute.␊ - */␊ - name?: string␊ - /**␊ - * List of all address prefixes.␊ - */␊ - addressPrefixes?: (string[] | string)␊ - /**␊ - * The ip address of the next hop.␊ - */␊ - nextHopIpAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/expressRouteGateways/expressRouteConnections␊ - */␊ - export interface ExpressRouteGatewaysExpressRouteConnections9 {␊ - name: string␊ - type: "Microsoft.Network/expressRouteGateways/expressRouteConnections"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Properties of the express route connection.␊ - */␊ - properties: (ExpressRouteConnectionProperties9 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ExpressRoutePorts␊ - */␊ - export interface ExpressRoutePorts14 {␊ - name: string␊ - type: "Microsoft.Network/ExpressRoutePorts"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * ExpressRoutePort properties.␊ - */␊ - properties: (ExpressRoutePortPropertiesFormat14 | string)␊ - /**␊ - * The identity of ExpressRoutePort, if configured.␊ - */␊ - identity?: (ManagedServiceIdentity13 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to ExpressRoutePort resources.␊ - */␊ - export interface ExpressRoutePortPropertiesFormat14 {␊ - /**␊ - * The name of the peering location that the ExpressRoutePort is mapped to physically.␊ - */␊ - peeringLocation?: string␊ - /**␊ - * Bandwidth of procured ports in Gbps.␊ - */␊ - bandwidthInGbps?: (number | string)␊ - /**␊ - * Encapsulation method on physical ports.␊ - */␊ - encapsulation?: (("Dot1Q" | "QinQ") | string)␊ - /**␊ - * The set of physical links of the ExpressRoutePort resource.␊ - */␊ - links?: (ExpressRouteLink14[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ExpressRouteLink child resource definition.␊ - */␊ - export interface ExpressRouteLink14 {␊ - /**␊ - * ExpressRouteLink properties.␊ - */␊ - properties?: (ExpressRouteLinkPropertiesFormat14 | string)␊ - /**␊ - * Name of child port resource that is unique among child port resources of the parent.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to ExpressRouteLink resources.␊ - */␊ - export interface ExpressRouteLinkPropertiesFormat14 {␊ - /**␊ - * Administrative state of the physical port.␊ - */␊ - adminState?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * MacSec configuration.␊ - */␊ - macSecConfig?: (ExpressRouteLinkMacSecConfig7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ExpressRouteLink Mac Security Configuration.␊ - */␊ - export interface ExpressRouteLinkMacSecConfig7 {␊ - /**␊ - * Keyvault Secret Identifier URL containing Mac security CKN key.␊ - */␊ - cknSecretIdentifier?: string␊ - /**␊ - * Keyvault Secret Identifier URL containing Mac security CAK key.␊ - */␊ - cakSecretIdentifier?: string␊ - /**␊ - * Mac security cipher.␊ - */␊ - cipher?: (("gcm-aes-128" | "gcm-aes-256") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/firewallPolicies␊ - */␊ - export interface FirewallPolicies8 {␊ - name: string␊ - type: "Microsoft.Network/firewallPolicies"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the firewall policy.␊ - */␊ - properties: (FirewallPolicyPropertiesFormat8 | string)␊ - /**␊ - * The identity of the firewall policy.␊ - */␊ - identity?: (ManagedServiceIdentity13 | string)␊ - resources?: FirewallPoliciesRuleCollectionGroupsChildResource[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Firewall Policy definition.␊ - */␊ - export interface FirewallPolicyPropertiesFormat8 {␊ - /**␊ - * The parent firewall policy from which rules are inherited.␊ - */␊ - basePolicy?: (SubResource35 | string)␊ - /**␊ - * The operation mode for Threat Intelligence.␊ - */␊ - threatIntelMode?: (("Alert" | "Deny" | "Off") | string)␊ - /**␊ - * ThreatIntel Whitelist for Firewall Policy.␊ - */␊ - threatIntelWhitelist?: (FirewallPolicyThreatIntelWhitelist1 | string)␊ - /**␊ - * The operation mode for Intrusion system.␊ - */␊ - intrusionSystemMode?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * TLS Configuration definition.␊ - */␊ - transportSecurity?: (FirewallPolicyTransportSecurity1 | string)␊ - /**␊ - * DNS Proxy Settings definition.␊ - */␊ - dnsSettings?: (DnsSettings | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ThreatIntel Whitelist for Firewall Policy.␊ - */␊ - export interface FirewallPolicyThreatIntelWhitelist1 {␊ - /**␊ - * List of IP addresses for the ThreatIntel Whitelist.␊ - */␊ - ipAddresses?: (string[] | string)␊ - /**␊ - * List of FQDNs for the ThreatIntel Whitelist.␊ - */␊ - fqdns?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Configuration needed to perform TLS termination & initiation.␊ - */␊ - export interface FirewallPolicyTransportSecurity1 {␊ - /**␊ - * The CA used for intermediate CA generation.␊ - */␊ - certificateAuthority?: (FirewallPolicyCertificateAuthority1 | string)␊ - /**␊ - * List of domains which are excluded from TLS termination.␊ - */␊ - excludedDomains?: (string[] | string)␊ - /**␊ - * Certificates which are to be trusted by the firewall.␊ - */␊ - trustedRootCertificates?: (FirewallPolicyTrustedRootCertificate1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trusted Root certificates properties for tls.␊ - */␊ - export interface FirewallPolicyCertificateAuthority1 {␊ - /**␊ - * Properties of the certificate authority.␊ - */␊ - properties?: (FirewallPolicyCertificateAuthorityPropertiesFormat1 | string)␊ - /**␊ - * Name of the CA certificate.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trusted Root certificates properties for tls.␊ - */␊ - export interface FirewallPolicyCertificateAuthorityPropertiesFormat1 {␊ - /**␊ - * Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault.␊ - */␊ - keyVaultSecretId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trusted Root certificates of a firewall policy.␊ - */␊ - export interface FirewallPolicyTrustedRootCertificate1 {␊ - /**␊ - * Properties of the trusted root authorities.␊ - */␊ - properties?: (FirewallPolicyTrustedRootCertificatePropertiesFormat1 | string)␊ - /**␊ - * Name of the trusted root certificate that is unique within a firewall policy.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trusted Root certificates properties for tls.␊ - */␊ - export interface FirewallPolicyTrustedRootCertificatePropertiesFormat1 {␊ - /**␊ - * Secret Id of (base-64 encoded unencrypted pfx) the public certificate data stored in KeyVault.␊ - */␊ - keyVaultSecretId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DNS Proxy Settings in Firewall Policy.␊ - */␊ - export interface DnsSettings {␊ - /**␊ - * List of Custom DNS Servers.␊ - */␊ - servers?: (string[] | string)␊ - /**␊ - * Enable DNS Proxy on Firewalls attached to the Firewall Policy.␊ - */␊ - enableProxy?: (boolean | string)␊ - /**␊ - * FQDNs in Network Rules are supported when set to true.␊ - */␊ - requireProxyForNetworkRules?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/firewallPolicies/ruleCollectionGroups␊ - */␊ - export interface FirewallPoliciesRuleCollectionGroupsChildResource {␊ - name: string␊ - type: "ruleCollectionGroups"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * The properties of the firewall policy rule collection group.␊ - */␊ - properties: (FirewallPolicyRuleCollectionGroupProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the rule collection group.␊ - */␊ - export interface FirewallPolicyRuleCollectionGroupProperties {␊ - /**␊ - * Priority of the Firewall Policy Rule Collection Group resource.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * Group of Firewall Policy rule collections.␊ - */␊ - ruleCollections?: (FirewallPolicyRuleCollection[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the FirewallPolicyNatRuleCollectionAction.␊ - */␊ - export interface FirewallPolicyNatRuleCollectionAction {␊ - /**␊ - * The type of action.␊ - */␊ - type?: "DNAT"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the application rule protocol.␊ - */␊ - export interface FirewallPolicyRuleApplicationProtocol {␊ - /**␊ - * Protocol type.␊ - */␊ - protocolType?: (("Http" | "Https") | string)␊ - /**␊ - * Port number for the protocol, cannot be greater than 64000.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the FirewallPolicyFilterRuleCollectionAction.␊ - */␊ - export interface FirewallPolicyFilterRuleCollectionAction {␊ - /**␊ - * The type of action.␊ - */␊ - type?: ("Allow" | "Deny")␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/firewallPolicies/ruleCollectionGroups␊ - */␊ - export interface FirewallPoliciesRuleCollectionGroups {␊ - name: string␊ - type: "Microsoft.Network/firewallPolicies/ruleCollectionGroups"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * The properties of the firewall policy rule collection group.␊ - */␊ - properties: (FirewallPolicyRuleCollectionGroupProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/IpAllocations␊ - */␊ - export interface IpAllocations2 {␊ - name: string␊ - type: "Microsoft.Network/IpAllocations"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the IpAllocation.␊ - */␊ - properties: (IpAllocationPropertiesFormat2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the IpAllocation.␊ - */␊ - export interface IpAllocationPropertiesFormat2 {␊ - /**␊ - * The type for the IpAllocation.␊ - */␊ - type?: ("Undefined" | "Hypernet")␊ - /**␊ - * The address prefix for the IpAllocation.␊ - */␊ - prefix?: string␊ - /**␊ - * The address prefix length for the IpAllocation.␊ - */␊ - prefixLength?: ((number & string) | string)␊ - /**␊ - * The address prefix Type for the IpAllocation.␊ - */␊ - prefixType?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The IPAM allocation ID.␊ - */␊ - ipamAllocationId?: string␊ - /**␊ - * IpAllocation tags.␊ - */␊ - allocationTags?: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/ipGroups␊ - */␊ - export interface IpGroups5 {␊ - name: string␊ - type: "Microsoft.Network/ipGroups"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the IpGroups.␊ - */␊ - properties: (IpGroupPropertiesFormat5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The IpGroups property information.␊ - */␊ - export interface IpGroupPropertiesFormat5 {␊ - /**␊ - * IpAddresses/IpAddressPrefixes in the IpGroups resource.␊ - */␊ - ipAddresses?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers␊ - */␊ - export interface LoadBalancers35 {␊ - name: string␊ - type: "Microsoft.Network/loadBalancers"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The load balancer SKU.␊ - */␊ - sku?: (LoadBalancerSku23 | string)␊ - /**␊ - * Properties of load balancer.␊ - */␊ - properties: (LoadBalancerPropertiesFormat27 | string)␊ - resources?: (LoadBalancersInboundNatRulesChildResource23 | LoadBalancersBackendAddressPoolsChildResource1)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a load balancer.␊ - */␊ - export interface LoadBalancerSku23 {␊ - /**␊ - * Name of a load balancer SKU.␊ - */␊ - name?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer.␊ - */␊ - export interface LoadBalancerPropertiesFormat27 {␊ - /**␊ - * Object representing the frontend IPs to be used for the load balancer.␊ - */␊ - frontendIPConfigurations?: (FrontendIPConfiguration26[] | string)␊ - /**␊ - * Collection of backend address pools used by a load balancer.␊ - */␊ - backendAddressPools?: (BackendAddressPool27[] | string)␊ - /**␊ - * Object collection representing the load balancing rules Gets the provisioning.␊ - */␊ - loadBalancingRules?: (LoadBalancingRule27[] | string)␊ - /**␊ - * Collection of probe objects used in the load balancer.␊ - */␊ - probes?: (Probe27[] | string)␊ - /**␊ - * Collection of inbound NAT Rules used by a load balancer. Defining inbound NAT rules on your load balancer is mutually exclusive with defining an inbound NAT pool. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an Inbound NAT pool. They have to reference individual inbound NAT rules.␊ - */␊ - inboundNatRules?: (InboundNatRule28[] | string)␊ - /**␊ - * Defines an external port range for inbound NAT to a single backend port on NICs associated with a load balancer. Inbound NAT rules are created automatically for each NIC associated with the Load Balancer using an external port from this range. Defining an Inbound NAT pool on your Load Balancer is mutually exclusive with defining inbound Nat rules. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an inbound NAT pool. They have to reference individual inbound NAT rules.␊ - */␊ - inboundNatPools?: (InboundNatPool28[] | string)␊ - /**␊ - * The outbound rules.␊ - */␊ - outboundRules?: (OutboundRule15[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Frontend IP address of the load balancer.␊ - */␊ - export interface FrontendIPConfiguration26 {␊ - /**␊ - * Properties of the load balancer probe.␊ - */␊ - properties?: (FrontendIPConfigurationPropertiesFormat26 | string)␊ - /**␊ - * The name of the resource that is unique within the set of frontend IP configurations used by the load balancer. This name can be used to access the resource.␊ - */␊ - name: string␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Frontend IP Configuration of the load balancer.␊ - */␊ - export interface FrontendIPConfigurationPropertiesFormat26 {␊ - /**␊ - * The private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The Private IP allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4.␊ - */␊ - privateIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The reference to the subnet resource.␊ - */␊ - subnet?: (SubResource35 | string)␊ - /**␊ - * The reference to the Public IP resource.␊ - */␊ - publicIPAddress?: (SubResource35 | string)␊ - /**␊ - * The reference to the Public IP Prefix resource.␊ - */␊ - publicIPPrefix?: (SubResource35 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Pool of backend IP addresses.␊ - */␊ - export interface BackendAddressPool27 {␊ - /**␊ - * Properties of load balancer backend address pool.␊ - */␊ - properties?: (BackendAddressPoolPropertiesFormat25 | string)␊ - /**␊ - * The name of the resource that is unique within the set of backend address pools used by the load balancer. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the backend address pool.␊ - */␊ - export interface BackendAddressPoolPropertiesFormat25 {␊ - /**␊ - * An array of backend addresses.␊ - */␊ - loadBalancerBackendAddresses?: (LoadBalancerBackendAddress1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Load balancer backend addresses.␊ - */␊ - export interface LoadBalancerBackendAddress1 {␊ - /**␊ - * Properties of load balancer backend address pool.␊ - */␊ - properties?: (LoadBalancerBackendAddressPropertiesFormat1 | string)␊ - /**␊ - * Name of the backend address.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer backend addresses.␊ - */␊ - export interface LoadBalancerBackendAddressPropertiesFormat1 {␊ - /**␊ - * Reference to an existing virtual network.␊ - */␊ - virtualNetwork?: (SubResource35 | string)␊ - /**␊ - * IP Address belonging to the referenced virtual network.␊ - */␊ - ipAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A load balancing rule for a load balancer.␊ - */␊ - export interface LoadBalancingRule27 {␊ - /**␊ - * Properties of load balancer load balancing rule.␊ - */␊ - properties?: (LoadBalancingRulePropertiesFormat27 | string)␊ - /**␊ - * The name of the resource that is unique within the set of load balancing rules used by the load balancer. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the load balancer.␊ - */␊ - export interface LoadBalancingRulePropertiesFormat27 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource35 | string)␊ - /**␊ - * A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs.␊ - */␊ - backendAddressPool?: (SubResource35 | string)␊ - /**␊ - * The reference to the load balancer probe used by the load balancing rule.␊ - */␊ - probe?: (SubResource35 | string)␊ - /**␊ - * The reference to the transport protocol used by the load balancing rule.␊ - */␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The load distribution policy for this rule.␊ - */␊ - loadDistribution?: (("Default" | "SourceIP" | "SourceIPProtocol") | string)␊ - /**␊ - * The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 0 and 65534. Note that value 0 enables "Any Port".␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port".␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - /**␊ - * Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule.␊ - */␊ - disableOutboundSnat?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A load balancer probe.␊ - */␊ - export interface Probe27 {␊ - /**␊ - * Properties of load balancer probe.␊ - */␊ - properties?: (ProbePropertiesFormat27 | string)␊ - /**␊ - * The name of the resource that is unique within the set of probes used by the load balancer. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Load balancer probe resource.␊ - */␊ - export interface ProbePropertiesFormat27 {␊ - /**␊ - * The protocol of the end point. If 'Tcp' is specified, a received ACK is required for the probe to be successful. If 'Http' or 'Https' is specified, a 200 OK response from the specifies URI is required for the probe to be successful.␊ - */␊ - protocol: (("Http" | "Tcp" | "Https") | string)␊ - /**␊ - * The port for communicating the probe. Possible values range from 1 to 65535, inclusive.␊ - */␊ - port: (number | string)␊ - /**␊ - * The interval, in seconds, for how frequently to probe the endpoint for health status. Typically, the interval is slightly less than half the allocated timeout period (in seconds) which allows two full probes before taking the instance out of rotation. The default value is 15, the minimum value is 5.␊ - */␊ - intervalInSeconds?: (number | string)␊ - /**␊ - * The number of probes where if no response, will result in stopping further traffic from being delivered to the endpoint. This values allows endpoints to be taken out of rotation faster or slower than the typical times used in Azure.␊ - */␊ - numberOfProbes: (number | string)␊ - /**␊ - * The URI used for requesting health status from the VM. Path is required if a protocol is set to http. Otherwise, it is not allowed. There is no default value.␊ - */␊ - requestPath?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT rule of the load balancer.␊ - */␊ - export interface InboundNatRule28 {␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties?: (InboundNatRulePropertiesFormat27 | string)␊ - /**␊ - * The name of the resource that is unique within the set of inbound NAT rules used by the load balancer. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the inbound NAT rule.␊ - */␊ - export interface InboundNatRulePropertiesFormat27 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource35 | string)␊ - /**␊ - * The reference to the transport protocol used by the load balancing rule.␊ - */␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values range from 1 to 65534.␊ - */␊ - frontendPort: (number | string)␊ - /**␊ - * The port used for the internal endpoint. Acceptable values range from 1 to 65535.␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound NAT pool of the load balancer.␊ - */␊ - export interface InboundNatPool28 {␊ - /**␊ - * Properties of load balancer inbound nat pool.␊ - */␊ - properties?: (InboundNatPoolPropertiesFormat27 | string)␊ - /**␊ - * The name of the resource that is unique within the set of inbound NAT pools used by the load balancer. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Inbound NAT pool.␊ - */␊ - export interface InboundNatPoolPropertiesFormat27 {␊ - /**␊ - * A reference to frontend IP addresses.␊ - */␊ - frontendIPConfiguration: (SubResource35 | string)␊ - /**␊ - * The reference to the transport protocol used by the inbound NAT pool.␊ - */␊ - protocol: (("Udp" | "Tcp" | "All") | string)␊ - /**␊ - * The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65534.␊ - */␊ - frontendPortRangeStart: (number | string)␊ - /**␊ - * The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65535.␊ - */␊ - frontendPortRangeEnd: (number | string)␊ - /**␊ - * The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.␊ - */␊ - backendPort: (number | string)␊ - /**␊ - * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.␊ - */␊ - enableFloatingIP?: (boolean | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound rule of the load balancer.␊ - */␊ - export interface OutboundRule15 {␊ - /**␊ - * Properties of load balancer outbound rule.␊ - */␊ - properties?: (OutboundRulePropertiesFormat15 | string)␊ - /**␊ - * The name of the resource that is unique within the set of outbound rules used by the load balancer. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound rule of the load balancer.␊ - */␊ - export interface OutboundRulePropertiesFormat15 {␊ - /**␊ - * The number of outbound ports to be used for NAT.␊ - */␊ - allocatedOutboundPorts?: (number | string)␊ - /**␊ - * The Frontend IP addresses of the load balancer.␊ - */␊ - frontendIPConfigurations: (SubResource35[] | string)␊ - /**␊ - * A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs.␊ - */␊ - backendAddressPool: (SubResource35 | string)␊ - /**␊ - * The protocol for the outbound rule in load balancer.␊ - */␊ - protocol: (("Tcp" | "Udp" | "All") | string)␊ - /**␊ - * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.␊ - */␊ - enableTcpReset?: (boolean | string)␊ - /**␊ - * The timeout for the TCP idle connection.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers/inboundNatRules␊ - */␊ - export interface LoadBalancersInboundNatRulesChildResource23 {␊ - name: string␊ - type: "inboundNatRules"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties: (InboundNatRulePropertiesFormat27 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers/backendAddressPools␊ - */␊ - export interface LoadBalancersBackendAddressPoolsChildResource1 {␊ - name: string␊ - type: "backendAddressPools"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Properties of load balancer backend address pool.␊ - */␊ - properties: (BackendAddressPoolPropertiesFormat25 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers/backendAddressPools␊ - */␊ - export interface LoadBalancersBackendAddressPools1 {␊ - name: string␊ - type: "Microsoft.Network/loadBalancers/backendAddressPools"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Properties of load balancer backend address pool.␊ - */␊ - properties: (BackendAddressPoolPropertiesFormat25 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/loadBalancers/inboundNatRules␊ - */␊ - export interface LoadBalancersInboundNatRules23 {␊ - name: string␊ - type: "Microsoft.Network/loadBalancers/inboundNatRules"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Properties of load balancer inbound nat rule.␊ - */␊ - properties: (InboundNatRulePropertiesFormat27 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/localNetworkGateways␊ - */␊ - export interface LocalNetworkGateways27 {␊ - name: string␊ - type: "Microsoft.Network/localNetworkGateways"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the local network gateway.␊ - */␊ - properties: (LocalNetworkGatewayPropertiesFormat27 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * LocalNetworkGateway properties.␊ - */␊ - export interface LocalNetworkGatewayPropertiesFormat27 {␊ - /**␊ - * Local network site address space.␊ - */␊ - localNetworkAddressSpace?: (AddressSpace35 | string)␊ - /**␊ - * IP address of local network gateway.␊ - */␊ - gatewayIpAddress?: string␊ - /**␊ - * FQDN of local network gateway.␊ - */␊ - fqdn?: string␊ - /**␊ - * Local network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings26 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.␊ - */␊ - export interface AddressSpace35 {␊ - /**␊ - * A list of address blocks reserved for this virtual network in CIDR notation.␊ - */␊ - addressPrefixes: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * BGP settings details.␊ - */␊ - export interface BgpSettings26 {␊ - /**␊ - * The BGP speaker's ASN.␊ - */␊ - asn?: (number | string)␊ - /**␊ - * The BGP peering address and BGP identifier of this BGP speaker.␊ - */␊ - bgpPeeringAddress?: string␊ - /**␊ - * The weight added to routes learned from this BGP speaker.␊ - */␊ - peerWeight?: (number | string)␊ - /**␊ - * BGP peering address with IP configuration ID for virtual network gateway.␊ - */␊ - bgpPeeringAddresses?: (IPConfigurationBgpPeeringAddress3[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IPConfigurationBgpPeeringAddress.␊ - */␊ - export interface IPConfigurationBgpPeeringAddress3 {␊ - /**␊ - * The ID of IP configuration which belongs to gateway.␊ - */␊ - ipconfigurationId?: string␊ - /**␊ - * The list of custom BGP peering addresses which belong to IP configuration.␊ - */␊ - customBgpIpAddresses?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/natGateways␊ - */␊ - export interface NatGateways10 {␊ - name: string␊ - type: "Microsoft.Network/natGateways"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The nat gateway SKU.␊ - */␊ - sku?: (NatGatewaySku10 | string)␊ - /**␊ - * Nat Gateway properties.␊ - */␊ - properties: (NatGatewayPropertiesFormat10 | string)␊ - /**␊ - * A list of availability zones denoting the zone in which Nat Gateway should be deployed.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of nat gateway.␊ - */␊ - export interface NatGatewaySku10 {␊ - /**␊ - * Name of Nat Gateway SKU.␊ - */␊ - name?: ("Standard" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Nat Gateway properties.␊ - */␊ - export interface NatGatewayPropertiesFormat10 {␊ - /**␊ - * The idle timeout of the nat gateway.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * An array of public ip addresses associated with the nat gateway resource.␊ - */␊ - publicIpAddresses?: (SubResource35[] | string)␊ - /**␊ - * An array of public ip prefixes associated with the nat gateway resource.␊ - */␊ - publicIpPrefixes?: (SubResource35[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces␊ - */␊ - export interface NetworkInterfaces36 {␊ - name: string␊ - type: "Microsoft.Network/networkInterfaces"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network interface.␊ - */␊ - properties: (NetworkInterfacePropertiesFormat27 | string)␊ - resources?: NetworkInterfacesTapConfigurationsChildResource14[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NetworkInterface properties.␊ - */␊ - export interface NetworkInterfacePropertiesFormat27 {␊ - /**␊ - * The reference to the NetworkSecurityGroup resource.␊ - */␊ - networkSecurityGroup?: (SubResource35 | string)␊ - /**␊ - * A list of IPConfigurations of the network interface.␊ - */␊ - ipConfigurations: (NetworkInterfaceIPConfiguration26[] | string)␊ - /**␊ - * The DNS settings in network interface.␊ - */␊ - dnsSettings?: (NetworkInterfaceDnsSettings35 | string)␊ - /**␊ - * If the network interface is accelerated networking enabled.␊ - */␊ - enableAcceleratedNetworking?: (boolean | string)␊ - /**␊ - * Indicates whether IP forwarding is enabled on this network interface.␊ - */␊ - enableIPForwarding?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IPConfiguration in a network interface.␊ - */␊ - export interface NetworkInterfaceIPConfiguration26 {␊ - /**␊ - * Network interface IP configuration properties.␊ - */␊ - properties?: (NetworkInterfaceIPConfigurationPropertiesFormat26 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration.␊ - */␊ - export interface NetworkInterfaceIPConfigurationPropertiesFormat26 {␊ - /**␊ - * The reference to Virtual Network Taps.␊ - */␊ - virtualNetworkTaps?: (SubResource35[] | string)␊ - /**␊ - * The reference to ApplicationGatewayBackendAddressPool resource.␊ - */␊ - applicationGatewayBackendAddressPools?: (SubResource35[] | string)␊ - /**␊ - * The reference to LoadBalancerBackendAddressPool resource.␊ - */␊ - loadBalancerBackendAddressPools?: (SubResource35[] | string)␊ - /**␊ - * A list of references of LoadBalancerInboundNatRules.␊ - */␊ - loadBalancerInboundNatRules?: (SubResource35[] | string)␊ - /**␊ - * Private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The private IP address allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4.␊ - */␊ - privateIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * Subnet bound to the IP configuration.␊ - */␊ - subnet?: (SubResource35 | string)␊ - /**␊ - * Whether this is a primary customer address on the network interface.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * Public IP address bound to the IP configuration.␊ - */␊ - publicIPAddress?: (SubResource35 | string)␊ - /**␊ - * Application security groups in which the IP configuration is included.␊ - */␊ - applicationSecurityGroups?: (SubResource35[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DNS settings of a network interface.␊ - */␊ - export interface NetworkInterfaceDnsSettings35 {␊ - /**␊ - * List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only value in dnsServers collection.␊ - */␊ - dnsServers?: (string[] | string)␊ - /**␊ - * Relative DNS name for this NIC used for internal communications between VMs in the same virtual network.␊ - */␊ - internalDnsNameLabel?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces/tapConfigurations␊ - */␊ - export interface NetworkInterfacesTapConfigurationsChildResource14 {␊ - name: string␊ - type: "tapConfigurations"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Properties of the Virtual Network Tap configuration.␊ - */␊ - properties: (NetworkInterfaceTapConfigurationPropertiesFormat14 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Virtual Network Tap configuration.␊ - */␊ - export interface NetworkInterfaceTapConfigurationPropertiesFormat14 {␊ - /**␊ - * The reference to the Virtual Network Tap resource.␊ - */␊ - virtualNetworkTap?: (SubResource35 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkInterfaces/tapConfigurations␊ - */␊ - export interface NetworkInterfacesTapConfigurations14 {␊ - name: string␊ - type: "Microsoft.Network/networkInterfaces/tapConfigurations"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Properties of the Virtual Network Tap configuration.␊ - */␊ - properties: (NetworkInterfaceTapConfigurationPropertiesFormat14 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkProfiles␊ - */␊ - export interface NetworkProfiles9 {␊ - name: string␊ - type: "Microsoft.Network/networkProfiles"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Network profile properties.␊ - */␊ - properties: (NetworkProfilePropertiesFormat9 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network profile properties.␊ - */␊ - export interface NetworkProfilePropertiesFormat9 {␊ - /**␊ - * List of chid container network interface configurations.␊ - */␊ - containerNetworkInterfaceConfigurations?: (ContainerNetworkInterfaceConfiguration9[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Container network interface configuration child resource.␊ - */␊ - export interface ContainerNetworkInterfaceConfiguration9 {␊ - /**␊ - * Container network interface configuration properties.␊ - */␊ - properties?: (ContainerNetworkInterfaceConfigurationPropertiesFormat9 | string)␊ - /**␊ - * The name of the resource. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Container network interface configuration properties.␊ - */␊ - export interface ContainerNetworkInterfaceConfigurationPropertiesFormat9 {␊ - /**␊ - * A list of ip configurations of the container network interface configuration.␊ - */␊ - ipConfigurations?: (IPConfigurationProfile9[] | string)␊ - /**␊ - * A list of container network interfaces created from this container network interface configuration.␊ - */␊ - containerNetworkInterfaces?: (SubResource35[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration profile child resource.␊ - */␊ - export interface IPConfigurationProfile9 {␊ - /**␊ - * Properties of the IP configuration profile.␊ - */␊ - properties?: (IPConfigurationProfilePropertiesFormat9 | string)␊ - /**␊ - * The name of the resource. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration profile properties.␊ - */␊ - export interface IPConfigurationProfilePropertiesFormat9 {␊ - /**␊ - * The reference to the subnet resource to create a container network interface ip configuration.␊ - */␊ - subnet?: (SubResource35 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups␊ - */␊ - export interface NetworkSecurityGroups35 {␊ - name: string␊ - type: "Microsoft.Network/networkSecurityGroups"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network security group.␊ - */␊ - properties: (NetworkSecurityGroupPropertiesFormat27 | string)␊ - resources?: NetworkSecurityGroupsSecurityRulesChildResource27[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network Security Group resource.␊ - */␊ - export interface NetworkSecurityGroupPropertiesFormat27 {␊ - /**␊ - * A collection of security rules of the network security group.␊ - */␊ - securityRules?: (SecurityRule27[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network security rule.␊ - */␊ - export interface SecurityRule27 {␊ - /**␊ - * Properties of the security rule.␊ - */␊ - properties?: (SecurityRulePropertiesFormat27 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Security rule resource.␊ - */␊ - export interface SecurityRulePropertiesFormat27 {␊ - /**␊ - * A description for this rule. Restricted to 140 chars.␊ - */␊ - description?: string␊ - /**␊ - * Network protocol this rule applies to.␊ - */␊ - protocol: (("Tcp" | "Udp" | "Icmp" | "Esp" | "*" | "Ah") | string)␊ - /**␊ - * The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.␊ - */␊ - sourcePortRange?: string␊ - /**␊ - * The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.␊ - */␊ - destinationPortRange?: string␊ - /**␊ - * The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from.␊ - */␊ - sourceAddressPrefix?: string␊ - /**␊ - * The CIDR or source IP ranges.␊ - */␊ - sourceAddressPrefixes?: (string[] | string)␊ - /**␊ - * The application security group specified as source.␊ - */␊ - sourceApplicationSecurityGroups?: (SubResource35[] | string)␊ - /**␊ - * The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used.␊ - */␊ - destinationAddressPrefix?: string␊ - /**␊ - * The destination address prefixes. CIDR or destination IP ranges.␊ - */␊ - destinationAddressPrefixes?: (string[] | string)␊ - /**␊ - * The application security group specified as destination.␊ - */␊ - destinationApplicationSecurityGroups?: (SubResource35[] | string)␊ - /**␊ - * The source port ranges.␊ - */␊ - sourcePortRanges?: (string[] | string)␊ - /**␊ - * The destination port ranges.␊ - */␊ - destinationPortRanges?: (string[] | string)␊ - /**␊ - * The network traffic is allowed or denied.␊ - */␊ - access: (("Allow" | "Deny") | string)␊ - /**␊ - * The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.␊ - */␊ - priority: (number | string)␊ - /**␊ - * The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic.␊ - */␊ - direction: (("Inbound" | "Outbound") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRulesChildResource27 {␊ - name: string␊ - type: "securityRules"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Properties of the security rule.␊ - */␊ - properties: (SecurityRulePropertiesFormat27 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkSecurityGroups/securityRules␊ - */␊ - export interface NetworkSecurityGroupsSecurityRules27 {␊ - name: string␊ - type: "Microsoft.Network/networkSecurityGroups/securityRules"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Properties of the security rule.␊ - */␊ - properties: (SecurityRulePropertiesFormat27 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkVirtualAppliances␊ - */␊ - export interface NetworkVirtualAppliances3 {␊ - name: string␊ - type: "Microsoft.Network/networkVirtualAppliances"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the Network Virtual Appliance.␊ - */␊ - properties: (NetworkVirtualAppliancePropertiesFormat3 | string)␊ - /**␊ - * The service principal that has read access to cloud-init and config blob.␊ - */␊ - identity?: (ManagedServiceIdentity13 | string)␊ - resources?: NetworkVirtualAppliancesVirtualApplianceSitesChildResource[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network Virtual Appliance definition.␊ - */␊ - export interface NetworkVirtualAppliancePropertiesFormat3 {␊ - /**␊ - * Network Virtual Appliance SKU.␊ - */␊ - nvaSku?: (VirtualApplianceSkuProperties3 | string)␊ - /**␊ - * BootStrapConfigurationBlobs storage URLs.␊ - */␊ - bootStrapConfigurationBlobs?: (string[] | string)␊ - /**␊ - * The Virtual Hub where Network Virtual Appliance is being deployed.␊ - */␊ - virtualHub?: (SubResource35 | string)␊ - /**␊ - * CloudInitConfigurationBlob storage URLs.␊ - */␊ - cloudInitConfigurationBlobs?: (string[] | string)␊ - /**␊ - * CloudInitConfiguration string in plain text.␊ - */␊ - cloudInitConfiguration?: string␊ - /**␊ - * VirtualAppliance ASN.␊ - */␊ - virtualApplianceAsn?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network Virtual Appliance Sku Properties.␊ - */␊ - export interface VirtualApplianceSkuProperties3 {␊ - /**␊ - * Virtual Appliance Vendor.␊ - */␊ - vendor?: string␊ - /**␊ - * Virtual Appliance Scale Unit.␊ - */␊ - bundledScaleUnit?: string␊ - /**␊ - * Virtual Appliance Version.␊ - */␊ - marketPlaceVersion?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkVirtualAppliances/virtualApplianceSites␊ - */␊ - export interface NetworkVirtualAppliancesVirtualApplianceSitesChildResource {␊ - name: string␊ - type: "virtualApplianceSites"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * The properties of the Virtual Appliance Sites.␊ - */␊ - properties: (VirtualApplianceSiteProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the rule group.␊ - */␊ - export interface VirtualApplianceSiteProperties {␊ - /**␊ - * Address Prefix.␊ - */␊ - addressPrefix?: string␊ - /**␊ - * Office 365 Policy.␊ - */␊ - o365Policy?: (Office365PolicyProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network Virtual Appliance Sku Properties.␊ - */␊ - export interface Office365PolicyProperties {␊ - /**␊ - * Office 365 breakout categories.␊ - */␊ - breakOutCategories?: (BreakOutCategoryPolicies | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network Virtual Appliance Sku Properties.␊ - */␊ - export interface BreakOutCategoryPolicies {␊ - /**␊ - * Flag to control breakout of o365 allow category.␊ - */␊ - allow?: (boolean | string)␊ - /**␊ - * Flag to control breakout of o365 optimize category.␊ - */␊ - optimize?: (boolean | string)␊ - /**␊ - * Flag to control breakout of o365 default category.␊ - */␊ - default?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkVirtualAppliances/virtualApplianceSites␊ - */␊ - export interface NetworkVirtualAppliancesVirtualApplianceSites {␊ - name: string␊ - type: "Microsoft.Network/networkVirtualAppliances/virtualApplianceSites"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * The properties of the Virtual Appliance Sites.␊ - */␊ - properties: (VirtualApplianceSiteProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers␊ - */␊ - export interface NetworkWatchers12 {␊ - name: string␊ - type: "Microsoft.Network/networkWatchers"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the network watcher.␊ - */␊ - properties: ({␊ - [k: string]: unknown␊ - } | string)␊ - resources?: (NetworkWatchersFlowLogsChildResource4 | NetworkWatchersConnectionMonitorsChildResource9 | NetworkWatchersPacketCapturesChildResource12)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/flowLogs␊ - */␊ - export interface NetworkWatchersFlowLogsChildResource4 {␊ - name: string␊ - type: "flowLogs"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the flow log.␊ - */␊ - properties: (FlowLogPropertiesFormat4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters that define the configuration of flow log.␊ - */␊ - export interface FlowLogPropertiesFormat4 {␊ - /**␊ - * ID of network security group to which flow log will be applied.␊ - */␊ - targetResourceId: string␊ - /**␊ - * ID of the storage account which is used to store the flow log.␊ - */␊ - storageId: string␊ - /**␊ - * Flag to enable/disable flow logging.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Parameters that define the retention policy for flow log.␊ - */␊ - retentionPolicy?: (RetentionPolicyParameters4 | string)␊ - /**␊ - * Parameters that define the flow log format.␊ - */␊ - format?: (FlowLogFormatParameters4 | string)␊ - /**␊ - * Parameters that define the configuration of traffic analytics.␊ - */␊ - flowAnalyticsConfiguration?: (TrafficAnalyticsProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters that define the retention policy for flow log.␊ - */␊ - export interface RetentionPolicyParameters4 {␊ - /**␊ - * Number of days to retain flow log records.␊ - */␊ - days?: ((number & string) | string)␊ - /**␊ - * Flag to enable/disable retention.␊ - */␊ - enabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters that define the flow log format.␊ - */␊ - export interface FlowLogFormatParameters4 {␊ - /**␊ - * The file type of flow log.␊ - */␊ - type?: "JSON"␊ - /**␊ - * The version (revision) of the flow log.␊ - */␊ - version?: ((number & string) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters that define the configuration of traffic analytics.␊ - */␊ - export interface TrafficAnalyticsProperties4 {␊ - /**␊ - * Parameters that define the configuration of traffic analytics.␊ - */␊ - networkWatcherFlowAnalyticsConfiguration?: (TrafficAnalyticsConfigurationProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters that define the configuration of traffic analytics.␊ - */␊ - export interface TrafficAnalyticsConfigurationProperties4 {␊ - /**␊ - * Flag to enable/disable traffic analytics.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * The resource guid of the attached workspace.␊ - */␊ - workspaceId?: string␊ - /**␊ - * The location of the attached workspace.␊ - */␊ - workspaceRegion?: string␊ - /**␊ - * Resource Id of the attached workspace.␊ - */␊ - workspaceResourceId?: string␊ - /**␊ - * The interval in minutes which would decide how frequently TA service should do flow analytics.␊ - */␊ - trafficAnalyticsInterval?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/connectionMonitors␊ - */␊ - export interface NetworkWatchersConnectionMonitorsChildResource9 {␊ - name: string␊ - type: "connectionMonitors"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Connection monitor location.␊ - */␊ - location?: string␊ - /**␊ - * Connection monitor tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the connection monitor.␊ - */␊ - properties: (ConnectionMonitorParameters9 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters that define the operation to create a connection monitor.␊ - */␊ - export interface ConnectionMonitorParameters9 {␊ - /**␊ - * Describes the source of connection monitor.␊ - */␊ - source?: (ConnectionMonitorSource9 | string)␊ - /**␊ - * Describes the destination of connection monitor.␊ - */␊ - destination?: (ConnectionMonitorDestination9 | string)␊ - /**␊ - * Determines if the connection monitor will start automatically once created.␊ - */␊ - autoStart?: (boolean | string)␊ - /**␊ - * Monitoring interval in seconds.␊ - */␊ - monitoringIntervalInSeconds?: ((number & string) | string)␊ - /**␊ - * List of connection monitor endpoints.␊ - */␊ - endpoints?: (ConnectionMonitorEndpoint4[] | string)␊ - /**␊ - * List of connection monitor test configurations.␊ - */␊ - testConfigurations?: (ConnectionMonitorTestConfiguration4[] | string)␊ - /**␊ - * List of connection monitor test groups.␊ - */␊ - testGroups?: (ConnectionMonitorTestGroup4[] | string)␊ - /**␊ - * List of connection monitor outputs.␊ - */␊ - outputs?: (ConnectionMonitorOutput4[] | string)␊ - /**␊ - * Optional notes to be associated with the connection monitor.␊ - */␊ - notes?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the source of connection monitor.␊ - */␊ - export interface ConnectionMonitorSource9 {␊ - /**␊ - * The ID of the resource used as the source by connection monitor.␊ - */␊ - resourceId: string␊ - /**␊ - * The source port used by connection monitor.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the destination of connection monitor.␊ - */␊ - export interface ConnectionMonitorDestination9 {␊ - /**␊ - * The ID of the resource used as the destination by connection monitor.␊ - */␊ - resourceId?: string␊ - /**␊ - * Address of the connection monitor destination (IP or domain name).␊ - */␊ - address?: string␊ - /**␊ - * The destination port used by connection monitor.␊ - */␊ - port?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the connection monitor endpoint.␊ - */␊ - export interface ConnectionMonitorEndpoint4 {␊ - /**␊ - * The name of the connection monitor endpoint.␊ - */␊ - name: string␊ - /**␊ - * Resource ID of the connection monitor endpoint.␊ - */␊ - resourceId?: string␊ - /**␊ - * Address of the connection monitor endpoint (IP or domain name).␊ - */␊ - address?: string␊ - /**␊ - * Filter for sub-items within the endpoint.␊ - */␊ - filter?: (ConnectionMonitorEndpointFilter4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the connection monitor endpoint filter.␊ - */␊ - export interface ConnectionMonitorEndpointFilter4 {␊ - /**␊ - * The behavior of the endpoint filter. Currently only 'Include' is supported.␊ - */␊ - type?: "Include"␊ - /**␊ - * List of items in the filter.␊ - */␊ - items?: (ConnectionMonitorEndpointFilterItem4[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the connection monitor endpoint filter item.␊ - */␊ - export interface ConnectionMonitorEndpointFilterItem4 {␊ - /**␊ - * The type of item included in the filter. Currently only 'AgentAddress' is supported.␊ - */␊ - type?: "AgentAddress"␊ - /**␊ - * The address of the filter item.␊ - */␊ - address?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a connection monitor test configuration.␊ - */␊ - export interface ConnectionMonitorTestConfiguration4 {␊ - /**␊ - * The name of the connection monitor test configuration.␊ - */␊ - name: string␊ - /**␊ - * The frequency of test evaluation, in seconds.␊ - */␊ - testFrequencySec?: (number | string)␊ - /**␊ - * The protocol to use in test evaluation.␊ - */␊ - protocol: (("Tcp" | "Http" | "Icmp") | string)␊ - /**␊ - * The preferred IP version to use in test evaluation. The connection monitor may choose to use a different version depending on other parameters.␊ - */␊ - preferredIPVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The parameters used to perform test evaluation over HTTP.␊ - */␊ - httpConfiguration?: (ConnectionMonitorHttpConfiguration4 | string)␊ - /**␊ - * The parameters used to perform test evaluation over TCP.␊ - */␊ - tcpConfiguration?: (ConnectionMonitorTcpConfiguration4 | string)␊ - /**␊ - * The parameters used to perform test evaluation over ICMP.␊ - */␊ - icmpConfiguration?: (ConnectionMonitorIcmpConfiguration4 | string)␊ - /**␊ - * The threshold for declaring a test successful.␊ - */␊ - successThreshold?: (ConnectionMonitorSuccessThreshold4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the HTTP configuration.␊ - */␊ - export interface ConnectionMonitorHttpConfiguration4 {␊ - /**␊ - * The port to connect to.␊ - */␊ - port?: (number | string)␊ - /**␊ - * The HTTP method to use.␊ - */␊ - method?: (("Get" | "Post") | string)␊ - /**␊ - * The path component of the URI. For instance, "/dir1/dir2".␊ - */␊ - path?: string␊ - /**␊ - * The HTTP headers to transmit with the request.␊ - */␊ - requestHeaders?: (HTTPHeader4[] | string)␊ - /**␊ - * HTTP status codes to consider successful. For instance, "2xx,301-304,418".␊ - */␊ - validStatusCodeRanges?: (string[] | string)␊ - /**␊ - * Value indicating whether HTTPS is preferred over HTTP in cases where the choice is not explicit.␊ - */␊ - preferHTTPS?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The HTTP header.␊ - */␊ - export interface HTTPHeader4 {␊ - /**␊ - * The name in HTTP header.␊ - */␊ - name?: string␊ - /**␊ - * The value in HTTP header.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the TCP configuration.␊ - */␊ - export interface ConnectionMonitorTcpConfiguration4 {␊ - /**␊ - * The port to connect to.␊ - */␊ - port?: (number | string)␊ - /**␊ - * Value indicating whether path evaluation with trace route should be disabled.␊ - */␊ - disableTraceRoute?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the ICMP configuration.␊ - */␊ - export interface ConnectionMonitorIcmpConfiguration4 {␊ - /**␊ - * Value indicating whether path evaluation with trace route should be disabled.␊ - */␊ - disableTraceRoute?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the threshold for declaring a test successful.␊ - */␊ - export interface ConnectionMonitorSuccessThreshold4 {␊ - /**␊ - * The maximum percentage of failed checks permitted for a test to evaluate as successful.␊ - */␊ - checksFailedPercent?: (number | string)␊ - /**␊ - * The maximum round-trip time in milliseconds permitted for a test to evaluate as successful.␊ - */␊ - roundTripTimeMs?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the connection monitor test group.␊ - */␊ - export interface ConnectionMonitorTestGroup4 {␊ - /**␊ - * The name of the connection monitor test group.␊ - */␊ - name: string␊ - /**␊ - * Value indicating whether test group is disabled.␊ - */␊ - disable?: (boolean | string)␊ - /**␊ - * List of test configuration names.␊ - */␊ - testConfigurations: (string[] | string)␊ - /**␊ - * List of source endpoint names.␊ - */␊ - sources: (string[] | string)␊ - /**␊ - * List of destination endpoint names.␊ - */␊ - destinations: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a connection monitor output destination.␊ - */␊ - export interface ConnectionMonitorOutput4 {␊ - /**␊ - * Connection monitor output destination type. Currently, only "Workspace" is supported.␊ - */␊ - type?: "Workspace"␊ - /**␊ - * Describes the settings for producing output into a log analytics workspace.␊ - */␊ - workspaceSettings?: (ConnectionMonitorWorkspaceSettings4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the settings for producing output into a log analytics workspace.␊ - */␊ - export interface ConnectionMonitorWorkspaceSettings4 {␊ - /**␊ - * Log analytics workspace resource ID.␊ - */␊ - workspaceResourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/packetCaptures␊ - */␊ - export interface NetworkWatchersPacketCapturesChildResource12 {␊ - name: string␊ - type: "packetCaptures"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Properties of the packet capture.␊ - */␊ - properties: (PacketCaptureParameters12 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters that define the create packet capture operation.␊ - */␊ - export interface PacketCaptureParameters12 {␊ - /**␊ - * The ID of the targeted resource, only VM is currently supported.␊ - */␊ - target: string␊ - /**␊ - * Number of bytes captured per packet, the remaining bytes are truncated.␊ - */␊ - bytesToCapturePerPacket?: ((number & string) | string)␊ - /**␊ - * Maximum size of the capture output.␊ - */␊ - totalBytesPerSession?: ((number & string) | string)␊ - /**␊ - * Maximum duration of the capture session in seconds.␊ - */␊ - timeLimitInSeconds?: ((number & string) | string)␊ - /**␊ - * The storage location for a packet capture session.␊ - */␊ - storageLocation: (PacketCaptureStorageLocation12 | string)␊ - /**␊ - * A list of packet capture filters.␊ - */␊ - filters?: (PacketCaptureFilter12[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The storage location for a packet capture session.␊ - */␊ - export interface PacketCaptureStorageLocation12 {␊ - /**␊ - * The ID of the storage account to save the packet capture session. Required if no local file path is provided.␊ - */␊ - storageId?: string␊ - /**␊ - * The URI of the storage path to save the packet capture. Must be a well-formed URI describing the location to save the packet capture.␊ - */␊ - storagePath?: string␊ - /**␊ - * A valid local path on the targeting VM. Must include the name of the capture file (*.cap). For linux virtual machine it must start with /var/captures. Required if no storage ID is provided, otherwise optional.␊ - */␊ - filePath?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Filter that is applied to packet capture request. Multiple filters can be applied.␊ - */␊ - export interface PacketCaptureFilter12 {␊ - /**␊ - * Protocol to be filtered on.␊ - */␊ - protocol?: (("TCP" | "UDP" | "Any") | string)␊ - /**␊ - * Local IP Address to be filtered on. Notation: "127.0.0.1" for single address entry. "127.0.0.1-127.0.0.255" for range. "127.0.0.1;127.0.0.5"? for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.␊ - */␊ - localIPAddress?: string␊ - /**␊ - * Local IP Address to be filtered on. Notation: "127.0.0.1" for single address entry. "127.0.0.1-127.0.0.255" for range. "127.0.0.1;127.0.0.5;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.␊ - */␊ - remoteIPAddress?: string␊ - /**␊ - * Local port to be filtered on. Notation: "80" for single port entry."80-85" for range. "80;443;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.␊ - */␊ - localPort?: string␊ - /**␊ - * Remote port to be filtered on. Notation: "80" for single port entry."80-85" for range. "80;443;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null.␊ - */␊ - remotePort?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/connectionMonitors␊ - */␊ - export interface NetworkWatchersConnectionMonitors9 {␊ - name: string␊ - type: "Microsoft.Network/networkWatchers/connectionMonitors"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Connection monitor location.␊ - */␊ - location?: string␊ - /**␊ - * Connection monitor tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the connection monitor.␊ - */␊ - properties: (ConnectionMonitorParameters9 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/flowLogs␊ - */␊ - export interface NetworkWatchersFlowLogs4 {␊ - name: string␊ - type: "Microsoft.Network/networkWatchers/flowLogs"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the flow log.␊ - */␊ - properties: (FlowLogPropertiesFormat4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/networkWatchers/packetCaptures␊ - */␊ - export interface NetworkWatchersPacketCaptures12 {␊ - name: string␊ - type: "Microsoft.Network/networkWatchers/packetCaptures"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Properties of the packet capture.␊ - */␊ - properties: (PacketCaptureParameters12 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/p2svpnGateways␊ - */␊ - export interface P2SvpnGateways9 {␊ - name: string␊ - type: "Microsoft.Network/p2svpnGateways"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the P2SVpnGateway.␊ - */␊ - properties: (P2SVpnGatewayProperties9 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for P2SVpnGateway.␊ - */␊ - export interface P2SVpnGatewayProperties9 {␊ - /**␊ - * The VirtualHub to which the gateway belongs.␊ - */␊ - virtualHub?: (SubResource35 | string)␊ - /**␊ - * List of all p2s connection configurations of the gateway.␊ - */␊ - p2SConnectionConfigurations?: (P2SConnectionConfiguration6[] | string)␊ - /**␊ - * The scale unit for this p2s vpn gateway.␊ - */␊ - vpnGatewayScaleUnit?: (number | string)␊ - /**␊ - * The VpnServerConfiguration to which the p2sVpnGateway is attached to.␊ - */␊ - vpnServerConfiguration?: (SubResource35 | string)␊ - /**␊ - * List of all customer specified DNS servers IP addresses.␊ - */␊ - customDnsServers?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * P2SConnectionConfiguration Resource.␊ - */␊ - export interface P2SConnectionConfiguration6 {␊ - /**␊ - * Properties of the P2S connection configuration.␊ - */␊ - properties?: (P2SConnectionConfigurationProperties6 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for P2SConnectionConfiguration.␊ - */␊ - export interface P2SConnectionConfigurationProperties6 {␊ - /**␊ - * The reference to the address space resource which represents Address space for P2S VpnClient.␊ - */␊ - vpnClientAddressPool?: (AddressSpace35 | string)␊ - /**␊ - * The Routing Configuration indicating the associated and propagated route tables on this connection.␊ - */␊ - routingConfiguration?: (RoutingConfiguration1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateEndpoints␊ - */␊ - export interface PrivateEndpoints9 {␊ - name: string␊ - type: "Microsoft.Network/privateEndpoints"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the private endpoint.␊ - */␊ - properties: (PrivateEndpointProperties9 | string)␊ - resources?: PrivateEndpointsPrivateDnsZoneGroupsChildResource2[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the private endpoint.␊ - */␊ - export interface PrivateEndpointProperties9 {␊ - /**␊ - * The ID of the subnet from which the private IP will be allocated.␊ - */␊ - subnet?: (SubResource35 | string)␊ - /**␊ - * A grouping of information about the connection to the remote resource.␊ - */␊ - privateLinkServiceConnections?: (PrivateLinkServiceConnection9[] | string)␊ - /**␊ - * A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource.␊ - */␊ - manualPrivateLinkServiceConnections?: (PrivateLinkServiceConnection9[] | string)␊ - /**␊ - * An array of custom dns configurations.␊ - */␊ - customDnsConfigs?: (CustomDnsConfigPropertiesFormat2[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * PrivateLinkServiceConnection resource.␊ - */␊ - export interface PrivateLinkServiceConnection9 {␊ - /**␊ - * Properties of the private link service connection.␊ - */␊ - properties?: (PrivateLinkServiceConnectionProperties9 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the PrivateLinkServiceConnection.␊ - */␊ - export interface PrivateLinkServiceConnectionProperties9 {␊ - /**␊ - * The resource id of private link service.␊ - */␊ - privateLinkServiceId?: string␊ - /**␊ - * The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to.␊ - */␊ - groupIds?: (string[] | string)␊ - /**␊ - * A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars.␊ - */␊ - requestMessage?: string␊ - /**␊ - * A collection of read-only information about the state of the connection to the remote resource.␊ - */␊ - privateLinkServiceConnectionState?: (PrivateLinkServiceConnectionState15 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains custom Dns resolution configuration from customer.␊ - */␊ - export interface CustomDnsConfigPropertiesFormat2 {␊ - /**␊ - * Fqdn that resolves to private endpoint ip address.␊ - */␊ - fqdn?: string␊ - /**␊ - * A list of private ip addresses of the private endpoint.␊ - */␊ - ipAddresses?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateEndpoints/privateDnsZoneGroups␊ - */␊ - export interface PrivateEndpointsPrivateDnsZoneGroupsChildResource2 {␊ - name: string␊ - type: "privateDnsZoneGroups"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Properties of the private dns zone group.␊ - */␊ - properties: (PrivateDnsZoneGroupPropertiesFormat2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the private dns zone group.␊ - */␊ - export interface PrivateDnsZoneGroupPropertiesFormat2 {␊ - /**␊ - * A collection of private dns zone configurations of the private dns zone group.␊ - */␊ - privateDnsZoneConfigs?: (PrivateDnsZoneConfig2[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * PrivateDnsZoneConfig resource.␊ - */␊ - export interface PrivateDnsZoneConfig2 {␊ - /**␊ - * Name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * Properties of the private dns zone configuration.␊ - */␊ - properties?: (PrivateDnsZonePropertiesFormat2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the private dns zone configuration resource.␊ - */␊ - export interface PrivateDnsZonePropertiesFormat2 {␊ - /**␊ - * The resource id of the private dns zone.␊ - */␊ - privateDnsZoneId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateEndpoints/privateDnsZoneGroups␊ - */␊ - export interface PrivateEndpointsPrivateDnsZoneGroups2 {␊ - name: string␊ - type: "Microsoft.Network/privateEndpoints/privateDnsZoneGroups"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Properties of the private dns zone group.␊ - */␊ - properties: (PrivateDnsZoneGroupPropertiesFormat2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateLinkServices␊ - */␊ - export interface PrivateLinkServices9 {␊ - name: string␊ - type: "Microsoft.Network/privateLinkServices"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the private link service.␊ - */␊ - properties: (PrivateLinkServiceProperties9 | string)␊ - resources?: PrivateLinkServicesPrivateEndpointConnectionsChildResource9[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the private link service.␊ - */␊ - export interface PrivateLinkServiceProperties9 {␊ - /**␊ - * An array of references to the load balancer IP configurations.␊ - */␊ - loadBalancerFrontendIpConfigurations?: (SubResource35[] | string)␊ - /**␊ - * An array of private link service IP configurations.␊ - */␊ - ipConfigurations?: (PrivateLinkServiceIpConfiguration9[] | string)␊ - /**␊ - * The visibility list of the private link service.␊ - */␊ - visibility?: (PrivateLinkServicePropertiesVisibility9 | string)␊ - /**␊ - * The auto-approval list of the private link service.␊ - */␊ - autoApproval?: (PrivateLinkServicePropertiesAutoApproval9 | string)␊ - /**␊ - * The list of Fqdn.␊ - */␊ - fqdns?: (string[] | string)␊ - /**␊ - * Whether the private link service is enabled for proxy protocol or not.␊ - */␊ - enableProxyProtocol?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The private link service ip configuration.␊ - */␊ - export interface PrivateLinkServiceIpConfiguration9 {␊ - /**␊ - * Properties of the private link service ip configuration.␊ - */␊ - properties?: (PrivateLinkServiceIpConfigurationProperties9 | string)␊ - /**␊ - * The name of private link service ip configuration.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of private link service IP configuration.␊ - */␊ - export interface PrivateLinkServiceIpConfigurationProperties9 {␊ - /**␊ - * The private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The private IP address allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * The reference to the subnet resource.␊ - */␊ - subnet?: (SubResource35 | string)␊ - /**␊ - * Whether the ip configuration is primary or not.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4.␊ - */␊ - privateIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The visibility list of the private link service.␊ - */␊ - export interface PrivateLinkServicePropertiesVisibility9 {␊ - /**␊ - * The list of subscriptions.␊ - */␊ - subscriptions?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The auto-approval list of the private link service.␊ - */␊ - export interface PrivateLinkServicePropertiesAutoApproval9 {␊ - /**␊ - * The list of subscriptions.␊ - */␊ - subscriptions?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateLinkServices/privateEndpointConnections␊ - */␊ - export interface PrivateLinkServicesPrivateEndpointConnectionsChildResource9 {␊ - name: string␊ - type: "privateEndpointConnections"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Properties of the private end point connection.␊ - */␊ - properties: (PrivateEndpointConnectionProperties16 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the PrivateEndpointConnectProperties.␊ - */␊ - export interface PrivateEndpointConnectionProperties16 {␊ - /**␊ - * A collection of information about the state of the connection between service consumer and provider.␊ - */␊ - privateLinkServiceConnectionState?: (PrivateLinkServiceConnectionState15 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/privateLinkServices/privateEndpointConnections␊ - */␊ - export interface PrivateLinkServicesPrivateEndpointConnections9 {␊ - name: string␊ - type: "Microsoft.Network/privateLinkServices/privateEndpointConnections"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Properties of the private end point connection.␊ - */␊ - properties: (PrivateEndpointConnectionProperties16 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/publicIPAddresses␊ - */␊ - export interface PublicIPAddresses35 {␊ - name: string␊ - type: "Microsoft.Network/publicIPAddresses"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The public IP address SKU.␊ - */␊ - sku?: (PublicIPAddressSku23 | string)␊ - /**␊ - * Public IP address properties.␊ - */␊ - properties: (PublicIPAddressPropertiesFormat26 | string)␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a public IP address.␊ - */␊ - export interface PublicIPAddressSku23 {␊ - /**␊ - * Name of a public IP address SKU.␊ - */␊ - name?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Public IP address properties.␊ - */␊ - export interface PublicIPAddressPropertiesFormat26 {␊ - /**␊ - * The public IP address allocation method.␊ - */␊ - publicIPAllocationMethod: (("Static" | "Dynamic") | string)␊ - /**␊ - * The public IP address version.␊ - */␊ - publicIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The FQDN of the DNS record associated with the public IP address.␊ - */␊ - dnsSettings?: (PublicIPAddressDnsSettings34 | string)␊ - /**␊ - * The DDoS protection custom policy associated with the public IP address.␊ - */␊ - ddosSettings?: (DdosSettings12 | string)␊ - /**␊ - * The list of tags associated with the public IP address.␊ - */␊ - ipTags?: (IpTag20[] | string)␊ - /**␊ - * The IP address associated with the public IP address resource.␊ - */␊ - ipAddress?: string␊ - /**␊ - * The Public IP Prefix this Public IP Address should be allocated from.␊ - */␊ - publicIPPrefix?: (SubResource35 | string)␊ - /**␊ - * The idle timeout of the public IP address.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains FQDN of the DNS record associated with the public IP address.␊ - */␊ - export interface PublicIPAddressDnsSettings34 {␊ - /**␊ - * The domain name label. The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.␊ - */␊ - domainNameLabel: string␊ - /**␊ - * The Fully Qualified Domain Name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone.␊ - */␊ - fqdn?: string␊ - /**␊ - * The reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN.␊ - */␊ - reverseFqdn?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains the DDoS protection settings of the public IP.␊ - */␊ - export interface DdosSettings12 {␊ - /**␊ - * The DDoS custom policy associated with the public IP.␊ - */␊ - ddosCustomPolicy?: (SubResource35 | string)␊ - /**␊ - * The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized.␊ - */␊ - protectionCoverage?: (("Basic" | "Standard") | string)␊ - /**␊ - * Enables DDoS protection on the public IP.␊ - */␊ - protectedIP?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains the IpTag associated with the object.␊ - */␊ - export interface IpTag20 {␊ - /**␊ - * The IP tag type. Example: FirstPartyUsage.␊ - */␊ - ipTagType?: string␊ - /**␊ - * The value of the IP tag associated with the public IP. Example: SQL.␊ - */␊ - tag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/publicIPPrefixes␊ - */␊ - export interface PublicIPPrefixes10 {␊ - name: string␊ - type: "Microsoft.Network/publicIPPrefixes"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The public IP prefix SKU.␊ - */␊ - sku?: (PublicIPPrefixSku10 | string)␊ - /**␊ - * Public IP prefix properties.␊ - */␊ - properties: (PublicIPPrefixPropertiesFormat10 | string)␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of a public IP prefix.␊ - */␊ - export interface PublicIPPrefixSku10 {␊ - /**␊ - * Name of a public IP prefix SKU.␊ - */␊ - name?: ("Standard" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Public IP prefix properties.␊ - */␊ - export interface PublicIPPrefixPropertiesFormat10 {␊ - /**␊ - * The public IP address version.␊ - */␊ - publicIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * The list of tags associated with the public IP prefix.␊ - */␊ - ipTags?: (IpTag20[] | string)␊ - /**␊ - * The Length of the Public IP Prefix.␊ - */␊ - prefixLength?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeFilters␊ - */␊ - export interface RouteFilters12 {␊ - name: string␊ - type: "Microsoft.Network/routeFilters"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the route filter.␊ - */␊ - properties: (RouteFilterPropertiesFormat12 | string)␊ - resources?: RouteFiltersRouteFilterRulesChildResource12[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Filter Resource.␊ - */␊ - export interface RouteFilterPropertiesFormat12 {␊ - /**␊ - * Collection of RouteFilterRules contained within a route filter.␊ - */␊ - rules?: (RouteFilterRule12[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Filter Rule Resource.␊ - */␊ - export interface RouteFilterRule12 {␊ - /**␊ - * Properties of the route filter rule.␊ - */␊ - properties?: (RouteFilterRulePropertiesFormat12 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Filter Rule Resource.␊ - */␊ - export interface RouteFilterRulePropertiesFormat12 {␊ - /**␊ - * The access type of the rule.␊ - */␊ - access: (("Allow" | "Deny") | string)␊ - /**␊ - * The rule type of the rule.␊ - */␊ - routeFilterRuleType: ("Community" | string)␊ - /**␊ - * The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'].␊ - */␊ - communities: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeFilters/routeFilterRules␊ - */␊ - export interface RouteFiltersRouteFilterRulesChildResource12 {␊ - name: string␊ - type: "routeFilterRules"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Properties of the route filter rule.␊ - */␊ - properties: (RouteFilterRulePropertiesFormat12 | string)␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeFilters/routeFilterRules␊ - */␊ - export interface RouteFiltersRouteFilterRules12 {␊ - name: string␊ - type: "Microsoft.Network/routeFilters/routeFilterRules"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Properties of the route filter rule.␊ - */␊ - properties: (RouteFilterRulePropertiesFormat12 | string)␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables␊ - */␊ - export interface RouteTables35 {␊ - name: string␊ - type: "Microsoft.Network/routeTables"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the route table.␊ - */␊ - properties: (RouteTablePropertiesFormat27 | string)␊ - resources?: RouteTablesRoutesChildResource27[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route Table resource.␊ - */␊ - export interface RouteTablePropertiesFormat27 {␊ - /**␊ - * Collection of routes contained within a route table.␊ - */␊ - routes?: (Route27[] | string)␊ - /**␊ - * Whether to disable the routes learned by BGP on that route table. True means disable.␊ - */␊ - disableBgpRoutePropagation?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource.␊ - */␊ - export interface Route27 {␊ - /**␊ - * Properties of the route.␊ - */␊ - properties?: (RoutePropertiesFormat27 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Route resource.␊ - */␊ - export interface RoutePropertiesFormat27 {␊ - /**␊ - * The destination CIDR to which the route applies.␊ - */␊ - addressPrefix: string␊ - /**␊ - * The type of Azure hop the packet should be sent to.␊ - */␊ - nextHopType: (("VirtualNetworkGateway" | "VnetLocal" | "Internet" | "VirtualAppliance" | "None") | string)␊ - /**␊ - * The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.␊ - */␊ - nextHopIpAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutesChildResource27 {␊ - name: string␊ - type: "routes"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Properties of the route.␊ - */␊ - properties: (RoutePropertiesFormat27 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/routeTables/routes␊ - */␊ - export interface RouteTablesRoutes27 {␊ - name: string␊ - type: "Microsoft.Network/routeTables/routes"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Properties of the route.␊ - */␊ - properties: (RoutePropertiesFormat27 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/securityPartnerProviders␊ - */␊ - export interface SecurityPartnerProviders2 {␊ - name: string␊ - type: "Microsoft.Network/securityPartnerProviders"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the Security Partner Provider.␊ - */␊ - properties: (SecurityPartnerProviderPropertiesFormat2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Security Partner Provider.␊ - */␊ - export interface SecurityPartnerProviderPropertiesFormat2 {␊ - /**␊ - * The security provider name.␊ - */␊ - securityProviderName?: (("ZScaler" | "IBoss" | "Checkpoint") | string)␊ - /**␊ - * The virtualHub to which the Security Partner Provider belongs.␊ - */␊ - virtualHub?: (SubResource35 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/serviceEndpointPolicies␊ - */␊ - export interface ServiceEndpointPolicies10 {␊ - name: string␊ - type: "Microsoft.Network/serviceEndpointPolicies"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the service end point policy.␊ - */␊ - properties: (ServiceEndpointPolicyPropertiesFormat10 | string)␊ - resources?: ServiceEndpointPoliciesServiceEndpointPolicyDefinitionsChildResource10[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Service Endpoint Policy resource.␊ - */␊ - export interface ServiceEndpointPolicyPropertiesFormat10 {␊ - /**␊ - * A collection of service endpoint policy definitions of the service endpoint policy.␊ - */␊ - serviceEndpointPolicyDefinitions?: (ServiceEndpointPolicyDefinition10[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Service Endpoint policy definitions.␊ - */␊ - export interface ServiceEndpointPolicyDefinition10 {␊ - /**␊ - * Properties of the service endpoint policy definition.␊ - */␊ - properties?: (ServiceEndpointPolicyDefinitionPropertiesFormat10 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Service Endpoint policy definition resource.␊ - */␊ - export interface ServiceEndpointPolicyDefinitionPropertiesFormat10 {␊ - /**␊ - * A description for this rule. Restricted to 140 chars.␊ - */␊ - description?: string␊ - /**␊ - * Service endpoint name.␊ - */␊ - service?: string␊ - /**␊ - * A list of service resources.␊ - */␊ - serviceResources?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions␊ - */␊ - export interface ServiceEndpointPoliciesServiceEndpointPolicyDefinitionsChildResource10 {␊ - name: string␊ - type: "serviceEndpointPolicyDefinitions"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Properties of the service endpoint policy definition.␊ - */␊ - properties: (ServiceEndpointPolicyDefinitionPropertiesFormat10 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions␊ - */␊ - export interface ServiceEndpointPoliciesServiceEndpointPolicyDefinitions10 {␊ - name: string␊ - type: "Microsoft.Network/serviceEndpointPolicies/serviceEndpointPolicyDefinitions"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Properties of the service endpoint policy definition.␊ - */␊ - properties: (ServiceEndpointPolicyDefinitionPropertiesFormat10 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualHubs␊ - */␊ - export interface VirtualHubs12 {␊ - name: string␊ - type: "Microsoft.Network/virtualHubs"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual hub.␊ - */␊ - properties: (VirtualHubProperties12 | string)␊ - resources?: (VirtualHubsHubRouteTablesChildResource1 | VirtualHubsIpConfigurationsChildResource | VirtualHubsBgpConnectionsChildResource | VirtualHubsRouteTablesChildResource5 | VirtualHubsHubVirtualNetworkConnectionsChildResource)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VirtualHub.␊ - */␊ - export interface VirtualHubProperties12 {␊ - /**␊ - * The VirtualWAN to which the VirtualHub belongs.␊ - */␊ - virtualWan?: (SubResource35 | string)␊ - /**␊ - * The VpnGateway associated with this VirtualHub.␊ - */␊ - vpnGateway?: (SubResource35 | string)␊ - /**␊ - * The P2SVpnGateway associated with this VirtualHub.␊ - */␊ - p2SVpnGateway?: (SubResource35 | string)␊ - /**␊ - * The expressRouteGateway associated with this VirtualHub.␊ - */␊ - expressRouteGateway?: (SubResource35 | string)␊ - /**␊ - * The azureFirewall associated with this VirtualHub.␊ - */␊ - azureFirewall?: (SubResource35 | string)␊ - /**␊ - * The securityPartnerProvider associated with this VirtualHub.␊ - */␊ - securityPartnerProvider?: (SubResource35 | string)␊ - /**␊ - * Address-prefix for this VirtualHub.␊ - */␊ - addressPrefix?: string␊ - /**␊ - * The routeTable associated with this virtual hub.␊ - */␊ - routeTable?: (VirtualHubRouteTable9 | string)␊ - /**␊ - * The Security Provider name.␊ - */␊ - securityProviderName?: string␊ - /**␊ - * List of all virtual hub route table v2s associated with this VirtualHub.␊ - */␊ - virtualHubRouteTableV2s?: (VirtualHubRouteTableV25[] | string)␊ - /**␊ - * The sku of this VirtualHub.␊ - */␊ - sku?: string␊ - /**␊ - * The routing state.␊ - */␊ - routingState?: (("None" | "Provisioned" | "Provisioning" | "Failed") | string)␊ - /**␊ - * VirtualRouter ASN.␊ - */␊ - virtualRouterAsn?: (number | string)␊ - /**␊ - * VirtualRouter IPs.␊ - */␊ - virtualRouterIps?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualHub route table.␊ - */␊ - export interface VirtualHubRouteTable9 {␊ - /**␊ - * List of all routes.␊ - */␊ - routes?: (VirtualHubRoute9[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualHub route.␊ - */␊ - export interface VirtualHubRoute9 {␊ - /**␊ - * List of all addressPrefixes.␊ - */␊ - addressPrefixes?: (string[] | string)␊ - /**␊ - * NextHop ip address.␊ - */␊ - nextHopIpAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualHubRouteTableV2 Resource.␊ - */␊ - export interface VirtualHubRouteTableV25 {␊ - /**␊ - * Properties of the virtual hub route table v2.␊ - */␊ - properties?: (VirtualHubRouteTableV2Properties5 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VirtualHubRouteTableV2.␊ - */␊ - export interface VirtualHubRouteTableV2Properties5 {␊ - /**␊ - * List of all routes.␊ - */␊ - routes?: (VirtualHubRouteV25[] | string)␊ - /**␊ - * List of all connections attached to this route table v2.␊ - */␊ - attachedConnections?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualHubRouteTableV2 route.␊ - */␊ - export interface VirtualHubRouteV25 {␊ - /**␊ - * The type of destinations.␊ - */␊ - destinationType?: string␊ - /**␊ - * List of all destinations.␊ - */␊ - destinations?: (string[] | string)␊ - /**␊ - * The type of next hops.␊ - */␊ - nextHopType?: string␊ - /**␊ - * NextHops ip address.␊ - */␊ - nextHops?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualHubs/hubRouteTables␊ - */␊ - export interface VirtualHubsHubRouteTablesChildResource1 {␊ - name: string␊ - type: "hubRouteTables"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Properties of the RouteTable resource.␊ - */␊ - properties: (HubRouteTableProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for RouteTable.␊ - */␊ - export interface HubRouteTableProperties1 {␊ - /**␊ - * List of all routes.␊ - */␊ - routes?: (HubRoute1[] | string)␊ - /**␊ - * List of labels associated with this route table.␊ - */␊ - labels?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * RouteTable route.␊ - */␊ - export interface HubRoute1 {␊ - /**␊ - * The name of the Route that is unique within a RouteTable. This name can be used to access this route.␊ - */␊ - name: string␊ - /**␊ - * The type of destinations (eg: CIDR, ResourceId, Service).␊ - */␊ - destinationType: string␊ - /**␊ - * List of all destinations.␊ - */␊ - destinations: (string[] | string)␊ - /**␊ - * The type of next hop (eg: ResourceId).␊ - */␊ - nextHopType: string␊ - /**␊ - * NextHop resource ID.␊ - */␊ - nextHop: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualHubs/ipConfigurations␊ - */␊ - export interface VirtualHubsIpConfigurationsChildResource {␊ - name: string␊ - type: "ipConfigurations"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * The properties of the Virtual Hub IPConfigurations.␊ - */␊ - properties: (HubIPConfigurationPropertiesFormat | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of IP configuration.␊ - */␊ - export interface HubIPConfigurationPropertiesFormat {␊ - /**␊ - * The private IP address of the IP configuration.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The private IP address allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * The reference to the subnet resource.␊ - */␊ - subnet?: (Subnet37 | string)␊ - /**␊ - * The reference to the public IP resource.␊ - */␊ - publicIPAddress?: (PublicIPAddress | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Subnet in a virtual network resource.␊ - */␊ - export interface Subnet37 {␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties?: (SubnetPropertiesFormat27 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the subnet.␊ - */␊ - export interface SubnetPropertiesFormat27 {␊ - /**␊ - * The address prefix for the subnet.␊ - */␊ - addressPrefix: string␊ - /**␊ - * List of address prefixes for the subnet.␊ - */␊ - addressPrefixes?: (string[] | string)␊ - /**␊ - * The reference to the NetworkSecurityGroup resource.␊ - */␊ - networkSecurityGroup?: (SubResource35 | string)␊ - /**␊ - * The reference to the RouteTable resource.␊ - */␊ - routeTable?: (SubResource35 | string)␊ - /**␊ - * Nat gateway associated with this subnet.␊ - */␊ - natGateway?: (SubResource35 | string)␊ - /**␊ - * An array of service endpoints.␊ - */␊ - serviceEndpoints?: (ServiceEndpointPropertiesFormat23[] | string)␊ - /**␊ - * An array of service endpoint policies.␊ - */␊ - serviceEndpointPolicies?: (SubResource35[] | string)␊ - /**␊ - * Array of IpAllocation which reference this subnet.␊ - */␊ - ipAllocations?: (SubResource35[] | string)␊ - /**␊ - * An array of references to the delegations on the subnet.␊ - */␊ - delegations?: (Delegation14[] | string)␊ - /**␊ - * Enable or Disable apply network policies on private end point in the subnet.␊ - */␊ - privateEndpointNetworkPolicies?: string␊ - /**␊ - * Enable or Disable apply network policies on private link service in the subnet.␊ - */␊ - privateLinkServiceNetworkPolicies?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The service endpoint properties.␊ - */␊ - export interface ServiceEndpointPropertiesFormat23 {␊ - /**␊ - * The type of the endpoint service.␊ - */␊ - service?: string␊ - /**␊ - * A list of locations.␊ - */␊ - locations?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Details the service to which the subnet is delegated.␊ - */␊ - export interface Delegation14 {␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties?: (ServiceDelegationPropertiesFormat14 | string)␊ - /**␊ - * The name of the resource that is unique within a subnet. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a service delegation.␊ - */␊ - export interface ServiceDelegationPropertiesFormat14 {␊ - /**␊ - * The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers).␊ - */␊ - serviceName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Public IP address resource.␊ - */␊ - export interface PublicIPAddress {␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The public IP address SKU.␊ - */␊ - sku?: (PublicIPAddressSku23 | string)␊ - /**␊ - * Public IP address properties.␊ - */␊ - properties?: (PublicIPAddressPropertiesFormat26 | string)␊ - /**␊ - * A list of availability zones denoting the IP allocated for the resource needs to come from.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualHubs/bgpConnections␊ - */␊ - export interface VirtualHubsBgpConnectionsChildResource {␊ - name: string␊ - type: "bgpConnections"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * The properties of the Bgp connections.␊ - */␊ - properties: (BgpConnectionProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the bgp connection.␊ - */␊ - export interface BgpConnectionProperties {␊ - /**␊ - * Peer ASN.␊ - */␊ - peerAsn?: (number | string)␊ - /**␊ - * Peer IP.␊ - */␊ - peerIp?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualHubs/routeTables␊ - */␊ - export interface VirtualHubsRouteTablesChildResource5 {␊ - name: string␊ - type: "routeTables"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Properties of the virtual hub route table v2.␊ - */␊ - properties: (VirtualHubRouteTableV2Properties5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualHubs/hubVirtualNetworkConnections␊ - */␊ - export interface VirtualHubsHubVirtualNetworkConnectionsChildResource {␊ - name: string␊ - type: "hubVirtualNetworkConnections"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Properties of the hub virtual network connection.␊ - */␊ - properties: (HubVirtualNetworkConnectionProperties12 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for HubVirtualNetworkConnection.␊ - */␊ - export interface HubVirtualNetworkConnectionProperties12 {␊ - /**␊ - * Reference to the remote virtual network.␊ - */␊ - remoteVirtualNetwork?: (SubResource35 | string)␊ - /**␊ - * Deprecated: VirtualHub to RemoteVnet transit to enabled or not.␊ - */␊ - allowHubToRemoteVnetTransit?: (boolean | string)␊ - /**␊ - * Deprecated: Allow RemoteVnet to use Virtual Hub's gateways.␊ - */␊ - allowRemoteVnetToUseHubVnetGateways?: (boolean | string)␊ - /**␊ - * Enable internet security.␊ - */␊ - enableInternetSecurity?: (boolean | string)␊ - /**␊ - * The Routing Configuration indicating the associated and propagated route tables on this connection.␊ - */␊ - routingConfiguration?: (RoutingConfiguration1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualHubs/bgpConnections␊ - */␊ - export interface VirtualHubsBgpConnections {␊ - name: string␊ - type: "Microsoft.Network/virtualHubs/bgpConnections"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * The properties of the Bgp connections.␊ - */␊ - properties: (BgpConnectionProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualHubs/hubRouteTables␊ - */␊ - export interface VirtualHubsHubRouteTables1 {␊ - name: string␊ - type: "Microsoft.Network/virtualHubs/hubRouteTables"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Properties of the RouteTable resource.␊ - */␊ - properties: (HubRouteTableProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualHubs/hubVirtualNetworkConnections␊ - */␊ - export interface VirtualHubsHubVirtualNetworkConnections {␊ - name: string␊ - type: "Microsoft.Network/virtualHubs/hubVirtualNetworkConnections"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Properties of the hub virtual network connection.␊ - */␊ - properties: (HubVirtualNetworkConnectionProperties12 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualHubs/ipConfigurations␊ - */␊ - export interface VirtualHubsIpConfigurations {␊ - name: string␊ - type: "Microsoft.Network/virtualHubs/ipConfigurations"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * The properties of the Virtual Hub IPConfigurations.␊ - */␊ - properties: (HubIPConfigurationPropertiesFormat | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualHubs/routeTables␊ - */␊ - export interface VirtualHubsRouteTables5 {␊ - name: string␊ - type: "Microsoft.Network/virtualHubs/routeTables"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Properties of the virtual hub route table v2.␊ - */␊ - properties: (VirtualHubRouteTableV2Properties5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworkGateways␊ - */␊ - export interface VirtualNetworkGateways27 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworkGateways"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network gateway.␊ - */␊ - properties: (VirtualNetworkGatewayPropertiesFormat27 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGateway properties.␊ - */␊ - export interface VirtualNetworkGatewayPropertiesFormat27 {␊ - /**␊ - * IP configurations for virtual network gateway.␊ - */␊ - ipConfigurations?: (VirtualNetworkGatewayIPConfiguration26[] | string)␊ - /**␊ - * The type of this virtual network gateway.␊ - */␊ - gatewayType?: (("Vpn" | "ExpressRoute" | "HyperNet") | string)␊ - /**␊ - * The type of this virtual network gateway.␊ - */␊ - vpnType?: (("PolicyBased" | "RouteBased") | string)␊ - /**␊ - * The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN.␊ - */␊ - vpnGatewayGeneration?: (("None" | "Generation1" | "Generation2") | string)␊ - /**␊ - * Whether BGP is enabled for this virtual network gateway or not.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * Whether private IP needs to be enabled on this gateway for connections or not.␊ - */␊ - enablePrivateIpAddress?: (boolean | string)␊ - /**␊ - * ActiveActive flag.␊ - */␊ - activeActive?: (boolean | string)␊ - /**␊ - * The reference to the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting.␊ - */␊ - gatewayDefaultSite?: (SubResource35 | string)␊ - /**␊ - * The reference to the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.␊ - */␊ - sku?: (VirtualNetworkGatewaySku26 | string)␊ - /**␊ - * The reference to the VpnClientConfiguration resource which represents the P2S VpnClient configurations.␊ - */␊ - vpnClientConfiguration?: (VpnClientConfiguration26 | string)␊ - /**␊ - * Virtual network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings26 | string)␊ - /**␊ - * The reference to the address space resource which represents the custom routes address space specified by the customer for virtual network gateway and VpnClient.␊ - */␊ - customRoutes?: (AddressSpace35 | string)␊ - /**␊ - * Whether dns forwarding is enabled or not.␊ - */␊ - enableDnsForwarding?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP configuration for virtual network gateway.␊ - */␊ - export interface VirtualNetworkGatewayIPConfiguration26 {␊ - /**␊ - * Properties of the virtual network gateway ip configuration.␊ - */␊ - properties?: (VirtualNetworkGatewayIPConfigurationPropertiesFormat26 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of VirtualNetworkGatewayIPConfiguration.␊ - */␊ - export interface VirtualNetworkGatewayIPConfigurationPropertiesFormat26 {␊ - /**␊ - * The private IP address allocation method.␊ - */␊ - privateIPAllocationMethod?: (("Static" | "Dynamic") | string)␊ - /**␊ - * The reference to the subnet resource.␊ - */␊ - subnet?: (SubResource35 | string)␊ - /**␊ - * The reference to the public IP resource.␊ - */␊ - publicIPAddress?: (SubResource35 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VirtualNetworkGatewaySku details.␊ - */␊ - export interface VirtualNetworkGatewaySku26 {␊ - /**␊ - * Gateway SKU name.␊ - */␊ - name?: (("Basic" | "HighPerformance" | "Standard" | "UltraPerformance" | "VpnGw1" | "VpnGw2" | "VpnGw3" | "VpnGw4" | "VpnGw5" | "VpnGw1AZ" | "VpnGw2AZ" | "VpnGw3AZ" | "VpnGw4AZ" | "VpnGw5AZ" | "ErGw1AZ" | "ErGw2AZ" | "ErGw3AZ") | string)␊ - /**␊ - * Gateway SKU tier.␊ - */␊ - tier?: (("Basic" | "HighPerformance" | "Standard" | "UltraPerformance" | "VpnGw1" | "VpnGw2" | "VpnGw3" | "VpnGw4" | "VpnGw5" | "VpnGw1AZ" | "VpnGw2AZ" | "VpnGw3AZ" | "VpnGw4AZ" | "VpnGw5AZ" | "ErGw1AZ" | "ErGw2AZ" | "ErGw3AZ") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnClientConfiguration for P2S client.␊ - */␊ - export interface VpnClientConfiguration26 {␊ - /**␊ - * The reference to the address space resource which represents Address space for P2S VpnClient.␊ - */␊ - vpnClientAddressPool?: (AddressSpace35 | string)␊ - /**␊ - * VpnClientRootCertificate for virtual network gateway.␊ - */␊ - vpnClientRootCertificates?: (VpnClientRootCertificate26[] | string)␊ - /**␊ - * VpnClientRevokedCertificate for Virtual network gateway.␊ - */␊ - vpnClientRevokedCertificates?: (VpnClientRevokedCertificate26[] | string)␊ - /**␊ - * VpnClientProtocols for Virtual network gateway.␊ - */␊ - vpnClientProtocols?: (("IkeV2" | "SSTP" | "OpenVPN")[] | string)␊ - /**␊ - * VpnClientIpsecPolicies for virtual network gateway P2S client.␊ - */␊ - vpnClientIpsecPolicies?: (IpsecPolicy24[] | string)␊ - /**␊ - * The radius server address property of the VirtualNetworkGateway resource for vpn client connection.␊ - */␊ - radiusServerAddress?: string␊ - /**␊ - * The radius secret property of the VirtualNetworkGateway resource for vpn client connection.␊ - */␊ - radiusServerSecret?: string␊ - /**␊ - * The radiusServers property for multiple radius server configuration.␊ - */␊ - radiusServers?: (RadiusServer2[] | string)␊ - /**␊ - * The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication.␊ - */␊ - aadTenant?: string␊ - /**␊ - * The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication.␊ - */␊ - aadAudience?: string␊ - /**␊ - * The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication.␊ - */␊ - aadIssuer?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client root certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRootCertificate26 {␊ - /**␊ - * Properties of the vpn client root certificate.␊ - */␊ - properties: (VpnClientRootCertificatePropertiesFormat26 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of SSL certificates of application gateway.␊ - */␊ - export interface VpnClientRootCertificatePropertiesFormat26 {␊ - /**␊ - * The certificate public data.␊ - */␊ - publicCertData: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VPN client revoked certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRevokedCertificate26 {␊ - /**␊ - * Properties of the vpn client revoked certificate.␊ - */␊ - properties?: (VpnClientRevokedCertificatePropertiesFormat26 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the revoked VPN client certificate of virtual network gateway.␊ - */␊ - export interface VpnClientRevokedCertificatePropertiesFormat26 {␊ - /**␊ - * The revoked VPN client certificate thumbprint.␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Radius Server Settings.␊ - */␊ - export interface RadiusServer2 {␊ - /**␊ - * The address of this radius server.␊ - */␊ - radiusServerAddress: string␊ - /**␊ - * The initial score assigned to this radius server.␊ - */␊ - radiusServerScore?: (number | string)␊ - /**␊ - * The secret used for this radius server.␊ - */␊ - radiusServerSecret?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks␊ - */␊ - export interface VirtualNetworks35 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual network.␊ - */␊ - properties: (VirtualNetworkPropertiesFormat27 | string)␊ - resources?: (VirtualNetworksVirtualNetworkPeeringsChildResource24 | VirtualNetworksSubnetsChildResource27)[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the virtual network.␊ - */␊ - export interface VirtualNetworkPropertiesFormat27 {␊ - /**␊ - * The AddressSpace that contains an array of IP address ranges that can be used by subnets.␊ - */␊ - addressSpace: (AddressSpace35 | string)␊ - /**␊ - * The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network.␊ - */␊ - dhcpOptions?: (DhcpOptions35 | string)␊ - /**␊ - * A list of subnets in a Virtual Network.␊ - */␊ - subnets?: (Subnet37[] | string)␊ - /**␊ - * A list of peerings in a Virtual Network.␊ - */␊ - virtualNetworkPeerings?: (VirtualNetworkPeering32[] | string)␊ - /**␊ - * Indicates if DDoS protection is enabled for all the protected resources in the virtual network. It requires a DDoS protection plan associated with the resource.␊ - */␊ - enableDdosProtection?: (boolean | string)␊ - /**␊ - * Indicates if VM protection is enabled for all the subnets in the virtual network.␊ - */␊ - enableVmProtection?: (boolean | string)␊ - /**␊ - * The DDoS protection plan associated with the virtual network.␊ - */␊ - ddosProtectionPlan?: (SubResource35 | string)␊ - /**␊ - * Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET.␊ - */␊ - bgpCommunities?: (VirtualNetworkBgpCommunities6 | string)␊ - /**␊ - * Array of IpAllocation which reference this VNET.␊ - */␊ - ipAllocations?: (SubResource35[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DhcpOptions contains an array of DNS servers available to VMs deployed in the virtual network. Standard DHCP option for a subnet overrides VNET DHCP options.␊ - */␊ - export interface DhcpOptions35 {␊ - /**␊ - * The list of DNS servers IP addresses.␊ - */␊ - dnsServers: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Peerings in a virtual network resource.␊ - */␊ - export interface VirtualNetworkPeering32 {␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties?: (VirtualNetworkPeeringPropertiesFormat24 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - export interface VirtualNetworkPeeringPropertiesFormat24 {␊ - /**␊ - * Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space.␊ - */␊ - allowVirtualNetworkAccess?: (boolean | string)␊ - /**␊ - * Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network.␊ - */␊ - allowForwardedTraffic?: (boolean | string)␊ - /**␊ - * If gateway links can be used in remote virtual networking to link to this virtual network.␊ - */␊ - allowGatewayTransit?: (boolean | string)␊ - /**␊ - * If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway.␊ - */␊ - useRemoteGateways?: (boolean | string)␊ - /**␊ - * The reference to the remote virtual network. The remote virtual network can be in the same or different region (preview). See here to register for the preview and learn more (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering).␊ - */␊ - remoteVirtualNetwork: (SubResource35 | string)␊ - /**␊ - * The reference to the remote virtual network address space.␊ - */␊ - remoteAddressSpace?: (AddressSpace35 | string)␊ - /**␊ - * The status of the virtual network peering.␊ - */␊ - peeringState?: (("Initiated" | "Connected" | "Disconnected") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET.␊ - */␊ - export interface VirtualNetworkBgpCommunities6 {␊ - /**␊ - * The BGP community associated with the virtual network.␊ - */␊ - virtualNetworkCommunity: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/virtualNetworkPeerings␊ - */␊ - export interface VirtualNetworksVirtualNetworkPeeringsChildResource24 {␊ - name: string␊ - type: "virtualNetworkPeerings"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties: (VirtualNetworkPeeringPropertiesFormat24 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnetsChildResource27 {␊ - name: string␊ - type: "subnets"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties: (SubnetPropertiesFormat27 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/subnets␊ - */␊ - export interface VirtualNetworksSubnets27 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks/subnets"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Properties of the subnet.␊ - */␊ - properties: (SubnetPropertiesFormat27 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworks/virtualNetworkPeerings␊ - */␊ - export interface VirtualNetworksVirtualNetworkPeerings24 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworks/virtualNetworkPeerings"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Properties of the virtual network peering.␊ - */␊ - properties: (VirtualNetworkPeeringPropertiesFormat24 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualNetworkTaps␊ - */␊ - export interface VirtualNetworkTaps9 {␊ - name: string␊ - type: "Microsoft.Network/virtualNetworkTaps"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Virtual Network Tap Properties.␊ - */␊ - properties: (VirtualNetworkTapPropertiesFormat9 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Virtual Network Tap properties.␊ - */␊ - export interface VirtualNetworkTapPropertiesFormat9 {␊ - /**␊ - * The reference to the private IP Address of the collector nic that will receive the tap.␊ - */␊ - destinationNetworkInterfaceIPConfiguration?: (SubResource35 | string)␊ - /**␊ - * The reference to the private IP address on the internal Load Balancer that will receive the tap.␊ - */␊ - destinationLoadBalancerFrontEndIPConfiguration?: (SubResource35 | string)␊ - /**␊ - * The VXLAN destination port that will receive the tapped traffic.␊ - */␊ - destinationPort?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualRouters␊ - */␊ - export interface VirtualRouters7 {␊ - name: string␊ - type: "Microsoft.Network/virtualRouters"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the Virtual Router.␊ - */␊ - properties: (VirtualRouterPropertiesFormat7 | string)␊ - resources?: VirtualRoutersPeeringsChildResource7[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Virtual Router definition.␊ - */␊ - export interface VirtualRouterPropertiesFormat7 {␊ - /**␊ - * VirtualRouter ASN.␊ - */␊ - virtualRouterAsn?: (number | string)␊ - /**␊ - * VirtualRouter IPs.␊ - */␊ - virtualRouterIps?: (string[] | string)␊ - /**␊ - * The Subnet on which VirtualRouter is hosted.␊ - */␊ - hostedSubnet?: (SubResource35 | string)␊ - /**␊ - * The Gateway on which VirtualRouter is hosted.␊ - */␊ - hostedGateway?: (SubResource35 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualRouters/peerings␊ - */␊ - export interface VirtualRoutersPeeringsChildResource7 {␊ - name: string␊ - type: "peerings"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * The properties of the Virtual Router Peering.␊ - */␊ - properties: (VirtualRouterPeeringProperties7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the rule group.␊ - */␊ - export interface VirtualRouterPeeringProperties7 {␊ - /**␊ - * Peer ASN.␊ - */␊ - peerAsn?: (number | string)␊ - /**␊ - * Peer IP.␊ - */␊ - peerIp?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualRouters/peerings␊ - */␊ - export interface VirtualRoutersPeerings7 {␊ - name: string␊ - type: "Microsoft.Network/virtualRouters/peerings"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * The properties of the Virtual Router Peering.␊ - */␊ - properties: (VirtualRouterPeeringProperties7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/virtualWans␊ - */␊ - export interface VirtualWans12 {␊ - name: string␊ - type: "Microsoft.Network/virtualWans"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the virtual WAN.␊ - */␊ - properties: (VirtualWanProperties12 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VirtualWAN.␊ - */␊ - export interface VirtualWanProperties12 {␊ - /**␊ - * Vpn encryption to be disabled or not.␊ - */␊ - disableVpnEncryption?: (boolean | string)␊ - /**␊ - * True if branch to branch traffic is allowed.␊ - */␊ - allowBranchToBranchTraffic?: (boolean | string)␊ - /**␊ - * True if Vnet to Vnet traffic is allowed.␊ - */␊ - allowVnetToVnetTraffic?: (boolean | string)␊ - /**␊ - * The office local breakout category.␊ - */␊ - office365LocalBreakoutCategory?: (("Optimize" | "OptimizeAndAllow" | "All" | "None") | string)␊ - /**␊ - * The type of the VirtualWAN.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnGateways␊ - */␊ - export interface VpnGateways12 {␊ - name: string␊ - type: "Microsoft.Network/vpnGateways"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the VPN gateway.␊ - */␊ - properties: (VpnGatewayProperties12 | string)␊ - resources?: VpnGatewaysVpnConnectionsChildResource12[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnGateway.␊ - */␊ - export interface VpnGatewayProperties12 {␊ - /**␊ - * The VirtualHub to which the gateway belongs.␊ - */␊ - virtualHub?: (SubResource35 | string)␊ - /**␊ - * List of all vpn connections to the gateway.␊ - */␊ - connections?: (VpnConnection12[] | string)␊ - /**␊ - * Local network gateway's BGP speaker settings.␊ - */␊ - bgpSettings?: (BgpSettings26 | string)␊ - /**␊ - * The scale unit for this vpn gateway.␊ - */␊ - vpnGatewayScaleUnit?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnConnection Resource.␊ - */␊ - export interface VpnConnection12 {␊ - /**␊ - * Properties of the VPN connection.␊ - */␊ - properties?: (VpnConnectionProperties12 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnConnection.␊ - */␊ - export interface VpnConnectionProperties12 {␊ - /**␊ - * Id of the connected vpn site.␊ - */␊ - remoteVpnSite?: (SubResource35 | string)␊ - /**␊ - * Routing weight for vpn connection.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * The dead peer detection timeout for a vpn connection in seconds.␊ - */␊ - dpdTimeoutSeconds?: (number | string)␊ - /**␊ - * The connection status.␊ - */␊ - connectionStatus?: (("Unknown" | "Connecting" | "Connected" | "NotConnected") | string)␊ - /**␊ - * Connection protocol used for this connection.␊ - */␊ - vpnConnectionProtocolType?: (("IKEv2" | "IKEv1") | string)␊ - /**␊ - * Expected bandwidth in MBPS.␊ - */␊ - connectionBandwidth?: (number | string)␊ - /**␊ - * SharedKey for the vpn connection.␊ - */␊ - sharedKey?: string␊ - /**␊ - * EnableBgp flag.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * Enable policy-based traffic selectors.␊ - */␊ - usePolicyBasedTrafficSelectors?: (boolean | string)␊ - /**␊ - * The IPSec Policies to be considered by this connection.␊ - */␊ - ipsecPolicies?: (IpsecPolicy24[] | string)␊ - /**␊ - * EnableBgp flag.␊ - */␊ - enableRateLimiting?: (boolean | string)␊ - /**␊ - * Enable internet security.␊ - */␊ - enableInternetSecurity?: (boolean | string)␊ - /**␊ - * Use local azure ip to initiate connection.␊ - */␊ - useLocalAzureIpAddress?: (boolean | string)␊ - /**␊ - * List of all vpn site link connections to the gateway.␊ - */␊ - vpnLinkConnections?: (VpnSiteLinkConnection8[] | string)␊ - /**␊ - * The Routing Configuration indicating the associated and propagated route tables on this connection.␊ - */␊ - routingConfiguration?: (RoutingConfiguration1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnSiteLinkConnection Resource.␊ - */␊ - export interface VpnSiteLinkConnection8 {␊ - /**␊ - * Properties of the VPN site link connection.␊ - */␊ - properties?: (VpnSiteLinkConnectionProperties8 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnConnection.␊ - */␊ - export interface VpnSiteLinkConnectionProperties8 {␊ - /**␊ - * Id of the connected vpn site link.␊ - */␊ - vpnSiteLink?: (SubResource35 | string)␊ - /**␊ - * Routing weight for vpn connection.␊ - */␊ - routingWeight?: (number | string)␊ - /**␊ - * The connection status.␊ - */␊ - connectionStatus?: (("Unknown" | "Connecting" | "Connected" | "NotConnected") | string)␊ - /**␊ - * Connection protocol used for this connection.␊ - */␊ - vpnConnectionProtocolType?: (("IKEv2" | "IKEv1") | string)␊ - /**␊ - * Expected bandwidth in MBPS.␊ - */␊ - connectionBandwidth?: (number | string)␊ - /**␊ - * SharedKey for the vpn connection.␊ - */␊ - sharedKey?: string␊ - /**␊ - * EnableBgp flag.␊ - */␊ - enableBgp?: (boolean | string)␊ - /**␊ - * Enable policy-based traffic selectors.␊ - */␊ - usePolicyBasedTrafficSelectors?: (boolean | string)␊ - /**␊ - * The IPSec Policies to be considered by this connection.␊ - */␊ - ipsecPolicies?: (IpsecPolicy24[] | string)␊ - /**␊ - * EnableBgp flag.␊ - */␊ - enableRateLimiting?: (boolean | string)␊ - /**␊ - * Use local azure ip to initiate connection.␊ - */␊ - useLocalAzureIpAddress?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnGateways/vpnConnections␊ - */␊ - export interface VpnGatewaysVpnConnectionsChildResource12 {␊ - name: string␊ - type: "vpnConnections"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Properties of the VPN connection.␊ - */␊ - properties: (VpnConnectionProperties12 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnGateways/vpnConnections␊ - */␊ - export interface VpnGatewaysVpnConnections12 {␊ - name: string␊ - type: "Microsoft.Network/vpnGateways/vpnConnections"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Properties of the VPN connection.␊ - */␊ - properties: (VpnConnectionProperties12 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnServerConfigurations␊ - */␊ - export interface VpnServerConfigurations6 {␊ - name: string␊ - type: "Microsoft.Network/vpnServerConfigurations"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the P2SVpnServer configuration.␊ - */␊ - properties: (VpnServerConfigurationProperties6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnServerConfiguration.␊ - */␊ - export interface VpnServerConfigurationProperties6 {␊ - /**␊ - * The name of the VpnServerConfiguration that is unique within a resource group.␊ - */␊ - name?: string␊ - /**␊ - * VPN protocols for the VpnServerConfiguration.␊ - */␊ - vpnProtocols?: (("IkeV2" | "OpenVPN")[] | string)␊ - /**␊ - * VPN authentication types for the VpnServerConfiguration.␊ - */␊ - vpnAuthenticationTypes?: (("Certificate" | "Radius" | "AAD")[] | string)␊ - /**␊ - * VPN client root certificate of VpnServerConfiguration.␊ - */␊ - vpnClientRootCertificates?: (VpnServerConfigVpnClientRootCertificate6[] | string)␊ - /**␊ - * VPN client revoked certificate of VpnServerConfiguration.␊ - */␊ - vpnClientRevokedCertificates?: (VpnServerConfigVpnClientRevokedCertificate6[] | string)␊ - /**␊ - * Radius Server root certificate of VpnServerConfiguration.␊ - */␊ - radiusServerRootCertificates?: (VpnServerConfigRadiusServerRootCertificate6[] | string)␊ - /**␊ - * Radius client root certificate of VpnServerConfiguration.␊ - */␊ - radiusClientRootCertificates?: (VpnServerConfigRadiusClientRootCertificate6[] | string)␊ - /**␊ - * VpnClientIpsecPolicies for VpnServerConfiguration.␊ - */␊ - vpnClientIpsecPolicies?: (IpsecPolicy24[] | string)␊ - /**␊ - * The radius server address property of the VpnServerConfiguration resource for point to site client connection.␊ - */␊ - radiusServerAddress?: string␊ - /**␊ - * The radius secret property of the VpnServerConfiguration resource for point to site client connection.␊ - */␊ - radiusServerSecret?: string␊ - /**␊ - * Multiple Radius Server configuration for VpnServerConfiguration.␊ - */␊ - radiusServers?: (RadiusServer2[] | string)␊ - /**␊ - * The set of aad vpn authentication parameters.␊ - */␊ - aadAuthenticationParameters?: (AadAuthenticationParameters6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of VPN client root certificate of VpnServerConfiguration.␊ - */␊ - export interface VpnServerConfigVpnClientRootCertificate6 {␊ - /**␊ - * The certificate name.␊ - */␊ - name?: string␊ - /**␊ - * The certificate public data.␊ - */␊ - publicCertData?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the revoked VPN client certificate of VpnServerConfiguration.␊ - */␊ - export interface VpnServerConfigVpnClientRevokedCertificate6 {␊ - /**␊ - * The certificate name.␊ - */␊ - name?: string␊ - /**␊ - * The revoked VPN client certificate thumbprint.␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of Radius Server root certificate of VpnServerConfiguration.␊ - */␊ - export interface VpnServerConfigRadiusServerRootCertificate6 {␊ - /**␊ - * The certificate name.␊ - */␊ - name?: string␊ - /**␊ - * The certificate public data.␊ - */␊ - publicCertData?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Radius client root certificate of VpnServerConfiguration.␊ - */␊ - export interface VpnServerConfigRadiusClientRootCertificate6 {␊ - /**␊ - * The certificate name.␊ - */␊ - name?: string␊ - /**␊ - * The Radius client root certificate thumbprint.␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AAD Vpn authentication type related parameters.␊ - */␊ - export interface AadAuthenticationParameters6 {␊ - /**␊ - * AAD Vpn authentication parameter AAD tenant.␊ - */␊ - aadTenant?: string␊ - /**␊ - * AAD Vpn authentication parameter AAD audience.␊ - */␊ - aadAudience?: string␊ - /**␊ - * AAD Vpn authentication parameter AAD issuer.␊ - */␊ - aadIssuer?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Network/vpnSites␊ - */␊ - export interface VpnSites12 {␊ - name: string␊ - type: "Microsoft.Network/vpnSites"␊ - apiVersion: "2020-05-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Properties of the VPN site.␊ - */␊ - properties: (VpnSiteProperties12 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnSite.␊ - */␊ - export interface VpnSiteProperties12 {␊ - /**␊ - * The VirtualWAN to which the vpnSite belongs.␊ - */␊ - virtualWan?: (SubResource35 | string)␊ - /**␊ - * The device properties.␊ - */␊ - deviceProperties?: (DeviceProperties12 | string)␊ - /**␊ - * The ip-address for the vpn-site.␊ - */␊ - ipAddress?: string␊ - /**␊ - * The key for vpn-site that can be used for connections.␊ - */␊ - siteKey?: string␊ - /**␊ - * The AddressSpace that contains an array of IP address ranges.␊ - */␊ - addressSpace?: (AddressSpace35 | string)␊ - /**␊ - * The set of bgp properties.␊ - */␊ - bgpProperties?: (BgpSettings26 | string)␊ - /**␊ - * IsSecuritySite flag.␊ - */␊ - isSecuritySite?: (boolean | string)␊ - /**␊ - * List of all vpn site links.␊ - */␊ - vpnSiteLinks?: (VpnSiteLink8[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * List of properties of the device.␊ - */␊ - export interface DeviceProperties12 {␊ - /**␊ - * Name of the device Vendor.␊ - */␊ - deviceVendor?: string␊ - /**␊ - * Model of the device.␊ - */␊ - deviceModel?: string␊ - /**␊ - * Link speed.␊ - */␊ - linkSpeedInMbps?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VpnSiteLink Resource.␊ - */␊ - export interface VpnSiteLink8 {␊ - /**␊ - * Properties of the VPN site link.␊ - */␊ - properties?: (VpnSiteLinkProperties8 | string)␊ - /**␊ - * The name of the resource that is unique within a resource group. This name can be used to access the resource.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for VpnSite.␊ - */␊ - export interface VpnSiteLinkProperties8 {␊ - /**␊ - * The link provider properties.␊ - */␊ - linkProperties?: (VpnLinkProviderProperties8 | string)␊ - /**␊ - * The ip-address for the vpn-site-link.␊ - */␊ - ipAddress?: string␊ - /**␊ - * FQDN of vpn-site-link.␊ - */␊ - fqdn?: string␊ - /**␊ - * The set of bgp properties.␊ - */␊ - bgpProperties?: (VpnLinkBgpSettings8 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * List of properties of a link provider.␊ - */␊ - export interface VpnLinkProviderProperties8 {␊ - /**␊ - * Name of the link provider.␊ - */␊ - linkProviderName?: string␊ - /**␊ - * Link speed.␊ - */␊ - linkSpeedInMbps?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * BGP settings details for a link.␊ - */␊ - export interface VpnLinkBgpSettings8 {␊ - /**␊ - * The BGP speaker's ASN.␊ - */␊ - asn?: (number | string)␊ - /**␊ - * The BGP peering address and BGP identifier of this BGP speaker.␊ - */␊ - bgpPeeringAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataMigration/services␊ - */␊ - export interface Services2 {␊ - apiVersion: "2017-11-15-preview"␊ - /**␊ - * HTTP strong entity tag value. Ignored if submitted␊ - */␊ - etag?: string␊ - /**␊ - * The resource kind. Only 'vm' (the default) is supported.␊ - */␊ - kind?: string␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Name of the service␊ - */␊ - name: string␊ - /**␊ - * Properties of the Data Migration service instance␊ - */␊ - properties: (DataMigrationServiceProperties | string)␊ - resources?: ServicesProjectsChildResource[]␊ - /**␊ - * An Azure SKU instance␊ - */␊ - sku?: (ServiceSku | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.DataMigration/services"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Data Migration service instance␊ - */␊ - export interface DataMigrationServiceProperties {␊ - /**␊ - * The public key of the service, used to encrypt secrets sent to the service␊ - */␊ - publicKey?: string␊ - /**␊ - * The ID of the Microsoft.Network/virtualNetworks/subnets resource to which the service should be joined␊ - */␊ - virtualSubnetId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataMigration/services/projects␊ - */␊ - export interface ServicesProjectsChildResource {␊ - apiVersion: "2017-11-15-preview"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Name of the project␊ - */␊ - name: string␊ - /**␊ - * Project-specific properties␊ - */␊ - properties: (ProjectProperties1 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "projects"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Project-specific properties␊ - */␊ - export interface ProjectProperties1 {␊ - /**␊ - * List of DatabaseInfo␊ - */␊ - databasesInfo?: (DatabaseInfo[] | string)␊ - /**␊ - * Defines the connection properties of a server␊ - */␊ - sourceConnectionInfo?: (ConnectionInfo | string)␊ - /**␊ - * Source platform for the project.␊ - */␊ - sourcePlatform: (("SQL" | "Unknown") | string)␊ - /**␊ - * Defines the connection properties of a server␊ - */␊ - targetConnectionInfo?: (SqlConnectionInfo | string)␊ - /**␊ - * Target platform for the project.␊ - */␊ - targetPlatform: (("SQLDB" | "Unknown") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Project Database Details␊ - */␊ - export interface DatabaseInfo {␊ - /**␊ - * Name of the database␊ - */␊ - sourceDatabaseName: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information for connecting to SQL database server␊ - */␊ - export interface SqlConnectionInfo {␊ - /**␊ - * Additional connection settings␊ - */␊ - additionalSettings?: string␊ - /**␊ - * Authentication type to use for connection.␊ - */␊ - authentication?: (("None" | "WindowsAuthentication" | "SqlAuthentication" | "ActiveDirectoryIntegrated" | "ActiveDirectoryPassword") | string)␊ - /**␊ - * Data source in the format Protocol:MachineName\\SQLServerInstanceName,PortNumber␊ - */␊ - dataSource: string␊ - /**␊ - * Whether to encrypt the connection␊ - */␊ - encryptConnection?: (boolean | string)␊ - /**␊ - * Password credential.␊ - */␊ - password?: string␊ - /**␊ - * Whether to trust the server certificate␊ - */␊ - trustServerCertificate?: (boolean | string)␊ - type: "SqlConnectionInfo"␊ - /**␊ - * User name␊ - */␊ - userName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An Azure SKU instance␊ - */␊ - export interface ServiceSku {␊ - /**␊ - * The capacity of the SKU, if it supports scaling␊ - */␊ - capacity?: (number | string)␊ - /**␊ - * The SKU family, used when the service has multiple performance classes within a tier, such as 'A', 'D', etc. for virtual machines␊ - */␊ - family?: string␊ - /**␊ - * The unique name of the SKU, such as 'P3'␊ - */␊ - name?: string␊ - /**␊ - * The size of the SKU, used when the name alone does not denote a service size or when a SKU has multiple performance classes within a family, e.g. 'A1' for virtual machines␊ - */␊ - size?: string␊ - /**␊ - * The tier of the SKU, such as 'Free', 'Basic', 'Standard', or 'Premium'␊ - */␊ - tier?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataMigration/services/projects␊ - */␊ - export interface ServicesProjects {␊ - apiVersion: "2017-11-15-preview"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Name of the project␊ - */␊ - name: string␊ - /**␊ - * Project-specific properties␊ - */␊ - properties: (ProjectProperties1 | string)␊ - resources?: ServicesProjectsTasksChildResource[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.DataMigration/services/projects"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataMigration/services/projects/tasks␊ - */␊ - export interface ServicesProjectsTasksChildResource {␊ - apiVersion: "2017-11-15-preview"␊ - /**␊ - * HTTP strong entity tag value. This is ignored if submitted.␊ - */␊ - etag?: string␊ - /**␊ - * Name of the Task␊ - */␊ - name: string␊ - /**␊ - * Base class for all types of DMS task properties. If task is not supported by current client, this object is returned.␊ - */␊ - properties: (ProjectTaskProperties | string)␊ - type: "tasks"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties for the task that validates connection to SQL Server and also validates source server requirements␊ - */␊ - export interface ConnectToSourceSqlServerTaskProperties {␊ - /**␊ - * Input for the task that validates connection to SQL Server and also validates source server requirements␊ - */␊ - input?: (ConnectToSourceSqlServerTaskInput | string)␊ - taskType: "ConnectToSource.SqlServer"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Input for the task that validates connection to SQL Server and also validates source server requirements␊ - */␊ - export interface ConnectToSourceSqlServerTaskInput {␊ - /**␊ - * Permission group for validations.␊ - */␊ - checkPermissionsGroup?: (("Default" | "MigrationFromSqlServerToAzureDB") | string)␊ - /**␊ - * Information for connecting to SQL database server␊ - */␊ - sourceConnectionInfo: (SqlConnectionInfo | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties for the task that validates connection to SQL DB and target server requirements␊ - */␊ - export interface ConnectToTargetSqlDbTaskProperties {␊ - /**␊ - * Input for the task that validates connection to SQL DB and target server requirements␊ - */␊ - input?: (ConnectToTargetSqlDbTaskInput | string)␊ - taskType: "ConnectToTarget.SqlDb"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Input for the task that validates connection to SQL DB and target server requirements␊ - */␊ - export interface ConnectToTargetSqlDbTaskInput {␊ - /**␊ - * Information for connecting to SQL database server␊ - */␊ - targetConnectionInfo: (SqlConnectionInfo | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties for the task that collects user tables for the given list of databases␊ - */␊ - export interface GetUserTablesSqlTaskProperties {␊ - /**␊ - * Input for the task that collects user tables for the given list of databases␊ - */␊ - input?: (GetUserTablesSqlTaskInput | string)␊ - taskType: "GetUserTables.Sql"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Input for the task that collects user tables for the given list of databases␊ - */␊ - export interface GetUserTablesSqlTaskInput {␊ - /**␊ - * Information for connecting to SQL database server␊ - */␊ - connectionInfo: (SqlConnectionInfo | string)␊ - /**␊ - * List of database names to collect tables for␊ - */␊ - selectedDatabases: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties for the task that migrates on-prem SQL Server databases to Azure SQL Database␊ - */␊ - export interface MigrateSqlServerSqlDbTaskProperties {␊ - /**␊ - * Input for the task that migrates on-prem SQL Server databases to Azure SQL Database␊ - */␊ - input?: (MigrateSqlServerSqlDbTaskInput | string)␊ - taskType: "Migrate.SqlServer.SqlDb"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Input for the task that migrates on-prem SQL Server databases to Azure SQL Database␊ - */␊ - export interface MigrateSqlServerSqlDbTaskInput {␊ - /**␊ - * Databases to migrate␊ - */␊ - selectedDatabases: (MigrateSqlServerSqlDbDatabaseInput[] | string)␊ - /**␊ - * Information for connecting to SQL database server␊ - */␊ - sourceConnectionInfo: (SqlConnectionInfo | string)␊ - /**␊ - * Information for connecting to SQL database server␊ - */␊ - targetConnectionInfo: (SqlConnectionInfo | string)␊ - /**␊ - * Types of validations to run after the migration␊ - */␊ - validationOptions?: (MigrationValidationOptions | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Database specific information for SQL to Azure SQL DB migration task inputs␊ - */␊ - export interface MigrateSqlServerSqlDbDatabaseInput {␊ - /**␊ - * Whether to set database read only before migration␊ - */␊ - makeSourceDbReadOnly?: (boolean | string)␊ - /**␊ - * Name of the database␊ - */␊ - name?: string␊ - /**␊ - * Mapping of source to target tables␊ - */␊ - tableMap?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Name of target database. Note: Target database will be truncated before starting migration.␊ - */␊ - targetDatabaseName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Types of validations to run after the migration␊ - */␊ - export interface MigrationValidationOptions {␊ - /**␊ - * Allows to perform a checksum based data integrity validation between source and target for the selected database / tables .␊ - */␊ - enableDataIntegrityValidation?: (boolean | string)␊ - /**␊ - * Allows to perform a quick and intelligent query analysis by retrieving queries from the source database and executes them in the target. The result will have execution statistics for executions in source and target databases for the extracted queries.␊ - */␊ - enableQueryAnalysisValidation?: (boolean | string)␊ - /**␊ - * Allows to compare the schema information between source and target.␊ - */␊ - enableSchemaValidation?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataMigration/services␊ - */␊ - export interface Services3 {␊ - /**␊ - * Name of the service␊ - */␊ - name: string␊ - type: "Microsoft.DataMigration/services"␊ - apiVersion: "2017-11-15-privatepreview"␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * HTTP strong entity tag value. Ignored if submitted␊ - */␊ - etag?: string␊ - /**␊ - * The resource kind. Only 'vm' (the default) is supported.␊ - */␊ - kind?: string␊ - /**␊ - * Custom service properties␊ - */␊ - properties: (DataMigrationServiceProperties1 | string)␊ - /**␊ - * Service SKU␊ - */␊ - sku?: (ServiceSku1 | string)␊ - resources?: ServicesProjectsChildResource1[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Data Migration service instance␊ - */␊ - export interface DataMigrationServiceProperties1 {␊ - /**␊ - * The ID of the Microsoft.Network/virtualNetworks/subnets resource to which the service should be joined␊ - */␊ - virtualSubnetId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An Azure SKU instance␊ - */␊ - export interface ServiceSku1 {␊ - /**␊ - * The unique name of the SKU, such as 'P3'␊ - */␊ - name?: string␊ - /**␊ - * The tier of the SKU, such as 'Free', 'Basic', 'Standard', or 'Premium'␊ - */␊ - tier?: string␊ - /**␊ - * The SKU family, used when the service has multiple performance classes within a tier, such as 'A', 'D', etc. for virtual machines␊ - */␊ - family?: string␊ - /**␊ - * The size of the SKU, used when the name alone does not denote a service size or when a SKU has multiple performance classes within a family, e.g. 'A1' for virtual machines␊ - */␊ - size?: string␊ - /**␊ - * The capacity of the SKU, if it supports scaling␊ - */␊ - capacity?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataMigration/services/projects␊ - */␊ - export interface ServicesProjectsChildResource1 {␊ - /**␊ - * Name of the project␊ - */␊ - name: string␊ - type: "projects"␊ - apiVersion: "2017-11-15-privatepreview"␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Project properties␊ - */␊ - properties: (ProjectProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Project-specific properties␊ - */␊ - export interface ProjectProperties2 {␊ - /**␊ - * Source platform for the project.␊ - */␊ - sourcePlatform: (("SQL" | "Access" | "DB2" | "MySQL" | "Oracle" | "Sybase" | "Unknown") | string)␊ - /**␊ - * Target platform for the project.␊ - */␊ - targetPlatform: (("SQL10" | "SQL11" | "SQL12" | "SQL13" | "SQL14" | "SQLDB" | "SQLDW" | "SQLMI" | "SQLVM" | "Unknown") | string)␊ - /**␊ - * Information for connecting to source␊ - */␊ - sourceConnectionInfo?: (ConnectionInfo1 | string)␊ - /**␊ - * Information for connecting to target␊ - */␊ - targetConnectionInfo?: ((OracleConnectionInfo | MySqlConnectionInfo | {␊ - type?: "Unknown"␊ - [k: string]: unknown␊ - } | SqlConnectionInfo1) | string)␊ - /**␊ - * List of DatabaseInfo␊ - */␊ - databasesInfo?: (DatabaseInfo1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Project Database Details␊ - */␊ - export interface DatabaseInfo1 {␊ - /**␊ - * Name of the database␊ - */␊ - sourceDatabaseName: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataMigration/services/projects␊ - */␊ - export interface ServicesProjects1 {␊ - /**␊ - * Name of the project␊ - */␊ - name: string␊ - type: "Microsoft.DataMigration/services/projects"␊ - apiVersion: "2017-11-15-privatepreview"␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Project properties␊ - */␊ - properties: (ProjectProperties2 | string)␊ - resources?: ServicesProjectsTasksChildResource1[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataMigration/services/projects/tasks␊ - */␊ - export interface ServicesProjectsTasksChildResource1 {␊ - /**␊ - * Name of the Task␊ - */␊ - name: string␊ - type: "tasks"␊ - apiVersion: "2017-11-15-privatepreview"␊ - /**␊ - * HTTP strong entity tag value. This is ignored if submitted.␊ - */␊ - etag?: string␊ - /**␊ - * Custom task properties␊ - */␊ - properties: (ProjectTaskProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Input for task that validates migration input for SQL to SQL on VM migrations␊ - */␊ - export interface ValidateMigrationInputSqlServerSqlServerTaskInput {␊ - /**␊ - * Information for connecting to target␊ - */␊ - targetConnectionInfo: ({␊ - type?: "SqlConnectionInfo"␊ - [k: string]: unknown␊ - } | string)␊ - /**␊ - * Databases to migrate␊ - */␊ - selectedDatabases: (MigrateSqlServerSqlServerDatabaseInput[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Database specific information for SQL to SQL migration task inputs␊ - */␊ - export interface MigrateSqlServerSqlServerDatabaseInput {␊ - /**␊ - * Name of the database␊ - */␊ - name?: string␊ - /**␊ - * Name of the database at destination␊ - */␊ - restoreDatabaseName?: string␊ - /**␊ - * The backup and restore folder␊ - */␊ - backupAndRestoreFolder?: string␊ - /**␊ - * The list of database files␊ - */␊ - databaseFiles?: (DatabaseFileInput[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Database file specific information for input␊ - */␊ - export interface DatabaseFileInput {␊ - /**␊ - * Unique identifier for database file␊ - */␊ - id?: string␊ - /**␊ - * Logical name of the file␊ - */␊ - logicalName?: string␊ - /**␊ - * Operating-system full path of the file␊ - */␊ - physicalFullName?: string␊ - /**␊ - * Suggested full path of the file for restoring␊ - */␊ - restoreFullName?: string␊ - /**␊ - * Database file type.␊ - */␊ - fileType?: (("Rows" | "Log" | "Filestream" | "NotSupported" | "Fulltext") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Input for task that validates migration input for SQL to Cloud DB migrations␊ - */␊ - export interface ValidateMigrationInputSqlServerCloudDbTaskInput {␊ - /**␊ - * Information for connecting to target␊ - */␊ - targetConnectionInfo: ({␊ - type?: "SqlConnectionInfo"␊ - [k: string]: unknown␊ - } | string)␊ - /**␊ - * Databases to migrate␊ - */␊ - selectedDatabases: (MigrateSqlServerSqlServerDatabaseInput[] | string)␊ - /**␊ - * User name credential to connect to the backup share location␊ - */␊ - backupShareUserName: string␊ - /**␊ - * Password credential used to connect to the backup share location. It must be RSA encrypted by the public key of the VM, then base64 encoded. It must never be the plaintext! Cryptography class contains helper methods to perform the encryption.␊ - * ␊ - */␊ - backupSharePassword?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Input for the task that migrates on-prem SQL Server databases to SQL on VM␊ - */␊ - export interface MigrateSqlServerSqlServerTaskInput {␊ - /**␊ - * Information for connecting to source␊ - */␊ - sourceConnectionInfo: ({␊ - type?: "SqlConnectionInfo"␊ - [k: string]: unknown␊ - } | string)␊ - /**␊ - * Information for connecting to target␊ - */␊ - targetConnectionInfo: ({␊ - type?: "SqlConnectionInfo"␊ - [k: string]: unknown␊ - } | string)␊ - /**␊ - * Databases to migrate␊ - */␊ - selectedDatabases: (MigrateSqlServerSqlServerDatabaseInput[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Input for the task that migrates on-prem SQL Server databases to Azure SQL Database␊ - */␊ - export interface MigrateSqlServerSqlDbTaskInput1 {␊ - /**␊ - * Information for connecting to source␊ - */␊ - sourceConnectionInfo: ({␊ - type?: "SqlConnectionInfo"␊ - [k: string]: unknown␊ - } | string)␊ - /**␊ - * Information for connecting to target␊ - */␊ - targetConnectionInfo: ({␊ - type?: "SqlConnectionInfo"␊ - [k: string]: unknown␊ - } | string)␊ - /**␊ - * Databases to migrate␊ - */␊ - selectedDatabases: (MigrateSqlServerSqlDbDatabaseInput1[] | string)␊ - /**␊ - * Options for enabling various post migration validations. Available options, ␊ - * 1.) Data Integrity Check: Performs a checksum based comparison on source and target tables after the migration to ensure the correctness of the data. ␊ - * 2.) Schema Validation: Performs a thorough schema comparison between the source and target tables and provides a list of differences between the source and target database, 3.) Query Analysis: Executes a set of queries picked up automatically either from the Query Plan Cache or Query Store and execute them and compares the execution time between the source and target database.␊ - */␊ - validationOptions?: (MigrationValidationOptions1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Database specific information for SQL to Azure SQL DB migration task inputs␊ - */␊ - export interface MigrateSqlServerSqlDbDatabaseInput1 {␊ - /**␊ - * Name of the database␊ - */␊ - name?: string␊ - /**␊ - * Name of target database. Note: Target database will be truncated before starting migration.␊ - */␊ - targetDatabaseName?: string␊ - /**␊ - * Whether to set database read only before migration␊ - */␊ - makeSourceDbReadOnly?: (boolean | string)␊ - /**␊ - * Mapping of source to target tables␊ - */␊ - tableMap?: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Types of validations to run after the migration␊ - */␊ - export interface MigrationValidationOptions1 {␊ - /**␊ - * Allows to compare the schema information between source and target.␊ - */␊ - enableSchemaValidation?: (boolean | string)␊ - /**␊ - * Allows to perform a checksum based data integrity validation between source and target for the selected database / tables .␊ - */␊ - enableDataIntegrityValidation?: (boolean | string)␊ - /**␊ - * Allows to perform a quick and intelligent query analysis by retrieving queries from the source database and executes them in the target. The result will have execution statistics for executions in source and target databases for the extracted queries.␊ - */␊ - enableQueryAnalysisValidation?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Input for task that migrates SQL Server databases to Cloud DB␊ - */␊ - export interface MigrateSqlServerCloudDbTaskInput {␊ - /**␊ - * Information for connecting to source␊ - */␊ - sourceConnectionInfo: ({␊ - type?: "SqlConnectionInfo"␊ - [k: string]: unknown␊ - } | string)␊ - /**␊ - * Information for connecting to target␊ - */␊ - targetConnectionInfo: ({␊ - type?: "SqlConnectionInfo"␊ - [k: string]: unknown␊ - } | string)␊ - /**␊ - * Databases to migrate␊ - */␊ - selectedDatabases: (MigrateSqlServerSqlServerDatabaseInput[] | string)␊ - /**␊ - * User name credential to connect to the backup share location␊ - */␊ - backupShareUserName: string␊ - /**␊ - * Password credential used to connect to the backup share location. It must be RSA encrypted by the public key of the VM, then base64 encoded. It must never be the plaintext! Cryptography class contains helper methods to perform the encryption.␊ - * ␊ - */␊ - backupSharePassword?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Input for the task that reads configuration from project artifacts␊ - */␊ - export interface GetProjectDetailsNonSqlTaskInput {␊ - /**␊ - * Name of the migration project␊ - */␊ - projectName: string␊ - /**␊ - * A URL that points to the location to access project artifacts␊ - */␊ - projectLocation: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Input for the task that validates connection to SQL Server and target server requirements␊ - */␊ - export interface ConnectToTargetSqlServerTaskInput {␊ - /**␊ - * Connection information for target SQL Server␊ - */␊ - targetConnectionInfo: ({␊ - type?: "SqlConnectionInfo"␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Input for the task that validates connection to Cloud DB␊ - */␊ - export interface ConnectToTargetCloudDbTaskInput {␊ - /**␊ - * Connection information for target SQL Server␊ - */␊ - targetConnectionInfo: ({␊ - type?: "SqlConnectionInfo"␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Input for the task that collects user tables for the given list of databases␊ - */␊ - export interface GetUserTablesSqlTaskInput1 {␊ - /**␊ - * Connection information for SQL Server␊ - */␊ - connectionInfo: ({␊ - type?: "SqlConnectionInfo"␊ - [k: string]: unknown␊ - } | string)␊ - /**␊ - * List of database names to collect tables for␊ - */␊ - selectedDatabases: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Input for the task that validates connection to SQL DB and target server requirements␊ - */␊ - export interface ConnectToTargetSqlDbTaskInput1 {␊ - /**␊ - * Connection information for target SQL DB␊ - */␊ - targetConnectionInfo: ({␊ - type?: "SqlConnectionInfo"␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Input for the task that validates connection to SQL Server and also validates source server requirements␊ - */␊ - export interface ConnectToSourceSqlServerTaskInput1 {␊ - /**␊ - * Connection information for Source SQL Server␊ - */␊ - sourceConnectionInfo: ({␊ - type?: "SqlConnectionInfo"␊ - [k: string]: unknown␊ - } | string)␊ - /**␊ - * Permission group for validations.␊ - */␊ - checkPermissionsGroup?: (("Default" | "MigrationFromSqlServerToAzureDB" | "MigrationFromSqlServerToAzureMI" | "MigrationFromSqlServerToAzureVM" | "MigrationFromOracleToSQL" | "MigrationFromOracleToAzureDB" | "MigrationFromOracleToAzureDW" | "MigrationFromMySQLToSQL" | "MigrationFromMySQLToAzureDB") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Input for the task that validates MySQL database connection␊ - */␊ - export interface ConnectToSourceMySqlTaskInput {␊ - /**␊ - * Information for connecting to MySQL source␊ - */␊ - sourceConnectionInfo: ({␊ - type?: "MySqlConnectionInfo"␊ - [k: string]: unknown␊ - } | string)␊ - /**␊ - * Permission group for validations.␊ - */␊ - checkPermissionsGroup?: (("Default" | "MigrationFromSqlServerToAzureDB" | "MigrationFromSqlServerToAzureMI" | "MigrationFromSqlServerToAzureVM" | "MigrationFromOracleToSQL" | "MigrationFromOracleToAzureDB" | "MigrationFromOracleToAzureDW" | "MigrationFromMySQLToSQL" | "MigrationFromMySQLToAzureDB") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Input for the task that validates Oracle database connection␊ - */␊ - export interface ConnectToSourceOracleTaskInput {␊ - /**␊ - * Information for connecting to Oracle source␊ - */␊ - sourceConnectionInfo: ({␊ - type?: "OracleConnectionInfo"␊ - [k: string]: unknown␊ - } | string)␊ - /**␊ - * Permission group for validations.␊ - */␊ - checkPermissionsGroup?: (("Default" | "MigrationFromSqlServerToAzureDB" | "MigrationFromSqlServerToAzureMI" | "MigrationFromSqlServerToAzureVM" | "MigrationFromOracleToSQL" | "MigrationFromOracleToAzureDB" | "MigrationFromOracleToAzureDW" | "MigrationFromMySQLToSQL" | "MigrationFromMySQLToAzureDB") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Input for task that migrates MySQL databases to Azure and SQL Server databases␊ - */␊ - export interface MigrateMySqlSqlTaskInput {␊ - /**␊ - * Information for connecting to target␊ - */␊ - targetConnectionInfo: ({␊ - type?: "SqlConnectionInfo"␊ - [k: string]: unknown␊ - } | string)␊ - /**␊ - * Target database name␊ - */␊ - targetDatabaseName: string␊ - /**␊ - * Name of the migration project␊ - */␊ - projectName: string␊ - /**␊ - * An URL that points to the drop location to access project artifacts␊ - */␊ - projectLocation: string␊ - /**␊ - * Metadata of the tables selected for migration␊ - */␊ - selectedTables: (NonSqlDataMigrationTable[] | string)␊ - /**␊ - * Information for connecting to MySQL source␊ - */␊ - sourceConnectionInfo: ({␊ - type?: "MySqlConnectionInfo"␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines metadata for table to be migrated␊ - */␊ - export interface NonSqlDataMigrationTable {␊ - /**␊ - * Source table name␊ - */␊ - sourceName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Input for task that migrates Oracle databases to Azure and SQL Server databases␊ - */␊ - export interface MigrateOracleSqlTaskInput {␊ - /**␊ - * Information for connecting to target␊ - */␊ - targetConnectionInfo: ({␊ - type?: "SqlConnectionInfo"␊ - [k: string]: unknown␊ - } | string)␊ - /**␊ - * Target database name␊ - */␊ - targetDatabaseName: string␊ - /**␊ - * Name of the migration project␊ - */␊ - projectName: string␊ - /**␊ - * An URL that points to the drop location to access project artifacts␊ - */␊ - projectLocation: string␊ - /**␊ - * Metadata of the tables selected for migration␊ - */␊ - selectedTables: (NonSqlDataMigrationTable[] | string)␊ - /**␊ - * Information for connecting to Oracle source␊ - */␊ - sourceConnectionInfo: ({␊ - type?: "OracleConnectionInfo"␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Consumption/budgets␊ - */␊ - export interface Budgets {␊ - apiVersion: "2018-01-31"␊ - /**␊ - * eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not.␊ - */␊ - eTag?: string␊ - /**␊ - * Budget Name.␊ - */␊ - name: string␊ - /**␊ - * The properties of the budget.␊ - */␊ - properties: (BudgetProperties | string)␊ - type: "Microsoft.Consumption/budgets"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the budget.␊ - */␊ - export interface BudgetProperties {␊ - /**␊ - * The total amount of cost to track with the budget␊ - */␊ - amount: (number | string)␊ - /**␊ - * The category of the budget, whether the budget tracks cost or usage.␊ - */␊ - category: (("Cost" | "Usage") | string)␊ - /**␊ - * May be used to filter budgets by resource group, resource, or meter.␊ - */␊ - filters?: (Filters1 | string)␊ - /**␊ - * Dictionary of notifications associated with the budget. Budget can have up to five notifications.␊ - */␊ - notifications?: ({␊ - [k: string]: Notification␊ - } | string)␊ - /**␊ - * The time covered by a budget. Tracking of the amount will be reset based on the time grain.␊ - */␊ - timeGrain: (("Monthly" | "Quarterly" | "Annually") | string)␊ - /**␊ - * The start and end date for a budget.␊ - */␊ - timePeriod: (BudgetTimePeriod | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * May be used to filter budgets by resource group, resource, or meter.␊ - */␊ - export interface Filters1 {␊ - /**␊ - * The list of filters on meters, mandatory for budgets of usage category. ␊ - */␊ - meters?: (string[] | string)␊ - /**␊ - * The list of filters on resource groups, allowed at subscription level only.␊ - */␊ - resourceGroups?: (string[] | string)␊ - /**␊ - * The list of filters on resources.␊ - */␊ - resources?: string[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The notification associated with a budget.␊ - */␊ - export interface Notification {␊ - /**␊ - * Email addresses to send the budget notification to when the threshold is exceeded.␊ - */␊ - contactEmails: (string[] | string)␊ - /**␊ - * Action groups to send the budget notification to when the threshold is exceeded.␊ - */␊ - contactGroups?: (string[] | string)␊ - /**␊ - * Contact roles to send the budget notification to when the threshold is exceeded.␊ - */␊ - contactRoles?: (string[] | string)␊ - /**␊ - * The notification is enabled or not.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * The comparison operator.␊ - */␊ - operator: (("EqualTo" | "GreaterThan" | "GreaterThanOrEqualTo") | string)␊ - /**␊ - * Threshold value associated with a notification. Notification is sent when the cost exceeded the threshold. It is always percent and has to be between 0 and 1000.␊ - */␊ - threshold: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The start and end date for a budget.␊ - */␊ - export interface BudgetTimePeriod {␊ - /**␊ - * The end date for the budget. If not provided, we default this to 10 years from the start date.␊ - */␊ - endDate?: string␊ - /**␊ - * The start date for the budget.␊ - */␊ - startDate: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.BatchAI/clusters␊ - */␊ - export interface Clusters14 {␊ - apiVersion: "2018-03-01"␊ - /**␊ - * The region in which to create the cluster.␊ - */␊ - location: string␊ - /**␊ - * The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.␊ - */␊ - name: string␊ - /**␊ - * The properties of a Cluster.␊ - */␊ - properties: (ClusterBaseProperties | string)␊ - /**␊ - * The user specified tags associated with the Cluster.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.BatchAI/clusters"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a Cluster.␊ - */␊ - export interface ClusterBaseProperties {␊ - /**␊ - * Use this to prepare the VM. NOTE: The volumes specified in mountVolumes are mounted first and then the setupTask is run. Therefore the setup task can use local mountPaths in its execution.␊ - */␊ - nodeSetup?: (NodeSetup | string)␊ - /**␊ - * At least one of manual or autoScale settings must be specified. Only one of manual or autoScale settings can be specified. If autoScale settings are specified, the system automatically scales the cluster up and down (within the supplied limits) based on the pending jobs on the cluster.␊ - */␊ - scaleSettings?: (ScaleSettings7 | string)␊ - /**␊ - * Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet.␊ - */␊ - subnet?: (ResourceId5 | string)␊ - /**␊ - * Settings for user account that gets created on each on the nodes of a cluster.␊ - */␊ - userAccountSettings: (UserAccountSettings | string)␊ - /**␊ - * Settings for OS image.␊ - */␊ - virtualMachineConfiguration?: (VirtualMachineConfiguration1 | string)␊ - /**␊ - * Default is dedicated.␊ - */␊ - vmPriority?: (("dedicated" | "lowpriority") | string)␊ - /**␊ - * All virtual machines in a cluster are the same size. For information about available VM sizes for clusters using images from the Virtual Machines Marketplace (see Sizes for Virtual Machines (Linux) or Sizes for Virtual Machines (Windows). Batch AI service supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series).␊ - */␊ - vmSize: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Use this to prepare the VM. NOTE: The volumes specified in mountVolumes are mounted first and then the setupTask is run. Therefore the setup task can use local mountPaths in its execution.␊ - */␊ - export interface NodeSetup {␊ - /**␊ - * Details of volumes to mount on the cluster.␊ - */␊ - mountVolumes?: (MountVolumes | string)␊ - /**␊ - * Performance counters reporting settings.␊ - */␊ - performanceCountersSettings?: (PerformanceCountersSettings | string)␊ - /**␊ - * Specifies a setup task which can be used to customize the compute nodes of the cluster.␊ - */␊ - setupTask?: (SetupTask | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Details of volumes to mount on the cluster.␊ - */␊ - export interface MountVolumes {␊ - /**␊ - * References to Azure Blob FUSE that are to be mounted to the cluster nodes.␊ - */␊ - azureBlobFileSystems?: (AzureBlobFileSystemReference[] | string)␊ - /**␊ - * References to Azure File Shares that are to be mounted to the cluster nodes.␊ - */␊ - azureFileShares?: (AzureFileShareReference[] | string)␊ - fileServers?: (FileServerReference[] | string)␊ - unmanagedFileSystems?: (UnmanagedFileSystemReference[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Provides required information, for the service to be able to mount Azure Blob Storage container on the cluster nodes.␊ - */␊ - export interface AzureBlobFileSystemReference {␊ - accountName: string␊ - containerName: string␊ - /**␊ - * Credentials to access Azure File Share.␊ - */␊ - credentials: (AzureStorageCredentialsInfo | string)␊ - mountOptions?: string␊ - /**␊ - * Note that all cluster level blob file systems will be mounted under $AZ_BATCHAI_MOUNT_ROOT location and all job level blob file systems will be mounted under $AZ_BATCHAI_JOB_MOUNT_ROOT.␊ - */␊ - relativeMountPath: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Credentials to access Azure File Share.␊ - */␊ - export interface AzureStorageCredentialsInfo {␊ - /**␊ - * One of accountKey or accountKeySecretReference must be specified.␊ - */␊ - accountKey?: string␊ - /**␊ - * Describes a reference to Key Vault Secret.␊ - */␊ - accountKeySecretReference?: (KeyVaultSecretReference3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a reference to Key Vault Secret.␊ - */␊ - export interface KeyVaultSecretReference3 {␊ - secretUrl: string␊ - /**␊ - * Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet.␊ - */␊ - sourceVault: (ResourceId5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet.␊ - */␊ - export interface ResourceId5 {␊ - /**␊ - * The ID of the resource␊ - */␊ - id: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Details of the Azure File Share to mount on the cluster.␊ - */␊ - export interface AzureFileShareReference {␊ - accountName: string␊ - azureFileUrl: string␊ - /**␊ - * Credentials to access Azure File Share.␊ - */␊ - credentials: (AzureStorageCredentialsInfo | string)␊ - /**␊ - * Default value is 0777. Valid only if OS is linux.␊ - */␊ - directoryMode?: string␊ - /**␊ - * Default value is 0777. Valid only if OS is linux.␊ - */␊ - fileMode?: string␊ - /**␊ - * Note that all cluster level file shares will be mounted under $AZ_BATCHAI_MOUNT_ROOT location and all job level file shares will be mounted under $AZ_BATCHAI_JOB_MOUNT_ROOT.␊ - */␊ - relativeMountPath: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Provides required information, for the service to be able to mount Azure FileShare on the cluster nodes.␊ - */␊ - export interface FileServerReference {␊ - /**␊ - * Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet.␊ - */␊ - fileServer: (ResourceId5 | string)␊ - mountOptions?: string␊ - /**␊ - * Note that all cluster level file servers will be mounted under $AZ_BATCHAI_MOUNT_ROOT location and job level file servers will be mounted under $AZ_BATCHAI_JOB_MOUNT_ROOT.␊ - */␊ - relativeMountPath: string␊ - /**␊ - * If this property is not specified, the entire File Server will be mounted.␊ - */␊ - sourceDirectory?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Details of the file system to mount on the compute cluster nodes.␊ - */␊ - export interface UnmanagedFileSystemReference {␊ - mountCommand: string␊ - /**␊ - * Note that all cluster level unmanaged file system will be mounted under $AZ_BATCHAI_MOUNT_ROOT location and job level unmanaged file system will be mounted under $AZ_BATCHAI_JOB_MOUNT_ROOT.␊ - */␊ - relativeMountPath: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Performance counters reporting settings.␊ - */␊ - export interface PerformanceCountersSettings {␊ - /**␊ - * Specifies Azure Application Insights information for performance counters reporting.␊ - */␊ - appInsightsReference: (AppInsightsReference | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies Azure Application Insights information for performance counters reporting.␊ - */␊ - export interface AppInsightsReference {␊ - /**␊ - * Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet.␊ - */␊ - component: (ResourceId5 | string)␊ - instrumentationKey?: string␊ - /**␊ - * Describes a reference to Key Vault Secret.␊ - */␊ - instrumentationKeySecretReference?: (KeyVaultSecretReference3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies a setup task which can be used to customize the compute nodes of the cluster.␊ - */␊ - export interface SetupTask {␊ - commandLine: string␊ - environmentVariables?: (EnvironmentVariable[] | string)␊ - /**␊ - * Note. Non-elevated tasks are run under an account added into sudoer list and can perform sudo when required.␊ - */␊ - runElevated?: (boolean | string)␊ - /**␊ - * Server will never report values of these variables back.␊ - */␊ - secrets?: (EnvironmentVariableWithSecretValue[] | string)␊ - /**␊ - * The prefix of a path where the Batch AI service will upload the stdout and stderr of the setup task.␊ - */␊ - stdOutErrPathPrefix: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A collection of environment variables to set.␊ - */␊ - export interface EnvironmentVariable {␊ - name: string␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A collection of environment variables with secret values to set.␊ - */␊ - export interface EnvironmentVariableWithSecretValue {␊ - name: string␊ - value?: string␊ - /**␊ - * Describes a reference to Key Vault Secret.␊ - */␊ - valueSecretReference?: (KeyVaultSecretReference3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * At least one of manual or autoScale settings must be specified. Only one of manual or autoScale settings can be specified. If autoScale settings are specified, the system automatically scales the cluster up and down (within the supplied limits) based on the pending jobs on the cluster.␊ - */␊ - export interface ScaleSettings7 {␊ - /**␊ - * The system automatically scales the cluster up and down (within minimumNodeCount and maximumNodeCount) based on the pending and running jobs on the cluster.␊ - */␊ - autoScale?: (AutoScaleSettings1 | string)␊ - /**␊ - * Manual scale settings for the cluster.␊ - */␊ - manual?: (ManualScaleSettings | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The system automatically scales the cluster up and down (within minimumNodeCount and maximumNodeCount) based on the pending and running jobs on the cluster.␊ - */␊ - export interface AutoScaleSettings1 {␊ - initialNodeCount?: ((number & string) | string)␊ - maximumNodeCount: (number | string)␊ - minimumNodeCount: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Manual scale settings for the cluster.␊ - */␊ - export interface ManualScaleSettings {␊ - /**␊ - * The default value is requeue.␊ - */␊ - nodeDeallocationOption?: (("requeue" | "terminate" | "waitforjobcompletion" | "unknown") | string)␊ - /**␊ - * Default is 0. If autoScaleSettings are not specified, then the Cluster starts with this target.␊ - */␊ - targetNodeCount: ((number & string) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Settings for user account that gets created on each on the nodes of a cluster.␊ - */␊ - export interface UserAccountSettings {␊ - adminUserName: string␊ - adminUserPassword?: string␊ - adminUserSshPublicKey?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Settings for OS image.␊ - */␊ - export interface VirtualMachineConfiguration1 {␊ - /**␊ - * The image reference.␊ - */␊ - imageReference?: (ImageReference5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The image reference.␊ - */␊ - export interface ImageReference5 {␊ - offer: string␊ - publisher: string␊ - sku: string␊ - version?: string␊ - /**␊ - * The virtual machine image must be in the same region and subscription as the cluster. 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. Note, you need to provide publisher, offer and sku of the base OS image of which the custom image has been derived from.␊ - */␊ - virtualMachineImageId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.BatchAI/fileServers␊ - */␊ - export interface FileServers {␊ - apiVersion: "2018-03-01"␊ - /**␊ - * The region in which to create the File Server.␊ - */␊ - location: string␊ - /**␊ - * The name of the file server within the specified resource group. File server names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.␊ - */␊ - name: string␊ - /**␊ - * The properties of a file server.␊ - */␊ - properties: (FileServerBaseProperties | string)␊ - /**␊ - * The user specified tags associated with the File Server.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.BatchAI/fileServers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a file server.␊ - */␊ - export interface FileServerBaseProperties {␊ - /**␊ - * Settings for the data disk which would be created for the File Server.␊ - */␊ - dataDisks: (DataDisks | string)␊ - /**␊ - * SSH configuration settings for the VM␊ - */␊ - sshConfiguration: (SshConfiguration3 | string)␊ - /**␊ - * Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet.␊ - */␊ - subnet?: (ResourceId5 | string)␊ - /**␊ - * For information about available VM sizes for fileservers from the Virtual Machines Marketplace, see Sizes for Virtual Machines (Linux).␊ - */␊ - vmSize: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Settings for the data disk which would be created for the File Server.␊ - */␊ - export interface DataDisks {␊ - cachingType?: (("none" | "readonly" | "readwrite") | string)␊ - diskCount: (number | string)␊ - diskSizeInGB: (number | string)␊ - storageAccountType: (("Standard_LRS" | "Premium_LRS") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSH configuration settings for the VM␊ - */␊ - export interface SshConfiguration3 {␊ - /**␊ - * Default value is '*' can be used to match all source IPs. Maximum number of IP ranges that can be specified are 400.␊ - */␊ - publicIPsToAllow?: (string[] | string)␊ - /**␊ - * Settings for user account that gets created on each on the nodes of a cluster.␊ - */␊ - userAccountSettings: (UserAccountSettings | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.BatchAI/jobs␊ - */␊ - export interface Jobs1 {␊ - apiVersion: "2018-03-01"␊ - /**␊ - * The region in which to create the job.␊ - */␊ - location: string␊ - /**␊ - * The name of the job within the specified resource group. Job names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.␊ - */␊ - name: string␊ - /**␊ - * The properties of a Batch AI job.␊ - */␊ - properties: (JobBaseProperties | string)␊ - /**␊ - * The user specified tags associated with the job.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.BatchAI/jobs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a Batch AI job.␊ - */␊ - export interface JobBaseProperties {␊ - /**␊ - * Specifies the settings for Caffe2 job.␊ - */␊ - caffe2Settings?: (Caffe2Settings | string)␊ - /**␊ - * Specifies the settings for Caffe job.␊ - */␊ - caffeSettings?: (CaffeSettings | string)␊ - /**␊ - * Specifies the settings for Chainer job.␊ - */␊ - chainerSettings?: (ChainerSettings | string)␊ - /**␊ - * Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet.␊ - */␊ - cluster: (ResourceId5 | string)␊ - /**␊ - * Specifies the settings for CNTK (aka Microsoft Cognitive Toolkit) job.␊ - */␊ - cntkSettings?: (CNTKsettings | string)␊ - /**␊ - * Constraints associated with the Job.␊ - */␊ - constraints?: (JobBasePropertiesConstraints | string)␊ - /**␊ - * Settings for the container to be downloaded.␊ - */␊ - containerSettings?: (ContainerSettings | string)␊ - /**␊ - * Specifies the settings for a custom tool kit job.␊ - */␊ - customToolkitSettings?: (CustomToolkitSettings | string)␊ - /**␊ - * Batch AI will setup these additional environment variables for the job.␊ - */␊ - environmentVariables?: (EnvironmentVariable[] | string)␊ - /**␊ - * Describe the experiment information of the job␊ - */␊ - experimentName?: string␊ - inputDirectories?: (InputDirectory[] | string)␊ - /**␊ - * Specifies the settings for job preparation.␊ - */␊ - jobPreparation?: (JobPreparation | string)␊ - /**␊ - * Details of volumes to mount on the cluster.␊ - */␊ - mountVolumes?: (MountVolumes | string)␊ - /**␊ - * The job will be gang scheduled on that many compute nodes␊ - */␊ - nodeCount: (number | string)␊ - outputDirectories?: (OutputDirectory[] | string)␊ - /**␊ - * Priority associated with the job. 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.␊ - */␊ - priority?: ((number & string) | string)␊ - /**␊ - * Specifies the settings for pyTorch job.␊ - */␊ - pyTorchSettings?: (PyTorchSettings | string)␊ - /**␊ - * Batch AI will setup these additional environment variables for the job. Server will never report values of these variables back.␊ - */␊ - secrets?: (EnvironmentVariableWithSecretValue[] | string)␊ - /**␊ - * The path where the Batch AI service will upload stdout and stderror of the job.␊ - */␊ - stdOutErrPathPrefix: string␊ - /**␊ - * Specifies the settings for TensorFlow job.␊ - */␊ - tensorFlowSettings?: (TensorFlowSettings | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the settings for Caffe2 job.␊ - */␊ - export interface Caffe2Settings {␊ - commandLineArgs?: string␊ - pythonInterpreterPath?: string␊ - pythonScriptFilePath: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the settings for Caffe job.␊ - */␊ - export interface CaffeSettings {␊ - commandLineArgs?: string␊ - /**␊ - * This property cannot be specified if pythonScriptFilePath is specified.␊ - */␊ - configFilePath?: string␊ - /**␊ - * The default value for this property is equal to nodeCount property␊ - */␊ - processCount?: (number | string)␊ - /**␊ - * This property can be specified only if the pythonScriptFilePath is specified.␊ - */␊ - pythonInterpreterPath?: string␊ - /**␊ - * This property cannot be specified if configFilePath is specified.␊ - */␊ - pythonScriptFilePath?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the settings for Chainer job.␊ - */␊ - export interface ChainerSettings {␊ - commandLineArgs?: string␊ - /**␊ - * The default value for this property is equal to nodeCount property␊ - */␊ - processCount?: (number | string)␊ - pythonInterpreterPath?: string␊ - pythonScriptFilePath: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the settings for CNTK (aka Microsoft Cognitive Toolkit) job.␊ - */␊ - export interface CNTKsettings {␊ - commandLineArgs?: string␊ - /**␊ - * This property can be specified only if the languageType is 'BrainScript'.␊ - */␊ - configFilePath?: string␊ - /**␊ - * Valid values are 'BrainScript' or 'Python'.␊ - */␊ - languageType?: string␊ - /**␊ - * The default value for this property is equal to nodeCount property␊ - */␊ - processCount?: (number | string)␊ - /**␊ - * This property can be specified only if the languageType is 'Python'.␊ - */␊ - pythonInterpreterPath?: string␊ - /**␊ - * This property can be specified only if the languageType is 'Python'.␊ - */␊ - pythonScriptFilePath?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Constraints associated with the Job.␊ - */␊ - export interface JobBasePropertiesConstraints {␊ - /**␊ - * Default Value = 1 week.␊ - */␊ - maxWallClockTime?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Settings for the container to be downloaded.␊ - */␊ - export interface ContainerSettings {␊ - /**␊ - * Details of the container image such as name, URL and credentials.␊ - */␊ - imageSourceRegistry: (ImageSourceRegistry | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Details of the container image such as name, URL and credentials.␊ - */␊ - export interface ImageSourceRegistry {␊ - /**␊ - * Credentials to access a container image in a private repository.␊ - */␊ - credentials?: (PrivateRegistryCredentials | string)␊ - image: string␊ - serverUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Credentials to access a container image in a private repository.␊ - */␊ - export interface PrivateRegistryCredentials {␊ - /**␊ - * One of password or passwordSecretReference must be specified.␊ - */␊ - password?: string␊ - /**␊ - * Describes a reference to Key Vault Secret.␊ - */␊ - passwordSecretReference?: (KeyVaultSecretReference3 | string)␊ - username: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the settings for a custom tool kit job.␊ - */␊ - export interface CustomToolkitSettings {␊ - commandLine?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Input directory for the job.␊ - */␊ - export interface InputDirectory {␊ - /**␊ - * The path of the input directory will be available as a value of an environment variable with AZ_BATCHAI_INPUT_ name, where is the value of id attribute.␊ - */␊ - id: string␊ - path: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the settings for job preparation.␊ - */␊ - export interface JobPreparation {␊ - /**␊ - * If containerSettings is specified on the job, this commandLine will be executed in the same container as job. Otherwise it will be executed on the node.␊ - */␊ - commandLine: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Output directory for the job.␊ - */␊ - export interface OutputDirectory {␊ - /**␊ - * Default is true. If false, then the directory is not created and can be any directory path that the user specifies.␊ - */␊ - createNew?: (boolean | string)␊ - /**␊ - * The path of the output directory will be available as a value of an environment variable with AZ_BATCHAI_OUTPUT_ name, where is the value of id attribute.␊ - */␊ - id: string␊ - /**␊ - * NOTE: This is an absolute path to prefix. E.g. $AZ_BATCHAI_MOUNT_ROOT/MyNFS/MyLogs. You can find the full path to the output directory by combining pathPrefix, jobOutputDirectoryPathSegment (reported by get job) and pathSuffix.␊ - */␊ - pathPrefix: string␊ - /**␊ - * The suffix path where the output directory will be created. E.g. models. You can find the full path to the output directory by combining pathPrefix, jobOutputDirectoryPathSegment (reported by get job) and pathSuffix.␊ - */␊ - pathSuffix?: string␊ - /**␊ - * Default value is Custom. The possible values are Model, Logs, Summary, and Custom. Users can use multiple enums for a single directory. Eg. outPutType='Model,Logs, Summary'.␊ - */␊ - type?: (("model" | "logs" | "summary" | "custom") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the settings for pyTorch job.␊ - */␊ - export interface PyTorchSettings {␊ - commandLineArgs?: string␊ - /**␊ - * Valid values are 'TCP', 'Gloo' or 'MPI'. Not required for non-distributed jobs.␊ - */␊ - communicationBackend?: string␊ - /**␊ - * The default value for this property is equal to nodeCount property.␊ - */␊ - processCount?: (number | string)␊ - pythonInterpreterPath?: string␊ - pythonScriptFilePath: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the settings for TensorFlow job.␊ - */␊ - export interface TensorFlowSettings {␊ - masterCommandLineArgs?: string␊ - /**␊ - * This property is optional for single machine training.␊ - */␊ - parameterServerCommandLineArgs?: string␊ - /**␊ - * If specified, the value must be less than or equal to nodeCount. If not specified, the default value is equal to 1 for distributed TensorFlow training (This property is not applicable for single machine training). This property can be specified only for distributed TensorFlow training.␊ - */␊ - parameterServerCount?: (number | string)␊ - pythonInterpreterPath?: string␊ - pythonScriptFilePath: string␊ - /**␊ - * This property is optional for single machine training.␊ - */␊ - workerCommandLineArgs?: string␊ - /**␊ - * If specified, the value must be less than or equal to (nodeCount * numberOfGPUs per VM). If not specified, the default value is equal to nodeCount. This property can be specified only for distributed TensorFlow training␊ - */␊ - workerCount?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems␊ - */␊ - export interface VaultsBackupFabricsProtectionContainersProtectedItems {␊ - name: string␊ - type: "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems"␊ - apiVersion: "2016-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Optional ETag.␊ - */␊ - eTag?: string␊ - /**␊ - * ProtectedItemResource properties␊ - */␊ - properties: (ProtectedItem | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Additional information about Azure File Share backup item.␊ - */␊ - export interface AzureFileshareProtectedItemExtendedInfo {␊ - /**␊ - * The oldest backup copy available for this item in the service.␊ - */␊ - oldestRecoveryPoint?: string␊ - /**␊ - * Number of available backup copies associated with this backup item.␊ - */␊ - recoveryPointCount?: (number | string)␊ - /**␊ - * Indicates consistency of policy object and policy applied to this backup item.␊ - */␊ - policyState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure IaaS VM workload-specific Health Details.␊ - */␊ - export interface AzureIaaSVMHealthDetails {␊ - /**␊ - * Health Code␊ - */␊ - code?: (number | string)␊ - /**␊ - * Health Title␊ - */␊ - title?: string␊ - /**␊ - * Health Message␊ - */␊ - message?: string␊ - /**␊ - * Health Recommended Actions␊ - */␊ - recommendations?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Additional information on Azure IaaS VM specific backup item.␊ - */␊ - export interface AzureIaaSVMProtectedItemExtendedInfo {␊ - /**␊ - * The oldest backup copy available for this backup item.␊ - */␊ - oldestRecoveryPoint?: string␊ - /**␊ - * Number of backup copies available for this backup item.␊ - */␊ - recoveryPointCount?: (number | string)␊ - /**␊ - * Specifies if backup policy associated with the backup item is inconsistent.␊ - */␊ - policyInconsistent?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Additional information on Azure Sql specific protected item.␊ - */␊ - export interface AzureSqlProtectedItemExtendedInfo {␊ - /**␊ - * The oldest backup copy available for this item in the service.␊ - */␊ - oldestRecoveryPoint?: string␊ - /**␊ - * Number of available backup copies associated with this backup item.␊ - */␊ - recoveryPointCount?: (number | string)␊ - /**␊ - * State of the backup policy associated with this backup item.␊ - */␊ - policyState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Error Detail class which encapsulates Code, Message and Recommendations.␊ - */␊ - export interface ErrorDetail {␊ - /**␊ - * Error code.␊ - */␊ - code?: string␊ - /**␊ - * Error Message related to the Code.␊ - */␊ - message?: string␊ - /**␊ - * List of recommendation strings.␊ - */␊ - recommendations?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Additional information on Azure Workload for SQL specific backup item.␊ - */␊ - export interface AzureVmWorkloadProtectedItemExtendedInfo {␊ - /**␊ - * The oldest backup copy available for this backup item.␊ - */␊ - oldestRecoveryPoint?: string␊ - /**␊ - * Number of backup copies available for this backup item.␊ - */␊ - recoveryPointCount?: (number | string)␊ - /**␊ - * Indicates consistency of policy object and policy applied to this backup item.␊ - */␊ - policyState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Additional information of DPM Protected item.␊ - */␊ - export interface DPMProtectedItemExtendedInfo {␊ - /**␊ - * Attribute to provide information on various DBs.␊ - */␊ - protectableObjectLoadPath?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * To check if backup item is disk protected.␊ - */␊ - protected?: (boolean | string)␊ - /**␊ - * To check if backup item is cloud protected.␊ - */␊ - isPresentOnCloud?: (boolean | string)␊ - /**␊ - * Last backup status information on backup item.␊ - */␊ - lastBackupStatus?: string␊ - /**␊ - * Last refresh time on backup item.␊ - */␊ - lastRefreshedAt?: string␊ - /**␊ - * Oldest cloud recovery point time.␊ - */␊ - oldestRecoveryPoint?: string␊ - /**␊ - * cloud recovery point count.␊ - */␊ - recoveryPointCount?: (number | string)␊ - /**␊ - * Oldest disk recovery point time.␊ - */␊ - onPremiseOldestRecoveryPoint?: string␊ - /**␊ - * latest disk recovery point time.␊ - */␊ - onPremiseLatestRecoveryPoint?: string␊ - /**␊ - * disk recovery point count.␊ - */␊ - onPremiseRecoveryPointCount?: (number | string)␊ - /**␊ - * To check if backup item is collocated.␊ - */␊ - isCollocated?: (boolean | string)␊ - /**␊ - * Protection group name of the backup item.␊ - */␊ - protectionGroupName?: string␊ - /**␊ - * Used Disk storage in bytes.␊ - */␊ - diskStorageUsedInBytes?: string␊ - /**␊ - * total Disk storage in bytes.␊ - */␊ - totalDiskStorageSizeInBytes?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Additional information on the backed up item.␊ - */␊ - export interface MabFileFolderProtectedItemExtendedInfo {␊ - /**␊ - * Last time when the agent data synced to service.␊ - */␊ - lastRefreshedAt?: string␊ - /**␊ - * The oldest backup copy available.␊ - */␊ - oldestRecoveryPoint?: string␊ - /**␊ - * Number of backup copies associated with the backup item.␊ - */␊ - recoveryPointCount?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.RecoveryServices/vaults/backupPolicies␊ - */␊ - export interface VaultsBackupPolicies {␊ - name: string␊ - type: "Microsoft.RecoveryServices/vaults/backupPolicies"␊ - apiVersion: "2016-12-01"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Optional ETag.␊ - */␊ - eTag?: string␊ - /**␊ - * ProtectionPolicyResource properties␊ - */␊ - properties: (ProtectionPolicy | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Daily retention schedule.␊ - */␊ - export interface DailyRetentionSchedule {␊ - /**␊ - * Retention times of retention policy.␊ - */␊ - retentionTimes?: (string[] | string)␊ - /**␊ - * Retention duration of retention Policy.␊ - */␊ - retentionDuration?: (RetentionDuration | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Retention duration.␊ - */␊ - export interface RetentionDuration {␊ - /**␊ - * Count of duration types. Retention duration is obtained by the counting the duration type Count times.␍␊ - * For example, when Count = 3 and DurationType = Weeks, retention duration will be three weeks.␊ - */␊ - count?: (number | string)␊ - /**␊ - * Retention duration type of retention policy.␊ - */␊ - durationType?: (("Invalid" | "Days" | "Weeks" | "Months" | "Years") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Weekly retention schedule.␊ - */␊ - export interface WeeklyRetentionSchedule {␊ - /**␊ - * List of days of week for weekly retention policy.␊ - */␊ - daysOfTheWeek?: (("Sunday" | "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday")[] | string)␊ - /**␊ - * Retention times of retention policy.␊ - */␊ - retentionTimes?: (string[] | string)␊ - /**␊ - * Retention duration of retention Policy.␊ - */␊ - retentionDuration?: (RetentionDuration | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Monthly retention schedule.␊ - */␊ - export interface MonthlyRetentionSchedule {␊ - /**␊ - * Retention schedule format type for monthly retention policy.␊ - */␊ - retentionScheduleFormatType?: (("Invalid" | "Daily" | "Weekly") | string)␊ - /**␊ - * Daily retention format for monthly retention policy.␊ - */␊ - retentionScheduleDaily?: (DailyRetentionFormat | string)␊ - /**␊ - * Weekly retention format for monthly retention policy.␊ - */␊ - retentionScheduleWeekly?: (WeeklyRetentionFormat | string)␊ - /**␊ - * Retention times of retention policy.␊ - */␊ - retentionTimes?: (string[] | string)␊ - /**␊ - * Retention duration of retention Policy.␊ - */␊ - retentionDuration?: (RetentionDuration | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Daily retention format.␊ - */␊ - export interface DailyRetentionFormat {␊ - /**␊ - * List of days of the month.␊ - */␊ - daysOfTheMonth?: (Day[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Day of the week.␊ - */␊ - export interface Day {␊ - /**␊ - * Date of the month␊ - */␊ - date?: (number | string)␊ - /**␊ - * Whether Date is last date of month␊ - */␊ - isLast?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Weekly retention format.␊ - */␊ - export interface WeeklyRetentionFormat {␊ - /**␊ - * List of days of the week.␊ - */␊ - daysOfTheWeek?: (("Sunday" | "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday")[] | string)␊ - /**␊ - * List of weeks of month.␊ - */␊ - weeksOfTheMonth?: (("First" | "Second" | "Third" | "Fourth" | "Last" | "Invalid")[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Yearly retention schedule.␊ - */␊ - export interface YearlyRetentionSchedule {␊ - /**␊ - * Retention schedule format for yearly retention policy.␊ - */␊ - retentionScheduleFormatType?: (("Invalid" | "Daily" | "Weekly") | string)␊ - /**␊ - * List of months of year of yearly retention policy.␊ - */␊ - monthsOfYear?: (("Invalid" | "January" | "February" | "March" | "April" | "May" | "June" | "July" | "August" | "September" | "October" | "November" | "December")[] | string)␊ - /**␊ - * Daily retention format for yearly retention policy.␊ - */␊ - retentionScheduleDaily?: (DailyRetentionFormat | string)␊ - /**␊ - * Weekly retention format for yearly retention policy.␊ - */␊ - retentionScheduleWeekly?: (WeeklyRetentionFormat | string)␊ - /**␊ - * Retention times of retention policy.␊ - */␊ - retentionTimes?: (string[] | string)␊ - /**␊ - * Retention duration of retention Policy.␊ - */␊ - retentionDuration?: (RetentionDuration | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Common settings field for backup management␊ - */␊ - export interface Settings {␊ - /**␊ - * TimeZone optional input as string. For example: TimeZone = "Pacific Standard Time".␊ - */␊ - timeZone?: string␊ - /**␊ - * SQL compression flag␊ - */␊ - issqlcompression?: (boolean | string)␊ - /**␊ - * Workload compression flag. This has been added so that 'isSqlCompression'␍␊ - * will be deprecated once clients upgrade to consider this flag.␊ - */␊ - isCompression?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Sub-protection policy which includes schedule and retention␊ - */␊ - export interface SubProtectionPolicy {␊ - /**␊ - * Type of backup policy type.␊ - */␊ - policyType?: (("Invalid" | "Full" | "Differential" | "Log" | "CopyOnlyFull") | string)␊ - /**␊ - * Backup schedule specified as part of backup policy.␊ - */␊ - schedulePolicy?: (({␊ - schedulePolicyType?: ("SchedulePolicy" | string)␊ - [k: string]: unknown␊ - } | LogSchedulePolicy | LongTermSchedulePolicy | SimpleSchedulePolicy) | string)␊ - /**␊ - * Retention policy with the details on backup copy retention ranges.␊ - */␊ - retentionPolicy?: (({␊ - retentionPolicyType?: ("RetentionPolicy" | string)␊ - [k: string]: unknown␊ - } | LongTermRetentionPolicy | SimpleRetentionPolicy) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.RecoveryServices/vaults/backupFabrics/backupProtectionIntent␊ - */␊ - export interface VaultsBackupFabricsBackupProtectionIntent {␊ - name: string␊ - type: "Microsoft.RecoveryServices/vaults/backupFabrics/backupProtectionIntent"␊ - apiVersion: "2017-07-01"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Optional ETag.␊ - */␊ - eTag?: string␊ - /**␊ - * ProtectionIntentResource properties␊ - */␊ - properties: (ProtectionIntent | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers␊ - */␊ - export interface VaultsBackupFabricsProtectionContainers {␊ - apiVersion: "2016-12-01"␊ - /**␊ - * Optional ETag.␊ - */␊ - eTag?: string␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * Name of the container to be registered.␊ - */␊ - name: string␊ - /**␊ - * Base class for container with backup items. Containers with specific workloads are derived from this class.␊ - */␊ - properties: (ProtectionContainer | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Sql workload-specific container.␊ - */␊ - export interface AzureSqlContainer {␊ - containerType: "AzureSqlContainer"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Storage Account workload-specific container.␊ - */␊ - export interface AzureStorageContainer {␊ - containerType: "StorageContainer"␊ - /**␊ - * Number of items backed up in this container.␊ - */␊ - protectedItemCount?: (number | string)␊ - /**␊ - * Resource group name of Recovery Services Vault.␊ - */␊ - resourceGroup?: string␊ - /**␊ - * Fully qualified ARM url.␊ - */␊ - sourceResourceId?: string␊ - /**␊ - * Storage account version.␊ - */␊ - storageAccountVersion?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Extended information of the container.␊ - */␊ - export interface AzureWorkloadContainerExtendedInfo {␊ - /**␊ - * Host Os Name in case of Stand Alone and Cluster Name in case of distributed container.␊ - */␊ - hostServerName?: string␊ - /**␊ - * Details about inquired protectable items under a given container.␊ - */␊ - inquiryInfo?: (InquiryInfo | string)␊ - /**␊ - * List of the nodes in case of distributed container.␊ - */␊ - nodesList?: (DistributedNodesInfo[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Details about inquired protectable items under a given container.␊ - */␊ - export interface InquiryInfo {␊ - /**␊ - * Error Detail class which encapsulates Code, Message and Recommendations.␊ - */␊ - errorDetail?: (ErrorDetail1 | string)␊ - /**␊ - * Inquiry Details which will have workload specific details.␍␊ - * For e.g. - For SQL and oracle this will contain different details.␊ - */␊ - inquiryDetails?: (WorkloadInquiryDetails[] | string)␊ - /**␊ - * Inquiry Status for this container such as␍␊ - * InProgress | Failed | Succeeded␊ - */␊ - status?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Error Detail class which encapsulates Code, Message and Recommendations.␊ - */␊ - export interface ErrorDetail1 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Details of an inquired protectable item.␊ - */␊ - export interface WorkloadInquiryDetails {␊ - /**␊ - * Validation for inquired protectable items under a given container.␊ - */␊ - inquiryValidation?: (InquiryValidation | string)␊ - /**␊ - * Contains the protectable item Count inside this Container.␊ - */␊ - itemCount?: (number | string)␊ - /**␊ - * Type of the Workload such as SQL, Oracle etc.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Validation for inquired protectable items under a given container.␊ - */␊ - export interface InquiryValidation {␊ - /**␊ - * Error Detail class which encapsulates Code, Message and Recommendations.␊ - */␊ - errorDetail?: (ErrorDetail1 | string)␊ - /**␊ - * Status for the Inquiry Validation.␊ - */␊ - status?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * This is used to represent the various nodes of the distributed container.␊ - */␊ - export interface DistributedNodesInfo {␊ - /**␊ - * Error Detail class which encapsulates Code, Message and Recommendations.␊ - */␊ - errorDetail?: (ErrorDetail1 | string)␊ - /**␊ - * Name of the node under a distributed container.␊ - */␊ - nodeName?: string␊ - /**␊ - * Status of this Node.␍␊ - * Failed | Succeeded␊ - */␊ - status?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Container for SQL workloads under SQL Availability Group.␊ - */␊ - export interface AzureSQLAGWorkloadContainerProtectionContainer {␊ - containerType: "SQLAGWorkLoadContainer"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Container for SQL workloads under Azure Virtual Machines.␊ - */␊ - export interface AzureVMAppContainerProtectionContainer {␊ - containerType: "VMAppContainer"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Additional information of the DPMContainer.␊ - */␊ - export interface DPMContainerExtendedInfo {␊ - /**␊ - * Last refresh time of the DPMContainer.␊ - */␊ - lastRefreshedAt?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AzureBackupServer (DPMVenus) workload-specific protection container.␊ - */␊ - export interface AzureBackupServerContainer {␊ - containerType: "AzureBackupServerContainer"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Base class for generic container of backup items␊ - */␊ - export interface GenericContainer {␊ - containerType: "GenericContainer"␊ - /**␊ - * Container extended information␊ - */␊ - extendedInformation?: (GenericContainerExtendedInfo | string)␊ - /**␊ - * Name of the container's fabric␊ - */␊ - fabricName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Container extended information␊ - */␊ - export interface GenericContainerExtendedInfo {␊ - /**␊ - * Container identity information␊ - */␊ - containerIdentityInfo?: (ContainerIdentityInfo | string)␊ - /**␊ - * Public key of container cert␊ - */␊ - rawCertData?: string␊ - /**␊ - * Azure Backup Service Endpoints for the container␊ - */␊ - serviceEndpoints?: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Container identity information␊ - */␊ - export interface ContainerIdentityInfo {␊ - /**␊ - * Protection container identity - AAD Tenant␊ - */␊ - aadTenantId?: string␊ - /**␊ - * Protection container identity - Audience␊ - */␊ - audience?: string␊ - /**␊ - * Protection container identity - AAD Service Principal␊ - */␊ - servicePrincipalClientId?: string␊ - /**␊ - * Unique name of the container␊ - */␊ - uniqueName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IaaS VM workload-specific backup item representing a classic virtual machine.␊ - */␊ - export interface AzureIaaSClassicComputeVMContainer {␊ - containerType: "Microsoft.ClassicCompute/virtualMachines"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IaaS VM workload-specific backup item representing an Azure Resource Manager virtual machine.␊ - */␊ - export interface AzureIaaSComputeVMContainer {␊ - containerType: "Microsoft.Compute/virtualMachines"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Container with items backed up using MAB backup engine.␊ - */␊ - export interface MabContainer {␊ - /**␊ - * Agent version of this container.␊ - */␊ - agentVersion?: string␊ - /**␊ - * Can the container be registered one more time.␊ - */␊ - canReRegister?: (boolean | string)␊ - /**␊ - * Health state of mab container.␊ - */␊ - containerHealthState?: string␊ - /**␊ - * ContainerID represents the container.␊ - */␊ - containerId?: (number | string)␊ - containerType: "Windows"␊ - /**␊ - * Additional information of the container.␊ - */␊ - extendedInfo?: (MabContainerExtendedInfo | string)␊ - /**␊ - * Health details on this mab container.␊ - */␊ - mabContainerHealthDetails?: (MABContainerHealthDetails[] | string)␊ - /**␊ - * Number of items backed up in this container.␊ - */␊ - protectedItemCount?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Additional information of the container.␊ - */␊ - export interface MabContainerExtendedInfo {␊ - /**␊ - * List of backup items associated with this container.␊ - */␊ - backupItems?: (string[] | string)␊ - /**␊ - * Type of backup items associated with this container.␊ - */␊ - backupItemType?: (("Invalid" | "VM" | "FileFolder" | "AzureSqlDb" | "SQLDB" | "Exchange" | "Sharepoint" | "VMwareVM" | "SystemState" | "Client" | "GenericDataSource" | "SQLDataBase" | "AzureFileShare" | "SAPHanaDatabase" | "SAPAseDatabase") | string)␊ - /**␊ - * Latest backup status of this container.␊ - */␊ - lastBackupStatus?: string␊ - /**␊ - * Time stamp when this container was refreshed.␊ - */␊ - lastRefreshedAt?: string␊ - /**␊ - * Backup policy associated with this container.␊ - */␊ - policyName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * MAB workload-specific Health Details.␊ - */␊ - export interface MABContainerHealthDetails {␊ - /**␊ - * Health Code␊ - */␊ - code?: (number | string)␊ - /**␊ - * Health Message␊ - */␊ - message?: string␊ - /**␊ - * Health Recommended Actions␊ - */␊ - recommendations?: (string[] | string)␊ - /**␊ - * Health Title␊ - */␊ - title?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.RecoveryServices/vaults/backupstorageconfig␊ - */␊ - export interface VaultsBackupstorageconfig {␊ - apiVersion: "2016-12-01"␊ - /**␊ - * Optional ETag.␊ - */␊ - eTag?: string␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - name: string␊ - /**␊ - * The resource storage details.␊ - */␊ - properties: (BackupResourceConfig | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.RecoveryServices/vaults/backupstorageconfig"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The resource storage details.␊ - */␊ - export interface BackupResourceConfig {␊ - /**␊ - * Storage type.␊ - */␊ - storageModelType?: (("Invalid" | "GeoRedundant" | "LocallyRedundant") | string)␊ - /**␊ - * Storage type.␊ - */␊ - storageType?: (("Invalid" | "GeoRedundant" | "LocallyRedundant") | string)␊ - /**␊ - * Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked.␊ - */␊ - storageTypeState?: (("Invalid" | "Locked" | "Unlocked") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/disks␊ - */␊ - export interface Disks2 {␊ - apiVersion: "2018-04-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters.␊ - */␊ - name: string␊ - /**␊ - * Disk resource properties.␊ - */␊ - properties: (DiskProperties3 | string)␊ - /**␊ - * The disks sku name. Can be Standard_LRS, Premium_LRS, or StandardSSD_LRS.␊ - */␊ - sku?: (DiskSku1 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/disks"␊ - /**␊ - * The Logical zone list for Disk.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Disk resource properties.␊ - */␊ - export interface DiskProperties3 {␊ - /**␊ - * Data used when creating a disk.␊ - */␊ - creationData: (CreationData2 | string)␊ - /**␊ - * If creationData.createOption is Empty, this field is mandatory and it indicates the size of the VHD to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size.␊ - */␊ - diskSizeGB?: (number | string)␊ - /**␊ - * Encryption settings for disk or snapshot␊ - */␊ - encryptionSettings?: (EncryptionSettings2 | string)␊ - /**␊ - * The Operating System type.␊ - */␊ - osType?: (("Windows" | "Linux") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Data used when creating a disk.␊ - */␊ - export interface CreationData2 {␊ - /**␊ - * This enumerates the possible sources of a disk's creation.␊ - */␊ - createOption: (("Empty" | "Attach" | "FromImage" | "Import" | "Copy" | "Restore") | string)␊ - /**␊ - * The source image used for creating the disk.␊ - */␊ - imageReference?: (ImageDiskReference2 | string)␊ - /**␊ - * If createOption is Copy, this is the ARM id of the source snapshot or disk.␊ - */␊ - sourceResourceId?: string␊ - /**␊ - * If createOption is Import, this is the URI of a blob to be imported into a managed disk.␊ - */␊ - sourceUri?: string␊ - /**␊ - * If createOption is Import, the Azure Resource Manager identifier of the storage account containing the blob to import as a disk. Required only if the blob is in a different subscription␊ - */␊ - storageAccountId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The source image used for creating the disk.␊ - */␊ - export interface ImageDiskReference2 {␊ - /**␊ - * A relative uri containing either a Platform Image Repository or user image reference.␊ - */␊ - id: string␊ - /**␊ - * If the disk is created from an image's data disk, this is an index that indicates which of the data disks in the image to use. For OS disks, this field is null.␊ - */␊ - lun?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Encryption settings for disk or snapshot␊ - */␊ - export interface EncryptionSettings2 {␊ - /**␊ - * Key Vault Secret Url and vault id of the encryption key ␊ - */␊ - diskEncryptionKey?: (KeyVaultAndSecretReference2 | string)␊ - /**␊ - * Set this flag to true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable encryption. Set this flag to false and remove DiskEncryptionKey and KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the request object, the existing settings remain unchanged.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey␊ - */␊ - keyEncryptionKey?: (KeyVaultAndKeyReference2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Key Vault Secret Url and vault id of the encryption key ␊ - */␊ - export interface KeyVaultAndSecretReference2 {␊ - /**␊ - * Url pointing to a key or secret in KeyVault␊ - */␊ - secretUrl: string␊ - /**␊ - * The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}␊ - */␊ - sourceVault: (SourceVault2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}␊ - */␊ - export interface SourceVault2 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey␊ - */␊ - export interface KeyVaultAndKeyReference2 {␊ - /**␊ - * Url pointing to a key or secret in KeyVault␊ - */␊ - keyUrl: string␊ - /**␊ - * The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}␊ - */␊ - sourceVault: (SourceVault2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The disks sku name. Can be Standard_LRS, Premium_LRS, or StandardSSD_LRS.␊ - */␊ - export interface DiskSku1 {␊ - /**␊ - * The sku name.␊ - */␊ - name?: (("Standard_LRS" | "Premium_LRS" | "StandardSSD_LRS") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/snapshots␊ - */␊ - export interface Snapshots2 {␊ - apiVersion: "2018-04-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the snapshot that is being created. The name can't be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The max name length is 80 characters.␊ - */␊ - name: string␊ - /**␊ - * Disk resource properties.␊ - */␊ - properties: (DiskProperties3 | string)␊ - /**␊ - * The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS.␊ - */␊ - sku?: (SnapshotSku | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/snapshots"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS.␊ - */␊ - export interface SnapshotSku {␊ - /**␊ - * The sku name.␊ - */␊ - name?: (("Standard_LRS" | "Premium_LRS" | "Standard_ZRS") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ContainerInstance/containerGroups␊ - */␊ - export interface ContainerGroups {␊ - apiVersion: "2018-04-01"␊ - /**␊ - * The resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the container group.␊ - */␊ - name: string␊ - properties: (ContainerGroupProperties | string)␊ - /**␊ - * The resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.ContainerInstance/containerGroups"␊ - [k: string]: unknown␊ - }␊ - export interface ContainerGroupProperties {␊ - /**␊ - * The containers within the container group.␊ - */␊ - containers: (Container[] | string)␊ - /**␊ - * The image registry credentials by which the container group is created from.␊ - */␊ - imageRegistryCredentials?: (ImageRegistryCredential[] | string)␊ - /**␊ - * IP address for the container group.␊ - */␊ - ipAddress?: (IpAddress | string)␊ - /**␊ - * The operating system type required by the containers in the container group.␊ - */␊ - osType: (("Windows" | "Linux") | string)␊ - /**␊ - * Restart policy for all containers within the container group. ␊ - * - \`Always\` Always restart␊ - * - \`OnFailure\` Restart on failure␊ - * - \`Never\` Never restart␊ - * .␊ - */␊ - restartPolicy?: (("Always" | "OnFailure" | "Never") | string)␊ - /**␊ - * The list of volumes that can be mounted by containers in this container group.␊ - */␊ - volumes?: (Volume[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A container instance.␊ - */␊ - export interface Container {␊ - /**␊ - * The user-provided name of the container instance.␊ - */␊ - name: string␊ - /**␊ - * The container instance properties.␊ - */␊ - properties: (ContainerProperties6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The container instance properties.␊ - */␊ - export interface ContainerProperties6 {␊ - /**␊ - * The commands to execute within the container instance in exec form.␊ - */␊ - command?: (string[] | string)␊ - /**␊ - * The environment variables to set in the container instance.␊ - */␊ - environmentVariables?: (EnvironmentVariable1[] | string)␊ - /**␊ - * The name of the image used to create the container instance.␊ - */␊ - image: string␊ - /**␊ - * The exposed ports on the container instance.␊ - */␊ - ports?: (ContainerPort[] | string)␊ - /**␊ - * The resource requirements.␊ - */␊ - resources: (ResourceRequirements | string)␊ - /**␊ - * The volume mounts available to the container instance.␊ - */␊ - volumeMounts?: (VolumeMount[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The environment variable to set within the container instance.␊ - */␊ - export interface EnvironmentVariable1 {␊ - /**␊ - * The name of the environment variable.␊ - */␊ - name: string␊ - /**␊ - * The value of the environment variable.␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The port exposed on the container instance.␊ - */␊ - export interface ContainerPort {␊ - /**␊ - * The port number exposed within the container group.␊ - */␊ - port: (number | string)␊ - /**␊ - * The protocol associated with the port.␊ - */␊ - protocol?: (("TCP" | "UDP") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The resource requirements.␊ - */␊ - export interface ResourceRequirements {␊ - /**␊ - * The resource limits.␊ - */␊ - limits?: (ResourceLimits | string)␊ - /**␊ - * The resource requests.␊ - */␊ - requests: (ResourceRequests | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The resource limits.␊ - */␊ - export interface ResourceLimits {␊ - /**␊ - * The CPU limit of this container instance.␊ - */␊ - cpu?: (number | string)␊ - /**␊ - * The memory limit in GB of this container instance.␊ - */␊ - memoryInGB?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The resource requests.␊ - */␊ - export interface ResourceRequests {␊ - /**␊ - * The CPU request of this container instance.␊ - */␊ - cpu: (number | string)␊ - /**␊ - * The memory request in GB of this container instance.␊ - */␊ - memoryInGB: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the volume mount.␊ - */␊ - export interface VolumeMount {␊ - /**␊ - * The path within the container where the volume should be mounted. Must not contain colon (:).␊ - */␊ - mountPath: string␊ - /**␊ - * The name of the volume mount.␊ - */␊ - name: string␊ - /**␊ - * The flag indicating whether the volume mount is read-only.␊ - */␊ - readOnly?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Image registry credential.␊ - */␊ - export interface ImageRegistryCredential {␊ - /**␊ - * The password for the private registry.␊ - */␊ - password?: string␊ - /**␊ - * The Docker image registry server without a protocol such as "http" and "https".␊ - */␊ - server: string␊ - /**␊ - * The username for the private registry.␊ - */␊ - username: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP address for the container group.␊ - */␊ - export interface IpAddress {␊ - /**␊ - * The Dns name label for the IP.␊ - */␊ - dnsNameLabel?: string␊ - /**␊ - * The IP exposed to the public internet.␊ - */␊ - ip?: string␊ - /**␊ - * The list of ports exposed on the container group.␊ - */␊ - ports: (Port1[] | string)␊ - /**␊ - * Specifies if the IP is exposed to the public internet.␊ - */␊ - type: ("Public" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The port exposed on the container group.␊ - */␊ - export interface Port1 {␊ - /**␊ - * The port number.␊ - */␊ - port: (number | string)␊ - /**␊ - * The protocol associated with the port.␊ - */␊ - protocol?: (("TCP" | "UDP") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the volume.␊ - */␊ - export interface Volume {␊ - /**␊ - * The properties of the Azure File volume. Azure File shares are mounted as volumes.␊ - */␊ - azureFile?: (AzureFileVolume | string)␊ - /**␊ - * The empty directory volume.␊ - */␊ - emptyDir?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents a volume that is populated with the contents of a git repository␊ - */␊ - gitRepo?: (GitRepoVolume | string)␊ - /**␊ - * The name of the volume.␊ - */␊ - name: string␊ - /**␊ - * The secret volume.␊ - */␊ - secret?: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the Azure File volume. Azure File shares are mounted as volumes.␊ - */␊ - export interface AzureFileVolume {␊ - /**␊ - * The flag indicating whether the Azure File shared mounted as a volume is read-only.␊ - */␊ - readOnly?: (boolean | string)␊ - /**␊ - * The name of the Azure File share to be mounted as a volume.␊ - */␊ - shareName: string␊ - /**␊ - * The storage account access key used to access the Azure File share.␊ - */␊ - storageAccountKey?: string␊ - /**␊ - * The name of the storage account that contains the Azure File share.␊ - */␊ - storageAccountName: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents a volume that is populated with the contents of a git repository␊ - */␊ - export interface GitRepoVolume {␊ - /**␊ - * Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.␊ - */␊ - directory?: string␊ - /**␊ - * Repository URL␊ - */␊ - repository: string␊ - /**␊ - * Commit hash for the specified revision.␊ - */␊ - revision?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ContainerInstance/containerGroups␊ - */␊ - export interface ContainerGroups1 {␊ - apiVersion: "2018-10-01"␊ - /**␊ - * Identity for the container group.␊ - */␊ - identity?: (ContainerGroupIdentity | string)␊ - /**␊ - * The resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the container group.␊ - */␊ - name: string␊ - properties: (ContainerGroupProperties1 | string)␊ - /**␊ - * The resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.ContainerInstance/containerGroups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the container group.␊ - */␊ - export interface ContainerGroupIdentity {␊ - /**␊ - * The type of identity used for the container group. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the container group.␊ - */␊ - type?: (("SystemAssigned" | "UserAssigned" | "SystemAssigned, UserAssigned" | "None") | string)␊ - /**␊ - * The list of user identities associated with the container group. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.␊ - */␊ - userAssignedIdentities?: ({␊ - [k: string]: Components10Wh5Udschemascontainergroupidentitypropertiesuserassignedidentitiesadditionalproperties␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - export interface Components10Wh5Udschemascontainergroupidentitypropertiesuserassignedidentitiesadditionalproperties {␊ - [k: string]: unknown␊ - }␊ - export interface ContainerGroupProperties1 {␊ - /**␊ - * The containers within the container group.␊ - */␊ - containers: (Container1[] | string)␊ - /**␊ - * Container group diagnostic information.␊ - */␊ - diagnostics?: (ContainerGroupDiagnostics | string)␊ - /**␊ - * DNS configuration for the container group.␊ - */␊ - dnsConfig?: (DnsConfiguration | string)␊ - /**␊ - * The image registry credentials by which the container group is created from.␊ - */␊ - imageRegistryCredentials?: (ImageRegistryCredential1[] | string)␊ - /**␊ - * IP address for the container group.␊ - */␊ - ipAddress?: (IpAddress1 | string)␊ - /**␊ - * Container group network profile information.␊ - */␊ - networkProfile?: (ContainerGroupNetworkProfile | string)␊ - /**␊ - * The operating system type required by the containers in the container group.␊ - */␊ - osType: (("Windows" | "Linux") | string)␊ - /**␊ - * Restart policy for all containers within the container group. ␊ - * - \`Always\` Always restart␊ - * - \`OnFailure\` Restart on failure␊ - * - \`Never\` Never restart␊ - * .␊ - */␊ - restartPolicy?: (("Always" | "OnFailure" | "Never") | string)␊ - /**␊ - * The list of volumes that can be mounted by containers in this container group.␊ - */␊ - volumes?: (Volume1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A container instance.␊ - */␊ - export interface Container1 {␊ - /**␊ - * The user-provided name of the container instance.␊ - */␊ - name: string␊ - /**␊ - * The container instance properties.␊ - */␊ - properties: (ContainerProperties7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The container instance properties.␊ - */␊ - export interface ContainerProperties7 {␊ - /**␊ - * The commands to execute within the container instance in exec form.␊ - */␊ - command?: (string[] | string)␊ - /**␊ - * The environment variables to set in the container instance.␊ - */␊ - environmentVariables?: (EnvironmentVariable2[] | string)␊ - /**␊ - * The name of the image used to create the container instance.␊ - */␊ - image: string␊ - /**␊ - * The container probe, for liveness or readiness␊ - */␊ - livenessProbe?: (ContainerProbe | string)␊ - /**␊ - * The exposed ports on the container instance.␊ - */␊ - ports?: (ContainerPort1[] | string)␊ - /**␊ - * The container probe, for liveness or readiness␊ - */␊ - readinessProbe?: (ContainerProbe | string)␊ - /**␊ - * The resource requirements.␊ - */␊ - resources: (ResourceRequirements1 | string)␊ - /**␊ - * The volume mounts available to the container instance.␊ - */␊ - volumeMounts?: (VolumeMount1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The environment variable to set within the container instance.␊ - */␊ - export interface EnvironmentVariable2 {␊ - /**␊ - * The name of the environment variable.␊ - */␊ - name: string␊ - /**␊ - * The value of the secure environment variable.␊ - */␊ - secureValue?: string␊ - /**␊ - * The value of the environment variable.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The container probe, for liveness or readiness␊ - */␊ - export interface ContainerProbe {␊ - /**␊ - * The container execution command, for liveness or readiness probe␊ - */␊ - exec?: (ContainerExec | string)␊ - /**␊ - * The failure threshold.␊ - */␊ - failureThreshold?: (number | string)␊ - /**␊ - * The container Http Get settings, for liveness or readiness probe␊ - */␊ - httpGet?: (ContainerHttpGet | string)␊ - /**␊ - * The initial delay seconds.␊ - */␊ - initialDelaySeconds?: (number | string)␊ - /**␊ - * The period seconds.␊ - */␊ - periodSeconds?: (number | string)␊ - /**␊ - * The success threshold.␊ - */␊ - successThreshold?: (number | string)␊ - /**␊ - * The timeout seconds.␊ - */␊ - timeoutSeconds?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The container execution command, for liveness or readiness probe␊ - */␊ - export interface ContainerExec {␊ - /**␊ - * The commands to execute within the container.␊ - */␊ - command?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The container Http Get settings, for liveness or readiness probe␊ - */␊ - export interface ContainerHttpGet {␊ - /**␊ - * The path to probe.␊ - */␊ - path?: string␊ - /**␊ - * The port number to probe.␊ - */␊ - port: (number | string)␊ - /**␊ - * The scheme.␊ - */␊ - scheme?: (("http" | "https") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The port exposed on the container instance.␊ - */␊ - export interface ContainerPort1 {␊ - /**␊ - * The port number exposed within the container group.␊ - */␊ - port: (number | string)␊ - /**␊ - * The protocol associated with the port.␊ - */␊ - protocol?: (("TCP" | "UDP") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The resource requirements.␊ - */␊ - export interface ResourceRequirements1 {␊ - /**␊ - * The resource limits.␊ - */␊ - limits?: (ResourceLimits1 | string)␊ - /**␊ - * The resource requests.␊ - */␊ - requests: (ResourceRequests1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The resource limits.␊ - */␊ - export interface ResourceLimits1 {␊ - /**␊ - * The CPU limit of this container instance.␊ - */␊ - cpu?: (number | string)␊ - /**␊ - * The GPU resource.␊ - */␊ - gpu?: (GpuResource | string)␊ - /**␊ - * The memory limit in GB of this container instance.␊ - */␊ - memoryInGB?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The GPU resource.␊ - */␊ - export interface GpuResource {␊ - /**␊ - * The count of the GPU resource.␊ - */␊ - count: (number | string)␊ - /**␊ - * The SKU of the GPU resource.␊ - */␊ - sku: (("K80" | "P100" | "V100") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The resource requests.␊ - */␊ - export interface ResourceRequests1 {␊ - /**␊ - * The CPU request of this container instance.␊ - */␊ - cpu: (number | string)␊ - /**␊ - * The GPU resource.␊ - */␊ - gpu?: (GpuResource | string)␊ - /**␊ - * The memory request in GB of this container instance.␊ - */␊ - memoryInGB: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the volume mount.␊ - */␊ - export interface VolumeMount1 {␊ - /**␊ - * The path within the container where the volume should be mounted. Must not contain colon (:).␊ - */␊ - mountPath: string␊ - /**␊ - * The name of the volume mount.␊ - */␊ - name: string␊ - /**␊ - * The flag indicating whether the volume mount is read-only.␊ - */␊ - readOnly?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Container group diagnostic information.␊ - */␊ - export interface ContainerGroupDiagnostics {␊ - /**␊ - * Container group log analytics information.␊ - */␊ - logAnalytics?: (LogAnalytics | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Container group log analytics information.␊ - */␊ - export interface LogAnalytics {␊ - /**␊ - * The log type to be used.␊ - */␊ - logType?: (("ContainerInsights" | "ContainerInstanceLogs") | string)␊ - /**␊ - * Metadata for log analytics.␊ - */␊ - metadata?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The workspace id for log analytics␊ - */␊ - workspaceId: string␊ - /**␊ - * The workspace key for log analytics␊ - */␊ - workspaceKey: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DNS configuration for the container group.␊ - */␊ - export interface DnsConfiguration {␊ - /**␊ - * The DNS servers for the container group.␊ - */␊ - nameServers: (string[] | string)␊ - /**␊ - * The DNS options for the container group.␊ - */␊ - options?: string␊ - /**␊ - * The DNS search domains for hostname lookup in the container group.␊ - */␊ - searchDomains?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Image registry credential.␊ - */␊ - export interface ImageRegistryCredential1 {␊ - /**␊ - * The password for the private registry.␊ - */␊ - password?: string␊ - /**␊ - * The Docker image registry server without a protocol such as "http" and "https".␊ - */␊ - server: string␊ - /**␊ - * The username for the private registry.␊ - */␊ - username: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP address for the container group.␊ - */␊ - export interface IpAddress1 {␊ - /**␊ - * The Dns name label for the IP.␊ - */␊ - dnsNameLabel?: string␊ - /**␊ - * The IP exposed to the public internet.␊ - */␊ - ip?: string␊ - /**␊ - * The list of ports exposed on the container group.␊ - */␊ - ports: (Port2[] | string)␊ - /**␊ - * Specifies if the IP is exposed to the public internet or private VNET.␊ - */␊ - type: (("Public" | "Private") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The port exposed on the container group.␊ - */␊ - export interface Port2 {␊ - /**␊ - * The port number.␊ - */␊ - port: (number | string)␊ - /**␊ - * The protocol associated with the port.␊ - */␊ - protocol?: (("TCP" | "UDP") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Container group network profile information.␊ - */␊ - export interface ContainerGroupNetworkProfile {␊ - /**␊ - * The identifier for a network profile.␊ - */␊ - id: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the volume.␊ - */␊ - export interface Volume1 {␊ - /**␊ - * The properties of the Azure File volume. Azure File shares are mounted as volumes.␊ - */␊ - azureFile?: (AzureFileVolume1 | string)␊ - /**␊ - * The empty directory volume.␊ - */␊ - emptyDir?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents a volume that is populated with the contents of a git repository␊ - */␊ - gitRepo?: (GitRepoVolume1 | string)␊ - /**␊ - * The name of the volume.␊ - */␊ - name: string␊ - /**␊ - * The secret volume.␊ - */␊ - secret?: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the Azure File volume. Azure File shares are mounted as volumes.␊ - */␊ - export interface AzureFileVolume1 {␊ - /**␊ - * The flag indicating whether the Azure File shared mounted as a volume is read-only.␊ - */␊ - readOnly?: (boolean | string)␊ - /**␊ - * The name of the Azure File share to be mounted as a volume.␊ - */␊ - shareName: string␊ - /**␊ - * The storage account access key used to access the Azure File share.␊ - */␊ - storageAccountKey?: string␊ - /**␊ - * The name of the storage account that contains the Azure File share.␊ - */␊ - storageAccountName: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents a volume that is populated with the contents of a git repository␊ - */␊ - export interface GitRepoVolume1 {␊ - /**␊ - * Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.␊ - */␊ - directory?: string␊ - /**␊ - * Repository URL␊ - */␊ - repository: string␊ - /**␊ - * Commit hash for the specified revision.␊ - */␊ - revision?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/galleries␊ - */␊ - export interface Galleries {␊ - apiVersion: "2018-06-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the Shared Image Gallery. The allowed characters are alphabets and numbers with dots and periods allowed in the middle. The maximum length is 80 characters.␊ - */␊ - name: string␊ - /**␊ - * Describes the properties of a Shared Image Gallery.␊ - */␊ - properties: (GalleryProperties | string)␊ - resources?: GalleriesImagesChildResource[]␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/galleries"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the properties of a Shared Image Gallery.␊ - */␊ - export interface GalleryProperties {␊ - /**␊ - * The description of this Shared Image Gallery resource. This property is updatable.␊ - */␊ - description?: string␊ - /**␊ - * Describes the gallery unique name.␊ - */␊ - identifier?: (GalleryIdentifier | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the gallery unique name.␊ - */␊ - export interface GalleryIdentifier {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/galleries/images␊ - */␊ - export interface GalleriesImagesChildResource {␊ - apiVersion: "2018-06-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the gallery Image Definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters.␊ - */␊ - name: string␊ - /**␊ - * Describes the properties of a gallery Image Definition.␊ - */␊ - properties: (GalleryImageProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "images"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the properties of a gallery Image Definition.␊ - */␊ - export interface GalleryImageProperties {␊ - /**␊ - * The description of this gallery Image Definition resource. This property is updatable.␊ - */␊ - description?: string␊ - /**␊ - * Describes the disallowed disk types.␊ - */␊ - disallowed?: (Disallowed | string)␊ - /**␊ - * The end of life date of the gallery Image Definition. This property can be used for decommissioning purposes. This property is updatable.␊ - */␊ - endOfLifeDate?: string␊ - /**␊ - * The Eula agreement for the gallery Image Definition.␊ - */␊ - eula?: string␊ - /**␊ - * This is the gallery Image Definition identifier.␊ - */␊ - identifier: (GalleryImageIdentifier | string)␊ - /**␊ - * The allowed values for OS State are 'Generalized'.␊ - */␊ - osState: (("Generalized" | "Specialized") | string)␊ - /**␊ - * This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image.

    Possible values are:

    **Windows**

    **Linux**.␊ - */␊ - osType: (("Windows" | "Linux") | string)␊ - /**␊ - * The privacy statement uri.␊ - */␊ - privacyStatementUri?: string␊ - /**␊ - * Describes the gallery Image Definition purchase plan. This is used by marketplace images.␊ - */␊ - purchasePlan?: (ImagePurchasePlan | string)␊ - /**␊ - * The properties describe the recommended machine configuration for this Image Definition. These properties are updatable.␊ - */␊ - recommended?: (RecommendedMachineConfiguration | string)␊ - /**␊ - * The release note uri.␊ - */␊ - releaseNoteUri?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the disallowed disk types.␊ - */␊ - export interface Disallowed {␊ - /**␊ - * A list of disk types.␊ - */␊ - diskTypes?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * This is the gallery Image Definition identifier.␊ - */␊ - export interface GalleryImageIdentifier {␊ - /**␊ - * The name of the gallery Image Definition offer.␊ - */␊ - offer: string␊ - /**␊ - * The name of the gallery Image Definition publisher.␊ - */␊ - publisher: string␊ - /**␊ - * The name of the gallery Image Definition SKU.␊ - */␊ - sku: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the gallery Image Definition purchase plan. This is used by marketplace images.␊ - */␊ - export interface ImagePurchasePlan {␊ - /**␊ - * The plan ID.␊ - */␊ - name?: string␊ - /**␊ - * The product ID.␊ - */␊ - product?: string␊ - /**␊ - * The publisher ID.␊ - */␊ - publisher?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties describe the recommended machine configuration for this Image Definition. These properties are updatable.␊ - */␊ - export interface RecommendedMachineConfiguration {␊ - /**␊ - * Describes the resource range.␊ - */␊ - memory?: (ResourceRange | string)␊ - /**␊ - * Describes the resource range.␊ - */␊ - vCPUs?: (ResourceRange | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the resource range.␊ - */␊ - export interface ResourceRange {␊ - /**␊ - * The maximum number of the resource.␊ - */␊ - max?: (number | string)␊ - /**␊ - * The minimum number of the resource.␊ - */␊ - min?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/galleries/images␊ - */␊ - export interface GalleriesImages {␊ - apiVersion: "2018-06-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the gallery Image Definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters.␊ - */␊ - name: string␊ - /**␊ - * Describes the properties of a gallery Image Definition.␊ - */␊ - properties: (GalleryImageProperties | string)␊ - resources?: GalleriesImagesVersionsChildResource[]␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/galleries/images"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/galleries/images/versions␊ - */␊ - export interface GalleriesImagesVersionsChildResource {␊ - apiVersion: "2018-06-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the gallery Image Version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: ..␊ - */␊ - name: string␊ - /**␊ - * Describes the properties of a gallery Image Version.␊ - */␊ - properties: (GalleryImageVersionProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "versions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the properties of a gallery Image Version.␊ - */␊ - export interface GalleryImageVersionProperties {␊ - /**␊ - * The publishing profile of a gallery Image Version.␊ - */␊ - publishingProfile: (GalleryImageVersionPublishingProfile | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The publishing profile of a gallery Image Version.␊ - */␊ - export interface GalleryImageVersionPublishingProfile {␊ - /**␊ - * The end of life date of the gallery Image Version. This property can be used for decommissioning purposes. This property is updatable.␊ - */␊ - endOfLifeDate?: string␊ - /**␊ - * If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version.␊ - */␊ - excludeFromLatest?: (boolean | string)␊ - /**␊ - * The number of replicas of the Image Version to be created per region. This property would take effect for a region when regionalReplicaCount is not specified. This property is updatable.␊ - */␊ - replicaCount?: (number | string)␊ - /**␊ - * The source image from which the Image Version is going to be created.␊ - */␊ - source: (GalleryArtifactSource | string)␊ - /**␊ - * The target regions where the Image Version is going to be replicated to. This property is updatable.␊ - */␊ - targetRegions?: (TargetRegion[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The source image from which the Image Version is going to be created.␊ - */␊ - export interface GalleryArtifactSource {␊ - /**␊ - * The managed artifact.␊ - */␊ - managedImage: (ManagedArtifact | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The managed artifact.␊ - */␊ - export interface ManagedArtifact {␊ - /**␊ - * The managed artifact id.␊ - */␊ - id: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the target region information.␊ - */␊ - export interface TargetRegion {␊ - /**␊ - * The name of the region.␊ - */␊ - name: string␊ - /**␊ - * The number of replicas of the Image Version to be created per region. This property is updatable.␊ - */␊ - regionalReplicaCount?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/galleries/images/versions␊ - */␊ - export interface GalleriesImagesVersions {␊ - apiVersion: "2018-06-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the gallery Image Version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: ..␊ - */␊ - name: string␊ - /**␊ - * Describes the properties of a gallery Image Version.␊ - */␊ - properties: (GalleryImageVersionProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/galleries/images/versions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/images␊ - */␊ - export interface Images3 {␊ - apiVersion: "2018-06-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the image.␊ - */␊ - name: string␊ - /**␊ - * Describes the properties of an Image.␊ - */␊ - properties: (ImageProperties3 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/images"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the properties of an Image.␊ - */␊ - export interface ImageProperties3 {␊ - sourceVirtualMachine?: (SubResource36 | string)␊ - /**␊ - * Describes a storage profile.␊ - */␊ - storageProfile?: (ImageStorageProfile3 | string)␊ - [k: string]: unknown␊ - }␊ - export interface SubResource36 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a storage profile.␊ - */␊ - export interface ImageStorageProfile3 {␊ - /**␊ - * 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).␊ - */␊ - dataDisks?: (ImageDataDisk3[] | string)␊ - /**␊ - * Describes an Operating System disk.␊ - */␊ - osDisk?: (ImageOSDisk3 | string)␊ - /**␊ - * Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS).␊ - */␊ - zoneResilient?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a data disk.␊ - */␊ - export interface ImageDataDisk3 {␊ - /**␊ - * The Virtual Hard Disk.␊ - */␊ - blobUri?: string␊ - /**␊ - * Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**.␊ - */␊ - caching?: (("None" | "ReadOnly" | "ReadWrite") | string)␊ - /**␊ - * 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␊ - */␊ - diskSizeGB?: (number | string)␊ - /**␊ - * 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.␊ - */␊ - lun: (number | string)␊ - managedDisk?: (SubResource36 | string)␊ - snapshot?: (SubResource36 | string)␊ - /**␊ - * Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.␊ - */␊ - storageAccountType?: (("Standard_LRS" | "Premium_LRS" | "StandardSSD_LRS" | "UltraSSD_LRS") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes an Operating System disk.␊ - */␊ - export interface ImageOSDisk3 {␊ - /**␊ - * The Virtual Hard Disk.␊ - */␊ - blobUri?: string␊ - /**␊ - * Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**.␊ - */␊ - caching?: (("None" | "ReadOnly" | "ReadWrite") | string)␊ - /**␊ - * 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␊ - */␊ - diskSizeGB?: (number | string)␊ - managedDisk?: (SubResource36 | string)␊ - /**␊ - * The OS State.␊ - */␊ - osState: (("Generalized" | "Specialized") | string)␊ - /**␊ - * 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**.␊ - */␊ - osType: (("Windows" | "Linux") | string)␊ - snapshot?: (SubResource36 | string)␊ - /**␊ - * Specifies the storage account type for the managed disk. UltraSSD_LRS cannot be used with OS Disk.␊ - */␊ - storageAccountType?: (("Standard_LRS" | "Premium_LRS" | "StandardSSD_LRS" | "UltraSSD_LRS") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/availabilitySets␊ - */␊ - export interface AvailabilitySets4 {␊ - apiVersion: "2018-06-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the availability set.␊ - */␊ - name: string␊ - /**␊ - * The instance view of a resource.␊ - */␊ - properties: (AvailabilitySetProperties3 | string)␊ - /**␊ - * Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name.␊ - */␊ - sku?: (Sku54 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/availabilitySets"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The instance view of a resource.␊ - */␊ - export interface AvailabilitySetProperties3 {␊ - /**␊ - * Fault Domain count.␊ - */␊ - platformFaultDomainCount?: (number | string)␊ - /**␊ - * Update Domain count.␊ - */␊ - platformUpdateDomainCount?: (number | string)␊ - proximityPlacementGroup?: (SubResource36 | string)␊ - /**␊ - * A list of references to all virtual machines in the availability set.␊ - */␊ - virtualMachines?: (SubResource36[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name.␊ - */␊ - export interface Sku54 {␊ - /**␊ - * Specifies the number of virtual machines in the scale set.␊ - */␊ - capacity?: (number | string)␊ - /**␊ - * The sku name.␊ - */␊ - name?: string␊ - /**␊ - * Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic**␊ - */␊ - tier?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/virtualMachines␊ - */␊ - export interface VirtualMachines5 {␊ - apiVersion: "2018-06-01"␊ - /**␊ - * Identity for the virtual machine.␊ - */␊ - identity?: (VirtualMachineIdentity3 | string)␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the virtual machine.␊ - */␊ - name: string␊ - /**␊ - * 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**.␊ - */␊ - plan?: (Plan4 | string)␊ - /**␊ - * Describes the properties of a Virtual Machine.␊ - */␊ - properties: (VirtualMachineProperties10 | string)␊ - resources?: VirtualMachinesExtensionsChildResource3[]␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/virtualMachines"␊ - /**␊ - * The virtual machine zones.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the virtual machine.␊ - */␊ - export interface VirtualMachineIdentity3 {␊ - /**␊ - * The type of identity used for the virtual machine. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.␊ - */␊ - type?: (("SystemAssigned" | "UserAssigned" | "SystemAssigned, UserAssigned" | "None") | string)␊ - /**␊ - * The list of user identities associated with the Virtual Machine. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.␊ - */␊ - userAssignedIdentities?: ({␊ - [k: string]: UserAssignedIdentitiesValue␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - export interface UserAssignedIdentitiesValue {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * 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**.␊ - */␊ - export interface Plan4 {␊ - /**␊ - * The plan ID.␊ - */␊ - name?: string␊ - /**␊ - * Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.␊ - */␊ - product?: string␊ - /**␊ - * The promotion code.␊ - */␊ - promotionCode?: string␊ - /**␊ - * The publisher ID.␊ - */␊ - publisher?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the properties of a Virtual Machine.␊ - */␊ - export interface VirtualMachineProperties10 {␊ - /**␊ - * Enables or disables a capability on the virtual machine or virtual machine scale set.␊ - */␊ - additionalCapabilities?: (AdditionalCapabilities | string)␊ - availabilitySet?: (SubResource36 | string)␊ - /**␊ - * Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15.␊ - */␊ - diagnosticsProfile?: (DiagnosticsProfile3 | string)␊ - /**␊ - * Specifies the hardware settings for the virtual machine.␊ - */␊ - hardwareProfile?: (HardwareProfile4 | string)␊ - /**␊ - * 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␊ - */␊ - licenseType?: string␊ - /**␊ - * Specifies the network interfaces of the virtual machine.␊ - */␊ - networkProfile?: (NetworkProfile4 | string)␊ - /**␊ - * Specifies the operating system settings for the virtual machine.␊ - */␊ - osProfile?: (OSProfile3 | string)␊ - proximityPlacementGroup?: (SubResource36 | string)␊ - /**␊ - * Specifies the storage settings for the virtual machine disks.␊ - */␊ - storageProfile?: (StorageProfile9 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Enables or disables a capability on the virtual machine or virtual machine scale set.␊ - */␊ - export interface AdditionalCapabilities {␊ - /**␊ - * The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled.␊ - */␊ - ultraSSDEnabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15.␊ - */␊ - export interface DiagnosticsProfile3 {␊ - /**␊ - * Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    You can easily view the output of your console log.

    Azure also enables you to see a screenshot of the VM from the hypervisor.␊ - */␊ - bootDiagnostics?: (BootDiagnostics3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    You can easily view the output of your console log.

    Azure also enables you to see a screenshot of the VM from the hypervisor.␊ - */␊ - export interface BootDiagnostics3 {␊ - /**␊ - * Whether boot diagnostics should be enabled on the Virtual Machine.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Uri of the storage account to use for placing the console output and screenshot.␊ - */␊ - storageUri?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the hardware settings for the virtual machine.␊ - */␊ - export interface HardwareProfile4 {␊ - /**␊ - * 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](https://docs.microsoft.com/rest/api/compute/availabilitysets/listavailablesizes)

    [List all available virtual machine sizes in a region](https://docs.microsoft.com/rest/api/compute/virtualmachinesizes/list)

    [List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes).␊ - */␊ - vmSize?: (("Basic_A0" | "Basic_A1" | "Basic_A2" | "Basic_A3" | "Basic_A4" | "Standard_A0" | "Standard_A1" | "Standard_A2" | "Standard_A3" | "Standard_A4" | "Standard_A5" | "Standard_A6" | "Standard_A7" | "Standard_A8" | "Standard_A9" | "Standard_A10" | "Standard_A11" | "Standard_A1_v2" | "Standard_A2_v2" | "Standard_A4_v2" | "Standard_A8_v2" | "Standard_A2m_v2" | "Standard_A4m_v2" | "Standard_A8m_v2" | "Standard_B1s" | "Standard_B1ms" | "Standard_B2s" | "Standard_B2ms" | "Standard_B4ms" | "Standard_B8ms" | "Standard_D1" | "Standard_D2" | "Standard_D3" | "Standard_D4" | "Standard_D11" | "Standard_D12" | "Standard_D13" | "Standard_D14" | "Standard_D1_v2" | "Standard_D2_v2" | "Standard_D3_v2" | "Standard_D4_v2" | "Standard_D5_v2" | "Standard_D2_v3" | "Standard_D4_v3" | "Standard_D8_v3" | "Standard_D16_v3" | "Standard_D32_v3" | "Standard_D64_v3" | "Standard_D2s_v3" | "Standard_D4s_v3" | "Standard_D8s_v3" | "Standard_D16s_v3" | "Standard_D32s_v3" | "Standard_D64s_v3" | "Standard_D11_v2" | "Standard_D12_v2" | "Standard_D13_v2" | "Standard_D14_v2" | "Standard_D15_v2" | "Standard_DS1" | "Standard_DS2" | "Standard_DS3" | "Standard_DS4" | "Standard_DS11" | "Standard_DS12" | "Standard_DS13" | "Standard_DS14" | "Standard_DS1_v2" | "Standard_DS2_v2" | "Standard_DS3_v2" | "Standard_DS4_v2" | "Standard_DS5_v2" | "Standard_DS11_v2" | "Standard_DS12_v2" | "Standard_DS13_v2" | "Standard_DS14_v2" | "Standard_DS15_v2" | "Standard_DS13-4_v2" | "Standard_DS13-2_v2" | "Standard_DS14-8_v2" | "Standard_DS14-4_v2" | "Standard_E2_v3" | "Standard_E4_v3" | "Standard_E8_v3" | "Standard_E16_v3" | "Standard_E32_v3" | "Standard_E64_v3" | "Standard_E2s_v3" | "Standard_E4s_v3" | "Standard_E8s_v3" | "Standard_E16s_v3" | "Standard_E32s_v3" | "Standard_E64s_v3" | "Standard_E32-16_v3" | "Standard_E32-8s_v3" | "Standard_E64-32s_v3" | "Standard_E64-16s_v3" | "Standard_F1" | "Standard_F2" | "Standard_F4" | "Standard_F8" | "Standard_F16" | "Standard_F1s" | "Standard_F2s" | "Standard_F4s" | "Standard_F8s" | "Standard_F16s" | "Standard_F2s_v2" | "Standard_F4s_v2" | "Standard_F8s_v2" | "Standard_F16s_v2" | "Standard_F32s_v2" | "Standard_F64s_v2" | "Standard_F72s_v2" | "Standard_G1" | "Standard_G2" | "Standard_G3" | "Standard_G4" | "Standard_G5" | "Standard_GS1" | "Standard_GS2" | "Standard_GS3" | "Standard_GS4" | "Standard_GS5" | "Standard_GS4-8" | "Standard_GS4-4" | "Standard_GS5-16" | "Standard_GS5-8" | "Standard_H8" | "Standard_H16" | "Standard_H8m" | "Standard_H16m" | "Standard_H16r" | "Standard_H16mr" | "Standard_L4s" | "Standard_L8s" | "Standard_L16s" | "Standard_L32s" | "Standard_M64s" | "Standard_M64ms" | "Standard_M128s" | "Standard_M128ms" | "Standard_M64-32ms" | "Standard_M64-16ms" | "Standard_M128-64ms" | "Standard_M128-32ms" | "Standard_NC6" | "Standard_NC12" | "Standard_NC24" | "Standard_NC24r" | "Standard_NC6s_v2" | "Standard_NC12s_v2" | "Standard_NC24s_v2" | "Standard_NC24rs_v2" | "Standard_NC6s_v3" | "Standard_NC12s_v3" | "Standard_NC24s_v3" | "Standard_NC24rs_v3" | "Standard_ND6s" | "Standard_ND12s" | "Standard_ND24s" | "Standard_ND24rs" | "Standard_NV6" | "Standard_NV12" | "Standard_NV24") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the network interfaces of the virtual machine.␊ - */␊ - export interface NetworkProfile4 {␊ - /**␊ - * Specifies the list of resource Ids for the network interfaces associated with the virtual machine.␊ - */␊ - networkInterfaces?: (NetworkInterfaceReference3[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a network interface reference.␊ - */␊ - export interface NetworkInterfaceReference3 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Describes a network interface reference properties.␊ - */␊ - properties?: (NetworkInterfaceReferenceProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a network interface reference properties.␊ - */␊ - export interface NetworkInterfaceReferenceProperties3 {␊ - /**␊ - * Specifies the primary network interface in case the virtual machine has more than 1 network interface.␊ - */␊ - primary?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the operating system settings for the virtual machine.␊ - */␊ - export interface OSProfile3 {␊ - /**␊ - * 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)␊ - */␊ - adminPassword?: string␊ - /**␊ - * 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)␊ - */␊ - adminUsername?: string␊ - /**␊ - * Specifies whether extension operations should be allowed on the virtual machine.

    This may only be set to False when no extensions are present on the virtual machine.␊ - */␊ - allowExtensionOperations?: (boolean | string)␊ - /**␊ - * Specifies the host OS name of the virtual machine.

    This name cannot be updated after the VM is created.

    **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).␊ - */␊ - computerName?: string␊ - /**␊ - * 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)␊ - */␊ - customData?: string␊ - /**␊ - * 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).␊ - */␊ - linuxConfiguration?: (LinuxConfiguration4 | string)␊ - /**␊ - * Specifies set of certificates that should be installed onto the virtual machine.␊ - */␊ - secrets?: (VaultSecretGroup3[] | string)␊ - /**␊ - * Specifies Windows operating system settings on the virtual machine.␊ - */␊ - windowsConfiguration?: (WindowsConfiguration5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * 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).␊ - */␊ - export interface LinuxConfiguration4 {␊ - /**␊ - * Specifies whether password authentication should be disabled.␊ - */␊ - disablePasswordAuthentication?: (boolean | string)␊ - /**␊ - * 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.␊ - */␊ - provisionVMAgent?: (boolean | string)␊ - /**␊ - * SSH configuration for Linux based VMs running on Azure␊ - */␊ - ssh?: (SshConfiguration4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSH configuration for Linux based VMs running on Azure␊ - */␊ - export interface SshConfiguration4 {␊ - /**␊ - * The list of SSH public keys used to authenticate with linux based VMs.␊ - */␊ - publicKeys?: (SshPublicKey3[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed.␊ - */␊ - export interface SshPublicKey3 {␊ - /**␊ - * 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).␊ - */␊ - keyData?: string␊ - /**␊ - * 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␊ - */␊ - path?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a set of certificates which are all in the same Key Vault.␊ - */␊ - export interface VaultSecretGroup3 {␊ - sourceVault?: (SubResource36 | string)␊ - /**␊ - * The list of key vault references in SourceVault which contain certificates.␊ - */␊ - vaultCertificates?: (VaultCertificate3[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM.␊ - */␊ - export interface VaultCertificate3 {␊ - /**␊ - * 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 <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted.␊ - */␊ - certificateStore?: string␊ - /**␊ - * 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":""
    }␊ - */␊ - certificateUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies Windows operating system settings on the virtual machine.␊ - */␊ - export interface WindowsConfiguration5 {␊ - /**␊ - * Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup.␊ - */␊ - additionalUnattendContent?: (AdditionalUnattendContent4[] | string)␊ - /**␊ - * Indicates whether virtual machine is enabled for automatic updates.␊ - */␊ - enableAutomaticUpdates?: (boolean | string)␊ - /**␊ - * 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.␊ - */␊ - provisionVMAgent?: (boolean | string)␊ - /**␊ - * Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time"␊ - */␊ - timeZone?: string␊ - /**␊ - * Describes Windows Remote Management configuration of the VM␊ - */␊ - winRM?: (WinRMConfiguration3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * 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.␊ - */␊ - export interface AdditionalUnattendContent4 {␊ - /**␊ - * The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup.␊ - */␊ - componentName?: ("Microsoft-Windows-Shell-Setup" | string)␊ - /**␊ - * 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.␊ - */␊ - content?: string␊ - /**␊ - * The pass name. Currently, the only allowable value is OobeSystem.␊ - */␊ - passName?: ("OobeSystem" | string)␊ - /**␊ - * Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.␊ - */␊ - settingName?: (("AutoLogon" | "FirstLogonCommands") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes Windows Remote Management configuration of the VM␊ - */␊ - export interface WinRMConfiguration3 {␊ - /**␊ - * The list of Windows Remote Management listeners␊ - */␊ - listeners?: (WinRMListener4[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes Protocol and thumbprint of Windows Remote Management listener␊ - */␊ - export interface WinRMListener4 {␊ - /**␊ - * 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":""
    }␊ - */␊ - certificateUrl?: string␊ - /**␊ - * Specifies the protocol of listener.

    Possible values are:
    **http**

    **https**.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the storage settings for the virtual machine disks.␊ - */␊ - export interface StorageProfile9 {␊ - /**␊ - * 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).␊ - */␊ - dataDisks?: (DataDisk5[] | string)␊ - /**␊ - * 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. NOTE: Image reference publisher and offer can only be set when you create the scale set.␊ - */␊ - imageReference?: (ImageReference6 | string)␊ - /**␊ - * 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).␊ - */␊ - osDisk?: (OSDisk4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a data disk.␊ - */␊ - export interface DataDisk5 {␊ - /**␊ - * Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**.␊ - */␊ - caching?: (("None" | "ReadOnly" | "ReadWrite") | string)␊ - /**␊ - * 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.␊ - */␊ - createOption: (("FromImage" | "Empty" | "Attach") | string)␊ - /**␊ - * Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB␊ - */␊ - diskSizeGB?: (number | string)␊ - /**␊ - * Describes the uri of a disk.␊ - */␊ - image?: (VirtualHardDisk3 | string)␊ - /**␊ - * 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.␊ - */␊ - lun: (number | string)␊ - /**␊ - * The parameters of a managed disk.␊ - */␊ - managedDisk?: (ManagedDiskParameters3 | string)␊ - /**␊ - * The disk name.␊ - */␊ - name?: string␊ - /**␊ - * Describes the uri of a disk.␊ - */␊ - vhd?: (VirtualHardDisk3 | string)␊ - /**␊ - * Specifies whether writeAccelerator should be enabled or disabled on the disk.␊ - */␊ - writeAcceleratorEnabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the uri of a disk.␊ - */␊ - export interface VirtualHardDisk3 {␊ - /**␊ - * Specifies the virtual hard disk's uri.␊ - */␊ - uri?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The parameters of a managed disk.␊ - */␊ - export interface ManagedDiskParameters3 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.␊ - */␊ - storageAccountType?: (("Standard_LRS" | "Premium_LRS" | "StandardSSD_LRS" | "UltraSSD_LRS") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * 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. NOTE: Image reference publisher and offer can only be set when you create the scale set.␊ - */␊ - export interface ImageReference6 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Specifies the offer of the platform image or marketplace image used to create the virtual machine.␊ - */␊ - offer?: string␊ - /**␊ - * The image publisher.␊ - */␊ - publisher?: string␊ - /**␊ - * The image SKU.␊ - */␊ - sku?: string␊ - /**␊ - * 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.␊ - */␊ - version?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * 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).␊ - */␊ - export interface OSDisk4 {␊ - /**␊ - * Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**.␊ - */␊ - caching?: (("None" | "ReadOnly" | "ReadWrite") | string)␊ - /**␊ - * 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.␊ - */␊ - createOption: (("FromImage" | "Empty" | "Attach") | string)␊ - /**␊ - * Describes the parameters of ephemeral disk settings that can be specified for operating system disk.

    NOTE: The ephemeral disk settings can only be specified for managed disk.␊ - */␊ - diffDiskSettings?: (DiffDiskSettings | string)␊ - /**␊ - * Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB␊ - */␊ - diskSizeGB?: (number | string)␊ - /**␊ - * Describes a Encryption Settings for a Disk␊ - */␊ - encryptionSettings?: (DiskEncryptionSettings3 | string)␊ - /**␊ - * Describes the uri of a disk.␊ - */␊ - image?: (VirtualHardDisk3 | string)␊ - /**␊ - * The parameters of a managed disk.␊ - */␊ - managedDisk?: (ManagedDiskParameters3 | string)␊ - /**␊ - * The disk name.␊ - */␊ - name?: string␊ - /**␊ - * 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**.␊ - */␊ - osType?: (("Windows" | "Linux") | string)␊ - /**␊ - * Describes the uri of a disk.␊ - */␊ - vhd?: (VirtualHardDisk3 | string)␊ - /**␊ - * Specifies whether writeAccelerator should be enabled or disabled on the disk.␊ - */␊ - writeAcceleratorEnabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the parameters of ephemeral disk settings that can be specified for operating system disk.

    NOTE: The ephemeral disk settings can only be specified for managed disk.␊ - */␊ - export interface DiffDiskSettings {␊ - /**␊ - * Specifies the ephemeral disk settings for operating system disk.␊ - */␊ - option?: ("Local" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a Encryption Settings for a Disk␊ - */␊ - export interface DiskEncryptionSettings3 {␊ - /**␊ - * Describes a reference to Key Vault Secret␊ - */␊ - diskEncryptionKey?: (KeyVaultSecretReference4 | string)␊ - /**␊ - * Specifies whether disk encryption should be enabled on the virtual machine.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Describes a reference to Key Vault Key␊ - */␊ - keyEncryptionKey?: (KeyVaultKeyReference3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a reference to Key Vault Secret␊ - */␊ - export interface KeyVaultSecretReference4 {␊ - /**␊ - * The URL referencing a secret in a Key Vault.␊ - */␊ - secretUrl: string␊ - sourceVault: (SubResource36 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a reference to Key Vault Key␊ - */␊ - export interface KeyVaultKeyReference3 {␊ - /**␊ - * The URL referencing a key encryption key in Key Vault.␊ - */␊ - keyUrl: string␊ - sourceVault: (SubResource36 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/virtualMachines/extensions␊ - */␊ - export interface VirtualMachinesExtensionsChildResource3 {␊ - apiVersion: "2018-06-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the virtual machine extension.␊ - */␊ - name: string␊ - properties: (GenericExtension4 | IaaSDiagnostics4 | IaaSAntimalware4 | CustomScriptExtension4 | CustomScriptForLinux4 | LinuxDiagnostic4 | VmAccessForLinux4 | BgInfo4 | VmAccessAgent4 | DscExtension4 | AcronisBackupLinux4 | AcronisBackup4 | LinuxChefClient4 | ChefClient4 | DatadogLinuxAgent4 | DatadogWindowsAgent4 | DockerExtension4 | DynatraceLinux4 | DynatraceWindows4 | Eset4 | HpeSecurityApplicationDefender4 | PuppetAgent4 | Site24X7LinuxServerExtn4 | Site24X7WindowsServerExtn4 | Site24X7ApmInsightExtn4 | TrendMicroDSALinux4 | TrendMicroDSA4 | BmcCtmAgentLinux4 | BmcCtmAgentWindows4 | OSPatchingForLinux4 | VMSnapshot4 | VMSnapshotLinux4 | CustomScript4 | NetworkWatcherAgentWindows4 | NetworkWatcherAgentLinux4)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "extensions"␊ - [k: string]: unknown␊ - }␊ - export interface GenericExtension4 {␊ - /**␊ - * Microsoft.Compute/extensions - Publisher␊ - */␊ - publisher: string␊ - /**␊ - * Microsoft.Compute/extensions - Type␊ - */␊ - type: string␊ - /**␊ - * Microsoft.Compute/extensions - Type handler version␊ - */␊ - typeHandlerVersion: string␊ - /**␊ - * Microsoft.Compute/extensions - Settings␊ - */␊ - settings: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - export interface IaaSDiagnostics4 {␊ - publisher: "Microsoft.Azure.Diagnostics"␊ - type: "IaaSDiagnostics"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - xmlCfg: string␊ - StorageAccount: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - storageAccountName: string␊ - storageAccountKey: string␊ - storageAccountEndPoint: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface IaaSAntimalware4 {␊ - publisher: "Microsoft.Azure.Security"␊ - type: "IaaSAntimalware"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - AntimalwareEnabled: boolean␊ - Exclusions: {␊ - Paths: string␊ - Extensions: string␊ - Processes: string␊ - [k: string]: unknown␊ - }␊ - RealtimeProtectionEnabled: ("true" | "false")␊ - ScheduledScanSettings: {␊ - isEnabled: ("true" | "false")␊ - scanType: string␊ - day: string␊ - time: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface CustomScriptExtension4 {␊ - publisher: "Microsoft.Compute"␊ - type: "CustomScriptExtension"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - fileUris?: string[]␊ - commandToExecute: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - storageAccountName?: string␊ - storageAccountKey?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface CustomScriptForLinux4 {␊ - publisher: "Microsoft.OSTCExtensions"␊ - type: "CustomScriptForLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - fileUris?: string[]␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - commandToExecute: string␊ - storageAccountName?: string␊ - storageAccountKey?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface LinuxDiagnostic4 {␊ - publisher: "Microsoft.OSTCExtensions"␊ - type: "LinuxDiagnostic"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - enableSyslog?: string␊ - mdsdHttpProxy?: string␊ - perCfg?: unknown[]␊ - fileCfg?: unknown[]␊ - xmlCfg?: string␊ - ladCfg?: {␊ - [k: string]: unknown␊ - }␊ - syslogCfg?: string␊ - eventVolume?: string␊ - mdsdCfg?: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - mdsdHttpProxy?: string␊ - storageAccountName: string␊ - storageAccountKey: string␊ - storageAccountEndPoint?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface VmAccessForLinux4 {␊ - publisher: "Microsoft.OSTCExtensions"␊ - type: "VMAccessForLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - check_disk?: boolean␊ - repair_disk?: boolean␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - username: string␊ - password: string␊ - ssh_key: string␊ - reset_ssh: string␊ - remove_user: string␊ - expiration: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface BgInfo4 {␊ - publisher: "Microsoft.Compute"␊ - type: "bginfo"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - [k: string]: unknown␊ - }␊ - export interface VmAccessAgent4 {␊ - publisher: "Microsoft.Compute"␊ - type: "VMAccessAgent"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - username?: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - password?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface DscExtension4 {␊ - publisher: "Microsoft.Powershell"␊ - type: "DSC"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - modulesUrl: string␊ - configurationFunction: string␊ - properties?: string␊ - wmfVersion?: string␊ - privacy?: {␊ - dataCollection?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - dataBlobUri?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface AcronisBackupLinux4 {␊ - publisher: "Acronis.Backup"␊ - type: "AcronisBackupLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - absURL: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - userLogin: string␊ - userPassword: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface AcronisBackup4 {␊ - publisher: "Acronis.Backup"␊ - type: "AcronisBackup"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - absURL: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - userLogin: string␊ - userPassword: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface LinuxChefClient4 {␊ - publisher: "Chef.Bootstrap.WindowsAzure"␊ - type: "LinuxChefClient"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - bootstrap_version?: string␊ - bootstrap_options?: {␊ - chef_node_name: string␊ - chef_server_url: string␊ - validation_client_name: string␊ - node_ssl_verify_mode: string␊ - environment: string␊ - [k: string]: unknown␊ - }␊ - runlist?: string␊ - client_rb?: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - validation_key: string␊ - chef_server_crt: string␊ - secret: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface ChefClient4 {␊ - publisher: "Chef.Bootstrap.WindowsAzure"␊ - type: "ChefClient"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - bootstrap_options?: {␊ - chef_node_name: string␊ - chef_server_url: string␊ - validation_client_name: string␊ - node_ssl_verify_mode: string␊ - environment: string␊ - [k: string]: unknown␊ - }␊ - runlist?: string␊ - client_rb?: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - validation_key: string␊ - chef_server_crt: string␊ - secret: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface DatadogLinuxAgent4 {␊ - publisher: "Datadog.Agent"␊ - type: "DatadogLinuxAgent"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - api_key: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface DatadogWindowsAgent4 {␊ - publisher: "Datadog.Agent"␊ - type: "DatadogWindowsAgent"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - api_key: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface DockerExtension4 {␊ - publisher: "Microsoft.Azure.Extensions"␊ - type: "DockerExtension"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - docker: {␊ - port: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - certs: {␊ - ca: string␊ - cert: string␊ - key: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface DynatraceLinux4 {␊ - publisher: "dynatrace.ruxit"␊ - type: "ruxitAgentLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - tenantId: string␊ - token: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface DynatraceWindows4 {␊ - publisher: "dynatrace.ruxit"␊ - type: "ruxitAgentWindows"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - tenantId: string␊ - token: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Eset4 {␊ - publisher: "ESET"␊ - type: "FileSecurity"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - LicenseKey: string␊ - "Install-RealtimeProtection": boolean␊ - "Install-ProtocolFiltering": boolean␊ - "Install-DeviceControl": boolean␊ - "Enable-Cloud": boolean␊ - "Enable-PUA": boolean␊ - ERAAgentCfgUrl: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface HpeSecurityApplicationDefender4 {␊ - publisher: "HPE.Security.ApplicationDefender"␊ - type: "DotnetAgent"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - protectedSettings: {␊ - key: string␊ - serverURL: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface PuppetAgent4 {␊ - publisher: "Puppet"␊ - type: "PuppetAgent"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - protectedSettings: {␊ - PUPPET_MASTER_SERVER: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Site24X7LinuxServerExtn4 {␊ - publisher: "Site24x7"␊ - type: "Site24x7LinuxServerExtn"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - site24x7AgentType?: "azurevmextnlinuxserver"␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - site24x7LicenseKey: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Site24X7WindowsServerExtn4 {␊ - publisher: "Site24x7"␊ - type: "Site24x7WindowsServerExtn"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - site24x7AgentType?: "azurevmextnwindowsserver"␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - site24x7LicenseKey: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Site24X7ApmInsightExtn4 {␊ - publisher: "Site24x7"␊ - type: "Site24x7ApmInsightExtn"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - site24x7AgentType?: "azurevmextnapminsightclassic"␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - site24x7LicenseKey: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface TrendMicroDSALinux4 {␊ - publisher: "TrendMicro.DeepSecurity"␊ - type: "TrendMicroDSALinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - DSMname: string␊ - DSMport: string␊ - policyNameorID?: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - tenantID: string␊ - tenantPassword: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface TrendMicroDSA4 {␊ - publisher: "TrendMicro.DeepSecurity"␊ - type: "TrendMicroDSA"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - DSMname: string␊ - DSMport: string␊ - policyNameorID?: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - tenantID: string␊ - tenantPassword: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface BmcCtmAgentLinux4 {␊ - publisher: "ctm.bmc.com"␊ - type: "BmcCtmAgentLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - "Control-M Server Name": string␊ - "Agent Port": string␊ - "Host Group": string␊ - "User Account": string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface BmcCtmAgentWindows4 {␊ - publisher: "bmc.ctm"␊ - type: "AgentWinExt"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - "Control-M Server Name": string␊ - "Agent Port": string␊ - "Host Group": string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface OSPatchingForLinux4 {␊ - publisher: "Microsoft.OSTCExtensions"␊ - type: "OSPatchingForLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - disabled: boolean␊ - stop: boolean␊ - installDuration?: string␊ - intervalOfWeeks?: number␊ - dayOfWeek?: string␊ - startTime?: string␊ - rebootAfterPatch?: string␊ - category?: string␊ - oneoff?: boolean␊ - local?: boolean␊ - idleTestScript?: string␊ - healthyTestScript?: string␊ - distUpgradeList?: string␊ - distUpgradeAll?: boolean␊ - vmStatusTest?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - storageAccountName?: string␊ - storageAccountKey?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface VMSnapshot4 {␊ - publisher: "Microsoft.Azure.RecoveryServices"␊ - type: "VMSnapshot"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - locale: string␊ - taskId: string␊ - commandToExecute: string␊ - objectStr: string␊ - logsBlobUri: string␊ - statusBlobUri: string␊ - commandStartTimeUTCTicks: string␊ - vmType: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface VMSnapshotLinux4 {␊ - publisher: "Microsoft.Azure.RecoveryServices"␊ - type: "VMSnapshotLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - locale: string␊ - taskId: string␊ - commandToExecute: string␊ - objectStr: string␊ - logsBlobUri: string␊ - statusBlobUri: string␊ - commandStartTimeUTCTicks: string␊ - vmType: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface CustomScript4 {␊ - publisher: "Microsoft.Azure.Extensions"␊ - type: "CustomScript"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - fileUris: string[]␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - storageAccountName: string␊ - storageAccountKey: string␊ - commandToExecute: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface NetworkWatcherAgentWindows4 {␊ - publisher: "Microsoft.Azure.NetworkWatcher"␊ - type: "NetworkWatcherAgentWindows"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - [k: string]: unknown␊ - }␊ - export interface NetworkWatcherAgentLinux4 {␊ - publisher: "Microsoft.Azure.NetworkWatcher"␊ - type: "NetworkWatcherAgentLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/virtualMachineScaleSets␊ - */␊ - export interface VirtualMachineScaleSets4 {␊ - apiVersion: "2018-06-01"␊ - /**␊ - * Identity for the virtual machine scale set.␊ - */␊ - identity?: (VirtualMachineScaleSetIdentity3 | string)␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the VM scale set to create or update.␊ - */␊ - name: string␊ - /**␊ - * 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**.␊ - */␊ - plan?: (Plan4 | string)␊ - /**␊ - * Describes the properties of a Virtual Machine Scale Set.␊ - */␊ - properties: (VirtualMachineScaleSetProperties3 | string)␊ - resources?: (VirtualMachineScaleSetsExtensionsChildResource2 | VirtualMachineScaleSetsVirtualmachinesChildResource1)[]␊ - /**␊ - * Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name.␊ - */␊ - sku?: (Sku54 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/virtualMachineScaleSets"␊ - /**␊ - * The virtual machine scale set zones. NOTE: Availability zones can only be set when you create the scale set.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the virtual machine scale set.␊ - */␊ - export interface VirtualMachineScaleSetIdentity3 {␊ - /**␊ - * The type of identity used for the virtual machine scale set. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine scale set.␊ - */␊ - type?: (("SystemAssigned" | "UserAssigned" | "SystemAssigned, UserAssigned" | "None") | string)␊ - /**␊ - * The list of user identities associated with the virtual machine scale set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.␊ - */␊ - userAssignedIdentities?: ({␊ - [k: string]: VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - export interface VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the properties of a Virtual Machine Scale Set.␊ - */␊ - export interface VirtualMachineScaleSetProperties3 {␊ - /**␊ - * Specifies whether the Virtual Machine Scale Set should be overprovisioned.␊ - */␊ - overprovision?: (boolean | string)␊ - /**␊ - * Fault Domain count for each placement group.␊ - */␊ - platformFaultDomainCount?: (number | string)␊ - proximityPlacementGroup?: (SubResource36 | string)␊ - /**␊ - * When true this limits the scale set to a single placement group, of max size 100 virtual machines.␊ - */␊ - singlePlacementGroup?: (boolean | string)␊ - /**␊ - * Describes an upgrade policy - automatic, manual, or rolling.␊ - */␊ - upgradePolicy?: (UpgradePolicy4 | string)␊ - /**␊ - * Describes a virtual machine scale set virtual machine profile.␊ - */␊ - virtualMachineProfile?: (VirtualMachineScaleSetVMProfile3 | string)␊ - /**␊ - * Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage.␊ - */␊ - zoneBalance?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes an upgrade policy - automatic, manual, or rolling.␊ - */␊ - export interface UpgradePolicy4 {␊ - /**␊ - * Whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the image becomes available.␊ - */␊ - automaticOSUpgrade?: (boolean | string)␊ - /**␊ - * The configuration parameters used for performing automatic OS upgrade.␊ - */␊ - autoOSUpgradePolicy?: (AutoOSUpgradePolicy1 | string)␊ - /**␊ - * 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.␊ - */␊ - mode?: (("Automatic" | "Manual" | "Rolling") | string)␊ - /**␊ - * The configuration parameters used while performing a rolling upgrade.␊ - */␊ - rollingUpgradePolicy?: (RollingUpgradePolicy2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The configuration parameters used for performing automatic OS upgrade.␊ - */␊ - export interface AutoOSUpgradePolicy1 {␊ - /**␊ - * Whether OS image rollback feature should be disabled. Default value is false.␊ - */␊ - disableAutoRollback?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The configuration parameters used while performing a rolling upgrade.␊ - */␊ - export interface RollingUpgradePolicy2 {␊ - /**␊ - * 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%.␊ - */␊ - maxBatchInstancePercent?: (number | string)␊ - /**␊ - * 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%.␊ - */␊ - maxUnhealthyInstancePercent?: (number | string)␊ - /**␊ - * 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%.␊ - */␊ - maxUnhealthyUpgradedInstancePercent?: (number | string)␊ - /**␊ - * 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).␊ - */␊ - pauseTimeBetweenBatches?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set virtual machine profile.␊ - */␊ - export interface VirtualMachineScaleSetVMProfile3 {␊ - /**␊ - * Enables or disables a capability on the virtual machine or virtual machine scale set.␊ - */␊ - additionalCapabilities?: (AdditionalCapabilities | string)␊ - /**␊ - * Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15.␊ - */␊ - diagnosticsProfile?: (DiagnosticsProfile3 | string)␊ - /**␊ - * Specifies the eviction policy for virtual machines in a low priority scale set.

    Minimum api-version: 2017-10-30-preview.␊ - */␊ - evictionPolicy?: (("Deallocate" | "Delete") | string)␊ - /**␊ - * Describes a virtual machine scale set extension profile.␊ - */␊ - extensionProfile?: (VirtualMachineScaleSetExtensionProfile4 | string)␊ - /**␊ - * 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␊ - */␊ - licenseType?: string␊ - /**␊ - * Describes a virtual machine scale set network profile.␊ - */␊ - networkProfile?: (VirtualMachineScaleSetNetworkProfile4 | string)␊ - /**␊ - * Describes a virtual machine scale set OS profile.␊ - */␊ - osProfile?: (VirtualMachineScaleSetOSProfile3 | string)␊ - /**␊ - * Specifies the priority for the virtual machines in the scale set.

    Minimum api-version: 2017-10-30-preview.␊ - */␊ - priority?: (("Regular" | "Low") | string)␊ - /**␊ - * Describes a virtual machine scale set storage profile.␊ - */␊ - storageProfile?: (VirtualMachineScaleSetStorageProfile4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set extension profile.␊ - */␊ - export interface VirtualMachineScaleSetExtensionProfile4 {␊ - /**␊ - * The virtual machine scale set child extension resources.␊ - */␊ - extensions?: (VirtualMachineScaleSetExtension4[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a Virtual Machine Scale Set Extension.␊ - */␊ - export interface VirtualMachineScaleSetExtension4 {␊ - /**␊ - * The name of the extension.␊ - */␊ - name?: string␊ - properties?: (GenericExtension4 | IaaSDiagnostics4 | IaaSAntimalware4 | CustomScriptExtension4 | CustomScriptForLinux4 | LinuxDiagnostic4 | VmAccessForLinux4 | BgInfo4 | VmAccessAgent4 | DscExtension4 | AcronisBackupLinux4 | AcronisBackup4 | LinuxChefClient4 | ChefClient4 | DatadogLinuxAgent4 | DatadogWindowsAgent4 | DockerExtension4 | DynatraceLinux4 | DynatraceWindows4 | Eset4 | HpeSecurityApplicationDefender4 | PuppetAgent4 | Site24X7LinuxServerExtn4 | Site24X7WindowsServerExtn4 | Site24X7ApmInsightExtn4 | TrendMicroDSALinux4 | TrendMicroDSA4 | BmcCtmAgentLinux4 | BmcCtmAgentWindows4 | OSPatchingForLinux4 | VMSnapshot4 | VMSnapshotLinux4 | CustomScript4 | NetworkWatcherAgentWindows4 | NetworkWatcherAgentLinux4)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set network profile.␊ - */␊ - export interface VirtualMachineScaleSetNetworkProfile4 {␊ - /**␊ - * The API entity reference.␊ - */␊ - healthProbe?: (ApiEntityReference3 | string)␊ - /**␊ - * The list of network configurations.␊ - */␊ - networkInterfaceConfigurations?: (VirtualMachineScaleSetNetworkConfiguration3[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The API entity reference.␊ - */␊ - export interface ApiEntityReference3 {␊ - /**␊ - * The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set network profile's network configurations.␊ - */␊ - export interface VirtualMachineScaleSetNetworkConfiguration3 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * The network configuration name.␊ - */␊ - name: string␊ - /**␊ - * Describes a virtual machine scale set network profile's IP configuration.␊ - */␊ - properties?: (VirtualMachineScaleSetNetworkConfigurationProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set network profile's IP configuration.␊ - */␊ - export interface VirtualMachineScaleSetNetworkConfigurationProperties3 {␊ - /**␊ - * Describes a virtual machines scale sets network configuration's DNS settings.␊ - */␊ - dnsSettings?: (VirtualMachineScaleSetNetworkConfigurationDnsSettings2 | string)␊ - /**␊ - * Specifies whether the network interface is accelerated networking-enabled.␊ - */␊ - enableAcceleratedNetworking?: (boolean | string)␊ - /**␊ - * Whether IP forwarding enabled on this NIC.␊ - */␊ - enableIPForwarding?: (boolean | string)␊ - /**␊ - * Specifies the IP configurations of the network interface.␊ - */␊ - ipConfigurations: (VirtualMachineScaleSetIPConfiguration3[] | string)␊ - networkSecurityGroup?: (SubResource36 | string)␊ - /**␊ - * Specifies the primary network interface in case the virtual machine has more than 1 network interface.␊ - */␊ - primary?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machines scale sets network configuration's DNS settings.␊ - */␊ - export interface VirtualMachineScaleSetNetworkConfigurationDnsSettings2 {␊ - /**␊ - * List of DNS servers IP addresses␊ - */␊ - dnsServers?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set network profile's IP configuration.␊ - */␊ - export interface VirtualMachineScaleSetIPConfiguration3 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * The IP configuration name.␊ - */␊ - name: string␊ - /**␊ - * Describes a virtual machine scale set network profile's IP configuration properties.␊ - */␊ - properties?: (VirtualMachineScaleSetIPConfigurationProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set network profile's IP configuration properties.␊ - */␊ - export interface VirtualMachineScaleSetIPConfigurationProperties3 {␊ - /**␊ - * 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.␊ - */␊ - applicationGatewayBackendAddressPools?: (SubResource36[] | string)␊ - /**␊ - * Specifies an array of references to application security group.␊ - */␊ - applicationSecurityGroups?: (SubResource36[] | string)␊ - /**␊ - * 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.␊ - */␊ - loadBalancerBackendAddressPools?: (SubResource36[] | string)␊ - /**␊ - * 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␊ - */␊ - loadBalancerInboundNatPools?: (SubResource36[] | string)␊ - /**␊ - * Specifies the primary network interface in case the virtual machine has more than 1 network interface.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * 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'.␊ - */␊ - privateIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration␊ - */␊ - publicIPAddressConfiguration?: (VirtualMachineScaleSetPublicIPAddressConfiguration2 | string)␊ - /**␊ - * The API entity reference.␊ - */␊ - subnet?: (ApiEntityReference3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration␊ - */␊ - export interface VirtualMachineScaleSetPublicIPAddressConfiguration2 {␊ - /**␊ - * The publicIP address configuration name.␊ - */␊ - name: string␊ - /**␊ - * Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration␊ - */␊ - properties?: (VirtualMachineScaleSetPublicIPAddressConfigurationProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration␊ - */␊ - export interface VirtualMachineScaleSetPublicIPAddressConfigurationProperties2 {␊ - /**␊ - * Describes a virtual machines scale sets network configuration's DNS settings.␊ - */␊ - dnsSettings?: (VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings2 | string)␊ - /**␊ - * The idle timeout of the public IP address.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * The list of IP tags associated with the public IP address.␊ - */␊ - ipTags?: (VirtualMachineScaleSetIpTag[] | string)␊ - publicIPPrefix?: (SubResource36 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machines scale sets network configuration's DNS settings.␊ - */␊ - export interface VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings2 {␊ - /**␊ - * 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␊ - */␊ - domainNameLabel: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains the IP tag associated with the public IP address.␊ - */␊ - export interface VirtualMachineScaleSetIpTag {␊ - /**␊ - * IP tag type. Example: FirstPartyUsage.␊ - */␊ - ipTagType?: string␊ - /**␊ - * IP tag associated with the public IP. Example: SQL, Storage etc.␊ - */␊ - tag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set OS profile.␊ - */␊ - export interface VirtualMachineScaleSetOSProfile3 {␊ - /**␊ - * 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)␊ - */␊ - adminPassword?: string␊ - /**␊ - * 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)␊ - */␊ - adminUsername?: string␊ - /**␊ - * 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.␊ - */␊ - computerNamePrefix?: string␊ - /**␊ - * 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)␊ - */␊ - customData?: string␊ - /**␊ - * 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).␊ - */␊ - linuxConfiguration?: (LinuxConfiguration4 | string)␊ - /**␊ - * Specifies set of certificates that should be installed onto the virtual machines in the scale set.␊ - */␊ - secrets?: (VaultSecretGroup3[] | string)␊ - /**␊ - * Specifies Windows operating system settings on the virtual machine.␊ - */␊ - windowsConfiguration?: (WindowsConfiguration5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set storage profile.␊ - */␊ - export interface VirtualMachineScaleSetStorageProfile4 {␊ - /**␊ - * 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).␊ - */␊ - dataDisks?: (VirtualMachineScaleSetDataDisk3[] | string)␊ - /**␊ - * 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. NOTE: Image reference publisher and offer can only be set when you create the scale set.␊ - */␊ - imageReference?: (ImageReference6 | string)␊ - /**␊ - * Describes a virtual machine scale set operating system disk.␊ - */␊ - osDisk?: (VirtualMachineScaleSetOSDisk4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set data disk.␊ - */␊ - export interface VirtualMachineScaleSetDataDisk3 {␊ - /**␊ - * Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**.␊ - */␊ - caching?: (("None" | "ReadOnly" | "ReadWrite") | string)␊ - /**␊ - * The create option.␊ - */␊ - createOption: (("FromImage" | "Empty" | "Attach") | string)␊ - /**␊ - * Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB␊ - */␊ - diskSizeGB?: (number | string)␊ - /**␊ - * 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.␊ - */␊ - lun: (number | string)␊ - /**␊ - * Describes the parameters of a ScaleSet managed disk.␊ - */␊ - managedDisk?: (VirtualMachineScaleSetManagedDiskParameters3 | string)␊ - /**␊ - * The disk name.␊ - */␊ - name?: string␊ - /**␊ - * Specifies whether writeAccelerator should be enabled or disabled on the disk.␊ - */␊ - writeAcceleratorEnabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the parameters of a ScaleSet managed disk.␊ - */␊ - export interface VirtualMachineScaleSetManagedDiskParameters3 {␊ - /**␊ - * Specifies the storage account type for the managed disk. Managed OS disk storage account type can only be set when you create the scale set. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.␊ - */␊ - storageAccountType?: (("Standard_LRS" | "Premium_LRS" | "StandardSSD_LRS" | "UltraSSD_LRS") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set operating system disk.␊ - */␊ - export interface VirtualMachineScaleSetOSDisk4 {␊ - /**␊ - * Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**.␊ - */␊ - caching?: (("None" | "ReadOnly" | "ReadWrite") | string)␊ - /**␊ - * 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.␊ - */␊ - createOption: (("FromImage" | "Empty" | "Attach") | string)␊ - /**␊ - * Describes the parameters of ephemeral disk settings that can be specified for operating system disk.

    NOTE: The ephemeral disk settings can only be specified for managed disk.␊ - */␊ - diffDiskSettings?: (DiffDiskSettings | string)␊ - /**␊ - * Specifies the size of the operating system disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB␊ - */␊ - diskSizeGB?: (number | string)␊ - /**␊ - * Describes the uri of a disk.␊ - */␊ - image?: (VirtualHardDisk3 | string)␊ - /**␊ - * Describes the parameters of a ScaleSet managed disk.␊ - */␊ - managedDisk?: (VirtualMachineScaleSetManagedDiskParameters3 | string)␊ - /**␊ - * The disk name.␊ - */␊ - name?: string␊ - /**␊ - * 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**.␊ - */␊ - osType?: (("Windows" | "Linux") | string)␊ - /**␊ - * Specifies the container urls that are used to store operating system disks for the scale set.␊ - */␊ - vhdContainers?: (string[] | string)␊ - /**␊ - * Specifies whether writeAccelerator should be enabled or disabled on the disk.␊ - */␊ - writeAcceleratorEnabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/virtualMachineScaleSets/extensions␊ - */␊ - export interface VirtualMachineScaleSetsExtensionsChildResource2 {␊ - apiVersion: "2018-06-01"␊ - /**␊ - * The name of the VM scale set extension.␊ - */␊ - name: string␊ - /**␊ - * Describes the properties of a Virtual Machine Scale Set Extension.␊ - */␊ - properties: (VirtualMachineScaleSetExtensionProperties2 | string)␊ - type: "extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the properties of a Virtual Machine Scale Set Extension.␊ - */␊ - export interface VirtualMachineScaleSetExtensionProperties2 {␊ - /**␊ - * 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.␊ - */␊ - autoUpgradeMinorVersion?: (boolean | string)␊ - /**␊ - * 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.␊ - */␊ - forceUpdateTag?: string␊ - /**␊ - * The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.␊ - */␊ - protectedSettings?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Collection of extension names after which this extension needs to be provisioned.␊ - */␊ - provisionAfterExtensions?: (string[] | string)␊ - /**␊ - * The name of the extension handler publisher.␊ - */␊ - publisher?: string␊ - /**␊ - * Json formatted public settings for the extension.␊ - */␊ - settings?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the type of the extension; an example is "CustomScriptExtension".␊ - */␊ - type?: string␊ - /**␊ - * Specifies the version of the script handler.␊ - */␊ - typeHandlerVersion?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/virtualMachineScaleSets/virtualmachines␊ - */␊ - export interface VirtualMachineScaleSetsVirtualmachinesChildResource1 {␊ - apiVersion: "2018-06-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The instance ID of the virtual machine.␊ - */␊ - name: string␊ - /**␊ - * 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**.␊ - */␊ - plan?: (Plan4 | string)␊ - /**␊ - * Describes the properties of a virtual machine scale set virtual machine.␊ - */␊ - properties: (VirtualMachineScaleSetVMProperties1 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "virtualmachines"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the properties of a virtual machine scale set virtual machine.␊ - */␊ - export interface VirtualMachineScaleSetVMProperties1 {␊ - /**␊ - * Enables or disables a capability on the virtual machine or virtual machine scale set.␊ - */␊ - additionalCapabilities?: (AdditionalCapabilities | string)␊ - availabilitySet?: (SubResource36 | string)␊ - /**␊ - * Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15.␊ - */␊ - diagnosticsProfile?: (DiagnosticsProfile3 | string)␊ - /**␊ - * Specifies the hardware settings for the virtual machine.␊ - */␊ - hardwareProfile?: (HardwareProfile4 | string)␊ - /**␊ - * 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␊ - */␊ - licenseType?: string␊ - /**␊ - * Specifies the network interfaces of the virtual machine.␊ - */␊ - networkProfile?: (NetworkProfile4 | string)␊ - /**␊ - * Specifies the operating system settings for the virtual machine.␊ - */␊ - osProfile?: (OSProfile3 | string)␊ - /**␊ - * Specifies the storage settings for the virtual machine disks.␊ - */␊ - storageProfile?: (StorageProfile9 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/disks␊ - */␊ - export interface Disks3 {␊ - apiVersion: "2018-06-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters.␊ - */␊ - name: string␊ - /**␊ - * Disk resource properties.␊ - */␊ - properties: (DiskProperties4 | string)␊ - /**␊ - * The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, or UltraSSD_LRS.␊ - */␊ - sku?: (DiskSku2 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/disks"␊ - /**␊ - * The Logical zone list for Disk.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Disk resource properties.␊ - */␊ - export interface DiskProperties4 {␊ - /**␊ - * Data used when creating a disk.␊ - */␊ - creationData: (CreationData3 | string)␊ - /**␊ - * The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes. For a description of the range of values you can set, see [Ultra SSD Managed Disk Offerings](https://docs.microsoft.com/azure/virtual-machines/windows/disks-ultra-ssd#ultra-ssd-managed-disk-offerings).␊ - */␊ - diskIOPSReadWrite?: (number | string)␊ - /**␊ - * The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. For a description of the range of values you can set, see [Ultra SSD Managed Disk Offerings](https://docs.microsoft.com/azure/virtual-machines/windows/disks-ultra-ssd#ultra-ssd-managed-disk-offerings).␊ - */␊ - diskMBpsReadWrite?: (number | string)␊ - /**␊ - * If creationData.createOption is Empty, this field is mandatory and it indicates the size of the VHD to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size.␊ - */␊ - diskSizeGB?: (number | string)␊ - /**␊ - * Encryption settings for disk or snapshot␊ - */␊ - encryptionSettings?: (EncryptionSettings3 | string)␊ - /**␊ - * The Operating System type.␊ - */␊ - osType?: (("Windows" | "Linux") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Data used when creating a disk.␊ - */␊ - export interface CreationData3 {␊ - /**␊ - * This enumerates the possible sources of a disk's creation.␊ - */␊ - createOption: (("Empty" | "Attach" | "FromImage" | "Import" | "Copy" | "Restore") | string)␊ - /**␊ - * The source image used for creating the disk.␊ - */␊ - imageReference?: (ImageDiskReference3 | string)␊ - /**␊ - * If createOption is Copy, this is the ARM id of the source snapshot or disk.␊ - */␊ - sourceResourceId?: string␊ - /**␊ - * If createOption is Import, this is the URI of a blob to be imported into a managed disk.␊ - */␊ - sourceUri?: string␊ - /**␊ - * If createOption is Import, the Azure Resource Manager identifier of the storage account containing the blob to import as a disk. Required only if the blob is in a different subscription␊ - */␊ - storageAccountId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The source image used for creating the disk.␊ - */␊ - export interface ImageDiskReference3 {␊ - /**␊ - * A relative uri containing either a Platform Image Repository or user image reference.␊ - */␊ - id: string␊ - /**␊ - * If the disk is created from an image's data disk, this is an index that indicates which of the data disks in the image to use. For OS disks, this field is null.␊ - */␊ - lun?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Encryption settings for disk or snapshot␊ - */␊ - export interface EncryptionSettings3 {␊ - /**␊ - * Key Vault Secret Url and vault id of the encryption key ␊ - */␊ - diskEncryptionKey?: (KeyVaultAndSecretReference3 | string)␊ - /**␊ - * Set this flag to true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable encryption. Set this flag to false and remove DiskEncryptionKey and KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the request object, the existing settings remain unchanged.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey␊ - */␊ - keyEncryptionKey?: (KeyVaultAndKeyReference3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Key Vault Secret Url and vault id of the encryption key ␊ - */␊ - export interface KeyVaultAndSecretReference3 {␊ - /**␊ - * Url pointing to a key or secret in KeyVault␊ - */␊ - secretUrl: string␊ - /**␊ - * The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}␊ - */␊ - sourceVault: (SourceVault3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}␊ - */␊ - export interface SourceVault3 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey␊ - */␊ - export interface KeyVaultAndKeyReference3 {␊ - /**␊ - * Url pointing to a key or secret in KeyVault␊ - */␊ - keyUrl: string␊ - /**␊ - * The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}␊ - */␊ - sourceVault: (SourceVault3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, or UltraSSD_LRS.␊ - */␊ - export interface DiskSku2 {␊ - /**␊ - * The sku name.␊ - */␊ - name?: (("Standard_LRS" | "Premium_LRS" | "StandardSSD_LRS" | "UltraSSD_LRS") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/snapshots␊ - */␊ - export interface Snapshots3 {␊ - apiVersion: "2018-06-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the snapshot that is being created. The name can't be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The max name length is 80 characters.␊ - */␊ - name: string␊ - /**␊ - * Snapshot resource properties.␊ - */␊ - properties: (SnapshotProperties | string)␊ - /**␊ - * The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS.␊ - */␊ - sku?: (SnapshotSku1 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/snapshots"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Snapshot resource properties.␊ - */␊ - export interface SnapshotProperties {␊ - /**␊ - * Data used when creating a disk.␊ - */␊ - creationData: (CreationData3 | string)␊ - /**␊ - * If creationData.createOption is Empty, this field is mandatory and it indicates the size of the VHD to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size.␊ - */␊ - diskSizeGB?: (number | string)␊ - /**␊ - * Encryption settings for disk or snapshot␊ - */␊ - encryptionSettings?: (EncryptionSettings3 | string)␊ - /**␊ - * The Operating System type.␊ - */␊ - osType?: (("Windows" | "Linux") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS.␊ - */␊ - export interface SnapshotSku1 {␊ - /**␊ - * The sku name.␊ - */␊ - name?: (("Standard_LRS" | "Premium_LRS" | "Standard_ZRS") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/virtualMachineScaleSets/virtualmachines␊ - */␊ - export interface VirtualMachineScaleSetsVirtualmachines {␊ - apiVersion: "2018-06-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The instance ID of the virtual machine.␊ - */␊ - name: string␊ - /**␊ - * 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**.␊ - */␊ - plan?: (Plan4 | string)␊ - /**␊ - * Describes the properties of a virtual machine scale set virtual machine.␊ - */␊ - properties: (VirtualMachineScaleSetVMProperties1 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/virtualMachineScaleSets/virtualmachines"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/virtualMachines/extensions␊ - */␊ - export interface VirtualMachinesExtensions3 {␊ - apiVersion: "2018-06-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the virtual machine extension.␊ - */␊ - name: string␊ - properties: (GenericExtension4 | IaaSDiagnostics4 | IaaSAntimalware4 | CustomScriptExtension4 | CustomScriptForLinux4 | LinuxDiagnostic4 | VmAccessForLinux4 | BgInfo4 | VmAccessAgent4 | DscExtension4 | AcronisBackupLinux4 | AcronisBackup4 | LinuxChefClient4 | ChefClient4 | DatadogLinuxAgent4 | DatadogWindowsAgent4 | DockerExtension4 | DynatraceLinux4 | DynatraceWindows4 | Eset4 | HpeSecurityApplicationDefender4 | PuppetAgent4 | Site24X7LinuxServerExtn4 | Site24X7WindowsServerExtn4 | Site24X7ApmInsightExtn4 | TrendMicroDSALinux4 | TrendMicroDSA4 | BmcCtmAgentLinux4 | BmcCtmAgentWindows4 | OSPatchingForLinux4 | VMSnapshot4 | VMSnapshotLinux4 | CustomScript4 | NetworkWatcherAgentWindows4 | NetworkWatcherAgentLinux4)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/virtualMachines/extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/virtualMachineScaleSets/extensions␊ - */␊ - export interface VirtualMachineScaleSetsExtensions1 {␊ - apiVersion: "2018-06-01"␊ - /**␊ - * The name of the VM scale set extension.␊ - */␊ - name: string␊ - properties: (GenericExtension4 | IaaSDiagnostics4 | IaaSAntimalware4 | CustomScriptExtension4 | CustomScriptForLinux4 | LinuxDiagnostic4 | VmAccessForLinux4 | BgInfo4 | VmAccessAgent4 | DscExtension4 | AcronisBackupLinux4 | AcronisBackup4 | LinuxChefClient4 | ChefClient4 | DatadogLinuxAgent4 | DatadogWindowsAgent4 | DockerExtension4 | DynatraceLinux4 | DynatraceWindows4 | Eset4 | HpeSecurityApplicationDefender4 | PuppetAgent4 | Site24X7LinuxServerExtn4 | Site24X7WindowsServerExtn4 | Site24X7ApmInsightExtn4 | TrendMicroDSALinux4 | TrendMicroDSA4 | BmcCtmAgentLinux4 | BmcCtmAgentWindows4 | OSPatchingForLinux4 | VMSnapshot4 | VMSnapshotLinux4 | CustomScript4 | NetworkWatcherAgentWindows4 | NetworkWatcherAgentLinux4)␊ - type: "Microsoft.Compute/virtualMachineScaleSets/extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/images␊ - */␊ - export interface Images4 {␊ - apiVersion: "2018-10-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the image.␊ - */␊ - name: string␊ - /**␊ - * Describes the properties of an Image.␊ - */␊ - properties: (ImageProperties4 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/images"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the properties of an Image.␊ - */␊ - export interface ImageProperties4 {␊ - sourceVirtualMachine?: (SubResource37 | string)␊ - /**␊ - * Describes a storage profile.␊ - */␊ - storageProfile?: (ImageStorageProfile4 | string)␊ - [k: string]: unknown␊ - }␊ - export interface SubResource37 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a storage profile.␊ - */␊ - export interface ImageStorageProfile4 {␊ - /**␊ - * 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).␊ - */␊ - dataDisks?: (ImageDataDisk4[] | string)␊ - /**␊ - * Describes an Operating System disk.␊ - */␊ - osDisk?: (ImageOSDisk4 | string)␊ - /**␊ - * Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS).␊ - */␊ - zoneResilient?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a data disk.␊ - */␊ - export interface ImageDataDisk4 {␊ - /**␊ - * The Virtual Hard Disk.␊ - */␊ - blobUri?: string␊ - /**␊ - * Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**.␊ - */␊ - caching?: (("None" | "ReadOnly" | "ReadWrite") | string)␊ - /**␊ - * 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␊ - */␊ - diskSizeGB?: (number | string)␊ - /**␊ - * 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.␊ - */␊ - lun: (number | string)␊ - managedDisk?: (SubResource37 | string)␊ - snapshot?: (SubResource37 | string)␊ - /**␊ - * Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.␊ - */␊ - storageAccountType?: (("Standard_LRS" | "Premium_LRS" | "StandardSSD_LRS" | "UltraSSD_LRS") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes an Operating System disk.␊ - */␊ - export interface ImageOSDisk4 {␊ - /**␊ - * The Virtual Hard Disk.␊ - */␊ - blobUri?: string␊ - /**␊ - * Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**.␊ - */␊ - caching?: (("None" | "ReadOnly" | "ReadWrite") | string)␊ - /**␊ - * 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␊ - */␊ - diskSizeGB?: (number | string)␊ - managedDisk?: (SubResource37 | string)␊ - /**␊ - * The OS State.␊ - */␊ - osState: (("Generalized" | "Specialized") | string)␊ - /**␊ - * 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**.␊ - */␊ - osType: (("Windows" | "Linux") | string)␊ - snapshot?: (SubResource37 | string)␊ - /**␊ - * Specifies the storage account type for the managed disk. UltraSSD_LRS cannot be used with OS Disk.␊ - */␊ - storageAccountType?: (("Standard_LRS" | "Premium_LRS" | "StandardSSD_LRS" | "UltraSSD_LRS") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/availabilitySets␊ - */␊ - export interface AvailabilitySets5 {␊ - apiVersion: "2018-10-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the availability set.␊ - */␊ - name: string␊ - /**␊ - * The instance view of a resource.␊ - */␊ - properties: (AvailabilitySetProperties4 | string)␊ - /**␊ - * Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name.␊ - */␊ - sku?: (Sku55 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/availabilitySets"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The instance view of a resource.␊ - */␊ - export interface AvailabilitySetProperties4 {␊ - /**␊ - * Fault Domain count.␊ - */␊ - platformFaultDomainCount?: (number | string)␊ - /**␊ - * Update Domain count.␊ - */␊ - platformUpdateDomainCount?: (number | string)␊ - proximityPlacementGroup?: (SubResource37 | string)␊ - /**␊ - * A list of references to all virtual machines in the availability set.␊ - */␊ - virtualMachines?: (SubResource37[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name.␊ - */␊ - export interface Sku55 {␊ - /**␊ - * Specifies the number of virtual machines in the scale set.␊ - */␊ - capacity?: (number | string)␊ - /**␊ - * The sku name.␊ - */␊ - name?: string␊ - /**␊ - * Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic**␊ - */␊ - tier?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/virtualMachines␊ - */␊ - export interface VirtualMachines6 {␊ - apiVersion: "2018-10-01"␊ - /**␊ - * Identity for the virtual machine.␊ - */␊ - identity?: (VirtualMachineIdentity4 | string)␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the virtual machine.␊ - */␊ - name: string␊ - /**␊ - * 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**.␊ - */␊ - plan?: (Plan5 | string)␊ - /**␊ - * Describes the properties of a Virtual Machine.␊ - */␊ - properties: (VirtualMachineProperties11 | string)␊ - resources?: VirtualMachinesExtensionsChildResource4[]␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/virtualMachines"␊ - /**␊ - * The virtual machine zones.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the virtual machine.␊ - */␊ - export interface VirtualMachineIdentity4 {␊ - /**␊ - * The type of identity used for the virtual machine. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.␊ - */␊ - type?: (("SystemAssigned" | "UserAssigned" | "SystemAssigned, UserAssigned" | "None") | string)␊ - /**␊ - * The list of user identities associated with the Virtual Machine. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.␊ - */␊ - userAssignedIdentities?: ({␊ - [k: string]: UserAssignedIdentitiesValue1␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - export interface UserAssignedIdentitiesValue1 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * 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**.␊ - */␊ - export interface Plan5 {␊ - /**␊ - * The plan ID.␊ - */␊ - name?: string␊ - /**␊ - * Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.␊ - */␊ - product?: string␊ - /**␊ - * The promotion code.␊ - */␊ - promotionCode?: string␊ - /**␊ - * The publisher ID.␊ - */␊ - publisher?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the properties of a Virtual Machine.␊ - */␊ - export interface VirtualMachineProperties11 {␊ - /**␊ - * Enables or disables a capability on the virtual machine or virtual machine scale set.␊ - */␊ - additionalCapabilities?: (AdditionalCapabilities1 | string)␊ - availabilitySet?: (SubResource37 | string)␊ - /**␊ - * Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15.␊ - */␊ - diagnosticsProfile?: (DiagnosticsProfile4 | string)␊ - /**␊ - * Specifies the hardware settings for the virtual machine.␊ - */␊ - hardwareProfile?: (HardwareProfile5 | string)␊ - /**␊ - * 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␊ - */␊ - licenseType?: string␊ - /**␊ - * Specifies the network interfaces of the virtual machine.␊ - */␊ - networkProfile?: (NetworkProfile5 | string)␊ - /**␊ - * Specifies the operating system settings for the virtual machine.␊ - */␊ - osProfile?: (OSProfile4 | string)␊ - proximityPlacementGroup?: (SubResource37 | string)␊ - /**␊ - * Specifies the storage settings for the virtual machine disks.␊ - */␊ - storageProfile?: (StorageProfile10 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Enables or disables a capability on the virtual machine or virtual machine scale set.␊ - */␊ - export interface AdditionalCapabilities1 {␊ - /**␊ - * The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled.␊ - */␊ - ultraSSDEnabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15.␊ - */␊ - export interface DiagnosticsProfile4 {␊ - /**␊ - * Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    You can easily view the output of your console log.

    Azure also enables you to see a screenshot of the VM from the hypervisor.␊ - */␊ - bootDiagnostics?: (BootDiagnostics4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    You can easily view the output of your console log.

    Azure also enables you to see a screenshot of the VM from the hypervisor.␊ - */␊ - export interface BootDiagnostics4 {␊ - /**␊ - * Whether boot diagnostics should be enabled on the Virtual Machine.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Uri of the storage account to use for placing the console output and screenshot.␊ - */␊ - storageUri?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the hardware settings for the virtual machine.␊ - */␊ - export interface HardwareProfile5 {␊ - /**␊ - * 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](https://docs.microsoft.com/rest/api/compute/availabilitysets/listavailablesizes)

    [List all available virtual machine sizes in a region](https://docs.microsoft.com/rest/api/compute/virtualmachinesizes/list)

    [List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes).␊ - */␊ - vmSize?: (("Basic_A0" | "Basic_A1" | "Basic_A2" | "Basic_A3" | "Basic_A4" | "Standard_A0" | "Standard_A1" | "Standard_A2" | "Standard_A3" | "Standard_A4" | "Standard_A5" | "Standard_A6" | "Standard_A7" | "Standard_A8" | "Standard_A9" | "Standard_A10" | "Standard_A11" | "Standard_A1_v2" | "Standard_A2_v2" | "Standard_A4_v2" | "Standard_A8_v2" | "Standard_A2m_v2" | "Standard_A4m_v2" | "Standard_A8m_v2" | "Standard_B1s" | "Standard_B1ms" | "Standard_B2s" | "Standard_B2ms" | "Standard_B4ms" | "Standard_B8ms" | "Standard_D1" | "Standard_D2" | "Standard_D3" | "Standard_D4" | "Standard_D11" | "Standard_D12" | "Standard_D13" | "Standard_D14" | "Standard_D1_v2" | "Standard_D2_v2" | "Standard_D3_v2" | "Standard_D4_v2" | "Standard_D5_v2" | "Standard_D2_v3" | "Standard_D4_v3" | "Standard_D8_v3" | "Standard_D16_v3" | "Standard_D32_v3" | "Standard_D64_v3" | "Standard_D2s_v3" | "Standard_D4s_v3" | "Standard_D8s_v3" | "Standard_D16s_v3" | "Standard_D32s_v3" | "Standard_D64s_v3" | "Standard_D11_v2" | "Standard_D12_v2" | "Standard_D13_v2" | "Standard_D14_v2" | "Standard_D15_v2" | "Standard_DS1" | "Standard_DS2" | "Standard_DS3" | "Standard_DS4" | "Standard_DS11" | "Standard_DS12" | "Standard_DS13" | "Standard_DS14" | "Standard_DS1_v2" | "Standard_DS2_v2" | "Standard_DS3_v2" | "Standard_DS4_v2" | "Standard_DS5_v2" | "Standard_DS11_v2" | "Standard_DS12_v2" | "Standard_DS13_v2" | "Standard_DS14_v2" | "Standard_DS15_v2" | "Standard_DS13-4_v2" | "Standard_DS13-2_v2" | "Standard_DS14-8_v2" | "Standard_DS14-4_v2" | "Standard_E2_v3" | "Standard_E4_v3" | "Standard_E8_v3" | "Standard_E16_v3" | "Standard_E32_v3" | "Standard_E64_v3" | "Standard_E2s_v3" | "Standard_E4s_v3" | "Standard_E8s_v3" | "Standard_E16s_v3" | "Standard_E32s_v3" | "Standard_E64s_v3" | "Standard_E32-16_v3" | "Standard_E32-8s_v3" | "Standard_E64-32s_v3" | "Standard_E64-16s_v3" | "Standard_F1" | "Standard_F2" | "Standard_F4" | "Standard_F8" | "Standard_F16" | "Standard_F1s" | "Standard_F2s" | "Standard_F4s" | "Standard_F8s" | "Standard_F16s" | "Standard_F2s_v2" | "Standard_F4s_v2" | "Standard_F8s_v2" | "Standard_F16s_v2" | "Standard_F32s_v2" | "Standard_F64s_v2" | "Standard_F72s_v2" | "Standard_G1" | "Standard_G2" | "Standard_G3" | "Standard_G4" | "Standard_G5" | "Standard_GS1" | "Standard_GS2" | "Standard_GS3" | "Standard_GS4" | "Standard_GS5" | "Standard_GS4-8" | "Standard_GS4-4" | "Standard_GS5-16" | "Standard_GS5-8" | "Standard_H8" | "Standard_H16" | "Standard_H8m" | "Standard_H16m" | "Standard_H16r" | "Standard_H16mr" | "Standard_L4s" | "Standard_L8s" | "Standard_L16s" | "Standard_L32s" | "Standard_M64s" | "Standard_M64ms" | "Standard_M128s" | "Standard_M128ms" | "Standard_M64-32ms" | "Standard_M64-16ms" | "Standard_M128-64ms" | "Standard_M128-32ms" | "Standard_NC6" | "Standard_NC12" | "Standard_NC24" | "Standard_NC24r" | "Standard_NC6s_v2" | "Standard_NC12s_v2" | "Standard_NC24s_v2" | "Standard_NC24rs_v2" | "Standard_NC6s_v3" | "Standard_NC12s_v3" | "Standard_NC24s_v3" | "Standard_NC24rs_v3" | "Standard_ND6s" | "Standard_ND12s" | "Standard_ND24s" | "Standard_ND24rs" | "Standard_NV6" | "Standard_NV12" | "Standard_NV24") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the network interfaces of the virtual machine.␊ - */␊ - export interface NetworkProfile5 {␊ - /**␊ - * Specifies the list of resource Ids for the network interfaces associated with the virtual machine.␊ - */␊ - networkInterfaces?: (NetworkInterfaceReference4[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a network interface reference.␊ - */␊ - export interface NetworkInterfaceReference4 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Describes a network interface reference properties.␊ - */␊ - properties?: (NetworkInterfaceReferenceProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a network interface reference properties.␊ - */␊ - export interface NetworkInterfaceReferenceProperties4 {␊ - /**␊ - * Specifies the primary network interface in case the virtual machine has more than 1 network interface.␊ - */␊ - primary?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the operating system settings for the virtual machine.␊ - */␊ - export interface OSProfile4 {␊ - /**␊ - * 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)␊ - */␊ - adminPassword?: string␊ - /**␊ - * 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)␊ - */␊ - adminUsername?: string␊ - /**␊ - * Specifies whether extension operations should be allowed on the virtual machine.

    This may only be set to False when no extensions are present on the virtual machine.␊ - */␊ - allowExtensionOperations?: (boolean | string)␊ - /**␊ - * Specifies the host OS name of the virtual machine.

    This name cannot be updated after the VM is created.

    **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).␊ - */␊ - computerName?: string␊ - /**␊ - * 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)␊ - */␊ - customData?: string␊ - /**␊ - * 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).␊ - */␊ - linuxConfiguration?: (LinuxConfiguration5 | string)␊ - /**␊ - * Specifies set of certificates that should be installed onto the virtual machine.␊ - */␊ - secrets?: (VaultSecretGroup4[] | string)␊ - /**␊ - * Specifies Windows operating system settings on the virtual machine.␊ - */␊ - windowsConfiguration?: (WindowsConfiguration6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * 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).␊ - */␊ - export interface LinuxConfiguration5 {␊ - /**␊ - * Specifies whether password authentication should be disabled.␊ - */␊ - disablePasswordAuthentication?: (boolean | string)␊ - /**␊ - * 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.␊ - */␊ - provisionVMAgent?: (boolean | string)␊ - /**␊ - * SSH configuration for Linux based VMs running on Azure␊ - */␊ - ssh?: (SshConfiguration5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSH configuration for Linux based VMs running on Azure␊ - */␊ - export interface SshConfiguration5 {␊ - /**␊ - * The list of SSH public keys used to authenticate with linux based VMs.␊ - */␊ - publicKeys?: (SshPublicKey4[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed.␊ - */␊ - export interface SshPublicKey4 {␊ - /**␊ - * 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).␊ - */␊ - keyData?: string␊ - /**␊ - * 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␊ - */␊ - path?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a set of certificates which are all in the same Key Vault.␊ - */␊ - export interface VaultSecretGroup4 {␊ - sourceVault?: (SubResource37 | string)␊ - /**␊ - * The list of key vault references in SourceVault which contain certificates.␊ - */␊ - vaultCertificates?: (VaultCertificate4[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM.␊ - */␊ - export interface VaultCertificate4 {␊ - /**␊ - * 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 <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted.␊ - */␊ - certificateStore?: string␊ - /**␊ - * 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":""
    }␊ - */␊ - certificateUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies Windows operating system settings on the virtual machine.␊ - */␊ - export interface WindowsConfiguration6 {␊ - /**␊ - * Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup.␊ - */␊ - additionalUnattendContent?: (AdditionalUnattendContent5[] | string)␊ - /**␊ - * Indicates whether virtual machine is enabled for automatic Windows updates. Default value is true.

    For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning.␊ - */␊ - enableAutomaticUpdates?: (boolean | string)␊ - /**␊ - * 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.␊ - */␊ - provisionVMAgent?: (boolean | string)␊ - /**␊ - * Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time"␊ - */␊ - timeZone?: string␊ - /**␊ - * Describes Windows Remote Management configuration of the VM␊ - */␊ - winRM?: (WinRMConfiguration4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * 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.␊ - */␊ - export interface AdditionalUnattendContent5 {␊ - /**␊ - * The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup.␊ - */␊ - componentName?: ("Microsoft-Windows-Shell-Setup" | string)␊ - /**␊ - * 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.␊ - */␊ - content?: string␊ - /**␊ - * The pass name. Currently, the only allowable value is OobeSystem.␊ - */␊ - passName?: ("OobeSystem" | string)␊ - /**␊ - * Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.␊ - */␊ - settingName?: (("AutoLogon" | "FirstLogonCommands") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes Windows Remote Management configuration of the VM␊ - */␊ - export interface WinRMConfiguration4 {␊ - /**␊ - * The list of Windows Remote Management listeners␊ - */␊ - listeners?: (WinRMListener5[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes Protocol and thumbprint of Windows Remote Management listener␊ - */␊ - export interface WinRMListener5 {␊ - /**␊ - * 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":""
    }␊ - */␊ - certificateUrl?: string␊ - /**␊ - * Specifies the protocol of listener.

    Possible values are:
    **http**

    **https**.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the storage settings for the virtual machine disks.␊ - */␊ - export interface StorageProfile10 {␊ - /**␊ - * 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).␊ - */␊ - dataDisks?: (DataDisk6[] | string)␊ - /**␊ - * 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. NOTE: Image reference publisher and offer can only be set when you create the scale set.␊ - */␊ - imageReference?: (ImageReference7 | string)␊ - /**␊ - * 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).␊ - */␊ - osDisk?: (OSDisk5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a data disk.␊ - */␊ - export interface DataDisk6 {␊ - /**␊ - * Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**.␊ - */␊ - caching?: (("None" | "ReadOnly" | "ReadWrite") | string)␊ - /**␊ - * 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.␊ - */␊ - createOption: (("FromImage" | "Empty" | "Attach") | string)␊ - /**␊ - * Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB␊ - */␊ - diskSizeGB?: (number | string)␊ - /**␊ - * Describes the uri of a disk.␊ - */␊ - image?: (VirtualHardDisk4 | string)␊ - /**␊ - * 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.␊ - */␊ - lun: (number | string)␊ - /**␊ - * The parameters of a managed disk.␊ - */␊ - managedDisk?: (ManagedDiskParameters4 | string)␊ - /**␊ - * The disk name.␊ - */␊ - name?: string␊ - /**␊ - * Describes the uri of a disk.␊ - */␊ - vhd?: (VirtualHardDisk4 | string)␊ - /**␊ - * Specifies whether writeAccelerator should be enabled or disabled on the disk.␊ - */␊ - writeAcceleratorEnabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the uri of a disk.␊ - */␊ - export interface VirtualHardDisk4 {␊ - /**␊ - * Specifies the virtual hard disk's uri.␊ - */␊ - uri?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The parameters of a managed disk.␊ - */␊ - export interface ManagedDiskParameters4 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.␊ - */␊ - storageAccountType?: (("Standard_LRS" | "Premium_LRS" | "StandardSSD_LRS" | "UltraSSD_LRS") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * 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. NOTE: Image reference publisher and offer can only be set when you create the scale set.␊ - */␊ - export interface ImageReference7 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Specifies the offer of the platform image or marketplace image used to create the virtual machine.␊ - */␊ - offer?: string␊ - /**␊ - * The image publisher.␊ - */␊ - publisher?: string␊ - /**␊ - * The image SKU.␊ - */␊ - sku?: string␊ - /**␊ - * 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.␊ - */␊ - version?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * 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).␊ - */␊ - export interface OSDisk5 {␊ - /**␊ - * Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**.␊ - */␊ - caching?: (("None" | "ReadOnly" | "ReadWrite") | string)␊ - /**␊ - * 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.␊ - */␊ - createOption: (("FromImage" | "Empty" | "Attach") | string)␊ - /**␊ - * Describes the parameters of ephemeral disk settings that can be specified for operating system disk.

    NOTE: The ephemeral disk settings can only be specified for managed disk.␊ - */␊ - diffDiskSettings?: (DiffDiskSettings1 | string)␊ - /**␊ - * Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB␊ - */␊ - diskSizeGB?: (number | string)␊ - /**␊ - * Describes a Encryption Settings for a Disk␊ - */␊ - encryptionSettings?: (DiskEncryptionSettings4 | string)␊ - /**␊ - * Describes the uri of a disk.␊ - */␊ - image?: (VirtualHardDisk4 | string)␊ - /**␊ - * The parameters of a managed disk.␊ - */␊ - managedDisk?: (ManagedDiskParameters4 | string)␊ - /**␊ - * The disk name.␊ - */␊ - name?: string␊ - /**␊ - * 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**.␊ - */␊ - osType?: (("Windows" | "Linux") | string)␊ - /**␊ - * Describes the uri of a disk.␊ - */␊ - vhd?: (VirtualHardDisk4 | string)␊ - /**␊ - * Specifies whether writeAccelerator should be enabled or disabled on the disk.␊ - */␊ - writeAcceleratorEnabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the parameters of ephemeral disk settings that can be specified for operating system disk.

    NOTE: The ephemeral disk settings can only be specified for managed disk.␊ - */␊ - export interface DiffDiskSettings1 {␊ - /**␊ - * Specifies the ephemeral disk settings for operating system disk.␊ - */␊ - option?: ("Local" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a Encryption Settings for a Disk␊ - */␊ - export interface DiskEncryptionSettings4 {␊ - /**␊ - * Describes a reference to Key Vault Secret␊ - */␊ - diskEncryptionKey?: (KeyVaultSecretReference5 | string)␊ - /**␊ - * Specifies whether disk encryption should be enabled on the virtual machine.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Describes a reference to Key Vault Key␊ - */␊ - keyEncryptionKey?: (KeyVaultKeyReference4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a reference to Key Vault Secret␊ - */␊ - export interface KeyVaultSecretReference5 {␊ - /**␊ - * The URL referencing a secret in a Key Vault.␊ - */␊ - secretUrl: string␊ - sourceVault: (SubResource37 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a reference to Key Vault Key␊ - */␊ - export interface KeyVaultKeyReference4 {␊ - /**␊ - * The URL referencing a key encryption key in Key Vault.␊ - */␊ - keyUrl: string␊ - sourceVault: (SubResource37 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/virtualMachines/extensions␊ - */␊ - export interface VirtualMachinesExtensionsChildResource4 {␊ - apiVersion: "2018-10-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the virtual machine extension.␊ - */␊ - name: string␊ - properties: (GenericExtension5 | IaaSDiagnostics5 | IaaSAntimalware5 | CustomScriptExtension5 | CustomScriptForLinux5 | LinuxDiagnostic5 | VmAccessForLinux5 | BgInfo5 | VmAccessAgent5 | DscExtension5 | AcronisBackupLinux5 | AcronisBackup5 | LinuxChefClient5 | ChefClient5 | DatadogLinuxAgent5 | DatadogWindowsAgent5 | DockerExtension5 | DynatraceLinux5 | DynatraceWindows5 | Eset5 | HpeSecurityApplicationDefender5 | PuppetAgent5 | Site24X7LinuxServerExtn5 | Site24X7WindowsServerExtn5 | Site24X7ApmInsightExtn5 | TrendMicroDSALinux5 | TrendMicroDSA5 | BmcCtmAgentLinux5 | BmcCtmAgentWindows5 | OSPatchingForLinux5 | VMSnapshot5 | VMSnapshotLinux5 | CustomScript5 | NetworkWatcherAgentWindows5 | NetworkWatcherAgentLinux5)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "extensions"␊ - [k: string]: unknown␊ - }␊ - export interface GenericExtension5 {␊ - /**␊ - * Microsoft.Compute/extensions - Publisher␊ - */␊ - publisher: string␊ - /**␊ - * Microsoft.Compute/extensions - Type␊ - */␊ - type: string␊ - /**␊ - * Microsoft.Compute/extensions - Type handler version␊ - */␊ - typeHandlerVersion: string␊ - /**␊ - * Microsoft.Compute/extensions - Settings␊ - */␊ - settings: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - export interface IaaSDiagnostics5 {␊ - publisher: "Microsoft.Azure.Diagnostics"␊ - type: "IaaSDiagnostics"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - xmlCfg: string␊ - StorageAccount: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - storageAccountName: string␊ - storageAccountKey: string␊ - storageAccountEndPoint: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface IaaSAntimalware5 {␊ - publisher: "Microsoft.Azure.Security"␊ - type: "IaaSAntimalware"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - AntimalwareEnabled: boolean␊ - Exclusions: {␊ - Paths: string␊ - Extensions: string␊ - Processes: string␊ - [k: string]: unknown␊ - }␊ - RealtimeProtectionEnabled: ("true" | "false")␊ - ScheduledScanSettings: {␊ - isEnabled: ("true" | "false")␊ - scanType: string␊ - day: string␊ - time: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface CustomScriptExtension5 {␊ - publisher: "Microsoft.Compute"␊ - type: "CustomScriptExtension"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - fileUris?: string[]␊ - commandToExecute: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - storageAccountName?: string␊ - storageAccountKey?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface CustomScriptForLinux5 {␊ - publisher: "Microsoft.OSTCExtensions"␊ - type: "CustomScriptForLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - fileUris?: string[]␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - commandToExecute: string␊ - storageAccountName?: string␊ - storageAccountKey?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface LinuxDiagnostic5 {␊ - publisher: "Microsoft.OSTCExtensions"␊ - type: "LinuxDiagnostic"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - enableSyslog?: string␊ - mdsdHttpProxy?: string␊ - perCfg?: unknown[]␊ - fileCfg?: unknown[]␊ - xmlCfg?: string␊ - ladCfg?: {␊ - [k: string]: unknown␊ - }␊ - syslogCfg?: string␊ - eventVolume?: string␊ - mdsdCfg?: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - mdsdHttpProxy?: string␊ - storageAccountName: string␊ - storageAccountKey: string␊ - storageAccountEndPoint?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface VmAccessForLinux5 {␊ - publisher: "Microsoft.OSTCExtensions"␊ - type: "VMAccessForLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - check_disk?: boolean␊ - repair_disk?: boolean␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - username: string␊ - password: string␊ - ssh_key: string␊ - reset_ssh: string␊ - remove_user: string␊ - expiration: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface BgInfo5 {␊ - publisher: "Microsoft.Compute"␊ - type: "bginfo"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - [k: string]: unknown␊ - }␊ - export interface VmAccessAgent5 {␊ - publisher: "Microsoft.Compute"␊ - type: "VMAccessAgent"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - username?: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - password?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface DscExtension5 {␊ - publisher: "Microsoft.Powershell"␊ - type: "DSC"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - modulesUrl: string␊ - configurationFunction: string␊ - properties?: string␊ - wmfVersion?: string␊ - privacy?: {␊ - dataCollection?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - dataBlobUri?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface AcronisBackupLinux5 {␊ - publisher: "Acronis.Backup"␊ - type: "AcronisBackupLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - absURL: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - userLogin: string␊ - userPassword: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface AcronisBackup5 {␊ - publisher: "Acronis.Backup"␊ - type: "AcronisBackup"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - absURL: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - userLogin: string␊ - userPassword: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface LinuxChefClient5 {␊ - publisher: "Chef.Bootstrap.WindowsAzure"␊ - type: "LinuxChefClient"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - bootstrap_version?: string␊ - bootstrap_options?: {␊ - chef_node_name: string␊ - chef_server_url: string␊ - validation_client_name: string␊ - node_ssl_verify_mode: string␊ - environment: string␊ - [k: string]: unknown␊ - }␊ - runlist?: string␊ - client_rb?: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - validation_key: string␊ - chef_server_crt: string␊ - secret: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface ChefClient5 {␊ - publisher: "Chef.Bootstrap.WindowsAzure"␊ - type: "ChefClient"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - bootstrap_options?: {␊ - chef_node_name: string␊ - chef_server_url: string␊ - validation_client_name: string␊ - node_ssl_verify_mode: string␊ - environment: string␊ - [k: string]: unknown␊ - }␊ - runlist?: string␊ - client_rb?: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - validation_key: string␊ - chef_server_crt: string␊ - secret: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface DatadogLinuxAgent5 {␊ - publisher: "Datadog.Agent"␊ - type: "DatadogLinuxAgent"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - api_key: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface DatadogWindowsAgent5 {␊ - publisher: "Datadog.Agent"␊ - type: "DatadogWindowsAgent"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - api_key: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface DockerExtension5 {␊ - publisher: "Microsoft.Azure.Extensions"␊ - type: "DockerExtension"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - docker: {␊ - port: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - certs: {␊ - ca: string␊ - cert: string␊ - key: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface DynatraceLinux5 {␊ - publisher: "dynatrace.ruxit"␊ - type: "ruxitAgentLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - tenantId: string␊ - token: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface DynatraceWindows5 {␊ - publisher: "dynatrace.ruxit"␊ - type: "ruxitAgentWindows"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - tenantId: string␊ - token: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Eset5 {␊ - publisher: "ESET"␊ - type: "FileSecurity"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - LicenseKey: string␊ - "Install-RealtimeProtection": boolean␊ - "Install-ProtocolFiltering": boolean␊ - "Install-DeviceControl": boolean␊ - "Enable-Cloud": boolean␊ - "Enable-PUA": boolean␊ - ERAAgentCfgUrl: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface HpeSecurityApplicationDefender5 {␊ - publisher: "HPE.Security.ApplicationDefender"␊ - type: "DotnetAgent"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - protectedSettings: {␊ - key: string␊ - serverURL: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface PuppetAgent5 {␊ - publisher: "Puppet"␊ - type: "PuppetAgent"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - protectedSettings: {␊ - PUPPET_MASTER_SERVER: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Site24X7LinuxServerExtn5 {␊ - publisher: "Site24x7"␊ - type: "Site24x7LinuxServerExtn"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - site24x7AgentType?: "azurevmextnlinuxserver"␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - site24x7LicenseKey: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Site24X7WindowsServerExtn5 {␊ - publisher: "Site24x7"␊ - type: "Site24x7WindowsServerExtn"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - site24x7AgentType?: "azurevmextnwindowsserver"␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - site24x7LicenseKey: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Site24X7ApmInsightExtn5 {␊ - publisher: "Site24x7"␊ - type: "Site24x7ApmInsightExtn"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - site24x7AgentType?: "azurevmextnapminsightclassic"␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - site24x7LicenseKey: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface TrendMicroDSALinux5 {␊ - publisher: "TrendMicro.DeepSecurity"␊ - type: "TrendMicroDSALinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - DSMname: string␊ - DSMport: string␊ - policyNameorID?: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - tenantID: string␊ - tenantPassword: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface TrendMicroDSA5 {␊ - publisher: "TrendMicro.DeepSecurity"␊ - type: "TrendMicroDSA"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - DSMname: string␊ - DSMport: string␊ - policyNameorID?: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - tenantID: string␊ - tenantPassword: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface BmcCtmAgentLinux5 {␊ - publisher: "ctm.bmc.com"␊ - type: "BmcCtmAgentLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - "Control-M Server Name": string␊ - "Agent Port": string␊ - "Host Group": string␊ - "User Account": string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface BmcCtmAgentWindows5 {␊ - publisher: "bmc.ctm"␊ - type: "AgentWinExt"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - "Control-M Server Name": string␊ - "Agent Port": string␊ - "Host Group": string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface OSPatchingForLinux5 {␊ - publisher: "Microsoft.OSTCExtensions"␊ - type: "OSPatchingForLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - disabled: boolean␊ - stop: boolean␊ - installDuration?: string␊ - intervalOfWeeks?: number␊ - dayOfWeek?: string␊ - startTime?: string␊ - rebootAfterPatch?: string␊ - category?: string␊ - oneoff?: boolean␊ - local?: boolean␊ - idleTestScript?: string␊ - healthyTestScript?: string␊ - distUpgradeList?: string␊ - distUpgradeAll?: boolean␊ - vmStatusTest?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - storageAccountName?: string␊ - storageAccountKey?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface VMSnapshot5 {␊ - publisher: "Microsoft.Azure.RecoveryServices"␊ - type: "VMSnapshot"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - locale: string␊ - taskId: string␊ - commandToExecute: string␊ - objectStr: string␊ - logsBlobUri: string␊ - statusBlobUri: string␊ - commandStartTimeUTCTicks: string␊ - vmType: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface VMSnapshotLinux5 {␊ - publisher: "Microsoft.Azure.RecoveryServices"␊ - type: "VMSnapshotLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - locale: string␊ - taskId: string␊ - commandToExecute: string␊ - objectStr: string␊ - logsBlobUri: string␊ - statusBlobUri: string␊ - commandStartTimeUTCTicks: string␊ - vmType: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface CustomScript5 {␊ - publisher: "Microsoft.Azure.Extensions"␊ - type: "CustomScript"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - fileUris: string[]␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - storageAccountName: string␊ - storageAccountKey: string␊ - commandToExecute: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface NetworkWatcherAgentWindows5 {␊ - publisher: "Microsoft.Azure.NetworkWatcher"␊ - type: "NetworkWatcherAgentWindows"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - [k: string]: unknown␊ - }␊ - export interface NetworkWatcherAgentLinux5 {␊ - publisher: "Microsoft.Azure.NetworkWatcher"␊ - type: "NetworkWatcherAgentLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/virtualMachineScaleSets␊ - */␊ - export interface VirtualMachineScaleSets5 {␊ - apiVersion: "2018-10-01"␊ - /**␊ - * Identity for the virtual machine scale set.␊ - */␊ - identity?: (VirtualMachineScaleSetIdentity4 | string)␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the VM scale set to create or update.␊ - */␊ - name: string␊ - /**␊ - * 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**.␊ - */␊ - plan?: (Plan5 | string)␊ - /**␊ - * Describes the properties of a Virtual Machine Scale Set.␊ - */␊ - properties: (VirtualMachineScaleSetProperties4 | string)␊ - resources?: (VirtualMachineScaleSetsExtensionsChildResource3 | VirtualMachineScaleSetsVirtualmachinesChildResource2)[]␊ - /**␊ - * Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name.␊ - */␊ - sku?: (Sku55 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/virtualMachineScaleSets"␊ - /**␊ - * The virtual machine scale set zones. NOTE: Availability zones can only be set when you create the scale set.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the virtual machine scale set.␊ - */␊ - export interface VirtualMachineScaleSetIdentity4 {␊ - /**␊ - * The type of identity used for the virtual machine scale set. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine scale set.␊ - */␊ - type?: (("SystemAssigned" | "UserAssigned" | "SystemAssigned, UserAssigned" | "None") | string)␊ - /**␊ - * The list of user identities associated with the virtual machine scale set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.␊ - */␊ - userAssignedIdentities?: ({␊ - [k: string]: VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue1␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - export interface VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue1 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the properties of a Virtual Machine Scale Set.␊ - */␊ - export interface VirtualMachineScaleSetProperties4 {␊ - /**␊ - * Specifies the configuration parameters for automatic repairs on the virtual machine scale set.␊ - */␊ - automaticRepairsPolicy?: (AutomaticRepairsPolicy | string)␊ - /**␊ - * When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs.␊ - */␊ - doNotRunExtensionsOnOverprovisionedVMs?: (boolean | string)␊ - /**␊ - * Specifies whether the Virtual Machine Scale Set should be overprovisioned.␊ - */␊ - overprovision?: (boolean | string)␊ - /**␊ - * Fault Domain count for each placement group.␊ - */␊ - platformFaultDomainCount?: (number | string)␊ - proximityPlacementGroup?: (SubResource37 | string)␊ - /**␊ - * When true this limits the scale set to a single placement group, of max size 100 virtual machines.␊ - */␊ - singlePlacementGroup?: (boolean | string)␊ - /**␊ - * Describes an upgrade policy - automatic, manual, or rolling.␊ - */␊ - upgradePolicy?: (UpgradePolicy5 | string)␊ - /**␊ - * Describes a virtual machine scale set virtual machine profile.␊ - */␊ - virtualMachineProfile?: (VirtualMachineScaleSetVMProfile4 | string)␊ - /**␊ - * Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage.␊ - */␊ - zoneBalance?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the configuration parameters for automatic repairs on the virtual machine scale set.␊ - */␊ - export interface AutomaticRepairsPolicy {␊ - /**␊ - * Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * The amount of time for which automatic repairs are suspended due to a state change on VM. The grace time starts after the state change has completed. This helps avoid premature or accidental repairs. The time duration should be specified in ISO 8601 format. The minimum allowed grace period is 30 minutes (PT30M), which is also the default value. The maximum allowed grace period is 90 minutes (PT90M).␊ - */␊ - gracePeriod?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes an upgrade policy - automatic, manual, or rolling.␊ - */␊ - export interface UpgradePolicy5 {␊ - /**␊ - * The configuration parameters used for performing automatic OS upgrade.␊ - */␊ - automaticOSUpgradePolicy?: (AutomaticOSUpgradePolicy | string)␊ - /**␊ - * 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.␊ - */␊ - mode?: (("Automatic" | "Manual" | "Rolling") | string)␊ - /**␊ - * The configuration parameters used while performing a rolling upgrade.␊ - */␊ - rollingUpgradePolicy?: (RollingUpgradePolicy3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The configuration parameters used for performing automatic OS upgrade.␊ - */␊ - export interface AutomaticOSUpgradePolicy {␊ - /**␊ - * Whether OS image rollback feature should be disabled. Default value is false.␊ - */␊ - disableAutomaticRollback?: (boolean | string)␊ - /**␊ - * Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. Default value is false. If this is set to true for Windows based scale sets, recommendation is to set [enableAutomaticUpdates](https://docs.microsoft.com/dotnet/api/microsoft.azure.management.compute.models.windowsconfiguration.enableautomaticupdates?view=azure-dotnet) to false.␊ - */␊ - enableAutomaticOSUpgrade?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The configuration parameters used while performing a rolling upgrade.␊ - */␊ - export interface RollingUpgradePolicy3 {␊ - /**␊ - * 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%.␊ - */␊ - maxBatchInstancePercent?: (number | string)␊ - /**␊ - * 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%.␊ - */␊ - maxUnhealthyInstancePercent?: (number | string)␊ - /**␊ - * 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%.␊ - */␊ - maxUnhealthyUpgradedInstancePercent?: (number | string)␊ - /**␊ - * 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).␊ - */␊ - pauseTimeBetweenBatches?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set virtual machine profile.␊ - */␊ - export interface VirtualMachineScaleSetVMProfile4 {␊ - /**␊ - * Enables or disables a capability on the virtual machine or virtual machine scale set.␊ - */␊ - additionalCapabilities?: (AdditionalCapabilities1 | string)␊ - /**␊ - * Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15.␊ - */␊ - diagnosticsProfile?: (DiagnosticsProfile4 | string)␊ - /**␊ - * Specifies the eviction policy for virtual machines in a low priority scale set.

    Minimum api-version: 2017-10-30-preview.␊ - */␊ - evictionPolicy?: (("Deallocate" | "Delete") | string)␊ - /**␊ - * Describes a virtual machine scale set extension profile.␊ - */␊ - extensionProfile?: (VirtualMachineScaleSetExtensionProfile5 | string)␊ - /**␊ - * 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␊ - */␊ - licenseType?: string␊ - /**␊ - * Describes a virtual machine scale set network profile.␊ - */␊ - networkProfile?: (VirtualMachineScaleSetNetworkProfile5 | string)␊ - /**␊ - * Describes a virtual machine scale set OS profile.␊ - */␊ - osProfile?: (VirtualMachineScaleSetOSProfile4 | string)␊ - /**␊ - * Specifies the priority for the virtual machines in the scale set.

    Minimum api-version: 2017-10-30-preview.␊ - */␊ - priority?: (("Regular" | "Low") | string)␊ - /**␊ - * Describes a virtual machine scale set storage profile.␊ - */␊ - storageProfile?: (VirtualMachineScaleSetStorageProfile5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set extension profile.␊ - */␊ - export interface VirtualMachineScaleSetExtensionProfile5 {␊ - /**␊ - * The virtual machine scale set child extension resources.␊ - */␊ - extensions?: (VirtualMachineScaleSetExtension5[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a Virtual Machine Scale Set Extension.␊ - */␊ - export interface VirtualMachineScaleSetExtension5 {␊ - /**␊ - * The name of the extension.␊ - */␊ - name?: string␊ - properties?: (GenericExtension5 | IaaSDiagnostics5 | IaaSAntimalware5 | CustomScriptExtension5 | CustomScriptForLinux5 | LinuxDiagnostic5 | VmAccessForLinux5 | BgInfo5 | VmAccessAgent5 | DscExtension5 | AcronisBackupLinux5 | AcronisBackup5 | LinuxChefClient5 | ChefClient5 | DatadogLinuxAgent5 | DatadogWindowsAgent5 | DockerExtension5 | DynatraceLinux5 | DynatraceWindows5 | Eset5 | HpeSecurityApplicationDefender5 | PuppetAgent5 | Site24X7LinuxServerExtn5 | Site24X7WindowsServerExtn5 | Site24X7ApmInsightExtn5 | TrendMicroDSALinux5 | TrendMicroDSA5 | BmcCtmAgentLinux5 | BmcCtmAgentWindows5 | OSPatchingForLinux5 | VMSnapshot5 | VMSnapshotLinux5 | CustomScript5 | NetworkWatcherAgentWindows5 | NetworkWatcherAgentLinux5)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set network profile.␊ - */␊ - export interface VirtualMachineScaleSetNetworkProfile5 {␊ - /**␊ - * The API entity reference.␊ - */␊ - healthProbe?: (ApiEntityReference4 | string)␊ - /**␊ - * The list of network configurations.␊ - */␊ - networkInterfaceConfigurations?: (VirtualMachineScaleSetNetworkConfiguration4[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The API entity reference.␊ - */␊ - export interface ApiEntityReference4 {␊ - /**␊ - * The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set network profile's network configurations.␊ - */␊ - export interface VirtualMachineScaleSetNetworkConfiguration4 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * The network configuration name.␊ - */␊ - name: string␊ - /**␊ - * Describes a virtual machine scale set network profile's IP configuration.␊ - */␊ - properties?: (VirtualMachineScaleSetNetworkConfigurationProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set network profile's IP configuration.␊ - */␊ - export interface VirtualMachineScaleSetNetworkConfigurationProperties4 {␊ - /**␊ - * Describes a virtual machines scale sets network configuration's DNS settings.␊ - */␊ - dnsSettings?: (VirtualMachineScaleSetNetworkConfigurationDnsSettings3 | string)␊ - /**␊ - * Specifies whether the network interface is accelerated networking-enabled.␊ - */␊ - enableAcceleratedNetworking?: (boolean | string)␊ - /**␊ - * Whether IP forwarding enabled on this NIC.␊ - */␊ - enableIPForwarding?: (boolean | string)␊ - /**␊ - * Specifies the IP configurations of the network interface.␊ - */␊ - ipConfigurations: (VirtualMachineScaleSetIPConfiguration4[] | string)␊ - networkSecurityGroup?: (SubResource37 | string)␊ - /**␊ - * Specifies the primary network interface in case the virtual machine has more than 1 network interface.␊ - */␊ - primary?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machines scale sets network configuration's DNS settings.␊ - */␊ - export interface VirtualMachineScaleSetNetworkConfigurationDnsSettings3 {␊ - /**␊ - * List of DNS servers IP addresses␊ - */␊ - dnsServers?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set network profile's IP configuration.␊ - */␊ - export interface VirtualMachineScaleSetIPConfiguration4 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * The IP configuration name.␊ - */␊ - name: string␊ - /**␊ - * Describes a virtual machine scale set network profile's IP configuration properties.␊ - */␊ - properties?: (VirtualMachineScaleSetIPConfigurationProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set network profile's IP configuration properties.␊ - */␊ - export interface VirtualMachineScaleSetIPConfigurationProperties4 {␊ - /**␊ - * 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.␊ - */␊ - applicationGatewayBackendAddressPools?: (SubResource37[] | string)␊ - /**␊ - * Specifies an array of references to application security group.␊ - */␊ - applicationSecurityGroups?: (SubResource37[] | string)␊ - /**␊ - * 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.␊ - */␊ - loadBalancerBackendAddressPools?: (SubResource37[] | string)␊ - /**␊ - * 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␊ - */␊ - loadBalancerInboundNatPools?: (SubResource37[] | string)␊ - /**␊ - * Specifies the primary network interface in case the virtual machine has more than 1 network interface.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * 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'.␊ - */␊ - privateIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration␊ - */␊ - publicIPAddressConfiguration?: (VirtualMachineScaleSetPublicIPAddressConfiguration3 | string)␊ - /**␊ - * The API entity reference.␊ - */␊ - subnet?: (ApiEntityReference4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration␊ - */␊ - export interface VirtualMachineScaleSetPublicIPAddressConfiguration3 {␊ - /**␊ - * The publicIP address configuration name.␊ - */␊ - name: string␊ - /**␊ - * Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration␊ - */␊ - properties?: (VirtualMachineScaleSetPublicIPAddressConfigurationProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration␊ - */␊ - export interface VirtualMachineScaleSetPublicIPAddressConfigurationProperties3 {␊ - /**␊ - * Describes a virtual machines scale sets network configuration's DNS settings.␊ - */␊ - dnsSettings?: (VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings3 | string)␊ - /**␊ - * The idle timeout of the public IP address.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * The list of IP tags associated with the public IP address.␊ - */␊ - ipTags?: (VirtualMachineScaleSetIpTag1[] | string)␊ - publicIPPrefix?: (SubResource37 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machines scale sets network configuration's DNS settings.␊ - */␊ - export interface VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings3 {␊ - /**␊ - * 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␊ - */␊ - domainNameLabel: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains the IP tag associated with the public IP address.␊ - */␊ - export interface VirtualMachineScaleSetIpTag1 {␊ - /**␊ - * IP tag type. Example: FirstPartyUsage.␊ - */␊ - ipTagType?: string␊ - /**␊ - * IP tag associated with the public IP. Example: SQL, Storage etc.␊ - */␊ - tag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set OS profile.␊ - */␊ - export interface VirtualMachineScaleSetOSProfile4 {␊ - /**␊ - * 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)␊ - */␊ - adminPassword?: string␊ - /**␊ - * 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)␊ - */␊ - adminUsername?: string␊ - /**␊ - * 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.␊ - */␊ - computerNamePrefix?: string␊ - /**␊ - * 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)␊ - */␊ - customData?: string␊ - /**␊ - * 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).␊ - */␊ - linuxConfiguration?: (LinuxConfiguration5 | string)␊ - /**␊ - * Specifies set of certificates that should be installed onto the virtual machines in the scale set.␊ - */␊ - secrets?: (VaultSecretGroup4[] | string)␊ - /**␊ - * Specifies Windows operating system settings on the virtual machine.␊ - */␊ - windowsConfiguration?: (WindowsConfiguration6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set storage profile.␊ - */␊ - export interface VirtualMachineScaleSetStorageProfile5 {␊ - /**␊ - * 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).␊ - */␊ - dataDisks?: (VirtualMachineScaleSetDataDisk4[] | string)␊ - /**␊ - * 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. NOTE: Image reference publisher and offer can only be set when you create the scale set.␊ - */␊ - imageReference?: (ImageReference7 | string)␊ - /**␊ - * Describes a virtual machine scale set operating system disk.␊ - */␊ - osDisk?: (VirtualMachineScaleSetOSDisk5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set data disk.␊ - */␊ - export interface VirtualMachineScaleSetDataDisk4 {␊ - /**␊ - * Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**.␊ - */␊ - caching?: (("None" | "ReadOnly" | "ReadWrite") | string)␊ - /**␊ - * The create option.␊ - */␊ - createOption: (("FromImage" | "Empty" | "Attach") | string)␊ - /**␊ - * Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB␊ - */␊ - diskSizeGB?: (number | string)␊ - /**␊ - * 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.␊ - */␊ - lun: (number | string)␊ - /**␊ - * Describes the parameters of a ScaleSet managed disk.␊ - */␊ - managedDisk?: (VirtualMachineScaleSetManagedDiskParameters4 | string)␊ - /**␊ - * The disk name.␊ - */␊ - name?: string␊ - /**␊ - * Specifies whether writeAccelerator should be enabled or disabled on the disk.␊ - */␊ - writeAcceleratorEnabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the parameters of a ScaleSet managed disk.␊ - */␊ - export interface VirtualMachineScaleSetManagedDiskParameters4 {␊ - /**␊ - * Specifies the storage account type for the managed disk. Managed OS disk storage account type can only be set when you create the scale set. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.␊ - */␊ - storageAccountType?: (("Standard_LRS" | "Premium_LRS" | "StandardSSD_LRS" | "UltraSSD_LRS") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set operating system disk.␊ - */␊ - export interface VirtualMachineScaleSetOSDisk5 {␊ - /**␊ - * Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**.␊ - */␊ - caching?: (("None" | "ReadOnly" | "ReadWrite") | string)␊ - /**␊ - * 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.␊ - */␊ - createOption: (("FromImage" | "Empty" | "Attach") | string)␊ - /**␊ - * Describes the parameters of ephemeral disk settings that can be specified for operating system disk.

    NOTE: The ephemeral disk settings can only be specified for managed disk.␊ - */␊ - diffDiskSettings?: (DiffDiskSettings1 | string)␊ - /**␊ - * Specifies the size of the operating system disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB␊ - */␊ - diskSizeGB?: (number | string)␊ - /**␊ - * Describes the uri of a disk.␊ - */␊ - image?: (VirtualHardDisk4 | string)␊ - /**␊ - * Describes the parameters of a ScaleSet managed disk.␊ - */␊ - managedDisk?: (VirtualMachineScaleSetManagedDiskParameters4 | string)␊ - /**␊ - * The disk name.␊ - */␊ - name?: string␊ - /**␊ - * 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**.␊ - */␊ - osType?: (("Windows" | "Linux") | string)␊ - /**␊ - * Specifies the container urls that are used to store operating system disks for the scale set.␊ - */␊ - vhdContainers?: (string[] | string)␊ - /**␊ - * Specifies whether writeAccelerator should be enabled or disabled on the disk.␊ - */␊ - writeAcceleratorEnabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/virtualMachineScaleSets/extensions␊ - */␊ - export interface VirtualMachineScaleSetsExtensionsChildResource3 {␊ - apiVersion: "2018-10-01"␊ - /**␊ - * The name of the VM scale set extension.␊ - */␊ - name: string␊ - /**␊ - * Describes the properties of a Virtual Machine Scale Set Extension.␊ - */␊ - properties: (VirtualMachineScaleSetExtensionProperties3 | string)␊ - type: "extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the properties of a Virtual Machine Scale Set Extension.␊ - */␊ - export interface VirtualMachineScaleSetExtensionProperties3 {␊ - /**␊ - * 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.␊ - */␊ - autoUpgradeMinorVersion?: (boolean | string)␊ - /**␊ - * 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.␊ - */␊ - forceUpdateTag?: string␊ - /**␊ - * The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.␊ - */␊ - protectedSettings?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Collection of extension names after which this extension needs to be provisioned.␊ - */␊ - provisionAfterExtensions?: (string[] | string)␊ - /**␊ - * The name of the extension handler publisher.␊ - */␊ - publisher?: string␊ - /**␊ - * Json formatted public settings for the extension.␊ - */␊ - settings?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the type of the extension; an example is "CustomScriptExtension".␊ - */␊ - type?: string␊ - /**␊ - * Specifies the version of the script handler.␊ - */␊ - typeHandlerVersion?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/virtualMachineScaleSets/virtualmachines␊ - */␊ - export interface VirtualMachineScaleSetsVirtualmachinesChildResource2 {␊ - apiVersion: "2018-10-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The instance ID of the virtual machine.␊ - */␊ - name: string␊ - /**␊ - * 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**.␊ - */␊ - plan?: (Plan5 | string)␊ - /**␊ - * Describes the properties of a virtual machine scale set virtual machine.␊ - */␊ - properties: (VirtualMachineScaleSetVMProperties2 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "virtualmachines"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the properties of a virtual machine scale set virtual machine.␊ - */␊ - export interface VirtualMachineScaleSetVMProperties2 {␊ - /**␊ - * Enables or disables a capability on the virtual machine or virtual machine scale set.␊ - */␊ - additionalCapabilities?: (AdditionalCapabilities1 | string)␊ - availabilitySet?: (SubResource37 | string)␊ - /**␊ - * Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15.␊ - */␊ - diagnosticsProfile?: (DiagnosticsProfile4 | string)␊ - /**␊ - * Specifies the hardware settings for the virtual machine.␊ - */␊ - hardwareProfile?: (HardwareProfile5 | string)␊ - /**␊ - * 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␊ - */␊ - licenseType?: string␊ - /**␊ - * Specifies the network interfaces of the virtual machine.␊ - */␊ - networkProfile?: (NetworkProfile5 | string)␊ - /**␊ - * Specifies the operating system settings for the virtual machine.␊ - */␊ - osProfile?: (OSProfile4 | string)␊ - /**␊ - * Specifies the storage settings for the virtual machine disks.␊ - */␊ - storageProfile?: (StorageProfile10 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/virtualMachineScaleSets/virtualmachines␊ - */␊ - export interface VirtualMachineScaleSetsVirtualmachines1 {␊ - apiVersion: "2018-10-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The instance ID of the virtual machine.␊ - */␊ - name: string␊ - /**␊ - * 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**.␊ - */␊ - plan?: (Plan5 | string)␊ - /**␊ - * Describes the properties of a virtual machine scale set virtual machine.␊ - */␊ - properties: (VirtualMachineScaleSetVMProperties2 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/virtualMachineScaleSets/virtualmachines"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/virtualMachines/extensions␊ - */␊ - export interface VirtualMachinesExtensions4 {␊ - apiVersion: "2018-10-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the virtual machine extension.␊ - */␊ - name: string␊ - properties: (GenericExtension5 | IaaSDiagnostics5 | IaaSAntimalware5 | CustomScriptExtension5 | CustomScriptForLinux5 | LinuxDiagnostic5 | VmAccessForLinux5 | BgInfo5 | VmAccessAgent5 | DscExtension5 | AcronisBackupLinux5 | AcronisBackup5 | LinuxChefClient5 | ChefClient5 | DatadogLinuxAgent5 | DatadogWindowsAgent5 | DockerExtension5 | DynatraceLinux5 | DynatraceWindows5 | Eset5 | HpeSecurityApplicationDefender5 | PuppetAgent5 | Site24X7LinuxServerExtn5 | Site24X7WindowsServerExtn5 | Site24X7ApmInsightExtn5 | TrendMicroDSALinux5 | TrendMicroDSA5 | BmcCtmAgentLinux5 | BmcCtmAgentWindows5 | OSPatchingForLinux5 | VMSnapshot5 | VMSnapshotLinux5 | CustomScript5 | NetworkWatcherAgentWindows5 | NetworkWatcherAgentLinux5)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/virtualMachines/extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/virtualMachineScaleSets/extensions␊ - */␊ - export interface VirtualMachineScaleSetsExtensions2 {␊ - apiVersion: "2018-10-01"␊ - /**␊ - * The name of the VM scale set extension.␊ - */␊ - name: string␊ - properties: (GenericExtension5 | IaaSDiagnostics5 | IaaSAntimalware5 | CustomScriptExtension5 | CustomScriptForLinux5 | LinuxDiagnostic5 | VmAccessForLinux5 | BgInfo5 | VmAccessAgent5 | DscExtension5 | AcronisBackupLinux5 | AcronisBackup5 | LinuxChefClient5 | ChefClient5 | DatadogLinuxAgent5 | DatadogWindowsAgent5 | DockerExtension5 | DynatraceLinux5 | DynatraceWindows5 | Eset5 | HpeSecurityApplicationDefender5 | PuppetAgent5 | Site24X7LinuxServerExtn5 | Site24X7WindowsServerExtn5 | Site24X7ApmInsightExtn5 | TrendMicroDSALinux5 | TrendMicroDSA5 | BmcCtmAgentLinux5 | BmcCtmAgentWindows5 | OSPatchingForLinux5 | VMSnapshot5 | VMSnapshotLinux5 | CustomScript5 | NetworkWatcherAgentWindows5 | NetworkWatcherAgentLinux5)␊ - type: "Microsoft.Compute/virtualMachineScaleSets/extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/availabilitySets␊ - */␊ - export interface AvailabilitySets6 {␊ - apiVersion: "2019-03-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the availability set.␊ - */␊ - name: string␊ - /**␊ - * The instance view of a resource.␊ - */␊ - properties: (AvailabilitySetProperties5 | string)␊ - /**␊ - * Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name.␊ - */␊ - sku?: (Sku56 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/availabilitySets"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The instance view of a resource.␊ - */␊ - export interface AvailabilitySetProperties5 {␊ - /**␊ - * Fault Domain count.␊ - */␊ - platformFaultDomainCount?: (number | string)␊ - /**␊ - * Update Domain count.␊ - */␊ - platformUpdateDomainCount?: (number | string)␊ - proximityPlacementGroup?: (SubResource38 | string)␊ - /**␊ - * A list of references to all virtual machines in the availability set.␊ - */␊ - virtualMachines?: (SubResource38[] | string)␊ - [k: string]: unknown␊ - }␊ - export interface SubResource38 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name.␊ - */␊ - export interface Sku56 {␊ - /**␊ - * Specifies the number of virtual machines in the scale set.␊ - */␊ - capacity?: (number | string)␊ - /**␊ - * The sku name.␊ - */␊ - name?: string␊ - /**␊ - * Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic**␊ - */␊ - tier?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/hostGroups␊ - */␊ - export interface HostGroups {␊ - apiVersion: "2019-03-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the dedicated host group.␊ - */␊ - name: string␊ - /**␊ - * Dedicated Host Group Properties.␊ - */␊ - properties: (DedicatedHostGroupProperties | string)␊ - resources?: HostGroupsHostsChildResource[]␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/hostGroups"␊ - /**␊ - * Availability Zone to use for this host group. Only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Dedicated Host Group Properties.␊ - */␊ - export interface DedicatedHostGroupProperties {␊ - /**␊ - * Number of fault domains that the host group can span.␊ - */␊ - platformFaultDomainCount: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/hostGroups/hosts␊ - */␊ - export interface HostGroupsHostsChildResource {␊ - apiVersion: "2019-03-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the dedicated host .␊ - */␊ - name: string␊ - /**␊ - * Properties of the dedicated host.␊ - */␊ - properties: (DedicatedHostProperties | string)␊ - /**␊ - * Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name.␊ - */␊ - sku: (Sku56 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "hosts"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the dedicated host.␊ - */␊ - export interface DedicatedHostProperties {␊ - /**␊ - * Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided.␊ - */␊ - autoReplaceOnFailure?: (boolean | string)␊ - /**␊ - * Specifies the software license type that will be applied to the VMs deployed on the dedicated host.

    Possible values are:

    **None**

    **Windows_Server_Hybrid**

    **Windows_Server_Perpetual**

    Default: **None**.␊ - */␊ - licenseType?: (("None" | "Windows_Server_Hybrid" | "Windows_Server_Perpetual") | string)␊ - /**␊ - * Fault domain of the dedicated host within a dedicated host group.␊ - */␊ - platformFaultDomain?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/hostGroups/hosts␊ - */␊ - export interface HostGroupsHosts {␊ - apiVersion: "2019-03-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the dedicated host .␊ - */␊ - name: string␊ - /**␊ - * Properties of the dedicated host.␊ - */␊ - properties: (DedicatedHostProperties | string)␊ - /**␊ - * Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name.␊ - */␊ - sku: (Sku56 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/hostGroups/hosts"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/images␊ - */␊ - export interface Images5 {␊ - apiVersion: "2019-03-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the image.␊ - */␊ - name: string␊ - /**␊ - * Describes the properties of an Image.␊ - */␊ - properties: (ImageProperties5 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/images"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the properties of an Image.␊ - */␊ - export interface ImageProperties5 {␊ - /**␊ - * Gets the HyperVGenerationType of the VirtualMachine created from the image.␊ - */␊ - hyperVGeneration?: (("V1" | "V2") | string)␊ - sourceVirtualMachine?: (SubResource38 | string)␊ - /**␊ - * Describes a storage profile.␊ - */␊ - storageProfile?: (ImageStorageProfile5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a storage profile.␊ - */␊ - export interface ImageStorageProfile5 {␊ - /**␊ - * 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).␊ - */␊ - dataDisks?: (ImageDataDisk5[] | string)␊ - /**␊ - * Describes an Operating System disk.␊ - */␊ - osDisk?: (ImageOSDisk5 | string)␊ - /**␊ - * Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS).␊ - */␊ - zoneResilient?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a data disk.␊ - */␊ - export interface ImageDataDisk5 {␊ - /**␊ - * The Virtual Hard Disk.␊ - */␊ - blobUri?: string␊ - /**␊ - * Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**.␊ - */␊ - caching?: (("None" | "ReadOnly" | "ReadWrite") | string)␊ - /**␊ - * 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␊ - */␊ - diskSizeGB?: (number | string)␊ - /**␊ - * 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.␊ - */␊ - lun: (number | string)␊ - managedDisk?: (SubResource38 | string)␊ - snapshot?: (SubResource38 | string)␊ - /**␊ - * Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.␊ - */␊ - storageAccountType?: (("Standard_LRS" | "Premium_LRS" | "StandardSSD_LRS" | "UltraSSD_LRS") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes an Operating System disk.␊ - */␊ - export interface ImageOSDisk5 {␊ - /**␊ - * The Virtual Hard Disk.␊ - */␊ - blobUri?: string␊ - /**␊ - * Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**.␊ - */␊ - caching?: (("None" | "ReadOnly" | "ReadWrite") | string)␊ - /**␊ - * 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␊ - */␊ - diskSizeGB?: (number | string)␊ - managedDisk?: (SubResource38 | string)␊ - /**␊ - * The OS State.␊ - */␊ - osState: (("Generalized" | "Specialized") | string)␊ - /**␊ - * 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**.␊ - */␊ - osType: (("Windows" | "Linux") | string)␊ - snapshot?: (SubResource38 | string)␊ - /**␊ - * Specifies the storage account type for the managed disk. UltraSSD_LRS cannot be used with OS Disk.␊ - */␊ - storageAccountType?: (("Standard_LRS" | "Premium_LRS" | "StandardSSD_LRS" | "UltraSSD_LRS") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/proximityPlacementGroups␊ - */␊ - export interface ProximityPlacementGroups {␊ - apiVersion: "2019-03-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the proximity placement group.␊ - */␊ - name: string␊ - /**␊ - * Describes the properties of a Proximity Placement Group.␊ - */␊ - properties: (ProximityPlacementGroupProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/proximityPlacementGroups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the properties of a Proximity Placement Group.␊ - */␊ - export interface ProximityPlacementGroupProperties {␊ - /**␊ - * Specifies the type of the proximity placement group.

    Possible values are:

    **Standard** : Co-locate resources within an Azure region or Availability Zone.

    **Ultra** : For future use.␊ - */␊ - proximityPlacementGroupType?: (("Standard" | "Ultra") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/virtualMachines␊ - */␊ - export interface VirtualMachines7 {␊ - apiVersion: "2019-03-01"␊ - /**␊ - * Identity for the virtual machine.␊ - */␊ - identity?: (VirtualMachineIdentity5 | string)␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the virtual machine.␊ - */␊ - name: string␊ - /**␊ - * 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**.␊ - */␊ - plan?: (Plan6 | string)␊ - /**␊ - * Describes the properties of a Virtual Machine.␊ - */␊ - properties: (VirtualMachineProperties12 | string)␊ - resources?: VirtualMachinesExtensionsChildResource5[]␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/virtualMachines"␊ - /**␊ - * The virtual machine zones.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the virtual machine.␊ - */␊ - export interface VirtualMachineIdentity5 {␊ - /**␊ - * The type of identity used for the virtual machine. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.␊ - */␊ - type?: (("SystemAssigned" | "UserAssigned" | "SystemAssigned, UserAssigned" | "None") | string)␊ - /**␊ - * The list of user identities associated with the Virtual Machine. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.␊ - */␊ - userAssignedIdentities?: ({␊ - [k: string]: UserAssignedIdentitiesValue2␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - export interface UserAssignedIdentitiesValue2 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * 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**.␊ - */␊ - export interface Plan6 {␊ - /**␊ - * The plan ID.␊ - */␊ - name?: string␊ - /**␊ - * Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.␊ - */␊ - product?: string␊ - /**␊ - * The promotion code.␊ - */␊ - promotionCode?: string␊ - /**␊ - * The publisher ID.␊ - */␊ - publisher?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the properties of a Virtual Machine.␊ - */␊ - export interface VirtualMachineProperties12 {␊ - /**␊ - * Enables or disables a capability on the virtual machine or virtual machine scale set.␊ - */␊ - additionalCapabilities?: (AdditionalCapabilities2 | string)␊ - availabilitySet?: (SubResource38 | string)␊ - /**␊ - * Specifies the billing related details of a Azure Spot VM or VMSS.

    Minimum api-version: 2019-03-01.␊ - */␊ - billingProfile?: (BillingProfile | string)␊ - /**␊ - * Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15.␊ - */␊ - diagnosticsProfile?: (DiagnosticsProfile5 | string)␊ - /**␊ - * Specifies the eviction policy for the Azure Spot virtual machine. Only supported value is 'Deallocate'.

    Minimum api-version: 2019-03-01.␊ - */␊ - evictionPolicy?: (("Deallocate" | "Delete") | string)␊ - /**␊ - * Specifies the hardware settings for the virtual machine.␊ - */␊ - hardwareProfile?: (HardwareProfile6 | string)␊ - host?: (SubResource38 | string)␊ - /**␊ - * 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␊ - */␊ - licenseType?: string␊ - /**␊ - * Specifies the network interfaces of the virtual machine.␊ - */␊ - networkProfile?: (NetworkProfile6 | string)␊ - /**␊ - * Specifies the operating system settings for the virtual machine.␊ - */␊ - osProfile?: (OSProfile5 | string)␊ - /**␊ - * Specifies the priority for the virtual machine.

    Minimum api-version: 2019-03-01.␊ - */␊ - priority?: (("Regular" | "Low" | "Spot") | string)␊ - proximityPlacementGroup?: (SubResource38 | string)␊ - /**␊ - * Specifies the storage settings for the virtual machine disks.␊ - */␊ - storageProfile?: (StorageProfile11 | string)␊ - virtualMachineScaleSet?: (SubResource38 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Enables or disables a capability on the virtual machine or virtual machine scale set.␊ - */␊ - export interface AdditionalCapabilities2 {␊ - /**␊ - * The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled.␊ - */␊ - ultraSSDEnabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the billing related details of a Azure Spot VM or VMSS.

    Minimum api-version: 2019-03-01.␊ - */␊ - export interface BillingProfile {␊ - /**␊ - * Specifies the maximum price you are willing to pay for a Azure Spot VM/VMSS. This price is in US Dollars.

    This price will be compared with the current Azure Spot price for the VM size. Also, the prices are compared at the time of create/update of Azure Spot VM/VMSS and the operation will only succeed if the maxPrice is greater than the current Azure Spot price.

    The maxPrice will also be used for evicting a Azure Spot VM/VMSS if the current Azure Spot price goes beyond the maxPrice after creation of VM/VMSS.

    Possible values are:

    - Any decimal value greater than zero. Example: 0.01538

    -1 – indicates default price to be up-to on-demand.

    You can set the maxPrice to -1 to indicate that the Azure Spot VM/VMSS should not be evicted for price reasons. Also, the default max price is -1 if it is not provided by you.

    Minimum api-version: 2019-03-01.␊ - */␊ - maxPrice?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15.␊ - */␊ - export interface DiagnosticsProfile5 {␊ - /**␊ - * Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    You can easily view the output of your console log.

    Azure also enables you to see a screenshot of the VM from the hypervisor.␊ - */␊ - bootDiagnostics?: (BootDiagnostics5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    You can easily view the output of your console log.

    Azure also enables you to see a screenshot of the VM from the hypervisor.␊ - */␊ - export interface BootDiagnostics5 {␊ - /**␊ - * Whether boot diagnostics should be enabled on the Virtual Machine.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Uri of the storage account to use for placing the console output and screenshot.␊ - */␊ - storageUri?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the hardware settings for the virtual machine.␊ - */␊ - export interface HardwareProfile6 {␊ - /**␊ - * 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](https://docs.microsoft.com/rest/api/compute/availabilitysets/listavailablesizes)

    [List all available virtual machine sizes in a region](https://docs.microsoft.com/rest/api/compute/virtualmachinesizes/list)

    [List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes).␊ - */␊ - vmSize?: (("Basic_A0" | "Basic_A1" | "Basic_A2" | "Basic_A3" | "Basic_A4" | "Standard_A0" | "Standard_A1" | "Standard_A2" | "Standard_A3" | "Standard_A4" | "Standard_A5" | "Standard_A6" | "Standard_A7" | "Standard_A8" | "Standard_A9" | "Standard_A10" | "Standard_A11" | "Standard_A1_v2" | "Standard_A2_v2" | "Standard_A4_v2" | "Standard_A8_v2" | "Standard_A2m_v2" | "Standard_A4m_v2" | "Standard_A8m_v2" | "Standard_B1s" | "Standard_B1ms" | "Standard_B2s" | "Standard_B2ms" | "Standard_B4ms" | "Standard_B8ms" | "Standard_D1" | "Standard_D2" | "Standard_D3" | "Standard_D4" | "Standard_D11" | "Standard_D12" | "Standard_D13" | "Standard_D14" | "Standard_D1_v2" | "Standard_D2_v2" | "Standard_D3_v2" | "Standard_D4_v2" | "Standard_D5_v2" | "Standard_D2_v3" | "Standard_D4_v3" | "Standard_D8_v3" | "Standard_D16_v3" | "Standard_D32_v3" | "Standard_D64_v3" | "Standard_D2s_v3" | "Standard_D4s_v3" | "Standard_D8s_v3" | "Standard_D16s_v3" | "Standard_D32s_v3" | "Standard_D64s_v3" | "Standard_D11_v2" | "Standard_D12_v2" | "Standard_D13_v2" | "Standard_D14_v2" | "Standard_D15_v2" | "Standard_DS1" | "Standard_DS2" | "Standard_DS3" | "Standard_DS4" | "Standard_DS11" | "Standard_DS12" | "Standard_DS13" | "Standard_DS14" | "Standard_DS1_v2" | "Standard_DS2_v2" | "Standard_DS3_v2" | "Standard_DS4_v2" | "Standard_DS5_v2" | "Standard_DS11_v2" | "Standard_DS12_v2" | "Standard_DS13_v2" | "Standard_DS14_v2" | "Standard_DS15_v2" | "Standard_DS13-4_v2" | "Standard_DS13-2_v2" | "Standard_DS14-8_v2" | "Standard_DS14-4_v2" | "Standard_E2_v3" | "Standard_E4_v3" | "Standard_E8_v3" | "Standard_E16_v3" | "Standard_E32_v3" | "Standard_E64_v3" | "Standard_E2s_v3" | "Standard_E4s_v3" | "Standard_E8s_v3" | "Standard_E16s_v3" | "Standard_E32s_v3" | "Standard_E64s_v3" | "Standard_E32-16_v3" | "Standard_E32-8s_v3" | "Standard_E64-32s_v3" | "Standard_E64-16s_v3" | "Standard_F1" | "Standard_F2" | "Standard_F4" | "Standard_F8" | "Standard_F16" | "Standard_F1s" | "Standard_F2s" | "Standard_F4s" | "Standard_F8s" | "Standard_F16s" | "Standard_F2s_v2" | "Standard_F4s_v2" | "Standard_F8s_v2" | "Standard_F16s_v2" | "Standard_F32s_v2" | "Standard_F64s_v2" | "Standard_F72s_v2" | "Standard_G1" | "Standard_G2" | "Standard_G3" | "Standard_G4" | "Standard_G5" | "Standard_GS1" | "Standard_GS2" | "Standard_GS3" | "Standard_GS4" | "Standard_GS5" | "Standard_GS4-8" | "Standard_GS4-4" | "Standard_GS5-16" | "Standard_GS5-8" | "Standard_H8" | "Standard_H16" | "Standard_H8m" | "Standard_H16m" | "Standard_H16r" | "Standard_H16mr" | "Standard_L4s" | "Standard_L8s" | "Standard_L16s" | "Standard_L32s" | "Standard_M64s" | "Standard_M64ms" | "Standard_M128s" | "Standard_M128ms" | "Standard_M64-32ms" | "Standard_M64-16ms" | "Standard_M128-64ms" | "Standard_M128-32ms" | "Standard_NC6" | "Standard_NC12" | "Standard_NC24" | "Standard_NC24r" | "Standard_NC6s_v2" | "Standard_NC12s_v2" | "Standard_NC24s_v2" | "Standard_NC24rs_v2" | "Standard_NC6s_v3" | "Standard_NC12s_v3" | "Standard_NC24s_v3" | "Standard_NC24rs_v3" | "Standard_ND6s" | "Standard_ND12s" | "Standard_ND24s" | "Standard_ND24rs" | "Standard_NV6" | "Standard_NV12" | "Standard_NV24") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the network interfaces of the virtual machine.␊ - */␊ - export interface NetworkProfile6 {␊ - /**␊ - * Specifies the list of resource Ids for the network interfaces associated with the virtual machine.␊ - */␊ - networkInterfaces?: (NetworkInterfaceReference5[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a network interface reference.␊ - */␊ - export interface NetworkInterfaceReference5 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Describes a network interface reference properties.␊ - */␊ - properties?: (NetworkInterfaceReferenceProperties5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a network interface reference properties.␊ - */␊ - export interface NetworkInterfaceReferenceProperties5 {␊ - /**␊ - * Specifies the primary network interface in case the virtual machine has more than 1 network interface.␊ - */␊ - primary?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the operating system settings for the virtual machine.␊ - */␊ - export interface OSProfile5 {␊ - /**␊ - * 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)␊ - */␊ - adminPassword?: string␊ - /**␊ - * 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)␊ - */␊ - adminUsername?: string␊ - /**␊ - * Specifies whether extension operations should be allowed on the virtual machine.

    This may only be set to False when no extensions are present on the virtual machine.␊ - */␊ - allowExtensionOperations?: (boolean | string)␊ - /**␊ - * Specifies the host OS name of the virtual machine.

    This name cannot be updated after the VM is created.

    **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).␊ - */␊ - computerName?: string␊ - /**␊ - * 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)␊ - */␊ - customData?: string␊ - /**␊ - * 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).␊ - */␊ - linuxConfiguration?: (LinuxConfiguration6 | string)␊ - /**␊ - * Specifies whether the guest provision signal is required from the virtual machine.␊ - */␊ - requireGuestProvisionSignal?: (boolean | string)␊ - /**␊ - * Specifies set of certificates that should be installed onto the virtual machine.␊ - */␊ - secrets?: (VaultSecretGroup5[] | string)␊ - /**␊ - * Specifies Windows operating system settings on the virtual machine.␊ - */␊ - windowsConfiguration?: (WindowsConfiguration7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * 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).␊ - */␊ - export interface LinuxConfiguration6 {␊ - /**␊ - * Specifies whether password authentication should be disabled.␊ - */␊ - disablePasswordAuthentication?: (boolean | string)␊ - /**␊ - * 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.␊ - */␊ - provisionVMAgent?: (boolean | string)␊ - /**␊ - * SSH configuration for Linux based VMs running on Azure␊ - */␊ - ssh?: (SshConfiguration6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSH configuration for Linux based VMs running on Azure␊ - */␊ - export interface SshConfiguration6 {␊ - /**␊ - * The list of SSH public keys used to authenticate with linux based VMs.␊ - */␊ - publicKeys?: (SshPublicKey5[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed.␊ - */␊ - export interface SshPublicKey5 {␊ - /**␊ - * 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).␊ - */␊ - keyData?: string␊ - /**␊ - * 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␊ - */␊ - path?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a set of certificates which are all in the same Key Vault.␊ - */␊ - export interface VaultSecretGroup5 {␊ - sourceVault?: (SubResource38 | string)␊ - /**␊ - * The list of key vault references in SourceVault which contain certificates.␊ - */␊ - vaultCertificates?: (VaultCertificate5[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM.␊ - */␊ - export interface VaultCertificate5 {␊ - /**␊ - * 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 <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted.␊ - */␊ - certificateStore?: string␊ - /**␊ - * 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":""
    }␊ - */␊ - certificateUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies Windows operating system settings on the virtual machine.␊ - */␊ - export interface WindowsConfiguration7 {␊ - /**␊ - * Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup.␊ - */␊ - additionalUnattendContent?: (AdditionalUnattendContent6[] | string)␊ - /**␊ - * Indicates whether Automatic Updates is enabled for the Windows virtual machine. Default value is true.

    For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning.␊ - */␊ - enableAutomaticUpdates?: (boolean | string)␊ - /**␊ - * 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.␊ - */␊ - provisionVMAgent?: (boolean | string)␊ - /**␊ - * Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time"␊ - */␊ - timeZone?: string␊ - /**␊ - * Describes Windows Remote Management configuration of the VM␊ - */␊ - winRM?: (WinRMConfiguration5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * 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.␊ - */␊ - export interface AdditionalUnattendContent6 {␊ - /**␊ - * The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup.␊ - */␊ - componentName?: ("Microsoft-Windows-Shell-Setup" | string)␊ - /**␊ - * 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.␊ - */␊ - content?: string␊ - /**␊ - * The pass name. Currently, the only allowable value is OobeSystem.␊ - */␊ - passName?: ("OobeSystem" | string)␊ - /**␊ - * Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.␊ - */␊ - settingName?: (("AutoLogon" | "FirstLogonCommands") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes Windows Remote Management configuration of the VM␊ - */␊ - export interface WinRMConfiguration5 {␊ - /**␊ - * The list of Windows Remote Management listeners␊ - */␊ - listeners?: (WinRMListener6[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes Protocol and thumbprint of Windows Remote Management listener␊ - */␊ - export interface WinRMListener6 {␊ - /**␊ - * 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":""
    }␊ - */␊ - certificateUrl?: string␊ - /**␊ - * Specifies the protocol of listener.

    Possible values are:
    **http**

    **https**.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the storage settings for the virtual machine disks.␊ - */␊ - export interface StorageProfile11 {␊ - /**␊ - * 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).␊ - */␊ - dataDisks?: (DataDisk7[] | string)␊ - /**␊ - * 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. NOTE: Image reference publisher and offer can only be set when you create the scale set.␊ - */␊ - imageReference?: (ImageReference8 | string)␊ - /**␊ - * 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).␊ - */␊ - osDisk?: (OSDisk6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a data disk.␊ - */␊ - export interface DataDisk7 {␊ - /**␊ - * Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**.␊ - */␊ - caching?: (("None" | "ReadOnly" | "ReadWrite") | string)␊ - /**␊ - * 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.␊ - */␊ - createOption: (("FromImage" | "Empty" | "Attach") | string)␊ - /**␊ - * Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB␊ - */␊ - diskSizeGB?: (number | string)␊ - /**␊ - * Describes the uri of a disk.␊ - */␊ - image?: (VirtualHardDisk5 | string)␊ - /**␊ - * 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.␊ - */␊ - lun: (number | string)␊ - /**␊ - * The parameters of a managed disk.␊ - */␊ - managedDisk?: (ManagedDiskParameters5 | string)␊ - /**␊ - * The disk name.␊ - */␊ - name?: string␊ - /**␊ - * Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset␊ - */␊ - toBeDetached?: (boolean | string)␊ - /**␊ - * Describes the uri of a disk.␊ - */␊ - vhd?: (VirtualHardDisk5 | string)␊ - /**␊ - * Specifies whether writeAccelerator should be enabled or disabled on the disk.␊ - */␊ - writeAcceleratorEnabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the uri of a disk.␊ - */␊ - export interface VirtualHardDisk5 {␊ - /**␊ - * Specifies the virtual hard disk's uri.␊ - */␊ - uri?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The parameters of a managed disk.␊ - */␊ - export interface ManagedDiskParameters5 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.␊ - */␊ - storageAccountType?: (("Standard_LRS" | "Premium_LRS" | "StandardSSD_LRS" | "UltraSSD_LRS") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * 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. NOTE: Image reference publisher and offer can only be set when you create the scale set.␊ - */␊ - export interface ImageReference8 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Specifies the offer of the platform image or marketplace image used to create the virtual machine.␊ - */␊ - offer?: string␊ - /**␊ - * The image publisher.␊ - */␊ - publisher?: string␊ - /**␊ - * The image SKU.␊ - */␊ - sku?: string␊ - /**␊ - * 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.␊ - */␊ - version?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * 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).␊ - */␊ - export interface OSDisk6 {␊ - /**␊ - * Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**.␊ - */␊ - caching?: (("None" | "ReadOnly" | "ReadWrite") | string)␊ - /**␊ - * 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.␊ - */␊ - createOption: (("FromImage" | "Empty" | "Attach") | string)␊ - /**␊ - * Describes the parameters of ephemeral disk settings that can be specified for operating system disk.

    NOTE: The ephemeral disk settings can only be specified for managed disk.␊ - */␊ - diffDiskSettings?: (DiffDiskSettings2 | string)␊ - /**␊ - * Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB␊ - */␊ - diskSizeGB?: (number | string)␊ - /**␊ - * Describes a Encryption Settings for a Disk␊ - */␊ - encryptionSettings?: (DiskEncryptionSettings5 | string)␊ - /**␊ - * Describes the uri of a disk.␊ - */␊ - image?: (VirtualHardDisk5 | string)␊ - /**␊ - * The parameters of a managed disk.␊ - */␊ - managedDisk?: (ManagedDiskParameters5 | string)␊ - /**␊ - * The disk name.␊ - */␊ - name?: string␊ - /**␊ - * 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**.␊ - */␊ - osType?: (("Windows" | "Linux") | string)␊ - /**␊ - * Describes the uri of a disk.␊ - */␊ - vhd?: (VirtualHardDisk5 | string)␊ - /**␊ - * Specifies whether writeAccelerator should be enabled or disabled on the disk.␊ - */␊ - writeAcceleratorEnabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the parameters of ephemeral disk settings that can be specified for operating system disk.

    NOTE: The ephemeral disk settings can only be specified for managed disk.␊ - */␊ - export interface DiffDiskSettings2 {␊ - /**␊ - * Specifies the ephemeral disk settings for operating system disk.␊ - */␊ - option?: ("Local" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a Encryption Settings for a Disk␊ - */␊ - export interface DiskEncryptionSettings5 {␊ - /**␊ - * Describes a reference to Key Vault Secret␊ - */␊ - diskEncryptionKey?: (KeyVaultSecretReference6 | string)␊ - /**␊ - * Specifies whether disk encryption should be enabled on the virtual machine.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Describes a reference to Key Vault Key␊ - */␊ - keyEncryptionKey?: (KeyVaultKeyReference5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a reference to Key Vault Secret␊ - */␊ - export interface KeyVaultSecretReference6 {␊ - /**␊ - * The URL referencing a secret in a Key Vault.␊ - */␊ - secretUrl: string␊ - sourceVault: (SubResource38 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a reference to Key Vault Key␊ - */␊ - export interface KeyVaultKeyReference5 {␊ - /**␊ - * The URL referencing a key encryption key in Key Vault.␊ - */␊ - keyUrl: string␊ - sourceVault: (SubResource38 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/virtualMachines/extensions␊ - */␊ - export interface VirtualMachinesExtensionsChildResource5 {␊ - apiVersion: "2019-03-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the virtual machine extension.␊ - */␊ - name: string␊ - properties: (GenericExtension6 | IaaSDiagnostics6 | IaaSAntimalware6 | CustomScriptExtension6 | CustomScriptForLinux6 | LinuxDiagnostic6 | VmAccessForLinux6 | BgInfo6 | VmAccessAgent6 | DscExtension6 | AcronisBackupLinux6 | AcronisBackup6 | LinuxChefClient6 | ChefClient6 | DatadogLinuxAgent6 | DatadogWindowsAgent6 | DockerExtension6 | DynatraceLinux6 | DynatraceWindows6 | Eset6 | HpeSecurityApplicationDefender6 | PuppetAgent6 | Site24X7LinuxServerExtn6 | Site24X7WindowsServerExtn6 | Site24X7ApmInsightExtn6 | TrendMicroDSALinux6 | TrendMicroDSA6 | BmcCtmAgentLinux6 | BmcCtmAgentWindows6 | OSPatchingForLinux6 | VMSnapshot6 | VMSnapshotLinux6 | CustomScript6 | NetworkWatcherAgentWindows6 | NetworkWatcherAgentLinux6)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "extensions"␊ - [k: string]: unknown␊ - }␊ - export interface GenericExtension6 {␊ - /**␊ - * Microsoft.Compute/extensions - Publisher␊ - */␊ - publisher: string␊ - /**␊ - * Microsoft.Compute/extensions - Type␊ - */␊ - type: string␊ - /**␊ - * Microsoft.Compute/extensions - Type handler version␊ - */␊ - typeHandlerVersion: string␊ - /**␊ - * Microsoft.Compute/extensions - Settings␊ - */␊ - settings: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - export interface IaaSDiagnostics6 {␊ - publisher: "Microsoft.Azure.Diagnostics"␊ - type: "IaaSDiagnostics"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - xmlCfg: string␊ - StorageAccount: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - storageAccountName: string␊ - storageAccountKey: string␊ - storageAccountEndPoint: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface IaaSAntimalware6 {␊ - publisher: "Microsoft.Azure.Security"␊ - type: "IaaSAntimalware"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - AntimalwareEnabled: boolean␊ - Exclusions: {␊ - Paths: string␊ - Extensions: string␊ - Processes: string␊ - [k: string]: unknown␊ - }␊ - RealtimeProtectionEnabled: ("true" | "false")␊ - ScheduledScanSettings: {␊ - isEnabled: ("true" | "false")␊ - scanType: string␊ - day: string␊ - time: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface CustomScriptExtension6 {␊ - publisher: "Microsoft.Compute"␊ - type: "CustomScriptExtension"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - fileUris?: string[]␊ - commandToExecute: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - storageAccountName?: string␊ - storageAccountKey?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface CustomScriptForLinux6 {␊ - publisher: "Microsoft.OSTCExtensions"␊ - type: "CustomScriptForLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - fileUris?: string[]␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - commandToExecute: string␊ - storageAccountName?: string␊ - storageAccountKey?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface LinuxDiagnostic6 {␊ - publisher: "Microsoft.OSTCExtensions"␊ - type: "LinuxDiagnostic"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - enableSyslog?: string␊ - mdsdHttpProxy?: string␊ - perCfg?: unknown[]␊ - fileCfg?: unknown[]␊ - xmlCfg?: string␊ - ladCfg?: {␊ - [k: string]: unknown␊ - }␊ - syslogCfg?: string␊ - eventVolume?: string␊ - mdsdCfg?: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - mdsdHttpProxy?: string␊ - storageAccountName: string␊ - storageAccountKey: string␊ - storageAccountEndPoint?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface VmAccessForLinux6 {␊ - publisher: "Microsoft.OSTCExtensions"␊ - type: "VMAccessForLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - check_disk?: boolean␊ - repair_disk?: boolean␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - username: string␊ - password: string␊ - ssh_key: string␊ - reset_ssh: string␊ - remove_user: string␊ - expiration: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface BgInfo6 {␊ - publisher: "Microsoft.Compute"␊ - type: "bginfo"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - [k: string]: unknown␊ - }␊ - export interface VmAccessAgent6 {␊ - publisher: "Microsoft.Compute"␊ - type: "VMAccessAgent"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - username?: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - password?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface DscExtension6 {␊ - publisher: "Microsoft.Powershell"␊ - type: "DSC"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - modulesUrl: string␊ - configurationFunction: string␊ - properties?: string␊ - wmfVersion?: string␊ - privacy?: {␊ - dataCollection?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - dataBlobUri?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface AcronisBackupLinux6 {␊ - publisher: "Acronis.Backup"␊ - type: "AcronisBackupLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - absURL: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - userLogin: string␊ - userPassword: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface AcronisBackup6 {␊ - publisher: "Acronis.Backup"␊ - type: "AcronisBackup"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - absURL: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - userLogin: string␊ - userPassword: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface LinuxChefClient6 {␊ - publisher: "Chef.Bootstrap.WindowsAzure"␊ - type: "LinuxChefClient"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - bootstrap_version?: string␊ - bootstrap_options?: {␊ - chef_node_name: string␊ - chef_server_url: string␊ - validation_client_name: string␊ - node_ssl_verify_mode: string␊ - environment: string␊ - [k: string]: unknown␊ - }␊ - runlist?: string␊ - client_rb?: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - validation_key: string␊ - chef_server_crt: string␊ - secret: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface ChefClient6 {␊ - publisher: "Chef.Bootstrap.WindowsAzure"␊ - type: "ChefClient"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - bootstrap_options?: {␊ - chef_node_name: string␊ - chef_server_url: string␊ - validation_client_name: string␊ - node_ssl_verify_mode: string␊ - environment: string␊ - [k: string]: unknown␊ - }␊ - runlist?: string␊ - client_rb?: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - validation_key: string␊ - chef_server_crt: string␊ - secret: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface DatadogLinuxAgent6 {␊ - publisher: "Datadog.Agent"␊ - type: "DatadogLinuxAgent"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - api_key: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface DatadogWindowsAgent6 {␊ - publisher: "Datadog.Agent"␊ - type: "DatadogWindowsAgent"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - api_key: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface DockerExtension6 {␊ - publisher: "Microsoft.Azure.Extensions"␊ - type: "DockerExtension"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - docker: {␊ - port: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - certs: {␊ - ca: string␊ - cert: string␊ - key: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface DynatraceLinux6 {␊ - publisher: "dynatrace.ruxit"␊ - type: "ruxitAgentLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - tenantId: string␊ - token: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface DynatraceWindows6 {␊ - publisher: "dynatrace.ruxit"␊ - type: "ruxitAgentWindows"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - tenantId: string␊ - token: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Eset6 {␊ - publisher: "ESET"␊ - type: "FileSecurity"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - LicenseKey: string␊ - "Install-RealtimeProtection": boolean␊ - "Install-ProtocolFiltering": boolean␊ - "Install-DeviceControl": boolean␊ - "Enable-Cloud": boolean␊ - "Enable-PUA": boolean␊ - ERAAgentCfgUrl: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface HpeSecurityApplicationDefender6 {␊ - publisher: "HPE.Security.ApplicationDefender"␊ - type: "DotnetAgent"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - protectedSettings: {␊ - key: string␊ - serverURL: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface PuppetAgent6 {␊ - publisher: "Puppet"␊ - type: "PuppetAgent"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - protectedSettings: {␊ - PUPPET_MASTER_SERVER: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Site24X7LinuxServerExtn6 {␊ - publisher: "Site24x7"␊ - type: "Site24x7LinuxServerExtn"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - site24x7AgentType?: "azurevmextnlinuxserver"␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - site24x7LicenseKey: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Site24X7WindowsServerExtn6 {␊ - publisher: "Site24x7"␊ - type: "Site24x7WindowsServerExtn"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - site24x7AgentType?: "azurevmextnwindowsserver"␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - site24x7LicenseKey: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Site24X7ApmInsightExtn6 {␊ - publisher: "Site24x7"␊ - type: "Site24x7ApmInsightExtn"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - site24x7AgentType?: "azurevmextnapminsightclassic"␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - site24x7LicenseKey: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface TrendMicroDSALinux6 {␊ - publisher: "TrendMicro.DeepSecurity"␊ - type: "TrendMicroDSALinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - DSMname: string␊ - DSMport: string␊ - policyNameorID?: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - tenantID: string␊ - tenantPassword: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface TrendMicroDSA6 {␊ - publisher: "TrendMicro.DeepSecurity"␊ - type: "TrendMicroDSA"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - DSMname: string␊ - DSMport: string␊ - policyNameorID?: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - tenantID: string␊ - tenantPassword: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface BmcCtmAgentLinux6 {␊ - publisher: "ctm.bmc.com"␊ - type: "BmcCtmAgentLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - "Control-M Server Name": string␊ - "Agent Port": string␊ - "Host Group": string␊ - "User Account": string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface BmcCtmAgentWindows6 {␊ - publisher: "bmc.ctm"␊ - type: "AgentWinExt"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - "Control-M Server Name": string␊ - "Agent Port": string␊ - "Host Group": string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface OSPatchingForLinux6 {␊ - publisher: "Microsoft.OSTCExtensions"␊ - type: "OSPatchingForLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - disabled: boolean␊ - stop: boolean␊ - installDuration?: string␊ - intervalOfWeeks?: number␊ - dayOfWeek?: string␊ - startTime?: string␊ - rebootAfterPatch?: string␊ - category?: string␊ - oneoff?: boolean␊ - local?: boolean␊ - idleTestScript?: string␊ - healthyTestScript?: string␊ - distUpgradeList?: string␊ - distUpgradeAll?: boolean␊ - vmStatusTest?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - storageAccountName?: string␊ - storageAccountKey?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface VMSnapshot6 {␊ - publisher: "Microsoft.Azure.RecoveryServices"␊ - type: "VMSnapshot"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - locale: string␊ - taskId: string␊ - commandToExecute: string␊ - objectStr: string␊ - logsBlobUri: string␊ - statusBlobUri: string␊ - commandStartTimeUTCTicks: string␊ - vmType: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface VMSnapshotLinux6 {␊ - publisher: "Microsoft.Azure.RecoveryServices"␊ - type: "VMSnapshotLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - locale: string␊ - taskId: string␊ - commandToExecute: string␊ - objectStr: string␊ - logsBlobUri: string␊ - statusBlobUri: string␊ - commandStartTimeUTCTicks: string␊ - vmType: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface CustomScript6 {␊ - publisher: "Microsoft.Azure.Extensions"␊ - type: "CustomScript"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - fileUris: string[]␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - storageAccountName: string␊ - storageAccountKey: string␊ - commandToExecute: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface NetworkWatcherAgentWindows6 {␊ - publisher: "Microsoft.Azure.NetworkWatcher"␊ - type: "NetworkWatcherAgentWindows"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - [k: string]: unknown␊ - }␊ - export interface NetworkWatcherAgentLinux6 {␊ - publisher: "Microsoft.Azure.NetworkWatcher"␊ - type: "NetworkWatcherAgentLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/virtualMachineScaleSets␊ - */␊ - export interface VirtualMachineScaleSets6 {␊ - apiVersion: "2019-03-01"␊ - /**␊ - * Identity for the virtual machine scale set.␊ - */␊ - identity?: (VirtualMachineScaleSetIdentity5 | string)␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the VM scale set to create or update.␊ - */␊ - name: string␊ - /**␊ - * 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**.␊ - */␊ - plan?: (Plan6 | string)␊ - /**␊ - * Describes the properties of a Virtual Machine Scale Set.␊ - */␊ - properties: (VirtualMachineScaleSetProperties5 | string)␊ - resources?: (VirtualMachineScaleSetsExtensionsChildResource4 | VirtualMachineScaleSetsVirtualmachinesChildResource3)[]␊ - /**␊ - * Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name.␊ - */␊ - sku?: (Sku56 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/virtualMachineScaleSets"␊ - /**␊ - * The virtual machine scale set zones. NOTE: Availability zones can only be set when you create the scale set.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the virtual machine scale set.␊ - */␊ - export interface VirtualMachineScaleSetIdentity5 {␊ - /**␊ - * The type of identity used for the virtual machine scale set. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine scale set.␊ - */␊ - type?: (("SystemAssigned" | "UserAssigned" | "SystemAssigned, UserAssigned" | "None") | string)␊ - /**␊ - * The list of user identities associated with the virtual machine scale set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.␊ - */␊ - userAssignedIdentities?: ({␊ - [k: string]: VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue2␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - export interface VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue2 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the properties of a Virtual Machine Scale Set.␊ - */␊ - export interface VirtualMachineScaleSetProperties5 {␊ - /**␊ - * Enables or disables a capability on the virtual machine or virtual machine scale set.␊ - */␊ - additionalCapabilities?: (AdditionalCapabilities2 | string)␊ - /**␊ - * Specifies the configuration parameters for automatic repairs on the virtual machine scale set.␊ - */␊ - automaticRepairsPolicy?: (AutomaticRepairsPolicy1 | string)␊ - /**␊ - * When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs.␊ - */␊ - doNotRunExtensionsOnOverprovisionedVMs?: (boolean | string)␊ - /**␊ - * Specifies whether the Virtual Machine Scale Set should be overprovisioned.␊ - */␊ - overprovision?: (boolean | string)␊ - /**␊ - * Fault Domain count for each placement group.␊ - */␊ - platformFaultDomainCount?: (number | string)␊ - proximityPlacementGroup?: (SubResource38 | string)␊ - /**␊ - * Describes a scale-in policy for a virtual machine scale set.␊ - */␊ - scaleInPolicy?: (ScaleInPolicy | string)␊ - /**␊ - * When true this limits the scale set to a single placement group, of max size 100 virtual machines.␊ - */␊ - singlePlacementGroup?: (boolean | string)␊ - /**␊ - * Describes an upgrade policy - automatic, manual, or rolling.␊ - */␊ - upgradePolicy?: (UpgradePolicy6 | string)␊ - /**␊ - * Describes a virtual machine scale set virtual machine profile.␊ - */␊ - virtualMachineProfile?: (VirtualMachineScaleSetVMProfile5 | string)␊ - /**␊ - * Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage.␊ - */␊ - zoneBalance?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the configuration parameters for automatic repairs on the virtual machine scale set.␊ - */␊ - export interface AutomaticRepairsPolicy1 {␊ - /**␊ - * Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * The amount of time for which automatic repairs are suspended due to a state change on VM. The grace time starts after the state change has completed. This helps avoid premature or accidental repairs. The time duration should be specified in ISO 8601 format. The minimum allowed grace period is 30 minutes (PT30M), which is also the default value. The maximum allowed grace period is 90 minutes (PT90M).␊ - */␊ - gracePeriod?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a scale-in policy for a virtual machine scale set.␊ - */␊ - export interface ScaleInPolicy {␊ - /**␊ - * The rules to be followed when scaling-in a virtual machine scale set.

    Possible values are:

    **Default** When a virtual machine scale set is scaled in, the scale set will first be balanced across zones if it is a zonal scale set. Then, it will be balanced across Fault Domains as far as possible. Within each Fault Domain, the virtual machines chosen for removal will be the newest ones that are not protected from scale-in.

    **OldestVM** When a virtual machine scale set is being scaled-in, the oldest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the oldest virtual machines that are not protected will be chosen for removal.

    **NewestVM** When a virtual machine scale set is being scaled-in, the newest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the newest virtual machines that are not protected will be chosen for removal.

    ␊ - */␊ - rules?: (("Default" | "OldestVM" | "NewestVM")[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes an upgrade policy - automatic, manual, or rolling.␊ - */␊ - export interface UpgradePolicy6 {␊ - /**␊ - * The configuration parameters used for performing automatic OS upgrade.␊ - */␊ - automaticOSUpgradePolicy?: (AutomaticOSUpgradePolicy1 | string)␊ - /**␊ - * 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.␊ - */␊ - mode?: (("Automatic" | "Manual" | "Rolling") | string)␊ - /**␊ - * The configuration parameters used while performing a rolling upgrade.␊ - */␊ - rollingUpgradePolicy?: (RollingUpgradePolicy4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The configuration parameters used for performing automatic OS upgrade.␊ - */␊ - export interface AutomaticOSUpgradePolicy1 {␊ - /**␊ - * Whether OS image rollback feature should be disabled. Default value is false.␊ - */␊ - disableAutomaticRollback?: (boolean | string)␊ - /**␊ - * Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. Default value is false.

    If this is set to true for Windows based scale sets, [enableAutomaticUpdates](https://docs.microsoft.com/dotnet/api/microsoft.azure.management.compute.models.windowsconfiguration.enableautomaticupdates?view=azure-dotnet) is automatically set to false and cannot be set to true.␊ - */␊ - enableAutomaticOSUpgrade?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The configuration parameters used while performing a rolling upgrade.␊ - */␊ - export interface RollingUpgradePolicy4 {␊ - /**␊ - * 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%.␊ - */␊ - maxBatchInstancePercent?: (number | string)␊ - /**␊ - * 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%.␊ - */␊ - maxUnhealthyInstancePercent?: (number | string)␊ - /**␊ - * 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%.␊ - */␊ - maxUnhealthyUpgradedInstancePercent?: (number | string)␊ - /**␊ - * 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).␊ - */␊ - pauseTimeBetweenBatches?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set virtual machine profile.␊ - */␊ - export interface VirtualMachineScaleSetVMProfile5 {␊ - /**␊ - * Specifies the billing related details of a Azure Spot VM or VMSS.

    Minimum api-version: 2019-03-01.␊ - */␊ - billingProfile?: (BillingProfile | string)␊ - /**␊ - * Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15.␊ - */␊ - diagnosticsProfile?: (DiagnosticsProfile5 | string)␊ - /**␊ - * Specifies the eviction policy for virtual machines in a Azure Spot scale set.

    Minimum api-version: 2017-10-30-preview.␊ - */␊ - evictionPolicy?: (("Deallocate" | "Delete") | string)␊ - /**␊ - * Describes a virtual machine scale set extension profile.␊ - */␊ - extensionProfile?: (VirtualMachineScaleSetExtensionProfile6 | string)␊ - /**␊ - * 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␊ - */␊ - licenseType?: string␊ - /**␊ - * Describes a virtual machine scale set network profile.␊ - */␊ - networkProfile?: (VirtualMachineScaleSetNetworkProfile6 | string)␊ - /**␊ - * Describes a virtual machine scale set OS profile.␊ - */␊ - osProfile?: (VirtualMachineScaleSetOSProfile5 | string)␊ - /**␊ - * Specifies the priority for the virtual machines in the scale set.

    Minimum api-version: 2017-10-30-preview.␊ - */␊ - priority?: (("Regular" | "Low" | "Spot") | string)␊ - scheduledEventsProfile?: (ScheduledEventsProfile | string)␊ - /**␊ - * Describes a virtual machine scale set storage profile.␊ - */␊ - storageProfile?: (VirtualMachineScaleSetStorageProfile6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set extension profile.␊ - */␊ - export interface VirtualMachineScaleSetExtensionProfile6 {␊ - /**␊ - * The virtual machine scale set child extension resources.␊ - */␊ - extensions?: (VirtualMachineScaleSetExtension6[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a Virtual Machine Scale Set Extension.␊ - */␊ - export interface VirtualMachineScaleSetExtension6 {␊ - /**␊ - * The name of the extension.␊ - */␊ - name?: string␊ - properties?: (GenericExtension6 | IaaSDiagnostics6 | IaaSAntimalware6 | CustomScriptExtension6 | CustomScriptForLinux6 | LinuxDiagnostic6 | VmAccessForLinux6 | BgInfo6 | VmAccessAgent6 | DscExtension6 | AcronisBackupLinux6 | AcronisBackup6 | LinuxChefClient6 | ChefClient6 | DatadogLinuxAgent6 | DatadogWindowsAgent6 | DockerExtension6 | DynatraceLinux6 | DynatraceWindows6 | Eset6 | HpeSecurityApplicationDefender6 | PuppetAgent6 | Site24X7LinuxServerExtn6 | Site24X7WindowsServerExtn6 | Site24X7ApmInsightExtn6 | TrendMicroDSALinux6 | TrendMicroDSA6 | BmcCtmAgentLinux6 | BmcCtmAgentWindows6 | OSPatchingForLinux6 | VMSnapshot6 | VMSnapshotLinux6 | CustomScript6 | NetworkWatcherAgentWindows6 | NetworkWatcherAgentLinux6)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set network profile.␊ - */␊ - export interface VirtualMachineScaleSetNetworkProfile6 {␊ - /**␊ - * The API entity reference.␊ - */␊ - healthProbe?: (ApiEntityReference5 | string)␊ - /**␊ - * The list of network configurations.␊ - */␊ - networkInterfaceConfigurations?: (VirtualMachineScaleSetNetworkConfiguration5[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The API entity reference.␊ - */␊ - export interface ApiEntityReference5 {␊ - /**␊ - * The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set network profile's network configurations.␊ - */␊ - export interface VirtualMachineScaleSetNetworkConfiguration5 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * The network configuration name.␊ - */␊ - name: string␊ - /**␊ - * Describes a virtual machine scale set network profile's IP configuration.␊ - */␊ - properties?: (VirtualMachineScaleSetNetworkConfigurationProperties5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set network profile's IP configuration.␊ - */␊ - export interface VirtualMachineScaleSetNetworkConfigurationProperties5 {␊ - /**␊ - * Describes a virtual machines scale sets network configuration's DNS settings.␊ - */␊ - dnsSettings?: (VirtualMachineScaleSetNetworkConfigurationDnsSettings4 | string)␊ - /**␊ - * Specifies whether the network interface is accelerated networking-enabled.␊ - */␊ - enableAcceleratedNetworking?: (boolean | string)␊ - /**␊ - * Whether IP forwarding enabled on this NIC.␊ - */␊ - enableIPForwarding?: (boolean | string)␊ - /**␊ - * Specifies the IP configurations of the network interface.␊ - */␊ - ipConfigurations: (VirtualMachineScaleSetIPConfiguration5[] | string)␊ - networkSecurityGroup?: (SubResource38 | string)␊ - /**␊ - * Specifies the primary network interface in case the virtual machine has more than 1 network interface.␊ - */␊ - primary?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machines scale sets network configuration's DNS settings.␊ - */␊ - export interface VirtualMachineScaleSetNetworkConfigurationDnsSettings4 {␊ - /**␊ - * List of DNS servers IP addresses␊ - */␊ - dnsServers?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set network profile's IP configuration.␊ - */␊ - export interface VirtualMachineScaleSetIPConfiguration5 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * The IP configuration name.␊ - */␊ - name: string␊ - /**␊ - * Describes a virtual machine scale set network profile's IP configuration properties.␊ - */␊ - properties?: (VirtualMachineScaleSetIPConfigurationProperties5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set network profile's IP configuration properties.␊ - */␊ - export interface VirtualMachineScaleSetIPConfigurationProperties5 {␊ - /**␊ - * 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.␊ - */␊ - applicationGatewayBackendAddressPools?: (SubResource38[] | string)␊ - /**␊ - * Specifies an array of references to application security group.␊ - */␊ - applicationSecurityGroups?: (SubResource38[] | string)␊ - /**␊ - * 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.␊ - */␊ - loadBalancerBackendAddressPools?: (SubResource38[] | string)␊ - /**␊ - * 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␊ - */␊ - loadBalancerInboundNatPools?: (SubResource38[] | string)␊ - /**␊ - * Specifies the primary network interface in case the virtual machine has more than 1 network interface.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * 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'.␊ - */␊ - privateIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration␊ - */␊ - publicIPAddressConfiguration?: (VirtualMachineScaleSetPublicIPAddressConfiguration4 | string)␊ - /**␊ - * The API entity reference.␊ - */␊ - subnet?: (ApiEntityReference5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration␊ - */␊ - export interface VirtualMachineScaleSetPublicIPAddressConfiguration4 {␊ - /**␊ - * The publicIP address configuration name.␊ - */␊ - name: string␊ - /**␊ - * Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration␊ - */␊ - properties?: (VirtualMachineScaleSetPublicIPAddressConfigurationProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration␊ - */␊ - export interface VirtualMachineScaleSetPublicIPAddressConfigurationProperties4 {␊ - /**␊ - * Describes a virtual machines scale sets network configuration's DNS settings.␊ - */␊ - dnsSettings?: (VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings4 | string)␊ - /**␊ - * The idle timeout of the public IP address.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * The list of IP tags associated with the public IP address.␊ - */␊ - ipTags?: (VirtualMachineScaleSetIpTag2[] | string)␊ - publicIPPrefix?: (SubResource38 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machines scale sets network configuration's DNS settings.␊ - */␊ - export interface VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings4 {␊ - /**␊ - * 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␊ - */␊ - domainNameLabel: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains the IP tag associated with the public IP address.␊ - */␊ - export interface VirtualMachineScaleSetIpTag2 {␊ - /**␊ - * IP tag type. Example: FirstPartyUsage.␊ - */␊ - ipTagType?: string␊ - /**␊ - * IP tag associated with the public IP. Example: SQL, Storage etc.␊ - */␊ - tag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set OS profile.␊ - */␊ - export interface VirtualMachineScaleSetOSProfile5 {␊ - /**␊ - * 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)␊ - */␊ - adminPassword?: string␊ - /**␊ - * 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)␊ - */␊ - adminUsername?: string␊ - /**␊ - * 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.␊ - */␊ - computerNamePrefix?: string␊ - /**␊ - * 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)␊ - */␊ - customData?: string␊ - /**␊ - * 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).␊ - */␊ - linuxConfiguration?: (LinuxConfiguration6 | string)␊ - /**␊ - * Specifies set of certificates that should be installed onto the virtual machines in the scale set.␊ - */␊ - secrets?: (VaultSecretGroup5[] | string)␊ - /**␊ - * Specifies Windows operating system settings on the virtual machine.␊ - */␊ - windowsConfiguration?: (WindowsConfiguration7 | string)␊ - [k: string]: unknown␊ - }␊ - export interface ScheduledEventsProfile {␊ - terminateNotificationProfile?: (TerminateNotificationProfile | string)␊ - [k: string]: unknown␊ - }␊ - export interface TerminateNotificationProfile {␊ - /**␊ - * Specifies whether the Terminate Scheduled event is enabled or disabled.␊ - */␊ - enable?: (boolean | string)␊ - /**␊ - * Configurable length of time a Virtual Machine being deleted will have to potentially approve the Terminate Scheduled Event before the event is auto approved (timed out). The configuration must be specified in ISO 8601 format, the default value is 5 minutes (PT5M)␊ - */␊ - notBeforeTimeout?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set storage profile.␊ - */␊ - export interface VirtualMachineScaleSetStorageProfile6 {␊ - /**␊ - * 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).␊ - */␊ - dataDisks?: (VirtualMachineScaleSetDataDisk5[] | string)␊ - /**␊ - * 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. NOTE: Image reference publisher and offer can only be set when you create the scale set.␊ - */␊ - imageReference?: (ImageReference8 | string)␊ - /**␊ - * Describes a virtual machine scale set operating system disk.␊ - */␊ - osDisk?: (VirtualMachineScaleSetOSDisk6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set data disk.␊ - */␊ - export interface VirtualMachineScaleSetDataDisk5 {␊ - /**␊ - * Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**.␊ - */␊ - caching?: (("None" | "ReadOnly" | "ReadWrite") | string)␊ - /**␊ - * The create option.␊ - */␊ - createOption: (("FromImage" | "Empty" | "Attach") | string)␊ - /**␊ - * Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB␊ - */␊ - diskSizeGB?: (number | string)␊ - /**␊ - * 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.␊ - */␊ - lun: (number | string)␊ - /**␊ - * Describes the parameters of a ScaleSet managed disk.␊ - */␊ - managedDisk?: (VirtualMachineScaleSetManagedDiskParameters5 | string)␊ - /**␊ - * The disk name.␊ - */␊ - name?: string␊ - /**␊ - * Specifies whether writeAccelerator should be enabled or disabled on the disk.␊ - */␊ - writeAcceleratorEnabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the parameters of a ScaleSet managed disk.␊ - */␊ - export interface VirtualMachineScaleSetManagedDiskParameters5 {␊ - /**␊ - * Specifies the storage account type for the managed disk. Managed OS disk storage account type can only be set when you create the scale set. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.␊ - */␊ - storageAccountType?: (("Standard_LRS" | "Premium_LRS" | "StandardSSD_LRS" | "UltraSSD_LRS") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set operating system disk.␊ - */␊ - export interface VirtualMachineScaleSetOSDisk6 {␊ - /**␊ - * Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**.␊ - */␊ - caching?: (("None" | "ReadOnly" | "ReadWrite") | string)␊ - /**␊ - * 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.␊ - */␊ - createOption: (("FromImage" | "Empty" | "Attach") | string)␊ - /**␊ - * Describes the parameters of ephemeral disk settings that can be specified for operating system disk.

    NOTE: The ephemeral disk settings can only be specified for managed disk.␊ - */␊ - diffDiskSettings?: (DiffDiskSettings2 | string)␊ - /**␊ - * Specifies the size of the operating system disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB␊ - */␊ - diskSizeGB?: (number | string)␊ - /**␊ - * Describes the uri of a disk.␊ - */␊ - image?: (VirtualHardDisk5 | string)␊ - /**␊ - * Describes the parameters of a ScaleSet managed disk.␊ - */␊ - managedDisk?: (VirtualMachineScaleSetManagedDiskParameters5 | string)␊ - /**␊ - * The disk name.␊ - */␊ - name?: string␊ - /**␊ - * 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**.␊ - */␊ - osType?: (("Windows" | "Linux") | string)␊ - /**␊ - * Specifies the container urls that are used to store operating system disks for the scale set.␊ - */␊ - vhdContainers?: (string[] | string)␊ - /**␊ - * Specifies whether writeAccelerator should be enabled or disabled on the disk.␊ - */␊ - writeAcceleratorEnabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/virtualMachineScaleSets/extensions␊ - */␊ - export interface VirtualMachineScaleSetsExtensionsChildResource4 {␊ - apiVersion: "2019-03-01"␊ - /**␊ - * The name of the VM scale set extension.␊ - */␊ - name: string␊ - /**␊ - * Describes the properties of a Virtual Machine Scale Set Extension.␊ - */␊ - properties: (VirtualMachineScaleSetExtensionProperties4 | string)␊ - type: "extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the properties of a Virtual Machine Scale Set Extension.␊ - */␊ - export interface VirtualMachineScaleSetExtensionProperties4 {␊ - /**␊ - * 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.␊ - */␊ - autoUpgradeMinorVersion?: (boolean | string)␊ - /**␊ - * 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.␊ - */␊ - forceUpdateTag?: string␊ - /**␊ - * The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.␊ - */␊ - protectedSettings?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Collection of extension names after which this extension needs to be provisioned.␊ - */␊ - provisionAfterExtensions?: (string[] | string)␊ - /**␊ - * The name of the extension handler publisher.␊ - */␊ - publisher?: string␊ - /**␊ - * Json formatted public settings for the extension.␊ - */␊ - settings?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the type of the extension; an example is "CustomScriptExtension".␊ - */␊ - type?: string␊ - /**␊ - * Specifies the version of the script handler.␊ - */␊ - typeHandlerVersion?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/virtualMachineScaleSets/virtualmachines␊ - */␊ - export interface VirtualMachineScaleSetsVirtualmachinesChildResource3 {␊ - apiVersion: "2019-03-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The instance ID of the virtual machine.␊ - */␊ - name: string␊ - /**␊ - * 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**.␊ - */␊ - plan?: (Plan6 | string)␊ - /**␊ - * Describes the properties of a virtual machine scale set virtual machine.␊ - */␊ - properties: (VirtualMachineScaleSetVMProperties3 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "virtualmachines"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the properties of a virtual machine scale set virtual machine.␊ - */␊ - export interface VirtualMachineScaleSetVMProperties3 {␊ - /**␊ - * Enables or disables a capability on the virtual machine or virtual machine scale set.␊ - */␊ - additionalCapabilities?: (AdditionalCapabilities2 | string)␊ - availabilitySet?: (SubResource38 | string)␊ - /**␊ - * Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15.␊ - */␊ - diagnosticsProfile?: (DiagnosticsProfile5 | string)␊ - /**␊ - * Specifies the hardware settings for the virtual machine.␊ - */␊ - hardwareProfile?: (HardwareProfile6 | string)␊ - /**␊ - * 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␊ - */␊ - licenseType?: string␊ - /**␊ - * Specifies the network interfaces of the virtual machine.␊ - */␊ - networkProfile?: (NetworkProfile6 | string)␊ - /**␊ - * Describes a virtual machine scale set VM network profile.␊ - */␊ - networkProfileConfiguration?: (VirtualMachineScaleSetVMNetworkProfileConfiguration | string)␊ - /**␊ - * Specifies the operating system settings for the virtual machine.␊ - */␊ - osProfile?: (OSProfile5 | string)␊ - /**␊ - * The protection policy of a virtual machine scale set VM.␊ - */␊ - protectionPolicy?: (VirtualMachineScaleSetVMProtectionPolicy | string)␊ - /**␊ - * Specifies the storage settings for the virtual machine disks.␊ - */␊ - storageProfile?: (StorageProfile11 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set VM network profile.␊ - */␊ - export interface VirtualMachineScaleSetVMNetworkProfileConfiguration {␊ - /**␊ - * The list of network configurations.␊ - */␊ - networkInterfaceConfigurations?: (VirtualMachineScaleSetNetworkConfiguration5[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The protection policy of a virtual machine scale set VM.␊ - */␊ - export interface VirtualMachineScaleSetVMProtectionPolicy {␊ - /**␊ - * Indicates that the virtual machine scale set VM shouldn't be considered for deletion during a scale-in operation.␊ - */␊ - protectFromScaleIn?: (boolean | string)␊ - /**␊ - * Indicates that model updates or actions (including scale-in) initiated on the virtual machine scale set should not be applied to the virtual machine scale set VM.␊ - */␊ - protectFromScaleSetActions?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/virtualMachineScaleSets/virtualmachines␊ - */␊ - export interface VirtualMachineScaleSetsVirtualmachines2 {␊ - apiVersion: "2019-03-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The instance ID of the virtual machine.␊ - */␊ - name: string␊ - /**␊ - * 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**.␊ - */␊ - plan?: (Plan6 | string)␊ - /**␊ - * Describes the properties of a virtual machine scale set virtual machine.␊ - */␊ - properties: (VirtualMachineScaleSetVMProperties3 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/virtualMachineScaleSets/virtualmachines"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/virtualMachines/extensions␊ - */␊ - export interface VirtualMachinesExtensions5 {␊ - apiVersion: "2019-03-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the virtual machine extension.␊ - */␊ - name: string␊ - properties: (GenericExtension6 | IaaSDiagnostics6 | IaaSAntimalware6 | CustomScriptExtension6 | CustomScriptForLinux6 | LinuxDiagnostic6 | VmAccessForLinux6 | BgInfo6 | VmAccessAgent6 | DscExtension6 | AcronisBackupLinux6 | AcronisBackup6 | LinuxChefClient6 | ChefClient6 | DatadogLinuxAgent6 | DatadogWindowsAgent6 | DockerExtension6 | DynatraceLinux6 | DynatraceWindows6 | Eset6 | HpeSecurityApplicationDefender6 | PuppetAgent6 | Site24X7LinuxServerExtn6 | Site24X7WindowsServerExtn6 | Site24X7ApmInsightExtn6 | TrendMicroDSALinux6 | TrendMicroDSA6 | BmcCtmAgentLinux6 | BmcCtmAgentWindows6 | OSPatchingForLinux6 | VMSnapshot6 | VMSnapshotLinux6 | CustomScript6 | NetworkWatcherAgentWindows6 | NetworkWatcherAgentLinux6)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/virtualMachines/extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/virtualMachineScaleSets/extensions␊ - */␊ - export interface VirtualMachineScaleSetsExtensions3 {␊ - apiVersion: "2019-03-01"␊ - /**␊ - * The name of the VM scale set extension.␊ - */␊ - name: string␊ - properties: (GenericExtension6 | IaaSDiagnostics6 | IaaSAntimalware6 | CustomScriptExtension6 | CustomScriptForLinux6 | LinuxDiagnostic6 | VmAccessForLinux6 | BgInfo6 | VmAccessAgent6 | DscExtension6 | AcronisBackupLinux6 | AcronisBackup6 | LinuxChefClient6 | ChefClient6 | DatadogLinuxAgent6 | DatadogWindowsAgent6 | DockerExtension6 | DynatraceLinux6 | DynatraceWindows6 | Eset6 | HpeSecurityApplicationDefender6 | PuppetAgent6 | Site24X7LinuxServerExtn6 | Site24X7WindowsServerExtn6 | Site24X7ApmInsightExtn6 | TrendMicroDSALinux6 | TrendMicroDSA6 | BmcCtmAgentLinux6 | BmcCtmAgentWindows6 | OSPatchingForLinux6 | VMSnapshot6 | VMSnapshotLinux6 | CustomScript6 | NetworkWatcherAgentWindows6 | NetworkWatcherAgentLinux6)␊ - type: "Microsoft.Compute/virtualMachineScaleSets/extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/galleries␊ - */␊ - export interface Galleries1 {␊ - apiVersion: "2019-03-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the Shared Image Gallery. The allowed characters are alphabets and numbers with dots and periods allowed in the middle. The maximum length is 80 characters.␊ - */␊ - name: string␊ - /**␊ - * Describes the properties of a Shared Image Gallery.␊ - */␊ - properties: (GalleryProperties1 | string)␊ - resources?: (GalleriesImagesChildResource1 | GalleriesApplicationsChildResource)[]␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/galleries"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the properties of a Shared Image Gallery.␊ - */␊ - export interface GalleryProperties1 {␊ - /**␊ - * The description of this Shared Image Gallery resource. This property is updatable.␊ - */␊ - description?: string␊ - /**␊ - * Describes the gallery unique name.␊ - */␊ - identifier?: (GalleryIdentifier1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the gallery unique name.␊ - */␊ - export interface GalleryIdentifier1 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/galleries/images␊ - */␊ - export interface GalleriesImagesChildResource1 {␊ - apiVersion: "2019-03-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the gallery Image Definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters.␊ - */␊ - name: string␊ - /**␊ - * Describes the properties of a gallery Image Definition.␊ - */␊ - properties: (GalleryImageProperties1 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "images"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the properties of a gallery Image Definition.␊ - */␊ - export interface GalleryImageProperties1 {␊ - /**␊ - * The description of this gallery Image Definition resource. This property is updatable.␊ - */␊ - description?: string␊ - /**␊ - * Describes the disallowed disk types.␊ - */␊ - disallowed?: (Disallowed1 | string)␊ - /**␊ - * The end of life date of the gallery Image Definition. This property can be used for decommissioning purposes. This property is updatable.␊ - */␊ - endOfLifeDate?: string␊ - /**␊ - * The Eula agreement for the gallery Image Definition.␊ - */␊ - eula?: string␊ - /**␊ - * This is the gallery Image Definition identifier.␊ - */␊ - identifier: (GalleryImageIdentifier1 | string)␊ - /**␊ - * This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'.␊ - */␊ - osState: (("Generalized" | "Specialized") | string)␊ - /**␊ - * This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image.

    Possible values are:

    **Windows**

    **Linux**.␊ - */␊ - osType: (("Windows" | "Linux") | string)␊ - /**␊ - * The privacy statement uri.␊ - */␊ - privacyStatementUri?: string␊ - /**␊ - * Describes the gallery Image Definition purchase plan. This is used by marketplace images.␊ - */␊ - purchasePlan?: (ImagePurchasePlan1 | string)␊ - /**␊ - * The properties describe the recommended machine configuration for this Image Definition. These properties are updatable.␊ - */␊ - recommended?: (RecommendedMachineConfiguration1 | string)␊ - /**␊ - * The release note uri.␊ - */␊ - releaseNoteUri?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the disallowed disk types.␊ - */␊ - export interface Disallowed1 {␊ - /**␊ - * A list of disk types.␊ - */␊ - diskTypes?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * This is the gallery Image Definition identifier.␊ - */␊ - export interface GalleryImageIdentifier1 {␊ - /**␊ - * The name of the gallery Image Definition offer.␊ - */␊ - offer: string␊ - /**␊ - * The name of the gallery Image Definition publisher.␊ - */␊ - publisher: string␊ - /**␊ - * The name of the gallery Image Definition SKU.␊ - */␊ - sku: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the gallery Image Definition purchase plan. This is used by marketplace images.␊ - */␊ - export interface ImagePurchasePlan1 {␊ - /**␊ - * The plan ID.␊ - */␊ - name?: string␊ - /**␊ - * The product ID.␊ - */␊ - product?: string␊ - /**␊ - * The publisher ID.␊ - */␊ - publisher?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties describe the recommended machine configuration for this Image Definition. These properties are updatable.␊ - */␊ - export interface RecommendedMachineConfiguration1 {␊ - /**␊ - * Describes the resource range.␊ - */␊ - memory?: (ResourceRange1 | string)␊ - /**␊ - * Describes the resource range.␊ - */␊ - vCPUs?: (ResourceRange1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the resource range.␊ - */␊ - export interface ResourceRange1 {␊ - /**␊ - * The maximum number of the resource.␊ - */␊ - max?: (number | string)␊ - /**␊ - * The minimum number of the resource.␊ - */␊ - min?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/galleries/applications␊ - */␊ - export interface GalleriesApplicationsChildResource {␊ - apiVersion: "2019-03-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the gallery Application Definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters.␊ - */␊ - name: string␊ - /**␊ - * Describes the properties of a gallery Application Definition.␊ - */␊ - properties: (GalleryApplicationProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "applications"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the properties of a gallery Application Definition.␊ - */␊ - export interface GalleryApplicationProperties {␊ - /**␊ - * The description of this gallery Application Definition resource. This property is updatable.␊ - */␊ - description?: string␊ - /**␊ - * The end of life date of the gallery Application Definition. This property can be used for decommissioning purposes. This property is updatable.␊ - */␊ - endOfLifeDate?: string␊ - /**␊ - * The Eula agreement for the gallery Application Definition.␊ - */␊ - eula?: string␊ - /**␊ - * The privacy statement uri.␊ - */␊ - privacyStatementUri?: string␊ - /**␊ - * The release note uri.␊ - */␊ - releaseNoteUri?: string␊ - /**␊ - * This property allows you to specify the supported type of the OS that application is built for.

    Possible values are:

    **Windows**

    **Linux**.␊ - */␊ - supportedOSType: (("Windows" | "Linux") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/galleries/images␊ - */␊ - export interface GalleriesImages1 {␊ - apiVersion: "2019-03-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the gallery Image Definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters.␊ - */␊ - name: string␊ - /**␊ - * Describes the properties of a gallery Image Definition.␊ - */␊ - properties: (GalleryImageProperties1 | string)␊ - resources?: GalleriesImagesVersionsChildResource1[]␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/galleries/images"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/galleries/images/versions␊ - */␊ - export interface GalleriesImagesVersionsChildResource1 {␊ - apiVersion: "2019-03-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the gallery Image Version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: ..␊ - */␊ - name: string␊ - /**␊ - * Describes the properties of a gallery Image Version.␊ - */␊ - properties: (GalleryImageVersionProperties1 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "versions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the properties of a gallery Image Version.␊ - */␊ - export interface GalleryImageVersionProperties1 {␊ - /**␊ - * The publishing profile of a gallery Image Version.␊ - */␊ - publishingProfile: (GalleryImageVersionPublishingProfile1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The publishing profile of a gallery Image Version.␊ - */␊ - export interface GalleryImageVersionPublishingProfile1 {␊ - /**␊ - * The end of life date of the gallery Image Version. This property can be used for decommissioning purposes. This property is updatable.␊ - */␊ - endOfLifeDate?: string␊ - /**␊ - * If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version.␊ - */␊ - excludeFromLatest?: (boolean | string)␊ - /**␊ - * The number of replicas of the Image Version to be created per region. This property would take effect for a region when regionalReplicaCount is not specified. This property is updatable.␊ - */␊ - replicaCount?: (number | string)␊ - /**␊ - * The source image from which the Image Version is going to be created.␊ - */␊ - source: (GalleryArtifactSource1 | string)␊ - /**␊ - * Specifies the storage account type to be used to store the image. This property is not updatable.␊ - */␊ - storageAccountType?: (("Standard_LRS" | "Standard_ZRS") | string)␊ - /**␊ - * The target regions where the Image Version is going to be replicated to. This property is updatable.␊ - */␊ - targetRegions?: (TargetRegion1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The source image from which the Image Version is going to be created.␊ - */␊ - export interface GalleryArtifactSource1 {␊ - /**␊ - * The managed artifact.␊ - */␊ - managedImage: (ManagedArtifact1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The managed artifact.␊ - */␊ - export interface ManagedArtifact1 {␊ - /**␊ - * The managed artifact id.␊ - */␊ - id: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the target region information.␊ - */␊ - export interface TargetRegion1 {␊ - /**␊ - * The name of the region.␊ - */␊ - name: string␊ - /**␊ - * The number of replicas of the Image Version to be created per region. This property is updatable.␊ - */␊ - regionalReplicaCount?: (number | string)␊ - /**␊ - * Specifies the storage account type to be used to store the image. This property is not updatable.␊ - */␊ - storageAccountType?: (("Standard_LRS" | "Standard_ZRS") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/galleries/images/versions␊ - */␊ - export interface GalleriesImagesVersions1 {␊ - apiVersion: "2019-03-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the gallery Image Version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: ..␊ - */␊ - name: string␊ - /**␊ - * Describes the properties of a gallery Image Version.␊ - */␊ - properties: (GalleryImageVersionProperties1 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/galleries/images/versions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.IoTCentral/iotApps␊ - */␊ - export interface IotApps {␊ - apiVersion: "2018-09-01"␊ - /**␊ - * The resource location.␊ - */␊ - location: string␊ - /**␊ - * The ARM resource name of the IoT Central application.␊ - */␊ - name: string␊ - /**␊ - * The properties of an IoT Central application.␊ - */␊ - properties: (AppProperties | string)␊ - /**␊ - * Information about the SKU of the IoT Central application.␊ - */␊ - sku: (AppSkuInfo | string)␊ - /**␊ - * The resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.IoTCentral/iotApps"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of an IoT Central application.␊ - */␊ - export interface AppProperties {␊ - /**␊ - * The display name of the application.␊ - */␊ - displayName?: string␊ - /**␊ - * The subdomain of the application.␊ - */␊ - subdomain?: string␊ - /**␊ - * The ID of the application template, which is a blueprint that defines the characteristics and behaviors of an application. Optional; if not specified, defaults to a blank blueprint and allows the application to be defined from scratch.␊ - */␊ - template?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the SKU of the IoT Central application.␊ - */␊ - export interface AppSkuInfo {␊ - /**␊ - * The name of the SKU.␊ - */␊ - name: (("F1" | "S1" | "ST0" | "ST1" | "ST2") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Maps/accounts␊ - */␊ - export interface Accounts8 {␊ - apiVersion: "2018-05-01"␊ - /**␊ - * The location of the resource.␊ - */␊ - location: string␊ - /**␊ - * The name of the Maps Account.␊ - */␊ - name: string␊ - /**␊ - * The SKU of the Maps Account.␊ - */␊ - sku: (Sku57 | string)␊ - /**␊ - * Gets or sets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Maps/accounts"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The SKU of the Maps Account.␊ - */␊ - export interface Sku57 {␊ - /**␊ - * The name of the SKU, in standard format (such as S0).␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.BatchAI/workspaces␊ - */␊ - export interface Workspaces8 {␊ - apiVersion: "2018-05-01"␊ - /**␊ - * The region in which to create the Workspace.␊ - */␊ - location: string␊ - /**␊ - * The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.␊ - */␊ - name: string␊ - resources?: (WorkspacesExperimentsChildResource | WorkspacesFileServersChildResource | WorkspacesClustersChildResource)[]␊ - /**␊ - * The user specified tags associated with the Workspace.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.BatchAI/workspaces"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.BatchAI/workspaces/experiments␊ - */␊ - export interface WorkspacesExperimentsChildResource {␊ - apiVersion: "2018-05-01"␊ - /**␊ - * The name of the experiment. Experiment names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.␊ - */␊ - name: string␊ - type: "experiments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.BatchAI/workspaces/fileServers␊ - */␊ - export interface WorkspacesFileServersChildResource {␊ - apiVersion: "2018-05-01"␊ - /**␊ - * The name of the file server within the specified resource group. File server names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.␊ - */␊ - name: string␊ - /**␊ - * The properties of a file server.␊ - */␊ - properties: (FileServerBaseProperties1 | string)␊ - type: "fileServers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a file server.␊ - */␊ - export interface FileServerBaseProperties1 {␊ - /**␊ - * Data disks settings.␊ - */␊ - dataDisks: (DataDisks1 | string)␊ - /**␊ - * SSH configuration.␊ - */␊ - sshConfiguration: (SshConfiguration7 | string)␊ - /**␊ - * Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet.␊ - */␊ - subnet?: (ResourceId6 | string)␊ - /**␊ - * The size of the virtual machine for the File Server. For information about available VM sizes from the Virtual Machines Marketplace, see Sizes for Virtual Machines (Linux).␊ - */␊ - vmSize: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Data disks settings.␊ - */␊ - export interface DataDisks1 {␊ - /**␊ - * Caching type for the disks. Available values are none (default), readonly, readwrite. Caching type can be set only for VM sizes supporting premium storage.␊ - */␊ - cachingType?: (("none" | "readonly" | "readwrite") | string)␊ - /**␊ - * Number of data disks attached to the File Server. If multiple disks attached, they will be configured in RAID level 0.␊ - */␊ - diskCount: (number | string)␊ - /**␊ - * Disk size in GB for the blank data disks.␊ - */␊ - diskSizeInGB: (number | string)␊ - /**␊ - * Type of storage account to be used on the disk. Possible values are: Standard_LRS or Premium_LRS. Premium storage account type can only be used with VM sizes supporting premium storage.␊ - */␊ - storageAccountType: (("Standard_LRS" | "Premium_LRS") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSH configuration.␊ - */␊ - export interface SshConfiguration7 {␊ - /**␊ - * List of source IP ranges to allow SSH connection from. The default value is '*' (all source IPs are allowed). Maximum number of IP ranges that can be specified is 400.␊ - */␊ - publicIPsToAllow?: (string[] | string)␊ - /**␊ - * Settings for user account that gets created on each on the nodes of a cluster.␊ - */␊ - userAccountSettings: (UserAccountSettings1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Settings for user account that gets created on each on the nodes of a cluster.␊ - */␊ - export interface UserAccountSettings1 {␊ - /**␊ - * Name of the administrator user account which can be used to SSH to nodes.␊ - */␊ - adminUserName: string␊ - /**␊ - * Password of the administrator user account.␊ - */␊ - adminUserPassword?: string␊ - /**␊ - * SSH public key of the administrator user account.␊ - */␊ - adminUserSshPublicKey?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet.␊ - */␊ - export interface ResourceId6 {␊ - /**␊ - * The ID of the resource␊ - */␊ - id: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.BatchAI/workspaces/clusters␊ - */␊ - export interface WorkspacesClustersChildResource {␊ - apiVersion: "2018-05-01"␊ - /**␊ - * The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.␊ - */␊ - name: string␊ - /**␊ - * The properties of a Cluster.␊ - */␊ - properties: (ClusterBaseProperties1 | string)␊ - type: "clusters"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a Cluster.␊ - */␊ - export interface ClusterBaseProperties1 {␊ - /**␊ - * Node setup settings.␊ - */␊ - nodeSetup?: (NodeSetup1 | string)␊ - /**␊ - * At least one of manual or autoScale settings must be specified. Only one of manual or autoScale settings can be specified. If autoScale settings are specified, the system automatically scales the cluster up and down (within the supplied limits) based on the pending jobs on the cluster.␊ - */␊ - scaleSettings?: (ScaleSettings8 | string)␊ - /**␊ - * Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet.␊ - */␊ - subnet?: (ResourceId6 | string)␊ - /**␊ - * Settings for user account that gets created on each on the nodes of a cluster.␊ - */␊ - userAccountSettings: (UserAccountSettings1 | string)␊ - /**␊ - * VM configuration.␊ - */␊ - virtualMachineConfiguration?: (VirtualMachineConfiguration2 | string)␊ - /**␊ - * VM priority. Allowed values are: dedicated (default) and lowpriority.␊ - */␊ - vmPriority?: (("dedicated" | "lowpriority") | string)␊ - /**␊ - * The size of the virtual machines in the cluster. All nodes in a cluster have the same VM size. For information about available VM sizes for clusters using images from the Virtual Machines Marketplace see Sizes for Virtual Machines (Linux). Batch AI service supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series).␊ - */␊ - vmSize: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Node setup settings.␊ - */␊ - export interface NodeSetup1 {␊ - /**␊ - * Details of volumes to mount on the cluster.␊ - */␊ - mountVolumes?: (MountVolumes1 | string)␊ - /**␊ - * Performance counters reporting settings.␊ - */␊ - performanceCountersSettings?: (PerformanceCountersSettings1 | string)␊ - /**␊ - * Specifies a setup task which can be used to customize the compute nodes of the cluster.␊ - */␊ - setupTask?: (SetupTask1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Details of volumes to mount on the cluster.␊ - */␊ - export interface MountVolumes1 {␊ - /**␊ - * A collection of Azure Blob Containers that are to be mounted to the cluster nodes.␊ - */␊ - azureBlobFileSystems?: (AzureBlobFileSystemReference1[] | string)␊ - /**␊ - * A collection of Azure File Shares that are to be mounted to the cluster nodes.␊ - */␊ - azureFileShares?: (AzureFileShareReference1[] | string)␊ - /**␊ - * A collection of Batch AI File Servers that are to be mounted to the cluster nodes.␊ - */␊ - fileServers?: (FileServerReference1[] | string)␊ - /**␊ - * A collection of unmanaged file systems that are to be mounted to the cluster nodes.␊ - */␊ - unmanagedFileSystems?: (UnmanagedFileSystemReference1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Blob Storage Container mounting configuration.␊ - */␊ - export interface AzureBlobFileSystemReference1 {␊ - /**␊ - * Name of the Azure storage account.␊ - */␊ - accountName: string␊ - /**␊ - * Name of the Azure Blob Storage container to mount on the cluster.␊ - */␊ - containerName: string␊ - /**␊ - * Azure storage account credentials.␊ - */␊ - credentials: (AzureStorageCredentialsInfo1 | string)␊ - /**␊ - * Mount options for mounting blobfuse file system.␊ - */␊ - mountOptions?: string␊ - /**␊ - * The relative path on the compute node where the Azure File container will be mounted. Note that all cluster level containers will be mounted under $AZ_BATCHAI_MOUNT_ROOT location and all job level containers will be mounted under $AZ_BATCHAI_JOB_MOUNT_ROOT.␊ - */␊ - relativeMountPath: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure storage account credentials.␊ - */␊ - export interface AzureStorageCredentialsInfo1 {␊ - /**␊ - * Storage account key. One of accountKey or accountKeySecretReference must be specified.␊ - */␊ - accountKey?: string␊ - /**␊ - * Key Vault Secret reference.␊ - */␊ - accountKeySecretReference?: (KeyVaultSecretReference7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Key Vault Secret reference.␊ - */␊ - export interface KeyVaultSecretReference7 {␊ - /**␊ - * The URL referencing a secret in the Key Vault.␊ - */␊ - secretUrl: string␊ - /**␊ - * Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet.␊ - */␊ - sourceVault: (ResourceId6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure File Share mounting configuration.␊ - */␊ - export interface AzureFileShareReference1 {␊ - /**␊ - * Name of the Azure storage account.␊ - */␊ - accountName: string␊ - /**␊ - * URL to access the Azure File.␊ - */␊ - azureFileUrl: string␊ - /**␊ - * Azure storage account credentials.␊ - */␊ - credentials: (AzureStorageCredentialsInfo1 | string)␊ - /**␊ - * File mode for directories on the mounted file share. Default value: 0777.␊ - */␊ - directoryMode?: string␊ - /**␊ - * File mode for files on the mounted file share. Default value: 0777.␊ - */␊ - fileMode?: string␊ - /**␊ - * The relative path on the compute node where the Azure File share will be mounted. Note that all cluster level file shares will be mounted under $AZ_BATCHAI_MOUNT_ROOT location and all job level file shares will be mounted under $AZ_BATCHAI_JOB_MOUNT_ROOT.␊ - */␊ - relativeMountPath: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * File Server mounting configuration.␊ - */␊ - export interface FileServerReference1 {␊ - /**␊ - * Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet.␊ - */␊ - fileServer: (ResourceId6 | string)␊ - /**␊ - * Mount options to be passed to mount command.␊ - */␊ - mountOptions?: string␊ - /**␊ - * The relative path on the compute node where the File Server will be mounted. Note that all cluster level file servers will be mounted under $AZ_BATCHAI_MOUNT_ROOT location and all job level file servers will be mounted under $AZ_BATCHAI_JOB_MOUNT_ROOT.␊ - */␊ - relativeMountPath: string␊ - /**␊ - * File Server directory that needs to be mounted. If this property is not specified, the entire File Server will be mounted.␊ - */␊ - sourceDirectory?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Unmanaged file system mounting configuration.␊ - */␊ - export interface UnmanagedFileSystemReference1 {␊ - /**␊ - * Mount command line. Note, Batch AI will append mount path to the command on its own.␊ - */␊ - mountCommand: string␊ - /**␊ - * The relative path on the compute node where the unmanaged file system will be mounted. Note that all cluster level unmanaged file systems will be mounted under $AZ_BATCHAI_MOUNT_ROOT location and all job level unmanaged file systems will be mounted under $AZ_BATCHAI_JOB_MOUNT_ROOT.␊ - */␊ - relativeMountPath: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Performance counters reporting settings.␊ - */␊ - export interface PerformanceCountersSettings1 {␊ - /**␊ - * Azure Application Insights information for performance counters reporting.␊ - */␊ - appInsightsReference: (AppInsightsReference1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Application Insights information for performance counters reporting.␊ - */␊ - export interface AppInsightsReference1 {␊ - /**␊ - * Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet.␊ - */␊ - component: (ResourceId6 | string)␊ - /**␊ - * Value of the Azure Application Insights instrumentation key.␊ - */␊ - instrumentationKey?: string␊ - /**␊ - * Key Vault Secret reference.␊ - */␊ - instrumentationKeySecretReference?: (KeyVaultSecretReference7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies a setup task which can be used to customize the compute nodes of the cluster.␊ - */␊ - export interface SetupTask1 {␊ - /**␊ - * The command line to be executed on each cluster's node after it being allocated or rebooted. The command is executed in a bash subshell as a root.␊ - */␊ - commandLine: string␊ - /**␊ - * A collection of user defined environment variables to be set for setup task.␊ - */␊ - environmentVariables?: (EnvironmentVariable3[] | string)␊ - /**␊ - * A collection of user defined environment variables with secret values to be set for the setup task. Server will never report values of these variables back.␊ - */␊ - secrets?: (EnvironmentVariableWithSecretValue1[] | string)␊ - /**␊ - * The prefix of a path where the Batch AI service will upload the stdout, stderr and execution log of the setup task.␊ - */␊ - stdOutErrPathPrefix: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An environment variable definition.␊ - */␊ - export interface EnvironmentVariable3 {␊ - /**␊ - * The name of the environment variable.␊ - */␊ - name: string␊ - /**␊ - * The value of the environment variable.␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An environment variable with secret value definition.␊ - */␊ - export interface EnvironmentVariableWithSecretValue1 {␊ - /**␊ - * The name of the environment variable to store the secret value.␊ - */␊ - name: string␊ - /**␊ - * The value of the environment variable. This value will never be reported back by Batch AI.␊ - */␊ - value?: string␊ - /**␊ - * Key Vault Secret reference.␊ - */␊ - valueSecretReference?: (KeyVaultSecretReference7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * At least one of manual or autoScale settings must be specified. Only one of manual or autoScale settings can be specified. If autoScale settings are specified, the system automatically scales the cluster up and down (within the supplied limits) based on the pending jobs on the cluster.␊ - */␊ - export interface ScaleSettings8 {␊ - /**␊ - * Auto-scale settings for the cluster. The system automatically scales the cluster up and down (within minimumNodeCount and maximumNodeCount) based on the number of queued and running jobs assigned to the cluster.␊ - */␊ - autoScale?: (AutoScaleSettings2 | string)␊ - /**␊ - * Manual scale settings for the cluster.␊ - */␊ - manual?: (ManualScaleSettings1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Auto-scale settings for the cluster. The system automatically scales the cluster up and down (within minimumNodeCount and maximumNodeCount) based on the number of queued and running jobs assigned to the cluster.␊ - */␊ - export interface AutoScaleSettings2 {␊ - /**␊ - * The number of compute nodes to allocate on cluster creation. Note that this value is used only during cluster creation. Default: 0.␊ - */␊ - initialNodeCount?: ((number & string) | string)␊ - /**␊ - * The maximum number of compute nodes the cluster can have.␊ - */␊ - maximumNodeCount: (number | string)␊ - /**␊ - * The minimum number of compute nodes the Batch AI service will try to allocate for the cluster. Note, the actual number of nodes can be less than the specified value if the subscription has not enough quota to fulfill the request.␊ - */␊ - minimumNodeCount: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Manual scale settings for the cluster.␊ - */␊ - export interface ManualScaleSettings1 {␊ - /**␊ - * An action to be performed when the cluster size is decreasing. The default value is requeue.␊ - */␊ - nodeDeallocationOption?: (("requeue" | "terminate" | "waitforjobcompletion") | string)␊ - /**␊ - * The desired number of compute nodes in the Cluster. Default is 0.␊ - */␊ - targetNodeCount: ((number & string) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VM configuration.␊ - */␊ - export interface VirtualMachineConfiguration2 {␊ - /**␊ - * The OS image reference.␊ - */␊ - imageReference?: (ImageReference9 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The OS image reference.␊ - */␊ - export interface ImageReference9 {␊ - /**␊ - * Offer of the image.␊ - */␊ - offer: string␊ - /**␊ - * Publisher of the image.␊ - */␊ - publisher: string␊ - /**␊ - * SKU of the image.␊ - */␊ - sku: string␊ - /**␊ - * Version of the image.␊ - */␊ - version?: string␊ - /**␊ - * The ARM resource identifier of the virtual machine image for the compute nodes. This is of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}. The virtual machine image must be in the same region and subscription as the cluster. 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. Note, you need to provide publisher, offer and sku of the base OS image of which the custom image has been derived from.␊ - */␊ - virtualMachineImageId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.BatchAI/workspaces/clusters␊ - */␊ - export interface WorkspacesClusters {␊ - apiVersion: "2018-05-01"␊ - /**␊ - * The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.␊ - */␊ - name: string␊ - /**␊ - * The properties of a Cluster.␊ - */␊ - properties: (ClusterBaseProperties1 | string)␊ - type: "Microsoft.BatchAI/workspaces/clusters"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.BatchAI/workspaces/experiments␊ - */␊ - export interface WorkspacesExperiments {␊ - apiVersion: "2018-05-01"␊ - /**␊ - * The name of the experiment. Experiment names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.␊ - */␊ - name: string␊ - resources?: WorkspacesExperimentsJobsChildResource[]␊ - type: "Microsoft.BatchAI/workspaces/experiments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.BatchAI/workspaces/experiments/jobs␊ - */␊ - export interface WorkspacesExperimentsJobsChildResource {␊ - apiVersion: "2018-05-01"␊ - /**␊ - * The name of the job within the specified resource group. Job names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.␊ - */␊ - name: string␊ - /**␊ - * The properties of a Batch AI Job.␊ - */␊ - properties: (JobBaseProperties1 | string)␊ - type: "jobs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a Batch AI Job.␊ - */␊ - export interface JobBaseProperties1 {␊ - /**␊ - * Caffe2 job settings.␊ - */␊ - caffe2Settings?: (Caffe2Settings1 | string)␊ - /**␊ - * Caffe job settings.␊ - */␊ - caffeSettings?: (CaffeSettings1 | string)␊ - /**␊ - * Chainer job settings.␊ - */␊ - chainerSettings?: (ChainerSettings1 | string)␊ - /**␊ - * Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet.␊ - */␊ - cluster: (ResourceId6 | string)␊ - /**␊ - * CNTK (aka Microsoft Cognitive Toolkit) job settings.␊ - */␊ - cntkSettings?: (CNTKsettings1 | string)␊ - /**␊ - * Constraints associated with the Job.␊ - */␊ - constraints?: (JobBasePropertiesConstraints1 | string)␊ - /**␊ - * Docker container settings.␊ - */␊ - containerSettings?: (ContainerSettings1 | string)␊ - /**␊ - * Custom MPI job settings.␊ - */␊ - customMpiSettings?: (CustomMpiSettings | string)␊ - /**␊ - * Custom tool kit job settings.␊ - */␊ - customToolkitSettings?: (CustomToolkitSettings1 | string)␊ - /**␊ - * A list of user defined environment variables which will be setup for the job.␊ - */␊ - environmentVariables?: (EnvironmentVariable3[] | string)␊ - /**␊ - * Specifies the settings for Horovod job.␊ - */␊ - horovodSettings?: (HorovodSettings | string)␊ - /**␊ - * A list of input directories for the job.␊ - */␊ - inputDirectories?: (InputDirectory1[] | string)␊ - /**␊ - * Job preparation settings.␊ - */␊ - jobPreparation?: (JobPreparation1 | string)␊ - /**␊ - * Details of volumes to mount on the cluster.␊ - */␊ - mountVolumes?: (MountVolumes1 | string)␊ - /**␊ - * Number of compute nodes to run the job on. The job will be gang scheduled on that many compute nodes.␊ - */␊ - nodeCount: (number | string)␊ - /**␊ - * A list of output directories for the job.␊ - */␊ - outputDirectories?: (OutputDirectory1[] | string)␊ - /**␊ - * pyTorch job settings.␊ - */␊ - pyTorchSettings?: (PyTorchSettings1 | string)␊ - /**␊ - * Scheduling priority associated with the job. Possible values: low, normal, high.␊ - */␊ - schedulingPriority?: (("low" | "normal" | "high") | string)␊ - /**␊ - * A list of user defined environment variables with secret values which will be setup for the job. Server will never report values of these variables back.␊ - */␊ - secrets?: (EnvironmentVariableWithSecretValue1[] | string)␊ - /**␊ - * The path where the Batch AI service will store stdout, stderror and execution log of the job.␊ - */␊ - stdOutErrPathPrefix: string␊ - /**␊ - * TensorFlow job settings.␊ - */␊ - tensorFlowSettings?: (TensorFlowSettings1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Caffe2 job settings.␊ - */␊ - export interface Caffe2Settings1 {␊ - /**␊ - * Command line arguments that need to be passed to the python script.␊ - */␊ - commandLineArgs?: string␊ - /**␊ - * The path to the Python interpreter.␊ - */␊ - pythonInterpreterPath?: string␊ - /**␊ - * The python script to execute.␊ - */␊ - pythonScriptFilePath: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Caffe job settings.␊ - */␊ - export interface CaffeSettings1 {␊ - /**␊ - * Command line arguments that need to be passed to the Caffe job.␊ - */␊ - commandLineArgs?: string␊ - /**␊ - * Path of the config file for the job. This property cannot be specified if pythonScriptFilePath is specified.␊ - */␊ - configFilePath?: string␊ - /**␊ - * Number of processes to launch for the job execution. The default value for this property is equal to nodeCount property␊ - */␊ - processCount?: (number | string)␊ - /**␊ - * The path to the Python interpreter. The property can be specified only if the pythonScriptFilePath is specified.␊ - */␊ - pythonInterpreterPath?: string␊ - /**␊ - * Python script to execute. This property cannot be specified if configFilePath is specified.␊ - */␊ - pythonScriptFilePath?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Chainer job settings.␊ - */␊ - export interface ChainerSettings1 {␊ - /**␊ - * Command line arguments that need to be passed to the python script.␊ - */␊ - commandLineArgs?: string␊ - /**␊ - * Number of processes to launch for the job execution. The default value for this property is equal to nodeCount property␊ - */␊ - processCount?: (number | string)␊ - /**␊ - * The path to the Python interpreter.␊ - */␊ - pythonInterpreterPath?: string␊ - /**␊ - * The python script to execute.␊ - */␊ - pythonScriptFilePath: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * CNTK (aka Microsoft Cognitive Toolkit) job settings.␊ - */␊ - export interface CNTKsettings1 {␊ - /**␊ - * Command line arguments that need to be passed to the python script or cntk executable.␊ - */␊ - commandLineArgs?: string␊ - /**␊ - * Specifies the path of the BrainScript config file. This property can be specified only if the languageType is 'BrainScript'.␊ - */␊ - configFilePath?: string␊ - /**␊ - * The language to use for launching CNTK (aka Microsoft Cognitive Toolkit) job. Valid values are 'BrainScript' or 'Python'.␊ - */␊ - languageType?: string␊ - /**␊ - * Number of processes to launch for the job execution. The default value for this property is equal to nodeCount property␊ - */␊ - processCount?: (number | string)␊ - /**␊ - * The path to the Python interpreter. This property can be specified only if the languageType is 'Python'.␊ - */␊ - pythonInterpreterPath?: string␊ - /**␊ - * Python script to execute. This property can be specified only if the languageType is 'Python'.␊ - */␊ - pythonScriptFilePath?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Constraints associated with the Job.␊ - */␊ - export interface JobBasePropertiesConstraints1 {␊ - /**␊ - * Max time the job can run. Default value: 1 week.␊ - */␊ - maxWallClockTime?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Docker container settings.␊ - */␊ - export interface ContainerSettings1 {␊ - /**␊ - * Information about docker image for the job.␊ - */␊ - imageSourceRegistry: (ImageSourceRegistry1 | string)␊ - /**␊ - * Size of /dev/shm. Please refer to docker documentation for supported argument formats.␊ - */␊ - shmSize?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about docker image for the job.␊ - */␊ - export interface ImageSourceRegistry1 {␊ - /**␊ - * Credentials to access a container image in a private repository.␊ - */␊ - credentials?: (PrivateRegistryCredentials1 | string)␊ - /**␊ - * The name of the image in the image repository.␊ - */␊ - image: string␊ - /**␊ - * URL for image repository.␊ - */␊ - serverUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Credentials to access a container image in a private repository.␊ - */␊ - export interface PrivateRegistryCredentials1 {␊ - /**␊ - * User password to login to the docker repository. One of password or passwordSecretReference must be specified.␊ - */␊ - password?: string␊ - /**␊ - * Key Vault Secret reference.␊ - */␊ - passwordSecretReference?: (KeyVaultSecretReference7 | string)␊ - /**␊ - * User name to login to the repository.␊ - */␊ - username: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Custom MPI job settings.␊ - */␊ - export interface CustomMpiSettings {␊ - /**␊ - * The command line to be executed by mpi runtime on each compute node.␊ - */␊ - commandLine: string␊ - /**␊ - * Number of processes to launch for the job execution. The default value for this property is equal to nodeCount property␊ - */␊ - processCount?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Custom tool kit job settings.␊ - */␊ - export interface CustomToolkitSettings1 {␊ - /**␊ - * The command line to execute on the master node.␊ - */␊ - commandLine?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the settings for Horovod job.␊ - */␊ - export interface HorovodSettings {␊ - /**␊ - * Command line arguments that need to be passed to the python script.␊ - */␊ - commandLineArgs?: string␊ - /**␊ - * Number of processes to launch for the job execution. The default value for this property is equal to nodeCount property␊ - */␊ - processCount?: (number | string)␊ - /**␊ - * The path to the Python interpreter.␊ - */␊ - pythonInterpreterPath?: string␊ - /**␊ - * The python script to execute.␊ - */␊ - pythonScriptFilePath: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Input directory for the job.␊ - */␊ - export interface InputDirectory1 {␊ - /**␊ - * The ID for the input directory. The job can use AZ_BATCHAI_INPUT_ environment variable to find the directory path, where is the value of id attribute.␊ - */␊ - id: string␊ - /**␊ - * The path to the input directory.␊ - */␊ - path: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Job preparation settings.␊ - */␊ - export interface JobPreparation1 {␊ - /**␊ - * The command line to execute. If containerSettings is specified on the job, this commandLine will be executed in the same container as job. Otherwise it will be executed on the node.␊ - */␊ - commandLine: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Output directory for the job.␊ - */␊ - export interface OutputDirectory1 {␊ - /**␊ - * The ID of the output directory. The job can use AZ_BATCHAI_OUTPUT_ environment variable to find the directory path, where is the value of id attribute.␊ - */␊ - id: string␊ - /**␊ - * The prefix path where the output directory will be created. Note, this is an absolute path to prefix. E.g. $AZ_BATCHAI_MOUNT_ROOT/MyNFS/MyLogs. The full path to the output directory by combining pathPrefix, jobOutputDirectoryPathSegment (reported by get job) and pathSuffix.␊ - */␊ - pathPrefix: string␊ - /**␊ - * The suffix path where the output directory will be created. E.g. models. You can find the full path to the output directory by combining pathPrefix, jobOutputDirectoryPathSegment (reported by get job) and pathSuffix.␊ - */␊ - pathSuffix?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * pyTorch job settings.␊ - */␊ - export interface PyTorchSettings1 {␊ - /**␊ - * Command line arguments that need to be passed to the python script.␊ - */␊ - commandLineArgs?: string␊ - /**␊ - * Type of the communication backend for distributed jobs. Valid values are 'TCP', 'Gloo' or 'MPI'. Not required for non-distributed jobs.␊ - */␊ - communicationBackend?: string␊ - /**␊ - * Number of processes to launch for the job execution. The default value for this property is equal to nodeCount property␊ - */␊ - processCount?: (number | string)␊ - /**␊ - * The path to the Python interpreter.␊ - */␊ - pythonInterpreterPath?: string␊ - /**␊ - * The python script to execute.␊ - */␊ - pythonScriptFilePath: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * TensorFlow job settings.␊ - */␊ - export interface TensorFlowSettings1 {␊ - /**␊ - * Command line arguments that need to be passed to the python script for the master task.␊ - */␊ - masterCommandLineArgs?: string␊ - /**␊ - * Command line arguments that need to be passed to the python script for the parameter server. Optional for single process jobs.␊ - */␊ - parameterServerCommandLineArgs?: string␊ - /**␊ - * The number of parameter server tasks. If specified, the value must be less than or equal to nodeCount. If not specified, the default value is equal to 1 for distributed TensorFlow training. This property can be specified only for distributed TensorFlow training.␊ - */␊ - parameterServerCount?: (number | string)␊ - /**␊ - * The path to the Python interpreter.␊ - */␊ - pythonInterpreterPath?: string␊ - /**␊ - * The python script to execute.␊ - */␊ - pythonScriptFilePath: string␊ - /**␊ - * Command line arguments that need to be passed to the python script for the worker task. Optional for single process jobs.␊ - */␊ - workerCommandLineArgs?: string␊ - /**␊ - * The number of worker tasks. If specified, the value must be less than or equal to (nodeCount * numberOfGPUs per VM). If not specified, the default value is equal to nodeCount. This property can be specified only for distributed TensorFlow training.␊ - */␊ - workerCount?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.BatchAI/workspaces/experiments/jobs␊ - */␊ - export interface WorkspacesExperimentsJobs {␊ - apiVersion: "2018-05-01"␊ - /**␊ - * The name of the job within the specified resource group. Job names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.␊ - */␊ - name: string␊ - /**␊ - * The properties of a Batch AI Job.␊ - */␊ - properties: (JobBaseProperties1 | string)␊ - type: "Microsoft.BatchAI/workspaces/experiments/jobs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.BatchAI/workspaces/fileServers␊ - */␊ - export interface WorkspacesFileServers {␊ - apiVersion: "2018-05-01"␊ - /**␊ - * The name of the file server within the specified resource group. File server names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.␊ - */␊ - name: string␊ - /**␊ - * The properties of a file server.␊ - */␊ - properties: (FileServerBaseProperties1 | string)␊ - type: "Microsoft.BatchAI/workspaces/fileServers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ContainerService/containerServices␊ - */␊ - export interface ContainerServices1 {␊ - apiVersion: "2017-07-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the container service in the specified subscription and resource group.␊ - */␊ - name: string␊ - /**␊ - * Properties of the container service.␊ - */␊ - properties: (ContainerServiceProperties1 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.ContainerService/containerServices"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the container service.␊ - */␊ - export interface ContainerServiceProperties1 {␊ - /**␊ - * Properties of the agent pool.␊ - */␊ - agentPoolProfiles?: (ContainerServiceAgentPoolProfile1[] | string)␊ - /**␊ - * Properties to configure a custom container service cluster.␊ - */␊ - customProfile?: (ContainerServiceCustomProfile | string)␊ - /**␊ - * Profile for diagnostics on the container service cluster.␊ - */␊ - diagnosticsProfile?: (ContainerServiceDiagnosticsProfile1 | string)␊ - /**␊ - * Profile for Linux VMs in the container service cluster.␊ - */␊ - linuxProfile: (ContainerServiceLinuxProfile1 | string)␊ - /**␊ - * Profile for the container service master.␊ - */␊ - masterProfile: (ContainerServiceMasterProfile1 | string)␊ - /**␊ - * Profile for the container service orchestrator.␊ - */␊ - orchestratorProfile: (ContainerServiceOrchestratorProfile1 | string)␊ - /**␊ - * Information about a service principal identity for the cluster to use for manipulating Azure APIs. Either secret or keyVaultSecretRef must be specified.␊ - */␊ - servicePrincipalProfile?: (ContainerServiceServicePrincipalProfile | string)␊ - /**␊ - * Profile for Windows VMs in the container service cluster.␊ - */␊ - windowsProfile?: (ContainerServiceWindowsProfile1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Profile for the container service agent pool.␊ - */␊ - export interface ContainerServiceAgentPoolProfile1 {␊ - /**␊ - * Number of agents (VMs) to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. ␊ - */␊ - count?: ((number & string) | string)␊ - /**␊ - * DNS prefix to be used to create the FQDN for the agent pool.␊ - */␊ - dnsPrefix?: string␊ - /**␊ - * Unique name of the agent pool profile in the context of the subscription and resource group.␊ - */␊ - name: string␊ - /**␊ - * OS Disk Size in GB to be used to specify the disk size for every machine in this master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified.␊ - */␊ - osDiskSizeGB?: (number | string)␊ - /**␊ - * OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux.␊ - */␊ - osType?: (("Linux" | "Windows") | string)␊ - /**␊ - * Ports number array used to expose on this agent pool. The default opened ports are different based on your choice of orchestrator.␊ - */␊ - ports?: (number[] | string)␊ - /**␊ - * Storage profile specifies what kind of storage used. Choose from StorageAccount and ManagedDisks. Leave it empty, we will choose for you based on the orchestrator choice.␊ - */␊ - storageProfile?: (("StorageAccount" | "ManagedDisks") | string)␊ - /**␊ - * Size of agent VMs.␊ - */␊ - vmSize: (("Standard_A1" | "Standard_A10" | "Standard_A11" | "Standard_A1_v2" | "Standard_A2" | "Standard_A2_v2" | "Standard_A2m_v2" | "Standard_A3" | "Standard_A4" | "Standard_A4_v2" | "Standard_A4m_v2" | "Standard_A5" | "Standard_A6" | "Standard_A7" | "Standard_A8" | "Standard_A8_v2" | "Standard_A8m_v2" | "Standard_A9" | "Standard_B2ms" | "Standard_B2s" | "Standard_B4ms" | "Standard_B8ms" | "Standard_D1" | "Standard_D11" | "Standard_D11_v2" | "Standard_D11_v2_Promo" | "Standard_D12" | "Standard_D12_v2" | "Standard_D12_v2_Promo" | "Standard_D13" | "Standard_D13_v2" | "Standard_D13_v2_Promo" | "Standard_D14" | "Standard_D14_v2" | "Standard_D14_v2_Promo" | "Standard_D15_v2" | "Standard_D16_v3" | "Standard_D16s_v3" | "Standard_D1_v2" | "Standard_D2" | "Standard_D2_v2" | "Standard_D2_v2_Promo" | "Standard_D2_v3" | "Standard_D2s_v3" | "Standard_D3" | "Standard_D32_v3" | "Standard_D32s_v3" | "Standard_D3_v2" | "Standard_D3_v2_Promo" | "Standard_D4" | "Standard_D4_v2" | "Standard_D4_v2_Promo" | "Standard_D4_v3" | "Standard_D4s_v3" | "Standard_D5_v2" | "Standard_D5_v2_Promo" | "Standard_D64_v3" | "Standard_D64s_v3" | "Standard_D8_v3" | "Standard_D8s_v3" | "Standard_DS1" | "Standard_DS11" | "Standard_DS11_v2" | "Standard_DS11_v2_Promo" | "Standard_DS12" | "Standard_DS12_v2" | "Standard_DS12_v2_Promo" | "Standard_DS13" | "Standard_DS13-2_v2" | "Standard_DS13-4_v2" | "Standard_DS13_v2" | "Standard_DS13_v2_Promo" | "Standard_DS14" | "Standard_DS14-4_v2" | "Standard_DS14-8_v2" | "Standard_DS14_v2" | "Standard_DS14_v2_Promo" | "Standard_DS15_v2" | "Standard_DS1_v2" | "Standard_DS2" | "Standard_DS2_v2" | "Standard_DS2_v2_Promo" | "Standard_DS3" | "Standard_DS3_v2" | "Standard_DS3_v2_Promo" | "Standard_DS4" | "Standard_DS4_v2" | "Standard_DS4_v2_Promo" | "Standard_DS5_v2" | "Standard_DS5_v2_Promo" | "Standard_E16_v3" | "Standard_E16s_v3" | "Standard_E2_v3" | "Standard_E2s_v3" | "Standard_E32-16s_v3" | "Standard_E32-8s_v3" | "Standard_E32_v3" | "Standard_E32s_v3" | "Standard_E4_v3" | "Standard_E4s_v3" | "Standard_E64-16s_v3" | "Standard_E64-32s_v3" | "Standard_E64_v3" | "Standard_E64s_v3" | "Standard_E8_v3" | "Standard_E8s_v3" | "Standard_F1" | "Standard_F16" | "Standard_F16s" | "Standard_F16s_v2" | "Standard_F1s" | "Standard_F2" | "Standard_F2s" | "Standard_F2s_v2" | "Standard_F32s_v2" | "Standard_F4" | "Standard_F4s" | "Standard_F4s_v2" | "Standard_F64s_v2" | "Standard_F72s_v2" | "Standard_F8" | "Standard_F8s" | "Standard_F8s_v2" | "Standard_G1" | "Standard_G2" | "Standard_G3" | "Standard_G4" | "Standard_G5" | "Standard_GS1" | "Standard_GS2" | "Standard_GS3" | "Standard_GS4" | "Standard_GS4-4" | "Standard_GS4-8" | "Standard_GS5" | "Standard_GS5-16" | "Standard_GS5-8" | "Standard_H16" | "Standard_H16m" | "Standard_H16mr" | "Standard_H16r" | "Standard_H8" | "Standard_H8m" | "Standard_L16s" | "Standard_L32s" | "Standard_L4s" | "Standard_L8s" | "Standard_M128-32ms" | "Standard_M128-64ms" | "Standard_M128ms" | "Standard_M128s" | "Standard_M64-16ms" | "Standard_M64-32ms" | "Standard_M64ms" | "Standard_M64s" | "Standard_NC12" | "Standard_NC12s_v2" | "Standard_NC12s_v3" | "Standard_NC24" | "Standard_NC24r" | "Standard_NC24rs_v2" | "Standard_NC24rs_v3" | "Standard_NC24s_v2" | "Standard_NC24s_v3" | "Standard_NC6" | "Standard_NC6s_v2" | "Standard_NC6s_v3" | "Standard_ND12s" | "Standard_ND24rs" | "Standard_ND24s" | "Standard_ND6s" | "Standard_NV12" | "Standard_NV24" | "Standard_NV6") | string)␊ - /**␊ - * VNet SubnetID specifies the VNet's subnet identifier.␊ - */␊ - vnetSubnetID?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties to configure a custom container service cluster.␊ - */␊ - export interface ContainerServiceCustomProfile {␊ - /**␊ - * The name of the custom orchestrator to use.␊ - */␊ - orchestrator: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Profile for diagnostics on the container service cluster.␊ - */␊ - export interface ContainerServiceDiagnosticsProfile1 {␊ - /**␊ - * Profile for diagnostics on the container service VMs.␊ - */␊ - vmDiagnostics: (ContainerServiceVMDiagnostics1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Profile for diagnostics on the container service VMs.␊ - */␊ - export interface ContainerServiceVMDiagnostics1 {␊ - /**␊ - * Whether the VM diagnostic agent is provisioned on the VM.␊ - */␊ - enabled: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Profile for Linux VMs in the container service cluster.␊ - */␊ - export interface ContainerServiceLinuxProfile1 {␊ - /**␊ - * The administrator username to use for Linux VMs.␊ - */␊ - adminUsername: string␊ - /**␊ - * SSH configuration for Linux-based VMs running on Azure.␊ - */␊ - ssh: (ContainerServiceSshConfiguration1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSH configuration for Linux-based VMs running on Azure.␊ - */␊ - export interface ContainerServiceSshConfiguration1 {␊ - /**␊ - * The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified.␊ - */␊ - publicKeys: (ContainerServiceSshPublicKey1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains information about SSH certificate public key data.␊ - */␊ - export interface ContainerServiceSshPublicKey1 {␊ - /**␊ - * Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers.␊ - */␊ - keyData: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Profile for the container service master.␊ - */␊ - export interface ContainerServiceMasterProfile1 {␊ - /**␊ - * Number of masters (VMs) in the container service cluster. Allowed values are 1, 3, and 5. The default value is 1.␊ - */␊ - count?: ((number & string) | string)␊ - /**␊ - * DNS prefix to be used to create the FQDN for the master pool.␊ - */␊ - dnsPrefix: string␊ - /**␊ - * FirstConsecutiveStaticIP used to specify the first static ip of masters.␊ - */␊ - firstConsecutiveStaticIP?: string␊ - /**␊ - * OS Disk Size in GB to be used to specify the disk size for every machine in this master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified.␊ - */␊ - osDiskSizeGB?: (number | string)␊ - /**␊ - * Storage profile specifies what kind of storage used. Choose from StorageAccount and ManagedDisks. Leave it empty, we will choose for you based on the orchestrator choice.␊ - */␊ - storageProfile?: (("StorageAccount" | "ManagedDisks") | string)␊ - /**␊ - * Size of agent VMs.␊ - */␊ - vmSize: (("Standard_A1" | "Standard_A10" | "Standard_A11" | "Standard_A1_v2" | "Standard_A2" | "Standard_A2_v2" | "Standard_A2m_v2" | "Standard_A3" | "Standard_A4" | "Standard_A4_v2" | "Standard_A4m_v2" | "Standard_A5" | "Standard_A6" | "Standard_A7" | "Standard_A8" | "Standard_A8_v2" | "Standard_A8m_v2" | "Standard_A9" | "Standard_B2ms" | "Standard_B2s" | "Standard_B4ms" | "Standard_B8ms" | "Standard_D1" | "Standard_D11" | "Standard_D11_v2" | "Standard_D11_v2_Promo" | "Standard_D12" | "Standard_D12_v2" | "Standard_D12_v2_Promo" | "Standard_D13" | "Standard_D13_v2" | "Standard_D13_v2_Promo" | "Standard_D14" | "Standard_D14_v2" | "Standard_D14_v2_Promo" | "Standard_D15_v2" | "Standard_D16_v3" | "Standard_D16s_v3" | "Standard_D1_v2" | "Standard_D2" | "Standard_D2_v2" | "Standard_D2_v2_Promo" | "Standard_D2_v3" | "Standard_D2s_v3" | "Standard_D3" | "Standard_D32_v3" | "Standard_D32s_v3" | "Standard_D3_v2" | "Standard_D3_v2_Promo" | "Standard_D4" | "Standard_D4_v2" | "Standard_D4_v2_Promo" | "Standard_D4_v3" | "Standard_D4s_v3" | "Standard_D5_v2" | "Standard_D5_v2_Promo" | "Standard_D64_v3" | "Standard_D64s_v3" | "Standard_D8_v3" | "Standard_D8s_v3" | "Standard_DS1" | "Standard_DS11" | "Standard_DS11_v2" | "Standard_DS11_v2_Promo" | "Standard_DS12" | "Standard_DS12_v2" | "Standard_DS12_v2_Promo" | "Standard_DS13" | "Standard_DS13-2_v2" | "Standard_DS13-4_v2" | "Standard_DS13_v2" | "Standard_DS13_v2_Promo" | "Standard_DS14" | "Standard_DS14-4_v2" | "Standard_DS14-8_v2" | "Standard_DS14_v2" | "Standard_DS14_v2_Promo" | "Standard_DS15_v2" | "Standard_DS1_v2" | "Standard_DS2" | "Standard_DS2_v2" | "Standard_DS2_v2_Promo" | "Standard_DS3" | "Standard_DS3_v2" | "Standard_DS3_v2_Promo" | "Standard_DS4" | "Standard_DS4_v2" | "Standard_DS4_v2_Promo" | "Standard_DS5_v2" | "Standard_DS5_v2_Promo" | "Standard_E16_v3" | "Standard_E16s_v3" | "Standard_E2_v3" | "Standard_E2s_v3" | "Standard_E32-16s_v3" | "Standard_E32-8s_v3" | "Standard_E32_v3" | "Standard_E32s_v3" | "Standard_E4_v3" | "Standard_E4s_v3" | "Standard_E64-16s_v3" | "Standard_E64-32s_v3" | "Standard_E64_v3" | "Standard_E64s_v3" | "Standard_E8_v3" | "Standard_E8s_v3" | "Standard_F1" | "Standard_F16" | "Standard_F16s" | "Standard_F16s_v2" | "Standard_F1s" | "Standard_F2" | "Standard_F2s" | "Standard_F2s_v2" | "Standard_F32s_v2" | "Standard_F4" | "Standard_F4s" | "Standard_F4s_v2" | "Standard_F64s_v2" | "Standard_F72s_v2" | "Standard_F8" | "Standard_F8s" | "Standard_F8s_v2" | "Standard_G1" | "Standard_G2" | "Standard_G3" | "Standard_G4" | "Standard_G5" | "Standard_GS1" | "Standard_GS2" | "Standard_GS3" | "Standard_GS4" | "Standard_GS4-4" | "Standard_GS4-8" | "Standard_GS5" | "Standard_GS5-16" | "Standard_GS5-8" | "Standard_H16" | "Standard_H16m" | "Standard_H16mr" | "Standard_H16r" | "Standard_H8" | "Standard_H8m" | "Standard_L16s" | "Standard_L32s" | "Standard_L4s" | "Standard_L8s" | "Standard_M128-32ms" | "Standard_M128-64ms" | "Standard_M128ms" | "Standard_M128s" | "Standard_M64-16ms" | "Standard_M64-32ms" | "Standard_M64ms" | "Standard_M64s" | "Standard_NC12" | "Standard_NC12s_v2" | "Standard_NC12s_v3" | "Standard_NC24" | "Standard_NC24r" | "Standard_NC24rs_v2" | "Standard_NC24rs_v3" | "Standard_NC24s_v2" | "Standard_NC24s_v3" | "Standard_NC6" | "Standard_NC6s_v2" | "Standard_NC6s_v3" | "Standard_ND12s" | "Standard_ND24rs" | "Standard_ND24s" | "Standard_ND6s" | "Standard_NV12" | "Standard_NV24" | "Standard_NV6") | string)␊ - /**␊ - * VNet SubnetID specifies the VNet's subnet identifier.␊ - */␊ - vnetSubnetID?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Profile for the container service orchestrator.␊ - */␊ - export interface ContainerServiceOrchestratorProfile1 {␊ - /**␊ - * The orchestrator to use to manage container service cluster resources. Valid values are Kubernetes, Swarm, DCOS, DockerCE and Custom.␊ - */␊ - orchestratorType: (("Kubernetes" | "Swarm" | "DCOS" | "DockerCE" | "Custom") | string)␊ - /**␊ - * The version of the orchestrator to use. You can specify the major.minor.patch part of the actual version.For example, you can specify version as "1.6.11".␊ - */␊ - orchestratorVersion?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about a service principal identity for the cluster to use for manipulating Azure APIs. Either secret or keyVaultSecretRef must be specified.␊ - */␊ - export interface ContainerServiceServicePrincipalProfile {␊ - /**␊ - * The ID for the service principal.␊ - */␊ - clientId: string␊ - /**␊ - * Reference to a secret stored in Azure Key Vault.␊ - */␊ - keyVaultSecretRef?: (KeyVaultSecretRef | string)␊ - /**␊ - * The secret password associated with the service principal in plain text.␊ - */␊ - secret?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Reference to a secret stored in Azure Key Vault.␊ - */␊ - export interface KeyVaultSecretRef {␊ - /**␊ - * The secret name.␊ - */␊ - secretName: string␊ - /**␊ - * Key vault identifier.␊ - */␊ - vaultID: string␊ - /**␊ - * The secret version.␊ - */␊ - version?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Profile for Windows VMs in the container service cluster.␊ - */␊ - export interface ContainerServiceWindowsProfile1 {␊ - /**␊ - * The administrator password to use for Windows VMs.␊ - */␊ - adminPassword: string␊ - /**␊ - * The administrator username to use for Windows VMs.␊ - */␊ - adminUsername: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ContainerService/managedClusters␊ - */␊ - export interface ManagedClusters {␊ - apiVersion: "2018-03-31"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the managed cluster resource.␊ - */␊ - name: string␊ - /**␊ - * Properties of the managed cluster.␊ - */␊ - properties: (ManagedClusterProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.ContainerService/managedClusters"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the managed cluster.␊ - */␊ - export interface ManagedClusterProperties {␊ - /**␊ - * AADProfile specifies attributes for Azure Active Directory integration.␊ - */␊ - aadProfile?: (ManagedClusterAADProfile | string)␊ - /**␊ - * Profile of managed cluster add-on.␊ - */␊ - addonProfiles?: ({␊ - [k: string]: ManagedClusterAddonProfile␊ - } | string)␊ - /**␊ - * Properties of the agent pool. Currently only one agent pool can exist.␊ - */␊ - agentPoolProfiles?: (ManagedClusterAgentPoolProfile[] | string)␊ - /**␊ - * DNS prefix specified when creating the managed cluster.␊ - */␊ - dnsPrefix?: string␊ - /**␊ - * Whether to enable Kubernetes Role-Based Access Control.␊ - */␊ - enableRBAC?: (boolean | string)␊ - /**␊ - * Version of Kubernetes specified when creating the managed cluster.␊ - */␊ - kubernetesVersion?: string␊ - /**␊ - * Profile for Linux VMs in the container service cluster.␊ - */␊ - linuxProfile?: (ContainerServiceLinuxProfile2 | string)␊ - /**␊ - * Profile of network configuration.␊ - */␊ - networkProfile?: (ContainerServiceNetworkProfile | string)␊ - /**␊ - * Information about a service principal identity for the cluster to use for manipulating Azure APIs.␊ - */␊ - servicePrincipalProfile?: (ManagedClusterServicePrincipalProfile | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AADProfile specifies attributes for Azure Active Directory integration.␊ - */␊ - export interface ManagedClusterAADProfile {␊ - /**␊ - * The client AAD application ID.␊ - */␊ - clientAppID: string␊ - /**␊ - * The server AAD application ID.␊ - */␊ - serverAppID: string␊ - /**␊ - * The server AAD application secret.␊ - */␊ - serverAppSecret?: string␊ - /**␊ - * The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription.␊ - */␊ - tenantID?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A Kubernetes add-on profile for a managed cluster.␊ - */␊ - export interface ManagedClusterAddonProfile {␊ - /**␊ - * Key-value pairs for configuring an add-on.␊ - */␊ - config?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Whether the add-on is enabled or not.␊ - */␊ - enabled: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Profile for the container service agent pool.␊ - */␊ - export interface ManagedClusterAgentPoolProfile {␊ - /**␊ - * Number of agents (VMs) to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. ␊ - */␊ - count?: ((number & string) | string)␊ - /**␊ - * Maximum number of pods that can run on a node.␊ - */␊ - maxPods?: (number | string)␊ - /**␊ - * Unique name of the agent pool profile in the context of the subscription and resource group.␊ - */␊ - name: string␊ - /**␊ - * OS Disk Size in GB to be used to specify the disk size for every machine in this master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified.␊ - */␊ - osDiskSizeGB?: (number | string)␊ - /**␊ - * OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux.␊ - */␊ - osType?: (("Linux" | "Windows") | string)␊ - /**␊ - * Size of agent VMs.␊ - */␊ - vmSize: (("Standard_A1" | "Standard_A10" | "Standard_A11" | "Standard_A1_v2" | "Standard_A2" | "Standard_A2_v2" | "Standard_A2m_v2" | "Standard_A3" | "Standard_A4" | "Standard_A4_v2" | "Standard_A4m_v2" | "Standard_A5" | "Standard_A6" | "Standard_A7" | "Standard_A8" | "Standard_A8_v2" | "Standard_A8m_v2" | "Standard_A9" | "Standard_B2ms" | "Standard_B2s" | "Standard_B4ms" | "Standard_B8ms" | "Standard_D1" | "Standard_D11" | "Standard_D11_v2" | "Standard_D11_v2_Promo" | "Standard_D12" | "Standard_D12_v2" | "Standard_D12_v2_Promo" | "Standard_D13" | "Standard_D13_v2" | "Standard_D13_v2_Promo" | "Standard_D14" | "Standard_D14_v2" | "Standard_D14_v2_Promo" | "Standard_D15_v2" | "Standard_D16_v3" | "Standard_D16s_v3" | "Standard_D1_v2" | "Standard_D2" | "Standard_D2_v2" | "Standard_D2_v2_Promo" | "Standard_D2_v3" | "Standard_D2s_v3" | "Standard_D3" | "Standard_D32_v3" | "Standard_D32s_v3" | "Standard_D3_v2" | "Standard_D3_v2_Promo" | "Standard_D4" | "Standard_D4_v2" | "Standard_D4_v2_Promo" | "Standard_D4_v3" | "Standard_D4s_v3" | "Standard_D5_v2" | "Standard_D5_v2_Promo" | "Standard_D64_v3" | "Standard_D64s_v3" | "Standard_D8_v3" | "Standard_D8s_v3" | "Standard_DS1" | "Standard_DS11" | "Standard_DS11_v2" | "Standard_DS11_v2_Promo" | "Standard_DS12" | "Standard_DS12_v2" | "Standard_DS12_v2_Promo" | "Standard_DS13" | "Standard_DS13-2_v2" | "Standard_DS13-4_v2" | "Standard_DS13_v2" | "Standard_DS13_v2_Promo" | "Standard_DS14" | "Standard_DS14-4_v2" | "Standard_DS14-8_v2" | "Standard_DS14_v2" | "Standard_DS14_v2_Promo" | "Standard_DS15_v2" | "Standard_DS1_v2" | "Standard_DS2" | "Standard_DS2_v2" | "Standard_DS2_v2_Promo" | "Standard_DS3" | "Standard_DS3_v2" | "Standard_DS3_v2_Promo" | "Standard_DS4" | "Standard_DS4_v2" | "Standard_DS4_v2_Promo" | "Standard_DS5_v2" | "Standard_DS5_v2_Promo" | "Standard_E16_v3" | "Standard_E16s_v3" | "Standard_E2_v3" | "Standard_E2s_v3" | "Standard_E32-16s_v3" | "Standard_E32-8s_v3" | "Standard_E32_v3" | "Standard_E32s_v3" | "Standard_E4_v3" | "Standard_E4s_v3" | "Standard_E64-16s_v3" | "Standard_E64-32s_v3" | "Standard_E64_v3" | "Standard_E64s_v3" | "Standard_E8_v3" | "Standard_E8s_v3" | "Standard_F1" | "Standard_F16" | "Standard_F16s" | "Standard_F16s_v2" | "Standard_F1s" | "Standard_F2" | "Standard_F2s" | "Standard_F2s_v2" | "Standard_F32s_v2" | "Standard_F4" | "Standard_F4s" | "Standard_F4s_v2" | "Standard_F64s_v2" | "Standard_F72s_v2" | "Standard_F8" | "Standard_F8s" | "Standard_F8s_v2" | "Standard_G1" | "Standard_G2" | "Standard_G3" | "Standard_G4" | "Standard_G5" | "Standard_GS1" | "Standard_GS2" | "Standard_GS3" | "Standard_GS4" | "Standard_GS4-4" | "Standard_GS4-8" | "Standard_GS5" | "Standard_GS5-16" | "Standard_GS5-8" | "Standard_H16" | "Standard_H16m" | "Standard_H16mr" | "Standard_H16r" | "Standard_H8" | "Standard_H8m" | "Standard_L16s" | "Standard_L32s" | "Standard_L4s" | "Standard_L8s" | "Standard_M128-32ms" | "Standard_M128-64ms" | "Standard_M128ms" | "Standard_M128s" | "Standard_M64-16ms" | "Standard_M64-32ms" | "Standard_M64ms" | "Standard_M64s" | "Standard_NC12" | "Standard_NC12s_v2" | "Standard_NC12s_v3" | "Standard_NC24" | "Standard_NC24r" | "Standard_NC24rs_v2" | "Standard_NC24rs_v3" | "Standard_NC24s_v2" | "Standard_NC24s_v3" | "Standard_NC6" | "Standard_NC6s_v2" | "Standard_NC6s_v3" | "Standard_ND12s" | "Standard_ND24rs" | "Standard_ND24s" | "Standard_ND6s" | "Standard_NV12" | "Standard_NV24" | "Standard_NV6") | string)␊ - /**␊ - * VNet SubnetID specifies the VNet's subnet identifier.␊ - */␊ - vnetSubnetID?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Profile for Linux VMs in the container service cluster.␊ - */␊ - export interface ContainerServiceLinuxProfile2 {␊ - /**␊ - * The administrator username to use for Linux VMs.␊ - */␊ - adminUsername: string␊ - /**␊ - * SSH configuration for Linux-based VMs running on Azure.␊ - */␊ - ssh: (ContainerServiceSshConfiguration2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSH configuration for Linux-based VMs running on Azure.␊ - */␊ - export interface ContainerServiceSshConfiguration2 {␊ - /**␊ - * The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified.␊ - */␊ - publicKeys: (ContainerServiceSshPublicKey2[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains information about SSH certificate public key data.␊ - */␊ - export interface ContainerServiceSshPublicKey2 {␊ - /**␊ - * Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers.␊ - */␊ - keyData: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Profile of network configuration.␊ - */␊ - export interface ContainerServiceNetworkProfile {␊ - /**␊ - * An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr.␊ - */␊ - dnsServiceIP?: string␊ - /**␊ - * A CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the Kubernetes service address range.␊ - */␊ - dockerBridgeCidr?: string␊ - /**␊ - * Network plugin used for building Kubernetes network.␊ - */␊ - networkPlugin?: (("azure" | "kubenet") | string)␊ - /**␊ - * Network policy used for building Kubernetes network.␊ - */␊ - networkPolicy?: ("calico" | string)␊ - /**␊ - * A CIDR notation IP range from which to assign pod IPs when kubenet is used.␊ - */␊ - podCidr?: string␊ - /**␊ - * A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges.␊ - */␊ - serviceCidr?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about a service principal identity for the cluster to use for manipulating Azure APIs.␊ - */␊ - export interface ManagedClusterServicePrincipalProfile {␊ - /**␊ - * The ID for the service principal.␊ - */␊ - clientId: string␊ - /**␊ - * The secret password associated with the service principal in plain text.␊ - */␊ - secret?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.OperationalInsights/workspaces/savedSearches␊ - */␊ - export interface WorkspacesSavedSearches {␊ - apiVersion: "2015-03-20"␊ - /**␊ - * The ETag of the saved search.␊ - */␊ - eTag?: string␊ - /**␊ - * The id of the saved search.␊ - */␊ - name: string␊ - /**␊ - * Value object for saved search results.␊ - */␊ - properties: (SavedSearchProperties | string)␊ - type: "Microsoft.OperationalInsights/workspaces/savedSearches"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Value object for saved search results.␊ - */␊ - export interface SavedSearchProperties {␊ - /**␊ - * The category of the saved search. This helps the user to find a saved search faster. ␊ - */␊ - category: string␊ - /**␊ - * Saved search display name.␊ - */␊ - displayName: string␊ - /**␊ - * The query expression for the saved search. Please see https://docs.microsoft.com/en-us/azure/log-analytics/log-analytics-search-reference for reference.␊ - */␊ - query: string␊ - /**␊ - * The tags attached to the saved search.␊ - */␊ - tags?: (Tag[] | string)␊ - /**␊ - * The version number of the query language. The current version is 2 and is the default.␊ - */␊ - version?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A tag of a saved search.␊ - */␊ - export interface Tag {␊ - /**␊ - * The tag name.␊ - */␊ - name: string␊ - /**␊ - * The tag value.␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.OperationalInsights/workspaces/storageInsightConfigs␊ - */␊ - export interface WorkspacesStorageInsightConfigs {␊ - apiVersion: "2015-03-20"␊ - /**␊ - * The ETag of the storage insight.␊ - */␊ - eTag?: string␊ - /**␊ - * Name of the storageInsightsConfigs resource␊ - */␊ - name: string␊ - /**␊ - * Storage insight properties.␊ - */␊ - properties: (StorageInsightProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.OperationalInsights/workspaces/storageInsightConfigs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Storage insight properties.␊ - */␊ - export interface StorageInsightProperties {␊ - /**␊ - * The names of the blob containers that the workspace should read␊ - */␊ - containers?: (string[] | string)␊ - /**␊ - * Describes a storage account connection.␊ - */␊ - storageAccount: (StorageAccount5 | string)␊ - /**␊ - * The names of the Azure tables that the workspace should read␊ - */␊ - tables?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a storage account connection.␊ - */␊ - export interface StorageAccount5 {␊ - /**␊ - * The Azure Resource Manager ID of the storage account resource.␊ - */␊ - id: string␊ - /**␊ - * The storage account key.␊ - */␊ - key: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.OperationalInsights/workspaces␊ - */␊ - export interface Workspaces9 {␊ - apiVersion: "2015-11-01-preview"␊ - /**␊ - * The ETag of the workspace.␊ - */␊ - eTag?: string␊ - /**␊ - * Resource location␊ - */␊ - location?: string␊ - /**␊ - * The name of the workspace.␊ - */␊ - name: string␊ - /**␊ - * Workspace properties.␊ - */␊ - properties: (WorkspaceProperties9 | string)␊ - resources?: (WorkspacesLinkedServicesChildResource | WorkspacesDataSourcesChildResource)[]␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.OperationalInsights/workspaces"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Workspace properties.␊ - */␊ - export interface WorkspaceProperties9 {␊ - /**␊ - * The provisioning state of the workspace.␊ - */␊ - provisioningState?: (("Creating" | "Succeeded" | "Failed" | "Canceled" | "Deleting" | "ProvisioningAccount") | string)␊ - /**␊ - * The workspace data retention in days. -1 means Unlimited retention for the Unlimited Sku. 730 days is the maximum allowed for all other Skus. ␊ - */␊ - retentionInDays?: (number | string)␊ - /**␊ - * The SKU (tier) of a workspace.␊ - */␊ - sku?: (Sku58 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The SKU (tier) of a workspace.␊ - */␊ - export interface Sku58 {␊ - /**␊ - * The name of the SKU.␊ - */␊ - name: (("Free" | "Standard" | "Premium" | "PerNode" | "PerGB2018" | "Standalone" | "CapacityReservation") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.OperationalInsights/workspaces/linkedServices␊ - */␊ - export interface WorkspacesLinkedServicesChildResource {␊ - apiVersion: "2015-11-01-preview"␊ - /**␊ - * Name of the linkedServices resource␊ - */␊ - name: string␊ - /**␊ - * Linked service properties.␊ - */␊ - properties: (LinkedServiceProperties | string)␊ - type: "linkedServices"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service properties.␊ - */␊ - export interface LinkedServiceProperties {␊ - /**␊ - * The resource id of the resource that will be linked to the workspace.␊ - */␊ - resourceId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.OperationalInsights/workspaces/dataSources␊ - */␊ - export interface WorkspacesDataSourcesChildResource {␊ - apiVersion: "2015-11-01-preview"␊ - /**␊ - * The ETag of the data source.␊ - */␊ - eTag?: string␊ - kind: (("AzureActivityLog" | "ChangeTrackingPath" | "ChangeTrackingDefaultPath" | "ChangeTrackingDefaultRegistry" | "ChangeTrackingCustomRegistry" | "CustomLog" | "CustomLogCollection" | "GenericDataSource" | "IISLogs" | "LinuxPerformanceObject" | "LinuxPerformanceCollection" | "LinuxSyslog" | "LinuxSyslogCollection" | "WindowsEvent" | "WindowsPerformanceCounter") | string)␊ - /**␊ - * The name of the datasource resource.␊ - */␊ - name: string␊ - /**␊ - * JSON object␊ - */␊ - properties: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "dataSources"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.OperationalInsights/workspaces/dataSources␊ - */␊ - export interface WorkspacesDataSources {␊ - apiVersion: "2015-11-01-preview"␊ - /**␊ - * The ETag of the data source.␊ - */␊ - eTag?: string␊ - kind: (("AzureActivityLog" | "ChangeTrackingPath" | "ChangeTrackingDefaultPath" | "ChangeTrackingDefaultRegistry" | "ChangeTrackingCustomRegistry" | "CustomLog" | "CustomLogCollection" | "GenericDataSource" | "IISLogs" | "LinuxPerformanceObject" | "LinuxPerformanceCollection" | "LinuxSyslog" | "LinuxSyslogCollection" | "WindowsEvent" | "WindowsPerformanceCounter") | string)␊ - /**␊ - * The name of the datasource resource.␊ - */␊ - name: string␊ - /**␊ - * JSON object␊ - */␊ - properties: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.OperationalInsights/workspaces/dataSources"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.OperationalInsights/workspaces/linkedServices␊ - */␊ - export interface WorkspacesLinkedServices {␊ - apiVersion: "2015-11-01-preview"␊ - /**␊ - * Name of the linkedServices resource␊ - */␊ - name: string␊ - /**␊ - * Linked service properties.␊ - */␊ - properties: (LinkedServiceProperties | string)␊ - type: "Microsoft.OperationalInsights/workspaces/linkedServices"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.OperationalInsights/clusters␊ - */␊ - export interface Clusters15 {␊ - apiVersion: "2019-08-01-preview"␊ - /**␊ - * Identity for the resource.␊ - */␊ - identity?: (Identity22 | string)␊ - /**␊ - * Resource location␊ - */␊ - location?: string␊ - /**␊ - * The name of the Log Analytics cluster.␊ - */␊ - name: string␊ - /**␊ - * Cluster properties.␊ - */␊ - properties: (ClusterProperties13 | string)␊ - sku?: (Sku59 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.OperationalInsights/clusters"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the resource.␊ - */␊ - export interface Identity22 {␊ - /**␊ - * The identity type.␊ - */␊ - type: (("SystemAssigned" | "None") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Cluster properties.␊ - */␊ - export interface ClusterProperties13 {␊ - keyVaultProperties?: (KeyVaultProperties16 | string)␊ - /**␊ - * The link used to get the next page of recommendations.␊ - */␊ - nextLink?: string␊ - [k: string]: unknown␊ - }␊ - export interface KeyVaultProperties16 {␊ - /**␊ - * The name of the key associated with the Log Analytics cluster.␊ - */␊ - keyName?: string␊ - /**␊ - * The Key Vault uri which holds they key associated with the Log Analytics cluster.␊ - */␊ - keyVaultUri?: string␊ - /**␊ - * The version of the key associated with the Log Analytics cluster.␊ - */␊ - keyVersion?: string␊ - [k: string]: unknown␊ - }␊ - export interface Sku59 {␊ - /**␊ - * The capacity value␊ - */␊ - capacity?: (number | string)␊ - /**␊ - * The name of the SKU.␊ - */␊ - name?: ("CapacityReservation" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.OperationsManagement/ManagementConfigurations␊ - */␊ - export interface ManagementConfigurations {␊ - /**␊ - * User Management Configuration Name.␊ - */␊ - name: string␊ - type: "Microsoft.OperationsManagement/ManagementConfigurations"␊ - apiVersion: "2015-11-01-preview"␊ - /**␊ - * Resource location␊ - */␊ - location?: string␊ - /**␊ - * Properties for ManagementConfiguration object supported by the OperationsManagement resource provider.␊ - */␊ - properties: (ManagementConfigurationProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ManagementConfiguration properties supported by the OperationsManagement resource provider.␊ - */␊ - export interface ManagementConfigurationProperties {␊ - /**␊ - * The applicationId of the appliance for this Management.␊ - */␊ - applicationId?: string␊ - /**␊ - * The type of the parent resource.␊ - */␊ - parentResourceType: string␊ - /**␊ - * Parameters to run the ARM template␊ - */␊ - parameters: (ArmTemplateParameter[] | string)␊ - /**␊ - * The Json object containing the ARM template to deploy␊ - */␊ - template: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameter to pass to ARM template␊ - */␊ - export interface ArmTemplateParameter {␊ - /**␊ - * name of the parameter.␊ - */␊ - name?: string␊ - /**␊ - * value for the parameter. In Jtoken ␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.OperationsManagement/solutions␊ - */␊ - export interface Solutions {␊ - /**␊ - * User Solution Name.␊ - */␊ - name: string␊ - type: "Microsoft.OperationsManagement/solutions"␊ - apiVersion: "2015-11-01-preview"␊ - /**␊ - * Resource location␊ - */␊ - location?: string␊ - /**␊ - * Plan for solution object supported by the OperationsManagement resource provider.␊ - */␊ - plan?: (SolutionPlan | string)␊ - /**␊ - * Properties for solution object supported by the OperationsManagement resource provider.␊ - */␊ - properties: (SolutionProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Plan for solution object supported by the OperationsManagement resource provider.␊ - */␊ - export interface SolutionPlan {␊ - /**␊ - * name of the solution to be created. For Microsoft published solution it should be in the format of solutionType(workspaceName). SolutionType part is case sensitive. For third party solution, it can be anything.␊ - */␊ - name?: string␊ - /**␊ - * Publisher name. For gallery solution, it is Microsoft.␊ - */␊ - publisher?: string␊ - /**␊ - * promotionCode, Not really used now, can you left as empty␊ - */␊ - promotionCode?: string␊ - /**␊ - * name of the solution to enabled/add. For Microsoft published gallery solution it should be in the format of OMSGallery/. This is case sensitive␊ - */␊ - product?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Solution properties supported by the OperationsManagement resource provider.␊ - */␊ - export interface SolutionProperties {␊ - /**␊ - * The azure resourceId for the workspace where the solution will be deployed/enabled.␊ - */␊ - workspaceResourceId: string␊ - /**␊ - * The azure resources that will be contained within the solutions. They will be locked and gets deleted automatically when the solution is deleted.␊ - */␊ - containedResources?: (string[] | string)␊ - /**␊ - * The resources that will be referenced from this solution. Deleting any of those solution out of band will break the solution.␊ - */␊ - referencedResources?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Peering/peerings␊ - */␊ - export interface Peerings {␊ - apiVersion: "2019-08-01-preview"␊ - /**␊ - * The kind of the peering.␊ - */␊ - kind: (("Direct" | "Exchange") | string)␊ - /**␊ - * The location of the resource.␊ - */␊ - location: string␊ - /**␊ - * The name of the peering.␊ - */␊ - name: string␊ - /**␊ - * The properties that define connectivity to the Microsoft Cloud Edge.␊ - */␊ - properties: (PeeringProperties | string)␊ - /**␊ - * The SKU that defines the tier and kind of the peering.␊ - */␊ - sku: (PeeringSku | string)␊ - /**␊ - * The resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Peering/peerings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties that define connectivity to the Microsoft Cloud Edge.␊ - */␊ - export interface PeeringProperties {␊ - /**␊ - * The properties that define a direct peering.␊ - */␊ - direct?: (PeeringPropertiesDirect | string)␊ - /**␊ - * The properties that define an exchange peering.␊ - */␊ - exchange?: (PeeringPropertiesExchange | string)␊ - /**␊ - * The location of the peering.␊ - */␊ - peeringLocation?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties that define a direct peering.␊ - */␊ - export interface PeeringPropertiesDirect {␊ - /**␊ - * The set of connections that constitute a direct peering.␊ - */␊ - connections?: (DirectConnection[] | string)␊ - /**␊ - * The type of direct peering.␊ - */␊ - directPeeringType?: (("Edge" | "Transit" | "Cdn" | "Internal") | string)␊ - /**␊ - * The sub resource.␊ - */␊ - peerAsn?: (SubResource39 | string)␊ - /**␊ - * The flag that indicates whether or not the peering is used for peering service.␊ - */␊ - useForPeeringService?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties that define a direct connection.␊ - */␊ - export interface DirectConnection {␊ - /**␊ - * The bandwidth of the connection.␊ - */␊ - bandwidthInMbps?: (number | string)␊ - /**␊ - * The properties that define a BGP session.␊ - */␊ - bgpSession?: (BgpSession | string)␊ - /**␊ - * The unique identifier (GUID) for the connection.␊ - */␊ - connectionIdentifier?: string␊ - /**␊ - * The PeeringDB.com ID of the facility at which the connection has to be set up.␊ - */␊ - peeringDBFacilityId?: (number | string)␊ - /**␊ - * The bandwidth that is actually provisioned.␊ - */␊ - provisionedBandwidthInMbps?: (number | string)␊ - /**␊ - * The field indicating if Microsoft provides session ip addresses.␊ - */␊ - sessionAddressProvider?: (("Microsoft" | "Peer") | string)␊ - /**␊ - * The flag that indicates whether or not the connection is used for peering service.␊ - */␊ - useForPeeringService?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties that define a BGP session.␊ - */␊ - export interface BgpSession {␊ - /**␊ - * The maximum number of prefixes advertised over the IPv4 session.␊ - */␊ - maxPrefixesAdvertisedV4?: (number | string)␊ - /**␊ - * The maximum number of prefixes advertised over the IPv6 session.␊ - */␊ - maxPrefixesAdvertisedV6?: (number | string)␊ - /**␊ - * The MD5 authentication key of the session.␊ - */␊ - md5AuthenticationKey?: string␊ - /**␊ - * The IPv4 session address on peer's end.␊ - */␊ - peerSessionIPv4Address?: string␊ - /**␊ - * The IPv6 session address on peer's end.␊ - */␊ - peerSessionIPv6Address?: string␊ - /**␊ - * The IPv4 prefix that contains both ends' IPv4 addresses.␊ - */␊ - sessionPrefixV4?: string␊ - /**␊ - * The IPv4 prefix that contains both ends' IPv4 addresses.␊ - */␊ - sessionPrefixV6?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The sub resource.␊ - */␊ - export interface SubResource39 {␊ - /**␊ - * The identifier of the referenced resource.␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties that define an exchange peering.␊ - */␊ - export interface PeeringPropertiesExchange {␊ - /**␊ - * The set of connections that constitute an exchange peering.␊ - */␊ - connections?: (ExchangeConnection[] | string)␊ - /**␊ - * The sub resource.␊ - */␊ - peerAsn?: (SubResource39 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties that define an exchange connection.␊ - */␊ - export interface ExchangeConnection {␊ - /**␊ - * The properties that define a BGP session.␊ - */␊ - bgpSession?: (BgpSession | string)␊ - /**␊ - * The unique identifier (GUID) for the connection.␊ - */␊ - connectionIdentifier?: string␊ - /**␊ - * The PeeringDB.com ID of the facility at which the connection has to be set up.␊ - */␊ - peeringDBFacilityId?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The SKU that defines the tier and kind of the peering.␊ - */␊ - export interface PeeringSku {␊ - /**␊ - * The family of the peering SKU.␊ - */␊ - family?: (("Direct" | "Exchange") | string)␊ - /**␊ - * The name of the peering SKU.␊ - */␊ - name?: (("Basic_Exchange_Free" | "Basic_Direct_Free" | "Premium_Direct_Free" | "Premium_Exchange_Metered" | "Premium_Direct_Metered" | "Premium_Direct_Unlimited") | string)␊ - /**␊ - * The size of the peering SKU.␊ - */␊ - size?: (("Free" | "Metered" | "Unlimited") | string)␊ - /**␊ - * The tier of the peering SKU.␊ - */␊ - tier?: (("Basic" | "Premium") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Peering/peeringServices␊ - */␊ - export interface PeeringServices {␊ - apiVersion: "2019-08-01-preview"␊ - /**␊ - * The location of the resource.␊ - */␊ - location: string␊ - /**␊ - * The name of the peering service.␊ - */␊ - name: string␊ - /**␊ - * The properties that define connectivity to the Peering Service.␊ - */␊ - properties: (PeeringServiceProperties | string)␊ - resources?: PeeringServicesPrefixesChildResource[]␊ - /**␊ - * The resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Peering/peeringServices"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties that define connectivity to the Peering Service.␊ - */␊ - export interface PeeringServiceProperties {␊ - /**␊ - * The PeeringServiceLocation of the Customer.␊ - */␊ - peeringServiceLocation?: string␊ - /**␊ - * The MAPS Provider Name.␊ - */␊ - peeringServiceProvider?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Peering/peeringServices/prefixes␊ - */␊ - export interface PeeringServicesPrefixesChildResource {␊ - apiVersion: "2019-08-01-preview"␊ - /**␊ - * The prefix name␊ - */␊ - name: string␊ - /**␊ - * The peering service prefix properties class.␊ - */␊ - properties: (PeeringServicePrefixProperties | string)␊ - type: "prefixes"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The peering service prefix properties class.␊ - */␊ - export interface PeeringServicePrefixProperties {␊ - /**␊ - * The prefix learned type.␊ - */␊ - learnedType?: (("None" | "ViaPartner" | "ViaSession") | string)␊ - /**␊ - * Valid route prefix␊ - */␊ - prefix?: string␊ - /**␊ - * The prefix validation state.␊ - */␊ - prefixValidationState?: (("None" | "Invalid" | "Verified" | "Failed" | "Pending" | "Unknown") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Peering/peeringServices/prefixes␊ - */␊ - export interface PeeringServicesPrefixes {␊ - apiVersion: "2019-08-01-preview"␊ - /**␊ - * The prefix name␊ - */␊ - name: string␊ - /**␊ - * The peering service prefix properties class.␊ - */␊ - properties: (PeeringServicePrefixProperties | string)␊ - type: "Microsoft.Peering/peeringServices/prefixes"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Peering/peerings␊ - */␊ - export interface Peerings1 {␊ - apiVersion: "2019-09-01-preview"␊ - /**␊ - * The kind of the peering.␊ - */␊ - kind: (("Direct" | "Exchange") | string)␊ - /**␊ - * The location of the resource.␊ - */␊ - location: string␊ - /**␊ - * The name of the peering.␊ - */␊ - name: string␊ - /**␊ - * The properties that define connectivity to the Microsoft Cloud Edge.␊ - */␊ - properties: (PeeringProperties1 | string)␊ - /**␊ - * The SKU that defines the tier and kind of the peering.␊ - */␊ - sku: (PeeringSku1 | string)␊ - /**␊ - * The resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Peering/peerings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties that define connectivity to the Microsoft Cloud Edge.␊ - */␊ - export interface PeeringProperties1 {␊ - /**␊ - * The properties that define a direct peering.␊ - */␊ - direct?: (PeeringPropertiesDirect1 | string)␊ - /**␊ - * The properties that define an exchange peering.␊ - */␊ - exchange?: (PeeringPropertiesExchange1 | string)␊ - /**␊ - * The location of the peering.␊ - */␊ - peeringLocation?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties that define a direct peering.␊ - */␊ - export interface PeeringPropertiesDirect1 {␊ - /**␊ - * The set of connections that constitute a direct peering.␊ - */␊ - connections?: (DirectConnection1[] | string)␊ - /**␊ - * The type of direct peering.␊ - */␊ - directPeeringType?: (("Edge" | "Transit" | "Cdn" | "Internal") | string)␊ - /**␊ - * The sub resource.␊ - */␊ - peerAsn?: (SubResource40 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties that define a direct connection.␊ - */␊ - export interface DirectConnection1 {␊ - /**␊ - * The bandwidth of the connection.␊ - */␊ - bandwidthInMbps?: (number | string)␊ - /**␊ - * The properties that define a BGP session.␊ - */␊ - bgpSession?: (BgpSession1 | string)␊ - /**␊ - * The unique identifier (GUID) for the connection.␊ - */␊ - connectionIdentifier?: string␊ - /**␊ - * The PeeringDB.com ID of the facility at which the connection has to be set up.␊ - */␊ - peeringDBFacilityId?: (number | string)␊ - /**␊ - * The field indicating if Microsoft provides session ip addresses.␊ - */␊ - sessionAddressProvider?: (("Microsoft" | "Peer") | string)␊ - /**␊ - * The flag that indicates whether or not the connection is used for peering service.␊ - */␊ - useForPeeringService?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties that define a BGP session.␊ - */␊ - export interface BgpSession1 {␊ - /**␊ - * The maximum number of prefixes advertised over the IPv4 session.␊ - */␊ - maxPrefixesAdvertisedV4?: (number | string)␊ - /**␊ - * The maximum number of prefixes advertised over the IPv6 session.␊ - */␊ - maxPrefixesAdvertisedV6?: (number | string)␊ - /**␊ - * The MD5 authentication key of the session.␊ - */␊ - md5AuthenticationKey?: string␊ - /**␊ - * The IPv4 session address on peer's end.␊ - */␊ - peerSessionIPv4Address?: string␊ - /**␊ - * The IPv6 session address on peer's end.␊ - */␊ - peerSessionIPv6Address?: string␊ - /**␊ - * The IPv4 prefix that contains both ends' IPv4 addresses.␊ - */␊ - sessionPrefixV4?: string␊ - /**␊ - * The IPv4 prefix that contains both ends' IPv4 addresses.␊ - */␊ - sessionPrefixV6?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The sub resource.␊ - */␊ - export interface SubResource40 {␊ - /**␊ - * The identifier of the referenced resource.␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties that define an exchange peering.␊ - */␊ - export interface PeeringPropertiesExchange1 {␊ - /**␊ - * The set of connections that constitute an exchange peering.␊ - */␊ - connections?: (ExchangeConnection1[] | string)␊ - /**␊ - * The sub resource.␊ - */␊ - peerAsn?: (SubResource40 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties that define an exchange connection.␊ - */␊ - export interface ExchangeConnection1 {␊ - /**␊ - * The properties that define a BGP session.␊ - */␊ - bgpSession?: (BgpSession1 | string)␊ - /**␊ - * The unique identifier (GUID) for the connection.␊ - */␊ - connectionIdentifier?: string␊ - /**␊ - * The PeeringDB.com ID of the facility at which the connection has to be set up.␊ - */␊ - peeringDBFacilityId?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The SKU that defines the tier and kind of the peering.␊ - */␊ - export interface PeeringSku1 {␊ - /**␊ - * The family of the peering SKU.␊ - */␊ - family?: (("Direct" | "Exchange") | string)␊ - /**␊ - * The name of the peering SKU.␊ - */␊ - name?: (("Basic_Exchange_Free" | "Basic_Direct_Free" | "Premium_Exchange_Metered" | "Premium_Direct_Free" | "Premium_Direct_Metered" | "Premium_Direct_Unlimited") | string)␊ - /**␊ - * The size of the peering SKU.␊ - */␊ - size?: (("Free" | "Metered" | "Unlimited") | string)␊ - /**␊ - * The tier of the peering SKU.␊ - */␊ - tier?: (("Basic" | "Premium") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Peering/peeringServices␊ - */␊ - export interface PeeringServices1 {␊ - apiVersion: "2019-09-01-preview"␊ - /**␊ - * The location of the resource.␊ - */␊ - location: string␊ - /**␊ - * The name of the peering service.␊ - */␊ - name: string␊ - /**␊ - * The properties that define connectivity to the Peering Service.␊ - */␊ - properties: (PeeringServiceProperties1 | string)␊ - resources?: PeeringServicesPrefixesChildResource1[]␊ - /**␊ - * The resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Peering/peeringServices"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties that define connectivity to the Peering Service.␊ - */␊ - export interface PeeringServiceProperties1 {␊ - /**␊ - * The PeeringServiceLocation of the Customer.␊ - */␊ - peeringServiceLocation?: string␊ - /**␊ - * The MAPS Provider Name.␊ - */␊ - peeringServiceProvider?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Peering/peeringServices/prefixes␊ - */␊ - export interface PeeringServicesPrefixesChildResource1 {␊ - apiVersion: "2019-09-01-preview"␊ - /**␊ - * The name of the prefix.␊ - */␊ - name: string␊ - /**␊ - * The peering service prefix properties class.␊ - */␊ - properties: (PeeringServicePrefixProperties1 | string)␊ - type: "prefixes"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The peering service prefix properties class.␊ - */␊ - export interface PeeringServicePrefixProperties1 {␊ - /**␊ - * The prefix from which your traffic originates.␊ - */␊ - prefix?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Peering/peeringServices/prefixes␊ - */␊ - export interface PeeringServicesPrefixes1 {␊ - apiVersion: "2019-09-01-preview"␊ - /**␊ - * The name of the prefix.␊ - */␊ - name: string␊ - /**␊ - * The peering service prefix properties class.␊ - */␊ - properties: (PeeringServicePrefixProperties1 | string)␊ - type: "Microsoft.Peering/peeringServices/prefixes"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Peering/peerings␊ - */␊ - export interface Peerings2 {␊ - apiVersion: "2020-01-01-preview"␊ - /**␊ - * The kind of the peering.␊ - */␊ - kind: (("Direct" | "Exchange") | string)␊ - /**␊ - * The location of the resource.␊ - */␊ - location: string␊ - /**␊ - * The name of the peering.␊ - */␊ - name: string␊ - /**␊ - * The properties that define connectivity to the Microsoft Cloud Edge.␊ - */␊ - properties: (PeeringProperties2 | string)␊ - resources?: (PeeringsRegisteredAsnsChildResource | PeeringsRegisteredPrefixesChildResource)[]␊ - /**␊ - * The SKU that defines the tier and kind of the peering.␊ - */␊ - sku: (PeeringSku2 | string)␊ - /**␊ - * The resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Peering/peerings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties that define connectivity to the Microsoft Cloud Edge.␊ - */␊ - export interface PeeringProperties2 {␊ - /**␊ - * The properties that define a direct peering.␊ - */␊ - direct?: (PeeringPropertiesDirect2 | string)␊ - /**␊ - * The properties that define an exchange peering.␊ - */␊ - exchange?: (PeeringPropertiesExchange2 | string)␊ - /**␊ - * The location of the peering.␊ - */␊ - peeringLocation?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties that define a direct peering.␊ - */␊ - export interface PeeringPropertiesDirect2 {␊ - /**␊ - * The set of connections that constitute a direct peering.␊ - */␊ - connections?: (DirectConnection2[] | string)␊ - /**␊ - * The type of direct peering.␊ - */␊ - directPeeringType?: (("Edge" | "Transit" | "Cdn" | "Internal" | "Ix" | "IxRs") | string)␊ - /**␊ - * The sub resource.␊ - */␊ - peerAsn?: (SubResource41 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties that define a direct connection.␊ - */␊ - export interface DirectConnection2 {␊ - /**␊ - * The bandwidth of the connection.␊ - */␊ - bandwidthInMbps?: (number | string)␊ - /**␊ - * The properties that define a BGP session.␊ - */␊ - bgpSession?: (BgpSession2 | string)␊ - /**␊ - * The unique identifier (GUID) for the connection.␊ - */␊ - connectionIdentifier?: string␊ - /**␊ - * The PeeringDB.com ID of the facility at which the connection has to be set up.␊ - */␊ - peeringDBFacilityId?: (number | string)␊ - /**␊ - * The field indicating if Microsoft provides session ip addresses.␊ - */␊ - sessionAddressProvider?: (("Microsoft" | "Peer") | string)␊ - /**␊ - * The flag that indicates whether or not the connection is used for peering service.␊ - */␊ - useForPeeringService?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties that define a BGP session.␊ - */␊ - export interface BgpSession2 {␊ - /**␊ - * The maximum number of prefixes advertised over the IPv4 session.␊ - */␊ - maxPrefixesAdvertisedV4?: (number | string)␊ - /**␊ - * The maximum number of prefixes advertised over the IPv6 session.␊ - */␊ - maxPrefixesAdvertisedV6?: (number | string)␊ - /**␊ - * The MD5 authentication key of the session.␊ - */␊ - md5AuthenticationKey?: string␊ - /**␊ - * The IPv4 session address on Microsoft's end.␊ - */␊ - microsoftSessionIPv4Address?: string␊ - /**␊ - * The IPv6 session address on Microsoft's end.␊ - */␊ - microsoftSessionIPv6Address?: string␊ - /**␊ - * The IPv4 session address on peer's end.␊ - */␊ - peerSessionIPv4Address?: string␊ - /**␊ - * The IPv6 session address on peer's end.␊ - */␊ - peerSessionIPv6Address?: string␊ - /**␊ - * The IPv4 prefix that contains both ends' IPv4 addresses.␊ - */␊ - sessionPrefixV4?: string␊ - /**␊ - * The IPv4 prefix that contains both ends' IPv4 addresses.␊ - */␊ - sessionPrefixV6?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The sub resource.␊ - */␊ - export interface SubResource41 {␊ - /**␊ - * The identifier of the referenced resource.␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties that define an exchange peering.␊ - */␊ - export interface PeeringPropertiesExchange2 {␊ - /**␊ - * The set of connections that constitute an exchange peering.␊ - */␊ - connections?: (ExchangeConnection2[] | string)␊ - /**␊ - * The sub resource.␊ - */␊ - peerAsn?: (SubResource41 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties that define an exchange connection.␊ - */␊ - export interface ExchangeConnection2 {␊ - /**␊ - * The properties that define a BGP session.␊ - */␊ - bgpSession?: (BgpSession2 | string)␊ - /**␊ - * The unique identifier (GUID) for the connection.␊ - */␊ - connectionIdentifier?: string␊ - /**␊ - * The PeeringDB.com ID of the facility at which the connection has to be set up.␊ - */␊ - peeringDBFacilityId?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Peering/peerings/registeredAsns␊ - */␊ - export interface PeeringsRegisteredAsnsChildResource {␊ - apiVersion: "2020-01-01-preview"␊ - /**␊ - * The name of the ASN.␊ - */␊ - name: string␊ - /**␊ - * The properties that define a registered ASN.␊ - */␊ - properties: (PeeringRegisteredAsnProperties | string)␊ - type: "registeredAsns"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties that define a registered ASN.␊ - */␊ - export interface PeeringRegisteredAsnProperties {␊ - /**␊ - * The customer's ASN from which traffic originates.␊ - */␊ - asn?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Peering/peerings/registeredPrefixes␊ - */␊ - export interface PeeringsRegisteredPrefixesChildResource {␊ - apiVersion: "2020-01-01-preview"␊ - /**␊ - * The name of the registered prefix.␊ - */␊ - name: string␊ - /**␊ - * The properties that define a registered prefix.␊ - */␊ - properties: (PeeringRegisteredPrefixProperties | string)␊ - type: "registeredPrefixes"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties that define a registered prefix.␊ - */␊ - export interface PeeringRegisteredPrefixProperties {␊ - /**␊ - * The customer's prefix from which traffic originates.␊ - */␊ - prefix?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The SKU that defines the tier and kind of the peering.␊ - */␊ - export interface PeeringSku2 {␊ - /**␊ - * The family of the peering SKU.␊ - */␊ - family?: (("Direct" | "Exchange") | string)␊ - /**␊ - * The name of the peering SKU.␊ - */␊ - name?: string␊ - /**␊ - * The size of the peering SKU.␊ - */␊ - size?: (("Free" | "Metered" | "Unlimited") | string)␊ - /**␊ - * The tier of the peering SKU.␊ - */␊ - tier?: (("Basic" | "Premium") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Peering/peerings/registeredAsns␊ - */␊ - export interface PeeringsRegisteredAsns {␊ - apiVersion: "2020-01-01-preview"␊ - /**␊ - * The name of the ASN.␊ - */␊ - name: string␊ - /**␊ - * The properties that define a registered ASN.␊ - */␊ - properties: (PeeringRegisteredAsnProperties | string)␊ - type: "Microsoft.Peering/peerings/registeredAsns"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Peering/peerings/registeredPrefixes␊ - */␊ - export interface PeeringsRegisteredPrefixes {␊ - apiVersion: "2020-01-01-preview"␊ - /**␊ - * The name of the registered prefix.␊ - */␊ - name: string␊ - /**␊ - * The properties that define a registered prefix.␊ - */␊ - properties: (PeeringRegisteredPrefixProperties | string)␊ - type: "Microsoft.Peering/peerings/registeredPrefixes"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Peering/peeringServices␊ - */␊ - export interface PeeringServices2 {␊ - apiVersion: "2020-01-01-preview"␊ - /**␊ - * The location of the resource.␊ - */␊ - location: string␊ - /**␊ - * The name of the peering service.␊ - */␊ - name: string␊ - /**␊ - * The properties that define connectivity to the Peering Service.␊ - */␊ - properties: (PeeringServiceProperties2 | string)␊ - resources?: PeeringServicesPrefixesChildResource2[]␊ - /**␊ - * The SKU that defines the type of the peering service.␊ - */␊ - sku?: (PeeringServiceSku | string)␊ - /**␊ - * The resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Peering/peeringServices"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties that define connectivity to the Peering Service.␊ - */␊ - export interface PeeringServiceProperties2 {␊ - /**␊ - * The PeeringServiceLocation of the Customer.␊ - */␊ - peeringServiceLocation?: string␊ - /**␊ - * The MAPS Provider Name.␊ - */␊ - peeringServiceProvider?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Peering/peeringServices/prefixes␊ - */␊ - export interface PeeringServicesPrefixesChildResource2 {␊ - apiVersion: "2020-01-01-preview"␊ - /**␊ - * The name of the prefix.␊ - */␊ - name: string␊ - /**␊ - * The peering service prefix properties class.␊ - */␊ - properties: (PeeringServicePrefixProperties2 | string)␊ - type: "prefixes"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The peering service prefix properties class.␊ - */␊ - export interface PeeringServicePrefixProperties2 {␊ - /**␊ - * The peering service prefix key␊ - */␊ - peeringServicePrefixKey?: string␊ - /**␊ - * The prefix from which your traffic originates.␊ - */␊ - prefix?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The SKU that defines the type of the peering service.␊ - */␊ - export interface PeeringServiceSku {␊ - /**␊ - * The name of the peering service SKU.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Peering/peeringServices/prefixes␊ - */␊ - export interface PeeringServicesPrefixes2 {␊ - apiVersion: "2020-01-01-preview"␊ - /**␊ - * The name of the prefix.␊ - */␊ - name: string␊ - /**␊ - * The peering service prefix properties class.␊ - */␊ - properties: (PeeringServicePrefixProperties2 | string)␊ - type: "Microsoft.Peering/peeringServices/prefixes"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.AAD/domainServices␊ - */␊ - export interface DomainServices {␊ - apiVersion: "2017-01-01"␊ - /**␊ - * Resource etag␊ - */␊ - etag?: string␊ - /**␊ - * Resource location␊ - */␊ - location?: string␊ - /**␊ - * The name of the domain service.␊ - */␊ - name: string␊ - /**␊ - * Properties of the Domain Service.␊ - */␊ - properties: (DomainServiceProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.AAD/domainServices"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Domain Service.␊ - */␊ - export interface DomainServiceProperties {␊ - /**␊ - * The name of the Azure domain that the user would like to deploy Domain Services to.␊ - */␊ - domainName?: string␊ - /**␊ - * Domain Security Settings␊ - */␊ - domainSecuritySettings?: (DomainSecuritySettings | string)␊ - /**␊ - * Enabled or Disabled flag to turn on Group-based filtered sync.␊ - */␊ - filteredSync?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Secure LDAP Settings␊ - */␊ - ldapsSettings?: (LdapsSettings | string)␊ - /**␊ - * Settings for notification␊ - */␊ - notificationSettings?: (NotificationSettings1 | string)␊ - /**␊ - * The name of the virtual network that Domain Services will be deployed on. The id of the subnet that Domain Services will be deployed on. /virtualNetwork/vnetName/subnets/subnetName.␊ - */␊ - subnetId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Domain Security Settings␊ - */␊ - export interface DomainSecuritySettings {␊ - /**␊ - * A flag to determine whether or not NtlmV1 is enabled or disabled.␊ - */␊ - ntlmV1?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * A flag to determine whether or not SyncNtlmPasswords is enabled or disabled.␊ - */␊ - syncNtlmPasswords?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * A flag to determine whether or not TlsV1 is enabled or disabled.␊ - */␊ - tlsV1?: (("Enabled" | "Disabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Secure LDAP Settings␊ - */␊ - export interface LdapsSettings {␊ - /**␊ - * A flag to determine whether or not Secure LDAP access over the internet is enabled or disabled.␊ - */␊ - externalAccess?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * A flag to determine whether or not Secure LDAP is enabled or disabled.␊ - */␊ - ldaps?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * The certificate required to configure Secure LDAP. The parameter passed here should be a base64encoded representation of the certificate pfx file.␊ - */␊ - pfxCertificate?: string␊ - /**␊ - * The password to decrypt the provided Secure LDAP certificate pfx file.␊ - */␊ - pfxCertificatePassword?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Settings for notification␊ - */␊ - export interface NotificationSettings1 {␊ - /**␊ - * The list of additional recipients␊ - */␊ - additionalRecipients?: (string[] | string)␊ - /**␊ - * Should domain controller admins be notified.␊ - */␊ - notifyDcAdmins?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Should global admins be notified.␊ - */␊ - notifyGlobalAdmins?: (("Enabled" | "Disabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.AAD/domainServices␊ - */␊ - export interface DomainServices1 {␊ - apiVersion: "2017-06-01"␊ - /**␊ - * Resource etag␊ - */␊ - etag?: string␊ - /**␊ - * Resource location␊ - */␊ - location?: string␊ - /**␊ - * The name of the domain service.␊ - */␊ - name: string␊ - /**␊ - * Properties of the Domain Service.␊ - */␊ - properties: (DomainServiceProperties1 | string)␊ - resources?: DomainServicesOuContainerChildResource[]␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.AAD/domainServices"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Domain Service.␊ - */␊ - export interface DomainServiceProperties1 {␊ - /**␊ - * Domain Configuration Type␊ - */␊ - domainConfigurationType?: string␊ - /**␊ - * The name of the Azure domain that the user would like to deploy Domain Services to.␊ - */␊ - domainName?: string␊ - /**␊ - * Domain Security Settings␊ - */␊ - domainSecuritySettings?: (DomainSecuritySettings1 | string)␊ - /**␊ - * Enabled or Disabled flag to turn on Group-based filtered sync.␊ - */␊ - filteredSync?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Secure LDAP Settings␊ - */␊ - ldapsSettings?: (LdapsSettings1 | string)␊ - /**␊ - * Settings for notification␊ - */␊ - notificationSettings?: (NotificationSettings2 | string)␊ - /**␊ - * Settings for Resource Forest␊ - */␊ - resourceForestSettings?: (ResourceForestSettings | string)␊ - /**␊ - * Sku Type␊ - */␊ - sku?: string␊ - /**␊ - * The name of the virtual network that Domain Services will be deployed on. The id of the subnet that Domain Services will be deployed on. /virtualNetwork/vnetName/subnets/subnetName.␊ - */␊ - subnetId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Domain Security Settings␊ - */␊ - export interface DomainSecuritySettings1 {␊ - /**␊ - * A flag to determine whether or not NtlmV1 is enabled or disabled.␊ - */␊ - ntlmV1?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * A flag to determine whether or not SyncKerberosPasswords is enabled or disabled.␊ - */␊ - syncKerberosPasswords?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * A flag to determine whether or not SyncNtlmPasswords is enabled or disabled.␊ - */␊ - syncNtlmPasswords?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * A flag to determine whether or not SyncOnPremPasswords is enabled or disabled.␊ - */␊ - syncOnPremPasswords?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * A flag to determine whether or not TlsV1 is enabled or disabled.␊ - */␊ - tlsV1?: (("Enabled" | "Disabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Secure LDAP Settings␊ - */␊ - export interface LdapsSettings1 {␊ - /**␊ - * A flag to determine whether or not Secure LDAP access over the internet is enabled or disabled.␊ - */␊ - externalAccess?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * A flag to determine whether or not Secure LDAP is enabled or disabled.␊ - */␊ - ldaps?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * The certificate required to configure Secure LDAP. The parameter passed here should be a base64encoded representation of the certificate pfx file.␊ - */␊ - pfxCertificate?: string␊ - /**␊ - * The password to decrypt the provided Secure LDAP certificate pfx file.␊ - */␊ - pfxCertificatePassword?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Settings for notification␊ - */␊ - export interface NotificationSettings2 {␊ - /**␊ - * The list of additional recipients␊ - */␊ - additionalRecipients?: (string[] | string)␊ - /**␊ - * Should domain controller admins be notified.␊ - */␊ - notifyDcAdmins?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Should global admins be notified.␊ - */␊ - notifyGlobalAdmins?: (("Enabled" | "Disabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Settings for Resource Forest␊ - */␊ - export interface ResourceForestSettings {␊ - /**␊ - * Resource Forest␊ - */␊ - resourceForest?: string␊ - /**␊ - * List of settings for Resource Forest␊ - */␊ - settings?: (ForestTrust[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Forest Trust Setting␊ - */␊ - export interface ForestTrust {␊ - /**␊ - * Friendly Name␊ - */␊ - friendlyName?: string␊ - /**␊ - * Remote Dns ips␊ - */␊ - remoteDnsIps?: string␊ - /**␊ - * Trust Direction␊ - */␊ - trustDirection?: string␊ - /**␊ - * Trusted Domain FQDN␊ - */␊ - trustedDomainFqdn?: string␊ - /**␊ - * Trust Password␊ - */␊ - trustPassword?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Aad/domainServices/ouContainer␊ - */␊ - export interface DomainServicesOuContainerChildResource {␊ - /**␊ - * The account name␊ - */␊ - accountName?: string␊ - apiVersion: "2017-06-01"␊ - /**␊ - * The name of the OuContainer.␊ - */␊ - name: string␊ - /**␊ - * The account password␊ - */␊ - password?: string␊ - /**␊ - * The account spn␊ - */␊ - spn?: string␊ - type: "ouContainer"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Aad/domainServices/ouContainer␊ - */␊ - export interface DomainServicesOuContainer {␊ - /**␊ - * The account name␊ - */␊ - accountName?: string␊ - apiVersion: "2017-06-01"␊ - /**␊ - * The name of the OuContainer.␊ - */␊ - name: string␊ - /**␊ - * The account password␊ - */␊ - password?: string␊ - /**␊ - * The account spn␊ - */␊ - spn?: string␊ - type: "Microsoft.Aad/domainServices/ouContainer"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.SignalRService/signalR␊ - */␊ - export interface SignalR {␊ - apiVersion: "2018-10-01"␊ - /**␊ - * Azure GEO region: e.g. West US | East US | North Central US | South Central US | West Europe | North Europe | East Asia | Southeast Asia | etc. ␍␊ - * The geo region of a resource never changes after it is created.␊ - */␊ - location: string␊ - /**␊ - * The name of the SignalR resource.␊ - */␊ - name: string␊ - /**␊ - * Settings used to provision or configure the resource.␊ - */␊ - properties: (SignalRCreateOrUpdateProperties | string)␊ - /**␊ - * The billing information of the SignalR resource.␊ - */␊ - sku?: (ResourceSku4 | string)␊ - /**␊ - * A list of key value pairs that describe the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.SignalRService/signalR"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Settings used to provision or configure the resource.␊ - */␊ - export interface SignalRCreateOrUpdateProperties {␊ - /**␊ - * Cross-Origin Resource Sharing (CORS) settings.␊ - */␊ - cors?: (SignalRCorsSettings | string)␊ - /**␊ - * List of SignalR featureFlags. e.g. ServiceMode.␍␊ - * ␍␊ - * FeatureFlags that are not included in the parameters for the update operation will not be modified.␍␊ - * And the response will only include featureFlags that are explicitly set. ␍␊ - * When a featureFlag is not explicitly set, SignalR service will use its globally default value. ␍␊ - * But keep in mind, the default value doesn't mean "false". It varies in terms of different FeatureFlags.␊ - */␊ - features?: (SignalRFeature[] | string)␊ - /**␊ - * Prefix for the hostName of the SignalR service. Retained for future use.␍␊ - * The hostname will be of format: <hostNamePrefix>.service.signalr.net.␊ - */␊ - hostNamePrefix?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Cross-Origin Resource Sharing (CORS) settings.␊ - */␊ - export interface SignalRCorsSettings {␊ - /**␊ - * 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. If omitted, allow all by default.␊ - */␊ - allowedOrigins?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Feature of a SignalR resource, which controls the SignalR runtime behavior.␊ - */␊ - export interface SignalRFeature {␊ - /**␊ - * FeatureFlags is the supported features of Azure SignalR service.␍␊ - * - ServiceMode: Flag for backend server for SignalR service. Values allowed: "Default": have your own backend server; "Serverless": your application doesn't have a backend server; "Classic": for backward compatibility. Support both Default and Serverless mode but not recommended; "PredefinedOnly": for future use.␍␊ - * - EnableConnectivityLogs: "true"/"false", to enable/disable the connectivity log category respectively.␊ - */␊ - flag: (("ServiceMode" | "EnableConnectivityLogs") | string)␊ - /**␊ - * Optional properties related to this feature.␊ - */␊ - properties?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Value of the feature flag. See Azure SignalR service document https://docs.microsoft.com/azure/azure-signalr/ for allowed values.␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The billing information of the SignalR resource.␊ - */␊ - export interface ResourceSku4 {␊ - /**␊ - * Optional, integer. The unit count of SignalR resource. 1 by default.␍␊ - * ␍␊ - * If present, following values are allowed:␍␊ - * Free: 1␍␊ - * Standard: 1,2,5,10,20,50,100␊ - */␊ - capacity?: (number | string)␊ - /**␊ - * Optional string. For future use.␊ - */␊ - family?: string␊ - /**␊ - * The name of the SKU. Required.␍␊ - * ␍␊ - * Allowed values: Standard_S1, Free_F1␊ - */␊ - name: string␊ - /**␊ - * Optional string. For future use.␊ - */␊ - size?: string␊ - /**␊ - * Optional tier of this particular SKU. 'Standard' or 'Free'. ␍␊ - * ␍␊ - * \`Basic\` is deprecated, use \`Standard\` instead.␊ - */␊ - tier?: (("Free" | "Basic" | "Standard" | "Premium") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.NetApp/netAppAccounts␊ - */␊ - export interface NetAppAccounts {␊ - apiVersion: "2017-08-15"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the NetApp account␊ - */␊ - name: string␊ - /**␊ - * NetApp account properties␊ - */␊ - properties: (AccountProperties1 | string)␊ - resources?: NetAppAccountsCapacityPoolsChildResource[]␊ - /**␊ - * Resource tags␊ - */␊ - tags?: {␊ - [k: string]: unknown␊ - }␊ - type: "Microsoft.NetApp/netAppAccounts"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NetApp account properties␊ - */␊ - export interface AccountProperties1 {␊ - /**␊ - * Active Directories␊ - */␊ - activeDirectories?: (ActiveDirectory[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Active Directory␊ - */␊ - export interface ActiveDirectory {␊ - /**␊ - * Id of the Active Directory␊ - */␊ - activeDirectoryId?: string␊ - /**␊ - * Comma separated list of DNS server IP addresses for the Active Directory domain␊ - */␊ - dNS?: string␊ - /**␊ - * Name of the Active Directory domain␊ - */␊ - domain?: string␊ - /**␊ - * The Organizational Unit (OU) within the Windows Active Directory␊ - */␊ - organizationalUnit?: string␊ - /**␊ - * Plain text password of Active Directory domain administrator␊ - */␊ - password?: string␊ - /**␊ - * NetBIOS name of the SMB server. This name will be registered as a computer account in the AD and used to mount volumes␊ - */␊ - sMBServerName?: string␊ - /**␊ - * Status of the Active Directory␊ - */␊ - status?: string␊ - /**␊ - * Username of Active Directory domain administrator␊ - */␊ - username?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.NetApp/netAppAccounts/capacityPools␊ - */␊ - export interface NetAppAccountsCapacityPoolsChildResource {␊ - apiVersion: "2017-08-15"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the capacity pool␊ - */␊ - name: string␊ - /**␊ - * Pool properties␊ - */␊ - properties: (PoolProperties1 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: {␊ - [k: string]: unknown␊ - }␊ - type: "capacityPools"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Pool properties␊ - */␊ - export interface PoolProperties1 {␊ - /**␊ - * The service level of the file system.␊ - */␊ - serviceLevel?: (("Standard" | "Premium" | "Ultra") | string)␊ - /**␊ - * Provisioned size of the pool (in bytes). Allowed values are in 4TiB chunks (value must be multiply of 4398046511104).␊ - */␊ - size?: ((number & string) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.NetApp/netAppAccounts/capacityPools␊ - */␊ - export interface NetAppAccountsCapacityPools {␊ - apiVersion: "2017-08-15"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the capacity pool␊ - */␊ - name: string␊ - /**␊ - * Pool properties␊ - */␊ - properties: (PoolProperties1 | string)␊ - resources?: NetAppAccountsCapacityPoolsVolumesChildResource[]␊ - /**␊ - * Resource tags␊ - */␊ - tags?: {␊ - [k: string]: unknown␊ - }␊ - type: "Microsoft.NetApp/netAppAccounts/capacityPools"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.NetApp/netAppAccounts/capacityPools/volumes␊ - */␊ - export interface NetAppAccountsCapacityPoolsVolumesChildResource {␊ - apiVersion: "2017-08-15"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the volume␊ - */␊ - name: string␊ - /**␊ - * Volume properties␊ - */␊ - properties: (VolumeProperties1 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: {␊ - [k: string]: unknown␊ - }␊ - type: "volumes"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Volume properties␊ - */␊ - export interface VolumeProperties1 {␊ - /**␊ - * A unique file path for the volume. Used when creating mount targets␊ - */␊ - creationToken: string␊ - /**␊ - * Export policy rule␊ - */␊ - exportPolicy?: (VolumePropertiesExportPolicy | string)␊ - /**␊ - * The service level of the file system.␊ - */␊ - serviceLevel: (("Standard" | "Premium" | "Ultra") | string)␊ - /**␊ - * The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes␊ - */␊ - subnetId?: string␊ - /**␊ - * Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. Minimum size is 100 GiB. Upper limit is 100TiB.␊ - */␊ - usageThreshold?: ((number & string) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Export policy rule␊ - */␊ - export interface VolumePropertiesExportPolicy {␊ - rules?: (ExportPolicyRule[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Volume Export Policy Rule␊ - */␊ - export interface ExportPolicyRule {␊ - /**␊ - * Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names␊ - */␊ - allowedClients?: string␊ - /**␊ - * Allows CIFS protocol␊ - */␊ - cifs?: (boolean | string)␊ - /**␊ - * Allows NFSv3 protocol␊ - */␊ - nfsv3?: (boolean | string)␊ - /**␊ - * Allows NFSv4 protocol␊ - */␊ - nfsv4?: (boolean | string)␊ - /**␊ - * Order index␊ - */␊ - ruleIndex?: (number | string)␊ - /**␊ - * Read only access␊ - */␊ - unixReadOnly?: (boolean | string)␊ - /**␊ - * Read and write access␊ - */␊ - unixReadWrite?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.NetApp/netAppAccounts/capacityPools/volumes␊ - */␊ - export interface NetAppAccountsCapacityPoolsVolumes {␊ - apiVersion: "2017-08-15"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the volume␊ - */␊ - name: string␊ - /**␊ - * Volume properties␊ - */␊ - properties: (VolumeProperties1 | string)␊ - resources?: NetAppAccountsCapacityPoolsVolumesSnapshotsChildResource[]␊ - /**␊ - * Resource tags␊ - */␊ - tags?: {␊ - [k: string]: unknown␊ - }␊ - type: "Microsoft.NetApp/netAppAccounts/capacityPools/volumes"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots␊ - */␊ - export interface NetAppAccountsCapacityPoolsVolumesSnapshotsChildResource {␊ - apiVersion: "2017-08-15"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the mount target␊ - */␊ - name: string␊ - /**␊ - * Snapshot properties␊ - */␊ - properties: (SnapshotProperties1 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: {␊ - [k: string]: unknown␊ - }␊ - type: "snapshots"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Snapshot properties␊ - */␊ - export interface SnapshotProperties1 {␊ - /**␊ - * UUID v4 used to identify the FileSystem␊ - */␊ - fileSystemId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots␊ - */␊ - export interface NetAppAccountsCapacityPoolsVolumesSnapshots {␊ - apiVersion: "2017-08-15"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the mount target␊ - */␊ - name: string␊ - /**␊ - * Snapshot properties␊ - */␊ - properties: (SnapshotProperties1 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: {␊ - [k: string]: unknown␊ - }␊ - type: "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.NetApp/netAppAccounts␊ - */␊ - export interface NetAppAccounts1 {␊ - apiVersion: "2019-05-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the NetApp account␊ - */␊ - name: string␊ - /**␊ - * NetApp account properties␊ - */␊ - properties: (AccountProperties2 | string)␊ - resources?: NetAppAccountsCapacityPoolsChildResource1[]␊ - /**␊ - * Resource tags␊ - */␊ - tags?: {␊ - [k: string]: unknown␊ - }␊ - type: "Microsoft.NetApp/netAppAccounts"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NetApp account properties␊ - */␊ - export interface AccountProperties2 {␊ - /**␊ - * Active Directories␊ - */␊ - activeDirectories?: (ActiveDirectory1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Active Directory␊ - */␊ - export interface ActiveDirectory1 {␊ - /**␊ - * Id of the Active Directory␊ - */␊ - activeDirectoryId?: string␊ - /**␊ - * Comma separated list of DNS server IP addresses for the Active Directory domain␊ - */␊ - dns?: string␊ - /**␊ - * Name of the Active Directory domain␊ - */␊ - domain?: string␊ - /**␊ - * The Organizational Unit (OU) within the Windows Active Directory␊ - */␊ - organizationalUnit?: string␊ - /**␊ - * Plain text password of Active Directory domain administrator␊ - */␊ - password?: string␊ - /**␊ - * NetBIOS name of the SMB server. This name will be registered as a computer account in the AD and used to mount volumes␊ - */␊ - smbServerName?: string␊ - /**␊ - * Status of the Active Directory␊ - */␊ - status?: string␊ - /**␊ - * Username of Active Directory domain administrator␊ - */␊ - username?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.NetApp/netAppAccounts/capacityPools␊ - */␊ - export interface NetAppAccountsCapacityPoolsChildResource1 {␊ - apiVersion: "2019-05-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the capacity pool␊ - */␊ - name: string␊ - /**␊ - * Pool properties␊ - */␊ - properties: (PoolProperties2 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: {␊ - [k: string]: unknown␊ - }␊ - type: "capacityPools"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Pool properties␊ - */␊ - export interface PoolProperties2 {␊ - /**␊ - * The service level of the file system.␊ - */␊ - serviceLevel: (("Standard" | "Premium" | "Ultra") | string)␊ - /**␊ - * Provisioned size of the pool (in bytes). Allowed values are in 4TiB chunks (value must be multiply of 4398046511104).␊ - */␊ - size: ((number & string) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.NetApp/netAppAccounts/capacityPools␊ - */␊ - export interface NetAppAccountsCapacityPools1 {␊ - apiVersion: "2019-05-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the capacity pool␊ - */␊ - name: string␊ - /**␊ - * Pool properties␊ - */␊ - properties: (PoolProperties2 | string)␊ - resources?: NetAppAccountsCapacityPoolsVolumesChildResource1[]␊ - /**␊ - * Resource tags␊ - */␊ - tags?: {␊ - [k: string]: unknown␊ - }␊ - type: "Microsoft.NetApp/netAppAccounts/capacityPools"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.NetApp/netAppAccounts/capacityPools/volumes␊ - */␊ - export interface NetAppAccountsCapacityPoolsVolumesChildResource1 {␊ - apiVersion: "2019-05-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the volume␊ - */␊ - name: string␊ - /**␊ - * Volume properties␊ - */␊ - properties: (VolumeProperties2 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: {␊ - [k: string]: unknown␊ - }␊ - type: "volumes"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Volume properties␊ - */␊ - export interface VolumeProperties2 {␊ - /**␊ - * A unique file path for the volume. Used when creating mount targets␊ - */␊ - creationToken: string␊ - /**␊ - * Set of export policy rules␊ - */␊ - exportPolicy?: (VolumePropertiesExportPolicy1 | string)␊ - /**␊ - * List of mount targets␊ - */␊ - mountTargets?: (MountTargetProperties[] | string)␊ - /**␊ - * Set of protocol types␊ - */␊ - protocolTypes?: (string[] | string)␊ - /**␊ - * The service level of the file system.␊ - */␊ - serviceLevel?: (("Standard" | "Premium" | "Ultra") | string)␊ - /**␊ - * UUID v4 used to identify the Snapshot␊ - */␊ - snapshotId?: string␊ - /**␊ - * The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes␊ - */␊ - subnetId: string␊ - /**␊ - * Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. Minimum size is 100 GiB. Upper limit is 100TiB. Specified in bytes.␊ - */␊ - usageThreshold: ((number & string) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Set of export policy rules␊ - */␊ - export interface VolumePropertiesExportPolicy1 {␊ - /**␊ - * Export policy rule␊ - */␊ - rules?: (ExportPolicyRule1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Volume Export Policy Rule␊ - */␊ - export interface ExportPolicyRule1 {␊ - /**␊ - * Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names␊ - */␊ - allowedClients?: string␊ - /**␊ - * Allows CIFS protocol␊ - */␊ - cifs?: (boolean | string)␊ - /**␊ - * Allows NFSv3 protocol␊ - */␊ - nfsv3?: (boolean | string)␊ - /**␊ - * Deprecated: Will use the NFSv4.1 protocol, please use swagger version 2019-07-01 or later␊ - */␊ - nfsv4?: (boolean | string)␊ - /**␊ - * Order index␊ - */␊ - ruleIndex?: (number | string)␊ - /**␊ - * Read only access␊ - */␊ - unixReadOnly?: (boolean | string)␊ - /**␊ - * Read and write access␊ - */␊ - unixReadWrite?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Mount target properties␊ - */␊ - export interface MountTargetProperties {␊ - /**␊ - * The end of IPv4 address range to use when creating a new mount target␊ - */␊ - endIp?: string␊ - /**␊ - * UUID v4 used to identify the MountTarget␊ - */␊ - fileSystemId: string␊ - /**␊ - * The gateway of the IPv4 address range to use when creating a new mount target␊ - */␊ - gateway?: string␊ - /**␊ - * The netmask of the IPv4 address range to use when creating a new mount target␊ - */␊ - netmask?: string␊ - /**␊ - * The SMB server's Fully Qualified Domain Name, FQDN␊ - */␊ - smbServerFqdn?: string␊ - /**␊ - * The start of IPv4 address range to use when creating a new mount target␊ - */␊ - startIp?: string␊ - /**␊ - * The subnet␊ - */␊ - subnet?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.NetApp/netAppAccounts/capacityPools/volumes␊ - */␊ - export interface NetAppAccountsCapacityPoolsVolumes1 {␊ - apiVersion: "2019-05-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the volume␊ - */␊ - name: string␊ - /**␊ - * Volume properties␊ - */␊ - properties: (VolumeProperties2 | string)␊ - resources?: NetAppAccountsCapacityPoolsVolumesSnapshotsChildResource1[]␊ - /**␊ - * Resource tags␊ - */␊ - tags?: {␊ - [k: string]: unknown␊ - }␊ - type: "Microsoft.NetApp/netAppAccounts/capacityPools/volumes"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots␊ - */␊ - export interface NetAppAccountsCapacityPoolsVolumesSnapshotsChildResource1 {␊ - apiVersion: "2019-05-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the snapshot␊ - */␊ - name: string␊ - /**␊ - * Snapshot properties␊ - */␊ - properties: (SnapshotProperties2 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: {␊ - [k: string]: unknown␊ - }␊ - type: "snapshots"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Snapshot properties␊ - */␊ - export interface SnapshotProperties2 {␊ - /**␊ - * UUID v4 used to identify the FileSystem␊ - */␊ - fileSystemId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots␊ - */␊ - export interface NetAppAccountsCapacityPoolsVolumesSnapshots1 {␊ - apiVersion: "2019-05-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the snapshot␊ - */␊ - name: string␊ - /**␊ - * Snapshot properties␊ - */␊ - properties: (SnapshotProperties2 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: {␊ - [k: string]: unknown␊ - }␊ - type: "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.StorSimple/managers␊ - */␊ - export interface Managers1 {␊ - apiVersion: "2016-10-01"␊ - /**␊ - * ETag of the Manager␊ - */␊ - etag?: string␊ - /**␊ - * The Geo location of the Manager␊ - */␊ - location: string␊ - /**␊ - * The manager name␊ - */␊ - name: string␊ - /**␊ - * The properties of the Manager␊ - */␊ - properties: (ManagerProperties1 | string)␊ - resources?: (ManagersCertificatesChildResource | ManagersExtendedInformationChildResource1 | ManagersAccessControlRecordsChildResource1 | ManagersStorageAccountCredentialsChildResource1 | ManagersStorageDomainsChildResource)[]␊ - /**␊ - * Tags attached to the Manager␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.StorSimple/managers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the Manager␊ - */␊ - export interface ManagerProperties1 {␊ - /**␊ - * Intrinsic settings which refers to the type of the StorSimple manager␊ - */␊ - cisIntrinsicSettings?: (ManagerIntrinsicSettings1 | string)␊ - /**␊ - * The Sku.␊ - */␊ - sku?: (ManagerSku1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Intrinsic settings which refers to the type of the StorSimple manager␊ - */␊ - export interface ManagerIntrinsicSettings1 {␊ - /**␊ - * Refers to the type of the StorSimple Manager.␊ - */␊ - type: (("GardaV1" | "HelsinkiV1") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Sku.␊ - */␊ - export interface ManagerSku1 {␊ - /**␊ - * Refers to the sku name which should be "Standard"␊ - */␊ - name: ("Standard" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.StorSimple/managers/certificates␊ - */␊ - export interface ManagersCertificatesChildResource {␊ - apiVersion: "2016-10-01"␊ - /**␊ - * Certificate Name␊ - */␊ - name: string␊ - /**␊ - * Raw Certificate Data From IDM␊ - */␊ - properties: (RawCertificateData1 | string)␊ - type: "certificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Raw Certificate Data From IDM␊ - */␊ - export interface RawCertificateData1 {␊ - /**␊ - * Specify the Authentication type.␊ - */␊ - authType?: (("Invalid" | "AccessControlService" | "AzureActiveDirectory") | string)␊ - /**␊ - * Gets or sets the base64 encoded certificate raw data string␊ - */␊ - certificate: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.StorSimple/managers/extendedInformation␊ - */␊ - export interface ManagersExtendedInformationChildResource1 {␊ - apiVersion: "2016-10-01"␊ - /**␊ - * ETag of the Resource␊ - */␊ - etag?: string␊ - name: "vaultExtendedInfo"␊ - /**␊ - * Properties of the ManagerExtendedInfo␊ - */␊ - properties: (ManagerExtendedInfoProperties1 | string)␊ - type: "extendedInformation"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the ManagerExtendedInfo␊ - */␊ - export interface ManagerExtendedInfoProperties1 {␊ - /**␊ - * Represents the encryption algorithm used to encrypt the other keys. None - if EncryptionKey is saved in plain text format. AlgorithmName - if encryption is used␊ - */␊ - algorithm: string␊ - /**␊ - * Represents the CEK of the resource␊ - */␊ - encryptionKey?: string␊ - /**␊ - * Represents the Cert thumbprint that was used to encrypt the CEK␊ - */␊ - encryptionKeyThumbprint?: string␊ - /**␊ - * Represents the CIK of the resource␊ - */␊ - integrityKey: string␊ - /**␊ - * Represents the portal thumbprint which can be used optionally to encrypt the entire data before storing it.␊ - */␊ - portalCertificateThumbprint?: string␊ - /**␊ - * Represents the version of the ExtendedInfo object being persisted␊ - */␊ - version?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.StorSimple/managers/accessControlRecords␊ - */␊ - export interface ManagersAccessControlRecordsChildResource1 {␊ - apiVersion: "2016-10-01"␊ - /**␊ - * The name of the access control record.␊ - */␊ - name: string␊ - /**␊ - * Properties of access control record␊ - */␊ - properties: (AccessControlRecordProperties1 | string)␊ - type: "accessControlRecords"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of access control record␊ - */␊ - export interface AccessControlRecordProperties1 {␊ - /**␊ - * The Iscsi initiator name (IQN)␊ - */␊ - initiatorName: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.StorSimple/managers/storageAccountCredentials␊ - */␊ - export interface ManagersStorageAccountCredentialsChildResource1 {␊ - apiVersion: "2016-10-01"␊ - /**␊ - * The credential name.␊ - */␊ - name: string␊ - /**␊ - * Storage account properties␊ - */␊ - properties: (StorageAccountCredentialProperties1 | string)␊ - type: "storageAccountCredentials"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Storage account properties␊ - */␊ - export interface StorageAccountCredentialProperties1 {␊ - /**␊ - * This class can be used as the Type for any secret entity represented as Password, CertThumbprint, Algorithm. This class is intended to be used when the secret is encrypted with an asymmetric key pair. The encryptionAlgorithm field is mainly for future usage to potentially allow different entities encrypted using different algorithms.␊ - */␊ - accessKey?: (AsymmetricEncryptedSecret1 | string)␊ - /**␊ - * The cloud service provider.␊ - */␊ - cloudType: (("Azure" | "S3" | "S3_RRS" | "OpenStack" | "HP") | string)␊ - /**␊ - * SSL needs to be enabled or not.␊ - */␊ - enableSSL: (("Enabled" | "Disabled") | string)␊ - /**␊ - * The storage endpoint␊ - */␊ - endPoint: string␊ - /**␊ - * The storage account's geo location␊ - */␊ - location?: string␊ - /**␊ - * The storage account login␊ - */␊ - login: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * This class can be used as the Type for any secret entity represented as Password, CertThumbprint, Algorithm. This class is intended to be used when the secret is encrypted with an asymmetric key pair. The encryptionAlgorithm field is mainly for future usage to potentially allow different entities encrypted using different algorithms.␊ - */␊ - export interface AsymmetricEncryptedSecret1 {␊ - /**␊ - * Algorithm used to encrypt "Value".␊ - */␊ - encryptionAlgorithm: (("None" | "AES256" | "RSAES_PKCS1_v_1_5") | string)␊ - /**␊ - * Thumbprint certificate that was used to encrypt "Value"␊ - */␊ - encryptionCertificateThumbprint?: string␊ - /**␊ - * The value of the secret itself. If the secret is in plaintext then EncryptionAlgorithm will be none and EncryptionCertThumbprint will be null.␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.StorSimple/managers/storageDomains␊ - */␊ - export interface ManagersStorageDomainsChildResource {␊ - apiVersion: "2016-10-01"␊ - /**␊ - * The storage domain name.␊ - */␊ - name: string␊ - /**␊ - * The storage domain properties.␊ - */␊ - properties: (StorageDomainProperties | string)␊ - type: "storageDomains"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The storage domain properties.␊ - */␊ - export interface StorageDomainProperties {␊ - /**␊ - * This class can be used as the Type for any secret entity represented as Password, CertThumbprint, Algorithm. This class is intended to be used when the secret is encrypted with an asymmetric key pair. The encryptionAlgorithm field is mainly for future usage to potentially allow different entities encrypted using different algorithms.␊ - */␊ - encryptionKey?: (AsymmetricEncryptedSecret1 | string)␊ - /**␊ - * The encryption status "Enabled | Disabled".␊ - */␊ - encryptionStatus: (("Enabled" | "Disabled") | string)␊ - /**␊ - * The storage account credentials.␊ - */␊ - storageAccountCredentialIds: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.StorSimple/managers/accessControlRecords␊ - */␊ - export interface ManagersAccessControlRecords1 {␊ - apiVersion: "2016-10-01"␊ - /**␊ - * The name of the access control record.␊ - */␊ - name: string␊ - /**␊ - * Properties of access control record␊ - */␊ - properties: (AccessControlRecordProperties1 | string)␊ - type: "Microsoft.StorSimple/managers/accessControlRecords"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.StorSimple/managers/certificates␊ - */␊ - export interface ManagersCertificates {␊ - apiVersion: "2016-10-01"␊ - /**␊ - * Certificate Name␊ - */␊ - name: string␊ - /**␊ - * Raw Certificate Data From IDM␊ - */␊ - properties: (RawCertificateData1 | string)␊ - type: "Microsoft.StorSimple/managers/certificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.StorSimple/managers/devices/alertSettings␊ - */␊ - export interface ManagersDevicesAlertSettings1 {␊ - apiVersion: "2016-10-01"␊ - name: string␊ - /**␊ - * Class containing the properties of AlertSettings␊ - */␊ - properties: (AlertSettingsProperties | string)␊ - type: "Microsoft.StorSimple/managers/devices/alertSettings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class containing the properties of AlertSettings␊ - */␊ - export interface AlertSettingsProperties {␊ - /**␊ - * List of email addresses (apart from admin/co-admin of subscription) to whom the alert emails need to be sent␊ - */␊ - additionalRecipientEmailList?: (string[] | string)␊ - /**␊ - * Culture setting to be used while building alert emails. For eg: "en-US"␊ - */␊ - alertNotificationCulture: string␊ - /**␊ - * Value indicating whether user/admins will receive emails when an alert condition occurs on the system.␊ - */␊ - emailNotification: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Value indicating whether service owners will receive emails when an alert condition occurs on the system. Applicable only if emailNotification flag is Enabled.␊ - */␊ - notificationToServiceOwners: (("Enabled" | "Disabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.StorSimple/managers/devices/backupScheduleGroups␊ - */␊ - export interface ManagersDevicesBackupScheduleGroups {␊ - apiVersion: "2016-10-01"␊ - /**␊ - * The name of the schedule group.␊ - */␊ - name: string␊ - /**␊ - * The Backup Schedule Group Properties␊ - */␊ - properties: (BackupScheduleGroupProperties | string)␊ - type: "Microsoft.StorSimple/managers/devices/backupScheduleGroups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Backup Schedule Group Properties␊ - */␊ - export interface BackupScheduleGroupProperties {␊ - /**␊ - * The Time.␊ - */␊ - startTime: (Time1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Time.␊ - */␊ - export interface Time1 {␊ - /**␊ - * The hour.␊ - */␊ - hour: (number | string)␊ - /**␊ - * The minute.␊ - */␊ - minute: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.StorSimple/managers/devices/chapSettings␊ - */␊ - export interface ManagersDevicesChapSettings {␊ - apiVersion: "2016-10-01"␊ - /**␊ - * The chap user name.␊ - */␊ - name: string␊ - /**␊ - * Chap properties␊ - */␊ - properties: (ChapProperties | string)␊ - type: "Microsoft.StorSimple/managers/devices/chapSettings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Chap properties␊ - */␊ - export interface ChapProperties {␊ - /**␊ - * This class can be used as the Type for any secret entity represented as Password, CertThumbprint, Algorithm. This class is intended to be used when the secret is encrypted with an asymmetric key pair. The encryptionAlgorithm field is mainly for future usage to potentially allow different entities encrypted using different algorithms.␊ - */␊ - password: (AsymmetricEncryptedSecret1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.StorSimple/managers/devices/fileservers␊ - */␊ - export interface ManagersDevicesFileservers {␊ - apiVersion: "2016-10-01"␊ - /**␊ - * The file server name.␊ - */␊ - name: string␊ - /**␊ - * The file server properties.␊ - */␊ - properties: (FileServerProperties | string)␊ - resources?: ManagersDevicesFileserversSharesChildResource[]␊ - type: "Microsoft.StorSimple/managers/devices/fileservers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The file server properties.␊ - */␊ - export interface FileServerProperties {␊ - /**␊ - * The backup policy id.␊ - */␊ - backupScheduleGroupId: string␊ - /**␊ - * The description of the file server␊ - */␊ - description?: string␊ - /**␊ - * Domain of the file server␊ - */␊ - domainName: string␊ - /**␊ - * The storage domain id.␊ - */␊ - storageDomainId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.StorSimple/managers/devices/fileservers/shares␊ - */␊ - export interface ManagersDevicesFileserversSharesChildResource {␊ - apiVersion: "2016-10-01"␊ - /**␊ - * The file share name.␊ - */␊ - name: string␊ - /**␊ - * The File Share.␊ - */␊ - properties: (FileShareProperties2 | string)␊ - type: "shares"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The File Share.␊ - */␊ - export interface FileShareProperties2 {␊ - /**␊ - * The user/group who will have full permission in this share. Active directory email address. Example: xyz@contoso.com or Contoso\\xyz.␊ - */␊ - adminUser: string␊ - /**␊ - * The data policy.␊ - */␊ - dataPolicy: (("Invalid" | "Local" | "Tiered" | "Cloud") | string)␊ - /**␊ - * Description for file share␊ - */␊ - description?: string␊ - /**␊ - * The monitoring status.␊ - */␊ - monitoringStatus: (("Enabled" | "Disabled") | string)␊ - /**␊ - * The total provisioned capacity in Bytes␊ - */␊ - provisionedCapacityInBytes: (number | string)␊ - /**␊ - * The Share Status.␊ - */␊ - shareStatus: (("Online" | "Offline") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.StorSimple/managers/devices/fileservers/shares␊ - */␊ - export interface ManagersDevicesFileserversShares {␊ - apiVersion: "2016-10-01"␊ - /**␊ - * The file share name.␊ - */␊ - name: string␊ - /**␊ - * The File Share.␊ - */␊ - properties: (FileShareProperties2 | string)␊ - type: "Microsoft.StorSimple/managers/devices/fileservers/shares"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.StorSimple/managers/devices/iscsiservers␊ - */␊ - export interface ManagersDevicesIscsiservers {␊ - apiVersion: "2016-10-01"␊ - /**␊ - * The iSCSI server name.␊ - */␊ - name: string␊ - /**␊ - * The iSCSI server properties.␊ - */␊ - properties: (ISCSIServerProperties | string)␊ - resources?: ManagersDevicesIscsiserversDisksChildResource[]␊ - type: "Microsoft.StorSimple/managers/devices/iscsiservers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The iSCSI server properties.␊ - */␊ - export interface ISCSIServerProperties {␊ - /**␊ - * The backup policy id.␊ - */␊ - backupScheduleGroupId: string␊ - /**␊ - * The chap id.␊ - */␊ - chapId?: string␊ - /**␊ - * The description.␊ - */␊ - description?: string␊ - /**␊ - * The reverse chap id.␊ - */␊ - reverseChapId?: string␊ - /**␊ - * The storage domain id.␊ - */␊ - storageDomainId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.StorSimple/managers/devices/iscsiservers/disks␊ - */␊ - export interface ManagersDevicesIscsiserversDisksChildResource {␊ - apiVersion: "2016-10-01"␊ - /**␊ - * The disk name.␊ - */␊ - name: string␊ - /**␊ - * The iSCSI disk properties.␊ - */␊ - properties: (ISCSIDiskProperties | string)␊ - type: "disks"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The iSCSI disk properties.␊ - */␊ - export interface ISCSIDiskProperties {␊ - /**␊ - * The access control records.␊ - */␊ - accessControlRecords: (string[] | string)␊ - /**␊ - * The data policy.␊ - */␊ - dataPolicy: (("Invalid" | "Local" | "Tiered" | "Cloud") | string)␊ - /**␊ - * The description.␊ - */␊ - description?: string␊ - /**␊ - * The disk status.␊ - */␊ - diskStatus: (("Online" | "Offline") | string)␊ - /**␊ - * The monitoring.␊ - */␊ - monitoringStatus: (("Enabled" | "Disabled") | string)␊ - /**␊ - * The provisioned capacity in bytes.␊ - */␊ - provisionedCapacityInBytes: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.StorSimple/managers/devices/iscsiservers/disks␊ - */␊ - export interface ManagersDevicesIscsiserversDisks {␊ - apiVersion: "2016-10-01"␊ - /**␊ - * The disk name.␊ - */␊ - name: string␊ - /**␊ - * The iSCSI disk properties.␊ - */␊ - properties: (ISCSIDiskProperties | string)␊ - type: "Microsoft.StorSimple/managers/devices/iscsiservers/disks"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.StorSimple/managers/extendedInformation␊ - */␊ - export interface ManagersExtendedInformation1 {␊ - apiVersion: "2016-10-01"␊ - /**␊ - * ETag of the Resource␊ - */␊ - etag?: string␊ - name: string␊ - /**␊ - * Properties of the ManagerExtendedInfo␊ - */␊ - properties: (ManagerExtendedInfoProperties1 | string)␊ - type: "Microsoft.StorSimple/managers/extendedInformation"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.StorSimple/managers/storageAccountCredentials␊ - */␊ - export interface ManagersStorageAccountCredentials1 {␊ - apiVersion: "2016-10-01"␊ - /**␊ - * The credential name.␊ - */␊ - name: string␊ - /**␊ - * Storage account properties␊ - */␊ - properties: (StorageAccountCredentialProperties1 | string)␊ - type: "Microsoft.StorSimple/managers/storageAccountCredentials"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.StorSimple/managers/storageDomains␊ - */␊ - export interface ManagersStorageDomains {␊ - apiVersion: "2016-10-01"␊ - /**␊ - * The storage domain name.␊ - */␊ - name: string␊ - /**␊ - * The storage domain properties.␊ - */␊ - properties: (StorageDomainProperties | string)␊ - type: "Microsoft.StorSimple/managers/storageDomains"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Maps/accounts␊ - */␊ - export interface Accounts9 {␊ - apiVersion: "2017-01-01-preview"␊ - /**␊ - * The location of the resource.␊ - */␊ - location: string␊ - /**␊ - * The name of the Maps Account.␊ - */␊ - name: string␊ - /**␊ - * The SKU of the Maps Account.␊ - */␊ - sku: (Sku60 | string)␊ - /**␊ - * Gets or sets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Maps/accounts"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The SKU of the Maps Account.␊ - */␊ - export interface Sku60 {␊ - /**␊ - * The name of the SKU, in standard format (such as S0).␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Maps/accounts␊ - */␊ - export interface Accounts10 {␊ - apiVersion: "2020-02-01-preview"␊ - /**␊ - * The location of the resource.␊ - */␊ - location: string␊ - /**␊ - * The name of the Maps Account.␊ - */␊ - name: string␊ - resources?: (AccountsPrivateAtlasesChildResource | AccountsCreatorsChildResource)[]␊ - /**␊ - * The SKU of the Maps Account.␊ - */␊ - sku: (Sku61 | string)␊ - /**␊ - * Gets or sets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). Each tag must have a key no greater than 128 characters and value no greater than 256 characters.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Maps/accounts"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Maps/accounts/privateAtlases␊ - */␊ - export interface AccountsPrivateAtlasesChildResource {␊ - apiVersion: "2020-02-01-preview"␊ - /**␊ - * The location of the resource.␊ - */␊ - location: string␊ - /**␊ - * The name of the Private Atlas instance.␊ - */␊ - name: string␊ - /**␊ - * Gets or sets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "privateAtlases"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Maps/accounts/creators␊ - */␊ - export interface AccountsCreatorsChildResource {␊ - apiVersion: "2020-02-01-preview"␊ - /**␊ - * The location of the resource.␊ - */␊ - location: string␊ - /**␊ - * The name of the Maps Creator instance.␊ - */␊ - name: string␊ - /**␊ - * Gets or sets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "creators"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The SKU of the Maps Account.␊ - */␊ - export interface Sku61 {␊ - /**␊ - * The name of the SKU, in standard format (such as S0).␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Maps/accounts/privateAtlases␊ - */␊ - export interface AccountsPrivateAtlases {␊ - apiVersion: "2020-02-01-preview"␊ - /**␊ - * The location of the resource.␊ - */␊ - location: string␊ - /**␊ - * The name of the Private Atlas instance.␊ - */␊ - name: string␊ - /**␊ - * Gets or sets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Maps/accounts/privateAtlases"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ManagedIdentity/userAssignedIdentities␊ - */␊ - export interface UserAssignedIdentities {␊ - apiVersion: "2015-08-31-preview"␊ - /**␊ - * The geo-location where the resource lives␊ - */␊ - location: string␊ - /**␊ - * The name of the identity resource.␊ - */␊ - name: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.ManagedIdentity/userAssignedIdentities"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ManagedIdentity/userAssignedIdentities␊ - */␊ - export interface UserAssignedIdentities1 {␊ - apiVersion: "2018-11-30"␊ - /**␊ - * The geo-location where the resource lives␊ - */␊ - location: string␊ - /**␊ - * The name of the identity resource.␊ - */␊ - name: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.ManagedIdentity/userAssignedIdentities"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.HDInsight/clusters␊ - */␊ - export interface Clusters16 {␊ - apiVersion: "2015-03-01-preview"␊ - /**␊ - * Identity for the cluster.␊ - */␊ - identity?: (ClusterIdentity | string)␊ - /**␊ - * The location of the cluster.␊ - */␊ - location?: string␊ - /**␊ - * The name of the cluster.␊ - */␊ - name: string␊ - /**␊ - * The cluster create parameters.␊ - */␊ - properties: (ClusterCreateProperties | string)␊ - resources?: (ClustersApplicationsChildResource2 | ClustersExtensionsChildResource)[]␊ - /**␊ - * The resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.HDInsight/clusters"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the cluster.␊ - */␊ - export interface ClusterIdentity {␊ - /**␊ - * The type of identity used for the cluster. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities.␊ - */␊ - type?: (("SystemAssigned" | "UserAssigned" | "SystemAssigned, UserAssigned" | "None") | string)␊ - /**␊ - * The list of user identities associated with the cluster. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.␊ - */␊ - userAssignedIdentities?: ({␊ - [k: string]: Componentsc51Ht8Schemasclusteridentitypropertiesuserassignedidentitiesadditionalproperties␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - export interface Componentsc51Ht8Schemasclusteridentitypropertiesuserassignedidentitiesadditionalproperties {␊ - /**␊ - * The tenant id of user assigned identity.␊ - */␊ - tenantId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The cluster create parameters.␊ - */␊ - export interface ClusterCreateProperties {␊ - /**␊ - * The cluster definition.␊ - */␊ - clusterDefinition?: (ClusterDefinition | string)␊ - /**␊ - * The version of the cluster.␊ - */␊ - clusterVersion?: string␊ - /**␊ - * The compute isolation properties.␊ - */␊ - computeIsolationProperties?: (ComputeIsolationProperties | string)␊ - /**␊ - * Describes the compute profile.␊ - */␊ - computeProfile?: (ComputeProfile | string)␊ - /**␊ - * The disk encryption properties␊ - */␊ - diskEncryptionProperties?: (DiskEncryptionProperties | string)␊ - /**␊ - * The encryption-in-transit properties.␊ - */␊ - encryptionInTransitProperties?: (EncryptionInTransitProperties | string)␊ - /**␊ - * The kafka rest proxy configuration which contains AAD security group information.␊ - */␊ - kafkaRestProperties?: (KafkaRestProperties | string)␊ - /**␊ - * The minimal supported tls version.␊ - */␊ - minSupportedTlsVersion?: string␊ - /**␊ - * The network properties.␊ - */␊ - networkProperties?: (NetworkProperties | string)␊ - /**␊ - * The type of operating system.␊ - */␊ - osType?: (("Windows" | "Linux") | string)␊ - /**␊ - * The security profile which contains Ssh public key for the HDInsight cluster.␊ - */␊ - securityProfile?: (SecurityProfile | string)␊ - /**␊ - * The storage profile.␊ - */␊ - storageProfile?: (StorageProfile12 | string)␊ - /**␊ - * The cluster tier.␊ - */␊ - tier?: (("Standard" | "Premium") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The cluster definition.␊ - */␊ - export interface ClusterDefinition {␊ - /**␊ - * The link to the blueprint.␊ - */␊ - blueprint?: string␊ - /**␊ - * The versions of different services in the cluster.␊ - */␊ - componentVersion?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The cluster configurations.␊ - */␊ - configurations?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The type of cluster.␊ - */␊ - kind?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The compute isolation properties.␊ - */␊ - export interface ComputeIsolationProperties {␊ - /**␊ - * The flag indicates whether enable compute isolation or not.␊ - */␊ - enableComputeIsolation?: (boolean | string)␊ - /**␊ - * The host sku.␊ - */␊ - hostSku?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the compute profile.␊ - */␊ - export interface ComputeProfile {␊ - /**␊ - * The list of roles in the cluster.␊ - */␊ - roles?: (Role[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a role on the cluster.␊ - */␊ - export interface Role {␊ - /**␊ - * The autoscale request parameters␊ - */␊ - autoscale?: (Autoscale | string)␊ - /**␊ - * The data disks groups for the role.␊ - */␊ - dataDisksGroups?: (DataDisksGroups[] | string)␊ - /**␊ - * Indicates whether encrypt the data disks.␊ - */␊ - encryptDataDisks?: (boolean | string)␊ - /**␊ - * The hardware profile.␊ - */␊ - hardwareProfile?: (HardwareProfile7 | string)␊ - /**␊ - * The minimum instance count of the cluster.␊ - */␊ - minInstanceCount?: (number | string)␊ - /**␊ - * The name of the role.␊ - */␊ - name?: string␊ - /**␊ - * The Linux operation systems profile.␊ - */␊ - osProfile?: (OsProfile1 | string)␊ - /**␊ - * The list of script actions on the role.␊ - */␊ - scriptActions?: (ScriptAction[] | string)␊ - /**␊ - * The instance count of the cluster.␊ - */␊ - targetInstanceCount?: (number | string)␊ - /**␊ - * The virtual network properties.␊ - */␊ - virtualNetworkProfile?: (VirtualNetworkProfile | string)␊ - /**␊ - * The name of the virtual machine group.␊ - */␊ - VMGroupName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The autoscale request parameters␊ - */␊ - export interface Autoscale {␊ - /**␊ - * The load-based autoscale request parameters␊ - */␊ - capacity?: (AutoscaleCapacity | string)␊ - /**␊ - * Schedule-based autoscale request parameters␊ - */␊ - recurrence?: (AutoscaleRecurrence | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The load-based autoscale request parameters␊ - */␊ - export interface AutoscaleCapacity {␊ - /**␊ - * The maximum instance count of the cluster␊ - */␊ - maxInstanceCount?: (number | string)␊ - /**␊ - * The minimum instance count of the cluster␊ - */␊ - minInstanceCount?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Schedule-based autoscale request parameters␊ - */␊ - export interface AutoscaleRecurrence {␊ - /**␊ - * Array of schedule-based autoscale rules␊ - */␊ - schedule?: (AutoscaleSchedule[] | string)␊ - /**␊ - * The time zone for the autoscale schedule times␊ - */␊ - timeZone?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for a schedule-based autoscale rule, consisting of an array of days + a time and capacity␊ - */␊ - export interface AutoscaleSchedule {␊ - /**␊ - * Days of the week for a schedule-based autoscale rule␊ - */␊ - days?: (("Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday" | "Sunday")[] | string)␊ - /**␊ - * Time and capacity request parameters␊ - */␊ - timeAndCapacity?: (AutoscaleTimeAndCapacity | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Time and capacity request parameters␊ - */␊ - export interface AutoscaleTimeAndCapacity {␊ - /**␊ - * The maximum instance count of the cluster␊ - */␊ - maxInstanceCount?: (number | string)␊ - /**␊ - * The minimum instance count of the cluster␊ - */␊ - minInstanceCount?: (number | string)␊ - /**␊ - * 24-hour time in the form xx:xx␊ - */␊ - time?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The data disks groups for the role.␊ - */␊ - export interface DataDisksGroups {␊ - /**␊ - * The number of disks per node.␊ - */␊ - disksPerNode?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The hardware profile.␊ - */␊ - export interface HardwareProfile7 {␊ - /**␊ - * The size of the VM␊ - */␊ - vmSize?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Linux operation systems profile.␊ - */␊ - export interface OsProfile1 {␊ - /**␊ - * The ssh username, password, and ssh public key.␊ - */␊ - linuxOperatingSystemProfile?: (LinuxOperatingSystemProfile | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The ssh username, password, and ssh public key.␊ - */␊ - export interface LinuxOperatingSystemProfile {␊ - /**␊ - * The password.␊ - */␊ - password?: string␊ - /**␊ - * The list of SSH public keys.␊ - */␊ - sshProfile?: (SshProfile | string)␊ - /**␊ - * The username.␊ - */␊ - username?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The list of SSH public keys.␊ - */␊ - export interface SshProfile {␊ - /**␊ - * The list of SSH public keys.␊ - */␊ - publicKeys?: (SshPublicKey6[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The SSH public key for the cluster nodes.␊ - */␊ - export interface SshPublicKey6 {␊ - /**␊ - * The certificate for SSH.␊ - */␊ - certificateData?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a script action on role on the cluster.␊ - */␊ - export interface ScriptAction {␊ - /**␊ - * The name of the script action.␊ - */␊ - name: string␊ - /**␊ - * The parameters for the script provided.␊ - */␊ - parameters: string␊ - /**␊ - * The URI to the script.␊ - */␊ - uri: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The virtual network properties.␊ - */␊ - export interface VirtualNetworkProfile {␊ - /**␊ - * The ID of the virtual network.␊ - */␊ - id?: string␊ - /**␊ - * The name of the subnet.␊ - */␊ - subnet?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The disk encryption properties␊ - */␊ - export interface DiskEncryptionProperties {␊ - /**␊ - * Algorithm identifier for encryption, default RSA-OAEP.␊ - */␊ - encryptionAlgorithm?: (("RSA-OAEP" | "RSA-OAEP-256" | "RSA1_5") | string)␊ - /**␊ - * Indicates whether or not resource disk encryption is enabled.␊ - */␊ - encryptionAtHost?: (boolean | string)␊ - /**␊ - * Key name that is used for enabling disk encryption.␊ - */␊ - keyName?: string␊ - /**␊ - * Specific key version that is used for enabling disk encryption.␊ - */␊ - keyVersion?: string␊ - /**␊ - * Resource ID of Managed Identity that is used to access the key vault.␊ - */␊ - msiResourceId?: string␊ - /**␊ - * Base key vault URI where the customers key is located eg. https://myvault.vault.azure.net␊ - */␊ - vaultUri?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encryption-in-transit properties.␊ - */␊ - export interface EncryptionInTransitProperties {␊ - /**␊ - * Indicates whether or not inter cluster node communication is encrypted in transit.␊ - */␊ - isEncryptionInTransitEnabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The kafka rest proxy configuration which contains AAD security group information.␊ - */␊ - export interface KafkaRestProperties {␊ - /**␊ - * The information of AAD security group.␊ - */␊ - clientGroupInfo?: (ClientGroupInfo | string)␊ - /**␊ - * The configurations that need to be overriden.␊ - */␊ - configurationOverride?: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The information of AAD security group.␊ - */␊ - export interface ClientGroupInfo {␊ - /**␊ - * The AAD security group id.␊ - */␊ - groupId?: string␊ - /**␊ - * The AAD security group name.␊ - */␊ - groupName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The network properties.␊ - */␊ - export interface NetworkProperties {␊ - /**␊ - * Indicates whether or not private link is enabled.␊ - */␊ - privateLink?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * The direction for the resource provider connection.␊ - */␊ - resourceProviderConnection?: (("Inbound" | "Outbound") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The security profile which contains Ssh public key for the HDInsight cluster.␊ - */␊ - export interface SecurityProfile {␊ - /**␊ - * The resource ID of the user's Azure Active Directory Domain Service.␊ - */␊ - aaddsResourceId?: string␊ - /**␊ - * Optional. The Distinguished Names for cluster user groups␊ - */␊ - clusterUsersGroupDNs?: (string[] | string)␊ - /**␊ - * The directory type.␊ - */␊ - directoryType?: ("ActiveDirectory" | string)␊ - /**␊ - * The organization's active directory domain.␊ - */␊ - domain?: string␊ - /**␊ - * The domain user account that will have admin privileges on the cluster.␊ - */␊ - domainUsername?: string␊ - /**␊ - * The domain admin password.␊ - */␊ - domainUserPassword?: string␊ - /**␊ - * The LDAPS protocol URLs to communicate with the Active Directory.␊ - */␊ - ldapsUrls?: (string[] | string)␊ - /**␊ - * User assigned identity that has permissions to read and create cluster-related artifacts in the user's AADDS.␊ - */␊ - msiResourceId?: string␊ - /**␊ - * The organizational unit within the Active Directory to place the cluster and service accounts.␊ - */␊ - organizationalUnitDN?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The storage profile.␊ - */␊ - export interface StorageProfile12 {␊ - /**␊ - * The list of storage accounts in the cluster.␊ - */␊ - storageaccounts?: (StorageAccount6[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The storage Account.␊ - */␊ - export interface StorageAccount6 {␊ - /**␊ - * The container in the storage account, only to be specified for WASB storage accounts.␊ - */␊ - container?: string␊ - /**␊ - * The file share name.␊ - */␊ - fileshare?: string␊ - /**␊ - * The filesystem, only to be specified for Azure Data Lake Storage Gen 2.␊ - */␊ - fileSystem?: string␊ - /**␊ - * Whether or not the storage account is the default storage account.␊ - */␊ - isDefault?: (boolean | string)␊ - /**␊ - * The storage account access key.␊ - */␊ - key?: string␊ - /**␊ - * The managed identity (MSI) that is allowed to access the storage account, only to be specified for Azure Data Lake Storage Gen 2.␊ - */␊ - msiResourceId?: string␊ - /**␊ - * The name of the storage account.␊ - */␊ - name?: string␊ - /**␊ - * The resource ID of storage account, only to be specified for Azure Data Lake Storage Gen 2.␊ - */␊ - resourceId?: string␊ - /**␊ - * The shared access signature key.␊ - */␊ - saskey?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.HDInsight/clusters/applications␊ - */␊ - export interface ClustersApplicationsChildResource2 {␊ - apiVersion: "2015-03-01-preview"␊ - /**␊ - * The ETag for the application␊ - */␊ - etag?: string␊ - /**␊ - * The constant value for the application name.␊ - */␊ - name: string␊ - /**␊ - * The HDInsight cluster application GET response.␊ - */␊ - properties: (ApplicationProperties | string)␊ - /**␊ - * The tags for the application.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "applications"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The HDInsight cluster application GET response.␊ - */␊ - export interface ApplicationProperties {␊ - /**␊ - * The application type.␊ - */␊ - applicationType?: string␊ - /**␊ - * Describes the compute profile.␊ - */␊ - computeProfile?: (ComputeProfile | string)␊ - /**␊ - * The list of errors.␊ - */␊ - errors?: (Errors[] | string)␊ - /**␊ - * The list of application HTTPS endpoints.␊ - */␊ - httpsEndpoints?: (ApplicationGetHttpsEndpoint[] | string)␊ - /**␊ - * The list of install script actions.␊ - */␊ - installScriptActions?: (RuntimeScriptAction[] | string)␊ - /**␊ - * The list of application SSH endpoints.␊ - */␊ - sshEndpoints?: (ApplicationGetEndpoint[] | string)␊ - /**␊ - * The list of uninstall script actions.␊ - */␊ - uninstallScriptActions?: (RuntimeScriptAction[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The error message associated with the cluster creation.␊ - */␊ - export interface Errors {␊ - /**␊ - * The error code.␊ - */␊ - code?: string␊ - /**␊ - * The error message.␊ - */␊ - message?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Gets the application HTTP endpoints.␊ - */␊ - export interface ApplicationGetHttpsEndpoint {␊ - /**␊ - * The list of access modes for the application.␊ - */␊ - accessModes?: (string[] | string)␊ - /**␊ - * The destination port to connect to.␊ - */␊ - destinationPort?: (number | string)␊ - /**␊ - * The value indicates whether to disable GatewayAuth.␊ - */␊ - disableGatewayAuth?: (boolean | string)␊ - /**␊ - * The private ip address of the endpoint.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The subdomain suffix of the application.␊ - */␊ - subDomainSuffix?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a script action on a running cluster.␊ - */␊ - export interface RuntimeScriptAction {␊ - /**␊ - * The name of the script action.␊ - */␊ - name: string␊ - /**␊ - * The parameters for the script␊ - */␊ - parameters?: string␊ - /**␊ - * The list of roles where script will be executed.␊ - */␊ - roles: (string[] | string)␊ - /**␊ - * The URI to the script.␊ - */␊ - uri: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Gets the application SSH endpoint␊ - */␊ - export interface ApplicationGetEndpoint {␊ - /**␊ - * The destination port to connect to.␊ - */␊ - destinationPort?: (number | string)␊ - /**␊ - * The location of the endpoint.␊ - */␊ - location?: string␊ - /**␊ - * The private ip address of the endpoint.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The public port to connect to.␊ - */␊ - publicPort?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The selected configurations for azure monitor.␊ - */␊ - export interface AzureMonitorSelectedConfigurations {␊ - /**␊ - * The configuration version.␊ - */␊ - configurationVersion?: string␊ - /**␊ - * The global configurations of selected configurations.␊ - */␊ - globalConfigurations?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The table list.␊ - */␊ - tableList?: (AzureMonitorTableConfiguration[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The table configuration for the Log Analytics integration.␊ - */␊ - export interface AzureMonitorTableConfiguration {␊ - /**␊ - * The name.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.HDInsight/clusters/applications␊ - */␊ - export interface ClustersApplications2 {␊ - apiVersion: "2015-03-01-preview"␊ - /**␊ - * The ETag for the application␊ - */␊ - etag?: string␊ - /**␊ - * The constant value for the application name.␊ - */␊ - name: string␊ - /**␊ - * The HDInsight cluster application GET response.␊ - */␊ - properties: (ApplicationProperties | string)␊ - /**␊ - * The tags for the application.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.HDInsight/clusters/applications"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.HDInsight/clusters␊ - */␊ - export interface Clusters17 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Identity for the cluster.␊ - */␊ - identity?: (ClusterIdentity1 | string)␊ - /**␊ - * The location of the cluster.␊ - */␊ - location?: string␊ - /**␊ - * The name of the cluster.␊ - */␊ - name: string␊ - /**␊ - * The cluster create parameters.␊ - */␊ - properties: (ClusterCreateProperties1 | string)␊ - resources?: (ClustersApplicationsChildResource3 | ClustersExtensionsChildResource1)[]␊ - /**␊ - * The resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.HDInsight/clusters"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the cluster.␊ - */␊ - export interface ClusterIdentity1 {␊ - /**␊ - * The type of identity used for the cluster. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities.␊ - */␊ - type?: (("SystemAssigned" | "UserAssigned" | "SystemAssigned, UserAssigned" | "None") | string)␊ - /**␊ - * The list of user identities associated with the cluster. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.␊ - */␊ - userAssignedIdentities?: ({␊ - [k: string]: Componentsc51Ht8Schemasclusteridentitypropertiesuserassignedidentitiesadditionalproperties1␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - export interface Componentsc51Ht8Schemasclusteridentitypropertiesuserassignedidentitiesadditionalproperties1 {␊ - /**␊ - * The tenant id of user assigned identity.␊ - */␊ - tenantId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The cluster create parameters.␊ - */␊ - export interface ClusterCreateProperties1 {␊ - /**␊ - * The cluster definition.␊ - */␊ - clusterDefinition?: (ClusterDefinition1 | string)␊ - /**␊ - * The version of the cluster.␊ - */␊ - clusterVersion?: string␊ - /**␊ - * The compute isolation properties.␊ - */␊ - computeIsolationProperties?: (ComputeIsolationProperties1 | string)␊ - /**␊ - * Describes the compute profile.␊ - */␊ - computeProfile?: (ComputeProfile1 | string)␊ - /**␊ - * The disk encryption properties␊ - */␊ - diskEncryptionProperties?: (DiskEncryptionProperties1 | string)␊ - /**␊ - * The encryption-in-transit properties.␊ - */␊ - encryptionInTransitProperties?: (EncryptionInTransitProperties1 | string)␊ - /**␊ - * The kafka rest proxy configuration which contains AAD security group information.␊ - */␊ - kafkaRestProperties?: (KafkaRestProperties1 | string)␊ - /**␊ - * The minimal supported tls version.␊ - */␊ - minSupportedTlsVersion?: string␊ - /**␊ - * The network properties.␊ - */␊ - networkProperties?: (NetworkProperties1 | string)␊ - /**␊ - * The type of operating system.␊ - */␊ - osType?: (("Windows" | "Linux") | string)␊ - /**␊ - * The security profile which contains Ssh public key for the HDInsight cluster.␊ - */␊ - securityProfile?: (SecurityProfile1 | string)␊ - /**␊ - * The storage profile.␊ - */␊ - storageProfile?: (StorageProfile13 | string)␊ - /**␊ - * The cluster tier.␊ - */␊ - tier?: (("Standard" | "Premium") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The cluster definition.␊ - */␊ - export interface ClusterDefinition1 {␊ - /**␊ - * The link to the blueprint.␊ - */␊ - blueprint?: string␊ - /**␊ - * The versions of different services in the cluster.␊ - */␊ - componentVersion?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The cluster configurations.␊ - */␊ - configurations?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The type of cluster.␊ - */␊ - kind?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The compute isolation properties.␊ - */␊ - export interface ComputeIsolationProperties1 {␊ - /**␊ - * The flag indicates whether enable compute isolation or not.␊ - */␊ - enableComputeIsolation?: (boolean | string)␊ - /**␊ - * The host sku.␊ - */␊ - hostSku?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the compute profile.␊ - */␊ - export interface ComputeProfile1 {␊ - /**␊ - * The list of roles in the cluster.␊ - */␊ - roles?: (Role1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a role on the cluster.␊ - */␊ - export interface Role1 {␊ - /**␊ - * The autoscale request parameters␊ - */␊ - autoscale?: (Autoscale1 | string)␊ - /**␊ - * The data disks groups for the role.␊ - */␊ - dataDisksGroups?: (DataDisksGroups1[] | string)␊ - /**␊ - * Indicates whether encrypt the data disks.␊ - */␊ - encryptDataDisks?: (boolean | string)␊ - /**␊ - * The hardware profile.␊ - */␊ - hardwareProfile?: (HardwareProfile8 | string)␊ - /**␊ - * The minimum instance count of the cluster.␊ - */␊ - minInstanceCount?: (number | string)␊ - /**␊ - * The name of the role.␊ - */␊ - name?: string␊ - /**␊ - * The Linux operation systems profile.␊ - */␊ - osProfile?: (OsProfile2 | string)␊ - /**␊ - * The list of script actions on the role.␊ - */␊ - scriptActions?: (ScriptAction1[] | string)␊ - /**␊ - * The instance count of the cluster.␊ - */␊ - targetInstanceCount?: (number | string)␊ - /**␊ - * The virtual network properties.␊ - */␊ - virtualNetworkProfile?: (VirtualNetworkProfile1 | string)␊ - /**␊ - * The name of the virtual machine group.␊ - */␊ - VMGroupName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The autoscale request parameters␊ - */␊ - export interface Autoscale1 {␊ - /**␊ - * The load-based autoscale request parameters␊ - */␊ - capacity?: (AutoscaleCapacity1 | string)␊ - /**␊ - * Schedule-based autoscale request parameters␊ - */␊ - recurrence?: (AutoscaleRecurrence1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The load-based autoscale request parameters␊ - */␊ - export interface AutoscaleCapacity1 {␊ - /**␊ - * The maximum instance count of the cluster␊ - */␊ - maxInstanceCount?: (number | string)␊ - /**␊ - * The minimum instance count of the cluster␊ - */␊ - minInstanceCount?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Schedule-based autoscale request parameters␊ - */␊ - export interface AutoscaleRecurrence1 {␊ - /**␊ - * Array of schedule-based autoscale rules␊ - */␊ - schedule?: (AutoscaleSchedule1[] | string)␊ - /**␊ - * The time zone for the autoscale schedule times␊ - */␊ - timeZone?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for a schedule-based autoscale rule, consisting of an array of days + a time and capacity␊ - */␊ - export interface AutoscaleSchedule1 {␊ - /**␊ - * Days of the week for a schedule-based autoscale rule␊ - */␊ - days?: (("Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday" | "Sunday")[] | string)␊ - /**␊ - * Time and capacity request parameters␊ - */␊ - timeAndCapacity?: (AutoscaleTimeAndCapacity1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Time and capacity request parameters␊ - */␊ - export interface AutoscaleTimeAndCapacity1 {␊ - /**␊ - * The maximum instance count of the cluster␊ - */␊ - maxInstanceCount?: (number | string)␊ - /**␊ - * The minimum instance count of the cluster␊ - */␊ - minInstanceCount?: (number | string)␊ - /**␊ - * 24-hour time in the form xx:xx␊ - */␊ - time?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The data disks groups for the role.␊ - */␊ - export interface DataDisksGroups1 {␊ - /**␊ - * The number of disks per node.␊ - */␊ - disksPerNode?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The hardware profile.␊ - */␊ - export interface HardwareProfile8 {␊ - /**␊ - * The size of the VM␊ - */␊ - vmSize?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Linux operation systems profile.␊ - */␊ - export interface OsProfile2 {␊ - /**␊ - * The ssh username, password, and ssh public key.␊ - */␊ - linuxOperatingSystemProfile?: (LinuxOperatingSystemProfile1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The ssh username, password, and ssh public key.␊ - */␊ - export interface LinuxOperatingSystemProfile1 {␊ - /**␊ - * The password.␊ - */␊ - password?: string␊ - /**␊ - * The list of SSH public keys.␊ - */␊ - sshProfile?: (SshProfile1 | string)␊ - /**␊ - * The username.␊ - */␊ - username?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The list of SSH public keys.␊ - */␊ - export interface SshProfile1 {␊ - /**␊ - * The list of SSH public keys.␊ - */␊ - publicKeys?: (SshPublicKey7[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The SSH public key for the cluster nodes.␊ - */␊ - export interface SshPublicKey7 {␊ - /**␊ - * The certificate for SSH.␊ - */␊ - certificateData?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a script action on role on the cluster.␊ - */␊ - export interface ScriptAction1 {␊ - /**␊ - * The name of the script action.␊ - */␊ - name: string␊ - /**␊ - * The parameters for the script provided.␊ - */␊ - parameters: string␊ - /**␊ - * The URI to the script.␊ - */␊ - uri: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The virtual network properties.␊ - */␊ - export interface VirtualNetworkProfile1 {␊ - /**␊ - * The ID of the virtual network.␊ - */␊ - id?: string␊ - /**␊ - * The name of the subnet.␊ - */␊ - subnet?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The disk encryption properties␊ - */␊ - export interface DiskEncryptionProperties1 {␊ - /**␊ - * Algorithm identifier for encryption, default RSA-OAEP.␊ - */␊ - encryptionAlgorithm?: (("RSA-OAEP" | "RSA-OAEP-256" | "RSA1_5") | string)␊ - /**␊ - * Indicates whether or not resource disk encryption is enabled.␊ - */␊ - encryptionAtHost?: (boolean | string)␊ - /**␊ - * Key name that is used for enabling disk encryption.␊ - */␊ - keyName?: string␊ - /**␊ - * Specific key version that is used for enabling disk encryption.␊ - */␊ - keyVersion?: string␊ - /**␊ - * Resource ID of Managed Identity that is used to access the key vault.␊ - */␊ - msiResourceId?: string␊ - /**␊ - * Base key vault URI where the customers key is located eg. https://myvault.vault.azure.net␊ - */␊ - vaultUri?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encryption-in-transit properties.␊ - */␊ - export interface EncryptionInTransitProperties1 {␊ - /**␊ - * Indicates whether or not inter cluster node communication is encrypted in transit.␊ - */␊ - isEncryptionInTransitEnabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The kafka rest proxy configuration which contains AAD security group information.␊ - */␊ - export interface KafkaRestProperties1 {␊ - /**␊ - * The information of AAD security group.␊ - */␊ - clientGroupInfo?: (ClientGroupInfo1 | string)␊ - /**␊ - * The configurations that need to be overriden.␊ - */␊ - configurationOverride?: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The information of AAD security group.␊ - */␊ - export interface ClientGroupInfo1 {␊ - /**␊ - * The AAD security group id.␊ - */␊ - groupId?: string␊ - /**␊ - * The AAD security group name.␊ - */␊ - groupName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The network properties.␊ - */␊ - export interface NetworkProperties1 {␊ - /**␊ - * Indicates whether or not private link is enabled.␊ - */␊ - privateLink?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * The direction for the resource provider connection.␊ - */␊ - resourceProviderConnection?: (("Inbound" | "Outbound") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The security profile which contains Ssh public key for the HDInsight cluster.␊ - */␊ - export interface SecurityProfile1 {␊ - /**␊ - * The resource ID of the user's Azure Active Directory Domain Service.␊ - */␊ - aaddsResourceId?: string␊ - /**␊ - * Optional. The Distinguished Names for cluster user groups␊ - */␊ - clusterUsersGroupDNs?: (string[] | string)␊ - /**␊ - * The directory type.␊ - */␊ - directoryType?: ("ActiveDirectory" | string)␊ - /**␊ - * The organization's active directory domain.␊ - */␊ - domain?: string␊ - /**␊ - * The domain user account that will have admin privileges on the cluster.␊ - */␊ - domainUsername?: string␊ - /**␊ - * The domain admin password.␊ - */␊ - domainUserPassword?: string␊ - /**␊ - * The LDAPS protocol URLs to communicate with the Active Directory.␊ - */␊ - ldapsUrls?: (string[] | string)␊ - /**␊ - * User assigned identity that has permissions to read and create cluster-related artifacts in the user's AADDS.␊ - */␊ - msiResourceId?: string␊ - /**␊ - * The organizational unit within the Active Directory to place the cluster and service accounts.␊ - */␊ - organizationalUnitDN?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The storage profile.␊ - */␊ - export interface StorageProfile13 {␊ - /**␊ - * The list of storage accounts in the cluster.␊ - */␊ - storageaccounts?: (StorageAccount7[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The storage Account.␊ - */␊ - export interface StorageAccount7 {␊ - /**␊ - * The container in the storage account, only to be specified for WASB storage accounts.␊ - */␊ - container?: string␊ - /**␊ - * The file share name.␊ - */␊ - fileshare?: string␊ - /**␊ - * The filesystem, only to be specified for Azure Data Lake Storage Gen 2.␊ - */␊ - fileSystem?: string␊ - /**␊ - * Whether or not the storage account is the default storage account.␊ - */␊ - isDefault?: (boolean | string)␊ - /**␊ - * The storage account access key.␊ - */␊ - key?: string␊ - /**␊ - * The managed identity (MSI) that is allowed to access the storage account, only to be specified for Azure Data Lake Storage Gen 2.␊ - */␊ - msiResourceId?: string␊ - /**␊ - * The name of the storage account.␊ - */␊ - name?: string␊ - /**␊ - * The resource ID of storage account, only to be specified for Azure Data Lake Storage Gen 2.␊ - */␊ - resourceId?: string␊ - /**␊ - * The shared access signature key.␊ - */␊ - saskey?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.HDInsight/clusters/applications␊ - */␊ - export interface ClustersApplicationsChildResource3 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * The ETag for the application␊ - */␊ - etag?: string␊ - /**␊ - * The constant value for the application name.␊ - */␊ - name: string␊ - /**␊ - * The HDInsight cluster application GET response.␊ - */␊ - properties: (ApplicationProperties1 | string)␊ - /**␊ - * The tags for the application.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "applications"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The HDInsight cluster application GET response.␊ - */␊ - export interface ApplicationProperties1 {␊ - /**␊ - * The application type.␊ - */␊ - applicationType?: string␊ - /**␊ - * Describes the compute profile.␊ - */␊ - computeProfile?: (ComputeProfile1 | string)␊ - /**␊ - * The list of errors.␊ - */␊ - errors?: (Errors1[] | string)␊ - /**␊ - * The list of application HTTPS endpoints.␊ - */␊ - httpsEndpoints?: (ApplicationGetHttpsEndpoint1[] | string)␊ - /**␊ - * The list of install script actions.␊ - */␊ - installScriptActions?: (RuntimeScriptAction1[] | string)␊ - /**␊ - * The list of application SSH endpoints.␊ - */␊ - sshEndpoints?: (ApplicationGetEndpoint1[] | string)␊ - /**␊ - * The list of uninstall script actions.␊ - */␊ - uninstallScriptActions?: (RuntimeScriptAction1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The error message associated with the cluster creation.␊ - */␊ - export interface Errors1 {␊ - /**␊ - * The error code.␊ - */␊ - code?: string␊ - /**␊ - * The error message.␊ - */␊ - message?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Gets the application HTTP endpoints.␊ - */␊ - export interface ApplicationGetHttpsEndpoint1 {␊ - /**␊ - * The list of access modes for the application.␊ - */␊ - accessModes?: (string[] | string)␊ - /**␊ - * The destination port to connect to.␊ - */␊ - destinationPort?: (number | string)␊ - /**␊ - * The value indicates whether to disable GatewayAuth.␊ - */␊ - disableGatewayAuth?: (boolean | string)␊ - /**␊ - * The private ip address of the endpoint.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The subdomain suffix of the application.␊ - */␊ - subDomainSuffix?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a script action on a running cluster.␊ - */␊ - export interface RuntimeScriptAction1 {␊ - /**␊ - * The name of the script action.␊ - */␊ - name: string␊ - /**␊ - * The parameters for the script␊ - */␊ - parameters?: string␊ - /**␊ - * The list of roles where script will be executed.␊ - */␊ - roles: (string[] | string)␊ - /**␊ - * The URI to the script.␊ - */␊ - uri: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Gets the application SSH endpoint␊ - */␊ - export interface ApplicationGetEndpoint1 {␊ - /**␊ - * The destination port to connect to.␊ - */␊ - destinationPort?: (number | string)␊ - /**␊ - * The location of the endpoint.␊ - */␊ - location?: string␊ - /**␊ - * The private ip address of the endpoint.␊ - */␊ - privateIPAddress?: string␊ - /**␊ - * The public port to connect to.␊ - */␊ - publicPort?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The selected configurations for azure monitor.␊ - */␊ - export interface AzureMonitorSelectedConfigurations1 {␊ - /**␊ - * The configuration version.␊ - */␊ - configurationVersion?: string␊ - /**␊ - * The global configurations of selected configurations.␊ - */␊ - globalConfigurations?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * The table list.␊ - */␊ - tableList?: (AzureMonitorTableConfiguration1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The table configuration for the Log Analytics integration.␊ - */␊ - export interface AzureMonitorTableConfiguration1 {␊ - /**␊ - * The name.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.HDInsight/clusters/applications␊ - */␊ - export interface ClustersApplications3 {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * The ETag for the application␊ - */␊ - etag?: string␊ - /**␊ - * The constant value for the application name.␊ - */␊ - name: string␊ - /**␊ - * The HDInsight cluster application GET response.␊ - */␊ - properties: (ApplicationProperties1 | string)␊ - /**␊ - * The tags for the application.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.HDInsight/clusters/applications"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Security/locations/jitNetworkAccessPolicies␊ - */␊ - export interface LocationsJitNetworkAccessPolicies {␊ - apiVersion: "2015-06-01-preview"␊ - /**␊ - * Kind of the resource␊ - */␊ - kind?: string␊ - /**␊ - * Name of a Just-in-Time access configuration policy.␊ - */␊ - name: string␊ - properties: (JitNetworkAccessPolicyProperties | string)␊ - type: "Microsoft.Security/locations/jitNetworkAccessPolicies"␊ - [k: string]: unknown␊ - }␊ - export interface JitNetworkAccessPolicyProperties {␊ - requests?: (JitNetworkAccessRequest[] | string)␊ - /**␊ - * Configurations for Microsoft.Compute/virtualMachines resource type.␊ - */␊ - virtualMachines: (JitNetworkAccessPolicyVirtualMachine[] | string)␊ - [k: string]: unknown␊ - }␊ - export interface JitNetworkAccessRequest {␊ - /**␊ - * The justification for making the initiate request␊ - */␊ - justification?: string␊ - /**␊ - * The identity of the person who made the request␊ - */␊ - requestor: string␊ - /**␊ - * The start time of the request in UTC␊ - */␊ - startTimeUtc: string␊ - virtualMachines: (JitNetworkAccessRequestVirtualMachine[] | string)␊ - [k: string]: unknown␊ - }␊ - export interface JitNetworkAccessRequestVirtualMachine {␊ - /**␊ - * Resource ID of the virtual machine that is linked to this policy␊ - */␊ - id: string␊ - /**␊ - * The ports that were opened for the virtual machine␊ - */␊ - ports: (JitNetworkAccessRequestPort[] | string)␊ - [k: string]: unknown␊ - }␊ - export interface JitNetworkAccessRequestPort {␊ - /**␊ - * Mutually exclusive with the "allowedSourceAddressPrefixes" parameter. Should be an IP address or CIDR, for example "192.168.0.3" or "192.168.0.0/16".␊ - */␊ - allowedSourceAddressPrefix?: string␊ - /**␊ - * Mutually exclusive with the "allowedSourceAddressPrefix" parameter.␊ - */␊ - allowedSourceAddressPrefixes?: (string[] | string)␊ - /**␊ - * The date & time at which the request ends in UTC␊ - */␊ - endTimeUtc: string␊ - /**␊ - * The port which is mapped to this port's \`number\` in the Azure Firewall, if applicable␊ - */␊ - mappedPort?: (number | string)␊ - number: (number | string)␊ - /**␊ - * The status of the port.␊ - */␊ - status: (("Revoked" | "Initiated") | string)␊ - /**␊ - * A description of why the \`status\` has its value.␊ - */␊ - statusReason: (("Expired" | "UserRequested" | "NewerRequestInitiated") | string)␊ - [k: string]: unknown␊ - }␊ - export interface JitNetworkAccessPolicyVirtualMachine {␊ - /**␊ - * Resource ID of the virtual machine that is linked to this policy␊ - */␊ - id: string␊ - /**␊ - * Port configurations for the virtual machine␊ - */␊ - ports: (JitNetworkAccessPortRule[] | string)␊ - /**␊ - * Public IP address of the Azure Firewall that is linked to this policy, if applicable␊ - */␊ - publicIpAddress?: string␊ - [k: string]: unknown␊ - }␊ - export interface JitNetworkAccessPortRule {␊ - /**␊ - * Mutually exclusive with the "allowedSourceAddressPrefixes" parameter. Should be an IP address or CIDR, for example "192.168.0.3" or "192.168.0.0/16".␊ - */␊ - allowedSourceAddressPrefix?: string␊ - /**␊ - * Mutually exclusive with the "allowedSourceAddressPrefix" parameter.␊ - */␊ - allowedSourceAddressPrefixes?: (string[] | string)␊ - /**␊ - * Maximum duration requests can be made for. In ISO 8601 duration format. Minimum 5 minutes, maximum 1 day␊ - */␊ - maxRequestAccessDuration: string␊ - number: (number | string)␊ - protocol: (("TCP" | "UDP" | "*") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Security/iotSecuritySolutions␊ - */␊ - export interface IotSecuritySolutions {␊ - apiVersion: "2017-08-01-preview"␊ - /**␊ - * The resource location.␊ - */␊ - location?: string␊ - /**␊ - * The solution manager name␊ - */␊ - name: string␊ - /**␊ - * Security Solution setting data␊ - */␊ - properties: (IoTSecuritySolutionProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Security/iotSecuritySolutions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Security Solution setting data␊ - */␊ - export interface IoTSecuritySolutionProperties {␊ - /**␊ - * Disabled data sources. Disabling these data sources compromises the system.␊ - */␊ - disabledDataSources?: (("TwinData")[] | string)␊ - /**␊ - * Resource display name.␊ - */␊ - displayName: string␊ - /**␊ - * List of additional export to workspace data options␊ - */␊ - export?: (("RawEvents")[] | string)␊ - /**␊ - * IoT Hub resource IDs␊ - */␊ - iotHubs: (string[] | string)␊ - /**␊ - * List of recommendation configuration␊ - */␊ - recommendationsConfiguration?: (RecommendationConfigurationProperties[] | string)␊ - /**␊ - * Security solution status.␊ - */␊ - status?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Properties of the solution's user defined resources.␊ - */␊ - userDefinedResources?: (UserDefinedResourcesProperties | string)␊ - /**␊ - * Workspace resource ID␊ - */␊ - workspace: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Recommendation configuration␊ - */␊ - export interface RecommendationConfigurationProperties {␊ - /**␊ - * The recommendation type.␊ - */␊ - recommendationType: (("IoT_ACRAuthentication" | "IoT_AgentSendsUnutilizedMessages" | "IoT_Baseline" | "IoT_EdgeHubMemOptimize" | "IoT_EdgeLoggingOptions" | "IoT_InconsistentModuleSettings" | "IoT_InstallAgent" | "IoT_IPFilter_DenyAll" | "IoT_IPFilter_PermissiveRule" | "IoT_OpenPorts" | "IoT_PermissiveFirewallPolicy" | "IoT_PermissiveInputFirewallRules" | "IoT_PermissiveOutputFirewallRules" | "IoT_PrivilegedDockerOptions" | "IoT_SharedCredentials" | "IoT_VulnerableTLSCipherSuite") | string)␊ - /**␊ - * Recommendation status. The recommendation is not generated when the status is disabled.␊ - */␊ - status: (("Disabled" | "Enabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the solution's user defined resources.␊ - */␊ - export interface UserDefinedResourcesProperties {␊ - /**␊ - * Azure Resource Graph query which represents the security solution's user defined resources. Required to start with "where type != "Microsoft.Devices/IotHubs""␊ - */␊ - query: string␊ - /**␊ - * List of Azure subscription ids on which the user defined resources query should be executed.␊ - */␊ - querySubscriptions: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Security/pricings␊ - */␊ - export interface Pricings {␊ - apiVersion: "2017-08-01-preview"␊ - /**␊ - * name of the pricing configuration␊ - */␊ - name: string␊ - /**␊ - * Pricing data␊ - */␊ - properties: (PricingProperties | string)␊ - type: "Microsoft.Security/pricings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Pricing data␊ - */␊ - export interface PricingProperties {␊ - /**␊ - * Pricing tier type.␊ - */␊ - pricingTier: (("Free" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Security/advancedThreatProtectionSettings␊ - */␊ - export interface AdvancedThreatProtectionSettings {␊ - apiVersion: "2017-08-01-preview"␊ - /**␊ - * Advanced Threat Protection setting name.␊ - */␊ - name: string␊ - /**␊ - * The Advanced Threat Protection settings.␊ - */␊ - properties: (AdvancedThreatProtectionProperties | string)␊ - type: "Microsoft.Security/advancedThreatProtectionSettings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Advanced Threat Protection settings.␊ - */␊ - export interface AdvancedThreatProtectionProperties {␊ - /**␊ - * Indicates whether Advanced Threat Protection is enabled.␊ - */␊ - isEnabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Security/deviceSecurityGroups␊ - */␊ - export interface DeviceSecurityGroups {␊ - apiVersion: "2017-08-01-preview"␊ - /**␊ - * The name of the device security group. Note that the name of the device security group is case insensitive.␊ - */␊ - name: string␊ - /**␊ - * describes properties of a security group.␊ - */␊ - properties: (DeviceSecurityGroupProperties | string)␊ - type: "Microsoft.Security/deviceSecurityGroups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * describes properties of a security group.␊ - */␊ - export interface DeviceSecurityGroupProperties {␊ - /**␊ - * The allow-list custom alert rules.␊ - */␊ - allowlistRules?: (AllowlistCustomAlertRule[] | string)␊ - /**␊ - * The deny-list custom alert rules.␊ - */␊ - denylistRules?: (DenylistCustomAlertRule[] | string)␊ - /**␊ - * The list of custom alert threshold rules.␊ - */␊ - thresholdRules?: (ThresholdCustomAlertRule[] | string)␊ - /**␊ - * The list of custom alert time-window rules.␊ - */␊ - timeWindowRules?: ((ActiveConnectionsNotInAllowedRange | AmqpC2DMessagesNotInAllowedRange | MqttC2DMessagesNotInAllowedRange | HttpC2DMessagesNotInAllowedRange | AmqpC2DRejectedMessagesNotInAllowedRange | MqttC2DRejectedMessagesNotInAllowedRange | HttpC2DRejectedMessagesNotInAllowedRange | AmqpD2CMessagesNotInAllowedRange | MqttD2CMessagesNotInAllowedRange | HttpD2CMessagesNotInAllowedRange | DirectMethodInvokesNotInAllowedRange | FailedLocalLoginsNotInAllowedRange | FileUploadsNotInAllowedRange | QueuePurgesNotInAllowedRange | TwinUpdatesNotInAllowedRange | UnauthorizedOperationsNotInAllowedRange)[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound connection to an ip that isn't allowed. Allow list consists of ipv4 or ipv6 range in CIDR notation.␊ - */␊ - export interface ConnectionToIpNotAllowed {␊ - ruleType: "ConnectionToIpNotAllowed"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Login by a local user that isn't allowed. Allow list consists of login names to allow.␊ - */␊ - export interface LocalUserNotAllowed {␊ - ruleType: "LocalUserNotAllowed"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Execution of a process that isn't allowed. Allow list consists of process names to allow.␊ - */␊ - export interface ProcessNotAllowed {␊ - ruleType: "ProcessNotAllowed"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A custom alert rule that checks if a value (depends on the custom alert type) is denied.␊ - */␊ - export interface DenylistCustomAlertRule {␊ - /**␊ - * The values to deny. The format of the values depends on the rule type.␊ - */␊ - denylistValues: (string[] | string)␊ - /**␊ - * Status of the custom alert.␊ - */␊ - isEnabled: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Number of active connections is not in allowed range.␊ - */␊ - export interface ActiveConnectionsNotInAllowedRange {␊ - ruleType: "ActiveConnectionsNotInAllowedRange"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Number of cloud to device messages (AMQP protocol) is not in allowed range.␊ - */␊ - export interface AmqpC2DMessagesNotInAllowedRange {␊ - ruleType: "AmqpC2DMessagesNotInAllowedRange"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Number of cloud to device messages (MQTT protocol) is not in allowed range.␊ - */␊ - export interface MqttC2DMessagesNotInAllowedRange {␊ - ruleType: "MqttC2DMessagesNotInAllowedRange"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Number of cloud to device messages (HTTP protocol) is not in allowed range.␊ - */␊ - export interface HttpC2DMessagesNotInAllowedRange {␊ - ruleType: "HttpC2DMessagesNotInAllowedRange"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Number of rejected cloud to device messages (AMQP protocol) is not in allowed range.␊ - */␊ - export interface AmqpC2DRejectedMessagesNotInAllowedRange {␊ - ruleType: "AmqpC2DRejectedMessagesNotInAllowedRange"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Number of rejected cloud to device messages (MQTT protocol) is not in allowed range.␊ - */␊ - export interface MqttC2DRejectedMessagesNotInAllowedRange {␊ - ruleType: "MqttC2DRejectedMessagesNotInAllowedRange"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Number of rejected cloud to device messages (HTTP protocol) is not in allowed range.␊ - */␊ - export interface HttpC2DRejectedMessagesNotInAllowedRange {␊ - ruleType: "HttpC2DRejectedMessagesNotInAllowedRange"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Number of device to cloud messages (AMQP protocol) is not in allowed range.␊ - */␊ - export interface AmqpD2CMessagesNotInAllowedRange {␊ - ruleType: "AmqpD2CMessagesNotInAllowedRange"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Number of device to cloud messages (MQTT protocol) is not in allowed range.␊ - */␊ - export interface MqttD2CMessagesNotInAllowedRange {␊ - ruleType: "MqttD2CMessagesNotInAllowedRange"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Number of device to cloud messages (HTTP protocol) is not in allowed range.␊ - */␊ - export interface HttpD2CMessagesNotInAllowedRange {␊ - ruleType: "HttpD2CMessagesNotInAllowedRange"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Number of direct method invokes is not in allowed range.␊ - */␊ - export interface DirectMethodInvokesNotInAllowedRange {␊ - ruleType: "DirectMethodInvokesNotInAllowedRange"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Number of failed local logins is not in allowed range.␊ - */␊ - export interface FailedLocalLoginsNotInAllowedRange {␊ - ruleType: "FailedLocalLoginsNotInAllowedRange"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Number of file uploads is not in allowed range.␊ - */␊ - export interface FileUploadsNotInAllowedRange {␊ - ruleType: "FileUploadsNotInAllowedRange"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Number of device queue purges is not in allowed range.␊ - */␊ - export interface QueuePurgesNotInAllowedRange {␊ - ruleType: "QueuePurgesNotInAllowedRange"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Number of twin updates is not in allowed range.␊ - */␊ - export interface TwinUpdatesNotInAllowedRange {␊ - ruleType: "TwinUpdatesNotInAllowedRange"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Number of unauthorized operations is not in allowed range.␊ - */␊ - export interface UnauthorizedOperationsNotInAllowedRange {␊ - ruleType: "UnauthorizedOperationsNotInAllowedRange"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Security/advancedThreatProtectionSettings␊ - */␊ - export interface AdvancedThreatProtectionSettings1 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Advanced Threat Protection setting name.␊ - */␊ - name: "current"␊ - /**␊ - * The Advanced Threat Protection settings.␊ - */␊ - properties: (AdvancedThreatProtectionProperties1 | string)␊ - type: "Microsoft.Security/advancedThreatProtectionSettings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Advanced Threat Protection settings.␊ - */␊ - export interface AdvancedThreatProtectionProperties1 {␊ - /**␊ - * Indicates whether Advanced Threat Protection is enabled.␊ - */␊ - isEnabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Security/automations␊ - */␊ - export interface Automations {␊ - apiVersion: "2019-01-01-preview"␊ - /**␊ - * Entity tag is used for comparing two or more entities from the same requested resource.␊ - */␊ - etag?: string␊ - /**␊ - * Kind of the resource␊ - */␊ - kind?: string␊ - /**␊ - * Location where the resource is stored␊ - */␊ - location?: string␊ - /**␊ - * The security automation name.␊ - */␊ - name: string␊ - /**␊ - * A set of properties that defines the behavior of the automation configuration. To learn more about the supported security events data models schemas - please visit https://aka.ms/ASCAutomationSchemas.␊ - */␊ - properties: (AutomationProperties | string)␊ - /**␊ - * A list of key value pairs that describe the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Security/automations"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A set of properties that defines the behavior of the automation configuration. To learn more about the supported security events data models schemas - please visit https://aka.ms/ASCAutomationSchemas.␊ - */␊ - export interface AutomationProperties {␊ - /**␊ - * A collection of the actions which are triggered if all the configured rules evaluations, within at least one rule set, are true.␊ - */␊ - actions?: (AutomationAction[] | string)␊ - /**␊ - * The security automation description.␊ - */␊ - description?: string␊ - /**␊ - * Indicates whether the security automation is enabled.␊ - */␊ - isEnabled?: (boolean | string)␊ - /**␊ - * A collection of scopes on which the security automations logic is applied. Supported scopes are the subscription itself or a resource group under that subscription. The automation will only apply on defined scopes.␊ - */␊ - scopes?: (AutomationScope[] | string)␊ - /**␊ - * A collection of the source event types which evaluate the security automation set of rules.␊ - */␊ - sources?: (AutomationSource[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The logic app action that should be triggered. To learn more about Microsoft Defender for Cloud's Workflow Automation capabilities, visit https://aka.ms/ASCWorkflowAutomationLearnMore␊ - */␊ - export interface AutomationActionLogicApp {␊ - actionType: "LogicApp"␊ - /**␊ - * The triggered Logic App Azure Resource ID. This can also reside on other subscriptions, given that you have permissions to trigger the Logic App␊ - */␊ - logicAppResourceId?: string␊ - /**␊ - * The Logic App trigger URI endpoint (it will not be included in any response).␊ - */␊ - uri?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The target Event Hub to which event data will be exported. To learn more about Microsoft Defender for Cloud continuous export capabilities, visit https://aka.ms/ASCExportLearnMore␊ - */␊ - export interface AutomationActionEventHub {␊ - actionType: "EventHub"␊ - /**␊ - * The target Event Hub connection string (it will not be included in any response).␊ - */␊ - connectionString?: string␊ - /**␊ - * The target Event Hub Azure Resource ID.␊ - */␊ - eventHubResourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Log Analytics Workspace to which event data will be exported. Security alerts data will reside in the 'SecurityAlert' table and the assessments data will reside in the 'SecurityRecommendation' table (under the 'Security'/'SecurityCenterFree' solutions). Note that in order to view the data in the workspace, the Security Center Log Analytics free/standard solution needs to be enabled on that workspace. To learn more about Microsoft Defender for Cloud continuous export capabilities, visit https://aka.ms/ASCExportLearnMore␊ - */␊ - export interface AutomationActionWorkspace {␊ - actionType: "Workspace"␊ - /**␊ - * The fully qualified Log Analytics Workspace Azure Resource ID.␊ - */␊ - workspaceResourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A single automation scope.␊ - */␊ - export interface AutomationScope {␊ - /**␊ - * The resources scope description.␊ - */␊ - description?: string␊ - /**␊ - * The resources scope path. Can be the subscription on which the automation is defined on or a resource group under that subscription (fully qualified Azure resource IDs).␊ - */␊ - scopePath?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The source event types which evaluate the security automation set of rules. For example - security alerts and security assessments. To learn more about the supported security events data models schemas - please visit https://aka.ms/ASCAutomationSchemas.␊ - */␊ - export interface AutomationSource {␊ - /**␊ - * A valid event source type.␊ - */␊ - eventSource?: (("Assessments" | "AssessmentsSnapshot" | "SubAssessments" | "SubAssessmentsSnapshot" | "Alerts" | "SecureScores" | "SecureScoresSnapshot" | "SecureScoreControls" | "SecureScoreControlsSnapshot" | "RegulatoryComplianceAssessment" | "RegulatoryComplianceAssessmentSnapshot") | string)␊ - /**␊ - * A set of rules which evaluate upon event interception. A logical disjunction is applied between defined rule sets (logical 'or').␊ - */␊ - ruleSets?: (AutomationRuleSet[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A rule set which evaluates all its rules upon an event interception. Only when all the included rules in the rule set will be evaluated as 'true', will the event trigger the defined actions.␊ - */␊ - export interface AutomationRuleSet {␊ - rules?: (AutomationTriggeringRule[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A rule which is evaluated upon event interception. The rule is configured by comparing a specific value from the event model to an expected value. This comparison is done by using one of the supported operators set.␊ - */␊ - export interface AutomationTriggeringRule {␊ - /**␊ - * The expected value.␊ - */␊ - expectedValue?: string␊ - /**␊ - * A valid comparer operator to use. A case-insensitive comparison will be applied for String PropertyType.␊ - */␊ - operator?: (("Equals" | "GreaterThan" | "GreaterThanOrEqualTo" | "LesserThan" | "LesserThanOrEqualTo" | "NotEquals" | "Contains" | "StartsWith" | "EndsWith") | string)␊ - /**␊ - * The JPath of the entity model property that should be checked.␊ - */␊ - propertyJPath?: string␊ - /**␊ - * The data type of the compared operands (string, integer, floating point number or a boolean [true/false]].␊ - */␊ - propertyType?: (("String" | "Integer" | "Number" | "Boolean") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Security/assessments␊ - */␊ - export interface Assessments {␊ - apiVersion: "2019-01-01-preview"␊ - /**␊ - * The Assessment Key - Unique key for the assessment type␊ - */␊ - name: string␊ - /**␊ - * Describes properties of an assessment.␊ - */␊ - properties: (SecurityAssessmentProperties | string)␊ - type: "Microsoft.Security/assessments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes properties of an assessment.␊ - */␊ - export interface SecurityAssessmentProperties {␊ - /**␊ - * Additional data regarding the assessment␊ - */␊ - additionalData?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Links relevant to the assessment␊ - */␊ - links?: (AssessmentLinks | string)␊ - /**␊ - * Details of the resource that was assessed␊ - */␊ - resourceDetails: (ResourceDetails | string)␊ - /**␊ - * The result of the assessment␊ - */␊ - status: (AssessmentStatus | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Links relevant to the assessment␊ - */␊ - export interface AssessmentLinks {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Details of the Azure resource that was assessed␊ - */␊ - export interface AzureResourceDetails {␊ - source: "Azure"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Details of the On Premise Sql resource that was assessed␊ - */␊ - export interface OnPremiseSqlResourceDetails {␊ - /**␊ - * The Sql database name installed on the machine␊ - */␊ - databaseName: string␊ - /**␊ - * The Sql server name installed on the machine␊ - */␊ - serverName: string␊ - source: "OnPremiseSql"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The result of the assessment␊ - */␊ - export interface AssessmentStatus {␊ - /**␊ - * Programmatic code for the cause of the assessment status␊ - */␊ - cause?: string␊ - /**␊ - * Programmatic code for the status of the assessment.␊ - */␊ - code: (("Healthy" | "Unhealthy" | "NotApplicable") | string)␊ - /**␊ - * Human readable description of the assessment status␊ - */␊ - description?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Security/iotSecuritySolutions␊ - */␊ - export interface IotSecuritySolutions1 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * The resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the IoT Security solution.␊ - */␊ - name: string␊ - /**␊ - * Security Solution setting data␊ - */␊ - properties: (IoTSecuritySolutionProperties1 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Security/iotSecuritySolutions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Security Solution setting data␊ - */␊ - export interface IoTSecuritySolutionProperties1 {␊ - /**␊ - * List of additional workspaces␊ - */␊ - additionalWorkspaces?: (AdditionalWorkspacesProperties[] | string)␊ - /**␊ - * Disabled data sources. Disabling these data sources compromises the system.␊ - */␊ - disabledDataSources?: (("TwinData")[] | string)␊ - /**␊ - * Resource display name.␊ - */␊ - displayName: string␊ - /**␊ - * List of additional options for exporting to workspace data.␊ - */␊ - export?: (("RawEvents")[] | string)␊ - /**␊ - * IoT Hub resource IDs␊ - */␊ - iotHubs: (string[] | string)␊ - /**␊ - * List of the configuration status for each recommendation type.␊ - */␊ - recommendationsConfiguration?: (RecommendationConfigurationProperties1[] | string)␊ - /**␊ - * Status of the IoT Security solution.␊ - */␊ - status?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Unmasked IP address logging status.␊ - */␊ - unmaskedIpLoggingStatus?: (("Disabled" | "Enabled") | string)␊ - /**␊ - * Properties of the IoT Security solution's user defined resources.␊ - */␊ - userDefinedResources?: (UserDefinedResourcesProperties1 | string)␊ - /**␊ - * Workspace resource ID␊ - */␊ - workspace?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the additional workspaces.␊ - */␊ - export interface AdditionalWorkspacesProperties {␊ - /**␊ - * List of data types sent to workspace␊ - */␊ - dataTypes?: (("Alerts" | "RawEvents")[] | string)␊ - /**␊ - * Workspace type.␊ - */␊ - type?: ("Sentinel" | string)␊ - /**␊ - * Workspace resource id␊ - */␊ - workspace?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The type of IoT Security recommendation.␊ - */␊ - export interface RecommendationConfigurationProperties1 {␊ - /**␊ - * The type of IoT Security recommendation.␊ - */␊ - recommendationType: (("IoT_ACRAuthentication" | "IoT_AgentSendsUnutilizedMessages" | "IoT_Baseline" | "IoT_EdgeHubMemOptimize" | "IoT_EdgeLoggingOptions" | "IoT_InconsistentModuleSettings" | "IoT_InstallAgent" | "IoT_IPFilter_DenyAll" | "IoT_IPFilter_PermissiveRule" | "IoT_OpenPorts" | "IoT_PermissiveFirewallPolicy" | "IoT_PermissiveInputFirewallRules" | "IoT_PermissiveOutputFirewallRules" | "IoT_PrivilegedDockerOptions" | "IoT_SharedCredentials" | "IoT_VulnerableTLSCipherSuite") | string)␊ - /**␊ - * Recommendation status. When the recommendation status is disabled recommendations are not generated.␊ - */␊ - status: (("Disabled" | "Enabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the IoT Security solution's user defined resources.␊ - */␊ - export interface UserDefinedResourcesProperties1 {␊ - /**␊ - * Azure Resource Graph query which represents the security solution's user defined resources. Required to start with "where type != "Microsoft.Devices/IotHubs""␊ - */␊ - query: string␊ - /**␊ - * List of Azure subscription ids on which the user defined resources query should be executed.␊ - */␊ - querySubscriptions: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Security/deviceSecurityGroups␊ - */␊ - export interface DeviceSecurityGroups1 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * The name of the device security group. Note that the name of the device security group is case insensitive.␊ - */␊ - name: string␊ - /**␊ - * describes properties of a security group.␊ - */␊ - properties: (DeviceSecurityGroupProperties1 | string)␊ - type: "Microsoft.Security/deviceSecurityGroups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * describes properties of a security group.␊ - */␊ - export interface DeviceSecurityGroupProperties1 {␊ - /**␊ - * The allow-list custom alert rules.␊ - */␊ - allowlistRules?: (AllowlistCustomAlertRule1[] | string)␊ - /**␊ - * The deny-list custom alert rules.␊ - */␊ - denylistRules?: (DenylistCustomAlertRule1[] | string)␊ - /**␊ - * The list of custom alert threshold rules.␊ - */␊ - thresholdRules?: (ThresholdCustomAlertRule1[] | string)␊ - /**␊ - * The list of custom alert time-window rules.␊ - */␊ - timeWindowRules?: ((ActiveConnectionsNotInAllowedRange1 | AmqpC2DMessagesNotInAllowedRange1 | MqttC2DMessagesNotInAllowedRange1 | HttpC2DMessagesNotInAllowedRange1 | AmqpC2DRejectedMessagesNotInAllowedRange1 | MqttC2DRejectedMessagesNotInAllowedRange1 | HttpC2DRejectedMessagesNotInAllowedRange1 | AmqpD2CMessagesNotInAllowedRange1 | MqttD2CMessagesNotInAllowedRange1 | HttpD2CMessagesNotInAllowedRange1 | DirectMethodInvokesNotInAllowedRange1 | FailedLocalLoginsNotInAllowedRange1 | FileUploadsNotInAllowedRange1 | QueuePurgesNotInAllowedRange1 | TwinUpdatesNotInAllowedRange1 | UnauthorizedOperationsNotInAllowedRange1)[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Outbound connection to an ip that isn't allowed. Allow list consists of ipv4 or ipv6 range in CIDR notation.␊ - */␊ - export interface ConnectionToIpNotAllowed1 {␊ - ruleType: "ConnectionToIpNotAllowed"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Inbound connection from an ip that isn't allowed. Allow list consists of ipv4 or ipv6 range in CIDR notation.␊ - */␊ - export interface ConnectionFromIpNotAllowed {␊ - ruleType: "ConnectionFromIpNotAllowed"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Login by a local user that isn't allowed. Allow list consists of login names to allow.␊ - */␊ - export interface LocalUserNotAllowed1 {␊ - ruleType: "LocalUserNotAllowed"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Execution of a process that isn't allowed. Allow list consists of process names to allow.␊ - */␊ - export interface ProcessNotAllowed1 {␊ - ruleType: "ProcessNotAllowed"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A custom alert rule that checks if a value (depends on the custom alert type) is denied.␊ - */␊ - export interface DenylistCustomAlertRule1 {␊ - /**␊ - * The values to deny. The format of the values depends on the rule type.␊ - */␊ - denylistValues: (string[] | string)␊ - /**␊ - * Status of the custom alert.␊ - */␊ - isEnabled: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Number of active connections is not in allowed range.␊ - */␊ - export interface ActiveConnectionsNotInAllowedRange1 {␊ - ruleType: "ActiveConnectionsNotInAllowedRange"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Number of cloud to device messages (AMQP protocol) is not in allowed range.␊ - */␊ - export interface AmqpC2DMessagesNotInAllowedRange1 {␊ - ruleType: "AmqpC2DMessagesNotInAllowedRange"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Number of cloud to device messages (MQTT protocol) is not in allowed range.␊ - */␊ - export interface MqttC2DMessagesNotInAllowedRange1 {␊ - ruleType: "MqttC2DMessagesNotInAllowedRange"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Number of cloud to device messages (HTTP protocol) is not in allowed range.␊ - */␊ - export interface HttpC2DMessagesNotInAllowedRange1 {␊ - ruleType: "HttpC2DMessagesNotInAllowedRange"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Number of rejected cloud to device messages (AMQP protocol) is not in allowed range.␊ - */␊ - export interface AmqpC2DRejectedMessagesNotInAllowedRange1 {␊ - ruleType: "AmqpC2DRejectedMessagesNotInAllowedRange"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Number of rejected cloud to device messages (MQTT protocol) is not in allowed range.␊ - */␊ - export interface MqttC2DRejectedMessagesNotInAllowedRange1 {␊ - ruleType: "MqttC2DRejectedMessagesNotInAllowedRange"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Number of rejected cloud to device messages (HTTP protocol) is not in allowed range.␊ - */␊ - export interface HttpC2DRejectedMessagesNotInAllowedRange1 {␊ - ruleType: "HttpC2DRejectedMessagesNotInAllowedRange"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Number of device to cloud messages (AMQP protocol) is not in allowed range.␊ - */␊ - export interface AmqpD2CMessagesNotInAllowedRange1 {␊ - ruleType: "AmqpD2CMessagesNotInAllowedRange"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Number of device to cloud messages (MQTT protocol) is not in allowed range.␊ - */␊ - export interface MqttD2CMessagesNotInAllowedRange1 {␊ - ruleType: "MqttD2CMessagesNotInAllowedRange"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Number of device to cloud messages (HTTP protocol) is not in allowed range.␊ - */␊ - export interface HttpD2CMessagesNotInAllowedRange1 {␊ - ruleType: "HttpD2CMessagesNotInAllowedRange"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Number of direct method invokes is not in allowed range.␊ - */␊ - export interface DirectMethodInvokesNotInAllowedRange1 {␊ - ruleType: "DirectMethodInvokesNotInAllowedRange"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Number of failed local logins is not in allowed range.␊ - */␊ - export interface FailedLocalLoginsNotInAllowedRange1 {␊ - ruleType: "FailedLocalLoginsNotInAllowedRange"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Number of file uploads is not in allowed range.␊ - */␊ - export interface FileUploadsNotInAllowedRange1 {␊ - ruleType: "FileUploadsNotInAllowedRange"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Number of device queue purges is not in allowed range.␊ - */␊ - export interface QueuePurgesNotInAllowedRange1 {␊ - ruleType: "QueuePurgesNotInAllowedRange"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Number of twin updates is not in allowed range.␊ - */␊ - export interface TwinUpdatesNotInAllowedRange1 {␊ - ruleType: "TwinUpdatesNotInAllowedRange"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Number of unauthorized operations is not in allowed range.␊ - */␊ - export interface UnauthorizedOperationsNotInAllowedRange1 {␊ - ruleType: "UnauthorizedOperationsNotInAllowedRange"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Security/locations/jitNetworkAccessPolicies␊ - */␊ - export interface LocationsJitNetworkAccessPolicies1 {␊ - apiVersion: "2020-01-01"␊ - /**␊ - * Kind of the resource␊ - */␊ - kind?: string␊ - /**␊ - * Name of a Just-in-Time access configuration policy.␊ - */␊ - name: string␊ - properties: (JitNetworkAccessPolicyProperties1 | string)␊ - type: "Microsoft.Security/locations/jitNetworkAccessPolicies"␊ - [k: string]: unknown␊ - }␊ - export interface JitNetworkAccessPolicyProperties1 {␊ - requests?: (JitNetworkAccessRequest1[] | string)␊ - /**␊ - * Configurations for Microsoft.Compute/virtualMachines resource type.␊ - */␊ - virtualMachines: (JitNetworkAccessPolicyVirtualMachine1[] | string)␊ - [k: string]: unknown␊ - }␊ - export interface JitNetworkAccessRequest1 {␊ - /**␊ - * The justification for making the initiate request␊ - */␊ - justification?: string␊ - /**␊ - * The identity of the person who made the request␊ - */␊ - requestor: string␊ - /**␊ - * The start time of the request in UTC␊ - */␊ - startTimeUtc: string␊ - virtualMachines: (JitNetworkAccessRequestVirtualMachine1[] | string)␊ - [k: string]: unknown␊ - }␊ - export interface JitNetworkAccessRequestVirtualMachine1 {␊ - /**␊ - * Resource ID of the virtual machine that is linked to this policy␊ - */␊ - id: string␊ - /**␊ - * The ports that were opened for the virtual machine␊ - */␊ - ports: (JitNetworkAccessRequestPort1[] | string)␊ - [k: string]: unknown␊ - }␊ - export interface JitNetworkAccessRequestPort1 {␊ - /**␊ - * Mutually exclusive with the "allowedSourceAddressPrefixes" parameter. Should be an IP address or CIDR, for example "192.168.0.3" or "192.168.0.0/16".␊ - */␊ - allowedSourceAddressPrefix?: string␊ - /**␊ - * Mutually exclusive with the "allowedSourceAddressPrefix" parameter.␊ - */␊ - allowedSourceAddressPrefixes?: (string[] | string)␊ - /**␊ - * The date & time at which the request ends in UTC␊ - */␊ - endTimeUtc: string␊ - /**␊ - * The port which is mapped to this port's \`number\` in the Azure Firewall, if applicable␊ - */␊ - mappedPort?: (number | string)␊ - number: (number | string)␊ - /**␊ - * The status of the port.␊ - */␊ - status: (("Revoked" | "Initiated") | string)␊ - /**␊ - * A description of why the \`status\` has its value.␊ - */␊ - statusReason: (("Expired" | "UserRequested" | "NewerRequestInitiated") | string)␊ - [k: string]: unknown␊ - }␊ - export interface JitNetworkAccessPolicyVirtualMachine1 {␊ - /**␊ - * Resource ID of the virtual machine that is linked to this policy␊ - */␊ - id: string␊ - /**␊ - * Port configurations for the virtual machine␊ - */␊ - ports: (JitNetworkAccessPortRule1[] | string)␊ - /**␊ - * Public IP address of the Azure Firewall that is linked to this policy, if applicable␊ - */␊ - publicIpAddress?: string␊ - [k: string]: unknown␊ - }␊ - export interface JitNetworkAccessPortRule1 {␊ - /**␊ - * Mutually exclusive with the "allowedSourceAddressPrefixes" parameter. Should be an IP address or CIDR, for example "192.168.0.3" or "192.168.0.0/16".␊ - */␊ - allowedSourceAddressPrefix?: string␊ - /**␊ - * Mutually exclusive with the "allowedSourceAddressPrefix" parameter.␊ - */␊ - allowedSourceAddressPrefixes?: (string[] | string)␊ - /**␊ - * Maximum duration requests can be made for. In ISO 8601 duration format. Minimum 5 minutes, maximum 1 day␊ - */␊ - maxRequestAccessDuration: string␊ - number: (number | string)␊ - protocol: (("TCP" | "UDP" | "*") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Security/assessments␊ - */␊ - export interface Assessments1 {␊ - apiVersion: "2020-01-01"␊ - /**␊ - * The Assessment Key - Unique key for the assessment type␊ - */␊ - name: string␊ - /**␊ - * Describes properties of an assessment.␊ - */␊ - properties: (SecurityAssessmentProperties1 | string)␊ - type: "Microsoft.Security/assessments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes properties of an assessment.␊ - */␊ - export interface SecurityAssessmentProperties1 {␊ - /**␊ - * Additional data regarding the assessment␊ - */␊ - additionalData?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Links relevant to the assessment␊ - */␊ - links?: (AssessmentLinks1 | string)␊ - /**␊ - * Describes properties of an assessment metadata.␊ - */␊ - metadata?: (SecurityAssessmentMetadataProperties | string)␊ - /**␊ - * Data regarding 3rd party partner integration␊ - */␊ - partnersData?: (SecurityAssessmentPartnerData | string)␊ - /**␊ - * Details of the resource that was assessed␊ - */␊ - resourceDetails: (ResourceDetails1 | string)␊ - /**␊ - * The result of the assessment␊ - */␊ - status: (AssessmentStatus1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Links relevant to the assessment␊ - */␊ - export interface AssessmentLinks1 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes properties of an assessment metadata.␊ - */␊ - export interface SecurityAssessmentMetadataProperties {␊ - /**␊ - * BuiltIn if the assessment based on built-in Azure Policy definition, Custom if the assessment based on custom Azure Policy definition.␊ - */␊ - assessmentType: (("BuiltIn" | "CustomPolicy" | "CustomerManaged" | "VerifiedPartner") | string)␊ - categories?: (("Compute" | "Networking" | "Data" | "IdentityAndAccess" | "IoT")[] | string)␊ - /**␊ - * Human readable description of the assessment␊ - */␊ - description?: string␊ - /**␊ - * User friendly display name of the assessment␊ - */␊ - displayName: string␊ - /**␊ - * The implementation effort required to remediate this assessment.␊ - */␊ - implementationEffort?: (("Low" | "Moderate" | "High") | string)␊ - /**␊ - * Describes the partner that created the assessment␊ - */␊ - partnerData?: (SecurityAssessmentMetadataPartnerData | string)␊ - /**␊ - * True if this assessment is in preview release status␊ - */␊ - preview?: (boolean | string)␊ - /**␊ - * Human readable description of what you should do to mitigate this security issue␊ - */␊ - remediationDescription?: string␊ - /**␊ - * The severity level of the assessment.␊ - */␊ - severity: (("Low" | "Medium" | "High") | string)␊ - threats?: (("accountBreach" | "dataExfiltration" | "dataSpillage" | "maliciousInsider" | "elevationOfPrivilege" | "threatResistance" | "missingCoverage" | "denialOfService")[] | string)␊ - /**␊ - * The user impact of the assessment.␊ - */␊ - userImpact?: (("Low" | "Moderate" | "High") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the partner that created the assessment␊ - */␊ - export interface SecurityAssessmentMetadataPartnerData {␊ - /**␊ - * Name of the company of the partner␊ - */␊ - partnerName: string␊ - /**␊ - * Name of the product of the partner that created the assessment␊ - */␊ - productName?: string␊ - /**␊ - * Secret to authenticate the partner and verify it created the assessment - write only␊ - */␊ - secret: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Data regarding 3rd party partner integration␊ - */␊ - export interface SecurityAssessmentPartnerData {␊ - /**␊ - * Name of the company of the partner␊ - */␊ - partnerName: string␊ - /**␊ - * secret to authenticate the partner - write only␊ - */␊ - secret: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Details of the Azure resource that was assessed␊ - */␊ - export interface AzureResourceDetails1 {␊ - source: "Azure"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Details of the On Premise Sql resource that was assessed␊ - */␊ - export interface OnPremiseSqlResourceDetails1 {␊ - /**␊ - * The Sql database name installed on the machine␊ - */␊ - databaseName: string␊ - /**␊ - * The Sql server name installed on the machine␊ - */␊ - serverName: string␊ - source: "OnPremiseSql"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The result of the assessment␊ - */␊ - export interface AssessmentStatus1 {␊ - /**␊ - * Programmatic code for the cause of the assessment status␊ - */␊ - cause?: string␊ - /**␊ - * Programmatic code for the status of the assessment.␊ - */␊ - code: (("Healthy" | "Unhealthy" | "NotApplicable") | string)␊ - /**␊ - * Human readable description of the assessment status␊ - */␊ - description?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Migrate/assessmentProjects␊ - */␊ - export interface AssessmentProjects {␊ - apiVersion: "2019-10-01"␊ - /**␊ - * For optimistic concurrency control.␊ - */␊ - eTag?: string␊ - /**␊ - * Azure location in which project is created.␊ - */␊ - location?: string␊ - /**␊ - * Name of the Azure Migrate project.␊ - */␊ - name: string␊ - /**␊ - * Properties of a project.␊ - */␊ - properties: (ProjectProperties3 | string)␊ - resources?: (AssessmentProjectsGroupsChildResource | AssessmentProjectsHypervcollectorsChildResource | AssessmentProjectsServercollectorsChildResource | AssessmentProjectsVmwarecollectorsChildResource | AssessmentProjectsImportcollectorsChildResource | AssessmentprojectsPrivateEndpointConnectionsChildResource)[]␊ - /**␊ - * Tags provided by Azure Tagging service.␊ - */␊ - tags?: {␊ - [k: string]: unknown␊ - }␊ - type: "Microsoft.Migrate/assessmentProjects"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a project.␊ - */␊ - export interface ProjectProperties3 {␊ - /**␊ - * Assessment solution ARM id tracked by Microsoft.Migrate/migrateProjects.␊ - */␊ - assessmentSolutionId?: string␊ - /**␊ - * The ARM id of the storage account used for interactions when public access is disabled.␊ - */␊ - customerStorageAccountArmId?: string␊ - /**␊ - * The ARM id of service map workspace created by customer.␊ - */␊ - customerWorkspaceId?: string␊ - /**␊ - * Location of service map workspace created by customer.␊ - */␊ - customerWorkspaceLocation?: string␊ - /**␊ - * Assessment project status.␊ - */␊ - projectStatus?: (("Active" | "Inactive") | string)␊ - /**␊ - * This value can be set to 'enabled' to avoid breaking changes on existing customer resources and templates. If set to 'disabled', traffic over public interface is not allowed, and private endpoint connections would be the exclusive access method.␊ - */␊ - publicNetworkAccess?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Migrate/assessmentProjects/groups␊ - */␊ - export interface AssessmentProjectsGroupsChildResource {␊ - apiVersion: "2019-10-01"␊ - /**␊ - * For optimistic concurrency control.␊ - */␊ - eTag?: string␊ - /**␊ - * Unique name of a group within a project.␊ - */␊ - name: string␊ - /**␊ - * Properties of group resource.␊ - */␊ - properties: (GroupProperties | string)␊ - type: "groups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of group resource.␊ - */␊ - export interface GroupProperties {␊ - /**␊ - * The type of group.␊ - */␊ - groupType?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Migrate/assessmentProjects/hypervcollectors␊ - */␊ - export interface AssessmentProjectsHypervcollectorsChildResource {␊ - apiVersion: "2019-10-01"␊ - eTag?: string␊ - /**␊ - * Unique name of a Hyper-V collector within a project.␊ - */␊ - name: string␊ - properties: (CollectorProperties | string)␊ - type: "hypervcollectors"␊ - [k: string]: unknown␊ - }␊ - export interface CollectorProperties {␊ - agentProperties?: (CollectorAgentProperties | string)␊ - /**␊ - * The ARM id of the discovery service site.␊ - */␊ - discoverySiteId?: string␊ - [k: string]: unknown␊ - }␊ - export interface CollectorAgentProperties {␊ - spnDetails?: (CollectorBodyAgentSpnProperties | string)␊ - [k: string]: unknown␊ - }␊ - export interface CollectorBodyAgentSpnProperties {␊ - /**␊ - * Application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.␊ - */␊ - applicationId?: string␊ - /**␊ - * Intended audience for the service principal.␊ - */␊ - audience?: string␊ - /**␊ - * AAD Authority URL which was used to request the token for the service principal.␊ - */␊ - authority?: string␊ - /**␊ - * Object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services.␊ - */␊ - objectId?: string␊ - /**␊ - * Tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.␊ - */␊ - tenantId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Migrate/assessmentProjects/servercollectors␊ - */␊ - export interface AssessmentProjectsServercollectorsChildResource {␊ - apiVersion: "2019-10-01"␊ - eTag?: string␊ - /**␊ - * Unique name of a Server collector within a project.␊ - */␊ - name: string␊ - properties: (CollectorProperties | string)␊ - type: "servercollectors"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Migrate/assessmentProjects/vmwarecollectors␊ - */␊ - export interface AssessmentProjectsVmwarecollectorsChildResource {␊ - apiVersion: "2019-10-01"␊ - eTag?: string␊ - /**␊ - * Unique name of a VMware collector within a project.␊ - */␊ - name: string␊ - properties: (CollectorProperties | string)␊ - type: "vmwarecollectors"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Migrate/assessmentProjects/importcollectors␊ - */␊ - export interface AssessmentProjectsImportcollectorsChildResource {␊ - apiVersion: "2019-10-01"␊ - eTag?: string␊ - /**␊ - * Unique name of a Import collector within a project.␊ - */␊ - name: string␊ - properties: (ImportCollectorProperties | string)␊ - type: "importcollectors"␊ - [k: string]: unknown␊ - }␊ - export interface ImportCollectorProperties {␊ - discoverySiteId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Migrate/assessmentprojects/privateEndpointConnections␊ - */␊ - export interface AssessmentprojectsPrivateEndpointConnectionsChildResource {␊ - apiVersion: "2019-10-01"␊ - /**␊ - * For optimistic concurrency control.␊ - */␊ - eTag?: string␊ - /**␊ - * Unique name of a private endpoint connection within a project.␊ - */␊ - name: string␊ - /**␊ - * Private endpoint connection properties.␊ - */␊ - properties: (PrivateEndpointConnectionProperties17 | string)␊ - type: "privateEndpointConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Private endpoint connection properties.␊ - */␊ - export interface PrivateEndpointConnectionProperties17 {␊ - /**␊ - * State of a private endpoint connection.␊ - */␊ - privateLinkServiceConnectionState?: (PrivateLinkServiceConnectionState16 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * State of a private endpoint connection.␊ - */␊ - export interface PrivateLinkServiceConnectionState16 {␊ - /**␊ - * Actions required on the private endpoint connection.␊ - */␊ - actionsRequired?: string␊ - /**␊ - * Description of the private endpoint connection.␊ - */␊ - description?: string␊ - /**␊ - * Connection status of the private endpoint connection.␊ - */␊ - status?: (("Approved" | "Pending" | "Rejected" | "Disconnected") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Migrate/assessmentProjects/groups␊ - */␊ - export interface AssessmentProjectsGroups {␊ - apiVersion: "2019-10-01"␊ - /**␊ - * For optimistic concurrency control.␊ - */␊ - eTag?: string␊ - /**␊ - * Unique name of a group within a project.␊ - */␊ - name: string␊ - /**␊ - * Properties of group resource.␊ - */␊ - properties: (GroupProperties | string)␊ - resources?: AssessmentProjectsGroupsAssessmentsChildResource[]␊ - type: "Microsoft.Migrate/assessmentProjects/groups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Migrate/assessmentProjects/groups/assessments␊ - */␊ - export interface AssessmentProjectsGroupsAssessmentsChildResource {␊ - apiVersion: "2019-10-01"␊ - /**␊ - * For optimistic concurrency control.␊ - */␊ - eTag?: string␊ - /**␊ - * Unique name of an assessment within a project.␊ - */␊ - name: string␊ - /**␊ - * Properties of an assessment.␊ - */␊ - properties: (AssessmentProperties | string)␊ - type: "assessments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of an assessment.␊ - */␊ - export interface AssessmentProperties {␊ - /**␊ - * Storage type selected for this disk.␊ - */␊ - azureDiskType: (("Unknown" | "Standard" | "Premium" | "StandardSSD" | "StandardOrPremium") | string)␊ - /**␊ - * AHUB discount on windows virtual machines.␊ - */␊ - azureHybridUseBenefit: (("Unknown" | "Yes" | "No") | string)␊ - /**␊ - * Target Azure location for which the machines should be assessed. These enums are the same as used by Compute API.␊ - */␊ - azureLocation: (("Unknown" | "EastAsia" | "SoutheastAsia" | "AustraliaEast" | "AustraliaSoutheast" | "BrazilSouth" | "CanadaCentral" | "CanadaEast" | "WestEurope" | "NorthEurope" | "CentralIndia" | "SouthIndia" | "WestIndia" | "JapanEast" | "JapanWest" | "KoreaCentral" | "KoreaSouth" | "UkWest" | "UkSouth" | "NorthCentralUs" | "EastUs" | "WestUs2" | "SouthCentralUs" | "CentralUs" | "EastUs2" | "WestUs" | "WestCentralUs" | "GermanyCentral" | "GermanyNortheast" | "ChinaNorth" | "ChinaEast" | "USGovArizona" | "USGovTexas" | "USGovIowa" | "USGovVirginia" | "USDoDCentral" | "USDoDEast") | string)␊ - /**␊ - * Offer code according to which cost estimation is done.␊ - */␊ - azureOfferCode: (("Unknown" | "MSAZR0003P" | "MSAZR0044P" | "MSAZR0059P" | "MSAZR0060P" | "MSAZR0062P" | "MSAZR0063P" | "MSAZR0064P" | "MSAZR0029P" | "MSAZR0022P" | "MSAZR0023P" | "MSAZR0148P" | "MSAZR0025P" | "MSAZR0036P" | "MSAZR0120P" | "MSAZR0121P" | "MSAZR0122P" | "MSAZR0123P" | "MSAZR0124P" | "MSAZR0125P" | "MSAZR0126P" | "MSAZR0127P" | "MSAZR0128P" | "MSAZR0129P" | "MSAZR0130P" | "MSAZR0111P" | "MSAZR0144P" | "MSAZR0149P" | "MSMCAZR0044P" | "MSMCAZR0059P" | "MSMCAZR0060P" | "MSMCAZR0063P" | "MSMCAZR0120P" | "MSMCAZR0121P" | "MSMCAZR0125P" | "MSMCAZR0128P" | "MSAZRDE0003P" | "MSAZRDE0044P" | "MSAZRUSGOV0003P" | "EA") | string)␊ - /**␊ - * Pricing tier for Size evaluation.␊ - */␊ - azurePricingTier: (("Standard" | "Basic") | string)␊ - /**␊ - * Storage Redundancy type offered by Azure.␊ - */␊ - azureStorageRedundancy: (("Unknown" | "LocallyRedundant" | "ZoneRedundant" | "GeoRedundant" | "ReadAccessGeoRedundant") | string)␊ - /**␊ - * List of azure VM families.␊ - */␊ - azureVmFamilies: (("Unknown" | "Basic_A0_A4" | "Standard_A0_A7" | "Standard_A8_A11" | "Av2_series" | "D_series" | "Dv2_series" | "DS_series" | "DSv2_series" | "F_series" | "Fs_series" | "G_series" | "GS_series" | "H_series" | "Ls_series" | "Dsv3_series" | "Dv3_series" | "Fsv2_series" | "Ev3_series" | "Esv3_series" | "M_series" | "DC_Series")[] | string)␊ - /**␊ - * Currency to report prices in.␊ - */␊ - currency: (("Unknown" | "USD" | "DKK" | "CAD" | "IDR" | "JPY" | "KRW" | "NZD" | "NOK" | "RUB" | "SAR" | "ZAR" | "SEK" | "TRY" | "GBP" | "MXN" | "MYR" | "INR" | "HKD" | "BRL" | "TWD" | "EUR" | "CHF" | "ARS" | "AUD" | "CNY") | string)␊ - /**␊ - * Custom discount percentage to be applied on final costs. Can be in the range [0, 100].␊ - */␊ - discountPercentage: (number | string)␊ - /**␊ - * Percentile of performance data used to recommend Azure size.␊ - */␊ - percentile: (("Percentile50" | "Percentile90" | "Percentile95" | "Percentile99") | string)␊ - /**␊ - * Azure reserved instance.␊ - */␊ - reservedInstance: (("None" | "RI1Year" | "RI3Year") | string)␊ - /**␊ - * Scaling factor used over utilization data to add a performance buffer for new machines to be created in Azure. Min Value = 1.0, Max value = 1.9, Default = 1.3.␊ - */␊ - scalingFactor: (number | string)␊ - /**␊ - * Assessment sizing criterion.␊ - */␊ - sizingCriterion: (("PerformanceBased" | "AsOnPremises") | string)␊ - /**␊ - * User configurable setting that describes the status of the assessment.␊ - */␊ - stage: (("InProgress" | "UnderReview" | "Approved") | string)␊ - /**␊ - * Time range of performance data used to recommend a size.␊ - */␊ - timeRange: (("Day" | "Week" | "Month" | "Custom") | string)␊ - vmUptime: (VmUptime | string)␊ - [k: string]: unknown␊ - }␊ - export interface VmUptime {␊ - /**␊ - * Number of days in a month for VM uptime.␊ - */␊ - daysPerMonth?: (number | string)␊ - /**␊ - * Number of hours per day for VM uptime.␊ - */␊ - hoursPerDay?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Migrate/assessmentProjects/groups/assessments␊ - */␊ - export interface AssessmentProjectsGroupsAssessments {␊ - apiVersion: "2019-10-01"␊ - /**␊ - * For optimistic concurrency control.␊ - */␊ - eTag?: string␊ - /**␊ - * Unique name of an assessment within a project.␊ - */␊ - name: string␊ - /**␊ - * Properties of an assessment.␊ - */␊ - properties: (AssessmentProperties | string)␊ - type: "Microsoft.Migrate/assessmentProjects/groups/assessments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Migrate/assessmentProjects/hypervcollectors␊ - */␊ - export interface AssessmentProjectsHypervcollectors {␊ - apiVersion: "2019-10-01"␊ - eTag?: string␊ - /**␊ - * Unique name of a Hyper-V collector within a project.␊ - */␊ - name: string␊ - properties: (CollectorProperties | string)␊ - type: "Microsoft.Migrate/assessmentProjects/hypervcollectors"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Migrate/assessmentProjects/vmwarecollectors␊ - */␊ - export interface AssessmentProjectsVmwarecollectors {␊ - apiVersion: "2019-10-01"␊ - eTag?: string␊ - /**␊ - * Unique name of a VMware collector within a project.␊ - */␊ - name: string␊ - properties: (CollectorProperties | string)␊ - type: "Microsoft.Migrate/assessmentProjects/vmwarecollectors"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ManagedServices/registrationAssignments␊ - */␊ - export interface RegistrationAssignments {␊ - /**␊ - * Guid of the registration assignment.␊ - */␊ - name: string␊ - type: "Microsoft.ManagedServices/registrationAssignments"␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Properties of a registration assignment.␊ - */␊ - properties: (RegistrationAssignmentProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a registration assignment.␊ - */␊ - export interface RegistrationAssignmentProperties {␊ - /**␊ - * Fully qualified path of the registration definition.␊ - */␊ - registrationDefinitionId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ManagedServices/registrationDefinitions␊ - */␊ - export interface RegistrationDefinitions {␊ - /**␊ - * Guid of the registration definition.␊ - */␊ - name: string␊ - type: "Microsoft.ManagedServices/registrationDefinitions"␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Properties of a registration definition.␊ - */␊ - properties: (RegistrationDefinitionProperties | string)␊ - /**␊ - * Plan details for the managed services.␊ - */␊ - plan?: (Plan7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a registration definition.␊ - */␊ - export interface RegistrationDefinitionProperties {␊ - /**␊ - * Description of the registration definition.␊ - */␊ - description?: string␊ - /**␊ - * Authorization tuple containing principal id of the user/security group or service principal and id of the build-in role.␊ - */␊ - authorizations: (Authorization[] | string)␊ - /**␊ - * Name of the registration definition.␊ - */␊ - registrationDefinitionName?: string␊ - /**␊ - * Id of the managedBy tenant.␊ - */␊ - managedByTenantId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authorization tuple containing principal Id (of user/service principal/security group) and role definition id.␊ - */␊ - export interface Authorization {␊ - /**␊ - * Principal Id of the security group/service principal/user that would be assigned permissions to the projected subscription␊ - */␊ - principalId: string␊ - /**␊ - * The role definition identifier. This role will define all the permissions that the security group/service principal/user must have on the projected subscription. This role cannot be an owner role.␊ - */␊ - roleDefinitionId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Plan details for the managed services.␊ - */␊ - export interface Plan7 {␊ - /**␊ - * The plan name.␊ - */␊ - name: string␊ - /**␊ - * The publisher ID.␊ - */␊ - publisher: string␊ - /**␊ - * The product code.␊ - */␊ - product: string␊ - /**␊ - * The plan's version.␊ - */␊ - version: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ManagedServices/registrationAssignments␊ - */␊ - export interface RegistrationAssignments1 {␊ - /**␊ - * Guid of the registration assignment.␊ - */␊ - name: string␊ - type: "Microsoft.ManagedServices/registrationAssignments"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Properties of a registration assignment.␊ - */␊ - properties: (RegistrationAssignmentProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a registration assignment.␊ - */␊ - export interface RegistrationAssignmentProperties1 {␊ - /**␊ - * Fully qualified path of the registration definition.␊ - */␊ - registrationDefinitionId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ManagedServices/registrationDefinitions␊ - */␊ - export interface RegistrationDefinitions1 {␊ - /**␊ - * Guid of the registration definition.␊ - */␊ - name: string␊ - type: "Microsoft.ManagedServices/registrationDefinitions"␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Properties of a registration definition.␊ - */␊ - properties: (RegistrationDefinitionProperties1 | string)␊ - /**␊ - * Plan details for the managed services.␊ - */␊ - plan?: (Plan8 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a registration definition.␊ - */␊ - export interface RegistrationDefinitionProperties1 {␊ - /**␊ - * Description of the registration definition.␊ - */␊ - description?: string␊ - /**␊ - * Authorization tuple containing principal id of the user/security group or service principal and id of the build-in role.␊ - */␊ - authorizations: (Authorization1[] | string)␊ - /**␊ - * Name of the registration definition.␊ - */␊ - registrationDefinitionName?: string␊ - /**␊ - * Id of the managedBy tenant.␊ - */␊ - managedByTenantId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authorization tuple containing principal Id (of user/service principal/security group) and role definition id.␊ - */␊ - export interface Authorization1 {␊ - /**␊ - * Principal Id of the security group/service principal/user that would be assigned permissions to the projected subscription␊ - */␊ - principalId: string␊ - /**␊ - * The role definition identifier. This role will define all the permissions that the security group/service principal/user must have on the projected subscription. This role cannot be an owner role.␊ - */␊ - roleDefinitionId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Plan details for the managed services.␊ - */␊ - export interface Plan8 {␊ - /**␊ - * The plan name.␊ - */␊ - name: string␊ - /**␊ - * The publisher ID.␊ - */␊ - publisher: string␊ - /**␊ - * The product code.␊ - */␊ - product: string␊ - /**␊ - * The plan's version.␊ - */␊ - version: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Cray Servers resource.␊ - */␊ - export interface CrayServers {␊ - /**␊ - * Resource name␊ - */␊ - name: string␊ - /**␊ - * The resource type.␊ - */␊ - type: "Microsoft.BareMetal/crayServers"␊ - apiVersion: "2018-09-01-preview"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - properties: (CrayServersProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Cray Servers properties.␊ - */␊ - export interface CrayServersProperties {␊ - /**␊ - * Ip Address.␊ - */␊ - ipAddress: string␊ - /**␊ - * Subnet resource ID.␊ - */␊ - subnetResourceId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ContainerService/managedClusters␊ - */␊ - export interface ManagedClusters1 {␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Identity for the managed cluster.␊ - */␊ - identity?: (ManagedClusterIdentity | string)␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the managed cluster resource.␊ - */␊ - name: string␊ - /**␊ - * Properties of the managed cluster.␊ - */␊ - properties: (ManagedClusterProperties1 | string)␊ - resources?: ManagedClustersAgentPoolsChildResource[]␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.ContainerService/managedClusters"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the managed cluster.␊ - */␊ - export interface ManagedClusterIdentity {␊ - /**␊ - * The type of identity used for the managed cluster. Type 'SystemAssigned' will use an implicitly created identity in master components and an auto-created user assigned identity in MC_ resource group in agent nodes. Type 'None' will not use MSI for the managed cluster, service principal will be used instead.␊ - */␊ - type?: (("SystemAssigned" | "None") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the managed cluster.␊ - */␊ - export interface ManagedClusterProperties1 {␊ - /**␊ - * AADProfile specifies attributes for Azure Active Directory integration.␊ - */␊ - aadProfile?: (ManagedClusterAADProfile1 | string)␊ - /**␊ - * Profile of managed cluster add-on.␊ - */␊ - addonProfiles?: ({␊ - [k: string]: ManagedClusterAddonProfile1␊ - } | string)␊ - /**␊ - * Properties of the agent pool.␊ - */␊ - agentPoolProfiles?: (ManagedClusterAgentPoolProfile1[] | string)␊ - /**␊ - * (PREVIEW) Authorized IP Ranges to kubernetes API server.␊ - */␊ - apiServerAuthorizedIPRanges?: (string[] | string)␊ - /**␊ - * DNS prefix specified when creating the managed cluster.␊ - */␊ - dnsPrefix?: string␊ - /**␊ - * (DEPRECATING) Whether to enable Kubernetes pod security policy (preview). This feature is set for removal on October 15th, 2020. Learn more at aka.ms/aks/azpodpolicy.␊ - */␊ - enablePodSecurityPolicy?: (boolean | string)␊ - /**␊ - * Whether to enable Kubernetes Role-Based Access Control.␊ - */␊ - enableRBAC?: (boolean | string)␊ - /**␊ - * Version of Kubernetes specified when creating the managed cluster.␊ - */␊ - kubernetesVersion?: string␊ - /**␊ - * Profile for Linux VMs in the container service cluster.␊ - */␊ - linuxProfile?: (ContainerServiceLinuxProfile3 | string)␊ - /**␊ - * Profile of network configuration.␊ - */␊ - networkProfile?: (ContainerServiceNetworkProfile1 | string)␊ - /**␊ - * Name of the resource group containing agent pool nodes.␊ - */␊ - nodeResourceGroup?: string␊ - /**␊ - * Information about a service principal identity for the cluster to use for manipulating Azure APIs.␊ - */␊ - servicePrincipalProfile?: (ManagedClusterServicePrincipalProfile1 | string)␊ - /**␊ - * Profile for Windows VMs in the container service cluster.␊ - */␊ - windowsProfile?: (ManagedClusterWindowsProfile | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AADProfile specifies attributes for Azure Active Directory integration.␊ - */␊ - export interface ManagedClusterAADProfile1 {␊ - /**␊ - * The client AAD application ID.␊ - */␊ - clientAppID: string␊ - /**␊ - * The server AAD application ID.␊ - */␊ - serverAppID: string␊ - /**␊ - * The server AAD application secret.␊ - */␊ - serverAppSecret?: string␊ - /**␊ - * The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription.␊ - */␊ - tenantID?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A Kubernetes add-on profile for a managed cluster.␊ - */␊ - export interface ManagedClusterAddonProfile1 {␊ - /**␊ - * Key-value pairs for configuring an add-on.␊ - */␊ - config?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Whether the add-on is enabled or not.␊ - */␊ - enabled: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Profile for the container service agent pool.␊ - */␊ - export interface ManagedClusterAgentPoolProfile1 {␊ - /**␊ - * (PREVIEW) Availability zones for nodes. Must use VirtualMachineScaleSets AgentPoolType.␊ - */␊ - availabilityZones?: (string[] | string)␊ - /**␊ - * Number of agents (VMs) to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1.␊ - */␊ - count?: (number | string)␊ - /**␊ - * Whether to enable auto-scaler␊ - */␊ - enableAutoScaling?: (boolean | string)␊ - /**␊ - * Enable public IP for nodes␊ - */␊ - enableNodePublicIP?: (boolean | string)␊ - /**␊ - * Maximum number of nodes for auto-scaling␊ - */␊ - maxCount?: (number | string)␊ - /**␊ - * Maximum number of pods that can run on a node.␊ - */␊ - maxPods?: (number | string)␊ - /**␊ - * Minimum number of nodes for auto-scaling␊ - */␊ - minCount?: (number | string)␊ - /**␊ - * Unique name of the agent pool profile in the context of the subscription and resource group.␊ - */␊ - name: string␊ - /**␊ - * Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.␊ - */␊ - nodeTaints?: (string[] | string)␊ - /**␊ - * Version of orchestrator specified when creating the managed cluster.␊ - */␊ - orchestratorVersion?: string␊ - /**␊ - * OS Disk Size in GB to be used to specify the disk size for every machine in this master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified.␊ - */␊ - osDiskSizeGB?: (number | string)␊ - /**␊ - * OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux.␊ - */␊ - osType?: (("Linux" | "Windows") | string)␊ - /**␊ - * ScaleSetEvictionPolicy to be used to specify eviction policy for low priority virtual machine scale set. Default to Delete.␊ - */␊ - scaleSetEvictionPolicy?: (("Delete" | "Deallocate") | string)␊ - /**␊ - * ScaleSetPriority to be used to specify virtual machine scale set priority. Default to regular.␊ - */␊ - scaleSetPriority?: (("Low" | "Regular") | string)␊ - /**␊ - * AgentPoolType represents types of an agent pool.␊ - */␊ - type?: (("VirtualMachineScaleSets" | "AvailabilitySet") | string)␊ - /**␊ - * Size of agent VMs.␊ - */␊ - vmSize?: (("Standard_A1" | "Standard_A10" | "Standard_A11" | "Standard_A1_v2" | "Standard_A2" | "Standard_A2_v2" | "Standard_A2m_v2" | "Standard_A3" | "Standard_A4" | "Standard_A4_v2" | "Standard_A4m_v2" | "Standard_A5" | "Standard_A6" | "Standard_A7" | "Standard_A8" | "Standard_A8_v2" | "Standard_A8m_v2" | "Standard_A9" | "Standard_B2ms" | "Standard_B2s" | "Standard_B4ms" | "Standard_B8ms" | "Standard_D1" | "Standard_D11" | "Standard_D11_v2" | "Standard_D11_v2_Promo" | "Standard_D12" | "Standard_D12_v2" | "Standard_D12_v2_Promo" | "Standard_D13" | "Standard_D13_v2" | "Standard_D13_v2_Promo" | "Standard_D14" | "Standard_D14_v2" | "Standard_D14_v2_Promo" | "Standard_D15_v2" | "Standard_D16_v3" | "Standard_D16s_v3" | "Standard_D1_v2" | "Standard_D2" | "Standard_D2_v2" | "Standard_D2_v2_Promo" | "Standard_D2_v3" | "Standard_D2s_v3" | "Standard_D3" | "Standard_D32_v3" | "Standard_D32s_v3" | "Standard_D3_v2" | "Standard_D3_v2_Promo" | "Standard_D4" | "Standard_D4_v2" | "Standard_D4_v2_Promo" | "Standard_D4_v3" | "Standard_D4s_v3" | "Standard_D5_v2" | "Standard_D5_v2_Promo" | "Standard_D64_v3" | "Standard_D64s_v3" | "Standard_D8_v3" | "Standard_D8s_v3" | "Standard_DS1" | "Standard_DS11" | "Standard_DS11_v2" | "Standard_DS11_v2_Promo" | "Standard_DS12" | "Standard_DS12_v2" | "Standard_DS12_v2_Promo" | "Standard_DS13" | "Standard_DS13-2_v2" | "Standard_DS13-4_v2" | "Standard_DS13_v2" | "Standard_DS13_v2_Promo" | "Standard_DS14" | "Standard_DS14-4_v2" | "Standard_DS14-8_v2" | "Standard_DS14_v2" | "Standard_DS14_v2_Promo" | "Standard_DS15_v2" | "Standard_DS1_v2" | "Standard_DS2" | "Standard_DS2_v2" | "Standard_DS2_v2_Promo" | "Standard_DS3" | "Standard_DS3_v2" | "Standard_DS3_v2_Promo" | "Standard_DS4" | "Standard_DS4_v2" | "Standard_DS4_v2_Promo" | "Standard_DS5_v2" | "Standard_DS5_v2_Promo" | "Standard_E16_v3" | "Standard_E16s_v3" | "Standard_E2_v3" | "Standard_E2s_v3" | "Standard_E32-16s_v3" | "Standard_E32-8s_v3" | "Standard_E32_v3" | "Standard_E32s_v3" | "Standard_E4_v3" | "Standard_E4s_v3" | "Standard_E64-16s_v3" | "Standard_E64-32s_v3" | "Standard_E64_v3" | "Standard_E64s_v3" | "Standard_E8_v3" | "Standard_E8s_v3" | "Standard_F1" | "Standard_F16" | "Standard_F16s" | "Standard_F16s_v2" | "Standard_F1s" | "Standard_F2" | "Standard_F2s" | "Standard_F2s_v2" | "Standard_F32s_v2" | "Standard_F4" | "Standard_F4s" | "Standard_F4s_v2" | "Standard_F64s_v2" | "Standard_F72s_v2" | "Standard_F8" | "Standard_F8s" | "Standard_F8s_v2" | "Standard_G1" | "Standard_G2" | "Standard_G3" | "Standard_G4" | "Standard_G5" | "Standard_GS1" | "Standard_GS2" | "Standard_GS3" | "Standard_GS4" | "Standard_GS4-4" | "Standard_GS4-8" | "Standard_GS5" | "Standard_GS5-16" | "Standard_GS5-8" | "Standard_H16" | "Standard_H16m" | "Standard_H16mr" | "Standard_H16r" | "Standard_H8" | "Standard_H8m" | "Standard_L16s" | "Standard_L32s" | "Standard_L4s" | "Standard_L8s" | "Standard_M128-32ms" | "Standard_M128-64ms" | "Standard_M128ms" | "Standard_M128s" | "Standard_M64-16ms" | "Standard_M64-32ms" | "Standard_M64ms" | "Standard_M64s" | "Standard_NC12" | "Standard_NC12s_v2" | "Standard_NC12s_v3" | "Standard_NC24" | "Standard_NC24r" | "Standard_NC24rs_v2" | "Standard_NC24rs_v3" | "Standard_NC24s_v2" | "Standard_NC24s_v3" | "Standard_NC6" | "Standard_NC6s_v2" | "Standard_NC6s_v3" | "Standard_ND12s" | "Standard_ND24rs" | "Standard_ND24s" | "Standard_ND6s" | "Standard_NV12" | "Standard_NV24" | "Standard_NV6") | string)␊ - /**␊ - * VNet SubnetID specifies the VNet's subnet identifier.␊ - */␊ - vnetSubnetID?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Profile for Linux VMs in the container service cluster.␊ - */␊ - export interface ContainerServiceLinuxProfile3 {␊ - /**␊ - * The administrator username to use for Linux VMs.␊ - */␊ - adminUsername: string␊ - /**␊ - * SSH configuration for Linux-based VMs running on Azure.␊ - */␊ - ssh: (ContainerServiceSshConfiguration3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSH configuration for Linux-based VMs running on Azure.␊ - */␊ - export interface ContainerServiceSshConfiguration3 {␊ - /**␊ - * The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified.␊ - */␊ - publicKeys: (ContainerServiceSshPublicKey3[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains information about SSH certificate public key data.␊ - */␊ - export interface ContainerServiceSshPublicKey3 {␊ - /**␊ - * Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers.␊ - */␊ - keyData: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Profile of network configuration.␊ - */␊ - export interface ContainerServiceNetworkProfile1 {␊ - /**␊ - * An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr.␊ - */␊ - dnsServiceIP?: string␊ - /**␊ - * A CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the Kubernetes service address range.␊ - */␊ - dockerBridgeCidr?: string␊ - /**␊ - * The load balancer sku for the managed cluster.␊ - */␊ - loadBalancerSku?: (("standard" | "basic") | string)␊ - /**␊ - * Network plugin used for building Kubernetes network.␊ - */␊ - networkPlugin?: (("azure" | "kubenet") | string)␊ - /**␊ - * Network policy used for building Kubernetes network.␊ - */␊ - networkPolicy?: (("calico" | "azure") | string)␊ - /**␊ - * A CIDR notation IP range from which to assign pod IPs when kubenet is used.␊ - */␊ - podCidr?: string␊ - /**␊ - * A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges.␊ - */␊ - serviceCidr?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about a service principal identity for the cluster to use for manipulating Azure APIs.␊ - */␊ - export interface ManagedClusterServicePrincipalProfile1 {␊ - /**␊ - * The ID for the service principal.␊ - */␊ - clientId: string␊ - /**␊ - * The secret password associated with the service principal in plain text.␊ - */␊ - secret?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Profile for Windows VMs in the container service cluster.␊ - */␊ - export interface ManagedClusterWindowsProfile {␊ - /**␊ - * Specifies the password of the administrator account.

    **Minimum-length:** 8 characters

    **Max-length:** 123 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!"␊ - */␊ - adminPassword?: string␊ - /**␊ - * Specifies the name of the administrator account.

    **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:** 1 character

    **Max-length:** 20 characters␊ - */␊ - adminUsername: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ContainerService/managedClusters/agentPools␊ - */␊ - export interface ManagedClustersAgentPoolsChildResource {␊ - apiVersion: "2019-06-01"␊ - /**␊ - * The name of the agent pool.␊ - */␊ - name: string␊ - /**␊ - * Properties for the container service agent pool profile.␊ - */␊ - properties: (ManagedClusterAgentPoolProfileProperties | string)␊ - type: "agentPools"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties for the container service agent pool profile.␊ - */␊ - export interface ManagedClusterAgentPoolProfileProperties {␊ - /**␊ - * (PREVIEW) Availability zones for nodes. Must use VirtualMachineScaleSets AgentPoolType.␊ - */␊ - availabilityZones?: (string[] | string)␊ - /**␊ - * Number of agents (VMs) to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1.␊ - */␊ - count?: (number | string)␊ - /**␊ - * Whether to enable auto-scaler␊ - */␊ - enableAutoScaling?: (boolean | string)␊ - /**␊ - * Enable public IP for nodes␊ - */␊ - enableNodePublicIP?: (boolean | string)␊ - /**␊ - * Maximum number of nodes for auto-scaling␊ - */␊ - maxCount?: (number | string)␊ - /**␊ - * Maximum number of pods that can run on a node.␊ - */␊ - maxPods?: (number | string)␊ - /**␊ - * Minimum number of nodes for auto-scaling␊ - */␊ - minCount?: (number | string)␊ - /**␊ - * Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.␊ - */␊ - nodeTaints?: (string[] | string)␊ - /**␊ - * Version of orchestrator specified when creating the managed cluster.␊ - */␊ - orchestratorVersion?: string␊ - /**␊ - * OS Disk Size in GB to be used to specify the disk size for every machine in this master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified.␊ - */␊ - osDiskSizeGB?: (number | string)␊ - /**␊ - * OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux.␊ - */␊ - osType?: (("Linux" | "Windows") | string)␊ - /**␊ - * ScaleSetEvictionPolicy to be used to specify eviction policy for low priority virtual machine scale set. Default to Delete.␊ - */␊ - scaleSetEvictionPolicy?: (("Delete" | "Deallocate") | string)␊ - /**␊ - * ScaleSetPriority to be used to specify virtual machine scale set priority. Default to regular.␊ - */␊ - scaleSetPriority?: (("Low" | "Regular") | string)␊ - /**␊ - * AgentPoolType represents types of an agent pool.␊ - */␊ - type?: (("VirtualMachineScaleSets" | "AvailabilitySet") | string)␊ - /**␊ - * Size of agent VMs.␊ - */␊ - vmSize?: (("Standard_A1" | "Standard_A10" | "Standard_A11" | "Standard_A1_v2" | "Standard_A2" | "Standard_A2_v2" | "Standard_A2m_v2" | "Standard_A3" | "Standard_A4" | "Standard_A4_v2" | "Standard_A4m_v2" | "Standard_A5" | "Standard_A6" | "Standard_A7" | "Standard_A8" | "Standard_A8_v2" | "Standard_A8m_v2" | "Standard_A9" | "Standard_B2ms" | "Standard_B2s" | "Standard_B4ms" | "Standard_B8ms" | "Standard_D1" | "Standard_D11" | "Standard_D11_v2" | "Standard_D11_v2_Promo" | "Standard_D12" | "Standard_D12_v2" | "Standard_D12_v2_Promo" | "Standard_D13" | "Standard_D13_v2" | "Standard_D13_v2_Promo" | "Standard_D14" | "Standard_D14_v2" | "Standard_D14_v2_Promo" | "Standard_D15_v2" | "Standard_D16_v3" | "Standard_D16s_v3" | "Standard_D1_v2" | "Standard_D2" | "Standard_D2_v2" | "Standard_D2_v2_Promo" | "Standard_D2_v3" | "Standard_D2s_v3" | "Standard_D3" | "Standard_D32_v3" | "Standard_D32s_v3" | "Standard_D3_v2" | "Standard_D3_v2_Promo" | "Standard_D4" | "Standard_D4_v2" | "Standard_D4_v2_Promo" | "Standard_D4_v3" | "Standard_D4s_v3" | "Standard_D5_v2" | "Standard_D5_v2_Promo" | "Standard_D64_v3" | "Standard_D64s_v3" | "Standard_D8_v3" | "Standard_D8s_v3" | "Standard_DS1" | "Standard_DS11" | "Standard_DS11_v2" | "Standard_DS11_v2_Promo" | "Standard_DS12" | "Standard_DS12_v2" | "Standard_DS12_v2_Promo" | "Standard_DS13" | "Standard_DS13-2_v2" | "Standard_DS13-4_v2" | "Standard_DS13_v2" | "Standard_DS13_v2_Promo" | "Standard_DS14" | "Standard_DS14-4_v2" | "Standard_DS14-8_v2" | "Standard_DS14_v2" | "Standard_DS14_v2_Promo" | "Standard_DS15_v2" | "Standard_DS1_v2" | "Standard_DS2" | "Standard_DS2_v2" | "Standard_DS2_v2_Promo" | "Standard_DS3" | "Standard_DS3_v2" | "Standard_DS3_v2_Promo" | "Standard_DS4" | "Standard_DS4_v2" | "Standard_DS4_v2_Promo" | "Standard_DS5_v2" | "Standard_DS5_v2_Promo" | "Standard_E16_v3" | "Standard_E16s_v3" | "Standard_E2_v3" | "Standard_E2s_v3" | "Standard_E32-16s_v3" | "Standard_E32-8s_v3" | "Standard_E32_v3" | "Standard_E32s_v3" | "Standard_E4_v3" | "Standard_E4s_v3" | "Standard_E64-16s_v3" | "Standard_E64-32s_v3" | "Standard_E64_v3" | "Standard_E64s_v3" | "Standard_E8_v3" | "Standard_E8s_v3" | "Standard_F1" | "Standard_F16" | "Standard_F16s" | "Standard_F16s_v2" | "Standard_F1s" | "Standard_F2" | "Standard_F2s" | "Standard_F2s_v2" | "Standard_F32s_v2" | "Standard_F4" | "Standard_F4s" | "Standard_F4s_v2" | "Standard_F64s_v2" | "Standard_F72s_v2" | "Standard_F8" | "Standard_F8s" | "Standard_F8s_v2" | "Standard_G1" | "Standard_G2" | "Standard_G3" | "Standard_G4" | "Standard_G5" | "Standard_GS1" | "Standard_GS2" | "Standard_GS3" | "Standard_GS4" | "Standard_GS4-4" | "Standard_GS4-8" | "Standard_GS5" | "Standard_GS5-16" | "Standard_GS5-8" | "Standard_H16" | "Standard_H16m" | "Standard_H16mr" | "Standard_H16r" | "Standard_H8" | "Standard_H8m" | "Standard_L16s" | "Standard_L32s" | "Standard_L4s" | "Standard_L8s" | "Standard_M128-32ms" | "Standard_M128-64ms" | "Standard_M128ms" | "Standard_M128s" | "Standard_M64-16ms" | "Standard_M64-32ms" | "Standard_M64ms" | "Standard_M64s" | "Standard_NC12" | "Standard_NC12s_v2" | "Standard_NC12s_v3" | "Standard_NC24" | "Standard_NC24r" | "Standard_NC24rs_v2" | "Standard_NC24rs_v3" | "Standard_NC24s_v2" | "Standard_NC24s_v3" | "Standard_NC6" | "Standard_NC6s_v2" | "Standard_NC6s_v3" | "Standard_ND12s" | "Standard_ND24rs" | "Standard_ND24s" | "Standard_ND6s" | "Standard_NV12" | "Standard_NV24" | "Standard_NV6") | string)␊ - /**␊ - * VNet SubnetID specifies the VNet's subnet identifier.␊ - */␊ - vnetSubnetID?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ContainerService/managedClusters/agentPools␊ - */␊ - export interface ManagedClustersAgentPools {␊ - apiVersion: "2019-06-01"␊ - /**␊ - * The name of the agent pool.␊ - */␊ - name: string␊ - /**␊ - * Properties for the container service agent pool profile.␊ - */␊ - properties: (ManagedClusterAgentPoolProfileProperties | string)␊ - type: "Microsoft.ContainerService/managedClusters/agentPools"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Migrate/migrateProjects␊ - */␊ - export interface MigrateProjects {␊ - apiVersion: "2018-09-01-preview"␊ - /**␊ - * Gets or sets the eTag for concurrency control.␊ - */␊ - eTag?: string␊ - /**␊ - * Gets or sets the Azure location in which migrate project is created.␊ - */␊ - location?: string␊ - /**␊ - * Name of the Azure Migrate project.␊ - */␊ - name: string␊ - /**␊ - * Class for migrate project properties.␊ - */␊ - properties: (MigrateProjectProperties | string)␊ - resources?: MigrateProjectsSolutionsChildResource[]␊ - /**␊ - * Gets or sets the tags.␊ - */␊ - tags?: (MigrateProjectTags | string)␊ - type: "Microsoft.Migrate/migrateProjects"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class for migrate project properties.␊ - */␊ - export interface MigrateProjectProperties {␊ - /**␊ - * Provisioning state of the migrate project.␊ - */␊ - provisioningState?: (("Accepted" | "Creating" | "Deleting" | "Failed" | "Moving" | "Succeeded") | string)␊ - /**␊ - * Gets or sets the list of tools registered with the migrate project.␊ - */␊ - registeredTools?: (("ServerDiscovery" | "ServerAssessment" | "ServerMigration" | "Cloudamize" | "Turbonomic" | "Zerto" | "CorentTech" | "ServerAssessmentV1" | "ServerMigration_Replication" | "Carbonite" | "DataMigrationAssistant" | "DatabaseMigrationService")[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Migrate/migrateProjects/solutions␊ - */␊ - export interface MigrateProjectsSolutionsChildResource {␊ - apiVersion: "2018-09-01-preview"␊ - /**␊ - * Gets or sets the ETAG for optimistic concurrency control.␊ - */␊ - etag?: string␊ - /**␊ - * Unique name of a migration solution within a migrate project.␊ - */␊ - name: string␊ - /**␊ - * Class for solution properties.␊ - */␊ - properties: (SolutionProperties1 | string)␊ - type: "solutions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class for solution properties.␊ - */␊ - export interface SolutionProperties1 {␊ - /**␊ - * Gets or sets the cleanup state of the solution.␊ - */␊ - cleanupState?: (("None" | "Started" | "InProgress" | "Completed" | "Failed") | string)␊ - /**␊ - * Class representing the details of the solution.␊ - */␊ - details?: (SolutionDetails | string)␊ - /**␊ - * Gets or sets the goal of the solution.␊ - */␊ - goal?: (("Servers" | "Databases") | string)␊ - /**␊ - * Gets or sets the purpose of the solution.␊ - */␊ - purpose?: (("Discovery" | "Assessment" | "Migration") | string)␊ - /**␊ - * Gets or sets the current status of the solution.␊ - */␊ - status?: (("Inactive" | "Active") | string)␊ - /**␊ - * The solution summary class.␊ - */␊ - summary?: (SolutionSummary | string)␊ - /**␊ - * Gets or sets the tool being used in the solution.␊ - */␊ - tool?: (("ServerDiscovery" | "ServerAssessment" | "ServerMigration" | "Cloudamize" | "Turbonomic" | "Zerto" | "CorentTech" | "ServerAssessmentV1" | "ServerMigration_Replication" | "Carbonite" | "DataMigrationAssistant" | "DatabaseMigrationService") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the details of the solution.␊ - */␊ - export interface SolutionDetails {␊ - /**␊ - * Gets or sets the count of assessments reported by the solution.␊ - */␊ - assessmentCount?: (number | string)␊ - /**␊ - * Gets or sets the extended details reported by the solution.␊ - */␊ - extendedDetails?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Gets or sets the count of groups reported by the solution.␊ - */␊ - groupCount?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the servers solution summary.␊ - */␊ - export interface ServersSolutionSummary {␊ - /**␊ - * Gets or sets the count of servers assessed.␊ - */␊ - assessedCount?: (number | string)␊ - /**␊ - * Gets or sets the count of servers discovered.␊ - */␊ - discoveredCount?: (number | string)␊ - instanceType: "Servers"␊ - /**␊ - * Gets or sets the count of servers migrated.␊ - */␊ - migratedCount?: (number | string)␊ - /**␊ - * Gets or sets the count of servers being replicated.␊ - */␊ - replicatingCount?: (number | string)␊ - /**␊ - * Gets or sets the count of servers test migrated.␊ - */␊ - testMigratedCount?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class representing the databases solution summary.␊ - */␊ - export interface DatabasesSolutionSummary {␊ - /**␊ - * Gets or sets the count of database instances assessed.␊ - */␊ - databaseInstancesAssessedCount?: (number | string)␊ - /**␊ - * Gets or sets the count of databases assessed.␊ - */␊ - databasesAssessedCount?: (number | string)␊ - instanceType: "Databases"␊ - /**␊ - * Gets or sets the count of databases ready for migration.␊ - */␊ - migrationReadyCount?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Gets or sets the tags.␊ - */␊ - export interface MigrateProjectTags {␊ - additionalProperties?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Migrate/migrateProjects/solutions␊ - */␊ - export interface MigrateProjectsSolutions {␊ - apiVersion: "2018-09-01-preview"␊ - /**␊ - * Gets or sets the ETAG for optimistic concurrency control.␊ - */␊ - etag?: string␊ - /**␊ - * Unique name of a migration solution within a migrate project.␊ - */␊ - name: string␊ - /**␊ - * Class for solution properties.␊ - */␊ - properties: (SolutionProperties1 | string)␊ - type: "Microsoft.Migrate/migrateProjects/solutions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces␊ - */␊ - export interface Namespaces3 {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Namespace location.␊ - */␊ - location: string␊ - /**␊ - * The namespace name.␊ - */␊ - name: string␊ - /**␊ - * Properties of the namespace.␊ - */␊ - properties: (NamespaceProperties3 | string)␊ - resources?: (Namespaces_AuthorizationRulesChildResource3 | NamespacesQueuesChildResource | NamespacesTopicsChildResource)[]␊ - /**␊ - * SKU of the namespace.␊ - */␊ - sku?: (Sku62 | string)␊ - /**␊ - * Namespace tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.ServiceBus/namespaces"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the namespace.␊ - */␊ - export interface NamespaceProperties3 {␊ - /**␊ - * Indicates whether to create an ACS namespace.␊ - */␊ - createACSNamespace?: (boolean | string)␊ - /**␊ - * Specifies whether this instance is enabled.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * State of the namespace.␊ - */␊ - status?: (("Unknown" | "Creating" | "Created" | "Activating" | "Enabling" | "Active" | "Disabling" | "Disabled" | "SoftDeleting" | "SoftDeleted" | "Removing" | "Removed" | "Failed") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/AuthorizationRules␊ - */␊ - export interface Namespaces_AuthorizationRulesChildResource3 {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * data center location.␊ - */␊ - location?: string␊ - /**␊ - * The authorization rule name.␊ - */␊ - name: string␊ - /**␊ - * SharedAccessAuthorizationRule properties.␊ - */␊ - properties: (SharedAccessAuthorizationRuleProperties3 | string)␊ - type: "AuthorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SharedAccessAuthorizationRule properties.␊ - */␊ - export interface SharedAccessAuthorizationRuleProperties3 {␊ - /**␊ - * The rights associated with the rule.␊ - */␊ - rights: (("Manage" | "Send" | "Listen")[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/queues␊ - */␊ - export interface NamespacesQueuesChildResource {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * location of the resource.␊ - */␊ - location: string␊ - /**␊ - * The queue name.␊ - */␊ - name: string␊ - /**␊ - * The Queue Properties definition.␊ - */␊ - properties: (QueueProperties1 | string)␊ - type: "queues"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Queue Properties definition.␊ - */␊ - export interface QueueProperties1 {␊ - /**␊ - * the TimeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes.␊ - */␊ - autoDeleteOnIdle?: string␊ - /**␊ - * A value that indicates whether this queue has dead letter support when a message expires.␊ - */␊ - deadLetteringOnMessageExpiration?: (boolean | string)␊ - /**␊ - * The default message time to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.␊ - */␊ - defaultMessageTimeToLive?: string␊ - /**␊ - * TimeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.␊ - */␊ - duplicateDetectionHistoryTimeWindow?: string␊ - /**␊ - * A value that indicates whether server-side batched operations are enabled.␊ - */␊ - enableBatchedOperations?: (boolean | string)␊ - /**␊ - * A value that indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage.␊ - */␊ - enableExpress?: (boolean | string)␊ - /**␊ - * A value that indicates whether the queue is to be partitioned across multiple message brokers.␊ - */␊ - enablePartitioning?: (boolean | string)␊ - /**␊ - * Entity availability status for the queue.␊ - */␊ - entityAvailabilityStatus?: (("Available" | "Limited" | "Renaming" | "Restoring" | "Unknown") | string)␊ - /**␊ - * A value that indicates whether the message is accessible anonymously.␊ - */␊ - isAnonymousAccessible?: (boolean | string)␊ - /**␊ - * The duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute.␊ - */␊ - lockDuration?: string␊ - /**␊ - * The maximum delivery count. A message is automatically deadlettered after this number of deliveries.␊ - */␊ - maxDeliveryCount?: (number | string)␊ - /**␊ - * The maximum size of the queue in megabytes, which is the size of memory allocated for the queue.␊ - */␊ - maxSizeInMegabytes?: (number | string)␊ - /**␊ - * A value indicating if this queue requires duplicate detection.␊ - */␊ - requiresDuplicateDetection?: (boolean | string)␊ - /**␊ - * A value that indicates whether the queue supports the concept of sessions.␊ - */␊ - requiresSession?: (boolean | string)␊ - /**␊ - * Enumerates the possible values for the status of a messaging entity.␊ - */␊ - status?: (("Active" | "Creating" | "Deleting" | "Disabled" | "ReceiveDisabled" | "Renaming" | "Restoring" | "SendDisabled" | "Unknown") | string)␊ - /**␊ - * A value that indicates whether the queue supports ordering.␊ - */␊ - supportOrdering?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/topics␊ - */␊ - export interface NamespacesTopicsChildResource {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Location of the resource.␊ - */␊ - location: string␊ - /**␊ - * The topic name.␊ - */␊ - name: string␊ - /**␊ - * The Topic Properties definition.␊ - */␊ - properties: (TopicProperties | string)␊ - type: "topics"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Topic Properties definition.␊ - */␊ - export interface TopicProperties {␊ - /**␊ - * TimeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.␊ - */␊ - autoDeleteOnIdle?: string␊ - /**␊ - * Default message time to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.␊ - */␊ - defaultMessageTimeToLive?: string␊ - /**␊ - * TimeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.␊ - */␊ - duplicateDetectionHistoryTimeWindow?: string␊ - /**␊ - * Value that indicates whether server-side batched operations are enabled.␊ - */␊ - enableBatchedOperations?: (boolean | string)␊ - /**␊ - * Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage.␊ - */␊ - enableExpress?: (boolean | string)␊ - /**␊ - * Value that indicates whether the topic to be partitioned across multiple message brokers is enabled.␊ - */␊ - enablePartitioning?: (boolean | string)␊ - /**␊ - * Entity availability status for the topic.␊ - */␊ - entityAvailabilityStatus?: (("Available" | "Limited" | "Renaming" | "Restoring" | "Unknown") | string)␊ - /**␊ - * Whether messages should be filtered before publishing.␊ - */␊ - filteringMessagesBeforePublishing?: (boolean | string)␊ - /**␊ - * Value that indicates whether the message is accessible anonymously.␊ - */␊ - isAnonymousAccessible?: (boolean | string)␊ - isExpress?: (boolean | string)␊ - /**␊ - * Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic.␊ - */␊ - maxSizeInMegabytes?: (number | string)␊ - /**␊ - * Value indicating if this topic requires duplicate detection.␊ - */␊ - requiresDuplicateDetection?: (boolean | string)␊ - /**␊ - * Enumerates the possible values for the status of a messaging entity.␊ - */␊ - status?: (("Active" | "Creating" | "Deleting" | "Disabled" | "ReceiveDisabled" | "Renaming" | "Restoring" | "SendDisabled" | "Unknown") | string)␊ - /**␊ - * Value that indicates whether the topic supports ordering.␊ - */␊ - supportOrdering?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of the namespace.␊ - */␊ - export interface Sku62 {␊ - /**␊ - * The specified messaging units for the tier.␊ - */␊ - capacity?: (number | string)␊ - /**␊ - * Name of this SKU.␊ - */␊ - name?: (("Basic" | "Standard" | "Premium") | string)␊ - /**␊ - * The billing tier of this particular SKU.␊ - */␊ - tier: (("Basic" | "Standard" | "Premium") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/AuthorizationRules␊ - */␊ - export interface Namespaces_AuthorizationRules3 {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * data center location.␊ - */␊ - location?: string␊ - /**␊ - * The authorization rule name.␊ - */␊ - name: string␊ - /**␊ - * SharedAccessAuthorizationRule properties.␊ - */␊ - properties: (SharedAccessAuthorizationRuleProperties3 | string)␊ - type: "Microsoft.ServiceBus/namespaces/AuthorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/queues␊ - */␊ - export interface NamespacesQueues {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * location of the resource.␊ - */␊ - location: string␊ - /**␊ - * The queue name.␊ - */␊ - name: string␊ - /**␊ - * The Queue Properties definition.␊ - */␊ - properties: (QueueProperties1 | string)␊ - resources?: NamespacesQueuesAuthorizationRulesChildResource[]␊ - type: "Microsoft.ServiceBus/namespaces/queues"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/queues/authorizationRules␊ - */␊ - export interface NamespacesQueuesAuthorizationRulesChildResource {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * data center location.␊ - */␊ - location?: string␊ - /**␊ - * The authorization rule name.␊ - */␊ - name: string␊ - /**␊ - * SharedAccessAuthorizationRule properties.␊ - */␊ - properties: (SharedAccessAuthorizationRuleProperties3 | string)␊ - type: "authorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/queues/authorizationRules␊ - */␊ - export interface NamespacesQueuesAuthorizationRules {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * data center location.␊ - */␊ - location?: string␊ - /**␊ - * The authorization rule name.␊ - */␊ - name: string␊ - /**␊ - * SharedAccessAuthorizationRule properties.␊ - */␊ - properties: (SharedAccessAuthorizationRuleProperties3 | string)␊ - type: "Microsoft.ServiceBus/namespaces/queues/authorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/topics␊ - */␊ - export interface NamespacesTopics {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Location of the resource.␊ - */␊ - location: string␊ - /**␊ - * The topic name.␊ - */␊ - name: string␊ - /**␊ - * The Topic Properties definition.␊ - */␊ - properties: (TopicProperties | string)␊ - resources?: (NamespacesTopicsAuthorizationRulesChildResource | NamespacesTopicsSubscriptionsChildResource)[]␊ - type: "Microsoft.ServiceBus/namespaces/topics"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/topics/authorizationRules␊ - */␊ - export interface NamespacesTopicsAuthorizationRulesChildResource {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * data center location.␊ - */␊ - location?: string␊ - /**␊ - * The authorization rule name.␊ - */␊ - name: string␊ - /**␊ - * SharedAccessAuthorizationRule properties.␊ - */␊ - properties: (SharedAccessAuthorizationRuleProperties3 | string)␊ - type: "authorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/topics/subscriptions␊ - */␊ - export interface NamespacesTopicsSubscriptionsChildResource {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Subscription data center location.␊ - */␊ - location: string␊ - /**␊ - * The subscription name.␊ - */␊ - name: string␊ - /**␊ - * Description of Subscription Resource.␊ - */␊ - properties: (SubscriptionProperties | string)␊ - type: "subscriptions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of Subscription Resource.␊ - */␊ - export interface SubscriptionProperties {␊ - /**␊ - * TimeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.␊ - */␊ - autoDeleteOnIdle?: string␊ - /**␊ - * Value that indicates whether a subscription has dead letter support on filter evaluation exceptions.␊ - */␊ - deadLetteringOnFilterEvaluationExceptions?: (boolean | string)␊ - /**␊ - * Value that indicates whether a subscription has dead letter support when a message expires.␊ - */␊ - deadLetteringOnMessageExpiration?: (boolean | string)␊ - /**␊ - * Default message time to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.␊ - */␊ - defaultMessageTimeToLive?: string␊ - /**␊ - * Value that indicates whether server-side batched operations are enabled.␊ - */␊ - enableBatchedOperations?: (boolean | string)␊ - /**␊ - * Entity availability status for the topic.␊ - */␊ - entityAvailabilityStatus?: (("Available" | "Limited" | "Renaming" | "Restoring" | "Unknown") | string)␊ - /**␊ - * Value that indicates whether the entity description is read-only.␊ - */␊ - isReadOnly?: (boolean | string)␊ - /**␊ - * The lock duration time span for the subscription.␊ - */␊ - lockDuration?: string␊ - /**␊ - * Number of maximum deliveries.␊ - */␊ - maxDeliveryCount?: (number | string)␊ - /**␊ - * Value indicating if a subscription supports the concept of sessions.␊ - */␊ - requiresSession?: (boolean | string)␊ - /**␊ - * Enumerates the possible values for the status of a messaging entity.␊ - */␊ - status?: (("Active" | "Creating" | "Deleting" | "Disabled" | "ReceiveDisabled" | "Renaming" | "Restoring" | "SendDisabled" | "Unknown") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/topics/authorizationRules␊ - */␊ - export interface NamespacesTopicsAuthorizationRules {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * data center location.␊ - */␊ - location?: string␊ - /**␊ - * The authorization rule name.␊ - */␊ - name: string␊ - /**␊ - * SharedAccessAuthorizationRule properties.␊ - */␊ - properties: (SharedAccessAuthorizationRuleProperties3 | string)␊ - type: "Microsoft.ServiceBus/namespaces/topics/authorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/topics/subscriptions␊ - */␊ - export interface NamespacesTopicsSubscriptions {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Subscription data center location.␊ - */␊ - location: string␊ - /**␊ - * The subscription name.␊ - */␊ - name: string␊ - /**␊ - * Description of Subscription Resource.␊ - */␊ - properties: (SubscriptionProperties | string)␊ - type: "Microsoft.ServiceBus/namespaces/topics/subscriptions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces␊ - */␊ - export interface Namespaces4 {␊ - apiVersion: "2017-04-01"␊ - /**␊ - * The Geo-location where the resource lives␊ - */␊ - location: string␊ - /**␊ - * The namespace name.␊ - */␊ - name: string␊ - /**␊ - * Properties of the namespace.␊ - */␊ - properties: (SBNamespaceProperties | string)␊ - resources?: (Namespaces_AuthorizationRulesChildResource4 | NamespacesNetworkRuleSetsChildResource | NamespacesQueuesChildResource1 | NamespacesTopicsChildResource1 | NamespacesDisasterRecoveryConfigsChildResource | NamespacesMigrationConfigurationsChildResource)[]␊ - /**␊ - * SKU of the namespace.␊ - */␊ - sku?: (SBSku | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.ServiceBus/namespaces"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the namespace.␊ - */␊ - export interface SBNamespaceProperties {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/AuthorizationRules␊ - */␊ - export interface Namespaces_AuthorizationRulesChildResource4 {␊ - apiVersion: "2017-04-01"␊ - /**␊ - * The authorization rule name.␊ - */␊ - name: string␊ - /**␊ - * AuthorizationRule properties.␊ - */␊ - properties: (SBAuthorizationRuleProperties | string)␊ - type: "AuthorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AuthorizationRule properties.␊ - */␊ - export interface SBAuthorizationRuleProperties {␊ - /**␊ - * The rights associated with the rule.␊ - */␊ - rights: (("Manage" | "Send" | "Listen")[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/networkRuleSets␊ - */␊ - export interface NamespacesNetworkRuleSetsChildResource {␊ - apiVersion: "2017-04-01"␊ - name: "default"␊ - /**␊ - * NetworkRuleSet properties␊ - */␊ - properties: (NetworkRuleSetProperties | string)␊ - type: "networkRuleSets"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NetworkRuleSet properties␊ - */␊ - export interface NetworkRuleSetProperties {␊ - /**␊ - * Default Action for Network Rule Set.␊ - */␊ - defaultAction?: (("Allow" | "Deny") | string)␊ - /**␊ - * List of IpRules␊ - */␊ - ipRules?: (NWRuleSetIpRules[] | string)␊ - /**␊ - * List VirtualNetwork Rules␊ - */␊ - virtualNetworkRules?: (NWRuleSetVirtualNetworkRules[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of NetWorkRuleSet - IpRules resource.␊ - */␊ - export interface NWRuleSetIpRules {␊ - /**␊ - * The IP Filter Action.␊ - */␊ - action?: ("Allow" | string)␊ - /**␊ - * IP Mask␊ - */␊ - ipMask?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of VirtualNetworkRules - NetworkRules resource.␊ - */␊ - export interface NWRuleSetVirtualNetworkRules {␊ - /**␊ - * Value that indicates whether to ignore missing VNet Service Endpoint␊ - */␊ - ignoreMissingVnetServiceEndpoint?: (boolean | string)␊ - /**␊ - * Properties supplied for Subnet␊ - */␊ - subnet?: (Subnet38 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties supplied for Subnet␊ - */␊ - export interface Subnet38 {␊ - /**␊ - * Resource ID of Virtual Network Subnet␊ - */␊ - id: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/queues␊ - */␊ - export interface NamespacesQueuesChildResource1 {␊ - apiVersion: "2017-04-01"␊ - /**␊ - * The queue name.␊ - */␊ - name: string␊ - /**␊ - * The Queue Properties definition.␊ - */␊ - properties: (SBQueueProperties | string)␊ - type: "queues"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Queue Properties definition.␊ - */␊ - export interface SBQueueProperties {␊ - /**␊ - * ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes.␊ - */␊ - autoDeleteOnIdle?: string␊ - /**␊ - * A value that indicates whether this queue has dead letter support when a message expires.␊ - */␊ - deadLetteringOnMessageExpiration?: (boolean | string)␊ - /**␊ - * ISO 8601 default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.␊ - */␊ - defaultMessageTimeToLive?: string␊ - /**␊ - * ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.␊ - */␊ - duplicateDetectionHistoryTimeWindow?: string␊ - /**␊ - * Value that indicates whether server-side batched operations are enabled.␊ - */␊ - enableBatchedOperations?: (boolean | string)␊ - /**␊ - * A value that indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage.␊ - */␊ - enableExpress?: (boolean | string)␊ - /**␊ - * A value that indicates whether the queue is to be partitioned across multiple message brokers.␊ - */␊ - enablePartitioning?: (boolean | string)␊ - /**␊ - * Queue/Topic name to forward the Dead Letter message␊ - */␊ - forwardDeadLetteredMessagesTo?: string␊ - /**␊ - * Queue/Topic name to forward the messages␊ - */␊ - forwardTo?: string␊ - /**␊ - * ISO 8601 timespan duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute.␊ - */␊ - lockDuration?: string␊ - /**␊ - * The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10.␊ - */␊ - maxDeliveryCount?: (number | string)␊ - /**␊ - * The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024.␊ - */␊ - maxSizeInMegabytes?: (number | string)␊ - /**␊ - * A value indicating if this queue requires duplicate detection.␊ - */␊ - requiresDuplicateDetection?: (boolean | string)␊ - /**␊ - * A value that indicates whether the queue supports the concept of sessions.␊ - */␊ - requiresSession?: (boolean | string)␊ - /**␊ - * Enumerates the possible values for the status of a messaging entity.␊ - */␊ - status?: (("Active" | "Disabled" | "Restoring" | "SendDisabled" | "ReceiveDisabled" | "Creating" | "Deleting" | "Renaming" | "Unknown") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/topics␊ - */␊ - export interface NamespacesTopicsChildResource1 {␊ - apiVersion: "2017-04-01"␊ - /**␊ - * The topic name.␊ - */␊ - name: string␊ - /**␊ - * The Topic Properties definition.␊ - */␊ - properties: (SBTopicProperties | string)␊ - type: "topics"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Topic Properties definition.␊ - */␊ - export interface SBTopicProperties {␊ - /**␊ - * ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.␊ - */␊ - autoDeleteOnIdle?: string␊ - /**␊ - * ISO 8601 Default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.␊ - */␊ - defaultMessageTimeToLive?: string␊ - /**␊ - * ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.␊ - */␊ - duplicateDetectionHistoryTimeWindow?: string␊ - /**␊ - * Value that indicates whether server-side batched operations are enabled.␊ - */␊ - enableBatchedOperations?: (boolean | string)␊ - /**␊ - * Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage.␊ - */␊ - enableExpress?: (boolean | string)␊ - /**␊ - * Value that indicates whether the topic to be partitioned across multiple message brokers is enabled.␊ - */␊ - enablePartitioning?: (boolean | string)␊ - /**␊ - * Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024.␊ - */␊ - maxSizeInMegabytes?: (number | string)␊ - /**␊ - * Value indicating if this topic requires duplicate detection.␊ - */␊ - requiresDuplicateDetection?: (boolean | string)␊ - /**␊ - * Enumerates the possible values for the status of a messaging entity.␊ - */␊ - status?: (("Active" | "Disabled" | "Restoring" | "SendDisabled" | "ReceiveDisabled" | "Creating" | "Deleting" | "Renaming" | "Unknown") | string)␊ - /**␊ - * Value that indicates whether the topic supports ordering.␊ - */␊ - supportOrdering?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/disasterRecoveryConfigs␊ - */␊ - export interface NamespacesDisasterRecoveryConfigsChildResource {␊ - apiVersion: "2017-04-01"␊ - /**␊ - * The Disaster Recovery configuration name␊ - */␊ - name: string␊ - /**␊ - * Properties required to the Create Or Update Alias(Disaster Recovery configurations)␊ - */␊ - properties: (ArmDisasterRecoveryProperties | string)␊ - type: "disasterRecoveryConfigs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties required to the Create Or Update Alias(Disaster Recovery configurations)␊ - */␊ - export interface ArmDisasterRecoveryProperties {␊ - /**␊ - * Primary/Secondary eventhub namespace name, which is part of GEO DR pairing␊ - */␊ - alternateName?: string␊ - /**␊ - * ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing␊ - */␊ - partnerNamespace?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/migrationConfigurations␊ - */␊ - export interface NamespacesMigrationConfigurationsChildResource {␊ - apiVersion: "2017-04-01"␊ - /**␊ - * The configuration name. Should always be "$default".␊ - */␊ - name: "$default"␊ - /**␊ - * Properties required to the Create Migration Configuration␊ - */␊ - properties: (MigrationConfigPropertiesProperties | string)␊ - type: "migrationConfigurations"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties required to the Create Migration Configuration␊ - */␊ - export interface MigrationConfigPropertiesProperties {␊ - /**␊ - * Name to access Standard Namespace after migration␊ - */␊ - postMigrationName: string␊ - /**␊ - * Existing premium Namespace ARM Id name which has no entities, will be used for migration␊ - */␊ - targetNamespace: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of the namespace.␊ - */␊ - export interface SBSku {␊ - /**␊ - * The specified messaging units for the tier. For Premium tier, capacity are 1,2 and 4.␊ - */␊ - capacity?: (number | string)␊ - /**␊ - * Name of this SKU.␊ - */␊ - name: (("Basic" | "Standard" | "Premium") | string)␊ - /**␊ - * The billing tier of this particular SKU.␊ - */␊ - tier?: (("Basic" | "Standard" | "Premium") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/AuthorizationRules␊ - */␊ - export interface Namespaces_AuthorizationRules4 {␊ - apiVersion: "2017-04-01"␊ - /**␊ - * The authorization rule name.␊ - */␊ - name: string␊ - /**␊ - * AuthorizationRule properties.␊ - */␊ - properties: (SBAuthorizationRuleProperties | string)␊ - type: "Microsoft.ServiceBus/namespaces/AuthorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/disasterRecoveryConfigs␊ - */␊ - export interface NamespacesDisasterRecoveryConfigs {␊ - apiVersion: "2017-04-01"␊ - /**␊ - * The Disaster Recovery configuration name␊ - */␊ - name: string␊ - /**␊ - * Properties required to the Create Or Update Alias(Disaster Recovery configurations)␊ - */␊ - properties: (ArmDisasterRecoveryProperties | string)␊ - type: "Microsoft.ServiceBus/namespaces/disasterRecoveryConfigs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/migrationConfigurations␊ - */␊ - export interface NamespacesMigrationConfigurations {␊ - apiVersion: "2017-04-01"␊ - /**␊ - * The configuration name. Should always be "$default".␊ - */␊ - name: string␊ - /**␊ - * Properties required to the Create Migration Configuration␊ - */␊ - properties: (MigrationConfigPropertiesProperties | string)␊ - type: "Microsoft.ServiceBus/namespaces/migrationConfigurations"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/networkRuleSets␊ - */␊ - export interface NamespacesNetworkRuleSets {␊ - apiVersion: "2017-04-01"␊ - name: string␊ - /**␊ - * NetworkRuleSet properties␊ - */␊ - properties: (NetworkRuleSetProperties | string)␊ - type: "Microsoft.ServiceBus/namespaces/networkRuleSets"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/queues␊ - */␊ - export interface NamespacesQueues1 {␊ - apiVersion: "2017-04-01"␊ - /**␊ - * The queue name.␊ - */␊ - name: string␊ - /**␊ - * The Queue Properties definition.␊ - */␊ - properties: (SBQueueProperties | string)␊ - resources?: NamespacesQueuesAuthorizationRulesChildResource1[]␊ - type: "Microsoft.ServiceBus/namespaces/queues"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/queues/authorizationRules␊ - */␊ - export interface NamespacesQueuesAuthorizationRulesChildResource1 {␊ - apiVersion: "2017-04-01"␊ - /**␊ - * The authorization rule name.␊ - */␊ - name: string␊ - /**␊ - * AuthorizationRule properties.␊ - */␊ - properties: (SBAuthorizationRuleProperties | string)␊ - type: "authorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/queues/authorizationRules␊ - */␊ - export interface NamespacesQueuesAuthorizationRules1 {␊ - apiVersion: "2017-04-01"␊ - /**␊ - * The authorization rule name.␊ - */␊ - name: string␊ - /**␊ - * AuthorizationRule properties.␊ - */␊ - properties: (SBAuthorizationRuleProperties | string)␊ - type: "Microsoft.ServiceBus/namespaces/queues/authorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/topics␊ - */␊ - export interface NamespacesTopics1 {␊ - apiVersion: "2017-04-01"␊ - /**␊ - * The topic name.␊ - */␊ - name: string␊ - /**␊ - * The Topic Properties definition.␊ - */␊ - properties: (SBTopicProperties | string)␊ - resources?: (NamespacesTopicsAuthorizationRulesChildResource1 | NamespacesTopicsSubscriptionsChildResource1)[]␊ - type: "Microsoft.ServiceBus/namespaces/topics"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/topics/authorizationRules␊ - */␊ - export interface NamespacesTopicsAuthorizationRulesChildResource1 {␊ - apiVersion: "2017-04-01"␊ - /**␊ - * The authorization rule name.␊ - */␊ - name: string␊ - /**␊ - * AuthorizationRule properties.␊ - */␊ - properties: (SBAuthorizationRuleProperties | string)␊ - type: "authorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/topics/subscriptions␊ - */␊ - export interface NamespacesTopicsSubscriptionsChildResource1 {␊ - apiVersion: "2017-04-01"␊ - /**␊ - * The subscription name.␊ - */␊ - name: string␊ - /**␊ - * Description of Subscription Resource.␊ - */␊ - properties: (SBSubscriptionProperties | string)␊ - type: "subscriptions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of Subscription Resource.␊ - */␊ - export interface SBSubscriptionProperties {␊ - /**␊ - * ISO 8061 timeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.␊ - */␊ - autoDeleteOnIdle?: string␊ - /**␊ - * Value that indicates whether a subscription has dead letter support on filter evaluation exceptions.␊ - */␊ - deadLetteringOnFilterEvaluationExceptions?: (boolean | string)␊ - /**␊ - * Value that indicates whether a subscription has dead letter support when a message expires.␊ - */␊ - deadLetteringOnMessageExpiration?: (boolean | string)␊ - /**␊ - * ISO 8061 Default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.␊ - */␊ - defaultMessageTimeToLive?: string␊ - /**␊ - * ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.␊ - */␊ - duplicateDetectionHistoryTimeWindow?: string␊ - /**␊ - * Value that indicates whether server-side batched operations are enabled.␊ - */␊ - enableBatchedOperations?: (boolean | string)␊ - /**␊ - * Queue/Topic name to forward the Dead Letter message␊ - */␊ - forwardDeadLetteredMessagesTo?: string␊ - /**␊ - * Queue/Topic name to forward the messages␊ - */␊ - forwardTo?: string␊ - /**␊ - * ISO 8061 lock duration timespan for the subscription. The default value is 1 minute.␊ - */␊ - lockDuration?: string␊ - /**␊ - * Number of maximum deliveries.␊ - */␊ - maxDeliveryCount?: (number | string)␊ - /**␊ - * Value indicating if a subscription supports the concept of sessions.␊ - */␊ - requiresSession?: (boolean | string)␊ - /**␊ - * Enumerates the possible values for the status of a messaging entity.␊ - */␊ - status?: (("Active" | "Disabled" | "Restoring" | "SendDisabled" | "ReceiveDisabled" | "Creating" | "Deleting" | "Renaming" | "Unknown") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/topics/authorizationRules␊ - */␊ - export interface NamespacesTopicsAuthorizationRules1 {␊ - apiVersion: "2017-04-01"␊ - /**␊ - * The authorization rule name.␊ - */␊ - name: string␊ - /**␊ - * AuthorizationRule properties.␊ - */␊ - properties: (SBAuthorizationRuleProperties | string)␊ - type: "Microsoft.ServiceBus/namespaces/topics/authorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/topics/subscriptions␊ - */␊ - export interface NamespacesTopicsSubscriptions1 {␊ - apiVersion: "2017-04-01"␊ - /**␊ - * The subscription name.␊ - */␊ - name: string␊ - /**␊ - * Description of Subscription Resource.␊ - */␊ - properties: (SBSubscriptionProperties | string)␊ - resources?: NamespacesTopicsSubscriptionsRulesChildResource[]␊ - type: "Microsoft.ServiceBus/namespaces/topics/subscriptions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/topics/subscriptions/rules␊ - */␊ - export interface NamespacesTopicsSubscriptionsRulesChildResource {␊ - apiVersion: "2017-04-01"␊ - /**␊ - * The rule name.␊ - */␊ - name: string␊ - /**␊ - * Description of Rule Resource.␊ - */␊ - properties: (Ruleproperties | string)␊ - type: "rules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of Rule Resource.␊ - */␊ - export interface Ruleproperties {␊ - /**␊ - * Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression.␊ - */␊ - action?: (Action | string)␊ - /**␊ - * Represents the correlation filter expression.␊ - */␊ - correlationFilter?: (CorrelationFilter | string)␊ - /**␊ - * Filter type that is evaluated against a BrokeredMessage.␊ - */␊ - filterType?: (("SqlFilter" | "CorrelationFilter") | string)␊ - /**␊ - * Represents a filter which is a composition of an expression and an action that is executed in the pub/sub pipeline.␊ - */␊ - sqlFilter?: (SqlFilter | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression.␊ - */␊ - export interface Action {␊ - /**␊ - * This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20.␊ - */␊ - compatibilityLevel?: (number | string)␊ - /**␊ - * Value that indicates whether the rule action requires preprocessing.␊ - */␊ - requiresPreprocessing?: (boolean | string)␊ - /**␊ - * SQL expression. e.g. MyProperty='ABC'␊ - */␊ - sqlExpression?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents the correlation filter expression.␊ - */␊ - export interface CorrelationFilter {␊ - /**␊ - * Content type of the message.␊ - */␊ - contentType?: string␊ - /**␊ - * Identifier of the correlation.␊ - */␊ - correlationId?: string␊ - /**␊ - * Application specific label.␊ - */␊ - label?: string␊ - /**␊ - * Identifier of the message.␊ - */␊ - messageId?: string␊ - /**␊ - * dictionary object for custom filters␊ - */␊ - properties?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Address of the queue to reply to.␊ - */␊ - replyTo?: string␊ - /**␊ - * Session identifier to reply to.␊ - */␊ - replyToSessionId?: string␊ - /**␊ - * Value that indicates whether the rule action requires preprocessing.␊ - */␊ - requiresPreprocessing?: (boolean | string)␊ - /**␊ - * Session identifier.␊ - */␊ - sessionId?: string␊ - /**␊ - * Address to send to.␊ - */␊ - to?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents a filter which is a composition of an expression and an action that is executed in the pub/sub pipeline.␊ - */␊ - export interface SqlFilter {␊ - /**␊ - * This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20.␊ - */␊ - compatibilityLevel?: ((number & string) | string)␊ - /**␊ - * Value that indicates whether the rule action requires preprocessing.␊ - */␊ - requiresPreprocessing?: (boolean | string)␊ - /**␊ - * The SQL expression. e.g. MyProperty='ABC'␊ - */␊ - sqlExpression?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/topics/subscriptions/rules␊ - */␊ - export interface NamespacesTopicsSubscriptionsRules {␊ - apiVersion: "2017-04-01"␊ - /**␊ - * The rule name.␊ - */␊ - name: string␊ - /**␊ - * Description of Rule Resource.␊ - */␊ - properties: (Ruleproperties | string)␊ - type: "Microsoft.ServiceBus/namespaces/topics/subscriptions/rules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces␊ - */␊ - export interface Namespaces5 {␊ - apiVersion: "2018-01-01-preview"␊ - /**␊ - * Properties to configure Identity for Bring your Own Keys␊ - */␊ - identity?: (Identity23 | string)␊ - /**␊ - * The Geo-location where the resource lives␊ - */␊ - location: string␊ - /**␊ - * The namespace name.␊ - */␊ - name: string␊ - /**␊ - * Properties of the namespace.␊ - */␊ - properties: (SBNamespaceProperties1 | string)␊ - resources?: (NamespacesIpfilterrulesChildResource | NamespacesVirtualnetworkrulesChildResource | Namespaces_AuthorizationRulesChildResource5 | NamespacesNetworkRuleSetsChildResource1 | NamespacesPrivateEndpointConnectionsChildResource | NamespacesDisasterRecoveryConfigsChildResource1 | NamespacesQueuesChildResource2 | NamespacesTopicsChildResource2 | NamespacesMigrationConfigurationsChildResource1)[]␊ - /**␊ - * SKU of the namespace.␊ - */␊ - sku?: (SBSku1 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.ServiceBus/namespaces"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties to configure Identity for Bring your Own Keys␊ - */␊ - export interface Identity23 {␊ - /**␊ - * ObjectId from the KeyVault␊ - */␊ - principalId?: string␊ - /**␊ - * TenantId from the KeyVault␊ - */␊ - tenantId?: string␊ - /**␊ - * Enumerates the possible value Identity type, which currently supports only 'SystemAssigned'.␊ - */␊ - type?: ("SystemAssigned" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the namespace.␊ - */␊ - export interface SBNamespaceProperties1 {␊ - /**␊ - * Properties to configure Encryption␊ - */␊ - encryption?: (Encryption10 | string)␊ - /**␊ - * Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones.␊ - */␊ - zoneRedundant?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties to configure Encryption␊ - */␊ - export interface Encryption10 {␊ - /**␊ - * Enumerates the possible value of keySource for Encryption.␊ - */␊ - keySource?: ("Microsoft.KeyVault" | string)␊ - /**␊ - * Properties to configure keyVault Properties␊ - */␊ - keyVaultProperties?: (KeyVaultProperties17 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties to configure keyVault Properties␊ - */␊ - export interface KeyVaultProperties17 {␊ - /**␊ - * Name of the Key from KeyVault␊ - */␊ - keyName?: string␊ - /**␊ - * Uri of KeyVault␊ - */␊ - keyVaultUri?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/ipfilterrules␊ - */␊ - export interface NamespacesIpfilterrulesChildResource {␊ - apiVersion: "2018-01-01-preview"␊ - /**␊ - * The IP Filter Rule name.␊ - */␊ - name: string␊ - /**␊ - * Properties supplied to create or update IpFilterRules␊ - */␊ - properties: (IpFilterRuleProperties | string)␊ - type: "ipfilterrules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties supplied to create or update IpFilterRules␊ - */␊ - export interface IpFilterRuleProperties {␊ - /**␊ - * The IP Filter Action.␊ - */␊ - action?: (("Accept" | "Reject") | string)␊ - /**␊ - * IP Filter name␊ - */␊ - filterName?: string␊ - /**␊ - * IP Mask␊ - */␊ - ipMask?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/virtualnetworkrules␊ - */␊ - export interface NamespacesVirtualnetworkrulesChildResource {␊ - apiVersion: "2018-01-01-preview"␊ - /**␊ - * The Virtual Network Rule name.␊ - */␊ - name: string␊ - /**␊ - * Properties supplied to create or update VirtualNetworkRules␊ - */␊ - properties: (VirtualNetworkRuleProperties6 | string)␊ - type: "virtualnetworkrules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties supplied to create or update VirtualNetworkRules␊ - */␊ - export interface VirtualNetworkRuleProperties6 {␊ - /**␊ - * Resource ID of Virtual Network Subnet␊ - */␊ - virtualNetworkSubnetId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/AuthorizationRules␊ - */␊ - export interface Namespaces_AuthorizationRulesChildResource5 {␊ - apiVersion: "2018-01-01-preview"␊ - /**␊ - * The authorization rule name.␊ - */␊ - name: string␊ - /**␊ - * AuthorizationRule properties.␊ - */␊ - properties: (SBAuthorizationRuleProperties1 | string)␊ - type: "AuthorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AuthorizationRule properties.␊ - */␊ - export interface SBAuthorizationRuleProperties1 {␊ - /**␊ - * The rights associated with the rule.␊ - */␊ - rights: (("Manage" | "Send" | "Listen")[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/networkRuleSets␊ - */␊ - export interface NamespacesNetworkRuleSetsChildResource1 {␊ - apiVersion: "2018-01-01-preview"␊ - name: "default"␊ - /**␊ - * NetworkRuleSet properties␊ - */␊ - properties: (NetworkRuleSetProperties1 | string)␊ - type: "networkRuleSets"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NetworkRuleSet properties␊ - */␊ - export interface NetworkRuleSetProperties1 {␊ - /**␊ - * Default Action for Network Rule Set.␊ - */␊ - defaultAction?: (("Allow" | "Deny") | string)␊ - /**␊ - * List of IpRules␊ - */␊ - ipRules?: (NWRuleSetIpRules1[] | string)␊ - /**␊ - * List VirtualNetwork Rules␊ - */␊ - virtualNetworkRules?: (NWRuleSetVirtualNetworkRules1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of NetWorkRuleSet - IpRules resource.␊ - */␊ - export interface NWRuleSetIpRules1 {␊ - /**␊ - * The IP Filter Action.␊ - */␊ - action?: ("Allow" | string)␊ - /**␊ - * IP Mask␊ - */␊ - ipMask?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of VirtualNetworkRules - NetworkRules resource.␊ - */␊ - export interface NWRuleSetVirtualNetworkRules1 {␊ - /**␊ - * Value that indicates whether to ignore missing VNet Service Endpoint␊ - */␊ - ignoreMissingVnetServiceEndpoint?: (boolean | string)␊ - /**␊ - * Properties supplied for Subnet␊ - */␊ - subnet?: (Subnet39 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties supplied for Subnet␊ - */␊ - export interface Subnet39 {␊ - /**␊ - * Resource ID of Virtual Network Subnet␊ - */␊ - id: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/privateEndpointConnections␊ - */␊ - export interface NamespacesPrivateEndpointConnectionsChildResource {␊ - apiVersion: "2018-01-01-preview"␊ - /**␊ - * The PrivateEndpointConnection name␊ - */␊ - name: string␊ - /**␊ - * Properties of the private endpoint connection resource.␊ - */␊ - properties: (PrivateEndpointConnectionProperties18 | string)␊ - type: "privateEndpointConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the private endpoint connection resource.␊ - */␊ - export interface PrivateEndpointConnectionProperties18 {␊ - /**␊ - * PrivateEndpoint information.␊ - */␊ - privateEndpoint?: (PrivateEndpoint6 | string)␊ - /**␊ - * ConnectionState information.␊ - */␊ - privateLinkServiceConnectionState?: (ConnectionState | string)␊ - /**␊ - * Provisioning state of the Private Endpoint Connection.␊ - */␊ - provisioningState?: (("Creating" | "Updating" | "Deleting" | "Succeeded" | "Canceled" | "Failed") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * PrivateEndpoint information.␊ - */␊ - export interface PrivateEndpoint6 {␊ - /**␊ - * The ARM identifier for Private Endpoint.␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ConnectionState information.␊ - */␊ - export interface ConnectionState {␊ - /**␊ - * Description of the connection state.␊ - */␊ - description?: string␊ - /**␊ - * Status of the connection.␊ - */␊ - status?: (("Pending" | "Approved" | "Rejected" | "Disconnected") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/disasterRecoveryConfigs␊ - */␊ - export interface NamespacesDisasterRecoveryConfigsChildResource1 {␊ - apiVersion: "2018-01-01-preview"␊ - /**␊ - * The Disaster Recovery configuration name␊ - */␊ - name: string␊ - /**␊ - * Properties required to the Create Or Update Alias(Disaster Recovery configurations)␊ - */␊ - properties: (ArmDisasterRecoveryProperties1 | string)␊ - type: "disasterRecoveryConfigs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties required to the Create Or Update Alias(Disaster Recovery configurations)␊ - */␊ - export interface ArmDisasterRecoveryProperties1 {␊ - /**␊ - * Primary/Secondary eventhub namespace name, which is part of GEO DR pairing␊ - */␊ - alternateName?: string␊ - /**␊ - * ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing␊ - */␊ - partnerNamespace?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/queues␊ - */␊ - export interface NamespacesQueuesChildResource2 {␊ - apiVersion: "2018-01-01-preview"␊ - /**␊ - * The queue name.␊ - */␊ - name: string␊ - /**␊ - * The Queue Properties definition.␊ - */␊ - properties: (SBQueueProperties1 | string)␊ - type: "queues"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Queue Properties definition.␊ - */␊ - export interface SBQueueProperties1 {␊ - /**␊ - * ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes.␊ - */␊ - autoDeleteOnIdle?: string␊ - /**␊ - * A value that indicates whether this queue has dead letter support when a message expires.␊ - */␊ - deadLetteringOnMessageExpiration?: (boolean | string)␊ - /**␊ - * ISO 8601 default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.␊ - */␊ - defaultMessageTimeToLive?: string␊ - /**␊ - * ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.␊ - */␊ - duplicateDetectionHistoryTimeWindow?: string␊ - /**␊ - * Value that indicates whether server-side batched operations are enabled.␊ - */␊ - enableBatchedOperations?: (boolean | string)␊ - /**␊ - * A value that indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage.␊ - */␊ - enableExpress?: (boolean | string)␊ - /**␊ - * A value that indicates whether the queue is to be partitioned across multiple message brokers.␊ - */␊ - enablePartitioning?: (boolean | string)␊ - /**␊ - * Queue/Topic name to forward the Dead Letter message␊ - */␊ - forwardDeadLetteredMessagesTo?: string␊ - /**␊ - * Queue/Topic name to forward the messages␊ - */␊ - forwardTo?: string␊ - /**␊ - * ISO 8601 timespan duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute.␊ - */␊ - lockDuration?: string␊ - /**␊ - * The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10.␊ - */␊ - maxDeliveryCount?: (number | string)␊ - /**␊ - * The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024.␊ - */␊ - maxSizeInMegabytes?: (number | string)␊ - /**␊ - * A value indicating if this queue requires duplicate detection.␊ - */␊ - requiresDuplicateDetection?: (boolean | string)␊ - /**␊ - * A value that indicates whether the queue supports the concept of sessions.␊ - */␊ - requiresSession?: (boolean | string)␊ - /**␊ - * Enumerates the possible values for the status of a messaging entity.␊ - */␊ - status?: (("Active" | "Disabled" | "Restoring" | "SendDisabled" | "ReceiveDisabled" | "Creating" | "Deleting" | "Renaming" | "Unknown") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/topics␊ - */␊ - export interface NamespacesTopicsChildResource2 {␊ - apiVersion: "2018-01-01-preview"␊ - /**␊ - * The topic name.␊ - */␊ - name: string␊ - /**␊ - * The Topic Properties definition.␊ - */␊ - properties: (SBTopicProperties1 | string)␊ - type: "topics"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Topic Properties definition.␊ - */␊ - export interface SBTopicProperties1 {␊ - /**␊ - * ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.␊ - */␊ - autoDeleteOnIdle?: string␊ - /**␊ - * ISO 8601 Default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.␊ - */␊ - defaultMessageTimeToLive?: string␊ - /**␊ - * ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.␊ - */␊ - duplicateDetectionHistoryTimeWindow?: string␊ - /**␊ - * Value that indicates whether server-side batched operations are enabled.␊ - */␊ - enableBatchedOperations?: (boolean | string)␊ - /**␊ - * Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage.␊ - */␊ - enableExpress?: (boolean | string)␊ - /**␊ - * Value that indicates whether the topic to be partitioned across multiple message brokers is enabled.␊ - */␊ - enablePartitioning?: (boolean | string)␊ - /**␊ - * Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024.␊ - */␊ - maxSizeInMegabytes?: (number | string)␊ - /**␊ - * Value indicating if this topic requires duplicate detection.␊ - */␊ - requiresDuplicateDetection?: (boolean | string)␊ - /**␊ - * Enumerates the possible values for the status of a messaging entity.␊ - */␊ - status?: (("Active" | "Disabled" | "Restoring" | "SendDisabled" | "ReceiveDisabled" | "Creating" | "Deleting" | "Renaming" | "Unknown") | string)␊ - /**␊ - * Value that indicates whether the topic supports ordering.␊ - */␊ - supportOrdering?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/migrationConfigurations␊ - */␊ - export interface NamespacesMigrationConfigurationsChildResource1 {␊ - apiVersion: "2018-01-01-preview"␊ - /**␊ - * The configuration name. Should always be "$default".␊ - */␊ - name: "$default"␊ - /**␊ - * Properties required to the Create Migration Configuration␊ - */␊ - properties: (MigrationConfigPropertiesProperties1 | string)␊ - type: "migrationConfigurations"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties required to the Create Migration Configuration␊ - */␊ - export interface MigrationConfigPropertiesProperties1 {␊ - /**␊ - * Name to access Standard Namespace after migration␊ - */␊ - postMigrationName: string␊ - /**␊ - * Existing premium Namespace ARM Id name which has no entities, will be used for migration␊ - */␊ - targetNamespace: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of the namespace.␊ - */␊ - export interface SBSku1 {␊ - /**␊ - * The specified messaging units for the tier. For Premium tier, capacity are 1,2 and 4.␊ - */␊ - capacity?: (number | string)␊ - /**␊ - * Name of this SKU.␊ - */␊ - name: (("Basic" | "Standard" | "Premium") | string)␊ - /**␊ - * The billing tier of this particular SKU.␊ - */␊ - tier?: (("Basic" | "Standard" | "Premium") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/ipfilterrules␊ - */␊ - export interface NamespacesIpfilterrules {␊ - apiVersion: "2018-01-01-preview"␊ - /**␊ - * The IP Filter Rule name.␊ - */␊ - name: string␊ - /**␊ - * Properties supplied to create or update IpFilterRules␊ - */␊ - properties: (IpFilterRuleProperties | string)␊ - type: "Microsoft.ServiceBus/namespaces/ipfilterrules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/networkRuleSets␊ - */␊ - export interface NamespacesNetworkRuleSets1 {␊ - apiVersion: "2018-01-01-preview"␊ - name: string␊ - /**␊ - * NetworkRuleSet properties␊ - */␊ - properties: (NetworkRuleSetProperties1 | string)␊ - type: "Microsoft.ServiceBus/namespaces/networkRuleSets"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/virtualnetworkrules␊ - */␊ - export interface NamespacesVirtualnetworkrules {␊ - apiVersion: "2018-01-01-preview"␊ - /**␊ - * The Virtual Network Rule name.␊ - */␊ - name: string␊ - /**␊ - * Properties supplied to create or update VirtualNetworkRules␊ - */␊ - properties: (VirtualNetworkRuleProperties6 | string)␊ - type: "Microsoft.ServiceBus/namespaces/virtualnetworkrules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/privateEndpointConnections␊ - */␊ - export interface NamespacesPrivateEndpointConnections {␊ - apiVersion: "2018-01-01-preview"␊ - /**␊ - * The PrivateEndpointConnection name␊ - */␊ - name: string␊ - /**␊ - * Properties of the private endpoint connection resource.␊ - */␊ - properties: (PrivateEndpointConnectionProperties18 | string)␊ - type: "Microsoft.ServiceBus/namespaces/privateEndpointConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/queues␊ - */␊ - export interface NamespacesQueues2 {␊ - apiVersion: "2018-01-01-preview"␊ - /**␊ - * The queue name.␊ - */␊ - name: string␊ - /**␊ - * The Queue Properties definition.␊ - */␊ - properties: (SBQueueProperties1 | string)␊ - resources?: NamespacesQueuesAuthorizationRulesChildResource2[]␊ - type: "Microsoft.ServiceBus/namespaces/queues"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/queues/authorizationRules␊ - */␊ - export interface NamespacesQueuesAuthorizationRulesChildResource2 {␊ - apiVersion: "2018-01-01-preview"␊ - /**␊ - * The authorization rule name.␊ - */␊ - name: string␊ - /**␊ - * AuthorizationRule properties.␊ - */␊ - properties: (SBAuthorizationRuleProperties1 | string)␊ - type: "authorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/queues/authorizationRules␊ - */␊ - export interface NamespacesQueuesAuthorizationRules2 {␊ - apiVersion: "2018-01-01-preview"␊ - /**␊ - * The authorization rule name.␊ - */␊ - name: string␊ - /**␊ - * AuthorizationRule properties.␊ - */␊ - properties: (SBAuthorizationRuleProperties1 | string)␊ - type: "Microsoft.ServiceBus/namespaces/queues/authorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/topics␊ - */␊ - export interface NamespacesTopics2 {␊ - apiVersion: "2018-01-01-preview"␊ - /**␊ - * The topic name.␊ - */␊ - name: string␊ - /**␊ - * The Topic Properties definition.␊ - */␊ - properties: (SBTopicProperties1 | string)␊ - resources?: (NamespacesTopicsAuthorizationRulesChildResource2 | NamespacesTopicsSubscriptionsChildResource2)[]␊ - type: "Microsoft.ServiceBus/namespaces/topics"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/topics/authorizationRules␊ - */␊ - export interface NamespacesTopicsAuthorizationRulesChildResource2 {␊ - apiVersion: "2018-01-01-preview"␊ - /**␊ - * The authorization rule name.␊ - */␊ - name: string␊ - /**␊ - * AuthorizationRule properties.␊ - */␊ - properties: (SBAuthorizationRuleProperties1 | string)␊ - type: "authorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/topics/subscriptions␊ - */␊ - export interface NamespacesTopicsSubscriptionsChildResource2 {␊ - apiVersion: "2018-01-01-preview"␊ - /**␊ - * The subscription name.␊ - */␊ - name: string␊ - /**␊ - * Description of Subscription Resource.␊ - */␊ - properties: (SBSubscriptionProperties1 | string)␊ - type: "subscriptions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of Subscription Resource.␊ - */␊ - export interface SBSubscriptionProperties1 {␊ - /**␊ - * ISO 8061 timeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.␊ - */␊ - autoDeleteOnIdle?: string␊ - /**␊ - * Value that indicates whether a subscription has dead letter support on filter evaluation exceptions.␊ - */␊ - deadLetteringOnFilterEvaluationExceptions?: (boolean | string)␊ - /**␊ - * Value that indicates whether a subscription has dead letter support when a message expires.␊ - */␊ - deadLetteringOnMessageExpiration?: (boolean | string)␊ - /**␊ - * ISO 8061 Default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.␊ - */␊ - defaultMessageTimeToLive?: string␊ - /**␊ - * ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.␊ - */␊ - duplicateDetectionHistoryTimeWindow?: string␊ - /**␊ - * Value that indicates whether server-side batched operations are enabled.␊ - */␊ - enableBatchedOperations?: (boolean | string)␊ - /**␊ - * Queue/Topic name to forward the Dead Letter message␊ - */␊ - forwardDeadLetteredMessagesTo?: string␊ - /**␊ - * Queue/Topic name to forward the messages␊ - */␊ - forwardTo?: string␊ - /**␊ - * ISO 8061 lock duration timespan for the subscription. The default value is 1 minute.␊ - */␊ - lockDuration?: string␊ - /**␊ - * Number of maximum deliveries.␊ - */␊ - maxDeliveryCount?: (number | string)␊ - /**␊ - * Value indicating if a subscription supports the concept of sessions.␊ - */␊ - requiresSession?: (boolean | string)␊ - /**␊ - * Enumerates the possible values for the status of a messaging entity.␊ - */␊ - status?: (("Active" | "Disabled" | "Restoring" | "SendDisabled" | "ReceiveDisabled" | "Creating" | "Deleting" | "Renaming" | "Unknown") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/topics/authorizationRules␊ - */␊ - export interface NamespacesTopicsAuthorizationRules2 {␊ - apiVersion: "2018-01-01-preview"␊ - /**␊ - * The authorization rule name.␊ - */␊ - name: string␊ - /**␊ - * AuthorizationRule properties.␊ - */␊ - properties: (SBAuthorizationRuleProperties1 | string)␊ - type: "Microsoft.ServiceBus/namespaces/topics/authorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/topics/subscriptions␊ - */␊ - export interface NamespacesTopicsSubscriptions2 {␊ - apiVersion: "2018-01-01-preview"␊ - /**␊ - * The subscription name.␊ - */␊ - name: string␊ - /**␊ - * Description of Subscription Resource.␊ - */␊ - properties: (SBSubscriptionProperties1 | string)␊ - resources?: NamespacesTopicsSubscriptionsRulesChildResource1[]␊ - type: "Microsoft.ServiceBus/namespaces/topics/subscriptions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/topics/subscriptions/rules␊ - */␊ - export interface NamespacesTopicsSubscriptionsRulesChildResource1 {␊ - apiVersion: "2018-01-01-preview"␊ - /**␊ - * The rule name.␊ - */␊ - name: string␊ - /**␊ - * Description of Rule Resource.␊ - */␊ - properties: (Ruleproperties1 | string)␊ - type: "rules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of Rule Resource.␊ - */␊ - export interface Ruleproperties1 {␊ - /**␊ - * Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression.␊ - */␊ - action?: (Action1 | string)␊ - /**␊ - * Represents the correlation filter expression.␊ - */␊ - correlationFilter?: (CorrelationFilter1 | string)␊ - /**␊ - * Filter type that is evaluated against a BrokeredMessage.␊ - */␊ - filterType?: (("SqlFilter" | "CorrelationFilter") | string)␊ - /**␊ - * Represents a filter which is a composition of an expression and an action that is executed in the pub/sub pipeline.␊ - */␊ - sqlFilter?: (SqlFilter1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression.␊ - */␊ - export interface Action1 {␊ - /**␊ - * This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20.␊ - */␊ - compatibilityLevel?: (number | string)␊ - /**␊ - * Value that indicates whether the rule action requires preprocessing.␊ - */␊ - requiresPreprocessing?: (boolean | string)␊ - /**␊ - * SQL expression. e.g. MyProperty='ABC'␊ - */␊ - sqlExpression?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents the correlation filter expression.␊ - */␊ - export interface CorrelationFilter1 {␊ - /**␊ - * Content type of the message.␊ - */␊ - contentType?: string␊ - /**␊ - * Identifier of the correlation.␊ - */␊ - correlationId?: string␊ - /**␊ - * Application specific label.␊ - */␊ - label?: string␊ - /**␊ - * Identifier of the message.␊ - */␊ - messageId?: string␊ - /**␊ - * dictionary object for custom filters␊ - */␊ - properties?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Address of the queue to reply to.␊ - */␊ - replyTo?: string␊ - /**␊ - * Session identifier to reply to.␊ - */␊ - replyToSessionId?: string␊ - /**␊ - * Value that indicates whether the rule action requires preprocessing.␊ - */␊ - requiresPreprocessing?: (boolean | string)␊ - /**␊ - * Session identifier.␊ - */␊ - sessionId?: string␊ - /**␊ - * Address to send to.␊ - */␊ - to?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents a filter which is a composition of an expression and an action that is executed in the pub/sub pipeline.␊ - */␊ - export interface SqlFilter1 {␊ - /**␊ - * This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20.␊ - */␊ - compatibilityLevel?: ((number & string) | string)␊ - /**␊ - * Value that indicates whether the rule action requires preprocessing.␊ - */␊ - requiresPreprocessing?: (boolean | string)␊ - /**␊ - * The SQL expression. e.g. MyProperty='ABC'␊ - */␊ - sqlExpression?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/topics/subscriptions/rules␊ - */␊ - export interface NamespacesTopicsSubscriptionsRules1 {␊ - apiVersion: "2018-01-01-preview"␊ - /**␊ - * The rule name.␊ - */␊ - name: string␊ - /**␊ - * Description of Rule Resource.␊ - */␊ - properties: (Ruleproperties1 | string)␊ - type: "Microsoft.ServiceBus/namespaces/topics/subscriptions/rules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/disasterRecoveryConfigs␊ - */␊ - export interface NamespacesDisasterRecoveryConfigs1 {␊ - apiVersion: "2018-01-01-preview"␊ - /**␊ - * The Disaster Recovery configuration name␊ - */␊ - name: string␊ - /**␊ - * Properties required to the Create Or Update Alias(Disaster Recovery configurations)␊ - */␊ - properties: (ArmDisasterRecoveryProperties1 | string)␊ - type: "Microsoft.ServiceBus/namespaces/disasterRecoveryConfigs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/migrationConfigurations␊ - */␊ - export interface NamespacesMigrationConfigurations1 {␊ - apiVersion: "2018-01-01-preview"␊ - /**␊ - * The configuration name. Should always be "$default".␊ - */␊ - name: string␊ - /**␊ - * Properties required to the Create Migration Configuration␊ - */␊ - properties: (MigrationConfigPropertiesProperties1 | string)␊ - type: "Microsoft.ServiceBus/namespaces/migrationConfigurations"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ServiceBus/namespaces/AuthorizationRules␊ - */␊ - export interface Namespaces_AuthorizationRules5 {␊ - apiVersion: "2018-01-01-preview"␊ - /**␊ - * The authorization rule name.␊ - */␊ - name: string␊ - /**␊ - * AuthorizationRule properties.␊ - */␊ - properties: (SBAuthorizationRuleProperties1 | string)␊ - type: "Microsoft.ServiceBus/namespaces/AuthorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * microsoft.visualstudio/account␊ - */␊ - export interface Account {␊ - /**␊ - * The account name.␊ - */␊ - accountName?: string␊ - apiVersion: "2014-04-01-preview"␊ - /**␊ - * The Azure instance location.␊ - */␊ - location?: string␊ - /**␊ - * Name of the resource.␊ - */␊ - name: string␊ - /**␊ - * The type of the operation.␊ - */␊ - operationType?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The custom properties of the resource.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - resources?: (AccountExtensionChildResource | AccountProjectChildResource)[]␊ - /**␊ - * The custom tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "microsoft.visualstudio/account"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * microsoft.visualstudio/account/extension␊ - */␊ - export interface AccountExtensionChildResource {␊ - apiVersion: "2014-04-01-preview"␊ - /**␊ - * The Azure region of the Visual Studio account associated with this request (i.e 'southcentralus'.)␊ - */␊ - location?: string␊ - /**␊ - * The name of the extension.␊ - */␊ - name: string␊ - /**␊ - * Plan data for an extension resource.␊ - */␊ - plan?: (ExtensionResourcePlan | string)␊ - /**␊ - * A dictionary of extended properties. This property is currently unused.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * A dictionary of user-defined tags to be stored with the extension resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "extension"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Plan data for an extension resource.␊ - */␊ - export interface ExtensionResourcePlan {␊ - /**␊ - * Name of the plan.␊ - */␊ - name?: string␊ - /**␊ - * Product name.␊ - */␊ - product?: string␊ - /**␊ - * Optional: the promotion code associated with the plan.␊ - */␊ - promotionCode?: string␊ - /**␊ - * Name of the extension publisher.␊ - */␊ - publisher?: string␊ - /**␊ - * A string that uniquely identifies the plan version.␊ - */␊ - version?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * microsoft.visualstudio/account/project␊ - */␊ - export interface AccountProjectChildResource {␊ - apiVersion: "2014-04-01-preview"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * Name of the Team Services project.␊ - */␊ - name: string␊ - /**␊ - * Key/value pair of resource properties.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "project"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * microsoft.visualstudio/account/extension␊ - */␊ - export interface AccountExtension {␊ - apiVersion: "2014-04-01-preview"␊ - /**␊ - * The Azure region of the Visual Studio account associated with this request (i.e 'southcentralus'.)␊ - */␊ - location?: string␊ - /**␊ - * The name of the extension.␊ - */␊ - name: string␊ - /**␊ - * Plan data for an extension resource.␊ - */␊ - plan?: (ExtensionResourcePlan | string)␊ - /**␊ - * A dictionary of extended properties. This property is currently unused.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * A dictionary of user-defined tags to be stored with the extension resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "microsoft.visualstudio/account/extension"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * microsoft.visualstudio/account/project␊ - */␊ - export interface AccountProject {␊ - apiVersion: "2014-04-01-preview"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * Name of the Team Services project.␊ - */␊ - name: string␊ - /**␊ - * Key/value pair of resource properties.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "microsoft.visualstudio/account/project"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventHub/namespaces␊ - */␊ - export interface Namespaces6 {␊ - apiVersion: "2014-09-01"␊ - /**␊ - * Namespace location.␊ - */␊ - location: string␊ - /**␊ - * The Namespace name␊ - */␊ - name: string␊ - /**␊ - * Properties of the Namespace supplied for create or update Namespace operation␊ - */␊ - properties: (NamespaceProperties4 | string)␊ - resources?: (Namespaces_AuthorizationRulesChildResource6 | NamespacesEventhubsChildResource)[]␊ - /**␊ - * SKU parameters supplied to the create Namespace operation␊ - */␊ - sku?: (Sku63 | string)␊ - /**␊ - * Namespace tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.EventHub/namespaces"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Namespace supplied for create or update Namespace operation␊ - */␊ - export interface NamespaceProperties4 {␊ - /**␊ - * The time the Namespace was created.␊ - */␊ - createdAt?: string␊ - /**␊ - * Specifies whether this instance is enabled.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Provisioning state of the Namespace.␊ - */␊ - provisioningState?: string␊ - /**␊ - * Endpoint you can use to perform Service Bus operations.␊ - */␊ - serviceBusEndpoint?: string␊ - /**␊ - * State of the Namespace.␊ - */␊ - status?: (("Unknown" | "Creating" | "Created" | "Activating" | "Enabling" | "Active" | "Disabling" | "Disabled" | "SoftDeleting" | "SoftDeleted" | "Removing" | "Removed" | "Failed") | string)␊ - /**␊ - * The time the Namespace was updated.␊ - */␊ - updatedAt?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventHub/namespaces/AuthorizationRules␊ - */␊ - export interface Namespaces_AuthorizationRulesChildResource6 {␊ - apiVersion: "2014-09-01"␊ - /**␊ - * Data center location.␊ - */␊ - location?: string␊ - /**␊ - * The authorization rule name.␊ - */␊ - name: string␊ - /**␊ - * Properties supplied to create or update SharedAccessAuthorizationRule␊ - */␊ - properties: (SharedAccessAuthorizationRuleProperties4 | string)␊ - type: "AuthorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties supplied to create or update SharedAccessAuthorizationRule␊ - */␊ - export interface SharedAccessAuthorizationRuleProperties4 {␊ - /**␊ - * The rights associated with the rule.␊ - */␊ - rights: (("Manage" | "Send" | "Listen")[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventHub/namespaces/eventhubs␊ - */␊ - export interface NamespacesEventhubsChildResource {␊ - apiVersion: "2014-09-01"␊ - /**␊ - * Location of the resource.␊ - */␊ - location: string␊ - /**␊ - * The Event Hub name␊ - */␊ - name: string␊ - /**␊ - * Properties supplied to the Create Or Update Event Hub operation.␊ - */␊ - properties: (EventHubProperties4 | string)␊ - type: "eventhubs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties supplied to the Create Or Update Event Hub operation.␊ - */␊ - export interface EventHubProperties4 {␊ - /**␊ - * Number of days to retain the events for this Event Hub.␊ - */␊ - messageRetentionInDays?: (number | string)␊ - /**␊ - * Number of partitions created for the Event Hub.␊ - */␊ - partitionCount?: (number | string)␊ - /**␊ - * Enumerates the possible values for the status of the Event Hub.␊ - */␊ - status?: (("Active" | "Disabled" | "Restoring" | "SendDisabled" | "ReceiveDisabled" | "Creating" | "Deleting" | "Renaming" | "Unknown") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU parameters supplied to the create Namespace operation␊ - */␊ - export interface Sku63 {␊ - /**␊ - * The Event Hubs throughput units.␊ - */␊ - capacity?: (number | string)␊ - /**␊ - * Name of this SKU.␊ - */␊ - name?: (("Basic" | "Standard") | string)␊ - /**␊ - * The billing tier of this particular SKU.␊ - */␊ - tier: (("Basic" | "Standard" | "Premium") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventHub/namespaces/AuthorizationRules␊ - */␊ - export interface Namespaces_AuthorizationRules6 {␊ - apiVersion: "2014-09-01"␊ - /**␊ - * Data center location.␊ - */␊ - location?: string␊ - /**␊ - * The authorization rule name.␊ - */␊ - name: string␊ - /**␊ - * Properties supplied to create or update SharedAccessAuthorizationRule␊ - */␊ - properties: (SharedAccessAuthorizationRuleProperties4 | string)␊ - type: "Microsoft.EventHub/namespaces/AuthorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventHub/namespaces/eventhubs␊ - */␊ - export interface NamespacesEventhubs {␊ - apiVersion: "2014-09-01"␊ - /**␊ - * Location of the resource.␊ - */␊ - location: string␊ - /**␊ - * The Event Hub name␊ - */␊ - name: string␊ - /**␊ - * Properties supplied to the Create Or Update Event Hub operation.␊ - */␊ - properties: (EventHubProperties4 | string)␊ - resources?: (NamespacesEventhubsAuthorizationRulesChildResource | NamespacesEventhubsConsumergroupsChildResource)[]␊ - type: "Microsoft.EventHub/namespaces/eventhubs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventHub/namespaces/eventhubs/authorizationRules␊ - */␊ - export interface NamespacesEventhubsAuthorizationRulesChildResource {␊ - apiVersion: "2014-09-01"␊ - /**␊ - * Data center location.␊ - */␊ - location?: string␊ - /**␊ - * The authorization rule name.␊ - */␊ - name: string␊ - /**␊ - * Properties supplied to create or update SharedAccessAuthorizationRule␊ - */␊ - properties: (SharedAccessAuthorizationRuleProperties4 | string)␊ - type: "authorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventHub/namespaces/eventhubs/consumergroups␊ - */␊ - export interface NamespacesEventhubsConsumergroupsChildResource {␊ - apiVersion: "2014-09-01"␊ - /**␊ - * Location of the resource.␊ - */␊ - location: string␊ - /**␊ - * The consumer group name␊ - */␊ - name: string␊ - /**␊ - * Properties supplied to the Create Or Update Consumer Group operation.␊ - */␊ - properties: (ConsumerGroupProperties | string)␊ - type: "consumergroups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties supplied to the Create Or Update Consumer Group operation.␊ - */␊ - export interface ConsumerGroupProperties {␊ - /**␊ - * The user metadata.␊ - */␊ - userMetadata?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventHub/namespaces/eventhubs/authorizationRules␊ - */␊ - export interface NamespacesEventhubsAuthorizationRules {␊ - apiVersion: "2014-09-01"␊ - /**␊ - * Data center location.␊ - */␊ - location?: string␊ - /**␊ - * The authorization rule name.␊ - */␊ - name: string␊ - /**␊ - * Properties supplied to create or update SharedAccessAuthorizationRule␊ - */␊ - properties: (SharedAccessAuthorizationRuleProperties4 | string)␊ - type: "Microsoft.EventHub/namespaces/eventhubs/authorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventHub/namespaces/eventhubs/consumergroups␊ - */␊ - export interface NamespacesEventhubsConsumergroups {␊ - apiVersion: "2014-09-01"␊ - /**␊ - * Location of the resource.␊ - */␊ - location: string␊ - /**␊ - * The consumer group name␊ - */␊ - name: string␊ - /**␊ - * Properties supplied to the Create Or Update Consumer Group operation.␊ - */␊ - properties: (ConsumerGroupProperties | string)␊ - type: "Microsoft.EventHub/namespaces/eventhubs/consumergroups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventHub/namespaces␊ - */␊ - export interface Namespaces7 {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Namespace location.␊ - */␊ - location: string␊ - /**␊ - * The Namespace name␊ - */␊ - name: string␊ - /**␊ - * Properties of the Namespace supplied for create or update Namespace operation␊ - */␊ - properties: (NamespaceProperties5 | string)␊ - resources?: (Namespaces_AuthorizationRulesChildResource7 | NamespacesEventhubsChildResource1)[]␊ - /**␊ - * SKU parameters supplied to the create Namespace operation␊ - */␊ - sku?: (Sku64 | string)␊ - /**␊ - * Namespace tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.EventHub/namespaces"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Namespace supplied for create or update Namespace operation␊ - */␊ - export interface NamespaceProperties5 {␊ - /**␊ - * The time the Namespace was created.␊ - */␊ - createdAt?: string␊ - /**␊ - * Specifies whether this instance is enabled.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Provisioning state of the Namespace.␊ - */␊ - provisioningState?: string␊ - /**␊ - * Endpoint you can use to perform Service Bus operations.␊ - */␊ - serviceBusEndpoint?: string␊ - /**␊ - * State of the Namespace.␊ - */␊ - status?: (("Unknown" | "Creating" | "Created" | "Activating" | "Enabling" | "Active" | "Disabling" | "Disabled" | "SoftDeleting" | "SoftDeleted" | "Removing" | "Removed" | "Failed") | string)␊ - /**␊ - * The time the Namespace was updated.␊ - */␊ - updatedAt?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventHub/namespaces/AuthorizationRules␊ - */␊ - export interface Namespaces_AuthorizationRulesChildResource7 {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Data center location.␊ - */␊ - location?: string␊ - /**␊ - * The authorization rule name.␊ - */␊ - name: string␊ - /**␊ - * Properties supplied to create or update SharedAccessAuthorizationRule␊ - */␊ - properties: (SharedAccessAuthorizationRuleProperties5 | string)␊ - type: "AuthorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties supplied to create or update SharedAccessAuthorizationRule␊ - */␊ - export interface SharedAccessAuthorizationRuleProperties5 {␊ - /**␊ - * The rights associated with the rule.␊ - */␊ - rights: (("Manage" | "Send" | "Listen")[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventHub/namespaces/eventhubs␊ - */␊ - export interface NamespacesEventhubsChildResource1 {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Location of the resource.␊ - */␊ - location: string␊ - /**␊ - * The Event Hub name␊ - */␊ - name: string␊ - /**␊ - * Properties supplied to the Create Or Update Event Hub operation.␊ - */␊ - properties: (EventHubProperties5 | string)␊ - type: "eventhubs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties supplied to the Create Or Update Event Hub operation.␊ - */␊ - export interface EventHubProperties5 {␊ - /**␊ - * Number of days to retain the events for this Event Hub.␊ - */␊ - messageRetentionInDays?: (number | string)␊ - /**␊ - * Number of partitions created for the Event Hub.␊ - */␊ - partitionCount?: (number | string)␊ - /**␊ - * Enumerates the possible values for the status of the Event Hub.␊ - */␊ - status?: (("Active" | "Disabled" | "Restoring" | "SendDisabled" | "ReceiveDisabled" | "Creating" | "Deleting" | "Renaming" | "Unknown") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU parameters supplied to the create Namespace operation␊ - */␊ - export interface Sku64 {␊ - /**␊ - * The Event Hubs throughput units.␊ - */␊ - capacity?: (number | string)␊ - /**␊ - * Name of this SKU.␊ - */␊ - name?: (("Basic" | "Standard") | string)␊ - /**␊ - * The billing tier of this particular SKU.␊ - */␊ - tier: (("Basic" | "Standard" | "Premium") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventHub/namespaces/AuthorizationRules␊ - */␊ - export interface Namespaces_AuthorizationRules7 {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Data center location.␊ - */␊ - location?: string␊ - /**␊ - * The authorization rule name.␊ - */␊ - name: string␊ - /**␊ - * Properties supplied to create or update SharedAccessAuthorizationRule␊ - */␊ - properties: (SharedAccessAuthorizationRuleProperties5 | string)␊ - type: "Microsoft.EventHub/namespaces/AuthorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventHub/namespaces/eventhubs␊ - */␊ - export interface NamespacesEventhubs1 {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Location of the resource.␊ - */␊ - location: string␊ - /**␊ - * The Event Hub name␊ - */␊ - name: string␊ - /**␊ - * Properties supplied to the Create Or Update Event Hub operation.␊ - */␊ - properties: (EventHubProperties5 | string)␊ - resources?: (NamespacesEventhubsAuthorizationRulesChildResource1 | NamespacesEventhubsConsumergroupsChildResource1)[]␊ - type: "Microsoft.EventHub/namespaces/eventhubs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventHub/namespaces/eventhubs/authorizationRules␊ - */␊ - export interface NamespacesEventhubsAuthorizationRulesChildResource1 {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Data center location.␊ - */␊ - location?: string␊ - /**␊ - * The authorization rule name.␊ - */␊ - name: string␊ - /**␊ - * Properties supplied to create or update SharedAccessAuthorizationRule␊ - */␊ - properties: (SharedAccessAuthorizationRuleProperties5 | string)␊ - type: "authorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventHub/namespaces/eventhubs/consumergroups␊ - */␊ - export interface NamespacesEventhubsConsumergroupsChildResource1 {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Location of the resource.␊ - */␊ - location: string␊ - /**␊ - * The consumer group name␊ - */␊ - name: string␊ - /**␊ - * Properties supplied to the Create Or Update Consumer Group operation.␊ - */␊ - properties: (ConsumerGroupProperties1 | string)␊ - type: "consumergroups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties supplied to the Create Or Update Consumer Group operation.␊ - */␊ - export interface ConsumerGroupProperties1 {␊ - /**␊ - * The user metadata.␊ - */␊ - userMetadata?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventHub/namespaces/eventhubs/authorizationRules␊ - */␊ - export interface NamespacesEventhubsAuthorizationRules1 {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Data center location.␊ - */␊ - location?: string␊ - /**␊ - * The authorization rule name.␊ - */␊ - name: string␊ - /**␊ - * Properties supplied to create or update SharedAccessAuthorizationRule␊ - */␊ - properties: (SharedAccessAuthorizationRuleProperties5 | string)␊ - type: "Microsoft.EventHub/namespaces/eventhubs/authorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventHub/namespaces/eventhubs/consumergroups␊ - */␊ - export interface NamespacesEventhubsConsumergroups1 {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Location of the resource.␊ - */␊ - location: string␊ - /**␊ - * The consumer group name␊ - */␊ - name: string␊ - /**␊ - * Properties supplied to the Create Or Update Consumer Group operation.␊ - */␊ - properties: (ConsumerGroupProperties1 | string)␊ - type: "Microsoft.EventHub/namespaces/eventhubs/consumergroups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventHub/namespaces␊ - */␊ - export interface Namespaces8 {␊ - apiVersion: "2017-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * The Namespace name␊ - */␊ - name: string␊ - /**␊ - * Namespace properties supplied for create namespace operation.␊ - */␊ - properties: (EHNamespaceProperties | string)␊ - resources?: (NamespacesAuthorizationRulesChildResource | NamespacesNetworkRuleSetsChildResource2 | NamespacesDisasterRecoveryConfigsChildResource2 | NamespacesEventhubsChildResource2)[]␊ - /**␊ - * SKU parameters supplied to the create namespace operation␊ - */␊ - sku?: (Sku65 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.EventHub/namespaces"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Namespace properties supplied for create namespace operation.␊ - */␊ - export interface EHNamespaceProperties {␊ - /**␊ - * Value that indicates whether AutoInflate is enabled for eventhub namespace.␊ - */␊ - isAutoInflateEnabled?: (boolean | string)␊ - /**␊ - * Value that indicates whether Kafka is enabled for eventhub namespace.␊ - */␊ - kafkaEnabled?: (boolean | string)␊ - /**␊ - * Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true)␊ - */␊ - maximumThroughputUnits?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventHub/namespaces/authorizationRules␊ - */␊ - export interface NamespacesAuthorizationRulesChildResource {␊ - apiVersion: "2017-04-01"␊ - /**␊ - * The authorization rule name.␊ - */␊ - name: string␊ - /**␊ - * Properties supplied to create or update AuthorizationRule␊ - */␊ - properties: (AuthorizationRuleProperties | string)␊ - type: "authorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties supplied to create or update AuthorizationRule␊ - */␊ - export interface AuthorizationRuleProperties {␊ - /**␊ - * The rights associated with the rule.␊ - */␊ - rights: (("Manage" | "Send" | "Listen")[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventHub/namespaces/networkRuleSets␊ - */␊ - export interface NamespacesNetworkRuleSetsChildResource2 {␊ - apiVersion: "2017-04-01"␊ - name: "default"␊ - /**␊ - * NetworkRuleSet properties␊ - */␊ - properties: (NetworkRuleSetProperties2 | string)␊ - type: "networkRuleSets"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NetworkRuleSet properties␊ - */␊ - export interface NetworkRuleSetProperties2 {␊ - /**␊ - * Default Action for Network Rule Set.␊ - */␊ - defaultAction?: (("Allow" | "Deny") | string)␊ - /**␊ - * List of IpRules␊ - */␊ - ipRules?: (NWRuleSetIpRules2[] | string)␊ - /**␊ - * List VirtualNetwork Rules␊ - */␊ - virtualNetworkRules?: (NWRuleSetVirtualNetworkRules2[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of NetWorkRuleSet - IpRules resource.␊ - */␊ - export interface NWRuleSetIpRules2 {␊ - /**␊ - * The IP Filter Action.␊ - */␊ - action?: ("Allow" | string)␊ - /**␊ - * IP Mask␊ - */␊ - ipMask?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of VirtualNetworkRules - NetworkRules resource.␊ - */␊ - export interface NWRuleSetVirtualNetworkRules2 {␊ - /**␊ - * Value that indicates whether to ignore missing VNet Service Endpoint␊ - */␊ - ignoreMissingVnetServiceEndpoint?: (boolean | string)␊ - /**␊ - * Properties supplied for Subnet␊ - */␊ - subnet?: (Subnet40 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties supplied for Subnet␊ - */␊ - export interface Subnet40 {␊ - /**␊ - * Resource ID of Virtual Network Subnet␊ - */␊ - id: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventHub/namespaces/disasterRecoveryConfigs␊ - */␊ - export interface NamespacesDisasterRecoveryConfigsChildResource2 {␊ - apiVersion: "2017-04-01"␊ - /**␊ - * The Disaster Recovery configuration name␊ - */␊ - name: string␊ - /**␊ - * Properties required to the Create Or Update Alias(Disaster Recovery configurations)␊ - */␊ - properties: (ArmDisasterRecoveryProperties2 | string)␊ - type: "disasterRecoveryConfigs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties required to the Create Or Update Alias(Disaster Recovery configurations)␊ - */␊ - export interface ArmDisasterRecoveryProperties2 {␊ - /**␊ - * Alternate name specified when alias and namespace names are same.␊ - */␊ - alternateName?: string␊ - /**␊ - * ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing␊ - */␊ - partnerNamespace?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventHub/namespaces/eventhubs␊ - */␊ - export interface NamespacesEventhubsChildResource2 {␊ - apiVersion: "2017-04-01"␊ - /**␊ - * The Event Hub name␊ - */␊ - name: string␊ - /**␊ - * Properties supplied to the Create Or Update Event Hub operation.␊ - */␊ - properties: (EventhubProperties | string)␊ - type: "eventhubs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties supplied to the Create Or Update Event Hub operation.␊ - */␊ - export interface EventhubProperties {␊ - /**␊ - * Properties to configure capture description for eventhub␊ - */␊ - captureDescription?: (CaptureDescription | string)␊ - /**␊ - * Number of days to retain the events for this Event Hub, value should be 1 to 7 days␊ - */␊ - messageRetentionInDays?: (number | string)␊ - /**␊ - * Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions.␊ - */␊ - partitionCount?: (number | string)␊ - /**␊ - * Enumerates the possible values for the status of the Event Hub.␊ - */␊ - status?: (("Active" | "Disabled" | "Restoring" | "SendDisabled" | "ReceiveDisabled" | "Creating" | "Deleting" | "Renaming" | "Unknown") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties to configure capture description for eventhub␊ - */␊ - export interface CaptureDescription {␊ - /**␊ - * Capture storage details for capture description␊ - */␊ - destination?: (Destination | string)␊ - /**␊ - * A value that indicates whether capture description is enabled. ␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Enumerates the possible values for the encoding format of capture description. Note: 'AvroDeflate' will be deprecated in New API Version.␊ - */␊ - encoding?: (("Avro" | "AvroDeflate") | string)␊ - /**␊ - * The time window allows you to set the frequency with which the capture to Azure Blobs will happen, value should between 60 to 900 seconds␊ - */␊ - intervalInSeconds?: (number | string)␊ - /**␊ - * The size window defines the amount of data built up in your Event Hub before an capture operation, value should be between 10485760 to 524288000 bytes␊ - */␊ - sizeLimitInBytes?: (number | string)␊ - /**␊ - * A value that indicates whether to Skip Empty Archives␊ - */␊ - skipEmptyArchives?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Capture storage details for capture description␊ - */␊ - export interface Destination {␊ - /**␊ - * Name for capture destination␊ - */␊ - name?: string␊ - /**␊ - * Properties describing the storage account, blob container and archive name format for capture destination␊ - */␊ - properties?: (DestinationProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties describing the storage account, blob container and archive name format for capture destination␊ - */␊ - export interface DestinationProperties {␊ - /**␊ - * Blob naming convention for archive, e.g. {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Here all the parameters (Namespace,EventHub .. etc) are mandatory irrespective of order␊ - */␊ - archiveNameFormat?: string␊ - /**␊ - * Blob container Name␊ - */␊ - blobContainer?: string␊ - /**␊ - * Resource id of the storage account to be used to create the blobs␊ - */␊ - storageAccountResourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU parameters supplied to the create namespace operation␊ - */␊ - export interface Sku65 {␊ - /**␊ - * The Event Hubs throughput units, value should be 0 to 20 throughput units.␊ - */␊ - capacity?: (number | string)␊ - /**␊ - * Name of this SKU.␊ - */␊ - name: (("Basic" | "Standard") | string)␊ - /**␊ - * The billing tier of this particular SKU.␊ - */␊ - tier?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventHub/namespaces/authorizationRules␊ - */␊ - export interface NamespacesAuthorizationRules {␊ - apiVersion: "2017-04-01"␊ - /**␊ - * The authorization rule name.␊ - */␊ - name: string␊ - /**␊ - * Properties supplied to create or update AuthorizationRule␊ - */␊ - properties: (AuthorizationRuleProperties | string)␊ - type: "Microsoft.EventHub/namespaces/authorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventHub/namespaces/disasterRecoveryConfigs␊ - */␊ - export interface NamespacesDisasterRecoveryConfigs2 {␊ - apiVersion: "2017-04-01"␊ - /**␊ - * The Disaster Recovery configuration name␊ - */␊ - name: string␊ - /**␊ - * Properties required to the Create Or Update Alias(Disaster Recovery configurations)␊ - */␊ - properties: (ArmDisasterRecoveryProperties2 | string)␊ - type: "Microsoft.EventHub/namespaces/disasterRecoveryConfigs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventHub/namespaces/eventhubs␊ - */␊ - export interface NamespacesEventhubs2 {␊ - apiVersion: "2017-04-01"␊ - /**␊ - * The Event Hub name␊ - */␊ - name: string␊ - /**␊ - * Properties supplied to the Create Or Update Event Hub operation.␊ - */␊ - properties: (EventhubProperties | string)␊ - resources?: (NamespacesEventhubsAuthorizationRulesChildResource2 | NamespacesEventhubsConsumergroupsChildResource2)[]␊ - type: "Microsoft.EventHub/namespaces/eventhubs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventHub/namespaces/eventhubs/authorizationRules␊ - */␊ - export interface NamespacesEventhubsAuthorizationRulesChildResource2 {␊ - apiVersion: "2017-04-01"␊ - /**␊ - * The authorization rule name.␊ - */␊ - name: string␊ - /**␊ - * Properties supplied to create or update AuthorizationRule␊ - */␊ - properties: (AuthorizationRuleProperties | string)␊ - type: "authorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventHub/namespaces/eventhubs/consumergroups␊ - */␊ - export interface NamespacesEventhubsConsumergroupsChildResource2 {␊ - apiVersion: "2017-04-01"␊ - /**␊ - * The consumer group name␊ - */␊ - name: string␊ - /**␊ - * Single item in List or Get Consumer group operation␊ - */␊ - properties: (ConsumerGroupProperties2 | string)␊ - type: "consumergroups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Single item in List or Get Consumer group operation␊ - */␊ - export interface ConsumerGroupProperties2 {␊ - /**␊ - * User Metadata is a placeholder to store user-defined string data with maximum length 1024. e.g. it can be used to store descriptive data, such as list of teams and their contact information also user-defined configuration settings can be stored.␊ - */␊ - userMetadata?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventHub/namespaces/eventhubs/authorizationRules␊ - */␊ - export interface NamespacesEventhubsAuthorizationRules2 {␊ - apiVersion: "2017-04-01"␊ - /**␊ - * The authorization rule name.␊ - */␊ - name: string␊ - /**␊ - * Properties supplied to create or update AuthorizationRule␊ - */␊ - properties: (AuthorizationRuleProperties | string)␊ - type: "Microsoft.EventHub/namespaces/eventhubs/authorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventHub/namespaces/eventhubs/consumergroups␊ - */␊ - export interface NamespacesEventhubsConsumergroups2 {␊ - apiVersion: "2017-04-01"␊ - /**␊ - * The consumer group name␊ - */␊ - name: string␊ - /**␊ - * Single item in List or Get Consumer group operation␊ - */␊ - properties: (ConsumerGroupProperties2 | string)␊ - type: "Microsoft.EventHub/namespaces/eventhubs/consumergroups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventHub/namespaces/networkRuleSets␊ - */␊ - export interface NamespacesNetworkRuleSets2 {␊ - apiVersion: "2017-04-01"␊ - name: string␊ - /**␊ - * NetworkRuleSet properties␊ - */␊ - properties: (NetworkRuleSetProperties2 | string)␊ - type: "Microsoft.EventHub/namespaces/networkRuleSets"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventHub/clusters␊ - */␊ - export interface Clusters18 {␊ - apiVersion: "2018-01-01-preview"␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * The name of the Event Hubs Cluster.␊ - */␊ - name: string␊ - /**␊ - * Event Hubs Cluster properties supplied in responses in List or Get operations.␊ - */␊ - properties: (ClusterProperties14 | string)␊ - /**␊ - * SKU parameters particular to a cluster instance.␊ - */␊ - sku?: (ClusterSku | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.EventHub/clusters"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Event Hubs Cluster properties supplied in responses in List or Get operations.␊ - */␊ - export interface ClusterProperties14 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU parameters particular to a cluster instance.␊ - */␊ - export interface ClusterSku {␊ - /**␊ - * The quantity of Event Hubs Cluster Capacity Units contained in this cluster.␊ - */␊ - capacity?: (number | string)␊ - /**␊ - * Name of this SKU.␊ - */␊ - name: ("Dedicated" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventHub/namespaces␊ - */␊ - export interface Namespaces9 {␊ - apiVersion: "2018-01-01-preview"␊ - /**␊ - * Properties to configure Identity for Bring your Own Keys␊ - */␊ - identity?: (Identity24 | string)␊ - /**␊ - * Resource location.␊ - */␊ - location?: string␊ - /**␊ - * The Namespace name␊ - */␊ - name: string␊ - /**␊ - * Namespace properties supplied for create namespace operation.␊ - */␊ - properties: (EHNamespaceProperties1 | string)␊ - resources?: (NamespacesIpfilterrulesChildResource1 | NamespacesVirtualnetworkrulesChildResource1 | NamespacesNetworkRuleSetsChildResource3 | NamespacesAuthorizationRulesChildResource1 | NamespacesPrivateEndpointConnectionsChildResource1 | NamespacesDisasterRecoveryConfigsChildResource3 | NamespacesEventhubsChildResource3)[]␊ - /**␊ - * SKU parameters supplied to the create namespace operation␊ - */␊ - sku?: (Sku66 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.EventHub/namespaces"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties to configure Identity for Bring your Own Keys␊ - */␊ - export interface Identity24 {␊ - /**␊ - * ObjectId from the KeyVault␊ - */␊ - principalId?: string␊ - /**␊ - * TenantId from the KeyVault␊ - */␊ - tenantId?: string␊ - /**␊ - * Enumerates the possible value Identity type, which currently supports only 'SystemAssigned'.␊ - */␊ - type?: ("SystemAssigned" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Namespace properties supplied for create namespace operation.␊ - */␊ - export interface EHNamespaceProperties1 {␊ - /**␊ - * Cluster ARM ID of the Namespace.␊ - */␊ - clusterArmId?: string␊ - /**␊ - * Properties to configure Encryption␊ - */␊ - encryption?: (Encryption11 | string)␊ - /**␊ - * Value that indicates whether AutoInflate is enabled for eventhub namespace.␊ - */␊ - isAutoInflateEnabled?: (boolean | string)␊ - /**␊ - * Value that indicates whether Kafka is enabled for eventhub namespace.␊ - */␊ - kafkaEnabled?: (boolean | string)␊ - /**␊ - * Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true)␊ - */␊ - maximumThroughputUnits?: (number | string)␊ - /**␊ - * Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones.␊ - */␊ - zoneRedundant?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties to configure Encryption␊ - */␊ - export interface Encryption11 {␊ - /**␊ - * Enumerates the possible value of keySource for Encryption.␊ - */␊ - keySource?: ("Microsoft.KeyVault" | string)␊ - /**␊ - * Properties of KeyVault␊ - */␊ - keyVaultProperties?: (KeyVaultProperties18[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties to configure keyVault Properties␊ - */␊ - export interface KeyVaultProperties18 {␊ - /**␊ - * Name of the Key from KeyVault␊ - */␊ - keyName?: string␊ - /**␊ - * Uri of KeyVault␊ - */␊ - keyVaultUri?: string␊ - /**␊ - * Key Version␊ - */␊ - keyVersion?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventHub/namespaces/ipfilterrules␊ - */␊ - export interface NamespacesIpfilterrulesChildResource1 {␊ - apiVersion: "2018-01-01-preview"␊ - /**␊ - * The IP Filter Rule name.␊ - */␊ - name: string␊ - /**␊ - * Properties supplied to create or update IpFilterRules␊ - */␊ - properties: (IpFilterRuleProperties1 | string)␊ - type: "ipfilterrules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties supplied to create or update IpFilterRules␊ - */␊ - export interface IpFilterRuleProperties1 {␊ - /**␊ - * The IP Filter Action.␊ - */␊ - action?: (("Accept" | "Reject") | string)␊ - /**␊ - * IP Filter name␊ - */␊ - filterName?: string␊ - /**␊ - * IP Mask␊ - */␊ - ipMask?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventHub/namespaces/virtualnetworkrules␊ - */␊ - export interface NamespacesVirtualnetworkrulesChildResource1 {␊ - apiVersion: "2018-01-01-preview"␊ - /**␊ - * The Virtual Network Rule name.␊ - */␊ - name: string␊ - /**␊ - * Properties supplied to create or update VirtualNetworkRules␊ - */␊ - properties: (VirtualNetworkRuleProperties7 | string)␊ - type: "virtualnetworkrules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties supplied to create or update VirtualNetworkRules␊ - */␊ - export interface VirtualNetworkRuleProperties7 {␊ - /**␊ - * ARM ID of Virtual Network Subnet␊ - */␊ - virtualNetworkSubnetId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventHub/namespaces/networkRuleSets␊ - */␊ - export interface NamespacesNetworkRuleSetsChildResource3 {␊ - apiVersion: "2018-01-01-preview"␊ - name: "default"␊ - /**␊ - * NetworkRuleSet properties␊ - */␊ - properties: (NetworkRuleSetProperties3 | string)␊ - type: "networkRuleSets"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NetworkRuleSet properties␊ - */␊ - export interface NetworkRuleSetProperties3 {␊ - /**␊ - * Default Action for Network Rule Set.␊ - */␊ - defaultAction?: (("Allow" | "Deny") | string)␊ - /**␊ - * List of IpRules␊ - */␊ - ipRules?: (NWRuleSetIpRules3[] | string)␊ - /**␊ - * Value that indicates whether Trusted Service Access is Enabled or not.␊ - */␊ - trustedServiceAccessEnabled?: (boolean | string)␊ - /**␊ - * List VirtualNetwork Rules␊ - */␊ - virtualNetworkRules?: (NWRuleSetVirtualNetworkRules3[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The response from the List namespace operation.␊ - */␊ - export interface NWRuleSetIpRules3 {␊ - /**␊ - * The IP Filter Action.␊ - */␊ - action?: ("Allow" | string)␊ - /**␊ - * IP Mask␊ - */␊ - ipMask?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The response from the List namespace operation.␊ - */␊ - export interface NWRuleSetVirtualNetworkRules3 {␊ - /**␊ - * Value that indicates whether to ignore missing Vnet Service Endpoint␊ - */␊ - ignoreMissingVnetServiceEndpoint?: (boolean | string)␊ - /**␊ - * Properties supplied for Subnet␊ - */␊ - subnet?: (Subnet41 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties supplied for Subnet␊ - */␊ - export interface Subnet41 {␊ - /**␊ - * Resource ID of Virtual Network Subnet␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventHub/namespaces/authorizationRules␊ - */␊ - export interface NamespacesAuthorizationRulesChildResource1 {␊ - apiVersion: "2018-01-01-preview"␊ - /**␊ - * The authorization rule name.␊ - */␊ - name: string␊ - /**␊ - * Properties supplied to create or update AuthorizationRule␊ - */␊ - properties: (AuthorizationRuleProperties1 | string)␊ - type: "authorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties supplied to create or update AuthorizationRule␊ - */␊ - export interface AuthorizationRuleProperties1 {␊ - /**␊ - * The rights associated with the rule.␊ - */␊ - rights: (("Manage" | "Send" | "Listen")[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventHub/namespaces/privateEndpointConnections␊ - */␊ - export interface NamespacesPrivateEndpointConnectionsChildResource1 {␊ - apiVersion: "2018-01-01-preview"␊ - /**␊ - * The PrivateEndpointConnection name␊ - */␊ - name: string␊ - /**␊ - * Properties of the private endpoint connection resource.␊ - */␊ - properties: (PrivateEndpointConnectionProperties19 | string)␊ - type: "privateEndpointConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the private endpoint connection resource.␊ - */␊ - export interface PrivateEndpointConnectionProperties19 {␊ - /**␊ - * PrivateEndpoint information.␊ - */␊ - privateEndpoint?: (PrivateEndpoint7 | string)␊ - /**␊ - * ConnectionState information.␊ - */␊ - privateLinkServiceConnectionState?: (ConnectionState1 | string)␊ - /**␊ - * Provisioning state of the Private Endpoint Connection.␊ - */␊ - provisioningState?: (("Creating" | "Updating" | "Deleting" | "Succeeded" | "Canceled" | "Failed") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * PrivateEndpoint information.␊ - */␊ - export interface PrivateEndpoint7 {␊ - /**␊ - * The ARM identifier for Private Endpoint.␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ConnectionState information.␊ - */␊ - export interface ConnectionState1 {␊ - /**␊ - * Description of the connection state.␊ - */␊ - description?: string␊ - /**␊ - * Status of the connection.␊ - */␊ - status?: (("Pending" | "Approved" | "Rejected" | "Disconnected") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventHub/namespaces/disasterRecoveryConfigs␊ - */␊ - export interface NamespacesDisasterRecoveryConfigsChildResource3 {␊ - apiVersion: "2018-01-01-preview"␊ - /**␊ - * The Disaster Recovery configuration name␊ - */␊ - name: string␊ - /**␊ - * Properties required to the Create Or Update Alias(Disaster Recovery configurations)␊ - */␊ - properties: (ArmDisasterRecoveryProperties3 | string)␊ - type: "disasterRecoveryConfigs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties required to the Create Or Update Alias(Disaster Recovery configurations)␊ - */␊ - export interface ArmDisasterRecoveryProperties3 {␊ - /**␊ - * Alternate name specified when alias and namespace names are same.␊ - */␊ - alternateName?: string␊ - /**␊ - * ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing␊ - */␊ - partnerNamespace?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventHub/namespaces/eventhubs␊ - */␊ - export interface NamespacesEventhubsChildResource3 {␊ - apiVersion: "2018-01-01-preview"␊ - /**␊ - * The Event Hub name␊ - */␊ - name: string␊ - /**␊ - * Properties supplied to the Create Or Update Event Hub operation.␊ - */␊ - properties: (EventhubProperties1 | string)␊ - type: "eventhubs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties supplied to the Create Or Update Event Hub operation.␊ - */␊ - export interface EventhubProperties1 {␊ - /**␊ - * Properties to configure capture description for eventhub␊ - */␊ - captureDescription?: (CaptureDescription1 | string)␊ - /**␊ - * Number of days to retain the events for this Event Hub, value should be 1 to 7 days␊ - */␊ - messageRetentionInDays?: (number | string)␊ - /**␊ - * Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions.␊ - */␊ - partitionCount?: (number | string)␊ - /**␊ - * Enumerates the possible values for the status of the Event Hub.␊ - */␊ - status?: (("Active" | "Disabled" | "Restoring" | "SendDisabled" | "ReceiveDisabled" | "Creating" | "Deleting" | "Renaming" | "Unknown") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties to configure capture description for eventhub␊ - */␊ - export interface CaptureDescription1 {␊ - /**␊ - * Capture storage details for capture description␊ - */␊ - destination?: (Destination1 | string)␊ - /**␊ - * A value that indicates whether capture description is enabled. ␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Enumerates the possible values for the encoding format of capture description. Note: 'AvroDeflate' will be deprecated in New API Version.␊ - */␊ - encoding?: (("Avro" | "AvroDeflate") | string)␊ - /**␊ - * The time window allows you to set the frequency with which the capture to Azure Blobs will happen, value should between 60 to 900 seconds␊ - */␊ - intervalInSeconds?: (number | string)␊ - /**␊ - * The size window defines the amount of data built up in your Event Hub before an capture operation, value should be between 10485760 to 524288000 bytes␊ - */␊ - sizeLimitInBytes?: (number | string)␊ - /**␊ - * A value that indicates whether to Skip Empty Archives␊ - */␊ - skipEmptyArchives?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Capture storage details for capture description␊ - */␊ - export interface Destination1 {␊ - /**␊ - * Name for capture destination␊ - */␊ - name?: string␊ - /**␊ - * Properties describing the storage account, blob container and archive name format for capture destination␊ - */␊ - properties?: (DestinationProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties describing the storage account, blob container and archive name format for capture destination␊ - */␊ - export interface DestinationProperties1 {␊ - /**␊ - * Blob naming convention for archive, e.g. {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Here all the parameters (Namespace,EventHub .. etc) are mandatory irrespective of order␊ - */␊ - archiveNameFormat?: string␊ - /**␊ - * Blob container Name␊ - */␊ - blobContainer?: string␊ - /**␊ - * Resource id of the storage account to be used to create the blobs␊ - */␊ - storageAccountResourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU parameters supplied to the create namespace operation␊ - */␊ - export interface Sku66 {␊ - /**␊ - * The Event Hubs throughput units, value should be 0 to 20 throughput units.␊ - */␊ - capacity?: (number | string)␊ - /**␊ - * Name of this SKU.␊ - */␊ - name: (("Basic" | "Standard") | string)␊ - /**␊ - * The billing tier of this particular SKU.␊ - */␊ - tier?: (("Basic" | "Standard") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventHub/namespaces/ipfilterrules␊ - */␊ - export interface NamespacesIpfilterrules1 {␊ - apiVersion: "2018-01-01-preview"␊ - /**␊ - * The IP Filter Rule name.␊ - */␊ - name: string␊ - /**␊ - * Properties supplied to create or update IpFilterRules␊ - */␊ - properties: (IpFilterRuleProperties1 | string)␊ - type: "Microsoft.EventHub/namespaces/ipfilterrules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventHub/namespaces/networkRuleSets␊ - */␊ - export interface NamespacesNetworkRuleSets3 {␊ - apiVersion: "2018-01-01-preview"␊ - name: string␊ - /**␊ - * NetworkRuleSet properties␊ - */␊ - properties: (NetworkRuleSetProperties3 | string)␊ - type: "Microsoft.EventHub/namespaces/networkRuleSets"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventHub/namespaces/virtualnetworkrules␊ - */␊ - export interface NamespacesVirtualnetworkrules1 {␊ - apiVersion: "2018-01-01-preview"␊ - /**␊ - * The Virtual Network Rule name.␊ - */␊ - name: string␊ - /**␊ - * Properties supplied to create or update VirtualNetworkRules␊ - */␊ - properties: (VirtualNetworkRuleProperties7 | string)␊ - type: "Microsoft.EventHub/namespaces/virtualnetworkrules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Relay/namespaces␊ - */␊ - export interface Namespaces10 {␊ - apiVersion: "2016-07-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The Namespace Name␊ - */␊ - name: string␊ - /**␊ - * Properties of the Namespace.␊ - */␊ - properties: (RelayNamespaceProperties | string)␊ - resources?: (Namespaces_AuthorizationRulesChildResource8 | Namespaces_HybridConnectionsChildResource | Namespaces_WcfRelaysChildResource)[]␊ - /**␊ - * Sku of the Namespace.␊ - */␊ - sku?: (Sku67 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Relay/namespaces"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Namespace.␊ - */␊ - export interface RelayNamespaceProperties {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Relay/namespaces/AuthorizationRules␊ - */␊ - export interface Namespaces_AuthorizationRulesChildResource8 {␊ - apiVersion: "2016-07-01"␊ - /**␊ - * The authorizationRule name.␊ - */␊ - name: string␊ - /**␊ - * AuthorizationRule properties.␊ - */␊ - properties: (AuthorizationRuleProperties2 | string)␊ - type: "AuthorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AuthorizationRule properties.␊ - */␊ - export interface AuthorizationRuleProperties2 {␊ - /**␊ - * The rights associated with the rule.␊ - */␊ - rights: (("Manage" | "Send" | "Listen")[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Relay/namespaces/HybridConnections␊ - */␊ - export interface Namespaces_HybridConnectionsChildResource {␊ - apiVersion: "2016-07-01"␊ - /**␊ - * The hybrid connection name.␊ - */␊ - name: string␊ - /**␊ - * Properties of the HybridConnection.␊ - */␊ - properties: (HybridConnectionProperties | string)␊ - type: "HybridConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the HybridConnection.␊ - */␊ - export interface HybridConnectionProperties {␊ - /**␊ - * true if client authorization is needed for this HybridConnection; otherwise, false.␊ - */␊ - requiresClientAuthorization?: (boolean | string)␊ - /**␊ - * usermetadata is a placeholder to store user-defined string data for the HybridConnection endpoint.e.g. it can be used to store descriptive data, such as list of teams and their contact information also user-defined configuration settings can be stored.␊ - */␊ - userMetadata?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Relay/namespaces/WcfRelays␊ - */␊ - export interface Namespaces_WcfRelaysChildResource {␊ - apiVersion: "2016-07-01"␊ - /**␊ - * The relay name␊ - */␊ - name: string␊ - /**␊ - * Properties of the WcfRelay Properties.␊ - */␊ - properties: (WcfRelayProperties | string)␊ - type: "WcfRelays"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the WcfRelay Properties.␊ - */␊ - export interface WcfRelayProperties {␊ - /**␊ - * WCFRelay Type.␊ - */␊ - relayType?: (("NetTcp" | "Http") | string)␊ - /**␊ - * true if client authorization is needed for this relay; otherwise, false.␊ - */␊ - requiresClientAuthorization?: (boolean | string)␊ - /**␊ - * true if transport security is needed for this relay; otherwise, false.␊ - */␊ - requiresTransportSecurity?: (boolean | string)␊ - /**␊ - * usermetadata is a placeholder to store user-defined string data for the HybridConnection endpoint.e.g. it can be used to store descriptive data, such as list of teams and their contact information also user-defined configuration settings can be stored.␊ - */␊ - userMetadata?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Sku of the Namespace.␊ - */␊ - export interface Sku67 {␊ - /**␊ - * Name of this Sku␊ - */␊ - name: ("Standard" | string)␊ - /**␊ - * The tier of this particular SKU␊ - */␊ - tier: ("Standard" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Relay/namespaces/AuthorizationRules␊ - */␊ - export interface Namespaces_AuthorizationRules8 {␊ - apiVersion: "2016-07-01"␊ - /**␊ - * The authorizationRule name.␊ - */␊ - name: string␊ - /**␊ - * AuthorizationRule properties.␊ - */␊ - properties: (AuthorizationRuleProperties2 | string)␊ - type: "Microsoft.Relay/namespaces/AuthorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Relay/namespaces/HybridConnections␊ - */␊ - export interface Namespaces_HybridConnections {␊ - apiVersion: "2016-07-01"␊ - /**␊ - * The hybrid connection name.␊ - */␊ - name: string␊ - /**␊ - * Properties of the HybridConnection.␊ - */␊ - properties: (HybridConnectionProperties | string)␊ - resources?: Namespaces_HybridConnectionsAuthorizationRulesChildResource[]␊ - type: "Microsoft.Relay/namespaces/HybridConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Relay/namespaces/HybridConnections/authorizationRules␊ - */␊ - export interface Namespaces_HybridConnectionsAuthorizationRulesChildResource {␊ - apiVersion: "2016-07-01"␊ - /**␊ - * The authorizationRule name.␊ - */␊ - name: string␊ - /**␊ - * AuthorizationRule properties.␊ - */␊ - properties: (AuthorizationRuleProperties2 | string)␊ - type: "authorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Relay/namespaces/HybridConnections/authorizationRules␊ - */␊ - export interface Namespaces_HybridConnectionsAuthorizationRules {␊ - apiVersion: "2016-07-01"␊ - /**␊ - * The authorizationRule name.␊ - */␊ - name: string␊ - /**␊ - * AuthorizationRule properties.␊ - */␊ - properties: (AuthorizationRuleProperties2 | string)␊ - type: "Microsoft.Relay/namespaces/HybridConnections/authorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Relay/namespaces/WcfRelays␊ - */␊ - export interface Namespaces_WcfRelays {␊ - apiVersion: "2016-07-01"␊ - /**␊ - * The relay name␊ - */␊ - name: string␊ - /**␊ - * Properties of the WcfRelay Properties.␊ - */␊ - properties: (WcfRelayProperties | string)␊ - resources?: Namespaces_WcfRelaysAuthorizationRulesChildResource[]␊ - type: "Microsoft.Relay/namespaces/WcfRelays"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Relay/namespaces/WcfRelays/authorizationRules␊ - */␊ - export interface Namespaces_WcfRelaysAuthorizationRulesChildResource {␊ - apiVersion: "2016-07-01"␊ - /**␊ - * The authorizationRule name.␊ - */␊ - name: string␊ - /**␊ - * AuthorizationRule properties.␊ - */␊ - properties: (AuthorizationRuleProperties2 | string)␊ - type: "authorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Relay/namespaces/WcfRelays/authorizationRules␊ - */␊ - export interface Namespaces_WcfRelaysAuthorizationRules {␊ - apiVersion: "2016-07-01"␊ - /**␊ - * The authorizationRule name.␊ - */␊ - name: string␊ - /**␊ - * AuthorizationRule properties.␊ - */␊ - properties: (AuthorizationRuleProperties2 | string)␊ - type: "Microsoft.Relay/namespaces/WcfRelays/authorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Relay/namespaces␊ - */␊ - export interface Namespaces11 {␊ - apiVersion: "2017-04-01"␊ - /**␊ - * Resource location.␊ - */␊ - location: string␊ - /**␊ - * The namespace name␊ - */␊ - name: string␊ - /**␊ - * Properties of the namespace.␊ - */␊ - properties: (RelayNamespaceProperties1 | string)␊ - resources?: (NamespacesAuthorizationRulesChildResource2 | NamespacesHybridConnectionsChildResource | NamespacesWcfRelaysChildResource)[]␊ - /**␊ - * SKU of the namespace.␊ - */␊ - sku?: (Sku68 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Relay/namespaces"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the namespace.␊ - */␊ - export interface RelayNamespaceProperties1 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Relay/namespaces/authorizationRules␊ - */␊ - export interface NamespacesAuthorizationRulesChildResource2 {␊ - apiVersion: "2017-04-01"␊ - /**␊ - * The authorization rule name.␊ - */␊ - name: string␊ - /**␊ - * Authorization rule properties.␊ - */␊ - properties: (AuthorizationRuleProperties3 | string)␊ - type: "authorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Authorization rule properties.␊ - */␊ - export interface AuthorizationRuleProperties3 {␊ - /**␊ - * The rights associated with the rule.␊ - */␊ - rights: (("Manage" | "Send" | "Listen")[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Relay/namespaces/hybridConnections␊ - */␊ - export interface NamespacesHybridConnectionsChildResource {␊ - apiVersion: "2017-04-01"␊ - /**␊ - * The hybrid connection name.␊ - */␊ - name: string␊ - /**␊ - * Properties of the HybridConnection.␊ - */␊ - properties: (HybridConnectionProperties1 | string)␊ - type: "hybridConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the HybridConnection.␊ - */␊ - export interface HybridConnectionProperties1 {␊ - /**␊ - * Returns true if client authorization is needed for this hybrid connection; otherwise, false.␊ - */␊ - requiresClientAuthorization?: (boolean | string)␊ - /**␊ - * The usermetadata is a placeholder to store user-defined string data for the hybrid connection endpoint. For example, it can be used to store descriptive data, such as a list of teams and their contact information. Also, user-defined configuration settings can be stored.␊ - */␊ - userMetadata?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Relay/namespaces/wcfRelays␊ - */␊ - export interface NamespacesWcfRelaysChildResource {␊ - apiVersion: "2017-04-01"␊ - /**␊ - * The relay name.␊ - */␊ - name: string␊ - /**␊ - * Properties of the WCF relay.␊ - */␊ - properties: (WcfRelayProperties1 | string)␊ - type: "wcfRelays"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the WCF relay.␊ - */␊ - export interface WcfRelayProperties1 {␊ - /**␊ - * WCF relay type.␊ - */␊ - relayType?: (("NetTcp" | "Http") | string)␊ - /**␊ - * Returns true if client authorization is needed for this relay; otherwise, false.␊ - */␊ - requiresClientAuthorization?: (boolean | string)␊ - /**␊ - * Returns true if transport security is needed for this relay; otherwise, false.␊ - */␊ - requiresTransportSecurity?: (boolean | string)␊ - /**␊ - * The usermetadata is a placeholder to store user-defined string data for the WCF Relay endpoint. For example, it can be used to store descriptive data, such as list of teams and their contact information. Also, user-defined configuration settings can be stored.␊ - */␊ - userMetadata?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SKU of the namespace.␊ - */␊ - export interface Sku68 {␊ - /**␊ - * Name of this SKU.␊ - */␊ - name: ("Standard" | string)␊ - /**␊ - * The tier of this SKU.␊ - */␊ - tier?: ("Standard" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Relay/namespaces/authorizationRules␊ - */␊ - export interface NamespacesAuthorizationRules1 {␊ - apiVersion: "2017-04-01"␊ - /**␊ - * The authorization rule name.␊ - */␊ - name: string␊ - /**␊ - * Authorization rule properties.␊ - */␊ - properties: (AuthorizationRuleProperties3 | string)␊ - type: "Microsoft.Relay/namespaces/authorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Relay/namespaces/hybridConnections␊ - */␊ - export interface NamespacesHybridConnections {␊ - apiVersion: "2017-04-01"␊ - /**␊ - * The hybrid connection name.␊ - */␊ - name: string␊ - /**␊ - * Properties of the HybridConnection.␊ - */␊ - properties: (HybridConnectionProperties1 | string)␊ - resources?: NamespacesHybridConnectionsAuthorizationRulesChildResource[]␊ - type: "Microsoft.Relay/namespaces/hybridConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Relay/namespaces/hybridConnections/authorizationRules␊ - */␊ - export interface NamespacesHybridConnectionsAuthorizationRulesChildResource {␊ - apiVersion: "2017-04-01"␊ - /**␊ - * The authorization rule name.␊ - */␊ - name: string␊ - /**␊ - * Authorization rule properties.␊ - */␊ - properties: (AuthorizationRuleProperties3 | string)␊ - type: "authorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Relay/namespaces/hybridConnections/authorizationRules␊ - */␊ - export interface NamespacesHybridConnectionsAuthorizationRules {␊ - apiVersion: "2017-04-01"␊ - /**␊ - * The authorization rule name.␊ - */␊ - name: string␊ - /**␊ - * Authorization rule properties.␊ - */␊ - properties: (AuthorizationRuleProperties3 | string)␊ - type: "Microsoft.Relay/namespaces/hybridConnections/authorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Relay/namespaces/wcfRelays␊ - */␊ - export interface NamespacesWcfRelays {␊ - apiVersion: "2017-04-01"␊ - /**␊ - * The relay name.␊ - */␊ - name: string␊ - /**␊ - * Properties of the WCF relay.␊ - */␊ - properties: (WcfRelayProperties1 | string)␊ - resources?: NamespacesWcfRelaysAuthorizationRulesChildResource[]␊ - type: "Microsoft.Relay/namespaces/wcfRelays"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Relay/namespaces/wcfRelays/authorizationRules␊ - */␊ - export interface NamespacesWcfRelaysAuthorizationRulesChildResource {␊ - apiVersion: "2017-04-01"␊ - /**␊ - * The authorization rule name.␊ - */␊ - name: string␊ - /**␊ - * Authorization rule properties.␊ - */␊ - properties: (AuthorizationRuleProperties3 | string)␊ - type: "authorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Relay/namespaces/wcfRelays/authorizationRules␊ - */␊ - export interface NamespacesWcfRelaysAuthorizationRules {␊ - apiVersion: "2017-04-01"␊ - /**␊ - * The authorization rule name.␊ - */␊ - name: string␊ - /**␊ - * Authorization rule properties.␊ - */␊ - properties: (AuthorizationRuleProperties3 | string)␊ - type: "Microsoft.Relay/namespaces/wcfRelays/authorizationRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataFactory/factories␊ - */␊ - export interface Factories {␊ - apiVersion: "2017-09-01-preview"␊ - /**␊ - * Identity properties of the factory resource.␊ - */␊ - identity?: (FactoryIdentity | string)␊ - /**␊ - * The resource location.␊ - */␊ - location?: string␊ - /**␊ - * The factory name.␊ - */␊ - name: string␊ - /**␊ - * Factory resource properties.␊ - */␊ - properties: (FactoryProperties | string)␊ - resources?: (FactoriesIntegrationRuntimesChildResource | FactoriesLinkedservicesChildResource | FactoriesDatasetsChildResource | FactoriesPipelinesChildResource | FactoriesTriggersChildResource)[]␊ - /**␊ - * The resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.DataFactory/factories"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity properties of the factory resource.␊ - */␊ - export interface FactoryIdentity {␊ - /**␊ - * The identity type. Currently the only supported type is 'SystemAssigned'.␊ - */␊ - type: ("SystemAssigned" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Factory resource properties.␊ - */␊ - export interface FactoryProperties {␊ - /**␊ - * Factory's VSTS repo information.␊ - */␊ - vstsConfiguration?: (FactoryVSTSConfiguration | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Factory's VSTS repo information.␊ - */␊ - export interface FactoryVSTSConfiguration {␊ - /**␊ - * VSTS account name.␊ - */␊ - accountName?: string␊ - /**␊ - * VSTS collaboration branch.␊ - */␊ - collaborationBranch?: string␊ - /**␊ - * VSTS last commit id.␊ - */␊ - lastCommitId?: string␊ - /**␊ - * VSTS project name.␊ - */␊ - projectName?: string␊ - /**␊ - * VSTS repository name.␊ - */␊ - repositoryName?: string␊ - /**␊ - * VSTS root folder.␊ - */␊ - rootFolder?: string␊ - /**␊ - * VSTS tenant id.␊ - */␊ - tenantId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataFactory/factories/integrationRuntimes␊ - */␊ - export interface FactoriesIntegrationRuntimesChildResource {␊ - apiVersion: "2017-09-01-preview"␊ - /**␊ - * The integration runtime name.␊ - */␊ - name: string␊ - /**␊ - * Azure Data Factory nested object which serves as a compute resource for activities.␊ - */␊ - properties: (IntegrationRuntime | string)␊ - type: "integrationRuntimes"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Managed integration runtime, including managed elastic and managed dedicated integration runtimes.␊ - */␊ - export interface ManagedIntegrationRuntime {␊ - type: "Managed"␊ - /**␊ - * Managed integration runtime type properties.␊ - */␊ - typeProperties: (ManagedIntegrationRuntimeTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Managed integration runtime type properties.␊ - */␊ - export interface ManagedIntegrationRuntimeTypeProperties {␊ - /**␊ - * The compute resource properties for managed integration runtime.␊ - */␊ - computeProperties?: (IntegrationRuntimeComputeProperties | string)␊ - /**␊ - * SSIS properties for managed integration runtime.␊ - */␊ - ssisProperties?: (IntegrationRuntimeSsisProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The compute resource properties for managed integration runtime.␊ - */␊ - export interface IntegrationRuntimeComputeProperties {␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * The location for managed integration runtime. The supported regions could be found on https://docs.microsoft.com/en-us/azure/data-factory/data-factory-data-movement-activities␊ - */␊ - location?: string␊ - /**␊ - * Maximum parallel executions count per node for managed integration runtime.␊ - */␊ - maxParallelExecutionsPerNode?: (number | string)␊ - /**␊ - * The node size requirement to managed integration runtime.␊ - */␊ - nodeSize?: string␊ - /**␊ - * The required number of nodes for managed integration runtime.␊ - */␊ - numberOfNodes?: (number | string)␊ - /**␊ - * VNet properties for managed integration runtime.␊ - */␊ - vNetProperties?: (IntegrationRuntimeVNetProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VNet properties for managed integration runtime.␊ - */␊ - export interface IntegrationRuntimeVNetProperties {␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * The name of the subnet this integration runtime will join.␊ - */␊ - subnet?: string␊ - /**␊ - * The ID of the VNet that this integration runtime will join.␊ - */␊ - vNetId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSIS properties for managed integration runtime.␊ - */␊ - export interface IntegrationRuntimeSsisProperties {␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Catalog information for managed dedicated integration runtime.␊ - */␊ - catalogInfo?: (IntegrationRuntimeSsisCatalogInfo | string)␊ - /**␊ - * Custom setup script properties for a managed dedicated integration runtime.␊ - */␊ - customSetupScriptProperties?: (IntegrationRuntimeCustomSetupScriptProperties | string)␊ - /**␊ - * Data proxy properties for a managed dedicated integration runtime.␊ - */␊ - dataProxyProperties?: (IntegrationRuntimeDataProxyProperties | string)␊ - /**␊ - * The edition for the SSIS Integration Runtime.␊ - */␊ - edition?: (("Standard" | "Enterprise") | string)␊ - /**␊ - * License type for bringing your own license scenario.␊ - */␊ - licenseType?: (("BasePrice" | "LicenseIncluded") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Catalog information for managed dedicated integration runtime.␊ - */␊ - export interface IntegrationRuntimeSsisCatalogInfo {␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Azure Data Factory secure string definition. The string value will be masked with asterisks '*' during Get or List API calls.␊ - */␊ - catalogAdminPassword?: (SecureString | string)␊ - /**␊ - * The administrator user name of catalog database.␊ - */␊ - catalogAdminUserName?: string␊ - /**␊ - * The pricing tier for the catalog database. The valid values could be found in https://azure.microsoft.com/en-us/pricing/details/sql-database/␊ - */␊ - catalogPricingTier?: string␊ - /**␊ - * The catalog database server URL.␊ - */␊ - catalogServerEndpoint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Data Factory secure string definition. The string value will be masked with asterisks '*' during Get or List API calls.␊ - */␊ - export interface SecureString {␊ - type: "SecureString"␊ - /**␊ - * Value of secure string.␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Custom setup script properties for a managed dedicated integration runtime.␊ - */␊ - export interface IntegrationRuntimeCustomSetupScriptProperties {␊ - /**␊ - * The URI of the Azure blob container that contains the custom setup script.␊ - */␊ - blobContainerUri?: string␊ - /**␊ - * Azure Data Factory secure string definition. The string value will be masked with asterisks '*' during Get or List API calls.␊ - */␊ - sasToken?: (SecureString | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Data proxy properties for a managed dedicated integration runtime.␊ - */␊ - export interface IntegrationRuntimeDataProxyProperties {␊ - /**␊ - * The entity reference.␊ - */␊ - connectVia?: (EntityReference | string)␊ - /**␊ - * The path to contain the staged data in the Blob storage.␊ - */␊ - path?: string␊ - /**␊ - * The entity reference.␊ - */␊ - stagingLinkedService?: (EntityReference | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The entity reference.␊ - */␊ - export interface EntityReference {␊ - /**␊ - * The name of this referenced entity.␊ - */␊ - referenceName?: string␊ - /**␊ - * The type of this referenced entity.␊ - */␊ - type?: (("IntegrationRuntimeReference" | "LinkedServiceReference") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Self-hosted integration runtime.␊ - */␊ - export interface SelfHostedIntegrationRuntime {␊ - type: "SelfHosted"␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - typeProperties: (LinkedIntegrationRuntimeTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - export interface LinkedIntegrationRuntimeTypeProperties {␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - linkedInfo?: (LinkedIntegrationRuntimeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - export interface LinkedIntegrationRuntimeKey {␊ - authorizationType: "Key"␊ - /**␊ - * Azure Data Factory secure string definition. The string value will be masked with asterisks '*' during Get or List API calls.␊ - */␊ - key: (SecureString | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - export interface LinkedIntegrationRuntimeRbac {␊ - authorizationType: "RBAC"␊ - /**␊ - * The resource ID of the integration runtime to be shared.␊ - */␊ - resourceId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataFactory/factories/linkedservices␊ - */␊ - export interface FactoriesLinkedservicesChildResource {␊ - apiVersion: "2017-09-01-preview"␊ - /**␊ - * The linked service name.␊ - */␊ - name: string␊ - /**␊ - * The Azure Data Factory nested object which contains the information and credential which can be used to connect with related store or compute resource.␊ - */␊ - properties: (LinkedService | string)␊ - type: "linkedservices"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Integration runtime reference type.␊ - */␊ - export interface IntegrationRuntimeReference {␊ - /**␊ - * An object mapping parameter names to argument values.␊ - */␊ - parameters?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Reference integration runtime name.␊ - */␊ - referenceName: string␊ - /**␊ - * Type of integration runtime.␊ - */␊ - type: ("IntegrationRuntimeReference" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Definition of a single parameter for an entity.␊ - */␊ - export interface ParameterSpecification {␊ - /**␊ - * Default value of parameter.␊ - */␊ - defaultValue?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameter type.␊ - */␊ - type: (("Object" | "String" | "Int" | "Float" | "Bool" | "Array" | "SecureString") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The storage account linked service.␊ - */␊ - export interface AzureStorageLinkedService {␊ - type: "AzureStorage"␊ - /**␊ - * Azure Storage linked service properties.␊ - */␊ - typeProperties: (AzureStorageLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Storage linked service properties.␊ - */␊ - export interface AzureStorageLinkedServiceTypeProperties {␊ - /**␊ - * The connection string. It is mutually exclusive with sasUri property. Type: string, SecureString or AzureKeyVaultSecretReference.␊ - */␊ - connectionString?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - sasUri?: (SecretBase | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Key Vault secret reference.␊ - */␊ - export interface AzureKeyVaultSecretReference {␊ - /**␊ - * The name of the secret in Azure Key Vault. Type: string (or Expression with resultType string).␊ - */␊ - secretName: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The version of the secret in Azure Key Vault. The default value is the latest version of the secret. Type: string (or Expression with resultType string).␊ - */␊ - secretVersion?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service reference type.␊ - */␊ - store: (LinkedServiceReference | string)␊ - type: "AzureKeyVaultSecret"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service reference type.␊ - */␊ - export interface LinkedServiceReference {␊ - /**␊ - * An object mapping parameter names to argument values.␊ - */␊ - parameters?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Reference LinkedService name.␊ - */␊ - referenceName: string␊ - /**␊ - * Linked service reference type.␊ - */␊ - type: ("LinkedServiceReference" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure SQL Data Warehouse linked service.␊ - */␊ - export interface AzureSqlDWLinkedService {␊ - type: "AzureSqlDW"␊ - /**␊ - * Azure SQL Data Warehouse linked service properties.␊ - */␊ - typeProperties: (AzureSqlDWLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure SQL Data Warehouse linked service properties.␊ - */␊ - export interface AzureSqlDWLinkedServiceTypeProperties {␊ - /**␊ - * The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.␊ - */␊ - connectionString: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The ID of the service principal used to authenticate against Azure SQL Data Warehouse. Type: string (or Expression with resultType string).␊ - */␊ - servicePrincipalId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - servicePrincipalKey?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).␊ - */␊ - tenant?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SQL Server linked service.␊ - */␊ - export interface SqlServerLinkedService {␊ - type: "SqlServer"␊ - /**␊ - * SQL Server linked service properties.␊ - */␊ - typeProperties: (SqlServerLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SQL Server linked service properties.␊ - */␊ - export interface SqlServerLinkedServiceTypeProperties {␊ - /**␊ - * The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.␊ - */␊ - connectionString: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * The on-premises Windows authentication user name. Type: string (or Expression with resultType string).␊ - */␊ - userName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft Azure SQL Database linked service.␊ - */␊ - export interface AzureSqlDatabaseLinkedService {␊ - type: "AzureSqlDatabase"␊ - /**␊ - * Azure SQL Database linked service properties.␊ - */␊ - typeProperties: (AzureSqlDatabaseLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure SQL Database linked service properties.␊ - */␊ - export interface AzureSqlDatabaseLinkedServiceTypeProperties {␊ - /**␊ - * The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.␊ - */␊ - connectionString: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The ID of the service principal used to authenticate against Azure SQL Database. Type: string (or Expression with resultType string).␊ - */␊ - servicePrincipalId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - servicePrincipalKey?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).␊ - */␊ - tenant?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Batch linked service.␊ - */␊ - export interface AzureBatchLinkedService {␊ - type: "AzureBatch"␊ - /**␊ - * Azure Batch linked service properties.␊ - */␊ - typeProperties: (AzureBatchLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Batch linked service properties.␊ - */␊ - export interface AzureBatchLinkedServiceTypeProperties {␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - accessKey?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * The Azure Batch account name. Type: string (or Expression with resultType string).␊ - */␊ - accountName: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Azure Batch URI. Type: string (or Expression with resultType string).␊ - */␊ - batchUri: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service reference type.␊ - */␊ - linkedServiceName: (LinkedServiceReference | string)␊ - /**␊ - * The Azure Batch pool name. Type: string (or Expression with resultType string).␊ - */␊ - poolName: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Key Vault linked service.␊ - */␊ - export interface AzureKeyVaultLinkedService {␊ - type: "AzureKeyVault"␊ - /**␊ - * Azure Key Vault linked service properties.␊ - */␊ - typeProperties: (AzureKeyVaultLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Key Vault linked service properties.␊ - */␊ - export interface AzureKeyVaultLinkedServiceTypeProperties {␊ - /**␊ - * The base URL of the Azure Key Vault. e.g. https://myakv.vault.azure.net Type: string (or Expression with resultType string).␊ - */␊ - baseUrl: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft Azure Cosmos Database (CosmosDB) linked service.␊ - */␊ - export interface CosmosDbLinkedService {␊ - type: "CosmosDb"␊ - /**␊ - * CosmosDB linked service properties.␊ - */␊ - typeProperties: (CosmosDbLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * CosmosDB linked service properties.␊ - */␊ - export interface CosmosDbLinkedServiceTypeProperties {␊ - /**␊ - * The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.␊ - */␊ - connectionString: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Dynamics linked service.␊ - */␊ - export interface DynamicsLinkedService {␊ - type: "Dynamics"␊ - /**␊ - * Dynamics linked service properties.␊ - */␊ - typeProperties: (DynamicsLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Dynamics linked service properties.␊ - */␊ - export interface DynamicsLinkedServiceTypeProperties {␊ - /**␊ - * The authentication type to connect to Dynamics server. 'Office365' for online scenario, 'Ifd' for on-premises with Ifd scenario. Type: string (or Expression with resultType string).␊ - */␊ - authenticationType: (("Office365" | "Ifd") | string)␊ - /**␊ - * The deployment type of the Dynamics instance. 'Online' for Dynamics Online and 'OnPremisesWithIfd' for Dynamics on-premises with Ifd. Type: string (or Expression with resultType string).␊ - */␊ - deploymentType: (("Online" | "OnPremisesWithIfd") | string)␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The host name of the on-premises Dynamics server. The property is required for on-prem and not allowed for online. Type: string (or Expression with resultType string).␊ - */␊ - hostName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The organization name of the Dynamics instance. The property is required for on-prem and required for online when there are more than one Dynamics instances associated with the user. Type: string (or Expression with resultType string).␊ - */␊ - organizationName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * The port of on-premises Dynamics server. The property is required for on-prem and not allowed for online. Default is 443. Type: integer (or Expression with resultType integer), minimum: 0.␊ - */␊ - port?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The URL to the Microsoft Dynamics server. The property is required for on-line and not allowed for on-prem. Type: string (or Expression with resultType string).␊ - */␊ - serviceUri?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * User name to access the Dynamics instance. Type: string (or Expression with resultType string).␊ - */␊ - username: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HDInsight linked service.␊ - */␊ - export interface HDInsightLinkedService {␊ - type: "HDInsight"␊ - /**␊ - * HDInsight linked service properties.␊ - */␊ - typeProperties: (HDInsightLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HDInsight linked service properties.␊ - */␊ - export interface HDInsightLinkedServiceTypeProperties {␊ - /**␊ - * HDInsight cluster URI. Type: string (or Expression with resultType string).␊ - */␊ - clusterUri: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service reference type.␊ - */␊ - hcatalogLinkedServiceName?: (LinkedServiceReference | string)␊ - /**␊ - * Linked service reference type.␊ - */␊ - linkedServiceName?: (LinkedServiceReference | string)␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * HDInsight cluster user name. Type: string (or Expression with resultType string).␊ - */␊ - userName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * File system linked service.␊ - */␊ - export interface FileServerLinkedService {␊ - type: "FileServer"␊ - /**␊ - * File system linked service properties.␊ - */␊ - typeProperties: (FileServerLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * File system linked service properties.␊ - */␊ - export interface FileServerLinkedServiceTypeProperties {␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Host name of the server. Type: string (or Expression with resultType string).␊ - */␊ - host: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * User ID to logon the server. Type: string (or Expression with resultType string).␊ - */␊ - userId?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Oracle database.␊ - */␊ - export interface OracleLinkedService {␊ - type: "Oracle"␊ - /**␊ - * Oracle database linked service properties.␊ - */␊ - typeProperties: (OracleLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Oracle database linked service properties.␊ - */␊ - export interface OracleLinkedServiceTypeProperties {␊ - /**␊ - * The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.␊ - */␊ - connectionString: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure MySQL database linked service.␊ - */␊ - export interface AzureMySqlLinkedService {␊ - type: "AzureMySql"␊ - /**␊ - * Azure MySQL database linked service properties.␊ - */␊ - typeProperties: (AzureMySqlLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure MySQL database linked service properties.␊ - */␊ - export interface AzureMySqlLinkedServiceTypeProperties {␊ - /**␊ - * The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.␊ - */␊ - connectionString: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service for MySQL data source.␊ - */␊ - export interface MySqlLinkedService {␊ - type: "MySql"␊ - /**␊ - * MySQL linked service properties.␊ - */␊ - typeProperties: (MySqlLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * MySQL linked service properties.␊ - */␊ - export interface MySqlLinkedServiceTypeProperties {␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - connectionString: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service for PostgreSQL data source.␊ - */␊ - export interface PostgreSqlLinkedService {␊ - type: "PostgreSql"␊ - /**␊ - * PostgreSQL linked service properties.␊ - */␊ - typeProperties: (PostgreSqlLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * PostgreSQL linked service properties.␊ - */␊ - export interface PostgreSqlLinkedServiceTypeProperties {␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - connectionString: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service for Sybase data source.␊ - */␊ - export interface SybaseLinkedService {␊ - type: "Sybase"␊ - /**␊ - * Sybase linked service properties.␊ - */␊ - typeProperties: (SybaseLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Sybase linked service properties.␊ - */␊ - export interface SybaseLinkedServiceTypeProperties {␊ - /**␊ - * AuthenticationType to be used for connection.␊ - */␊ - authenticationType?: (("Basic" | "Windows") | string)␊ - /**␊ - * Database name for connection. Type: string (or Expression with resultType string).␊ - */␊ - database: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * Schema name for connection. Type: string (or Expression with resultType string).␊ - */␊ - schema?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Server name for connection. Type: string (or Expression with resultType string).␊ - */␊ - server: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Username for authentication. Type: string (or Expression with resultType string).␊ - */␊ - username?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service for DB2 data source.␊ - */␊ - export interface Db2LinkedService {␊ - type: "Db2"␊ - /**␊ - * DB2 linked service properties.␊ - */␊ - typeProperties: (Db2LinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DB2 linked service properties.␊ - */␊ - export interface Db2LinkedServiceTypeProperties {␊ - /**␊ - * AuthenticationType to be used for connection.␊ - */␊ - authenticationType?: ("Basic" | string)␊ - /**␊ - * Database name for connection. Type: string (or Expression with resultType string).␊ - */␊ - database: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * Server name for connection. Type: string (or Expression with resultType string).␊ - */␊ - server: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Username for authentication. Type: string (or Expression with resultType string).␊ - */␊ - username?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service for Teradata data source.␊ - */␊ - export interface TeradataLinkedService {␊ - type: "Teradata"␊ - /**␊ - * Teradata linked service properties.␊ - */␊ - typeProperties: (TeradataLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Teradata linked service properties.␊ - */␊ - export interface TeradataLinkedServiceTypeProperties {␊ - /**␊ - * AuthenticationType to be used for connection.␊ - */␊ - authenticationType?: (("Basic" | "Windows") | string)␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * Server name for connection. Type: string (or Expression with resultType string).␊ - */␊ - server: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Username for authentication. Type: string (or Expression with resultType string).␊ - */␊ - username?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure ML Web Service linked service.␊ - */␊ - export interface AzureMLLinkedService {␊ - type: "AzureML"␊ - /**␊ - * Azure ML Web Service linked service properties.␊ - */␊ - typeProperties: (AzureMLLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure ML Web Service linked service properties.␊ - */␊ - export interface AzureMLLinkedServiceTypeProperties {␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - apiKey: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Batch Execution REST URL for an Azure ML Web Service endpoint. Type: string (or Expression with resultType string).␊ - */␊ - mlEndpoint: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The ID of the service principal used to authenticate against the ARM-based updateResourceEndpoint of an Azure ML web service. Type: string (or Expression with resultType string).␊ - */␊ - servicePrincipalId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - servicePrincipalKey?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).␊ - */␊ - tenant?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Update Resource REST URL for an Azure ML Web Service endpoint. Type: string (or Expression with resultType string).␊ - */␊ - updateResourceEndpoint?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Open Database Connectivity (ODBC) linked service.␊ - */␊ - export interface OdbcLinkedService {␊ - type: "Odbc"␊ - /**␊ - * ODBC linked service properties.␊ - */␊ - typeProperties: (OdbcLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ODBC linked service properties.␊ - */␊ - export interface OdbcLinkedServiceTypeProperties {␊ - /**␊ - * Type of authentication used to connect to the ODBC data store. Possible values are: Anonymous and Basic. Type: string (or Expression with resultType string).␊ - */␊ - authenticationType?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The non-access credential portion of the connection string as well as an optional encrypted credential. Type: string, SecureString or AzureKeyVaultSecretReference.␊ - */␊ - connectionString: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - credential?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * User name for Basic authentication. Type: string (or Expression with resultType string).␊ - */␊ - userName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Hadoop Distributed File System (HDFS) linked service.␊ - */␊ - export interface HdfsLinkedService {␊ - type: "Hdfs"␊ - /**␊ - * HDFS linked service properties.␊ - */␊ - typeProperties: (HdfsLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HDFS linked service properties.␊ - */␊ - export interface HdfsLinkedServiceTypeProperties {␊ - /**␊ - * Type of authentication used to connect to the HDFS. Possible values are: Anonymous and Windows. Type: string (or Expression with resultType string).␊ - */␊ - authenticationType?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * The URL of the HDFS service endpoint, e.g. http://myhostname:50070/webhdfs/v1 . Type: string (or Expression with resultType string).␊ - */␊ - url: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * User name for Windows authentication. Type: string (or Expression with resultType string).␊ - */␊ - userName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Open Data Protocol (OData) linked service.␊ - */␊ - export interface ODataLinkedService {␊ - type: "OData"␊ - /**␊ - * OData linked service properties.␊ - */␊ - typeProperties: (ODataLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * OData linked service properties.␊ - */␊ - export interface ODataLinkedServiceTypeProperties {␊ - /**␊ - * Type of authentication used to connect to the OData service.␊ - */␊ - authenticationType?: (("Basic" | "Anonymous") | string)␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * The URL of the OData service endpoint. Type: string (or Expression with resultType string).␊ - */␊ - url: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * User name of the OData service. Type: string (or Expression with resultType string).␊ - */␊ - userName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Web linked service.␊ - */␊ - export interface WebLinkedService {␊ - type: "Web"␊ - /**␊ - * Base definition of WebLinkedServiceTypeProperties, this typeProperties is polymorphic based on authenticationType, so not flattened in SDK models.␊ - */␊ - typeProperties: (WebLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A WebLinkedService that uses anonymous authentication to communicate with an HTTP endpoint.␊ - */␊ - export interface WebAnonymousAuthentication {␊ - authenticationType: "Anonymous"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A WebLinkedService that uses basic authentication to communicate with an HTTP endpoint.␊ - */␊ - export interface WebBasicAuthentication {␊ - authenticationType: "Basic"␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * User name for Basic authentication. Type: string (or Expression with resultType string).␊ - */␊ - username: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A WebLinkedService that uses client certificate based authentication to communicate with an HTTP endpoint. This scheme follows mutual authentication; the server must also provide valid credentials to the client.␊ - */␊ - export interface WebClientCertificateAuthentication {␊ - authenticationType: "ClientCertificate"␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - pfx: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service for Cassandra data source.␊ - */␊ - export interface CassandraLinkedService {␊ - type: "Cassandra"␊ - /**␊ - * Cassandra linked service properties.␊ - */␊ - typeProperties: (CassandraLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Cassandra linked service properties.␊ - */␊ - export interface CassandraLinkedServiceTypeProperties {␊ - /**␊ - * AuthenticationType to be used for connection. Type: string (or Expression with resultType string).␊ - */␊ - authenticationType?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Host name for connection. Type: string (or Expression with resultType string).␊ - */␊ - host: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * The port for the connection. Type: integer (or Expression with resultType integer).␊ - */␊ - port?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Username for authentication. Type: string (or Expression with resultType string).␊ - */␊ - username?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service for MongoDb data source.␊ - */␊ - export interface MongoDbLinkedService {␊ - type: "MongoDb"␊ - /**␊ - * MongoDB linked service properties.␊ - */␊ - typeProperties: (MongoDbLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * MongoDB linked service properties.␊ - */␊ - export interface MongoDbLinkedServiceTypeProperties {␊ - /**␊ - * Specifies whether to allow self-signed certificates from the server. The default value is false. Type: boolean (or Expression with resultType boolean).␊ - */␊ - allowSelfSignedServerCert?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The authentication type to be used to connect to the MongoDB database.␊ - */␊ - authenticationType?: (("Basic" | "Anonymous") | string)␊ - /**␊ - * Database to verify the username and password. Type: string (or Expression with resultType string).␊ - */␊ - authSource?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The name of the MongoDB database that you want to access. Type: string (or Expression with resultType string).␊ - */␊ - databaseName: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether the connections to the server are encrypted using SSL. The default value is false. Type: boolean (or Expression with resultType boolean).␊ - */␊ - enableSsl?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * The TCP port number that the MongoDB server uses to listen for client connections. The default value is 27017. Type: integer (or Expression with resultType integer), minimum: 0.␊ - */␊ - port?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The IP address or server name of the MongoDB server. Type: string (or Expression with resultType string).␊ - */␊ - server: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Username for authentication. Type: string (or Expression with resultType string).␊ - */␊ - username?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Data Lake Store linked service.␊ - */␊ - export interface AzureDataLakeStoreLinkedService {␊ - type: "AzureDataLakeStore"␊ - /**␊ - * Azure Data Lake Store linked service properties.␊ - */␊ - typeProperties: (AzureDataLakeStoreLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Data Lake Store linked service properties.␊ - */␊ - export interface AzureDataLakeStoreLinkedServiceTypeProperties {␊ - /**␊ - * Data Lake Store account name. Type: string (or Expression with resultType string).␊ - */␊ - accountName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Data Lake Store service URI. Type: string (or Expression with resultType string).␊ - */␊ - dataLakeStoreUri: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Data Lake Store account resource group name (if different from Data Factory account). Type: string (or Expression with resultType string).␊ - */␊ - resourceGroupName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The ID of the application used to authenticate against the Azure Data Lake Store account. Type: string (or Expression with resultType string).␊ - */␊ - servicePrincipalId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - servicePrincipalKey?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * Data Lake Store account subscription ID (if different from Data Factory account). Type: string (or Expression with resultType string).␊ - */␊ - subscriptionId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).␊ - */␊ - tenant?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service for Salesforce.␊ - */␊ - export interface SalesforceLinkedService {␊ - type: "Salesforce"␊ - /**␊ - * Salesforce linked service properties.␊ - */␊ - typeProperties: (SalesforceLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Salesforce linked service properties.␊ - */␊ - export interface SalesforceLinkedServiceTypeProperties {␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The URL of Salesforce instance. Default is 'https://login.salesforce.com'. To copy data from sandbox, specify 'https://test.salesforce.com'. To copy data from custom domain, specify, for example, 'https://[domain].my.salesforce.com'. Type: string (or Expression with resultType string).␊ - */␊ - environmentUrl?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - securityToken?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * The username for Basic authentication of the Salesforce instance. Type: string (or Expression with resultType string).␊ - */␊ - username?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service for SAP Cloud for Customer.␊ - */␊ - export interface SapCloudForCustomerLinkedService {␊ - type: "SapCloudForCustomer"␊ - /**␊ - * SAP Cloud for Customer linked service properties.␊ - */␊ - typeProperties: (SapCloudForCustomerLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SAP Cloud for Customer linked service properties.␊ - */␊ - export interface SapCloudForCustomerLinkedServiceTypeProperties {␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Either encryptedCredential or username/password must be provided. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * The URL of SAP Cloud for Customer OData API. For example, '[https://[tenantname].crm.ondemand.com/sap/c4c/odata/v1]'. Type: string (or Expression with resultType string).␊ - */␊ - url: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The username for Basic authentication. Type: string (or Expression with resultType string).␊ - */␊ - username?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service for SAP ERP Central Component(SAP ECC).␊ - */␊ - export interface SapEccLinkedService {␊ - type: "SapEcc"␊ - /**␊ - * SAP ECC linked service properties.␊ - */␊ - typeProperties: (SapEccLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SAP ECC linked service properties.␊ - */␊ - export interface SapEccLinkedServiceTypeProperties {␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Either encryptedCredential or username/password must be provided. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: string␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * The URL of SAP ECC OData API. For example, '[https://hostname:port/sap/opu/odata/sap/servicename/]'. Type: string (or Expression with resultType string).␊ - */␊ - url: string␊ - /**␊ - * The username for Basic authentication. Type: string (or Expression with resultType string).␊ - */␊ - username?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service for Amazon S3.␊ - */␊ - export interface AmazonS3LinkedService {␊ - type: "AmazonS3"␊ - /**␊ - * Amazon S3 linked service properties.␊ - */␊ - typeProperties: (AmazonS3LinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Amazon S3 linked service properties.␊ - */␊ - export interface AmazonS3LinkedServiceTypeProperties {␊ - /**␊ - * The access key identifier of the Amazon S3 Identity and Access Management (IAM) user. Type: string (or Expression with resultType string).␊ - */␊ - accessKeyId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - secretAccessKey?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service for Amazon Redshift.␊ - */␊ - export interface AmazonRedshiftLinkedService {␊ - type: "AmazonRedshift"␊ - /**␊ - * Amazon Redshift linked service properties.␊ - */␊ - typeProperties: (AmazonRedshiftLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Amazon Redshift linked service properties.␊ - */␊ - export interface AmazonRedshiftLinkedServiceTypeProperties {␊ - /**␊ - * The database name of the Amazon Redshift source. Type: string (or Expression with resultType string).␊ - */␊ - database: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * The TCP port number that the Amazon Redshift server uses to listen for client connections. The default value is 5439. Type: integer (or Expression with resultType integer).␊ - */␊ - port?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The name of the Amazon Redshift server. Type: string (or Expression with resultType string).␊ - */␊ - server: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The username of the Amazon Redshift source. Type: string (or Expression with resultType string).␊ - */␊ - username?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Custom linked service.␊ - */␊ - export interface CustomDataSourceLinkedService {␊ - type: "CustomDataSource"␊ - /**␊ - * Custom linked service properties.␊ - */␊ - typeProperties: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service for Windows Azure Search Service.␊ - */␊ - export interface AzureSearchLinkedService {␊ - type: "AzureSearch"␊ - /**␊ - * Windows Azure Search Service linked service properties.␊ - */␊ - typeProperties: (AzureSearchLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Windows Azure Search Service linked service properties.␊ - */␊ - export interface AzureSearchLinkedServiceTypeProperties {␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - key?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * URL for Azure Search service. Type: string (or Expression with resultType string).␊ - */␊ - url: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service for an HTTP source.␊ - */␊ - export interface HttpLinkedService {␊ - type: "HttpServer"␊ - /**␊ - * Properties specific to this linked service type.␊ - */␊ - typeProperties: (HttpLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to this linked service type.␊ - */␊ - export interface HttpLinkedServiceTypeProperties {␊ - /**␊ - * The authentication type to be used to connect to the HTTP server.␊ - */␊ - authenticationType?: (("Basic" | "Anonymous" | "Digest" | "Windows" | "ClientCertificate") | string)␊ - /**␊ - * Thumbprint of certificate for ClientCertificate authentication. Only valid for on-premises copy. For on-premises copy with ClientCertificate authentication, either CertThumbprint or EmbeddedCertData/Password should be specified. Type: string (or Expression with resultType string).␊ - */␊ - certThumbprint?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Base64 encoded certificate data for ClientCertificate authentication. For on-premises copy with ClientCertificate authentication, either CertThumbprint or EmbeddedCertData/Password should be specified. Type: string (or Expression with resultType string).␊ - */␊ - embeddedCertData?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * If true, validate the HTTPS server SSL certificate. Default value is true. Type: boolean (or Expression with resultType boolean).␊ - */␊ - enableServerCertificateValidation?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * The base URL of the HTTP endpoint, e.g. https://www.microsoft.com. Type: string (or Expression with resultType string).␊ - */␊ - url: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * User name for Basic, Digest, or Windows authentication. Type: string (or Expression with resultType string).␊ - */␊ - userName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A FTP server Linked Service.␊ - */␊ - export interface FtpServerLinkedService {␊ - type: "FtpServer"␊ - /**␊ - * Properties specific to this linked service type.␊ - */␊ - typeProperties: (FtpServerLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to this linked service type.␊ - */␊ - export interface FtpServerLinkedServiceTypeProperties {␊ - /**␊ - * The authentication type to be used to connect to the FTP server.␊ - */␊ - authenticationType?: (("Basic" | "Anonymous") | string)␊ - /**␊ - * If true, validate the FTP server SSL certificate when connect over SSL/TLS channel. Default value is true. Type: boolean (or Expression with resultType boolean).␊ - */␊ - enableServerCertificateValidation?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * If true, connect to the FTP server over SSL/TLS channel. Default value is true. Type: boolean (or Expression with resultType boolean).␊ - */␊ - enableSsl?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Host name of the FTP server. Type: string (or Expression with resultType string).␊ - */␊ - host: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * The TCP port number that the FTP server uses to listen for client connections. Default value is 21. Type: integer (or Expression with resultType integer), minimum: 0.␊ - */␊ - port?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Username to logon the FTP server. Type: string (or Expression with resultType string).␊ - */␊ - userName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A linked service for an SSH File Transfer Protocol (SFTP) server. ␊ - */␊ - export interface SftpServerLinkedService {␊ - type: "Sftp"␊ - /**␊ - * Properties specific to this linked service type.␊ - */␊ - typeProperties: (SftpServerLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to this linked service type.␊ - */␊ - export interface SftpServerLinkedServiceTypeProperties {␊ - /**␊ - * The authentication type to be used to connect to the FTP server.␊ - */␊ - authenticationType?: (("Basic" | "SshPublicKey") | string)␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The SFTP server host name. Type: string (or Expression with resultType string).␊ - */␊ - host: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The host key finger-print of the SFTP server. When SkipHostKeyValidation is false, HostKeyFingerprint should be specified. Type: string (or Expression with resultType string).␊ - */␊ - hostKeyFingerprint?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - passPhrase?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * The TCP port number that the SFTP server uses to listen for client connections. Default value is 22. Type: integer (or Expression with resultType integer), minimum: 0.␊ - */␊ - port?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - privateKeyContent?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * The SSH private key file path for SshPublicKey authentication. Only valid for on-premises copy. For on-premises copy with SshPublicKey authentication, either PrivateKeyPath or PrivateKeyContent should be specified. SSH private key should be OpenSSH format. Type: string (or Expression with resultType string).␊ - */␊ - privateKeyPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * If true, skip the SSH host key validation. Default value is false. Type: boolean (or Expression with resultType boolean).␊ - */␊ - skipHostKeyValidation?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The username used to log on to the SFTP server. Type: string (or Expression with resultType string).␊ - */␊ - userName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SAP Business Warehouse Linked Service.␊ - */␊ - export interface SapBWLinkedService {␊ - type: "SapBW"␊ - /**␊ - * Properties specific to this linked service type.␊ - */␊ - typeProperties: (SapBWLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to this linked service type.␊ - */␊ - export interface SapBWLinkedServiceTypeProperties {␊ - /**␊ - * Client ID of the client on the BW system. (Usually a three-digit decimal number represented as a string) Type: string (or Expression with resultType string).␊ - */␊ - clientId: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * Host name of the SAP BW instance. Type: string (or Expression with resultType string).␊ - */␊ - server: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * System number of the BW system. (Usually a two-digit decimal number represented as a string.) Type: string (or Expression with resultType string).␊ - */␊ - systemNumber: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Username to access the SAP BW server. Type: string (or Expression with resultType string).␊ - */␊ - userName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SAP HANA Linked Service.␊ - */␊ - export interface SapHanaLinkedService {␊ - type: "SapHana"␊ - /**␊ - * Properties specific to this linked service type.␊ - */␊ - typeProperties: (SapHanaLinkedServiceProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to this linked service type.␊ - */␊ - export interface SapHanaLinkedServiceProperties {␊ - /**␊ - * The authentication type to be used to connect to the SAP HANA server.␊ - */␊ - authenticationType?: (("Basic" | "Windows") | string)␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * Host name of the SAP HANA server. Type: string (or Expression with resultType string).␊ - */␊ - server: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Username to access the SAP HANA server. Type: string (or Expression with resultType string).␊ - */␊ - userName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Amazon Marketplace Web Service linked service.␊ - */␊ - export interface AmazonMWSLinkedService {␊ - type: "AmazonMWS"␊ - /**␊ - * Amazon Marketplace Web Service linked service properties.␊ - */␊ - typeProperties: (AmazonMWSLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Amazon Marketplace Web Service linked service properties.␊ - */␊ - export interface AmazonMWSLinkedServiceTypeProperties {␊ - /**␊ - * The access key id used to access data.␊ - */␊ - accessKeyId: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The endpoint of the Amazon MWS server, (i.e. mws.amazonservices.com)␊ - */␊ - endpoint: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Amazon Marketplace ID you want to retrieve data from. To retrieve data from multiple Marketplace IDs, separate them with a comma (,). (i.e. A2EUQ1WTGCTBG2)␊ - */␊ - marketplaceID: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - mwsAuthToken?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - secretKey?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * The Amazon seller ID.␊ - */␊ - sellerID: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.␊ - */␊ - useEncryptedEndpoints?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.␊ - */␊ - useHostVerification?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.␊ - */␊ - usePeerVerification?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure PostgreSQL linked service.␊ - */␊ - export interface AzurePostgreSqlLinkedService {␊ - type: "AzurePostgreSql"␊ - /**␊ - * Azure PostgreSQL linked service properties.␊ - */␊ - typeProperties: (AzurePostgreSqlLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure PostgreSQL linked service properties.␊ - */␊ - export interface AzurePostgreSqlLinkedServiceTypeProperties {␊ - /**␊ - * An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.␊ - */␊ - connectionString?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Concur Service linked service.␊ - */␊ - export interface ConcurLinkedService {␊ - type: "Concur"␊ - /**␊ - * Concur Service linked service properties.␊ - */␊ - typeProperties: (ConcurLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Concur Service linked service properties.␊ - */␊ - export interface ConcurLinkedServiceTypeProperties {␊ - /**␊ - * Application client_id supplied by Concur App Management.␊ - */␊ - clientId: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.␊ - */␊ - useEncryptedEndpoints?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.␊ - */␊ - useHostVerification?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.␊ - */␊ - usePeerVerification?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The user name that you use to access Concur Service.␊ - */␊ - username: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Couchbase server linked service.␊ - */␊ - export interface CouchbaseLinkedService {␊ - type: "Couchbase"␊ - /**␊ - * Couchbase server linked service properties.␊ - */␊ - typeProperties: (CouchbaseLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Couchbase server linked service properties.␊ - */␊ - export interface CouchbaseLinkedServiceTypeProperties {␊ - /**␊ - * An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.␊ - */␊ - connectionString?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Drill server linked service.␊ - */␊ - export interface DrillLinkedService {␊ - type: "Drill"␊ - /**␊ - * Drill server linked service properties.␊ - */␊ - typeProperties: (DrillLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Drill server linked service properties.␊ - */␊ - export interface DrillLinkedServiceTypeProperties {␊ - /**␊ - * An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.␊ - */␊ - connectionString?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Eloqua server linked service.␊ - */␊ - export interface EloquaLinkedService {␊ - type: "Eloqua"␊ - /**␊ - * Eloqua server linked service properties.␊ - */␊ - typeProperties: (EloquaLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Eloqua server linked service properties.␊ - */␊ - export interface EloquaLinkedServiceTypeProperties {␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The endpoint of the Eloqua server. (i.e. eloqua.example.com)␊ - */␊ - endpoint: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.␊ - */␊ - useEncryptedEndpoints?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.␊ - */␊ - useHostVerification?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.␊ - */␊ - usePeerVerification?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The site name and user name of your Eloqua account in the form: sitename/username. (i.e. Eloqua/Alice)␊ - */␊ - username: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Google BigQuery service linked service.␊ - */␊ - export interface GoogleBigQueryLinkedService {␊ - type: "GoogleBigQuery"␊ - /**␊ - * Google BigQuery service linked service properties.␊ - */␊ - typeProperties: (GoogleBigQueryLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Google BigQuery service linked service properties.␊ - */␊ - export interface GoogleBigQueryLinkedServiceTypeProperties {␊ - /**␊ - * A comma-separated list of public BigQuery projects to access.␊ - */␊ - additionalProjects?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR.␊ - */␊ - authenticationType: (("ServiceAuthentication" | "UserAuthentication") | string)␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - clientId?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - clientSecret?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * The service account email ID that is used for ServiceAuthentication and can only be used on self-hosted IR.␊ - */␊ - email?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The full path to the .p12 key file that is used to authenticate the service account email address and can only be used on self-hosted IR.␊ - */␊ - keyFilePath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The default BigQuery project to query against.␊ - */␊ - project: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - refreshToken?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * Whether to request access to Google Drive. Allowing Google Drive access enables support for federated tables that combine BigQuery data with data from Google Drive. The default value is false.␊ - */␊ - requestGoogleDriveScope?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.␊ - */␊ - trustedCertPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.␊ - */␊ - useSystemTrustStore?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Greenplum Database linked service.␊ - */␊ - export interface GreenplumLinkedService {␊ - type: "Greenplum"␊ - /**␊ - * Greenplum Database linked service properties.␊ - */␊ - typeProperties: (GreenplumLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Greenplum Database linked service properties.␊ - */␊ - export interface GreenplumLinkedServiceTypeProperties {␊ - /**␊ - * An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.␊ - */␊ - connectionString?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HBase server linked service.␊ - */␊ - export interface HBaseLinkedService {␊ - type: "HBase"␊ - /**␊ - * HBase server linked service properties.␊ - */␊ - typeProperties: (HBaseLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HBase server linked service properties.␊ - */␊ - export interface HBaseLinkedServiceTypeProperties {␊ - /**␊ - * Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.␊ - */␊ - allowHostNameCNMismatch?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to allow self-signed certificates from the server. The default value is false.␊ - */␊ - allowSelfSignedServerCert?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The authentication mechanism to use to connect to the HBase server.␊ - */␊ - authenticationType: (("Anonymous" | "Basic") | string)␊ - /**␊ - * Specifies whether the connections to the server are encrypted using SSL. The default value is false.␊ - */␊ - enableSsl?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The IP address or host name of the HBase server. (i.e. 192.168.222.160)␊ - */␊ - host: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The partial URL corresponding to the HBase server. (i.e. /gateway/sandbox/hbase/version)␊ - */␊ - httpPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * The TCP port that the HBase instance uses to listen for client connections. The default value is 9090.␊ - */␊ - port?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.␊ - */␊ - trustedCertPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The user name used to connect to the HBase instance.␊ - */␊ - username?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Hive Server linked service.␊ - */␊ - export interface HiveLinkedService {␊ - type: "Hive"␊ - /**␊ - * Hive Server linked service properties.␊ - */␊ - typeProperties: (HiveLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Hive Server linked service properties.␊ - */␊ - export interface HiveLinkedServiceTypeProperties {␊ - /**␊ - * Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.␊ - */␊ - allowHostNameCNMismatch?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to allow self-signed certificates from the server. The default value is false.␊ - */␊ - allowSelfSignedServerCert?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The authentication method used to access the Hive server.␊ - */␊ - authenticationType: (("Anonymous" | "Username" | "UsernameAndPassword" | "WindowsAzureHDInsightService") | string)␊ - /**␊ - * Specifies whether the connections to the server are encrypted using SSL. The default value is false.␊ - */␊ - enableSsl?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP address or host name of the Hive server, separated by ';' for multiple hosts (only when serviceDiscoveryMode is enable).␊ - */␊ - host: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The partial URL corresponding to the Hive server.␊ - */␊ - httpPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * The TCP port that the Hive server uses to listen for client connections.␊ - */␊ - port?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The type of Hive server.␊ - */␊ - serverType?: (("HiveServer1" | "HiveServer2" | "HiveThriftServer") | string)␊ - /**␊ - * true to indicate using the ZooKeeper service, false not.␊ - */␊ - serviceDiscoveryMode?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The transport protocol to use in the Thrift layer.␊ - */␊ - thriftTransportProtocol?: (("Binary" | "SASL" | "HTTP ") | string)␊ - /**␊ - * The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.␊ - */␊ - trustedCertPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether the driver uses native HiveQL queries,or converts them into an equivalent form in HiveQL.␊ - */␊ - useNativeQuery?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The user name that you use to access Hive Server.␊ - */␊ - username?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.␊ - */␊ - useSystemTrustStore?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The namespace on ZooKeeper under which Hive Server 2 nodes are added.␊ - */␊ - zooKeeperNameSpace?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Hubspot Service linked service.␊ - */␊ - export interface HubspotLinkedService {␊ - type: "Hubspot"␊ - /**␊ - * Hubspot Service linked service properties.␊ - */␊ - typeProperties: (HubspotLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Hubspot Service linked service properties.␊ - */␊ - export interface HubspotLinkedServiceTypeProperties {␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - accessToken?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * The client ID associated with your Hubspot application.␊ - */␊ - clientId: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - clientSecret?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - refreshToken?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.␊ - */␊ - useEncryptedEndpoints?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.␊ - */␊ - useHostVerification?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.␊ - */␊ - usePeerVerification?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Impala server linked service.␊ - */␊ - export interface ImpalaLinkedService {␊ - type: "Impala"␊ - /**␊ - * Impala server linked service properties.␊ - */␊ - typeProperties: (ImpalaLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Impala server linked service properties.␊ - */␊ - export interface ImpalaLinkedServiceTypeProperties {␊ - /**␊ - * Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.␊ - */␊ - allowHostNameCNMismatch?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to allow self-signed certificates from the server. The default value is false.␊ - */␊ - allowSelfSignedServerCert?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The authentication type to use.␊ - */␊ - authenticationType: (("Anonymous" | "SASLUsername" | "UsernameAndPassword") | string)␊ - /**␊ - * Specifies whether the connections to the server are encrypted using SSL. The default value is false.␊ - */␊ - enableSsl?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The IP address or host name of the Impala server. (i.e. 192.168.222.160)␊ - */␊ - host: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * The TCP port that the Impala server uses to listen for client connections. The default value is 21050.␊ - */␊ - port?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.␊ - */␊ - trustedCertPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The user name used to access the Impala server. The default value is anonymous when using SASLUsername.␊ - */␊ - username?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.␊ - */␊ - useSystemTrustStore?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Jira Service linked service.␊ - */␊ - export interface JiraLinkedService {␊ - type: "Jira"␊ - /**␊ - * Jira Service linked service properties.␊ - */␊ - typeProperties: (JiraLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Jira Service linked service properties.␊ - */␊ - export interface JiraLinkedServiceTypeProperties {␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The IP address or host name of the Jira service. (e.g. jira.example.com)␊ - */␊ - host: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * The TCP port that the Jira server uses to listen for client connections. The default value is 443 if connecting through HTTPS, or 8080 if connecting through HTTP.␊ - */␊ - port?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.␊ - */␊ - useEncryptedEndpoints?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.␊ - */␊ - useHostVerification?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.␊ - */␊ - usePeerVerification?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The user name that you use to access Jira Service.␊ - */␊ - username: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Magento server linked service.␊ - */␊ - export interface MagentoLinkedService {␊ - type: "Magento"␊ - /**␊ - * Magento server linked service properties.␊ - */␊ - typeProperties: (MagentoLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Magento server linked service properties.␊ - */␊ - export interface MagentoLinkedServiceTypeProperties {␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - accessToken?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The URL of the Magento instance. (i.e. 192.168.222.110/magento3)␊ - */␊ - host: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.␊ - */␊ - useEncryptedEndpoints?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.␊ - */␊ - useHostVerification?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.␊ - */␊ - usePeerVerification?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * MariaDB server linked service.␊ - */␊ - export interface MariaDBLinkedService {␊ - type: "MariaDB"␊ - /**␊ - * MariaDB server linked service properties.␊ - */␊ - typeProperties: (MariaDBLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * MariaDB server linked service properties.␊ - */␊ - export interface MariaDBLinkedServiceTypeProperties {␊ - /**␊ - * An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.␊ - */␊ - connectionString?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Marketo server linked service.␊ - */␊ - export interface MarketoLinkedService {␊ - type: "Marketo"␊ - /**␊ - * Marketo server linked service properties.␊ - */␊ - typeProperties: (MarketoLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Marketo server linked service properties.␊ - */␊ - export interface MarketoLinkedServiceTypeProperties {␊ - /**␊ - * The client Id of your Marketo service.␊ - */␊ - clientId: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - clientSecret?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The endpoint of the Marketo server. (i.e. 123-ABC-321.mktorest.com)␊ - */␊ - endpoint: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.␊ - */␊ - useEncryptedEndpoints?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.␊ - */␊ - useHostVerification?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.␊ - */␊ - usePeerVerification?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Paypal Service linked service.␊ - */␊ - export interface PaypalLinkedService {␊ - type: "Paypal"␊ - /**␊ - * Paypal Service linked service properties.␊ - */␊ - typeProperties: (PaypalLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Paypal Service linked service properties.␊ - */␊ - export interface PaypalLinkedServiceTypeProperties {␊ - /**␊ - * The client ID associated with your PayPal application.␊ - */␊ - clientId: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - clientSecret?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The URL of the PayPal instance. (i.e. api.sandbox.paypal.com)␊ - */␊ - host: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.␊ - */␊ - useEncryptedEndpoints?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.␊ - */␊ - useHostVerification?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.␊ - */␊ - usePeerVerification?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Phoenix server linked service.␊ - */␊ - export interface PhoenixLinkedService {␊ - type: "Phoenix"␊ - /**␊ - * Phoenix server linked service properties.␊ - */␊ - typeProperties: (PhoenixLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Phoenix server linked service properties.␊ - */␊ - export interface PhoenixLinkedServiceTypeProperties {␊ - /**␊ - * Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.␊ - */␊ - allowHostNameCNMismatch?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to allow self-signed certificates from the server. The default value is false.␊ - */␊ - allowSelfSignedServerCert?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The authentication mechanism used to connect to the Phoenix server.␊ - */␊ - authenticationType: (("Anonymous" | "UsernameAndPassword" | "WindowsAzureHDInsightService") | string)␊ - /**␊ - * Specifies whether the connections to the server are encrypted using SSL. The default value is false.␊ - */␊ - enableSsl?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The IP address or host name of the Phoenix server. (i.e. 192.168.222.160)␊ - */␊ - host: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The partial URL corresponding to the Phoenix server. (i.e. /gateway/sandbox/phoenix/version). The default value is hbasephoenix if using WindowsAzureHDInsightService.␊ - */␊ - httpPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * The TCP port that the Phoenix server uses to listen for client connections. The default value is 8765.␊ - */␊ - port?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.␊ - */␊ - trustedCertPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The user name used to connect to the Phoenix server.␊ - */␊ - username?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.␊ - */␊ - useSystemTrustStore?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Presto server linked service.␊ - */␊ - export interface PrestoLinkedService {␊ - type: "Presto"␊ - /**␊ - * Presto server linked service properties.␊ - */␊ - typeProperties: (PrestoLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Presto server linked service properties.␊ - */␊ - export interface PrestoLinkedServiceTypeProperties {␊ - /**␊ - * Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.␊ - */␊ - allowHostNameCNMismatch?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to allow self-signed certificates from the server. The default value is false.␊ - */␊ - allowSelfSignedServerCert?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The authentication mechanism used to connect to the Presto server.␊ - */␊ - authenticationType: (("Anonymous" | "LDAP") | string)␊ - /**␊ - * The catalog context for all request against the server.␊ - */␊ - catalog: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether the connections to the server are encrypted using SSL. The default value is false.␊ - */␊ - enableSsl?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The IP address or host name of the Presto server. (i.e. 192.168.222.160)␊ - */␊ - host: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * The TCP port that the Presto server uses to listen for client connections. The default value is 8080.␊ - */␊ - port?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The version of the Presto server. (i.e. 0.148-t)␊ - */␊ - serverVersion: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The local time zone used by the connection. Valid values for this option are specified in the IANA Time Zone Database. The default value is the system time zone.␊ - */␊ - timeZoneID?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.␊ - */␊ - trustedCertPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The user name used to connect to the Presto server.␊ - */␊ - username?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.␊ - */␊ - useSystemTrustStore?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * QuickBooks server linked service.␊ - */␊ - export interface QuickBooksLinkedService {␊ - type: "QuickBooks"␊ - /**␊ - * QuickBooks server linked service properties.␊ - */␊ - typeProperties: (QuickBooksLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * QuickBooks server linked service properties.␊ - */␊ - export interface QuickBooksLinkedServiceTypeProperties {␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - accessToken: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - accessTokenSecret: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * The company ID of the QuickBooks company to authorize.␊ - */␊ - companyId: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The consumer key for OAuth 1.0 authentication.␊ - */␊ - consumerKey: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - consumerSecret: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The endpoint of the QuickBooks server. (i.e. quickbooks.api.intuit.com)␊ - */␊ - endpoint: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.␊ - */␊ - useEncryptedEndpoints?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ServiceNow server linked service.␊ - */␊ - export interface ServiceNowLinkedService {␊ - type: "ServiceNow"␊ - /**␊ - * ServiceNow server linked service properties.␊ - */␊ - typeProperties: (ServiceNowLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ServiceNow server linked service properties.␊ - */␊ - export interface ServiceNowLinkedServiceTypeProperties {␊ - /**␊ - * The authentication type to use.␊ - */␊ - authenticationType: (("Basic" | "OAuth2") | string)␊ - /**␊ - * The client id for OAuth2 authentication.␊ - */␊ - clientId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - clientSecret?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The endpoint of the ServiceNow server. (i.e. .service-now.com)␊ - */␊ - endpoint: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.␊ - */␊ - useEncryptedEndpoints?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.␊ - */␊ - useHostVerification?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.␊ - */␊ - usePeerVerification?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The user name used to connect to the ServiceNow server for Basic and OAuth2 authentication.␊ - */␊ - username?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Shopify Service linked service.␊ - */␊ - export interface ShopifyLinkedService {␊ - type: "Shopify"␊ - /**␊ - * Shopify Service linked service properties.␊ - */␊ - typeProperties: (ShopifyLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Shopify Service linked service properties.␊ - */␊ - export interface ShopifyLinkedServiceTypeProperties {␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - accessToken?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The endpoint of the Shopify server. (i.e. mystore.myshopify.com)␊ - */␊ - host: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.␊ - */␊ - useEncryptedEndpoints?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.␊ - */␊ - useHostVerification?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.␊ - */␊ - usePeerVerification?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Spark Server linked service.␊ - */␊ - export interface SparkLinkedService {␊ - type: "Spark"␊ - /**␊ - * Spark Server linked service properties.␊ - */␊ - typeProperties: (SparkLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Spark Server linked service properties.␊ - */␊ - export interface SparkLinkedServiceTypeProperties {␊ - /**␊ - * Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.␊ - */␊ - allowHostNameCNMismatch?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to allow self-signed certificates from the server. The default value is false.␊ - */␊ - allowSelfSignedServerCert?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The authentication method used to access the Spark server.␊ - */␊ - authenticationType: (("Anonymous" | "Username" | "UsernameAndPassword" | "WindowsAzureHDInsightService") | string)␊ - /**␊ - * Specifies whether the connections to the server are encrypted using SSL. The default value is false.␊ - */␊ - enableSsl?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP address or host name of the Spark server␊ - */␊ - host: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The partial URL corresponding to the Spark server.␊ - */␊ - httpPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * The TCP port that the Spark server uses to listen for client connections.␊ - */␊ - port: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The type of Spark server.␊ - */␊ - serverType?: (("SharkServer" | "SharkServer2" | "SparkThriftServer") | string)␊ - /**␊ - * The transport protocol to use in the Thrift layer.␊ - */␊ - thriftTransportProtocol?: (("Binary" | "SASL" | "HTTP ") | string)␊ - /**␊ - * The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.␊ - */␊ - trustedCertPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The user name that you use to access Spark Server.␊ - */␊ - username?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.␊ - */␊ - useSystemTrustStore?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Square Service linked service.␊ - */␊ - export interface SquareLinkedService {␊ - type: "Square"␊ - /**␊ - * Square Service linked service properties.␊ - */␊ - typeProperties: (SquareLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Square Service linked service properties.␊ - */␊ - export interface SquareLinkedServiceTypeProperties {␊ - /**␊ - * The client ID associated with your Square application.␊ - */␊ - clientId: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - clientSecret?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The URL of the Square instance. (i.e. mystore.mysquare.com)␊ - */␊ - host: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The redirect URL assigned in the Square application dashboard. (i.e. http://localhost:2500)␊ - */␊ - redirectUri: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.␊ - */␊ - useEncryptedEndpoints?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.␊ - */␊ - useHostVerification?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.␊ - */␊ - usePeerVerification?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Xero Service linked service.␊ - */␊ - export interface XeroLinkedService {␊ - type: "Xero"␊ - /**␊ - * Xero Service linked service properties.␊ - */␊ - typeProperties: (XeroLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Xero Service linked service properties.␊ - */␊ - export interface XeroLinkedServiceTypeProperties {␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - consumerKey?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The endpoint of the Xero server. (i.e. api.xero.com)␊ - */␊ - host: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - privateKey?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.␊ - */␊ - useEncryptedEndpoints?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.␊ - */␊ - useHostVerification?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.␊ - */␊ - usePeerVerification?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Zoho server linked service.␊ - */␊ - export interface ZohoLinkedService {␊ - type: "Zoho"␊ - /**␊ - * Zoho server linked service properties.␊ - */␊ - typeProperties: (ZohoLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Zoho server linked service properties.␊ - */␊ - export interface ZohoLinkedServiceTypeProperties {␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - accessToken?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The endpoint of the Zoho server. (i.e. crm.zoho.com/crm/private)␊ - */␊ - endpoint: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.␊ - */␊ - useEncryptedEndpoints?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.␊ - */␊ - useHostVerification?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.␊ - */␊ - usePeerVerification?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Vertica linked service.␊ - */␊ - export interface VerticaLinkedService {␊ - type: "Vertica"␊ - /**␊ - * Vertica linked service properties.␊ - */␊ - typeProperties: (VerticaLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Vertica linked service properties.␊ - */␊ - export interface VerticaLinkedServiceTypeProperties {␊ - /**␊ - * An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.␊ - */␊ - connectionString?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Netezza linked service.␊ - */␊ - export interface NetezzaLinkedService {␊ - type: "Netezza"␊ - /**␊ - * Netezza linked service properties.␊ - */␊ - typeProperties: (NetezzaLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Netezza linked service properties.␊ - */␊ - export interface NetezzaLinkedServiceTypeProperties {␊ - /**␊ - * An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.␊ - */␊ - connectionString?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Salesforce Marketing Cloud linked service.␊ - */␊ - export interface SalesforceMarketingCloudLinkedService {␊ - type: "SalesforceMarketingCloud"␊ - /**␊ - * Salesforce Marketing Cloud linked service properties.␊ - */␊ - typeProperties: (SalesforceMarketingCloudLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Salesforce Marketing Cloud linked service properties.␊ - */␊ - export interface SalesforceMarketingCloudLinkedServiceTypeProperties {␊ - /**␊ - * The client ID associated with the Salesforce Marketing Cloud application. Type: string (or Expression with resultType string).␊ - */␊ - clientId: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - clientSecret?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean).␊ - */␊ - useEncryptedEndpoints?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).␊ - */␊ - useHostVerification?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).␊ - */␊ - usePeerVerification?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HDInsight ondemand linked service.␊ - */␊ - export interface HDInsightOnDemandLinkedService {␊ - type: "HDInsightOnDemand"␊ - /**␊ - * HDInsight ondemand linked service properties.␊ - */␊ - typeProperties: (HDInsightOnDemandLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HDInsight ondemand linked service properties.␊ - */␊ - export interface HDInsightOnDemandLinkedServiceTypeProperties {␊ - /**␊ - * Specifies additional storage accounts for the HDInsight linked service so that the Data Factory service can register them on your behalf.␊ - */␊ - additionalLinkedServiceNames?: (LinkedServiceReference[] | string)␊ - /**␊ - * The prefix of cluster name, postfix will be distinct with timestamp. Type: string (or Expression with resultType string).␊ - */␊ - clusterNamePrefix?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - clusterPassword?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * The resource group where the cluster belongs. Type: string (or Expression with resultType string).␊ - */␊ - clusterResourceGroup: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Number of worker/data nodes in the cluster. Suggestion value: 4. Type: string (or Expression with resultType string).␊ - */␊ - clusterSize: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - clusterSshPassword?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * The username to SSH remotely connect to cluster’s node (for Linux). Type: string (or Expression with resultType string).␊ - */␊ - clusterSshUserName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The cluster type. Type: string (or Expression with resultType string).␊ - */␊ - clusterType?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The username to access the cluster. Type: string (or Expression with resultType string).␊ - */␊ - clusterUserName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the core configuration parameters (as in core-site.xml) for the HDInsight cluster to be created.␊ - */␊ - coreConfiguration?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the size of the data node for the HDInsight cluster.␊ - */␊ - dataNodeSize?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the HBase configuration parameters (hbase-site.xml) for the HDInsight cluster.␊ - */␊ - hBaseConfiguration?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service reference type.␊ - */␊ - hcatalogLinkedServiceName?: (LinkedServiceReference | string)␊ - /**␊ - * Specifies the HDFS configuration parameters (hdfs-site.xml) for the HDInsight cluster.␊ - */␊ - hdfsConfiguration?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the size of the head node for the HDInsight cluster.␊ - */␊ - headNodeSize?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the hive configuration parameters (hive-site.xml) for the HDInsight cluster.␊ - */␊ - hiveConfiguration?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The customer’s subscription to host the cluster. Type: string (or Expression with resultType string).␊ - */␊ - hostSubscriptionId: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service reference type.␊ - */␊ - linkedServiceName: (LinkedServiceReference | string)␊ - /**␊ - * Specifies the MapReduce configuration parameters (mapred-site.xml) for the HDInsight cluster.␊ - */␊ - mapReduceConfiguration?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the Oozie configuration parameters (oozie-site.xml) for the HDInsight cluster.␊ - */␊ - oozieConfiguration?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The service principal id for the hostSubscriptionId. Type: string (or Expression with resultType string).␊ - */␊ - servicePrincipalId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - servicePrincipalKey?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * The version of spark if the cluster type is 'spark'. Type: string (or Expression with resultType string).␊ - */␊ - sparkVersion?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the Storm configuration parameters (storm-site.xml) for the HDInsight cluster.␊ - */␊ - stormConfiguration?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Tenant id/name to which the service principal belongs. Type: string (or Expression with resultType string).␊ - */␊ - tenant: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The allowed idle time for the on-demand HDInsight cluster. Specifies how long the on-demand HDInsight cluster stays alive after completion of an activity run if there are no other active jobs in the cluster. The minimum value is 5 mins. Type: string (or Expression with resultType string).␊ - */␊ - timeToLive: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Version of the HDInsight cluster.  Type: string (or Expression with resultType string).␊ - */␊ - version: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the Yarn configuration parameters (yarn-site.xml) for the HDInsight cluster.␊ - */␊ - yarnConfiguration?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the size of the Zoo Keeper node for the HDInsight cluster.␊ - */␊ - zookeeperNodeSize?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Data Lake Analytics linked service.␊ - */␊ - export interface AzureDataLakeAnalyticsLinkedService {␊ - type: "AzureDataLakeAnalytics"␊ - /**␊ - * Azure Data Lake Analytics linked service properties.␊ - */␊ - typeProperties: (AzureDataLakeAnalyticsLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Data Lake Analytics linked service properties.␊ - */␊ - export interface AzureDataLakeAnalyticsLinkedServiceTypeProperties {␊ - /**␊ - * The Azure Data Lake Analytics account name. Type: string (or Expression with resultType string).␊ - */␊ - accountName: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Data Lake Analytics URI Type: string (or Expression with resultType string).␊ - */␊ - dataLakeAnalyticsUri?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Data Lake Analytics account resource group name (if different from Data Factory account). Type: string (or Expression with resultType string).␊ - */␊ - resourceGroupName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The ID of the application used to authenticate against the Azure Data Lake Analytics account. Type: string (or Expression with resultType string).␊ - */␊ - servicePrincipalId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - servicePrincipalKey?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * Data Lake Analytics account subscription ID (if different from Data Factory account). Type: string (or Expression with resultType string).␊ - */␊ - subscriptionId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).␊ - */␊ - tenant: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Databricks linked service.␊ - */␊ - export interface AzureDatabricksLinkedService {␊ - type: "AzureDatabricks"␊ - /**␊ - * Azure Databricks linked service properties.␊ - */␊ - typeProperties: (AzureDatabricksLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Databricks linked service properties.␊ - */␊ - export interface AzureDatabricksLinkedServiceTypeProperties {␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - accessToken: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * .azuredatabricks.net, domain name of your Databricks deployment. Type: string (or Expression with resultType string).␊ - */␊ - domain: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The id of an existing cluster that will be used for all runs of this job. Type: string (or Expression with resultType string).␊ - */␊ - existingClusterId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The node types of new cluster. Type: string (or Expression with resultType string).␊ - */␊ - newClusterNodeType?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Number of worker nodes that new cluster should have. A string formatted Int32, like '1' means numOfWorker is 1 or '1:10' means auto-scale from 1 as min and 10 as max. Type: string (or Expression with resultType string).␊ - */␊ - newClusterNumOfWorker?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * a set of optional, user-specified Spark configuration key-value pairs.␊ - */␊ - newClusterSparkConf?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * The Spark version of new cluster. Type: string (or Expression with resultType string).␊ - */␊ - newClusterVersion?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Responsys linked service.␊ - */␊ - export interface ResponsysLinkedService {␊ - type: "Responsys"␊ - /**␊ - * Responsys linked service properties.␊ - */␊ - typeProperties: (ResponsysLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Responsys linked service properties.␊ - */␊ - export interface ResponsysLinkedServiceTypeProperties {␊ - /**␊ - * The client ID associated with the Responsys application. Type: string (or Expression with resultType string).␊ - */␊ - clientId: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - clientSecret?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The endpoint of the Responsys server.␊ - */␊ - endpoint: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean).␊ - */␊ - useEncryptedEndpoints?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).␊ - */␊ - useHostVerification?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).␊ - */␊ - usePeerVerification?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataFactory/factories/datasets␊ - */␊ - export interface FactoriesDatasetsChildResource {␊ - apiVersion: "2017-09-01-preview"␊ - /**␊ - * The dataset name.␊ - */␊ - name: string␊ - /**␊ - * The Azure Data Factory nested object which identifies data within different data stores, such as tables, files, folders, and documents.␊ - */␊ - properties: (Dataset | string)␊ - type: "datasets"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A single Amazon Simple Storage Service (S3) object or a set of S3 objects.␊ - */␊ - export interface AmazonS3Dataset {␊ - type: "AmazonS3Object"␊ - /**␊ - * Amazon S3 dataset properties.␊ - */␊ - typeProperties: (AmazonS3DatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Amazon S3 dataset properties.␊ - */␊ - export interface AmazonS3DatasetTypeProperties {␊ - /**␊ - * The name of the Amazon S3 bucket. Type: string (or Expression with resultType string).␊ - */␊ - bucketName: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The compression method used on a dataset.␊ - */␊ - compression?: (DatasetCompression | string)␊ - /**␊ - * The format definition of a storage.␊ - */␊ - format?: (DatasetStorageFormat | string)␊ - /**␊ - * The key of the Amazon S3 object. Type: string (or Expression with resultType string).␊ - */␊ - key?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The prefix filter for the S3 object name. Type: string (or Expression with resultType string).␊ - */␊ - prefix?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The version for the S3 object. Type: string (or Expression with resultType string).␊ - */␊ - version?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The BZip2 compression method used on a dataset.␊ - */␊ - export interface DatasetBZip2Compression {␊ - type: "BZip2"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The GZip compression method used on a dataset.␊ - */␊ - export interface DatasetGZipCompression {␊ - /**␊ - * The GZip compression level.␊ - */␊ - level?: (("Optimal" | "Fastest") | string)␊ - type: "GZip"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Deflate compression method used on a dataset.␊ - */␊ - export interface DatasetDeflateCompression {␊ - /**␊ - * The Deflate compression level.␊ - */␊ - level?: (("Optimal" | "Fastest") | string)␊ - type: "Deflate"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The ZipDeflate compression method used on a dataset.␊ - */␊ - export interface DatasetZipDeflateCompression {␊ - /**␊ - * The ZipDeflate compression level.␊ - */␊ - level?: (("Optimal" | "Fastest") | string)␊ - type: "ZipDeflate"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The format definition of a storage.␊ - */␊ - export interface DatasetStorageFormat {␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Deserializer. Type: string (or Expression with resultType string).␊ - */␊ - deserializer?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Serializer. Type: string (or Expression with resultType string).␊ - */␊ - serializer?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Azure Blob storage.␊ - */␊ - export interface AzureBlobDataset {␊ - type: "AzureBlob"␊ - /**␊ - * Azure Blob dataset properties.␊ - */␊ - typeProperties: (AzureBlobDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Blob dataset properties.␊ - */␊ - export interface AzureBlobDatasetTypeProperties {␊ - /**␊ - * The compression method used on a dataset.␊ - */␊ - compression?: ((DatasetBZip2Compression | DatasetGZipCompression | DatasetDeflateCompression | DatasetZipDeflateCompression) | string)␊ - /**␊ - * The name of the Azure Blob. Type: string (or Expression with resultType string).␊ - */␊ - fileName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The path of the Azure Blob storage. Type: string (or Expression with resultType string).␊ - */␊ - folderPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The format definition of a storage.␊ - */␊ - format?: (DatasetStorageFormat | string)␊ - /**␊ - * The root of blob path. Type: string (or Expression with resultType string).␊ - */␊ - tableRootLocation?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Azure Table storage dataset.␊ - */␊ - export interface AzureTableDataset {␊ - type: "AzureTable"␊ - /**␊ - * Azure Table dataset properties.␊ - */␊ - typeProperties: (AzureTableDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Table dataset properties.␊ - */␊ - export interface AzureTableDatasetTypeProperties {␊ - /**␊ - * The table name of the Azure Table storage. Type: string (or Expression with resultType string).␊ - */␊ - tableName: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Azure SQL Server database dataset.␊ - */␊ - export interface AzureSqlTableDataset {␊ - type: "AzureSqlTable"␊ - /**␊ - * Azure SQL dataset properties.␊ - */␊ - typeProperties: (AzureSqlTableDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure SQL dataset properties.␊ - */␊ - export interface AzureSqlTableDatasetTypeProperties {␊ - /**␊ - * The table name of the Azure SQL database. Type: string (or Expression with resultType string).␊ - */␊ - tableName: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Azure SQL Data Warehouse dataset.␊ - */␊ - export interface AzureSqlDWTableDataset {␊ - type: "AzureSqlDWTable"␊ - /**␊ - * Azure SQL Data Warehouse dataset properties.␊ - */␊ - typeProperties: (AzureSqlDWTableDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure SQL Data Warehouse dataset properties.␊ - */␊ - export interface AzureSqlDWTableDatasetTypeProperties {␊ - /**␊ - * The table name of the Azure SQL Data Warehouse. Type: string (or Expression with resultType string).␊ - */␊ - tableName: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Cassandra database dataset.␊ - */␊ - export interface CassandraTableDataset {␊ - type: "CassandraTable"␊ - /**␊ - * Cassandra dataset properties.␊ - */␊ - typeProperties: (CassandraTableDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Cassandra dataset properties.␊ - */␊ - export interface CassandraTableDatasetTypeProperties {␊ - /**␊ - * The keyspace of the Cassandra database. Type: string (or Expression with resultType string).␊ - */␊ - keyspace?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The table name of the Cassandra database. Type: string (or Expression with resultType string).␊ - */␊ - tableName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft Azure Document Database Collection dataset.␊ - */␊ - export interface DocumentDbCollectionDataset {␊ - type: "DocumentDbCollection"␊ - /**␊ - * DocumentDB Collection dataset properties.␊ - */␊ - typeProperties: (DocumentDbCollectionDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DocumentDB Collection dataset properties.␊ - */␊ - export interface DocumentDbCollectionDatasetTypeProperties {␊ - /**␊ - * Document Database collection name. Type: string (or Expression with resultType string).␊ - */␊ - collectionName: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Dynamics entity dataset.␊ - */␊ - export interface DynamicsEntityDataset {␊ - type: "DynamicsEntity"␊ - /**␊ - * Dynamics entity dataset properties.␊ - */␊ - typeProperties: (DynamicsEntityDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Dynamics entity dataset properties.␊ - */␊ - export interface DynamicsEntityDatasetTypeProperties {␊ - /**␊ - * The logical name of the entity. Type: string (or Expression with resultType string).␊ - */␊ - entityName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Data Lake Store dataset.␊ - */␊ - export interface AzureDataLakeStoreDataset {␊ - type: "AzureDataLakeStoreFile"␊ - /**␊ - * Azure Data Lake Store dataset properties.␊ - */␊ - typeProperties: (AzureDataLakeStoreDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Data Lake Store dataset properties.␊ - */␊ - export interface AzureDataLakeStoreDatasetTypeProperties {␊ - /**␊ - * The compression method used on a dataset.␊ - */␊ - compression?: ((DatasetBZip2Compression | DatasetGZipCompression | DatasetDeflateCompression | DatasetZipDeflateCompression) | string)␊ - /**␊ - * The name of the file in the Azure Data Lake Store. Type: string (or Expression with resultType string).␊ - */␊ - fileName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Path to the folder in the Azure Data Lake Store. Type: string (or Expression with resultType string).␊ - */␊ - folderPath: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The format definition of a storage.␊ - */␊ - format?: (DatasetStorageFormat | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An on-premises file system dataset.␊ - */␊ - export interface FileShareDataset {␊ - type: "FileShare"␊ - /**␊ - * On-premises file system dataset properties.␊ - */␊ - typeProperties: (FileShareDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * On-premises file system dataset properties.␊ - */␊ - export interface FileShareDatasetTypeProperties {␊ - /**␊ - * The compression method used on a dataset.␊ - */␊ - compression?: ((DatasetBZip2Compression | DatasetGZipCompression | DatasetDeflateCompression | DatasetZipDeflateCompression) | string)␊ - /**␊ - * Specify a filter to be used to select a subset of files in the folderPath rather than all files. Type: string (or Expression with resultType string).␊ - */␊ - fileFilter?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The name of the on-premises file system. Type: string (or Expression with resultType string).␊ - */␊ - fileName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The path of the on-premises file system. Type: string (or Expression with resultType string).␊ - */␊ - folderPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The format definition of a storage.␊ - */␊ - format?: (DatasetStorageFormat | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The MongoDB database dataset.␊ - */␊ - export interface MongoDbCollectionDataset {␊ - type: "MongoDbCollection"␊ - /**␊ - * MongoDB database dataset properties.␊ - */␊ - typeProperties: (MongoDbCollectionDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * MongoDB database dataset properties.␊ - */␊ - export interface MongoDbCollectionDatasetTypeProperties {␊ - /**␊ - * The table name of the MongoDB database. Type: string (or Expression with resultType string).␊ - */␊ - collectionName: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Open Data Protocol (OData) resource dataset.␊ - */␊ - export interface ODataResourceDataset {␊ - type: "ODataResource"␊ - /**␊ - * OData dataset properties.␊ - */␊ - typeProperties: (ODataResourceDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * OData dataset properties.␊ - */␊ - export interface ODataResourceDatasetTypeProperties {␊ - /**␊ - * The OData resource path. Type: string (or Expression with resultType string).␊ - */␊ - path?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The on-premises Oracle database dataset.␊ - */␊ - export interface OracleTableDataset {␊ - type: "OracleTable"␊ - /**␊ - * On-premises Oracle dataset properties.␊ - */␊ - typeProperties: (OracleTableDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * On-premises Oracle dataset properties.␊ - */␊ - export interface OracleTableDatasetTypeProperties {␊ - /**␊ - * The table name of the on-premises Oracle database. Type: string (or Expression with resultType string).␊ - */␊ - tableName: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Azure MySQL database dataset.␊ - */␊ - export interface AzureMySqlTableDataset {␊ - type: "AzureMySqlTable"␊ - /**␊ - * Azure MySQL database dataset properties.␊ - */␊ - typeProperties: (AzureMySqlTableDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure MySQL database dataset properties.␊ - */␊ - export interface AzureMySqlTableDatasetTypeProperties {␊ - /**␊ - * The Azure MySQL database table name. Type: string (or Expression with resultType string).␊ - */␊ - tableName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The relational table dataset.␊ - */␊ - export interface RelationalTableDataset {␊ - type: "RelationalTable"␊ - /**␊ - * Relational table dataset properties.␊ - */␊ - typeProperties: (RelationalTableDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Relational table dataset properties.␊ - */␊ - export interface RelationalTableDatasetTypeProperties {␊ - /**␊ - * The relational table name. Type: string (or Expression with resultType string).␊ - */␊ - tableName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Salesforce object dataset.␊ - */␊ - export interface SalesforceObjectDataset {␊ - type: "SalesforceObject"␊ - /**␊ - * Salesforce object dataset properties.␊ - */␊ - typeProperties: (SalesforceObjectDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Salesforce object dataset properties.␊ - */␊ - export interface SalesforceObjectDatasetTypeProperties {␊ - /**␊ - * The Salesforce object API name. Type: string (or Expression with resultType string).␊ - */␊ - objectApiName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The path of the SAP Cloud for Customer OData entity.␊ - */␊ - export interface SapCloudForCustomerResourceDataset {␊ - type: "SapCloudForCustomerResource"␊ - /**␊ - * Sap Cloud For Customer OData resource dataset properties.␊ - */␊ - typeProperties: (SapCloudForCustomerResourceDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Sap Cloud For Customer OData resource dataset properties.␊ - */␊ - export interface SapCloudForCustomerResourceDatasetTypeProperties {␊ - /**␊ - * The path of the SAP Cloud for Customer OData entity. Type: string (or Expression with resultType string).␊ - */␊ - path: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The path of the SAP ECC OData entity.␊ - */␊ - export interface SapEccResourceDataset {␊ - type: "SapEccResource"␊ - /**␊ - * Sap ECC OData resource dataset properties.␊ - */␊ - typeProperties: (SapEccResourceDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Sap ECC OData resource dataset properties.␊ - */␊ - export interface SapEccResourceDatasetTypeProperties {␊ - /**␊ - * The path of the SAP ECC OData entity. Type: string (or Expression with resultType string).␊ - */␊ - path: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The on-premises SQL Server dataset.␊ - */␊ - export interface SqlServerTableDataset {␊ - type: "SqlServerTable"␊ - /**␊ - * On-premises SQL Server dataset properties.␊ - */␊ - typeProperties: (SqlServerTableDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * On-premises SQL Server dataset properties.␊ - */␊ - export interface SqlServerTableDatasetTypeProperties {␊ - /**␊ - * The table name of the SQL Server dataset. Type: string (or Expression with resultType string).␊ - */␊ - tableName: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The dataset points to a HTML table in the web page.␊ - */␊ - export interface WebTableDataset {␊ - type: "WebTable"␊ - /**␊ - * Web table dataset properties.␊ - */␊ - typeProperties: (WebTableDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Web table dataset properties.␊ - */␊ - export interface WebTableDatasetTypeProperties {␊ - /**␊ - * The zero-based index of the table in the web page. Type: integer (or Expression with resultType integer), minimum: 0.␊ - */␊ - index: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The relative URL to the web page from the linked service URL. Type: string (or Expression with resultType string).␊ - */␊ - path?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Azure Search Index.␊ - */␊ - export interface AzureSearchIndexDataset {␊ - type: "AzureSearchIndex"␊ - /**␊ - * Properties specific to this dataset type.␊ - */␊ - typeProperties: (AzureSearchIndexDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to this dataset type.␊ - */␊ - export interface AzureSearchIndexDatasetTypeProperties {␊ - /**␊ - * The name of the Azure Search Index. Type: string (or Expression with resultType string).␊ - */␊ - indexName: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A file in an HTTP web server.␊ - */␊ - export interface HttpDataset {␊ - type: "HttpFile"␊ - /**␊ - * Properties specific to this dataset type.␊ - */␊ - typeProperties: (HttpDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to this dataset type.␊ - */␊ - export interface HttpDatasetTypeProperties {␊ - /**␊ - * The headers for the HTTP Request. e.g. request-header-name-1:request-header-value-1␍␊ - * ...␍␊ - * request-header-name-n:request-header-value-n Type: string (or Expression with resultType string).␊ - */␊ - additionalHeaders?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The compression method used on a dataset.␊ - */␊ - compression?: ((DatasetBZip2Compression | DatasetGZipCompression | DatasetDeflateCompression | DatasetZipDeflateCompression) | string)␊ - /**␊ - * The format definition of a storage.␊ - */␊ - format?: (DatasetStorageFormat | string)␊ - /**␊ - * The relative URL based on the URL in the HttpLinkedService refers to an HTTP file Type: string (or Expression with resultType string).␊ - */␊ - relativeUrl?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The body for the HTTP request. Type: string (or Expression with resultType string).␊ - */␊ - requestBody?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The HTTP method for the HTTP request. Type: string (or Expression with resultType string).␊ - */␊ - requestMethod?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Amazon Marketplace Web Service dataset.␊ - */␊ - export interface AmazonMWSObjectDataset {␊ - type: "AmazonMWSObject"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure PostgreSQL dataset.␊ - */␊ - export interface AzurePostgreSqlTableDataset {␊ - type: "AzurePostgreSqlTable"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Concur Service dataset.␊ - */␊ - export interface ConcurObjectDataset {␊ - type: "ConcurObject"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Couchbase server dataset.␊ - */␊ - export interface CouchbaseTableDataset {␊ - type: "CouchbaseTable"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Drill server dataset.␊ - */␊ - export interface DrillTableDataset {␊ - type: "DrillTable"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Eloqua server dataset.␊ - */␊ - export interface EloquaObjectDataset {␊ - type: "EloquaObject"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Google BigQuery service dataset.␊ - */␊ - export interface GoogleBigQueryObjectDataset {␊ - type: "GoogleBigQueryObject"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Greenplum Database dataset.␊ - */␊ - export interface GreenplumTableDataset {␊ - type: "GreenplumTable"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HBase server dataset.␊ - */␊ - export interface HBaseObjectDataset {␊ - type: "HBaseObject"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Hive Server dataset.␊ - */␊ - export interface HiveObjectDataset {␊ - type: "HiveObject"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Hubspot Service dataset.␊ - */␊ - export interface HubspotObjectDataset {␊ - type: "HubspotObject"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Impala server dataset.␊ - */␊ - export interface ImpalaObjectDataset {␊ - type: "ImpalaObject"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Jira Service dataset.␊ - */␊ - export interface JiraObjectDataset {␊ - type: "JiraObject"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Magento server dataset.␊ - */␊ - export interface MagentoObjectDataset {␊ - type: "MagentoObject"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * MariaDB server dataset.␊ - */␊ - export interface MariaDBTableDataset {␊ - type: "MariaDBTable"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Marketo server dataset.␊ - */␊ - export interface MarketoObjectDataset {␊ - type: "MarketoObject"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Paypal Service dataset.␊ - */␊ - export interface PaypalObjectDataset {␊ - type: "PaypalObject"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Phoenix server dataset.␊ - */␊ - export interface PhoenixObjectDataset {␊ - type: "PhoenixObject"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Presto server dataset.␊ - */␊ - export interface PrestoObjectDataset {␊ - type: "PrestoObject"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * QuickBooks server dataset.␊ - */␊ - export interface QuickBooksObjectDataset {␊ - type: "QuickBooksObject"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ServiceNow server dataset.␊ - */␊ - export interface ServiceNowObjectDataset {␊ - type: "ServiceNowObject"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Shopify Service dataset.␊ - */␊ - export interface ShopifyObjectDataset {␊ - type: "ShopifyObject"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Spark Server dataset.␊ - */␊ - export interface SparkObjectDataset {␊ - type: "SparkObject"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Square Service dataset.␊ - */␊ - export interface SquareObjectDataset {␊ - type: "SquareObject"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Xero Service dataset.␊ - */␊ - export interface XeroObjectDataset {␊ - type: "XeroObject"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Zoho server dataset.␊ - */␊ - export interface ZohoObjectDataset {␊ - type: "ZohoObject"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Netezza dataset.␊ - */␊ - export interface NetezzaTableDataset {␊ - type: "NetezzaTable"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Vertica dataset.␊ - */␊ - export interface VerticaTableDataset {␊ - type: "VerticaTable"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Salesforce Marketing Cloud dataset.␊ - */␊ - export interface SalesforceMarketingCloudObjectDataset {␊ - type: "SalesforceMarketingCloudObject"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Responsys dataset.␊ - */␊ - export interface ResponsysObjectDataset {␊ - type: "ResponsysObject"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataFactory/factories/pipelines␊ - */␊ - export interface FactoriesPipelinesChildResource {␊ - apiVersion: "2017-09-01-preview"␊ - /**␊ - * The pipeline name.␊ - */␊ - name: string␊ - /**␊ - * A data factory pipeline.␊ - */␊ - properties: (Pipeline | string)␊ - type: "pipelines"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A data factory pipeline.␊ - */␊ - export interface Pipeline {␊ - /**␊ - * List of activities in pipeline.␊ - */␊ - activities?: (Activity[] | string)␊ - /**␊ - * List of tags that can be used for describing the Pipeline.␊ - */␊ - annotations?: ({␊ - [k: string]: unknown␊ - }[] | string)␊ - /**␊ - * The max number of concurrent runs for the pipeline.␊ - */␊ - concurrency?: (number | string)␊ - /**␊ - * The description of the pipeline.␊ - */␊ - description?: string␊ - /**␊ - * Definition of all parameters for an entity.␊ - */␊ - parameters?: ({␊ - [k: string]: ParameterSpecification␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Activity dependency information.␊ - */␊ - export interface ActivityDependency {␊ - /**␊ - * Activity name.␊ - */␊ - activity: string␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Match-Condition for the dependency.␊ - */␊ - dependencyConditions: (("Succeeded" | "Failed" | "Skipped" | "Completed")[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Execute pipeline activity.␊ - */␊ - export interface ExecutePipelineActivity {␊ - type: "ExecutePipeline"␊ - /**␊ - * Execute pipeline activity properties.␊ - */␊ - typeProperties: (ExecutePipelineActivityTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Execute pipeline activity properties.␊ - */␊ - export interface ExecutePipelineActivityTypeProperties {␊ - /**␊ - * An object mapping parameter names to argument values.␊ - */␊ - parameters?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Pipeline reference type.␊ - */␊ - pipeline: (PipelineReference | string)␊ - /**␊ - * Defines whether activity execution will wait for the dependent pipeline execution to finish. Default is false.␊ - */␊ - waitOnCompletion?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Pipeline reference type.␊ - */␊ - export interface PipelineReference {␊ - /**␊ - * Reference name.␊ - */␊ - name?: string␊ - /**␊ - * Reference pipeline name.␊ - */␊ - referenceName: string␊ - /**␊ - * Pipeline reference type.␊ - */␊ - type: ("PipelineReference" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * This activity evaluates a boolean expression and executes either the activities under the ifTrueActivities property or the ifFalseActivities property depending on the result of the expression.␊ - */␊ - export interface IfConditionActivity {␊ - type: "IfCondition"␊ - /**␊ - * IfCondition activity properties.␊ - */␊ - typeProperties: (IfConditionActivityTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IfCondition activity properties.␊ - */␊ - export interface IfConditionActivityTypeProperties {␊ - /**␊ - * Azure Data Factory expression definition.␊ - */␊ - expression: (Expression | string)␊ - /**␊ - * List of activities to execute if expression is evaluated to false. This is an optional property and if not provided, the activity will exit without any action.␊ - */␊ - ifFalseActivities?: ((ControlActivity | ExecutionActivity)[] | string)␊ - /**␊ - * List of activities to execute if expression is evaluated to true. This is an optional property and if not provided, the activity will exit without any action.␊ - */␊ - ifTrueActivities?: ((ControlActivity | ExecutionActivity)[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Data Factory expression definition.␊ - */␊ - export interface Expression {␊ - /**␊ - * Expression type.␊ - */␊ - type: ("Expression" | string)␊ - /**␊ - * Expression value.␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * This activity is used for iterating over a collection and execute given activities.␊ - */␊ - export interface ForEachActivity {␊ - type: "ForEach"␊ - /**␊ - * ForEach activity properties.␊ - */␊ - typeProperties: (ForEachActivityTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ForEach activity properties.␊ - */␊ - export interface ForEachActivityTypeProperties {␊ - /**␊ - * List of activities to execute .␊ - */␊ - activities: ((ControlActivity | ExecutionActivity)[] | string)␊ - /**␊ - * Batch count to be used for controlling the number of parallel execution (when isSequential is set to false).␊ - */␊ - batchCount?: (number | string)␊ - /**␊ - * Should the loop be executed in sequence or in parallel (max 50)␊ - */␊ - isSequential?: (boolean | string)␊ - /**␊ - * Azure Data Factory expression definition.␊ - */␊ - items: (Expression | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * This activity suspends pipeline execution for the specified interval.␊ - */␊ - export interface WaitActivity {␊ - type: "Wait"␊ - /**␊ - * Wait activity properties.␊ - */␊ - typeProperties: (WaitActivityTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Wait activity properties.␊ - */␊ - export interface WaitActivityTypeProperties {␊ - /**␊ - * Duration in seconds.␊ - */␊ - waitTimeInSeconds: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * This activity executes inner activities until the specified boolean expression results to true or timeout is reached, whichever is earlier.␊ - */␊ - export interface UntilActivity {␊ - type: "Until"␊ - /**␊ - * Until activity properties.␊ - */␊ - typeProperties: (UntilActivityTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Until activity properties.␊ - */␊ - export interface UntilActivityTypeProperties {␊ - /**␊ - * List of activities to execute.␊ - */␊ - activities: ((ControlActivity | ExecutionActivity)[] | string)␊ - /**␊ - * Azure Data Factory expression definition.␊ - */␊ - expression: (Expression | string)␊ - /**␊ - * Specifies the timeout for the activity to run. If there is no value specified, it takes the value of TimeSpan.FromDays(7) which is 1 week as default. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9])). Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9])).␊ - */␊ - timeout?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Filter and return results from input array based on the conditions.␊ - */␊ - export interface FilterActivity {␊ - type: "Filter"␊ - /**␊ - * Filter activity properties.␊ - */␊ - typeProperties: (FilterActivityTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Filter activity properties.␊ - */␊ - export interface FilterActivityTypeProperties {␊ - /**␊ - * Azure Data Factory expression definition.␊ - */␊ - condition: (Expression | string)␊ - /**␊ - * Azure Data Factory expression definition.␊ - */␊ - items: (Expression | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Execution policy for an activity.␊ - */␊ - export interface ActivityPolicy {␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Maximum ordinary retry attempts. Default is 0. Type: integer (or Expression with resultType integer), minimum: 0.␊ - */␊ - retry?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Interval between each retry attempt (in seconds). The default is 30 sec.␊ - */␊ - retryIntervalInSeconds?: (number | string)␊ - /**␊ - * When set to true, Output from activity is considered as secure and will not be logged to monitoring.␊ - */␊ - secureOutput?: (boolean | string)␊ - /**␊ - * Specifies the timeout for the activity to run. The default timeout is 7 days. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9])).␊ - */␊ - timeout?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Copy activity.␊ - */␊ - export interface CopyActivity {␊ - /**␊ - * List of inputs for the activity.␊ - */␊ - inputs?: (DatasetReference[] | string)␊ - /**␊ - * List of outputs for the activity.␊ - */␊ - outputs?: (DatasetReference[] | string)␊ - type: "Copy"␊ - /**␊ - * Copy activity properties.␊ - */␊ - typeProperties: (CopyActivityTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Dataset reference type.␊ - */␊ - export interface DatasetReference {␊ - /**␊ - * An object mapping parameter names to argument values.␊ - */␊ - parameters?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Reference dataset name.␊ - */␊ - referenceName: string␊ - /**␊ - * Dataset reference type.␊ - */␊ - type: ("DatasetReference" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Copy activity properties.␊ - */␊ - export interface CopyActivityTypeProperties {␊ - /**␊ - * Maximum number of cloud data movement units that can be used to perform this data movement. Type: integer (or Expression with resultType integer), minimum: 0.␊ - */␊ - cloudDataMovementUnits?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Whether to skip incompatible row. Default value is false. Type: boolean (or Expression with resultType boolean).␊ - */␊ - enableSkipIncompatibleRow?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to copy data via an interim staging. Default value is false. Type: boolean (or Expression with resultType boolean).␊ - */␊ - enableStaging?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Maximum number of concurrent sessions opened on the source or sink to avoid overloading the data store. Type: integer (or Expression with resultType integer), minimum: 0.␊ - */␊ - parallelCopies?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Redirect incompatible row settings␊ - */␊ - redirectIncompatibleRowSettings?: (RedirectIncompatibleRowSettings | string)␊ - /**␊ - * A copy activity sink.␊ - */␊ - sink: (CopySink | string)␊ - /**␊ - * A copy activity source.␊ - */␊ - source: (CopySource | string)␊ - /**␊ - * Staging settings.␊ - */␊ - stagingSettings?: (StagingSettings | string)␊ - /**␊ - * Copy activity translator. If not specified, tabular translator is used.␊ - */␊ - translator?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Redirect incompatible row settings␊ - */␊ - export interface RedirectIncompatibleRowSettings {␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Name of the Azure Storage, Storage SAS, or Azure Data Lake Store linked service used for redirecting incompatible row. Must be specified if redirectIncompatibleRowSettings is specified. Type: string (or Expression with resultType string).␊ - */␊ - linkedServiceName: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The path for storing the redirect incompatible row data. Type: string (or Expression with resultType string).␊ - */␊ - path?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity sink.␊ - */␊ - export interface CopySink {␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Sink retry count. Type: integer (or Expression with resultType integer).␊ - */␊ - sinkRetryCount?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9])).␊ - */␊ - sinkRetryWait?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.␊ - */␊ - writeBatchSize?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9])).␊ - */␊ - writeBatchTimeout?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity source.␊ - */␊ - export interface CopySource {␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Source retry count. Type: integer (or Expression with resultType integer).␊ - */␊ - sourceRetryCount?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9])).␊ - */␊ - sourceRetryWait?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Staging settings.␊ - */␊ - export interface StagingSettings {␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Specifies whether to use compression when copying data via an interim staging. Default value is false. Type: boolean (or Expression with resultType boolean).␊ - */␊ - enableCompression?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service reference type.␊ - */␊ - linkedServiceName: (LinkedServiceReference | string)␊ - /**␊ - * The path to storage for storing the interim data. Type: string (or Expression with resultType string).␊ - */␊ - path?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HDInsight Hive activity type.␊ - */␊ - export interface HDInsightHiveActivity {␊ - type: "HDInsightHive"␊ - /**␊ - * HDInsight Hive activity properties.␊ - */␊ - typeProperties: (HDInsightHiveActivityTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HDInsight Hive activity properties.␊ - */␊ - export interface HDInsightHiveActivityTypeProperties {␊ - /**␊ - * User specified arguments to HDInsightActivity.␊ - */␊ - arguments?: ({␊ - [k: string]: unknown␊ - }[] | string)␊ - /**␊ - * Allows user to specify defines for Hive job request.␊ - */␊ - defines?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Debug info option.␊ - */␊ - getDebugInfo?: (("None" | "Always" | "Failure") | string)␊ - /**␊ - * Linked service reference type.␊ - */␊ - scriptLinkedService?: (LinkedServiceReference | string)␊ - /**␊ - * Script path. Type: string (or Expression with resultType string).␊ - */␊ - scriptPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Storage linked service references.␊ - */␊ - storageLinkedServices?: (LinkedServiceReference[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HDInsight Pig activity type.␊ - */␊ - export interface HDInsightPigActivity {␊ - type: "HDInsightPig"␊ - /**␊ - * HDInsight Pig activity properties.␊ - */␊ - typeProperties: (HDInsightPigActivityTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HDInsight Pig activity properties.␊ - */␊ - export interface HDInsightPigActivityTypeProperties {␊ - /**␊ - * User specified arguments to HDInsightActivity.␊ - */␊ - arguments?: ({␊ - [k: string]: unknown␊ - }[] | string)␊ - /**␊ - * Allows user to specify defines for Pig job request.␊ - */␊ - defines?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Debug info option.␊ - */␊ - getDebugInfo?: (("None" | "Always" | "Failure") | string)␊ - /**␊ - * Linked service reference type.␊ - */␊ - scriptLinkedService?: (LinkedServiceReference | string)␊ - /**␊ - * Script path. Type: string (or Expression with resultType string).␊ - */␊ - scriptPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Storage linked service references.␊ - */␊ - storageLinkedServices?: (LinkedServiceReference[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HDInsight MapReduce activity type.␊ - */␊ - export interface HDInsightMapReduceActivity {␊ - type: "HDInsightMapReduce"␊ - /**␊ - * HDInsight MapReduce activity properties.␊ - */␊ - typeProperties: (HDInsightMapReduceActivityTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HDInsight MapReduce activity properties.␊ - */␊ - export interface HDInsightMapReduceActivityTypeProperties {␊ - /**␊ - * User specified arguments to HDInsightActivity.␊ - */␊ - arguments?: ({␊ - [k: string]: unknown␊ - }[] | string)␊ - /**␊ - * Class name. Type: string (or Expression with resultType string).␊ - */␊ - className: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allows user to specify defines for the MapReduce job request.␊ - */␊ - defines?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Debug info option.␊ - */␊ - getDebugInfo?: (("None" | "Always" | "Failure") | string)␊ - /**␊ - * Jar path. Type: string (or Expression with resultType string).␊ - */␊ - jarFilePath: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Jar libs.␊ - */␊ - jarLibs?: ({␊ - [k: string]: unknown␊ - }[] | string)␊ - /**␊ - * Linked service reference type.␊ - */␊ - jarLinkedService?: (LinkedServiceReference | string)␊ - /**␊ - * Storage linked service references.␊ - */␊ - storageLinkedServices?: (LinkedServiceReference[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HDInsight streaming activity type.␊ - */␊ - export interface HDInsightStreamingActivity {␊ - type: "HDInsightStreaming"␊ - /**␊ - * HDInsight streaming activity properties.␊ - */␊ - typeProperties: (HDInsightStreamingActivityTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HDInsight streaming activity properties.␊ - */␊ - export interface HDInsightStreamingActivityTypeProperties {␊ - /**␊ - * User specified arguments to HDInsightActivity.␊ - */␊ - arguments?: ({␊ - [k: string]: unknown␊ - }[] | string)␊ - /**␊ - * Combiner executable name. Type: string (or Expression with resultType string).␊ - */␊ - combiner?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Command line environment values.␊ - */␊ - commandEnvironment?: ({␊ - [k: string]: unknown␊ - }[] | string)␊ - /**␊ - * Allows user to specify defines for streaming job request.␊ - */␊ - defines?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Linked service reference type.␊ - */␊ - fileLinkedService?: (LinkedServiceReference | string)␊ - /**␊ - * Paths to streaming job files. Can be directories.␊ - */␊ - filePaths: ({␊ - [k: string]: unknown␊ - }[] | string)␊ - /**␊ - * Debug info option.␊ - */␊ - getDebugInfo?: (("None" | "Always" | "Failure") | string)␊ - /**␊ - * Input blob path. Type: string (or Expression with resultType string).␊ - */␊ - input: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Mapper executable name. Type: string (or Expression with resultType string).␊ - */␊ - mapper: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Output blob path. Type: string (or Expression with resultType string).␊ - */␊ - output: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Reducer executable name. Type: string (or Expression with resultType string).␊ - */␊ - reducer: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Storage linked service references.␊ - */␊ - storageLinkedServices?: (LinkedServiceReference[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HDInsight Spark activity.␊ - */␊ - export interface HDInsightSparkActivity {␊ - type: "HDInsightSpark"␊ - /**␊ - * HDInsight spark activity properties.␊ - */␊ - typeProperties: (HDInsightSparkActivityTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HDInsight spark activity properties.␊ - */␊ - export interface HDInsightSparkActivityTypeProperties {␊ - /**␊ - * The user-specified arguments to HDInsightSparkActivity.␊ - */␊ - arguments?: ({␊ - [k: string]: unknown␊ - }[] | string)␊ - /**␊ - * The application's Java/Spark main class.␊ - */␊ - className?: string␊ - /**␊ - * The relative path to the root folder of the code/package to be executed. Type: string (or Expression with resultType string).␊ - */␊ - entryFilePath: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Debug info option.␊ - */␊ - getDebugInfo?: (("None" | "Always" | "Failure") | string)␊ - /**␊ - * The user to impersonate that will execute the job. Type: string (or Expression with resultType string).␊ - */␊ - proxyUser?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The root path in 'sparkJobLinkedService' for all the job’s files. Type: string (or Expression with resultType string).␊ - */␊ - rootPath: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Spark configuration property.␊ - */␊ - sparkConfig?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Linked service reference type.␊ - */␊ - sparkJobLinkedService?: (LinkedServiceReference | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Execute SSIS package activity.␊ - */␊ - export interface ExecuteSSISPackageActivity {␊ - type: "ExecuteSSISPackage"␊ - /**␊ - * Execute SSIS package activity properties.␊ - */␊ - typeProperties: (ExecuteSSISPackageActivityTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Execute SSIS package activity properties.␊ - */␊ - export interface ExecuteSSISPackageActivityTypeProperties {␊ - /**␊ - * Integration runtime reference type.␊ - */␊ - connectVia: (IntegrationRuntimeReference | string)␊ - /**␊ - * The environment path to execute the SSIS package. Type: string (or Expression with resultType string).␊ - */␊ - environmentPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSIS package execution credential.␊ - */␊ - executionCredential?: (SSISExecutionCredential | string)␊ - /**␊ - * The logging level of SSIS package execution. Type: string (or Expression with resultType string).␊ - */␊ - loggingLevel?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSIS package execution log location␊ - */␊ - logLocation?: (SSISLogLocation | string)␊ - /**␊ - * The package level connection managers to execute the SSIS package.␊ - */␊ - packageConnectionManagers?: ({␊ - [k: string]: {␊ - [k: string]: SSISExecutionParameter␊ - }␊ - } | string)␊ - /**␊ - * SSIS package location.␊ - */␊ - packageLocation: (SSISPackageLocation | string)␊ - /**␊ - * The package level parameters to execute the SSIS package.␊ - */␊ - packageParameters?: ({␊ - [k: string]: SSISExecutionParameter␊ - } | string)␊ - /**␊ - * The project level connection managers to execute the SSIS package.␊ - */␊ - projectConnectionManagers?: ({␊ - [k: string]: {␊ - [k: string]: SSISExecutionParameter␊ - }␊ - } | string)␊ - /**␊ - * The project level parameters to execute the SSIS package.␊ - */␊ - projectParameters?: ({␊ - [k: string]: SSISExecutionParameter␊ - } | string)␊ - /**␊ - * The property overrides to execute the SSIS package.␊ - */␊ - propertyOverrides?: ({␊ - [k: string]: SSISPropertyOverride␊ - } | string)␊ - /**␊ - * Specifies the runtime to execute SSIS package. The value should be "x86" or "x64". Type: string (or Expression with resultType string).␊ - */␊ - runtime?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSIS package execution credential.␊ - */␊ - export interface SSISExecutionCredential {␊ - /**␊ - * Domain for windows authentication.␊ - */␊ - domain: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Data Factory secure string definition. The string value will be masked with asterisks '*' during Get or List API calls.␊ - */␊ - password: (SecureString | string)␊ - /**␊ - * UseName for windows authentication.␊ - */␊ - userName: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSIS package execution log location␊ - */␊ - export interface SSISLogLocation {␊ - /**␊ - * The SSIS package execution log path. Type: string (or Expression with resultType string).␊ - */␊ - logPath: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The type of SSIS log location.␊ - */␊ - type: ("File" | string)␊ - /**␊ - * SSIS package execution log location properties.␊ - */␊ - typeProperties: (SSISLogLocationTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSIS package execution log location properties.␊ - */␊ - export interface SSISLogLocationTypeProperties {␊ - /**␊ - * SSIS access credential.␊ - */␊ - accessCredential?: (SSISAccessCredential | string)␊ - /**␊ - * Specifies the interval to refresh log. The default interval is 5 minutes. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9])).␊ - */␊ - logRefreshInterval?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSIS access credential.␊ - */␊ - export interface SSISAccessCredential {␊ - /**␊ - * Domain for windows authentication.␊ - */␊ - domain: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - /**␊ - * UseName for windows authentication.␊ - */␊ - userName: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSIS execution parameter.␊ - */␊ - export interface SSISExecutionParameter {␊ - /**␊ - * SSIS package execution parameter value. Type: string (or Expression with resultType string).␊ - */␊ - value: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSIS package location.␊ - */␊ - export interface SSISPackageLocation {␊ - /**␊ - * The SSIS package path. Type: string (or Expression with resultType string).␊ - */␊ - packagePath: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The type of SSIS package location.␊ - */␊ - type?: (("SSISDB" | "File") | string)␊ - /**␊ - * SSIS package location properties.␊ - */␊ - typeProperties?: (SSISPackageLocationTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSIS package location properties.␊ - */␊ - export interface SSISPackageLocationTypeProperties {␊ - /**␊ - * SSIS access credential.␊ - */␊ - accessCredential?: (SSISAccessCredential | string)␊ - /**␊ - * The configuration file of the package execution. Type: string (or Expression with resultType string).␊ - */␊ - configurationPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - packagePassword?: ((SecureString | AzureKeyVaultSecretReference) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSIS property override.␊ - */␊ - export interface SSISPropertyOverride {␊ - /**␊ - * Whether SSIS package property override value is sensitive data. Value will be encrypted in SSISDB if it is true␊ - */␊ - isSensitive?: (boolean | string)␊ - /**␊ - * SSIS package property override value. Type: string (or Expression with resultType string).␊ - */␊ - value: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Custom activity type.␊ - */␊ - export interface CustomActivity {␊ - type: "Custom"␊ - /**␊ - * Custom activity properties.␊ - */␊ - typeProperties: (CustomActivityTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Custom activity properties.␊ - */␊ - export interface CustomActivityTypeProperties {␊ - /**␊ - * Command for custom activity Type: string (or Expression with resultType string).␊ - */␊ - command: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * User defined property bag. There is no restriction on the keys or values that can be used. The user specified custom activity has the full responsibility to consume and interpret the content defined.␊ - */␊ - extendedProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Folder path for resource files Type: string (or Expression with resultType string).␊ - */␊ - folderPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Reference objects for custom activity␊ - */␊ - referenceObjects?: (CustomActivityReferenceObject | string)␊ - /**␊ - * Linked service reference type.␊ - */␊ - resourceLinkedService?: (LinkedServiceReference | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Reference objects for custom activity␊ - */␊ - export interface CustomActivityReferenceObject {␊ - /**␊ - * Dataset references.␊ - */␊ - datasets?: (DatasetReference[] | string)␊ - /**␊ - * Linked service references.␊ - */␊ - linkedServices?: (LinkedServiceReference[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SQL stored procedure activity type.␊ - */␊ - export interface SqlServerStoredProcedureActivity {␊ - type: "SqlServerStoredProcedure"␊ - /**␊ - * SQL stored procedure activity properties.␊ - */␊ - typeProperties: (SqlServerStoredProcedureActivityTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SQL stored procedure activity properties.␊ - */␊ - export interface SqlServerStoredProcedureActivityTypeProperties {␊ - /**␊ - * Stored procedure name. Type: string (or Expression with resultType string).␊ - */␊ - storedProcedureName: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}".␊ - */␊ - storedProcedureParameters?: ({␊ - [k: string]: StoredProcedureParameter␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SQL stored procedure parameter.␊ - */␊ - export interface StoredProcedureParameter {␊ - /**␊ - * Stored procedure parameter type.␊ - */␊ - type?: (("String" | "Int" | "Int64" | "Decimal" | "Guid" | "Boolean" | "Date") | string)␊ - /**␊ - * Stored procedure parameter value. Type: string (or Expression with resultType string).␊ - */␊ - value: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Lookup activity.␊ - */␊ - export interface LookupActivity {␊ - type: "Lookup"␊ - /**␊ - * Lookup activity properties.␊ - */␊ - typeProperties: (LookupActivityTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Lookup activity properties.␊ - */␊ - export interface LookupActivityTypeProperties {␊ - /**␊ - * Dataset reference type.␊ - */␊ - dataset: (DatasetReference | string)␊ - /**␊ - * Whether to return first row or all rows. Default value is true. Type: boolean (or Expression with resultType boolean).␊ - */␊ - firstRowOnly?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity source.␊ - */␊ - source: (CopySource | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Web activity.␊ - */␊ - export interface WebActivity {␊ - type: "WebActivity"␊ - /**␊ - * Web activity type properties.␊ - */␊ - typeProperties: (WebActivityTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Web activity type properties.␊ - */␊ - export interface WebActivityTypeProperties {␊ - /**␊ - * Web activity authentication properties.␊ - */␊ - authentication?: (WebActivityAuthentication | string)␊ - /**␊ - * Represents the payload that will be sent to the endpoint. Required for POST/PUT method, not allowed for GET method Type: string (or Expression with resultType string).␊ - */␊ - body?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * List of datasets passed to web endpoint.␊ - */␊ - datasets?: (DatasetReference[] | string)␊ - /**␊ - * When set to true, Certificate validation will be disabled.␊ - */␊ - disableCertValidation?: (boolean | string)␊ - /**␊ - * Represents the headers that will be sent to the request. For example, to set the language and type on a request: "headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }. Type: string (or Expression with resultType string).␊ - */␊ - headers?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * List of linked services passed to web endpoint.␊ - */␊ - linkedServices?: (LinkedServiceReference[] | string)␊ - /**␊ - * Rest API method for target endpoint.␊ - */␊ - method: (("GET" | "POST" | "PUT" | "DELETE") | string)␊ - /**␊ - * Web activity target endpoint and path. Type: string (or Expression with resultType string).␊ - */␊ - url: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Web activity authentication properties.␊ - */␊ - export interface WebActivityAuthentication {␊ - /**␊ - * Azure Data Factory secure string definition. The string value will be masked with asterisks '*' during Get or List API calls.␊ - */␊ - password?: (SecureString | string)␊ - /**␊ - * Azure Data Factory secure string definition. The string value will be masked with asterisks '*' during Get or List API calls.␊ - */␊ - pfx?: (SecureString | string)␊ - /**␊ - * Resource for which Azure Auth token will be requested when using MSI Authentication.␊ - */␊ - resource?: string␊ - /**␊ - * Web activity authentication (Basic/ClientCertificate/MSI)␊ - */␊ - type: string␊ - /**␊ - * Web activity authentication user name for basic authentication.␊ - */␊ - username?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Activity to get metadata of dataset␊ - */␊ - export interface GetMetadataActivity {␊ - type: "GetMetadata"␊ - /**␊ - * GetMetadata activity properties.␊ - */␊ - typeProperties: (GetMetadataActivityTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * GetMetadata activity properties.␊ - */␊ - export interface GetMetadataActivityTypeProperties {␊ - /**␊ - * Dataset reference type.␊ - */␊ - dataset: (DatasetReference | string)␊ - /**␊ - * Fields of metadata to get from dataset.␊ - */␊ - fieldList?: ({␊ - [k: string]: unknown␊ - }[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure ML Batch Execution activity.␊ - */␊ - export interface AzureMLBatchExecutionActivity {␊ - type: "AzureMLBatchExecution"␊ - /**␊ - * Azure ML Batch Execution activity properties.␊ - */␊ - typeProperties: (AzureMLBatchExecutionActivityTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure ML Batch Execution activity properties.␊ - */␊ - export interface AzureMLBatchExecutionActivityTypeProperties {␊ - /**␊ - * Key,Value pairs to be passed to the Azure ML Batch Execution Service endpoint. Keys must match the names of web service parameters defined in the published Azure ML web service. Values will be passed in the GlobalParameters property of the Azure ML batch execution request.␊ - */␊ - globalParameters?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Key,Value pairs, mapping the names of Azure ML endpoint's Web Service Inputs to AzureMLWebServiceFile objects specifying the input Blob locations.. This information will be passed in the WebServiceInputs property of the Azure ML batch execution request.␊ - */␊ - webServiceInputs?: ({␊ - [k: string]: AzureMLWebServiceFile␊ - } | string)␊ - /**␊ - * Key,Value pairs, mapping the names of Azure ML endpoint's Web Service Outputs to AzureMLWebServiceFile objects specifying the output Blob locations. This information will be passed in the WebServiceOutputs property of the Azure ML batch execution request.␊ - */␊ - webServiceOutputs?: ({␊ - [k: string]: AzureMLWebServiceFile␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure ML WebService Input/Output file␊ - */␊ - export interface AzureMLWebServiceFile {␊ - /**␊ - * The relative file path, including container name, in the Azure Blob Storage specified by the LinkedService. Type: string (or Expression with resultType string).␊ - */␊ - filePath: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service reference type.␊ - */␊ - linkedServiceName: (LinkedServiceReference | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure ML Update Resource management activity.␊ - */␊ - export interface AzureMLUpdateResourceActivity {␊ - type: "AzureMLUpdateResource"␊ - /**␊ - * Azure ML Update Resource activity properties.␊ - */␊ - typeProperties: (AzureMLUpdateResourceActivityTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure ML Update Resource activity properties.␊ - */␊ - export interface AzureMLUpdateResourceActivityTypeProperties {␊ - /**␊ - * The relative file path in trainedModelLinkedService to represent the .ilearner file that will be uploaded by the update operation. Type: string (or Expression with resultType string).␊ - */␊ - trainedModelFilePath: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service reference type.␊ - */␊ - trainedModelLinkedServiceName: (LinkedServiceReference | string)␊ - /**␊ - * Name of the Trained Model module in the Web Service experiment to be updated. Type: string (or Expression with resultType string).␊ - */␊ - trainedModelName: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Data Lake Analytics U-SQL activity.␊ - */␊ - export interface DataLakeAnalyticsUSQLActivity {␊ - type: "DataLakeAnalyticsU-SQL"␊ - /**␊ - * DataLakeAnalyticsU-SQL activity properties.␊ - */␊ - typeProperties: (DataLakeAnalyticsUSQLActivityTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DataLakeAnalyticsU-SQL activity properties.␊ - */␊ - export interface DataLakeAnalyticsUSQLActivityTypeProperties {␊ - /**␊ - * Compilation mode of U-SQL. Must be one of these values : Semantic, Full and SingleBox. Type: string (or Expression with resultType string).␊ - */␊ - compilationMode?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The maximum number of nodes simultaneously used to run the job. Default value is 1. Type: integer (or Expression with resultType integer), minimum: 1.␊ - */␊ - degreeOfParallelism?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for U-SQL job request.␊ - */␊ - parameters?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Determines which jobs out of all that are queued should be selected to run first. The lower the number, the higher the priority. Default value is 1000. Type: integer (or Expression with resultType integer), minimum: 1.␊ - */␊ - priority?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Runtime version of the U-SQL engine to use. Type: string (or Expression with resultType string).␊ - */␊ - runtimeVersion?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service reference type.␊ - */␊ - scriptLinkedService: (LinkedServiceReference | string)␊ - /**␊ - * Case-sensitive path to folder that contains the U-SQL script. Type: string (or Expression with resultType string).␊ - */␊ - scriptPath: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DatabricksNotebook activity.␊ - */␊ - export interface DatabricksNotebookActivity {␊ - type: "DatabricksNotebook"␊ - /**␊ - * Databricks Notebook activity properties.␊ - */␊ - typeProperties: (DatabricksNotebookActivityTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Databricks Notebook activity properties.␊ - */␊ - export interface DatabricksNotebookActivityTypeProperties {␊ - /**␊ - * Base parameters to be used for each run of this job.If the notebook takes a parameter that is not specified, the default value from the notebook will be used.␊ - */␊ - baseParameters?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * The absolute path of the notebook to be run in the Databricks Workspace. This path must begin with a slash. Type: string (or Expression with resultType string).␊ - */␊ - notebookPath: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataFactory/factories/triggers␊ - */␊ - export interface FactoriesTriggersChildResource {␊ - apiVersion: "2017-09-01-preview"␊ - /**␊ - * The trigger name.␊ - */␊ - name: string␊ - /**␊ - * Azure data factory nested object which contains information about creating pipeline run␊ - */␊ - properties: (Trigger | string)␊ - type: "triggers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Base class for all triggers that support one to many model for trigger to pipeline.␊ - */␊ - export interface MultiplePipelineTrigger {␊ - /**␊ - * Pipelines that need to be started.␊ - */␊ - pipelines?: (TriggerPipelineReference[] | string)␊ - type: "MultiplePipelineTrigger"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Pipeline that needs to be triggered with the given parameters.␊ - */␊ - export interface TriggerPipelineReference {␊ - /**␊ - * An object mapping parameter names to argument values.␊ - */␊ - parameters?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Pipeline reference type.␊ - */␊ - pipelineReference?: (PipelineReference | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataFactory/factories/datasets␊ - */␊ - export interface FactoriesDatasets {␊ - apiVersion: "2017-09-01-preview"␊ - /**␊ - * The dataset name.␊ - */␊ - name: string␊ - /**␊ - * The Azure Data Factory nested object which identifies data within different data stores, such as tables, files, folders, and documents.␊ - */␊ - properties: ((AmazonS3Dataset | AzureBlobDataset | AzureTableDataset | AzureSqlTableDataset | AzureSqlDWTableDataset | CassandraTableDataset | DocumentDbCollectionDataset | DynamicsEntityDataset | AzureDataLakeStoreDataset | FileShareDataset | MongoDbCollectionDataset | ODataResourceDataset | OracleTableDataset | AzureMySqlTableDataset | RelationalTableDataset | SalesforceObjectDataset | SapCloudForCustomerResourceDataset | SapEccResourceDataset | SqlServerTableDataset | WebTableDataset | AzureSearchIndexDataset | HttpDataset | AmazonMWSObjectDataset | AzurePostgreSqlTableDataset | ConcurObjectDataset | CouchbaseTableDataset | DrillTableDataset | EloquaObjectDataset | GoogleBigQueryObjectDataset | GreenplumTableDataset | HBaseObjectDataset | HiveObjectDataset | HubspotObjectDataset | ImpalaObjectDataset | JiraObjectDataset | MagentoObjectDataset | MariaDBTableDataset | MarketoObjectDataset | PaypalObjectDataset | PhoenixObjectDataset | PrestoObjectDataset | QuickBooksObjectDataset | ServiceNowObjectDataset | ShopifyObjectDataset | SparkObjectDataset | SquareObjectDataset | XeroObjectDataset | ZohoObjectDataset | NetezzaTableDataset | VerticaTableDataset | SalesforceMarketingCloudObjectDataset | ResponsysObjectDataset) | string)␊ - type: "Microsoft.DataFactory/factories/datasets"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataFactory/factories/integrationRuntimes␊ - */␊ - export interface FactoriesIntegrationRuntimes {␊ - apiVersion: "2017-09-01-preview"␊ - /**␊ - * The integration runtime name.␊ - */␊ - name: string␊ - /**␊ - * Azure Data Factory nested object which serves as a compute resource for activities.␊ - */␊ - properties: ((ManagedIntegrationRuntime | SelfHostedIntegrationRuntime) | string)␊ - type: "Microsoft.DataFactory/factories/integrationRuntimes"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataFactory/factories/linkedservices␊ - */␊ - export interface FactoriesLinkedservices {␊ - apiVersion: "2017-09-01-preview"␊ - /**␊ - * The linked service name.␊ - */␊ - name: string␊ - /**␊ - * The Azure Data Factory nested object which contains the information and credential which can be used to connect with related store or compute resource.␊ - */␊ - properties: ((AzureStorageLinkedService | AzureSqlDWLinkedService | SqlServerLinkedService | AzureSqlDatabaseLinkedService | AzureBatchLinkedService | AzureKeyVaultLinkedService | CosmosDbLinkedService | DynamicsLinkedService | HDInsightLinkedService | FileServerLinkedService | OracleLinkedService | AzureMySqlLinkedService | MySqlLinkedService | PostgreSqlLinkedService | SybaseLinkedService | Db2LinkedService | TeradataLinkedService | AzureMLLinkedService | OdbcLinkedService | HdfsLinkedService | ODataLinkedService | WebLinkedService | CassandraLinkedService | MongoDbLinkedService | AzureDataLakeStoreLinkedService | SalesforceLinkedService | SapCloudForCustomerLinkedService | SapEccLinkedService | AmazonS3LinkedService | AmazonRedshiftLinkedService | CustomDataSourceLinkedService | AzureSearchLinkedService | HttpLinkedService | FtpServerLinkedService | SftpServerLinkedService | SapBWLinkedService | SapHanaLinkedService | AmazonMWSLinkedService | AzurePostgreSqlLinkedService | ConcurLinkedService | CouchbaseLinkedService | DrillLinkedService | EloquaLinkedService | GoogleBigQueryLinkedService | GreenplumLinkedService | HBaseLinkedService | HiveLinkedService | HubspotLinkedService | ImpalaLinkedService | JiraLinkedService | MagentoLinkedService | MariaDBLinkedService | MarketoLinkedService | PaypalLinkedService | PhoenixLinkedService | PrestoLinkedService | QuickBooksLinkedService | ServiceNowLinkedService | ShopifyLinkedService | SparkLinkedService | SquareLinkedService | XeroLinkedService | ZohoLinkedService | VerticaLinkedService | NetezzaLinkedService | SalesforceMarketingCloudLinkedService | HDInsightOnDemandLinkedService | AzureDataLakeAnalyticsLinkedService | AzureDatabricksLinkedService | ResponsysLinkedService) | string)␊ - type: "Microsoft.DataFactory/factories/linkedservices"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataFactory/factories/pipelines␊ - */␊ - export interface FactoriesPipelines {␊ - apiVersion: "2017-09-01-preview"␊ - /**␊ - * The pipeline name.␊ - */␊ - name: string␊ - /**␊ - * A data factory pipeline.␊ - */␊ - properties: (Pipeline | string)␊ - type: "Microsoft.DataFactory/factories/pipelines"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataFactory/factories/triggers␊ - */␊ - export interface FactoriesTriggers {␊ - apiVersion: "2017-09-01-preview"␊ - /**␊ - * The trigger name.␊ - */␊ - name: string␊ - /**␊ - * Azure data factory nested object which contains information about creating pipeline run␊ - */␊ - properties: (MultiplePipelineTrigger | string)␊ - type: "Microsoft.DataFactory/factories/triggers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataFactory/factories␊ - */␊ - export interface Factories1 {␊ - apiVersion: "2018-06-01"␊ - /**␊ - * Identity properties of the factory resource.␊ - */␊ - identity?: (FactoryIdentity1 | string)␊ - /**␊ - * The resource location.␊ - */␊ - location?: string␊ - /**␊ - * The factory name.␊ - */␊ - name: string␊ - /**␊ - * Factory resource properties.␊ - */␊ - properties: (FactoryProperties1 | string)␊ - resources?: (FactoriesIntegrationRuntimesChildResource1 | FactoriesLinkedservicesChildResource1 | FactoriesDatasetsChildResource1 | FactoriesPipelinesChildResource1 | FactoriesTriggersChildResource1 | FactoriesDataflowsChildResource | FactoriesManagedVirtualNetworksChildResource | FactoriesPrivateEndpointConnectionsChildResource | FactoriesGlobalParametersChildResource)[]␊ - /**␊ - * The resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.DataFactory/factories"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity properties of the factory resource.␊ - */␊ - export interface FactoryIdentity1 {␊ - /**␊ - * The identity type.␊ - */␊ - type: (("SystemAssigned" | "UserAssigned" | "SystemAssigned,UserAssigned") | string)␊ - /**␊ - * Definition of all user assigned identities for a factory.␊ - */␊ - userAssignedIdentities?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Factory resource properties.␊ - */␊ - export interface FactoryProperties1 {␊ - /**␊ - * Definition of CMK for the factory.␊ - */␊ - encryption?: (EncryptionConfiguration | string)␊ - /**␊ - * Definition of all parameters for an entity.␊ - */␊ - globalParameters?: ({␊ - [k: string]: GlobalParameterSpecification␊ - } | string)␊ - /**␊ - * Whether or not public network access is allowed for the data factory.␊ - */␊ - publicNetworkAccess?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Purview configuration.␊ - */␊ - purviewConfiguration?: (PurviewConfiguration | string)␊ - /**␊ - * Factory's git repo information.␊ - */␊ - repoConfiguration?: (FactoryRepoConfiguration | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Definition of CMK for the factory.␊ - */␊ - export interface EncryptionConfiguration {␊ - /**␊ - * Managed Identity used for CMK.␊ - */␊ - identity?: (CMKIdentityDefinition | string)␊ - /**␊ - * The name of the key in Azure Key Vault to use as Customer Managed Key.␊ - */␊ - keyName: string␊ - /**␊ - * The version of the key used for CMK. If not provided, latest version will be used.␊ - */␊ - keyVersion?: string␊ - /**␊ - * The url of the Azure Key Vault used for CMK.␊ - */␊ - vaultBaseUrl: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Managed Identity used for CMK.␊ - */␊ - export interface CMKIdentityDefinition {␊ - /**␊ - * The resource id of the user assigned identity to authenticate to customer's key vault.␊ - */␊ - userAssignedIdentity?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Definition of a single parameter for an entity.␊ - */␊ - export interface GlobalParameterSpecification {␊ - /**␊ - * Global Parameter type.␊ - */␊ - type: (("Object" | "String" | "Int" | "Float" | "Bool" | "Array") | string)␊ - /**␊ - * Value of parameter.␊ - */␊ - value: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Purview configuration.␊ - */␊ - export interface PurviewConfiguration {␊ - /**␊ - * Purview resource id.␊ - */␊ - purviewResourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Factory's VSTS repo information.␊ - */␊ - export interface FactoryVSTSConfiguration1 {␊ - /**␊ - * VSTS project name.␊ - */␊ - projectName: string␊ - /**␊ - * VSTS tenant id.␊ - */␊ - tenantId?: string␊ - type: "FactoryVSTSConfiguration"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Factory's GitHub repo information.␊ - */␊ - export interface FactoryGitHubConfiguration {␊ - /**␊ - * GitHub bring your own app client id.␊ - */␊ - clientId?: string␊ - /**␊ - * Client secret information for factory's bring your own app repository configuration.␊ - */␊ - clientSecret?: (GitHubClientSecret | string)␊ - /**␊ - * GitHub Enterprise host name. For example: \`https://github.mydomain.com\`␊ - */␊ - hostName?: string␊ - type: "FactoryGitHubConfiguration"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Client secret information for factory's bring your own app repository configuration.␊ - */␊ - export interface GitHubClientSecret {␊ - /**␊ - * Bring your own app client secret AKV URL.␊ - */␊ - byoaSecretAkvUrl?: string␊ - /**␊ - * Bring your own app client secret name in AKV.␊ - */␊ - byoaSecretName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataFactory/factories/integrationRuntimes␊ - */␊ - export interface FactoriesIntegrationRuntimesChildResource1 {␊ - apiVersion: "2018-06-01"␊ - /**␊ - * The integration runtime name.␊ - */␊ - name: string␊ - /**␊ - * Azure Data Factory nested object which serves as a compute resource for activities.␊ - */␊ - properties: (IntegrationRuntime1 | string)␊ - type: "integrationRuntimes"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Managed integration runtime, including managed elastic and managed dedicated integration runtimes.␊ - */␊ - export interface ManagedIntegrationRuntime1 {␊ - /**␊ - * Managed Virtual Network reference type.␊ - */␊ - managedVirtualNetwork?: (ManagedVirtualNetworkReference | string)␊ - type: "Managed"␊ - /**␊ - * Managed integration runtime type properties.␊ - */␊ - typeProperties: (ManagedIntegrationRuntimeTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Managed Virtual Network reference type.␊ - */␊ - export interface ManagedVirtualNetworkReference {␊ - /**␊ - * Reference ManagedVirtualNetwork name.␊ - */␊ - referenceName: string␊ - /**␊ - * Managed Virtual Network reference type.␊ - */␊ - type: ("ManagedVirtualNetworkReference" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Managed integration runtime type properties.␊ - */␊ - export interface ManagedIntegrationRuntimeTypeProperties1 {␊ - /**␊ - * The compute resource properties for managed integration runtime.␊ - */␊ - computeProperties?: (IntegrationRuntimeComputeProperties1 | string)␊ - /**␊ - * The definition and properties of virtual network to which Azure-SSIS integration runtime will join.␊ - */␊ - customerVirtualNetwork?: (IntegrationRuntimeCustomerVirtualNetwork | string)␊ - /**␊ - * SSIS properties for managed integration runtime.␊ - */␊ - ssisProperties?: (IntegrationRuntimeSsisProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The compute resource properties for managed integration runtime.␊ - */␊ - export interface IntegrationRuntimeComputeProperties1 {␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Data flow properties for managed integration runtime.␊ - */␊ - dataFlowProperties?: (IntegrationRuntimeDataFlowProperties | string)␊ - /**␊ - * The location for managed integration runtime. The supported regions could be found on https://docs.microsoft.com/en-us/azure/data-factory/data-factory-data-movement-activities␊ - */␊ - location?: string␊ - /**␊ - * Maximum parallel executions count per node for managed integration runtime.␊ - */␊ - maxParallelExecutionsPerNode?: (number | string)␊ - /**␊ - * The node size requirement to managed integration runtime.␊ - */␊ - nodeSize?: string␊ - /**␊ - * The required number of nodes for managed integration runtime.␊ - */␊ - numberOfNodes?: (number | string)␊ - /**␊ - * VNet properties for managed integration runtime.␊ - */␊ - vNetProperties?: (IntegrationRuntimeVNetProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Data flow properties for managed integration runtime.␊ - */␊ - export interface IntegrationRuntimeDataFlowProperties {␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Cluster will not be recycled and it will be used in next data flow activity run until TTL (time to live) is reached if this is set as false. Default is true.␊ - */␊ - cleanup?: (boolean | string)␊ - /**␊ - * Compute type of the cluster which will execute data flow job.␊ - */␊ - computeType?: (("General" | "MemoryOptimized" | "ComputeOptimized") | string)␊ - /**␊ - * Core count of the cluster which will execute data flow job. Supported values are: 8, 16, 32, 48, 80, 144 and 272.␊ - */␊ - coreCount?: (number | string)␊ - /**␊ - * Time to live (in minutes) setting of the cluster which will execute data flow job.␊ - */␊ - timeToLive?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VNet properties for managed integration runtime.␊ - */␊ - export interface IntegrationRuntimeVNetProperties1 {␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Resource IDs of the public IP addresses that this integration runtime will use.␊ - */␊ - publicIPs?: (string[] | string)␊ - /**␊ - * The name of the subnet this integration runtime will join.␊ - */␊ - subnet?: string␊ - /**␊ - * The ID of subnet, to which this Azure-SSIS integration runtime will be joined.␊ - */␊ - subnetId?: string␊ - /**␊ - * The ID of the VNet that this integration runtime will join.␊ - */␊ - vNetId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The definition and properties of virtual network to which Azure-SSIS integration runtime will join.␊ - */␊ - export interface IntegrationRuntimeCustomerVirtualNetwork {␊ - /**␊ - * The ID of subnet to which Azure-SSIS integration runtime will join.␊ - */␊ - subnetId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSIS properties for managed integration runtime.␊ - */␊ - export interface IntegrationRuntimeSsisProperties1 {␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Catalog information for managed dedicated integration runtime.␊ - */␊ - catalogInfo?: (IntegrationRuntimeSsisCatalogInfo1 | string)␊ - /**␊ - * Credential reference type.␊ - */␊ - credential?: (CredentialReference | string)␊ - /**␊ - * Custom setup script properties for a managed dedicated integration runtime.␊ - */␊ - customSetupScriptProperties?: (IntegrationRuntimeCustomSetupScriptProperties1 | string)␊ - /**␊ - * Data proxy properties for a managed dedicated integration runtime.␊ - */␊ - dataProxyProperties?: (IntegrationRuntimeDataProxyProperties1 | string)␊ - /**␊ - * The edition for the SSIS Integration Runtime.␊ - */␊ - edition?: (("Standard" | "Enterprise") | string)␊ - /**␊ - * Custom setup without script properties for a SSIS integration runtime.␊ - */␊ - expressCustomSetupProperties?: (CustomSetupBase[] | string)␊ - /**␊ - * License type for bringing your own license scenario.␊ - */␊ - licenseType?: (("BasePrice" | "LicenseIncluded") | string)␊ - /**␊ - * Package stores for the SSIS Integration Runtime.␊ - */␊ - packageStores?: (PackageStore[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Catalog information for managed dedicated integration runtime.␊ - */␊ - export interface IntegrationRuntimeSsisCatalogInfo1 {␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Azure Data Factory secure string definition. The string value will be masked with asterisks '*' during Get or List API calls.␊ - */␊ - catalogAdminPassword?: (SecureString1 | string)␊ - /**␊ - * The administrator user name of catalog database.␊ - */␊ - catalogAdminUserName?: string␊ - /**␊ - * The pricing tier for the catalog database. The valid values could be found in https://azure.microsoft.com/en-us/pricing/details/sql-database/.␊ - */␊ - catalogPricingTier?: (("Basic" | "Standard" | "Premium" | "PremiumRS") | string)␊ - /**␊ - * The catalog database server URL.␊ - */␊ - catalogServerEndpoint?: string␊ - /**␊ - * The dual standby pair name of Azure-SSIS Integration Runtimes to support SSISDB failover.␊ - */␊ - dualStandbyPairName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Data Factory secure string definition. The string value will be masked with asterisks '*' during Get or List API calls.␊ - */␊ - export interface SecureString1 {␊ - type: "SecureString"␊ - /**␊ - * Value of secure string.␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Credential reference type.␊ - */␊ - export interface CredentialReference {␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Reference credential name.␊ - */␊ - referenceName: string␊ - /**␊ - * Credential reference type.␊ - */␊ - type: ("CredentialReference" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Custom setup script properties for a managed dedicated integration runtime.␊ - */␊ - export interface IntegrationRuntimeCustomSetupScriptProperties1 {␊ - /**␊ - * The URI of the Azure blob container that contains the custom setup script.␊ - */␊ - blobContainerUri?: string␊ - /**␊ - * Azure Data Factory secure string definition. The string value will be masked with asterisks '*' during Get or List API calls.␊ - */␊ - sasToken?: (SecureString1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Data proxy properties for a managed dedicated integration runtime.␊ - */␊ - export interface IntegrationRuntimeDataProxyProperties1 {␊ - /**␊ - * The entity reference.␊ - */␊ - connectVia?: (EntityReference1 | string)␊ - /**␊ - * The path to contain the staged data in the Blob storage.␊ - */␊ - path?: string␊ - /**␊ - * The entity reference.␊ - */␊ - stagingLinkedService?: (EntityReference1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The entity reference.␊ - */␊ - export interface EntityReference1 {␊ - /**␊ - * The name of this referenced entity.␊ - */␊ - referenceName?: string␊ - /**␊ - * The type of this referenced entity.␊ - */␊ - type?: (("IntegrationRuntimeReference" | "LinkedServiceReference") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The custom setup of running cmdkey commands.␊ - */␊ - export interface CmdkeySetup {␊ - type: "CmdkeySetup"␊ - /**␊ - * Cmdkey command custom setup type properties.␊ - */␊ - typeProperties: (CmdkeySetupTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Cmdkey command custom setup type properties.␊ - */␊ - export interface CmdkeySetupTypeProperties {␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password: (SecretBase1 | string)␊ - /**␊ - * The server name of data source access.␊ - */␊ - targetName: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The user name of data source access.␊ - */␊ - userName: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Key Vault secret reference.␊ - */␊ - export interface AzureKeyVaultSecretReference1 {␊ - /**␊ - * The name of the secret in Azure Key Vault. Type: string (or Expression with resultType string).␊ - */␊ - secretName: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The version of the secret in Azure Key Vault. The default value is the latest version of the secret. Type: string (or Expression with resultType string).␊ - */␊ - secretVersion?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service reference type.␊ - */␊ - store: (LinkedServiceReference1 | string)␊ - type: "AzureKeyVaultSecret"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service reference type.␊ - */␊ - export interface LinkedServiceReference1 {␊ - /**␊ - * An object mapping parameter names to argument values.␊ - */␊ - parameters?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Reference LinkedService name.␊ - */␊ - referenceName: string␊ - /**␊ - * Linked service reference type.␊ - */␊ - type: ("LinkedServiceReference" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The custom setup of setting environment variable.␊ - */␊ - export interface EnvironmentVariableSetup {␊ - type: "EnvironmentVariableSetup"␊ - /**␊ - * Environment variable custom setup type properties.␊ - */␊ - typeProperties: (EnvironmentVariableSetupTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Environment variable custom setup type properties.␊ - */␊ - export interface EnvironmentVariableSetupTypeProperties {␊ - /**␊ - * The name of the environment variable.␊ - */␊ - variableName: string␊ - /**␊ - * The value of the environment variable.␊ - */␊ - variableValue: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The custom setup of installing 3rd party components.␊ - */␊ - export interface ComponentSetup {␊ - type: "ComponentSetup"␊ - /**␊ - * Installation of licensed component setup type properties.␊ - */␊ - typeProperties: (LicensedComponentSetupTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Installation of licensed component setup type properties.␊ - */␊ - export interface LicensedComponentSetupTypeProperties {␊ - /**␊ - * The name of the 3rd party component.␊ - */␊ - componentName: string␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - licenseKey?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The express custom setup of installing Azure PowerShell.␊ - */␊ - export interface AzPowerShellSetup {␊ - type: "AzPowerShellSetup"␊ - /**␊ - * Installation of Azure PowerShell type properties.␊ - */␊ - typeProperties: (AzPowerShellSetupTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Installation of Azure PowerShell type properties.␊ - */␊ - export interface AzPowerShellSetupTypeProperties {␊ - /**␊ - * The required version of Azure PowerShell to install.␊ - */␊ - version: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Package store for the SSIS integration runtime.␊ - */␊ - export interface PackageStore {␊ - /**␊ - * The name of the package store␊ - */␊ - name: string␊ - /**␊ - * The entity reference.␊ - */␊ - packageStoreLinkedService: (EntityReference1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Self-hosted integration runtime.␊ - */␊ - export interface SelfHostedIntegrationRuntime1 {␊ - type: "SelfHosted"␊ - /**␊ - * The self-hosted integration runtime properties.␊ - */␊ - typeProperties?: (SelfHostedIntegrationRuntimeTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The self-hosted integration runtime properties.␊ - */␊ - export interface SelfHostedIntegrationRuntimeTypeProperties {␊ - /**␊ - * The base definition of a linked integration runtime.␊ - */␊ - linkedInfo?: (LinkedIntegrationRuntimeType | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The key authorization type integration runtime.␊ - */␊ - export interface LinkedIntegrationRuntimeKeyAuthorization {␊ - authorizationType: "Key"␊ - /**␊ - * Azure Data Factory secure string definition. The string value will be masked with asterisks '*' during Get or List API calls.␊ - */␊ - key: (SecureString1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The role based access control (RBAC) authorization type integration runtime.␊ - */␊ - export interface LinkedIntegrationRuntimeRbacAuthorization {␊ - authorizationType: "RBAC"␊ - /**␊ - * Credential reference type.␊ - */␊ - credential?: (CredentialReference | string)␊ - /**␊ - * The resource identifier of the integration runtime to be shared.␊ - */␊ - resourceId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataFactory/factories/linkedservices␊ - */␊ - export interface FactoriesLinkedservicesChildResource1 {␊ - apiVersion: "2018-06-01"␊ - /**␊ - * The linked service name.␊ - */␊ - name: string␊ - /**␊ - * The nested object which contains the information and credential which can be used to connect with related store or compute resource.␊ - */␊ - properties: (LinkedService1 | string)␊ - type: "linkedservices"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Integration runtime reference type.␊ - */␊ - export interface IntegrationRuntimeReference1 {␊ - /**␊ - * An object mapping parameter names to argument values.␊ - */␊ - parameters?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Reference integration runtime name.␊ - */␊ - referenceName: string␊ - /**␊ - * Type of integration runtime.␊ - */␊ - type: ("IntegrationRuntimeReference" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Definition of a single parameter for an entity.␊ - */␊ - export interface ParameterSpecification1 {␊ - /**␊ - * Default value of parameter.␊ - */␊ - defaultValue?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameter type.␊ - */␊ - type: (("Object" | "String" | "Int" | "Float" | "Bool" | "Array" | "SecureString") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The storage account linked service.␊ - */␊ - export interface AzureStorageLinkedService1 {␊ - type: "AzureStorage"␊ - /**␊ - * Azure Storage linked service properties.␊ - */␊ - typeProperties: (AzureStorageLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Storage linked service properties.␊ - */␊ - export interface AzureStorageLinkedServiceTypeProperties1 {␊ - /**␊ - * Azure Key Vault secret reference.␊ - */␊ - accountKey?: (AzureKeyVaultSecretReference1 | string)␊ - /**␊ - * The connection string. It is mutually exclusive with sasUri property. Type: string, SecureString or AzureKeyVaultSecretReference.␊ - */␊ - connectionString?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: string␊ - /**␊ - * Azure Key Vault secret reference.␊ - */␊ - sasToken?: (AzureKeyVaultSecretReference1 | string)␊ - /**␊ - * SAS URI of the Azure Storage resource. It is mutually exclusive with connectionString property. Type: string, SecureString or AzureKeyVaultSecretReference.␊ - */␊ - sasUri?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The azure blob storage linked service.␊ - */␊ - export interface AzureBlobStorageLinkedService {␊ - type: "AzureBlobStorage"␊ - /**␊ - * Azure Blob Storage linked service properties.␊ - */␊ - typeProperties: (AzureBlobStorageLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Blob Storage linked service properties.␊ - */␊ - export interface AzureBlobStorageLinkedServiceTypeProperties {␊ - /**␊ - * Azure Key Vault secret reference.␊ - */␊ - accountKey?: (AzureKeyVaultSecretReference1 | string)␊ - /**␊ - * Specify the kind of your storage account. Allowed values are: Storage (general purpose v1), StorageV2 (general purpose v2), BlobStorage, or BlockBlobStorage. Type: string (or Expression with resultType string).␊ - */␊ - accountKind?: string␊ - /**␊ - * Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).␊ - */␊ - azureCloudType?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The connection string. It is mutually exclusive with sasUri, serviceEndpoint property. Type: string, SecureString or AzureKeyVaultSecretReference.␊ - */␊ - connectionString?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Credential reference type.␊ - */␊ - credential?: (CredentialReference | string)␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: string␊ - /**␊ - * Azure Key Vault secret reference.␊ - */␊ - sasToken?: (AzureKeyVaultSecretReference1 | string)␊ - /**␊ - * SAS URI of the Azure Blob Storage resource. It is mutually exclusive with connectionString, serviceEndpoint property. Type: string, SecureString or AzureKeyVaultSecretReference.␊ - */␊ - sasUri?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Blob service endpoint of the Azure Blob Storage resource. It is mutually exclusive with connectionString, sasUri property.␊ - */␊ - serviceEndpoint?: string␊ - /**␊ - * The ID of the service principal used to authenticate against Azure SQL Data Warehouse. Type: string (or Expression with resultType string).␊ - */␊ - servicePrincipalId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - servicePrincipalKey?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).␊ - */␊ - tenant?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The azure table storage linked service.␊ - */␊ - export interface AzureTableStorageLinkedService {␊ - type: "AzureTableStorage"␊ - /**␊ - * Azure Storage linked service properties.␊ - */␊ - typeProperties: (AzureStorageLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure SQL Data Warehouse linked service.␊ - */␊ - export interface AzureSqlDWLinkedService1 {␊ - type: "AzureSqlDW"␊ - /**␊ - * Azure SQL Data Warehouse linked service properties.␊ - */␊ - typeProperties: (AzureSqlDWLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure SQL Data Warehouse linked service properties.␊ - */␊ - export interface AzureSqlDWLinkedServiceTypeProperties1 {␊ - /**␊ - * Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).␊ - */␊ - azureCloudType?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.␊ - */␊ - connectionString: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Credential reference type.␊ - */␊ - credential?: (CredentialReference | string)␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Key Vault secret reference.␊ - */␊ - password?: (AzureKeyVaultSecretReference1 | string)␊ - /**␊ - * The ID of the service principal used to authenticate against Azure SQL Data Warehouse. Type: string (or Expression with resultType string).␊ - */␊ - servicePrincipalId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - servicePrincipalKey?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).␊ - */␊ - tenant?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SQL Server linked service.␊ - */␊ - export interface SqlServerLinkedService1 {␊ - type: "SqlServer"␊ - /**␊ - * SQL Server linked service properties.␊ - */␊ - typeProperties: (SqlServerLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SQL Server linked service properties.␊ - */␊ - export interface SqlServerLinkedServiceTypeProperties1 {␊ - /**␊ - * Sql always encrypted properties.␊ - */␊ - alwaysEncryptedSettings?: (SqlAlwaysEncryptedProperties | string)␊ - /**␊ - * The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.␊ - */␊ - connectionString: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The on-premises Windows authentication user name. Type: string (or Expression with resultType string).␊ - */␊ - userName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Sql always encrypted properties.␊ - */␊ - export interface SqlAlwaysEncryptedProperties {␊ - /**␊ - * Sql always encrypted AKV authentication type. Type: string (or Expression with resultType string).␊ - */␊ - alwaysEncryptedAkvAuthType: (("ServicePrincipal" | "ManagedIdentity" | "UserAssignedManagedIdentity") | string)␊ - /**␊ - * Credential reference type.␊ - */␊ - credential?: (CredentialReference | string)␊ - /**␊ - * The client ID of the application in Azure Active Directory used for Azure Key Vault authentication. Type: string (or Expression with resultType string).␊ - */␊ - servicePrincipalId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - servicePrincipalKey?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Amazon RDS for SQL Server linked service.␊ - */␊ - export interface AmazonRdsForSqlServerLinkedService {␊ - type: "AmazonRdsForSqlServer"␊ - /**␊ - * Amazon Rds for SQL Server linked service properties.␊ - */␊ - typeProperties: (AmazonRdsForSqlServerLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Amazon Rds for SQL Server linked service properties.␊ - */␊ - export interface AmazonRdsForSqlServerLinkedServiceTypeProperties {␊ - /**␊ - * Sql always encrypted properties.␊ - */␊ - alwaysEncryptedSettings?: (SqlAlwaysEncryptedProperties | string)␊ - /**␊ - * The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.␊ - */␊ - connectionString: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The on-premises Windows authentication user name. Type: string (or Expression with resultType string).␊ - */␊ - userName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft Azure SQL Database linked service.␊ - */␊ - export interface AzureSqlDatabaseLinkedService1 {␊ - type: "AzureSqlDatabase"␊ - /**␊ - * Azure SQL Database linked service properties.␊ - */␊ - typeProperties: (AzureSqlDatabaseLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure SQL Database linked service properties.␊ - */␊ - export interface AzureSqlDatabaseLinkedServiceTypeProperties1 {␊ - /**␊ - * Sql always encrypted properties.␊ - */␊ - alwaysEncryptedSettings?: (SqlAlwaysEncryptedProperties | string)␊ - /**␊ - * Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).␊ - */␊ - azureCloudType?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.␊ - */␊ - connectionString: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Credential reference type.␊ - */␊ - credential?: (CredentialReference | string)␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Key Vault secret reference.␊ - */␊ - password?: (AzureKeyVaultSecretReference1 | string)␊ - /**␊ - * The ID of the service principal used to authenticate against Azure SQL Database. Type: string (or Expression with resultType string).␊ - */␊ - servicePrincipalId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - servicePrincipalKey?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).␊ - */␊ - tenant?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure SQL Managed Instance linked service.␊ - */␊ - export interface AzureSqlMILinkedService {␊ - type: "AzureSqlMI"␊ - /**␊ - * Azure SQL Managed Instance linked service properties.␊ - */␊ - typeProperties: (AzureSqlMILinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure SQL Managed Instance linked service properties.␊ - */␊ - export interface AzureSqlMILinkedServiceTypeProperties {␊ - /**␊ - * Sql always encrypted properties.␊ - */␊ - alwaysEncryptedSettings?: (SqlAlwaysEncryptedProperties | string)␊ - /**␊ - * Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).␊ - */␊ - azureCloudType?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.␊ - */␊ - connectionString: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Credential reference type.␊ - */␊ - credential?: (CredentialReference | string)␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Key Vault secret reference.␊ - */␊ - password?: (AzureKeyVaultSecretReference1 | string)␊ - /**␊ - * The ID of the service principal used to authenticate against Azure SQL Managed Instance. Type: string (or Expression with resultType string).␊ - */␊ - servicePrincipalId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - servicePrincipalKey?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).␊ - */␊ - tenant?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Batch linked service.␊ - */␊ - export interface AzureBatchLinkedService1 {␊ - type: "AzureBatch"␊ - /**␊ - * Azure Batch linked service properties.␊ - */␊ - typeProperties: (AzureBatchLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Batch linked service properties.␊ - */␊ - export interface AzureBatchLinkedServiceTypeProperties1 {␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - accessKey?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The Azure Batch account name. Type: string (or Expression with resultType string).␊ - */␊ - accountName: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Azure Batch URI. Type: string (or Expression with resultType string).␊ - */␊ - batchUri: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Credential reference type.␊ - */␊ - credential?: (CredentialReference | string)␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service reference type.␊ - */␊ - linkedServiceName: (LinkedServiceReference1 | string)␊ - /**␊ - * The Azure Batch pool name. Type: string (or Expression with resultType string).␊ - */␊ - poolName: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Key Vault linked service.␊ - */␊ - export interface AzureKeyVaultLinkedService1 {␊ - type: "AzureKeyVault"␊ - /**␊ - * Azure Key Vault linked service properties.␊ - */␊ - typeProperties: (AzureKeyVaultLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Key Vault linked service properties.␊ - */␊ - export interface AzureKeyVaultLinkedServiceTypeProperties1 {␊ - /**␊ - * The base URL of the Azure Key Vault. e.g. https://myakv.vault.azure.net Type: string (or Expression with resultType string).␊ - */␊ - baseUrl: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Credential reference type.␊ - */␊ - credential?: (CredentialReference | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft Azure Cosmos Database (CosmosDB) linked service.␊ - */␊ - export interface CosmosDbLinkedService1 {␊ - type: "CosmosDb"␊ - /**␊ - * CosmosDB linked service properties.␊ - */␊ - typeProperties: (CosmosDbLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * CosmosDB linked service properties.␊ - */␊ - export interface CosmosDbLinkedServiceTypeProperties1 {␊ - /**␊ - * The endpoint of the Azure CosmosDB account. Type: string (or Expression with resultType string)␊ - */␊ - accountEndpoint?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - accountKey?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).␊ - */␊ - azureCloudType?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The connection mode used to access CosmosDB account. Type: string (or Expression with resultType string).␊ - */␊ - connectionMode?: (("Gateway" | "Direct") | string)␊ - /**␊ - * The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.␊ - */␊ - connectionString?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Credential reference type.␊ - */␊ - credential?: (CredentialReference | string)␊ - /**␊ - * The name of the database. Type: string (or Expression with resultType string)␊ - */␊ - database?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - servicePrincipalCredential?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string).␊ - */␊ - servicePrincipalCredentialType?: (("ServicePrincipalKey" | "ServicePrincipalCert") | string)␊ - /**␊ - * The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string).␊ - */␊ - servicePrincipalId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).␊ - */␊ - tenant?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Dynamics linked service.␊ - */␊ - export interface DynamicsLinkedService1 {␊ - type: "Dynamics"␊ - /**␊ - * Dynamics linked service properties.␊ - */␊ - typeProperties: (DynamicsLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Dynamics linked service properties.␊ - */␊ - export interface DynamicsLinkedServiceTypeProperties1 {␊ - /**␊ - * The authentication type to connect to Dynamics server. 'Office365' for online scenario, 'Ifd' for on-premises with Ifd scenario, 'AADServicePrincipal' for Server-To-Server authentication in online scenario. Type: string (or Expression with resultType string).␊ - */␊ - authenticationType: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Credential reference type.␊ - */␊ - credential?: (CredentialReference | string)␊ - /**␊ - * The deployment type of the Dynamics instance. 'Online' for Dynamics Online and 'OnPremisesWithIfd' for Dynamics on-premises with Ifd. Type: string (or Expression with resultType string).␊ - */␊ - deploymentType: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The host name of the on-premises Dynamics server. The property is required for on-prem and not allowed for online. Type: string (or Expression with resultType string).␊ - */␊ - hostName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The organization name of the Dynamics instance. The property is required for on-prem and required for online when there are more than one Dynamics instances associated with the user. Type: string (or Expression with resultType string).␊ - */␊ - organizationName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The port of on-premises Dynamics server. The property is required for on-prem and not allowed for online. Default is 443. Type: integer (or Expression with resultType integer), minimum: 0.␊ - */␊ - port?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - servicePrincipalCredential?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string).␊ - */␊ - servicePrincipalCredentialType?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string).␊ - */␊ - servicePrincipalId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The URL to the Microsoft Dynamics server. The property is required for on-line and not allowed for on-prem. Type: string (or Expression with resultType string).␊ - */␊ - serviceUri?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * User name to access the Dynamics instance. Type: string (or Expression with resultType string).␊ - */␊ - username?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Dynamics CRM linked service.␊ - */␊ - export interface DynamicsCrmLinkedService {␊ - type: "DynamicsCrm"␊ - /**␊ - * Dynamics CRM linked service properties.␊ - */␊ - typeProperties: (DynamicsCrmLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Dynamics CRM linked service properties.␊ - */␊ - export interface DynamicsCrmLinkedServiceTypeProperties {␊ - /**␊ - * The authentication type to connect to Dynamics CRM server. 'Office365' for online scenario, 'Ifd' for on-premises with Ifd scenario, 'AADServicePrincipal' for Server-To-Server authentication in online scenario. Type: string (or Expression with resultType string).␊ - */␊ - authenticationType: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The deployment type of the Dynamics CRM instance. 'Online' for Dynamics CRM Online and 'OnPremisesWithIfd' for Dynamics CRM on-premises with Ifd. Type: string (or Expression with resultType string).␊ - */␊ - deploymentType: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The host name of the on-premises Dynamics CRM server. The property is required for on-prem and not allowed for online. Type: string (or Expression with resultType string).␊ - */␊ - hostName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The organization name of the Dynamics CRM instance. The property is required for on-prem and required for online when there are more than one Dynamics CRM instances associated with the user. Type: string (or Expression with resultType string).␊ - */␊ - organizationName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The port of on-premises Dynamics CRM server. The property is required for on-prem and not allowed for online. Default is 443. Type: integer (or Expression with resultType integer), minimum: 0.␊ - */␊ - port?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - servicePrincipalCredential?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string).␊ - */␊ - servicePrincipalCredentialType?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string).␊ - */␊ - servicePrincipalId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The URL to the Microsoft Dynamics CRM server. The property is required for on-line and not allowed for on-prem. Type: string (or Expression with resultType string).␊ - */␊ - serviceUri?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * User name to access the Dynamics CRM instance. Type: string (or Expression with resultType string).␊ - */␊ - username?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Common Data Service for Apps linked service.␊ - */␊ - export interface CommonDataServiceForAppsLinkedService {␊ - type: "CommonDataServiceForApps"␊ - /**␊ - * Common Data Service for Apps linked service properties.␊ - */␊ - typeProperties: (CommonDataServiceForAppsLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Common Data Service for Apps linked service properties.␊ - */␊ - export interface CommonDataServiceForAppsLinkedServiceTypeProperties {␊ - /**␊ - * The authentication type to connect to Common Data Service for Apps server. 'Office365' for online scenario, 'Ifd' for on-premises with Ifd scenario. 'AADServicePrincipal' for Server-To-Server authentication in online scenario. Type: string (or Expression with resultType string).␊ - */␊ - authenticationType: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The deployment type of the Common Data Service for Apps instance. 'Online' for Common Data Service for Apps Online and 'OnPremisesWithIfd' for Common Data Service for Apps on-premises with Ifd. Type: string (or Expression with resultType string).␊ - */␊ - deploymentType: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The host name of the on-premises Common Data Service for Apps server. The property is required for on-prem and not allowed for online. Type: string (or Expression with resultType string).␊ - */␊ - hostName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The organization name of the Common Data Service for Apps instance. The property is required for on-prem and required for online when there are more than one Common Data Service for Apps instances associated with the user. Type: string (or Expression with resultType string).␊ - */␊ - organizationName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The port of on-premises Common Data Service for Apps server. The property is required for on-prem and not allowed for online. Default is 443. Type: integer (or Expression with resultType integer), minimum: 0.␊ - */␊ - port?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - servicePrincipalCredential?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string).␊ - */␊ - servicePrincipalCredentialType?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string).␊ - */␊ - servicePrincipalId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The URL to the Microsoft Common Data Service for Apps server. The property is required for on-line and not allowed for on-prem. Type: string (or Expression with resultType string).␊ - */␊ - serviceUri?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * User name to access the Common Data Service for Apps instance. Type: string (or Expression with resultType string).␊ - */␊ - username?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HDInsight linked service.␊ - */␊ - export interface HDInsightLinkedService1 {␊ - type: "HDInsight"␊ - /**␊ - * HDInsight linked service properties.␊ - */␊ - typeProperties: (HDInsightLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HDInsight linked service properties.␊ - */␊ - export interface HDInsightLinkedServiceTypeProperties1 {␊ - /**␊ - * HDInsight cluster URI. Type: string (or Expression with resultType string).␊ - */␊ - clusterUri: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specify the FileSystem if the main storage for the HDInsight is ADLS Gen2. Type: string (or Expression with resultType string).␊ - */␊ - fileSystem?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service reference type.␊ - */␊ - hcatalogLinkedServiceName?: (LinkedServiceReference1 | string)␊ - /**␊ - * Specify if the HDInsight is created with ESP (Enterprise Security Package). Type: Boolean.␊ - */␊ - isEspEnabled?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service reference type.␊ - */␊ - linkedServiceName?: (LinkedServiceReference1 | string)␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * HDInsight cluster user name. Type: string (or Expression with resultType string).␊ - */␊ - userName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * File system linked service.␊ - */␊ - export interface FileServerLinkedService1 {␊ - type: "FileServer"␊ - /**␊ - * File system linked service properties.␊ - */␊ - typeProperties: (FileServerLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * File system linked service properties.␊ - */␊ - export interface FileServerLinkedServiceTypeProperties1 {␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Host name of the server. Type: string (or Expression with resultType string).␊ - */␊ - host: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * User ID to logon the server. Type: string (or Expression with resultType string).␊ - */␊ - userId?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure File Storage linked service.␊ - */␊ - export interface AzureFileStorageLinkedService {␊ - type: "AzureFileStorage"␊ - /**␊ - * Azure File Storage linked service properties.␊ - */␊ - typeProperties: (AzureFileStorageLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure File Storage linked service properties.␊ - */␊ - export interface AzureFileStorageLinkedServiceTypeProperties {␊ - /**␊ - * Azure Key Vault secret reference.␊ - */␊ - accountKey?: (AzureKeyVaultSecretReference1 | string)␊ - /**␊ - * The connection string. It is mutually exclusive with sasUri property. Type: string, SecureString or AzureKeyVaultSecretReference.␊ - */␊ - connectionString?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The azure file share name. It is required when auth with accountKey/sasToken. Type: string (or Expression with resultType string).␊ - */␊ - fileShare?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Host name of the server. Type: string (or Expression with resultType string).␊ - */␊ - host?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * Azure Key Vault secret reference.␊ - */␊ - sasToken?: (AzureKeyVaultSecretReference1 | string)␊ - /**␊ - * SAS URI of the Azure File resource. It is mutually exclusive with connectionString property. Type: string, SecureString or AzureKeyVaultSecretReference.␊ - */␊ - sasUri?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The azure file share snapshot version. Type: string (or Expression with resultType string).␊ - */␊ - snapshot?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * User ID to logon the server. Type: string (or Expression with resultType string).␊ - */␊ - userId?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service for Amazon S3 Compatible.␊ - */␊ - export interface AmazonS3CompatibleLinkedService {␊ - type: "AmazonS3Compatible"␊ - /**␊ - * Amazon S3 Compatible linked service properties.␊ - */␊ - typeProperties: (AmazonS3CompatibleLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Amazon S3 Compatible linked service properties.␊ - */␊ - export interface AmazonS3CompatibleLinkedServiceTypeProperties {␊ - /**␊ - * The access key identifier of the Amazon S3 Compatible Identity and Access Management (IAM) user. Type: string (or Expression with resultType string).␊ - */␊ - accessKeyId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * If true, use S3 path-style access instead of virtual hosted-style access. Default value is false. Type: boolean (or Expression with resultType boolean).␊ - */␊ - forcePathStyle?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - secretAccessKey?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * This value specifies the endpoint to access with the Amazon S3 Compatible Connector. This is an optional property; change it only if you want to try a different service endpoint or want to switch between https and http. Type: string (or Expression with resultType string).␊ - */␊ - serviceUrl?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service for Oracle Cloud Storage.␊ - */␊ - export interface OracleCloudStorageLinkedService {␊ - type: "OracleCloudStorage"␊ - /**␊ - * Oracle Cloud Storage linked service properties.␊ - */␊ - typeProperties: (OracleCloudStorageLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Oracle Cloud Storage linked service properties.␊ - */␊ - export interface OracleCloudStorageLinkedServiceTypeProperties {␊ - /**␊ - * The access key identifier of the Oracle Cloud Storage Identity and Access Management (IAM) user. Type: string (or Expression with resultType string).␊ - */␊ - accessKeyId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - secretAccessKey?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * This value specifies the endpoint to access with the Oracle Cloud Storage Connector. This is an optional property; change it only if you want to try a different service endpoint or want to switch between https and http. Type: string (or Expression with resultType string).␊ - */␊ - serviceUrl?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service for Google Cloud Storage.␊ - */␊ - export interface GoogleCloudStorageLinkedService {␊ - type: "GoogleCloudStorage"␊ - /**␊ - * Google Cloud Storage linked service properties.␊ - */␊ - typeProperties: (GoogleCloudStorageLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Google Cloud Storage linked service properties.␊ - */␊ - export interface GoogleCloudStorageLinkedServiceTypeProperties {␊ - /**␊ - * The access key identifier of the Google Cloud Storage Identity and Access Management (IAM) user. Type: string (or Expression with resultType string).␊ - */␊ - accessKeyId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - secretAccessKey?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * This value specifies the endpoint to access with the Google Cloud Storage Connector. This is an optional property; change it only if you want to try a different service endpoint or want to switch between https and http. Type: string (or Expression with resultType string).␊ - */␊ - serviceUrl?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Oracle database.␊ - */␊ - export interface OracleLinkedService1 {␊ - type: "Oracle"␊ - /**␊ - * Oracle database linked service properties.␊ - */␊ - typeProperties: (OracleLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Oracle database linked service properties.␊ - */␊ - export interface OracleLinkedServiceTypeProperties1 {␊ - /**␊ - * The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.␊ - */␊ - connectionString: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Key Vault secret reference.␊ - */␊ - password?: (AzureKeyVaultSecretReference1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AmazonRdsForOracle database.␊ - */␊ - export interface AmazonRdsForOracleLinkedService {␊ - type: "AmazonRdsForOracle"␊ - /**␊ - * AmazonRdsForOracle database linked service properties.␊ - */␊ - typeProperties: (AmazonRdsForLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AmazonRdsForOracle database linked service properties.␊ - */␊ - export interface AmazonRdsForLinkedServiceTypeProperties {␊ - /**␊ - * The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.␊ - */␊ - connectionString: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure MySQL database linked service.␊ - */␊ - export interface AzureMySqlLinkedService1 {␊ - type: "AzureMySql"␊ - /**␊ - * Azure MySQL database linked service properties.␊ - */␊ - typeProperties: (AzureMySqlLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure MySQL database linked service properties.␊ - */␊ - export interface AzureMySqlLinkedServiceTypeProperties1 {␊ - /**␊ - * The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.␊ - */␊ - connectionString: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Key Vault secret reference.␊ - */␊ - password?: (AzureKeyVaultSecretReference1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service for MySQL data source.␊ - */␊ - export interface MySqlLinkedService1 {␊ - type: "MySql"␊ - /**␊ - * MySQL linked service properties.␊ - */␊ - typeProperties: (MySqlLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * MySQL linked service properties.␊ - */␊ - export interface MySqlLinkedServiceTypeProperties1 {␊ - /**␊ - * The connection string.␊ - */␊ - connectionString: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Key Vault secret reference.␊ - */␊ - password?: (AzureKeyVaultSecretReference1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service for PostgreSQL data source.␊ - */␊ - export interface PostgreSqlLinkedService1 {␊ - type: "PostgreSql"␊ - /**␊ - * PostgreSQL linked service properties.␊ - */␊ - typeProperties: (PostgreSqlLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * PostgreSQL linked service properties.␊ - */␊ - export interface PostgreSqlLinkedServiceTypeProperties1 {␊ - /**␊ - * The connection string.␊ - */␊ - connectionString: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Key Vault secret reference.␊ - */␊ - password?: (AzureKeyVaultSecretReference1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service for Sybase data source.␊ - */␊ - export interface SybaseLinkedService1 {␊ - type: "Sybase"␊ - /**␊ - * Sybase linked service properties.␊ - */␊ - typeProperties: (SybaseLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Sybase linked service properties.␊ - */␊ - export interface SybaseLinkedServiceTypeProperties1 {␊ - /**␊ - * AuthenticationType to be used for connection.␊ - */␊ - authenticationType?: (("Basic" | "Windows") | string)␊ - /**␊ - * Database name for connection. Type: string (or Expression with resultType string).␊ - */␊ - database: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * Schema name for connection. Type: string (or Expression with resultType string).␊ - */␊ - schema?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Server name for connection. Type: string (or Expression with resultType string).␊ - */␊ - server: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Username for authentication. Type: string (or Expression with resultType string).␊ - */␊ - username?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service for DB2 data source.␊ - */␊ - export interface Db2LinkedService1 {␊ - type: "Db2"␊ - /**␊ - * DB2 linked service properties.␊ - */␊ - typeProperties: (Db2LinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DB2 linked service properties.␊ - */␊ - export interface Db2LinkedServiceTypeProperties1 {␊ - /**␊ - * AuthenticationType to be used for connection. It is mutually exclusive with connectionString property.␊ - */␊ - authenticationType?: ("Basic" | string)␊ - /**␊ - * Certificate Common Name when TLS is enabled. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string).␊ - */␊ - certificateCommonName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The connection string. It is mutually exclusive with server, database, authenticationType, userName, packageCollection and certificateCommonName property. Type: string, SecureString or AzureKeyVaultSecretReference.␊ - */␊ - connectionString?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Database name for connection. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string).␊ - */␊ - database?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Under where packages are created when querying database. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string).␊ - */␊ - packageCollection?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * Server name for connection. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string).␊ - */␊ - server?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Username for authentication. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string).␊ - */␊ - username?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service for Teradata data source.␊ - */␊ - export interface TeradataLinkedService1 {␊ - type: "Teradata"␊ - /**␊ - * Teradata linked service properties.␊ - */␊ - typeProperties: (TeradataLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Teradata linked service properties.␊ - */␊ - export interface TeradataLinkedServiceTypeProperties1 {␊ - /**␊ - * AuthenticationType to be used for connection.␊ - */␊ - authenticationType?: (("Basic" | "Windows") | string)␊ - /**␊ - * Teradata ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.␊ - */␊ - connectionString?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * Server name for connection. Type: string (or Expression with resultType string).␊ - */␊ - server?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Username for authentication. Type: string (or Expression with resultType string).␊ - */␊ - username?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure ML Studio Web Service linked service.␊ - */␊ - export interface AzureMLLinkedService1 {␊ - type: "AzureML"␊ - /**␊ - * Azure ML Studio Web Service linked service properties.␊ - */␊ - typeProperties: (AzureMLLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure ML Studio Web Service linked service properties.␊ - */␊ - export interface AzureMLLinkedServiceTypeProperties1 {␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - apiKey: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * Type of authentication (Required to specify MSI) used to connect to AzureML. Type: string (or Expression with resultType string).␊ - */␊ - authentication?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Batch Execution REST URL for an Azure ML Studio Web Service endpoint. Type: string (or Expression with resultType string).␊ - */␊ - mlEndpoint: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The ID of the service principal used to authenticate against the ARM-based updateResourceEndpoint of an Azure ML Studio web service. Type: string (or Expression with resultType string).␊ - */␊ - servicePrincipalId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - servicePrincipalKey?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).␊ - */␊ - tenant?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Update Resource REST URL for an Azure ML Studio Web Service endpoint. Type: string (or Expression with resultType string).␊ - */␊ - updateResourceEndpoint?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure ML Service linked service.␊ - */␊ - export interface AzureMLServiceLinkedService {␊ - type: "AzureMLService"␊ - /**␊ - * Azure ML Service linked service properties.␊ - */␊ - typeProperties: (AzureMLServiceLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure ML Service linked service properties.␊ - */␊ - export interface AzureMLServiceLinkedServiceTypeProperties {␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure ML Service workspace name. Type: string (or Expression with resultType string).␊ - */␊ - mlWorkspaceName: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure ML Service workspace resource group name. Type: string (or Expression with resultType string).␊ - */␊ - resourceGroupName: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The ID of the service principal used to authenticate against the endpoint of a published Azure ML Service pipeline. Type: string (or Expression with resultType string).␊ - */␊ - servicePrincipalId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - servicePrincipalKey?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * Azure ML Service workspace subscription ID. Type: string (or Expression with resultType string).␊ - */␊ - subscriptionId: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).␊ - */␊ - tenant?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Open Database Connectivity (ODBC) linked service.␊ - */␊ - export interface OdbcLinkedService1 {␊ - type: "Odbc"␊ - /**␊ - * ODBC linked service properties.␊ - */␊ - typeProperties: (OdbcLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ODBC linked service properties.␊ - */␊ - export interface OdbcLinkedServiceTypeProperties1 {␊ - /**␊ - * Type of authentication used to connect to the ODBC data store. Possible values are: Anonymous and Basic. Type: string (or Expression with resultType string).␊ - */␊ - authenticationType?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The non-access credential portion of the connection string as well as an optional encrypted credential. Type: string, SecureString or AzureKeyVaultSecretReference.␊ - */␊ - connectionString: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - credential?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * User name for Basic authentication. Type: string (or Expression with resultType string).␊ - */␊ - userName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Informix linked service.␊ - */␊ - export interface InformixLinkedService {␊ - type: "Informix"␊ - /**␊ - * Informix linked service properties.␊ - */␊ - typeProperties: (InformixLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Informix linked service properties.␊ - */␊ - export interface InformixLinkedServiceTypeProperties {␊ - /**␊ - * Type of authentication used to connect to the Informix as ODBC data store. Possible values are: Anonymous and Basic. Type: string (or Expression with resultType string).␊ - */␊ - authenticationType?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The non-access credential portion of the connection string as well as an optional encrypted credential. Type: string, SecureString or AzureKeyVaultSecretReference.␊ - */␊ - connectionString: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - credential?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * User name for Basic authentication. Type: string (or Expression with resultType string).␊ - */␊ - userName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft Access linked service.␊ - */␊ - export interface MicrosoftAccessLinkedService {␊ - type: "MicrosoftAccess"␊ - /**␊ - * Microsoft Access linked service properties.␊ - */␊ - typeProperties: (MicrosoftAccessLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft Access linked service properties.␊ - */␊ - export interface MicrosoftAccessLinkedServiceTypeProperties {␊ - /**␊ - * Type of authentication used to connect to the Microsoft Access as ODBC data store. Possible values are: Anonymous and Basic. Type: string (or Expression with resultType string).␊ - */␊ - authenticationType?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The non-access credential portion of the connection string as well as an optional encrypted credential. Type: string, SecureString or AzureKeyVaultSecretReference.␊ - */␊ - connectionString: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - credential?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * User name for Basic authentication. Type: string (or Expression with resultType string).␊ - */␊ - userName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Hadoop Distributed File System (HDFS) linked service.␊ - */␊ - export interface HdfsLinkedService1 {␊ - type: "Hdfs"␊ - /**␊ - * HDFS linked service properties.␊ - */␊ - typeProperties: (HdfsLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HDFS linked service properties.␊ - */␊ - export interface HdfsLinkedServiceTypeProperties1 {␊ - /**␊ - * Type of authentication used to connect to the HDFS. Possible values are: Anonymous and Windows. Type: string (or Expression with resultType string).␊ - */␊ - authenticationType?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The URL of the HDFS service endpoint, e.g. http://myhostname:50070/webhdfs/v1 . Type: string (or Expression with resultType string).␊ - */␊ - url: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * User name for Windows authentication. Type: string (or Expression with resultType string).␊ - */␊ - userName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Open Data Protocol (OData) linked service.␊ - */␊ - export interface ODataLinkedService1 {␊ - type: "OData"␊ - /**␊ - * OData linked service properties.␊ - */␊ - typeProperties: (ODataLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * OData linked service properties.␊ - */␊ - export interface ODataLinkedServiceTypeProperties1 {␊ - /**␊ - * Specify the resource you are requesting authorization to use Directory. Type: string (or Expression with resultType string).␊ - */␊ - aadResourceId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specify the credential type (key or cert) is used for service principal.␊ - */␊ - aadServicePrincipalCredentialType?: (("ServicePrincipalKey" | "ServicePrincipalCert") | string)␊ - /**␊ - * Type of authentication used to connect to the OData service.␊ - */␊ - authenticationType?: (("Basic" | "Anonymous" | "Windows" | "AadServicePrincipal" | "ManagedServiceIdentity") | string)␊ - /**␊ - * The additional HTTP headers in the request to RESTful API used for authorization. Type: object (or Expression with resultType object).␊ - */␊ - authHeaders?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).␊ - */␊ - azureCloudType?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - servicePrincipalEmbeddedCert?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - servicePrincipalEmbeddedCertPassword?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * Specify the application id of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).␊ - */␊ - servicePrincipalId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - servicePrincipalKey?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * Specify the tenant information (domain name or tenant ID) under which your application resides. Type: string (or Expression with resultType string).␊ - */␊ - tenant?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The URL of the OData service endpoint. Type: string (or Expression with resultType string).␊ - */␊ - url: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * User name of the OData service. Type: string (or Expression with resultType string).␊ - */␊ - userName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Web linked service.␊ - */␊ - export interface WebLinkedService1 {␊ - type: "Web"␊ - /**␊ - * Base definition of WebLinkedServiceTypeProperties, this typeProperties is polymorphic based on authenticationType, so not flattened in SDK models.␊ - */␊ - typeProperties: (WebLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A WebLinkedService that uses anonymous authentication to communicate with an HTTP endpoint.␊ - */␊ - export interface WebAnonymousAuthentication1 {␊ - authenticationType: "Anonymous"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A WebLinkedService that uses basic authentication to communicate with an HTTP endpoint.␊ - */␊ - export interface WebBasicAuthentication1 {␊ - authenticationType: "Basic"␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * User name for Basic authentication. Type: string (or Expression with resultType string).␊ - */␊ - username: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A WebLinkedService that uses client certificate based authentication to communicate with an HTTP endpoint. This scheme follows mutual authentication; the server must also provide valid credentials to the client.␊ - */␊ - export interface WebClientCertificateAuthentication1 {␊ - authenticationType: "ClientCertificate"␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - pfx: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service for Cassandra data source.␊ - */␊ - export interface CassandraLinkedService1 {␊ - type: "Cassandra"␊ - /**␊ - * Cassandra linked service properties.␊ - */␊ - typeProperties: (CassandraLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Cassandra linked service properties.␊ - */␊ - export interface CassandraLinkedServiceTypeProperties1 {␊ - /**␊ - * AuthenticationType to be used for connection. Type: string (or Expression with resultType string).␊ - */␊ - authenticationType?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Host name for connection. Type: string (or Expression with resultType string).␊ - */␊ - host: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The port for the connection. Type: integer (or Expression with resultType integer).␊ - */␊ - port?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Username for authentication. Type: string (or Expression with resultType string).␊ - */␊ - username?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service for MongoDb data source.␊ - */␊ - export interface MongoDbLinkedService1 {␊ - type: "MongoDb"␊ - /**␊ - * MongoDB linked service properties.␊ - */␊ - typeProperties: (MongoDbLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * MongoDB linked service properties.␊ - */␊ - export interface MongoDbLinkedServiceTypeProperties1 {␊ - /**␊ - * Specifies whether to allow self-signed certificates from the server. The default value is false. Type: boolean (or Expression with resultType boolean).␊ - */␊ - allowSelfSignedServerCert?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The authentication type to be used to connect to the MongoDB database.␊ - */␊ - authenticationType?: (("Basic" | "Anonymous") | string)␊ - /**␊ - * Database to verify the username and password. Type: string (or Expression with resultType string).␊ - */␊ - authSource?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The name of the MongoDB database that you want to access. Type: string (or Expression with resultType string).␊ - */␊ - databaseName: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether the connections to the server are encrypted using SSL. The default value is false. Type: boolean (or Expression with resultType boolean).␊ - */␊ - enableSsl?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The TCP port number that the MongoDB server uses to listen for client connections. The default value is 27017. Type: integer (or Expression with resultType integer), minimum: 0.␊ - */␊ - port?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The IP address or server name of the MongoDB server. Type: string (or Expression with resultType string).␊ - */␊ - server: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Username for authentication. Type: string (or Expression with resultType string).␊ - */␊ - username?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service for MongoDB Atlas data source.␊ - */␊ - export interface MongoDbAtlasLinkedService {␊ - type: "MongoDbAtlas"␊ - /**␊ - * MongoDB Atlas linked service properties.␊ - */␊ - typeProperties: (MongoDbAtlasLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * MongoDB Atlas linked service properties.␊ - */␊ - export interface MongoDbAtlasLinkedServiceTypeProperties {␊ - /**␊ - * The MongoDB Atlas connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.␊ - */␊ - connectionString: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The name of the MongoDB Atlas database that you want to access. Type: string (or Expression with resultType string).␊ - */␊ - database: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service for MongoDB data source.␊ - */␊ - export interface MongoDbV2LinkedService {␊ - type: "MongoDbV2"␊ - /**␊ - * MongoDB linked service properties.␊ - */␊ - typeProperties: (MongoDbV2LinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * MongoDB linked service properties.␊ - */␊ - export interface MongoDbV2LinkedServiceTypeProperties {␊ - /**␊ - * The MongoDB connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.␊ - */␊ - connectionString: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The name of the MongoDB database that you want to access. Type: string (or Expression with resultType string).␊ - */␊ - database: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service for CosmosDB (MongoDB API) data source.␊ - */␊ - export interface CosmosDbMongoDbApiLinkedService {␊ - type: "CosmosDbMongoDbApi"␊ - /**␊ - * CosmosDB (MongoDB API) linked service properties.␊ - */␊ - typeProperties: (CosmosDbMongoDbApiLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * CosmosDB (MongoDB API) linked service properties.␊ - */␊ - export interface CosmosDbMongoDbApiLinkedServiceTypeProperties {␊ - /**␊ - * The CosmosDB (MongoDB API) connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.␊ - */␊ - connectionString: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The name of the CosmosDB (MongoDB API) database that you want to access. Type: string (or Expression with resultType string).␊ - */␊ - database: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Whether the CosmosDB (MongoDB API) server version is higher than 3.2. The default value is false. Type: boolean (or Expression with resultType boolean).␊ - */␊ - isServerVersionAbove32?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Data Lake Store linked service.␊ - */␊ - export interface AzureDataLakeStoreLinkedService1 {␊ - type: "AzureDataLakeStore"␊ - /**␊ - * Azure Data Lake Store linked service properties.␊ - */␊ - typeProperties: (AzureDataLakeStoreLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Data Lake Store linked service properties.␊ - */␊ - export interface AzureDataLakeStoreLinkedServiceTypeProperties1 {␊ - /**␊ - * Data Lake Store account name. Type: string (or Expression with resultType string).␊ - */␊ - accountName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).␊ - */␊ - azureCloudType?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Credential reference type.␊ - */␊ - credential?: (CredentialReference | string)␊ - /**␊ - * Data Lake Store service URI. Type: string (or Expression with resultType string).␊ - */␊ - dataLakeStoreUri: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Data Lake Store account resource group name (if different from Data Factory account). Type: string (or Expression with resultType string).␊ - */␊ - resourceGroupName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The ID of the application used to authenticate against the Azure Data Lake Store account. Type: string (or Expression with resultType string).␊ - */␊ - servicePrincipalId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - servicePrincipalKey?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * Data Lake Store account subscription ID (if different from Data Factory account). Type: string (or Expression with resultType string).␊ - */␊ - subscriptionId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).␊ - */␊ - tenant?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Data Lake Storage Gen2 linked service.␊ - */␊ - export interface AzureBlobFSLinkedService {␊ - type: "AzureBlobFS"␊ - /**␊ - * Azure Data Lake Storage Gen2 linked service properties.␊ - */␊ - typeProperties: (AzureBlobFSLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Data Lake Storage Gen2 linked service properties.␊ - */␊ - export interface AzureBlobFSLinkedServiceTypeProperties {␊ - /**␊ - * Account key for the Azure Data Lake Storage Gen2 service. Type: string (or Expression with resultType string).␊ - */␊ - accountKey?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).␊ - */␊ - azureCloudType?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Credential reference type.␊ - */␊ - credential?: (CredentialReference | string)␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - servicePrincipalCredential?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string).␊ - */␊ - servicePrincipalCredentialType?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The ID of the application used to authenticate against the Azure Data Lake Storage Gen2 account. Type: string (or Expression with resultType string).␊ - */␊ - servicePrincipalId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - servicePrincipalKey?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).␊ - */␊ - tenant?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Endpoint for the Azure Data Lake Storage Gen2 service. Type: string (or Expression with resultType string).␊ - */␊ - url: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Office365 linked service.␊ - */␊ - export interface Office365LinkedService {␊ - type: "Office365"␊ - /**␊ - * Office365 linked service properties.␊ - */␊ - typeProperties: (Office365LinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Office365 linked service properties.␊ - */␊ - export interface Office365LinkedServiceTypeProperties {␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure tenant ID to which the Office 365 account belongs. Type: string (or Expression with resultType string).␊ - */␊ - office365TenantId: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specify the application's client ID. Type: string (or Expression with resultType string).␊ - */␊ - servicePrincipalId: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - servicePrincipalKey: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * Specify the tenant information under which your Azure AD web application resides. Type: string (or Expression with resultType string).␊ - */␊ - servicePrincipalTenantId: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service for Salesforce.␊ - */␊ - export interface SalesforceLinkedService1 {␊ - type: "Salesforce"␊ - /**␊ - * Salesforce linked service properties.␊ - */␊ - typeProperties: (SalesforceLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Salesforce linked service properties.␊ - */␊ - export interface SalesforceLinkedServiceTypeProperties1 {␊ - /**␊ - * The Salesforce API version used in ADF. Type: string (or Expression with resultType string).␊ - */␊ - apiVersion?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The URL of Salesforce instance. Default is 'https://login.salesforce.com'. To copy data from sandbox, specify 'https://test.salesforce.com'. To copy data from custom domain, specify, for example, 'https://[domain].my.salesforce.com'. Type: string (or Expression with resultType string).␊ - */␊ - environmentUrl?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - securityToken?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The username for Basic authentication of the Salesforce instance. Type: string (or Expression with resultType string).␊ - */␊ - username?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service for Salesforce Service Cloud.␊ - */␊ - export interface SalesforceServiceCloudLinkedService {␊ - type: "SalesforceServiceCloud"␊ - /**␊ - * Salesforce Service Cloud linked service properties.␊ - */␊ - typeProperties: (SalesforceServiceCloudLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Salesforce Service Cloud linked service properties.␊ - */␊ - export interface SalesforceServiceCloudLinkedServiceTypeProperties {␊ - /**␊ - * The Salesforce API version used in ADF. Type: string (or Expression with resultType string).␊ - */␊ - apiVersion?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The URL of Salesforce Service Cloud instance. Default is 'https://login.salesforce.com'. To copy data from sandbox, specify 'https://test.salesforce.com'. To copy data from custom domain, specify, for example, 'https://[domain].my.salesforce.com'. Type: string (or Expression with resultType string).␊ - */␊ - environmentUrl?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Extended properties appended to the connection string. Type: string (or Expression with resultType string).␊ - */␊ - extendedProperties?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - securityToken?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The username for Basic authentication of the Salesforce instance. Type: string (or Expression with resultType string).␊ - */␊ - username?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service for SAP Cloud for Customer.␊ - */␊ - export interface SapCloudForCustomerLinkedService1 {␊ - type: "SapCloudForCustomer"␊ - /**␊ - * SAP Cloud for Customer linked service properties.␊ - */␊ - typeProperties: (SapCloudForCustomerLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SAP Cloud for Customer linked service properties.␊ - */␊ - export interface SapCloudForCustomerLinkedServiceTypeProperties1 {␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Either encryptedCredential or username/password must be provided. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The URL of SAP Cloud for Customer OData API. For example, '[https://[tenantname].crm.ondemand.com/sap/c4c/odata/v1]'. Type: string (or Expression with resultType string).␊ - */␊ - url: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The username for Basic authentication. Type: string (or Expression with resultType string).␊ - */␊ - username?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service for SAP ERP Central Component(SAP ECC).␊ - */␊ - export interface SapEccLinkedService1 {␊ - type: "SapEcc"␊ - /**␊ - * SAP ECC linked service properties.␊ - */␊ - typeProperties: (SapEccLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SAP ECC linked service properties.␊ - */␊ - export interface SapEccLinkedServiceTypeProperties1 {␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Either encryptedCredential or username/password must be provided. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: string␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The URL of SAP ECC OData API. For example, '[https://hostname:port/sap/opu/odata/sap/servicename/]'. Type: string (or Expression with resultType string).␊ - */␊ - url: string␊ - /**␊ - * The username for Basic authentication. Type: string (or Expression with resultType string).␊ - */␊ - username?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SAP Business Warehouse Open Hub Destination Linked Service.␊ - */␊ - export interface SapOpenHubLinkedService {␊ - type: "SapOpenHub"␊ - /**␊ - * Properties specific to SAP Business Warehouse Open Hub Destination linked service type.␊ - */␊ - typeProperties: (SapOpenHubLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to SAP Business Warehouse Open Hub Destination linked service type.␊ - */␊ - export interface SapOpenHubLinkedServiceTypeProperties {␊ - /**␊ - * Client ID of the client on the BW system where the open hub destination is located. (Usually a three-digit decimal number represented as a string) Type: string (or Expression with resultType string).␊ - */␊ - clientId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Language of the BW system where the open hub destination is located. The default value is EN. Type: string (or Expression with resultType string).␊ - */␊ - language?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Logon Group for the SAP System. Type: string (or Expression with resultType string).␊ - */␊ - logonGroup?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The hostname of the SAP Message Server. Type: string (or Expression with resultType string).␊ - */␊ - messageServer?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The service name or port number of the Message Server. Type: string (or Expression with resultType string).␊ - */␊ - messageServerService?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * Host name of the SAP BW instance where the open hub destination is located. Type: string (or Expression with resultType string).␊ - */␊ - server?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SystemID of the SAP system where the table is located. Type: string (or Expression with resultType string).␊ - */␊ - systemId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * System number of the BW system where the open hub destination is located. (Usually a two-digit decimal number represented as a string.) Type: string (or Expression with resultType string).␊ - */␊ - systemNumber?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Username to access the SAP BW server where the open hub destination is located. Type: string (or Expression with resultType string).␊ - */␊ - userName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SAP ODP Linked Service.␊ - */␊ - export interface SapOdpLinkedService {␊ - type: "SapOdp"␊ - /**␊ - * Properties specific to this linked service type.␊ - */␊ - typeProperties: (SapOdpLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to this linked service type.␊ - */␊ - export interface SapOdpLinkedServiceTypeProperties {␊ - /**␊ - * Client ID of the client on the SAP system where the table is located. (Usually a three-digit decimal number represented as a string) Type: string (or Expression with resultType string).␊ - */␊ - clientId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Language of the SAP system where the table is located. The default value is EN. Type: string (or Expression with resultType string).␊ - */␊ - language?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Logon Group for the SAP System. Type: string (or Expression with resultType string).␊ - */␊ - logonGroup?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The hostname of the SAP Message Server. Type: string (or Expression with resultType string).␊ - */␊ - messageServer?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The service name or port number of the Message Server. Type: string (or Expression with resultType string).␊ - */␊ - messageServerService?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * Host name of the SAP instance where the table is located. Type: string (or Expression with resultType string).␊ - */␊ - server?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * External security product's library to access the SAP server where the table is located. Type: string (or Expression with resultType string).␊ - */␊ - sncLibraryPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SNC activation indicator to access the SAP server where the table is located. Must be either 0 (off) or 1 (on). Type: string (or Expression with resultType string).␊ - */␊ - sncMode?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Initiator's SNC name to access the SAP server where the table is located. Type: string (or Expression with resultType string).␊ - */␊ - sncMyName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Communication partner's SNC name to access the SAP server where the table is located. Type: string (or Expression with resultType string).␊ - */␊ - sncPartnerName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SNC Quality of Protection. Allowed value include: 1, 2, 3, 8, 9. Type: string (or Expression with resultType string).␊ - */␊ - sncQop?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The subscriber name. Type: string (or Expression with resultType string).␊ - */␊ - subscriberName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SystemID of the SAP system where the table is located. Type: string (or Expression with resultType string).␊ - */␊ - systemId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * System number of the SAP system where the table is located. (Usually a two-digit decimal number represented as a string.) Type: string (or Expression with resultType string).␊ - */␊ - systemNumber?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Username to access the SAP server where the table is located. Type: string (or Expression with resultType string).␊ - */␊ - userName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SNC X509 certificate file path. Type: string (or Expression with resultType string).␊ - */␊ - x509CertificatePath?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Rest Service linked service.␊ - */␊ - export interface RestServiceLinkedService {␊ - type: "RestService"␊ - /**␊ - * Rest Service linked service properties.␊ - */␊ - typeProperties: (RestServiceLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Rest Service linked service properties.␊ - */␊ - export interface RestServiceLinkedServiceTypeProperties {␊ - /**␊ - * The resource you are requesting authorization to use.␊ - */␊ - aadResourceId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Type of authentication used to connect to the REST service.␊ - */␊ - authenticationType: (("Anonymous" | "Basic" | "AadServicePrincipal" | "ManagedServiceIdentity" | "OAuth2ClientCredential") | string)␊ - /**␊ - * The additional HTTP headers in the request to RESTful API used for authorization. Type: object (or Expression with resultType object).␊ - */␊ - authHeaders?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).␊ - */␊ - azureCloudType?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The client ID associated with your application. Type: string (or Expression with resultType string).␊ - */␊ - clientId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - clientSecret?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * Credential reference type.␊ - */␊ - credential?: (CredentialReference | string)␊ - /**␊ - * Whether to validate server side SSL certificate when connecting to the endpoint.The default value is true. Type: boolean (or Expression with resultType boolean).␊ - */␊ - enableServerCertificateValidation?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The target service or resource to which the access will be requested. Type: string (or Expression with resultType string).␊ - */␊ - resource?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The scope of the access required. It describes what kind of access will be requested. Type: string (or Expression with resultType string).␊ - */␊ - scope?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The application's client ID used in AadServicePrincipal authentication type.␊ - */␊ - servicePrincipalId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - servicePrincipalKey?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The tenant information (domain name or tenant ID) used in AadServicePrincipal authentication type under which your application resides.␊ - */␊ - tenant?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The token endpoint of the authorization server to acquire access token. Type: string (or Expression with resultType string).␊ - */␊ - tokenEndpoint?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base URL of the REST service.␊ - */␊ - url: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The user name used in Basic authentication type.␊ - */␊ - userName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service for TeamDesk.␊ - */␊ - export interface TeamDeskLinkedService {␊ - type: "TeamDesk"␊ - /**␊ - * TeamDesk linked service type properties.␊ - */␊ - typeProperties: (TeamDeskLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * TeamDesk linked service type properties.␊ - */␊ - export interface TeamDeskLinkedServiceTypeProperties {␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - apiToken?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The authentication type to use.␊ - */␊ - authenticationType: (("Basic" | "Token") | string)␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The url to connect TeamDesk source. Type: string (or Expression with resultType string).␊ - */␊ - url: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The username of the TeamDesk source. Type: string (or Expression with resultType string).␊ - */␊ - userName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service for Quickbase.␊ - */␊ - export interface QuickbaseLinkedService {␊ - type: "Quickbase"␊ - /**␊ - * Quickbase linked service type properties.␊ - */␊ - typeProperties: (QuickbaseLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Quickbase linked service type properties.␊ - */␊ - export interface QuickbaseLinkedServiceTypeProperties {␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The url to connect Quickbase source. Type: string (or Expression with resultType string).␊ - */␊ - url: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - userToken: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service for Smartsheet.␊ - */␊ - export interface SmartsheetLinkedService {␊ - type: "Smartsheet"␊ - /**␊ - * Smartsheet linked service type properties.␊ - */␊ - typeProperties: (SmartsheetLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Smartsheet linked service type properties.␊ - */␊ - export interface SmartsheetLinkedServiceTypeProperties {␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - apiToken: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service for Zendesk.␊ - */␊ - export interface ZendeskLinkedService {␊ - type: "Zendesk"␊ - /**␊ - * Zendesk linked service type properties.␊ - */␊ - typeProperties: (ZendeskLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Zendesk linked service type properties.␊ - */␊ - export interface ZendeskLinkedServiceTypeProperties {␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - apiToken?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The authentication type to use.␊ - */␊ - authenticationType: (("Basic" | "Token") | string)␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The url to connect Zendesk source. Type: string (or Expression with resultType string).␊ - */␊ - url: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The username of the Zendesk source. Type: string (or Expression with resultType string).␊ - */␊ - userName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service for Dataworld.␊ - */␊ - export interface DataworldLinkedService {␊ - type: "Dataworld"␊ - /**␊ - * Dataworld linked service type properties.␊ - */␊ - typeProperties: (DataworldLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Dataworld linked service type properties.␊ - */␊ - export interface DataworldLinkedServiceTypeProperties {␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - apiToken: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service for AppFigures.␊ - */␊ - export interface AppFiguresLinkedService {␊ - type: "AppFigures"␊ - /**␊ - * AppFigures linked service type properties.␊ - */␊ - typeProperties: (AppFiguresLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AppFigures linked service type properties.␊ - */␊ - export interface AppFiguresLinkedServiceTypeProperties {␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - clientKey: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The username of the Appfigures source.␊ - */␊ - userName: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service for Asana.␊ - */␊ - export interface AsanaLinkedService {␊ - type: "Asana"␊ - /**␊ - * Asana linked service type properties.␊ - */␊ - typeProperties: (AsanaLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Asana linked service type properties.␊ - */␊ - export interface AsanaLinkedServiceTypeProperties {␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - apiToken: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service for Twilio.␊ - */␊ - export interface TwilioLinkedService {␊ - type: "Twilio"␊ - /**␊ - * Twilio linked service type properties.␊ - */␊ - typeProperties: (TwilioLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Twilio linked service type properties.␊ - */␊ - export interface TwilioLinkedServiceTypeProperties {␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The Account SID of Twilio service.␊ - */␊ - userName: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service for Amazon S3.␊ - */␊ - export interface AmazonS3LinkedService1 {␊ - type: "AmazonS3"␊ - /**␊ - * Amazon S3 linked service properties.␊ - */␊ - typeProperties: (AmazonS3LinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Amazon S3 linked service properties.␊ - */␊ - export interface AmazonS3LinkedServiceTypeProperties1 {␊ - /**␊ - * The access key identifier of the Amazon S3 Identity and Access Management (IAM) user. Type: string (or Expression with resultType string).␊ - */␊ - accessKeyId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The authentication type of S3. Allowed value: AccessKey (default) or TemporarySecurityCredentials. Type: string (or Expression with resultType string).␊ - */␊ - authenticationType?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - secretAccessKey?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * This value specifies the endpoint to access with the S3 Connector. This is an optional property; change it only if you want to try a different service endpoint or want to switch between https and http. Type: string (or Expression with resultType string).␊ - */␊ - serviceUrl?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - sessionToken?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service for Amazon Redshift.␊ - */␊ - export interface AmazonRedshiftLinkedService1 {␊ - type: "AmazonRedshift"␊ - /**␊ - * Amazon Redshift linked service properties.␊ - */␊ - typeProperties: (AmazonRedshiftLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Amazon Redshift linked service properties.␊ - */␊ - export interface AmazonRedshiftLinkedServiceTypeProperties1 {␊ - /**␊ - * The database name of the Amazon Redshift source. Type: string (or Expression with resultType string).␊ - */␊ - database: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The TCP port number that the Amazon Redshift server uses to listen for client connections. The default value is 5439. Type: integer (or Expression with resultType integer).␊ - */␊ - port?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The name of the Amazon Redshift server. Type: string (or Expression with resultType string).␊ - */␊ - server: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The username of the Amazon Redshift source. Type: string (or Expression with resultType string).␊ - */␊ - username?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Custom linked service.␊ - */␊ - export interface CustomDataSourceLinkedService1 {␊ - type: "CustomDataSource"␊ - /**␊ - * Custom linked service properties.␊ - */␊ - typeProperties: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service for Windows Azure Search Service.␊ - */␊ - export interface AzureSearchLinkedService1 {␊ - type: "AzureSearch"␊ - /**␊ - * Windows Azure Search Service linked service properties.␊ - */␊ - typeProperties: (AzureSearchLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Windows Azure Search Service linked service properties.␊ - */␊ - export interface AzureSearchLinkedServiceTypeProperties1 {␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - key?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * URL for Azure Search service. Type: string (or Expression with resultType string).␊ - */␊ - url: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service for an HTTP source.␊ - */␊ - export interface HttpLinkedService1 {␊ - type: "HttpServer"␊ - /**␊ - * Properties specific to this linked service type.␊ - */␊ - typeProperties: (HttpLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to this linked service type.␊ - */␊ - export interface HttpLinkedServiceTypeProperties1 {␊ - /**␊ - * The authentication type to be used to connect to the HTTP server.␊ - */␊ - authenticationType?: (("Basic" | "Anonymous" | "Digest" | "Windows" | "ClientCertificate") | string)␊ - /**␊ - * The additional HTTP headers in the request to RESTful API used for authorization. Type: object (or Expression with resultType object).␊ - */␊ - authHeaders?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Thumbprint of certificate for ClientCertificate authentication. Only valid for on-premises copy. For on-premises copy with ClientCertificate authentication, either CertThumbprint or EmbeddedCertData/Password should be specified. Type: string (or Expression with resultType string).␊ - */␊ - certThumbprint?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Base64 encoded certificate data for ClientCertificate authentication. For on-premises copy with ClientCertificate authentication, either CertThumbprint or EmbeddedCertData/Password should be specified. Type: string (or Expression with resultType string).␊ - */␊ - embeddedCertData?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * If true, validate the HTTPS server SSL certificate. Default value is true. Type: boolean (or Expression with resultType boolean).␊ - */␊ - enableServerCertificateValidation?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The base URL of the HTTP endpoint, e.g. https://www.microsoft.com. Type: string (or Expression with resultType string).␊ - */␊ - url: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * User name for Basic, Digest, or Windows authentication. Type: string (or Expression with resultType string).␊ - */␊ - userName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A FTP server Linked Service.␊ - */␊ - export interface FtpServerLinkedService1 {␊ - type: "FtpServer"␊ - /**␊ - * Properties specific to this linked service type.␊ - */␊ - typeProperties: (FtpServerLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to this linked service type.␊ - */␊ - export interface FtpServerLinkedServiceTypeProperties1 {␊ - /**␊ - * The authentication type to be used to connect to the FTP server.␊ - */␊ - authenticationType?: (("Basic" | "Anonymous") | string)␊ - /**␊ - * If true, validate the FTP server SSL certificate when connect over SSL/TLS channel. Default value is true. Type: boolean (or Expression with resultType boolean).␊ - */␊ - enableServerCertificateValidation?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * If true, connect to the FTP server over SSL/TLS channel. Default value is true. Type: boolean (or Expression with resultType boolean).␊ - */␊ - enableSsl?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Host name of the FTP server. Type: string (or Expression with resultType string).␊ - */␊ - host: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The TCP port number that the FTP server uses to listen for client connections. Default value is 21. Type: integer (or Expression with resultType integer), minimum: 0.␊ - */␊ - port?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Username to logon the FTP server. Type: string (or Expression with resultType string).␊ - */␊ - userName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A linked service for an SSH File Transfer Protocol (SFTP) server. ␊ - */␊ - export interface SftpServerLinkedService1 {␊ - type: "Sftp"␊ - /**␊ - * Properties specific to this linked service type.␊ - */␊ - typeProperties: (SftpServerLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to this linked service type.␊ - */␊ - export interface SftpServerLinkedServiceTypeProperties1 {␊ - /**␊ - * The authentication type to be used to connect to the FTP server.␊ - */␊ - authenticationType?: (("Basic" | "SshPublicKey" | "MultiFactor") | string)␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The SFTP server host name. Type: string (or Expression with resultType string).␊ - */␊ - host: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The host key finger-print of the SFTP server. When SkipHostKeyValidation is false, HostKeyFingerprint should be specified. Type: string (or Expression with resultType string).␊ - */␊ - hostKeyFingerprint?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - passPhrase?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The TCP port number that the SFTP server uses to listen for client connections. Default value is 22. Type: integer (or Expression with resultType integer), minimum: 0.␊ - */␊ - port?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - privateKeyContent?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The SSH private key file path for SshPublicKey authentication. Only valid for on-premises copy. For on-premises copy with SshPublicKey authentication, either PrivateKeyPath or PrivateKeyContent should be specified. SSH private key should be OpenSSH format. Type: string (or Expression with resultType string).␊ - */␊ - privateKeyPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * If true, skip the SSH host key validation. Default value is false. Type: boolean (or Expression with resultType boolean).␊ - */␊ - skipHostKeyValidation?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The username used to log on to the SFTP server. Type: string (or Expression with resultType string).␊ - */␊ - userName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SAP Business Warehouse Linked Service.␊ - */␊ - export interface SapBWLinkedService1 {␊ - type: "SapBW"␊ - /**␊ - * Properties specific to this linked service type.␊ - */␊ - typeProperties: (SapBWLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to this linked service type.␊ - */␊ - export interface SapBWLinkedServiceTypeProperties1 {␊ - /**␊ - * Client ID of the client on the BW system. (Usually a three-digit decimal number represented as a string) Type: string (or Expression with resultType string).␊ - */␊ - clientId: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * Host name of the SAP BW instance. Type: string (or Expression with resultType string).␊ - */␊ - server: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * System number of the BW system. (Usually a two-digit decimal number represented as a string.) Type: string (or Expression with resultType string).␊ - */␊ - systemNumber: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Username to access the SAP BW server. Type: string (or Expression with resultType string).␊ - */␊ - userName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SAP HANA Linked Service.␊ - */␊ - export interface SapHanaLinkedService1 {␊ - type: "SapHana"␊ - /**␊ - * Properties specific to this linked service type.␊ - */␊ - typeProperties: (SapHanaLinkedServiceProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to this linked service type.␊ - */␊ - export interface SapHanaLinkedServiceProperties1 {␊ - /**␊ - * The authentication type to be used to connect to the SAP HANA server.␊ - */␊ - authenticationType?: (("Basic" | "Windows") | string)␊ - /**␊ - * SAP HANA ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.␊ - */␊ - connectionString?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * Host name of the SAP HANA server. Type: string (or Expression with resultType string).␊ - */␊ - server?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Username to access the SAP HANA server. Type: string (or Expression with resultType string).␊ - */␊ - userName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Amazon Marketplace Web Service linked service.␊ - */␊ - export interface AmazonMWSLinkedService1 {␊ - type: "AmazonMWS"␊ - /**␊ - * Amazon Marketplace Web Service linked service properties.␊ - */␊ - typeProperties: (AmazonMWSLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Amazon Marketplace Web Service linked service properties.␊ - */␊ - export interface AmazonMWSLinkedServiceTypeProperties1 {␊ - /**␊ - * The access key id used to access data.␊ - */␊ - accessKeyId: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The endpoint of the Amazon MWS server, (i.e. mws.amazonservices.com)␊ - */␊ - endpoint: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Amazon Marketplace ID you want to retrieve data from. To retrieve data from multiple Marketplace IDs, separate them with a comma (,). (i.e. A2EUQ1WTGCTBG2)␊ - */␊ - marketplaceID: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - mwsAuthToken?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - secretKey?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The Amazon seller ID.␊ - */␊ - sellerID: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.␊ - */␊ - useEncryptedEndpoints?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.␊ - */␊ - useHostVerification?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.␊ - */␊ - usePeerVerification?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure PostgreSQL linked service.␊ - */␊ - export interface AzurePostgreSqlLinkedService1 {␊ - type: "AzurePostgreSql"␊ - /**␊ - * Azure PostgreSQL linked service properties.␊ - */␊ - typeProperties: (AzurePostgreSqlLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure PostgreSQL linked service properties.␊ - */␊ - export interface AzurePostgreSqlLinkedServiceTypeProperties1 {␊ - /**␊ - * An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.␊ - */␊ - connectionString?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Key Vault secret reference.␊ - */␊ - password?: (AzureKeyVaultSecretReference1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Concur Service linked service.␊ - */␊ - export interface ConcurLinkedService1 {␊ - type: "Concur"␊ - /**␊ - * Concur Service linked service properties.␊ - */␊ - typeProperties: (ConcurLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Concur Service linked service properties.␊ - */␊ - export interface ConcurLinkedServiceTypeProperties1 {␊ - /**␊ - * Application client_id supplied by Concur App Management.␊ - */␊ - clientId: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties used to connect to Concur. It is mutually exclusive with any other properties in the linked service. Type: object.␊ - */␊ - connectionProperties?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.␊ - */␊ - useEncryptedEndpoints?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.␊ - */␊ - useHostVerification?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.␊ - */␊ - usePeerVerification?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The user name that you use to access Concur Service.␊ - */␊ - username: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Couchbase server linked service.␊ - */␊ - export interface CouchbaseLinkedService1 {␊ - type: "Couchbase"␊ - /**␊ - * Couchbase server linked service properties.␊ - */␊ - typeProperties: (CouchbaseLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Couchbase server linked service properties.␊ - */␊ - export interface CouchbaseLinkedServiceTypeProperties1 {␊ - /**␊ - * An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.␊ - */␊ - connectionString?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Key Vault secret reference.␊ - */␊ - credString?: (AzureKeyVaultSecretReference1 | string)␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Drill server linked service.␊ - */␊ - export interface DrillLinkedService1 {␊ - type: "Drill"␊ - /**␊ - * Drill server linked service properties.␊ - */␊ - typeProperties: (DrillLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Drill server linked service properties.␊ - */␊ - export interface DrillLinkedServiceTypeProperties1 {␊ - /**␊ - * An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.␊ - */␊ - connectionString?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Key Vault secret reference.␊ - */␊ - pwd?: (AzureKeyVaultSecretReference1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Eloqua server linked service.␊ - */␊ - export interface EloquaLinkedService1 {␊ - type: "Eloqua"␊ - /**␊ - * Eloqua server linked service properties.␊ - */␊ - typeProperties: (EloquaLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Eloqua server linked service properties.␊ - */␊ - export interface EloquaLinkedServiceTypeProperties1 {␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The endpoint of the Eloqua server. (i.e. eloqua.example.com)␊ - */␊ - endpoint: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.␊ - */␊ - useEncryptedEndpoints?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.␊ - */␊ - useHostVerification?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.␊ - */␊ - usePeerVerification?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The site name and user name of your Eloqua account in the form: sitename/username. (i.e. Eloqua/Alice)␊ - */␊ - username: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Google BigQuery service linked service.␊ - */␊ - export interface GoogleBigQueryLinkedService1 {␊ - type: "GoogleBigQuery"␊ - /**␊ - * Google BigQuery service linked service properties.␊ - */␊ - typeProperties: (GoogleBigQueryLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Google BigQuery service linked service properties.␊ - */␊ - export interface GoogleBigQueryLinkedServiceTypeProperties1 {␊ - /**␊ - * A comma-separated list of public BigQuery projects to access.␊ - */␊ - additionalProjects?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR.␊ - */␊ - authenticationType: (("ServiceAuthentication" | "UserAuthentication") | string)␊ - /**␊ - * The client id of the google application used to acquire the refresh token. Type: string (or Expression with resultType string).␊ - */␊ - clientId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - clientSecret?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The service account email ID that is used for ServiceAuthentication and can only be used on self-hosted IR.␊ - */␊ - email?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The full path to the .p12 key file that is used to authenticate the service account email address and can only be used on self-hosted IR.␊ - */␊ - keyFilePath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The default BigQuery project to query against.␊ - */␊ - project: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - refreshToken?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * Whether to request access to Google Drive. Allowing Google Drive access enables support for federated tables that combine BigQuery data with data from Google Drive. The default value is false.␊ - */␊ - requestGoogleDriveScope?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.␊ - */␊ - trustedCertPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.␊ - */␊ - useSystemTrustStore?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Greenplum Database linked service.␊ - */␊ - export interface GreenplumLinkedService1 {␊ - type: "Greenplum"␊ - /**␊ - * Greenplum Database linked service properties.␊ - */␊ - typeProperties: (GreenplumLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Greenplum Database linked service properties.␊ - */␊ - export interface GreenplumLinkedServiceTypeProperties1 {␊ - /**␊ - * An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.␊ - */␊ - connectionString?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Key Vault secret reference.␊ - */␊ - pwd?: (AzureKeyVaultSecretReference1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HBase server linked service.␊ - */␊ - export interface HBaseLinkedService1 {␊ - type: "HBase"␊ - /**␊ - * HBase server linked service properties.␊ - */␊ - typeProperties: (HBaseLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HBase server linked service properties.␊ - */␊ - export interface HBaseLinkedServiceTypeProperties1 {␊ - /**␊ - * Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.␊ - */␊ - allowHostNameCNMismatch?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to allow self-signed certificates from the server. The default value is false.␊ - */␊ - allowSelfSignedServerCert?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The authentication mechanism to use to connect to the HBase server.␊ - */␊ - authenticationType: (("Anonymous" | "Basic") | string)␊ - /**␊ - * Specifies whether the connections to the server are encrypted using SSL. The default value is false.␊ - */␊ - enableSsl?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The IP address or host name of the HBase server. (i.e. 192.168.222.160)␊ - */␊ - host: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The partial URL corresponding to the HBase server. (i.e. /gateway/sandbox/hbase/version)␊ - */␊ - httpPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The TCP port that the HBase instance uses to listen for client connections. The default value is 9090.␊ - */␊ - port?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.␊ - */␊ - trustedCertPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The user name used to connect to the HBase instance.␊ - */␊ - username?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Hive Server linked service.␊ - */␊ - export interface HiveLinkedService1 {␊ - type: "Hive"␊ - /**␊ - * Hive Server linked service properties.␊ - */␊ - typeProperties: (HiveLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Hive Server linked service properties.␊ - */␊ - export interface HiveLinkedServiceTypeProperties1 {␊ - /**␊ - * Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.␊ - */␊ - allowHostNameCNMismatch?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to allow self-signed certificates from the server. The default value is false.␊ - */␊ - allowSelfSignedServerCert?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The authentication method used to access the Hive server.␊ - */␊ - authenticationType: (("Anonymous" | "Username" | "UsernameAndPassword" | "WindowsAzureHDInsightService") | string)␊ - /**␊ - * Specifies whether the connections to the server are encrypted using SSL. The default value is false.␊ - */␊ - enableSsl?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP address or host name of the Hive server, separated by ';' for multiple hosts (only when serviceDiscoveryMode is enable).␊ - */␊ - host: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The partial URL corresponding to the Hive server.␊ - */␊ - httpPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The TCP port that the Hive server uses to listen for client connections.␊ - */␊ - port?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The type of Hive server.␊ - */␊ - serverType?: (("HiveServer1" | "HiveServer2" | "HiveThriftServer") | string)␊ - /**␊ - * true to indicate using the ZooKeeper service, false not.␊ - */␊ - serviceDiscoveryMode?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The transport protocol to use in the Thrift layer.␊ - */␊ - thriftTransportProtocol?: (("Binary" | "SASL" | "HTTP ") | string)␊ - /**␊ - * The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.␊ - */␊ - trustedCertPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether the driver uses native HiveQL queries,or converts them into an equivalent form in HiveQL.␊ - */␊ - useNativeQuery?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The user name that you use to access Hive Server.␊ - */␊ - username?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.␊ - */␊ - useSystemTrustStore?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The namespace on ZooKeeper under which Hive Server 2 nodes are added.␊ - */␊ - zooKeeperNameSpace?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Hubspot Service linked service.␊ - */␊ - export interface HubspotLinkedService1 {␊ - type: "Hubspot"␊ - /**␊ - * Hubspot Service linked service properties.␊ - */␊ - typeProperties: (HubspotLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Hubspot Service linked service properties.␊ - */␊ - export interface HubspotLinkedServiceTypeProperties1 {␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - accessToken?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The client ID associated with your Hubspot application.␊ - */␊ - clientId: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - clientSecret?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - refreshToken?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.␊ - */␊ - useEncryptedEndpoints?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.␊ - */␊ - useHostVerification?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.␊ - */␊ - usePeerVerification?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Impala server linked service.␊ - */␊ - export interface ImpalaLinkedService1 {␊ - type: "Impala"␊ - /**␊ - * Impala server linked service properties.␊ - */␊ - typeProperties: (ImpalaLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Impala server linked service properties.␊ - */␊ - export interface ImpalaLinkedServiceTypeProperties1 {␊ - /**␊ - * Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.␊ - */␊ - allowHostNameCNMismatch?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to allow self-signed certificates from the server. The default value is false.␊ - */␊ - allowSelfSignedServerCert?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The authentication type to use.␊ - */␊ - authenticationType: (("Anonymous" | "SASLUsername" | "UsernameAndPassword") | string)␊ - /**␊ - * Specifies whether the connections to the server are encrypted using SSL. The default value is false.␊ - */␊ - enableSsl?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The IP address or host name of the Impala server. (i.e. 192.168.222.160)␊ - */␊ - host: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The TCP port that the Impala server uses to listen for client connections. The default value is 21050.␊ - */␊ - port?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.␊ - */␊ - trustedCertPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The user name used to access the Impala server. The default value is anonymous when using SASLUsername.␊ - */␊ - username?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.␊ - */␊ - useSystemTrustStore?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Jira Service linked service.␊ - */␊ - export interface JiraLinkedService1 {␊ - type: "Jira"␊ - /**␊ - * Jira Service linked service properties.␊ - */␊ - typeProperties: (JiraLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Jira Service linked service properties.␊ - */␊ - export interface JiraLinkedServiceTypeProperties1 {␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The IP address or host name of the Jira service. (e.g. jira.example.com)␊ - */␊ - host: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The TCP port that the Jira server uses to listen for client connections. The default value is 443 if connecting through HTTPS, or 8080 if connecting through HTTP.␊ - */␊ - port?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.␊ - */␊ - useEncryptedEndpoints?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.␊ - */␊ - useHostVerification?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.␊ - */␊ - usePeerVerification?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The user name that you use to access Jira Service.␊ - */␊ - username: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Magento server linked service.␊ - */␊ - export interface MagentoLinkedService1 {␊ - type: "Magento"␊ - /**␊ - * Magento server linked service properties.␊ - */␊ - typeProperties: (MagentoLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Magento server linked service properties.␊ - */␊ - export interface MagentoLinkedServiceTypeProperties1 {␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - accessToken?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The URL of the Magento instance. (i.e. 192.168.222.110/magento3)␊ - */␊ - host: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.␊ - */␊ - useEncryptedEndpoints?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.␊ - */␊ - useHostVerification?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.␊ - */␊ - usePeerVerification?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * MariaDB server linked service.␊ - */␊ - export interface MariaDBLinkedService1 {␊ - type: "MariaDB"␊ - /**␊ - * MariaDB server linked service properties.␊ - */␊ - typeProperties: (MariaDBLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * MariaDB server linked service properties.␊ - */␊ - export interface MariaDBLinkedServiceTypeProperties1 {␊ - /**␊ - * An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.␊ - */␊ - connectionString?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Key Vault secret reference.␊ - */␊ - pwd?: (AzureKeyVaultSecretReference1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Database for MariaDB linked service.␊ - */␊ - export interface AzureMariaDBLinkedService {␊ - type: "AzureMariaDB"␊ - /**␊ - * Azure Database for MariaDB linked service properties.␊ - */␊ - typeProperties: (AzureMariaDBLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Database for MariaDB linked service properties.␊ - */␊ - export interface AzureMariaDBLinkedServiceTypeProperties {␊ - /**␊ - * An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.␊ - */␊ - connectionString?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Key Vault secret reference.␊ - */␊ - pwd?: (AzureKeyVaultSecretReference1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Marketo server linked service.␊ - */␊ - export interface MarketoLinkedService1 {␊ - type: "Marketo"␊ - /**␊ - * Marketo server linked service properties.␊ - */␊ - typeProperties: (MarketoLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Marketo server linked service properties.␊ - */␊ - export interface MarketoLinkedServiceTypeProperties1 {␊ - /**␊ - * The client Id of your Marketo service.␊ - */␊ - clientId: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - clientSecret?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The endpoint of the Marketo server. (i.e. 123-ABC-321.mktorest.com)␊ - */␊ - endpoint: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.␊ - */␊ - useEncryptedEndpoints?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.␊ - */␊ - useHostVerification?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.␊ - */␊ - usePeerVerification?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Paypal Service linked service.␊ - */␊ - export interface PaypalLinkedService1 {␊ - type: "Paypal"␊ - /**␊ - * Paypal Service linked service properties.␊ - */␊ - typeProperties: (PaypalLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Paypal Service linked service properties.␊ - */␊ - export interface PaypalLinkedServiceTypeProperties1 {␊ - /**␊ - * The client ID associated with your PayPal application.␊ - */␊ - clientId: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - clientSecret?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The URL of the PayPal instance. (i.e. api.sandbox.paypal.com)␊ - */␊ - host: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.␊ - */␊ - useEncryptedEndpoints?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.␊ - */␊ - useHostVerification?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.␊ - */␊ - usePeerVerification?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Phoenix server linked service.␊ - */␊ - export interface PhoenixLinkedService1 {␊ - type: "Phoenix"␊ - /**␊ - * Phoenix server linked service properties.␊ - */␊ - typeProperties: (PhoenixLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Phoenix server linked service properties.␊ - */␊ - export interface PhoenixLinkedServiceTypeProperties1 {␊ - /**␊ - * Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.␊ - */␊ - allowHostNameCNMismatch?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to allow self-signed certificates from the server. The default value is false.␊ - */␊ - allowSelfSignedServerCert?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The authentication mechanism used to connect to the Phoenix server.␊ - */␊ - authenticationType: (("Anonymous" | "UsernameAndPassword" | "WindowsAzureHDInsightService") | string)␊ - /**␊ - * Specifies whether the connections to the server are encrypted using SSL. The default value is false.␊ - */␊ - enableSsl?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The IP address or host name of the Phoenix server. (i.e. 192.168.222.160)␊ - */␊ - host: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The partial URL corresponding to the Phoenix server. (i.e. /gateway/sandbox/phoenix/version). The default value is hbasephoenix if using WindowsAzureHDInsightService.␊ - */␊ - httpPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The TCP port that the Phoenix server uses to listen for client connections. The default value is 8765.␊ - */␊ - port?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.␊ - */␊ - trustedCertPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The user name used to connect to the Phoenix server.␊ - */␊ - username?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.␊ - */␊ - useSystemTrustStore?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Presto server linked service.␊ - */␊ - export interface PrestoLinkedService1 {␊ - type: "Presto"␊ - /**␊ - * Presto server linked service properties.␊ - */␊ - typeProperties: (PrestoLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Presto server linked service properties.␊ - */␊ - export interface PrestoLinkedServiceTypeProperties1 {␊ - /**␊ - * Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.␊ - */␊ - allowHostNameCNMismatch?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to allow self-signed certificates from the server. The default value is false.␊ - */␊ - allowSelfSignedServerCert?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The authentication mechanism used to connect to the Presto server.␊ - */␊ - authenticationType: (("Anonymous" | "LDAP") | string)␊ - /**␊ - * The catalog context for all request against the server.␊ - */␊ - catalog: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether the connections to the server are encrypted using SSL. The default value is false.␊ - */␊ - enableSsl?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The IP address or host name of the Presto server. (i.e. 192.168.222.160)␊ - */␊ - host: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The TCP port that the Presto server uses to listen for client connections. The default value is 8080.␊ - */␊ - port?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The version of the Presto server. (i.e. 0.148-t)␊ - */␊ - serverVersion: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The local time zone used by the connection. Valid values for this option are specified in the IANA Time Zone Database. The default value is the system time zone.␊ - */␊ - timeZoneID?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.␊ - */␊ - trustedCertPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The user name used to connect to the Presto server.␊ - */␊ - username?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.␊ - */␊ - useSystemTrustStore?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * QuickBooks server linked service.␊ - */␊ - export interface QuickBooksLinkedService1 {␊ - type: "QuickBooks"␊ - /**␊ - * QuickBooks server linked service properties.␊ - */␊ - typeProperties: (QuickBooksLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * QuickBooks server linked service properties.␊ - */␊ - export interface QuickBooksLinkedServiceTypeProperties1 {␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - accessToken?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - accessTokenSecret?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The company ID of the QuickBooks company to authorize.␊ - */␊ - companyId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties used to connect to QuickBooks. It is mutually exclusive with any other properties in the linked service. Type: object.␊ - */␊ - connectionProperties?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The consumer key for OAuth 1.0 authentication.␊ - */␊ - consumerKey?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - consumerSecret?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The endpoint of the QuickBooks server. (i.e. quickbooks.api.intuit.com)␊ - */␊ - endpoint?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.␊ - */␊ - useEncryptedEndpoints?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ServiceNow server linked service.␊ - */␊ - export interface ServiceNowLinkedService1 {␊ - type: "ServiceNow"␊ - /**␊ - * ServiceNow server linked service properties.␊ - */␊ - typeProperties: (ServiceNowLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ServiceNow server linked service properties.␊ - */␊ - export interface ServiceNowLinkedServiceTypeProperties1 {␊ - /**␊ - * The authentication type to use.␊ - */␊ - authenticationType: (("Basic" | "OAuth2") | string)␊ - /**␊ - * The client id for OAuth2 authentication.␊ - */␊ - clientId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - clientSecret?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The endpoint of the ServiceNow server. (i.e. .service-now.com)␊ - */␊ - endpoint: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.␊ - */␊ - useEncryptedEndpoints?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.␊ - */␊ - useHostVerification?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.␊ - */␊ - usePeerVerification?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The user name used to connect to the ServiceNow server for Basic and OAuth2 authentication.␊ - */␊ - username?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Shopify Service linked service.␊ - */␊ - export interface ShopifyLinkedService1 {␊ - type: "Shopify"␊ - /**␊ - * Shopify Service linked service properties.␊ - */␊ - typeProperties: (ShopifyLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Shopify Service linked service properties.␊ - */␊ - export interface ShopifyLinkedServiceTypeProperties1 {␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - accessToken?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The endpoint of the Shopify server. (i.e. mystore.myshopify.com)␊ - */␊ - host: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.␊ - */␊ - useEncryptedEndpoints?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.␊ - */␊ - useHostVerification?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.␊ - */␊ - usePeerVerification?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Spark Server linked service.␊ - */␊ - export interface SparkLinkedService1 {␊ - type: "Spark"␊ - /**␊ - * Spark Server linked service properties.␊ - */␊ - typeProperties: (SparkLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Spark Server linked service properties.␊ - */␊ - export interface SparkLinkedServiceTypeProperties1 {␊ - /**␊ - * Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.␊ - */␊ - allowHostNameCNMismatch?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to allow self-signed certificates from the server. The default value is false.␊ - */␊ - allowSelfSignedServerCert?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The authentication method used to access the Spark server.␊ - */␊ - authenticationType: (("Anonymous" | "Username" | "UsernameAndPassword" | "WindowsAzureHDInsightService") | string)␊ - /**␊ - * Specifies whether the connections to the server are encrypted using SSL. The default value is false.␊ - */␊ - enableSsl?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP address or host name of the Spark server␊ - */␊ - host: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The partial URL corresponding to the Spark server.␊ - */␊ - httpPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The TCP port that the Spark server uses to listen for client connections.␊ - */␊ - port: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The type of Spark server.␊ - */␊ - serverType?: (("SharkServer" | "SharkServer2" | "SparkThriftServer") | string)␊ - /**␊ - * The transport protocol to use in the Thrift layer.␊ - */␊ - thriftTransportProtocol?: (("Binary" | "SASL" | "HTTP ") | string)␊ - /**␊ - * The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.␊ - */␊ - trustedCertPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The user name that you use to access Spark Server.␊ - */␊ - username?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.␊ - */␊ - useSystemTrustStore?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Square Service linked service.␊ - */␊ - export interface SquareLinkedService1 {␊ - type: "Square"␊ - /**␊ - * Square Service linked service properties.␊ - */␊ - typeProperties: (SquareLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Square Service linked service properties.␊ - */␊ - export interface SquareLinkedServiceTypeProperties1 {␊ - /**␊ - * The client ID associated with your Square application.␊ - */␊ - clientId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - clientSecret?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * Properties used to connect to Square. It is mutually exclusive with any other properties in the linked service. Type: object.␊ - */␊ - connectionProperties?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The URL of the Square instance. (i.e. mystore.mysquare.com)␊ - */␊ - host?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The redirect URL assigned in the Square application dashboard. (i.e. http://localhost:2500)␊ - */␊ - redirectUri?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.␊ - */␊ - useEncryptedEndpoints?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.␊ - */␊ - useHostVerification?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.␊ - */␊ - usePeerVerification?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Xero Service linked service.␊ - */␊ - export interface XeroLinkedService1 {␊ - type: "Xero"␊ - /**␊ - * Xero Service linked service properties.␊ - */␊ - typeProperties: (XeroLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Xero Service linked service properties.␊ - */␊ - export interface XeroLinkedServiceTypeProperties1 {␊ - /**␊ - * Properties used to connect to Xero. It is mutually exclusive with any other properties in the linked service. Type: object.␊ - */␊ - connectionProperties?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - consumerKey?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The endpoint of the Xero server. (i.e. api.xero.com)␊ - */␊ - host?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - privateKey?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.␊ - */␊ - useEncryptedEndpoints?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.␊ - */␊ - useHostVerification?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.␊ - */␊ - usePeerVerification?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Zoho server linked service.␊ - */␊ - export interface ZohoLinkedService1 {␊ - type: "Zoho"␊ - /**␊ - * Zoho server linked service properties.␊ - */␊ - typeProperties: (ZohoLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Zoho server linked service properties.␊ - */␊ - export interface ZohoLinkedServiceTypeProperties1 {␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - accessToken?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * Properties used to connect to Zoho. It is mutually exclusive with any other properties in the linked service. Type: object.␊ - */␊ - connectionProperties?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The endpoint of the Zoho server. (i.e. crm.zoho.com/crm/private)␊ - */␊ - endpoint?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.␊ - */␊ - useEncryptedEndpoints?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.␊ - */␊ - useHostVerification?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.␊ - */␊ - usePeerVerification?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Vertica linked service.␊ - */␊ - export interface VerticaLinkedService1 {␊ - type: "Vertica"␊ - /**␊ - * Vertica linked service properties.␊ - */␊ - typeProperties: (VerticaLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Vertica linked service properties.␊ - */␊ - export interface VerticaLinkedServiceTypeProperties1 {␊ - /**␊ - * An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.␊ - */␊ - connectionString?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Key Vault secret reference.␊ - */␊ - pwd?: (AzureKeyVaultSecretReference1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Netezza linked service.␊ - */␊ - export interface NetezzaLinkedService1 {␊ - type: "Netezza"␊ - /**␊ - * Netezza linked service properties.␊ - */␊ - typeProperties: (NetezzaLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Netezza linked service properties.␊ - */␊ - export interface NetezzaLinkedServiceTypeProperties1 {␊ - /**␊ - * An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.␊ - */␊ - connectionString?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Key Vault secret reference.␊ - */␊ - pwd?: (AzureKeyVaultSecretReference1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Salesforce Marketing Cloud linked service.␊ - */␊ - export interface SalesforceMarketingCloudLinkedService1 {␊ - type: "SalesforceMarketingCloud"␊ - /**␊ - * Salesforce Marketing Cloud linked service properties.␊ - */␊ - typeProperties: (SalesforceMarketingCloudLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Salesforce Marketing Cloud linked service properties.␊ - */␊ - export interface SalesforceMarketingCloudLinkedServiceTypeProperties1 {␊ - /**␊ - * The client ID associated with the Salesforce Marketing Cloud application. Type: string (or Expression with resultType string).␊ - */␊ - clientId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - clientSecret?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * Properties used to connect to Salesforce Marketing Cloud. It is mutually exclusive with any other properties in the linked service. Type: object.␊ - */␊ - connectionProperties?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean).␊ - */␊ - useEncryptedEndpoints?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).␊ - */␊ - useHostVerification?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).␊ - */␊ - usePeerVerification?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HDInsight ondemand linked service.␊ - */␊ - export interface HDInsightOnDemandLinkedService1 {␊ - type: "HDInsightOnDemand"␊ - /**␊ - * HDInsight ondemand linked service properties.␊ - */␊ - typeProperties: (HDInsightOnDemandLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HDInsight ondemand linked service properties.␊ - */␊ - export interface HDInsightOnDemandLinkedServiceTypeProperties1 {␊ - /**␊ - * Specifies additional storage accounts for the HDInsight linked service so that the Data Factory service can register them on your behalf.␊ - */␊ - additionalLinkedServiceNames?: (LinkedServiceReference1[] | string)␊ - /**␊ - * The prefix of cluster name, postfix will be distinct with timestamp. Type: string (or Expression with resultType string).␊ - */␊ - clusterNamePrefix?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - clusterPassword?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The resource group where the cluster belongs. Type: string (or Expression with resultType string).␊ - */␊ - clusterResourceGroup: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Number of worker/data nodes in the cluster. Suggestion value: 4. Type: string (or Expression with resultType string).␊ - */␊ - clusterSize: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - clusterSshPassword?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The username to SSH remotely connect to cluster’s node (for Linux). Type: string (or Expression with resultType string).␊ - */␊ - clusterSshUserName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The cluster type. Type: string (or Expression with resultType string).␊ - */␊ - clusterType?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The username to access the cluster. Type: string (or Expression with resultType string).␊ - */␊ - clusterUserName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the core configuration parameters (as in core-site.xml) for the HDInsight cluster to be created.␊ - */␊ - coreConfiguration?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Credential reference type.␊ - */␊ - credential?: (CredentialReference | string)␊ - /**␊ - * Specifies the size of the data node for the HDInsight cluster.␊ - */␊ - dataNodeSize?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the HBase configuration parameters (hbase-site.xml) for the HDInsight cluster.␊ - */␊ - hBaseConfiguration?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service reference type.␊ - */␊ - hcatalogLinkedServiceName?: (LinkedServiceReference1 | string)␊ - /**␊ - * Specifies the HDFS configuration parameters (hdfs-site.xml) for the HDInsight cluster.␊ - */␊ - hdfsConfiguration?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the size of the head node for the HDInsight cluster.␊ - */␊ - headNodeSize?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the hive configuration parameters (hive-site.xml) for the HDInsight cluster.␊ - */␊ - hiveConfiguration?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The customer’s subscription to host the cluster. Type: string (or Expression with resultType string).␊ - */␊ - hostSubscriptionId: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service reference type.␊ - */␊ - linkedServiceName: (LinkedServiceReference1 | string)␊ - /**␊ - * Specifies the MapReduce configuration parameters (mapred-site.xml) for the HDInsight cluster.␊ - */␊ - mapReduceConfiguration?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the Oozie configuration parameters (oozie-site.xml) for the HDInsight cluster.␊ - */␊ - oozieConfiguration?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Custom script actions to run on HDI ondemand cluster once it's up. Please refer to https://docs.microsoft.com/en-us/azure/hdinsight/hdinsight-hadoop-customize-cluster-linux?toc=%2Fen-us%2Fazure%2Fhdinsight%2Fr-server%2FTOC.json&bc=%2Fen-us%2Fazure%2Fbread%2Ftoc.json#understanding-script-actions.␊ - */␊ - scriptActions?: (ScriptAction2[] | string)␊ - /**␊ - * The service principal id for the hostSubscriptionId. Type: string (or Expression with resultType string).␊ - */␊ - servicePrincipalId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - servicePrincipalKey?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The version of spark if the cluster type is 'spark'. Type: string (or Expression with resultType string).␊ - */␊ - sparkVersion?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the Storm configuration parameters (storm-site.xml) for the HDInsight cluster.␊ - */␊ - stormConfiguration?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The ARM resource ID for the subnet in the vNet. If virtualNetworkId was specified, then this property is required. Type: string (or Expression with resultType string).␊ - */␊ - subnetName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Tenant id/name to which the service principal belongs. Type: string (or Expression with resultType string).␊ - */␊ - tenant: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The allowed idle time for the on-demand HDInsight cluster. Specifies how long the on-demand HDInsight cluster stays alive after completion of an activity run if there are no other active jobs in the cluster. The minimum value is 5 mins. Type: string (or Expression with resultType string).␊ - */␊ - timeToLive: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Version of the HDInsight cluster.  Type: string (or Expression with resultType string).␊ - */␊ - version: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The ARM resource ID for the vNet to which the cluster should be joined after creation. Type: string (or Expression with resultType string).␊ - */␊ - virtualNetworkId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the Yarn configuration parameters (yarn-site.xml) for the HDInsight cluster.␊ - */␊ - yarnConfiguration?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the size of the Zoo Keeper node for the HDInsight cluster.␊ - */␊ - zookeeperNodeSize?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Custom script action to run on HDI ondemand cluster once it's up.␊ - */␊ - export interface ScriptAction2 {␊ - /**␊ - * The user provided name of the script action.␊ - */␊ - name: string␊ - /**␊ - * The parameters for the script action.␊ - */␊ - parameters?: string␊ - /**␊ - * The node types on which the script action should be executed.␊ - */␊ - roles: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The URI for the script action.␊ - */␊ - uri: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Data Lake Analytics linked service.␊ - */␊ - export interface AzureDataLakeAnalyticsLinkedService1 {␊ - type: "AzureDataLakeAnalytics"␊ - /**␊ - * Azure Data Lake Analytics linked service properties.␊ - */␊ - typeProperties: (AzureDataLakeAnalyticsLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Data Lake Analytics linked service properties.␊ - */␊ - export interface AzureDataLakeAnalyticsLinkedServiceTypeProperties1 {␊ - /**␊ - * The Azure Data Lake Analytics account name. Type: string (or Expression with resultType string).␊ - */␊ - accountName: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Data Lake Analytics URI Type: string (or Expression with resultType string).␊ - */␊ - dataLakeAnalyticsUri?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Data Lake Analytics account resource group name (if different from Data Factory account). Type: string (or Expression with resultType string).␊ - */␊ - resourceGroupName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The ID of the application used to authenticate against the Azure Data Lake Analytics account. Type: string (or Expression with resultType string).␊ - */␊ - servicePrincipalId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - servicePrincipalKey?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * Data Lake Analytics account subscription ID (if different from Data Factory account). Type: string (or Expression with resultType string).␊ - */␊ - subscriptionId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).␊ - */␊ - tenant: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Databricks linked service.␊ - */␊ - export interface AzureDatabricksLinkedService1 {␊ - type: "AzureDatabricks"␊ - /**␊ - * Azure Databricks linked service properties.␊ - */␊ - typeProperties: (AzureDatabricksLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Databricks linked service properties.␊ - */␊ - export interface AzureDatabricksLinkedServiceTypeProperties1 {␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - accessToken?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * Required to specify MSI, if using Workspace resource id for databricks REST API. Type: string (or Expression with resultType string).␊ - */␊ - authentication?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Credential reference type.␊ - */␊ - credential?: (CredentialReference | string)␊ - /**␊ - * .azuredatabricks.net, domain name of your Databricks deployment. Type: string (or Expression with resultType string).␊ - */␊ - domain: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The id of an existing interactive cluster that will be used for all runs of this activity. Type: string (or Expression with resultType string).␊ - */␊ - existingClusterId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The id of an existing instance pool that will be used for all runs of this activity. Type: string (or Expression with resultType string).␊ - */␊ - instancePoolId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Additional tags for cluster resources. This property is ignored in instance pool configurations.␊ - */␊ - newClusterCustomTags?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * The driver node type for the new job cluster. This property is ignored in instance pool configurations. Type: string (or Expression with resultType string).␊ - */␊ - newClusterDriverNodeType?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Enable the elastic disk on the new cluster. This property is now ignored, and takes the default elastic disk behavior in Databricks (elastic disks are always enabled). Type: boolean (or Expression with resultType boolean).␊ - */␊ - newClusterEnableElasticDisk?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * User-defined initialization scripts for the new cluster. Type: array of strings (or Expression with resultType array of strings).␊ - */␊ - newClusterInitScripts?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specify a location to deliver Spark driver, worker, and event logs. Type: string (or Expression with resultType string).␊ - */␊ - newClusterLogDestination?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The node type of the new job cluster. This property is required if newClusterVersion is specified and instancePoolId is not specified. If instancePoolId is specified, this property is ignored. Type: string (or Expression with resultType string).␊ - */␊ - newClusterNodeType?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * If not using an existing interactive cluster, this specifies the number of worker nodes to use for the new job cluster or instance pool. For new job clusters, this a string-formatted Int32, like '1' means numOfWorker is 1 or '1:10' means auto-scale from 1 (min) to 10 (max). For instance pools, this is a string-formatted Int32, and can only specify a fixed number of worker nodes, such as '2'. Required if newClusterVersion is specified. Type: string (or Expression with resultType string).␊ - */␊ - newClusterNumOfWorker?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A set of optional, user-specified Spark configuration key-value pairs.␊ - */␊ - newClusterSparkConf?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * A set of optional, user-specified Spark environment variables key-value pairs.␊ - */␊ - newClusterSparkEnvVars?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * If not using an existing interactive cluster, this specifies the Spark version of a new job cluster or instance pool nodes created for each run of this activity. Required if instancePoolId is specified. Type: string (or Expression with resultType string).␊ - */␊ - newClusterVersion?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The policy id for limiting the ability to configure clusters based on a user defined set of rules. Type: string (or Expression with resultType string).␊ - */␊ - policyId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Workspace resource id for databricks REST API. Type: string (or Expression with resultType string).␊ - */␊ - workspaceResourceId?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Databricks Delta Lake linked service.␊ - */␊ - export interface AzureDatabricksDeltaLakeLinkedService {␊ - type: "AzureDatabricksDeltaLake"␊ - /**␊ - * Azure Databricks Delta Lake linked service properties.␊ - */␊ - typeProperties: (AzureDatabricksDetltaLakeLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Databricks Delta Lake linked service properties.␊ - */␊ - export interface AzureDatabricksDetltaLakeLinkedServiceTypeProperties {␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - accessToken?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The id of an existing interactive cluster that will be used for all runs of this job. Type: string (or Expression with resultType string).␊ - */␊ - clusterId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Credential reference type.␊ - */␊ - credential?: (CredentialReference | string)␊ - /**␊ - * .azuredatabricks.net, domain name of your Databricks deployment. Type: string (or Expression with resultType string).␊ - */␊ - domain: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Workspace resource id for databricks REST API. Type: string (or Expression with resultType string).␊ - */␊ - workspaceResourceId?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Responsys linked service.␊ - */␊ - export interface ResponsysLinkedService1 {␊ - type: "Responsys"␊ - /**␊ - * Responsys linked service properties.␊ - */␊ - typeProperties: (ResponsysLinkedServiceTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Responsys linked service properties.␊ - */␊ - export interface ResponsysLinkedServiceTypeProperties1 {␊ - /**␊ - * The client ID associated with the Responsys application. Type: string (or Expression with resultType string).␊ - */␊ - clientId: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - clientSecret?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The endpoint of the Responsys server.␊ - */␊ - endpoint: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean).␊ - */␊ - useEncryptedEndpoints?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).␊ - */␊ - useHostVerification?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).␊ - */␊ - usePeerVerification?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Dynamics AX linked service.␊ - */␊ - export interface DynamicsAXLinkedService {␊ - type: "DynamicsAX"␊ - /**␊ - * Dynamics AX linked service properties.␊ - */␊ - typeProperties: (DynamicsAXLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Dynamics AX linked service properties.␊ - */␊ - export interface DynamicsAXLinkedServiceTypeProperties {␊ - /**␊ - * Specify the resource you are requesting authorization. Type: string (or Expression with resultType string).␊ - */␊ - aadResourceId: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specify the application's client ID. Type: string (or Expression with resultType string).␊ - */␊ - servicePrincipalId: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - servicePrincipalKey: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * Specify the tenant information (domain name or tenant ID) under which your application resides. Retrieve it by hovering the mouse in the top-right corner of the Azure portal. Type: string (or Expression with resultType string).␊ - */␊ - tenant: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Dynamics AX (or Dynamics 365 Finance and Operations) instance OData endpoint.␊ - */␊ - url: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Oracle Service Cloud linked service.␊ - */␊ - export interface OracleServiceCloudLinkedService {␊ - type: "OracleServiceCloud"␊ - /**␊ - * Oracle Service Cloud linked service properties.␊ - */␊ - typeProperties: (OracleServiceCloudLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Oracle Service Cloud linked service properties.␊ - */␊ - export interface OracleServiceCloudLinkedServiceTypeProperties {␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The URL of the Oracle Service Cloud instance.␊ - */␊ - host: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean).␊ - */␊ - useEncryptedEndpoints?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).␊ - */␊ - useHostVerification?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).␊ - */␊ - usePeerVerification?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The user name that you use to access Oracle Service Cloud server.␊ - */␊ - username: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Google AdWords service linked service.␊ - */␊ - export interface GoogleAdWordsLinkedService {␊ - type: "GoogleAdWords"␊ - /**␊ - * Google AdWords service linked service properties.␊ - */␊ - typeProperties: (GoogleAdWordsLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Google AdWords service linked service properties.␊ - */␊ - export interface GoogleAdWordsLinkedServiceTypeProperties {␊ - /**␊ - * The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR.␊ - */␊ - authenticationType?: (("ServiceAuthentication" | "UserAuthentication") | string)␊ - /**␊ - * The Client customer ID of the AdWords account that you want to fetch report data for.␊ - */␊ - clientCustomerID?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The client id of the google application used to acquire the refresh token. Type: string (or Expression with resultType string).␊ - */␊ - clientId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - clientSecret?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * Properties used to connect to GoogleAds. It is mutually exclusive with any other properties in the linked service. Type: object.␊ - */␊ - connectionProperties?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - developerToken?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The service account email ID that is used for ServiceAuthentication and can only be used on self-hosted IR.␊ - */␊ - email?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The full path to the .p12 key file that is used to authenticate the service account email address and can only be used on self-hosted IR.␊ - */␊ - keyFilePath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - refreshToken?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.␊ - */␊ - trustedCertPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.␊ - */␊ - useSystemTrustStore?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SAP Table Linked Service.␊ - */␊ - export interface SapTableLinkedService {␊ - type: "SapTable"␊ - /**␊ - * Properties specific to this linked service type.␊ - */␊ - typeProperties: (SapTableLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to this linked service type.␊ - */␊ - export interface SapTableLinkedServiceTypeProperties {␊ - /**␊ - * Client ID of the client on the SAP system where the table is located. (Usually a three-digit decimal number represented as a string) Type: string (or Expression with resultType string).␊ - */␊ - clientId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Language of the SAP system where the table is located. The default value is EN. Type: string (or Expression with resultType string).␊ - */␊ - language?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Logon Group for the SAP System. Type: string (or Expression with resultType string).␊ - */␊ - logonGroup?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The hostname of the SAP Message Server. Type: string (or Expression with resultType string).␊ - */␊ - messageServer?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The service name or port number of the Message Server. Type: string (or Expression with resultType string).␊ - */␊ - messageServerService?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * Host name of the SAP instance where the table is located. Type: string (or Expression with resultType string).␊ - */␊ - server?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * External security product's library to access the SAP server where the table is located. Type: string (or Expression with resultType string).␊ - */␊ - sncLibraryPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SNC activation indicator to access the SAP server where the table is located. Must be either 0 (off) or 1 (on). Type: string (or Expression with resultType string).␊ - */␊ - sncMode?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Initiator's SNC name to access the SAP server where the table is located. Type: string (or Expression with resultType string).␊ - */␊ - sncMyName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Communication partner's SNC name to access the SAP server where the table is located. Type: string (or Expression with resultType string).␊ - */␊ - sncPartnerName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SNC Quality of Protection. Allowed value include: 1, 2, 3, 8, 9. Type: string (or Expression with resultType string).␊ - */␊ - sncQop?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SystemID of the SAP system where the table is located. Type: string (or Expression with resultType string).␊ - */␊ - systemId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * System number of the SAP system where the table is located. (Usually a two-digit decimal number represented as a string.) Type: string (or Expression with resultType string).␊ - */␊ - systemNumber?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Username to access the SAP server where the table is located. Type: string (or Expression with resultType string).␊ - */␊ - userName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Data Explorer (Kusto) linked service.␊ - */␊ - export interface AzureDataExplorerLinkedService {␊ - type: "AzureDataExplorer"␊ - /**␊ - * Azure Data Explorer (Kusto) linked service properties.␊ - */␊ - typeProperties: (AzureDataExplorerLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Data Explorer (Kusto) linked service properties.␊ - */␊ - export interface AzureDataExplorerLinkedServiceTypeProperties {␊ - /**␊ - * Credential reference type.␊ - */␊ - credential?: (CredentialReference | string)␊ - /**␊ - * Database name for connection. Type: string (or Expression with resultType string).␊ - */␊ - database: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The endpoint of Azure Data Explorer (the engine's endpoint). URL will be in the format https://..kusto.windows.net. Type: string (or Expression with resultType string)␊ - */␊ - endpoint: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The ID of the service principal used to authenticate against Azure Data Explorer. Type: string (or Expression with resultType string).␊ - */␊ - servicePrincipalId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - servicePrincipalKey?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).␊ - */␊ - tenant?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Function linked service.␊ - */␊ - export interface AzureFunctionLinkedService {␊ - type: "AzureFunction"␊ - /**␊ - * Azure Function linked service properties.␊ - */␊ - typeProperties: (AzureFunctionLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Function linked service properties.␊ - */␊ - export interface AzureFunctionLinkedServiceTypeProperties {␊ - /**␊ - * Type of authentication (Required to specify MSI) used to connect to AzureFunction. Type: string (or Expression with resultType string).␊ - */␊ - authentication?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Credential reference type.␊ - */␊ - credential?: (CredentialReference | string)␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The endpoint of the Azure Function App. URL will be in the format https://.azurewebsites.net.␊ - */␊ - functionAppUrl: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - functionKey?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * Allowed token audiences for azure function.␊ - */␊ - resourceId?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Snowflake linked service.␊ - */␊ - export interface SnowflakeLinkedService {␊ - type: "Snowflake"␊ - /**␊ - * Snowflake linked service properties.␊ - */␊ - typeProperties: (SnowflakeLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Snowflake linked service properties.␊ - */␊ - export interface SnowflakeLinkedServiceTypeProperties {␊ - /**␊ - * The connection string of snowflake. Type: string, SecureString.␊ - */␊ - connectionString: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Key Vault secret reference.␊ - */␊ - password?: (AzureKeyVaultSecretReference1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SharePoint Online List linked service.␊ - */␊ - export interface SharePointOnlineListLinkedService {␊ - type: "SharePointOnlineList"␊ - /**␊ - * SharePoint Online List linked service properties.␊ - */␊ - typeProperties: (SharePointOnlineListLinkedServiceTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SharePoint Online List linked service properties.␊ - */␊ - export interface SharePointOnlineListLinkedServiceTypeProperties {␊ - /**␊ - * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).␊ - */␊ - encryptedCredential?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The application (client) ID of your application registered in Azure Active Directory. Make sure to grant SharePoint site permission to this application. Type: string (or Expression with resultType string).␊ - */␊ - servicePrincipalId: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - servicePrincipalKey: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The URL of the SharePoint Online site. For example, https://contoso.sharepoint.com/sites/siteName. Type: string (or Expression with resultType string).␊ - */␊ - siteUrl: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The tenant ID under which your application resides. You can find it from Azure portal Active Directory overview page. Type: string (or Expression with resultType string).␊ - */␊ - tenantId: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataFactory/factories/datasets␊ - */␊ - export interface FactoriesDatasetsChildResource1 {␊ - apiVersion: "2018-06-01"␊ - /**␊ - * The dataset name.␊ - */␊ - name: string␊ - /**␊ - * The Azure Data Factory nested object which identifies data within different data stores, such as tables, files, folders, and documents.␊ - */␊ - properties: (Dataset1 | string)␊ - type: "datasets"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The folder that this Dataset is in. If not specified, Dataset will appear at the root level.␊ - */␊ - export interface DatasetFolder {␊ - /**␊ - * The name of the folder that this Dataset is in.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A single Amazon Simple Storage Service (S3) object or a set of S3 objects.␊ - */␊ - export interface AmazonS3Dataset1 {␊ - type: "AmazonS3Object"␊ - /**␊ - * Amazon S3 dataset properties.␊ - */␊ - typeProperties: (AmazonS3DatasetTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Amazon S3 dataset properties.␊ - */␊ - export interface AmazonS3DatasetTypeProperties1 {␊ - /**␊ - * The name of the Amazon S3 bucket. Type: string (or Expression with resultType string).␊ - */␊ - bucketName: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The compression method used on a dataset.␊ - */␊ - compression?: (DatasetCompression1 | string)␊ - /**␊ - * The format definition of a storage.␊ - */␊ - format?: (DatasetStorageFormat1 | string)␊ - /**␊ - * The key of the Amazon S3 object. Type: string (or Expression with resultType string).␊ - */␊ - key?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The end of S3 object's modified datetime. Type: string (or Expression with resultType string).␊ - */␊ - modifiedDatetimeEnd?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The start of S3 object's modified datetime. Type: string (or Expression with resultType string).␊ - */␊ - modifiedDatetimeStart?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The prefix filter for the S3 object name. Type: string (or Expression with resultType string).␊ - */␊ - prefix?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The version for the S3 object. Type: string (or Expression with resultType string).␊ - */␊ - version?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The compression method used on a dataset.␊ - */␊ - export interface DatasetCompression1 {␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * The dataset compression level. Type: string (or Expression with resultType string).␊ - */␊ - level?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Type of dataset compression. Type: string (or Expression with resultType string).␊ - */␊ - type: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The data stored in text format.␊ - */␊ - export interface TextFormat {␊ - /**␊ - * The column delimiter. Type: string (or Expression with resultType string).␊ - */␊ - columnDelimiter?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The code page name of the preferred encoding. If miss, the default value is ΓÇ£utf-8ΓÇ¥, unless BOM denotes another Unicode encoding. Refer to the ΓÇ£NameΓÇ¥ column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string).␊ - */␊ - encodingName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The escape character. Type: string (or Expression with resultType string).␊ - */␊ - escapeChar?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * When used as input, treat the first row of data as headers. When used as output,write the headers into the output as the first row of data. The default value is false. Type: boolean (or Expression with resultType boolean).␊ - */␊ - firstRowAsHeader?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The null value string. Type: string (or Expression with resultType string).␊ - */␊ - nullValue?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The quote character. Type: string (or Expression with resultType string).␊ - */␊ - quoteChar?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The row delimiter. Type: string (or Expression with resultType string).␊ - */␊ - rowDelimiter?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The number of lines/rows to be skipped when parsing text files. The default value is 0. Type: integer (or Expression with resultType integer).␊ - */␊ - skipLineCount?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Treat empty column values in the text file as null. The default value is true. Type: boolean (or Expression with resultType boolean).␊ - */␊ - treatEmptyAsNull?: {␊ - [k: string]: unknown␊ - }␊ - type: "TextFormat"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The data stored in JSON format.␊ - */␊ - export interface JsonFormat {␊ - /**␊ - * The code page name of the preferred encoding. If not provided, the default value is 'utf-8', unless the byte order mark (BOM) denotes another Unicode encoding. The full list of supported values can be found in the 'Name' column of the table of encodings in the following reference: https://go.microsoft.com/fwlink/?linkid=861078. Type: string (or Expression with resultType string).␊ - */␊ - encodingName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * File pattern of JSON. To be more specific, the way of separating a collection of JSON objects. The default value is 'setOfObjects'. It is case-sensitive.␊ - */␊ - filePattern?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The JSONPath of the JSON array element to be flattened. Example: "$.ArrayPath". Type: string (or Expression with resultType string).␊ - */␊ - jsonNodeReference?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The JSONPath definition for each column mapping with a customized column name to extract data from JSON file. For fields under root object, start with "$"; for fields inside the array chosen by jsonNodeReference property, start from the array element. Example: {"Column1": "$.Column1Path", "Column2": "Column2PathInArray"}. Type: object (or Expression with resultType object).␊ - */␊ - jsonPathDefinition?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The character used to separate nesting levels. Default value is '.' (dot). Type: string (or Expression with resultType string).␊ - */␊ - nestingSeparator?: {␊ - [k: string]: unknown␊ - }␊ - type: "JsonFormat"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The data stored in Avro format.␊ - */␊ - export interface AvroFormat {␊ - type: "AvroFormat"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The data stored in Optimized Row Columnar (ORC) format.␊ - */␊ - export interface OrcFormat {␊ - type: "OrcFormat"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The data stored in Parquet format.␊ - */␊ - export interface ParquetFormat {␊ - type: "ParquetFormat"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Avro dataset.␊ - */␊ - export interface AvroDataset {␊ - type: "Avro"␊ - /**␊ - * Avro dataset properties.␊ - */␊ - typeProperties?: (AvroDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Avro dataset properties.␊ - */␊ - export interface AvroDatasetTypeProperties {␊ - /**␊ - * The data avroCompressionCodec. Type: string (or Expression with resultType string).␊ - */␊ - avroCompressionCodec?: {␊ - [k: string]: unknown␊ - }␊ - avroCompressionLevel?: (number | string)␊ - /**␊ - * Dataset location.␊ - */␊ - location: (DatasetLocation | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The location of azure blob dataset.␊ - */␊ - export interface AzureBlobStorageLocation {␊ - /**␊ - * Specify the container of azure blob. Type: string (or Expression with resultType string).␊ - */␊ - container?: {␊ - [k: string]: unknown␊ - }␊ - type: "AzureBlobStorageLocation"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The location of azure blobFS dataset.␊ - */␊ - export interface AzureBlobFSLocation {␊ - /**␊ - * Specify the fileSystem of azure blobFS. Type: string (or Expression with resultType string).␊ - */␊ - fileSystem?: {␊ - [k: string]: unknown␊ - }␊ - type: "AzureBlobFSLocation"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The location of azure data lake store dataset.␊ - */␊ - export interface AzureDataLakeStoreLocation {␊ - type: "AzureDataLakeStoreLocation"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The location of amazon S3 dataset.␊ - */␊ - export interface AmazonS3Location {␊ - /**␊ - * Specify the bucketName of amazon S3. Type: string (or Expression with resultType string)␊ - */␊ - bucketName?: {␊ - [k: string]: unknown␊ - }␊ - type: "AmazonS3Location"␊ - /**␊ - * Specify the version of amazon S3. Type: string (or Expression with resultType string).␊ - */␊ - version?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The location of file server dataset.␊ - */␊ - export interface FileServerLocation {␊ - type: "FileServerLocation"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The location of file server dataset.␊ - */␊ - export interface AzureFileStorageLocation {␊ - type: "AzureFileStorageLocation"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The location of Amazon S3 Compatible dataset.␊ - */␊ - export interface AmazonS3CompatibleLocation {␊ - /**␊ - * Specify the bucketName of Amazon S3 Compatible. Type: string (or Expression with resultType string)␊ - */␊ - bucketName?: {␊ - [k: string]: unknown␊ - }␊ - type: "AmazonS3CompatibleLocation"␊ - /**␊ - * Specify the version of Amazon S3 Compatible. Type: string (or Expression with resultType string).␊ - */␊ - version?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The location of Oracle Cloud Storage dataset.␊ - */␊ - export interface OracleCloudStorageLocation {␊ - /**␊ - * Specify the bucketName of Oracle Cloud Storage. Type: string (or Expression with resultType string)␊ - */␊ - bucketName?: {␊ - [k: string]: unknown␊ - }␊ - type: "OracleCloudStorageLocation"␊ - /**␊ - * Specify the version of Oracle Cloud Storage. Type: string (or Expression with resultType string).␊ - */␊ - version?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The location of Google Cloud Storage dataset.␊ - */␊ - export interface GoogleCloudStorageLocation {␊ - /**␊ - * Specify the bucketName of Google Cloud Storage. Type: string (or Expression with resultType string)␊ - */␊ - bucketName?: {␊ - [k: string]: unknown␊ - }␊ - type: "GoogleCloudStorageLocation"␊ - /**␊ - * Specify the version of Google Cloud Storage. Type: string (or Expression with resultType string).␊ - */␊ - version?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The location of ftp server dataset.␊ - */␊ - export interface FtpServerLocation {␊ - type: "FtpServerLocation"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The location of SFTP dataset.␊ - */␊ - export interface SftpLocation {␊ - type: "SftpLocation"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The location of http server.␊ - */␊ - export interface HttpServerLocation {␊ - /**␊ - * Specify the relativeUrl of http server. Type: string (or Expression with resultType string)␊ - */␊ - relativeUrl?: {␊ - [k: string]: unknown␊ - }␊ - type: "HttpServerLocation"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The location of HDFS.␊ - */␊ - export interface HdfsLocation {␊ - type: "HdfsLocation"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Excel dataset.␊ - */␊ - export interface ExcelDataset {␊ - type: "Excel"␊ - /**␊ - * Excel dataset properties.␊ - */␊ - typeProperties?: (ExcelDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Excel dataset properties.␊ - */␊ - export interface ExcelDatasetTypeProperties {␊ - /**␊ - * The compression method used on a dataset.␊ - */␊ - compression?: (DatasetCompression1 | string)␊ - /**␊ - * When used as input, treat the first row of data as headers. When used as output,write the headers into the output as the first row of data. The default value is false. Type: boolean (or Expression with resultType boolean).␊ - */␊ - firstRowAsHeader?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Dataset location.␊ - */␊ - location: ((AzureBlobStorageLocation | AzureBlobFSLocation | AzureDataLakeStoreLocation | AmazonS3Location | FileServerLocation | AzureFileStorageLocation | AmazonS3CompatibleLocation | OracleCloudStorageLocation | GoogleCloudStorageLocation | FtpServerLocation | SftpLocation | HttpServerLocation | HdfsLocation) | string)␊ - /**␊ - * The null value string. Type: string (or Expression with resultType string).␊ - */␊ - nullValue?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The partial data of one sheet. Type: string (or Expression with resultType string).␊ - */␊ - range?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The sheet index of excel file and default value is 0. Type: integer (or Expression with resultType integer)␊ - */␊ - sheetIndex?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The sheet name of excel file. Type: string (or Expression with resultType string).␊ - */␊ - sheetName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parquet dataset.␊ - */␊ - export interface ParquetDataset {␊ - type: "Parquet"␊ - /**␊ - * Parquet dataset properties.␊ - */␊ - typeProperties?: (ParquetDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parquet dataset properties.␊ - */␊ - export interface ParquetDatasetTypeProperties {␊ - /**␊ - * The data compressionCodec. Type: string (or Expression with resultType string).␊ - */␊ - compressionCodec?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Dataset location.␊ - */␊ - location: ((AzureBlobStorageLocation | AzureBlobFSLocation | AzureDataLakeStoreLocation | AmazonS3Location | FileServerLocation | AzureFileStorageLocation | AmazonS3CompatibleLocation | OracleCloudStorageLocation | GoogleCloudStorageLocation | FtpServerLocation | SftpLocation | HttpServerLocation | HdfsLocation) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Delimited text dataset.␊ - */␊ - export interface DelimitedTextDataset {␊ - type: "DelimitedText"␊ - /**␊ - * DelimitedText dataset properties.␊ - */␊ - typeProperties?: (DelimitedTextDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DelimitedText dataset properties.␊ - */␊ - export interface DelimitedTextDatasetTypeProperties {␊ - /**␊ - * The column delimiter. Type: string (or Expression with resultType string).␊ - */␊ - columnDelimiter?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The data compressionCodec. Type: string (or Expression with resultType string).␊ - */␊ - compressionCodec?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The data compression method used for DelimitedText.␊ - */␊ - compressionLevel?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The code page name of the preferred encoding. If miss, the default value is UTF-8, unless BOM denotes another Unicode encoding. Refer to the name column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string).␊ - */␊ - encodingName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The escape character. Type: string (or Expression with resultType string).␊ - */␊ - escapeChar?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * When used as input, treat the first row of data as headers. When used as output,write the headers into the output as the first row of data. The default value is false. Type: boolean (or Expression with resultType boolean).␊ - */␊ - firstRowAsHeader?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Dataset location.␊ - */␊ - location: ((AzureBlobStorageLocation | AzureBlobFSLocation | AzureDataLakeStoreLocation | AmazonS3Location | FileServerLocation | AzureFileStorageLocation | AmazonS3CompatibleLocation | OracleCloudStorageLocation | GoogleCloudStorageLocation | FtpServerLocation | SftpLocation | HttpServerLocation | HdfsLocation) | string)␊ - /**␊ - * The null value string. Type: string (or Expression with resultType string).␊ - */␊ - nullValue?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The quote character. Type: string (or Expression with resultType string).␊ - */␊ - quoteChar?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The row delimiter. Type: string (or Expression with resultType string).␊ - */␊ - rowDelimiter?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Json dataset.␊ - */␊ - export interface JsonDataset {␊ - type: "Json"␊ - /**␊ - * Json dataset properties.␊ - */␊ - typeProperties?: (JsonDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Json dataset properties.␊ - */␊ - export interface JsonDatasetTypeProperties {␊ - /**␊ - * The compression method used on a dataset.␊ - */␊ - compression?: (DatasetCompression1 | string)␊ - /**␊ - * The code page name of the preferred encoding. If not specified, the default value is UTF-8, unless BOM denotes another Unicode encoding. Refer to the name column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string).␊ - */␊ - encodingName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Dataset location.␊ - */␊ - location: ((AzureBlobStorageLocation | AzureBlobFSLocation | AzureDataLakeStoreLocation | AmazonS3Location | FileServerLocation | AzureFileStorageLocation | AmazonS3CompatibleLocation | OracleCloudStorageLocation | GoogleCloudStorageLocation | FtpServerLocation | SftpLocation | HttpServerLocation | HdfsLocation) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Xml dataset.␊ - */␊ - export interface XmlDataset {␊ - type: "Xml"␊ - /**␊ - * Xml dataset properties.␊ - */␊ - typeProperties?: (XmlDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Xml dataset properties.␊ - */␊ - export interface XmlDatasetTypeProperties {␊ - /**␊ - * The compression method used on a dataset.␊ - */␊ - compression?: (DatasetCompression1 | string)␊ - /**␊ - * The code page name of the preferred encoding. If not specified, the default value is UTF-8, unless BOM denotes another Unicode encoding. Refer to the name column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string).␊ - */␊ - encodingName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Dataset location.␊ - */␊ - location: ((AzureBlobStorageLocation | AzureBlobFSLocation | AzureDataLakeStoreLocation | AmazonS3Location | FileServerLocation | AzureFileStorageLocation | AmazonS3CompatibleLocation | OracleCloudStorageLocation | GoogleCloudStorageLocation | FtpServerLocation | SftpLocation | HttpServerLocation | HdfsLocation) | string)␊ - /**␊ - * The null value string. Type: string (or Expression with resultType string).␊ - */␊ - nullValue?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ORC dataset.␊ - */␊ - export interface OrcDataset {␊ - type: "Orc"␊ - /**␊ - * ORC dataset properties.␊ - */␊ - typeProperties?: (OrcDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ORC dataset properties.␊ - */␊ - export interface OrcDatasetTypeProperties {␊ - /**␊ - * Dataset location.␊ - */␊ - location: ((AzureBlobStorageLocation | AzureBlobFSLocation | AzureDataLakeStoreLocation | AmazonS3Location | FileServerLocation | AzureFileStorageLocation | AmazonS3CompatibleLocation | OracleCloudStorageLocation | GoogleCloudStorageLocation | FtpServerLocation | SftpLocation | HttpServerLocation | HdfsLocation) | string)␊ - /**␊ - * The data orcCompressionCodec. Type: string (or Expression with resultType string).␊ - */␊ - orcCompressionCodec?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Binary dataset.␊ - */␊ - export interface BinaryDataset {␊ - type: "Binary"␊ - /**␊ - * Binary dataset properties.␊ - */␊ - typeProperties?: (BinaryDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Binary dataset properties.␊ - */␊ - export interface BinaryDatasetTypeProperties {␊ - /**␊ - * The compression method used on a dataset.␊ - */␊ - compression?: (DatasetCompression1 | string)␊ - /**␊ - * Dataset location.␊ - */␊ - location: ((AzureBlobStorageLocation | AzureBlobFSLocation | AzureDataLakeStoreLocation | AmazonS3Location | FileServerLocation | AzureFileStorageLocation | AmazonS3CompatibleLocation | OracleCloudStorageLocation | GoogleCloudStorageLocation | FtpServerLocation | SftpLocation | HttpServerLocation | HdfsLocation) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Azure Blob storage.␊ - */␊ - export interface AzureBlobDataset1 {␊ - type: "AzureBlob"␊ - /**␊ - * Azure Blob dataset properties.␊ - */␊ - typeProperties?: (AzureBlobDatasetTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Blob dataset properties.␊ - */␊ - export interface AzureBlobDatasetTypeProperties1 {␊ - /**␊ - * The compression method used on a dataset.␊ - */␊ - compression?: (DatasetCompression1 | string)␊ - /**␊ - * The name of the Azure Blob. Type: string (or Expression with resultType string).␊ - */␊ - fileName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The path of the Azure Blob storage. Type: string (or Expression with resultType string).␊ - */␊ - folderPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The format definition of a storage.␊ - */␊ - format?: ((TextFormat | JsonFormat | AvroFormat | OrcFormat | ParquetFormat) | string)␊ - /**␊ - * The end of Azure Blob's modified datetime. Type: string (or Expression with resultType string).␊ - */␊ - modifiedDatetimeEnd?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The start of Azure Blob's modified datetime. Type: string (or Expression with resultType string).␊ - */␊ - modifiedDatetimeStart?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The root of blob path. Type: string (or Expression with resultType string).␊ - */␊ - tableRootLocation?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Azure Table storage dataset.␊ - */␊ - export interface AzureTableDataset1 {␊ - type: "AzureTable"␊ - /**␊ - * Azure Table dataset properties.␊ - */␊ - typeProperties: (AzureTableDatasetTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Table dataset properties.␊ - */␊ - export interface AzureTableDatasetTypeProperties1 {␊ - /**␊ - * The table name of the Azure Table storage. Type: string (or Expression with resultType string).␊ - */␊ - tableName: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Azure SQL Server database dataset.␊ - */␊ - export interface AzureSqlTableDataset1 {␊ - type: "AzureSqlTable"␊ - /**␊ - * Azure SQL dataset properties.␊ - */␊ - typeProperties?: (AzureSqlTableDatasetTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure SQL dataset properties.␊ - */␊ - export interface AzureSqlTableDatasetTypeProperties1 {␊ - /**␊ - * The schema name of the Azure SQL database. Type: string (or Expression with resultType string).␊ - */␊ - schema?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The table name of the Azure SQL database. Type: string (or Expression with resultType string).␊ - */␊ - table?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * This property will be retired. Please consider using schema + table properties instead.␊ - */␊ - tableName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Azure SQL Managed Instance dataset.␊ - */␊ - export interface AzureSqlMITableDataset {␊ - type: "AzureSqlMITable"␊ - /**␊ - * Azure SQL Managed Instance dataset properties.␊ - */␊ - typeProperties?: (AzureSqlMITableDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure SQL Managed Instance dataset properties.␊ - */␊ - export interface AzureSqlMITableDatasetTypeProperties {␊ - /**␊ - * The schema name of the Azure SQL Managed Instance. Type: string (or Expression with resultType string).␊ - */␊ - schema?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The table name of the Azure SQL Managed Instance dataset. Type: string (or Expression with resultType string).␊ - */␊ - table?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * This property will be retired. Please consider using schema + table properties instead.␊ - */␊ - tableName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Azure SQL Data Warehouse dataset.␊ - */␊ - export interface AzureSqlDWTableDataset1 {␊ - type: "AzureSqlDWTable"␊ - /**␊ - * Azure SQL Data Warehouse dataset properties.␊ - */␊ - typeProperties?: (AzureSqlDWTableDatasetTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure SQL Data Warehouse dataset properties.␊ - */␊ - export interface AzureSqlDWTableDatasetTypeProperties1 {␊ - /**␊ - * The schema name of the Azure SQL Data Warehouse. Type: string (or Expression with resultType string).␊ - */␊ - schema?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The table name of the Azure SQL Data Warehouse. Type: string (or Expression with resultType string).␊ - */␊ - table?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * This property will be retired. Please consider using schema + table properties instead.␊ - */␊ - tableName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Cassandra database dataset.␊ - */␊ - export interface CassandraTableDataset1 {␊ - type: "CassandraTable"␊ - /**␊ - * Cassandra dataset properties.␊ - */␊ - typeProperties?: (CassandraTableDatasetTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Cassandra dataset properties.␊ - */␊ - export interface CassandraTableDatasetTypeProperties1 {␊ - /**␊ - * The keyspace of the Cassandra database. Type: string (or Expression with resultType string).␊ - */␊ - keyspace?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The table name of the Cassandra database. Type: string (or Expression with resultType string).␊ - */␊ - tableName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The custom dataset.␊ - */␊ - export interface CustomDataset {␊ - type: "CustomDataset"␊ - /**␊ - * Custom dataset properties.␊ - */␊ - typeProperties?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft Azure CosmosDB (SQL API) Collection dataset.␊ - */␊ - export interface CosmosDbSqlApiCollectionDataset {␊ - type: "CosmosDbSqlApiCollection"␊ - /**␊ - * CosmosDB (SQL API) Collection dataset properties.␊ - */␊ - typeProperties: (CosmosDbSqlApiCollectionDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * CosmosDB (SQL API) Collection dataset properties.␊ - */␊ - export interface CosmosDbSqlApiCollectionDatasetTypeProperties {␊ - /**␊ - * CosmosDB (SQL API) collection name. Type: string (or Expression with resultType string).␊ - */␊ - collectionName: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft Azure Document Database Collection dataset.␊ - */␊ - export interface DocumentDbCollectionDataset1 {␊ - type: "DocumentDbCollection"␊ - /**␊ - * DocumentDB Collection dataset properties.␊ - */␊ - typeProperties: (DocumentDbCollectionDatasetTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DocumentDB Collection dataset properties.␊ - */␊ - export interface DocumentDbCollectionDatasetTypeProperties1 {␊ - /**␊ - * Document Database collection name. Type: string (or Expression with resultType string).␊ - */␊ - collectionName: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Dynamics entity dataset.␊ - */␊ - export interface DynamicsEntityDataset1 {␊ - type: "DynamicsEntity"␊ - /**␊ - * Dynamics entity dataset properties.␊ - */␊ - typeProperties?: (DynamicsEntityDatasetTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Dynamics entity dataset properties.␊ - */␊ - export interface DynamicsEntityDatasetTypeProperties1 {␊ - /**␊ - * The logical name of the entity. Type: string (or Expression with resultType string).␊ - */␊ - entityName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Dynamics CRM entity dataset.␊ - */␊ - export interface DynamicsCrmEntityDataset {␊ - type: "DynamicsCrmEntity"␊ - /**␊ - * Dynamics CRM entity dataset properties.␊ - */␊ - typeProperties?: (DynamicsCrmEntityDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Dynamics CRM entity dataset properties.␊ - */␊ - export interface DynamicsCrmEntityDatasetTypeProperties {␊ - /**␊ - * The logical name of the entity. Type: string (or Expression with resultType string).␊ - */␊ - entityName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Common Data Service for Apps entity dataset.␊ - */␊ - export interface CommonDataServiceForAppsEntityDataset {␊ - type: "CommonDataServiceForAppsEntity"␊ - /**␊ - * Common Data Service for Apps entity dataset properties.␊ - */␊ - typeProperties?: (CommonDataServiceForAppsEntityDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Common Data Service for Apps entity dataset properties.␊ - */␊ - export interface CommonDataServiceForAppsEntityDatasetTypeProperties {␊ - /**␊ - * The logical name of the entity. Type: string (or Expression with resultType string).␊ - */␊ - entityName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Data Lake Store dataset.␊ - */␊ - export interface AzureDataLakeStoreDataset1 {␊ - type: "AzureDataLakeStoreFile"␊ - /**␊ - * Azure Data Lake Store dataset properties.␊ - */␊ - typeProperties?: (AzureDataLakeStoreDatasetTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Data Lake Store dataset properties.␊ - */␊ - export interface AzureDataLakeStoreDatasetTypeProperties1 {␊ - /**␊ - * The compression method used on a dataset.␊ - */␊ - compression?: (DatasetCompression1 | string)␊ - /**␊ - * The name of the file in the Azure Data Lake Store. Type: string (or Expression with resultType string).␊ - */␊ - fileName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Path to the folder in the Azure Data Lake Store. Type: string (or Expression with resultType string).␊ - */␊ - folderPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The format definition of a storage.␊ - */␊ - format?: ((TextFormat | JsonFormat | AvroFormat | OrcFormat | ParquetFormat) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Azure Data Lake Storage Gen2 storage.␊ - */␊ - export interface AzureBlobFSDataset {␊ - type: "AzureBlobFSFile"␊ - /**␊ - * Azure Data Lake Storage Gen2 dataset properties.␊ - */␊ - typeProperties?: (AzureBlobFSDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Data Lake Storage Gen2 dataset properties.␊ - */␊ - export interface AzureBlobFSDatasetTypeProperties {␊ - /**␊ - * The compression method used on a dataset.␊ - */␊ - compression?: (DatasetCompression1 | string)␊ - /**␊ - * The name of the Azure Data Lake Storage Gen2. Type: string (or Expression with resultType string).␊ - */␊ - fileName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The path of the Azure Data Lake Storage Gen2 storage. Type: string (or Expression with resultType string).␊ - */␊ - folderPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The format definition of a storage.␊ - */␊ - format?: ((TextFormat | JsonFormat | AvroFormat | OrcFormat | ParquetFormat) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Office365 account.␊ - */␊ - export interface Office365Dataset {␊ - type: "Office365Table"␊ - /**␊ - * Office365 dataset properties.␊ - */␊ - typeProperties: (Office365DatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Office365 dataset properties.␊ - */␊ - export interface Office365DatasetTypeProperties {␊ - /**␊ - * A predicate expression that can be used to filter the specific rows to extract from Office 365. Type: string (or Expression with resultType string).␊ - */␊ - predicate?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Name of the dataset to extract from Office 365. Type: string (or Expression with resultType string).␊ - */␊ - tableName: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An on-premises file system dataset.␊ - */␊ - export interface FileShareDataset1 {␊ - type: "FileShare"␊ - /**␊ - * On-premises file system dataset properties.␊ - */␊ - typeProperties?: (FileShareDatasetTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * On-premises file system dataset properties.␊ - */␊ - export interface FileShareDatasetTypeProperties1 {␊ - /**␊ - * The compression method used on a dataset.␊ - */␊ - compression?: (DatasetCompression1 | string)␊ - /**␊ - * Specify a filter to be used to select a subset of files in the folderPath rather than all files. Type: string (or Expression with resultType string).␊ - */␊ - fileFilter?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The name of the on-premises file system. Type: string (or Expression with resultType string).␊ - */␊ - fileName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The path of the on-premises file system. Type: string (or Expression with resultType string).␊ - */␊ - folderPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The format definition of a storage.␊ - */␊ - format?: ((TextFormat | JsonFormat | AvroFormat | OrcFormat | ParquetFormat) | string)␊ - /**␊ - * The end of file's modified datetime. Type: string (or Expression with resultType string).␊ - */␊ - modifiedDatetimeEnd?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The start of file's modified datetime. Type: string (or Expression with resultType string).␊ - */␊ - modifiedDatetimeStart?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The MongoDB database dataset.␊ - */␊ - export interface MongoDbCollectionDataset1 {␊ - type: "MongoDbCollection"␊ - /**␊ - * MongoDB database dataset properties.␊ - */␊ - typeProperties: (MongoDbCollectionDatasetTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * MongoDB database dataset properties.␊ - */␊ - export interface MongoDbCollectionDatasetTypeProperties1 {␊ - /**␊ - * The table name of the MongoDB database. Type: string (or Expression with resultType string).␊ - */␊ - collectionName: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The MongoDB Atlas database dataset.␊ - */␊ - export interface MongoDbAtlasCollectionDataset {␊ - type: "MongoDbAtlasCollection"␊ - /**␊ - * MongoDB Atlas database dataset properties.␊ - */␊ - typeProperties: (MongoDbAtlasCollectionDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * MongoDB Atlas database dataset properties.␊ - */␊ - export interface MongoDbAtlasCollectionDatasetTypeProperties {␊ - /**␊ - * The collection name of the MongoDB Atlas database. Type: string (or Expression with resultType string).␊ - */␊ - collection: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The MongoDB database dataset.␊ - */␊ - export interface MongoDbV2CollectionDataset {␊ - type: "MongoDbV2Collection"␊ - /**␊ - * MongoDB database dataset properties.␊ - */␊ - typeProperties: (MongoDbV2CollectionDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * MongoDB database dataset properties.␊ - */␊ - export interface MongoDbV2CollectionDatasetTypeProperties {␊ - /**␊ - * The collection name of the MongoDB database. Type: string (or Expression with resultType string).␊ - */␊ - collection: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The CosmosDB (MongoDB API) database dataset.␊ - */␊ - export interface CosmosDbMongoDbApiCollectionDataset {␊ - type: "CosmosDbMongoDbApiCollection"␊ - /**␊ - * CosmosDB (MongoDB API) database dataset properties.␊ - */␊ - typeProperties: (CosmosDbMongoDbApiCollectionDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * CosmosDB (MongoDB API) database dataset properties.␊ - */␊ - export interface CosmosDbMongoDbApiCollectionDatasetTypeProperties {␊ - /**␊ - * The collection name of the CosmosDB (MongoDB API) database. Type: string (or Expression with resultType string).␊ - */␊ - collection: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Open Data Protocol (OData) resource dataset.␊ - */␊ - export interface ODataResourceDataset1 {␊ - type: "ODataResource"␊ - /**␊ - * OData dataset properties.␊ - */␊ - typeProperties?: (ODataResourceDatasetTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * OData dataset properties.␊ - */␊ - export interface ODataResourceDatasetTypeProperties1 {␊ - /**␊ - * The OData resource path. Type: string (or Expression with resultType string).␊ - */␊ - path?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The on-premises Oracle database dataset.␊ - */␊ - export interface OracleTableDataset1 {␊ - type: "OracleTable"␊ - /**␊ - * On-premises Oracle dataset properties.␊ - */␊ - typeProperties?: (OracleTableDatasetTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * On-premises Oracle dataset properties.␊ - */␊ - export interface OracleTableDatasetTypeProperties1 {␊ - /**␊ - * The schema name of the on-premises Oracle database. Type: string (or Expression with resultType string).␊ - */␊ - schema?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The table name of the on-premises Oracle database. Type: string (or Expression with resultType string).␊ - */␊ - table?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * This property will be retired. Please consider using schema + table properties instead.␊ - */␊ - tableName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The AmazonRdsForOracle database dataset.␊ - */␊ - export interface AmazonRdsForOracleTableDataset {␊ - type: "AmazonRdsForOracleTable"␊ - /**␊ - * AmazonRdsForOracle dataset properties.␊ - */␊ - typeProperties?: (AmazonRdsForOracleTableDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AmazonRdsForOracle dataset properties.␊ - */␊ - export interface AmazonRdsForOracleTableDatasetTypeProperties {␊ - /**␊ - * The schema name of the AmazonRdsForOracle database. Type: string (or Expression with resultType string).␊ - */␊ - schema?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The table name of the AmazonRdsForOracle database. Type: string (or Expression with resultType string).␊ - */␊ - table?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Teradata database dataset.␊ - */␊ - export interface TeradataTableDataset {␊ - type: "TeradataTable"␊ - /**␊ - * Teradata dataset properties.␊ - */␊ - typeProperties?: (TeradataTableDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Teradata dataset properties.␊ - */␊ - export interface TeradataTableDatasetTypeProperties {␊ - /**␊ - * The database name of Teradata. Type: string (or Expression with resultType string).␊ - */␊ - database?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The table name of Teradata. Type: string (or Expression with resultType string).␊ - */␊ - table?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Azure MySQL database dataset.␊ - */␊ - export interface AzureMySqlTableDataset1 {␊ - type: "AzureMySqlTable"␊ - /**␊ - * Azure MySQL database dataset properties.␊ - */␊ - typeProperties: (AzureMySqlTableDatasetTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure MySQL database dataset properties.␊ - */␊ - export interface AzureMySqlTableDatasetTypeProperties1 {␊ - /**␊ - * The name of Azure MySQL database table. Type: string (or Expression with resultType string).␊ - */␊ - table?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Azure MySQL database table name. Type: string (or Expression with resultType string).␊ - */␊ - tableName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Amazon Redshift table dataset.␊ - */␊ - export interface AmazonRedshiftTableDataset {␊ - type: "AmazonRedshiftTable"␊ - /**␊ - * Amazon Redshift table dataset properties.␊ - */␊ - typeProperties?: (AmazonRedshiftTableDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Amazon Redshift table dataset properties.␊ - */␊ - export interface AmazonRedshiftTableDatasetTypeProperties {␊ - /**␊ - * The Amazon Redshift schema name. Type: string (or Expression with resultType string).␊ - */␊ - schema?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Amazon Redshift table name. Type: string (or Expression with resultType string).␊ - */␊ - table?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * This property will be retired. Please consider using schema + table properties instead.␊ - */␊ - tableName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Db2 table dataset.␊ - */␊ - export interface Db2TableDataset {␊ - type: "Db2Table"␊ - /**␊ - * Db2 table dataset properties.␊ - */␊ - typeProperties?: (Db2TableDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Db2 table dataset properties.␊ - */␊ - export interface Db2TableDatasetTypeProperties {␊ - /**␊ - * The Db2 schema name. Type: string (or Expression with resultType string).␊ - */␊ - schema?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Db2 table name. Type: string (or Expression with resultType string).␊ - */␊ - table?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * This property will be retired. Please consider using schema + table properties instead.␊ - */␊ - tableName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The relational table dataset.␊ - */␊ - export interface RelationalTableDataset1 {␊ - type: "RelationalTable"␊ - /**␊ - * Relational table dataset properties.␊ - */␊ - typeProperties?: (RelationalTableDatasetTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Relational table dataset properties.␊ - */␊ - export interface RelationalTableDatasetTypeProperties1 {␊ - /**␊ - * The relational table name. Type: string (or Expression with resultType string).␊ - */␊ - tableName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Informix table dataset.␊ - */␊ - export interface InformixTableDataset {␊ - type: "InformixTable"␊ - /**␊ - * Informix table dataset properties.␊ - */␊ - typeProperties?: (InformixTableDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Informix table dataset properties.␊ - */␊ - export interface InformixTableDatasetTypeProperties {␊ - /**␊ - * The Informix table name. Type: string (or Expression with resultType string).␊ - */␊ - tableName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The ODBC table dataset.␊ - */␊ - export interface OdbcTableDataset {␊ - type: "OdbcTable"␊ - /**␊ - * ODBC table dataset properties.␊ - */␊ - typeProperties?: (OdbcTableDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ODBC table dataset properties.␊ - */␊ - export interface OdbcTableDatasetTypeProperties {␊ - /**␊ - * The ODBC table name. Type: string (or Expression with resultType string).␊ - */␊ - tableName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The MySQL table dataset.␊ - */␊ - export interface MySqlTableDataset {␊ - type: "MySqlTable"␊ - /**␊ - * MySql table dataset properties.␊ - */␊ - typeProperties?: (MySqlTableDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * MySql table dataset properties.␊ - */␊ - export interface MySqlTableDatasetTypeProperties {␊ - /**␊ - * The MySQL table name. Type: string (or Expression with resultType string).␊ - */␊ - tableName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The PostgreSQL table dataset.␊ - */␊ - export interface PostgreSqlTableDataset {␊ - type: "PostgreSqlTable"␊ - /**␊ - * PostgreSQL table dataset properties.␊ - */␊ - typeProperties?: (PostgreSqlTableDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * PostgreSQL table dataset properties.␊ - */␊ - export interface PostgreSqlTableDatasetTypeProperties {␊ - /**␊ - * The PostgreSQL schema name. Type: string (or Expression with resultType string).␊ - */␊ - schema?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The PostgreSQL table name. Type: string (or Expression with resultType string).␊ - */␊ - table?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * This property will be retired. Please consider using schema + table properties instead.␊ - */␊ - tableName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Microsoft Access table dataset.␊ - */␊ - export interface MicrosoftAccessTableDataset {␊ - type: "MicrosoftAccessTable"␊ - /**␊ - * Microsoft Access table dataset properties.␊ - */␊ - typeProperties?: (MicrosoftAccessTableDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft Access table dataset properties.␊ - */␊ - export interface MicrosoftAccessTableDatasetTypeProperties {␊ - /**␊ - * The Microsoft Access table name. Type: string (or Expression with resultType string).␊ - */␊ - tableName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Salesforce object dataset.␊ - */␊ - export interface SalesforceObjectDataset1 {␊ - type: "SalesforceObject"␊ - /**␊ - * Salesforce object dataset properties.␊ - */␊ - typeProperties?: (SalesforceObjectDatasetTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Salesforce object dataset properties.␊ - */␊ - export interface SalesforceObjectDatasetTypeProperties1 {␊ - /**␊ - * The Salesforce object API name. Type: string (or Expression with resultType string).␊ - */␊ - objectApiName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Salesforce Service Cloud object dataset.␊ - */␊ - export interface SalesforceServiceCloudObjectDataset {␊ - type: "SalesforceServiceCloudObject"␊ - /**␊ - * Salesforce Service Cloud object dataset properties.␊ - */␊ - typeProperties?: (SalesforceServiceCloudObjectDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Salesforce Service Cloud object dataset properties.␊ - */␊ - export interface SalesforceServiceCloudObjectDatasetTypeProperties {␊ - /**␊ - * The Salesforce Service Cloud object API name. Type: string (or Expression with resultType string).␊ - */␊ - objectApiName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Sybase table dataset.␊ - */␊ - export interface SybaseTableDataset {␊ - type: "SybaseTable"␊ - /**␊ - * Sybase table dataset properties.␊ - */␊ - typeProperties?: (SybaseTableDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Sybase table dataset properties.␊ - */␊ - export interface SybaseTableDatasetTypeProperties {␊ - /**␊ - * The Sybase table name. Type: string (or Expression with resultType string).␊ - */␊ - tableName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The SAP BW cube dataset.␊ - */␊ - export interface SapBwCubeDataset {␊ - type: "SapBwCube"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The path of the SAP Cloud for Customer OData entity.␊ - */␊ - export interface SapCloudForCustomerResourceDataset1 {␊ - type: "SapCloudForCustomerResource"␊ - /**␊ - * Sap Cloud For Customer OData resource dataset properties.␊ - */␊ - typeProperties: (SapCloudForCustomerResourceDatasetTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Sap Cloud For Customer OData resource dataset properties.␊ - */␊ - export interface SapCloudForCustomerResourceDatasetTypeProperties1 {␊ - /**␊ - * The path of the SAP Cloud for Customer OData entity. Type: string (or Expression with resultType string).␊ - */␊ - path: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The path of the SAP ECC OData entity.␊ - */␊ - export interface SapEccResourceDataset1 {␊ - type: "SapEccResource"␊ - /**␊ - * Sap ECC OData resource dataset properties.␊ - */␊ - typeProperties: (SapEccResourceDatasetTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Sap ECC OData resource dataset properties.␊ - */␊ - export interface SapEccResourceDatasetTypeProperties1 {␊ - /**␊ - * The path of the SAP ECC OData entity. Type: string (or Expression with resultType string).␊ - */␊ - path: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SAP HANA Table properties.␊ - */␊ - export interface SapHanaTableDataset {␊ - type: "SapHanaTable"␊ - /**␊ - * SAP HANA Table properties.␊ - */␊ - typeProperties?: (SapHanaTableDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SAP HANA Table properties.␊ - */␊ - export interface SapHanaTableDatasetTypeProperties {␊ - /**␊ - * The schema name of SAP HANA. Type: string (or Expression with resultType string).␊ - */␊ - schema?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The table name of SAP HANA. Type: string (or Expression with resultType string).␊ - */␊ - table?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Sap Business Warehouse Open Hub Destination Table properties.␊ - */␊ - export interface SapOpenHubTableDataset {␊ - type: "SapOpenHubTable"␊ - /**␊ - * Sap Business Warehouse Open Hub Destination Table properties.␊ - */␊ - typeProperties: (SapOpenHubTableDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Sap Business Warehouse Open Hub Destination Table properties.␊ - */␊ - export interface SapOpenHubTableDatasetTypeProperties {␊ - /**␊ - * The ID of request for delta loading. Once it is set, only data with requestId larger than the value of this property will be retrieved. The default value is 0. Type: integer (or Expression with resultType integer ).␊ - */␊ - baseRequestId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Whether to exclude the records of the last request. The default value is true. Type: boolean (or Expression with resultType boolean).␊ - */␊ - excludeLastRequest?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The name of the Open Hub Destination with destination type as Database Table. Type: string (or Expression with resultType string).␊ - */␊ - openHubDestinationName: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The on-premises SQL Server dataset.␊ - */␊ - export interface SqlServerTableDataset1 {␊ - type: "SqlServerTable"␊ - /**␊ - * On-premises SQL Server dataset properties.␊ - */␊ - typeProperties?: (SqlServerTableDatasetTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * On-premises SQL Server dataset properties.␊ - */␊ - export interface SqlServerTableDatasetTypeProperties1 {␊ - /**␊ - * The schema name of the SQL Server dataset. Type: string (or Expression with resultType string).␊ - */␊ - schema?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The table name of the SQL Server dataset. Type: string (or Expression with resultType string).␊ - */␊ - table?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * This property will be retired. Please consider using schema + table properties instead.␊ - */␊ - tableName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Amazon RDS for SQL Server dataset.␊ - */␊ - export interface AmazonRdsForSqlServerTableDataset {␊ - type: "AmazonRdsForSqlServerTable"␊ - /**␊ - * The Amazon RDS for SQL Server dataset properties.␊ - */␊ - typeProperties?: (AmazonRdsForSqlServerTableDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Amazon RDS for SQL Server dataset properties.␊ - */␊ - export interface AmazonRdsForSqlServerTableDatasetTypeProperties {␊ - /**␊ - * The schema name of the SQL Server dataset. Type: string (or Expression with resultType string).␊ - */␊ - schema?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The table name of the SQL Server dataset. Type: string (or Expression with resultType string).␊ - */␊ - table?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A Rest service dataset.␊ - */␊ - export interface RestResourceDataset {␊ - type: "RestResource"␊ - /**␊ - * Properties specific to this dataset type.␊ - */␊ - typeProperties?: (RestResourceDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to this dataset type.␊ - */␊ - export interface RestResourceDatasetTypeProperties {␊ - /**␊ - * The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string).␊ - */␊ - additionalHeaders?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The pagination rules to compose next page requests. Type: string (or Expression with resultType string).␊ - */␊ - paginationRules?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The relative URL to the resource that the RESTful API provides. Type: string (or Expression with resultType string).␊ - */␊ - relativeUrl?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string).␊ - */␊ - requestBody?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string).␊ - */␊ - requestMethod?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SAP Table Resource properties.␊ - */␊ - export interface SapTableResourceDataset {␊ - type: "SapTableResource"␊ - /**␊ - * SAP Table Resource properties.␊ - */␊ - typeProperties: (SapTableResourceDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SAP Table Resource properties.␊ - */␊ - export interface SapTableResourceDatasetTypeProperties {␊ - /**␊ - * The name of the SAP Table. Type: string (or Expression with resultType string).␊ - */␊ - tableName: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SAP ODP Resource properties.␊ - */␊ - export interface SapOdpResourceDataset {␊ - type: "SapOdpResource"␊ - /**␊ - * SAP ODP Resource properties.␊ - */␊ - typeProperties: (SapOdpResourceDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SAP ODP Resource properties.␊ - */␊ - export interface SapOdpResourceDatasetTypeProperties {␊ - /**␊ - * The context of the SAP ODP Object. Type: string (or Expression with resultType string).␊ - */␊ - context: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The name of the SAP ODP Object. Type: string (or Expression with resultType string).␊ - */␊ - objectName: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The dataset points to a HTML table in the web page.␊ - */␊ - export interface WebTableDataset1 {␊ - type: "WebTable"␊ - /**␊ - * Web table dataset properties.␊ - */␊ - typeProperties: (WebTableDatasetTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Web table dataset properties.␊ - */␊ - export interface WebTableDatasetTypeProperties1 {␊ - /**␊ - * The zero-based index of the table in the web page. Type: integer (or Expression with resultType integer), minimum: 0.␊ - */␊ - index: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The relative URL to the web page from the linked service URL. Type: string (or Expression with resultType string).␊ - */␊ - path?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Azure Search Index.␊ - */␊ - export interface AzureSearchIndexDataset1 {␊ - type: "AzureSearchIndex"␊ - /**␊ - * Properties specific to this dataset type.␊ - */␊ - typeProperties: (AzureSearchIndexDatasetTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to this dataset type.␊ - */␊ - export interface AzureSearchIndexDatasetTypeProperties1 {␊ - /**␊ - * The name of the Azure Search Index. Type: string (or Expression with resultType string).␊ - */␊ - indexName: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A file in an HTTP web server.␊ - */␊ - export interface HttpDataset1 {␊ - type: "HttpFile"␊ - /**␊ - * Properties specific to this dataset type.␊ - */␊ - typeProperties?: (HttpDatasetTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to this dataset type.␊ - */␊ - export interface HttpDatasetTypeProperties1 {␊ - /**␊ - * The headers for the HTTP Request. e.g. request-header-name-1:request-header-value-1␍␊ - * ...␍␊ - * request-header-name-n:request-header-value-n Type: string (or Expression with resultType string).␊ - */␊ - additionalHeaders?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The compression method used on a dataset.␊ - */␊ - compression?: (DatasetCompression1 | string)␊ - /**␊ - * The format definition of a storage.␊ - */␊ - format?: ((TextFormat | JsonFormat | AvroFormat | OrcFormat | ParquetFormat) | string)␊ - /**␊ - * The relative URL based on the URL in the HttpLinkedService refers to an HTTP file Type: string (or Expression with resultType string).␊ - */␊ - relativeUrl?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The body for the HTTP request. Type: string (or Expression with resultType string).␊ - */␊ - requestBody?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The HTTP method for the HTTP request. Type: string (or Expression with resultType string).␊ - */␊ - requestMethod?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Amazon Marketplace Web Service dataset.␊ - */␊ - export interface AmazonMWSObjectDataset1 {␊ - type: "AmazonMWSObject"␊ - /**␊ - * Properties specific to this dataset type.␊ - */␊ - typeProperties?: (GenericDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties specific to this dataset type.␊ - */␊ - export interface GenericDatasetTypeProperties {␊ - /**␊ - * The table name. Type: string (or Expression with resultType string).␊ - */␊ - tableName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure PostgreSQL dataset.␊ - */␊ - export interface AzurePostgreSqlTableDataset1 {␊ - type: "AzurePostgreSqlTable"␊ - /**␊ - * Azure PostgreSQL dataset properties.␊ - */␊ - typeProperties?: (AzurePostgreSqlTableDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure PostgreSQL dataset properties.␊ - */␊ - export interface AzurePostgreSqlTableDatasetTypeProperties {␊ - /**␊ - * The schema name of the Azure PostgreSQL database. Type: string (or Expression with resultType string).␊ - */␊ - schema?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The table name of the Azure PostgreSQL database. Type: string (or Expression with resultType string).␊ - */␊ - table?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The table name of the Azure PostgreSQL database which includes both schema and table. Type: string (or Expression with resultType string).␊ - */␊ - tableName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Concur Service dataset.␊ - */␊ - export interface ConcurObjectDataset1 {␊ - type: "ConcurObject"␊ - /**␊ - * Properties specific to this dataset type.␊ - */␊ - typeProperties?: (GenericDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Couchbase server dataset.␊ - */␊ - export interface CouchbaseTableDataset1 {␊ - type: "CouchbaseTable"␊ - /**␊ - * Properties specific to this dataset type.␊ - */␊ - typeProperties?: (GenericDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Drill server dataset.␊ - */␊ - export interface DrillTableDataset1 {␊ - type: "DrillTable"␊ - /**␊ - * Drill Dataset Properties␊ - */␊ - typeProperties?: (DrillDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Drill Dataset Properties␊ - */␊ - export interface DrillDatasetTypeProperties {␊ - /**␊ - * The schema name of the Drill. Type: string (or Expression with resultType string).␊ - */␊ - schema?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The table name of the Drill. Type: string (or Expression with resultType string).␊ - */␊ - table?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * This property will be retired. Please consider using schema + table properties instead.␊ - */␊ - tableName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Eloqua server dataset.␊ - */␊ - export interface EloquaObjectDataset1 {␊ - type: "EloquaObject"␊ - /**␊ - * Properties specific to this dataset type.␊ - */␊ - typeProperties?: (GenericDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Google BigQuery service dataset.␊ - */␊ - export interface GoogleBigQueryObjectDataset1 {␊ - type: "GoogleBigQueryObject"␊ - /**␊ - * Google BigQuery Dataset Properties␊ - */␊ - typeProperties?: (GoogleBigQueryDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Google BigQuery Dataset Properties␊ - */␊ - export interface GoogleBigQueryDatasetTypeProperties {␊ - /**␊ - * The database name of the Google BigQuery. Type: string (or Expression with resultType string).␊ - */␊ - dataset?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The table name of the Google BigQuery. Type: string (or Expression with resultType string).␊ - */␊ - table?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * This property will be retired. Please consider using database + table properties instead.␊ - */␊ - tableName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Greenplum Database dataset.␊ - */␊ - export interface GreenplumTableDataset1 {␊ - type: "GreenplumTable"␊ - /**␊ - * Greenplum Dataset Properties␊ - */␊ - typeProperties?: (GreenplumDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Greenplum Dataset Properties␊ - */␊ - export interface GreenplumDatasetTypeProperties {␊ - /**␊ - * The schema name of Greenplum. Type: string (or Expression with resultType string).␊ - */␊ - schema?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The table name of Greenplum. Type: string (or Expression with resultType string).␊ - */␊ - table?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * This property will be retired. Please consider using schema + table properties instead.␊ - */␊ - tableName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HBase server dataset.␊ - */␊ - export interface HBaseObjectDataset1 {␊ - type: "HBaseObject"␊ - /**␊ - * Properties specific to this dataset type.␊ - */␊ - typeProperties?: (GenericDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Hive Server dataset.␊ - */␊ - export interface HiveObjectDataset1 {␊ - type: "HiveObject"␊ - /**␊ - * Hive Properties␊ - */␊ - typeProperties?: (HiveDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Hive Properties␊ - */␊ - export interface HiveDatasetTypeProperties {␊ - /**␊ - * The schema name of the Hive. Type: string (or Expression with resultType string).␊ - */␊ - schema?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The table name of the Hive. Type: string (or Expression with resultType string).␊ - */␊ - table?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * This property will be retired. Please consider using schema + table properties instead.␊ - */␊ - tableName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Hubspot Service dataset.␊ - */␊ - export interface HubspotObjectDataset1 {␊ - type: "HubspotObject"␊ - /**␊ - * Properties specific to this dataset type.␊ - */␊ - typeProperties?: (GenericDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Impala server dataset.␊ - */␊ - export interface ImpalaObjectDataset1 {␊ - type: "ImpalaObject"␊ - /**␊ - * Impala Dataset Properties␊ - */␊ - typeProperties?: (ImpalaDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Impala Dataset Properties␊ - */␊ - export interface ImpalaDatasetTypeProperties {␊ - /**␊ - * The schema name of the Impala. Type: string (or Expression with resultType string).␊ - */␊ - schema?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The table name of the Impala. Type: string (or Expression with resultType string).␊ - */␊ - table?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * This property will be retired. Please consider using schema + table properties instead.␊ - */␊ - tableName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Jira Service dataset.␊ - */␊ - export interface JiraObjectDataset1 {␊ - type: "JiraObject"␊ - /**␊ - * Properties specific to this dataset type.␊ - */␊ - typeProperties?: (GenericDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Magento server dataset.␊ - */␊ - export interface MagentoObjectDataset1 {␊ - type: "MagentoObject"␊ - /**␊ - * Properties specific to this dataset type.␊ - */␊ - typeProperties?: (GenericDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * MariaDB server dataset.␊ - */␊ - export interface MariaDBTableDataset1 {␊ - type: "MariaDBTable"␊ - /**␊ - * Properties specific to this dataset type.␊ - */␊ - typeProperties?: (GenericDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Database for MariaDB dataset.␊ - */␊ - export interface AzureMariaDBTableDataset {␊ - type: "AzureMariaDBTable"␊ - /**␊ - * Properties specific to this dataset type.␊ - */␊ - typeProperties?: (GenericDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Marketo server dataset.␊ - */␊ - export interface MarketoObjectDataset1 {␊ - type: "MarketoObject"␊ - /**␊ - * Properties specific to this dataset type.␊ - */␊ - typeProperties?: (GenericDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Paypal Service dataset.␊ - */␊ - export interface PaypalObjectDataset1 {␊ - type: "PaypalObject"␊ - /**␊ - * Properties specific to this dataset type.␊ - */␊ - typeProperties?: (GenericDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Phoenix server dataset.␊ - */␊ - export interface PhoenixObjectDataset1 {␊ - type: "PhoenixObject"␊ - /**␊ - * Phoenix Dataset Properties␊ - */␊ - typeProperties?: (PhoenixDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Phoenix Dataset Properties␊ - */␊ - export interface PhoenixDatasetTypeProperties {␊ - /**␊ - * The schema name of the Phoenix. Type: string (or Expression with resultType string).␊ - */␊ - schema?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The table name of the Phoenix. Type: string (or Expression with resultType string).␊ - */␊ - table?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * This property will be retired. Please consider using schema + table properties instead.␊ - */␊ - tableName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Presto server dataset.␊ - */␊ - export interface PrestoObjectDataset1 {␊ - type: "PrestoObject"␊ - /**␊ - * Presto Dataset Properties␊ - */␊ - typeProperties?: (PrestoDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Presto Dataset Properties␊ - */␊ - export interface PrestoDatasetTypeProperties {␊ - /**␊ - * The schema name of the Presto. Type: string (or Expression with resultType string).␊ - */␊ - schema?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The table name of the Presto. Type: string (or Expression with resultType string).␊ - */␊ - table?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * This property will be retired. Please consider using schema + table properties instead.␊ - */␊ - tableName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * QuickBooks server dataset.␊ - */␊ - export interface QuickBooksObjectDataset1 {␊ - type: "QuickBooksObject"␊ - /**␊ - * Properties specific to this dataset type.␊ - */␊ - typeProperties?: (GenericDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ServiceNow server dataset.␊ - */␊ - export interface ServiceNowObjectDataset1 {␊ - type: "ServiceNowObject"␊ - /**␊ - * Properties specific to this dataset type.␊ - */␊ - typeProperties?: (GenericDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Shopify Service dataset.␊ - */␊ - export interface ShopifyObjectDataset1 {␊ - type: "ShopifyObject"␊ - /**␊ - * Properties specific to this dataset type.␊ - */␊ - typeProperties?: (GenericDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Spark Server dataset.␊ - */␊ - export interface SparkObjectDataset1 {␊ - type: "SparkObject"␊ - /**␊ - * Spark Properties␊ - */␊ - typeProperties?: (SparkDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Spark Properties␊ - */␊ - export interface SparkDatasetTypeProperties {␊ - /**␊ - * The schema name of the Spark. Type: string (or Expression with resultType string).␊ - */␊ - schema?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The table name of the Spark. Type: string (or Expression with resultType string).␊ - */␊ - table?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * This property will be retired. Please consider using schema + table properties instead.␊ - */␊ - tableName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Square Service dataset.␊ - */␊ - export interface SquareObjectDataset1 {␊ - type: "SquareObject"␊ - /**␊ - * Properties specific to this dataset type.␊ - */␊ - typeProperties?: (GenericDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Xero Service dataset.␊ - */␊ - export interface XeroObjectDataset1 {␊ - type: "XeroObject"␊ - /**␊ - * Properties specific to this dataset type.␊ - */␊ - typeProperties?: (GenericDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Zoho server dataset.␊ - */␊ - export interface ZohoObjectDataset1 {␊ - type: "ZohoObject"␊ - /**␊ - * Properties specific to this dataset type.␊ - */␊ - typeProperties?: (GenericDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Netezza dataset.␊ - */␊ - export interface NetezzaTableDataset1 {␊ - type: "NetezzaTable"␊ - /**␊ - * Netezza dataset properties.␊ - */␊ - typeProperties?: (NetezzaTableDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Netezza dataset properties.␊ - */␊ - export interface NetezzaTableDatasetTypeProperties {␊ - /**␊ - * The schema name of the Netezza. Type: string (or Expression with resultType string).␊ - */␊ - schema?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The table name of the Netezza. Type: string (or Expression with resultType string).␊ - */␊ - table?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * This property will be retired. Please consider using schema + table properties instead.␊ - */␊ - tableName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Vertica dataset.␊ - */␊ - export interface VerticaTableDataset1 {␊ - type: "VerticaTable"␊ - /**␊ - * Vertica Properties␊ - */␊ - typeProperties?: (VerticaDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Vertica Properties␊ - */␊ - export interface VerticaDatasetTypeProperties {␊ - /**␊ - * The schema name of the Vertica. Type: string (or Expression with resultType string).␊ - */␊ - schema?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The table name of the Vertica. Type: string (or Expression with resultType string).␊ - */␊ - table?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * This property will be retired. Please consider using schema + table properties instead.␊ - */␊ - tableName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Salesforce Marketing Cloud dataset.␊ - */␊ - export interface SalesforceMarketingCloudObjectDataset1 {␊ - type: "SalesforceMarketingCloudObject"␊ - /**␊ - * Properties specific to this dataset type.␊ - */␊ - typeProperties?: (GenericDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Responsys dataset.␊ - */␊ - export interface ResponsysObjectDataset1 {␊ - type: "ResponsysObject"␊ - /**␊ - * Properties specific to this dataset type.␊ - */␊ - typeProperties?: (GenericDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The path of the Dynamics AX OData entity.␊ - */␊ - export interface DynamicsAXResourceDataset {␊ - type: "DynamicsAXResource"␊ - /**␊ - * Dynamics AX OData resource dataset properties.␊ - */␊ - typeProperties: (DynamicsAXResourceDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Dynamics AX OData resource dataset properties.␊ - */␊ - export interface DynamicsAXResourceDatasetTypeProperties {␊ - /**␊ - * The path of the Dynamics AX OData entity. Type: string (or Expression with resultType string).␊ - */␊ - path: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Oracle Service Cloud dataset.␊ - */␊ - export interface OracleServiceCloudObjectDataset {␊ - type: "OracleServiceCloudObject"␊ - /**␊ - * Properties specific to this dataset type.␊ - */␊ - typeProperties?: (GenericDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Azure Data Explorer (Kusto) dataset.␊ - */␊ - export interface AzureDataExplorerTableDataset {␊ - type: "AzureDataExplorerTable"␊ - /**␊ - * Azure Data Explorer (Kusto) dataset properties.␊ - */␊ - typeProperties: (AzureDataExplorerDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Data Explorer (Kusto) dataset properties.␊ - */␊ - export interface AzureDataExplorerDatasetTypeProperties {␊ - /**␊ - * The table name of the Azure Data Explorer database. Type: string (or Expression with resultType string).␊ - */␊ - table?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Google AdWords service dataset.␊ - */␊ - export interface GoogleAdWordsObjectDataset {␊ - type: "GoogleAdWordsObject"␊ - /**␊ - * Properties specific to this dataset type.␊ - */␊ - typeProperties?: (GenericDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The snowflake dataset.␊ - */␊ - export interface SnowflakeDataset {␊ - type: "SnowflakeTable"␊ - /**␊ - * Snowflake dataset properties.␊ - */␊ - typeProperties: (SnowflakeDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Snowflake dataset properties.␊ - */␊ - export interface SnowflakeDatasetTypeProperties {␊ - /**␊ - * The schema name of the Snowflake database. Type: string (or Expression with resultType string).␊ - */␊ - schema?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The table name of the Snowflake database. Type: string (or Expression with resultType string).␊ - */␊ - table?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The sharepoint online list resource dataset.␊ - */␊ - export interface SharePointOnlineListResourceDataset {␊ - type: "SharePointOnlineListResource"␊ - /**␊ - * Sharepoint online list dataset properties.␊ - */␊ - typeProperties?: (SharePointOnlineListDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Sharepoint online list dataset properties.␊ - */␊ - export interface SharePointOnlineListDatasetTypeProperties {␊ - /**␊ - * The name of the SharePoint Online list. Type: string (or Expression with resultType string).␊ - */␊ - listName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Databricks Delta Lake dataset.␊ - */␊ - export interface AzureDatabricksDeltaLakeDataset {␊ - type: "AzureDatabricksDeltaLakeDataset"␊ - /**␊ - * Azure Databricks Delta Lake Dataset Properties␊ - */␊ - typeProperties?: (AzureDatabricksDeltaLakeDatasetTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Databricks Delta Lake Dataset Properties␊ - */␊ - export interface AzureDatabricksDeltaLakeDatasetTypeProperties {␊ - /**␊ - * The database name of delta table. Type: string (or Expression with resultType string).␊ - */␊ - database?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The name of delta table. Type: string (or Expression with resultType string).␊ - */␊ - table?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataFactory/factories/pipelines␊ - */␊ - export interface FactoriesPipelinesChildResource1 {␊ - apiVersion: "2018-06-01"␊ - /**␊ - * The pipeline name.␊ - */␊ - name: string␊ - /**␊ - * A data factory pipeline.␊ - */␊ - properties: (Pipeline1 | string)␊ - type: "pipelines"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A data factory pipeline.␊ - */␊ - export interface Pipeline1 {␊ - /**␊ - * List of activities in pipeline.␊ - */␊ - activities?: (Activity1[] | string)␊ - /**␊ - * List of tags that can be used for describing the Pipeline.␊ - */␊ - annotations?: ({␊ - [k: string]: unknown␊ - }[] | string)␊ - /**␊ - * The max number of concurrent runs for the pipeline.␊ - */␊ - concurrency?: (number | string)␊ - /**␊ - * The description of the pipeline.␊ - */␊ - description?: string␊ - /**␊ - * The folder that this Pipeline is in. If not specified, Pipeline will appear at the root level.␊ - */␊ - folder?: (PipelineFolder | string)␊ - /**␊ - * Definition of all parameters for an entity.␊ - */␊ - parameters?: ({␊ - [k: string]: ParameterSpecification1␊ - } | string)␊ - /**␊ - * Pipeline Policy.␊ - */␊ - policy?: (PipelinePolicy | string)␊ - /**␊ - * Dimensions emitted by Pipeline.␊ - */␊ - runDimensions?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Definition of variable for a Pipeline.␊ - */␊ - variables?: ({␊ - [k: string]: VariableSpecification␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Activity dependency information.␊ - */␊ - export interface ActivityDependency1 {␊ - /**␊ - * Activity name.␊ - */␊ - activity: string␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Match-Condition for the dependency.␊ - */␊ - dependencyConditions: (("Succeeded" | "Failed" | "Skipped" | "Completed")[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * User property.␊ - */␊ - export interface UserProperty {␊ - /**␊ - * User property name.␊ - */␊ - name: string␊ - /**␊ - * User property value. Type: string (or Expression with resultType string).␊ - */␊ - value: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Execute pipeline activity.␊ - */␊ - export interface ExecutePipelineActivity1 {␊ - /**␊ - * Execution policy for an execute pipeline activity.␊ - */␊ - policy?: (ExecutePipelineActivityPolicy | string)␊ - type: "ExecutePipeline"␊ - /**␊ - * Execute pipeline activity properties.␊ - */␊ - typeProperties: (ExecutePipelineActivityTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Execution policy for an execute pipeline activity.␊ - */␊ - export interface ExecutePipelineActivityPolicy {␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * When set to true, Input from activity is considered as secure and will not be logged to monitoring.␊ - */␊ - secureInput?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Execute pipeline activity properties.␊ - */␊ - export interface ExecutePipelineActivityTypeProperties1 {␊ - /**␊ - * An object mapping parameter names to argument values.␊ - */␊ - parameters?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Pipeline reference type.␊ - */␊ - pipeline: (PipelineReference1 | string)␊ - /**␊ - * Defines whether activity execution will wait for the dependent pipeline execution to finish. Default is false.␊ - */␊ - waitOnCompletion?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Pipeline reference type.␊ - */␊ - export interface PipelineReference1 {␊ - /**␊ - * Reference name.␊ - */␊ - name?: string␊ - /**␊ - * Reference pipeline name.␊ - */␊ - referenceName: string␊ - /**␊ - * Pipeline reference type.␊ - */␊ - type: ("PipelineReference" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * This activity evaluates a boolean expression and executes either the activities under the ifTrueActivities property or the ifFalseActivities property depending on the result of the expression.␊ - */␊ - export interface IfConditionActivity1 {␊ - type: "IfCondition"␊ - /**␊ - * IfCondition activity properties.␊ - */␊ - typeProperties: (IfConditionActivityTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IfCondition activity properties.␊ - */␊ - export interface IfConditionActivityTypeProperties1 {␊ - /**␊ - * Azure Data Factory expression definition.␊ - */␊ - expression: (Expression1 | string)␊ - /**␊ - * List of activities to execute if expression is evaluated to false. This is an optional property and if not provided, the activity will exit without any action.␊ - */␊ - ifFalseActivities?: ((ControlActivity1 | ExecutionActivity1 | ExecuteWranglingDataflowActivity)[] | string)␊ - /**␊ - * List of activities to execute if expression is evaluated to true. This is an optional property and if not provided, the activity will exit without any action.␊ - */␊ - ifTrueActivities?: ((ControlActivity1 | ExecutionActivity1 | ExecuteWranglingDataflowActivity)[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Data Factory expression definition.␊ - */␊ - export interface Expression1 {␊ - /**␊ - * Expression type.␊ - */␊ - type: ("Expression" | string)␊ - /**␊ - * Expression value.␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * This activity evaluates an expression and executes activities under the cases property that correspond to the expression evaluation expected in the equals property.␊ - */␊ - export interface SwitchActivity {␊ - type: "Switch"␊ - /**␊ - * Switch activity properties.␊ - */␊ - typeProperties: (SwitchActivityTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Switch activity properties.␊ - */␊ - export interface SwitchActivityTypeProperties {␊ - /**␊ - * List of cases that correspond to expected values of the 'on' property. This is an optional property and if not provided, the activity will execute activities provided in defaultActivities.␊ - */␊ - cases?: (SwitchCase[] | string)␊ - /**␊ - * List of activities to execute if no case condition is satisfied. This is an optional property and if not provided, the activity will exit without any action.␊ - */␊ - defaultActivities?: ((ControlActivity1 | ExecutionActivity1 | ExecuteWranglingDataflowActivity)[] | string)␊ - /**␊ - * Azure Data Factory expression definition.␊ - */␊ - on: (Expression1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Switch cases with have a value and corresponding activities.␊ - */␊ - export interface SwitchCase {␊ - /**␊ - * List of activities to execute for satisfied case condition.␊ - */␊ - activities?: ((ControlActivity1 | ExecutionActivity1 | ExecuteWranglingDataflowActivity)[] | string)␊ - /**␊ - * Expected value that satisfies the expression result of the 'on' property.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * This activity is used for iterating over a collection and execute given activities.␊ - */␊ - export interface ForEachActivity1 {␊ - type: "ForEach"␊ - /**␊ - * ForEach activity properties.␊ - */␊ - typeProperties: (ForEachActivityTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ForEach activity properties.␊ - */␊ - export interface ForEachActivityTypeProperties1 {␊ - /**␊ - * List of activities to execute .␊ - */␊ - activities: ((ControlActivity1 | ExecutionActivity1 | ExecuteWranglingDataflowActivity)[] | string)␊ - /**␊ - * Batch count to be used for controlling the number of parallel execution (when isSequential is set to false).␊ - */␊ - batchCount?: (number | string)␊ - /**␊ - * Should the loop be executed in sequence or in parallel (max 50)␊ - */␊ - isSequential?: (boolean | string)␊ - /**␊ - * Azure Data Factory expression definition.␊ - */␊ - items: (Expression1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * This activity suspends pipeline execution for the specified interval.␊ - */␊ - export interface WaitActivity1 {␊ - type: "Wait"␊ - /**␊ - * Wait activity properties.␊ - */␊ - typeProperties: (WaitActivityTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Wait activity properties.␊ - */␊ - export interface WaitActivityTypeProperties1 {␊ - /**␊ - * Duration in seconds.␊ - */␊ - waitTimeInSeconds: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * This activity will fail within its own scope and output a custom error message and error code. The error message and code can provided either as a string literal or as an expression that can be evaluated to a string at runtime. The activity scope can be the whole pipeline or a control activity (e.g. foreach, switch, until), if the fail activity is contained in it.␊ - */␊ - export interface FailActivity {␊ - type: "Fail"␊ - /**␊ - * Fail activity properties.␊ - */␊ - typeProperties: (FailActivityTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Fail activity properties.␊ - */␊ - export interface FailActivityTypeProperties {␊ - /**␊ - * The error code that categorizes the error type of the Fail activity. It can be dynamic content that's evaluated to a non empty/blank string at runtime. Type: string (or Expression with resultType string).␊ - */␊ - errorCode: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The error message that surfaced in the Fail activity. It can be dynamic content that's evaluated to a non empty/blank string at runtime. Type: string (or Expression with resultType string).␊ - */␊ - message: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * This activity executes inner activities until the specified boolean expression results to true or timeout is reached, whichever is earlier.␊ - */␊ - export interface UntilActivity1 {␊ - type: "Until"␊ - /**␊ - * Until activity properties.␊ - */␊ - typeProperties: (UntilActivityTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Until activity properties.␊ - */␊ - export interface UntilActivityTypeProperties1 {␊ - /**␊ - * List of activities to execute.␊ - */␊ - activities: ((ControlActivity1 | ExecutionActivity1 | ExecuteWranglingDataflowActivity)[] | string)␊ - /**␊ - * Azure Data Factory expression definition.␊ - */␊ - expression: (Expression1 | string)␊ - /**␊ - * Specifies the timeout for the activity to run. If there is no value specified, it takes the value of TimeSpan.FromDays(7) which is 1 week as default. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9])). Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9])).␊ - */␊ - timeout?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * This activity verifies that an external resource exists.␊ - */␊ - export interface ValidationActivity {␊ - type: "Validation"␊ - /**␊ - * Validation activity properties.␊ - */␊ - typeProperties: (ValidationActivityTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Validation activity properties.␊ - */␊ - export interface ValidationActivityTypeProperties {␊ - /**␊ - * Can be used if dataset points to a folder. If set to true, the folder must have at least one file. If set to false, the folder must be empty. Type: boolean (or Expression with resultType boolean).␊ - */␊ - childItems?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Dataset reference type.␊ - */␊ - dataset: (DatasetReference1 | string)␊ - /**␊ - * Can be used if dataset points to a file. The file must be greater than or equal in size to the value specified. Type: integer (or Expression with resultType integer).␊ - */␊ - minimumSize?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A delay in seconds between validation attempts. If no value is specified, 10 seconds will be used as the default. Type: integer (or Expression with resultType integer).␊ - */␊ - sleep?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the timeout for the activity to run. If there is no value specified, it takes the value of TimeSpan.FromDays(7) which is 1 week as default. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9])).␊ - */␊ - timeout?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Dataset reference type.␊ - */␊ - export interface DatasetReference1 {␊ - /**␊ - * An object mapping parameter names to argument values.␊ - */␊ - parameters?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Reference dataset name.␊ - */␊ - referenceName: string␊ - /**␊ - * Dataset reference type.␊ - */␊ - type: ("DatasetReference" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Filter and return results from input array based on the conditions.␊ - */␊ - export interface FilterActivity1 {␊ - type: "Filter"␊ - /**␊ - * Filter activity properties.␊ - */␊ - typeProperties: (FilterActivityTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Filter activity properties.␊ - */␊ - export interface FilterActivityTypeProperties1 {␊ - /**␊ - * Azure Data Factory expression definition.␊ - */␊ - condition: (Expression1 | string)␊ - /**␊ - * Azure Data Factory expression definition.␊ - */␊ - items: (Expression1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Set value for a Variable.␊ - */␊ - export interface SetVariableActivity {␊ - type: "SetVariable"␊ - /**␊ - * SetVariable activity properties.␊ - */␊ - typeProperties: (SetVariableActivityTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SetVariable activity properties.␊ - */␊ - export interface SetVariableActivityTypeProperties {␊ - /**␊ - * Value to be set. Could be a static value or Expression␊ - */␊ - value?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Name of the variable whose value needs to be set.␊ - */␊ - variableName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Append value for a Variable of type Array.␊ - */␊ - export interface AppendVariableActivity {␊ - type: "AppendVariable"␊ - /**␊ - * AppendVariable activity properties.␊ - */␊ - typeProperties: (AppendVariableActivityTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AppendVariable activity properties.␊ - */␊ - export interface AppendVariableActivityTypeProperties {␊ - /**␊ - * Value to be appended. Could be a static value or Expression␊ - */␊ - value?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Name of the variable whose value needs to be appended to.␊ - */␊ - variableName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * WebHook activity.␊ - */␊ - export interface WebHookActivity {␊ - type: "WebHook"␊ - /**␊ - * WebHook activity type properties.␊ - */␊ - typeProperties: (WebHookActivityTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * WebHook activity type properties.␊ - */␊ - export interface WebHookActivityTypeProperties {␊ - /**␊ - * Web activity authentication properties.␊ - */␊ - authentication?: (WebActivityAuthentication1 | string)␊ - /**␊ - * Represents the payload that will be sent to the endpoint. Required for POST/PUT method, not allowed for GET method Type: string (or Expression with resultType string).␊ - */␊ - body?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents the headers that will be sent to the request. For example, to set the language and type on a request: "headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }. Type: string (or Expression with resultType string).␊ - */␊ - headers?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Rest API method for target endpoint.␊ - */␊ - method: ("POST" | string)␊ - /**␊ - * When set to true, statusCode, output and error in callback request body will be consumed by activity. The activity can be marked as failed by setting statusCode >= 400 in callback request. Default is false. Type: boolean (or Expression with resultType boolean).␊ - */␊ - reportStatusOnCallBack?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The timeout within which the webhook should be called back. If there is no value specified, it defaults to 10 minutes. Type: string. Pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9])).␊ - */␊ - timeout?: string␊ - /**␊ - * WebHook activity target endpoint and path. Type: string (or Expression with resultType string).␊ - */␊ - url: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Web activity authentication properties.␊ - */␊ - export interface WebActivityAuthentication1 {␊ - /**␊ - * Credential reference type.␊ - */␊ - credential?: (CredentialReference | string)␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - pfx?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * Resource for which Azure Auth token will be requested when using MSI Authentication. Type: string (or Expression with resultType string).␊ - */␊ - resource?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Web activity authentication (Basic/ClientCertificate/MSI/ServicePrincipal)␊ - */␊ - type?: string␊ - /**␊ - * Web activity authentication user name for basic authentication or ClientID when used for ServicePrincipal. Type: string (or Expression with resultType string).␊ - */␊ - username?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * TenantId for which Azure Auth token will be requested when using ServicePrincipal Authentication. Type: string (or Expression with resultType string).␊ - */␊ - userTenant?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Execution policy for an activity.␊ - */␊ - export interface ActivityPolicy1 {␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Maximum ordinary retry attempts. Default is 0. Type: integer (or Expression with resultType integer), minimum: 0.␊ - */␊ - retry?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Interval between each retry attempt (in seconds). The default is 30 sec.␊ - */␊ - retryIntervalInSeconds?: (number | string)␊ - /**␊ - * When set to true, Input from activity is considered as secure and will not be logged to monitoring.␊ - */␊ - secureInput?: (boolean | string)␊ - /**␊ - * When set to true, Output from activity is considered as secure and will not be logged to monitoring.␊ - */␊ - secureOutput?: (boolean | string)␊ - /**␊ - * Specifies the timeout for the activity to run. The default timeout is 7 days. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9])).␊ - */␊ - timeout?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Copy activity.␊ - */␊ - export interface CopyActivity1 {␊ - /**␊ - * List of inputs for the activity.␊ - */␊ - inputs?: (DatasetReference1[] | string)␊ - /**␊ - * List of outputs for the activity.␊ - */␊ - outputs?: (DatasetReference1[] | string)␊ - type: "Copy"␊ - /**␊ - * Copy activity properties.␊ - */␊ - typeProperties: (CopyActivityTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Copy activity properties.␊ - */␊ - export interface CopyActivityTypeProperties1 {␊ - /**␊ - * Maximum number of data integration units that can be used to perform this data movement. Type: integer (or Expression with resultType integer), minimum: 0.␊ - */␊ - dataIntegrationUnits?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Whether to skip incompatible row. Default value is false. Type: boolean (or Expression with resultType boolean).␊ - */␊ - enableSkipIncompatibleRow?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to copy data via an interim staging. Default value is false. Type: boolean (or Expression with resultType boolean).␊ - */␊ - enableStaging?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Log settings.␊ - */␊ - logSettings?: (LogSettings | string)␊ - /**␊ - * (Deprecated. Please use LogSettings) Log storage settings.␊ - */␊ - logStorageSettings?: (LogStorageSettings | string)␊ - /**␊ - * Maximum number of concurrent sessions opened on the source or sink to avoid overloading the data store. Type: integer (or Expression with resultType integer), minimum: 0.␊ - */␊ - parallelCopies?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Preserve rules.␊ - */␊ - preserve?: ({␊ - [k: string]: unknown␊ - }[] | string)␊ - /**␊ - * Preserve Rules.␊ - */␊ - preserveRules?: ({␊ - [k: string]: unknown␊ - }[] | string)␊ - /**␊ - * Redirect incompatible row settings␊ - */␊ - redirectIncompatibleRowSettings?: (RedirectIncompatibleRowSettings1 | string)␊ - /**␊ - * A copy activity sink.␊ - */␊ - sink: (CopySink1 | string)␊ - /**␊ - * Skip error file.␊ - */␊ - skipErrorFile?: (SkipErrorFile | string)␊ - /**␊ - * A copy activity source.␊ - */␊ - source: (CopySource1 | string)␊ - /**␊ - * Staging settings.␊ - */␊ - stagingSettings?: (StagingSettings1 | string)␊ - /**␊ - * Copy activity translator. If not specified, tabular translator is used.␊ - */␊ - translator?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Whether to enable Data Consistency validation. Type: boolean (or Expression with resultType boolean).␊ - */␊ - validateDataConsistency?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Log settings.␊ - */␊ - export interface LogSettings {␊ - /**␊ - * Settings for copy activity log.␊ - */␊ - copyActivityLogSettings?: (CopyActivityLogSettings | string)␊ - /**␊ - * Specifies whether to enable copy activity log. Type: boolean (or Expression with resultType boolean).␊ - */␊ - enableCopyActivityLog?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Log location settings.␊ - */␊ - logLocationSettings: (LogLocationSettings | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Settings for copy activity log.␊ - */␊ - export interface CopyActivityLogSettings {␊ - /**␊ - * Specifies whether to enable reliable logging. Type: boolean (or Expression with resultType boolean).␊ - */␊ - enableReliableLogging?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Gets or sets the log level, support: Info, Warning. Type: string (or Expression with resultType string).␊ - */␊ - logLevel?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Log location settings.␊ - */␊ - export interface LogLocationSettings {␊ - /**␊ - * Linked service reference type.␊ - */␊ - linkedServiceName: (LinkedServiceReference1 | string)␊ - /**␊ - * The path to storage for storing detailed logs of activity execution. Type: string (or Expression with resultType string).␊ - */␊ - path?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * (Deprecated. Please use LogSettings) Log storage settings.␊ - */␊ - export interface LogStorageSettings {␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Specifies whether to enable reliable logging. Type: boolean (or Expression with resultType boolean).␊ - */␊ - enableReliableLogging?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service reference type.␊ - */␊ - linkedServiceName: (LinkedServiceReference1 | string)␊ - /**␊ - * Gets or sets the log level, support: Info, Warning. Type: string (or Expression with resultType string).␊ - */␊ - logLevel?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The path to storage for storing detailed logs of activity execution. Type: string (or Expression with resultType string).␊ - */␊ - path?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Redirect incompatible row settings␊ - */␊ - export interface RedirectIncompatibleRowSettings1 {␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Name of the Azure Storage, Storage SAS, or Azure Data Lake Store linked service used for redirecting incompatible row. Must be specified if redirectIncompatibleRowSettings is specified. Type: string (or Expression with resultType string).␊ - */␊ - linkedServiceName: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The path for storing the redirect incompatible row data. Type: string (or Expression with resultType string).␊ - */␊ - path?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity DelimitedText sink.␊ - */␊ - export interface DelimitedTextSink {␊ - /**␊ - * Delimited text write settings.␊ - */␊ - formatSettings?: (DelimitedTextWriteSettings | string)␊ - /**␊ - * Connector write settings.␊ - */␊ - storeSettings?: (StoreWriteSettings | string)␊ - type: "DelimitedTextSink"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Delimited text write settings.␊ - */␊ - export interface DelimitedTextWriteSettings {␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * The file extension used to create the files. Type: string (or Expression with resultType string).␊ - */␊ - fileExtension: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the file name pattern _. when copy from non-file based store without partitionOptions. Type: string (or Expression with resultType string).␊ - */␊ - fileNamePrefix?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Limit the written file's row count to be smaller than or equal to the specified count. Type: integer (or Expression with resultType integer).␊ - */␊ - maxRowsPerFile?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Indicates whether string values should always be enclosed with quotes. Type: boolean (or Expression with resultType boolean).␊ - */␊ - quoteAllText?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Sftp write settings.␊ - */␊ - export interface SftpWriteSettings {␊ - /**␊ - * Specifies the timeout for writing each chunk to SFTP server. Default value: 01:00:00 (one hour). Type: string (or Expression with resultType string).␊ - */␊ - operationTimeout?: {␊ - [k: string]: unknown␊ - }␊ - type: "SftpWriteSettings"␊ - /**␊ - * Upload to temporary file(s) and rename. Disable this option if your SFTP server doesn't support rename operation. Type: boolean (or Expression with resultType boolean).␊ - */␊ - useTempFileRename?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure blob write settings.␊ - */␊ - export interface AzureBlobStorageWriteSettings {␊ - /**␊ - * Indicates the block size(MB) when writing data to blob. Type: integer (or Expression with resultType integer).␊ - */␊ - blockSizeInMB?: {␊ - [k: string]: unknown␊ - }␊ - type: "AzureBlobStorageWriteSettings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure blobFS write settings.␊ - */␊ - export interface AzureBlobFSWriteSettings {␊ - /**␊ - * Indicates the block size(MB) when writing data to blob. Type: integer (or Expression with resultType integer).␊ - */␊ - blockSizeInMB?: {␊ - [k: string]: unknown␊ - }␊ - type: "AzureBlobFSWriteSettings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure data lake store write settings.␊ - */␊ - export interface AzureDataLakeStoreWriteSettings {␊ - /**␊ - * Specifies the expiry time of the written files. The time is applied to the UTC time zone in the format of "2018-12-01T05:00:00Z". Default value is NULL. Type: integer (or Expression with resultType integer).␊ - */␊ - expiryDateTime?: {␊ - [k: string]: unknown␊ - }␊ - type: "AzureDataLakeStoreWriteSettings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * File server write settings.␊ - */␊ - export interface FileServerWriteSettings {␊ - type: "FileServerWriteSettings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure File Storage write settings.␊ - */␊ - export interface AzureFileStorageWriteSettings {␊ - type: "AzureFileStorageWriteSettings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Json sink.␊ - */␊ - export interface JsonSink {␊ - /**␊ - * Json write settings.␊ - */␊ - formatSettings?: (JsonWriteSettings | string)␊ - /**␊ - * Connector write settings.␊ - */␊ - storeSettings?: ((SftpWriteSettings | AzureBlobStorageWriteSettings | AzureBlobFSWriteSettings | AzureDataLakeStoreWriteSettings | FileServerWriteSettings | AzureFileStorageWriteSettings) | string)␊ - type: "JsonSink"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Json write settings.␊ - */␊ - export interface JsonWriteSettings {␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * File pattern of JSON. This setting controls the way a collection of JSON objects will be treated. The default value is 'setOfObjects'. It is case-sensitive.␊ - */␊ - filePattern?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity ORC sink.␊ - */␊ - export interface OrcSink {␊ - /**␊ - * Orc write settings.␊ - */␊ - formatSettings?: (OrcWriteSettings | string)␊ - /**␊ - * Connector write settings.␊ - */␊ - storeSettings?: ((SftpWriteSettings | AzureBlobStorageWriteSettings | AzureBlobFSWriteSettings | AzureDataLakeStoreWriteSettings | FileServerWriteSettings | AzureFileStorageWriteSettings) | string)␊ - type: "OrcSink"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Orc write settings.␊ - */␊ - export interface OrcWriteSettings {␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Specifies the file name pattern _. when copy from non-file based store without partitionOptions. Type: string (or Expression with resultType string).␊ - */␊ - fileNamePrefix?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Limit the written file's row count to be smaller than or equal to the specified count. Type: integer (or Expression with resultType integer).␊ - */␊ - maxRowsPerFile?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Rest service Sink.␊ - */␊ - export interface RestSink {␊ - /**␊ - * The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string).␊ - */␊ - additionalHeaders?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http Compression Type to Send data in compressed format with Optimal Compression Level, Default is None. And The Only Supported option is Gzip. ␊ - */␊ - httpCompressionType?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:01:40. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9])).␊ - */␊ - httpRequestTimeout?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The time to await before sending next request, in milliseconds ␊ - */␊ - requestInterval?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The HTTP method used to call the RESTful API. The default is POST. Type: string (or Expression with resultType string).␊ - */␊ - requestMethod?: {␊ - [k: string]: unknown␊ - }␊ - type: "RestSink"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Azure PostgreSQL sink.␊ - */␊ - export interface AzurePostgreSqlSink {␊ - /**␊ - * A query to execute before starting the copy. Type: string (or Expression with resultType string).␊ - */␊ - preCopyScript?: {␊ - [k: string]: unknown␊ - }␊ - type: "AzurePostgreSqlSink"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Azure MySql sink.␊ - */␊ - export interface AzureMySqlSink {␊ - /**␊ - * A query to execute before starting the copy. Type: string (or Expression with resultType string).␊ - */␊ - preCopyScript?: {␊ - [k: string]: unknown␊ - }␊ - type: "AzureMySqlSink"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Azure Databricks Delta Lake sink.␊ - */␊ - export interface AzureDatabricksDeltaLakeSink {␊ - /**␊ - * Azure Databricks Delta Lake import command settings.␊ - */␊ - importSettings?: (AzureDatabricksDeltaLakeImportCommand | string)␊ - /**␊ - * SQL pre-copy script. Type: string (or Expression with resultType string).␊ - */␊ - preCopyScript?: {␊ - [k: string]: unknown␊ - }␊ - type: "AzureDatabricksDeltaLakeSink"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Databricks Delta Lake import command settings.␊ - */␊ - export interface AzureDatabricksDeltaLakeImportCommand {␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Specify the date format for csv in Azure Databricks Delta Lake Copy. Type: string (or Expression with resultType string).␊ - */␊ - dateFormat?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specify the timestamp format for csv in Azure Databricks Delta Lake Copy. Type: string (or Expression with resultType string).␊ - */␊ - timestampFormat?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity SAP Cloud for Customer sink.␊ - */␊ - export interface SapCloudForCustomerSink {␊ - /**␊ - * The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9])).␊ - */␊ - httpRequestTimeout?: {␊ - [k: string]: unknown␊ - }␊ - type: "SapCloudForCustomerSink"␊ - /**␊ - * The write behavior for the operation. Default is 'Insert'.␊ - */␊ - writeBehavior?: (("Insert" | "Update") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Azure Queue sink.␊ - */␊ - export interface AzureQueueSink {␊ - type: "AzureQueueSink"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Azure Table sink.␊ - */␊ - export interface AzureTableSink {␊ - /**␊ - * Azure Table default partition key value. Type: string (or Expression with resultType string).␊ - */␊ - azureTableDefaultPartitionKeyValue?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Table insert type. Type: string (or Expression with resultType string).␊ - */␊ - azureTableInsertType?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Table partition key name. Type: string (or Expression with resultType string).␊ - */␊ - azureTablePartitionKeyName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Table row key name. Type: string (or Expression with resultType string).␊ - */␊ - azureTableRowKeyName?: {␊ - [k: string]: unknown␊ - }␊ - type: "AzureTableSink"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Avro sink.␊ - */␊ - export interface AvroSink {␊ - /**␊ - * Avro write settings.␊ - */␊ - formatSettings?: (AvroWriteSettings | string)␊ - /**␊ - * Connector write settings.␊ - */␊ - storeSettings?: ((SftpWriteSettings | AzureBlobStorageWriteSettings | AzureBlobFSWriteSettings | AzureDataLakeStoreWriteSettings | FileServerWriteSettings | AzureFileStorageWriteSettings) | string)␊ - type: "AvroSink"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Avro write settings.␊ - */␊ - export interface AvroWriteSettings {␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Specifies the file name pattern _. when copy from non-file based store without partitionOptions. Type: string (or Expression with resultType string).␊ - */␊ - fileNamePrefix?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Limit the written file's row count to be smaller than or equal to the specified count. Type: integer (or Expression with resultType integer).␊ - */␊ - maxRowsPerFile?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Top level record name in write result, which is required in AVRO spec.␊ - */␊ - recordName?: string␊ - /**␊ - * Record namespace in the write result.␊ - */␊ - recordNamespace?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Parquet sink.␊ - */␊ - export interface ParquetSink {␊ - /**␊ - * Parquet write settings.␊ - */␊ - formatSettings?: (ParquetWriteSettings | string)␊ - /**␊ - * Connector write settings.␊ - */␊ - storeSettings?: ((SftpWriteSettings | AzureBlobStorageWriteSettings | AzureBlobFSWriteSettings | AzureDataLakeStoreWriteSettings | FileServerWriteSettings | AzureFileStorageWriteSettings) | string)␊ - type: "ParquetSink"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parquet write settings.␊ - */␊ - export interface ParquetWriteSettings {␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Specifies the file name pattern _. when copy from non-file based store without partitionOptions. Type: string (or Expression with resultType string).␊ - */␊ - fileNamePrefix?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Limit the written file's row count to be smaller than or equal to the specified count. Type: integer (or Expression with resultType integer).␊ - */␊ - maxRowsPerFile?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Binary sink.␊ - */␊ - export interface BinarySink {␊ - /**␊ - * Connector write settings.␊ - */␊ - storeSettings?: ((SftpWriteSettings | AzureBlobStorageWriteSettings | AzureBlobFSWriteSettings | AzureDataLakeStoreWriteSettings | FileServerWriteSettings | AzureFileStorageWriteSettings) | string)␊ - type: "BinarySink"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Azure Blob sink.␊ - */␊ - export interface BlobSink {␊ - /**␊ - * Blob writer add header. Type: boolean (or Expression with resultType boolean).␊ - */␊ - blobWriterAddHeader?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Blob writer date time format. Type: string (or Expression with resultType string).␊ - */␊ - blobWriterDateTimeFormat?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Blob writer overwrite files. Type: boolean (or Expression with resultType boolean).␊ - */␊ - blobWriterOverwriteFiles?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The type of copy behavior for copy sink.␊ - */␊ - copyBehavior?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specify the custom metadata to be added to sink data. Type: array of objects (or Expression with resultType array of objects).␊ - */␊ - metadata?: (MetadataItem1[] | string)␊ - type: "BlobSink"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specify the name and value of custom metadata item.␊ - */␊ - export interface MetadataItem1 {␊ - /**␊ - * Metadata item key name. Type: string (or Expression with resultType string).␊ - */␊ - name?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Metadata item value. Type: string (or Expression with resultType string).␊ - */␊ - value?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity file system sink.␊ - */␊ - export interface FileSystemSink {␊ - /**␊ - * The type of copy behavior for copy sink.␊ - */␊ - copyBehavior?: {␊ - [k: string]: unknown␊ - }␊ - type: "FileSystemSink"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Document Database Collection sink.␊ - */␊ - export interface DocumentDbCollectionSink {␊ - /**␊ - * Nested properties separator. Default is . (dot). Type: string (or Expression with resultType string).␊ - */␊ - nestingSeparator?: {␊ - [k: string]: unknown␊ - }␊ - type: "DocumentDbCollectionSink"␊ - /**␊ - * Describes how to write data to Azure Cosmos DB. Type: string (or Expression with resultType string). Allowed values: insert and upsert.␊ - */␊ - writeBehavior?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Azure CosmosDB (SQL API) Collection sink.␊ - */␊ - export interface CosmosDbSqlApiSink {␊ - type: "CosmosDbSqlApiSink"␊ - /**␊ - * Describes how to write data to Azure Cosmos DB. Type: string (or Expression with resultType string). Allowed values: insert and upsert.␊ - */␊ - writeBehavior?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity SQL sink.␊ - */␊ - export interface SqlSink {␊ - /**␊ - * SQL pre-copy script. Type: string (or Expression with resultType string).␊ - */␊ - preCopyScript?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SQL writer stored procedure name. Type: string (or Expression with resultType string).␊ - */␊ - sqlWriterStoredProcedureName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SQL writer table type. Type: string (or Expression with resultType string).␊ - */␊ - sqlWriterTableType?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Whether to use table lock during bulk copy. Type: boolean (or Expression with resultType boolean).␊ - */␊ - sqlWriterUseTableLock?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SQL stored procedure parameters.␊ - */␊ - storedProcedureParameters?: ({␊ - [k: string]: StoredProcedureParameter1␊ - } | string)␊ - /**␊ - * The stored procedure parameter name of the table type. Type: string (or Expression with resultType string).␊ - */␊ - storedProcedureTableTypeParameterName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string).␊ - */␊ - tableOption?: {␊ - [k: string]: unknown␊ - }␊ - type: "SqlSink"␊ - /**␊ - * Sql upsert option settings␊ - */␊ - upsertSettings?: (SqlUpsertSettings | string)␊ - /**␊ - * Write behavior when copying data into sql. Type: SqlWriteBehaviorEnum (or Expression with resultType SqlWriteBehaviorEnum)␊ - */␊ - writeBehavior?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SQL stored procedure parameter.␊ - */␊ - export interface StoredProcedureParameter1 {␊ - /**␊ - * Stored procedure parameter type.␊ - */␊ - type?: (("String" | "Int" | "Int64" | "Decimal" | "Guid" | "Boolean" | "Date") | string)␊ - /**␊ - * Stored procedure parameter value. Type: string (or Expression with resultType string).␊ - */␊ - value?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Sql upsert option settings␊ - */␊ - export interface SqlUpsertSettings {␊ - /**␊ - * Schema name for interim table. Type: string (or Expression with resultType string).␊ - */␊ - interimSchemaName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Key column names for unique row identification. Type: array of strings (or Expression with resultType array of strings).␊ - */␊ - keys?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies whether to use temp db for upsert interim table. Type: boolean (or Expression with resultType boolean).␊ - */␊ - useTempDB?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity SQL server sink.␊ - */␊ - export interface SqlServerSink {␊ - /**␊ - * SQL pre-copy script. Type: string (or Expression with resultType string).␊ - */␊ - preCopyScript?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SQL writer stored procedure name. Type: string (or Expression with resultType string).␊ - */␊ - sqlWriterStoredProcedureName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SQL writer table type. Type: string (or Expression with resultType string).␊ - */␊ - sqlWriterTableType?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Whether to use table lock during bulk copy. Type: boolean (or Expression with resultType boolean).␊ - */␊ - sqlWriterUseTableLock?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SQL stored procedure parameters.␊ - */␊ - storedProcedureParameters?: ({␊ - [k: string]: StoredProcedureParameter1␊ - } | string)␊ - /**␊ - * The stored procedure parameter name of the table type. Type: string (or Expression with resultType string).␊ - */␊ - storedProcedureTableTypeParameterName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string).␊ - */␊ - tableOption?: {␊ - [k: string]: unknown␊ - }␊ - type: "SqlServerSink"␊ - /**␊ - * Sql upsert option settings␊ - */␊ - upsertSettings?: (SqlUpsertSettings | string)␊ - /**␊ - * Write behavior when copying data into sql server. Type: SqlWriteBehaviorEnum (or Expression with resultType SqlWriteBehaviorEnum)␊ - */␊ - writeBehavior?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Azure SQL sink.␊ - */␊ - export interface AzureSqlSink {␊ - /**␊ - * SQL pre-copy script. Type: string (or Expression with resultType string).␊ - */␊ - preCopyScript?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SQL writer stored procedure name. Type: string (or Expression with resultType string).␊ - */␊ - sqlWriterStoredProcedureName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SQL writer table type. Type: string (or Expression with resultType string).␊ - */␊ - sqlWriterTableType?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Whether to use table lock during bulk copy. Type: boolean (or Expression with resultType boolean).␊ - */␊ - sqlWriterUseTableLock?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SQL stored procedure parameters.␊ - */␊ - storedProcedureParameters?: ({␊ - [k: string]: StoredProcedureParameter1␊ - } | string)␊ - /**␊ - * The stored procedure parameter name of the table type. Type: string (or Expression with resultType string).␊ - */␊ - storedProcedureTableTypeParameterName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string).␊ - */␊ - tableOption?: {␊ - [k: string]: unknown␊ - }␊ - type: "AzureSqlSink"␊ - /**␊ - * Sql upsert option settings␊ - */␊ - upsertSettings?: (SqlUpsertSettings | string)␊ - /**␊ - * Write behavior when copying data into Azure SQL. Type: SqlWriteBehaviorEnum (or Expression with resultType SqlWriteBehaviorEnum)␊ - */␊ - writeBehavior?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Azure SQL Managed Instance sink.␊ - */␊ - export interface SqlMISink {␊ - /**␊ - * SQL pre-copy script. Type: string (or Expression with resultType string).␊ - */␊ - preCopyScript?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SQL writer stored procedure name. Type: string (or Expression with resultType string).␊ - */␊ - sqlWriterStoredProcedureName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SQL writer table type. Type: string (or Expression with resultType string).␊ - */␊ - sqlWriterTableType?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Whether to use table lock during bulk copy. Type: boolean (or Expression with resultType boolean).␊ - */␊ - sqlWriterUseTableLock?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SQL stored procedure parameters.␊ - */␊ - storedProcedureParameters?: ({␊ - [k: string]: StoredProcedureParameter1␊ - } | string)␊ - /**␊ - * The stored procedure parameter name of the table type. Type: string (or Expression with resultType string).␊ - */␊ - storedProcedureTableTypeParameterName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string).␊ - */␊ - tableOption?: {␊ - [k: string]: unknown␊ - }␊ - type: "SqlMISink"␊ - /**␊ - * Sql upsert option settings␊ - */␊ - upsertSettings?: (SqlUpsertSettings | string)␊ - /**␊ - * White behavior when copying data into azure SQL MI. Type: SqlWriteBehaviorEnum (or Expression with resultType SqlWriteBehaviorEnum)␊ - */␊ - writeBehavior?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity SQL Data Warehouse sink.␊ - */␊ - export interface SqlDWSink {␊ - /**␊ - * Indicates to use Copy Command to copy data into SQL Data Warehouse. Type: boolean (or Expression with resultType boolean).␊ - */␊ - allowCopyCommand?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Indicates to use PolyBase to copy data into SQL Data Warehouse when applicable. Type: boolean (or Expression with resultType boolean).␊ - */␊ - allowPolyBase?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DW Copy Command settings.␊ - */␊ - copyCommandSettings?: (DWCopyCommandSettings | string)␊ - /**␊ - * PolyBase settings.␊ - */␊ - polyBaseSettings?: (PolybaseSettings | string)␊ - /**␊ - * SQL pre-copy script. Type: string (or Expression with resultType string).␊ - */␊ - preCopyScript?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Whether to use table lock during bulk copy. Type: boolean (or Expression with resultType boolean).␊ - */␊ - sqlWriterUseTableLock?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string).␊ - */␊ - tableOption?: {␊ - [k: string]: unknown␊ - }␊ - type: "SqlDWSink"␊ - /**␊ - * Sql DW upsert option settings␊ - */␊ - upsertSettings?: (SqlDWUpsertSettings | string)␊ - /**␊ - * Write behavior when copying data into azure SQL DW. Type: SqlDWWriteBehaviorEnum (or Expression with resultType SqlDWWriteBehaviorEnum)␊ - */␊ - writeBehavior?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DW Copy Command settings.␊ - */␊ - export interface DWCopyCommandSettings {␊ - /**␊ - * Additional options directly passed to SQL DW in Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: "additionalOptions": { "MAXERRORS": "1000", "DATEFORMAT": "'ymd'" }␊ - */␊ - additionalOptions?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Specifies the default values for each target column in SQL DW. The default values in the property overwrite the DEFAULT constraint set in the DB, and identity column cannot have a default value. Type: array of objects (or Expression with resultType array of objects).␊ - */␊ - defaultValues?: (DWCopyCommandDefaultValue[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Default value.␊ - */␊ - export interface DWCopyCommandDefaultValue {␊ - /**␊ - * Column name. Type: object (or Expression with resultType string).␊ - */␊ - columnName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The default value of the column. Type: object (or Expression with resultType string).␊ - */␊ - defaultValue?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * PolyBase settings.␊ - */␊ - export interface PolybaseSettings {␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Determines the number of rows to attempt to retrieve before the PolyBase recalculates the percentage of rejected rows. Type: integer (or Expression with resultType integer), minimum: 0.␊ - */␊ - rejectSampleValue?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Reject type.␊ - */␊ - rejectType?: (("value" | "percentage") | string)␊ - /**␊ - * Specifies the value or the percentage of rows that can be rejected before the query fails. Type: number (or Expression with resultType number), minimum: 0.␊ - */␊ - rejectValue?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies how to handle missing values in delimited text files when PolyBase retrieves data from the text file. Type: boolean (or Expression with resultType boolean).␊ - */␊ - useTypeDefault?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Sql DW upsert option settings␊ - */␊ - export interface SqlDWUpsertSettings {␊ - /**␊ - * Schema name for interim table. Type: string (or Expression with resultType string).␊ - */␊ - interimSchemaName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Key column names for unique row identification. Type: array of strings (or Expression with resultType array of strings).␊ - */␊ - keys?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity snowflake sink.␊ - */␊ - export interface SnowflakeSink {␊ - /**␊ - * Snowflake import command settings.␊ - */␊ - importSettings?: (SnowflakeImportCopyCommand | string)␊ - /**␊ - * SQL pre-copy script. Type: string (or Expression with resultType string).␊ - */␊ - preCopyScript?: {␊ - [k: string]: unknown␊ - }␊ - type: "SnowflakeSink"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Snowflake import command settings.␊ - */␊ - export interface SnowflakeImportCopyCommand {␊ - /**␊ - * Additional copy options directly passed to snowflake Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: "additionalCopyOptions": { "DATE_FORMAT": "MM/DD/YYYY", "TIME_FORMAT": "'HH24:MI:SS.FF'" }␊ - */␊ - additionalCopyOptions?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Additional format options directly passed to snowflake Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: "additionalFormatOptions": { "FORCE": "TRUE", "LOAD_UNCERTAIN_FILES": "'FALSE'" }␊ - */␊ - additionalFormatOptions?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Oracle sink.␊ - */␊ - export interface OracleSink {␊ - /**␊ - * SQL pre-copy script. Type: string (or Expression with resultType string).␊ - */␊ - preCopyScript?: {␊ - [k: string]: unknown␊ - }␊ - type: "OracleSink"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Azure Data Lake Store sink.␊ - */␊ - export interface AzureDataLakeStoreSink {␊ - /**␊ - * The type of copy behavior for copy sink.␊ - */␊ - copyBehavior?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Single File Parallel.␊ - */␊ - enableAdlsSingleFileParallel?: {␊ - [k: string]: unknown␊ - }␊ - type: "AzureDataLakeStoreSink"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Azure Data Lake Storage Gen2 sink.␊ - */␊ - export interface AzureBlobFSSink {␊ - /**␊ - * The type of copy behavior for copy sink.␊ - */␊ - copyBehavior?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specify the custom metadata to be added to sink data. Type: array of objects (or Expression with resultType array of objects).␊ - */␊ - metadata?: (MetadataItem1[] | string)␊ - type: "AzureBlobFSSink"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Azure Search Index sink.␊ - */␊ - export interface AzureSearchIndexSink {␊ - type: "AzureSearchIndexSink"␊ - /**␊ - * Specify the write behavior when upserting documents into Azure Search Index.␊ - */␊ - writeBehavior?: (("Merge" | "Upload") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity ODBC sink.␊ - */␊ - export interface OdbcSink {␊ - /**␊ - * A query to execute before starting the copy. Type: string (or Expression with resultType string).␊ - */␊ - preCopyScript?: {␊ - [k: string]: unknown␊ - }␊ - type: "OdbcSink"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Informix sink.␊ - */␊ - export interface InformixSink {␊ - /**␊ - * A query to execute before starting the copy. Type: string (or Expression with resultType string).␊ - */␊ - preCopyScript?: {␊ - [k: string]: unknown␊ - }␊ - type: "InformixSink"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Microsoft Access sink.␊ - */␊ - export interface MicrosoftAccessSink {␊ - /**␊ - * A query to execute before starting the copy. Type: string (or Expression with resultType string).␊ - */␊ - preCopyScript?: {␊ - [k: string]: unknown␊ - }␊ - type: "MicrosoftAccessSink"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Dynamics sink.␊ - */␊ - export interface DynamicsSink {␊ - /**␊ - * The logical name of the alternate key which will be used when upserting records. Type: string (or Expression with resultType string).␊ - */␊ - alternateKeyName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The flag indicating whether ignore null values from input dataset (except key fields) during write operation. Default is false. Type: boolean (or Expression with resultType boolean).␊ - */␊ - ignoreNullValues?: {␊ - [k: string]: unknown␊ - }␊ - type: "DynamicsSink"␊ - /**␊ - * The write behavior for the operation.␊ - */␊ - writeBehavior: ("Upsert" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Dynamics CRM sink.␊ - */␊ - export interface DynamicsCrmSink {␊ - /**␊ - * The logical name of the alternate key which will be used when upserting records. Type: string (or Expression with resultType string).␊ - */␊ - alternateKeyName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The flag indicating whether to ignore null values from input dataset (except key fields) during write operation. Default is false. Type: boolean (or Expression with resultType boolean).␊ - */␊ - ignoreNullValues?: {␊ - [k: string]: unknown␊ - }␊ - type: "DynamicsCrmSink"␊ - /**␊ - * The write behavior for the operation.␊ - */␊ - writeBehavior: ("Upsert" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Common Data Service for Apps sink.␊ - */␊ - export interface CommonDataServiceForAppsSink {␊ - /**␊ - * The logical name of the alternate key which will be used when upserting records. Type: string (or Expression with resultType string).␊ - */␊ - alternateKeyName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The flag indicating whether to ignore null values from input dataset (except key fields) during write operation. Default is false. Type: boolean (or Expression with resultType boolean).␊ - */␊ - ignoreNullValues?: {␊ - [k: string]: unknown␊ - }␊ - type: "CommonDataServiceForAppsSink"␊ - /**␊ - * The write behavior for the operation.␊ - */␊ - writeBehavior: ("Upsert" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Azure Data Explorer sink.␊ - */␊ - export interface AzureDataExplorerSink {␊ - /**␊ - * If set to true, any aggregation will be skipped. Default is false. Type: boolean.␊ - */␊ - flushImmediately?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An explicit column mapping description provided in a json format. Type: string.␊ - */␊ - ingestionMappingAsJson?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A name of a pre-created csv mapping that was defined on the target Kusto table. Type: string.␊ - */␊ - ingestionMappingName?: {␊ - [k: string]: unknown␊ - }␊ - type: "AzureDataExplorerSink"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Salesforce sink.␊ - */␊ - export interface SalesforceSink {␊ - /**␊ - * The name of the external ID field for upsert operation. Default value is 'Id' column. Type: string (or Expression with resultType string).␊ - */␊ - externalIdFieldName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The flag indicating whether or not to ignore null values from input dataset (except key fields) during write operation. Default value is false. If set it to true, it means ADF will leave the data in the destination object unchanged when doing upsert/update operation and insert defined default value when doing insert operation, versus ADF will update the data in the destination object to NULL when doing upsert/update operation and insert NULL value when doing insert operation. Type: boolean (or Expression with resultType boolean).␊ - */␊ - ignoreNullValues?: {␊ - [k: string]: unknown␊ - }␊ - type: "SalesforceSink"␊ - /**␊ - * The write behavior for the operation. Default is Insert.␊ - */␊ - writeBehavior?: (("Insert" | "Upsert") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Salesforce Service Cloud sink.␊ - */␊ - export interface SalesforceServiceCloudSink {␊ - /**␊ - * The name of the external ID field for upsert operation. Default value is 'Id' column. Type: string (or Expression with resultType string).␊ - */␊ - externalIdFieldName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The flag indicating whether or not to ignore null values from input dataset (except key fields) during write operation. Default value is false. If set it to true, it means ADF will leave the data in the destination object unchanged when doing upsert/update operation and insert defined default value when doing insert operation, versus ADF will update the data in the destination object to NULL when doing upsert/update operation and insert NULL value when doing insert operation. Type: boolean (or Expression with resultType boolean).␊ - */␊ - ignoreNullValues?: {␊ - [k: string]: unknown␊ - }␊ - type: "SalesforceServiceCloudSink"␊ - /**␊ - * The write behavior for the operation. Default is Insert.␊ - */␊ - writeBehavior?: (("Insert" | "Upsert") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity MongoDB Atlas sink.␊ - */␊ - export interface MongoDbAtlasSink {␊ - type: "MongoDbAtlasSink"␊ - /**␊ - * Specifies whether the document with same key to be overwritten (upsert) rather than throw exception (insert). The default value is "insert". Type: string (or Expression with resultType string). Type: string (or Expression with resultType string).␊ - */␊ - writeBehavior?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity MongoDB sink.␊ - */␊ - export interface MongoDbV2Sink {␊ - type: "MongoDbV2Sink"␊ - /**␊ - * Specifies whether the document with same key to be overwritten (upsert) rather than throw exception (insert). The default value is "insert". Type: string (or Expression with resultType string). Type: string (or Expression with resultType string).␊ - */␊ - writeBehavior?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity sink for a CosmosDB (MongoDB API) database.␊ - */␊ - export interface CosmosDbMongoDbApiSink {␊ - type: "CosmosDbMongoDbApiSink"␊ - /**␊ - * Specifies whether the document with same key to be overwritten (upsert) rather than throw exception (insert). The default value is "insert". Type: string (or Expression with resultType string). Type: string (or Expression with resultType string).␊ - */␊ - writeBehavior?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Skip error file.␊ - */␊ - export interface SkipErrorFile {␊ - /**␊ - * Skip if source/sink file changed by other concurrent write. Default is false. Type: boolean (or Expression with resultType boolean).␊ - */␊ - dataInconsistency?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Skip if file is deleted by other client during copy. Default is true. Type: boolean (or Expression with resultType boolean).␊ - */␊ - fileMissing?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Avro source.␊ - */␊ - export interface AvroSource {␊ - /**␊ - * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).␊ - */␊ - additionalColumns?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Connector read setting.␊ - */␊ - storeSettings?: (StoreReadSettings | string)␊ - type: "AvroSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure blob read settings.␊ - */␊ - export interface AzureBlobStorageReadSettings {␊ - /**␊ - * Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).␊ - */␊ - deleteFilesAfterCompletion?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Indicates whether to enable partition discovery.␊ - */␊ - enablePartitionDiscovery?: (boolean | string)␊ - /**␊ - * Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).␊ - */␊ - fileListPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The end of file's modified datetime. Type: string (or Expression with resultType string).␊ - */␊ - modifiedDatetimeEnd?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The start of file's modified datetime. Type: string (or Expression with resultType string).␊ - */␊ - modifiedDatetimeStart?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).␊ - */␊ - partitionRootPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The prefix filter for the Azure Blob name. Type: string (or Expression with resultType string).␊ - */␊ - prefix?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).␊ - */␊ - recursive?: {␊ - [k: string]: unknown␊ - }␊ - type: "AzureBlobStorageReadSettings"␊ - /**␊ - * Azure blob wildcardFileName. Type: string (or Expression with resultType string).␊ - */␊ - wildcardFileName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure blob wildcardFolderPath. Type: string (or Expression with resultType string).␊ - */␊ - wildcardFolderPath?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure blobFS read settings.␊ - */␊ - export interface AzureBlobFSReadSettings {␊ - /**␊ - * Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).␊ - */␊ - deleteFilesAfterCompletion?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Indicates whether to enable partition discovery.␊ - */␊ - enablePartitionDiscovery?: (boolean | string)␊ - /**␊ - * Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).␊ - */␊ - fileListPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The end of file's modified datetime. Type: string (or Expression with resultType string).␊ - */␊ - modifiedDatetimeEnd?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The start of file's modified datetime. Type: string (or Expression with resultType string).␊ - */␊ - modifiedDatetimeStart?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).␊ - */␊ - partitionRootPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).␊ - */␊ - recursive?: {␊ - [k: string]: unknown␊ - }␊ - type: "AzureBlobFSReadSettings"␊ - /**␊ - * Azure blobFS wildcardFileName. Type: string (or Expression with resultType string).␊ - */␊ - wildcardFileName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure blobFS wildcardFolderPath. Type: string (or Expression with resultType string).␊ - */␊ - wildcardFolderPath?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure data lake store read settings.␊ - */␊ - export interface AzureDataLakeStoreReadSettings {␊ - /**␊ - * Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).␊ - */␊ - deleteFilesAfterCompletion?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Indicates whether to enable partition discovery.␊ - */␊ - enablePartitionDiscovery?: (boolean | string)␊ - /**␊ - * Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).␊ - */␊ - fileListPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Lists files after the value (exclusive) based on file/folder names’ lexicographical order. Applies under the folderPath in data set, and filter files/sub-folders under the folderPath. Type: string (or Expression with resultType string).␊ - */␊ - listAfter?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Lists files before the value (inclusive) based on file/folder names’ lexicographical order. Applies under the folderPath in data set, and filter files/sub-folders under the folderPath. Type: string (or Expression with resultType string).␊ - */␊ - listBefore?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The end of file's modified datetime. Type: string (or Expression with resultType string).␊ - */␊ - modifiedDatetimeEnd?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The start of file's modified datetime. Type: string (or Expression with resultType string).␊ - */␊ - modifiedDatetimeStart?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).␊ - */␊ - partitionRootPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).␊ - */␊ - recursive?: {␊ - [k: string]: unknown␊ - }␊ - type: "AzureDataLakeStoreReadSettings"␊ - /**␊ - * ADLS wildcardFileName. Type: string (or Expression with resultType string).␊ - */␊ - wildcardFileName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ADLS wildcardFolderPath. Type: string (or Expression with resultType string).␊ - */␊ - wildcardFolderPath?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Amazon S3 read settings.␊ - */␊ - export interface AmazonS3ReadSettings {␊ - /**␊ - * Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).␊ - */␊ - deleteFilesAfterCompletion?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Indicates whether to enable partition discovery.␊ - */␊ - enablePartitionDiscovery?: (boolean | string)␊ - /**␊ - * Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).␊ - */␊ - fileListPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The end of file's modified datetime. Type: string (or Expression with resultType string).␊ - */␊ - modifiedDatetimeEnd?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The start of file's modified datetime. Type: string (or Expression with resultType string).␊ - */␊ - modifiedDatetimeStart?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).␊ - */␊ - partitionRootPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The prefix filter for the S3 object name. Type: string (or Expression with resultType string).␊ - */␊ - prefix?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).␊ - */␊ - recursive?: {␊ - [k: string]: unknown␊ - }␊ - type: "AmazonS3ReadSettings"␊ - /**␊ - * AmazonS3 wildcardFileName. Type: string (or Expression with resultType string).␊ - */␊ - wildcardFileName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AmazonS3 wildcardFolderPath. Type: string (or Expression with resultType string).␊ - */␊ - wildcardFolderPath?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * File server read settings.␊ - */␊ - export interface FileServerReadSettings {␊ - /**␊ - * Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).␊ - */␊ - deleteFilesAfterCompletion?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Indicates whether to enable partition discovery.␊ - */␊ - enablePartitionDiscovery?: (boolean | string)␊ - /**␊ - * Specify a filter to be used to select a subset of files in the folderPath rather than all files. Type: string (or Expression with resultType string).␊ - */␊ - fileFilter?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).␊ - */␊ - fileListPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The end of file's modified datetime. Type: string (or Expression with resultType string).␊ - */␊ - modifiedDatetimeEnd?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The start of file's modified datetime. Type: string (or Expression with resultType string).␊ - */␊ - modifiedDatetimeStart?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).␊ - */␊ - partitionRootPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).␊ - */␊ - recursive?: {␊ - [k: string]: unknown␊ - }␊ - type: "FileServerReadSettings"␊ - /**␊ - * FileServer wildcardFileName. Type: string (or Expression with resultType string).␊ - */␊ - wildcardFileName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * FileServer wildcardFolderPath. Type: string (or Expression with resultType string).␊ - */␊ - wildcardFolderPath?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure File Storage read settings.␊ - */␊ - export interface AzureFileStorageReadSettings {␊ - /**␊ - * Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).␊ - */␊ - deleteFilesAfterCompletion?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Indicates whether to enable partition discovery.␊ - */␊ - enablePartitionDiscovery?: (boolean | string)␊ - /**␊ - * Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).␊ - */␊ - fileListPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The end of file's modified datetime. Type: string (or Expression with resultType string).␊ - */␊ - modifiedDatetimeEnd?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The start of file's modified datetime. Type: string (or Expression with resultType string).␊ - */␊ - modifiedDatetimeStart?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).␊ - */␊ - partitionRootPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The prefix filter for the Azure File name starting from root path. Type: string (or Expression with resultType string).␊ - */␊ - prefix?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).␊ - */␊ - recursive?: {␊ - [k: string]: unknown␊ - }␊ - type: "AzureFileStorageReadSettings"␊ - /**␊ - * Azure File Storage wildcardFileName. Type: string (or Expression with resultType string).␊ - */␊ - wildcardFileName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure File Storage wildcardFolderPath. Type: string (or Expression with resultType string).␊ - */␊ - wildcardFolderPath?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Amazon S3 Compatible read settings.␊ - */␊ - export interface AmazonS3CompatibleReadSettings {␊ - /**␊ - * Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).␊ - */␊ - deleteFilesAfterCompletion?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Indicates whether to enable partition discovery.␊ - */␊ - enablePartitionDiscovery?: (boolean | string)␊ - /**␊ - * Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).␊ - */␊ - fileListPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The end of file's modified datetime. Type: string (or Expression with resultType string).␊ - */␊ - modifiedDatetimeEnd?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The start of file's modified datetime. Type: string (or Expression with resultType string).␊ - */␊ - modifiedDatetimeStart?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).␊ - */␊ - partitionRootPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The prefix filter for the S3 Compatible object name. Type: string (or Expression with resultType string).␊ - */␊ - prefix?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).␊ - */␊ - recursive?: {␊ - [k: string]: unknown␊ - }␊ - type: "AmazonS3CompatibleReadSettings"␊ - /**␊ - * Amazon S3 Compatible wildcardFileName. Type: string (or Expression with resultType string).␊ - */␊ - wildcardFileName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Amazon S3 Compatible wildcardFolderPath. Type: string (or Expression with resultType string).␊ - */␊ - wildcardFolderPath?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Oracle Cloud Storage read settings.␊ - */␊ - export interface OracleCloudStorageReadSettings {␊ - /**␊ - * Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).␊ - */␊ - deleteFilesAfterCompletion?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Indicates whether to enable partition discovery.␊ - */␊ - enablePartitionDiscovery?: (boolean | string)␊ - /**␊ - * Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).␊ - */␊ - fileListPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The end of file's modified datetime. Type: string (or Expression with resultType string).␊ - */␊ - modifiedDatetimeEnd?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The start of file's modified datetime. Type: string (or Expression with resultType string).␊ - */␊ - modifiedDatetimeStart?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).␊ - */␊ - partitionRootPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The prefix filter for the Oracle Cloud Storage object name. Type: string (or Expression with resultType string).␊ - */␊ - prefix?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).␊ - */␊ - recursive?: {␊ - [k: string]: unknown␊ - }␊ - type: "OracleCloudStorageReadSettings"␊ - /**␊ - * Oracle Cloud Storage wildcardFileName. Type: string (or Expression with resultType string).␊ - */␊ - wildcardFileName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Oracle Cloud Storage wildcardFolderPath. Type: string (or Expression with resultType string).␊ - */␊ - wildcardFolderPath?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Google Cloud Storage read settings.␊ - */␊ - export interface GoogleCloudStorageReadSettings {␊ - /**␊ - * Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).␊ - */␊ - deleteFilesAfterCompletion?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Indicates whether to enable partition discovery.␊ - */␊ - enablePartitionDiscovery?: (boolean | string)␊ - /**␊ - * Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).␊ - */␊ - fileListPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The end of file's modified datetime. Type: string (or Expression with resultType string).␊ - */␊ - modifiedDatetimeEnd?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The start of file's modified datetime. Type: string (or Expression with resultType string).␊ - */␊ - modifiedDatetimeStart?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).␊ - */␊ - partitionRootPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The prefix filter for the Google Cloud Storage object name. Type: string (or Expression with resultType string).␊ - */␊ - prefix?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).␊ - */␊ - recursive?: {␊ - [k: string]: unknown␊ - }␊ - type: "GoogleCloudStorageReadSettings"␊ - /**␊ - * Google Cloud Storage wildcardFileName. Type: string (or Expression with resultType string).␊ - */␊ - wildcardFileName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Google Cloud Storage wildcardFolderPath. Type: string (or Expression with resultType string).␊ - */␊ - wildcardFolderPath?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Ftp read settings.␊ - */␊ - export interface FtpReadSettings {␊ - /**␊ - * Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).␊ - */␊ - deleteFilesAfterCompletion?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * If true, disable parallel reading within each file. Default is false. Type: boolean (or Expression with resultType boolean).␊ - */␊ - disableChunking?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Indicates whether to enable partition discovery.␊ - */␊ - enablePartitionDiscovery?: (boolean | string)␊ - /**␊ - * Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).␊ - */␊ - fileListPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).␊ - */␊ - partitionRootPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).␊ - */␊ - recursive?: {␊ - [k: string]: unknown␊ - }␊ - type: "FtpReadSettings"␊ - /**␊ - * Specify whether to use binary transfer mode for FTP stores.␊ - */␊ - useBinaryTransfer?: (boolean | string)␊ - /**␊ - * Ftp wildcardFileName. Type: string (or Expression with resultType string).␊ - */␊ - wildcardFileName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Ftp wildcardFolderPath. Type: string (or Expression with resultType string).␊ - */␊ - wildcardFolderPath?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Sftp read settings.␊ - */␊ - export interface SftpReadSettings {␊ - /**␊ - * Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).␊ - */␊ - deleteFilesAfterCompletion?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * If true, disable parallel reading within each file. Default is false. Type: boolean (or Expression with resultType boolean).␊ - */␊ - disableChunking?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Indicates whether to enable partition discovery.␊ - */␊ - enablePartitionDiscovery?: (boolean | string)␊ - /**␊ - * Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).␊ - */␊ - fileListPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The end of file's modified datetime. Type: string (or Expression with resultType string).␊ - */␊ - modifiedDatetimeEnd?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The start of file's modified datetime. Type: string (or Expression with resultType string).␊ - */␊ - modifiedDatetimeStart?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).␊ - */␊ - partitionRootPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).␊ - */␊ - recursive?: {␊ - [k: string]: unknown␊ - }␊ - type: "SftpReadSettings"␊ - /**␊ - * Sftp wildcardFileName. Type: string (or Expression with resultType string).␊ - */␊ - wildcardFileName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Sftp wildcardFolderPath. Type: string (or Expression with resultType string).␊ - */␊ - wildcardFolderPath?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Sftp read settings.␊ - */␊ - export interface HttpReadSettings {␊ - /**␊ - * The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string).␊ - */␊ - additionalHeaders?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Indicates whether to enable partition discovery.␊ - */␊ - enablePartitionDiscovery?: (boolean | string)␊ - /**␊ - * Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).␊ - */␊ - partitionRootPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string).␊ - */␊ - requestBody?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string).␊ - */␊ - requestMethod?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the timeout for a HTTP client to get HTTP response from HTTP server.␊ - */␊ - requestTimeout?: {␊ - [k: string]: unknown␊ - }␊ - type: "HttpReadSettings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HDFS read settings.␊ - */␊ - export interface HdfsReadSettings {␊ - /**␊ - * Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).␊ - */␊ - deleteFilesAfterCompletion?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Distcp settings.␊ - */␊ - distcpSettings?: (DistcpSettings | string)␊ - /**␊ - * Indicates whether to enable partition discovery.␊ - */␊ - enablePartitionDiscovery?: (boolean | string)␊ - /**␊ - * Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).␊ - */␊ - fileListPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The end of file's modified datetime. Type: string (or Expression with resultType string).␊ - */␊ - modifiedDatetimeEnd?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The start of file's modified datetime. Type: string (or Expression with resultType string).␊ - */␊ - modifiedDatetimeStart?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).␊ - */␊ - partitionRootPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).␊ - */␊ - recursive?: {␊ - [k: string]: unknown␊ - }␊ - type: "HdfsReadSettings"␊ - /**␊ - * HDFS wildcardFileName. Type: string (or Expression with resultType string).␊ - */␊ - wildcardFileName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HDFS wildcardFolderPath. Type: string (or Expression with resultType string).␊ - */␊ - wildcardFolderPath?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Distcp settings.␊ - */␊ - export interface DistcpSettings {␊ - /**␊ - * Specifies the Distcp options. Type: string (or Expression with resultType string).␊ - */␊ - distcpOptions?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the Yarn ResourceManager endpoint. Type: string (or Expression with resultType string).␊ - */␊ - resourceManagerEndpoint: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies an existing folder path which will be used to store temp Distcp command script. The script file is generated by ADF and will be removed after Copy job finished. Type: string (or Expression with resultType string).␊ - */␊ - tempScriptPath: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity excel source.␊ - */␊ - export interface ExcelSource {␊ - /**␊ - * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).␊ - */␊ - additionalColumns?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Connector read setting.␊ - */␊ - storeSettings?: ((AzureBlobStorageReadSettings | AzureBlobFSReadSettings | AzureDataLakeStoreReadSettings | AmazonS3ReadSettings | FileServerReadSettings | AzureFileStorageReadSettings | AmazonS3CompatibleReadSettings | OracleCloudStorageReadSettings | GoogleCloudStorageReadSettings | FtpReadSettings | SftpReadSettings | HttpReadSettings | HdfsReadSettings) | string)␊ - type: "ExcelSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Parquet source.␊ - */␊ - export interface ParquetSource {␊ - /**␊ - * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).␊ - */␊ - additionalColumns?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Connector read setting.␊ - */␊ - storeSettings?: ((AzureBlobStorageReadSettings | AzureBlobFSReadSettings | AzureDataLakeStoreReadSettings | AmazonS3ReadSettings | FileServerReadSettings | AzureFileStorageReadSettings | AmazonS3CompatibleReadSettings | OracleCloudStorageReadSettings | GoogleCloudStorageReadSettings | FtpReadSettings | SftpReadSettings | HttpReadSettings | HdfsReadSettings) | string)␊ - type: "ParquetSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity DelimitedText source.␊ - */␊ - export interface DelimitedTextSource {␊ - /**␊ - * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).␊ - */␊ - additionalColumns?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Delimited text read settings.␊ - */␊ - formatSettings?: (DelimitedTextReadSettings | string)␊ - /**␊ - * Connector read setting.␊ - */␊ - storeSettings?: ((AzureBlobStorageReadSettings | AzureBlobFSReadSettings | AzureDataLakeStoreReadSettings | AmazonS3ReadSettings | FileServerReadSettings | AzureFileStorageReadSettings | AmazonS3CompatibleReadSettings | OracleCloudStorageReadSettings | GoogleCloudStorageReadSettings | FtpReadSettings | SftpReadSettings | HttpReadSettings | HdfsReadSettings) | string)␊ - type: "DelimitedTextSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Delimited text read settings.␊ - */␊ - export interface DelimitedTextReadSettings {␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Compression read settings.␊ - */␊ - compressionProperties?: (CompressionReadSettings | string)␊ - /**␊ - * Indicates the number of non-empty rows to skip when reading data from input files. Type: integer (or Expression with resultType integer).␊ - */␊ - skipLineCount?: {␊ - [k: string]: unknown␊ - }␊ - type: "DelimitedTextReadSettings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The ZipDeflate compression read settings.␊ - */␊ - export interface ZipDeflateReadSettings {␊ - /**␊ - * Preserve the zip file name as folder path. Type: boolean (or Expression with resultType boolean).␊ - */␊ - preserveZipFileNameAsFolder?: {␊ - [k: string]: unknown␊ - }␊ - type: "ZipDeflateReadSettings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Tar compression read settings.␊ - */␊ - export interface TarReadSettings {␊ - /**␊ - * Preserve the compression file name as folder path. Type: boolean (or Expression with resultType boolean).␊ - */␊ - preserveCompressionFileNameAsFolder?: {␊ - [k: string]: unknown␊ - }␊ - type: "TarReadSettings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The TarGZip compression read settings.␊ - */␊ - export interface TarGZipReadSettings {␊ - /**␊ - * Preserve the compression file name as folder path. Type: boolean (or Expression with resultType boolean).␊ - */␊ - preserveCompressionFileNameAsFolder?: {␊ - [k: string]: unknown␊ - }␊ - type: "TarGZipReadSettings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Json source.␊ - */␊ - export interface JsonSource {␊ - /**␊ - * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).␊ - */␊ - additionalColumns?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Json read settings.␊ - */␊ - formatSettings?: (JsonReadSettings | string)␊ - /**␊ - * Connector read setting.␊ - */␊ - storeSettings?: ((AzureBlobStorageReadSettings | AzureBlobFSReadSettings | AzureDataLakeStoreReadSettings | AmazonS3ReadSettings | FileServerReadSettings | AzureFileStorageReadSettings | AmazonS3CompatibleReadSettings | OracleCloudStorageReadSettings | GoogleCloudStorageReadSettings | FtpReadSettings | SftpReadSettings | HttpReadSettings | HdfsReadSettings) | string)␊ - type: "JsonSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Json read settings.␊ - */␊ - export interface JsonReadSettings {␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Compression read settings.␊ - */␊ - compressionProperties?: ((ZipDeflateReadSettings | TarReadSettings | TarGZipReadSettings) | string)␊ - type: "JsonReadSettings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Xml source.␊ - */␊ - export interface XmlSource {␊ - /**␊ - * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).␊ - */␊ - additionalColumns?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Xml read settings.␊ - */␊ - formatSettings?: (XmlReadSettings | string)␊ - /**␊ - * Connector read setting.␊ - */␊ - storeSettings?: ((AzureBlobStorageReadSettings | AzureBlobFSReadSettings | AzureDataLakeStoreReadSettings | AmazonS3ReadSettings | FileServerReadSettings | AzureFileStorageReadSettings | AmazonS3CompatibleReadSettings | OracleCloudStorageReadSettings | GoogleCloudStorageReadSettings | FtpReadSettings | SftpReadSettings | HttpReadSettings | HdfsReadSettings) | string)␊ - type: "XmlSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Xml read settings.␊ - */␊ - export interface XmlReadSettings {␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Compression read settings.␊ - */␊ - compressionProperties?: ((ZipDeflateReadSettings | TarReadSettings | TarGZipReadSettings) | string)␊ - /**␊ - * Indicates whether type detection is enabled when reading the xml files. Type: boolean (or Expression with resultType boolean).␊ - */␊ - detectDataType?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Namespace uri to prefix mappings to override the prefixes in column names when namespace is enabled, if no prefix is defined for a namespace uri, the prefix of xml element/attribute name in the xml data file will be used. Example: "{"http://www.example.com/xml":"prefix"}" Type: object (or Expression with resultType object).␊ - */␊ - namespacePrefixes?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Indicates whether namespace is enabled when reading the xml files. Type: boolean (or Expression with resultType boolean).␊ - */␊ - namespaces?: {␊ - [k: string]: unknown␊ - }␊ - type: "XmlReadSettings"␊ - /**␊ - * Indicates what validation method is used when reading the xml files. Allowed values: 'none', 'xsd', or 'dtd'. Type: string (or Expression with resultType string).␊ - */␊ - validationMode?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity ORC source.␊ - */␊ - export interface OrcSource {␊ - /**␊ - * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).␊ - */␊ - additionalColumns?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Connector read setting.␊ - */␊ - storeSettings?: ((AzureBlobStorageReadSettings | AzureBlobFSReadSettings | AzureDataLakeStoreReadSettings | AmazonS3ReadSettings | FileServerReadSettings | AzureFileStorageReadSettings | AmazonS3CompatibleReadSettings | OracleCloudStorageReadSettings | GoogleCloudStorageReadSettings | FtpReadSettings | SftpReadSettings | HttpReadSettings | HdfsReadSettings) | string)␊ - type: "OrcSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Binary source.␊ - */␊ - export interface BinarySource {␊ - /**␊ - * Binary read settings.␊ - */␊ - formatSettings?: (BinaryReadSettings | string)␊ - /**␊ - * Connector read setting.␊ - */␊ - storeSettings?: ((AzureBlobStorageReadSettings | AzureBlobFSReadSettings | AzureDataLakeStoreReadSettings | AmazonS3ReadSettings | FileServerReadSettings | AzureFileStorageReadSettings | AmazonS3CompatibleReadSettings | OracleCloudStorageReadSettings | GoogleCloudStorageReadSettings | FtpReadSettings | SftpReadSettings | HttpReadSettings | HdfsReadSettings) | string)␊ - type: "BinarySource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Binary read settings.␊ - */␊ - export interface BinaryReadSettings {␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Compression read settings.␊ - */␊ - compressionProperties?: ((ZipDeflateReadSettings | TarReadSettings | TarGZipReadSettings) | string)␊ - type: "BinaryReadSettings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Azure Table source.␊ - */␊ - export interface AzureTableSource {␊ - /**␊ - * Azure Table source ignore table not found. Type: boolean (or Expression with resultType boolean).␊ - */␊ - azureTableSourceIgnoreTableNotFound?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Table source query. Type: string (or Expression with resultType string).␊ - */␊ - azureTableSourceQuery?: {␊ - [k: string]: unknown␊ - }␊ - type: "AzureTableSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity source for Informix.␊ - */␊ - export interface InformixSource {␊ - /**␊ - * Database query. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "InformixSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity source for Db2 databases.␊ - */␊ - export interface Db2Source {␊ - /**␊ - * Database query. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "Db2Source"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity source for ODBC databases.␊ - */␊ - export interface OdbcSource {␊ - /**␊ - * Database query. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "OdbcSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity source for MySQL databases.␊ - */␊ - export interface MySqlSource {␊ - /**␊ - * Database query. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "MySqlSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity source for PostgreSQL databases.␊ - */␊ - export interface PostgreSqlSource {␊ - /**␊ - * Database query. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "PostgreSqlSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity source for Sybase databases.␊ - */␊ - export interface SybaseSource {␊ - /**␊ - * Database query. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "SybaseSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity source for SapBW server via MDX.␊ - */␊ - export interface SapBwSource {␊ - /**␊ - * MDX query. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "SapBwSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Salesforce source.␊ - */␊ - export interface SalesforceSource {␊ - /**␊ - * Database query. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The read behavior for the operation. Default is Query.␊ - */␊ - readBehavior?: (("Query" | "QueryAll") | string)␊ - type: "SalesforceSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity source for SAP Cloud for Customer source.␊ - */␊ - export interface SapCloudForCustomerSource {␊ - /**␊ - * The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9])).␊ - */␊ - httpRequestTimeout?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SAP Cloud for Customer OData query. For example, "$top=1". Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "SapCloudForCustomerSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity source for SAP ECC source.␊ - */␊ - export interface SapEccSource {␊ - /**␊ - * The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9])).␊ - */␊ - httpRequestTimeout?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SAP ECC OData query. For example, "$top=1". Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "SapEccSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity source for SAP HANA source.␊ - */␊ - export interface SapHanaSource {␊ - /**␊ - * The packet size of data read from SAP HANA. Type: integer(or Expression with resultType integer).␊ - */␊ - packetSize?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The partition mechanism that will be used for SAP HANA read in parallel. Possible values include: "None", "PhysicalPartitionsOfTable", "SapHanaDynamicRange". ␊ - */␊ - partitionOption?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The settings that will be leveraged for SAP HANA source partitioning.␊ - */␊ - partitionSettings?: (SapHanaPartitionSettings | string)␊ - /**␊ - * SAP HANA Sql query. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "SapHanaSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The settings that will be leveraged for SAP HANA source partitioning.␊ - */␊ - export interface SapHanaPartitionSettings {␊ - /**␊ - * The name of the column that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).␊ - */␊ - partitionColumnName?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity source for SAP Business Warehouse Open Hub Destination source.␊ - */␊ - export interface SapOpenHubSource {␊ - /**␊ - * The ID of request for delta loading. Once it is set, only data with requestId larger than the value of this property will be retrieved. The default value is 0. Type: integer (or Expression with resultType integer ).␊ - */␊ - baseRequestId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the custom RFC function module that will be used to read data from SAP Table. Type: string (or Expression with resultType string).␊ - */␊ - customRfcReadTableFunctionModule?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Whether to exclude the records of the last request. The default value is true. Type: boolean (or Expression with resultType boolean).␊ - */␊ - excludeLastRequest?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The single character that will be used as delimiter passed to SAP RFC as well as splitting the output data retrieved. Type: string (or Expression with resultType string).␊ - */␊ - sapDataColumnDelimiter?: {␊ - [k: string]: unknown␊ - }␊ - type: "SapOpenHubSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity source for SAP ODP source.␊ - */␊ - export interface SapOdpSource {␊ - /**␊ - * The extraction mode. Allowed value include: Full, Delta and Recovery. The default value is Full. Type: string (or Expression with resultType string).␊ - */␊ - extractionMode?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the columns to be selected from source data. Type: array of objects(projection) (or Expression with resultType array of objects).␊ - */␊ - projection?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the selection conditions from source data. Type: array of objects(selection) (or Expression with resultType array of objects).␊ - */␊ - selection?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The subscriber process to manage the delta process. Type: string (or Expression with resultType string).␊ - */␊ - subscriberProcess?: {␊ - [k: string]: unknown␊ - }␊ - type: "SapOdpSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity source for SAP Table source.␊ - */␊ - export interface SapTableSource {␊ - /**␊ - * Specifies the maximum number of rows that will be retrieved at a time when retrieving data from SAP Table. Type: integer (or Expression with resultType integer).␊ - */␊ - batchSize?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the custom RFC function module that will be used to read data from SAP Table. Type: string (or Expression with resultType string).␊ - */␊ - customRfcReadTableFunctionModule?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The partition mechanism that will be used for SAP table read in parallel. Possible values include: "None", "PartitionOnInt", "PartitionOnCalendarYear", "PartitionOnCalendarMonth", "PartitionOnCalendarDate", "PartitionOnTime".␊ - */␊ - partitionOption?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The settings that will be leveraged for SAP table source partitioning.␊ - */␊ - partitionSettings?: (SapTablePartitionSettings | string)␊ - /**␊ - * The fields of the SAP table that will be retrieved. For example, column0, column1. Type: string (or Expression with resultType string).␊ - */␊ - rfcTableFields?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The options for the filtering of the SAP Table. For example, COLUMN0 EQ SOME VALUE. Type: string (or Expression with resultType string).␊ - */␊ - rfcTableOptions?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The number of rows to be retrieved. Type: integer(or Expression with resultType integer).␊ - */␊ - rowCount?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The number of rows that will be skipped. Type: integer (or Expression with resultType integer).␊ - */␊ - rowSkips?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The single character that will be used as delimiter passed to SAP RFC as well as splitting the output data retrieved. Type: string (or Expression with resultType string).␊ - */␊ - sapDataColumnDelimiter?: {␊ - [k: string]: unknown␊ - }␊ - type: "SapTableSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The settings that will be leveraged for SAP table source partitioning.␊ - */␊ - export interface SapTablePartitionSettings {␊ - /**␊ - * The maximum value of partitions the table will be split into. Type: integer (or Expression with resultType string).␊ - */␊ - maxPartitionsNumber?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The name of the column that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).␊ - */␊ - partitionColumnName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).␊ - */␊ - partitionLowerBound?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).␊ - */␊ - partitionUpperBound?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity SQL source.␊ - */␊ - export interface SqlSource {␊ - /**␊ - * Specifies the transaction locking behavior for the SQL source. Allowed values: ReadCommitted/ReadUncommitted/RepeatableRead/Serializable/Snapshot. The default value is ReadCommitted. Type: string (or Expression with resultType string).␊ - */␊ - isolationLevel?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The partition mechanism that will be used for Sql read in parallel. Possible values include: "None", "PhysicalPartitionsOfTable", "DynamicRange".␊ - */␊ - partitionOption?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The settings that will be leveraged for Sql source partitioning.␊ - */␊ - partitionSettings?: (SqlPartitionSettings | string)␊ - /**␊ - * SQL reader query. Type: string (or Expression with resultType string).␊ - */␊ - sqlReaderQuery?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Name of the stored procedure for a SQL Database source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string).␊ - */␊ - sqlReaderStoredProcedureName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}".␊ - */␊ - storedProcedureParameters?: ({␊ - [k: string]: StoredProcedureParameter1␊ - } | string)␊ - type: "SqlSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The settings that will be leveraged for Sql source partitioning.␊ - */␊ - export interface SqlPartitionSettings {␊ - /**␊ - * The name of the column in integer or datetime type that will be used for proceeding partitioning. If not specified, the primary key of the table is auto-detected and used as the partition column. Type: string (or Expression with resultType string).␊ - */␊ - partitionColumnName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The minimum value of the partition column for partition range splitting. This value is used to decide the partition stride, not for filtering the rows in table. All rows in the table or query result will be partitioned and copied. Type: string (or Expression with resultType string).␊ - */␊ - partitionLowerBound?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The maximum value of the partition column for partition range splitting. This value is used to decide the partition stride, not for filtering the rows in table. All rows in the table or query result will be partitioned and copied. Type: string (or Expression with resultType string).␊ - */␊ - partitionUpperBound?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity SQL server source.␊ - */␊ - export interface SqlServerSource {␊ - /**␊ - * The partition mechanism that will be used for Sql read in parallel. Possible values include: "None", "PhysicalPartitionsOfTable", "DynamicRange".␊ - */␊ - partitionOption?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The settings that will be leveraged for Sql source partitioning.␊ - */␊ - partitionSettings?: (SqlPartitionSettings | string)␊ - /**␊ - * Which additional types to produce.␊ - */␊ - produceAdditionalTypes?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SQL reader query. Type: string (or Expression with resultType string).␊ - */␊ - sqlReaderQuery?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Name of the stored procedure for a SQL Database source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string).␊ - */␊ - sqlReaderStoredProcedureName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}".␊ - */␊ - storedProcedureParameters?: ({␊ - [k: string]: StoredProcedureParameter1␊ - } | string)␊ - type: "SqlServerSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Amazon RDS for SQL Server source.␊ - */␊ - export interface AmazonRdsForSqlServerSource {␊ - /**␊ - * The partition mechanism that will be used for Sql read in parallel. Possible values include: "None", "PhysicalPartitionsOfTable", "DynamicRange".␊ - */␊ - partitionOption?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The settings that will be leveraged for Sql source partitioning.␊ - */␊ - partitionSettings?: (SqlPartitionSettings | string)␊ - /**␊ - * Which additional types to produce.␊ - */␊ - produceAdditionalTypes?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SQL reader query. Type: string (or Expression with resultType string).␊ - */␊ - sqlReaderQuery?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Name of the stored procedure for a SQL Database source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string).␊ - */␊ - sqlReaderStoredProcedureName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}".␊ - */␊ - storedProcedureParameters?: ({␊ - [k: string]: StoredProcedureParameter1␊ - } | string)␊ - type: "AmazonRdsForSqlServerSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Azure SQL source.␊ - */␊ - export interface AzureSqlSource {␊ - /**␊ - * The partition mechanism that will be used for Sql read in parallel. Possible values include: "None", "PhysicalPartitionsOfTable", "DynamicRange".␊ - */␊ - partitionOption?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The settings that will be leveraged for Sql source partitioning.␊ - */␊ - partitionSettings?: (SqlPartitionSettings | string)␊ - /**␊ - * Which additional types to produce.␊ - */␊ - produceAdditionalTypes?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SQL reader query. Type: string (or Expression with resultType string).␊ - */␊ - sqlReaderQuery?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Name of the stored procedure for a SQL Database source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string).␊ - */␊ - sqlReaderStoredProcedureName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}".␊ - */␊ - storedProcedureParameters?: ({␊ - [k: string]: StoredProcedureParameter1␊ - } | string)␊ - type: "AzureSqlSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Azure SQL Managed Instance source.␊ - */␊ - export interface SqlMISource {␊ - /**␊ - * The partition mechanism that will be used for Sql read in parallel. Possible values include: "None", "PhysicalPartitionsOfTable", "DynamicRange".␊ - */␊ - partitionOption?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The settings that will be leveraged for Sql source partitioning.␊ - */␊ - partitionSettings?: (SqlPartitionSettings | string)␊ - /**␊ - * Which additional types to produce.␊ - */␊ - produceAdditionalTypes?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SQL reader query. Type: string (or Expression with resultType string).␊ - */␊ - sqlReaderQuery?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Name of the stored procedure for a Azure SQL Managed Instance source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string).␊ - */␊ - sqlReaderStoredProcedureName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}".␊ - */␊ - storedProcedureParameters?: ({␊ - [k: string]: StoredProcedureParameter1␊ - } | string)␊ - type: "SqlMISource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity SQL Data Warehouse source.␊ - */␊ - export interface SqlDWSource {␊ - /**␊ - * The partition mechanism that will be used for Sql read in parallel. Possible values include: "None", "PhysicalPartitionsOfTable", "DynamicRange".␊ - */␊ - partitionOption?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The settings that will be leveraged for Sql source partitioning.␊ - */␊ - partitionSettings?: (SqlPartitionSettings | string)␊ - /**␊ - * SQL Data Warehouse reader query. Type: string (or Expression with resultType string).␊ - */␊ - sqlReaderQuery?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Name of the stored procedure for a SQL Data Warehouse source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string).␊ - */␊ - sqlReaderStoredProcedureName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}". Type: object (or Expression with resultType object), itemType: StoredProcedureParameter.␊ - */␊ - storedProcedureParameters?: {␊ - [k: string]: unknown␊ - }␊ - type: "SqlDWSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Azure MySQL source.␊ - */␊ - export interface AzureMySqlSource {␊ - /**␊ - * Database query. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "AzureMySqlSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Teradata source.␊ - */␊ - export interface TeradataSource {␊ - /**␊ - * The partition mechanism that will be used for teradata read in parallel. Possible values include: "None", "Hash", "DynamicRange".␊ - */␊ - partitionOption?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The settings that will be leveraged for teradata source partitioning.␊ - */␊ - partitionSettings?: (TeradataPartitionSettings | string)␊ - /**␊ - * Teradata query. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "TeradataSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The settings that will be leveraged for teradata source partitioning.␊ - */␊ - export interface TeradataPartitionSettings {␊ - /**␊ - * The name of the column that will be used for proceeding range or hash partitioning. Type: string (or Expression with resultType string).␊ - */␊ - partitionColumnName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).␊ - */␊ - partitionLowerBound?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).␊ - */␊ - partitionUpperBound?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity source for a Cassandra database.␊ - */␊ - export interface CassandraSource {␊ - /**␊ - * The consistency level specifies how many Cassandra servers must respond to a read request before returning data to the client application. Cassandra checks the specified number of Cassandra servers for data to satisfy the read request. Must be one of cassandraSourceReadConsistencyLevels. The default value is 'ONE'. It is case-insensitive.␊ - */␊ - consistencyLevel?: (("ALL" | "EACH_QUORUM" | "QUORUM" | "LOCAL_QUORUM" | "ONE" | "TWO" | "THREE" | "LOCAL_ONE" | "SERIAL" | "LOCAL_SERIAL") | string)␊ - /**␊ - * Database query. Should be a SQL-92 query expression or Cassandra Query Language (CQL) command. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "CassandraSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Amazon Marketplace Web Service source.␊ - */␊ - export interface AmazonMWSSource {␊ - /**␊ - * A query to retrieve data from source. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "AmazonMWSSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Azure PostgreSQL source.␊ - */␊ - export interface AzurePostgreSqlSource {␊ - /**␊ - * A query to retrieve data from source. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "AzurePostgreSqlSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Concur Service source.␊ - */␊ - export interface ConcurSource {␊ - /**␊ - * A query to retrieve data from source. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "ConcurSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Couchbase server source.␊ - */␊ - export interface CouchbaseSource {␊ - /**␊ - * A query to retrieve data from source. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "CouchbaseSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Drill server source.␊ - */␊ - export interface DrillSource {␊ - /**␊ - * A query to retrieve data from source. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "DrillSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Eloqua server source.␊ - */␊ - export interface EloquaSource {␊ - /**␊ - * A query to retrieve data from source. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "EloquaSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Google BigQuery service source.␊ - */␊ - export interface GoogleBigQuerySource {␊ - /**␊ - * A query to retrieve data from source. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "GoogleBigQuerySource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Greenplum Database source.␊ - */␊ - export interface GreenplumSource {␊ - /**␊ - * A query to retrieve data from source. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "GreenplumSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity HBase server source.␊ - */␊ - export interface HBaseSource {␊ - /**␊ - * A query to retrieve data from source. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "HBaseSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Hive Server source.␊ - */␊ - export interface HiveSource {␊ - /**␊ - * A query to retrieve data from source. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "HiveSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Hubspot Service source.␊ - */␊ - export interface HubspotSource {␊ - /**␊ - * A query to retrieve data from source. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "HubspotSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Impala server source.␊ - */␊ - export interface ImpalaSource {␊ - /**␊ - * A query to retrieve data from source. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "ImpalaSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Jira Service source.␊ - */␊ - export interface JiraSource {␊ - /**␊ - * A query to retrieve data from source. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "JiraSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Magento server source.␊ - */␊ - export interface MagentoSource {␊ - /**␊ - * A query to retrieve data from source. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "MagentoSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity MariaDB server source.␊ - */␊ - export interface MariaDBSource {␊ - /**␊ - * A query to retrieve data from source. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "MariaDBSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Azure MariaDB source.␊ - */␊ - export interface AzureMariaDBSource {␊ - /**␊ - * A query to retrieve data from source. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "AzureMariaDBSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Marketo server source.␊ - */␊ - export interface MarketoSource {␊ - /**␊ - * A query to retrieve data from source. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "MarketoSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Paypal Service source.␊ - */␊ - export interface PaypalSource {␊ - /**␊ - * A query to retrieve data from source. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "PaypalSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Phoenix server source.␊ - */␊ - export interface PhoenixSource {␊ - /**␊ - * A query to retrieve data from source. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "PhoenixSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Presto server source.␊ - */␊ - export interface PrestoSource {␊ - /**␊ - * A query to retrieve data from source. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "PrestoSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity QuickBooks server source.␊ - */␊ - export interface QuickBooksSource {␊ - /**␊ - * A query to retrieve data from source. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "QuickBooksSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity ServiceNow server source.␊ - */␊ - export interface ServiceNowSource {␊ - /**␊ - * A query to retrieve data from source. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "ServiceNowSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Shopify Service source.␊ - */␊ - export interface ShopifySource {␊ - /**␊ - * A query to retrieve data from source. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "ShopifySource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Spark Server source.␊ - */␊ - export interface SparkSource {␊ - /**␊ - * A query to retrieve data from source. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "SparkSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Square Service source.␊ - */␊ - export interface SquareSource {␊ - /**␊ - * A query to retrieve data from source. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "SquareSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Xero Service source.␊ - */␊ - export interface XeroSource {␊ - /**␊ - * A query to retrieve data from source. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "XeroSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Zoho server source.␊ - */␊ - export interface ZohoSource {␊ - /**␊ - * A query to retrieve data from source. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "ZohoSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Netezza source.␊ - */␊ - export interface NetezzaSource {␊ - /**␊ - * The partition mechanism that will be used for Netezza read in parallel. Possible values include: "None", "DataSlice", "DynamicRange".␊ - */␊ - partitionOption?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The settings that will be leveraged for Netezza source partitioning.␊ - */␊ - partitionSettings?: (NetezzaPartitionSettings | string)␊ - /**␊ - * A query to retrieve data from source. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "NetezzaSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The settings that will be leveraged for Netezza source partitioning.␊ - */␊ - export interface NetezzaPartitionSettings {␊ - /**␊ - * The name of the column in integer type that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).␊ - */␊ - partitionColumnName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).␊ - */␊ - partitionLowerBound?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).␊ - */␊ - partitionUpperBound?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Vertica source.␊ - */␊ - export interface VerticaSource {␊ - /**␊ - * A query to retrieve data from source. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "VerticaSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Salesforce Marketing Cloud source.␊ - */␊ - export interface SalesforceMarketingCloudSource {␊ - /**␊ - * A query to retrieve data from source. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "SalesforceMarketingCloudSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Responsys source.␊ - */␊ - export interface ResponsysSource {␊ - /**␊ - * A query to retrieve data from source. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "ResponsysSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Dynamics AX source.␊ - */␊ - export interface DynamicsAXSource {␊ - /**␊ - * The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9])).␊ - */␊ - httpRequestTimeout?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A query to retrieve data from source. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "DynamicsAXSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Oracle Service Cloud source.␊ - */␊ - export interface OracleServiceCloudSource {␊ - /**␊ - * A query to retrieve data from source. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "OracleServiceCloudSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Google AdWords service source.␊ - */␊ - export interface GoogleAdWordsSource {␊ - /**␊ - * A query to retrieve data from source. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "GoogleAdWordsSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity source for Amazon Redshift Source.␊ - */␊ - export interface AmazonRedshiftSource {␊ - /**␊ - * Database query. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Amazon S3 settings needed for the interim Amazon S3 when copying from Amazon Redshift with unload. With this, data from Amazon Redshift source will be unloaded into S3 first and then copied into the targeted sink from the interim S3.␊ - */␊ - redshiftUnloadSettings?: (RedshiftUnloadSettings | string)␊ - type: "AmazonRedshiftSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Amazon S3 settings needed for the interim Amazon S3 when copying from Amazon Redshift with unload. With this, data from Amazon Redshift source will be unloaded into S3 first and then copied into the targeted sink from the interim S3.␊ - */␊ - export interface RedshiftUnloadSettings {␊ - /**␊ - * The bucket of the interim Amazon S3 which will be used to store the unloaded data from Amazon Redshift source. The bucket must be in the same region as the Amazon Redshift source. Type: string (or Expression with resultType string).␊ - */␊ - bucketName: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service reference type.␊ - */␊ - s3LinkedServiceName: (LinkedServiceReference1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Azure Blob source.␊ - */␊ - export interface BlobSource {␊ - /**␊ - * If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).␊ - */␊ - recursive?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Number of header lines to skip from each blob. Type: integer (or Expression with resultType integer).␊ - */␊ - skipHeaderLineCount?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Treat empty as null. Type: boolean (or Expression with resultType boolean).␊ - */␊ - treatEmptyAsNull?: {␊ - [k: string]: unknown␊ - }␊ - type: "BlobSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Document Database Collection source.␊ - */␊ - export interface DocumentDbCollectionSource {␊ - /**␊ - * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).␊ - */␊ - additionalColumns?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Nested properties separator. Type: string (or Expression with resultType string).␊ - */␊ - nestingSeparator?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Documents query. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9])).␊ - */␊ - queryTimeout?: {␊ - [k: string]: unknown␊ - }␊ - type: "DocumentDbCollectionSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Azure CosmosDB (SQL API) Collection source.␊ - */␊ - export interface CosmosDbSqlApiSource {␊ - /**␊ - * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).␊ - */␊ - additionalColumns?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Whether detect primitive values as datetime values. Type: boolean (or Expression with resultType boolean).␊ - */␊ - detectDatetime?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Page size of the result. Type: integer (or Expression with resultType integer).␊ - */␊ - pageSize?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Preferred regions. Type: array of strings (or Expression with resultType array of strings).␊ - */␊ - preferredRegions?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SQL API query. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "CosmosDbSqlApiSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Dynamics source.␊ - */␊ - export interface DynamicsSource {␊ - /**␊ - * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).␊ - */␊ - additionalColumns?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * FetchXML is a proprietary query language that is used in Microsoft Dynamics (online & on-premises). Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "DynamicsSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Dynamics CRM source.␊ - */␊ - export interface DynamicsCrmSource {␊ - /**␊ - * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).␊ - */␊ - additionalColumns?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * FetchXML is a proprietary query language that is used in Microsoft Dynamics CRM (online & on-premises). Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "DynamicsCrmSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Common Data Service for Apps source.␊ - */␊ - export interface CommonDataServiceForAppsSource {␊ - /**␊ - * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).␊ - */␊ - additionalColumns?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * FetchXML is a proprietary query language that is used in Microsoft Common Data Service for Apps (online & on-premises). Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "CommonDataServiceForAppsSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity source for various relational databases.␊ - */␊ - export interface RelationalSource {␊ - /**␊ - * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).␊ - */␊ - additionalColumns?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Database query. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "RelationalSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity source for Microsoft Access.␊ - */␊ - export interface MicrosoftAccessSource {␊ - /**␊ - * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).␊ - */␊ - additionalColumns?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Database query. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "MicrosoftAccessSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity source for OData source.␊ - */␊ - export interface ODataSource {␊ - /**␊ - * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).␊ - */␊ - additionalColumns?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9])).␊ - */␊ - httpRequestTimeout?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * OData query. For example, "$top=1". Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "ODataSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Salesforce Service Cloud source.␊ - */␊ - export interface SalesforceServiceCloudSource {␊ - /**␊ - * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).␊ - */␊ - additionalColumns?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Database query. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The read behavior for the operation. Default is Query.␊ - */␊ - readBehavior?: (("Query" | "QueryAll") | string)␊ - type: "SalesforceServiceCloudSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Rest service source.␊ - */␊ - export interface RestSource {␊ - /**␊ - * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).␊ - */␊ - additionalColumns?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string).␊ - */␊ - additionalHeaders?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:01:40. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9])).␊ - */␊ - httpRequestTimeout?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The pagination rules to compose next page requests. Type: string (or Expression with resultType string).␊ - */␊ - paginationRules?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string).␊ - */␊ - requestBody?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The time to await before sending next page request. ␊ - */␊ - requestInterval?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string).␊ - */␊ - requestMethod?: {␊ - [k: string]: unknown␊ - }␊ - type: "RestSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity file system source.␊ - */␊ - export interface FileSystemSource {␊ - /**␊ - * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).␊ - */␊ - additionalColumns?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).␊ - */␊ - recursive?: {␊ - [k: string]: unknown␊ - }␊ - type: "FileSystemSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity HDFS source.␊ - */␊ - export interface HdfsSource {␊ - /**␊ - * Distcp settings.␊ - */␊ - distcpSettings?: (DistcpSettings | string)␊ - /**␊ - * If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).␊ - */␊ - recursive?: {␊ - [k: string]: unknown␊ - }␊ - type: "HdfsSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Azure Data Explorer (Kusto) source.␊ - */␊ - export interface AzureDataExplorerSource {␊ - /**␊ - * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).␊ - */␊ - additionalColumns?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The name of the Boolean option that controls whether truncation is applied to result-sets that go beyond a certain row-count limit.␊ - */␊ - noTruncation?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Database query. Should be a Kusto Query Language (KQL) query. Type: string (or Expression with resultType string).␊ - */␊ - query: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))..␊ - */␊ - queryTimeout?: {␊ - [k: string]: unknown␊ - }␊ - type: "AzureDataExplorerSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Oracle source.␊ - */␊ - export interface OracleSource {␊ - /**␊ - * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).␊ - */␊ - additionalColumns?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Oracle reader query. Type: string (or Expression with resultType string).␊ - */␊ - oracleReaderQuery?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The partition mechanism that will be used for Oracle read in parallel. Possible values include: "None", "PhysicalPartitionsOfTable", "DynamicRange".␊ - */␊ - partitionOption?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The settings that will be leveraged for Oracle source partitioning.␊ - */␊ - partitionSettings?: (OraclePartitionSettings | string)␊ - /**␊ - * Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9])).␊ - */␊ - queryTimeout?: {␊ - [k: string]: unknown␊ - }␊ - type: "OracleSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The settings that will be leveraged for Oracle source partitioning.␊ - */␊ - export interface OraclePartitionSettings {␊ - /**␊ - * The name of the column in integer type that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).␊ - */␊ - partitionColumnName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).␊ - */␊ - partitionLowerBound?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Names of the physical partitions of Oracle table. ␊ - */␊ - partitionNames?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).␊ - */␊ - partitionUpperBound?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity AmazonRdsForOracle source.␊ - */␊ - export interface AmazonRdsForOracleSource {␊ - /**␊ - * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).␊ - */␊ - additionalColumns?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AmazonRdsForOracle reader query. Type: string (or Expression with resultType string).␊ - */␊ - oracleReaderQuery?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The partition mechanism that will be used for AmazonRdsForOracle read in parallel. Type: string (or Expression with resultType string).␊ - */␊ - partitionOption?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The settings that will be leveraged for AmazonRdsForOracle source partitioning.␊ - */␊ - partitionSettings?: (AmazonRdsForOraclePartitionSettings | string)␊ - /**␊ - * Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9])).␊ - */␊ - queryTimeout?: {␊ - [k: string]: unknown␊ - }␊ - type: "AmazonRdsForOracleSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The settings that will be leveraged for AmazonRdsForOracle source partitioning.␊ - */␊ - export interface AmazonRdsForOraclePartitionSettings {␊ - /**␊ - * The name of the column in integer type that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).␊ - */␊ - partitionColumnName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).␊ - */␊ - partitionLowerBound?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Names of the physical partitions of AmazonRdsForOracle table. ␊ - */␊ - partitionNames?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string).␊ - */␊ - partitionUpperBound?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity source for web page table.␊ - */␊ - export interface WebSource {␊ - /**␊ - * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).␊ - */␊ - additionalColumns?: {␊ - [k: string]: unknown␊ - }␊ - type: "WebSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity source for a MongoDB database.␊ - */␊ - export interface MongoDbSource {␊ - /**␊ - * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).␊ - */␊ - additionalColumns?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Database query. Should be a SQL-92 query expression. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "MongoDbSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity source for a MongoDB Atlas database.␊ - */␊ - export interface MongoDbAtlasSource {␊ - /**␊ - * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).␊ - */␊ - additionalColumns?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the number of documents to return in each batch of the response from MongoDB Atlas instance. In most cases, modifying the batch size will not affect the user or the application. This property's main purpose is to avoid hit the limitation of response size. Type: integer (or Expression with resultType integer).␊ - */␊ - batchSize?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Cursor methods for Mongodb query␊ - */␊ - cursorMethods?: (MongoDbCursorMethodsProperties | string)␊ - /**␊ - * Specifies selection filter using query operators. To return all documents in a collection, omit this parameter or pass an empty document ({}). Type: string (or Expression with resultType string).␊ - */␊ - filter?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9])).␊ - */␊ - queryTimeout?: {␊ - [k: string]: unknown␊ - }␊ - type: "MongoDbAtlasSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Cursor methods for Mongodb query␊ - */␊ - export interface MongoDbCursorMethodsProperties {␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Specifies the maximum number of documents the server returns. limit() is analogous to the LIMIT statement in a SQL database. Type: integer (or Expression with resultType integer).␊ - */␊ - limit?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the fields to return in the documents that match the query filter. To return all fields in the matching documents, omit this parameter. Type: string (or Expression with resultType string).␊ - */␊ - project?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the how many documents skipped and where MongoDB begins returning results. This approach may be useful in implementing paginated results. Type: integer (or Expression with resultType integer).␊ - */␊ - skip?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the order in which the query returns matching documents. Type: string (or Expression with resultType string). Type: string (or Expression with resultType string).␊ - */␊ - sort?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity source for a MongoDB database.␊ - */␊ - export interface MongoDbV2Source {␊ - /**␊ - * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).␊ - */␊ - additionalColumns?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the number of documents to return in each batch of the response from MongoDB instance. In most cases, modifying the batch size will not affect the user or the application. This property's main purpose is to avoid hit the limitation of response size. Type: integer (or Expression with resultType integer).␊ - */␊ - batchSize?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Cursor methods for Mongodb query␊ - */␊ - cursorMethods?: (MongoDbCursorMethodsProperties | string)␊ - /**␊ - * Specifies selection filter using query operators. To return all documents in a collection, omit this parameter or pass an empty document ({}). Type: string (or Expression with resultType string).␊ - */␊ - filter?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9])).␊ - */␊ - queryTimeout?: {␊ - [k: string]: unknown␊ - }␊ - type: "MongoDbV2Source"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity source for a CosmosDB (MongoDB API) database.␊ - */␊ - export interface CosmosDbMongoDbApiSource {␊ - /**␊ - * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).␊ - */␊ - additionalColumns?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the number of documents to return in each batch of the response from MongoDB instance. In most cases, modifying the batch size will not affect the user or the application. This property's main purpose is to avoid hit the limitation of response size. Type: integer (or Expression with resultType integer).␊ - */␊ - batchSize?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Cursor methods for Mongodb query␊ - */␊ - cursorMethods?: (MongoDbCursorMethodsProperties | string)␊ - /**␊ - * Specifies selection filter using query operators. To return all documents in a collection, omit this parameter or pass an empty document ({}). Type: string (or Expression with resultType string).␊ - */␊ - filter?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9])).␊ - */␊ - queryTimeout?: {␊ - [k: string]: unknown␊ - }␊ - type: "CosmosDbMongoDbApiSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity source for an Office 365 service.␊ - */␊ - export interface Office365Source {␊ - /**␊ - * The groups containing all the users. Type: array of strings (or Expression with resultType array of strings).␊ - */␊ - allowedGroups?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Column to apply the and . Type: string (or Expression with resultType string).␊ - */␊ - dateFilterColumn?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * End time of the requested range for this dataset. Type: string (or Expression with resultType string).␊ - */␊ - endTime?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The columns to be read out from the Office 365 table. Type: array of objects (or Expression with resultType array of objects). Example: [ { "name": "Id" }, { "name": "CreatedDateTime" } ]␊ - */␊ - outputColumns?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Start time of the requested range for this dataset. Type: string (or Expression with resultType string).␊ - */␊ - startTime?: {␊ - [k: string]: unknown␊ - }␊ - type: "Office365Source"␊ - /**␊ - * The user scope uri. Type: string (or Expression with resultType string).␊ - */␊ - userScopeFilterUri?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Azure Data Lake source.␊ - */␊ - export interface AzureDataLakeStoreSource {␊ - /**␊ - * If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).␊ - */␊ - recursive?: {␊ - [k: string]: unknown␊ - }␊ - type: "AzureDataLakeStoreSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Azure BlobFS source.␊ - */␊ - export interface AzureBlobFSSource {␊ - /**␊ - * If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).␊ - */␊ - recursive?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Number of header lines to skip from each blob. Type: integer (or Expression with resultType integer).␊ - */␊ - skipHeaderLineCount?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Treat empty as null. Type: boolean (or Expression with resultType boolean).␊ - */␊ - treatEmptyAsNull?: {␊ - [k: string]: unknown␊ - }␊ - type: "AzureBlobFSSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity source for an HTTP file.␊ - */␊ - export interface HttpSource {␊ - /**␊ - * Specifies the timeout for a HTTP client to get HTTP response from HTTP server. The default value is equivalent to System.Net.HttpWebRequest.Timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9])).␊ - */␊ - httpRequestTimeout?: {␊ - [k: string]: unknown␊ - }␊ - type: "HttpSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity snowflake source.␊ - */␊ - export interface SnowflakeSource {␊ - /**␊ - * Snowflake export command settings.␊ - */␊ - exportSettings?: (SnowflakeExportCopyCommand | string)␊ - /**␊ - * Snowflake Sql query. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "SnowflakeSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Snowflake export command settings.␊ - */␊ - export interface SnowflakeExportCopyCommand {␊ - /**␊ - * Additional copy options directly passed to snowflake Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: "additionalCopyOptions": { "DATE_FORMAT": "MM/DD/YYYY", "TIME_FORMAT": "'HH24:MI:SS.FF'" }␊ - */␊ - additionalCopyOptions?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Additional format options directly passed to snowflake Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: "additionalFormatOptions": { "OVERWRITE": "TRUE", "MAX_FILE_SIZE": "'FALSE'" }␊ - */␊ - additionalFormatOptions?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity Azure Databricks Delta Lake source.␊ - */␊ - export interface AzureDatabricksDeltaLakeSource {␊ - /**␊ - * Azure Databricks Delta Lake export command settings.␊ - */␊ - exportSettings?: (AzureDatabricksDeltaLakeExportCommand | string)␊ - /**␊ - * Azure Databricks Delta Lake Sql query. Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "AzureDatabricksDeltaLakeSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Databricks Delta Lake export command settings.␊ - */␊ - export interface AzureDatabricksDeltaLakeExportCommand {␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Specify the date format for the csv in Azure Databricks Delta Lake Copy. Type: string (or Expression with resultType string).␊ - */␊ - dateFormat?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specify the timestamp format for the csv in Azure Databricks Delta Lake Copy. Type: string (or Expression with resultType string).␊ - */␊ - timestampFormat?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity source for sharePoint online list source.␊ - */␊ - export interface SharePointOnlineListSource {␊ - /**␊ - * The wait time to get a response from SharePoint Online. Default value is 5 minutes (00:05:00). Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9])).␊ - */␊ - httpRequestTimeout?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The OData query to filter the data in SharePoint Online list. For example, "$top=1". Type: string (or Expression with resultType string).␊ - */␊ - query?: {␊ - [k: string]: unknown␊ - }␊ - type: "SharePointOnlineListSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Staging settings.␊ - */␊ - export interface StagingSettings1 {␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Specifies whether to use compression when copying data via an interim staging. Default value is false. Type: boolean (or Expression with resultType boolean).␊ - */␊ - enableCompression?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service reference type.␊ - */␊ - linkedServiceName: (LinkedServiceReference1 | string)␊ - /**␊ - * The path to storage for storing the interim data. Type: string (or Expression with resultType string).␊ - */␊ - path?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HDInsight Hive activity type.␊ - */␊ - export interface HDInsightHiveActivity1 {␊ - type: "HDInsightHive"␊ - /**␊ - * HDInsight Hive activity properties.␊ - */␊ - typeProperties: (HDInsightHiveActivityTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HDInsight Hive activity properties.␊ - */␊ - export interface HDInsightHiveActivityTypeProperties1 {␊ - /**␊ - * User specified arguments to HDInsightActivity.␊ - */␊ - arguments?: ({␊ - [k: string]: unknown␊ - }[] | string)␊ - /**␊ - * Allows user to specify defines for Hive job request.␊ - */␊ - defines?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Debug info option.␊ - */␊ - getDebugInfo?: (("None" | "Always" | "Failure") | string)␊ - /**␊ - * Query timeout value (in minutes). Effective when the HDInsight cluster is with ESP (Enterprise Security Package)␊ - */␊ - queryTimeout?: (number | string)␊ - /**␊ - * Linked service reference type.␊ - */␊ - scriptLinkedService?: (LinkedServiceReference1 | string)␊ - /**␊ - * Script path. Type: string (or Expression with resultType string).␊ - */␊ - scriptPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Storage linked service references.␊ - */␊ - storageLinkedServices?: (LinkedServiceReference1[] | string)␊ - /**␊ - * User specified arguments under hivevar namespace.␊ - */␊ - variables?: ({␊ - [k: string]: unknown␊ - }[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HDInsight Pig activity type.␊ - */␊ - export interface HDInsightPigActivity1 {␊ - type: "HDInsightPig"␊ - /**␊ - * HDInsight Pig activity properties.␊ - */␊ - typeProperties: (HDInsightPigActivityTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HDInsight Pig activity properties.␊ - */␊ - export interface HDInsightPigActivityTypeProperties1 {␊ - /**␊ - * User specified arguments to HDInsightActivity. Type: array (or Expression with resultType array).␊ - */␊ - arguments?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allows user to specify defines for Pig job request.␊ - */␊ - defines?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Debug info option.␊ - */␊ - getDebugInfo?: (("None" | "Always" | "Failure") | string)␊ - /**␊ - * Linked service reference type.␊ - */␊ - scriptLinkedService?: (LinkedServiceReference1 | string)␊ - /**␊ - * Script path. Type: string (or Expression with resultType string).␊ - */␊ - scriptPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Storage linked service references.␊ - */␊ - storageLinkedServices?: (LinkedServiceReference1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HDInsight MapReduce activity type.␊ - */␊ - export interface HDInsightMapReduceActivity1 {␊ - type: "HDInsightMapReduce"␊ - /**␊ - * HDInsight MapReduce activity properties.␊ - */␊ - typeProperties: (HDInsightMapReduceActivityTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HDInsight MapReduce activity properties.␊ - */␊ - export interface HDInsightMapReduceActivityTypeProperties1 {␊ - /**␊ - * User specified arguments to HDInsightActivity.␊ - */␊ - arguments?: ({␊ - [k: string]: unknown␊ - }[] | string)␊ - /**␊ - * Class name. Type: string (or Expression with resultType string).␊ - */␊ - className: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Allows user to specify defines for the MapReduce job request.␊ - */␊ - defines?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Debug info option.␊ - */␊ - getDebugInfo?: (("None" | "Always" | "Failure") | string)␊ - /**␊ - * Jar path. Type: string (or Expression with resultType string).␊ - */␊ - jarFilePath: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Jar libs.␊ - */␊ - jarLibs?: ({␊ - [k: string]: unknown␊ - }[] | string)␊ - /**␊ - * Linked service reference type.␊ - */␊ - jarLinkedService?: (LinkedServiceReference1 | string)␊ - /**␊ - * Storage linked service references.␊ - */␊ - storageLinkedServices?: (LinkedServiceReference1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HDInsight streaming activity type.␊ - */␊ - export interface HDInsightStreamingActivity1 {␊ - type: "HDInsightStreaming"␊ - /**␊ - * HDInsight streaming activity properties.␊ - */␊ - typeProperties: (HDInsightStreamingActivityTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HDInsight streaming activity properties.␊ - */␊ - export interface HDInsightStreamingActivityTypeProperties1 {␊ - /**␊ - * User specified arguments to HDInsightActivity.␊ - */␊ - arguments?: ({␊ - [k: string]: unknown␊ - }[] | string)␊ - /**␊ - * Combiner executable name. Type: string (or Expression with resultType string).␊ - */␊ - combiner?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Command line environment values.␊ - */␊ - commandEnvironment?: ({␊ - [k: string]: unknown␊ - }[] | string)␊ - /**␊ - * Allows user to specify defines for streaming job request.␊ - */␊ - defines?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Linked service reference type.␊ - */␊ - fileLinkedService?: (LinkedServiceReference1 | string)␊ - /**␊ - * Paths to streaming job files. Can be directories.␊ - */␊ - filePaths: ({␊ - [k: string]: unknown␊ - }[] | string)␊ - /**␊ - * Debug info option.␊ - */␊ - getDebugInfo?: (("None" | "Always" | "Failure") | string)␊ - /**␊ - * Input blob path. Type: string (or Expression with resultType string).␊ - */␊ - input: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Mapper executable name. Type: string (or Expression with resultType string).␊ - */␊ - mapper: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Output blob path. Type: string (or Expression with resultType string).␊ - */␊ - output: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Reducer executable name. Type: string (or Expression with resultType string).␊ - */␊ - reducer: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Storage linked service references.␊ - */␊ - storageLinkedServices?: (LinkedServiceReference1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HDInsight Spark activity.␊ - */␊ - export interface HDInsightSparkActivity1 {␊ - type: "HDInsightSpark"␊ - /**␊ - * HDInsight spark activity properties.␊ - */␊ - typeProperties: (HDInsightSparkActivityTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HDInsight spark activity properties.␊ - */␊ - export interface HDInsightSparkActivityTypeProperties1 {␊ - /**␊ - * The user-specified arguments to HDInsightSparkActivity.␊ - */␊ - arguments?: ({␊ - [k: string]: unknown␊ - }[] | string)␊ - /**␊ - * The application's Java/Spark main class.␊ - */␊ - className?: string␊ - /**␊ - * The relative path to the root folder of the code/package to be executed. Type: string (or Expression with resultType string).␊ - */␊ - entryFilePath: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Debug info option.␊ - */␊ - getDebugInfo?: (("None" | "Always" | "Failure") | string)␊ - /**␊ - * The user to impersonate that will execute the job. Type: string (or Expression with resultType string).␊ - */␊ - proxyUser?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The root path in 'sparkJobLinkedService' for all the job’s files. Type: string (or Expression with resultType string).␊ - */␊ - rootPath: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Spark configuration property.␊ - */␊ - sparkConfig?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Linked service reference type.␊ - */␊ - sparkJobLinkedService?: (LinkedServiceReference1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Execute SSIS package activity.␊ - */␊ - export interface ExecuteSSISPackageActivity1 {␊ - type: "ExecuteSSISPackage"␊ - /**␊ - * Execute SSIS package activity properties.␊ - */␊ - typeProperties: (ExecuteSSISPackageActivityTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Execute SSIS package activity properties.␊ - */␊ - export interface ExecuteSSISPackageActivityTypeProperties1 {␊ - /**␊ - * Integration runtime reference type.␊ - */␊ - connectVia: (IntegrationRuntimeReference1 | string)␊ - /**␊ - * The environment path to execute the SSIS package. Type: string (or Expression with resultType string).␊ - */␊ - environmentPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSIS package execution credential.␊ - */␊ - executionCredential?: (SSISExecutionCredential1 | string)␊ - /**␊ - * The logging level of SSIS package execution. Type: string (or Expression with resultType string).␊ - */␊ - loggingLevel?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSIS package execution log location␊ - */␊ - logLocation?: (SSISLogLocation1 | string)␊ - /**␊ - * The package level connection managers to execute the SSIS package.␊ - */␊ - packageConnectionManagers?: ({␊ - [k: string]: {␊ - [k: string]: SSISExecutionParameter1␊ - }␊ - } | string)␊ - /**␊ - * SSIS package location.␊ - */␊ - packageLocation: (SSISPackageLocation1 | string)␊ - /**␊ - * The package level parameters to execute the SSIS package.␊ - */␊ - packageParameters?: ({␊ - [k: string]: SSISExecutionParameter1␊ - } | string)␊ - /**␊ - * The project level connection managers to execute the SSIS package.␊ - */␊ - projectConnectionManagers?: ({␊ - [k: string]: {␊ - [k: string]: SSISExecutionParameter1␊ - }␊ - } | string)␊ - /**␊ - * The project level parameters to execute the SSIS package.␊ - */␊ - projectParameters?: ({␊ - [k: string]: SSISExecutionParameter1␊ - } | string)␊ - /**␊ - * The property overrides to execute the SSIS package.␊ - */␊ - propertyOverrides?: ({␊ - [k: string]: SSISPropertyOverride1␊ - } | string)␊ - /**␊ - * Specifies the runtime to execute SSIS package. The value should be "x86" or "x64". Type: string (or Expression with resultType string).␊ - */␊ - runtime?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSIS package execution credential.␊ - */␊ - export interface SSISExecutionCredential1 {␊ - /**␊ - * Domain for windows authentication.␊ - */␊ - domain: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Data Factory secure string definition. The string value will be masked with asterisks '*' during Get or List API calls.␊ - */␊ - password: (SecureString1 | string)␊ - /**␊ - * UseName for windows authentication.␊ - */␊ - userName: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSIS package execution log location␊ - */␊ - export interface SSISLogLocation1 {␊ - /**␊ - * The SSIS package execution log path. Type: string (or Expression with resultType string).␊ - */␊ - logPath: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The type of SSIS log location.␊ - */␊ - type: ("File" | string)␊ - /**␊ - * SSIS package execution log location properties.␊ - */␊ - typeProperties: (SSISLogLocationTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSIS package execution log location properties.␊ - */␊ - export interface SSISLogLocationTypeProperties1 {␊ - /**␊ - * SSIS access credential.␊ - */␊ - accessCredential?: (SSISAccessCredential1 | string)␊ - /**␊ - * Specifies the interval to refresh log. The default interval is 5 minutes. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9])).␊ - */␊ - logRefreshInterval?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSIS access credential.␊ - */␊ - export interface SSISAccessCredential1 {␊ - /**␊ - * Domain for windows authentication.␊ - */␊ - domain: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - /**␊ - * UseName for windows authentication.␊ - */␊ - userName: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSIS execution parameter.␊ - */␊ - export interface SSISExecutionParameter1 {␊ - /**␊ - * SSIS package execution parameter value. Type: string (or Expression with resultType string).␊ - */␊ - value: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSIS package location.␊ - */␊ - export interface SSISPackageLocation1 {␊ - /**␊ - * The SSIS package path. Type: string (or Expression with resultType string).␊ - */␊ - packagePath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The type of SSIS package location.␊ - */␊ - type?: (("SSISDB" | "File" | "InlinePackage" | "PackageStore") | string)␊ - /**␊ - * SSIS package location properties.␊ - */␊ - typeProperties?: (SSISPackageLocationTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSIS package location properties.␊ - */␊ - export interface SSISPackageLocationTypeProperties1 {␊ - /**␊ - * SSIS access credential.␊ - */␊ - accessCredential?: (SSISAccessCredential1 | string)␊ - /**␊ - * The embedded child package list.␊ - */␊ - childPackages?: (SSISChildPackage[] | string)␊ - /**␊ - * SSIS access credential.␊ - */␊ - configurationAccessCredential?: (SSISAccessCredential1 | string)␊ - /**␊ - * The configuration file of the package execution. Type: string (or Expression with resultType string).␊ - */␊ - configurationPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The embedded package content. Type: string (or Expression with resultType string).␊ - */␊ - packageContent?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The embedded package last modified date.␊ - */␊ - packageLastModifiedDate?: string␊ - /**␊ - * The package name.␊ - */␊ - packageName?: string␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - packagePassword?: ((SecureString1 | AzureKeyVaultSecretReference1) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSIS embedded child package.␊ - */␊ - export interface SSISChildPackage {␊ - /**␊ - * Content for embedded child package. Type: string (or Expression with resultType string).␊ - */␊ - packageContent: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Last modified date for embedded child package.␊ - */␊ - packageLastModifiedDate?: string␊ - /**␊ - * Name for embedded child package.␊ - */␊ - packageName?: string␊ - /**␊ - * Path for embedded child package. Type: string (or Expression with resultType string).␊ - */␊ - packagePath: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSIS property override.␊ - */␊ - export interface SSISPropertyOverride1 {␊ - /**␊ - * Whether SSIS package property override value is sensitive data. Value will be encrypted in SSISDB if it is true␊ - */␊ - isSensitive?: (boolean | string)␊ - /**␊ - * SSIS package property override value. Type: string (or Expression with resultType string).␊ - */␊ - value: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Custom activity type.␊ - */␊ - export interface CustomActivity1 {␊ - type: "Custom"␊ - /**␊ - * Custom activity properties.␊ - */␊ - typeProperties: (CustomActivityTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Custom activity properties.␊ - */␊ - export interface CustomActivityTypeProperties1 {␊ - /**␊ - * Elevation level and scope for the user, default is nonadmin task. Type: string (or Expression with resultType double).␊ - */␊ - autoUserSpecification?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Command for custom activity Type: string (or Expression with resultType string).␊ - */␊ - command: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * User defined property bag. There is no restriction on the keys or values that can be used. The user specified custom activity has the full responsibility to consume and interpret the content defined.␊ - */␊ - extendedProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Folder path for resource files Type: string (or Expression with resultType string).␊ - */␊ - folderPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Reference objects for custom activity␊ - */␊ - referenceObjects?: (CustomActivityReferenceObject1 | string)␊ - /**␊ - * Linked service reference type.␊ - */␊ - resourceLinkedService?: (LinkedServiceReference1 | string)␊ - /**␊ - * The retention time for the files submitted for custom activity. Type: double (or Expression with resultType double).␊ - */␊ - retentionTimeInDays?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Reference objects for custom activity␊ - */␊ - export interface CustomActivityReferenceObject1 {␊ - /**␊ - * Dataset references.␊ - */␊ - datasets?: (DatasetReference1[] | string)␊ - /**␊ - * Linked service references.␊ - */␊ - linkedServices?: (LinkedServiceReference1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SQL stored procedure activity type.␊ - */␊ - export interface SqlServerStoredProcedureActivity1 {␊ - type: "SqlServerStoredProcedure"␊ - /**␊ - * SQL stored procedure activity properties.␊ - */␊ - typeProperties: (SqlServerStoredProcedureActivityTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SQL stored procedure activity properties.␊ - */␊ - export interface SqlServerStoredProcedureActivityTypeProperties1 {␊ - /**␊ - * Stored procedure name. Type: string (or Expression with resultType string).␊ - */␊ - storedProcedureName: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}".␊ - */␊ - storedProcedureParameters?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Delete activity.␊ - */␊ - export interface DeleteActivity {␊ - type: "Delete"␊ - /**␊ - * Delete activity properties.␊ - */␊ - typeProperties: (DeleteActivityTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Delete activity properties.␊ - */␊ - export interface DeleteActivityTypeProperties {␊ - /**␊ - * Dataset reference type.␊ - */␊ - dataset: (DatasetReference1 | string)␊ - /**␊ - * Whether to record detailed logs of delete-activity execution. Default value is false. Type: boolean (or Expression with resultType boolean).␊ - */␊ - enableLogging?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * (Deprecated. Please use LogSettings) Log storage settings.␊ - */␊ - logStorageSettings?: (LogStorageSettings | string)␊ - /**␊ - * The max concurrent connections to connect data source at the same time.␊ - */␊ - maxConcurrentConnections?: (number | string)␊ - /**␊ - * If true, files or sub-folders under current folder path will be deleted recursively. Default is false. Type: boolean (or Expression with resultType boolean).␊ - */␊ - recursive?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Connector read setting.␊ - */␊ - storeSettings?: ((AzureBlobStorageReadSettings | AzureBlobFSReadSettings | AzureDataLakeStoreReadSettings | AmazonS3ReadSettings | FileServerReadSettings | AzureFileStorageReadSettings | AmazonS3CompatibleReadSettings | OracleCloudStorageReadSettings | GoogleCloudStorageReadSettings | FtpReadSettings | SftpReadSettings | HttpReadSettings | HdfsReadSettings) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Data Explorer command activity.␊ - */␊ - export interface AzureDataExplorerCommandActivity {␊ - type: "AzureDataExplorerCommand"␊ - /**␊ - * Azure Data Explorer command activity properties.␊ - */␊ - typeProperties: (AzureDataExplorerCommandActivityTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Data Explorer command activity properties.␊ - */␊ - export interface AzureDataExplorerCommandActivityTypeProperties {␊ - /**␊ - * A control command, according to the Azure Data Explorer command syntax. Type: string (or Expression with resultType string).␊ - */␊ - command: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Control command timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))..)␊ - */␊ - commandTimeout?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Lookup activity.␊ - */␊ - export interface LookupActivity1 {␊ - type: "Lookup"␊ - /**␊ - * Lookup activity properties.␊ - */␊ - typeProperties: (LookupActivityTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Lookup activity properties.␊ - */␊ - export interface LookupActivityTypeProperties1 {␊ - /**␊ - * Dataset reference type.␊ - */␊ - dataset: (DatasetReference1 | string)␊ - /**␊ - * Whether to return first row or all rows. Default value is true. Type: boolean (or Expression with resultType boolean).␊ - */␊ - firstRowOnly?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A copy activity source.␊ - */␊ - source: ((AvroSource | ExcelSource | ParquetSource | DelimitedTextSource | JsonSource | XmlSource | OrcSource | BinarySource | TabularSource | BlobSource | DocumentDbCollectionSource | CosmosDbSqlApiSource | DynamicsSource | DynamicsCrmSource | CommonDataServiceForAppsSource | RelationalSource | MicrosoftAccessSource | ODataSource | SalesforceServiceCloudSource | RestSource | FileSystemSource | HdfsSource | AzureDataExplorerSource | OracleSource | AmazonRdsForOracleSource | WebSource | MongoDbSource | MongoDbAtlasSource | MongoDbV2Source | CosmosDbMongoDbApiSource | Office365Source | AzureDataLakeStoreSource | AzureBlobFSSource | HttpSource | SnowflakeSource | AzureDatabricksDeltaLakeSource | SharePointOnlineListSource) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Web activity.␊ - */␊ - export interface WebActivity1 {␊ - type: "WebActivity"␊ - /**␊ - * Web activity type properties.␊ - */␊ - typeProperties: (WebActivityTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Web activity type properties.␊ - */␊ - export interface WebActivityTypeProperties1 {␊ - /**␊ - * Web activity authentication properties.␊ - */␊ - authentication?: (WebActivityAuthentication1 | string)␊ - /**␊ - * Represents the payload that will be sent to the endpoint. Required for POST/PUT method, not allowed for GET method Type: string (or Expression with resultType string).␊ - */␊ - body?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Integration runtime reference type.␊ - */␊ - connectVia?: (IntegrationRuntimeReference1 | string)␊ - /**␊ - * List of datasets passed to web endpoint.␊ - */␊ - datasets?: (DatasetReference1[] | string)␊ - /**␊ - * When set to true, Certificate validation will be disabled.␊ - */␊ - disableCertValidation?: (boolean | string)␊ - /**␊ - * Represents the headers that will be sent to the request. For example, to set the language and type on a request: "headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }. Type: string (or Expression with resultType string).␊ - */␊ - headers?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * List of linked services passed to web endpoint.␊ - */␊ - linkedServices?: (LinkedServiceReference1[] | string)␊ - /**␊ - * Rest API method for target endpoint.␊ - */␊ - method: (("GET" | "POST" | "PUT" | "DELETE") | string)␊ - /**␊ - * Web activity target endpoint and path. Type: string (or Expression with resultType string).␊ - */␊ - url: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Activity to get metadata of dataset␊ - */␊ - export interface GetMetadataActivity1 {␊ - type: "GetMetadata"␊ - /**␊ - * GetMetadata activity properties.␊ - */␊ - typeProperties: (GetMetadataActivityTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * GetMetadata activity properties.␊ - */␊ - export interface GetMetadataActivityTypeProperties1 {␊ - /**␊ - * Dataset reference type.␊ - */␊ - dataset: (DatasetReference1 | string)␊ - /**␊ - * Fields of metadata to get from dataset.␊ - */␊ - fieldList?: ({␊ - [k: string]: unknown␊ - }[] | string)␊ - /**␊ - * Format read settings.␊ - */␊ - formatSettings?: (FormatReadSettings | string)␊ - /**␊ - * Connector read setting.␊ - */␊ - storeSettings?: ((AzureBlobStorageReadSettings | AzureBlobFSReadSettings | AzureDataLakeStoreReadSettings | AmazonS3ReadSettings | FileServerReadSettings | AzureFileStorageReadSettings | AmazonS3CompatibleReadSettings | OracleCloudStorageReadSettings | GoogleCloudStorageReadSettings | FtpReadSettings | SftpReadSettings | HttpReadSettings | HdfsReadSettings) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure ML Batch Execution activity.␊ - */␊ - export interface AzureMLBatchExecutionActivity1 {␊ - type: "AzureMLBatchExecution"␊ - /**␊ - * Azure ML Batch Execution activity properties.␊ - */␊ - typeProperties: (AzureMLBatchExecutionActivityTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure ML Batch Execution activity properties.␊ - */␊ - export interface AzureMLBatchExecutionActivityTypeProperties1 {␊ - /**␊ - * Key,Value pairs to be passed to the Azure ML Batch Execution Service endpoint. Keys must match the names of web service parameters defined in the published Azure ML web service. Values will be passed in the GlobalParameters property of the Azure ML batch execution request.␊ - */␊ - globalParameters?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Key,Value pairs, mapping the names of Azure ML endpoint's Web Service Inputs to AzureMLWebServiceFile objects specifying the input Blob locations.. This information will be passed in the WebServiceInputs property of the Azure ML batch execution request.␊ - */␊ - webServiceInputs?: ({␊ - [k: string]: AzureMLWebServiceFile1␊ - } | string)␊ - /**␊ - * Key,Value pairs, mapping the names of Azure ML endpoint's Web Service Outputs to AzureMLWebServiceFile objects specifying the output Blob locations. This information will be passed in the WebServiceOutputs property of the Azure ML batch execution request.␊ - */␊ - webServiceOutputs?: ({␊ - [k: string]: AzureMLWebServiceFile1␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure ML WebService Input/Output file␊ - */␊ - export interface AzureMLWebServiceFile1 {␊ - /**␊ - * The relative file path, including container name, in the Azure Blob Storage specified by the LinkedService. Type: string (or Expression with resultType string).␊ - */␊ - filePath: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service reference type.␊ - */␊ - linkedServiceName: (LinkedServiceReference1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure ML Update Resource management activity.␊ - */␊ - export interface AzureMLUpdateResourceActivity1 {␊ - type: "AzureMLUpdateResource"␊ - /**␊ - * Azure ML Update Resource activity properties.␊ - */␊ - typeProperties: (AzureMLUpdateResourceActivityTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure ML Update Resource activity properties.␊ - */␊ - export interface AzureMLUpdateResourceActivityTypeProperties1 {␊ - /**␊ - * The relative file path in trainedModelLinkedService to represent the .ilearner file that will be uploaded by the update operation. Type: string (or Expression with resultType string).␊ - */␊ - trainedModelFilePath: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service reference type.␊ - */␊ - trainedModelLinkedServiceName: (LinkedServiceReference1 | string)␊ - /**␊ - * Name of the Trained Model module in the Web Service experiment to be updated. Type: string (or Expression with resultType string).␊ - */␊ - trainedModelName: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure ML Execute Pipeline activity.␊ - */␊ - export interface AzureMLExecutePipelineActivity {␊ - type: "AzureMLExecutePipeline"␊ - /**␊ - * Azure ML Execute Pipeline activity properties.␊ - */␊ - typeProperties: (AzureMLExecutePipelineActivityTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure ML Execute Pipeline activity properties.␊ - */␊ - export interface AzureMLExecutePipelineActivityTypeProperties {␊ - /**␊ - * Whether to continue execution of other steps in the PipelineRun if a step fails. This information will be passed in the continueOnStepFailure property of the published pipeline execution request. Type: boolean (or Expression with resultType boolean).␊ - */␊ - continueOnStepFailure?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Dictionary used for changing data path assignments without retraining. Values will be passed in the dataPathAssignments property of the published pipeline execution request. Type: object with key value pairs (or Expression with resultType object).␊ - */␊ - dataPathAssignments?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Run history experiment name of the pipeline run. This information will be passed in the ExperimentName property of the published pipeline execution request. Type: string (or Expression with resultType string).␊ - */␊ - experimentName?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The parent Azure ML Service pipeline run id. This information will be passed in the ParentRunId property of the published pipeline execution request. Type: string (or Expression with resultType string).␊ - */␊ - mlParentRunId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ID of the published Azure ML pipeline endpoint. Type: string (or Expression with resultType string).␊ - */␊ - mlPipelineEndpointId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ID of the published Azure ML pipeline. Type: string (or Expression with resultType string).␊ - */␊ - mlPipelineId?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Key,Value pairs to be passed to the published Azure ML pipeline endpoint. Keys must match the names of pipeline parameters defined in the published pipeline. Values will be passed in the ParameterAssignments property of the published pipeline execution request. Type: object with key value pairs (or Expression with resultType object).␊ - */␊ - mlPipelineParameters?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Version of the published Azure ML pipeline endpoint. Type: string (or Expression with resultType string).␊ - */␊ - version?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Data Lake Analytics U-SQL activity.␊ - */␊ - export interface DataLakeAnalyticsUSQLActivity1 {␊ - type: "DataLakeAnalyticsU-SQL"␊ - /**␊ - * DataLakeAnalyticsU-SQL activity properties.␊ - */␊ - typeProperties: (DataLakeAnalyticsUSQLActivityTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DataLakeAnalyticsU-SQL activity properties.␊ - */␊ - export interface DataLakeAnalyticsUSQLActivityTypeProperties1 {␊ - /**␊ - * Compilation mode of U-SQL. Must be one of these values : Semantic, Full and SingleBox. Type: string (or Expression with resultType string).␊ - */␊ - compilationMode?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The maximum number of nodes simultaneously used to run the job. Default value is 1. Type: integer (or Expression with resultType integer), minimum: 1.␊ - */␊ - degreeOfParallelism?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters for U-SQL job request.␊ - */␊ - parameters?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Determines which jobs out of all that are queued should be selected to run first. The lower the number, the higher the priority. Default value is 1000. Type: integer (or Expression with resultType integer), minimum: 1.␊ - */␊ - priority?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Runtime version of the U-SQL engine to use. Type: string (or Expression with resultType string).␊ - */␊ - runtimeVersion?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service reference type.␊ - */␊ - scriptLinkedService: (LinkedServiceReference1 | string)␊ - /**␊ - * Case-sensitive path to folder that contains the U-SQL script. Type: string (or Expression with resultType string).␊ - */␊ - scriptPath: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DatabricksNotebook activity.␊ - */␊ - export interface DatabricksNotebookActivity1 {␊ - type: "DatabricksNotebook"␊ - /**␊ - * Databricks Notebook activity properties.␊ - */␊ - typeProperties: (DatabricksNotebookActivityTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Databricks Notebook activity properties.␊ - */␊ - export interface DatabricksNotebookActivityTypeProperties1 {␊ - /**␊ - * Base parameters to be used for each run of this job.If the notebook takes a parameter that is not specified, the default value from the notebook will be used.␊ - */␊ - baseParameters?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * A list of libraries to be installed on the cluster that will execute the job.␊ - */␊ - libraries?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - }[] | string)␊ - /**␊ - * The absolute path of the notebook to be run in the Databricks Workspace. This path must begin with a slash. Type: string (or Expression with resultType string).␊ - */␊ - notebookPath: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DatabricksSparkJar activity.␊ - */␊ - export interface DatabricksSparkJarActivity {␊ - type: "DatabricksSparkJar"␊ - /**␊ - * Databricks SparkJar activity properties.␊ - */␊ - typeProperties: (DatabricksSparkJarActivityTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Databricks SparkJar activity properties.␊ - */␊ - export interface DatabricksSparkJarActivityTypeProperties {␊ - /**␊ - * A list of libraries to be installed on the cluster that will execute the job.␊ - */␊ - libraries?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - }[] | string)␊ - /**␊ - * The full name of the class containing the main method to be executed. This class must be contained in a JAR provided as a library. Type: string (or Expression with resultType string).␊ - */␊ - mainClassName: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters that will be passed to the main method.␊ - */␊ - parameters?: ({␊ - [k: string]: unknown␊ - }[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DatabricksSparkPython activity.␊ - */␊ - export interface DatabricksSparkPythonActivity {␊ - type: "DatabricksSparkPython"␊ - /**␊ - * Databricks SparkPython activity properties.␊ - */␊ - typeProperties: (DatabricksSparkPythonActivityTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Databricks SparkPython activity properties.␊ - */␊ - export interface DatabricksSparkPythonActivityTypeProperties {␊ - /**␊ - * A list of libraries to be installed on the cluster that will execute the job.␊ - */␊ - libraries?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - }[] | string)␊ - /**␊ - * Command line parameters that will be passed to the Python file.␊ - */␊ - parameters?: ({␊ - [k: string]: unknown␊ - }[] | string)␊ - /**␊ - * The URI of the Python file to be executed. DBFS paths are supported. Type: string (or Expression with resultType string).␊ - */␊ - pythonFile: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Function activity.␊ - */␊ - export interface AzureFunctionActivity {␊ - type: "AzureFunctionActivity"␊ - /**␊ - * Azure Function activity type properties.␊ - */␊ - typeProperties: (AzureFunctionActivityTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Function activity type properties.␊ - */␊ - export interface AzureFunctionActivityTypeProperties {␊ - /**␊ - * Represents the payload that will be sent to the endpoint. Required for POST/PUT method, not allowed for GET method Type: string (or Expression with resultType string).␊ - */␊ - body?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Name of the Function that the Azure Function Activity will call. Type: string (or Expression with resultType string)␊ - */␊ - functionName: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents the headers that will be sent to the request. For example, to set the language and type on a request: "headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }. Type: string (or Expression with resultType string).␊ - */␊ - headers?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Rest API method for target endpoint.␊ - */␊ - method: (("GET" | "POST" | "PUT" | "DELETE" | "OPTIONS" | "HEAD" | "TRACE") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Execute data flow activity.␊ - */␊ - export interface ExecuteDataFlowActivity {␊ - type: "ExecuteDataFlow"␊ - /**␊ - * Execute data flow activity properties.␊ - */␊ - typeProperties: (ExecuteDataFlowActivityTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Execute data flow activity properties.␊ - */␊ - export interface ExecuteDataFlowActivityTypeProperties {␊ - /**␊ - * Compute properties for data flow activity.␊ - */␊ - compute?: (ExecuteDataFlowActivityTypePropertiesCompute | string)␊ - /**␊ - * Continue on error setting used for data flow execution. Enables processing to continue if a sink fails. Type: boolean (or Expression with resultType boolean)␊ - */␊ - continueOnError?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Data flow reference type.␊ - */␊ - dataFlow: (DataFlowReference | string)␊ - /**␊ - * Integration runtime reference type.␊ - */␊ - integrationRuntime?: (IntegrationRuntimeReference1 | string)␊ - /**␊ - * Concurrent run setting used for data flow execution. Allows sinks with the same save order to be processed concurrently. Type: boolean (or Expression with resultType boolean)␊ - */␊ - runConcurrently?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specify number of parallel staging for sources applicable to the sink. Type: integer (or Expression with resultType integer)␊ - */␊ - sourceStagingConcurrency?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Staging info for execute data flow activity.␊ - */␊ - staging?: (DataFlowStagingInfo | string)␊ - /**␊ - * Trace level setting used for data flow monitoring output. Supported values are: 'coarse', 'fine', and 'none'. Type: string (or Expression with resultType string)␊ - */␊ - traceLevel?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Compute properties for data flow activity.␊ - */␊ - export interface ExecuteDataFlowActivityTypePropertiesCompute {␊ - /**␊ - * Compute type of the cluster which will execute data flow job. Possible values include: 'General', 'MemoryOptimized', 'ComputeOptimized'. Type: string (or Expression with resultType string)␊ - */␊ - computeType?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Core count of the cluster which will execute data flow job. Supported values are: 8, 16, 32, 48, 80, 144 and 272. Type: integer (or Expression with resultType integer)␊ - */␊ - coreCount?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Data flow reference type.␊ - */␊ - export interface DataFlowReference {␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Reference data flow parameters from dataset.␊ - */␊ - datasetParameters?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An object mapping parameter names to argument values.␊ - */␊ - parameters?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Reference data flow name.␊ - */␊ - referenceName: string␊ - /**␊ - * Data flow reference type.␊ - */␊ - type: ("DataFlowReference" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Staging info for execute data flow activity.␊ - */␊ - export interface DataFlowStagingInfo {␊ - /**␊ - * Folder path for staging blob. Type: string (or Expression with resultType string)␊ - */␊ - folderPath?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Linked service reference type.␊ - */␊ - linkedService?: (LinkedServiceReference1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Script activity type.␊ - */␊ - export interface ScriptActivity {␊ - type: "Script"␊ - /**␊ - * Script activity properties.␊ - */␊ - typeProperties: (ScriptActivityTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Script activity properties.␊ - */␊ - export interface ScriptActivityTypeProperties {␊ - /**␊ - * Log settings of script activity.␊ - */␊ - logSettings?: (ScriptActivityTypePropertiesLogSettings | string)␊ - /**␊ - * Array of script blocks. Type: array.␊ - */␊ - scripts?: (ScriptActivityScriptBlock[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Log settings of script activity.␊ - */␊ - export interface ScriptActivityTypePropertiesLogSettings {␊ - /**␊ - * The destination of logs. Type: string.␊ - */␊ - logDestination: (("ActivityOutput" | "ExternalStore") | string)␊ - /**␊ - * Log location settings.␊ - */␊ - logLocationSettings?: (LogLocationSettings | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Script block of scripts.␊ - */␊ - export interface ScriptActivityScriptBlock {␊ - /**␊ - * Array of script parameters. Type: array.␊ - */␊ - parameters?: (ScriptActivityParameter[] | string)␊ - /**␊ - * The query text. Type: string (or Expression with resultType string).␊ - */␊ - text: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The type of the query. Type: string.␊ - */␊ - type: (("Query" | "NonQuery") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameters of a script block.␊ - */␊ - export interface ScriptActivityParameter {␊ - /**␊ - * The direction of the parameter.␊ - */␊ - direction?: (("Input" | "Output" | "InputOutput") | string)␊ - /**␊ - * The name of the parameter. Type: string (or Expression with resultType string).␊ - */␊ - name?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The size of the output direction parameter.␊ - */␊ - size?: (number | string)␊ - /**␊ - * The type of the parameter.␊ - */␊ - type?: (("Boolean" | "DateTime" | "DateTimeOffset" | "Decimal" | "Double" | "Guid" | "Int16" | "Int32" | "Int64" | "Single" | "String" | "Timespan") | string)␊ - /**␊ - * The value of the parameter.␊ - */␊ - value?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Execute power query activity.␊ - */␊ - export interface ExecuteWranglingDataflowActivity {␊ - /**␊ - * Execution policy for an activity.␊ - */␊ - policy?: (ActivityPolicy1 | string)␊ - type: "ExecuteWranglingDataflow"␊ - /**␊ - * Execute power query data flow activity properties.␊ - */␊ - typeProperties: (ExecutePowerQueryActivityTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Execute power query data flow activity properties.␊ - */␊ - export interface ExecutePowerQueryActivityTypeProperties {␊ - /**␊ - * Compute properties for data flow activity.␊ - */␊ - compute?: (ExecuteDataFlowActivityTypePropertiesCompute | string)␊ - /**␊ - * Continue on error setting used for data flow execution. Enables processing to continue if a sink fails. Type: boolean (or Expression with resultType boolean)␊ - */␊ - continueOnError?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Data flow reference type.␊ - */␊ - dataFlow: (DataFlowReference | string)␊ - /**␊ - * Integration runtime reference type.␊ - */␊ - integrationRuntime?: (IntegrationRuntimeReference1 | string)␊ - /**␊ - * List of mapping for Power Query mashup query to sink dataset(s).␊ - */␊ - queries?: (PowerQuerySinkMapping[] | string)␊ - /**␊ - * Concurrent run setting used for data flow execution. Allows sinks with the same save order to be processed concurrently. Type: boolean (or Expression with resultType boolean)␊ - */␊ - runConcurrently?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * (Deprecated. Please use Queries). List of Power Query activity sinks mapped to a queryName.␊ - */␊ - sinks?: ({␊ - [k: string]: PowerQuerySink␊ - } | string)␊ - /**␊ - * Specify number of parallel staging for sources applicable to the sink. Type: integer (or Expression with resultType integer)␊ - */␊ - sourceStagingConcurrency?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Staging info for execute data flow activity.␊ - */␊ - staging?: (DataFlowStagingInfo | string)␊ - /**␊ - * Trace level setting used for data flow monitoring output. Supported values are: 'coarse', 'fine', and 'none'. Type: string (or Expression with resultType string)␊ - */␊ - traceLevel?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Map Power Query mashup query to sink dataset(s).␊ - */␊ - export interface PowerQuerySinkMapping {␊ - /**␊ - * List of sinks mapped to Power Query mashup query.␊ - */␊ - dataflowSinks?: (PowerQuerySink[] | string)␊ - /**␊ - * Name of the query in Power Query mashup document.␊ - */␊ - queryName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Power query sink.␊ - */␊ - export interface PowerQuerySink {␊ - /**␊ - * Dataset reference type.␊ - */␊ - dataset?: (DatasetReference1 | string)␊ - /**␊ - * Transformation description.␊ - */␊ - description?: string␊ - /**␊ - * Data flow reference type.␊ - */␊ - flowlet?: (DataFlowReference | string)␊ - /**␊ - * Linked service reference type.␊ - */␊ - linkedService?: (LinkedServiceReference1 | string)␊ - /**␊ - * Transformation name.␊ - */␊ - name: string␊ - /**␊ - * Linked service reference type.␊ - */␊ - rejectedDataLinkedService?: (LinkedServiceReference1 | string)␊ - /**␊ - * Linked service reference type.␊ - */␊ - schemaLinkedService?: (LinkedServiceReference1 | string)␊ - /**␊ - * sink script.␊ - */␊ - script?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The folder that this Pipeline is in. If not specified, Pipeline will appear at the root level.␊ - */␊ - export interface PipelineFolder {␊ - /**␊ - * The name of the folder that this Pipeline is in.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Pipeline Policy.␊ - */␊ - export interface PipelinePolicy {␊ - /**␊ - * Pipeline ElapsedTime Metric Policy.␊ - */␊ - elapsedTimeMetric?: (PipelineElapsedTimeMetricPolicy | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Pipeline ElapsedTime Metric Policy.␊ - */␊ - export interface PipelineElapsedTimeMetricPolicy {␊ - /**␊ - * TimeSpan value, after which an Azure Monitoring Metric is fired.␊ - */␊ - duration?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Definition of a single variable for a Pipeline.␊ - */␊ - export interface VariableSpecification {␊ - /**␊ - * Default value of variable.␊ - */␊ - defaultValue?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Variable type.␊ - */␊ - type: (("String" | "Bool" | "Array") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataFactory/factories/triggers␊ - */␊ - export interface FactoriesTriggersChildResource1 {␊ - apiVersion: "2018-06-01"␊ - /**␊ - * The trigger name.␊ - */␊ - name: string␊ - /**␊ - * Azure data factory nested object which contains information about creating pipeline run␊ - */␊ - properties: (Trigger1 | string)␊ - type: "triggers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Pipeline that needs to be triggered with the given parameters.␊ - */␊ - export interface TriggerPipelineReference1 {␊ - /**␊ - * An object mapping parameter names to argument values.␊ - */␊ - parameters?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Pipeline reference type.␊ - */␊ - pipelineReference?: (PipelineReference1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trigger that creates pipeline runs periodically, on schedule.␊ - */␊ - export interface ScheduleTrigger {␊ - type: "ScheduleTrigger"␊ - /**␊ - * Schedule Trigger properties.␊ - */␊ - typeProperties: (ScheduleTriggerTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Schedule Trigger properties.␊ - */␊ - export interface ScheduleTriggerTypeProperties {␊ - /**␊ - * The workflow trigger recurrence.␊ - */␊ - recurrence: (ScheduleTriggerRecurrence | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The workflow trigger recurrence.␊ - */␊ - export interface ScheduleTriggerRecurrence {␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * The end time.␊ - */␊ - endTime?: string␊ - /**␊ - * The frequency.␊ - */␊ - frequency?: (("NotSpecified" | "Minute" | "Hour" | "Day" | "Week" | "Month" | "Year") | string)␊ - /**␊ - * The interval.␊ - */␊ - interval?: (number | string)␊ - /**␊ - * The recurrence schedule.␊ - */␊ - schedule?: (RecurrenceSchedule | string)␊ - /**␊ - * The start time.␊ - */␊ - startTime?: string␊ - /**␊ - * The time zone.␊ - */␊ - timeZone?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The recurrence schedule.␊ - */␊ - export interface RecurrenceSchedule {␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * The hours.␊ - */␊ - hours?: (number[] | string)␊ - /**␊ - * The minutes.␊ - */␊ - minutes?: (number[] | string)␊ - /**␊ - * The month days.␊ - */␊ - monthDays?: (number[] | string)␊ - /**␊ - * The monthly occurrences.␊ - */␊ - monthlyOccurrences?: (RecurrenceScheduleOccurrence[] | string)␊ - /**␊ - * The days of the week.␊ - */␊ - weekDays?: (("Sunday" | "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday")[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The recurrence schedule occurrence.␊ - */␊ - export interface RecurrenceScheduleOccurrence {␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * The day of the week.␊ - */␊ - day?: (("Sunday" | "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday") | string)␊ - /**␊ - * The occurrence.␊ - */␊ - occurrence?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trigger that runs every time the selected Blob container changes.␊ - */␊ - export interface BlobTrigger {␊ - type: "BlobTrigger"␊ - /**␊ - * Blob Trigger properties.␊ - */␊ - typeProperties: (BlobTriggerTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Blob Trigger properties.␊ - */␊ - export interface BlobTriggerTypeProperties {␊ - /**␊ - * The path of the container/folder that will trigger the pipeline.␊ - */␊ - folderPath: string␊ - /**␊ - * Linked service reference type.␊ - */␊ - linkedService: (LinkedServiceReference1 | string)␊ - /**␊ - * The max number of parallel files to handle when it is triggered.␊ - */␊ - maxConcurrency: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trigger that runs every time a Blob event occurs.␊ - */␊ - export interface BlobEventsTrigger {␊ - type: "BlobEventsTrigger"␊ - /**␊ - * Blob Events Trigger properties.␊ - */␊ - typeProperties: (BlobEventsTriggerTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Blob Events Trigger properties.␊ - */␊ - export interface BlobEventsTriggerTypeProperties {␊ - /**␊ - * The blob path must begin with the pattern provided for trigger to fire. For example, '/records/blobs/december/' will only fire the trigger for blobs in the december folder under the records container. At least one of these must be provided: blobPathBeginsWith, blobPathEndsWith.␊ - */␊ - blobPathBeginsWith?: string␊ - /**␊ - * The blob path must end with the pattern provided for trigger to fire. For example, 'december/boxes.csv' will only fire the trigger for blobs named boxes in a december folder. At least one of these must be provided: blobPathBeginsWith, blobPathEndsWith.␊ - */␊ - blobPathEndsWith?: string␊ - /**␊ - * Blob event types.␊ - */␊ - events: (("Microsoft.Storage.BlobCreated" | "Microsoft.Storage.BlobDeleted")[] | string)␊ - /**␊ - * If set to true, blobs with zero bytes will be ignored.␊ - */␊ - ignoreEmptyBlobs?: (boolean | string)␊ - /**␊ - * The ARM resource ID of the Storage Account.␊ - */␊ - scope: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trigger that runs every time a custom event is received.␊ - */␊ - export interface CustomEventsTrigger {␊ - type: "CustomEventsTrigger"␊ - /**␊ - * Custom Events Trigger properties.␊ - */␊ - typeProperties: (CustomEventsTriggerTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Custom Events Trigger properties.␊ - */␊ - export interface CustomEventsTriggerTypeProperties {␊ - /**␊ - * The list of event types that cause this trigger to fire.␊ - */␊ - events: ({␊ - [k: string]: unknown␊ - }[] | string)␊ - /**␊ - * The ARM resource ID of the Azure Event Grid Topic.␊ - */␊ - scope: string␊ - /**␊ - * The event subject must begin with the pattern provided for trigger to fire. At least one of these must be provided: subjectBeginsWith, subjectEndsWith.␊ - */␊ - subjectBeginsWith?: string␊ - /**␊ - * The event subject must end with the pattern provided for trigger to fire. At least one of these must be provided: subjectBeginsWith, subjectEndsWith.␊ - */␊ - subjectEndsWith?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trigger that schedules pipeline runs for all fixed time interval windows from a start time without gaps and also supports backfill scenarios (when start time is in the past).␊ - */␊ - export interface TumblingWindowTrigger {␊ - /**␊ - * Pipeline that needs to be triggered with the given parameters.␊ - */␊ - pipeline: (TriggerPipelineReference1 | string)␊ - type: "TumblingWindowTrigger"␊ - /**␊ - * Tumbling Window Trigger properties.␊ - */␊ - typeProperties: (TumblingWindowTriggerTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Tumbling Window Trigger properties.␊ - */␊ - export interface TumblingWindowTriggerTypeProperties {␊ - /**␊ - * Specifies how long the trigger waits past due time before triggering new run. It doesn't alter window start and end time. The default is 0. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9])).␊ - */␊ - delay?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Triggers that this trigger depends on. Only tumbling window triggers are supported.␊ - */␊ - dependsOn?: (DependencyReference[] | string)␊ - /**␊ - * The end time for the time period for the trigger during which events are fired for windows that are ready. Only UTC time is currently supported.␊ - */␊ - endTime?: string␊ - /**␊ - * The frequency of the time windows.␊ - */␊ - frequency: (("Minute" | "Hour" | "Month") | string)␊ - /**␊ - * The interval of the time windows. The minimum interval allowed is 15 Minutes.␊ - */␊ - interval: (number | string)␊ - /**␊ - * The max number of parallel time windows (ready for execution) for which a new run is triggered.␊ - */␊ - maxConcurrency: (number | string)␊ - /**␊ - * Execution policy for an activity.␊ - */␊ - retryPolicy?: (RetryPolicy2 | string)␊ - /**␊ - * The start time for the time period for the trigger during which events are fired for windows that are ready. Only UTC time is currently supported.␊ - */␊ - startTime: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trigger reference type.␊ - */␊ - export interface TriggerReference {␊ - /**␊ - * Reference trigger name.␊ - */␊ - referenceName: string␊ - /**␊ - * Trigger reference type.␊ - */␊ - type: ("TriggerReference" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Referenced tumbling window trigger dependency.␊ - */␊ - export interface TumblingWindowTriggerDependencyReference {␊ - /**␊ - * Timespan applied to the start time of a tumbling window when evaluating dependency.␊ - */␊ - offset?: string␊ - /**␊ - * The size of the window when evaluating the dependency. If undefined the frequency of the tumbling window will be used.␊ - */␊ - size?: string␊ - type: "TumblingWindowTriggerDependencyReference"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Self referenced tumbling window trigger dependency.␊ - */␊ - export interface SelfDependencyTumblingWindowTriggerReference {␊ - /**␊ - * Timespan applied to the start time of a tumbling window when evaluating dependency.␊ - */␊ - offset: string␊ - /**␊ - * The size of the window when evaluating the dependency. If undefined the frequency of the tumbling window will be used.␊ - */␊ - size?: string␊ - type: "SelfDependencyTumblingWindowTriggerReference"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Execution policy for an activity.␊ - */␊ - export interface RetryPolicy2 {␊ - /**␊ - * Maximum ordinary retry attempts. Default is 0. Type: integer (or Expression with resultType integer), minimum: 0.␊ - */␊ - count?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Interval between retries in seconds. Default is 30.␊ - */␊ - intervalInSeconds?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trigger that schedules pipeline reruns for all fixed time interval windows from a requested start time to requested end time.␊ - */␊ - export interface RerunTumblingWindowTrigger {␊ - type: "RerunTumblingWindowTrigger"␊ - /**␊ - * Rerun Trigger properties.␊ - */␊ - typeProperties: (RerunTumblingWindowTriggerTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Rerun Trigger properties.␊ - */␊ - export interface RerunTumblingWindowTriggerTypeProperties {␊ - /**␊ - * The parent trigger reference.␊ - */␊ - parentTrigger: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The end time for the time period for which restatement is initiated. Only UTC time is currently supported.␊ - */␊ - requestedEndTime: string␊ - /**␊ - * The start time for the time period for which restatement is initiated. Only UTC time is currently supported.␊ - */␊ - requestedStartTime: string␊ - /**␊ - * The max number of parallel time windows (ready for execution) for which a rerun is triggered.␊ - */␊ - rerunConcurrency: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trigger that allows the referenced pipeline to depend on other pipeline runs based on runDimension Name/Value pairs. Upstream pipelines should declare the same runDimension Name and their runs should have the values for those runDimensions. The referenced pipeline run would be triggered if the values for the runDimension match for all upstream pipeline runs.␊ - */␊ - export interface ChainingTrigger {␊ - /**␊ - * Pipeline that needs to be triggered with the given parameters.␊ - */␊ - pipeline: (TriggerPipelineReference1 | string)␊ - type: "ChainingTrigger"␊ - /**␊ - * Chaining Trigger properties.␊ - */␊ - typeProperties: (ChainingTriggerTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Chaining Trigger properties.␊ - */␊ - export interface ChainingTriggerTypeProperties {␊ - /**␊ - * Upstream Pipelines.␊ - */␊ - dependsOn: (PipelineReference1[] | string)␊ - /**␊ - * Run Dimension property that needs to be emitted by upstream pipelines.␊ - */␊ - runDimension: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataFactory/factories/dataflows␊ - */␊ - export interface FactoriesDataflowsChildResource {␊ - apiVersion: "2018-06-01"␊ - /**␊ - * The data flow name.␊ - */␊ - name: string␊ - /**␊ - * Azure Data Factory nested object which contains a flow with data movements and transformations.␊ - */␊ - properties: (DataFlow | string)␊ - type: "dataflows"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The folder that this data flow is in. If not specified, Data flow will appear at the root level.␊ - */␊ - export interface DataFlowFolder {␊ - /**␊ - * The name of the folder that this data flow is in.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Mapping data flow.␊ - */␊ - export interface MappingDataFlow {␊ - type: "MappingDataFlow"␊ - /**␊ - * Mapping data flow type properties.␊ - */␊ - typeProperties?: (MappingDataFlowTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Mapping data flow type properties.␊ - */␊ - export interface MappingDataFlowTypeProperties {␊ - /**␊ - * DataFlow script.␊ - */␊ - script?: string␊ - /**␊ - * Data flow script lines.␊ - */␊ - scriptLines?: (string[] | string)␊ - /**␊ - * List of sinks in data flow.␊ - */␊ - sinks?: (DataFlowSink[] | string)␊ - /**␊ - * List of sources in data flow.␊ - */␊ - sources?: (DataFlowSource[] | string)␊ - /**␊ - * List of transformations in data flow.␊ - */␊ - transformations?: (Transformation1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Transformation for data flow sink.␊ - */␊ - export interface DataFlowSink {␊ - /**␊ - * Dataset reference type.␊ - */␊ - dataset?: (DatasetReference1 | string)␊ - /**␊ - * Transformation description.␊ - */␊ - description?: string␊ - /**␊ - * Data flow reference type.␊ - */␊ - flowlet?: (DataFlowReference | string)␊ - /**␊ - * Linked service reference type.␊ - */␊ - linkedService?: (LinkedServiceReference1 | string)␊ - /**␊ - * Transformation name.␊ - */␊ - name: string␊ - /**␊ - * Linked service reference type.␊ - */␊ - rejectedDataLinkedService?: (LinkedServiceReference1 | string)␊ - /**␊ - * Linked service reference type.␊ - */␊ - schemaLinkedService?: (LinkedServiceReference1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Transformation for data flow source.␊ - */␊ - export interface DataFlowSource {␊ - /**␊ - * Dataset reference type.␊ - */␊ - dataset?: (DatasetReference1 | string)␊ - /**␊ - * Transformation description.␊ - */␊ - description?: string␊ - /**␊ - * Data flow reference type.␊ - */␊ - flowlet?: (DataFlowReference | string)␊ - /**␊ - * Linked service reference type.␊ - */␊ - linkedService?: (LinkedServiceReference1 | string)␊ - /**␊ - * Transformation name.␊ - */␊ - name: string␊ - /**␊ - * Linked service reference type.␊ - */␊ - schemaLinkedService?: (LinkedServiceReference1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A data flow transformation.␊ - */␊ - export interface Transformation1 {␊ - /**␊ - * Dataset reference type.␊ - */␊ - dataset?: (DatasetReference1 | string)␊ - /**␊ - * Transformation description.␊ - */␊ - description?: string␊ - /**␊ - * Data flow reference type.␊ - */␊ - flowlet?: (DataFlowReference | string)␊ - /**␊ - * Linked service reference type.␊ - */␊ - linkedService?: (LinkedServiceReference1 | string)␊ - /**␊ - * Transformation name.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Data flow flowlet␊ - */␊ - export interface Flowlet {␊ - type: "Flowlet"␊ - /**␊ - * Flowlet type properties.␊ - */␊ - typeProperties?: (FlowletTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Flowlet type properties.␊ - */␊ - export interface FlowletTypeProperties {␊ - /**␊ - * Flowlet script.␊ - */␊ - script?: string␊ - /**␊ - * Flowlet script lines.␊ - */␊ - scriptLines?: (string[] | string)␊ - /**␊ - * List of sinks in Flowlet.␊ - */␊ - sinks?: (DataFlowSink[] | string)␊ - /**␊ - * List of sources in Flowlet.␊ - */␊ - sources?: (DataFlowSource[] | string)␊ - /**␊ - * List of transformations in Flowlet.␊ - */␊ - transformations?: (Transformation1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Power Query data flow.␊ - */␊ - export interface WranglingDataFlow {␊ - type: "WranglingDataFlow"␊ - /**␊ - * Power Query data flow type properties.␊ - */␊ - typeProperties?: (PowerQueryTypeProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Power Query data flow type properties.␊ - */␊ - export interface PowerQueryTypeProperties {␊ - /**␊ - * Locale of the Power query mashup document.␊ - */␊ - documentLocale?: string␊ - /**␊ - * Power query mashup script.␊ - */␊ - script?: string␊ - /**␊ - * List of sources in Power Query.␊ - */␊ - sources?: (PowerQuerySource[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Power query source.␊ - */␊ - export interface PowerQuerySource {␊ - /**␊ - * Dataset reference type.␊ - */␊ - dataset?: (DatasetReference1 | string)␊ - /**␊ - * Transformation description.␊ - */␊ - description?: string␊ - /**␊ - * Data flow reference type.␊ - */␊ - flowlet?: (DataFlowReference | string)␊ - /**␊ - * Linked service reference type.␊ - */␊ - linkedService?: (LinkedServiceReference1 | string)␊ - /**␊ - * Transformation name.␊ - */␊ - name: string␊ - /**␊ - * Linked service reference type.␊ - */␊ - schemaLinkedService?: (LinkedServiceReference1 | string)␊ - /**␊ - * source script.␊ - */␊ - script?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataFactory/factories/managedVirtualNetworks␊ - */␊ - export interface FactoriesManagedVirtualNetworksChildResource {␊ - apiVersion: "2018-06-01"␊ - /**␊ - * Managed virtual network name␊ - */␊ - name: string␊ - /**␊ - * A managed Virtual Network associated with the Azure Data Factory␊ - */␊ - properties: (ManagedVirtualNetwork | string)␊ - type: "managedVirtualNetworks"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A managed Virtual Network associated with the Azure Data Factory␊ - */␊ - export interface ManagedVirtualNetwork {␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataFactory/factories/privateEndpointConnections␊ - */␊ - export interface FactoriesPrivateEndpointConnectionsChildResource {␊ - apiVersion: "2018-06-01"␊ - /**␊ - * The private endpoint connection name.␊ - */␊ - name: string␊ - /**␊ - * A request to approve or reject a private endpoint connection␊ - */␊ - properties: (PrivateLinkConnectionApprovalRequest | string)␊ - type: "privateEndpointConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A request to approve or reject a private endpoint connection␊ - */␊ - export interface PrivateLinkConnectionApprovalRequest {␊ - /**␊ - * Private endpoint which a connection belongs to.␊ - */␊ - privateEndpoint?: (PrivateEndpoint8 | string)␊ - /**␊ - * The state of a private link connection␊ - */␊ - privateLinkServiceConnectionState?: (PrivateLinkConnectionState | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Private endpoint which a connection belongs to.␊ - */␊ - export interface PrivateEndpoint8 {␊ - /**␊ - * The resource Id for private endpoint␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The state of a private link connection␊ - */␊ - export interface PrivateLinkConnectionState {␊ - /**␊ - * ActionsRequired for a private link connection␊ - */␊ - actionsRequired?: string␊ - /**␊ - * Description of a private link connection␊ - */␊ - description?: string␊ - /**␊ - * Status of a private link connection␊ - */␊ - status?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataFactory/factories/globalParameters␊ - */␊ - export interface FactoriesGlobalParametersChildResource {␊ - apiVersion: "2018-06-01"␊ - /**␊ - * The global parameter name.␊ - */␊ - name: string␊ - /**␊ - * Global parameters associated with the Azure Data Factory␊ - */␊ - properties: ({␊ - [k: string]: GlobalParameterSpecification␊ - } | string)␊ - type: "globalParameters"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataFactory/factories/dataflows␊ - */␊ - export interface FactoriesDataflows {␊ - apiVersion: "2018-06-01"␊ - /**␊ - * The data flow name.␊ - */␊ - name: string␊ - /**␊ - * Azure Data Factory nested object which contains a flow with data movements and transformations.␊ - */␊ - properties: ((MappingDataFlow | Flowlet | WranglingDataFlow) | string)␊ - type: "Microsoft.DataFactory/factories/dataflows"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataFactory/factories/datasets␊ - */␊ - export interface FactoriesDatasets1 {␊ - apiVersion: "2018-06-01"␊ - /**␊ - * The dataset name.␊ - */␊ - name: string␊ - /**␊ - * The Azure Data Factory nested object which identifies data within different data stores, such as tables, files, folders, and documents.␊ - */␊ - properties: ((AmazonS3Dataset1 | AvroDataset | ExcelDataset | ParquetDataset | DelimitedTextDataset | JsonDataset | XmlDataset | OrcDataset | BinaryDataset | AzureBlobDataset1 | AzureTableDataset1 | AzureSqlTableDataset1 | AzureSqlMITableDataset | AzureSqlDWTableDataset1 | CassandraTableDataset1 | CustomDataset | CosmosDbSqlApiCollectionDataset | DocumentDbCollectionDataset1 | DynamicsEntityDataset1 | DynamicsCrmEntityDataset | CommonDataServiceForAppsEntityDataset | AzureDataLakeStoreDataset1 | AzureBlobFSDataset | Office365Dataset | FileShareDataset1 | MongoDbCollectionDataset1 | MongoDbAtlasCollectionDataset | MongoDbV2CollectionDataset | CosmosDbMongoDbApiCollectionDataset | ODataResourceDataset1 | OracleTableDataset1 | AmazonRdsForOracleTableDataset | TeradataTableDataset | AzureMySqlTableDataset1 | AmazonRedshiftTableDataset | Db2TableDataset | RelationalTableDataset1 | InformixTableDataset | OdbcTableDataset | MySqlTableDataset | PostgreSqlTableDataset | MicrosoftAccessTableDataset | SalesforceObjectDataset1 | SalesforceServiceCloudObjectDataset | SybaseTableDataset | SapBwCubeDataset | SapCloudForCustomerResourceDataset1 | SapEccResourceDataset1 | SapHanaTableDataset | SapOpenHubTableDataset | SqlServerTableDataset1 | AmazonRdsForSqlServerTableDataset | RestResourceDataset | SapTableResourceDataset | SapOdpResourceDataset | WebTableDataset1 | AzureSearchIndexDataset1 | HttpDataset1 | AmazonMWSObjectDataset1 | AzurePostgreSqlTableDataset1 | ConcurObjectDataset1 | CouchbaseTableDataset1 | DrillTableDataset1 | EloquaObjectDataset1 | GoogleBigQueryObjectDataset1 | GreenplumTableDataset1 | HBaseObjectDataset1 | HiveObjectDataset1 | HubspotObjectDataset1 | ImpalaObjectDataset1 | JiraObjectDataset1 | MagentoObjectDataset1 | MariaDBTableDataset1 | AzureMariaDBTableDataset | MarketoObjectDataset1 | PaypalObjectDataset1 | PhoenixObjectDataset1 | PrestoObjectDataset1 | QuickBooksObjectDataset1 | ServiceNowObjectDataset1 | ShopifyObjectDataset1 | SparkObjectDataset1 | SquareObjectDataset1 | XeroObjectDataset1 | ZohoObjectDataset1 | NetezzaTableDataset1 | VerticaTableDataset1 | SalesforceMarketingCloudObjectDataset1 | ResponsysObjectDataset1 | DynamicsAXResourceDataset | OracleServiceCloudObjectDataset | AzureDataExplorerTableDataset | GoogleAdWordsObjectDataset | SnowflakeDataset | SharePointOnlineListResourceDataset | AzureDatabricksDeltaLakeDataset) | string)␊ - type: "Microsoft.DataFactory/factories/datasets"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataFactory/factories/integrationRuntimes␊ - */␊ - export interface FactoriesIntegrationRuntimes1 {␊ - apiVersion: "2018-06-01"␊ - /**␊ - * The integration runtime name.␊ - */␊ - name: string␊ - /**␊ - * Azure Data Factory nested object which serves as a compute resource for activities.␊ - */␊ - properties: ((ManagedIntegrationRuntime1 | SelfHostedIntegrationRuntime1) | string)␊ - type: "Microsoft.DataFactory/factories/integrationRuntimes"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataFactory/factories/linkedservices␊ - */␊ - export interface FactoriesLinkedservices1 {␊ - apiVersion: "2018-06-01"␊ - /**␊ - * The linked service name.␊ - */␊ - name: string␊ - /**␊ - * The nested object which contains the information and credential which can be used to connect with related store or compute resource.␊ - */␊ - properties: ((AzureStorageLinkedService1 | AzureBlobStorageLinkedService | AzureTableStorageLinkedService | AzureSqlDWLinkedService1 | SqlServerLinkedService1 | AmazonRdsForSqlServerLinkedService | AzureSqlDatabaseLinkedService1 | AzureSqlMILinkedService | AzureBatchLinkedService1 | AzureKeyVaultLinkedService1 | CosmosDbLinkedService1 | DynamicsLinkedService1 | DynamicsCrmLinkedService | CommonDataServiceForAppsLinkedService | HDInsightLinkedService1 | FileServerLinkedService1 | AzureFileStorageLinkedService | AmazonS3CompatibleLinkedService | OracleCloudStorageLinkedService | GoogleCloudStorageLinkedService | OracleLinkedService1 | AmazonRdsForOracleLinkedService | AzureMySqlLinkedService1 | MySqlLinkedService1 | PostgreSqlLinkedService1 | SybaseLinkedService1 | Db2LinkedService1 | TeradataLinkedService1 | AzureMLLinkedService1 | AzureMLServiceLinkedService | OdbcLinkedService1 | InformixLinkedService | MicrosoftAccessLinkedService | HdfsLinkedService1 | ODataLinkedService1 | WebLinkedService1 | CassandraLinkedService1 | MongoDbLinkedService1 | MongoDbAtlasLinkedService | MongoDbV2LinkedService | CosmosDbMongoDbApiLinkedService | AzureDataLakeStoreLinkedService1 | AzureBlobFSLinkedService | Office365LinkedService | SalesforceLinkedService1 | SalesforceServiceCloudLinkedService | SapCloudForCustomerLinkedService1 | SapEccLinkedService1 | SapOpenHubLinkedService | SapOdpLinkedService | RestServiceLinkedService | TeamDeskLinkedService | QuickbaseLinkedService | SmartsheetLinkedService | ZendeskLinkedService | DataworldLinkedService | AppFiguresLinkedService | AsanaLinkedService | TwilioLinkedService | AmazonS3LinkedService1 | AmazonRedshiftLinkedService1 | CustomDataSourceLinkedService1 | AzureSearchLinkedService1 | HttpLinkedService1 | FtpServerLinkedService1 | SftpServerLinkedService1 | SapBWLinkedService1 | SapHanaLinkedService1 | AmazonMWSLinkedService1 | AzurePostgreSqlLinkedService1 | ConcurLinkedService1 | CouchbaseLinkedService1 | DrillLinkedService1 | EloquaLinkedService1 | GoogleBigQueryLinkedService1 | GreenplumLinkedService1 | HBaseLinkedService1 | HiveLinkedService1 | HubspotLinkedService1 | ImpalaLinkedService1 | JiraLinkedService1 | MagentoLinkedService1 | MariaDBLinkedService1 | AzureMariaDBLinkedService | MarketoLinkedService1 | PaypalLinkedService1 | PhoenixLinkedService1 | PrestoLinkedService1 | QuickBooksLinkedService1 | ServiceNowLinkedService1 | ShopifyLinkedService1 | SparkLinkedService1 | SquareLinkedService1 | XeroLinkedService1 | ZohoLinkedService1 | VerticaLinkedService1 | NetezzaLinkedService1 | SalesforceMarketingCloudLinkedService1 | HDInsightOnDemandLinkedService1 | AzureDataLakeAnalyticsLinkedService1 | AzureDatabricksLinkedService1 | AzureDatabricksDeltaLakeLinkedService | ResponsysLinkedService1 | DynamicsAXLinkedService | OracleServiceCloudLinkedService | GoogleAdWordsLinkedService | SapTableLinkedService | AzureDataExplorerLinkedService | AzureFunctionLinkedService | SnowflakeLinkedService | SharePointOnlineListLinkedService) | string)␊ - type: "Microsoft.DataFactory/factories/linkedservices"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataFactory/factories/pipelines␊ - */␊ - export interface FactoriesPipelines1 {␊ - apiVersion: "2018-06-01"␊ - /**␊ - * The pipeline name.␊ - */␊ - name: string␊ - /**␊ - * A data factory pipeline.␊ - */␊ - properties: (Pipeline1 | string)␊ - type: "Microsoft.DataFactory/factories/pipelines"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataFactory/factories/triggers␊ - */␊ - export interface FactoriesTriggers1 {␊ - apiVersion: "2018-06-01"␊ - /**␊ - * The trigger name.␊ - */␊ - name: string␊ - /**␊ - * Azure data factory nested object which contains information about creating pipeline run␊ - */␊ - properties: ((MultiplePipelineTrigger1 | TumblingWindowTrigger | RerunTumblingWindowTrigger | ChainingTrigger) | string)␊ - type: "Microsoft.DataFactory/factories/triggers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataFactory/factories/managedVirtualNetworks␊ - */␊ - export interface FactoriesManagedVirtualNetworks {␊ - apiVersion: "2018-06-01"␊ - /**␊ - * Managed virtual network name␊ - */␊ - name: string␊ - /**␊ - * A managed Virtual Network associated with the Azure Data Factory␊ - */␊ - properties: (ManagedVirtualNetwork | string)␊ - resources?: FactoriesManagedVirtualNetworksManagedPrivateEndpointsChildResource[]␊ - type: "Microsoft.DataFactory/factories/managedVirtualNetworks"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataFactory/factories/managedVirtualNetworks/managedPrivateEndpoints␊ - */␊ - export interface FactoriesManagedVirtualNetworksManagedPrivateEndpointsChildResource {␊ - apiVersion: "2018-06-01"␊ - /**␊ - * Managed private endpoint name␊ - */␊ - name: string␊ - /**␊ - * Properties of a managed private endpoint␊ - */␊ - properties: (ManagedPrivateEndpoint | string)␊ - type: "managedPrivateEndpoints"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a managed private endpoint␊ - */␊ - export interface ManagedPrivateEndpoint {␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * The connection state of a managed private endpoint␊ - */␊ - connectionState?: (ConnectionStateProperties | string)␊ - /**␊ - * Fully qualified domain names␊ - */␊ - fqdns?: (string[] | string)␊ - /**␊ - * The groupId to which the managed private endpoint is created␊ - */␊ - groupId?: string␊ - /**␊ - * The ARM resource ID of the resource to which the managed private endpoint is created␊ - */␊ - privateLinkResourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The connection state of a managed private endpoint␊ - */␊ - export interface ConnectionStateProperties {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DataFactory/factories/managedVirtualNetworks/managedPrivateEndpoints␊ - */␊ - export interface FactoriesManagedVirtualNetworksManagedPrivateEndpoints {␊ - apiVersion: "2018-06-01"␊ - /**␊ - * Managed private endpoint name␊ - */␊ - name: string␊ - /**␊ - * Properties of a managed private endpoint␊ - */␊ - properties: (ManagedPrivateEndpoint | string)␊ - type: "Microsoft.DataFactory/factories/managedVirtualNetworks/managedPrivateEndpoints"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventGrid/topics␊ - */␊ - export interface Topics {␊ - apiVersion: "2017-06-15-preview"␊ - /**␊ - * Location of the resource␊ - */␊ - location: string␊ - /**␊ - * Name of the topic␊ - */␊ - name: string␊ - /**␊ - * Properties of the Topic␊ - */␊ - properties: (TopicProperties1 | string)␊ - /**␊ - * Tags of the resource␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.EventGrid/topics"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Topic␊ - */␊ - export interface TopicProperties1 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventGrid/eventSubscriptions␊ - */␊ - export interface EventSubscriptions {␊ - apiVersion: "2017-06-15-preview"␊ - /**␊ - * Name of the event subscription to be created. Event subscription names must be between 3 and 64 characters in length and use alphanumeric letters only.␊ - */␊ - name: string␊ - /**␊ - * Properties of the Event Subscription␊ - */␊ - properties: (EventSubscriptionProperties | string)␊ - type: "Microsoft.EventGrid/eventSubscriptions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Event Subscription␊ - */␊ - export interface EventSubscriptionProperties {␊ - /**␊ - * Information about the destination for an event subscription␊ - */␊ - destination?: (EventSubscriptionDestination | string)␊ - /**␊ - * Filter for the Event Subscription␊ - */␊ - filter?: (EventSubscriptionFilter | string)␊ - /**␊ - * List of user defined labels.␊ - */␊ - labels?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the destination for an event subscription␊ - */␊ - export interface EventSubscriptionDestination {␊ - /**␊ - * Type of the endpoint for the event subscription destination.␊ - */␊ - endpointType?: ("WebHook" | string)␊ - /**␊ - * Properties of the event subscription destination␊ - */␊ - properties?: (EventSubscriptionDestinationProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the event subscription destination␊ - */␊ - export interface EventSubscriptionDestinationProperties {␊ - /**␊ - * The URL that represents the endpoint of the destination of an event subscription.␊ - */␊ - endpointUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Filter for the Event Subscription␊ - */␊ - export interface EventSubscriptionFilter {␊ - /**␊ - * A list of applicable event types that need to be part of the event subscription. ␍␊ - * If it is desired to subscribe to all event types, the string "all" needs to be specified as an element in this list.␊ - */␊ - includedEventTypes?: (string[] | string)␊ - /**␊ - * Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter ␍␊ - * should be compared in a case sensitive manner.␊ - */␊ - isSubjectCaseSensitive?: (boolean | string)␊ - /**␊ - * An optional string to filter events for an event subscription based on a resource path prefix.␍␊ - * The format of this depends on the publisher of the events. ␍␊ - * Wildcard characters are not supported in this path.␊ - */␊ - subjectBeginsWith?: string␊ - /**␊ - * An optional string to filter events for an event subscription based on a resource path suffix.␍␊ - * Wildcard characters are not supported in this path.␊ - */␊ - subjectEndsWith?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventGrid/topics␊ - */␊ - export interface Topics1 {␊ - apiVersion: "2017-09-15-preview"␊ - /**␊ - * Location of the resource␊ - */␊ - location: string␊ - /**␊ - * Name of the topic␊ - */␊ - name: string␊ - /**␊ - * Properties of the Topic␊ - */␊ - properties: (TopicProperties2 | string)␊ - /**␊ - * Tags of the resource␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.EventGrid/topics"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Topic␊ - */␊ - export interface TopicProperties2 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventGrid/eventSubscriptions␊ - */␊ - export interface EventSubscriptions1 {␊ - apiVersion: "2017-09-15-preview"␊ - /**␊ - * Name of the event subscription to be created. Event subscription names must be between 3 and 64 characters in length and use alphanumeric letters only.␊ - */␊ - name: string␊ - /**␊ - * Properties of the Event Subscription␊ - */␊ - properties: (EventSubscriptionProperties1 | string)␊ - type: "Microsoft.EventGrid/eventSubscriptions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Event Subscription␊ - */␊ - export interface EventSubscriptionProperties1 {␊ - /**␊ - * Information about the destination for an event subscription␊ - */␊ - destination?: (EventSubscriptionDestination1 | string)␊ - /**␊ - * Filter for the Event Subscription␊ - */␊ - filter?: (EventSubscriptionFilter1 | string)␊ - /**␊ - * List of user defined labels.␊ - */␊ - labels?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the webhook destination for an event subscription␊ - */␊ - export interface WebHookEventSubscriptionDestination {␊ - endpointType: "WebHook"␊ - /**␊ - * Information about the webhook destination properties for an event subscription␊ - */␊ - properties?: (WebHookEventSubscriptionDestinationProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the webhook destination properties for an event subscription␊ - */␊ - export interface WebHookEventSubscriptionDestinationProperties {␊ - /**␊ - * The URL that represents the endpoint of the destination of an event subscription.␊ - */␊ - endpointUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the event hub destination for an event subscription␊ - */␊ - export interface EventHubEventSubscriptionDestination {␊ - endpointType: "EventHub"␊ - /**␊ - * The properties for a event hub destination.␊ - */␊ - properties?: (EventHubEventSubscriptionDestinationProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties for a event hub destination.␊ - */␊ - export interface EventHubEventSubscriptionDestinationProperties {␊ - /**␊ - * The Azure Resource Id that represents the endpoint of an Event Hub destination of an event subscription.␊ - */␊ - resourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Filter for the Event Subscription␊ - */␊ - export interface EventSubscriptionFilter1 {␊ - /**␊ - * A list of applicable event types that need to be part of the event subscription. ␍␊ - * If it is desired to subscribe to all event types, the string "all" needs to be specified as an element in this list.␊ - */␊ - includedEventTypes?: (string[] | string)␊ - /**␊ - * Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter ␍␊ - * should be compared in a case sensitive manner.␊ - */␊ - isSubjectCaseSensitive?: (boolean | string)␊ - /**␊ - * An optional string to filter events for an event subscription based on a resource path prefix.␍␊ - * The format of this depends on the publisher of the events. ␍␊ - * Wildcard characters are not supported in this path.␊ - */␊ - subjectBeginsWith?: string␊ - /**␊ - * An optional string to filter events for an event subscription based on a resource path suffix.␍␊ - * Wildcard characters are not supported in this path.␊ - */␊ - subjectEndsWith?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventGrid/topics␊ - */␊ - export interface Topics2 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Location of the resource␊ - */␊ - location: string␊ - /**␊ - * Name of the topic␊ - */␊ - name: string␊ - /**␊ - * Properties of the Topic␊ - */␊ - properties: (TopicProperties3 | string)␊ - /**␊ - * Tags of the resource␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.EventGrid/topics"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Topic␊ - */␊ - export interface TopicProperties3 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventGrid/eventSubscriptions␊ - */␊ - export interface EventSubscriptions2 {␊ - apiVersion: "2018-01-01"␊ - /**␊ - * Name of the event subscription. Event subscription names must be between 3 and 64 characters in length and should use alphanumeric letters only.␊ - */␊ - name: string␊ - /**␊ - * Properties of the Event Subscription␊ - */␊ - properties: (EventSubscriptionProperties2 | string)␊ - type: "Microsoft.EventGrid/eventSubscriptions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Event Subscription␊ - */␊ - export interface EventSubscriptionProperties2 {␊ - /**␊ - * Information about the destination for an event subscription␊ - */␊ - destination?: (EventSubscriptionDestination2 | string)␊ - /**␊ - * Filter for the Event Subscription␊ - */␊ - filter?: (EventSubscriptionFilter2 | string)␊ - /**␊ - * List of user defined labels.␊ - */␊ - labels?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the webhook destination for an event subscription␊ - */␊ - export interface WebHookEventSubscriptionDestination1 {␊ - endpointType: "WebHook"␊ - /**␊ - * Information about the webhook destination properties for an event subscription.␊ - */␊ - properties?: (WebHookEventSubscriptionDestinationProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the webhook destination properties for an event subscription.␊ - */␊ - export interface WebHookEventSubscriptionDestinationProperties1 {␊ - /**␊ - * The URL that represents the endpoint of the destination of an event subscription.␊ - */␊ - endpointUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the event hub destination for an event subscription␊ - */␊ - export interface EventHubEventSubscriptionDestination1 {␊ - endpointType: "EventHub"␊ - /**␊ - * The properties for a event hub destination.␊ - */␊ - properties?: (EventHubEventSubscriptionDestinationProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties for a event hub destination.␊ - */␊ - export interface EventHubEventSubscriptionDestinationProperties1 {␊ - /**␊ - * The Azure Resource Id that represents the endpoint of an Event Hub destination of an event subscription.␊ - */␊ - resourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Filter for the Event Subscription␊ - */␊ - export interface EventSubscriptionFilter2 {␊ - /**␊ - * A list of applicable event types that need to be part of the event subscription. ␍␊ - * If it is desired to subscribe to all event types, the string "all" needs to be specified as an element in this list.␊ - */␊ - includedEventTypes?: (string[] | string)␊ - /**␊ - * Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter ␍␊ - * should be compared in a case sensitive manner.␊ - */␊ - isSubjectCaseSensitive?: (boolean | string)␊ - /**␊ - * An optional string to filter events for an event subscription based on a resource path prefix.␍␊ - * The format of this depends on the publisher of the events. ␍␊ - * Wildcard characters are not supported in this path.␊ - */␊ - subjectBeginsWith?: string␊ - /**␊ - * An optional string to filter events for an event subscription based on a resource path suffix.␍␊ - * Wildcard characters are not supported in this path.␊ - */␊ - subjectEndsWith?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventGrid/topics␊ - */␊ - export interface Topics3 {␊ - apiVersion: "2018-05-01-preview"␊ - /**␊ - * Location of the resource␊ - */␊ - location: string␊ - /**␊ - * Name of the topic␊ - */␊ - name: string␊ - /**␊ - * Properties of the Topic␊ - */␊ - properties: (TopicProperties4 | string)␊ - /**␊ - * Tags of the resource␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.EventGrid/topics"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Topic␊ - */␊ - export interface TopicProperties4 {␊ - /**␊ - * This determines the format that Event Grid should expect for incoming events published to the topic.␊ - */␊ - inputSchema?: (("EventGridSchema" | "CustomEventSchema" | "CloudEventV01Schema") | string)␊ - /**␊ - * By default, Event Grid expects events to be in the Event Grid event schema. Specifying an input schema mapping enables publishing to Event Grid using a custom input schema. Currently, the only supported type of InputSchemaMapping is 'JsonInputSchemaMapping'.␊ - */␊ - inputSchemaMapping?: (InputSchemaMapping | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * This enables publishing to Event Grid using a custom input schema. This can be used to map properties from a custom input JSON schema to the Event Grid event schema.␊ - */␊ - export interface JsonInputSchemaMapping {␊ - inputSchemaMappingType: "Json"␊ - /**␊ - * This can be used to map properties of a source schema (or default values, for certain supported properties) to properties of the EventGridEvent schema.␊ - */␊ - properties?: (JsonInputSchemaMappingProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * This can be used to map properties of a source schema (or default values, for certain supported properties) to properties of the EventGridEvent schema.␊ - */␊ - export interface JsonInputSchemaMappingProperties {␊ - /**␊ - * This is used to express the source of an input schema mapping for a single target field in the Event Grid Event schema. This is currently used in the mappings for the 'subject','eventType' and 'dataVersion' properties. This represents a field in the input event schema along with a default value to be used, and at least one of these two properties should be provided.␊ - */␊ - dataVersion?: (JsonFieldWithDefault | string)␊ - /**␊ - * This is used to express the source of an input schema mapping for a single target field in the Event Grid Event schema. This is currently used in the mappings for the 'id','topic' and 'eventTime' properties. This represents a field in the input event schema.␊ - */␊ - eventTime?: (JsonField | string)␊ - /**␊ - * This is used to express the source of an input schema mapping for a single target field in the Event Grid Event schema. This is currently used in the mappings for the 'subject','eventType' and 'dataVersion' properties. This represents a field in the input event schema along with a default value to be used, and at least one of these two properties should be provided.␊ - */␊ - eventType?: (JsonFieldWithDefault | string)␊ - /**␊ - * This is used to express the source of an input schema mapping for a single target field in the Event Grid Event schema. This is currently used in the mappings for the 'id','topic' and 'eventTime' properties. This represents a field in the input event schema.␊ - */␊ - id?: (JsonField | string)␊ - /**␊ - * This is used to express the source of an input schema mapping for a single target field in the Event Grid Event schema. This is currently used in the mappings for the 'subject','eventType' and 'dataVersion' properties. This represents a field in the input event schema along with a default value to be used, and at least one of these two properties should be provided.␊ - */␊ - subject?: (JsonFieldWithDefault | string)␊ - /**␊ - * This is used to express the source of an input schema mapping for a single target field in the Event Grid Event schema. This is currently used in the mappings for the 'id','topic' and 'eventTime' properties. This represents a field in the input event schema.␊ - */␊ - topic?: (JsonField | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * This is used to express the source of an input schema mapping for a single target field in the Event Grid Event schema. This is currently used in the mappings for the 'subject','eventType' and 'dataVersion' properties. This represents a field in the input event schema along with a default value to be used, and at least one of these two properties should be provided.␊ - */␊ - export interface JsonFieldWithDefault {␊ - /**␊ - * The default value to be used for mapping when a SourceField is not provided or if there's no property with the specified name in the published JSON event payload.␊ - */␊ - defaultValue?: string␊ - /**␊ - * Name of a field in the input event schema that's to be used as the source of a mapping.␊ - */␊ - sourceField?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * This is used to express the source of an input schema mapping for a single target field in the Event Grid Event schema. This is currently used in the mappings for the 'id','topic' and 'eventTime' properties. This represents a field in the input event schema.␊ - */␊ - export interface JsonField {␊ - /**␊ - * Name of a field in the input event schema that's to be used as the source of a mapping.␊ - */␊ - sourceField?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventGrid/eventSubscriptions␊ - */␊ - export interface EventSubscriptions3 {␊ - apiVersion: "2018-05-01-preview"␊ - /**␊ - * Name of the event subscription. Event subscription names must be between 3 and 64 characters in length and should use alphanumeric letters only.␊ - */␊ - name: string␊ - /**␊ - * Properties of the Event Subscription␊ - */␊ - properties: (EventSubscriptionProperties3 | string)␊ - type: "Microsoft.EventGrid/eventSubscriptions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Event Subscription␊ - */␊ - export interface EventSubscriptionProperties3 {␊ - /**␊ - * Information about the dead letter destination for an event subscription. To configure a deadletter destination, do not directly instantiate an object of this class. Instead, instantiate an object of a derived class. Currently, StorageBlobDeadLetterDestination is the only class that derives from this class.␊ - */␊ - deadLetterDestination?: (DeadLetterDestination | string)␊ - /**␊ - * Information about the destination for an event subscription␊ - */␊ - destination?: (EventSubscriptionDestination3 | string)␊ - /**␊ - * The event delivery schema for the event subscription.␊ - */␊ - eventDeliverySchema?: (("EventGridSchema" | "InputEventSchema" | "CloudEventV01Schema") | string)␊ - /**␊ - * Filter for the Event Subscription␊ - */␊ - filter?: (EventSubscriptionFilter3 | string)␊ - /**␊ - * List of user defined labels.␊ - */␊ - labels?: (string[] | string)␊ - /**␊ - * Information about the retry policy for an event subscription␊ - */␊ - retryPolicy?: (RetryPolicy3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the storage blob based dead letter destination.␊ - */␊ - export interface StorageBlobDeadLetterDestination {␊ - endpointType: "StorageBlob"␊ - /**␊ - * Properties of the storage blob based dead letter destination.␊ - */␊ - properties?: (StorageBlobDeadLetterDestinationProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the storage blob based dead letter destination.␊ - */␊ - export interface StorageBlobDeadLetterDestinationProperties {␊ - /**␊ - * The name of the Storage blob container that is the destination of the deadletter events␊ - */␊ - blobContainerName?: string␊ - /**␊ - * The Azure Resource ID of the storage account that is the destination of the deadletter events␊ - */␊ - resourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the webhook destination for an event subscription␊ - */␊ - export interface WebHookEventSubscriptionDestination2 {␊ - endpointType: "WebHook"␊ - /**␊ - * Information about the webhook destination properties for an event subscription.␊ - */␊ - properties?: (WebHookEventSubscriptionDestinationProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the webhook destination properties for an event subscription.␊ - */␊ - export interface WebHookEventSubscriptionDestinationProperties2 {␊ - /**␊ - * The URL that represents the endpoint of the destination of an event subscription.␊ - */␊ - endpointUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the event hub destination for an event subscription␊ - */␊ - export interface EventHubEventSubscriptionDestination2 {␊ - endpointType: "EventHub"␊ - /**␊ - * The properties for a event hub destination.␊ - */␊ - properties?: (EventHubEventSubscriptionDestinationProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties for a event hub destination.␊ - */␊ - export interface EventHubEventSubscriptionDestinationProperties2 {␊ - /**␊ - * The Azure Resource Id that represents the endpoint of an Event Hub destination of an event subscription.␊ - */␊ - resourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the storage queue destination for an event subscription.␊ - */␊ - export interface StorageQueueEventSubscriptionDestination {␊ - endpointType: "StorageQueue"␊ - /**␊ - * The properties for a storage queue destination.␊ - */␊ - properties?: (StorageQueueEventSubscriptionDestinationProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties for a storage queue destination.␊ - */␊ - export interface StorageQueueEventSubscriptionDestinationProperties {␊ - /**␊ - * The name of the Storage queue under a storage account that is the destination of an event subscription.␊ - */␊ - queueName?: string␊ - /**␊ - * The Azure Resource ID of the storage account that contains the queue that is the destination of an event subscription.␊ - */␊ - resourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the HybridConnection destination for an event subscription.␊ - */␊ - export interface HybridConnectionEventSubscriptionDestination {␊ - endpointType: "HybridConnection"␊ - /**␊ - * The properties for a hybrid connection destination.␊ - */␊ - properties?: (HybridConnectionEventSubscriptionDestinationProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties for a hybrid connection destination.␊ - */␊ - export interface HybridConnectionEventSubscriptionDestinationProperties {␊ - /**␊ - * The Azure Resource ID of an hybrid connection that is the destination of an event subscription.␊ - */␊ - resourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Filter for the Event Subscription␊ - */␊ - export interface EventSubscriptionFilter3 {␊ - /**␊ - * A list of applicable event types that need to be part of the event subscription. ␍␊ - * If it is desired to subscribe to all event types, the string "all" needs to be specified as an element in this list.␊ - */␊ - includedEventTypes?: (string[] | string)␊ - /**␊ - * Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter ␍␊ - * should be compared in a case sensitive manner.␊ - */␊ - isSubjectCaseSensitive?: (boolean | string)␊ - /**␊ - * An optional string to filter events for an event subscription based on a resource path prefix.␍␊ - * The format of this depends on the publisher of the events. ␍␊ - * Wildcard characters are not supported in this path.␊ - */␊ - subjectBeginsWith?: string␊ - /**␊ - * An optional string to filter events for an event subscription based on a resource path suffix.␍␊ - * Wildcard characters are not supported in this path.␊ - */␊ - subjectEndsWith?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the retry policy for an event subscription␊ - */␊ - export interface RetryPolicy3 {␊ - /**␊ - * Time To Live (in minutes) for events.␊ - */␊ - eventTimeToLiveInMinutes?: (number | string)␊ - /**␊ - * Maximum number of delivery retry attempts for events.␊ - */␊ - maxDeliveryAttempts?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventGrid/domains␊ - */␊ - export interface Domains {␊ - apiVersion: "2018-09-15-preview"␊ - /**␊ - * Location of the resource␊ - */␊ - location: string␊ - /**␊ - * Name of the domain␊ - */␊ - name: string␊ - /**␊ - * Properties of the Domain␊ - */␊ - properties: (DomainProperties | string)␊ - /**␊ - * Tags of the resource␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.EventGrid/domains"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Domain␊ - */␊ - export interface DomainProperties {␊ - /**␊ - * This determines the format that Event Grid should expect for incoming events published to the domain.␊ - */␊ - inputSchema?: (("EventGridSchema" | "CustomEventSchema" | "CloudEventV01Schema") | string)␊ - /**␊ - * By default, Event Grid expects events to be in the Event Grid event schema. Specifying an input schema mapping enables publishing to Event Grid using a custom input schema. Currently, the only supported type of InputSchemaMapping is 'JsonInputSchemaMapping'.␊ - */␊ - inputSchemaMapping?: (InputSchemaMapping1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * This enables publishing to Event Grid using a custom input schema. This can be used to map properties from a custom input JSON schema to the Event Grid event schema.␊ - */␊ - export interface JsonInputSchemaMapping1 {␊ - inputSchemaMappingType: "Json"␊ - /**␊ - * This can be used to map properties of a source schema (or default values, for certain supported properties) to properties of the EventGridEvent schema.␊ - */␊ - properties?: (JsonInputSchemaMappingProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * This can be used to map properties of a source schema (or default values, for certain supported properties) to properties of the EventGridEvent schema.␊ - */␊ - export interface JsonInputSchemaMappingProperties1 {␊ - /**␊ - * This is used to express the source of an input schema mapping for a single target field in the Event Grid Event schema. This is currently used in the mappings for the 'subject','eventType' and 'dataVersion' properties. This represents a field in the input event schema along with a default value to be used, and at least one of these two properties should be provided.␊ - */␊ - dataVersion?: (JsonFieldWithDefault1 | string)␊ - /**␊ - * This is used to express the source of an input schema mapping for a single target field in the Event Grid Event schema. This is currently used in the mappings for the 'id','topic' and 'eventTime' properties. This represents a field in the input event schema.␊ - */␊ - eventTime?: (JsonField1 | string)␊ - /**␊ - * This is used to express the source of an input schema mapping for a single target field in the Event Grid Event schema. This is currently used in the mappings for the 'subject','eventType' and 'dataVersion' properties. This represents a field in the input event schema along with a default value to be used, and at least one of these two properties should be provided.␊ - */␊ - eventType?: (JsonFieldWithDefault1 | string)␊ - /**␊ - * This is used to express the source of an input schema mapping for a single target field in the Event Grid Event schema. This is currently used in the mappings for the 'id','topic' and 'eventTime' properties. This represents a field in the input event schema.␊ - */␊ - id?: (JsonField1 | string)␊ - /**␊ - * This is used to express the source of an input schema mapping for a single target field in the Event Grid Event schema. This is currently used in the mappings for the 'subject','eventType' and 'dataVersion' properties. This represents a field in the input event schema along with a default value to be used, and at least one of these two properties should be provided.␊ - */␊ - subject?: (JsonFieldWithDefault1 | string)␊ - /**␊ - * This is used to express the source of an input schema mapping for a single target field in the Event Grid Event schema. This is currently used in the mappings for the 'id','topic' and 'eventTime' properties. This represents a field in the input event schema.␊ - */␊ - topic?: (JsonField1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * This is used to express the source of an input schema mapping for a single target field in the Event Grid Event schema. This is currently used in the mappings for the 'subject','eventType' and 'dataVersion' properties. This represents a field in the input event schema along with a default value to be used, and at least one of these two properties should be provided.␊ - */␊ - export interface JsonFieldWithDefault1 {␊ - /**␊ - * The default value to be used for mapping when a SourceField is not provided or if there's no property with the specified name in the published JSON event payload.␊ - */␊ - defaultValue?: string␊ - /**␊ - * Name of a field in the input event schema that's to be used as the source of a mapping.␊ - */␊ - sourceField?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * This is used to express the source of an input schema mapping for a single target field in the Event Grid Event schema. This is currently used in the mappings for the 'id','topic' and 'eventTime' properties. This represents a field in the input event schema.␊ - */␊ - export interface JsonField1 {␊ - /**␊ - * Name of a field in the input event schema that's to be used as the source of a mapping.␊ - */␊ - sourceField?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventGrid/topics␊ - */␊ - export interface Topics4 {␊ - apiVersion: "2018-09-15-preview"␊ - /**␊ - * Location of the resource␊ - */␊ - location: string␊ - /**␊ - * Name of the topic␊ - */␊ - name: string␊ - /**␊ - * Properties of the Topic␊ - */␊ - properties: (TopicProperties5 | string)␊ - /**␊ - * Tags of the resource␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.EventGrid/topics"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Topic␊ - */␊ - export interface TopicProperties5 {␊ - /**␊ - * This determines the format that Event Grid should expect for incoming events published to the topic.␊ - */␊ - inputSchema?: (("EventGridSchema" | "CustomEventSchema" | "CloudEventV01Schema") | string)␊ - /**␊ - * By default, Event Grid expects events to be in the Event Grid event schema. Specifying an input schema mapping enables publishing to Event Grid using a custom input schema. Currently, the only supported type of InputSchemaMapping is 'JsonInputSchemaMapping'.␊ - */␊ - inputSchemaMapping?: (JsonInputSchemaMapping1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventGrid/eventSubscriptions␊ - */␊ - export interface EventSubscriptions4 {␊ - apiVersion: "2018-09-15-preview"␊ - /**␊ - * Name of the event subscription. Event subscription names must be between 3 and 64 characters in length and should use alphanumeric letters only.␊ - */␊ - name: string␊ - /**␊ - * Properties of the Event Subscription␊ - */␊ - properties: (EventSubscriptionProperties4 | string)␊ - type: "Microsoft.EventGrid/eventSubscriptions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Event Subscription␊ - */␊ - export interface EventSubscriptionProperties4 {␊ - /**␊ - * Information about the dead letter destination for an event subscription. To configure a deadletter destination, do not directly instantiate an object of this class. Instead, instantiate an object of a derived class. Currently, StorageBlobDeadLetterDestination is the only class that derives from this class.␊ - */␊ - deadLetterDestination?: (DeadLetterDestination1 | string)␊ - /**␊ - * Information about the destination for an event subscription␊ - */␊ - destination?: (EventSubscriptionDestination4 | string)␊ - /**␊ - * The event delivery schema for the event subscription.␊ - */␊ - eventDeliverySchema?: (("EventGridSchema" | "CloudEventV01Schema" | "CustomInputSchema") | string)␊ - /**␊ - * Expiration time of the event subscription.␊ - */␊ - expirationTimeUtc?: string␊ - /**␊ - * Filter for the Event Subscription␊ - */␊ - filter?: (EventSubscriptionFilter4 | string)␊ - /**␊ - * List of user defined labels.␊ - */␊ - labels?: (string[] | string)␊ - /**␊ - * Information about the retry policy for an event subscription␊ - */␊ - retryPolicy?: (RetryPolicy4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the storage blob based dead letter destination.␊ - */␊ - export interface StorageBlobDeadLetterDestination1 {␊ - endpointType: "StorageBlob"␊ - /**␊ - * Properties of the storage blob based dead letter destination.␊ - */␊ - properties?: (StorageBlobDeadLetterDestinationProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the storage blob based dead letter destination.␊ - */␊ - export interface StorageBlobDeadLetterDestinationProperties1 {␊ - /**␊ - * The name of the Storage blob container that is the destination of the deadletter events␊ - */␊ - blobContainerName?: string␊ - /**␊ - * The Azure Resource ID of the storage account that is the destination of the deadletter events␊ - */␊ - resourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the webhook destination for an event subscription␊ - */␊ - export interface WebHookEventSubscriptionDestination3 {␊ - endpointType: "WebHook"␊ - /**␊ - * Information about the webhook destination properties for an event subscription.␊ - */␊ - properties?: (WebHookEventSubscriptionDestinationProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the webhook destination properties for an event subscription.␊ - */␊ - export interface WebHookEventSubscriptionDestinationProperties3 {␊ - /**␊ - * The URL that represents the endpoint of the destination of an event subscription.␊ - */␊ - endpointUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the event hub destination for an event subscription␊ - */␊ - export interface EventHubEventSubscriptionDestination3 {␊ - endpointType: "EventHub"␊ - /**␊ - * The properties for a event hub destination.␊ - */␊ - properties?: (EventHubEventSubscriptionDestinationProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties for a event hub destination.␊ - */␊ - export interface EventHubEventSubscriptionDestinationProperties3 {␊ - /**␊ - * The Azure Resource Id that represents the endpoint of an Event Hub destination of an event subscription.␊ - */␊ - resourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the storage queue destination for an event subscription.␊ - */␊ - export interface StorageQueueEventSubscriptionDestination1 {␊ - endpointType: "StorageQueue"␊ - /**␊ - * The properties for a storage queue destination.␊ - */␊ - properties?: (StorageQueueEventSubscriptionDestinationProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties for a storage queue destination.␊ - */␊ - export interface StorageQueueEventSubscriptionDestinationProperties1 {␊ - /**␊ - * The name of the Storage queue under a storage account that is the destination of an event subscription.␊ - */␊ - queueName?: string␊ - /**␊ - * The Azure Resource ID of the storage account that contains the queue that is the destination of an event subscription.␊ - */␊ - resourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the HybridConnection destination for an event subscription.␊ - */␊ - export interface HybridConnectionEventSubscriptionDestination1 {␊ - endpointType: "HybridConnection"␊ - /**␊ - * The properties for a hybrid connection destination.␊ - */␊ - properties?: (HybridConnectionEventSubscriptionDestinationProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties for a hybrid connection destination.␊ - */␊ - export interface HybridConnectionEventSubscriptionDestinationProperties1 {␊ - /**␊ - * The Azure Resource ID of an hybrid connection that is the destination of an event subscription.␊ - */␊ - resourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Filter for the Event Subscription␊ - */␊ - export interface EventSubscriptionFilter4 {␊ - /**␊ - * A list of advanced filters.␊ - */␊ - advancedFilters?: (AdvancedFilter[] | string)␊ - /**␊ - * A list of applicable event types that need to be part of the event subscription. ␍␊ - * If it is desired to subscribe to all event types, the string "all" needs to be specified as an element in this list.␊ - */␊ - includedEventTypes?: (string[] | string)␊ - /**␊ - * Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter ␍␊ - * should be compared in a case sensitive manner.␊ - */␊ - isSubjectCaseSensitive?: (boolean | string)␊ - /**␊ - * An optional string to filter events for an event subscription based on a resource path prefix.␍␊ - * The format of this depends on the publisher of the events. ␍␊ - * Wildcard characters are not supported in this path.␊ - */␊ - subjectBeginsWith?: string␊ - /**␊ - * An optional string to filter events for an event subscription based on a resource path suffix.␍␊ - * Wildcard characters are not supported in this path.␊ - */␊ - subjectEndsWith?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NumberIn filter␊ - */␊ - export interface NumberInAdvancedFilter {␊ - operatorType: "NumberIn"␊ - /**␊ - * The set of filter values␊ - */␊ - values?: (number[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NumberNotIn Filter␊ - */␊ - export interface NumberNotInAdvancedFilter {␊ - operatorType: "NumberNotIn"␊ - /**␊ - * The set of filter values␊ - */␊ - values?: (number[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NumberLessThan Filter␊ - */␊ - export interface NumberLessThanAdvancedFilter {␊ - operatorType: "NumberLessThan"␊ - /**␊ - * The filter value␊ - */␊ - value?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NumberGreaterThan Filter␊ - */␊ - export interface NumberGreaterThanAdvancedFilter {␊ - operatorType: "NumberGreaterThan"␊ - /**␊ - * The filter value␊ - */␊ - value?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NumberLessThanOrEquals Filter␊ - */␊ - export interface NumberLessThanOrEqualsAdvancedFilter {␊ - operatorType: "NumberLessThanOrEquals"␊ - /**␊ - * The filter value␊ - */␊ - value?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NumberGreaterThanOrEquals Filter␊ - */␊ - export interface NumberGreaterThanOrEqualsAdvancedFilter {␊ - operatorType: "NumberGreaterThanOrEquals"␊ - /**␊ - * The filter value␊ - */␊ - value?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * BoolEquals Filter␊ - */␊ - export interface BoolEqualsAdvancedFilter {␊ - operatorType: "BoolEquals"␊ - /**␊ - * The filter value␊ - */␊ - value?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * StringIn Filter␊ - */␊ - export interface StringInAdvancedFilter {␊ - operatorType: "StringIn"␊ - /**␊ - * The set of filter values␊ - */␊ - values?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * StringNotIn Filter␊ - */␊ - export interface StringNotInAdvancedFilter {␊ - operatorType: "StringNotIn"␊ - /**␊ - * The set of filter values␊ - */␊ - values?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * StringBeginsWith Filter␊ - */␊ - export interface StringBeginsWithAdvancedFilter {␊ - operatorType: "StringBeginsWith"␊ - /**␊ - * The set of filter values␊ - */␊ - values?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * StringEndsWith Filter␊ - */␊ - export interface StringEndsWithAdvancedFilter {␊ - operatorType: "StringEndsWith"␊ - /**␊ - * The set of filter values␊ - */␊ - values?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * StringContains Filter␊ - */␊ - export interface StringContainsAdvancedFilter {␊ - operatorType: "StringContains"␊ - /**␊ - * The set of filter values␊ - */␊ - values?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the retry policy for an event subscription␊ - */␊ - export interface RetryPolicy4 {␊ - /**␊ - * Time To Live (in minutes) for events.␊ - */␊ - eventTimeToLiveInMinutes?: (number | string)␊ - /**␊ - * Maximum number of delivery retry attempts for events.␊ - */␊ - maxDeliveryAttempts?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventGrid/topics␊ - */␊ - export interface Topics5 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Location of the resource␊ - */␊ - location: string␊ - /**␊ - * Name of the topic␊ - */␊ - name: string␊ - /**␊ - * Properties of the Topic␊ - */␊ - properties: (TopicProperties6 | string)␊ - /**␊ - * Tags of the resource␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.EventGrid/topics"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Topic␊ - */␊ - export interface TopicProperties6 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventGrid/eventSubscriptions␊ - */␊ - export interface EventSubscriptions5 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Name of the event subscription. Event subscription names must be between 3 and 64 characters in length and should use alphanumeric letters only.␊ - */␊ - name: string␊ - /**␊ - * Properties of the Event Subscription␊ - */␊ - properties: (EventSubscriptionProperties5 | string)␊ - type: "Microsoft.EventGrid/eventSubscriptions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Event Subscription␊ - */␊ - export interface EventSubscriptionProperties5 {␊ - /**␊ - * Information about the dead letter destination for an event subscription. To configure a deadletter destination, do not directly instantiate an object of this class. Instead, instantiate an object of a derived class. Currently, StorageBlobDeadLetterDestination is the only class that derives from this class.␊ - */␊ - deadLetterDestination?: (DeadLetterDestination2 | string)␊ - /**␊ - * Information about the destination for an event subscription␊ - */␊ - destination?: (EventSubscriptionDestination5 | string)␊ - /**␊ - * Filter for the Event Subscription␊ - */␊ - filter?: (EventSubscriptionFilter5 | string)␊ - /**␊ - * List of user defined labels.␊ - */␊ - labels?: (string[] | string)␊ - /**␊ - * Information about the retry policy for an event subscription␊ - */␊ - retryPolicy?: (RetryPolicy5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the storage blob based dead letter destination.␊ - */␊ - export interface StorageBlobDeadLetterDestination2 {␊ - endpointType: "StorageBlob"␊ - /**␊ - * Properties of the storage blob based dead letter destination.␊ - */␊ - properties?: (StorageBlobDeadLetterDestinationProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the storage blob based dead letter destination.␊ - */␊ - export interface StorageBlobDeadLetterDestinationProperties2 {␊ - /**␊ - * The name of the Storage blob container that is the destination of the deadletter events␊ - */␊ - blobContainerName?: string␊ - /**␊ - * The Azure Resource ID of the storage account that is the destination of the deadletter events. For example: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/microsoft.Storage/storageAccounts/{StorageAccountName}␊ - */␊ - resourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the webhook destination for an event subscription␊ - */␊ - export interface WebHookEventSubscriptionDestination4 {␊ - endpointType: "WebHook"␊ - /**␊ - * Information about the webhook destination properties for an event subscription.␊ - */␊ - properties?: (WebHookEventSubscriptionDestinationProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the webhook destination properties for an event subscription.␊ - */␊ - export interface WebHookEventSubscriptionDestinationProperties4 {␊ - /**␊ - * The URL that represents the endpoint of the destination of an event subscription.␊ - */␊ - endpointUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the event hub destination for an event subscription␊ - */␊ - export interface EventHubEventSubscriptionDestination4 {␊ - endpointType: "EventHub"␊ - /**␊ - * The properties for a event hub destination.␊ - */␊ - properties?: (EventHubEventSubscriptionDestinationProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties for a event hub destination.␊ - */␊ - export interface EventHubEventSubscriptionDestinationProperties4 {␊ - /**␊ - * The Azure Resource Id that represents the endpoint of an Event Hub destination of an event subscription.␊ - */␊ - resourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the storage queue destination for an event subscription.␊ - */␊ - export interface StorageQueueEventSubscriptionDestination2 {␊ - endpointType: "StorageQueue"␊ - /**␊ - * The properties for a storage queue destination.␊ - */␊ - properties?: (StorageQueueEventSubscriptionDestinationProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties for a storage queue destination.␊ - */␊ - export interface StorageQueueEventSubscriptionDestinationProperties2 {␊ - /**␊ - * The name of the Storage queue under a storage account that is the destination of an event subscription.␊ - */␊ - queueName?: string␊ - /**␊ - * The Azure Resource ID of the storage account that contains the queue that is the destination of an event subscription.␊ - */␊ - resourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the HybridConnection destination for an event subscription.␊ - */␊ - export interface HybridConnectionEventSubscriptionDestination2 {␊ - endpointType: "HybridConnection"␊ - /**␊ - * The properties for a hybrid connection destination.␊ - */␊ - properties?: (HybridConnectionEventSubscriptionDestinationProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties for a hybrid connection destination.␊ - */␊ - export interface HybridConnectionEventSubscriptionDestinationProperties2 {␊ - /**␊ - * The Azure Resource ID of an hybrid connection that is the destination of an event subscription.␊ - */␊ - resourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Filter for the Event Subscription␊ - */␊ - export interface EventSubscriptionFilter5 {␊ - /**␊ - * A list of applicable event types that need to be part of the event subscription. ␍␊ - * If it is desired to subscribe to all event types, the string "all" needs to be specified as an element in this list.␊ - */␊ - includedEventTypes?: (string[] | string)␊ - /**␊ - * Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter ␍␊ - * should be compared in a case sensitive manner.␊ - */␊ - isSubjectCaseSensitive?: (boolean | string)␊ - /**␊ - * An optional string to filter events for an event subscription based on a resource path prefix.␍␊ - * The format of this depends on the publisher of the events. ␍␊ - * Wildcard characters are not supported in this path.␊ - */␊ - subjectBeginsWith?: string␊ - /**␊ - * An optional string to filter events for an event subscription based on a resource path suffix.␍␊ - * Wildcard characters are not supported in this path.␊ - */␊ - subjectEndsWith?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the retry policy for an event subscription␊ - */␊ - export interface RetryPolicy5 {␊ - /**␊ - * Time To Live (in minutes) for events.␊ - */␊ - eventTimeToLiveInMinutes?: (number | string)␊ - /**␊ - * Maximum number of delivery retry attempts for events.␊ - */␊ - maxDeliveryAttempts?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventGrid/domains␊ - */␊ - export interface Domains1 {␊ - apiVersion: "2019-02-01-preview"␊ - /**␊ - * Location of the resource␊ - */␊ - location: string␊ - /**␊ - * Name of the domain␊ - */␊ - name: string␊ - /**␊ - * Properties of the Domain␊ - */␊ - properties: (DomainProperties1 | string)␊ - resources?: DomainsTopicsChildResource[]␊ - /**␊ - * Tags of the resource␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.EventGrid/domains"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Domain␊ - */␊ - export interface DomainProperties1 {␊ - /**␊ - * This determines the format that Event Grid should expect for incoming events published to the domain.␊ - */␊ - inputSchema?: (("EventGridSchema" | "CustomEventSchema" | "CloudEventV01Schema") | string)␊ - /**␊ - * By default, Event Grid expects events to be in the Event Grid event schema. Specifying an input schema mapping enables publishing to Event Grid using a custom input schema. Currently, the only supported type of InputSchemaMapping is 'JsonInputSchemaMapping'.␊ - */␊ - inputSchemaMapping?: (InputSchemaMapping2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * This enables publishing to Event Grid using a custom input schema. This can be used to map properties from a custom input JSON schema to the Event Grid event schema.␊ - */␊ - export interface JsonInputSchemaMapping2 {␊ - inputSchemaMappingType: "Json"␊ - /**␊ - * This can be used to map properties of a source schema (or default values, for certain supported properties) to properties of the EventGridEvent schema.␊ - */␊ - properties?: (JsonInputSchemaMappingProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * This can be used to map properties of a source schema (or default values, for certain supported properties) to properties of the EventGridEvent schema.␊ - */␊ - export interface JsonInputSchemaMappingProperties2 {␊ - /**␊ - * This is used to express the source of an input schema mapping for a single target field␍␊ - * in the Event Grid Event schema. This is currently used in the mappings for the 'subject',␍␊ - * 'eventtype' and 'dataversion' properties. This represents a field in the input event schema␍␊ - * along with a default value to be used, and at least one of these two properties should be provided.␊ - */␊ - dataVersion?: (JsonFieldWithDefault2 | string)␊ - /**␊ - * This is used to express the source of an input schema mapping for a single target field in the Event Grid Event schema. This is currently used in the mappings for the 'id', 'topic' and 'eventtime' properties. This represents a field in the input event schema.␊ - */␊ - eventTime?: (JsonField2 | string)␊ - /**␊ - * This is used to express the source of an input schema mapping for a single target field␍␊ - * in the Event Grid Event schema. This is currently used in the mappings for the 'subject',␍␊ - * 'eventtype' and 'dataversion' properties. This represents a field in the input event schema␍␊ - * along with a default value to be used, and at least one of these two properties should be provided.␊ - */␊ - eventType?: (JsonFieldWithDefault2 | string)␊ - /**␊ - * This is used to express the source of an input schema mapping for a single target field in the Event Grid Event schema. This is currently used in the mappings for the 'id', 'topic' and 'eventtime' properties. This represents a field in the input event schema.␊ - */␊ - id?: (JsonField2 | string)␊ - /**␊ - * This is used to express the source of an input schema mapping for a single target field␍␊ - * in the Event Grid Event schema. This is currently used in the mappings for the 'subject',␍␊ - * 'eventtype' and 'dataversion' properties. This represents a field in the input event schema␍␊ - * along with a default value to be used, and at least one of these two properties should be provided.␊ - */␊ - subject?: (JsonFieldWithDefault2 | string)␊ - /**␊ - * This is used to express the source of an input schema mapping for a single target field in the Event Grid Event schema. This is currently used in the mappings for the 'id', 'topic' and 'eventtime' properties. This represents a field in the input event schema.␊ - */␊ - topic?: (JsonField2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * This is used to express the source of an input schema mapping for a single target field␍␊ - * in the Event Grid Event schema. This is currently used in the mappings for the 'subject',␍␊ - * 'eventtype' and 'dataversion' properties. This represents a field in the input event schema␍␊ - * along with a default value to be used, and at least one of these two properties should be provided.␊ - */␊ - export interface JsonFieldWithDefault2 {␊ - /**␊ - * The default value to be used for mapping when a SourceField is not provided or if there's no property with the specified name in the published JSON event payload.␊ - */␊ - defaultValue?: string␊ - /**␊ - * Name of a field in the input event schema that's to be used as the source of a mapping.␊ - */␊ - sourceField?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * This is used to express the source of an input schema mapping for a single target field in the Event Grid Event schema. This is currently used in the mappings for the 'id', 'topic' and 'eventtime' properties. This represents a field in the input event schema.␊ - */␊ - export interface JsonField2 {␊ - /**␊ - * Name of a field in the input event schema that's to be used as the source of a mapping.␊ - */␊ - sourceField?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventGrid/domains/topics␊ - */␊ - export interface DomainsTopicsChildResource {␊ - apiVersion: "2019-02-01-preview"␊ - /**␊ - * Name of the domain topic␊ - */␊ - name: string␊ - type: "topics"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventGrid/domains/topics␊ - */␊ - export interface DomainsTopics {␊ - apiVersion: "2019-02-01-preview"␊ - /**␊ - * Name of the domain topic␊ - */␊ - name: string␊ - type: "Microsoft.EventGrid/domains/topics"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventGrid/topics␊ - */␊ - export interface Topics6 {␊ - apiVersion: "2019-02-01-preview"␊ - /**␊ - * Location of the resource␊ - */␊ - location: string␊ - /**␊ - * Name of the topic␊ - */␊ - name: string␊ - /**␊ - * Properties of the Topic␊ - */␊ - properties: (TopicProperties7 | string)␊ - /**␊ - * Tags of the resource␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.EventGrid/topics"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Topic␊ - */␊ - export interface TopicProperties7 {␊ - /**␊ - * This determines the format that Event Grid should expect for incoming events published to the topic.␊ - */␊ - inputSchema?: (("EventGridSchema" | "CustomEventSchema" | "CloudEventV01Schema") | string)␊ - /**␊ - * By default, Event Grid expects events to be in the Event Grid event schema. Specifying an input schema mapping enables publishing to Event Grid using a custom input schema. Currently, the only supported type of InputSchemaMapping is 'JsonInputSchemaMapping'.␊ - */␊ - inputSchemaMapping?: (JsonInputSchemaMapping2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventGrid/eventSubscriptions␊ - */␊ - export interface EventSubscriptions6 {␊ - apiVersion: "2019-02-01-preview"␊ - /**␊ - * Name of the event subscription. Event subscription names must be between 3 and 64 characters in length and should use alphanumeric letters only.␊ - */␊ - name: string␊ - /**␊ - * Properties of the Event Subscription␊ - */␊ - properties: (EventSubscriptionProperties6 | string)␊ - type: "Microsoft.EventGrid/eventSubscriptions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Event Subscription␊ - */␊ - export interface EventSubscriptionProperties6 {␊ - /**␊ - * Information about the dead letter destination for an event subscription. To configure a deadletter destination, do not directly instantiate an object of this class. Instead, instantiate an object of a derived class. Currently, StorageBlobDeadLetterDestination is the only class that derives from this class.␊ - */␊ - deadLetterDestination?: (DeadLetterDestination3 | string)␊ - /**␊ - * Information about the destination for an event subscription␊ - */␊ - destination?: (EventSubscriptionDestination6 | string)␊ - /**␊ - * The event delivery schema for the event subscription.␊ - */␊ - eventDeliverySchema?: (("EventGridSchema" | "CloudEventV01Schema" | "CustomInputSchema") | string)␊ - /**␊ - * Expiration time of the event subscription.␊ - */␊ - expirationTimeUtc?: string␊ - /**␊ - * Filter for the Event Subscription␊ - */␊ - filter?: (EventSubscriptionFilter6 | string)␊ - /**␊ - * List of user defined labels.␊ - */␊ - labels?: (string[] | string)␊ - /**␊ - * Information about the retry policy for an event subscription␊ - */␊ - retryPolicy?: (RetryPolicy6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the storage blob based dead letter destination.␊ - */␊ - export interface StorageBlobDeadLetterDestination3 {␊ - endpointType: "StorageBlob"␊ - /**␊ - * Properties of the storage blob based dead letter destination.␊ - */␊ - properties?: (StorageBlobDeadLetterDestinationProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the storage blob based dead letter destination.␊ - */␊ - export interface StorageBlobDeadLetterDestinationProperties3 {␊ - /**␊ - * The name of the Storage blob container that is the destination of the deadletter events␊ - */␊ - blobContainerName?: string␊ - /**␊ - * The Azure Resource ID of the storage account that is the destination of the deadletter events␊ - */␊ - resourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the webhook destination for an event subscription␊ - */␊ - export interface WebHookEventSubscriptionDestination5 {␊ - endpointType: "WebHook"␊ - /**␊ - * Information about the webhook destination properties for an event subscription.␊ - */␊ - properties?: (WebHookEventSubscriptionDestinationProperties5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the webhook destination properties for an event subscription.␊ - */␊ - export interface WebHookEventSubscriptionDestinationProperties5 {␊ - /**␊ - * The URL that represents the endpoint of the destination of an event subscription.␊ - */␊ - endpointUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the event hub destination for an event subscription␊ - */␊ - export interface EventHubEventSubscriptionDestination5 {␊ - endpointType: "EventHub"␊ - /**␊ - * The properties for a event hub destination.␊ - */␊ - properties?: (EventHubEventSubscriptionDestinationProperties5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties for a event hub destination.␊ - */␊ - export interface EventHubEventSubscriptionDestinationProperties5 {␊ - /**␊ - * The Azure Resource Id that represents the endpoint of an Event Hub destination of an event subscription.␊ - */␊ - resourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the storage queue destination for an event subscription.␊ - */␊ - export interface StorageQueueEventSubscriptionDestination3 {␊ - endpointType: "StorageQueue"␊ - /**␊ - * The properties for a storage queue destination.␊ - */␊ - properties?: (StorageQueueEventSubscriptionDestinationProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties for a storage queue destination.␊ - */␊ - export interface StorageQueueEventSubscriptionDestinationProperties3 {␊ - /**␊ - * The name of the Storage queue under a storage account that is the destination of an event subscription.␊ - */␊ - queueName?: string␊ - /**␊ - * The Azure Resource ID of the storage account that contains the queue that is the destination of an event subscription.␊ - */␊ - resourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the HybridConnection destination for an event subscription.␊ - */␊ - export interface HybridConnectionEventSubscriptionDestination3 {␊ - endpointType: "HybridConnection"␊ - /**␊ - * The properties for a hybrid connection destination.␊ - */␊ - properties?: (HybridConnectionEventSubscriptionDestinationProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties for a hybrid connection destination.␊ - */␊ - export interface HybridConnectionEventSubscriptionDestinationProperties3 {␊ - /**␊ - * The Azure Resource ID of an hybrid connection that is the destination of an event subscription.␊ - */␊ - resourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the service bus destination for an event subscription␊ - */␊ - export interface ServiceBusQueueEventSubscriptionDestination {␊ - endpointType: "ServiceBusQueue"␊ - /**␊ - * The properties that represent the Service Bus destination of an event subscription.␊ - */␊ - properties?: (ServiceBusQueueEventSubscriptionDestinationProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties that represent the Service Bus destination of an event subscription.␊ - */␊ - export interface ServiceBusQueueEventSubscriptionDestinationProperties {␊ - /**␊ - * The Azure Resource Id that represents the endpoint of the Service Bus destination of an event subscription.␊ - */␊ - resourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Filter for the Event Subscription␊ - */␊ - export interface EventSubscriptionFilter6 {␊ - /**␊ - * An array of advanced filters that are used for filtering event subscriptions.␊ - */␊ - advancedFilters?: (AdvancedFilter1[] | string)␊ - /**␊ - * A list of applicable event types that need to be part of the event subscription. If it is desired to subscribe to all default event types, set the IncludedEventTypes to null.␊ - */␊ - includedEventTypes?: (string[] | string)␊ - /**␊ - * Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter ␍␊ - * should be compared in a case sensitive manner.␊ - */␊ - isSubjectCaseSensitive?: (boolean | string)␊ - /**␊ - * An optional string to filter events for an event subscription based on a resource path prefix.␍␊ - * The format of this depends on the publisher of the events. ␍␊ - * Wildcard characters are not supported in this path.␊ - */␊ - subjectBeginsWith?: string␊ - /**␊ - * An optional string to filter events for an event subscription based on a resource path suffix.␍␊ - * Wildcard characters are not supported in this path.␊ - */␊ - subjectEndsWith?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NumberIn Advanced Filter.␊ - */␊ - export interface NumberInAdvancedFilter1 {␊ - operatorType: "NumberIn"␊ - /**␊ - * The set of filter values.␊ - */␊ - values?: (number[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NumberNotIn Advanced Filter.␊ - */␊ - export interface NumberNotInAdvancedFilter1 {␊ - operatorType: "NumberNotIn"␊ - /**␊ - * The set of filter values.␊ - */␊ - values?: (number[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NumberLessThan Advanced Filter.␊ - */␊ - export interface NumberLessThanAdvancedFilter1 {␊ - operatorType: "NumberLessThan"␊ - /**␊ - * The filter value.␊ - */␊ - value?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NumberGreaterThan Advanced Filter.␊ - */␊ - export interface NumberGreaterThanAdvancedFilter1 {␊ - operatorType: "NumberGreaterThan"␊ - /**␊ - * The filter value.␊ - */␊ - value?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NumberLessThanOrEquals Advanced Filter.␊ - */␊ - export interface NumberLessThanOrEqualsAdvancedFilter1 {␊ - operatorType: "NumberLessThanOrEquals"␊ - /**␊ - * The filter value.␊ - */␊ - value?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NumberGreaterThanOrEquals Advanced Filter.␊ - */␊ - export interface NumberGreaterThanOrEqualsAdvancedFilter1 {␊ - operatorType: "NumberGreaterThanOrEquals"␊ - /**␊ - * The filter value.␊ - */␊ - value?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * BoolEquals Advanced Filter.␊ - */␊ - export interface BoolEqualsAdvancedFilter1 {␊ - operatorType: "BoolEquals"␊ - /**␊ - * The boolean filter value.␊ - */␊ - value?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * StringIn Advanced Filter.␊ - */␊ - export interface StringInAdvancedFilter1 {␊ - operatorType: "StringIn"␊ - /**␊ - * The set of filter values.␊ - */␊ - values?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * StringNotIn Advanced Filter.␊ - */␊ - export interface StringNotInAdvancedFilter1 {␊ - operatorType: "StringNotIn"␊ - /**␊ - * The set of filter values.␊ - */␊ - values?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * StringBeginsWith Advanced Filter.␊ - */␊ - export interface StringBeginsWithAdvancedFilter1 {␊ - operatorType: "StringBeginsWith"␊ - /**␊ - * The set of filter values.␊ - */␊ - values?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * StringEndsWith Advanced Filter.␊ - */␊ - export interface StringEndsWithAdvancedFilter1 {␊ - operatorType: "StringEndsWith"␊ - /**␊ - * The set of filter values.␊ - */␊ - values?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * StringContains Advanced Filter.␊ - */␊ - export interface StringContainsAdvancedFilter1 {␊ - operatorType: "StringContains"␊ - /**␊ - * The set of filter values.␊ - */␊ - values?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the retry policy for an event subscription␊ - */␊ - export interface RetryPolicy6 {␊ - /**␊ - * Time To Live (in minutes) for events.␊ - */␊ - eventTimeToLiveInMinutes?: (number | string)␊ - /**␊ - * Maximum number of delivery retry attempts for events.␊ - */␊ - maxDeliveryAttempts?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventGrid/domains␊ - */␊ - export interface Domains2 {␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Location of the resource.␊ - */␊ - location: string␊ - /**␊ - * Name of the domain.␊ - */␊ - name: string␊ - /**␊ - * Properties of the Domain.␊ - */␊ - properties: (DomainProperties2 | string)␊ - resources?: DomainsTopicsChildResource1[]␊ - /**␊ - * Tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.EventGrid/domains"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Domain.␊ - */␊ - export interface DomainProperties2 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventGrid/domains/topics␊ - */␊ - export interface DomainsTopicsChildResource1 {␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Name of the domain topic.␊ - */␊ - name: string␊ - type: "topics"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventGrid/domains/topics␊ - */␊ - export interface DomainsTopics1 {␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Name of the domain topic.␊ - */␊ - name: string␊ - type: "Microsoft.EventGrid/domains/topics"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventGrid/topics␊ - */␊ - export interface Topics7 {␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Location of the resource.␊ - */␊ - location: string␊ - /**␊ - * Name of the topic.␊ - */␊ - name: string␊ - /**␊ - * Properties of the Topic␊ - */␊ - properties: (TopicProperties8 | string)␊ - /**␊ - * Tags of the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.EventGrid/topics"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Topic␊ - */␊ - export interface TopicProperties8 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.EventGrid/eventSubscriptions␊ - */␊ - export interface EventSubscriptions7 {␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Name of the event subscription. Event subscription names must be between 3 and 64 characters in length and should use alphanumeric letters only.␊ - */␊ - name: string␊ - /**␊ - * Properties of the Event Subscription␊ - */␊ - properties: (EventSubscriptionProperties7 | string)␊ - type: "Microsoft.EventGrid/eventSubscriptions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Event Subscription␊ - */␊ - export interface EventSubscriptionProperties7 {␊ - /**␊ - * Information about the dead letter destination for an event subscription. To configure a deadletter destination, do not directly instantiate an object of this class. Instead, instantiate an object of a derived class. Currently, StorageBlobDeadLetterDestination is the only class that derives from this class.␊ - */␊ - deadLetterDestination?: (DeadLetterDestination4 | string)␊ - /**␊ - * Information about the destination for an event subscription␊ - */␊ - destination?: (EventSubscriptionDestination7 | string)␊ - /**␊ - * Expiration time of the event subscription.␊ - */␊ - expirationTimeUtc?: string␊ - /**␊ - * Filter for the Event Subscription.␊ - */␊ - filter?: (EventSubscriptionFilter7 | string)␊ - /**␊ - * List of user defined labels.␊ - */␊ - labels?: (string[] | string)␊ - /**␊ - * Information about the retry policy for an event subscription.␊ - */␊ - retryPolicy?: (RetryPolicy7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the storage blob based dead letter destination.␊ - */␊ - export interface StorageBlobDeadLetterDestination4 {␊ - endpointType: "StorageBlob"␊ - /**␊ - * Properties of the storage blob based dead letter destination.␊ - */␊ - properties?: (StorageBlobDeadLetterDestinationProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the storage blob based dead letter destination.␊ - */␊ - export interface StorageBlobDeadLetterDestinationProperties4 {␊ - /**␊ - * The name of the Storage blob container that is the destination of the deadletter events␊ - */␊ - blobContainerName?: string␊ - /**␊ - * The Azure Resource ID of the storage account that is the destination of the deadletter events␊ - */␊ - resourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the webhook destination for an event subscription␊ - */␊ - export interface WebHookEventSubscriptionDestination6 {␊ - endpointType: "WebHook"␊ - /**␊ - * Information about the webhook destination properties for an event subscription.␊ - */␊ - properties?: (WebHookEventSubscriptionDestinationProperties6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the webhook destination properties for an event subscription.␊ - */␊ - export interface WebHookEventSubscriptionDestinationProperties6 {␊ - /**␊ - * The URL that represents the endpoint of the destination of an event subscription.␊ - */␊ - endpointUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the event hub destination for an event subscription␊ - */␊ - export interface EventHubEventSubscriptionDestination6 {␊ - endpointType: "EventHub"␊ - /**␊ - * The properties for a event hub destination.␊ - */␊ - properties?: (EventHubEventSubscriptionDestinationProperties6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties for a event hub destination.␊ - */␊ - export interface EventHubEventSubscriptionDestinationProperties6 {␊ - /**␊ - * The Azure Resource Id that represents the endpoint of an Event Hub destination of an event subscription.␊ - */␊ - resourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the storage queue destination for an event subscription.␊ - */␊ - export interface StorageQueueEventSubscriptionDestination4 {␊ - endpointType: "StorageQueue"␊ - /**␊ - * The properties for a storage queue destination.␊ - */␊ - properties?: (StorageQueueEventSubscriptionDestinationProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties for a storage queue destination.␊ - */␊ - export interface StorageQueueEventSubscriptionDestinationProperties4 {␊ - /**␊ - * The name of the Storage queue under a storage account that is the destination of an event subscription.␊ - */␊ - queueName?: string␊ - /**␊ - * The Azure Resource ID of the storage account that contains the queue that is the destination of an event subscription.␊ - */␊ - resourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the HybridConnection destination for an event subscription.␊ - */␊ - export interface HybridConnectionEventSubscriptionDestination4 {␊ - endpointType: "HybridConnection"␊ - /**␊ - * The properties for a hybrid connection destination.␊ - */␊ - properties?: (HybridConnectionEventSubscriptionDestinationProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties for a hybrid connection destination.␊ - */␊ - export interface HybridConnectionEventSubscriptionDestinationProperties4 {␊ - /**␊ - * The Azure Resource ID of an hybrid connection that is the destination of an event subscription.␊ - */␊ - resourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the service bus destination for an event subscription␊ - */␊ - export interface ServiceBusQueueEventSubscriptionDestination1 {␊ - endpointType: "ServiceBusQueue"␊ - /**␊ - * The properties that represent the Service Bus destination of an event subscription.␊ - */␊ - properties?: (ServiceBusQueueEventSubscriptionDestinationProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties that represent the Service Bus destination of an event subscription.␊ - */␊ - export interface ServiceBusQueueEventSubscriptionDestinationProperties1 {␊ - /**␊ - * The Azure Resource Id that represents the endpoint of the Service Bus destination of an event subscription.␊ - */␊ - resourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Filter for the Event Subscription.␊ - */␊ - export interface EventSubscriptionFilter7 {␊ - /**␊ - * An array of advanced filters that are used for filtering event subscriptions.␊ - */␊ - advancedFilters?: (AdvancedFilter2[] | string)␊ - /**␊ - * A list of applicable event types that need to be part of the event subscription. If it is desired to subscribe to all default event types, set the IncludedEventTypes to null.␊ - */␊ - includedEventTypes?: (string[] | string)␊ - /**␊ - * Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter ␍␊ - * should be compared in a case sensitive manner.␊ - */␊ - isSubjectCaseSensitive?: (boolean | string)␊ - /**␊ - * An optional string to filter events for an event subscription based on a resource path prefix.␍␊ - * The format of this depends on the publisher of the events. ␍␊ - * Wildcard characters are not supported in this path.␊ - */␊ - subjectBeginsWith?: string␊ - /**␊ - * An optional string to filter events for an event subscription based on a resource path suffix.␍␊ - * Wildcard characters are not supported in this path.␊ - */␊ - subjectEndsWith?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NumberIn Advanced Filter.␊ - */␊ - export interface NumberInAdvancedFilter2 {␊ - operatorType: "NumberIn"␊ - /**␊ - * The set of filter values.␊ - */␊ - values?: (number[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NumberNotIn Advanced Filter.␊ - */␊ - export interface NumberNotInAdvancedFilter2 {␊ - operatorType: "NumberNotIn"␊ - /**␊ - * The set of filter values.␊ - */␊ - values?: (number[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NumberLessThan Advanced Filter.␊ - */␊ - export interface NumberLessThanAdvancedFilter2 {␊ - operatorType: "NumberLessThan"␊ - /**␊ - * The filter value.␊ - */␊ - value?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NumberGreaterThan Advanced Filter.␊ - */␊ - export interface NumberGreaterThanAdvancedFilter2 {␊ - operatorType: "NumberGreaterThan"␊ - /**␊ - * The filter value.␊ - */␊ - value?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NumberLessThanOrEquals Advanced Filter.␊ - */␊ - export interface NumberLessThanOrEqualsAdvancedFilter2 {␊ - operatorType: "NumberLessThanOrEquals"␊ - /**␊ - * The filter value.␊ - */␊ - value?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * NumberGreaterThanOrEquals Advanced Filter.␊ - */␊ - export interface NumberGreaterThanOrEqualsAdvancedFilter2 {␊ - operatorType: "NumberGreaterThanOrEquals"␊ - /**␊ - * The filter value.␊ - */␊ - value?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * BoolEquals Advanced Filter.␊ - */␊ - export interface BoolEqualsAdvancedFilter2 {␊ - operatorType: "BoolEquals"␊ - /**␊ - * The boolean filter value.␊ - */␊ - value?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * StringIn Advanced Filter.␊ - */␊ - export interface StringInAdvancedFilter2 {␊ - operatorType: "StringIn"␊ - /**␊ - * The set of filter values.␊ - */␊ - values?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * StringNotIn Advanced Filter.␊ - */␊ - export interface StringNotInAdvancedFilter2 {␊ - operatorType: "StringNotIn"␊ - /**␊ - * The set of filter values.␊ - */␊ - values?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * StringBeginsWith Advanced Filter.␊ - */␊ - export interface StringBeginsWithAdvancedFilter2 {␊ - operatorType: "StringBeginsWith"␊ - /**␊ - * The set of filter values.␊ - */␊ - values?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * StringEndsWith Advanced Filter.␊ - */␊ - export interface StringEndsWithAdvancedFilter2 {␊ - operatorType: "StringEndsWith"␊ - /**␊ - * The set of filter values.␊ - */␊ - values?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * StringContains Advanced Filter.␊ - */␊ - export interface StringContainsAdvancedFilter2 {␊ - operatorType: "StringContains"␊ - /**␊ - * The set of filter values.␊ - */␊ - values?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the retry policy for an event subscription.␊ - */␊ - export interface RetryPolicy7 {␊ - /**␊ - * Time To Live (in minutes) for events.␊ - */␊ - eventTimeToLiveInMinutes?: (number | string)␊ - /**␊ - * Maximum number of delivery retry attempts for events.␊ - */␊ - maxDeliveryAttempts?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/availabilitySets␊ - */␊ - export interface AvailabilitySets7 {␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the availability set.␊ - */␊ - name: string␊ - /**␊ - * The instance view of a resource.␊ - */␊ - properties: (AvailabilitySetProperties6 | string)␊ - /**␊ - * Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name.␊ - */␊ - sku?: (Sku69 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/availabilitySets"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The instance view of a resource.␊ - */␊ - export interface AvailabilitySetProperties6 {␊ - /**␊ - * Fault Domain count.␊ - */␊ - platformFaultDomainCount?: (number | string)␊ - /**␊ - * Update Domain count.␊ - */␊ - platformUpdateDomainCount?: (number | string)␊ - proximityPlacementGroup?: (SubResource42 | string)␊ - /**␊ - * A list of references to all virtual machines in the availability set.␊ - */␊ - virtualMachines?: (SubResource42[] | string)␊ - [k: string]: unknown␊ - }␊ - export interface SubResource42 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name.␊ - */␊ - export interface Sku69 {␊ - /**␊ - * Specifies the number of virtual machines in the scale set.␊ - */␊ - capacity?: (number | string)␊ - /**␊ - * The sku name.␊ - */␊ - name?: string␊ - /**␊ - * Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic**␊ - */␊ - tier?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/diskEncryptionSets␊ - */␊ - export interface DiskEncryptionSets {␊ - apiVersion: "2019-07-01"␊ - /**␊ - * The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks.␊ - */␊ - identity?: (EncryptionSetIdentity | string)␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the disk encryption set that is being created. The name can't be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters.␊ - */␊ - name: string␊ - properties: (EncryptionSetProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/diskEncryptionSets"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks.␊ - */␊ - export interface EncryptionSetIdentity {␊ - /**␊ - * The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported.␊ - */␊ - type?: ("SystemAssigned" | string)␊ - [k: string]: unknown␊ - }␊ - export interface EncryptionSetProperties {␊ - /**␊ - * Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey␊ - */␊ - activeKey?: (KeyVaultAndKeyReference4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey␊ - */␊ - export interface KeyVaultAndKeyReference4 {␊ - /**␊ - * Url pointing to a key or secret in KeyVault␊ - */␊ - keyUrl: string␊ - /**␊ - * The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}␊ - */␊ - sourceVault: (SourceVault4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}␊ - */␊ - export interface SourceVault4 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/disks␊ - */␊ - export interface Disks4 {␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters.␊ - */␊ - name: string␊ - /**␊ - * Disk resource properties.␊ - */␊ - properties: (DiskProperties5 | string)␊ - /**␊ - * The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, or UltraSSD_LRS.␊ - */␊ - sku?: (DiskSku3 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/disks"␊ - /**␊ - * The Logical zone list for Disk.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Disk resource properties.␊ - */␊ - export interface DiskProperties5 {␊ - /**␊ - * Data used when creating a disk.␊ - */␊ - creationData: (CreationData4 | string)␊ - /**␊ - * The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes.␊ - */␊ - diskIOPSReadWrite?: (number | string)␊ - /**␊ - * The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10.␊ - */␊ - diskMBpsReadWrite?: (number | string)␊ - /**␊ - * If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size.␊ - */␊ - diskSizeGB?: (number | string)␊ - /**␊ - * Encryption at rest settings for disk or snapshot␊ - */␊ - encryption?: (Encryption12 | string)␊ - /**␊ - * Encryption settings for disk or snapshot␊ - */␊ - encryptionSettingsCollection?: (EncryptionSettingsCollection | string)␊ - /**␊ - * The hypervisor generation of the Virtual Machine. Applicable to OS disks only.␊ - */␊ - hyperVGeneration?: (("V1" | "V2") | string)␊ - /**␊ - * The Operating System type.␊ - */␊ - osType?: (("Windows" | "Linux") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Data used when creating a disk.␊ - */␊ - export interface CreationData4 {␊ - /**␊ - * This enumerates the possible sources of a disk's creation.␊ - */␊ - createOption: (("Empty" | "Attach" | "FromImage" | "Import" | "Copy" | "Restore" | "Upload") | string)␊ - /**␊ - * The source image used for creating the disk.␊ - */␊ - imageReference?: (ImageDiskReference4 | string)␊ - /**␊ - * If createOption is Copy, this is the ARM id of the source snapshot or disk.␊ - */␊ - sourceResourceId?: string␊ - /**␊ - * If createOption is Import, this is the URI of a blob to be imported into a managed disk.␊ - */␊ - sourceUri?: string␊ - /**␊ - * Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk.␊ - */␊ - storageAccountId?: string␊ - /**␊ - * If createOption is Upload, this is the size of the contents of the upload including the VHD footer. This value should be between 20972032 (20 MiB + 512 bytes for the VHD footer) and 35183298347520 bytes (32 TiB + 512 bytes for the VHD footer).␊ - */␊ - uploadSizeBytes?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The source image used for creating the disk.␊ - */␊ - export interface ImageDiskReference4 {␊ - /**␊ - * A relative uri containing either a Platform Image Repository or user image reference.␊ - */␊ - id: string␊ - /**␊ - * If the disk is created from an image's data disk, this is an index that indicates which of the data disks in the image to use. For OS disks, this field is null.␊ - */␊ - lun?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Encryption at rest settings for disk or snapshot␊ - */␊ - export interface Encryption12 {␊ - /**␊ - * ResourceId of the disk encryption set to use for enabling encryption at rest.␊ - */␊ - diskEncryptionSetId?: string␊ - /**␊ - * The type of key used to encrypt the data of the disk.␊ - */␊ - type: (("EncryptionAtRestWithPlatformKey" | "EncryptionAtRestWithCustomerKey") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Encryption settings for disk or snapshot␊ - */␊ - export interface EncryptionSettingsCollection {␊ - /**␊ - * Set this flag to true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable encryption. Set this flag to false and remove DiskEncryptionKey and KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the request object, the existing settings remain unchanged.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * A collection of encryption settings, one for each disk volume.␊ - */␊ - encryptionSettings?: (EncryptionSettingsElement[] | string)␊ - /**␊ - * Describes what type of encryption is used for the disks. Once this field is set, it cannot be overwritten. '1.0' corresponds to Azure Disk Encryption with AAD app.'1.1' corresponds to Azure Disk Encryption.␊ - */␊ - encryptionSettingsVersion?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Encryption settings for one disk volume.␊ - */␊ - export interface EncryptionSettingsElement {␊ - /**␊ - * Key Vault Secret Url and vault id of the encryption key ␊ - */␊ - diskEncryptionKey?: (KeyVaultAndSecretReference4 | string)␊ - /**␊ - * Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey␊ - */␊ - keyEncryptionKey?: (KeyVaultAndKeyReference4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Key Vault Secret Url and vault id of the encryption key ␊ - */␊ - export interface KeyVaultAndSecretReference4 {␊ - /**␊ - * Url pointing to a key or secret in KeyVault␊ - */␊ - secretUrl: string␊ - /**␊ - * The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}␊ - */␊ - sourceVault: (SourceVault4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, or UltraSSD_LRS.␊ - */␊ - export interface DiskSku3 {␊ - /**␊ - * The sku name.␊ - */␊ - name?: (("Standard_LRS" | "Premium_LRS" | "StandardSSD_LRS" | "UltraSSD_LRS") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/hostGroups␊ - */␊ - export interface HostGroups1 {␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the dedicated host group.␊ - */␊ - name: string␊ - /**␊ - * Dedicated Host Group Properties.␊ - */␊ - properties: (DedicatedHostGroupProperties1 | string)␊ - resources?: HostGroupsHostsChildResource1[]␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/hostGroups"␊ - /**␊ - * Availability Zone to use for this host group. Only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Dedicated Host Group Properties.␊ - */␊ - export interface DedicatedHostGroupProperties1 {␊ - /**␊ - * Number of fault domains that the host group can span.␊ - */␊ - platformFaultDomainCount: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/hostGroups/hosts␊ - */␊ - export interface HostGroupsHostsChildResource1 {␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the dedicated host .␊ - */␊ - name: string␊ - /**␊ - * Properties of the dedicated host.␊ - */␊ - properties: (DedicatedHostProperties1 | string)␊ - /**␊ - * Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name.␊ - */␊ - sku: (Sku69 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "hosts"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the dedicated host.␊ - */␊ - export interface DedicatedHostProperties1 {␊ - /**␊ - * Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided.␊ - */␊ - autoReplaceOnFailure?: (boolean | string)␊ - /**␊ - * Specifies the software license type that will be applied to the VMs deployed on the dedicated host.

    Possible values are:

    **None**

    **Windows_Server_Hybrid**

    **Windows_Server_Perpetual**

    Default: **None**.␊ - */␊ - licenseType?: (("None" | "Windows_Server_Hybrid" | "Windows_Server_Perpetual") | string)␊ - /**␊ - * Fault domain of the dedicated host within a dedicated host group.␊ - */␊ - platformFaultDomain?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/hostGroups/hosts␊ - */␊ - export interface HostGroupsHosts1 {␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the dedicated host .␊ - */␊ - name: string␊ - /**␊ - * Properties of the dedicated host.␊ - */␊ - properties: (DedicatedHostProperties1 | string)␊ - /**␊ - * Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name.␊ - */␊ - sku: (Sku69 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/hostGroups/hosts"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/images␊ - */␊ - export interface Images6 {␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the image.␊ - */␊ - name: string␊ - /**␊ - * Describes the properties of an Image.␊ - */␊ - properties: (ImageProperties6 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/images"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the properties of an Image.␊ - */␊ - export interface ImageProperties6 {␊ - /**␊ - * Gets the HyperVGenerationType of the VirtualMachine created from the image.␊ - */␊ - hyperVGeneration?: (("V1" | "V2") | string)␊ - sourceVirtualMachine?: (SubResource42 | string)␊ - /**␊ - * Describes a storage profile.␊ - */␊ - storageProfile?: (ImageStorageProfile6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a storage profile.␊ - */␊ - export interface ImageStorageProfile6 {␊ - /**␊ - * 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).␊ - */␊ - dataDisks?: (ImageDataDisk6[] | string)␊ - /**␊ - * Describes an Operating System disk.␊ - */␊ - osDisk?: (ImageOSDisk6 | string)␊ - /**␊ - * Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS).␊ - */␊ - zoneResilient?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a data disk.␊ - */␊ - export interface ImageDataDisk6 {␊ - /**␊ - * The Virtual Hard Disk.␊ - */␊ - blobUri?: string␊ - /**␊ - * Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**.␊ - */␊ - caching?: (("None" | "ReadOnly" | "ReadWrite") | string)␊ - /**␊ - * Describes the parameter of customer managed disk encryption set resource id that can be specified for disk.

    NOTE: The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details.␊ - */␊ - diskEncryptionSet?: (DiskEncryptionSetParameters | string)␊ - /**␊ - * 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␊ - */␊ - diskSizeGB?: (number | string)␊ - /**␊ - * 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.␊ - */␊ - lun: (number | string)␊ - managedDisk?: (SubResource42 | string)␊ - snapshot?: (SubResource42 | string)␊ - /**␊ - * Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.␊ - */␊ - storageAccountType?: (("Standard_LRS" | "Premium_LRS" | "StandardSSD_LRS" | "UltraSSD_LRS") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the parameter of customer managed disk encryption set resource id that can be specified for disk.

    NOTE: The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details.␊ - */␊ - export interface DiskEncryptionSetParameters {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes an Operating System disk.␊ - */␊ - export interface ImageOSDisk6 {␊ - /**␊ - * The Virtual Hard Disk.␊ - */␊ - blobUri?: string␊ - /**␊ - * Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**.␊ - */␊ - caching?: (("None" | "ReadOnly" | "ReadWrite") | string)␊ - /**␊ - * Describes the parameter of customer managed disk encryption set resource id that can be specified for disk.

    NOTE: The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details.␊ - */␊ - diskEncryptionSet?: (DiskEncryptionSetParameters | string)␊ - /**␊ - * 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␊ - */␊ - diskSizeGB?: (number | string)␊ - managedDisk?: (SubResource42 | string)␊ - /**␊ - * The OS State.␊ - */␊ - osState: (("Generalized" | "Specialized") | string)␊ - /**␊ - * 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**.␊ - */␊ - osType: (("Windows" | "Linux") | string)␊ - snapshot?: (SubResource42 | string)␊ - /**␊ - * Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.␊ - */␊ - storageAccountType?: (("Standard_LRS" | "Premium_LRS" | "StandardSSD_LRS" | "UltraSSD_LRS") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/proximityPlacementGroups␊ - */␊ - export interface ProximityPlacementGroups1 {␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the proximity placement group.␊ - */␊ - name: string␊ - /**␊ - * Describes the properties of a Proximity Placement Group.␊ - */␊ - properties: (ProximityPlacementGroupProperties1 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/proximityPlacementGroups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the properties of a Proximity Placement Group.␊ - */␊ - export interface ProximityPlacementGroupProperties1 {␊ - /**␊ - * Instance view status.␊ - */␊ - colocationStatus?: (InstanceViewStatus | string)␊ - /**␊ - * Specifies the type of the proximity placement group.

    Possible values are:

    **Standard** : Co-locate resources within an Azure region or Availability Zone.

    **Ultra** : For future use.␊ - */␊ - proximityPlacementGroupType?: (("Standard" | "Ultra") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Instance view status.␊ - */␊ - export interface InstanceViewStatus {␊ - /**␊ - * The status code.␊ - */␊ - code?: string␊ - /**␊ - * The short localizable label for the status.␊ - */␊ - displayStatus?: string␊ - /**␊ - * The level code.␊ - */␊ - level?: (("Info" | "Warning" | "Error") | string)␊ - /**␊ - * The detailed status message, including for alerts and error messages.␊ - */␊ - message?: string␊ - /**␊ - * The time of the status.␊ - */␊ - time?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/snapshots␊ - */␊ - export interface Snapshots4 {␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the snapshot that is being created. The name can't be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The max name length is 80 characters.␊ - */␊ - name: string␊ - /**␊ - * Snapshot resource properties.␊ - */␊ - properties: (SnapshotProperties3 | string)␊ - /**␊ - * The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS.␊ - */␊ - sku?: (SnapshotSku2 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/snapshots"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Snapshot resource properties.␊ - */␊ - export interface SnapshotProperties3 {␊ - /**␊ - * Data used when creating a disk.␊ - */␊ - creationData: (CreationData4 | string)␊ - /**␊ - * If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size.␊ - */␊ - diskSizeGB?: (number | string)␊ - /**␊ - * Encryption at rest settings for disk or snapshot␊ - */␊ - encryption?: (Encryption12 | string)␊ - /**␊ - * Encryption settings for disk or snapshot␊ - */␊ - encryptionSettingsCollection?: (EncryptionSettingsCollection | string)␊ - /**␊ - * The hypervisor generation of the Virtual Machine. Applicable to OS disks only.␊ - */␊ - hyperVGeneration?: (("V1" | "V2") | string)␊ - /**␊ - * Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed.␊ - */␊ - incremental?: (boolean | string)␊ - /**␊ - * The Operating System type.␊ - */␊ - osType?: (("Windows" | "Linux") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS.␊ - */␊ - export interface SnapshotSku2 {␊ - /**␊ - * The sku name.␊ - */␊ - name?: (("Standard_LRS" | "Premium_LRS" | "Standard_ZRS") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/virtualMachines␊ - */␊ - export interface VirtualMachines8 {␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Identity for the virtual machine.␊ - */␊ - identity?: (VirtualMachineIdentity6 | string)␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the virtual machine.␊ - */␊ - name: string␊ - /**␊ - * 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**.␊ - */␊ - plan?: (Plan9 | string)␊ - /**␊ - * Describes the properties of a Virtual Machine.␊ - */␊ - properties: (VirtualMachineProperties13 | string)␊ - resources?: VirtualMachinesExtensionsChildResource6[]␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/virtualMachines"␊ - /**␊ - * The virtual machine zones.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the virtual machine.␊ - */␊ - export interface VirtualMachineIdentity6 {␊ - /**␊ - * The type of identity used for the virtual machine. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.␊ - */␊ - type?: (("SystemAssigned" | "UserAssigned" | "SystemAssigned, UserAssigned" | "None") | string)␊ - /**␊ - * The list of user identities associated with the Virtual Machine. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.␊ - */␊ - userAssignedIdentities?: ({␊ - [k: string]: UserAssignedIdentitiesValue3␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - export interface UserAssignedIdentitiesValue3 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * 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**.␊ - */␊ - export interface Plan9 {␊ - /**␊ - * The plan ID.␊ - */␊ - name?: string␊ - /**␊ - * Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.␊ - */␊ - product?: string␊ - /**␊ - * The promotion code.␊ - */␊ - promotionCode?: string␊ - /**␊ - * The publisher ID.␊ - */␊ - publisher?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the properties of a Virtual Machine.␊ - */␊ - export interface VirtualMachineProperties13 {␊ - /**␊ - * Enables or disables a capability on the virtual machine or virtual machine scale set.␊ - */␊ - additionalCapabilities?: (AdditionalCapabilities3 | string)␊ - availabilitySet?: (SubResource42 | string)␊ - /**␊ - * Specifies the billing related details of a Azure Spot VM or VMSS.

    Minimum api-version: 2019-03-01.␊ - */␊ - billingProfile?: (BillingProfile1 | string)␊ - /**␊ - * Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15.␊ - */␊ - diagnosticsProfile?: (DiagnosticsProfile6 | string)␊ - /**␊ - * Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set.

    For Azure Spot virtual machines, the only supported value is 'Deallocate' and the minimum api-version is 2019-03-01.

    For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview.␊ - */␊ - evictionPolicy?: (("Deallocate" | "Delete") | string)␊ - /**␊ - * Specifies the hardware settings for the virtual machine.␊ - */␊ - hardwareProfile?: (HardwareProfile9 | string)␊ - host?: (SubResource42 | string)␊ - /**␊ - * 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␊ - */␊ - licenseType?: string␊ - /**␊ - * Specifies the network interfaces of the virtual machine.␊ - */␊ - networkProfile?: (NetworkProfile7 | string)␊ - /**␊ - * Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned.␊ - */␊ - osProfile?: (OSProfile6 | string)␊ - /**␊ - * Specifies the priority for the virtual machine.

    Minimum api-version: 2019-03-01.␊ - */␊ - priority?: (("Regular" | "Low" | "Spot") | string)␊ - proximityPlacementGroup?: (SubResource42 | string)␊ - /**␊ - * Specifies the storage settings for the virtual machine disks.␊ - */␊ - storageProfile?: (StorageProfile14 | string)␊ - virtualMachineScaleSet?: (SubResource42 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Enables or disables a capability on the virtual machine or virtual machine scale set.␊ - */␊ - export interface AdditionalCapabilities3 {␊ - /**␊ - * The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled.␊ - */␊ - ultraSSDEnabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the billing related details of a Azure Spot VM or VMSS.

    Minimum api-version: 2019-03-01.␊ - */␊ - export interface BillingProfile1 {␊ - /**␊ - * Specifies the maximum price you are willing to pay for a Azure Spot VM/VMSS. This price is in US Dollars.

    This price will be compared with the current Azure Spot price for the VM size. Also, the prices are compared at the time of create/update of Azure Spot VM/VMSS and the operation will only succeed if the maxPrice is greater than the current Azure Spot price.

    The maxPrice will also be used for evicting a Azure Spot VM/VMSS if the current Azure Spot price goes beyond the maxPrice after creation of VM/VMSS.

    Possible values are:

    - Any decimal value greater than zero. Example: 0.01538

    -1 – indicates default price to be up-to on-demand.

    You can set the maxPrice to -1 to indicate that the Azure Spot VM/VMSS should not be evicted for price reasons. Also, the default max price is -1 if it is not provided by you.

    Minimum api-version: 2019-03-01.␊ - */␊ - maxPrice?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15.␊ - */␊ - export interface DiagnosticsProfile6 {␊ - /**␊ - * Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    You can easily view the output of your console log.

    Azure also enables you to see a screenshot of the VM from the hypervisor.␊ - */␊ - bootDiagnostics?: (BootDiagnostics6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    You can easily view the output of your console log.

    Azure also enables you to see a screenshot of the VM from the hypervisor.␊ - */␊ - export interface BootDiagnostics6 {␊ - /**␊ - * Whether boot diagnostics should be enabled on the Virtual Machine.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Uri of the storage account to use for placing the console output and screenshot.␊ - */␊ - storageUri?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the hardware settings for the virtual machine.␊ - */␊ - export interface HardwareProfile9 {␊ - /**␊ - * 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](https://docs.microsoft.com/rest/api/compute/availabilitysets/listavailablesizes)

    [List all available virtual machine sizes in a region](https://docs.microsoft.com/rest/api/compute/virtualmachinesizes/list)

    [List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes).␊ - */␊ - vmSize?: (("Basic_A0" | "Basic_A1" | "Basic_A2" | "Basic_A3" | "Basic_A4" | "Standard_A0" | "Standard_A1" | "Standard_A2" | "Standard_A3" | "Standard_A4" | "Standard_A5" | "Standard_A6" | "Standard_A7" | "Standard_A8" | "Standard_A9" | "Standard_A10" | "Standard_A11" | "Standard_A1_v2" | "Standard_A2_v2" | "Standard_A4_v2" | "Standard_A8_v2" | "Standard_A2m_v2" | "Standard_A4m_v2" | "Standard_A8m_v2" | "Standard_B1s" | "Standard_B1ms" | "Standard_B2s" | "Standard_B2ms" | "Standard_B4ms" | "Standard_B8ms" | "Standard_D1" | "Standard_D2" | "Standard_D3" | "Standard_D4" | "Standard_D11" | "Standard_D12" | "Standard_D13" | "Standard_D14" | "Standard_D1_v2" | "Standard_D2_v2" | "Standard_D3_v2" | "Standard_D4_v2" | "Standard_D5_v2" | "Standard_D2_v3" | "Standard_D4_v3" | "Standard_D8_v3" | "Standard_D16_v3" | "Standard_D32_v3" | "Standard_D64_v3" | "Standard_D2s_v3" | "Standard_D4s_v3" | "Standard_D8s_v3" | "Standard_D16s_v3" | "Standard_D32s_v3" | "Standard_D64s_v3" | "Standard_D11_v2" | "Standard_D12_v2" | "Standard_D13_v2" | "Standard_D14_v2" | "Standard_D15_v2" | "Standard_DS1" | "Standard_DS2" | "Standard_DS3" | "Standard_DS4" | "Standard_DS11" | "Standard_DS12" | "Standard_DS13" | "Standard_DS14" | "Standard_DS1_v2" | "Standard_DS2_v2" | "Standard_DS3_v2" | "Standard_DS4_v2" | "Standard_DS5_v2" | "Standard_DS11_v2" | "Standard_DS12_v2" | "Standard_DS13_v2" | "Standard_DS14_v2" | "Standard_DS15_v2" | "Standard_DS13-4_v2" | "Standard_DS13-2_v2" | "Standard_DS14-8_v2" | "Standard_DS14-4_v2" | "Standard_E2_v3" | "Standard_E4_v3" | "Standard_E8_v3" | "Standard_E16_v3" | "Standard_E32_v3" | "Standard_E64_v3" | "Standard_E2s_v3" | "Standard_E4s_v3" | "Standard_E8s_v3" | "Standard_E16s_v3" | "Standard_E32s_v3" | "Standard_E64s_v3" | "Standard_E32-16_v3" | "Standard_E32-8s_v3" | "Standard_E64-32s_v3" | "Standard_E64-16s_v3" | "Standard_F1" | "Standard_F2" | "Standard_F4" | "Standard_F8" | "Standard_F16" | "Standard_F1s" | "Standard_F2s" | "Standard_F4s" | "Standard_F8s" | "Standard_F16s" | "Standard_F2s_v2" | "Standard_F4s_v2" | "Standard_F8s_v2" | "Standard_F16s_v2" | "Standard_F32s_v2" | "Standard_F64s_v2" | "Standard_F72s_v2" | "Standard_G1" | "Standard_G2" | "Standard_G3" | "Standard_G4" | "Standard_G5" | "Standard_GS1" | "Standard_GS2" | "Standard_GS3" | "Standard_GS4" | "Standard_GS5" | "Standard_GS4-8" | "Standard_GS4-4" | "Standard_GS5-16" | "Standard_GS5-8" | "Standard_H8" | "Standard_H16" | "Standard_H8m" | "Standard_H16m" | "Standard_H16r" | "Standard_H16mr" | "Standard_L4s" | "Standard_L8s" | "Standard_L16s" | "Standard_L32s" | "Standard_M64s" | "Standard_M64ms" | "Standard_M128s" | "Standard_M128ms" | "Standard_M64-32ms" | "Standard_M64-16ms" | "Standard_M128-64ms" | "Standard_M128-32ms" | "Standard_NC6" | "Standard_NC12" | "Standard_NC24" | "Standard_NC24r" | "Standard_NC6s_v2" | "Standard_NC12s_v2" | "Standard_NC24s_v2" | "Standard_NC24rs_v2" | "Standard_NC6s_v3" | "Standard_NC12s_v3" | "Standard_NC24s_v3" | "Standard_NC24rs_v3" | "Standard_ND6s" | "Standard_ND12s" | "Standard_ND24s" | "Standard_ND24rs" | "Standard_NV6" | "Standard_NV12" | "Standard_NV24") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the network interfaces of the virtual machine.␊ - */␊ - export interface NetworkProfile7 {␊ - /**␊ - * Specifies the list of resource Ids for the network interfaces associated with the virtual machine.␊ - */␊ - networkInterfaces?: (NetworkInterfaceReference6[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a network interface reference.␊ - */␊ - export interface NetworkInterfaceReference6 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Describes a network interface reference properties.␊ - */␊ - properties?: (NetworkInterfaceReferenceProperties6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a network interface reference properties.␊ - */␊ - export interface NetworkInterfaceReferenceProperties6 {␊ - /**␊ - * Specifies the primary network interface in case the virtual machine has more than 1 network interface.␊ - */␊ - primary?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned.␊ - */␊ - export interface OSProfile6 {␊ - /**␊ - * 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)␊ - */␊ - adminPassword?: string␊ - /**␊ - * Specifies the name of the administrator account.

    This property cannot be updated after the VM is created.

    **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)␊ - */␊ - adminUsername?: string␊ - /**␊ - * Specifies whether extension operations should be allowed on the virtual machine.

    This may only be set to False when no extensions are present on the virtual machine.␊ - */␊ - allowExtensionOperations?: (boolean | string)␊ - /**␊ - * Specifies the host OS name of the virtual machine.

    This name cannot be updated after the VM is created.

    **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).␊ - */␊ - computerName?: string␊ - /**␊ - * 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.

    **Note: Do not pass any secrets or passwords in customData property**

    This property cannot be updated after the VM is created.

    customData is passed to the VM to be saved as a file, for more information see [Custom Data on Azure VMs](https://docs.microsoft.com/azure/virtual-machines/custom-data)

    For using cloud-init for your Linux 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)␊ - */␊ - customData?: string␊ - /**␊ - * 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).␊ - */␊ - linuxConfiguration?: (LinuxConfiguration7 | string)␊ - /**␊ - * Specifies whether the guest provision signal is required to infer provision success of the virtual machine.␊ - */␊ - requireGuestProvisionSignal?: (boolean | string)␊ - /**␊ - * Specifies set of certificates that should be installed onto the virtual machine.␊ - */␊ - secrets?: (VaultSecretGroup6[] | string)␊ - /**␊ - * Specifies Windows operating system settings on the virtual machine.␊ - */␊ - windowsConfiguration?: (WindowsConfiguration8 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * 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).␊ - */␊ - export interface LinuxConfiguration7 {␊ - /**␊ - * Specifies whether password authentication should be disabled.␊ - */␊ - disablePasswordAuthentication?: (boolean | string)␊ - /**␊ - * 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.␊ - */␊ - provisionVMAgent?: (boolean | string)␊ - /**␊ - * SSH configuration for Linux based VMs running on Azure␊ - */␊ - ssh?: (SshConfiguration8 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSH configuration for Linux based VMs running on Azure␊ - */␊ - export interface SshConfiguration8 {␊ - /**␊ - * The list of SSH public keys used to authenticate with linux based VMs.␊ - */␊ - publicKeys?: (SshPublicKey8[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed.␊ - */␊ - export interface SshPublicKey8 {␊ - /**␊ - * 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).␊ - */␊ - keyData?: string␊ - /**␊ - * 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␊ - */␊ - path?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a set of certificates which are all in the same Key Vault.␊ - */␊ - export interface VaultSecretGroup6 {␊ - sourceVault?: (SubResource42 | string)␊ - /**␊ - * The list of key vault references in SourceVault which contain certificates.␊ - */␊ - vaultCertificates?: (VaultCertificate6[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM.␊ - */␊ - export interface VaultCertificate6 {␊ - /**␊ - * 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 <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted.␊ - */␊ - certificateStore?: string␊ - /**␊ - * 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":""
    }␊ - */␊ - certificateUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies Windows operating system settings on the virtual machine.␊ - */␊ - export interface WindowsConfiguration8 {␊ - /**␊ - * Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup.␊ - */␊ - additionalUnattendContent?: (AdditionalUnattendContent7[] | string)␊ - /**␊ - * Indicates whether Automatic Updates is enabled for the Windows virtual machine. Default value is true.

    For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning.␊ - */␊ - enableAutomaticUpdates?: (boolean | string)␊ - /**␊ - * 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.␊ - */␊ - provisionVMAgent?: (boolean | string)␊ - /**␊ - * Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time".

    Possible values can be [TimeZoneInfo.Id](https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time zones returned by [TimeZoneInfo.GetSystemTimeZones](https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.getsystemtimezones).␊ - */␊ - timeZone?: string␊ - /**␊ - * Describes Windows Remote Management configuration of the VM␊ - */␊ - winRM?: (WinRMConfiguration6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * 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.␊ - */␊ - export interface AdditionalUnattendContent7 {␊ - /**␊ - * The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup.␊ - */␊ - componentName?: ("Microsoft-Windows-Shell-Setup" | string)␊ - /**␊ - * 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.␊ - */␊ - content?: string␊ - /**␊ - * The pass name. Currently, the only allowable value is OobeSystem.␊ - */␊ - passName?: ("OobeSystem" | string)␊ - /**␊ - * Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.␊ - */␊ - settingName?: (("AutoLogon" | "FirstLogonCommands") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes Windows Remote Management configuration of the VM␊ - */␊ - export interface WinRMConfiguration6 {␊ - /**␊ - * The list of Windows Remote Management listeners␊ - */␊ - listeners?: (WinRMListener7[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes Protocol and thumbprint of Windows Remote Management listener␊ - */␊ - export interface WinRMListener7 {␊ - /**␊ - * 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":""
    }␊ - */␊ - certificateUrl?: string␊ - /**␊ - * Specifies the protocol of WinRM listener.

    Possible values are:
    **http**

    **https**.␊ - */␊ - protocol?: (("Http" | "Https") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the storage settings for the virtual machine disks.␊ - */␊ - export interface StorageProfile14 {␊ - /**␊ - * 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).␊ - */␊ - dataDisks?: (DataDisk8[] | string)␊ - /**␊ - * 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. NOTE: Image reference publisher and offer can only be set when you create the scale set␊ - */␊ - imageReference?: (ImageReference10 | string)␊ - /**␊ - * 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).␊ - */␊ - osDisk?: (OSDisk7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a data disk.␊ - */␊ - export interface DataDisk8 {␊ - /**␊ - * Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**.␊ - */␊ - caching?: (("None" | "ReadOnly" | "ReadWrite") | string)␊ - /**␊ - * 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.␊ - */␊ - createOption: (("FromImage" | "Empty" | "Attach") | string)␊ - /**␊ - * Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB␊ - */␊ - diskSizeGB?: (number | string)␊ - /**␊ - * Describes the uri of a disk.␊ - */␊ - image?: (VirtualHardDisk6 | string)␊ - /**␊ - * 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.␊ - */␊ - lun: (number | string)␊ - /**␊ - * The parameters of a managed disk.␊ - */␊ - managedDisk?: (ManagedDiskParameters6 | string)␊ - /**␊ - * The disk name.␊ - */␊ - name?: string␊ - /**␊ - * Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset␊ - */␊ - toBeDetached?: (boolean | string)␊ - /**␊ - * Describes the uri of a disk.␊ - */␊ - vhd?: (VirtualHardDisk6 | string)␊ - /**␊ - * Specifies whether writeAccelerator should be enabled or disabled on the disk.␊ - */␊ - writeAcceleratorEnabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the uri of a disk.␊ - */␊ - export interface VirtualHardDisk6 {␊ - /**␊ - * Specifies the virtual hard disk's uri.␊ - */␊ - uri?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The parameters of a managed disk.␊ - */␊ - export interface ManagedDiskParameters6 {␊ - /**␊ - * Describes the parameter of customer managed disk encryption set resource id that can be specified for disk.

    NOTE: The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details.␊ - */␊ - diskEncryptionSet?: (DiskEncryptionSetParameters | string)␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.␊ - */␊ - storageAccountType?: (("Standard_LRS" | "Premium_LRS" | "StandardSSD_LRS" | "UltraSSD_LRS") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * 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. NOTE: Image reference publisher and offer can only be set when you create the scale set␊ - */␊ - export interface ImageReference10 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Specifies the offer of the platform image or marketplace image used to create the virtual machine.␊ - */␊ - offer?: string␊ - /**␊ - * The image publisher.␊ - */␊ - publisher?: string␊ - /**␊ - * The image SKU.␊ - */␊ - sku?: string␊ - /**␊ - * 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.␊ - */␊ - version?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * 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).␊ - */␊ - export interface OSDisk7 {␊ - /**␊ - * Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**.␊ - */␊ - caching?: (("None" | "ReadOnly" | "ReadWrite") | string)␊ - /**␊ - * 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.␊ - */␊ - createOption: (("FromImage" | "Empty" | "Attach") | string)␊ - /**␊ - * Describes the parameters of ephemeral disk settings that can be specified for operating system disk.

    NOTE: The ephemeral disk settings can only be specified for managed disk.␊ - */␊ - diffDiskSettings?: (DiffDiskSettings3 | string)␊ - /**␊ - * Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB␊ - */␊ - diskSizeGB?: (number | string)␊ - /**␊ - * Describes a Encryption Settings for a Disk␊ - */␊ - encryptionSettings?: (DiskEncryptionSettings6 | string)␊ - /**␊ - * Describes the uri of a disk.␊ - */␊ - image?: (VirtualHardDisk6 | string)␊ - /**␊ - * The parameters of a managed disk.␊ - */␊ - managedDisk?: (ManagedDiskParameters6 | string)␊ - /**␊ - * The disk name.␊ - */␊ - name?: string␊ - /**␊ - * 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**.␊ - */␊ - osType?: (("Windows" | "Linux") | string)␊ - /**␊ - * Describes the uri of a disk.␊ - */␊ - vhd?: (VirtualHardDisk6 | string)␊ - /**␊ - * Specifies whether writeAccelerator should be enabled or disabled on the disk.␊ - */␊ - writeAcceleratorEnabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the parameters of ephemeral disk settings that can be specified for operating system disk.

    NOTE: The ephemeral disk settings can only be specified for managed disk.␊ - */␊ - export interface DiffDiskSettings3 {␊ - /**␊ - * Specifies the ephemeral disk settings for operating system disk.␊ - */␊ - option?: ("Local" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a Encryption Settings for a Disk␊ - */␊ - export interface DiskEncryptionSettings6 {␊ - /**␊ - * Describes a reference to Key Vault Secret␊ - */␊ - diskEncryptionKey?: (KeyVaultSecretReference8 | string)␊ - /**␊ - * Specifies whether disk encryption should be enabled on the virtual machine.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Describes a reference to Key Vault Key␊ - */␊ - keyEncryptionKey?: (KeyVaultKeyReference6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a reference to Key Vault Secret␊ - */␊ - export interface KeyVaultSecretReference8 {␊ - /**␊ - * The URL referencing a secret in a Key Vault.␊ - */␊ - secretUrl: string␊ - sourceVault: (SubResource42 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a reference to Key Vault Key␊ - */␊ - export interface KeyVaultKeyReference6 {␊ - /**␊ - * The URL referencing a key encryption key in Key Vault.␊ - */␊ - keyUrl: string␊ - sourceVault: (SubResource42 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/virtualMachines/extensions␊ - */␊ - export interface VirtualMachinesExtensionsChildResource6 {␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the virtual machine extension.␊ - */␊ - name: string␊ - properties: (GenericExtension7 | IaaSDiagnostics7 | IaaSAntimalware7 | CustomScriptExtension7 | CustomScriptForLinux7 | LinuxDiagnostic7 | VmAccessForLinux7 | BgInfo7 | VmAccessAgent7 | DscExtension7 | AcronisBackupLinux7 | AcronisBackup7 | LinuxChefClient7 | ChefClient7 | DatadogLinuxAgent7 | DatadogWindowsAgent7 | DockerExtension7 | DynatraceLinux7 | DynatraceWindows7 | Eset7 | HpeSecurityApplicationDefender7 | PuppetAgent7 | Site24X7LinuxServerExtn7 | Site24X7WindowsServerExtn7 | Site24X7ApmInsightExtn7 | TrendMicroDSALinux7 | TrendMicroDSA7 | BmcCtmAgentLinux7 | BmcCtmAgentWindows7 | OSPatchingForLinux7 | VMSnapshot7 | VMSnapshotLinux7 | CustomScript7 | NetworkWatcherAgentWindows7 | NetworkWatcherAgentLinux7)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "extensions"␊ - [k: string]: unknown␊ - }␊ - export interface GenericExtension7 {␊ - /**␊ - * Microsoft.Compute/extensions - Publisher␊ - */␊ - publisher: string␊ - /**␊ - * Microsoft.Compute/extensions - Type␊ - */␊ - type: string␊ - /**␊ - * Microsoft.Compute/extensions - Type handler version␊ - */␊ - typeHandlerVersion: string␊ - /**␊ - * Microsoft.Compute/extensions - Settings␊ - */␊ - settings: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - export interface IaaSDiagnostics7 {␊ - publisher: "Microsoft.Azure.Diagnostics"␊ - type: "IaaSDiagnostics"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - xmlCfg: string␊ - StorageAccount: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - storageAccountName: string␊ - storageAccountKey: string␊ - storageAccountEndPoint: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface IaaSAntimalware7 {␊ - publisher: "Microsoft.Azure.Security"␊ - type: "IaaSAntimalware"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - AntimalwareEnabled: boolean␊ - Exclusions: {␊ - Paths: string␊ - Extensions: string␊ - Processes: string␊ - [k: string]: unknown␊ - }␊ - RealtimeProtectionEnabled: ("true" | "false")␊ - ScheduledScanSettings: {␊ - isEnabled: ("true" | "false")␊ - scanType: string␊ - day: string␊ - time: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface CustomScriptExtension7 {␊ - publisher: "Microsoft.Compute"␊ - type: "CustomScriptExtension"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - fileUris?: string[]␊ - commandToExecute: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - storageAccountName?: string␊ - storageAccountKey?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface CustomScriptForLinux7 {␊ - publisher: "Microsoft.OSTCExtensions"␊ - type: "CustomScriptForLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - fileUris?: string[]␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - commandToExecute: string␊ - storageAccountName?: string␊ - storageAccountKey?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface LinuxDiagnostic7 {␊ - publisher: "Microsoft.OSTCExtensions"␊ - type: "LinuxDiagnostic"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - enableSyslog?: string␊ - mdsdHttpProxy?: string␊ - perCfg?: unknown[]␊ - fileCfg?: unknown[]␊ - xmlCfg?: string␊ - ladCfg?: {␊ - [k: string]: unknown␊ - }␊ - syslogCfg?: string␊ - eventVolume?: string␊ - mdsdCfg?: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - mdsdHttpProxy?: string␊ - storageAccountName: string␊ - storageAccountKey: string␊ - storageAccountEndPoint?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface VmAccessForLinux7 {␊ - publisher: "Microsoft.OSTCExtensions"␊ - type: "VMAccessForLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - check_disk?: boolean␊ - repair_disk?: boolean␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - username: string␊ - password: string␊ - ssh_key: string␊ - reset_ssh: string␊ - remove_user: string␊ - expiration: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface BgInfo7 {␊ - publisher: "Microsoft.Compute"␊ - type: "bginfo"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - [k: string]: unknown␊ - }␊ - export interface VmAccessAgent7 {␊ - publisher: "Microsoft.Compute"␊ - type: "VMAccessAgent"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - username?: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - password?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface DscExtension7 {␊ - publisher: "Microsoft.Powershell"␊ - type: "DSC"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - modulesUrl: string␊ - configurationFunction: string␊ - properties?: string␊ - wmfVersion?: string␊ - privacy?: {␊ - dataCollection?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - dataBlobUri?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface AcronisBackupLinux7 {␊ - publisher: "Acronis.Backup"␊ - type: "AcronisBackupLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - absURL: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - userLogin: string␊ - userPassword: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface AcronisBackup7 {␊ - publisher: "Acronis.Backup"␊ - type: "AcronisBackup"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - absURL: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - userLogin: string␊ - userPassword: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface LinuxChefClient7 {␊ - publisher: "Chef.Bootstrap.WindowsAzure"␊ - type: "LinuxChefClient"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - bootstrap_version?: string␊ - bootstrap_options?: {␊ - chef_node_name: string␊ - chef_server_url: string␊ - validation_client_name: string␊ - node_ssl_verify_mode: string␊ - environment: string␊ - [k: string]: unknown␊ - }␊ - runlist?: string␊ - client_rb?: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - validation_key: string␊ - chef_server_crt: string␊ - secret: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface ChefClient7 {␊ - publisher: "Chef.Bootstrap.WindowsAzure"␊ - type: "ChefClient"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - bootstrap_options?: {␊ - chef_node_name: string␊ - chef_server_url: string␊ - validation_client_name: string␊ - node_ssl_verify_mode: string␊ - environment: string␊ - [k: string]: unknown␊ - }␊ - runlist?: string␊ - client_rb?: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - validation_key: string␊ - chef_server_crt: string␊ - secret: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface DatadogLinuxAgent7 {␊ - publisher: "Datadog.Agent"␊ - type: "DatadogLinuxAgent"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - api_key: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface DatadogWindowsAgent7 {␊ - publisher: "Datadog.Agent"␊ - type: "DatadogWindowsAgent"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - api_key: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface DockerExtension7 {␊ - publisher: "Microsoft.Azure.Extensions"␊ - type: "DockerExtension"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - docker: {␊ - port: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - certs: {␊ - ca: string␊ - cert: string␊ - key: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface DynatraceLinux7 {␊ - publisher: "dynatrace.ruxit"␊ - type: "ruxitAgentLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - tenantId: string␊ - token: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface DynatraceWindows7 {␊ - publisher: "dynatrace.ruxit"␊ - type: "ruxitAgentWindows"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - tenantId: string␊ - token: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Eset7 {␊ - publisher: "ESET"␊ - type: "FileSecurity"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - LicenseKey: string␊ - "Install-RealtimeProtection": boolean␊ - "Install-ProtocolFiltering": boolean␊ - "Install-DeviceControl": boolean␊ - "Enable-Cloud": boolean␊ - "Enable-PUA": boolean␊ - ERAAgentCfgUrl: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface HpeSecurityApplicationDefender7 {␊ - publisher: "HPE.Security.ApplicationDefender"␊ - type: "DotnetAgent"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - protectedSettings: {␊ - key: string␊ - serverURL: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface PuppetAgent7 {␊ - publisher: "Puppet"␊ - type: "PuppetAgent"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - protectedSettings: {␊ - PUPPET_MASTER_SERVER: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Site24X7LinuxServerExtn7 {␊ - publisher: "Site24x7"␊ - type: "Site24x7LinuxServerExtn"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - site24x7AgentType?: "azurevmextnlinuxserver"␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - site24x7LicenseKey: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Site24X7WindowsServerExtn7 {␊ - publisher: "Site24x7"␊ - type: "Site24x7WindowsServerExtn"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - site24x7AgentType?: "azurevmextnwindowsserver"␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - site24x7LicenseKey: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface Site24X7ApmInsightExtn7 {␊ - publisher: "Site24x7"␊ - type: "Site24x7ApmInsightExtn"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - site24x7AgentType?: "azurevmextnapminsightclassic"␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - site24x7LicenseKey: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface TrendMicroDSALinux7 {␊ - publisher: "TrendMicro.DeepSecurity"␊ - type: "TrendMicroDSALinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - DSMname: string␊ - DSMport: string␊ - policyNameorID?: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - tenantID: string␊ - tenantPassword: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface TrendMicroDSA7 {␊ - publisher: "TrendMicro.DeepSecurity"␊ - type: "TrendMicroDSA"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - DSMname: string␊ - DSMport: string␊ - policyNameorID?: string␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - tenantID: string␊ - tenantPassword: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface BmcCtmAgentLinux7 {␊ - publisher: "ctm.bmc.com"␊ - type: "BmcCtmAgentLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - "Control-M Server Name": string␊ - "Agent Port": string␊ - "Host Group": string␊ - "User Account": string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface BmcCtmAgentWindows7 {␊ - publisher: "bmc.ctm"␊ - type: "AgentWinExt"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - "Control-M Server Name": string␊ - "Agent Port": string␊ - "Host Group": string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface OSPatchingForLinux7 {␊ - publisher: "Microsoft.OSTCExtensions"␊ - type: "OSPatchingForLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - disabled: boolean␊ - stop: boolean␊ - installDuration?: string␊ - intervalOfWeeks?: number␊ - dayOfWeek?: string␊ - startTime?: string␊ - rebootAfterPatch?: string␊ - category?: string␊ - oneoff?: boolean␊ - local?: boolean␊ - idleTestScript?: string␊ - healthyTestScript?: string␊ - distUpgradeList?: string␊ - distUpgradeAll?: boolean␊ - vmStatusTest?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - storageAccountName?: string␊ - storageAccountKey?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface VMSnapshot7 {␊ - publisher: "Microsoft.Azure.RecoveryServices"␊ - type: "VMSnapshot"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - locale: string␊ - taskId: string␊ - commandToExecute: string␊ - objectStr: string␊ - logsBlobUri: string␊ - statusBlobUri: string␊ - commandStartTimeUTCTicks: string␊ - vmType: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface VMSnapshotLinux7 {␊ - publisher: "Microsoft.Azure.RecoveryServices"␊ - type: "VMSnapshotLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - locale: string␊ - taskId: string␊ - commandToExecute: string␊ - objectStr: string␊ - logsBlobUri: string␊ - statusBlobUri: string␊ - commandStartTimeUTCTicks: string␊ - vmType: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface CustomScript7 {␊ - publisher: "Microsoft.Azure.Extensions"␊ - type: "CustomScript"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - settings: {␊ - fileUris: string[]␊ - [k: string]: unknown␊ - }␊ - protectedSettings: {␊ - storageAccountName: string␊ - storageAccountKey: string␊ - commandToExecute: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - export interface NetworkWatcherAgentWindows7 {␊ - publisher: "Microsoft.Azure.NetworkWatcher"␊ - type: "NetworkWatcherAgentWindows"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - [k: string]: unknown␊ - }␊ - export interface NetworkWatcherAgentLinux7 {␊ - publisher: "Microsoft.Azure.NetworkWatcher"␊ - type: "NetworkWatcherAgentLinux"␊ - typeHandlerVersion: string␊ - autoUpgradeMinorVersion: boolean␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/virtualMachineScaleSets␊ - */␊ - export interface VirtualMachineScaleSets7 {␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Identity for the virtual machine scale set.␊ - */␊ - identity?: (VirtualMachineScaleSetIdentity6 | string)␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the VM scale set to create or update.␊ - */␊ - name: string␊ - /**␊ - * 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**.␊ - */␊ - plan?: (Plan9 | string)␊ - /**␊ - * Describes the properties of a Virtual Machine Scale Set.␊ - */␊ - properties: (VirtualMachineScaleSetProperties6 | string)␊ - resources?: (VirtualMachineScaleSetsExtensionsChildResource5 | VirtualMachineScaleSetsVirtualmachinesChildResource4)[]␊ - /**␊ - * Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name.␊ - */␊ - sku?: (Sku69 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/virtualMachineScaleSets"␊ - /**␊ - * The virtual machine scale set zones. NOTE: Availability zones can only be set when you create the scale set.␊ - */␊ - zones?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the virtual machine scale set.␊ - */␊ - export interface VirtualMachineScaleSetIdentity6 {␊ - /**␊ - * The type of identity used for the virtual machine scale set. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine scale set.␊ - */␊ - type?: (("SystemAssigned" | "UserAssigned" | "SystemAssigned, UserAssigned" | "None") | string)␊ - /**␊ - * The list of user identities associated with the virtual machine scale set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.␊ - */␊ - userAssignedIdentities?: ({␊ - [k: string]: VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue3␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - export interface VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue3 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the properties of a Virtual Machine Scale Set.␊ - */␊ - export interface VirtualMachineScaleSetProperties6 {␊ - /**␊ - * Enables or disables a capability on the virtual machine or virtual machine scale set.␊ - */␊ - additionalCapabilities?: (AdditionalCapabilities3 | string)␊ - /**␊ - * Specifies the configuration parameters for automatic repairs on the virtual machine scale set.␊ - */␊ - automaticRepairsPolicy?: (AutomaticRepairsPolicy2 | string)␊ - /**␊ - * When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs.␊ - */␊ - doNotRunExtensionsOnOverprovisionedVMs?: (boolean | string)␊ - /**␊ - * Specifies whether the Virtual Machine Scale Set should be overprovisioned.␊ - */␊ - overprovision?: (boolean | string)␊ - /**␊ - * Fault Domain count for each placement group.␊ - */␊ - platformFaultDomainCount?: (number | string)␊ - proximityPlacementGroup?: (SubResource42 | string)␊ - /**␊ - * Describes a scale-in policy for a virtual machine scale set.␊ - */␊ - scaleInPolicy?: (ScaleInPolicy1 | string)␊ - /**␊ - * When true this limits the scale set to a single placement group, of max size 100 virtual machines.␊ - */␊ - singlePlacementGroup?: (boolean | string)␊ - /**␊ - * Describes an upgrade policy - automatic, manual, or rolling.␊ - */␊ - upgradePolicy?: (UpgradePolicy7 | string)␊ - /**␊ - * Describes a virtual machine scale set virtual machine profile.␊ - */␊ - virtualMachineProfile?: (VirtualMachineScaleSetVMProfile6 | string)␊ - /**␊ - * Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage.␊ - */␊ - zoneBalance?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the configuration parameters for automatic repairs on the virtual machine scale set.␊ - */␊ - export interface AutomaticRepairsPolicy2 {␊ - /**␊ - * Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * The amount of time for which automatic repairs are suspended due to a state change on VM. The grace time starts after the state change has completed. This helps avoid premature or accidental repairs. The time duration should be specified in ISO 8601 format. The minimum allowed grace period is 30 minutes (PT30M), which is also the default value. The maximum allowed grace period is 90 minutes (PT90M).␊ - */␊ - gracePeriod?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a scale-in policy for a virtual machine scale set.␊ - */␊ - export interface ScaleInPolicy1 {␊ - /**␊ - * The rules to be followed when scaling-in a virtual machine scale set.

    Possible values are:

    **Default** When a virtual machine scale set is scaled in, the scale set will first be balanced across zones if it is a zonal scale set. Then, it will be balanced across Fault Domains as far as possible. Within each Fault Domain, the virtual machines chosen for removal will be the newest ones that are not protected from scale-in.

    **OldestVM** When a virtual machine scale set is being scaled-in, the oldest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the oldest virtual machines that are not protected will be chosen for removal.

    **NewestVM** When a virtual machine scale set is being scaled-in, the newest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the newest virtual machines that are not protected will be chosen for removal.

    ␊ - */␊ - rules?: (("Default" | "OldestVM" | "NewestVM")[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes an upgrade policy - automatic, manual, or rolling.␊ - */␊ - export interface UpgradePolicy7 {␊ - /**␊ - * The configuration parameters used for performing automatic OS upgrade.␊ - */␊ - automaticOSUpgradePolicy?: (AutomaticOSUpgradePolicy2 | string)␊ - /**␊ - * 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.␊ - */␊ - mode?: (("Automatic" | "Manual" | "Rolling") | string)␊ - /**␊ - * The configuration parameters used while performing a rolling upgrade.␊ - */␊ - rollingUpgradePolicy?: (RollingUpgradePolicy5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The configuration parameters used for performing automatic OS upgrade.␊ - */␊ - export interface AutomaticOSUpgradePolicy2 {␊ - /**␊ - * Whether OS image rollback feature should be disabled. Default value is false.␊ - */␊ - disableAutomaticRollback?: (boolean | string)␊ - /**␊ - * Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. Default value is false.

    If this is set to true for Windows based scale sets, [enableAutomaticUpdates](https://docs.microsoft.com/dotnet/api/microsoft.azure.management.compute.models.windowsconfiguration.enableautomaticupdates?view=azure-dotnet) is automatically set to false and cannot be set to true.␊ - */␊ - enableAutomaticOSUpgrade?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The configuration parameters used while performing a rolling upgrade.␊ - */␊ - export interface RollingUpgradePolicy5 {␊ - /**␊ - * 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%.␊ - */␊ - maxBatchInstancePercent?: (number | string)␊ - /**␊ - * 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%.␊ - */␊ - maxUnhealthyInstancePercent?: (number | string)␊ - /**␊ - * 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%.␊ - */␊ - maxUnhealthyUpgradedInstancePercent?: (number | string)␊ - /**␊ - * 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).␊ - */␊ - pauseTimeBetweenBatches?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set virtual machine profile.␊ - */␊ - export interface VirtualMachineScaleSetVMProfile6 {␊ - /**␊ - * Specifies the billing related details of a Azure Spot VM or VMSS.

    Minimum api-version: 2019-03-01.␊ - */␊ - billingProfile?: (BillingProfile1 | string)␊ - /**␊ - * Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15.␊ - */␊ - diagnosticsProfile?: (DiagnosticsProfile6 | string)␊ - /**␊ - * Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set.

    For Azure Spot virtual machines, the only supported value is 'Deallocate' and the minimum api-version is 2019-03-01.

    For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview.␊ - */␊ - evictionPolicy?: (("Deallocate" | "Delete") | string)␊ - /**␊ - * Describes a virtual machine scale set extension profile.␊ - */␊ - extensionProfile?: (VirtualMachineScaleSetExtensionProfile7 | string)␊ - /**␊ - * 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␊ - */␊ - licenseType?: string␊ - /**␊ - * Describes a virtual machine scale set network profile.␊ - */␊ - networkProfile?: (VirtualMachineScaleSetNetworkProfile7 | string)␊ - /**␊ - * Describes a virtual machine scale set OS profile.␊ - */␊ - osProfile?: (VirtualMachineScaleSetOSProfile6 | string)␊ - /**␊ - * Specifies the priority for the virtual machines in the scale set.

    Minimum api-version: 2017-10-30-preview.␊ - */␊ - priority?: (("Regular" | "Low" | "Spot") | string)␊ - scheduledEventsProfile?: (ScheduledEventsProfile1 | string)␊ - /**␊ - * Describes a virtual machine scale set storage profile.␊ - */␊ - storageProfile?: (VirtualMachineScaleSetStorageProfile7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set extension profile.␊ - */␊ - export interface VirtualMachineScaleSetExtensionProfile7 {␊ - /**␊ - * The virtual machine scale set child extension resources.␊ - */␊ - extensions?: (VirtualMachineScaleSetExtension7[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a Virtual Machine Scale Set Extension.␊ - */␊ - export interface VirtualMachineScaleSetExtension7 {␊ - /**␊ - * The name of the extension.␊ - */␊ - name?: string␊ - properties?: (GenericExtension7 | IaaSDiagnostics7 | IaaSAntimalware7 | CustomScriptExtension7 | CustomScriptForLinux7 | LinuxDiagnostic7 | VmAccessForLinux7 | BgInfo7 | VmAccessAgent7 | DscExtension7 | AcronisBackupLinux7 | AcronisBackup7 | LinuxChefClient7 | ChefClient7 | DatadogLinuxAgent7 | DatadogWindowsAgent7 | DockerExtension7 | DynatraceLinux7 | DynatraceWindows7 | Eset7 | HpeSecurityApplicationDefender7 | PuppetAgent7 | Site24X7LinuxServerExtn7 | Site24X7WindowsServerExtn7 | Site24X7ApmInsightExtn7 | TrendMicroDSALinux7 | TrendMicroDSA7 | BmcCtmAgentLinux7 | BmcCtmAgentWindows7 | OSPatchingForLinux7 | VMSnapshot7 | VMSnapshotLinux7 | CustomScript7 | NetworkWatcherAgentWindows7 | NetworkWatcherAgentLinux7)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set network profile.␊ - */␊ - export interface VirtualMachineScaleSetNetworkProfile7 {␊ - /**␊ - * The API entity reference.␊ - */␊ - healthProbe?: (ApiEntityReference6 | string)␊ - /**␊ - * The list of network configurations.␊ - */␊ - networkInterfaceConfigurations?: (VirtualMachineScaleSetNetworkConfiguration6[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The API entity reference.␊ - */␊ - export interface ApiEntityReference6 {␊ - /**␊ - * The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set network profile's network configurations.␊ - */␊ - export interface VirtualMachineScaleSetNetworkConfiguration6 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * The network configuration name.␊ - */␊ - name: string␊ - /**␊ - * Describes a virtual machine scale set network profile's IP configuration.␊ - */␊ - properties?: (VirtualMachineScaleSetNetworkConfigurationProperties6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set network profile's IP configuration.␊ - */␊ - export interface VirtualMachineScaleSetNetworkConfigurationProperties6 {␊ - /**␊ - * Describes a virtual machines scale sets network configuration's DNS settings.␊ - */␊ - dnsSettings?: (VirtualMachineScaleSetNetworkConfigurationDnsSettings5 | string)␊ - /**␊ - * Specifies whether the network interface is accelerated networking-enabled.␊ - */␊ - enableAcceleratedNetworking?: (boolean | string)␊ - /**␊ - * Whether IP forwarding enabled on this NIC.␊ - */␊ - enableIPForwarding?: (boolean | string)␊ - /**␊ - * Specifies the IP configurations of the network interface.␊ - */␊ - ipConfigurations: (VirtualMachineScaleSetIPConfiguration6[] | string)␊ - networkSecurityGroup?: (SubResource42 | string)␊ - /**␊ - * Specifies the primary network interface in case the virtual machine has more than 1 network interface.␊ - */␊ - primary?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machines scale sets network configuration's DNS settings.␊ - */␊ - export interface VirtualMachineScaleSetNetworkConfigurationDnsSettings5 {␊ - /**␊ - * List of DNS servers IP addresses␊ - */␊ - dnsServers?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set network profile's IP configuration.␊ - */␊ - export interface VirtualMachineScaleSetIPConfiguration6 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * The IP configuration name.␊ - */␊ - name: string␊ - /**␊ - * Describes a virtual machine scale set network profile's IP configuration properties.␊ - */␊ - properties?: (VirtualMachineScaleSetIPConfigurationProperties6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set network profile's IP configuration properties.␊ - */␊ - export interface VirtualMachineScaleSetIPConfigurationProperties6 {␊ - /**␊ - * 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.␊ - */␊ - applicationGatewayBackendAddressPools?: (SubResource42[] | string)␊ - /**␊ - * Specifies an array of references to application security group.␊ - */␊ - applicationSecurityGroups?: (SubResource42[] | string)␊ - /**␊ - * 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.␊ - */␊ - loadBalancerBackendAddressPools?: (SubResource42[] | string)␊ - /**␊ - * 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␊ - */␊ - loadBalancerInboundNatPools?: (SubResource42[] | string)␊ - /**␊ - * Specifies the primary network interface in case the virtual machine has more than 1 network interface.␊ - */␊ - primary?: (boolean | string)␊ - /**␊ - * 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'.␊ - */␊ - privateIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - /**␊ - * Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration␊ - */␊ - publicIPAddressConfiguration?: (VirtualMachineScaleSetPublicIPAddressConfiguration5 | string)␊ - /**␊ - * The API entity reference.␊ - */␊ - subnet?: (ApiEntityReference6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration␊ - */␊ - export interface VirtualMachineScaleSetPublicIPAddressConfiguration5 {␊ - /**␊ - * The publicIP address configuration name.␊ - */␊ - name: string␊ - /**␊ - * Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration␊ - */␊ - properties?: (VirtualMachineScaleSetPublicIPAddressConfigurationProperties5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration␊ - */␊ - export interface VirtualMachineScaleSetPublicIPAddressConfigurationProperties5 {␊ - /**␊ - * Describes a virtual machines scale sets network configuration's DNS settings.␊ - */␊ - dnsSettings?: (VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings5 | string)␊ - /**␊ - * The idle timeout of the public IP address.␊ - */␊ - idleTimeoutInMinutes?: (number | string)␊ - /**␊ - * The list of IP tags associated with the public IP address.␊ - */␊ - ipTags?: (VirtualMachineScaleSetIpTag3[] | string)␊ - /**␊ - * Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.␊ - */␊ - publicIPAddressVersion?: (("IPv4" | "IPv6") | string)␊ - publicIPPrefix?: (SubResource42 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machines scale sets network configuration's DNS settings.␊ - */␊ - export interface VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings5 {␊ - /**␊ - * 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␊ - */␊ - domainNameLabel: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contains the IP tag associated with the public IP address.␊ - */␊ - export interface VirtualMachineScaleSetIpTag3 {␊ - /**␊ - * IP tag type. Example: FirstPartyUsage.␊ - */␊ - ipTagType?: string␊ - /**␊ - * IP tag associated with the public IP. Example: SQL, Storage etc.␊ - */␊ - tag?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set OS profile.␊ - */␊ - export interface VirtualMachineScaleSetOSProfile6 {␊ - /**␊ - * 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)␊ - */␊ - adminPassword?: string␊ - /**␊ - * 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)␊ - */␊ - adminUsername?: string␊ - /**␊ - * 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.␊ - */␊ - computerNamePrefix?: string␊ - /**␊ - * 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)␊ - */␊ - customData?: string␊ - /**␊ - * 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).␊ - */␊ - linuxConfiguration?: (LinuxConfiguration7 | string)␊ - /**␊ - * Specifies set of certificates that should be installed onto the virtual machines in the scale set.␊ - */␊ - secrets?: (VaultSecretGroup6[] | string)␊ - /**␊ - * Specifies Windows operating system settings on the virtual machine.␊ - */␊ - windowsConfiguration?: (WindowsConfiguration8 | string)␊ - [k: string]: unknown␊ - }␊ - export interface ScheduledEventsProfile1 {␊ - terminateNotificationProfile?: (TerminateNotificationProfile1 | string)␊ - [k: string]: unknown␊ - }␊ - export interface TerminateNotificationProfile1 {␊ - /**␊ - * Specifies whether the Terminate Scheduled event is enabled or disabled.␊ - */␊ - enable?: (boolean | string)␊ - /**␊ - * Configurable length of time a Virtual Machine being deleted will have to potentially approve the Terminate Scheduled Event before the event is auto approved (timed out). The configuration must be specified in ISO 8601 format, the default value is 5 minutes (PT5M)␊ - */␊ - notBeforeTimeout?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set storage profile.␊ - */␊ - export interface VirtualMachineScaleSetStorageProfile7 {␊ - /**␊ - * 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).␊ - */␊ - dataDisks?: (VirtualMachineScaleSetDataDisk6[] | string)␊ - /**␊ - * 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. NOTE: Image reference publisher and offer can only be set when you create the scale set␊ - */␊ - imageReference?: (ImageReference10 | string)␊ - /**␊ - * Describes a virtual machine scale set operating system disk.␊ - */␊ - osDisk?: (VirtualMachineScaleSetOSDisk7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set data disk.␊ - */␊ - export interface VirtualMachineScaleSetDataDisk6 {␊ - /**␊ - * Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**.␊ - */␊ - caching?: (("None" | "ReadOnly" | "ReadWrite") | string)␊ - /**␊ - * The create option.␊ - */␊ - createOption: (("FromImage" | "Empty" | "Attach") | string)␊ - /**␊ - * Specifies the Read-Write IOPS for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB.␊ - */␊ - diskIOPSReadWrite?: (number | string)␊ - /**␊ - * Specifies the bandwidth in MB per second for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB.␊ - */␊ - diskMBpsReadWrite?: (number | string)␊ - /**␊ - * Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB␊ - */␊ - diskSizeGB?: (number | string)␊ - /**␊ - * 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.␊ - */␊ - lun: (number | string)␊ - /**␊ - * Describes the parameters of a ScaleSet managed disk.␊ - */␊ - managedDisk?: (VirtualMachineScaleSetManagedDiskParameters6 | string)␊ - /**␊ - * The disk name.␊ - */␊ - name?: string␊ - /**␊ - * Specifies whether writeAccelerator should be enabled or disabled on the disk.␊ - */␊ - writeAcceleratorEnabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the parameters of a ScaleSet managed disk.␊ - */␊ - export interface VirtualMachineScaleSetManagedDiskParameters6 {␊ - /**␊ - * Describes the parameter of customer managed disk encryption set resource id that can be specified for disk.

    NOTE: The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details.␊ - */␊ - diskEncryptionSet?: (DiskEncryptionSetParameters | string)␊ - /**␊ - * Specifies the storage account type for the managed disk. Managed OS disk storage account type can only be set when you create the scale set. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.␊ - */␊ - storageAccountType?: (("Standard_LRS" | "Premium_LRS" | "StandardSSD_LRS" | "UltraSSD_LRS") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set operating system disk.␊ - */␊ - export interface VirtualMachineScaleSetOSDisk7 {␊ - /**␊ - * Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**.␊ - */␊ - caching?: (("None" | "ReadOnly" | "ReadWrite") | string)␊ - /**␊ - * 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.␊ - */␊ - createOption: (("FromImage" | "Empty" | "Attach") | string)␊ - /**␊ - * Describes the parameters of ephemeral disk settings that can be specified for operating system disk.

    NOTE: The ephemeral disk settings can only be specified for managed disk.␊ - */␊ - diffDiskSettings?: (DiffDiskSettings3 | string)␊ - /**␊ - * Specifies the size of the operating system disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB␊ - */␊ - diskSizeGB?: (number | string)␊ - /**␊ - * Describes the uri of a disk.␊ - */␊ - image?: (VirtualHardDisk6 | string)␊ - /**␊ - * Describes the parameters of a ScaleSet managed disk.␊ - */␊ - managedDisk?: (VirtualMachineScaleSetManagedDiskParameters6 | string)␊ - /**␊ - * The disk name.␊ - */␊ - name?: string␊ - /**␊ - * 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**.␊ - */␊ - osType?: (("Windows" | "Linux") | string)␊ - /**␊ - * Specifies the container urls that are used to store operating system disks for the scale set.␊ - */␊ - vhdContainers?: (string[] | string)␊ - /**␊ - * Specifies whether writeAccelerator should be enabled or disabled on the disk.␊ - */␊ - writeAcceleratorEnabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/virtualMachineScaleSets/extensions␊ - */␊ - export interface VirtualMachineScaleSetsExtensionsChildResource5 {␊ - apiVersion: "2019-07-01"␊ - /**␊ - * The name of the VM scale set extension.␊ - */␊ - name: string␊ - /**␊ - * Describes the properties of a Virtual Machine Scale Set Extension.␊ - */␊ - properties: (VirtualMachineScaleSetExtensionProperties5 | string)␊ - type: "extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the properties of a Virtual Machine Scale Set Extension.␊ - */␊ - export interface VirtualMachineScaleSetExtensionProperties5 {␊ - /**␊ - * 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.␊ - */␊ - autoUpgradeMinorVersion?: (boolean | string)␊ - /**␊ - * 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.␊ - */␊ - forceUpdateTag?: string␊ - /**␊ - * The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.␊ - */␊ - protectedSettings?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Collection of extension names after which this extension needs to be provisioned.␊ - */␊ - provisionAfterExtensions?: (string[] | string)␊ - /**␊ - * The name of the extension handler publisher.␊ - */␊ - publisher?: string␊ - /**␊ - * Json formatted public settings for the extension.␊ - */␊ - settings?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the type of the extension; an example is "CustomScriptExtension".␊ - */␊ - type?: string␊ - /**␊ - * Specifies the version of the script handler.␊ - */␊ - typeHandlerVersion?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/virtualMachineScaleSets/virtualmachines␊ - */␊ - export interface VirtualMachineScaleSetsVirtualmachinesChildResource4 {␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The instance ID of the virtual machine.␊ - */␊ - name: string␊ - /**␊ - * 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**.␊ - */␊ - plan?: (Plan9 | string)␊ - /**␊ - * Describes the properties of a virtual machine scale set virtual machine.␊ - */␊ - properties: (VirtualMachineScaleSetVMProperties4 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "virtualmachines"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the properties of a virtual machine scale set virtual machine.␊ - */␊ - export interface VirtualMachineScaleSetVMProperties4 {␊ - /**␊ - * Enables or disables a capability on the virtual machine or virtual machine scale set.␊ - */␊ - additionalCapabilities?: (AdditionalCapabilities3 | string)␊ - availabilitySet?: (SubResource42 | string)␊ - /**␊ - * Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15.␊ - */␊ - diagnosticsProfile?: (DiagnosticsProfile6 | string)␊ - /**␊ - * Specifies the hardware settings for the virtual machine.␊ - */␊ - hardwareProfile?: (HardwareProfile9 | string)␊ - /**␊ - * 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␊ - */␊ - licenseType?: string␊ - /**␊ - * Specifies the network interfaces of the virtual machine.␊ - */␊ - networkProfile?: (NetworkProfile7 | string)␊ - /**␊ - * Describes a virtual machine scale set VM network profile.␊ - */␊ - networkProfileConfiguration?: (VirtualMachineScaleSetVMNetworkProfileConfiguration1 | string)␊ - /**␊ - * Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned.␊ - */␊ - osProfile?: (OSProfile6 | string)␊ - /**␊ - * The protection policy of a virtual machine scale set VM.␊ - */␊ - protectionPolicy?: (VirtualMachineScaleSetVMProtectionPolicy1 | string)␊ - /**␊ - * Specifies the storage settings for the virtual machine disks.␊ - */␊ - storageProfile?: (StorageProfile14 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a virtual machine scale set VM network profile.␊ - */␊ - export interface VirtualMachineScaleSetVMNetworkProfileConfiguration1 {␊ - /**␊ - * The list of network configurations.␊ - */␊ - networkInterfaceConfigurations?: (VirtualMachineScaleSetNetworkConfiguration6[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The protection policy of a virtual machine scale set VM.␊ - */␊ - export interface VirtualMachineScaleSetVMProtectionPolicy1 {␊ - /**␊ - * Indicates that the virtual machine scale set VM shouldn't be considered for deletion during a scale-in operation.␊ - */␊ - protectFromScaleIn?: (boolean | string)␊ - /**␊ - * Indicates that model updates or actions (including scale-in) initiated on the virtual machine scale set should not be applied to the virtual machine scale set VM.␊ - */␊ - protectFromScaleSetActions?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/virtualMachineScaleSets/virtualmachines␊ - */␊ - export interface VirtualMachineScaleSetsVirtualmachines3 {␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The instance ID of the virtual machine.␊ - */␊ - name: string␊ - /**␊ - * 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**.␊ - */␊ - plan?: (Plan9 | string)␊ - /**␊ - * Describes the properties of a virtual machine scale set virtual machine.␊ - */␊ - properties: (VirtualMachineScaleSetVMProperties4 | string)␊ - resources?: VirtualMachineScaleSetsVirtualMachinesExtensionsChildResource[]␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/virtualMachineScaleSets/virtualmachines"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions␊ - */␊ - export interface VirtualMachineScaleSetsVirtualMachinesExtensionsChildResource {␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the virtual machine extension.␊ - */␊ - name: string␊ - /**␊ - * Describes the properties of a Virtual Machine Extension.␊ - */␊ - properties: (VirtualMachineExtensionProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the properties of a Virtual Machine Extension.␊ - */␊ - export interface VirtualMachineExtensionProperties {␊ - /**␊ - * 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.␊ - */␊ - autoUpgradeMinorVersion?: (boolean | string)␊ - /**␊ - * How the extension handler should be forced to update even if the extension configuration has not changed.␊ - */␊ - forceUpdateTag?: string␊ - /**␊ - * The instance view of a virtual machine extension.␊ - */␊ - instanceView?: (VirtualMachineExtensionInstanceView | string)␊ - /**␊ - * The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.␊ - */␊ - protectedSettings?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The name of the extension handler publisher.␊ - */␊ - publisher?: string␊ - /**␊ - * Json formatted public settings for the extension.␊ - */␊ - settings?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the type of the extension; an example is "CustomScriptExtension".␊ - */␊ - type?: string␊ - /**␊ - * Specifies the version of the script handler.␊ - */␊ - typeHandlerVersion?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The instance view of a virtual machine extension.␊ - */␊ - export interface VirtualMachineExtensionInstanceView {␊ - /**␊ - * The virtual machine extension name.␊ - */␊ - name?: string␊ - /**␊ - * The resource status information.␊ - */␊ - statuses?: (InstanceViewStatus[] | string)␊ - /**␊ - * The resource status information.␊ - */␊ - substatuses?: (InstanceViewStatus[] | string)␊ - /**␊ - * Specifies the type of the extension; an example is "CustomScriptExtension".␊ - */␊ - type?: string␊ - /**␊ - * Specifies the version of the script handler.␊ - */␊ - typeHandlerVersion?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions␊ - */␊ - export interface VirtualMachineScaleSetsVirtualMachinesExtensions {␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the virtual machine extension.␊ - */␊ - name: string␊ - /**␊ - * Describes the properties of a Virtual Machine Extension.␊ - */␊ - properties: (VirtualMachineExtensionProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/virtualMachines/extensions␊ - */␊ - export interface VirtualMachinesExtensions6 {␊ - apiVersion: "2019-07-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the virtual machine extension.␊ - */␊ - name: string␊ - properties: (GenericExtension7 | IaaSDiagnostics7 | IaaSAntimalware7 | CustomScriptExtension7 | CustomScriptForLinux7 | LinuxDiagnostic7 | VmAccessForLinux7 | BgInfo7 | VmAccessAgent7 | DscExtension7 | AcronisBackupLinux7 | AcronisBackup7 | LinuxChefClient7 | ChefClient7 | DatadogLinuxAgent7 | DatadogWindowsAgent7 | DockerExtension7 | DynatraceLinux7 | DynatraceWindows7 | Eset7 | HpeSecurityApplicationDefender7 | PuppetAgent7 | Site24X7LinuxServerExtn7 | Site24X7WindowsServerExtn7 | Site24X7ApmInsightExtn7 | TrendMicroDSALinux7 | TrendMicroDSA7 | BmcCtmAgentLinux7 | BmcCtmAgentWindows7 | OSPatchingForLinux7 | VMSnapshot7 | VMSnapshotLinux7 | CustomScript7 | NetworkWatcherAgentWindows7 | NetworkWatcherAgentLinux7)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Compute/virtualMachines/extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Compute/virtualMachineScaleSets/extensions␊ - */␊ - export interface VirtualMachineScaleSetsExtensions4 {␊ - apiVersion: "2019-07-01"␊ - /**␊ - * The name of the VM scale set extension.␊ - */␊ - name: string␊ - properties: (GenericExtension7 | IaaSDiagnostics7 | IaaSAntimalware7 | CustomScriptExtension7 | CustomScriptForLinux7 | LinuxDiagnostic7 | VmAccessForLinux7 | BgInfo7 | VmAccessAgent7 | DscExtension7 | AcronisBackupLinux7 | AcronisBackup7 | LinuxChefClient7 | ChefClient7 | DatadogLinuxAgent7 | DatadogWindowsAgent7 | DockerExtension7 | DynatraceLinux7 | DynatraceWindows7 | Eset7 | HpeSecurityApplicationDefender7 | PuppetAgent7 | Site24X7LinuxServerExtn7 | Site24X7WindowsServerExtn7 | Site24X7ApmInsightExtn7 | TrendMicroDSALinux7 | TrendMicroDSA7 | BmcCtmAgentLinux7 | BmcCtmAgentWindows7 | OSPatchingForLinux7 | VMSnapshot7 | VMSnapshotLinux7 | CustomScript7 | NetworkWatcherAgentWindows7 | NetworkWatcherAgentLinux7)␊ - type: "Microsoft.Compute/virtualMachineScaleSets/extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.WindowsESU/multipleActivationKeys␊ - */␊ - export interface MultipleActivationKeys {␊ - apiVersion: "2019-09-16-preview"␊ - /**␊ - * The geo-location where the resource lives␊ - */␊ - location: string␊ - /**␊ - * The name of the MAK key.␊ - */␊ - name: string␊ - /**␊ - * MAK key specific properties.␊ - */␊ - properties: (MultipleActivationKeyProperties | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.WindowsESU/multipleActivationKeys"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * MAK key specific properties.␊ - */␊ - export interface MultipleActivationKeyProperties {␊ - /**␊ - * Agreement number under which the key is requested.␊ - */␊ - agreementNumber?: string␊ - /**␊ - * Number of activations/servers using the MAK key.␊ - */␊ - installedServerNumber?: (number | string)␊ - /**␊ - * true if user has eligible on-premises Windows physical or virtual machines, and that the requested key will only be used in their organization; false otherwise.␊ - */␊ - isEligible?: (boolean | string)␊ - /**␊ - * Type of OS for which the key is requested.␊ - */␊ - osType?: (("Windows7" | "WindowsServer2008" | "WindowsServer2008R2") | string)␊ - /**␊ - * Type of support.␊ - */␊ - supportType?: (("SupplementalServicing" | "PremiumAssurance") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Scheduler/jobCollections/jobs␊ - */␊ - export interface JobCollectionsJobs1 {␊ - apiVersion: "2014-08-01-preview"␊ - /**␊ - * The job name.␊ - */␊ - name: string␊ - properties: (JobProperties | string)␊ - type: "Microsoft.Scheduler/jobCollections/jobs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Scheduler/jobCollections␊ - */␊ - export interface JobCollections2 {␊ - apiVersion: "2016-01-01"␊ - /**␊ - * Gets or sets the storage account location.␊ - */␊ - location?: string␊ - /**␊ - * The job collection name.␊ - */␊ - name: string␊ - properties: (JobCollectionProperties2 | string)␊ - resources?: JobCollectionsJobsChildResource2[]␊ - /**␊ - * Gets or sets the tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Scheduler/jobCollections"␊ - [k: string]: unknown␊ - }␊ - export interface JobCollectionProperties2 {␊ - quota?: (JobCollectionQuota2 | string)␊ - sku?: (Sku70 | string)␊ - /**␊ - * Gets or sets the state.␊ - */␊ - state?: (("Enabled" | "Disabled" | "Suspended" | "Deleted") | string)␊ - [k: string]: unknown␊ - }␊ - export interface JobCollectionQuota2 {␊ - /**␊ - * Gets or set the maximum job count.␊ - */␊ - maxJobCount?: (number | string)␊ - /**␊ - * Gets or sets the maximum job occurrence.␊ - */␊ - maxJobOccurrence?: (number | string)␊ - maxRecurrence?: (JobMaxRecurrence2 | string)␊ - [k: string]: unknown␊ - }␊ - export interface JobMaxRecurrence2 {␊ - /**␊ - * Gets or sets the frequency of recurrence (second, minute, hour, day, week, month).␊ - */␊ - frequency?: (("Minute" | "Hour" | "Day" | "Week" | "Month") | string)␊ - /**␊ - * Gets or sets the interval between retries.␊ - */␊ - interval?: (number | string)␊ - [k: string]: unknown␊ - }␊ - export interface Sku70 {␊ - /**␊ - * Gets or set the SKU.␊ - */␊ - name?: (("Standard" | "Free" | "Premium") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Scheduler/jobCollections/jobs␊ - */␊ - export interface JobCollectionsJobsChildResource2 {␊ - apiVersion: "2016-01-01"␊ - /**␊ - * The job name.␊ - */␊ - name: string␊ - properties: (JobProperties4 | string)␊ - type: "jobs"␊ - [k: string]: unknown␊ - }␊ - export interface JobProperties4 {␊ - action?: (JobAction2 | string)␊ - recurrence?: (JobRecurrence2 | string)␊ - /**␊ - * Gets or sets the job start time.␊ - */␊ - startTime?: string␊ - /**␊ - * Gets or set the job state.␊ - */␊ - state?: (("Enabled" | "Disabled" | "Faulted" | "Completed") | string)␊ - [k: string]: unknown␊ - }␊ - export interface JobAction2 {␊ - errorAction?: (JobErrorAction2 | string)␊ - queueMessage?: (StorageQueueMessage2 | string)␊ - request?: (HttpRequest2 | string)␊ - retryPolicy?: (RetryPolicy8 | string)␊ - serviceBusQueueMessage?: (ServiceBusQueueMessage2 | string)␊ - serviceBusTopicMessage?: (ServiceBusTopicMessage2 | string)␊ - /**␊ - * Gets or sets the job action type.␊ - */␊ - type?: (("Http" | "Https" | "StorageQueue" | "ServiceBusQueue" | "ServiceBusTopic") | string)␊ - [k: string]: unknown␊ - }␊ - export interface JobErrorAction2 {␊ - queueMessage?: (StorageQueueMessage2 | string)␊ - request?: (HttpRequest2 | string)␊ - retryPolicy?: (RetryPolicy8 | string)␊ - serviceBusQueueMessage?: (ServiceBusQueueMessage2 | string)␊ - serviceBusTopicMessage?: (ServiceBusTopicMessage2 | string)␊ - /**␊ - * Gets or sets the job error action type.␊ - */␊ - type?: (("Http" | "Https" | "StorageQueue" | "ServiceBusQueue" | "ServiceBusTopic") | string)␊ - [k: string]: unknown␊ - }␊ - export interface StorageQueueMessage2 {␊ - /**␊ - * Gets or sets the message.␊ - */␊ - message?: string␊ - /**␊ - * Gets or sets the queue name.␊ - */␊ - queueName?: string␊ - /**␊ - * Gets or sets the SAS key.␊ - */␊ - sasToken?: string␊ - /**␊ - * Gets or sets the storage account name.␊ - */␊ - storageAccount?: string␊ - [k: string]: unknown␊ - }␊ - export interface HttpRequest2 {␊ - authentication?: (HttpAuthentication2 | string)␊ - /**␊ - * Gets or sets the request body.␊ - */␊ - body?: string␊ - /**␊ - * Gets or sets the headers.␊ - */␊ - headers?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Gets or sets the method of the request.␊ - */␊ - method?: string␊ - /**␊ - * Gets or sets the Uri.␊ - */␊ - uri?: string␊ - [k: string]: unknown␊ - }␊ - export interface HttpAuthentication2 {␊ - /**␊ - * Gets or sets the http authentication type.␊ - */␊ - type?: (("NotSpecified" | "ClientCertificate" | "ActiveDirectoryOAuth" | "Basic") | string)␊ - [k: string]: unknown␊ - }␊ - export interface RetryPolicy8 {␊ - /**␊ - * Gets or sets the number of times a retry should be attempted.␊ - */␊ - retryCount?: (number | string)␊ - /**␊ - * Gets or sets the retry interval between retries.␊ - */␊ - retryInterval?: string␊ - /**␊ - * Gets or sets the retry strategy to be used.␊ - */␊ - retryType?: (("None" | "Fixed") | string)␊ - [k: string]: unknown␊ - }␊ - export interface ServiceBusQueueMessage2 {␊ - authentication?: (ServiceBusAuthentication2 | string)␊ - brokeredMessageProperties?: (ServiceBusBrokeredMessageProperties2 | string)␊ - /**␊ - * Gets or sets the custom message properties.␊ - */␊ - customMessageProperties?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Gets or sets the message.␊ - */␊ - message?: string␊ - /**␊ - * Gets or sets the namespace.␊ - */␊ - namespace?: string␊ - /**␊ - * Gets or sets the queue name.␊ - */␊ - queueName?: string␊ - /**␊ - * Gets or sets the transport type.␊ - */␊ - transportType?: (("NotSpecified" | "NetMessaging" | "AMQP") | string)␊ - [k: string]: unknown␊ - }␊ - export interface ServiceBusAuthentication2 {␊ - /**␊ - * Gets or sets the SAS key.␊ - */␊ - sasKey?: string␊ - /**␊ - * Gets or sets the SAS key name.␊ - */␊ - sasKeyName?: string␊ - /**␊ - * Gets or sets the authentication type.␊ - */␊ - type?: (("NotSpecified" | "SharedAccessKey") | string)␊ - [k: string]: unknown␊ - }␊ - export interface ServiceBusBrokeredMessageProperties2 {␊ - /**␊ - * Gets or sets the content type.␊ - */␊ - contentType?: string␊ - /**␊ - * Gets or sets the correlation id.␊ - */␊ - correlationId?: string␊ - /**␊ - * Gets or sets the force persistence.␊ - */␊ - forcePersistence?: (boolean | string)␊ - /**␊ - * Gets or sets the label.␊ - */␊ - label?: string␊ - /**␊ - * Gets or sets the message id.␊ - */␊ - messageId?: string␊ - /**␊ - * Gets or sets the partition key.␊ - */␊ - partitionKey?: string␊ - /**␊ - * Gets or sets the reply to.␊ - */␊ - replyTo?: string␊ - /**␊ - * Gets or sets the reply to session id.␊ - */␊ - replyToSessionId?: string␊ - /**␊ - * Gets or sets the scheduled enqueue time UTC.␊ - */␊ - scheduledEnqueueTimeUtc?: string␊ - /**␊ - * Gets or sets the session id.␊ - */␊ - sessionId?: string␊ - /**␊ - * Gets or sets the time to live.␊ - */␊ - timeToLive?: string␊ - /**␊ - * Gets or sets the to.␊ - */␊ - to?: string␊ - /**␊ - * Gets or sets the via partition key.␊ - */␊ - viaPartitionKey?: string␊ - [k: string]: unknown␊ - }␊ - export interface ServiceBusTopicMessage2 {␊ - authentication?: (ServiceBusAuthentication2 | string)␊ - brokeredMessageProperties?: (ServiceBusBrokeredMessageProperties2 | string)␊ - /**␊ - * Gets or sets the custom message properties.␊ - */␊ - customMessageProperties?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Gets or sets the message.␊ - */␊ - message?: string␊ - /**␊ - * Gets or sets the namespace.␊ - */␊ - namespace?: string␊ - /**␊ - * Gets or sets the topic path.␊ - */␊ - topicPath?: string␊ - /**␊ - * Gets or sets the transport type.␊ - */␊ - transportType?: (("NotSpecified" | "NetMessaging" | "AMQP") | string)␊ - [k: string]: unknown␊ - }␊ - export interface JobRecurrence2 {␊ - /**␊ - * Gets or sets the maximum number of times that the job should run.␊ - */␊ - count?: (number | string)␊ - /**␊ - * Gets or sets the time at which the job will complete.␊ - */␊ - endTime?: string␊ - /**␊ - * Gets or sets the frequency of recurrence (second, minute, hour, day, week, month).␊ - */␊ - frequency?: (("Minute" | "Hour" | "Day" | "Week" | "Month") | string)␊ - /**␊ - * Gets or sets the interval between retries.␊ - */␊ - interval?: (number | string)␊ - schedule?: (JobRecurrenceSchedule2 | string)␊ - [k: string]: unknown␊ - }␊ - export interface JobRecurrenceSchedule2 {␊ - /**␊ - * Gets or sets the hours of the day that the job should execute at.␊ - */␊ - hours?: (number[] | string)␊ - /**␊ - * Gets or sets the minutes of the hour that the job should execute at.␊ - */␊ - minutes?: (number[] | string)␊ - /**␊ - * Gets or sets the days of the month that the job should execute on. Must be between 1 and 31.␊ - */␊ - monthDays?: (number[] | string)␊ - /**␊ - * Gets or sets the occurrences of days within a month.␊ - */␊ - monthlyOccurrences?: (JobRecurrenceScheduleMonthlyOccurrence2[] | string)␊ - /**␊ - * Gets or sets the days of the week that the job should execute on.␊ - */␊ - weekDays?: (("Sunday" | "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday")[] | string)␊ - [k: string]: unknown␊ - }␊ - export interface JobRecurrenceScheduleMonthlyOccurrence2 {␊ - /**␊ - * Gets or sets the day. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.␊ - */␊ - day?: (("Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday" | "Sunday") | string)␊ - /**␊ - * Gets or sets the occurrence. Must be between -5 and 5.␊ - */␊ - Occurrence?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Scheduler/jobCollections/jobs␊ - */␊ - export interface JobCollectionsJobs2 {␊ - apiVersion: "2016-01-01"␊ - /**␊ - * The job name.␊ - */␊ - name: string␊ - properties: (JobProperties4 | string)␊ - type: "Microsoft.Scheduler/jobCollections/jobs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Search/searchServices␊ - */␊ - export interface SearchServices1 {␊ - apiVersion: "2015-02-28"␊ - /**␊ - * The geographic location of the Search service.␊ - */␊ - location?: string␊ - /**␊ - * The name of the Search service to create or update.␊ - */␊ - name: string␊ - /**␊ - * Defines properties of an Azure Search service that can be modified.␊ - */␊ - properties: (SearchServiceProperties1 | string)␊ - /**␊ - * Tags to help categorize the Search service in the Azure Portal.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Search/searchServices"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines properties of an Azure Search service that can be modified.␊ - */␊ - export interface SearchServiceProperties1 {␊ - /**␊ - * The number of partitions in the Search service; if specified, it can be 1, 2, 3, 4, 6, or 12.␊ - */␊ - partitionCount?: (number | string)␊ - /**␊ - * The number of replicas in the Search service. If specified, it must be a value between 1 and 6 inclusive.␊ - */␊ - replicaCount?: (number | string)␊ - /**␊ - * Defines the SKU of an Azure Search Service, which determines price tier and capacity limits.␊ - */␊ - sku?: (Sku71 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines the SKU of an Azure Search Service, which determines price tier and capacity limits.␊ - */␊ - export interface Sku71 {␊ - /**␊ - * The SKU of the Search service.␊ - */␊ - name?: (("free" | "standard" | "standard2") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Search/searchServices␊ - */␊ - export interface SearchServices2 {␊ - apiVersion: "2019-10-01-preview"␊ - /**␊ - * Identity for the resource.␊ - */␊ - identity?: (Identity25 | string)␊ - /**␊ - * The geographic location of the resource. This must be one of the supported and registered Azure Geo Regions (for example, West US, East US, Southeast Asia, and so forth). This property is required when creating a new resource.␊ - */␊ - location?: string␊ - /**␊ - * The name of the Azure Cognitive Search service to create or update. Search service names must only contain lowercase letters, digits or dashes, cannot use dash as the first two or last one characters, cannot contain consecutive dashes, and must be between 2 and 60 characters in length. Search service names must be globally unique since they are part of the service URI (https://.search.windows.net). You cannot change the service name after the service is created.␊ - */␊ - name: string␊ - /**␊ - * Properties of the Search service.␊ - */␊ - properties: (SearchServiceProperties2 | string)␊ - resources?: SearchServicesPrivateEndpointConnectionsChildResource[]␊ - /**␊ - * Defines the SKU of an Azure Cognitive Search Service, which determines price tier and capacity limits.␊ - */␊ - sku?: (Sku72 | string)␊ - /**␊ - * Tags to help categorize the resource in the Azure portal.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Search/searchServices"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the resource.␊ - */␊ - export interface Identity25 {␊ - /**␊ - * The identity type.␊ - */␊ - type: (("None" | "SystemAssigned") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of the Search service.␊ - */␊ - export interface SearchServiceProperties2 {␊ - /**␊ - * Applicable only for the standard3 SKU. You can set this property to enable up to 3 high density partitions that allow up to 1000 indexes, which is much higher than the maximum indexes allowed for any other SKU. For the standard3 SKU, the value is either 'default' or 'highDensity'. For all other SKUs, this value must be 'default'.␊ - */␊ - hostingMode?: (("default" | "highDensity") | string)␊ - /**␊ - * Network specific rules that determine how the Azure Cognitive Search service may be reached.␊ - */␊ - networkRuleSet?: (NetworkRuleSet14 | string)␊ - /**␊ - * The number of partitions in the Search service; if specified, it can be 1, 2, 3, 4, 6, or 12. Values greater than 1 are only valid for standard SKUs. For 'standard3' services with hostingMode set to 'highDensity', the allowed values are between 1 and 3.␊ - */␊ - partitionCount?: ((number & string) | string)␊ - /**␊ - * The number of replicas in the Search service. If specified, it must be a value between 1 and 12 inclusive for standard SKUs or between 1 and 3 inclusive for basic SKU.␊ - */␊ - replicaCount?: ((number & string) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network specific rules that determine how the Azure Cognitive Search service may be reached.␊ - */␊ - export interface NetworkRuleSet14 {␊ - /**␊ - * The level of access to the search service endpoint. Public, the search service endpoint is reachable from the internet. Private, the search service endpoint can only be accessed via private endpoints. Default is Public.␊ - */␊ - endpointAccess?: (("Public" | "Private") | string)␊ - /**␊ - * A list of IP restriction rules that defines the inbound network access to the search service endpoint. These restriction rules are applied only when the EndpointAccess of the search service is Public.␊ - */␊ - ipRules?: (IpRule1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The IP restriction rule of the Azure Cognitive Search service.␊ - */␊ - export interface IpRule1 {␊ - /**␊ - * Value corresponding to a single IPv4 address (eg., 123.1.2.3) or an IP range in CIDR format (eg., 123.1.2.3/24) to be allowed.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Search/searchServices/privateEndpointConnections␊ - */␊ - export interface SearchServicesPrivateEndpointConnectionsChildResource {␊ - apiVersion: "2019-10-01-preview"␊ - /**␊ - * The ID of the private endpoint connection. This can be used with the Azure Resource Manager to link resources together.␊ - */␊ - id?: string␊ - /**␊ - * The name of the private endpoint connection to the Azure Cognitive Search service with the specified resource group.␊ - */␊ - name: string␊ - /**␊ - * Describes the properties of an existing Private Endpoint connection to the Azure Cognitive Search service.␊ - */␊ - properties: (PrivateEndpointConnectionProperties20 | string)␊ - type: "privateEndpointConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the properties of an existing Private Endpoint connection to the Azure Cognitive Search service.␊ - */␊ - export interface PrivateEndpointConnectionProperties20 {␊ - /**␊ - * The private endpoint resource from Microsoft.Network provider.␊ - */␊ - privateEndpoint?: (PrivateEndpointConnectionPropertiesPrivateEndpoint | string)␊ - /**␊ - * Describes the current state of an existing Private Link Service connection to the Azure Private Endpoint.␊ - */␊ - privateLinkServiceConnectionState?: (PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The private endpoint resource from Microsoft.Network provider.␊ - */␊ - export interface PrivateEndpointConnectionPropertiesPrivateEndpoint {␊ - /**␊ - * The resource id of the private endpoint resource from Microsoft.Network provider.␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the current state of an existing Private Link Service connection to the Azure Private Endpoint.␊ - */␊ - export interface PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState {␊ - /**␊ - * A description of any extra actions that may be required.␊ - */␊ - actionsRequired?: string␊ - /**␊ - * The description for the private link service connection state.␊ - */␊ - description?: string␊ - /**␊ - * Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected.␊ - */␊ - status?: (("Pending" | "Approved" | "Rejected" | "Disconnected") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines the SKU of an Azure Cognitive Search Service, which determines price tier and capacity limits.␊ - */␊ - export interface Sku72 {␊ - /**␊ - * The SKU of the Search service. Valid values include: 'free': Shared service. 'basic': Dedicated service with up to 3 replicas. 'standard': Dedicated service with up to 12 partitions and 12 replicas. 'standard2': Similar to standard, but with more capacity per search unit. 'standard3': The largest Standard offering with up to 12 partitions and 12 replicas (or up to 3 partitions with more indexes if you also set the hostingMode property to 'highDensity'). 'storage_optimized_l1': Supports 1TB per partition, up to 12 partitions. 'storage_optimized_l2': Supports 2TB per partition, up to 12 partitions.'.␊ - */␊ - name?: (("free" | "basic" | "standard" | "standard2" | "standard3" | "storage_optimized_l1" | "storage_optimized_l2") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Search/searchServices/privateEndpointConnections␊ - */␊ - export interface SearchServicesPrivateEndpointConnections {␊ - apiVersion: "2019-10-01-preview"␊ - /**␊ - * The ID of the private endpoint connection. This can be used with the Azure Resource Manager to link resources together.␊ - */␊ - id?: string␊ - /**␊ - * The name of the private endpoint connection to the Azure Cognitive Search service with the specified resource group.␊ - */␊ - name: string␊ - /**␊ - * Describes the properties of an existing Private Endpoint connection to the Azure Cognitive Search service.␊ - */␊ - properties: (PrivateEndpointConnectionProperties20 | string)␊ - type: "Microsoft.Search/searchServices/privateEndpointConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Synapse/workspaces␊ - */␊ - export interface Workspaces10 {␊ - apiVersion: "2019-06-01-preview"␊ - /**␊ - * The workspace managed identity␊ - */␊ - identity?: (ManagedIdentity | string)␊ - /**␊ - * The geo-location where the resource lives␊ - */␊ - location: string␊ - /**␊ - * The name of the workspace␊ - */␊ - name: string␊ - /**␊ - * Workspace properties␊ - */␊ - properties: (WorkspaceProperties10 | string)␊ - resources?: (WorkspacesBigDataPoolsChildResource | WorkspacesFirewallRulesChildResource | WorkspacesSqlPoolsChildResource | WorkspacesAdministratorsChildResource | WorkspacesSqlAdministratorsChildResource | WorkspacesManagedIdentitySqlControlSettingsChildResource | WorkspacesIntegrationRuntimesChildResource | WorkspacesPrivateEndpointConnectionsChildResource1 | WorkspacesAuditingSettingsChildResource | WorkspacesExtendedAuditingSettingsChildResource | WorkspacesSecurityAlertPoliciesChildResource | WorkspacesVulnerabilityAssessmentsChildResource | WorkspacesKeysChildResource)[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Synapse/workspaces"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The workspace managed identity␊ - */␊ - export interface ManagedIdentity {␊ - /**␊ - * The type of managed identity for the workspace.␊ - */␊ - type?: (("None" | "SystemAssigned") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Workspace properties␊ - */␊ - export interface WorkspaceProperties10 {␊ - /**␊ - * Connectivity endpoints␊ - */␊ - connectivityEndpoints?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Details of the data lake storage account associated with the workspace␊ - */␊ - defaultDataLakeStorage?: (DataLakeStorageAccountDetails | string)␊ - /**␊ - * Details of the encryption associated with the workspace␊ - */␊ - encryption?: (EncryptionDetails | string)␊ - /**␊ - * Workspace managed resource group. The resource group name uniquely identifies the resource group within the user subscriptionId. The resource group name must be no longer than 90 characters long, and must be alphanumeric characters (Char.IsLetterOrDigit()) and '-', '_', '(', ')' and'.'. Note that the name cannot end with '.'␊ - */␊ - managedResourceGroupName?: string␊ - /**␊ - * Setting this to 'default' will ensure that all compute for this workspace is in a virtual network managed on behalf of the user.␊ - */␊ - managedVirtualNetwork?: string␊ - /**␊ - * Managed Virtual Network Settings␊ - */␊ - managedVirtualNetworkSettings?: (ManagedVirtualNetworkSettings | string)␊ - /**␊ - * Private endpoint connections to the workspace␊ - */␊ - privateEndpointConnections?: (PrivateEndpointConnection1[] | string)␊ - /**␊ - * Purview Configuration␊ - */␊ - purviewConfiguration?: (PurviewConfiguration1 | string)␊ - /**␊ - * Login for workspace SQL active directory administrator␊ - */␊ - sqlAdministratorLogin?: string␊ - /**␊ - * SQL administrator login password␊ - */␊ - sqlAdministratorLoginPassword?: string␊ - /**␊ - * Virtual Network Profile␊ - */␊ - virtualNetworkProfile?: (VirtualNetworkProfile2 | string)␊ - /**␊ - * Git integration settings␊ - */␊ - workspaceRepositoryConfiguration?: (WorkspaceRepositoryConfiguration | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Details of the data lake storage account associated with the workspace␊ - */␊ - export interface DataLakeStorageAccountDetails {␊ - /**␊ - * Account URL␊ - */␊ - accountUrl?: string␊ - /**␊ - * Filesystem name␊ - */␊ - filesystem?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Details of the encryption associated with the workspace␊ - */␊ - export interface EncryptionDetails {␊ - /**␊ - * Details of the customer managed key associated with the workspace␊ - */␊ - cmk?: (CustomerManagedKeyDetails | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Details of the customer managed key associated with the workspace␊ - */␊ - export interface CustomerManagedKeyDetails {␊ - /**␊ - * Details of the customer managed key associated with the workspace␊ - */␊ - key?: (WorkspaceKeyDetails | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Details of the customer managed key associated with the workspace␊ - */␊ - export interface WorkspaceKeyDetails {␊ - /**␊ - * Workspace Key sub-resource key vault url␊ - */␊ - keyVaultUrl?: string␊ - /**␊ - * Workspace Key sub-resource name␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Managed Virtual Network Settings␊ - */␊ - export interface ManagedVirtualNetworkSettings {␊ - /**␊ - * Allowed Aad Tenant Ids For Linking␊ - */␊ - allowedAadTenantIdsForLinking?: (string[] | string)␊ - /**␊ - * Linked Access Check On Target Resource␊ - */␊ - linkedAccessCheckOnTargetResource?: (boolean | string)␊ - /**␊ - * Prevent Data Exfiltration␊ - */␊ - preventDataExfiltration?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A private endpoint connection␊ - */␊ - export interface PrivateEndpointConnection1 {␊ - /**␊ - * Properties of a private endpoint connection.␊ - */␊ - properties?: (PrivateEndpointConnectionProperties21 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a private endpoint connection.␊ - */␊ - export interface PrivateEndpointConnectionProperties21 {␊ - /**␊ - * Private endpoint details␊ - */␊ - privateEndpoint?: (PrivateEndpoint9 | string)␊ - /**␊ - * Connection state details of the private endpoint␊ - */␊ - privateLinkServiceConnectionState?: (PrivateLinkServiceConnectionState17 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Private endpoint details␊ - */␊ - export interface PrivateEndpoint9 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Connection state details of the private endpoint␊ - */␊ - export interface PrivateLinkServiceConnectionState17 {␊ - /**␊ - * The private link service connection description.␊ - */␊ - description?: string␊ - /**␊ - * The private link service connection status.␊ - */␊ - status?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Purview Configuration␊ - */␊ - export interface PurviewConfiguration1 {␊ - /**␊ - * Purview Resource ID␊ - */␊ - purviewResourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Virtual Network Profile␊ - */␊ - export interface VirtualNetworkProfile2 {␊ - /**␊ - * Subnet ID used for computes in workspace␊ - */␊ - computeSubnetId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Git integration settings␊ - */␊ - export interface WorkspaceRepositoryConfiguration {␊ - /**␊ - * Account name␊ - */␊ - accountName?: string␊ - /**␊ - * GitHub bring your own app client id␊ - */␊ - clientId?: string␊ - /**␊ - * Client secret information for factory's bring your own app repository configuration␊ - */␊ - clientSecret?: (GitHubClientSecret1 | string)␊ - /**␊ - * Collaboration branch␊ - */␊ - collaborationBranch?: string␊ - /**␊ - * GitHub Enterprise host name. For example: https://github.mydomain.com␊ - */␊ - hostName?: string␊ - /**␊ - * The last commit ID␊ - */␊ - lastCommitId?: string␊ - /**␊ - * VSTS project name␊ - */␊ - projectName?: string␊ - /**␊ - * Repository name␊ - */␊ - repositoryName?: string␊ - /**␊ - * Root folder to use in the repository␊ - */␊ - rootFolder?: string␊ - /**␊ - * The VSTS tenant ID␊ - */␊ - tenantId?: string␊ - /**␊ - * Type of workspace repositoryID configuration. Example WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Client secret information for factory's bring your own app repository configuration␊ - */␊ - export interface GitHubClientSecret1 {␊ - /**␊ - * Bring your own app client secret AKV URL␊ - */␊ - byoaSecretAkvUrl?: string␊ - /**␊ - * Bring your own app client secret name in AKV␊ - */␊ - byoaSecretName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Synapse/workspaces/bigDataPools␊ - */␊ - export interface WorkspacesBigDataPoolsChildResource {␊ - apiVersion: "2019-06-01-preview"␊ - /**␊ - * The geo-location where the resource lives␊ - */␊ - location: string␊ - /**␊ - * Big Data pool name␊ - */␊ - name: string␊ - /**␊ - * Properties of a Big Data pool powered by Apache Spark␊ - */␊ - properties: (BigDataPoolResourceProperties | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "bigDataPools"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a Big Data pool powered by Apache Spark␊ - */␊ - export interface BigDataPoolResourceProperties {␊ - /**␊ - * Auto-pausing properties of a Big Data pool powered by Apache Spark␊ - */␊ - autoPause?: (AutoPauseProperties | string)␊ - /**␊ - * Auto-scaling properties of a Big Data pool powered by Apache Spark␊ - */␊ - autoScale?: (AutoScaleProperties | string)␊ - /**␊ - * The cache size␊ - */␊ - cacheSize?: (number | string)␊ - /**␊ - * The time when the Big Data pool was created.␊ - */␊ - creationDate?: string␊ - /**␊ - * List of custom libraries/packages associated with the spark pool.␊ - */␊ - customLibraries?: (LibraryInfo[] | string)␊ - /**␊ - * The default folder where Spark logs will be written.␊ - */␊ - defaultSparkLogFolder?: string␊ - /**␊ - * Dynamic Executor Allocation Properties␊ - */␊ - dynamicExecutorAllocation?: (DynamicExecutorAllocation | string)␊ - /**␊ - * Whether compute isolation is required or not.␊ - */␊ - isComputeIsolationEnabled?: (boolean | string)␊ - /**␊ - * Library requirements for a Big Data pool powered by Apache Spark␊ - */␊ - libraryRequirements?: (LibraryRequirements | string)␊ - /**␊ - * The number of nodes in the Big Data pool.␊ - */␊ - nodeCount?: (number | string)␊ - /**␊ - * The level of compute power that each node in the Big Data pool has.␊ - */␊ - nodeSize?: (("None" | "Small" | "Medium" | "Large" | "XLarge" | "XXLarge" | "XXXLarge") | string)␊ - /**␊ - * The kind of nodes that the Big Data pool provides.␊ - */␊ - nodeSizeFamily?: (("None" | "MemoryOptimized") | string)␊ - /**␊ - * The state of the Big Data pool.␊ - */␊ - provisioningState?: string␊ - /**␊ - * Whether session level packages enabled.␊ - */␊ - sessionLevelPackagesEnabled?: (boolean | string)␊ - /**␊ - * Library requirements for a Big Data pool powered by Apache Spark␊ - */␊ - sparkConfigProperties?: (LibraryRequirements | string)␊ - /**␊ - * The Spark events folder␊ - */␊ - sparkEventsFolder?: string␊ - /**␊ - * The Apache Spark version.␊ - */␊ - sparkVersion?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Auto-pausing properties of a Big Data pool powered by Apache Spark␊ - */␊ - export interface AutoPauseProperties {␊ - /**␊ - * Number of minutes of idle time before the Big Data pool is automatically paused.␊ - */␊ - delayInMinutes?: (number | string)␊ - /**␊ - * Whether auto-pausing is enabled for the Big Data pool.␊ - */␊ - enabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Auto-scaling properties of a Big Data pool powered by Apache Spark␊ - */␊ - export interface AutoScaleProperties {␊ - /**␊ - * Whether automatic scaling is enabled for the Big Data pool.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * The maximum number of nodes the Big Data pool can support.␊ - */␊ - maxNodeCount?: (number | string)␊ - /**␊ - * The minimum number of nodes the Big Data pool can support.␊ - */␊ - minNodeCount?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Library/package information of a Big Data pool powered by Apache Spark␊ - */␊ - export interface LibraryInfo {␊ - /**␊ - * Storage blob container name.␊ - */␊ - containerName?: string␊ - /**␊ - * Name of the library.␊ - */␊ - name?: string␊ - /**␊ - * Storage blob path of library.␊ - */␊ - path?: string␊ - /**␊ - * Type of the library.␊ - */␊ - type?: string␊ - /**␊ - * The last update time of the library.␊ - */␊ - uploadedTimestamp?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Dynamic Executor Allocation Properties␊ - */␊ - export interface DynamicExecutorAllocation {␊ - /**␊ - * Indicates whether Dynamic Executor Allocation is enabled or not.␊ - */␊ - enabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Library requirements for a Big Data pool powered by Apache Spark␊ - */␊ - export interface LibraryRequirements {␊ - /**␊ - * The library requirements.␊ - */␊ - content?: string␊ - /**␊ - * The filename of the library requirements file.␊ - */␊ - filename?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Synapse/workspaces/firewallRules␊ - */␊ - export interface WorkspacesFirewallRulesChildResource {␊ - apiVersion: "2019-06-01-preview"␊ - /**␊ - * The IP firewall rule name␊ - */␊ - name: string␊ - /**␊ - * IP firewall rule properties␊ - */␊ - properties: (IpFirewallRuleProperties | string)␊ - type: "firewallRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP firewall rule properties␊ - */␊ - export interface IpFirewallRuleProperties {␊ - /**␊ - * The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress␊ - */␊ - endIpAddress?: string␊ - /**␊ - * The start IP address of the firewall rule. Must be IPv4 format␊ - */␊ - startIpAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Synapse/workspaces/sqlPools␊ - */␊ - export interface WorkspacesSqlPoolsChildResource {␊ - apiVersion: "2019-06-01-preview"␊ - /**␊ - * The geo-location where the resource lives␊ - */␊ - location: string␊ - /**␊ - * SQL pool name␊ - */␊ - name: string␊ - /**␊ - * Properties of a SQL Analytics pool␊ - */␊ - properties: (SqlPoolResourceProperties | string)␊ - /**␊ - * SQL pool SKU␊ - */␊ - sku?: (Sku73 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "sqlPools"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a SQL Analytics pool␊ - */␊ - export interface SqlPoolResourceProperties {␊ - /**␊ - * Collation mode␊ - */␊ - collation?: string␊ - /**␊ - * Specifies the mode of sql pool creation.␊ - * ␊ - * Default: regular sql pool creation.␊ - * ␊ - * PointInTimeRestore: Creates a sql pool by restoring a point in time backup of an existing sql pool. sourceDatabaseId must be specified as the resource ID of the existing sql pool, and restorePointInTime must be specified.␊ - * ␊ - * Recovery: Creates a sql pool by a geo-replicated backup. sourceDatabaseId must be specified as the recoverableDatabaseId to restore.␊ - * ␊ - * Restore: Creates a sql pool by restoring a backup of a deleted sql pool. SourceDatabaseId should be the sql pool's original resource ID. SourceDatabaseId and sourceDatabaseDeletionDate must be specified.␊ - */␊ - createMode?: (("Default" | "PointInTimeRestore" | "Recovery" | "Restore") | string)␊ - /**␊ - * Date the SQL pool was created␊ - */␊ - creationDate?: string␊ - /**␊ - * Maximum size in bytes␊ - */␊ - maxSizeBytes?: (number | string)␊ - /**␊ - * Resource state␊ - */␊ - provisioningState?: string␊ - /**␊ - * Backup database to restore from␊ - */␊ - recoverableDatabaseId?: string␊ - /**␊ - * Snapshot time to restore␊ - */␊ - restorePointInTime?: string␊ - /**␊ - * Source database to create from␊ - */␊ - sourceDatabaseId?: string␊ - /**␊ - * Resource status␊ - */␊ - status?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SQL pool SKU␊ - */␊ - export interface Sku73 {␊ - /**␊ - * If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.␊ - */␊ - capacity?: (number | string)␊ - /**␊ - * The SKU name␊ - */␊ - name?: string␊ - /**␊ - * The service tier␊ - */␊ - tier?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Synapse/workspaces/administrators␊ - */␊ - export interface WorkspacesAdministratorsChildResource {␊ - apiVersion: "2019-06-01-preview"␊ - name: "activeDirectory"␊ - /**␊ - * Workspace active directory administrator properties␊ - */␊ - properties: (AadAdminProperties | string)␊ - type: "administrators"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Workspace active directory administrator properties␊ - */␊ - export interface AadAdminProperties {␊ - /**␊ - * Workspace active directory administrator type␊ - */␊ - administratorType?: string␊ - /**␊ - * Login of the workspace active directory administrator␊ - */␊ - login?: string␊ - /**␊ - * Object ID of the workspace active directory administrator␊ - */␊ - sid?: string␊ - /**␊ - * Tenant ID of the workspace active directory administrator␊ - */␊ - tenantId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Synapse/workspaces/sqlAdministrators␊ - */␊ - export interface WorkspacesSqlAdministratorsChildResource {␊ - apiVersion: "2019-06-01-preview"␊ - name: "activeDirectory"␊ - /**␊ - * Workspace active directory administrator properties␊ - */␊ - properties: (AadAdminProperties | string)␊ - type: "sqlAdministrators"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Synapse/workspaces/managedIdentitySqlControlSettings␊ - */␊ - export interface WorkspacesManagedIdentitySqlControlSettingsChildResource {␊ - apiVersion: "2019-06-01-preview"␊ - name: "default"␊ - /**␊ - * Sql Control Settings for workspace managed identity␊ - */␊ - properties: (ManagedIdentitySqlControlSettingsModelProperties | string)␊ - type: "managedIdentitySqlControlSettings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Sql Control Settings for workspace managed identity␊ - */␊ - export interface ManagedIdentitySqlControlSettingsModelProperties {␊ - /**␊ - * Grant sql control to managed identity␊ - */␊ - grantSqlControlToManagedIdentity?: (ManagedIdentitySqlControlSettingsModelPropertiesGrantSqlControlToManagedIdentity | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Grant sql control to managed identity␊ - */␊ - export interface ManagedIdentitySqlControlSettingsModelPropertiesGrantSqlControlToManagedIdentity {␊ - /**␊ - * Desired state.␊ - */␊ - desiredState?: (("Enabled" | "Disabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Synapse/workspaces/integrationRuntimes␊ - */␊ - export interface WorkspacesIntegrationRuntimesChildResource {␊ - apiVersion: "2019-06-01-preview"␊ - /**␊ - * Integration runtime name␊ - */␊ - name: string␊ - /**␊ - * Azure Synapse nested object which serves as a compute resource for activities.␊ - */␊ - properties: (IntegrationRuntime2 | string)␊ - type: "integrationRuntimes"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Managed integration runtime, including managed elastic and managed dedicated integration runtimes.␊ - */␊ - export interface ManagedIntegrationRuntime2 {␊ - /**␊ - * Managed Virtual Network reference type.␊ - */␊ - managedVirtualNetwork?: (ManagedVirtualNetworkReference1 | string)␊ - type: "Managed"␊ - /**␊ - * Managed integration runtime type properties.␊ - */␊ - typeProperties: (ManagedIntegrationRuntimeTypeProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Managed Virtual Network reference type.␊ - */␊ - export interface ManagedVirtualNetworkReference1 {␊ - /**␊ - * Reference ManagedVirtualNetwork name.␊ - */␊ - referenceName: string␊ - /**␊ - * Managed Virtual Network reference type.␊ - */␊ - type: ("ManagedVirtualNetworkReference" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Managed integration runtime type properties.␊ - */␊ - export interface ManagedIntegrationRuntimeTypeProperties2 {␊ - /**␊ - * The compute resource properties for managed integration runtime.␊ - */␊ - computeProperties?: (IntegrationRuntimeComputeProperties2 | string)␊ - /**␊ - * SSIS properties for managed integration runtime.␊ - */␊ - ssisProperties?: (IntegrationRuntimeSsisProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The compute resource properties for managed integration runtime.␊ - */␊ - export interface IntegrationRuntimeComputeProperties2 {␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Data flow properties for managed integration runtime.␊ - */␊ - dataFlowProperties?: (IntegrationRuntimeDataFlowProperties1 | string)␊ - /**␊ - * The location for managed integration runtime. The supported regions could be found on https://docs.microsoft.com/en-us/azure/data-factory/data-factory-data-movement-activities␊ - */␊ - location?: string␊ - /**␊ - * Maximum parallel executions count per node for managed integration runtime.␊ - */␊ - maxParallelExecutionsPerNode?: (number | string)␊ - /**␊ - * The node size requirement to managed integration runtime.␊ - */␊ - nodeSize?: string␊ - /**␊ - * The required number of nodes for managed integration runtime.␊ - */␊ - numberOfNodes?: (number | string)␊ - /**␊ - * VNet properties for managed integration runtime.␊ - */␊ - vNetProperties?: (IntegrationRuntimeVNetProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Data flow properties for managed integration runtime.␊ - */␊ - export interface IntegrationRuntimeDataFlowProperties1 {␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Cluster will not be recycled and it will be used in next data flow activity run until TTL (time to live) is reached if this is set as false. Default is true.␊ - */␊ - cleanup?: (boolean | string)␊ - /**␊ - * Compute type of the cluster which will execute data flow job.␊ - */␊ - computeType?: (("General" | "MemoryOptimized" | "ComputeOptimized") | string)␊ - /**␊ - * Core count of the cluster which will execute data flow job. Supported values are: 8, 16, 32, 48, 80, 144 and 272.␊ - */␊ - coreCount?: (number | string)␊ - /**␊ - * Time to live (in minutes) setting of the cluster which will execute data flow job.␊ - */␊ - timeToLive?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VNet properties for managed integration runtime.␊ - */␊ - export interface IntegrationRuntimeVNetProperties2 {␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Resource IDs of the public IP addresses that this integration runtime will use.␊ - */␊ - publicIPs?: (string[] | string)␊ - /**␊ - * The name of the subnet this integration runtime will join.␊ - */␊ - subnet?: string␊ - /**␊ - * The ID of the VNet that this integration runtime will join.␊ - */␊ - vNetId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSIS properties for managed integration runtime.␊ - */␊ - export interface IntegrationRuntimeSsisProperties2 {␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Catalog information for managed dedicated integration runtime.␊ - */␊ - catalogInfo?: (IntegrationRuntimeSsisCatalogInfo2 | string)␊ - /**␊ - * Custom setup script properties for a managed dedicated integration runtime.␊ - */␊ - customSetupScriptProperties?: (IntegrationRuntimeCustomSetupScriptProperties2 | string)␊ - /**␊ - * Data proxy properties for a managed dedicated integration runtime.␊ - */␊ - dataProxyProperties?: (IntegrationRuntimeDataProxyProperties2 | string)␊ - /**␊ - * The edition for the SSIS Integration Runtime.␊ - */␊ - edition?: (("Standard" | "Enterprise") | string)␊ - /**␊ - * Custom setup without script properties for a SSIS integration runtime.␊ - */␊ - expressCustomSetupProperties?: (CustomSetupBase1[] | string)␊ - /**␊ - * License type for bringing your own license scenario.␊ - */␊ - licenseType?: (("BasePrice" | "LicenseIncluded") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Catalog information for managed dedicated integration runtime.␊ - */␊ - export interface IntegrationRuntimeSsisCatalogInfo2 {␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Azure Synapse secure string definition. The string value will be masked with asterisks '*' during Get or List API calls.␊ - */␊ - catalogAdminPassword?: (SecureString2 | string)␊ - /**␊ - * The administrator user name of catalog database.␊ - */␊ - catalogAdminUserName?: string␊ - /**␊ - * The pricing tier for the catalog database. The valid values could be found in https://azure.microsoft.com/en-us/pricing/details/sql-database/.␊ - */␊ - catalogPricingTier?: (("Basic" | "Standard" | "Premium" | "PremiumRS") | string)␊ - /**␊ - * The catalog database server URL.␊ - */␊ - catalogServerEndpoint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Synapse secure string definition. The string value will be masked with asterisks '*' during Get or List API calls.␊ - */␊ - export interface SecureString2 {␊ - type: "SecureString"␊ - /**␊ - * Value of secure string.␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Custom setup script properties for a managed dedicated integration runtime.␊ - */␊ - export interface IntegrationRuntimeCustomSetupScriptProperties2 {␊ - /**␊ - * The URI of the Azure blob container that contains the custom setup script.␊ - */␊ - blobContainerUri?: string␊ - /**␊ - * Azure Synapse secure string definition. The string value will be masked with asterisks '*' during Get or List API calls.␊ - */␊ - sasToken?: (SecureString2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Data proxy properties for a managed dedicated integration runtime.␊ - */␊ - export interface IntegrationRuntimeDataProxyProperties2 {␊ - /**␊ - * The entity reference.␊ - */␊ - connectVia?: (EntityReference2 | string)␊ - /**␊ - * The path to contain the staged data in the Blob storage.␊ - */␊ - path?: string␊ - /**␊ - * The entity reference.␊ - */␊ - stagingLinkedService?: (EntityReference2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The entity reference.␊ - */␊ - export interface EntityReference2 {␊ - /**␊ - * The name of this referenced entity.␊ - */␊ - referenceName?: string␊ - /**␊ - * The type of this referenced entity.␊ - */␊ - type?: (("IntegrationRuntimeReference" | "LinkedServiceReference") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The custom setup of running cmdkey commands.␊ - */␊ - export interface CmdkeySetup1 {␊ - type: "CmdkeySetup"␊ - /**␊ - * Cmdkey command custom setup type properties.␊ - */␊ - typeProperties: (CmdkeySetupTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Cmdkey command custom setup type properties.␊ - */␊ - export interface CmdkeySetupTypeProperties1 {␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - password: (SecretBase2 | string)␊ - /**␊ - * The server name of data source access.␊ - */␊ - targetName: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The user name of data source access.␊ - */␊ - userName: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The custom setup of setting environment variable.␊ - */␊ - export interface EnvironmentVariableSetup1 {␊ - type: "EnvironmentVariableSetup"␊ - /**␊ - * Environment variable custom setup type properties.␊ - */␊ - typeProperties: (EnvironmentVariableSetupTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Environment variable custom setup type properties.␊ - */␊ - export interface EnvironmentVariableSetupTypeProperties1 {␊ - /**␊ - * The name of the environment variable.␊ - */␊ - variableName: string␊ - /**␊ - * The value of the environment variable.␊ - */␊ - variableValue: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The custom setup of installing 3rd party components.␊ - */␊ - export interface ComponentSetup1 {␊ - type: "ComponentSetup"␊ - /**␊ - * Installation of licensed component setup type properties.␊ - */␊ - typeProperties: (LicensedComponentSetupTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Installation of licensed component setup type properties.␊ - */␊ - export interface LicensedComponentSetupTypeProperties1 {␊ - /**␊ - * The name of the 3rd party component.␊ - */␊ - componentName: string␊ - /**␊ - * The base definition of a secret type.␊ - */␊ - licenseKey?: (SecureString2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Self-hosted integration runtime.␊ - */␊ - export interface SelfHostedIntegrationRuntime2 {␊ - type: "SelfHosted"␊ - /**␊ - * The self-hosted integration runtime properties.␊ - */␊ - typeProperties?: (SelfHostedIntegrationRuntimeTypeProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The self-hosted integration runtime properties.␊ - */␊ - export interface SelfHostedIntegrationRuntimeTypeProperties1 {␊ - /**␊ - * The base definition of a linked integration runtime.␊ - */␊ - linkedInfo?: (LinkedIntegrationRuntimeType1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The key authorization type integration runtime.␊ - */␊ - export interface LinkedIntegrationRuntimeKeyAuthorization1 {␊ - authorizationType: "Key"␊ - /**␊ - * Azure Synapse secure string definition. The string value will be masked with asterisks '*' during Get or List API calls.␊ - */␊ - key: (SecureString2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The role based access control (RBAC) authorization type integration runtime.␊ - */␊ - export interface LinkedIntegrationRuntimeRbacAuthorization1 {␊ - authorizationType: "RBAC"␊ - /**␊ - * The resource identifier of the integration runtime to be shared.␊ - */␊ - resourceId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Synapse/workspaces/privateEndpointConnections␊ - */␊ - export interface WorkspacesPrivateEndpointConnectionsChildResource1 {␊ - apiVersion: "2019-06-01-preview"␊ - /**␊ - * The name of the private endpoint connection.␊ - */␊ - name: string␊ - /**␊ - * Properties of a private endpoint connection.␊ - */␊ - properties: (PrivateEndpointConnectionProperties21 | string)␊ - type: "privateEndpointConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Synapse/workspaces/auditingSettings␊ - */␊ - export interface WorkspacesAuditingSettingsChildResource {␊ - apiVersion: "2019-06-01-preview"␊ - /**␊ - * The name of the blob auditing policy.␊ - */␊ - name: "default"␊ - /**␊ - * Properties of a server blob auditing policy.␊ - */␊ - properties: (ServerBlobAuditingPolicyProperties1 | string)␊ - type: "auditingSettings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a server blob auditing policy.␊ - */␊ - export interface ServerBlobAuditingPolicyProperties1 {␊ - /**␊ - * Specifies the Actions-Groups and Actions to audit.␍␊ - * ␍␊ - * The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins:␍␊ - * ␍␊ - * BATCH_COMPLETED_GROUP,␍␊ - * SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP,␍␊ - * FAILED_DATABASE_AUTHENTICATION_GROUP.␍␊ - * ␍␊ - * This above combination is also the set that is configured by default when enabling auditing from the Azure portal.␍␊ - * ␍␊ - * The supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records):␍␊ - * ␍␊ - * APPLICATION_ROLE_CHANGE_PASSWORD_GROUP␍␊ - * BACKUP_RESTORE_GROUP␍␊ - * DATABASE_LOGOUT_GROUP␍␊ - * DATABASE_OBJECT_CHANGE_GROUP␍␊ - * DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP␍␊ - * DATABASE_OBJECT_PERMISSION_CHANGE_GROUP␍␊ - * DATABASE_OPERATION_GROUP␍␊ - * DATABASE_PERMISSION_CHANGE_GROUP␍␊ - * DATABASE_PRINCIPAL_CHANGE_GROUP␍␊ - * DATABASE_PRINCIPAL_IMPERSONATION_GROUP␍␊ - * DATABASE_ROLE_MEMBER_CHANGE_GROUP␍␊ - * FAILED_DATABASE_AUTHENTICATION_GROUP␍␊ - * SCHEMA_OBJECT_ACCESS_GROUP␍␊ - * SCHEMA_OBJECT_CHANGE_GROUP␍␊ - * SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP␍␊ - * SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP␍␊ - * SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP␍␊ - * USER_CHANGE_PASSWORD_GROUP␍␊ - * BATCH_STARTED_GROUP␍␊ - * BATCH_COMPLETED_GROUP␍␊ - * ␍␊ - * These are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs.␍␊ - * ␍␊ - * For more information, see [Database-Level Audit Action Groups](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups).␍␊ - * ␍␊ - * For Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are:␍␊ - * SELECT␍␊ - * UPDATE␍␊ - * INSERT␍␊ - * DELETE␍␊ - * EXECUTE␍␊ - * RECEIVE␍␊ - * REFERENCES␍␊ - * ␍␊ - * The general form for defining an action to be audited is:␍␊ - * {action} ON {object} BY {principal}␍␊ - * ␍␊ - * Note that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively.␍␊ - * ␍␊ - * For example:␍␊ - * SELECT on dbo.myTable by public␍␊ - * SELECT on DATABASE::myDatabase by public␍␊ - * SELECT on SCHEMA::mySchema by public␍␊ - * ␍␊ - * For more information, see [Database-Level Audit Actions](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions)␊ - */␊ - auditActionsAndGroups?: (string[] | string)␊ - /**␊ - * Specifies whether audit events are sent to Azure Monitor. ␍␊ - * In order to send the events to Azure Monitor, specify 'state' as 'Enabled' and 'isAzureMonitorTargetEnabled' as true.␍␊ - * ␍␊ - * When using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created.␍␊ - * Note that for server level audit you should use the 'master' database as {databaseName}.␍␊ - * ␍␊ - * Diagnostic Settings URI format:␍␊ - * PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview␍␊ - * ␍␊ - * For more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207)␍␊ - * or [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043)␍␊ - * ␊ - */␊ - isAzureMonitorTargetEnabled?: (boolean | string)␊ - /**␊ - * Specifies whether storageAccountAccessKey value is the storage's secondary key.␊ - */␊ - isStorageSecondaryKeyInUse?: (boolean | string)␊ - /**␊ - * Specifies the amount of time in milliseconds that can elapse before audit actions are forced to be processed.␍␊ - * The default minimum value is 1000 (1 second). The maximum is 2,147,483,647.␊ - */␊ - queueDelayMs?: (number | string)␊ - /**␊ - * Specifies the number of days to keep in the audit logs in the storage account.␊ - */␊ - retentionDays?: (number | string)␊ - /**␊ - * Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required.␊ - */␊ - state: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Specifies the identifier key of the auditing storage account. ␍␊ - * If state is Enabled and storageEndpoint is specified, not specifying the storageAccountAccessKey will use SQL server system-assigned managed identity to access the storage.␍␊ - * Prerequisites for using managed identity authentication:␍␊ - * 1. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD).␍␊ - * 2. Grant SQL Server identity access to the storage account by adding 'Storage Blob Data Contributor' RBAC role to the server identity.␍␊ - * For more information, see [Auditing to storage using Managed Identity authentication](https://go.microsoft.com/fwlink/?linkid=2114355)␊ - */␊ - storageAccountAccessKey?: string␊ - /**␊ - * Specifies the blob storage subscription Id.␊ - */␊ - storageAccountSubscriptionId?: string␊ - /**␊ - * Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required.␊ - */␊ - storageEndpoint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Synapse/workspaces/extendedAuditingSettings␊ - */␊ - export interface WorkspacesExtendedAuditingSettingsChildResource {␊ - apiVersion: "2019-06-01-preview"␊ - /**␊ - * The name of the blob auditing policy.␊ - */␊ - name: "default"␊ - /**␊ - * Properties of an extended server blob auditing policy.␊ - */␊ - properties: (ExtendedServerBlobAuditingPolicyProperties1 | string)␊ - type: "extendedAuditingSettings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of an extended server blob auditing policy.␊ - */␊ - export interface ExtendedServerBlobAuditingPolicyProperties1 {␊ - /**␊ - * Specifies the Actions-Groups and Actions to audit.␍␊ - * ␍␊ - * The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins:␍␊ - * ␍␊ - * BATCH_COMPLETED_GROUP,␍␊ - * SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP,␍␊ - * FAILED_DATABASE_AUTHENTICATION_GROUP.␍␊ - * ␍␊ - * This above combination is also the set that is configured by default when enabling auditing from the Azure portal.␍␊ - * ␍␊ - * The supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records):␍␊ - * ␍␊ - * APPLICATION_ROLE_CHANGE_PASSWORD_GROUP␍␊ - * BACKUP_RESTORE_GROUP␍␊ - * DATABASE_LOGOUT_GROUP␍␊ - * DATABASE_OBJECT_CHANGE_GROUP␍␊ - * DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP␍␊ - * DATABASE_OBJECT_PERMISSION_CHANGE_GROUP␍␊ - * DATABASE_OPERATION_GROUP␍␊ - * DATABASE_PERMISSION_CHANGE_GROUP␍␊ - * DATABASE_PRINCIPAL_CHANGE_GROUP␍␊ - * DATABASE_PRINCIPAL_IMPERSONATION_GROUP␍␊ - * DATABASE_ROLE_MEMBER_CHANGE_GROUP␍␊ - * FAILED_DATABASE_AUTHENTICATION_GROUP␍␊ - * SCHEMA_OBJECT_ACCESS_GROUP␍␊ - * SCHEMA_OBJECT_CHANGE_GROUP␍␊ - * SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP␍␊ - * SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP␍␊ - * SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP␍␊ - * USER_CHANGE_PASSWORD_GROUP␍␊ - * BATCH_STARTED_GROUP␍␊ - * BATCH_COMPLETED_GROUP␍␊ - * ␍␊ - * These are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs.␍␊ - * ␍␊ - * For more information, see [Database-Level Audit Action Groups](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups).␍␊ - * ␍␊ - * For Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are:␍␊ - * SELECT␍␊ - * UPDATE␍␊ - * INSERT␍␊ - * DELETE␍␊ - * EXECUTE␍␊ - * RECEIVE␍␊ - * REFERENCES␍␊ - * ␍␊ - * The general form for defining an action to be audited is:␍␊ - * {action} ON {object} BY {principal}␍␊ - * ␍␊ - * Note that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively.␍␊ - * ␍␊ - * For example:␍␊ - * SELECT on dbo.myTable by public␍␊ - * SELECT on DATABASE::myDatabase by public␍␊ - * SELECT on SCHEMA::mySchema by public␍␊ - * ␍␊ - * For more information, see [Database-Level Audit Actions](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions)␊ - */␊ - auditActionsAndGroups?: (string[] | string)␊ - /**␊ - * Specifies whether audit events are sent to Azure Monitor. ␍␊ - * In order to send the events to Azure Monitor, specify 'state' as 'Enabled' and 'isAzureMonitorTargetEnabled' as true.␍␊ - * ␍␊ - * When using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created.␍␊ - * Note that for server level audit you should use the 'master' database as {databaseName}.␍␊ - * ␍␊ - * Diagnostic Settings URI format:␍␊ - * PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview␍␊ - * ␍␊ - * For more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207)␍␊ - * or [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043)␍␊ - * ␊ - */␊ - isAzureMonitorTargetEnabled?: (boolean | string)␊ - /**␊ - * Specifies whether storageAccountAccessKey value is the storage's secondary key.␊ - */␊ - isStorageSecondaryKeyInUse?: (boolean | string)␊ - /**␊ - * Specifies condition of where clause when creating an audit.␊ - */␊ - predicateExpression?: string␊ - /**␊ - * Specifies the amount of time in milliseconds that can elapse before audit actions are forced to be processed.␍␊ - * The default minimum value is 1000 (1 second). The maximum is 2,147,483,647.␊ - */␊ - queueDelayMs?: (number | string)␊ - /**␊ - * Specifies the number of days to keep in the audit logs in the storage account.␊ - */␊ - retentionDays?: (number | string)␊ - /**␊ - * Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required.␊ - */␊ - state: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Specifies the identifier key of the auditing storage account. ␍␊ - * If state is Enabled and storageEndpoint is specified, not specifying the storageAccountAccessKey will use SQL server system-assigned managed identity to access the storage.␍␊ - * Prerequisites for using managed identity authentication:␍␊ - * 1. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD).␍␊ - * 2. Grant SQL Server identity access to the storage account by adding 'Storage Blob Data Contributor' RBAC role to the server identity.␍␊ - * For more information, see [Auditing to storage using Managed Identity authentication](https://go.microsoft.com/fwlink/?linkid=2114355)␊ - */␊ - storageAccountAccessKey?: string␊ - /**␊ - * Specifies the blob storage subscription Id.␊ - */␊ - storageAccountSubscriptionId?: string␊ - /**␊ - * Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required.␊ - */␊ - storageEndpoint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Synapse/workspaces/securityAlertPolicies␊ - */␊ - export interface WorkspacesSecurityAlertPoliciesChildResource {␊ - apiVersion: "2019-06-01-preview"␊ - /**␊ - * The name of the security alert policy.␊ - */␊ - name: "default"␊ - /**␊ - * Properties of a security alert policy.␊ - */␊ - properties: (ServerSecurityAlertPolicyProperties | string)␊ - type: "securityAlertPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a security alert policy.␊ - */␊ - export interface ServerSecurityAlertPolicyProperties {␊ - /**␊ - * Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action␊ - */␊ - disabledAlerts?: (string[] | string)␊ - /**␊ - * Specifies that the alert is sent to the account administrators.␊ - */␊ - emailAccountAdmins?: (boolean | string)␊ - /**␊ - * Specifies an array of e-mail addresses to which the alert is sent.␊ - */␊ - emailAddresses?: (string[] | string)␊ - /**␊ - * Specifies the number of days to keep in the Threat Detection audit logs.␊ - */␊ - retentionDays?: (number | string)␊ - /**␊ - * Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific server.␊ - */␊ - state: (("New" | "Enabled" | "Disabled") | string)␊ - /**␊ - * Specifies the identifier key of the Threat Detection audit storage account.␊ - */␊ - storageAccountAccessKey?: string␊ - /**␊ - * Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.␊ - */␊ - storageEndpoint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Synapse/workspaces/vulnerabilityAssessments␊ - */␊ - export interface WorkspacesVulnerabilityAssessmentsChildResource {␊ - apiVersion: "2019-06-01-preview"␊ - /**␊ - * The name of the vulnerability assessment.␊ - */␊ - name: "default"␊ - /**␊ - * Properties of a server Vulnerability Assessment.␊ - */␊ - properties: (ServerVulnerabilityAssessmentProperties1 | string)␊ - type: "vulnerabilityAssessments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a server Vulnerability Assessment.␊ - */␊ - export interface ServerVulnerabilityAssessmentProperties1 {␊ - /**␊ - * Properties of a Vulnerability Assessment recurring scans.␊ - */␊ - recurringScans?: (VulnerabilityAssessmentRecurringScansProperties3 | string)␊ - /**␊ - * Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required.␊ - */␊ - storageAccountAccessKey?: string␊ - /**␊ - * A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/).␊ - */␊ - storageContainerPath: string␊ - /**␊ - * A shared access signature (SAS Key) that has read and write access to the blob container specified in 'storageContainerPath' parameter. If 'storageAccountAccessKey' isn't specified, StorageContainerSasKey is required.␊ - */␊ - storageContainerSasKey?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a Vulnerability Assessment recurring scans.␊ - */␊ - export interface VulnerabilityAssessmentRecurringScansProperties3 {␊ - /**␊ - * Specifies an array of e-mail addresses to which the scan notification is sent.␊ - */␊ - emails?: (string[] | string)␊ - /**␊ - * Specifies that the schedule scan notification will be is sent to the subscription administrators.␊ - */␊ - emailSubscriptionAdmins?: (boolean | string)␊ - /**␊ - * Recurring scans state.␊ - */␊ - isEnabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Synapse/workspaces/keys␊ - */␊ - export interface WorkspacesKeysChildResource {␊ - apiVersion: "2019-06-01-preview"␊ - /**␊ - * The name of the workspace key␊ - */␊ - name: string␊ - /**␊ - * Key properties␊ - */␊ - properties: (KeyProperties3 | string)␊ - type: "keys"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Key properties␊ - */␊ - export interface KeyProperties3 {␊ - /**␊ - * Used to activate the workspace after a customer managed key is provided.␊ - */␊ - isActiveCMK?: (boolean | string)␊ - /**␊ - * The Key Vault Url of the workspace key.␊ - */␊ - keyVaultUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Synapse/workspaces/administrators␊ - */␊ - export interface WorkspacesAdministrators {␊ - apiVersion: "2019-06-01-preview"␊ - name: string␊ - /**␊ - * Workspace active directory administrator properties␊ - */␊ - properties: (AadAdminProperties | string)␊ - type: "Microsoft.Synapse/workspaces/administrators"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Synapse/workspaces/bigDataPools␊ - */␊ - export interface WorkspacesBigDataPools {␊ - apiVersion: "2019-06-01-preview"␊ - /**␊ - * The geo-location where the resource lives␊ - */␊ - location: string␊ - /**␊ - * Big Data pool name␊ - */␊ - name: string␊ - /**␊ - * Properties of a Big Data pool powered by Apache Spark␊ - */␊ - properties: (BigDataPoolResourceProperties | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Synapse/workspaces/bigDataPools"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Synapse/workspaces/firewallRules␊ - */␊ - export interface WorkspacesFirewallRules {␊ - apiVersion: "2019-06-01-preview"␊ - /**␊ - * The IP firewall rule name␊ - */␊ - name: string␊ - /**␊ - * IP firewall rule properties␊ - */␊ - properties: (IpFirewallRuleProperties | string)␊ - type: "Microsoft.Synapse/workspaces/firewallRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Synapse/workspaces/managedIdentitySqlControlSettings␊ - */␊ - export interface WorkspacesManagedIdentitySqlControlSettings {␊ - apiVersion: "2019-06-01-preview"␊ - name: string␊ - /**␊ - * Sql Control Settings for workspace managed identity␊ - */␊ - properties: (ManagedIdentitySqlControlSettingsModelProperties | string)␊ - type: "Microsoft.Synapse/workspaces/managedIdentitySqlControlSettings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Synapse/workspaces/sqlPools␊ - */␊ - export interface WorkspacesSqlPools {␊ - apiVersion: "2019-06-01-preview"␊ - /**␊ - * The geo-location where the resource lives␊ - */␊ - location: string␊ - /**␊ - * SQL pool name␊ - */␊ - name: string␊ - /**␊ - * Properties of a SQL Analytics pool␊ - */␊ - properties: (SqlPoolResourceProperties | string)␊ - resources?: (WorkspacesSqlPoolsMetadataSyncChildResource | WorkspacesSqlPoolsGeoBackupPoliciesChildResource | WorkspacesSqlPoolsMaintenancewindowsChildResource | WorkspacesSqlPoolsTransparentDataEncryptionChildResource | WorkspacesSqlPoolsAuditingSettingsChildResource | WorkspacesSqlPoolsVulnerabilityAssessmentsChildResource | WorkspacesSqlPoolsSecurityAlertPoliciesChildResource | WorkspacesSqlPoolsExtendedAuditingSettingsChildResource | WorkspacesSqlPoolsDataMaskingPoliciesChildResource | WorkspacesSqlPoolsWorkloadGroupsChildResource)[]␊ - /**␊ - * SQL pool SKU␊ - */␊ - sku?: (Sku73 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Synapse/workspaces/sqlPools"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Synapse/workspaces/sqlPools/metadataSync␊ - */␊ - export interface WorkspacesSqlPoolsMetadataSyncChildResource {␊ - apiVersion: "2019-06-01-preview"␊ - name: "config"␊ - /**␊ - * Metadata Sync Config properties␊ - */␊ - properties: (MetadataSyncConfigProperties | string)␊ - type: "metadataSync"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Metadata Sync Config properties␊ - */␊ - export interface MetadataSyncConfigProperties {␊ - /**␊ - * Indicates whether the metadata sync is enabled or disabled␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * The Sync Interval in minutes.␊ - */␊ - syncIntervalInMinutes?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Synapse/workspaces/sqlPools/geoBackupPolicies␊ - */␊ - export interface WorkspacesSqlPoolsGeoBackupPoliciesChildResource {␊ - apiVersion: "2019-06-01-preview"␊ - /**␊ - * The name of the geo backup policy.␊ - */␊ - name: "Default"␊ - /**␊ - * The properties of the geo backup policy.␊ - */␊ - properties: (GeoBackupPolicyProperties1 | string)␊ - type: "geoBackupPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of the geo backup policy.␊ - */␊ - export interface GeoBackupPolicyProperties1 {␊ - /**␊ - * The state of the geo backup policy.␊ - */␊ - state: (("Disabled" | "Enabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Synapse/workspaces/sqlPools/maintenancewindows␊ - */␊ - export interface WorkspacesSqlPoolsMaintenancewindowsChildResource {␊ - apiVersion: "2019-06-01-preview"␊ - name: "current"␊ - /**␊ - * Maintenance windows resource properties.␊ - */␊ - properties: (MaintenanceWindowsProperties | string)␊ - type: "maintenancewindows"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Maintenance windows resource properties.␊ - */␊ - export interface MaintenanceWindowsProperties {␊ - timeRanges?: (MaintenanceWindowTimeRange[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Maintenance window time range.␊ - */␊ - export interface MaintenanceWindowTimeRange {␊ - /**␊ - * Day of maintenance window.␊ - */␊ - dayOfWeek?: (("Sunday" | "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday") | string)␊ - /**␊ - * Duration of maintenance window in minutes.␊ - */␊ - duration?: string␊ - /**␊ - * Start time minutes offset from 12am.␊ - */␊ - startTime?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Synapse/workspaces/sqlPools/transparentDataEncryption␊ - */␊ - export interface WorkspacesSqlPoolsTransparentDataEncryptionChildResource {␊ - apiVersion: "2019-06-01-preview"␊ - /**␊ - * The name of the transparent data encryption configuration.␊ - */␊ - name: "current"␊ - /**␊ - * Represents the properties of a database transparent data encryption.␊ - */␊ - properties: (TransparentDataEncryptionProperties1 | string)␊ - type: "transparentDataEncryption"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents the properties of a database transparent data encryption.␊ - */␊ - export interface TransparentDataEncryptionProperties1 {␊ - /**␊ - * The status of the database transparent data encryption.␊ - */␊ - status?: (("Enabled" | "Disabled") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Synapse/workspaces/sqlPools/auditingSettings␊ - */␊ - export interface WorkspacesSqlPoolsAuditingSettingsChildResource {␊ - apiVersion: "2019-06-01-preview"␊ - /**␊ - * The name of the blob auditing policy.␊ - */␊ - name: "default"␊ - /**␊ - * Properties of a Sql pool blob auditing policy.␊ - */␊ - properties: (SqlPoolBlobAuditingPolicyProperties | string)␊ - type: "auditingSettings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a Sql pool blob auditing policy.␊ - */␊ - export interface SqlPoolBlobAuditingPolicyProperties {␊ - /**␊ - * Specifies the Actions-Groups and Actions to audit.␍␊ - * ␍␊ - * The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins:␍␊ - * ␍␊ - * BATCH_COMPLETED_GROUP,␍␊ - * SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP,␍␊ - * FAILED_DATABASE_AUTHENTICATION_GROUP.␍␊ - * ␍␊ - * This above combination is also the set that is configured by default when enabling auditing from the Azure portal.␍␊ - * ␍␊ - * The supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records):␍␊ - * ␍␊ - * APPLICATION_ROLE_CHANGE_PASSWORD_GROUP␍␊ - * BACKUP_RESTORE_GROUP␍␊ - * DATABASE_LOGOUT_GROUP␍␊ - * DATABASE_OBJECT_CHANGE_GROUP␍␊ - * DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP␍␊ - * DATABASE_OBJECT_PERMISSION_CHANGE_GROUP␍␊ - * DATABASE_OPERATION_GROUP␍␊ - * DATABASE_PERMISSION_CHANGE_GROUP␍␊ - * DATABASE_PRINCIPAL_CHANGE_GROUP␍␊ - * DATABASE_PRINCIPAL_IMPERSONATION_GROUP␍␊ - * DATABASE_ROLE_MEMBER_CHANGE_GROUP␍␊ - * FAILED_DATABASE_AUTHENTICATION_GROUP␍␊ - * SCHEMA_OBJECT_ACCESS_GROUP␍␊ - * SCHEMA_OBJECT_CHANGE_GROUP␍␊ - * SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP␍␊ - * SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP␍␊ - * SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP␍␊ - * USER_CHANGE_PASSWORD_GROUP␍␊ - * BATCH_STARTED_GROUP␍␊ - * BATCH_COMPLETED_GROUP␍␊ - * ␍␊ - * These are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs.␍␊ - * ␍␊ - * For more information, see [Database-Level Audit Action Groups](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups).␍␊ - * ␍␊ - * For Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are:␍␊ - * SELECT␍␊ - * UPDATE␍␊ - * INSERT␍␊ - * DELETE␍␊ - * EXECUTE␍␊ - * RECEIVE␍␊ - * REFERENCES␍␊ - * ␍␊ - * The general form for defining an action to be audited is:␍␊ - * {action} ON {object} BY {principal}␍␊ - * ␍␊ - * Note that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively.␍␊ - * ␍␊ - * For example:␍␊ - * SELECT on dbo.myTable by public␍␊ - * SELECT on DATABASE::myDatabase by public␍␊ - * SELECT on SCHEMA::mySchema by public␍␊ - * ␍␊ - * For more information, see [Database-Level Audit Actions](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions)␊ - */␊ - auditActionsAndGroups?: (string[] | string)␊ - /**␊ - * Specifies whether audit events are sent to Azure Monitor. ␍␊ - * In order to send the events to Azure Monitor, specify 'state' as 'Enabled' and 'isAzureMonitorTargetEnabled' as true.␍␊ - * ␍␊ - * When using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created.␍␊ - * Note that for server level audit you should use the 'master' database as {databaseName}.␍␊ - * ␍␊ - * Diagnostic Settings URI format:␍␊ - * PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview␍␊ - * ␍␊ - * For more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207)␍␊ - * or [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043)␍␊ - * ␊ - */␊ - isAzureMonitorTargetEnabled?: (boolean | string)␊ - /**␊ - * Specifies whether storageAccountAccessKey value is the storage's secondary key.␊ - */␊ - isStorageSecondaryKeyInUse?: (boolean | string)␊ - /**␊ - * Specifies the number of days to keep in the audit logs in the storage account.␊ - */␊ - retentionDays?: (number | string)␊ - /**␊ - * Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required.␊ - */␊ - state: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, storageAccountAccessKey is required.␊ - */␊ - storageAccountAccessKey?: string␊ - /**␊ - * Specifies the blob storage subscription Id.␊ - */␊ - storageAccountSubscriptionId?: string␊ - /**␊ - * Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint is required.␊ - */␊ - storageEndpoint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments␊ - */␊ - export interface WorkspacesSqlPoolsVulnerabilityAssessmentsChildResource {␊ - apiVersion: "2019-06-01-preview"␊ - /**␊ - * The name of the vulnerability assessment.␊ - */␊ - name: "default"␊ - /**␊ - * Properties of a Sql pool Vulnerability Assessment.␊ - */␊ - properties: (SqlPoolVulnerabilityAssessmentProperties | string)␊ - type: "vulnerabilityAssessments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a Sql pool Vulnerability Assessment.␊ - */␊ - export interface SqlPoolVulnerabilityAssessmentProperties {␊ - /**␊ - * Properties of a Vulnerability Assessment recurring scans.␊ - */␊ - recurringScans?: (VulnerabilityAssessmentRecurringScansProperties3 | string)␊ - /**␊ - * Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required.␊ - */␊ - storageAccountAccessKey?: string␊ - /**␊ - * A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). It is required if server level vulnerability assessment policy doesn't set␊ - */␊ - storageContainerPath?: string␊ - /**␊ - * A shared access signature (SAS Key) that has write access to the blob container specified in 'storageContainerPath' parameter. If 'storageAccountAccessKey' isn't specified, StorageContainerSasKey is required.␊ - */␊ - storageContainerSasKey?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Synapse/workspaces/sqlPools/securityAlertPolicies␊ - */␊ - export interface WorkspacesSqlPoolsSecurityAlertPoliciesChildResource {␊ - apiVersion: "2019-06-01-preview"␊ - /**␊ - * The name of the security alert policy.␊ - */␊ - name: "default"␊ - /**␊ - * Properties of a security alert policy.␊ - */␊ - properties: (SecurityAlertPolicyProperties7 | string)␊ - type: "securityAlertPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a security alert policy.␊ - */␊ - export interface SecurityAlertPolicyProperties7 {␊ - /**␊ - * Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action␊ - */␊ - disabledAlerts?: (string[] | string)␊ - /**␊ - * Specifies that the alert is sent to the account administrators.␊ - */␊ - emailAccountAdmins?: (boolean | string)␊ - /**␊ - * Specifies an array of e-mail addresses to which the alert is sent.␊ - */␊ - emailAddresses?: (string[] | string)␊ - /**␊ - * Specifies the number of days to keep in the Threat Detection audit logs.␊ - */␊ - retentionDays?: (number | string)␊ - /**␊ - * Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific Sql pool.␊ - */␊ - state: (("New" | "Enabled" | "Disabled") | string)␊ - /**␊ - * Specifies the identifier key of the Threat Detection audit storage account.␊ - */␊ - storageAccountAccessKey?: string␊ - /**␊ - * Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.␊ - */␊ - storageEndpoint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Synapse/workspaces/sqlPools/extendedAuditingSettings␊ - */␊ - export interface WorkspacesSqlPoolsExtendedAuditingSettingsChildResource {␊ - apiVersion: "2019-06-01-preview"␊ - /**␊ - * The name of the blob auditing policy.␊ - */␊ - name: "default"␊ - /**␊ - * Properties of an extended Sql pool blob auditing policy.␊ - */␊ - properties: (ExtendedSqlPoolBlobAuditingPolicyProperties | string)␊ - type: "extendedAuditingSettings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of an extended Sql pool blob auditing policy.␊ - */␊ - export interface ExtendedSqlPoolBlobAuditingPolicyProperties {␊ - /**␊ - * Specifies the Actions-Groups and Actions to audit.␍␊ - * ␍␊ - * The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins:␍␊ - * ␍␊ - * BATCH_COMPLETED_GROUP,␍␊ - * SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP,␍␊ - * FAILED_DATABASE_AUTHENTICATION_GROUP.␍␊ - * ␍␊ - * This above combination is also the set that is configured by default when enabling auditing from the Azure portal.␍␊ - * ␍␊ - * The supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records):␍␊ - * ␍␊ - * APPLICATION_ROLE_CHANGE_PASSWORD_GROUP␍␊ - * BACKUP_RESTORE_GROUP␍␊ - * DATABASE_LOGOUT_GROUP␍␊ - * DATABASE_OBJECT_CHANGE_GROUP␍␊ - * DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP␍␊ - * DATABASE_OBJECT_PERMISSION_CHANGE_GROUP␍␊ - * DATABASE_OPERATION_GROUP␍␊ - * DATABASE_PERMISSION_CHANGE_GROUP␍␊ - * DATABASE_PRINCIPAL_CHANGE_GROUP␍␊ - * DATABASE_PRINCIPAL_IMPERSONATION_GROUP␍␊ - * DATABASE_ROLE_MEMBER_CHANGE_GROUP␍␊ - * FAILED_DATABASE_AUTHENTICATION_GROUP␍␊ - * SCHEMA_OBJECT_ACCESS_GROUP␍␊ - * SCHEMA_OBJECT_CHANGE_GROUP␍␊ - * SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP␍␊ - * SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP␍␊ - * SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP␍␊ - * USER_CHANGE_PASSWORD_GROUP␍␊ - * BATCH_STARTED_GROUP␍␊ - * BATCH_COMPLETED_GROUP␍␊ - * ␍␊ - * These are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs.␍␊ - * ␍␊ - * For more information, see [Database-Level Audit Action Groups](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups).␍␊ - * ␍␊ - * For Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are:␍␊ - * SELECT␍␊ - * UPDATE␍␊ - * INSERT␍␊ - * DELETE␍␊ - * EXECUTE␍␊ - * RECEIVE␍␊ - * REFERENCES␍␊ - * ␍␊ - * The general form for defining an action to be audited is:␍␊ - * {action} ON {object} BY {principal}␍␊ - * ␍␊ - * Note that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively.␍␊ - * ␍␊ - * For example:␍␊ - * SELECT on dbo.myTable by public␍␊ - * SELECT on DATABASE::myDatabase by public␍␊ - * SELECT on SCHEMA::mySchema by public␍␊ - * ␍␊ - * For more information, see [Database-Level Audit Actions](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions)␊ - */␊ - auditActionsAndGroups?: (string[] | string)␊ - /**␊ - * Specifies whether audit events are sent to Azure Monitor. ␍␊ - * In order to send the events to Azure Monitor, specify 'state' as 'Enabled' and 'isAzureMonitorTargetEnabled' as true.␍␊ - * ␍␊ - * When using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created.␍␊ - * Note that for server level audit you should use the 'master' database as {databaseName}.␍␊ - * ␍␊ - * Diagnostic Settings URI format:␍␊ - * PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview␍␊ - * ␍␊ - * For more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207)␍␊ - * or [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043)␍␊ - * ␊ - */␊ - isAzureMonitorTargetEnabled?: (boolean | string)␊ - /**␊ - * Specifies whether storageAccountAccessKey value is the storage's secondary key.␊ - */␊ - isStorageSecondaryKeyInUse?: (boolean | string)␊ - /**␊ - * Specifies condition of where clause when creating an audit.␊ - */␊ - predicateExpression?: string␊ - /**␊ - * Specifies the amount of time in milliseconds that can elapse before audit actions are forced to be processed.␍␊ - * The default minimum value is 1000 (1 second). The maximum is 2,147,483,647.␊ - */␊ - queueDelayMs?: (number | string)␊ - /**␊ - * Specifies the number of days to keep in the audit logs in the storage account.␊ - */␊ - retentionDays?: (number | string)␊ - /**␊ - * Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required.␊ - */␊ - state: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Specifies the identifier key of the auditing storage account. ␍␊ - * If state is Enabled and storageEndpoint is specified, not specifying the storageAccountAccessKey will use SQL server system-assigned managed identity to access the storage.␍␊ - * Prerequisites for using managed identity authentication:␍␊ - * 1. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD).␍␊ - * 2. Grant SQL Server identity access to the storage account by adding 'Storage Blob Data Contributor' RBAC role to the server identity.␍␊ - * For more information, see [Auditing to storage using Managed Identity authentication](https://go.microsoft.com/fwlink/?linkid=2114355)␊ - */␊ - storageAccountAccessKey?: string␊ - /**␊ - * Specifies the blob storage subscription Id.␊ - */␊ - storageAccountSubscriptionId?: string␊ - /**␊ - * Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required.␊ - */␊ - storageEndpoint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Synapse/workspaces/sqlPools/dataMaskingPolicies␊ - */␊ - export interface WorkspacesSqlPoolsDataMaskingPoliciesChildResource {␊ - apiVersion: "2019-06-01-preview"␊ - /**␊ - * The name of the data masking policy for which the masking rule applies.␊ - */␊ - name: "Default"␊ - /**␊ - * The properties of a database data masking policy.␊ - */␊ - properties: (DataMaskingPolicyProperties1 | string)␊ - type: "dataMaskingPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The properties of a database data masking policy.␊ - */␊ - export interface DataMaskingPolicyProperties1 {␊ - /**␊ - * The state of the data masking policy.␊ - */␊ - dataMaskingState: (("Disabled" | "Enabled") | string)␊ - /**␊ - * The list of the exempt principals. Specifies the semicolon-separated list of database users for which the data masking policy does not apply. The specified users receive data results without masking for all of the database queries.␊ - */␊ - exemptPrincipals?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Synapse/workspaces/sqlPools/workloadGroups␊ - */␊ - export interface WorkspacesSqlPoolsWorkloadGroupsChildResource {␊ - apiVersion: "2019-06-01-preview"␊ - /**␊ - * The name of the workload group.␊ - */␊ - name: string␊ - /**␊ - * Workload group definition. For more information look at sys.workload_management_workload_groups (DMV).␊ - */␊ - properties: (WorkloadGroupProperties | string)␊ - type: "workloadGroups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Workload group definition. For more information look at sys.workload_management_workload_groups (DMV).␊ - */␊ - export interface WorkloadGroupProperties {␊ - /**␊ - * The workload group importance level.␊ - */␊ - importance?: string␊ - /**␊ - * The workload group cap percentage resource.␊ - */␊ - maxResourcePercent: (number | string)␊ - /**␊ - * The workload group request maximum grant percentage.␊ - */␊ - maxResourcePercentPerRequest?: (number | string)␊ - /**␊ - * The workload group minimum percentage resource.␊ - */␊ - minResourcePercent: (number | string)␊ - /**␊ - * The workload group request minimum grant percentage.␊ - */␊ - minResourcePercentPerRequest: (number | string)␊ - /**␊ - * The workload group query execution timeout.␊ - */␊ - queryExecutionTimeout?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Synapse/workspaces/sqlPools/auditingSettings␊ - */␊ - export interface WorkspacesSqlPoolsAuditingSettings {␊ - apiVersion: "2019-06-01-preview"␊ - /**␊ - * The name of the blob auditing policy.␊ - */␊ - name: string␊ - /**␊ - * Properties of a Sql pool blob auditing policy.␊ - */␊ - properties: (SqlPoolBlobAuditingPolicyProperties | string)␊ - type: "Microsoft.Synapse/workspaces/sqlPools/auditingSettings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Synapse/workspaces/sqlPools/metadataSync␊ - */␊ - export interface WorkspacesSqlPoolsMetadataSync {␊ - apiVersion: "2019-06-01-preview"␊ - name: string␊ - /**␊ - * Metadata Sync Config properties␊ - */␊ - properties: (MetadataSyncConfigProperties | string)␊ - type: "Microsoft.Synapse/workspaces/sqlPools/metadataSync"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Synapse/workspaces/sqlPools/schemas/tables/columns/sensitivityLabels␊ - */␊ - export interface WorkspacesSqlPoolsSchemasTablesColumnsSensitivityLabels {␊ - apiVersion: "2019-06-01-preview"␊ - /**␊ - * The source of the sensitivity label.␊ - */␊ - name: string␊ - /**␊ - * Properties of a sensitivity label.␊ - */␊ - properties: (SensitivityLabelProperties | string)␊ - type: "Microsoft.Synapse/workspaces/sqlPools/schemas/tables/columns/sensitivityLabels"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a sensitivity label.␊ - */␊ - export interface SensitivityLabelProperties {␊ - /**␊ - * The information type.␊ - */␊ - informationType?: string␊ - /**␊ - * The information type ID.␊ - */␊ - informationTypeId?: string␊ - /**␊ - * The label ID.␊ - */␊ - labelId?: string␊ - /**␊ - * The label name.␊ - */␊ - labelName?: string␊ - rank?: (("None" | "Low" | "Medium" | "High" | "Critical") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Synapse/workspaces/sqlPools/securityAlertPolicies␊ - */␊ - export interface WorkspacesSqlPoolsSecurityAlertPolicies {␊ - apiVersion: "2019-06-01-preview"␊ - /**␊ - * The name of the security alert policy.␊ - */␊ - name: string␊ - /**␊ - * Properties of a security alert policy.␊ - */␊ - properties: (SecurityAlertPolicyProperties7 | string)␊ - type: "Microsoft.Synapse/workspaces/sqlPools/securityAlertPolicies"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Synapse/workspaces/sqlPools/transparentDataEncryption␊ - */␊ - export interface WorkspacesSqlPoolsTransparentDataEncryption {␊ - apiVersion: "2019-06-01-preview"␊ - /**␊ - * The name of the transparent data encryption configuration.␊ - */␊ - name: string␊ - /**␊ - * Represents the properties of a database transparent data encryption.␊ - */␊ - properties: (TransparentDataEncryptionProperties1 | string)␊ - type: "Microsoft.Synapse/workspaces/sqlPools/transparentDataEncryption"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments␊ - */␊ - export interface WorkspacesSqlPoolsVulnerabilityAssessments {␊ - apiVersion: "2019-06-01-preview"␊ - /**␊ - * The name of the vulnerability assessment.␊ - */␊ - name: string␊ - /**␊ - * Properties of a Sql pool Vulnerability Assessment.␊ - */␊ - properties: (SqlPoolVulnerabilityAssessmentProperties | string)␊ - type: "Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments/rules/baselines␊ - */␊ - export interface WorkspacesSqlPoolsVulnerabilityAssessmentsRulesBaselines {␊ - apiVersion: "2019-06-01-preview"␊ - /**␊ - * The name of the vulnerability assessment rule baseline (default implies a baseline on a Sql pool level rule and master for workspace level rule).␊ - */␊ - name: (("master" | "default") | string)␊ - /**␊ - * Properties of a Sql pool vulnerability assessment rule baseline.␊ - */␊ - properties: (SqlPoolVulnerabilityAssessmentRuleBaselineProperties | string)␊ - type: "Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments/rules/baselines"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a Sql pool vulnerability assessment rule baseline.␊ - */␊ - export interface SqlPoolVulnerabilityAssessmentRuleBaselineProperties {␊ - /**␊ - * The rule baseline result␊ - */␊ - baselineResults: (SqlPoolVulnerabilityAssessmentRuleBaselineItem[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties for an Sql pool vulnerability assessment rule baseline's result.␊ - */␊ - export interface SqlPoolVulnerabilityAssessmentRuleBaselineItem {␊ - /**␊ - * The rule baseline result␊ - */␊ - result: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.ResourceGraph/queries␊ - */␊ - export interface Queries {␊ - apiVersion: "2018-09-01-preview"␊ - /**␊ - * This will be used to handle Optimistic Concurrency. If not present, it will always overwrite the existing resource without checking conflict.␊ - */␊ - etag?: string␊ - /**␊ - * The location of the resource␊ - */␊ - location?: string␊ - /**␊ - * The name of the Graph Query resource.␊ - */␊ - name: string␊ - /**␊ - * Properties that contain a graph query.␊ - */␊ - properties: (GraphQueryProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.ResourceGraph/queries"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties that contain a graph query.␊ - */␊ - export interface GraphQueryProperties {␊ - /**␊ - * The description of a graph query.␊ - */␊ - description?: string␊ - /**␊ - * KQL query that will be graph.␊ - */␊ - query: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Communication/communicationServices␊ - */␊ - export interface CommunicationServices {␊ - apiVersion: "2020-08-20-preview"␊ - /**␊ - * The Azure location where the CommunicationService is running.␊ - */␊ - location?: string␊ - /**␊ - * The name of the CommunicationService resource.␊ - */␊ - name: string␊ - /**␊ - * A class that describes the properties of the CommunicationService.␊ - */␊ - properties: (CommunicationServiceProperties | string)␊ - /**␊ - * Tags of the service which is a list of key value pairs that describe the resource.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Communication/communicationServices"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A class that describes the properties of the CommunicationService.␊ - */␊ - export interface CommunicationServiceProperties {␊ - /**␊ - * The location where the communication service stores its data at rest.␊ - */␊ - dataLocation: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Insights/alertrules␊ - */␊ - export interface Alertrules {␊ - apiVersion: "2014-04-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the rule.␊ - */␊ - name: string␊ - /**␊ - * An alert rule.␊ - */␊ - properties: (AlertRule | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Insights/alertrules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An alert rule.␊ - */␊ - export interface AlertRule {␊ - /**␊ - * The action that is performed when the alert rule becomes active, and when an alert condition is resolved.␊ - */␊ - action?: (RuleAction | string)␊ - /**␊ - * the array of actions that are performed when the alert rule becomes active, and when an alert condition is resolved.␊ - */␊ - actions?: ((RuleEmailAction | RuleWebhookAction)[] | string)␊ - /**␊ - * The condition that results in the alert rule being activated.␊ - */␊ - condition: (RuleCondition | string)␊ - /**␊ - * the description of the alert rule that will be included in the alert email.␊ - */␊ - description?: string␊ - /**␊ - * the flag that indicates whether the alert rule is enabled.␊ - */␊ - isEnabled: (boolean | string)␊ - /**␊ - * the name of the alert rule.␊ - */␊ - name: string␊ - /**␊ - * the provisioning state.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the action to send email when the rule condition is evaluated. The discriminator is always RuleEmailAction in this case.␊ - */␊ - export interface RuleEmailAction {␊ - /**␊ - * the list of administrator's custom email addresses to notify of the activation of the alert.␊ - */␊ - customEmails?: (string[] | string)␊ - "odata.type": "Microsoft.Azure.Management.Insights.Models.RuleEmailAction"␊ - /**␊ - * Whether the administrators (service and co-administrators) of the service should be notified when the alert is activated.␊ - */␊ - sendToServiceOwners?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the action to post to service when the rule condition is evaluated. The discriminator is always RuleWebhookAction in this case.␊ - */␊ - export interface RuleWebhookAction {␊ - "odata.type": "Microsoft.Azure.Management.Insights.Models.RuleWebhookAction"␊ - /**␊ - * the dictionary of custom properties to include with the post operation. These data are appended to the webhook payload.␊ - */␊ - properties?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * the service uri to Post the notification when the alert activates or resolves.␊ - */␊ - serviceUri?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A rule metric data source. The discriminator value is always RuleMetricDataSource in this case.␊ - */␊ - export interface RuleMetricDataSource {␊ - /**␊ - * the name of the metric that defines what the rule monitors.␊ - */␊ - metricName?: string␊ - "odata.type": "Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A rule management event data source. The discriminator fields is always RuleManagementEventDataSource in this case.␊ - */␊ - export interface RuleManagementEventDataSource {␊ - /**␊ - * The claims for a rule management event data source.␊ - */␊ - claims?: (RuleManagementEventClaimsDataSource | string)␊ - /**␊ - * the event name.␊ - */␊ - eventName?: string␊ - /**␊ - * the event source.␊ - */␊ - eventSource?: string␊ - /**␊ - * the level.␊ - */␊ - level?: string␊ - "odata.type": "Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource"␊ - /**␊ - * The name of the operation that should be checked for. If no name is provided, any operation will match.␊ - */␊ - operationName?: string␊ - /**␊ - * the resource group name.␊ - */␊ - resourceGroupName?: string␊ - /**␊ - * the resource provider name.␊ - */␊ - resourceProviderName?: string␊ - /**␊ - * The status of the operation that should be checked for. If no status is provided, any status will match.␊ - */␊ - status?: string␊ - /**␊ - * the substatus.␊ - */␊ - subStatus?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The claims for a rule management event data source.␊ - */␊ - export interface RuleManagementEventClaimsDataSource {␊ - /**␊ - * the email address.␊ - */␊ - emailAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A rule condition based on a metric crossing a threshold.␊ - */␊ - export interface ThresholdRuleCondition {␊ - "odata.type": "Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition"␊ - /**␊ - * the operator used to compare the data and the threshold.␊ - */␊ - operator: (("GreaterThan" | "GreaterThanOrEqual" | "LessThan" | "LessThanOrEqual") | string)␊ - /**␊ - * the threshold value that activates the alert.␊ - */␊ - threshold: (number | string)␊ - /**␊ - * the time aggregation operator. How the data that are collected should be combined over time. The default value is the PrimaryAggregationType of the Metric.␊ - */␊ - timeAggregation?: (("Average" | "Minimum" | "Maximum" | "Total" | "Last") | string)␊ - /**␊ - * the period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold. If specified then it must be between 5 minutes and 1 day.␊ - */␊ - windowSize?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A rule condition based on a certain number of locations failing.␊ - */␊ - export interface LocationThresholdRuleCondition {␊ - /**␊ - * the number of locations that must fail to activate the alert.␊ - */␊ - failedLocationCount: (number | string)␊ - "odata.type": "Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition"␊ - /**␊ - * the period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold. If specified then it must be between 5 minutes and 1 day.␊ - */␊ - windowSize?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A management event rule condition.␊ - */␊ - export interface ManagementEventRuleCondition {␊ - /**␊ - * How the data that is collected should be combined over time.␊ - */␊ - aggregation?: (ManagementEventAggregationCondition | string)␊ - "odata.type": "Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * How the data that is collected should be combined over time.␊ - */␊ - export interface ManagementEventAggregationCondition {␊ - /**␊ - * the condition operator.␊ - */␊ - operator?: (("GreaterThan" | "GreaterThanOrEqual" | "LessThan" | "LessThanOrEqual") | string)␊ - /**␊ - * The threshold value that activates the alert.␊ - */␊ - threshold?: (number | string)␊ - /**␊ - * the period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold. If specified then it must be between 5 minutes and 1 day.␊ - */␊ - windowSize?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Insights/components␊ - */␊ - export interface Components {␊ - type: "Microsoft.Insights/components"␊ - apiVersion: "2014-04-01"␊ - properties: {␊ - /**␊ - * Microsoft.Insights/components: applicationId␊ - */␊ - applicationId?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Insights/webtests␊ - */␊ - export interface Webtests {␊ - type: "Microsoft.Insights/webtests"␊ - apiVersion: "2014-04-01"␊ - properties: {␊ - /**␊ - * Microsoft.Insights/webtests: provisioning state.␊ - */␊ - provisioningState?: string␊ - /**␊ - * Microsoft.Insights/webtests: name of the webtest.␊ - */␊ - Name?: string␊ - /**␊ - * Microsoft.Insights/webtests: description of the webtest.␊ - */␊ - Description?: string␊ - /**␊ - * Microsoft.Insights/webtests: Is the webtest enabled.␊ - */␊ - Enabled?: (string | boolean)␊ - /**␊ - * Microsoft.Insights/webtests: Frequency of the webtest.␊ - */␊ - Frequency?: (number | string)␊ - /**␊ - * Microsoft.Insights/webtests: Timeout for the webtest.␊ - */␊ - Timeout?: (number | string)␊ - /**␊ - * Microsoft.Insights/webtests: Locations of the webtest.␊ - */␊ - Locations?: (string | {␊ - /**␊ - * Microsoft.Insights/webtests: Location id of the webtest␊ - */␊ - Id?: string␊ - [k: string]: unknown␊ - }[])␊ - /**␊ - * Microsoft.Insights/webtests: Configuration for the webtest.␊ - */␊ - Configuration?: (string | {␊ - /**␊ - * Microsoft.Insights/webtests: WebTest configuration.␊ - */␊ - WebTest?: string␊ - [k: string]: unknown␊ - })␊ - /**␊ - * Microsoft.Insights/webtests: Synthetic monitor id.␊ - */␊ - SyntheticMonitorId?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Insights/autoscalesettings␊ - */␊ - export interface Autoscalesettings {␊ - type: "Microsoft.Insights/autoscalesettings"␊ - apiVersion: "2014-04-01"␊ - properties: {␊ - /**␊ - * Microsoft.Insights/autoscalesettings: Contains a collection of automatic scaling profiles that specify different scaling parameters for different time periods. A maximum of 20 profiles can be specified.␊ - */␊ - profiles?: (string | {␊ - /**␊ - * Microsoft.Insights/autoscalesettings: The name of the profile.␊ - */␊ - name?: string␊ - /**␊ - * Microsoft.Insights/autoscalesettings: The number of instances that can be used during this profile.␊ - */␊ - capacity?: {␊ - /**␊ - * Microsoft.Insights/autoscalesettings: The minimum number of instances for the resource.␊ - */␊ - minimum?: (string | number)␊ - /**␊ - * Microsoft.Insights/autoscalesettings: The maximum number of instances for the resource. The actual maximum number may be limited by the cores that are available.␊ - */␊ - maximum?: (string | number)␊ - /**␊ - * Microsoft.Insights/autoscalesettings: The number of instances that will be set if metrics are not available for evaluation. The default is only used if the current instance count is lower than the default.␊ - */␊ - default?: (string | number)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Insights/autoscalesettings: Contains a collection of rules that provide the triggers and parameters for the scaling action. A maximum of 10 rules can be specified.␊ - */␊ - rules?: ({␊ - /**␊ - * Microsoft.Insights/autoscalesettings: The trigger that results in a scaling action.␊ - */␊ - metricTrigger?: {␊ - /**␊ - * Microsoft.Insights/autoscalesettings: The name of the metric that defines what the rule monitors.␊ - */␊ - metricName?: string␊ - /**␊ - * Microsoft.Insights/autoscalesettings: The resource identifier of the resource the rule monitors.␊ - */␊ - metricResourceUri?: string␊ - /**␊ - * Microsoft.Insights/autoscalesettings: The granularity of metrics the rule monitors. Must be one of the predefined values returned from metric definitions for the metric. Must be between 12 hours and 1 minute. ISO 8601 duration format.␊ - */␊ - timeGrain?: string␊ - /**␊ - * Microsoft.Insights/autoscalesettings: How the metrics from multiple instances are combined.␊ - */␊ - statistic?: (string | ("Average" | "Min" | "Max" | "Sum"))␊ - /**␊ - * Microsoft.Insights/autoscalesettings: The range of time in which instance data is collected. This value must be greater than the delay in metric collection, which can vary from resource-to-resource. Must be between 12 hours and 5 minutes. ISO 8601 duration format.␊ - */␊ - timeWindow?: string␊ - /**␊ - * Microsoft.Insights/autoscalesettings: How the data that is collected should be combined over time. The default value is Average.␊ - */␊ - timeAggregation?: (string | ("Average" | "Minimum" | "Maximum" | "Last" | "Total" | "Count"))␊ - /**␊ - * Microsoft.Insights/autoscalesettings: The operator that is used to compare the metric data and the threshold.␊ - */␊ - operator?: (string | ("GreaterThan" | "GreaterThanOrEqual" | "Equals" | "NotEquals" | "LessThan" | "LessThanOrEqual"))␊ - /**␊ - * Microsoft.Insights/autoscalesettings: The threshold of the metric that triggers the scale action.␊ - */␊ - threshold?: (string | number)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - } & {␊ - scaleAction?: {␊ - /**␊ - * Microsoft.Insights/autoscalesettings: Whether the scaling action increases or decreases the number of instances.␊ - */␊ - direction?: (string | ("Increase" | "Decrease"))␊ - /**␊ - * Microsoft.Insights/autoscalesettings: The type of action that should occur, this must be set to ChangeCount.␊ - */␊ - type?: (string | "ChangeCount")␊ - /**␊ - * Microsoft.Insights/autoscalesettings: The number of instances that are involved in the scaling action. This value must be 1 or greater. The default value is 1.␊ - */␊ - value?: (string | number)␊ - /**␊ - * Microsoft.Insights/autoscalesettings: The amount of time to wait since the last scaling action before this action occurs. Must be between 1 week and 1 minute. ISO 8601 duration format.␊ - */␊ - cooldown?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - })[]␊ - /**␊ - * Microsoft.Insights/autoscalesettings: A specific date for the profile. This element is not used if the Recurrence element is used.␊ - */␊ - fixedDate?: {␊ - /**␊ - * Microsoft.Insights/autoscalesettings: The time zone of the start and end times for the profile.␊ - */␊ - timeZone?: string␊ - /**␊ - * Microsoft.Insights/autoscalesettings: The start time for the profile.␊ - */␊ - start?: string␊ - /**␊ - * Microsoft.Insights/autoscalesettings: The end time for the profile.␊ - */␊ - end?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Insights/autoscalesettings: The repeating times at which this profile begins. This element is not used if the FixedDate element is used.␊ - */␊ - recurrence?: {␊ - /**␊ - * Microsoft.Insights/autoscalesettings: How often the schedule profile should take effect. This value must be Week, meaning each week will have the same set of profiles.␊ - */␊ - frequency?: "Week"␊ - /**␊ - * Microsoft.Insights/autoscalesettings: The scheduling constraints for when the profile begins.␊ - */␊ - schedule?: {␊ - /**␊ - * Microsoft.Insights/autoscalesettings: The time zone for the hours of the profile.␊ - */␊ - timeZone?: string␊ - /**␊ - * Microsoft.Insights/autoscalesettings: A collection of days that the profile takes effect on.␊ - */␊ - days?: ("Sunday" | "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday")[]␊ - /**␊ - * Microsoft.Insights/autoscalesettings: A collection of hours at which the profile takes effect at.␊ - */␊ - hours?: number[]␊ - /**␊ - * Microsoft.Insights/autoscalesettings: A collection of minutes at which the profile takes effect at.␊ - */␊ - minutes?: number[]␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }[])␊ - /**␊ - * Microsoft.Insights/autoscalesettings: Specifies whether automatic scaling is enabled for the resource.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Microsoft.Insights/autoscalesettings: The name of the autoscale setting.␊ - */␊ - name?: string␊ - /**␊ - * Microsoft.Insights/autoscalesettings: The resource identifier of the resource that the autoscale setting should be added to.␊ - */␊ - targetResourceUri?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Insights/components␊ - */␊ - export interface Components1 {␊ - apiVersion: "2015-05-01"␊ - /**␊ - * The kind of application that this component refers to, used to customize UI. This value is a freeform string, values should typically be one of the following: web, ios, other, store, java, phone.␊ - */␊ - kind: string␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the Application Insights component resource.␊ - */␊ - name: string␊ - /**␊ - * Properties that define an Application Insights component resource.␊ - */␊ - properties: (ApplicationInsightsComponentProperties | string)␊ - resources?: (Components_AnnotationsChildResource | ComponentsExportconfigurationChildResource | ComponentsCurrentbillingfeaturesChildResource | Components_ProactiveDetectionConfigsChildResource | ComponentsFavoritesChildResource | ComponentsAnalyticsItemsChildResource | ComponentsMyanalyticsItemsChildResource)[]␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Insights/components"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties that define an Application Insights component resource.␊ - */␊ - export interface ApplicationInsightsComponentProperties {␊ - /**␊ - * Type of application being monitored.␊ - */␊ - Application_Type: (("web" | "other") | string)␊ - /**␊ - * Disable IP masking.␊ - */␊ - DisableIpMasking?: (boolean | string)␊ - /**␊ - * Used by the Application Insights system to determine what kind of flow this component was created by. This is to be set to 'Bluefield' when creating/updating a component via the REST API.␊ - */␊ - Flow_Type?: ("Bluefield" | string)␊ - /**␊ - * The unique application ID created when a new application is added to HockeyApp, used for communications with HockeyApp.␊ - */␊ - HockeyAppId?: string␊ - /**␊ - * Purge data immediately after 30 days.␊ - */␊ - ImmediatePurgeDataOn30Days?: (boolean | string)␊ - /**␊ - * Indicates the flow of the ingestion.␊ - */␊ - IngestionMode?: (("ApplicationInsights" | "ApplicationInsightsWithDiagnosticSettings" | "LogAnalytics") | string)␊ - /**␊ - * Describes what tool created this Application Insights component. Customers using this API should set this to the default 'rest'.␊ - */␊ - Request_Source?: ("rest" | string)␊ - /**␊ - * Retention period in days.␊ - */␊ - RetentionInDays?: ((number & string) | string)␊ - /**␊ - * Percentage of the data produced by the application being monitored that is being sampled for Application Insights telemetry.␊ - */␊ - SamplingPercentage?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Insights/components/Annotations␊ - */␊ - export interface Components_AnnotationsChildResource {␊ - /**␊ - * Name of annotation␊ - */␊ - AnnotationName?: string␊ - apiVersion: "2015-05-01"␊ - /**␊ - * Category of annotation, free form␊ - */␊ - Category?: string␊ - /**␊ - * Time when event occurred␊ - */␊ - EventTime?: string␊ - /**␊ - * Unique Id for annotation␊ - */␊ - Id?: string␊ - name: "Annotations"␊ - /**␊ - * Serialized JSON object for detailed properties␊ - */␊ - Properties?: string␊ - /**␊ - * Related parent annotation if any␊ - */␊ - RelatedAnnotation?: string␊ - type: "Annotations"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Insights/components/exportconfiguration␊ - */␊ - export interface ComponentsExportconfigurationChildResource {␊ - apiVersion: "2015-05-01"␊ - /**␊ - * The name of destination storage account.␊ - */␊ - DestinationAccountId?: string␊ - /**␊ - * The SAS URL for the destination storage container. It must grant write permission.␊ - */␊ - DestinationAddress?: string␊ - /**␊ - * The location ID of the destination storage container.␊ - */␊ - DestinationStorageLocationId?: string␊ - /**␊ - * The subscription ID of the destination storage container.␊ - */␊ - DestinationStorageSubscriptionId?: string␊ - /**␊ - * The Continuous Export destination type. This has to be 'Blob'.␊ - */␊ - DestinationType?: string␊ - /**␊ - * Set to 'true' to create a Continuous Export configuration as enabled, otherwise set it to 'false'.␊ - */␊ - IsEnabled?: string␊ - /**␊ - * The Continuous Export configuration ID. This is unique within a Application Insights component.␊ - */␊ - name: string␊ - /**␊ - * Deprecated␊ - */␊ - NotificationQueueEnabled?: string␊ - /**␊ - * Deprecated␊ - */␊ - NotificationQueueUri?: string␊ - /**␊ - * The document types to be exported, as comma separated values. Allowed values include 'Requests', 'Event', 'Exceptions', 'Metrics', 'PageViews', 'PageViewPerformance', 'Rdd', 'PerformanceCounters', 'Availability', 'Messages'.␊ - */␊ - RecordTypes?: string␊ - type: "exportconfiguration"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Insights/components/currentbillingfeatures␊ - */␊ - export interface ComponentsCurrentbillingfeaturesChildResource {␊ - apiVersion: "2015-05-01"␊ - /**␊ - * Current enabled pricing plan. When the component is in the Enterprise plan, this will list both 'Basic' and 'Application Insights Enterprise'.␊ - */␊ - CurrentBillingFeatures?: (string[] | string)␊ - /**␊ - * An Application Insights component daily data volume cap␊ - */␊ - DataVolumeCap?: (ApplicationInsightsComponentDataVolumeCap | string)␊ - name: "currentbillingfeatures"␊ - type: "currentbillingfeatures"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An Application Insights component daily data volume cap␊ - */␊ - export interface ApplicationInsightsComponentDataVolumeCap {␊ - /**␊ - * Daily data volume cap in GB.␊ - */␊ - Cap?: (number | string)␊ - /**␊ - * Do not send a notification email when the daily data volume cap is met.␊ - */␊ - StopSendNotificationWhenHitCap?: (boolean | string)␊ - /**␊ - * Reserved, not used for now.␊ - */␊ - StopSendNotificationWhenHitThreshold?: (boolean | string)␊ - /**␊ - * Reserved, not used for now.␊ - */␊ - WarningThreshold?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Insights/components/ProactiveDetectionConfigs␊ - */␊ - export interface Components_ProactiveDetectionConfigsChildResource {␊ - apiVersion: "2015-05-01"␊ - /**␊ - * Custom email addresses for this rule notifications␊ - */␊ - CustomEmails?: (string[] | string)␊ - /**␊ - * A flag that indicates whether this rule is enabled by the user␊ - */␊ - Enabled?: (boolean | string)␊ - /**␊ - * The last time this rule was updated␊ - */␊ - LastUpdatedTime?: string␊ - /**␊ - * The rule name␊ - */␊ - Name?: string␊ - /**␊ - * The ProactiveDetection configuration ID. This is unique within a Application Insights component.␊ - */␊ - name: string␊ - /**␊ - * Static definitions of the ProactiveDetection configuration rule (same values for all components).␊ - */␊ - RuleDefinitions?: (ApplicationInsightsComponentProactiveDetectionConfigurationRuleDefinitions | string)␊ - /**␊ - * A flag that indicated whether notifications on this rule should be sent to subscription owners␊ - */␊ - SendEmailsToSubscriptionOwners?: (boolean | string)␊ - type: "ProactiveDetectionConfigs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Static definitions of the ProactiveDetection configuration rule (same values for all components).␊ - */␊ - export interface ApplicationInsightsComponentProactiveDetectionConfigurationRuleDefinitions {␊ - /**␊ - * The rule description␊ - */␊ - Description?: string␊ - /**␊ - * The rule name as it is displayed in UI␊ - */␊ - DisplayName?: string␊ - /**␊ - * URL which displays additional info about the proactive detection rule␊ - */␊ - HelpUrl?: string␊ - /**␊ - * A flag indicating whether the rule is enabled by default␊ - */␊ - IsEnabledByDefault?: (boolean | string)␊ - /**␊ - * A flag indicating whether the rule is hidden (from the UI)␊ - */␊ - IsHidden?: (boolean | string)␊ - /**␊ - * A flag indicating whether the rule is in preview␊ - */␊ - IsInPreview?: (boolean | string)␊ - /**␊ - * The rule name␊ - */␊ - Name?: string␊ - /**␊ - * A flag indicating whether email notifications are supported for detections for this rule␊ - */␊ - SupportsEmailNotifications?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Insights/components/favorites␊ - */␊ - export interface ComponentsFavoritesChildResource {␊ - apiVersion: "2015-05-01"␊ - /**␊ - * Favorite category, as defined by the user at creation time.␊ - */␊ - Category?: string␊ - /**␊ - * Configuration of this particular favorite, which are driven by the Azure portal UX. Configuration data is a string containing valid JSON␊ - */␊ - Config?: string␊ - /**␊ - * Enum indicating if this favorite definition is owned by a specific user or is shared between all users with access to the Application Insights component.␊ - */␊ - FavoriteType?: (("shared" | "user") | string)␊ - /**␊ - * Flag denoting wether or not this favorite was generated from a template.␊ - */␊ - IsGeneratedFromTemplate?: (boolean | string)␊ - /**␊ - * The user-defined name of the favorite.␊ - */␊ - Name?: string␊ - /**␊ - * The Id of a specific favorite defined in the Application Insights component␊ - */␊ - name: string␊ - /**␊ - * The source of the favorite definition.␊ - */␊ - SourceType?: string␊ - /**␊ - * A list of 0 or more tags that are associated with this favorite definition␊ - */␊ - Tags?: (string[] | string)␊ - type: "favorites"␊ - /**␊ - * This instance's version of the data model. This can change as new features are added that can be marked favorite. Current examples include MetricsExplorer (ME) and Search.␊ - */␊ - Version?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * microsoft.insights/components/analyticsItems␊ - */␊ - export interface ComponentsAnalyticsItemsChildResource {␊ - apiVersion: "2015-05-01"␊ - /**␊ - * The content of this item␊ - */␊ - Content?: string␊ - /**␊ - * Internally assigned unique id of the item definition.␊ - */␊ - Id?: string␊ - /**␊ - * The user-defined name of the item.␊ - */␊ - Name?: string␊ - name: "item"␊ - /**␊ - * A set of properties that can be defined in the context of a specific item type. Each type may have its own properties.␊ - */␊ - Properties?: (ApplicationInsightsComponentAnalyticsItemProperties | string)␊ - /**␊ - * Enum indicating if this item definition is owned by a specific user or is shared between all users with access to the Application Insights component.␊ - */␊ - Scope?: (("shared" | "user") | string)␊ - /**␊ - * Enum indicating the type of the Analytics item.␊ - */␊ - Type?: (("none" | "query" | "recent" | "function") | string)␊ - type: "analyticsItems"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A set of properties that can be defined in the context of a specific item type. Each type may have its own properties.␊ - */␊ - export interface ApplicationInsightsComponentAnalyticsItemProperties {␊ - /**␊ - * A function alias, used when the type of the item is Function␊ - */␊ - functionAlias?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * microsoft.insights/components/myanalyticsItems␊ - */␊ - export interface ComponentsMyanalyticsItemsChildResource {␊ - apiVersion: "2015-05-01"␊ - /**␊ - * The content of this item␊ - */␊ - Content?: string␊ - /**␊ - * Internally assigned unique id of the item definition.␊ - */␊ - Id?: string␊ - /**␊ - * The user-defined name of the item.␊ - */␊ - Name?: string␊ - name: "item"␊ - /**␊ - * A set of properties that can be defined in the context of a specific item type. Each type may have its own properties.␊ - */␊ - Properties?: (ApplicationInsightsComponentAnalyticsItemProperties | string)␊ - /**␊ - * Enum indicating if this item definition is owned by a specific user or is shared between all users with access to the Application Insights component.␊ - */␊ - Scope?: (("shared" | "user") | string)␊ - /**␊ - * Enum indicating the type of the Analytics item.␊ - */␊ - Type?: (("none" | "query" | "recent" | "function") | string)␊ - type: "myanalyticsItems"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * microsoft.insights/components/analyticsItems␊ - */␊ - export interface ComponentsAnalyticsItems {␊ - apiVersion: "2015-05-01"␊ - /**␊ - * The content of this item␊ - */␊ - Content?: string␊ - /**␊ - * Internally assigned unique id of the item definition.␊ - */␊ - Id?: string␊ - /**␊ - * The user-defined name of the item.␊ - */␊ - Name?: string␊ - name: string␊ - /**␊ - * A set of properties that can be defined in the context of a specific item type. Each type may have its own properties.␊ - */␊ - Properties?: (ApplicationInsightsComponentAnalyticsItemProperties | string)␊ - /**␊ - * Enum indicating if this item definition is owned by a specific user or is shared between all users with access to the Application Insights component.␊ - */␊ - Scope?: (("shared" | "user") | string)␊ - type: "microsoft.insights/components/analyticsItems"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Insights/components/Annotations␊ - */␊ - export interface Components_Annotations {␊ - /**␊ - * Name of annotation␊ - */␊ - AnnotationName?: string␊ - apiVersion: "2015-05-01"␊ - /**␊ - * Category of annotation, free form␊ - */␊ - Category?: string␊ - /**␊ - * Time when event occurred␊ - */␊ - EventTime?: string␊ - /**␊ - * Unique Id for annotation␊ - */␊ - Id?: string␊ - name: string␊ - /**␊ - * Serialized JSON object for detailed properties␊ - */␊ - Properties?: string␊ - /**␊ - * Related parent annotation if any␊ - */␊ - RelatedAnnotation?: string␊ - type: "Microsoft.Insights/components/Annotations"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Insights/components/currentbillingfeatures␊ - */␊ - export interface ComponentsCurrentbillingfeatures {␊ - apiVersion: "2015-05-01"␊ - /**␊ - * Current enabled pricing plan. When the component is in the Enterprise plan, this will list both 'Basic' and 'Application Insights Enterprise'.␊ - */␊ - CurrentBillingFeatures?: (string[] | string)␊ - /**␊ - * An Application Insights component daily data volume cap␊ - */␊ - DataVolumeCap?: (ApplicationInsightsComponentDataVolumeCap | string)␊ - name: string␊ - type: "Microsoft.Insights/components/currentbillingfeatures"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Insights/components/favorites␊ - */␊ - export interface ComponentsFavorites {␊ - apiVersion: "2015-05-01"␊ - /**␊ - * Favorite category, as defined by the user at creation time.␊ - */␊ - Category?: string␊ - /**␊ - * Configuration of this particular favorite, which are driven by the Azure portal UX. Configuration data is a string containing valid JSON␊ - */␊ - Config?: string␊ - /**␊ - * Enum indicating if this favorite definition is owned by a specific user or is shared between all users with access to the Application Insights component.␊ - */␊ - FavoriteType?: (("shared" | "user") | string)␊ - /**␊ - * Flag denoting wether or not this favorite was generated from a template.␊ - */␊ - IsGeneratedFromTemplate?: (boolean | string)␊ - /**␊ - * The user-defined name of the favorite.␊ - */␊ - Name?: string␊ - /**␊ - * The Id of a specific favorite defined in the Application Insights component␊ - */␊ - name: string␊ - /**␊ - * The source of the favorite definition.␊ - */␊ - SourceType?: string␊ - /**␊ - * A list of 0 or more tags that are associated with this favorite definition␊ - */␊ - Tags?: (string[] | string)␊ - type: "Microsoft.Insights/components/favorites"␊ - /**␊ - * This instance's version of the data model. This can change as new features are added that can be marked favorite. Current examples include MetricsExplorer (ME) and Search.␊ - */␊ - Version?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * microsoft.insights/components/myanalyticsItems␊ - */␊ - export interface ComponentsMyanalyticsItems {␊ - apiVersion: "2015-05-01"␊ - /**␊ - * The content of this item␊ - */␊ - Content?: string␊ - /**␊ - * Internally assigned unique id of the item definition.␊ - */␊ - Id?: string␊ - /**␊ - * The user-defined name of the item.␊ - */␊ - Name?: string␊ - name: string␊ - /**␊ - * A set of properties that can be defined in the context of a specific item type. Each type may have its own properties.␊ - */␊ - Properties?: (ApplicationInsightsComponentAnalyticsItemProperties | string)␊ - /**␊ - * Enum indicating if this item definition is owned by a specific user or is shared between all users with access to the Application Insights component.␊ - */␊ - Scope?: (("shared" | "user") | string)␊ - type: "microsoft.insights/components/myanalyticsItems"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Insights/components/ProactiveDetectionConfigs␊ - */␊ - export interface Components_ProactiveDetectionConfigs {␊ - apiVersion: "2015-05-01"␊ - /**␊ - * Custom email addresses for this rule notifications␊ - */␊ - CustomEmails?: (string[] | string)␊ - /**␊ - * A flag that indicates whether this rule is enabled by the user␊ - */␊ - Enabled?: (boolean | string)␊ - /**␊ - * The last time this rule was updated␊ - */␊ - LastUpdatedTime?: string␊ - /**␊ - * The rule name␊ - */␊ - Name?: string␊ - /**␊ - * The ProactiveDetection configuration ID. This is unique within a Application Insights component.␊ - */␊ - name: string␊ - /**␊ - * Static definitions of the ProactiveDetection configuration rule (same values for all components).␊ - */␊ - RuleDefinitions?: (ApplicationInsightsComponentProactiveDetectionConfigurationRuleDefinitions | string)␊ - /**␊ - * A flag that indicated whether notifications on this rule should be sent to subscription owners␊ - */␊ - SendEmailsToSubscriptionOwners?: (boolean | string)␊ - type: "Microsoft.Insights/components/ProactiveDetectionConfigs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Insights/myWorkbooks␊ - */␊ - export interface MyWorkbooks {␊ - apiVersion: "2015-05-01"␊ - /**␊ - * Azure resource Id␊ - */␊ - id?: string␊ - /**␊ - * The kind of workbook. Choices are user and shared.␊ - */␊ - kind?: (("user" | "shared") | string)␊ - /**␊ - * Resource location␊ - */␊ - location?: string␊ - /**␊ - * The name of the Application Insights component resource.␊ - */␊ - name: string␊ - /**␊ - * Properties that contain a private workbook.␊ - */␊ - properties: (MyWorkbookProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Insights/myWorkbooks"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties that contain a private workbook.␊ - */␊ - export interface MyWorkbookProperties {␊ - /**␊ - * Workbook category, as defined by the user at creation time.␊ - */␊ - category: string␊ - /**␊ - * The user-defined name of the private workbook.␊ - */␊ - displayName: string␊ - /**␊ - * Configuration of this particular private workbook. Configuration data is a string containing valid JSON␊ - */␊ - serializedData: string␊ - /**␊ - * Optional resourceId for a source resource.␊ - */␊ - sourceId?: string␊ - /**␊ - * A list of 0 or more tags that are associated with this private workbook definition␊ - */␊ - tags?: (string[] | string)␊ - /**␊ - * This instance's version of the data model. This can change as new features are added that can be marked private workbook.␊ - */␊ - version?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Insights/webtests␊ - */␊ - export interface Webtests1 {␊ - apiVersion: "2015-05-01"␊ - /**␊ - * The kind of web test that this web test watches. Choices are ping and multistep.␊ - */␊ - kind?: (("ping" | "multistep") | string)␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the Application Insights webtest resource.␊ - */␊ - name: string␊ - /**␊ - * Metadata describing a web test for an Azure resource.␊ - */␊ - properties: (WebTestProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Insights/webtests"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Metadata describing a web test for an Azure resource.␊ - */␊ - export interface WebTestProperties {␊ - /**␊ - * An XML configuration specification for a WebTest.␊ - */␊ - Configuration?: (WebTestPropertiesConfiguration | string)␊ - /**␊ - * Purpose/user defined descriptive test for this WebTest.␊ - */␊ - Description?: string␊ - /**␊ - * Is the test actively being monitored.␊ - */␊ - Enabled?: (boolean | string)␊ - /**␊ - * Interval in seconds between test runs for this WebTest. Default value is 300.␊ - */␊ - Frequency?: ((number & string) | string)␊ - /**␊ - * The kind of web test this is, valid choices are ping and multistep.␊ - */␊ - Kind: (("ping" | "multistep") | string)␊ - /**␊ - * A list of where to physically run the tests from to give global coverage for accessibility of your application.␊ - */␊ - Locations: (WebTestGeolocation[] | string)␊ - /**␊ - * User defined name if this WebTest.␊ - */␊ - Name: string␊ - /**␊ - * Allow for retries should this WebTest fail.␊ - */␊ - RetryEnabled?: (boolean | string)␊ - /**␊ - * Unique ID of this WebTest. This is typically the same value as the Name field.␊ - */␊ - SyntheticMonitorId: string␊ - /**␊ - * Seconds until this WebTest will timeout and fail. Default value is 30.␊ - */␊ - Timeout?: ((number & string) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An XML configuration specification for a WebTest.␊ - */␊ - export interface WebTestPropertiesConfiguration {␊ - /**␊ - * The XML specification of a WebTest to run against an application.␊ - */␊ - WebTest?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Geo-physical location to run a web test from. You must specify one or more locations for the test to run from.␊ - */␊ - export interface WebTestGeolocation {␊ - /**␊ - * Location ID for the webtest to run from.␊ - */␊ - Id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * microsoft.insights/workbooks␊ - */␊ - export interface Workbooks {␊ - apiVersion: "2015-05-01"␊ - /**␊ - * The kind of workbook. Choices are user and shared.␊ - */␊ - kind?: (("user" | "shared") | string)␊ - /**␊ - * Resource location␊ - */␊ - location?: string␊ - /**␊ - * The name of the Application Insights component resource.␊ - */␊ - name: string␊ - /**␊ - * Properties that contain a workbook.␊ - */␊ - properties: (WorkbookProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "microsoft.insights/workbooks"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties that contain a workbook.␊ - */␊ - export interface WorkbookProperties {␊ - /**␊ - * Workbook category, as defined by the user at creation time.␊ - */␊ - category: string␊ - /**␊ - * Enum indicating if this workbook definition is owned by a specific user or is shared between all users with access to the Application Insights component.␊ - */␊ - kind: (("user" | "shared") | string)␊ - /**␊ - * The user-defined name of the workbook.␊ - */␊ - name: string␊ - /**␊ - * Configuration of this particular workbook. Configuration data is a string containing valid JSON␊ - */␊ - serializedData: string␊ - /**␊ - * Optional resourceId for a source resource.␊ - */␊ - sourceResourceId?: string␊ - /**␊ - * A list of 0 or more tags that are associated with this workbook definition␊ - */␊ - tags?: (string[] | string)␊ - /**␊ - * Unique user id of the specific user that owns this workbook.␊ - */␊ - userId: string␊ - /**␊ - * This instance's version of the data model. This can change as new features are added that can be marked workbook.␊ - */␊ - version?: string␊ - /**␊ - * Internally assigned unique id of the workbook definition.␊ - */␊ - workbookId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Insights/components/exportconfiguration␊ - */␊ - export interface ComponentsExportconfiguration {␊ - apiVersion: "2015-05-01"␊ - /**␊ - * The name of destination storage account.␊ - */␊ - DestinationAccountId?: string␊ - /**␊ - * The SAS URL for the destination storage container. It must grant write permission.␊ - */␊ - DestinationAddress?: string␊ - /**␊ - * The location ID of the destination storage container.␊ - */␊ - DestinationStorageLocationId?: string␊ - /**␊ - * The subscription ID of the destination storage container.␊ - */␊ - DestinationStorageSubscriptionId?: string␊ - /**␊ - * The Continuous Export destination type. This has to be 'Blob'.␊ - */␊ - DestinationType?: string␊ - /**␊ - * Set to 'true' to create a Continuous Export configuration as enabled, otherwise set it to 'false'.␊ - */␊ - IsEnabled?: string␊ - /**␊ - * The Continuous Export configuration ID. This is unique within a Application Insights component.␊ - */␊ - name: string␊ - /**␊ - * Deprecated␊ - */␊ - NotificationQueueEnabled?: string␊ - /**␊ - * Deprecated␊ - */␊ - NotificationQueueUri?: string␊ - /**␊ - * The document types to be exported, as comma separated values. Allowed values include 'Requests', 'Event', 'Exceptions', 'Metrics', 'PageViews', 'PageViewPerformance', 'Rdd', 'PerformanceCounters', 'Availability', 'Messages'.␊ - */␊ - RecordTypes?: string␊ - type: "Microsoft.Insights/components/exportconfiguration"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * microsoft.insights/components/pricingPlans␊ - */␊ - export interface ComponentsPricingPlans {␊ - apiVersion: "2017-10-01"␊ - name: string␊ - /**␊ - * An Application Insights component daily data volume cap␊ - */␊ - properties: (PricingPlanProperties | string)␊ - type: "microsoft.insights/components/pricingPlans"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An Application Insights component daily data volume cap␊ - */␊ - export interface PricingPlanProperties {␊ - /**␊ - * Daily data volume cap in GB.␊ - */␊ - cap?: (number | string)␊ - /**␊ - * Pricing Plan Type Name.␊ - */␊ - planType?: string␊ - /**␊ - * Do not send a notification email when the daily data volume cap is met.␊ - */␊ - stopSendNotificationWhenHitCap?: (boolean | string)␊ - /**␊ - * Reserved, not used for now.␊ - */␊ - stopSendNotificationWhenHitThreshold?: (boolean | string)␊ - /**␊ - * Reserved, not used for now.␊ - */␊ - warningThreshold?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Insights/components␊ - */␊ - export interface Components2 {␊ - apiVersion: "2018-05-01-preview"␊ - /**␊ - * The kind of application that this component refers to, used to customize UI. This value is a freeform string, values should typically be one of the following: web, ios, other, store, java, phone.␊ - */␊ - kind: string␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the Application Insights component resource.␊ - */␊ - name: string␊ - /**␊ - * Properties that define an Application Insights component resource.␊ - */␊ - properties: (ApplicationInsightsComponentProperties1 | string)␊ - resources?: Components_ProactiveDetectionConfigsChildResource1[]␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Insights/components"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties that define an Application Insights component resource.␊ - */␊ - export interface ApplicationInsightsComponentProperties1 {␊ - /**␊ - * Type of application being monitored.␊ - */␊ - Application_Type: (("web" | "other") | string)␊ - /**␊ - * Disable IP masking.␊ - */␊ - DisableIpMasking?: (boolean | string)␊ - /**␊ - * Used by the Application Insights system to determine what kind of flow this component was created by. This is to be set to 'Bluefield' when creating/updating a component via the REST API.␊ - */␊ - Flow_Type?: ("Bluefield" | string)␊ - /**␊ - * The unique application ID created when a new application is added to HockeyApp, used for communications with HockeyApp.␊ - */␊ - HockeyAppId?: string␊ - /**␊ - * Purge data immediately after 30 days.␊ - */␊ - ImmediatePurgeDataOn30Days?: (boolean | string)␊ - /**␊ - * Indicates the flow of the ingestion.␊ - */␊ - IngestionMode?: (("ApplicationInsights" | "ApplicationInsightsWithDiagnosticSettings" | "LogAnalytics") | string)␊ - /**␊ - * The network access type for accessing Application Insights ingestion.␊ - */␊ - publicNetworkAccessForIngestion?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * The network access type for accessing Application Insights query.␊ - */␊ - publicNetworkAccessForQuery?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Describes what tool created this Application Insights component. Customers using this API should set this to the default 'rest'.␊ - */␊ - Request_Source?: ("rest" | string)␊ - /**␊ - * Retention period in days.␊ - */␊ - RetentionInDays?: ((number & string) | string)␊ - /**␊ - * Percentage of the data produced by the application being monitored that is being sampled for Application Insights telemetry.␊ - */␊ - SamplingPercentage?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Insights/components/ProactiveDetectionConfigs␊ - */␊ - export interface Components_ProactiveDetectionConfigsChildResource1 {␊ - apiVersion: "2018-05-01-preview"␊ - /**␊ - * Resource location␊ - */␊ - location?: string␊ - /**␊ - * The ProactiveDetection configuration ID. This is unique within a Application Insights component.␊ - */␊ - name: string␊ - /**␊ - * Properties that define a ProactiveDetection configuration.␊ - */␊ - properties: (ApplicationInsightsComponentProactiveDetectionConfigurationProperties | string)␊ - type: "ProactiveDetectionConfigs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties that define a ProactiveDetection configuration.␊ - */␊ - export interface ApplicationInsightsComponentProactiveDetectionConfigurationProperties {␊ - /**␊ - * Custom email addresses for this rule notifications␊ - */␊ - CustomEmails?: (string[] | string)␊ - /**␊ - * A flag that indicates whether this rule is enabled by the user␊ - */␊ - Enabled?: (boolean | string)␊ - /**␊ - * Static definitions of the ProactiveDetection configuration rule (same values for all components).␊ - */␊ - RuleDefinitions?: (ApplicationInsightsComponentProactiveDetectionConfigurationPropertiesRuleDefinitions | string)␊ - /**␊ - * A flag that indicated whether notifications on this rule should be sent to subscription owners␊ - */␊ - SendEmailsToSubscriptionOwners?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Static definitions of the ProactiveDetection configuration rule (same values for all components).␊ - */␊ - export interface ApplicationInsightsComponentProactiveDetectionConfigurationPropertiesRuleDefinitions {␊ - /**␊ - * The rule description␊ - */␊ - Description?: string␊ - /**␊ - * The rule name as it is displayed in UI␊ - */␊ - DisplayName?: string␊ - /**␊ - * URL which displays additional info about the proactive detection rule␊ - */␊ - HelpUrl?: string␊ - /**␊ - * A flag indicating whether the rule is enabled by default␊ - */␊ - IsEnabledByDefault?: (boolean | string)␊ - /**␊ - * A flag indicating whether the rule is hidden (from the UI)␊ - */␊ - IsHidden?: (boolean | string)␊ - /**␊ - * A flag indicating whether the rule is in preview␊ - */␊ - IsInPreview?: (boolean | string)␊ - /**␊ - * The rule name␊ - */␊ - Name?: string␊ - /**␊ - * A flag indicating whether email notifications are supported for detections for this rule␊ - */␊ - SupportsEmailNotifications?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Insights/components/ProactiveDetectionConfigs␊ - */␊ - export interface Components_ProactiveDetectionConfigs1 {␊ - apiVersion: "2018-05-01-preview"␊ - /**␊ - * Resource location␊ - */␊ - location?: string␊ - /**␊ - * The ProactiveDetection configuration ID. This is unique within a Application Insights component.␊ - */␊ - name: string␊ - /**␊ - * Properties that define a ProactiveDetection configuration.␊ - */␊ - properties: (ApplicationInsightsComponentProactiveDetectionConfigurationProperties | string)␊ - type: "Microsoft.Insights/components/ProactiveDetectionConfigs"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * microsoft.insights/workbooks␊ - */␊ - export interface Workbooks1 {␊ - apiVersion: "2018-06-17-preview"␊ - /**␊ - * The kind of workbook. Choices are user and shared.␊ - */␊ - kind?: (("user" | "shared") | string)␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the Application Insights component resource.␊ - */␊ - name: string␊ - /**␊ - * Properties that contain a workbook.␊ - */␊ - properties: (WorkbookProperties1 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "microsoft.insights/workbooks"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties that contain a workbook.␊ - */␊ - export interface WorkbookProperties1 {␊ - /**␊ - * Workbook category, as defined by the user at creation time.␊ - */␊ - category: string␊ - /**␊ - * The user-defined name (display name) of the workbook.␊ - */␊ - displayName: string␊ - /**␊ - * Configuration of this particular workbook. Configuration data is a string containing valid JSON␊ - */␊ - serializedData: string␊ - /**␊ - * ResourceId for a source resource.␊ - */␊ - sourceId?: string␊ - /**␊ - * A list of 0 or more tags that are associated with this workbook definition␊ - */␊ - tags?: (string[] | string)␊ - /**␊ - * Workbook version␊ - */␊ - version?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * microsoft.insights/workbooktemplates␊ - */␊ - export interface Workbooktemplates {␊ - apiVersion: "2019-10-17-preview"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the Application Insights component resource.␊ - */␊ - name: string␊ - /**␊ - * Properties that contain a workbook template.␊ - */␊ - properties: (WorkbookTemplateProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "microsoft.insights/workbooktemplates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties that contain a workbook template.␊ - */␊ - export interface WorkbookTemplateProperties {␊ - /**␊ - * Information about the author of the workbook template.␊ - */␊ - author?: string␊ - /**␊ - * Workbook galleries supported by the template.␊ - */␊ - galleries: (WorkbookTemplateGallery[] | string)␊ - /**␊ - * Key value pair of localized gallery. Each key is the locale code of languages supported by the Azure portal.␊ - */␊ - localized?: ({␊ - [k: string]: WorkbookTemplateLocalizedGallery[]␊ - } | string)␊ - /**␊ - * Priority of the template. Determines which template to open when a workbook gallery is opened in viewer mode.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * Valid JSON object containing workbook template payload.␊ - */␊ - templateData: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Gallery information for a workbook template.␊ - */␊ - export interface WorkbookTemplateGallery {␊ - /**␊ - * Category for the gallery.␊ - */␊ - category?: string␊ - /**␊ - * Name of the workbook template in the gallery.␊ - */␊ - name?: string␊ - /**␊ - * Order of the template within the gallery.␊ - */␊ - order?: (number | string)␊ - /**␊ - * Azure resource type supported by the gallery.␊ - */␊ - resourceType?: string␊ - /**␊ - * Type of workbook supported by the workbook template.␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Localized template data and gallery information.␊ - */␊ - export interface WorkbookTemplateLocalizedGallery {␊ - /**␊ - * Workbook galleries supported by the template.␊ - */␊ - galleries?: (WorkbookTemplateGallery[] | string)␊ - /**␊ - * Valid JSON object containing workbook template payload.␊ - */␊ - templateData?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Insights/components␊ - */␊ - export interface Components3 {␊ - apiVersion: "2020-02-02-preview"␊ - /**␊ - * Resource etag␊ - */␊ - etag?: string␊ - /**␊ - * The kind of application that this component refers to, used to customize UI. This value is a freeform string, values should typically be one of the following: web, ios, other, store, java, phone.␊ - */␊ - kind: string␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the Application Insights component resource.␊ - */␊ - name: string␊ - /**␊ - * Properties that define an Application Insights component resource.␊ - */␊ - properties: (ApplicationInsightsComponentProperties2 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Insights/components"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties that define an Application Insights component resource.␊ - */␊ - export interface ApplicationInsightsComponentProperties2 {␊ - /**␊ - * Type of application being monitored.␊ - */␊ - Application_Type: (("web" | "other") | string)␊ - /**␊ - * Disable IP masking.␊ - */␊ - DisableIpMasking?: (boolean | string)␊ - /**␊ - * Disable Non-AAD based Auth.␊ - */␊ - DisableLocalAuth?: (boolean | string)␊ - /**␊ - * Used by the Application Insights system to determine what kind of flow this component was created by. This is to be set to 'Bluefield' when creating/updating a component via the REST API.␊ - */␊ - Flow_Type?: ("Bluefield" | string)␊ - /**␊ - * Force users to create their own storage account for profiler and debugger.␊ - */␊ - ForceCustomerStorageForProfiler?: (boolean | string)␊ - /**␊ - * The unique application ID created when a new application is added to HockeyApp, used for communications with HockeyApp.␊ - */␊ - HockeyAppId?: string␊ - /**␊ - * Purge data immediately after 30 days.␊ - */␊ - ImmediatePurgeDataOn30Days?: (boolean | string)␊ - /**␊ - * Indicates the flow of the ingestion.␊ - */␊ - IngestionMode?: (("ApplicationInsights" | "ApplicationInsightsWithDiagnosticSettings" | "LogAnalytics") | string)␊ - /**␊ - * The network access type for accessing Application Insights ingestion.␊ - */␊ - publicNetworkAccessForIngestion?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * The network access type for accessing Application Insights query.␊ - */␊ - publicNetworkAccessForQuery?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Describes what tool created this Application Insights component. Customers using this API should set this to the default 'rest'.␊ - */␊ - Request_Source?: ("rest" | string)␊ - /**␊ - * Percentage of the data produced by the application being monitored that is being sampled for Application Insights telemetry.␊ - */␊ - SamplingPercentage?: (number | string)␊ - /**␊ - * Resource Id of the log analytics workspace which the data will be ingested to. This property is required to create an application with this API version. Applications from older versions will not have this property.␊ - */␊ - WorkspaceResourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * microsoft.insights/components/linkedStorageAccounts␊ - */␊ - export interface ComponentsLinkedStorageAccounts {␊ - apiVersion: "2020-03-01-preview"␊ - /**␊ - * The type of the Application Insights component data source for the linked storage account.␊ - */␊ - name: string␊ - /**␊ - * An Application Insights component linked storage account␊ - */␊ - properties: (LinkedStorageAccountsProperties | string)␊ - type: "microsoft.insights/components/linkedStorageAccounts"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An Application Insights component linked storage account␊ - */␊ - export interface LinkedStorageAccountsProperties {␊ - /**␊ - * Linked storage account resource ID␊ - */␊ - linkedStorageAccount?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Insights/autoscalesettings␊ - */␊ - export interface Autoscalesettings1 {␊ - apiVersion: "2015-04-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The autoscale setting name.␊ - */␊ - name: string␊ - /**␊ - * A setting that contains all of the configuration for the automatic scaling of a resource.␊ - */␊ - properties: (AutoscaleSetting | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Insights/autoscalesettings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A setting that contains all of the configuration for the automatic scaling of a resource.␊ - */␊ - export interface AutoscaleSetting {␊ - /**␊ - * the enabled flag. Specifies whether automatic scaling is enabled for the resource. The default value is 'true'.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * the name of the autoscale setting.␊ - */␊ - name?: string␊ - /**␊ - * the collection of notifications.␊ - */␊ - notifications?: (AutoscaleNotification[] | string)␊ - /**␊ - * the collection of automatic scaling profiles that specify different scaling parameters for different time periods. A maximum of 20 profiles can be specified.␊ - */␊ - profiles: (AutoscaleProfile[] | string)␊ - /**␊ - * the location of the resource that the autoscale setting should be added to.␊ - */␊ - targetResourceLocation?: string␊ - /**␊ - * the resource identifier of the resource that the autoscale setting should be added to.␊ - */␊ - targetResourceUri?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Autoscale notification.␊ - */␊ - export interface AutoscaleNotification {␊ - /**␊ - * Email notification of an autoscale event.␊ - */␊ - email?: (EmailNotification | string)␊ - /**␊ - * the operation associated with the notification and its value must be "scale"␊ - */␊ - operation: ("Scale" | string)␊ - /**␊ - * the collection of webhook notifications.␊ - */␊ - webhooks?: (WebhookNotification[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Email notification of an autoscale event.␊ - */␊ - export interface EmailNotification {␊ - /**␊ - * the custom e-mails list. This value can be null or empty, in which case this attribute will be ignored.␊ - */␊ - customEmails?: (string[] | string)␊ - /**␊ - * a value indicating whether to send email to subscription administrator.␊ - */␊ - sendToSubscriptionAdministrator?: (boolean | string)␊ - /**␊ - * a value indicating whether to send email to subscription co-administrators.␊ - */␊ - sendToSubscriptionCoAdministrators?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Webhook notification of an autoscale event.␊ - */␊ - export interface WebhookNotification {␊ - /**␊ - * a property bag of settings. This value can be empty.␊ - */␊ - properties?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * the service address to receive the notification.␊ - */␊ - serviceUri?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Autoscale profile.␊ - */␊ - export interface AutoscaleProfile {␊ - /**␊ - * The number of instances that can be used during this profile.␊ - */␊ - capacity: (ScaleCapacity | string)␊ - /**␊ - * A specific date-time for the profile.␊ - */␊ - fixedDate?: (TimeWindow | string)␊ - /**␊ - * the name of the profile.␊ - */␊ - name: string␊ - /**␊ - * The repeating times at which this profile begins. This element is not used if the FixedDate element is used.␊ - */␊ - recurrence?: (Recurrence | string)␊ - /**␊ - * the collection of rules that provide the triggers and parameters for the scaling action. A maximum of 10 rules can be specified.␊ - */␊ - rules: (ScaleRule[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The number of instances that can be used during this profile.␊ - */␊ - export interface ScaleCapacity {␊ - /**␊ - * the number of instances that will be set if metrics are not available for evaluation. The default is only used if the current instance count is lower than the default.␊ - */␊ - default: string␊ - /**␊ - * the maximum number of instances for the resource. The actual maximum number of instances is limited by the cores that are available in the subscription.␊ - */␊ - maximum: string␊ - /**␊ - * the minimum number of instances for the resource.␊ - */␊ - minimum: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A specific date-time for the profile.␊ - */␊ - export interface TimeWindow {␊ - /**␊ - * the end time for the profile in ISO 8601 format.␊ - */␊ - end: string␊ - /**␊ - * the start time for the profile in ISO 8601 format.␊ - */␊ - start: string␊ - /**␊ - * the timezone of the start and end times for the profile. Some examples of valid time zones are: Dateline Standard Time, UTC-11, Hawaiian Standard Time, Alaskan Standard Time, Pacific Standard Time (Mexico), Pacific Standard Time, US Mountain Standard Time, Mountain Standard Time (Mexico), Mountain Standard Time, Central America Standard Time, Central Standard Time, Central Standard Time (Mexico), Canada Central Standard Time, SA Pacific Standard Time, Eastern Standard Time, US Eastern Standard Time, Venezuela Standard Time, Paraguay Standard Time, Atlantic Standard Time, Central Brazilian Standard Time, SA Western Standard Time, Pacific SA Standard Time, Newfoundland Standard Time, E. South America Standard Time, Argentina Standard Time, SA Eastern Standard Time, Greenland Standard Time, Montevideo Standard Time, Bahia Standard Time, UTC-02, Mid-Atlantic Standard Time, Azores Standard Time, Cape Verde Standard Time, Morocco Standard Time, UTC, GMT Standard Time, Greenwich Standard Time, W. Europe Standard Time, Central Europe Standard Time, Romance Standard Time, Central European Standard Time, W. Central Africa Standard Time, Namibia Standard Time, Jordan Standard Time, GTB Standard Time, Middle East Standard Time, Egypt Standard Time, Syria Standard Time, E. Europe Standard Time, South Africa Standard Time, FLE Standard Time, Turkey Standard Time, Israel Standard Time, Kaliningrad Standard Time, Libya Standard Time, Arabic Standard Time, Arab Standard Time, Belarus Standard Time, Russian Standard Time, E. Africa Standard Time, Iran Standard Time, Arabian Standard Time, Azerbaijan Standard Time, Russia Time Zone 3, Mauritius Standard Time, Georgian Standard Time, Caucasus Standard Time, Afghanistan Standard Time, West Asia Standard Time, Ekaterinburg Standard Time, Pakistan Standard Time, India Standard Time, Sri Lanka Standard Time, Nepal Standard Time, Central Asia Standard Time, Bangladesh Standard Time, N. Central Asia Standard Time, Myanmar Standard Time, SE Asia Standard Time, North Asia Standard Time, China Standard Time, North Asia East Standard Time, Singapore Standard Time, W. Australia Standard Time, Taipei Standard Time, Ulaanbaatar Standard Time, Tokyo Standard Time, Korea Standard Time, Yakutsk Standard Time, Cen. Australia Standard Time, AUS Central Standard Time, E. Australia Standard Time, AUS Eastern Standard Time, West Pacific Standard Time, Tasmania Standard Time, Magadan Standard Time, Vladivostok Standard Time, Russia Time Zone 10, Central Pacific Standard Time, Russia Time Zone 11, New Zealand Standard Time, UTC+12, Fiji Standard Time, Kamchatka Standard Time, Tonga Standard Time, Samoa Standard Time, Line Islands Standard Time␊ - */␊ - timeZone?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The repeating times at which this profile begins. This element is not used if the FixedDate element is used.␊ - */␊ - export interface Recurrence {␊ - /**␊ - * the recurrence frequency. How often the schedule profile should take effect. This value must be Week, meaning each week will have the same set of profiles. For example, to set a daily schedule, set **schedule** to every day of the week. The frequency property specifies that the schedule is repeated weekly.␊ - */␊ - frequency: (("None" | "Second" | "Minute" | "Hour" | "Day" | "Week" | "Month" | "Year") | string)␊ - /**␊ - * The scheduling constraints for when the profile begins.␊ - */␊ - schedule: (RecurrentSchedule | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The scheduling constraints for when the profile begins.␊ - */␊ - export interface RecurrentSchedule {␊ - /**␊ - * the collection of days that the profile takes effect on. Possible values are Sunday through Saturday.␊ - */␊ - days: (string[] | string)␊ - /**␊ - * A collection of hours that the profile takes effect on. Values supported are 0 to 23 on the 24-hour clock (AM/PM times are not supported).␊ - */␊ - hours: (number[] | string)␊ - /**␊ - * A collection of minutes at which the profile takes effect at.␊ - */␊ - minutes: (number[] | string)␊ - /**␊ - * the timezone for the hours of the profile. Some examples of valid time zones are: Dateline Standard Time, UTC-11, Hawaiian Standard Time, Alaskan Standard Time, Pacific Standard Time (Mexico), Pacific Standard Time, US Mountain Standard Time, Mountain Standard Time (Mexico), Mountain Standard Time, Central America Standard Time, Central Standard Time, Central Standard Time (Mexico), Canada Central Standard Time, SA Pacific Standard Time, Eastern Standard Time, US Eastern Standard Time, Venezuela Standard Time, Paraguay Standard Time, Atlantic Standard Time, Central Brazilian Standard Time, SA Western Standard Time, Pacific SA Standard Time, Newfoundland Standard Time, E. South America Standard Time, Argentina Standard Time, SA Eastern Standard Time, Greenland Standard Time, Montevideo Standard Time, Bahia Standard Time, UTC-02, Mid-Atlantic Standard Time, Azores Standard Time, Cape Verde Standard Time, Morocco Standard Time, UTC, GMT Standard Time, Greenwich Standard Time, W. Europe Standard Time, Central Europe Standard Time, Romance Standard Time, Central European Standard Time, W. Central Africa Standard Time, Namibia Standard Time, Jordan Standard Time, GTB Standard Time, Middle East Standard Time, Egypt Standard Time, Syria Standard Time, E. Europe Standard Time, South Africa Standard Time, FLE Standard Time, Turkey Standard Time, Israel Standard Time, Kaliningrad Standard Time, Libya Standard Time, Arabic Standard Time, Arab Standard Time, Belarus Standard Time, Russian Standard Time, E. Africa Standard Time, Iran Standard Time, Arabian Standard Time, Azerbaijan Standard Time, Russia Time Zone 3, Mauritius Standard Time, Georgian Standard Time, Caucasus Standard Time, Afghanistan Standard Time, West Asia Standard Time, Ekaterinburg Standard Time, Pakistan Standard Time, India Standard Time, Sri Lanka Standard Time, Nepal Standard Time, Central Asia Standard Time, Bangladesh Standard Time, N. Central Asia Standard Time, Myanmar Standard Time, SE Asia Standard Time, North Asia Standard Time, China Standard Time, North Asia East Standard Time, Singapore Standard Time, W. Australia Standard Time, Taipei Standard Time, Ulaanbaatar Standard Time, Tokyo Standard Time, Korea Standard Time, Yakutsk Standard Time, Cen. Australia Standard Time, AUS Central Standard Time, E. Australia Standard Time, AUS Eastern Standard Time, West Pacific Standard Time, Tasmania Standard Time, Magadan Standard Time, Vladivostok Standard Time, Russia Time Zone 10, Central Pacific Standard Time, Russia Time Zone 11, New Zealand Standard Time, UTC+12, Fiji Standard Time, Kamchatka Standard Time, Tonga Standard Time, Samoa Standard Time, Line Islands Standard Time␊ - */␊ - timeZone: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A rule that provide the triggers and parameters for the scaling action.␊ - */␊ - export interface ScaleRule {␊ - /**␊ - * The trigger that results in a scaling action.␊ - */␊ - metricTrigger: (MetricTrigger | string)␊ - /**␊ - * The parameters for the scaling action.␊ - */␊ - scaleAction: (ScaleAction | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The trigger that results in a scaling action.␊ - */␊ - export interface MetricTrigger {␊ - /**␊ - * List of dimension conditions. For example: [{"DimensionName":"AppName","Operator":"Equals","Values":["App1"]},{"DimensionName":"Deployment","Operator":"Equals","Values":["default"]}].␊ - */␊ - dimensions?: (ScaleRuleMetricDimension[] | string)␊ - /**␊ - * a value indicating whether metric should divide per instance.␊ - */␊ - dividePerInstance?: (boolean | string)␊ - /**␊ - * the name of the metric that defines what the rule monitors.␊ - */␊ - metricName: string␊ - /**␊ - * the namespace of the metric that defines what the rule monitors.␊ - */␊ - metricNamespace?: string␊ - /**␊ - * the location of the resource the rule monitors.␊ - */␊ - metricResourceLocation?: string␊ - /**␊ - * the resource identifier of the resource the rule monitors.␊ - */␊ - metricResourceUri: string␊ - /**␊ - * the operator that is used to compare the metric data and the threshold.␊ - */␊ - operator: (("Equals" | "NotEquals" | "GreaterThan" | "GreaterThanOrEqual" | "LessThan" | "LessThanOrEqual") | string)␊ - /**␊ - * the metric statistic type. How the metrics from multiple instances are combined.␊ - */␊ - statistic: (("Average" | "Min" | "Max" | "Sum" | "Count") | string)␊ - /**␊ - * the threshold of the metric that triggers the scale action.␊ - */␊ - threshold: (number | string)␊ - /**␊ - * time aggregation type. How the data that is collected should be combined over time. The default value is Average.␊ - */␊ - timeAggregation: (("Average" | "Minimum" | "Maximum" | "Total" | "Count" | "Last") | string)␊ - /**␊ - * the granularity of metrics the rule monitors. Must be one of the predefined values returned from metric definitions for the metric. Must be between 12 hours and 1 minute.␊ - */␊ - timeGrain: string␊ - /**␊ - * the range of time in which instance data is collected. This value must be greater than the delay in metric collection, which can vary from resource-to-resource. Must be between 12 hours and 5 minutes.␊ - */␊ - timeWindow: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies an auto scale rule metric dimension.␊ - */␊ - export interface ScaleRuleMetricDimension {␊ - /**␊ - * Name of the dimension.␊ - */␊ - DimensionName: string␊ - /**␊ - * the dimension operator. Only 'Equals' and 'NotEquals' are supported. 'Equals' being equal to any of the values. 'NotEquals' being not equal to all of the values.␊ - */␊ - Operator: (("Equals" | "NotEquals") | string)␊ - /**␊ - * list of dimension values. For example: ["App1","App2"].␊ - */␊ - Values: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The parameters for the scaling action.␊ - */␊ - export interface ScaleAction {␊ - /**␊ - * the amount of time to wait since the last scaling action before this action occurs. It must be between 1 week and 1 minute in ISO 8601 format.␊ - */␊ - cooldown: string␊ - /**␊ - * the scale direction. Whether the scaling action increases or decreases the number of instances.␊ - */␊ - direction: (("None" | "Increase" | "Decrease") | string)␊ - /**␊ - * the type of action that should occur when the scale rule fires.␊ - */␊ - type: (("ChangeCount" | "PercentChangeCount" | "ExactCount" | "ServiceAllowedNextValue") | string)␊ - /**␊ - * the number of instances that are involved in the scaling action. This value must be 1 or greater. The default value is 1.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Insights/alertrules␊ - */␊ - export interface Alertrules1 {␊ - apiVersion: "2016-03-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the rule.␊ - */␊ - name: string␊ - /**␊ - * An alert rule.␊ - */␊ - properties: (AlertRule1 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Insights/alertrules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An alert rule.␊ - */␊ - export interface AlertRule1 {␊ - /**␊ - * The action that is performed when the alert rule becomes active, and when an alert condition is resolved.␊ - */␊ - action?: (RuleAction1 | string)␊ - /**␊ - * the array of actions that are performed when the alert rule becomes active, and when an alert condition is resolved.␊ - */␊ - actions?: ((RuleEmailAction1 | RuleWebhookAction1)[] | string)␊ - /**␊ - * The condition that results in the alert rule being activated.␊ - */␊ - condition: (RuleCondition1 | string)␊ - /**␊ - * the description of the alert rule that will be included in the alert email.␊ - */␊ - description?: string␊ - /**␊ - * the flag that indicates whether the alert rule is enabled.␊ - */␊ - isEnabled: (boolean | string)␊ - /**␊ - * the name of the alert rule.␊ - */␊ - name: string␊ - /**␊ - * the provisioning state.␊ - */␊ - provisioningState?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the action to send email when the rule condition is evaluated. The discriminator is always RuleEmailAction in this case.␊ - */␊ - export interface RuleEmailAction1 {␊ - /**␊ - * the list of administrator's custom email addresses to notify of the activation of the alert.␊ - */␊ - customEmails?: (string[] | string)␊ - "odata.type": "Microsoft.Azure.Management.Insights.Models.RuleEmailAction"␊ - /**␊ - * Whether the administrators (service and co-administrators) of the service should be notified when the alert is activated.␊ - */␊ - sendToServiceOwners?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the action to post to service when the rule condition is evaluated. The discriminator is always RuleWebhookAction in this case.␊ - */␊ - export interface RuleWebhookAction1 {␊ - "odata.type": "Microsoft.Azure.Management.Insights.Models.RuleWebhookAction"␊ - /**␊ - * the dictionary of custom properties to include with the post operation. These data are appended to the webhook payload.␊ - */␊ - properties?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * the service uri to Post the notification when the alert activates or resolves.␊ - */␊ - serviceUri?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A rule metric data source. The discriminator value is always RuleMetricDataSource in this case.␊ - */␊ - export interface RuleMetricDataSource1 {␊ - /**␊ - * the name of the metric that defines what the rule monitors.␊ - */␊ - metricName?: string␊ - "odata.type": "Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A rule management event data source. The discriminator fields is always RuleManagementEventDataSource in this case.␊ - */␊ - export interface RuleManagementEventDataSource1 {␊ - /**␊ - * The claims for a rule management event data source.␊ - */␊ - claims?: (RuleManagementEventClaimsDataSource1 | string)␊ - /**␊ - * the event name.␊ - */␊ - eventName?: string␊ - /**␊ - * the event source.␊ - */␊ - eventSource?: string␊ - /**␊ - * the level.␊ - */␊ - level?: string␊ - "odata.type": "Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource"␊ - /**␊ - * The name of the operation that should be checked for. If no name is provided, any operation will match.␊ - */␊ - operationName?: string␊ - /**␊ - * the resource group name.␊ - */␊ - resourceGroupName?: string␊ - /**␊ - * the resource provider name.␊ - */␊ - resourceProviderName?: string␊ - /**␊ - * The status of the operation that should be checked for. If no status is provided, any status will match.␊ - */␊ - status?: string␊ - /**␊ - * the substatus.␊ - */␊ - subStatus?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The claims for a rule management event data source.␊ - */␊ - export interface RuleManagementEventClaimsDataSource1 {␊ - /**␊ - * the email address.␊ - */␊ - emailAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A rule condition based on a metric crossing a threshold.␊ - */␊ - export interface ThresholdRuleCondition1 {␊ - "odata.type": "Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition"␊ - /**␊ - * the operator used to compare the data and the threshold.␊ - */␊ - operator: (("GreaterThan" | "GreaterThanOrEqual" | "LessThan" | "LessThanOrEqual") | string)␊ - /**␊ - * the threshold value that activates the alert.␊ - */␊ - threshold: (number | string)␊ - /**␊ - * the time aggregation operator. How the data that are collected should be combined over time. The default value is the PrimaryAggregationType of the Metric.␊ - */␊ - timeAggregation?: (("Average" | "Minimum" | "Maximum" | "Total" | "Last") | string)␊ - /**␊ - * the period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold. If specified then it must be between 5 minutes and 1 day.␊ - */␊ - windowSize?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A rule condition based on a certain number of locations failing.␊ - */␊ - export interface LocationThresholdRuleCondition1 {␊ - /**␊ - * the number of locations that must fail to activate the alert.␊ - */␊ - failedLocationCount: (number | string)␊ - "odata.type": "Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition"␊ - /**␊ - * the period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold. If specified then it must be between 5 minutes and 1 day.␊ - */␊ - windowSize?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A management event rule condition.␊ - */␊ - export interface ManagementEventRuleCondition1 {␊ - /**␊ - * How the data that is collected should be combined over time.␊ - */␊ - aggregation?: (ManagementEventAggregationCondition1 | string)␊ - "odata.type": "Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * How the data that is collected should be combined over time.␊ - */␊ - export interface ManagementEventAggregationCondition1 {␊ - /**␊ - * the condition operator.␊ - */␊ - operator?: (("GreaterThan" | "GreaterThanOrEqual" | "LessThan" | "LessThanOrEqual") | string)␊ - /**␊ - * The threshold value that activates the alert.␊ - */␊ - threshold?: (number | string)␊ - /**␊ - * the period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold. If specified then it must be between 5 minutes and 1 day.␊ - */␊ - windowSize?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * microsoft.insights/activityLogAlerts␊ - */␊ - export interface ActivityLogAlerts {␊ - apiVersion: "2017-03-01-preview"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the activity log alert.␊ - */␊ - name: string␊ - /**␊ - * An Azure activity log alert.␊ - */␊ - properties: (ActivityLogAlert | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "microsoft.insights/activityLogAlerts"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An Azure activity log alert.␊ - */␊ - export interface ActivityLogAlert {␊ - /**␊ - * A list of activity log alert actions.␊ - */␊ - actions: (ActivityLogAlertActionList | string)␊ - /**␊ - * An Activity Log alert condition that is met when all its member conditions are met.␊ - */␊ - condition: (ActivityLogAlertAllOfCondition | string)␊ - /**␊ - * A description of this activity log alert.␊ - */␊ - description?: string␊ - /**␊ - * Indicates whether this activity log alert is enabled. If an activity log alert is not enabled, then none of its actions will be activated.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * A list of resourceIds that will be used as prefixes. The alert will only apply to activityLogs with resourceIds that fall under one of these prefixes. This list must include at least one item.␊ - */␊ - scopes: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A list of activity log alert actions.␊ - */␊ - export interface ActivityLogAlertActionList {␊ - /**␊ - * The list of activity log alerts.␊ - */␊ - actionGroups?: (ActivityLogAlertActionGroup[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A pointer to an Azure Action Group.␊ - */␊ - export interface ActivityLogAlertActionGroup {␊ - /**␊ - * The resourceId of the action group. This cannot be null or empty.␊ - */␊ - actionGroupId: string␊ - /**␊ - * The dictionary of custom properties to include with the post operation. These data are appended to the webhook payload.␊ - */␊ - webhookProperties?: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An Activity Log alert condition that is met when all its member conditions are met.␊ - */␊ - export interface ActivityLogAlertAllOfCondition {␊ - /**␊ - * The list of activity log alert conditions.␊ - */␊ - allOf: (ActivityLogAlertLeafCondition[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An Activity Log alert condition that is met by comparing an activity log field and value.␊ - */␊ - export interface ActivityLogAlertLeafCondition {␊ - /**␊ - * The field value will be compared to this value (case-insensitive) to determine if the condition is met.␊ - */␊ - equals: string␊ - /**␊ - * The name of the field that this condition will examine. The possible values for this field are (case-insensitive): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType', or anything beginning with 'properties.'.␊ - */␊ - field: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * microsoft.insights/actionGroups␊ - */␊ - export interface ActionGroups {␊ - apiVersion: "2017-04-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the action group.␊ - */␊ - name: string␊ - /**␊ - * An Azure action group.␊ - */␊ - properties: (ActionGroup | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "microsoft.insights/actionGroups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An Azure action group.␊ - */␊ - export interface ActionGroup {␊ - /**␊ - * The list of AutomationRunbook receivers that are part of this action group.␊ - */␊ - automationRunbookReceivers?: (AutomationRunbookReceiver[] | string)␊ - /**␊ - * The list of AzureAppPush receivers that are part of this action group.␊ - */␊ - azureAppPushReceivers?: (AzureAppPushReceiver[] | string)␊ - /**␊ - * The list of email receivers that are part of this action group.␊ - */␊ - emailReceivers?: (EmailReceiver[] | string)␊ - /**␊ - * Indicates whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * The short name of the action group. This will be used in SMS messages.␊ - */␊ - groupShortName: string␊ - /**␊ - * The list of ITSM receivers that are part of this action group.␊ - */␊ - itsmReceivers?: (ItsmReceiver[] | string)␊ - /**␊ - * The list of SMS receivers that are part of this action group.␊ - */␊ - smsReceivers?: (SmsReceiver[] | string)␊ - /**␊ - * The list of webhook receivers that are part of this action group.␊ - */␊ - webhookReceivers?: (WebhookReceiver[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Azure Automation Runbook notification receiver.␊ - */␊ - export interface AutomationRunbookReceiver {␊ - /**␊ - * The Azure automation account Id which holds this runbook and authenticate to Azure resource.␊ - */␊ - automationAccountId: string␊ - /**␊ - * Indicates whether this instance is global runbook.␊ - */␊ - isGlobalRunbook: (boolean | string)␊ - /**␊ - * Indicates name of the webhook.␊ - */␊ - name?: string␊ - /**␊ - * The name for this runbook.␊ - */␊ - runbookName: string␊ - /**␊ - * The URI where webhooks should be sent.␊ - */␊ - serviceUri?: string␊ - /**␊ - * The resource id for webhook linked to this runbook.␊ - */␊ - webhookResourceId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Azure mobile App push notification receiver.␊ - */␊ - export interface AzureAppPushReceiver {␊ - /**␊ - * The email address registered for the Azure mobile app.␊ - */␊ - emailAddress: string␊ - /**␊ - * The name of the Azure mobile app push receiver. Names must be unique across all receivers within an action group.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An email receiver.␊ - */␊ - export interface EmailReceiver {␊ - /**␊ - * The email address of this receiver.␊ - */␊ - emailAddress: string␊ - /**␊ - * The name of the email receiver. Names must be unique across all receivers within an action group.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An Itsm receiver.␊ - */␊ - export interface ItsmReceiver {␊ - /**␊ - * Unique identification of ITSM connection among multiple defined in above workspace.␊ - */␊ - connectionId: string␊ - /**␊ - * The name of the Itsm receiver. Names must be unique across all receivers within an action group.␊ - */␊ - name: string␊ - /**␊ - * Region in which workspace resides. Supported values:'centralindia','japaneast','southeastasia','australiasoutheast','uksouth','westcentralus','canadacentral','eastus','westeurope'␊ - */␊ - region: string␊ - /**␊ - * JSON blob for the configurations of the ITSM action. CreateMultipleWorkItems option will be part of this blob as well.␊ - */␊ - ticketConfiguration: string␊ - /**␊ - * OMS LA instance identifier.␊ - */␊ - workspaceId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An SMS receiver.␊ - */␊ - export interface SmsReceiver {␊ - /**␊ - * The country code of the SMS receiver.␊ - */␊ - countryCode: string␊ - /**␊ - * The name of the SMS receiver. Names must be unique across all receivers within an action group.␊ - */␊ - name: string␊ - /**␊ - * The phone number of the SMS receiver.␊ - */␊ - phoneNumber: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A webhook receiver.␊ - */␊ - export interface WebhookReceiver {␊ - /**␊ - * The name of the webhook receiver. Names must be unique across all receivers within an action group.␊ - */␊ - name: string␊ - /**␊ - * The URI where webhooks should be sent.␊ - */␊ - serviceUri: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * microsoft.insights/activityLogAlerts␊ - */␊ - export interface ActivityLogAlerts1 {␊ - apiVersion: "2017-04-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the activity log alert.␊ - */␊ - name: string␊ - /**␊ - * An Azure activity log alert.␊ - */␊ - properties: (ActivityLogAlert1 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "microsoft.insights/activityLogAlerts"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An Azure activity log alert.␊ - */␊ - export interface ActivityLogAlert1 {␊ - /**␊ - * A list of activity log alert actions.␊ - */␊ - actions: (ActivityLogAlertActionList1 | string)␊ - /**␊ - * An Activity Log alert condition that is met when all its member conditions are met.␊ - */␊ - condition: (ActivityLogAlertAllOfCondition1 | string)␊ - /**␊ - * A description of this activity log alert.␊ - */␊ - description?: string␊ - /**␊ - * Indicates whether this activity log alert is enabled. If an activity log alert is not enabled, then none of its actions will be activated.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * A list of resourceIds that will be used as prefixes. The alert will only apply to activityLogs with resourceIds that fall under one of these prefixes. This list must include at least one item.␊ - */␊ - scopes: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A list of activity log alert actions.␊ - */␊ - export interface ActivityLogAlertActionList1 {␊ - /**␊ - * The list of activity log alerts.␊ - */␊ - actionGroups?: (ActivityLogAlertActionGroup1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A pointer to an Azure Action Group.␊ - */␊ - export interface ActivityLogAlertActionGroup1 {␊ - /**␊ - * The resourceId of the action group. This cannot be null or empty.␊ - */␊ - actionGroupId: string␊ - /**␊ - * the dictionary of custom properties to include with the post operation. These data are appended to the webhook payload.␊ - */␊ - webhookProperties?: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An Activity Log alert condition that is met when all its member conditions are met.␊ - */␊ - export interface ActivityLogAlertAllOfCondition1 {␊ - /**␊ - * The list of activity log alert conditions.␊ - */␊ - allOf: (ActivityLogAlertLeafCondition1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An Activity Log alert condition that is met by comparing an activity log field and value.␊ - */␊ - export interface ActivityLogAlertLeafCondition1 {␊ - /**␊ - * The field value will be compared to this value (case-insensitive) to determine if the condition is met.␊ - */␊ - equals: string␊ - /**␊ - * The name of the field that this condition will examine. The possible values for this field are (case-insensitive): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType', or anything beginning with 'properties.'.␊ - */␊ - field: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * microsoft.insights/actionGroups␊ - */␊ - export interface ActionGroups1 {␊ - apiVersion: "2018-03-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the action group.␊ - */␊ - name: string␊ - /**␊ - * An Azure action group.␊ - */␊ - properties: (ActionGroup1 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "microsoft.insights/actionGroups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An Azure action group.␊ - */␊ - export interface ActionGroup1 {␊ - /**␊ - * The list of AutomationRunbook receivers that are part of this action group.␊ - */␊ - automationRunbookReceivers?: (AutomationRunbookReceiver1[] | string)␊ - /**␊ - * The list of AzureAppPush receivers that are part of this action group.␊ - */␊ - azureAppPushReceivers?: (AzureAppPushReceiver1[] | string)␊ - /**␊ - * The list of azure function receivers that are part of this action group.␊ - */␊ - azureFunctionReceivers?: (AzureFunctionReceiver[] | string)␊ - /**␊ - * The list of email receivers that are part of this action group.␊ - */␊ - emailReceivers?: (EmailReceiver1[] | string)␊ - /**␊ - * Indicates whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * The short name of the action group. This will be used in SMS messages.␊ - */␊ - groupShortName: string␊ - /**␊ - * The list of ITSM receivers that are part of this action group.␊ - */␊ - itsmReceivers?: (ItsmReceiver1[] | string)␊ - /**␊ - * The list of logic app receivers that are part of this action group.␊ - */␊ - logicAppReceivers?: (LogicAppReceiver[] | string)␊ - /**␊ - * The list of SMS receivers that are part of this action group.␊ - */␊ - smsReceivers?: (SmsReceiver1[] | string)␊ - /**␊ - * The list of voice receivers that are part of this action group.␊ - */␊ - voiceReceivers?: (VoiceReceiver[] | string)␊ - /**␊ - * The list of webhook receivers that are part of this action group.␊ - */␊ - webhookReceivers?: (WebhookReceiver1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Azure Automation Runbook notification receiver.␊ - */␊ - export interface AutomationRunbookReceiver1 {␊ - /**␊ - * The Azure automation account Id which holds this runbook and authenticate to Azure resource.␊ - */␊ - automationAccountId: string␊ - /**␊ - * Indicates whether this instance is global runbook.␊ - */␊ - isGlobalRunbook: (boolean | string)␊ - /**␊ - * Indicates name of the webhook.␊ - */␊ - name?: string␊ - /**␊ - * The name for this runbook.␊ - */␊ - runbookName: string␊ - /**␊ - * The URI where webhooks should be sent.␊ - */␊ - serviceUri?: string␊ - /**␊ - * The resource id for webhook linked to this runbook.␊ - */␊ - webhookResourceId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Azure mobile App push notification receiver.␊ - */␊ - export interface AzureAppPushReceiver1 {␊ - /**␊ - * The email address registered for the Azure mobile app.␊ - */␊ - emailAddress: string␊ - /**␊ - * The name of the Azure mobile app push receiver. Names must be unique across all receivers within an action group.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An azure function receiver.␊ - */␊ - export interface AzureFunctionReceiver {␊ - /**␊ - * The azure resource id of the function app.␊ - */␊ - functionAppResourceId: string␊ - /**␊ - * The function name in the function app.␊ - */␊ - functionName: string␊ - /**␊ - * The http trigger url where http request sent to.␊ - */␊ - httpTriggerUrl: string␊ - /**␊ - * The name of the azure function receiver. Names must be unique across all receivers within an action group.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An email receiver.␊ - */␊ - export interface EmailReceiver1 {␊ - /**␊ - * The email address of this receiver.␊ - */␊ - emailAddress: string␊ - /**␊ - * The name of the email receiver. Names must be unique across all receivers within an action group.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An Itsm receiver.␊ - */␊ - export interface ItsmReceiver1 {␊ - /**␊ - * Unique identification of ITSM connection among multiple defined in above workspace.␊ - */␊ - connectionId: string␊ - /**␊ - * The name of the Itsm receiver. Names must be unique across all receivers within an action group.␊ - */␊ - name: string␊ - /**␊ - * Region in which workspace resides. Supported values:'centralindia','japaneast','southeastasia','australiasoutheast','uksouth','westcentralus','canadacentral','eastus','westeurope'␊ - */␊ - region: string␊ - /**␊ - * JSON blob for the configurations of the ITSM action. CreateMultipleWorkItems option will be part of this blob as well.␊ - */␊ - ticketConfiguration: string␊ - /**␊ - * OMS LA instance identifier.␊ - */␊ - workspaceId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A logic app receiver.␊ - */␊ - export interface LogicAppReceiver {␊ - /**␊ - * The callback url where http request sent to.␊ - */␊ - callbackUrl: string␊ - /**␊ - * The name of the logic app receiver. Names must be unique across all receivers within an action group.␊ - */␊ - name: string␊ - /**␊ - * The azure resource id of the logic app receiver.␊ - */␊ - resourceId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An SMS receiver.␊ - */␊ - export interface SmsReceiver1 {␊ - /**␊ - * The country code of the SMS receiver.␊ - */␊ - countryCode: string␊ - /**␊ - * The name of the SMS receiver. Names must be unique across all receivers within an action group.␊ - */␊ - name: string␊ - /**␊ - * The phone number of the SMS receiver.␊ - */␊ - phoneNumber: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A voice receiver.␊ - */␊ - export interface VoiceReceiver {␊ - /**␊ - * The country code of the voice receiver.␊ - */␊ - countryCode: string␊ - /**␊ - * The name of the voice receiver. Names must be unique across all receivers within an action group.␊ - */␊ - name: string␊ - /**␊ - * The phone number of the voice receiver.␊ - */␊ - phoneNumber: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A webhook receiver.␊ - */␊ - export interface WebhookReceiver1 {␊ - /**␊ - * The name of the webhook receiver. Names must be unique across all receivers within an action group.␊ - */␊ - name: string␊ - /**␊ - * The URI where webhooks should be sent.␊ - */␊ - serviceUri: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Insights/metricAlerts␊ - */␊ - export interface MetricAlerts {␊ - apiVersion: "2018-03-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the rule.␊ - */␊ - name: string␊ - /**␊ - * An alert rule.␊ - */␊ - properties: (MetricAlertProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Insights/metricAlerts"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An alert rule.␊ - */␊ - export interface MetricAlertProperties {␊ - /**␊ - * the array of actions that are performed when the alert rule becomes active, and when an alert condition is resolved.␊ - */␊ - actions?: (MetricAlertAction[] | string)␊ - /**␊ - * the flag that indicates whether the alert should be auto resolved or not. The default is true.␊ - */␊ - autoMitigate?: (boolean | string)␊ - /**␊ - * The rule criteria that defines the conditions of the alert rule.␊ - */␊ - criteria: (MetricAlertCriteria | string)␊ - /**␊ - * the description of the metric alert that will be included in the alert email.␊ - */␊ - description?: string␊ - /**␊ - * the flag that indicates whether the metric alert is enabled.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * how often the metric alert is evaluated represented in ISO 8601 duration format.␊ - */␊ - evaluationFrequency: string␊ - /**␊ - * the list of resource id's that this metric alert is scoped to.␊ - */␊ - scopes: (string[] | string)␊ - /**␊ - * Alert severity {0, 1, 2, 3, 4}␊ - */␊ - severity: (number | string)␊ - /**␊ - * the region of the target resource(s) on which the alert is created/updated. Mandatory if the scope contains a subscription, resource group, or more than one resource.␊ - */␊ - targetResourceRegion?: string␊ - /**␊ - * the resource type of the target resource(s) on which the alert is created/updated. Mandatory if the scope contains a subscription, resource group, or more than one resource.␊ - */␊ - targetResourceType?: string␊ - /**␊ - * the period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold.␊ - */␊ - windowSize: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An alert action.␊ - */␊ - export interface MetricAlertAction {␊ - /**␊ - * the id of the action group to use.␊ - */␊ - actionGroupId?: string␊ - /**␊ - * This field allows specifying custom properties, which would be appended to the alert payload sent as input to the webhook.␊ - */␊ - webHookProperties?: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the metric alert criteria for a single resource that has multiple metric criteria.␊ - */␊ - export interface MetricAlertSingleResourceMultipleMetricCriteria {␊ - /**␊ - * The list of metric criteria for this 'all of' operation. ␊ - */␊ - allOf?: (MetricCriteria[] | string)␊ - "odata.type": "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Criterion to filter metrics.␊ - */␊ - export interface MetricCriteria {␊ - /**␊ - * Unmatched properties from the message are deserialized this collection␊ - */␊ - additionalProperties?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - criterionType: "StaticThresholdCriterion"␊ - /**␊ - * List of dimension conditions.␊ - */␊ - dimensions?: (MetricDimension[] | string)␊ - /**␊ - * Name of the metric.␊ - */␊ - metricName: string␊ - /**␊ - * Namespace of the metric.␊ - */␊ - metricNamespace?: string␊ - /**␊ - * Name of the criteria.␊ - */␊ - name: string␊ - /**␊ - * the criteria operator.␊ - */␊ - operator: (("Equals" | "GreaterThan" | "GreaterThanOrEqual" | "LessThan" | "LessThanOrEqual") | string)␊ - /**␊ - * Allows creating an alert rule on a custom metric that isn't yet emitted, by causing the metric validation to be skipped.␊ - */␊ - skipMetricValidation?: (boolean | string)␊ - /**␊ - * the criteria threshold value that activates the alert.␊ - */␊ - threshold: (number | string)␊ - /**␊ - * the criteria time aggregation types.␊ - */␊ - timeAggregation: (("Average" | "Count" | "Minimum" | "Maximum" | "Total") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies a metric dimension.␊ - */␊ - export interface MetricDimension {␊ - /**␊ - * Name of the dimension.␊ - */␊ - name: string␊ - /**␊ - * the dimension operator. Only 'Include' and 'Exclude' are supported␊ - */␊ - operator: string␊ - /**␊ - * list of dimension values.␊ - */␊ - values: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the metric alert rule criteria for a web test resource.␊ - */␊ - export interface WebtestLocationAvailabilityCriteria {␊ - /**␊ - * The Application Insights resource Id.␊ - */␊ - componentId: string␊ - /**␊ - * The number of failed locations.␊ - */␊ - failedLocationCount: (number | string)␊ - "odata.type": "Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria"␊ - /**␊ - * The Application Insights web test Id.␊ - */␊ - webTestId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the metric alert criteria for multiple resource that has multiple metric criteria.␊ - */␊ - export interface MetricAlertMultipleResourceMultipleMetricCriteria {␊ - /**␊ - * the list of multiple metric criteria for this 'all of' operation. ␊ - */␊ - allOf?: (MultiMetricCriteria[] | string)␊ - "odata.type": "Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Criterion for dynamic threshold.␊ - */␊ - export interface DynamicMetricCriteria {␊ - /**␊ - * The extent of deviation required to trigger an alert. This will affect how tight the threshold is to the metric series pattern.␊ - */␊ - alertSensitivity: (("Low" | "Medium" | "High") | string)␊ - criterionType: "DynamicThresholdCriterion"␊ - /**␊ - * The minimum number of violations required within the selected lookback time window required to raise an alert.␊ - */␊ - failingPeriods: (DynamicThresholdFailingPeriods | string)␊ - /**␊ - * Use this option to set the date from which to start learning the metric historical data and calculate the dynamic thresholds (in ISO8601 format)␊ - */␊ - ignoreDataBefore?: string␊ - /**␊ - * The operator used to compare the metric value against the threshold.␊ - */␊ - operator: (("GreaterThan" | "LessThan" | "GreaterOrLessThan") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The minimum number of violations required within the selected lookback time window required to raise an alert.␊ - */␊ - export interface DynamicThresholdFailingPeriods {␊ - /**␊ - * The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods.␊ - */␊ - minFailingPeriodsToAlert: (number | string)␊ - /**␊ - * The number of aggregated lookback points. The lookback time window is calculated based on the aggregation granularity (windowSize) and the selected number of aggregated points.␊ - */␊ - numberOfEvaluationPeriods: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Insights/scheduledQueryRules␊ - */␊ - export interface ScheduledQueryRules {␊ - apiVersion: "2018-04-16"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the rule.␊ - */␊ - name: string␊ - /**␊ - * Log Search Rule Definition␊ - */␊ - properties: (LogSearchRule | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Insights/scheduledQueryRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Log Search Rule Definition␊ - */␊ - export interface LogSearchRule {␊ - /**␊ - * Action descriptor.␊ - */␊ - action: (Action2 | string)␊ - /**␊ - * The flag that indicates whether the alert should be automatically resolved or not. The default is false.␊ - */␊ - autoMitigate?: (boolean | string)␊ - /**␊ - * The description of the Log Search rule.␊ - */␊ - description?: string␊ - /**␊ - * The display name of the alert rule␊ - */␊ - displayName?: string␊ - /**␊ - * The flag which indicates whether the Log Search rule is enabled. Value should be true or false.␊ - */␊ - enabled?: (("true" | "false") | string)␊ - /**␊ - * Defines how often to run the search and the time interval.␊ - */␊ - schedule?: (Schedule1 | string)␊ - /**␊ - * Specifies the log search query.␊ - */␊ - source: (Source | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specify action need to be taken when rule type is Alert␊ - */␊ - export interface AlertingAction {␊ - /**␊ - * Azure action group␊ - */␊ - aznsAction?: (AzNsActionGroup | string)␊ - "odata.type": "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction"␊ - /**␊ - * Severity of the alert.␊ - */␊ - severity: (("0" | "1" | "2" | "3" | "4") | string)␊ - /**␊ - * time (in minutes) for which Alerts should be throttled or suppressed.␊ - */␊ - throttlingInMin?: (number | string)␊ - /**␊ - * The condition that results in the Log Search rule.␊ - */␊ - trigger: (TriggerCondition | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure action group␊ - */␊ - export interface AzNsActionGroup {␊ - /**␊ - * Azure Action Group reference.␊ - */␊ - actionGroup?: (string[] | string)␊ - /**␊ - * Custom payload to be sent for all webhook URI in Azure action group␊ - */␊ - customWebhookPayload?: string␊ - /**␊ - * Custom subject override for all email ids in Azure action group␊ - */␊ - emailSubject?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The condition that results in the Log Search rule.␊ - */␊ - export interface TriggerCondition {␊ - /**␊ - * A log metrics trigger descriptor.␊ - */␊ - metricTrigger?: (LogMetricTrigger | string)␊ - /**␊ - * Result or count threshold based on which rule should be triggered.␊ - */␊ - threshold: (number | string)␊ - /**␊ - * Evaluation operation for rule - 'GreaterThan' or 'LessThan.␊ - */␊ - thresholdOperator: (("GreaterThanOrEqual" | "LessThanOrEqual" | "GreaterThan" | "LessThan" | "Equal") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A log metrics trigger descriptor.␊ - */␊ - export interface LogMetricTrigger {␊ - /**␊ - * Evaluation of metric on a particular column␊ - */␊ - metricColumn?: string␊ - /**␊ - * Metric Trigger Type - 'Consecutive' or 'Total'.␊ - */␊ - metricTriggerType?: (("Consecutive" | "Total") | string)␊ - /**␊ - * The threshold of the metric trigger.␊ - */␊ - threshold?: (number | string)␊ - /**␊ - * Evaluation operation for Metric -'GreaterThan' or 'LessThan' or 'Equal'.␊ - */␊ - thresholdOperator?: (("GreaterThanOrEqual" | "LessThanOrEqual" | "GreaterThan" | "LessThan" | "Equal") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specify action need to be taken when rule type is converting log to metric␊ - */␊ - export interface LogToMetricAction {␊ - /**␊ - * Criteria of Metric␊ - */␊ - criteria: (Criteria[] | string)␊ - "odata.type": "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the criteria for converting log to metric.␊ - */␊ - export interface Criteria {␊ - /**␊ - * List of Dimensions for creating metric␊ - */␊ - dimensions?: (Dimension[] | string)␊ - /**␊ - * Name of the metric␊ - */␊ - metricName: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the criteria for converting log to metric.␊ - */␊ - export interface Dimension {␊ - /**␊ - * Name of the dimension␊ - */␊ - name: string␊ - /**␊ - * Operator for dimension values␊ - */␊ - operator: ("Include" | string)␊ - /**␊ - * List of dimension values␊ - */␊ - values: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Defines how often to run the search and the time interval.␊ - */␊ - export interface Schedule1 {␊ - /**␊ - * frequency (in minutes) at which rule condition should be evaluated.␊ - */␊ - frequencyInMinutes: (number | string)␊ - /**␊ - * Time window for which data needs to be fetched for query (should be greater than or equal to frequencyInMinutes).␊ - */␊ - timeWindowInMinutes: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the log search query.␊ - */␊ - export interface Source {␊ - /**␊ - * List of Resource referred into query␊ - */␊ - authorizedResources?: (string[] | string)␊ - /**␊ - * The resource uri over which log search query is to be run.␊ - */␊ - dataSourceId: string␊ - /**␊ - * Log search query. Required for action type - AlertingAction␊ - */␊ - query?: string␊ - /**␊ - * Set value to 'ResultCount'.␊ - */␊ - queryType?: ("ResultCount" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * microsoft.insights/guestDiagnosticSettings␊ - */␊ - export interface GuestDiagnosticSettings {␊ - apiVersion: "2018-06-01-preview"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the diagnostic setting.␊ - */␊ - name: string␊ - /**␊ - * Virtual machine diagnostic settings␊ - */␊ - properties: (GuestDiagnosticSettings1 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "microsoft.insights/guestDiagnosticSettings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Virtual machine diagnostic settings␊ - */␊ - export interface GuestDiagnosticSettings1 {␊ - /**␊ - * the array of data source object which are configured to collect and send data␊ - */␊ - dataSources?: (DataSource[] | string)␊ - /**␊ - * Operating system type for the configuration.␊ - */␊ - osType?: (("Windows" | "Linux") | string)␊ - proxySetting?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Data source object contains configuration to collect telemetry and one or more sinks to send that telemetry data to␊ - */␊ - export interface DataSource {␊ - configuration: (DataSourceConfiguration | string)␊ - /**␊ - * Datasource kind.␊ - */␊ - kind: (("PerformanceCounter" | "ETWProviders" | "WindowsEventLogs") | string)␊ - sinks: (SinkConfiguration[] | string)␊ - [k: string]: unknown␊ - }␊ - export interface DataSourceConfiguration {␊ - /**␊ - * Windows event logs configuration.␊ - */␊ - eventLogs?: (EventLogConfiguration[] | string)␊ - /**␊ - * Performance counter configuration␊ - */␊ - perfCounters?: (PerformanceCounterConfiguration[] | string)␊ - /**␊ - * ETW providers configuration␊ - */␊ - providers?: (EtwProviderConfiguration[] | string)␊ - [k: string]: unknown␊ - }␊ - export interface EventLogConfiguration {␊ - filter?: string␊ - logName: string␊ - [k: string]: unknown␊ - }␊ - export interface PerformanceCounterConfiguration {␊ - instance?: string␊ - name: string␊ - samplingPeriod: string␊ - [k: string]: unknown␊ - }␊ - export interface EtwProviderConfiguration {␊ - events: (EtwEventConfiguration[] | string)␊ - id: string␊ - [k: string]: unknown␊ - }␊ - export interface EtwEventConfiguration {␊ - filter?: string␊ - id: (number | string)␊ - name: string␊ - [k: string]: unknown␊ - }␊ - export interface SinkConfiguration {␊ - kind: (("EventHub" | "ApplicationInsights" | "LogAnalytics") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * microsoft.insights/actionGroups␊ - */␊ - export interface ActionGroups2 {␊ - apiVersion: "2018-09-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the action group.␊ - */␊ - name: string␊ - /**␊ - * An Azure action group.␊ - */␊ - properties: (ActionGroup2 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "microsoft.insights/actionGroups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An Azure action group.␊ - */␊ - export interface ActionGroup2 {␊ - /**␊ - * The list of ARM role receivers that are part of this action group. Roles are Azure RBAC roles and only built-in roles are supported.␊ - */␊ - armRoleReceivers?: (ArmRoleReceiver[] | string)␊ - /**␊ - * The list of AutomationRunbook receivers that are part of this action group.␊ - */␊ - automationRunbookReceivers?: (AutomationRunbookReceiver2[] | string)␊ - /**␊ - * The list of AzureAppPush receivers that are part of this action group.␊ - */␊ - azureAppPushReceivers?: (AzureAppPushReceiver2[] | string)␊ - /**␊ - * The list of azure function receivers that are part of this action group.␊ - */␊ - azureFunctionReceivers?: (AzureFunctionReceiver1[] | string)␊ - /**␊ - * The list of email receivers that are part of this action group.␊ - */␊ - emailReceivers?: (EmailReceiver2[] | string)␊ - /**␊ - * Indicates whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * The short name of the action group. This will be used in SMS messages.␊ - */␊ - groupShortName: string␊ - /**␊ - * The list of ITSM receivers that are part of this action group.␊ - */␊ - itsmReceivers?: (ItsmReceiver2[] | string)␊ - /**␊ - * The list of logic app receivers that are part of this action group.␊ - */␊ - logicAppReceivers?: (LogicAppReceiver1[] | string)␊ - /**␊ - * The list of SMS receivers that are part of this action group.␊ - */␊ - smsReceivers?: (SmsReceiver2[] | string)␊ - /**␊ - * The list of voice receivers that are part of this action group.␊ - */␊ - voiceReceivers?: (VoiceReceiver1[] | string)␊ - /**␊ - * The list of webhook receivers that are part of this action group.␊ - */␊ - webhookReceivers?: (WebhookReceiver2[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An arm role receiver.␊ - */␊ - export interface ArmRoleReceiver {␊ - /**␊ - * The name of the arm role receiver. Names must be unique across all receivers within an action group.␊ - */␊ - name: string␊ - /**␊ - * The arm role id.␊ - */␊ - roleId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Azure Automation Runbook notification receiver.␊ - */␊ - export interface AutomationRunbookReceiver2 {␊ - /**␊ - * The Azure automation account Id which holds this runbook and authenticate to Azure resource.␊ - */␊ - automationAccountId: string␊ - /**␊ - * Indicates whether this instance is global runbook.␊ - */␊ - isGlobalRunbook: (boolean | string)␊ - /**␊ - * Indicates name of the webhook.␊ - */␊ - name?: string␊ - /**␊ - * The name for this runbook.␊ - */␊ - runbookName: string␊ - /**␊ - * The URI where webhooks should be sent.␊ - */␊ - serviceUri?: string␊ - /**␊ - * The resource id for webhook linked to this runbook.␊ - */␊ - webhookResourceId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Azure mobile App push notification receiver.␊ - */␊ - export interface AzureAppPushReceiver2 {␊ - /**␊ - * The email address registered for the Azure mobile app.␊ - */␊ - emailAddress: string␊ - /**␊ - * The name of the Azure mobile app push receiver. Names must be unique across all receivers within an action group.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An azure function receiver.␊ - */␊ - export interface AzureFunctionReceiver1 {␊ - /**␊ - * The azure resource id of the function app.␊ - */␊ - functionAppResourceId: string␊ - /**␊ - * The function name in the function app.␊ - */␊ - functionName: string␊ - /**␊ - * The http trigger url where http request sent to.␊ - */␊ - httpTriggerUrl: string␊ - /**␊ - * The name of the azure function receiver. Names must be unique across all receivers within an action group.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An email receiver.␊ - */␊ - export interface EmailReceiver2 {␊ - /**␊ - * The email address of this receiver.␊ - */␊ - emailAddress: string␊ - /**␊ - * The name of the email receiver. Names must be unique across all receivers within an action group.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An Itsm receiver.␊ - */␊ - export interface ItsmReceiver2 {␊ - /**␊ - * Unique identification of ITSM connection among multiple defined in above workspace.␊ - */␊ - connectionId: string␊ - /**␊ - * The name of the Itsm receiver. Names must be unique across all receivers within an action group.␊ - */␊ - name: string␊ - /**␊ - * Region in which workspace resides. Supported values:'centralindia','japaneast','southeastasia','australiasoutheast','uksouth','westcentralus','canadacentral','eastus','westeurope'␊ - */␊ - region: string␊ - /**␊ - * JSON blob for the configurations of the ITSM action. CreateMultipleWorkItems option will be part of this blob as well.␊ - */␊ - ticketConfiguration: string␊ - /**␊ - * OMS LA instance identifier.␊ - */␊ - workspaceId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A logic app receiver.␊ - */␊ - export interface LogicAppReceiver1 {␊ - /**␊ - * The callback url where http request sent to.␊ - */␊ - callbackUrl: string␊ - /**␊ - * The name of the logic app receiver. Names must be unique across all receivers within an action group.␊ - */␊ - name: string␊ - /**␊ - * The azure resource id of the logic app receiver.␊ - */␊ - resourceId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An SMS receiver.␊ - */␊ - export interface SmsReceiver2 {␊ - /**␊ - * The country code of the SMS receiver.␊ - */␊ - countryCode: string␊ - /**␊ - * The name of the SMS receiver. Names must be unique across all receivers within an action group.␊ - */␊ - name: string␊ - /**␊ - * The phone number of the SMS receiver.␊ - */␊ - phoneNumber: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A voice receiver.␊ - */␊ - export interface VoiceReceiver1 {␊ - /**␊ - * The country code of the voice receiver.␊ - */␊ - countryCode: string␊ - /**␊ - * The name of the voice receiver. Names must be unique across all receivers within an action group.␊ - */␊ - name: string␊ - /**␊ - * The phone number of the voice receiver.␊ - */␊ - phoneNumber: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A webhook receiver.␊ - */␊ - export interface WebhookReceiver2 {␊ - /**␊ - * The name of the webhook receiver. Names must be unique across all receivers within an action group.␊ - */␊ - name: string␊ - /**␊ - * The URI where webhooks should be sent.␊ - */␊ - serviceUri: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * microsoft.insights/actionGroups␊ - */␊ - export interface ActionGroups3 {␊ - apiVersion: "2019-03-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the action group.␊ - */␊ - name: string␊ - /**␊ - * An Azure action group.␊ - */␊ - properties: (ActionGroup3 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "microsoft.insights/actionGroups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An Azure action group.␊ - */␊ - export interface ActionGroup3 {␊ - /**␊ - * The list of ARM role receivers that are part of this action group. Roles are Azure RBAC roles and only built-in roles are supported.␊ - */␊ - armRoleReceivers?: (ArmRoleReceiver1[] | string)␊ - /**␊ - * The list of AutomationRunbook receivers that are part of this action group.␊ - */␊ - automationRunbookReceivers?: (AutomationRunbookReceiver3[] | string)␊ - /**␊ - * The list of AzureAppPush receivers that are part of this action group.␊ - */␊ - azureAppPushReceivers?: (AzureAppPushReceiver3[] | string)␊ - /**␊ - * The list of azure function receivers that are part of this action group.␊ - */␊ - azureFunctionReceivers?: (AzureFunctionReceiver2[] | string)␊ - /**␊ - * The list of email receivers that are part of this action group.␊ - */␊ - emailReceivers?: (EmailReceiver3[] | string)␊ - /**␊ - * Indicates whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * The short name of the action group. This will be used in SMS messages.␊ - */␊ - groupShortName: string␊ - /**␊ - * The list of ITSM receivers that are part of this action group.␊ - */␊ - itsmReceivers?: (ItsmReceiver3[] | string)␊ - /**␊ - * The list of logic app receivers that are part of this action group.␊ - */␊ - logicAppReceivers?: (LogicAppReceiver2[] | string)␊ - /**␊ - * The list of SMS receivers that are part of this action group.␊ - */␊ - smsReceivers?: (SmsReceiver3[] | string)␊ - /**␊ - * The list of voice receivers that are part of this action group.␊ - */␊ - voiceReceivers?: (VoiceReceiver2[] | string)␊ - /**␊ - * The list of webhook receivers that are part of this action group.␊ - */␊ - webhookReceivers?: (WebhookReceiver3[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An arm role receiver.␊ - */␊ - export interface ArmRoleReceiver1 {␊ - /**␊ - * The name of the arm role receiver. Names must be unique across all receivers within an action group.␊ - */␊ - name: string␊ - /**␊ - * The arm role id.␊ - */␊ - roleId: string␊ - /**␊ - * Indicates whether to use common alert schema.␊ - */␊ - useCommonAlertSchema?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Azure Automation Runbook notification receiver.␊ - */␊ - export interface AutomationRunbookReceiver3 {␊ - /**␊ - * The Azure automation account Id which holds this runbook and authenticate to Azure resource.␊ - */␊ - automationAccountId: string␊ - /**␊ - * Indicates whether this instance is global runbook.␊ - */␊ - isGlobalRunbook: (boolean | string)␊ - /**␊ - * Indicates name of the webhook.␊ - */␊ - name?: string␊ - /**␊ - * The name for this runbook.␊ - */␊ - runbookName: string␊ - /**␊ - * The URI where webhooks should be sent.␊ - */␊ - serviceUri?: string␊ - /**␊ - * Indicates whether to use common alert schema.␊ - */␊ - useCommonAlertSchema?: (boolean | string)␊ - /**␊ - * The resource id for webhook linked to this runbook.␊ - */␊ - webhookResourceId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Azure mobile App push notification receiver.␊ - */␊ - export interface AzureAppPushReceiver3 {␊ - /**␊ - * The email address registered for the Azure mobile app.␊ - */␊ - emailAddress: string␊ - /**␊ - * The name of the Azure mobile app push receiver. Names must be unique across all receivers within an action group.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An azure function receiver.␊ - */␊ - export interface AzureFunctionReceiver2 {␊ - /**␊ - * The azure resource id of the function app.␊ - */␊ - functionAppResourceId: string␊ - /**␊ - * The function name in the function app.␊ - */␊ - functionName: string␊ - /**␊ - * The http trigger url where http request sent to.␊ - */␊ - httpTriggerUrl: string␊ - /**␊ - * The name of the azure function receiver. Names must be unique across all receivers within an action group.␊ - */␊ - name: string␊ - /**␊ - * Indicates whether to use common alert schema.␊ - */␊ - useCommonAlertSchema?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An email receiver.␊ - */␊ - export interface EmailReceiver3 {␊ - /**␊ - * The email address of this receiver.␊ - */␊ - emailAddress: string␊ - /**␊ - * The name of the email receiver. Names must be unique across all receivers within an action group.␊ - */␊ - name: string␊ - /**␊ - * Indicates whether to use common alert schema.␊ - */␊ - useCommonAlertSchema?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An Itsm receiver.␊ - */␊ - export interface ItsmReceiver3 {␊ - /**␊ - * Unique identification of ITSM connection among multiple defined in above workspace.␊ - */␊ - connectionId: string␊ - /**␊ - * The name of the Itsm receiver. Names must be unique across all receivers within an action group.␊ - */␊ - name: string␊ - /**␊ - * Region in which workspace resides. Supported values:'centralindia','japaneast','southeastasia','australiasoutheast','uksouth','westcentralus','canadacentral','eastus','westeurope'␊ - */␊ - region: string␊ - /**␊ - * JSON blob for the configurations of the ITSM action. CreateMultipleWorkItems option will be part of this blob as well.␊ - */␊ - ticketConfiguration: string␊ - /**␊ - * OMS LA instance identifier.␊ - */␊ - workspaceId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A logic app receiver.␊ - */␊ - export interface LogicAppReceiver2 {␊ - /**␊ - * The callback url where http request sent to.␊ - */␊ - callbackUrl: string␊ - /**␊ - * The name of the logic app receiver. Names must be unique across all receivers within an action group.␊ - */␊ - name: string␊ - /**␊ - * The azure resource id of the logic app receiver.␊ - */␊ - resourceId: string␊ - /**␊ - * Indicates whether to use common alert schema.␊ - */␊ - useCommonAlertSchema?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An SMS receiver.␊ - */␊ - export interface SmsReceiver3 {␊ - /**␊ - * The country code of the SMS receiver.␊ - */␊ - countryCode: string␊ - /**␊ - * The name of the SMS receiver. Names must be unique across all receivers within an action group.␊ - */␊ - name: string␊ - /**␊ - * The phone number of the SMS receiver.␊ - */␊ - phoneNumber: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A voice receiver.␊ - */␊ - export interface VoiceReceiver2 {␊ - /**␊ - * The country code of the voice receiver.␊ - */␊ - countryCode: string␊ - /**␊ - * The name of the voice receiver. Names must be unique across all receivers within an action group.␊ - */␊ - name: string␊ - /**␊ - * The phone number of the voice receiver.␊ - */␊ - phoneNumber: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A webhook receiver.␊ - */␊ - export interface WebhookReceiver3 {␊ - /**␊ - * The name of the webhook receiver. Names must be unique across all receivers within an action group.␊ - */␊ - name: string␊ - /**␊ - * The URI where webhooks should be sent.␊ - */␊ - serviceUri: string␊ - /**␊ - * Indicates whether to use common alert schema.␊ - */␊ - useCommonAlertSchema?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * microsoft.insights/actionGroups␊ - */␊ - export interface ActionGroups4 {␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the action group.␊ - */␊ - name: string␊ - /**␊ - * An Azure action group.␊ - */␊ - properties: (ActionGroup4 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "microsoft.insights/actionGroups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An Azure action group.␊ - */␊ - export interface ActionGroup4 {␊ - /**␊ - * The list of ARM role receivers that are part of this action group. Roles are Azure RBAC roles and only built-in roles are supported.␊ - */␊ - armRoleReceivers?: (ArmRoleReceiver2[] | string)␊ - /**␊ - * The list of AutomationRunbook receivers that are part of this action group.␊ - */␊ - automationRunbookReceivers?: (AutomationRunbookReceiver4[] | string)␊ - /**␊ - * The list of AzureAppPush receivers that are part of this action group.␊ - */␊ - azureAppPushReceivers?: (AzureAppPushReceiver4[] | string)␊ - /**␊ - * The list of azure function receivers that are part of this action group.␊ - */␊ - azureFunctionReceivers?: (AzureFunctionReceiver3[] | string)␊ - /**␊ - * The list of email receivers that are part of this action group.␊ - */␊ - emailReceivers?: (EmailReceiver4[] | string)␊ - /**␊ - * Indicates whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications.␊ - */␊ - enabled: (boolean | string)␊ - /**␊ - * The short name of the action group. This will be used in SMS messages.␊ - */␊ - groupShortName: string␊ - /**␊ - * The list of ITSM receivers that are part of this action group.␊ - */␊ - itsmReceivers?: (ItsmReceiver4[] | string)␊ - /**␊ - * The list of logic app receivers that are part of this action group.␊ - */␊ - logicAppReceivers?: (LogicAppReceiver3[] | string)␊ - /**␊ - * The list of SMS receivers that are part of this action group.␊ - */␊ - smsReceivers?: (SmsReceiver4[] | string)␊ - /**␊ - * The list of voice receivers that are part of this action group.␊ - */␊ - voiceReceivers?: (VoiceReceiver3[] | string)␊ - /**␊ - * The list of webhook receivers that are part of this action group.␊ - */␊ - webhookReceivers?: (WebhookReceiver4[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An arm role receiver.␊ - */␊ - export interface ArmRoleReceiver2 {␊ - /**␊ - * The name of the arm role receiver. Names must be unique across all receivers within an action group.␊ - */␊ - name: string␊ - /**␊ - * The arm role id.␊ - */␊ - roleId: string␊ - /**␊ - * Indicates whether to use common alert schema.␊ - */␊ - useCommonAlertSchema?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Azure Automation Runbook notification receiver.␊ - */␊ - export interface AutomationRunbookReceiver4 {␊ - /**␊ - * The Azure automation account Id which holds this runbook and authenticate to Azure resource.␊ - */␊ - automationAccountId: string␊ - /**␊ - * Indicates whether this instance is global runbook.␊ - */␊ - isGlobalRunbook: (boolean | string)␊ - /**␊ - * Indicates name of the webhook.␊ - */␊ - name?: string␊ - /**␊ - * The name for this runbook.␊ - */␊ - runbookName: string␊ - /**␊ - * The URI where webhooks should be sent.␊ - */␊ - serviceUri?: string␊ - /**␊ - * Indicates whether to use common alert schema.␊ - */␊ - useCommonAlertSchema?: (boolean | string)␊ - /**␊ - * The resource id for webhook linked to this runbook.␊ - */␊ - webhookResourceId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The Azure mobile App push notification receiver.␊ - */␊ - export interface AzureAppPushReceiver4 {␊ - /**␊ - * The email address registered for the Azure mobile app.␊ - */␊ - emailAddress: string␊ - /**␊ - * The name of the Azure mobile app push receiver. Names must be unique across all receivers within an action group.␊ - */␊ - name: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An azure function receiver.␊ - */␊ - export interface AzureFunctionReceiver3 {␊ - /**␊ - * The azure resource id of the function app.␊ - */␊ - functionAppResourceId: string␊ - /**␊ - * The function name in the function app.␊ - */␊ - functionName: string␊ - /**␊ - * The http trigger url where http request sent to.␊ - */␊ - httpTriggerUrl: string␊ - /**␊ - * The name of the azure function receiver. Names must be unique across all receivers within an action group.␊ - */␊ - name: string␊ - /**␊ - * Indicates whether to use common alert schema.␊ - */␊ - useCommonAlertSchema?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An email receiver.␊ - */␊ - export interface EmailReceiver4 {␊ - /**␊ - * The email address of this receiver.␊ - */␊ - emailAddress: string␊ - /**␊ - * The name of the email receiver. Names must be unique across all receivers within an action group.␊ - */␊ - name: string␊ - /**␊ - * Indicates whether to use common alert schema.␊ - */␊ - useCommonAlertSchema?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An Itsm receiver.␊ - */␊ - export interface ItsmReceiver4 {␊ - /**␊ - * Unique identification of ITSM connection among multiple defined in above workspace.␊ - */␊ - connectionId: string␊ - /**␊ - * The name of the Itsm receiver. Names must be unique across all receivers within an action group.␊ - */␊ - name: string␊ - /**␊ - * Region in which workspace resides. Supported values:'centralindia','japaneast','southeastasia','australiasoutheast','uksouth','westcentralus','canadacentral','eastus','westeurope'␊ - */␊ - region: string␊ - /**␊ - * JSON blob for the configurations of the ITSM action. CreateMultipleWorkItems option will be part of this blob as well.␊ - */␊ - ticketConfiguration: string␊ - /**␊ - * OMS LA instance identifier.␊ - */␊ - workspaceId: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A logic app receiver.␊ - */␊ - export interface LogicAppReceiver3 {␊ - /**␊ - * The callback url where http request sent to.␊ - */␊ - callbackUrl: string␊ - /**␊ - * The name of the logic app receiver. Names must be unique across all receivers within an action group.␊ - */␊ - name: string␊ - /**␊ - * The azure resource id of the logic app receiver.␊ - */␊ - resourceId: string␊ - /**␊ - * Indicates whether to use common alert schema.␊ - */␊ - useCommonAlertSchema?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An SMS receiver.␊ - */␊ - export interface SmsReceiver4 {␊ - /**␊ - * The country code of the SMS receiver.␊ - */␊ - countryCode: string␊ - /**␊ - * The name of the SMS receiver. Names must be unique across all receivers within an action group.␊ - */␊ - name: string␊ - /**␊ - * The phone number of the SMS receiver.␊ - */␊ - phoneNumber: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A voice receiver.␊ - */␊ - export interface VoiceReceiver3 {␊ - /**␊ - * The country code of the voice receiver.␊ - */␊ - countryCode: string␊ - /**␊ - * The name of the voice receiver. Names must be unique across all receivers within an action group.␊ - */␊ - name: string␊ - /**␊ - * The phone number of the voice receiver.␊ - */␊ - phoneNumber: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A webhook receiver.␊ - */␊ - export interface WebhookReceiver4 {␊ - /**␊ - * Indicates the identifier uri for aad auth.␊ - */␊ - identifierUri?: string␊ - /**␊ - * The name of the webhook receiver. Names must be unique across all receivers within an action group.␊ - */␊ - name: string␊ - /**␊ - * Indicates the webhook app object Id for aad auth.␊ - */␊ - objectId?: string␊ - /**␊ - * The URI where webhooks should be sent.␊ - */␊ - serviceUri: string␊ - /**␊ - * Indicates the tenant id for aad auth.␊ - */␊ - tenantId?: string␊ - /**␊ - * Indicates whether or not use AAD authentication.␊ - */␊ - useAadAuth?: (boolean | string)␊ - /**␊ - * Indicates whether to use common alert schema.␊ - */␊ - useCommonAlertSchema?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * microsoft.insights/privateLinkScopes␊ - */␊ - export interface PrivateLinkScopes {␊ - apiVersion: "2019-10-17-preview"␊ - /**␊ - * Resource location␊ - */␊ - location: string␊ - /**␊ - * The name of the Azure Monitor PrivateLinkScope resource.␊ - */␊ - name: string␊ - /**␊ - * Properties that define a Azure Monitor PrivateLinkScope resource.␊ - */␊ - properties: (AzureMonitorPrivateLinkScopeProperties | string)␊ - resources?: (PrivateLinkScopesPrivateEndpointConnectionsChildResource | PrivateLinkScopesScopedResourcesChildResource)[]␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "microsoft.insights/privateLinkScopes"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties that define a Azure Monitor PrivateLinkScope resource.␊ - */␊ - export interface AzureMonitorPrivateLinkScopeProperties {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Insights/privateLinkScopes/privateEndpointConnections␊ - */␊ - export interface PrivateLinkScopesPrivateEndpointConnectionsChildResource {␊ - apiVersion: "2019-10-17-preview"␊ - /**␊ - * The name of the private endpoint connection.␊ - */␊ - name: string␊ - /**␊ - * Properties of a private endpoint connection.␊ - */␊ - properties: (PrivateEndpointConnectionProperties22 | string)␊ - type: "privateEndpointConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a private endpoint connection.␊ - */␊ - export interface PrivateEndpointConnectionProperties22 {␊ - /**␊ - * Private endpoint which the connection belongs to.␊ - */␊ - privateEndpoint?: (PrivateEndpointProperty1 | string)␊ - /**␊ - * State of the private endpoint connection.␊ - */␊ - privateLinkServiceConnectionState?: (PrivateLinkServiceConnectionStateProperty1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Private endpoint which the connection belongs to.␊ - */␊ - export interface PrivateEndpointProperty1 {␊ - /**␊ - * Resource id of the private endpoint.␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * State of the private endpoint connection.␊ - */␊ - export interface PrivateLinkServiceConnectionStateProperty1 {␊ - /**␊ - * The private link service connection description.␊ - */␊ - description: string␊ - /**␊ - * The private link service connection status.␊ - */␊ - status: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Insights/privateLinkScopes/scopedResources␊ - */␊ - export interface PrivateLinkScopesScopedResourcesChildResource {␊ - apiVersion: "2019-10-17-preview"␊ - /**␊ - * The name of the scoped resource object.␊ - */␊ - name: string␊ - /**␊ - * Properties of a private link scoped resource.␊ - */␊ - properties: (ScopedResourceProperties | string)␊ - type: "scopedResources"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a private link scoped resource.␊ - */␊ - export interface ScopedResourceProperties {␊ - /**␊ - * The resource id of the scoped Azure monitor resource.␊ - */␊ - linkedResourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Insights/privateLinkScopes/privateEndpointConnections␊ - */␊ - export interface PrivateLinkScopesPrivateEndpointConnections {␊ - apiVersion: "2019-10-17-preview"␊ - /**␊ - * The name of the private endpoint connection.␊ - */␊ - name: string␊ - /**␊ - * Properties of a private endpoint connection.␊ - */␊ - properties: (PrivateEndpointConnectionProperties22 | string)␊ - type: "Microsoft.Insights/privateLinkScopes/privateEndpointConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Insights/privateLinkScopes/scopedResources␊ - */␊ - export interface PrivateLinkScopesScopedResources {␊ - apiVersion: "2019-10-17-preview"␊ - /**␊ - * The name of the scoped resource object.␊ - */␊ - name: string␊ - /**␊ - * Properties of a private link scoped resource.␊ - */␊ - properties: (ScopedResourceProperties | string)␊ - type: "Microsoft.Insights/privateLinkScopes/scopedResources"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Insights/dataCollectionRules␊ - */␊ - export interface DataCollectionRules {␊ - apiVersion: "2019-11-01-preview"␊ - /**␊ - * The kind of the resource.␊ - */␊ - kind?: (("Linux" | "Windows") | string)␊ - /**␊ - * The geo-location where the resource lives.␊ - */␊ - location: string␊ - /**␊ - * The name of the data collection rule. The name is case insensitive.␊ - */␊ - name: string␊ - /**␊ - * Resource properties.␊ - */␊ - properties: (DataCollectionRuleResourceProperties | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Insights/dataCollectionRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Resource properties.␊ - */␊ - export interface DataCollectionRuleResourceProperties {␊ - /**␊ - * The specification of data flows.␊ - */␊ - dataFlows?: (DataFlow1[] | string)␊ - /**␊ - * The specification of data sources. ␍␊ - * This property is optional and can be omitted if the rule is meant to be used via direct calls to the provisioned endpoint.␊ - */␊ - dataSources?: (DataCollectionRuleDataSources | string)␊ - /**␊ - * Description of the data collection rule.␊ - */␊ - description?: string␊ - /**␊ - * The specification of destinations.␊ - */␊ - destinations?: (DataCollectionRuleDestinations | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Definition of which streams are sent to which destinations.␊ - */␊ - export interface DataFlow1 {␊ - /**␊ - * List of destinations for this data flow.␊ - */␊ - destinations?: (string[] | string)␊ - /**␊ - * List of streams for this data flow.␊ - */␊ - streams?: (("Microsoft-Event" | "Microsoft-InsightsMetrics" | "Microsoft-Perf" | "Microsoft-Syslog" | "Microsoft-WindowsEvent")[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The specification of data sources. ␍␊ - * This property is optional and can be omitted if the rule is meant to be used via direct calls to the provisioned endpoint.␊ - */␊ - export interface DataCollectionRuleDataSources {␊ - /**␊ - * The list of Azure VM extension data source configurations.␊ - */␊ - extensions?: (ExtensionDataSource[] | string)␊ - /**␊ - * The list of performance counter data source configurations.␊ - */␊ - performanceCounters?: (PerfCounterDataSource[] | string)␊ - /**␊ - * The list of Syslog data source configurations.␊ - */␊ - syslog?: (SyslogDataSource[] | string)␊ - /**␊ - * The list of Windows Event Log data source configurations.␊ - */␊ - windowsEventLogs?: (WindowsEventLogDataSource[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Definition of which data will be collected from a separate VM extension that integrates with the Azure Monitor Agent.␍␊ - * Collected from either Windows and Linux machines, depending on which extension is defined.␊ - */␊ - export interface ExtensionDataSource {␊ - /**␊ - * The name of the VM extension.␊ - */␊ - extensionName: string␊ - /**␊ - * The extension settings. The format is specific for particular extension.␊ - */␊ - extensionSettings?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The list of data sources this extension needs data from.␊ - */␊ - inputDataSources?: (string[] | string)␊ - /**␊ - * A friendly name for the data source. ␍␊ - * This name should be unique across all data sources (regardless of type) within the data collection rule.␊ - */␊ - name?: string␊ - /**␊ - * List of streams that this data source will be sent to.␍␊ - * A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to.␊ - */␊ - streams?: (("Microsoft-Event" | "Microsoft-InsightsMetrics" | "Microsoft-Perf" | "Microsoft-Syslog" | "Microsoft-WindowsEvent")[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Definition of which performance counters will be collected and how they will be collected by this data collection rule.␍␊ - * Collected from both Windows and Linux machines where the counter is present.␊ - */␊ - export interface PerfCounterDataSource {␊ - /**␊ - * A list of specifier names of the performance counters you want to collect.␍␊ - * Use a wildcard (*) to collect a counter for all instances.␍␊ - * To get a list of performance counters on Windows, run the command 'typeperf'.␊ - */␊ - counterSpecifiers?: (string[] | string)␊ - /**␊ - * A friendly name for the data source. ␍␊ - * This name should be unique across all data sources (regardless of type) within the data collection rule.␊ - */␊ - name?: string␊ - /**␊ - * The number of seconds between consecutive counter measurements (samples).␊ - */␊ - samplingFrequencyInSeconds?: (number | string)␊ - /**␊ - * List of streams that this data source will be sent to.␍␊ - * A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to.␊ - */␊ - streams?: (("Microsoft-Perf" | "Microsoft-InsightsMetrics")[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Definition of which syslog data will be collected and how it will be collected.␍␊ - * Only collected from Linux machines.␊ - */␊ - export interface SyslogDataSource {␊ - /**␊ - * The list of facility names.␊ - */␊ - facilityNames?: (("auth" | "authpriv" | "cron" | "daemon" | "kern" | "lpr" | "mail" | "mark" | "news" | "syslog" | "user" | "uucp" | "local0" | "local1" | "local2" | "local3" | "local4" | "local5" | "local6" | "local7" | "*")[] | string)␊ - /**␊ - * The log levels to collect.␊ - */␊ - logLevels?: (("Debug" | "Info" | "Notice" | "Warning" | "Error" | "Critical" | "Alert" | "Emergency" | "*")[] | string)␊ - /**␊ - * A friendly name for the data source. ␍␊ - * This name should be unique across all data sources (regardless of type) within the data collection rule.␊ - */␊ - name?: string␊ - /**␊ - * List of streams that this data source will be sent to.␍␊ - * A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to.␊ - */␊ - streams?: (("Microsoft-Syslog")[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Definition of which Windows Event Log events will be collected and how they will be collected.␍␊ - * Only collected from Windows machines.␊ - */␊ - export interface WindowsEventLogDataSource {␊ - /**␊ - * A friendly name for the data source. ␍␊ - * This name should be unique across all data sources (regardless of type) within the data collection rule.␊ - */␊ - name?: string␊ - /**␊ - * List of streams that this data source will be sent to.␍␊ - * A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to.␊ - */␊ - streams?: (("Microsoft-WindowsEvent" | "Microsoft-Event")[] | string)␊ - /**␊ - * A list of Windows Event Log queries in XPATH format.␊ - */␊ - xPathQueries?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The specification of destinations.␊ - */␊ - export interface DataCollectionRuleDestinations {␊ - /**␊ - * Azure Monitor Metrics destination.␊ - */␊ - azureMonitorMetrics?: (DestinationsSpecAzureMonitorMetrics | string)␊ - /**␊ - * List of Log Analytics destinations.␊ - */␊ - logAnalytics?: (LogAnalyticsDestination[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Monitor Metrics destination.␊ - */␊ - export interface DestinationsSpecAzureMonitorMetrics {␊ - /**␊ - * A friendly name for the destination. ␍␊ - * This name should be unique across all destinations (regardless of type) within the data collection rule.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Log Analytics destination.␊ - */␊ - export interface LogAnalyticsDestination {␊ - /**␊ - * A friendly name for the destination. ␍␊ - * This name should be unique across all destinations (regardless of type) within the data collection rule.␊ - */␊ - name?: string␊ - /**␊ - * The resource ID of the Log Analytics workspace.␊ - */␊ - workspaceResourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Insights/scheduledQueryRules␊ - */␊ - export interface ScheduledQueryRules1 {␊ - apiVersion: "2020-05-01-preview"␊ - /**␊ - * The geo-location where the resource lives␊ - */␊ - location: string␊ - /**␊ - * The name of the rule.␊ - */␊ - name: string␊ - /**␊ - * scheduled query rule Definition␊ - */␊ - properties: (ScheduledQueryRuleProperties | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Insights/scheduledQueryRules"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * scheduled query rule Definition␊ - */␊ - export interface ScheduledQueryRuleProperties {␊ - actions?: (Action3[] | string)␊ - /**␊ - * The rule criteria that defines the conditions of the scheduled query rule.␊ - */␊ - criteria?: (ScheduledQueryRuleCriteria | string)␊ - /**␊ - * The description of the scheduled query rule.␊ - */␊ - description?: string␊ - /**␊ - * The display name of the alert rule␊ - */␊ - displayName?: string␊ - /**␊ - * The flag which indicates whether this scheduled query rule is enabled. Value should be true or false␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * How often the scheduled query rule is evaluated represented in ISO 8601 duration format.␊ - */␊ - evaluationFrequency?: string␊ - /**␊ - * Mute actions for the chosen period of time (in ISO 8601 duration format) after the alert is fired.␊ - */␊ - muteActionsDuration?: string␊ - /**␊ - * If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods)␊ - */␊ - overrideQueryTimeRange?: string␊ - /**␊ - * The list of resource id's that this scheduled query rule is scoped to.␊ - */␊ - scopes?: (string[] | string)␊ - /**␊ - * Severity of the alert. Should be an integer between [0-4]. Value of 0 is severest␊ - */␊ - severity?: (number | string)␊ - /**␊ - * List of resource type of the target resource(s) on which the alert is created/updated. For example if the scope is a resource group and targetResourceTypes is Microsoft.Compute/virtualMachines, then a different alert will be fired for each virtual machine in the resource group which meet the alert criteria␊ - */␊ - targetResourceTypes?: (string[] | string)␊ - /**␊ - * The period of time (in ISO 8601 duration format) on which the Alert query will be executed (bin size).␊ - */␊ - windowSize?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Actions to invoke when the alert fires.␊ - */␊ - export interface Action3 {␊ - /**␊ - * Action Group resource Id to invoke when the alert fires.␊ - */␊ - actionGroupId?: string␊ - /**␊ - * The properties of a webhook object.␊ - */␊ - webHookProperties?: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The rule criteria that defines the conditions of the scheduled query rule.␊ - */␊ - export interface ScheduledQueryRuleCriteria {␊ - /**␊ - * A list of conditions to evaluate against the specified scopes␊ - */␊ - allOf?: (Condition[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A condition of the scheduled query rule.␊ - */␊ - export interface Condition {␊ - /**␊ - * List of Dimensions conditions␊ - */␊ - dimensions?: (Dimension1[] | string)␊ - /**␊ - * The minimum number of violations required within the selected lookback time window required to raise an alert.␊ - */␊ - failingPeriods?: (ConditionFailingPeriods | string)␊ - /**␊ - * The column containing the metric measure number.␊ - */␊ - metricMeasureColumn?: string␊ - /**␊ - * The criteria operator.␊ - */␊ - operator: (("Equals" | "GreaterThan" | "GreaterThanOrEqual" | "LessThan" | "LessThanOrEqual") | string)␊ - /**␊ - * Log query alert␊ - */␊ - query?: string␊ - /**␊ - * The column containing the resource id. The content of the column must be a uri formatted as resource id␊ - */␊ - resourceIdColumn?: string␊ - /**␊ - * the criteria threshold value that activates the alert.␊ - */␊ - threshold: (number | string)␊ - /**␊ - * Aggregation type.␊ - */␊ - timeAggregation: (("Count" | "Average" | "Minimum" | "Maximum" | "Total") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Dimension splitting and filtering definition␊ - */␊ - export interface Dimension1 {␊ - /**␊ - * Name of the dimension␊ - */␊ - name: string␊ - /**␊ - * Operator for dimension values.␊ - */␊ - operator: (("Include" | "Exclude") | string)␊ - /**␊ - * List of dimension values␊ - */␊ - values: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The minimum number of violations required within the selected lookback time window required to raise an alert.␊ - */␊ - export interface ConditionFailingPeriods {␊ - /**␊ - * The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods. Default value is 1␊ - */␊ - minFailingPeriodsToAlert?: ((number & string) | string)␊ - /**␊ - * The number of aggregated lookback points. The lookback time window is calculated based on the aggregation granularity (windowSize) and the selected number of aggregated points. Default value is 1␊ - */␊ - numberOfEvaluationPeriods?: ((number & string) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Quantum/workspaces␊ - */␊ - export interface Workspaces11 {␊ - apiVersion: "2019-11-04-preview"␊ - /**␊ - * Managed Identity information.␊ - */␊ - identity?: (QuantumWorkspaceIdentity | string)␊ - /**␊ - * The geo-location where the resource lives␊ - */␊ - location: string␊ - /**␊ - * The name of the quantum workspace resource.␊ - */␊ - name: string␊ - /**␊ - * Properties of a Workspace␊ - */␊ - properties: (WorkspaceResourceProperties | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Quantum/workspaces"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Managed Identity information.␊ - */␊ - export interface QuantumWorkspaceIdentity {␊ - /**␊ - * The identity type.␊ - */␊ - type?: (("SystemAssigned" | "None") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Properties of a Workspace␊ - */␊ - export interface WorkspaceResourceProperties {␊ - /**␊ - * List of Providers selected for this Workspace␊ - */␊ - providers?: (Provider[] | string)␊ - /**␊ - * ARM Resource Id of the storage account associated with this workspace.␊ - */␊ - storageAccount?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about a Provider. A Provider is an entity that offers Targets to run Azure Quantum Jobs.␊ - */␊ - export interface Provider {␊ - /**␊ - * The provider's marketplace application display name.␊ - */␊ - applicationName?: string␊ - /**␊ - * A Uri identifying the specific instance of this provider.␊ - */␊ - instanceUri?: string␊ - /**␊ - * Unique id of this provider.␊ - */␊ - providerId?: string␊ - /**␊ - * The sku associated with pricing information for this provider.␊ - */␊ - providerSku?: string␊ - /**␊ - * Provisioning status field.␊ - */␊ - provisioningState?: (("Succeeded" | "Launching" | "Updating" | "Deleting" | "Deleted" | "Failed") | string)␊ - /**␊ - * Id to track resource usage for the provider.␊ - */␊ - resourceUsageId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Authorization/locks␊ - */␊ - export interface Locks {␊ - apiVersion: "2015-01-01"␊ - /**␊ - * The lock name.␊ - */␊ - name: string␊ - /**␊ - * The management lock properties.␊ - */␊ - properties: (ManagementLockProperties | string)␊ - type: "Microsoft.Authorization/locks"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The management lock properties.␊ - */␊ - export interface ManagementLockProperties {␊ - /**␊ - * The lock level of the management lock.␊ - */␊ - level?: (("NotSpecified" | "CanNotDelete" | "ReadOnly") | string)␊ - /**␊ - * The notes of the management lock.␊ - */␊ - notes?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Authorization/policyassignments␊ - */␊ - export interface Policyassignments {␊ - apiVersion: "2015-10-01-preview"␊ - /**␊ - * The ID of the policy assignment.␊ - */␊ - id?: string␊ - /**␊ - * The name of the policy assignment.␊ - */␊ - name: string␊ - /**␊ - * The policy assignment properties.␊ - */␊ - properties: (PolicyAssignmentProperties | string)␊ - type: "Microsoft.Authorization/policyassignments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The policy assignment properties.␊ - */␊ - export interface PolicyAssignmentProperties {␊ - /**␊ - * The display name of the policy assignment.␊ - */␊ - displayName?: string␊ - /**␊ - * The ID of the policy definition.␊ - */␊ - policyDefinitionId?: string␊ - /**␊ - * The scope for the policy assignment.␊ - */␊ - scope?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Authorization/policyassignments␊ - */␊ - export interface Policyassignments1 {␊ - apiVersion: "2016-04-01"␊ - /**␊ - * The ID of the policy assignment.␊ - */␊ - id?: string␊ - /**␊ - * The name of the policy assignment.␊ - */␊ - name: string␊ - /**␊ - * The policy assignment properties.␊ - */␊ - properties: (PolicyAssignmentProperties1 | string)␊ - type: "Microsoft.Authorization/policyassignments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The policy assignment properties.␊ - */␊ - export interface PolicyAssignmentProperties1 {␊ - /**␊ - * The display name of the policy assignment.␊ - */␊ - displayName?: string␊ - /**␊ - * The ID of the policy definition.␊ - */␊ - policyDefinitionId?: string␊ - /**␊ - * The scope for the policy assignment.␊ - */␊ - scope?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Authorization/locks␊ - */␊ - export interface Locks1 {␊ - apiVersion: "2016-09-01"␊ - /**␊ - * The lock name. The lock name can be a maximum of 260 characters. It cannot contain <, > %, &, :, \\, ?, /, or any control characters.␊ - */␊ - name: string␊ - /**␊ - * The lock properties.␊ - */␊ - properties: (ManagementLockProperties1 | string)␊ - type: "Microsoft.Authorization/locks"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The lock properties.␊ - */␊ - export interface ManagementLockProperties1 {␊ - /**␊ - * The level of the lock. Possible values are: NotSpecified, CanNotDelete, ReadOnly. CanNotDelete means authorized users are able to read and modify the resources, but not delete. ReadOnly means authorized users can only read from a resource, but they can't modify or delete it.␊ - */␊ - level: (("NotSpecified" | "CanNotDelete" | "ReadOnly") | string)␊ - /**␊ - * Notes about the lock. Maximum of 512 characters.␊ - */␊ - notes?: string␊ - /**␊ - * The owners of the lock.␊ - */␊ - owners?: (ManagementLockOwner[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Lock owner properties.␊ - */␊ - export interface ManagementLockOwner {␊ - /**␊ - * The application ID of the lock owner.␊ - */␊ - applicationId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Authorization/policyAssignments␊ - */␊ - export interface PolicyAssignments {␊ - apiVersion: "2016-12-01"␊ - /**␊ - * The name of the policy assignment.␊ - */␊ - name: string␊ - /**␊ - * The policy assignment properties.␊ - */␊ - properties: (PolicyAssignmentProperties2 | string)␊ - type: "Microsoft.Authorization/policyAssignments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The policy assignment properties.␊ - */␊ - export interface PolicyAssignmentProperties2 {␊ - /**␊ - * This message will be part of response in case of policy violation.␊ - */␊ - description?: string␊ - /**␊ - * The display name of the policy assignment.␊ - */␊ - displayName?: string␊ - /**␊ - * Required if a parameter is used in policy rule.␊ - */␊ - parameters?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The ID of the policy definition.␊ - */␊ - policyDefinitionId?: string␊ - /**␊ - * The scope for the policy assignment.␊ - */␊ - scope?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Authorization/policyAssignments␊ - */␊ - export interface PolicyAssignments1 {␊ - apiVersion: "2017-06-01-preview"␊ - /**␊ - * The name of the policy assignment.␊ - */␊ - name: string␊ - /**␊ - * The policy assignment properties.␊ - */␊ - properties: (PolicyAssignmentProperties3 | string)␊ - /**␊ - * The policy sku.␊ - */␊ - sku?: (PolicySku | string)␊ - type: "Microsoft.Authorization/policyAssignments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The policy assignment properties.␊ - */␊ - export interface PolicyAssignmentProperties3 {␊ - /**␊ - * This message will be part of response in case of policy violation.␊ - */␊ - description?: string␊ - /**␊ - * The display name of the policy assignment.␊ - */␊ - displayName?: string␊ - /**␊ - * The policy assignment metadata.␊ - */␊ - metadata?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The policy's excluded scopes.␊ - */␊ - notScopes?: (string[] | string)␊ - /**␊ - * Required if a parameter is used in policy rule.␊ - */␊ - parameters?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The ID of the policy definition.␊ - */␊ - policyDefinitionId?: string␊ - /**␊ - * The scope for the policy assignment.␊ - */␊ - scope?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The policy sku.␊ - */␊ - export interface PolicySku {␊ - /**␊ - * The name of the policy sku. Possible values are A0 and A1.␊ - */␊ - name: string␊ - /**␊ - * The policy sku tier. Possible values are Free and Standard.␊ - */␊ - tier?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Authorization/policyAssignments␊ - */␊ - export interface PolicyAssignments2 {␊ - apiVersion: "2018-03-01"␊ - /**␊ - * The name of the policy assignment.␊ - */␊ - name: string␊ - /**␊ - * The policy assignment properties.␊ - */␊ - properties: (PolicyAssignmentProperties4 | string)␊ - /**␊ - * The policy sku. This property is optional, obsolete, and will be ignored.␊ - */␊ - sku?: (PolicySku1 | string)␊ - type: "Microsoft.Authorization/policyAssignments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The policy assignment properties.␊ - */␊ - export interface PolicyAssignmentProperties4 {␊ - /**␊ - * This message will be part of response in case of policy violation.␊ - */␊ - description?: string␊ - /**␊ - * The display name of the policy assignment.␊ - */␊ - displayName?: string␊ - /**␊ - * The policy assignment metadata.␊ - */␊ - metadata?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The policy's excluded scopes.␊ - */␊ - notScopes?: (string[] | string)␊ - /**␊ - * Required if a parameter is used in policy rule.␊ - */␊ - parameters?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The ID of the policy definition or policy set definition being assigned.␊ - */␊ - policyDefinitionId?: string␊ - /**␊ - * The scope for the policy assignment.␊ - */␊ - scope?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The policy sku. This property is optional, obsolete, and will be ignored.␊ - */␊ - export interface PolicySku1 {␊ - /**␊ - * The name of the policy sku. Possible values are A0 and A1.␊ - */␊ - name: string␊ - /**␊ - * The policy sku tier. Possible values are Free and Standard.␊ - */␊ - tier?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Authorization/policyAssignments␊ - */␊ - export interface PolicyAssignments3 {␊ - apiVersion: "2018-05-01"␊ - /**␊ - * Identity for the resource.␊ - */␊ - identity?: (Identity26 | string)␊ - /**␊ - * The location of the policy assignment. Only required when utilizing managed identity.␊ - */␊ - location?: string␊ - /**␊ - * The name of the policy assignment.␊ - */␊ - name: string␊ - /**␊ - * The policy assignment properties.␊ - */␊ - properties: (PolicyAssignmentProperties5 | string)␊ - /**␊ - * The policy sku. This property is optional, obsolete, and will be ignored.␊ - */␊ - sku?: (PolicySku2 | string)␊ - type: "Microsoft.Authorization/policyAssignments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the resource.␊ - */␊ - export interface Identity26 {␊ - /**␊ - * The identity type.␊ - */␊ - type?: (("SystemAssigned" | "None") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The policy assignment properties.␊ - */␊ - export interface PolicyAssignmentProperties5 {␊ - /**␊ - * This message will be part of response in case of policy violation.␊ - */␊ - description?: string␊ - /**␊ - * The display name of the policy assignment.␊ - */␊ - displayName?: string␊ - /**␊ - * The policy assignment metadata.␊ - */␊ - metadata?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The policy's excluded scopes.␊ - */␊ - notScopes?: (string[] | string)␊ - /**␊ - * Required if a parameter is used in policy rule.␊ - */␊ - parameters?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The ID of the policy definition or policy set definition being assigned.␊ - */␊ - policyDefinitionId?: string␊ - /**␊ - * The scope for the policy assignment.␊ - */␊ - scope?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The policy sku. This property is optional, obsolete, and will be ignored.␊ - */␊ - export interface PolicySku2 {␊ - /**␊ - * The name of the policy sku. Possible values are A0 and A1.␊ - */␊ - name: string␊ - /**␊ - * The policy sku tier. Possible values are Free and Standard.␊ - */␊ - tier?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Authorization/policyAssignments␊ - */␊ - export interface PolicyAssignments4 {␊ - apiVersion: "2019-01-01"␊ - /**␊ - * Identity for the resource.␊ - */␊ - identity?: (Identity27 | string)␊ - /**␊ - * The location of the policy assignment. Only required when utilizing managed identity.␊ - */␊ - location?: string␊ - /**␊ - * The name of the policy assignment.␊ - */␊ - name: string␊ - /**␊ - * The policy assignment properties.␊ - */␊ - properties: (PolicyAssignmentProperties6 | string)␊ - /**␊ - * The policy sku. This property is optional, obsolete, and will be ignored.␊ - */␊ - sku?: (PolicySku3 | string)␊ - type: "Microsoft.Authorization/policyAssignments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the resource.␊ - */␊ - export interface Identity27 {␊ - /**␊ - * The identity type.␊ - */␊ - type?: (("SystemAssigned" | "None") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The policy assignment properties.␊ - */␊ - export interface PolicyAssignmentProperties6 {␊ - /**␊ - * This message will be part of response in case of policy violation.␊ - */␊ - description?: string␊ - /**␊ - * The display name of the policy assignment.␊ - */␊ - displayName?: string␊ - /**␊ - * The policy assignment metadata.␊ - */␊ - metadata?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The policy's excluded scopes.␊ - */␊ - notScopes?: (string[] | string)␊ - /**␊ - * Required if a parameter is used in policy rule.␊ - */␊ - parameters?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The ID of the policy definition or policy set definition being assigned.␊ - */␊ - policyDefinitionId?: string␊ - /**␊ - * The scope for the policy assignment.␊ - */␊ - scope?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The policy sku. This property is optional, obsolete, and will be ignored.␊ - */␊ - export interface PolicySku3 {␊ - /**␊ - * The name of the policy sku. Possible values are A0 and A1.␊ - */␊ - name: string␊ - /**␊ - * The policy sku tier. Possible values are Free and Standard.␊ - */␊ - tier?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Authorization/policyAssignments␊ - */␊ - export interface PolicyAssignments5 {␊ - apiVersion: "2019-06-01"␊ - /**␊ - * Identity for the resource.␊ - */␊ - identity?: (Identity28 | string)␊ - /**␊ - * The location of the policy assignment. Only required when utilizing managed identity.␊ - */␊ - location?: string␊ - /**␊ - * The name of the policy assignment.␊ - */␊ - name: string␊ - /**␊ - * The policy assignment properties.␊ - */␊ - properties: (PolicyAssignmentProperties7 | string)␊ - /**␊ - * The policy sku. This property is optional, obsolete, and will be ignored.␊ - */␊ - sku?: (PolicySku4 | string)␊ - type: "Microsoft.Authorization/policyAssignments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the resource.␊ - */␊ - export interface Identity28 {␊ - /**␊ - * The identity type.␊ - */␊ - type?: (("SystemAssigned" | "None") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The policy assignment properties.␊ - */␊ - export interface PolicyAssignmentProperties7 {␊ - /**␊ - * This message will be part of response in case of policy violation.␊ - */␊ - description?: string␊ - /**␊ - * The display name of the policy assignment.␊ - */␊ - displayName?: string␊ - /**␊ - * The policy assignment enforcement mode. Possible values are Default and DoNotEnforce.␊ - */␊ - enforcementMode?: (("Default" | "DoNotEnforce") | string)␊ - /**␊ - * The policy assignment metadata.␊ - */␊ - metadata?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The policy's excluded scopes.␊ - */␊ - notScopes?: (string[] | string)␊ - /**␊ - * Required if a parameter is used in policy rule.␊ - */␊ - parameters?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The ID of the policy definition or policy set definition being assigned.␊ - */␊ - policyDefinitionId?: string␊ - /**␊ - * The scope for the policy assignment.␊ - */␊ - scope?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The policy sku. This property is optional, obsolete, and will be ignored.␊ - */␊ - export interface PolicySku4 {␊ - /**␊ - * The name of the policy sku. Possible values are A0 and A1.␊ - */␊ - name: string␊ - /**␊ - * The policy sku tier. Possible values are Free and Standard.␊ - */␊ - tier?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Authorization/policyAssignments␊ - */␊ - export interface PolicyAssignments6 {␊ - apiVersion: "2019-09-01"␊ - /**␊ - * Identity for the resource.␊ - */␊ - identity?: (Identity29 | string)␊ - /**␊ - * The location of the policy assignment. Only required when utilizing managed identity.␊ - */␊ - location?: string␊ - /**␊ - * The name of the policy assignment.␊ - */␊ - name: string␊ - /**␊ - * The policy assignment properties.␊ - */␊ - properties: (PolicyAssignmentProperties8 | string)␊ - /**␊ - * The policy sku. This property is optional, obsolete, and will be ignored.␊ - */␊ - sku?: (PolicySku5 | string)␊ - type: "Microsoft.Authorization/policyAssignments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the resource.␊ - */␊ - export interface Identity29 {␊ - /**␊ - * The identity type. This is the only required field when adding a system assigned identity to a resource.␊ - */␊ - type?: (("SystemAssigned" | "None") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The policy assignment properties.␊ - */␊ - export interface PolicyAssignmentProperties8 {␊ - /**␊ - * This message will be part of response in case of policy violation.␊ - */␊ - description?: string␊ - /**␊ - * The display name of the policy assignment.␊ - */␊ - displayName?: string␊ - /**␊ - * The policy assignment enforcement mode. Possible values are Default and DoNotEnforce.␊ - */␊ - enforcementMode?: (("Default" | "DoNotEnforce") | string)␊ - /**␊ - * The policy assignment metadata. Metadata is an open ended object and is typically a collection of key value pairs.␊ - */␊ - metadata?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The policy's excluded scopes.␊ - */␊ - notScopes?: (string[] | string)␊ - /**␊ - * The parameter values for the policy rule. The keys are the parameter names.␊ - */␊ - parameters?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The ID of the policy definition or policy set definition being assigned.␊ - */␊ - policyDefinitionId?: string␊ - /**␊ - * The scope for the policy assignment.␊ - */␊ - scope?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The policy sku. This property is optional, obsolete, and will be ignored.␊ - */␊ - export interface PolicySku5 {␊ - /**␊ - * The name of the policy sku. Possible values are A0 and A1.␊ - */␊ - name: string␊ - /**␊ - * The policy sku tier. Possible values are Free and Standard.␊ - */␊ - tier?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Authorization/policyAssignments␊ - */␊ - export interface PolicyAssignments7 {␊ - apiVersion: "2020-03-01"␊ - /**␊ - * Identity for the resource.␊ - */␊ - identity?: (Identity30 | string)␊ - /**␊ - * The location of the policy assignment. Only required when utilizing managed identity.␊ - */␊ - location?: string␊ - /**␊ - * The name of the policy assignment.␊ - */␊ - name: string␊ - /**␊ - * The policy assignment properties.␊ - */␊ - properties: (PolicyAssignmentProperties9 | string)␊ - /**␊ - * The policy sku. This property is optional, obsolete, and will be ignored.␊ - */␊ - sku?: (PolicySku6 | string)␊ - type: "Microsoft.Authorization/policyAssignments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the resource.␊ - */␊ - export interface Identity30 {␊ - /**␊ - * The identity type. This is the only required field when adding a system assigned identity to a resource.␊ - */␊ - type?: (("SystemAssigned" | "None") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The policy assignment properties.␊ - */␊ - export interface PolicyAssignmentProperties9 {␊ - /**␊ - * This message will be part of response in case of policy violation.␊ - */␊ - description?: string␊ - /**␊ - * The display name of the policy assignment.␊ - */␊ - displayName?: string␊ - /**␊ - * The policy assignment enforcement mode. Possible values are Default and DoNotEnforce.␊ - */␊ - enforcementMode?: (("Default" | "DoNotEnforce") | string)␊ - /**␊ - * The policy assignment metadata. Metadata is an open ended object and is typically a collection of key value pairs.␊ - */␊ - metadata?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The policy's excluded scopes.␊ - */␊ - notScopes?: (string[] | string)␊ - /**␊ - * The parameter values for the policy rule. The keys are the parameter names.␊ - */␊ - parameters?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The ID of the policy definition or policy set definition being assigned.␊ - */␊ - policyDefinitionId?: string␊ - /**␊ - * The scope for the policy assignment.␊ - */␊ - scope?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The policy sku. This property is optional, obsolete, and will be ignored.␊ - */␊ - export interface PolicySku6 {␊ - /**␊ - * The name of the policy sku. Possible values are A0 and A1.␊ - */␊ - name: string␊ - /**␊ - * The policy sku tier. Possible values are Free and Standard.␊ - */␊ - tier?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Authorization/policyExemptions␊ - */␊ - export interface PolicyExemptions {␊ - apiVersion: "2020-07-01-preview"␊ - /**␊ - * The name of the policy exemption to delete.␊ - */␊ - name: string␊ - /**␊ - * The policy exemption properties.␊ - */␊ - properties: (PolicyExemptionProperties | string)␊ - type: "Microsoft.Authorization/policyExemptions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The policy exemption properties.␊ - */␊ - export interface PolicyExemptionProperties {␊ - /**␊ - * The description of the policy exemption.␊ - */␊ - description?: string␊ - /**␊ - * The display name of the policy exemption.␊ - */␊ - displayName?: string␊ - /**␊ - * The policy exemption category. Possible values are Waiver and Mitigated.␊ - */␊ - exemptionCategory: (("Waiver" | "Mitigated") | string)␊ - /**␊ - * The expiration date and time (in UTC ISO 8601 format yyyy-MM-ddTHH:mm:ssZ) of the policy exemption.␊ - */␊ - expiresOn?: string␊ - /**␊ - * The policy exemption metadata. Metadata is an open ended object and is typically a collection of key value pairs.␊ - */␊ - metadata?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The ID of the policy assignment that is being exempted.␊ - */␊ - policyAssignmentId: string␊ - /**␊ - * The policy definition reference ID list when the associated policy assignment is an assignment of a policy set definition.␊ - */␊ - policyDefinitionReferenceIds?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Authorization/policyAssignments␊ - */␊ - export interface PolicyAssignments8 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Identity for the resource.␊ - */␊ - identity?: (Identity31 | string)␊ - /**␊ - * The location of the policy assignment. Only required when utilizing managed identity.␊ - */␊ - location?: string␊ - /**␊ - * The name of the policy assignment.␊ - */␊ - name: string␊ - /**␊ - * The policy assignment properties.␊ - */␊ - properties: (PolicyAssignmentProperties10 | string)␊ - type: "Microsoft.Authorization/policyAssignments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity for the resource.␊ - */␊ - export interface Identity31 {␊ - /**␊ - * The identity type. This is the only required field when adding a system assigned identity to a resource.␊ - */␊ - type?: (("SystemAssigned" | "None") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The policy assignment properties.␊ - */␊ - export interface PolicyAssignmentProperties10 {␊ - /**␊ - * This message will be part of response in case of policy violation.␊ - */␊ - description?: string␊ - /**␊ - * The display name of the policy assignment.␊ - */␊ - displayName?: string␊ - /**␊ - * The policy assignment enforcement mode. Possible values are Default and DoNotEnforce.␊ - */␊ - enforcementMode?: (("Default" | "DoNotEnforce") | string)␊ - /**␊ - * The policy assignment metadata. Metadata is an open ended object and is typically a collection of key value pairs.␊ - */␊ - metadata?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The messages that describe why a resource is non-compliant with the policy.␊ - */␊ - nonComplianceMessages?: (NonComplianceMessage[] | string)␊ - /**␊ - * The policy's excluded scopes.␊ - */␊ - notScopes?: (string[] | string)␊ - /**␊ - * The parameter values for the policy rule. The keys are the parameter names.␊ - */␊ - parameters?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The ID of the policy definition or policy set definition being assigned.␊ - */␊ - policyDefinitionId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A message that describes why a resource is non-compliant with the policy. This is shown in 'deny' error messages and on resource's non-compliant compliance results.␊ - */␊ - export interface NonComplianceMessage {␊ - /**␊ - * A message that describes why a resource is non-compliant with the policy. This is shown in 'deny' error messages and on resource's non-compliant compliance results.␊ - */␊ - message: string␊ - /**␊ - * The policy definition reference ID within a policy set definition the message is intended for. This is only applicable if the policy assignment assigns a policy set definition. If this is not provided the message applies to all policies assigned by this policy assignment.␊ - */␊ - policyDefinitionReferenceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.CertificateRegistration/certificateOrders␊ - */␊ - export interface CertificateOrders {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the certificate order.␊ - */␊ - name: string␊ - /**␊ - * AppServiceCertificateOrder resource specific properties␊ - */␊ - properties: (AppServiceCertificateOrderProperties | string)␊ - resources?: CertificateOrdersCertificatesChildResource[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.CertificateRegistration/certificateOrders"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AppServiceCertificateOrder resource specific properties␊ - */␊ - export interface AppServiceCertificateOrderProperties {␊ - /**␊ - * true if the certificate should be automatically renewed when it expires; otherwise, false.␊ - */␊ - autoRenew?: (boolean | string)␊ - /**␊ - * State of the Key Vault secret.␊ - */␊ - certificates?: ({␊ - [k: string]: AppServiceCertificate␊ - } | string)␊ - /**␊ - * Last CSR that was created for this order.␊ - */␊ - csr?: string␊ - /**␊ - * Certificate distinguished name.␊ - */␊ - distinguishedName?: string␊ - /**␊ - * Certificate key size.␊ - */␊ - keySize?: ((number & string) | string)␊ - /**␊ - * Certificate product type.␊ - */␊ - productType: (("StandardDomainValidatedSsl" | "StandardDomainValidatedWildCardSsl") | string)␊ - /**␊ - * Duration in years (must be between 1 and 3).␊ - */␊ - validityInYears?: ((number & string) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Key Vault container for a certificate that is purchased through Azure.␊ - */␊ - export interface AppServiceCertificate {␊ - /**␊ - * Key Vault resource Id.␊ - */␊ - keyVaultId?: string␊ - /**␊ - * Key Vault secret name.␊ - */␊ - keyVaultSecretName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.CertificateRegistration/certificateOrders/certificates␊ - */␊ - export interface CertificateOrdersCertificatesChildResource {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the certificate.␊ - */␊ - name: string␊ - /**␊ - * Key Vault container for a certificate that is purchased through Azure.␊ - */␊ - properties: (AppServiceCertificate | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "certificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.CertificateRegistration/certificateOrders/certificates␊ - */␊ - export interface CertificateOrdersCertificates {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the certificate.␊ - */␊ - name: string␊ - /**␊ - * Key Vault container for a certificate that is purchased through Azure.␊ - */␊ - properties: (AppServiceCertificate | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.CertificateRegistration/certificateOrders/certificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.CertificateRegistration/certificateOrders␊ - */␊ - export interface CertificateOrders1 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the certificate order.␊ - */␊ - name: string␊ - /**␊ - * AppServiceCertificateOrder resource specific properties␊ - */␊ - properties: (AppServiceCertificateOrderProperties1 | string)␊ - resources?: CertificateOrdersCertificatesChildResource1[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.CertificateRegistration/certificateOrders"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AppServiceCertificateOrder resource specific properties␊ - */␊ - export interface AppServiceCertificateOrderProperties1 {␊ - /**␊ - * true if the certificate should be automatically renewed when it expires; otherwise, false.␊ - */␊ - autoRenew?: (boolean | string)␊ - /**␊ - * State of the Key Vault secret.␊ - */␊ - certificates?: ({␊ - [k: string]: AppServiceCertificate1␊ - } | string)␊ - /**␊ - * Last CSR that was created for this order.␊ - */␊ - csr?: string␊ - /**␊ - * Certificate distinguished name.␊ - */␊ - distinguishedName?: string␊ - /**␊ - * Certificate key size.␊ - */␊ - keySize?: ((number & string) | string)␊ - /**␊ - * Certificate product type.␊ - */␊ - productType: (("StandardDomainValidatedSsl" | "StandardDomainValidatedWildCardSsl") | string)␊ - /**␊ - * Duration in years (must be between 1 and 3).␊ - */␊ - validityInYears?: ((number & string) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Key Vault container for a certificate that is purchased through Azure.␊ - */␊ - export interface AppServiceCertificate1 {␊ - /**␊ - * Key Vault resource Id.␊ - */␊ - keyVaultId?: string␊ - /**␊ - * Key Vault secret name.␊ - */␊ - keyVaultSecretName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.CertificateRegistration/certificateOrders/certificates␊ - */␊ - export interface CertificateOrdersCertificatesChildResource1 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the certificate.␊ - */␊ - name: string␊ - /**␊ - * Key Vault container for a certificate that is purchased through Azure.␊ - */␊ - properties: (AppServiceCertificate1 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "certificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.CertificateRegistration/certificateOrders/certificates␊ - */␊ - export interface CertificateOrdersCertificates1 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the certificate.␊ - */␊ - name: string␊ - /**␊ - * Key Vault container for a certificate that is purchased through Azure.␊ - */␊ - properties: (AppServiceCertificate1 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.CertificateRegistration/certificateOrders/certificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.CertificateRegistration/certificateOrders␊ - */␊ - export interface CertificateOrders2 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the certificate order.␊ - */␊ - name: string␊ - /**␊ - * AppServiceCertificateOrder resource specific properties␊ - */␊ - properties: (AppServiceCertificateOrderProperties2 | string)␊ - resources?: CertificateOrdersCertificatesChildResource2[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.CertificateRegistration/certificateOrders"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AppServiceCertificateOrder resource specific properties␊ - */␊ - export interface AppServiceCertificateOrderProperties2 {␊ - /**␊ - * true if the certificate should be automatically renewed when it expires; otherwise, false.␊ - */␊ - autoRenew?: (boolean | string)␊ - /**␊ - * State of the Key Vault secret.␊ - */␊ - certificates?: ({␊ - [k: string]: AppServiceCertificate2␊ - } | string)␊ - /**␊ - * Last CSR that was created for this order.␊ - */␊ - csr?: string␊ - /**␊ - * Certificate distinguished name.␊ - */␊ - distinguishedName?: string␊ - /**␊ - * Certificate key size.␊ - */␊ - keySize?: ((number & string) | string)␊ - /**␊ - * Certificate product type.␊ - */␊ - productType: (("StandardDomainValidatedSsl" | "StandardDomainValidatedWildCardSsl") | string)␊ - /**␊ - * Duration in years (must be between 1 and 3).␊ - */␊ - validityInYears?: ((number & string) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Key Vault container for a certificate that is purchased through Azure.␊ - */␊ - export interface AppServiceCertificate2 {␊ - /**␊ - * Key Vault resource Id.␊ - */␊ - keyVaultId?: string␊ - /**␊ - * Key Vault secret name.␊ - */␊ - keyVaultSecretName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.CertificateRegistration/certificateOrders/certificates␊ - */␊ - export interface CertificateOrdersCertificatesChildResource2 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the certificate.␊ - */␊ - name: string␊ - /**␊ - * Key Vault container for a certificate that is purchased through Azure.␊ - */␊ - properties: (AppServiceCertificate2 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "certificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.CertificateRegistration/certificateOrders/certificates␊ - */␊ - export interface CertificateOrdersCertificates2 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the certificate.␊ - */␊ - name: string␊ - /**␊ - * Key Vault container for a certificate that is purchased through Azure.␊ - */␊ - properties: (AppServiceCertificate2 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.CertificateRegistration/certificateOrders/certificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.CertificateRegistration/certificateOrders␊ - */␊ - export interface CertificateOrders3 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the certificate order.␊ - */␊ - name: string␊ - /**␊ - * AppServiceCertificateOrder resource specific properties␊ - */␊ - properties: (AppServiceCertificateOrderProperties3 | string)␊ - resources?: CertificateOrdersCertificatesChildResource3[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.CertificateRegistration/certificateOrders"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AppServiceCertificateOrder resource specific properties␊ - */␊ - export interface AppServiceCertificateOrderProperties3 {␊ - /**␊ - * true if the certificate should be automatically renewed when it expires; otherwise, false.␊ - */␊ - autoRenew?: (boolean | string)␊ - /**␊ - * State of the Key Vault secret.␊ - */␊ - certificates?: ({␊ - [k: string]: AppServiceCertificate3␊ - } | string)␊ - /**␊ - * Last CSR that was created for this order.␊ - */␊ - csr?: string␊ - /**␊ - * Certificate distinguished name.␊ - */␊ - distinguishedName?: string␊ - /**␊ - * Certificate key size.␊ - */␊ - keySize?: ((number & string) | string)␊ - /**␊ - * Certificate product type.␊ - */␊ - productType: (("StandardDomainValidatedSsl" | "StandardDomainValidatedWildCardSsl") | string)␊ - /**␊ - * Duration in years (must be between 1 and 3).␊ - */␊ - validityInYears?: ((number & string) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Key Vault container for a certificate that is purchased through Azure.␊ - */␊ - export interface AppServiceCertificate3 {␊ - /**␊ - * Key Vault resource Id.␊ - */␊ - keyVaultId?: string␊ - /**␊ - * Key Vault secret name.␊ - */␊ - keyVaultSecretName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.CertificateRegistration/certificateOrders/certificates␊ - */␊ - export interface CertificateOrdersCertificatesChildResource3 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the certificate.␊ - */␊ - name: string␊ - /**␊ - * Key Vault container for a certificate that is purchased through Azure.␊ - */␊ - properties: (AppServiceCertificate3 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "certificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.CertificateRegistration/certificateOrders/certificates␊ - */␊ - export interface CertificateOrdersCertificates3 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the certificate.␊ - */␊ - name: string␊ - /**␊ - * Key Vault container for a certificate that is purchased through Azure.␊ - */␊ - properties: (AppServiceCertificate3 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.CertificateRegistration/certificateOrders/certificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.CertificateRegistration/certificateOrders␊ - */␊ - export interface CertificateOrders4 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the certificate order.␊ - */␊ - name: string␊ - /**␊ - * AppServiceCertificateOrder resource specific properties␊ - */␊ - properties: (AppServiceCertificateOrderProperties4 | string)␊ - resources?: CertificateOrdersCertificatesChildResource4[]␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData1 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.CertificateRegistration/certificateOrders"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AppServiceCertificateOrder resource specific properties␊ - */␊ - export interface AppServiceCertificateOrderProperties4 {␊ - /**␊ - * true if the certificate should be automatically renewed when it expires; otherwise, false.␊ - */␊ - autoRenew?: (boolean | string)␊ - /**␊ - * State of the Key Vault secret.␊ - */␊ - certificates?: ({␊ - [k: string]: AppServiceCertificate4␊ - } | string)␊ - /**␊ - * Last CSR that was created for this order.␊ - */␊ - csr?: string␊ - /**␊ - * Certificate distinguished name.␊ - */␊ - distinguishedName?: string␊ - /**␊ - * Certificate key size.␊ - */␊ - keySize?: ((number & string) | string)␊ - /**␊ - * Certificate product type.␊ - */␊ - productType: (("StandardDomainValidatedSsl" | "StandardDomainValidatedWildCardSsl") | string)␊ - /**␊ - * Duration in years (must be between 1 and 3).␊ - */␊ - validityInYears?: ((number & string) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Key Vault container for a certificate that is purchased through Azure.␊ - */␊ - export interface AppServiceCertificate4 {␊ - /**␊ - * Key Vault resource Id.␊ - */␊ - keyVaultId?: string␊ - /**␊ - * Key Vault secret name.␊ - */␊ - keyVaultSecretName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.CertificateRegistration/certificateOrders/certificates␊ - */␊ - export interface CertificateOrdersCertificatesChildResource4 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the certificate.␊ - */␊ - name: string␊ - /**␊ - * Key Vault container for a certificate that is purchased through Azure.␊ - */␊ - properties: (AppServiceCertificate4 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData1 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "certificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - export interface SystemData1 {␊ - /**␊ - * The timestamp of resource creation (UTC).␊ - */␊ - createdAt?: string␊ - /**␊ - * The identity that created the resource.␊ - */␊ - createdBy?: string␊ - /**␊ - * The type of identity that created the resource.␊ - */␊ - createdByType?: (("User" | "Application" | "ManagedIdentity" | "Key") | string)␊ - /**␊ - * The timestamp of resource last modification (UTC)␊ - */␊ - lastModifiedAt?: string␊ - /**␊ - * The identity that last modified the resource.␊ - */␊ - lastModifiedBy?: string␊ - /**␊ - * The type of identity that last modified the resource.␊ - */␊ - lastModifiedByType?: (("User" | "Application" | "ManagedIdentity" | "Key") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.CertificateRegistration/certificateOrders/certificates␊ - */␊ - export interface CertificateOrdersCertificates4 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the certificate.␊ - */␊ - name: string␊ - /**␊ - * Key Vault container for a certificate that is purchased through Azure.␊ - */␊ - properties: (AppServiceCertificate4 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData1 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.CertificateRegistration/certificateOrders/certificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.CertificateRegistration/certificateOrders␊ - */␊ - export interface CertificateOrders5 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the certificate order.␊ - */␊ - name: string␊ - /**␊ - * AppServiceCertificateOrder resource specific properties␊ - */␊ - properties: (AppServiceCertificateOrderProperties5 | string)␊ - resources?: CertificateOrdersCertificatesChildResource5[]␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData2 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.CertificateRegistration/certificateOrders"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AppServiceCertificateOrder resource specific properties␊ - */␊ - export interface AppServiceCertificateOrderProperties5 {␊ - /**␊ - * true if the certificate should be automatically renewed when it expires; otherwise, false.␊ - */␊ - autoRenew?: (boolean | string)␊ - /**␊ - * State of the Key Vault secret.␊ - */␊ - certificates?: ({␊ - [k: string]: AppServiceCertificate5␊ - } | string)␊ - /**␊ - * Last CSR that was created for this order.␊ - */␊ - csr?: string␊ - /**␊ - * Certificate distinguished name.␊ - */␊ - distinguishedName?: string␊ - /**␊ - * Certificate key size.␊ - */␊ - keySize?: ((number & string) | string)␊ - /**␊ - * Certificate product type.␊ - */␊ - productType: (("StandardDomainValidatedSsl" | "StandardDomainValidatedWildCardSsl") | string)␊ - /**␊ - * Duration in years (must be between 1 and 3).␊ - */␊ - validityInYears?: ((number & string) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Key Vault container for a certificate that is purchased through Azure.␊ - */␊ - export interface AppServiceCertificate5 {␊ - /**␊ - * Key Vault resource Id.␊ - */␊ - keyVaultId?: string␊ - /**␊ - * Key Vault secret name.␊ - */␊ - keyVaultSecretName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.CertificateRegistration/certificateOrders/certificates␊ - */␊ - export interface CertificateOrdersCertificatesChildResource5 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the certificate.␊ - */␊ - name: string␊ - /**␊ - * Key Vault container for a certificate that is purchased through Azure.␊ - */␊ - properties: (AppServiceCertificate5 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData2 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "certificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - export interface SystemData2 {␊ - /**␊ - * The timestamp of resource creation (UTC).␊ - */␊ - createdAt?: string␊ - /**␊ - * The identity that created the resource.␊ - */␊ - createdBy?: string␊ - /**␊ - * The type of identity that created the resource.␊ - */␊ - createdByType?: (("User" | "Application" | "ManagedIdentity" | "Key") | string)␊ - /**␊ - * The timestamp of resource last modification (UTC)␊ - */␊ - lastModifiedAt?: string␊ - /**␊ - * The identity that last modified the resource.␊ - */␊ - lastModifiedBy?: string␊ - /**␊ - * The type of identity that last modified the resource.␊ - */␊ - lastModifiedByType?: (("User" | "Application" | "ManagedIdentity" | "Key") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.CertificateRegistration/certificateOrders/certificates␊ - */␊ - export interface CertificateOrdersCertificates5 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the certificate.␊ - */␊ - name: string␊ - /**␊ - * Key Vault container for a certificate that is purchased through Azure.␊ - */␊ - properties: (AppServiceCertificate5 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData2 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.CertificateRegistration/certificateOrders/certificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.CertificateRegistration/certificateOrders␊ - */␊ - export interface CertificateOrders6 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the certificate order.␊ - */␊ - name: string␊ - /**␊ - * AppServiceCertificateOrder resource specific properties␊ - */␊ - properties: (AppServiceCertificateOrderProperties6 | string)␊ - resources?: CertificateOrdersCertificatesChildResource6[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.CertificateRegistration/certificateOrders"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AppServiceCertificateOrder resource specific properties␊ - */␊ - export interface AppServiceCertificateOrderProperties6 {␊ - /**␊ - * true if the certificate should be automatically renewed when it expires; otherwise, false.␊ - */␊ - autoRenew?: (boolean | string)␊ - /**␊ - * State of the Key Vault secret.␊ - */␊ - certificates?: ({␊ - [k: string]: AppServiceCertificate6␊ - } | string)␊ - /**␊ - * Last CSR that was created for this order.␊ - */␊ - csr?: string␊ - /**␊ - * Certificate distinguished name.␊ - */␊ - distinguishedName?: string␊ - /**␊ - * Certificate key size.␊ - */␊ - keySize?: ((number & string) | string)␊ - /**␊ - * Certificate product type.␊ - */␊ - productType: (("StandardDomainValidatedSsl" | "StandardDomainValidatedWildCardSsl") | string)␊ - /**␊ - * Duration in years (must be 1).␊ - */␊ - validityInYears?: ((number & string) | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Key Vault container for a certificate that is purchased through Azure.␊ - */␊ - export interface AppServiceCertificate6 {␊ - /**␊ - * Key Vault resource Id.␊ - */␊ - keyVaultId?: string␊ - /**␊ - * Key Vault secret name.␊ - */␊ - keyVaultSecretName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.CertificateRegistration/certificateOrders/certificates␊ - */␊ - export interface CertificateOrdersCertificatesChildResource6 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the certificate.␊ - */␊ - name: string␊ - /**␊ - * Key Vault container for a certificate that is purchased through Azure.␊ - */␊ - properties: (AppServiceCertificate6 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "certificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.CertificateRegistration/certificateOrders/certificates␊ - */␊ - export interface CertificateOrdersCertificates6 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the certificate.␊ - */␊ - name: string␊ - /**␊ - * Key Vault container for a certificate that is purchased through Azure.␊ - */␊ - properties: (AppServiceCertificate6 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.CertificateRegistration/certificateOrders/certificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DomainRegistration/domains␊ - */␊ - export interface Domains3 {␊ - apiVersion: "2015-04-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the domain.␊ - */␊ - name: string␊ - /**␊ - * Domain resource specific properties␊ - */␊ - properties: (DomainProperties3 | string)␊ - resources?: DomainsDomainOwnershipIdentifiersChildResource[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.DomainRegistration/domains"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Domain resource specific properties␊ - */␊ - export interface DomainProperties3 {␊ - authCode?: string␊ - /**␊ - * true if the domain should be automatically renewed; otherwise, false.␊ - */␊ - autoRenew?: (boolean | string)␊ - /**␊ - * Domain purchase consent object, representing acceptance of applicable legal agreements.␊ - */␊ - consent: (DomainPurchaseConsent | string)␊ - /**␊ - * Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois ␊ - * directories as per ICANN requirements.␊ - */␊ - contactAdmin: (Contact | string)␊ - /**␊ - * Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois ␊ - * directories as per ICANN requirements.␊ - */␊ - contactBilling: (Contact | string)␊ - /**␊ - * Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois ␊ - * directories as per ICANN requirements.␊ - */␊ - contactRegistrant: (Contact | string)␊ - /**␊ - * Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois ␊ - * directories as per ICANN requirements.␊ - */␊ - contactTech: (Contact | string)␊ - /**␊ - * Current DNS type.␊ - */␊ - dnsType?: (("AzureDns" | "DefaultDomainRegistrarDns") | string)␊ - /**␊ - * Azure DNS Zone to use␊ - */␊ - dnsZoneId?: string␊ - /**␊ - * true if domain privacy is enabled for this domain; otherwise, false.␊ - */␊ - privacy?: (boolean | string)␊ - /**␊ - * Target DNS type (would be used for migration).␊ - */␊ - targetDnsType?: (("AzureDns" | "DefaultDomainRegistrarDns") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Domain purchase consent object, representing acceptance of applicable legal agreements.␊ - */␊ - export interface DomainPurchaseConsent {␊ - /**␊ - * Timestamp when the agreements were accepted.␊ - */␊ - agreedAt?: string␊ - /**␊ - * Client IP address.␊ - */␊ - agreedBy?: string␊ - /**␊ - * List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource.␊ - */␊ - agreementKeys?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois ␊ - * directories as per ICANN requirements.␊ - */␊ - export interface Contact {␊ - /**␊ - * Address information for domain registration.␊ - */␊ - addressMailing?: (Address | string)␊ - /**␊ - * Email address.␊ - */␊ - email: string␊ - /**␊ - * Fax number.␊ - */␊ - fax?: string␊ - /**␊ - * Job title.␊ - */␊ - jobTitle?: string␊ - /**␊ - * First name.␊ - */␊ - nameFirst: string␊ - /**␊ - * Last name.␊ - */␊ - nameLast: string␊ - /**␊ - * Middle name.␊ - */␊ - nameMiddle?: string␊ - /**␊ - * Organization contact belongs to.␊ - */␊ - organization?: string␊ - /**␊ - * Phone number.␊ - */␊ - phone: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Address information for domain registration.␊ - */␊ - export interface Address {␊ - /**␊ - * First line of an Address.␊ - */␊ - address1: string␊ - /**␊ - * First line of an Address.␊ - */␊ - address2?: string␊ - /**␊ - * The city for the address.␊ - */␊ - city: string␊ - /**␊ - * The country for the address.␊ - */␊ - country: string␊ - /**␊ - * The postal code for the address.␊ - */␊ - postalCode: string␊ - /**␊ - * The state or province for the address.␊ - */␊ - state: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers␊ - */␊ - export interface DomainsDomainOwnershipIdentifiersChildResource {␊ - apiVersion: "2015-04-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of identifier.␊ - */␊ - name: string␊ - /**␊ - * DomainOwnershipIdentifier resource specific properties␊ - */␊ - properties: (DomainOwnershipIdentifierProperties | string)␊ - type: "domainOwnershipIdentifiers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DomainOwnershipIdentifier resource specific properties␊ - */␊ - export interface DomainOwnershipIdentifierProperties {␊ - /**␊ - * Ownership Id.␊ - */␊ - ownershipId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers␊ - */␊ - export interface DomainsDomainOwnershipIdentifiers {␊ - apiVersion: "2015-04-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of identifier.␊ - */␊ - name: string␊ - /**␊ - * DomainOwnershipIdentifier resource specific properties␊ - */␊ - properties: (DomainOwnershipIdentifierProperties | string)␊ - type: "Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DomainRegistration/domains␊ - */␊ - export interface Domains4 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the domain.␊ - */␊ - name: string␊ - /**␊ - * Domain resource specific properties␊ - */␊ - properties: (DomainProperties4 | string)␊ - resources?: DomainsDomainOwnershipIdentifiersChildResource1[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.DomainRegistration/domains"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Domain resource specific properties␊ - */␊ - export interface DomainProperties4 {␊ - authCode?: string␊ - /**␊ - * true if the domain should be automatically renewed; otherwise, false.␊ - */␊ - autoRenew?: (boolean | string)␊ - /**␊ - * Domain purchase consent object, representing acceptance of applicable legal agreements.␊ - */␊ - consent: (DomainPurchaseConsent1 | string)␊ - /**␊ - * Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois ␊ - * directories as per ICANN requirements.␊ - */␊ - contactAdmin: (Contact1 | string)␊ - /**␊ - * Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois ␊ - * directories as per ICANN requirements.␊ - */␊ - contactBilling: (Contact1 | string)␊ - /**␊ - * Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois ␊ - * directories as per ICANN requirements.␊ - */␊ - contactRegistrant: (Contact1 | string)␊ - /**␊ - * Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois ␊ - * directories as per ICANN requirements.␊ - */␊ - contactTech: (Contact1 | string)␊ - /**␊ - * Current DNS type.␊ - */␊ - dnsType?: (("AzureDns" | "DefaultDomainRegistrarDns") | string)␊ - /**␊ - * Azure DNS Zone to use␊ - */␊ - dnsZoneId?: string␊ - /**␊ - * true if domain privacy is enabled for this domain; otherwise, false.␊ - */␊ - privacy?: (boolean | string)␊ - /**␊ - * Target DNS type (would be used for migration).␊ - */␊ - targetDnsType?: (("AzureDns" | "DefaultDomainRegistrarDns") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Domain purchase consent object, representing acceptance of applicable legal agreements.␊ - */␊ - export interface DomainPurchaseConsent1 {␊ - /**␊ - * Timestamp when the agreements were accepted.␊ - */␊ - agreedAt?: string␊ - /**␊ - * Client IP address.␊ - */␊ - agreedBy?: string␊ - /**␊ - * List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource.␊ - */␊ - agreementKeys?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois ␊ - * directories as per ICANN requirements.␊ - */␊ - export interface Contact1 {␊ - /**␊ - * Address information for domain registration.␊ - */␊ - addressMailing?: (Address1 | string)␊ - /**␊ - * Email address.␊ - */␊ - email: string␊ - /**␊ - * Fax number.␊ - */␊ - fax?: string␊ - /**␊ - * Job title.␊ - */␊ - jobTitle?: string␊ - /**␊ - * First name.␊ - */␊ - nameFirst: string␊ - /**␊ - * Last name.␊ - */␊ - nameLast: string␊ - /**␊ - * Middle name.␊ - */␊ - nameMiddle?: string␊ - /**␊ - * Organization contact belongs to.␊ - */␊ - organization?: string␊ - /**␊ - * Phone number.␊ - */␊ - phone: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Address information for domain registration.␊ - */␊ - export interface Address1 {␊ - /**␊ - * First line of an Address.␊ - */␊ - address1: string␊ - /**␊ - * First line of an Address.␊ - */␊ - address2?: string␊ - /**␊ - * The city for the address.␊ - */␊ - city: string␊ - /**␊ - * The country for the address.␊ - */␊ - country: string␊ - /**␊ - * The postal code for the address.␊ - */␊ - postalCode: string␊ - /**␊ - * The state or province for the address.␊ - */␊ - state: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers␊ - */␊ - export interface DomainsDomainOwnershipIdentifiersChildResource1 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of identifier.␊ - */␊ - name: string␊ - /**␊ - * DomainOwnershipIdentifier resource specific properties␊ - */␊ - properties: (DomainOwnershipIdentifierProperties1 | string)␊ - type: "domainOwnershipIdentifiers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DomainOwnershipIdentifier resource specific properties␊ - */␊ - export interface DomainOwnershipIdentifierProperties1 {␊ - /**␊ - * Ownership Id.␊ - */␊ - ownershipId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers␊ - */␊ - export interface DomainsDomainOwnershipIdentifiers1 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of identifier.␊ - */␊ - name: string␊ - /**␊ - * DomainOwnershipIdentifier resource specific properties␊ - */␊ - properties: (DomainOwnershipIdentifierProperties1 | string)␊ - type: "Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DomainRegistration/domains␊ - */␊ - export interface Domains5 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the domain.␊ - */␊ - name: string␊ - /**␊ - * Domain resource specific properties␊ - */␊ - properties: (DomainProperties5 | string)␊ - resources?: DomainsDomainOwnershipIdentifiersChildResource2[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.DomainRegistration/domains"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Domain resource specific properties␊ - */␊ - export interface DomainProperties5 {␊ - authCode?: string␊ - /**␊ - * true if the domain should be automatically renewed; otherwise, false.␊ - */␊ - autoRenew?: (boolean | string)␊ - /**␊ - * Domain purchase consent object, representing acceptance of applicable legal agreements.␊ - */␊ - consent: (DomainPurchaseConsent2 | string)␊ - /**␊ - * Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois ␊ - * directories as per ICANN requirements.␊ - */␊ - contactAdmin: (Contact2 | string)␊ - /**␊ - * Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois ␊ - * directories as per ICANN requirements.␊ - */␊ - contactBilling: (Contact2 | string)␊ - /**␊ - * Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois ␊ - * directories as per ICANN requirements.␊ - */␊ - contactRegistrant: (Contact2 | string)␊ - /**␊ - * Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois ␊ - * directories as per ICANN requirements.␊ - */␊ - contactTech: (Contact2 | string)␊ - /**␊ - * Current DNS type.␊ - */␊ - dnsType?: (("AzureDns" | "DefaultDomainRegistrarDns") | string)␊ - /**␊ - * Azure DNS Zone to use␊ - */␊ - dnsZoneId?: string␊ - /**␊ - * true if domain privacy is enabled for this domain; otherwise, false.␊ - */␊ - privacy?: (boolean | string)␊ - /**␊ - * Target DNS type (would be used for migration).␊ - */␊ - targetDnsType?: (("AzureDns" | "DefaultDomainRegistrarDns") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Domain purchase consent object, representing acceptance of applicable legal agreements.␊ - */␊ - export interface DomainPurchaseConsent2 {␊ - /**␊ - * Timestamp when the agreements were accepted.␊ - */␊ - agreedAt?: string␊ - /**␊ - * Client IP address.␊ - */␊ - agreedBy?: string␊ - /**␊ - * List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource.␊ - */␊ - agreementKeys?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois ␊ - * directories as per ICANN requirements.␊ - */␊ - export interface Contact2 {␊ - /**␊ - * Address information for domain registration.␊ - */␊ - addressMailing?: (Address2 | string)␊ - /**␊ - * Email address.␊ - */␊ - email: string␊ - /**␊ - * Fax number.␊ - */␊ - fax?: string␊ - /**␊ - * Job title.␊ - */␊ - jobTitle?: string␊ - /**␊ - * First name.␊ - */␊ - nameFirst: string␊ - /**␊ - * Last name.␊ - */␊ - nameLast: string␊ - /**␊ - * Middle name.␊ - */␊ - nameMiddle?: string␊ - /**␊ - * Organization contact belongs to.␊ - */␊ - organization?: string␊ - /**␊ - * Phone number.␊ - */␊ - phone: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Address information for domain registration.␊ - */␊ - export interface Address2 {␊ - /**␊ - * First line of an Address.␊ - */␊ - address1: string␊ - /**␊ - * First line of an Address.␊ - */␊ - address2?: string␊ - /**␊ - * The city for the address.␊ - */␊ - city: string␊ - /**␊ - * The country for the address.␊ - */␊ - country: string␊ - /**␊ - * The postal code for the address.␊ - */␊ - postalCode: string␊ - /**␊ - * The state or province for the address.␊ - */␊ - state: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers␊ - */␊ - export interface DomainsDomainOwnershipIdentifiersChildResource2 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of identifier.␊ - */␊ - name: string␊ - /**␊ - * DomainOwnershipIdentifier resource specific properties␊ - */␊ - properties: (DomainOwnershipIdentifierProperties2 | string)␊ - type: "domainOwnershipIdentifiers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DomainOwnershipIdentifier resource specific properties␊ - */␊ - export interface DomainOwnershipIdentifierProperties2 {␊ - /**␊ - * Ownership Id.␊ - */␊ - ownershipId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers␊ - */␊ - export interface DomainsDomainOwnershipIdentifiers2 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of identifier.␊ - */␊ - name: string␊ - /**␊ - * DomainOwnershipIdentifier resource specific properties␊ - */␊ - properties: (DomainOwnershipIdentifierProperties2 | string)␊ - type: "Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DomainRegistration/domains␊ - */␊ - export interface Domains6 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the domain.␊ - */␊ - name: string␊ - /**␊ - * Domain resource specific properties␊ - */␊ - properties: (DomainProperties6 | string)␊ - resources?: DomainsDomainOwnershipIdentifiersChildResource3[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.DomainRegistration/domains"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Domain resource specific properties␊ - */␊ - export interface DomainProperties6 {␊ - authCode?: string␊ - /**␊ - * true if the domain should be automatically renewed; otherwise, false.␊ - */␊ - autoRenew?: (boolean | string)␊ - /**␊ - * Domain purchase consent object, representing acceptance of applicable legal agreements.␊ - */␊ - consent: (DomainPurchaseConsent3 | string)␊ - /**␊ - * Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois ␊ - * directories as per ICANN requirements.␊ - */␊ - contactAdmin: (Contact3 | string)␊ - /**␊ - * Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois ␊ - * directories as per ICANN requirements.␊ - */␊ - contactBilling: (Contact3 | string)␊ - /**␊ - * Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois ␊ - * directories as per ICANN requirements.␊ - */␊ - contactRegistrant: (Contact3 | string)␊ - /**␊ - * Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois ␊ - * directories as per ICANN requirements.␊ - */␊ - contactTech: (Contact3 | string)␊ - /**␊ - * Current DNS type.␊ - */␊ - dnsType?: (("AzureDns" | "DefaultDomainRegistrarDns") | string)␊ - /**␊ - * Azure DNS Zone to use␊ - */␊ - dnsZoneId?: string␊ - /**␊ - * true if domain privacy is enabled for this domain; otherwise, false.␊ - */␊ - privacy?: (boolean | string)␊ - /**␊ - * Target DNS type (would be used for migration).␊ - */␊ - targetDnsType?: (("AzureDns" | "DefaultDomainRegistrarDns") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Domain purchase consent object, representing acceptance of applicable legal agreements.␊ - */␊ - export interface DomainPurchaseConsent3 {␊ - /**␊ - * Timestamp when the agreements were accepted.␊ - */␊ - agreedAt?: string␊ - /**␊ - * Client IP address.␊ - */␊ - agreedBy?: string␊ - /**␊ - * List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource.␊ - */␊ - agreementKeys?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois ␊ - * directories as per ICANN requirements.␊ - */␊ - export interface Contact3 {␊ - /**␊ - * Address information for domain registration.␊ - */␊ - addressMailing?: (Address3 | string)␊ - /**␊ - * Email address.␊ - */␊ - email: string␊ - /**␊ - * Fax number.␊ - */␊ - fax?: string␊ - /**␊ - * Job title.␊ - */␊ - jobTitle?: string␊ - /**␊ - * First name.␊ - */␊ - nameFirst: string␊ - /**␊ - * Last name.␊ - */␊ - nameLast: string␊ - /**␊ - * Middle name.␊ - */␊ - nameMiddle?: string␊ - /**␊ - * Organization contact belongs to.␊ - */␊ - organization?: string␊ - /**␊ - * Phone number.␊ - */␊ - phone: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Address information for domain registration.␊ - */␊ - export interface Address3 {␊ - /**␊ - * First line of an Address.␊ - */␊ - address1: string␊ - /**␊ - * First line of an Address.␊ - */␊ - address2?: string␊ - /**␊ - * The city for the address.␊ - */␊ - city: string␊ - /**␊ - * The country for the address.␊ - */␊ - country: string␊ - /**␊ - * The postal code for the address.␊ - */␊ - postalCode: string␊ - /**␊ - * The state or province for the address.␊ - */␊ - state: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers␊ - */␊ - export interface DomainsDomainOwnershipIdentifiersChildResource3 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of identifier.␊ - */␊ - name: string␊ - /**␊ - * DomainOwnershipIdentifier resource specific properties␊ - */␊ - properties: (DomainOwnershipIdentifierProperties3 | string)␊ - type: "domainOwnershipIdentifiers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DomainOwnershipIdentifier resource specific properties␊ - */␊ - export interface DomainOwnershipIdentifierProperties3 {␊ - /**␊ - * Ownership Id.␊ - */␊ - ownershipId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers␊ - */␊ - export interface DomainsDomainOwnershipIdentifiers3 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of identifier.␊ - */␊ - name: string␊ - /**␊ - * DomainOwnershipIdentifier resource specific properties␊ - */␊ - properties: (DomainOwnershipIdentifierProperties3 | string)␊ - type: "Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DomainRegistration/domains␊ - */␊ - export interface Domains7 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the domain.␊ - */␊ - name: string␊ - /**␊ - * Domain resource specific properties␊ - */␊ - properties: (DomainProperties7 | string)␊ - resources?: DomainsDomainOwnershipIdentifiersChildResource4[]␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData3 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.DomainRegistration/domains"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Domain resource specific properties␊ - */␊ - export interface DomainProperties7 {␊ - authCode?: string␊ - /**␊ - * true if the domain should be automatically renewed; otherwise, false.␊ - */␊ - autoRenew?: (boolean | string)␊ - /**␊ - * Domain purchase consent object, representing acceptance of applicable legal agreements.␊ - */␊ - consent: (DomainPurchaseConsent4 | string)␊ - /**␊ - * Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois ␊ - * directories as per ICANN requirements.␊ - */␊ - contactAdmin: (Contact4 | string)␊ - /**␊ - * Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois ␊ - * directories as per ICANN requirements.␊ - */␊ - contactBilling: (Contact4 | string)␊ - /**␊ - * Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois ␊ - * directories as per ICANN requirements.␊ - */␊ - contactRegistrant: (Contact4 | string)␊ - /**␊ - * Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois ␊ - * directories as per ICANN requirements.␊ - */␊ - contactTech: (Contact4 | string)␊ - /**␊ - * Current DNS type.␊ - */␊ - dnsType?: (("AzureDns" | "DefaultDomainRegistrarDns") | string)␊ - /**␊ - * Azure DNS Zone to use␊ - */␊ - dnsZoneId?: string␊ - /**␊ - * true if domain privacy is enabled for this domain; otherwise, false.␊ - */␊ - privacy?: (boolean | string)␊ - /**␊ - * Target DNS type (would be used for migration).␊ - */␊ - targetDnsType?: (("AzureDns" | "DefaultDomainRegistrarDns") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Domain purchase consent object, representing acceptance of applicable legal agreements.␊ - */␊ - export interface DomainPurchaseConsent4 {␊ - /**␊ - * Timestamp when the agreements were accepted.␊ - */␊ - agreedAt?: string␊ - /**␊ - * Client IP address.␊ - */␊ - agreedBy?: string␊ - /**␊ - * List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource.␊ - */␊ - agreementKeys?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois ␊ - * directories as per ICANN requirements.␊ - */␊ - export interface Contact4 {␊ - /**␊ - * Address information for domain registration.␊ - */␊ - addressMailing?: (Address4 | string)␊ - /**␊ - * Email address.␊ - */␊ - email: string␊ - /**␊ - * Fax number.␊ - */␊ - fax?: string␊ - /**␊ - * Job title.␊ - */␊ - jobTitle?: string␊ - /**␊ - * First name.␊ - */␊ - nameFirst: string␊ - /**␊ - * Last name.␊ - */␊ - nameLast: string␊ - /**␊ - * Middle name.␊ - */␊ - nameMiddle?: string␊ - /**␊ - * Organization contact belongs to.␊ - */␊ - organization?: string␊ - /**␊ - * Phone number.␊ - */␊ - phone: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Address information for domain registration.␊ - */␊ - export interface Address4 {␊ - /**␊ - * First line of an Address.␊ - */␊ - address1: string␊ - /**␊ - * First line of an Address.␊ - */␊ - address2?: string␊ - /**␊ - * The city for the address.␊ - */␊ - city: string␊ - /**␊ - * The country for the address.␊ - */␊ - country: string␊ - /**␊ - * The postal code for the address.␊ - */␊ - postalCode: string␊ - /**␊ - * The state or province for the address.␊ - */␊ - state: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers␊ - */␊ - export interface DomainsDomainOwnershipIdentifiersChildResource4 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of identifier.␊ - */␊ - name: string␊ - /**␊ - * DomainOwnershipIdentifier resource specific properties␊ - */␊ - properties: (DomainOwnershipIdentifierProperties4 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData3 | string)␊ - type: "domainOwnershipIdentifiers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DomainOwnershipIdentifier resource specific properties␊ - */␊ - export interface DomainOwnershipIdentifierProperties4 {␊ - /**␊ - * Ownership Id.␊ - */␊ - ownershipId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - export interface SystemData3 {␊ - /**␊ - * The timestamp of resource creation (UTC).␊ - */␊ - createdAt?: string␊ - /**␊ - * The identity that created the resource.␊ - */␊ - createdBy?: string␊ - /**␊ - * The type of identity that created the resource.␊ - */␊ - createdByType?: (("User" | "Application" | "ManagedIdentity" | "Key") | string)␊ - /**␊ - * The timestamp of resource last modification (UTC)␊ - */␊ - lastModifiedAt?: string␊ - /**␊ - * The identity that last modified the resource.␊ - */␊ - lastModifiedBy?: string␊ - /**␊ - * The type of identity that last modified the resource.␊ - */␊ - lastModifiedByType?: (("User" | "Application" | "ManagedIdentity" | "Key") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers␊ - */␊ - export interface DomainsDomainOwnershipIdentifiers4 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of identifier.␊ - */␊ - name: string␊ - /**␊ - * DomainOwnershipIdentifier resource specific properties␊ - */␊ - properties: (DomainOwnershipIdentifierProperties4 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData3 | string)␊ - type: "Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DomainRegistration/domains␊ - */␊ - export interface Domains8 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the domain.␊ - */␊ - name: string␊ - /**␊ - * Domain resource specific properties␊ - */␊ - properties: (DomainProperties8 | string)␊ - resources?: DomainsDomainOwnershipIdentifiersChildResource5[]␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData4 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.DomainRegistration/domains"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Domain resource specific properties␊ - */␊ - export interface DomainProperties8 {␊ - authCode?: string␊ - /**␊ - * true if the domain should be automatically renewed; otherwise, false.␊ - */␊ - autoRenew?: (boolean | string)␊ - /**␊ - * Domain purchase consent object, representing acceptance of applicable legal agreements.␊ - */␊ - consent: (DomainPurchaseConsent5 | string)␊ - /**␊ - * Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois ␊ - * directories as per ICANN requirements.␊ - */␊ - contactAdmin: (Contact5 | string)␊ - /**␊ - * Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois ␊ - * directories as per ICANN requirements.␊ - */␊ - contactBilling: (Contact5 | string)␊ - /**␊ - * Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois ␊ - * directories as per ICANN requirements.␊ - */␊ - contactRegistrant: (Contact5 | string)␊ - /**␊ - * Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois ␊ - * directories as per ICANN requirements.␊ - */␊ - contactTech: (Contact5 | string)␊ - /**␊ - * Current DNS type.␊ - */␊ - dnsType?: (("AzureDns" | "DefaultDomainRegistrarDns") | string)␊ - /**␊ - * Azure DNS Zone to use␊ - */␊ - dnsZoneId?: string␊ - /**␊ - * true if domain privacy is enabled for this domain; otherwise, false.␊ - */␊ - privacy?: (boolean | string)␊ - /**␊ - * Target DNS type (would be used for migration).␊ - */␊ - targetDnsType?: (("AzureDns" | "DefaultDomainRegistrarDns") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Domain purchase consent object, representing acceptance of applicable legal agreements.␊ - */␊ - export interface DomainPurchaseConsent5 {␊ - /**␊ - * Timestamp when the agreements were accepted.␊ - */␊ - agreedAt?: string␊ - /**␊ - * Client IP address.␊ - */␊ - agreedBy?: string␊ - /**␊ - * List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource.␊ - */␊ - agreementKeys?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois ␊ - * directories as per ICANN requirements.␊ - */␊ - export interface Contact5 {␊ - /**␊ - * Address information for domain registration.␊ - */␊ - addressMailing?: (Address5 | string)␊ - /**␊ - * Email address.␊ - */␊ - email: string␊ - /**␊ - * Fax number.␊ - */␊ - fax?: string␊ - /**␊ - * Job title.␊ - */␊ - jobTitle?: string␊ - /**␊ - * First name.␊ - */␊ - nameFirst: string␊ - /**␊ - * Last name.␊ - */␊ - nameLast: string␊ - /**␊ - * Middle name.␊ - */␊ - nameMiddle?: string␊ - /**␊ - * Organization contact belongs to.␊ - */␊ - organization?: string␊ - /**␊ - * Phone number.␊ - */␊ - phone: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Address information for domain registration.␊ - */␊ - export interface Address5 {␊ - /**␊ - * First line of an Address.␊ - */␊ - address1: string␊ - /**␊ - * First line of an Address.␊ - */␊ - address2?: string␊ - /**␊ - * The city for the address.␊ - */␊ - city: string␊ - /**␊ - * The country for the address.␊ - */␊ - country: string␊ - /**␊ - * The postal code for the address.␊ - */␊ - postalCode: string␊ - /**␊ - * The state or province for the address.␊ - */␊ - state: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers␊ - */␊ - export interface DomainsDomainOwnershipIdentifiersChildResource5 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of identifier.␊ - */␊ - name: string␊ - /**␊ - * DomainOwnershipIdentifier resource specific properties␊ - */␊ - properties: (DomainOwnershipIdentifierProperties5 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData4 | string)␊ - type: "domainOwnershipIdentifiers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DomainOwnershipIdentifier resource specific properties␊ - */␊ - export interface DomainOwnershipIdentifierProperties5 {␊ - /**␊ - * Ownership Id.␊ - */␊ - ownershipId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - export interface SystemData4 {␊ - /**␊ - * The timestamp of resource creation (UTC).␊ - */␊ - createdAt?: string␊ - /**␊ - * The identity that created the resource.␊ - */␊ - createdBy?: string␊ - /**␊ - * The type of identity that created the resource.␊ - */␊ - createdByType?: (("User" | "Application" | "ManagedIdentity" | "Key") | string)␊ - /**␊ - * The timestamp of resource last modification (UTC)␊ - */␊ - lastModifiedAt?: string␊ - /**␊ - * The identity that last modified the resource.␊ - */␊ - lastModifiedBy?: string␊ - /**␊ - * The type of identity that last modified the resource.␊ - */␊ - lastModifiedByType?: (("User" | "Application" | "ManagedIdentity" | "Key") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers␊ - */␊ - export interface DomainsDomainOwnershipIdentifiers5 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of identifier.␊ - */␊ - name: string␊ - /**␊ - * DomainOwnershipIdentifier resource specific properties␊ - */␊ - properties: (DomainOwnershipIdentifierProperties5 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData4 | string)␊ - type: "Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DomainRegistration/domains␊ - */␊ - export interface Domains9 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the domain.␊ - */␊ - name: string␊ - /**␊ - * Domain resource specific properties␊ - */␊ - properties: (DomainProperties9 | string)␊ - resources?: DomainsDomainOwnershipIdentifiersChildResource6[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.DomainRegistration/domains"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Domain resource specific properties␊ - */␊ - export interface DomainProperties9 {␊ - authCode?: string␊ - /**␊ - * true if the domain should be automatically renewed; otherwise, false.␊ - */␊ - autoRenew?: (boolean | string)␊ - /**␊ - * Domain purchase consent object, representing acceptance of applicable legal agreements.␊ - */␊ - consent: (DomainPurchaseConsent6 | string)␊ - /**␊ - * Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois ␊ - * directories as per ICANN requirements.␊ - */␊ - contactAdmin: (Contact6 | string)␊ - /**␊ - * Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois ␊ - * directories as per ICANN requirements.␊ - */␊ - contactBilling: (Contact6 | string)␊ - /**␊ - * Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois ␊ - * directories as per ICANN requirements.␊ - */␊ - contactRegistrant: (Contact6 | string)␊ - /**␊ - * Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois ␊ - * directories as per ICANN requirements.␊ - */␊ - contactTech: (Contact6 | string)␊ - /**␊ - * Current DNS type.␊ - */␊ - dnsType?: (("AzureDns" | "DefaultDomainRegistrarDns") | string)␊ - /**␊ - * Azure DNS Zone to use␊ - */␊ - dnsZoneId?: string␊ - /**␊ - * true if domain privacy is enabled for this domain; otherwise, false.␊ - */␊ - privacy?: (boolean | string)␊ - /**␊ - * Target DNS type (would be used for migration).␊ - */␊ - targetDnsType?: (("AzureDns" | "DefaultDomainRegistrarDns") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Domain purchase consent object, representing acceptance of applicable legal agreements.␊ - */␊ - export interface DomainPurchaseConsent6 {␊ - /**␊ - * Timestamp when the agreements were accepted.␊ - */␊ - agreedAt?: string␊ - /**␊ - * Client IP address.␊ - */␊ - agreedBy?: string␊ - /**␊ - * List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource.␊ - */␊ - agreementKeys?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois ␊ - * directories as per ICANN requirements.␊ - */␊ - export interface Contact6 {␊ - /**␊ - * Address information for domain registration.␊ - */␊ - addressMailing?: (Address6 | string)␊ - /**␊ - * Email address.␊ - */␊ - email: string␊ - /**␊ - * Fax number.␊ - */␊ - fax?: string␊ - /**␊ - * Job title.␊ - */␊ - jobTitle?: string␊ - /**␊ - * First name.␊ - */␊ - nameFirst: string␊ - /**␊ - * Last name.␊ - */␊ - nameLast: string␊ - /**␊ - * Middle name.␊ - */␊ - nameMiddle?: string␊ - /**␊ - * Organization contact belongs to.␊ - */␊ - organization?: string␊ - /**␊ - * Phone number.␊ - */␊ - phone: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Address information for domain registration.␊ - */␊ - export interface Address6 {␊ - /**␊ - * First line of an Address.␊ - */␊ - address1: string␊ - /**␊ - * First line of an Address.␊ - */␊ - address2?: string␊ - /**␊ - * The city for the address.␊ - */␊ - city: string␊ - /**␊ - * The country for the address.␊ - */␊ - country: string␊ - /**␊ - * The postal code for the address.␊ - */␊ - postalCode: string␊ - /**␊ - * The state or province for the address.␊ - */␊ - state: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers␊ - */␊ - export interface DomainsDomainOwnershipIdentifiersChildResource6 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of identifier.␊ - */␊ - name: string␊ - /**␊ - * DomainOwnershipIdentifier resource specific properties␊ - */␊ - properties: (DomainOwnershipIdentifierProperties6 | string)␊ - type: "domainOwnershipIdentifiers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * DomainOwnershipIdentifier resource specific properties␊ - */␊ - export interface DomainOwnershipIdentifierProperties6 {␊ - /**␊ - * Ownership Id.␊ - */␊ - ownershipId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers␊ - */␊ - export interface DomainsDomainOwnershipIdentifiers6 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of identifier.␊ - */␊ - name: string␊ - /**␊ - * DomainOwnershipIdentifier resource specific properties␊ - */␊ - properties: (DomainOwnershipIdentifierProperties6 | string)␊ - type: "Microsoft.DomainRegistration/domains/domainOwnershipIdentifiers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/certificates␊ - */␊ - export interface Certificates {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - /**␊ - * Name of the certificate.␊ - */␊ - name: string␊ - properties: (CertificateProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/certificates"␊ - [k: string]: unknown␊ - }␊ - export interface CertificateProperties {␊ - /**␊ - * Raw bytes of .cer file␊ - */␊ - cerBlob?: string␊ - /**␊ - * Certificate expiration date␊ - */␊ - expirationDate?: string␊ - /**␊ - * Friendly name of the certificate␊ - */␊ - friendlyName?: string␊ - /**␊ - * Specification for a hostingEnvironment (App Service Environment) to use for this resource␊ - */␊ - hostingEnvironmentProfile?: (HostingEnvironmentProfile | string)␊ - /**␊ - * Host names the certificate applies to␊ - */␊ - hostNames?: (string[] | string)␊ - /**␊ - * Certificate issue Date␊ - */␊ - issueDate?: string␊ - /**␊ - * Certificate issuer␊ - */␊ - issuer?: string␊ - /**␊ - * Certificate password␊ - */␊ - password?: string␊ - /**␊ - * Pfx blob␊ - */␊ - pfxBlob?: string␊ - /**␊ - * Public key hash␊ - */␊ - publicKeyHash?: string␊ - /**␊ - * Self link␊ - */␊ - selfLink?: string␊ - /**␊ - * App name␊ - */␊ - siteName?: string␊ - /**␊ - * Subject name of the certificate␊ - */␊ - subjectName?: string␊ - /**␊ - * Certificate thumbprint␊ - */␊ - thumbprint?: string␊ - /**␊ - * Is the certificate valid?␊ - */␊ - valid?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specification for a hostingEnvironment (App Service Environment) to use for this resource␊ - */␊ - export interface HostingEnvironmentProfile {␊ - /**␊ - * Resource id of the hostingEnvironment (App Service Environment)␊ - */␊ - id?: string␊ - /**␊ - * Name of the hostingEnvironment (App Service Environment) (read only)␊ - */␊ - name?: string␊ - /**␊ - * Resource type of the hostingEnvironment (App Service Environment) (read only)␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/csrs␊ - */␊ - export interface Csrs {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - /**␊ - * Name of the certificate.␊ - */␊ - name: string␊ - properties: (CsrProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/csrs"␊ - [k: string]: unknown␊ - }␊ - export interface CsrProperties {␊ - /**␊ - * Actual CSR string created␊ - */␊ - csrString?: string␊ - /**␊ - * Distinguished name of certificate to be created␊ - */␊ - distinguishedName?: string␊ - /**␊ - * Hosting environment␊ - */␊ - hostingEnvironment?: string␊ - /**␊ - * Name used to locate CSR object␊ - */␊ - name?: string␊ - /**␊ - * PFX password␊ - */␊ - password?: string␊ - /**␊ - * PFX certificate of created certificate␊ - */␊ - pfxBlob?: string␊ - /**␊ - * Hash of the certificates public key␊ - */␊ - publicKeyHash?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/hostingEnvironments␊ - */␊ - export interface HostingEnvironments {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - /**␊ - * Name of hostingEnvironment (App Service Environment)␊ - */␊ - name: string␊ - properties: (HostingEnvironmentProperties | string)␊ - resources?: (HostingEnvironmentsMultiRolePoolsChildResource | HostingEnvironmentsWorkerPoolsChildResource)[]␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/hostingEnvironments"␊ - [k: string]: unknown␊ - }␊ - export interface HostingEnvironmentProperties {␊ - /**␊ - * List of comma separated strings describing which VM sizes are allowed for front-ends␊ - */␊ - allowedMultiSizes?: string␊ - /**␊ - * List of comma separated strings describing which VM sizes are allowed for workers␊ - */␊ - allowedWorkerSizes?: string␊ - /**␊ - * Api Management Account associated with this Hosting Environment␊ - */␊ - apiManagementAccountId?: string␊ - /**␊ - * Custom settings for changing the behavior of the hosting environment␊ - */␊ - clusterSettings?: (NameValuePair[] | string)␊ - /**␊ - * Edition of the metadata database for the hostingEnvironment (App Service Environment) e.g. "Standard"␊ - */␊ - databaseEdition?: string␊ - /**␊ - * Service objective of the metadata database for the hostingEnvironment (App Service Environment) e.g. "S0"␊ - */␊ - databaseServiceObjective?: string␊ - /**␊ - * DNS suffix of the hostingEnvironment (App Service Environment)␊ - */␊ - dnsSuffix?: string␊ - /**␊ - * Current total, used, and available worker capacities␊ - */␊ - environmentCapacities?: (StampCapacity[] | string)␊ - /**␊ - * True/false indicating whether the hostingEnvironment (App Service Environment) is healthy␊ - */␊ - environmentIsHealthy?: (boolean | string)␊ - /**␊ - * Detailed message about with results of the last check of the hostingEnvironment (App Service Environment)␊ - */␊ - environmentStatus?: string␊ - /**␊ - * Specifies which endpoints to serve internally in the hostingEnvironment's (App Service Environment) VNET.␊ - */␊ - internalLoadBalancingMode?: (("None" | "Web" | "Publishing") | string)␊ - /**␊ - * Number of IP SSL addresses reserved for this hostingEnvironment (App Service Environment)␊ - */␊ - ipsslAddressCount?: (number | string)␊ - /**␊ - * Last deployment action on this hostingEnvironment (App Service Environment)␊ - */␊ - lastAction?: string␊ - /**␊ - * Result of the last deployment action on this hostingEnvironment (App Service Environment)␊ - */␊ - lastActionResult?: string␊ - /**␊ - * Location of the hostingEnvironment (App Service Environment), e.g. "West US"␊ - */␊ - location?: string␊ - /**␊ - * Maximum number of VMs in this hostingEnvironment (App Service Environment)␊ - */␊ - maximumNumberOfMachines?: (number | string)␊ - /**␊ - * Number of front-end instances␊ - */␊ - multiRoleCount?: (number | string)␊ - /**␊ - * Front-end VM size, e.g. "Medium", "Large"␊ - */␊ - multiSize?: string␊ - /**␊ - * Name of the hostingEnvironment (App Service Environment)␊ - */␊ - name?: string␊ - /**␊ - * Access control list for controlling traffic to the hostingEnvironment (App Service Environment)␊ - */␊ - networkAccessControlList?: (NetworkAccessControlEntry[] | string)␊ - /**␊ - * Provisioning state of the hostingEnvironment (App Service Environment).␊ - */␊ - provisioningState?: (("Succeeded" | "Failed" | "Canceled" | "InProgress" | "Deleting") | string)␊ - /**␊ - * Resource group of the hostingEnvironment (App Service Environment)␊ - */␊ - resourceGroup?: string␊ - /**␊ - * Current status of the hostingEnvironment (App Service Environment).␊ - */␊ - status: (("Preparing" | "Ready" | "Scaling" | "Deleting") | string)␊ - /**␊ - * Subscription of the hostingEnvironment (App Service Environment)␊ - */␊ - subscriptionId?: string␊ - /**␊ - * True/false indicating whether the hostingEnvironment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available␍␊ - * (most likely because NSG blocked the incoming traffic)␊ - */␊ - suspended?: (boolean | string)␊ - /**␊ - * Number of upgrade domains of this hostingEnvironment (App Service Environment)␊ - */␊ - upgradeDomains?: (number | string)␊ - /**␊ - * Description of IP SSL mapping for this hostingEnvironment (App Service Environment)␊ - */␊ - vipMappings?: (VirtualIPMapping[] | string)␊ - /**␊ - * Specification for using a virtual network␊ - */␊ - virtualNetwork?: (VirtualNetworkProfile3 | string)␊ - /**␊ - * Name of the hostingEnvironment's (App Service Environment) virtual network␊ - */␊ - vnetName?: string␊ - /**␊ - * Resource group of the hostingEnvironment's (App Service Environment) virtual network␊ - */␊ - vnetResourceGroupName?: string␊ - /**␊ - * Subnet of the hostingEnvironment's (App Service Environment) virtual network␊ - */␊ - vnetSubnetName?: string␊ - /**␊ - * Description of worker pools with worker size ids, VM sizes, and number of workers in each pool␊ - */␊ - workerPools?: (WorkerPool[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Name value pair␊ - */␊ - export interface NameValuePair {␊ - /**␊ - * Pair name␊ - */␊ - name?: string␊ - /**␊ - * Pair value␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class containing stamp capacity information␊ - */␊ - export interface StampCapacity {␊ - /**␊ - * Available capacity (# of machines, bytes of storage etc...)␊ - */␊ - availableCapacity?: (number | string)␊ - /**␊ - * Shared/Dedicated workers.␊ - */␊ - computeMode?: (("Shared" | "Dedicated" | "Dynamic") | string)␊ - /**␊ - * If true it includes basic sites␍␊ - * Basic sites are not used for capacity allocation.␊ - */␊ - excludeFromCapacityAllocation?: (boolean | string)␊ - /**␊ - * Is capacity applicable for all sites?␊ - */␊ - isApplicableForAllComputeModes?: (boolean | string)␊ - /**␊ - * Name of the stamp␊ - */␊ - name?: string␊ - /**␊ - * Shared or Dedicated␊ - */␊ - siteMode?: string␊ - /**␊ - * Total capacity (# of machines, bytes of storage etc...)␊ - */␊ - totalCapacity?: (number | string)␊ - /**␊ - * Name of the unit␊ - */␊ - unit?: string␊ - /**␊ - * Size of the machines.␊ - */␊ - workerSize?: (("Default" | "Small" | "Medium" | "Large") | string)␊ - /**␊ - * Size Id of machines: ␍␊ - * 0 - Small␍␊ - * 1 - Medium␍␊ - * 2 - Large␊ - */␊ - workerSizeId?: (number | string)␊ - [k: string]: unknown␊ - }␊ - export interface NetworkAccessControlEntry {␊ - action?: (("Permit" | "Deny") | string)␊ - description?: string␊ - order?: (number | string)␊ - remoteSubnet?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class that represents a VIP mapping␊ - */␊ - export interface VirtualIPMapping {␊ - /**␊ - * Internal HTTP port␊ - */␊ - internalHttpPort?: (number | string)␊ - /**␊ - * Internal HTTPS port␊ - */␊ - internalHttpsPort?: (number | string)␊ - /**␊ - * Is VIP mapping in use␊ - */␊ - inUse?: (boolean | string)␊ - /**␊ - * Virtual IP address␊ - */␊ - virtualIP?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specification for using a virtual network␊ - */␊ - export interface VirtualNetworkProfile3 {␊ - /**␊ - * Resource id of the virtual network␊ - */␊ - id?: string␊ - /**␊ - * Name of the virtual network (read-only)␊ - */␊ - name?: string␊ - /**␊ - * Subnet within the virtual network␊ - */␊ - subnet?: string␊ - /**␊ - * Resource type of the virtual network (read-only)␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Worker pool of a hostingEnvironment (App Service Environment)␊ - */␊ - export interface WorkerPool {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - /**␊ - * Resource Name␊ - */␊ - name?: string␊ - properties?: (WorkerPoolProperties | string)␊ - /**␊ - * Describes a sku for a scalable resource␊ - */␊ - sku?: (SkuDescription1 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Resource type␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - export interface WorkerPoolProperties {␊ - /**␊ - * Shared or dedicated web app hosting.␊ - */␊ - computeMode?: (("Shared" | "Dedicated" | "Dynamic") | string)␊ - /**␊ - * Names of all instances in the worker pool (read only)␊ - */␊ - instanceNames?: (string[] | string)␊ - /**␊ - * Number of instances in the worker pool␊ - */␊ - workerCount?: (number | string)␊ - /**␊ - * VM size of the worker pool instances␊ - */␊ - workerSize?: string␊ - /**␊ - * Worker size id for referencing this worker pool␊ - */␊ - workerSizeId?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a sku for a scalable resource␊ - */␊ - export interface SkuDescription1 {␊ - /**␊ - * Current number of instances assigned to the resource␊ - */␊ - capacity?: (number | string)␊ - /**␊ - * Family code of the resource sku␊ - */␊ - family?: string␊ - /**␊ - * Name of the resource sku␊ - */␊ - name?: string␊ - /**␊ - * Size specifier of the resource sku␊ - */␊ - size?: string␊ - /**␊ - * Service Tier of the resource sku␊ - */␊ - tier?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/hostingEnvironments/multiRolePools␊ - */␊ - export interface HostingEnvironmentsMultiRolePoolsChildResource {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - name: "default"␊ - properties: (WorkerPoolProperties | string)␊ - /**␊ - * Describes a sku for a scalable resource␊ - */␊ - sku?: (SkuDescription1 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "multiRolePools"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/hostingEnvironments/workerPools␊ - */␊ - export interface HostingEnvironmentsWorkerPoolsChildResource {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - /**␊ - * Name of worker pool␊ - */␊ - name: string␊ - properties: (WorkerPoolProperties | string)␊ - /**␊ - * Describes a sku for a scalable resource␊ - */␊ - sku?: (SkuDescription1 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "workerPools"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/hostingEnvironments/multiRolePools␊ - */␊ - export interface HostingEnvironmentsMultiRolePools {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - name: string␊ - properties: (WorkerPoolProperties | string)␊ - /**␊ - * Describes a sku for a scalable resource␊ - */␊ - sku?: (SkuDescription1 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/hostingEnvironments/multiRolePools"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/hostingEnvironments/workerPools␊ - */␊ - export interface HostingEnvironmentsWorkerPools {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - /**␊ - * Name of worker pool␊ - */␊ - name: string␊ - properties: (WorkerPoolProperties | string)␊ - /**␊ - * Describes a sku for a scalable resource␊ - */␊ - sku?: (SkuDescription1 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/hostingEnvironments/workerPools"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/managedHostingEnvironments␊ - */␊ - export interface ManagedHostingEnvironments {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - /**␊ - * Name of managed hosting environment␊ - */␊ - name: string␊ - properties: (HostingEnvironmentProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/managedHostingEnvironments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/serverfarms␊ - */␊ - export interface Serverfarms {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - /**␊ - * Name of App Service Plan␊ - */␊ - name: string␊ - properties: (ServerFarmWithRichSkuProperties | string)␊ - /**␊ - * Describes a sku for a scalable resource␊ - */␊ - sku?: (SkuDescription1 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/serverfarms"␊ - [k: string]: unknown␊ - }␊ - export interface ServerFarmWithRichSkuProperties {␊ - /**␊ - * App Service Plan administration site␊ - */␊ - adminSiteName?: string␊ - /**␊ - * Specification for a hostingEnvironment (App Service Environment) to use for this resource␊ - */␊ - hostingEnvironmentProfile?: (HostingEnvironmentProfile | string)␊ - /**␊ - * Maximum number of instances that can be assigned to this App Service Plan␊ - */␊ - maximumNumberOfWorkers?: (number | string)␊ - /**␊ - * Name for the App Service Plan␊ - */␊ - name?: string␊ - /**␊ - * 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␊ - */␊ - perSiteScaling?: (boolean | string)␊ - /**␊ - * Enables creation of a Linux App Service Plan␊ - */␊ - reserved?: (boolean | string)␊ - /**␊ - * Target worker tier assigned to the App Service Plan␊ - */␊ - workerTierName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/serverfarms/virtualNetworkConnections/gateways␊ - */␊ - export interface ServerfarmsVirtualNetworkConnectionsGateways {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - /**␊ - * The name of the gateway. Only 'primary' is supported.␊ - */␊ - name: string␊ - properties: (VnetGatewayProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/serverfarms/virtualNetworkConnections/gateways"␊ - [k: string]: unknown␊ - }␊ - export interface VnetGatewayProperties {␊ - /**␊ - * The VNET name.␊ - */␊ - vnetName?: string␊ - /**␊ - * The URI where the Vpn package can be downloaded␊ - */␊ - vpnPackageUri?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/serverfarms/virtualNetworkConnections/routes␊ - */␊ - export interface ServerfarmsVirtualNetworkConnectionsRoutes {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - /**␊ - * Name of the virtual network route␊ - */␊ - name: string␊ - properties: (VnetRouteProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/serverfarms/virtualNetworkConnections/routes"␊ - [k: string]: unknown␊ - }␊ - export interface VnetRouteProperties {␊ - /**␊ - * The ending address for this route. If the start address is specified in CIDR notation, this must be omitted.␊ - */␊ - endAddress?: string␊ - /**␊ - * The name of this route. This is only returned by the server and does not need to be set by the client.␊ - */␊ - name?: string␊ - /**␊ - * The type of route this is:␍␊ - * DEFAULT - By default, every web 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 web app only␍␊ - * ␍␊ - * These values will be used for syncing a Web App's routes with those from a Virtual Network. This operation will clear all DEFAULT and INHERITED routes and replace them␍␊ - * with new INHERITED routes.␊ - */␊ - routeType?: string␊ - /**␊ - * The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified.␊ - */␊ - startAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites␊ - */␊ - export interface Sites {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - /**␊ - * Name of the web app␊ - */␊ - name: string␊ - properties: (SiteProperties | string)␊ - resources?: (SitesVirtualNetworkConnectionsChildResource | SitesConfigChildResource | SitesSlotsChildResource | SitesSnapshotsChildResource | SitesDeploymentsChildResource | SitesHostNameBindingsChildResource | SitesSourcecontrolsChildResource | SitesPremieraddonsChildResource | SitesBackupsChildResource | SitesHybridconnectionChildResource)[]␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/sites"␊ - [k: string]: unknown␊ - }␊ - export interface SiteProperties {␊ - /**␊ - * Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app␊ - */␊ - clientAffinityEnabled?: (boolean | string)␊ - /**␊ - * Specifies if the client certificate is enabled for the web app␊ - */␊ - clientCertEnabled?: (boolean | string)␊ - /**␊ - * Represents information needed for cloning operation␊ - */␊ - cloningInfo?: (CloningInfo | string)␊ - /**␊ - * Size of a function container␊ - */␊ - containerSize?: (number | string)␊ - /**␊ - * True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line).␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Name of gateway app associated with web app␊ - */␊ - gatewaySiteName?: string␊ - /**␊ - * Specification for a hostingEnvironment (App Service Environment) to use for this resource␊ - */␊ - hostingEnvironmentProfile?: (HostingEnvironmentProfile | string)␊ - /**␊ - * Specifies if the public hostnames are disabled the web app.␍␊ - * If set to true the app is only accessible via API Management process␊ - */␊ - hostNamesDisabled?: (boolean | string)␊ - /**␊ - * Hostname SSL states are used to manage the SSL bindings for site's hostnames.␊ - */␊ - hostNameSslStates?: (HostNameSslState[] | string)␊ - /**␊ - * Maximum number of workers␍␊ - * This only applies to function container␊ - */␊ - maxNumberOfWorkers?: (number | string)␊ - microService?: string␊ - /**␊ - * Name of web app␊ - */␊ - name?: string␊ - /**␊ - * If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false.␊ - */␊ - scmSiteAlsoStopped?: (boolean | string)␊ - serverFarmId?: string␊ - /**␊ - * Configuration of Azure web site␊ - */␊ - siteConfig?: (SiteConfig | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents information needed for cloning operation␊ - */␊ - export interface CloningInfo {␊ - /**␊ - * Application settings overrides for cloned web app. If specified these settings will override the settings cloned ␍␊ - * from source web app. If not specified, application settings from source web app are retained.␊ - */␊ - appSettingsOverrides?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * If true, clone custom hostnames from source web app␊ - */␊ - cloneCustomHostNames?: (boolean | string)␊ - /**␊ - * Clone source control from source web app␊ - */␊ - cloneSourceControl?: (boolean | string)␊ - /**␊ - * If specified configure load balancing for source and clone site␊ - */␊ - configureLoadBalancing?: (boolean | string)␊ - /**␊ - * Correlation Id of cloning operation. This id ties multiple cloning operations␍␊ - * together to use the same snapshot␊ - */␊ - correlationId?: string␊ - /**␊ - * Hosting environment␊ - */␊ - hostingEnvironment?: string␊ - /**␊ - * Overwrite destination web app␊ - */␊ - overwrite?: (boolean | string)␊ - /**␊ - * ARM resource id of the source web app. Web 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␊ - */␊ - sourceWebAppId?: string␊ - /**␊ - * 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}␊ - */␊ - trafficManagerProfileId?: string␊ - /**␊ - * Name of traffic manager profile to create. This is only needed if traffic manager profile does not already exist␊ - */␊ - trafficManagerProfileName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Object that represents a SSL-enabled host name.␊ - */␊ - export interface HostNameSslState {␊ - /**␊ - * Host name␊ - */␊ - name?: string␊ - /**␊ - * SSL type.␊ - */␊ - sslState: (("Disabled" | "SniEnabled" | "IpBasedEnabled") | string)␊ - /**␊ - * SSL cert thumbprint␊ - */␊ - thumbprint?: string␊ - /**␊ - * Set this flag to update existing host name␊ - */␊ - toUpdate?: (boolean | string)␊ - /**␊ - * Virtual IP address assigned to the host name if IP based SSL is enabled␊ - */␊ - virtualIP?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Configuration of Azure web site␊ - */␊ - export interface SiteConfig {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - /**␊ - * Resource Name␊ - */␊ - name?: string␊ - properties?: (SiteConfigProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Resource type␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - export interface SiteConfigProperties {␊ - /**␊ - * Always On␊ - */␊ - alwaysOn?: (boolean | string)␊ - /**␊ - * Information about the formal API definition for the web app.␊ - */␊ - apiDefinition?: (ApiDefinitionInfo | string)␊ - /**␊ - * App Command Line to launch␊ - */␊ - appCommandLine?: string␊ - /**␊ - * Application Settings␊ - */␊ - appSettings?: (NameValuePair[] | string)␊ - /**␊ - * Auto heal enabled␊ - */␊ - autoHealEnabled?: (boolean | string)␊ - /**␊ - * AutoHealRules - describes the rules which can be defined for auto-heal␊ - */␊ - autoHealRules?: (AutoHealRules | string)␊ - /**␊ - * Auto swap slot name␊ - */␊ - autoSwapSlotName?: string␊ - /**␊ - * Connection strings␊ - */␊ - connectionStrings?: (ConnStringInfo[] | string)␊ - /**␊ - * Cross-Origin Resource Sharing (CORS) settings for the web app.␊ - */␊ - cors?: (CorsSettings | string)␊ - /**␊ - * Default documents␊ - */␊ - defaultDocuments?: (string[] | string)␊ - /**␊ - * Detailed error logging enabled␊ - */␊ - detailedErrorLoggingEnabled?: (boolean | string)␊ - /**␊ - * Document root␊ - */␊ - documentRoot?: string␊ - /**␊ - * Class containing Routing in production experiments␊ - */␊ - experiments?: (Experiments | string)␊ - /**␊ - * Handler mappings␊ - */␊ - handlerMappings?: (HandlerMapping[] | string)␊ - /**␊ - * HTTP logging Enabled␊ - */␊ - httpLoggingEnabled?: (boolean | string)␊ - /**␊ - * Ip Security restrictions␊ - */␊ - ipSecurityRestrictions?: (IpSecurityRestriction[] | string)␊ - /**␊ - * Java container␊ - */␊ - javaContainer?: string␊ - /**␊ - * Java container version␊ - */␊ - javaContainerVersion?: string␊ - /**␊ - * Java version␊ - */␊ - javaVersion?: string␊ - /**␊ - * Represents metric limits set on a web app.␊ - */␊ - limits?: (SiteLimits | string)␊ - /**␊ - * Site load balancing.␊ - */␊ - loadBalancing?: (("WeightedRoundRobin" | "LeastRequests" | "LeastResponseTime" | "WeightedTotalTraffic" | "RequestHash") | string)␊ - /**␊ - * Local mysql enabled␊ - */␊ - localMySqlEnabled?: (boolean | string)␊ - /**␊ - * HTTP Logs Directory size limit␊ - */␊ - logsDirectorySizeLimit?: (number | string)␊ - /**␊ - * Managed pipeline mode.␊ - */␊ - managedPipelineMode?: (("Integrated" | "Classic") | string)␊ - /**␊ - * Site Metadata␊ - */␊ - metadata?: (NameValuePair[] | string)␊ - /**␊ - * Net Framework Version␊ - */␊ - netFrameworkVersion?: string␊ - /**␊ - * Version of Node␊ - */␊ - nodeVersion?: string␊ - /**␊ - * Number of workers␊ - */␊ - numberOfWorkers?: (number | string)␊ - /**␊ - * Version of PHP␊ - */␊ - phpVersion?: string␊ - /**␊ - * Publishing password␊ - */␊ - publishingPassword?: string␊ - /**␊ - * Publishing user name␊ - */␊ - publishingUsername?: string␊ - /**␊ - * Version of Python␊ - */␊ - pythonVersion?: string␊ - /**␊ - * Remote Debugging Enabled␊ - */␊ - remoteDebuggingEnabled?: (boolean | string)␊ - /**␊ - * Remote Debugging Version␊ - */␊ - remoteDebuggingVersion?: string␊ - /**␊ - * Enable request tracing␊ - */␊ - requestTracingEnabled?: (boolean | string)␊ - /**␊ - * Request tracing expiration time␊ - */␊ - requestTracingExpirationTime?: string␊ - /**␊ - * SCM type␊ - */␊ - scmType?: string␊ - /**␊ - * Tracing options␊ - */␊ - tracingOptions?: string␊ - /**␊ - * Use 32 bit worker process␊ - */␊ - use32BitWorkerProcess?: (boolean | string)␊ - /**␊ - * Virtual applications␊ - */␊ - virtualApplications?: (VirtualApplication[] | string)␊ - /**␊ - * Vnet name␊ - */␊ - vnetName?: string␊ - /**␊ - * Web socket enabled.␊ - */␊ - webSocketsEnabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the formal API definition for the web app.␊ - */␊ - export interface ApiDefinitionInfo {␊ - /**␊ - * The URL of the API definition.␊ - */␊ - url?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AutoHealRules - describes the rules which can be defined for auto-heal␊ - */␊ - export interface AutoHealRules {␊ - /**␊ - * AutoHealActions - Describes the actions which can be␍␊ - * taken by the auto-heal module when a rule is triggered.␊ - */␊ - actions?: (AutoHealActions | string)␊ - /**␊ - * AutoHealTriggers - describes the triggers for auto-heal.␊ - */␊ - triggers?: (AutoHealTriggers | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AutoHealActions - Describes the actions which can be␍␊ - * taken by the auto-heal module when a rule is triggered.␊ - */␊ - export interface AutoHealActions {␊ - /**␊ - * ActionType - predefined action to be taken.␊ - */␊ - actionType: (("Recycle" | "LogEvent" | "CustomAction") | string)␊ - /**␊ - * AutoHealCustomAction - Describes the custom action to be executed␍␊ - * when an auto heal rule is triggered.␊ - */␊ - customAction?: (AutoHealCustomAction | string)␊ - /**␊ - * MinProcessExecutionTime - minimum time the process must execute␍␊ - * before taking the action␊ - */␊ - minProcessExecutionTime?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AutoHealCustomAction - Describes the custom action to be executed␍␊ - * when an auto heal rule is triggered.␊ - */␊ - export interface AutoHealCustomAction {␊ - /**␊ - * Executable to be run␊ - */␊ - exe?: string␊ - /**␊ - * Parameters for the executable␊ - */␊ - parameters?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AutoHealTriggers - describes the triggers for auto-heal.␊ - */␊ - export interface AutoHealTriggers {␊ - /**␊ - * PrivateBytesInKB - Defines a rule based on private bytes␊ - */␊ - privateBytesInKB?: (number | string)␊ - /**␊ - * RequestsBasedTrigger␊ - */␊ - requests?: (RequestsBasedTrigger | string)␊ - /**␊ - * SlowRequestsBasedTrigger␊ - */␊ - slowRequests?: (SlowRequestsBasedTrigger | string)␊ - /**␊ - * StatusCodes - Defines a rule based on status codes␊ - */␊ - statusCodes?: (StatusCodesBasedTrigger[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * RequestsBasedTrigger␊ - */␊ - export interface RequestsBasedTrigger {␊ - /**␊ - * Count␊ - */␊ - count?: (number | string)␊ - /**␊ - * TimeInterval␊ - */␊ - timeInterval?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SlowRequestsBasedTrigger␊ - */␊ - export interface SlowRequestsBasedTrigger {␊ - /**␊ - * Count␊ - */␊ - count?: (number | string)␊ - /**␊ - * TimeInterval␊ - */␊ - timeInterval?: string␊ - /**␊ - * TimeTaken␊ - */␊ - timeTaken?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * StatusCodeBasedTrigger␊ - */␊ - export interface StatusCodesBasedTrigger {␊ - /**␊ - * Count␊ - */␊ - count?: (number | string)␊ - /**␊ - * HTTP status code␊ - */␊ - status?: (number | string)␊ - /**␊ - * SubStatus␊ - */␊ - subStatus?: (number | string)␊ - /**␊ - * TimeInterval␊ - */␊ - timeInterval?: string␊ - /**␊ - * Win32 error code␊ - */␊ - win32Status?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents database connection string information␊ - */␊ - export interface ConnStringInfo {␊ - /**␊ - * Connection string value␊ - */␊ - connectionString?: string␊ - /**␊ - * Name of connection string␊ - */␊ - name?: string␊ - /**␊ - * Type of database.␊ - */␊ - type: (("MySql" | "SQLServer" | "SQLAzure" | "Custom") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Cross-Origin Resource Sharing (CORS) settings for the web app.␊ - */␊ - export interface CorsSettings {␊ - /**␊ - * 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.␊ - */␊ - allowedOrigins?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Class containing Routing in production experiments␊ - */␊ - export interface Experiments {␊ - /**␊ - * List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects.␊ - */␊ - rampUpRules?: (RampUpRule[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance␊ - */␊ - export interface RampUpRule {␊ - /**␊ - * Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net␊ - */␊ - actionHostName?: string␊ - /**␊ - * 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/␊ - */␊ - changeDecisionCallbackUrl?: string␊ - /**␊ - * [Optional] Specifies interval in minutes to reevaluate ReroutePercentage␊ - */␊ - changeIntervalInMinutes?: (number | string)␊ - /**␊ - * [Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches ␍␊ - * {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}.␍␊ - * Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl}␊ - */␊ - changeStep?: (number | string)␊ - /**␊ - * [Optional] Specifies upper boundary below which ReroutePercentage will stay.␊ - */␊ - maxReroutePercentage?: (number | string)␊ - /**␊ - * [Optional] Specifies lower boundary above which ReroutePercentage will stay.␊ - */␊ - minReroutePercentage?: (number | string)␊ - /**␊ - * Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment.␊ - */␊ - name?: string␊ - /**␊ - * Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName}␊ - */␊ - reroutePercentage?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * 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.␊ - */␊ - export interface HandlerMapping {␊ - /**␊ - * Command-line arguments to be passed to the script processor.␊ - */␊ - arguments?: string␊ - /**␊ - * Requests with this extension will be handled using the specified FastCGI application.␊ - */␊ - extension?: string␊ - /**␊ - * The absolute path to the FastCGI application.␊ - */␊ - scriptProcessor?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents an ip security restriction on a web app.␊ - */␊ - export interface IpSecurityRestriction {␊ - /**␊ - * IP address the security restriction is valid for␊ - */␊ - ipAddress?: string␊ - /**␊ - * Subnet mask for the range of IP addresses the restriction is valid for␊ - */␊ - subnetMask?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Represents metric limits set on a web app.␊ - */␊ - export interface SiteLimits {␊ - /**␊ - * Maximum allowed disk size usage in MB␊ - */␊ - maxDiskSizeInMb?: (number | string)␊ - /**␊ - * Maximum allowed memory usage in MB␊ - */␊ - maxMemoryInMb?: (number | string)␊ - /**␊ - * Maximum allowed CPU usage percentage␊ - */␊ - maxPercentageCpu?: (number | string)␊ - [k: string]: unknown␊ - }␊ - export interface VirtualApplication {␊ - physicalPath?: string␊ - preloadEnabled?: (boolean | string)␊ - virtualDirectories?: (VirtualDirectory[] | string)␊ - virtualPath?: string␊ - [k: string]: unknown␊ - }␊ - export interface VirtualDirectory {␊ - physicalPath?: string␊ - virtualPath?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/virtualNetworkConnections␊ - */␊ - export interface SitesVirtualNetworkConnectionsChildResource {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - /**␊ - * The name of the Virtual Network␊ - */␊ - name: string␊ - properties: (VnetInfoProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "virtualNetworkConnections"␊ - [k: string]: unknown␊ - }␊ - export interface VnetInfoProperties {␊ - /**␊ - * A certificate file (.cer) blob containing the public key of the private key used to authenticate a ␍␊ - * Point-To-Site VPN connection.␊ - */␊ - certBlob?: string␊ - /**␊ - * The client certificate thumbprint␊ - */␊ - certThumbprint?: string␊ - /**␊ - * Dns servers to be used by this VNET. This should be a comma-separated list of IP addresses.␊ - */␊ - dnsServers?: string␊ - /**␊ - * Flag to determine if a resync is required␊ - */␊ - resyncRequired?: (boolean | string)␊ - /**␊ - * The routes that this virtual network connection uses.␊ - */␊ - routes?: (VnetRoute2[] | string)␊ - /**␊ - * The vnet resource id␊ - */␊ - vnetResourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VnetRoute contract used to pass routing information for a vnet.␊ - */␊ - export interface VnetRoute2 {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - /**␊ - * Resource Name␊ - */␊ - name?: string␊ - properties?: (VnetRouteProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Resource type␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - export interface SlotConfigNamesResourceProperties {␊ - /**␊ - * List of application settings names␊ - */␊ - appSettingNames?: (string[] | string)␊ - /**␊ - * List of connection string names␊ - */␊ - connectionStringNames?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Database connection string value to type pair␊ - */␊ - export interface ConnStringValueTypePair {␊ - /**␊ - * Type of database.␊ - */␊ - type: (("MySql" | "SQLServer" | "SQLAzure" | "Custom") | string)␊ - /**␊ - * Value of pair␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - export interface SiteLogsConfigProperties {␊ - /**␊ - * Application logs configuration␊ - */␊ - applicationLogs?: (ApplicationLogsConfig | string)␊ - /**␊ - * Enabled configuration␊ - */␊ - detailedErrorMessages?: (EnabledConfig | string)␊ - /**␊ - * Enabled configuration␊ - */␊ - failedRequestsTracing?: (EnabledConfig | string)␊ - /**␊ - * Http logs configuration␊ - */␊ - httpLogs?: (HttpLogsConfig | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application logs configuration␊ - */␊ - export interface ApplicationLogsConfig {␊ - /**␊ - * Application logs azure blob storage configuration␊ - */␊ - azureBlobStorage?: (AzureBlobStorageApplicationLogsConfig | string)␊ - /**␊ - * Application logs to azure table storage configuration␊ - */␊ - azureTableStorage?: (AzureTableStorageApplicationLogsConfig | string)␊ - /**␊ - * Application logs to file system configuration␊ - */␊ - fileSystem?: (FileSystemApplicationLogsConfig | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application logs azure blob storage configuration␊ - */␊ - export interface AzureBlobStorageApplicationLogsConfig {␊ - /**␊ - * Log level.␊ - */␊ - level?: (("Off" | "Verbose" | "Information" | "Warning" | "Error") | string)␊ - /**␊ - * Retention in days.␍␊ - * Remove blobs older than X days.␍␊ - * 0 or lower means no retention.␊ - */␊ - retentionInDays?: (number | string)␊ - /**␊ - * SAS url to a azure blob container with read/write/list/delete permissions␊ - */␊ - sasUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application logs to azure table storage configuration␊ - */␊ - export interface AzureTableStorageApplicationLogsConfig {␊ - /**␊ - * Log level.␊ - */␊ - level?: (("Off" | "Verbose" | "Information" | "Warning" | "Error") | string)␊ - /**␊ - * SAS url to an azure table with add/query/delete permissions␊ - */␊ - sasUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application logs to file system configuration␊ - */␊ - export interface FileSystemApplicationLogsConfig {␊ - /**␊ - * Log level.␊ - */␊ - level?: (("Off" | "Verbose" | "Information" | "Warning" | "Error") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Enabled configuration␊ - */␊ - export interface EnabledConfig {␊ - /**␊ - * Enabled␊ - */␊ - enabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http logs configuration␊ - */␊ - export interface HttpLogsConfig {␊ - /**␊ - * Http logs to azure blob storage configuration␊ - */␊ - azureBlobStorage?: (AzureBlobStorageHttpLogsConfig | string)␊ - /**␊ - * Http logs to file system configuration␊ - */␊ - fileSystem?: (FileSystemHttpLogsConfig | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http logs to azure blob storage configuration␊ - */␊ - export interface AzureBlobStorageHttpLogsConfig {␊ - /**␊ - * Enabled␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Retention in days.␍␊ - * Remove blobs older than X days.␍␊ - * 0 or lower means no retention.␊ - */␊ - retentionInDays?: (number | string)␊ - /**␊ - * SAS url to a azure blob container with read/write/list/delete permissions␊ - */␊ - sasUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http logs to file system configuration␊ - */␊ - export interface FileSystemHttpLogsConfig {␊ - /**␊ - * Enabled␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Retention in days.␍␊ - * Remove files older than X days.␍␊ - * 0 or lower means no retention.␊ - */␊ - retentionInDays?: (number | string)␊ - /**␊ - * 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.␊ - */␊ - retentionInMb?: (number | string)␊ - [k: string]: unknown␊ - }␊ - export interface BackupRequestProperties {␊ - /**␊ - * Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy.␊ - */␊ - backupSchedule?: (BackupSchedule | string)␊ - /**␊ - * Databases included in the backup␊ - */␊ - databases?: (DatabaseBackupSetting[] | string)␊ - /**␊ - * True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Name of the backup␊ - */␊ - name?: string␊ - /**␊ - * SAS URL to the container␊ - */␊ - storageAccountUrl?: string␊ - /**␊ - * Type of the backup.␊ - */␊ - type: (("Default" | "Clone" | "Relocation") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy.␊ - */␊ - export interface BackupSchedule {␊ - /**␊ - * How often should be the backup executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day)␊ - */␊ - frequencyInterval?: (number | string)␊ - /**␊ - * How often should be the backup executed (e.g. for weekly backup, this should be set to Day and FrequencyInterval should be set to 7).␊ - */␊ - frequencyUnit: (("Day" | "Hour") | string)␊ - /**␊ - * True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise.␊ - */␊ - keepAtLeastOneBackup?: (boolean | string)␊ - /**␊ - * The last time when this schedule was triggered␊ - */␊ - lastExecutionTime?: string␊ - /**␊ - * After how many days backups should be deleted␊ - */␊ - retentionPeriodInDays?: (number | string)␊ - /**␊ - * When the schedule should start working␊ - */␊ - startTime?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Note: properties are serialized in JSON format and stored in DB. ␍␊ - * if new properties are added they might not be in the previous data rows ␍␊ - * so please handle nulls␊ - */␊ - export interface DatabaseBackupSetting {␊ - /**␊ - * Contains a connection string to a database which is being backed up/restored. If the restore should happen to a new database, the database name inside is the new one.␊ - */␊ - connectionString?: string␊ - /**␊ - * Contains a connection string name that is linked to the SiteConfig.ConnectionStrings.␍␊ - * This is used during restore with overwrite connection strings options.␊ - */␊ - connectionStringName?: string␊ - /**␊ - * SqlAzure / MySql␊ - */␊ - databaseType?: string␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots␊ - */␊ - export interface SitesSlotsChildResource {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - /**␊ - * Name of web app slot. If not specified then will default to production slot.␊ - */␊ - name: string␊ - properties: (SiteProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "slots"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/snapshots␊ - */␊ - export interface SitesSnapshotsChildResource {␊ - apiVersion: "2015-08-01"␊ - name: "snapshots"␊ - type: "snapshots"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/deployments␊ - */␊ - export interface SitesDeploymentsChildResource {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - /**␊ - * Id of the deployment␊ - */␊ - name: string␊ - properties: (DeploymentProperties2 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "deployments"␊ - [k: string]: unknown␊ - }␊ - export interface DeploymentProperties2 {␊ - /**␊ - * Active␊ - */␊ - active?: (boolean | string)␊ - /**␊ - * Author␊ - */␊ - author?: string␊ - /**␊ - * AuthorEmail␊ - */␊ - author_email?: string␊ - /**␊ - * Deployer␊ - */␊ - deployer?: string␊ - /**␊ - * Detail␊ - */␊ - details?: string␊ - /**␊ - * EndTime␊ - */␊ - end_time?: string␊ - /**␊ - * Id␊ - */␊ - id?: string␊ - /**␊ - * Message␊ - */␊ - message?: string␊ - /**␊ - * StartTime␊ - */␊ - start_time?: string␊ - /**␊ - * Status␊ - */␊ - status?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/hostNameBindings␊ - */␊ - export interface SitesHostNameBindingsChildResource {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - /**␊ - * Name of host␊ - */␊ - name: string␊ - properties: (HostNameBindingProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "hostNameBindings"␊ - [k: string]: unknown␊ - }␊ - export interface HostNameBindingProperties {␊ - /**␊ - * Azure resource name␊ - */␊ - azureResourceName?: string␊ - /**␊ - * Azure resource type.␊ - */␊ - azureResourceType?: (("Website" | "TrafficManager") | string)␊ - /**␊ - * Custom DNS record type.␊ - */␊ - customHostNameDnsRecordType?: (("CName" | "A") | string)␊ - /**␊ - * Fully qualified ARM domain resource URI␊ - */␊ - domainId?: string␊ - /**␊ - * Host name type.␊ - */␊ - hostNameType?: (("Verified" | "Managed") | string)␊ - /**␊ - * Hostname␊ - */␊ - name?: string␊ - /**␊ - * Web app name␊ - */␊ - siteName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/sourcecontrols␊ - */␊ - export interface SitesSourcecontrolsChildResource {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - name: "web"␊ - properties: (SiteSourceControlProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "sourcecontrols"␊ - [k: string]: unknown␊ - }␊ - export interface SiteSourceControlProperties {␊ - /**␊ - * Name of branch to use for deployment␊ - */␊ - branch?: string␊ - /**␊ - * Whether to manual or continuous integration␊ - */␊ - deploymentRollbackEnabled?: (boolean | string)␊ - /**␊ - * Whether to manual or continuous integration␊ - */␊ - isManualIntegration?: (boolean | string)␊ - /**␊ - * Mercurial or Git repository type␊ - */␊ - isMercurial?: (boolean | string)␊ - /**␊ - * Repository or source control url␊ - */␊ - repoUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/premieraddons␊ - */␊ - export interface SitesPremieraddonsChildResource {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Geo region resource belongs to e.g. SouthCentralUS, SouthEastAsia␊ - */␊ - location?: string␊ - name: string␊ - /**␊ - * The plan object in an ARM, represents a marketplace plan␊ - */␊ - plan?: (ArmPlan | string)␊ - properties: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a sku for a scalable resource␊ - */␊ - sku?: (SkuDescription1 | string)␊ - /**␊ - * Tags associated with resource␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "premieraddons"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The plan object in an ARM, represents a marketplace plan␊ - */␊ - export interface ArmPlan {␊ - /**␊ - * The name␊ - */␊ - name?: string␊ - /**␊ - * The product␊ - */␊ - product?: string␊ - /**␊ - * The promotion code␊ - */␊ - promotionCode?: string␊ - /**␊ - * The publisher␊ - */␊ - publisher?: string␊ - /**␊ - * Version of product␊ - */␊ - version?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/backups␊ - */␊ - export interface SitesBackupsChildResource {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - name: "discover"␊ - properties: (RestoreRequestProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "backups"␊ - [k: string]: unknown␊ - }␊ - export interface RestoreRequestProperties {␊ - /**␊ - * Gets or sets a flag showing if SiteConfig.ConnectionStrings should be set in new site␊ - */␊ - adjustConnectionStrings?: (boolean | string)␊ - /**␊ - * Name of a blob which contains the backup␊ - */␊ - blobName?: string␊ - /**␊ - * Collection of databases which should be restored. This list has to match the list of databases included in the backup.␊ - */␊ - databases?: (DatabaseBackupSetting[] | string)␊ - /**␊ - * App Service Environment name, if needed (only when restoring a site to an App Service Environment)␊ - */␊ - hostingEnvironment?: string␊ - /**␊ - * Changes a logic when restoring a site with custom domains. If "true", custom domains are removed automatically. If "false", custom domains are added to ␍␊ - * the site object when it is being restored, but that might fail due to conflicts during the operation.␊ - */␊ - ignoreConflictingHostNames?: (boolean | string)␊ - /**␊ - * Operation type.␊ - */␊ - operationType: (("Default" | "Clone" | "Relocation") | string)␊ - /**␊ - * True if the restore operation can overwrite target site. "True" needed if trying to restore over an existing site.␊ - */␊ - overwrite?: (boolean | string)␊ - /**␊ - * Name of a site (Web App)␊ - */␊ - siteName?: string␊ - /**␊ - * SAS URL to the container␊ - */␊ - storageAccountUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/hybridconnection␊ - */␊ - export interface SitesHybridconnectionChildResource {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - /**␊ - * The name by which the Hybrid Connection is identified␊ - */␊ - name: string␊ - properties: (RelayServiceConnectionEntityProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "hybridconnection"␊ - [k: string]: unknown␊ - }␊ - export interface RelayServiceConnectionEntityProperties {␊ - biztalkUri?: string␊ - entityConnectionString?: string␊ - entityName?: string␊ - hostname?: string␊ - port?: (number | string)␊ - resourceConnectionString?: string␊ - resourceType?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/backups␊ - */␊ - export interface SitesBackups {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - name: string␊ - properties: (RestoreRequestProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/sites/backups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/deployments␊ - */␊ - export interface SitesDeployments {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - /**␊ - * Id of the deployment␊ - */␊ - name: string␊ - properties: (DeploymentProperties2 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/sites/deployments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/hostNameBindings␊ - */␊ - export interface SitesHostNameBindings {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - /**␊ - * Name of host␊ - */␊ - name: string␊ - properties: (HostNameBindingProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/sites/hostNameBindings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/hybridconnection␊ - */␊ - export interface SitesHybridconnection {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - /**␊ - * The name by which the Hybrid Connection is identified␊ - */␊ - name: string␊ - properties: (RelayServiceConnectionEntityProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/sites/hybridconnection"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/instances/deployments␊ - */␊ - export interface SitesInstancesDeployments {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - /**␊ - * Id of the deployment␊ - */␊ - name: string␊ - properties: (DeploymentProperties2 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/sites/instances/deployments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/premieraddons␊ - */␊ - export interface SitesPremieraddons {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Geo region resource belongs to e.g. SouthCentralUS, SouthEastAsia␊ - */␊ - location?: string␊ - name: string␊ - /**␊ - * The plan object in an ARM, represents a marketplace plan␊ - */␊ - plan?: (ArmPlan | string)␊ - properties: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a sku for a scalable resource␊ - */␊ - sku?: (SkuDescription1 | string)␊ - /**␊ - * Tags associated with resource␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/sites/premieraddons"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots␊ - */␊ - export interface SitesSlots {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - /**␊ - * Name of web app slot. If not specified then will default to production slot.␊ - */␊ - name: string␊ - properties: (SiteProperties | string)␊ - resources?: (SitesSlotsVirtualNetworkConnectionsChildResource | SitesSlotsSnapshotsChildResource | SitesSlotsDeploymentsChildResource | SitesSlotsHostNameBindingsChildResource | SitesSlotsConfigChildResource | SitesSlotsSourcecontrolsChildResource | SitesSlotsPremieraddonsChildResource | SitesSlotsBackupsChildResource | SitesSlotsHybridconnectionChildResource)[]␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/sites/slots"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/virtualNetworkConnections␊ - */␊ - export interface SitesSlotsVirtualNetworkConnectionsChildResource {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - /**␊ - * The name of the Virtual Network␊ - */␊ - name: string␊ - properties: (VnetInfoProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "virtualNetworkConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/snapshots␊ - */␊ - export interface SitesSlotsSnapshotsChildResource {␊ - apiVersion: "2015-08-01"␊ - name: "snapshots"␊ - type: "snapshots"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/deployments␊ - */␊ - export interface SitesSlotsDeploymentsChildResource {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - /**␊ - * Id of the deployment␊ - */␊ - name: string␊ - properties: (DeploymentProperties2 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "deployments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/hostNameBindings␊ - */␊ - export interface SitesSlotsHostNameBindingsChildResource {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - /**␊ - * Name of host␊ - */␊ - name: string␊ - properties: (HostNameBindingProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "hostNameBindings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/sourcecontrols␊ - */␊ - export interface SitesSlotsSourcecontrolsChildResource {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - name: "web"␊ - properties: (SiteSourceControlProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "sourcecontrols"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/premieraddons␊ - */␊ - export interface SitesSlotsPremieraddonsChildResource {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Geo region resource belongs to e.g. SouthCentralUS, SouthEastAsia␊ - */␊ - location?: string␊ - name: string␊ - /**␊ - * The plan object in an ARM, represents a marketplace plan␊ - */␊ - plan?: (ArmPlan | string)␊ - properties: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a sku for a scalable resource␊ - */␊ - sku?: (SkuDescription1 | string)␊ - /**␊ - * Tags associated with resource␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "premieraddons"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/backups␊ - */␊ - export interface SitesSlotsBackupsChildResource {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - name: "discover"␊ - properties: (RestoreRequestProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "backups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/hybridconnection␊ - */␊ - export interface SitesSlotsHybridconnectionChildResource {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - /**␊ - * The name by which the Hybrid Connection is identified␊ - */␊ - name: string␊ - properties: (RelayServiceConnectionEntityProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "hybridconnection"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/backups␊ - */␊ - export interface SitesSlotsBackups {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - name: string␊ - properties: (RestoreRequestProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/sites/slots/backups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/deployments␊ - */␊ - export interface SitesSlotsDeployments {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - /**␊ - * Id of the deployment␊ - */␊ - name: string␊ - properties: (DeploymentProperties2 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/sites/slots/deployments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/hostNameBindings␊ - */␊ - export interface SitesSlotsHostNameBindings {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - /**␊ - * Name of host␊ - */␊ - name: string␊ - properties: (HostNameBindingProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/sites/slots/hostNameBindings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/hybridconnection␊ - */␊ - export interface SitesSlotsHybridconnection {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - /**␊ - * The name by which the Hybrid Connection is identified␊ - */␊ - name: string␊ - properties: (RelayServiceConnectionEntityProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/sites/slots/hybridconnection"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/instances/deployments␊ - */␊ - export interface SitesSlotsInstancesDeployments {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - /**␊ - * Id of the deployment␊ - */␊ - name: string␊ - properties: (DeploymentProperties2 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/sites/slots/instances/deployments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/premieraddons␊ - */␊ - export interface SitesSlotsPremieraddons {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Geo region resource belongs to e.g. SouthCentralUS, SouthEastAsia␊ - */␊ - location?: string␊ - name: string␊ - /**␊ - * The plan object in an ARM, represents a marketplace plan␊ - */␊ - plan?: (ArmPlan | string)␊ - properties: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a sku for a scalable resource␊ - */␊ - sku?: (SkuDescription1 | string)␊ - /**␊ - * Tags associated with resource␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/sites/slots/premieraddons"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/snapshots␊ - */␊ - export interface SitesSlotsSnapshots {␊ - apiVersion: "2015-08-01"␊ - name: string␊ - type: "Microsoft.Web/sites/slots/snapshots"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/sourcecontrols␊ - */␊ - export interface SitesSlotsSourcecontrols {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - name: string␊ - properties: (SiteSourceControlProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/sites/slots/sourcecontrols"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/virtualNetworkConnections␊ - */␊ - export interface SitesSlotsVirtualNetworkConnections {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - /**␊ - * The name of the Virtual Network␊ - */␊ - name: string␊ - properties: (VnetInfoProperties | string)␊ - resources?: SitesSlotsVirtualNetworkConnectionsGatewaysChildResource[]␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/sites/slots/virtualNetworkConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/virtualNetworkConnections/gateways␊ - */␊ - export interface SitesSlotsVirtualNetworkConnectionsGatewaysChildResource {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - /**␊ - * The name of the gateway. The only gateway that exists presently is "primary"␊ - */␊ - name: string␊ - properties: (VnetGatewayProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "gateways"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/virtualNetworkConnections/gateways␊ - */␊ - export interface SitesSlotsVirtualNetworkConnectionsGateways {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - /**␊ - * The name of the gateway. The only gateway that exists presently is "primary"␊ - */␊ - name: string␊ - properties: (VnetGatewayProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/sites/slots/virtualNetworkConnections/gateways"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/snapshots␊ - */␊ - export interface SitesSnapshots {␊ - apiVersion: "2015-08-01"␊ - name: string␊ - type: "Microsoft.Web/sites/snapshots"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/sourcecontrols␊ - */␊ - export interface SitesSourcecontrols {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - name: string␊ - properties: (SiteSourceControlProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/sites/sourcecontrols"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/virtualNetworkConnections␊ - */␊ - export interface SitesVirtualNetworkConnections {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - /**␊ - * The name of the Virtual Network␊ - */␊ - name: string␊ - properties: (VnetInfoProperties | string)␊ - resources?: SitesVirtualNetworkConnectionsGatewaysChildResource[]␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/sites/virtualNetworkConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/virtualNetworkConnections/gateways␊ - */␊ - export interface SitesVirtualNetworkConnectionsGatewaysChildResource {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - /**␊ - * The name of the gateway. The only gateway that exists presently is "primary"␊ - */␊ - name: string␊ - properties: (VnetGatewayProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "gateways"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/virtualNetworkConnections/gateways␊ - */␊ - export interface SitesVirtualNetworkConnectionsGateways {␊ - apiVersion: "2015-08-01"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - /**␊ - * The name of the gateway. The only gateway that exists presently is "primary"␊ - */␊ - name: string␊ - properties: (VnetGatewayProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/sites/virtualNetworkConnections/gateways"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/connections␊ - */␊ - export interface Connections28 {␊ - apiVersion: "2015-08-01-preview"␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - /**␊ - * The connection name.␊ - */␊ - name: string␊ - properties: (ConnectionProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/connections"␊ - [k: string]: unknown␊ - }␊ - export interface ConnectionProperties {␊ - /**␊ - * expanded parent object for expansion␊ - */␊ - api?: (ExpandedParentApiEntity | string)␊ - /**␊ - * Timestamp of last connection change.␊ - */␊ - changedTime?: string␊ - /**␊ - * Timestamp of the connection creation␊ - */␊ - createdTime?: string␊ - /**␊ - * Custom login setting values.␊ - */␊ - customParameterValues?: ({␊ - [k: string]: ParameterCustomLoginSettingValues␊ - } | string)␊ - /**␊ - * display name␊ - */␊ - displayName?: string␊ - /**␊ - * Time in UTC when the first expiration of OAuth tokens␊ - */␊ - firstExpirationTime?: string␊ - /**␊ - * List of Keywords that tag the acl␊ - */␊ - keywords?: (string[] | string)␊ - metadata?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * connection name␊ - */␊ - name?: string␊ - /**␊ - * Tokens/Claim␊ - */␊ - nonSecretParameterValues?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Tokens/Claim␊ - */␊ - parameterValues?: ({␊ - [k: string]: {␊ - [k: string]: unknown␊ - }␊ - } | string)␊ - /**␊ - * Status of the connection␊ - */␊ - statuses?: (ConnectionStatus[] | string)␊ - tenantId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * expanded parent object for expansion␊ - */␊ - export interface ExpandedParentApiEntity {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - /**␊ - * Resource Name␊ - */␊ - name?: string␊ - properties?: (ExpandedParentApiEntityProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Resource type␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - export interface ExpandedParentApiEntityProperties {␊ - /**␊ - * Message envelope that contains the common Azure resource manager properties and the resource provider specific content␊ - */␊ - entity?: (ResponseMessageEnvelopeApiEntity | string)␊ - /**␊ - * Id of connection provider␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Message envelope that contains the common Azure resource manager properties and the resource provider specific content␊ - */␊ - export interface ResponseMessageEnvelopeApiEntity {␊ - /**␊ - * Resource Id. Typically id is populated only for responses to GET requests. Caller is responsible for passing in this␍␊ - * value for GET requests only.␍␊ - * For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename}␊ - */␊ - id?: string␊ - /**␊ - * Geo region resource belongs to e.g. SouthCentralUS, SouthEastAsia␊ - */␊ - location?: string␊ - /**␊ - * Name of resource␊ - */␊ - name?: string␊ - /**␊ - * The plan object in an ARM, represents a marketplace plan␊ - */␊ - plan?: (ArmPlan1 | string)␊ - /**␊ - * API Management␊ - */␊ - properties?: (ApiEntity | string)␊ - /**␊ - * Describes a sku for a scalable resource␊ - */␊ - sku?: (SkuDescription2 | string)␊ - /**␊ - * Tags associated with resource␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Type of resource e.g Microsoft.Web/sites␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The plan object in an ARM, represents a marketplace plan␊ - */␊ - export interface ArmPlan1 {␊ - /**␊ - * The name␊ - */␊ - name?: string␊ - /**␊ - * The product␊ - */␊ - product?: string␊ - /**␊ - * The promotion code␊ - */␊ - promotionCode?: string␊ - /**␊ - * The publisher␊ - */␊ - publisher?: string␊ - /**␊ - * Version of product␊ - */␊ - version?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * API Management␊ - */␊ - export interface ApiEntity {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - /**␊ - * Resource Name␊ - */␊ - name?: string␊ - properties?: (ApiEntityProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Resource type␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - export interface ApiEntityProperties {␊ - /**␊ - * API definition Url - url where the swagger can be downloaded from␊ - */␊ - apiDefinitionUrl?: string␊ - /**␊ - * API definitions with backend urls␊ - */␊ - backendService?: (BackendServiceDefinition | string)␊ - /**␊ - * Capabilities␊ - */␊ - capabilities?: (string[] | string)␊ - /**␊ - * Timestamp of last connection change.␊ - */␊ - changedTime?: string␊ - /**␊ - * Connection parameters␊ - */␊ - connectionParameters?: ({␊ - [k: string]: ConnectionParameter␊ - } | string)␊ - /**␊ - * Timestamp of the connection creation␊ - */␊ - createdTime?: string␊ - /**␊ - * General API information␊ - */␊ - generalInformation?: (GeneralApiInformation | string)␊ - metadata?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Name of the API␍␊ - * the URL path of this API when exposed via APIM␊ - */␊ - name?: string␊ - /**␊ - * the URL path of this API when exposed via APIM␊ - */␊ - path?: string␊ - /**␊ - * API policies␊ - */␊ - policies?: (ApiPolicies | string)␊ - /**␊ - * Protocols supported by the front end - http/https␊ - */␊ - protocols?: (string[] | string)␊ - /**␊ - * Read only property returning the runtime endpoints where the API can be called␊ - */␊ - runtimeUrls?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * API definitions with backend urls␊ - */␊ - export interface BackendServiceDefinition {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - /**␊ - * Resource Name␊ - */␊ - name?: string␊ - properties?: (BackendServiceDefinitionProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Resource type␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - export interface BackendServiceDefinitionProperties {␊ - /**␊ - * Service Urls per Hosting environment␊ - */␊ - hostingEnvironmentServiceUrls?: (HostingEnvironmentServiceDescriptions[] | string)␊ - /**␊ - * Url from which the swagger payload will be fetched␊ - */␊ - serviceUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Back end service per ASE␊ - */␊ - export interface HostingEnvironmentServiceDescriptions {␊ - /**␊ - * Host Id␊ - */␊ - hostId?: string␊ - /**␊ - * Hosting environment Id␊ - */␊ - hostingEnvironmentId?: string␊ - /**␊ - * service url to use␊ - */␊ - serviceUrl?: string␊ - /**␊ - * When the backend url is in same ASE, for performance reason this flag can be set to true␍␊ - * If WebApp.DisableHostNames is also set it improves the security by making the back end accessible only ␍␊ - * via API calls␍␊ - * Note: calls will fail if this option is used but back end is not on the same ASE␊ - */␊ - useInternalRouting?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * connection provider parameters␊ - */␊ - export interface ConnectionParameter {␊ - defaultValue?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * OAuth settings for the connection provider␊ - */␊ - oAuthSettings?: (ApiOAuthSettings | string)␊ - /**␊ - * Type of the parameter.␊ - */␊ - type?: (("string" | "securestring" | "secureobject" | "int" | "bool" | "object" | "array" | "oauthSetting" | "connection") | string)␊ - uiDefinition?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * OAuth settings for the connection provider␊ - */␊ - export interface ApiOAuthSettings {␊ - /**␊ - * Resource provider client id␊ - */␊ - clientId?: string␊ - /**␊ - * Client Secret needed for OAuth␊ - */␊ - clientSecret?: string␊ - /**␊ - * OAuth parameters key is the name of parameter␊ - */␊ - customParameters?: ({␊ - [k: string]: ApiOAuthSettingsParameter␊ - } | string)␊ - /**␊ - * Identity provider␊ - */␊ - identityProvider?: string␊ - properties?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Url␊ - */␊ - redirectUrl?: string␊ - /**␊ - * OAuth scopes␊ - */␊ - scopes?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * OAuth Settings Parameter␊ - */␊ - export interface ApiOAuthSettingsParameter {␊ - options?: {␊ - [k: string]: unknown␊ - }␊ - uiDefinition?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Value␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * General API information␊ - */␊ - export interface GeneralApiInformation {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - /**␊ - * Resource Name␊ - */␊ - name?: string␊ - properties?: (GeneralApiInformationProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Resource type␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - export interface GeneralApiInformationProperties {␊ - /**␊ - * DefaultConnectionNameTemplate␊ - */␊ - connectionDisplayName?: string␊ - connectionPortalUrl?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description␊ - */␊ - description?: string␊ - /**␊ - * Display Name␊ - */␊ - displayName?: string␊ - /**␊ - * Icon Url␊ - */␊ - iconUrl?: string␊ - /**␊ - * a public accessible url of the Terms Of Use Url of this API␊ - */␊ - termsOfUseUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * API policies␊ - */␊ - export interface ApiPolicies {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - /**␊ - * Resource Name␊ - */␊ - name?: string␊ - properties?: (ApiPoliciesProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Resource type␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - export interface ApiPoliciesProperties {␊ - /**␊ - * Content of xml policy␊ - */␊ - content?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes a sku for a scalable resource␊ - */␊ - export interface SkuDescription2 {␊ - /**␊ - * Current number of instances assigned to the resource␊ - */␊ - capacity?: (number | string)␊ - /**␊ - * Family code of the resource sku␊ - */␊ - family?: string␊ - /**␊ - * Name of the resource sku␊ - */␊ - name?: string␊ - /**␊ - * Size specifier of the resource sku␊ - */␊ - size?: string␊ - /**␊ - * Service Tier of the resource sku␊ - */␊ - tier?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Custom logging setting values␊ - */␊ - export interface ParameterCustomLoginSettingValues {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - /**␊ - * Resource Name␊ - */␊ - name?: string␊ - properties?: (ParameterCustomLoginSettingValuesProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Resource type␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - export interface ParameterCustomLoginSettingValuesProperties {␊ - /**␊ - * Custom parameters.␊ - */␊ - customParameters?: ({␊ - [k: string]: CustomLoginSettingValue␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Custom logging setting value␊ - */␊ - export interface CustomLoginSettingValue {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - /**␊ - * Resource Name␊ - */␊ - name?: string␊ - properties?: (CustomLoginSettingValueProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Resource type␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - export interface CustomLoginSettingValueProperties {␊ - /**␊ - * Option selected for this custom login setting value␊ - */␊ - option?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Connection status␊ - */␊ - export interface ConnectionStatus {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - /**␊ - * Resource Name␊ - */␊ - name?: string␊ - properties?: (ConnectionStatusProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Resource type␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - export interface ConnectionStatusProperties {␊ - /**␊ - * Connection error␊ - */␊ - error?: (ConnectionError | string)␊ - /**␊ - * Status␊ - */␊ - status?: string␊ - /**␊ - * Target of the error␊ - */␊ - target?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Connection error␊ - */␊ - export interface ConnectionError {␊ - /**␊ - * Resource Id␊ - */␊ - id?: string␊ - /**␊ - * Kind of resource␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location␊ - */␊ - location: string␊ - /**␊ - * Resource Name␊ - */␊ - name?: string␊ - properties?: (ConnectionErrorProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Resource type␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - export interface ConnectionErrorProperties {␊ - /**␊ - * code of the status␊ - */␊ - code?: string␊ - /**␊ - * Description of the status␊ - */␊ - message?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/certificates␊ - */␊ - export interface Certificates1 {␊ - apiVersion: "2016-03-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the certificate.␊ - */␊ - name: string␊ - /**␊ - * Certificate resource specific properties␊ - */␊ - properties: (CertificateProperties1 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/certificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Certificate resource specific properties␊ - */␊ - export interface CertificateProperties1 {␊ - /**␊ - * Host names the certificate applies to.␊ - */␊ - hostNames?: (string[] | string)␊ - /**␊ - * Key Vault Csm resource Id.␊ - */␊ - keyVaultId?: string␊ - /**␊ - * Key Vault secret name.␊ - */␊ - keyVaultSecretName?: string␊ - /**␊ - * Certificate password.␊ - */␊ - password: string␊ - /**␊ - * Pfx blob.␊ - */␊ - pfxBlob?: string␊ - /**␊ - * Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".␊ - */␊ - serverFarmId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/connectionGateways␊ - */␊ - export interface ConnectionGateways {␊ - apiVersion: "2016-06-01"␊ - /**␊ - * Resource ETag␊ - */␊ - etag?: string␊ - /**␊ - * Resource location␊ - */␊ - location?: string␊ - /**␊ - * The connection gateway name␊ - */␊ - name: string␊ - properties: (ConnectionGatewayDefinitionProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/connectionGateways"␊ - [k: string]: unknown␊ - }␊ - export interface ConnectionGatewayDefinitionProperties {␊ - /**␊ - * The URI of the backend␊ - */␊ - backendUri?: string␊ - /**␊ - * The gateway installation reference␊ - */␊ - connectionGatewayInstallation?: (ConnectionGatewayReference | string)␊ - /**␊ - * The gateway admin␊ - */␊ - contactInformation?: (string[] | string)␊ - /**␊ - * The gateway description␊ - */␊ - description?: string␊ - /**␊ - * The gateway display name␊ - */␊ - displayName?: string␊ - /**␊ - * The machine name of the gateway␊ - */␊ - machineName?: string␊ - /**␊ - * The gateway status␊ - */␊ - status?: {␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The gateway installation reference␊ - */␊ - export interface ConnectionGatewayReference {␊ - /**␊ - * Resource reference id␊ - */␊ - id?: string␊ - /**␊ - * Resource reference location␊ - */␊ - location?: string␊ - /**␊ - * Resource reference name␊ - */␊ - name?: string␊ - /**␊ - * Resource reference type␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/connections␊ - */␊ - export interface Connections29 {␊ - apiVersion: "2016-06-01"␊ - /**␊ - * Resource ETag␊ - */␊ - etag?: string␊ - /**␊ - * Resource location␊ - */␊ - location?: string␊ - /**␊ - * Connection name␊ - */␊ - name: string␊ - properties: (ApiConnectionDefinitionProperties | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/connections"␊ - [k: string]: unknown␊ - }␊ - export interface ApiConnectionDefinitionProperties {␊ - api?: (ApiReference | string)␊ - /**␊ - * Timestamp of last connection change␊ - */␊ - changedTime?: string␊ - /**␊ - * Timestamp of the connection creation␊ - */␊ - createdTime?: string␊ - /**␊ - * Dictionary of custom parameter values␊ - */␊ - customParameterValues?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Display name␊ - */␊ - displayName?: string␊ - /**␊ - * Dictionary of nonsecret parameter values␊ - */␊ - nonSecretParameterValues?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Dictionary of parameter values␊ - */␊ - parameterValues?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Status of the connection␊ - */␊ - statuses?: (ConnectionStatusDefinition[] | string)␊ - /**␊ - * Links to test the API connection␊ - */␊ - testLinks?: (ApiConnectionTestLink[] | string)␊ - [k: string]: unknown␊ - }␊ - export interface ApiReference {␊ - /**␊ - * Brand color␊ - */␊ - brandColor?: string␊ - /**␊ - * The custom API description␊ - */␊ - description?: string␊ - /**␊ - * The display name␊ - */␊ - displayName?: string␊ - /**␊ - * The icon URI␊ - */␊ - iconUri?: string␊ - /**␊ - * Resource reference id␊ - */␊ - id?: string␊ - /**␊ - * The name of the API␊ - */␊ - name?: string␊ - /**␊ - * The JSON representation of the swagger␊ - */␊ - swagger?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Resource reference type␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Connection status␊ - */␊ - export interface ConnectionStatusDefinition {␊ - /**␊ - * Connection error␊ - */␊ - error?: (ConnectionError1 | string)␊ - /**␊ - * The gateway status␊ - */␊ - status?: string␊ - /**␊ - * Target of the error␊ - */␊ - target?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Connection error␊ - */␊ - export interface ConnectionError1 {␊ - /**␊ - * Resource ETag␊ - */␊ - etag?: string␊ - /**␊ - * Resource location␊ - */␊ - location?: string␊ - properties?: (ConnectionErrorProperties1 | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - export interface ConnectionErrorProperties1 {␊ - /**␊ - * Code of the status␊ - */␊ - code?: string␊ - /**␊ - * Description of the status␊ - */␊ - message?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * API connection properties␊ - */␊ - export interface ApiConnectionTestLink {␊ - /**␊ - * HTTP Method␊ - */␊ - method?: string␊ - /**␊ - * Test link request URI␊ - */␊ - requestUri?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/customApis␊ - */␊ - export interface CustomApis {␊ - apiVersion: "2016-06-01"␊ - /**␊ - * Resource ETag␊ - */␊ - etag?: string␊ - /**␊ - * Resource location␊ - */␊ - location?: string␊ - /**␊ - * API name␊ - */␊ - name: string␊ - /**␊ - * Custom API properties␊ - */␊ - properties: (CustomApiPropertiesDefinition | string)␊ - /**␊ - * Resource tags␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/customApis"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Custom API properties␊ - */␊ - export interface CustomApiPropertiesDefinition {␊ - /**␊ - * API Definitions␊ - */␊ - apiDefinitions?: (ApiResourceDefinitions | string)␊ - apiType?: (("NotSpecified" | "Rest" | "Soap") | string)␊ - /**␊ - * The API backend service␊ - */␊ - backendService?: (ApiResourceBackendService | string)␊ - /**␊ - * Brand color␊ - */␊ - brandColor?: string␊ - /**␊ - * The custom API capabilities␊ - */␊ - capabilities?: (string[] | string)␊ - /**␊ - * Connection parameters␊ - */␊ - connectionParameters?: ({␊ - [k: string]: ConnectionParameter1␊ - } | string)␊ - /**␊ - * The custom API description␊ - */␊ - description?: string␊ - /**␊ - * The display name␊ - */␊ - displayName?: string␊ - /**␊ - * The icon URI␊ - */␊ - iconUri?: string␊ - /**␊ - * Runtime URLs␊ - */␊ - runtimeUrls?: (string[] | string)␊ - /**␊ - * The JSON representation of the swagger␊ - */␊ - swagger?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The WSDL definition␊ - */␊ - wsdlDefinition?: (WsdlDefinition | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * API Definitions␊ - */␊ - export interface ApiResourceDefinitions {␊ - /**␊ - * The modified swagger URL␊ - */␊ - modifiedSwaggerUrl?: string␊ - /**␊ - * The original swagger URL␊ - */␊ - originalSwaggerUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The API backend service␊ - */␊ - export interface ApiResourceBackendService {␊ - /**␊ - * The service URL␊ - */␊ - serviceUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Connection provider parameters␊ - */␊ - export interface ConnectionParameter1 {␊ - /**␊ - * OAuth settings for the connection provider␊ - */␊ - oAuthSettings?: (ApiOAuthSettings1 | string)␊ - /**␊ - * Type of the parameter.␊ - */␊ - type?: (("string" | "securestring" | "secureobject" | "int" | "bool" | "object" | "array" | "oauthSetting" | "connection") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * OAuth settings for the connection provider␊ - */␊ - export interface ApiOAuthSettings1 {␊ - /**␊ - * Resource provider client id␊ - */␊ - clientId?: string␊ - /**␊ - * Client Secret needed for OAuth␊ - */␊ - clientSecret?: string␊ - /**␊ - * OAuth parameters key is the name of parameter␊ - */␊ - customParameters?: ({␊ - [k: string]: ApiOAuthSettingsParameter1␊ - } | string)␊ - /**␊ - * Identity provider␊ - */␊ - identityProvider?: string␊ - /**␊ - * Read only properties for this oauth setting.␊ - */␊ - properties?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Url␊ - */␊ - redirectUrl?: string␊ - /**␊ - * OAuth scopes␊ - */␊ - scopes?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * OAuth settings for the API␊ - */␊ - export interface ApiOAuthSettingsParameter1 {␊ - /**␊ - * Options available to this parameter␊ - */␊ - options?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * UI definitions per culture as caller can specify the culture␊ - */␊ - uiDefinition?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Value of the setting␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The WSDL definition␊ - */␊ - export interface WsdlDefinition {␊ - /**␊ - * The WSDL content␊ - */␊ - content?: string␊ - importMethod?: (("NotSpecified" | "SoapToRest" | "SoapPassThrough") | string)␊ - /**␊ - * The service with name and endpoint names␊ - */␊ - service?: (WsdlService | string)␊ - /**␊ - * The WSDL URL␊ - */␊ - url?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The service with name and endpoint names␊ - */␊ - export interface WsdlService {␊ - /**␊ - * List of the endpoints' qualified names␊ - */␊ - endpointQualifiedNames?: (string[] | string)␊ - /**␊ - * The service's qualified name␊ - */␊ - qualifiedName: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites␊ - */␊ - export interface Sites1 {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Managed service identity.␊ - */␊ - identity?: (ManagedServiceIdentity14 | string)␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Unique name of the app to create or update. To create or update a deployment slot, use the {slot} parameter.␊ - */␊ - name: string␊ - /**␊ - * Site resource specific properties␊ - */␊ - properties: (SiteProperties1 | string)␊ - resources?: (SitesBackupsChildResource1 | SitesConfigChildResource1 | SitesDeploymentsChildResource1 | SitesDomainOwnershipIdentifiersChildResource | SitesExtensionsChildResource | SitesFunctionsChildResource | SitesHostNameBindingsChildResource1 | SitesHybridconnectionChildResource1 | SitesMigrateChildResource | SitesPremieraddonsChildResource1 | SitesPublicCertificatesChildResource | SitesSiteextensionsChildResource | SitesSlotsChildResource1 | SitesSourcecontrolsChildResource1 | SitesVirtualNetworkConnectionsChildResource1)[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/sites"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Managed service identity.␊ - */␊ - export interface ManagedServiceIdentity14 {␊ - /**␊ - * Type of managed service identity.␊ - */␊ - type?: ("SystemAssigned" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Site resource specific properties␊ - */␊ - export interface SiteProperties1 {␊ - /**␊ - * 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.␊ - */␊ - clientAffinityEnabled?: (boolean | string)␊ - /**␊ - * true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.␊ - */␊ - clientCertEnabled?: (boolean | string)␊ - /**␊ - * Information needed for cloning operation.␊ - */␊ - cloningInfo?: (CloningInfo1 | string)␊ - /**␊ - * Size of the function container.␊ - */␊ - containerSize?: (number | string)␊ - /**␊ - * Maximum allowed daily memory-time quota (applicable on dynamic apps only).␊ - */␊ - dailyMemoryTimeQuota?: (number | string)␊ - /**␊ - * true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Specification for an App Service Environment to use for this resource.␊ - */␊ - hostingEnvironmentProfile?: (HostingEnvironmentProfile1 | string)␊ - /**␊ - * true to disable the public hostnames of the app; otherwise, false.␊ - * If true, the app is only accessible via API management process.␊ - */␊ - hostNamesDisabled?: (boolean | string)␊ - /**␊ - * Hostname SSL states are used to manage the SSL bindings for app's hostnames.␊ - */␊ - hostNameSslStates?: (HostNameSslState1[] | string)␊ - /**␊ - * HttpsOnly: configures a web site to accept only https requests. Issues redirect for␊ - * http requests␊ - */␊ - httpsOnly?: (boolean | string)␊ - /**␊ - * true if reserved; otherwise, false.␊ - */␊ - reserved?: (boolean | string)␊ - /**␊ - * true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.␊ - */␊ - scmSiteAlsoStopped?: (boolean | string)␊ - /**␊ - * Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".␊ - */␊ - serverFarmId?: string␊ - /**␊ - * Configuration of an App Service app.␊ - */␊ - siteConfig?: (SiteConfig1 | string)␊ - /**␊ - * Details about app recovery operation.␊ - */␊ - snapshotInfo?: (SnapshotRecoveryRequest | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information needed for cloning operation.␊ - */␊ - export interface CloningInfo1 {␊ - /**␊ - * 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.␊ - */␊ - appSettingsOverrides?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * true to clone custom hostnames from source app; otherwise, false.␊ - */␊ - cloneCustomHostNames?: (boolean | string)␊ - /**␊ - * true to clone source control from source app; otherwise, false.␊ - */␊ - cloneSourceControl?: (boolean | string)␊ - /**␊ - * true to configure load balancing for source and destination app.␊ - */␊ - configureLoadBalancing?: (boolean | string)␊ - /**␊ - * Correlation ID of cloning operation. This ID ties multiple cloning operations␊ - * together to use the same snapshot.␊ - */␊ - correlationId?: string␊ - /**␊ - * App Service Environment.␊ - */␊ - hostingEnvironment?: string␊ - /**␊ - * true if quotas should be ignored; otherwise, false.␊ - */␊ - ignoreQuotas?: (boolean | string)␊ - /**␊ - * true to overwrite destination app; otherwise, false.␊ - */␊ - overwrite?: (boolean | string)␊ - /**␊ - * 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.␊ - */␊ - sourceWebAppId: string␊ - /**␊ - * 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}.␊ - */␊ - trafficManagerProfileId?: string␊ - /**␊ - * Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist.␊ - */␊ - trafficManagerProfileName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specification for an App Service Environment to use for this resource.␊ - */␊ - export interface HostingEnvironmentProfile1 {␊ - /**␊ - * Resource ID of the App Service Environment.␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSL-enabled hostname.␊ - */␊ - export interface HostNameSslState1 {␊ - /**␊ - * Indicates whether the hostname is a standard or repository hostname.␊ - */␊ - hostType?: (("Standard" | "Repository") | string)␊ - /**␊ - * Hostname.␊ - */␊ - name?: string␊ - /**␊ - * SSL type.␊ - */␊ - sslState?: (("Disabled" | "SniEnabled" | "IpBasedEnabled") | string)␊ - /**␊ - * SSL certificate thumbprint.␊ - */␊ - thumbprint?: string␊ - /**␊ - * Set to true to update existing hostname.␊ - */␊ - toUpdate?: (boolean | string)␊ - /**␊ - * Virtual IP address assigned to the hostname if IP based SSL is enabled.␊ - */␊ - virtualIP?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Configuration of an App Service app.␊ - */␊ - export interface SiteConfig1 {␊ - /**␊ - * true if Always On is enabled; otherwise, false.␊ - */␊ - alwaysOn?: (boolean | string)␊ - /**␊ - * Information about the formal API definition for the app.␊ - */␊ - apiDefinition?: (ApiDefinitionInfo1 | string)␊ - /**␊ - * App command line to launch.␊ - */␊ - appCommandLine?: string␊ - /**␊ - * Application settings.␊ - */␊ - appSettings?: (NameValuePair1[] | string)␊ - /**␊ - * true if Auto Heal is enabled; otherwise, false.␊ - */␊ - autoHealEnabled?: (boolean | string)␊ - /**␊ - * Rules that can be defined for auto-heal.␊ - */␊ - autoHealRules?: (AutoHealRules1 | string)␊ - /**␊ - * Auto-swap slot name.␊ - */␊ - autoSwapSlotName?: string␊ - /**␊ - * Connection strings.␊ - */␊ - connectionStrings?: (ConnStringInfo1[] | string)␊ - /**␊ - * Cross-Origin Resource Sharing (CORS) settings for the app.␊ - */␊ - cors?: (CorsSettings1 | string)␊ - /**␊ - * Default documents.␊ - */␊ - defaultDocuments?: (string[] | string)␊ - /**␊ - * true if detailed error logging is enabled; otherwise, false.␊ - */␊ - detailedErrorLoggingEnabled?: (boolean | string)␊ - /**␊ - * Document root.␊ - */␊ - documentRoot?: string␊ - /**␊ - * Routing rules in production experiments.␊ - */␊ - experiments?: (Experiments1 | string)␊ - /**␊ - * Handler mappings.␊ - */␊ - handlerMappings?: (HandlerMapping1[] | string)␊ - /**␊ - * Http20Enabled: configures a web site to allow clients to connect over http2.0␊ - */␊ - http20Enabled?: (boolean | string)␊ - /**␊ - * true if HTTP logging is enabled; otherwise, false.␊ - */␊ - httpLoggingEnabled?: (boolean | string)␊ - /**␊ - * IP security restrictions.␊ - */␊ - ipSecurityRestrictions?: (IpSecurityRestriction1[] | string)␊ - /**␊ - * Java container.␊ - */␊ - javaContainer?: string␊ - /**␊ - * Java container version.␊ - */␊ - javaContainerVersion?: string␊ - /**␊ - * Java version.␊ - */␊ - javaVersion?: string␊ - /**␊ - * Metric limits set on an app.␊ - */␊ - limits?: (SiteLimits1 | string)␊ - /**␊ - * Linux App Framework and version␊ - */␊ - linuxFxVersion?: string␊ - /**␊ - * Site load balancing.␊ - */␊ - loadBalancing?: (("WeightedRoundRobin" | "LeastRequests" | "LeastResponseTime" | "WeightedTotalTraffic" | "RequestHash") | string)␊ - /**␊ - * true to enable local MySQL; otherwise, false.␊ - */␊ - localMySqlEnabled?: (boolean | string)␊ - /**␊ - * HTTP logs directory size limit.␊ - */␊ - logsDirectorySizeLimit?: (number | string)␊ - /**␊ - * Managed pipeline mode.␊ - */␊ - managedPipelineMode?: (("Integrated" | "Classic") | string)␊ - /**␊ - * MinTlsVersion: configures the minimum version of TLS required for SSL requests.␊ - */␊ - minTlsVersion?: (("1.0" | "1.1" | "1.2") | string)␊ - /**␊ - * .NET Framework version.␊ - */␊ - netFrameworkVersion?: string␊ - /**␊ - * Version of Node.js.␊ - */␊ - nodeVersion?: string␊ - /**␊ - * Number of workers.␊ - */␊ - numberOfWorkers?: (number | string)␊ - /**␊ - * Version of PHP.␊ - */␊ - phpVersion?: string␊ - /**␊ - * Publishing user name.␊ - */␊ - publishingUsername?: string␊ - /**␊ - * Push settings for the App.␊ - */␊ - push?: (PushSettings | string)␊ - /**␊ - * Version of Python.␊ - */␊ - pythonVersion?: string␊ - /**␊ - * true if remote debugging is enabled; otherwise, false.␊ - */␊ - remoteDebuggingEnabled?: (boolean | string)␊ - /**␊ - * Remote debugging version.␊ - */␊ - remoteDebuggingVersion?: string␊ - /**␊ - * true if request tracing is enabled; otherwise, false.␊ - */␊ - requestTracingEnabled?: (boolean | string)␊ - /**␊ - * Request tracing expiration time.␊ - */␊ - requestTracingExpirationTime?: string␊ - /**␊ - * SCM type.␊ - */␊ - scmType?: (("None" | "Dropbox" | "Tfs" | "LocalGit" | "GitHub" | "CodePlexGit" | "CodePlexHg" | "BitbucketGit" | "BitbucketHg" | "ExternalGit" | "ExternalHg" | "OneDrive" | "VSO") | string)␊ - /**␊ - * Tracing options.␊ - */␊ - tracingOptions?: string␊ - /**␊ - * true to use 32-bit worker process; otherwise, false.␊ - */␊ - use32BitWorkerProcess?: (boolean | string)␊ - /**␊ - * Virtual applications.␊ - */␊ - virtualApplications?: (VirtualApplication1[] | string)␊ - /**␊ - * Virtual Network name.␊ - */␊ - vnetName?: string␊ - /**␊ - * true if WebSocket is enabled; otherwise, false.␊ - */␊ - webSocketsEnabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the formal API definition for the app.␊ - */␊ - export interface ApiDefinitionInfo1 {␊ - /**␊ - * The URL of the API definition.␊ - */␊ - url?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Name value pair.␊ - */␊ - export interface NameValuePair1 {␊ - /**␊ - * Pair name.␊ - */␊ - name?: string␊ - /**␊ - * Pair value.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Rules that can be defined for auto-heal.␊ - */␊ - export interface AutoHealRules1 {␊ - /**␊ - * Actions which to take by the auto-heal module when a rule is triggered.␊ - */␊ - actions?: (AutoHealActions1 | string)␊ - /**␊ - * Triggers for auto-heal.␊ - */␊ - triggers?: (AutoHealTriggers1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Actions which to take by the auto-heal module when a rule is triggered.␊ - */␊ - export interface AutoHealActions1 {␊ - /**␊ - * Predefined action to be taken.␊ - */␊ - actionType?: (("Recycle" | "LogEvent" | "CustomAction") | string)␊ - /**␊ - * Custom action to be executed␊ - * when an auto heal rule is triggered.␊ - */␊ - customAction?: (AutoHealCustomAction1 | string)␊ - /**␊ - * Minimum time the process must execute␊ - * before taking the action␊ - */␊ - minProcessExecutionTime?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Custom action to be executed␊ - * when an auto heal rule is triggered.␊ - */␊ - export interface AutoHealCustomAction1 {␊ - /**␊ - * Executable to be run.␊ - */␊ - exe?: string␊ - /**␊ - * Parameters for the executable.␊ - */␊ - parameters?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Triggers for auto-heal.␊ - */␊ - export interface AutoHealTriggers1 {␊ - /**␊ - * A rule based on private bytes.␊ - */␊ - privateBytesInKB?: (number | string)␊ - /**␊ - * Trigger based on total requests.␊ - */␊ - requests?: (RequestsBasedTrigger1 | string)␊ - /**␊ - * Trigger based on request execution time.␊ - */␊ - slowRequests?: (SlowRequestsBasedTrigger1 | string)␊ - /**␊ - * A rule based on status codes.␊ - */␊ - statusCodes?: (StatusCodesBasedTrigger1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trigger based on total requests.␊ - */␊ - export interface RequestsBasedTrigger1 {␊ - /**␊ - * Request Count.␊ - */␊ - count?: (number | string)␊ - /**␊ - * Time interval.␊ - */␊ - timeInterval?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trigger based on request execution time.␊ - */␊ - export interface SlowRequestsBasedTrigger1 {␊ - /**␊ - * Request Count.␊ - */␊ - count?: (number | string)␊ - /**␊ - * Time interval.␊ - */␊ - timeInterval?: string␊ - /**␊ - * Time taken.␊ - */␊ - timeTaken?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trigger based on status code.␊ - */␊ - export interface StatusCodesBasedTrigger1 {␊ - /**␊ - * Request Count.␊ - */␊ - count?: (number | string)␊ - /**␊ - * HTTP status code.␊ - */␊ - status?: (number | string)␊ - /**␊ - * Request Sub Status.␊ - */␊ - subStatus?: (number | string)␊ - /**␊ - * Time interval.␊ - */␊ - timeInterval?: string␊ - /**␊ - * Win32 error code.␊ - */␊ - win32Status?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Database connection string information.␊ - */␊ - export interface ConnStringInfo1 {␊ - /**␊ - * Connection string value.␊ - */␊ - connectionString?: string␊ - /**␊ - * Name of connection string.␊ - */␊ - name?: string␊ - /**␊ - * Type of database.␊ - */␊ - type?: (("MySql" | "SQLServer" | "SQLAzure" | "Custom" | "NotificationHub" | "ServiceBus" | "EventHub" | "ApiHub" | "DocDb" | "RedisCache" | "PostgreSQL") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Cross-Origin Resource Sharing (CORS) settings for the app.␊ - */␊ - export interface CorsSettings1 {␊ - /**␊ - * 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.␊ - */␊ - allowedOrigins?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Routing rules in production experiments.␊ - */␊ - export interface Experiments1 {␊ - /**␊ - * List of ramp-up rules.␊ - */␊ - rampUpRules?: (RampUpRule1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance.␊ - */␊ - export interface RampUpRule1 {␊ - /**␊ - * Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.␊ - */␊ - actionHostName?: string␊ - /**␊ - * 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/␊ - */␊ - changeDecisionCallbackUrl?: string␊ - /**␊ - * Specifies interval in minutes to reevaluate ReroutePercentage.␊ - */␊ - changeIntervalInMinutes?: (number | string)␊ - /**␊ - * In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches ␊ - * MinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.␊ - * Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl.␊ - */␊ - changeStep?: (number | string)␊ - /**␊ - * Specifies upper boundary below which ReroutePercentage will stay.␊ - */␊ - maxReroutePercentage?: (number | string)␊ - /**␊ - * Specifies lower boundary above which ReroutePercentage will stay.␊ - */␊ - minReroutePercentage?: (number | string)␊ - /**␊ - * Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment.␊ - */␊ - name?: string␊ - /**␊ - * Percentage of the traffic which will be redirected to ActionHostName.␊ - */␊ - reroutePercentage?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * 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.␊ - */␊ - export interface HandlerMapping1 {␊ - /**␊ - * Command-line arguments to be passed to the script processor.␊ - */␊ - arguments?: string␊ - /**␊ - * Requests with this extension will be handled using the specified FastCGI application.␊ - */␊ - extension?: string␊ - /**␊ - * The absolute path to the FastCGI application.␊ - */␊ - scriptProcessor?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP security restriction on an app.␊ - */␊ - export interface IpSecurityRestriction1 {␊ - /**␊ - * IP address the security restriction is valid for.␊ - */␊ - ipAddress: string␊ - /**␊ - * Subnet mask for the range of IP addresses the restriction is valid for.␊ - */␊ - subnetMask?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Metric limits set on an app.␊ - */␊ - export interface SiteLimits1 {␊ - /**␊ - * Maximum allowed disk size usage in MB.␊ - */␊ - maxDiskSizeInMb?: (number | string)␊ - /**␊ - * Maximum allowed memory usage in MB.␊ - */␊ - maxMemoryInMb?: (number | string)␊ - /**␊ - * Maximum allowed CPU usage percentage.␊ - */␊ - maxPercentageCpu?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Push settings for the App.␊ - */␊ - export interface PushSettings {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * PushSettings resource specific properties␊ - */␊ - properties?: (PushSettingsProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * PushSettings resource specific properties␊ - */␊ - export interface PushSettingsProperties {␊ - /**␊ - * Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint.␊ - */␊ - dynamicTagsJson?: string␊ - /**␊ - * Gets or sets a flag indicating whether the Push endpoint is enabled.␊ - */␊ - isPushEnabled: (boolean | string)␊ - /**␊ - * 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.␊ - */␊ - tagsRequiringAuth?: string␊ - /**␊ - * Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.␊ - */␊ - tagWhitelistJson?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Virtual application in an app.␊ - */␊ - export interface VirtualApplication1 {␊ - /**␊ - * Physical path.␊ - */␊ - physicalPath?: string␊ - /**␊ - * true if preloading is enabled; otherwise, false.␊ - */␊ - preloadEnabled?: (boolean | string)␊ - /**␊ - * Virtual directories for virtual application.␊ - */␊ - virtualDirectories?: (VirtualDirectory1[] | string)␊ - /**␊ - * Virtual path.␊ - */␊ - virtualPath?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Directory for virtual application.␊ - */␊ - export interface VirtualDirectory1 {␊ - /**␊ - * Physical path.␊ - */␊ - physicalPath?: string␊ - /**␊ - * Path to virtual application.␊ - */␊ - virtualPath?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Details about app recovery operation.␊ - */␊ - export interface SnapshotRecoveryRequest {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * SnapshotRecoveryRequest resource specific properties␊ - */␊ - properties?: (SnapshotRecoveryRequestProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SnapshotRecoveryRequest resource specific properties␊ - */␊ - export interface SnapshotRecoveryRequestProperties {␊ - /**␊ - * If true, custom hostname conflicts will be ignored when recovering to a target web app.␊ - * This setting is only necessary when RecoverConfiguration is enabled.␊ - */␊ - ignoreConflictingHostNames?: (boolean | string)␊ - /**␊ - * If true the recovery operation can overwrite source app; otherwise, false.␊ - */␊ - overwrite: (boolean | string)␊ - /**␊ - * If true, site configuration, in addition to content, will be reverted.␊ - */␊ - recoverConfiguration?: (boolean | string)␊ - /**␊ - * Specifies the web app that snapshot contents will be written to.␊ - */␊ - recoveryTarget?: (SnapshotRecoveryTarget | string)␊ - /**␊ - * Point in time in which the app recovery should be attempted, formatted as a DateTime string.␊ - */␊ - snapshotTime?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specifies the web app that snapshot contents will be written to.␊ - */␊ - export interface SnapshotRecoveryTarget {␊ - /**␊ - * 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.␊ - */␊ - id?: string␊ - /**␊ - * Geographical location of the target web app, e.g. SouthEastAsia, SouthCentralUS␊ - */␊ - location?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/backups␊ - */␊ - export interface SitesBackupsChildResource1 {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "discover"␊ - /**␊ - * RestoreRequest resource specific properties␊ - */␊ - properties: (RestoreRequestProperties1 | string)␊ - type: "backups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * RestoreRequest resource specific properties␊ - */␊ - export interface RestoreRequestProperties1 {␊ - /**␊ - * true if SiteConfig.ConnectionStrings should be set in new app; otherwise, false.␊ - */␊ - adjustConnectionStrings?: (boolean | string)␊ - /**␊ - * Specify app service plan that will own restored site.␊ - */␊ - appServicePlan?: string␊ - /**␊ - * Name of a blob which contains the backup.␊ - */␊ - blobName?: string␊ - /**␊ - * Collection of databases which should be restored. This list has to match the list of databases included in the backup.␊ - */␊ - databases?: (DatabaseBackupSetting1[] | string)␊ - /**␊ - * App Service Environment name, if needed (only when restoring an app to an App Service Environment).␊ - */␊ - hostingEnvironment?: string␊ - /**␊ - * 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.␊ - */␊ - ignoreConflictingHostNames?: (boolean | string)␊ - /**␊ - * Ignore the databases and only restore the site content␊ - */␊ - ignoreDatabases?: (boolean | string)␊ - /**␊ - * Operation type.␊ - */␊ - operationType?: (("Default" | "Clone" | "Relocation" | "Snapshot") | string)␊ - /**␊ - * true if the restore operation can overwrite target app; otherwise, false. true is needed if trying to restore over an existing app.␊ - */␊ - overwrite: (boolean | string)␊ - /**␊ - * Name of an app.␊ - */␊ - siteName?: string␊ - /**␊ - * SAS URL to the container.␊ - */␊ - storageAccountUrl: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Database backup settings.␊ - */␊ - export interface DatabaseBackupSetting1 {␊ - /**␊ - * 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.␊ - */␊ - connectionString?: string␊ - /**␊ - * Contains a connection string name that is linked to the SiteConfig.ConnectionStrings.␊ - * This is used during restore with overwrite connection strings options.␊ - */␊ - connectionStringName?: string␊ - /**␊ - * Database type (e.g. SqlAzure / MySql).␊ - */␊ - databaseType: (("SqlAzure" | "MySql" | "LocalMySql" | "PostgreSql") | string)␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SiteAuthSettings resource specific properties␊ - */␊ - export interface SiteAuthSettingsProperties {␊ - /**␊ - * Login parameters to send to the OpenID Connect authorization endpoint when␊ - * a user logs in. Each parameter must be in the form "key=value".␊ - */␊ - additionalLoginParams?: (string[] | string)␊ - /**␊ - * 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.␊ - */␊ - allowedAudiences?: (string[] | string)␊ - /**␊ - * 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.␊ - */␊ - allowedExternalRedirectUrls?: (string[] | string)␊ - /**␊ - * 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␊ - */␊ - clientId?: string␊ - /**␊ - * 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␊ - */␊ - clientSecret?: string␊ - /**␊ - * 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".␊ - */␊ - defaultProvider?: (("AzureActiveDirectory" | "Facebook" | "Google" | "MicrosoftAccount" | "Twitter") | string)␊ - /**␊ - * true if the Authentication / Authorization feature is enabled for the current app; otherwise, false.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * 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␊ - */␊ - facebookAppId?: string␊ - /**␊ - * 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␊ - */␊ - facebookAppSecret?: string␊ - /**␊ - * 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␊ - */␊ - facebookOAuthScopes?: (string[] | string)␊ - /**␊ - * 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/␊ - */␊ - googleClientId?: string␊ - /**␊ - * 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/␊ - */␊ - googleClientSecret?: string␊ - /**␊ - * 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/␊ - */␊ - googleOAuthScopes?: (string[] | string)␊ - /**␊ - * 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␊ - */␊ - issuer?: string␊ - /**␊ - * 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␊ - */␊ - microsoftAccountClientId?: string␊ - /**␊ - * 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␊ - */␊ - microsoftAccountClientSecret?: string␊ - /**␊ - * 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␊ - */␊ - microsoftAccountOAuthScopes?: (string[] | string)␊ - /**␊ - * 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.␊ - */␊ - runtimeVersion?: string␊ - /**␊ - * 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.␊ - */␊ - tokenRefreshExtensionHours?: (number | string)␊ - /**␊ - * true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.␊ - * The default is false.␊ - */␊ - tokenStoreEnabled?: (boolean | string)␊ - /**␊ - * 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␊ - */␊ - twitterConsumerKey?: string␊ - /**␊ - * 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␊ - */␊ - twitterConsumerSecret?: string␊ - /**␊ - * The action to take when an unauthenticated client attempts to access the app.␊ - */␊ - unauthenticatedClientAction?: (("RedirectToLoginPage" | "AllowAnonymous") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * BackupRequest resource specific properties␊ - */␊ - export interface BackupRequestProperties1 {␊ - /**␊ - * Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy.␊ - */␊ - backupSchedule?: (BackupSchedule1 | string)␊ - /**␊ - * Databases included in the backup.␊ - */␊ - databases?: (DatabaseBackupSetting1[] | string)␊ - /**␊ - * True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Name of the backup.␊ - */␊ - name: string␊ - /**␊ - * SAS URL to the container.␊ - */␊ - storageAccountUrl: string␊ - /**␊ - * Type of the backup.␊ - */␊ - type?: (("Default" | "Clone" | "Relocation" | "Snapshot") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy.␊ - */␊ - export interface BackupSchedule1 {␊ - /**␊ - * 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)␊ - */␊ - frequencyInterval: ((number & string) | string)␊ - /**␊ - * 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).␊ - */␊ - frequencyUnit: (("Day" | "Hour") | string)␊ - /**␊ - * True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise.␊ - */␊ - keepAtLeastOneBackup: (boolean | string)␊ - /**␊ - * After how many days backups should be deleted.␊ - */␊ - retentionPeriodInDays: ((number & string) | string)␊ - /**␊ - * When the schedule should start working.␊ - */␊ - startTime?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Database connection string value to type pair.␊ - */␊ - export interface ConnStringValueTypePair1 {␊ - /**␊ - * Type of database.␊ - */␊ - type: (("MySql" | "SQLServer" | "SQLAzure" | "Custom" | "NotificationHub" | "ServiceBus" | "EventHub" | "ApiHub" | "DocDb" | "RedisCache" | "PostgreSQL") | string)␊ - /**␊ - * Value of pair.␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SiteLogsConfig resource specific properties␊ - */␊ - export interface SiteLogsConfigProperties1 {␊ - /**␊ - * Application logs configuration.␊ - */␊ - applicationLogs?: (ApplicationLogsConfig1 | string)␊ - /**␊ - * Enabled configuration.␊ - */␊ - detailedErrorMessages?: (EnabledConfig1 | string)␊ - /**␊ - * Enabled configuration.␊ - */␊ - failedRequestsTracing?: (EnabledConfig1 | string)␊ - /**␊ - * Http logs configuration.␊ - */␊ - httpLogs?: (HttpLogsConfig1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application logs configuration.␊ - */␊ - export interface ApplicationLogsConfig1 {␊ - /**␊ - * Application logs azure blob storage configuration.␊ - */␊ - azureBlobStorage?: (AzureBlobStorageApplicationLogsConfig1 | string)␊ - /**␊ - * Application logs to Azure table storage configuration.␊ - */␊ - azureTableStorage?: (AzureTableStorageApplicationLogsConfig1 | string)␊ - /**␊ - * Application logs to file system configuration.␊ - */␊ - fileSystem?: (FileSystemApplicationLogsConfig1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application logs azure blob storage configuration.␊ - */␊ - export interface AzureBlobStorageApplicationLogsConfig1 {␊ - /**␊ - * Log level.␊ - */␊ - level?: (("Off" | "Verbose" | "Information" | "Warning" | "Error") | string)␊ - /**␊ - * Retention in days.␊ - * Remove blobs older than X days.␊ - * 0 or lower means no retention.␊ - */␊ - retentionInDays?: (number | string)␊ - /**␊ - * SAS url to a azure blob container with read/write/list/delete permissions.␊ - */␊ - sasUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application logs to Azure table storage configuration.␊ - */␊ - export interface AzureTableStorageApplicationLogsConfig1 {␊ - /**␊ - * Log level.␊ - */␊ - level?: (("Off" | "Verbose" | "Information" | "Warning" | "Error") | string)␊ - /**␊ - * SAS URL to an Azure table with add/query/delete permissions.␊ - */␊ - sasUrl: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application logs to file system configuration.␊ - */␊ - export interface FileSystemApplicationLogsConfig1 {␊ - /**␊ - * Log level.␊ - */␊ - level?: (("Off" | "Verbose" | "Information" | "Warning" | "Error") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Enabled configuration.␊ - */␊ - export interface EnabledConfig1 {␊ - /**␊ - * True if configuration is enabled, false if it is disabled and null if configuration is not set.␊ - */␊ - enabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http logs configuration.␊ - */␊ - export interface HttpLogsConfig1 {␊ - /**␊ - * Http logs to azure blob storage configuration.␊ - */␊ - azureBlobStorage?: (AzureBlobStorageHttpLogsConfig1 | string)␊ - /**␊ - * Http logs to file system configuration.␊ - */␊ - fileSystem?: (FileSystemHttpLogsConfig1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http logs to azure blob storage configuration.␊ - */␊ - export interface AzureBlobStorageHttpLogsConfig1 {␊ - /**␊ - * True if configuration is enabled, false if it is disabled and null if configuration is not set.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Retention in days.␊ - * Remove blobs older than X days.␊ - * 0 or lower means no retention.␊ - */␊ - retentionInDays?: (number | string)␊ - /**␊ - * SAS url to a azure blob container with read/write/list/delete permissions.␊ - */␊ - sasUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http logs to file system configuration.␊ - */␊ - export interface FileSystemHttpLogsConfig1 {␊ - /**␊ - * True if configuration is enabled, false if it is disabled and null if configuration is not set.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Retention in days.␊ - * Remove files older than X days.␊ - * 0 or lower means no retention.␊ - */␊ - retentionInDays?: (number | string)␊ - /**␊ - * 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.␊ - */␊ - retentionInMb?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * 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.␊ - */␊ - export interface SlotConfigNames {␊ - /**␊ - * List of application settings names.␊ - */␊ - appSettingNames?: (string[] | string)␊ - /**␊ - * List of connection string names.␊ - */␊ - connectionStringNames?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/deployments␊ - */␊ - export interface SitesDeploymentsChildResource1 {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * ID of an existing deployment.␊ - */␊ - name: string␊ - /**␊ - * Deployment resource specific properties␊ - */␊ - properties: (DeploymentProperties3 | string)␊ - type: "deployments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Deployment resource specific properties␊ - */␊ - export interface DeploymentProperties3 {␊ - /**␊ - * True if deployment is currently active, false if completed and null if not started.␊ - */␊ - active?: (boolean | string)␊ - /**␊ - * Who authored the deployment.␊ - */␊ - author?: string␊ - /**␊ - * Author email.␊ - */␊ - authorEmail?: string␊ - /**␊ - * Who performed the deployment.␊ - */␊ - deployer?: string␊ - /**␊ - * Details on deployment.␊ - */␊ - details?: string␊ - /**␊ - * End time.␊ - */␊ - endTime?: string␊ - /**␊ - * Identifier for deployment.␊ - */␊ - id?: string␊ - /**␊ - * Details about deployment status.␊ - */␊ - message?: string␊ - /**␊ - * Start time.␊ - */␊ - startTime?: string␊ - /**␊ - * Deployment status.␊ - */␊ - status?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/domainOwnershipIdentifiers␊ - */␊ - export interface SitesDomainOwnershipIdentifiersChildResource {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of domain ownership identifier.␊ - */␊ - name: string␊ - /**␊ - * Identifier resource specific properties␊ - */␊ - properties: (IdentifierProperties | string)␊ - type: "domainOwnershipIdentifiers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identifier resource specific properties␊ - */␊ - export interface IdentifierProperties {␊ - /**␊ - * String representation of the identity.␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/extensions␊ - */␊ - export interface SitesExtensionsChildResource {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "MSDeploy"␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - properties: (MSDeployCore | string)␊ - type: "extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - export interface MSDeployCore {␊ - /**␊ - * Sets the AppOffline rule while the MSDeploy operation executes.␊ - * Setting is false by default.␊ - */␊ - appOffline?: (boolean | string)␊ - /**␊ - * SQL Connection String␊ - */␊ - connectionString?: string␊ - /**␊ - * Database Type␊ - */␊ - dbType?: string␊ - /**␊ - * Package URI␊ - */␊ - packageUri?: string␊ - /**␊ - * MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used.␊ - */␊ - setParameters?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * URI of MSDeploy Parameters file. Must not be set if SetParameters is used.␊ - */␊ - setParametersXmlFileUri?: string␊ - /**␊ - * 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.␊ - */␊ - skipAppData?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/functions␊ - */␊ - export interface SitesFunctionsChildResource {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Function name.␊ - */␊ - name: string␊ - /**␊ - * FunctionEnvelope resource specific properties␊ - */␊ - properties: (FunctionEnvelopeProperties | string)␊ - type: "functions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * FunctionEnvelope resource specific properties␊ - */␊ - export interface FunctionEnvelopeProperties {␊ - /**␊ - * Config information.␊ - */␊ - config?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Config URI.␊ - */␊ - configHref?: string␊ - /**␊ - * File list.␊ - */␊ - files?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Function URI.␊ - */␊ - href?: string␊ - /**␊ - * Script URI.␊ - */␊ - scriptHref?: string␊ - /**␊ - * Script root path URI.␊ - */␊ - scriptRootPathHref?: string␊ - /**␊ - * Secrets file URI.␊ - */␊ - secretsFileHref?: string␊ - /**␊ - * Test data used when testing via the Azure Portal.␊ - */␊ - testData?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/hostNameBindings␊ - */␊ - export interface SitesHostNameBindingsChildResource1 {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Hostname in the hostname binding.␊ - */␊ - name: string␊ - /**␊ - * HostNameBinding resource specific properties␊ - */␊ - properties: (HostNameBindingProperties1 | string)␊ - type: "hostNameBindings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HostNameBinding resource specific properties␊ - */␊ - export interface HostNameBindingProperties1 {␊ - /**␊ - * Azure resource name.␊ - */␊ - azureResourceName?: string␊ - /**␊ - * Azure resource type.␊ - */␊ - azureResourceType?: (("Website" | "TrafficManager") | string)␊ - /**␊ - * Custom DNS record type.␊ - */␊ - customHostNameDnsRecordType?: (("CName" | "A") | string)␊ - /**␊ - * Fully qualified ARM domain resource URI.␊ - */␊ - domainId?: string␊ - /**␊ - * Hostname type.␊ - */␊ - hostNameType?: (("Verified" | "Managed") | string)␊ - /**␊ - * App Service app name.␊ - */␊ - siteName?: string␊ - /**␊ - * SSL type.␊ - */␊ - sslState?: (("Disabled" | "SniEnabled" | "IpBasedEnabled") | string)␊ - /**␊ - * SSL certificate thumbprint␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/hybridconnection␊ - */␊ - export interface SitesHybridconnectionChildResource1 {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the hybrid connection configuration.␊ - */␊ - name: string␊ - /**␊ - * RelayServiceConnectionEntity resource specific properties␊ - */␊ - properties: (RelayServiceConnectionEntityProperties1 | string)␊ - type: "hybridconnection"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * RelayServiceConnectionEntity resource specific properties␊ - */␊ - export interface RelayServiceConnectionEntityProperties1 {␊ - biztalkUri?: string␊ - entityConnectionString?: string␊ - entityName?: string␊ - hostname?: string␊ - port?: (number | string)␊ - resourceConnectionString?: string␊ - resourceType?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/migrate␊ - */␊ - export interface SitesMigrateChildResource {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "migrate"␊ - /**␊ - * StorageMigrationOptions resource specific properties␊ - */␊ - properties: (StorageMigrationOptionsProperties | string)␊ - type: "migrate"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * StorageMigrationOptions resource specific properties␊ - */␊ - export interface StorageMigrationOptionsProperties {␊ - /**␊ - * AzureFiles connection string.␊ - */␊ - azurefilesConnectionString: string␊ - /**␊ - * AzureFiles share.␊ - */␊ - azurefilesShare: string␊ - /**␊ - * true if the app should be read only during copy operation; otherwise, false.␊ - */␊ - blockWriteAccessToSite?: (boolean | string)␊ - /**␊ - * trueif the app should be switched over; otherwise, false.␊ - */␊ - switchSiteAfterMigration?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/premieraddons␊ - */␊ - export interface SitesPremieraddonsChildResource1 {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Add-on name.␊ - */␊ - name: string␊ - /**␊ - * PremierAddOn resource specific properties␊ - */␊ - properties: (PremierAddOnProperties | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "premieraddons"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * PremierAddOn resource specific properties␊ - */␊ - export interface PremierAddOnProperties {␊ - /**␊ - * Premier add on Location.␊ - */␊ - location?: string␊ - /**␊ - * Premier add on Marketplace offer.␊ - */␊ - marketplaceOffer?: string␊ - /**␊ - * Premier add on Marketplace publisher.␊ - */␊ - marketplacePublisher?: string␊ - /**␊ - * Premier add on Name.␊ - */␊ - name?: string␊ - /**␊ - * Premier add on Product.␊ - */␊ - product?: string␊ - /**␊ - * Premier add on SKU.␊ - */␊ - sku?: string␊ - /**␊ - * Premier add on Tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Premier add on Vendor.␊ - */␊ - vendor?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/publicCertificates␊ - */␊ - export interface SitesPublicCertificatesChildResource {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Public certificate name.␊ - */␊ - name: string␊ - /**␊ - * PublicCertificate resource specific properties␊ - */␊ - properties: (PublicCertificateProperties | string)␊ - type: "publicCertificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * PublicCertificate resource specific properties␊ - */␊ - export interface PublicCertificateProperties {␊ - /**␊ - * Public Certificate byte array␊ - */␊ - blob?: string␊ - /**␊ - * Public Certificate Location.␊ - */␊ - publicCertificateLocation?: (("CurrentUserMy" | "LocalMachineMy" | "Unknown") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/siteextensions␊ - */␊ - export interface SitesSiteextensionsChildResource {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Site extension name.␊ - */␊ - name: string␊ - type: "siteextensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots␊ - */␊ - export interface SitesSlotsChildResource1 {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Managed service identity.␊ - */␊ - identity?: (ManagedServiceIdentity14 | string)␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the deployment slot to create or update. The name 'production' is reserved.␊ - */␊ - name: string␊ - /**␊ - * Site resource specific properties␊ - */␊ - properties: (SiteProperties1 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "slots"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/sourcecontrols␊ - */␊ - export interface SitesSourcecontrolsChildResource1 {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "web"␊ - /**␊ - * SiteSourceControl resource specific properties␊ - */␊ - properties: (SiteSourceControlProperties1 | string)␊ - type: "sourcecontrols"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SiteSourceControl resource specific properties␊ - */␊ - export interface SiteSourceControlProperties1 {␊ - /**␊ - * Name of branch to use for deployment.␊ - */␊ - branch?: string␊ - /**␊ - * true to enable deployment rollback; otherwise, false.␊ - */␊ - deploymentRollbackEnabled?: (boolean | string)␊ - /**␊ - * true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub).␊ - */␊ - isManualIntegration?: (boolean | string)␊ - /**␊ - * true for a Mercurial repository; false for a Git repository.␊ - */␊ - isMercurial?: (boolean | string)␊ - /**␊ - * Repository or source control URL.␊ - */␊ - repoUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/virtualNetworkConnections␊ - */␊ - export interface SitesVirtualNetworkConnectionsChildResource1 {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of an existing Virtual Network.␊ - */␊ - name: string␊ - /**␊ - * VnetInfo resource specific properties␊ - */␊ - properties: (VnetInfoProperties1 | string)␊ - type: "virtualNetworkConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VnetInfo resource specific properties␊ - */␊ - export interface VnetInfoProperties1 {␊ - /**␊ - * A certificate file (.cer) blob containing the public key of the private key used to authenticate a ␊ - * Point-To-Site VPN connection.␊ - */␊ - certBlob?: string␊ - /**␊ - * DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses.␊ - */␊ - dnsServers?: string␊ - /**␊ - * The Virtual Network's resource ID.␊ - */␊ - vnetResourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/backups␊ - */␊ - export interface SitesBackups1 {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * RestoreRequest resource specific properties␊ - */␊ - properties: (RestoreRequestProperties1 | string)␊ - type: "Microsoft.Web/sites/backups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/deployments␊ - */␊ - export interface SitesDeployments1 {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * ID of an existing deployment.␊ - */␊ - name: string␊ - /**␊ - * Deployment resource specific properties␊ - */␊ - properties: (DeploymentProperties3 | string)␊ - type: "Microsoft.Web/sites/deployments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/domainOwnershipIdentifiers␊ - */␊ - export interface SitesDomainOwnershipIdentifiers {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of domain ownership identifier.␊ - */␊ - name: string␊ - /**␊ - * Identifier resource specific properties␊ - */␊ - properties: (IdentifierProperties | string)␊ - type: "Microsoft.Web/sites/domainOwnershipIdentifiers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/extensions␊ - */␊ - export interface SitesExtensions {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - properties: (MSDeployCore | string)␊ - type: "Microsoft.Web/sites/extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/functions␊ - */␊ - export interface SitesFunctions {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Function name.␊ - */␊ - name: string␊ - /**␊ - * FunctionEnvelope resource specific properties␊ - */␊ - properties: (FunctionEnvelopeProperties | string)␊ - type: "Microsoft.Web/sites/functions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/hostNameBindings␊ - */␊ - export interface SitesHostNameBindings1 {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Hostname in the hostname binding.␊ - */␊ - name: string␊ - /**␊ - * HostNameBinding resource specific properties␊ - */␊ - properties: (HostNameBindingProperties1 | string)␊ - type: "Microsoft.Web/sites/hostNameBindings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/hybridconnection␊ - */␊ - export interface SitesHybridconnection1 {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the hybrid connection configuration.␊ - */␊ - name: string␊ - /**␊ - * RelayServiceConnectionEntity resource specific properties␊ - */␊ - properties: (RelayServiceConnectionEntityProperties1 | string)␊ - type: "Microsoft.Web/sites/hybridconnection"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/hybridConnectionNamespaces/relays␊ - */␊ - export interface SitesHybridConnectionNamespacesRelays {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * The relay name for this hybrid connection.␊ - */␊ - name: string␊ - /**␊ - * HybridConnection resource specific properties␊ - */␊ - properties: (HybridConnectionProperties2 | string)␊ - type: "Microsoft.Web/sites/hybridConnectionNamespaces/relays"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HybridConnection resource specific properties␊ - */␊ - export interface HybridConnectionProperties2 {␊ - /**␊ - * The hostname of the endpoint.␊ - */␊ - hostname?: string␊ - /**␊ - * The port of the endpoint.␊ - */␊ - port?: (number | string)␊ - /**␊ - * The ARM URI to the Service Bus relay.␊ - */␊ - relayArmUri?: string␊ - /**␊ - * The name of the Service Bus relay.␊ - */␊ - relayName?: string␊ - /**␊ - * The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus.␊ - */␊ - sendKeyName?: string␊ - /**␊ - * 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.␊ - */␊ - sendKeyValue?: string␊ - /**␊ - * The name of the Service Bus namespace.␊ - */␊ - serviceBusNamespace?: string␊ - /**␊ - * The suffix for the service bus endpoint. By default this is .servicebus.windows.net␊ - */␊ - serviceBusSuffix?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/instances/extensions␊ - */␊ - export interface SitesInstancesExtensions {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - properties: (MSDeployCore | string)␊ - type: "Microsoft.Web/sites/instances/extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/migrate␊ - */␊ - export interface SitesMigrate {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * StorageMigrationOptions resource specific properties␊ - */␊ - properties: (StorageMigrationOptionsProperties | string)␊ - type: "Microsoft.Web/sites/migrate"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/premieraddons␊ - */␊ - export interface SitesPremieraddons1 {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Add-on name.␊ - */␊ - name: string␊ - /**␊ - * PremierAddOn resource specific properties␊ - */␊ - properties: (PremierAddOnProperties | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/sites/premieraddons"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/publicCertificates␊ - */␊ - export interface SitesPublicCertificates {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Public certificate name.␊ - */␊ - name: string␊ - /**␊ - * PublicCertificate resource specific properties␊ - */␊ - properties: (PublicCertificateProperties | string)␊ - type: "Microsoft.Web/sites/publicCertificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/siteextensions␊ - */␊ - export interface SitesSiteextensions {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Site extension name.␊ - */␊ - name: string␊ - type: "Microsoft.Web/sites/siteextensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots␊ - */␊ - export interface SitesSlots1 {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Managed service identity.␊ - */␊ - identity?: (ManagedServiceIdentity14 | string)␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the deployment slot to create or update. The name 'production' is reserved.␊ - */␊ - name: string␊ - /**␊ - * Site resource specific properties␊ - */␊ - properties: (SiteProperties1 | string)␊ - resources?: (SitesSlotsBackupsChildResource1 | SitesSlotsConfigChildResource1 | SitesSlotsDeploymentsChildResource1 | SitesSlotsDomainOwnershipIdentifiersChildResource | SitesSlotsExtensionsChildResource | SitesSlotsFunctionsChildResource | SitesSlotsHostNameBindingsChildResource1 | SitesSlotsHybridconnectionChildResource1 | SitesSlotsPremieraddonsChildResource1 | SitesSlotsPublicCertificatesChildResource | SitesSlotsSiteextensionsChildResource | SitesSlotsSourcecontrolsChildResource1 | SitesSlotsVirtualNetworkConnectionsChildResource1)[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/sites/slots"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/backups␊ - */␊ - export interface SitesSlotsBackupsChildResource1 {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "discover"␊ - /**␊ - * RestoreRequest resource specific properties␊ - */␊ - properties: (RestoreRequestProperties1 | string)␊ - type: "backups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/deployments␊ - */␊ - export interface SitesSlotsDeploymentsChildResource1 {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * ID of an existing deployment.␊ - */␊ - name: string␊ - /**␊ - * Deployment resource specific properties␊ - */␊ - properties: (DeploymentProperties3 | string)␊ - type: "deployments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/domainOwnershipIdentifiers␊ - */␊ - export interface SitesSlotsDomainOwnershipIdentifiersChildResource {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of domain ownership identifier.␊ - */␊ - name: string␊ - /**␊ - * Identifier resource specific properties␊ - */␊ - properties: (IdentifierProperties | string)␊ - type: "domainOwnershipIdentifiers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/extensions␊ - */␊ - export interface SitesSlotsExtensionsChildResource {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "MSDeploy"␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - properties: (MSDeployCore | string)␊ - type: "extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/functions␊ - */␊ - export interface SitesSlotsFunctionsChildResource {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Function name.␊ - */␊ - name: string␊ - /**␊ - * FunctionEnvelope resource specific properties␊ - */␊ - properties: (FunctionEnvelopeProperties | string)␊ - type: "functions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/hostNameBindings␊ - */␊ - export interface SitesSlotsHostNameBindingsChildResource1 {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Hostname in the hostname binding.␊ - */␊ - name: string␊ - /**␊ - * HostNameBinding resource specific properties␊ - */␊ - properties: (HostNameBindingProperties1 | string)␊ - type: "hostNameBindings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/hybridconnection␊ - */␊ - export interface SitesSlotsHybridconnectionChildResource1 {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the hybrid connection configuration.␊ - */␊ - name: string␊ - /**␊ - * RelayServiceConnectionEntity resource specific properties␊ - */␊ - properties: (RelayServiceConnectionEntityProperties1 | string)␊ - type: "hybridconnection"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/premieraddons␊ - */␊ - export interface SitesSlotsPremieraddonsChildResource1 {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Add-on name.␊ - */␊ - name: string␊ - /**␊ - * PremierAddOn resource specific properties␊ - */␊ - properties: (PremierAddOnProperties | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "premieraddons"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/publicCertificates␊ - */␊ - export interface SitesSlotsPublicCertificatesChildResource {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Public certificate name.␊ - */␊ - name: string␊ - /**␊ - * PublicCertificate resource specific properties␊ - */␊ - properties: (PublicCertificateProperties | string)␊ - type: "publicCertificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/siteextensions␊ - */␊ - export interface SitesSlotsSiteextensionsChildResource {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Site extension name.␊ - */␊ - name: string␊ - type: "siteextensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/sourcecontrols␊ - */␊ - export interface SitesSlotsSourcecontrolsChildResource1 {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "web"␊ - /**␊ - * SiteSourceControl resource specific properties␊ - */␊ - properties: (SiteSourceControlProperties1 | string)␊ - type: "sourcecontrols"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/virtualNetworkConnections␊ - */␊ - export interface SitesSlotsVirtualNetworkConnectionsChildResource1 {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of an existing Virtual Network.␊ - */␊ - name: string␊ - /**␊ - * VnetInfo resource specific properties␊ - */␊ - properties: (VnetInfoProperties1 | string)␊ - type: "virtualNetworkConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/backups␊ - */␊ - export interface SitesSlotsBackups1 {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * RestoreRequest resource specific properties␊ - */␊ - properties: (RestoreRequestProperties1 | string)␊ - type: "Microsoft.Web/sites/slots/backups"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/deployments␊ - */␊ - export interface SitesSlotsDeployments1 {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * ID of an existing deployment.␊ - */␊ - name: string␊ - /**␊ - * Deployment resource specific properties␊ - */␊ - properties: (DeploymentProperties3 | string)␊ - type: "Microsoft.Web/sites/slots/deployments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/domainOwnershipIdentifiers␊ - */␊ - export interface SitesSlotsDomainOwnershipIdentifiers {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of domain ownership identifier.␊ - */␊ - name: string␊ - /**␊ - * Identifier resource specific properties␊ - */␊ - properties: (IdentifierProperties | string)␊ - type: "Microsoft.Web/sites/slots/domainOwnershipIdentifiers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/extensions␊ - */␊ - export interface SitesSlotsExtensions {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - properties: (MSDeployCore | string)␊ - type: "Microsoft.Web/sites/slots/extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/functions␊ - */␊ - export interface SitesSlotsFunctions {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Function name.␊ - */␊ - name: string␊ - /**␊ - * FunctionEnvelope resource specific properties␊ - */␊ - properties: (FunctionEnvelopeProperties | string)␊ - type: "Microsoft.Web/sites/slots/functions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/hostNameBindings␊ - */␊ - export interface SitesSlotsHostNameBindings1 {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Hostname in the hostname binding.␊ - */␊ - name: string␊ - /**␊ - * HostNameBinding resource specific properties␊ - */␊ - properties: (HostNameBindingProperties1 | string)␊ - type: "Microsoft.Web/sites/slots/hostNameBindings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/hybridconnection␊ - */␊ - export interface SitesSlotsHybridconnection1 {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the hybrid connection configuration.␊ - */␊ - name: string␊ - /**␊ - * RelayServiceConnectionEntity resource specific properties␊ - */␊ - properties: (RelayServiceConnectionEntityProperties1 | string)␊ - type: "Microsoft.Web/sites/slots/hybridconnection"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays␊ - */␊ - export interface SitesSlotsHybridConnectionNamespacesRelays {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * The relay name for this hybrid connection.␊ - */␊ - name: string␊ - /**␊ - * HybridConnection resource specific properties␊ - */␊ - properties: (HybridConnectionProperties2 | string)␊ - type: "Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/instances/extensions␊ - */␊ - export interface SitesSlotsInstancesExtensions {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - properties: (MSDeployCore | string)␊ - type: "Microsoft.Web/sites/slots/instances/extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/premieraddons␊ - */␊ - export interface SitesSlotsPremieraddons1 {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Add-on name.␊ - */␊ - name: string␊ - /**␊ - * PremierAddOn resource specific properties␊ - */␊ - properties: (PremierAddOnProperties | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/sites/slots/premieraddons"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/publicCertificates␊ - */␊ - export interface SitesSlotsPublicCertificates {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Public certificate name.␊ - */␊ - name: string␊ - /**␊ - * PublicCertificate resource specific properties␊ - */␊ - properties: (PublicCertificateProperties | string)␊ - type: "Microsoft.Web/sites/slots/publicCertificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/siteextensions␊ - */␊ - export interface SitesSlotsSiteextensions {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Site extension name.␊ - */␊ - name: string␊ - type: "Microsoft.Web/sites/slots/siteextensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/sourcecontrols␊ - */␊ - export interface SitesSlotsSourcecontrols1 {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteSourceControl resource specific properties␊ - */␊ - properties: (SiteSourceControlProperties1 | string)␊ - type: "Microsoft.Web/sites/slots/sourcecontrols"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/virtualNetworkConnections␊ - */␊ - export interface SitesSlotsVirtualNetworkConnections1 {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of an existing Virtual Network.␊ - */␊ - name: string␊ - /**␊ - * VnetInfo resource specific properties␊ - */␊ - properties: (VnetInfoProperties1 | string)␊ - resources?: SitesSlotsVirtualNetworkConnectionsGatewaysChildResource1[]␊ - type: "Microsoft.Web/sites/slots/virtualNetworkConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/virtualNetworkConnections/gateways␊ - */␊ - export interface SitesSlotsVirtualNetworkConnectionsGatewaysChildResource1 {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the gateway. Currently, the only supported string is "primary".␊ - */␊ - name: string␊ - /**␊ - * VnetGateway resource specific properties␊ - */␊ - properties: (VnetGatewayProperties1 | string)␊ - type: "gateways"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VnetGateway resource specific properties␊ - */␊ - export interface VnetGatewayProperties1 {␊ - /**␊ - * The Virtual Network name.␊ - */␊ - vnetName?: string␊ - /**␊ - * The URI where the VPN package can be downloaded.␊ - */␊ - vpnPackageUri: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/virtualNetworkConnections/gateways␊ - */␊ - export interface SitesSlotsVirtualNetworkConnectionsGateways1 {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the gateway. Currently, the only supported string is "primary".␊ - */␊ - name: string␊ - /**␊ - * VnetGateway resource specific properties␊ - */␊ - properties: (VnetGatewayProperties1 | string)␊ - type: "Microsoft.Web/sites/slots/virtualNetworkConnections/gateways"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/sourcecontrols␊ - */␊ - export interface SitesSourcecontrols1 {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteSourceControl resource specific properties␊ - */␊ - properties: (SiteSourceControlProperties1 | string)␊ - type: "Microsoft.Web/sites/sourcecontrols"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/virtualNetworkConnections␊ - */␊ - export interface SitesVirtualNetworkConnections1 {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of an existing Virtual Network.␊ - */␊ - name: string␊ - /**␊ - * VnetInfo resource specific properties␊ - */␊ - properties: (VnetInfoProperties1 | string)␊ - resources?: SitesVirtualNetworkConnectionsGatewaysChildResource1[]␊ - type: "Microsoft.Web/sites/virtualNetworkConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/virtualNetworkConnections/gateways␊ - */␊ - export interface SitesVirtualNetworkConnectionsGatewaysChildResource1 {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the gateway. Currently, the only supported string is "primary".␊ - */␊ - name: string␊ - /**␊ - * VnetGateway resource specific properties␊ - */␊ - properties: (VnetGatewayProperties1 | string)␊ - type: "gateways"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/virtualNetworkConnections/gateways␊ - */␊ - export interface SitesVirtualNetworkConnectionsGateways1 {␊ - apiVersion: "2016-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the gateway. Currently, the only supported string is "primary".␊ - */␊ - name: string␊ - /**␊ - * VnetGateway resource specific properties␊ - */␊ - properties: (VnetGatewayProperties1 | string)␊ - type: "Microsoft.Web/sites/virtualNetworkConnections/gateways"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/hostingEnvironments␊ - */␊ - export interface HostingEnvironments1 {␊ - apiVersion: "2016-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the App Service Environment.␊ - */␊ - name: string␊ - /**␊ - * Description of an App Service Environment.␊ - */␊ - properties: (AppServiceEnvironment | string)␊ - resources?: (HostingEnvironmentsMultiRolePoolsChildResource1 | HostingEnvironmentsWorkerPoolsChildResource1)[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/hostingEnvironments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of an App Service Environment.␊ - */␊ - export interface AppServiceEnvironment {␊ - /**␊ - * API Management Account associated with the App Service Environment.␊ - */␊ - apiManagementAccountId?: string␊ - /**␊ - * Custom settings for changing the behavior of the App Service Environment.␊ - */␊ - clusterSettings?: (NameValuePair2[] | string)␊ - /**␊ - * DNS suffix of the App Service Environment.␊ - */␊ - dnsSuffix?: string␊ - /**␊ - * True/false indicating whether the App Service Environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available␊ - * (most likely because NSG blocked the incoming traffic).␊ - */␊ - dynamicCacheEnabled?: (boolean | string)␊ - /**␊ - * Scale factor for front-ends.␊ - */␊ - frontEndScaleFactor?: (number | string)␊ - /**␊ - * Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.␊ - */␊ - internalLoadBalancingMode?: (("None" | "Web" | "Publishing") | string)␊ - /**␊ - * Number of IP SSL addresses reserved for the App Service Environment.␊ - */␊ - ipsslAddressCount?: (number | string)␊ - /**␊ - * Location of the App Service Environment, e.g. "West US".␊ - */␊ - location: string␊ - /**␊ - * Number of front-end instances.␊ - */␊ - multiRoleCount?: (number | string)␊ - /**␊ - * Front-end VM size, e.g. "Medium", "Large".␊ - */␊ - multiSize?: string␊ - /**␊ - * Name of the App Service Environment.␊ - */␊ - name: string␊ - /**␊ - * Access control list for controlling traffic to the App Service Environment.␊ - */␊ - networkAccessControlList?: (NetworkAccessControlEntry1[] | string)␊ - /**␊ - * true if the App Service Environment is suspended; otherwise, false. The environment can be suspended, e.g. when the management endpoint is no longer available␊ - * (most likely because NSG blocked the incoming traffic).␊ - */␊ - suspended?: (boolean | string)␊ - /**␊ - * User added ip ranges to whitelist on ASE db␊ - */␊ - userWhitelistedIpRanges?: (string[] | string)␊ - /**␊ - * Specification for using a Virtual Network.␊ - */␊ - virtualNetwork: (VirtualNetworkProfile4 | string)␊ - /**␊ - * Name of the Virtual Network for the App Service Environment.␊ - */␊ - vnetName?: string␊ - /**␊ - * Resource group of the Virtual Network.␊ - */␊ - vnetResourceGroupName?: string␊ - /**␊ - * Subnet of the Virtual Network.␊ - */␊ - vnetSubnetName?: string␊ - /**␊ - * Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool.␊ - */␊ - workerPools: (WorkerPool1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Name value pair.␊ - */␊ - export interface NameValuePair2 {␊ - /**␊ - * Pair name.␊ - */␊ - name?: string␊ - /**␊ - * Pair value.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network access control entry.␊ - */␊ - export interface NetworkAccessControlEntry1 {␊ - /**␊ - * Action object.␊ - */␊ - action?: (("Permit" | "Deny") | string)␊ - /**␊ - * Description of network access control entry.␊ - */␊ - description?: string␊ - /**␊ - * Order of precedence.␊ - */␊ - order?: (number | string)␊ - /**␊ - * Remote subnet.␊ - */␊ - remoteSubnet?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specification for using a Virtual Network.␊ - */␊ - export interface VirtualNetworkProfile4 {␊ - /**␊ - * Resource id of the Virtual Network.␊ - */␊ - id?: string␊ - /**␊ - * Subnet within the Virtual Network.␊ - */␊ - subnet?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Worker pool of an App Service Environment.␊ - */␊ - export interface WorkerPool1 {␊ - /**␊ - * Shared or dedicated app hosting.␊ - */␊ - computeMode?: (("Shared" | "Dedicated" | "Dynamic") | string)␊ - /**␊ - * Number of instances in the worker pool.␊ - */␊ - workerCount?: (number | string)␊ - /**␊ - * VM size of the worker pool instances.␊ - */␊ - workerSize?: string␊ - /**␊ - * Worker size ID for referencing this worker pool.␊ - */␊ - workerSizeId?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/hostingEnvironments/multiRolePools␊ - */␊ - export interface HostingEnvironmentsMultiRolePoolsChildResource1 {␊ - apiVersion: "2016-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "default"␊ - /**␊ - * Worker pool of an App Service Environment.␊ - */␊ - properties: (WorkerPool1 | string)␊ - /**␊ - * Description of a SKU for a scalable resource.␊ - */␊ - sku?: (SkuDescription3 | string)␊ - type: "multiRolePools"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a SKU for a scalable resource.␊ - */␊ - export interface SkuDescription3 {␊ - /**␊ - * Capabilities of the SKU, e.g., is traffic manager enabled?␊ - */␊ - capabilities?: (Capability1[] | string)␊ - /**␊ - * Current number of instances assigned to the resource.␊ - */␊ - capacity?: (number | string)␊ - /**␊ - * Family code of the resource SKU.␊ - */␊ - family?: string␊ - /**␊ - * Locations of the SKU.␊ - */␊ - locations?: (string[] | string)␊ - /**␊ - * Name of the resource SKU.␊ - */␊ - name?: string␊ - /**␊ - * Size specifier of the resource SKU.␊ - */␊ - size?: string␊ - /**␊ - * Description of the App Service plan scale options.␊ - */␊ - skuCapacity?: (SkuCapacity | string)␊ - /**␊ - * Service tier of the resource SKU.␊ - */␊ - tier?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the capabilities/features allowed for a specific SKU.␊ - */␊ - export interface Capability1 {␊ - /**␊ - * Name of the SKU capability.␊ - */␊ - name?: string␊ - /**␊ - * Reason of the SKU capability.␊ - */␊ - reason?: string␊ - /**␊ - * Value of the SKU capability.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of the App Service plan scale options.␊ - */␊ - export interface SkuCapacity {␊ - /**␊ - * Default number of workers for this App Service plan SKU.␊ - */␊ - default?: (number | string)␊ - /**␊ - * Maximum number of workers for this App Service plan SKU.␊ - */␊ - maximum?: (number | string)␊ - /**␊ - * Minimum number of workers for this App Service plan SKU.␊ - */␊ - minimum?: (number | string)␊ - /**␊ - * Available scale configurations for an App Service plan.␊ - */␊ - scaleType?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/hostingEnvironments/workerPools␊ - */␊ - export interface HostingEnvironmentsWorkerPoolsChildResource1 {␊ - apiVersion: "2016-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the worker pool.␊ - */␊ - name: string␊ - /**␊ - * Worker pool of an App Service Environment.␊ - */␊ - properties: (WorkerPool1 | string)␊ - /**␊ - * Description of a SKU for a scalable resource.␊ - */␊ - sku?: (SkuDescription3 | string)␊ - type: "workerPools"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/hostingEnvironments/multiRolePools␊ - */␊ - export interface HostingEnvironmentsMultiRolePools1 {␊ - apiVersion: "2016-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Worker pool of an App Service Environment.␊ - */␊ - properties: (WorkerPool1 | string)␊ - /**␊ - * Description of a SKU for a scalable resource.␊ - */␊ - sku?: (SkuDescription3 | string)␊ - type: "Microsoft.Web/hostingEnvironments/multiRolePools"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/hostingEnvironments/workerPools␊ - */␊ - export interface HostingEnvironmentsWorkerPools1 {␊ - apiVersion: "2016-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the worker pool.␊ - */␊ - name: string␊ - /**␊ - * Worker pool of an App Service Environment.␊ - */␊ - properties: (WorkerPool1 | string)␊ - /**␊ - * Description of a SKU for a scalable resource.␊ - */␊ - sku?: (SkuDescription3 | string)␊ - type: "Microsoft.Web/hostingEnvironments/workerPools"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/serverfarms␊ - */␊ - export interface Serverfarms1 {␊ - apiVersion: "2016-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the App Service plan.␊ - */␊ - name: string␊ - /**␊ - * AppServicePlan resource specific properties␊ - */␊ - properties: (AppServicePlanProperties | string)␊ - /**␊ - * Description of a SKU for a scalable resource.␊ - */␊ - sku?: (SkuDescription3 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/serverfarms"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AppServicePlan resource specific properties␊ - */␊ - export interface AppServicePlanProperties {␊ - /**␊ - * App Service plan administration site.␊ - */␊ - adminSiteName?: string␊ - /**␊ - * Specification for an App Service Environment to use for this resource.␊ - */␊ - hostingEnvironmentProfile?: (HostingEnvironmentProfile2 | string)␊ - /**␊ - * If true, this App Service Plan owns spot instances.␊ - */␊ - isSpot?: (boolean | string)␊ - /**␊ - * Name for the App Service plan.␊ - */␊ - name: string␊ - /**␊ - * 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.␊ - */␊ - perSiteScaling?: (boolean | string)␊ - /**␊ - * If Linux app service plan true, false otherwise.␊ - */␊ - reserved?: (boolean | string)␊ - /**␊ - * The time when the server farm expires. Valid only if it is a spot server farm.␊ - */␊ - spotExpirationTime?: string␊ - /**␊ - * Scaling worker count.␊ - */␊ - targetWorkerCount?: (number | string)␊ - /**␊ - * Scaling worker size ID.␊ - */␊ - targetWorkerSizeId?: (number | string)␊ - /**␊ - * Target worker tier assigned to the App Service plan.␊ - */␊ - workerTierName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specification for an App Service Environment to use for this resource.␊ - */␊ - export interface HostingEnvironmentProfile2 {␊ - /**␊ - * Resource ID of the App Service Environment.␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/serverfarms/virtualNetworkConnections/gateways␊ - */␊ - export interface ServerfarmsVirtualNetworkConnectionsGateways1 {␊ - apiVersion: "2016-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the gateway. Only the 'primary' gateway is supported.␊ - */␊ - name: string␊ - /**␊ - * VnetGateway resource specific properties␊ - */␊ - properties: (VnetGatewayProperties2 | string)␊ - type: "Microsoft.Web/serverfarms/virtualNetworkConnections/gateways"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VnetGateway resource specific properties␊ - */␊ - export interface VnetGatewayProperties2 {␊ - /**␊ - * The Virtual Network name.␊ - */␊ - vnetName?: string␊ - /**␊ - * The URI where the VPN package can be downloaded.␊ - */␊ - vpnPackageUri: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/serverfarms/virtualNetworkConnections/routes␊ - */␊ - export interface ServerfarmsVirtualNetworkConnectionsRoutes1 {␊ - apiVersion: "2016-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the Virtual Network route.␊ - */␊ - name: string␊ - /**␊ - * VnetRoute resource specific properties␊ - */␊ - properties: (VnetRouteProperties1 | string)␊ - type: "Microsoft.Web/serverfarms/virtualNetworkConnections/routes"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VnetRoute resource specific properties␊ - */␊ - export interface VnetRouteProperties1 {␊ - /**␊ - * The ending address for this route. If the start address is specified in CIDR notation, this must be omitted.␊ - */␊ - endAddress?: string␊ - /**␊ - * The name of this route. This is only returned by the server and does not need to be set by the client.␊ - */␊ - name?: string␊ - /**␊ - * 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.␊ - */␊ - routeType?: (("DEFAULT" | "INHERITED" | "STATIC") | string)␊ - /**␊ - * The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified.␊ - */␊ - startAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/certificates␊ - */␊ - export interface Certificates2 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the certificate.␊ - */␊ - name: string␊ - /**␊ - * Certificate resource specific properties␊ - */␊ - properties: (CertificateProperties2 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/certificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Certificate resource specific properties␊ - */␊ - export interface CertificateProperties2 {␊ - /**␊ - * Host names the certificate applies to.␊ - */␊ - hostNames?: (string[] | string)␊ - /**␊ - * Key Vault Csm resource Id.␊ - */␊ - keyVaultId?: string␊ - /**␊ - * Key Vault secret name.␊ - */␊ - keyVaultSecretName?: string␊ - /**␊ - * Certificate password.␊ - */␊ - password: string␊ - /**␊ - * Pfx blob.␊ - */␊ - pfxBlob?: string␊ - /**␊ - * Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".␊ - */␊ - serverFarmId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/hostingEnvironments␊ - */␊ - export interface HostingEnvironments2 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the App Service Environment.␊ - */␊ - name: string␊ - /**␊ - * Description of an App Service Environment.␊ - */␊ - properties: (AppServiceEnvironment1 | string)␊ - resources?: (HostingEnvironmentsMultiRolePoolsChildResource2 | HostingEnvironmentsWorkerPoolsChildResource2)[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/hostingEnvironments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of an App Service Environment.␊ - */␊ - export interface AppServiceEnvironment1 {␊ - /**␊ - * API Management Account associated with the App Service Environment.␊ - */␊ - apiManagementAccountId?: string␊ - /**␊ - * Custom settings for changing the behavior of the App Service Environment.␊ - */␊ - clusterSettings?: (NameValuePair3[] | string)␊ - /**␊ - * DNS suffix of the App Service Environment.␊ - */␊ - dnsSuffix?: string␊ - /**␊ - * True/false indicating whether the App Service Environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available␊ - * (most likely because NSG blocked the incoming traffic).␊ - */␊ - dynamicCacheEnabled?: (boolean | string)␊ - /**␊ - * Scale factor for front-ends.␊ - */␊ - frontEndScaleFactor?: (number | string)␊ - /**␊ - * Flag that displays whether an ASE has linux workers or not␊ - */␊ - hasLinuxWorkers?: (boolean | string)␊ - /**␊ - * Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.␊ - */␊ - internalLoadBalancingMode?: (("None" | "Web" | "Publishing") | string)␊ - /**␊ - * Number of IP SSL addresses reserved for the App Service Environment.␊ - */␊ - ipsslAddressCount?: (number | string)␊ - /**␊ - * Location of the App Service Environment, e.g. "West US".␊ - */␊ - location: string␊ - /**␊ - * Number of front-end instances.␊ - */␊ - multiRoleCount?: (number | string)␊ - /**␊ - * Front-end VM size, e.g. "Medium", "Large".␊ - */␊ - multiSize?: string␊ - /**␊ - * Name of the App Service Environment.␊ - */␊ - name: string␊ - /**␊ - * Access control list for controlling traffic to the App Service Environment.␊ - */␊ - networkAccessControlList?: (NetworkAccessControlEntry2[] | string)␊ - /**␊ - * Key Vault ID for ILB App Service Environment default SSL certificate␊ - */␊ - sslCertKeyVaultId?: string␊ - /**␊ - * Key Vault Secret Name for ILB App Service Environment default SSL certificate␊ - */␊ - sslCertKeyVaultSecretName?: string␊ - /**␊ - * true if the App Service Environment is suspended; otherwise, false. The environment can be suspended, e.g. when the management endpoint is no longer available␊ - * (most likely because NSG blocked the incoming traffic).␊ - */␊ - suspended?: (boolean | string)␊ - /**␊ - * User added ip ranges to whitelist on ASE db␊ - */␊ - userWhitelistedIpRanges?: (string[] | string)␊ - /**␊ - * Specification for using a Virtual Network.␊ - */␊ - virtualNetwork: (VirtualNetworkProfile5 | string)␊ - /**␊ - * Name of the Virtual Network for the App Service Environment.␊ - */␊ - vnetName?: string␊ - /**␊ - * Resource group of the Virtual Network.␊ - */␊ - vnetResourceGroupName?: string␊ - /**␊ - * Subnet of the Virtual Network.␊ - */␊ - vnetSubnetName?: string␊ - /**␊ - * Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool.␊ - */␊ - workerPools: (WorkerPool2[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Name value pair.␊ - */␊ - export interface NameValuePair3 {␊ - /**␊ - * Pair name.␊ - */␊ - name?: string␊ - /**␊ - * Pair value.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network access control entry.␊ - */␊ - export interface NetworkAccessControlEntry2 {␊ - /**␊ - * Action object.␊ - */␊ - action?: (("Permit" | "Deny") | string)␊ - /**␊ - * Description of network access control entry.␊ - */␊ - description?: string␊ - /**␊ - * Order of precedence.␊ - */␊ - order?: (number | string)␊ - /**␊ - * Remote subnet.␊ - */␊ - remoteSubnet?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specification for using a Virtual Network.␊ - */␊ - export interface VirtualNetworkProfile5 {␊ - /**␊ - * Resource id of the Virtual Network.␊ - */␊ - id?: string␊ - /**␊ - * Subnet within the Virtual Network.␊ - */␊ - subnet?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Worker pool of an App Service Environment.␊ - */␊ - export interface WorkerPool2 {␊ - /**␊ - * Shared or dedicated app hosting.␊ - */␊ - computeMode?: (("Shared" | "Dedicated" | "Dynamic") | string)␊ - /**␊ - * Number of instances in the worker pool.␊ - */␊ - workerCount?: (number | string)␊ - /**␊ - * VM size of the worker pool instances.␊ - */␊ - workerSize?: string␊ - /**␊ - * Worker size ID for referencing this worker pool.␊ - */␊ - workerSizeId?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/hostingEnvironments/multiRolePools␊ - */␊ - export interface HostingEnvironmentsMultiRolePoolsChildResource2 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "default"␊ - /**␊ - * Worker pool of an App Service Environment.␊ - */␊ - properties: (WorkerPool2 | string)␊ - /**␊ - * Description of a SKU for a scalable resource.␊ - */␊ - sku?: (SkuDescription4 | string)␊ - type: "multiRolePools"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a SKU for a scalable resource.␊ - */␊ - export interface SkuDescription4 {␊ - /**␊ - * Capabilities of the SKU, e.g., is traffic manager enabled?␊ - */␊ - capabilities?: (Capability2[] | string)␊ - /**␊ - * Current number of instances assigned to the resource.␊ - */␊ - capacity?: (number | string)␊ - /**␊ - * Family code of the resource SKU.␊ - */␊ - family?: string␊ - /**␊ - * Locations of the SKU.␊ - */␊ - locations?: (string[] | string)␊ - /**␊ - * Name of the resource SKU.␊ - */␊ - name?: string␊ - /**␊ - * Size specifier of the resource SKU.␊ - */␊ - size?: string␊ - /**␊ - * Description of the App Service plan scale options.␊ - */␊ - skuCapacity?: (SkuCapacity1 | string)␊ - /**␊ - * Service tier of the resource SKU.␊ - */␊ - tier?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the capabilities/features allowed for a specific SKU.␊ - */␊ - export interface Capability2 {␊ - /**␊ - * Name of the SKU capability.␊ - */␊ - name?: string␊ - /**␊ - * Reason of the SKU capability.␊ - */␊ - reason?: string␊ - /**␊ - * Value of the SKU capability.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of the App Service plan scale options.␊ - */␊ - export interface SkuCapacity1 {␊ - /**␊ - * Default number of workers for this App Service plan SKU.␊ - */␊ - default?: (number | string)␊ - /**␊ - * Maximum number of workers for this App Service plan SKU.␊ - */␊ - maximum?: (number | string)␊ - /**␊ - * Minimum number of workers for this App Service plan SKU.␊ - */␊ - minimum?: (number | string)␊ - /**␊ - * Available scale configurations for an App Service plan.␊ - */␊ - scaleType?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/hostingEnvironments/workerPools␊ - */␊ - export interface HostingEnvironmentsWorkerPoolsChildResource2 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the worker pool.␊ - */␊ - name: string␊ - /**␊ - * Worker pool of an App Service Environment.␊ - */␊ - properties: (WorkerPool2 | string)␊ - /**␊ - * Description of a SKU for a scalable resource.␊ - */␊ - sku?: (SkuDescription4 | string)␊ - type: "workerPools"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/hostingEnvironments/multiRolePools␊ - */␊ - export interface HostingEnvironmentsMultiRolePools2 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Worker pool of an App Service Environment.␊ - */␊ - properties: (WorkerPool2 | string)␊ - /**␊ - * Description of a SKU for a scalable resource.␊ - */␊ - sku?: (SkuDescription4 | string)␊ - type: "Microsoft.Web/hostingEnvironments/multiRolePools"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/hostingEnvironments/workerPools␊ - */␊ - export interface HostingEnvironmentsWorkerPools2 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the worker pool.␊ - */␊ - name: string␊ - /**␊ - * Worker pool of an App Service Environment.␊ - */␊ - properties: (WorkerPool2 | string)␊ - /**␊ - * Description of a SKU for a scalable resource.␊ - */␊ - sku?: (SkuDescription4 | string)␊ - type: "Microsoft.Web/hostingEnvironments/workerPools"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/serverfarms␊ - */␊ - export interface Serverfarms2 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the App Service plan.␊ - */␊ - name: string␊ - /**␊ - * AppServicePlan resource specific properties␊ - */␊ - properties: (AppServicePlanProperties1 | string)␊ - /**␊ - * Description of a SKU for a scalable resource.␊ - */␊ - sku?: (SkuDescription4 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/serverfarms"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AppServicePlan resource specific properties␊ - */␊ - export interface AppServicePlanProperties1 {␊ - /**␊ - * The time when the server farm free offer expires.␊ - */␊ - freeOfferExpirationTime?: string␊ - /**␊ - * Specification for an App Service Environment to use for this resource.␊ - */␊ - hostingEnvironmentProfile?: (HostingEnvironmentProfile3 | string)␊ - /**␊ - * If Hyper-V container app service plan true, false otherwise.␊ - */␊ - hyperV?: (boolean | string)␊ - /**␊ - * If true, this App Service Plan owns spot instances.␊ - */␊ - isSpot?: (boolean | string)␊ - /**␊ - * Obsolete: If Hyper-V container app service plan true, false otherwise.␊ - */␊ - isXenon?: (boolean | string)␊ - /**␊ - * Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan␊ - */␊ - maximumElasticWorkerCount?: (number | string)␊ - /**␊ - * 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.␊ - */␊ - perSiteScaling?: (boolean | string)␊ - /**␊ - * If Linux app service plan true, false otherwise.␊ - */␊ - reserved?: (boolean | string)␊ - /**␊ - * The time when the server farm expires. Valid only if it is a spot server farm.␊ - */␊ - spotExpirationTime?: string␊ - /**␊ - * Scaling worker count.␊ - */␊ - targetWorkerCount?: (number | string)␊ - /**␊ - * Scaling worker size ID.␊ - */␊ - targetWorkerSizeId?: (number | string)␊ - /**␊ - * Target worker tier assigned to the App Service plan.␊ - */␊ - workerTierName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specification for an App Service Environment to use for this resource.␊ - */␊ - export interface HostingEnvironmentProfile3 {␊ - /**␊ - * Resource ID of the App Service Environment.␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/serverfarms/virtualNetworkConnections/gateways␊ - */␊ - export interface ServerfarmsVirtualNetworkConnectionsGateways2 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the gateway. Only the 'primary' gateway is supported.␊ - */␊ - name: string␊ - /**␊ - * VnetGateway resource specific properties␊ - */␊ - properties: (VnetGatewayProperties3 | string)␊ - type: "Microsoft.Web/serverfarms/virtualNetworkConnections/gateways"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VnetGateway resource specific properties␊ - */␊ - export interface VnetGatewayProperties3 {␊ - /**␊ - * The Virtual Network name.␊ - */␊ - vnetName?: string␊ - /**␊ - * The URI where the VPN package can be downloaded.␊ - */␊ - vpnPackageUri: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/serverfarms/virtualNetworkConnections/routes␊ - */␊ - export interface ServerfarmsVirtualNetworkConnectionsRoutes2 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the Virtual Network route.␊ - */␊ - name: string␊ - /**␊ - * VnetRoute resource specific properties␊ - */␊ - properties: (VnetRouteProperties2 | string)␊ - type: "Microsoft.Web/serverfarms/virtualNetworkConnections/routes"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VnetRoute resource specific properties␊ - */␊ - export interface VnetRouteProperties2 {␊ - /**␊ - * The ending address for this route. If the start address is specified in CIDR notation, this must be omitted.␊ - */␊ - endAddress?: string␊ - /**␊ - * 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.␊ - */␊ - routeType?: (("DEFAULT" | "INHERITED" | "STATIC") | string)␊ - /**␊ - * The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified.␊ - */␊ - startAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites␊ - */␊ - export interface Sites2 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Managed service identity.␊ - */␊ - identity?: (ManagedServiceIdentity15 | string)␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Unique name of the app to create or update. To create or update a deployment slot, use the {slot} parameter.␊ - */␊ - name: string␊ - /**␊ - * Site resource specific properties␊ - */␊ - properties: (SiteProperties2 | string)␊ - resources?: (SitesConfigChildResource2 | SitesDeploymentsChildResource2 | SitesDomainOwnershipIdentifiersChildResource1 | SitesExtensionsChildResource1 | SitesFunctionsChildResource1 | SitesHostNameBindingsChildResource2 | SitesHybridconnectionChildResource2 | SitesMigrateChildResource1 | SitesNetworkConfigChildResource | SitesPremieraddonsChildResource2 | SitesPrivateAccessChildResource | SitesPublicCertificatesChildResource1 | SitesSiteextensionsChildResource1 | SitesSlotsChildResource2 | SitesSourcecontrolsChildResource2 | SitesVirtualNetworkConnectionsChildResource2)[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/sites"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Managed service identity.␊ - */␊ - export interface ManagedServiceIdentity15 {␊ - /**␊ - * Type of managed service identity.␊ - */␊ - type?: (("SystemAssigned" | "UserAssigned" | "SystemAssigned, UserAssigned" | "None") | string)␊ - /**␊ - * The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}␊ - */␊ - userAssignedIdentities?: ({␊ - [k: string]: Components1Jq1T4Ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties1␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - export interface Components1Jq1T4Ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties1 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Site resource specific properties␊ - */␊ - export interface SiteProperties2 {␊ - /**␊ - * 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.␊ - */␊ - clientAffinityEnabled?: (boolean | string)␊ - /**␊ - * true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.␊ - */␊ - clientCertEnabled?: (boolean | string)␊ - /**␊ - * client certificate authentication comma-separated exclusion paths␊ - */␊ - clientCertExclusionPaths?: string␊ - /**␊ - * Information needed for cloning operation.␊ - */␊ - cloningInfo?: (CloningInfo2 | string)␊ - /**␊ - * Size of the function container.␊ - */␊ - containerSize?: (number | string)␊ - /**␊ - * Maximum allowed daily memory-time quota (applicable on dynamic apps only).␊ - */␊ - dailyMemoryTimeQuota?: (number | string)␊ - /**␊ - * true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * GeoDistributions for this site␊ - */␊ - geoDistributions?: (GeoDistribution[] | string)␊ - /**␊ - * Specification for an App Service Environment to use for this resource.␊ - */␊ - hostingEnvironmentProfile?: (HostingEnvironmentProfile3 | string)␊ - /**␊ - * true to disable the public hostnames of the app; otherwise, false.␊ - * If true, the app is only accessible via API management process.␊ - */␊ - hostNamesDisabled?: (boolean | string)␊ - /**␊ - * Hostname SSL states are used to manage the SSL bindings for app's hostnames.␊ - */␊ - hostNameSslStates?: (HostNameSslState2[] | string)␊ - /**␊ - * HttpsOnly: configures a web site to accept only https requests. Issues redirect for␊ - * http requests␊ - */␊ - httpsOnly?: (boolean | string)␊ - /**␊ - * Hyper-V sandbox.␊ - */␊ - hyperV?: (boolean | string)␊ - /**␊ - * Obsolete: Hyper-V sandbox.␊ - */␊ - isXenon?: (boolean | string)␊ - /**␊ - * Site redundancy mode.␊ - */␊ - redundancyMode?: (("None" | "Manual" | "Failover" | "ActiveActive" | "GeoRedundant") | string)␊ - /**␊ - * true if reserved; otherwise, false.␊ - */␊ - reserved?: (boolean | string)␊ - /**␊ - * true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.␊ - */␊ - scmSiteAlsoStopped?: (boolean | string)␊ - /**␊ - * Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".␊ - */␊ - serverFarmId?: string␊ - /**␊ - * Configuration of an App Service app.␊ - */␊ - siteConfig?: (SiteConfig2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information needed for cloning operation.␊ - */␊ - export interface CloningInfo2 {␊ - /**␊ - * 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.␊ - */␊ - appSettingsOverrides?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * true to clone custom hostnames from source app; otherwise, false.␊ - */␊ - cloneCustomHostNames?: (boolean | string)␊ - /**␊ - * true to clone source control from source app; otherwise, false.␊ - */␊ - cloneSourceControl?: (boolean | string)␊ - /**␊ - * true to configure load balancing for source and destination app.␊ - */␊ - configureLoadBalancing?: (boolean | string)␊ - /**␊ - * Correlation ID of cloning operation. This ID ties multiple cloning operations␊ - * together to use the same snapshot.␊ - */␊ - correlationId?: string␊ - /**␊ - * App Service Environment.␊ - */␊ - hostingEnvironment?: string␊ - /**␊ - * true to overwrite destination app; otherwise, false.␊ - */␊ - overwrite?: (boolean | string)␊ - /**␊ - * 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.␊ - */␊ - sourceWebAppId: string␊ - /**␊ - * Location of source app ex: West US or North Europe␊ - */␊ - sourceWebAppLocation?: string␊ - /**␊ - * 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}.␊ - */␊ - trafficManagerProfileId?: string␊ - /**␊ - * Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist.␊ - */␊ - trafficManagerProfileName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A global distribution definition.␊ - */␊ - export interface GeoDistribution {␊ - /**␊ - * Location.␊ - */␊ - location?: string␊ - /**␊ - * NumberOfWorkers.␊ - */␊ - numberOfWorkers?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSL-enabled hostname.␊ - */␊ - export interface HostNameSslState2 {␊ - /**␊ - * Indicates whether the hostname is a standard or repository hostname.␊ - */␊ - hostType?: (("Standard" | "Repository") | string)␊ - /**␊ - * Hostname.␊ - */␊ - name?: string␊ - /**␊ - * SSL type.␊ - */␊ - sslState?: (("Disabled" | "SniEnabled" | "IpBasedEnabled") | string)␊ - /**␊ - * SSL certificate thumbprint.␊ - */␊ - thumbprint?: string␊ - /**␊ - * Set to true to update existing hostname.␊ - */␊ - toUpdate?: (boolean | string)␊ - /**␊ - * Virtual IP address assigned to the hostname if IP based SSL is enabled.␊ - */␊ - virtualIP?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Configuration of an App Service app.␊ - */␊ - export interface SiteConfig2 {␊ - /**␊ - * true if Always On is enabled; otherwise, false.␊ - */␊ - alwaysOn?: (boolean | string)␊ - /**␊ - * Information about the formal API definition for the app.␊ - */␊ - apiDefinition?: (ApiDefinitionInfo2 | string)␊ - /**␊ - * App command line to launch.␊ - */␊ - appCommandLine?: string␊ - /**␊ - * Application settings.␊ - */␊ - appSettings?: (NameValuePair3[] | string)␊ - /**␊ - * true if Auto Heal is enabled; otherwise, false.␊ - */␊ - autoHealEnabled?: (boolean | string)␊ - /**␊ - * Rules that can be defined for auto-heal.␊ - */␊ - autoHealRules?: (AutoHealRules2 | string)␊ - /**␊ - * Auto-swap slot name.␊ - */␊ - autoSwapSlotName?: string␊ - /**␊ - * User-provided Azure storage accounts.␊ - */␊ - azureStorageAccounts?: ({␊ - [k: string]: AzureStorageInfoValue␊ - } | string)␊ - /**␊ - * Connection strings.␊ - */␊ - connectionStrings?: (ConnStringInfo2[] | string)␊ - /**␊ - * Cross-Origin Resource Sharing (CORS) settings for the app.␊ - */␊ - cors?: (CorsSettings2 | string)␊ - /**␊ - * Default documents.␊ - */␊ - defaultDocuments?: (string[] | string)␊ - /**␊ - * true if detailed error logging is enabled; otherwise, false.␊ - */␊ - detailedErrorLoggingEnabled?: (boolean | string)␊ - /**␊ - * Document root.␊ - */␊ - documentRoot?: string␊ - /**␊ - * Routing rules in production experiments.␊ - */␊ - experiments?: (Experiments2 | string)␊ - /**␊ - * State of FTP / FTPS service.␊ - */␊ - ftpsState?: (("AllAllowed" | "FtpsOnly" | "Disabled") | string)␊ - /**␊ - * Handler mappings.␊ - */␊ - handlerMappings?: (HandlerMapping2[] | string)␊ - /**␊ - * Http20Enabled: configures a web site to allow clients to connect over http2.0␊ - */␊ - http20Enabled?: (boolean | string)␊ - /**␊ - * true if HTTP logging is enabled; otherwise, false.␊ - */␊ - httpLoggingEnabled?: (boolean | string)␊ - /**␊ - * IP security restrictions for main.␊ - */␊ - ipSecurityRestrictions?: (IpSecurityRestriction2[] | string)␊ - /**␊ - * Java container.␊ - */␊ - javaContainer?: string␊ - /**␊ - * Java container version.␊ - */␊ - javaContainerVersion?: string␊ - /**␊ - * Java version.␊ - */␊ - javaVersion?: string␊ - /**␊ - * Metric limits set on an app.␊ - */␊ - limits?: (SiteLimits2 | string)␊ - /**␊ - * Linux App Framework and version␊ - */␊ - linuxFxVersion?: string␊ - /**␊ - * Site load balancing.␊ - */␊ - loadBalancing?: (("WeightedRoundRobin" | "LeastRequests" | "LeastResponseTime" | "WeightedTotalTraffic" | "RequestHash") | string)␊ - /**␊ - * true to enable local MySQL; otherwise, false.␊ - */␊ - localMySqlEnabled?: (boolean | string)␊ - /**␊ - * HTTP logs directory size limit.␊ - */␊ - logsDirectorySizeLimit?: (number | string)␊ - /**␊ - * Managed pipeline mode.␊ - */␊ - managedPipelineMode?: (("Integrated" | "Classic") | string)␊ - /**␊ - * Managed Service Identity Id␊ - */␊ - managedServiceIdentityId?: (number | string)␊ - /**␊ - * MinTlsVersion: configures the minimum version of TLS required for SSL requests.␊ - */␊ - minTlsVersion?: (("1.0" | "1.1" | "1.2") | string)␊ - /**␊ - * .NET Framework version.␊ - */␊ - netFrameworkVersion?: string␊ - /**␊ - * Version of Node.js.␊ - */␊ - nodeVersion?: string␊ - /**␊ - * Number of workers.␊ - */␊ - numberOfWorkers?: (number | string)␊ - /**␊ - * Version of PHP.␊ - */␊ - phpVersion?: string␊ - /**␊ - * Publishing user name.␊ - */␊ - publishingUsername?: string␊ - /**␊ - * Push settings for the App.␊ - */␊ - push?: (PushSettings1 | string)␊ - /**␊ - * Version of Python.␊ - */␊ - pythonVersion?: string␊ - /**␊ - * true if remote debugging is enabled; otherwise, false.␊ - */␊ - remoteDebuggingEnabled?: (boolean | string)␊ - /**␊ - * Remote debugging version.␊ - */␊ - remoteDebuggingVersion?: string␊ - /**␊ - * true if request tracing is enabled; otherwise, false.␊ - */␊ - requestTracingEnabled?: (boolean | string)␊ - /**␊ - * Request tracing expiration time.␊ - */␊ - requestTracingExpirationTime?: string␊ - /**␊ - * Number of reserved instances.␊ - * This setting only applies to the Consumption Plan␊ - */␊ - reservedInstanceCount?: (number | string)␊ - /**␊ - * IP security restrictions for scm.␊ - */␊ - scmIpSecurityRestrictions?: (IpSecurityRestriction2[] | string)␊ - /**␊ - * IP security restrictions for scm to use main.␊ - */␊ - scmIpSecurityRestrictionsUseMain?: (boolean | string)␊ - /**␊ - * SCM type.␊ - */␊ - scmType?: (("None" | "Dropbox" | "Tfs" | "LocalGit" | "GitHub" | "CodePlexGit" | "CodePlexHg" | "BitbucketGit" | "BitbucketHg" | "ExternalGit" | "ExternalHg" | "OneDrive" | "VSO") | string)␊ - /**␊ - * Tracing options.␊ - */␊ - tracingOptions?: string␊ - /**␊ - * true to use 32-bit worker process; otherwise, false.␊ - */␊ - use32BitWorkerProcess?: (boolean | string)␊ - /**␊ - * Virtual applications.␊ - */␊ - virtualApplications?: (VirtualApplication2[] | string)␊ - /**␊ - * Virtual Network name.␊ - */␊ - vnetName?: string␊ - /**␊ - * true if WebSocket is enabled; otherwise, false.␊ - */␊ - webSocketsEnabled?: (boolean | string)␊ - /**␊ - * Xenon App Framework and version␊ - */␊ - windowsFxVersion?: string␊ - /**␊ - * Explicit Managed Service Identity Id␊ - */␊ - xManagedServiceIdentityId?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the formal API definition for the app.␊ - */␊ - export interface ApiDefinitionInfo2 {␊ - /**␊ - * The URL of the API definition.␊ - */␊ - url?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Rules that can be defined for auto-heal.␊ - */␊ - export interface AutoHealRules2 {␊ - /**␊ - * Actions which to take by the auto-heal module when a rule is triggered.␊ - */␊ - actions?: (AutoHealActions2 | string)␊ - /**␊ - * Triggers for auto-heal.␊ - */␊ - triggers?: (AutoHealTriggers2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Actions which to take by the auto-heal module when a rule is triggered.␊ - */␊ - export interface AutoHealActions2 {␊ - /**␊ - * Predefined action to be taken.␊ - */␊ - actionType?: (("Recycle" | "LogEvent" | "CustomAction") | string)␊ - /**␊ - * Custom action to be executed␊ - * when an auto heal rule is triggered.␊ - */␊ - customAction?: (AutoHealCustomAction2 | string)␊ - /**␊ - * Minimum time the process must execute␊ - * before taking the action␊ - */␊ - minProcessExecutionTime?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Custom action to be executed␊ - * when an auto heal rule is triggered.␊ - */␊ - export interface AutoHealCustomAction2 {␊ - /**␊ - * Executable to be run.␊ - */␊ - exe?: string␊ - /**␊ - * Parameters for the executable.␊ - */␊ - parameters?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Triggers for auto-heal.␊ - */␊ - export interface AutoHealTriggers2 {␊ - /**␊ - * A rule based on private bytes.␊ - */␊ - privateBytesInKB?: (number | string)␊ - /**␊ - * Trigger based on total requests.␊ - */␊ - requests?: (RequestsBasedTrigger2 | string)␊ - /**␊ - * Trigger based on request execution time.␊ - */␊ - slowRequests?: (SlowRequestsBasedTrigger2 | string)␊ - /**␊ - * A rule based on status codes.␊ - */␊ - statusCodes?: (StatusCodesBasedTrigger2[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trigger based on total requests.␊ - */␊ - export interface RequestsBasedTrigger2 {␊ - /**␊ - * Request Count.␊ - */␊ - count?: (number | string)␊ - /**␊ - * Time interval.␊ - */␊ - timeInterval?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trigger based on request execution time.␊ - */␊ - export interface SlowRequestsBasedTrigger2 {␊ - /**␊ - * Request Count.␊ - */␊ - count?: (number | string)␊ - /**␊ - * Time interval.␊ - */␊ - timeInterval?: string␊ - /**␊ - * Time taken.␊ - */␊ - timeTaken?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trigger based on status code.␊ - */␊ - export interface StatusCodesBasedTrigger2 {␊ - /**␊ - * Request Count.␊ - */␊ - count?: (number | string)␊ - /**␊ - * HTTP status code.␊ - */␊ - status?: (number | string)␊ - /**␊ - * Request Sub Status.␊ - */␊ - subStatus?: (number | string)␊ - /**␊ - * Time interval.␊ - */␊ - timeInterval?: string␊ - /**␊ - * Win32 error code.␊ - */␊ - win32Status?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Files or Blob Storage access information value for dictionary storage.␊ - */␊ - export interface AzureStorageInfoValue {␊ - /**␊ - * Access key for the storage account.␊ - */␊ - accessKey?: string␊ - /**␊ - * Name of the storage account.␊ - */␊ - accountName?: string␊ - /**␊ - * Path to mount the storage within the site's runtime environment.␊ - */␊ - mountPath?: string␊ - /**␊ - * Name of the file share (container name, for Blob storage).␊ - */␊ - shareName?: string␊ - /**␊ - * Type of storage.␊ - */␊ - type?: (("AzureFiles" | "AzureBlob") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Database connection string information.␊ - */␊ - export interface ConnStringInfo2 {␊ - /**␊ - * Connection string value.␊ - */␊ - connectionString?: string␊ - /**␊ - * Name of connection string.␊ - */␊ - name?: string␊ - /**␊ - * Type of database.␊ - */␊ - type?: (("MySql" | "SQLServer" | "SQLAzure" | "Custom" | "NotificationHub" | "ServiceBus" | "EventHub" | "ApiHub" | "DocDb" | "RedisCache" | "PostgreSQL") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Cross-Origin Resource Sharing (CORS) settings for the app.␊ - */␊ - export interface CorsSettings2 {␊ - /**␊ - * 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.␊ - */␊ - allowedOrigins?: (string[] | string)␊ - /**␊ - * Gets or sets whether CORS requests with credentials are allowed. See ␊ - * https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials␊ - * for more details.␊ - */␊ - supportCredentials?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Routing rules in production experiments.␊ - */␊ - export interface Experiments2 {␊ - /**␊ - * List of ramp-up rules.␊ - */␊ - rampUpRules?: (RampUpRule2[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance.␊ - */␊ - export interface RampUpRule2 {␊ - /**␊ - * Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.␊ - */␊ - actionHostName?: string␊ - /**␊ - * 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/␊ - */␊ - changeDecisionCallbackUrl?: string␊ - /**␊ - * Specifies interval in minutes to reevaluate ReroutePercentage.␊ - */␊ - changeIntervalInMinutes?: (number | string)␊ - /**␊ - * In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches ␊ - * MinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.␊ - * Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl.␊ - */␊ - changeStep?: (number | string)␊ - /**␊ - * Specifies upper boundary below which ReroutePercentage will stay.␊ - */␊ - maxReroutePercentage?: (number | string)␊ - /**␊ - * Specifies lower boundary above which ReroutePercentage will stay.␊ - */␊ - minReroutePercentage?: (number | string)␊ - /**␊ - * Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment.␊ - */␊ - name?: string␊ - /**␊ - * Percentage of the traffic which will be redirected to ActionHostName.␊ - */␊ - reroutePercentage?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * 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.␊ - */␊ - export interface HandlerMapping2 {␊ - /**␊ - * Command-line arguments to be passed to the script processor.␊ - */␊ - arguments?: string␊ - /**␊ - * Requests with this extension will be handled using the specified FastCGI application.␊ - */␊ - extension?: string␊ - /**␊ - * The absolute path to the FastCGI application.␊ - */␊ - scriptProcessor?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP security restriction on an app.␊ - */␊ - export interface IpSecurityRestriction2 {␊ - /**␊ - * Allow or Deny access for this IP range.␊ - */␊ - action?: string␊ - /**␊ - * IP restriction rule description.␊ - */␊ - description?: string␊ - /**␊ - * IP address the security restriction is valid for.␊ - * It can be in form of pure ipv4 address (required SubnetMask property) or␊ - * CIDR notation such as ipv4/mask (leading bit match). For CIDR,␊ - * SubnetMask property must not be specified.␊ - */␊ - ipAddress?: string␊ - /**␊ - * IP restriction rule name.␊ - */␊ - name?: string␊ - /**␊ - * Priority of IP restriction rule.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * Subnet mask for the range of IP addresses the restriction is valid for.␊ - */␊ - subnetMask?: string␊ - /**␊ - * (internal) Subnet traffic tag␊ - */␊ - subnetTrafficTag?: (number | string)␊ - /**␊ - * Defines what this IP filter will be used for. This is to support IP filtering on proxies.␊ - */␊ - tag?: (("Default" | "XffProxy") | string)␊ - /**␊ - * Virtual network resource id␊ - */␊ - vnetSubnetResourceId?: string␊ - /**␊ - * (internal) Vnet traffic tag␊ - */␊ - vnetTrafficTag?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Metric limits set on an app.␊ - */␊ - export interface SiteLimits2 {␊ - /**␊ - * Maximum allowed disk size usage in MB.␊ - */␊ - maxDiskSizeInMb?: (number | string)␊ - /**␊ - * Maximum allowed memory usage in MB.␊ - */␊ - maxMemoryInMb?: (number | string)␊ - /**␊ - * Maximum allowed CPU usage percentage.␊ - */␊ - maxPercentageCpu?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Push settings for the App.␊ - */␊ - export interface PushSettings1 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * PushSettings resource specific properties␊ - */␊ - properties?: (PushSettingsProperties1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * PushSettings resource specific properties␊ - */␊ - export interface PushSettingsProperties1 {␊ - /**␊ - * Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint.␊ - */␊ - dynamicTagsJson?: string␊ - /**␊ - * Gets or sets a flag indicating whether the Push endpoint is enabled.␊ - */␊ - isPushEnabled: (boolean | string)␊ - /**␊ - * 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.␊ - */␊ - tagsRequiringAuth?: string␊ - /**␊ - * Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.␊ - */␊ - tagWhitelistJson?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Virtual application in an app.␊ - */␊ - export interface VirtualApplication2 {␊ - /**␊ - * Physical path.␊ - */␊ - physicalPath?: string␊ - /**␊ - * true if preloading is enabled; otherwise, false.␊ - */␊ - preloadEnabled?: (boolean | string)␊ - /**␊ - * Virtual directories for virtual application.␊ - */␊ - virtualDirectories?: (VirtualDirectory2[] | string)␊ - /**␊ - * Virtual path.␊ - */␊ - virtualPath?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Directory for virtual application.␊ - */␊ - export interface VirtualDirectory2 {␊ - /**␊ - * Physical path.␊ - */␊ - physicalPath?: string␊ - /**␊ - * Path to virtual application.␊ - */␊ - virtualPath?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SiteAuthSettings resource specific properties␊ - */␊ - export interface SiteAuthSettingsProperties1 {␊ - /**␊ - * Login parameters to send to the OpenID Connect authorization endpoint when␊ - * a user logs in. Each parameter must be in the form "key=value".␊ - */␊ - additionalLoginParams?: (string[] | string)␊ - /**␊ - * 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.␊ - */␊ - allowedAudiences?: (string[] | string)␊ - /**␊ - * 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.␊ - */␊ - allowedExternalRedirectUrls?: (string[] | string)␊ - /**␊ - * 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␊ - */␊ - clientId?: string␊ - /**␊ - * 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␊ - */␊ - clientSecret?: string␊ - /**␊ - * An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as␊ - * a replacement for the Client Secret. It is also optional.␊ - */␊ - clientSecretCertificateThumbprint?: string␊ - /**␊ - * 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".␊ - */␊ - defaultProvider?: (("AzureActiveDirectory" | "Facebook" | "Google" | "MicrosoftAccount" | "Twitter") | string)␊ - /**␊ - * true if the Authentication / Authorization feature is enabled for the current app; otherwise, false.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * 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␊ - */␊ - facebookAppId?: string␊ - /**␊ - * 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␊ - */␊ - facebookAppSecret?: string␊ - /**␊ - * 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␊ - */␊ - facebookOAuthScopes?: (string[] | string)␊ - /**␊ - * 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/␊ - */␊ - googleClientId?: string␊ - /**␊ - * 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/␊ - */␊ - googleClientSecret?: string␊ - /**␊ - * 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/␊ - */␊ - googleOAuthScopes?: (string[] | string)␊ - /**␊ - * 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␊ - */␊ - issuer?: string␊ - /**␊ - * 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␊ - */␊ - microsoftAccountClientId?: string␊ - /**␊ - * 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␊ - */␊ - microsoftAccountClientSecret?: string␊ - /**␊ - * 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␊ - */␊ - microsoftAccountOAuthScopes?: (string[] | string)␊ - /**␊ - * 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.␊ - */␊ - runtimeVersion?: string␊ - /**␊ - * 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.␊ - */␊ - tokenRefreshExtensionHours?: (number | string)␊ - /**␊ - * true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.␊ - * The default is false.␊ - */␊ - tokenStoreEnabled?: (boolean | string)␊ - /**␊ - * 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␊ - */␊ - twitterConsumerKey?: string␊ - /**␊ - * 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␊ - */␊ - twitterConsumerSecret?: string␊ - /**␊ - * The action to take when an unauthenticated client attempts to access the app.␊ - */␊ - unauthenticatedClientAction?: (("RedirectToLoginPage" | "AllowAnonymous") | string)␊ - /**␊ - * Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such.␊ - */␊ - validateIssuer?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * BackupRequest resource specific properties␊ - */␊ - export interface BackupRequestProperties2 {␊ - /**␊ - * Name of the backup.␊ - */␊ - backupName?: string␊ - /**␊ - * Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy.␊ - */␊ - backupSchedule?: (BackupSchedule2 | string)␊ - /**␊ - * Databases included in the backup.␊ - */␊ - databases?: (DatabaseBackupSetting2[] | string)␊ - /**␊ - * True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * SAS URL to the container.␊ - */␊ - storageAccountUrl: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy.␊ - */␊ - export interface BackupSchedule2 {␊ - /**␊ - * 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)␊ - */␊ - frequencyInterval: ((number & string) | string)␊ - /**␊ - * 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).␊ - */␊ - frequencyUnit: (("Day" | "Hour") | string)␊ - /**␊ - * True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise.␊ - */␊ - keepAtLeastOneBackup: (boolean | string)␊ - /**␊ - * After how many days backups should be deleted.␊ - */␊ - retentionPeriodInDays: ((number & string) | string)␊ - /**␊ - * When the schedule should start working.␊ - */␊ - startTime?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Database backup settings.␊ - */␊ - export interface DatabaseBackupSetting2 {␊ - /**␊ - * 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.␊ - */␊ - connectionString?: string␊ - /**␊ - * Contains a connection string name that is linked to the SiteConfig.ConnectionStrings.␊ - * This is used during restore with overwrite connection strings options.␊ - */␊ - connectionStringName?: string␊ - /**␊ - * Database type (e.g. SqlAzure / MySql).␊ - */␊ - databaseType: (("SqlAzure" | "MySql" | "LocalMySql" | "PostgreSql") | string)␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Database connection string value to type pair.␊ - */␊ - export interface ConnStringValueTypePair2 {␊ - /**␊ - * Type of database.␊ - */␊ - type: (("MySql" | "SQLServer" | "SQLAzure" | "Custom" | "NotificationHub" | "ServiceBus" | "EventHub" | "ApiHub" | "DocDb" | "RedisCache" | "PostgreSQL") | string)␊ - /**␊ - * Value of pair.␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SiteLogsConfig resource specific properties␊ - */␊ - export interface SiteLogsConfigProperties2 {␊ - /**␊ - * Application logs configuration.␊ - */␊ - applicationLogs?: (ApplicationLogsConfig2 | string)␊ - /**␊ - * Enabled configuration.␊ - */␊ - detailedErrorMessages?: (EnabledConfig2 | string)␊ - /**␊ - * Enabled configuration.␊ - */␊ - failedRequestsTracing?: (EnabledConfig2 | string)␊ - /**␊ - * Http logs configuration.␊ - */␊ - httpLogs?: (HttpLogsConfig2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application logs configuration.␊ - */␊ - export interface ApplicationLogsConfig2 {␊ - /**␊ - * Application logs azure blob storage configuration.␊ - */␊ - azureBlobStorage?: (AzureBlobStorageApplicationLogsConfig2 | string)␊ - /**␊ - * Application logs to Azure table storage configuration.␊ - */␊ - azureTableStorage?: (AzureTableStorageApplicationLogsConfig2 | string)␊ - /**␊ - * Application logs to file system configuration.␊ - */␊ - fileSystem?: (FileSystemApplicationLogsConfig2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application logs azure blob storage configuration.␊ - */␊ - export interface AzureBlobStorageApplicationLogsConfig2 {␊ - /**␊ - * Log level.␊ - */␊ - level?: (("Off" | "Verbose" | "Information" | "Warning" | "Error") | string)␊ - /**␊ - * Retention in days.␊ - * Remove blobs older than X days.␊ - * 0 or lower means no retention.␊ - */␊ - retentionInDays?: (number | string)␊ - /**␊ - * SAS url to a azure blob container with read/write/list/delete permissions.␊ - */␊ - sasUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application logs to Azure table storage configuration.␊ - */␊ - export interface AzureTableStorageApplicationLogsConfig2 {␊ - /**␊ - * Log level.␊ - */␊ - level?: (("Off" | "Verbose" | "Information" | "Warning" | "Error") | string)␊ - /**␊ - * SAS URL to an Azure table with add/query/delete permissions.␊ - */␊ - sasUrl: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application logs to file system configuration.␊ - */␊ - export interface FileSystemApplicationLogsConfig2 {␊ - /**␊ - * Log level.␊ - */␊ - level?: (("Off" | "Verbose" | "Information" | "Warning" | "Error") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Enabled configuration.␊ - */␊ - export interface EnabledConfig2 {␊ - /**␊ - * True if configuration is enabled, false if it is disabled and null if configuration is not set.␊ - */␊ - enabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http logs configuration.␊ - */␊ - export interface HttpLogsConfig2 {␊ - /**␊ - * Http logs to azure blob storage configuration.␊ - */␊ - azureBlobStorage?: (AzureBlobStorageHttpLogsConfig2 | string)␊ - /**␊ - * Http logs to file system configuration.␊ - */␊ - fileSystem?: (FileSystemHttpLogsConfig2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http logs to azure blob storage configuration.␊ - */␊ - export interface AzureBlobStorageHttpLogsConfig2 {␊ - /**␊ - * True if configuration is enabled, false if it is disabled and null if configuration is not set.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Retention in days.␊ - * Remove blobs older than X days.␊ - * 0 or lower means no retention.␊ - */␊ - retentionInDays?: (number | string)␊ - /**␊ - * SAS url to a azure blob container with read/write/list/delete permissions.␊ - */␊ - sasUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http logs to file system configuration.␊ - */␊ - export interface FileSystemHttpLogsConfig2 {␊ - /**␊ - * True if configuration is enabled, false if it is disabled and null if configuration is not set.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Retention in days.␊ - * Remove files older than X days.␊ - * 0 or lower means no retention.␊ - */␊ - retentionInDays?: (number | string)␊ - /**␊ - * 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.␊ - */␊ - retentionInMb?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Names for connection strings, application settings, and external Azure storage account configuration␊ - * identifiers 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.␊ - */␊ - export interface SlotConfigNames1 {␊ - /**␊ - * List of application settings names.␊ - */␊ - appSettingNames?: (string[] | string)␊ - /**␊ - * List of external Azure storage account identifiers.␊ - */␊ - azureStorageConfigNames?: (string[] | string)␊ - /**␊ - * List of connection string names.␊ - */␊ - connectionStringNames?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/deployments␊ - */␊ - export interface SitesDeploymentsChildResource2 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * ID of an existing deployment.␊ - */␊ - name: string␊ - /**␊ - * Deployment resource specific properties␊ - */␊ - properties: (DeploymentProperties4 | string)␊ - type: "deployments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Deployment resource specific properties␊ - */␊ - export interface DeploymentProperties4 {␊ - /**␊ - * True if deployment is currently active, false if completed and null if not started.␊ - */␊ - active?: (boolean | string)␊ - /**␊ - * Who authored the deployment.␊ - */␊ - author?: string␊ - /**␊ - * Author email.␊ - */␊ - author_email?: string␊ - /**␊ - * Who performed the deployment.␊ - */␊ - deployer?: string␊ - /**␊ - * Details on deployment.␊ - */␊ - details?: string␊ - /**␊ - * End time.␊ - */␊ - end_time?: string␊ - /**␊ - * Details about deployment status.␊ - */␊ - message?: string␊ - /**␊ - * Start time.␊ - */␊ - start_time?: string␊ - /**␊ - * Deployment status.␊ - */␊ - status?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/domainOwnershipIdentifiers␊ - */␊ - export interface SitesDomainOwnershipIdentifiersChildResource1 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of domain ownership identifier.␊ - */␊ - name: string␊ - /**␊ - * Identifier resource specific properties␊ - */␊ - properties: (IdentifierProperties1 | string)␊ - type: "domainOwnershipIdentifiers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identifier resource specific properties␊ - */␊ - export interface IdentifierProperties1 {␊ - /**␊ - * String representation of the identity.␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/extensions␊ - */␊ - export interface SitesExtensionsChildResource1 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "MSDeploy"␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - properties: (MSDeployCore1 | string)␊ - type: "extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - export interface MSDeployCore1 {␊ - /**␊ - * Sets the AppOffline rule while the MSDeploy operation executes.␊ - * Setting is false by default.␊ - */␊ - appOffline?: (boolean | string)␊ - /**␊ - * SQL Connection String␊ - */␊ - connectionString?: string␊ - /**␊ - * Database Type␊ - */␊ - dbType?: string␊ - /**␊ - * Package URI␊ - */␊ - packageUri?: string␊ - /**␊ - * MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used.␊ - */␊ - setParameters?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * URI of MSDeploy Parameters file. Must not be set if SetParameters is used.␊ - */␊ - setParametersXmlFileUri?: string␊ - /**␊ - * 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.␊ - */␊ - skipAppData?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/functions␊ - */␊ - export interface SitesFunctionsChildResource1 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Function name.␊ - */␊ - name: string␊ - /**␊ - * FunctionEnvelope resource specific properties␊ - */␊ - properties: (FunctionEnvelopeProperties1 | string)␊ - type: "functions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * FunctionEnvelope resource specific properties␊ - */␊ - export interface FunctionEnvelopeProperties1 {␊ - /**␊ - * Config information.␊ - */␊ - config?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Config URI.␊ - */␊ - config_href?: string␊ - /**␊ - * File list.␊ - */␊ - files?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Function App ID.␊ - */␊ - function_app_id?: string␊ - /**␊ - * Function URI.␊ - */␊ - href?: string␊ - /**␊ - * The invocation URL␊ - */␊ - invoke_url_template?: string␊ - /**␊ - * Value indicating whether the function is disabled␊ - */␊ - isDisabled?: (boolean | string)␊ - /**␊ - * The function language␊ - */␊ - language?: string␊ - /**␊ - * Script URI.␊ - */␊ - script_href?: string␊ - /**␊ - * Script root path URI.␊ - */␊ - script_root_path_href?: string␊ - /**␊ - * Secrets file URI.␊ - */␊ - secrets_file_href?: string␊ - /**␊ - * Test data used when testing via the Azure Portal.␊ - */␊ - test_data?: string␊ - /**␊ - * Test data URI.␊ - */␊ - test_data_href?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/hostNameBindings␊ - */␊ - export interface SitesHostNameBindingsChildResource2 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Hostname in the hostname binding.␊ - */␊ - name: string␊ - /**␊ - * HostNameBinding resource specific properties␊ - */␊ - properties: (HostNameBindingProperties2 | string)␊ - type: "hostNameBindings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HostNameBinding resource specific properties␊ - */␊ - export interface HostNameBindingProperties2 {␊ - /**␊ - * Azure resource name.␊ - */␊ - azureResourceName?: string␊ - /**␊ - * Azure resource type.␊ - */␊ - azureResourceType?: (("Website" | "TrafficManager") | string)␊ - /**␊ - * Custom DNS record type.␊ - */␊ - customHostNameDnsRecordType?: (("CName" | "A") | string)␊ - /**␊ - * Fully qualified ARM domain resource URI.␊ - */␊ - domainId?: string␊ - /**␊ - * Hostname type.␊ - */␊ - hostNameType?: (("Verified" | "Managed") | string)␊ - /**␊ - * App Service app name.␊ - */␊ - siteName?: string␊ - /**␊ - * SSL type.␊ - */␊ - sslState?: (("Disabled" | "SniEnabled" | "IpBasedEnabled") | string)␊ - /**␊ - * SSL certificate thumbprint␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/hybridconnection␊ - */␊ - export interface SitesHybridconnectionChildResource2 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the hybrid connection configuration.␊ - */␊ - name: string␊ - /**␊ - * RelayServiceConnectionEntity resource specific properties␊ - */␊ - properties: (RelayServiceConnectionEntityProperties2 | string)␊ - type: "hybridconnection"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * RelayServiceConnectionEntity resource specific properties␊ - */␊ - export interface RelayServiceConnectionEntityProperties2 {␊ - biztalkUri?: string␊ - entityConnectionString?: string␊ - entityName?: string␊ - hostname?: string␊ - port?: (number | string)␊ - resourceConnectionString?: string␊ - resourceType?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/migrate␊ - */␊ - export interface SitesMigrateChildResource1 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "migrate"␊ - /**␊ - * StorageMigrationOptions resource specific properties␊ - */␊ - properties: (StorageMigrationOptionsProperties1 | string)␊ - type: "migrate"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * StorageMigrationOptions resource specific properties␊ - */␊ - export interface StorageMigrationOptionsProperties1 {␊ - /**␊ - * AzureFiles connection string.␊ - */␊ - azurefilesConnectionString: string␊ - /**␊ - * AzureFiles share.␊ - */␊ - azurefilesShare: string␊ - /**␊ - * true if the app should be read only during copy operation; otherwise, false.␊ - */␊ - blockWriteAccessToSite?: (boolean | string)␊ - /**␊ - * trueif the app should be switched over; otherwise, false.␊ - */␊ - switchSiteAfterMigration?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/networkConfig␊ - */␊ - export interface SitesNetworkConfigChildResource {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "virtualNetwork"␊ - /**␊ - * SwiftVirtualNetwork resource specific properties␊ - */␊ - properties: (SwiftVirtualNetworkProperties | string)␊ - type: "networkConfig"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SwiftVirtualNetwork resource specific properties␊ - */␊ - export interface SwiftVirtualNetworkProperties {␊ - /**␊ - * The Virtual Network subnet's resource ID. This is the subnet that this Web App will join. This subnet must have a delegation to Microsoft.Web/serverFarms defined first.␊ - */␊ - subnetResourceId?: string␊ - /**␊ - * A flag that specifies if the scale unit this Web App is on supports Swift integration.␊ - */␊ - swiftSupported?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/premieraddons␊ - */␊ - export interface SitesPremieraddonsChildResource2 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Add-on name.␊ - */␊ - name: string␊ - /**␊ - * PremierAddOn resource specific properties␊ - */␊ - properties: (PremierAddOnProperties1 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "premieraddons"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * PremierAddOn resource specific properties␊ - */␊ - export interface PremierAddOnProperties1 {␊ - /**␊ - * Premier add on Marketplace offer.␊ - */␊ - marketplaceOffer?: string␊ - /**␊ - * Premier add on Marketplace publisher.␊ - */␊ - marketplacePublisher?: string␊ - /**␊ - * Premier add on Product.␊ - */␊ - product?: string␊ - /**␊ - * Premier add on SKU.␊ - */␊ - sku?: string␊ - /**␊ - * Premier add on Vendor.␊ - */␊ - vendor?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/privateAccess␊ - */␊ - export interface SitesPrivateAccessChildResource {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "virtualNetworks"␊ - /**␊ - * PrivateAccess resource specific properties␊ - */␊ - properties: (PrivateAccessProperties | string)␊ - type: "privateAccess"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * PrivateAccess resource specific properties␊ - */␊ - export interface PrivateAccessProperties {␊ - /**␊ - * Whether private access is enabled or not.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * The Virtual Networks (and subnets) allowed to access the site privately.␊ - */␊ - virtualNetworks?: (PrivateAccessVirtualNetwork[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a Virtual Network that is useable for private site access.␊ - */␊ - export interface PrivateAccessVirtualNetwork {␊ - /**␊ - * The key (ID) of the Virtual Network.␊ - */␊ - key?: (number | string)␊ - /**␊ - * The name of the Virtual Network.␊ - */␊ - name?: string␊ - /**␊ - * The ARM uri of the Virtual Network␊ - */␊ - resourceId?: string␊ - /**␊ - * A List of subnets that access is allowed to on this Virtual Network. An empty array (but not null) is interpreted to mean that all subnets are allowed within this Virtual Network.␊ - */␊ - subnets?: (PrivateAccessSubnet[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a Virtual Network subnet that is useable for private site access.␊ - */␊ - export interface PrivateAccessSubnet {␊ - /**␊ - * The key (ID) of the subnet.␊ - */␊ - key?: (number | string)␊ - /**␊ - * The name of the subnet.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/publicCertificates␊ - */␊ - export interface SitesPublicCertificatesChildResource1 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Public certificate name.␊ - */␊ - name: string␊ - /**␊ - * PublicCertificate resource specific properties␊ - */␊ - properties: (PublicCertificateProperties1 | string)␊ - type: "publicCertificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * PublicCertificate resource specific properties␊ - */␊ - export interface PublicCertificateProperties1 {␊ - /**␊ - * Public Certificate byte array␊ - */␊ - blob?: string␊ - /**␊ - * Public Certificate Location.␊ - */␊ - publicCertificateLocation?: (("CurrentUserMy" | "LocalMachineMy" | "Unknown") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/siteextensions␊ - */␊ - export interface SitesSiteextensionsChildResource1 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Site extension name.␊ - */␊ - name: string␊ - type: "siteextensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots␊ - */␊ - export interface SitesSlotsChildResource2 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Managed service identity.␊ - */␊ - identity?: (ManagedServiceIdentity15 | string)␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the deployment slot to create or update. The name 'production' is reserved.␊ - */␊ - name: string␊ - /**␊ - * Site resource specific properties␊ - */␊ - properties: (SiteProperties2 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "slots"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/sourcecontrols␊ - */␊ - export interface SitesSourcecontrolsChildResource2 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "web"␊ - /**␊ - * SiteSourceControl resource specific properties␊ - */␊ - properties: (SiteSourceControlProperties2 | string)␊ - type: "sourcecontrols"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SiteSourceControl resource specific properties␊ - */␊ - export interface SiteSourceControlProperties2 {␊ - /**␊ - * Name of branch to use for deployment.␊ - */␊ - branch?: string␊ - /**␊ - * true to enable deployment rollback; otherwise, false.␊ - */␊ - deploymentRollbackEnabled?: (boolean | string)␊ - /**␊ - * true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub).␊ - */␊ - isManualIntegration?: (boolean | string)␊ - /**␊ - * true for a Mercurial repository; false for a Git repository.␊ - */␊ - isMercurial?: (boolean | string)␊ - /**␊ - * Repository or source control URL.␊ - */␊ - repoUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/virtualNetworkConnections␊ - */␊ - export interface SitesVirtualNetworkConnectionsChildResource2 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of an existing Virtual Network.␊ - */␊ - name: string␊ - /**␊ - * VnetInfo resource specific properties␊ - */␊ - properties: (VnetInfoProperties2 | string)␊ - type: "virtualNetworkConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VnetInfo resource specific properties␊ - */␊ - export interface VnetInfoProperties2 {␊ - /**␊ - * A certificate file (.cer) blob containing the public key of the private key used to authenticate a ␊ - * Point-To-Site VPN connection.␊ - */␊ - certBlob?: string␊ - /**␊ - * DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses.␊ - */␊ - dnsServers?: string␊ - /**␊ - * Flag that is used to denote if this is VNET injection␊ - */␊ - isSwift?: (boolean | string)␊ - /**␊ - * The Virtual Network's resource ID.␊ - */␊ - vnetResourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/deployments␊ - */␊ - export interface SitesDeployments2 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * ID of an existing deployment.␊ - */␊ - name: string␊ - /**␊ - * Deployment resource specific properties␊ - */␊ - properties: (DeploymentProperties4 | string)␊ - type: "Microsoft.Web/sites/deployments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/domainOwnershipIdentifiers␊ - */␊ - export interface SitesDomainOwnershipIdentifiers1 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of domain ownership identifier.␊ - */␊ - name: string␊ - /**␊ - * Identifier resource specific properties␊ - */␊ - properties: (IdentifierProperties1 | string)␊ - type: "Microsoft.Web/sites/domainOwnershipIdentifiers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/extensions␊ - */␊ - export interface SitesExtensions1 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - properties: (MSDeployCore1 | string)␊ - type: "Microsoft.Web/sites/extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/functions␊ - */␊ - export interface SitesFunctions1 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Function name.␊ - */␊ - name: string␊ - /**␊ - * FunctionEnvelope resource specific properties␊ - */␊ - properties: (FunctionEnvelopeProperties1 | string)␊ - resources?: SitesFunctionsKeysChildResource[]␊ - type: "Microsoft.Web/sites/functions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/functions/keys␊ - */␊ - export interface SitesFunctionsKeysChildResource {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * The name of the key.␊ - */␊ - name: string␊ - type: "keys"␊ - /**␊ - * Key value␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/functions/keys␊ - */␊ - export interface SitesFunctionsKeys {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * The name of the key.␊ - */␊ - name: string␊ - type: "Microsoft.Web/sites/functions/keys"␊ - /**␊ - * Key value␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/hostNameBindings␊ - */␊ - export interface SitesHostNameBindings2 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Hostname in the hostname binding.␊ - */␊ - name: string␊ - /**␊ - * HostNameBinding resource specific properties␊ - */␊ - properties: (HostNameBindingProperties2 | string)␊ - type: "Microsoft.Web/sites/hostNameBindings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/hybridconnection␊ - */␊ - export interface SitesHybridconnection2 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the hybrid connection configuration.␊ - */␊ - name: string␊ - /**␊ - * RelayServiceConnectionEntity resource specific properties␊ - */␊ - properties: (RelayServiceConnectionEntityProperties2 | string)␊ - type: "Microsoft.Web/sites/hybridconnection"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/hybridConnectionNamespaces/relays␊ - */␊ - export interface SitesHybridConnectionNamespacesRelays1 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * The relay name for this hybrid connection.␊ - */␊ - name: string␊ - /**␊ - * HybridConnection resource specific properties␊ - */␊ - properties: (HybridConnectionProperties3 | string)␊ - type: "Microsoft.Web/sites/hybridConnectionNamespaces/relays"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HybridConnection resource specific properties␊ - */␊ - export interface HybridConnectionProperties3 {␊ - /**␊ - * The hostname of the endpoint.␊ - */␊ - hostname?: string␊ - /**␊ - * The port of the endpoint.␊ - */␊ - port?: (number | string)␊ - /**␊ - * The ARM URI to the Service Bus relay.␊ - */␊ - relayArmUri?: string␊ - /**␊ - * The name of the Service Bus relay.␊ - */␊ - relayName?: string␊ - /**␊ - * The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus.␊ - */␊ - sendKeyName?: string␊ - /**␊ - * 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.␊ - */␊ - sendKeyValue?: string␊ - /**␊ - * The name of the Service Bus namespace.␊ - */␊ - serviceBusNamespace?: string␊ - /**␊ - * The suffix for the service bus endpoint. By default this is .servicebus.windows.net␊ - */␊ - serviceBusSuffix?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/instances/extensions␊ - */␊ - export interface SitesInstancesExtensions1 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - properties: (MSDeployCore1 | string)␊ - type: "Microsoft.Web/sites/instances/extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/migrate␊ - */␊ - export interface SitesMigrate1 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * StorageMigrationOptions resource specific properties␊ - */␊ - properties: (StorageMigrationOptionsProperties1 | string)␊ - type: "Microsoft.Web/sites/migrate"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/networkConfig␊ - */␊ - export interface SitesNetworkConfig {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SwiftVirtualNetwork resource specific properties␊ - */␊ - properties: (SwiftVirtualNetworkProperties | string)␊ - type: "Microsoft.Web/sites/networkConfig"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/premieraddons␊ - */␊ - export interface SitesPremieraddons2 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Add-on name.␊ - */␊ - name: string␊ - /**␊ - * PremierAddOn resource specific properties␊ - */␊ - properties: (PremierAddOnProperties1 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/sites/premieraddons"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/privateAccess␊ - */␊ - export interface SitesPrivateAccess {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * PrivateAccess resource specific properties␊ - */␊ - properties: (PrivateAccessProperties | string)␊ - type: "Microsoft.Web/sites/privateAccess"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/publicCertificates␊ - */␊ - export interface SitesPublicCertificates1 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Public certificate name.␊ - */␊ - name: string␊ - /**␊ - * PublicCertificate resource specific properties␊ - */␊ - properties: (PublicCertificateProperties1 | string)␊ - type: "Microsoft.Web/sites/publicCertificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/siteextensions␊ - */␊ - export interface SitesSiteextensions1 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Site extension name.␊ - */␊ - name: string␊ - type: "Microsoft.Web/sites/siteextensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots␊ - */␊ - export interface SitesSlots2 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Managed service identity.␊ - */␊ - identity?: (ManagedServiceIdentity15 | string)␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the deployment slot to create or update. The name 'production' is reserved.␊ - */␊ - name: string␊ - /**␊ - * Site resource specific properties␊ - */␊ - properties: (SiteProperties2 | string)␊ - resources?: (SitesSlotsConfigChildResource2 | SitesSlotsDeploymentsChildResource2 | SitesSlotsDomainOwnershipIdentifiersChildResource1 | SitesSlotsExtensionsChildResource1 | SitesSlotsFunctionsChildResource1 | SitesSlotsHostNameBindingsChildResource2 | SitesSlotsHybridconnectionChildResource2 | SitesSlotsNetworkConfigChildResource | SitesSlotsPremieraddonsChildResource2 | SitesSlotsPrivateAccessChildResource | SitesSlotsPublicCertificatesChildResource1 | SitesSlotsSiteextensionsChildResource1 | SitesSlotsSourcecontrolsChildResource2 | SitesSlotsVirtualNetworkConnectionsChildResource2)[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/sites/slots"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/deployments␊ - */␊ - export interface SitesSlotsDeploymentsChildResource2 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * ID of an existing deployment.␊ - */␊ - name: string␊ - /**␊ - * Deployment resource specific properties␊ - */␊ - properties: (DeploymentProperties4 | string)␊ - type: "deployments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/domainOwnershipIdentifiers␊ - */␊ - export interface SitesSlotsDomainOwnershipIdentifiersChildResource1 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of domain ownership identifier.␊ - */␊ - name: string␊ - /**␊ - * Identifier resource specific properties␊ - */␊ - properties: (IdentifierProperties1 | string)␊ - type: "domainOwnershipIdentifiers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/extensions␊ - */␊ - export interface SitesSlotsExtensionsChildResource1 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "MSDeploy"␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - properties: (MSDeployCore1 | string)␊ - type: "extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/functions␊ - */␊ - export interface SitesSlotsFunctionsChildResource1 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Function name.␊ - */␊ - name: string␊ - /**␊ - * FunctionEnvelope resource specific properties␊ - */␊ - properties: (FunctionEnvelopeProperties1 | string)␊ - type: "functions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/hostNameBindings␊ - */␊ - export interface SitesSlotsHostNameBindingsChildResource2 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Hostname in the hostname binding.␊ - */␊ - name: string␊ - /**␊ - * HostNameBinding resource specific properties␊ - */␊ - properties: (HostNameBindingProperties2 | string)␊ - type: "hostNameBindings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/hybridconnection␊ - */␊ - export interface SitesSlotsHybridconnectionChildResource2 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the hybrid connection configuration.␊ - */␊ - name: string␊ - /**␊ - * RelayServiceConnectionEntity resource specific properties␊ - */␊ - properties: (RelayServiceConnectionEntityProperties2 | string)␊ - type: "hybridconnection"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/networkConfig␊ - */␊ - export interface SitesSlotsNetworkConfigChildResource {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "virtualNetwork"␊ - /**␊ - * SwiftVirtualNetwork resource specific properties␊ - */␊ - properties: (SwiftVirtualNetworkProperties | string)␊ - type: "networkConfig"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/premieraddons␊ - */␊ - export interface SitesSlotsPremieraddonsChildResource2 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Add-on name.␊ - */␊ - name: string␊ - /**␊ - * PremierAddOn resource specific properties␊ - */␊ - properties: (PremierAddOnProperties1 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "premieraddons"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/privateAccess␊ - */␊ - export interface SitesSlotsPrivateAccessChildResource {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "virtualNetworks"␊ - /**␊ - * PrivateAccess resource specific properties␊ - */␊ - properties: (PrivateAccessProperties | string)␊ - type: "privateAccess"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/publicCertificates␊ - */␊ - export interface SitesSlotsPublicCertificatesChildResource1 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Public certificate name.␊ - */␊ - name: string␊ - /**␊ - * PublicCertificate resource specific properties␊ - */␊ - properties: (PublicCertificateProperties1 | string)␊ - type: "publicCertificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/siteextensions␊ - */␊ - export interface SitesSlotsSiteextensionsChildResource1 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Site extension name.␊ - */␊ - name: string␊ - type: "siteextensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/sourcecontrols␊ - */␊ - export interface SitesSlotsSourcecontrolsChildResource2 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "web"␊ - /**␊ - * SiteSourceControl resource specific properties␊ - */␊ - properties: (SiteSourceControlProperties2 | string)␊ - type: "sourcecontrols"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/virtualNetworkConnections␊ - */␊ - export interface SitesSlotsVirtualNetworkConnectionsChildResource2 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of an existing Virtual Network.␊ - */␊ - name: string␊ - /**␊ - * VnetInfo resource specific properties␊ - */␊ - properties: (VnetInfoProperties2 | string)␊ - type: "virtualNetworkConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/deployments␊ - */␊ - export interface SitesSlotsDeployments2 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * ID of an existing deployment.␊ - */␊ - name: string␊ - /**␊ - * Deployment resource specific properties␊ - */␊ - properties: (DeploymentProperties4 | string)␊ - type: "Microsoft.Web/sites/slots/deployments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/domainOwnershipIdentifiers␊ - */␊ - export interface SitesSlotsDomainOwnershipIdentifiers1 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of domain ownership identifier.␊ - */␊ - name: string␊ - /**␊ - * Identifier resource specific properties␊ - */␊ - properties: (IdentifierProperties1 | string)␊ - type: "Microsoft.Web/sites/slots/domainOwnershipIdentifiers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/extensions␊ - */␊ - export interface SitesSlotsExtensions1 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - properties: (MSDeployCore1 | string)␊ - type: "Microsoft.Web/sites/slots/extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/functions␊ - */␊ - export interface SitesSlotsFunctions1 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Function name.␊ - */␊ - name: string␊ - /**␊ - * FunctionEnvelope resource specific properties␊ - */␊ - properties: (FunctionEnvelopeProperties1 | string)␊ - resources?: SitesSlotsFunctionsKeysChildResource[]␊ - type: "Microsoft.Web/sites/slots/functions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/functions/keys␊ - */␊ - export interface SitesSlotsFunctionsKeysChildResource {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * The name of the key.␊ - */␊ - name: string␊ - type: "keys"␊ - /**␊ - * Key value␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/functions/keys␊ - */␊ - export interface SitesSlotsFunctionsKeys {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * The name of the key.␊ - */␊ - name: string␊ - type: "Microsoft.Web/sites/slots/functions/keys"␊ - /**␊ - * Key value␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/hostNameBindings␊ - */␊ - export interface SitesSlotsHostNameBindings2 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Hostname in the hostname binding.␊ - */␊ - name: string␊ - /**␊ - * HostNameBinding resource specific properties␊ - */␊ - properties: (HostNameBindingProperties2 | string)␊ - type: "Microsoft.Web/sites/slots/hostNameBindings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/hybridconnection␊ - */␊ - export interface SitesSlotsHybridconnection2 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the hybrid connection configuration.␊ - */␊ - name: string␊ - /**␊ - * RelayServiceConnectionEntity resource specific properties␊ - */␊ - properties: (RelayServiceConnectionEntityProperties2 | string)␊ - type: "Microsoft.Web/sites/slots/hybridconnection"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays␊ - */␊ - export interface SitesSlotsHybridConnectionNamespacesRelays1 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * The relay name for this hybrid connection.␊ - */␊ - name: string␊ - /**␊ - * HybridConnection resource specific properties␊ - */␊ - properties: (HybridConnectionProperties3 | string)␊ - type: "Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/instances/extensions␊ - */␊ - export interface SitesSlotsInstancesExtensions1 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - properties: (MSDeployCore1 | string)␊ - type: "Microsoft.Web/sites/slots/instances/extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/networkConfig␊ - */␊ - export interface SitesSlotsNetworkConfig {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SwiftVirtualNetwork resource specific properties␊ - */␊ - properties: (SwiftVirtualNetworkProperties | string)␊ - type: "Microsoft.Web/sites/slots/networkConfig"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/premieraddons␊ - */␊ - export interface SitesSlotsPremieraddons2 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Add-on name.␊ - */␊ - name: string␊ - /**␊ - * PremierAddOn resource specific properties␊ - */␊ - properties: (PremierAddOnProperties1 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/sites/slots/premieraddons"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/privateAccess␊ - */␊ - export interface SitesSlotsPrivateAccess {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * PrivateAccess resource specific properties␊ - */␊ - properties: (PrivateAccessProperties | string)␊ - type: "Microsoft.Web/sites/slots/privateAccess"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/publicCertificates␊ - */␊ - export interface SitesSlotsPublicCertificates1 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Public certificate name.␊ - */␊ - name: string␊ - /**␊ - * PublicCertificate resource specific properties␊ - */␊ - properties: (PublicCertificateProperties1 | string)␊ - type: "Microsoft.Web/sites/slots/publicCertificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/siteextensions␊ - */␊ - export interface SitesSlotsSiteextensions1 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Site extension name.␊ - */␊ - name: string␊ - type: "Microsoft.Web/sites/slots/siteextensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/sourcecontrols␊ - */␊ - export interface SitesSlotsSourcecontrols2 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteSourceControl resource specific properties␊ - */␊ - properties: (SiteSourceControlProperties2 | string)␊ - type: "Microsoft.Web/sites/slots/sourcecontrols"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/virtualNetworkConnections␊ - */␊ - export interface SitesSlotsVirtualNetworkConnections2 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of an existing Virtual Network.␊ - */␊ - name: string␊ - /**␊ - * VnetInfo resource specific properties␊ - */␊ - properties: (VnetInfoProperties2 | string)␊ - resources?: SitesSlotsVirtualNetworkConnectionsGatewaysChildResource2[]␊ - type: "Microsoft.Web/sites/slots/virtualNetworkConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/virtualNetworkConnections/gateways␊ - */␊ - export interface SitesSlotsVirtualNetworkConnectionsGatewaysChildResource2 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the gateway. Currently, the only supported string is "primary".␊ - */␊ - name: string␊ - /**␊ - * VnetGateway resource specific properties␊ - */␊ - properties: (VnetGatewayProperties3 | string)␊ - type: "gateways"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/virtualNetworkConnections/gateways␊ - */␊ - export interface SitesSlotsVirtualNetworkConnectionsGateways2 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the gateway. Currently, the only supported string is "primary".␊ - */␊ - name: string␊ - /**␊ - * VnetGateway resource specific properties␊ - */␊ - properties: (VnetGatewayProperties3 | string)␊ - type: "Microsoft.Web/sites/slots/virtualNetworkConnections/gateways"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/sourcecontrols␊ - */␊ - export interface SitesSourcecontrols2 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteSourceControl resource specific properties␊ - */␊ - properties: (SiteSourceControlProperties2 | string)␊ - type: "Microsoft.Web/sites/sourcecontrols"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/virtualNetworkConnections␊ - */␊ - export interface SitesVirtualNetworkConnections2 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of an existing Virtual Network.␊ - */␊ - name: string␊ - /**␊ - * VnetInfo resource specific properties␊ - */␊ - properties: (VnetInfoProperties2 | string)␊ - resources?: SitesVirtualNetworkConnectionsGatewaysChildResource2[]␊ - type: "Microsoft.Web/sites/virtualNetworkConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/virtualNetworkConnections/gateways␊ - */␊ - export interface SitesVirtualNetworkConnectionsGatewaysChildResource2 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the gateway. Currently, the only supported string is "primary".␊ - */␊ - name: string␊ - /**␊ - * VnetGateway resource specific properties␊ - */␊ - properties: (VnetGatewayProperties3 | string)␊ - type: "gateways"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/virtualNetworkConnections/gateways␊ - */␊ - export interface SitesVirtualNetworkConnectionsGateways2 {␊ - apiVersion: "2018-02-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the gateway. Currently, the only supported string is "primary".␊ - */␊ - name: string␊ - /**␊ - * VnetGateway resource specific properties␊ - */␊ - properties: (VnetGatewayProperties3 | string)␊ - type: "Microsoft.Web/sites/virtualNetworkConnections/gateways"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/certificates␊ - */␊ - export interface Certificates3 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the certificate.␊ - */␊ - name: string␊ - /**␊ - * Certificate resource specific properties␊ - */␊ - properties: (CertificateProperties3 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/certificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Certificate resource specific properties␊ - */␊ - export interface CertificateProperties3 {␊ - /**␊ - * Host names the certificate applies to.␊ - */␊ - hostNames?: (string[] | string)␊ - /**␊ - * Key Vault Csm resource Id.␊ - */␊ - keyVaultId?: string␊ - /**␊ - * Key Vault secret name.␊ - */␊ - keyVaultSecretName?: string␊ - /**␊ - * Certificate password.␊ - */␊ - password: string␊ - /**␊ - * Pfx blob.␊ - */␊ - pfxBlob?: string␊ - /**␊ - * Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".␊ - */␊ - serverFarmId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites␊ - */␊ - export interface Sites3 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Managed service identity.␊ - */␊ - identity?: (ManagedServiceIdentity16 | string)␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Unique name of the app to create or update. To create or update a deployment slot, use the {slot} parameter.␊ - */␊ - name: string␊ - /**␊ - * Site resource specific properties␊ - */␊ - properties: (SiteProperties3 | string)␊ - resources?: (SitesConfigChildResource3 | SitesDeploymentsChildResource3 | SitesDomainOwnershipIdentifiersChildResource2 | SitesExtensionsChildResource2 | SitesFunctionsChildResource2 | SitesHostNameBindingsChildResource3 | SitesHybridconnectionChildResource3 | SitesMigrateChildResource2 | SitesNetworkConfigChildResource1 | SitesPremieraddonsChildResource3 | SitesPrivateAccessChildResource1 | SitesPublicCertificatesChildResource2 | SitesSiteextensionsChildResource2 | SitesSlotsChildResource3 | SitesSourcecontrolsChildResource3 | SitesVirtualNetworkConnectionsChildResource3)[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/sites"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Managed service identity.␊ - */␊ - export interface ManagedServiceIdentity16 {␊ - /**␊ - * Type of managed service identity.␊ - */␊ - type?: (("SystemAssigned" | "UserAssigned" | "SystemAssigned, UserAssigned" | "None") | string)␊ - /**␊ - * The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}␊ - */␊ - userAssignedIdentities?: ({␊ - [k: string]: Components1Jq1T4Ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties2␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - export interface Components1Jq1T4Ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties2 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Site resource specific properties␊ - */␊ - export interface SiteProperties3 {␊ - /**␊ - * 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.␊ - */␊ - clientAffinityEnabled?: (boolean | string)␊ - /**␊ - * true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.␊ - */␊ - clientCertEnabled?: (boolean | string)␊ - /**␊ - * client certificate authentication comma-separated exclusion paths␊ - */␊ - clientCertExclusionPaths?: string␊ - /**␊ - * Information needed for cloning operation.␊ - */␊ - cloningInfo?: (CloningInfo3 | string)␊ - /**␊ - * Size of the function container.␊ - */␊ - containerSize?: (number | string)␊ - /**␊ - * Maximum allowed daily memory-time quota (applicable on dynamic apps only).␊ - */␊ - dailyMemoryTimeQuota?: (number | string)␊ - /**␊ - * true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * GeoDistributions for this site␊ - */␊ - geoDistributions?: (GeoDistribution1[] | string)␊ - /**␊ - * Specification for an App Service Environment to use for this resource.␊ - */␊ - hostingEnvironmentProfile?: (HostingEnvironmentProfile4 | string)␊ - /**␊ - * true to disable the public hostnames of the app; otherwise, false.␊ - * If true, the app is only accessible via API management process.␊ - */␊ - hostNamesDisabled?: (boolean | string)␊ - /**␊ - * Hostname SSL states are used to manage the SSL bindings for app's hostnames.␊ - */␊ - hostNameSslStates?: (HostNameSslState3[] | string)␊ - /**␊ - * HttpsOnly: configures a web site to accept only https requests. Issues redirect for␊ - * http requests␊ - */␊ - httpsOnly?: (boolean | string)␊ - /**␊ - * Hyper-V sandbox.␊ - */␊ - hyperV?: (boolean | string)␊ - /**␊ - * Obsolete: Hyper-V sandbox.␊ - */␊ - isXenon?: (boolean | string)␊ - /**␊ - * Site redundancy mode.␊ - */␊ - redundancyMode?: (("None" | "Manual" | "Failover" | "ActiveActive" | "GeoRedundant") | string)␊ - /**␊ - * true if reserved; otherwise, false.␊ - */␊ - reserved?: (boolean | string)␊ - /**␊ - * true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.␊ - */␊ - scmSiteAlsoStopped?: (boolean | string)␊ - /**␊ - * Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".␊ - */␊ - serverFarmId?: string␊ - /**␊ - * Configuration of an App Service app.␊ - */␊ - siteConfig?: (SiteConfig3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information needed for cloning operation.␊ - */␊ - export interface CloningInfo3 {␊ - /**␊ - * 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.␊ - */␊ - appSettingsOverrides?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * true to clone custom hostnames from source app; otherwise, false.␊ - */␊ - cloneCustomHostNames?: (boolean | string)␊ - /**␊ - * true to clone source control from source app; otherwise, false.␊ - */␊ - cloneSourceControl?: (boolean | string)␊ - /**␊ - * true to configure load balancing for source and destination app.␊ - */␊ - configureLoadBalancing?: (boolean | string)␊ - /**␊ - * Correlation ID of cloning operation. This ID ties multiple cloning operations␊ - * together to use the same snapshot.␊ - */␊ - correlationId?: string␊ - /**␊ - * App Service Environment.␊ - */␊ - hostingEnvironment?: string␊ - /**␊ - * true to overwrite destination app; otherwise, false.␊ - */␊ - overwrite?: (boolean | string)␊ - /**␊ - * 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.␊ - */␊ - sourceWebAppId: string␊ - /**␊ - * Location of source app ex: West US or North Europe␊ - */␊ - sourceWebAppLocation?: string␊ - /**␊ - * 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}.␊ - */␊ - trafficManagerProfileId?: string␊ - /**␊ - * Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist.␊ - */␊ - trafficManagerProfileName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A global distribution definition.␊ - */␊ - export interface GeoDistribution1 {␊ - /**␊ - * Location.␊ - */␊ - location?: string␊ - /**␊ - * NumberOfWorkers.␊ - */␊ - numberOfWorkers?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specification for an App Service Environment to use for this resource.␊ - */␊ - export interface HostingEnvironmentProfile4 {␊ - /**␊ - * Resource ID of the App Service Environment.␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSL-enabled hostname.␊ - */␊ - export interface HostNameSslState3 {␊ - /**␊ - * Indicates whether the hostname is a standard or repository hostname.␊ - */␊ - hostType?: (("Standard" | "Repository") | string)␊ - /**␊ - * Hostname.␊ - */␊ - name?: string␊ - /**␊ - * SSL type.␊ - */␊ - sslState?: (("Disabled" | "SniEnabled" | "IpBasedEnabled") | string)␊ - /**␊ - * SSL certificate thumbprint.␊ - */␊ - thumbprint?: string␊ - /**␊ - * Set to true to update existing hostname.␊ - */␊ - toUpdate?: (boolean | string)␊ - /**␊ - * Virtual IP address assigned to the hostname if IP based SSL is enabled.␊ - */␊ - virtualIP?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Configuration of an App Service app.␊ - */␊ - export interface SiteConfig3 {␊ - /**␊ - * true if Always On is enabled; otherwise, false.␊ - */␊ - alwaysOn?: (boolean | string)␊ - /**␊ - * Information about the formal API definition for the app.␊ - */␊ - apiDefinition?: (ApiDefinitionInfo3 | string)␊ - /**␊ - * App command line to launch.␊ - */␊ - appCommandLine?: string␊ - /**␊ - * Application settings.␊ - */␊ - appSettings?: (NameValuePair4[] | string)␊ - /**␊ - * true if Auto Heal is enabled; otherwise, false.␊ - */␊ - autoHealEnabled?: (boolean | string)␊ - /**␊ - * Rules that can be defined for auto-heal.␊ - */␊ - autoHealRules?: (AutoHealRules3 | string)␊ - /**␊ - * Auto-swap slot name.␊ - */␊ - autoSwapSlotName?: string␊ - /**␊ - * User-provided Azure storage accounts.␊ - */␊ - azureStorageAccounts?: ({␊ - [k: string]: AzureStorageInfoValue1␊ - } | string)␊ - /**␊ - * Connection strings.␊ - */␊ - connectionStrings?: (ConnStringInfo3[] | string)␊ - /**␊ - * Cross-Origin Resource Sharing (CORS) settings for the app.␊ - */␊ - cors?: (CorsSettings3 | string)␊ - /**␊ - * Default documents.␊ - */␊ - defaultDocuments?: (string[] | string)␊ - /**␊ - * true if detailed error logging is enabled; otherwise, false.␊ - */␊ - detailedErrorLoggingEnabled?: (boolean | string)␊ - /**␊ - * Document root.␊ - */␊ - documentRoot?: string␊ - /**␊ - * Routing rules in production experiments.␊ - */␊ - experiments?: (Experiments3 | string)␊ - /**␊ - * State of FTP / FTPS service.␊ - */␊ - ftpsState?: (("AllAllowed" | "FtpsOnly" | "Disabled") | string)␊ - /**␊ - * Handler mappings.␊ - */␊ - handlerMappings?: (HandlerMapping3[] | string)␊ - /**␊ - * Http20Enabled: configures a web site to allow clients to connect over http2.0␊ - */␊ - http20Enabled?: (boolean | string)␊ - /**␊ - * true if HTTP logging is enabled; otherwise, false.␊ - */␊ - httpLoggingEnabled?: (boolean | string)␊ - /**␊ - * IP security restrictions for main.␊ - */␊ - ipSecurityRestrictions?: (IpSecurityRestriction3[] | string)␊ - /**␊ - * Java container.␊ - */␊ - javaContainer?: string␊ - /**␊ - * Java container version.␊ - */␊ - javaContainerVersion?: string␊ - /**␊ - * Java version.␊ - */␊ - javaVersion?: string␊ - /**␊ - * Metric limits set on an app.␊ - */␊ - limits?: (SiteLimits3 | string)␊ - /**␊ - * Linux App Framework and version␊ - */␊ - linuxFxVersion?: string␊ - /**␊ - * Site load balancing.␊ - */␊ - loadBalancing?: (("WeightedRoundRobin" | "LeastRequests" | "LeastResponseTime" | "WeightedTotalTraffic" | "RequestHash") | string)␊ - /**␊ - * true to enable local MySQL; otherwise, false.␊ - */␊ - localMySqlEnabled?: (boolean | string)␊ - /**␊ - * HTTP logs directory size limit.␊ - */␊ - logsDirectorySizeLimit?: (number | string)␊ - /**␊ - * Managed pipeline mode.␊ - */␊ - managedPipelineMode?: (("Integrated" | "Classic") | string)␊ - /**␊ - * Managed Service Identity Id␊ - */␊ - managedServiceIdentityId?: (number | string)␊ - /**␊ - * MinTlsVersion: configures the minimum version of TLS required for SSL requests.␊ - */␊ - minTlsVersion?: (("1.0" | "1.1" | "1.2") | string)␊ - /**␊ - * .NET Framework version.␊ - */␊ - netFrameworkVersion?: string␊ - /**␊ - * Version of Node.js.␊ - */␊ - nodeVersion?: string␊ - /**␊ - * Number of workers.␊ - */␊ - numberOfWorkers?: (number | string)␊ - /**␊ - * Version of PHP.␊ - */␊ - phpVersion?: string␊ - /**␊ - * Publishing user name.␊ - */␊ - publishingUsername?: string␊ - /**␊ - * Push settings for the App.␊ - */␊ - push?: (PushSettings2 | string)␊ - /**␊ - * Version of Python.␊ - */␊ - pythonVersion?: string␊ - /**␊ - * true if remote debugging is enabled; otherwise, false.␊ - */␊ - remoteDebuggingEnabled?: (boolean | string)␊ - /**␊ - * Remote debugging version.␊ - */␊ - remoteDebuggingVersion?: string␊ - /**␊ - * true if request tracing is enabled; otherwise, false.␊ - */␊ - requestTracingEnabled?: (boolean | string)␊ - /**␊ - * Request tracing expiration time.␊ - */␊ - requestTracingExpirationTime?: string␊ - /**␊ - * Number of reserved instances.␊ - * This setting only applies to the Consumption Plan␊ - */␊ - reservedInstanceCount?: (number | string)␊ - /**␊ - * IP security restrictions for scm.␊ - */␊ - scmIpSecurityRestrictions?: (IpSecurityRestriction3[] | string)␊ - /**␊ - * IP security restrictions for scm to use main.␊ - */␊ - scmIpSecurityRestrictionsUseMain?: (boolean | string)␊ - /**␊ - * SCM type.␊ - */␊ - scmType?: (("None" | "Dropbox" | "Tfs" | "LocalGit" | "GitHub" | "CodePlexGit" | "CodePlexHg" | "BitbucketGit" | "BitbucketHg" | "ExternalGit" | "ExternalHg" | "OneDrive" | "VSO") | string)␊ - /**␊ - * Tracing options.␊ - */␊ - tracingOptions?: string␊ - /**␊ - * true to use 32-bit worker process; otherwise, false.␊ - */␊ - use32BitWorkerProcess?: (boolean | string)␊ - /**␊ - * Virtual applications.␊ - */␊ - virtualApplications?: (VirtualApplication3[] | string)␊ - /**␊ - * Virtual Network name.␊ - */␊ - vnetName?: string␊ - /**␊ - * true if WebSocket is enabled; otherwise, false.␊ - */␊ - webSocketsEnabled?: (boolean | string)␊ - /**␊ - * Xenon App Framework and version␊ - */␊ - windowsFxVersion?: string␊ - /**␊ - * Explicit Managed Service Identity Id␊ - */␊ - xManagedServiceIdentityId?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the formal API definition for the app.␊ - */␊ - export interface ApiDefinitionInfo3 {␊ - /**␊ - * The URL of the API definition.␊ - */␊ - url?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Name value pair.␊ - */␊ - export interface NameValuePair4 {␊ - /**␊ - * Pair name.␊ - */␊ - name?: string␊ - /**␊ - * Pair value.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Rules that can be defined for auto-heal.␊ - */␊ - export interface AutoHealRules3 {␊ - /**␊ - * Actions which to take by the auto-heal module when a rule is triggered.␊ - */␊ - actions?: (AutoHealActions3 | string)␊ - /**␊ - * Triggers for auto-heal.␊ - */␊ - triggers?: (AutoHealTriggers3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Actions which to take by the auto-heal module when a rule is triggered.␊ - */␊ - export interface AutoHealActions3 {␊ - /**␊ - * Predefined action to be taken.␊ - */␊ - actionType?: (("Recycle" | "LogEvent" | "CustomAction") | string)␊ - /**␊ - * Custom action to be executed␊ - * when an auto heal rule is triggered.␊ - */␊ - customAction?: (AutoHealCustomAction3 | string)␊ - /**␊ - * Minimum time the process must execute␊ - * before taking the action␊ - */␊ - minProcessExecutionTime?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Custom action to be executed␊ - * when an auto heal rule is triggered.␊ - */␊ - export interface AutoHealCustomAction3 {␊ - /**␊ - * Executable to be run.␊ - */␊ - exe?: string␊ - /**␊ - * Parameters for the executable.␊ - */␊ - parameters?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Triggers for auto-heal.␊ - */␊ - export interface AutoHealTriggers3 {␊ - /**␊ - * A rule based on private bytes.␊ - */␊ - privateBytesInKB?: (number | string)␊ - /**␊ - * Trigger based on total requests.␊ - */␊ - requests?: (RequestsBasedTrigger3 | string)␊ - /**␊ - * Trigger based on request execution time.␊ - */␊ - slowRequests?: (SlowRequestsBasedTrigger3 | string)␊ - /**␊ - * A rule based on status codes.␊ - */␊ - statusCodes?: (StatusCodesBasedTrigger3[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trigger based on total requests.␊ - */␊ - export interface RequestsBasedTrigger3 {␊ - /**␊ - * Request Count.␊ - */␊ - count?: (number | string)␊ - /**␊ - * Time interval.␊ - */␊ - timeInterval?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trigger based on request execution time.␊ - */␊ - export interface SlowRequestsBasedTrigger3 {␊ - /**␊ - * Request Count.␊ - */␊ - count?: (number | string)␊ - /**␊ - * Time interval.␊ - */␊ - timeInterval?: string␊ - /**␊ - * Time taken.␊ - */␊ - timeTaken?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trigger based on status code.␊ - */␊ - export interface StatusCodesBasedTrigger3 {␊ - /**␊ - * Request Count.␊ - */␊ - count?: (number | string)␊ - /**␊ - * HTTP status code.␊ - */␊ - status?: (number | string)␊ - /**␊ - * Request Sub Status.␊ - */␊ - subStatus?: (number | string)␊ - /**␊ - * Time interval.␊ - */␊ - timeInterval?: string␊ - /**␊ - * Win32 error code.␊ - */␊ - win32Status?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Files or Blob Storage access information value for dictionary storage.␊ - */␊ - export interface AzureStorageInfoValue1 {␊ - /**␊ - * Access key for the storage account.␊ - */␊ - accessKey?: string␊ - /**␊ - * Name of the storage account.␊ - */␊ - accountName?: string␊ - /**␊ - * Path to mount the storage within the site's runtime environment.␊ - */␊ - mountPath?: string␊ - /**␊ - * Name of the file share (container name, for Blob storage).␊ - */␊ - shareName?: string␊ - /**␊ - * Type of storage.␊ - */␊ - type?: (("AzureFiles" | "AzureBlob") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Database connection string information.␊ - */␊ - export interface ConnStringInfo3 {␊ - /**␊ - * Connection string value.␊ - */␊ - connectionString?: string␊ - /**␊ - * Name of connection string.␊ - */␊ - name?: string␊ - /**␊ - * Type of database.␊ - */␊ - type?: (("MySql" | "SQLServer" | "SQLAzure" | "Custom" | "NotificationHub" | "ServiceBus" | "EventHub" | "ApiHub" | "DocDb" | "RedisCache" | "PostgreSQL") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Cross-Origin Resource Sharing (CORS) settings for the app.␊ - */␊ - export interface CorsSettings3 {␊ - /**␊ - * 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.␊ - */␊ - allowedOrigins?: (string[] | string)␊ - /**␊ - * Gets or sets whether CORS requests with credentials are allowed. See ␊ - * https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials␊ - * for more details.␊ - */␊ - supportCredentials?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Routing rules in production experiments.␊ - */␊ - export interface Experiments3 {␊ - /**␊ - * List of ramp-up rules.␊ - */␊ - rampUpRules?: (RampUpRule3[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance.␊ - */␊ - export interface RampUpRule3 {␊ - /**␊ - * Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.␊ - */␊ - actionHostName?: string␊ - /**␊ - * 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/␊ - */␊ - changeDecisionCallbackUrl?: string␊ - /**␊ - * Specifies interval in minutes to reevaluate ReroutePercentage.␊ - */␊ - changeIntervalInMinutes?: (number | string)␊ - /**␊ - * In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches ␊ - * MinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.␊ - * Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl.␊ - */␊ - changeStep?: (number | string)␊ - /**␊ - * Specifies upper boundary below which ReroutePercentage will stay.␊ - */␊ - maxReroutePercentage?: (number | string)␊ - /**␊ - * Specifies lower boundary above which ReroutePercentage will stay.␊ - */␊ - minReroutePercentage?: (number | string)␊ - /**␊ - * Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment.␊ - */␊ - name?: string␊ - /**␊ - * Percentage of the traffic which will be redirected to ActionHostName.␊ - */␊ - reroutePercentage?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * 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.␊ - */␊ - export interface HandlerMapping3 {␊ - /**␊ - * Command-line arguments to be passed to the script processor.␊ - */␊ - arguments?: string␊ - /**␊ - * Requests with this extension will be handled using the specified FastCGI application.␊ - */␊ - extension?: string␊ - /**␊ - * The absolute path to the FastCGI application.␊ - */␊ - scriptProcessor?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP security restriction on an app.␊ - */␊ - export interface IpSecurityRestriction3 {␊ - /**␊ - * Allow or Deny access for this IP range.␊ - */␊ - action?: string␊ - /**␊ - * IP restriction rule description.␊ - */␊ - description?: string␊ - /**␊ - * IP address the security restriction is valid for.␊ - * It can be in form of pure ipv4 address (required SubnetMask property) or␊ - * CIDR notation such as ipv4/mask (leading bit match). For CIDR,␊ - * SubnetMask property must not be specified.␊ - */␊ - ipAddress?: string␊ - /**␊ - * IP restriction rule name.␊ - */␊ - name?: string␊ - /**␊ - * Priority of IP restriction rule.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * Subnet mask for the range of IP addresses the restriction is valid for.␊ - */␊ - subnetMask?: string␊ - /**␊ - * (internal) Subnet traffic tag␊ - */␊ - subnetTrafficTag?: (number | string)␊ - /**␊ - * Defines what this IP filter will be used for. This is to support IP filtering on proxies.␊ - */␊ - tag?: (("Default" | "XffProxy") | string)␊ - /**␊ - * Virtual network resource id␊ - */␊ - vnetSubnetResourceId?: string␊ - /**␊ - * (internal) Vnet traffic tag␊ - */␊ - vnetTrafficTag?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Metric limits set on an app.␊ - */␊ - export interface SiteLimits3 {␊ - /**␊ - * Maximum allowed disk size usage in MB.␊ - */␊ - maxDiskSizeInMb?: (number | string)␊ - /**␊ - * Maximum allowed memory usage in MB.␊ - */␊ - maxMemoryInMb?: (number | string)␊ - /**␊ - * Maximum allowed CPU usage percentage.␊ - */␊ - maxPercentageCpu?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Push settings for the App.␊ - */␊ - export interface PushSettings2 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * PushSettings resource specific properties␊ - */␊ - properties?: (PushSettingsProperties2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * PushSettings resource specific properties␊ - */␊ - export interface PushSettingsProperties2 {␊ - /**␊ - * Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint.␊ - */␊ - dynamicTagsJson?: string␊ - /**␊ - * Gets or sets a flag indicating whether the Push endpoint is enabled.␊ - */␊ - isPushEnabled: (boolean | string)␊ - /**␊ - * 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.␊ - */␊ - tagsRequiringAuth?: string␊ - /**␊ - * Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.␊ - */␊ - tagWhitelistJson?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Virtual application in an app.␊ - */␊ - export interface VirtualApplication3 {␊ - /**␊ - * Physical path.␊ - */␊ - physicalPath?: string␊ - /**␊ - * true if preloading is enabled; otherwise, false.␊ - */␊ - preloadEnabled?: (boolean | string)␊ - /**␊ - * Virtual directories for virtual application.␊ - */␊ - virtualDirectories?: (VirtualDirectory3[] | string)␊ - /**␊ - * Virtual path.␊ - */␊ - virtualPath?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Directory for virtual application.␊ - */␊ - export interface VirtualDirectory3 {␊ - /**␊ - * Physical path.␊ - */␊ - physicalPath?: string␊ - /**␊ - * Path to virtual application.␊ - */␊ - virtualPath?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SiteAuthSettings resource specific properties␊ - */␊ - export interface SiteAuthSettingsProperties2 {␊ - /**␊ - * Login parameters to send to the OpenID Connect authorization endpoint when␊ - * a user logs in. Each parameter must be in the form "key=value".␊ - */␊ - additionalLoginParams?: (string[] | string)␊ - /**␊ - * 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.␊ - */␊ - allowedAudiences?: (string[] | string)␊ - /**␊ - * 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.␊ - */␊ - allowedExternalRedirectUrls?: (string[] | string)␊ - /**␊ - * 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␊ - */␊ - clientId?: string␊ - /**␊ - * 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␊ - */␊ - clientSecret?: string␊ - /**␊ - * An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as␊ - * a replacement for the Client Secret. It is also optional.␊ - */␊ - clientSecretCertificateThumbprint?: string␊ - /**␊ - * 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".␊ - */␊ - defaultProvider?: (("AzureActiveDirectory" | "Facebook" | "Google" | "MicrosoftAccount" | "Twitter") | string)␊ - /**␊ - * true if the Authentication / Authorization feature is enabled for the current app; otherwise, false.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * 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␊ - */␊ - facebookAppId?: string␊ - /**␊ - * 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␊ - */␊ - facebookAppSecret?: string␊ - /**␊ - * 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␊ - */␊ - facebookOAuthScopes?: (string[] | string)␊ - /**␊ - * 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/␊ - */␊ - googleClientId?: string␊ - /**␊ - * 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/␊ - */␊ - googleClientSecret?: string␊ - /**␊ - * 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/␊ - */␊ - googleOAuthScopes?: (string[] | string)␊ - /**␊ - * 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␊ - */␊ - issuer?: string␊ - /**␊ - * 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␊ - */␊ - microsoftAccountClientId?: string␊ - /**␊ - * 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␊ - */␊ - microsoftAccountClientSecret?: string␊ - /**␊ - * 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␊ - */␊ - microsoftAccountOAuthScopes?: (string[] | string)␊ - /**␊ - * 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.␊ - */␊ - runtimeVersion?: string␊ - /**␊ - * 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.␊ - */␊ - tokenRefreshExtensionHours?: (number | string)␊ - /**␊ - * true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.␊ - * The default is false.␊ - */␊ - tokenStoreEnabled?: (boolean | string)␊ - /**␊ - * 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␊ - */␊ - twitterConsumerKey?: string␊ - /**␊ - * 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␊ - */␊ - twitterConsumerSecret?: string␊ - /**␊ - * The action to take when an unauthenticated client attempts to access the app.␊ - */␊ - unauthenticatedClientAction?: (("RedirectToLoginPage" | "AllowAnonymous") | string)␊ - /**␊ - * Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such.␊ - */␊ - validateIssuer?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * BackupRequest resource specific properties␊ - */␊ - export interface BackupRequestProperties3 {␊ - /**␊ - * Name of the backup.␊ - */␊ - backupName?: string␊ - /**␊ - * Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy.␊ - */␊ - backupSchedule?: (BackupSchedule3 | string)␊ - /**␊ - * Databases included in the backup.␊ - */␊ - databases?: (DatabaseBackupSetting3[] | string)␊ - /**␊ - * True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * SAS URL to the container.␊ - */␊ - storageAccountUrl: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy.␊ - */␊ - export interface BackupSchedule3 {␊ - /**␊ - * 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)␊ - */␊ - frequencyInterval: ((number & string) | string)␊ - /**␊ - * 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).␊ - */␊ - frequencyUnit: (("Day" | "Hour") | string)␊ - /**␊ - * True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise.␊ - */␊ - keepAtLeastOneBackup: (boolean | string)␊ - /**␊ - * After how many days backups should be deleted.␊ - */␊ - retentionPeriodInDays: ((number & string) | string)␊ - /**␊ - * When the schedule should start working.␊ - */␊ - startTime?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Database backup settings.␊ - */␊ - export interface DatabaseBackupSetting3 {␊ - /**␊ - * 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.␊ - */␊ - connectionString?: string␊ - /**␊ - * Contains a connection string name that is linked to the SiteConfig.ConnectionStrings.␊ - * This is used during restore with overwrite connection strings options.␊ - */␊ - connectionStringName?: string␊ - /**␊ - * Database type (e.g. SqlAzure / MySql).␊ - */␊ - databaseType: (("SqlAzure" | "MySql" | "LocalMySql" | "PostgreSql") | string)␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Database connection string value to type pair.␊ - */␊ - export interface ConnStringValueTypePair3 {␊ - /**␊ - * Type of database.␊ - */␊ - type: (("MySql" | "SQLServer" | "SQLAzure" | "Custom" | "NotificationHub" | "ServiceBus" | "EventHub" | "ApiHub" | "DocDb" | "RedisCache" | "PostgreSQL") | string)␊ - /**␊ - * Value of pair.␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SiteLogsConfig resource specific properties␊ - */␊ - export interface SiteLogsConfigProperties3 {␊ - /**␊ - * Application logs configuration.␊ - */␊ - applicationLogs?: (ApplicationLogsConfig3 | string)␊ - /**␊ - * Enabled configuration.␊ - */␊ - detailedErrorMessages?: (EnabledConfig3 | string)␊ - /**␊ - * Enabled configuration.␊ - */␊ - failedRequestsTracing?: (EnabledConfig3 | string)␊ - /**␊ - * Http logs configuration.␊ - */␊ - httpLogs?: (HttpLogsConfig3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application logs configuration.␊ - */␊ - export interface ApplicationLogsConfig3 {␊ - /**␊ - * Application logs azure blob storage configuration.␊ - */␊ - azureBlobStorage?: (AzureBlobStorageApplicationLogsConfig3 | string)␊ - /**␊ - * Application logs to Azure table storage configuration.␊ - */␊ - azureTableStorage?: (AzureTableStorageApplicationLogsConfig3 | string)␊ - /**␊ - * Application logs to file system configuration.␊ - */␊ - fileSystem?: (FileSystemApplicationLogsConfig3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application logs azure blob storage configuration.␊ - */␊ - export interface AzureBlobStorageApplicationLogsConfig3 {␊ - /**␊ - * Log level.␊ - */␊ - level?: (("Off" | "Verbose" | "Information" | "Warning" | "Error") | string)␊ - /**␊ - * Retention in days.␊ - * Remove blobs older than X days.␊ - * 0 or lower means no retention.␊ - */␊ - retentionInDays?: (number | string)␊ - /**␊ - * SAS url to a azure blob container with read/write/list/delete permissions.␊ - */␊ - sasUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application logs to Azure table storage configuration.␊ - */␊ - export interface AzureTableStorageApplicationLogsConfig3 {␊ - /**␊ - * Log level.␊ - */␊ - level?: (("Off" | "Verbose" | "Information" | "Warning" | "Error") | string)␊ - /**␊ - * SAS URL to an Azure table with add/query/delete permissions.␊ - */␊ - sasUrl: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application logs to file system configuration.␊ - */␊ - export interface FileSystemApplicationLogsConfig3 {␊ - /**␊ - * Log level.␊ - */␊ - level?: (("Off" | "Verbose" | "Information" | "Warning" | "Error") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Enabled configuration.␊ - */␊ - export interface EnabledConfig3 {␊ - /**␊ - * True if configuration is enabled, false if it is disabled and null if configuration is not set.␊ - */␊ - enabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http logs configuration.␊ - */␊ - export interface HttpLogsConfig3 {␊ - /**␊ - * Http logs to azure blob storage configuration.␊ - */␊ - azureBlobStorage?: (AzureBlobStorageHttpLogsConfig3 | string)␊ - /**␊ - * Http logs to file system configuration.␊ - */␊ - fileSystem?: (FileSystemHttpLogsConfig3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http logs to azure blob storage configuration.␊ - */␊ - export interface AzureBlobStorageHttpLogsConfig3 {␊ - /**␊ - * True if configuration is enabled, false if it is disabled and null if configuration is not set.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Retention in days.␊ - * Remove blobs older than X days.␊ - * 0 or lower means no retention.␊ - */␊ - retentionInDays?: (number | string)␊ - /**␊ - * SAS url to a azure blob container with read/write/list/delete permissions.␊ - */␊ - sasUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http logs to file system configuration.␊ - */␊ - export interface FileSystemHttpLogsConfig3 {␊ - /**␊ - * True if configuration is enabled, false if it is disabled and null if configuration is not set.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Retention in days.␊ - * Remove files older than X days.␊ - * 0 or lower means no retention.␊ - */␊ - retentionInDays?: (number | string)␊ - /**␊ - * 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.␊ - */␊ - retentionInMb?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Names for connection strings, application settings, and external Azure storage account configuration␊ - * identifiers 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.␊ - */␊ - export interface SlotConfigNames2 {␊ - /**␊ - * List of application settings names.␊ - */␊ - appSettingNames?: (string[] | string)␊ - /**␊ - * List of external Azure storage account identifiers.␊ - */␊ - azureStorageConfigNames?: (string[] | string)␊ - /**␊ - * List of connection string names.␊ - */␊ - connectionStringNames?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/deployments␊ - */␊ - export interface SitesDeploymentsChildResource3 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * ID of an existing deployment.␊ - */␊ - name: string␊ - /**␊ - * Deployment resource specific properties␊ - */␊ - properties: (DeploymentProperties5 | string)␊ - type: "deployments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Deployment resource specific properties␊ - */␊ - export interface DeploymentProperties5 {␊ - /**␊ - * True if deployment is currently active, false if completed and null if not started.␊ - */␊ - active?: (boolean | string)␊ - /**␊ - * Who authored the deployment.␊ - */␊ - author?: string␊ - /**␊ - * Author email.␊ - */␊ - author_email?: string␊ - /**␊ - * Who performed the deployment.␊ - */␊ - deployer?: string␊ - /**␊ - * Details on deployment.␊ - */␊ - details?: string␊ - /**␊ - * End time.␊ - */␊ - end_time?: string␊ - /**␊ - * Details about deployment status.␊ - */␊ - message?: string␊ - /**␊ - * Start time.␊ - */␊ - start_time?: string␊ - /**␊ - * Deployment status.␊ - */␊ - status?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/domainOwnershipIdentifiers␊ - */␊ - export interface SitesDomainOwnershipIdentifiersChildResource2 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of domain ownership identifier.␊ - */␊ - name: string␊ - /**␊ - * Identifier resource specific properties␊ - */␊ - properties: (IdentifierProperties2 | string)␊ - type: "domainOwnershipIdentifiers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identifier resource specific properties␊ - */␊ - export interface IdentifierProperties2 {␊ - /**␊ - * String representation of the identity.␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/extensions␊ - */␊ - export interface SitesExtensionsChildResource2 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "MSDeploy"␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - properties: (MSDeployCore2 | string)␊ - type: "extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - export interface MSDeployCore2 {␊ - /**␊ - * Sets the AppOffline rule while the MSDeploy operation executes.␊ - * Setting is false by default.␊ - */␊ - appOffline?: (boolean | string)␊ - /**␊ - * SQL Connection String␊ - */␊ - connectionString?: string␊ - /**␊ - * Database Type␊ - */␊ - dbType?: string␊ - /**␊ - * Package URI␊ - */␊ - packageUri?: string␊ - /**␊ - * MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used.␊ - */␊ - setParameters?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * URI of MSDeploy Parameters file. Must not be set if SetParameters is used.␊ - */␊ - setParametersXmlFileUri?: string␊ - /**␊ - * 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.␊ - */␊ - skipAppData?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/functions␊ - */␊ - export interface SitesFunctionsChildResource2 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Function name.␊ - */␊ - name: string␊ - /**␊ - * FunctionEnvelope resource specific properties␊ - */␊ - properties: (FunctionEnvelopeProperties2 | string)␊ - type: "functions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * FunctionEnvelope resource specific properties␊ - */␊ - export interface FunctionEnvelopeProperties2 {␊ - /**␊ - * Config information.␊ - */␊ - config?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Config URI.␊ - */␊ - config_href?: string␊ - /**␊ - * File list.␊ - */␊ - files?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Function App ID.␊ - */␊ - function_app_id?: string␊ - /**␊ - * Function URI.␊ - */␊ - href?: string␊ - /**␊ - * Script URI.␊ - */␊ - script_href?: string␊ - /**␊ - * Script root path URI.␊ - */␊ - script_root_path_href?: string␊ - /**␊ - * Secrets file URI.␊ - */␊ - secrets_file_href?: string␊ - /**␊ - * Test data used when testing via the Azure Portal.␊ - */␊ - test_data?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/hostNameBindings␊ - */␊ - export interface SitesHostNameBindingsChildResource3 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Hostname in the hostname binding.␊ - */␊ - name: string␊ - /**␊ - * HostNameBinding resource specific properties␊ - */␊ - properties: (HostNameBindingProperties3 | string)␊ - type: "hostNameBindings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HostNameBinding resource specific properties␊ - */␊ - export interface HostNameBindingProperties3 {␊ - /**␊ - * Azure resource name.␊ - */␊ - azureResourceName?: string␊ - /**␊ - * Azure resource type.␊ - */␊ - azureResourceType?: (("Website" | "TrafficManager") | string)␊ - /**␊ - * Custom DNS record type.␊ - */␊ - customHostNameDnsRecordType?: (("CName" | "A") | string)␊ - /**␊ - * Fully qualified ARM domain resource URI.␊ - */␊ - domainId?: string␊ - /**␊ - * Hostname type.␊ - */␊ - hostNameType?: (("Verified" | "Managed") | string)␊ - /**␊ - * App Service app name.␊ - */␊ - siteName?: string␊ - /**␊ - * SSL type.␊ - */␊ - sslState?: (("Disabled" | "SniEnabled" | "IpBasedEnabled") | string)␊ - /**␊ - * SSL certificate thumbprint␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/hybridconnection␊ - */␊ - export interface SitesHybridconnectionChildResource3 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the hybrid connection configuration.␊ - */␊ - name: string␊ - /**␊ - * RelayServiceConnectionEntity resource specific properties␊ - */␊ - properties: (RelayServiceConnectionEntityProperties3 | string)␊ - type: "hybridconnection"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * RelayServiceConnectionEntity resource specific properties␊ - */␊ - export interface RelayServiceConnectionEntityProperties3 {␊ - biztalkUri?: string␊ - entityConnectionString?: string␊ - entityName?: string␊ - hostname?: string␊ - port?: (number | string)␊ - resourceConnectionString?: string␊ - resourceType?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/migrate␊ - */␊ - export interface SitesMigrateChildResource2 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "migrate"␊ - /**␊ - * StorageMigrationOptions resource specific properties␊ - */␊ - properties: (StorageMigrationOptionsProperties2 | string)␊ - type: "migrate"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * StorageMigrationOptions resource specific properties␊ - */␊ - export interface StorageMigrationOptionsProperties2 {␊ - /**␊ - * AzureFiles connection string.␊ - */␊ - azurefilesConnectionString: string␊ - /**␊ - * AzureFiles share.␊ - */␊ - azurefilesShare: string␊ - /**␊ - * true if the app should be read only during copy operation; otherwise, false.␊ - */␊ - blockWriteAccessToSite?: (boolean | string)␊ - /**␊ - * trueif the app should be switched over; otherwise, false.␊ - */␊ - switchSiteAfterMigration?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/networkConfig␊ - */␊ - export interface SitesNetworkConfigChildResource1 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "virtualNetwork"␊ - /**␊ - * SwiftVirtualNetwork resource specific properties␊ - */␊ - properties: (SwiftVirtualNetworkProperties1 | string)␊ - type: "networkConfig"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SwiftVirtualNetwork resource specific properties␊ - */␊ - export interface SwiftVirtualNetworkProperties1 {␊ - /**␊ - * The Virtual Network subnet's resource ID. This is the subnet that this Web App will join. This subnet must have a delegation to Microsoft.Web/serverFarms defined first.␊ - */␊ - subnetResourceId?: string␊ - /**␊ - * A flag that specifies if the scale unit this Web App is on supports Swift integration.␊ - */␊ - swiftSupported?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/premieraddons␊ - */␊ - export interface SitesPremieraddonsChildResource3 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Add-on name.␊ - */␊ - name: string␊ - /**␊ - * PremierAddOn resource specific properties␊ - */␊ - properties: (PremierAddOnProperties2 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "premieraddons"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * PremierAddOn resource specific properties␊ - */␊ - export interface PremierAddOnProperties2 {␊ - /**␊ - * Premier add on Marketplace offer.␊ - */␊ - marketplaceOffer?: string␊ - /**␊ - * Premier add on Marketplace publisher.␊ - */␊ - marketplacePublisher?: string␊ - /**␊ - * Premier add on Product.␊ - */␊ - product?: string␊ - /**␊ - * Premier add on SKU.␊ - */␊ - sku?: string␊ - /**␊ - * Premier add on Vendor.␊ - */␊ - vendor?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/privateAccess␊ - */␊ - export interface SitesPrivateAccessChildResource1 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "virtualNetworks"␊ - /**␊ - * PrivateAccess resource specific properties␊ - */␊ - properties: (PrivateAccessProperties1 | string)␊ - type: "privateAccess"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * PrivateAccess resource specific properties␊ - */␊ - export interface PrivateAccessProperties1 {␊ - /**␊ - * Whether private access is enabled or not.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * The Virtual Networks (and subnets) allowed to access the site privately.␊ - */␊ - virtualNetworks?: (PrivateAccessVirtualNetwork1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a Virtual Network that is useable for private site access.␊ - */␊ - export interface PrivateAccessVirtualNetwork1 {␊ - /**␊ - * The key (ID) of the Virtual Network.␊ - */␊ - key?: (number | string)␊ - /**␊ - * The name of the Virtual Network.␊ - */␊ - name?: string␊ - /**␊ - * The ARM uri of the Virtual Network␊ - */␊ - resourceId?: string␊ - /**␊ - * A List of subnets that access is allowed to on this Virtual Network. An empty array (but not null) is interpreted to mean that all subnets are allowed within this Virtual Network.␊ - */␊ - subnets?: (PrivateAccessSubnet1[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a Virtual Network subnet that is useable for private site access.␊ - */␊ - export interface PrivateAccessSubnet1 {␊ - /**␊ - * The key (ID) of the subnet.␊ - */␊ - key?: (number | string)␊ - /**␊ - * The name of the subnet.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/publicCertificates␊ - */␊ - export interface SitesPublicCertificatesChildResource2 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Public certificate name.␊ - */␊ - name: string␊ - /**␊ - * PublicCertificate resource specific properties␊ - */␊ - properties: (PublicCertificateProperties2 | string)␊ - type: "publicCertificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * PublicCertificate resource specific properties␊ - */␊ - export interface PublicCertificateProperties2 {␊ - /**␊ - * Public Certificate byte array␊ - */␊ - blob?: string␊ - /**␊ - * Public Certificate Location.␊ - */␊ - publicCertificateLocation?: (("CurrentUserMy" | "LocalMachineMy" | "Unknown") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/siteextensions␊ - */␊ - export interface SitesSiteextensionsChildResource2 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Site extension name.␊ - */␊ - name: string␊ - type: "siteextensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots␊ - */␊ - export interface SitesSlotsChildResource3 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Managed service identity.␊ - */␊ - identity?: (ManagedServiceIdentity16 | string)␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the deployment slot to create or update. The name 'production' is reserved.␊ - */␊ - name: string␊ - /**␊ - * Site resource specific properties␊ - */␊ - properties: (SiteProperties3 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "slots"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/sourcecontrols␊ - */␊ - export interface SitesSourcecontrolsChildResource3 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "web"␊ - /**␊ - * SiteSourceControl resource specific properties␊ - */␊ - properties: (SiteSourceControlProperties3 | string)␊ - type: "sourcecontrols"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SiteSourceControl resource specific properties␊ - */␊ - export interface SiteSourceControlProperties3 {␊ - /**␊ - * Name of branch to use for deployment.␊ - */␊ - branch?: string␊ - /**␊ - * true to enable deployment rollback; otherwise, false.␊ - */␊ - deploymentRollbackEnabled?: (boolean | string)␊ - /**␊ - * true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub).␊ - */␊ - isManualIntegration?: (boolean | string)␊ - /**␊ - * true for a Mercurial repository; false for a Git repository.␊ - */␊ - isMercurial?: (boolean | string)␊ - /**␊ - * Repository or source control URL.␊ - */␊ - repoUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/virtualNetworkConnections␊ - */␊ - export interface SitesVirtualNetworkConnectionsChildResource3 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of an existing Virtual Network.␊ - */␊ - name: string␊ - /**␊ - * VnetInfo resource specific properties␊ - */␊ - properties: (VnetInfoProperties3 | string)␊ - type: "virtualNetworkConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VnetInfo resource specific properties␊ - */␊ - export interface VnetInfoProperties3 {␊ - /**␊ - * A certificate file (.cer) blob containing the public key of the private key used to authenticate a ␊ - * Point-To-Site VPN connection.␊ - */␊ - certBlob?: string␊ - /**␊ - * DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses.␊ - */␊ - dnsServers?: string␊ - /**␊ - * Flag that is used to denote if this is VNET injection␊ - */␊ - isSwift?: (boolean | string)␊ - /**␊ - * The Virtual Network's resource ID.␊ - */␊ - vnetResourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/deployments␊ - */␊ - export interface SitesDeployments3 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * ID of an existing deployment.␊ - */␊ - name: string␊ - /**␊ - * Deployment resource specific properties␊ - */␊ - properties: (DeploymentProperties5 | string)␊ - type: "Microsoft.Web/sites/deployments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/domainOwnershipIdentifiers␊ - */␊ - export interface SitesDomainOwnershipIdentifiers2 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of domain ownership identifier.␊ - */␊ - name: string␊ - /**␊ - * Identifier resource specific properties␊ - */␊ - properties: (IdentifierProperties2 | string)␊ - type: "Microsoft.Web/sites/domainOwnershipIdentifiers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/extensions␊ - */␊ - export interface SitesExtensions2 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - properties: (MSDeployCore2 | string)␊ - type: "Microsoft.Web/sites/extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/functions␊ - */␊ - export interface SitesFunctions2 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Function name.␊ - */␊ - name: string␊ - /**␊ - * FunctionEnvelope resource specific properties␊ - */␊ - properties: (FunctionEnvelopeProperties2 | string)␊ - type: "Microsoft.Web/sites/functions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/hostNameBindings␊ - */␊ - export interface SitesHostNameBindings3 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Hostname in the hostname binding.␊ - */␊ - name: string␊ - /**␊ - * HostNameBinding resource specific properties␊ - */␊ - properties: (HostNameBindingProperties3 | string)␊ - type: "Microsoft.Web/sites/hostNameBindings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/hybridconnection␊ - */␊ - export interface SitesHybridconnection3 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the hybrid connection configuration.␊ - */␊ - name: string␊ - /**␊ - * RelayServiceConnectionEntity resource specific properties␊ - */␊ - properties: (RelayServiceConnectionEntityProperties3 | string)␊ - type: "Microsoft.Web/sites/hybridconnection"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/hybridConnectionNamespaces/relays␊ - */␊ - export interface SitesHybridConnectionNamespacesRelays2 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * The relay name for this hybrid connection.␊ - */␊ - name: string␊ - /**␊ - * HybridConnection resource specific properties␊ - */␊ - properties: (HybridConnectionProperties4 | string)␊ - type: "Microsoft.Web/sites/hybridConnectionNamespaces/relays"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HybridConnection resource specific properties␊ - */␊ - export interface HybridConnectionProperties4 {␊ - /**␊ - * The hostname of the endpoint.␊ - */␊ - hostname?: string␊ - /**␊ - * The port of the endpoint.␊ - */␊ - port?: (number | string)␊ - /**␊ - * The ARM URI to the Service Bus relay.␊ - */␊ - relayArmUri?: string␊ - /**␊ - * The name of the Service Bus relay.␊ - */␊ - relayName?: string␊ - /**␊ - * The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus.␊ - */␊ - sendKeyName?: string␊ - /**␊ - * 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.␊ - */␊ - sendKeyValue?: string␊ - /**␊ - * The name of the Service Bus namespace.␊ - */␊ - serviceBusNamespace?: string␊ - /**␊ - * The suffix for the service bus endpoint. By default this is .servicebus.windows.net␊ - */␊ - serviceBusSuffix?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/instances/extensions␊ - */␊ - export interface SitesInstancesExtensions2 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - properties: (MSDeployCore2 | string)␊ - type: "Microsoft.Web/sites/instances/extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/migrate␊ - */␊ - export interface SitesMigrate2 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * StorageMigrationOptions resource specific properties␊ - */␊ - properties: (StorageMigrationOptionsProperties2 | string)␊ - type: "Microsoft.Web/sites/migrate"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/networkConfig␊ - */␊ - export interface SitesNetworkConfig1 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SwiftVirtualNetwork resource specific properties␊ - */␊ - properties: (SwiftVirtualNetworkProperties1 | string)␊ - type: "Microsoft.Web/sites/networkConfig"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/premieraddons␊ - */␊ - export interface SitesPremieraddons3 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Add-on name.␊ - */␊ - name: string␊ - /**␊ - * PremierAddOn resource specific properties␊ - */␊ - properties: (PremierAddOnProperties2 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/sites/premieraddons"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/privateAccess␊ - */␊ - export interface SitesPrivateAccess1 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * PrivateAccess resource specific properties␊ - */␊ - properties: (PrivateAccessProperties1 | string)␊ - type: "Microsoft.Web/sites/privateAccess"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/publicCertificates␊ - */␊ - export interface SitesPublicCertificates2 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Public certificate name.␊ - */␊ - name: string␊ - /**␊ - * PublicCertificate resource specific properties␊ - */␊ - properties: (PublicCertificateProperties2 | string)␊ - type: "Microsoft.Web/sites/publicCertificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/siteextensions␊ - */␊ - export interface SitesSiteextensions2 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Site extension name.␊ - */␊ - name: string␊ - type: "Microsoft.Web/sites/siteextensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots␊ - */␊ - export interface SitesSlots3 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Managed service identity.␊ - */␊ - identity?: (ManagedServiceIdentity16 | string)␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the deployment slot to create or update. The name 'production' is reserved.␊ - */␊ - name: string␊ - /**␊ - * Site resource specific properties␊ - */␊ - properties: (SiteProperties3 | string)␊ - resources?: (SitesSlotsConfigChildResource3 | SitesSlotsDeploymentsChildResource3 | SitesSlotsDomainOwnershipIdentifiersChildResource2 | SitesSlotsExtensionsChildResource2 | SitesSlotsFunctionsChildResource2 | SitesSlotsHostNameBindingsChildResource3 | SitesSlotsHybridconnectionChildResource3 | SitesSlotsNetworkConfigChildResource1 | SitesSlotsPremieraddonsChildResource3 | SitesSlotsPrivateAccessChildResource1 | SitesSlotsPublicCertificatesChildResource2 | SitesSlotsSiteextensionsChildResource2 | SitesSlotsSourcecontrolsChildResource3 | SitesSlotsVirtualNetworkConnectionsChildResource3)[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/sites/slots"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/deployments␊ - */␊ - export interface SitesSlotsDeploymentsChildResource3 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * ID of an existing deployment.␊ - */␊ - name: string␊ - /**␊ - * Deployment resource specific properties␊ - */␊ - properties: (DeploymentProperties5 | string)␊ - type: "deployments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/domainOwnershipIdentifiers␊ - */␊ - export interface SitesSlotsDomainOwnershipIdentifiersChildResource2 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of domain ownership identifier.␊ - */␊ - name: string␊ - /**␊ - * Identifier resource specific properties␊ - */␊ - properties: (IdentifierProperties2 | string)␊ - type: "domainOwnershipIdentifiers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/extensions␊ - */␊ - export interface SitesSlotsExtensionsChildResource2 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "MSDeploy"␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - properties: (MSDeployCore2 | string)␊ - type: "extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/functions␊ - */␊ - export interface SitesSlotsFunctionsChildResource2 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Function name.␊ - */␊ - name: string␊ - /**␊ - * FunctionEnvelope resource specific properties␊ - */␊ - properties: (FunctionEnvelopeProperties2 | string)␊ - type: "functions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/hostNameBindings␊ - */␊ - export interface SitesSlotsHostNameBindingsChildResource3 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Hostname in the hostname binding.␊ - */␊ - name: string␊ - /**␊ - * HostNameBinding resource specific properties␊ - */␊ - properties: (HostNameBindingProperties3 | string)␊ - type: "hostNameBindings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/hybridconnection␊ - */␊ - export interface SitesSlotsHybridconnectionChildResource3 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the hybrid connection configuration.␊ - */␊ - name: string␊ - /**␊ - * RelayServiceConnectionEntity resource specific properties␊ - */␊ - properties: (RelayServiceConnectionEntityProperties3 | string)␊ - type: "hybridconnection"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/networkConfig␊ - */␊ - export interface SitesSlotsNetworkConfigChildResource1 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "virtualNetwork"␊ - /**␊ - * SwiftVirtualNetwork resource specific properties␊ - */␊ - properties: (SwiftVirtualNetworkProperties1 | string)␊ - type: "networkConfig"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/premieraddons␊ - */␊ - export interface SitesSlotsPremieraddonsChildResource3 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Add-on name.␊ - */␊ - name: string␊ - /**␊ - * PremierAddOn resource specific properties␊ - */␊ - properties: (PremierAddOnProperties2 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "premieraddons"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/privateAccess␊ - */␊ - export interface SitesSlotsPrivateAccessChildResource1 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "virtualNetworks"␊ - /**␊ - * PrivateAccess resource specific properties␊ - */␊ - properties: (PrivateAccessProperties1 | string)␊ - type: "privateAccess"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/publicCertificates␊ - */␊ - export interface SitesSlotsPublicCertificatesChildResource2 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Public certificate name.␊ - */␊ - name: string␊ - /**␊ - * PublicCertificate resource specific properties␊ - */␊ - properties: (PublicCertificateProperties2 | string)␊ - type: "publicCertificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/siteextensions␊ - */␊ - export interface SitesSlotsSiteextensionsChildResource2 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Site extension name.␊ - */␊ - name: string␊ - type: "siteextensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/sourcecontrols␊ - */␊ - export interface SitesSlotsSourcecontrolsChildResource3 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "web"␊ - /**␊ - * SiteSourceControl resource specific properties␊ - */␊ - properties: (SiteSourceControlProperties3 | string)␊ - type: "sourcecontrols"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/virtualNetworkConnections␊ - */␊ - export interface SitesSlotsVirtualNetworkConnectionsChildResource3 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of an existing Virtual Network.␊ - */␊ - name: string␊ - /**␊ - * VnetInfo resource specific properties␊ - */␊ - properties: (VnetInfoProperties3 | string)␊ - type: "virtualNetworkConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/deployments␊ - */␊ - export interface SitesSlotsDeployments3 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * ID of an existing deployment.␊ - */␊ - name: string␊ - /**␊ - * Deployment resource specific properties␊ - */␊ - properties: (DeploymentProperties5 | string)␊ - type: "Microsoft.Web/sites/slots/deployments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/domainOwnershipIdentifiers␊ - */␊ - export interface SitesSlotsDomainOwnershipIdentifiers2 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of domain ownership identifier.␊ - */␊ - name: string␊ - /**␊ - * Identifier resource specific properties␊ - */␊ - properties: (IdentifierProperties2 | string)␊ - type: "Microsoft.Web/sites/slots/domainOwnershipIdentifiers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/extensions␊ - */␊ - export interface SitesSlotsExtensions2 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - properties: (MSDeployCore2 | string)␊ - type: "Microsoft.Web/sites/slots/extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/functions␊ - */␊ - export interface SitesSlotsFunctions2 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Function name.␊ - */␊ - name: string␊ - /**␊ - * FunctionEnvelope resource specific properties␊ - */␊ - properties: (FunctionEnvelopeProperties2 | string)␊ - type: "Microsoft.Web/sites/slots/functions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/hostNameBindings␊ - */␊ - export interface SitesSlotsHostNameBindings3 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Hostname in the hostname binding.␊ - */␊ - name: string␊ - /**␊ - * HostNameBinding resource specific properties␊ - */␊ - properties: (HostNameBindingProperties3 | string)␊ - type: "Microsoft.Web/sites/slots/hostNameBindings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/hybridconnection␊ - */␊ - export interface SitesSlotsHybridconnection3 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the hybrid connection configuration.␊ - */␊ - name: string␊ - /**␊ - * RelayServiceConnectionEntity resource specific properties␊ - */␊ - properties: (RelayServiceConnectionEntityProperties3 | string)␊ - type: "Microsoft.Web/sites/slots/hybridconnection"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays␊ - */␊ - export interface SitesSlotsHybridConnectionNamespacesRelays2 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * The relay name for this hybrid connection.␊ - */␊ - name: string␊ - /**␊ - * HybridConnection resource specific properties␊ - */␊ - properties: (HybridConnectionProperties4 | string)␊ - type: "Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/instances/extensions␊ - */␊ - export interface SitesSlotsInstancesExtensions2 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - properties: (MSDeployCore2 | string)␊ - type: "Microsoft.Web/sites/slots/instances/extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/networkConfig␊ - */␊ - export interface SitesSlotsNetworkConfig1 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SwiftVirtualNetwork resource specific properties␊ - */␊ - properties: (SwiftVirtualNetworkProperties1 | string)␊ - type: "Microsoft.Web/sites/slots/networkConfig"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/premieraddons␊ - */␊ - export interface SitesSlotsPremieraddons3 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Add-on name.␊ - */␊ - name: string␊ - /**␊ - * PremierAddOn resource specific properties␊ - */␊ - properties: (PremierAddOnProperties2 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/sites/slots/premieraddons"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/privateAccess␊ - */␊ - export interface SitesSlotsPrivateAccess1 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * PrivateAccess resource specific properties␊ - */␊ - properties: (PrivateAccessProperties1 | string)␊ - type: "Microsoft.Web/sites/slots/privateAccess"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/publicCertificates␊ - */␊ - export interface SitesSlotsPublicCertificates2 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Public certificate name.␊ - */␊ - name: string␊ - /**␊ - * PublicCertificate resource specific properties␊ - */␊ - properties: (PublicCertificateProperties2 | string)␊ - type: "Microsoft.Web/sites/slots/publicCertificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/siteextensions␊ - */␊ - export interface SitesSlotsSiteextensions2 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Site extension name.␊ - */␊ - name: string␊ - type: "Microsoft.Web/sites/slots/siteextensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/sourcecontrols␊ - */␊ - export interface SitesSlotsSourcecontrols3 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteSourceControl resource specific properties␊ - */␊ - properties: (SiteSourceControlProperties3 | string)␊ - type: "Microsoft.Web/sites/slots/sourcecontrols"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/virtualNetworkConnections␊ - */␊ - export interface SitesSlotsVirtualNetworkConnections3 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of an existing Virtual Network.␊ - */␊ - name: string␊ - /**␊ - * VnetInfo resource specific properties␊ - */␊ - properties: (VnetInfoProperties3 | string)␊ - resources?: SitesSlotsVirtualNetworkConnectionsGatewaysChildResource3[]␊ - type: "Microsoft.Web/sites/slots/virtualNetworkConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/virtualNetworkConnections/gateways␊ - */␊ - export interface SitesSlotsVirtualNetworkConnectionsGatewaysChildResource3 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the gateway. Currently, the only supported string is "primary".␊ - */␊ - name: string␊ - /**␊ - * VnetGateway resource specific properties␊ - */␊ - properties: (VnetGatewayProperties4 | string)␊ - type: "gateways"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VnetGateway resource specific properties␊ - */␊ - export interface VnetGatewayProperties4 {␊ - /**␊ - * The Virtual Network name.␊ - */␊ - vnetName?: string␊ - /**␊ - * The URI where the VPN package can be downloaded.␊ - */␊ - vpnPackageUri: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/virtualNetworkConnections/gateways␊ - */␊ - export interface SitesSlotsVirtualNetworkConnectionsGateways3 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the gateway. Currently, the only supported string is "primary".␊ - */␊ - name: string␊ - /**␊ - * VnetGateway resource specific properties␊ - */␊ - properties: (VnetGatewayProperties4 | string)␊ - type: "Microsoft.Web/sites/slots/virtualNetworkConnections/gateways"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/sourcecontrols␊ - */␊ - export interface SitesSourcecontrols3 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteSourceControl resource specific properties␊ - */␊ - properties: (SiteSourceControlProperties3 | string)␊ - type: "Microsoft.Web/sites/sourcecontrols"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/virtualNetworkConnections␊ - */␊ - export interface SitesVirtualNetworkConnections3 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of an existing Virtual Network.␊ - */␊ - name: string␊ - /**␊ - * VnetInfo resource specific properties␊ - */␊ - properties: (VnetInfoProperties3 | string)␊ - resources?: SitesVirtualNetworkConnectionsGatewaysChildResource3[]␊ - type: "Microsoft.Web/sites/virtualNetworkConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/virtualNetworkConnections/gateways␊ - */␊ - export interface SitesVirtualNetworkConnectionsGatewaysChildResource3 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the gateway. Currently, the only supported string is "primary".␊ - */␊ - name: string␊ - /**␊ - * VnetGateway resource specific properties␊ - */␊ - properties: (VnetGatewayProperties4 | string)␊ - type: "gateways"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/virtualNetworkConnections/gateways␊ - */␊ - export interface SitesVirtualNetworkConnectionsGateways3 {␊ - apiVersion: "2018-11-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the gateway. Currently, the only supported string is "primary".␊ - */␊ - name: string␊ - /**␊ - * VnetGateway resource specific properties␊ - */␊ - properties: (VnetGatewayProperties4 | string)␊ - type: "Microsoft.Web/sites/virtualNetworkConnections/gateways"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/certificates␊ - */␊ - export interface Certificates4 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the certificate.␊ - */␊ - name: string␊ - /**␊ - * Certificate resource specific properties␊ - */␊ - properties: (CertificateProperties4 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/certificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Certificate resource specific properties␊ - */␊ - export interface CertificateProperties4 {␊ - /**␊ - * CNAME of the certificate to be issued via free certificate␊ - */␊ - canonicalName?: string␊ - /**␊ - * Host names the certificate applies to.␊ - */␊ - hostNames?: (string[] | string)␊ - /**␊ - * Key Vault Csm resource Id.␊ - */␊ - keyVaultId?: string␊ - /**␊ - * Key Vault secret name.␊ - */␊ - keyVaultSecretName?: string␊ - /**␊ - * Certificate password.␊ - */␊ - password: string␊ - /**␊ - * Pfx blob.␊ - */␊ - pfxBlob?: string␊ - /**␊ - * Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".␊ - */␊ - serverFarmId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/hostingEnvironments␊ - */␊ - export interface HostingEnvironments3 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the App Service Environment.␊ - */␊ - name: string␊ - /**␊ - * Description of an App Service Environment.␊ - */␊ - properties: (AppServiceEnvironment2 | string)␊ - resources?: (HostingEnvironmentsMultiRolePoolsChildResource3 | HostingEnvironmentsWorkerPoolsChildResource3)[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/hostingEnvironments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of an App Service Environment.␊ - */␊ - export interface AppServiceEnvironment2 {␊ - /**␊ - * API Management Account associated with the App Service Environment.␊ - */␊ - apiManagementAccountId?: string␊ - /**␊ - * Custom settings for changing the behavior of the App Service Environment.␊ - */␊ - clusterSettings?: (NameValuePair5[] | string)␊ - /**␊ - * DNS suffix of the App Service Environment.␊ - */␊ - dnsSuffix?: string␊ - /**␊ - * True/false indicating whether the App Service Environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available␊ - * (most likely because NSG blocked the incoming traffic).␊ - */␊ - dynamicCacheEnabled?: (boolean | string)␊ - /**␊ - * Scale factor for front-ends.␊ - */␊ - frontEndScaleFactor?: (number | string)␊ - /**␊ - * Flag that displays whether an ASE has linux workers or not␊ - */␊ - hasLinuxWorkers?: (boolean | string)␊ - /**␊ - * Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.␊ - */␊ - internalLoadBalancingMode?: (("None" | "Web" | "Publishing") | string)␊ - /**␊ - * Number of IP SSL addresses reserved for the App Service Environment.␊ - */␊ - ipsslAddressCount?: (number | string)␊ - /**␊ - * Location of the App Service Environment, e.g. "West US".␊ - */␊ - location: string␊ - /**␊ - * Number of front-end instances.␊ - */␊ - multiRoleCount?: (number | string)␊ - /**␊ - * Front-end VM size, e.g. "Medium", "Large".␊ - */␊ - multiSize?: string␊ - /**␊ - * Name of the App Service Environment.␊ - */␊ - name: string␊ - /**␊ - * Access control list for controlling traffic to the App Service Environment.␊ - */␊ - networkAccessControlList?: (NetworkAccessControlEntry3[] | string)␊ - /**␊ - * Key Vault ID for ILB App Service Environment default SSL certificate␊ - */␊ - sslCertKeyVaultId?: string␊ - /**␊ - * Key Vault Secret Name for ILB App Service Environment default SSL certificate␊ - */␊ - sslCertKeyVaultSecretName?: string␊ - /**␊ - * true if the App Service Environment is suspended; otherwise, false. The environment can be suspended, e.g. when the management endpoint is no longer available␊ - * (most likely because NSG blocked the incoming traffic).␊ - */␊ - suspended?: (boolean | string)␊ - /**␊ - * User added ip ranges to whitelist on ASE db␊ - */␊ - userWhitelistedIpRanges?: (string[] | string)␊ - /**␊ - * Specification for using a Virtual Network.␊ - */␊ - virtualNetwork: (VirtualNetworkProfile6 | string)␊ - /**␊ - * Name of the Virtual Network for the App Service Environment.␊ - */␊ - vnetName?: string␊ - /**␊ - * Resource group of the Virtual Network.␊ - */␊ - vnetResourceGroupName?: string␊ - /**␊ - * Subnet of the Virtual Network.␊ - */␊ - vnetSubnetName?: string␊ - /**␊ - * Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool.␊ - */␊ - workerPools: (WorkerPool3[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Name value pair.␊ - */␊ - export interface NameValuePair5 {␊ - /**␊ - * Pair name.␊ - */␊ - name?: string␊ - /**␊ - * Pair value.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network access control entry.␊ - */␊ - export interface NetworkAccessControlEntry3 {␊ - /**␊ - * Action object.␊ - */␊ - action?: (("Permit" | "Deny") | string)␊ - /**␊ - * Description of network access control entry.␊ - */␊ - description?: string␊ - /**␊ - * Order of precedence.␊ - */␊ - order?: (number | string)␊ - /**␊ - * Remote subnet.␊ - */␊ - remoteSubnet?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specification for using a Virtual Network.␊ - */␊ - export interface VirtualNetworkProfile6 {␊ - /**␊ - * Resource id of the Virtual Network.␊ - */␊ - id?: string␊ - /**␊ - * Subnet within the Virtual Network.␊ - */␊ - subnet?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Worker pool of an App Service Environment.␊ - */␊ - export interface WorkerPool3 {␊ - /**␊ - * Shared or dedicated app hosting.␊ - */␊ - computeMode?: (("Shared" | "Dedicated" | "Dynamic") | string)␊ - /**␊ - * Number of instances in the worker pool.␊ - */␊ - workerCount?: (number | string)␊ - /**␊ - * VM size of the worker pool instances.␊ - */␊ - workerSize?: string␊ - /**␊ - * Worker size ID for referencing this worker pool.␊ - */␊ - workerSizeId?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/hostingEnvironments/multiRolePools␊ - */␊ - export interface HostingEnvironmentsMultiRolePoolsChildResource3 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "default"␊ - /**␊ - * Worker pool of an App Service Environment.␊ - */␊ - properties: (WorkerPool3 | string)␊ - /**␊ - * Description of a SKU for a scalable resource.␊ - */␊ - sku?: (SkuDescription5 | string)␊ - type: "multiRolePools"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a SKU for a scalable resource.␊ - */␊ - export interface SkuDescription5 {␊ - /**␊ - * Capabilities of the SKU, e.g., is traffic manager enabled?␊ - */␊ - capabilities?: (Capability3[] | string)␊ - /**␊ - * Current number of instances assigned to the resource.␊ - */␊ - capacity?: (number | string)␊ - /**␊ - * Family code of the resource SKU.␊ - */␊ - family?: string␊ - /**␊ - * Locations of the SKU.␊ - */␊ - locations?: (string[] | string)␊ - /**␊ - * Name of the resource SKU.␊ - */␊ - name?: string␊ - /**␊ - * Size specifier of the resource SKU.␊ - */␊ - size?: string␊ - /**␊ - * Description of the App Service plan scale options.␊ - */␊ - skuCapacity?: (SkuCapacity2 | string)␊ - /**␊ - * Service tier of the resource SKU.␊ - */␊ - tier?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the capabilities/features allowed for a specific SKU.␊ - */␊ - export interface Capability3 {␊ - /**␊ - * Name of the SKU capability.␊ - */␊ - name?: string␊ - /**␊ - * Reason of the SKU capability.␊ - */␊ - reason?: string␊ - /**␊ - * Value of the SKU capability.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of the App Service plan scale options.␊ - */␊ - export interface SkuCapacity2 {␊ - /**␊ - * Default number of workers for this App Service plan SKU.␊ - */␊ - default?: (number | string)␊ - /**␊ - * Maximum number of workers for this App Service plan SKU.␊ - */␊ - maximum?: (number | string)␊ - /**␊ - * Minimum number of workers for this App Service plan SKU.␊ - */␊ - minimum?: (number | string)␊ - /**␊ - * Available scale configurations for an App Service plan.␊ - */␊ - scaleType?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/hostingEnvironments/workerPools␊ - */␊ - export interface HostingEnvironmentsWorkerPoolsChildResource3 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the worker pool.␊ - */␊ - name: string␊ - /**␊ - * Worker pool of an App Service Environment.␊ - */␊ - properties: (WorkerPool3 | string)␊ - /**␊ - * Description of a SKU for a scalable resource.␊ - */␊ - sku?: (SkuDescription5 | string)␊ - type: "workerPools"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/hostingEnvironments/multiRolePools␊ - */␊ - export interface HostingEnvironmentsMultiRolePools3 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Worker pool of an App Service Environment.␊ - */␊ - properties: (WorkerPool3 | string)␊ - /**␊ - * Description of a SKU for a scalable resource.␊ - */␊ - sku?: (SkuDescription5 | string)␊ - type: "Microsoft.Web/hostingEnvironments/multiRolePools"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/hostingEnvironments/workerPools␊ - */␊ - export interface HostingEnvironmentsWorkerPools3 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the worker pool.␊ - */␊ - name: string␊ - /**␊ - * Worker pool of an App Service Environment.␊ - */␊ - properties: (WorkerPool3 | string)␊ - /**␊ - * Description of a SKU for a scalable resource.␊ - */␊ - sku?: (SkuDescription5 | string)␊ - type: "Microsoft.Web/hostingEnvironments/workerPools"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/serverfarms␊ - */␊ - export interface Serverfarms3 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the App Service plan.␊ - */␊ - name: string␊ - /**␊ - * AppServicePlan resource specific properties␊ - */␊ - properties: (AppServicePlanProperties2 | string)␊ - /**␊ - * Description of a SKU for a scalable resource.␊ - */␊ - sku?: (SkuDescription5 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/serverfarms"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AppServicePlan resource specific properties␊ - */␊ - export interface AppServicePlanProperties2 {␊ - /**␊ - * The time when the server farm free offer expires.␊ - */␊ - freeOfferExpirationTime?: string␊ - /**␊ - * Specification for an App Service Environment to use for this resource.␊ - */␊ - hostingEnvironmentProfile?: (HostingEnvironmentProfile5 | string)␊ - /**␊ - * If Hyper-V container app service plan true, false otherwise.␊ - */␊ - hyperV?: (boolean | string)␊ - /**␊ - * If true, this App Service Plan owns spot instances.␊ - */␊ - isSpot?: (boolean | string)␊ - /**␊ - * Obsolete: If Hyper-V container app service plan true, false otherwise.␊ - */␊ - isXenon?: (boolean | string)␊ - /**␊ - * Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan␊ - */␊ - maximumElasticWorkerCount?: (number | string)␊ - /**␊ - * 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.␊ - */␊ - perSiteScaling?: (boolean | string)␊ - /**␊ - * If Linux app service plan true, false otherwise.␊ - */␊ - reserved?: (boolean | string)␊ - /**␊ - * The time when the server farm expires. Valid only if it is a spot server farm.␊ - */␊ - spotExpirationTime?: string␊ - /**␊ - * Scaling worker count.␊ - */␊ - targetWorkerCount?: (number | string)␊ - /**␊ - * Scaling worker size ID.␊ - */␊ - targetWorkerSizeId?: (number | string)␊ - /**␊ - * Target worker tier assigned to the App Service plan.␊ - */␊ - workerTierName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specification for an App Service Environment to use for this resource.␊ - */␊ - export interface HostingEnvironmentProfile5 {␊ - /**␊ - * Resource ID of the App Service Environment.␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/serverfarms/virtualNetworkConnections/gateways␊ - */␊ - export interface ServerfarmsVirtualNetworkConnectionsGateways3 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the gateway. Only the 'primary' gateway is supported.␊ - */␊ - name: string␊ - /**␊ - * VnetGateway resource specific properties␊ - */␊ - properties: (VnetGatewayProperties5 | string)␊ - type: "Microsoft.Web/serverfarms/virtualNetworkConnections/gateways"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VnetGateway resource specific properties␊ - */␊ - export interface VnetGatewayProperties5 {␊ - /**␊ - * The Virtual Network name.␊ - */␊ - vnetName?: string␊ - /**␊ - * The URI where the VPN package can be downloaded.␊ - */␊ - vpnPackageUri: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/serverfarms/virtualNetworkConnections/routes␊ - */␊ - export interface ServerfarmsVirtualNetworkConnectionsRoutes3 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the Virtual Network route.␊ - */␊ - name: string␊ - /**␊ - * VnetRoute resource specific properties␊ - */␊ - properties: (VnetRouteProperties3 | string)␊ - type: "Microsoft.Web/serverfarms/virtualNetworkConnections/routes"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VnetRoute resource specific properties␊ - */␊ - export interface VnetRouteProperties3 {␊ - /**␊ - * The ending address for this route. If the start address is specified in CIDR notation, this must be omitted.␊ - */␊ - endAddress?: string␊ - /**␊ - * 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.␊ - */␊ - routeType?: (("DEFAULT" | "INHERITED" | "STATIC") | string)␊ - /**␊ - * The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified.␊ - */␊ - startAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites␊ - */␊ - export interface Sites4 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Managed service identity.␊ - */␊ - identity?: (ManagedServiceIdentity17 | string)␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Unique name of the app to create or update. To create or update a deployment slot, use the {slot} parameter.␊ - */␊ - name: string␊ - /**␊ - * Site resource specific properties␊ - */␊ - properties: (SiteProperties4 | string)␊ - resources?: (SitesBasicPublishingCredentialsPoliciesChildResource | SitesConfigChildResource4 | SitesDeploymentsChildResource4 | SitesDomainOwnershipIdentifiersChildResource3 | SitesExtensionsChildResource3 | SitesFunctionsChildResource3 | SitesHostNameBindingsChildResource4 | SitesHybridconnectionChildResource4 | SitesMigrateChildResource3 | SitesNetworkConfigChildResource2 | SitesPremieraddonsChildResource4 | SitesPrivateAccessChildResource2 | SitesPublicCertificatesChildResource3 | SitesSiteextensionsChildResource3 | SitesSlotsChildResource4 | SitesPrivateEndpointConnectionsChildResource | SitesSourcecontrolsChildResource4 | SitesVirtualNetworkConnectionsChildResource4)[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/sites"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Managed service identity.␊ - */␊ - export interface ManagedServiceIdentity17 {␊ - /**␊ - * Type of managed service identity.␊ - */␊ - type?: (("SystemAssigned" | "UserAssigned" | "SystemAssigned, UserAssigned" | "None") | string)␊ - /**␊ - * The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}␊ - */␊ - userAssignedIdentities?: ({␊ - [k: string]: Components1Jq1T4Ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties3␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - export interface Components1Jq1T4Ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties3 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Site resource specific properties␊ - */␊ - export interface SiteProperties4 {␊ - /**␊ - * 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.␊ - */␊ - clientAffinityEnabled?: (boolean | string)␊ - /**␊ - * true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.␊ - */␊ - clientCertEnabled?: (boolean | string)␊ - /**␊ - * client certificate authentication comma-separated exclusion paths␊ - */␊ - clientCertExclusionPaths?: string␊ - /**␊ - * Information needed for cloning operation.␊ - */␊ - cloningInfo?: (CloningInfo4 | string)␊ - /**␊ - * Size of the function container.␊ - */␊ - containerSize?: (number | string)␊ - /**␊ - * Maximum allowed daily memory-time quota (applicable on dynamic apps only).␊ - */␊ - dailyMemoryTimeQuota?: (number | string)␊ - /**␊ - * true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Specification for an App Service Environment to use for this resource.␊ - */␊ - hostingEnvironmentProfile?: (HostingEnvironmentProfile5 | string)␊ - /**␊ - * true to disable the public hostnames of the app; otherwise, false.␊ - * If true, the app is only accessible via API management process.␊ - */␊ - hostNamesDisabled?: (boolean | string)␊ - /**␊ - * Hostname SSL states are used to manage the SSL bindings for app's hostnames.␊ - */␊ - hostNameSslStates?: (HostNameSslState4[] | string)␊ - /**␊ - * HttpsOnly: configures a web site to accept only https requests. Issues redirect for␊ - * http requests␊ - */␊ - httpsOnly?: (boolean | string)␊ - /**␊ - * Hyper-V sandbox.␊ - */␊ - hyperV?: (boolean | string)␊ - /**␊ - * Obsolete: Hyper-V sandbox.␊ - */␊ - isXenon?: (boolean | string)␊ - /**␊ - * Site redundancy mode.␊ - */␊ - redundancyMode?: (("None" | "Manual" | "Failover" | "ActiveActive" | "GeoRedundant") | string)␊ - /**␊ - * true if reserved; otherwise, false.␊ - */␊ - reserved?: (boolean | string)␊ - /**␊ - * true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.␊ - */␊ - scmSiteAlsoStopped?: (boolean | string)␊ - /**␊ - * Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".␊ - */␊ - serverFarmId?: string␊ - /**␊ - * Configuration of an App Service app.␊ - */␊ - siteConfig?: (SiteConfig4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information needed for cloning operation.␊ - */␊ - export interface CloningInfo4 {␊ - /**␊ - * 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.␊ - */␊ - appSettingsOverrides?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * true to clone custom hostnames from source app; otherwise, false.␊ - */␊ - cloneCustomHostNames?: (boolean | string)␊ - /**␊ - * true to clone source control from source app; otherwise, false.␊ - */␊ - cloneSourceControl?: (boolean | string)␊ - /**␊ - * true to configure load balancing for source and destination app.␊ - */␊ - configureLoadBalancing?: (boolean | string)␊ - /**␊ - * Correlation ID of cloning operation. This ID ties multiple cloning operations␊ - * together to use the same snapshot.␊ - */␊ - correlationId?: string␊ - /**␊ - * App Service Environment.␊ - */␊ - hostingEnvironment?: string␊ - /**␊ - * true to overwrite destination app; otherwise, false.␊ - */␊ - overwrite?: (boolean | string)␊ - /**␊ - * 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.␊ - */␊ - sourceWebAppId: string␊ - /**␊ - * Location of source app ex: West US or North Europe␊ - */␊ - sourceWebAppLocation?: string␊ - /**␊ - * 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}.␊ - */␊ - trafficManagerProfileId?: string␊ - /**␊ - * Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist.␊ - */␊ - trafficManagerProfileName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSL-enabled hostname.␊ - */␊ - export interface HostNameSslState4 {␊ - /**␊ - * Indicates whether the hostname is a standard or repository hostname.␊ - */␊ - hostType?: (("Standard" | "Repository") | string)␊ - /**␊ - * Hostname.␊ - */␊ - name?: string␊ - /**␊ - * SSL type.␊ - */␊ - sslState?: (("Disabled" | "SniEnabled" | "IpBasedEnabled") | string)␊ - /**␊ - * SSL certificate thumbprint.␊ - */␊ - thumbprint?: string␊ - /**␊ - * Set to true to update existing hostname.␊ - */␊ - toUpdate?: (boolean | string)␊ - /**␊ - * Virtual IP address assigned to the hostname if IP based SSL is enabled.␊ - */␊ - virtualIP?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Configuration of an App Service app.␊ - */␊ - export interface SiteConfig4 {␊ - /**␊ - * Flag to use Managed Identity Creds for ACR pull␊ - */␊ - acrUseManagedIdentityCreds?: (boolean | string)␊ - /**␊ - * If using user managed identity, the user managed identity ClientId␊ - */␊ - acrUserManagedIdentityID?: string␊ - /**␊ - * true if Always On is enabled; otherwise, false.␊ - */␊ - alwaysOn?: (boolean | string)␊ - /**␊ - * Information about the formal API definition for the app.␊ - */␊ - apiDefinition?: (ApiDefinitionInfo4 | string)␊ - /**␊ - * Azure API management (APIM) configuration linked to the app.␊ - */␊ - apiManagementConfig?: (ApiManagementConfig | string)␊ - /**␊ - * App command line to launch.␊ - */␊ - appCommandLine?: string␊ - /**␊ - * Application settings.␊ - */␊ - appSettings?: (NameValuePair5[] | string)␊ - /**␊ - * true if Auto Heal is enabled; otherwise, false.␊ - */␊ - autoHealEnabled?: (boolean | string)␊ - /**␊ - * Rules that can be defined for auto-heal.␊ - */␊ - autoHealRules?: (AutoHealRules4 | string)␊ - /**␊ - * Auto-swap slot name.␊ - */␊ - autoSwapSlotName?: string␊ - /**␊ - * Connection strings.␊ - */␊ - connectionStrings?: (ConnStringInfo4[] | string)␊ - /**␊ - * Cross-Origin Resource Sharing (CORS) settings for the app.␊ - */␊ - cors?: (CorsSettings4 | string)␊ - /**␊ - * Default documents.␊ - */␊ - defaultDocuments?: (string[] | string)␊ - /**␊ - * true if detailed error logging is enabled; otherwise, false.␊ - */␊ - detailedErrorLoggingEnabled?: (boolean | string)␊ - /**␊ - * Document root.␊ - */␊ - documentRoot?: string␊ - /**␊ - * Routing rules in production experiments.␊ - */␊ - experiments?: (Experiments4 | string)␊ - /**␊ - * State of FTP / FTPS service.␊ - */␊ - ftpsState?: (("AllAllowed" | "FtpsOnly" | "Disabled") | string)␊ - /**␊ - * Handler mappings.␊ - */␊ - handlerMappings?: (HandlerMapping4[] | string)␊ - /**␊ - * Health check path␊ - */␊ - healthCheckPath?: string␊ - /**␊ - * Http20Enabled: configures a web site to allow clients to connect over http2.0␊ - */␊ - http20Enabled?: (boolean | string)␊ - /**␊ - * true if HTTP logging is enabled; otherwise, false.␊ - */␊ - httpLoggingEnabled?: (boolean | string)␊ - /**␊ - * IP security restrictions for main.␊ - */␊ - ipSecurityRestrictions?: (IpSecurityRestriction4[] | string)␊ - /**␊ - * Java container.␊ - */␊ - javaContainer?: string␊ - /**␊ - * Java container version.␊ - */␊ - javaContainerVersion?: string␊ - /**␊ - * Java version.␊ - */␊ - javaVersion?: string␊ - /**␊ - * Metric limits set on an app.␊ - */␊ - limits?: (SiteLimits4 | string)␊ - /**␊ - * Linux App Framework and version␊ - */␊ - linuxFxVersion?: string␊ - /**␊ - * Site load balancing.␊ - */␊ - loadBalancing?: (("WeightedRoundRobin" | "LeastRequests" | "LeastResponseTime" | "WeightedTotalTraffic" | "RequestHash") | string)␊ - /**␊ - * true to enable local MySQL; otherwise, false.␊ - */␊ - localMySqlEnabled?: (boolean | string)␊ - /**␊ - * HTTP logs directory size limit.␊ - */␊ - logsDirectorySizeLimit?: (number | string)␊ - /**␊ - * Managed pipeline mode.␊ - */␊ - managedPipelineMode?: (("Integrated" | "Classic") | string)␊ - /**␊ - * Managed Service Identity Id␊ - */␊ - managedServiceIdentityId?: (number | string)␊ - /**␊ - * MinTlsVersion: configures the minimum version of TLS required for SSL requests.␊ - */␊ - minTlsVersion?: (("1.0" | "1.1" | "1.2") | string)␊ - /**␊ - * .NET Framework version.␊ - */␊ - netFrameworkVersion?: string␊ - /**␊ - * Version of Node.js.␊ - */␊ - nodeVersion?: string␊ - /**␊ - * Number of workers.␊ - */␊ - numberOfWorkers?: (number | string)␊ - /**␊ - * Version of PHP.␊ - */␊ - phpVersion?: string␊ - /**␊ - * Version of PowerShell.␊ - */␊ - powerShellVersion?: string␊ - /**␊ - * Number of preWarmed instances.␊ - * This setting only applies to the Consumption and Elastic Plans␊ - */␊ - preWarmedInstanceCount?: (number | string)␊ - /**␊ - * Publishing user name.␊ - */␊ - publishingUsername?: string␊ - /**␊ - * Push settings for the App.␊ - */␊ - push?: (PushSettings3 | string)␊ - /**␊ - * Version of Python.␊ - */␊ - pythonVersion?: string␊ - /**␊ - * true if remote debugging is enabled; otherwise, false.␊ - */␊ - remoteDebuggingEnabled?: (boolean | string)␊ - /**␊ - * Remote debugging version.␊ - */␊ - remoteDebuggingVersion?: string␊ - /**␊ - * true if request tracing is enabled; otherwise, false.␊ - */␊ - requestTracingEnabled?: (boolean | string)␊ - /**␊ - * Request tracing expiration time.␊ - */␊ - requestTracingExpirationTime?: string␊ - /**␊ - * IP security restrictions for scm.␊ - */␊ - scmIpSecurityRestrictions?: (IpSecurityRestriction4[] | string)␊ - /**␊ - * IP security restrictions for scm to use main.␊ - */␊ - scmIpSecurityRestrictionsUseMain?: (boolean | string)␊ - /**␊ - * SCM type.␊ - */␊ - scmType?: (("None" | "Dropbox" | "Tfs" | "LocalGit" | "GitHub" | "CodePlexGit" | "CodePlexHg" | "BitbucketGit" | "BitbucketHg" | "ExternalGit" | "ExternalHg" | "OneDrive" | "VSO" | "VSTSRM") | string)␊ - /**␊ - * Tracing options.␊ - */␊ - tracingOptions?: string␊ - /**␊ - * true to use 32-bit worker process; otherwise, false.␊ - */␊ - use32BitWorkerProcess?: (boolean | string)␊ - /**␊ - * Virtual applications.␊ - */␊ - virtualApplications?: (VirtualApplication4[] | string)␊ - /**␊ - * Virtual Network name.␊ - */␊ - vnetName?: string␊ - /**␊ - * true if WebSocket is enabled; otherwise, false.␊ - */␊ - webSocketsEnabled?: (boolean | string)␊ - /**␊ - * Xenon App Framework and version␊ - */␊ - windowsFxVersion?: string␊ - /**␊ - * Explicit Managed Service Identity Id␊ - */␊ - xManagedServiceIdentityId?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the formal API definition for the app.␊ - */␊ - export interface ApiDefinitionInfo4 {␊ - /**␊ - * The URL of the API definition.␊ - */␊ - url?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure API management (APIM) configuration linked to the app.␊ - */␊ - export interface ApiManagementConfig {␊ - /**␊ - * APIM-Api Identifier.␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Rules that can be defined for auto-heal.␊ - */␊ - export interface AutoHealRules4 {␊ - /**␊ - * Actions which to take by the auto-heal module when a rule is triggered.␊ - */␊ - actions?: (AutoHealActions4 | string)␊ - /**␊ - * Triggers for auto-heal.␊ - */␊ - triggers?: (AutoHealTriggers4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Actions which to take by the auto-heal module when a rule is triggered.␊ - */␊ - export interface AutoHealActions4 {␊ - /**␊ - * Predefined action to be taken.␊ - */␊ - actionType?: (("Recycle" | "LogEvent" | "CustomAction") | string)␊ - /**␊ - * Custom action to be executed␊ - * when an auto heal rule is triggered.␊ - */␊ - customAction?: (AutoHealCustomAction4 | string)␊ - /**␊ - * Minimum time the process must execute␊ - * before taking the action␊ - */␊ - minProcessExecutionTime?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Custom action to be executed␊ - * when an auto heal rule is triggered.␊ - */␊ - export interface AutoHealCustomAction4 {␊ - /**␊ - * Executable to be run.␊ - */␊ - exe?: string␊ - /**␊ - * Parameters for the executable.␊ - */␊ - parameters?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Triggers for auto-heal.␊ - */␊ - export interface AutoHealTriggers4 {␊ - /**␊ - * A rule based on private bytes.␊ - */␊ - privateBytesInKB?: (number | string)␊ - /**␊ - * Trigger based on total requests.␊ - */␊ - requests?: (RequestsBasedTrigger4 | string)␊ - /**␊ - * Trigger based on request execution time.␊ - */␊ - slowRequests?: (SlowRequestsBasedTrigger4 | string)␊ - /**␊ - * A rule based on status codes.␊ - */␊ - statusCodes?: (StatusCodesBasedTrigger4[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trigger based on total requests.␊ - */␊ - export interface RequestsBasedTrigger4 {␊ - /**␊ - * Request Count.␊ - */␊ - count?: (number | string)␊ - /**␊ - * Time interval.␊ - */␊ - timeInterval?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trigger based on request execution time.␊ - */␊ - export interface SlowRequestsBasedTrigger4 {␊ - /**␊ - * Request Count.␊ - */␊ - count?: (number | string)␊ - /**␊ - * Time interval.␊ - */␊ - timeInterval?: string␊ - /**␊ - * Time taken.␊ - */␊ - timeTaken?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trigger based on status code.␊ - */␊ - export interface StatusCodesBasedTrigger4 {␊ - /**␊ - * Request Count.␊ - */␊ - count?: (number | string)␊ - /**␊ - * HTTP status code.␊ - */␊ - status?: (number | string)␊ - /**␊ - * Request Sub Status.␊ - */␊ - subStatus?: (number | string)␊ - /**␊ - * Time interval.␊ - */␊ - timeInterval?: string␊ - /**␊ - * Win32 error code.␊ - */␊ - win32Status?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Database connection string information.␊ - */␊ - export interface ConnStringInfo4 {␊ - /**␊ - * Connection string value.␊ - */␊ - connectionString?: string␊ - /**␊ - * Name of connection string.␊ - */␊ - name?: string␊ - /**␊ - * Type of database.␊ - */␊ - type?: (("MySql" | "SQLServer" | "SQLAzure" | "Custom" | "NotificationHub" | "ServiceBus" | "EventHub" | "ApiHub" | "DocDb" | "RedisCache" | "PostgreSQL") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Cross-Origin Resource Sharing (CORS) settings for the app.␊ - */␊ - export interface CorsSettings4 {␊ - /**␊ - * 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.␊ - */␊ - allowedOrigins?: (string[] | string)␊ - /**␊ - * Gets or sets whether CORS requests with credentials are allowed. See ␊ - * https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials␊ - * for more details.␊ - */␊ - supportCredentials?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Routing rules in production experiments.␊ - */␊ - export interface Experiments4 {␊ - /**␊ - * List of ramp-up rules.␊ - */␊ - rampUpRules?: (RampUpRule4[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance.␊ - */␊ - export interface RampUpRule4 {␊ - /**␊ - * Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.␊ - */␊ - actionHostName?: string␊ - /**␊ - * 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/␊ - */␊ - changeDecisionCallbackUrl?: string␊ - /**␊ - * Specifies interval in minutes to reevaluate ReroutePercentage.␊ - */␊ - changeIntervalInMinutes?: (number | string)␊ - /**␊ - * In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \\nMinReroutePercentage or ␊ - * MaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\\nCustom decision algorithm ␊ - * can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl.␊ - */␊ - changeStep?: (number | string)␊ - /**␊ - * Specifies upper boundary below which ReroutePercentage will stay.␊ - */␊ - maxReroutePercentage?: (number | string)␊ - /**␊ - * Specifies lower boundary above which ReroutePercentage will stay.␊ - */␊ - minReroutePercentage?: (number | string)␊ - /**␊ - * Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment.␊ - */␊ - name?: string␊ - /**␊ - * Percentage of the traffic which will be redirected to ActionHostName.␊ - */␊ - reroutePercentage?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * 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.␊ - */␊ - export interface HandlerMapping4 {␊ - /**␊ - * Command-line arguments to be passed to the script processor.␊ - */␊ - arguments?: string␊ - /**␊ - * Requests with this extension will be handled using the specified FastCGI application.␊ - */␊ - extension?: string␊ - /**␊ - * The absolute path to the FastCGI application.␊ - */␊ - scriptProcessor?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP security restriction on an app.␊ - */␊ - export interface IpSecurityRestriction4 {␊ - /**␊ - * Allow or Deny access for this IP range.␊ - */␊ - action?: string␊ - /**␊ - * IP restriction rule description.␊ - */␊ - description?: string␊ - /**␊ - * IP address the security restriction is valid for.␊ - * It can be in form of pure ipv4 address (required SubnetMask property) or␊ - * CIDR notation such as ipv4/mask (leading bit match). For CIDR,␊ - * SubnetMask property must not be specified.␊ - */␊ - ipAddress?: string␊ - /**␊ - * IP restriction rule name.␊ - */␊ - name?: string␊ - /**␊ - * Priority of IP restriction rule.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * Subnet mask for the range of IP addresses the restriction is valid for.␊ - */␊ - subnetMask?: string␊ - /**␊ - * (internal) Subnet traffic tag␊ - */␊ - subnetTrafficTag?: (number | string)␊ - /**␊ - * Defines what this IP filter will be used for. This is to support IP filtering on proxies.␊ - */␊ - tag?: (("Default" | "XffProxy") | string)␊ - /**␊ - * Virtual network resource id␊ - */␊ - vnetSubnetResourceId?: string␊ - /**␊ - * (internal) Vnet traffic tag␊ - */␊ - vnetTrafficTag?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Metric limits set on an app.␊ - */␊ - export interface SiteLimits4 {␊ - /**␊ - * Maximum allowed disk size usage in MB.␊ - */␊ - maxDiskSizeInMb?: (number | string)␊ - /**␊ - * Maximum allowed memory usage in MB.␊ - */␊ - maxMemoryInMb?: (number | string)␊ - /**␊ - * Maximum allowed CPU usage percentage.␊ - */␊ - maxPercentageCpu?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Push settings for the App.␊ - */␊ - export interface PushSettings3 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * PushSettings resource specific properties␊ - */␊ - properties?: (PushSettingsProperties3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * PushSettings resource specific properties␊ - */␊ - export interface PushSettingsProperties3 {␊ - /**␊ - * Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint.␊ - */␊ - dynamicTagsJson?: string␊ - /**␊ - * Gets or sets a flag indicating whether the Push endpoint is enabled.␊ - */␊ - isPushEnabled: (boolean | string)␊ - /**␊ - * 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.␊ - */␊ - tagsRequiringAuth?: string␊ - /**␊ - * Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.␊ - */␊ - tagWhitelistJson?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Virtual application in an app.␊ - */␊ - export interface VirtualApplication4 {␊ - /**␊ - * Physical path.␊ - */␊ - physicalPath?: string␊ - /**␊ - * true if preloading is enabled; otherwise, false.␊ - */␊ - preloadEnabled?: (boolean | string)␊ - /**␊ - * Virtual directories for virtual application.␊ - */␊ - virtualDirectories?: (VirtualDirectory4[] | string)␊ - /**␊ - * Virtual path.␊ - */␊ - virtualPath?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Directory for virtual application.␊ - */␊ - export interface VirtualDirectory4 {␊ - /**␊ - * Physical path.␊ - */␊ - physicalPath?: string␊ - /**␊ - * Path to virtual application.␊ - */␊ - virtualPath?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * CsmPublishingCredentialsPoliciesEntity resource specific properties␊ - */␊ - export interface CsmPublishingCredentialsPoliciesEntityProperties {␊ - /**␊ - * true to allow access to a publishing method; otherwise, false.␊ - */␊ - allow: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SiteAuthSettings resource specific properties␊ - */␊ - export interface SiteAuthSettingsProperties3 {␊ - /**␊ - * Login parameters to send to the OpenID Connect authorization endpoint when␊ - * a user logs in. Each parameter must be in the form "key=value".␊ - */␊ - additionalLoginParams?: (string[] | string)␊ - /**␊ - * 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.␊ - */␊ - allowedAudiences?: (string[] | string)␊ - /**␊ - * 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.␊ - */␊ - allowedExternalRedirectUrls?: (string[] | string)␊ - /**␊ - * 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␊ - */␊ - clientId?: string␊ - /**␊ - * 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␊ - */␊ - clientSecret?: string␊ - /**␊ - * An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as␊ - * a replacement for the Client Secret. It is also optional.␊ - */␊ - clientSecretCertificateThumbprint?: string␊ - /**␊ - * 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".␊ - */␊ - defaultProvider?: (("AzureActiveDirectory" | "Facebook" | "Google" | "MicrosoftAccount" | "Twitter") | string)␊ - /**␊ - * true if the Authentication / Authorization feature is enabled for the current app; otherwise, false.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * 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␊ - */␊ - facebookAppId?: string␊ - /**␊ - * 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␊ - */␊ - facebookAppSecret?: string␊ - /**␊ - * 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␊ - */␊ - facebookOAuthScopes?: (string[] | string)␊ - /**␊ - * 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/␊ - */␊ - googleClientId?: string␊ - /**␊ - * 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/␊ - */␊ - googleClientSecret?: string␊ - /**␊ - * 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/␊ - */␊ - googleOAuthScopes?: (string[] | string)␊ - /**␊ - * 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␊ - */␊ - issuer?: string␊ - /**␊ - * 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␊ - */␊ - microsoftAccountClientId?: string␊ - /**␊ - * 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␊ - */␊ - microsoftAccountClientSecret?: string␊ - /**␊ - * 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␊ - */␊ - microsoftAccountOAuthScopes?: (string[] | string)␊ - /**␊ - * 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.␊ - */␊ - runtimeVersion?: string␊ - /**␊ - * 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.␊ - */␊ - tokenRefreshExtensionHours?: (number | string)␊ - /**␊ - * true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.␊ - * The default is false.␊ - */␊ - tokenStoreEnabled?: (boolean | string)␊ - /**␊ - * 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␊ - */␊ - twitterConsumerKey?: string␊ - /**␊ - * 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␊ - */␊ - twitterConsumerSecret?: string␊ - /**␊ - * The action to take when an unauthenticated client attempts to access the app.␊ - */␊ - unauthenticatedClientAction?: (("RedirectToLoginPage" | "AllowAnonymous") | string)␊ - /**␊ - * Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such.␊ - */␊ - validateIssuer?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Files or Blob Storage access information value for dictionary storage.␊ - */␊ - export interface AzureStorageInfoValue2 {␊ - /**␊ - * Access key for the storage account.␊ - */␊ - accessKey?: string␊ - /**␊ - * Name of the storage account.␊ - */␊ - accountName?: string␊ - /**␊ - * Path to mount the storage within the site's runtime environment.␊ - */␊ - mountPath?: string␊ - /**␊ - * Name of the file share (container name, for Blob storage).␊ - */␊ - shareName?: string␊ - /**␊ - * Type of storage.␊ - */␊ - type?: (("AzureFiles" | "AzureBlob") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * BackupRequest resource specific properties␊ - */␊ - export interface BackupRequestProperties4 {␊ - /**␊ - * Name of the backup.␊ - */␊ - backupName?: string␊ - /**␊ - * Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy.␊ - */␊ - backupSchedule?: (BackupSchedule4 | string)␊ - /**␊ - * Databases included in the backup.␊ - */␊ - databases?: (DatabaseBackupSetting4[] | string)␊ - /**␊ - * True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * SAS URL to the container.␊ - */␊ - storageAccountUrl: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy.␊ - */␊ - export interface BackupSchedule4 {␊ - /**␊ - * 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)␊ - */␊ - frequencyInterval: ((number & string) | string)␊ - /**␊ - * 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).␊ - */␊ - frequencyUnit: (("Day" | "Hour") | string)␊ - /**␊ - * True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise.␊ - */␊ - keepAtLeastOneBackup: (boolean | string)␊ - /**␊ - * After how many days backups should be deleted.␊ - */␊ - retentionPeriodInDays: ((number & string) | string)␊ - /**␊ - * When the schedule should start working.␊ - */␊ - startTime?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Database backup settings.␊ - */␊ - export interface DatabaseBackupSetting4 {␊ - /**␊ - * 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.␊ - */␊ - connectionString?: string␊ - /**␊ - * Contains a connection string name that is linked to the SiteConfig.ConnectionStrings.␊ - * This is used during restore with overwrite connection strings options.␊ - */␊ - connectionStringName?: string␊ - /**␊ - * Database type (e.g. SqlAzure / MySql).␊ - */␊ - databaseType: (("SqlAzure" | "MySql" | "LocalMySql" | "PostgreSql") | string)␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Database connection string value to type pair.␊ - */␊ - export interface ConnStringValueTypePair4 {␊ - /**␊ - * Type of database.␊ - */␊ - type: (("MySql" | "SQLServer" | "SQLAzure" | "Custom" | "NotificationHub" | "ServiceBus" | "EventHub" | "ApiHub" | "DocDb" | "RedisCache" | "PostgreSQL") | string)␊ - /**␊ - * Value of pair.␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SiteLogsConfig resource specific properties␊ - */␊ - export interface SiteLogsConfigProperties4 {␊ - /**␊ - * Application logs configuration.␊ - */␊ - applicationLogs?: (ApplicationLogsConfig4 | string)␊ - /**␊ - * Enabled configuration.␊ - */␊ - detailedErrorMessages?: (EnabledConfig4 | string)␊ - /**␊ - * Enabled configuration.␊ - */␊ - failedRequestsTracing?: (EnabledConfig4 | string)␊ - /**␊ - * Http logs configuration.␊ - */␊ - httpLogs?: (HttpLogsConfig4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application logs configuration.␊ - */␊ - export interface ApplicationLogsConfig4 {␊ - /**␊ - * Application logs azure blob storage configuration.␊ - */␊ - azureBlobStorage?: (AzureBlobStorageApplicationLogsConfig4 | string)␊ - /**␊ - * Application logs to Azure table storage configuration.␊ - */␊ - azureTableStorage?: (AzureTableStorageApplicationLogsConfig4 | string)␊ - /**␊ - * Application logs to file system configuration.␊ - */␊ - fileSystem?: (FileSystemApplicationLogsConfig4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application logs azure blob storage configuration.␊ - */␊ - export interface AzureBlobStorageApplicationLogsConfig4 {␊ - /**␊ - * Log level.␊ - */␊ - level?: (("Off" | "Verbose" | "Information" | "Warning" | "Error") | string)␊ - /**␊ - * Retention in days.␊ - * Remove blobs older than X days.␊ - * 0 or lower means no retention.␊ - */␊ - retentionInDays?: (number | string)␊ - /**␊ - * SAS url to a azure blob container with read/write/list/delete permissions.␊ - */␊ - sasUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application logs to Azure table storage configuration.␊ - */␊ - export interface AzureTableStorageApplicationLogsConfig4 {␊ - /**␊ - * Log level.␊ - */␊ - level?: (("Off" | "Verbose" | "Information" | "Warning" | "Error") | string)␊ - /**␊ - * SAS URL to an Azure table with add/query/delete permissions.␊ - */␊ - sasUrl: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application logs to file system configuration.␊ - */␊ - export interface FileSystemApplicationLogsConfig4 {␊ - /**␊ - * Log level.␊ - */␊ - level?: (("Off" | "Verbose" | "Information" | "Warning" | "Error") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Enabled configuration.␊ - */␊ - export interface EnabledConfig4 {␊ - /**␊ - * True if configuration is enabled, false if it is disabled and null if configuration is not set.␊ - */␊ - enabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http logs configuration.␊ - */␊ - export interface HttpLogsConfig4 {␊ - /**␊ - * Http logs to azure blob storage configuration.␊ - */␊ - azureBlobStorage?: (AzureBlobStorageHttpLogsConfig4 | string)␊ - /**␊ - * Http logs to file system configuration.␊ - */␊ - fileSystem?: (FileSystemHttpLogsConfig4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http logs to azure blob storage configuration.␊ - */␊ - export interface AzureBlobStorageHttpLogsConfig4 {␊ - /**␊ - * True if configuration is enabled, false if it is disabled and null if configuration is not set.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Retention in days.␊ - * Remove blobs older than X days.␊ - * 0 or lower means no retention.␊ - */␊ - retentionInDays?: (number | string)␊ - /**␊ - * SAS url to a azure blob container with read/write/list/delete permissions.␊ - */␊ - sasUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http logs to file system configuration.␊ - */␊ - export interface FileSystemHttpLogsConfig4 {␊ - /**␊ - * True if configuration is enabled, false if it is disabled and null if configuration is not set.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Retention in days.␊ - * Remove files older than X days.␊ - * 0 or lower means no retention.␊ - */␊ - retentionInDays?: (number | string)␊ - /**␊ - * 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.␊ - */␊ - retentionInMb?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Names for connection strings, application settings, and external Azure storage account configuration␊ - * identifiers 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.␊ - */␊ - export interface SlotConfigNames3 {␊ - /**␊ - * List of application settings names.␊ - */␊ - appSettingNames?: (string[] | string)␊ - /**␊ - * List of external Azure storage account identifiers.␊ - */␊ - azureStorageConfigNames?: (string[] | string)␊ - /**␊ - * List of connection string names.␊ - */␊ - connectionStringNames?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/deployments␊ - */␊ - export interface SitesDeploymentsChildResource4 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * ID of an existing deployment.␊ - */␊ - name: string␊ - /**␊ - * Deployment resource specific properties␊ - */␊ - properties: (DeploymentProperties6 | string)␊ - type: "deployments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Deployment resource specific properties␊ - */␊ - export interface DeploymentProperties6 {␊ - /**␊ - * True if deployment is currently active, false if completed and null if not started.␊ - */␊ - active?: (boolean | string)␊ - /**␊ - * Who authored the deployment.␊ - */␊ - author?: string␊ - /**␊ - * Author email.␊ - */␊ - author_email?: string␊ - /**␊ - * Who performed the deployment.␊ - */␊ - deployer?: string␊ - /**␊ - * Details on deployment.␊ - */␊ - details?: string␊ - /**␊ - * End time.␊ - */␊ - end_time?: string␊ - /**␊ - * Details about deployment status.␊ - */␊ - message?: string␊ - /**␊ - * Start time.␊ - */␊ - start_time?: string␊ - /**␊ - * Deployment status.␊ - */␊ - status?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/domainOwnershipIdentifiers␊ - */␊ - export interface SitesDomainOwnershipIdentifiersChildResource3 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of domain ownership identifier.␊ - */␊ - name: string␊ - /**␊ - * Identifier resource specific properties␊ - */␊ - properties: (IdentifierProperties3 | string)␊ - type: "domainOwnershipIdentifiers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identifier resource specific properties␊ - */␊ - export interface IdentifierProperties3 {␊ - /**␊ - * String representation of the identity.␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/extensions␊ - */␊ - export interface SitesExtensionsChildResource3 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "MSDeploy"␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - properties: (MSDeployCore3 | string)␊ - type: "extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - export interface MSDeployCore3 {␊ - /**␊ - * Sets the AppOffline rule while the MSDeploy operation executes.␊ - * Setting is false by default.␊ - */␊ - appOffline?: (boolean | string)␊ - /**␊ - * SQL Connection String␊ - */␊ - connectionString?: string␊ - /**␊ - * Database Type␊ - */␊ - dbType?: string␊ - /**␊ - * Package URI␊ - */␊ - packageUri?: string␊ - /**␊ - * MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used.␊ - */␊ - setParameters?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * URI of MSDeploy Parameters file. Must not be set if SetParameters is used.␊ - */␊ - setParametersXmlFileUri?: string␊ - /**␊ - * 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.␊ - */␊ - skipAppData?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/functions␊ - */␊ - export interface SitesFunctionsChildResource3 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Function name.␊ - */␊ - name: string␊ - /**␊ - * FunctionEnvelope resource specific properties␊ - */␊ - properties: (FunctionEnvelopeProperties3 | string)␊ - type: "functions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * FunctionEnvelope resource specific properties␊ - */␊ - export interface FunctionEnvelopeProperties3 {␊ - /**␊ - * Config information.␊ - */␊ - config?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Config URI.␊ - */␊ - config_href?: string␊ - /**␊ - * File list.␊ - */␊ - files?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Function App ID.␊ - */␊ - function_app_id?: string␊ - /**␊ - * Function URI.␊ - */␊ - href?: string␊ - /**␊ - * The invocation URL␊ - */␊ - invoke_url_template?: string␊ - /**␊ - * Gets or sets a value indicating whether the function is disabled␊ - */␊ - isDisabled?: (boolean | string)␊ - /**␊ - * The function language␊ - */␊ - language?: string␊ - /**␊ - * Script URI.␊ - */␊ - script_href?: string␊ - /**␊ - * Script root path URI.␊ - */␊ - script_root_path_href?: string␊ - /**␊ - * Secrets file URI.␊ - */␊ - secrets_file_href?: string␊ - /**␊ - * Test data used when testing via the Azure Portal.␊ - */␊ - test_data?: string␊ - /**␊ - * Test data URI.␊ - */␊ - test_data_href?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/hostNameBindings␊ - */␊ - export interface SitesHostNameBindingsChildResource4 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Hostname in the hostname binding.␊ - */␊ - name: string␊ - /**␊ - * HostNameBinding resource specific properties␊ - */␊ - properties: (HostNameBindingProperties4 | string)␊ - type: "hostNameBindings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HostNameBinding resource specific properties␊ - */␊ - export interface HostNameBindingProperties4 {␊ - /**␊ - * Azure resource name.␊ - */␊ - azureResourceName?: string␊ - /**␊ - * Azure resource type.␊ - */␊ - azureResourceType?: (("Website" | "TrafficManager") | string)␊ - /**␊ - * Custom DNS record type.␊ - */␊ - customHostNameDnsRecordType?: (("CName" | "A") | string)␊ - /**␊ - * Fully qualified ARM domain resource URI.␊ - */␊ - domainId?: string␊ - /**␊ - * Hostname type.␊ - */␊ - hostNameType?: (("Verified" | "Managed") | string)␊ - /**␊ - * App Service app name.␊ - */␊ - siteName?: string␊ - /**␊ - * SSL type.␊ - */␊ - sslState?: (("Disabled" | "SniEnabled" | "IpBasedEnabled") | string)␊ - /**␊ - * SSL certificate thumbprint␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/hybridconnection␊ - */␊ - export interface SitesHybridconnectionChildResource4 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the hybrid connection configuration.␊ - */␊ - name: string␊ - /**␊ - * RelayServiceConnectionEntity resource specific properties␊ - */␊ - properties: (RelayServiceConnectionEntityProperties4 | string)␊ - type: "hybridconnection"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * RelayServiceConnectionEntity resource specific properties␊ - */␊ - export interface RelayServiceConnectionEntityProperties4 {␊ - biztalkUri?: string␊ - entityConnectionString?: string␊ - entityName?: string␊ - hostname?: string␊ - port?: (number | string)␊ - resourceConnectionString?: string␊ - resourceType?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/migrate␊ - */␊ - export interface SitesMigrateChildResource3 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "migrate"␊ - /**␊ - * StorageMigrationOptions resource specific properties␊ - */␊ - properties: (StorageMigrationOptionsProperties3 | string)␊ - type: "migrate"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * StorageMigrationOptions resource specific properties␊ - */␊ - export interface StorageMigrationOptionsProperties3 {␊ - /**␊ - * AzureFiles connection string.␊ - */␊ - azurefilesConnectionString: string␊ - /**␊ - * AzureFiles share.␊ - */␊ - azurefilesShare: string␊ - /**␊ - * true if the app should be read only during copy operation; otherwise, false.␊ - */␊ - blockWriteAccessToSite?: (boolean | string)␊ - /**␊ - * trueif the app should be switched over; otherwise, false.␊ - */␊ - switchSiteAfterMigration?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/networkConfig␊ - */␊ - export interface SitesNetworkConfigChildResource2 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "virtualNetwork"␊ - /**␊ - * SwiftVirtualNetwork resource specific properties␊ - */␊ - properties: (SwiftVirtualNetworkProperties2 | string)␊ - type: "networkConfig"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SwiftVirtualNetwork resource specific properties␊ - */␊ - export interface SwiftVirtualNetworkProperties2 {␊ - /**␊ - * The Virtual Network subnet's resource ID. This is the subnet that this Web App will join. This subnet must have a delegation to Microsoft.Web/serverFarms defined first.␊ - */␊ - subnetResourceId?: string␊ - /**␊ - * A flag that specifies if the scale unit this Web App is on supports Swift integration.␊ - */␊ - swiftSupported?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/premieraddons␊ - */␊ - export interface SitesPremieraddonsChildResource4 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Add-on name.␊ - */␊ - name: string␊ - /**␊ - * PremierAddOn resource specific properties␊ - */␊ - properties: (PremierAddOnProperties3 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "premieraddons"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * PremierAddOn resource specific properties␊ - */␊ - export interface PremierAddOnProperties3 {␊ - /**␊ - * Premier add on Marketplace offer.␊ - */␊ - marketplaceOffer?: string␊ - /**␊ - * Premier add on Marketplace publisher.␊ - */␊ - marketplacePublisher?: string␊ - /**␊ - * Premier add on Product.␊ - */␊ - product?: string␊ - /**␊ - * Premier add on SKU.␊ - */␊ - sku?: string␊ - /**␊ - * Premier add on Vendor.␊ - */␊ - vendor?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/privateAccess␊ - */␊ - export interface SitesPrivateAccessChildResource2 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "virtualNetworks"␊ - /**␊ - * PrivateAccess resource specific properties␊ - */␊ - properties: (PrivateAccessProperties2 | string)␊ - type: "privateAccess"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * PrivateAccess resource specific properties␊ - */␊ - export interface PrivateAccessProperties2 {␊ - /**␊ - * Whether private access is enabled or not.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * The Virtual Networks (and subnets) allowed to access the site privately.␊ - */␊ - virtualNetworks?: (PrivateAccessVirtualNetwork2[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a Virtual Network that is useable for private site access.␊ - */␊ - export interface PrivateAccessVirtualNetwork2 {␊ - /**␊ - * The key (ID) of the Virtual Network.␊ - */␊ - key?: (number | string)␊ - /**␊ - * The name of the Virtual Network.␊ - */␊ - name?: string␊ - /**␊ - * The ARM uri of the Virtual Network␊ - */␊ - resourceId?: string␊ - /**␊ - * A List of subnets that access is allowed to on this Virtual Network. An empty array (but not null) is interpreted to mean that all subnets are allowed within this Virtual Network.␊ - */␊ - subnets?: (PrivateAccessSubnet2[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a Virtual Network subnet that is useable for private site access.␊ - */␊ - export interface PrivateAccessSubnet2 {␊ - /**␊ - * The key (ID) of the subnet.␊ - */␊ - key?: (number | string)␊ - /**␊ - * The name of the subnet.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/publicCertificates␊ - */␊ - export interface SitesPublicCertificatesChildResource3 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Public certificate name.␊ - */␊ - name: string␊ - /**␊ - * PublicCertificate resource specific properties␊ - */␊ - properties: (PublicCertificateProperties3 | string)␊ - type: "publicCertificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * PublicCertificate resource specific properties␊ - */␊ - export interface PublicCertificateProperties3 {␊ - /**␊ - * Public Certificate byte array␊ - */␊ - blob?: string␊ - /**␊ - * Public Certificate Location.␊ - */␊ - publicCertificateLocation?: (("CurrentUserMy" | "LocalMachineMy" | "Unknown") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/siteextensions␊ - */␊ - export interface SitesSiteextensionsChildResource3 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Site extension name.␊ - */␊ - name: string␊ - type: "siteextensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots␊ - */␊ - export interface SitesSlotsChildResource4 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Managed service identity.␊ - */␊ - identity?: (ManagedServiceIdentity17 | string)␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the deployment slot to create or update. The name 'production' is reserved.␊ - */␊ - name: string␊ - /**␊ - * Site resource specific properties␊ - */␊ - properties: (SiteProperties4 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "slots"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/privateEndpointConnections␊ - */␊ - export interface SitesPrivateEndpointConnectionsChildResource {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * A request to approve or reject a private endpoint connection␊ - */␊ - properties: (PrivateLinkConnectionApprovalRequest1 | string)␊ - type: "privateEndpointConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A request to approve or reject a private endpoint connection␊ - */␊ - export interface PrivateLinkConnectionApprovalRequest1 {␊ - /**␊ - * The state of a private link connection␊ - */␊ - privateLinkServiceConnectionState?: (PrivateLinkConnectionState1 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The state of a private link connection␊ - */␊ - export interface PrivateLinkConnectionState1 {␊ - /**␊ - * ActionsRequired for a private link connection␊ - */␊ - actionsRequired?: string␊ - /**␊ - * Description of a private link connection␊ - */␊ - description?: string␊ - /**␊ - * Status of a private link connection␊ - */␊ - status?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/sourcecontrols␊ - */␊ - export interface SitesSourcecontrolsChildResource4 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "web"␊ - /**␊ - * SiteSourceControl resource specific properties␊ - */␊ - properties: (SiteSourceControlProperties4 | string)␊ - type: "sourcecontrols"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SiteSourceControl resource specific properties␊ - */␊ - export interface SiteSourceControlProperties4 {␊ - /**␊ - * Name of branch to use for deployment.␊ - */␊ - branch?: string␊ - /**␊ - * true to enable deployment rollback; otherwise, false.␊ - */␊ - deploymentRollbackEnabled?: (boolean | string)␊ - /**␊ - * true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub).␊ - */␊ - isManualIntegration?: (boolean | string)␊ - /**␊ - * true for a Mercurial repository; false for a Git repository.␊ - */␊ - isMercurial?: (boolean | string)␊ - /**␊ - * Repository or source control URL.␊ - */␊ - repoUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/virtualNetworkConnections␊ - */␊ - export interface SitesVirtualNetworkConnectionsChildResource4 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of an existing Virtual Network.␊ - */␊ - name: string␊ - /**␊ - * VnetInfo resource specific properties␊ - */␊ - properties: (VnetInfoProperties4 | string)␊ - type: "virtualNetworkConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VnetInfo resource specific properties␊ - */␊ - export interface VnetInfoProperties4 {␊ - /**␊ - * A certificate file (.cer) blob containing the public key of the private key used to authenticate a ␊ - * Point-To-Site VPN connection.␊ - */␊ - certBlob?: string␊ - /**␊ - * DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses.␊ - */␊ - dnsServers?: string␊ - /**␊ - * Flag that is used to denote if this is VNET injection␊ - */␊ - isSwift?: (boolean | string)␊ - /**␊ - * The Virtual Network's resource ID.␊ - */␊ - vnetResourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/deployments␊ - */␊ - export interface SitesDeployments4 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * ID of an existing deployment.␊ - */␊ - name: string␊ - /**␊ - * Deployment resource specific properties␊ - */␊ - properties: (DeploymentProperties6 | string)␊ - type: "Microsoft.Web/sites/deployments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/domainOwnershipIdentifiers␊ - */␊ - export interface SitesDomainOwnershipIdentifiers3 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of domain ownership identifier.␊ - */␊ - name: string␊ - /**␊ - * Identifier resource specific properties␊ - */␊ - properties: (IdentifierProperties3 | string)␊ - type: "Microsoft.Web/sites/domainOwnershipIdentifiers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/extensions␊ - */␊ - export interface SitesExtensions3 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - properties: (MSDeployCore3 | string)␊ - type: "Microsoft.Web/sites/extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/functions␊ - */␊ - export interface SitesFunctions3 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Function name.␊ - */␊ - name: string␊ - /**␊ - * FunctionEnvelope resource specific properties␊ - */␊ - properties: (FunctionEnvelopeProperties3 | string)␊ - resources?: SitesFunctionsKeysChildResource1[]␊ - type: "Microsoft.Web/sites/functions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/functions/keys␊ - */␊ - export interface SitesFunctionsKeysChildResource1 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * The name of the key.␊ - */␊ - name: string␊ - type: "keys"␊ - /**␊ - * Key value␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/functions/keys␊ - */␊ - export interface SitesFunctionsKeys1 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * The name of the key.␊ - */␊ - name: string␊ - type: "Microsoft.Web/sites/functions/keys"␊ - /**␊ - * Key value␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/hostNameBindings␊ - */␊ - export interface SitesHostNameBindings4 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Hostname in the hostname binding.␊ - */␊ - name: string␊ - /**␊ - * HostNameBinding resource specific properties␊ - */␊ - properties: (HostNameBindingProperties4 | string)␊ - type: "Microsoft.Web/sites/hostNameBindings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/hybridconnection␊ - */␊ - export interface SitesHybridconnection4 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the hybrid connection configuration.␊ - */␊ - name: string␊ - /**␊ - * RelayServiceConnectionEntity resource specific properties␊ - */␊ - properties: (RelayServiceConnectionEntityProperties4 | string)␊ - type: "Microsoft.Web/sites/hybridconnection"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/hybridConnectionNamespaces/relays␊ - */␊ - export interface SitesHybridConnectionNamespacesRelays3 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * The relay name for this hybrid connection.␊ - */␊ - name: string␊ - /**␊ - * HybridConnection resource specific properties␊ - */␊ - properties: (HybridConnectionProperties5 | string)␊ - type: "Microsoft.Web/sites/hybridConnectionNamespaces/relays"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HybridConnection resource specific properties␊ - */␊ - export interface HybridConnectionProperties5 {␊ - /**␊ - * The hostname of the endpoint.␊ - */␊ - hostname?: string␊ - /**␊ - * The port of the endpoint.␊ - */␊ - port?: (number | string)␊ - /**␊ - * The ARM URI to the Service Bus relay.␊ - */␊ - relayArmUri?: string␊ - /**␊ - * The name of the Service Bus relay.␊ - */␊ - relayName?: string␊ - /**␊ - * The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus.␊ - */␊ - sendKeyName?: string␊ - /**␊ - * 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.␊ - */␊ - sendKeyValue?: string␊ - /**␊ - * The name of the Service Bus namespace.␊ - */␊ - serviceBusNamespace?: string␊ - /**␊ - * The suffix for the service bus endpoint. By default this is .servicebus.windows.net␊ - */␊ - serviceBusSuffix?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/instances/extensions␊ - */␊ - export interface SitesInstancesExtensions3 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - properties: (MSDeployCore3 | string)␊ - type: "Microsoft.Web/sites/instances/extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/migrate␊ - */␊ - export interface SitesMigrate3 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * StorageMigrationOptions resource specific properties␊ - */␊ - properties: (StorageMigrationOptionsProperties3 | string)␊ - type: "Microsoft.Web/sites/migrate"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/networkConfig␊ - */␊ - export interface SitesNetworkConfig2 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SwiftVirtualNetwork resource specific properties␊ - */␊ - properties: (SwiftVirtualNetworkProperties2 | string)␊ - type: "Microsoft.Web/sites/networkConfig"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/premieraddons␊ - */␊ - export interface SitesPremieraddons4 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Add-on name.␊ - */␊ - name: string␊ - /**␊ - * PremierAddOn resource specific properties␊ - */␊ - properties: (PremierAddOnProperties3 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/sites/premieraddons"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/privateAccess␊ - */␊ - export interface SitesPrivateAccess2 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * PrivateAccess resource specific properties␊ - */␊ - properties: (PrivateAccessProperties2 | string)␊ - type: "Microsoft.Web/sites/privateAccess"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/privateEndpointConnections␊ - */␊ - export interface SitesPrivateEndpointConnections {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * A request to approve or reject a private endpoint connection␊ - */␊ - properties: (PrivateLinkConnectionApprovalRequest1 | string)␊ - type: "Microsoft.Web/sites/privateEndpointConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/publicCertificates␊ - */␊ - export interface SitesPublicCertificates3 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Public certificate name.␊ - */␊ - name: string␊ - /**␊ - * PublicCertificate resource specific properties␊ - */␊ - properties: (PublicCertificateProperties3 | string)␊ - type: "Microsoft.Web/sites/publicCertificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/siteextensions␊ - */␊ - export interface SitesSiteextensions3 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Site extension name.␊ - */␊ - name: string␊ - type: "Microsoft.Web/sites/siteextensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots␊ - */␊ - export interface SitesSlots4 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Managed service identity.␊ - */␊ - identity?: (ManagedServiceIdentity17 | string)␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the deployment slot to create or update. The name 'production' is reserved.␊ - */␊ - name: string␊ - /**␊ - * Site resource specific properties␊ - */␊ - properties: (SiteProperties4 | string)␊ - resources?: (SitesSlotsConfigChildResource4 | SitesSlotsDeploymentsChildResource4 | SitesSlotsDomainOwnershipIdentifiersChildResource3 | SitesSlotsExtensionsChildResource3 | SitesSlotsFunctionsChildResource3 | SitesSlotsHostNameBindingsChildResource4 | SitesSlotsHybridconnectionChildResource4 | SitesSlotsNetworkConfigChildResource2 | SitesSlotsPremieraddonsChildResource4 | SitesSlotsPrivateAccessChildResource2 | SitesSlotsPublicCertificatesChildResource3 | SitesSlotsSiteextensionsChildResource3 | SitesSlotsSourcecontrolsChildResource4 | SitesSlotsVirtualNetworkConnectionsChildResource4)[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/sites/slots"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/deployments␊ - */␊ - export interface SitesSlotsDeploymentsChildResource4 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * ID of an existing deployment.␊ - */␊ - name: string␊ - /**␊ - * Deployment resource specific properties␊ - */␊ - properties: (DeploymentProperties6 | string)␊ - type: "deployments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/domainOwnershipIdentifiers␊ - */␊ - export interface SitesSlotsDomainOwnershipIdentifiersChildResource3 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of domain ownership identifier.␊ - */␊ - name: string␊ - /**␊ - * Identifier resource specific properties␊ - */␊ - properties: (IdentifierProperties3 | string)␊ - type: "domainOwnershipIdentifiers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/extensions␊ - */␊ - export interface SitesSlotsExtensionsChildResource3 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "MSDeploy"␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - properties: (MSDeployCore3 | string)␊ - type: "extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/functions␊ - */␊ - export interface SitesSlotsFunctionsChildResource3 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Function name.␊ - */␊ - name: string␊ - /**␊ - * FunctionEnvelope resource specific properties␊ - */␊ - properties: (FunctionEnvelopeProperties3 | string)␊ - type: "functions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/hostNameBindings␊ - */␊ - export interface SitesSlotsHostNameBindingsChildResource4 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Hostname in the hostname binding.␊ - */␊ - name: string␊ - /**␊ - * HostNameBinding resource specific properties␊ - */␊ - properties: (HostNameBindingProperties4 | string)␊ - type: "hostNameBindings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/hybridconnection␊ - */␊ - export interface SitesSlotsHybridconnectionChildResource4 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the hybrid connection configuration.␊ - */␊ - name: string␊ - /**␊ - * RelayServiceConnectionEntity resource specific properties␊ - */␊ - properties: (RelayServiceConnectionEntityProperties4 | string)␊ - type: "hybridconnection"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/networkConfig␊ - */␊ - export interface SitesSlotsNetworkConfigChildResource2 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "virtualNetwork"␊ - /**␊ - * SwiftVirtualNetwork resource specific properties␊ - */␊ - properties: (SwiftVirtualNetworkProperties2 | string)␊ - type: "networkConfig"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/premieraddons␊ - */␊ - export interface SitesSlotsPremieraddonsChildResource4 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Add-on name.␊ - */␊ - name: string␊ - /**␊ - * PremierAddOn resource specific properties␊ - */␊ - properties: (PremierAddOnProperties3 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "premieraddons"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/privateAccess␊ - */␊ - export interface SitesSlotsPrivateAccessChildResource2 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "virtualNetworks"␊ - /**␊ - * PrivateAccess resource specific properties␊ - */␊ - properties: (PrivateAccessProperties2 | string)␊ - type: "privateAccess"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/publicCertificates␊ - */␊ - export interface SitesSlotsPublicCertificatesChildResource3 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Public certificate name.␊ - */␊ - name: string␊ - /**␊ - * PublicCertificate resource specific properties␊ - */␊ - properties: (PublicCertificateProperties3 | string)␊ - type: "publicCertificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/siteextensions␊ - */␊ - export interface SitesSlotsSiteextensionsChildResource3 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Site extension name.␊ - */␊ - name: string␊ - type: "siteextensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/sourcecontrols␊ - */␊ - export interface SitesSlotsSourcecontrolsChildResource4 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "web"␊ - /**␊ - * SiteSourceControl resource specific properties␊ - */␊ - properties: (SiteSourceControlProperties4 | string)␊ - type: "sourcecontrols"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/virtualNetworkConnections␊ - */␊ - export interface SitesSlotsVirtualNetworkConnectionsChildResource4 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of an existing Virtual Network.␊ - */␊ - name: string␊ - /**␊ - * VnetInfo resource specific properties␊ - */␊ - properties: (VnetInfoProperties4 | string)␊ - type: "virtualNetworkConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/deployments␊ - */␊ - export interface SitesSlotsDeployments4 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * ID of an existing deployment.␊ - */␊ - name: string␊ - /**␊ - * Deployment resource specific properties␊ - */␊ - properties: (DeploymentProperties6 | string)␊ - type: "Microsoft.Web/sites/slots/deployments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/domainOwnershipIdentifiers␊ - */␊ - export interface SitesSlotsDomainOwnershipIdentifiers3 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of domain ownership identifier.␊ - */␊ - name: string␊ - /**␊ - * Identifier resource specific properties␊ - */␊ - properties: (IdentifierProperties3 | string)␊ - type: "Microsoft.Web/sites/slots/domainOwnershipIdentifiers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/extensions␊ - */␊ - export interface SitesSlotsExtensions3 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - properties: (MSDeployCore3 | string)␊ - type: "Microsoft.Web/sites/slots/extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/functions␊ - */␊ - export interface SitesSlotsFunctions3 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Function name.␊ - */␊ - name: string␊ - /**␊ - * FunctionEnvelope resource specific properties␊ - */␊ - properties: (FunctionEnvelopeProperties3 | string)␊ - resources?: SitesSlotsFunctionsKeysChildResource1[]␊ - type: "Microsoft.Web/sites/slots/functions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/functions/keys␊ - */␊ - export interface SitesSlotsFunctionsKeysChildResource1 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * The name of the key.␊ - */␊ - name: string␊ - type: "keys"␊ - /**␊ - * Key value␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/functions/keys␊ - */␊ - export interface SitesSlotsFunctionsKeys1 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * The name of the key.␊ - */␊ - name: string␊ - type: "Microsoft.Web/sites/slots/functions/keys"␊ - /**␊ - * Key value␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/hostNameBindings␊ - */␊ - export interface SitesSlotsHostNameBindings4 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Hostname in the hostname binding.␊ - */␊ - name: string␊ - /**␊ - * HostNameBinding resource specific properties␊ - */␊ - properties: (HostNameBindingProperties4 | string)␊ - type: "Microsoft.Web/sites/slots/hostNameBindings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/hybridconnection␊ - */␊ - export interface SitesSlotsHybridconnection4 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the hybrid connection configuration.␊ - */␊ - name: string␊ - /**␊ - * RelayServiceConnectionEntity resource specific properties␊ - */␊ - properties: (RelayServiceConnectionEntityProperties4 | string)␊ - type: "Microsoft.Web/sites/slots/hybridconnection"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays␊ - */␊ - export interface SitesSlotsHybridConnectionNamespacesRelays3 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * The relay name for this hybrid connection.␊ - */␊ - name: string␊ - /**␊ - * HybridConnection resource specific properties␊ - */␊ - properties: (HybridConnectionProperties5 | string)␊ - type: "Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/instances/extensions␊ - */␊ - export interface SitesSlotsInstancesExtensions3 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - properties: (MSDeployCore3 | string)␊ - type: "Microsoft.Web/sites/slots/instances/extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/networkConfig␊ - */␊ - export interface SitesSlotsNetworkConfig2 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SwiftVirtualNetwork resource specific properties␊ - */␊ - properties: (SwiftVirtualNetworkProperties2 | string)␊ - type: "Microsoft.Web/sites/slots/networkConfig"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/premieraddons␊ - */␊ - export interface SitesSlotsPremieraddons4 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Add-on name.␊ - */␊ - name: string␊ - /**␊ - * PremierAddOn resource specific properties␊ - */␊ - properties: (PremierAddOnProperties3 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/sites/slots/premieraddons"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/privateAccess␊ - */␊ - export interface SitesSlotsPrivateAccess2 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * PrivateAccess resource specific properties␊ - */␊ - properties: (PrivateAccessProperties2 | string)␊ - type: "Microsoft.Web/sites/slots/privateAccess"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/publicCertificates␊ - */␊ - export interface SitesSlotsPublicCertificates3 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Public certificate name.␊ - */␊ - name: string␊ - /**␊ - * PublicCertificate resource specific properties␊ - */␊ - properties: (PublicCertificateProperties3 | string)␊ - type: "Microsoft.Web/sites/slots/publicCertificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/siteextensions␊ - */␊ - export interface SitesSlotsSiteextensions3 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Site extension name.␊ - */␊ - name: string␊ - type: "Microsoft.Web/sites/slots/siteextensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/sourcecontrols␊ - */␊ - export interface SitesSlotsSourcecontrols4 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteSourceControl resource specific properties␊ - */␊ - properties: (SiteSourceControlProperties4 | string)␊ - type: "Microsoft.Web/sites/slots/sourcecontrols"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/virtualNetworkConnections␊ - */␊ - export interface SitesSlotsVirtualNetworkConnections4 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of an existing Virtual Network.␊ - */␊ - name: string␊ - /**␊ - * VnetInfo resource specific properties␊ - */␊ - properties: (VnetInfoProperties4 | string)␊ - resources?: SitesSlotsVirtualNetworkConnectionsGatewaysChildResource4[]␊ - type: "Microsoft.Web/sites/slots/virtualNetworkConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/virtualNetworkConnections/gateways␊ - */␊ - export interface SitesSlotsVirtualNetworkConnectionsGatewaysChildResource4 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the gateway. Currently, the only supported string is "primary".␊ - */␊ - name: string␊ - /**␊ - * VnetGateway resource specific properties␊ - */␊ - properties: (VnetGatewayProperties5 | string)␊ - type: "gateways"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/virtualNetworkConnections/gateways␊ - */␊ - export interface SitesSlotsVirtualNetworkConnectionsGateways4 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the gateway. Currently, the only supported string is "primary".␊ - */␊ - name: string␊ - /**␊ - * VnetGateway resource specific properties␊ - */␊ - properties: (VnetGatewayProperties5 | string)␊ - type: "Microsoft.Web/sites/slots/virtualNetworkConnections/gateways"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/sourcecontrols␊ - */␊ - export interface SitesSourcecontrols4 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteSourceControl resource specific properties␊ - */␊ - properties: (SiteSourceControlProperties4 | string)␊ - type: "Microsoft.Web/sites/sourcecontrols"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/virtualNetworkConnections␊ - */␊ - export interface SitesVirtualNetworkConnections4 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of an existing Virtual Network.␊ - */␊ - name: string␊ - /**␊ - * VnetInfo resource specific properties␊ - */␊ - properties: (VnetInfoProperties4 | string)␊ - resources?: SitesVirtualNetworkConnectionsGatewaysChildResource4[]␊ - type: "Microsoft.Web/sites/virtualNetworkConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/virtualNetworkConnections/gateways␊ - */␊ - export interface SitesVirtualNetworkConnectionsGatewaysChildResource4 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the gateway. Currently, the only supported string is "primary".␊ - */␊ - name: string␊ - /**␊ - * VnetGateway resource specific properties␊ - */␊ - properties: (VnetGatewayProperties5 | string)␊ - type: "gateways"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/virtualNetworkConnections/gateways␊ - */␊ - export interface SitesVirtualNetworkConnectionsGateways4 {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the gateway. Currently, the only supported string is "primary".␊ - */␊ - name: string␊ - /**␊ - * VnetGateway resource specific properties␊ - */␊ - properties: (VnetGatewayProperties5 | string)␊ - type: "Microsoft.Web/sites/virtualNetworkConnections/gateways"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/staticSites␊ - */␊ - export interface StaticSites {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the static site to create or update.␊ - */␊ - name: string␊ - /**␊ - * A static site.␊ - */␊ - properties: (StaticSite | string)␊ - resources?: (StaticSitesConfigChildResource | StaticSitesCustomDomainsChildResource)[]␊ - /**␊ - * Description of a SKU for a scalable resource.␊ - */␊ - sku?: (SkuDescription5 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/staticSites"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A static site.␊ - */␊ - export interface StaticSite {␊ - /**␊ - * The target branch in the repository.␊ - */␊ - branch?: string␊ - /**␊ - * Build properties for the static site.␊ - */␊ - buildProperties?: (StaticSiteBuildProperties | string)␊ - /**␊ - * A user's github repository token. This is used to setup the Github Actions workflow file and API secrets.␊ - */␊ - repositoryToken?: string␊ - /**␊ - * URL for the repository of the static site.␊ - */␊ - repositoryUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Build properties for the static site.␊ - */␊ - export interface StaticSiteBuildProperties {␊ - /**␊ - * The path to the api code within the repository.␊ - */␊ - apiLocation?: string␊ - /**␊ - * The path of the app artifacts after building.␊ - */␊ - appArtifactLocation?: string␊ - /**␊ - * The path to the app code within the repository.␊ - */␊ - appLocation?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/staticSites/config␊ - */␊ - export interface StaticSitesConfigChildResource {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "functionappsettings"␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - type: "config"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/staticSites/customDomains␊ - */␊ - export interface StaticSitesCustomDomainsChildResource {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * The custom domain to create.␊ - */␊ - name: string␊ - type: "customDomains"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/staticSites/builds/config␊ - */␊ - export interface StaticSitesBuildsConfig {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/staticSites/builds/config"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/staticSites/config␊ - */␊ - export interface StaticSitesConfig {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/staticSites/config"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/staticSites/customDomains␊ - */␊ - export interface StaticSitesCustomDomains {␊ - apiVersion: "2019-08-01"␊ - /**␊ - * The custom domain to create.␊ - */␊ - name: string␊ - type: "Microsoft.Web/staticSites/customDomains"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/certificates␊ - */␊ - export interface Certificates5 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the certificate.␊ - */␊ - name: string␊ - /**␊ - * Certificate resource specific properties␊ - */␊ - properties: (CertificateProperties5 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/certificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Certificate resource specific properties␊ - */␊ - export interface CertificateProperties5 {␊ - /**␊ - * CNAME of the certificate to be issued via free certificate␊ - */␊ - canonicalName?: string␊ - /**␊ - * Host names the certificate applies to.␊ - */␊ - hostNames?: (string[] | string)␊ - /**␊ - * Key Vault Csm resource Id.␊ - */␊ - keyVaultId?: string␊ - /**␊ - * Key Vault secret name.␊ - */␊ - keyVaultSecretName?: string␊ - /**␊ - * Certificate password.␊ - */␊ - password: string␊ - /**␊ - * Pfx blob.␊ - */␊ - pfxBlob?: string␊ - /**␊ - * Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".␊ - */␊ - serverFarmId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/hostingEnvironments␊ - */␊ - export interface HostingEnvironments4 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the App Service Environment.␊ - */␊ - name: string␊ - /**␊ - * Description of an App Service Environment.␊ - */␊ - properties: (AppServiceEnvironment3 | string)␊ - resources?: (HostingEnvironmentsMultiRolePoolsChildResource4 | HostingEnvironmentsWorkerPoolsChildResource4)[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/hostingEnvironments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of an App Service Environment.␊ - */␊ - export interface AppServiceEnvironment3 {␊ - /**␊ - * API Management Account associated with the App Service Environment.␊ - */␊ - apiManagementAccountId?: string␊ - /**␊ - * Custom settings for changing the behavior of the App Service Environment.␊ - */␊ - clusterSettings?: (NameValuePair6[] | string)␊ - /**␊ - * DNS suffix of the App Service Environment.␊ - */␊ - dnsSuffix?: string␊ - /**␊ - * True/false indicating whether the App Service Environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available␊ - * (most likely because NSG blocked the incoming traffic).␊ - */␊ - dynamicCacheEnabled?: (boolean | string)␊ - /**␊ - * Scale factor for front-ends.␊ - */␊ - frontEndScaleFactor?: (number | string)␊ - /**␊ - * Flag that displays whether an ASE has linux workers or not␊ - */␊ - hasLinuxWorkers?: (boolean | string)␊ - /**␊ - * Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.␊ - */␊ - internalLoadBalancingMode?: (("None" | "Web" | "Publishing" | "Web,Publishing") | string)␊ - /**␊ - * Number of IP SSL addresses reserved for the App Service Environment.␊ - */␊ - ipsslAddressCount?: (number | string)␊ - /**␊ - * Location of the App Service Environment, e.g. "West US".␊ - */␊ - location: string␊ - /**␊ - * Number of front-end instances.␊ - */␊ - multiRoleCount?: (number | string)␊ - /**␊ - * Front-end VM size, e.g. "Medium", "Large".␊ - */␊ - multiSize?: string␊ - /**␊ - * Name of the App Service Environment.␊ - */␊ - name: string␊ - /**␊ - * Access control list for controlling traffic to the App Service Environment.␊ - */␊ - networkAccessControlList?: (NetworkAccessControlEntry4[] | string)␊ - /**␊ - * Key Vault ID for ILB App Service Environment default SSL certificate␊ - */␊ - sslCertKeyVaultId?: string␊ - /**␊ - * Key Vault Secret Name for ILB App Service Environment default SSL certificate␊ - */␊ - sslCertKeyVaultSecretName?: string␊ - /**␊ - * true if the App Service Environment is suspended; otherwise, false. The environment can be suspended, e.g. when the management endpoint is no longer available␊ - * (most likely because NSG blocked the incoming traffic).␊ - */␊ - suspended?: (boolean | string)␊ - /**␊ - * User added ip ranges to whitelist on ASE db␊ - */␊ - userWhitelistedIpRanges?: (string[] | string)␊ - /**␊ - * Specification for using a Virtual Network.␊ - */␊ - virtualNetwork: (VirtualNetworkProfile7 | string)␊ - /**␊ - * Name of the Virtual Network for the App Service Environment.␊ - */␊ - vnetName?: string␊ - /**␊ - * Resource group of the Virtual Network.␊ - */␊ - vnetResourceGroupName?: string␊ - /**␊ - * Subnet of the Virtual Network.␊ - */␊ - vnetSubnetName?: string␊ - /**␊ - * Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool.␊ - */␊ - workerPools: (WorkerPool4[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Name value pair.␊ - */␊ - export interface NameValuePair6 {␊ - /**␊ - * Pair name.␊ - */␊ - name?: string␊ - /**␊ - * Pair value.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network access control entry.␊ - */␊ - export interface NetworkAccessControlEntry4 {␊ - /**␊ - * Action object.␊ - */␊ - action?: (("Permit" | "Deny") | string)␊ - /**␊ - * Description of network access control entry.␊ - */␊ - description?: string␊ - /**␊ - * Order of precedence.␊ - */␊ - order?: (number | string)␊ - /**␊ - * Remote subnet.␊ - */␊ - remoteSubnet?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specification for using a Virtual Network.␊ - */␊ - export interface VirtualNetworkProfile7 {␊ - /**␊ - * Resource id of the Virtual Network.␊ - */␊ - id?: string␊ - /**␊ - * Subnet within the Virtual Network.␊ - */␊ - subnet?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Worker pool of an App Service Environment.␊ - */␊ - export interface WorkerPool4 {␊ - /**␊ - * Shared or dedicated app hosting.␊ - */␊ - computeMode?: (("Shared" | "Dedicated" | "Dynamic") | string)␊ - /**␊ - * Number of instances in the worker pool.␊ - */␊ - workerCount?: (number | string)␊ - /**␊ - * VM size of the worker pool instances.␊ - */␊ - workerSize?: string␊ - /**␊ - * Worker size ID for referencing this worker pool.␊ - */␊ - workerSizeId?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/hostingEnvironments/multiRolePools␊ - */␊ - export interface HostingEnvironmentsMultiRolePoolsChildResource4 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "default"␊ - /**␊ - * Worker pool of an App Service Environment.␊ - */␊ - properties: (WorkerPool4 | string)␊ - /**␊ - * Description of a SKU for a scalable resource.␊ - */␊ - sku?: (SkuDescription6 | string)␊ - type: "multiRolePools"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a SKU for a scalable resource.␊ - */␊ - export interface SkuDescription6 {␊ - /**␊ - * Capabilities of the SKU, e.g., is traffic manager enabled?␊ - */␊ - capabilities?: (Capability4[] | string)␊ - /**␊ - * Current number of instances assigned to the resource.␊ - */␊ - capacity?: (number | string)␊ - /**␊ - * Family code of the resource SKU.␊ - */␊ - family?: string␊ - /**␊ - * Locations of the SKU.␊ - */␊ - locations?: (string[] | string)␊ - /**␊ - * Name of the resource SKU.␊ - */␊ - name?: string␊ - /**␊ - * Size specifier of the resource SKU.␊ - */␊ - size?: string␊ - /**␊ - * Description of the App Service plan scale options.␊ - */␊ - skuCapacity?: (SkuCapacity3 | string)␊ - /**␊ - * Service tier of the resource SKU.␊ - */␊ - tier?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the capabilities/features allowed for a specific SKU.␊ - */␊ - export interface Capability4 {␊ - /**␊ - * Name of the SKU capability.␊ - */␊ - name?: string␊ - /**␊ - * Reason of the SKU capability.␊ - */␊ - reason?: string␊ - /**␊ - * Value of the SKU capability.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of the App Service plan scale options.␊ - */␊ - export interface SkuCapacity3 {␊ - /**␊ - * Default number of workers for this App Service plan SKU.␊ - */␊ - default?: (number | string)␊ - /**␊ - * Maximum number of workers for this App Service plan SKU.␊ - */␊ - maximum?: (number | string)␊ - /**␊ - * Minimum number of workers for this App Service plan SKU.␊ - */␊ - minimum?: (number | string)␊ - /**␊ - * Available scale configurations for an App Service plan.␊ - */␊ - scaleType?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/hostingEnvironments/workerPools␊ - */␊ - export interface HostingEnvironmentsWorkerPoolsChildResource4 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the worker pool.␊ - */␊ - name: string␊ - /**␊ - * Worker pool of an App Service Environment.␊ - */␊ - properties: (WorkerPool4 | string)␊ - /**␊ - * Description of a SKU for a scalable resource.␊ - */␊ - sku?: (SkuDescription6 | string)␊ - type: "workerPools"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/hostingEnvironments/multiRolePools␊ - */␊ - export interface HostingEnvironmentsMultiRolePools4 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Worker pool of an App Service Environment.␊ - */␊ - properties: (WorkerPool4 | string)␊ - /**␊ - * Description of a SKU for a scalable resource.␊ - */␊ - sku?: (SkuDescription6 | string)␊ - type: "Microsoft.Web/hostingEnvironments/multiRolePools"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/hostingEnvironments/workerPools␊ - */␊ - export interface HostingEnvironmentsWorkerPools4 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the worker pool.␊ - */␊ - name: string␊ - /**␊ - * Worker pool of an App Service Environment.␊ - */␊ - properties: (WorkerPool4 | string)␊ - /**␊ - * Description of a SKU for a scalable resource.␊ - */␊ - sku?: (SkuDescription6 | string)␊ - type: "Microsoft.Web/hostingEnvironments/workerPools"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/serverfarms␊ - */␊ - export interface Serverfarms4 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the App Service plan.␊ - */␊ - name: string␊ - /**␊ - * AppServicePlan resource specific properties␊ - */␊ - properties: (AppServicePlanProperties3 | string)␊ - /**␊ - * Description of a SKU for a scalable resource.␊ - */␊ - sku?: (SkuDescription6 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/serverfarms"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AppServicePlan resource specific properties␊ - */␊ - export interface AppServicePlanProperties3 {␊ - /**␊ - * The time when the server farm free offer expires.␊ - */␊ - freeOfferExpirationTime?: string␊ - /**␊ - * Specification for an App Service Environment to use for this resource.␊ - */␊ - hostingEnvironmentProfile?: (HostingEnvironmentProfile6 | string)␊ - /**␊ - * If Hyper-V container app service plan true, false otherwise.␊ - */␊ - hyperV?: (boolean | string)␊ - /**␊ - * If true, this App Service Plan owns spot instances.␊ - */␊ - isSpot?: (boolean | string)␊ - /**␊ - * Obsolete: If Hyper-V container app service plan true, false otherwise.␊ - */␊ - isXenon?: (boolean | string)␊ - /**␊ - * Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan␊ - */␊ - maximumElasticWorkerCount?: (number | string)␊ - /**␊ - * 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.␊ - */␊ - perSiteScaling?: (boolean | string)␊ - /**␊ - * If Linux app service plan true, false otherwise.␊ - */␊ - reserved?: (boolean | string)␊ - /**␊ - * The time when the server farm expires. Valid only if it is a spot server farm.␊ - */␊ - spotExpirationTime?: string␊ - /**␊ - * Scaling worker count.␊ - */␊ - targetWorkerCount?: (number | string)␊ - /**␊ - * Scaling worker size ID.␊ - */␊ - targetWorkerSizeId?: (number | string)␊ - /**␊ - * Target worker tier assigned to the App Service plan.␊ - */␊ - workerTierName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specification for an App Service Environment to use for this resource.␊ - */␊ - export interface HostingEnvironmentProfile6 {␊ - /**␊ - * Resource ID of the App Service Environment.␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/serverfarms/virtualNetworkConnections/gateways␊ - */␊ - export interface ServerfarmsVirtualNetworkConnectionsGateways4 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the gateway. Only the 'primary' gateway is supported.␊ - */␊ - name: string␊ - /**␊ - * VnetGateway resource specific properties␊ - */␊ - properties: (VnetGatewayProperties6 | string)␊ - type: "Microsoft.Web/serverfarms/virtualNetworkConnections/gateways"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VnetGateway resource specific properties␊ - */␊ - export interface VnetGatewayProperties6 {␊ - /**␊ - * The Virtual Network name.␊ - */␊ - vnetName?: string␊ - /**␊ - * The URI where the VPN package can be downloaded.␊ - */␊ - vpnPackageUri: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/serverfarms/virtualNetworkConnections/routes␊ - */␊ - export interface ServerfarmsVirtualNetworkConnectionsRoutes4 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the Virtual Network route.␊ - */␊ - name: string␊ - /**␊ - * VnetRoute resource specific properties␊ - */␊ - properties: (VnetRouteProperties4 | string)␊ - type: "Microsoft.Web/serverfarms/virtualNetworkConnections/routes"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VnetRoute resource specific properties␊ - */␊ - export interface VnetRouteProperties4 {␊ - /**␊ - * The ending address for this route. If the start address is specified in CIDR notation, this must be omitted.␊ - */␊ - endAddress?: string␊ - /**␊ - * 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.␊ - */␊ - routeType?: (("DEFAULT" | "INHERITED" | "STATIC") | string)␊ - /**␊ - * The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified.␊ - */␊ - startAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites␊ - */␊ - export interface Sites5 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Managed service identity.␊ - */␊ - identity?: (ManagedServiceIdentity18 | string)␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Unique name of the app to create or update. To create or update a deployment slot, use the {slot} parameter.␊ - */␊ - name: string␊ - /**␊ - * Site resource specific properties␊ - */␊ - properties: (SiteProperties5 | string)␊ - resources?: (SitesBasicPublishingCredentialsPoliciesChildResource1 | SitesConfigChildResource5 | SitesDeploymentsChildResource5 | SitesDomainOwnershipIdentifiersChildResource4 | SitesExtensionsChildResource4 | SitesFunctionsChildResource4 | SitesHostNameBindingsChildResource5 | SitesHybridconnectionChildResource5 | SitesMigrateChildResource4 | SitesNetworkConfigChildResource3 | SitesPremieraddonsChildResource5 | SitesPrivateAccessChildResource3 | SitesPublicCertificatesChildResource4 | SitesSiteextensionsChildResource4 | SitesSlotsChildResource5 | SitesPrivateEndpointConnectionsChildResource1 | SitesSourcecontrolsChildResource5 | SitesVirtualNetworkConnectionsChildResource5)[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/sites"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Managed service identity.␊ - */␊ - export interface ManagedServiceIdentity18 {␊ - /**␊ - * Type of managed service identity.␊ - */␊ - type?: (("SystemAssigned" | "UserAssigned" | "SystemAssigned, UserAssigned" | "None") | string)␊ - /**␊ - * The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}␊ - */␊ - userAssignedIdentities?: ({␊ - [k: string]: Components1Jq1T4Ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties4␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - export interface Components1Jq1T4Ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties4 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Site resource specific properties␊ - */␊ - export interface SiteProperties5 {␊ - /**␊ - * 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.␊ - */␊ - clientAffinityEnabled?: (boolean | string)␊ - /**␊ - * true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.␊ - */␊ - clientCertEnabled?: (boolean | string)␊ - /**␊ - * client certificate authentication comma-separated exclusion paths␊ - */␊ - clientCertExclusionPaths?: string␊ - /**␊ - * This composes with ClientCertEnabled setting.␊ - * - ClientCertEnabled: false means ClientCert is ignored.␊ - * - ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required.␊ - * - ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted.␊ - */␊ - clientCertMode?: (("Required" | "Optional") | string)␊ - /**␊ - * Information needed for cloning operation.␊ - */␊ - cloningInfo?: (CloningInfo5 | string)␊ - /**␊ - * Size of the function container.␊ - */␊ - containerSize?: (number | string)␊ - /**␊ - * Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification.␊ - */␊ - customDomainVerificationId?: string␊ - /**␊ - * Maximum allowed daily memory-time quota (applicable on dynamic apps only).␊ - */␊ - dailyMemoryTimeQuota?: (number | string)␊ - /**␊ - * true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Specification for an App Service Environment to use for this resource.␊ - */␊ - hostingEnvironmentProfile?: (HostingEnvironmentProfile6 | string)␊ - /**␊ - * true to disable the public hostnames of the app; otherwise, false.␊ - * If true, the app is only accessible via API management process.␊ - */␊ - hostNamesDisabled?: (boolean | string)␊ - /**␊ - * Hostname SSL states are used to manage the SSL bindings for app's hostnames.␊ - */␊ - hostNameSslStates?: (HostNameSslState5[] | string)␊ - /**␊ - * HttpsOnly: configures a web site to accept only https requests. Issues redirect for␊ - * http requests␊ - */␊ - httpsOnly?: (boolean | string)␊ - /**␊ - * Hyper-V sandbox.␊ - */␊ - hyperV?: (boolean | string)␊ - /**␊ - * Obsolete: Hyper-V sandbox.␊ - */␊ - isXenon?: (boolean | string)␊ - /**␊ - * Site redundancy mode.␊ - */␊ - redundancyMode?: (("None" | "Manual" | "Failover" | "ActiveActive" | "GeoRedundant") | string)␊ - /**␊ - * true if reserved; otherwise, false.␊ - */␊ - reserved?: (boolean | string)␊ - /**␊ - * true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.␊ - */␊ - scmSiteAlsoStopped?: (boolean | string)␊ - /**␊ - * Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".␊ - */␊ - serverFarmId?: string␊ - /**␊ - * Configuration of an App Service app.␊ - */␊ - siteConfig?: (SiteConfig5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information needed for cloning operation.␊ - */␊ - export interface CloningInfo5 {␊ - /**␊ - * 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.␊ - */␊ - appSettingsOverrides?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * true to clone custom hostnames from source app; otherwise, false.␊ - */␊ - cloneCustomHostNames?: (boolean | string)␊ - /**␊ - * true to clone source control from source app; otherwise, false.␊ - */␊ - cloneSourceControl?: (boolean | string)␊ - /**␊ - * true to configure load balancing for source and destination app.␊ - */␊ - configureLoadBalancing?: (boolean | string)␊ - /**␊ - * Correlation ID of cloning operation. This ID ties multiple cloning operations␊ - * together to use the same snapshot.␊ - */␊ - correlationId?: string␊ - /**␊ - * App Service Environment.␊ - */␊ - hostingEnvironment?: string␊ - /**␊ - * true to overwrite destination app; otherwise, false.␊ - */␊ - overwrite?: (boolean | string)␊ - /**␊ - * 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.␊ - */␊ - sourceWebAppId: string␊ - /**␊ - * Location of source app ex: West US or North Europe␊ - */␊ - sourceWebAppLocation?: string␊ - /**␊ - * 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}.␊ - */␊ - trafficManagerProfileId?: string␊ - /**␊ - * Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist.␊ - */␊ - trafficManagerProfileName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSL-enabled hostname.␊ - */␊ - export interface HostNameSslState5 {␊ - /**␊ - * Indicates whether the hostname is a standard or repository hostname.␊ - */␊ - hostType?: (("Standard" | "Repository") | string)␊ - /**␊ - * Hostname.␊ - */␊ - name?: string␊ - /**␊ - * SSL type.␊ - */␊ - sslState?: (("Disabled" | "SniEnabled" | "IpBasedEnabled") | string)␊ - /**␊ - * SSL certificate thumbprint.␊ - */␊ - thumbprint?: string␊ - /**␊ - * Set to true to update existing hostname.␊ - */␊ - toUpdate?: (boolean | string)␊ - /**␊ - * Virtual IP address assigned to the hostname if IP based SSL is enabled.␊ - */␊ - virtualIP?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Configuration of an App Service app.␊ - */␊ - export interface SiteConfig5 {␊ - /**␊ - * Flag to use Managed Identity Creds for ACR pull␊ - */␊ - acrUseManagedIdentityCreds?: (boolean | string)␊ - /**␊ - * If using user managed identity, the user managed identity ClientId␊ - */␊ - acrUserManagedIdentityID?: string␊ - /**␊ - * true if Always On is enabled; otherwise, false.␊ - */␊ - alwaysOn?: (boolean | string)␊ - /**␊ - * Information about the formal API definition for the app.␊ - */␊ - apiDefinition?: (ApiDefinitionInfo5 | string)␊ - /**␊ - * Azure API management (APIM) configuration linked to the app.␊ - */␊ - apiManagementConfig?: (ApiManagementConfig1 | string)␊ - /**␊ - * App command line to launch.␊ - */␊ - appCommandLine?: string␊ - /**␊ - * Application settings.␊ - */␊ - appSettings?: (NameValuePair6[] | string)␊ - /**␊ - * true if Auto Heal is enabled; otherwise, false.␊ - */␊ - autoHealEnabled?: (boolean | string)␊ - /**␊ - * Rules that can be defined for auto-heal.␊ - */␊ - autoHealRules?: (AutoHealRules5 | string)␊ - /**␊ - * Auto-swap slot name.␊ - */␊ - autoSwapSlotName?: string␊ - /**␊ - * Connection strings.␊ - */␊ - connectionStrings?: (ConnStringInfo5[] | string)␊ - /**␊ - * Cross-Origin Resource Sharing (CORS) settings for the app.␊ - */␊ - cors?: (CorsSettings5 | string)␊ - /**␊ - * Default documents.␊ - */␊ - defaultDocuments?: (string[] | string)␊ - /**␊ - * true if detailed error logging is enabled; otherwise, false.␊ - */␊ - detailedErrorLoggingEnabled?: (boolean | string)␊ - /**␊ - * Document root.␊ - */␊ - documentRoot?: string␊ - /**␊ - * Routing rules in production experiments.␊ - */␊ - experiments?: (Experiments5 | string)␊ - /**␊ - * State of FTP / FTPS service.␊ - */␊ - ftpsState?: (("AllAllowed" | "FtpsOnly" | "Disabled") | string)␊ - /**␊ - * Handler mappings.␊ - */␊ - handlerMappings?: (HandlerMapping5[] | string)␊ - /**␊ - * Health check path␊ - */␊ - healthCheckPath?: string␊ - /**␊ - * Http20Enabled: configures a web site to allow clients to connect over http2.0␊ - */␊ - http20Enabled?: (boolean | string)␊ - /**␊ - * true if HTTP logging is enabled; otherwise, false.␊ - */␊ - httpLoggingEnabled?: (boolean | string)␊ - /**␊ - * IP security restrictions for main.␊ - */␊ - ipSecurityRestrictions?: (IpSecurityRestriction5[] | string)␊ - /**␊ - * Java container.␊ - */␊ - javaContainer?: string␊ - /**␊ - * Java container version.␊ - */␊ - javaContainerVersion?: string␊ - /**␊ - * Java version.␊ - */␊ - javaVersion?: string␊ - /**␊ - * Metric limits set on an app.␊ - */␊ - limits?: (SiteLimits5 | string)␊ - /**␊ - * Linux App Framework and version␊ - */␊ - linuxFxVersion?: string␊ - /**␊ - * Site load balancing.␊ - */␊ - loadBalancing?: (("WeightedRoundRobin" | "LeastRequests" | "LeastResponseTime" | "WeightedTotalTraffic" | "RequestHash") | string)␊ - /**␊ - * true to enable local MySQL; otherwise, false.␊ - */␊ - localMySqlEnabled?: (boolean | string)␊ - /**␊ - * HTTP logs directory size limit.␊ - */␊ - logsDirectorySizeLimit?: (number | string)␊ - /**␊ - * Managed pipeline mode.␊ - */␊ - managedPipelineMode?: (("Integrated" | "Classic") | string)␊ - /**␊ - * Managed Service Identity Id␊ - */␊ - managedServiceIdentityId?: (number | string)␊ - /**␊ - * MinTlsVersion: configures the minimum version of TLS required for SSL requests.␊ - */␊ - minTlsVersion?: (("1.0" | "1.1" | "1.2") | string)␊ - /**␊ - * .NET Framework version.␊ - */␊ - netFrameworkVersion?: string␊ - /**␊ - * Version of Node.js.␊ - */␊ - nodeVersion?: string␊ - /**␊ - * Number of workers.␊ - */␊ - numberOfWorkers?: (number | string)␊ - /**␊ - * Version of PHP.␊ - */␊ - phpVersion?: string␊ - /**␊ - * Version of PowerShell.␊ - */␊ - powerShellVersion?: string␊ - /**␊ - * Number of preWarmed instances.␊ - * This setting only applies to the Consumption and Elastic Plans␊ - */␊ - preWarmedInstanceCount?: (number | string)␊ - /**␊ - * Publishing user name.␊ - */␊ - publishingUsername?: string␊ - /**␊ - * Push settings for the App.␊ - */␊ - push?: (PushSettings4 | string)␊ - /**␊ - * Version of Python.␊ - */␊ - pythonVersion?: string␊ - /**␊ - * true if remote debugging is enabled; otherwise, false.␊ - */␊ - remoteDebuggingEnabled?: (boolean | string)␊ - /**␊ - * Remote debugging version.␊ - */␊ - remoteDebuggingVersion?: string␊ - /**␊ - * true if request tracing is enabled; otherwise, false.␊ - */␊ - requestTracingEnabled?: (boolean | string)␊ - /**␊ - * Request tracing expiration time.␊ - */␊ - requestTracingExpirationTime?: string␊ - /**␊ - * IP security restrictions for scm.␊ - */␊ - scmIpSecurityRestrictions?: (IpSecurityRestriction5[] | string)␊ - /**␊ - * IP security restrictions for scm to use main.␊ - */␊ - scmIpSecurityRestrictionsUseMain?: (boolean | string)␊ - /**␊ - * ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site.␊ - */␊ - scmMinTlsVersion?: (("1.0" | "1.1" | "1.2") | string)␊ - /**␊ - * SCM type.␊ - */␊ - scmType?: (("None" | "Dropbox" | "Tfs" | "LocalGit" | "GitHub" | "CodePlexGit" | "CodePlexHg" | "BitbucketGit" | "BitbucketHg" | "ExternalGit" | "ExternalHg" | "OneDrive" | "VSO" | "VSTSRM") | string)␊ - /**␊ - * Tracing options.␊ - */␊ - tracingOptions?: string␊ - /**␊ - * true to use 32-bit worker process; otherwise, false.␊ - */␊ - use32BitWorkerProcess?: (boolean | string)␊ - /**␊ - * Virtual applications.␊ - */␊ - virtualApplications?: (VirtualApplication5[] | string)␊ - /**␊ - * Virtual Network name.␊ - */␊ - vnetName?: string␊ - /**␊ - * The number of private ports assigned to this app. These will be assigned dynamically on runtime.␊ - */␊ - vnetPrivatePortsCount?: (number | string)␊ - /**␊ - * Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied.␊ - */␊ - vnetRouteAllEnabled?: (boolean | string)␊ - /**␊ - * true if WebSocket is enabled; otherwise, false.␊ - */␊ - webSocketsEnabled?: (boolean | string)␊ - /**␊ - * Xenon App Framework and version␊ - */␊ - windowsFxVersion?: string␊ - /**␊ - * Explicit Managed Service Identity Id␊ - */␊ - xManagedServiceIdentityId?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the formal API definition for the app.␊ - */␊ - export interface ApiDefinitionInfo5 {␊ - /**␊ - * The URL of the API definition.␊ - */␊ - url?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure API management (APIM) configuration linked to the app.␊ - */␊ - export interface ApiManagementConfig1 {␊ - /**␊ - * APIM-Api Identifier.␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Rules that can be defined for auto-heal.␊ - */␊ - export interface AutoHealRules5 {␊ - /**␊ - * Actions which to take by the auto-heal module when a rule is triggered.␊ - */␊ - actions?: (AutoHealActions5 | string)␊ - /**␊ - * Triggers for auto-heal.␊ - */␊ - triggers?: (AutoHealTriggers5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Actions which to take by the auto-heal module when a rule is triggered.␊ - */␊ - export interface AutoHealActions5 {␊ - /**␊ - * Predefined action to be taken.␊ - */␊ - actionType?: (("Recycle" | "LogEvent" | "CustomAction") | string)␊ - /**␊ - * Custom action to be executed␊ - * when an auto heal rule is triggered.␊ - */␊ - customAction?: (AutoHealCustomAction5 | string)␊ - /**␊ - * Minimum time the process must execute␊ - * before taking the action␊ - */␊ - minProcessExecutionTime?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Custom action to be executed␊ - * when an auto heal rule is triggered.␊ - */␊ - export interface AutoHealCustomAction5 {␊ - /**␊ - * Executable to be run.␊ - */␊ - exe?: string␊ - /**␊ - * Parameters for the executable.␊ - */␊ - parameters?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Triggers for auto-heal.␊ - */␊ - export interface AutoHealTriggers5 {␊ - /**␊ - * A rule based on private bytes.␊ - */␊ - privateBytesInKB?: (number | string)␊ - /**␊ - * Trigger based on total requests.␊ - */␊ - requests?: (RequestsBasedTrigger5 | string)␊ - /**␊ - * Trigger based on request execution time.␊ - */␊ - slowRequests?: (SlowRequestsBasedTrigger5 | string)␊ - /**␊ - * A rule based on status codes.␊ - */␊ - statusCodes?: (StatusCodesBasedTrigger5[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trigger based on total requests.␊ - */␊ - export interface RequestsBasedTrigger5 {␊ - /**␊ - * Request Count.␊ - */␊ - count?: (number | string)␊ - /**␊ - * Time interval.␊ - */␊ - timeInterval?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trigger based on request execution time.␊ - */␊ - export interface SlowRequestsBasedTrigger5 {␊ - /**␊ - * Request Count.␊ - */␊ - count?: (number | string)␊ - /**␊ - * Time interval.␊ - */␊ - timeInterval?: string␊ - /**␊ - * Time taken.␊ - */␊ - timeTaken?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trigger based on status code.␊ - */␊ - export interface StatusCodesBasedTrigger5 {␊ - /**␊ - * Request Count.␊ - */␊ - count?: (number | string)␊ - /**␊ - * HTTP status code.␊ - */␊ - status?: (number | string)␊ - /**␊ - * Request Sub Status.␊ - */␊ - subStatus?: (number | string)␊ - /**␊ - * Time interval.␊ - */␊ - timeInterval?: string␊ - /**␊ - * Win32 error code.␊ - */␊ - win32Status?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Database connection string information.␊ - */␊ - export interface ConnStringInfo5 {␊ - /**␊ - * Connection string value.␊ - */␊ - connectionString?: string␊ - /**␊ - * Name of connection string.␊ - */␊ - name?: string␊ - /**␊ - * Type of database.␊ - */␊ - type?: (("MySql" | "SQLServer" | "SQLAzure" | "Custom" | "NotificationHub" | "ServiceBus" | "EventHub" | "ApiHub" | "DocDb" | "RedisCache" | "PostgreSQL") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Cross-Origin Resource Sharing (CORS) settings for the app.␊ - */␊ - export interface CorsSettings5 {␊ - /**␊ - * 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.␊ - */␊ - allowedOrigins?: (string[] | string)␊ - /**␊ - * Gets or sets whether CORS requests with credentials are allowed. See ␊ - * https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials␊ - * for more details.␊ - */␊ - supportCredentials?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Routing rules in production experiments.␊ - */␊ - export interface Experiments5 {␊ - /**␊ - * List of ramp-up rules.␊ - */␊ - rampUpRules?: (RampUpRule5[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance.␊ - */␊ - export interface RampUpRule5 {␊ - /**␊ - * Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.␊ - */␊ - actionHostName?: string␊ - /**␊ - * 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/␊ - */␊ - changeDecisionCallbackUrl?: string␊ - /**␊ - * Specifies interval in minutes to reevaluate ReroutePercentage.␊ - */␊ - changeIntervalInMinutes?: (number | string)␊ - /**␊ - * In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \\nMinReroutePercentage or ␊ - * MaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\\nCustom decision algorithm ␊ - * can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl.␊ - */␊ - changeStep?: (number | string)␊ - /**␊ - * Specifies upper boundary below which ReroutePercentage will stay.␊ - */␊ - maxReroutePercentage?: (number | string)␊ - /**␊ - * Specifies lower boundary above which ReroutePercentage will stay.␊ - */␊ - minReroutePercentage?: (number | string)␊ - /**␊ - * Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment.␊ - */␊ - name?: string␊ - /**␊ - * Percentage of the traffic which will be redirected to ActionHostName.␊ - */␊ - reroutePercentage?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * 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.␊ - */␊ - export interface HandlerMapping5 {␊ - /**␊ - * Command-line arguments to be passed to the script processor.␊ - */␊ - arguments?: string␊ - /**␊ - * Requests with this extension will be handled using the specified FastCGI application.␊ - */␊ - extension?: string␊ - /**␊ - * The absolute path to the FastCGI application.␊ - */␊ - scriptProcessor?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP security restriction on an app.␊ - */␊ - export interface IpSecurityRestriction5 {␊ - /**␊ - * Allow or Deny access for this IP range.␊ - */␊ - action?: string␊ - /**␊ - * IP restriction rule description.␊ - */␊ - description?: string␊ - /**␊ - * IP restriction rule headers.␊ - * X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). ␊ - * The matching logic is ..␊ - * - If the property is null or empty (default), all hosts(or lack of) are allowed.␊ - * - A value is compared using ordinal-ignore-case (excluding port number).␊ - * - Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com␊ - * but not the root domain contoso.com or multi-level foo.bar.contoso.com␊ - * - Unicode host names are allowed but are converted to Punycode for matching.␊ - * ␊ - * X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples).␊ - * The matching logic is ..␊ - * - If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed.␊ - * - If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property.␊ - * ␊ - * X-Azure-FDID and X-FD-HealthProbe.␊ - * The matching logic is exact match.␊ - */␊ - headers?: ({␊ - [k: string]: string[]␊ - } | string)␊ - /**␊ - * IP address the security restriction is valid for.␊ - * It can be in form of pure ipv4 address (required SubnetMask property) or␊ - * CIDR notation such as ipv4/mask (leading bit match). For CIDR,␊ - * SubnetMask property must not be specified.␊ - */␊ - ipAddress?: string␊ - /**␊ - * IP restriction rule name.␊ - */␊ - name?: string␊ - /**␊ - * Priority of IP restriction rule.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * Subnet mask for the range of IP addresses the restriction is valid for.␊ - */␊ - subnetMask?: string␊ - /**␊ - * (internal) Subnet traffic tag␊ - */␊ - subnetTrafficTag?: (number | string)␊ - /**␊ - * Defines what this IP filter will be used for. This is to support IP filtering on proxies.␊ - */␊ - tag?: (("Default" | "XffProxy" | "ServiceTag") | string)␊ - /**␊ - * Virtual network resource id␊ - */␊ - vnetSubnetResourceId?: string␊ - /**␊ - * (internal) Vnet traffic tag␊ - */␊ - vnetTrafficTag?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Metric limits set on an app.␊ - */␊ - export interface SiteLimits5 {␊ - /**␊ - * Maximum allowed disk size usage in MB.␊ - */␊ - maxDiskSizeInMb?: (number | string)␊ - /**␊ - * Maximum allowed memory usage in MB.␊ - */␊ - maxMemoryInMb?: (number | string)␊ - /**␊ - * Maximum allowed CPU usage percentage.␊ - */␊ - maxPercentageCpu?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Push settings for the App.␊ - */␊ - export interface PushSettings4 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * PushSettings resource specific properties␊ - */␊ - properties?: (PushSettingsProperties4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * PushSettings resource specific properties␊ - */␊ - export interface PushSettingsProperties4 {␊ - /**␊ - * Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint.␊ - */␊ - dynamicTagsJson?: string␊ - /**␊ - * Gets or sets a flag indicating whether the Push endpoint is enabled.␊ - */␊ - isPushEnabled: (boolean | string)␊ - /**␊ - * 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.␊ - */␊ - tagsRequiringAuth?: string␊ - /**␊ - * Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.␊ - */␊ - tagWhitelistJson?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Virtual application in an app.␊ - */␊ - export interface VirtualApplication5 {␊ - /**␊ - * Physical path.␊ - */␊ - physicalPath?: string␊ - /**␊ - * true if preloading is enabled; otherwise, false.␊ - */␊ - preloadEnabled?: (boolean | string)␊ - /**␊ - * Virtual directories for virtual application.␊ - */␊ - virtualDirectories?: (VirtualDirectory5[] | string)␊ - /**␊ - * Virtual path.␊ - */␊ - virtualPath?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Directory for virtual application.␊ - */␊ - export interface VirtualDirectory5 {␊ - /**␊ - * Physical path.␊ - */␊ - physicalPath?: string␊ - /**␊ - * Path to virtual application.␊ - */␊ - virtualPath?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * CsmPublishingCredentialsPoliciesEntity resource specific properties␊ - */␊ - export interface CsmPublishingCredentialsPoliciesEntityProperties1 {␊ - /**␊ - * true to allow access to a publishing method; otherwise, false.␊ - */␊ - allow: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SiteAuthSettings resource specific properties␊ - */␊ - export interface SiteAuthSettingsProperties4 {␊ - /**␊ - * Gets a JSON string containing the Azure AD Acl settings.␊ - */␊ - aadClaimsAuthorization?: string␊ - /**␊ - * Login parameters to send to the OpenID Connect authorization endpoint when␊ - * a user logs in. Each parameter must be in the form "key=value".␊ - */␊ - additionalLoginParams?: (string[] | string)␊ - /**␊ - * 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.␊ - */␊ - allowedAudiences?: (string[] | string)␊ - /**␊ - * 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.␊ - */␊ - allowedExternalRedirectUrls?: (string[] | string)␊ - /**␊ - * The path of the config file containing auth settings.␊ - * If the path is relative, base will the site's root directory.␊ - */␊ - authFilePath?: string␊ - /**␊ - * 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␊ - */␊ - clientId?: string␊ - /**␊ - * 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␊ - */␊ - clientSecret?: string␊ - /**␊ - * An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as␊ - * a replacement for the Client Secret. It is also optional.␊ - */␊ - clientSecretCertificateThumbprint?: string␊ - /**␊ - * The app setting name that contains the client secret of the relying party application.␊ - */␊ - clientSecretSettingName?: string␊ - /**␊ - * 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".␊ - */␊ - defaultProvider?: (("AzureActiveDirectory" | "Facebook" | "Google" | "MicrosoftAccount" | "Twitter" | "Github") | string)␊ - /**␊ - * true if the Authentication / Authorization feature is enabled for the current app; otherwise, false.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * 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␊ - */␊ - facebookAppId?: string␊ - /**␊ - * 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␊ - */␊ - facebookAppSecret?: string␊ - /**␊ - * The app setting name that contains the app secret used for Facebook Login.␊ - */␊ - facebookAppSecretSettingName?: string␊ - /**␊ - * 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␊ - */␊ - facebookOAuthScopes?: (string[] | string)␊ - /**␊ - * The Client Id of the GitHub app used for login.␊ - * This setting is required for enabling Github login␊ - */␊ - gitHubClientId?: string␊ - /**␊ - * The Client Secret of the GitHub app used for Github Login.␊ - * This setting is required for enabling Github login.␊ - */␊ - gitHubClientSecret?: string␊ - /**␊ - * The app setting name that contains the client secret of the Github␊ - * app used for GitHub Login.␊ - */␊ - gitHubClientSecretSettingName?: string␊ - /**␊ - * The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication.␊ - * This setting is optional␊ - */␊ - gitHubOAuthScopes?: (string[] | string)␊ - /**␊ - * 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/␊ - */␊ - googleClientId?: string␊ - /**␊ - * 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/␊ - */␊ - googleClientSecret?: string␊ - /**␊ - * The app setting name that contains the client secret associated with ␊ - * the Google web application.␊ - */␊ - googleClientSecretSettingName?: string␊ - /**␊ - * 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/␊ - */␊ - googleOAuthScopes?: (string[] | string)␊ - /**␊ - * "true" if the auth config settings should be read from a file,␊ - * "false" otherwise␊ - */␊ - isAuthFromFile?: string␊ - /**␊ - * 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␊ - */␊ - issuer?: string␊ - /**␊ - * 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␊ - */␊ - microsoftAccountClientId?: string␊ - /**␊ - * 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␊ - */␊ - microsoftAccountClientSecret?: string␊ - /**␊ - * The app setting name containing the OAuth 2.0 client secret that was created for the␊ - * app used for authentication.␊ - */␊ - microsoftAccountClientSecretSettingName?: string␊ - /**␊ - * 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␊ - */␊ - microsoftAccountOAuthScopes?: (string[] | string)␊ - /**␊ - * 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.␊ - */␊ - runtimeVersion?: string␊ - /**␊ - * 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.␊ - */␊ - tokenRefreshExtensionHours?: (number | string)␊ - /**␊ - * true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.␊ - * The default is false.␊ - */␊ - tokenStoreEnabled?: (boolean | string)␊ - /**␊ - * 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␊ - */␊ - twitterConsumerKey?: string␊ - /**␊ - * 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␊ - */␊ - twitterConsumerSecret?: string␊ - /**␊ - * The app setting name that contains the OAuth 1.0a consumer secret of the Twitter␊ - * application used for sign-in.␊ - */␊ - twitterConsumerSecretSettingName?: string␊ - /**␊ - * The action to take when an unauthenticated client attempts to access the app.␊ - */␊ - unauthenticatedClientAction?: (("RedirectToLoginPage" | "AllowAnonymous") | string)␊ - /**␊ - * Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such.␊ - */␊ - validateIssuer?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SiteAuthSettingsV2 resource specific properties␊ - */␊ - export interface SiteAuthSettingsV2Properties {␊ - globalValidation?: (GlobalValidation | string)␊ - httpSettings?: (HttpSettings | string)␊ - identityProviders?: (IdentityProviders | string)␊ - login?: (Login | string)␊ - platform?: (AuthPlatform | string)␊ - [k: string]: unknown␊ - }␊ - export interface GlobalValidation {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * GlobalValidation resource specific properties␊ - */␊ - properties?: (GlobalValidationProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * GlobalValidation resource specific properties␊ - */␊ - export interface GlobalValidationProperties {␊ - excludedPaths?: (string[] | string)␊ - redirectToProvider?: string␊ - requireAuthentication?: (boolean | string)␊ - unauthenticatedClientAction?: (("RedirectToLoginPage" | "AllowAnonymous" | "Return401" | "Return403") | string)␊ - [k: string]: unknown␊ - }␊ - export interface HttpSettings {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * HttpSettings resource specific properties␊ - */␊ - properties?: (HttpSettingsProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HttpSettings resource specific properties␊ - */␊ - export interface HttpSettingsProperties {␊ - forwardProxy?: (ForwardProxy | string)␊ - requireHttps?: (boolean | string)␊ - routes?: (HttpSettingsRoutes | string)␊ - [k: string]: unknown␊ - }␊ - export interface ForwardProxy {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * ForwardProxy resource specific properties␊ - */␊ - properties?: (ForwardProxyProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ForwardProxy resource specific properties␊ - */␊ - export interface ForwardProxyProperties {␊ - convention?: (("NoProxy" | "Standard" | "Custom") | string)␊ - customHostHeaderName?: string␊ - customProtoHeaderName?: string␊ - [k: string]: unknown␊ - }␊ - export interface HttpSettingsRoutes {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * HttpSettingsRoutes resource specific properties␊ - */␊ - properties?: (HttpSettingsRoutesProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HttpSettingsRoutes resource specific properties␊ - */␊ - export interface HttpSettingsRoutesProperties {␊ - apiPrefix?: string␊ - [k: string]: unknown␊ - }␊ - export interface IdentityProviders {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * IdentityProviders resource specific properties␊ - */␊ - properties?: (IdentityProvidersProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IdentityProviders resource specific properties␊ - */␊ - export interface IdentityProvidersProperties {␊ - azureActiveDirectory?: (AzureActiveDirectory5 | string)␊ - customOpenIdConnectProviders?: ({␊ - [k: string]: CustomOpenIdConnectProvider␊ - } | string)␊ - facebook?: (Facebook | string)␊ - gitHub?: (GitHub | string)␊ - google?: (Google | string)␊ - twitter?: (Twitter | string)␊ - [k: string]: unknown␊ - }␊ - export interface AzureActiveDirectory5 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * AzureActiveDirectory resource specific properties␊ - */␊ - properties?: (AzureActiveDirectoryProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AzureActiveDirectory resource specific properties␊ - */␊ - export interface AzureActiveDirectoryProperties {␊ - enabled?: (boolean | string)␊ - isAutoProvisioned?: (boolean | string)␊ - login?: (AzureActiveDirectoryLogin | string)␊ - registration?: (AzureActiveDirectoryRegistration | string)␊ - validation?: (AzureActiveDirectoryValidation | string)␊ - [k: string]: unknown␊ - }␊ - export interface AzureActiveDirectoryLogin {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * AzureActiveDirectoryLogin resource specific properties␊ - */␊ - properties?: (AzureActiveDirectoryLoginProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AzureActiveDirectoryLogin resource specific properties␊ - */␊ - export interface AzureActiveDirectoryLoginProperties {␊ - disableWWWAuthenticate?: (boolean | string)␊ - loginParameters?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - export interface AzureActiveDirectoryRegistration {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * AzureActiveDirectoryRegistration resource specific properties␊ - */␊ - properties?: (AzureActiveDirectoryRegistrationProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AzureActiveDirectoryRegistration resource specific properties␊ - */␊ - export interface AzureActiveDirectoryRegistrationProperties {␊ - clientId?: string␊ - clientSecretCertificateThumbprint?: string␊ - clientSecretSettingName?: string␊ - openIdIssuer?: string␊ - [k: string]: unknown␊ - }␊ - export interface AzureActiveDirectoryValidation {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * AzureActiveDirectoryValidation resource specific properties␊ - */␊ - properties?: (AzureActiveDirectoryValidationProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AzureActiveDirectoryValidation resource specific properties␊ - */␊ - export interface AzureActiveDirectoryValidationProperties {␊ - allowedAudiences?: (string[] | string)␊ - jwtClaimChecks?: (JwtClaimChecks | string)␊ - [k: string]: unknown␊ - }␊ - export interface JwtClaimChecks {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * JwtClaimChecks resource specific properties␊ - */␊ - properties?: (JwtClaimChecksProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * JwtClaimChecks resource specific properties␊ - */␊ - export interface JwtClaimChecksProperties {␊ - allowedClientApplications?: (string[] | string)␊ - allowedGroups?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - export interface CustomOpenIdConnectProvider {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * CustomOpenIdConnectProvider resource specific properties␊ - */␊ - properties?: (CustomOpenIdConnectProviderProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * CustomOpenIdConnectProvider resource specific properties␊ - */␊ - export interface CustomOpenIdConnectProviderProperties {␊ - enabled?: (boolean | string)␊ - login?: (OpenIdConnectLogin | string)␊ - registration?: (OpenIdConnectRegistration | string)␊ - [k: string]: unknown␊ - }␊ - export interface OpenIdConnectLogin {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * OpenIdConnectLogin resource specific properties␊ - */␊ - properties?: (OpenIdConnectLoginProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * OpenIdConnectLogin resource specific properties␊ - */␊ - export interface OpenIdConnectLoginProperties {␊ - nameClaimType?: string␊ - scopes?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - export interface OpenIdConnectRegistration {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * OpenIdConnectRegistration resource specific properties␊ - */␊ - properties?: (OpenIdConnectRegistrationProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * OpenIdConnectRegistration resource specific properties␊ - */␊ - export interface OpenIdConnectRegistrationProperties {␊ - clientCredential?: (OpenIdConnectClientCredential | string)␊ - clientId?: string␊ - openIdConnectConfiguration?: (OpenIdConnectConfig | string)␊ - [k: string]: unknown␊ - }␊ - export interface OpenIdConnectClientCredential {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * OpenIdConnectClientCredential resource specific properties␊ - */␊ - properties?: (OpenIdConnectClientCredentialProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * OpenIdConnectClientCredential resource specific properties␊ - */␊ - export interface OpenIdConnectClientCredentialProperties {␊ - clientSecretSettingName?: string␊ - method?: ("ClientSecretPost" | string)␊ - [k: string]: unknown␊ - }␊ - export interface OpenIdConnectConfig {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * OpenIdConnectConfig resource specific properties␊ - */␊ - properties?: (OpenIdConnectConfigProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * OpenIdConnectConfig resource specific properties␊ - */␊ - export interface OpenIdConnectConfigProperties {␊ - authorizationEndpoint?: string␊ - certificationUri?: string␊ - issuer?: string␊ - tokenEndpoint?: string␊ - wellKnownOpenIdConfiguration?: string␊ - [k: string]: unknown␊ - }␊ - export interface Facebook {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Facebook resource specific properties␊ - */␊ - properties?: (FacebookProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Facebook resource specific properties␊ - */␊ - export interface FacebookProperties {␊ - enabled?: (boolean | string)␊ - graphApiVersion?: string␊ - login?: (LoginScopes | string)␊ - registration?: (AppRegistration | string)␊ - [k: string]: unknown␊ - }␊ - export interface LoginScopes {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * LoginScopes resource specific properties␊ - */␊ - properties?: (LoginScopesProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * LoginScopes resource specific properties␊ - */␊ - export interface LoginScopesProperties {␊ - scopes?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - export interface AppRegistration {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * AppRegistration resource specific properties␊ - */␊ - properties?: (AppRegistrationProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AppRegistration resource specific properties␊ - */␊ - export interface AppRegistrationProperties {␊ - appId?: string␊ - appSecretSettingName?: string␊ - [k: string]: unknown␊ - }␊ - export interface GitHub {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * GitHub resource specific properties␊ - */␊ - properties?: (GitHubProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * GitHub resource specific properties␊ - */␊ - export interface GitHubProperties {␊ - enabled?: (boolean | string)␊ - login?: (LoginScopes | string)␊ - registration?: (ClientRegistration | string)␊ - [k: string]: unknown␊ - }␊ - export interface ClientRegistration {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * ClientRegistration resource specific properties␊ - */␊ - properties?: (ClientRegistrationProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ClientRegistration resource specific properties␊ - */␊ - export interface ClientRegistrationProperties {␊ - clientId?: string␊ - clientSecretSettingName?: string␊ - [k: string]: unknown␊ - }␊ - export interface Google {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Google resource specific properties␊ - */␊ - properties?: (GoogleProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Google resource specific properties␊ - */␊ - export interface GoogleProperties {␊ - enabled?: (boolean | string)␊ - login?: (LoginScopes | string)␊ - registration?: (ClientRegistration | string)␊ - validation?: (AllowedAudiencesValidation | string)␊ - [k: string]: unknown␊ - }␊ - export interface AllowedAudiencesValidation {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * AllowedAudiencesValidation resource specific properties␊ - */␊ - properties?: (AllowedAudiencesValidationProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AllowedAudiencesValidation resource specific properties␊ - */␊ - export interface AllowedAudiencesValidationProperties {␊ - allowedAudiences?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - export interface Twitter {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Twitter resource specific properties␊ - */␊ - properties?: (TwitterProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Twitter resource specific properties␊ - */␊ - export interface TwitterProperties {␊ - enabled?: (boolean | string)␊ - registration?: (TwitterRegistration | string)␊ - [k: string]: unknown␊ - }␊ - export interface TwitterRegistration {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * TwitterRegistration resource specific properties␊ - */␊ - properties?: (TwitterRegistrationProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * TwitterRegistration resource specific properties␊ - */␊ - export interface TwitterRegistrationProperties {␊ - consumerKey?: string␊ - consumerSecretSettingName?: string␊ - [k: string]: unknown␊ - }␊ - export interface Login {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Login resource specific properties␊ - */␊ - properties?: (LoginProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Login resource specific properties␊ - */␊ - export interface LoginProperties {␊ - allowedExternalRedirectUrls?: (string[] | string)␊ - cookieExpiration?: (CookieExpiration | string)␊ - nonce?: (Nonce | string)␊ - preserveUrlFragmentsForLogins?: (boolean | string)␊ - routes?: (LoginRoutes | string)␊ - tokenStore?: (TokenStore | string)␊ - [k: string]: unknown␊ - }␊ - export interface CookieExpiration {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * CookieExpiration resource specific properties␊ - */␊ - properties?: (CookieExpirationProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * CookieExpiration resource specific properties␊ - */␊ - export interface CookieExpirationProperties {␊ - convention?: (("FixedTime" | "IdentityProviderDerived") | string)␊ - timeToExpiration?: string␊ - [k: string]: unknown␊ - }␊ - export interface Nonce {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Nonce resource specific properties␊ - */␊ - properties?: (NonceProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Nonce resource specific properties␊ - */␊ - export interface NonceProperties {␊ - nonceExpirationInterval?: string␊ - validateNonce?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - export interface LoginRoutes {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * LoginRoutes resource specific properties␊ - */␊ - properties?: (LoginRoutesProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * LoginRoutes resource specific properties␊ - */␊ - export interface LoginRoutesProperties {␊ - logoutEndpoint?: string␊ - [k: string]: unknown␊ - }␊ - export interface TokenStore {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * TokenStore resource specific properties␊ - */␊ - properties?: (TokenStoreProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * TokenStore resource specific properties␊ - */␊ - export interface TokenStoreProperties {␊ - azureBlobStorage?: (BlobStorageTokenStore | string)␊ - enabled?: (boolean | string)␊ - fileSystem?: (FileSystemTokenStore | string)␊ - tokenRefreshExtensionHours?: (number | string)␊ - [k: string]: unknown␊ - }␊ - export interface BlobStorageTokenStore {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * BlobStorageTokenStore resource specific properties␊ - */␊ - properties?: (BlobStorageTokenStoreProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * BlobStorageTokenStore resource specific properties␊ - */␊ - export interface BlobStorageTokenStoreProperties {␊ - sasUrlSettingName?: string␊ - [k: string]: unknown␊ - }␊ - export interface FileSystemTokenStore {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * FileSystemTokenStore resource specific properties␊ - */␊ - properties?: (FileSystemTokenStoreProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * FileSystemTokenStore resource specific properties␊ - */␊ - export interface FileSystemTokenStoreProperties {␊ - directory?: string␊ - [k: string]: unknown␊ - }␊ - export interface AuthPlatform {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * AuthPlatform resource specific properties␊ - */␊ - properties?: (AuthPlatformProperties | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AuthPlatform resource specific properties␊ - */␊ - export interface AuthPlatformProperties {␊ - configFilePath?: string␊ - enabled?: (boolean | string)␊ - runtimeVersion?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Files or Blob Storage access information value for dictionary storage.␊ - */␊ - export interface AzureStorageInfoValue3 {␊ - /**␊ - * Access key for the storage account.␊ - */␊ - accessKey?: string␊ - /**␊ - * Name of the storage account.␊ - */␊ - accountName?: string␊ - /**␊ - * Path to mount the storage within the site's runtime environment.␊ - */␊ - mountPath?: string␊ - /**␊ - * Name of the file share (container name, for Blob storage).␊ - */␊ - shareName?: string␊ - /**␊ - * Type of storage.␊ - */␊ - type?: (("AzureFiles" | "AzureBlob") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * BackupRequest resource specific properties␊ - */␊ - export interface BackupRequestProperties5 {␊ - /**␊ - * Name of the backup.␊ - */␊ - backupName?: string␊ - /**␊ - * Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy.␊ - */␊ - backupSchedule?: (BackupSchedule5 | string)␊ - /**␊ - * Databases included in the backup.␊ - */␊ - databases?: (DatabaseBackupSetting5[] | string)␊ - /**␊ - * True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * SAS URL to the container.␊ - */␊ - storageAccountUrl: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy.␊ - */␊ - export interface BackupSchedule5 {␊ - /**␊ - * 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)␊ - */␊ - frequencyInterval: ((number & string) | string)␊ - /**␊ - * 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).␊ - */␊ - frequencyUnit: (("Day" | "Hour") | string)␊ - /**␊ - * True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise.␊ - */␊ - keepAtLeastOneBackup: (boolean | string)␊ - /**␊ - * After how many days backups should be deleted.␊ - */␊ - retentionPeriodInDays: ((number & string) | string)␊ - /**␊ - * When the schedule should start working.␊ - */␊ - startTime?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Database backup settings.␊ - */␊ - export interface DatabaseBackupSetting5 {␊ - /**␊ - * 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.␊ - */␊ - connectionString?: string␊ - /**␊ - * Contains a connection string name that is linked to the SiteConfig.ConnectionStrings.␊ - * This is used during restore with overwrite connection strings options.␊ - */␊ - connectionStringName?: string␊ - /**␊ - * Database type (e.g. SqlAzure / MySql).␊ - */␊ - databaseType: (("SqlAzure" | "MySql" | "LocalMySql" | "PostgreSql") | string)␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Database connection string value to type pair.␊ - */␊ - export interface ConnStringValueTypePair5 {␊ - /**␊ - * Type of database.␊ - */␊ - type: (("MySql" | "SQLServer" | "SQLAzure" | "Custom" | "NotificationHub" | "ServiceBus" | "EventHub" | "ApiHub" | "DocDb" | "RedisCache" | "PostgreSQL") | string)␊ - /**␊ - * Value of pair.␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SiteLogsConfig resource specific properties␊ - */␊ - export interface SiteLogsConfigProperties5 {␊ - /**␊ - * Application logs configuration.␊ - */␊ - applicationLogs?: (ApplicationLogsConfig5 | string)␊ - /**␊ - * Enabled configuration.␊ - */␊ - detailedErrorMessages?: (EnabledConfig5 | string)␊ - /**␊ - * Enabled configuration.␊ - */␊ - failedRequestsTracing?: (EnabledConfig5 | string)␊ - /**␊ - * Http logs configuration.␊ - */␊ - httpLogs?: (HttpLogsConfig5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application logs configuration.␊ - */␊ - export interface ApplicationLogsConfig5 {␊ - /**␊ - * Application logs azure blob storage configuration.␊ - */␊ - azureBlobStorage?: (AzureBlobStorageApplicationLogsConfig5 | string)␊ - /**␊ - * Application logs to Azure table storage configuration.␊ - */␊ - azureTableStorage?: (AzureTableStorageApplicationLogsConfig5 | string)␊ - /**␊ - * Application logs to file system configuration.␊ - */␊ - fileSystem?: (FileSystemApplicationLogsConfig5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application logs azure blob storage configuration.␊ - */␊ - export interface AzureBlobStorageApplicationLogsConfig5 {␊ - /**␊ - * Log level.␊ - */␊ - level?: (("Off" | "Verbose" | "Information" | "Warning" | "Error") | string)␊ - /**␊ - * Retention in days.␊ - * Remove blobs older than X days.␊ - * 0 or lower means no retention.␊ - */␊ - retentionInDays?: (number | string)␊ - /**␊ - * SAS url to a azure blob container with read/write/list/delete permissions.␊ - */␊ - sasUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application logs to Azure table storage configuration.␊ - */␊ - export interface AzureTableStorageApplicationLogsConfig5 {␊ - /**␊ - * Log level.␊ - */␊ - level?: (("Off" | "Verbose" | "Information" | "Warning" | "Error") | string)␊ - /**␊ - * SAS URL to an Azure table with add/query/delete permissions.␊ - */␊ - sasUrl: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application logs to file system configuration.␊ - */␊ - export interface FileSystemApplicationLogsConfig5 {␊ - /**␊ - * Log level.␊ - */␊ - level?: (("Off" | "Verbose" | "Information" | "Warning" | "Error") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Enabled configuration.␊ - */␊ - export interface EnabledConfig5 {␊ - /**␊ - * True if configuration is enabled, false if it is disabled and null if configuration is not set.␊ - */␊ - enabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http logs configuration.␊ - */␊ - export interface HttpLogsConfig5 {␊ - /**␊ - * Http logs to azure blob storage configuration.␊ - */␊ - azureBlobStorage?: (AzureBlobStorageHttpLogsConfig5 | string)␊ - /**␊ - * Http logs to file system configuration.␊ - */␊ - fileSystem?: (FileSystemHttpLogsConfig5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http logs to azure blob storage configuration.␊ - */␊ - export interface AzureBlobStorageHttpLogsConfig5 {␊ - /**␊ - * True if configuration is enabled, false if it is disabled and null if configuration is not set.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Retention in days.␊ - * Remove blobs older than X days.␊ - * 0 or lower means no retention.␊ - */␊ - retentionInDays?: (number | string)␊ - /**␊ - * SAS url to a azure blob container with read/write/list/delete permissions.␊ - */␊ - sasUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http logs to file system configuration.␊ - */␊ - export interface FileSystemHttpLogsConfig5 {␊ - /**␊ - * True if configuration is enabled, false if it is disabled and null if configuration is not set.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Retention in days.␊ - * Remove files older than X days.␊ - * 0 or lower means no retention.␊ - */␊ - retentionInDays?: (number | string)␊ - /**␊ - * 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.␊ - */␊ - retentionInMb?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Names for connection strings, application settings, and external Azure storage account configuration␊ - * identifiers 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.␊ - */␊ - export interface SlotConfigNames4 {␊ - /**␊ - * List of application settings names.␊ - */␊ - appSettingNames?: (string[] | string)␊ - /**␊ - * List of external Azure storage account identifiers.␊ - */␊ - azureStorageConfigNames?: (string[] | string)␊ - /**␊ - * List of connection string names.␊ - */␊ - connectionStringNames?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/deployments␊ - */␊ - export interface SitesDeploymentsChildResource5 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * ID of an existing deployment.␊ - */␊ - name: string␊ - /**␊ - * Deployment resource specific properties␊ - */␊ - properties: (DeploymentProperties7 | string)␊ - type: "deployments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Deployment resource specific properties␊ - */␊ - export interface DeploymentProperties7 {␊ - /**␊ - * True if deployment is currently active, false if completed and null if not started.␊ - */␊ - active?: (boolean | string)␊ - /**␊ - * Who authored the deployment.␊ - */␊ - author?: string␊ - /**␊ - * Author email.␊ - */␊ - author_email?: string␊ - /**␊ - * Who performed the deployment.␊ - */␊ - deployer?: string␊ - /**␊ - * Details on deployment.␊ - */␊ - details?: string␊ - /**␊ - * End time.␊ - */␊ - end_time?: string␊ - /**␊ - * Details about deployment status.␊ - */␊ - message?: string␊ - /**␊ - * Start time.␊ - */␊ - start_time?: string␊ - /**␊ - * Deployment status.␊ - */␊ - status?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/domainOwnershipIdentifiers␊ - */␊ - export interface SitesDomainOwnershipIdentifiersChildResource4 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of domain ownership identifier.␊ - */␊ - name: string␊ - /**␊ - * Identifier resource specific properties␊ - */␊ - properties: (IdentifierProperties4 | string)␊ - type: "domainOwnershipIdentifiers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identifier resource specific properties␊ - */␊ - export interface IdentifierProperties4 {␊ - /**␊ - * String representation of the identity.␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/extensions␊ - */␊ - export interface SitesExtensionsChildResource4 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "MSDeploy"␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - properties: (MSDeployCore4 | string)␊ - type: "extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - export interface MSDeployCore4 {␊ - /**␊ - * Sets the AppOffline rule while the MSDeploy operation executes.␊ - * Setting is false by default.␊ - */␊ - appOffline?: (boolean | string)␊ - /**␊ - * SQL Connection String␊ - */␊ - connectionString?: string␊ - /**␊ - * Database Type␊ - */␊ - dbType?: string␊ - /**␊ - * Package URI␊ - */␊ - packageUri?: string␊ - /**␊ - * MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used.␊ - */␊ - setParameters?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * URI of MSDeploy Parameters file. Must not be set if SetParameters is used.␊ - */␊ - setParametersXmlFileUri?: string␊ - /**␊ - * 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.␊ - */␊ - skipAppData?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/functions␊ - */␊ - export interface SitesFunctionsChildResource4 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Function name.␊ - */␊ - name: string␊ - /**␊ - * FunctionEnvelope resource specific properties␊ - */␊ - properties: (FunctionEnvelopeProperties4 | string)␊ - type: "functions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * FunctionEnvelope resource specific properties␊ - */␊ - export interface FunctionEnvelopeProperties4 {␊ - /**␊ - * Config information.␊ - */␊ - config?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Config URI.␊ - */␊ - config_href?: string␊ - /**␊ - * File list.␊ - */␊ - files?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Function App ID.␊ - */␊ - function_app_id?: string␊ - /**␊ - * Function URI.␊ - */␊ - href?: string␊ - /**␊ - * The invocation URL␊ - */␊ - invoke_url_template?: string␊ - /**␊ - * Gets or sets a value indicating whether the function is disabled␊ - */␊ - isDisabled?: (boolean | string)␊ - /**␊ - * The function language␊ - */␊ - language?: string␊ - /**␊ - * Script URI.␊ - */␊ - script_href?: string␊ - /**␊ - * Script root path URI.␊ - */␊ - script_root_path_href?: string␊ - /**␊ - * Secrets file URI.␊ - */␊ - secrets_file_href?: string␊ - /**␊ - * Test data used when testing via the Azure Portal.␊ - */␊ - test_data?: string␊ - /**␊ - * Test data URI.␊ - */␊ - test_data_href?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/hostNameBindings␊ - */␊ - export interface SitesHostNameBindingsChildResource5 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Hostname in the hostname binding.␊ - */␊ - name: string␊ - /**␊ - * HostNameBinding resource specific properties␊ - */␊ - properties: (HostNameBindingProperties5 | string)␊ - type: "hostNameBindings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HostNameBinding resource specific properties␊ - */␊ - export interface HostNameBindingProperties5 {␊ - /**␊ - * Azure resource name.␊ - */␊ - azureResourceName?: string␊ - /**␊ - * Azure resource type.␊ - */␊ - azureResourceType?: (("Website" | "TrafficManager") | string)␊ - /**␊ - * Custom DNS record type.␊ - */␊ - customHostNameDnsRecordType?: (("CName" | "A") | string)␊ - /**␊ - * Fully qualified ARM domain resource URI.␊ - */␊ - domainId?: string␊ - /**␊ - * Hostname type.␊ - */␊ - hostNameType?: (("Verified" | "Managed") | string)␊ - /**␊ - * App Service app name.␊ - */␊ - siteName?: string␊ - /**␊ - * SSL type.␊ - */␊ - sslState?: (("Disabled" | "SniEnabled" | "IpBasedEnabled") | string)␊ - /**␊ - * SSL certificate thumbprint␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/hybridconnection␊ - */␊ - export interface SitesHybridconnectionChildResource5 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the hybrid connection configuration.␊ - */␊ - name: string␊ - /**␊ - * RelayServiceConnectionEntity resource specific properties␊ - */␊ - properties: (RelayServiceConnectionEntityProperties5 | string)␊ - type: "hybridconnection"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * RelayServiceConnectionEntity resource specific properties␊ - */␊ - export interface RelayServiceConnectionEntityProperties5 {␊ - biztalkUri?: string␊ - entityConnectionString?: string␊ - entityName?: string␊ - hostname?: string␊ - port?: (number | string)␊ - resourceConnectionString?: string␊ - resourceType?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/migrate␊ - */␊ - export interface SitesMigrateChildResource4 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "migrate"␊ - /**␊ - * StorageMigrationOptions resource specific properties␊ - */␊ - properties: (StorageMigrationOptionsProperties4 | string)␊ - type: "migrate"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * StorageMigrationOptions resource specific properties␊ - */␊ - export interface StorageMigrationOptionsProperties4 {␊ - /**␊ - * AzureFiles connection string.␊ - */␊ - azurefilesConnectionString: string␊ - /**␊ - * AzureFiles share.␊ - */␊ - azurefilesShare: string␊ - /**␊ - * true if the app should be read only during copy operation; otherwise, false.␊ - */␊ - blockWriteAccessToSite?: (boolean | string)␊ - /**␊ - * trueif the app should be switched over; otherwise, false.␊ - */␊ - switchSiteAfterMigration?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/networkConfig␊ - */␊ - export interface SitesNetworkConfigChildResource3 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "virtualNetwork"␊ - /**␊ - * SwiftVirtualNetwork resource specific properties␊ - */␊ - properties: (SwiftVirtualNetworkProperties3 | string)␊ - type: "networkConfig"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SwiftVirtualNetwork resource specific properties␊ - */␊ - export interface SwiftVirtualNetworkProperties3 {␊ - /**␊ - * The Virtual Network subnet's resource ID. This is the subnet that this Web App will join. This subnet must have a delegation to Microsoft.Web/serverFarms defined first.␊ - */␊ - subnetResourceId?: string␊ - /**␊ - * A flag that specifies if the scale unit this Web App is on supports Swift integration.␊ - */␊ - swiftSupported?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/premieraddons␊ - */␊ - export interface SitesPremieraddonsChildResource5 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Add-on name.␊ - */␊ - name: string␊ - /**␊ - * PremierAddOn resource specific properties␊ - */␊ - properties: (PremierAddOnProperties4 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "premieraddons"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * PremierAddOn resource specific properties␊ - */␊ - export interface PremierAddOnProperties4 {␊ - /**␊ - * Premier add on Marketplace offer.␊ - */␊ - marketplaceOffer?: string␊ - /**␊ - * Premier add on Marketplace publisher.␊ - */␊ - marketplacePublisher?: string␊ - /**␊ - * Premier add on Product.␊ - */␊ - product?: string␊ - /**␊ - * Premier add on SKU.␊ - */␊ - sku?: string␊ - /**␊ - * Premier add on Vendor.␊ - */␊ - vendor?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/privateAccess␊ - */␊ - export interface SitesPrivateAccessChildResource3 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "virtualNetworks"␊ - /**␊ - * PrivateAccess resource specific properties␊ - */␊ - properties: (PrivateAccessProperties3 | string)␊ - type: "privateAccess"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * PrivateAccess resource specific properties␊ - */␊ - export interface PrivateAccessProperties3 {␊ - /**␊ - * Whether private access is enabled or not.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * The Virtual Networks (and subnets) allowed to access the site privately.␊ - */␊ - virtualNetworks?: (PrivateAccessVirtualNetwork3[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a Virtual Network that is useable for private site access.␊ - */␊ - export interface PrivateAccessVirtualNetwork3 {␊ - /**␊ - * The key (ID) of the Virtual Network.␊ - */␊ - key?: (number | string)␊ - /**␊ - * The name of the Virtual Network.␊ - */␊ - name?: string␊ - /**␊ - * The ARM uri of the Virtual Network␊ - */␊ - resourceId?: string␊ - /**␊ - * A List of subnets that access is allowed to on this Virtual Network. An empty array (but not null) is interpreted to mean that all subnets are allowed within this Virtual Network.␊ - */␊ - subnets?: (PrivateAccessSubnet3[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a Virtual Network subnet that is useable for private site access.␊ - */␊ - export interface PrivateAccessSubnet3 {␊ - /**␊ - * The key (ID) of the subnet.␊ - */␊ - key?: (number | string)␊ - /**␊ - * The name of the subnet.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/publicCertificates␊ - */␊ - export interface SitesPublicCertificatesChildResource4 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Public certificate name.␊ - */␊ - name: string␊ - /**␊ - * PublicCertificate resource specific properties␊ - */␊ - properties: (PublicCertificateProperties4 | string)␊ - type: "publicCertificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * PublicCertificate resource specific properties␊ - */␊ - export interface PublicCertificateProperties4 {␊ - /**␊ - * Public Certificate byte array␊ - */␊ - blob?: string␊ - /**␊ - * Public Certificate Location.␊ - */␊ - publicCertificateLocation?: (("CurrentUserMy" | "LocalMachineMy" | "Unknown") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/siteextensions␊ - */␊ - export interface SitesSiteextensionsChildResource4 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Site extension name.␊ - */␊ - name: string␊ - type: "siteextensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots␊ - */␊ - export interface SitesSlotsChildResource5 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Managed service identity.␊ - */␊ - identity?: (ManagedServiceIdentity18 | string)␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the deployment slot to create or update. The name 'production' is reserved.␊ - */␊ - name: string␊ - /**␊ - * Site resource specific properties␊ - */␊ - properties: (SiteProperties5 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "slots"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/privateEndpointConnections␊ - */␊ - export interface SitesPrivateEndpointConnectionsChildResource1 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * A request to approve or reject a private endpoint connection␊ - */␊ - properties: (PrivateLinkConnectionApprovalRequest2 | string)␊ - type: "privateEndpointConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A request to approve or reject a private endpoint connection␊ - */␊ - export interface PrivateLinkConnectionApprovalRequest2 {␊ - /**␊ - * The state of a private link connection␊ - */␊ - privateLinkServiceConnectionState?: (PrivateLinkConnectionState2 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The state of a private link connection␊ - */␊ - export interface PrivateLinkConnectionState2 {␊ - /**␊ - * ActionsRequired for a private link connection␊ - */␊ - actionsRequired?: string␊ - /**␊ - * Description of a private link connection␊ - */␊ - description?: string␊ - /**␊ - * Status of a private link connection␊ - */␊ - status?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/sourcecontrols␊ - */␊ - export interface SitesSourcecontrolsChildResource5 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "web"␊ - /**␊ - * SiteSourceControl resource specific properties␊ - */␊ - properties: (SiteSourceControlProperties5 | string)␊ - type: "sourcecontrols"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SiteSourceControl resource specific properties␊ - */␊ - export interface SiteSourceControlProperties5 {␊ - /**␊ - * Name of branch to use for deployment.␊ - */␊ - branch?: string␊ - /**␊ - * true to enable deployment rollback; otherwise, false.␊ - */␊ - deploymentRollbackEnabled?: (boolean | string)␊ - /**␊ - * true if this is deployed via GitHub action.␊ - */␊ - isGitHubAction?: (boolean | string)␊ - /**␊ - * true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub).␊ - */␊ - isManualIntegration?: (boolean | string)␊ - /**␊ - * true for a Mercurial repository; false for a Git repository.␊ - */␊ - isMercurial?: (boolean | string)␊ - /**␊ - * Repository or source control URL.␊ - */␊ - repoUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/virtualNetworkConnections␊ - */␊ - export interface SitesVirtualNetworkConnectionsChildResource5 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of an existing Virtual Network.␊ - */␊ - name: string␊ - /**␊ - * VnetInfo resource specific properties␊ - */␊ - properties: (VnetInfoProperties5 | string)␊ - type: "virtualNetworkConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VnetInfo resource specific properties␊ - */␊ - export interface VnetInfoProperties5 {␊ - /**␊ - * A certificate file (.cer) blob containing the public key of the private key used to authenticate a ␊ - * Point-To-Site VPN connection.␊ - */␊ - certBlob?: string␊ - /**␊ - * DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses.␊ - */␊ - dnsServers?: string␊ - /**␊ - * Flag that is used to denote if this is VNET injection␊ - */␊ - isSwift?: (boolean | string)␊ - /**␊ - * The Virtual Network's resource ID.␊ - */␊ - vnetResourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/deployments␊ - */␊ - export interface SitesDeployments5 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * ID of an existing deployment.␊ - */␊ - name: string␊ - /**␊ - * Deployment resource specific properties␊ - */␊ - properties: (DeploymentProperties7 | string)␊ - type: "Microsoft.Web/sites/deployments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/domainOwnershipIdentifiers␊ - */␊ - export interface SitesDomainOwnershipIdentifiers4 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of domain ownership identifier.␊ - */␊ - name: string␊ - /**␊ - * Identifier resource specific properties␊ - */␊ - properties: (IdentifierProperties4 | string)␊ - type: "Microsoft.Web/sites/domainOwnershipIdentifiers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/extensions␊ - */␊ - export interface SitesExtensions4 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - properties: (MSDeployCore4 | string)␊ - type: "Microsoft.Web/sites/extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/functions␊ - */␊ - export interface SitesFunctions4 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Function name.␊ - */␊ - name: string␊ - /**␊ - * FunctionEnvelope resource specific properties␊ - */␊ - properties: (FunctionEnvelopeProperties4 | string)␊ - resources?: SitesFunctionsKeysChildResource2[]␊ - type: "Microsoft.Web/sites/functions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/functions/keys␊ - */␊ - export interface SitesFunctionsKeysChildResource2 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * The name of the key.␊ - */␊ - name: string␊ - type: "keys"␊ - /**␊ - * Key value␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/functions/keys␊ - */␊ - export interface SitesFunctionsKeys2 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * The name of the key.␊ - */␊ - name: string␊ - type: "Microsoft.Web/sites/functions/keys"␊ - /**␊ - * Key value␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/hostNameBindings␊ - */␊ - export interface SitesHostNameBindings5 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Hostname in the hostname binding.␊ - */␊ - name: string␊ - /**␊ - * HostNameBinding resource specific properties␊ - */␊ - properties: (HostNameBindingProperties5 | string)␊ - type: "Microsoft.Web/sites/hostNameBindings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/hybridconnection␊ - */␊ - export interface SitesHybridconnection5 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the hybrid connection configuration.␊ - */␊ - name: string␊ - /**␊ - * RelayServiceConnectionEntity resource specific properties␊ - */␊ - properties: (RelayServiceConnectionEntityProperties5 | string)␊ - type: "Microsoft.Web/sites/hybridconnection"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/hybridConnectionNamespaces/relays␊ - */␊ - export interface SitesHybridConnectionNamespacesRelays4 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * The relay name for this hybrid connection.␊ - */␊ - name: string␊ - /**␊ - * HybridConnection resource specific properties␊ - */␊ - properties: (HybridConnectionProperties6 | string)␊ - type: "Microsoft.Web/sites/hybridConnectionNamespaces/relays"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HybridConnection resource specific properties␊ - */␊ - export interface HybridConnectionProperties6 {␊ - /**␊ - * The hostname of the endpoint.␊ - */␊ - hostname?: string␊ - /**␊ - * The port of the endpoint.␊ - */␊ - port?: (number | string)␊ - /**␊ - * The ARM URI to the Service Bus relay.␊ - */␊ - relayArmUri?: string␊ - /**␊ - * The name of the Service Bus relay.␊ - */␊ - relayName?: string␊ - /**␊ - * The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus.␊ - */␊ - sendKeyName?: string␊ - /**␊ - * 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.␊ - */␊ - sendKeyValue?: string␊ - /**␊ - * The name of the Service Bus namespace.␊ - */␊ - serviceBusNamespace?: string␊ - /**␊ - * The suffix for the service bus endpoint. By default this is .servicebus.windows.net␊ - */␊ - serviceBusSuffix?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/instances/extensions␊ - */␊ - export interface SitesInstancesExtensions4 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - properties: (MSDeployCore4 | string)␊ - type: "Microsoft.Web/sites/instances/extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/migrate␊ - */␊ - export interface SitesMigrate4 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * StorageMigrationOptions resource specific properties␊ - */␊ - properties: (StorageMigrationOptionsProperties4 | string)␊ - type: "Microsoft.Web/sites/migrate"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/networkConfig␊ - */␊ - export interface SitesNetworkConfig3 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SwiftVirtualNetwork resource specific properties␊ - */␊ - properties: (SwiftVirtualNetworkProperties3 | string)␊ - type: "Microsoft.Web/sites/networkConfig"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/premieraddons␊ - */␊ - export interface SitesPremieraddons5 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Add-on name.␊ - */␊ - name: string␊ - /**␊ - * PremierAddOn resource specific properties␊ - */␊ - properties: (PremierAddOnProperties4 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/sites/premieraddons"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/privateAccess␊ - */␊ - export interface SitesPrivateAccess3 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * PrivateAccess resource specific properties␊ - */␊ - properties: (PrivateAccessProperties3 | string)␊ - type: "Microsoft.Web/sites/privateAccess"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/privateEndpointConnections␊ - */␊ - export interface SitesPrivateEndpointConnections1 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * A request to approve or reject a private endpoint connection␊ - */␊ - properties: (PrivateLinkConnectionApprovalRequest2 | string)␊ - type: "Microsoft.Web/sites/privateEndpointConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/publicCertificates␊ - */␊ - export interface SitesPublicCertificates4 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Public certificate name.␊ - */␊ - name: string␊ - /**␊ - * PublicCertificate resource specific properties␊ - */␊ - properties: (PublicCertificateProperties4 | string)␊ - type: "Microsoft.Web/sites/publicCertificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/siteextensions␊ - */␊ - export interface SitesSiteextensions4 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Site extension name.␊ - */␊ - name: string␊ - type: "Microsoft.Web/sites/siteextensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots␊ - */␊ - export interface SitesSlots5 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Managed service identity.␊ - */␊ - identity?: (ManagedServiceIdentity18 | string)␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the deployment slot to create or update. The name 'production' is reserved.␊ - */␊ - name: string␊ - /**␊ - * Site resource specific properties␊ - */␊ - properties: (SiteProperties5 | string)␊ - resources?: (SitesSlotsConfigChildResource5 | SitesSlotsDeploymentsChildResource5 | SitesSlotsDomainOwnershipIdentifiersChildResource4 | SitesSlotsExtensionsChildResource4 | SitesSlotsFunctionsChildResource4 | SitesSlotsHostNameBindingsChildResource5 | SitesSlotsHybridconnectionChildResource5 | SitesSlotsNetworkConfigChildResource3 | SitesSlotsPremieraddonsChildResource5 | SitesSlotsPrivateAccessChildResource3 | SitesSlotsPublicCertificatesChildResource4 | SitesSlotsSiteextensionsChildResource4 | SitesSlotsSourcecontrolsChildResource5 | SitesSlotsVirtualNetworkConnectionsChildResource5)[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/sites/slots"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/deployments␊ - */␊ - export interface SitesSlotsDeploymentsChildResource5 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * ID of an existing deployment.␊ - */␊ - name: string␊ - /**␊ - * Deployment resource specific properties␊ - */␊ - properties: (DeploymentProperties7 | string)␊ - type: "deployments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/domainOwnershipIdentifiers␊ - */␊ - export interface SitesSlotsDomainOwnershipIdentifiersChildResource4 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of domain ownership identifier.␊ - */␊ - name: string␊ - /**␊ - * Identifier resource specific properties␊ - */␊ - properties: (IdentifierProperties4 | string)␊ - type: "domainOwnershipIdentifiers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/extensions␊ - */␊ - export interface SitesSlotsExtensionsChildResource4 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "MSDeploy"␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - properties: (MSDeployCore4 | string)␊ - type: "extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/functions␊ - */␊ - export interface SitesSlotsFunctionsChildResource4 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Function name.␊ - */␊ - name: string␊ - /**␊ - * FunctionEnvelope resource specific properties␊ - */␊ - properties: (FunctionEnvelopeProperties4 | string)␊ - type: "functions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/hostNameBindings␊ - */␊ - export interface SitesSlotsHostNameBindingsChildResource5 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Hostname in the hostname binding.␊ - */␊ - name: string␊ - /**␊ - * HostNameBinding resource specific properties␊ - */␊ - properties: (HostNameBindingProperties5 | string)␊ - type: "hostNameBindings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/hybridconnection␊ - */␊ - export interface SitesSlotsHybridconnectionChildResource5 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the hybrid connection configuration.␊ - */␊ - name: string␊ - /**␊ - * RelayServiceConnectionEntity resource specific properties␊ - */␊ - properties: (RelayServiceConnectionEntityProperties5 | string)␊ - type: "hybridconnection"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/networkConfig␊ - */␊ - export interface SitesSlotsNetworkConfigChildResource3 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "virtualNetwork"␊ - /**␊ - * SwiftVirtualNetwork resource specific properties␊ - */␊ - properties: (SwiftVirtualNetworkProperties3 | string)␊ - type: "networkConfig"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/premieraddons␊ - */␊ - export interface SitesSlotsPremieraddonsChildResource5 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Add-on name.␊ - */␊ - name: string␊ - /**␊ - * PremierAddOn resource specific properties␊ - */␊ - properties: (PremierAddOnProperties4 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "premieraddons"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/privateAccess␊ - */␊ - export interface SitesSlotsPrivateAccessChildResource3 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "virtualNetworks"␊ - /**␊ - * PrivateAccess resource specific properties␊ - */␊ - properties: (PrivateAccessProperties3 | string)␊ - type: "privateAccess"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/publicCertificates␊ - */␊ - export interface SitesSlotsPublicCertificatesChildResource4 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Public certificate name.␊ - */␊ - name: string␊ - /**␊ - * PublicCertificate resource specific properties␊ - */␊ - properties: (PublicCertificateProperties4 | string)␊ - type: "publicCertificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/siteextensions␊ - */␊ - export interface SitesSlotsSiteextensionsChildResource4 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Site extension name.␊ - */␊ - name: string␊ - type: "siteextensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/sourcecontrols␊ - */␊ - export interface SitesSlotsSourcecontrolsChildResource5 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "web"␊ - /**␊ - * SiteSourceControl resource specific properties␊ - */␊ - properties: (SiteSourceControlProperties5 | string)␊ - type: "sourcecontrols"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/virtualNetworkConnections␊ - */␊ - export interface SitesSlotsVirtualNetworkConnectionsChildResource5 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of an existing Virtual Network.␊ - */␊ - name: string␊ - /**␊ - * VnetInfo resource specific properties␊ - */␊ - properties: (VnetInfoProperties5 | string)␊ - type: "virtualNetworkConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/deployments␊ - */␊ - export interface SitesSlotsDeployments5 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * ID of an existing deployment.␊ - */␊ - name: string␊ - /**␊ - * Deployment resource specific properties␊ - */␊ - properties: (DeploymentProperties7 | string)␊ - type: "Microsoft.Web/sites/slots/deployments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/domainOwnershipIdentifiers␊ - */␊ - export interface SitesSlotsDomainOwnershipIdentifiers4 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of domain ownership identifier.␊ - */␊ - name: string␊ - /**␊ - * Identifier resource specific properties␊ - */␊ - properties: (IdentifierProperties4 | string)␊ - type: "Microsoft.Web/sites/slots/domainOwnershipIdentifiers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/extensions␊ - */␊ - export interface SitesSlotsExtensions4 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - properties: (MSDeployCore4 | string)␊ - type: "Microsoft.Web/sites/slots/extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/functions␊ - */␊ - export interface SitesSlotsFunctions4 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Function name.␊ - */␊ - name: string␊ - /**␊ - * FunctionEnvelope resource specific properties␊ - */␊ - properties: (FunctionEnvelopeProperties4 | string)␊ - resources?: SitesSlotsFunctionsKeysChildResource2[]␊ - type: "Microsoft.Web/sites/slots/functions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/functions/keys␊ - */␊ - export interface SitesSlotsFunctionsKeysChildResource2 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * The name of the key.␊ - */␊ - name: string␊ - type: "keys"␊ - /**␊ - * Key value␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/functions/keys␊ - */␊ - export interface SitesSlotsFunctionsKeys2 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * The name of the key.␊ - */␊ - name: string␊ - type: "Microsoft.Web/sites/slots/functions/keys"␊ - /**␊ - * Key value␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/hostNameBindings␊ - */␊ - export interface SitesSlotsHostNameBindings5 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Hostname in the hostname binding.␊ - */␊ - name: string␊ - /**␊ - * HostNameBinding resource specific properties␊ - */␊ - properties: (HostNameBindingProperties5 | string)␊ - type: "Microsoft.Web/sites/slots/hostNameBindings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/hybridconnection␊ - */␊ - export interface SitesSlotsHybridconnection5 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the hybrid connection configuration.␊ - */␊ - name: string␊ - /**␊ - * RelayServiceConnectionEntity resource specific properties␊ - */␊ - properties: (RelayServiceConnectionEntityProperties5 | string)␊ - type: "Microsoft.Web/sites/slots/hybridconnection"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays␊ - */␊ - export interface SitesSlotsHybridConnectionNamespacesRelays4 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * The relay name for this hybrid connection.␊ - */␊ - name: string␊ - /**␊ - * HybridConnection resource specific properties␊ - */␊ - properties: (HybridConnectionProperties6 | string)␊ - type: "Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/instances/extensions␊ - */␊ - export interface SitesSlotsInstancesExtensions4 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - properties: (MSDeployCore4 | string)␊ - type: "Microsoft.Web/sites/slots/instances/extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/networkConfig␊ - */␊ - export interface SitesSlotsNetworkConfig3 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SwiftVirtualNetwork resource specific properties␊ - */␊ - properties: (SwiftVirtualNetworkProperties3 | string)␊ - type: "Microsoft.Web/sites/slots/networkConfig"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/premieraddons␊ - */␊ - export interface SitesSlotsPremieraddons5 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Add-on name.␊ - */␊ - name: string␊ - /**␊ - * PremierAddOn resource specific properties␊ - */␊ - properties: (PremierAddOnProperties4 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/sites/slots/premieraddons"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/privateAccess␊ - */␊ - export interface SitesSlotsPrivateAccess3 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * PrivateAccess resource specific properties␊ - */␊ - properties: (PrivateAccessProperties3 | string)␊ - type: "Microsoft.Web/sites/slots/privateAccess"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/publicCertificates␊ - */␊ - export interface SitesSlotsPublicCertificates4 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Public certificate name.␊ - */␊ - name: string␊ - /**␊ - * PublicCertificate resource specific properties␊ - */␊ - properties: (PublicCertificateProperties4 | string)␊ - type: "Microsoft.Web/sites/slots/publicCertificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/siteextensions␊ - */␊ - export interface SitesSlotsSiteextensions4 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Site extension name.␊ - */␊ - name: string␊ - type: "Microsoft.Web/sites/slots/siteextensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/sourcecontrols␊ - */␊ - export interface SitesSlotsSourcecontrols5 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteSourceControl resource specific properties␊ - */␊ - properties: (SiteSourceControlProperties5 | string)␊ - type: "Microsoft.Web/sites/slots/sourcecontrols"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/virtualNetworkConnections␊ - */␊ - export interface SitesSlotsVirtualNetworkConnections5 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of an existing Virtual Network.␊ - */␊ - name: string␊ - /**␊ - * VnetInfo resource specific properties␊ - */␊ - properties: (VnetInfoProperties5 | string)␊ - resources?: SitesSlotsVirtualNetworkConnectionsGatewaysChildResource5[]␊ - type: "Microsoft.Web/sites/slots/virtualNetworkConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/virtualNetworkConnections/gateways␊ - */␊ - export interface SitesSlotsVirtualNetworkConnectionsGatewaysChildResource5 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the gateway. Currently, the only supported string is "primary".␊ - */␊ - name: string␊ - /**␊ - * VnetGateway resource specific properties␊ - */␊ - properties: (VnetGatewayProperties6 | string)␊ - type: "gateways"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/virtualNetworkConnections/gateways␊ - */␊ - export interface SitesSlotsVirtualNetworkConnectionsGateways5 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the gateway. Currently, the only supported string is "primary".␊ - */␊ - name: string␊ - /**␊ - * VnetGateway resource specific properties␊ - */␊ - properties: (VnetGatewayProperties6 | string)␊ - type: "Microsoft.Web/sites/slots/virtualNetworkConnections/gateways"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/sourcecontrols␊ - */␊ - export interface SitesSourcecontrols5 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteSourceControl resource specific properties␊ - */␊ - properties: (SiteSourceControlProperties5 | string)␊ - type: "Microsoft.Web/sites/sourcecontrols"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/virtualNetworkConnections␊ - */␊ - export interface SitesVirtualNetworkConnections5 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of an existing Virtual Network.␊ - */␊ - name: string␊ - /**␊ - * VnetInfo resource specific properties␊ - */␊ - properties: (VnetInfoProperties5 | string)␊ - resources?: SitesVirtualNetworkConnectionsGatewaysChildResource5[]␊ - type: "Microsoft.Web/sites/virtualNetworkConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/virtualNetworkConnections/gateways␊ - */␊ - export interface SitesVirtualNetworkConnectionsGatewaysChildResource5 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the gateway. Currently, the only supported string is "primary".␊ - */␊ - name: string␊ - /**␊ - * VnetGateway resource specific properties␊ - */␊ - properties: (VnetGatewayProperties6 | string)␊ - type: "gateways"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/virtualNetworkConnections/gateways␊ - */␊ - export interface SitesVirtualNetworkConnectionsGateways5 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the gateway. Currently, the only supported string is "primary".␊ - */␊ - name: string␊ - /**␊ - * VnetGateway resource specific properties␊ - */␊ - properties: (VnetGatewayProperties6 | string)␊ - type: "Microsoft.Web/sites/virtualNetworkConnections/gateways"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/staticSites␊ - */␊ - export interface StaticSites1 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the static site to create or update.␊ - */␊ - name: string␊ - /**␊ - * A static site.␊ - */␊ - properties: (StaticSite1 | string)␊ - resources?: (StaticSitesConfigChildResource1 | StaticSitesCustomDomainsChildResource1)[]␊ - /**␊ - * Description of a SKU for a scalable resource.␊ - */␊ - sku?: (SkuDescription6 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/staticSites"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A static site.␊ - */␊ - export interface StaticSite1 {␊ - /**␊ - * The target branch in the repository.␊ - */␊ - branch?: string␊ - /**␊ - * Build properties for the static site.␊ - */␊ - buildProperties?: (StaticSiteBuildProperties1 | string)␊ - /**␊ - * A user's github repository token. This is used to setup the Github Actions workflow file and API secrets.␊ - */␊ - repositoryToken?: string␊ - /**␊ - * URL for the repository of the static site.␊ - */␊ - repositoryUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Build properties for the static site.␊ - */␊ - export interface StaticSiteBuildProperties1 {␊ - /**␊ - * The path to the api code within the repository.␊ - */␊ - apiLocation?: string␊ - /**␊ - * The path of the app artifacts after building.␊ - */␊ - appArtifactLocation?: string␊ - /**␊ - * The path to the app code within the repository.␊ - */␊ - appLocation?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/staticSites/config␊ - */␊ - export interface StaticSitesConfigChildResource1 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "functionappsettings"␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - type: "config"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/staticSites/customDomains␊ - */␊ - export interface StaticSitesCustomDomainsChildResource1 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * The custom domain to create.␊ - */␊ - name: string␊ - type: "customDomains"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/staticSites/builds/config␊ - */␊ - export interface StaticSitesBuildsConfig1 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/staticSites/builds/config"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/staticSites/config␊ - */␊ - export interface StaticSitesConfig1 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/staticSites/config"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/staticSites/customDomains␊ - */␊ - export interface StaticSitesCustomDomains1 {␊ - apiVersion: "2020-06-01"␊ - /**␊ - * The custom domain to create.␊ - */␊ - name: string␊ - type: "Microsoft.Web/staticSites/customDomains"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/certificates␊ - */␊ - export interface Certificates6 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the certificate.␊ - */␊ - name: string␊ - /**␊ - * Certificate resource specific properties␊ - */␊ - properties: (CertificateProperties6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/certificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Certificate resource specific properties␊ - */␊ - export interface CertificateProperties6 {␊ - /**␊ - * CNAME of the certificate to be issued via free certificate␊ - */␊ - canonicalName?: string␊ - /**␊ - * Host names the certificate applies to.␊ - */␊ - hostNames?: (string[] | string)␊ - /**␊ - * Key Vault Csm resource Id.␊ - */␊ - keyVaultId?: string␊ - /**␊ - * Key Vault secret name.␊ - */␊ - keyVaultSecretName?: string␊ - /**␊ - * Certificate password.␊ - */␊ - password: string␊ - /**␊ - * Pfx blob.␊ - */␊ - pfxBlob?: string␊ - /**␊ - * Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".␊ - */␊ - serverFarmId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - export interface SystemData5 {␊ - /**␊ - * The timestamp of resource creation (UTC).␊ - */␊ - createdAt?: string␊ - /**␊ - * The identity that created the resource.␊ - */␊ - createdBy?: string␊ - /**␊ - * The type of identity that created the resource.␊ - */␊ - createdByType?: (("User" | "Application" | "ManagedIdentity" | "Key") | string)␊ - /**␊ - * The timestamp of resource last modification (UTC)␊ - */␊ - lastModifiedAt?: string␊ - /**␊ - * The identity that last modified the resource.␊ - */␊ - lastModifiedBy?: string␊ - /**␊ - * The type of identity that last modified the resource.␊ - */␊ - lastModifiedByType?: (("User" | "Application" | "ManagedIdentity" | "Key") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/hostingEnvironments␊ - */␊ - export interface HostingEnvironments5 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the App Service Environment.␊ - */␊ - name: string␊ - /**␊ - * Description of an App Service Environment.␊ - */␊ - properties: (AppServiceEnvironment4 | string)␊ - resources?: (HostingEnvironmentsMultiRolePoolsChildResource5 | HostingEnvironmentsWorkerPoolsChildResource5)[]␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/hostingEnvironments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of an App Service Environment.␊ - */␊ - export interface AppServiceEnvironment4 {␊ - /**␊ - * API Management Account associated with the App Service Environment.␊ - */␊ - apiManagementAccountId?: string␊ - /**␊ - * Custom settings for changing the behavior of the App Service Environment.␊ - */␊ - clusterSettings?: (NameValuePair7[] | string)␊ - /**␊ - * DNS suffix of the App Service Environment.␊ - */␊ - dnsSuffix?: string␊ - /**␊ - * True/false indicating whether the App Service Environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available␊ - * (most likely because NSG blocked the incoming traffic).␊ - */␊ - dynamicCacheEnabled?: (boolean | string)␊ - /**␊ - * Scale factor for front-ends.␊ - */␊ - frontEndScaleFactor?: (number | string)␊ - /**␊ - * Flag that displays whether an ASE has linux workers or not␊ - */␊ - hasLinuxWorkers?: (boolean | string)␊ - /**␊ - * Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.␊ - */␊ - internalLoadBalancingMode?: (("None" | "Web" | "Publishing" | "Web,Publishing") | string)␊ - /**␊ - * Number of IP SSL addresses reserved for the App Service Environment.␊ - */␊ - ipsslAddressCount?: (number | string)␊ - /**␊ - * Location of the App Service Environment, e.g. "West US".␊ - */␊ - location: string␊ - /**␊ - * Number of front-end instances.␊ - */␊ - multiRoleCount?: (number | string)␊ - /**␊ - * Front-end VM size, e.g. "Medium", "Large".␊ - */␊ - multiSize?: string␊ - /**␊ - * Name of the App Service Environment.␊ - */␊ - name: string␊ - /**␊ - * Access control list for controlling traffic to the App Service Environment.␊ - */␊ - networkAccessControlList?: (NetworkAccessControlEntry5[] | string)␊ - /**␊ - * Key Vault ID for ILB App Service Environment default SSL certificate␊ - */␊ - sslCertKeyVaultId?: string␊ - /**␊ - * Key Vault Secret Name for ILB App Service Environment default SSL certificate␊ - */␊ - sslCertKeyVaultSecretName?: string␊ - /**␊ - * true if the App Service Environment is suspended; otherwise, false. The environment can be suspended, e.g. when the management endpoint is no longer available␊ - * (most likely because NSG blocked the incoming traffic).␊ - */␊ - suspended?: (boolean | string)␊ - /**␊ - * User added ip ranges to whitelist on ASE db␊ - */␊ - userWhitelistedIpRanges?: (string[] | string)␊ - /**␊ - * Specification for using a Virtual Network.␊ - */␊ - virtualNetwork: (VirtualNetworkProfile8 | string)␊ - /**␊ - * Name of the Virtual Network for the App Service Environment.␊ - */␊ - vnetName?: string␊ - /**␊ - * Resource group of the Virtual Network.␊ - */␊ - vnetResourceGroupName?: string␊ - /**␊ - * Subnet of the Virtual Network.␊ - */␊ - vnetSubnetName?: string␊ - /**␊ - * Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool.␊ - */␊ - workerPools: (WorkerPool5[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Name value pair.␊ - */␊ - export interface NameValuePair7 {␊ - /**␊ - * Pair name.␊ - */␊ - name?: string␊ - /**␊ - * Pair value.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network access control entry.␊ - */␊ - export interface NetworkAccessControlEntry5 {␊ - /**␊ - * Action object.␊ - */␊ - action?: (("Permit" | "Deny") | string)␊ - /**␊ - * Description of network access control entry.␊ - */␊ - description?: string␊ - /**␊ - * Order of precedence.␊ - */␊ - order?: (number | string)␊ - /**␊ - * Remote subnet.␊ - */␊ - remoteSubnet?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specification for using a Virtual Network.␊ - */␊ - export interface VirtualNetworkProfile8 {␊ - /**␊ - * Resource id of the Virtual Network.␊ - */␊ - id?: string␊ - /**␊ - * Subnet within the Virtual Network.␊ - */␊ - subnet?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Worker pool of an App Service Environment.␊ - */␊ - export interface WorkerPool5 {␊ - /**␊ - * Shared or dedicated app hosting.␊ - */␊ - computeMode?: (("Shared" | "Dedicated" | "Dynamic") | string)␊ - /**␊ - * Number of instances in the worker pool.␊ - */␊ - workerCount?: (number | string)␊ - /**␊ - * VM size of the worker pool instances.␊ - */␊ - workerSize?: string␊ - /**␊ - * Worker size ID for referencing this worker pool.␊ - */␊ - workerSizeId?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/hostingEnvironments/multiRolePools␊ - */␊ - export interface HostingEnvironmentsMultiRolePoolsChildResource5 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "default"␊ - /**␊ - * Worker pool of an App Service Environment.␊ - */␊ - properties: (WorkerPool5 | string)␊ - /**␊ - * Description of a SKU for a scalable resource.␊ - */␊ - sku?: (SkuDescription7 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "multiRolePools"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a SKU for a scalable resource.␊ - */␊ - export interface SkuDescription7 {␊ - /**␊ - * Capabilities of the SKU, e.g., is traffic manager enabled?␊ - */␊ - capabilities?: (Capability5[] | string)␊ - /**␊ - * Current number of instances assigned to the resource.␊ - */␊ - capacity?: (number | string)␊ - /**␊ - * Family code of the resource SKU.␊ - */␊ - family?: string␊ - /**␊ - * Locations of the SKU.␊ - */␊ - locations?: (string[] | string)␊ - /**␊ - * Name of the resource SKU.␊ - */␊ - name?: string␊ - /**␊ - * Size specifier of the resource SKU.␊ - */␊ - size?: string␊ - /**␊ - * Description of the App Service plan scale options.␊ - */␊ - skuCapacity?: (SkuCapacity4 | string)␊ - /**␊ - * Service tier of the resource SKU.␊ - */␊ - tier?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the capabilities/features allowed for a specific SKU.␊ - */␊ - export interface Capability5 {␊ - /**␊ - * Name of the SKU capability.␊ - */␊ - name?: string␊ - /**␊ - * Reason of the SKU capability.␊ - */␊ - reason?: string␊ - /**␊ - * Value of the SKU capability.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of the App Service plan scale options.␊ - */␊ - export interface SkuCapacity4 {␊ - /**␊ - * Default number of workers for this App Service plan SKU.␊ - */␊ - default?: (number | string)␊ - /**␊ - * Maximum number of workers for this App Service plan SKU.␊ - */␊ - maximum?: (number | string)␊ - /**␊ - * Minimum number of workers for this App Service plan SKU.␊ - */␊ - minimum?: (number | string)␊ - /**␊ - * Available scale configurations for an App Service plan.␊ - */␊ - scaleType?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/hostingEnvironments/workerPools␊ - */␊ - export interface HostingEnvironmentsWorkerPoolsChildResource5 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the worker pool.␊ - */␊ - name: string␊ - /**␊ - * Worker pool of an App Service Environment.␊ - */␊ - properties: (WorkerPool5 | string)␊ - /**␊ - * Description of a SKU for a scalable resource.␊ - */␊ - sku?: (SkuDescription7 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "workerPools"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/hostingEnvironments/multiRolePools␊ - */␊ - export interface HostingEnvironmentsMultiRolePools5 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Worker pool of an App Service Environment.␊ - */␊ - properties: (WorkerPool5 | string)␊ - /**␊ - * Description of a SKU for a scalable resource.␊ - */␊ - sku?: (SkuDescription7 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "Microsoft.Web/hostingEnvironments/multiRolePools"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/hostingEnvironments/workerPools␊ - */␊ - export interface HostingEnvironmentsWorkerPools5 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the worker pool.␊ - */␊ - name: string␊ - /**␊ - * Worker pool of an App Service Environment.␊ - */␊ - properties: (WorkerPool5 | string)␊ - /**␊ - * Description of a SKU for a scalable resource.␊ - */␊ - sku?: (SkuDescription7 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "Microsoft.Web/hostingEnvironments/workerPools"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/serverfarms␊ - */␊ - export interface Serverfarms5 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the App Service plan.␊ - */␊ - name: string␊ - /**␊ - * AppServicePlan resource specific properties␊ - */␊ - properties: (AppServicePlanProperties4 | string)␊ - /**␊ - * Description of a SKU for a scalable resource.␊ - */␊ - sku?: (SkuDescription7 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/serverfarms"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AppServicePlan resource specific properties␊ - */␊ - export interface AppServicePlanProperties4 {␊ - /**␊ - * The time when the server farm free offer expires.␊ - */␊ - freeOfferExpirationTime?: string␊ - /**␊ - * Specification for an App Service Environment to use for this resource.␊ - */␊ - hostingEnvironmentProfile?: (HostingEnvironmentProfile7 | string)␊ - /**␊ - * If Hyper-V container app service plan true, false otherwise.␊ - */␊ - hyperV?: (boolean | string)␊ - /**␊ - * If true, this App Service Plan owns spot instances.␊ - */␊ - isSpot?: (boolean | string)␊ - /**␊ - * Obsolete: If Hyper-V container app service plan true, false otherwise.␊ - */␊ - isXenon?: (boolean | string)␊ - /**␊ - * Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan␊ - */␊ - maximumElasticWorkerCount?: (number | string)␊ - /**␊ - * 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.␊ - */␊ - perSiteScaling?: (boolean | string)␊ - /**␊ - * If Linux app service plan true, false otherwise.␊ - */␊ - reserved?: (boolean | string)␊ - /**␊ - * The time when the server farm expires. Valid only if it is a spot server farm.␊ - */␊ - spotExpirationTime?: string␊ - /**␊ - * Scaling worker count.␊ - */␊ - targetWorkerCount?: (number | string)␊ - /**␊ - * Scaling worker size ID.␊ - */␊ - targetWorkerSizeId?: (number | string)␊ - /**␊ - * Target worker tier assigned to the App Service plan.␊ - */␊ - workerTierName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specification for an App Service Environment to use for this resource.␊ - */␊ - export interface HostingEnvironmentProfile7 {␊ - /**␊ - * Resource ID of the App Service Environment.␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/serverfarms/virtualNetworkConnections/gateways␊ - */␊ - export interface ServerfarmsVirtualNetworkConnectionsGateways5 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the gateway. Only the 'primary' gateway is supported.␊ - */␊ - name: string␊ - /**␊ - * VnetGateway resource specific properties␊ - */␊ - properties: (VnetGatewayProperties7 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "Microsoft.Web/serverfarms/virtualNetworkConnections/gateways"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VnetGateway resource specific properties␊ - */␊ - export interface VnetGatewayProperties7 {␊ - /**␊ - * The Virtual Network name.␊ - */␊ - vnetName?: string␊ - /**␊ - * The URI where the VPN package can be downloaded.␊ - */␊ - vpnPackageUri: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/serverfarms/virtualNetworkConnections/routes␊ - */␊ - export interface ServerfarmsVirtualNetworkConnectionsRoutes5 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the Virtual Network route.␊ - */␊ - name: string␊ - /**␊ - * VnetRoute resource specific properties␊ - */␊ - properties: (VnetRouteProperties5 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "Microsoft.Web/serverfarms/virtualNetworkConnections/routes"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VnetRoute resource specific properties␊ - */␊ - export interface VnetRouteProperties5 {␊ - /**␊ - * The ending address for this route. If the start address is specified in CIDR notation, this must be omitted.␊ - */␊ - endAddress?: string␊ - /**␊ - * 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.␊ - */␊ - routeType?: (("DEFAULT" | "INHERITED" | "STATIC") | string)␊ - /**␊ - * The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified.␊ - */␊ - startAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites␊ - */␊ - export interface Sites6 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Managed service identity.␊ - */␊ - identity?: (ManagedServiceIdentity19 | string)␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Unique name of the app to create or update. To create or update a deployment slot, use the {slot} parameter.␊ - */␊ - name: string␊ - /**␊ - * Site resource specific properties␊ - */␊ - properties: (SiteProperties6 | string)␊ - resources?: (SitesBasicPublishingCredentialsPoliciesChildResource2 | SitesConfigChildResource6 | SitesDeploymentsChildResource6 | SitesDomainOwnershipIdentifiersChildResource5 | SitesExtensionsChildResource5 | SitesFunctionsChildResource5 | SitesHostNameBindingsChildResource6 | SitesHybridconnectionChildResource6 | SitesMigrateChildResource5 | SitesNetworkConfigChildResource4 | SitesPremieraddonsChildResource6 | SitesPrivateAccessChildResource4 | SitesPublicCertificatesChildResource5 | SitesSiteextensionsChildResource5 | SitesSlotsChildResource6 | SitesPrivateEndpointConnectionsChildResource2 | SitesSourcecontrolsChildResource6 | SitesVirtualNetworkConnectionsChildResource6)[]␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/sites"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Managed service identity.␊ - */␊ - export interface ManagedServiceIdentity19 {␊ - /**␊ - * Type of managed service identity.␊ - */␊ - type?: (("SystemAssigned" | "UserAssigned" | "SystemAssigned, UserAssigned" | "None") | string)␊ - /**␊ - * The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}␊ - */␊ - userAssignedIdentities?: ({␊ - [k: string]: Components1Jq1T4Ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties5␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - export interface Components1Jq1T4Ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties5 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Site resource specific properties␊ - */␊ - export interface SiteProperties6 {␊ - /**␊ - * 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.␊ - */␊ - clientAffinityEnabled?: (boolean | string)␊ - /**␊ - * true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.␊ - */␊ - clientCertEnabled?: (boolean | string)␊ - /**␊ - * client certificate authentication comma-separated exclusion paths␊ - */␊ - clientCertExclusionPaths?: string␊ - /**␊ - * This composes with ClientCertEnabled setting.␊ - * - ClientCertEnabled: false means ClientCert is ignored.␊ - * - ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required.␊ - * - ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted.␊ - */␊ - clientCertMode?: (("Required" | "Optional") | string)␊ - /**␊ - * Information needed for cloning operation.␊ - */␊ - cloningInfo?: (CloningInfo6 | string)␊ - /**␊ - * Size of the function container.␊ - */␊ - containerSize?: (number | string)␊ - /**␊ - * Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification.␊ - */␊ - customDomainVerificationId?: string␊ - /**␊ - * Maximum allowed daily memory-time quota (applicable on dynamic apps only).␊ - */␊ - dailyMemoryTimeQuota?: (number | string)␊ - /**␊ - * true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Specification for an App Service Environment to use for this resource.␊ - */␊ - hostingEnvironmentProfile?: (HostingEnvironmentProfile7 | string)␊ - /**␊ - * true to disable the public hostnames of the app; otherwise, false.␊ - * If true, the app is only accessible via API management process.␊ - */␊ - hostNamesDisabled?: (boolean | string)␊ - /**␊ - * Hostname SSL states are used to manage the SSL bindings for app's hostnames.␊ - */␊ - hostNameSslStates?: (HostNameSslState6[] | string)␊ - /**␊ - * HttpsOnly: configures a web site to accept only https requests. Issues redirect for␊ - * http requests␊ - */␊ - httpsOnly?: (boolean | string)␊ - /**␊ - * Hyper-V sandbox.␊ - */␊ - hyperV?: (boolean | string)␊ - /**␊ - * Obsolete: Hyper-V sandbox.␊ - */␊ - isXenon?: (boolean | string)␊ - /**␊ - * Site redundancy mode.␊ - */␊ - redundancyMode?: (("None" | "Manual" | "Failover" | "ActiveActive" | "GeoRedundant") | string)␊ - /**␊ - * true if reserved; otherwise, false.␊ - */␊ - reserved?: (boolean | string)␊ - /**␊ - * true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.␊ - */␊ - scmSiteAlsoStopped?: (boolean | string)␊ - /**␊ - * Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".␊ - */␊ - serverFarmId?: string␊ - /**␊ - * Configuration of an App Service app.␊ - */␊ - siteConfig?: (SiteConfig6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information needed for cloning operation.␊ - */␊ - export interface CloningInfo6 {␊ - /**␊ - * 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.␊ - */␊ - appSettingsOverrides?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * true to clone custom hostnames from source app; otherwise, false.␊ - */␊ - cloneCustomHostNames?: (boolean | string)␊ - /**␊ - * true to clone source control from source app; otherwise, false.␊ - */␊ - cloneSourceControl?: (boolean | string)␊ - /**␊ - * true to configure load balancing for source and destination app.␊ - */␊ - configureLoadBalancing?: (boolean | string)␊ - /**␊ - * Correlation ID of cloning operation. This ID ties multiple cloning operations␊ - * together to use the same snapshot.␊ - */␊ - correlationId?: string␊ - /**␊ - * App Service Environment.␊ - */␊ - hostingEnvironment?: string␊ - /**␊ - * true to overwrite destination app; otherwise, false.␊ - */␊ - overwrite?: (boolean | string)␊ - /**␊ - * 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.␊ - */␊ - sourceWebAppId: string␊ - /**␊ - * Location of source app ex: West US or North Europe␊ - */␊ - sourceWebAppLocation?: string␊ - /**␊ - * 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}.␊ - */␊ - trafficManagerProfileId?: string␊ - /**␊ - * Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist.␊ - */␊ - trafficManagerProfileName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSL-enabled hostname.␊ - */␊ - export interface HostNameSslState6 {␊ - /**␊ - * Indicates whether the hostname is a standard or repository hostname.␊ - */␊ - hostType?: (("Standard" | "Repository") | string)␊ - /**␊ - * Hostname.␊ - */␊ - name?: string␊ - /**␊ - * SSL type.␊ - */␊ - sslState?: (("Disabled" | "SniEnabled" | "IpBasedEnabled") | string)␊ - /**␊ - * SSL certificate thumbprint.␊ - */␊ - thumbprint?: string␊ - /**␊ - * Set to true to update existing hostname.␊ - */␊ - toUpdate?: (boolean | string)␊ - /**␊ - * Virtual IP address assigned to the hostname if IP based SSL is enabled.␊ - */␊ - virtualIP?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Configuration of an App Service app.␊ - */␊ - export interface SiteConfig6 {␊ - /**␊ - * Flag to use Managed Identity Creds for ACR pull␊ - */␊ - acrUseManagedIdentityCreds?: (boolean | string)␊ - /**␊ - * If using user managed identity, the user managed identity ClientId␊ - */␊ - acrUserManagedIdentityID?: string␊ - /**␊ - * true if Always On is enabled; otherwise, false.␊ - */␊ - alwaysOn?: (boolean | string)␊ - /**␊ - * Information about the formal API definition for the app.␊ - */␊ - apiDefinition?: (ApiDefinitionInfo6 | string)␊ - /**␊ - * Azure API management (APIM) configuration linked to the app.␊ - */␊ - apiManagementConfig?: (ApiManagementConfig2 | string)␊ - /**␊ - * App command line to launch.␊ - */␊ - appCommandLine?: string␊ - /**␊ - * Application settings.␊ - */␊ - appSettings?: (NameValuePair7[] | string)␊ - /**␊ - * true if Auto Heal is enabled; otherwise, false.␊ - */␊ - autoHealEnabled?: (boolean | string)␊ - /**␊ - * Rules that can be defined for auto-heal.␊ - */␊ - autoHealRules?: (AutoHealRules6 | string)␊ - /**␊ - * Auto-swap slot name.␊ - */␊ - autoSwapSlotName?: string␊ - /**␊ - * Connection strings.␊ - */␊ - connectionStrings?: (ConnStringInfo6[] | string)␊ - /**␊ - * Cross-Origin Resource Sharing (CORS) settings for the app.␊ - */␊ - cors?: (CorsSettings6 | string)␊ - /**␊ - * Default documents.␊ - */␊ - defaultDocuments?: (string[] | string)␊ - /**␊ - * true if detailed error logging is enabled; otherwise, false.␊ - */␊ - detailedErrorLoggingEnabled?: (boolean | string)␊ - /**␊ - * Document root.␊ - */␊ - documentRoot?: string␊ - /**␊ - * Routing rules in production experiments.␊ - */␊ - experiments?: (Experiments6 | string)␊ - /**␊ - * State of FTP / FTPS service.␊ - */␊ - ftpsState?: (("AllAllowed" | "FtpsOnly" | "Disabled") | string)␊ - /**␊ - * Handler mappings.␊ - */␊ - handlerMappings?: (HandlerMapping6[] | string)␊ - /**␊ - * Health check path␊ - */␊ - healthCheckPath?: string␊ - /**␊ - * Http20Enabled: configures a web site to allow clients to connect over http2.0␊ - */␊ - http20Enabled?: (boolean | string)␊ - /**␊ - * true if HTTP logging is enabled; otherwise, false.␊ - */␊ - httpLoggingEnabled?: (boolean | string)␊ - /**␊ - * IP security restrictions for main.␊ - */␊ - ipSecurityRestrictions?: (IpSecurityRestriction6[] | string)␊ - /**␊ - * Java container.␊ - */␊ - javaContainer?: string␊ - /**␊ - * Java container version.␊ - */␊ - javaContainerVersion?: string␊ - /**␊ - * Java version.␊ - */␊ - javaVersion?: string␊ - /**␊ - * Metric limits set on an app.␊ - */␊ - limits?: (SiteLimits6 | string)␊ - /**␊ - * Linux App Framework and version␊ - */␊ - linuxFxVersion?: string␊ - /**␊ - * Site load balancing.␊ - */␊ - loadBalancing?: (("WeightedRoundRobin" | "LeastRequests" | "LeastResponseTime" | "WeightedTotalTraffic" | "RequestHash") | string)␊ - /**␊ - * true to enable local MySQL; otherwise, false.␊ - */␊ - localMySqlEnabled?: (boolean | string)␊ - /**␊ - * HTTP logs directory size limit.␊ - */␊ - logsDirectorySizeLimit?: (number | string)␊ - /**␊ - * Managed pipeline mode.␊ - */␊ - managedPipelineMode?: (("Integrated" | "Classic") | string)␊ - /**␊ - * Managed Service Identity Id␊ - */␊ - managedServiceIdentityId?: (number | string)␊ - /**␊ - * MinTlsVersion: configures the minimum version of TLS required for SSL requests.␊ - */␊ - minTlsVersion?: (("1.0" | "1.1" | "1.2") | string)␊ - /**␊ - * .NET Framework version.␊ - */␊ - netFrameworkVersion?: string␊ - /**␊ - * Version of Node.js.␊ - */␊ - nodeVersion?: string␊ - /**␊ - * Number of workers.␊ - */␊ - numberOfWorkers?: (number | string)␊ - /**␊ - * Version of PHP.␊ - */␊ - phpVersion?: string␊ - /**␊ - * Version of PowerShell.␊ - */␊ - powerShellVersion?: string␊ - /**␊ - * Number of preWarmed instances.␊ - * This setting only applies to the Consumption and Elastic Plans␊ - */␊ - preWarmedInstanceCount?: (number | string)␊ - /**␊ - * Publishing user name.␊ - */␊ - publishingUsername?: string␊ - /**␊ - * Push settings for the App.␊ - */␊ - push?: (PushSettings5 | string)␊ - /**␊ - * Version of Python.␊ - */␊ - pythonVersion?: string␊ - /**␊ - * true if remote debugging is enabled; otherwise, false.␊ - */␊ - remoteDebuggingEnabled?: (boolean | string)␊ - /**␊ - * Remote debugging version.␊ - */␊ - remoteDebuggingVersion?: string␊ - /**␊ - * true if request tracing is enabled; otherwise, false.␊ - */␊ - requestTracingEnabled?: (boolean | string)␊ - /**␊ - * Request tracing expiration time.␊ - */␊ - requestTracingExpirationTime?: string␊ - /**␊ - * IP security restrictions for scm.␊ - */␊ - scmIpSecurityRestrictions?: (IpSecurityRestriction6[] | string)␊ - /**␊ - * IP security restrictions for scm to use main.␊ - */␊ - scmIpSecurityRestrictionsUseMain?: (boolean | string)␊ - /**␊ - * ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site.␊ - */␊ - scmMinTlsVersion?: (("1.0" | "1.1" | "1.2") | string)␊ - /**␊ - * SCM type.␊ - */␊ - scmType?: (("None" | "Dropbox" | "Tfs" | "LocalGit" | "GitHub" | "CodePlexGit" | "CodePlexHg" | "BitbucketGit" | "BitbucketHg" | "ExternalGit" | "ExternalHg" | "OneDrive" | "VSO" | "VSTSRM") | string)␊ - /**␊ - * Tracing options.␊ - */␊ - tracingOptions?: string␊ - /**␊ - * true to use 32-bit worker process; otherwise, false.␊ - */␊ - use32BitWorkerProcess?: (boolean | string)␊ - /**␊ - * Virtual applications.␊ - */␊ - virtualApplications?: (VirtualApplication6[] | string)␊ - /**␊ - * Virtual Network name.␊ - */␊ - vnetName?: string␊ - /**␊ - * The number of private ports assigned to this app. These will be assigned dynamically on runtime.␊ - */␊ - vnetPrivatePortsCount?: (number | string)␊ - /**␊ - * Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied.␊ - */␊ - vnetRouteAllEnabled?: (boolean | string)␊ - /**␊ - * true if WebSocket is enabled; otherwise, false.␊ - */␊ - webSocketsEnabled?: (boolean | string)␊ - /**␊ - * Xenon App Framework and version␊ - */␊ - windowsFxVersion?: string␊ - /**␊ - * Explicit Managed Service Identity Id␊ - */␊ - xManagedServiceIdentityId?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the formal API definition for the app.␊ - */␊ - export interface ApiDefinitionInfo6 {␊ - /**␊ - * The URL of the API definition.␊ - */␊ - url?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure API management (APIM) configuration linked to the app.␊ - */␊ - export interface ApiManagementConfig2 {␊ - /**␊ - * APIM-Api Identifier.␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Rules that can be defined for auto-heal.␊ - */␊ - export interface AutoHealRules6 {␊ - /**␊ - * Actions which to take by the auto-heal module when a rule is triggered.␊ - */␊ - actions?: (AutoHealActions6 | string)␊ - /**␊ - * Triggers for auto-heal.␊ - */␊ - triggers?: (AutoHealTriggers6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Actions which to take by the auto-heal module when a rule is triggered.␊ - */␊ - export interface AutoHealActions6 {␊ - /**␊ - * Predefined action to be taken.␊ - */␊ - actionType?: (("Recycle" | "LogEvent" | "CustomAction") | string)␊ - /**␊ - * Custom action to be executed␊ - * when an auto heal rule is triggered.␊ - */␊ - customAction?: (AutoHealCustomAction6 | string)␊ - /**␊ - * Minimum time the process must execute␊ - * before taking the action␊ - */␊ - minProcessExecutionTime?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Custom action to be executed␊ - * when an auto heal rule is triggered.␊ - */␊ - export interface AutoHealCustomAction6 {␊ - /**␊ - * Executable to be run.␊ - */␊ - exe?: string␊ - /**␊ - * Parameters for the executable.␊ - */␊ - parameters?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Triggers for auto-heal.␊ - */␊ - export interface AutoHealTriggers6 {␊ - /**␊ - * A rule based on private bytes.␊ - */␊ - privateBytesInKB?: (number | string)␊ - /**␊ - * Trigger based on total requests.␊ - */␊ - requests?: (RequestsBasedTrigger6 | string)␊ - /**␊ - * Trigger based on request execution time.␊ - */␊ - slowRequests?: (SlowRequestsBasedTrigger6 | string)␊ - /**␊ - * A rule based on status codes.␊ - */␊ - statusCodes?: (StatusCodesBasedTrigger6[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trigger based on total requests.␊ - */␊ - export interface RequestsBasedTrigger6 {␊ - /**␊ - * Request Count.␊ - */␊ - count?: (number | string)␊ - /**␊ - * Time interval.␊ - */␊ - timeInterval?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trigger based on request execution time.␊ - */␊ - export interface SlowRequestsBasedTrigger6 {␊ - /**␊ - * Request Count.␊ - */␊ - count?: (number | string)␊ - /**␊ - * Time interval.␊ - */␊ - timeInterval?: string␊ - /**␊ - * Time taken.␊ - */␊ - timeTaken?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trigger based on status code.␊ - */␊ - export interface StatusCodesBasedTrigger6 {␊ - /**␊ - * Request Count.␊ - */␊ - count?: (number | string)␊ - /**␊ - * HTTP status code.␊ - */␊ - status?: (number | string)␊ - /**␊ - * Request Sub Status.␊ - */␊ - subStatus?: (number | string)␊ - /**␊ - * Time interval.␊ - */␊ - timeInterval?: string␊ - /**␊ - * Win32 error code.␊ - */␊ - win32Status?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Database connection string information.␊ - */␊ - export interface ConnStringInfo6 {␊ - /**␊ - * Connection string value.␊ - */␊ - connectionString?: string␊ - /**␊ - * Name of connection string.␊ - */␊ - name?: string␊ - /**␊ - * Type of database.␊ - */␊ - type?: (("MySql" | "SQLServer" | "SQLAzure" | "Custom" | "NotificationHub" | "ServiceBus" | "EventHub" | "ApiHub" | "DocDb" | "RedisCache" | "PostgreSQL") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Cross-Origin Resource Sharing (CORS) settings for the app.␊ - */␊ - export interface CorsSettings6 {␊ - /**␊ - * 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.␊ - */␊ - allowedOrigins?: (string[] | string)␊ - /**␊ - * Gets or sets whether CORS requests with credentials are allowed. See ␊ - * https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials␊ - * for more details.␊ - */␊ - supportCredentials?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Routing rules in production experiments.␊ - */␊ - export interface Experiments6 {␊ - /**␊ - * List of ramp-up rules.␊ - */␊ - rampUpRules?: (RampUpRule6[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance.␊ - */␊ - export interface RampUpRule6 {␊ - /**␊ - * Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.␊ - */␊ - actionHostName?: string␊ - /**␊ - * 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/␊ - */␊ - changeDecisionCallbackUrl?: string␊ - /**␊ - * Specifies interval in minutes to reevaluate ReroutePercentage.␊ - */␊ - changeIntervalInMinutes?: (number | string)␊ - /**␊ - * In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \\nMinReroutePercentage or ␊ - * MaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\\nCustom decision algorithm ␊ - * can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl.␊ - */␊ - changeStep?: (number | string)␊ - /**␊ - * Specifies upper boundary below which ReroutePercentage will stay.␊ - */␊ - maxReroutePercentage?: (number | string)␊ - /**␊ - * Specifies lower boundary above which ReroutePercentage will stay.␊ - */␊ - minReroutePercentage?: (number | string)␊ - /**␊ - * Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment.␊ - */␊ - name?: string␊ - /**␊ - * Percentage of the traffic which will be redirected to ActionHostName.␊ - */␊ - reroutePercentage?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * 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.␊ - */␊ - export interface HandlerMapping6 {␊ - /**␊ - * Command-line arguments to be passed to the script processor.␊ - */␊ - arguments?: string␊ - /**␊ - * Requests with this extension will be handled using the specified FastCGI application.␊ - */␊ - extension?: string␊ - /**␊ - * The absolute path to the FastCGI application.␊ - */␊ - scriptProcessor?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP security restriction on an app.␊ - */␊ - export interface IpSecurityRestriction6 {␊ - /**␊ - * Allow or Deny access for this IP range.␊ - */␊ - action?: string␊ - /**␊ - * IP restriction rule description.␊ - */␊ - description?: string␊ - /**␊ - * IP restriction rule headers.␊ - * X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). ␊ - * The matching logic is ..␊ - * - If the property is null or empty (default), all hosts(or lack of) are allowed.␊ - * - A value is compared using ordinal-ignore-case (excluding port number).␊ - * - Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com␊ - * but not the root domain contoso.com or multi-level foo.bar.contoso.com␊ - * - Unicode host names are allowed but are converted to Punycode for matching.␊ - * ␊ - * X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples).␊ - * The matching logic is ..␊ - * - If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed.␊ - * - If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property.␊ - * ␊ - * X-Azure-FDID and X-FD-HealthProbe.␊ - * The matching logic is exact match.␊ - */␊ - headers?: ({␊ - [k: string]: string[]␊ - } | string)␊ - /**␊ - * IP address the security restriction is valid for.␊ - * It can be in form of pure ipv4 address (required SubnetMask property) or␊ - * CIDR notation such as ipv4/mask (leading bit match). For CIDR,␊ - * SubnetMask property must not be specified.␊ - */␊ - ipAddress?: string␊ - /**␊ - * IP restriction rule name.␊ - */␊ - name?: string␊ - /**␊ - * Priority of IP restriction rule.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * Subnet mask for the range of IP addresses the restriction is valid for.␊ - */␊ - subnetMask?: string␊ - /**␊ - * (internal) Subnet traffic tag␊ - */␊ - subnetTrafficTag?: (number | string)␊ - /**␊ - * Defines what this IP filter will be used for. This is to support IP filtering on proxies.␊ - */␊ - tag?: (("Default" | "XffProxy" | "ServiceTag") | string)␊ - /**␊ - * Virtual network resource id␊ - */␊ - vnetSubnetResourceId?: string␊ - /**␊ - * (internal) Vnet traffic tag␊ - */␊ - vnetTrafficTag?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Metric limits set on an app.␊ - */␊ - export interface SiteLimits6 {␊ - /**␊ - * Maximum allowed disk size usage in MB.␊ - */␊ - maxDiskSizeInMb?: (number | string)␊ - /**␊ - * Maximum allowed memory usage in MB.␊ - */␊ - maxMemoryInMb?: (number | string)␊ - /**␊ - * Maximum allowed CPU usage percentage.␊ - */␊ - maxPercentageCpu?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Push settings for the App.␊ - */␊ - export interface PushSettings5 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * PushSettings resource specific properties␊ - */␊ - properties?: (PushSettingsProperties5 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * PushSettings resource specific properties␊ - */␊ - export interface PushSettingsProperties5 {␊ - /**␊ - * Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint.␊ - */␊ - dynamicTagsJson?: string␊ - /**␊ - * Gets or sets a flag indicating whether the Push endpoint is enabled.␊ - */␊ - isPushEnabled: (boolean | string)␊ - /**␊ - * 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.␊ - */␊ - tagsRequiringAuth?: string␊ - /**␊ - * Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.␊ - */␊ - tagWhitelistJson?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Virtual application in an app.␊ - */␊ - export interface VirtualApplication6 {␊ - /**␊ - * Physical path.␊ - */␊ - physicalPath?: string␊ - /**␊ - * true if preloading is enabled; otherwise, false.␊ - */␊ - preloadEnabled?: (boolean | string)␊ - /**␊ - * Virtual directories for virtual application.␊ - */␊ - virtualDirectories?: (VirtualDirectory6[] | string)␊ - /**␊ - * Virtual path.␊ - */␊ - virtualPath?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Directory for virtual application.␊ - */␊ - export interface VirtualDirectory6 {␊ - /**␊ - * Physical path.␊ - */␊ - physicalPath?: string␊ - /**␊ - * Path to virtual application.␊ - */␊ - virtualPath?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * CsmPublishingCredentialsPoliciesEntity resource specific properties␊ - */␊ - export interface CsmPublishingCredentialsPoliciesEntityProperties2 {␊ - /**␊ - * true to allow access to a publishing method; otherwise, false.␊ - */␊ - allow: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SiteAuthSettings resource specific properties␊ - */␊ - export interface SiteAuthSettingsProperties5 {␊ - /**␊ - * Gets a JSON string containing the Azure AD Acl settings.␊ - */␊ - aadClaimsAuthorization?: string␊ - /**␊ - * Login parameters to send to the OpenID Connect authorization endpoint when␊ - * a user logs in. Each parameter must be in the form "key=value".␊ - */␊ - additionalLoginParams?: (string[] | string)␊ - /**␊ - * 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.␊ - */␊ - allowedAudiences?: (string[] | string)␊ - /**␊ - * 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.␊ - */␊ - allowedExternalRedirectUrls?: (string[] | string)␊ - /**␊ - * The path of the config file containing auth settings.␊ - * If the path is relative, base will the site's root directory.␊ - */␊ - authFilePath?: string␊ - /**␊ - * 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␊ - */␊ - clientId?: string␊ - /**␊ - * 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␊ - */␊ - clientSecret?: string␊ - /**␊ - * An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as␊ - * a replacement for the Client Secret. It is also optional.␊ - */␊ - clientSecretCertificateThumbprint?: string␊ - /**␊ - * The app setting name that contains the client secret of the relying party application.␊ - */␊ - clientSecretSettingName?: string␊ - /**␊ - * 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".␊ - */␊ - defaultProvider?: (("AzureActiveDirectory" | "Facebook" | "Google" | "MicrosoftAccount" | "Twitter" | "Github") | string)␊ - /**␊ - * true if the Authentication / Authorization feature is enabled for the current app; otherwise, false.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * 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␊ - */␊ - facebookAppId?: string␊ - /**␊ - * 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␊ - */␊ - facebookAppSecret?: string␊ - /**␊ - * The app setting name that contains the app secret used for Facebook Login.␊ - */␊ - facebookAppSecretSettingName?: string␊ - /**␊ - * 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␊ - */␊ - facebookOAuthScopes?: (string[] | string)␊ - /**␊ - * The Client Id of the GitHub app used for login.␊ - * This setting is required for enabling Github login␊ - */␊ - gitHubClientId?: string␊ - /**␊ - * The Client Secret of the GitHub app used for Github Login.␊ - * This setting is required for enabling Github login.␊ - */␊ - gitHubClientSecret?: string␊ - /**␊ - * The app setting name that contains the client secret of the Github␊ - * app used for GitHub Login.␊ - */␊ - gitHubClientSecretSettingName?: string␊ - /**␊ - * The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication.␊ - * This setting is optional␊ - */␊ - gitHubOAuthScopes?: (string[] | string)␊ - /**␊ - * 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/␊ - */␊ - googleClientId?: string␊ - /**␊ - * 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/␊ - */␊ - googleClientSecret?: string␊ - /**␊ - * The app setting name that contains the client secret associated with ␊ - * the Google web application.␊ - */␊ - googleClientSecretSettingName?: string␊ - /**␊ - * 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/␊ - */␊ - googleOAuthScopes?: (string[] | string)␊ - /**␊ - * "true" if the auth config settings should be read from a file,␊ - * "false" otherwise␊ - */␊ - isAuthFromFile?: string␊ - /**␊ - * 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␊ - */␊ - issuer?: string␊ - /**␊ - * 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␊ - */␊ - microsoftAccountClientId?: string␊ - /**␊ - * 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␊ - */␊ - microsoftAccountClientSecret?: string␊ - /**␊ - * The app setting name containing the OAuth 2.0 client secret that was created for the␊ - * app used for authentication.␊ - */␊ - microsoftAccountClientSecretSettingName?: string␊ - /**␊ - * 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␊ - */␊ - microsoftAccountOAuthScopes?: (string[] | string)␊ - /**␊ - * 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.␊ - */␊ - runtimeVersion?: string␊ - /**␊ - * 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.␊ - */␊ - tokenRefreshExtensionHours?: (number | string)␊ - /**␊ - * true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.␊ - * The default is false.␊ - */␊ - tokenStoreEnabled?: (boolean | string)␊ - /**␊ - * 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␊ - */␊ - twitterConsumerKey?: string␊ - /**␊ - * 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␊ - */␊ - twitterConsumerSecret?: string␊ - /**␊ - * The app setting name that contains the OAuth 1.0a consumer secret of the Twitter␊ - * application used for sign-in.␊ - */␊ - twitterConsumerSecretSettingName?: string␊ - /**␊ - * The action to take when an unauthenticated client attempts to access the app.␊ - */␊ - unauthenticatedClientAction?: (("RedirectToLoginPage" | "AllowAnonymous") | string)␊ - /**␊ - * Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such.␊ - */␊ - validateIssuer?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SiteAuthSettingsV2 resource specific properties␊ - */␊ - export interface SiteAuthSettingsV2Properties1 {␊ - globalValidation?: (GlobalValidation1 | string)␊ - httpSettings?: (HttpSettings1 | string)␊ - identityProviders?: (IdentityProviders1 | string)␊ - login?: (Login1 | string)␊ - platform?: (AuthPlatform1 | string)␊ - [k: string]: unknown␊ - }␊ - export interface GlobalValidation1 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * GlobalValidation resource specific properties␊ - */␊ - properties?: (GlobalValidationProperties1 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * GlobalValidation resource specific properties␊ - */␊ - export interface GlobalValidationProperties1 {␊ - excludedPaths?: (string[] | string)␊ - redirectToProvider?: string␊ - requireAuthentication?: (boolean | string)␊ - unauthenticatedClientAction?: (("RedirectToLoginPage" | "AllowAnonymous" | "Return401" | "Return403") | string)␊ - [k: string]: unknown␊ - }␊ - export interface HttpSettings1 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * HttpSettings resource specific properties␊ - */␊ - properties?: (HttpSettingsProperties1 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HttpSettings resource specific properties␊ - */␊ - export interface HttpSettingsProperties1 {␊ - forwardProxy?: (ForwardProxy1 | string)␊ - requireHttps?: (boolean | string)␊ - routes?: (HttpSettingsRoutes1 | string)␊ - [k: string]: unknown␊ - }␊ - export interface ForwardProxy1 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * ForwardProxy resource specific properties␊ - */␊ - properties?: (ForwardProxyProperties1 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ForwardProxy resource specific properties␊ - */␊ - export interface ForwardProxyProperties1 {␊ - convention?: (("NoProxy" | "Standard" | "Custom") | string)␊ - customHostHeaderName?: string␊ - customProtoHeaderName?: string␊ - [k: string]: unknown␊ - }␊ - export interface HttpSettingsRoutes1 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * HttpSettingsRoutes resource specific properties␊ - */␊ - properties?: (HttpSettingsRoutesProperties1 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HttpSettingsRoutes resource specific properties␊ - */␊ - export interface HttpSettingsRoutesProperties1 {␊ - apiPrefix?: string␊ - [k: string]: unknown␊ - }␊ - export interface IdentityProviders1 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * IdentityProviders resource specific properties␊ - */␊ - properties?: (IdentityProvidersProperties1 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IdentityProviders resource specific properties␊ - */␊ - export interface IdentityProvidersProperties1 {␊ - azureActiveDirectory?: (AzureActiveDirectory6 | string)␊ - customOpenIdConnectProviders?: ({␊ - [k: string]: CustomOpenIdConnectProvider1␊ - } | string)␊ - facebook?: (Facebook1 | string)␊ - gitHub?: (GitHub1 | string)␊ - google?: (Google1 | string)␊ - twitter?: (Twitter1 | string)␊ - [k: string]: unknown␊ - }␊ - export interface AzureActiveDirectory6 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * AzureActiveDirectory resource specific properties␊ - */␊ - properties?: (AzureActiveDirectoryProperties1 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AzureActiveDirectory resource specific properties␊ - */␊ - export interface AzureActiveDirectoryProperties1 {␊ - enabled?: (boolean | string)␊ - isAutoProvisioned?: (boolean | string)␊ - login?: (AzureActiveDirectoryLogin1 | string)␊ - registration?: (AzureActiveDirectoryRegistration1 | string)␊ - validation?: (AzureActiveDirectoryValidation1 | string)␊ - [k: string]: unknown␊ - }␊ - export interface AzureActiveDirectoryLogin1 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * AzureActiveDirectoryLogin resource specific properties␊ - */␊ - properties?: (AzureActiveDirectoryLoginProperties1 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AzureActiveDirectoryLogin resource specific properties␊ - */␊ - export interface AzureActiveDirectoryLoginProperties1 {␊ - disableWWWAuthenticate?: (boolean | string)␊ - loginParameters?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - export interface AzureActiveDirectoryRegistration1 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * AzureActiveDirectoryRegistration resource specific properties␊ - */␊ - properties?: (AzureActiveDirectoryRegistrationProperties1 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AzureActiveDirectoryRegistration resource specific properties␊ - */␊ - export interface AzureActiveDirectoryRegistrationProperties1 {␊ - clientId?: string␊ - clientSecretCertificateThumbprint?: string␊ - clientSecretSettingName?: string␊ - openIdIssuer?: string␊ - [k: string]: unknown␊ - }␊ - export interface AzureActiveDirectoryValidation1 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * AzureActiveDirectoryValidation resource specific properties␊ - */␊ - properties?: (AzureActiveDirectoryValidationProperties1 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AzureActiveDirectoryValidation resource specific properties␊ - */␊ - export interface AzureActiveDirectoryValidationProperties1 {␊ - allowedAudiences?: (string[] | string)␊ - jwtClaimChecks?: (JwtClaimChecks1 | string)␊ - [k: string]: unknown␊ - }␊ - export interface JwtClaimChecks1 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * JwtClaimChecks resource specific properties␊ - */␊ - properties?: (JwtClaimChecksProperties1 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * JwtClaimChecks resource specific properties␊ - */␊ - export interface JwtClaimChecksProperties1 {␊ - allowedClientApplications?: (string[] | string)␊ - allowedGroups?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - export interface CustomOpenIdConnectProvider1 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * CustomOpenIdConnectProvider resource specific properties␊ - */␊ - properties?: (CustomOpenIdConnectProviderProperties1 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * CustomOpenIdConnectProvider resource specific properties␊ - */␊ - export interface CustomOpenIdConnectProviderProperties1 {␊ - enabled?: (boolean | string)␊ - login?: (OpenIdConnectLogin1 | string)␊ - registration?: (OpenIdConnectRegistration1 | string)␊ - [k: string]: unknown␊ - }␊ - export interface OpenIdConnectLogin1 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * OpenIdConnectLogin resource specific properties␊ - */␊ - properties?: (OpenIdConnectLoginProperties1 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * OpenIdConnectLogin resource specific properties␊ - */␊ - export interface OpenIdConnectLoginProperties1 {␊ - nameClaimType?: string␊ - scopes?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - export interface OpenIdConnectRegistration1 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * OpenIdConnectRegistration resource specific properties␊ - */␊ - properties?: (OpenIdConnectRegistrationProperties1 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * OpenIdConnectRegistration resource specific properties␊ - */␊ - export interface OpenIdConnectRegistrationProperties1 {␊ - clientCredential?: (OpenIdConnectClientCredential1 | string)␊ - clientId?: string␊ - openIdConnectConfiguration?: (OpenIdConnectConfig1 | string)␊ - [k: string]: unknown␊ - }␊ - export interface OpenIdConnectClientCredential1 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * OpenIdConnectClientCredential resource specific properties␊ - */␊ - properties?: (OpenIdConnectClientCredentialProperties1 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * OpenIdConnectClientCredential resource specific properties␊ - */␊ - export interface OpenIdConnectClientCredentialProperties1 {␊ - clientSecretSettingName?: string␊ - method?: ("ClientSecretPost" | string)␊ - [k: string]: unknown␊ - }␊ - export interface OpenIdConnectConfig1 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * OpenIdConnectConfig resource specific properties␊ - */␊ - properties?: (OpenIdConnectConfigProperties1 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * OpenIdConnectConfig resource specific properties␊ - */␊ - export interface OpenIdConnectConfigProperties1 {␊ - authorizationEndpoint?: string␊ - certificationUri?: string␊ - issuer?: string␊ - tokenEndpoint?: string␊ - wellKnownOpenIdConfiguration?: string␊ - [k: string]: unknown␊ - }␊ - export interface Facebook1 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Facebook resource specific properties␊ - */␊ - properties?: (FacebookProperties1 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Facebook resource specific properties␊ - */␊ - export interface FacebookProperties1 {␊ - enabled?: (boolean | string)␊ - graphApiVersion?: string␊ - login?: (LoginScopes1 | string)␊ - registration?: (AppRegistration1 | string)␊ - [k: string]: unknown␊ - }␊ - export interface LoginScopes1 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * LoginScopes resource specific properties␊ - */␊ - properties?: (LoginScopesProperties1 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * LoginScopes resource specific properties␊ - */␊ - export interface LoginScopesProperties1 {␊ - scopes?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - export interface AppRegistration1 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * AppRegistration resource specific properties␊ - */␊ - properties?: (AppRegistrationProperties1 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AppRegistration resource specific properties␊ - */␊ - export interface AppRegistrationProperties1 {␊ - appId?: string␊ - appSecretSettingName?: string␊ - [k: string]: unknown␊ - }␊ - export interface GitHub1 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * GitHub resource specific properties␊ - */␊ - properties?: (GitHubProperties1 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * GitHub resource specific properties␊ - */␊ - export interface GitHubProperties1 {␊ - enabled?: (boolean | string)␊ - login?: (LoginScopes1 | string)␊ - registration?: (ClientRegistration1 | string)␊ - [k: string]: unknown␊ - }␊ - export interface ClientRegistration1 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * ClientRegistration resource specific properties␊ - */␊ - properties?: (ClientRegistrationProperties1 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ClientRegistration resource specific properties␊ - */␊ - export interface ClientRegistrationProperties1 {␊ - clientId?: string␊ - clientSecretSettingName?: string␊ - [k: string]: unknown␊ - }␊ - export interface Google1 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Google resource specific properties␊ - */␊ - properties?: (GoogleProperties1 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Google resource specific properties␊ - */␊ - export interface GoogleProperties1 {␊ - enabled?: (boolean | string)␊ - login?: (LoginScopes1 | string)␊ - registration?: (ClientRegistration1 | string)␊ - validation?: (AllowedAudiencesValidation1 | string)␊ - [k: string]: unknown␊ - }␊ - export interface AllowedAudiencesValidation1 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * AllowedAudiencesValidation resource specific properties␊ - */␊ - properties?: (AllowedAudiencesValidationProperties1 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AllowedAudiencesValidation resource specific properties␊ - */␊ - export interface AllowedAudiencesValidationProperties1 {␊ - allowedAudiences?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - export interface Twitter1 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Twitter resource specific properties␊ - */␊ - properties?: (TwitterProperties1 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Twitter resource specific properties␊ - */␊ - export interface TwitterProperties1 {␊ - enabled?: (boolean | string)␊ - registration?: (TwitterRegistration1 | string)␊ - [k: string]: unknown␊ - }␊ - export interface TwitterRegistration1 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * TwitterRegistration resource specific properties␊ - */␊ - properties?: (TwitterRegistrationProperties1 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * TwitterRegistration resource specific properties␊ - */␊ - export interface TwitterRegistrationProperties1 {␊ - consumerKey?: string␊ - consumerSecretSettingName?: string␊ - [k: string]: unknown␊ - }␊ - export interface Login1 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Login resource specific properties␊ - */␊ - properties?: (LoginProperties1 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Login resource specific properties␊ - */␊ - export interface LoginProperties1 {␊ - allowedExternalRedirectUrls?: (string[] | string)␊ - cookieExpiration?: (CookieExpiration1 | string)␊ - nonce?: (Nonce1 | string)␊ - preserveUrlFragmentsForLogins?: (boolean | string)␊ - routes?: (LoginRoutes1 | string)␊ - tokenStore?: (TokenStore1 | string)␊ - [k: string]: unknown␊ - }␊ - export interface CookieExpiration1 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * CookieExpiration resource specific properties␊ - */␊ - properties?: (CookieExpirationProperties1 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * CookieExpiration resource specific properties␊ - */␊ - export interface CookieExpirationProperties1 {␊ - convention?: (("FixedTime" | "IdentityProviderDerived") | string)␊ - timeToExpiration?: string␊ - [k: string]: unknown␊ - }␊ - export interface Nonce1 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Nonce resource specific properties␊ - */␊ - properties?: (NonceProperties1 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Nonce resource specific properties␊ - */␊ - export interface NonceProperties1 {␊ - nonceExpirationInterval?: string␊ - validateNonce?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - export interface LoginRoutes1 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * LoginRoutes resource specific properties␊ - */␊ - properties?: (LoginRoutesProperties1 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * LoginRoutes resource specific properties␊ - */␊ - export interface LoginRoutesProperties1 {␊ - logoutEndpoint?: string␊ - [k: string]: unknown␊ - }␊ - export interface TokenStore1 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * TokenStore resource specific properties␊ - */␊ - properties?: (TokenStoreProperties1 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * TokenStore resource specific properties␊ - */␊ - export interface TokenStoreProperties1 {␊ - azureBlobStorage?: (BlobStorageTokenStore1 | string)␊ - enabled?: (boolean | string)␊ - fileSystem?: (FileSystemTokenStore1 | string)␊ - tokenRefreshExtensionHours?: (number | string)␊ - [k: string]: unknown␊ - }␊ - export interface BlobStorageTokenStore1 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * BlobStorageTokenStore resource specific properties␊ - */␊ - properties?: (BlobStorageTokenStoreProperties1 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * BlobStorageTokenStore resource specific properties␊ - */␊ - export interface BlobStorageTokenStoreProperties1 {␊ - sasUrlSettingName?: string␊ - [k: string]: unknown␊ - }␊ - export interface FileSystemTokenStore1 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * FileSystemTokenStore resource specific properties␊ - */␊ - properties?: (FileSystemTokenStoreProperties1 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * FileSystemTokenStore resource specific properties␊ - */␊ - export interface FileSystemTokenStoreProperties1 {␊ - directory?: string␊ - [k: string]: unknown␊ - }␊ - export interface AuthPlatform1 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * AuthPlatform resource specific properties␊ - */␊ - properties?: (AuthPlatformProperties1 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AuthPlatform resource specific properties␊ - */␊ - export interface AuthPlatformProperties1 {␊ - configFilePath?: string␊ - enabled?: (boolean | string)␊ - runtimeVersion?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Files or Blob Storage access information value for dictionary storage.␊ - */␊ - export interface AzureStorageInfoValue4 {␊ - /**␊ - * Access key for the storage account.␊ - */␊ - accessKey?: string␊ - /**␊ - * Name of the storage account.␊ - */␊ - accountName?: string␊ - /**␊ - * Path to mount the storage within the site's runtime environment.␊ - */␊ - mountPath?: string␊ - /**␊ - * Name of the file share (container name, for Blob storage).␊ - */␊ - shareName?: string␊ - /**␊ - * Type of storage.␊ - */␊ - type?: (("AzureFiles" | "AzureBlob") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * BackupRequest resource specific properties␊ - */␊ - export interface BackupRequestProperties6 {␊ - /**␊ - * Name of the backup.␊ - */␊ - backupName?: string␊ - /**␊ - * Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy.␊ - */␊ - backupSchedule?: (BackupSchedule6 | string)␊ - /**␊ - * Databases included in the backup.␊ - */␊ - databases?: (DatabaseBackupSetting6[] | string)␊ - /**␊ - * True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * SAS URL to the container.␊ - */␊ - storageAccountUrl: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy.␊ - */␊ - export interface BackupSchedule6 {␊ - /**␊ - * 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)␊ - */␊ - frequencyInterval: ((number & string) | string)␊ - /**␊ - * 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).␊ - */␊ - frequencyUnit: (("Day" | "Hour") | string)␊ - /**␊ - * True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise.␊ - */␊ - keepAtLeastOneBackup: (boolean | string)␊ - /**␊ - * After how many days backups should be deleted.␊ - */␊ - retentionPeriodInDays: ((number & string) | string)␊ - /**␊ - * When the schedule should start working.␊ - */␊ - startTime?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Database backup settings.␊ - */␊ - export interface DatabaseBackupSetting6 {␊ - /**␊ - * 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.␊ - */␊ - connectionString?: string␊ - /**␊ - * Contains a connection string name that is linked to the SiteConfig.ConnectionStrings.␊ - * This is used during restore with overwrite connection strings options.␊ - */␊ - connectionStringName?: string␊ - /**␊ - * Database type (e.g. SqlAzure / MySql).␊ - */␊ - databaseType: (("SqlAzure" | "MySql" | "LocalMySql" | "PostgreSql") | string)␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Database connection string value to type pair.␊ - */␊ - export interface ConnStringValueTypePair6 {␊ - /**␊ - * Type of database.␊ - */␊ - type: (("MySql" | "SQLServer" | "SQLAzure" | "Custom" | "NotificationHub" | "ServiceBus" | "EventHub" | "ApiHub" | "DocDb" | "RedisCache" | "PostgreSQL") | string)␊ - /**␊ - * Value of pair.␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SiteLogsConfig resource specific properties␊ - */␊ - export interface SiteLogsConfigProperties6 {␊ - /**␊ - * Application logs configuration.␊ - */␊ - applicationLogs?: (ApplicationLogsConfig6 | string)␊ - /**␊ - * Enabled configuration.␊ - */␊ - detailedErrorMessages?: (EnabledConfig6 | string)␊ - /**␊ - * Enabled configuration.␊ - */␊ - failedRequestsTracing?: (EnabledConfig6 | string)␊ - /**␊ - * Http logs configuration.␊ - */␊ - httpLogs?: (HttpLogsConfig6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application logs configuration.␊ - */␊ - export interface ApplicationLogsConfig6 {␊ - /**␊ - * Application logs azure blob storage configuration.␊ - */␊ - azureBlobStorage?: (AzureBlobStorageApplicationLogsConfig6 | string)␊ - /**␊ - * Application logs to Azure table storage configuration.␊ - */␊ - azureTableStorage?: (AzureTableStorageApplicationLogsConfig6 | string)␊ - /**␊ - * Application logs to file system configuration.␊ - */␊ - fileSystem?: (FileSystemApplicationLogsConfig6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application logs azure blob storage configuration.␊ - */␊ - export interface AzureBlobStorageApplicationLogsConfig6 {␊ - /**␊ - * Log level.␊ - */␊ - level?: (("Off" | "Verbose" | "Information" | "Warning" | "Error") | string)␊ - /**␊ - * Retention in days.␊ - * Remove blobs older than X days.␊ - * 0 or lower means no retention.␊ - */␊ - retentionInDays?: (number | string)␊ - /**␊ - * SAS url to a azure blob container with read/write/list/delete permissions.␊ - */␊ - sasUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application logs to Azure table storage configuration.␊ - */␊ - export interface AzureTableStorageApplicationLogsConfig6 {␊ - /**␊ - * Log level.␊ - */␊ - level?: (("Off" | "Verbose" | "Information" | "Warning" | "Error") | string)␊ - /**␊ - * SAS URL to an Azure table with add/query/delete permissions.␊ - */␊ - sasUrl: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application logs to file system configuration.␊ - */␊ - export interface FileSystemApplicationLogsConfig6 {␊ - /**␊ - * Log level.␊ - */␊ - level?: (("Off" | "Verbose" | "Information" | "Warning" | "Error") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Enabled configuration.␊ - */␊ - export interface EnabledConfig6 {␊ - /**␊ - * True if configuration is enabled, false if it is disabled and null if configuration is not set.␊ - */␊ - enabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http logs configuration.␊ - */␊ - export interface HttpLogsConfig6 {␊ - /**␊ - * Http logs to azure blob storage configuration.␊ - */␊ - azureBlobStorage?: (AzureBlobStorageHttpLogsConfig6 | string)␊ - /**␊ - * Http logs to file system configuration.␊ - */␊ - fileSystem?: (FileSystemHttpLogsConfig6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http logs to azure blob storage configuration.␊ - */␊ - export interface AzureBlobStorageHttpLogsConfig6 {␊ - /**␊ - * True if configuration is enabled, false if it is disabled and null if configuration is not set.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Retention in days.␊ - * Remove blobs older than X days.␊ - * 0 or lower means no retention.␊ - */␊ - retentionInDays?: (number | string)␊ - /**␊ - * SAS url to a azure blob container with read/write/list/delete permissions.␊ - */␊ - sasUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http logs to file system configuration.␊ - */␊ - export interface FileSystemHttpLogsConfig6 {␊ - /**␊ - * True if configuration is enabled, false if it is disabled and null if configuration is not set.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Retention in days.␊ - * Remove files older than X days.␊ - * 0 or lower means no retention.␊ - */␊ - retentionInDays?: (number | string)␊ - /**␊ - * 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.␊ - */␊ - retentionInMb?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Names for connection strings, application settings, and external Azure storage account configuration␊ - * identifiers 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.␊ - */␊ - export interface SlotConfigNames5 {␊ - /**␊ - * List of application settings names.␊ - */␊ - appSettingNames?: (string[] | string)␊ - /**␊ - * List of external Azure storage account identifiers.␊ - */␊ - azureStorageConfigNames?: (string[] | string)␊ - /**␊ - * List of connection string names.␊ - */␊ - connectionStringNames?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/deployments␊ - */␊ - export interface SitesDeploymentsChildResource6 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * ID of an existing deployment.␊ - */␊ - name: string␊ - /**␊ - * Deployment resource specific properties␊ - */␊ - properties: (DeploymentProperties8 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "deployments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Deployment resource specific properties␊ - */␊ - export interface DeploymentProperties8 {␊ - /**␊ - * True if deployment is currently active, false if completed and null if not started.␊ - */␊ - active?: (boolean | string)␊ - /**␊ - * Who authored the deployment.␊ - */␊ - author?: string␊ - /**␊ - * Author email.␊ - */␊ - author_email?: string␊ - /**␊ - * Who performed the deployment.␊ - */␊ - deployer?: string␊ - /**␊ - * Details on deployment.␊ - */␊ - details?: string␊ - /**␊ - * End time.␊ - */␊ - end_time?: string␊ - /**␊ - * Details about deployment status.␊ - */␊ - message?: string␊ - /**␊ - * Start time.␊ - */␊ - start_time?: string␊ - /**␊ - * Deployment status.␊ - */␊ - status?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/domainOwnershipIdentifiers␊ - */␊ - export interface SitesDomainOwnershipIdentifiersChildResource5 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of domain ownership identifier.␊ - */␊ - name: string␊ - /**␊ - * Identifier resource specific properties␊ - */␊ - properties: (IdentifierProperties5 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "domainOwnershipIdentifiers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identifier resource specific properties␊ - */␊ - export interface IdentifierProperties5 {␊ - /**␊ - * String representation of the identity.␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/extensions␊ - */␊ - export interface SitesExtensionsChildResource5 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "MSDeploy"␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - properties: (MSDeployCore5 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - export interface MSDeployCore5 {␊ - /**␊ - * Sets the AppOffline rule while the MSDeploy operation executes.␊ - * Setting is false by default.␊ - */␊ - appOffline?: (boolean | string)␊ - /**␊ - * SQL Connection String␊ - */␊ - connectionString?: string␊ - /**␊ - * Database Type␊ - */␊ - dbType?: string␊ - /**␊ - * Package URI␊ - */␊ - packageUri?: string␊ - /**␊ - * MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used.␊ - */␊ - setParameters?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * URI of MSDeploy Parameters file. Must not be set if SetParameters is used.␊ - */␊ - setParametersXmlFileUri?: string␊ - /**␊ - * 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.␊ - */␊ - skipAppData?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/functions␊ - */␊ - export interface SitesFunctionsChildResource5 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Function name.␊ - */␊ - name: string␊ - /**␊ - * FunctionEnvelope resource specific properties␊ - */␊ - properties: (FunctionEnvelopeProperties5 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "functions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * FunctionEnvelope resource specific properties␊ - */␊ - export interface FunctionEnvelopeProperties5 {␊ - /**␊ - * Config information.␊ - */␊ - config?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Config URI.␊ - */␊ - config_href?: string␊ - /**␊ - * File list.␊ - */␊ - files?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Function App ID.␊ - */␊ - function_app_id?: string␊ - /**␊ - * Function URI.␊ - */␊ - href?: string␊ - /**␊ - * The invocation URL␊ - */␊ - invoke_url_template?: string␊ - /**␊ - * Gets or sets a value indicating whether the function is disabled␊ - */␊ - isDisabled?: (boolean | string)␊ - /**␊ - * The function language␊ - */␊ - language?: string␊ - /**␊ - * Script URI.␊ - */␊ - script_href?: string␊ - /**␊ - * Script root path URI.␊ - */␊ - script_root_path_href?: string␊ - /**␊ - * Secrets file URI.␊ - */␊ - secrets_file_href?: string␊ - /**␊ - * Test data used when testing via the Azure Portal.␊ - */␊ - test_data?: string␊ - /**␊ - * Test data URI.␊ - */␊ - test_data_href?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/hostNameBindings␊ - */␊ - export interface SitesHostNameBindingsChildResource6 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Hostname in the hostname binding.␊ - */␊ - name: string␊ - /**␊ - * HostNameBinding resource specific properties␊ - */␊ - properties: (HostNameBindingProperties6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "hostNameBindings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HostNameBinding resource specific properties␊ - */␊ - export interface HostNameBindingProperties6 {␊ - /**␊ - * Azure resource name.␊ - */␊ - azureResourceName?: string␊ - /**␊ - * Azure resource type.␊ - */␊ - azureResourceType?: (("Website" | "TrafficManager") | string)␊ - /**␊ - * Custom DNS record type.␊ - */␊ - customHostNameDnsRecordType?: (("CName" | "A") | string)␊ - /**␊ - * Fully qualified ARM domain resource URI.␊ - */␊ - domainId?: string␊ - /**␊ - * Hostname type.␊ - */␊ - hostNameType?: (("Verified" | "Managed") | string)␊ - /**␊ - * App Service app name.␊ - */␊ - siteName?: string␊ - /**␊ - * SSL type.␊ - */␊ - sslState?: (("Disabled" | "SniEnabled" | "IpBasedEnabled") | string)␊ - /**␊ - * SSL certificate thumbprint␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/hybridconnection␊ - */␊ - export interface SitesHybridconnectionChildResource6 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the hybrid connection configuration.␊ - */␊ - name: string␊ - /**␊ - * RelayServiceConnectionEntity resource specific properties␊ - */␊ - properties: (RelayServiceConnectionEntityProperties6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "hybridconnection"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * RelayServiceConnectionEntity resource specific properties␊ - */␊ - export interface RelayServiceConnectionEntityProperties6 {␊ - biztalkUri?: string␊ - entityConnectionString?: string␊ - entityName?: string␊ - hostname?: string␊ - port?: (number | string)␊ - resourceConnectionString?: string␊ - resourceType?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/migrate␊ - */␊ - export interface SitesMigrateChildResource5 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "migrate"␊ - /**␊ - * StorageMigrationOptions resource specific properties␊ - */␊ - properties: (StorageMigrationOptionsProperties5 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "migrate"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * StorageMigrationOptions resource specific properties␊ - */␊ - export interface StorageMigrationOptionsProperties5 {␊ - /**␊ - * AzureFiles connection string.␊ - */␊ - azurefilesConnectionString: string␊ - /**␊ - * AzureFiles share.␊ - */␊ - azurefilesShare: string␊ - /**␊ - * true if the app should be read only during copy operation; otherwise, false.␊ - */␊ - blockWriteAccessToSite?: (boolean | string)␊ - /**␊ - * trueif the app should be switched over; otherwise, false.␊ - */␊ - switchSiteAfterMigration?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/networkConfig␊ - */␊ - export interface SitesNetworkConfigChildResource4 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "virtualNetwork"␊ - /**␊ - * SwiftVirtualNetwork resource specific properties␊ - */␊ - properties: (SwiftVirtualNetworkProperties4 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "networkConfig"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SwiftVirtualNetwork resource specific properties␊ - */␊ - export interface SwiftVirtualNetworkProperties4 {␊ - /**␊ - * The Virtual Network subnet's resource ID. This is the subnet that this Web App will join. This subnet must have a delegation to Microsoft.Web/serverFarms defined first.␊ - */␊ - subnetResourceId?: string␊ - /**␊ - * A flag that specifies if the scale unit this Web App is on supports Swift integration.␊ - */␊ - swiftSupported?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/premieraddons␊ - */␊ - export interface SitesPremieraddonsChildResource6 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Add-on name.␊ - */␊ - name: string␊ - /**␊ - * PremierAddOn resource specific properties␊ - */␊ - properties: (PremierAddOnProperties5 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "premieraddons"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * PremierAddOn resource specific properties␊ - */␊ - export interface PremierAddOnProperties5 {␊ - /**␊ - * Premier add on Marketplace offer.␊ - */␊ - marketplaceOffer?: string␊ - /**␊ - * Premier add on Marketplace publisher.␊ - */␊ - marketplacePublisher?: string␊ - /**␊ - * Premier add on Product.␊ - */␊ - product?: string␊ - /**␊ - * Premier add on SKU.␊ - */␊ - sku?: string␊ - /**␊ - * Premier add on Vendor.␊ - */␊ - vendor?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/privateAccess␊ - */␊ - export interface SitesPrivateAccessChildResource4 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "virtualNetworks"␊ - /**␊ - * PrivateAccess resource specific properties␊ - */␊ - properties: (PrivateAccessProperties4 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "privateAccess"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * PrivateAccess resource specific properties␊ - */␊ - export interface PrivateAccessProperties4 {␊ - /**␊ - * Whether private access is enabled or not.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * The Virtual Networks (and subnets) allowed to access the site privately.␊ - */␊ - virtualNetworks?: (PrivateAccessVirtualNetwork4[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a Virtual Network that is useable for private site access.␊ - */␊ - export interface PrivateAccessVirtualNetwork4 {␊ - /**␊ - * The key (ID) of the Virtual Network.␊ - */␊ - key?: (number | string)␊ - /**␊ - * The name of the Virtual Network.␊ - */␊ - name?: string␊ - /**␊ - * The ARM uri of the Virtual Network␊ - */␊ - resourceId?: string␊ - /**␊ - * A List of subnets that access is allowed to on this Virtual Network. An empty array (but not null) is interpreted to mean that all subnets are allowed within this Virtual Network.␊ - */␊ - subnets?: (PrivateAccessSubnet4[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a Virtual Network subnet that is useable for private site access.␊ - */␊ - export interface PrivateAccessSubnet4 {␊ - /**␊ - * The key (ID) of the subnet.␊ - */␊ - key?: (number | string)␊ - /**␊ - * The name of the subnet.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/publicCertificates␊ - */␊ - export interface SitesPublicCertificatesChildResource5 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Public certificate name.␊ - */␊ - name: string␊ - /**␊ - * PublicCertificate resource specific properties␊ - */␊ - properties: (PublicCertificateProperties5 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "publicCertificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * PublicCertificate resource specific properties␊ - */␊ - export interface PublicCertificateProperties5 {␊ - /**␊ - * Public Certificate byte array␊ - */␊ - blob?: string␊ - /**␊ - * Public Certificate Location.␊ - */␊ - publicCertificateLocation?: (("CurrentUserMy" | "LocalMachineMy" | "Unknown") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/siteextensions␊ - */␊ - export interface SitesSiteextensionsChildResource5 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Site extension name.␊ - */␊ - name: string␊ - type: "siteextensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots␊ - */␊ - export interface SitesSlotsChildResource6 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Managed service identity.␊ - */␊ - identity?: (ManagedServiceIdentity19 | string)␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the deployment slot to create or update. The name 'production' is reserved.␊ - */␊ - name: string␊ - /**␊ - * Site resource specific properties␊ - */␊ - properties: (SiteProperties6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "slots"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/privateEndpointConnections␊ - */␊ - export interface SitesPrivateEndpointConnectionsChildResource2 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * A request to approve or reject a private endpoint connection␊ - */␊ - properties: (PrivateLinkConnectionApprovalRequest3 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "privateEndpointConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A request to approve or reject a private endpoint connection␊ - */␊ - export interface PrivateLinkConnectionApprovalRequest3 {␊ - /**␊ - * The state of a private link connection␊ - */␊ - privateLinkServiceConnectionState?: (PrivateLinkConnectionState3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The state of a private link connection␊ - */␊ - export interface PrivateLinkConnectionState3 {␊ - /**␊ - * ActionsRequired for a private link connection␊ - */␊ - actionsRequired?: string␊ - /**␊ - * Description of a private link connection␊ - */␊ - description?: string␊ - /**␊ - * Status of a private link connection␊ - */␊ - status?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/sourcecontrols␊ - */␊ - export interface SitesSourcecontrolsChildResource6 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "web"␊ - /**␊ - * SiteSourceControl resource specific properties␊ - */␊ - properties: (SiteSourceControlProperties6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "sourcecontrols"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SiteSourceControl resource specific properties␊ - */␊ - export interface SiteSourceControlProperties6 {␊ - /**␊ - * Name of branch to use for deployment.␊ - */␊ - branch?: string␊ - /**␊ - * true to enable deployment rollback; otherwise, false.␊ - */␊ - deploymentRollbackEnabled?: (boolean | string)␊ - /**␊ - * true if this is deployed via GitHub action.␊ - */␊ - isGitHubAction?: (boolean | string)␊ - /**␊ - * true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub).␊ - */␊ - isManualIntegration?: (boolean | string)␊ - /**␊ - * true for a Mercurial repository; false for a Git repository.␊ - */␊ - isMercurial?: (boolean | string)␊ - /**␊ - * Repository or source control URL.␊ - */␊ - repoUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/virtualNetworkConnections␊ - */␊ - export interface SitesVirtualNetworkConnectionsChildResource6 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of an existing Virtual Network.␊ - */␊ - name: string␊ - /**␊ - * VnetInfo resource specific properties␊ - */␊ - properties: (VnetInfoProperties6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "virtualNetworkConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VnetInfo resource specific properties␊ - */␊ - export interface VnetInfoProperties6 {␊ - /**␊ - * A certificate file (.cer) blob containing the public key of the private key used to authenticate a ␊ - * Point-To-Site VPN connection.␊ - */␊ - certBlob?: string␊ - /**␊ - * DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses.␊ - */␊ - dnsServers?: string␊ - /**␊ - * Flag that is used to denote if this is VNET injection␊ - */␊ - isSwift?: (boolean | string)␊ - /**␊ - * The Virtual Network's resource ID.␊ - */␊ - vnetResourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/deployments␊ - */␊ - export interface SitesDeployments6 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * ID of an existing deployment.␊ - */␊ - name: string␊ - /**␊ - * Deployment resource specific properties␊ - */␊ - properties: (DeploymentProperties8 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "Microsoft.Web/sites/deployments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/domainOwnershipIdentifiers␊ - */␊ - export interface SitesDomainOwnershipIdentifiers5 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of domain ownership identifier.␊ - */␊ - name: string␊ - /**␊ - * Identifier resource specific properties␊ - */␊ - properties: (IdentifierProperties5 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "Microsoft.Web/sites/domainOwnershipIdentifiers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/extensions␊ - */␊ - export interface SitesExtensions5 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - properties: (MSDeployCore5 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "Microsoft.Web/sites/extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/functions␊ - */␊ - export interface SitesFunctions5 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Function name.␊ - */␊ - name: string␊ - /**␊ - * FunctionEnvelope resource specific properties␊ - */␊ - properties: (FunctionEnvelopeProperties5 | string)␊ - resources?: SitesFunctionsKeysChildResource3[]␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "Microsoft.Web/sites/functions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/functions/keys␊ - */␊ - export interface SitesFunctionsKeysChildResource3 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * The name of the key.␊ - */␊ - name: string␊ - type: "keys"␊ - /**␊ - * Key value␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/functions/keys␊ - */␊ - export interface SitesFunctionsKeys3 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * The name of the key.␊ - */␊ - name: string␊ - type: "Microsoft.Web/sites/functions/keys"␊ - /**␊ - * Key value␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/hostNameBindings␊ - */␊ - export interface SitesHostNameBindings6 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Hostname in the hostname binding.␊ - */␊ - name: string␊ - /**␊ - * HostNameBinding resource specific properties␊ - */␊ - properties: (HostNameBindingProperties6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "Microsoft.Web/sites/hostNameBindings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/hybridconnection␊ - */␊ - export interface SitesHybridconnection6 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the hybrid connection configuration.␊ - */␊ - name: string␊ - /**␊ - * RelayServiceConnectionEntity resource specific properties␊ - */␊ - properties: (RelayServiceConnectionEntityProperties6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "Microsoft.Web/sites/hybridconnection"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/hybridConnectionNamespaces/relays␊ - */␊ - export interface SitesHybridConnectionNamespacesRelays5 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * The relay name for this hybrid connection.␊ - */␊ - name: string␊ - /**␊ - * HybridConnection resource specific properties␊ - */␊ - properties: (HybridConnectionProperties7 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "Microsoft.Web/sites/hybridConnectionNamespaces/relays"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HybridConnection resource specific properties␊ - */␊ - export interface HybridConnectionProperties7 {␊ - /**␊ - * The hostname of the endpoint.␊ - */␊ - hostname?: string␊ - /**␊ - * The port of the endpoint.␊ - */␊ - port?: (number | string)␊ - /**␊ - * The ARM URI to the Service Bus relay.␊ - */␊ - relayArmUri?: string␊ - /**␊ - * The name of the Service Bus relay.␊ - */␊ - relayName?: string␊ - /**␊ - * The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus.␊ - */␊ - sendKeyName?: string␊ - /**␊ - * 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.␊ - */␊ - sendKeyValue?: string␊ - /**␊ - * The name of the Service Bus namespace.␊ - */␊ - serviceBusNamespace?: string␊ - /**␊ - * The suffix for the service bus endpoint. By default this is .servicebus.windows.net␊ - */␊ - serviceBusSuffix?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/instances/extensions␊ - */␊ - export interface SitesInstancesExtensions5 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - properties: (MSDeployCore5 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "Microsoft.Web/sites/instances/extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/migrate␊ - */␊ - export interface SitesMigrate5 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * StorageMigrationOptions resource specific properties␊ - */␊ - properties: (StorageMigrationOptionsProperties5 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "Microsoft.Web/sites/migrate"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/networkConfig␊ - */␊ - export interface SitesNetworkConfig4 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SwiftVirtualNetwork resource specific properties␊ - */␊ - properties: (SwiftVirtualNetworkProperties4 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "Microsoft.Web/sites/networkConfig"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/premieraddons␊ - */␊ - export interface SitesPremieraddons6 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Add-on name.␊ - */␊ - name: string␊ - /**␊ - * PremierAddOn resource specific properties␊ - */␊ - properties: (PremierAddOnProperties5 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/sites/premieraddons"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/privateAccess␊ - */␊ - export interface SitesPrivateAccess4 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * PrivateAccess resource specific properties␊ - */␊ - properties: (PrivateAccessProperties4 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "Microsoft.Web/sites/privateAccess"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/privateEndpointConnections␊ - */␊ - export interface SitesPrivateEndpointConnections2 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * A request to approve or reject a private endpoint connection␊ - */␊ - properties: (PrivateLinkConnectionApprovalRequest3 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "Microsoft.Web/sites/privateEndpointConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/publicCertificates␊ - */␊ - export interface SitesPublicCertificates5 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Public certificate name.␊ - */␊ - name: string␊ - /**␊ - * PublicCertificate resource specific properties␊ - */␊ - properties: (PublicCertificateProperties5 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "Microsoft.Web/sites/publicCertificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/siteextensions␊ - */␊ - export interface SitesSiteextensions5 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Site extension name.␊ - */␊ - name: string␊ - type: "Microsoft.Web/sites/siteextensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots␊ - */␊ - export interface SitesSlots6 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Managed service identity.␊ - */␊ - identity?: (ManagedServiceIdentity19 | string)␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the deployment slot to create or update. The name 'production' is reserved.␊ - */␊ - name: string␊ - /**␊ - * Site resource specific properties␊ - */␊ - properties: (SiteProperties6 | string)␊ - resources?: (SitesSlotsConfigChildResource6 | SitesSlotsDeploymentsChildResource6 | SitesSlotsDomainOwnershipIdentifiersChildResource5 | SitesSlotsExtensionsChildResource5 | SitesSlotsFunctionsChildResource5 | SitesSlotsHostNameBindingsChildResource6 | SitesSlotsHybridconnectionChildResource6 | SitesSlotsNetworkConfigChildResource4 | SitesSlotsPremieraddonsChildResource6 | SitesSlotsPrivateAccessChildResource4 | SitesSlotsPublicCertificatesChildResource5 | SitesSlotsSiteextensionsChildResource5 | SitesSlotsSourcecontrolsChildResource6 | SitesSlotsVirtualNetworkConnectionsChildResource6)[]␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/sites/slots"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/deployments␊ - */␊ - export interface SitesSlotsDeploymentsChildResource6 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * ID of an existing deployment.␊ - */␊ - name: string␊ - /**␊ - * Deployment resource specific properties␊ - */␊ - properties: (DeploymentProperties8 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "deployments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/domainOwnershipIdentifiers␊ - */␊ - export interface SitesSlotsDomainOwnershipIdentifiersChildResource5 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of domain ownership identifier.␊ - */␊ - name: string␊ - /**␊ - * Identifier resource specific properties␊ - */␊ - properties: (IdentifierProperties5 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "domainOwnershipIdentifiers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/extensions␊ - */␊ - export interface SitesSlotsExtensionsChildResource5 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "MSDeploy"␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - properties: (MSDeployCore5 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/functions␊ - */␊ - export interface SitesSlotsFunctionsChildResource5 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Function name.␊ - */␊ - name: string␊ - /**␊ - * FunctionEnvelope resource specific properties␊ - */␊ - properties: (FunctionEnvelopeProperties5 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "functions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/hostNameBindings␊ - */␊ - export interface SitesSlotsHostNameBindingsChildResource6 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Hostname in the hostname binding.␊ - */␊ - name: string␊ - /**␊ - * HostNameBinding resource specific properties␊ - */␊ - properties: (HostNameBindingProperties6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "hostNameBindings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/hybridconnection␊ - */␊ - export interface SitesSlotsHybridconnectionChildResource6 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the hybrid connection configuration.␊ - */␊ - name: string␊ - /**␊ - * RelayServiceConnectionEntity resource specific properties␊ - */␊ - properties: (RelayServiceConnectionEntityProperties6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "hybridconnection"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/networkConfig␊ - */␊ - export interface SitesSlotsNetworkConfigChildResource4 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "virtualNetwork"␊ - /**␊ - * SwiftVirtualNetwork resource specific properties␊ - */␊ - properties: (SwiftVirtualNetworkProperties4 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "networkConfig"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/premieraddons␊ - */␊ - export interface SitesSlotsPremieraddonsChildResource6 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Add-on name.␊ - */␊ - name: string␊ - /**␊ - * PremierAddOn resource specific properties␊ - */␊ - properties: (PremierAddOnProperties5 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "premieraddons"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/privateAccess␊ - */␊ - export interface SitesSlotsPrivateAccessChildResource4 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "virtualNetworks"␊ - /**␊ - * PrivateAccess resource specific properties␊ - */␊ - properties: (PrivateAccessProperties4 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "privateAccess"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/publicCertificates␊ - */␊ - export interface SitesSlotsPublicCertificatesChildResource5 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Public certificate name.␊ - */␊ - name: string␊ - /**␊ - * PublicCertificate resource specific properties␊ - */␊ - properties: (PublicCertificateProperties5 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "publicCertificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/siteextensions␊ - */␊ - export interface SitesSlotsSiteextensionsChildResource5 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Site extension name.␊ - */␊ - name: string␊ - type: "siteextensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/sourcecontrols␊ - */␊ - export interface SitesSlotsSourcecontrolsChildResource6 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "web"␊ - /**␊ - * SiteSourceControl resource specific properties␊ - */␊ - properties: (SiteSourceControlProperties6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "sourcecontrols"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/virtualNetworkConnections␊ - */␊ - export interface SitesSlotsVirtualNetworkConnectionsChildResource6 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of an existing Virtual Network.␊ - */␊ - name: string␊ - /**␊ - * VnetInfo resource specific properties␊ - */␊ - properties: (VnetInfoProperties6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "virtualNetworkConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/deployments␊ - */␊ - export interface SitesSlotsDeployments6 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * ID of an existing deployment.␊ - */␊ - name: string␊ - /**␊ - * Deployment resource specific properties␊ - */␊ - properties: (DeploymentProperties8 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "Microsoft.Web/sites/slots/deployments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/domainOwnershipIdentifiers␊ - */␊ - export interface SitesSlotsDomainOwnershipIdentifiers5 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of domain ownership identifier.␊ - */␊ - name: string␊ - /**␊ - * Identifier resource specific properties␊ - */␊ - properties: (IdentifierProperties5 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "Microsoft.Web/sites/slots/domainOwnershipIdentifiers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/extensions␊ - */␊ - export interface SitesSlotsExtensions5 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - properties: (MSDeployCore5 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "Microsoft.Web/sites/slots/extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/functions␊ - */␊ - export interface SitesSlotsFunctions5 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Function name.␊ - */␊ - name: string␊ - /**␊ - * FunctionEnvelope resource specific properties␊ - */␊ - properties: (FunctionEnvelopeProperties5 | string)␊ - resources?: SitesSlotsFunctionsKeysChildResource3[]␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "Microsoft.Web/sites/slots/functions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/functions/keys␊ - */␊ - export interface SitesSlotsFunctionsKeysChildResource3 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * The name of the key.␊ - */␊ - name: string␊ - type: "keys"␊ - /**␊ - * Key value␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/functions/keys␊ - */␊ - export interface SitesSlotsFunctionsKeys3 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * The name of the key.␊ - */␊ - name: string␊ - type: "Microsoft.Web/sites/slots/functions/keys"␊ - /**␊ - * Key value␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/hostNameBindings␊ - */␊ - export interface SitesSlotsHostNameBindings6 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Hostname in the hostname binding.␊ - */␊ - name: string␊ - /**␊ - * HostNameBinding resource specific properties␊ - */␊ - properties: (HostNameBindingProperties6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "Microsoft.Web/sites/slots/hostNameBindings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/hybridconnection␊ - */␊ - export interface SitesSlotsHybridconnection6 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the hybrid connection configuration.␊ - */␊ - name: string␊ - /**␊ - * RelayServiceConnectionEntity resource specific properties␊ - */␊ - properties: (RelayServiceConnectionEntityProperties6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "Microsoft.Web/sites/slots/hybridconnection"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays␊ - */␊ - export interface SitesSlotsHybridConnectionNamespacesRelays5 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * The relay name for this hybrid connection.␊ - */␊ - name: string␊ - /**␊ - * HybridConnection resource specific properties␊ - */␊ - properties: (HybridConnectionProperties7 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/instances/extensions␊ - */␊ - export interface SitesSlotsInstancesExtensions5 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - properties: (MSDeployCore5 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "Microsoft.Web/sites/slots/instances/extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/networkConfig␊ - */␊ - export interface SitesSlotsNetworkConfig4 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SwiftVirtualNetwork resource specific properties␊ - */␊ - properties: (SwiftVirtualNetworkProperties4 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "Microsoft.Web/sites/slots/networkConfig"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/premieraddons␊ - */␊ - export interface SitesSlotsPremieraddons6 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Add-on name.␊ - */␊ - name: string␊ - /**␊ - * PremierAddOn resource specific properties␊ - */␊ - properties: (PremierAddOnProperties5 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/sites/slots/premieraddons"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/privateAccess␊ - */␊ - export interface SitesSlotsPrivateAccess4 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * PrivateAccess resource specific properties␊ - */␊ - properties: (PrivateAccessProperties4 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "Microsoft.Web/sites/slots/privateAccess"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/publicCertificates␊ - */␊ - export interface SitesSlotsPublicCertificates5 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Public certificate name.␊ - */␊ - name: string␊ - /**␊ - * PublicCertificate resource specific properties␊ - */␊ - properties: (PublicCertificateProperties5 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "Microsoft.Web/sites/slots/publicCertificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/siteextensions␊ - */␊ - export interface SitesSlotsSiteextensions5 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Site extension name.␊ - */␊ - name: string␊ - type: "Microsoft.Web/sites/slots/siteextensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/sourcecontrols␊ - */␊ - export interface SitesSlotsSourcecontrols6 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteSourceControl resource specific properties␊ - */␊ - properties: (SiteSourceControlProperties6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "Microsoft.Web/sites/slots/sourcecontrols"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/virtualNetworkConnections␊ - */␊ - export interface SitesSlotsVirtualNetworkConnections6 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of an existing Virtual Network.␊ - */␊ - name: string␊ - /**␊ - * VnetInfo resource specific properties␊ - */␊ - properties: (VnetInfoProperties6 | string)␊ - resources?: SitesSlotsVirtualNetworkConnectionsGatewaysChildResource6[]␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "Microsoft.Web/sites/slots/virtualNetworkConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/virtualNetworkConnections/gateways␊ - */␊ - export interface SitesSlotsVirtualNetworkConnectionsGatewaysChildResource6 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the gateway. Currently, the only supported string is "primary".␊ - */␊ - name: string␊ - /**␊ - * VnetGateway resource specific properties␊ - */␊ - properties: (VnetGatewayProperties7 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "gateways"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/virtualNetworkConnections/gateways␊ - */␊ - export interface SitesSlotsVirtualNetworkConnectionsGateways6 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the gateway. Currently, the only supported string is "primary".␊ - */␊ - name: string␊ - /**␊ - * VnetGateway resource specific properties␊ - */␊ - properties: (VnetGatewayProperties7 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "Microsoft.Web/sites/slots/virtualNetworkConnections/gateways"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/sourcecontrols␊ - */␊ - export interface SitesSourcecontrols6 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteSourceControl resource specific properties␊ - */␊ - properties: (SiteSourceControlProperties6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "Microsoft.Web/sites/sourcecontrols"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/virtualNetworkConnections␊ - */␊ - export interface SitesVirtualNetworkConnections6 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of an existing Virtual Network.␊ - */␊ - name: string␊ - /**␊ - * VnetInfo resource specific properties␊ - */␊ - properties: (VnetInfoProperties6 | string)␊ - resources?: SitesVirtualNetworkConnectionsGatewaysChildResource6[]␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "Microsoft.Web/sites/virtualNetworkConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/virtualNetworkConnections/gateways␊ - */␊ - export interface SitesVirtualNetworkConnectionsGatewaysChildResource6 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the gateway. Currently, the only supported string is "primary".␊ - */␊ - name: string␊ - /**␊ - * VnetGateway resource specific properties␊ - */␊ - properties: (VnetGatewayProperties7 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "gateways"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/virtualNetworkConnections/gateways␊ - */␊ - export interface SitesVirtualNetworkConnectionsGateways6 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the gateway. Currently, the only supported string is "primary".␊ - */␊ - name: string␊ - /**␊ - * VnetGateway resource specific properties␊ - */␊ - properties: (VnetGatewayProperties7 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "Microsoft.Web/sites/virtualNetworkConnections/gateways"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/staticSites␊ - */␊ - export interface StaticSites2 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the static site to create or update.␊ - */␊ - name: string␊ - /**␊ - * A static site.␊ - */␊ - properties: (StaticSite2 | string)␊ - resources?: (StaticSitesConfigChildResource2 | StaticSitesCustomDomainsChildResource2)[]␊ - /**␊ - * Description of a SKU for a scalable resource.␊ - */␊ - sku?: (SkuDescription7 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/staticSites"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A static site.␊ - */␊ - export interface StaticSite2 {␊ - /**␊ - * The target branch in the repository.␊ - */␊ - branch?: string␊ - /**␊ - * Build properties for the static site.␊ - */␊ - buildProperties?: (StaticSiteBuildProperties2 | string)␊ - /**␊ - * A user's github repository token. This is used to setup the Github Actions workflow file and API secrets.␊ - */␊ - repositoryToken?: string␊ - /**␊ - * URL for the repository of the static site.␊ - */␊ - repositoryUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Build properties for the static site.␊ - */␊ - export interface StaticSiteBuildProperties2 {␊ - /**␊ - * The path to the api code within the repository.␊ - */␊ - apiLocation?: string␊ - /**␊ - * The path of the app artifacts after building.␊ - */␊ - appArtifactLocation?: string␊ - /**␊ - * The path to the app code within the repository.␊ - */␊ - appLocation?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/staticSites/config␊ - */␊ - export interface StaticSitesConfigChildResource2 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "functionappsettings"␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "config"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/staticSites/customDomains␊ - */␊ - export interface StaticSitesCustomDomainsChildResource2 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * The custom domain to create.␊ - */␊ - name: string␊ - type: "customDomains"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/staticSites/builds/config␊ - */␊ - export interface StaticSitesBuildsConfig2 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "Microsoft.Web/staticSites/builds/config"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/staticSites/config␊ - */␊ - export interface StaticSitesConfig2 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData5 | string)␊ - type: "Microsoft.Web/staticSites/config"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/staticSites/customDomains␊ - */␊ - export interface StaticSitesCustomDomains2 {␊ - apiVersion: "2020-09-01"␊ - /**␊ - * The custom domain to create.␊ - */␊ - name: string␊ - type: "Microsoft.Web/staticSites/customDomains"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/certificates␊ - */␊ - export interface Certificates7 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the certificate.␊ - */␊ - name: string␊ - /**␊ - * Certificate resource specific properties␊ - */␊ - properties: (CertificateProperties7 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/certificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Certificate resource specific properties␊ - */␊ - export interface CertificateProperties7 {␊ - /**␊ - * CNAME of the certificate to be issued via free certificate␊ - */␊ - canonicalName?: string␊ - /**␊ - * Host names the certificate applies to.␊ - */␊ - hostNames?: (string[] | string)␊ - /**␊ - * Key Vault Csm resource Id.␊ - */␊ - keyVaultId?: string␊ - /**␊ - * Key Vault secret name.␊ - */␊ - keyVaultSecretName?: string␊ - /**␊ - * Certificate password.␊ - */␊ - password: string␊ - /**␊ - * Pfx blob.␊ - */␊ - pfxBlob?: string␊ - /**␊ - * Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".␊ - */␊ - serverFarmId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - export interface SystemData6 {␊ - /**␊ - * The timestamp of resource creation (UTC).␊ - */␊ - createdAt?: string␊ - /**␊ - * The identity that created the resource.␊ - */␊ - createdBy?: string␊ - /**␊ - * The type of identity that created the resource.␊ - */␊ - createdByType?: (("User" | "Application" | "ManagedIdentity" | "Key") | string)␊ - /**␊ - * The timestamp of resource last modification (UTC)␊ - */␊ - lastModifiedAt?: string␊ - /**␊ - * The identity that last modified the resource.␊ - */␊ - lastModifiedBy?: string␊ - /**␊ - * The type of identity that last modified the resource.␊ - */␊ - lastModifiedByType?: (("User" | "Application" | "ManagedIdentity" | "Key") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/hostingEnvironments␊ - */␊ - export interface HostingEnvironments6 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the App Service Environment.␊ - */␊ - name: string␊ - /**␊ - * Description of an App Service Environment.␊ - */␊ - properties: (AppServiceEnvironment5 | string)␊ - resources?: (HostingEnvironmentsMultiRolePoolsChildResource6 | HostingEnvironmentsWorkerPoolsChildResource6)[]␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/hostingEnvironments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of an App Service Environment.␊ - */␊ - export interface AppServiceEnvironment5 {␊ - /**␊ - * API Management Account associated with the App Service Environment.␊ - */␊ - apiManagementAccountId?: string␊ - /**␊ - * Custom settings for changing the behavior of the App Service Environment.␊ - */␊ - clusterSettings?: (NameValuePair8[] | string)␊ - /**␊ - * DNS suffix of the App Service Environment.␊ - */␊ - dnsSuffix?: string␊ - /**␊ - * True/false indicating whether the App Service Environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available␊ - * (most likely because NSG blocked the incoming traffic).␊ - */␊ - dynamicCacheEnabled?: (boolean | string)␊ - /**␊ - * Scale factor for front-ends.␊ - */␊ - frontEndScaleFactor?: (number | string)␊ - /**␊ - * Flag that displays whether an ASE has linux workers or not␊ - */␊ - hasLinuxWorkers?: (boolean | string)␊ - /**␊ - * Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.␊ - */␊ - internalLoadBalancingMode?: (("None" | "Web" | "Publishing" | "Web,Publishing") | string)␊ - /**␊ - * Number of IP SSL addresses reserved for the App Service Environment.␊ - */␊ - ipsslAddressCount?: (number | string)␊ - /**␊ - * Location of the App Service Environment, e.g. "West US".␊ - */␊ - location: string␊ - /**␊ - * Number of front-end instances.␊ - */␊ - multiRoleCount?: (number | string)␊ - /**␊ - * Front-end VM size, e.g. "Medium", "Large".␊ - */␊ - multiSize?: string␊ - /**␊ - * Name of the App Service Environment.␊ - */␊ - name: string␊ - /**␊ - * Access control list for controlling traffic to the App Service Environment.␊ - */␊ - networkAccessControlList?: (NetworkAccessControlEntry6[] | string)␊ - /**␊ - * Key Vault ID for ILB App Service Environment default SSL certificate␊ - */␊ - sslCertKeyVaultId?: string␊ - /**␊ - * Key Vault Secret Name for ILB App Service Environment default SSL certificate␊ - */␊ - sslCertKeyVaultSecretName?: string␊ - /**␊ - * true if the App Service Environment is suspended; otherwise, false. The environment can be suspended, e.g. when the management endpoint is no longer available␊ - * (most likely because NSG blocked the incoming traffic).␊ - */␊ - suspended?: (boolean | string)␊ - /**␊ - * User added ip ranges to whitelist on ASE db␊ - */␊ - userWhitelistedIpRanges?: (string[] | string)␊ - /**␊ - * Specification for using a Virtual Network.␊ - */␊ - virtualNetwork: (VirtualNetworkProfile9 | string)␊ - /**␊ - * Name of the Virtual Network for the App Service Environment.␊ - */␊ - vnetName?: string␊ - /**␊ - * Resource group of the Virtual Network.␊ - */␊ - vnetResourceGroupName?: string␊ - /**␊ - * Subnet of the Virtual Network.␊ - */␊ - vnetSubnetName?: string␊ - /**␊ - * Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool.␊ - */␊ - workerPools: (WorkerPool6[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Name value pair.␊ - */␊ - export interface NameValuePair8 {␊ - /**␊ - * Pair name.␊ - */␊ - name?: string␊ - /**␊ - * Pair value.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network access control entry.␊ - */␊ - export interface NetworkAccessControlEntry6 {␊ - /**␊ - * Action object.␊ - */␊ - action?: (("Permit" | "Deny") | string)␊ - /**␊ - * Description of network access control entry.␊ - */␊ - description?: string␊ - /**␊ - * Order of precedence.␊ - */␊ - order?: (number | string)␊ - /**␊ - * Remote subnet.␊ - */␊ - remoteSubnet?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specification for using a Virtual Network.␊ - */␊ - export interface VirtualNetworkProfile9 {␊ - /**␊ - * Resource id of the Virtual Network.␊ - */␊ - id?: string␊ - /**␊ - * Subnet within the Virtual Network.␊ - */␊ - subnet?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Worker pool of an App Service Environment.␊ - */␊ - export interface WorkerPool6 {␊ - /**␊ - * Shared or dedicated app hosting.␊ - */␊ - computeMode?: (("Shared" | "Dedicated" | "Dynamic") | string)␊ - /**␊ - * Number of instances in the worker pool.␊ - */␊ - workerCount?: (number | string)␊ - /**␊ - * VM size of the worker pool instances.␊ - */␊ - workerSize?: string␊ - /**␊ - * Worker size ID for referencing this worker pool.␊ - */␊ - workerSizeId?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/hostingEnvironments/multiRolePools␊ - */␊ - export interface HostingEnvironmentsMultiRolePoolsChildResource6 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "default"␊ - /**␊ - * Worker pool of an App Service Environment.␊ - */␊ - properties: (WorkerPool6 | string)␊ - /**␊ - * Description of a SKU for a scalable resource.␊ - */␊ - sku?: (SkuDescription8 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "multiRolePools"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a SKU for a scalable resource.␊ - */␊ - export interface SkuDescription8 {␊ - /**␊ - * Capabilities of the SKU, e.g., is traffic manager enabled?␊ - */␊ - capabilities?: (Capability6[] | string)␊ - /**␊ - * Current number of instances assigned to the resource.␊ - */␊ - capacity?: (number | string)␊ - /**␊ - * Family code of the resource SKU.␊ - */␊ - family?: string␊ - /**␊ - * Locations of the SKU.␊ - */␊ - locations?: (string[] | string)␊ - /**␊ - * Name of the resource SKU.␊ - */␊ - name?: string␊ - /**␊ - * Size specifier of the resource SKU.␊ - */␊ - size?: string␊ - /**␊ - * Description of the App Service plan scale options.␊ - */␊ - skuCapacity?: (SkuCapacity5 | string)␊ - /**␊ - * Service tier of the resource SKU.␊ - */␊ - tier?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the capabilities/features allowed for a specific SKU.␊ - */␊ - export interface Capability6 {␊ - /**␊ - * Name of the SKU capability.␊ - */␊ - name?: string␊ - /**␊ - * Reason of the SKU capability.␊ - */␊ - reason?: string␊ - /**␊ - * Value of the SKU capability.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of the App Service plan scale options.␊ - */␊ - export interface SkuCapacity5 {␊ - /**␊ - * Default number of workers for this App Service plan SKU.␊ - */␊ - default?: (number | string)␊ - /**␊ - * Maximum number of workers for this App Service plan SKU.␊ - */␊ - maximum?: (number | string)␊ - /**␊ - * Minimum number of workers for this App Service plan SKU.␊ - */␊ - minimum?: (number | string)␊ - /**␊ - * Available scale configurations for an App Service plan.␊ - */␊ - scaleType?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/hostingEnvironments/workerPools␊ - */␊ - export interface HostingEnvironmentsWorkerPoolsChildResource6 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the worker pool.␊ - */␊ - name: string␊ - /**␊ - * Worker pool of an App Service Environment.␊ - */␊ - properties: (WorkerPool6 | string)␊ - /**␊ - * Description of a SKU for a scalable resource.␊ - */␊ - sku?: (SkuDescription8 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "workerPools"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/hostingEnvironments/multiRolePools␊ - */␊ - export interface HostingEnvironmentsMultiRolePools6 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Worker pool of an App Service Environment.␊ - */␊ - properties: (WorkerPool6 | string)␊ - /**␊ - * Description of a SKU for a scalable resource.␊ - */␊ - sku?: (SkuDescription8 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "Microsoft.Web/hostingEnvironments/multiRolePools"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/hostingEnvironments/workerPools␊ - */␊ - export interface HostingEnvironmentsWorkerPools6 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the worker pool.␊ - */␊ - name: string␊ - /**␊ - * Worker pool of an App Service Environment.␊ - */␊ - properties: (WorkerPool6 | string)␊ - /**␊ - * Description of a SKU for a scalable resource.␊ - */␊ - sku?: (SkuDescription8 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "Microsoft.Web/hostingEnvironments/workerPools"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/serverfarms␊ - */␊ - export interface Serverfarms6 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the App Service plan.␊ - */␊ - name: string␊ - /**␊ - * AppServicePlan resource specific properties␊ - */␊ - properties: (AppServicePlanProperties5 | string)␊ - /**␊ - * Description of a SKU for a scalable resource.␊ - */␊ - sku?: (SkuDescription8 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/serverfarms"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AppServicePlan resource specific properties␊ - */␊ - export interface AppServicePlanProperties5 {␊ - /**␊ - * The time when the server farm free offer expires.␊ - */␊ - freeOfferExpirationTime?: string␊ - /**␊ - * Specification for an App Service Environment to use for this resource.␊ - */␊ - hostingEnvironmentProfile?: (HostingEnvironmentProfile8 | string)␊ - /**␊ - * If Hyper-V container app service plan true, false otherwise.␊ - */␊ - hyperV?: (boolean | string)␊ - /**␊ - * If true, this App Service Plan owns spot instances.␊ - */␊ - isSpot?: (boolean | string)␊ - /**␊ - * Obsolete: If Hyper-V container app service plan true, false otherwise.␊ - */␊ - isXenon?: (boolean | string)␊ - /**␊ - * Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan␊ - */␊ - maximumElasticWorkerCount?: (number | string)␊ - /**␊ - * 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.␊ - */␊ - perSiteScaling?: (boolean | string)␊ - /**␊ - * If Linux app service plan true, false otherwise.␊ - */␊ - reserved?: (boolean | string)␊ - /**␊ - * The time when the server farm expires. Valid only if it is a spot server farm.␊ - */␊ - spotExpirationTime?: string␊ - /**␊ - * Scaling worker count.␊ - */␊ - targetWorkerCount?: (number | string)␊ - /**␊ - * Scaling worker size ID.␊ - */␊ - targetWorkerSizeId?: (number | string)␊ - /**␊ - * Target worker tier assigned to the App Service plan.␊ - */␊ - workerTierName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specification for an App Service Environment to use for this resource.␊ - */␊ - export interface HostingEnvironmentProfile8 {␊ - /**␊ - * Resource ID of the App Service Environment.␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/serverfarms/virtualNetworkConnections/gateways␊ - */␊ - export interface ServerfarmsVirtualNetworkConnectionsGateways6 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the gateway. Only the 'primary' gateway is supported.␊ - */␊ - name: string␊ - /**␊ - * VnetGateway resource specific properties␊ - */␊ - properties: (VnetGatewayProperties8 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "Microsoft.Web/serverfarms/virtualNetworkConnections/gateways"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VnetGateway resource specific properties␊ - */␊ - export interface VnetGatewayProperties8 {␊ - /**␊ - * The Virtual Network name.␊ - */␊ - vnetName?: string␊ - /**␊ - * The URI where the VPN package can be downloaded.␊ - */␊ - vpnPackageUri: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/serverfarms/virtualNetworkConnections/routes␊ - */␊ - export interface ServerfarmsVirtualNetworkConnectionsRoutes6 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the Virtual Network route.␊ - */␊ - name: string␊ - /**␊ - * VnetRoute resource specific properties␊ - */␊ - properties: (VnetRouteProperties6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "Microsoft.Web/serverfarms/virtualNetworkConnections/routes"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VnetRoute resource specific properties␊ - */␊ - export interface VnetRouteProperties6 {␊ - /**␊ - * The ending address for this route. If the start address is specified in CIDR notation, this must be omitted.␊ - */␊ - endAddress?: string␊ - /**␊ - * 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.␊ - */␊ - routeType?: (("DEFAULT" | "INHERITED" | "STATIC") | string)␊ - /**␊ - * The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified.␊ - */␊ - startAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites␊ - */␊ - export interface Sites7 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Managed service identity.␊ - */␊ - identity?: (ManagedServiceIdentity20 | string)␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Unique name of the app to create or update. To create or update a deployment slot, use the {slot} parameter.␊ - */␊ - name: string␊ - /**␊ - * Site resource specific properties␊ - */␊ - properties: (SiteProperties7 | string)␊ - resources?: (SitesBasicPublishingCredentialsPoliciesChildResource3 | SitesConfigChildResource7 | SitesDeploymentsChildResource7 | SitesDomainOwnershipIdentifiersChildResource6 | SitesExtensionsChildResource6 | SitesFunctionsChildResource6 | SitesHostNameBindingsChildResource7 | SitesHybridconnectionChildResource7 | SitesMigrateChildResource6 | SitesNetworkConfigChildResource5 | SitesPremieraddonsChildResource7 | SitesPrivateAccessChildResource5 | SitesPublicCertificatesChildResource6 | SitesSiteextensionsChildResource6 | SitesSlotsChildResource7 | SitesPrivateEndpointConnectionsChildResource3 | SitesSourcecontrolsChildResource7 | SitesVirtualNetworkConnectionsChildResource7)[]␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/sites"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Managed service identity.␊ - */␊ - export interface ManagedServiceIdentity20 {␊ - /**␊ - * Type of managed service identity.␊ - */␊ - type?: (("SystemAssigned" | "UserAssigned" | "SystemAssigned, UserAssigned" | "None") | string)␊ - /**␊ - * The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}␊ - */␊ - userAssignedIdentities?: ({␊ - [k: string]: Components1Jq1T4Ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties6␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - export interface Components1Jq1T4Ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties6 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Site resource specific properties␊ - */␊ - export interface SiteProperties7 {␊ - /**␊ - * 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.␊ - */␊ - clientAffinityEnabled?: (boolean | string)␊ - /**␊ - * true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.␊ - */␊ - clientCertEnabled?: (boolean | string)␊ - /**␊ - * client certificate authentication comma-separated exclusion paths␊ - */␊ - clientCertExclusionPaths?: string␊ - /**␊ - * This composes with ClientCertEnabled setting.␊ - * - ClientCertEnabled: false means ClientCert is ignored.␊ - * - ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required.␊ - * - ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted.␊ - */␊ - clientCertMode?: (("Required" | "Optional") | string)␊ - /**␊ - * Information needed for cloning operation.␊ - */␊ - cloningInfo?: (CloningInfo7 | string)␊ - /**␊ - * Size of the function container.␊ - */␊ - containerSize?: (number | string)␊ - /**␊ - * Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification.␊ - */␊ - customDomainVerificationId?: string␊ - /**␊ - * Maximum allowed daily memory-time quota (applicable on dynamic apps only).␊ - */␊ - dailyMemoryTimeQuota?: (number | string)␊ - /**␊ - * true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Specification for an App Service Environment to use for this resource.␊ - */␊ - hostingEnvironmentProfile?: (HostingEnvironmentProfile8 | string)␊ - /**␊ - * true to disable the public hostnames of the app; otherwise, false.␊ - * If true, the app is only accessible via API management process.␊ - */␊ - hostNamesDisabled?: (boolean | string)␊ - /**␊ - * Hostname SSL states are used to manage the SSL bindings for app's hostnames.␊ - */␊ - hostNameSslStates?: (HostNameSslState7[] | string)␊ - /**␊ - * HttpsOnly: configures a web site to accept only https requests. Issues redirect for␊ - * http requests␊ - */␊ - httpsOnly?: (boolean | string)␊ - /**␊ - * Hyper-V sandbox.␊ - */␊ - hyperV?: (boolean | string)␊ - /**␊ - * Obsolete: Hyper-V sandbox.␊ - */␊ - isXenon?: (boolean | string)␊ - /**␊ - * Site redundancy mode.␊ - */␊ - redundancyMode?: (("None" | "Manual" | "Failover" | "ActiveActive" | "GeoRedundant") | string)␊ - /**␊ - * true if reserved; otherwise, false.␊ - */␊ - reserved?: (boolean | string)␊ - /**␊ - * true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.␊ - */␊ - scmSiteAlsoStopped?: (boolean | string)␊ - /**␊ - * Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".␊ - */␊ - serverFarmId?: string␊ - /**␊ - * Configuration of an App Service app.␊ - */␊ - siteConfig?: (SiteConfig7 | string)␊ - /**␊ - * Checks if Customer provided storage account is required␊ - */␊ - storageAccountRequired?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information needed for cloning operation.␊ - */␊ - export interface CloningInfo7 {␊ - /**␊ - * 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.␊ - */␊ - appSettingsOverrides?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * true to clone custom hostnames from source app; otherwise, false.␊ - */␊ - cloneCustomHostNames?: (boolean | string)␊ - /**␊ - * true to clone source control from source app; otherwise, false.␊ - */␊ - cloneSourceControl?: (boolean | string)␊ - /**␊ - * true to configure load balancing for source and destination app.␊ - */␊ - configureLoadBalancing?: (boolean | string)␊ - /**␊ - * Correlation ID of cloning operation. This ID ties multiple cloning operations␊ - * together to use the same snapshot.␊ - */␊ - correlationId?: string␊ - /**␊ - * App Service Environment.␊ - */␊ - hostingEnvironment?: string␊ - /**␊ - * true to overwrite destination app; otherwise, false.␊ - */␊ - overwrite?: (boolean | string)␊ - /**␊ - * 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.␊ - */␊ - sourceWebAppId: string␊ - /**␊ - * Location of source app ex: West US or North Europe␊ - */␊ - sourceWebAppLocation?: string␊ - /**␊ - * 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}.␊ - */␊ - trafficManagerProfileId?: string␊ - /**␊ - * Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist.␊ - */␊ - trafficManagerProfileName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSL-enabled hostname.␊ - */␊ - export interface HostNameSslState7 {␊ - /**␊ - * Indicates whether the hostname is a standard or repository hostname.␊ - */␊ - hostType?: (("Standard" | "Repository") | string)␊ - /**␊ - * Hostname.␊ - */␊ - name?: string␊ - /**␊ - * SSL type.␊ - */␊ - sslState?: (("Disabled" | "SniEnabled" | "IpBasedEnabled") | string)␊ - /**␊ - * SSL certificate thumbprint.␊ - */␊ - thumbprint?: string␊ - /**␊ - * Set to true to update existing hostname.␊ - */␊ - toUpdate?: (boolean | string)␊ - /**␊ - * Virtual IP address assigned to the hostname if IP based SSL is enabled.␊ - */␊ - virtualIP?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Configuration of an App Service app.␊ - */␊ - export interface SiteConfig7 {␊ - /**␊ - * Flag to use Managed Identity Creds for ACR pull␊ - */␊ - acrUseManagedIdentityCreds?: (boolean | string)␊ - /**␊ - * If using user managed identity, the user managed identity ClientId␊ - */␊ - acrUserManagedIdentityID?: string␊ - /**␊ - * true if Always On is enabled; otherwise, false.␊ - */␊ - alwaysOn?: (boolean | string)␊ - /**␊ - * Information about the formal API definition for the app.␊ - */␊ - apiDefinition?: (ApiDefinitionInfo7 | string)␊ - /**␊ - * Azure API management (APIM) configuration linked to the app.␊ - */␊ - apiManagementConfig?: (ApiManagementConfig3 | string)␊ - /**␊ - * App command line to launch.␊ - */␊ - appCommandLine?: string␊ - /**␊ - * Application settings.␊ - */␊ - appSettings?: (NameValuePair8[] | string)␊ - /**␊ - * true if Auto Heal is enabled; otherwise, false.␊ - */␊ - autoHealEnabled?: (boolean | string)␊ - /**␊ - * Rules that can be defined for auto-heal.␊ - */␊ - autoHealRules?: (AutoHealRules7 | string)␊ - /**␊ - * Auto-swap slot name.␊ - */␊ - autoSwapSlotName?: string␊ - /**␊ - * Connection strings.␊ - */␊ - connectionStrings?: (ConnStringInfo7[] | string)␊ - /**␊ - * Cross-Origin Resource Sharing (CORS) settings for the app.␊ - */␊ - cors?: (CorsSettings7 | string)␊ - /**␊ - * Default documents.␊ - */␊ - defaultDocuments?: (string[] | string)␊ - /**␊ - * true if detailed error logging is enabled; otherwise, false.␊ - */␊ - detailedErrorLoggingEnabled?: (boolean | string)␊ - /**␊ - * Document root.␊ - */␊ - documentRoot?: string␊ - /**␊ - * Routing rules in production experiments.␊ - */␊ - experiments?: (Experiments7 | string)␊ - /**␊ - * State of FTP / FTPS service.␊ - */␊ - ftpsState?: (("AllAllowed" | "FtpsOnly" | "Disabled") | string)␊ - /**␊ - * Handler mappings.␊ - */␊ - handlerMappings?: (HandlerMapping7[] | string)␊ - /**␊ - * Health check path␊ - */␊ - healthCheckPath?: string␊ - /**␊ - * Http20Enabled: configures a web site to allow clients to connect over http2.0␊ - */␊ - http20Enabled?: (boolean | string)␊ - /**␊ - * true if HTTP logging is enabled; otherwise, false.␊ - */␊ - httpLoggingEnabled?: (boolean | string)␊ - /**␊ - * IP security restrictions for main.␊ - */␊ - ipSecurityRestrictions?: (IpSecurityRestriction7[] | string)␊ - /**␊ - * Java container.␊ - */␊ - javaContainer?: string␊ - /**␊ - * Java container version.␊ - */␊ - javaContainerVersion?: string␊ - /**␊ - * Java version.␊ - */␊ - javaVersion?: string␊ - /**␊ - * Metric limits set on an app.␊ - */␊ - limits?: (SiteLimits7 | string)␊ - /**␊ - * Linux App Framework and version␊ - */␊ - linuxFxVersion?: string␊ - /**␊ - * Site load balancing.␊ - */␊ - loadBalancing?: (("WeightedRoundRobin" | "LeastRequests" | "LeastResponseTime" | "WeightedTotalTraffic" | "RequestHash") | string)␊ - /**␊ - * true to enable local MySQL; otherwise, false.␊ - */␊ - localMySqlEnabled?: (boolean | string)␊ - /**␊ - * HTTP logs directory size limit.␊ - */␊ - logsDirectorySizeLimit?: (number | string)␊ - /**␊ - * Managed pipeline mode.␊ - */␊ - managedPipelineMode?: (("Integrated" | "Classic") | string)␊ - /**␊ - * Managed Service Identity Id␊ - */␊ - managedServiceIdentityId?: (number | string)␊ - /**␊ - * MinTlsVersion: configures the minimum version of TLS required for SSL requests.␊ - */␊ - minTlsVersion?: (("1.0" | "1.1" | "1.2") | string)␊ - /**␊ - * .NET Framework version.␊ - */␊ - netFrameworkVersion?: string␊ - /**␊ - * Version of Node.js.␊ - */␊ - nodeVersion?: string␊ - /**␊ - * Number of workers.␊ - */␊ - numberOfWorkers?: (number | string)␊ - /**␊ - * Version of PHP.␊ - */␊ - phpVersion?: string␊ - /**␊ - * Version of PowerShell.␊ - */␊ - powerShellVersion?: string␊ - /**␊ - * Number of preWarmed instances.␊ - * This setting only applies to the Consumption and Elastic Plans␊ - */␊ - preWarmedInstanceCount?: (number | string)␊ - /**␊ - * Publishing user name.␊ - */␊ - publishingUsername?: string␊ - /**␊ - * Push settings for the App.␊ - */␊ - push?: (PushSettings6 | string)␊ - /**␊ - * Version of Python.␊ - */␊ - pythonVersion?: string␊ - /**␊ - * true if remote debugging is enabled; otherwise, false.␊ - */␊ - remoteDebuggingEnabled?: (boolean | string)␊ - /**␊ - * Remote debugging version.␊ - */␊ - remoteDebuggingVersion?: string␊ - /**␊ - * true if request tracing is enabled; otherwise, false.␊ - */␊ - requestTracingEnabled?: (boolean | string)␊ - /**␊ - * Request tracing expiration time.␊ - */␊ - requestTracingExpirationTime?: string␊ - /**␊ - * IP security restrictions for scm.␊ - */␊ - scmIpSecurityRestrictions?: (IpSecurityRestriction7[] | string)␊ - /**␊ - * IP security restrictions for scm to use main.␊ - */␊ - scmIpSecurityRestrictionsUseMain?: (boolean | string)␊ - /**␊ - * ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site.␊ - */␊ - scmMinTlsVersion?: (("1.0" | "1.1" | "1.2") | string)␊ - /**␊ - * SCM type.␊ - */␊ - scmType?: (("None" | "Dropbox" | "Tfs" | "LocalGit" | "GitHub" | "CodePlexGit" | "CodePlexHg" | "BitbucketGit" | "BitbucketHg" | "ExternalGit" | "ExternalHg" | "OneDrive" | "VSO" | "VSTSRM") | string)␊ - /**␊ - * Tracing options.␊ - */␊ - tracingOptions?: string␊ - /**␊ - * true to use 32-bit worker process; otherwise, false.␊ - */␊ - use32BitWorkerProcess?: (boolean | string)␊ - /**␊ - * Virtual applications.␊ - */␊ - virtualApplications?: (VirtualApplication7[] | string)␊ - /**␊ - * Virtual Network name.␊ - */␊ - vnetName?: string␊ - /**␊ - * The number of private ports assigned to this app. These will be assigned dynamically on runtime.␊ - */␊ - vnetPrivatePortsCount?: (number | string)␊ - /**␊ - * Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied.␊ - */␊ - vnetRouteAllEnabled?: (boolean | string)␊ - /**␊ - * true if WebSocket is enabled; otherwise, false.␊ - */␊ - webSocketsEnabled?: (boolean | string)␊ - /**␊ - * Xenon App Framework and version␊ - */␊ - windowsFxVersion?: string␊ - /**␊ - * Explicit Managed Service Identity Id␊ - */␊ - xManagedServiceIdentityId?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the formal API definition for the app.␊ - */␊ - export interface ApiDefinitionInfo7 {␊ - /**␊ - * The URL of the API definition.␊ - */␊ - url?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure API management (APIM) configuration linked to the app.␊ - */␊ - export interface ApiManagementConfig3 {␊ - /**␊ - * APIM-Api Identifier.␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Rules that can be defined for auto-heal.␊ - */␊ - export interface AutoHealRules7 {␊ - /**␊ - * Actions which to take by the auto-heal module when a rule is triggered.␊ - */␊ - actions?: (AutoHealActions7 | string)␊ - /**␊ - * Triggers for auto-heal.␊ - */␊ - triggers?: (AutoHealTriggers7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Actions which to take by the auto-heal module when a rule is triggered.␊ - */␊ - export interface AutoHealActions7 {␊ - /**␊ - * Predefined action to be taken.␊ - */␊ - actionType?: (("Recycle" | "LogEvent" | "CustomAction") | string)␊ - /**␊ - * Custom action to be executed␊ - * when an auto heal rule is triggered.␊ - */␊ - customAction?: (AutoHealCustomAction7 | string)␊ - /**␊ - * Minimum time the process must execute␊ - * before taking the action␊ - */␊ - minProcessExecutionTime?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Custom action to be executed␊ - * when an auto heal rule is triggered.␊ - */␊ - export interface AutoHealCustomAction7 {␊ - /**␊ - * Executable to be run.␊ - */␊ - exe?: string␊ - /**␊ - * Parameters for the executable.␊ - */␊ - parameters?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Triggers for auto-heal.␊ - */␊ - export interface AutoHealTriggers7 {␊ - /**␊ - * A rule based on private bytes.␊ - */␊ - privateBytesInKB?: (number | string)␊ - /**␊ - * Trigger based on total requests.␊ - */␊ - requests?: (RequestsBasedTrigger7 | string)␊ - /**␊ - * Trigger based on request execution time.␊ - */␊ - slowRequests?: (SlowRequestsBasedTrigger7 | string)␊ - /**␊ - * A rule based on status codes.␊ - */␊ - statusCodes?: (StatusCodesBasedTrigger7[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trigger based on total requests.␊ - */␊ - export interface RequestsBasedTrigger7 {␊ - /**␊ - * Request Count.␊ - */␊ - count?: (number | string)␊ - /**␊ - * Time interval.␊ - */␊ - timeInterval?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trigger based on request execution time.␊ - */␊ - export interface SlowRequestsBasedTrigger7 {␊ - /**␊ - * Request Count.␊ - */␊ - count?: (number | string)␊ - /**␊ - * Time interval.␊ - */␊ - timeInterval?: string␊ - /**␊ - * Time taken.␊ - */␊ - timeTaken?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trigger based on status code.␊ - */␊ - export interface StatusCodesBasedTrigger7 {␊ - /**␊ - * Request Count.␊ - */␊ - count?: (number | string)␊ - /**␊ - * HTTP status code.␊ - */␊ - status?: (number | string)␊ - /**␊ - * Request Sub Status.␊ - */␊ - subStatus?: (number | string)␊ - /**␊ - * Time interval.␊ - */␊ - timeInterval?: string␊ - /**␊ - * Win32 error code.␊ - */␊ - win32Status?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Database connection string information.␊ - */␊ - export interface ConnStringInfo7 {␊ - /**␊ - * Connection string value.␊ - */␊ - connectionString?: string␊ - /**␊ - * Name of connection string.␊ - */␊ - name?: string␊ - /**␊ - * Type of database.␊ - */␊ - type?: (("MySql" | "SQLServer" | "SQLAzure" | "Custom" | "NotificationHub" | "ServiceBus" | "EventHub" | "ApiHub" | "DocDb" | "RedisCache" | "PostgreSQL") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Cross-Origin Resource Sharing (CORS) settings for the app.␊ - */␊ - export interface CorsSettings7 {␊ - /**␊ - * 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.␊ - */␊ - allowedOrigins?: (string[] | string)␊ - /**␊ - * Gets or sets whether CORS requests with credentials are allowed. See ␊ - * https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials␊ - * for more details.␊ - */␊ - supportCredentials?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Routing rules in production experiments.␊ - */␊ - export interface Experiments7 {␊ - /**␊ - * List of ramp-up rules.␊ - */␊ - rampUpRules?: (RampUpRule7[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance.␊ - */␊ - export interface RampUpRule7 {␊ - /**␊ - * Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.␊ - */␊ - actionHostName?: string␊ - /**␊ - * 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/␊ - */␊ - changeDecisionCallbackUrl?: string␊ - /**␊ - * Specifies interval in minutes to reevaluate ReroutePercentage.␊ - */␊ - changeIntervalInMinutes?: (number | string)␊ - /**␊ - * In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \\nMinReroutePercentage or ␊ - * MaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\\nCustom decision algorithm ␊ - * can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl.␊ - */␊ - changeStep?: (number | string)␊ - /**␊ - * Specifies upper boundary below which ReroutePercentage will stay.␊ - */␊ - maxReroutePercentage?: (number | string)␊ - /**␊ - * Specifies lower boundary above which ReroutePercentage will stay.␊ - */␊ - minReroutePercentage?: (number | string)␊ - /**␊ - * Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment.␊ - */␊ - name?: string␊ - /**␊ - * Percentage of the traffic which will be redirected to ActionHostName.␊ - */␊ - reroutePercentage?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * 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.␊ - */␊ - export interface HandlerMapping7 {␊ - /**␊ - * Command-line arguments to be passed to the script processor.␊ - */␊ - arguments?: string␊ - /**␊ - * Requests with this extension will be handled using the specified FastCGI application.␊ - */␊ - extension?: string␊ - /**␊ - * The absolute path to the FastCGI application.␊ - */␊ - scriptProcessor?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP security restriction on an app.␊ - */␊ - export interface IpSecurityRestriction7 {␊ - /**␊ - * Allow or Deny access for this IP range.␊ - */␊ - action?: string␊ - /**␊ - * IP restriction rule description.␊ - */␊ - description?: string␊ - /**␊ - * IP restriction rule headers.␊ - * X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). ␊ - * The matching logic is ..␊ - * - If the property is null or empty (default), all hosts(or lack of) are allowed.␊ - * - A value is compared using ordinal-ignore-case (excluding port number).␊ - * - Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com␊ - * but not the root domain contoso.com or multi-level foo.bar.contoso.com␊ - * - Unicode host names are allowed but are converted to Punycode for matching.␊ - * ␊ - * X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples).␊ - * The matching logic is ..␊ - * - If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed.␊ - * - If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property.␊ - * ␊ - * X-Azure-FDID and X-FD-HealthProbe.␊ - * The matching logic is exact match.␊ - */␊ - headers?: ({␊ - [k: string]: string[]␊ - } | string)␊ - /**␊ - * IP address the security restriction is valid for.␊ - * It can be in form of pure ipv4 address (required SubnetMask property) or␊ - * CIDR notation such as ipv4/mask (leading bit match). For CIDR,␊ - * SubnetMask property must not be specified.␊ - */␊ - ipAddress?: string␊ - /**␊ - * IP restriction rule name.␊ - */␊ - name?: string␊ - /**␊ - * Priority of IP restriction rule.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * Subnet mask for the range of IP addresses the restriction is valid for.␊ - */␊ - subnetMask?: string␊ - /**␊ - * (internal) Subnet traffic tag␊ - */␊ - subnetTrafficTag?: (number | string)␊ - /**␊ - * Defines what this IP filter will be used for. This is to support IP filtering on proxies.␊ - */␊ - tag?: (("Default" | "XffProxy" | "ServiceTag") | string)␊ - /**␊ - * Virtual network resource id␊ - */␊ - vnetSubnetResourceId?: string␊ - /**␊ - * (internal) Vnet traffic tag␊ - */␊ - vnetTrafficTag?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Metric limits set on an app.␊ - */␊ - export interface SiteLimits7 {␊ - /**␊ - * Maximum allowed disk size usage in MB.␊ - */␊ - maxDiskSizeInMb?: (number | string)␊ - /**␊ - * Maximum allowed memory usage in MB.␊ - */␊ - maxMemoryInMb?: (number | string)␊ - /**␊ - * Maximum allowed CPU usage percentage.␊ - */␊ - maxPercentageCpu?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Push settings for the App.␊ - */␊ - export interface PushSettings6 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * PushSettings resource specific properties␊ - */␊ - properties?: (PushSettingsProperties6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * PushSettings resource specific properties␊ - */␊ - export interface PushSettingsProperties6 {␊ - /**␊ - * Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint.␊ - */␊ - dynamicTagsJson?: string␊ - /**␊ - * Gets or sets a flag indicating whether the Push endpoint is enabled.␊ - */␊ - isPushEnabled: (boolean | string)␊ - /**␊ - * 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.␊ - */␊ - tagsRequiringAuth?: string␊ - /**␊ - * Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.␊ - */␊ - tagWhitelistJson?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Virtual application in an app.␊ - */␊ - export interface VirtualApplication7 {␊ - /**␊ - * Physical path.␊ - */␊ - physicalPath?: string␊ - /**␊ - * true if preloading is enabled; otherwise, false.␊ - */␊ - preloadEnabled?: (boolean | string)␊ - /**␊ - * Virtual directories for virtual application.␊ - */␊ - virtualDirectories?: (VirtualDirectory7[] | string)␊ - /**␊ - * Virtual path.␊ - */␊ - virtualPath?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Directory for virtual application.␊ - */␊ - export interface VirtualDirectory7 {␊ - /**␊ - * Physical path.␊ - */␊ - physicalPath?: string␊ - /**␊ - * Path to virtual application.␊ - */␊ - virtualPath?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * CsmPublishingCredentialsPoliciesEntity resource specific properties␊ - */␊ - export interface CsmPublishingCredentialsPoliciesEntityProperties3 {␊ - /**␊ - * true to allow access to a publishing method; otherwise, false.␊ - */␊ - allow: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SiteAuthSettings resource specific properties␊ - */␊ - export interface SiteAuthSettingsProperties6 {␊ - /**␊ - * Gets a JSON string containing the Azure AD Acl settings.␊ - */␊ - aadClaimsAuthorization?: string␊ - /**␊ - * Login parameters to send to the OpenID Connect authorization endpoint when␊ - * a user logs in. Each parameter must be in the form "key=value".␊ - */␊ - additionalLoginParams?: (string[] | string)␊ - /**␊ - * 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.␊ - */␊ - allowedAudiences?: (string[] | string)␊ - /**␊ - * 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.␊ - */␊ - allowedExternalRedirectUrls?: (string[] | string)␊ - /**␊ - * The path of the config file containing auth settings.␊ - * If the path is relative, base will the site's root directory.␊ - */␊ - authFilePath?: string␊ - /**␊ - * 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␊ - */␊ - clientId?: string␊ - /**␊ - * 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␊ - */␊ - clientSecret?: string␊ - /**␊ - * An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as␊ - * a replacement for the Client Secret. It is also optional.␊ - */␊ - clientSecretCertificateThumbprint?: string␊ - /**␊ - * The app setting name that contains the client secret of the relying party application.␊ - */␊ - clientSecretSettingName?: string␊ - /**␊ - * 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".␊ - */␊ - defaultProvider?: (("AzureActiveDirectory" | "Facebook" | "Google" | "MicrosoftAccount" | "Twitter" | "Github") | string)␊ - /**␊ - * true if the Authentication / Authorization feature is enabled for the current app; otherwise, false.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * 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␊ - */␊ - facebookAppId?: string␊ - /**␊ - * 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␊ - */␊ - facebookAppSecret?: string␊ - /**␊ - * The app setting name that contains the app secret used for Facebook Login.␊ - */␊ - facebookAppSecretSettingName?: string␊ - /**␊ - * 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␊ - */␊ - facebookOAuthScopes?: (string[] | string)␊ - /**␊ - * The Client Id of the GitHub app used for login.␊ - * This setting is required for enabling Github login␊ - */␊ - gitHubClientId?: string␊ - /**␊ - * The Client Secret of the GitHub app used for Github Login.␊ - * This setting is required for enabling Github login.␊ - */␊ - gitHubClientSecret?: string␊ - /**␊ - * The app setting name that contains the client secret of the Github␊ - * app used for GitHub Login.␊ - */␊ - gitHubClientSecretSettingName?: string␊ - /**␊ - * The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication.␊ - * This setting is optional␊ - */␊ - gitHubOAuthScopes?: (string[] | string)␊ - /**␊ - * 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/␊ - */␊ - googleClientId?: string␊ - /**␊ - * 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/␊ - */␊ - googleClientSecret?: string␊ - /**␊ - * The app setting name that contains the client secret associated with ␊ - * the Google web application.␊ - */␊ - googleClientSecretSettingName?: string␊ - /**␊ - * 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/␊ - */␊ - googleOAuthScopes?: (string[] | string)␊ - /**␊ - * "true" if the auth config settings should be read from a file,␊ - * "false" otherwise␊ - */␊ - isAuthFromFile?: string␊ - /**␊ - * 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␊ - */␊ - issuer?: string␊ - /**␊ - * 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␊ - */␊ - microsoftAccountClientId?: string␊ - /**␊ - * 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␊ - */␊ - microsoftAccountClientSecret?: string␊ - /**␊ - * The app setting name containing the OAuth 2.0 client secret that was created for the␊ - * app used for authentication.␊ - */␊ - microsoftAccountClientSecretSettingName?: string␊ - /**␊ - * 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␊ - */␊ - microsoftAccountOAuthScopes?: (string[] | string)␊ - /**␊ - * 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.␊ - */␊ - runtimeVersion?: string␊ - /**␊ - * 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.␊ - */␊ - tokenRefreshExtensionHours?: (number | string)␊ - /**␊ - * true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.␊ - * The default is false.␊ - */␊ - tokenStoreEnabled?: (boolean | string)␊ - /**␊ - * 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␊ - */␊ - twitterConsumerKey?: string␊ - /**␊ - * 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␊ - */␊ - twitterConsumerSecret?: string␊ - /**␊ - * The app setting name that contains the OAuth 1.0a consumer secret of the Twitter␊ - * application used for sign-in.␊ - */␊ - twitterConsumerSecretSettingName?: string␊ - /**␊ - * The action to take when an unauthenticated client attempts to access the app.␊ - */␊ - unauthenticatedClientAction?: (("RedirectToLoginPage" | "AllowAnonymous") | string)␊ - /**␊ - * Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such.␊ - */␊ - validateIssuer?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SiteAuthSettingsV2 resource specific properties␊ - */␊ - export interface SiteAuthSettingsV2Properties2 {␊ - globalValidation?: (GlobalValidation2 | string)␊ - httpSettings?: (HttpSettings2 | string)␊ - identityProviders?: (IdentityProviders2 | string)␊ - login?: (Login2 | string)␊ - platform?: (AuthPlatform2 | string)␊ - [k: string]: unknown␊ - }␊ - export interface GlobalValidation2 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * GlobalValidation resource specific properties␊ - */␊ - properties?: (GlobalValidationProperties2 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * GlobalValidation resource specific properties␊ - */␊ - export interface GlobalValidationProperties2 {␊ - excludedPaths?: (string[] | string)␊ - redirectToProvider?: string␊ - requireAuthentication?: (boolean | string)␊ - unauthenticatedClientAction?: (("RedirectToLoginPage" | "AllowAnonymous" | "Return401" | "Return403") | string)␊ - [k: string]: unknown␊ - }␊ - export interface HttpSettings2 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * HttpSettings resource specific properties␊ - */␊ - properties?: (HttpSettingsProperties2 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HttpSettings resource specific properties␊ - */␊ - export interface HttpSettingsProperties2 {␊ - forwardProxy?: (ForwardProxy2 | string)␊ - requireHttps?: (boolean | string)␊ - routes?: (HttpSettingsRoutes2 | string)␊ - [k: string]: unknown␊ - }␊ - export interface ForwardProxy2 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * ForwardProxy resource specific properties␊ - */␊ - properties?: (ForwardProxyProperties2 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ForwardProxy resource specific properties␊ - */␊ - export interface ForwardProxyProperties2 {␊ - convention?: (("NoProxy" | "Standard" | "Custom") | string)␊ - customHostHeaderName?: string␊ - customProtoHeaderName?: string␊ - [k: string]: unknown␊ - }␊ - export interface HttpSettingsRoutes2 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * HttpSettingsRoutes resource specific properties␊ - */␊ - properties?: (HttpSettingsRoutesProperties2 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HttpSettingsRoutes resource specific properties␊ - */␊ - export interface HttpSettingsRoutesProperties2 {␊ - apiPrefix?: string␊ - [k: string]: unknown␊ - }␊ - export interface IdentityProviders2 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * IdentityProviders resource specific properties␊ - */␊ - properties?: (IdentityProvidersProperties2 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IdentityProviders resource specific properties␊ - */␊ - export interface IdentityProvidersProperties2 {␊ - azureActiveDirectory?: (AzureActiveDirectory7 | string)␊ - customOpenIdConnectProviders?: ({␊ - [k: string]: CustomOpenIdConnectProvider2␊ - } | string)␊ - facebook?: (Facebook2 | string)␊ - gitHub?: (GitHub2 | string)␊ - google?: (Google2 | string)␊ - twitter?: (Twitter2 | string)␊ - [k: string]: unknown␊ - }␊ - export interface AzureActiveDirectory7 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * AzureActiveDirectory resource specific properties␊ - */␊ - properties?: (AzureActiveDirectoryProperties2 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AzureActiveDirectory resource specific properties␊ - */␊ - export interface AzureActiveDirectoryProperties2 {␊ - enabled?: (boolean | string)␊ - isAutoProvisioned?: (boolean | string)␊ - login?: (AzureActiveDirectoryLogin2 | string)␊ - registration?: (AzureActiveDirectoryRegistration2 | string)␊ - validation?: (AzureActiveDirectoryValidation2 | string)␊ - [k: string]: unknown␊ - }␊ - export interface AzureActiveDirectoryLogin2 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * AzureActiveDirectoryLogin resource specific properties␊ - */␊ - properties?: (AzureActiveDirectoryLoginProperties2 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AzureActiveDirectoryLogin resource specific properties␊ - */␊ - export interface AzureActiveDirectoryLoginProperties2 {␊ - disableWWWAuthenticate?: (boolean | string)␊ - loginParameters?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - export interface AzureActiveDirectoryRegistration2 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * AzureActiveDirectoryRegistration resource specific properties␊ - */␊ - properties?: (AzureActiveDirectoryRegistrationProperties2 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AzureActiveDirectoryRegistration resource specific properties␊ - */␊ - export interface AzureActiveDirectoryRegistrationProperties2 {␊ - clientId?: string␊ - clientSecretCertificateThumbprint?: string␊ - clientSecretSettingName?: string␊ - openIdIssuer?: string␊ - [k: string]: unknown␊ - }␊ - export interface AzureActiveDirectoryValidation2 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * AzureActiveDirectoryValidation resource specific properties␊ - */␊ - properties?: (AzureActiveDirectoryValidationProperties2 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AzureActiveDirectoryValidation resource specific properties␊ - */␊ - export interface AzureActiveDirectoryValidationProperties2 {␊ - allowedAudiences?: (string[] | string)␊ - jwtClaimChecks?: (JwtClaimChecks2 | string)␊ - [k: string]: unknown␊ - }␊ - export interface JwtClaimChecks2 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * JwtClaimChecks resource specific properties␊ - */␊ - properties?: (JwtClaimChecksProperties2 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * JwtClaimChecks resource specific properties␊ - */␊ - export interface JwtClaimChecksProperties2 {␊ - allowedClientApplications?: (string[] | string)␊ - allowedGroups?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - export interface CustomOpenIdConnectProvider2 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * CustomOpenIdConnectProvider resource specific properties␊ - */␊ - properties?: (CustomOpenIdConnectProviderProperties2 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * CustomOpenIdConnectProvider resource specific properties␊ - */␊ - export interface CustomOpenIdConnectProviderProperties2 {␊ - enabled?: (boolean | string)␊ - login?: (OpenIdConnectLogin2 | string)␊ - registration?: (OpenIdConnectRegistration2 | string)␊ - [k: string]: unknown␊ - }␊ - export interface OpenIdConnectLogin2 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * OpenIdConnectLogin resource specific properties␊ - */␊ - properties?: (OpenIdConnectLoginProperties2 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * OpenIdConnectLogin resource specific properties␊ - */␊ - export interface OpenIdConnectLoginProperties2 {␊ - nameClaimType?: string␊ - scopes?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - export interface OpenIdConnectRegistration2 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * OpenIdConnectRegistration resource specific properties␊ - */␊ - properties?: (OpenIdConnectRegistrationProperties2 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * OpenIdConnectRegistration resource specific properties␊ - */␊ - export interface OpenIdConnectRegistrationProperties2 {␊ - clientCredential?: (OpenIdConnectClientCredential2 | string)␊ - clientId?: string␊ - openIdConnectConfiguration?: (OpenIdConnectConfig2 | string)␊ - [k: string]: unknown␊ - }␊ - export interface OpenIdConnectClientCredential2 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * OpenIdConnectClientCredential resource specific properties␊ - */␊ - properties?: (OpenIdConnectClientCredentialProperties2 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * OpenIdConnectClientCredential resource specific properties␊ - */␊ - export interface OpenIdConnectClientCredentialProperties2 {␊ - clientSecretSettingName?: string␊ - method?: ("ClientSecretPost" | string)␊ - [k: string]: unknown␊ - }␊ - export interface OpenIdConnectConfig2 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * OpenIdConnectConfig resource specific properties␊ - */␊ - properties?: (OpenIdConnectConfigProperties2 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * OpenIdConnectConfig resource specific properties␊ - */␊ - export interface OpenIdConnectConfigProperties2 {␊ - authorizationEndpoint?: string␊ - certificationUri?: string␊ - issuer?: string␊ - tokenEndpoint?: string␊ - wellKnownOpenIdConfiguration?: string␊ - [k: string]: unknown␊ - }␊ - export interface Facebook2 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Facebook resource specific properties␊ - */␊ - properties?: (FacebookProperties2 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Facebook resource specific properties␊ - */␊ - export interface FacebookProperties2 {␊ - enabled?: (boolean | string)␊ - graphApiVersion?: string␊ - login?: (LoginScopes2 | string)␊ - registration?: (AppRegistration2 | string)␊ - [k: string]: unknown␊ - }␊ - export interface LoginScopes2 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * LoginScopes resource specific properties␊ - */␊ - properties?: (LoginScopesProperties2 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * LoginScopes resource specific properties␊ - */␊ - export interface LoginScopesProperties2 {␊ - scopes?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - export interface AppRegistration2 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * AppRegistration resource specific properties␊ - */␊ - properties?: (AppRegistrationProperties2 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AppRegistration resource specific properties␊ - */␊ - export interface AppRegistrationProperties2 {␊ - appId?: string␊ - appSecretSettingName?: string␊ - [k: string]: unknown␊ - }␊ - export interface GitHub2 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * GitHub resource specific properties␊ - */␊ - properties?: (GitHubProperties2 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * GitHub resource specific properties␊ - */␊ - export interface GitHubProperties2 {␊ - enabled?: (boolean | string)␊ - login?: (LoginScopes2 | string)␊ - registration?: (ClientRegistration2 | string)␊ - [k: string]: unknown␊ - }␊ - export interface ClientRegistration2 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * ClientRegistration resource specific properties␊ - */␊ - properties?: (ClientRegistrationProperties2 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * ClientRegistration resource specific properties␊ - */␊ - export interface ClientRegistrationProperties2 {␊ - clientId?: string␊ - clientSecretSettingName?: string␊ - [k: string]: unknown␊ - }␊ - export interface Google2 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Google resource specific properties␊ - */␊ - properties?: (GoogleProperties2 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Google resource specific properties␊ - */␊ - export interface GoogleProperties2 {␊ - enabled?: (boolean | string)␊ - login?: (LoginScopes2 | string)␊ - registration?: (ClientRegistration2 | string)␊ - validation?: (AllowedAudiencesValidation2 | string)␊ - [k: string]: unknown␊ - }␊ - export interface AllowedAudiencesValidation2 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * AllowedAudiencesValidation resource specific properties␊ - */␊ - properties?: (AllowedAudiencesValidationProperties2 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AllowedAudiencesValidation resource specific properties␊ - */␊ - export interface AllowedAudiencesValidationProperties2 {␊ - allowedAudiences?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - export interface Twitter2 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Twitter resource specific properties␊ - */␊ - properties?: (TwitterProperties2 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Twitter resource specific properties␊ - */␊ - export interface TwitterProperties2 {␊ - enabled?: (boolean | string)␊ - registration?: (TwitterRegistration2 | string)␊ - [k: string]: unknown␊ - }␊ - export interface TwitterRegistration2 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * TwitterRegistration resource specific properties␊ - */␊ - properties?: (TwitterRegistrationProperties2 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * TwitterRegistration resource specific properties␊ - */␊ - export interface TwitterRegistrationProperties2 {␊ - consumerKey?: string␊ - consumerSecretSettingName?: string␊ - [k: string]: unknown␊ - }␊ - export interface Login2 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Login resource specific properties␊ - */␊ - properties?: (LoginProperties2 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Login resource specific properties␊ - */␊ - export interface LoginProperties2 {␊ - allowedExternalRedirectUrls?: (string[] | string)␊ - cookieExpiration?: (CookieExpiration2 | string)␊ - nonce?: (Nonce2 | string)␊ - preserveUrlFragmentsForLogins?: (boolean | string)␊ - routes?: (LoginRoutes2 | string)␊ - tokenStore?: (TokenStore2 | string)␊ - [k: string]: unknown␊ - }␊ - export interface CookieExpiration2 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * CookieExpiration resource specific properties␊ - */␊ - properties?: (CookieExpirationProperties2 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * CookieExpiration resource specific properties␊ - */␊ - export interface CookieExpirationProperties2 {␊ - convention?: (("FixedTime" | "IdentityProviderDerived") | string)␊ - timeToExpiration?: string␊ - [k: string]: unknown␊ - }␊ - export interface Nonce2 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Nonce resource specific properties␊ - */␊ - properties?: (NonceProperties2 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Nonce resource specific properties␊ - */␊ - export interface NonceProperties2 {␊ - nonceExpirationInterval?: string␊ - validateNonce?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - export interface LoginRoutes2 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * LoginRoutes resource specific properties␊ - */␊ - properties?: (LoginRoutesProperties2 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * LoginRoutes resource specific properties␊ - */␊ - export interface LoginRoutesProperties2 {␊ - logoutEndpoint?: string␊ - [k: string]: unknown␊ - }␊ - export interface TokenStore2 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * TokenStore resource specific properties␊ - */␊ - properties?: (TokenStoreProperties2 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * TokenStore resource specific properties␊ - */␊ - export interface TokenStoreProperties2 {␊ - azureBlobStorage?: (BlobStorageTokenStore2 | string)␊ - enabled?: (boolean | string)␊ - fileSystem?: (FileSystemTokenStore2 | string)␊ - tokenRefreshExtensionHours?: (number | string)␊ - [k: string]: unknown␊ - }␊ - export interface BlobStorageTokenStore2 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * BlobStorageTokenStore resource specific properties␊ - */␊ - properties?: (BlobStorageTokenStoreProperties2 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * BlobStorageTokenStore resource specific properties␊ - */␊ - export interface BlobStorageTokenStoreProperties2 {␊ - sasUrlSettingName?: string␊ - [k: string]: unknown␊ - }␊ - export interface FileSystemTokenStore2 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * FileSystemTokenStore resource specific properties␊ - */␊ - properties?: (FileSystemTokenStoreProperties2 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * FileSystemTokenStore resource specific properties␊ - */␊ - export interface FileSystemTokenStoreProperties2 {␊ - directory?: string␊ - [k: string]: unknown␊ - }␊ - export interface AuthPlatform2 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * AuthPlatform resource specific properties␊ - */␊ - properties?: (AuthPlatformProperties2 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AuthPlatform resource specific properties␊ - */␊ - export interface AuthPlatformProperties2 {␊ - configFilePath?: string␊ - enabled?: (boolean | string)␊ - runtimeVersion?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Files or Blob Storage access information value for dictionary storage.␊ - */␊ - export interface AzureStorageInfoValue5 {␊ - /**␊ - * Access key for the storage account.␊ - */␊ - accessKey?: string␊ - /**␊ - * Name of the storage account.␊ - */␊ - accountName?: string␊ - /**␊ - * Path to mount the storage within the site's runtime environment.␊ - */␊ - mountPath?: string␊ - /**␊ - * Name of the file share (container name, for Blob storage).␊ - */␊ - shareName?: string␊ - /**␊ - * Type of storage.␊ - */␊ - type?: (("AzureFiles" | "AzureBlob") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * BackupRequest resource specific properties␊ - */␊ - export interface BackupRequestProperties7 {␊ - /**␊ - * Name of the backup.␊ - */␊ - backupName?: string␊ - /**␊ - * Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy.␊ - */␊ - backupSchedule?: (BackupSchedule7 | string)␊ - /**␊ - * Databases included in the backup.␊ - */␊ - databases?: (DatabaseBackupSetting7[] | string)␊ - /**␊ - * True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * SAS URL to the container.␊ - */␊ - storageAccountUrl: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy.␊ - */␊ - export interface BackupSchedule7 {␊ - /**␊ - * 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)␊ - */␊ - frequencyInterval: ((number & string) | string)␊ - /**␊ - * 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).␊ - */␊ - frequencyUnit: (("Day" | "Hour") | string)␊ - /**␊ - * True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise.␊ - */␊ - keepAtLeastOneBackup: (boolean | string)␊ - /**␊ - * After how many days backups should be deleted.␊ - */␊ - retentionPeriodInDays: ((number & string) | string)␊ - /**␊ - * When the schedule should start working.␊ - */␊ - startTime?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Database backup settings.␊ - */␊ - export interface DatabaseBackupSetting7 {␊ - /**␊ - * 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.␊ - */␊ - connectionString?: string␊ - /**␊ - * Contains a connection string name that is linked to the SiteConfig.ConnectionStrings.␊ - * This is used during restore with overwrite connection strings options.␊ - */␊ - connectionStringName?: string␊ - /**␊ - * Database type (e.g. SqlAzure / MySql).␊ - */␊ - databaseType: (("SqlAzure" | "MySql" | "LocalMySql" | "PostgreSql") | string)␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Database connection string value to type pair.␊ - */␊ - export interface ConnStringValueTypePair7 {␊ - /**␊ - * Type of database.␊ - */␊ - type: (("MySql" | "SQLServer" | "SQLAzure" | "Custom" | "NotificationHub" | "ServiceBus" | "EventHub" | "ApiHub" | "DocDb" | "RedisCache" | "PostgreSQL") | string)␊ - /**␊ - * Value of pair.␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SiteLogsConfig resource specific properties␊ - */␊ - export interface SiteLogsConfigProperties7 {␊ - /**␊ - * Application logs configuration.␊ - */␊ - applicationLogs?: (ApplicationLogsConfig7 | string)␊ - /**␊ - * Enabled configuration.␊ - */␊ - detailedErrorMessages?: (EnabledConfig7 | string)␊ - /**␊ - * Enabled configuration.␊ - */␊ - failedRequestsTracing?: (EnabledConfig7 | string)␊ - /**␊ - * Http logs configuration.␊ - */␊ - httpLogs?: (HttpLogsConfig7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application logs configuration.␊ - */␊ - export interface ApplicationLogsConfig7 {␊ - /**␊ - * Application logs azure blob storage configuration.␊ - */␊ - azureBlobStorage?: (AzureBlobStorageApplicationLogsConfig7 | string)␊ - /**␊ - * Application logs to Azure table storage configuration.␊ - */␊ - azureTableStorage?: (AzureTableStorageApplicationLogsConfig7 | string)␊ - /**␊ - * Application logs to file system configuration.␊ - */␊ - fileSystem?: (FileSystemApplicationLogsConfig7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application logs azure blob storage configuration.␊ - */␊ - export interface AzureBlobStorageApplicationLogsConfig7 {␊ - /**␊ - * Log level.␊ - */␊ - level?: (("Off" | "Verbose" | "Information" | "Warning" | "Error") | string)␊ - /**␊ - * Retention in days.␊ - * Remove blobs older than X days.␊ - * 0 or lower means no retention.␊ - */␊ - retentionInDays?: (number | string)␊ - /**␊ - * SAS url to a azure blob container with read/write/list/delete permissions.␊ - */␊ - sasUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application logs to Azure table storage configuration.␊ - */␊ - export interface AzureTableStorageApplicationLogsConfig7 {␊ - /**␊ - * Log level.␊ - */␊ - level?: (("Off" | "Verbose" | "Information" | "Warning" | "Error") | string)␊ - /**␊ - * SAS URL to an Azure table with add/query/delete permissions.␊ - */␊ - sasUrl: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application logs to file system configuration.␊ - */␊ - export interface FileSystemApplicationLogsConfig7 {␊ - /**␊ - * Log level.␊ - */␊ - level?: (("Off" | "Verbose" | "Information" | "Warning" | "Error") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Enabled configuration.␊ - */␊ - export interface EnabledConfig7 {␊ - /**␊ - * True if configuration is enabled, false if it is disabled and null if configuration is not set.␊ - */␊ - enabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http logs configuration.␊ - */␊ - export interface HttpLogsConfig7 {␊ - /**␊ - * Http logs to azure blob storage configuration.␊ - */␊ - azureBlobStorage?: (AzureBlobStorageHttpLogsConfig7 | string)␊ - /**␊ - * Http logs to file system configuration.␊ - */␊ - fileSystem?: (FileSystemHttpLogsConfig7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http logs to azure blob storage configuration.␊ - */␊ - export interface AzureBlobStorageHttpLogsConfig7 {␊ - /**␊ - * True if configuration is enabled, false if it is disabled and null if configuration is not set.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Retention in days.␊ - * Remove blobs older than X days.␊ - * 0 or lower means no retention.␊ - */␊ - retentionInDays?: (number | string)␊ - /**␊ - * SAS url to a azure blob container with read/write/list/delete permissions.␊ - */␊ - sasUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http logs to file system configuration.␊ - */␊ - export interface FileSystemHttpLogsConfig7 {␊ - /**␊ - * True if configuration is enabled, false if it is disabled and null if configuration is not set.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Retention in days.␊ - * Remove files older than X days.␊ - * 0 or lower means no retention.␊ - */␊ - retentionInDays?: (number | string)␊ - /**␊ - * 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.␊ - */␊ - retentionInMb?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Names for connection strings, application settings, and external Azure storage account configuration␊ - * identifiers 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.␊ - */␊ - export interface SlotConfigNames6 {␊ - /**␊ - * List of application settings names.␊ - */␊ - appSettingNames?: (string[] | string)␊ - /**␊ - * List of external Azure storage account identifiers.␊ - */␊ - azureStorageConfigNames?: (string[] | string)␊ - /**␊ - * List of connection string names.␊ - */␊ - connectionStringNames?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/deployments␊ - */␊ - export interface SitesDeploymentsChildResource7 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * ID of an existing deployment.␊ - */␊ - name: string␊ - /**␊ - * Deployment resource specific properties␊ - */␊ - properties: (DeploymentProperties9 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "deployments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Deployment resource specific properties␊ - */␊ - export interface DeploymentProperties9 {␊ - /**␊ - * True if deployment is currently active, false if completed and null if not started.␊ - */␊ - active?: (boolean | string)␊ - /**␊ - * Who authored the deployment.␊ - */␊ - author?: string␊ - /**␊ - * Author email.␊ - */␊ - author_email?: string␊ - /**␊ - * Who performed the deployment.␊ - */␊ - deployer?: string␊ - /**␊ - * Details on deployment.␊ - */␊ - details?: string␊ - /**␊ - * End time.␊ - */␊ - end_time?: string␊ - /**␊ - * Details about deployment status.␊ - */␊ - message?: string␊ - /**␊ - * Start time.␊ - */␊ - start_time?: string␊ - /**␊ - * Deployment status.␊ - */␊ - status?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/domainOwnershipIdentifiers␊ - */␊ - export interface SitesDomainOwnershipIdentifiersChildResource6 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of domain ownership identifier.␊ - */␊ - name: string␊ - /**␊ - * Identifier resource specific properties␊ - */␊ - properties: (IdentifierProperties6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "domainOwnershipIdentifiers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identifier resource specific properties␊ - */␊ - export interface IdentifierProperties6 {␊ - /**␊ - * String representation of the identity.␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/extensions␊ - */␊ - export interface SitesExtensionsChildResource6 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "MSDeploy"␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - properties: (MSDeployCore6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - export interface MSDeployCore6 {␊ - /**␊ - * Sets the AppOffline rule while the MSDeploy operation executes.␊ - * Setting is false by default.␊ - */␊ - appOffline?: (boolean | string)␊ - /**␊ - * SQL Connection String␊ - */␊ - connectionString?: string␊ - /**␊ - * Database Type␊ - */␊ - dbType?: string␊ - /**␊ - * Package URI␊ - */␊ - packageUri?: string␊ - /**␊ - * MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used.␊ - */␊ - setParameters?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * URI of MSDeploy Parameters file. Must not be set if SetParameters is used.␊ - */␊ - setParametersXmlFileUri?: string␊ - /**␊ - * 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.␊ - */␊ - skipAppData?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/functions␊ - */␊ - export interface SitesFunctionsChildResource6 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Function name.␊ - */␊ - name: string␊ - /**␊ - * FunctionEnvelope resource specific properties␊ - */␊ - properties: (FunctionEnvelopeProperties6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "functions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * FunctionEnvelope resource specific properties␊ - */␊ - export interface FunctionEnvelopeProperties6 {␊ - /**␊ - * Config information.␊ - */␊ - config?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Config URI.␊ - */␊ - config_href?: string␊ - /**␊ - * File list.␊ - */␊ - files?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Function App ID.␊ - */␊ - function_app_id?: string␊ - /**␊ - * Function URI.␊ - */␊ - href?: string␊ - /**␊ - * The invocation URL␊ - */␊ - invoke_url_template?: string␊ - /**␊ - * Gets or sets a value indicating whether the function is disabled␊ - */␊ - isDisabled?: (boolean | string)␊ - /**␊ - * The function language␊ - */␊ - language?: string␊ - /**␊ - * Script URI.␊ - */␊ - script_href?: string␊ - /**␊ - * Script root path URI.␊ - */␊ - script_root_path_href?: string␊ - /**␊ - * Secrets file URI.␊ - */␊ - secrets_file_href?: string␊ - /**␊ - * Test data used when testing via the Azure Portal.␊ - */␊ - test_data?: string␊ - /**␊ - * Test data URI.␊ - */␊ - test_data_href?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/hostNameBindings␊ - */␊ - export interface SitesHostNameBindingsChildResource7 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Hostname in the hostname binding.␊ - */␊ - name: string␊ - /**␊ - * HostNameBinding resource specific properties␊ - */␊ - properties: (HostNameBindingProperties7 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "hostNameBindings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HostNameBinding resource specific properties␊ - */␊ - export interface HostNameBindingProperties7 {␊ - /**␊ - * Azure resource name.␊ - */␊ - azureResourceName?: string␊ - /**␊ - * Azure resource type.␊ - */␊ - azureResourceType?: (("Website" | "TrafficManager") | string)␊ - /**␊ - * Custom DNS record type.␊ - */␊ - customHostNameDnsRecordType?: (("CName" | "A") | string)␊ - /**␊ - * Fully qualified ARM domain resource URI.␊ - */␊ - domainId?: string␊ - /**␊ - * Hostname type.␊ - */␊ - hostNameType?: (("Verified" | "Managed") | string)␊ - /**␊ - * App Service app name.␊ - */␊ - siteName?: string␊ - /**␊ - * SSL type.␊ - */␊ - sslState?: (("Disabled" | "SniEnabled" | "IpBasedEnabled") | string)␊ - /**␊ - * SSL certificate thumbprint␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/hybridconnection␊ - */␊ - export interface SitesHybridconnectionChildResource7 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the hybrid connection configuration.␊ - */␊ - name: string␊ - /**␊ - * RelayServiceConnectionEntity resource specific properties␊ - */␊ - properties: (RelayServiceConnectionEntityProperties7 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "hybridconnection"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * RelayServiceConnectionEntity resource specific properties␊ - */␊ - export interface RelayServiceConnectionEntityProperties7 {␊ - biztalkUri?: string␊ - entityConnectionString?: string␊ - entityName?: string␊ - hostname?: string␊ - port?: (number | string)␊ - resourceConnectionString?: string␊ - resourceType?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/migrate␊ - */␊ - export interface SitesMigrateChildResource6 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "migrate"␊ - /**␊ - * StorageMigrationOptions resource specific properties␊ - */␊ - properties: (StorageMigrationOptionsProperties6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "migrate"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * StorageMigrationOptions resource specific properties␊ - */␊ - export interface StorageMigrationOptionsProperties6 {␊ - /**␊ - * AzureFiles connection string.␊ - */␊ - azurefilesConnectionString: string␊ - /**␊ - * AzureFiles share.␊ - */␊ - azurefilesShare: string␊ - /**␊ - * true if the app should be read only during copy operation; otherwise, false.␊ - */␊ - blockWriteAccessToSite?: (boolean | string)␊ - /**␊ - * trueif the app should be switched over; otherwise, false.␊ - */␊ - switchSiteAfterMigration?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/networkConfig␊ - */␊ - export interface SitesNetworkConfigChildResource5 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "virtualNetwork"␊ - /**␊ - * SwiftVirtualNetwork resource specific properties␊ - */␊ - properties: (SwiftVirtualNetworkProperties5 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "networkConfig"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SwiftVirtualNetwork resource specific properties␊ - */␊ - export interface SwiftVirtualNetworkProperties5 {␊ - /**␊ - * The Virtual Network subnet's resource ID. This is the subnet that this Web App will join. This subnet must have a delegation to Microsoft.Web/serverFarms defined first.␊ - */␊ - subnetResourceId?: string␊ - /**␊ - * A flag that specifies if the scale unit this Web App is on supports Swift integration.␊ - */␊ - swiftSupported?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/premieraddons␊ - */␊ - export interface SitesPremieraddonsChildResource7 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Add-on name.␊ - */␊ - name: string␊ - /**␊ - * PremierAddOn resource specific properties␊ - */␊ - properties: (PremierAddOnProperties6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "premieraddons"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * PremierAddOn resource specific properties␊ - */␊ - export interface PremierAddOnProperties6 {␊ - /**␊ - * Premier add on Marketplace offer.␊ - */␊ - marketplaceOffer?: string␊ - /**␊ - * Premier add on Marketplace publisher.␊ - */␊ - marketplacePublisher?: string␊ - /**␊ - * Premier add on Product.␊ - */␊ - product?: string␊ - /**␊ - * Premier add on SKU.␊ - */␊ - sku?: string␊ - /**␊ - * Premier add on Vendor.␊ - */␊ - vendor?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/privateAccess␊ - */␊ - export interface SitesPrivateAccessChildResource5 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "virtualNetworks"␊ - /**␊ - * PrivateAccess resource specific properties␊ - */␊ - properties: (PrivateAccessProperties5 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "privateAccess"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * PrivateAccess resource specific properties␊ - */␊ - export interface PrivateAccessProperties5 {␊ - /**␊ - * Whether private access is enabled or not.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * The Virtual Networks (and subnets) allowed to access the site privately.␊ - */␊ - virtualNetworks?: (PrivateAccessVirtualNetwork5[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a Virtual Network that is useable for private site access.␊ - */␊ - export interface PrivateAccessVirtualNetwork5 {␊ - /**␊ - * The key (ID) of the Virtual Network.␊ - */␊ - key?: (number | string)␊ - /**␊ - * The name of the Virtual Network.␊ - */␊ - name?: string␊ - /**␊ - * The ARM uri of the Virtual Network␊ - */␊ - resourceId?: string␊ - /**␊ - * A List of subnets that access is allowed to on this Virtual Network. An empty array (but not null) is interpreted to mean that all subnets are allowed within this Virtual Network.␊ - */␊ - subnets?: (PrivateAccessSubnet5[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a Virtual Network subnet that is useable for private site access.␊ - */␊ - export interface PrivateAccessSubnet5 {␊ - /**␊ - * The key (ID) of the subnet.␊ - */␊ - key?: (number | string)␊ - /**␊ - * The name of the subnet.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/publicCertificates␊ - */␊ - export interface SitesPublicCertificatesChildResource6 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Public certificate name.␊ - */␊ - name: string␊ - /**␊ - * PublicCertificate resource specific properties␊ - */␊ - properties: (PublicCertificateProperties6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "publicCertificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * PublicCertificate resource specific properties␊ - */␊ - export interface PublicCertificateProperties6 {␊ - /**␊ - * Public Certificate byte array␊ - */␊ - blob?: string␊ - /**␊ - * Public Certificate Location.␊ - */␊ - publicCertificateLocation?: (("CurrentUserMy" | "LocalMachineMy" | "Unknown") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/siteextensions␊ - */␊ - export interface SitesSiteextensionsChildResource6 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Site extension name.␊ - */␊ - name: string␊ - type: "siteextensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots␊ - */␊ - export interface SitesSlotsChildResource7 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Managed service identity.␊ - */␊ - identity?: (ManagedServiceIdentity20 | string)␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the deployment slot to create or update. The name 'production' is reserved.␊ - */␊ - name: string␊ - /**␊ - * Site resource specific properties␊ - */␊ - properties: (SiteProperties7 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "slots"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/privateEndpointConnections␊ - */␊ - export interface SitesPrivateEndpointConnectionsChildResource3 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * A request to approve or reject a private endpoint connection␊ - */␊ - properties: (PrivateLinkConnectionApprovalRequest4 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "privateEndpointConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A request to approve or reject a private endpoint connection␊ - */␊ - export interface PrivateLinkConnectionApprovalRequest4 {␊ - /**␊ - * The state of a private link connection␊ - */␊ - privateLinkServiceConnectionState?: (PrivateLinkConnectionState4 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The state of a private link connection␊ - */␊ - export interface PrivateLinkConnectionState4 {␊ - /**␊ - * ActionsRequired for a private link connection␊ - */␊ - actionsRequired?: string␊ - /**␊ - * Description of a private link connection␊ - */␊ - description?: string␊ - /**␊ - * Status of a private link connection␊ - */␊ - status?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/sourcecontrols␊ - */␊ - export interface SitesSourcecontrolsChildResource7 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "web"␊ - /**␊ - * SiteSourceControl resource specific properties␊ - */␊ - properties: (SiteSourceControlProperties7 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "sourcecontrols"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SiteSourceControl resource specific properties␊ - */␊ - export interface SiteSourceControlProperties7 {␊ - /**␊ - * Name of branch to use for deployment.␊ - */␊ - branch?: string␊ - /**␊ - * true to enable deployment rollback; otherwise, false.␊ - */␊ - deploymentRollbackEnabled?: (boolean | string)␊ - /**␊ - * true if this is deployed via GitHub action.␊ - */␊ - isGitHubAction?: (boolean | string)␊ - /**␊ - * true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub).␊ - */␊ - isManualIntegration?: (boolean | string)␊ - /**␊ - * true for a Mercurial repository; false for a Git repository.␊ - */␊ - isMercurial?: (boolean | string)␊ - /**␊ - * Repository or source control URL.␊ - */␊ - repoUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/virtualNetworkConnections␊ - */␊ - export interface SitesVirtualNetworkConnectionsChildResource7 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of an existing Virtual Network.␊ - */␊ - name: string␊ - /**␊ - * VnetInfo resource specific properties␊ - */␊ - properties: (VnetInfoProperties7 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "virtualNetworkConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VnetInfo resource specific properties␊ - */␊ - export interface VnetInfoProperties7 {␊ - /**␊ - * A certificate file (.cer) blob containing the public key of the private key used to authenticate a ␊ - * Point-To-Site VPN connection.␊ - */␊ - certBlob?: string␊ - /**␊ - * DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses.␊ - */␊ - dnsServers?: string␊ - /**␊ - * Flag that is used to denote if this is VNET injection␊ - */␊ - isSwift?: (boolean | string)␊ - /**␊ - * The Virtual Network's resource ID.␊ - */␊ - vnetResourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/deployments␊ - */␊ - export interface SitesDeployments7 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * ID of an existing deployment.␊ - */␊ - name: string␊ - /**␊ - * Deployment resource specific properties␊ - */␊ - properties: (DeploymentProperties9 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "Microsoft.Web/sites/deployments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/domainOwnershipIdentifiers␊ - */␊ - export interface SitesDomainOwnershipIdentifiers6 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of domain ownership identifier.␊ - */␊ - name: string␊ - /**␊ - * Identifier resource specific properties␊ - */␊ - properties: (IdentifierProperties6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "Microsoft.Web/sites/domainOwnershipIdentifiers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/extensions␊ - */␊ - export interface SitesExtensions6 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - properties: (MSDeployCore6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "Microsoft.Web/sites/extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/functions␊ - */␊ - export interface SitesFunctions6 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Function name.␊ - */␊ - name: string␊ - /**␊ - * FunctionEnvelope resource specific properties␊ - */␊ - properties: (FunctionEnvelopeProperties6 | string)␊ - resources?: SitesFunctionsKeysChildResource4[]␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "Microsoft.Web/sites/functions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/functions/keys␊ - */␊ - export interface SitesFunctionsKeysChildResource4 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * The name of the key.␊ - */␊ - name: string␊ - type: "keys"␊ - /**␊ - * Key value␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/functions/keys␊ - */␊ - export interface SitesFunctionsKeys4 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * The name of the key.␊ - */␊ - name: string␊ - type: "Microsoft.Web/sites/functions/keys"␊ - /**␊ - * Key value␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/hostNameBindings␊ - */␊ - export interface SitesHostNameBindings7 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Hostname in the hostname binding.␊ - */␊ - name: string␊ - /**␊ - * HostNameBinding resource specific properties␊ - */␊ - properties: (HostNameBindingProperties7 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "Microsoft.Web/sites/hostNameBindings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/hybridconnection␊ - */␊ - export interface SitesHybridconnection7 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the hybrid connection configuration.␊ - */␊ - name: string␊ - /**␊ - * RelayServiceConnectionEntity resource specific properties␊ - */␊ - properties: (RelayServiceConnectionEntityProperties7 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "Microsoft.Web/sites/hybridconnection"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/hybridConnectionNamespaces/relays␊ - */␊ - export interface SitesHybridConnectionNamespacesRelays6 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * The relay name for this hybrid connection.␊ - */␊ - name: string␊ - /**␊ - * HybridConnection resource specific properties␊ - */␊ - properties: (HybridConnectionProperties8 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "Microsoft.Web/sites/hybridConnectionNamespaces/relays"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HybridConnection resource specific properties␊ - */␊ - export interface HybridConnectionProperties8 {␊ - /**␊ - * The hostname of the endpoint.␊ - */␊ - hostname?: string␊ - /**␊ - * The port of the endpoint.␊ - */␊ - port?: (number | string)␊ - /**␊ - * The ARM URI to the Service Bus relay.␊ - */␊ - relayArmUri?: string␊ - /**␊ - * The name of the Service Bus relay.␊ - */␊ - relayName?: string␊ - /**␊ - * The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus.␊ - */␊ - sendKeyName?: string␊ - /**␊ - * 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.␊ - */␊ - sendKeyValue?: string␊ - /**␊ - * The name of the Service Bus namespace.␊ - */␊ - serviceBusNamespace?: string␊ - /**␊ - * The suffix for the service bus endpoint. By default this is .servicebus.windows.net␊ - */␊ - serviceBusSuffix?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/instances/extensions␊ - */␊ - export interface SitesInstancesExtensions6 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - properties: (MSDeployCore6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "Microsoft.Web/sites/instances/extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/migrate␊ - */␊ - export interface SitesMigrate6 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * StorageMigrationOptions resource specific properties␊ - */␊ - properties: (StorageMigrationOptionsProperties6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "Microsoft.Web/sites/migrate"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/networkConfig␊ - */␊ - export interface SitesNetworkConfig5 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SwiftVirtualNetwork resource specific properties␊ - */␊ - properties: (SwiftVirtualNetworkProperties5 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "Microsoft.Web/sites/networkConfig"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/premieraddons␊ - */␊ - export interface SitesPremieraddons7 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Add-on name.␊ - */␊ - name: string␊ - /**␊ - * PremierAddOn resource specific properties␊ - */␊ - properties: (PremierAddOnProperties6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/sites/premieraddons"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/privateAccess␊ - */␊ - export interface SitesPrivateAccess5 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * PrivateAccess resource specific properties␊ - */␊ - properties: (PrivateAccessProperties5 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "Microsoft.Web/sites/privateAccess"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/privateEndpointConnections␊ - */␊ - export interface SitesPrivateEndpointConnections3 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * A request to approve or reject a private endpoint connection␊ - */␊ - properties: (PrivateLinkConnectionApprovalRequest4 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "Microsoft.Web/sites/privateEndpointConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/publicCertificates␊ - */␊ - export interface SitesPublicCertificates6 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Public certificate name.␊ - */␊ - name: string␊ - /**␊ - * PublicCertificate resource specific properties␊ - */␊ - properties: (PublicCertificateProperties6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "Microsoft.Web/sites/publicCertificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/siteextensions␊ - */␊ - export interface SitesSiteextensions6 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Site extension name.␊ - */␊ - name: string␊ - type: "Microsoft.Web/sites/siteextensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots␊ - */␊ - export interface SitesSlots7 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Managed service identity.␊ - */␊ - identity?: (ManagedServiceIdentity20 | string)␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the deployment slot to create or update. The name 'production' is reserved.␊ - */␊ - name: string␊ - /**␊ - * Site resource specific properties␊ - */␊ - properties: (SiteProperties7 | string)␊ - resources?: (SitesSlotsConfigChildResource7 | SitesSlotsDeploymentsChildResource7 | SitesSlotsDomainOwnershipIdentifiersChildResource6 | SitesSlotsExtensionsChildResource6 | SitesSlotsFunctionsChildResource6 | SitesSlotsHostNameBindingsChildResource7 | SitesSlotsHybridconnectionChildResource7 | SitesSlotsNetworkConfigChildResource5 | SitesSlotsPremieraddonsChildResource7 | SitesSlotsPrivateAccessChildResource5 | SitesSlotsPublicCertificatesChildResource6 | SitesSlotsSiteextensionsChildResource6 | SitesSlotsSourcecontrolsChildResource7 | SitesSlotsVirtualNetworkConnectionsChildResource7)[]␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/sites/slots"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/deployments␊ - */␊ - export interface SitesSlotsDeploymentsChildResource7 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * ID of an existing deployment.␊ - */␊ - name: string␊ - /**␊ - * Deployment resource specific properties␊ - */␊ - properties: (DeploymentProperties9 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "deployments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/domainOwnershipIdentifiers␊ - */␊ - export interface SitesSlotsDomainOwnershipIdentifiersChildResource6 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of domain ownership identifier.␊ - */␊ - name: string␊ - /**␊ - * Identifier resource specific properties␊ - */␊ - properties: (IdentifierProperties6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "domainOwnershipIdentifiers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/extensions␊ - */␊ - export interface SitesSlotsExtensionsChildResource6 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "MSDeploy"␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - properties: (MSDeployCore6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/functions␊ - */␊ - export interface SitesSlotsFunctionsChildResource6 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Function name.␊ - */␊ - name: string␊ - /**␊ - * FunctionEnvelope resource specific properties␊ - */␊ - properties: (FunctionEnvelopeProperties6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "functions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/hostNameBindings␊ - */␊ - export interface SitesSlotsHostNameBindingsChildResource7 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Hostname in the hostname binding.␊ - */␊ - name: string␊ - /**␊ - * HostNameBinding resource specific properties␊ - */␊ - properties: (HostNameBindingProperties7 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "hostNameBindings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/hybridconnection␊ - */␊ - export interface SitesSlotsHybridconnectionChildResource7 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the hybrid connection configuration.␊ - */␊ - name: string␊ - /**␊ - * RelayServiceConnectionEntity resource specific properties␊ - */␊ - properties: (RelayServiceConnectionEntityProperties7 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "hybridconnection"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/networkConfig␊ - */␊ - export interface SitesSlotsNetworkConfigChildResource5 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "virtualNetwork"␊ - /**␊ - * SwiftVirtualNetwork resource specific properties␊ - */␊ - properties: (SwiftVirtualNetworkProperties5 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "networkConfig"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/premieraddons␊ - */␊ - export interface SitesSlotsPremieraddonsChildResource7 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Add-on name.␊ - */␊ - name: string␊ - /**␊ - * PremierAddOn resource specific properties␊ - */␊ - properties: (PremierAddOnProperties6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "premieraddons"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/privateAccess␊ - */␊ - export interface SitesSlotsPrivateAccessChildResource5 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "virtualNetworks"␊ - /**␊ - * PrivateAccess resource specific properties␊ - */␊ - properties: (PrivateAccessProperties5 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "privateAccess"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/publicCertificates␊ - */␊ - export interface SitesSlotsPublicCertificatesChildResource6 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Public certificate name.␊ - */␊ - name: string␊ - /**␊ - * PublicCertificate resource specific properties␊ - */␊ - properties: (PublicCertificateProperties6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "publicCertificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/siteextensions␊ - */␊ - export interface SitesSlotsSiteextensionsChildResource6 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Site extension name.␊ - */␊ - name: string␊ - type: "siteextensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/sourcecontrols␊ - */␊ - export interface SitesSlotsSourcecontrolsChildResource7 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "web"␊ - /**␊ - * SiteSourceControl resource specific properties␊ - */␊ - properties: (SiteSourceControlProperties7 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "sourcecontrols"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/virtualNetworkConnections␊ - */␊ - export interface SitesSlotsVirtualNetworkConnectionsChildResource7 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of an existing Virtual Network.␊ - */␊ - name: string␊ - /**␊ - * VnetInfo resource specific properties␊ - */␊ - properties: (VnetInfoProperties7 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "virtualNetworkConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/deployments␊ - */␊ - export interface SitesSlotsDeployments7 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * ID of an existing deployment.␊ - */␊ - name: string␊ - /**␊ - * Deployment resource specific properties␊ - */␊ - properties: (DeploymentProperties9 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "Microsoft.Web/sites/slots/deployments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/domainOwnershipIdentifiers␊ - */␊ - export interface SitesSlotsDomainOwnershipIdentifiers6 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of domain ownership identifier.␊ - */␊ - name: string␊ - /**␊ - * Identifier resource specific properties␊ - */␊ - properties: (IdentifierProperties6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "Microsoft.Web/sites/slots/domainOwnershipIdentifiers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/extensions␊ - */␊ - export interface SitesSlotsExtensions6 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - properties: (MSDeployCore6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "Microsoft.Web/sites/slots/extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/functions␊ - */␊ - export interface SitesSlotsFunctions6 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Function name.␊ - */␊ - name: string␊ - /**␊ - * FunctionEnvelope resource specific properties␊ - */␊ - properties: (FunctionEnvelopeProperties6 | string)␊ - resources?: SitesSlotsFunctionsKeysChildResource4[]␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "Microsoft.Web/sites/slots/functions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/functions/keys␊ - */␊ - export interface SitesSlotsFunctionsKeysChildResource4 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * The name of the key.␊ - */␊ - name: string␊ - type: "keys"␊ - /**␊ - * Key value␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/functions/keys␊ - */␊ - export interface SitesSlotsFunctionsKeys4 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * The name of the key.␊ - */␊ - name: string␊ - type: "Microsoft.Web/sites/slots/functions/keys"␊ - /**␊ - * Key value␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/hostNameBindings␊ - */␊ - export interface SitesSlotsHostNameBindings7 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Hostname in the hostname binding.␊ - */␊ - name: string␊ - /**␊ - * HostNameBinding resource specific properties␊ - */␊ - properties: (HostNameBindingProperties7 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "Microsoft.Web/sites/slots/hostNameBindings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/hybridconnection␊ - */␊ - export interface SitesSlotsHybridconnection7 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the hybrid connection configuration.␊ - */␊ - name: string␊ - /**␊ - * RelayServiceConnectionEntity resource specific properties␊ - */␊ - properties: (RelayServiceConnectionEntityProperties7 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "Microsoft.Web/sites/slots/hybridconnection"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays␊ - */␊ - export interface SitesSlotsHybridConnectionNamespacesRelays6 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * The relay name for this hybrid connection.␊ - */␊ - name: string␊ - /**␊ - * HybridConnection resource specific properties␊ - */␊ - properties: (HybridConnectionProperties8 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/instances/extensions␊ - */␊ - export interface SitesSlotsInstancesExtensions6 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - properties: (MSDeployCore6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "Microsoft.Web/sites/slots/instances/extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/networkConfig␊ - */␊ - export interface SitesSlotsNetworkConfig5 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SwiftVirtualNetwork resource specific properties␊ - */␊ - properties: (SwiftVirtualNetworkProperties5 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "Microsoft.Web/sites/slots/networkConfig"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/premieraddons␊ - */␊ - export interface SitesSlotsPremieraddons7 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Add-on name.␊ - */␊ - name: string␊ - /**␊ - * PremierAddOn resource specific properties␊ - */␊ - properties: (PremierAddOnProperties6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/sites/slots/premieraddons"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/privateAccess␊ - */␊ - export interface SitesSlotsPrivateAccess5 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * PrivateAccess resource specific properties␊ - */␊ - properties: (PrivateAccessProperties5 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "Microsoft.Web/sites/slots/privateAccess"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/publicCertificates␊ - */␊ - export interface SitesSlotsPublicCertificates6 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Public certificate name.␊ - */␊ - name: string␊ - /**␊ - * PublicCertificate resource specific properties␊ - */␊ - properties: (PublicCertificateProperties6 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "Microsoft.Web/sites/slots/publicCertificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/siteextensions␊ - */␊ - export interface SitesSlotsSiteextensions6 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Site extension name.␊ - */␊ - name: string␊ - type: "Microsoft.Web/sites/slots/siteextensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/sourcecontrols␊ - */␊ - export interface SitesSlotsSourcecontrols7 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteSourceControl resource specific properties␊ - */␊ - properties: (SiteSourceControlProperties7 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "Microsoft.Web/sites/slots/sourcecontrols"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/virtualNetworkConnections␊ - */␊ - export interface SitesSlotsVirtualNetworkConnections7 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of an existing Virtual Network.␊ - */␊ - name: string␊ - /**␊ - * VnetInfo resource specific properties␊ - */␊ - properties: (VnetInfoProperties7 | string)␊ - resources?: SitesSlotsVirtualNetworkConnectionsGatewaysChildResource7[]␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "Microsoft.Web/sites/slots/virtualNetworkConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/virtualNetworkConnections/gateways␊ - */␊ - export interface SitesSlotsVirtualNetworkConnectionsGatewaysChildResource7 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the gateway. Currently, the only supported string is "primary".␊ - */␊ - name: string␊ - /**␊ - * VnetGateway resource specific properties␊ - */␊ - properties: (VnetGatewayProperties8 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "gateways"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/virtualNetworkConnections/gateways␊ - */␊ - export interface SitesSlotsVirtualNetworkConnectionsGateways7 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the gateway. Currently, the only supported string is "primary".␊ - */␊ - name: string␊ - /**␊ - * VnetGateway resource specific properties␊ - */␊ - properties: (VnetGatewayProperties8 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "Microsoft.Web/sites/slots/virtualNetworkConnections/gateways"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/sourcecontrols␊ - */␊ - export interface SitesSourcecontrols7 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteSourceControl resource specific properties␊ - */␊ - properties: (SiteSourceControlProperties7 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "Microsoft.Web/sites/sourcecontrols"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/virtualNetworkConnections␊ - */␊ - export interface SitesVirtualNetworkConnections7 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of an existing Virtual Network.␊ - */␊ - name: string␊ - /**␊ - * VnetInfo resource specific properties␊ - */␊ - properties: (VnetInfoProperties7 | string)␊ - resources?: SitesVirtualNetworkConnectionsGatewaysChildResource7[]␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "Microsoft.Web/sites/virtualNetworkConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/virtualNetworkConnections/gateways␊ - */␊ - export interface SitesVirtualNetworkConnectionsGatewaysChildResource7 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the gateway. Currently, the only supported string is "primary".␊ - */␊ - name: string␊ - /**␊ - * VnetGateway resource specific properties␊ - */␊ - properties: (VnetGatewayProperties8 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "gateways"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/virtualNetworkConnections/gateways␊ - */␊ - export interface SitesVirtualNetworkConnectionsGateways7 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the gateway. Currently, the only supported string is "primary".␊ - */␊ - name: string␊ - /**␊ - * VnetGateway resource specific properties␊ - */␊ - properties: (VnetGatewayProperties8 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "Microsoft.Web/sites/virtualNetworkConnections/gateways"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/staticSites␊ - */␊ - export interface StaticSites3 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the static site to create or update.␊ - */␊ - name: string␊ - /**␊ - * A static site.␊ - */␊ - properties: (StaticSite3 | string)␊ - resources?: (StaticSitesConfigChildResource3 | StaticSitesCustomDomainsChildResource3)[]␊ - /**␊ - * Description of a SKU for a scalable resource.␊ - */␊ - sku?: (SkuDescription8 | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/staticSites"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A static site.␊ - */␊ - export interface StaticSite3 {␊ - /**␊ - * The target branch in the repository.␊ - */␊ - branch?: string␊ - /**␊ - * Build properties for the static site.␊ - */␊ - buildProperties?: (StaticSiteBuildProperties3 | string)␊ - /**␊ - * A user's github repository token. This is used to setup the Github Actions workflow file and API secrets.␊ - */␊ - repositoryToken?: string␊ - /**␊ - * URL for the repository of the static site.␊ - */␊ - repositoryUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Build properties for the static site.␊ - */␊ - export interface StaticSiteBuildProperties3 {␊ - /**␊ - * The path to the api code within the repository.␊ - */␊ - apiLocation?: string␊ - /**␊ - * The path of the app artifacts after building.␊ - */␊ - appArtifactLocation?: string␊ - /**␊ - * The path to the app code within the repository.␊ - */␊ - appLocation?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/staticSites/config␊ - */␊ - export interface StaticSitesConfigChildResource3 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "functionappsettings"␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "config"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/staticSites/customDomains␊ - */␊ - export interface StaticSitesCustomDomainsChildResource3 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * The custom domain to create.␊ - */␊ - name: string␊ - type: "customDomains"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/staticSites/builds/config␊ - */␊ - export interface StaticSitesBuildsConfig3 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "Microsoft.Web/staticSites/builds/config"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/staticSites/config␊ - */␊ - export interface StaticSitesConfig3 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Settings.␊ - */␊ - properties: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Metadata pertaining to creation and last modification of the resource.␊ - */␊ - systemData?: (SystemData6 | string)␊ - type: "Microsoft.Web/staticSites/config"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/staticSites/customDomains␊ - */␊ - export interface StaticSitesCustomDomains3 {␊ - apiVersion: "2020-10-01"␊ - /**␊ - * The custom domain to create.␊ - */␊ - name: string␊ - type: "Microsoft.Web/staticSites/customDomains"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/certificates␊ - */␊ - export interface Certificates8 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the certificate.␊ - */␊ - name: string␊ - /**␊ - * Certificate resource specific properties␊ - */␊ - properties: (CertificateProperties8 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/certificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Certificate resource specific properties␊ - */␊ - export interface CertificateProperties8 {␊ - /**␊ - * CNAME of the certificate to be issued via free certificate␊ - */␊ - canonicalName?: string␊ - /**␊ - * Method of domain validation for free cert␊ - */␊ - domainValidationMethod?: string␊ - /**␊ - * Host names the certificate applies to.␊ - */␊ - hostNames?: (string[] | string)␊ - /**␊ - * Key Vault Csm resource Id.␊ - */␊ - keyVaultId?: string␊ - /**␊ - * Key Vault secret name.␊ - */␊ - keyVaultSecretName?: string␊ - /**␊ - * Certificate password.␊ - */␊ - password?: string␊ - /**␊ - * Pfx blob.␊ - */␊ - pfxBlob?: string␊ - /**␊ - * Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".␊ - */␊ - serverFarmId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/hostingEnvironments␊ - */␊ - export interface HostingEnvironments7 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the App Service Environment.␊ - */␊ - name: string␊ - /**␊ - * Description of an App Service Environment.␊ - */␊ - properties: (AppServiceEnvironment6 | string)␊ - resources?: (HostingEnvironmentsConfigurationsChildResource | HostingEnvironmentsMultiRolePoolsChildResource7 | HostingEnvironmentsPrivateEndpointConnectionsChildResource | HostingEnvironmentsWorkerPoolsChildResource7)[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/hostingEnvironments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of an App Service Environment.␊ - */␊ - export interface AppServiceEnvironment6 {␊ - /**␊ - * Custom settings for changing the behavior of the App Service Environment.␊ - */␊ - clusterSettings?: (NameValuePair9[] | string)␊ - /**␊ - * DNS suffix of the App Service Environment.␊ - */␊ - dnsSuffix?: string␊ - /**␊ - * Scale factor for front-ends.␊ - */␊ - frontEndScaleFactor?: (number | string)␊ - /**␊ - * Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.␊ - */␊ - internalLoadBalancingMode?: (("None" | "Web" | "Publishing" | "Web, Publishing") | string)␊ - /**␊ - * Number of IP SSL addresses reserved for the App Service Environment.␊ - */␊ - ipsslAddressCount?: (number | string)␊ - /**␊ - * Front-end VM size, e.g. "Medium", "Large".␊ - */␊ - multiSize?: string␊ - /**␊ - * User added ip ranges to whitelist on ASE db␊ - */␊ - userWhitelistedIpRanges?: (string[] | string)␊ - /**␊ - * Specification for using a Virtual Network.␊ - */␊ - virtualNetwork: (VirtualNetworkProfile10 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Name value pair.␊ - */␊ - export interface NameValuePair9 {␊ - /**␊ - * Pair name.␊ - */␊ - name?: string␊ - /**␊ - * Pair value.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specification for using a Virtual Network.␊ - */␊ - export interface VirtualNetworkProfile10 {␊ - /**␊ - * Resource id of the Virtual Network.␊ - */␊ - id: string␊ - /**␊ - * Subnet within the Virtual Network.␊ - */␊ - subnet?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/hostingEnvironments/configurations␊ - */␊ - export interface HostingEnvironmentsConfigurationsChildResource {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "networking"␊ - /**␊ - * AseV3NetworkingConfiguration resource specific properties␊ - */␊ - properties: (AseV3NetworkingConfigurationProperties | string)␊ - type: "configurations"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AseV3NetworkingConfiguration resource specific properties␊ - */␊ - export interface AseV3NetworkingConfigurationProperties {␊ - /**␊ - * Property to enable and disable new private endpoint connection creation on ASE␊ - */␊ - allowNewPrivateEndpointConnections?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/hostingEnvironments/multiRolePools␊ - */␊ - export interface HostingEnvironmentsMultiRolePoolsChildResource7 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "default"␊ - /**␊ - * Worker pool of an App Service Environment.␊ - */␊ - properties: (WorkerPool7 | string)␊ - /**␊ - * Description of a SKU for a scalable resource.␊ - */␊ - sku?: (SkuDescription9 | string)␊ - type: "multiRolePools"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Worker pool of an App Service Environment.␊ - */␊ - export interface WorkerPool7 {␊ - /**␊ - * Shared or dedicated app hosting.␊ - */␊ - computeMode?: (("Shared" | "Dedicated" | "Dynamic") | string)␊ - /**␊ - * Number of instances in the worker pool.␊ - */␊ - workerCount?: (number | string)␊ - /**␊ - * VM size of the worker pool instances.␊ - */␊ - workerSize?: string␊ - /**␊ - * Worker size ID for referencing this worker pool.␊ - */␊ - workerSizeId?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a SKU for a scalable resource.␊ - */␊ - export interface SkuDescription9 {␊ - /**␊ - * Capabilities of the SKU, e.g., is traffic manager enabled?␊ - */␊ - capabilities?: (Capability7[] | string)␊ - /**␊ - * Current number of instances assigned to the resource.␊ - */␊ - capacity?: (number | string)␊ - /**␊ - * Family code of the resource SKU.␊ - */␊ - family?: string␊ - /**␊ - * Locations of the SKU.␊ - */␊ - locations?: (string[] | string)␊ - /**␊ - * Name of the resource SKU.␊ - */␊ - name?: string␊ - /**␊ - * Size specifier of the resource SKU.␊ - */␊ - size?: string␊ - /**␊ - * Description of the App Service plan scale options.␊ - */␊ - skuCapacity?: (SkuCapacity6 | string)␊ - /**␊ - * Service tier of the resource SKU.␊ - */␊ - tier?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Describes the capabilities/features allowed for a specific SKU.␊ - */␊ - export interface Capability7 {␊ - /**␊ - * Name of the SKU capability.␊ - */␊ - name?: string␊ - /**␊ - * Reason of the SKU capability.␊ - */␊ - reason?: string␊ - /**␊ - * Value of the SKU capability.␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of the App Service plan scale options.␊ - */␊ - export interface SkuCapacity6 {␊ - /**␊ - * Default number of workers for this App Service plan SKU.␊ - */␊ - default?: (number | string)␊ - /**␊ - * Maximum number of Elastic workers for this App Service plan SKU.␊ - */␊ - elasticMaximum?: (number | string)␊ - /**␊ - * Maximum number of workers for this App Service plan SKU.␊ - */␊ - maximum?: (number | string)␊ - /**␊ - * Minimum number of workers for this App Service plan SKU.␊ - */␊ - minimum?: (number | string)␊ - /**␊ - * Available scale configurations for an App Service plan.␊ - */␊ - scaleType?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/hostingEnvironments/privateEndpointConnections␊ - */␊ - export interface HostingEnvironmentsPrivateEndpointConnectionsChildResource {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the private endpoint connection.␊ - */␊ - name: string␊ - /**␊ - * A request to approve or reject a private endpoint connection␊ - */␊ - properties: (PrivateLinkConnectionApprovalRequest5 | string)␊ - type: "privateEndpointConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A request to approve or reject a private endpoint connection␊ - */␊ - export interface PrivateLinkConnectionApprovalRequest5 {␊ - /**␊ - * The state of a private link connection␊ - */␊ - privateLinkServiceConnectionState?: (PrivateLinkConnectionState5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The state of a private link connection␊ - */␊ - export interface PrivateLinkConnectionState5 {␊ - /**␊ - * ActionsRequired for a private link connection␊ - */␊ - actionsRequired?: string␊ - /**␊ - * Description of a private link connection␊ - */␊ - description?: string␊ - /**␊ - * Status of a private link connection␊ - */␊ - status?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/hostingEnvironments/workerPools␊ - */␊ - export interface HostingEnvironmentsWorkerPoolsChildResource7 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the worker pool.␊ - */␊ - name: string␊ - /**␊ - * Worker pool of an App Service Environment.␊ - */␊ - properties: (WorkerPool7 | string)␊ - /**␊ - * Description of a SKU for a scalable resource.␊ - */␊ - sku?: (SkuDescription9 | string)␊ - type: "workerPools"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/hostingEnvironments/configurations␊ - */␊ - export interface HostingEnvironmentsConfigurations {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * AseV3NetworkingConfiguration resource specific properties␊ - */␊ - properties: (AseV3NetworkingConfigurationProperties | string)␊ - type: "Microsoft.Web/hostingEnvironments/configurations"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/hostingEnvironments/multiRolePools␊ - */␊ - export interface HostingEnvironmentsMultiRolePools7 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * Worker pool of an App Service Environment.␊ - */␊ - properties: (WorkerPool7 | string)␊ - /**␊ - * Description of a SKU for a scalable resource.␊ - */␊ - sku?: (SkuDescription9 | string)␊ - type: "Microsoft.Web/hostingEnvironments/multiRolePools"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/hostingEnvironments/privateEndpointConnections␊ - */␊ - export interface HostingEnvironmentsPrivateEndpointConnections {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the private endpoint connection.␊ - */␊ - name: string␊ - /**␊ - * A request to approve or reject a private endpoint connection␊ - */␊ - properties: (PrivateLinkConnectionApprovalRequest5 | string)␊ - type: "Microsoft.Web/hostingEnvironments/privateEndpointConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/hostingEnvironments/workerPools␊ - */␊ - export interface HostingEnvironmentsWorkerPools7 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the worker pool.␊ - */␊ - name: string␊ - /**␊ - * Worker pool of an App Service Environment.␊ - */␊ - properties: (WorkerPool7 | string)␊ - /**␊ - * Description of a SKU for a scalable resource.␊ - */␊ - sku?: (SkuDescription9 | string)␊ - type: "Microsoft.Web/hostingEnvironments/workerPools"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/serverfarms␊ - */␊ - export interface Serverfarms7 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the App Service plan.␊ - */␊ - name: string␊ - /**␊ - * AppServicePlan resource specific properties␊ - */␊ - properties: (AppServicePlanProperties6 | string)␊ - /**␊ - * Description of a SKU for a scalable resource.␊ - */␊ - sku?: (SkuDescription9 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/serverfarms"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * AppServicePlan resource specific properties␊ - */␊ - export interface AppServicePlanProperties6 {␊ - /**␊ - * The time when the server farm free offer expires.␊ - */␊ - freeOfferExpirationTime?: string␊ - /**␊ - * Specification for an App Service Environment to use for this resource.␊ - */␊ - hostingEnvironmentProfile?: (HostingEnvironmentProfile9 | string)␊ - /**␊ - * If Hyper-V container app service plan true, false otherwise.␊ - */␊ - hyperV?: (boolean | string)␊ - /**␊ - * If true, this App Service Plan owns spot instances.␊ - */␊ - isSpot?: (boolean | string)␊ - /**␊ - * Obsolete: If Hyper-V container app service plan true, false otherwise.␊ - */␊ - isXenon?: (boolean | string)␊ - /**␊ - * Specification for a Kubernetes Environment to use for this resource.␊ - */␊ - kubeEnvironmentProfile?: (KubeEnvironmentProfile | string)␊ - /**␊ - * Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan␊ - */␊ - maximumElasticWorkerCount?: (number | string)␊ - /**␊ - * 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.␊ - */␊ - perSiteScaling?: (boolean | string)␊ - /**␊ - * If Linux app service plan true, false otherwise.␊ - */␊ - reserved?: (boolean | string)␊ - /**␊ - * The time when the server farm expires. Valid only if it is a spot server farm.␊ - */␊ - spotExpirationTime?: string␊ - /**␊ - * Scaling worker count.␊ - */␊ - targetWorkerCount?: (number | string)␊ - /**␊ - * Scaling worker size ID.␊ - */␊ - targetWorkerSizeId?: (number | string)␊ - /**␊ - * Target worker tier assigned to the App Service plan.␊ - */␊ - workerTierName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specification for an App Service Environment to use for this resource.␊ - */␊ - export interface HostingEnvironmentProfile9 {␊ - /**␊ - * Resource ID of the App Service Environment.␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Specification for a Kubernetes Environment to use for this resource.␊ - */␊ - export interface KubeEnvironmentProfile {␊ - /**␊ - * Resource ID of the Kubernetes Environment.␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/serverfarms/virtualNetworkConnections/gateways␊ - */␊ - export interface ServerfarmsVirtualNetworkConnectionsGateways7 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the gateway. Only the 'primary' gateway is supported.␊ - */␊ - name: string␊ - /**␊ - * VnetGateway resource specific properties␊ - */␊ - properties: (VnetGatewayProperties9 | string)␊ - type: "Microsoft.Web/serverfarms/virtualNetworkConnections/gateways"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VnetGateway resource specific properties␊ - */␊ - export interface VnetGatewayProperties9 {␊ - /**␊ - * The Virtual Network name.␊ - */␊ - vnetName?: string␊ - /**␊ - * The URI where the VPN package can be downloaded.␊ - */␊ - vpnPackageUri: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/serverfarms/virtualNetworkConnections/routes␊ - */␊ - export interface ServerfarmsVirtualNetworkConnectionsRoutes7 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the Virtual Network route.␊ - */␊ - name: string␊ - /**␊ - * VnetRoute resource specific properties␊ - */␊ - properties: (VnetRouteProperties7 | string)␊ - type: "Microsoft.Web/serverfarms/virtualNetworkConnections/routes"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VnetRoute resource specific properties␊ - */␊ - export interface VnetRouteProperties7 {␊ - /**␊ - * The ending address for this route. If the start address is specified in CIDR notation, this must be omitted.␊ - */␊ - endAddress?: string␊ - /**␊ - * 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.␊ - */␊ - routeType?: (("DEFAULT" | "INHERITED" | "STATIC") | string)␊ - /**␊ - * The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified.␊ - */␊ - startAddress?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites␊ - */␊ - export interface Sites8 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Managed service identity.␊ - */␊ - identity?: (ManagedServiceIdentity21 | string)␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Unique name of the app to create or update. To create or update a deployment slot, use the {slot} parameter.␊ - */␊ - name: string␊ - /**␊ - * Site resource specific properties␊ - */␊ - properties: (SiteProperties8 | string)␊ - resources?: (SitesBasicPublishingCredentialsPoliciesChildResource4 | SitesConfigChildResource8 | SitesDeploymentsChildResource8 | SitesDomainOwnershipIdentifiersChildResource7 | SitesExtensionsChildResource7 | SitesFunctionsChildResource7 | SitesHostNameBindingsChildResource8 | SitesHybridconnectionChildResource8 | SitesMigrateChildResource7 | SitesNetworkConfigChildResource6 | SitesPremieraddonsChildResource8 | SitesPrivateAccessChildResource6 | SitesPrivateEndpointConnectionsChildResource4 | SitesPublicCertificatesChildResource7 | SitesSiteextensionsChildResource7 | SitesSlotsChildResource8 | SitesSourcecontrolsChildResource8 | SitesVirtualNetworkConnectionsChildResource8)[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/sites"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Managed service identity.␊ - */␊ - export interface ManagedServiceIdentity21 {␊ - /**␊ - * Type of managed service identity.␊ - */␊ - type?: (("SystemAssigned" | "UserAssigned" | "SystemAssigned, UserAssigned" | "None") | string)␊ - /**␊ - * The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}␊ - */␊ - userAssignedIdentities?: ({␊ - [k: string]: Components1Jq1T4Ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties7␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - export interface Components1Jq1T4Ischemasmanagedserviceidentitypropertiesuserassignedidentitiesadditionalproperties7 {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Site resource specific properties␊ - */␊ - export interface SiteProperties8 {␊ - /**␊ - * 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.␊ - */␊ - clientAffinityEnabled?: (boolean | string)␊ - /**␊ - * true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.␊ - */␊ - clientCertEnabled?: (boolean | string)␊ - /**␊ - * client certificate authentication comma-separated exclusion paths␊ - */␊ - clientCertExclusionPaths?: string␊ - /**␊ - * This composes with ClientCertEnabled setting.␊ - * - ClientCertEnabled: false means ClientCert is ignored.␊ - * - ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required.␊ - * - ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted.␊ - */␊ - clientCertMode?: (("Required" | "Optional" | "OptionalInteractiveUser") | string)␊ - /**␊ - * Information needed for cloning operation.␊ - */␊ - cloningInfo?: (CloningInfo8 | string)␊ - /**␊ - * Size of the function container.␊ - */␊ - containerSize?: (number | string)␊ - /**␊ - * Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification.␊ - */␊ - customDomainVerificationId?: string␊ - /**␊ - * Maximum allowed daily memory-time quota (applicable on dynamic apps only).␊ - */␊ - dailyMemoryTimeQuota?: (number | string)␊ - /**␊ - * true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Specification for an App Service Environment to use for this resource.␊ - */␊ - hostingEnvironmentProfile?: (HostingEnvironmentProfile9 | string)␊ - /**␊ - * true to disable the public hostnames of the app; otherwise, false.␊ - * If true, the app is only accessible via API management process.␊ - */␊ - hostNamesDisabled?: (boolean | string)␊ - /**␊ - * Hostname SSL states are used to manage the SSL bindings for app's hostnames.␊ - */␊ - hostNameSslStates?: (HostNameSslState8[] | string)␊ - /**␊ - * HttpsOnly: configures a web site to accept only https requests. Issues redirect for␊ - * http requests␊ - */␊ - httpsOnly?: (boolean | string)␊ - /**␊ - * Hyper-V sandbox.␊ - */␊ - hyperV?: (boolean | string)␊ - /**␊ - * Obsolete: Hyper-V sandbox.␊ - */␊ - isXenon?: (boolean | string)␊ - /**␊ - * Identity to use for Key Vault Reference authentication.␊ - */␊ - keyVaultReferenceIdentity?: string␊ - /**␊ - * Site redundancy mode.␊ - */␊ - redundancyMode?: (("None" | "Manual" | "Failover" | "ActiveActive" | "GeoRedundant") | string)␊ - /**␊ - * true if reserved; otherwise, false.␊ - */␊ - reserved?: (boolean | string)␊ - /**␊ - * true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.␊ - */␊ - scmSiteAlsoStopped?: (boolean | string)␊ - /**␊ - * Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".␊ - */␊ - serverFarmId?: string␊ - /**␊ - * Configuration of an App Service app.␊ - */␊ - siteConfig?: (SiteConfig8 | string)␊ - /**␊ - * Checks if Customer provided storage account is required␊ - */␊ - storageAccountRequired?: (boolean | string)␊ - /**␊ - * Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration.␊ - * This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}␊ - */␊ - virtualNetworkSubnetId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information needed for cloning operation.␊ - */␊ - export interface CloningInfo8 {␊ - /**␊ - * 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.␊ - */␊ - appSettingsOverrides?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * true to clone custom hostnames from source app; otherwise, false.␊ - */␊ - cloneCustomHostNames?: (boolean | string)␊ - /**␊ - * true to clone source control from source app; otherwise, false.␊ - */␊ - cloneSourceControl?: (boolean | string)␊ - /**␊ - * true to configure load balancing for source and destination app.␊ - */␊ - configureLoadBalancing?: (boolean | string)␊ - /**␊ - * Correlation ID of cloning operation. This ID ties multiple cloning operations␊ - * together to use the same snapshot.␊ - */␊ - correlationId?: string␊ - /**␊ - * App Service Environment.␊ - */␊ - hostingEnvironment?: string␊ - /**␊ - * true to overwrite destination app; otherwise, false.␊ - */␊ - overwrite?: (boolean | string)␊ - /**␊ - * 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.␊ - */␊ - sourceWebAppId: string␊ - /**␊ - * Location of source app ex: West US or North Europe␊ - */␊ - sourceWebAppLocation?: string␊ - /**␊ - * 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}.␊ - */␊ - trafficManagerProfileId?: string␊ - /**␊ - * Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist.␊ - */␊ - trafficManagerProfileName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SSL-enabled hostname.␊ - */␊ - export interface HostNameSslState8 {␊ - /**␊ - * Indicates whether the hostname is a standard or repository hostname.␊ - */␊ - hostType?: (("Standard" | "Repository") | string)␊ - /**␊ - * Hostname.␊ - */␊ - name?: string␊ - /**␊ - * SSL type.␊ - */␊ - sslState?: (("Disabled" | "SniEnabled" | "IpBasedEnabled") | string)␊ - /**␊ - * SSL certificate thumbprint.␊ - */␊ - thumbprint?: string␊ - /**␊ - * Set to true to update existing hostname.␊ - */␊ - toUpdate?: (boolean | string)␊ - /**␊ - * Virtual IP address assigned to the hostname if IP based SSL is enabled.␊ - */␊ - virtualIP?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Configuration of an App Service app.␊ - */␊ - export interface SiteConfig8 {␊ - /**␊ - * Flag to use Managed Identity Creds for ACR pull␊ - */␊ - acrUseManagedIdentityCreds?: (boolean | string)␊ - /**␊ - * If using user managed identity, the user managed identity ClientId␊ - */␊ - acrUserManagedIdentityID?: string␊ - /**␊ - * true if Always On is enabled; otherwise, false.␊ - */␊ - alwaysOn?: (boolean | string)␊ - /**␊ - * Information about the formal API definition for the app.␊ - */␊ - apiDefinition?: (ApiDefinitionInfo8 | string)␊ - /**␊ - * Azure API management (APIM) configuration linked to the app.␊ - */␊ - apiManagementConfig?: (ApiManagementConfig4 | string)␊ - /**␊ - * App command line to launch.␊ - */␊ - appCommandLine?: string␊ - /**␊ - * Application settings.␊ - */␊ - appSettings?: (NameValuePair9[] | string)␊ - /**␊ - * true if Auto Heal is enabled; otherwise, false.␊ - */␊ - autoHealEnabled?: (boolean | string)␊ - /**␊ - * Rules that can be defined for auto-heal.␊ - */␊ - autoHealRules?: (AutoHealRules8 | string)␊ - /**␊ - * Auto-swap slot name.␊ - */␊ - autoSwapSlotName?: string␊ - /**␊ - * List of Azure Storage Accounts.␊ - */␊ - azureStorageAccounts?: ({␊ - [k: string]: AzureStorageInfoValue6␊ - } | string)␊ - /**␊ - * Connection strings.␊ - */␊ - connectionStrings?: (ConnStringInfo8[] | string)␊ - /**␊ - * Cross-Origin Resource Sharing (CORS) settings for the app.␊ - */␊ - cors?: (CorsSettings8 | string)␊ - /**␊ - * Default documents.␊ - */␊ - defaultDocuments?: (string[] | string)␊ - /**␊ - * true if detailed error logging is enabled; otherwise, false.␊ - */␊ - detailedErrorLoggingEnabled?: (boolean | string)␊ - /**␊ - * Document root.␊ - */␊ - documentRoot?: string␊ - /**␊ - * Routing rules in production experiments.␊ - */␊ - experiments?: (Experiments8 | string)␊ - /**␊ - * State of FTP / FTPS service.␊ - */␊ - ftpsState?: (("AllAllowed" | "FtpsOnly" | "Disabled") | string)␊ - /**␊ - * Maximum number of workers that a site can scale out to.␊ - * This setting only applies to the Consumption and Elastic Premium Plans␊ - */␊ - functionAppScaleLimit?: (number | string)␊ - /**␊ - * Gets or sets a value indicating whether functions runtime scale monitoring is enabled. When enabled,␊ - * the ScaleController will not monitor event sources directly, but will instead call to the␊ - * runtime to get scale status.␊ - */␊ - functionsRuntimeScaleMonitoringEnabled?: (boolean | string)␊ - /**␊ - * Handler mappings.␊ - */␊ - handlerMappings?: (HandlerMapping8[] | string)␊ - /**␊ - * Health check path␊ - */␊ - healthCheckPath?: string␊ - /**␊ - * Http20Enabled: configures a web site to allow clients to connect over http2.0␊ - */␊ - http20Enabled?: (boolean | string)␊ - /**␊ - * true if HTTP logging is enabled; otherwise, false.␊ - */␊ - httpLoggingEnabled?: (boolean | string)␊ - /**␊ - * IP security restrictions for main.␊ - */␊ - ipSecurityRestrictions?: (IpSecurityRestriction8[] | string)␊ - /**␊ - * Java container.␊ - */␊ - javaContainer?: string␊ - /**␊ - * Java container version.␊ - */␊ - javaContainerVersion?: string␊ - /**␊ - * Java version.␊ - */␊ - javaVersion?: string␊ - /**␊ - * Identity to use for Key Vault Reference authentication.␊ - */␊ - keyVaultReferenceIdentity?: string␊ - /**␊ - * Metric limits set on an app.␊ - */␊ - limits?: (SiteLimits8 | string)␊ - /**␊ - * Linux App Framework and version␊ - */␊ - linuxFxVersion?: string␊ - /**␊ - * Site load balancing.␊ - */␊ - loadBalancing?: (("WeightedRoundRobin" | "LeastRequests" | "LeastResponseTime" | "WeightedTotalTraffic" | "RequestHash" | "PerSiteRoundRobin") | string)␊ - /**␊ - * true to enable local MySQL; otherwise, false.␊ - */␊ - localMySqlEnabled?: (boolean | string)␊ - /**␊ - * HTTP logs directory size limit.␊ - */␊ - logsDirectorySizeLimit?: (number | string)␊ - /**␊ - * Managed pipeline mode.␊ - */␊ - managedPipelineMode?: (("Integrated" | "Classic") | string)␊ - /**␊ - * Managed Service Identity Id␊ - */␊ - managedServiceIdentityId?: (number | string)␊ - /**␊ - * Number of minimum instance count for a site␊ - * This setting only applies to the Elastic Plans␊ - */␊ - minimumElasticInstanceCount?: (number | string)␊ - /**␊ - * MinTlsVersion: configures the minimum version of TLS required for SSL requests.␊ - */␊ - minTlsVersion?: (("1.0" | "1.1" | "1.2") | string)␊ - /**␊ - * .NET Framework version.␊ - */␊ - netFrameworkVersion?: string␊ - /**␊ - * Version of Node.js.␊ - */␊ - nodeVersion?: string␊ - /**␊ - * Number of workers.␊ - */␊ - numberOfWorkers?: (number | string)␊ - /**␊ - * Version of PHP.␊ - */␊ - phpVersion?: string␊ - /**␊ - * Version of PowerShell.␊ - */␊ - powerShellVersion?: string␊ - /**␊ - * Number of preWarmed instances.␊ - * This setting only applies to the Consumption and Elastic Plans␊ - */␊ - preWarmedInstanceCount?: (number | string)␊ - /**␊ - * Property to allow or block all public traffic.␊ - */␊ - publicNetworkAccess?: string␊ - /**␊ - * Publishing user name.␊ - */␊ - publishingUsername?: string␊ - /**␊ - * Push settings for the App.␊ - */␊ - push?: (PushSettings7 | string)␊ - /**␊ - * Version of Python.␊ - */␊ - pythonVersion?: string␊ - /**␊ - * true if remote debugging is enabled; otherwise, false.␊ - */␊ - remoteDebuggingEnabled?: (boolean | string)␊ - /**␊ - * Remote debugging version.␊ - */␊ - remoteDebuggingVersion?: string␊ - /**␊ - * true if request tracing is enabled; otherwise, false.␊ - */␊ - requestTracingEnabled?: (boolean | string)␊ - /**␊ - * Request tracing expiration time.␊ - */␊ - requestTracingExpirationTime?: string␊ - /**␊ - * IP security restrictions for scm.␊ - */␊ - scmIpSecurityRestrictions?: (IpSecurityRestriction8[] | string)␊ - /**␊ - * IP security restrictions for scm to use main.␊ - */␊ - scmIpSecurityRestrictionsUseMain?: (boolean | string)␊ - /**␊ - * ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site.␊ - */␊ - scmMinTlsVersion?: (("1.0" | "1.1" | "1.2") | string)␊ - /**␊ - * SCM type.␊ - */␊ - scmType?: (("None" | "Dropbox" | "Tfs" | "LocalGit" | "GitHub" | "CodePlexGit" | "CodePlexHg" | "BitbucketGit" | "BitbucketHg" | "ExternalGit" | "ExternalHg" | "OneDrive" | "VSO" | "VSTSRM") | string)␊ - /**␊ - * Tracing options.␊ - */␊ - tracingOptions?: string␊ - /**␊ - * true to use 32-bit worker process; otherwise, false.␊ - */␊ - use32BitWorkerProcess?: (boolean | string)␊ - /**␊ - * Virtual applications.␊ - */␊ - virtualApplications?: (VirtualApplication8[] | string)␊ - /**␊ - * Virtual Network name.␊ - */␊ - vnetName?: string␊ - /**␊ - * The number of private ports assigned to this app. These will be assigned dynamically on runtime.␊ - */␊ - vnetPrivatePortsCount?: (number | string)␊ - /**␊ - * Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied.␊ - */␊ - vnetRouteAllEnabled?: (boolean | string)␊ - /**␊ - * Sets the time zone a site uses for generating timestamps. Compatible with Linux and Windows App Service. Setting the WEBSITE_TIME_ZONE app setting takes precedence over this config. For Linux, expects tz database values https://www.iana.org/time-zones (for a quick reference see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For Windows, expects one of the time zones listed under HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\Time Zones␊ - */␊ - websiteTimeZone?: string␊ - /**␊ - * true if WebSocket is enabled; otherwise, false.␊ - */␊ - webSocketsEnabled?: (boolean | string)␊ - /**␊ - * Xenon App Framework and version␊ - */␊ - windowsFxVersion?: string␊ - /**␊ - * Explicit Managed Service Identity Id␊ - */␊ - xManagedServiceIdentityId?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about the formal API definition for the app.␊ - */␊ - export interface ApiDefinitionInfo8 {␊ - /**␊ - * The URL of the API definition.␊ - */␊ - url?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure API management (APIM) configuration linked to the app.␊ - */␊ - export interface ApiManagementConfig4 {␊ - /**␊ - * APIM-Api Identifier.␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Rules that can be defined for auto-heal.␊ - */␊ - export interface AutoHealRules8 {␊ - /**␊ - * Actions which to take by the auto-heal module when a rule is triggered.␊ - */␊ - actions?: (AutoHealActions8 | string)␊ - /**␊ - * Triggers for auto-heal.␊ - */␊ - triggers?: (AutoHealTriggers8 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Actions which to take by the auto-heal module when a rule is triggered.␊ - */␊ - export interface AutoHealActions8 {␊ - /**␊ - * Predefined action to be taken.␊ - */␊ - actionType?: (("Recycle" | "LogEvent" | "CustomAction") | string)␊ - /**␊ - * Custom action to be executed␊ - * when an auto heal rule is triggered.␊ - */␊ - customAction?: (AutoHealCustomAction8 | string)␊ - /**␊ - * Minimum time the process must execute␊ - * before taking the action␊ - */␊ - minProcessExecutionTime?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Custom action to be executed␊ - * when an auto heal rule is triggered.␊ - */␊ - export interface AutoHealCustomAction8 {␊ - /**␊ - * Executable to be run.␊ - */␊ - exe?: string␊ - /**␊ - * Parameters for the executable.␊ - */␊ - parameters?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Triggers for auto-heal.␊ - */␊ - export interface AutoHealTriggers8 {␊ - /**␊ - * A rule based on private bytes.␊ - */␊ - privateBytesInKB?: (number | string)␊ - /**␊ - * Trigger based on total requests.␊ - */␊ - requests?: (RequestsBasedTrigger8 | string)␊ - /**␊ - * Trigger based on request execution time.␊ - */␊ - slowRequests?: (SlowRequestsBasedTrigger8 | string)␊ - /**␊ - * A rule based on multiple Slow Requests Rule with path␊ - */␊ - slowRequestsWithPath?: (SlowRequestsBasedTrigger8[] | string)␊ - /**␊ - * A rule based on status codes.␊ - */␊ - statusCodes?: (StatusCodesBasedTrigger8[] | string)␊ - /**␊ - * A rule based on status codes ranges.␊ - */␊ - statusCodesRange?: (StatusCodesRangeBasedTrigger[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trigger based on total requests.␊ - */␊ - export interface RequestsBasedTrigger8 {␊ - /**␊ - * Request Count.␊ - */␊ - count?: (number | string)␊ - /**␊ - * Time interval.␊ - */␊ - timeInterval?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trigger based on request execution time.␊ - */␊ - export interface SlowRequestsBasedTrigger8 {␊ - /**␊ - * Request Count.␊ - */␊ - count?: (number | string)␊ - /**␊ - * Request Path.␊ - */␊ - path?: string␊ - /**␊ - * Time interval.␊ - */␊ - timeInterval?: string␊ - /**␊ - * Time taken.␊ - */␊ - timeTaken?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trigger based on status code.␊ - */␊ - export interface StatusCodesBasedTrigger8 {␊ - /**␊ - * Request Count.␊ - */␊ - count?: (number | string)␊ - /**␊ - * Request Path␊ - */␊ - path?: string␊ - /**␊ - * HTTP status code.␊ - */␊ - status?: (number | string)␊ - /**␊ - * Request Sub Status.␊ - */␊ - subStatus?: (number | string)␊ - /**␊ - * Time interval.␊ - */␊ - timeInterval?: string␊ - /**␊ - * Win32 error code.␊ - */␊ - win32Status?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Trigger based on range of status codes.␊ - */␊ - export interface StatusCodesRangeBasedTrigger {␊ - /**␊ - * Request Count.␊ - */␊ - count?: (number | string)␊ - path?: string␊ - /**␊ - * HTTP status code.␊ - */␊ - statusCodes?: string␊ - /**␊ - * Time interval.␊ - */␊ - timeInterval?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Azure Files or Blob Storage access information value for dictionary storage.␊ - */␊ - export interface AzureStorageInfoValue6 {␊ - /**␊ - * Access key for the storage account.␊ - */␊ - accessKey?: string␊ - /**␊ - * Name of the storage account.␊ - */␊ - accountName?: string␊ - /**␊ - * Path to mount the storage within the site's runtime environment.␊ - */␊ - mountPath?: string␊ - /**␊ - * Name of the file share (container name, for Blob storage).␊ - */␊ - shareName?: string␊ - /**␊ - * Type of storage.␊ - */␊ - type?: (("AzureFiles" | "AzureBlob") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Database connection string information.␊ - */␊ - export interface ConnStringInfo8 {␊ - /**␊ - * Connection string value.␊ - */␊ - connectionString?: string␊ - /**␊ - * Name of connection string.␊ - */␊ - name?: string␊ - /**␊ - * Type of database.␊ - */␊ - type?: (("MySql" | "SQLServer" | "SQLAzure" | "Custom" | "NotificationHub" | "ServiceBus" | "EventHub" | "ApiHub" | "DocDb" | "RedisCache" | "PostgreSQL") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Cross-Origin Resource Sharing (CORS) settings for the app.␊ - */␊ - export interface CorsSettings8 {␊ - /**␊ - * 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.␊ - */␊ - allowedOrigins?: (string[] | string)␊ - /**␊ - * Gets or sets whether CORS requests with credentials are allowed. See ␊ - * https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials␊ - * for more details.␊ - */␊ - supportCredentials?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Routing rules in production experiments.␊ - */␊ - export interface Experiments8 {␊ - /**␊ - * List of ramp-up rules.␊ - */␊ - rampUpRules?: (RampUpRule8[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance.␊ - */␊ - export interface RampUpRule8 {␊ - /**␊ - * Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.␊ - */␊ - actionHostName?: string␊ - /**␊ - * 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/␊ - */␊ - changeDecisionCallbackUrl?: string␊ - /**␊ - * Specifies interval in minutes to reevaluate ReroutePercentage.␊ - */␊ - changeIntervalInMinutes?: (number | string)␊ - /**␊ - * In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \\nMinReroutePercentage or ␊ - * MaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\\nCustom decision algorithm ␊ - * can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl.␊ - */␊ - changeStep?: (number | string)␊ - /**␊ - * Specifies upper boundary below which ReroutePercentage will stay.␊ - */␊ - maxReroutePercentage?: (number | string)␊ - /**␊ - * Specifies lower boundary above which ReroutePercentage will stay.␊ - */␊ - minReroutePercentage?: (number | string)␊ - /**␊ - * Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment.␊ - */␊ - name?: string␊ - /**␊ - * Percentage of the traffic which will be redirected to ActionHostName.␊ - */␊ - reroutePercentage?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * 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.␊ - */␊ - export interface HandlerMapping8 {␊ - /**␊ - * Command-line arguments to be passed to the script processor.␊ - */␊ - arguments?: string␊ - /**␊ - * Requests with this extension will be handled using the specified FastCGI application.␊ - */␊ - extension?: string␊ - /**␊ - * The absolute path to the FastCGI application.␊ - */␊ - scriptProcessor?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * IP security restriction on an app.␊ - */␊ - export interface IpSecurityRestriction8 {␊ - /**␊ - * Allow or Deny access for this IP range.␊ - */␊ - action?: string␊ - /**␊ - * IP restriction rule description.␊ - */␊ - description?: string␊ - /**␊ - * IP restriction rule headers.␊ - * X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). ␊ - * The matching logic is ..␊ - * - If the property is null or empty (default), all hosts(or lack of) are allowed.␊ - * - A value is compared using ordinal-ignore-case (excluding port number).␊ - * - Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com␊ - * but not the root domain contoso.com or multi-level foo.bar.contoso.com␊ - * - Unicode host names are allowed but are converted to Punycode for matching.␊ - * ␊ - * X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples).␊ - * The matching logic is ..␊ - * - If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed.␊ - * - If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property.␊ - * ␊ - * X-Azure-FDID and X-FD-HealthProbe.␊ - * The matching logic is exact match.␊ - */␊ - headers?: ({␊ - [k: string]: string[]␊ - } | string)␊ - /**␊ - * IP address the security restriction is valid for.␊ - * It can be in form of pure ipv4 address (required SubnetMask property) or␊ - * CIDR notation such as ipv4/mask (leading bit match). For CIDR,␊ - * SubnetMask property must not be specified.␊ - */␊ - ipAddress?: string␊ - /**␊ - * IP restriction rule name.␊ - */␊ - name?: string␊ - /**␊ - * Priority of IP restriction rule.␊ - */␊ - priority?: (number | string)␊ - /**␊ - * Subnet mask for the range of IP addresses the restriction is valid for.␊ - */␊ - subnetMask?: string␊ - /**␊ - * (internal) Subnet traffic tag␊ - */␊ - subnetTrafficTag?: (number | string)␊ - /**␊ - * Defines what this IP filter will be used for. This is to support IP filtering on proxies.␊ - */␊ - tag?: (("Default" | "XffProxy" | "ServiceTag") | string)␊ - /**␊ - * Virtual network resource id␊ - */␊ - vnetSubnetResourceId?: string␊ - /**␊ - * (internal) Vnet traffic tag␊ - */␊ - vnetTrafficTag?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Metric limits set on an app.␊ - */␊ - export interface SiteLimits8 {␊ - /**␊ - * Maximum allowed disk size usage in MB.␊ - */␊ - maxDiskSizeInMb?: (number | string)␊ - /**␊ - * Maximum allowed memory usage in MB.␊ - */␊ - maxMemoryInMb?: (number | string)␊ - /**␊ - * Maximum allowed CPU usage percentage.␊ - */␊ - maxPercentageCpu?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Push settings for the App.␊ - */␊ - export interface PushSettings7 {␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * PushSettings resource specific properties␊ - */␊ - properties?: (PushSettingsProperties7 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * PushSettings resource specific properties␊ - */␊ - export interface PushSettingsProperties7 {␊ - /**␊ - * Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint.␊ - */␊ - dynamicTagsJson?: string␊ - /**␊ - * Gets or sets a flag indicating whether the Push endpoint is enabled.␊ - */␊ - isPushEnabled: (boolean | string)␊ - /**␊ - * 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.␊ - */␊ - tagsRequiringAuth?: string␊ - /**␊ - * Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.␊ - */␊ - tagWhitelistJson?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Virtual application in an app.␊ - */␊ - export interface VirtualApplication8 {␊ - /**␊ - * Physical path.␊ - */␊ - physicalPath?: string␊ - /**␊ - * true if preloading is enabled; otherwise, false.␊ - */␊ - preloadEnabled?: (boolean | string)␊ - /**␊ - * Virtual directories for virtual application.␊ - */␊ - virtualDirectories?: (VirtualDirectory8[] | string)␊ - /**␊ - * Virtual path.␊ - */␊ - virtualPath?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Directory for virtual application.␊ - */␊ - export interface VirtualDirectory8 {␊ - /**␊ - * Physical path.␊ - */␊ - physicalPath?: string␊ - /**␊ - * Path to virtual application.␊ - */␊ - virtualPath?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * CsmPublishingCredentialsPoliciesEntity resource specific properties␊ - */␊ - export interface CsmPublishingCredentialsPoliciesEntityProperties4 {␊ - /**␊ - * true to allow access to a publishing method; otherwise, false.␊ - */␊ - allow: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SiteAuthSettings resource specific properties␊ - */␊ - export interface SiteAuthSettingsProperties7 {␊ - /**␊ - * Gets a JSON string containing the Azure AD Acl settings.␊ - */␊ - aadClaimsAuthorization?: string␊ - /**␊ - * Login parameters to send to the OpenID Connect authorization endpoint when␊ - * a user logs in. Each parameter must be in the form "key=value".␊ - */␊ - additionalLoginParams?: (string[] | string)␊ - /**␊ - * 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.␊ - */␊ - allowedAudiences?: (string[] | string)␊ - /**␊ - * 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.␊ - */␊ - allowedExternalRedirectUrls?: (string[] | string)␊ - /**␊ - * The path of the config file containing auth settings.␊ - * If the path is relative, base will the site's root directory.␊ - */␊ - authFilePath?: string␊ - /**␊ - * 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␊ - */␊ - clientId?: string␊ - /**␊ - * 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␊ - */␊ - clientSecret?: string␊ - /**␊ - * An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as␊ - * a replacement for the Client Secret. It is also optional.␊ - */␊ - clientSecretCertificateThumbprint?: string␊ - /**␊ - * The app setting name that contains the client secret of the relying party application.␊ - */␊ - clientSecretSettingName?: string␊ - /**␊ - * The ConfigVersion of the Authentication / Authorization feature in use for the current app.␊ - * The setting in this value can control the behavior of the control plane for Authentication / Authorization.␊ - */␊ - configVersion?: string␊ - /**␊ - * 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".␊ - */␊ - defaultProvider?: (("AzureActiveDirectory" | "Facebook" | "Google" | "MicrosoftAccount" | "Twitter" | "Github") | string)␊ - /**␊ - * true if the Authentication / Authorization feature is enabled for the current app; otherwise, false.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * 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␊ - */␊ - facebookAppId?: string␊ - /**␊ - * 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␊ - */␊ - facebookAppSecret?: string␊ - /**␊ - * The app setting name that contains the app secret used for Facebook Login.␊ - */␊ - facebookAppSecretSettingName?: string␊ - /**␊ - * 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␊ - */␊ - facebookOAuthScopes?: (string[] | string)␊ - /**␊ - * The Client Id of the GitHub app used for login.␊ - * This setting is required for enabling Github login␊ - */␊ - gitHubClientId?: string␊ - /**␊ - * The Client Secret of the GitHub app used for Github Login.␊ - * This setting is required for enabling Github login.␊ - */␊ - gitHubClientSecret?: string␊ - /**␊ - * The app setting name that contains the client secret of the Github␊ - * app used for GitHub Login.␊ - */␊ - gitHubClientSecretSettingName?: string␊ - /**␊ - * The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication.␊ - * This setting is optional␊ - */␊ - gitHubOAuthScopes?: (string[] | string)␊ - /**␊ - * 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/␊ - */␊ - googleClientId?: string␊ - /**␊ - * 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/␊ - */␊ - googleClientSecret?: string␊ - /**␊ - * The app setting name that contains the client secret associated with ␊ - * the Google web application.␊ - */␊ - googleClientSecretSettingName?: string␊ - /**␊ - * 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/␊ - */␊ - googleOAuthScopes?: (string[] | string)␊ - /**␊ - * "true" if the auth config settings should be read from a file,␊ - * "false" otherwise␊ - */␊ - isAuthFromFile?: string␊ - /**␊ - * 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␊ - */␊ - issuer?: string␊ - /**␊ - * 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␊ - */␊ - microsoftAccountClientId?: string␊ - /**␊ - * 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␊ - */␊ - microsoftAccountClientSecret?: string␊ - /**␊ - * The app setting name containing the OAuth 2.0 client secret that was created for the␊ - * app used for authentication.␊ - */␊ - microsoftAccountClientSecretSettingName?: string␊ - /**␊ - * 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␊ - */␊ - microsoftAccountOAuthScopes?: (string[] | string)␊ - /**␊ - * 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.␊ - */␊ - runtimeVersion?: string␊ - /**␊ - * 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.␊ - */␊ - tokenRefreshExtensionHours?: (number | string)␊ - /**␊ - * true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.␊ - * The default is false.␊ - */␊ - tokenStoreEnabled?: (boolean | string)␊ - /**␊ - * 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␊ - */␊ - twitterConsumerKey?: string␊ - /**␊ - * 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␊ - */␊ - twitterConsumerSecret?: string␊ - /**␊ - * The app setting name that contains the OAuth 1.0a consumer secret of the Twitter␊ - * application used for sign-in.␊ - */␊ - twitterConsumerSecretSettingName?: string␊ - /**␊ - * The action to take when an unauthenticated client attempts to access the app.␊ - */␊ - unauthenticatedClientAction?: (("RedirectToLoginPage" | "AllowAnonymous") | string)␊ - /**␊ - * Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such.␊ - */␊ - validateIssuer?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SiteAuthSettingsV2 resource specific properties␊ - */␊ - export interface SiteAuthSettingsV2Properties3 {␊ - /**␊ - * The configuration settings that determines the validation flow of users using App Service Authentication/Authorization.␊ - */␊ - globalValidation?: (GlobalValidation3 | string)␊ - /**␊ - * The configuration settings of the HTTP requests for authentication and authorization requests made against App Service Authentication/Authorization.␊ - */␊ - httpSettings?: (HttpSettings3 | string)␊ - /**␊ - * The configuration settings of each of the identity providers used to configure App Service Authentication/Authorization.␊ - */␊ - identityProviders?: (IdentityProviders3 | string)␊ - /**␊ - * The configuration settings of the login flow of users using App Service Authentication/Authorization.␊ - */␊ - login?: (Login3 | string)␊ - /**␊ - * The configuration settings of the platform of App Service Authentication/Authorization.␊ - */␊ - platform?: (AuthPlatform3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The configuration settings that determines the validation flow of users using App Service Authentication/Authorization.␊ - */␊ - export interface GlobalValidation3 {␊ - /**␊ - * The paths for which unauthenticated flow would not be redirected to the login page.␊ - */␊ - excludedPaths?: (string[] | string)␊ - /**␊ - * 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".␊ - */␊ - redirectToProvider?: string␊ - /**␊ - * true if the authentication flow is required any request is made; otherwise, false.␊ - */␊ - requireAuthentication?: (boolean | string)␊ - /**␊ - * The action to take when an unauthenticated client attempts to access the app.␊ - */␊ - unauthenticatedClientAction?: (("RedirectToLoginPage" | "AllowAnonymous" | "Return401" | "Return403") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The configuration settings of the HTTP requests for authentication and authorization requests made against App Service Authentication/Authorization.␊ - */␊ - export interface HttpSettings3 {␊ - /**␊ - * The configuration settings of a forward proxy used to make the requests.␊ - */␊ - forwardProxy?: (ForwardProxy3 | string)␊ - /**␊ - * false if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, true.␊ - */␊ - requireHttps?: (boolean | string)␊ - /**␊ - * The configuration settings of the paths HTTP requests.␊ - */␊ - routes?: (HttpSettingsRoutes3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The configuration settings of a forward proxy used to make the requests.␊ - */␊ - export interface ForwardProxy3 {␊ - /**␊ - * The convention used to determine the url of the request made.␊ - */␊ - convention?: (("NoProxy" | "Standard" | "Custom") | string)␊ - /**␊ - * The name of the header containing the host of the request.␊ - */␊ - customHostHeaderName?: string␊ - /**␊ - * The name of the header containing the scheme of the request.␊ - */␊ - customProtoHeaderName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The configuration settings of the paths HTTP requests.␊ - */␊ - export interface HttpSettingsRoutes3 {␊ - /**␊ - * The prefix that should precede all the authentication/authorization paths.␊ - */␊ - apiPrefix?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The configuration settings of each of the identity providers used to configure App Service Authentication/Authorization.␊ - */␊ - export interface IdentityProviders3 {␊ - /**␊ - * The configuration settings of the Apple provider.␊ - */␊ - apple?: (Apple | string)␊ - /**␊ - * The configuration settings of the Azure Active directory provider.␊ - */␊ - azureActiveDirectory?: (AzureActiveDirectory8 | string)␊ - /**␊ - * The configuration settings of the Azure Static Web Apps provider.␊ - */␊ - azureStaticWebApps?: (AzureStaticWebApps | string)␊ - /**␊ - * The map of the name of the alias of each custom Open ID Connect provider to the␊ - * configuration settings of the custom Open ID Connect provider.␊ - */␊ - customOpenIdConnectProviders?: ({␊ - [k: string]: CustomOpenIdConnectProvider3␊ - } | string)␊ - /**␊ - * The configuration settings of the Facebook provider.␊ - */␊ - facebook?: (Facebook3 | string)␊ - /**␊ - * The configuration settings of the GitHub provider.␊ - */␊ - gitHub?: (GitHub3 | string)␊ - /**␊ - * The configuration settings of the Google provider.␊ - */␊ - google?: (Google3 | string)␊ - /**␊ - * The configuration settings of the legacy Microsoft Account provider.␊ - */␊ - legacyMicrosoftAccount?: (LegacyMicrosoftAccount | string)␊ - /**␊ - * The configuration settings of the Twitter provider.␊ - */␊ - twitter?: (Twitter3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The configuration settings of the Apple provider.␊ - */␊ - export interface Apple {␊ - /**␊ - * false if the Apple provider should not be enabled despite the set registration; otherwise, true.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * The configuration settings of the login flow, including the scopes that should be requested.␊ - */␊ - login?: (LoginScopes3 | string)␊ - /**␊ - * The configuration settings of the registration for the Apple provider␊ - */␊ - registration?: (AppleRegistration | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The configuration settings of the login flow, including the scopes that should be requested.␊ - */␊ - export interface LoginScopes3 {␊ - /**␊ - * A list of the scopes that should be requested while authenticating.␊ - */␊ - scopes?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The configuration settings of the registration for the Apple provider␊ - */␊ - export interface AppleRegistration {␊ - /**␊ - * The Client ID of the app used for login.␊ - */␊ - clientId?: string␊ - /**␊ - * The app setting name that contains the client secret.␊ - */␊ - clientSecretSettingName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The configuration settings of the Azure Active directory provider.␊ - */␊ - export interface AzureActiveDirectory8 {␊ - /**␊ - * false if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, true.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Gets a value indicating whether the Azure AD configuration was auto-provisioned using 1st party tooling.␊ - * This is an internal flag primarily intended to support the Azure Management Portal. Users should not␊ - * read or write to this property.␊ - */␊ - isAutoProvisioned?: (boolean | string)␊ - /**␊ - * The configuration settings of the Azure Active Directory login flow.␊ - */␊ - login?: (AzureActiveDirectoryLogin3 | string)␊ - /**␊ - * The configuration settings of the Azure Active Directory app registration.␊ - */␊ - registration?: (AzureActiveDirectoryRegistration3 | string)␊ - /**␊ - * The configuration settings of the Azure Active Directory token validation flow.␊ - */␊ - validation?: (AzureActiveDirectoryValidation3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The configuration settings of the Azure Active Directory login flow.␊ - */␊ - export interface AzureActiveDirectoryLogin3 {␊ - /**␊ - * true if the www-authenticate provider should be omitted from the request; otherwise, false.␊ - */␊ - disableWWWAuthenticate?: (boolean | string)␊ - /**␊ - * Login parameters to send to the OpenID Connect authorization endpoint when␊ - * a user logs in. Each parameter must be in the form "key=value".␊ - */␊ - loginParameters?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The configuration settings of the Azure Active Directory app registration.␊ - */␊ - export interface AzureActiveDirectoryRegistration3 {␊ - /**␊ - * 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␊ - */␊ - clientId?: string␊ - /**␊ - * An alternative to the client secret thumbprint, that is the issuer of a certificate used for signing purposes. This property acts as␊ - * a replacement for the Client Secret Certificate Thumbprint. It is also optional.␊ - */␊ - clientSecretCertificateIssuer?: string␊ - /**␊ - * An alternative to the client secret thumbprint, that is the subject alternative name of a certificate used for signing purposes. This property acts as␊ - * a replacement for the Client Secret Certificate Thumbprint. It is also optional.␊ - */␊ - clientSecretCertificateSubjectAlternativeName?: string␊ - /**␊ - * An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as␊ - * a replacement for the Client Secret. It is also optional.␊ - */␊ - clientSecretCertificateThumbprint?: string␊ - /**␊ - * The app setting name that contains the client secret of the relying party application.␊ - */␊ - clientSecretSettingName?: string␊ - /**␊ - * 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://login.microsoftonline.com/v2.0/{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␊ - */␊ - openIdIssuer?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The configuration settings of the Azure Active Directory token validation flow.␊ - */␊ - export interface AzureActiveDirectoryValidation3 {␊ - /**␊ - * The list of audiences that can make successful authentication/authorization requests.␊ - */␊ - allowedAudiences?: (string[] | string)␊ - /**␊ - * The configuration settings of the checks that should be made while validating the JWT Claims.␊ - */␊ - jwtClaimChecks?: (JwtClaimChecks3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The configuration settings of the checks that should be made while validating the JWT Claims.␊ - */␊ - export interface JwtClaimChecks3 {␊ - /**␊ - * The list of the allowed client applications.␊ - */␊ - allowedClientApplications?: (string[] | string)␊ - /**␊ - * The list of the allowed groups.␊ - */␊ - allowedGroups?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The configuration settings of the Azure Static Web Apps provider.␊ - */␊ - export interface AzureStaticWebApps {␊ - /**␊ - * false if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, true.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * The configuration settings of the registration for the Azure Static Web Apps provider␊ - */␊ - registration?: (AzureStaticWebAppsRegistration | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The configuration settings of the registration for the Azure Static Web Apps provider␊ - */␊ - export interface AzureStaticWebAppsRegistration {␊ - /**␊ - * The Client ID of the app used for login.␊ - */␊ - clientId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The configuration settings of the custom Open ID Connect provider.␊ - */␊ - export interface CustomOpenIdConnectProvider3 {␊ - /**␊ - * false if the custom Open ID provider provider should not be enabled; otherwise, true.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * The configuration settings of the login flow of the custom Open ID Connect provider.␊ - */␊ - login?: (OpenIdConnectLogin3 | string)␊ - /**␊ - * The configuration settings of the app registration for the custom Open ID Connect provider.␊ - */␊ - registration?: (OpenIdConnectRegistration3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The configuration settings of the login flow of the custom Open ID Connect provider.␊ - */␊ - export interface OpenIdConnectLogin3 {␊ - /**␊ - * The name of the claim that contains the users name.␊ - */␊ - nameClaimType?: string␊ - /**␊ - * A list of the scopes that should be requested while authenticating.␊ - */␊ - scopes?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The configuration settings of the app registration for the custom Open ID Connect provider.␊ - */␊ - export interface OpenIdConnectRegistration3 {␊ - /**␊ - * The authentication client credentials of the custom Open ID Connect provider.␊ - */␊ - clientCredential?: (OpenIdConnectClientCredential3 | string)␊ - /**␊ - * The client id of the custom Open ID Connect provider.␊ - */␊ - clientId?: string␊ - /**␊ - * The configuration settings of the endpoints used for the custom Open ID Connect provider.␊ - */␊ - openIdConnectConfiguration?: (OpenIdConnectConfig3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The authentication client credentials of the custom Open ID Connect provider.␊ - */␊ - export interface OpenIdConnectClientCredential3 {␊ - /**␊ - * The app setting that contains the client secret for the custom Open ID Connect provider.␊ - */␊ - clientSecretSettingName?: string␊ - /**␊ - * The method that should be used to authenticate the user.␊ - */␊ - method?: ("ClientSecretPost" | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The configuration settings of the endpoints used for the custom Open ID Connect provider.␊ - */␊ - export interface OpenIdConnectConfig3 {␊ - /**␊ - * The endpoint to be used to make an authorization request.␊ - */␊ - authorizationEndpoint?: string␊ - /**␊ - * The endpoint that provides the keys necessary to validate the token.␊ - */␊ - certificationUri?: string␊ - /**␊ - * The endpoint that issues the token.␊ - */␊ - issuer?: string␊ - /**␊ - * The endpoint to be used to request a token.␊ - */␊ - tokenEndpoint?: string␊ - /**␊ - * The endpoint that contains all the configuration endpoints for the provider.␊ - */␊ - wellKnownOpenIdConfiguration?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The configuration settings of the Facebook provider.␊ - */␊ - export interface Facebook3 {␊ - /**␊ - * false if the Facebook provider should not be enabled despite the set registration; otherwise, true.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * The version of the Facebook api to be used while logging in.␊ - */␊ - graphApiVersion?: string␊ - /**␊ - * The configuration settings of the login flow, including the scopes that should be requested.␊ - */␊ - login?: (LoginScopes3 | string)␊ - /**␊ - * The configuration settings of the app registration for providers that have app ids and app secrets␊ - */␊ - registration?: (AppRegistration3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The configuration settings of the app registration for providers that have app ids and app secrets␊ - */␊ - export interface AppRegistration3 {␊ - /**␊ - * The App ID of the app used for login.␊ - */␊ - appId?: string␊ - /**␊ - * The app setting name that contains the app secret.␊ - */␊ - appSecretSettingName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The configuration settings of the GitHub provider.␊ - */␊ - export interface GitHub3 {␊ - /**␊ - * false if the GitHub provider should not be enabled despite the set registration; otherwise, true.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * The configuration settings of the login flow, including the scopes that should be requested.␊ - */␊ - login?: (LoginScopes3 | string)␊ - /**␊ - * The configuration settings of the app registration for providers that have client ids and client secrets␊ - */␊ - registration?: (ClientRegistration3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The configuration settings of the app registration for providers that have client ids and client secrets␊ - */␊ - export interface ClientRegistration3 {␊ - /**␊ - * The Client ID of the app used for login.␊ - */␊ - clientId?: string␊ - /**␊ - * The app setting name that contains the client secret.␊ - */␊ - clientSecretSettingName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The configuration settings of the Google provider.␊ - */␊ - export interface Google3 {␊ - /**␊ - * false if the Google provider should not be enabled despite the set registration; otherwise, true.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * The configuration settings of the login flow, including the scopes that should be requested.␊ - */␊ - login?: (LoginScopes3 | string)␊ - /**␊ - * The configuration settings of the app registration for providers that have client ids and client secrets␊ - */␊ - registration?: (ClientRegistration3 | string)␊ - /**␊ - * The configuration settings of the Allowed Audiences validation flow.␊ - */␊ - validation?: (AllowedAudiencesValidation3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The configuration settings of the Allowed Audiences validation flow.␊ - */␊ - export interface AllowedAudiencesValidation3 {␊ - /**␊ - * The configuration settings of the allowed list of audiences from which to validate the JWT token.␊ - */␊ - allowedAudiences?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The configuration settings of the legacy Microsoft Account provider.␊ - */␊ - export interface LegacyMicrosoftAccount {␊ - /**␊ - * false if the legacy Microsoft Account provider should not be enabled despite the set registration; otherwise, true.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * The configuration settings of the login flow, including the scopes that should be requested.␊ - */␊ - login?: (LoginScopes3 | string)␊ - /**␊ - * The configuration settings of the app registration for providers that have client ids and client secrets␊ - */␊ - registration?: (ClientRegistration3 | string)␊ - /**␊ - * The configuration settings of the Allowed Audiences validation flow.␊ - */␊ - validation?: (AllowedAudiencesValidation3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The configuration settings of the Twitter provider.␊ - */␊ - export interface Twitter3 {␊ - /**␊ - * false if the Twitter provider should not be enabled despite the set registration; otherwise, true.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * The configuration settings of the app registration for the Twitter provider.␊ - */␊ - registration?: (TwitterRegistration3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The configuration settings of the app registration for the Twitter provider.␊ - */␊ - export interface TwitterRegistration3 {␊ - /**␊ - * 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␊ - */␊ - consumerKey?: string␊ - /**␊ - * The app setting name that contains the OAuth 1.0a consumer secret of the Twitter␊ - * application used for sign-in.␊ - */␊ - consumerSecretSettingName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The configuration settings of the login flow of users using App Service Authentication/Authorization.␊ - */␊ - export interface Login3 {␊ - /**␊ - * 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.␊ - */␊ - allowedExternalRedirectUrls?: (string[] | string)␊ - /**␊ - * The configuration settings of the session cookie's expiration.␊ - */␊ - cookieExpiration?: (CookieExpiration3 | string)␊ - /**␊ - * The configuration settings of the nonce used in the login flow.␊ - */␊ - nonce?: (Nonce3 | string)␊ - /**␊ - * true if the fragments from the request are preserved after the login request is made; otherwise, false.␊ - */␊ - preserveUrlFragmentsForLogins?: (boolean | string)␊ - /**␊ - * The routes that specify the endpoints used for login and logout requests.␊ - */␊ - routes?: (LoginRoutes3 | string)␊ - /**␊ - * The configuration settings of the token store.␊ - */␊ - tokenStore?: (TokenStore3 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The configuration settings of the session cookie's expiration.␊ - */␊ - export interface CookieExpiration3 {␊ - /**␊ - * The convention used when determining the session cookie's expiration.␊ - */␊ - convention?: (("FixedTime" | "IdentityProviderDerived") | string)␊ - /**␊ - * The time after the request is made when the session cookie should expire.␊ - */␊ - timeToExpiration?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The configuration settings of the nonce used in the login flow.␊ - */␊ - export interface Nonce3 {␊ - /**␊ - * The time after the request is made when the nonce should expire.␊ - */␊ - nonceExpirationInterval?: string␊ - /**␊ - * false if the nonce should not be validated while completing the login flow; otherwise, true.␊ - */␊ - validateNonce?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The routes that specify the endpoints used for login and logout requests.␊ - */␊ - export interface LoginRoutes3 {␊ - /**␊ - * The endpoint at which a logout request should be made.␊ - */␊ - logoutEndpoint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The configuration settings of the token store.␊ - */␊ - export interface TokenStore3 {␊ - /**␊ - * The configuration settings of the storage of the tokens if blob storage is used.␊ - */␊ - azureBlobStorage?: (BlobStorageTokenStore3 | string)␊ - /**␊ - * true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.␊ - * The default is false.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * The configuration settings of the storage of the tokens if a file system is used.␊ - */␊ - fileSystem?: (FileSystemTokenStore3 | string)␊ - /**␊ - * 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.␊ - */␊ - tokenRefreshExtensionHours?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The configuration settings of the storage of the tokens if blob storage is used.␊ - */␊ - export interface BlobStorageTokenStore3 {␊ - /**␊ - * The name of the app setting containing the SAS URL of the blob storage containing the tokens.␊ - */␊ - sasUrlSettingName?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The configuration settings of the storage of the tokens if a file system is used.␊ - */␊ - export interface FileSystemTokenStore3 {␊ - /**␊ - * The directory in which the tokens will be stored.␊ - */␊ - directory?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The configuration settings of the platform of App Service Authentication/Authorization.␊ - */␊ - export interface AuthPlatform3 {␊ - /**␊ - * The path of the config file containing auth settings if they come from a file.␊ - * If the path is relative, base will the site's root directory.␊ - */␊ - configFilePath?: string␊ - /**␊ - * true if the Authentication / Authorization feature is enabled for the current app; otherwise, false.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * 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.␊ - */␊ - runtimeVersion?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * BackupRequest resource specific properties␊ - */␊ - export interface BackupRequestProperties8 {␊ - /**␊ - * Name of the backup.␊ - */␊ - backupName?: string␊ - /**␊ - * Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy.␊ - */␊ - backupSchedule?: (BackupSchedule8 | string)␊ - /**␊ - * Databases included in the backup.␊ - */␊ - databases?: (DatabaseBackupSetting8[] | string)␊ - /**␊ - * True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * SAS URL to the container.␊ - */␊ - storageAccountUrl: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy.␊ - */␊ - export interface BackupSchedule8 {␊ - /**␊ - * 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)␊ - */␊ - frequencyInterval: ((number & string) | string)␊ - /**␊ - * 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).␊ - */␊ - frequencyUnit: (("Day" | "Hour") | string)␊ - /**␊ - * True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise.␊ - */␊ - keepAtLeastOneBackup: (boolean | string)␊ - /**␊ - * After how many days backups should be deleted.␊ - */␊ - retentionPeriodInDays: ((number & string) | string)␊ - /**␊ - * When the schedule should start working.␊ - */␊ - startTime?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Database backup settings.␊ - */␊ - export interface DatabaseBackupSetting8 {␊ - /**␊ - * 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.␊ - */␊ - connectionString?: string␊ - /**␊ - * Contains a connection string name that is linked to the SiteConfig.ConnectionStrings.␊ - * This is used during restore with overwrite connection strings options.␊ - */␊ - connectionStringName?: string␊ - /**␊ - * Database type (e.g. SqlAzure / MySql).␊ - */␊ - databaseType: (("SqlAzure" | "MySql" | "LocalMySql" | "PostgreSql") | string)␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Database connection string value to type pair.␊ - */␊ - export interface ConnStringValueTypePair8 {␊ - /**␊ - * Type of database.␊ - */␊ - type: (("MySql" | "SQLServer" | "SQLAzure" | "Custom" | "NotificationHub" | "ServiceBus" | "EventHub" | "ApiHub" | "DocDb" | "RedisCache" | "PostgreSQL") | string)␊ - /**␊ - * Value of pair.␊ - */␊ - value: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SiteLogsConfig resource specific properties␊ - */␊ - export interface SiteLogsConfigProperties8 {␊ - /**␊ - * Application logs configuration.␊ - */␊ - applicationLogs?: (ApplicationLogsConfig8 | string)␊ - /**␊ - * Enabled configuration.␊ - */␊ - detailedErrorMessages?: (EnabledConfig8 | string)␊ - /**␊ - * Enabled configuration.␊ - */␊ - failedRequestsTracing?: (EnabledConfig8 | string)␊ - /**␊ - * Http logs configuration.␊ - */␊ - httpLogs?: (HttpLogsConfig8 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application logs configuration.␊ - */␊ - export interface ApplicationLogsConfig8 {␊ - /**␊ - * Application logs azure blob storage configuration.␊ - */␊ - azureBlobStorage?: (AzureBlobStorageApplicationLogsConfig8 | string)␊ - /**␊ - * Application logs to Azure table storage configuration.␊ - */␊ - azureTableStorage?: (AzureTableStorageApplicationLogsConfig8 | string)␊ - /**␊ - * Application logs to file system configuration.␊ - */␊ - fileSystem?: (FileSystemApplicationLogsConfig8 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application logs azure blob storage configuration.␊ - */␊ - export interface AzureBlobStorageApplicationLogsConfig8 {␊ - /**␊ - * Log level.␊ - */␊ - level?: (("Off" | "Verbose" | "Information" | "Warning" | "Error") | string)␊ - /**␊ - * Retention in days.␊ - * Remove blobs older than X days.␊ - * 0 or lower means no retention.␊ - */␊ - retentionInDays?: (number | string)␊ - /**␊ - * SAS url to a azure blob container with read/write/list/delete permissions.␊ - */␊ - sasUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application logs to Azure table storage configuration.␊ - */␊ - export interface AzureTableStorageApplicationLogsConfig8 {␊ - /**␊ - * Log level.␊ - */␊ - level?: (("Off" | "Verbose" | "Information" | "Warning" | "Error") | string)␊ - /**␊ - * SAS URL to an Azure table with add/query/delete permissions.␊ - */␊ - sasUrl: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Application logs to file system configuration.␊ - */␊ - export interface FileSystemApplicationLogsConfig8 {␊ - /**␊ - * Log level.␊ - */␊ - level?: (("Off" | "Verbose" | "Information" | "Warning" | "Error") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Enabled configuration.␊ - */␊ - export interface EnabledConfig8 {␊ - /**␊ - * True if configuration is enabled, false if it is disabled and null if configuration is not set.␊ - */␊ - enabled?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http logs configuration.␊ - */␊ - export interface HttpLogsConfig8 {␊ - /**␊ - * Http logs to azure blob storage configuration.␊ - */␊ - azureBlobStorage?: (AzureBlobStorageHttpLogsConfig8 | string)␊ - /**␊ - * Http logs to file system configuration.␊ - */␊ - fileSystem?: (FileSystemHttpLogsConfig8 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http logs to azure blob storage configuration.␊ - */␊ - export interface AzureBlobStorageHttpLogsConfig8 {␊ - /**␊ - * True if configuration is enabled, false if it is disabled and null if configuration is not set.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Retention in days.␊ - * Remove blobs older than X days.␊ - * 0 or lower means no retention.␊ - */␊ - retentionInDays?: (number | string)␊ - /**␊ - * SAS url to a azure blob container with read/write/list/delete permissions.␊ - */␊ - sasUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Http logs to file system configuration.␊ - */␊ - export interface FileSystemHttpLogsConfig8 {␊ - /**␊ - * True if configuration is enabled, false if it is disabled and null if configuration is not set.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * Retention in days.␊ - * Remove files older than X days.␊ - * 0 or lower means no retention.␊ - */␊ - retentionInDays?: (number | string)␊ - /**␊ - * 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.␊ - */␊ - retentionInMb?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Names for connection strings, application settings, and external Azure storage account configuration␊ - * identifiers 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.␊ - */␊ - export interface SlotConfigNames7 {␊ - /**␊ - * List of application settings names.␊ - */␊ - appSettingNames?: (string[] | string)␊ - /**␊ - * List of external Azure storage account identifiers.␊ - */␊ - azureStorageConfigNames?: (string[] | string)␊ - /**␊ - * List of connection string names.␊ - */␊ - connectionStringNames?: (string[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/deployments␊ - */␊ - export interface SitesDeploymentsChildResource8 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * ID of an existing deployment.␊ - */␊ - name: string␊ - /**␊ - * Deployment resource specific properties␊ - */␊ - properties: (DeploymentProperties10 | string)␊ - type: "deployments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Deployment resource specific properties␊ - */␊ - export interface DeploymentProperties10 {␊ - /**␊ - * True if deployment is currently active, false if completed and null if not started.␊ - */␊ - active?: (boolean | string)␊ - /**␊ - * Who authored the deployment.␊ - */␊ - author?: string␊ - /**␊ - * Author email.␊ - */␊ - author_email?: string␊ - /**␊ - * Who performed the deployment.␊ - */␊ - deployer?: string␊ - /**␊ - * Details on deployment.␊ - */␊ - details?: string␊ - /**␊ - * End time.␊ - */␊ - end_time?: string␊ - /**␊ - * Details about deployment status.␊ - */␊ - message?: string␊ - /**␊ - * Start time.␊ - */␊ - start_time?: string␊ - /**␊ - * Deployment status.␊ - */␊ - status?: (number | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/domainOwnershipIdentifiers␊ - */␊ - export interface SitesDomainOwnershipIdentifiersChildResource7 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of domain ownership identifier.␊ - */␊ - name: string␊ - /**␊ - * Identifier resource specific properties␊ - */␊ - properties: (IdentifierProperties7 | string)␊ - type: "domainOwnershipIdentifiers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identifier resource specific properties␊ - */␊ - export interface IdentifierProperties7 {␊ - /**␊ - * String representation of the identity.␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/extensions␊ - */␊ - export interface SitesExtensionsChildResource7 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "MSDeploy"␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - properties: (MSDeployCore7 | string)␊ - type: "extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - export interface MSDeployCore7 {␊ - /**␊ - * Sets the AppOffline rule while the MSDeploy operation executes.␊ - * Setting is false by default.␊ - */␊ - appOffline?: (boolean | string)␊ - /**␊ - * SQL Connection String␊ - */␊ - connectionString?: string␊ - /**␊ - * Database Type␊ - */␊ - dbType?: string␊ - /**␊ - * Package URI␊ - */␊ - packageUri?: string␊ - /**␊ - * MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used.␊ - */␊ - setParameters?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * URI of MSDeploy Parameters file. Must not be set if SetParameters is used.␊ - */␊ - setParametersXmlFileUri?: string␊ - /**␊ - * 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.␊ - */␊ - skipAppData?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/functions␊ - */␊ - export interface SitesFunctionsChildResource7 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Function name.␊ - */␊ - name: string␊ - /**␊ - * FunctionEnvelope resource specific properties␊ - */␊ - properties: (FunctionEnvelopeProperties7 | string)␊ - type: "functions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * FunctionEnvelope resource specific properties␊ - */␊ - export interface FunctionEnvelopeProperties7 {␊ - /**␊ - * Config information.␊ - */␊ - config?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Config URI.␊ - */␊ - config_href?: string␊ - /**␊ - * File list.␊ - */␊ - files?: ({␊ - [k: string]: string␊ - } | string)␊ - /**␊ - * Function App ID.␊ - */␊ - function_app_id?: string␊ - /**␊ - * Function URI.␊ - */␊ - href?: string␊ - /**␊ - * The invocation URL␊ - */␊ - invoke_url_template?: string␊ - /**␊ - * Gets or sets a value indicating whether the function is disabled␊ - */␊ - isDisabled?: (boolean | string)␊ - /**␊ - * The function language␊ - */␊ - language?: string␊ - /**␊ - * Script URI.␊ - */␊ - script_href?: string␊ - /**␊ - * Script root path URI.␊ - */␊ - script_root_path_href?: string␊ - /**␊ - * Secrets file URI.␊ - */␊ - secrets_file_href?: string␊ - /**␊ - * Test data used when testing via the Azure Portal.␊ - */␊ - test_data?: string␊ - /**␊ - * Test data URI.␊ - */␊ - test_data_href?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/hostNameBindings␊ - */␊ - export interface SitesHostNameBindingsChildResource8 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Hostname in the hostname binding.␊ - */␊ - name: string␊ - /**␊ - * HostNameBinding resource specific properties␊ - */␊ - properties: (HostNameBindingProperties8 | string)␊ - type: "hostNameBindings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HostNameBinding resource specific properties␊ - */␊ - export interface HostNameBindingProperties8 {␊ - /**␊ - * Azure resource name.␊ - */␊ - azureResourceName?: string␊ - /**␊ - * Azure resource type.␊ - */␊ - azureResourceType?: (("Website" | "TrafficManager") | string)␊ - /**␊ - * Custom DNS record type.␊ - */␊ - customHostNameDnsRecordType?: (("CName" | "A") | string)␊ - /**␊ - * Fully qualified ARM domain resource URI.␊ - */␊ - domainId?: string␊ - /**␊ - * Hostname type.␊ - */␊ - hostNameType?: (("Verified" | "Managed") | string)␊ - /**␊ - * App Service app name.␊ - */␊ - siteName?: string␊ - /**␊ - * SSL type.␊ - */␊ - sslState?: (("Disabled" | "SniEnabled" | "IpBasedEnabled") | string)␊ - /**␊ - * SSL certificate thumbprint␊ - */␊ - thumbprint?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/hybridconnection␊ - */␊ - export interface SitesHybridconnectionChildResource8 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the hybrid connection configuration.␊ - */␊ - name: string␊ - /**␊ - * RelayServiceConnectionEntity resource specific properties␊ - */␊ - properties: (RelayServiceConnectionEntityProperties8 | string)␊ - type: "hybridconnection"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * RelayServiceConnectionEntity resource specific properties␊ - */␊ - export interface RelayServiceConnectionEntityProperties8 {␊ - biztalkUri?: string␊ - entityConnectionString?: string␊ - entityName?: string␊ - hostname?: string␊ - port?: (number | string)␊ - resourceConnectionString?: string␊ - resourceType?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/migrate␊ - */␊ - export interface SitesMigrateChildResource7 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "migrate"␊ - /**␊ - * StorageMigrationOptions resource specific properties␊ - */␊ - properties: (StorageMigrationOptionsProperties7 | string)␊ - type: "migrate"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * StorageMigrationOptions resource specific properties␊ - */␊ - export interface StorageMigrationOptionsProperties7 {␊ - /**␊ - * AzureFiles connection string.␊ - */␊ - azurefilesConnectionString: string␊ - /**␊ - * AzureFiles share.␊ - */␊ - azurefilesShare: string␊ - /**␊ - * true if the app should be read only during copy operation; otherwise, false.␊ - */␊ - blockWriteAccessToSite?: (boolean | string)␊ - /**␊ - * trueif the app should be switched over; otherwise, false.␊ - */␊ - switchSiteAfterMigration?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/networkConfig␊ - */␊ - export interface SitesNetworkConfigChildResource6 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "virtualNetwork"␊ - /**␊ - * SwiftVirtualNetwork resource specific properties␊ - */␊ - properties: (SwiftVirtualNetworkProperties6 | string)␊ - type: "networkConfig"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SwiftVirtualNetwork resource specific properties␊ - */␊ - export interface SwiftVirtualNetworkProperties6 {␊ - /**␊ - * The Virtual Network subnet's resource ID. This is the subnet that this Web App will join. This subnet must have a delegation to Microsoft.Web/serverFarms defined first.␊ - */␊ - subnetResourceId?: string␊ - /**␊ - * A flag that specifies if the scale unit this Web App is on supports Swift integration.␊ - */␊ - swiftSupported?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/premieraddons␊ - */␊ - export interface SitesPremieraddonsChildResource8 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Add-on name.␊ - */␊ - name: string␊ - /**␊ - * PremierAddOn resource specific properties␊ - */␊ - properties: (PremierAddOnProperties7 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "premieraddons"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * PremierAddOn resource specific properties␊ - */␊ - export interface PremierAddOnProperties7 {␊ - /**␊ - * Premier add on Marketplace offer.␊ - */␊ - marketplaceOffer?: string␊ - /**␊ - * Premier add on Marketplace publisher.␊ - */␊ - marketplacePublisher?: string␊ - /**␊ - * Premier add on Product.␊ - */␊ - product?: string␊ - /**␊ - * Premier add on SKU.␊ - */␊ - sku?: string␊ - /**␊ - * Premier add on Vendor.␊ - */␊ - vendor?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/privateAccess␊ - */␊ - export interface SitesPrivateAccessChildResource6 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "virtualNetworks"␊ - /**␊ - * PrivateAccess resource specific properties␊ - */␊ - properties: (PrivateAccessProperties6 | string)␊ - type: "privateAccess"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * PrivateAccess resource specific properties␊ - */␊ - export interface PrivateAccessProperties6 {␊ - /**␊ - * Whether private access is enabled or not.␊ - */␊ - enabled?: (boolean | string)␊ - /**␊ - * The Virtual Networks (and subnets) allowed to access the site privately.␊ - */␊ - virtualNetworks?: (PrivateAccessVirtualNetwork6[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a Virtual Network that is useable for private site access.␊ - */␊ - export interface PrivateAccessVirtualNetwork6 {␊ - /**␊ - * The key (ID) of the Virtual Network.␊ - */␊ - key?: (number | string)␊ - /**␊ - * The name of the Virtual Network.␊ - */␊ - name?: string␊ - /**␊ - * The ARM uri of the Virtual Network␊ - */␊ - resourceId?: string␊ - /**␊ - * A List of subnets that access is allowed to on this Virtual Network. An empty array (but not null) is interpreted to mean that all subnets are allowed within this Virtual Network.␊ - */␊ - subnets?: (PrivateAccessSubnet6[] | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Description of a Virtual Network subnet that is useable for private site access.␊ - */␊ - export interface PrivateAccessSubnet6 {␊ - /**␊ - * The key (ID) of the subnet.␊ - */␊ - key?: (number | string)␊ - /**␊ - * The name of the subnet.␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/privateEndpointConnections␊ - */␊ - export interface SitesPrivateEndpointConnectionsChildResource4 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the private endpoint connection.␊ - */␊ - name: string␊ - /**␊ - * A request to approve or reject a private endpoint connection␊ - */␊ - properties: (PrivateLinkConnectionApprovalRequest5 | string)␊ - type: "privateEndpointConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/publicCertificates␊ - */␊ - export interface SitesPublicCertificatesChildResource7 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Public certificate name.␊ - */␊ - name: string␊ - /**␊ - * PublicCertificate resource specific properties␊ - */␊ - properties: (PublicCertificateProperties7 | string)␊ - type: "publicCertificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * PublicCertificate resource specific properties␊ - */␊ - export interface PublicCertificateProperties7 {␊ - /**␊ - * Public Certificate byte array␊ - */␊ - blob?: string␊ - /**␊ - * Public Certificate Location.␊ - */␊ - publicCertificateLocation?: (("CurrentUserMy" | "LocalMachineMy" | "Unknown") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/siteextensions␊ - */␊ - export interface SitesSiteextensionsChildResource7 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Site extension name.␊ - */␊ - name: string␊ - type: "siteextensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots␊ - */␊ - export interface SitesSlotsChildResource8 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Managed service identity.␊ - */␊ - identity?: (ManagedServiceIdentity21 | string)␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the deployment slot to create or update. The name 'production' is reserved.␊ - */␊ - name: string␊ - /**␊ - * Site resource specific properties␊ - */␊ - properties: (SiteProperties8 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "slots"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/sourcecontrols␊ - */␊ - export interface SitesSourcecontrolsChildResource8 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "web"␊ - /**␊ - * SiteSourceControl resource specific properties␊ - */␊ - properties: (SiteSourceControlProperties8 | string)␊ - type: "sourcecontrols"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SiteSourceControl resource specific properties␊ - */␊ - export interface SiteSourceControlProperties8 {␊ - /**␊ - * Name of branch to use for deployment.␊ - */␊ - branch?: string␊ - /**␊ - * true to enable deployment rollback; otherwise, false.␊ - */␊ - deploymentRollbackEnabled?: (boolean | string)␊ - /**␊ - * The GitHub action configuration.␊ - */␊ - gitHubActionConfiguration?: (GitHubActionConfiguration | string)␊ - /**␊ - * true if this is deployed via GitHub action.␊ - */␊ - isGitHubAction?: (boolean | string)␊ - /**␊ - * true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub).␊ - */␊ - isManualIntegration?: (boolean | string)␊ - /**␊ - * true for a Mercurial repository; false for a Git repository.␊ - */␊ - isMercurial?: (boolean | string)␊ - /**␊ - * Repository or source control URL.␊ - */␊ - repoUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The GitHub action configuration.␊ - */␊ - export interface GitHubActionConfiguration {␊ - /**␊ - * The GitHub action code configuration.␊ - */␊ - codeConfiguration?: (GitHubActionCodeConfiguration | string)␊ - /**␊ - * The GitHub action container configuration.␊ - */␊ - containerConfiguration?: (GitHubActionContainerConfiguration | string)␊ - /**␊ - * Workflow option to determine whether the workflow file should be generated and written to the repository.␊ - */␊ - generateWorkflowFile?: (boolean | string)␊ - /**␊ - * This will help determine the workflow configuration to select.␊ - */␊ - isLinux?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The GitHub action code configuration.␊ - */␊ - export interface GitHubActionCodeConfiguration {␊ - /**␊ - * Runtime stack is used to determine the workflow file content for code base apps.␊ - */␊ - runtimeStack?: string␊ - /**␊ - * Runtime version is used to determine what build version to set in the workflow file.␊ - */␊ - runtimeVersion?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The GitHub action container configuration.␊ - */␊ - export interface GitHubActionContainerConfiguration {␊ - /**␊ - * The image name for the build.␊ - */␊ - imageName?: string␊ - /**␊ - * The password used to upload the image to the container registry.␊ - */␊ - password?: string␊ - /**␊ - * The server URL for the container registry where the build will be hosted.␊ - */␊ - serverUrl?: string␊ - /**␊ - * The username used to upload the image to the container registry.␊ - */␊ - username?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/virtualNetworkConnections␊ - */␊ - export interface SitesVirtualNetworkConnectionsChildResource8 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of an existing Virtual Network.␊ - */␊ - name: string␊ - /**␊ - * VnetInfo resource specific properties␊ - */␊ - properties: (VnetInfoProperties8 | string)␊ - type: "virtualNetworkConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * VnetInfo resource specific properties␊ - */␊ - export interface VnetInfoProperties8 {␊ - /**␊ - * A certificate file (.cer) blob containing the public key of the private key used to authenticate a ␊ - * Point-To-Site VPN connection.␊ - */␊ - certBlob?: string␊ - /**␊ - * DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses.␊ - */␊ - dnsServers?: string␊ - /**␊ - * Flag that is used to denote if this is VNET injection␊ - */␊ - isSwift?: (boolean | string)␊ - /**␊ - * The Virtual Network's resource ID.␊ - */␊ - vnetResourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/deployments␊ - */␊ - export interface SitesDeployments8 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * ID of an existing deployment.␊ - */␊ - name: string␊ - /**␊ - * Deployment resource specific properties␊ - */␊ - properties: (DeploymentProperties10 | string)␊ - type: "Microsoft.Web/sites/deployments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/domainOwnershipIdentifiers␊ - */␊ - export interface SitesDomainOwnershipIdentifiers7 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of domain ownership identifier.␊ - */␊ - name: string␊ - /**␊ - * Identifier resource specific properties␊ - */␊ - properties: (IdentifierProperties7 | string)␊ - type: "Microsoft.Web/sites/domainOwnershipIdentifiers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/extensions␊ - */␊ - export interface SitesExtensions7 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - properties: (MSDeployCore7 | string)␊ - type: "Microsoft.Web/sites/extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/functions␊ - */␊ - export interface SitesFunctions7 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Function name.␊ - */␊ - name: string␊ - /**␊ - * FunctionEnvelope resource specific properties␊ - */␊ - properties: (FunctionEnvelopeProperties7 | string)␊ - resources?: SitesFunctionsKeysChildResource5[]␊ - type: "Microsoft.Web/sites/functions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/functions/keys␊ - */␊ - export interface SitesFunctionsKeysChildResource5 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * The name of the key.␊ - */␊ - name: string␊ - type: "keys"␊ - /**␊ - * Key value␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/functions/keys␊ - */␊ - export interface SitesFunctionsKeys5 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * The name of the key.␊ - */␊ - name: string␊ - type: "Microsoft.Web/sites/functions/keys"␊ - /**␊ - * Key value␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/hostNameBindings␊ - */␊ - export interface SitesHostNameBindings8 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Hostname in the hostname binding.␊ - */␊ - name: string␊ - /**␊ - * HostNameBinding resource specific properties␊ - */␊ - properties: (HostNameBindingProperties8 | string)␊ - type: "Microsoft.Web/sites/hostNameBindings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/hybridconnection␊ - */␊ - export interface SitesHybridconnection8 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the hybrid connection configuration.␊ - */␊ - name: string␊ - /**␊ - * RelayServiceConnectionEntity resource specific properties␊ - */␊ - properties: (RelayServiceConnectionEntityProperties8 | string)␊ - type: "Microsoft.Web/sites/hybridconnection"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/hybridConnectionNamespaces/relays␊ - */␊ - export interface SitesHybridConnectionNamespacesRelays7 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * The relay name for this hybrid connection.␊ - */␊ - name: string␊ - /**␊ - * HybridConnection resource specific properties␊ - */␊ - properties: (HybridConnectionProperties9 | string)␊ - type: "Microsoft.Web/sites/hybridConnectionNamespaces/relays"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * HybridConnection resource specific properties␊ - */␊ - export interface HybridConnectionProperties9 {␊ - /**␊ - * The hostname of the endpoint.␊ - */␊ - hostname?: string␊ - /**␊ - * The port of the endpoint.␊ - */␊ - port?: (number | string)␊ - /**␊ - * The ARM URI to the Service Bus relay.␊ - */␊ - relayArmUri?: string␊ - /**␊ - * The name of the Service Bus relay.␊ - */␊ - relayName?: string␊ - /**␊ - * The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus.␊ - */␊ - sendKeyName?: string␊ - /**␊ - * 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.␊ - */␊ - sendKeyValue?: string␊ - /**␊ - * The name of the Service Bus namespace.␊ - */␊ - serviceBusNamespace?: string␊ - /**␊ - * The suffix for the service bus endpoint. By default this is .servicebus.windows.net␊ - */␊ - serviceBusSuffix?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/instances/extensions␊ - */␊ - export interface SitesInstancesExtensions7 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - properties: (MSDeployCore7 | string)␊ - type: "Microsoft.Web/sites/instances/extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/migrate␊ - */␊ - export interface SitesMigrate7 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * StorageMigrationOptions resource specific properties␊ - */␊ - properties: (StorageMigrationOptionsProperties7 | string)␊ - type: "Microsoft.Web/sites/migrate"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/networkConfig␊ - */␊ - export interface SitesNetworkConfig6 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SwiftVirtualNetwork resource specific properties␊ - */␊ - properties: (SwiftVirtualNetworkProperties6 | string)␊ - type: "Microsoft.Web/sites/networkConfig"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/premieraddons␊ - */␊ - export interface SitesPremieraddons8 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Add-on name.␊ - */␊ - name: string␊ - /**␊ - * PremierAddOn resource specific properties␊ - */␊ - properties: (PremierAddOnProperties7 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/sites/premieraddons"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/privateAccess␊ - */␊ - export interface SitesPrivateAccess6 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * PrivateAccess resource specific properties␊ - */␊ - properties: (PrivateAccessProperties6 | string)␊ - type: "Microsoft.Web/sites/privateAccess"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/privateEndpointConnections␊ - */␊ - export interface SitesPrivateEndpointConnections4 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the private endpoint connection.␊ - */␊ - name: string␊ - /**␊ - * A request to approve or reject a private endpoint connection␊ - */␊ - properties: (PrivateLinkConnectionApprovalRequest5 | string)␊ - type: "Microsoft.Web/sites/privateEndpointConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/publicCertificates␊ - */␊ - export interface SitesPublicCertificates7 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Public certificate name.␊ - */␊ - name: string␊ - /**␊ - * PublicCertificate resource specific properties␊ - */␊ - properties: (PublicCertificateProperties7 | string)␊ - type: "Microsoft.Web/sites/publicCertificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/siteextensions␊ - */␊ - export interface SitesSiteextensions7 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Site extension name.␊ - */␊ - name: string␊ - type: "Microsoft.Web/sites/siteextensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots␊ - */␊ - export interface SitesSlots8 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Managed service identity.␊ - */␊ - identity?: (ManagedServiceIdentity21 | string)␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the deployment slot to create or update. The name 'production' is reserved.␊ - */␊ - name: string␊ - /**␊ - * Site resource specific properties␊ - */␊ - properties: (SiteProperties8 | string)␊ - resources?: (SitesSlotsBasicPublishingCredentialsPoliciesChildResource | SitesSlotsConfigChildResource8 | SitesSlotsDeploymentsChildResource8 | SitesSlotsDomainOwnershipIdentifiersChildResource7 | SitesSlotsExtensionsChildResource7 | SitesSlotsFunctionsChildResource7 | SitesSlotsHostNameBindingsChildResource8 | SitesSlotsHybridconnectionChildResource8 | SitesSlotsPremieraddonsChildResource8 | SitesSlotsPrivateAccessChildResource6 | SitesSlotsPrivateEndpointConnectionsChildResource | SitesSlotsPublicCertificatesChildResource7 | SitesSlotsSiteextensionsChildResource7 | SitesSlotsSourcecontrolsChildResource8 | SitesSlotsVirtualNetworkConnectionsChildResource8)[]␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/sites/slots"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/deployments␊ - */␊ - export interface SitesSlotsDeploymentsChildResource8 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * ID of an existing deployment.␊ - */␊ - name: string␊ - /**␊ - * Deployment resource specific properties␊ - */␊ - properties: (DeploymentProperties10 | string)␊ - type: "deployments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/domainOwnershipIdentifiers␊ - */␊ - export interface SitesSlotsDomainOwnershipIdentifiersChildResource7 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of domain ownership identifier.␊ - */␊ - name: string␊ - /**␊ - * Identifier resource specific properties␊ - */␊ - properties: (IdentifierProperties7 | string)␊ - type: "domainOwnershipIdentifiers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/extensions␊ - */␊ - export interface SitesSlotsExtensionsChildResource7 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "MSDeploy"␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - properties: (MSDeployCore7 | string)␊ - type: "extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/functions␊ - */␊ - export interface SitesSlotsFunctionsChildResource7 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Function name.␊ - */␊ - name: string␊ - /**␊ - * FunctionEnvelope resource specific properties␊ - */␊ - properties: (FunctionEnvelopeProperties7 | string)␊ - type: "functions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/hostNameBindings␊ - */␊ - export interface SitesSlotsHostNameBindingsChildResource8 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Hostname in the hostname binding.␊ - */␊ - name: string␊ - /**␊ - * HostNameBinding resource specific properties␊ - */␊ - properties: (HostNameBindingProperties8 | string)␊ - type: "hostNameBindings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/hybridconnection␊ - */␊ - export interface SitesSlotsHybridconnectionChildResource8 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the hybrid connection configuration.␊ - */␊ - name: string␊ - /**␊ - * RelayServiceConnectionEntity resource specific properties␊ - */␊ - properties: (RelayServiceConnectionEntityProperties8 | string)␊ - type: "hybridconnection"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/premieraddons␊ - */␊ - export interface SitesSlotsPremieraddonsChildResource8 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Add-on name.␊ - */␊ - name: string␊ - /**␊ - * PremierAddOn resource specific properties␊ - */␊ - properties: (PremierAddOnProperties7 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "premieraddons"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/privateAccess␊ - */␊ - export interface SitesSlotsPrivateAccessChildResource6 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "virtualNetworks"␊ - /**␊ - * PrivateAccess resource specific properties␊ - */␊ - properties: (PrivateAccessProperties6 | string)␊ - type: "privateAccess"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/privateEndpointConnections␊ - */␊ - export interface SitesSlotsPrivateEndpointConnectionsChildResource {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the private endpoint connection.␊ - */␊ - name: string␊ - /**␊ - * A request to approve or reject a private endpoint connection␊ - */␊ - properties: (PrivateLinkConnectionApprovalRequest5 | string)␊ - type: "privateEndpointConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/publicCertificates␊ - */␊ - export interface SitesSlotsPublicCertificatesChildResource7 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Public certificate name.␊ - */␊ - name: string␊ - /**␊ - * PublicCertificate resource specific properties␊ - */␊ - properties: (PublicCertificateProperties7 | string)␊ - type: "publicCertificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/siteextensions␊ - */␊ - export interface SitesSlotsSiteextensionsChildResource7 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Site extension name.␊ - */␊ - name: string␊ - type: "siteextensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/sourcecontrols␊ - */␊ - export interface SitesSlotsSourcecontrolsChildResource8 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: "web"␊ - /**␊ - * SiteSourceControl resource specific properties␊ - */␊ - properties: (SiteSourceControlProperties8 | string)␊ - type: "sourcecontrols"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/virtualNetworkConnections␊ - */␊ - export interface SitesSlotsVirtualNetworkConnectionsChildResource8 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of an existing Virtual Network.␊ - */␊ - name: string␊ - /**␊ - * VnetInfo resource specific properties␊ - */␊ - properties: (VnetInfoProperties8 | string)␊ - type: "virtualNetworkConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/deployments␊ - */␊ - export interface SitesSlotsDeployments8 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * ID of an existing deployment.␊ - */␊ - name: string␊ - /**␊ - * Deployment resource specific properties␊ - */␊ - properties: (DeploymentProperties10 | string)␊ - type: "Microsoft.Web/sites/slots/deployments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/domainOwnershipIdentifiers␊ - */␊ - export interface SitesSlotsDomainOwnershipIdentifiers7 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of domain ownership identifier.␊ - */␊ - name: string␊ - /**␊ - * Identifier resource specific properties␊ - */␊ - properties: (IdentifierProperties7 | string)␊ - type: "Microsoft.Web/sites/slots/domainOwnershipIdentifiers"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/extensions␊ - */␊ - export interface SitesSlotsExtensions7 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - properties: (MSDeployCore7 | string)␊ - type: "Microsoft.Web/sites/slots/extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/functions␊ - */␊ - export interface SitesSlotsFunctions7 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Function name.␊ - */␊ - name: string␊ - /**␊ - * FunctionEnvelope resource specific properties␊ - */␊ - properties: (FunctionEnvelopeProperties7 | string)␊ - resources?: SitesSlotsFunctionsKeysChildResource5[]␊ - type: "Microsoft.Web/sites/slots/functions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/functions/keys␊ - */␊ - export interface SitesSlotsFunctionsKeysChildResource5 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * The name of the key.␊ - */␊ - name: string␊ - type: "keys"␊ - /**␊ - * Key value␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/functions/keys␊ - */␊ - export interface SitesSlotsFunctionsKeys5 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * The name of the key.␊ - */␊ - name: string␊ - type: "Microsoft.Web/sites/slots/functions/keys"␊ - /**␊ - * Key value␊ - */␊ - value?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/hostNameBindings␊ - */␊ - export interface SitesSlotsHostNameBindings8 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Hostname in the hostname binding.␊ - */␊ - name: string␊ - /**␊ - * HostNameBinding resource specific properties␊ - */␊ - properties: (HostNameBindingProperties8 | string)␊ - type: "Microsoft.Web/sites/slots/hostNameBindings"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/hybridconnection␊ - */␊ - export interface SitesSlotsHybridconnection8 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the hybrid connection configuration.␊ - */␊ - name: string␊ - /**␊ - * RelayServiceConnectionEntity resource specific properties␊ - */␊ - properties: (RelayServiceConnectionEntityProperties8 | string)␊ - type: "Microsoft.Web/sites/slots/hybridconnection"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays␊ - */␊ - export interface SitesSlotsHybridConnectionNamespacesRelays7 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * The relay name for this hybrid connection.␊ - */␊ - name: string␊ - /**␊ - * HybridConnection resource specific properties␊ - */␊ - properties: (HybridConnectionProperties9 | string)␊ - type: "Microsoft.Web/sites/slots/hybridConnectionNamespaces/relays"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/instances/extensions␊ - */␊ - export interface SitesSlotsInstancesExtensions7 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * MSDeploy ARM PUT core information␊ - */␊ - properties: (MSDeployCore7 | string)␊ - type: "Microsoft.Web/sites/slots/instances/extensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/premieraddons␊ - */␊ - export interface SitesSlotsPremieraddons8 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Add-on name.␊ - */␊ - name: string␊ - /**␊ - * PremierAddOn resource specific properties␊ - */␊ - properties: (PremierAddOnProperties7 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/sites/slots/premieraddons"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/privateAccess␊ - */␊ - export interface SitesSlotsPrivateAccess6 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * PrivateAccess resource specific properties␊ - */␊ - properties: (PrivateAccessProperties6 | string)␊ - type: "Microsoft.Web/sites/slots/privateAccess"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/privateEndpointConnections␊ - */␊ - export interface SitesSlotsPrivateEndpointConnections {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the private endpoint connection.␊ - */␊ - name: string␊ - /**␊ - * A request to approve or reject a private endpoint connection␊ - */␊ - properties: (PrivateLinkConnectionApprovalRequest5 | string)␊ - type: "Microsoft.Web/sites/slots/privateEndpointConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/publicCertificates␊ - */␊ - export interface SitesSlotsPublicCertificates7 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Public certificate name.␊ - */␊ - name: string␊ - /**␊ - * PublicCertificate resource specific properties␊ - */␊ - properties: (PublicCertificateProperties7 | string)␊ - type: "Microsoft.Web/sites/slots/publicCertificates"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/siteextensions␊ - */␊ - export interface SitesSlotsSiteextensions7 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Site extension name.␊ - */␊ - name: string␊ - type: "Microsoft.Web/sites/slots/siteextensions"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/sourcecontrols␊ - */␊ - export interface SitesSlotsSourcecontrols8 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteSourceControl resource specific properties␊ - */␊ - properties: (SiteSourceControlProperties8 | string)␊ - type: "Microsoft.Web/sites/slots/sourcecontrols"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/virtualNetworkConnections␊ - */␊ - export interface SitesSlotsVirtualNetworkConnections8 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of an existing Virtual Network.␊ - */␊ - name: string␊ - /**␊ - * VnetInfo resource specific properties␊ - */␊ - properties: (VnetInfoProperties8 | string)␊ - resources?: SitesSlotsVirtualNetworkConnectionsGatewaysChildResource8[]␊ - type: "Microsoft.Web/sites/slots/virtualNetworkConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/virtualNetworkConnections/gateways␊ - */␊ - export interface SitesSlotsVirtualNetworkConnectionsGatewaysChildResource8 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the gateway. Currently, the only supported string is "primary".␊ - */␊ - name: string␊ - /**␊ - * VnetGateway resource specific properties␊ - */␊ - properties: (VnetGatewayProperties9 | string)␊ - type: "gateways"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/slots/virtualNetworkConnections/gateways␊ - */␊ - export interface SitesSlotsVirtualNetworkConnectionsGateways8 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the gateway. Currently, the only supported string is "primary".␊ - */␊ - name: string␊ - /**␊ - * VnetGateway resource specific properties␊ - */␊ - properties: (VnetGatewayProperties9 | string)␊ - type: "Microsoft.Web/sites/slots/virtualNetworkConnections/gateways"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/sourcecontrols␊ - */␊ - export interface SitesSourcecontrols8 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - name: string␊ - /**␊ - * SiteSourceControl resource specific properties␊ - */␊ - properties: (SiteSourceControlProperties8 | string)␊ - type: "Microsoft.Web/sites/sourcecontrols"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/virtualNetworkConnections␊ - */␊ - export interface SitesVirtualNetworkConnections8 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of an existing Virtual Network.␊ - */␊ - name: string␊ - /**␊ - * VnetInfo resource specific properties␊ - */␊ - properties: (VnetInfoProperties8 | string)␊ - resources?: SitesVirtualNetworkConnectionsGatewaysChildResource8[]␊ - type: "Microsoft.Web/sites/virtualNetworkConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/virtualNetworkConnections/gateways␊ - */␊ - export interface SitesVirtualNetworkConnectionsGatewaysChildResource8 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the gateway. Currently, the only supported string is "primary".␊ - */␊ - name: string␊ - /**␊ - * VnetGateway resource specific properties␊ - */␊ - properties: (VnetGatewayProperties9 | string)␊ - type: "gateways"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/sites/virtualNetworkConnections/gateways␊ - */␊ - export interface SitesVirtualNetworkConnectionsGateways8 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the gateway. Currently, the only supported string is "primary".␊ - */␊ - name: string␊ - /**␊ - * VnetGateway resource specific properties␊ - */␊ - properties: (VnetGatewayProperties9 | string)␊ - type: "Microsoft.Web/sites/virtualNetworkConnections/gateways"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/staticSites␊ - */␊ - export interface StaticSites4 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Managed service identity.␊ - */␊ - identity?: (ManagedServiceIdentity21 | string)␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Resource Location.␊ - */␊ - location: string␊ - /**␊ - * Name of the static site to create or update.␊ - */␊ - name: string␊ - /**␊ - * A static site.␊ - */␊ - properties: (StaticSite4 | string)␊ - resources?: (StaticSitesConfigChildResource4 | StaticSitesCustomDomainsChildResource4 | StaticSitesPrivateEndpointConnectionsChildResource | StaticSitesUserProvidedFunctionAppsChildResource)[]␊ - /**␊ - * Description of a SKU for a scalable resource.␊ - */␊ - sku?: (SkuDescription9 | string)␊ - /**␊ - * Resource tags.␊ - */␊ - tags?: ({␊ - [k: string]: string␊ - } | string)␊ - type: "Microsoft.Web/staticSites"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A static site.␊ - */␊ - export interface StaticSite4 {␊ - /**␊ - * false if config file is locked for this static web app; otherwise, true.␊ - */␊ - allowConfigFileUpdates?: (boolean | string)␊ - /**␊ - * The target branch in the repository.␊ - */␊ - branch?: string␊ - /**␊ - * Build properties for the static site.␊ - */␊ - buildProperties?: (StaticSiteBuildProperties4 | string)␊ - /**␊ - * A user's github repository token. This is used to setup the Github Actions workflow file and API secrets.␊ - */␊ - repositoryToken?: string␊ - /**␊ - * URL for the repository of the static site.␊ - */␊ - repositoryUrl?: string␊ - /**␊ - * State indicating whether staging environments are allowed or not allowed for a static web app.␊ - */␊ - stagingEnvironmentPolicy?: (("Enabled" | "Disabled") | string)␊ - /**␊ - * Template Options for the static site.␊ - */␊ - templateProperties?: (StaticSiteTemplateOptions | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Build properties for the static site.␊ - */␊ - export interface StaticSiteBuildProperties4 {␊ - /**␊ - * A custom command to run during deployment of the Azure Functions API application.␊ - */␊ - apiBuildCommand?: string␊ - /**␊ - * The path to the api code within the repository.␊ - */␊ - apiLocation?: string␊ - /**␊ - * Deprecated: The path of the app artifacts after building (deprecated in favor of OutputLocation)␊ - */␊ - appArtifactLocation?: string␊ - /**␊ - * A custom command to run during deployment of the static content application.␊ - */␊ - appBuildCommand?: string␊ - /**␊ - * The path to the app code within the repository.␊ - */␊ - appLocation?: string␊ - /**␊ - * Github Action secret name override.␊ - */␊ - githubActionSecretNameOverride?: string␊ - /**␊ - * The output path of the app after building.␊ - */␊ - outputLocation?: string␊ - /**␊ - * Skip Github Action workflow generation.␊ - */␊ - skipGithubActionWorkflowGeneration?: (boolean | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Template Options for the static site.␊ - */␊ - export interface StaticSiteTemplateOptions {␊ - /**␊ - * Description of the newly generated repository.␊ - */␊ - description?: string␊ - /**␊ - * Whether or not the newly generated repository is a private repository. Defaults to false (i.e. public).␊ - */␊ - isPrivate?: (boolean | string)␊ - /**␊ - * Owner of the newly generated repository.␊ - */␊ - owner?: string␊ - /**␊ - * Name of the newly generated repository.␊ - */␊ - repositoryName?: string␊ - /**␊ - * URL of the template repository. The newly generated repository will be based on this one.␊ - */␊ - templateRepositoryUrl?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/staticSites/customDomains␊ - */␊ - export interface StaticSitesCustomDomainsChildResource4 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * The custom domain to create.␊ - */␊ - name: string␊ - /**␊ - * StaticSiteCustomDomainRequestPropertiesARMResource resource specific properties␊ - */␊ - properties: (StaticSiteCustomDomainRequestPropertiesARMResourceProperties | string)␊ - type: "customDomains"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * StaticSiteCustomDomainRequestPropertiesARMResource resource specific properties␊ - */␊ - export interface StaticSiteCustomDomainRequestPropertiesARMResourceProperties {␊ - /**␊ - * Validation method for adding a custom domain␊ - */␊ - validationMethod?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/staticSites/privateEndpointConnections␊ - */␊ - export interface StaticSitesPrivateEndpointConnectionsChildResource {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the private endpoint connection.␊ - */␊ - name: string␊ - /**␊ - * A request to approve or reject a private endpoint connection␊ - */␊ - properties: (PrivateLinkConnectionApprovalRequest5 | string)␊ - type: "privateEndpointConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/staticSites/userProvidedFunctionApps␊ - */␊ - export interface StaticSitesUserProvidedFunctionAppsChildResource {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the function app to register with the static site.␊ - */␊ - name: string␊ - /**␊ - * StaticSiteUserProvidedFunctionAppARMResource resource specific properties␊ - */␊ - properties: (StaticSiteUserProvidedFunctionAppARMResourceProperties | string)␊ - type: "userProvidedFunctionApps"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * StaticSiteUserProvidedFunctionAppARMResource resource specific properties␊ - */␊ - export interface StaticSiteUserProvidedFunctionAppARMResourceProperties {␊ - /**␊ - * The region of the function app registered with the static site␊ - */␊ - functionAppRegion?: string␊ - /**␊ - * The resource id of the function app registered with the static site␊ - */␊ - functionAppResourceId?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/staticSites/builds/userProvidedFunctionApps␊ - */␊ - export interface StaticSitesBuildsUserProvidedFunctionApps {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the function app to register with the static site build.␊ - */␊ - name: string␊ - /**␊ - * StaticSiteUserProvidedFunctionAppARMResource resource specific properties␊ - */␊ - properties: (StaticSiteUserProvidedFunctionAppARMResourceProperties | string)␊ - type: "Microsoft.Web/staticSites/builds/userProvidedFunctionApps"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/staticSites/customDomains␊ - */␊ - export interface StaticSitesCustomDomains4 {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * The custom domain to create.␊ - */␊ - name: string␊ - /**␊ - * StaticSiteCustomDomainRequestPropertiesARMResource resource specific properties␊ - */␊ - properties: (StaticSiteCustomDomainRequestPropertiesARMResourceProperties | string)␊ - type: "Microsoft.Web/staticSites/customDomains"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/staticSites/privateEndpointConnections␊ - */␊ - export interface StaticSitesPrivateEndpointConnections {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the private endpoint connection.␊ - */␊ - name: string␊ - /**␊ - * A request to approve or reject a private endpoint connection␊ - */␊ - properties: (PrivateLinkConnectionApprovalRequest5 | string)␊ - type: "Microsoft.Web/staticSites/privateEndpointConnections"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Web/staticSites/userProvidedFunctionApps␊ - */␊ - export interface StaticSitesUserProvidedFunctionApps {␊ - apiVersion: "2020-12-01"␊ - /**␊ - * Kind of resource.␊ - */␊ - kind?: string␊ - /**␊ - * Name of the function app to register with the static site.␊ - */␊ - name: string␊ - /**␊ - * StaticSiteUserProvidedFunctionAppARMResource resource specific properties␊ - */␊ - properties: (StaticSiteUserProvidedFunctionAppARMResourceProperties | string)␊ - type: "Microsoft.Web/staticSites/userProvidedFunctionApps"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SendGrid resources that user purchases␊ - */␊ - export interface Accounts11 {␊ - /**␊ - * Name of the resource␊ - */␊ - name: string␊ - type: "Sendgrid.Email/accounts"␊ - apiVersion: "2015-01-01"␊ - /**␊ - * SendGrid plan␊ - */␊ - plan: {␊ - /**␊ - * Plan name␊ - */␊ - name: (string | ("free" | "bronze" | "silver" | "gold" | "platinum" | "premier"))␊ - /**␊ - * Publisher name␊ - */␊ - publisher: (string | "Sendgrid")␊ - /**␊ - * Plan id␊ - */␊ - product: (string | "sendgrid_azure")␊ - /**␊ - * Promotion code␊ - */␊ - promotionCode?: string␊ - [k: string]: unknown␊ - }␊ - properties: {␊ - /**␊ - * The SendGrid account password␊ - */␊ - password: string␊ - /**␊ - * True if you want to accept Marketing Emails␊ - */␊ - acceptMarketingEmails: (boolean | string)␊ - /**␊ - * The user's email address␊ - */␊ - email: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Resources/deployments␊ - */␊ - export interface Deployments2 {␊ - type: "Microsoft.Resources/deployments"␊ - apiVersion: "2015-01-01"␊ - /**␊ - * Name of the deployment␊ - */␊ - name: string␊ - /**␊ - * Collection of resources this deployment depends on␊ - */␊ - dependsOn?: string[]␊ - properties: {␊ - /**␊ - * Template expression evaluation options'␊ - */␊ - expressionEvaluationOptions?: (TemplateExpressionEvaluationOptions | string)␊ - /**␊ - * Deployment mode␊ - */␊ - mode: (("Incremental" | "Complete") | string)␊ - /**␊ - * Deployment template link␊ - */␊ - templateLink?: (TemplateLink2 | string)␊ - /**␊ - * Deployment template␊ - */␊ - template?: ({␊ - [k: string]: unknown␊ - } | string)␊ - /**␊ - * Deployment parameters link␊ - */␊ - parametersLink?: (ParametersLink2 | string)␊ - /**␊ - * Deployment parameters␊ - */␊ - parameters?: ({␊ - [k: string]: unknown␊ - } | string)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Template expression evaluation options␊ - */␊ - export interface TemplateExpressionEvaluationOptions {␊ - /**␊ - * Template expression evaluation scope␊ - */␊ - scope: ("inner" | "outer")␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Template file reference in a deployment␊ - */␊ - export interface TemplateLink2 {␊ - /**␊ - * URI referencing the deployment template␊ - */␊ - uri: string␊ - /**␊ - * If included it must match the contentVersion in the template␊ - */␊ - contentVersion?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Parameter file reference in a deployment␊ - */␊ - export interface ParametersLink2 {␊ - /**␊ - * URI referencing the deployment template parameters␊ - */␊ - uri: string␊ - /**␊ - * If included it must match the contentVersion in the parameters file␊ - */␊ - contentVersion?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Resources/deployments␊ - */␊ - export interface Deployments3 {␊ - apiVersion: "2016-02-01"␊ - /**␊ - * The name of the deployment.␊ - */␊ - name: string␊ - /**␊ - * Deployment properties.␊ - */␊ - properties: (DeploymentProperties11 | string)␊ - type: "Microsoft.Resources/deployments"␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Deployment properties.␊ - */␊ - export interface DeploymentProperties11 {␊ - debugSetting?: (DebugSetting2 | string)␊ - /**␊ - * The deployment mode.␊ - */␊ - mode: (("Incremental" | "Complete") | string)␊ - /**␊ - * Deployment parameters. It can be a JObject or a well formed JSON string. Use only one of Parameters or ParametersLink.␊ - */␊ - parameters?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Entity representing the reference to the deployment parameters.␊ - */␊ - parametersLink?: (ParametersLink3 | string)␊ - /**␊ - * The template content. It can be a JObject or a well formed JSON string. Use only one of Template or TemplateLink.␊ - */␊ - template?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Entity representing the reference to the template.␊ - */␊ - templateLink?: (TemplateLink3 | string)␊ - [k: string]: unknown␊ - }␊ - export interface DebugSetting2 {␊ - /**␊ - * The debug detail level.␊ - */␊ - detailLevel?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Entity representing the reference to the deployment parameters.␊ - */␊ - export interface ParametersLink3 {␊ - /**␊ - * If included it must match the ContentVersion in the template.␊ - */␊ - contentVersion?: string␊ - /**␊ - * URI referencing the template.␊ - */␊ - uri: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Entity representing the reference to the template.␊ - */␊ - export interface TemplateLink3 {␊ - /**␊ - * If included it must match the ContentVersion in the template.␊ - */␊ - contentVersion?: string␊ - /**␊ - * URI referencing the template.␊ - */␊ - uri: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Resources/deployments␊ - */␊ - export interface Deployments4 {␊ - apiVersion: "2018-05-01"␊ - /**␊ - * The location to store the deployment data.␊ - */␊ - location?: string␊ - /**␊ - * The name of the deployment.␊ - */␊ - name: string␊ - /**␊ - * Deployment properties.␊ - */␊ - properties: (DeploymentProperties12 | string)␊ - type: "Microsoft.Resources/deployments"␊ - /**␊ - * The subscription to deploy to␊ - */␊ - subscriptionId?: string␊ - /**␊ - * The resource group to deploy to␊ - */␊ - resourceGroup?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Deployment properties.␊ - */␊ - export interface DeploymentProperties12 {␊ - debugSetting?: (DebugSetting3 | string)␊ - /**␊ - * The mode that is used to deploy resources. This value can be either Incremental or Complete. In Incremental mode, resources are deployed without deleting existing resources that are not included in the template. In Complete mode, resources are deployed and existing resources in the resource group that are not included in the template are deleted. Be careful when using Complete mode as you may unintentionally delete resources.␊ - */␊ - mode: (("Incremental" | "Complete") | string)␊ - /**␊ - * Deployment on error behavior.␊ - */␊ - onErrorDeployment?: (OnErrorDeployment | string)␊ - /**␊ - * Name and value pairs that define the deployment parameters for the template. You use this element when you want to provide the parameter values directly in the request rather than link to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. It can be a JObject or a well formed JSON string.␊ - */␊ - parameters?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Entity representing the reference to the deployment parameters.␊ - */␊ - parametersLink?: (ParametersLink4 | string)␊ - /**␊ - * The template content. You use this element when you want to pass the template syntax directly in the request rather than link to an existing template. It can be a JObject or well-formed JSON string. Use either the templateLink property or the template property, but not both.␊ - */␊ - template?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Entity representing the reference to the template.␊ - */␊ - templateLink?: (TemplateLink4 | string)␊ - [k: string]: unknown␊ - }␊ - export interface DebugSetting3 {␊ - /**␊ - * Specifies the type of information to log for debugging. The permitted values are none, requestContent, responseContent, or both requestContent and responseContent separated by a comma. The default is none. When setting this value, carefully consider the type of information you are passing in during deployment. By logging information about the request or response, you could potentially expose sensitive data that is retrieved through the deployment operations.␊ - */␊ - detailLevel?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Deployment on error behavior.␊ - */␊ - export interface OnErrorDeployment {␊ - /**␊ - * The deployment to be used on error case.␊ - */␊ - deploymentName?: string␊ - /**␊ - * The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment.␊ - */␊ - type?: (("LastSuccessful" | "SpecificDeployment") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Entity representing the reference to the deployment parameters.␊ - */␊ - export interface ParametersLink4 {␊ - /**␊ - * If included, must match the ContentVersion in the template.␊ - */␊ - contentVersion?: string␊ - /**␊ - * The URI of the parameters file.␊ - */␊ - uri: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Entity representing the reference to the template.␊ - */␊ - export interface TemplateLink4 {␊ - /**␊ - * If included, must match the ContentVersion in the template.␊ - */␊ - contentVersion?: string␊ - /**␊ - * The URI of the template to deploy.␊ - */␊ - uri: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Resources/deployments␊ - */␊ - export interface Deployments5 {␊ - apiVersion: "2019-05-01"␊ - /**␊ - * The location to store the deployment data.␊ - */␊ - location?: string␊ - /**␊ - * The name of the deployment.␊ - */␊ - name: string␊ - /**␊ - * Deployment properties.␊ - */␊ - properties: (DeploymentProperties13 | string)␊ - type: "Microsoft.Resources/deployments"␊ - /**␊ - * The subscription to deploy to␊ - */␊ - subscriptionId?: string␊ - /**␊ - * The resource group to deploy to␊ - */␊ - resourceGroup?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Deployment properties.␊ - */␊ - export interface DeploymentProperties13 {␊ - /**␊ - * The debug setting.␊ - */␊ - debugSetting?: (DebugSetting4 | string)␊ - /**␊ - * The mode that is used to deploy resources. This value can be either Incremental or Complete. In Incremental mode, resources are deployed without deleting existing resources that are not included in the template. In Complete mode, resources are deployed and existing resources in the resource group that are not included in the template are deleted. Be careful when using Complete mode as you may unintentionally delete resources.␊ - */␊ - mode: (("Incremental" | "Complete") | string)␊ - /**␊ - * Deployment on error behavior.␊ - */␊ - onErrorDeployment?: (OnErrorDeployment1 | string)␊ - /**␊ - * Name and value pairs that define the deployment parameters for the template. You use this element when you want to provide the parameter values directly in the request rather than link to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. It can be a JObject or a well formed JSON string.␊ - */␊ - parameters?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Entity representing the reference to the deployment parameters.␊ - */␊ - parametersLink?: (ParametersLink5 | string)␊ - /**␊ - * The template content. You use this element when you want to pass the template syntax directly in the request rather than link to an existing template. It can be a JObject or well-formed JSON string. Use either the templateLink property or the template property, but not both.␊ - */␊ - template?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Entity representing the reference to the template.␊ - */␊ - templateLink?: (TemplateLink5 | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The debug setting.␊ - */␊ - export interface DebugSetting4 {␊ - /**␊ - * Specifies the type of information to log for debugging. The permitted values are none, requestContent, responseContent, or both requestContent and responseContent separated by a comma. The default is none. When setting this value, carefully consider the type of information you are passing in during deployment. By logging information about the request or response, you could potentially expose sensitive data that is retrieved through the deployment operations.␊ - */␊ - detailLevel?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Deployment on error behavior.␊ - */␊ - export interface OnErrorDeployment1 {␊ - /**␊ - * The deployment to be used on error case.␊ - */␊ - deploymentName?: string␊ - /**␊ - * The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment.␊ - */␊ - type?: (("LastSuccessful" | "SpecificDeployment") | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Entity representing the reference to the deployment parameters.␊ - */␊ - export interface ParametersLink5 {␊ - /**␊ - * If included, must match the ContentVersion in the template.␊ - */␊ - contentVersion?: string␊ - /**␊ - * The URI of the parameters file.␊ - */␊ - uri: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Entity representing the reference to the template.␊ - */␊ - export interface TemplateLink5 {␊ - /**␊ - * If included, must match the ContentVersion in the template.␊ - */␊ - contentVersion?: string␊ - /**␊ - * The URI of the template to deploy.␊ - */␊ - uri: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Microsoft.Resources/links␊ - */␊ - export interface Links {␊ - type: "Microsoft.Resources/links"␊ - apiVersion: "2015-01-01"␊ - /**␊ - * Name of the link␊ - */␊ - name: string␊ - /**␊ - * Collection of resources this link depends on␊ - */␊ - dependsOn?: string[]␊ - properties: {␊ - /**␊ - * Target resource id to link to␊ - */␊ - targetId: string␊ - /**␊ - * Notes for this link␊ - */␊ - notes?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Resources with symbolic names␊ - */␊ - export interface ResourcesWithSymbolicNames {␊ - [k: string]: Resource␊ - }␊ - /**␊ - * Set of output parameters␊ - */␊ - export interface Output1 {␊ - /**␊ - * Condition of the output␊ - */␊ - condition?: (boolean | string)␊ - /**␊ - * Type of output value␊ - */␊ - type: ("string" | "securestring" | "int" | "bool" | "object" | "secureObject" | "array")␊ - value?: ParameterValueTypes2␊ - copy?: OutputCopy␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Output copy␊ - */␊ - export interface OutputCopy {␊ - /**␊ - * Count of the copy␊ - */␊ - count: (string | number)␊ - /**␊ - * Input of the copy␊ - */␊ - input: ((string | boolean | number | unknown[] | {␊ - [k: string]: unknown␊ - } | null) | string)␊ - [k: string]: unknown␊ - }␊ - ` - -## realWorld.fhir.js - -> Expected output to match snapshot for e2e test: realWorld.fhir.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - /**␊ - * see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas␊ - */␊ - export type HttpHl7OrgFhirJsonSchema40 = (Account | ActivityDefinition | AdverseEvent | AllergyIntolerance | Appointment | AppointmentResponse | AuditEvent | Basic | Binary | BiologicallyDerivedProduct | BodyStructure | Bundle | CapabilityStatement | CarePlan | CareTeam | CatalogEntry | ChargeItem | ChargeItemDefinition | Claim | ClaimResponse | ClinicalImpression | CodeSystem | Communication | CommunicationRequest | CompartmentDefinition | Composition | ConceptMap | Condition | Consent | Contract | Coverage | CoverageEligibilityRequest | CoverageEligibilityResponse | DetectedIssue | Device | DeviceDefinition | DeviceMetric | DeviceRequest | DeviceUseStatement | DiagnosticReport | DocumentManifest | DocumentReference | EffectEvidenceSynthesis | Encounter | Endpoint | EnrollmentRequest | EnrollmentResponse | EpisodeOfCare | EventDefinition | Evidence | EvidenceVariable | ExampleScenario | ExplanationOfBenefit | FamilyMemberHistory | Flag | Goal | GraphDefinition | Group | GuidanceResponse | HealthcareService | ImagingStudy | Immunization | ImmunizationEvaluation | ImmunizationRecommendation | ImplementationGuide | InsurancePlan | Invoice | Library | Linkage | List | Location | Measure | MeasureReport | Media | Medication | MedicationAdministration | MedicationDispense | MedicationKnowledge | MedicationRequest | MedicationStatement | MedicinalProduct | MedicinalProductAuthorization | MedicinalProductContraindication | MedicinalProductIndication | MedicinalProductIngredient | MedicinalProductInteraction | MedicinalProductManufactured | MedicinalProductPackaged | MedicinalProductPharmaceutical | MedicinalProductUndesirableEffect | MessageDefinition | MessageHeader | MolecularSequence | NamingSystem | NutritionOrder | Observation | ObservationDefinition | OperationDefinition | OperationOutcome | Organization | OrganizationAffiliation | Parameters | Patient | PaymentNotice | PaymentReconciliation | Person | PlanDefinition | Practitioner | PractitionerRole | Procedure | Provenance | Questionnaire | QuestionnaireResponse | RelatedPerson | RequestGroup | ResearchDefinition | ResearchElementDefinition | ResearchStudy | ResearchSubject | RiskAssessment | RiskEvidenceSynthesis | Schedule | SearchParameter | ServiceRequest | Slot | Specimen | SpecimenDefinition | StructureDefinition | StructureMap | Subscription | Substance | SubstanceNucleicAcid | SubstancePolymer | SubstanceProtein | SubstanceReferenceInformation | SubstanceSourceMaterial | SubstanceSpecification | SupplyDelivery | SupplyRequest | Task | TerminologyCapabilities | TestReport | TestScript | ValueSet | VerificationResult | VisionPrescription)␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - export type String = string␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - export type DateTime = string␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - export type Code = string␊ - /**␊ - * A time during the day, with no date specified␊ - */␊ - export type Time = string␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - export type Canonical = string␊ - export type ResourceList = (Account | ActivityDefinition | AdverseEvent | AllergyIntolerance | Appointment | AppointmentResponse | AuditEvent | Basic | Binary | BiologicallyDerivedProduct | BodyStructure | Bundle | CapabilityStatement | CarePlan | CareTeam | CatalogEntry | ChargeItem | ChargeItemDefinition | Claim | ClaimResponse | ClinicalImpression | CodeSystem | Communication | CommunicationRequest | CompartmentDefinition | Composition | ConceptMap | Condition | Consent | Contract | Coverage | CoverageEligibilityRequest | CoverageEligibilityResponse | DetectedIssue | Device | DeviceDefinition | DeviceMetric | DeviceRequest | DeviceUseStatement | DiagnosticReport | DocumentManifest | DocumentReference | EffectEvidenceSynthesis | Encounter | Endpoint | EnrollmentRequest | EnrollmentResponse | EpisodeOfCare | EventDefinition | Evidence | EvidenceVariable | ExampleScenario | ExplanationOfBenefit | FamilyMemberHistory | Flag | Goal | GraphDefinition | Group | GuidanceResponse | HealthcareService | ImagingStudy | Immunization | ImmunizationEvaluation | ImmunizationRecommendation | ImplementationGuide | InsurancePlan | Invoice | Library | Linkage | List | Location | Measure | MeasureReport | Media | Medication | MedicationAdministration | MedicationDispense | MedicationKnowledge | MedicationRequest | MedicationStatement | MedicinalProduct | MedicinalProductAuthorization | MedicinalProductContraindication | MedicinalProductIndication | MedicinalProductIngredient | MedicinalProductInteraction | MedicinalProductManufactured | MedicinalProductPackaged | MedicinalProductPharmaceutical | MedicinalProductUndesirableEffect | MessageDefinition | MessageHeader | MolecularSequence | NamingSystem | NutritionOrder | Observation | ObservationDefinition | OperationDefinition | OperationOutcome | Organization | OrganizationAffiliation | Parameters | Patient | PaymentNotice | PaymentReconciliation | Person | PlanDefinition | Practitioner | PractitionerRole | Procedure | Provenance | Questionnaire | QuestionnaireResponse | RelatedPerson | RequestGroup | ResearchDefinition | ResearchElementDefinition | ResearchStudy | ResearchSubject | RiskAssessment | RiskEvidenceSynthesis | Schedule | SearchParameter | ServiceRequest | Slot | Specimen | SpecimenDefinition | StructureDefinition | StructureMap | Subscription | Substance | SubstanceNucleicAcid | SubstancePolymer | SubstanceProtein | SubstanceReferenceInformation | SubstanceSourceMaterial | SubstanceSpecification | SupplyDelivery | SupplyRequest | Task | TerminologyCapabilities | TestReport | TestScript | ValueSet | VerificationResult | VisionPrescription)␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - export type Uri = string␊ - /**␊ - * An integer with a value that is positive (e.g. >0)␊ - */␊ - export type PositiveInt = number␊ - /**␊ - * An integer with a value that is not negative (e.g. >= 0)␊ - */␊ - export type UnsignedInt = number␊ - /**␊ - * A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine␊ - */␊ - export type Markdown = string␊ - /**␊ - * A whole number␊ - */␊ - export type Integer = number␊ - /**␊ - * A rational number with implicit precision␊ - */␊ - export type Decimal = number␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - export type Id = string␊ - ␊ - /**␊ - * A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centers, etc.␊ - */␊ - export interface Account {␊ - /**␊ - * This is a Account resource␊ - */␊ - resourceType: "Account"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta␊ - /**␊ - * A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element148␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element149␊ - text?: Narrative␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Unique identifier used to reference the account. Might or might not be intended for human use (e.g. credit card number).␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * Indicates whether the account is presently used/usable or not.␊ - */␊ - status?: ("active" | "inactive" | "entered-in-error" | "on-hold" | "unknown")␊ - _status?: Element2321␊ - type?: CodeableConcept593␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element2322␊ - /**␊ - * Identifies the entity which incurs the expenses. While the immediate recipients of services or goods might be entities related to the subject, the expenses were ultimately incurred by the subject of the Account.␊ - */␊ - subject?: Reference11[]␊ - servicePeriod?: Period128␊ - /**␊ - * The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account.␊ - */␊ - coverage?: Account_Coverage[]␊ - owner?: Reference475␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element2324␊ - /**␊ - * The parties responsible for balancing the account if other payment options fall short.␊ - */␊ - guarantor?: Account_Guarantor[]␊ - partOf?: Reference477␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Optional Extension Element - found in all resources.␊ - */␊ - export interface Extension {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Source of the definition for the extension code - a logical name or a URL.␊ - */␊ - url?: string␊ - _url?: Element␊ - /**␊ - * Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).␊ - */␊ - valueBase64Binary?: string␊ - _valueBase64Binary?: Element1␊ - /**␊ - * Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).␊ - */␊ - valueBoolean?: boolean␊ - _valueBoolean?: Element2␊ - /**␊ - * Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).␊ - */␊ - valueCanonical?: string␊ - _valueCanonical?: Element3␊ - /**␊ - * Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).␊ - */␊ - valueCode?: string␊ - _valueCode?: Element4␊ - /**␊ - * Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).␊ - */␊ - valueDate?: string␊ - _valueDate?: Element5␊ - /**␊ - * Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).␊ - */␊ - valueDateTime?: string␊ - _valueDateTime?: Element6␊ - /**␊ - * Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).␊ - */␊ - valueDecimal?: number␊ - _valueDecimal?: Element7␊ - /**␊ - * Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).␊ - */␊ - valueId?: string␊ - _valueId?: Element8␊ - /**␊ - * Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).␊ - */␊ - valueInstant?: string␊ - _valueInstant?: Element9␊ - /**␊ - * Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).␊ - */␊ - valueInteger?: number␊ - _valueInteger?: Element10␊ - /**␊ - * Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).␊ - */␊ - valueMarkdown?: string␊ - _valueMarkdown?: Element11␊ - /**␊ - * Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).␊ - */␊ - valueOid?: string␊ - _valueOid?: Element12␊ - /**␊ - * Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).␊ - */␊ - valuePositiveInt?: number␊ - _valuePositiveInt?: Element13␊ - /**␊ - * Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).␊ - */␊ - valueString?: string␊ - _valueString?: Element14␊ - /**␊ - * Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).␊ - */␊ - valueTime?: string␊ - _valueTime?: Element15␊ - /**␊ - * Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).␊ - */␊ - valueUnsignedInt?: number␊ - _valueUnsignedInt?: Element16␊ - /**␊ - * Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).␊ - */␊ - valueUri?: string␊ - _valueUri?: Element17␊ - /**␊ - * Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).␊ - */␊ - valueUrl?: string␊ - _valueUrl?: Element18␊ - /**␊ - * Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).␊ - */␊ - valueUuid?: string␊ - _valueUuid?: Element19␊ - valueAddress?: Address␊ - valueAge?: Age␊ - valueAnnotation?: Annotation␊ - valueAttachment?: Attachment␊ - valueCodeableConcept?: CodeableConcept1␊ - valueCoding?: Coding1␊ - valueContactPoint?: ContactPoint␊ - valueCount?: Count␊ - valueDistance?: Distance␊ - valueDuration?: Duration␊ - valueHumanName?: HumanName␊ - valueIdentifier?: Identifier1␊ - valueMoney?: Money␊ - valuePeriod?: Period4␊ - valueQuantity?: Quantity␊ - valueRange?: Range␊ - valueRatio?: Ratio␊ - valueReference?: Reference2␊ - valueSampledData?: SampledData␊ - valueSignature?: Signature␊ - valueTiming?: Timing␊ - valueContactDetail?: ContactDetail␊ - valueContributor?: Contributor␊ - valueDataRequirement?: DataRequirement␊ - valueExpression?: Expression␊ - valueParameterDefinition?: ParameterDefinition␊ - valueRelatedArtifact?: RelatedArtifact␊ - valueTriggerDefinition?: TriggerDefinition␊ - valueUsageContext?: UsageContext␊ - valueDosage?: Dosage␊ - valueMeta?: Meta1␊ - }␊ - /**␊ - * Extensions for url␊ - */␊ - export interface Element {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Extensions for valueBase64Binary␊ - */␊ - export interface Element1 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Extensions for valueBoolean␊ - */␊ - export interface Element2 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Extensions for valueCanonical␊ - */␊ - export interface Element3 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Extensions for valueCode␊ - */␊ - export interface Element4 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Extensions for valueDate␊ - */␊ - export interface Element5 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Extensions for valueDateTime␊ - */␊ - export interface Element6 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Extensions for valueDecimal␊ - */␊ - export interface Element7 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Extensions for valueId␊ - */␊ - export interface Element8 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Extensions for valueInstant␊ - */␊ - export interface Element9 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Extensions for valueInteger␊ - */␊ - export interface Element10 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Extensions for valueMarkdown␊ - */␊ - export interface Element11 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Extensions for valueOid␊ - */␊ - export interface Element12 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Extensions for valuePositiveInt␊ - */␊ - export interface Element13 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Extensions for valueString␊ - */␊ - export interface Element14 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Extensions for valueTime␊ - */␊ - export interface Element15 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Extensions for valueUnsignedInt␊ - */␊ - export interface Element16 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Extensions for valueUri␊ - */␊ - export interface Element17 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Extensions for valueUrl␊ - */␊ - export interface Element18 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Extensions for valueUuid␊ - */␊ - export interface Element19 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).␊ - */␊ - export interface Address {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this address.␊ - */␊ - use?: ("home" | "work" | "temp" | "old" | "billing")␊ - _use?: Element20␊ - /**␊ - * Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.␊ - */␊ - type?: ("postal" | "physical" | "both")␊ - _type?: Element21␊ - /**␊ - * Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.␊ - */␊ - text?: string␊ - _text?: Element22␊ - /**␊ - * This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.␊ - */␊ - line?: String[]␊ - /**␊ - * Extensions for line␊ - */␊ - _line?: Element23[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - city?: string␊ - _city?: Element24␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - district?: string␊ - _district?: Element25␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - state?: string␊ - _state?: Element26␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - postalCode?: string␊ - _postalCode?: Element27␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - country?: string␊ - _country?: Element28␊ - period?: Period␊ - }␊ - /**␊ - * Extensions for use␊ - */␊ - export interface Element20 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Extensions for type␊ - */␊ - export interface Element21 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Extensions for text␊ - */␊ - export interface Element22 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element23 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element24 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element25 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element26 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element27 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element28 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Time period when address was/is in use.␊ - */␊ - export interface Period {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element29 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element30 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).␊ - */␊ - export interface Age {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element31␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element32␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element33␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element34␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element35␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element31 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element32 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element33 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element34 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element35 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).␊ - */␊ - export interface Annotation {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - authorReference?: Reference␊ - /**␊ - * The individual responsible for making the annotation.␊ - */␊ - authorString?: string␊ - _authorString?: Element48␊ - /**␊ - * Indicates when this particular annotation was made.␊ - */␊ - time?: string␊ - _time?: Element49␊ - /**␊ - * The text of the annotation in markdown format.␊ - */␊ - text?: string␊ - _text?: Element50␊ - }␊ - /**␊ - * The individual responsible for making the annotation.␊ - */␊ - export interface Reference {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element36 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element37 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.␊ - */␊ - export interface Identifier {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element38 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.␊ - */␊ - export interface CodeableConcept {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - export interface Coding {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The identification of the code system that defines the meaning of the symbol in the code.␊ - */␊ - system?: string␊ - _system?: Element39␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element40␊ - /**␊ - * A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).␊ - */␊ - code?: string␊ - _code?: Element41␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element42␊ - /**␊ - * Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).␊ - */␊ - userSelected?: boolean␊ - _userSelected?: Element43␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element39 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element40 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element41 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element42 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element43 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element44 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element45 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element46 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Time period during which identifier is/was valid for use.␊ - */␊ - export interface Period1 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Organization that issued/manages the identifier.␊ - */␊ - export interface Reference1 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element47 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element48 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element49 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element50 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).␊ - */␊ - export interface Attachment {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.␊ - */␊ - contentType?: string␊ - _contentType?: Element51␊ - /**␊ - * The human language of the content. The value can be any valid value according to BCP 47.␊ - */␊ - language?: string␊ - _language?: Element52␊ - /**␊ - * The actual data of the attachment - a sequence of bytes, base64 encoded.␊ - */␊ - data?: string␊ - _data?: Element53␊ - /**␊ - * A location where the data can be accessed.␊ - */␊ - url?: string␊ - _url?: Element54␊ - /**␊ - * The number of bytes of data that make up this attachment (before base64 encoding, if that is done).␊ - */␊ - size?: number␊ - _size?: Element55␊ - /**␊ - * The calculated hash of the data using SHA-1. Represented using base64.␊ - */␊ - hash?: string␊ - _hash?: Element56␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element57␊ - /**␊ - * The date that the attachment was first created.␊ - */␊ - creation?: string␊ - _creation?: Element58␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element51 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element52 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element53 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element54 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element55 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element56 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element57 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element58 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).␊ - */␊ - export interface CodeableConcept1 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - export interface Coding1 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The identification of the code system that defines the meaning of the symbol in the code.␊ - */␊ - system?: string␊ - _system?: Element39␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element40␊ - /**␊ - * A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).␊ - */␊ - code?: string␊ - _code?: Element41␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element42␊ - /**␊ - * Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).␊ - */␊ - userSelected?: boolean␊ - _userSelected?: Element43␊ - }␊ - /**␊ - * Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).␊ - */␊ - export interface ContactPoint {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Telecommunications form for contact point - what communications system is required to make use of the contact.␊ - */␊ - system?: ("phone" | "fax" | "email" | "pager" | "url" | "sms" | "other")␊ - _system?: Element59␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element60␊ - /**␊ - * Identifies the purpose for the contact point.␊ - */␊ - use?: ("home" | "work" | "temp" | "old" | "mobile")␊ - _use?: Element61␊ - /**␊ - * Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.␊ - */␊ - rank?: number␊ - _rank?: Element62␊ - period?: Period2␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element59 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element60 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element61 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element62 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Time period when the contact point was/is in use.␊ - */␊ - export interface Period2 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).␊ - */␊ - export interface Count {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element63␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element64␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element65␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element66␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element67␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element63 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element64 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element65 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element66 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element67 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).␊ - */␊ - export interface Distance {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element68␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element69␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element70␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element71␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element72␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element68 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element69 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element70 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element71 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element72 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).␊ - */␊ - export interface Duration {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element73␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element74␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element75␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element76␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element77␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element73 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element74 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element75 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element76 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element77 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).␊ - */␊ - export interface HumanName {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Identifies the purpose for this name.␊ - */␊ - use?: ("usual" | "official" | "temp" | "nickname" | "anonymous" | "old" | "maiden")␊ - _use?: Element78␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element79␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - family?: string␊ - _family?: Element80␊ - /**␊ - * Given name.␊ - */␊ - given?: String[]␊ - /**␊ - * Extensions for given␊ - */␊ - _given?: Element23[]␊ - /**␊ - * Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.␊ - */␊ - prefix?: String[]␊ - /**␊ - * Extensions for prefix␊ - */␊ - _prefix?: Element23[]␊ - /**␊ - * Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.␊ - */␊ - suffix?: String[]␊ - /**␊ - * Extensions for suffix␊ - */␊ - _suffix?: Element23[]␊ - period?: Period3␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element78 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element79 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element80 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Indicates the period of time when this name was valid for the named person.␊ - */␊ - export interface Period3 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).␊ - */␊ - export interface Identifier1 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).␊ - */␊ - export interface Money {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element81 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element82 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).␊ - */␊ - export interface Period4 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).␊ - */␊ - export interface Quantity {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element83 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element84 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element85 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element86 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element87 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).␊ - */␊ - export interface Range {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - low?: Quantity1␊ - high?: Quantity2␊ - }␊ - /**␊ - * The low limit. The boundary is inclusive.␊ - */␊ - export interface Quantity1 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * The high limit. The boundary is inclusive.␊ - */␊ - export interface Quantity2 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).␊ - */␊ - export interface Ratio {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - numerator?: Quantity3␊ - denominator?: Quantity4␊ - }␊ - /**␊ - * The value of the numerator.␊ - */␊ - export interface Quantity3 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * The value of the denominator.␊ - */␊ - export interface Quantity4 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).␊ - */␊ - export interface Reference2 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).␊ - */␊ - export interface SampledData {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - origin: Quantity5␊ - /**␊ - * The length of time between sampling times, measured in milliseconds.␊ - */␊ - period?: number␊ - _period?: Element88␊ - /**␊ - * A correction factor that is applied to the sampled data points before they are added to the origin.␊ - */␊ - factor?: number␊ - _factor?: Element89␊ - /**␊ - * The lower limit of detection of the measured points. This is needed if any of the data points have the value "L" (lower than detection limit).␊ - */␊ - lowerLimit?: number␊ - _lowerLimit?: Element90␊ - /**␊ - * The upper limit of detection of the measured points. This is needed if any of the data points have the value "U" (higher than detection limit).␊ - */␊ - upperLimit?: number␊ - _upperLimit?: Element91␊ - /**␊ - * The number of sample points at each time point. If this value is greater than one, then the dimensions will be interlaced - all the sample points for a point in time will be recorded at once.␊ - */␊ - dimensions?: number␊ - _dimensions?: Element92␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - data?: string␊ - _data?: Element93␊ - }␊ - /**␊ - * The base quantity that a measured value of zero represents. In addition, this provides the units of the entire measurement series.␊ - */␊ - export interface Quantity5 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element88 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element89 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element90 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element91 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element92 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element93 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).␊ - */␊ - export interface Signature {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document.␊ - */␊ - type: Coding[]␊ - /**␊ - * When the digital signature was signed.␊ - */␊ - when?: string␊ - _when?: Element94␊ - who: Reference3␊ - onBehalfOf?: Reference4␊ - /**␊ - * A mime type that indicates the technical format of the target resources signed by the signature.␊ - */␊ - targetFormat?: string␊ - _targetFormat?: Element95␊ - /**␊ - * A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jose for JWS, and image/* for a graphical image of a signature, etc.␊ - */␊ - sigFormat?: string␊ - _sigFormat?: Element96␊ - /**␊ - * The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty.␊ - */␊ - data?: string␊ - _data?: Element97␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element94 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference to an application-usable description of the identity that signed (e.g. the signature used their private key).␊ - */␊ - export interface Reference3 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference to an application-usable description of the identity that is represented by the signature.␊ - */␊ - export interface Reference4 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element95 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element96 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element97 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).␊ - */␊ - export interface Timing {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifies specific times when the event occurs.␊ - */␊ - event?: DateTime[]␊ - /**␊ - * Extensions for event␊ - */␊ - _event?: Element23[]␊ - repeat?: Timing_Repeat␊ - code?: CodeableConcept2␊ - }␊ - /**␊ - * A set of rules that describe when the event is scheduled.␊ - */␊ - export interface Timing_Repeat {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - boundsDuration?: Duration1␊ - boundsRange?: Range1␊ - boundsPeriod?: Period5␊ - /**␊ - * A total count of the desired number of repetitions across the duration of the entire timing specification. If countMax is present, this element indicates the lower bound of the allowed range of count values.␊ - */␊ - count?: number␊ - _count?: Element98␊ - /**␊ - * If present, indicates that the count is a range - so to perform the action between [count] and [countMax] times.␊ - */␊ - countMax?: number␊ - _countMax?: Element99␊ - /**␊ - * How long this thing happens for when it happens. If durationMax is present, this element indicates the lower bound of the allowed range of the duration.␊ - */␊ - duration?: number␊ - _duration?: Element100␊ - /**␊ - * If present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length.␊ - */␊ - durationMax?: number␊ - _durationMax?: Element101␊ - /**␊ - * The units of time for the duration, in UCUM units.␊ - */␊ - durationUnit?: ("s" | "min" | "h" | "d" | "wk" | "mo" | "a")␊ - _durationUnit?: Element102␊ - /**␊ - * The number of times to repeat the action within the specified period. If frequencyMax is present, this element indicates the lower bound of the allowed range of the frequency.␊ - */␊ - frequency?: number␊ - _frequency?: Element103␊ - /**␊ - * If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range.␊ - */␊ - frequencyMax?: number␊ - _frequencyMax?: Element104␊ - /**␊ - * Indicates the duration of time over which repetitions are to occur; e.g. to express "3 times per day", 3 would be the frequency and "1 day" would be the period. If periodMax is present, this element indicates the lower bound of the allowed range of the period length.␊ - */␊ - period?: number␊ - _period?: Element105␊ - /**␊ - * If present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as "do this once every 3-5 days.␊ - */␊ - periodMax?: number␊ - _periodMax?: Element106␊ - /**␊ - * The units of time for the period in UCUM units.␊ - */␊ - periodUnit?: ("s" | "min" | "h" | "d" | "wk" | "mo" | "a")␊ - _periodUnit?: Element107␊ - /**␊ - * If one or more days of week is provided, then the action happens only on the specified day(s).␊ - */␊ - dayOfWeek?: Code[]␊ - /**␊ - * Extensions for dayOfWeek␊ - */␊ - _dayOfWeek?: Element23[]␊ - /**␊ - * Specified time of day for action to take place.␊ - */␊ - timeOfDay?: Time[]␊ - /**␊ - * Extensions for timeOfDay␊ - */␊ - _timeOfDay?: Element23[]␊ - /**␊ - * An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur.␊ - */␊ - when?: ("MORN" | "MORN.early" | "MORN.late" | "NOON" | "AFT" | "AFT.early" | "AFT.late" | "EVE" | "EVE.early" | "EVE.late" | "NIGHT" | "PHS" | "HS" | "WAKE" | "C" | "CM" | "CD" | "CV" | "AC" | "ACM" | "ACD" | "ACV" | "PC" | "PCM" | "PCD" | "PCV")[]␊ - /**␊ - * Extensions for when␊ - */␊ - _when?: Element23[]␊ - /**␊ - * The number of minutes from the event. If the event code does not indicate whether the minutes is before or after the event, then the offset is assumed to be after the event.␊ - */␊ - offset?: number␊ - _offset?: Element108␊ - }␊ - /**␊ - * Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.␊ - */␊ - export interface Duration1 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element73␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element74␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element75␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element76␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element77␊ - }␊ - /**␊ - * Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.␊ - */␊ - export interface Range1 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - low?: Quantity1␊ - high?: Quantity2␊ - }␊ - /**␊ - * Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.␊ - */␊ - export interface Period5 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element98 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element99 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element100 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element101 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element102 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element103 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element104 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element105 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element106 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element107 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element108 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A code for the timing schedule (or just text in code.text). Some codes such as BID are ubiquitous, but many institutions define their own additional codes. If a code is provided, the code is understood to be a complete statement of whatever is specified in the structured timing data, and either the code or the data may be used to interpret the Timing, with the exception that .repeat.bounds still applies over the code (and is not contained in the code).␊ - */␊ - export interface CodeableConcept2 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).␊ - */␊ - export interface ContactDetail {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element109␊ - /**␊ - * The contact details for the individual (if a name was provided) or the organization.␊ - */␊ - telecom?: ContactPoint1[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element109 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.␊ - */␊ - export interface ContactPoint1 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Telecommunications form for contact point - what communications system is required to make use of the contact.␊ - */␊ - system?: ("phone" | "fax" | "email" | "pager" | "url" | "sms" | "other")␊ - _system?: Element59␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element60␊ - /**␊ - * Identifies the purpose for the contact point.␊ - */␊ - use?: ("home" | "work" | "temp" | "old" | "mobile")␊ - _use?: Element61␊ - /**␊ - * Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.␊ - */␊ - rank?: number␊ - _rank?: Element62␊ - period?: Period2␊ - }␊ - /**␊ - * Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).␊ - */␊ - export interface Contributor {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The type of contributor.␊ - */␊ - type?: ("author" | "editor" | "reviewer" | "endorser")␊ - _type?: Element110␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element111␊ - /**␊ - * Contact details to assist a user in finding and communicating with the contributor.␊ - */␊ - contact?: ContactDetail1[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element110 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element111 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Specifies contact information for a person or organization.␊ - */␊ - export interface ContactDetail1 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element109␊ - /**␊ - * The contact details for the individual (if a name was provided) or the organization.␊ - */␊ - telecom?: ContactPoint1[]␊ - }␊ - /**␊ - * Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).␊ - */␊ - export interface DataRequirement {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - type?: string␊ - _type?: Element112␊ - /**␊ - * The profile of the required data, specified as the uri of the profile definition.␊ - */␊ - profile?: Canonical[]␊ - subjectCodeableConcept?: CodeableConcept3␊ - subjectReference?: Reference5␊ - /**␊ - * Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. ␊ - * ␊ - * The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details).␊ - */␊ - mustSupport?: String[]␊ - /**␊ - * Extensions for mustSupport␊ - */␊ - _mustSupport?: Element23[]␊ - /**␊ - * Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.␊ - */␊ - codeFilter?: DataRequirement_CodeFilter[]␊ - /**␊ - * Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.␊ - */␊ - dateFilter?: DataRequirement_DateFilter[]␊ - /**␊ - * Specifies a maximum number of results that are required (uses the _count search parameter).␊ - */␊ - limit?: number␊ - _limit?: Element118␊ - /**␊ - * Specifies the order of the results to be returned.␊ - */␊ - sort?: DataRequirement_Sort[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element112 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.␊ - */␊ - export interface CodeableConcept3 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.␊ - */␊ - export interface Reference5 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.␊ - */␊ - export interface DataRequirement_CodeFilter {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - path?: string␊ - _path?: Element113␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - searchParam?: string␊ - _searchParam?: Element114␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - valueSet?: string␊ - /**␊ - * The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.␊ - */␊ - code?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element113 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element114 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.␊ - */␊ - export interface DataRequirement_DateFilter {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - path?: string␊ - _path?: Element115␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - searchParam?: string␊ - _searchParam?: Element116␊ - /**␊ - * The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.␊ - */␊ - valueDateTime?: string␊ - _valueDateTime?: Element117␊ - valuePeriod?: Period6␊ - valueDuration?: Duration2␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element115 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element116 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element117 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.␊ - */␊ - export interface Period6 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.␊ - */␊ - export interface Duration2 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element73␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element74␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element75␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element76␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element77␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element118 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.␊ - */␊ - export interface DataRequirement_Sort {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - path?: string␊ - _path?: Element119␊ - /**␊ - * The direction of the sort, ascending or descending.␊ - */␊ - direction?: ("ascending" | "descending")␊ - _direction?: Element120␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element119 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element120 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).␊ - */␊ - export interface Expression {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element121␊ - /**␊ - * A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.␊ - */␊ - name?: string␊ - _name?: Element122␊ - /**␊ - * The media type of the language for the expression.␊ - */␊ - language?: ("text/cql" | "text/fhirpath" | "application/x-fhir-query")␊ - _language?: Element123␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - expression?: string␊ - _expression?: Element124␊ - /**␊ - * A URI that defines where the expression is found.␊ - */␊ - reference?: string␊ - _reference?: Element125␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element121 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element122 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element123 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element124 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element125 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).␊ - */␊ - export interface ParameterDefinition {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - name?: string␊ - _name?: Element126␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - use?: string␊ - _use?: Element127␊ - /**␊ - * The minimum number of times this parameter SHALL appear in the request or response.␊ - */␊ - min?: number␊ - _min?: Element128␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - max?: string␊ - _max?: Element129␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - documentation?: string␊ - _documentation?: Element130␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - type?: string␊ - _type?: Element131␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - profile?: string␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element126 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element127 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element128 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element129 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element130 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element131 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).␊ - */␊ - export interface RelatedArtifact {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The type of relationship to the related artifact.␊ - */␊ - type?: ("documentation" | "justification" | "citation" | "predecessor" | "successor" | "derived-from" | "depends-on" | "composed-of")␊ - _type?: Element132␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - label?: string␊ - _label?: Element133␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element134␊ - /**␊ - * A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.␊ - */␊ - citation?: string␊ - _citation?: Element135␊ - /**␊ - * A url for the artifact that can be followed to access the actual content.␊ - */␊ - url?: string␊ - _url?: Element136␊ - document?: Attachment1␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - resource?: string␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element132 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element133 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element134 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element135 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element136 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The document being referenced, represented as an attachment. This is exclusive with the resource element.␊ - */␊ - export interface Attachment1 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.␊ - */␊ - contentType?: string␊ - _contentType?: Element51␊ - /**␊ - * The human language of the content. The value can be any valid value according to BCP 47.␊ - */␊ - language?: string␊ - _language?: Element52␊ - /**␊ - * The actual data of the attachment - a sequence of bytes, base64 encoded.␊ - */␊ - data?: string␊ - _data?: Element53␊ - /**␊ - * A location where the data can be accessed.␊ - */␊ - url?: string␊ - _url?: Element54␊ - /**␊ - * The number of bytes of data that make up this attachment (before base64 encoding, if that is done).␊ - */␊ - size?: number␊ - _size?: Element55␊ - /**␊ - * The calculated hash of the data using SHA-1. Represented using base64.␊ - */␊ - hash?: string␊ - _hash?: Element56␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element57␊ - /**␊ - * The date that the attachment was first created.␊ - */␊ - creation?: string␊ - _creation?: Element58␊ - }␊ - /**␊ - * Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).␊ - */␊ - export interface TriggerDefinition {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The type of triggering event.␊ - */␊ - type?: ("named-event" | "periodic" | "data-changed" | "data-added" | "data-modified" | "data-removed" | "data-accessed" | "data-access-ended")␊ - _type?: Element137␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element138␊ - timingTiming?: Timing1␊ - timingReference?: Reference6␊ - /**␊ - * The timing of the event (if this is a periodic trigger).␊ - */␊ - timingDate?: string␊ - _timingDate?: Element139␊ - /**␊ - * The timing of the event (if this is a periodic trigger).␊ - */␊ - timingDateTime?: string␊ - _timingDateTime?: Element140␊ - /**␊ - * The triggering data of the event (if this is a data trigger). If more than one data is requirement is specified, then all the data requirements must be true.␊ - */␊ - data?: DataRequirement1[]␊ - condition?: Expression1␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element137 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element138 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The timing of the event (if this is a periodic trigger).␊ - */␊ - export interface Timing1 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifies specific times when the event occurs.␊ - */␊ - event?: DateTime[]␊ - /**␊ - * Extensions for event␊ - */␊ - _event?: Element23[]␊ - repeat?: Timing_Repeat␊ - code?: CodeableConcept2␊ - }␊ - /**␊ - * The timing of the event (if this is a periodic trigger).␊ - */␊ - export interface Reference6 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element139 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element140 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.␊ - */␊ - export interface DataRequirement1 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - type?: string␊ - _type?: Element112␊ - /**␊ - * The profile of the required data, specified as the uri of the profile definition.␊ - */␊ - profile?: Canonical[]␊ - subjectCodeableConcept?: CodeableConcept3␊ - subjectReference?: Reference5␊ - /**␊ - * Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. ␊ - * ␊ - * The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details).␊ - */␊ - mustSupport?: String[]␊ - /**␊ - * Extensions for mustSupport␊ - */␊ - _mustSupport?: Element23[]␊ - /**␊ - * Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.␊ - */␊ - codeFilter?: DataRequirement_CodeFilter[]␊ - /**␊ - * Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.␊ - */␊ - dateFilter?: DataRequirement_DateFilter[]␊ - /**␊ - * Specifies a maximum number of results that are required (uses the _count search parameter).␊ - */␊ - limit?: number␊ - _limit?: Element118␊ - /**␊ - * Specifies the order of the results to be returned.␊ - */␊ - sort?: DataRequirement_Sort[]␊ - }␊ - /**␊ - * A boolean-valued expression that is evaluated in the context of the container of the trigger definition and returns whether or not the trigger fires.␊ - */␊ - export interface Expression1 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element121␊ - /**␊ - * A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.␊ - */␊ - name?: string␊ - _name?: Element122␊ - /**␊ - * The media type of the language for the expression.␊ - */␊ - language?: ("text/cql" | "text/fhirpath" | "application/x-fhir-query")␊ - _language?: Element123␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - expression?: string␊ - _expression?: Element124␊ - /**␊ - * A URI that defines where the expression is found.␊ - */␊ - reference?: string␊ - _reference?: Element125␊ - }␊ - /**␊ - * Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).␊ - */␊ - export interface UsageContext {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - code: Coding2␊ - valueCodeableConcept?: CodeableConcept4␊ - valueQuantity?: Quantity6␊ - valueRange?: Range2␊ - valueReference?: Reference7␊ - }␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - export interface Coding2 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The identification of the code system that defines the meaning of the symbol in the code.␊ - */␊ - system?: string␊ - _system?: Element39␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element40␊ - /**␊ - * A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).␊ - */␊ - code?: string␊ - _code?: Element41␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element42␊ - /**␊ - * Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).␊ - */␊ - userSelected?: boolean␊ - _userSelected?: Element43␊ - }␊ - /**␊ - * A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.␊ - */␊ - export interface CodeableConcept4 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.␊ - */␊ - export interface Quantity6 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.␊ - */␊ - export interface Range2 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - low?: Quantity1␊ - high?: Quantity2␊ - }␊ - /**␊ - * A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.␊ - */␊ - export interface Reference7 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).␊ - */␊ - export interface Dosage {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Indicates the order in which the dosage instructions should be applied or interpreted.␊ - */␊ - sequence?: number␊ - _sequence?: Element141␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element142␊ - /**␊ - * Supplemental instructions to the patient on how to take the medication (e.g. "with meals" or"take half to one hour before food") or warnings for the patient about the medication (e.g. "may cause drowsiness" or "avoid exposure of skin to direct sunlight or sunlamps").␊ - */␊ - additionalInstruction?: CodeableConcept5[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - patientInstruction?: string␊ - _patientInstruction?: Element143␊ - timing?: Timing2␊ - /**␊ - * Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).␊ - */␊ - asNeededBoolean?: boolean␊ - _asNeededBoolean?: Element144␊ - asNeededCodeableConcept?: CodeableConcept6␊ - site?: CodeableConcept7␊ - route?: CodeableConcept8␊ - method?: CodeableConcept9␊ - /**␊ - * The amount of medication administered.␊ - */␊ - doseAndRate?: Dosage_DoseAndRate[]␊ - maxDosePerPeriod?: Ratio2␊ - maxDosePerAdministration?: Quantity9␊ - maxDosePerLifetime?: Quantity10␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element141 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element142 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept5 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element143 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * When medication should be administered.␊ - */␊ - export interface Timing2 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifies specific times when the event occurs.␊ - */␊ - event?: DateTime[]␊ - /**␊ - * Extensions for event␊ - */␊ - _event?: Element23[]␊ - repeat?: Timing_Repeat␊ - code?: CodeableConcept2␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element144 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept6 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept7 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept8 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept9 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Indicates how the medication is/was taken or should be taken by the patient.␊ - */␊ - export interface Dosage_DoseAndRate {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - type?: CodeableConcept10␊ - doseRange?: Range3␊ - doseQuantity?: Quantity7␊ - rateRatio?: Ratio1␊ - rateRange?: Range4␊ - rateQuantity?: Quantity8␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept10 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Amount of medication per dose.␊ - */␊ - export interface Range3 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - low?: Quantity1␊ - high?: Quantity2␊ - }␊ - /**␊ - * Amount of medication per dose.␊ - */␊ - export interface Quantity7 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * Amount of medication per unit of time.␊ - */␊ - export interface Ratio1 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - numerator?: Quantity3␊ - denominator?: Quantity4␊ - }␊ - /**␊ - * Amount of medication per unit of time.␊ - */␊ - export interface Range4 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - low?: Quantity1␊ - high?: Quantity2␊ - }␊ - /**␊ - * Amount of medication per unit of time.␊ - */␊ - export interface Quantity8 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * Upper limit on medication per unit of time.␊ - */␊ - export interface Ratio2 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - numerator?: Quantity3␊ - denominator?: Quantity4␊ - }␊ - /**␊ - * Upper limit on medication per administration.␊ - */␊ - export interface Quantity9 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * Upper limit on medication per lifetime of the patient.␊ - */␊ - export interface Quantity10 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).␊ - */␊ - export interface Meta1 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element145 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element146 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element147 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element148 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element149 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element150 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.␊ - */␊ - export interface ActivityDefinition {␊ - /**␊ - * This is a ActivityDefinition resource␊ - */␊ - resourceType: "ActivityDefinition"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta2␊ - /**␊ - * A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element151␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element152␊ - text?: Narrative1␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * An absolute URI that is used to identify this activity definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this activity definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the activity definition is stored on different servers.␊ - */␊ - url?: string␊ - _url?: Element153␊ - /**␊ - * A formal identifier that is used to identify this activity definition when it is represented in other formats, or referenced in a specification, model, design or an instance.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element154␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element155␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element156␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - subtitle?: string␊ - _subtitle?: Element157␊ - /**␊ - * The status of this activity definition. Enables tracking the life-cycle of the content.␊ - */␊ - status?: ("draft" | "active" | "retired" | "unknown")␊ - _status?: Element158␊ - /**␊ - * A Boolean value to indicate that this activity definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.␊ - */␊ - experimental?: boolean␊ - _experimental?: Element159␊ - subjectCodeableConcept?: CodeableConcept11␊ - subjectReference?: Reference8␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - date?: string␊ - _date?: Element160␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - publisher?: string␊ - _publisher?: Element161␊ - /**␊ - * Contact details to assist a user in finding and communicating with the publisher.␊ - */␊ - contact?: ContactDetail1[]␊ - /**␊ - * A free text natural language description of the activity definition from a consumer's perspective.␊ - */␊ - description?: string␊ - _description?: Element162␊ - /**␊ - * The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate activity definition instances.␊ - */␊ - useContext?: UsageContext1[]␊ - /**␊ - * A legal or geographic region in which the activity definition is intended to be used.␊ - */␊ - jurisdiction?: CodeableConcept5[]␊ - /**␊ - * Explanation of why this activity definition is needed and why it has been designed as it has.␊ - */␊ - purpose?: string␊ - _purpose?: Element163␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - usage?: string␊ - _usage?: Element164␊ - /**␊ - * A copyright statement relating to the activity definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the activity definition.␊ - */␊ - copyright?: string␊ - _copyright?: Element165␊ - /**␊ - * The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.␊ - */␊ - approvalDate?: string␊ - _approvalDate?: Element166␊ - /**␊ - * The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.␊ - */␊ - lastReviewDate?: string␊ - _lastReviewDate?: Element167␊ - effectivePeriod?: Period7␊ - /**␊ - * Descriptive topics related to the content of the activity. Topics provide a high-level categorization of the activity that can be useful for filtering and searching.␊ - */␊ - topic?: CodeableConcept5[]␊ - /**␊ - * An individiual or organization primarily involved in the creation and maintenance of the content.␊ - */␊ - author?: ContactDetail1[]␊ - /**␊ - * An individual or organization primarily responsible for internal coherence of the content.␊ - */␊ - editor?: ContactDetail1[]␊ - /**␊ - * An individual or organization primarily responsible for review of some aspect of the content.␊ - */␊ - reviewer?: ContactDetail1[]␊ - /**␊ - * An individual or organization responsible for officially endorsing the content for use in some setting.␊ - */␊ - endorser?: ContactDetail1[]␊ - /**␊ - * Related artifacts such as additional documentation, justification, or bibliographic references.␊ - */␊ - relatedArtifact?: RelatedArtifact1[]␊ - /**␊ - * A reference to a Library resource containing any formal logic used by the activity definition.␊ - */␊ - library?: Canonical[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - kind?: string␊ - _kind?: Element168␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - profile?: string␊ - code?: CodeableConcept12␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - intent?: string␊ - _intent?: Element169␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - priority?: string␊ - _priority?: Element170␊ - /**␊ - * Set this to true if the definition is to indicate that a particular activity should NOT be performed. If true, this element should be interpreted to reinforce a negative coding. For example NPO as a code with a doNotPerform of true would still indicate to NOT perform the action.␊ - */␊ - doNotPerform?: boolean␊ - _doNotPerform?: Element171␊ - timingTiming?: Timing3␊ - /**␊ - * The period, timing or frequency upon which the described activity is to occur.␊ - */␊ - timingDateTime?: string␊ - _timingDateTime?: Element172␊ - timingAge?: Age1␊ - timingPeriod?: Period8␊ - timingRange?: Range5␊ - timingDuration?: Duration3␊ - location?: Reference9␊ - /**␊ - * Indicates who should participate in performing the action described.␊ - */␊ - participant?: ActivityDefinition_Participant[]␊ - productReference?: Reference10␊ - productCodeableConcept?: CodeableConcept14␊ - quantity?: Quantity11␊ - /**␊ - * Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources.␊ - */␊ - dosage?: Dosage1[]␊ - /**␊ - * Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites).␊ - */␊ - bodySite?: CodeableConcept5[]␊ - /**␊ - * Defines specimen requirements for the action to be performed, such as required specimens for a lab test.␊ - */␊ - specimenRequirement?: Reference11[]␊ - /**␊ - * Defines observation requirements for the action to be performed, such as body weight or surface area.␊ - */␊ - observationRequirement?: Reference11[]␊ - /**␊ - * Defines the observations that are expected to be produced by the action.␊ - */␊ - observationResultRequirement?: Reference11[]␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - transform?: string␊ - /**␊ - * Dynamic values that will be evaluated to produce values for elements of the resulting resource. For example, if the dosage of a medication must be computed based on the patient's weight, a dynamic value would be used to specify an expression that calculated the weight, and the path on the request resource that would contain the result.␊ - */␊ - dynamicValue?: ActivityDefinition_DynamicValue[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta2 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element151 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element152 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative1 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element153 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier2 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element154 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element155 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element156 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element157 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element158 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element159 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept11 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A code or group definition that describes the intended subject of the activity being defined.␊ - */␊ - export interface Reference8 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element160 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element161 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element162 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Specifies clinical/business/etc. metadata that can be used to retrieve, index and/or categorize an artifact. This metadata can either be specific to the applicable population (e.g., age category, DRG) or the specific context of care (e.g., venue, care setting, provider of care).␊ - */␊ - export interface UsageContext1 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - code: Coding2␊ - valueCodeableConcept?: CodeableConcept4␊ - valueQuantity?: Quantity6␊ - valueRange?: Range2␊ - valueReference?: Reference7␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element163 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element164 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element165 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element166 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element167 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The period during which the activity definition content was or is planned to be in active use.␊ - */␊ - export interface Period7 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Related artifacts such as additional documentation, justification, or bibliographic references.␊ - */␊ - export interface RelatedArtifact1 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The type of relationship to the related artifact.␊ - */␊ - type?: ("documentation" | "justification" | "citation" | "predecessor" | "successor" | "derived-from" | "depends-on" | "composed-of")␊ - _type?: Element132␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - label?: string␊ - _label?: Element133␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element134␊ - /**␊ - * A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.␊ - */␊ - citation?: string␊ - _citation?: Element135␊ - /**␊ - * A url for the artifact that can be followed to access the actual content.␊ - */␊ - url?: string␊ - _url?: Element136␊ - document?: Attachment1␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - resource?: string␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element168 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept12 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element169 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element170 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element171 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The period, timing or frequency upon which the described activity is to occur.␊ - */␊ - export interface Timing3 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifies specific times when the event occurs.␊ - */␊ - event?: DateTime[]␊ - /**␊ - * Extensions for event␊ - */␊ - _event?: Element23[]␊ - repeat?: Timing_Repeat␊ - code?: CodeableConcept2␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element172 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The period, timing or frequency upon which the described activity is to occur.␊ - */␊ - export interface Age1 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element31␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element32␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element33␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element34␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element35␊ - }␊ - /**␊ - * The period, timing or frequency upon which the described activity is to occur.␊ - */␊ - export interface Period8 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * The period, timing or frequency upon which the described activity is to occur.␊ - */␊ - export interface Range5 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - low?: Quantity1␊ - high?: Quantity2␊ - }␊ - /**␊ - * The period, timing or frequency upon which the described activity is to occur.␊ - */␊ - export interface Duration3 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element73␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element74␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element75␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element76␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element77␊ - }␊ - /**␊ - * Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.␊ - */␊ - export interface Reference9 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.␊ - */␊ - export interface ActivityDefinition_Participant {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - type?: string␊ - _type?: Element173␊ - role?: CodeableConcept13␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element173 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept13 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Identifies the food, drug or other product being consumed or supplied in the activity.␊ - */␊ - export interface Reference10 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept14 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Identifies the quantity expected to be consumed at once (per dose, per meal, etc.).␊ - */␊ - export interface Quantity11 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * Indicates how the medication is/was taken or should be taken by the patient.␊ - */␊ - export interface Dosage1 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Indicates the order in which the dosage instructions should be applied or interpreted.␊ - */␊ - sequence?: number␊ - _sequence?: Element141␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element142␊ - /**␊ - * Supplemental instructions to the patient on how to take the medication (e.g. "with meals" or"take half to one hour before food") or warnings for the patient about the medication (e.g. "may cause drowsiness" or "avoid exposure of skin to direct sunlight or sunlamps").␊ - */␊ - additionalInstruction?: CodeableConcept5[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - patientInstruction?: string␊ - _patientInstruction?: Element143␊ - timing?: Timing2␊ - /**␊ - * Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).␊ - */␊ - asNeededBoolean?: boolean␊ - _asNeededBoolean?: Element144␊ - asNeededCodeableConcept?: CodeableConcept6␊ - site?: CodeableConcept7␊ - route?: CodeableConcept8␊ - method?: CodeableConcept9␊ - /**␊ - * The amount of medication administered.␊ - */␊ - doseAndRate?: Dosage_DoseAndRate[]␊ - maxDosePerPeriod?: Ratio2␊ - maxDosePerAdministration?: Quantity9␊ - maxDosePerLifetime?: Quantity10␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference11 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.␊ - */␊ - export interface ActivityDefinition_DynamicValue {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - path?: string␊ - _path?: Element174␊ - expression: Expression2␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element174 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * An expression specifying the value of the customized element.␊ - */␊ - export interface Expression2 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element121␊ - /**␊ - * A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.␊ - */␊ - name?: string␊ - _name?: Element122␊ - /**␊ - * The media type of the language for the expression.␊ - */␊ - language?: ("text/cql" | "text/fhirpath" | "application/x-fhir-query")␊ - _language?: Element123␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - expression?: string␊ - _expression?: Element124␊ - /**␊ - * A URI that defines where the expression is found.␊ - */␊ - reference?: string␊ - _reference?: Element125␊ - }␊ - /**␊ - * Actual or potential/avoided event causing unintended physical injury resulting from or contributed to by medical care, a research study or other healthcare setting factors that requires additional monitoring, treatment, or hospitalization, or that results in death.␊ - */␊ - export interface AdverseEvent {␊ - /**␊ - * This is a AdverseEvent resource␊ - */␊ - resourceType: "AdverseEvent"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta3␊ - /**␊ - * A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element175␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element176␊ - text?: Narrative2␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - identifier?: Identifier3␊ - /**␊ - * Whether the event actually happened, or just had the potential to. Note that this is independent of whether anyone was affected or harmed or how severely.␊ - */␊ - actuality?: ("actual" | "potential")␊ - _actuality?: Element177␊ - /**␊ - * The overall type of event, intended for search and filtering purposes.␊ - */␊ - category?: CodeableConcept5[]␊ - event?: CodeableConcept15␊ - subject: Reference12␊ - encounter?: Reference13␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - date?: string␊ - _date?: Element178␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - detected?: string␊ - _detected?: Element179␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - recordedDate?: string␊ - _recordedDate?: Element180␊ - /**␊ - * Includes information about the reaction that occurred as a result of exposure to a substance (for example, a drug or a chemical).␊ - */␊ - resultingCondition?: Reference11[]␊ - location?: Reference14␊ - seriousness?: CodeableConcept16␊ - severity?: CodeableConcept17␊ - outcome?: CodeableConcept18␊ - recorder?: Reference15␊ - /**␊ - * Parties that may or should contribute or have contributed information to the adverse event, which can consist of one or more activities. Such information includes information leading to the decision to perform the activity and how to perform the activity (e.g. consultant), information that the activity itself seeks to reveal (e.g. informant of clinical history), or information about what activity was performed (e.g. informant witness).␊ - */␊ - contributor?: Reference11[]␊ - /**␊ - * Describes the entity that is suspected to have caused the adverse event.␊ - */␊ - suspectEntity?: AdverseEvent_SuspectEntity[]␊ - /**␊ - * AdverseEvent.subjectMedicalHistory.␊ - */␊ - subjectMedicalHistory?: Reference11[]␊ - /**␊ - * AdverseEvent.referenceDocument.␊ - */␊ - referenceDocument?: Reference11[]␊ - /**␊ - * AdverseEvent.study.␊ - */␊ - study?: Reference11[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta3 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element175 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element176 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative2 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier3 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element177 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept15 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference12 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference13 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element178 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element179 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element180 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference14 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept16 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept17 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept18 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference15 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Actual or potential/avoided event causing unintended physical injury resulting from or contributed to by medical care, a research study or other healthcare setting factors that requires additional monitoring, treatment, or hospitalization, or that results in death.␊ - */␊ - export interface AdverseEvent_SuspectEntity {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - instance: Reference16␊ - /**␊ - * Information on the possible cause of the event.␊ - */␊ - causality?: AdverseEvent_Causality[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference16 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Actual or potential/avoided event causing unintended physical injury resulting from or contributed to by medical care, a research study or other healthcare setting factors that requires additional monitoring, treatment, or hospitalization, or that results in death.␊ - */␊ - export interface AdverseEvent_Causality {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - assessment?: CodeableConcept19␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - productRelatedness?: string␊ - _productRelatedness?: Element181␊ - author?: Reference17␊ - method?: CodeableConcept20␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept19 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element181 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference17 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept20 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.␊ - */␊ - export interface AllergyIntolerance {␊ - /**␊ - * This is a AllergyIntolerance resource␊ - */␊ - resourceType: "AllergyIntolerance"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta4␊ - /**␊ - * A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element182␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element183␊ - text?: Narrative3␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Business identifiers assigned to this AllergyIntolerance by the performer or other systems which remain constant as the resource is updated and propagates from server to server.␊ - */␊ - identifier?: Identifier2[]␊ - clinicalStatus?: CodeableConcept21␊ - verificationStatus?: CodeableConcept22␊ - /**␊ - * Identification of the underlying physiological mechanism for the reaction risk.␊ - */␊ - type?: ("allergy" | "intolerance")␊ - _type?: Element184␊ - /**␊ - * Category of the identified substance.␊ - */␊ - category?: ("food" | "medication" | "environment" | "biologic")[]␊ - /**␊ - * Extensions for category␊ - */␊ - _category?: Element23[]␊ - /**␊ - * Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance.␊ - */␊ - criticality?: ("low" | "high" | "unable-to-assess")␊ - _criticality?: Element185␊ - code?: CodeableConcept23␊ - patient: Reference18␊ - encounter?: Reference19␊ - /**␊ - * Estimated or actual date, date-time, or age when allergy or intolerance was identified.␊ - */␊ - onsetDateTime?: string␊ - _onsetDateTime?: Element186␊ - onsetAge?: Age2␊ - onsetPeriod?: Period9␊ - onsetRange?: Range6␊ - /**␊ - * Estimated or actual date, date-time, or age when allergy or intolerance was identified.␊ - */␊ - onsetString?: string␊ - _onsetString?: Element187␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - recordedDate?: string␊ - _recordedDate?: Element188␊ - recorder?: Reference20␊ - asserter?: Reference21␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - lastOccurrence?: string␊ - _lastOccurrence?: Element189␊ - /**␊ - * Additional narrative about the propensity for the Adverse Reaction, not captured in other fields.␊ - */␊ - note?: Annotation1[]␊ - /**␊ - * Details about each adverse reaction event linked to exposure to the identified substance.␊ - */␊ - reaction?: AllergyIntolerance_Reaction[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta4 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element182 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element183 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative3 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept21 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept22 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element184 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element185 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept23 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference18 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference19 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element186 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Estimated or actual date, date-time, or age when allergy or intolerance was identified.␊ - */␊ - export interface Age2 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element31␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element32␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element33␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element34␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element35␊ - }␊ - /**␊ - * Estimated or actual date, date-time, or age when allergy or intolerance was identified.␊ - */␊ - export interface Period9 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Estimated or actual date, date-time, or age when allergy or intolerance was identified.␊ - */␊ - export interface Range6 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - low?: Quantity1␊ - high?: Quantity2␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element187 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element188 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference20 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference21 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element189 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A text note which also contains information about who made the statement and when.␊ - */␊ - export interface Annotation1 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - authorReference?: Reference␊ - /**␊ - * The individual responsible for making the annotation.␊ - */␊ - authorString?: string␊ - _authorString?: Element48␊ - /**␊ - * Indicates when this particular annotation was made.␊ - */␊ - time?: string␊ - _time?: Element49␊ - /**␊ - * The text of the annotation in markdown format.␊ - */␊ - text?: string␊ - _text?: Element50␊ - }␊ - /**␊ - * Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.␊ - */␊ - export interface AllergyIntolerance_Reaction {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - substance?: CodeableConcept24␊ - /**␊ - * Clinical symptoms and/or signs that are observed or associated with the adverse reaction event.␊ - */␊ - manifestation: CodeableConcept5[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element190␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - onset?: string␊ - _onset?: Element191␊ - /**␊ - * Clinical assessment of the severity of the reaction event as a whole, potentially considering multiple different manifestations.␊ - */␊ - severity?: ("mild" | "moderate" | "severe")␊ - _severity?: Element192␊ - exposureRoute?: CodeableConcept25␊ - /**␊ - * Additional text about the adverse reaction event not captured in other fields.␊ - */␊ - note?: Annotation1[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept24 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element190 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element191 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element192 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept25 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).␊ - */␊ - export interface Appointment {␊ - /**␊ - * This is a Appointment resource␊ - */␊ - resourceType: "Appointment"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta5␊ - /**␊ - * A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element193␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element194␊ - text?: Narrative4␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status.␊ - */␊ - status?: ("proposed" | "pending" | "booked" | "arrived" | "fulfilled" | "cancelled" | "noshow" | "entered-in-error" | "checked-in" | "waitlist")␊ - _status?: Element195␊ - cancelationReason?: CodeableConcept26␊ - /**␊ - * A broad categorization of the service that is to be performed during this appointment.␊ - */␊ - serviceCategory?: CodeableConcept5[]␊ - /**␊ - * The specific service that is to be performed during this appointment.␊ - */␊ - serviceType?: CodeableConcept5[]␊ - /**␊ - * The specialty of a practitioner that would be required to perform the service requested in this appointment.␊ - */␊ - specialty?: CodeableConcept5[]␊ - appointmentType?: CodeableConcept27␊ - /**␊ - * The coded reason that this appointment is being scheduled. This is more clinical than administrative.␊ - */␊ - reasonCode?: CodeableConcept5[]␊ - /**␊ - * Reason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.␊ - */␊ - reasonReference?: Reference11[]␊ - /**␊ - * The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority).␊ - */␊ - priority?: number␊ - _priority?: Element196␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element197␊ - /**␊ - * Additional information to support the appointment provided when making the appointment.␊ - */␊ - supportingInformation?: Reference11[]␊ - /**␊ - * Date/Time that the appointment is to take place.␊ - */␊ - start?: string␊ - _start?: Element198␊ - /**␊ - * Date/Time that the appointment is to conclude.␊ - */␊ - end?: string␊ - _end?: Element199␊ - /**␊ - * Number of minutes that the appointment is to take. This can be less than the duration between the start and end times. For example, where the actual time of appointment is only an estimate or if a 30 minute appointment is being requested, but any time would work. Also, if there is, for example, a planned 15 minute break in the middle of a long appointment, the duration may be 15 minutes less than the difference between the start and end.␊ - */␊ - minutesDuration?: number␊ - _minutesDuration?: Element200␊ - /**␊ - * The slots from the participants' schedules that will be filled by the appointment.␊ - */␊ - slot?: Reference11[]␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - created?: string␊ - _created?: Element201␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - comment?: string␊ - _comment?: Element202␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - patientInstruction?: string␊ - _patientInstruction?: Element203␊ - /**␊ - * The service request this appointment is allocated to assess (e.g. incoming referral or procedure request).␊ - */␊ - basedOn?: Reference11[]␊ - /**␊ - * List of participants involved in the appointment.␊ - */␊ - participant: Appointment_Participant[]␊ - /**␊ - * A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within.␊ - * ␊ - * The duration (usually in minutes) could also be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time. However, in other situations the duration may be calculated by the scheduling system.␊ - */␊ - requestedPeriod?: Period11[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta5 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element193 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element194 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative4 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element195 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept26 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept27 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element196 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element197 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element198 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element199 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element200 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element201 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element202 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element203 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).␊ - */␊ - export interface Appointment_Participant {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Role of participant in the appointment.␊ - */␊ - type?: CodeableConcept5[]␊ - actor?: Reference22␊ - /**␊ - * Whether this participant is required to be present at the meeting. This covers a use-case where two doctors need to meet to discuss the results for a specific patient, and the patient is not required to be present.␊ - */␊ - required?: ("required" | "optional" | "information-only")␊ - _required?: Element204␊ - /**␊ - * Participation status of the actor.␊ - */␊ - status?: ("accepted" | "declined" | "tentative" | "needs-action")␊ - _status?: Element205␊ - period?: Period10␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference22 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element204 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element205 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Participation period of the actor.␊ - */␊ - export interface Period10 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period11 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.␊ - */␊ - export interface AppointmentResponse {␊ - /**␊ - * This is a AppointmentResponse resource␊ - */␊ - resourceType: "AppointmentResponse"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta6␊ - /**␊ - * A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element206␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element207␊ - text?: Narrative5␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * This records identifiers associated with this appointment response concern that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate.␊ - */␊ - identifier?: Identifier2[]␊ - appointment: Reference23␊ - /**␊ - * Date/Time that the appointment is to take place, or requested new start time.␊ - */␊ - start?: string␊ - _start?: Element208␊ - /**␊ - * This may be either the same as the appointment request to confirm the details of the appointment, or alternately a new time to request a re-negotiation of the end time.␊ - */␊ - end?: string␊ - _end?: Element209␊ - /**␊ - * Role of participant in the appointment.␊ - */␊ - participantType?: CodeableConcept5[]␊ - actor?: Reference24␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - participantStatus?: string␊ - _participantStatus?: Element210␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - comment?: string␊ - _comment?: Element211␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta6 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element206 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element207 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative5 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference23 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element208 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element209 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference24 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element210 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element211 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.␊ - */␊ - export interface AuditEvent {␊ - /**␊ - * This is a AuditEvent resource␊ - */␊ - resourceType: "AuditEvent"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta7␊ - /**␊ - * A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element212␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element213␊ - text?: Narrative6␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - type: Coding3␊ - /**␊ - * Identifier for the category of event.␊ - */␊ - subtype?: Coding[]␊ - /**␊ - * Indicator for type of action performed during the event that generated the audit.␊ - */␊ - action?: ("C" | "R" | "U" | "D" | "E")␊ - _action?: Element214␊ - period?: Period12␊ - /**␊ - * The time when the event was recorded.␊ - */␊ - recorded?: string␊ - _recorded?: Element215␊ - /**␊ - * Indicates whether the event succeeded or failed.␊ - */␊ - outcome?: ("0" | "4" | "8" | "12")␊ - _outcome?: Element216␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - outcomeDesc?: string␊ - _outcomeDesc?: Element217␊ - /**␊ - * The purposeOfUse (reason) that was used during the event being recorded.␊ - */␊ - purposeOfEvent?: CodeableConcept5[]␊ - /**␊ - * An actor taking an active role in the event or activity that is logged.␊ - */␊ - agent: AuditEvent_Agent[]␊ - source: AuditEvent_Source␊ - /**␊ - * Specific instances of data or objects that have been accessed.␊ - */␊ - entity?: AuditEvent_Entity[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta7 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element212 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element213 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative6 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - export interface Coding3 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The identification of the code system that defines the meaning of the symbol in the code.␊ - */␊ - system?: string␊ - _system?: Element39␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element40␊ - /**␊ - * A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).␊ - */␊ - code?: string␊ - _code?: Element41␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element42␊ - /**␊ - * Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).␊ - */␊ - userSelected?: boolean␊ - _userSelected?: Element43␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element214 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period12 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element215 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element216 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element217 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.␊ - */␊ - export interface AuditEvent_Agent {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - type?: CodeableConcept28␊ - /**␊ - * The security role that the user was acting under, that come from local codes defined by the access control security system (e.g. RBAC, ABAC) used in the local context.␊ - */␊ - role?: CodeableConcept5[]␊ - who?: Reference25␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - altId?: string␊ - _altId?: Element218␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element219␊ - /**␊ - * Indicator that the user is or is not the requestor, or initiator, for the event being audited.␊ - */␊ - requestor?: boolean␊ - _requestor?: Element220␊ - location?: Reference26␊ - /**␊ - * The policy or plan that authorized the activity being recorded. Typically, a single activity may have multiple applicable policies, such as patient consent, guarantor funding, etc. The policy would also indicate the security token used.␊ - */␊ - policy?: Uri[]␊ - /**␊ - * Extensions for policy␊ - */␊ - _policy?: Element23[]␊ - media?: Coding4␊ - network?: AuditEvent_Network␊ - /**␊ - * The reason (purpose of use), specific to this agent, that was used during the event being recorded.␊ - */␊ - purposeOfUse?: CodeableConcept5[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept28 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference25 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element218 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element219 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element220 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference26 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - export interface Coding4 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The identification of the code system that defines the meaning of the symbol in the code.␊ - */␊ - system?: string␊ - _system?: Element39␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element40␊ - /**␊ - * A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).␊ - */␊ - code?: string␊ - _code?: Element41␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element42␊ - /**␊ - * Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).␊ - */␊ - userSelected?: boolean␊ - _userSelected?: Element43␊ - }␊ - /**␊ - * Logical network location for application activity, if the activity has a network location.␊ - */␊ - export interface AuditEvent_Network {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - address?: string␊ - _address?: Element221␊ - /**␊ - * An identifier for the type of network access point that originated the audit event.␊ - */␊ - type?: ("1" | "2" | "3" | "4" | "5")␊ - _type?: Element222␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element221 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element222 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The system that is reporting the event.␊ - */␊ - export interface AuditEvent_Source {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - site?: string␊ - _site?: Element223␊ - observer: Reference27␊ - /**␊ - * Code specifying the type of source where event originated.␊ - */␊ - type?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element223 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference27 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.␊ - */␊ - export interface AuditEvent_Entity {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - what?: Reference28␊ - type?: Coding5␊ - role?: Coding6␊ - lifecycle?: Coding7␊ - /**␊ - * Security labels for the identified entity.␊ - */␊ - securityLabel?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element224␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element225␊ - /**␊ - * The query parameters for a query-type entities.␊ - */␊ - query?: string␊ - _query?: Element226␊ - /**␊ - * Tagged value pairs for conveying additional information about the entity.␊ - */␊ - detail?: AuditEvent_Detail[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference28 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - export interface Coding5 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The identification of the code system that defines the meaning of the symbol in the code.␊ - */␊ - system?: string␊ - _system?: Element39␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element40␊ - /**␊ - * A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).␊ - */␊ - code?: string␊ - _code?: Element41␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element42␊ - /**␊ - * Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).␊ - */␊ - userSelected?: boolean␊ - _userSelected?: Element43␊ - }␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - export interface Coding6 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The identification of the code system that defines the meaning of the symbol in the code.␊ - */␊ - system?: string␊ - _system?: Element39␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element40␊ - /**␊ - * A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).␊ - */␊ - code?: string␊ - _code?: Element41␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element42␊ - /**␊ - * Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).␊ - */␊ - userSelected?: boolean␊ - _userSelected?: Element43␊ - }␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - export interface Coding7 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The identification of the code system that defines the meaning of the symbol in the code.␊ - */␊ - system?: string␊ - _system?: Element39␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element40␊ - /**␊ - * A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).␊ - */␊ - code?: string␊ - _code?: Element41␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element42␊ - /**␊ - * Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).␊ - */␊ - userSelected?: boolean␊ - _userSelected?: Element43␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element224 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element225 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element226 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.␊ - */␊ - export interface AuditEvent_Detail {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - type?: string␊ - _type?: Element227␊ - /**␊ - * The value of the extra detail.␊ - */␊ - valueString?: string␊ - _valueString?: Element228␊ - /**␊ - * The value of the extra detail.␊ - */␊ - valueBase64Binary?: string␊ - _valueBase64Binary?: Element229␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element227 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element228 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element229 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Basic is used for handling concepts not yet defined in FHIR, narrative-only resources that don't map to an existing resource, and custom resources not appropriate for inclusion in the FHIR specification.␊ - */␊ - export interface Basic {␊ - /**␊ - * This is a Basic resource␊ - */␊ - resourceType: "Basic"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta8␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element230␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element231␊ - text?: Narrative7␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifier assigned to the resource for business purposes, outside the context of FHIR.␊ - */␊ - identifier?: Identifier2[]␊ - code: CodeableConcept29␊ - subject?: Reference29␊ - /**␊ - * Identifies when the resource was first created.␊ - */␊ - created?: string␊ - _created?: Element232␊ - author?: Reference30␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta8 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element230 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element231 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative7 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept29 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference29 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element232 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference30 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A resource that represents the data of a single raw artifact as digital content accessible in its native format. A Binary resource can contain any content, whether text, image, pdf, zip archive, etc.␊ - */␊ - export interface Binary {␊ - /**␊ - * This is a Binary resource␊ - */␊ - resourceType: "Binary"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta9␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element233␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element234␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - contentType?: string␊ - _contentType?: Element235␊ - securityContext?: Reference31␊ - /**␊ - * The actual content, base64 encoded.␊ - */␊ - data?: string␊ - _data?: Element236␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta9 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element233 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element234 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element235 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference31 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element236 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A material substance originating from a biological entity intended to be transplanted or infused␊ - * into another (possibly the same) biological entity.␊ - */␊ - export interface BiologicallyDerivedProduct {␊ - /**␊ - * This is a BiologicallyDerivedProduct resource␊ - */␊ - resourceType: "BiologicallyDerivedProduct"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta10␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element237␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element238␊ - text?: Narrative8␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * This records identifiers associated with this biologically derived product instance that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * Broad category of this product.␊ - */␊ - productCategory?: ("organ" | "tissue" | "fluid" | "cells" | "biologicalAgent")␊ - _productCategory?: Element239␊ - productCode?: CodeableConcept30␊ - /**␊ - * Whether the product is currently available.␊ - */␊ - status?: ("available" | "unavailable")␊ - _status?: Element240␊ - /**␊ - * Procedure request to obtain this biologically derived product.␊ - */␊ - request?: Reference11[]␊ - /**␊ - * Number of discrete units within this product.␊ - */␊ - quantity?: number␊ - _quantity?: Element241␊ - /**␊ - * Parent product (if any).␊ - */␊ - parent?: Reference11[]␊ - collection?: BiologicallyDerivedProduct_Collection␊ - /**␊ - * Any processing of the product during collection that does not change the fundamental nature of the product. For example adding anti-coagulants during the collection of Peripheral Blood Stem Cells.␊ - */␊ - processing?: BiologicallyDerivedProduct_Processing[]␊ - manipulation?: BiologicallyDerivedProduct_Manipulation␊ - /**␊ - * Product storage.␊ - */␊ - storage?: BiologicallyDerivedProduct_Storage[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta10 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element237 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element238 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative8 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element239 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept30 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element240 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element241 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * How this product was collected.␊ - */␊ - export interface BiologicallyDerivedProduct_Collection {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - collector?: Reference32␊ - source?: Reference33␊ - /**␊ - * Time of product collection.␊ - */␊ - collectedDateTime?: string␊ - _collectedDateTime?: Element242␊ - collectedPeriod?: Period13␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference32 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference33 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element242 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period13 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * A material substance originating from a biological entity intended to be transplanted or infused␊ - * into another (possibly the same) biological entity.␊ - */␊ - export interface BiologicallyDerivedProduct_Processing {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element243␊ - procedure?: CodeableConcept31␊ - additive?: Reference34␊ - /**␊ - * Time of processing.␊ - */␊ - timeDateTime?: string␊ - _timeDateTime?: Element244␊ - timePeriod?: Period14␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element243 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept31 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference34 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element244 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period14 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Any manipulation of product post-collection that is intended to alter the product. For example a buffy-coat enrichment or CD8 reduction of Peripheral Blood Stem Cells to make it more suitable for infusion.␊ - */␊ - export interface BiologicallyDerivedProduct_Manipulation {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element245␊ - /**␊ - * Time of manipulation.␊ - */␊ - timeDateTime?: string␊ - _timeDateTime?: Element246␊ - timePeriod?: Period15␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element245 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element246 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period15 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * A material substance originating from a biological entity intended to be transplanted or infused␊ - * into another (possibly the same) biological entity.␊ - */␊ - export interface BiologicallyDerivedProduct_Storage {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element247␊ - /**␊ - * Storage temperature.␊ - */␊ - temperature?: number␊ - _temperature?: Element248␊ - /**␊ - * Temperature scale used.␊ - */␊ - scale?: ("farenheit" | "celsius" | "kelvin")␊ - _scale?: Element249␊ - duration?: Period16␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element247 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element248 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element249 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period16 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Record details about an anatomical structure. This resource may be used when a coded concept does not provide the necessary detail needed for the use case.␊ - */␊ - export interface BodyStructure {␊ - /**␊ - * This is a BodyStructure resource␊ - */␊ - resourceType: "BodyStructure"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta11␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element250␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element251␊ - text?: Narrative9␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifier for this instance of the anatomical structure.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * Whether this body site is in active use.␊ - */␊ - active?: boolean␊ - _active?: Element252␊ - morphology?: CodeableConcept32␊ - location?: CodeableConcept33␊ - /**␊ - * Qualifier to refine the anatomical location. These include qualifiers for laterality, relative location, directionality, number, and plane.␊ - */␊ - locationQualifier?: CodeableConcept5[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element253␊ - /**␊ - * Image or images used to identify a location.␊ - */␊ - image?: Attachment2[]␊ - patient: Reference35␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta11 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element250 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element251 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative9 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element252 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept32 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept33 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element253 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * For referring to data content defined in other formats.␊ - */␊ - export interface Attachment2 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.␊ - */␊ - contentType?: string␊ - _contentType?: Element51␊ - /**␊ - * The human language of the content. The value can be any valid value according to BCP 47.␊ - */␊ - language?: string␊ - _language?: Element52␊ - /**␊ - * The actual data of the attachment - a sequence of bytes, base64 encoded.␊ - */␊ - data?: string␊ - _data?: Element53␊ - /**␊ - * A location where the data can be accessed.␊ - */␊ - url?: string␊ - _url?: Element54␊ - /**␊ - * The number of bytes of data that make up this attachment (before base64 encoding, if that is done).␊ - */␊ - size?: number␊ - _size?: Element55␊ - /**␊ - * The calculated hash of the data using SHA-1. Represented using base64.␊ - */␊ - hash?: string␊ - _hash?: Element56␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element57␊ - /**␊ - * The date that the attachment was first created.␊ - */␊ - creation?: string␊ - _creation?: Element58␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference35 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A container for a collection of resources.␊ - */␊ - export interface Bundle {␊ - /**␊ - * This is a Bundle resource␊ - */␊ - resourceType: "Bundle"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta12␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element254␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element255␊ - identifier?: Identifier4␊ - /**␊ - * Indicates the purpose of this bundle - how it is intended to be used.␊ - */␊ - type?: ("document" | "message" | "transaction" | "transaction-response" | "batch" | "batch-response" | "history" | "searchset" | "collection")␊ - _type?: Element256␊ - /**␊ - * The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.␊ - */␊ - timestamp?: string␊ - _timestamp?: Element257␊ - /**␊ - * If a set of search matches, this is the total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle.␊ - */␊ - total?: number␊ - _total?: Element258␊ - /**␊ - * A series of links that provide context to this bundle.␊ - */␊ - link?: Bundle_Link[]␊ - /**␊ - * An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).␊ - */␊ - entry?: Bundle_Entry[]␊ - signature?: Signature13␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta12 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element254 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element255 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier4 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element256 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element257 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element258 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A container for a collection of resources.␊ - */␊ - export interface Bundle_Link {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - relation?: string␊ - _relation?: Element259␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - url?: string␊ - _url?: Element260␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element259 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element260 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A container for a collection of resources.␊ - */␊ - export interface Bundle_Entry {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A series of links that provide context to this entry.␊ - */␊ - link?: Bundle_Link[]␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - fullUrl?: string␊ - _fullUrl?: Element261␊ - /**␊ - * The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.␊ - */␊ - resource?: (Account | ActivityDefinition | AdverseEvent | AllergyIntolerance | Appointment | AppointmentResponse | AuditEvent | Basic | Binary | BiologicallyDerivedProduct | BodyStructure | Bundle | CapabilityStatement | CarePlan | CareTeam | CatalogEntry | ChargeItem | ChargeItemDefinition | Claim | ClaimResponse | ClinicalImpression | CodeSystem | Communication | CommunicationRequest | CompartmentDefinition | Composition | ConceptMap | Condition | Consent | Contract | Coverage | CoverageEligibilityRequest | CoverageEligibilityResponse | DetectedIssue | Device | DeviceDefinition | DeviceMetric | DeviceRequest | DeviceUseStatement | DiagnosticReport | DocumentManifest | DocumentReference | EffectEvidenceSynthesis | Encounter | Endpoint | EnrollmentRequest | EnrollmentResponse | EpisodeOfCare | EventDefinition | Evidence | EvidenceVariable | ExampleScenario | ExplanationOfBenefit | FamilyMemberHistory | Flag | Goal | GraphDefinition | Group | GuidanceResponse | HealthcareService | ImagingStudy | Immunization | ImmunizationEvaluation | ImmunizationRecommendation | ImplementationGuide | InsurancePlan | Invoice | Library | Linkage | List | Location | Measure | MeasureReport | Media | Medication | MedicationAdministration | MedicationDispense | MedicationKnowledge | MedicationRequest | MedicationStatement | MedicinalProduct | MedicinalProductAuthorization | MedicinalProductContraindication | MedicinalProductIndication | MedicinalProductIngredient | MedicinalProductInteraction | MedicinalProductManufactured | MedicinalProductPackaged | MedicinalProductPharmaceutical | MedicinalProductUndesirableEffect | MessageDefinition | MessageHeader | MolecularSequence | NamingSystem | NutritionOrder | Observation | ObservationDefinition | OperationDefinition | OperationOutcome | Organization | OrganizationAffiliation | Parameters | Patient | PaymentNotice | PaymentReconciliation | Person | PlanDefinition | Practitioner | PractitionerRole | Procedure | Provenance | Questionnaire | QuestionnaireResponse | RelatedPerson | RequestGroup | ResearchDefinition | ResearchElementDefinition | ResearchStudy | ResearchSubject | RiskAssessment | RiskEvidenceSynthesis | Schedule | SearchParameter | ServiceRequest | Slot | Specimen | SpecimenDefinition | StructureDefinition | StructureMap | Subscription | Substance | SubstanceNucleicAcid | SubstancePolymer | SubstanceProtein | SubstanceReferenceInformation | SubstanceSourceMaterial | SubstanceSpecification | SupplyDelivery | SupplyRequest | Task | TerminologyCapabilities | TestReport | TestScript | ValueSet | VerificationResult | VisionPrescription)␊ - search?: Bundle_Search␊ - request?: Bundle_Request␊ - response?: Bundle_Response␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element261 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.␊ - */␊ - export interface CapabilityStatement {␊ - /**␊ - * This is a CapabilityStatement resource␊ - */␊ - resourceType: "CapabilityStatement"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta13␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element262␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element263␊ - text?: Narrative10␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - url?: string␊ - _url?: Element264␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element265␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element266␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element267␊ - /**␊ - * The status of this capability statement. Enables tracking the life-cycle of the content.␊ - */␊ - status?: ("draft" | "active" | "retired" | "unknown")␊ - _status?: Element268␊ - /**␊ - * A Boolean value to indicate that this capability statement is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.␊ - */␊ - experimental?: boolean␊ - _experimental?: Element269␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - date?: string␊ - _date?: Element270␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - publisher?: string␊ - _publisher?: Element271␊ - /**␊ - * Contact details to assist a user in finding and communicating with the publisher.␊ - */␊ - contact?: ContactDetail1[]␊ - /**␊ - * A free text natural language description of the capability statement from a consumer's perspective. Typically, this is used when the capability statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP.␊ - */␊ - description?: string␊ - _description?: Element272␊ - /**␊ - * The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate capability statement instances.␊ - */␊ - useContext?: UsageContext1[]␊ - /**␊ - * A legal or geographic region in which the capability statement is intended to be used.␊ - */␊ - jurisdiction?: CodeableConcept5[]␊ - /**␊ - * Explanation of why this capability statement is needed and why it has been designed as it has.␊ - */␊ - purpose?: string␊ - _purpose?: Element273␊ - /**␊ - * A copyright statement relating to the capability statement and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the capability statement.␊ - */␊ - copyright?: string␊ - _copyright?: Element274␊ - /**␊ - * The way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind, not instance of software) or a class of implementation (e.g. a desired purchase).␊ - */␊ - kind?: ("instance" | "capability" | "requirements")␊ - _kind?: Element275␊ - /**␊ - * Reference to a canonical URL of another CapabilityStatement that this software implements. This capability statement is a published API description that corresponds to a business service. The server may actually implement a subset of the capability statement it claims to implement, so the capability statement must specify the full capability details.␊ - */␊ - instantiates?: Canonical[]␊ - /**␊ - * Reference to a canonical URL of another CapabilityStatement that this software adds to. The capability statement automatically includes everything in the other statement, and it is not duplicated, though the server may repeat the same resources, interactions and operations to add additional details to them.␊ - */␊ - imports?: Canonical[]␊ - software?: CapabilityStatement_Software␊ - implementation?: CapabilityStatement_Implementation␊ - /**␊ - * The version of the FHIR specification that this CapabilityStatement describes (which SHALL be the same as the FHIR version of the CapabilityStatement itself). There is no default value.␊ - */␊ - fhirVersion?: ("0.01" | "0.05" | "0.06" | "0.11" | "0.0.80" | "0.0.81" | "0.0.82" | "0.4.0" | "0.5.0" | "1.0.0" | "1.0.1" | "1.0.2" | "1.1.0" | "1.4.0" | "1.6.0" | "1.8.0" | "3.0.0" | "3.0.1" | "3.3.0" | "3.5.0" | "4.0.0" | "4.0.1")␊ - _fhirVersion?: Element281␊ - /**␊ - * A list of the formats supported by this implementation using their content types.␊ - */␊ - format?: Code[]␊ - /**␊ - * Extensions for format␊ - */␊ - _format?: Element23[]␊ - /**␊ - * A list of the patch formats supported by this implementation using their content types.␊ - */␊ - patchFormat?: Code[]␊ - /**␊ - * Extensions for patchFormat␊ - */␊ - _patchFormat?: Element23[]␊ - /**␊ - * A list of implementation guides that the server does (or should) support in their entirety.␊ - */␊ - implementationGuide?: Canonical[]␊ - /**␊ - * A definition of the restful capabilities of the solution, if any.␊ - */␊ - rest?: CapabilityStatement_Rest[]␊ - /**␊ - * A description of the messaging capabilities of the solution.␊ - */␊ - messaging?: CapabilityStatement_Messaging[]␊ - /**␊ - * A document definition.␊ - */␊ - document?: CapabilityStatement_Document[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta13 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element262 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element263 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative10 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element264 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element265 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element266 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element267 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element268 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element269 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element270 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element271 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element272 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element273 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element274 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element275 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Software that is covered by this capability statement. It is used when the capability statement describes the capabilities of a particular software version, independent of an installation.␊ - */␊ - export interface CapabilityStatement_Software {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element276␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element277␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - releaseDate?: string␊ - _releaseDate?: Element278␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element276 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element277 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element278 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Identifies a specific implementation instance that is described by the capability statement - i.e. a particular installation, rather than the capabilities of a software program.␊ - */␊ - export interface CapabilityStatement_Implementation {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element279␊ - /**␊ - * An absolute base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces.␊ - */␊ - url?: string␊ - _url?: Element280␊ - custodian?: Reference36␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element279 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element280 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference36 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element281 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.␊ - */␊ - export interface CapabilityStatement_Rest {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifies whether this portion of the statement is describing the ability to initiate or receive restful operations.␊ - */␊ - mode?: ("client" | "server")␊ - _mode?: Element282␊ - /**␊ - * Information about the system's restful capabilities that apply across all applications, such as security.␊ - */␊ - documentation?: string␊ - _documentation?: Element283␊ - security?: CapabilityStatement_Security␊ - /**␊ - * A specification of the restful capabilities of the solution for a specific resource type.␊ - */␊ - resource?: CapabilityStatement_Resource[]␊ - /**␊ - * A specification of restful operations supported by the system.␊ - */␊ - interaction?: CapabilityStatement_Interaction1[]␊ - /**␊ - * Search parameters that are supported for searching all resources for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation.␊ - */␊ - searchParam?: CapabilityStatement_SearchParam[]␊ - /**␊ - * Definition of an operation or a named query together with its parameters and their meaning and type.␊ - */␊ - operation?: CapabilityStatement_Operation[]␊ - /**␊ - * An absolute URI which is a reference to the definition of a compartment that the system supports. The reference is to a CompartmentDefinition resource by its canonical URL .␊ - */␊ - compartment?: Canonical[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element282 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element283 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Information about security implementation from an interface perspective - what a client needs to know.␊ - */␊ - export interface CapabilityStatement_Security {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Server adds CORS headers when responding to requests - this enables Javascript applications to use the server.␊ - */␊ - cors?: boolean␊ - _cors?: Element284␊ - /**␊ - * Types of security services that are supported/required by the system.␊ - */␊ - service?: CodeableConcept5[]␊ - /**␊ - * General description of how security works.␊ - */␊ - description?: string␊ - _description?: Element285␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element284 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element285 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.␊ - */␊ - export interface CapabilityStatement_Resource {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - type?: string␊ - _type?: Element286␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - profile?: string␊ - /**␊ - * A list of profiles that represent different use cases supported by the system. For a server, "supported by the system" means the system hosts/produces a set of resources that are conformant to a particular profile, and allows clients that use its services to search using this profile and to find appropriate data. For a client, it means the system will search by this profile and process data according to the guidance implicit in the profile. See further discussion in [Using Profiles](profiling.html#profile-uses).␊ - */␊ - supportedProfile?: Canonical[]␊ - /**␊ - * Additional information about the resource type used by the system.␊ - */␊ - documentation?: string␊ - _documentation?: Element287␊ - /**␊ - * Identifies a restful operation supported by the solution.␊ - */␊ - interaction?: CapabilityStatement_Interaction[]␊ - /**␊ - * This field is set to no-version to specify that the system does not support (server) or use (client) versioning for this resource type. If this has some other value, the server must at least correctly track and populate the versionId meta-property on resources. If the value is 'versioned-update', then the server supports all the versioning features, including using e-tags for version integrity in the API.␊ - */␊ - versioning?: ("no-version" | "versioned" | "versioned-update")␊ - _versioning?: Element290␊ - /**␊ - * A flag for whether the server is able to return past versions as part of the vRead operation.␊ - */␊ - readHistory?: boolean␊ - _readHistory?: Element291␊ - /**␊ - * A flag to indicate that the server allows or needs to allow the client to create new identities on the server (that is, the client PUTs to a location where there is no existing resource). Allowing this operation means that the server allows the client to create new identities on the server.␊ - */␊ - updateCreate?: boolean␊ - _updateCreate?: Element292␊ - /**␊ - * A flag that indicates that the server supports conditional create.␊ - */␊ - conditionalCreate?: boolean␊ - _conditionalCreate?: Element293␊ - /**␊ - * A code that indicates how the server supports conditional read.␊ - */␊ - conditionalRead?: ("not-supported" | "modified-since" | "not-match" | "full-support")␊ - _conditionalRead?: Element294␊ - /**␊ - * A flag that indicates that the server supports conditional update.␊ - */␊ - conditionalUpdate?: boolean␊ - _conditionalUpdate?: Element295␊ - /**␊ - * A code that indicates how the server supports conditional delete.␊ - */␊ - conditionalDelete?: ("not-supported" | "single" | "multiple")␊ - _conditionalDelete?: Element296␊ - /**␊ - * A set of flags that defines how references are supported.␊ - */␊ - referencePolicy?: ("literal" | "logical" | "resolves" | "enforced" | "local")[]␊ - /**␊ - * Extensions for referencePolicy␊ - */␊ - _referencePolicy?: Element23[]␊ - /**␊ - * A list of _include values supported by the server.␊ - */␊ - searchInclude?: String[]␊ - /**␊ - * Extensions for searchInclude␊ - */␊ - _searchInclude?: Element23[]␊ - /**␊ - * A list of _revinclude (reverse include) values supported by the server.␊ - */␊ - searchRevInclude?: String[]␊ - /**␊ - * Extensions for searchRevInclude␊ - */␊ - _searchRevInclude?: Element23[]␊ - /**␊ - * Search parameters for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation.␊ - */␊ - searchParam?: CapabilityStatement_SearchParam[]␊ - /**␊ - * Definition of an operation or a named query together with its parameters and their meaning and type. Consult the definition of the operation for details about how to invoke the operation, and the parameters.␊ - */␊ - operation?: CapabilityStatement_Operation[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element286 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element287 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.␊ - */␊ - export interface CapabilityStatement_Interaction {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Coded identifier of the operation, supported by the system resource.␊ - */␊ - code?: ("read" | "vread" | "update" | "patch" | "delete" | "history-instance" | "history-type" | "create" | "search-type")␊ - _code?: Element288␊ - /**␊ - * Guidance specific to the implementation of this operation, such as 'delete is a logical delete' or 'updates are only allowed with version id' or 'creates permitted from pre-authorized certificates only'.␊ - */␊ - documentation?: string␊ - _documentation?: Element289␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element288 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element289 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element290 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element291 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element292 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element293 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element294 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element295 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element296 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.␊ - */␊ - export interface CapabilityStatement_SearchParam {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element297␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - definition?: string␊ - /**␊ - * The type of value a search parameter refers to, and how the content is interpreted.␊ - */␊ - type?: ("number" | "date" | "string" | "token" | "reference" | "composite" | "quantity" | "uri" | "special")␊ - _type?: Element298␊ - /**␊ - * This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms.␊ - */␊ - documentation?: string␊ - _documentation?: Element299␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element297 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element298 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element299 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.␊ - */␊ - export interface CapabilityStatement_Operation {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element300␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - definition: string␊ - /**␊ - * Documentation that describes anything special about the operation behavior, possibly detailing different behavior for system, type and instance-level invocation of the operation.␊ - */␊ - documentation?: string␊ - _documentation?: Element301␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element300 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element301 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.␊ - */␊ - export interface CapabilityStatement_Interaction1 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A coded identifier of the operation, supported by the system.␊ - */␊ - code?: ("transaction" | "batch" | "search-system" | "history-system")␊ - _code?: Element302␊ - /**␊ - * Guidance specific to the implementation of this operation, such as limitations on the kind of transactions allowed, or information about system wide search is implemented.␊ - */␊ - documentation?: string␊ - _documentation?: Element303␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element302 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element303 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.␊ - */␊ - export interface CapabilityStatement_Messaging {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * An endpoint (network accessible address) to which messages and/or replies are to be sent.␊ - */␊ - endpoint?: CapabilityStatement_Endpoint[]␊ - /**␊ - * Length if the receiver's reliable messaging cache in minutes (if a receiver) or how long the cache length on the receiver should be (if a sender).␊ - */␊ - reliableCache?: number␊ - _reliableCache?: Element305␊ - /**␊ - * Documentation about the system's messaging capabilities for this endpoint not otherwise documented by the capability statement. For example, the process for becoming an authorized messaging exchange partner.␊ - */␊ - documentation?: string␊ - _documentation?: Element306␊ - /**␊ - * References to message definitions for messages this system can send or receive.␊ - */␊ - supportedMessage?: CapabilityStatement_SupportedMessage[]␊ - }␊ - /**␊ - * A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.␊ - */␊ - export interface CapabilityStatement_Endpoint {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - protocol: Coding8␊ - /**␊ - * The network address of the endpoint. For solutions that do not use network addresses for routing, it can be just an identifier.␊ - */␊ - address?: string␊ - _address?: Element304␊ - }␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - export interface Coding8 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The identification of the code system that defines the meaning of the symbol in the code.␊ - */␊ - system?: string␊ - _system?: Element39␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element40␊ - /**␊ - * A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).␊ - */␊ - code?: string␊ - _code?: Element41␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element42␊ - /**␊ - * Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).␊ - */␊ - userSelected?: boolean␊ - _userSelected?: Element43␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element304 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element305 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element306 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.␊ - */␊ - export interface CapabilityStatement_SupportedMessage {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * The mode of this event declaration - whether application is sender or receiver.␊ - */␊ - mode?: ("sender" | "receiver")␊ - _mode?: Element307␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - definition: string␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element307 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.␊ - */␊ - export interface CapabilityStatement_Document {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Mode of this document declaration - whether an application is a producer or consumer.␊ - */␊ - mode?: ("producer" | "consumer")␊ - _mode?: Element308␊ - /**␊ - * A description of how the application supports or uses the specified document profile. For example, when documents are created, what action is taken with consumed documents, etc.␊ - */␊ - documentation?: string␊ - _documentation?: Element309␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - profile: string␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element308 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element309 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.␊ - */␊ - export interface CarePlan {␊ - /**␊ - * This is a CarePlan resource␊ - */␊ - resourceType: "CarePlan"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta14␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element310␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element311␊ - text?: Narrative11␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Business identifiers assigned to this care plan by the performer or other systems which remain constant as the resource is updated and propagates from server to server.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.␊ - */␊ - instantiatesCanonical?: Canonical[]␊ - /**␊ - * The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.␊ - */␊ - instantiatesUri?: Uri[]␊ - /**␊ - * Extensions for instantiatesUri␊ - */␊ - _instantiatesUri?: Element23[]␊ - /**␊ - * A care plan that is fulfilled in whole or in part by this care plan.␊ - */␊ - basedOn?: Reference11[]␊ - /**␊ - * Completed or terminated care plan whose function is taken by this new care plan.␊ - */␊ - replaces?: Reference11[]␊ - /**␊ - * A larger care plan of which this particular care plan is a component or step.␊ - */␊ - partOf?: Reference11[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - status?: string␊ - _status?: Element312␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - intent?: string␊ - _intent?: Element313␊ - /**␊ - * Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", "wellness plan", etc.␊ - */␊ - category?: CodeableConcept5[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element314␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element315␊ - subject: Reference37␊ - encounter?: Reference38␊ - period?: Period17␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - created?: string␊ - _created?: Element316␊ - author?: Reference39␊ - /**␊ - * Identifies the individual(s) or organization who provided the contents of the care plan.␊ - */␊ - contributor?: Reference11[]␊ - /**␊ - * Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.␊ - */␊ - careTeam?: Reference11[]␊ - /**␊ - * Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.␊ - */␊ - addresses?: Reference11[]␊ - /**␊ - * Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include comorbidities, recent procedures, limitations, recent assessments, etc.␊ - */␊ - supportingInfo?: Reference11[]␊ - /**␊ - * Describes the intended objective(s) of carrying out the care plan.␊ - */␊ - goal?: Reference11[]␊ - /**␊ - * Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc.␊ - */␊ - activity?: CarePlan_Activity[]␊ - /**␊ - * General notes about the care plan not covered elsewhere.␊ - */␊ - note?: Annotation1[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta14 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element310 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element311 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative11 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element312 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element313 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element314 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element315 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference37 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference38 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period17 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element316 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference39 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.␊ - */␊ - export interface CarePlan_Activity {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifies the outcome at the point when the status of the activity is assessed. For example, the outcome of an education activity could be patient understands (or not).␊ - */␊ - outcomeCodeableConcept?: CodeableConcept5[]␊ - /**␊ - * Details of the outcome or action resulting from the activity. The reference to an "event" resource, such as Procedure or Encounter or Observation, is the result/outcome of the activity itself. The activity can be conveyed using CarePlan.activity.detail OR using the CarePlan.activity.reference (a reference to a “request” resource).␊ - */␊ - outcomeReference?: Reference11[]␊ - /**␊ - * Notes about the adherence/status/progress of the activity.␊ - */␊ - progress?: Annotation1[]␊ - reference?: Reference40␊ - detail?: CarePlan_Detail␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference40 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A simple summary of a planned activity suitable for a general care plan system (e.g. form driven) that doesn't know about specific resources such as procedure etc.␊ - */␊ - export interface CarePlan_Detail {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - kind?: string␊ - _kind?: Element317␊ - /**␊ - * The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity.␊ - */␊ - instantiatesCanonical?: Canonical[]␊ - /**␊ - * The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity.␊ - */␊ - instantiatesUri?: Uri[]␊ - /**␊ - * Extensions for instantiatesUri␊ - */␊ - _instantiatesUri?: Element23[]␊ - code?: CodeableConcept34␊ - /**␊ - * Provides the rationale that drove the inclusion of this particular activity as part of the plan or the reason why the activity was prohibited.␊ - */␊ - reasonCode?: CodeableConcept5[]␊ - /**␊ - * Indicates another resource, such as the health condition(s), whose existence justifies this request and drove the inclusion of this particular activity as part of the plan.␊ - */␊ - reasonReference?: Reference11[]␊ - /**␊ - * Internal reference that identifies the goals that this activity is intended to contribute towards meeting.␊ - */␊ - goal?: Reference11[]␊ - /**␊ - * Identifies what progress is being made for the specific activity.␊ - */␊ - status?: ("not-started" | "scheduled" | "in-progress" | "on-hold" | "completed" | "cancelled" | "stopped" | "unknown" | "entered-in-error")␊ - _status?: Element318␊ - statusReason?: CodeableConcept35␊ - /**␊ - * If true, indicates that the described activity is one that must NOT be engaged in when following the plan. If false, or missing, indicates that the described activity is one that should be engaged in when following the plan.␊ - */␊ - doNotPerform?: boolean␊ - _doNotPerform?: Element319␊ - scheduledTiming?: Timing4␊ - scheduledPeriod?: Period18␊ - /**␊ - * The period, timing or frequency upon which the described activity is to occur.␊ - */␊ - scheduledString?: string␊ - _scheduledString?: Element320␊ - location?: Reference41␊ - /**␊ - * Identifies who's expected to be involved in the activity.␊ - */␊ - performer?: Reference11[]␊ - productCodeableConcept?: CodeableConcept36␊ - productReference?: Reference42␊ - dailyAmount?: Quantity12␊ - quantity?: Quantity13␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element321␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element317 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept34 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element318 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept35 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element319 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The period, timing or frequency upon which the described activity is to occur.␊ - */␊ - export interface Timing4 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifies specific times when the event occurs.␊ - */␊ - event?: DateTime[]␊ - /**␊ - * Extensions for event␊ - */␊ - _event?: Element23[]␊ - repeat?: Timing_Repeat␊ - code?: CodeableConcept2␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period18 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element320 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference41 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept36 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference42 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Identifies the quantity expected to be consumed in a given day.␊ - */␊ - export interface Quantity12 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * Identifies the quantity expected to be supplied, administered or consumed by the subject.␊ - */␊ - export interface Quantity13 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element321 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient.␊ - */␊ - export interface CareTeam {␊ - /**␊ - * This is a CareTeam resource␊ - */␊ - resourceType: "CareTeam"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta15␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element322␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element323␊ - text?: Narrative12␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Business identifiers assigned to this care team by the performer or other systems which remain constant as the resource is updated and propagates from server to server.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * Indicates the current state of the care team.␊ - */␊ - status?: ("proposed" | "active" | "suspended" | "inactive" | "entered-in-error")␊ - _status?: Element324␊ - /**␊ - * Identifies what kind of team. This is to support differentiation between multiple co-existing teams, such as care plan team, episode of care team, longitudinal care team.␊ - */␊ - category?: CodeableConcept5[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element325␊ - subject?: Reference43␊ - encounter?: Reference44␊ - period?: Period19␊ - /**␊ - * Identifies all people and organizations who are expected to be involved in the care team.␊ - */␊ - participant?: CareTeam_Participant[]␊ - /**␊ - * Describes why the care team exists.␊ - */␊ - reasonCode?: CodeableConcept5[]␊ - /**␊ - * Condition(s) that this care team addresses.␊ - */␊ - reasonReference?: Reference11[]␊ - /**␊ - * The organization responsible for the care team.␊ - */␊ - managingOrganization?: Reference11[]␊ - /**␊ - * A central contact detail for the care team (that applies to all members).␊ - */␊ - telecom?: ContactPoint1[]␊ - /**␊ - * Comments made about the CareTeam.␊ - */␊ - note?: Annotation1[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta15 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element322 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element323 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative12 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element324 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element325 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference43 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference44 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period19 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient.␊ - */␊ - export interface CareTeam_Participant {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Indicates specific responsibility of an individual within the care team, such as "Primary care physician", "Trained social worker counselor", "Caregiver", etc.␊ - */␊ - role?: CodeableConcept5[]␊ - member?: Reference45␊ - onBehalfOf?: Reference46␊ - period?: Period20␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference45 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference46 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period20 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Catalog entries are wrappers that contextualize items included in a catalog.␊ - */␊ - export interface CatalogEntry {␊ - /**␊ - * This is a CatalogEntry resource␊ - */␊ - resourceType: "CatalogEntry"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta16␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element326␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element327␊ - text?: Narrative13␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Used in supporting different identifiers for the same product, e.g. manufacturer code and retailer code.␊ - */␊ - identifier?: Identifier2[]␊ - type?: CodeableConcept37␊ - /**␊ - * Whether the entry represents an orderable item.␊ - */␊ - orderable?: boolean␊ - _orderable?: Element328␊ - referencedItem: Reference47␊ - /**␊ - * Used in supporting related concepts, e.g. NDC to RxNorm.␊ - */␊ - additionalIdentifier?: Identifier2[]␊ - /**␊ - * Classes of devices, or ATC for medication.␊ - */␊ - classification?: CodeableConcept5[]␊ - /**␊ - * Used to support catalog exchange even for unsupported products, e.g. getting list of medications even if not prescribable.␊ - */␊ - status?: ("draft" | "active" | "retired" | "unknown")␊ - _status?: Element329␊ - validityPeriod?: Period21␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - validTo?: string␊ - _validTo?: Element330␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element331␊ - /**␊ - * Used for examplefor Out of Formulary, or any specifics.␊ - */␊ - additionalCharacteristic?: CodeableConcept5[]␊ - /**␊ - * User for example for ATC classification, or.␊ - */␊ - additionalClassification?: CodeableConcept5[]␊ - /**␊ - * Used for example, to point to a substance, or to a device used to administer a medication.␊ - */␊ - relatedEntry?: CatalogEntry_RelatedEntry[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta16 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element326 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element327 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative13 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept37 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element328 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference47 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element329 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period21 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element330 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element331 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Catalog entries are wrappers that contextualize items included in a catalog.␊ - */␊ - export interface CatalogEntry_RelatedEntry {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * The type of relation to the related item: child, parent, packageContent, containerPackage, usedIn, uses, requires, etc.␊ - */␊ - relationtype?: ("triggers" | "is-replaced-by")␊ - _relationtype?: Element332␊ - item: Reference48␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element332 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference48 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * The resource ChargeItem describes the provision of healthcare provider products for a certain patient, therefore referring not only to the product, but containing in addition details of the provision, like date, time, amounts and participating organizations and persons. Main Usage of the ChargeItem is to enable the billing process and internal cost allocation.␊ - */␊ - export interface ChargeItem {␊ - /**␊ - * This is a ChargeItem resource␊ - */␊ - resourceType: "ChargeItem"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta17␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element333␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element334␊ - text?: Narrative14␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifiers assigned to this event performer or other systems.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * References the (external) source of pricing information, rules of application for the code this ChargeItem uses.␊ - */␊ - definitionUri?: Uri[]␊ - /**␊ - * Extensions for definitionUri␊ - */␊ - _definitionUri?: Element23[]␊ - /**␊ - * References the source of pricing information, rules of application for the code this ChargeItem uses.␊ - */␊ - definitionCanonical?: Canonical[]␊ - /**␊ - * The current state of the ChargeItem.␊ - */␊ - status?: ("planned" | "billable" | "not-billable" | "aborted" | "billed" | "entered-in-error" | "unknown")␊ - _status?: Element335␊ - /**␊ - * ChargeItems can be grouped to larger ChargeItems covering the whole set.␊ - */␊ - partOf?: Reference11[]␊ - code: CodeableConcept38␊ - subject: Reference49␊ - context?: Reference50␊ - /**␊ - * Date/time(s) or duration when the charged service was applied.␊ - */␊ - occurrenceDateTime?: string␊ - _occurrenceDateTime?: Element336␊ - occurrencePeriod?: Period22␊ - occurrenceTiming?: Timing5␊ - /**␊ - * Indicates who or what performed or participated in the charged service.␊ - */␊ - performer?: ChargeItem_Performer[]␊ - performingOrganization?: Reference52␊ - requestingOrganization?: Reference53␊ - costCenter?: Reference54␊ - quantity?: Quantity14␊ - /**␊ - * The anatomical location where the related service has been applied.␊ - */␊ - bodysite?: CodeableConcept5[]␊ - /**␊ - * Factor overriding the factor determined by the rules associated with the code.␊ - */␊ - factorOverride?: number␊ - _factorOverride?: Element337␊ - priceOverride?: Money1␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - overrideReason?: string␊ - _overrideReason?: Element338␊ - enterer?: Reference55␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - enteredDate?: string␊ - _enteredDate?: Element339␊ - /**␊ - * Describes why the event occurred in coded or textual form.␊ - */␊ - reason?: CodeableConcept5[]␊ - /**␊ - * Indicated the rendered service that caused this charge.␊ - */␊ - service?: Reference11[]␊ - productReference?: Reference56␊ - productCodeableConcept?: CodeableConcept40␊ - /**␊ - * Account into which this ChargeItems belongs.␊ - */␊ - account?: Reference11[]␊ - /**␊ - * Comments made about the event by the performer, subject or other participants.␊ - */␊ - note?: Annotation1[]␊ - /**␊ - * Further information supporting this charge.␊ - */␊ - supportingInformation?: Reference11[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta17 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element333 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element334 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative14 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element335 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept38 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference49 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference50 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element336 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period22 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Date/time(s) or duration when the charged service was applied.␊ - */␊ - export interface Timing5 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifies specific times when the event occurs.␊ - */␊ - event?: DateTime[]␊ - /**␊ - * Extensions for event␊ - */␊ - _event?: Element23[]␊ - repeat?: Timing_Repeat␊ - code?: CodeableConcept2␊ - }␊ - /**␊ - * The resource ChargeItem describes the provision of healthcare provider products for a certain patient, therefore referring not only to the product, but containing in addition details of the provision, like date, time, amounts and participating organizations and persons. Main Usage of the ChargeItem is to enable the billing process and internal cost allocation.␊ - */␊ - export interface ChargeItem_Performer {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - function?: CodeableConcept39␊ - actor: Reference51␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept39 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference51 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference52 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference53 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference54 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Quantity of which the charge item has been serviced.␊ - */␊ - export interface Quantity14 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element337 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Total price of the charge overriding the list price associated with the code.␊ - */␊ - export interface Money1 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element338 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference55 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element339 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference56 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept40 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * The ChargeItemDefinition resource provides the properties that apply to the (billing) codes necessary to calculate costs and prices. The properties may differ largely depending on type and realm, therefore this resource gives only a rough structure and requires profiling for each type of billing code system.␊ - */␊ - export interface ChargeItemDefinition {␊ - /**␊ - * This is a ChargeItemDefinition resource␊ - */␊ - resourceType: "ChargeItemDefinition"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta18␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element340␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element341␊ - text?: Narrative15␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - url?: string␊ - _url?: Element342␊ - /**␊ - * A formal identifier that is used to identify this charge item definition when it is represented in other formats, or referenced in a specification, model, design or an instance.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element343␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element344␊ - /**␊ - * The URL pointing to an externally-defined charge item definition that is adhered to in whole or in part by this definition.␊ - */␊ - derivedFromUri?: Uri[]␊ - /**␊ - * Extensions for derivedFromUri␊ - */␊ - _derivedFromUri?: Element23[]␊ - /**␊ - * A larger definition of which this particular definition is a component or step.␊ - */␊ - partOf?: Canonical[]␊ - /**␊ - * As new versions of a protocol or guideline are defined, allows identification of what versions are replaced by a new instance.␊ - */␊ - replaces?: Canonical[]␊ - /**␊ - * The current state of the ChargeItemDefinition.␊ - */␊ - status?: ("draft" | "active" | "retired" | "unknown")␊ - _status?: Element345␊ - /**␊ - * A Boolean value to indicate that this charge item definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.␊ - */␊ - experimental?: boolean␊ - _experimental?: Element346␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - date?: string␊ - _date?: Element347␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - publisher?: string␊ - _publisher?: Element348␊ - /**␊ - * Contact details to assist a user in finding and communicating with the publisher.␊ - */␊ - contact?: ContactDetail1[]␊ - /**␊ - * A free text natural language description of the charge item definition from a consumer's perspective.␊ - */␊ - description?: string␊ - _description?: Element349␊ - /**␊ - * The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate charge item definition instances.␊ - */␊ - useContext?: UsageContext1[]␊ - /**␊ - * A legal or geographic region in which the charge item definition is intended to be used.␊ - */␊ - jurisdiction?: CodeableConcept5[]␊ - /**␊ - * A copyright statement relating to the charge item definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the charge item definition.␊ - */␊ - copyright?: string␊ - _copyright?: Element350␊ - /**␊ - * The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.␊ - */␊ - approvalDate?: string␊ - _approvalDate?: Element351␊ - /**␊ - * The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.␊ - */␊ - lastReviewDate?: string␊ - _lastReviewDate?: Element352␊ - effectivePeriod?: Period23␊ - code?: CodeableConcept41␊ - /**␊ - * The defined billing details in this resource pertain to the given product instance(s).␊ - */␊ - instance?: Reference11[]␊ - /**␊ - * Expressions that describe applicability criteria for the billing code.␊ - */␊ - applicability?: ChargeItemDefinition_Applicability[]␊ - /**␊ - * Group of properties which are applicable under the same conditions. If no applicability rules are established for the group, then all properties always apply.␊ - */␊ - propertyGroup?: ChargeItemDefinition_PropertyGroup[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta18 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element340 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element341 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative15 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element342 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element343 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element344 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element345 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element346 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element347 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element348 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element349 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element350 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element351 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element352 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period23 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept41 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * The ChargeItemDefinition resource provides the properties that apply to the (billing) codes necessary to calculate costs and prices. The properties may differ largely depending on type and realm, therefore this resource gives only a rough structure and requires profiling for each type of billing code system.␊ - */␊ - export interface ChargeItemDefinition_Applicability {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element353␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - language?: string␊ - _language?: Element354␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - expression?: string␊ - _expression?: Element355␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element353 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element354 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element355 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The ChargeItemDefinition resource provides the properties that apply to the (billing) codes necessary to calculate costs and prices. The properties may differ largely depending on type and realm, therefore this resource gives only a rough structure and requires profiling for each type of billing code system.␊ - */␊ - export interface ChargeItemDefinition_PropertyGroup {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Expressions that describe applicability criteria for the priceComponent.␊ - */␊ - applicability?: ChargeItemDefinition_Applicability[]␊ - /**␊ - * The price for a ChargeItem may be calculated as a base price with surcharges/deductions that apply in certain conditions. A ChargeItemDefinition resource that defines the prices, factors and conditions that apply to a billing code is currently under development. The priceComponent element can be used to offer transparency to the recipient of the Invoice of how the prices have been calculated.␊ - */␊ - priceComponent?: ChargeItemDefinition_PriceComponent[]␊ - }␊ - /**␊ - * The ChargeItemDefinition resource provides the properties that apply to the (billing) codes necessary to calculate costs and prices. The properties may differ largely depending on type and realm, therefore this resource gives only a rough structure and requires profiling for each type of billing code system.␊ - */␊ - export interface ChargeItemDefinition_PriceComponent {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - type?: string␊ - _type?: Element356␊ - code?: CodeableConcept42␊ - /**␊ - * The factor that has been applied on the base price for calculating this component.␊ - */␊ - factor?: number␊ - _factor?: Element357␊ - amount?: Money2␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element356 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept42 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element357 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The amount calculated for this component.␊ - */␊ - export interface Money2 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement.␊ - */␊ - export interface Claim {␊ - /**␊ - * This is a Claim resource␊ - */␊ - resourceType: "Claim"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta19␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element358␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element359␊ - text?: Narrative16␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A unique identifier assigned to this claim.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - status?: string␊ - _status?: Element360␊ - type: CodeableConcept43␊ - subType?: CodeableConcept44␊ - /**␊ - * A code to indicate whether the nature of the request is: to request adjudication of products and services previously rendered; or requesting authorization and adjudication for provision in the future; or requesting the non-binding adjudication of the listed products and services which could be provided in the future.␊ - */␊ - use?: ("claim" | "preauthorization" | "predetermination")␊ - _use?: Element361␊ - patient: Reference57␊ - billablePeriod?: Period24␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - created?: string␊ - _created?: Element362␊ - enterer?: Reference58␊ - insurer?: Reference59␊ - provider: Reference60␊ - priority: CodeableConcept45␊ - fundsReserve?: CodeableConcept46␊ - /**␊ - * Other claims which are related to this claim such as prior submissions or claims for related services or for the same event.␊ - */␊ - related?: Claim_Related[]␊ - prescription?: Reference62␊ - originalPrescription?: Reference63␊ - payee?: Claim_Payee␊ - referral?: Reference65␊ - facility?: Reference66␊ - /**␊ - * The members of the team who provided the products and services.␊ - */␊ - careTeam?: Claim_CareTeam[]␊ - /**␊ - * Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.␊ - */␊ - supportingInfo?: Claim_SupportingInfo[]␊ - /**␊ - * Information about diagnoses relevant to the claim items.␊ - */␊ - diagnosis?: Claim_Diagnosis[]␊ - /**␊ - * Procedures performed on the patient relevant to the billing items with the claim.␊ - */␊ - procedure?: Claim_Procedure[]␊ - /**␊ - * Financial instruments for reimbursement for the health care products and services specified on the claim.␊ - */␊ - insurance: Claim_Insurance[]␊ - accident?: Claim_Accident␊ - /**␊ - * A claim line. Either a simple product or service or a 'group' of details which can each be a simple items or groups of sub-details.␊ - */␊ - item?: Claim_Item[]␊ - total?: Money9␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta19 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element358 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element359 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative16 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element360 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept43 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept44 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element361 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference57 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period24 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element362 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference58 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference59 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference60 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept45 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept46 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement.␊ - */␊ - export interface Claim_Related {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - claim?: Reference61␊ - relationship?: CodeableConcept47␊ - reference?: Identifier5␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference61 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept47 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier5 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference62 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference63 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * The party to be reimbursed for cost of the products and services according to the terms of the policy.␊ - */␊ - export interface Claim_Payee {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - type: CodeableConcept48␊ - party?: Reference64␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept48 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference64 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference65 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference66 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement.␊ - */␊ - export interface Claim_CareTeam {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A number to uniquely identify care team entries.␊ - */␊ - sequence?: number␊ - _sequence?: Element363␊ - provider: Reference67␊ - /**␊ - * The party who is billing and/or responsible for the claimed products or services.␊ - */␊ - responsible?: boolean␊ - _responsible?: Element364␊ - role?: CodeableConcept49␊ - qualification?: CodeableConcept50␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element363 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference67 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element364 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept49 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept50 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement.␊ - */␊ - export interface Claim_SupportingInfo {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A number to uniquely identify supporting information entries.␊ - */␊ - sequence?: number␊ - _sequence?: Element365␊ - category: CodeableConcept51␊ - code?: CodeableConcept52␊ - /**␊ - * The date when or period to which this information refers.␊ - */␊ - timingDate?: string␊ - _timingDate?: Element366␊ - timingPeriod?: Period25␊ - /**␊ - * Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.␊ - */␊ - valueBoolean?: boolean␊ - _valueBoolean?: Element367␊ - /**␊ - * Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.␊ - */␊ - valueString?: string␊ - _valueString?: Element368␊ - valueQuantity?: Quantity15␊ - valueAttachment?: Attachment3␊ - valueReference?: Reference68␊ - reason?: CodeableConcept53␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element365 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept51 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept52 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element366 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period25 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element367 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element368 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.␊ - */␊ - export interface Quantity15 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * For referring to data content defined in other formats.␊ - */␊ - export interface Attachment3 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.␊ - */␊ - contentType?: string␊ - _contentType?: Element51␊ - /**␊ - * The human language of the content. The value can be any valid value according to BCP 47.␊ - */␊ - language?: string␊ - _language?: Element52␊ - /**␊ - * The actual data of the attachment - a sequence of bytes, base64 encoded.␊ - */␊ - data?: string␊ - _data?: Element53␊ - /**␊ - * A location where the data can be accessed.␊ - */␊ - url?: string␊ - _url?: Element54␊ - /**␊ - * The number of bytes of data that make up this attachment (before base64 encoding, if that is done).␊ - */␊ - size?: number␊ - _size?: Element55␊ - /**␊ - * The calculated hash of the data using SHA-1. Represented using base64.␊ - */␊ - hash?: string␊ - _hash?: Element56␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element57␊ - /**␊ - * The date that the attachment was first created.␊ - */␊ - creation?: string␊ - _creation?: Element58␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference68 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept53 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement.␊ - */␊ - export interface Claim_Diagnosis {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A number to uniquely identify diagnosis entries.␊ - */␊ - sequence?: number␊ - _sequence?: Element369␊ - diagnosisCodeableConcept?: CodeableConcept54␊ - diagnosisReference?: Reference69␊ - /**␊ - * When the condition was observed or the relative ranking.␊ - */␊ - type?: CodeableConcept5[]␊ - onAdmission?: CodeableConcept55␊ - packageCode?: CodeableConcept56␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element369 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept54 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference69 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept55 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept56 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement.␊ - */␊ - export interface Claim_Procedure {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A number to uniquely identify procedure entries.␊ - */␊ - sequence?: number␊ - _sequence?: Element370␊ - /**␊ - * When the condition was observed or the relative ranking.␊ - */␊ - type?: CodeableConcept5[]␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - date?: string␊ - _date?: Element371␊ - procedureCodeableConcept?: CodeableConcept57␊ - procedureReference?: Reference70␊ - /**␊ - * Unique Device Identifiers associated with this line item.␊ - */␊ - udi?: Reference11[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element370 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element371 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept57 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference70 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement.␊ - */␊ - export interface Claim_Insurance {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A number to uniquely identify insurance entries and provide a sequence of coverages to convey coordination of benefit order.␊ - */␊ - sequence?: number␊ - _sequence?: Element372␊ - /**␊ - * A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true.␊ - */␊ - focal?: boolean␊ - _focal?: Element373␊ - identifier?: Identifier6␊ - coverage: Reference71␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - businessArrangement?: string␊ - _businessArrangement?: Element374␊ - /**␊ - * Reference numbers previously provided by the insurer to the provider to be quoted on subsequent claims containing services or products related to the prior authorization.␊ - */␊ - preAuthRef?: String[]␊ - /**␊ - * Extensions for preAuthRef␊ - */␊ - _preAuthRef?: Element23[]␊ - claimResponse?: Reference72␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element372 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element373 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier6 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference71 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element374 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference72 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Details of an accident which resulted in injuries which required the products and services listed in the claim.␊ - */␊ - export interface Claim_Accident {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Date of an accident event related to the products and services contained in the claim.␊ - */␊ - date?: string␊ - _date?: Element375␊ - type?: CodeableConcept58␊ - locationAddress?: Address1␊ - locationReference?: Reference73␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element375 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept58 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * The physical location of the accident event.␊ - */␊ - export interface Address1 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this address.␊ - */␊ - use?: ("home" | "work" | "temp" | "old" | "billing")␊ - _use?: Element20␊ - /**␊ - * Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.␊ - */␊ - type?: ("postal" | "physical" | "both")␊ - _type?: Element21␊ - /**␊ - * Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.␊ - */␊ - text?: string␊ - _text?: Element22␊ - /**␊ - * This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.␊ - */␊ - line?: String[]␊ - /**␊ - * Extensions for line␊ - */␊ - _line?: Element23[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - city?: string␊ - _city?: Element24␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - district?: string␊ - _district?: Element25␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - state?: string␊ - _state?: Element26␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - postalCode?: string␊ - _postalCode?: Element27␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - country?: string␊ - _country?: Element28␊ - period?: Period␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference73 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement.␊ - */␊ - export interface Claim_Item {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A number to uniquely identify item entries.␊ - */␊ - sequence?: number␊ - _sequence?: Element376␊ - /**␊ - * CareTeam members related to this service or product.␊ - */␊ - careTeamSequence?: PositiveInt[]␊ - /**␊ - * Extensions for careTeamSequence␊ - */␊ - _careTeamSequence?: Element23[]␊ - /**␊ - * Diagnosis applicable for this service or product.␊ - */␊ - diagnosisSequence?: PositiveInt[]␊ - /**␊ - * Extensions for diagnosisSequence␊ - */␊ - _diagnosisSequence?: Element23[]␊ - /**␊ - * Procedures applicable for this service or product.␊ - */␊ - procedureSequence?: PositiveInt[]␊ - /**␊ - * Extensions for procedureSequence␊ - */␊ - _procedureSequence?: Element23[]␊ - /**␊ - * Exceptions, special conditions and supporting information applicable for this service or product.␊ - */␊ - informationSequence?: PositiveInt[]␊ - /**␊ - * Extensions for informationSequence␊ - */␊ - _informationSequence?: Element23[]␊ - revenue?: CodeableConcept59␊ - category?: CodeableConcept60␊ - productOrService: CodeableConcept61␊ - /**␊ - * Item typification or modifiers codes to convey additional context for the product or service.␊ - */␊ - modifier?: CodeableConcept5[]␊ - /**␊ - * Identifies the program under which this may be recovered.␊ - */␊ - programCode?: CodeableConcept5[]␊ - /**␊ - * The date or dates when the service or product was supplied, performed or completed.␊ - */␊ - servicedDate?: string␊ - _servicedDate?: Element377␊ - servicedPeriod?: Period26␊ - locationCodeableConcept?: CodeableConcept62␊ - locationAddress?: Address2␊ - locationReference?: Reference74␊ - quantity?: Quantity16␊ - unitPrice?: Money3␊ - /**␊ - * A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.␊ - */␊ - factor?: number␊ - _factor?: Element378␊ - net?: Money4␊ - /**␊ - * Unique Device Identifiers associated with this line item.␊ - */␊ - udi?: Reference11[]␊ - bodySite?: CodeableConcept63␊ - /**␊ - * A region or surface of the bodySite, e.g. limb region or tooth surface(s).␊ - */␊ - subSite?: CodeableConcept5[]␊ - /**␊ - * The Encounters during which this Claim was created or to which the creation of this record is tightly associated.␊ - */␊ - encounter?: Reference11[]␊ - /**␊ - * A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.␊ - */␊ - detail?: Claim_Detail[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element376 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept59 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept60 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept61 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element377 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period26 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept62 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Where the product or service was provided.␊ - */␊ - export interface Address2 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this address.␊ - */␊ - use?: ("home" | "work" | "temp" | "old" | "billing")␊ - _use?: Element20␊ - /**␊ - * Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.␊ - */␊ - type?: ("postal" | "physical" | "both")␊ - _type?: Element21␊ - /**␊ - * Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.␊ - */␊ - text?: string␊ - _text?: Element22␊ - /**␊ - * This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.␊ - */␊ - line?: String[]␊ - /**␊ - * Extensions for line␊ - */␊ - _line?: Element23[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - city?: string␊ - _city?: Element24␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - district?: string␊ - _district?: Element25␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - state?: string␊ - _state?: Element26␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - postalCode?: string␊ - _postalCode?: Element27␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - country?: string␊ - _country?: Element28␊ - period?: Period␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference74 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * The number of repetitions of a service or product.␊ - */␊ - export interface Quantity16 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.␊ - */␊ - export interface Money3 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element378 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The quantity times the unit price for an additional service or product or charge.␊ - */␊ - export interface Money4 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept63 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement.␊ - */␊ - export interface Claim_Detail {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * An integer with a value that is positive (e.g. >0)␊ - */␊ - sequence?: number␊ - _sequence?: Element379␊ - revenue?: CodeableConcept64␊ - category?: CodeableConcept65␊ - productOrService: CodeableConcept66␊ - /**␊ - * Item typification or modifiers codes to convey additional context for the product or service.␊ - */␊ - modifier?: CodeableConcept5[]␊ - /**␊ - * Identifies the program under which this may be recovered.␊ - */␊ - programCode?: CodeableConcept5[]␊ - quantity?: Quantity17␊ - unitPrice?: Money5␊ - /**␊ - * A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.␊ - */␊ - factor?: number␊ - _factor?: Element380␊ - net?: Money6␊ - /**␊ - * Unique Device Identifiers associated with this line item.␊ - */␊ - udi?: Reference11[]␊ - /**␊ - * A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.␊ - */␊ - subDetail?: Claim_SubDetail[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element379 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept64 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept65 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept66 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * The number of repetitions of a service or product.␊ - */␊ - export interface Quantity17 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.␊ - */␊ - export interface Money5 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element380 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The quantity times the unit price for an additional service or product or charge.␊ - */␊ - export interface Money6 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement.␊ - */␊ - export interface Claim_SubDetail {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * An integer with a value that is positive (e.g. >0)␊ - */␊ - sequence?: number␊ - _sequence?: Element381␊ - revenue?: CodeableConcept67␊ - category?: CodeableConcept68␊ - productOrService: CodeableConcept69␊ - /**␊ - * Item typification or modifiers codes to convey additional context for the product or service.␊ - */␊ - modifier?: CodeableConcept5[]␊ - /**␊ - * Identifies the program under which this may be recovered.␊ - */␊ - programCode?: CodeableConcept5[]␊ - quantity?: Quantity18␊ - unitPrice?: Money7␊ - /**␊ - * A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.␊ - */␊ - factor?: number␊ - _factor?: Element382␊ - net?: Money8␊ - /**␊ - * Unique Device Identifiers associated with this line item.␊ - */␊ - udi?: Reference11[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element381 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept67 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept68 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept69 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * The number of repetitions of a service or product.␊ - */␊ - export interface Quantity18 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.␊ - */␊ - export interface Money7 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element382 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The quantity times the unit price for an additional service or product or charge.␊ - */␊ - export interface Money8 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * The total value of the all the items in the claim.␊ - */␊ - export interface Money9 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * This resource provides the adjudication details from the processing of a Claim resource.␊ - */␊ - export interface ClaimResponse {␊ - /**␊ - * This is a ClaimResponse resource␊ - */␊ - resourceType: "ClaimResponse"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta20␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element383␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element384␊ - text?: Narrative17␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A unique identifier assigned to this claim response.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - status?: string␊ - _status?: Element385␊ - type: CodeableConcept70␊ - subType?: CodeableConcept71␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - use?: string␊ - _use?: Element386␊ - patient: Reference75␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - created?: string␊ - _created?: Element387␊ - insurer: Reference76␊ - requestor?: Reference77␊ - request?: Reference78␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - outcome?: string␊ - _outcome?: Element388␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - disposition?: string␊ - _disposition?: Element389␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - preAuthRef?: string␊ - _preAuthRef?: Element390␊ - preAuthPeriod?: Period27␊ - payeeType?: CodeableConcept72␊ - /**␊ - * A claim line. Either a simple (a product or service) or a 'group' of details which can also be a simple items or groups of sub-details.␊ - */␊ - item?: ClaimResponse_Item[]␊ - /**␊ - * The first-tier service adjudications for payor added product or service lines.␊ - */␊ - addItem?: ClaimResponse_AddItem[]␊ - /**␊ - * The adjudication results which are presented at the header level rather than at the line-item or add-item levels.␊ - */␊ - adjudication?: ClaimResponse_Adjudication[]␊ - /**␊ - * Categorized monetary totals for the adjudication.␊ - */␊ - total?: ClaimResponse_Total[]␊ - payment?: ClaimResponse_Payment␊ - fundsReserve?: CodeableConcept83␊ - formCode?: CodeableConcept84␊ - form?: Attachment4␊ - /**␊ - * A note that describes or explains adjudication results in a human readable form.␊ - */␊ - processNote?: ClaimResponse_ProcessNote[]␊ - /**␊ - * Request for additional supporting or authorizing information.␊ - */␊ - communicationRequest?: Reference11[]␊ - /**␊ - * Financial instruments for reimbursement for the health care products and services specified on the claim.␊ - */␊ - insurance?: ClaimResponse_Insurance[]␊ - /**␊ - * Errors encountered during the processing of the adjudication.␊ - */␊ - error?: ClaimResponse_Error[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta20 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element383 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element384 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative17 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element385 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept70 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept71 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element386 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference75 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element387 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference76 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference77 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference78 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element388 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element389 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element390 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period27 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept72 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * This resource provides the adjudication details from the processing of a Claim resource.␊ - */␊ - export interface ClaimResponse_Item {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * An integer with a value that is positive (e.g. >0)␊ - */␊ - itemSequence?: number␊ - _itemSequence?: Element391␊ - /**␊ - * The numbers associated with notes below which apply to the adjudication of this item.␊ - */␊ - noteNumber?: PositiveInt[]␊ - /**␊ - * Extensions for noteNumber␊ - */␊ - _noteNumber?: Element23[]␊ - /**␊ - * If this item is a group then the values here are a summary of the adjudication of the detail items. If this item is a simple product or service then this is the result of the adjudication of this item.␊ - */␊ - adjudication: ClaimResponse_Adjudication[]␊ - /**␊ - * A claim detail. Either a simple (a product or service) or a 'group' of sub-details which are simple items.␊ - */␊ - detail?: ClaimResponse_Detail[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element391 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * This resource provides the adjudication details from the processing of a Claim resource.␊ - */␊ - export interface ClaimResponse_Adjudication {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - category: CodeableConcept73␊ - reason?: CodeableConcept74␊ - amount?: Money10␊ - /**␊ - * A non-monetary value associated with the category. Mutually exclusive to the amount element above.␊ - */␊ - value?: number␊ - _value?: Element392␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept73 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept74 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Monetary amount associated with the category.␊ - */␊ - export interface Money10 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element392 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * This resource provides the adjudication details from the processing of a Claim resource.␊ - */␊ - export interface ClaimResponse_Detail {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * An integer with a value that is positive (e.g. >0)␊ - */␊ - detailSequence?: number␊ - _detailSequence?: Element393␊ - /**␊ - * The numbers associated with notes below which apply to the adjudication of this item.␊ - */␊ - noteNumber?: PositiveInt[]␊ - /**␊ - * Extensions for noteNumber␊ - */␊ - _noteNumber?: Element23[]␊ - /**␊ - * The adjudication results.␊ - */␊ - adjudication: ClaimResponse_Adjudication[]␊ - /**␊ - * A sub-detail adjudication of a simple product or service.␊ - */␊ - subDetail?: ClaimResponse_SubDetail[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element393 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * This resource provides the adjudication details from the processing of a Claim resource.␊ - */␊ - export interface ClaimResponse_SubDetail {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * An integer with a value that is positive (e.g. >0)␊ - */␊ - subDetailSequence?: number␊ - _subDetailSequence?: Element394␊ - /**␊ - * The numbers associated with notes below which apply to the adjudication of this item.␊ - */␊ - noteNumber?: PositiveInt[]␊ - /**␊ - * Extensions for noteNumber␊ - */␊ - _noteNumber?: Element23[]␊ - /**␊ - * The adjudication results.␊ - */␊ - adjudication?: ClaimResponse_Adjudication[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element394 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * This resource provides the adjudication details from the processing of a Claim resource.␊ - */␊ - export interface ClaimResponse_AddItem {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Claim items which this service line is intended to replace.␊ - */␊ - itemSequence?: PositiveInt[]␊ - /**␊ - * Extensions for itemSequence␊ - */␊ - _itemSequence?: Element23[]␊ - /**␊ - * The sequence number of the details within the claim item which this line is intended to replace.␊ - */␊ - detailSequence?: PositiveInt[]␊ - /**␊ - * Extensions for detailSequence␊ - */␊ - _detailSequence?: Element23[]␊ - /**␊ - * The sequence number of the sub-details within the details within the claim item which this line is intended to replace.␊ - */␊ - subdetailSequence?: PositiveInt[]␊ - /**␊ - * Extensions for subdetailSequence␊ - */␊ - _subdetailSequence?: Element23[]␊ - /**␊ - * The providers who are authorized for the services rendered to the patient.␊ - */␊ - provider?: Reference11[]␊ - productOrService: CodeableConcept75␊ - /**␊ - * Item typification or modifiers codes to convey additional context for the product or service.␊ - */␊ - modifier?: CodeableConcept5[]␊ - /**␊ - * Identifies the program under which this may be recovered.␊ - */␊ - programCode?: CodeableConcept5[]␊ - /**␊ - * The date or dates when the service or product was supplied, performed or completed.␊ - */␊ - servicedDate?: string␊ - _servicedDate?: Element395␊ - servicedPeriod?: Period28␊ - locationCodeableConcept?: CodeableConcept76␊ - locationAddress?: Address3␊ - locationReference?: Reference79␊ - quantity?: Quantity19␊ - unitPrice?: Money11␊ - /**␊ - * A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.␊ - */␊ - factor?: number␊ - _factor?: Element396␊ - net?: Money12␊ - bodySite?: CodeableConcept77␊ - /**␊ - * A region or surface of the bodySite, e.g. limb region or tooth surface(s).␊ - */␊ - subSite?: CodeableConcept5[]␊ - /**␊ - * The numbers associated with notes below which apply to the adjudication of this item.␊ - */␊ - noteNumber?: PositiveInt[]␊ - /**␊ - * Extensions for noteNumber␊ - */␊ - _noteNumber?: Element23[]␊ - /**␊ - * The adjudication results.␊ - */␊ - adjudication: ClaimResponse_Adjudication[]␊ - /**␊ - * The second-tier service adjudications for payor added services.␊ - */␊ - detail?: ClaimResponse_Detail1[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept75 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element395 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period28 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept76 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Where the product or service was provided.␊ - */␊ - export interface Address3 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this address.␊ - */␊ - use?: ("home" | "work" | "temp" | "old" | "billing")␊ - _use?: Element20␊ - /**␊ - * Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.␊ - */␊ - type?: ("postal" | "physical" | "both")␊ - _type?: Element21␊ - /**␊ - * Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.␊ - */␊ - text?: string␊ - _text?: Element22␊ - /**␊ - * This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.␊ - */␊ - line?: String[]␊ - /**␊ - * Extensions for line␊ - */␊ - _line?: Element23[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - city?: string␊ - _city?: Element24␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - district?: string␊ - _district?: Element25␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - state?: string␊ - _state?: Element26␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - postalCode?: string␊ - _postalCode?: Element27␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - country?: string␊ - _country?: Element28␊ - period?: Period␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference79 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * The number of repetitions of a service or product.␊ - */␊ - export interface Quantity19 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.␊ - */␊ - export interface Money11 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element396 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The quantity times the unit price for an additional service or product or charge.␊ - */␊ - export interface Money12 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept77 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * This resource provides the adjudication details from the processing of a Claim resource.␊ - */␊ - export interface ClaimResponse_Detail1 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - productOrService: CodeableConcept78␊ - /**␊ - * Item typification or modifiers codes to convey additional context for the product or service.␊ - */␊ - modifier?: CodeableConcept5[]␊ - quantity?: Quantity20␊ - unitPrice?: Money13␊ - /**␊ - * A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.␊ - */␊ - factor?: number␊ - _factor?: Element397␊ - net?: Money14␊ - /**␊ - * The numbers associated with notes below which apply to the adjudication of this item.␊ - */␊ - noteNumber?: PositiveInt[]␊ - /**␊ - * Extensions for noteNumber␊ - */␊ - _noteNumber?: Element23[]␊ - /**␊ - * The adjudication results.␊ - */␊ - adjudication: ClaimResponse_Adjudication[]␊ - /**␊ - * The third-tier service adjudications for payor added services.␊ - */␊ - subDetail?: ClaimResponse_SubDetail1[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept78 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * The number of repetitions of a service or product.␊ - */␊ - export interface Quantity20 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.␊ - */␊ - export interface Money13 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element397 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The quantity times the unit price for an additional service or product or charge.␊ - */␊ - export interface Money14 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * This resource provides the adjudication details from the processing of a Claim resource.␊ - */␊ - export interface ClaimResponse_SubDetail1 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - productOrService: CodeableConcept79␊ - /**␊ - * Item typification or modifiers codes to convey additional context for the product or service.␊ - */␊ - modifier?: CodeableConcept5[]␊ - quantity?: Quantity21␊ - unitPrice?: Money15␊ - /**␊ - * A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.␊ - */␊ - factor?: number␊ - _factor?: Element398␊ - net?: Money16␊ - /**␊ - * The numbers associated with notes below which apply to the adjudication of this item.␊ - */␊ - noteNumber?: PositiveInt[]␊ - /**␊ - * Extensions for noteNumber␊ - */␊ - _noteNumber?: Element23[]␊ - /**␊ - * The adjudication results.␊ - */␊ - adjudication: ClaimResponse_Adjudication[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept79 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * The number of repetitions of a service or product.␊ - */␊ - export interface Quantity21 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.␊ - */␊ - export interface Money15 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element398 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The quantity times the unit price for an additional service or product or charge.␊ - */␊ - export interface Money16 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * This resource provides the adjudication details from the processing of a Claim resource.␊ - */␊ - export interface ClaimResponse_Total {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - category: CodeableConcept80␊ - amount: Money17␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept80 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Monetary total amount associated with the category.␊ - */␊ - export interface Money17 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * Payment details for the adjudication of the claim.␊ - */␊ - export interface ClaimResponse_Payment {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - type: CodeableConcept81␊ - adjustment?: Money18␊ - adjustmentReason?: CodeableConcept82␊ - /**␊ - * Estimated date the payment will be issued or the actual issue date of payment.␊ - */␊ - date?: string␊ - _date?: Element399␊ - amount: Money19␊ - identifier?: Identifier7␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept81 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Total amount of all adjustments to this payment included in this transaction which are not related to this claim's adjudication.␊ - */␊ - export interface Money18 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept82 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element399 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Benefits payable less any payment adjustment.␊ - */␊ - export interface Money19 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier7 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept83 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept84 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * For referring to data content defined in other formats.␊ - */␊ - export interface Attachment4 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.␊ - */␊ - contentType?: string␊ - _contentType?: Element51␊ - /**␊ - * The human language of the content. The value can be any valid value according to BCP 47.␊ - */␊ - language?: string␊ - _language?: Element52␊ - /**␊ - * The actual data of the attachment - a sequence of bytes, base64 encoded.␊ - */␊ - data?: string␊ - _data?: Element53␊ - /**␊ - * A location where the data can be accessed.␊ - */␊ - url?: string␊ - _url?: Element54␊ - /**␊ - * The number of bytes of data that make up this attachment (before base64 encoding, if that is done).␊ - */␊ - size?: number␊ - _size?: Element55␊ - /**␊ - * The calculated hash of the data using SHA-1. Represented using base64.␊ - */␊ - hash?: string␊ - _hash?: Element56␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element57␊ - /**␊ - * The date that the attachment was first created.␊ - */␊ - creation?: string␊ - _creation?: Element58␊ - }␊ - /**␊ - * This resource provides the adjudication details from the processing of a Claim resource.␊ - */␊ - export interface ClaimResponse_ProcessNote {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * An integer with a value that is positive (e.g. >0)␊ - */␊ - number?: number␊ - _number?: Element400␊ - /**␊ - * The business purpose of the note text.␊ - */␊ - type?: ("display" | "print" | "printoper")␊ - _type?: Element401␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element402␊ - language?: CodeableConcept85␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element400 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element401 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element402 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept85 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * This resource provides the adjudication details from the processing of a Claim resource.␊ - */␊ - export interface ClaimResponse_Insurance {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * An integer with a value that is positive (e.g. >0)␊ - */␊ - sequence?: number␊ - _sequence?: Element403␊ - /**␊ - * A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true.␊ - */␊ - focal?: boolean␊ - _focal?: Element404␊ - coverage: Reference80␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - businessArrangement?: string␊ - _businessArrangement?: Element405␊ - claimResponse?: Reference81␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element403 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element404 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference80 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element405 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference81 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * This resource provides the adjudication details from the processing of a Claim resource.␊ - */␊ - export interface ClaimResponse_Error {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * An integer with a value that is positive (e.g. >0)␊ - */␊ - itemSequence?: number␊ - _itemSequence?: Element406␊ - /**␊ - * An integer with a value that is positive (e.g. >0)␊ - */␊ - detailSequence?: number␊ - _detailSequence?: Element407␊ - /**␊ - * An integer with a value that is positive (e.g. >0)␊ - */␊ - subDetailSequence?: number␊ - _subDetailSequence?: Element408␊ - code: CodeableConcept86␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element406 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element407 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element408 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept86 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A record of a clinical assessment performed to determine what problem(s) may affect the patient and before planning the treatments or management strategies that are best to manage a patient's condition. Assessments are often 1:1 with a clinical consultation / encounter, but this varies greatly depending on the clinical workflow. This resource is called "ClinicalImpression" rather than "ClinicalAssessment" to avoid confusion with the recording of assessment tools such as Apgar score.␊ - */␊ - export interface ClinicalImpression {␊ - /**␊ - * This is a ClinicalImpression resource␊ - */␊ - resourceType: "ClinicalImpression"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta21␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element409␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element410␊ - text?: Narrative18␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Business identifiers assigned to this clinical impression by the performer or other systems which remain constant as the resource is updated and propagates from server to server.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - status?: string␊ - _status?: Element411␊ - statusReason?: CodeableConcept87␊ - code?: CodeableConcept88␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element412␊ - subject: Reference82␊ - encounter?: Reference83␊ - /**␊ - * The point in time or period over which the subject was assessed.␊ - */␊ - effectiveDateTime?: string␊ - _effectiveDateTime?: Element413␊ - effectivePeriod?: Period29␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - date?: string␊ - _date?: Element414␊ - assessor?: Reference84␊ - previous?: Reference85␊ - /**␊ - * A list of the relevant problems/conditions for a patient.␊ - */␊ - problem?: Reference11[]␊ - /**␊ - * One or more sets of investigations (signs, symptoms, etc.). The actual grouping of investigations varies greatly depending on the type and context of the assessment. These investigations may include data generated during the assessment process, or data previously generated and recorded that is pertinent to the outcomes.␊ - */␊ - investigation?: ClinicalImpression_Investigation[]␊ - /**␊ - * Reference to a specific published clinical protocol that was followed during this assessment, and/or that provides evidence in support of the diagnosis.␊ - */␊ - protocol?: Uri[]␊ - /**␊ - * Extensions for protocol␊ - */␊ - _protocol?: Element23[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - summary?: string␊ - _summary?: Element415␊ - /**␊ - * Specific findings or diagnoses that were considered likely or relevant to ongoing treatment.␊ - */␊ - finding?: ClinicalImpression_Finding[]␊ - /**␊ - * Estimate of likely outcome.␊ - */␊ - prognosisCodeableConcept?: CodeableConcept5[]␊ - /**␊ - * RiskAssessment expressing likely outcome.␊ - */␊ - prognosisReference?: Reference11[]␊ - /**␊ - * Information supporting the clinical impression.␊ - */␊ - supportingInfo?: Reference11[]␊ - /**␊ - * Commentary about the impression, typically recorded after the impression itself was made, though supplemental notes by the original author could also appear.␊ - */␊ - note?: Annotation1[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta21 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element409 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element410 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative18 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element411 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept87 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept88 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element412 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference82 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference83 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element413 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period29 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element414 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference84 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference85 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A record of a clinical assessment performed to determine what problem(s) may affect the patient and before planning the treatments or management strategies that are best to manage a patient's condition. Assessments are often 1:1 with a clinical consultation / encounter, but this varies greatly depending on the clinical workflow. This resource is called "ClinicalImpression" rather than "ClinicalAssessment" to avoid confusion with the recording of assessment tools such as Apgar score.␊ - */␊ - export interface ClinicalImpression_Investigation {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - code: CodeableConcept89␊ - /**␊ - * A record of a specific investigation that was undertaken.␊ - */␊ - item?: Reference11[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept89 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element415 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A record of a clinical assessment performed to determine what problem(s) may affect the patient and before planning the treatments or management strategies that are best to manage a patient's condition. Assessments are often 1:1 with a clinical consultation / encounter, but this varies greatly depending on the clinical workflow. This resource is called "ClinicalImpression" rather than "ClinicalAssessment" to avoid confusion with the recording of assessment tools such as Apgar score.␊ - */␊ - export interface ClinicalImpression_Finding {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - itemCodeableConcept?: CodeableConcept90␊ - itemReference?: Reference86␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - basis?: string␊ - _basis?: Element416␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept90 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference86 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element416 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its key properties, and optionally define a part or all of its content.␊ - */␊ - export interface CodeSystem {␊ - /**␊ - * This is a CodeSystem resource␊ - */␊ - resourceType: "CodeSystem"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta22␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element417␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element418␊ - text?: Narrative19␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - url?: string␊ - _url?: Element419␊ - /**␊ - * A formal identifier that is used to identify this code system when it is represented in other formats, or referenced in a specification, model, design or an instance.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element420␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element421␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element422␊ - /**␊ - * The date (and optionally time) when the code system resource was created or revised.␊ - */␊ - status?: ("draft" | "active" | "retired" | "unknown")␊ - _status?: Element423␊ - /**␊ - * A Boolean value to indicate that this code system is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.␊ - */␊ - experimental?: boolean␊ - _experimental?: Element424␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - date?: string␊ - _date?: Element425␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - publisher?: string␊ - _publisher?: Element426␊ - /**␊ - * Contact details to assist a user in finding and communicating with the publisher.␊ - */␊ - contact?: ContactDetail1[]␊ - /**␊ - * A free text natural language description of the code system from a consumer's perspective.␊ - */␊ - description?: string␊ - _description?: Element427␊ - /**␊ - * The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate code system instances.␊ - */␊ - useContext?: UsageContext1[]␊ - /**␊ - * A legal or geographic region in which the code system is intended to be used.␊ - */␊ - jurisdiction?: CodeableConcept5[]␊ - /**␊ - * Explanation of why this code system is needed and why it has been designed as it has.␊ - */␊ - purpose?: string␊ - _purpose?: Element428␊ - /**␊ - * A copyright statement relating to the code system and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the code system.␊ - */␊ - copyright?: string␊ - _copyright?: Element429␊ - /**␊ - * If code comparison is case sensitive when codes within this system are compared to each other.␊ - */␊ - caseSensitive?: boolean␊ - _caseSensitive?: Element430␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - valueSet?: string␊ - /**␊ - * The meaning of the hierarchy of concepts as represented in this resource.␊ - */␊ - hierarchyMeaning?: ("grouped-by" | "is-a" | "part-of" | "classified-with")␊ - _hierarchyMeaning?: Element431␊ - /**␊ - * The code system defines a compositional (post-coordination) grammar.␊ - */␊ - compositional?: boolean␊ - _compositional?: Element432␊ - /**␊ - * This flag is used to signify that the code system does not commit to concept permanence across versions. If true, a version must be specified when referencing this code system.␊ - */␊ - versionNeeded?: boolean␊ - _versionNeeded?: Element433␊ - /**␊ - * The extent of the content of the code system (the concepts and codes it defines) are represented in this resource instance.␊ - */␊ - content?: ("not-present" | "example" | "fragment" | "complete" | "supplement")␊ - _content?: Element434␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - supplements?: string␊ - /**␊ - * The total number of concepts defined by the code system. Where the code system has a compositional grammar, the basis of this count is defined by the system steward.␊ - */␊ - count?: number␊ - _count?: Element435␊ - /**␊ - * A filter that can be used in a value set compose statement when selecting concepts using a filter.␊ - */␊ - filter?: CodeSystem_Filter[]␊ - /**␊ - * A property defines an additional slot through which additional information can be provided about a concept.␊ - */␊ - property?: CodeSystem_Property[]␊ - /**␊ - * Concepts that are in the code system. The concept definitions are inherently hierarchical, but the definitions must be consulted to determine what the meanings of the hierarchical relationships are.␊ - */␊ - concept?: CodeSystem_Concept[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta22 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element417 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element418 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative19 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element419 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element420 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element421 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element422 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element423 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element424 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element425 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element426 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element427 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element428 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element429 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element430 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element431 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element432 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element433 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element434 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element435 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its key properties, and optionally define a part or all of its content.␊ - */␊ - export interface CodeSystem_Filter {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - code?: string␊ - _code?: Element436␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element437␊ - /**␊ - * A list of operators that can be used with the filter.␊ - */␊ - operator?: Code[]␊ - /**␊ - * Extensions for operator␊ - */␊ - _operator?: Element23[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element438␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element436 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element437 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element438 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its key properties, and optionally define a part or all of its content.␊ - */␊ - export interface CodeSystem_Property {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - code?: string␊ - _code?: Element439␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - uri?: string␊ - _uri?: Element440␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element441␊ - /**␊ - * The type of the property value. Properties of type "code" contain a code defined by the code system (e.g. a reference to another defined concept).␊ - */␊ - type?: ("code" | "Coding" | "string" | "integer" | "boolean" | "dateTime" | "decimal")␊ - _type?: Element442␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element439 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element440 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element441 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element442 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its key properties, and optionally define a part or all of its content.␊ - */␊ - export interface CodeSystem_Concept {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - code?: string␊ - _code?: Element443␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element444␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - definition?: string␊ - _definition?: Element445␊ - /**␊ - * Additional representations for the concept - other languages, aliases, specialized purposes, used for particular purposes, etc.␊ - */␊ - designation?: CodeSystem_Designation[]␊ - /**␊ - * A property value for this concept.␊ - */␊ - property?: CodeSystem_Property1[]␊ - /**␊ - * Defines children of a concept to produce a hierarchy of concepts. The nature of the relationships is variable (is-a/contains/categorizes) - see hierarchyMeaning.␊ - */␊ - concept?: CodeSystem_Concept[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element443 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element444 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element445 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its key properties, and optionally define a part or all of its content.␊ - */␊ - export interface CodeSystem_Designation {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element446␊ - use?: Coding9␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element447␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element446 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - export interface Coding9 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The identification of the code system that defines the meaning of the symbol in the code.␊ - */␊ - system?: string␊ - _system?: Element39␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element40␊ - /**␊ - * A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).␊ - */␊ - code?: string␊ - _code?: Element41␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element42␊ - /**␊ - * Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).␊ - */␊ - userSelected?: boolean␊ - _userSelected?: Element43␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element447 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its key properties, and optionally define a part or all of its content.␊ - */␊ - export interface CodeSystem_Property1 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - code?: string␊ - _code?: Element448␊ - /**␊ - * The value of this property.␊ - */␊ - valueCode?: string␊ - _valueCode?: Element449␊ - valueCoding?: Coding10␊ - /**␊ - * The value of this property.␊ - */␊ - valueString?: string␊ - _valueString?: Element450␊ - /**␊ - * The value of this property.␊ - */␊ - valueInteger?: number␊ - _valueInteger?: Element451␊ - /**␊ - * The value of this property.␊ - */␊ - valueBoolean?: boolean␊ - _valueBoolean?: Element452␊ - /**␊ - * The value of this property.␊ - */␊ - valueDateTime?: string␊ - _valueDateTime?: Element453␊ - /**␊ - * The value of this property.␊ - */␊ - valueDecimal?: number␊ - _valueDecimal?: Element454␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element448 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element449 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - export interface Coding10 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The identification of the code system that defines the meaning of the symbol in the code.␊ - */␊ - system?: string␊ - _system?: Element39␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element40␊ - /**␊ - * A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).␊ - */␊ - code?: string␊ - _code?: Element41␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element42␊ - /**␊ - * Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).␊ - */␊ - userSelected?: boolean␊ - _userSelected?: Element43␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element450 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element451 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element452 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element453 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element454 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency that was notified about a reportable condition.␊ - */␊ - export interface Communication {␊ - /**␊ - * This is a Communication resource␊ - */␊ - resourceType: "Communication"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta23␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element455␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element456␊ - text?: Narrative20␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Business identifiers assigned to this communication by the performer or other systems which remain constant as the resource is updated and propagates from server to server.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.␊ - */␊ - instantiatesCanonical?: Canonical[]␊ - /**␊ - * The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.␊ - */␊ - instantiatesUri?: Uri[]␊ - /**␊ - * Extensions for instantiatesUri␊ - */␊ - _instantiatesUri?: Element23[]␊ - /**␊ - * An order, proposal or plan fulfilled in whole or in part by this Communication.␊ - */␊ - basedOn?: Reference11[]␊ - /**␊ - * Part of this action.␊ - */␊ - partOf?: Reference11[]␊ - /**␊ - * Prior communication that this communication is in response to.␊ - */␊ - inResponseTo?: Reference11[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - status?: string␊ - _status?: Element457␊ - statusReason?: CodeableConcept91␊ - /**␊ - * The type of message conveyed such as alert, notification, reminder, instruction, etc.␊ - */␊ - category?: CodeableConcept5[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - priority?: string␊ - _priority?: Element458␊ - /**␊ - * A channel that was used for this communication (e.g. email, fax).␊ - */␊ - medium?: CodeableConcept5[]␊ - subject?: Reference87␊ - topic?: CodeableConcept92␊ - /**␊ - * Other resources that pertain to this communication and to which this communication should be associated.␊ - */␊ - about?: Reference11[]␊ - encounter?: Reference88␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - sent?: string␊ - _sent?: Element459␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - received?: string␊ - _received?: Element460␊ - /**␊ - * The entity (e.g. person, organization, clinical information system, care team or device) which was the target of the communication. If receipts need to be tracked by an individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either receipts are not tracked (e.g. a mass mail-out) or a receipt is captured in aggregate (all emails confirmed received by a particular time).␊ - */␊ - recipient?: Reference11[]␊ - sender?: Reference89␊ - /**␊ - * The reason or justification for the communication.␊ - */␊ - reasonCode?: CodeableConcept5[]␊ - /**␊ - * Indicates another resource whose existence justifies this communication.␊ - */␊ - reasonReference?: Reference11[]␊ - /**␊ - * Text, attachment(s), or resource(s) that was communicated to the recipient.␊ - */␊ - payload?: Communication_Payload[]␊ - /**␊ - * Additional notes or commentary about the communication by the sender, receiver or other interested parties.␊ - */␊ - note?: Annotation1[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta23 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element455 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element456 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative20 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element457 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept91 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element458 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference87 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept92 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference88 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element459 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element460 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference89 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency that was notified about a reportable condition.␊ - */␊ - export interface Communication_Payload {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A communicated content (or for multi-part communications, one portion of the communication).␊ - */␊ - contentString?: string␊ - _contentString?: Element461␊ - contentAttachment?: Attachment5␊ - contentReference?: Reference90␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element461 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * For referring to data content defined in other formats.␊ - */␊ - export interface Attachment5 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.␊ - */␊ - contentType?: string␊ - _contentType?: Element51␊ - /**␊ - * The human language of the content. The value can be any valid value according to BCP 47.␊ - */␊ - language?: string␊ - _language?: Element52␊ - /**␊ - * The actual data of the attachment - a sequence of bytes, base64 encoded.␊ - */␊ - data?: string␊ - _data?: Element53␊ - /**␊ - * A location where the data can be accessed.␊ - */␊ - url?: string␊ - _url?: Element54␊ - /**␊ - * The number of bytes of data that make up this attachment (before base64 encoding, if that is done).␊ - */␊ - size?: number␊ - _size?: Element55␊ - /**␊ - * The calculated hash of the data using SHA-1. Represented using base64.␊ - */␊ - hash?: string␊ - _hash?: Element56␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element57␊ - /**␊ - * The date that the attachment was first created.␊ - */␊ - creation?: string␊ - _creation?: Element58␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference90 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.␊ - */␊ - export interface CommunicationRequest {␊ - /**␊ - * This is a CommunicationRequest resource␊ - */␊ - resourceType: "CommunicationRequest"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta24␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element462␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element463␊ - text?: Narrative21␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Business identifiers assigned to this communication request by the performer or other systems which remain constant as the resource is updated and propagates from server to server.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * A plan or proposal that is fulfilled in whole or in part by this request.␊ - */␊ - basedOn?: Reference11[]␊ - /**␊ - * Completed or terminated request(s) whose function is taken by this new request.␊ - */␊ - replaces?: Reference11[]␊ - groupIdentifier?: Identifier8␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - status?: string␊ - _status?: Element464␊ - statusReason?: CodeableConcept93␊ - /**␊ - * The type of message to be sent such as alert, notification, reminder, instruction, etc.␊ - */␊ - category?: CodeableConcept5[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - priority?: string␊ - _priority?: Element465␊ - /**␊ - * If true indicates that the CommunicationRequest is asking for the specified action to *not* occur.␊ - */␊ - doNotPerform?: boolean␊ - _doNotPerform?: Element466␊ - /**␊ - * A channel that was used for this communication (e.g. email, fax).␊ - */␊ - medium?: CodeableConcept5[]␊ - subject?: Reference91␊ - /**␊ - * Other resources that pertain to this communication request and to which this communication request should be associated.␊ - */␊ - about?: Reference11[]␊ - encounter?: Reference92␊ - /**␊ - * Text, attachment(s), or resource(s) to be communicated to the recipient.␊ - */␊ - payload?: CommunicationRequest_Payload[]␊ - /**␊ - * The time when this communication is to occur.␊ - */␊ - occurrenceDateTime?: string␊ - _occurrenceDateTime?: Element468␊ - occurrencePeriod?: Period30␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - authoredOn?: string␊ - _authoredOn?: Element469␊ - requester?: Reference94␊ - /**␊ - * The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication.␊ - */␊ - recipient?: Reference11[]␊ - sender?: Reference95␊ - /**␊ - * Describes why the request is being made in coded or textual form.␊ - */␊ - reasonCode?: CodeableConcept5[]␊ - /**␊ - * Indicates another resource whose existence justifies this request.␊ - */␊ - reasonReference?: Reference11[]␊ - /**␊ - * Comments made about the request by the requester, sender, recipient, subject or other participants.␊ - */␊ - note?: Annotation1[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta24 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element462 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element463 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative21 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier8 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element464 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept93 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element465 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element466 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference91 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference92 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.␊ - */␊ - export interface CommunicationRequest_Payload {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * The communicated content (or for multi-part communications, one portion of the communication).␊ - */␊ - contentString?: string␊ - _contentString?: Element467␊ - contentAttachment?: Attachment6␊ - contentReference?: Reference93␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element467 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * For referring to data content defined in other formats.␊ - */␊ - export interface Attachment6 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.␊ - */␊ - contentType?: string␊ - _contentType?: Element51␊ - /**␊ - * The human language of the content. The value can be any valid value according to BCP 47.␊ - */␊ - language?: string␊ - _language?: Element52␊ - /**␊ - * The actual data of the attachment - a sequence of bytes, base64 encoded.␊ - */␊ - data?: string␊ - _data?: Element53␊ - /**␊ - * A location where the data can be accessed.␊ - */␊ - url?: string␊ - _url?: Element54␊ - /**␊ - * The number of bytes of data that make up this attachment (before base64 encoding, if that is done).␊ - */␊ - size?: number␊ - _size?: Element55␊ - /**␊ - * The calculated hash of the data using SHA-1. Represented using base64.␊ - */␊ - hash?: string␊ - _hash?: Element56␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element57␊ - /**␊ - * The date that the attachment was first created.␊ - */␊ - creation?: string␊ - _creation?: Element58␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference93 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element468 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period30 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element469 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference94 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference95 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A compartment definition that defines how resources are accessed on a server.␊ - */␊ - export interface CompartmentDefinition {␊ - /**␊ - * This is a CompartmentDefinition resource␊ - */␊ - resourceType: "CompartmentDefinition"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta25␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element470␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element471␊ - text?: Narrative22␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - url?: string␊ - _url?: Element472␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element473␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element474␊ - /**␊ - * The status of this compartment definition. Enables tracking the life-cycle of the content.␊ - */␊ - status?: ("draft" | "active" | "retired" | "unknown")␊ - _status?: Element475␊ - /**␊ - * A Boolean value to indicate that this compartment definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.␊ - */␊ - experimental?: boolean␊ - _experimental?: Element476␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - date?: string␊ - _date?: Element477␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - publisher?: string␊ - _publisher?: Element478␊ - /**␊ - * Contact details to assist a user in finding and communicating with the publisher.␊ - */␊ - contact?: ContactDetail1[]␊ - /**␊ - * A free text natural language description of the compartment definition from a consumer's perspective.␊ - */␊ - description?: string␊ - _description?: Element479␊ - /**␊ - * The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate compartment definition instances.␊ - */␊ - useContext?: UsageContext1[]␊ - /**␊ - * Explanation of why this compartment definition is needed and why it has been designed as it has.␊ - */␊ - purpose?: string␊ - _purpose?: Element480␊ - /**␊ - * Which compartment this definition describes.␊ - */␊ - code?: ("Patient" | "Encounter" | "RelatedPerson" | "Practitioner" | "Device")␊ - _code?: Element481␊ - /**␊ - * Whether the search syntax is supported,.␊ - */␊ - search?: boolean␊ - _search?: Element482␊ - /**␊ - * Information about how a resource is related to the compartment.␊ - */␊ - resource?: CompartmentDefinition_Resource[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta25 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element470 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element471 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative22 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element472 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element473 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element474 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element475 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element476 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element477 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element478 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element479 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element480 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element481 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element482 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A compartment definition that defines how resources are accessed on a server.␊ - */␊ - export interface CompartmentDefinition_Resource {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - code?: string␊ - _code?: Element483␊ - /**␊ - * The name of a search parameter that represents the link to the compartment. More than one may be listed because a resource may be linked to a compartment in more than one way,.␊ - */␊ - param?: String[]␊ - /**␊ - * Extensions for param␊ - */␊ - _param?: Element23[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - documentation?: string␊ - _documentation?: Element484␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element483 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element484 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.).␊ - */␊ - export interface Composition {␊ - /**␊ - * This is a Composition resource␊ - */␊ - resourceType: "Composition"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta26␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element485␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element486␊ - text?: Narrative23␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - identifier?: Identifier9␊ - /**␊ - * The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document.␊ - */␊ - status?: ("preliminary" | "final" | "amended" | "entered-in-error")␊ - _status?: Element487␊ - type: CodeableConcept94␊ - /**␊ - * A categorization for the type of the composition - helps for indexing and searching. This may be implied by or derived from the code specified in the Composition Type.␊ - */␊ - category?: CodeableConcept5[]␊ - subject?: Reference96␊ - encounter?: Reference97␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - date?: string␊ - _date?: Element488␊ - /**␊ - * Identifies who is responsible for the information in the composition, not necessarily who typed it in.␊ - */␊ - author: Reference11[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element489␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - confidentiality?: string␊ - _confidentiality?: Element490␊ - /**␊ - * A participant who has attested to the accuracy of the composition/document.␊ - */␊ - attester?: Composition_Attester[]␊ - custodian?: Reference99␊ - /**␊ - * Relationships that this composition has with other compositions or documents that already exist.␊ - */␊ - relatesTo?: Composition_RelatesTo[]␊ - /**␊ - * The clinical service, such as a colonoscopy or an appendectomy, being documented.␊ - */␊ - event?: Composition_Event[]␊ - /**␊ - * The root of the sections that make up the composition.␊ - */␊ - section?: Composition_Section[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta26 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element485 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element486 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative23 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier9 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element487 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept94 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference96 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference97 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element488 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element489 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element490 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.).␊ - */␊ - export interface Composition_Attester {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * The type of attestation the authenticator offers.␊ - */␊ - mode?: ("personal" | "professional" | "legal" | "official")␊ - _mode?: Element491␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - time?: string␊ - _time?: Element492␊ - party?: Reference98␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element491 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element492 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference98 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference99 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.).␊ - */␊ - export interface Composition_RelatesTo {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - code?: string␊ - _code?: Element493␊ - targetIdentifier?: Identifier10␊ - targetReference?: Reference100␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element493 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier10 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference100 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.).␊ - */␊ - export interface Composition_Event {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act.␊ - */␊ - code?: CodeableConcept5[]␊ - period?: Period31␊ - /**␊ - * The description and/or reference of the event(s) being documented. For example, this could be used to document such a colonoscopy or an appendectomy.␊ - */␊ - detail?: Reference11[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period31 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.).␊ - */␊ - export interface Composition_Section {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element494␊ - code?: CodeableConcept95␊ - /**␊ - * Identifies who is responsible for the information in this section, not necessarily who typed it in.␊ - */␊ - author?: Reference11[]␊ - focus?: Reference101␊ - text?: Narrative24␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - mode?: string␊ - _mode?: Element495␊ - orderedBy?: CodeableConcept96␊ - /**␊ - * A reference to the actual resource from which the narrative in the section is derived.␊ - */␊ - entry?: Reference11[]␊ - emptyReason?: CodeableConcept97␊ - /**␊ - * A nested sub-section within this section.␊ - */␊ - section?: Composition_Section[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element494 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept95 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference101 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.␊ - */␊ - export interface Narrative24 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element495 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept96 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept97 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, or classes in class models.␊ - */␊ - export interface ConceptMap {␊ - /**␊ - * This is a ConceptMap resource␊ - */␊ - resourceType: "ConceptMap"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta27␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element496␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element497␊ - text?: Narrative25␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - url?: string␊ - _url?: Element498␊ - identifier?: Identifier11␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element499␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element500␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element501␊ - /**␊ - * The status of this concept map. Enables tracking the life-cycle of the content.␊ - */␊ - status?: ("draft" | "active" | "retired" | "unknown")␊ - _status?: Element502␊ - /**␊ - * A Boolean value to indicate that this concept map is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.␊ - */␊ - experimental?: boolean␊ - _experimental?: Element503␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - date?: string␊ - _date?: Element504␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - publisher?: string␊ - _publisher?: Element505␊ - /**␊ - * Contact details to assist a user in finding and communicating with the publisher.␊ - */␊ - contact?: ContactDetail1[]␊ - /**␊ - * A free text natural language description of the concept map from a consumer's perspective.␊ - */␊ - description?: string␊ - _description?: Element506␊ - /**␊ - * The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate concept map instances.␊ - */␊ - useContext?: UsageContext1[]␊ - /**␊ - * A legal or geographic region in which the concept map is intended to be used.␊ - */␊ - jurisdiction?: CodeableConcept5[]␊ - /**␊ - * Explanation of why this concept map is needed and why it has been designed as it has.␊ - */␊ - purpose?: string␊ - _purpose?: Element507␊ - /**␊ - * A copyright statement relating to the concept map and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the concept map.␊ - */␊ - copyright?: string␊ - _copyright?: Element508␊ - /**␊ - * Identifier for the source value set that contains the concepts that are being mapped and provides context for the mappings.␊ - */␊ - sourceUri?: string␊ - _sourceUri?: Element509␊ - /**␊ - * Identifier for the source value set that contains the concepts that are being mapped and provides context for the mappings.␊ - */␊ - sourceCanonical?: string␊ - _sourceCanonical?: Element510␊ - /**␊ - * The target value set provides context for the mappings. Note that the mapping is made between concepts, not between value sets, but the value set provides important context about how the concept mapping choices are made.␊ - */␊ - targetUri?: string␊ - _targetUri?: Element511␊ - /**␊ - * The target value set provides context for the mappings. Note that the mapping is made between concepts, not between value sets, but the value set provides important context about how the concept mapping choices are made.␊ - */␊ - targetCanonical?: string␊ - _targetCanonical?: Element512␊ - /**␊ - * A group of mappings that all have the same source and target system.␊ - */␊ - group?: ConceptMap_Group[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta27 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element496 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element497 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative25 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element498 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier11 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element499 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element500 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element501 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element502 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element503 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element504 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element505 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element506 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element507 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element508 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element509 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element510 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element511 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element512 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, or classes in class models.␊ - */␊ - export interface ConceptMap_Group {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - source?: string␊ - _source?: Element513␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - sourceVersion?: string␊ - _sourceVersion?: Element514␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - target?: string␊ - _target?: Element515␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - targetVersion?: string␊ - _targetVersion?: Element516␊ - /**␊ - * Mappings for an individual concept in the source to one or more concepts in the target.␊ - */␊ - element: ConceptMap_Element[]␊ - unmapped?: ConceptMap_Unmapped␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element513 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element514 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element515 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element516 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, or classes in class models.␊ - */␊ - export interface ConceptMap_Element {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - code?: string␊ - _code?: Element517␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element518␊ - /**␊ - * A concept from the target value set that this concept maps to.␊ - */␊ - target?: ConceptMap_Target[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element517 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element518 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, or classes in class models.␊ - */␊ - export interface ConceptMap_Target {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - code?: string␊ - _code?: Element519␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element520␊ - /**␊ - * The equivalence between the source and target concepts (counting for the dependencies and products). The equivalence is read from target to source (e.g. the target is 'wider' than the source).␊ - */␊ - equivalence?: ("relatedto" | "equivalent" | "equal" | "wider" | "subsumes" | "narrower" | "specializes" | "inexact" | "unmatched" | "disjoint")␊ - _equivalence?: Element521␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - comment?: string␊ - _comment?: Element522␊ - /**␊ - * A set of additional dependencies for this mapping to hold. This mapping is only applicable if the specified element can be resolved, and it has the specified value.␊ - */␊ - dependsOn?: ConceptMap_DependsOn[]␊ - /**␊ - * A set of additional outcomes from this mapping to other elements. To properly execute this mapping, the specified element must be mapped to some data element or source that is in context. The mapping may still be useful without a place for the additional data elements, but the equivalence cannot be relied on.␊ - */␊ - product?: ConceptMap_DependsOn[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element519 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element520 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element521 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element522 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, or classes in class models.␊ - */␊ - export interface ConceptMap_DependsOn {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - property?: string␊ - _property?: Element523␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - system?: string␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element524␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element525␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element523 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element524 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element525 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * What to do when there is no mapping for the source concept. "Unmapped" does not include codes that are unmatched, and the unmapped element is ignored in a code is specified to have equivalence = unmatched.␊ - */␊ - export interface ConceptMap_Unmapped {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Defines which action to take if there is no match for the source concept in the target system designated for the group. One of 3 actions are possible: use the unmapped code (this is useful when doing a mapping between versions, and only a few codes have changed), use a fixed code (a default code), or alternatively, a reference to a different concept map can be provided (by canonical URL).␊ - */␊ - mode?: ("provided" | "fixed" | "other-map")␊ - _mode?: Element526␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - code?: string␊ - _code?: Element527␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element528␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - url?: string␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element526 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element527 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element528 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.␊ - */␊ - export interface Condition {␊ - /**␊ - * This is a Condition resource␊ - */␊ - resourceType: "Condition"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta28␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element529␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element530␊ - text?: Narrative26␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Business identifiers assigned to this condition by the performer or other systems which remain constant as the resource is updated and propagates from server to server.␊ - */␊ - identifier?: Identifier2[]␊ - clinicalStatus?: CodeableConcept98␊ - verificationStatus?: CodeableConcept99␊ - /**␊ - * A category assigned to the condition.␊ - */␊ - category?: CodeableConcept5[]␊ - severity?: CodeableConcept100␊ - code?: CodeableConcept101␊ - /**␊ - * The anatomical location where this condition manifests itself.␊ - */␊ - bodySite?: CodeableConcept5[]␊ - subject: Reference102␊ - encounter?: Reference103␊ - /**␊ - * Estimated or actual date or date-time the condition began, in the opinion of the clinician.␊ - */␊ - onsetDateTime?: string␊ - _onsetDateTime?: Element531␊ - onsetAge?: Age3␊ - onsetPeriod?: Period32␊ - onsetRange?: Range7␊ - /**␊ - * Estimated or actual date or date-time the condition began, in the opinion of the clinician.␊ - */␊ - onsetString?: string␊ - _onsetString?: Element532␊ - /**␊ - * The date or estimated date that the condition resolved or went into remission. This is called "abatement" because of the many overloaded connotations associated with "remission" or "resolution" - Conditions are never really resolved, but they can abate.␊ - */␊ - abatementDateTime?: string␊ - _abatementDateTime?: Element533␊ - abatementAge?: Age4␊ - abatementPeriod?: Period33␊ - abatementRange?: Range8␊ - /**␊ - * The date or estimated date that the condition resolved or went into remission. This is called "abatement" because of the many overloaded connotations associated with "remission" or "resolution" - Conditions are never really resolved, but they can abate.␊ - */␊ - abatementString?: string␊ - _abatementString?: Element534␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - recordedDate?: string␊ - _recordedDate?: Element535␊ - recorder?: Reference104␊ - asserter?: Reference105␊ - /**␊ - * Clinical stage or grade of a condition. May include formal severity assessments.␊ - */␊ - stage?: Condition_Stage[]␊ - /**␊ - * Supporting evidence / manifestations that are the basis of the Condition's verification status, such as evidence that confirmed or refuted the condition.␊ - */␊ - evidence?: Condition_Evidence[]␊ - /**␊ - * Additional information about the Condition. This is a general notes/comments entry for description of the Condition, its diagnosis and prognosis.␊ - */␊ - note?: Annotation1[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta28 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element529 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element530 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative26 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept98 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept99 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept100 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept101 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference102 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference103 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element531 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Estimated or actual date or date-time the condition began, in the opinion of the clinician.␊ - */␊ - export interface Age3 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element31␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element32␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element33␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element34␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element35␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period32 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Estimated or actual date or date-time the condition began, in the opinion of the clinician.␊ - */␊ - export interface Range7 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - low?: Quantity1␊ - high?: Quantity2␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element532 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element533 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The date or estimated date that the condition resolved or went into remission. This is called "abatement" because of the many overloaded connotations associated with "remission" or "resolution" - Conditions are never really resolved, but they can abate.␊ - */␊ - export interface Age4 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element31␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element32␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element33␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element34␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element35␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period33 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * The date or estimated date that the condition resolved or went into remission. This is called "abatement" because of the many overloaded connotations associated with "remission" or "resolution" - Conditions are never really resolved, but they can abate.␊ - */␊ - export interface Range8 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - low?: Quantity1␊ - high?: Quantity2␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element534 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element535 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference104 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference105 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.␊ - */␊ - export interface Condition_Stage {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - summary?: CodeableConcept102␊ - /**␊ - * Reference to a formal record of the evidence on which the staging assessment is based.␊ - */␊ - assessment?: Reference11[]␊ - type?: CodeableConcept103␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept102 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept103 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.␊ - */␊ - export interface Condition_Evidence {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A manifestation or symptom that led to the recording of this condition.␊ - */␊ - code?: CodeableConcept5[]␊ - /**␊ - * Links to other relevant information, including pathology reports.␊ - */␊ - detail?: Reference11[]␊ - }␊ - /**␊ - * A record of a healthcare consumer’s choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.␊ - */␊ - export interface Consent {␊ - /**␊ - * This is a Consent resource␊ - */␊ - resourceType: "Consent"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta29␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element536␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element537␊ - text?: Narrative27␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Unique identifier for this copy of the Consent Statement.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * Indicates the current state of this consent.␊ - */␊ - status?: ("draft" | "proposed" | "active" | "rejected" | "inactive" | "entered-in-error")␊ - _status?: Element538␊ - scope: CodeableConcept104␊ - /**␊ - * A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements.␊ - */␊ - category: CodeableConcept5[]␊ - patient?: Reference106␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - dateTime?: string␊ - _dateTime?: Element539␊ - /**␊ - * Either the Grantor, which is the entity responsible for granting the rights listed in a Consent Directive or the Grantee, which is the entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions.␊ - */␊ - performer?: Reference11[]␊ - /**␊ - * The organization that manages the consent, and the framework within which it is executed.␊ - */␊ - organization?: Reference11[]␊ - sourceAttachment?: Attachment7␊ - sourceReference?: Reference107␊ - /**␊ - * The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.␊ - */␊ - policy?: Consent_Policy[]␊ - policyRule?: CodeableConcept105␊ - /**␊ - * Whether a treatment instruction (e.g. artificial respiration yes or no) was verified with the patient, his/her family or another authorized person.␊ - */␊ - verification?: Consent_Verification[]␊ - provision?: Consent_Provision␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta29 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element536 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element537 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative27 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element538 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept104 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference106 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element539 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * For referring to data content defined in other formats.␊ - */␊ - export interface Attachment7 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.␊ - */␊ - contentType?: string␊ - _contentType?: Element51␊ - /**␊ - * The human language of the content. The value can be any valid value according to BCP 47.␊ - */␊ - language?: string␊ - _language?: Element52␊ - /**␊ - * The actual data of the attachment - a sequence of bytes, base64 encoded.␊ - */␊ - data?: string␊ - _data?: Element53␊ - /**␊ - * A location where the data can be accessed.␊ - */␊ - url?: string␊ - _url?: Element54␊ - /**␊ - * The number of bytes of data that make up this attachment (before base64 encoding, if that is done).␊ - */␊ - size?: number␊ - _size?: Element55␊ - /**␊ - * The calculated hash of the data using SHA-1. Represented using base64.␊ - */␊ - hash?: string␊ - _hash?: Element56␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element57␊ - /**␊ - * The date that the attachment was first created.␊ - */␊ - creation?: string␊ - _creation?: Element58␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference107 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A record of a healthcare consumer’s choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.␊ - */␊ - export interface Consent_Policy {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - authority?: string␊ - _authority?: Element540␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - uri?: string␊ - _uri?: Element541␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element540 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element541 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept105 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A record of a healthcare consumer’s choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.␊ - */␊ - export interface Consent_Verification {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Has the instruction been verified.␊ - */␊ - verified?: boolean␊ - _verified?: Element542␊ - verifiedWith?: Reference108␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - verificationDate?: string␊ - _verificationDate?: Element543␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element542 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference108 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element543 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * An exception to the base policy of this consent. An exception can be an addition or removal of access permissions.␊ - */␊ - export interface Consent_Provision {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Action to take - permit or deny - when the rule conditions are met. Not permitted in root rule, required in all nested rules.␊ - */␊ - type?: ("deny" | "permit")␊ - _type?: Element544␊ - period?: Period34␊ - /**␊ - * Who or what is controlled by this rule. Use group to identify a set of actors by some property they share (e.g. 'admitting officers').␊ - */␊ - actor?: Consent_Actor[]␊ - /**␊ - * Actions controlled by this Rule.␊ - */␊ - action?: CodeableConcept5[]␊ - /**␊ - * A security label, comprised of 0..* security label fields (Privacy tags), which define which resources are controlled by this exception.␊ - */␊ - securityLabel?: Coding[]␊ - /**␊ - * The context of the activities a user is taking - why the user is accessing the data - that are controlled by this rule.␊ - */␊ - purpose?: Coding[]␊ - /**␊ - * The class of information covered by this rule. The type can be a FHIR resource type, a profile on a type, or a CDA document, or some other type that indicates what sort of information the consent relates to.␊ - */␊ - class?: Coding[]␊ - /**␊ - * If this code is found in an instance, then the rule applies.␊ - */␊ - code?: CodeableConcept5[]␊ - dataPeriod?: Period35␊ - /**␊ - * The resources controlled by this rule if specific resources are referenced.␊ - */␊ - data?: Consent_Data[]␊ - /**␊ - * Rules which provide exceptions to the base rule or subrules.␊ - */␊ - provision?: Consent_Provision1[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element544 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period34 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * A record of a healthcare consumer’s choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.␊ - */␊ - export interface Consent_Actor {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - role: CodeableConcept106␊ - reference: Reference109␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept106 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference109 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period35 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * A record of a healthcare consumer’s choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.␊ - */␊ - export interface Consent_Data {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * How the resource reference is interpreted when testing consent restrictions.␊ - */␊ - meaning?: ("instance" | "related" | "dependents" | "authoredby")␊ - _meaning?: Element545␊ - reference: Reference110␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element545 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference110 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A record of a healthcare consumer’s choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.␊ - */␊ - export interface Consent_Provision1 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Action to take - permit or deny - when the rule conditions are met. Not permitted in root rule, required in all nested rules.␊ - */␊ - type?: ("deny" | "permit")␊ - _type?: Element544␊ - period?: Period34␊ - /**␊ - * Who or what is controlled by this rule. Use group to identify a set of actors by some property they share (e.g. 'admitting officers').␊ - */␊ - actor?: Consent_Actor[]␊ - /**␊ - * Actions controlled by this Rule.␊ - */␊ - action?: CodeableConcept5[]␊ - /**␊ - * A security label, comprised of 0..* security label fields (Privacy tags), which define which resources are controlled by this exception.␊ - */␊ - securityLabel?: Coding[]␊ - /**␊ - * The context of the activities a user is taking - why the user is accessing the data - that are controlled by this rule.␊ - */␊ - purpose?: Coding[]␊ - /**␊ - * The class of information covered by this rule. The type can be a FHIR resource type, a profile on a type, or a CDA document, or some other type that indicates what sort of information the consent relates to.␊ - */␊ - class?: Coding[]␊ - /**␊ - * If this code is found in an instance, then the rule applies.␊ - */␊ - code?: CodeableConcept5[]␊ - dataPeriod?: Period35␊ - /**␊ - * The resources controlled by this rule if specific resources are referenced.␊ - */␊ - data?: Consent_Data[]␊ - /**␊ - * Rules which provide exceptions to the base rule or subrules.␊ - */␊ - provision?: Consent_Provision1[]␊ - }␊ - /**␊ - * Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.␊ - */␊ - export interface Contract {␊ - /**␊ - * This is a Contract resource␊ - */␊ - resourceType: "Contract"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta30␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element546␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element547␊ - text?: Narrative28␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Unique identifier for this Contract or a derivative that references a Source Contract.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - url?: string␊ - _url?: Element548␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element549␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - status?: string␊ - _status?: Element550␊ - legalState?: CodeableConcept107␊ - instantiatesCanonical?: Reference111␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - instantiatesUri?: string␊ - _instantiatesUri?: Element551␊ - contentDerivative?: CodeableConcept108␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - issued?: string␊ - _issued?: Element552␊ - applies?: Period36␊ - expirationType?: CodeableConcept109␊ - /**␊ - * The target entity impacted by or of interest to parties to the agreement.␊ - */␊ - subject?: Reference11[]␊ - /**␊ - * A formally or informally recognized grouping of people, principals, organizations, or jurisdictions formed for the purpose of achieving some form of collective action such as the promulgation, administration and enforcement of contracts and policies.␊ - */␊ - authority?: Reference11[]␊ - /**␊ - * Recognized governance framework or system operating with a circumscribed scope in accordance with specified principles, policies, processes or procedures for managing rights, actions, or behaviors of parties or principals relative to resources.␊ - */␊ - domain?: Reference11[]␊ - /**␊ - * Sites in which the contract is complied with, exercised, or in force.␊ - */␊ - site?: Reference11[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element553␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element554␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - subtitle?: string␊ - _subtitle?: Element555␊ - /**␊ - * Alternative representation of the title for this Contract definition, derivative, or instance in any legal state., e.g., a domain specific contract number related to legislation.␊ - */␊ - alias?: String[]␊ - /**␊ - * Extensions for alias␊ - */␊ - _alias?: Element23[]␊ - author?: Reference112␊ - scope?: CodeableConcept110␊ - topicCodeableConcept?: CodeableConcept111␊ - topicReference?: Reference113␊ - type?: CodeableConcept112␊ - /**␊ - * Sub-category for the Contract that distinguishes the kinds of systems that would be interested in the Contract within the context of the Contract's scope.␊ - */␊ - subType?: CodeableConcept5[]␊ - contentDefinition?: Contract_ContentDefinition␊ - /**␊ - * One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.␊ - */␊ - term?: Contract_Term[]␊ - /**␊ - * Information that may be needed by/relevant to the performer in their execution of this term action.␊ - */␊ - supportingInfo?: Reference11[]␊ - /**␊ - * Links to Provenance records for past versions of this Contract definition, derivative, or instance, which identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the Contract. The Provence.entity indicates the target that was changed in the update. http://build.fhir.org/provenance-definitions.html#Provenance.entity.␊ - */␊ - relevantHistory?: Reference11[]␊ - /**␊ - * Parties with legal standing in the Contract, including the principal parties, the grantor(s) and grantee(s), which are any person or organization bound by the contract, and any ancillary parties, which facilitate the execution of the contract such as a notary or witness.␊ - */␊ - signer?: Contract_Signer[]␊ - /**␊ - * The "patient friendly language" versionof the Contract in whole or in parts. "Patient friendly language" means the representation of the Contract and Contract Provisions in a manner that is readily accessible and understandable by a layperson in accordance with best practices for communication styles that ensure that those agreeing to or signing the Contract understand the roles, actions, obligations, responsibilities, and implication of the agreement.␊ - */␊ - friendly?: Contract_Friendly[]␊ - /**␊ - * List of Legal expressions or representations of this Contract.␊ - */␊ - legal?: Contract_Legal[]␊ - /**␊ - * List of Computable Policy Rule Language Representations of this Contract.␊ - */␊ - rule?: Contract_Rule[]␊ - legallyBindingAttachment?: Attachment12␊ - legallyBindingReference?: Reference128␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta30 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element546 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element547 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative28 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element548 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element549 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element550 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept107 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference111 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element551 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept108 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element552 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period36 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept109 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element553 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element554 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element555 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference112 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept110 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept111 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference113 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept112 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Precusory content developed with a focus and intent of supporting the formation a Contract instance, which may be associated with and transformable into a Contract.␊ - */␊ - export interface Contract_ContentDefinition {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - type: CodeableConcept113␊ - subType?: CodeableConcept114␊ - publisher?: Reference114␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - publicationDate?: string␊ - _publicationDate?: Element556␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - publicationStatus?: string␊ - _publicationStatus?: Element557␊ - /**␊ - * A copyright statement relating to Contract precursor content. Copyright statements are generally legal restrictions on the use and publishing of the Contract precursor content.␊ - */␊ - copyright?: string␊ - _copyright?: Element558␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept113 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept114 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference114 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element556 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element557 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element558 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.␊ - */␊ - export interface Contract_Term {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - identifier?: Identifier12␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - issued?: string␊ - _issued?: Element559␊ - applies?: Period37␊ - topicCodeableConcept?: CodeableConcept115␊ - topicReference?: Reference115␊ - type?: CodeableConcept116␊ - subType?: CodeableConcept117␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element560␊ - /**␊ - * Security labels that protect the handling of information about the term and its elements, which may be specifically identified..␊ - */␊ - securityLabel?: Contract_SecurityLabel[]␊ - offer: Contract_Offer␊ - /**␊ - * Contract Term Asset List.␊ - */␊ - asset?: Contract_Asset[]␊ - /**␊ - * An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.␊ - */␊ - action?: Contract_Action[]␊ - /**␊ - * Nested group of Contract Provisions.␊ - */␊ - group?: Contract_Term[]␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier12 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element559 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period37 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept115 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference115 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept116 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept117 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element560 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.␊ - */␊ - export interface Contract_SecurityLabel {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Number used to link this term or term element to the applicable Security Label.␊ - */␊ - number?: UnsignedInt[]␊ - /**␊ - * Extensions for number␊ - */␊ - _number?: Element23[]␊ - classification: Coding11␊ - /**␊ - * Security label privacy tag that species the applicable privacy and security policies governing this term and/or term elements.␊ - */␊ - category?: Coding[]␊ - /**␊ - * Security label privacy tag that species the manner in which term and/or term elements are to be protected.␊ - */␊ - control?: Coding[]␊ - }␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - export interface Coding11 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The identification of the code system that defines the meaning of the symbol in the code.␊ - */␊ - system?: string␊ - _system?: Element39␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element40␊ - /**␊ - * A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).␊ - */␊ - code?: string␊ - _code?: Element41␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element42␊ - /**␊ - * Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).␊ - */␊ - userSelected?: boolean␊ - _userSelected?: Element43␊ - }␊ - /**␊ - * The matter of concern in the context of this provision of the agrement.␊ - */␊ - export interface Contract_Offer {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Unique identifier for this particular Contract Provision.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * Offer Recipient.␊ - */␊ - party?: Contract_Party[]␊ - topic?: Reference116␊ - type?: CodeableConcept119␊ - decision?: CodeableConcept120␊ - /**␊ - * How the decision about a Contract was conveyed.␊ - */␊ - decisionMode?: CodeableConcept5[]␊ - /**␊ - * Response to offer text.␊ - */␊ - answer?: Contract_Answer[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element569␊ - /**␊ - * The id of the clause or question text of the offer in the referenced questionnaire/response.␊ - */␊ - linkId?: String[]␊ - /**␊ - * Extensions for linkId␊ - */␊ - _linkId?: Element23[]␊ - /**␊ - * Security labels that protects the offer.␊ - */␊ - securityLabelNumber?: UnsignedInt[]␊ - /**␊ - * Extensions for securityLabelNumber␊ - */␊ - _securityLabelNumber?: Element23[]␊ - }␊ - /**␊ - * Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.␊ - */␊ - export interface Contract_Party {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Participant in the offer.␊ - */␊ - reference: Reference11[]␊ - role: CodeableConcept118␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept118 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference116 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept119 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept120 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.␊ - */␊ - export interface Contract_Answer {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research.␊ - */␊ - valueBoolean?: boolean␊ - _valueBoolean?: Element561␊ - /**␊ - * Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research.␊ - */␊ - valueDecimal?: number␊ - _valueDecimal?: Element562␊ - /**␊ - * Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research.␊ - */␊ - valueInteger?: number␊ - _valueInteger?: Element563␊ - /**␊ - * Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research.␊ - */␊ - valueDate?: string␊ - _valueDate?: Element564␊ - /**␊ - * Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research.␊ - */␊ - valueDateTime?: string␊ - _valueDateTime?: Element565␊ - /**␊ - * Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research.␊ - */␊ - valueTime?: string␊ - _valueTime?: Element566␊ - /**␊ - * Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research.␊ - */␊ - valueString?: string␊ - _valueString?: Element567␊ - /**␊ - * Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research.␊ - */␊ - valueUri?: string␊ - _valueUri?: Element568␊ - valueAttachment?: Attachment8␊ - valueCoding?: Coding12␊ - valueQuantity?: Quantity22␊ - valueReference?: Reference117␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element561 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element562 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element563 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element564 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element565 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element566 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element567 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element568 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * For referring to data content defined in other formats.␊ - */␊ - export interface Attachment8 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.␊ - */␊ - contentType?: string␊ - _contentType?: Element51␊ - /**␊ - * The human language of the content. The value can be any valid value according to BCP 47.␊ - */␊ - language?: string␊ - _language?: Element52␊ - /**␊ - * The actual data of the attachment - a sequence of bytes, base64 encoded.␊ - */␊ - data?: string␊ - _data?: Element53␊ - /**␊ - * A location where the data can be accessed.␊ - */␊ - url?: string␊ - _url?: Element54␊ - /**␊ - * The number of bytes of data that make up this attachment (before base64 encoding, if that is done).␊ - */␊ - size?: number␊ - _size?: Element55␊ - /**␊ - * The calculated hash of the data using SHA-1. Represented using base64.␊ - */␊ - hash?: string␊ - _hash?: Element56␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element57␊ - /**␊ - * The date that the attachment was first created.␊ - */␊ - creation?: string␊ - _creation?: Element58␊ - }␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - export interface Coding12 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The identification of the code system that defines the meaning of the symbol in the code.␊ - */␊ - system?: string␊ - _system?: Element39␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element40␊ - /**␊ - * A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).␊ - */␊ - code?: string␊ - _code?: Element41␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element42␊ - /**␊ - * Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).␊ - */␊ - userSelected?: boolean␊ - _userSelected?: Element43␊ - }␊ - /**␊ - * Response to an offer clause or question text, which enables selection of values to be agreed to, e.g., the period of participation, the date of occupancy of a rental, warrently duration, or whether biospecimen may be used for further research.␊ - */␊ - export interface Quantity22 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference117 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element569 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.␊ - */␊ - export interface Contract_Asset {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - scope?: CodeableConcept121␊ - /**␊ - * Target entity type about which the term may be concerned.␊ - */␊ - type?: CodeableConcept5[]␊ - /**␊ - * Associated entities.␊ - */␊ - typeReference?: Reference11[]␊ - /**␊ - * May be a subtype or part of an offered asset.␊ - */␊ - subtype?: CodeableConcept5[]␊ - relationship?: Coding13␊ - /**␊ - * Circumstance of the asset.␊ - */␊ - context?: Contract_Context[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - condition?: string␊ - _condition?: Element571␊ - /**␊ - * Type of Asset availability for use or ownership.␊ - */␊ - periodType?: CodeableConcept5[]␊ - /**␊ - * Asset relevant contractual time period.␊ - */␊ - period?: Period11[]␊ - /**␊ - * Time period of asset use.␊ - */␊ - usePeriod?: Period11[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element572␊ - /**␊ - * Id [identifier??] of the clause or question text about the asset in the referenced form or QuestionnaireResponse.␊ - */␊ - linkId?: String[]␊ - /**␊ - * Extensions for linkId␊ - */␊ - _linkId?: Element23[]␊ - /**␊ - * Response to assets.␊ - */␊ - answer?: Contract_Answer[]␊ - /**␊ - * Security labels that protects the asset.␊ - */␊ - securityLabelNumber?: UnsignedInt[]␊ - /**␊ - * Extensions for securityLabelNumber␊ - */␊ - _securityLabelNumber?: Element23[]␊ - /**␊ - * Contract Valued Item List.␊ - */␊ - valuedItem?: Contract_ValuedItem[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept121 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - export interface Coding13 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The identification of the code system that defines the meaning of the symbol in the code.␊ - */␊ - system?: string␊ - _system?: Element39␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element40␊ - /**␊ - * A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).␊ - */␊ - code?: string␊ - _code?: Element41␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element42␊ - /**␊ - * Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).␊ - */␊ - userSelected?: boolean␊ - _userSelected?: Element43␊ - }␊ - /**␊ - * Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.␊ - */␊ - export interface Contract_Context {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - reference?: Reference118␊ - /**␊ - * Coded representation of the context generally or of the Referenced entity, such as the asset holder type or location.␊ - */␊ - code?: CodeableConcept5[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element570␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference118 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element570 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element571 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element572 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.␊ - */␊ - export interface Contract_ValuedItem {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - entityCodeableConcept?: CodeableConcept122␊ - entityReference?: Reference119␊ - identifier?: Identifier13␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - effectiveTime?: string␊ - _effectiveTime?: Element573␊ - quantity?: Quantity23␊ - unitPrice?: Money20␊ - /**␊ - * A real number that represents a multiplier used in determining the overall value of the Contract Valued Item delivered. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.␊ - */␊ - factor?: number␊ - _factor?: Element574␊ - /**␊ - * An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the Contract Valued Item delivered. The concept of Points allows for assignment of point values for a Contract Valued Item, such that a monetary amount can be assigned to each point.␊ - */␊ - points?: number␊ - _points?: Element575␊ - net?: Money21␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - payment?: string␊ - _payment?: Element576␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - paymentDate?: string␊ - _paymentDate?: Element577␊ - responsible?: Reference120␊ - recipient?: Reference121␊ - /**␊ - * Id of the clause or question text related to the context of this valuedItem in the referenced form or QuestionnaireResponse.␊ - */␊ - linkId?: String[]␊ - /**␊ - * Extensions for linkId␊ - */␊ - _linkId?: Element23[]␊ - /**␊ - * A set of security labels that define which terms are controlled by this condition.␊ - */␊ - securityLabelNumber?: UnsignedInt[]␊ - /**␊ - * Extensions for securityLabelNumber␊ - */␊ - _securityLabelNumber?: Element23[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept122 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference119 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier13 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element573 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Specifies the units by which the Contract Valued Item is measured or counted, and quantifies the countable or measurable Contract Valued Item instances.␊ - */␊ - export interface Quantity23 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * A Contract Valued Item unit valuation measure.␊ - */␊ - export interface Money20 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element574 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element575 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Expresses the product of the Contract Valued Item unitQuantity and the unitPriceAmt. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.␊ - */␊ - export interface Money21 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element576 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element577 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference120 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference121 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.␊ - */␊ - export interface Contract_Action {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * True if the term prohibits the action.␊ - */␊ - doNotPerform?: boolean␊ - _doNotPerform?: Element578␊ - type: CodeableConcept123␊ - /**␊ - * Entity of the action.␊ - */␊ - subject?: Contract_Subject[]␊ - intent: CodeableConcept125␊ - /**␊ - * Id [identifier??] of the clause or question text related to this action in the referenced form or QuestionnaireResponse.␊ - */␊ - linkId?: String[]␊ - /**␊ - * Extensions for linkId␊ - */␊ - _linkId?: Element23[]␊ - status: CodeableConcept126␊ - context?: Reference122␊ - /**␊ - * Id [identifier??] of the clause or question text related to the requester of this action in the referenced form or QuestionnaireResponse.␊ - */␊ - contextLinkId?: String[]␊ - /**␊ - * Extensions for contextLinkId␊ - */␊ - _contextLinkId?: Element23[]␊ - /**␊ - * When action happens.␊ - */␊ - occurrenceDateTime?: string␊ - _occurrenceDateTime?: Element579␊ - occurrencePeriod?: Period38␊ - occurrenceTiming?: Timing6␊ - /**␊ - * Who or what initiated the action and has responsibility for its activation.␊ - */␊ - requester?: Reference11[]␊ - /**␊ - * Id [identifier??] of the clause or question text related to the requester of this action in the referenced form or QuestionnaireResponse.␊ - */␊ - requesterLinkId?: String[]␊ - /**␊ - * Extensions for requesterLinkId␊ - */␊ - _requesterLinkId?: Element23[]␊ - /**␊ - * The type of individual that is desired or required to perform or not perform the action.␊ - */␊ - performerType?: CodeableConcept5[]␊ - performerRole?: CodeableConcept127␊ - performer?: Reference123␊ - /**␊ - * Id [identifier??] of the clause or question text related to the reason type or reference of this action in the referenced form or QuestionnaireResponse.␊ - */␊ - performerLinkId?: String[]␊ - /**␊ - * Extensions for performerLinkId␊ - */␊ - _performerLinkId?: Element23[]␊ - /**␊ - * Rationale for the action to be performed or not performed. Describes why the action is permitted or prohibited.␊ - */␊ - reasonCode?: CodeableConcept5[]␊ - /**␊ - * Indicates another resource whose existence justifies permitting or not permitting this action.␊ - */␊ - reasonReference?: Reference11[]␊ - /**␊ - * Describes why the action is to be performed or not performed in textual form.␊ - */␊ - reason?: String[]␊ - /**␊ - * Extensions for reason␊ - */␊ - _reason?: Element23[]␊ - /**␊ - * Id [identifier??] of the clause or question text related to the reason type or reference of this action in the referenced form or QuestionnaireResponse.␊ - */␊ - reasonLinkId?: String[]␊ - /**␊ - * Extensions for reasonLinkId␊ - */␊ - _reasonLinkId?: Element23[]␊ - /**␊ - * Comments made about the term action made by the requester, performer, subject or other participants.␊ - */␊ - note?: Annotation1[]␊ - /**␊ - * Security labels that protects the action.␊ - */␊ - securityLabelNumber?: UnsignedInt[]␊ - /**␊ - * Extensions for securityLabelNumber␊ - */␊ - _securityLabelNumber?: Element23[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element578 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept123 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.␊ - */␊ - export interface Contract_Subject {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * The entity the action is performed or not performed on or for.␊ - */␊ - reference: Reference11[]␊ - role?: CodeableConcept124␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept124 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept125 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept126 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference122 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element579 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period38 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * When action happens.␊ - */␊ - export interface Timing6 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifies specific times when the event occurs.␊ - */␊ - event?: DateTime[]␊ - /**␊ - * Extensions for event␊ - */␊ - _event?: Element23[]␊ - repeat?: Timing_Repeat␊ - code?: CodeableConcept2␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept127 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference123 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.␊ - */␊ - export interface Contract_Signer {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - type: Coding14␊ - party: Reference124␊ - /**␊ - * Legally binding Contract DSIG signature contents in Base64.␊ - */␊ - signature: Signature1[]␊ - }␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - export interface Coding14 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The identification of the code system that defines the meaning of the symbol in the code.␊ - */␊ - system?: string␊ - _system?: Element39␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element40␊ - /**␊ - * A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).␊ - */␊ - code?: string␊ - _code?: Element41␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element42␊ - /**␊ - * Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).␊ - */␊ - userSelected?: boolean␊ - _userSelected?: Element43␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference124 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities.␊ - */␊ - export interface Signature1 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document.␊ - */␊ - type: Coding[]␊ - /**␊ - * When the digital signature was signed.␊ - */␊ - when?: string␊ - _when?: Element94␊ - who: Reference3␊ - onBehalfOf?: Reference4␊ - /**␊ - * A mime type that indicates the technical format of the target resources signed by the signature.␊ - */␊ - targetFormat?: string␊ - _targetFormat?: Element95␊ - /**␊ - * A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jose for JWS, and image/* for a graphical image of a signature, etc.␊ - */␊ - sigFormat?: string␊ - _sigFormat?: Element96␊ - /**␊ - * The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty.␊ - */␊ - data?: string␊ - _data?: Element97␊ - }␊ - /**␊ - * Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.␊ - */␊ - export interface Contract_Friendly {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - contentAttachment?: Attachment9␊ - contentReference?: Reference125␊ - }␊ - /**␊ - * For referring to data content defined in other formats.␊ - */␊ - export interface Attachment9 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.␊ - */␊ - contentType?: string␊ - _contentType?: Element51␊ - /**␊ - * The human language of the content. The value can be any valid value according to BCP 47.␊ - */␊ - language?: string␊ - _language?: Element52␊ - /**␊ - * The actual data of the attachment - a sequence of bytes, base64 encoded.␊ - */␊ - data?: string␊ - _data?: Element53␊ - /**␊ - * A location where the data can be accessed.␊ - */␊ - url?: string␊ - _url?: Element54␊ - /**␊ - * The number of bytes of data that make up this attachment (before base64 encoding, if that is done).␊ - */␊ - size?: number␊ - _size?: Element55␊ - /**␊ - * The calculated hash of the data using SHA-1. Represented using base64.␊ - */␊ - hash?: string␊ - _hash?: Element56␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element57␊ - /**␊ - * The date that the attachment was first created.␊ - */␊ - creation?: string␊ - _creation?: Element58␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference125 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.␊ - */␊ - export interface Contract_Legal {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - contentAttachment?: Attachment10␊ - contentReference?: Reference126␊ - }␊ - /**␊ - * For referring to data content defined in other formats.␊ - */␊ - export interface Attachment10 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.␊ - */␊ - contentType?: string␊ - _contentType?: Element51␊ - /**␊ - * The human language of the content. The value can be any valid value according to BCP 47.␊ - */␊ - language?: string␊ - _language?: Element52␊ - /**␊ - * The actual data of the attachment - a sequence of bytes, base64 encoded.␊ - */␊ - data?: string␊ - _data?: Element53␊ - /**␊ - * A location where the data can be accessed.␊ - */␊ - url?: string␊ - _url?: Element54␊ - /**␊ - * The number of bytes of data that make up this attachment (before base64 encoding, if that is done).␊ - */␊ - size?: number␊ - _size?: Element55␊ - /**␊ - * The calculated hash of the data using SHA-1. Represented using base64.␊ - */␊ - hash?: string␊ - _hash?: Element56␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element57␊ - /**␊ - * The date that the attachment was first created.␊ - */␊ - creation?: string␊ - _creation?: Element58␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference126 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.␊ - */␊ - export interface Contract_Rule {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - contentAttachment?: Attachment11␊ - contentReference?: Reference127␊ - }␊ - /**␊ - * For referring to data content defined in other formats.␊ - */␊ - export interface Attachment11 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.␊ - */␊ - contentType?: string␊ - _contentType?: Element51␊ - /**␊ - * The human language of the content. The value can be any valid value according to BCP 47.␊ - */␊ - language?: string␊ - _language?: Element52␊ - /**␊ - * The actual data of the attachment - a sequence of bytes, base64 encoded.␊ - */␊ - data?: string␊ - _data?: Element53␊ - /**␊ - * A location where the data can be accessed.␊ - */␊ - url?: string␊ - _url?: Element54␊ - /**␊ - * The number of bytes of data that make up this attachment (before base64 encoding, if that is done).␊ - */␊ - size?: number␊ - _size?: Element55␊ - /**␊ - * The calculated hash of the data using SHA-1. Represented using base64.␊ - */␊ - hash?: string␊ - _hash?: Element56␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element57␊ - /**␊ - * The date that the attachment was first created.␊ - */␊ - creation?: string␊ - _creation?: Element58␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference127 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * For referring to data content defined in other formats.␊ - */␊ - export interface Attachment12 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.␊ - */␊ - contentType?: string␊ - _contentType?: Element51␊ - /**␊ - * The human language of the content. The value can be any valid value according to BCP 47.␊ - */␊ - language?: string␊ - _language?: Element52␊ - /**␊ - * The actual data of the attachment - a sequence of bytes, base64 encoded.␊ - */␊ - data?: string␊ - _data?: Element53␊ - /**␊ - * A location where the data can be accessed.␊ - */␊ - url?: string␊ - _url?: Element54␊ - /**␊ - * The number of bytes of data that make up this attachment (before base64 encoding, if that is done).␊ - */␊ - size?: number␊ - _size?: Element55␊ - /**␊ - * The calculated hash of the data using SHA-1. Represented using base64.␊ - */␊ - hash?: string␊ - _hash?: Element56␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element57␊ - /**␊ - * The date that the attachment was first created.␊ - */␊ - creation?: string␊ - _creation?: Element58␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference128 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.␊ - */␊ - export interface Coverage {␊ - /**␊ - * This is a Coverage resource␊ - */␊ - resourceType: "Coverage"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta31␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element580␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element581␊ - text?: Narrative29␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A unique identifier assigned to this coverage.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - status?: string␊ - _status?: Element582␊ - type?: CodeableConcept128␊ - policyHolder?: Reference129␊ - subscriber?: Reference130␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - subscriberId?: string␊ - _subscriberId?: Element583␊ - beneficiary: Reference131␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - dependent?: string␊ - _dependent?: Element584␊ - relationship?: CodeableConcept129␊ - period?: Period39␊ - /**␊ - * The program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements.␊ - */␊ - payor: Reference11[]␊ - /**␊ - * A suite of underwriter specific classifiers.␊ - */␊ - class?: Coverage_Class[]␊ - /**␊ - * An integer with a value that is positive (e.g. >0)␊ - */␊ - order?: number␊ - _order?: Element587␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - network?: string␊ - _network?: Element588␊ - /**␊ - * A suite of codes indicating the cost category and associated amount which have been detailed in the policy and may have been included on the health card.␊ - */␊ - costToBeneficiary?: Coverage_CostToBeneficiary[]␊ - /**␊ - * When 'subrogation=true' this insurance instance has been included not for adjudication but to provide insurers with the details to recover costs.␊ - */␊ - subrogation?: boolean␊ - _subrogation?: Element589␊ - /**␊ - * The policy(s) which constitute this insurance coverage.␊ - */␊ - contract?: Reference11[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta31 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element580 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element581 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative29 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element582 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept128 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference129 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference130 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element583 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference131 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element584 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept129 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period39 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.␊ - */␊ - export interface Coverage_Class {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - type: CodeableConcept130␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element585␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element586␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept130 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element585 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element586 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element587 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element588 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.␊ - */␊ - export interface Coverage_CostToBeneficiary {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - type?: CodeableConcept131␊ - valueQuantity?: Quantity24␊ - valueMoney?: Money22␊ - /**␊ - * A suite of codes indicating exceptions or reductions to patient costs and their effective periods.␊ - */␊ - exception?: Coverage_Exception[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept131 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * The amount due from the patient for the cost category.␊ - */␊ - export interface Quantity24 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * The amount due from the patient for the cost category.␊ - */␊ - export interface Money22 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.␊ - */␊ - export interface Coverage_Exception {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - type: CodeableConcept132␊ - period?: Period40␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept132 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period40 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element589 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The CoverageEligibilityRequest provides patient and insurance coverage information to an insurer for them to respond, in the form of an CoverageEligibilityResponse, with information regarding whether the stated coverage is valid and in-force and optionally to provide the insurance details of the policy.␊ - */␊ - export interface CoverageEligibilityRequest {␊ - /**␊ - * This is a CoverageEligibilityRequest resource␊ - */␊ - resourceType: "CoverageEligibilityRequest"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta32␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element590␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element591␊ - text?: Narrative30␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A unique identifier assigned to this coverage eligiblity request.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - status?: string␊ - _status?: Element592␊ - priority?: CodeableConcept133␊ - /**␊ - * Code to specify whether requesting: prior authorization requirements for some service categories or billing codes; benefits for coverages specified or discovered; discovery and return of coverages for the patient; and/or validation that the specified coverage is in-force at the date/period specified or 'now' if not specified.␊ - */␊ - purpose?: ("auth-requirements" | "benefits" | "discovery" | "validation")[]␊ - /**␊ - * Extensions for purpose␊ - */␊ - _purpose?: Element23[]␊ - patient: Reference132␊ - /**␊ - * The date or dates when the enclosed suite of services were performed or completed.␊ - */␊ - servicedDate?: string␊ - _servicedDate?: Element593␊ - servicedPeriod?: Period41␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - created?: string␊ - _created?: Element594␊ - enterer?: Reference133␊ - provider?: Reference134␊ - insurer: Reference135␊ - facility?: Reference136␊ - /**␊ - * Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.␊ - */␊ - supportingInfo?: CoverageEligibilityRequest_SupportingInfo[]␊ - /**␊ - * Financial instruments for reimbursement for the health care products and services.␊ - */␊ - insurance?: CoverageEligibilityRequest_Insurance[]␊ - /**␊ - * Service categories or billable services for which benefit details and/or an authorization prior to service delivery may be required by the payor.␊ - */␊ - item?: CoverageEligibilityRequest_Item[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta32 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element590 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element591 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative30 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element592 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept133 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference132 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element593 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period41 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element594 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference133 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference134 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference135 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference136 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * The CoverageEligibilityRequest provides patient and insurance coverage information to an insurer for them to respond, in the form of an CoverageEligibilityResponse, with information regarding whether the stated coverage is valid and in-force and optionally to provide the insurance details of the policy.␊ - */␊ - export interface CoverageEligibilityRequest_SupportingInfo {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * An integer with a value that is positive (e.g. >0)␊ - */␊ - sequence?: number␊ - _sequence?: Element595␊ - information: Reference137␊ - /**␊ - * The supporting materials are applicable for all detail items, product/servce categories and specific billing codes.␊ - */␊ - appliesToAll?: boolean␊ - _appliesToAll?: Element596␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element595 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference137 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element596 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The CoverageEligibilityRequest provides patient and insurance coverage information to an insurer for them to respond, in the form of an CoverageEligibilityResponse, with information regarding whether the stated coverage is valid and in-force and optionally to provide the insurance details of the policy.␊ - */␊ - export interface CoverageEligibilityRequest_Insurance {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A flag to indicate that this Coverage is to be used for evaluation of this request when set to true.␊ - */␊ - focal?: boolean␊ - _focal?: Element597␊ - coverage: Reference138␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - businessArrangement?: string␊ - _businessArrangement?: Element598␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element597 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference138 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element598 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The CoverageEligibilityRequest provides patient and insurance coverage information to an insurer for them to respond, in the form of an CoverageEligibilityResponse, with information regarding whether the stated coverage is valid and in-force and optionally to provide the insurance details of the policy.␊ - */␊ - export interface CoverageEligibilityRequest_Item {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Exceptions, special conditions and supporting information applicable for this service or product line.␊ - */␊ - supportingInfoSequence?: PositiveInt[]␊ - /**␊ - * Extensions for supportingInfoSequence␊ - */␊ - _supportingInfoSequence?: Element23[]␊ - category?: CodeableConcept134␊ - productOrService?: CodeableConcept135␊ - /**␊ - * Item typification or modifiers codes to convey additional context for the product or service.␊ - */␊ - modifier?: CodeableConcept5[]␊ - provider?: Reference139␊ - quantity?: Quantity25␊ - unitPrice?: Money23␊ - facility?: Reference140␊ - /**␊ - * Patient diagnosis for which care is sought.␊ - */␊ - diagnosis?: CoverageEligibilityRequest_Diagnosis[]␊ - /**␊ - * The plan/proposal/order describing the proposed service in detail.␊ - */␊ - detail?: Reference11[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept134 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept135 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference139 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * The number of repetitions of a service or product.␊ - */␊ - export interface Quantity25 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * The amount charged to the patient by the provider for a single unit.␊ - */␊ - export interface Money23 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference140 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * The CoverageEligibilityRequest provides patient and insurance coverage information to an insurer for them to respond, in the form of an CoverageEligibilityResponse, with information regarding whether the stated coverage is valid and in-force and optionally to provide the insurance details of the policy.␊ - */␊ - export interface CoverageEligibilityRequest_Diagnosis {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - diagnosisCodeableConcept?: CodeableConcept136␊ - diagnosisReference?: Reference141␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept136 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference141 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * This resource provides eligibility and plan details from the processing of an CoverageEligibilityRequest resource.␊ - */␊ - export interface CoverageEligibilityResponse {␊ - /**␊ - * This is a CoverageEligibilityResponse resource␊ - */␊ - resourceType: "CoverageEligibilityResponse"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta33␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element599␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element600␊ - text?: Narrative31␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A unique identifier assigned to this coverage eligiblity request.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - status?: string␊ - _status?: Element601␊ - /**␊ - * Code to specify whether requesting: prior authorization requirements for some service categories or billing codes; benefits for coverages specified or discovered; discovery and return of coverages for the patient; and/or validation that the specified coverage is in-force at the date/period specified or 'now' if not specified.␊ - */␊ - purpose?: ("auth-requirements" | "benefits" | "discovery" | "validation")[]␊ - /**␊ - * Extensions for purpose␊ - */␊ - _purpose?: Element23[]␊ - patient: Reference142␊ - /**␊ - * The date or dates when the enclosed suite of services were performed or completed.␊ - */␊ - servicedDate?: string␊ - _servicedDate?: Element602␊ - servicedPeriod?: Period42␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - created?: string␊ - _created?: Element603␊ - requestor?: Reference143␊ - request: Reference144␊ - /**␊ - * The outcome of the request processing.␊ - */␊ - outcome?: ("queued" | "complete" | "error" | "partial")␊ - _outcome?: Element604␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - disposition?: string␊ - _disposition?: Element605␊ - insurer: Reference145␊ - /**␊ - * Financial instruments for reimbursement for the health care products and services.␊ - */␊ - insurance?: CoverageEligibilityResponse_Insurance[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - preAuthRef?: string␊ - _preAuthRef?: Element616␊ - form?: CodeableConcept143␊ - /**␊ - * Errors encountered during the processing of the request.␊ - */␊ - error?: CoverageEligibilityResponse_Error[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta33 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element599 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element600 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative31 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element601 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference142 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element602 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period42 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element603 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference143 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference144 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element604 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element605 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference145 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * This resource provides eligibility and plan details from the processing of an CoverageEligibilityRequest resource.␊ - */␊ - export interface CoverageEligibilityResponse_Insurance {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - coverage: Reference146␊ - /**␊ - * Flag indicating if the coverage provided is inforce currently if no service date(s) specified or for the whole duration of the service dates.␊ - */␊ - inforce?: boolean␊ - _inforce?: Element606␊ - benefitPeriod?: Period43␊ - /**␊ - * Benefits and optionally current balances, and authorization details by category or service.␊ - */␊ - item?: CoverageEligibilityResponse_Item[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference146 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element606 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period43 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * This resource provides eligibility and plan details from the processing of an CoverageEligibilityRequest resource.␊ - */␊ - export interface CoverageEligibilityResponse_Item {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - category?: CodeableConcept137␊ - productOrService?: CodeableConcept138␊ - /**␊ - * Item typification or modifiers codes to convey additional context for the product or service.␊ - */␊ - modifier?: CodeableConcept5[]␊ - provider?: Reference147␊ - /**␊ - * True if the indicated class of service is excluded from the plan, missing or False indicates the product or service is included in the coverage.␊ - */␊ - excluded?: boolean␊ - _excluded?: Element607␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element608␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element609␊ - network?: CodeableConcept139␊ - unit?: CodeableConcept140␊ - term?: CodeableConcept141␊ - /**␊ - * Benefits used to date.␊ - */␊ - benefit?: CoverageEligibilityResponse_Benefit[]␊ - /**␊ - * A boolean flag indicating whether a preauthorization is required prior to actual service delivery.␊ - */␊ - authorizationRequired?: boolean␊ - _authorizationRequired?: Element614␊ - /**␊ - * Codes or comments regarding information or actions associated with the preauthorization.␊ - */␊ - authorizationSupporting?: CodeableConcept5[]␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - authorizationUrl?: string␊ - _authorizationUrl?: Element615␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept137 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept138 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference147 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element607 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element608 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element609 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept139 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept140 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept141 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * This resource provides eligibility and plan details from the processing of an CoverageEligibilityRequest resource.␊ - */␊ - export interface CoverageEligibilityResponse_Benefit {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - type: CodeableConcept142␊ - /**␊ - * The quantity of the benefit which is permitted under the coverage.␊ - */␊ - allowedUnsignedInt?: number␊ - _allowedUnsignedInt?: Element610␊ - /**␊ - * The quantity of the benefit which is permitted under the coverage.␊ - */␊ - allowedString?: string␊ - _allowedString?: Element611␊ - allowedMoney?: Money24␊ - /**␊ - * The quantity of the benefit which have been consumed to date.␊ - */␊ - usedUnsignedInt?: number␊ - _usedUnsignedInt?: Element612␊ - /**␊ - * The quantity of the benefit which have been consumed to date.␊ - */␊ - usedString?: string␊ - _usedString?: Element613␊ - usedMoney?: Money25␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept142 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element610 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element611 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The quantity of the benefit which is permitted under the coverage.␊ - */␊ - export interface Money24 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element612 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element613 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The quantity of the benefit which have been consumed to date.␊ - */␊ - export interface Money25 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element614 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element615 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element616 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept143 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * This resource provides eligibility and plan details from the processing of an CoverageEligibilityRequest resource.␊ - */␊ - export interface CoverageEligibilityResponse_Error {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - code: CodeableConcept144␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept144 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, Ineffective treatment frequency, Procedure-condition conflict, etc.␊ - */␊ - export interface DetectedIssue {␊ - /**␊ - * This is a DetectedIssue resource␊ - */␊ - resourceType: "DetectedIssue"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta34␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element617␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element618␊ - text?: Narrative32␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Business identifier associated with the detected issue record.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - status?: string␊ - _status?: Element619␊ - code?: CodeableConcept145␊ - /**␊ - * Indicates the degree of importance associated with the identified issue based on the potential impact on the patient.␊ - */␊ - severity?: ("high" | "moderate" | "low")␊ - _severity?: Element620␊ - patient?: Reference148␊ - /**␊ - * The date or period when the detected issue was initially identified.␊ - */␊ - identifiedDateTime?: string␊ - _identifiedDateTime?: Element621␊ - identifiedPeriod?: Period44␊ - author?: Reference149␊ - /**␊ - * Indicates the resource representing the current activity or proposed activity that is potentially problematic.␊ - */␊ - implicated?: Reference11[]␊ - /**␊ - * Supporting evidence or manifestations that provide the basis for identifying the detected issue such as a GuidanceResponse or MeasureReport.␊ - */␊ - evidence?: DetectedIssue_Evidence[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - detail?: string␊ - _detail?: Element622␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - reference?: string␊ - _reference?: Element623␊ - /**␊ - * Indicates an action that has been taken or is committed to reduce or eliminate the likelihood of the risk identified by the detected issue from manifesting. Can also reflect an observation of known mitigating factors that may reduce/eliminate the need for any action.␊ - */␊ - mitigation?: DetectedIssue_Mitigation[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta34 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element617 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element618 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative32 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element619 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept145 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element620 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference148 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element621 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period44 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference149 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, Ineffective treatment frequency, Procedure-condition conflict, etc.␊ - */␊ - export interface DetectedIssue_Evidence {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A manifestation that led to the recording of this detected issue.␊ - */␊ - code?: CodeableConcept5[]␊ - /**␊ - * Links to resources that constitute evidence for the detected issue such as a GuidanceResponse or MeasureReport.␊ - */␊ - detail?: Reference11[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element622 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element623 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, Ineffective treatment frequency, Procedure-condition conflict, etc.␊ - */␊ - export interface DetectedIssue_Mitigation {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - action: CodeableConcept146␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - date?: string␊ - _date?: Element624␊ - author?: Reference150␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept146 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element624 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference150 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.␊ - */␊ - export interface Device {␊ - /**␊ - * This is a Device resource␊ - */␊ - resourceType: "Device"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta35␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element625␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element626␊ - text?: Narrative33␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Unique instance identifiers assigned to a device by manufacturers other organizations or owners.␊ - */␊ - identifier?: Identifier2[]␊ - definition?: Reference151␊ - /**␊ - * Unique device identifier (UDI) assigned to device label or package. Note that the Device may include multiple udiCarriers as it either may include just the udiCarrier for the jurisdiction it is sold, or for multiple jurisdictions it could have been sold.␊ - */␊ - udiCarrier?: Device_UdiCarrier[]␊ - /**␊ - * Status of the Device availability.␊ - */␊ - status?: ("active" | "inactive" | "entered-in-error" | "unknown")␊ - _status?: Element633␊ - /**␊ - * Reason for the dtatus of the Device availability.␊ - */␊ - statusReason?: CodeableConcept5[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - distinctIdentifier?: string␊ - _distinctIdentifier?: Element634␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - manufacturer?: string␊ - _manufacturer?: Element635␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - manufactureDate?: string␊ - _manufactureDate?: Element636␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - expirationDate?: string␊ - _expirationDate?: Element637␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - lotNumber?: string␊ - _lotNumber?: Element638␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - serialNumber?: string␊ - _serialNumber?: Element639␊ - /**␊ - * This represents the manufacturer's name of the device as provided by the device, from a UDI label, or by a person describing the Device. This typically would be used when a person provides the name(s) or when the device represents one of the names available from DeviceDefinition.␊ - */␊ - deviceName?: Device_DeviceName[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - modelNumber?: string␊ - _modelNumber?: Element642␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - partNumber?: string␊ - _partNumber?: Element643␊ - type?: CodeableConcept147␊ - /**␊ - * The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication.␊ - */␊ - specialization?: Device_Specialization[]␊ - /**␊ - * The actual design of the device or software version running on the device.␊ - */␊ - version?: Device_Version[]␊ - /**␊ - * The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.␊ - */␊ - property?: Device_Property[]␊ - patient?: Reference152␊ - owner?: Reference153␊ - /**␊ - * Contact details for an organization or a particular human that is responsible for the device.␊ - */␊ - contact?: ContactPoint1[]␊ - location?: Reference154␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - url?: string␊ - _url?: Element646␊ - /**␊ - * Descriptive information, usage information or implantation information that is not captured in an existing element.␊ - */␊ - note?: Annotation1[]␊ - /**␊ - * Provides additional safety characteristics about a medical device. For example devices containing latex.␊ - */␊ - safety?: CodeableConcept5[]␊ - parent?: Reference155␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta35 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element625 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element626 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative33 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference151 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.␊ - */␊ - export interface Device_UdiCarrier {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - deviceIdentifier?: string␊ - _deviceIdentifier?: Element627␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - issuer?: string␊ - _issuer?: Element628␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - jurisdiction?: string␊ - _jurisdiction?: Element629␊ - /**␊ - * The full UDI carrier of the Automatic Identification and Data Capture (AIDC) technology representation of the barcode string as printed on the packaging of the device - e.g., a barcode or RFID. Because of limitations on character sets in XML and the need to round-trip JSON data through XML, AIDC Formats *SHALL* be base64 encoded.␊ - */␊ - carrierAIDC?: string␊ - _carrierAIDC?: Element630␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - carrierHRF?: string␊ - _carrierHRF?: Element631␊ - /**␊ - * A coded entry to indicate how the data was entered.␊ - */␊ - entryType?: ("barcode" | "rfid" | "manual" | "card" | "self-reported" | "unknown")␊ - _entryType?: Element632␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element627 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element628 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element629 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element630 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element631 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element632 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element633 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element634 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element635 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element636 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element637 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element638 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element639 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.␊ - */␊ - export interface Device_DeviceName {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element640␊ - /**␊ - * The type of deviceName.␊ - * UDILabelName | UserFriendlyName | PatientReportedName | ManufactureDeviceName | ModelName.␊ - */␊ - type?: ("udi-label-name" | "user-friendly-name" | "patient-reported-name" | "manufacturer-name" | "model-name" | "other")␊ - _type?: Element641␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element640 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element641 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element642 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element643 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept147 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.␊ - */␊ - export interface Device_Specialization {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - systemType: CodeableConcept148␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element644␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept148 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element644 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.␊ - */␊ - export interface Device_Version {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - type?: CodeableConcept149␊ - component?: Identifier14␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element645␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept149 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier14 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element645 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.␊ - */␊ - export interface Device_Property {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - type: CodeableConcept150␊ - /**␊ - * Property value as a quantity.␊ - */␊ - valueQuantity?: Quantity26[]␊ - /**␊ - * Property value as a code, e.g., NTP4 (synced to NTP).␊ - */␊ - valueCode?: CodeableConcept5[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept150 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity26 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference152 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference153 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference154 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element646 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference155 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * The characteristics, operational status and capabilities of a medical-related component of a medical device.␊ - */␊ - export interface DeviceDefinition {␊ - /**␊ - * This is a DeviceDefinition resource␊ - */␊ - resourceType: "DeviceDefinition"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta36␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element647␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element648␊ - text?: Narrative34␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Unique instance identifiers assigned to a device by the software, manufacturers, other organizations or owners. For example: handle ID.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * Unique device identifier (UDI) assigned to device label or package. Note that the Device may include multiple udiCarriers as it either may include just the udiCarrier for the jurisdiction it is sold, or for multiple jurisdictions it could have been sold.␊ - */␊ - udiDeviceIdentifier?: DeviceDefinition_UdiDeviceIdentifier[]␊ - /**␊ - * A name of the manufacturer.␊ - */␊ - manufacturerString?: string␊ - _manufacturerString?: Element652␊ - manufacturerReference?: Reference156␊ - /**␊ - * A name given to the device to identify it.␊ - */␊ - deviceName?: DeviceDefinition_DeviceName[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - modelNumber?: string␊ - _modelNumber?: Element655␊ - type?: CodeableConcept151␊ - /**␊ - * The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication.␊ - */␊ - specialization?: DeviceDefinition_Specialization[]␊ - /**␊ - * The available versions of the device, e.g., software versions.␊ - */␊ - version?: String[]␊ - /**␊ - * Extensions for version␊ - */␊ - _version?: Element23[]␊ - /**␊ - * Safety characteristics of the device.␊ - */␊ - safety?: CodeableConcept5[]␊ - /**␊ - * Shelf Life and storage information.␊ - */␊ - shelfLifeStorage?: ProductShelfLife[]␊ - physicalCharacteristics?: ProdCharacteristic␊ - /**␊ - * Language code for the human-readable text strings produced by the device (all supported).␊ - */␊ - languageCode?: CodeableConcept5[]␊ - /**␊ - * Device capabilities.␊ - */␊ - capability?: DeviceDefinition_Capability[]␊ - /**␊ - * The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.␊ - */␊ - property?: DeviceDefinition_Property[]␊ - owner?: Reference157␊ - /**␊ - * Contact details for an organization or a particular human that is responsible for the device.␊ - */␊ - contact?: ContactPoint1[]␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - url?: string␊ - _url?: Element659␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - onlineInformation?: string␊ - _onlineInformation?: Element660␊ - /**␊ - * Descriptive information, usage information or implantation information that is not captured in an existing element.␊ - */␊ - note?: Annotation1[]␊ - quantity?: Quantity34␊ - parentDevice?: Reference158␊ - /**␊ - * A substance used to create the material(s) of which the device is made.␊ - */␊ - material?: DeviceDefinition_Material[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta36 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element647 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element648 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative34 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * The characteristics, operational status and capabilities of a medical-related component of a medical device.␊ - */␊ - export interface DeviceDefinition_UdiDeviceIdentifier {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - deviceIdentifier?: string␊ - _deviceIdentifier?: Element649␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - issuer?: string␊ - _issuer?: Element650␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - jurisdiction?: string␊ - _jurisdiction?: Element651␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element649 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element650 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element651 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element652 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference156 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * The characteristics, operational status and capabilities of a medical-related component of a medical device.␊ - */␊ - export interface DeviceDefinition_DeviceName {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element653␊ - /**␊ - * The type of deviceName.␊ - * UDILabelName | UserFriendlyName | PatientReportedName | ManufactureDeviceName | ModelName.␊ - */␊ - type?: ("udi-label-name" | "user-friendly-name" | "patient-reported-name" | "manufacturer-name" | "model-name" | "other")␊ - _type?: Element654␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element653 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element654 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element655 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept151 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * The characteristics, operational status and capabilities of a medical-related component of a medical device.␊ - */␊ - export interface DeviceDefinition_Specialization {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - systemType?: string␊ - _systemType?: Element656␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element657␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element656 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element657 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The shelf-life and storage information for a medicinal product item or container can be described using this class.␊ - */␊ - export interface ProductShelfLife {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - identifier?: Identifier15␊ - type: CodeableConcept152␊ - period: Quantity27␊ - /**␊ - * Special precautions for storage, if any, can be specified using an appropriate controlled vocabulary The controlled term and the controlled term identifier shall be specified.␊ - */␊ - specialPrecautionsForStorage?: CodeableConcept5[]␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier15 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept152 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity27 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * Dimensions, color etc.␊ - */␊ - export interface ProdCharacteristic {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - height?: Quantity28␊ - width?: Quantity29␊ - depth?: Quantity30␊ - weight?: Quantity31␊ - nominalVolume?: Quantity32␊ - externalDiameter?: Quantity33␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - shape?: string␊ - _shape?: Element658␊ - /**␊ - * Where applicable, the color can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used.␊ - */␊ - color?: String[]␊ - /**␊ - * Extensions for color␊ - */␊ - _color?: Element23[]␊ - /**␊ - * Where applicable, the imprint can be specified as text.␊ - */␊ - imprint?: String[]␊ - /**␊ - * Extensions for imprint␊ - */␊ - _imprint?: Element23[]␊ - /**␊ - * Where applicable, the image can be provided The format of the image attachment shall be specified by regional implementations.␊ - */␊ - image?: Attachment2[]␊ - scoring?: CodeableConcept153␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity28 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity29 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity30 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity31 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity32 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity33 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element658 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept153 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * The characteristics, operational status and capabilities of a medical-related component of a medical device.␊ - */␊ - export interface DeviceDefinition_Capability {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - type: CodeableConcept154␊ - /**␊ - * Description of capability.␊ - */␊ - description?: CodeableConcept5[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept154 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * The characteristics, operational status and capabilities of a medical-related component of a medical device.␊ - */␊ - export interface DeviceDefinition_Property {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - type: CodeableConcept155␊ - /**␊ - * Property value as a quantity.␊ - */␊ - valueQuantity?: Quantity26[]␊ - /**␊ - * Property value as a code, e.g., NTP4 (synced to NTP).␊ - */␊ - valueCode?: CodeableConcept5[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept155 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference157 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element659 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element660 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity34 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference158 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * The characteristics, operational status and capabilities of a medical-related component of a medical device.␊ - */␊ - export interface DeviceDefinition_Material {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - substance: CodeableConcept156␊ - /**␊ - * Indicates an alternative material of the device.␊ - */␊ - alternate?: boolean␊ - _alternate?: Element661␊ - /**␊ - * Whether the substance is a known or suspected allergen.␊ - */␊ - allergenicIndicator?: boolean␊ - _allergenicIndicator?: Element662␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept156 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element661 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element662 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Describes a measurement, calculation or setting capability of a medical device.␊ - */␊ - export interface DeviceMetric {␊ - /**␊ - * This is a DeviceMetric resource␊ - */␊ - resourceType: "DeviceMetric"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta37␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element663␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element664␊ - text?: Narrative35␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Unique instance identifiers assigned to a device by the device or gateway software, manufacturers, other organizations or owners. For example: handle ID.␊ - */␊ - identifier?: Identifier2[]␊ - type: CodeableConcept157␊ - unit?: CodeableConcept158␊ - source?: Reference159␊ - parent?: Reference160␊ - /**␊ - * Indicates current operational state of the device. For example: On, Off, Standby, etc.␊ - */␊ - operationalStatus?: ("on" | "off" | "standby" | "entered-in-error")␊ - _operationalStatus?: Element665␊ - /**␊ - * Describes the color representation for the metric. This is often used to aid clinicians to track and identify parameter types by color. In practice, consider a Patient Monitor that has ECG/HR and Pleth for example; the parameters are displayed in different characteristic colors, such as HR-blue, BP-green, and PR and SpO2- magenta.␊ - */␊ - color?: ("black" | "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white")␊ - _color?: Element666␊ - /**␊ - * Indicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation.␊ - */␊ - category?: ("measurement" | "setting" | "calculation" | "unspecified")␊ - _category?: Element667␊ - measurementPeriod?: Timing7␊ - /**␊ - * Describes the calibrations that have been performed or that are required to be performed.␊ - */␊ - calibration?: DeviceMetric_Calibration[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta37 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element663 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element664 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative35 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept157 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept158 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference159 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference160 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element665 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element666 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element667 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Describes the measurement repetition time. This is not necessarily the same as the update period. The measurement repetition time can range from milliseconds up to hours. An example for a measurement repetition time in the range of milliseconds is the sampling rate of an ECG. An example for a measurement repetition time in the range of hours is a NIBP that is triggered automatically every hour. The update period may be different than the measurement repetition time, if the device does not update the published observed value with the same frequency as it was measured.␊ - */␊ - export interface Timing7 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifies specific times when the event occurs.␊ - */␊ - event?: DateTime[]␊ - /**␊ - * Extensions for event␊ - */␊ - _event?: Element23[]␊ - repeat?: Timing_Repeat␊ - code?: CodeableConcept2␊ - }␊ - /**␊ - * Describes a measurement, calculation or setting capability of a medical device.␊ - */␊ - export interface DeviceMetric_Calibration {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Describes the type of the calibration method.␊ - */␊ - type?: ("unspecified" | "offset" | "gain" | "two-point")␊ - _type?: Element668␊ - /**␊ - * Describes the state of the calibration.␊ - */␊ - state?: ("not-calibrated" | "calibration-required" | "calibrated" | "unspecified")␊ - _state?: Element669␊ - /**␊ - * Describes the time last calibration has been performed.␊ - */␊ - time?: string␊ - _time?: Element670␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element668 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element669 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element670 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Represents a request for a patient to employ a medical device. The device may be an implantable device, or an external assistive device, such as a walker.␊ - */␊ - export interface DeviceRequest {␊ - /**␊ - * This is a DeviceRequest resource␊ - */␊ - resourceType: "DeviceRequest"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta38␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element671␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element672␊ - text?: Narrative36␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifiers assigned to this order by the orderer or by the receiver.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest.␊ - */␊ - instantiatesCanonical?: Canonical[]␊ - /**␊ - * The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest.␊ - */␊ - instantiatesUri?: Uri[]␊ - /**␊ - * Extensions for instantiatesUri␊ - */␊ - _instantiatesUri?: Element23[]␊ - /**␊ - * Plan/proposal/order fulfilled by this request.␊ - */␊ - basedOn?: Reference11[]␊ - /**␊ - * The request takes the place of the referenced completed or terminated request(s).␊ - */␊ - priorRequest?: Reference11[]␊ - groupIdentifier?: Identifier16␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - status?: string␊ - _status?: Element673␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - intent?: string␊ - _intent?: Element674␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - priority?: string␊ - _priority?: Element675␊ - codeReference?: Reference161␊ - codeCodeableConcept?: CodeableConcept159␊ - /**␊ - * Specific parameters for the ordered item. For example, the prism value for lenses.␊ - */␊ - parameter?: DeviceRequest_Parameter[]␊ - subject: Reference162␊ - encounter?: Reference163␊ - /**␊ - * The timing schedule for the use of the device. The Schedule data type allows many different expressions, for example. "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013".␊ - */␊ - occurrenceDateTime?: string␊ - _occurrenceDateTime?: Element677␊ - occurrencePeriod?: Period45␊ - occurrenceTiming?: Timing8␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - authoredOn?: string␊ - _authoredOn?: Element678␊ - requester?: Reference164␊ - performerType?: CodeableConcept162␊ - performer?: Reference165␊ - /**␊ - * Reason or justification for the use of this device.␊ - */␊ - reasonCode?: CodeableConcept5[]␊ - /**␊ - * Reason or justification for the use of this device.␊ - */␊ - reasonReference?: Reference11[]␊ - /**␊ - * Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.␊ - */␊ - insurance?: Reference11[]␊ - /**␊ - * Additional clinical information about the patient that may influence the request fulfilment. For example, this may include where on the subject's body the device will be used (i.e. the target site).␊ - */␊ - supportingInfo?: Reference11[]␊ - /**␊ - * Details about this request that were not represented at all or sufficiently in one of the attributes provided in a class. These may include for example a comment, an instruction, or a note associated with the statement.␊ - */␊ - note?: Annotation1[]␊ - /**␊ - * Key events in the history of the request.␊ - */␊ - relevantHistory?: Reference11[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta38 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element671 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element672 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative36 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier16 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element673 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element674 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element675 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference161 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept159 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Represents a request for a patient to employ a medical device. The device may be an implantable device, or an external assistive device, such as a walker.␊ - */␊ - export interface DeviceRequest_Parameter {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - code?: CodeableConcept160␊ - valueCodeableConcept?: CodeableConcept161␊ - valueQuantity?: Quantity35␊ - valueRange?: Range9␊ - /**␊ - * The value of the device detail.␊ - */␊ - valueBoolean?: boolean␊ - _valueBoolean?: Element676␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept160 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept161 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity35 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * The value of the device detail.␊ - */␊ - export interface Range9 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - low?: Quantity1␊ - high?: Quantity2␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element676 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference162 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference163 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element677 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period45 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * The timing schedule for the use of the device. The Schedule data type allows many different expressions, for example. "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013".␊ - */␊ - export interface Timing8 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifies specific times when the event occurs.␊ - */␊ - event?: DateTime[]␊ - /**␊ - * Extensions for event␊ - */␊ - _event?: Element23[]␊ - repeat?: Timing_Repeat␊ - code?: CodeableConcept2␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element678 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference164 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept162 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference165 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A record of a device being used by a patient where the record is the result of a report from the patient or another clinician.␊ - */␊ - export interface DeviceUseStatement {␊ - /**␊ - * This is a DeviceUseStatement resource␊ - */␊ - resourceType: "DeviceUseStatement"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta39␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element679␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element680␊ - text?: Narrative37␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * An external identifier for this statement such as an IRI.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * A plan, proposal or order that is fulfilled in whole or in part by this DeviceUseStatement.␊ - */␊ - basedOn?: Reference11[]␊ - /**␊ - * A code representing the patient or other source's judgment about the state of the device used that this statement is about. Generally this will be active or completed.␊ - */␊ - status?: ("active" | "completed" | "entered-in-error" | "intended" | "stopped" | "on-hold")␊ - _status?: Element681␊ - subject: Reference166␊ - /**␊ - * Allows linking the DeviceUseStatement to the underlying Request, or to other information that supports or is used to derive the DeviceUseStatement.␊ - */␊ - derivedFrom?: Reference11[]␊ - timingTiming?: Timing9␊ - timingPeriod?: Period46␊ - /**␊ - * How often the device was used.␊ - */␊ - timingDateTime?: string␊ - _timingDateTime?: Element682␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - recordedOn?: string␊ - _recordedOn?: Element683␊ - source?: Reference167␊ - device: Reference168␊ - /**␊ - * Reason or justification for the use of the device.␊ - */␊ - reasonCode?: CodeableConcept5[]␊ - /**␊ - * Indicates another resource whose existence justifies this DeviceUseStatement.␊ - */␊ - reasonReference?: Reference11[]␊ - bodySite?: CodeableConcept163␊ - /**␊ - * Details about the device statement that were not represented at all or sufficiently in one of the attributes provided in a class. These may include for example a comment, an instruction, or a note associated with the statement.␊ - */␊ - note?: Annotation1[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta39 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element679 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element680 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative37 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element681 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference166 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * How often the device was used.␊ - */␊ - export interface Timing9 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifies specific times when the event occurs.␊ - */␊ - event?: DateTime[]␊ - /**␊ - * Extensions for event␊ - */␊ - _event?: Element23[]␊ - repeat?: Timing_Repeat␊ - code?: CodeableConcept2␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period46 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element682 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element683 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference167 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference168 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept163 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * The findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports.␊ - */␊ - export interface DiagnosticReport {␊ - /**␊ - * This is a DiagnosticReport resource␊ - */␊ - resourceType: "DiagnosticReport"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta40␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element684␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element685␊ - text?: Narrative38␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifiers assigned to this report by the performer or other systems.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * Details concerning a service requested.␊ - */␊ - basedOn?: Reference11[]␊ - /**␊ - * The status of the diagnostic report.␊ - */␊ - status?: ("registered" | "partial" | "preliminary" | "final" | "amended" | "corrected" | "appended" | "cancelled" | "entered-in-error" | "unknown")␊ - _status?: Element686␊ - /**␊ - * A code that classifies the clinical discipline, department or diagnostic service that created the report (e.g. cardiology, biochemistry, hematology, MRI). This is used for searching, sorting and display purposes.␊ - */␊ - category?: CodeableConcept5[]␊ - code: CodeableConcept164␊ - subject?: Reference169␊ - encounter?: Reference170␊ - /**␊ - * The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself.␊ - */␊ - effectiveDateTime?: string␊ - _effectiveDateTime?: Element687␊ - effectivePeriod?: Period47␊ - /**␊ - * The date and time that this version of the report was made available to providers, typically after the report was reviewed and verified.␊ - */␊ - issued?: string␊ - _issued?: Element688␊ - /**␊ - * The diagnostic service that is responsible for issuing the report.␊ - */␊ - performer?: Reference11[]␊ - /**␊ - * The practitioner or organization that is responsible for the report's conclusions and interpretations.␊ - */␊ - resultsInterpreter?: Reference11[]␊ - /**␊ - * Details about the specimens on which this diagnostic report is based.␊ - */␊ - specimen?: Reference11[]␊ - /**␊ - * [Observations](observation.html) that are part of this diagnostic report.␊ - */␊ - result?: Reference11[]␊ - /**␊ - * One or more links to full details of any imaging performed during the diagnostic investigation. Typically, this is imaging performed by DICOM enabled modalities, but this is not required. A fully enabled PACS viewer can use this information to provide views of the source images.␊ - */␊ - imagingStudy?: Reference11[]␊ - /**␊ - * A list of key images associated with this report. The images are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest).␊ - */␊ - media?: DiagnosticReport_Media[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - conclusion?: string␊ - _conclusion?: Element690␊ - /**␊ - * One or more codes that represent the summary conclusion (interpretation/impression) of the diagnostic report.␊ - */␊ - conclusionCode?: CodeableConcept5[]␊ - /**␊ - * Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent.␊ - */␊ - presentedForm?: Attachment2[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta40 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element684 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element685 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative38 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element686 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept164 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference169 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference170 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element687 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period47 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element688 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports.␊ - */␊ - export interface DiagnosticReport_Media {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - comment?: string␊ - _comment?: Element689␊ - link: Reference171␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element689 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference171 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element690 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A collection of documents compiled for a purpose together with metadata that applies to the collection.␊ - */␊ - export interface DocumentManifest {␊ - /**␊ - * This is a DocumentManifest resource␊ - */␊ - resourceType: "DocumentManifest"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta41␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element691␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element692␊ - text?: Narrative39␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - masterIdentifier?: Identifier17␊ - /**␊ - * Other identifiers associated with the document manifest, including version independent identifiers.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * The status of this document manifest.␊ - */␊ - status?: ("current" | "superseded" | "entered-in-error")␊ - _status?: Element693␊ - type?: CodeableConcept165␊ - subject?: Reference172␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - created?: string␊ - _created?: Element694␊ - /**␊ - * Identifies who is the author of the manifest. Manifest author is not necessarly the author of the references included.␊ - */␊ - author?: Reference11[]␊ - /**␊ - * A patient, practitioner, or organization for which this set of documents is intended.␊ - */␊ - recipient?: Reference11[]␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - source?: string␊ - _source?: Element695␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element696␊ - /**␊ - * The list of Resources that consist of the parts of this manifest.␊ - */␊ - content: Reference11[]␊ - /**␊ - * Related identifiers or resources associated with the DocumentManifest.␊ - */␊ - related?: DocumentManifest_Related[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta41 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element691 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element692 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative39 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier17 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element693 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept165 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference172 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element694 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element695 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element696 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A collection of documents compiled for a purpose together with metadata that applies to the collection.␊ - */␊ - export interface DocumentManifest_Related {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - identifier?: Identifier18␊ - ref?: Reference173␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier18 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference173 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text.␊ - */␊ - export interface DocumentReference {␊ - /**␊ - * This is a DocumentReference resource␊ - */␊ - resourceType: "DocumentReference"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta42␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element697␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element698␊ - text?: Narrative40␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - masterIdentifier?: Identifier19␊ - /**␊ - * Other identifiers associated with the document, including version independent identifiers.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * The status of this document reference.␊ - */␊ - status?: ("current" | "superseded" | "entered-in-error")␊ - _status?: Element699␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - docStatus?: string␊ - _docStatus?: Element700␊ - type?: CodeableConcept166␊ - /**␊ - * A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type.␊ - */␊ - category?: CodeableConcept5[]␊ - subject?: Reference174␊ - /**␊ - * When the document reference was created.␊ - */␊ - date?: string␊ - _date?: Element701␊ - /**␊ - * Identifies who is responsible for adding the information to the document.␊ - */␊ - author?: Reference11[]␊ - authenticator?: Reference175␊ - custodian?: Reference176␊ - /**␊ - * Relationships that this document has with other document references that already exist.␊ - */␊ - relatesTo?: DocumentReference_RelatesTo[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element703␊ - /**␊ - * A set of Security-Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the "reference" to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to.␊ - */␊ - securityLabel?: CodeableConcept5[]␊ - /**␊ - * The document and format referenced. There may be multiple content element repetitions, each with a different format.␊ - */␊ - content: DocumentReference_Content[]␊ - context?: DocumentReference_Context␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta42 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element697 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element698 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative40 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier19 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element699 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element700 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept166 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference174 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element701 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference175 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference176 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text.␊ - */␊ - export interface DocumentReference_RelatesTo {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * The type of relationship that this document has with anther document.␊ - */␊ - code?: ("replaces" | "transforms" | "signs" | "appends")␊ - _code?: Element702␊ - target: Reference177␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element702 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference177 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element703 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text.␊ - */␊ - export interface DocumentReference_Content {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - attachment: Attachment13␊ - format?: Coding15␊ - }␊ - /**␊ - * For referring to data content defined in other formats.␊ - */␊ - export interface Attachment13 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.␊ - */␊ - contentType?: string␊ - _contentType?: Element51␊ - /**␊ - * The human language of the content. The value can be any valid value according to BCP 47.␊ - */␊ - language?: string␊ - _language?: Element52␊ - /**␊ - * The actual data of the attachment - a sequence of bytes, base64 encoded.␊ - */␊ - data?: string␊ - _data?: Element53␊ - /**␊ - * A location where the data can be accessed.␊ - */␊ - url?: string␊ - _url?: Element54␊ - /**␊ - * The number of bytes of data that make up this attachment (before base64 encoding, if that is done).␊ - */␊ - size?: number␊ - _size?: Element55␊ - /**␊ - * The calculated hash of the data using SHA-1. Represented using base64.␊ - */␊ - hash?: string␊ - _hash?: Element56␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element57␊ - /**␊ - * The date that the attachment was first created.␊ - */␊ - creation?: string␊ - _creation?: Element58␊ - }␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - export interface Coding15 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The identification of the code system that defines the meaning of the symbol in the code.␊ - */␊ - system?: string␊ - _system?: Element39␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element40␊ - /**␊ - * A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).␊ - */␊ - code?: string␊ - _code?: Element41␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element42␊ - /**␊ - * Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).␊ - */␊ - userSelected?: boolean␊ - _userSelected?: Element43␊ - }␊ - /**␊ - * The clinical context in which the document was prepared.␊ - */␊ - export interface DocumentReference_Context {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Describes the clinical encounter or type of care that the document content is associated with.␊ - */␊ - encounter?: Reference11[]␊ - /**␊ - * This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the type Code, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act.␊ - */␊ - event?: CodeableConcept5[]␊ - period?: Period48␊ - facilityType?: CodeableConcept167␊ - practiceSetting?: CodeableConcept168␊ - sourcePatientInfo?: Reference178␊ - /**␊ - * Related identifiers or resources associated with the DocumentReference.␊ - */␊ - related?: Reference11[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period48 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept167 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept168 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference178 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * The EffectEvidenceSynthesis resource describes the difference in an outcome between exposures states in a population where the effect estimate is derived from a combination of research studies.␊ - */␊ - export interface EffectEvidenceSynthesis {␊ - /**␊ - * This is a EffectEvidenceSynthesis resource␊ - */␊ - resourceType: "EffectEvidenceSynthesis"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta43␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element704␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element705␊ - text?: Narrative41␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - url?: string␊ - _url?: Element706␊ - /**␊ - * A formal identifier that is used to identify this effect evidence synthesis when it is represented in other formats, or referenced in a specification, model, design or an instance.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element707␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element708␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element709␊ - /**␊ - * The status of this effect evidence synthesis. Enables tracking the life-cycle of the content.␊ - */␊ - status?: ("draft" | "active" | "retired" | "unknown")␊ - _status?: Element710␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - date?: string␊ - _date?: Element711␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - publisher?: string␊ - _publisher?: Element712␊ - /**␊ - * Contact details to assist a user in finding and communicating with the publisher.␊ - */␊ - contact?: ContactDetail1[]␊ - /**␊ - * A free text natural language description of the effect evidence synthesis from a consumer's perspective.␊ - */␊ - description?: string␊ - _description?: Element713␊ - /**␊ - * A human-readable string to clarify or explain concepts about the resource.␊ - */␊ - note?: Annotation1[]␊ - /**␊ - * The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate effect evidence synthesis instances.␊ - */␊ - useContext?: UsageContext1[]␊ - /**␊ - * A legal or geographic region in which the effect evidence synthesis is intended to be used.␊ - */␊ - jurisdiction?: CodeableConcept5[]␊ - /**␊ - * A copyright statement relating to the effect evidence synthesis and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the effect evidence synthesis.␊ - */␊ - copyright?: string␊ - _copyright?: Element714␊ - /**␊ - * The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.␊ - */␊ - approvalDate?: string␊ - _approvalDate?: Element715␊ - /**␊ - * The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.␊ - */␊ - lastReviewDate?: string␊ - _lastReviewDate?: Element716␊ - effectivePeriod?: Period49␊ - /**␊ - * Descriptive topics related to the content of the EffectEvidenceSynthesis. Topics provide a high-level categorization grouping types of EffectEvidenceSynthesiss that can be useful for filtering and searching.␊ - */␊ - topic?: CodeableConcept5[]␊ - /**␊ - * An individiual or organization primarily involved in the creation and maintenance of the content.␊ - */␊ - author?: ContactDetail1[]␊ - /**␊ - * An individual or organization primarily responsible for internal coherence of the content.␊ - */␊ - editor?: ContactDetail1[]␊ - /**␊ - * An individual or organization primarily responsible for review of some aspect of the content.␊ - */␊ - reviewer?: ContactDetail1[]␊ - /**␊ - * An individual or organization responsible for officially endorsing the content for use in some setting.␊ - */␊ - endorser?: ContactDetail1[]␊ - /**␊ - * Related artifacts such as additional documentation, justification, or bibliographic references.␊ - */␊ - relatedArtifact?: RelatedArtifact1[]␊ - synthesisType?: CodeableConcept169␊ - studyType?: CodeableConcept170␊ - population: Reference179␊ - exposure: Reference180␊ - exposureAlternative: Reference181␊ - outcome: Reference182␊ - sampleSize?: EffectEvidenceSynthesis_SampleSize␊ - /**␊ - * A description of the results for each exposure considered in the effect estimate.␊ - */␊ - resultsByExposure?: EffectEvidenceSynthesis_ResultsByExposure[]␊ - /**␊ - * The estimated effect of the exposure variant.␊ - */␊ - effectEstimate?: EffectEvidenceSynthesis_EffectEstimate[]␊ - /**␊ - * A description of the certainty of the effect estimate.␊ - */␊ - certainty?: EffectEvidenceSynthesis_Certainty[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta43 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element704 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element705 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative41 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element706 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element707 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element708 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element709 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element710 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element711 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element712 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element713 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element714 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element715 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element716 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period49 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept169 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept170 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference179 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference180 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference181 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference182 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A description of the size of the sample involved in the synthesis.␊ - */␊ - export interface EffectEvidenceSynthesis_SampleSize {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element717␊ - /**␊ - * Number of studies included in this evidence synthesis.␊ - */␊ - numberOfStudies?: number␊ - _numberOfStudies?: Element718␊ - /**␊ - * Number of participants included in this evidence synthesis.␊ - */␊ - numberOfParticipants?: number␊ - _numberOfParticipants?: Element719␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element717 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element718 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element719 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The EffectEvidenceSynthesis resource describes the difference in an outcome between exposures states in a population where the effect estimate is derived from a combination of research studies.␊ - */␊ - export interface EffectEvidenceSynthesis_ResultsByExposure {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element720␊ - /**␊ - * Whether these results are for the exposure state or alternative exposure state.␊ - */␊ - exposureState?: ("exposure" | "exposure-alternative")␊ - _exposureState?: Element721␊ - variantState?: CodeableConcept171␊ - riskEvidenceSynthesis: Reference183␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element720 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element721 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept171 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference183 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * The EffectEvidenceSynthesis resource describes the difference in an outcome between exposures states in a population where the effect estimate is derived from a combination of research studies.␊ - */␊ - export interface EffectEvidenceSynthesis_EffectEstimate {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element722␊ - type?: CodeableConcept172␊ - variantState?: CodeableConcept173␊ - /**␊ - * The point estimate of the effect estimate.␊ - */␊ - value?: number␊ - _value?: Element723␊ - unitOfMeasure?: CodeableConcept174␊ - /**␊ - * A description of the precision of the estimate for the effect.␊ - */␊ - precisionEstimate?: EffectEvidenceSynthesis_PrecisionEstimate[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element722 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept172 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept173 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element723 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept174 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * The EffectEvidenceSynthesis resource describes the difference in an outcome between exposures states in a population where the effect estimate is derived from a combination of research studies.␊ - */␊ - export interface EffectEvidenceSynthesis_PrecisionEstimate {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - type?: CodeableConcept175␊ - /**␊ - * Use 95 for a 95% confidence interval.␊ - */␊ - level?: number␊ - _level?: Element724␊ - /**␊ - * Lower bound of confidence interval.␊ - */␊ - from?: number␊ - _from?: Element725␊ - /**␊ - * Upper bound of confidence interval.␊ - */␊ - to?: number␊ - _to?: Element726␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept175 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element724 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element725 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element726 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The EffectEvidenceSynthesis resource describes the difference in an outcome between exposures states in a population where the effect estimate is derived from a combination of research studies.␊ - */␊ - export interface EffectEvidenceSynthesis_Certainty {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A rating of the certainty of the effect estimate.␊ - */␊ - rating?: CodeableConcept5[]␊ - /**␊ - * A human-readable string to clarify or explain concepts about the resource.␊ - */␊ - note?: Annotation1[]␊ - /**␊ - * A description of a component of the overall certainty.␊ - */␊ - certaintySubcomponent?: EffectEvidenceSynthesis_CertaintySubcomponent[]␊ - }␊ - /**␊ - * The EffectEvidenceSynthesis resource describes the difference in an outcome between exposures states in a population where the effect estimate is derived from a combination of research studies.␊ - */␊ - export interface EffectEvidenceSynthesis_CertaintySubcomponent {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - type?: CodeableConcept176␊ - /**␊ - * A rating of a subcomponent of rating certainty.␊ - */␊ - rating?: CodeableConcept5[]␊ - /**␊ - * A human-readable string to clarify or explain concepts about the resource.␊ - */␊ - note?: Annotation1[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept176 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.␊ - */␊ - export interface Encounter {␊ - /**␊ - * This is a Encounter resource␊ - */␊ - resourceType: "Encounter"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta44␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element727␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element728␊ - text?: Narrative42␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifier(s) by which this encounter is known.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * planned | arrived | triaged | in-progress | onleave | finished | cancelled +.␊ - */␊ - status?: ("planned" | "arrived" | "triaged" | "in-progress" | "onleave" | "finished" | "cancelled" | "entered-in-error" | "unknown")␊ - _status?: Element729␊ - /**␊ - * The status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them.␊ - */␊ - statusHistory?: Encounter_StatusHistory[]␊ - class: Coding16␊ - /**␊ - * The class history permits the tracking of the encounters transitions without needing to go through the resource history. This would be used for a case where an admission starts of as an emergency encounter, then transitions into an inpatient scenario. Doing this and not restarting a new encounter ensures that any lab/diagnostic results can more easily follow the patient and not require re-processing and not get lost or cancelled during a kind of discharge from emergency to inpatient.␊ - */␊ - classHistory?: Encounter_ClassHistory[]␊ - /**␊ - * Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).␊ - */␊ - type?: CodeableConcept5[]␊ - serviceType?: CodeableConcept177␊ - priority?: CodeableConcept178␊ - subject?: Reference184␊ - /**␊ - * Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).␊ - */␊ - episodeOfCare?: Reference11[]␊ - /**␊ - * The request this encounter satisfies (e.g. incoming referral or procedure request).␊ - */␊ - basedOn?: Reference11[]␊ - /**␊ - * The list of people responsible for providing the service.␊ - */␊ - participant?: Encounter_Participant[]␊ - /**␊ - * The appointment that scheduled this encounter.␊ - */␊ - appointment?: Reference11[]␊ - period?: Period53␊ - length?: Duration4␊ - /**␊ - * Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.␊ - */␊ - reasonCode?: CodeableConcept5[]␊ - /**␊ - * Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.␊ - */␊ - reasonReference?: Reference11[]␊ - /**␊ - * The list of diagnosis relevant to this encounter.␊ - */␊ - diagnosis?: Encounter_Diagnosis[]␊ - /**␊ - * The set of accounts that may be used for billing for this Encounter.␊ - */␊ - account?: Reference11[]␊ - hospitalization?: Encounter_Hospitalization␊ - /**␊ - * List of locations where the patient has been during this encounter.␊ - */␊ - location?: Encounter_Location[]␊ - serviceProvider?: Reference190␊ - partOf?: Reference191␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta44 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element727 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element728 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative42 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element729 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.␊ - */␊ - export interface Encounter_StatusHistory {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * planned | arrived | triaged | in-progress | onleave | finished | cancelled +.␊ - */␊ - status?: ("planned" | "arrived" | "triaged" | "in-progress" | "onleave" | "finished" | "cancelled" | "entered-in-error" | "unknown")␊ - _status?: Element730␊ - period: Period50␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element730 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period50 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - export interface Coding16 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The identification of the code system that defines the meaning of the symbol in the code.␊ - */␊ - system?: string␊ - _system?: Element39␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element40␊ - /**␊ - * A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).␊ - */␊ - code?: string␊ - _code?: Element41␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element42␊ - /**␊ - * Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).␊ - */␊ - userSelected?: boolean␊ - _userSelected?: Element43␊ - }␊ - /**␊ - * An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.␊ - */␊ - export interface Encounter_ClassHistory {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - class: Coding17␊ - period: Period51␊ - }␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - export interface Coding17 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The identification of the code system that defines the meaning of the symbol in the code.␊ - */␊ - system?: string␊ - _system?: Element39␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element40␊ - /**␊ - * A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).␊ - */␊ - code?: string␊ - _code?: Element41␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element42␊ - /**␊ - * Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).␊ - */␊ - userSelected?: boolean␊ - _userSelected?: Element43␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period51 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept177 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept178 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference184 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.␊ - */␊ - export interface Encounter_Participant {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Role of participant in encounter.␊ - */␊ - type?: CodeableConcept5[]␊ - period?: Period52␊ - individual?: Reference185␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period52 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference185 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period53 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Quantity of time the encounter lasted. This excludes the time during leaves of absence.␊ - */␊ - export interface Duration4 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element73␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element74␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element75␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element76␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element77␊ - }␊ - /**␊ - * An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.␊ - */␊ - export interface Encounter_Diagnosis {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - condition: Reference186␊ - use?: CodeableConcept179␊ - /**␊ - * An integer with a value that is positive (e.g. >0)␊ - */␊ - rank?: number␊ - _rank?: Element731␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference186 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept179 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element731 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Details about the admission to a healthcare service.␊ - */␊ - export interface Encounter_Hospitalization {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - preAdmissionIdentifier?: Identifier20␊ - origin?: Reference187␊ - admitSource?: CodeableConcept180␊ - reAdmission?: CodeableConcept181␊ - /**␊ - * Diet preferences reported by the patient.␊ - */␊ - dietPreference?: CodeableConcept5[]␊ - /**␊ - * Special courtesies (VIP, board member).␊ - */␊ - specialCourtesy?: CodeableConcept5[]␊ - /**␊ - * Any special requests that have been made for this hospitalization encounter, such as the provision of specific equipment or other things.␊ - */␊ - specialArrangement?: CodeableConcept5[]␊ - destination?: Reference188␊ - dischargeDisposition?: CodeableConcept182␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier20 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference187 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept180 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept181 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference188 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept182 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.␊ - */␊ - export interface Encounter_Location {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - location: Reference189␊ - /**␊ - * The status of the participants' presence at the specified location during the period specified. If the participant is no longer at the location, then the period will have an end date/time.␊ - */␊ - status?: ("planned" | "active" | "reserved" | "completed")␊ - _status?: Element732␊ - physicalType?: CodeableConcept183␊ - period?: Period54␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference189 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element732 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept183 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period54 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference190 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference191 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * The technical details of an endpoint that can be used for electronic services, such as for web services providing XDS.b or a REST endpoint for another FHIR server. This may include any security context information.␊ - */␊ - export interface Endpoint {␊ - /**␊ - * This is a Endpoint resource␊ - */␊ - resourceType: "Endpoint"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta45␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element733␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element734␊ - text?: Narrative43␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifier for the organization that is used to identify the endpoint across multiple disparate systems.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * active | suspended | error | off | test.␊ - */␊ - status?: ("active" | "suspended" | "error" | "off" | "entered-in-error" | "test")␊ - _status?: Element735␊ - connectionType: Coding18␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element736␊ - managingOrganization?: Reference192␊ - /**␊ - * Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.␊ - */␊ - contact?: ContactPoint1[]␊ - period?: Period55␊ - /**␊ - * The payload type describes the acceptable content that can be communicated on the endpoint.␊ - */␊ - payloadType: CodeableConcept5[]␊ - /**␊ - * The mime type to send the payload in - e.g. application/fhir+xml, application/fhir+json. If the mime type is not specified, then the sender could send any content (including no content depending on the connectionType).␊ - */␊ - payloadMimeType?: Code[]␊ - /**␊ - * Extensions for payloadMimeType␊ - */␊ - _payloadMimeType?: Element23[]␊ - /**␊ - * The uri that describes the actual end-point to connect to.␊ - */␊ - address?: string␊ - _address?: Element737␊ - /**␊ - * Additional headers / information to send as part of the notification.␊ - */␊ - header?: String[]␊ - /**␊ - * Extensions for header␊ - */␊ - _header?: Element23[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta45 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element733 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element734 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative43 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element735 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - export interface Coding18 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The identification of the code system that defines the meaning of the symbol in the code.␊ - */␊ - system?: string␊ - _system?: Element39␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element40␊ - /**␊ - * A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).␊ - */␊ - code?: string␊ - _code?: Element41␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element42␊ - /**␊ - * Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).␊ - */␊ - userSelected?: boolean␊ - _userSelected?: Element43␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element736 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference192 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period55 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element737 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * This resource provides the insurance enrollment details to the insurer regarding a specified coverage.␊ - */␊ - export interface EnrollmentRequest {␊ - /**␊ - * This is a EnrollmentRequest resource␊ - */␊ - resourceType: "EnrollmentRequest"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta46␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element738␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element739␊ - text?: Narrative44␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * The Response business identifier.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - status?: string␊ - _status?: Element740␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - created?: string␊ - _created?: Element741␊ - insurer?: Reference193␊ - provider?: Reference194␊ - candidate?: Reference195␊ - coverage?: Reference196␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta46 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element738 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element739 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative44 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element740 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element741 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference193 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference194 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference195 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference196 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * This resource provides enrollment and plan details from the processing of an EnrollmentRequest resource.␊ - */␊ - export interface EnrollmentResponse {␊ - /**␊ - * This is a EnrollmentResponse resource␊ - */␊ - resourceType: "EnrollmentResponse"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta47␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element742␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element743␊ - text?: Narrative45␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * The Response business identifier.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - status?: string␊ - _status?: Element744␊ - request?: Reference197␊ - /**␊ - * Processing status: error, complete.␊ - */␊ - outcome?: ("queued" | "complete" | "error" | "partial")␊ - _outcome?: Element745␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - disposition?: string␊ - _disposition?: Element746␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - created?: string␊ - _created?: Element747␊ - organization?: Reference198␊ - requestProvider?: Reference199␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta47 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element742 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element743 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative45 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element744 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference197 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element745 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element746 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element747 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference198 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference199 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * An association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level of responsibility for the patient during this time.␊ - */␊ - export interface EpisodeOfCare {␊ - /**␊ - * This is a EpisodeOfCare resource␊ - */␊ - resourceType: "EpisodeOfCare"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta48␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element748␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element749␊ - text?: Narrative46␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * The EpisodeOfCare may be known by different identifiers for different contexts of use, such as when an external agency is tracking the Episode for funding purposes.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * planned | waitlist | active | onhold | finished | cancelled.␊ - */␊ - status?: ("planned" | "waitlist" | "active" | "onhold" | "finished" | "cancelled" | "entered-in-error")␊ - _status?: Element750␊ - /**␊ - * The history of statuses that the EpisodeOfCare has been through (without requiring processing the history of the resource).␊ - */␊ - statusHistory?: EpisodeOfCare_StatusHistory[]␊ - /**␊ - * A classification of the type of episode of care; e.g. specialist referral, disease management, type of funded care.␊ - */␊ - type?: CodeableConcept5[]␊ - /**␊ - * The list of diagnosis relevant to this episode of care.␊ - */␊ - diagnosis?: EpisodeOfCare_Diagnosis[]␊ - patient: Reference201␊ - managingOrganization?: Reference202␊ - period?: Period57␊ - /**␊ - * Referral Request(s) that are fulfilled by this EpisodeOfCare, incoming referrals.␊ - */␊ - referralRequest?: Reference11[]␊ - careManager?: Reference203␊ - /**␊ - * The list of practitioners that may be facilitating this episode of care for specific purposes.␊ - */␊ - team?: Reference11[]␊ - /**␊ - * The set of accounts that may be used for billing for this EpisodeOfCare.␊ - */␊ - account?: Reference11[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta48 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element748 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element749 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative46 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element750 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * An association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level of responsibility for the patient during this time.␊ - */␊ - export interface EpisodeOfCare_StatusHistory {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * planned | waitlist | active | onhold | finished | cancelled.␊ - */␊ - status?: ("planned" | "waitlist" | "active" | "onhold" | "finished" | "cancelled" | "entered-in-error")␊ - _status?: Element751␊ - period: Period56␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element751 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period56 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * An association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level of responsibility for the patient during this time.␊ - */␊ - export interface EpisodeOfCare_Diagnosis {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - condition: Reference200␊ - role?: CodeableConcept184␊ - /**␊ - * An integer with a value that is positive (e.g. >0)␊ - */␊ - rank?: number␊ - _rank?: Element752␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference200 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept184 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element752 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference201 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference202 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period57 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference203 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * The EventDefinition resource provides a reusable description of when a particular event can occur.␊ - */␊ - export interface EventDefinition {␊ - /**␊ - * This is a EventDefinition resource␊ - */␊ - resourceType: "EventDefinition"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta49␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element753␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element754␊ - text?: Narrative47␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - url?: string␊ - _url?: Element755␊ - /**␊ - * A formal identifier that is used to identify this event definition when it is represented in other formats, or referenced in a specification, model, design or an instance.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element756␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element757␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element758␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - subtitle?: string␊ - _subtitle?: Element759␊ - /**␊ - * The status of this event definition. Enables tracking the life-cycle of the content.␊ - */␊ - status?: ("draft" | "active" | "retired" | "unknown")␊ - _status?: Element760␊ - /**␊ - * A Boolean value to indicate that this event definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.␊ - */␊ - experimental?: boolean␊ - _experimental?: Element761␊ - subjectCodeableConcept?: CodeableConcept185␊ - subjectReference?: Reference204␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - date?: string␊ - _date?: Element762␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - publisher?: string␊ - _publisher?: Element763␊ - /**␊ - * Contact details to assist a user in finding and communicating with the publisher.␊ - */␊ - contact?: ContactDetail1[]␊ - /**␊ - * A free text natural language description of the event definition from a consumer's perspective.␊ - */␊ - description?: string␊ - _description?: Element764␊ - /**␊ - * The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate event definition instances.␊ - */␊ - useContext?: UsageContext1[]␊ - /**␊ - * A legal or geographic region in which the event definition is intended to be used.␊ - */␊ - jurisdiction?: CodeableConcept5[]␊ - /**␊ - * Explanation of why this event definition is needed and why it has been designed as it has.␊ - */␊ - purpose?: string␊ - _purpose?: Element765␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - usage?: string␊ - _usage?: Element766␊ - /**␊ - * A copyright statement relating to the event definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the event definition.␊ - */␊ - copyright?: string␊ - _copyright?: Element767␊ - /**␊ - * The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.␊ - */␊ - approvalDate?: string␊ - _approvalDate?: Element768␊ - /**␊ - * The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.␊ - */␊ - lastReviewDate?: string␊ - _lastReviewDate?: Element769␊ - effectivePeriod?: Period58␊ - /**␊ - * Descriptive topics related to the module. Topics provide a high-level categorization of the module that can be useful for filtering and searching.␊ - */␊ - topic?: CodeableConcept5[]␊ - /**␊ - * An individiual or organization primarily involved in the creation and maintenance of the content.␊ - */␊ - author?: ContactDetail1[]␊ - /**␊ - * An individual or organization primarily responsible for internal coherence of the content.␊ - */␊ - editor?: ContactDetail1[]␊ - /**␊ - * An individual or organization primarily responsible for review of some aspect of the content.␊ - */␊ - reviewer?: ContactDetail1[]␊ - /**␊ - * An individual or organization responsible for officially endorsing the content for use in some setting.␊ - */␊ - endorser?: ContactDetail1[]␊ - /**␊ - * Related resources such as additional documentation, justification, or bibliographic references.␊ - */␊ - relatedArtifact?: RelatedArtifact1[]␊ - /**␊ - * The trigger element defines when the event occurs. If more than one trigger condition is specified, the event fires whenever any one of the trigger conditions is met.␊ - */␊ - trigger: TriggerDefinition1[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta49 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element753 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element754 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative47 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element755 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element756 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element757 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element758 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element759 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element760 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element761 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept185 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference204 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element762 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element763 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element764 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element765 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element766 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element767 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element768 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element769 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period58 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * A description of a triggering event. Triggering events can be named events, data events, or periodic, as determined by the type element.␊ - */␊ - export interface TriggerDefinition1 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The type of triggering event.␊ - */␊ - type?: ("named-event" | "periodic" | "data-changed" | "data-added" | "data-modified" | "data-removed" | "data-accessed" | "data-access-ended")␊ - _type?: Element137␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element138␊ - timingTiming?: Timing1␊ - timingReference?: Reference6␊ - /**␊ - * The timing of the event (if this is a periodic trigger).␊ - */␊ - timingDate?: string␊ - _timingDate?: Element139␊ - /**␊ - * The timing of the event (if this is a periodic trigger).␊ - */␊ - timingDateTime?: string␊ - _timingDateTime?: Element140␊ - /**␊ - * The triggering data of the event (if this is a data trigger). If more than one data is requirement is specified, then all the data requirements must be true.␊ - */␊ - data?: DataRequirement1[]␊ - condition?: Expression1␊ - }␊ - /**␊ - * The Evidence resource describes the conditional state (population and any exposures being compared within the population) and outcome (if specified) that the knowledge (evidence, assertion, recommendation) is about.␊ - */␊ - export interface Evidence {␊ - /**␊ - * This is a Evidence resource␊ - */␊ - resourceType: "Evidence"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta50␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element770␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element771␊ - text?: Narrative48␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - url?: string␊ - _url?: Element772␊ - /**␊ - * A formal identifier that is used to identify this evidence when it is represented in other formats, or referenced in a specification, model, design or an instance.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element773␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element774␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element775␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - shortTitle?: string␊ - _shortTitle?: Element776␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - subtitle?: string␊ - _subtitle?: Element777␊ - /**␊ - * The status of this evidence. Enables tracking the life-cycle of the content.␊ - */␊ - status?: ("draft" | "active" | "retired" | "unknown")␊ - _status?: Element778␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - date?: string␊ - _date?: Element779␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - publisher?: string␊ - _publisher?: Element780␊ - /**␊ - * Contact details to assist a user in finding and communicating with the publisher.␊ - */␊ - contact?: ContactDetail1[]␊ - /**␊ - * A free text natural language description of the evidence from a consumer's perspective.␊ - */␊ - description?: string␊ - _description?: Element781␊ - /**␊ - * A human-readable string to clarify or explain concepts about the resource.␊ - */␊ - note?: Annotation1[]␊ - /**␊ - * The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate evidence instances.␊ - */␊ - useContext?: UsageContext1[]␊ - /**␊ - * A legal or geographic region in which the evidence is intended to be used.␊ - */␊ - jurisdiction?: CodeableConcept5[]␊ - /**␊ - * A copyright statement relating to the evidence and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the evidence.␊ - */␊ - copyright?: string␊ - _copyright?: Element782␊ - /**␊ - * The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.␊ - */␊ - approvalDate?: string␊ - _approvalDate?: Element783␊ - /**␊ - * The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.␊ - */␊ - lastReviewDate?: string␊ - _lastReviewDate?: Element784␊ - effectivePeriod?: Period59␊ - /**␊ - * Descriptive topics related to the content of the Evidence. Topics provide a high-level categorization grouping types of Evidences that can be useful for filtering and searching.␊ - */␊ - topic?: CodeableConcept5[]␊ - /**␊ - * An individiual or organization primarily involved in the creation and maintenance of the content.␊ - */␊ - author?: ContactDetail1[]␊ - /**␊ - * An individual or organization primarily responsible for internal coherence of the content.␊ - */␊ - editor?: ContactDetail1[]␊ - /**␊ - * An individual or organization primarily responsible for review of some aspect of the content.␊ - */␊ - reviewer?: ContactDetail1[]␊ - /**␊ - * An individual or organization responsible for officially endorsing the content for use in some setting.␊ - */␊ - endorser?: ContactDetail1[]␊ - /**␊ - * Related artifacts such as additional documentation, justification, or bibliographic references.␊ - */␊ - relatedArtifact?: RelatedArtifact1[]␊ - exposureBackground: Reference205␊ - /**␊ - * A reference to a EvidenceVariable resource that defines the exposure for the research.␊ - */␊ - exposureVariant?: Reference11[]␊ - /**␊ - * A reference to a EvidenceVariable resomece that defines the outcome for the research.␊ - */␊ - outcome?: Reference11[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta50 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element770 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element771 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative48 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element772 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element773 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element774 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element775 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element776 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element777 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element778 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element779 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element780 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element781 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element782 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element783 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element784 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period59 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference205 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * The EvidenceVariable resource describes a "PICO" element that knowledge (evidence, assertion, recommendation) is about.␊ - */␊ - export interface EvidenceVariable {␊ - /**␊ - * This is a EvidenceVariable resource␊ - */␊ - resourceType: "EvidenceVariable"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta51␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element785␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element786␊ - text?: Narrative49␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - url?: string␊ - _url?: Element787␊ - /**␊ - * A formal identifier that is used to identify this evidence variable when it is represented in other formats, or referenced in a specification, model, design or an instance.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element788␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element789␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element790␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - shortTitle?: string␊ - _shortTitle?: Element791␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - subtitle?: string␊ - _subtitle?: Element792␊ - /**␊ - * The status of this evidence variable. Enables tracking the life-cycle of the content.␊ - */␊ - status?: ("draft" | "active" | "retired" | "unknown")␊ - _status?: Element793␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - date?: string␊ - _date?: Element794␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - publisher?: string␊ - _publisher?: Element795␊ - /**␊ - * Contact details to assist a user in finding and communicating with the publisher.␊ - */␊ - contact?: ContactDetail1[]␊ - /**␊ - * A free text natural language description of the evidence variable from a consumer's perspective.␊ - */␊ - description?: string␊ - _description?: Element796␊ - /**␊ - * A human-readable string to clarify or explain concepts about the resource.␊ - */␊ - note?: Annotation1[]␊ - /**␊ - * The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate evidence variable instances.␊ - */␊ - useContext?: UsageContext1[]␊ - /**␊ - * A legal or geographic region in which the evidence variable is intended to be used.␊ - */␊ - jurisdiction?: CodeableConcept5[]␊ - /**␊ - * A copyright statement relating to the evidence variable and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the evidence variable.␊ - */␊ - copyright?: string␊ - _copyright?: Element797␊ - /**␊ - * The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.␊ - */␊ - approvalDate?: string␊ - _approvalDate?: Element798␊ - /**␊ - * The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.␊ - */␊ - lastReviewDate?: string␊ - _lastReviewDate?: Element799␊ - effectivePeriod?: Period60␊ - /**␊ - * Descriptive topics related to the content of the EvidenceVariable. Topics provide a high-level categorization grouping types of EvidenceVariables that can be useful for filtering and searching.␊ - */␊ - topic?: CodeableConcept5[]␊ - /**␊ - * An individiual or organization primarily involved in the creation and maintenance of the content.␊ - */␊ - author?: ContactDetail1[]␊ - /**␊ - * An individual or organization primarily responsible for internal coherence of the content.␊ - */␊ - editor?: ContactDetail1[]␊ - /**␊ - * An individual or organization primarily responsible for review of some aspect of the content.␊ - */␊ - reviewer?: ContactDetail1[]␊ - /**␊ - * An individual or organization responsible for officially endorsing the content for use in some setting.␊ - */␊ - endorser?: ContactDetail1[]␊ - /**␊ - * Related artifacts such as additional documentation, justification, or bibliographic references.␊ - */␊ - relatedArtifact?: RelatedArtifact1[]␊ - /**␊ - * The type of evidence element, a population, an exposure, or an outcome.␊ - */␊ - type?: ("dichotomous" | "continuous" | "descriptive")␊ - _type?: Element800␊ - /**␊ - * A characteristic that defines the members of the evidence element. Multiple characteristics are applied with "and" semantics.␊ - */␊ - characteristic: EvidenceVariable_Characteristic[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta51 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element785 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element786 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative49 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element787 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element788 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element789 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element790 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element791 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element792 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element793 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element794 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element795 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element796 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element797 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element798 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element799 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period60 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element800 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The EvidenceVariable resource describes a "PICO" element that knowledge (evidence, assertion, recommendation) is about.␊ - */␊ - export interface EvidenceVariable_Characteristic {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element801␊ - definitionReference?: Reference206␊ - /**␊ - * Define members of the evidence element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year).␊ - */␊ - definitionCanonical?: string␊ - _definitionCanonical?: Element802␊ - definitionCodeableConcept?: CodeableConcept186␊ - definitionExpression?: Expression3␊ - definitionDataRequirement?: DataRequirement2␊ - definitionTriggerDefinition?: TriggerDefinition2␊ - /**␊ - * Use UsageContext to define the members of the population, such as Age Ranges, Genders, Settings.␊ - */␊ - usageContext?: UsageContext1[]␊ - /**␊ - * When true, members with this characteristic are excluded from the element.␊ - */␊ - exclude?: boolean␊ - _exclude?: Element803␊ - /**␊ - * Indicates what effective period the study covers.␊ - */␊ - participantEffectiveDateTime?: string␊ - _participantEffectiveDateTime?: Element804␊ - participantEffectivePeriod?: Period61␊ - participantEffectiveDuration?: Duration5␊ - participantEffectiveTiming?: Timing10␊ - timeFromStart?: Duration6␊ - /**␊ - * Indicates how elements are aggregated within the study effective period.␊ - */␊ - groupMeasure?: ("mean" | "median" | "mean-of-mean" | "mean-of-median" | "median-of-mean" | "median-of-median")␊ - _groupMeasure?: Element805␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element801 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference206 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element802 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept186 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Define members of the evidence element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year).␊ - */␊ - export interface Expression3 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element121␊ - /**␊ - * A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.␊ - */␊ - name?: string␊ - _name?: Element122␊ - /**␊ - * The media type of the language for the expression.␊ - */␊ - language?: ("text/cql" | "text/fhirpath" | "application/x-fhir-query")␊ - _language?: Element123␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - expression?: string␊ - _expression?: Element124␊ - /**␊ - * A URI that defines where the expression is found.␊ - */␊ - reference?: string␊ - _reference?: Element125␊ - }␊ - /**␊ - * Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.␊ - */␊ - export interface DataRequirement2 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - type?: string␊ - _type?: Element112␊ - /**␊ - * The profile of the required data, specified as the uri of the profile definition.␊ - */␊ - profile?: Canonical[]␊ - subjectCodeableConcept?: CodeableConcept3␊ - subjectReference?: Reference5␊ - /**␊ - * Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. ␊ - * ␊ - * The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details).␊ - */␊ - mustSupport?: String[]␊ - /**␊ - * Extensions for mustSupport␊ - */␊ - _mustSupport?: Element23[]␊ - /**␊ - * Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.␊ - */␊ - codeFilter?: DataRequirement_CodeFilter[]␊ - /**␊ - * Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.␊ - */␊ - dateFilter?: DataRequirement_DateFilter[]␊ - /**␊ - * Specifies a maximum number of results that are required (uses the _count search parameter).␊ - */␊ - limit?: number␊ - _limit?: Element118␊ - /**␊ - * Specifies the order of the results to be returned.␊ - */␊ - sort?: DataRequirement_Sort[]␊ - }␊ - /**␊ - * A description of a triggering event. Triggering events can be named events, data events, or periodic, as determined by the type element.␊ - */␊ - export interface TriggerDefinition2 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The type of triggering event.␊ - */␊ - type?: ("named-event" | "periodic" | "data-changed" | "data-added" | "data-modified" | "data-removed" | "data-accessed" | "data-access-ended")␊ - _type?: Element137␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element138␊ - timingTiming?: Timing1␊ - timingReference?: Reference6␊ - /**␊ - * The timing of the event (if this is a periodic trigger).␊ - */␊ - timingDate?: string␊ - _timingDate?: Element139␊ - /**␊ - * The timing of the event (if this is a periodic trigger).␊ - */␊ - timingDateTime?: string␊ - _timingDateTime?: Element140␊ - /**␊ - * The triggering data of the event (if this is a data trigger). If more than one data is requirement is specified, then all the data requirements must be true.␊ - */␊ - data?: DataRequirement1[]␊ - condition?: Expression1␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element803 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element804 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period61 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Indicates what effective period the study covers.␊ - */␊ - export interface Duration5 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element73␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element74␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element75␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element76␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element77␊ - }␊ - /**␊ - * Indicates what effective period the study covers.␊ - */␊ - export interface Timing10 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifies specific times when the event occurs.␊ - */␊ - event?: DateTime[]␊ - /**␊ - * Extensions for event␊ - */␊ - _event?: Element23[]␊ - repeat?: Timing_Repeat␊ - code?: CodeableConcept2␊ - }␊ - /**␊ - * Indicates duration from the participant's study entry.␊ - */␊ - export interface Duration6 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element73␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element74␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element75␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element76␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element77␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element805 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Example of workflow instance.␊ - */␊ - export interface ExampleScenario {␊ - /**␊ - * This is a ExampleScenario resource␊ - */␊ - resourceType: "ExampleScenario"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta52␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element806␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element807␊ - text?: Narrative50␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - url?: string␊ - _url?: Element808␊ - /**␊ - * A formal identifier that is used to identify this example scenario when it is represented in other formats, or referenced in a specification, model, design or an instance.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element809␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element810␊ - /**␊ - * The status of this example scenario. Enables tracking the life-cycle of the content.␊ - */␊ - status?: ("draft" | "active" | "retired" | "unknown")␊ - _status?: Element811␊ - /**␊ - * A Boolean value to indicate that this example scenario is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.␊ - */␊ - experimental?: boolean␊ - _experimental?: Element812␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - date?: string␊ - _date?: Element813␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - publisher?: string␊ - _publisher?: Element814␊ - /**␊ - * Contact details to assist a user in finding and communicating with the publisher.␊ - */␊ - contact?: ContactDetail1[]␊ - /**␊ - * The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate example scenario instances.␊ - */␊ - useContext?: UsageContext1[]␊ - /**␊ - * A legal or geographic region in which the example scenario is intended to be used.␊ - */␊ - jurisdiction?: CodeableConcept5[]␊ - /**␊ - * A copyright statement relating to the example scenario and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the example scenario.␊ - */␊ - copyright?: string␊ - _copyright?: Element815␊ - /**␊ - * What the example scenario resource is created for. This should not be used to show the business purpose of the scenario itself, but the purpose of documenting a scenario.␊ - */␊ - purpose?: string␊ - _purpose?: Element816␊ - /**␊ - * Actor participating in the resource.␊ - */␊ - actor?: ExampleScenario_Actor[]␊ - /**␊ - * Each resource and each version that is present in the workflow.␊ - */␊ - instance?: ExampleScenario_Instance[]␊ - /**␊ - * Each major process - a group of operations.␊ - */␊ - process?: ExampleScenario_Process[]␊ - /**␊ - * Another nested workflow.␊ - */␊ - workflow?: Canonical[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta52 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element806 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element807 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative50 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element808 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element809 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element810 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element811 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element812 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element813 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element814 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element815 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element816 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Example of workflow instance.␊ - */␊ - export interface ExampleScenario_Actor {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - actorId?: string␊ - _actorId?: Element817␊ - /**␊ - * The type of actor - person or system.␊ - */␊ - type?: ("person" | "entity")␊ - _type?: Element818␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element819␊ - /**␊ - * The description of the actor.␊ - */␊ - description?: string␊ - _description?: Element820␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element817 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element818 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element819 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element820 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Example of workflow instance.␊ - */␊ - export interface ExampleScenario_Instance {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - resourceId?: string␊ - _resourceId?: Element821␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - resourceType?: string␊ - _resourceType?: Element822␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element823␊ - /**␊ - * Human-friendly description of the resource instance.␊ - */␊ - description?: string␊ - _description?: Element824␊ - /**␊ - * A specific version of the resource.␊ - */␊ - version?: ExampleScenario_Version[]␊ - /**␊ - * Resources contained in the instance (e.g. the observations contained in a bundle).␊ - */␊ - containedInstance?: ExampleScenario_ContainedInstance[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element821 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element822 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element823 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element824 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Example of workflow instance.␊ - */␊ - export interface ExampleScenario_Version {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - versionId?: string␊ - _versionId?: Element825␊ - /**␊ - * The description of the resource version.␊ - */␊ - description?: string␊ - _description?: Element826␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element825 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element826 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Example of workflow instance.␊ - */␊ - export interface ExampleScenario_ContainedInstance {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - resourceId?: string␊ - _resourceId?: Element827␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - versionId?: string␊ - _versionId?: Element828␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element827 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element828 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Example of workflow instance.␊ - */␊ - export interface ExampleScenario_Process {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element829␊ - /**␊ - * A longer description of the group of operations.␊ - */␊ - description?: string␊ - _description?: Element830␊ - /**␊ - * Description of initial status before the process starts.␊ - */␊ - preConditions?: string␊ - _preConditions?: Element831␊ - /**␊ - * Description of final status after the process ends.␊ - */␊ - postConditions?: string␊ - _postConditions?: Element832␊ - /**␊ - * Each step of the process.␊ - */␊ - step?: ExampleScenario_Step[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element829 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element830 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element831 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element832 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Example of workflow instance.␊ - */␊ - export interface ExampleScenario_Step {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Nested process.␊ - */␊ - process?: ExampleScenario_Process[]␊ - /**␊ - * If there is a pause in the flow.␊ - */␊ - pause?: boolean␊ - _pause?: Element833␊ - operation?: ExampleScenario_Operation␊ - /**␊ - * Indicates an alternative step that can be taken instead of the operations on the base step in exceptional/atypical circumstances.␊ - */␊ - alternative?: ExampleScenario_Alternative[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element833 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Each interaction or action.␊ - */␊ - export interface ExampleScenario_Operation {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - number?: string␊ - _number?: Element834␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - type?: string␊ - _type?: Element835␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element836␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - initiator?: string␊ - _initiator?: Element837␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - receiver?: string␊ - _receiver?: Element838␊ - /**␊ - * A comment to be inserted in the diagram.␊ - */␊ - description?: string␊ - _description?: Element839␊ - /**␊ - * Whether the initiator is deactivated right after the transaction.␊ - */␊ - initiatorActive?: boolean␊ - _initiatorActive?: Element840␊ - /**␊ - * Whether the receiver is deactivated right after the transaction.␊ - */␊ - receiverActive?: boolean␊ - _receiverActive?: Element841␊ - request?: ExampleScenario_ContainedInstance1␊ - response?: ExampleScenario_ContainedInstance2␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element834 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element835 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element836 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element837 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element838 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element839 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element840 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element841 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Example of workflow instance.␊ - */␊ - export interface ExampleScenario_ContainedInstance1 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - resourceId?: string␊ - _resourceId?: Element827␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - versionId?: string␊ - _versionId?: Element828␊ - }␊ - /**␊ - * Example of workflow instance.␊ - */␊ - export interface ExampleScenario_ContainedInstance2 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - resourceId?: string␊ - _resourceId?: Element827␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - versionId?: string␊ - _versionId?: Element828␊ - }␊ - /**␊ - * Example of workflow instance.␊ - */␊ - export interface ExampleScenario_Alternative {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element842␊ - /**␊ - * A human-readable description of the alternative explaining when the alternative should occur rather than the base step.␊ - */␊ - description?: string␊ - _description?: Element843␊ - /**␊ - * What happens in each alternative option.␊ - */␊ - step?: ExampleScenario_Step[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element842 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element843 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.␊ - */␊ - export interface ExplanationOfBenefit {␊ - /**␊ - * This is a ExplanationOfBenefit resource␊ - */␊ - resourceType: "ExplanationOfBenefit"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta53␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element844␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element845␊ - text?: Narrative51␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A unique identifier assigned to this explanation of benefit.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * The status of the resource instance.␊ - */␊ - status?: ("active" | "cancelled" | "draft" | "entered-in-error")␊ - _status?: Element846␊ - type: CodeableConcept187␊ - subType?: CodeableConcept188␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - use?: string␊ - _use?: Element847␊ - patient: Reference207␊ - billablePeriod?: Period62␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - created?: string␊ - _created?: Element848␊ - enterer?: Reference208␊ - insurer: Reference209␊ - provider: Reference210␊ - priority?: CodeableConcept189␊ - fundsReserveRequested?: CodeableConcept190␊ - fundsReserve?: CodeableConcept191␊ - /**␊ - * Other claims which are related to this claim such as prior submissions or claims for related services or for the same event.␊ - */␊ - related?: ExplanationOfBenefit_Related[]␊ - prescription?: Reference212␊ - originalPrescription?: Reference213␊ - payee?: ExplanationOfBenefit_Payee␊ - referral?: Reference215␊ - facility?: Reference216␊ - claim?: Reference217␊ - claimResponse?: Reference218␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - outcome?: string␊ - _outcome?: Element849␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - disposition?: string␊ - _disposition?: Element850␊ - /**␊ - * Reference from the Insurer which is used in later communications which refers to this adjudication.␊ - */␊ - preAuthRef?: String[]␊ - /**␊ - * Extensions for preAuthRef␊ - */␊ - _preAuthRef?: Element23[]␊ - /**␊ - * The timeframe during which the supplied preauthorization reference may be quoted on claims to obtain the adjudication as provided.␊ - */␊ - preAuthRefPeriod?: Period11[]␊ - /**␊ - * The members of the team who provided the products and services.␊ - */␊ - careTeam?: ExplanationOfBenefit_CareTeam[]␊ - /**␊ - * Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.␊ - */␊ - supportingInfo?: ExplanationOfBenefit_SupportingInfo[]␊ - /**␊ - * Information about diagnoses relevant to the claim items.␊ - */␊ - diagnosis?: ExplanationOfBenefit_Diagnosis[]␊ - /**␊ - * Procedures performed on the patient relevant to the billing items with the claim.␊ - */␊ - procedure?: ExplanationOfBenefit_Procedure[]␊ - /**␊ - * An integer with a value that is positive (e.g. >0)␊ - */␊ - precedence?: number␊ - _precedence?: Element860␊ - /**␊ - * Financial instruments for reimbursement for the health care products and services specified on the claim.␊ - */␊ - insurance: ExplanationOfBenefit_Insurance[]␊ - accident?: ExplanationOfBenefit_Accident␊ - /**␊ - * A claim line. Either a simple (a product or service) or a 'group' of details which can also be a simple items or groups of sub-details.␊ - */␊ - item?: ExplanationOfBenefit_Item[]␊ - /**␊ - * The first-tier service adjudications for payor added product or service lines.␊ - */␊ - addItem?: ExplanationOfBenefit_AddItem[]␊ - /**␊ - * The adjudication results which are presented at the header level rather than at the line-item or add-item levels.␊ - */␊ - adjudication?: ExplanationOfBenefit_Adjudication[]␊ - /**␊ - * Categorized monetary totals for the adjudication.␊ - */␊ - total?: ExplanationOfBenefit_Total[]␊ - payment?: ExplanationOfBenefit_Payment␊ - formCode?: CodeableConcept224␊ - form?: Attachment15␊ - /**␊ - * A note that describes or explains adjudication results in a human readable form.␊ - */␊ - processNote?: ExplanationOfBenefit_ProcessNote[]␊ - benefitPeriod?: Period66␊ - /**␊ - * Balance by Benefit Category.␊ - */␊ - benefitBalance?: ExplanationOfBenefit_BenefitBalance[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta53 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element844 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element845 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative51 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element846 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept187 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept188 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element847 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference207 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period62 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element848 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference208 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference209 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference210 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept189 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept190 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept191 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.␊ - */␊ - export interface ExplanationOfBenefit_Related {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - claim?: Reference211␊ - relationship?: CodeableConcept192␊ - reference?: Identifier21␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference211 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept192 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier21 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference212 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference213 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * The party to be reimbursed for cost of the products and services according to the terms of the policy.␊ - */␊ - export interface ExplanationOfBenefit_Payee {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - type?: CodeableConcept193␊ - party?: Reference214␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept193 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference214 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference215 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference216 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference217 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference218 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element849 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element850 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.␊ - */␊ - export interface ExplanationOfBenefit_CareTeam {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * An integer with a value that is positive (e.g. >0)␊ - */␊ - sequence?: number␊ - _sequence?: Element851␊ - provider: Reference219␊ - /**␊ - * The party who is billing and/or responsible for the claimed products or services.␊ - */␊ - responsible?: boolean␊ - _responsible?: Element852␊ - role?: CodeableConcept194␊ - qualification?: CodeableConcept195␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element851 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference219 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element852 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept194 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept195 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.␊ - */␊ - export interface ExplanationOfBenefit_SupportingInfo {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * An integer with a value that is positive (e.g. >0)␊ - */␊ - sequence?: number␊ - _sequence?: Element853␊ - category: CodeableConcept196␊ - code?: CodeableConcept197␊ - /**␊ - * The date when or period to which this information refers.␊ - */␊ - timingDate?: string␊ - _timingDate?: Element854␊ - timingPeriod?: Period63␊ - /**␊ - * Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.␊ - */␊ - valueBoolean?: boolean␊ - _valueBoolean?: Element855␊ - /**␊ - * Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.␊ - */␊ - valueString?: string␊ - _valueString?: Element856␊ - valueQuantity?: Quantity36␊ - valueAttachment?: Attachment14␊ - valueReference?: Reference220␊ - reason?: Coding19␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element853 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept196 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept197 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element854 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period63 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element855 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element856 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity36 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * For referring to data content defined in other formats.␊ - */␊ - export interface Attachment14 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.␊ - */␊ - contentType?: string␊ - _contentType?: Element51␊ - /**␊ - * The human language of the content. The value can be any valid value according to BCP 47.␊ - */␊ - language?: string␊ - _language?: Element52␊ - /**␊ - * The actual data of the attachment - a sequence of bytes, base64 encoded.␊ - */␊ - data?: string␊ - _data?: Element53␊ - /**␊ - * A location where the data can be accessed.␊ - */␊ - url?: string␊ - _url?: Element54␊ - /**␊ - * The number of bytes of data that make up this attachment (before base64 encoding, if that is done).␊ - */␊ - size?: number␊ - _size?: Element55␊ - /**␊ - * The calculated hash of the data using SHA-1. Represented using base64.␊ - */␊ - hash?: string␊ - _hash?: Element56␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element57␊ - /**␊ - * The date that the attachment was first created.␊ - */␊ - creation?: string␊ - _creation?: Element58␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference220 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - export interface Coding19 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The identification of the code system that defines the meaning of the symbol in the code.␊ - */␊ - system?: string␊ - _system?: Element39␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element40␊ - /**␊ - * A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).␊ - */␊ - code?: string␊ - _code?: Element41␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element42␊ - /**␊ - * Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).␊ - */␊ - userSelected?: boolean␊ - _userSelected?: Element43␊ - }␊ - /**␊ - * This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.␊ - */␊ - export interface ExplanationOfBenefit_Diagnosis {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * An integer with a value that is positive (e.g. >0)␊ - */␊ - sequence?: number␊ - _sequence?: Element857␊ - diagnosisCodeableConcept?: CodeableConcept198␊ - diagnosisReference?: Reference221␊ - /**␊ - * When the condition was observed or the relative ranking.␊ - */␊ - type?: CodeableConcept5[]␊ - onAdmission?: CodeableConcept199␊ - packageCode?: CodeableConcept200␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element857 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept198 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference221 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept199 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept200 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.␊ - */␊ - export interface ExplanationOfBenefit_Procedure {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * An integer with a value that is positive (e.g. >0)␊ - */␊ - sequence?: number␊ - _sequence?: Element858␊ - /**␊ - * When the condition was observed or the relative ranking.␊ - */␊ - type?: CodeableConcept5[]␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - date?: string␊ - _date?: Element859␊ - procedureCodeableConcept?: CodeableConcept201␊ - procedureReference?: Reference222␊ - /**␊ - * Unique Device Identifiers associated with this line item.␊ - */␊ - udi?: Reference11[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element858 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element859 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept201 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference222 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element860 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.␊ - */␊ - export interface ExplanationOfBenefit_Insurance {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true.␊ - */␊ - focal?: boolean␊ - _focal?: Element861␊ - coverage: Reference223␊ - /**␊ - * Reference numbers previously provided by the insurer to the provider to be quoted on subsequent claims containing services or products related to the prior authorization.␊ - */␊ - preAuthRef?: String[]␊ - /**␊ - * Extensions for preAuthRef␊ - */␊ - _preAuthRef?: Element23[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element861 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference223 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Details of a accident which resulted in injuries which required the products and services listed in the claim.␊ - */␊ - export interface ExplanationOfBenefit_Accident {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Date of an accident event related to the products and services contained in the claim.␊ - */␊ - date?: string␊ - _date?: Element862␊ - type?: CodeableConcept202␊ - locationAddress?: Address4␊ - locationReference?: Reference224␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element862 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept202 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * The physical location of the accident event.␊ - */␊ - export interface Address4 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this address.␊ - */␊ - use?: ("home" | "work" | "temp" | "old" | "billing")␊ - _use?: Element20␊ - /**␊ - * Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.␊ - */␊ - type?: ("postal" | "physical" | "both")␊ - _type?: Element21␊ - /**␊ - * Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.␊ - */␊ - text?: string␊ - _text?: Element22␊ - /**␊ - * This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.␊ - */␊ - line?: String[]␊ - /**␊ - * Extensions for line␊ - */␊ - _line?: Element23[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - city?: string␊ - _city?: Element24␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - district?: string␊ - _district?: Element25␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - state?: string␊ - _state?: Element26␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - postalCode?: string␊ - _postalCode?: Element27␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - country?: string␊ - _country?: Element28␊ - period?: Period␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference224 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.␊ - */␊ - export interface ExplanationOfBenefit_Item {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * An integer with a value that is positive (e.g. >0)␊ - */␊ - sequence?: number␊ - _sequence?: Element863␊ - /**␊ - * Care team members related to this service or product.␊ - */␊ - careTeamSequence?: PositiveInt[]␊ - /**␊ - * Extensions for careTeamSequence␊ - */␊ - _careTeamSequence?: Element23[]␊ - /**␊ - * Diagnoses applicable for this service or product.␊ - */␊ - diagnosisSequence?: PositiveInt[]␊ - /**␊ - * Extensions for diagnosisSequence␊ - */␊ - _diagnosisSequence?: Element23[]␊ - /**␊ - * Procedures applicable for this service or product.␊ - */␊ - procedureSequence?: PositiveInt[]␊ - /**␊ - * Extensions for procedureSequence␊ - */␊ - _procedureSequence?: Element23[]␊ - /**␊ - * Exceptions, special conditions and supporting information applicable for this service or product.␊ - */␊ - informationSequence?: PositiveInt[]␊ - /**␊ - * Extensions for informationSequence␊ - */␊ - _informationSequence?: Element23[]␊ - revenue?: CodeableConcept203␊ - category?: CodeableConcept204␊ - productOrService: CodeableConcept205␊ - /**␊ - * Item typification or modifiers codes to convey additional context for the product or service.␊ - */␊ - modifier?: CodeableConcept5[]␊ - /**␊ - * Identifies the program under which this may be recovered.␊ - */␊ - programCode?: CodeableConcept5[]␊ - /**␊ - * The date or dates when the service or product was supplied, performed or completed.␊ - */␊ - servicedDate?: string␊ - _servicedDate?: Element864␊ - servicedPeriod?: Period64␊ - locationCodeableConcept?: CodeableConcept206␊ - locationAddress?: Address5␊ - locationReference?: Reference225␊ - quantity?: Quantity37␊ - unitPrice?: Money26␊ - /**␊ - * A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.␊ - */␊ - factor?: number␊ - _factor?: Element865␊ - net?: Money27␊ - /**␊ - * Unique Device Identifiers associated with this line item.␊ - */␊ - udi?: Reference11[]␊ - bodySite?: CodeableConcept207␊ - /**␊ - * A region or surface of the bodySite, e.g. limb region or tooth surface(s).␊ - */␊ - subSite?: CodeableConcept5[]␊ - /**␊ - * A billed item may include goods or services provided in multiple encounters.␊ - */␊ - encounter?: Reference11[]␊ - /**␊ - * The numbers associated with notes below which apply to the adjudication of this item.␊ - */␊ - noteNumber?: PositiveInt[]␊ - /**␊ - * Extensions for noteNumber␊ - */␊ - _noteNumber?: Element23[]␊ - /**␊ - * If this item is a group then the values here are a summary of the adjudication of the detail items. If this item is a simple product or service then this is the result of the adjudication of this item.␊ - */␊ - adjudication?: ExplanationOfBenefit_Adjudication[]␊ - /**␊ - * Second-tier of goods and services.␊ - */␊ - detail?: ExplanationOfBenefit_Detail[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element863 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept203 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept204 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept205 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element864 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period64 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept206 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Where the product or service was provided.␊ - */␊ - export interface Address5 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this address.␊ - */␊ - use?: ("home" | "work" | "temp" | "old" | "billing")␊ - _use?: Element20␊ - /**␊ - * Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.␊ - */␊ - type?: ("postal" | "physical" | "both")␊ - _type?: Element21␊ - /**␊ - * Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.␊ - */␊ - text?: string␊ - _text?: Element22␊ - /**␊ - * This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.␊ - */␊ - line?: String[]␊ - /**␊ - * Extensions for line␊ - */␊ - _line?: Element23[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - city?: string␊ - _city?: Element24␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - district?: string␊ - _district?: Element25␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - state?: string␊ - _state?: Element26␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - postalCode?: string␊ - _postalCode?: Element27␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - country?: string␊ - _country?: Element28␊ - period?: Period␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference225 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity37 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.␊ - */␊ - export interface Money26 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element865 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The quantity times the unit price for an additional service or product or charge.␊ - */␊ - export interface Money27 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept207 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.␊ - */␊ - export interface ExplanationOfBenefit_Adjudication {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - category: CodeableConcept208␊ - reason?: CodeableConcept209␊ - amount?: Money28␊ - /**␊ - * A non-monetary value associated with the category. Mutually exclusive to the amount element above.␊ - */␊ - value?: number␊ - _value?: Element866␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept208 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept209 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Monetary amount associated with the category.␊ - */␊ - export interface Money28 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element866 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.␊ - */␊ - export interface ExplanationOfBenefit_Detail {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * An integer with a value that is positive (e.g. >0)␊ - */␊ - sequence?: number␊ - _sequence?: Element867␊ - revenue?: CodeableConcept210␊ - category?: CodeableConcept211␊ - productOrService: CodeableConcept212␊ - /**␊ - * Item typification or modifiers codes to convey additional context for the product or service.␊ - */␊ - modifier?: CodeableConcept5[]␊ - /**␊ - * Identifies the program under which this may be recovered.␊ - */␊ - programCode?: CodeableConcept5[]␊ - quantity?: Quantity38␊ - unitPrice?: Money29␊ - /**␊ - * A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.␊ - */␊ - factor?: number␊ - _factor?: Element868␊ - net?: Money30␊ - /**␊ - * Unique Device Identifiers associated with this line item.␊ - */␊ - udi?: Reference11[]␊ - /**␊ - * The numbers associated with notes below which apply to the adjudication of this item.␊ - */␊ - noteNumber?: PositiveInt[]␊ - /**␊ - * Extensions for noteNumber␊ - */␊ - _noteNumber?: Element23[]␊ - /**␊ - * The adjudication results.␊ - */␊ - adjudication?: ExplanationOfBenefit_Adjudication[]␊ - /**␊ - * Third-tier of goods and services.␊ - */␊ - subDetail?: ExplanationOfBenefit_SubDetail[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element867 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept210 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept211 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept212 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity38 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.␊ - */␊ - export interface Money29 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element868 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The quantity times the unit price for an additional service or product or charge.␊ - */␊ - export interface Money30 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.␊ - */␊ - export interface ExplanationOfBenefit_SubDetail {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * An integer with a value that is positive (e.g. >0)␊ - */␊ - sequence?: number␊ - _sequence?: Element869␊ - revenue?: CodeableConcept213␊ - category?: CodeableConcept214␊ - productOrService: CodeableConcept215␊ - /**␊ - * Item typification or modifiers codes to convey additional context for the product or service.␊ - */␊ - modifier?: CodeableConcept5[]␊ - /**␊ - * Identifies the program under which this may be recovered.␊ - */␊ - programCode?: CodeableConcept5[]␊ - quantity?: Quantity39␊ - unitPrice?: Money31␊ - /**␊ - * A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.␊ - */␊ - factor?: number␊ - _factor?: Element870␊ - net?: Money32␊ - /**␊ - * Unique Device Identifiers associated with this line item.␊ - */␊ - udi?: Reference11[]␊ - /**␊ - * The numbers associated with notes below which apply to the adjudication of this item.␊ - */␊ - noteNumber?: PositiveInt[]␊ - /**␊ - * Extensions for noteNumber␊ - */␊ - _noteNumber?: Element23[]␊ - /**␊ - * The adjudication results.␊ - */␊ - adjudication?: ExplanationOfBenefit_Adjudication[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element869 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept213 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept214 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept215 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity39 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.␊ - */␊ - export interface Money31 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element870 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The quantity times the unit price for an additional service or product or charge.␊ - */␊ - export interface Money32 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.␊ - */␊ - export interface ExplanationOfBenefit_AddItem {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Claim items which this service line is intended to replace.␊ - */␊ - itemSequence?: PositiveInt[]␊ - /**␊ - * Extensions for itemSequence␊ - */␊ - _itemSequence?: Element23[]␊ - /**␊ - * The sequence number of the details within the claim item which this line is intended to replace.␊ - */␊ - detailSequence?: PositiveInt[]␊ - /**␊ - * Extensions for detailSequence␊ - */␊ - _detailSequence?: Element23[]␊ - /**␊ - * The sequence number of the sub-details woithin the details within the claim item which this line is intended to replace.␊ - */␊ - subDetailSequence?: PositiveInt[]␊ - /**␊ - * Extensions for subDetailSequence␊ - */␊ - _subDetailSequence?: Element23[]␊ - /**␊ - * The providers who are authorized for the services rendered to the patient.␊ - */␊ - provider?: Reference11[]␊ - productOrService: CodeableConcept216␊ - /**␊ - * Item typification or modifiers codes to convey additional context for the product or service.␊ - */␊ - modifier?: CodeableConcept5[]␊ - /**␊ - * Identifies the program under which this may be recovered.␊ - */␊ - programCode?: CodeableConcept5[]␊ - /**␊ - * The date or dates when the service or product was supplied, performed or completed.␊ - */␊ - servicedDate?: string␊ - _servicedDate?: Element871␊ - servicedPeriod?: Period65␊ - locationCodeableConcept?: CodeableConcept217␊ - locationAddress?: Address6␊ - locationReference?: Reference226␊ - quantity?: Quantity40␊ - unitPrice?: Money33␊ - /**␊ - * A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.␊ - */␊ - factor?: number␊ - _factor?: Element872␊ - net?: Money34␊ - bodySite?: CodeableConcept218␊ - /**␊ - * A region or surface of the bodySite, e.g. limb region or tooth surface(s).␊ - */␊ - subSite?: CodeableConcept5[]␊ - /**␊ - * The numbers associated with notes below which apply to the adjudication of this item.␊ - */␊ - noteNumber?: PositiveInt[]␊ - /**␊ - * Extensions for noteNumber␊ - */␊ - _noteNumber?: Element23[]␊ - /**␊ - * The adjudication results.␊ - */␊ - adjudication?: ExplanationOfBenefit_Adjudication[]␊ - /**␊ - * The second-tier service adjudications for payor added services.␊ - */␊ - detail?: ExplanationOfBenefit_Detail1[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept216 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element871 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period65 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept217 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Where the product or service was provided.␊ - */␊ - export interface Address6 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this address.␊ - */␊ - use?: ("home" | "work" | "temp" | "old" | "billing")␊ - _use?: Element20␊ - /**␊ - * Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.␊ - */␊ - type?: ("postal" | "physical" | "both")␊ - _type?: Element21␊ - /**␊ - * Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.␊ - */␊ - text?: string␊ - _text?: Element22␊ - /**␊ - * This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.␊ - */␊ - line?: String[]␊ - /**␊ - * Extensions for line␊ - */␊ - _line?: Element23[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - city?: string␊ - _city?: Element24␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - district?: string␊ - _district?: Element25␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - state?: string␊ - _state?: Element26␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - postalCode?: string␊ - _postalCode?: Element27␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - country?: string␊ - _country?: Element28␊ - period?: Period␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference226 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity40 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.␊ - */␊ - export interface Money33 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element872 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The quantity times the unit price for an additional service or product or charge.␊ - */␊ - export interface Money34 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept218 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.␊ - */␊ - export interface ExplanationOfBenefit_Detail1 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - productOrService: CodeableConcept219␊ - /**␊ - * Item typification or modifiers codes to convey additional context for the product or service.␊ - */␊ - modifier?: CodeableConcept5[]␊ - quantity?: Quantity41␊ - unitPrice?: Money35␊ - /**␊ - * A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.␊ - */␊ - factor?: number␊ - _factor?: Element873␊ - net?: Money36␊ - /**␊ - * The numbers associated with notes below which apply to the adjudication of this item.␊ - */␊ - noteNumber?: PositiveInt[]␊ - /**␊ - * Extensions for noteNumber␊ - */␊ - _noteNumber?: Element23[]␊ - /**␊ - * The adjudication results.␊ - */␊ - adjudication?: ExplanationOfBenefit_Adjudication[]␊ - /**␊ - * The third-tier service adjudications for payor added services.␊ - */␊ - subDetail?: ExplanationOfBenefit_SubDetail1[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept219 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity41 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.␊ - */␊ - export interface Money35 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element873 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The quantity times the unit price for an additional service or product or charge.␊ - */␊ - export interface Money36 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.␊ - */␊ - export interface ExplanationOfBenefit_SubDetail1 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - productOrService: CodeableConcept220␊ - /**␊ - * Item typification or modifiers codes to convey additional context for the product or service.␊ - */␊ - modifier?: CodeableConcept5[]␊ - quantity?: Quantity42␊ - unitPrice?: Money37␊ - /**␊ - * A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.␊ - */␊ - factor?: number␊ - _factor?: Element874␊ - net?: Money38␊ - /**␊ - * The numbers associated with notes below which apply to the adjudication of this item.␊ - */␊ - noteNumber?: PositiveInt[]␊ - /**␊ - * Extensions for noteNumber␊ - */␊ - _noteNumber?: Element23[]␊ - /**␊ - * The adjudication results.␊ - */␊ - adjudication?: ExplanationOfBenefit_Adjudication[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept220 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity42 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * If the item is not a group then this is the fee for the product or service, otherwise this is the total of the fees for the details of the group.␊ - */␊ - export interface Money37 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element874 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The quantity times the unit price for an additional service or product or charge.␊ - */␊ - export interface Money38 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.␊ - */␊ - export interface ExplanationOfBenefit_Total {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - category: CodeableConcept221␊ - amount: Money39␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept221 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Monetary total amount associated with the category.␊ - */␊ - export interface Money39 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * Payment details for the adjudication of the claim.␊ - */␊ - export interface ExplanationOfBenefit_Payment {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - type?: CodeableConcept222␊ - adjustment?: Money40␊ - adjustmentReason?: CodeableConcept223␊ - /**␊ - * Estimated date the payment will be issued or the actual issue date of payment.␊ - */␊ - date?: string␊ - _date?: Element875␊ - amount?: Money41␊ - identifier?: Identifier22␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept222 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Total amount of all adjustments to this payment included in this transaction which are not related to this claim's adjudication.␊ - */␊ - export interface Money40 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept223 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element875 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Benefits payable less any payment adjustment.␊ - */␊ - export interface Money41 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier22 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept224 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * For referring to data content defined in other formats.␊ - */␊ - export interface Attachment15 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.␊ - */␊ - contentType?: string␊ - _contentType?: Element51␊ - /**␊ - * The human language of the content. The value can be any valid value according to BCP 47.␊ - */␊ - language?: string␊ - _language?: Element52␊ - /**␊ - * The actual data of the attachment - a sequence of bytes, base64 encoded.␊ - */␊ - data?: string␊ - _data?: Element53␊ - /**␊ - * A location where the data can be accessed.␊ - */␊ - url?: string␊ - _url?: Element54␊ - /**␊ - * The number of bytes of data that make up this attachment (before base64 encoding, if that is done).␊ - */␊ - size?: number␊ - _size?: Element55␊ - /**␊ - * The calculated hash of the data using SHA-1. Represented using base64.␊ - */␊ - hash?: string␊ - _hash?: Element56␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element57␊ - /**␊ - * The date that the attachment was first created.␊ - */␊ - creation?: string␊ - _creation?: Element58␊ - }␊ - /**␊ - * This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.␊ - */␊ - export interface ExplanationOfBenefit_ProcessNote {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * An integer with a value that is positive (e.g. >0)␊ - */␊ - number?: number␊ - _number?: Element876␊ - /**␊ - * The business purpose of the note text.␊ - */␊ - type?: ("display" | "print" | "printoper")␊ - _type?: Element877␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element878␊ - language?: CodeableConcept225␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element876 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element877 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element878 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept225 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period66 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.␊ - */␊ - export interface ExplanationOfBenefit_BenefitBalance {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - category: CodeableConcept226␊ - /**␊ - * True if the indicated class of service is excluded from the plan, missing or False indicates the product or service is included in the coverage.␊ - */␊ - excluded?: boolean␊ - _excluded?: Element879␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element880␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element881␊ - network?: CodeableConcept227␊ - unit?: CodeableConcept228␊ - term?: CodeableConcept229␊ - /**␊ - * Benefits Used to date.␊ - */␊ - financial?: ExplanationOfBenefit_Financial[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept226 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element879 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element880 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element881 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept227 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept228 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept229 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.␊ - */␊ - export interface ExplanationOfBenefit_Financial {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - type: CodeableConcept230␊ - /**␊ - * The quantity of the benefit which is permitted under the coverage.␊ - */␊ - allowedUnsignedInt?: number␊ - _allowedUnsignedInt?: Element882␊ - /**␊ - * The quantity of the benefit which is permitted under the coverage.␊ - */␊ - allowedString?: string␊ - _allowedString?: Element883␊ - allowedMoney?: Money42␊ - /**␊ - * The quantity of the benefit which have been consumed to date.␊ - */␊ - usedUnsignedInt?: number␊ - _usedUnsignedInt?: Element884␊ - usedMoney?: Money43␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept230 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element882 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element883 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The quantity of the benefit which is permitted under the coverage.␊ - */␊ - export interface Money42 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element884 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The quantity of the benefit which have been consumed to date.␊ - */␊ - export interface Money43 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * Significant health conditions for a person related to the patient relevant in the context of care for the patient.␊ - */␊ - export interface FamilyMemberHistory {␊ - /**␊ - * This is a FamilyMemberHistory resource␊ - */␊ - resourceType: "FamilyMemberHistory"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta54␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element885␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element886␊ - text?: Narrative52␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Business identifiers assigned to this family member history by the performer or other systems which remain constant as the resource is updated and propagates from server to server.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.␊ - */␊ - instantiatesCanonical?: Canonical[]␊ - /**␊ - * The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.␊ - */␊ - instantiatesUri?: Uri[]␊ - /**␊ - * Extensions for instantiatesUri␊ - */␊ - _instantiatesUri?: Element23[]␊ - /**␊ - * A code specifying the status of the record of the family history of a specific family member.␊ - */␊ - status?: ("partial" | "completed" | "entered-in-error" | "health-unknown")␊ - _status?: Element887␊ - dataAbsentReason?: CodeableConcept231␊ - patient: Reference227␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - date?: string␊ - _date?: Element888␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element889␊ - relationship: CodeableConcept232␊ - sex?: CodeableConcept233␊ - bornPeriod?: Period67␊ - /**␊ - * The actual or approximate date of birth of the relative.␊ - */␊ - bornDate?: string␊ - _bornDate?: Element890␊ - /**␊ - * The actual or approximate date of birth of the relative.␊ - */␊ - bornString?: string␊ - _bornString?: Element891␊ - ageAge?: Age5␊ - ageRange?: Range10␊ - /**␊ - * The age of the relative at the time the family member history is recorded.␊ - */␊ - ageString?: string␊ - _ageString?: Element892␊ - /**␊ - * If true, indicates that the age value specified is an estimated value.␊ - */␊ - estimatedAge?: boolean␊ - _estimatedAge?: Element893␊ - /**␊ - * Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.␊ - */␊ - deceasedBoolean?: boolean␊ - _deceasedBoolean?: Element894␊ - deceasedAge?: Age6␊ - deceasedRange?: Range11␊ - /**␊ - * Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.␊ - */␊ - deceasedDate?: string␊ - _deceasedDate?: Element895␊ - /**␊ - * Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.␊ - */␊ - deceasedString?: string␊ - _deceasedString?: Element896␊ - /**␊ - * Describes why the family member history occurred in coded or textual form.␊ - */␊ - reasonCode?: CodeableConcept5[]␊ - /**␊ - * Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.␊ - */␊ - reasonReference?: Reference11[]␊ - /**␊ - * This property allows a non condition-specific note to the made about the related person. Ideally, the note would be in the condition property, but this is not always possible.␊ - */␊ - note?: Annotation1[]␊ - /**␊ - * The significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition.␊ - */␊ - condition?: FamilyMemberHistory_Condition[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta54 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element885 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element886 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative52 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element887 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept231 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference227 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element888 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element889 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept232 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept233 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period67 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element890 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element891 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The age of the relative at the time the family member history is recorded.␊ - */␊ - export interface Age5 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element31␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element32␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element33␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element34␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element35␊ - }␊ - /**␊ - * The age of the relative at the time the family member history is recorded.␊ - */␊ - export interface Range10 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - low?: Quantity1␊ - high?: Quantity2␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element892 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element893 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element894 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.␊ - */␊ - export interface Age6 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element31␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element32␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element33␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element34␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element35␊ - }␊ - /**␊ - * Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.␊ - */␊ - export interface Range11 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - low?: Quantity1␊ - high?: Quantity2␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element895 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element896 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Significant health conditions for a person related to the patient relevant in the context of care for the patient.␊ - */␊ - export interface FamilyMemberHistory_Condition {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - code: CodeableConcept234␊ - outcome?: CodeableConcept235␊ - /**␊ - * This condition contributed to the cause of death of the related person. If contributedToDeath is not populated, then it is unknown.␊ - */␊ - contributedToDeath?: boolean␊ - _contributedToDeath?: Element897␊ - onsetAge?: Age7␊ - onsetRange?: Range12␊ - onsetPeriod?: Period68␊ - /**␊ - * Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.␊ - */␊ - onsetString?: string␊ - _onsetString?: Element898␊ - /**␊ - * An area where general notes can be placed about this specific condition.␊ - */␊ - note?: Annotation1[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept234 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept235 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element897 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.␊ - */␊ - export interface Age7 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element31␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element32␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element33␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element34␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element35␊ - }␊ - /**␊ - * Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.␊ - */␊ - export interface Range12 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - low?: Quantity1␊ - high?: Quantity2␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period68 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element898 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Prospective warnings of potential issues when providing care to the patient.␊ - */␊ - export interface Flag {␊ - /**␊ - * This is a Flag resource␊ - */␊ - resourceType: "Flag"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta55␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element899␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element900␊ - text?: Narrative53␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Business identifiers assigned to this flag by the performer or other systems which remain constant as the resource is updated and propagates from server to server.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * Supports basic workflow.␊ - */␊ - status?: ("active" | "inactive" | "entered-in-error")␊ - _status?: Element901␊ - /**␊ - * Allows a flag to be divided into different categories like clinical, administrative etc. Intended to be used as a means of filtering which flags are displayed to particular user or in a given context.␊ - */␊ - category?: CodeableConcept5[]␊ - code: CodeableConcept236␊ - subject: Reference228␊ - period?: Period69␊ - encounter?: Reference229␊ - author?: Reference230␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta55 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element899 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element900 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative53 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element901 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept236 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference228 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period69 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference229 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference230 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Describes the intended objective(s) for a patient, group or organization care, for example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.␊ - */␊ - export interface Goal {␊ - /**␊ - * This is a Goal resource␊ - */␊ - resourceType: "Goal"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta56␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element902␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element903␊ - text?: Narrative54␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Business identifiers assigned to this goal by the performer or other systems which remain constant as the resource is updated and propagates from server to server.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * The state of the goal throughout its lifecycle.␊ - */␊ - lifecycleStatus?: ("proposed" | "planned" | "accepted" | "active" | "on-hold" | "completed" | "cancelled" | "entered-in-error" | "rejected")␊ - _lifecycleStatus?: Element904␊ - achievementStatus?: CodeableConcept237␊ - /**␊ - * Indicates a category the goal falls within.␊ - */␊ - category?: CodeableConcept5[]␊ - priority?: CodeableConcept238␊ - description: CodeableConcept239␊ - subject: Reference231␊ - /**␊ - * The date or event after which the goal should begin being pursued.␊ - */␊ - startDate?: string␊ - _startDate?: Element905␊ - startCodeableConcept?: CodeableConcept240␊ - /**␊ - * Indicates what should be done by when.␊ - */␊ - target?: Goal_Target[]␊ - /**␊ - * Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.␊ - */␊ - statusDate?: string␊ - _statusDate?: Element910␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - statusReason?: string␊ - _statusReason?: Element911␊ - expressedBy?: Reference232␊ - /**␊ - * The identified conditions and other health record elements that are intended to be addressed by the goal.␊ - */␊ - addresses?: Reference11[]␊ - /**␊ - * Any comments related to the goal.␊ - */␊ - note?: Annotation1[]␊ - /**␊ - * Identifies the change (or lack of change) at the point when the status of the goal is assessed.␊ - */␊ - outcomeCode?: CodeableConcept5[]␊ - /**␊ - * Details of what's changed (or not changed).␊ - */␊ - outcomeReference?: Reference11[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta56 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element902 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element903 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative54 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element904 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept237 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept238 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept239 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference231 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element905 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept240 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Describes the intended objective(s) for a patient, group or organization care, for example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.␊ - */␊ - export interface Goal_Target {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - measure?: CodeableConcept241␊ - detailQuantity?: Quantity43␊ - detailRange?: Range13␊ - detailCodeableConcept?: CodeableConcept242␊ - /**␊ - * The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.␊ - */␊ - detailString?: string␊ - _detailString?: Element906␊ - /**␊ - * The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.␊ - */␊ - detailBoolean?: boolean␊ - _detailBoolean?: Element907␊ - /**␊ - * The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.␊ - */␊ - detailInteger?: number␊ - _detailInteger?: Element908␊ - detailRatio?: Ratio3␊ - /**␊ - * Indicates either the date or the duration after start by which the goal should be met.␊ - */␊ - dueDate?: string␊ - _dueDate?: Element909␊ - dueDuration?: Duration7␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept241 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity43 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.␊ - */␊ - export interface Range13 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - low?: Quantity1␊ - high?: Quantity2␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept242 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element906 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element907 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element908 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.␊ - */␊ - export interface Ratio3 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - numerator?: Quantity3␊ - denominator?: Quantity4␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element909 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Indicates either the date or the duration after start by which the goal should be met.␊ - */␊ - export interface Duration7 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element73␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element74␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element75␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element76␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element77␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element910 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element911 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference232 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A formal computable definition of a graph of resources - that is, a coherent set of resources that form a graph by following references. The Graph Definition resource defines a set and makes rules about the set.␊ - */␊ - export interface GraphDefinition {␊ - /**␊ - * This is a GraphDefinition resource␊ - */␊ - resourceType: "GraphDefinition"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta57␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element912␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element913␊ - text?: Narrative55␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - url?: string␊ - _url?: Element914␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element915␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element916␊ - /**␊ - * The status of this graph definition. Enables tracking the life-cycle of the content.␊ - */␊ - status?: ("draft" | "active" | "retired" | "unknown")␊ - _status?: Element917␊ - /**␊ - * A Boolean value to indicate that this graph definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.␊ - */␊ - experimental?: boolean␊ - _experimental?: Element918␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - date?: string␊ - _date?: Element919␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - publisher?: string␊ - _publisher?: Element920␊ - /**␊ - * Contact details to assist a user in finding and communicating with the publisher.␊ - */␊ - contact?: ContactDetail1[]␊ - /**␊ - * A free text natural language description of the graph definition from a consumer's perspective.␊ - */␊ - description?: string␊ - _description?: Element921␊ - /**␊ - * The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate graph definition instances.␊ - */␊ - useContext?: UsageContext1[]␊ - /**␊ - * A legal or geographic region in which the graph definition is intended to be used.␊ - */␊ - jurisdiction?: CodeableConcept5[]␊ - /**␊ - * Explanation of why this graph definition is needed and why it has been designed as it has.␊ - */␊ - purpose?: string␊ - _purpose?: Element922␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - start?: string␊ - _start?: Element923␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - profile?: string␊ - /**␊ - * Links this graph makes rules about.␊ - */␊ - link?: GraphDefinition_Link[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta57 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element912 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element913 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative55 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element914 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element915 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element916 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element917 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element918 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element919 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element920 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element921 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element922 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element923 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A formal computable definition of a graph of resources - that is, a coherent set of resources that form a graph by following references. The Graph Definition resource defines a set and makes rules about the set.␊ - */␊ - export interface GraphDefinition_Link {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - path?: string␊ - _path?: Element924␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - sliceName?: string␊ - _sliceName?: Element925␊ - /**␊ - * Minimum occurrences for this link.␊ - */␊ - min?: number␊ - _min?: Element926␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - max?: string␊ - _max?: Element927␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element928␊ - /**␊ - * Potential target for the link.␊ - */␊ - target?: GraphDefinition_Target[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element924 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element925 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element926 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element927 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element928 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A formal computable definition of a graph of resources - that is, a coherent set of resources that form a graph by following references. The Graph Definition resource defines a set and makes rules about the set.␊ - */␊ - export interface GraphDefinition_Target {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - type?: string␊ - _type?: Element929␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - params?: string␊ - _params?: Element930␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - profile?: string␊ - /**␊ - * Compartment Consistency Rules.␊ - */␊ - compartment?: GraphDefinition_Compartment[]␊ - /**␊ - * Additional links from target resource.␊ - */␊ - link?: GraphDefinition_Link[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element929 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element930 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A formal computable definition of a graph of resources - that is, a coherent set of resources that form a graph by following references. The Graph Definition resource defines a set and makes rules about the set.␊ - */␊ - export interface GraphDefinition_Compartment {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Defines how the compartment rule is used - whether it it is used to test whether resources are subject to the rule, or whether it is a rule that must be followed.␊ - */␊ - use?: ("condition" | "requirement")␊ - _use?: Element931␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - code?: string␊ - _code?: Element932␊ - /**␊ - * identical | matching | different | no-rule | custom.␊ - */␊ - rule?: ("identical" | "matching" | "different" | "custom")␊ - _rule?: Element933␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - expression?: string␊ - _expression?: Element934␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element935␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element931 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element932 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element933 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element934 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element935 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Represents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively, and are not formally or legally recognized; i.e. a collection of entities that isn't an Organization.␊ - */␊ - export interface Group {␊ - /**␊ - * This is a Group resource␊ - */␊ - resourceType: "Group"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta58␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element936␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element937␊ - text?: Narrative56␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A unique business identifier for this group.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * Indicates whether the record for the group is available for use or is merely being retained for historical purposes.␊ - */␊ - active?: boolean␊ - _active?: Element938␊ - /**␊ - * Identifies the broad classification of the kind of resources the group includes.␊ - */␊ - type?: ("person" | "animal" | "practitioner" | "device" | "medication" | "substance")␊ - _type?: Element939␊ - /**␊ - * If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals.␊ - */␊ - actual?: boolean␊ - _actual?: Element940␊ - code?: CodeableConcept243␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element941␊ - /**␊ - * An integer with a value that is not negative (e.g. >= 0)␊ - */␊ - quantity?: number␊ - _quantity?: Element942␊ - managingEntity?: Reference233␊ - /**␊ - * Identifies traits whose presence r absence is shared by members of the group.␊ - */␊ - characteristic?: Group_Characteristic[]␊ - /**␊ - * Identifies the resource instances that are members of the group.␊ - */␊ - member?: Group_Member[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta58 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element936 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element937 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative56 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element938 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element939 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element940 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept243 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element941 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element942 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference233 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Represents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively, and are not formally or legally recognized; i.e. a collection of entities that isn't an Organization.␊ - */␊ - export interface Group_Characteristic {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - code: CodeableConcept244␊ - valueCodeableConcept?: CodeableConcept245␊ - /**␊ - * The value of the trait that holds (or does not hold - see 'exclude') for members of the group.␊ - */␊ - valueBoolean?: boolean␊ - _valueBoolean?: Element943␊ - valueQuantity?: Quantity44␊ - valueRange?: Range14␊ - valueReference?: Reference234␊ - /**␊ - * If true, indicates the characteristic is one that is NOT held by members of the group.␊ - */␊ - exclude?: boolean␊ - _exclude?: Element944␊ - period?: Period70␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept244 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept245 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element943 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity44 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * The value of the trait that holds (or does not hold - see 'exclude') for members of the group.␊ - */␊ - export interface Range14 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - low?: Quantity1␊ - high?: Quantity2␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference234 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element944 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period70 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Represents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively, and are not formally or legally recognized; i.e. a collection of entities that isn't an Organization.␊ - */␊ - export interface Group_Member {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - entity: Reference235␊ - period?: Period71␊ - /**␊ - * A flag to indicate that the member is no longer in the group, but previously may have been a member.␊ - */␊ - inactive?: boolean␊ - _inactive?: Element945␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference235 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period71 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element945 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A guidance response is the formal response to a guidance request, including any output parameters returned by the evaluation, as well as the description of any proposed actions to be taken.␊ - */␊ - export interface GuidanceResponse {␊ - /**␊ - * This is a GuidanceResponse resource␊ - */␊ - resourceType: "GuidanceResponse"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta59␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element946␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element947␊ - text?: Narrative57␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - requestIdentifier?: Identifier23␊ - /**␊ - * Allows a service to provide unique, business identifiers for the response.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * An identifier, CodeableConcept or canonical reference to the guidance that was requested.␊ - */␊ - moduleUri?: string␊ - _moduleUri?: Element948␊ - /**␊ - * An identifier, CodeableConcept or canonical reference to the guidance that was requested.␊ - */␊ - moduleCanonical?: string␊ - _moduleCanonical?: Element949␊ - moduleCodeableConcept?: CodeableConcept246␊ - /**␊ - * The status of the response. If the evaluation is completed successfully, the status will indicate success. However, in order to complete the evaluation, the engine may require more information. In this case, the status will be data-required, and the response will contain a description of the additional required information. If the evaluation completed successfully, but the engine determines that a potentially more accurate response could be provided if more data was available, the status will be data-requested, and the response will contain a description of the additional requested information.␊ - */␊ - status?: ("success" | "data-requested" | "data-required" | "in-progress" | "failure" | "entered-in-error")␊ - _status?: Element950␊ - subject?: Reference236␊ - encounter?: Reference237␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - occurrenceDateTime?: string␊ - _occurrenceDateTime?: Element951␊ - performer?: Reference238␊ - /**␊ - * Describes the reason for the guidance response in coded or textual form.␊ - */␊ - reasonCode?: CodeableConcept5[]␊ - /**␊ - * Indicates the reason the request was initiated. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response.␊ - */␊ - reasonReference?: Reference11[]␊ - /**␊ - * Provides a mechanism to communicate additional information about the response.␊ - */␊ - note?: Annotation1[]␊ - /**␊ - * Messages resulting from the evaluation of the artifact or artifacts. As part of evaluating the request, the engine may produce informational or warning messages. These messages will be provided by this element.␊ - */␊ - evaluationMessage?: Reference11[]␊ - outputParameters?: Reference239␊ - result?: Reference240␊ - /**␊ - * If the evaluation could not be completed due to lack of information, or additional information would potentially result in a more accurate response, this element will a description of the data required in order to proceed with the evaluation. A subsequent request to the service should include this data.␊ - */␊ - dataRequirement?: DataRequirement1[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta59 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element946 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element947 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative57 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier23 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element948 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element949 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept246 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element950 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference236 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference237 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element951 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference238 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference239 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference240 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * The details of a healthcare service available at a location.␊ - */␊ - export interface HealthcareService {␊ - /**␊ - * This is a HealthcareService resource␊ - */␊ - resourceType: "HealthcareService"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta60␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element952␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element953␊ - text?: Narrative58␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * External identifiers for this item.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * This flag is used to mark the record to not be used. This is not used when a center is closed for maintenance, or for holidays, the notAvailable period is to be used for this.␊ - */␊ - active?: boolean␊ - _active?: Element954␊ - providedBy?: Reference241␊ - /**␊ - * Identifies the broad category of service being performed or delivered.␊ - */␊ - category?: CodeableConcept5[]␊ - /**␊ - * The specific type of service that may be delivered or performed.␊ - */␊ - type?: CodeableConcept5[]␊ - /**␊ - * Collection of specialties handled by the service site. This is more of a medical term.␊ - */␊ - specialty?: CodeableConcept5[]␊ - /**␊ - * The location(s) where this healthcare service may be provided.␊ - */␊ - location?: Reference11[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element955␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - comment?: string␊ - _comment?: Element956␊ - /**␊ - * Extra details about the service that can't be placed in the other fields.␊ - */␊ - extraDetails?: string␊ - _extraDetails?: Element957␊ - photo?: Attachment16␊ - /**␊ - * List of contacts related to this specific healthcare service.␊ - */␊ - telecom?: ContactPoint1[]␊ - /**␊ - * The location(s) that this service is available to (not where the service is provided).␊ - */␊ - coverageArea?: Reference11[]␊ - /**␊ - * The code(s) that detail the conditions under which the healthcare service is available/offered.␊ - */␊ - serviceProvisionCode?: CodeableConcept5[]␊ - /**␊ - * Does this service have specific eligibility requirements that need to be met in order to use the service?␊ - */␊ - eligibility?: HealthcareService_Eligibility[]␊ - /**␊ - * Programs that this service is applicable to.␊ - */␊ - program?: CodeableConcept5[]␊ - /**␊ - * Collection of characteristics (attributes).␊ - */␊ - characteristic?: CodeableConcept5[]␊ - /**␊ - * Some services are specifically made available in multiple languages, this property permits a directory to declare the languages this is offered in. Typically this is only provided where a service operates in communities with mixed languages used.␊ - */␊ - communication?: CodeableConcept5[]␊ - /**␊ - * Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.␊ - */␊ - referralMethod?: CodeableConcept5[]␊ - /**␊ - * Indicates whether or not a prospective consumer will require an appointment for a particular service at a site to be provided by the Organization. Indicates if an appointment is required for access to this service.␊ - */␊ - appointmentRequired?: boolean␊ - _appointmentRequired?: Element959␊ - /**␊ - * A collection of times that the Service Site is available.␊ - */␊ - availableTime?: HealthcareService_AvailableTime[]␊ - /**␊ - * The HealthcareService is not available during this period of time due to the provided reason.␊ - */␊ - notAvailable?: HealthcareService_NotAvailable[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - availabilityExceptions?: string␊ - _availabilityExceptions?: Element964␊ - /**␊ - * Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.␊ - */␊ - endpoint?: Reference11[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta60 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element952 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element953 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative58 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element954 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference241 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element955 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element956 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element957 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * For referring to data content defined in other formats.␊ - */␊ - export interface Attachment16 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.␊ - */␊ - contentType?: string␊ - _contentType?: Element51␊ - /**␊ - * The human language of the content. The value can be any valid value according to BCP 47.␊ - */␊ - language?: string␊ - _language?: Element52␊ - /**␊ - * The actual data of the attachment - a sequence of bytes, base64 encoded.␊ - */␊ - data?: string␊ - _data?: Element53␊ - /**␊ - * A location where the data can be accessed.␊ - */␊ - url?: string␊ - _url?: Element54␊ - /**␊ - * The number of bytes of data that make up this attachment (before base64 encoding, if that is done).␊ - */␊ - size?: number␊ - _size?: Element55␊ - /**␊ - * The calculated hash of the data using SHA-1. Represented using base64.␊ - */␊ - hash?: string␊ - _hash?: Element56␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element57␊ - /**␊ - * The date that the attachment was first created.␊ - */␊ - creation?: string␊ - _creation?: Element58␊ - }␊ - /**␊ - * The details of a healthcare service available at a location.␊ - */␊ - export interface HealthcareService_Eligibility {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - code?: CodeableConcept247␊ - /**␊ - * Describes the eligibility conditions for the service.␊ - */␊ - comment?: string␊ - _comment?: Element958␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept247 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element958 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element959 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The details of a healthcare service available at a location.␊ - */␊ - export interface HealthcareService_AvailableTime {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Indicates which days of the week are available between the start and end Times.␊ - */␊ - daysOfWeek?: ("mon" | "tue" | "wed" | "thu" | "fri" | "sat" | "sun")[]␊ - /**␊ - * Extensions for daysOfWeek␊ - */␊ - _daysOfWeek?: Element23[]␊ - /**␊ - * Is this always available? (hence times are irrelevant) e.g. 24 hour service.␊ - */␊ - allDay?: boolean␊ - _allDay?: Element960␊ - /**␊ - * A time during the day, with no date specified␊ - */␊ - availableStartTime?: string␊ - _availableStartTime?: Element961␊ - /**␊ - * A time during the day, with no date specified␊ - */␊ - availableEndTime?: string␊ - _availableEndTime?: Element962␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element960 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element961 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element962 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The details of a healthcare service available at a location.␊ - */␊ - export interface HealthcareService_NotAvailable {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element963␊ - during?: Period72␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element963 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period72 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element964 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Representation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A series is of only one modality (e.g. X-ray, CT, MR, ultrasound), but a study may have multiple series of different modalities.␊ - */␊ - export interface ImagingStudy {␊ - /**␊ - * This is a ImagingStudy resource␊ - */␊ - resourceType: "ImagingStudy"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta61␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element965␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element966␊ - text?: Narrative59␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifiers for the ImagingStudy such as DICOM Study Instance UID, and Accession Number.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * The current state of the ImagingStudy.␊ - */␊ - status?: ("registered" | "available" | "cancelled" | "entered-in-error" | "unknown")␊ - _status?: Element967␊ - /**␊ - * A list of all the series.modality values that are actual acquisition modalities, i.e. those in the DICOM Context Group 29 (value set OID 1.2.840.10008.6.1.19).␊ - */␊ - modality?: Coding[]␊ - subject: Reference242␊ - encounter?: Reference243␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - started?: string␊ - _started?: Element968␊ - /**␊ - * A list of the diagnostic requests that resulted in this imaging study being performed.␊ - */␊ - basedOn?: Reference11[]␊ - referrer?: Reference244␊ - /**␊ - * Who read the study and interpreted the images or other content.␊ - */␊ - interpreter?: Reference11[]␊ - /**␊ - * The network service providing access (e.g., query, view, or retrieval) for the study. See implementation notes for information about using DICOM endpoints. A study-level endpoint applies to each series in the study, unless overridden by a series-level endpoint with the same Endpoint.connectionType.␊ - */␊ - endpoint?: Reference11[]␊ - /**␊ - * An integer with a value that is not negative (e.g. >= 0)␊ - */␊ - numberOfSeries?: number␊ - _numberOfSeries?: Element969␊ - /**␊ - * An integer with a value that is not negative (e.g. >= 0)␊ - */␊ - numberOfInstances?: number␊ - _numberOfInstances?: Element970␊ - procedureReference?: Reference245␊ - /**␊ - * The code for the performed procedure type.␊ - */␊ - procedureCode?: CodeableConcept5[]␊ - location?: Reference246␊ - /**␊ - * Description of clinical condition indicating why the ImagingStudy was requested.␊ - */␊ - reasonCode?: CodeableConcept5[]␊ - /**␊ - * Indicates another resource whose existence justifies this Study.␊ - */␊ - reasonReference?: Reference11[]␊ - /**␊ - * Per the recommended DICOM mapping, this element is derived from the Study Description attribute (0008,1030). Observations or findings about the imaging study should be recorded in another resource, e.g. Observation, and not in this element.␊ - */␊ - note?: Annotation1[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element971␊ - /**␊ - * Each study has one or more series of images or other content.␊ - */␊ - series?: ImagingStudy_Series[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta61 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element965 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element966 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative59 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element967 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference242 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference243 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element968 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference244 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element969 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element970 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference245 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference246 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element971 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Representation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A series is of only one modality (e.g. X-ray, CT, MR, ultrasound), but a study may have multiple series of different modalities.␊ - */␊ - export interface ImagingStudy_Series {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * The DICOM Series Instance UID for the series.␊ - */␊ - uid?: string␊ - _uid?: Element972␊ - /**␊ - * An integer with a value that is not negative (e.g. >= 0)␊ - */␊ - number?: number␊ - _number?: Element973␊ - modality: Coding20␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element974␊ - /**␊ - * An integer with a value that is not negative (e.g. >= 0)␊ - */␊ - numberOfInstances?: number␊ - _numberOfInstances?: Element975␊ - /**␊ - * The network service providing access (e.g., query, view, or retrieval) for this series. See implementation notes for information about using DICOM endpoints. A series-level endpoint, if present, has precedence over a study-level endpoint with the same Endpoint.connectionType.␊ - */␊ - endpoint?: Reference11[]␊ - bodySite?: Coding21␊ - laterality?: Coding22␊ - /**␊ - * The specimen imaged, e.g., for whole slide imaging of a biopsy.␊ - */␊ - specimen?: Reference11[]␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - started?: string␊ - _started?: Element976␊ - /**␊ - * Indicates who or what performed the series and how they were involved.␊ - */␊ - performer?: ImagingStudy_Performer[]␊ - /**␊ - * A single SOP instance within the series, e.g. an image, or presentation state.␊ - */␊ - instance?: ImagingStudy_Instance[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element972 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element973 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - export interface Coding20 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The identification of the code system that defines the meaning of the symbol in the code.␊ - */␊ - system?: string␊ - _system?: Element39␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element40␊ - /**␊ - * A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).␊ - */␊ - code?: string␊ - _code?: Element41␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element42␊ - /**␊ - * Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).␊ - */␊ - userSelected?: boolean␊ - _userSelected?: Element43␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element974 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element975 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - export interface Coding21 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The identification of the code system that defines the meaning of the symbol in the code.␊ - */␊ - system?: string␊ - _system?: Element39␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element40␊ - /**␊ - * A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).␊ - */␊ - code?: string␊ - _code?: Element41␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element42␊ - /**␊ - * Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).␊ - */␊ - userSelected?: boolean␊ - _userSelected?: Element43␊ - }␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - export interface Coding22 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The identification of the code system that defines the meaning of the symbol in the code.␊ - */␊ - system?: string␊ - _system?: Element39␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element40␊ - /**␊ - * A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).␊ - */␊ - code?: string␊ - _code?: Element41␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element42␊ - /**␊ - * Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).␊ - */␊ - userSelected?: boolean␊ - _userSelected?: Element43␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element976 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Representation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A series is of only one modality (e.g. X-ray, CT, MR, ultrasound), but a study may have multiple series of different modalities.␊ - */␊ - export interface ImagingStudy_Performer {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - function?: CodeableConcept248␊ - actor: Reference247␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept248 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference247 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Representation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A series is of only one modality (e.g. X-ray, CT, MR, ultrasound), but a study may have multiple series of different modalities.␊ - */␊ - export interface ImagingStudy_Instance {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * The DICOM SOP Instance UID for this image or other DICOM content.␊ - */␊ - uid?: string␊ - _uid?: Element977␊ - sopClass: Coding23␊ - /**␊ - * An integer with a value that is not negative (e.g. >= 0)␊ - */␊ - number?: number␊ - _number?: Element978␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element979␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element977 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - export interface Coding23 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The identification of the code system that defines the meaning of the symbol in the code.␊ - */␊ - system?: string␊ - _system?: Element39␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element40␊ - /**␊ - * A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).␊ - */␊ - code?: string␊ - _code?: Element41␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element42␊ - /**␊ - * Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).␊ - */␊ - userSelected?: boolean␊ - _userSelected?: Element43␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element978 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element979 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.␊ - */␊ - export interface Immunization {␊ - /**␊ - * This is a Immunization resource␊ - */␊ - resourceType: "Immunization"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta62␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element980␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element981␊ - text?: Narrative60␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A unique identifier assigned to this immunization record.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - status?: string␊ - _status?: Element982␊ - statusReason?: CodeableConcept249␊ - vaccineCode: CodeableConcept250␊ - patient: Reference248␊ - encounter?: Reference249␊ - /**␊ - * Date vaccine administered or was to be administered.␊ - */␊ - occurrenceDateTime?: string␊ - _occurrenceDateTime?: Element983␊ - /**␊ - * Date vaccine administered or was to be administered.␊ - */␊ - occurrenceString?: string␊ - _occurrenceString?: Element984␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - recorded?: string␊ - _recorded?: Element985␊ - /**␊ - * An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.␊ - */␊ - primarySource?: boolean␊ - _primarySource?: Element986␊ - reportOrigin?: CodeableConcept251␊ - location?: Reference250␊ - manufacturer?: Reference251␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - lotNumber?: string␊ - _lotNumber?: Element987␊ - /**␊ - * Date vaccine batch expires.␊ - */␊ - expirationDate?: string␊ - _expirationDate?: Element988␊ - site?: CodeableConcept252␊ - route?: CodeableConcept253␊ - doseQuantity?: Quantity45␊ - /**␊ - * Indicates who performed the immunization event.␊ - */␊ - performer?: Immunization_Performer[]␊ - /**␊ - * Extra information about the immunization that is not conveyed by the other attributes.␊ - */␊ - note?: Annotation1[]␊ - /**␊ - * Reasons why the vaccine was administered.␊ - */␊ - reasonCode?: CodeableConcept5[]␊ - /**␊ - * Condition, Observation or DiagnosticReport that supports why the immunization was administered.␊ - */␊ - reasonReference?: Reference11[]␊ - /**␊ - * Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.␊ - */␊ - isSubpotent?: boolean␊ - _isSubpotent?: Element989␊ - /**␊ - * Reason why a dose is considered to be subpotent.␊ - */␊ - subpotentReason?: CodeableConcept5[]␊ - /**␊ - * Educational material presented to the patient (or guardian) at the time of vaccine administration.␊ - */␊ - education?: Immunization_Education[]␊ - /**␊ - * Indicates a patient's eligibility for a funding program.␊ - */␊ - programEligibility?: CodeableConcept5[]␊ - fundingSource?: CodeableConcept255␊ - /**␊ - * Categorical data indicating that an adverse event is associated in time to an immunization.␊ - */␊ - reaction?: Immunization_Reaction[]␊ - /**␊ - * The protocol (set of recommendations) being followed by the provider who administered the dose.␊ - */␊ - protocolApplied?: Immunization_ProtocolApplied[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta62 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element980 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element981 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative60 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element982 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept249 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept250 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference248 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference249 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element983 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element984 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element985 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element986 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept251 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference250 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference251 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element987 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element988 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept252 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept253 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity45 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.␊ - */␊ - export interface Immunization_Performer {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - function?: CodeableConcept254␊ - actor: Reference252␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept254 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference252 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element989 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.␊ - */␊ - export interface Immunization_Education {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - documentType?: string␊ - _documentType?: Element990␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - reference?: string␊ - _reference?: Element991␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - publicationDate?: string␊ - _publicationDate?: Element992␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - presentationDate?: string␊ - _presentationDate?: Element993␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element990 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element991 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element992 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element993 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept255 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.␊ - */␊ - export interface Immunization_Reaction {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - date?: string␊ - _date?: Element994␊ - detail?: Reference253␊ - /**␊ - * Self-reported indicator.␊ - */␊ - reported?: boolean␊ - _reported?: Element995␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element994 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference253 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element995 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.␊ - */␊ - export interface Immunization_ProtocolApplied {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - series?: string␊ - _series?: Element996␊ - authority?: Reference254␊ - /**␊ - * The vaccine preventable disease the dose is being administered against.␊ - */␊ - targetDisease?: CodeableConcept5[]␊ - /**␊ - * Nominal position in a series.␊ - */␊ - doseNumberPositiveInt?: number␊ - _doseNumberPositiveInt?: Element997␊ - /**␊ - * Nominal position in a series.␊ - */␊ - doseNumberString?: string␊ - _doseNumberString?: Element998␊ - /**␊ - * The recommended number of doses to achieve immunity.␊ - */␊ - seriesDosesPositiveInt?: number␊ - _seriesDosesPositiveInt?: Element999␊ - /**␊ - * The recommended number of doses to achieve immunity.␊ - */␊ - seriesDosesString?: string␊ - _seriesDosesString?: Element1000␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element996 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference254 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element997 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element998 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element999 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1000 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Describes a comparison of an immunization event against published recommendations to determine if the administration is "valid" in relation to those recommendations.␊ - */␊ - export interface ImmunizationEvaluation {␊ - /**␊ - * This is a ImmunizationEvaluation resource␊ - */␊ - resourceType: "ImmunizationEvaluation"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta63␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1001␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1002␊ - text?: Narrative61␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A unique identifier assigned to this immunization evaluation record.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - status?: string␊ - _status?: Element1003␊ - patient: Reference255␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - date?: string␊ - _date?: Element1004␊ - authority?: Reference256␊ - targetDisease: CodeableConcept256␊ - immunizationEvent: Reference257␊ - doseStatus: CodeableConcept257␊ - /**␊ - * Provides an explanation as to why the vaccine administration event is valid or not relative to the published recommendations.␊ - */␊ - doseStatusReason?: CodeableConcept5[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element1005␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - series?: string␊ - _series?: Element1006␊ - /**␊ - * Nominal position in a series.␊ - */␊ - doseNumberPositiveInt?: number␊ - _doseNumberPositiveInt?: Element1007␊ - /**␊ - * Nominal position in a series.␊ - */␊ - doseNumberString?: string␊ - _doseNumberString?: Element1008␊ - /**␊ - * The recommended number of doses to achieve immunity.␊ - */␊ - seriesDosesPositiveInt?: number␊ - _seriesDosesPositiveInt?: Element1009␊ - /**␊ - * The recommended number of doses to achieve immunity.␊ - */␊ - seriesDosesString?: string␊ - _seriesDosesString?: Element1010␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta63 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1001 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1002 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative61 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1003 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference255 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1004 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference256 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept256 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference257 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept257 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1005 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1006 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1007 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1008 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1009 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1010 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A patient's point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification.␊ - */␊ - export interface ImmunizationRecommendation {␊ - /**␊ - * This is a ImmunizationRecommendation resource␊ - */␊ - resourceType: "ImmunizationRecommendation"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta64␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1011␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1012␊ - text?: Narrative62␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A unique identifier assigned to this particular recommendation record.␊ - */␊ - identifier?: Identifier2[]␊ - patient: Reference258␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - date?: string␊ - _date?: Element1013␊ - authority?: Reference259␊ - /**␊ - * Vaccine administration recommendations.␊ - */␊ - recommendation: ImmunizationRecommendation_Recommendation[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta64 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1011 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1012 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative62 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference258 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1013 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference259 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A patient's point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification.␊ - */␊ - export interface ImmunizationRecommendation_Recommendation {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Vaccine(s) or vaccine group that pertain to the recommendation.␊ - */␊ - vaccineCode?: CodeableConcept5[]␊ - targetDisease?: CodeableConcept258␊ - /**␊ - * Vaccine(s) which should not be used to fulfill the recommendation.␊ - */␊ - contraindicatedVaccineCode?: CodeableConcept5[]␊ - forecastStatus: CodeableConcept259␊ - /**␊ - * The reason for the assigned forecast status.␊ - */␊ - forecastReason?: CodeableConcept5[]␊ - /**␊ - * Vaccine date recommendations. For example, earliest date to administer, latest date to administer, etc.␊ - */␊ - dateCriterion?: ImmunizationRecommendation_DateCriterion[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element1015␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - series?: string␊ - _series?: Element1016␊ - /**␊ - * Nominal position of the recommended dose in a series (e.g. dose 2 is the next recommended dose).␊ - */␊ - doseNumberPositiveInt?: number␊ - _doseNumberPositiveInt?: Element1017␊ - /**␊ - * Nominal position of the recommended dose in a series (e.g. dose 2 is the next recommended dose).␊ - */␊ - doseNumberString?: string␊ - _doseNumberString?: Element1018␊ - /**␊ - * The recommended number of doses to achieve immunity.␊ - */␊ - seriesDosesPositiveInt?: number␊ - _seriesDosesPositiveInt?: Element1019␊ - /**␊ - * The recommended number of doses to achieve immunity.␊ - */␊ - seriesDosesString?: string␊ - _seriesDosesString?: Element1020␊ - /**␊ - * Immunization event history and/or evaluation that supports the status and recommendation.␊ - */␊ - supportingImmunization?: Reference11[]␊ - /**␊ - * Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information.␊ - */␊ - supportingPatientInformation?: Reference11[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept258 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept259 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A patient's point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification.␊ - */␊ - export interface ImmunizationRecommendation_DateCriterion {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - code: CodeableConcept260␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - value?: string␊ - _value?: Element1014␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept260 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1014 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1015 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1016 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1017 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1018 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1019 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1020 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.␊ - */␊ - export interface ImplementationGuide {␊ - /**␊ - * This is a ImplementationGuide resource␊ - */␊ - resourceType: "ImplementationGuide"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta65␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1021␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1022␊ - text?: Narrative63␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - url?: string␊ - _url?: Element1023␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element1024␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element1025␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element1026␊ - /**␊ - * The status of this implementation guide. Enables tracking the life-cycle of the content.␊ - */␊ - status?: ("draft" | "active" | "retired" | "unknown")␊ - _status?: Element1027␊ - /**␊ - * A Boolean value to indicate that this implementation guide is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.␊ - */␊ - experimental?: boolean␊ - _experimental?: Element1028␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - date?: string␊ - _date?: Element1029␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - publisher?: string␊ - _publisher?: Element1030␊ - /**␊ - * Contact details to assist a user in finding and communicating with the publisher.␊ - */␊ - contact?: ContactDetail1[]␊ - /**␊ - * A free text natural language description of the implementation guide from a consumer's perspective.␊ - */␊ - description?: string␊ - _description?: Element1031␊ - /**␊ - * The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate implementation guide instances.␊ - */␊ - useContext?: UsageContext1[]␊ - /**␊ - * A legal or geographic region in which the implementation guide is intended to be used.␊ - */␊ - jurisdiction?: CodeableConcept5[]␊ - /**␊ - * A copyright statement relating to the implementation guide and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the implementation guide.␊ - */␊ - copyright?: string␊ - _copyright?: Element1032␊ - /**␊ - * The NPM package name for this Implementation Guide, used in the NPM package distribution, which is the primary mechanism by which FHIR based tooling manages IG dependencies. This value must be globally unique, and should be assigned with care.␊ - */␊ - packageId?: string␊ - _packageId?: Element1033␊ - /**␊ - * The license that applies to this Implementation Guide, using an SPDX license code, or 'not-open-source'.␊ - */␊ - license?: ("not-open-source" | "0BSD" | "AAL" | "Abstyles" | "Adobe-2006" | "Adobe-Glyph" | "ADSL" | "AFL-1.1" | "AFL-1.2" | "AFL-2.0" | "AFL-2.1" | "AFL-3.0" | "Afmparse" | "AGPL-1.0-only" | "AGPL-1.0-or-later" | "AGPL-3.0-only" | "AGPL-3.0-or-later" | "Aladdin" | "AMDPLPA" | "AML" | "AMPAS" | "ANTLR-PD" | "Apache-1.0" | "Apache-1.1" | "Apache-2.0" | "APAFML" | "APL-1.0" | "APSL-1.0" | "APSL-1.1" | "APSL-1.2" | "APSL-2.0" | "Artistic-1.0-cl8" | "Artistic-1.0-Perl" | "Artistic-1.0" | "Artistic-2.0" | "Bahyph" | "Barr" | "Beerware" | "BitTorrent-1.0" | "BitTorrent-1.1" | "Borceux" | "BSD-1-Clause" | "BSD-2-Clause-FreeBSD" | "BSD-2-Clause-NetBSD" | "BSD-2-Clause-Patent" | "BSD-2-Clause" | "BSD-3-Clause-Attribution" | "BSD-3-Clause-Clear" | "BSD-3-Clause-LBNL" | "BSD-3-Clause-No-Nuclear-License-2014" | "BSD-3-Clause-No-Nuclear-License" | "BSD-3-Clause-No-Nuclear-Warranty" | "BSD-3-Clause" | "BSD-4-Clause-UC" | "BSD-4-Clause" | "BSD-Protection" | "BSD-Source-Code" | "BSL-1.0" | "bzip2-1.0.5" | "bzip2-1.0.6" | "Caldera" | "CATOSL-1.1" | "CC-BY-1.0" | "CC-BY-2.0" | "CC-BY-2.5" | "CC-BY-3.0" | "CC-BY-4.0" | "CC-BY-NC-1.0" | "CC-BY-NC-2.0" | "CC-BY-NC-2.5" | "CC-BY-NC-3.0" | "CC-BY-NC-4.0" | "CC-BY-NC-ND-1.0" | "CC-BY-NC-ND-2.0" | "CC-BY-NC-ND-2.5" | "CC-BY-NC-ND-3.0" | "CC-BY-NC-ND-4.0" | "CC-BY-NC-SA-1.0" | "CC-BY-NC-SA-2.0" | "CC-BY-NC-SA-2.5" | "CC-BY-NC-SA-3.0" | "CC-BY-NC-SA-4.0" | "CC-BY-ND-1.0" | "CC-BY-ND-2.0" | "CC-BY-ND-2.5" | "CC-BY-ND-3.0" | "CC-BY-ND-4.0" | "CC-BY-SA-1.0" | "CC-BY-SA-2.0" | "CC-BY-SA-2.5" | "CC-BY-SA-3.0" | "CC-BY-SA-4.0" | "CC0-1.0" | "CDDL-1.0" | "CDDL-1.1" | "CDLA-Permissive-1.0" | "CDLA-Sharing-1.0" | "CECILL-1.0" | "CECILL-1.1" | "CECILL-2.0" | "CECILL-2.1" | "CECILL-B" | "CECILL-C" | "ClArtistic" | "CNRI-Jython" | "CNRI-Python-GPL-Compatible" | "CNRI-Python" | "Condor-1.1" | "CPAL-1.0" | "CPL-1.0" | "CPOL-1.02" | "Crossword" | "CrystalStacker" | "CUA-OPL-1.0" | "Cube" | "curl" | "D-FSL-1.0" | "diffmark" | "DOC" | "Dotseqn" | "DSDP" | "dvipdfm" | "ECL-1.0" | "ECL-2.0" | "EFL-1.0" | "EFL-2.0" | "eGenix" | "Entessa" | "EPL-1.0" | "EPL-2.0" | "ErlPL-1.1" | "EUDatagrid" | "EUPL-1.0" | "EUPL-1.1" | "EUPL-1.2" | "Eurosym" | "Fair" | "Frameworx-1.0" | "FreeImage" | "FSFAP" | "FSFUL" | "FSFULLR" | "FTL" | "GFDL-1.1-only" | "GFDL-1.1-or-later" | "GFDL-1.2-only" | "GFDL-1.2-or-later" | "GFDL-1.3-only" | "GFDL-1.3-or-later" | "Giftware" | "GL2PS" | "Glide" | "Glulxe" | "gnuplot" | "GPL-1.0-only" | "GPL-1.0-or-later" | "GPL-2.0-only" | "GPL-2.0-or-later" | "GPL-3.0-only" | "GPL-3.0-or-later" | "gSOAP-1.3b" | "HaskellReport" | "HPND" | "IBM-pibs" | "ICU" | "IJG" | "ImageMagick" | "iMatix" | "Imlib2" | "Info-ZIP" | "Intel-ACPI" | "Intel" | "Interbase-1.0" | "IPA" | "IPL-1.0" | "ISC" | "JasPer-2.0" | "JSON" | "LAL-1.2" | "LAL-1.3" | "Latex2e" | "Leptonica" | "LGPL-2.0-only" | "LGPL-2.0-or-later" | "LGPL-2.1-only" | "LGPL-2.1-or-later" | "LGPL-3.0-only" | "LGPL-3.0-or-later" | "LGPLLR" | "Libpng" | "libtiff" | "LiLiQ-P-1.1" | "LiLiQ-R-1.1" | "LiLiQ-Rplus-1.1" | "Linux-OpenIB" | "LPL-1.0" | "LPL-1.02" | "LPPL-1.0" | "LPPL-1.1" | "LPPL-1.2" | "LPPL-1.3a" | "LPPL-1.3c" | "MakeIndex" | "MirOS" | "MIT-0" | "MIT-advertising" | "MIT-CMU" | "MIT-enna" | "MIT-feh" | "MIT" | "MITNFA" | "Motosoto" | "mpich2" | "MPL-1.0" | "MPL-1.1" | "MPL-2.0-no-copyleft-exception" | "MPL-2.0" | "MS-PL" | "MS-RL" | "MTLL" | "Multics" | "Mup" | "NASA-1.3" | "Naumen" | "NBPL-1.0" | "NCSA" | "Net-SNMP" | "NetCDF" | "Newsletr" | "NGPL" | "NLOD-1.0" | "NLPL" | "Nokia" | "NOSL" | "Noweb" | "NPL-1.0" | "NPL-1.1" | "NPOSL-3.0" | "NRL" | "NTP" | "OCCT-PL" | "OCLC-2.0" | "ODbL-1.0" | "OFL-1.0" | "OFL-1.1" | "OGTSL" | "OLDAP-1.1" | "OLDAP-1.2" | "OLDAP-1.3" | "OLDAP-1.4" | "OLDAP-2.0.1" | "OLDAP-2.0" | "OLDAP-2.1" | "OLDAP-2.2.1" | "OLDAP-2.2.2" | "OLDAP-2.2" | "OLDAP-2.3" | "OLDAP-2.4" | "OLDAP-2.5" | "OLDAP-2.6" | "OLDAP-2.7" | "OLDAP-2.8" | "OML" | "OpenSSL" | "OPL-1.0" | "OSET-PL-2.1" | "OSL-1.0" | "OSL-1.1" | "OSL-2.0" | "OSL-2.1" | "OSL-3.0" | "PDDL-1.0" | "PHP-3.0" | "PHP-3.01" | "Plexus" | "PostgreSQL" | "psfrag" | "psutils" | "Python-2.0" | "Qhull" | "QPL-1.0" | "Rdisc" | "RHeCos-1.1" | "RPL-1.1" | "RPL-1.5" | "RPSL-1.0" | "RSA-MD" | "RSCPL" | "Ruby" | "SAX-PD" | "Saxpath" | "SCEA" | "Sendmail" | "SGI-B-1.0" | "SGI-B-1.1" | "SGI-B-2.0" | "SimPL-2.0" | "SISSL-1.2" | "SISSL" | "Sleepycat" | "SMLNJ" | "SMPPL" | "SNIA" | "Spencer-86" | "Spencer-94" | "Spencer-99" | "SPL-1.0" | "SugarCRM-1.1.3" | "SWL" | "TCL" | "TCP-wrappers" | "TMate" | "TORQUE-1.1" | "TOSL" | "Unicode-DFS-2015" | "Unicode-DFS-2016" | "Unicode-TOU" | "Unlicense" | "UPL-1.0" | "Vim" | "VOSTROM" | "VSL-1.0" | "W3C-19980720" | "W3C-20150513" | "W3C" | "Watcom-1.0" | "Wsuipa" | "WTFPL" | "X11" | "Xerox" | "XFree86-1.1" | "xinetd" | "Xnet" | "xpp" | "XSkat" | "YPL-1.0" | "YPL-1.1" | "Zed" | "Zend-2.0" | "Zimbra-1.3" | "Zimbra-1.4" | "zlib-acknowledgement" | "Zlib" | "ZPL-1.1" | "ZPL-2.0" | "ZPL-2.1")␊ - _license?: Element1034␊ - /**␊ - * The version(s) of the FHIR specification that this ImplementationGuide targets - e.g. describes how to use. The value of this element is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 4.0.1. for this version.␊ - */␊ - fhirVersion?: ("0.01" | "0.05" | "0.06" | "0.11" | "0.0.80" | "0.0.81" | "0.0.82" | "0.4.0" | "0.5.0" | "1.0.0" | "1.0.1" | "1.0.2" | "1.1.0" | "1.4.0" | "1.6.0" | "1.8.0" | "3.0.0" | "3.0.1" | "3.3.0" | "3.5.0" | "4.0.0" | "4.0.1")[]␊ - /**␊ - * Extensions for fhirVersion␊ - */␊ - _fhirVersion?: Element23[]␊ - /**␊ - * Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides.␊ - */␊ - dependsOn?: ImplementationGuide_DependsOn[]␊ - /**␊ - * A set of profiles that all resources covered by this implementation guide must conform to.␊ - */␊ - global?: ImplementationGuide_Global[]␊ - definition?: ImplementationGuide_Definition␊ - manifest?: ImplementationGuide_Manifest␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta65 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1021 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1022 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative63 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1023 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1024 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1025 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1026 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1027 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1028 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1029 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1030 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1031 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1032 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1033 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1034 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.␊ - */␊ - export interface ImplementationGuide_DependsOn {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - uri: string␊ - /**␊ - * The NPM package name for the Implementation Guide that this IG depends on.␊ - */␊ - packageId?: string␊ - _packageId?: Element1035␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element1036␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1035 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1036 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.␊ - */␊ - export interface ImplementationGuide_Global {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - type?: string␊ - _type?: Element1037␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - profile: string␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1037 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The information needed by an IG publisher tool to publish the whole implementation guide.␊ - */␊ - export interface ImplementationGuide_Definition {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A logical group of resources. Logical groups can be used when building pages.␊ - */␊ - grouping?: ImplementationGuide_Grouping[]␊ - /**␊ - * A resource that is part of the implementation guide. Conformance resources (value set, structure definition, capability statements etc.) are obvious candidates for inclusion, but any kind of resource can be included as an example resource.␊ - */␊ - resource: ImplementationGuide_Resource[]␊ - page?: ImplementationGuide_Page␊ - /**␊ - * Defines how IG is built by tools.␊ - */␊ - parameter?: ImplementationGuide_Parameter[]␊ - /**␊ - * A template for building resources.␊ - */␊ - template?: ImplementationGuide_Template[]␊ - }␊ - /**␊ - * A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.␊ - */␊ - export interface ImplementationGuide_Grouping {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element1038␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element1039␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1038 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1039 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.␊ - */␊ - export interface ImplementationGuide_Resource {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - reference: Reference260␊ - /**␊ - * Indicates the FHIR Version(s) this artifact is intended to apply to. If no versions are specified, the resource is assumed to apply to all the versions stated in ImplementationGuide.fhirVersion.␊ - */␊ - fhirVersion?: ("0.01" | "0.05" | "0.06" | "0.11" | "0.0.80" | "0.0.81" | "0.0.82" | "0.4.0" | "0.5.0" | "1.0.0" | "1.0.1" | "1.0.2" | "1.1.0" | "1.4.0" | "1.6.0" | "1.8.0" | "3.0.0" | "3.0.1" | "3.3.0" | "3.5.0" | "4.0.0" | "4.0.1")[]␊ - /**␊ - * Extensions for fhirVersion␊ - */␊ - _fhirVersion?: Element23[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element1040␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element1041␊ - /**␊ - * If true or a reference, indicates the resource is an example instance. If a reference is present, indicates that the example is an example of the specified profile.␊ - */␊ - exampleBoolean?: boolean␊ - _exampleBoolean?: Element1042␊ - /**␊ - * If true or a reference, indicates the resource is an example instance. If a reference is present, indicates that the example is an example of the specified profile.␊ - */␊ - exampleCanonical?: string␊ - _exampleCanonical?: Element1043␊ - /**␊ - * Reference to the id of the grouping this resource appears in.␊ - */␊ - groupingId?: string␊ - _groupingId?: Element1044␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference260 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1040 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1041 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1042 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1043 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1044 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A page / section in the implementation guide. The root page is the implementation guide home page.␊ - */␊ - export interface ImplementationGuide_Page {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * The source address for the page.␊ - */␊ - nameUrl?: string␊ - _nameUrl?: Element1045␊ - nameReference?: Reference261␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element1046␊ - /**␊ - * A code that indicates how the page is generated.␊ - */␊ - generation?: ("html" | "markdown" | "xml" | "generated")␊ - _generation?: Element1047␊ - /**␊ - * Nested Pages/Sections under this page.␊ - */␊ - page?: ImplementationGuide_Page1[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1045 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference261 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1046 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1047 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.␊ - */␊ - export interface ImplementationGuide_Page1 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * The source address for the page.␊ - */␊ - nameUrl?: string␊ - _nameUrl?: Element1045␊ - nameReference?: Reference261␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element1046␊ - /**␊ - * A code that indicates how the page is generated.␊ - */␊ - generation?: ("html" | "markdown" | "xml" | "generated")␊ - _generation?: Element1047␊ - /**␊ - * Nested Pages/Sections under this page.␊ - */␊ - page?: ImplementationGuide_Page1[]␊ - }␊ - /**␊ - * A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.␊ - */␊ - export interface ImplementationGuide_Parameter {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * apply | path-resource | path-pages | path-tx-cache | expansion-parameter | rule-broken-links | generate-xml | generate-json | generate-turtle | html-template.␊ - */␊ - code?: ("apply" | "path-resource" | "path-pages" | "path-tx-cache" | "expansion-parameter" | "rule-broken-links" | "generate-xml" | "generate-json" | "generate-turtle" | "html-template")␊ - _code?: Element1048␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element1049␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1048 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1049 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.␊ - */␊ - export interface ImplementationGuide_Template {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - code?: string␊ - _code?: Element1050␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - source?: string␊ - _source?: Element1051␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - scope?: string␊ - _scope?: Element1052␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1050 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1051 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1052 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Information about an assembled implementation guide, created by the publication tooling.␊ - */␊ - export interface ImplementationGuide_Manifest {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A pointer to official web page, PDF or other rendering of the implementation guide.␊ - */␊ - rendering?: string␊ - _rendering?: Element1053␊ - /**␊ - * A resource that is part of the implementation guide. Conformance resources (value set, structure definition, capability statements etc.) are obvious candidates for inclusion, but any kind of resource can be included as an example resource.␊ - */␊ - resource: ImplementationGuide_Resource1[]␊ - /**␊ - * Information about a page within the IG.␊ - */␊ - page?: ImplementationGuide_Page11[]␊ - /**␊ - * Indicates a relative path to an image that exists within the IG.␊ - */␊ - image?: String[]␊ - /**␊ - * Extensions for image␊ - */␊ - _image?: Element23[]␊ - /**␊ - * Indicates the relative path of an additional non-page, non-image file that is part of the IG - e.g. zip, jar and similar files that could be the target of a hyperlink in a derived IG.␊ - */␊ - other?: String[]␊ - /**␊ - * Extensions for other␊ - */␊ - _other?: Element23[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1053 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.␊ - */␊ - export interface ImplementationGuide_Resource1 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - reference: Reference262␊ - /**␊ - * If true or a reference, indicates the resource is an example instance. If a reference is present, indicates that the example is an example of the specified profile.␊ - */␊ - exampleBoolean?: boolean␊ - _exampleBoolean?: Element1054␊ - /**␊ - * If true or a reference, indicates the resource is an example instance. If a reference is present, indicates that the example is an example of the specified profile.␊ - */␊ - exampleCanonical?: string␊ - _exampleCanonical?: Element1055␊ - /**␊ - * The relative path for primary page for this resource within the IG.␊ - */␊ - relativePath?: string␊ - _relativePath?: Element1056␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference262 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1054 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1055 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1056 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.␊ - */␊ - export interface ImplementationGuide_Page11 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element1057␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element1058␊ - /**␊ - * The name of an anchor available on the page.␊ - */␊ - anchor?: String[]␊ - /**␊ - * Extensions for anchor␊ - */␊ - _anchor?: Element23[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1057 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1058 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Details of a Health Insurance product/plan provided by an organization.␊ - */␊ - export interface InsurancePlan {␊ - /**␊ - * This is a InsurancePlan resource␊ - */␊ - resourceType: "InsurancePlan"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta66␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1059␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1060␊ - text?: Narrative64␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Business identifiers assigned to this health insurance product which remain constant as the resource is updated and propagates from server to server.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * The current state of the health insurance product.␊ - */␊ - status?: ("draft" | "active" | "retired" | "unknown")␊ - _status?: Element1061␊ - /**␊ - * The kind of health insurance product.␊ - */␊ - type?: CodeableConcept5[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element1062␊ - /**␊ - * A list of alternate names that the product is known as, or was known as in the past.␊ - */␊ - alias?: String[]␊ - /**␊ - * Extensions for alias␊ - */␊ - _alias?: Element23[]␊ - period?: Period73␊ - ownedBy?: Reference263␊ - administeredBy?: Reference264␊ - /**␊ - * The geographic region in which a health insurance product's benefits apply.␊ - */␊ - coverageArea?: Reference11[]␊ - /**␊ - * The contact for the health insurance product for a certain purpose.␊ - */␊ - contact?: InsurancePlan_Contact[]␊ - /**␊ - * The technical endpoints providing access to services operated for the health insurance product.␊ - */␊ - endpoint?: Reference11[]␊ - /**␊ - * Reference to the network included in the health insurance product.␊ - */␊ - network?: Reference11[]␊ - /**␊ - * Details about the coverage offered by the insurance product.␊ - */␊ - coverage?: InsurancePlan_Coverage[]␊ - /**␊ - * Details about an insurance plan.␊ - */␊ - plan?: InsurancePlan_Plan[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta66 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1059 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1060 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative64 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1061 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1062 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period73 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference263 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference264 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Details of a Health Insurance product/plan provided by an organization.␊ - */␊ - export interface InsurancePlan_Contact {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - purpose?: CodeableConcept261␊ - name?: HumanName1␊ - /**␊ - * A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.␊ - */␊ - telecom?: ContactPoint1[]␊ - address?: Address7␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept261 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A name associated with the contact.␊ - */␊ - export interface HumanName1 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Identifies the purpose for this name.␊ - */␊ - use?: ("usual" | "official" | "temp" | "nickname" | "anonymous" | "old" | "maiden")␊ - _use?: Element78␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element79␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - family?: string␊ - _family?: Element80␊ - /**␊ - * Given name.␊ - */␊ - given?: String[]␊ - /**␊ - * Extensions for given␊ - */␊ - _given?: Element23[]␊ - /**␊ - * Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.␊ - */␊ - prefix?: String[]␊ - /**␊ - * Extensions for prefix␊ - */␊ - _prefix?: Element23[]␊ - /**␊ - * Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.␊ - */␊ - suffix?: String[]␊ - /**␊ - * Extensions for suffix␊ - */␊ - _suffix?: Element23[]␊ - period?: Period3␊ - }␊ - /**␊ - * Visiting or postal addresses for the contact.␊ - */␊ - export interface Address7 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this address.␊ - */␊ - use?: ("home" | "work" | "temp" | "old" | "billing")␊ - _use?: Element20␊ - /**␊ - * Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.␊ - */␊ - type?: ("postal" | "physical" | "both")␊ - _type?: Element21␊ - /**␊ - * Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.␊ - */␊ - text?: string␊ - _text?: Element22␊ - /**␊ - * This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.␊ - */␊ - line?: String[]␊ - /**␊ - * Extensions for line␊ - */␊ - _line?: Element23[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - city?: string␊ - _city?: Element24␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - district?: string␊ - _district?: Element25␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - state?: string␊ - _state?: Element26␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - postalCode?: string␊ - _postalCode?: Element27␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - country?: string␊ - _country?: Element28␊ - period?: Period␊ - }␊ - /**␊ - * Details of a Health Insurance product/plan provided by an organization.␊ - */␊ - export interface InsurancePlan_Coverage {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - type: CodeableConcept262␊ - /**␊ - * Reference to the network that providing the type of coverage.␊ - */␊ - network?: Reference11[]␊ - /**␊ - * Specific benefits under this type of coverage.␊ - */␊ - benefit: InsurancePlan_Benefit[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept262 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Details of a Health Insurance product/plan provided by an organization.␊ - */␊ - export interface InsurancePlan_Benefit {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - type: CodeableConcept263␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - requirement?: string␊ - _requirement?: Element1063␊ - /**␊ - * The specific limits on the benefit.␊ - */␊ - limit?: InsurancePlan_Limit[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept263 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1063 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Details of a Health Insurance product/plan provided by an organization.␊ - */␊ - export interface InsurancePlan_Limit {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - value?: Quantity46␊ - code?: CodeableConcept264␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity46 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept264 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Details of a Health Insurance product/plan provided by an organization.␊ - */␊ - export interface InsurancePlan_Plan {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Business identifiers assigned to this health insurance plan which remain constant as the resource is updated and propagates from server to server.␊ - */␊ - identifier?: Identifier2[]␊ - type?: CodeableConcept265␊ - /**␊ - * The geographic region in which a health insurance plan's benefits apply.␊ - */␊ - coverageArea?: Reference11[]␊ - /**␊ - * Reference to the network that providing the type of coverage.␊ - */␊ - network?: Reference11[]␊ - /**␊ - * Overall costs associated with the plan.␊ - */␊ - generalCost?: InsurancePlan_GeneralCost[]␊ - /**␊ - * Costs associated with the coverage provided by the product.␊ - */␊ - specificCost?: InsurancePlan_SpecificCost[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept265 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Details of a Health Insurance product/plan provided by an organization.␊ - */␊ - export interface InsurancePlan_GeneralCost {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - type?: CodeableConcept266␊ - /**␊ - * An integer with a value that is positive (e.g. >0)␊ - */␊ - groupSize?: number␊ - _groupSize?: Element1064␊ - cost?: Money44␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - comment?: string␊ - _comment?: Element1065␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept266 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1064 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Value of the cost.␊ - */␊ - export interface Money44 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1065 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Details of a Health Insurance product/plan provided by an organization.␊ - */␊ - export interface InsurancePlan_SpecificCost {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - category: CodeableConcept267␊ - /**␊ - * List of the specific benefits under this category of benefit.␊ - */␊ - benefit?: InsurancePlan_Benefit1[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept267 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Details of a Health Insurance product/plan provided by an organization.␊ - */␊ - export interface InsurancePlan_Benefit1 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - type: CodeableConcept268␊ - /**␊ - * List of the costs associated with a specific benefit.␊ - */␊ - cost?: InsurancePlan_Cost[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept268 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Details of a Health Insurance product/plan provided by an organization.␊ - */␊ - export interface InsurancePlan_Cost {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - type: CodeableConcept269␊ - applicability?: CodeableConcept270␊ - /**␊ - * Additional information about the cost, such as information about funding sources (e.g. HSA, HRA, FSA, RRA).␊ - */␊ - qualifiers?: CodeableConcept5[]␊ - value?: Quantity47␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept269 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept270 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity47 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose.␊ - */␊ - export interface Invoice {␊ - /**␊ - * This is a Invoice resource␊ - */␊ - resourceType: "Invoice"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta67␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1066␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1067␊ - text?: Narrative65␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifier of this Invoice, often used for reference in correspondence about this invoice or for tracking of payments.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * The current state of the Invoice.␊ - */␊ - status?: ("draft" | "issued" | "balanced" | "cancelled" | "entered-in-error")␊ - _status?: Element1068␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - cancelledReason?: string␊ - _cancelledReason?: Element1069␊ - type?: CodeableConcept271␊ - subject?: Reference265␊ - recipient?: Reference266␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - date?: string␊ - _date?: Element1070␊ - /**␊ - * Indicates who or what performed or participated in the charged service.␊ - */␊ - participant?: Invoice_Participant[]␊ - issuer?: Reference268␊ - account?: Reference269␊ - /**␊ - * Each line item represents one charge for goods and services rendered. Details such as date, code and amount are found in the referenced ChargeItem resource.␊ - */␊ - lineItem?: Invoice_LineItem[]␊ - /**␊ - * The total amount for the Invoice may be calculated as the sum of the line items with surcharges/deductions that apply in certain conditions. The priceComponent element can be used to offer transparency to the recipient of the Invoice of how the total price was calculated.␊ - */␊ - totalPriceComponent?: Invoice_PriceComponent[]␊ - totalNet?: Money46␊ - totalGross?: Money47␊ - /**␊ - * Payment details such as banking details, period of payment, deductibles, methods of payment.␊ - */␊ - paymentTerms?: string␊ - _paymentTerms?: Element1074␊ - /**␊ - * Comments made about the invoice by the issuer, subject, or other participants.␊ - */␊ - note?: Annotation1[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta67 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1066 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1067 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative65 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1068 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1069 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept271 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference265 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference266 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1070 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose.␊ - */␊ - export interface Invoice_Participant {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - role?: CodeableConcept272␊ - actor: Reference267␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept272 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference267 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference268 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference269 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose.␊ - */␊ - export interface Invoice_LineItem {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * An integer with a value that is positive (e.g. >0)␊ - */␊ - sequence?: number␊ - _sequence?: Element1071␊ - chargeItemReference?: Reference270␊ - chargeItemCodeableConcept?: CodeableConcept273␊ - /**␊ - * The price for a ChargeItem may be calculated as a base price with surcharges/deductions that apply in certain conditions. A ChargeItemDefinition resource that defines the prices, factors and conditions that apply to a billing code is currently under development. The priceComponent element can be used to offer transparency to the recipient of the Invoice as to how the prices have been calculated.␊ - */␊ - priceComponent?: Invoice_PriceComponent[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1071 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference270 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept273 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose.␊ - */␊ - export interface Invoice_PriceComponent {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * This code identifies the type of the component.␊ - */␊ - type?: ("base" | "surcharge" | "deduction" | "discount" | "tax" | "informational")␊ - _type?: Element1072␊ - code?: CodeableConcept274␊ - /**␊ - * The factor that has been applied on the base price for calculating this component.␊ - */␊ - factor?: number␊ - _factor?: Element1073␊ - amount?: Money45␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1072 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept274 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1073 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The amount calculated for this component.␊ - */␊ - export interface Money45 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * Invoice total , taxes excluded.␊ - */␊ - export interface Money46 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * Invoice total, tax included.␊ - */␊ - export interface Money47 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1074 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The Library resource is a general-purpose container for knowledge asset definitions. It can be used to describe and expose existing knowledge assets such as logic libraries and information model descriptions, as well as to describe a collection of knowledge assets.␊ - */␊ - export interface Library {␊ - /**␊ - * This is a Library resource␊ - */␊ - resourceType: "Library"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta68␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1075␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1076␊ - text?: Narrative66␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - url?: string␊ - _url?: Element1077␊ - /**␊ - * A formal identifier that is used to identify this library when it is represented in other formats, or referenced in a specification, model, design or an instance. e.g. CMS or NQF identifiers for a measure artifact. Note that at least one identifier is required for non-experimental active artifacts.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element1078␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element1079␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element1080␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - subtitle?: string␊ - _subtitle?: Element1081␊ - /**␊ - * The status of this library. Enables tracking the life-cycle of the content.␊ - */␊ - status?: ("draft" | "active" | "retired" | "unknown")␊ - _status?: Element1082␊ - /**␊ - * A Boolean value to indicate that this library is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.␊ - */␊ - experimental?: boolean␊ - _experimental?: Element1083␊ - type: CodeableConcept275␊ - subjectCodeableConcept?: CodeableConcept276␊ - subjectReference?: Reference271␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - date?: string␊ - _date?: Element1084␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - publisher?: string␊ - _publisher?: Element1085␊ - /**␊ - * Contact details to assist a user in finding and communicating with the publisher.␊ - */␊ - contact?: ContactDetail1[]␊ - /**␊ - * A free text natural language description of the library from a consumer's perspective.␊ - */␊ - description?: string␊ - _description?: Element1086␊ - /**␊ - * The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate library instances.␊ - */␊ - useContext?: UsageContext1[]␊ - /**␊ - * A legal or geographic region in which the library is intended to be used.␊ - */␊ - jurisdiction?: CodeableConcept5[]␊ - /**␊ - * Explanation of why this library is needed and why it has been designed as it has.␊ - */␊ - purpose?: string␊ - _purpose?: Element1087␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - usage?: string␊ - _usage?: Element1088␊ - /**␊ - * A copyright statement relating to the library and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the library.␊ - */␊ - copyright?: string␊ - _copyright?: Element1089␊ - /**␊ - * The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.␊ - */␊ - approvalDate?: string␊ - _approvalDate?: Element1090␊ - /**␊ - * The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.␊ - */␊ - lastReviewDate?: string␊ - _lastReviewDate?: Element1091␊ - effectivePeriod?: Period74␊ - /**␊ - * Descriptive topics related to the content of the library. Topics provide a high-level categorization of the library that can be useful for filtering and searching.␊ - */␊ - topic?: CodeableConcept5[]␊ - /**␊ - * An individiual or organization primarily involved in the creation and maintenance of the content.␊ - */␊ - author?: ContactDetail1[]␊ - /**␊ - * An individual or organization primarily responsible for internal coherence of the content.␊ - */␊ - editor?: ContactDetail1[]␊ - /**␊ - * An individual or organization primarily responsible for review of some aspect of the content.␊ - */␊ - reviewer?: ContactDetail1[]␊ - /**␊ - * An individual or organization responsible for officially endorsing the content for use in some setting.␊ - */␊ - endorser?: ContactDetail1[]␊ - /**␊ - * Related artifacts such as additional documentation, justification, or bibliographic references.␊ - */␊ - relatedArtifact?: RelatedArtifact1[]␊ - /**␊ - * The parameter element defines parameters used by the library.␊ - */␊ - parameter?: ParameterDefinition1[]␊ - /**␊ - * Describes a set of data that must be provided in order to be able to successfully perform the computations defined by the library.␊ - */␊ - dataRequirement?: DataRequirement1[]␊ - /**␊ - * The content of the library as an Attachment. The content may be a reference to a url, or may be directly embedded as a base-64 string. Either way, the contentType of the attachment determines how to interpret the content.␊ - */␊ - content?: Attachment2[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta68 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1075 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1076 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative66 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1077 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1078 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1079 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1080 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1081 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1082 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1083 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept275 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept276 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference271 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1084 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1085 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1086 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1087 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1088 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1089 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1090 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1091 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period74 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * The parameters to the module. This collection specifies both the input and output parameters. Input parameters are provided by the caller as part of the $evaluate operation. Output parameters are included in the GuidanceResponse.␊ - */␊ - export interface ParameterDefinition1 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - name?: string␊ - _name?: Element126␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - use?: string␊ - _use?: Element127␊ - /**␊ - * The minimum number of times this parameter SHALL appear in the request or response.␊ - */␊ - min?: number␊ - _min?: Element128␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - max?: string␊ - _max?: Element129␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - documentation?: string␊ - _documentation?: Element130␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - type?: string␊ - _type?: Element131␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - profile?: string␊ - }␊ - /**␊ - * Identifies two or more records (resource instances) that refer to the same real-world "occurrence".␊ - */␊ - export interface Linkage {␊ - /**␊ - * This is a Linkage resource␊ - */␊ - resourceType: "Linkage"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta69␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1092␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1093␊ - text?: Narrative67␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Indicates whether the asserted set of linkages are considered to be "in effect".␊ - */␊ - active?: boolean␊ - _active?: Element1094␊ - author?: Reference272␊ - /**␊ - * Identifies which record considered as the reference to the same real-world occurrence as well as how the items should be evaluated within the collection of linked items.␊ - */␊ - item: Linkage_Item[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta69 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1092 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1093 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative67 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1094 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference272 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Identifies two or more records (resource instances) that refer to the same real-world "occurrence".␊ - */␊ - export interface Linkage_Item {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Distinguishes which item is "source of truth" (if any) and which items are no longer considered to be current representations.␊ - */␊ - type?: ("source" | "alternate" | "historical")␊ - _type?: Element1095␊ - resource: Reference273␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1095 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference273 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A list is a curated collection of resources.␊ - */␊ - export interface List {␊ - /**␊ - * This is a List resource␊ - */␊ - resourceType: "List"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta70␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1096␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1097␊ - text?: Narrative68␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifier for the List assigned for business purposes outside the context of FHIR.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * Indicates the current state of this list.␊ - */␊ - status?: ("current" | "retired" | "entered-in-error")␊ - _status?: Element1098␊ - /**␊ - * How this list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.␊ - */␊ - mode?: ("working" | "snapshot" | "changes")␊ - _mode?: Element1099␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element1100␊ - code?: CodeableConcept277␊ - subject?: Reference274␊ - encounter?: Reference275␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - date?: string␊ - _date?: Element1101␊ - source?: Reference276␊ - orderedBy?: CodeableConcept278␊ - /**␊ - * Comments that apply to the overall list.␊ - */␊ - note?: Annotation1[]␊ - /**␊ - * Entries in this list.␊ - */␊ - entry?: List_Entry[]␊ - emptyReason?: CodeableConcept280␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta70 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1096 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1097 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative68 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1098 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1099 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1100 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept277 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference274 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference275 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1101 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference276 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept278 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A list is a curated collection of resources.␊ - */␊ - export interface List_Entry {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - flag?: CodeableConcept279␊ - /**␊ - * True if this item is marked as deleted in the list.␊ - */␊ - deleted?: boolean␊ - _deleted?: Element1102␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - date?: string␊ - _date?: Element1103␊ - item: Reference277␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept279 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1102 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1103 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference277 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept280 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.␊ - */␊ - export interface Location {␊ - /**␊ - * This is a Location resource␊ - */␊ - resourceType: "Location"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta71␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1104␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1105␊ - text?: Narrative69␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Unique code or number identifying the location to its users.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * The status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location.␊ - */␊ - status?: ("active" | "suspended" | "inactive")␊ - _status?: Element1106␊ - operationalStatus?: Coding24␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element1107␊ - /**␊ - * A list of alternate names that the location is known as, or was known as, in the past.␊ - */␊ - alias?: String[]␊ - /**␊ - * Extensions for alias␊ - */␊ - _alias?: Element23[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element1108␊ - /**␊ - * Indicates whether a resource instance represents a specific location or a class of locations.␊ - */␊ - mode?: ("instance" | "kind")␊ - _mode?: Element1109␊ - /**␊ - * Indicates the type of function performed at the location.␊ - */␊ - type?: CodeableConcept5[]␊ - /**␊ - * The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.␊ - */␊ - telecom?: ContactPoint1[]␊ - address?: Address8␊ - physicalType?: CodeableConcept281␊ - position?: Location_Position␊ - managingOrganization?: Reference278␊ - partOf?: Reference279␊ - /**␊ - * What days/times during a week is this location usually open.␊ - */␊ - hoursOfOperation?: Location_HoursOfOperation[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - availabilityExceptions?: string␊ - _availabilityExceptions?: Element1116␊ - /**␊ - * Technical endpoints providing access to services operated for the location.␊ - */␊ - endpoint?: Reference11[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta71 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1104 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1105 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative69 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1106 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - export interface Coding24 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The identification of the code system that defines the meaning of the symbol in the code.␊ - */␊ - system?: string␊ - _system?: Element39␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element40␊ - /**␊ - * A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).␊ - */␊ - code?: string␊ - _code?: Element41␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element42␊ - /**␊ - * Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).␊ - */␊ - userSelected?: boolean␊ - _userSelected?: Element43␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1107 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1108 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1109 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Physical location.␊ - */␊ - export interface Address8 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this address.␊ - */␊ - use?: ("home" | "work" | "temp" | "old" | "billing")␊ - _use?: Element20␊ - /**␊ - * Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.␊ - */␊ - type?: ("postal" | "physical" | "both")␊ - _type?: Element21␊ - /**␊ - * Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.␊ - */␊ - text?: string␊ - _text?: Element22␊ - /**␊ - * This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.␊ - */␊ - line?: String[]␊ - /**␊ - * Extensions for line␊ - */␊ - _line?: Element23[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - city?: string␊ - _city?: Element24␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - district?: string␊ - _district?: Element25␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - state?: string␊ - _state?: Element26␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - postalCode?: string␊ - _postalCode?: Element27␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - country?: string␊ - _country?: Element28␊ - period?: Period␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept281 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).␊ - */␊ - export interface Location_Position {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below).␊ - */␊ - longitude?: number␊ - _longitude?: Element1110␊ - /**␊ - * Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below).␊ - */␊ - latitude?: number␊ - _latitude?: Element1111␊ - /**␊ - * Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below).␊ - */␊ - altitude?: number␊ - _altitude?: Element1112␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1110 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1111 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1112 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference278 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference279 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.␊ - */␊ - export interface Location_HoursOfOperation {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Indicates which days of the week are available between the start and end Times.␊ - */␊ - daysOfWeek?: Code[]␊ - /**␊ - * Extensions for daysOfWeek␊ - */␊ - _daysOfWeek?: Element23[]␊ - /**␊ - * The Location is open all day.␊ - */␊ - allDay?: boolean␊ - _allDay?: Element1113␊ - /**␊ - * A time during the day, with no date specified␊ - */␊ - openingTime?: string␊ - _openingTime?: Element1114␊ - /**␊ - * A time during the day, with no date specified␊ - */␊ - closingTime?: string␊ - _closingTime?: Element1115␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1113 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1114 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1115 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1116 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The Measure resource provides the definition of a quality measure.␊ - */␊ - export interface Measure {␊ - /**␊ - * This is a Measure resource␊ - */␊ - resourceType: "Measure"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta72␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1117␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1118␊ - text?: Narrative70␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - url?: string␊ - _url?: Element1119␊ - /**␊ - * A formal identifier that is used to identify this measure when it is represented in other formats, or referenced in a specification, model, design or an instance.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element1120␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element1121␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element1122␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - subtitle?: string␊ - _subtitle?: Element1123␊ - /**␊ - * The status of this measure. Enables tracking the life-cycle of the content.␊ - */␊ - status?: ("draft" | "active" | "retired" | "unknown")␊ - _status?: Element1124␊ - /**␊ - * A Boolean value to indicate that this measure is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.␊ - */␊ - experimental?: boolean␊ - _experimental?: Element1125␊ - subjectCodeableConcept?: CodeableConcept282␊ - subjectReference?: Reference280␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - date?: string␊ - _date?: Element1126␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - publisher?: string␊ - _publisher?: Element1127␊ - /**␊ - * Contact details to assist a user in finding and communicating with the publisher.␊ - */␊ - contact?: ContactDetail1[]␊ - /**␊ - * A free text natural language description of the measure from a consumer's perspective.␊ - */␊ - description?: string␊ - _description?: Element1128␊ - /**␊ - * The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate measure instances.␊ - */␊ - useContext?: UsageContext1[]␊ - /**␊ - * A legal or geographic region in which the measure is intended to be used.␊ - */␊ - jurisdiction?: CodeableConcept5[]␊ - /**␊ - * Explanation of why this measure is needed and why it has been designed as it has.␊ - */␊ - purpose?: string␊ - _purpose?: Element1129␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - usage?: string␊ - _usage?: Element1130␊ - /**␊ - * A copyright statement relating to the measure and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the measure.␊ - */␊ - copyright?: string␊ - _copyright?: Element1131␊ - /**␊ - * The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.␊ - */␊ - approvalDate?: string␊ - _approvalDate?: Element1132␊ - /**␊ - * The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.␊ - */␊ - lastReviewDate?: string␊ - _lastReviewDate?: Element1133␊ - effectivePeriod?: Period75␊ - /**␊ - * Descriptive topics related to the content of the measure. Topics provide a high-level categorization grouping types of measures that can be useful for filtering and searching.␊ - */␊ - topic?: CodeableConcept5[]␊ - /**␊ - * An individiual or organization primarily involved in the creation and maintenance of the content.␊ - */␊ - author?: ContactDetail1[]␊ - /**␊ - * An individual or organization primarily responsible for internal coherence of the content.␊ - */␊ - editor?: ContactDetail1[]␊ - /**␊ - * An individual or organization primarily responsible for review of some aspect of the content.␊ - */␊ - reviewer?: ContactDetail1[]␊ - /**␊ - * An individual or organization responsible for officially endorsing the content for use in some setting.␊ - */␊ - endorser?: ContactDetail1[]␊ - /**␊ - * Related artifacts such as additional documentation, justification, or bibliographic references.␊ - */␊ - relatedArtifact?: RelatedArtifact1[]␊ - /**␊ - * A reference to a Library resource containing the formal logic used by the measure.␊ - */␊ - library?: Canonical[]␊ - /**␊ - * Notices and disclaimers regarding the use of the measure or related to intellectual property (such as code systems) referenced by the measure.␊ - */␊ - disclaimer?: string␊ - _disclaimer?: Element1134␊ - scoring?: CodeableConcept283␊ - compositeScoring?: CodeableConcept284␊ - /**␊ - * Indicates whether the measure is used to examine a process, an outcome over time, a patient-reported outcome, or a structure measure such as utilization.␊ - */␊ - type?: CodeableConcept5[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - riskAdjustment?: string␊ - _riskAdjustment?: Element1135␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - rateAggregation?: string␊ - _rateAggregation?: Element1136␊ - /**␊ - * Provides a succinct statement of the need for the measure. Usually includes statements pertaining to importance criterion: impact, gap in care, and evidence.␊ - */␊ - rationale?: string␊ - _rationale?: Element1137␊ - /**␊ - * Provides a summary of relevant clinical guidelines or other clinical recommendations supporting the measure.␊ - */␊ - clinicalRecommendationStatement?: string␊ - _clinicalRecommendationStatement?: Element1138␊ - improvementNotation?: CodeableConcept285␊ - /**␊ - * Provides a description of an individual term used within the measure.␊ - */␊ - definition?: Markdown[]␊ - /**␊ - * Extensions for definition␊ - */␊ - _definition?: Element23[]␊ - /**␊ - * A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine␊ - */␊ - guidance?: string␊ - _guidance?: Element1139␊ - /**␊ - * A group of population criteria for the measure.␊ - */␊ - group?: Measure_Group[]␊ - /**␊ - * The supplemental data criteria for the measure report, specified as either the name of a valid CQL expression within a referenced library, or a valid FHIR Resource Path.␊ - */␊ - supplementalData?: Measure_SupplementalData[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta72 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1117 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1118 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative70 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1119 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1120 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1121 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1122 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1123 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1124 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1125 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept282 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference280 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1126 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1127 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1128 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1129 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1130 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1131 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1132 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1133 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period75 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1134 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept283 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept284 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1135 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1136 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1137 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1138 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept285 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1139 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The Measure resource provides the definition of a quality measure.␊ - */␊ - export interface Measure_Group {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - code?: CodeableConcept286␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element1140␊ - /**␊ - * A population criteria for the measure.␊ - */␊ - population?: Measure_Population[]␊ - /**␊ - * The stratifier criteria for the measure report, specified as either the name of a valid CQL expression defined within a referenced library or a valid FHIR Resource Path.␊ - */␊ - stratifier?: Measure_Stratifier[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept286 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1140 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The Measure resource provides the definition of a quality measure.␊ - */␊ - export interface Measure_Population {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - code?: CodeableConcept287␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element1141␊ - criteria: Expression4␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept287 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1141 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * An expression that specifies the criteria for the population, typically the name of an expression in a library.␊ - */␊ - export interface Expression4 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element121␊ - /**␊ - * A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.␊ - */␊ - name?: string␊ - _name?: Element122␊ - /**␊ - * The media type of the language for the expression.␊ - */␊ - language?: ("text/cql" | "text/fhirpath" | "application/x-fhir-query")␊ - _language?: Element123␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - expression?: string␊ - _expression?: Element124␊ - /**␊ - * A URI that defines where the expression is found.␊ - */␊ - reference?: string␊ - _reference?: Element125␊ - }␊ - /**␊ - * The Measure resource provides the definition of a quality measure.␊ - */␊ - export interface Measure_Stratifier {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - code?: CodeableConcept288␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element1142␊ - criteria?: Expression5␊ - /**␊ - * A component of the stratifier criteria for the measure report, specified as either the name of a valid CQL expression defined within a referenced library or a valid FHIR Resource Path.␊ - */␊ - component?: Measure_Component[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept288 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1142 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * An expression that specifies the criteria for the stratifier. This is typically the name of an expression defined within a referenced library, but it may also be a path to a stratifier element.␊ - */␊ - export interface Expression5 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element121␊ - /**␊ - * A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.␊ - */␊ - name?: string␊ - _name?: Element122␊ - /**␊ - * The media type of the language for the expression.␊ - */␊ - language?: ("text/cql" | "text/fhirpath" | "application/x-fhir-query")␊ - _language?: Element123␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - expression?: string␊ - _expression?: Element124␊ - /**␊ - * A URI that defines where the expression is found.␊ - */␊ - reference?: string␊ - _reference?: Element125␊ - }␊ - /**␊ - * The Measure resource provides the definition of a quality measure.␊ - */␊ - export interface Measure_Component {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - code?: CodeableConcept289␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element1143␊ - criteria: Expression6␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept289 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1143 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * An expression that specifies the criteria for this component of the stratifier. This is typically the name of an expression defined within a referenced library, but it may also be a path to a stratifier element.␊ - */␊ - export interface Expression6 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element121␊ - /**␊ - * A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.␊ - */␊ - name?: string␊ - _name?: Element122␊ - /**␊ - * The media type of the language for the expression.␊ - */␊ - language?: ("text/cql" | "text/fhirpath" | "application/x-fhir-query")␊ - _language?: Element123␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - expression?: string␊ - _expression?: Element124␊ - /**␊ - * A URI that defines where the expression is found.␊ - */␊ - reference?: string␊ - _reference?: Element125␊ - }␊ - /**␊ - * The Measure resource provides the definition of a quality measure.␊ - */␊ - export interface Measure_SupplementalData {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - code?: CodeableConcept290␊ - /**␊ - * An indicator of the intended usage for the supplemental data element. Supplemental data indicates the data is additional information requested to augment the measure information. Risk adjustment factor indicates the data is additional information used to calculate risk adjustment factors when applying a risk model to the measure calculation.␊ - */␊ - usage?: CodeableConcept5[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element1144␊ - criteria: Expression7␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept290 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1144 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The criteria for the supplemental data. This is typically the name of a valid expression defined within a referenced library, but it may also be a path to a specific data element. The criteria defines the data to be returned for this element.␊ - */␊ - export interface Expression7 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element121␊ - /**␊ - * A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.␊ - */␊ - name?: string␊ - _name?: Element122␊ - /**␊ - * The media type of the language for the expression.␊ - */␊ - language?: ("text/cql" | "text/fhirpath" | "application/x-fhir-query")␊ - _language?: Element123␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - expression?: string␊ - _expression?: Element124␊ - /**␊ - * A URI that defines where the expression is found.␊ - */␊ - reference?: string␊ - _reference?: Element125␊ - }␊ - /**␊ - * The MeasureReport resource contains the results of the calculation of a measure; and optionally a reference to the resources involved in that calculation.␊ - */␊ - export interface MeasureReport {␊ - /**␊ - * This is a MeasureReport resource␊ - */␊ - resourceType: "MeasureReport"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta73␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1145␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1146␊ - text?: Narrative71␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A formal identifier that is used to identify this MeasureReport when it is represented in other formats or referenced in a specification, model, design or an instance.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * The MeasureReport status. No data will be available until the MeasureReport status is complete.␊ - */␊ - status?: ("complete" | "pending" | "error")␊ - _status?: Element1147␊ - /**␊ - * The type of measure report. This may be an individual report, which provides the score for the measure for an individual member of the population; a subject-listing, which returns the list of members that meet the various criteria in the measure; a summary report, which returns a population count for each of the criteria in the measure; or a data-collection, which enables the MeasureReport to be used to exchange the data-of-interest for a quality measure.␊ - */␊ - type?: ("individual" | "subject-list" | "summary" | "data-collection")␊ - _type?: Element1148␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - measure: string␊ - subject?: Reference281␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - date?: string␊ - _date?: Element1149␊ - reporter?: Reference282␊ - period: Period76␊ - improvementNotation?: CodeableConcept291␊ - /**␊ - * The results of the calculation, one for each population group in the measure.␊ - */␊ - group?: MeasureReport_Group[]␊ - /**␊ - * A reference to a Bundle containing the Resources that were used in the calculation of this measure.␊ - */␊ - evaluatedResource?: Reference11[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta73 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1145 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1146 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative71 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1147 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1148 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference281 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1149 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference282 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period76 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept291 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * The MeasureReport resource contains the results of the calculation of a measure; and optionally a reference to the resources involved in that calculation.␊ - */␊ - export interface MeasureReport_Group {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - code?: CodeableConcept292␊ - /**␊ - * The populations that make up the population group, one for each type of population appropriate for the measure.␊ - */␊ - population?: MeasureReport_Population[]␊ - measureScore?: Quantity48␊ - /**␊ - * When a measure includes multiple stratifiers, there will be a stratifier group for each stratifier defined by the measure.␊ - */␊ - stratifier?: MeasureReport_Stratifier[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept292 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * The MeasureReport resource contains the results of the calculation of a measure; and optionally a reference to the resources involved in that calculation.␊ - */␊ - export interface MeasureReport_Population {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - code?: CodeableConcept293␊ - /**␊ - * The number of members of the population.␊ - */␊ - count?: number␊ - _count?: Element1150␊ - subjectResults?: Reference283␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept293 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1150 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference283 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity48 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * The MeasureReport resource contains the results of the calculation of a measure; and optionally a reference to the resources involved in that calculation.␊ - */␊ - export interface MeasureReport_Stratifier {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * The meaning of this stratifier, as defined in the measure definition.␊ - */␊ - code?: CodeableConcept5[]␊ - /**␊ - * This element contains the results for a single stratum within the stratifier. For example, when stratifying on administrative gender, there will be four strata, one for each possible gender value.␊ - */␊ - stratum?: MeasureReport_Stratum[]␊ - }␊ - /**␊ - * The MeasureReport resource contains the results of the calculation of a measure; and optionally a reference to the resources involved in that calculation.␊ - */␊ - export interface MeasureReport_Stratum {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - value?: CodeableConcept294␊ - /**␊ - * A stratifier component value.␊ - */␊ - component?: MeasureReport_Component[]␊ - /**␊ - * The populations that make up the stratum, one for each type of population appropriate to the measure.␊ - */␊ - population?: MeasureReport_Population1[]␊ - measureScore?: Quantity49␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept294 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * The MeasureReport resource contains the results of the calculation of a measure; and optionally a reference to the resources involved in that calculation.␊ - */␊ - export interface MeasureReport_Component {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - code: CodeableConcept295␊ - value: CodeableConcept296␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept295 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept296 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * The MeasureReport resource contains the results of the calculation of a measure; and optionally a reference to the resources involved in that calculation.␊ - */␊ - export interface MeasureReport_Population1 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - code?: CodeableConcept297␊ - /**␊ - * The number of members of the population in this stratum.␊ - */␊ - count?: number␊ - _count?: Element1151␊ - subjectResults?: Reference284␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept297 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1151 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference284 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity49 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference.␊ - */␊ - export interface Media {␊ - /**␊ - * This is a Media resource␊ - */␊ - resourceType: "Media"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta74␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1152␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1153␊ - text?: Narrative72␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifiers associated with the image - these may include identifiers for the image itself, identifiers for the context of its collection (e.g. series ids) and context ids such as accession numbers or other workflow identifiers.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * A procedure that is fulfilled in whole or in part by the creation of this media.␊ - */␊ - basedOn?: Reference11[]␊ - /**␊ - * A larger event of which this particular event is a component or step.␊ - */␊ - partOf?: Reference11[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - status?: string␊ - _status?: Element1154␊ - type?: CodeableConcept298␊ - modality?: CodeableConcept299␊ - view?: CodeableConcept300␊ - subject?: Reference285␊ - encounter?: Reference286␊ - /**␊ - * The date and time(s) at which the media was collected.␊ - */␊ - createdDateTime?: string␊ - _createdDateTime?: Element1155␊ - createdPeriod?: Period77␊ - /**␊ - * The date and time this version of the media was made available to providers, typically after having been reviewed.␊ - */␊ - issued?: string␊ - _issued?: Element1156␊ - operator?: Reference287␊ - /**␊ - * Describes why the event occurred in coded or textual form.␊ - */␊ - reasonCode?: CodeableConcept5[]␊ - bodySite?: CodeableConcept301␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - deviceName?: string␊ - _deviceName?: Element1157␊ - device?: Reference288␊ - /**␊ - * An integer with a value that is positive (e.g. >0)␊ - */␊ - height?: number␊ - _height?: Element1158␊ - /**␊ - * An integer with a value that is positive (e.g. >0)␊ - */␊ - width?: number␊ - _width?: Element1159␊ - /**␊ - * An integer with a value that is positive (e.g. >0)␊ - */␊ - frames?: number␊ - _frames?: Element1160␊ - /**␊ - * The duration of the recording in seconds - for audio and video.␊ - */␊ - duration?: number␊ - _duration?: Element1161␊ - content: Attachment17␊ - /**␊ - * Comments made about the media by the performer, subject or other participants.␊ - */␊ - note?: Annotation1[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta74 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1152 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1153 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative72 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1154 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept298 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept299 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept300 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference285 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference286 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1155 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period77 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1156 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference287 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept301 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1157 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference288 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1158 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1159 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1160 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1161 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * For referring to data content defined in other formats.␊ - */␊ - export interface Attachment17 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.␊ - */␊ - contentType?: string␊ - _contentType?: Element51␊ - /**␊ - * The human language of the content. The value can be any valid value according to BCP 47.␊ - */␊ - language?: string␊ - _language?: Element52␊ - /**␊ - * The actual data of the attachment - a sequence of bytes, base64 encoded.␊ - */␊ - data?: string␊ - _data?: Element53␊ - /**␊ - * A location where the data can be accessed.␊ - */␊ - url?: string␊ - _url?: Element54␊ - /**␊ - * The number of bytes of data that make up this attachment (before base64 encoding, if that is done).␊ - */␊ - size?: number␊ - _size?: Element55␊ - /**␊ - * The calculated hash of the data using SHA-1. Represented using base64.␊ - */␊ - hash?: string␊ - _hash?: Element56␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element57␊ - /**␊ - * The date that the attachment was first created.␊ - */␊ - creation?: string␊ - _creation?: Element58␊ - }␊ - /**␊ - * This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use.␊ - */␊ - export interface Medication {␊ - /**␊ - * This is a Medication resource␊ - */␊ - resourceType: "Medication"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta75␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1162␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1163␊ - text?: Narrative73␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Business identifier for this medication.␊ - */␊ - identifier?: Identifier2[]␊ - code?: CodeableConcept302␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - status?: string␊ - _status?: Element1164␊ - manufacturer?: Reference289␊ - form?: CodeableConcept303␊ - amount?: Ratio4␊ - /**␊ - * Identifies a particular constituent of interest in the product.␊ - */␊ - ingredient?: Medication_Ingredient[]␊ - batch?: Medication_Batch␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta75 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1162 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1163 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative73 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept302 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1164 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference289 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept303 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Specific amount of the drug in the packaged product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.).␊ - */␊ - export interface Ratio4 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - numerator?: Quantity3␊ - denominator?: Quantity4␊ - }␊ - /**␊ - * This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use.␊ - */␊ - export interface Medication_Ingredient {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - itemCodeableConcept?: CodeableConcept304␊ - itemReference?: Reference290␊ - /**␊ - * Indication of whether this ingredient affects the therapeutic action of the drug.␊ - */␊ - isActive?: boolean␊ - _isActive?: Element1165␊ - strength?: Ratio5␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept304 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference290 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1165 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet.␊ - */␊ - export interface Ratio5 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - numerator?: Quantity3␊ - denominator?: Quantity4␊ - }␊ - /**␊ - * Information that only applies to packages (not products).␊ - */␊ - export interface Medication_Batch {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - lotNumber?: string␊ - _lotNumber?: Element1166␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - expirationDate?: string␊ - _expirationDate?: Element1167␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1166 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1167 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Describes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.␊ - */␊ - export interface MedicationAdministration {␊ - /**␊ - * This is a MedicationAdministration resource␊ - */␊ - resourceType: "MedicationAdministration"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta76␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1168␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1169␊ - text?: Narrative74␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifiers associated with this Medication Administration that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * A protocol, guideline, orderset, or other definition that was adhered to in whole or in part by this event.␊ - */␊ - instantiates?: Uri[]␊ - /**␊ - * Extensions for instantiates␊ - */␊ - _instantiates?: Element23[]␊ - /**␊ - * A larger event of which this particular event is a component or step.␊ - */␊ - partOf?: Reference11[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - status?: string␊ - _status?: Element1170␊ - /**␊ - * A code indicating why the administration was not performed.␊ - */␊ - statusReason?: CodeableConcept5[]␊ - category?: CodeableConcept305␊ - medicationCodeableConcept?: CodeableConcept306␊ - medicationReference?: Reference291␊ - subject: Reference292␊ - context?: Reference293␊ - /**␊ - * Additional information (for example, patient height and weight) that supports the administration of the medication.␊ - */␊ - supportingInformation?: Reference11[]␊ - /**␊ - * A specific date/time or interval of time during which the administration took place (or did not take place, when the 'notGiven' attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.␊ - */␊ - effectiveDateTime?: string␊ - _effectiveDateTime?: Element1171␊ - effectivePeriod?: Period78␊ - /**␊ - * Indicates who or what performed the medication administration and how they were involved.␊ - */␊ - performer?: MedicationAdministration_Performer[]␊ - /**␊ - * A code indicating why the medication was given.␊ - */␊ - reasonCode?: CodeableConcept5[]␊ - /**␊ - * Condition or observation that supports why the medication was administered.␊ - */␊ - reasonReference?: Reference11[]␊ - request?: Reference295␊ - /**␊ - * The device used in administering the medication to the patient. For example, a particular infusion pump.␊ - */␊ - device?: Reference11[]␊ - /**␊ - * Extra information about the medication administration that is not conveyed by the other attributes.␊ - */␊ - note?: Annotation1[]␊ - dosage?: MedicationAdministration_Dosage␊ - /**␊ - * A summary of the events of interest that have occurred, such as when the administration was verified.␊ - */␊ - eventHistory?: Reference11[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta76 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1168 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1169 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative74 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1170 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept305 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept306 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference291 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference292 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference293 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1171 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period78 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Describes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.␊ - */␊ - export interface MedicationAdministration_Performer {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - function?: CodeableConcept307␊ - actor: Reference294␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept307 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference294 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference295 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Describes the medication dosage information details e.g. dose, rate, site, route, etc.␊ - */␊ - export interface MedicationAdministration_Dosage {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element1172␊ - site?: CodeableConcept308␊ - route?: CodeableConcept309␊ - method?: CodeableConcept310␊ - dose?: Quantity50␊ - rateRatio?: Ratio6␊ - rateQuantity?: Quantity51␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1172 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept308 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept309 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept310 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity50 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * Identifies the speed with which the medication was or will be introduced into the patient. Typically, the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time, e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours.␊ - */␊ - export interface Ratio6 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - numerator?: Quantity3␊ - denominator?: Quantity4␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity51 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * Indicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order.␊ - */␊ - export interface MedicationDispense {␊ - /**␊ - * This is a MedicationDispense resource␊ - */␊ - resourceType: "MedicationDispense"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta77␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1173␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1174␊ - text?: Narrative75␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifiers associated with this Medication Dispense that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * The procedure that trigger the dispense.␊ - */␊ - partOf?: Reference11[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - status?: string␊ - _status?: Element1175␊ - statusReasonCodeableConcept?: CodeableConcept311␊ - statusReasonReference?: Reference296␊ - category?: CodeableConcept312␊ - medicationCodeableConcept?: CodeableConcept313␊ - medicationReference?: Reference297␊ - subject?: Reference298␊ - context?: Reference299␊ - /**␊ - * Additional information that supports the medication being dispensed.␊ - */␊ - supportingInformation?: Reference11[]␊ - /**␊ - * Indicates who or what performed the event.␊ - */␊ - performer?: MedicationDispense_Performer[]␊ - location?: Reference301␊ - /**␊ - * Indicates the medication order that is being dispensed against.␊ - */␊ - authorizingPrescription?: Reference11[]␊ - type?: CodeableConcept315␊ - quantity?: Quantity52␊ - daysSupply?: Quantity53␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - whenPrepared?: string␊ - _whenPrepared?: Element1176␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - whenHandedOver?: string␊ - _whenHandedOver?: Element1177␊ - destination?: Reference302␊ - /**␊ - * Identifies the person who picked up the medication. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional.␊ - */␊ - receiver?: Reference11[]␊ - /**␊ - * Extra information about the dispense that could not be conveyed in the other attributes.␊ - */␊ - note?: Annotation1[]␊ - /**␊ - * Indicates how the medication is to be used by the patient.␊ - */␊ - dosageInstruction?: Dosage1[]␊ - substitution?: MedicationDispense_Substitution␊ - /**␊ - * Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. drug-drug interaction, duplicate therapy, dosage alert etc.␊ - */␊ - detectedIssue?: Reference11[]␊ - /**␊ - * A summary of the events of interest that have occurred, such as when the dispense was verified.␊ - */␊ - eventHistory?: Reference11[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta77 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1173 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1174 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative75 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1175 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept311 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference296 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept312 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept313 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference297 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference298 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference299 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Indicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order.␊ - */␊ - export interface MedicationDispense_Performer {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - function?: CodeableConcept314␊ - actor: Reference300␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept314 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference300 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference301 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept315 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity52 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity53 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1176 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1177 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference302 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Indicates whether or not substitution was made as part of the dispense. In some cases, substitution will be expected but does not happen, in other cases substitution is not expected but does happen. This block explains what substitution did or did not happen and why. If nothing is specified, substitution was not done.␊ - */␊ - export interface MedicationDispense_Substitution {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * True if the dispenser dispensed a different drug or product from what was prescribed.␊ - */␊ - wasSubstituted?: boolean␊ - _wasSubstituted?: Element1178␊ - type?: CodeableConcept316␊ - /**␊ - * Indicates the reason for the substitution (or lack of substitution) from what was prescribed.␊ - */␊ - reason?: CodeableConcept5[]␊ - /**␊ - * The person or organization that has primary responsibility for the substitution.␊ - */␊ - responsibleParty?: Reference11[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1178 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept316 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Information about a medication that is used to support knowledge.␊ - */␊ - export interface MedicationKnowledge {␊ - /**␊ - * This is a MedicationKnowledge resource␊ - */␊ - resourceType: "MedicationKnowledge"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta78␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1179␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1180␊ - text?: Narrative76␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - code?: CodeableConcept317␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - status?: string␊ - _status?: Element1181␊ - manufacturer?: Reference303␊ - doseForm?: CodeableConcept318␊ - amount?: Quantity54␊ - /**␊ - * Additional names for a medication, for example, the name(s) given to a medication in different countries. For example, acetaminophen and paracetamol or salbutamol and albuterol.␊ - */␊ - synonym?: String[]␊ - /**␊ - * Extensions for synonym␊ - */␊ - _synonym?: Element23[]␊ - /**␊ - * Associated or related knowledge about a medication.␊ - */␊ - relatedMedicationKnowledge?: MedicationKnowledge_RelatedMedicationKnowledge[]␊ - /**␊ - * Associated or related medications. For example, if the medication is a branded product (e.g. Crestor), this is the Therapeutic Moeity (e.g. Rosuvastatin) or if this is a generic medication (e.g. Rosuvastatin), this would link to a branded product (e.g. Crestor).␊ - */␊ - associatedMedication?: Reference11[]␊ - /**␊ - * Category of the medication or product (e.g. branded product, therapeutic moeity, generic product, innovator product, etc.).␊ - */␊ - productType?: CodeableConcept5[]␊ - /**␊ - * Associated documentation about the medication.␊ - */␊ - monograph?: MedicationKnowledge_Monograph[]␊ - /**␊ - * Identifies a particular constituent of interest in the product.␊ - */␊ - ingredient?: MedicationKnowledge_Ingredient[]␊ - /**␊ - * A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine␊ - */␊ - preparationInstruction?: string␊ - _preparationInstruction?: Element1183␊ - /**␊ - * The intended or approved route of administration.␊ - */␊ - intendedRoute?: CodeableConcept5[]␊ - /**␊ - * The price of the medication.␊ - */␊ - cost?: MedicationKnowledge_Cost[]␊ - /**␊ - * The program under which the medication is reviewed.␊ - */␊ - monitoringProgram?: MedicationKnowledge_MonitoringProgram[]␊ - /**␊ - * Guidelines for the administration of the medication.␊ - */␊ - administrationGuidelines?: MedicationKnowledge_AdministrationGuidelines[]␊ - /**␊ - * Categorization of the medication within a formulary or classification system.␊ - */␊ - medicineClassification?: MedicationKnowledge_MedicineClassification[]␊ - packaging?: MedicationKnowledge_Packaging␊ - /**␊ - * Specifies descriptive properties of the medicine, such as color, shape, imprints, etc.␊ - */␊ - drugCharacteristic?: MedicationKnowledge_DrugCharacteristic[]␊ - /**␊ - * Potential clinical issue with or between medication(s) (for example, drug-drug interaction, drug-disease contraindication, drug-allergy interaction, etc.).␊ - */␊ - contraindication?: Reference11[]␊ - /**␊ - * Regulatory information about a medication.␊ - */␊ - regulatory?: MedicationKnowledge_Regulatory[]␊ - /**␊ - * The time course of drug absorption, distribution, metabolism and excretion of a medication from the body.␊ - */␊ - kinetics?: MedicationKnowledge_Kinetics[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta78 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1179 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1180 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative76 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept317 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1181 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference303 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept318 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity54 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * Information about a medication that is used to support knowledge.␊ - */␊ - export interface MedicationKnowledge_RelatedMedicationKnowledge {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - type: CodeableConcept319␊ - /**␊ - * Associated documentation about the associated medication knowledge.␊ - */␊ - reference: Reference11[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept319 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Information about a medication that is used to support knowledge.␊ - */␊ - export interface MedicationKnowledge_Monograph {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - type?: CodeableConcept320␊ - source?: Reference304␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept320 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference304 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Information about a medication that is used to support knowledge.␊ - */␊ - export interface MedicationKnowledge_Ingredient {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - itemCodeableConcept?: CodeableConcept321␊ - itemReference?: Reference305␊ - /**␊ - * Indication of whether this ingredient affects the therapeutic action of the drug.␊ - */␊ - isActive?: boolean␊ - _isActive?: Element1182␊ - strength?: Ratio7␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept321 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference305 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1182 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet.␊ - */␊ - export interface Ratio7 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - numerator?: Quantity3␊ - denominator?: Quantity4␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1183 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Information about a medication that is used to support knowledge.␊ - */␊ - export interface MedicationKnowledge_Cost {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - type: CodeableConcept322␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - source?: string␊ - _source?: Element1184␊ - cost: Money48␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept322 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1184 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The price of the medication.␊ - */␊ - export interface Money48 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * Information about a medication that is used to support knowledge.␊ - */␊ - export interface MedicationKnowledge_MonitoringProgram {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - type?: CodeableConcept323␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element1185␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept323 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1185 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Information about a medication that is used to support knowledge.␊ - */␊ - export interface MedicationKnowledge_AdministrationGuidelines {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Dosage for the medication for the specific guidelines.␊ - */␊ - dosage?: MedicationKnowledge_Dosage[]␊ - indicationCodeableConcept?: CodeableConcept325␊ - indicationReference?: Reference306␊ - /**␊ - * Characteristics of the patient that are relevant to the administration guidelines (for example, height, weight, gender, etc.).␊ - */␊ - patientCharacteristics?: MedicationKnowledge_PatientCharacteristics[]␊ - }␊ - /**␊ - * Information about a medication that is used to support knowledge.␊ - */␊ - export interface MedicationKnowledge_Dosage {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - type: CodeableConcept324␊ - /**␊ - * Dosage for the medication for the specific guidelines.␊ - */␊ - dosage: Dosage1[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept324 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept325 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference306 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Information about a medication that is used to support knowledge.␊ - */␊ - export interface MedicationKnowledge_PatientCharacteristics {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - characteristicCodeableConcept?: CodeableConcept326␊ - characteristicQuantity?: Quantity55␊ - /**␊ - * The specific characteristic (e.g. height, weight, gender, etc.).␊ - */␊ - value?: String[]␊ - /**␊ - * Extensions for value␊ - */␊ - _value?: Element23[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept326 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity55 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * Information about a medication that is used to support knowledge.␊ - */␊ - export interface MedicationKnowledge_MedicineClassification {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - type: CodeableConcept327␊ - /**␊ - * Specific category assigned to the medication (e.g. anti-infective, anti-hypertensive, antibiotic, etc.).␊ - */␊ - classification?: CodeableConcept5[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept327 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Information that only applies to packages (not products).␊ - */␊ - export interface MedicationKnowledge_Packaging {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - type?: CodeableConcept328␊ - quantity?: Quantity56␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept328 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity56 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * Information about a medication that is used to support knowledge.␊ - */␊ - export interface MedicationKnowledge_DrugCharacteristic {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - type?: CodeableConcept329␊ - valueCodeableConcept?: CodeableConcept330␊ - /**␊ - * Description of the characteristic.␊ - */␊ - valueString?: string␊ - _valueString?: Element1186␊ - valueQuantity?: Quantity57␊ - /**␊ - * Description of the characteristic.␊ - */␊ - valueBase64Binary?: string␊ - _valueBase64Binary?: Element1187␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept329 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept330 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1186 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity57 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1187 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Information about a medication that is used to support knowledge.␊ - */␊ - export interface MedicationKnowledge_Regulatory {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - regulatoryAuthority: Reference307␊ - /**␊ - * Specifies if changes are allowed when dispensing a medication from a regulatory perspective.␊ - */␊ - substitution?: MedicationKnowledge_Substitution[]␊ - /**␊ - * Specifies the schedule of a medication in jurisdiction.␊ - */␊ - schedule?: MedicationKnowledge_Schedule[]␊ - maxDispense?: MedicationKnowledge_MaxDispense␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference307 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Information about a medication that is used to support knowledge.␊ - */␊ - export interface MedicationKnowledge_Substitution {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - type: CodeableConcept331␊ - /**␊ - * Specifies if regulation allows for changes in the medication when dispensing.␊ - */␊ - allowed?: boolean␊ - _allowed?: Element1188␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept331 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1188 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Information about a medication that is used to support knowledge.␊ - */␊ - export interface MedicationKnowledge_Schedule {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - schedule: CodeableConcept332␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept332 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * The maximum number of units of the medication that can be dispensed in a period.␊ - */␊ - export interface MedicationKnowledge_MaxDispense {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - quantity: Quantity58␊ - period?: Duration8␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity58 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * The period that applies to the maximum number of units.␊ - */␊ - export interface Duration8 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element73␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element74␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element75␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element76␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element77␊ - }␊ - /**␊ - * Information about a medication that is used to support knowledge.␊ - */␊ - export interface MedicationKnowledge_Kinetics {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * The drug concentration measured at certain discrete points in time.␊ - */␊ - areaUnderCurve?: Quantity26[]␊ - /**␊ - * The median lethal dose of a drug.␊ - */␊ - lethalDose50?: Quantity26[]␊ - halfLifePeriod?: Duration9␊ - }␊ - /**␊ - * The time required for any specified property (e.g., the concentration of a substance in the body) to decrease by half.␊ - */␊ - export interface Duration9 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element73␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element74␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element75␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element76␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element77␊ - }␊ - /**␊ - * An order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called "MedicationRequest" rather than "MedicationPrescription" or "MedicationOrder" to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns.␊ - */␊ - export interface MedicationRequest {␊ - /**␊ - * This is a MedicationRequest resource␊ - */␊ - resourceType: "MedicationRequest"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta79␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1189␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1190␊ - text?: Narrative77␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifiers associated with this medication request that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - status?: string␊ - _status?: Element1191␊ - statusReason?: CodeableConcept333␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - intent?: string␊ - _intent?: Element1192␊ - /**␊ - * Indicates the type of medication request (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)).␊ - */␊ - category?: CodeableConcept5[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - priority?: string␊ - _priority?: Element1193␊ - /**␊ - * If true indicates that the provider is asking for the medication request not to occur.␊ - */␊ - doNotPerform?: boolean␊ - _doNotPerform?: Element1194␊ - /**␊ - * Indicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of-truth record. It may also indicate the source of the report.␊ - */␊ - reportedBoolean?: boolean␊ - _reportedBoolean?: Element1195␊ - reportedReference?: Reference308␊ - medicationCodeableConcept?: CodeableConcept334␊ - medicationReference?: Reference309␊ - subject: Reference310␊ - encounter?: Reference311␊ - /**␊ - * Include additional information (for example, patient height and weight) that supports the ordering of the medication.␊ - */␊ - supportingInformation?: Reference11[]␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - authoredOn?: string␊ - _authoredOn?: Element1196␊ - requester?: Reference312␊ - performer?: Reference313␊ - performerType?: CodeableConcept335␊ - recorder?: Reference314␊ - /**␊ - * The reason or the indication for ordering or not ordering the medication.␊ - */␊ - reasonCode?: CodeableConcept5[]␊ - /**␊ - * Condition or observation that supports why the medication was ordered.␊ - */␊ - reasonReference?: Reference11[]␊ - /**␊ - * The URL pointing to a protocol, guideline, orderset, or other definition that is adhered to in whole or in part by this MedicationRequest.␊ - */␊ - instantiatesCanonical?: Canonical[]␊ - /**␊ - * Extensions for instantiatesCanonical␊ - */␊ - _instantiatesCanonical?: Element23[]␊ - /**␊ - * The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this MedicationRequest.␊ - */␊ - instantiatesUri?: Uri[]␊ - /**␊ - * Extensions for instantiatesUri␊ - */␊ - _instantiatesUri?: Element23[]␊ - /**␊ - * A plan or request that is fulfilled in whole or in part by this medication request.␊ - */␊ - basedOn?: Reference11[]␊ - groupIdentifier?: Identifier24␊ - courseOfTherapyType?: CodeableConcept336␊ - /**␊ - * Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.␊ - */␊ - insurance?: Reference11[]␊ - /**␊ - * Extra information about the prescription that could not be conveyed by the other attributes.␊ - */␊ - note?: Annotation1[]␊ - /**␊ - * Indicates how the medication is to be used by the patient.␊ - */␊ - dosageInstruction?: Dosage1[]␊ - dispenseRequest?: MedicationRequest_DispenseRequest␊ - substitution?: MedicationRequest_Substitution␊ - priorPrescription?: Reference316␊ - /**␊ - * Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, duplicate therapy, dosage alert etc.␊ - */␊ - detectedIssue?: Reference11[]␊ - /**␊ - * Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource.␊ - */␊ - eventHistory?: Reference11[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta79 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1189 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1190 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative77 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1191 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept333 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1192 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1193 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1194 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1195 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference308 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept334 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference309 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference310 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference311 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1196 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference312 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference313 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept335 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference314 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier24 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept336 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Indicates the specific details for the dispense or medication supply part of a medication request (also known as a Medication Prescription or Medication Order). Note that this information is not always sent with the order. There may be in some settings (e.g. hospitals) institutional or system support for completing the dispense details in the pharmacy department.␊ - */␊ - export interface MedicationRequest_DispenseRequest {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - initialFill?: MedicationRequest_InitialFill␊ - dispenseInterval?: Duration11␊ - validityPeriod?: Period79␊ - /**␊ - * An integer with a value that is not negative (e.g. >= 0)␊ - */␊ - numberOfRepeatsAllowed?: number␊ - _numberOfRepeatsAllowed?: Element1197␊ - quantity?: Quantity60␊ - expectedSupplyDuration?: Duration12␊ - performer?: Reference315␊ - }␊ - /**␊ - * Indicates the quantity or duration for the first dispense of the medication.␊ - */␊ - export interface MedicationRequest_InitialFill {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - quantity?: Quantity59␊ - duration?: Duration10␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity59 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * The length of time that the first dispense is expected to last.␊ - */␊ - export interface Duration10 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element73␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element74␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element75␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element76␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element77␊ - }␊ - /**␊ - * The minimum period of time that must occur between dispenses of the medication.␊ - */␊ - export interface Duration11 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element73␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element74␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element75␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element76␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element77␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period79 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1197 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity60 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * Identifies the period time over which the supplied product is expected to be used, or the length of time the dispense is expected to last.␊ - */␊ - export interface Duration12 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element73␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element74␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element75␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element76␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element77␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference315 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Indicates whether or not substitution can or should be part of the dispense. In some cases, substitution must happen, in other cases substitution must not happen. This block explains the prescriber's intent. If nothing is specified substitution may be done.␊ - */␊ - export interface MedicationRequest_Substitution {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * True if the prescriber allows a different drug to be dispensed from what was prescribed.␊ - */␊ - allowedBoolean?: boolean␊ - _allowedBoolean?: Element1198␊ - allowedCodeableConcept?: CodeableConcept337␊ - reason?: CodeableConcept338␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1198 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept337 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept338 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference316 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A record of a medication that is being consumed by a patient. A MedicationStatement may indicate that the patient may be taking the medication now or has taken the medication in the past or will be taking the medication in the future. The source of this information can be the patient, significant other (such as a family member or spouse), or a clinician. A common scenario where this information is captured is during the history taking process during a patient visit or stay. The medication information may come from sources such as the patient's memory, from a prescription bottle, or from a list of medications the patient, clinician or other party maintains. ␊ - * ␊ - * The primary difference between a medication statement and a medication administration is that the medication administration has complete administration information and is based on actual administration information from the person who administered the medication. A medication statement is often, if not always, less specific. There is no required date/time when the medication was administered, in fact we only know that a source has reported the patient is taking this medication, where details such as time, quantity, or rate or even medication product may be incomplete or missing or less precise. As stated earlier, the medication statement information may come from the patient's memory, from a prescription bottle or from a list of medications the patient, clinician or other party maintains. Medication administration is more formal and is not missing detailed information.␊ - */␊ - export interface MedicationStatement {␊ - /**␊ - * This is a MedicationStatement resource␊ - */␊ - resourceType: "MedicationStatement"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta80␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1199␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1200␊ - text?: Narrative78␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifiers associated with this Medication Statement that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * A plan, proposal or order that is fulfilled in whole or in part by this event.␊ - */␊ - basedOn?: Reference11[]␊ - /**␊ - * A larger event of which this particular event is a component or step.␊ - */␊ - partOf?: Reference11[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - status?: string␊ - _status?: Element1201␊ - /**␊ - * Captures the reason for the current state of the MedicationStatement.␊ - */␊ - statusReason?: CodeableConcept5[]␊ - category?: CodeableConcept339␊ - medicationCodeableConcept?: CodeableConcept340␊ - medicationReference?: Reference317␊ - subject: Reference318␊ - context?: Reference319␊ - /**␊ - * The interval of time during which it is being asserted that the patient is/was/will be taking the medication (or was not taking, when the MedicationStatement.taken element is No).␊ - */␊ - effectiveDateTime?: string␊ - _effectiveDateTime?: Element1202␊ - effectivePeriod?: Period80␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - dateAsserted?: string␊ - _dateAsserted?: Element1203␊ - informationSource?: Reference320␊ - /**␊ - * Allows linking the MedicationStatement to the underlying MedicationRequest, or to other information that supports or is used to derive the MedicationStatement.␊ - */␊ - derivedFrom?: Reference11[]␊ - /**␊ - * A reason for why the medication is being/was taken.␊ - */␊ - reasonCode?: CodeableConcept5[]␊ - /**␊ - * Condition or observation that supports why the medication is being/was taken.␊ - */␊ - reasonReference?: Reference11[]␊ - /**␊ - * Provides extra information about the medication statement that is not conveyed by the other attributes.␊ - */␊ - note?: Annotation1[]␊ - /**␊ - * Indicates how the medication is/was or should be taken by the patient.␊ - */␊ - dosage?: Dosage1[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta80 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1199 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1200 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative78 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1201 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept339 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept340 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference317 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference318 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference319 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1202 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period80 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1203 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference320 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use).␊ - */␊ - export interface MedicinalProduct {␊ - /**␊ - * This is a MedicinalProduct resource␊ - */␊ - resourceType: "MedicinalProduct"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta81␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1204␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1205␊ - text?: Narrative79␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Business identifier for this product. Could be an MPID.␊ - */␊ - identifier?: Identifier2[]␊ - type?: CodeableConcept341␊ - domain?: Coding25␊ - combinedPharmaceuticalDoseForm?: CodeableConcept342␊ - legalStatusOfSupply?: CodeableConcept343␊ - additionalMonitoringIndicator?: CodeableConcept344␊ - /**␊ - * Whether the Medicinal Product is subject to special measures for regulatory reasons.␊ - */␊ - specialMeasures?: String[]␊ - /**␊ - * Extensions for specialMeasures␊ - */␊ - _specialMeasures?: Element23[]␊ - paediatricUseIndicator?: CodeableConcept345␊ - /**␊ - * Allows the product to be classified by various systems.␊ - */␊ - productClassification?: CodeableConcept5[]␊ - /**␊ - * Marketing status of the medicinal product, in contrast to marketing authorizaton.␊ - */␊ - marketingStatus?: MarketingStatus[]␊ - /**␊ - * Pharmaceutical aspects of product.␊ - */␊ - pharmaceuticalProduct?: Reference11[]␊ - /**␊ - * Package representation for the product.␊ - */␊ - packagedMedicinalProduct?: Reference11[]␊ - /**␊ - * Supporting documentation, typically for regulatory submission.␊ - */␊ - attachedDocument?: Reference11[]␊ - /**␊ - * A master file for to the medicinal product (e.g. Pharmacovigilance System Master File).␊ - */␊ - masterFile?: Reference11[]␊ - /**␊ - * A product specific contact, person (in a role), or an organization.␊ - */␊ - contact?: Reference11[]␊ - /**␊ - * Clinical trials or studies that this product is involved in.␊ - */␊ - clinicalTrial?: Reference11[]␊ - /**␊ - * The product's name, including full name and possibly coded parts.␊ - */␊ - name: MedicinalProduct_Name[]␊ - /**␊ - * Reference to another product, e.g. for linking authorised to investigational product.␊ - */␊ - crossReference?: Identifier2[]␊ - /**␊ - * An operation applied to the product, for manufacturing or adminsitrative purpose.␊ - */␊ - manufacturingBusinessOperation?: MedicinalProduct_ManufacturingBusinessOperation[]␊ - /**␊ - * Indicates if the medicinal product has an orphan designation for the treatment of a rare disease.␊ - */␊ - specialDesignation?: MedicinalProduct_SpecialDesignation[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta81 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1204 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1205 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative79 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept341 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - export interface Coding25 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The identification of the code system that defines the meaning of the symbol in the code.␊ - */␊ - system?: string␊ - _system?: Element39␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element40␊ - /**␊ - * A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).␊ - */␊ - code?: string␊ - _code?: Element41␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element42␊ - /**␊ - * Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).␊ - */␊ - userSelected?: boolean␊ - _userSelected?: Element43␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept342 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept343 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept344 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept345 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * The marketing status describes the date when a medicinal product is actually put on the market or the date as of which it is no longer available.␊ - */␊ - export interface MarketingStatus {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - country: CodeableConcept346␊ - jurisdiction?: CodeableConcept347␊ - status: CodeableConcept348␊ - dateRange: Period81␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - restoreDate?: string␊ - _restoreDate?: Element1206␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept346 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept347 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept348 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period81 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1206 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use).␊ - */␊ - export interface MedicinalProduct_Name {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - productName?: string␊ - _productName?: Element1207␊ - /**␊ - * Coding words or phrases of the name.␊ - */␊ - namePart?: MedicinalProduct_NamePart[]␊ - /**␊ - * Country where the name applies.␊ - */␊ - countryLanguage?: MedicinalProduct_CountryLanguage[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1207 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use).␊ - */␊ - export interface MedicinalProduct_NamePart {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - part?: string␊ - _part?: Element1208␊ - type: Coding26␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1208 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - export interface Coding26 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The identification of the code system that defines the meaning of the symbol in the code.␊ - */␊ - system?: string␊ - _system?: Element39␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element40␊ - /**␊ - * A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).␊ - */␊ - code?: string␊ - _code?: Element41␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element42␊ - /**␊ - * Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).␊ - */␊ - userSelected?: boolean␊ - _userSelected?: Element43␊ - }␊ - /**␊ - * Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use).␊ - */␊ - export interface MedicinalProduct_CountryLanguage {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - country: CodeableConcept349␊ - jurisdiction?: CodeableConcept350␊ - language: CodeableConcept351␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept349 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept350 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept351 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use).␊ - */␊ - export interface MedicinalProduct_ManufacturingBusinessOperation {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - operationType?: CodeableConcept352␊ - authorisationReferenceNumber?: Identifier25␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - effectiveDate?: string␊ - _effectiveDate?: Element1209␊ - confidentialityIndicator?: CodeableConcept353␊ - /**␊ - * The manufacturer or establishment associated with the process.␊ - */␊ - manufacturer?: Reference11[]␊ - regulator?: Reference321␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept352 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier25 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1209 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept353 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference321 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use).␊ - */␊ - export interface MedicinalProduct_SpecialDesignation {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifier for the designation, or procedure number.␊ - */␊ - identifier?: Identifier2[]␊ - type?: CodeableConcept354␊ - intendedUse?: CodeableConcept355␊ - indicationCodeableConcept?: CodeableConcept356␊ - indicationReference?: Reference322␊ - status?: CodeableConcept357␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - date?: string␊ - _date?: Element1210␊ - species?: CodeableConcept358␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept354 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept355 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept356 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference322 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept357 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1210 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept358 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * The regulatory authorization of a medicinal product.␊ - */␊ - export interface MedicinalProductAuthorization {␊ - /**␊ - * This is a MedicinalProductAuthorization resource␊ - */␊ - resourceType: "MedicinalProductAuthorization"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta82␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1211␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1212␊ - text?: Narrative80␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Business identifier for the marketing authorization, as assigned by a regulator.␊ - */␊ - identifier?: Identifier2[]␊ - subject?: Reference323␊ - /**␊ - * The country in which the marketing authorization has been granted.␊ - */␊ - country?: CodeableConcept5[]␊ - /**␊ - * Jurisdiction within a country.␊ - */␊ - jurisdiction?: CodeableConcept5[]␊ - status?: CodeableConcept359␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - statusDate?: string␊ - _statusDate?: Element1213␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - restoreDate?: string␊ - _restoreDate?: Element1214␊ - validityPeriod?: Period82␊ - dataExclusivityPeriod?: Period83␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - dateOfFirstAuthorization?: string␊ - _dateOfFirstAuthorization?: Element1215␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - internationalBirthDate?: string␊ - _internationalBirthDate?: Element1216␊ - legalBasis?: CodeableConcept360␊ - /**␊ - * Authorization in areas within a country.␊ - */␊ - jurisdictionalAuthorization?: MedicinalProductAuthorization_JurisdictionalAuthorization[]␊ - holder?: Reference324␊ - regulator?: Reference325␊ - procedure?: MedicinalProductAuthorization_Procedure␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta82 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1211 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1212 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative80 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference323 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept359 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1213 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1214 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period82 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period83 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1215 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1216 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept360 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * The regulatory authorization of a medicinal product.␊ - */␊ - export interface MedicinalProductAuthorization_JurisdictionalAuthorization {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * The assigned number for the marketing authorization.␊ - */␊ - identifier?: Identifier2[]␊ - country?: CodeableConcept361␊ - /**␊ - * Jurisdiction within a country.␊ - */␊ - jurisdiction?: CodeableConcept5[]␊ - legalStatusOfSupply?: CodeableConcept362␊ - validityPeriod?: Period84␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept361 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept362 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period84 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference324 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference325 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * The regulatory procedure for granting or amending a marketing authorization.␊ - */␊ - export interface MedicinalProductAuthorization_Procedure {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - identifier?: Identifier26␊ - type: CodeableConcept363␊ - datePeriod?: Period85␊ - /**␊ - * Date of procedure.␊ - */␊ - dateDateTime?: string␊ - _dateDateTime?: Element1217␊ - /**␊ - * Applcations submitted to obtain a marketing authorization.␊ - */␊ - application?: MedicinalProductAuthorization_Procedure1[]␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier26 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept363 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period85 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1217 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The regulatory authorization of a medicinal product.␊ - */␊ - export interface MedicinalProductAuthorization_Procedure1 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - identifier?: Identifier26␊ - type: CodeableConcept363␊ - datePeriod?: Period85␊ - /**␊ - * Date of procedure.␊ - */␊ - dateDateTime?: string␊ - _dateDateTime?: Element1217␊ - /**␊ - * Applcations submitted to obtain a marketing authorization.␊ - */␊ - application?: MedicinalProductAuthorization_Procedure1[]␊ - }␊ - /**␊ - * The clinical particulars - indications, contraindications etc. of a medicinal product, including for regulatory purposes.␊ - */␊ - export interface MedicinalProductContraindication {␊ - /**␊ - * This is a MedicinalProductContraindication resource␊ - */␊ - resourceType: "MedicinalProductContraindication"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta83␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1218␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1219␊ - text?: Narrative81␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * The medication for which this is an indication.␊ - */␊ - subject?: Reference11[]␊ - disease?: CodeableConcept364␊ - diseaseStatus?: CodeableConcept365␊ - /**␊ - * A comorbidity (concurrent condition) or coinfection.␊ - */␊ - comorbidity?: CodeableConcept5[]␊ - /**␊ - * Information about the use of the medicinal product in relation to other therapies as part of the indication.␊ - */␊ - therapeuticIndication?: Reference11[]␊ - /**␊ - * Information about the use of the medicinal product in relation to other therapies described as part of the indication.␊ - */␊ - otherTherapy?: MedicinalProductContraindication_OtherTherapy[]␊ - /**␊ - * The population group to which this applies.␊ - */␊ - population?: Population[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta83 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1218 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1219 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative81 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept364 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept365 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * The clinical particulars - indications, contraindications etc. of a medicinal product, including for regulatory purposes.␊ - */␊ - export interface MedicinalProductContraindication_OtherTherapy {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - therapyRelationshipType: CodeableConcept366␊ - medicationCodeableConcept?: CodeableConcept367␊ - medicationReference?: Reference326␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept366 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept367 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference326 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A populatioof people with some set of grouping criteria.␊ - */␊ - export interface Population {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - ageRange?: Range15␊ - ageCodeableConcept?: CodeableConcept368␊ - gender?: CodeableConcept369␊ - race?: CodeableConcept370␊ - physiologicalCondition?: CodeableConcept371␊ - }␊ - /**␊ - * The age of the specific population.␊ - */␊ - export interface Range15 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - low?: Quantity1␊ - high?: Quantity2␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept368 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept369 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept370 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept371 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Indication for the Medicinal Product.␊ - */␊ - export interface MedicinalProductIndication {␊ - /**␊ - * This is a MedicinalProductIndication resource␊ - */␊ - resourceType: "MedicinalProductIndication"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta84␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1220␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1221␊ - text?: Narrative82␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * The medication for which this is an indication.␊ - */␊ - subject?: Reference11[]␊ - diseaseSymptomProcedure?: CodeableConcept372␊ - diseaseStatus?: CodeableConcept373␊ - /**␊ - * Comorbidity (concurrent condition) or co-infection as part of the indication.␊ - */␊ - comorbidity?: CodeableConcept5[]␊ - intendedEffect?: CodeableConcept374␊ - duration?: Quantity61␊ - /**␊ - * Information about the use of the medicinal product in relation to other therapies described as part of the indication.␊ - */␊ - otherTherapy?: MedicinalProductIndication_OtherTherapy[]␊ - /**␊ - * Describe the undesirable effects of the medicinal product.␊ - */␊ - undesirableEffect?: Reference11[]␊ - /**␊ - * The population group to which this applies.␊ - */␊ - population?: Population[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta84 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1220 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1221 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative82 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept372 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept373 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept374 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity61 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * Indication for the Medicinal Product.␊ - */␊ - export interface MedicinalProductIndication_OtherTherapy {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - therapyRelationshipType: CodeableConcept375␊ - medicationCodeableConcept?: CodeableConcept376␊ - medicationReference?: Reference327␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept375 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept376 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference327 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * An ingredient of a manufactured item or pharmaceutical product.␊ - */␊ - export interface MedicinalProductIngredient {␊ - /**␊ - * This is a MedicinalProductIngredient resource␊ - */␊ - resourceType: "MedicinalProductIngredient"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta85␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1222␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1223␊ - text?: Narrative83␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - identifier?: Identifier27␊ - role: CodeableConcept377␊ - /**␊ - * If the ingredient is a known or suspected allergen.␊ - */␊ - allergenicIndicator?: boolean␊ - _allergenicIndicator?: Element1224␊ - /**␊ - * Manufacturer of this Ingredient.␊ - */␊ - manufacturer?: Reference11[]␊ - /**␊ - * A specified substance that comprises this ingredient.␊ - */␊ - specifiedSubstance?: MedicinalProductIngredient_SpecifiedSubstance[]␊ - substance?: MedicinalProductIngredient_Substance␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta85 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1222 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1223 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative83 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier27 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept377 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1224 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * An ingredient of a manufactured item or pharmaceutical product.␊ - */␊ - export interface MedicinalProductIngredient_SpecifiedSubstance {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - code: CodeableConcept378␊ - group: CodeableConcept379␊ - confidentiality?: CodeableConcept380␊ - /**␊ - * Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product.␊ - */␊ - strength?: MedicinalProductIngredient_Strength[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept378 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept379 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept380 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * An ingredient of a manufactured item or pharmaceutical product.␊ - */␊ - export interface MedicinalProductIngredient_Strength {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - presentation: Ratio8␊ - presentationLowLimit?: Ratio9␊ - concentration?: Ratio10␊ - concentrationLowLimit?: Ratio11␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - measurementPoint?: string␊ - _measurementPoint?: Element1225␊ - /**␊ - * The country or countries for which the strength range applies.␊ - */␊ - country?: CodeableConcept5[]␊ - /**␊ - * Strength expressed in terms of a reference substance.␊ - */␊ - referenceStrength?: MedicinalProductIngredient_ReferenceStrength[]␊ - }␊ - /**␊ - * The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item.␊ - */␊ - export interface Ratio8 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - numerator?: Quantity3␊ - denominator?: Quantity4␊ - }␊ - /**␊ - * A lower limit for the quantity of substance in the unit of presentation. For use when there is a range of strengths, this is the lower limit, with the presentation attribute becoming the upper limit.␊ - */␊ - export interface Ratio9 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - numerator?: Quantity3␊ - denominator?: Quantity4␊ - }␊ - /**␊ - * The strength per unitary volume (or mass).␊ - */␊ - export interface Ratio10 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - numerator?: Quantity3␊ - denominator?: Quantity4␊ - }␊ - /**␊ - * A lower limit for the strength per unitary volume (or mass), for when there is a range. The concentration attribute then becomes the upper limit.␊ - */␊ - export interface Ratio11 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - numerator?: Quantity3␊ - denominator?: Quantity4␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1225 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * An ingredient of a manufactured item or pharmaceutical product.␊ - */␊ - export interface MedicinalProductIngredient_ReferenceStrength {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - substance?: CodeableConcept381␊ - strength: Ratio12␊ - strengthLowLimit?: Ratio13␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - measurementPoint?: string␊ - _measurementPoint?: Element1226␊ - /**␊ - * The country or countries for which the strength range applies.␊ - */␊ - country?: CodeableConcept5[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept381 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Strength expressed in terms of a reference substance.␊ - */␊ - export interface Ratio12 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - numerator?: Quantity3␊ - denominator?: Quantity4␊ - }␊ - /**␊ - * Strength expressed in terms of a reference substance.␊ - */␊ - export interface Ratio13 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - numerator?: Quantity3␊ - denominator?: Quantity4␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1226 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The ingredient substance.␊ - */␊ - export interface MedicinalProductIngredient_Substance {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - code: CodeableConcept382␊ - /**␊ - * Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product.␊ - */␊ - strength?: MedicinalProductIngredient_Strength[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept382 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * The interactions of the medicinal product with other medicinal products, or other forms of interactions.␊ - */␊ - export interface MedicinalProductInteraction {␊ - /**␊ - * This is a MedicinalProductInteraction resource␊ - */␊ - resourceType: "MedicinalProductInteraction"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta86␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1227␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1228␊ - text?: Narrative84␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * The medication for which this is a described interaction.␊ - */␊ - subject?: Reference11[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element1229␊ - /**␊ - * The specific medication, food or laboratory test that interacts.␊ - */␊ - interactant?: MedicinalProductInteraction_Interactant[]␊ - type?: CodeableConcept384␊ - effect?: CodeableConcept385␊ - incidence?: CodeableConcept386␊ - management?: CodeableConcept387␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta86 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1227 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1228 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative84 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1229 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The interactions of the medicinal product with other medicinal products, or other forms of interactions.␊ - */␊ - export interface MedicinalProductInteraction_Interactant {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - itemReference?: Reference328␊ - itemCodeableConcept?: CodeableConcept383␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference328 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept383 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept384 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept385 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept386 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept387 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * The manufactured item as contained in the packaged medicinal product.␊ - */␊ - export interface MedicinalProductManufactured {␊ - /**␊ - * This is a MedicinalProductManufactured resource␊ - */␊ - resourceType: "MedicinalProductManufactured"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta87␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1230␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1231␊ - text?: Narrative85␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - manufacturedDoseForm: CodeableConcept388␊ - unitOfPresentation?: CodeableConcept389␊ - quantity: Quantity62␊ - /**␊ - * Manufacturer of the item (Note that this should be named "manufacturer" but it currently causes technical issues).␊ - */␊ - manufacturer?: Reference11[]␊ - /**␊ - * Ingredient.␊ - */␊ - ingredient?: Reference11[]␊ - physicalCharacteristics?: ProdCharacteristic1␊ - /**␊ - * Other codeable characteristics.␊ - */␊ - otherCharacteristics?: CodeableConcept5[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta87 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1230 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1231 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative85 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept388 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept389 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity62 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * Dimensions, color etc.␊ - */␊ - export interface ProdCharacteristic1 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - height?: Quantity28␊ - width?: Quantity29␊ - depth?: Quantity30␊ - weight?: Quantity31␊ - nominalVolume?: Quantity32␊ - externalDiameter?: Quantity33␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - shape?: string␊ - _shape?: Element658␊ - /**␊ - * Where applicable, the color can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used.␊ - */␊ - color?: String[]␊ - /**␊ - * Extensions for color␊ - */␊ - _color?: Element23[]␊ - /**␊ - * Where applicable, the imprint can be specified as text.␊ - */␊ - imprint?: String[]␊ - /**␊ - * Extensions for imprint␊ - */␊ - _imprint?: Element23[]␊ - /**␊ - * Where applicable, the image can be provided The format of the image attachment shall be specified by regional implementations.␊ - */␊ - image?: Attachment2[]␊ - scoring?: CodeableConcept153␊ - }␊ - /**␊ - * A medicinal product in a container or package.␊ - */␊ - export interface MedicinalProductPackaged {␊ - /**␊ - * This is a MedicinalProductPackaged resource␊ - */␊ - resourceType: "MedicinalProductPackaged"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta88␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1232␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1233␊ - text?: Narrative86␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Unique identifier.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * The product with this is a pack for.␊ - */␊ - subject?: Reference11[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element1234␊ - legalStatusOfSupply?: CodeableConcept390␊ - /**␊ - * Marketing information.␊ - */␊ - marketingStatus?: MarketingStatus[]␊ - marketingAuthorization?: Reference329␊ - /**␊ - * Manufacturer of this Package Item.␊ - */␊ - manufacturer?: Reference11[]␊ - /**␊ - * Batch numbering.␊ - */␊ - batchIdentifier?: MedicinalProductPackaged_BatchIdentifier[]␊ - /**␊ - * A packaging item, as a contained for medicine, possibly with other packaging items within.␊ - */␊ - packageItem: MedicinalProductPackaged_PackageItem[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta88 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1232 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1233 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative86 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1234 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept390 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference329 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A medicinal product in a container or package.␊ - */␊ - export interface MedicinalProductPackaged_BatchIdentifier {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - outerPackaging: Identifier28␊ - immediatePackaging?: Identifier29␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier28 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier29 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * A medicinal product in a container or package.␊ - */␊ - export interface MedicinalProductPackaged_PackageItem {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Including possibly Data Carrier Identifier.␊ - */␊ - identifier?: Identifier2[]␊ - type: CodeableConcept391␊ - quantity: Quantity63␊ - /**␊ - * Material type of the package item.␊ - */␊ - material?: CodeableConcept5[]␊ - /**␊ - * A possible alternate material for the packaging.␊ - */␊ - alternateMaterial?: CodeableConcept5[]␊ - /**␊ - * A device accompanying a medicinal product.␊ - */␊ - device?: Reference11[]␊ - /**␊ - * The manufactured item as contained in the packaged medicinal product.␊ - */␊ - manufacturedItem?: Reference11[]␊ - /**␊ - * Allows containers within containers.␊ - */␊ - packageItem?: MedicinalProductPackaged_PackageItem[]␊ - physicalCharacteristics?: ProdCharacteristic2␊ - /**␊ - * Other codeable characteristics.␊ - */␊ - otherCharacteristics?: CodeableConcept5[]␊ - /**␊ - * Shelf Life and storage information.␊ - */␊ - shelfLifeStorage?: ProductShelfLife[]␊ - /**␊ - * Manufacturer of this Package Item.␊ - */␊ - manufacturer?: Reference11[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept391 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity63 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * Dimensions, color etc.␊ - */␊ - export interface ProdCharacteristic2 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - height?: Quantity28␊ - width?: Quantity29␊ - depth?: Quantity30␊ - weight?: Quantity31␊ - nominalVolume?: Quantity32␊ - externalDiameter?: Quantity33␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - shape?: string␊ - _shape?: Element658␊ - /**␊ - * Where applicable, the color can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used.␊ - */␊ - color?: String[]␊ - /**␊ - * Extensions for color␊ - */␊ - _color?: Element23[]␊ - /**␊ - * Where applicable, the imprint can be specified as text.␊ - */␊ - imprint?: String[]␊ - /**␊ - * Extensions for imprint␊ - */␊ - _imprint?: Element23[]␊ - /**␊ - * Where applicable, the image can be provided The format of the image attachment shall be specified by regional implementations.␊ - */␊ - image?: Attachment2[]␊ - scoring?: CodeableConcept153␊ - }␊ - /**␊ - * A pharmaceutical product described in terms of its composition and dose form.␊ - */␊ - export interface MedicinalProductPharmaceutical {␊ - /**␊ - * This is a MedicinalProductPharmaceutical resource␊ - */␊ - resourceType: "MedicinalProductPharmaceutical"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta89␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1235␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1236␊ - text?: Narrative87␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * An identifier for the pharmaceutical medicinal product.␊ - */␊ - identifier?: Identifier2[]␊ - administrableDoseForm: CodeableConcept392␊ - unitOfPresentation?: CodeableConcept393␊ - /**␊ - * Ingredient.␊ - */␊ - ingredient?: Reference11[]␊ - /**␊ - * Accompanying device.␊ - */␊ - device?: Reference11[]␊ - /**␊ - * Characteristics e.g. a products onset of action.␊ - */␊ - characteristics?: MedicinalProductPharmaceutical_Characteristics[]␊ - /**␊ - * The path by which the pharmaceutical product is taken into or makes contact with the body.␊ - */␊ - routeOfAdministration: MedicinalProductPharmaceutical_RouteOfAdministration[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta89 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1235 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1236 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative87 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept392 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept393 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A pharmaceutical product described in terms of its composition and dose form.␊ - */␊ - export interface MedicinalProductPharmaceutical_Characteristics {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - code: CodeableConcept394␊ - status?: CodeableConcept395␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept394 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept395 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A pharmaceutical product described in terms of its composition and dose form.␊ - */␊ - export interface MedicinalProductPharmaceutical_RouteOfAdministration {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - code: CodeableConcept396␊ - firstDose?: Quantity64␊ - maxSingleDose?: Quantity65␊ - maxDosePerDay?: Quantity66␊ - maxDosePerTreatmentPeriod?: Ratio14␊ - maxTreatmentPeriod?: Duration13␊ - /**␊ - * A species for which this route applies.␊ - */␊ - targetSpecies?: MedicinalProductPharmaceutical_TargetSpecies[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept396 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity64 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity65 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity66 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * The maximum dose per treatment period that can be administered as per the protocol referenced in the clinical trial authorisation.␊ - */␊ - export interface Ratio14 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - numerator?: Quantity3␊ - denominator?: Quantity4␊ - }␊ - /**␊ - * The maximum treatment period during which an Investigational Medicinal Product can be administered as per the protocol referenced in the clinical trial authorisation.␊ - */␊ - export interface Duration13 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element73␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element74␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element75␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element76␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element77␊ - }␊ - /**␊ - * A pharmaceutical product described in terms of its composition and dose form.␊ - */␊ - export interface MedicinalProductPharmaceutical_TargetSpecies {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - code: CodeableConcept397␊ - /**␊ - * A species specific time during which consumption of animal product is not appropriate.␊ - */␊ - withdrawalPeriod?: MedicinalProductPharmaceutical_WithdrawalPeriod[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept397 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A pharmaceutical product described in terms of its composition and dose form.␊ - */␊ - export interface MedicinalProductPharmaceutical_WithdrawalPeriod {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - tissue: CodeableConcept398␊ - value: Quantity67␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - supportingInformation?: string␊ - _supportingInformation?: Element1237␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept398 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity67 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1237 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Describe the undesirable effects of the medicinal product.␊ - */␊ - export interface MedicinalProductUndesirableEffect {␊ - /**␊ - * This is a MedicinalProductUndesirableEffect resource␊ - */␊ - resourceType: "MedicinalProductUndesirableEffect"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta90␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1238␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1239␊ - text?: Narrative88␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * The medication for which this is an indication.␊ - */␊ - subject?: Reference11[]␊ - symptomConditionEffect?: CodeableConcept399␊ - classification?: CodeableConcept400␊ - frequencyOfOccurrence?: CodeableConcept401␊ - /**␊ - * The population group to which this applies.␊ - */␊ - population?: Population[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta90 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1238 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1239 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative88 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept399 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept400 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept401 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Defines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), if any, are permitted.␊ - */␊ - export interface MessageDefinition {␊ - /**␊ - * This is a MessageDefinition resource␊ - */␊ - resourceType: "MessageDefinition"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta91␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1240␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1241␊ - text?: Narrative89␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - url?: string␊ - _url?: Element1242␊ - /**␊ - * A formal identifier that is used to identify this message definition when it is represented in other formats, or referenced in a specification, model, design or an instance.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element1243␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element1244␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element1245␊ - /**␊ - * A MessageDefinition that is superseded by this definition.␊ - */␊ - replaces?: Canonical[]␊ - /**␊ - * The status of this message definition. Enables tracking the life-cycle of the content.␊ - */␊ - status?: ("draft" | "active" | "retired" | "unknown")␊ - _status?: Element1246␊ - /**␊ - * A Boolean value to indicate that this message definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.␊ - */␊ - experimental?: boolean␊ - _experimental?: Element1247␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - date?: string␊ - _date?: Element1248␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - publisher?: string␊ - _publisher?: Element1249␊ - /**␊ - * Contact details to assist a user in finding and communicating with the publisher.␊ - */␊ - contact?: ContactDetail1[]␊ - /**␊ - * A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine␊ - */␊ - description?: string␊ - _description?: Element1250␊ - /**␊ - * The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate message definition instances.␊ - */␊ - useContext?: UsageContext1[]␊ - /**␊ - * A legal or geographic region in which the message definition is intended to be used.␊ - */␊ - jurisdiction?: CodeableConcept5[]␊ - /**␊ - * A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine␊ - */␊ - purpose?: string␊ - _purpose?: Element1251␊ - /**␊ - * A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine␊ - */␊ - copyright?: string␊ - _copyright?: Element1252␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - base?: string␊ - /**␊ - * Identifies a protocol or workflow that this MessageDefinition represents a step in.␊ - */␊ - parent?: Canonical[]␊ - eventCoding?: Coding27␊ - /**␊ - * Event code or link to the EventDefinition.␊ - */␊ - eventUri?: string␊ - _eventUri?: Element1253␊ - /**␊ - * The impact of the content of the message.␊ - */␊ - category?: ("consequence" | "currency" | "notification")␊ - _category?: Element1254␊ - /**␊ - * Identifies the resource (or resources) that are being addressed by the event. For example, the Encounter for an admit message or two Account records for a merge.␊ - */␊ - focus?: MessageDefinition_Focus[]␊ - /**␊ - * Declare at a message definition level whether a response is required or only upon error or success, or never.␊ - */␊ - responseRequired?: ("always" | "on-error" | "never" | "on-success")␊ - _responseRequired?: Element1258␊ - /**␊ - * Indicates what types of messages may be sent as an application-level response to this message.␊ - */␊ - allowedResponse?: MessageDefinition_AllowedResponse[]␊ - /**␊ - * Canonical reference to a GraphDefinition. If a URL is provided, it is the canonical reference to a [[[GraphDefinition]]] that it controls what resources are to be added to the bundle when building the document. The GraphDefinition can also specify profiles that apply to the various resources.␊ - */␊ - graph?: Canonical[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta91 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1240 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1241 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative89 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1242 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1243 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1244 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1245 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1246 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1247 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1248 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1249 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1250 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1251 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1252 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - export interface Coding27 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The identification of the code system that defines the meaning of the symbol in the code.␊ - */␊ - system?: string␊ - _system?: Element39␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element40␊ - /**␊ - * A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).␊ - */␊ - code?: string␊ - _code?: Element41␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element42␊ - /**␊ - * Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).␊ - */␊ - userSelected?: boolean␊ - _userSelected?: Element43␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1253 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1254 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Defines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), if any, are permitted.␊ - */␊ - export interface MessageDefinition_Focus {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - code?: string␊ - _code?: Element1255␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - profile?: string␊ - /**␊ - * An integer with a value that is not negative (e.g. >= 0)␊ - */␊ - min?: number␊ - _min?: Element1256␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - max?: string␊ - _max?: Element1257␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1255 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1256 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1257 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1258 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Defines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), if any, are permitted.␊ - */␊ - export interface MessageDefinition_AllowedResponse {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - message: string␊ - /**␊ - * A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine␊ - */␊ - situation?: string␊ - _situation?: Element1259␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1259 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.␊ - */␊ - export interface MessageHeader {␊ - /**␊ - * This is a MessageHeader resource␊ - */␊ - resourceType: "MessageHeader"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta92␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1260␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1261␊ - text?: Narrative90␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - eventCoding?: Coding28␊ - /**␊ - * Code that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification have the system value "http://terminology.hl7.org/CodeSystem/message-events". Alternatively uri to the EventDefinition.␊ - */␊ - eventUri?: string␊ - _eventUri?: Element1262␊ - /**␊ - * The destination application which the message is intended for.␊ - */␊ - destination?: MessageHeader_Destination[]␊ - sender?: Reference332␊ - enterer?: Reference333␊ - author?: Reference334␊ - source: MessageHeader_Source␊ - responsible?: Reference335␊ - reason?: CodeableConcept402␊ - response?: MessageHeader_Response␊ - /**␊ - * The actual data of the message - a reference to the root/focus class of the event.␊ - */␊ - focus?: Reference11[]␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - definition?: string␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta92 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1260 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1261 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative90 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - export interface Coding28 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The identification of the code system that defines the meaning of the symbol in the code.␊ - */␊ - system?: string␊ - _system?: Element39␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element40␊ - /**␊ - * A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).␊ - */␊ - code?: string␊ - _code?: Element41␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element42␊ - /**␊ - * Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).␊ - */␊ - userSelected?: boolean␊ - _userSelected?: Element43␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1262 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.␊ - */␊ - export interface MessageHeader_Destination {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element1263␊ - target?: Reference330␊ - /**␊ - * Indicates where the message should be routed to.␊ - */␊ - endpoint?: string␊ - _endpoint?: Element1264␊ - receiver?: Reference331␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1263 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference330 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1264 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference331 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference332 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference333 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference334 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * The source application from which this message originated.␊ - */␊ - export interface MessageHeader_Source {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element1265␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - software?: string␊ - _software?: Element1266␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element1267␊ - contact?: ContactPoint2␊ - /**␊ - * Identifies the routing target to send acknowledgements to.␊ - */␊ - endpoint?: string␊ - _endpoint?: Element1268␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1265 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1266 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1267 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.␊ - */␊ - export interface ContactPoint2 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Telecommunications form for contact point - what communications system is required to make use of the contact.␊ - */␊ - system?: ("phone" | "fax" | "email" | "pager" | "url" | "sms" | "other")␊ - _system?: Element59␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element60␊ - /**␊ - * Identifies the purpose for the contact point.␊ - */␊ - use?: ("home" | "work" | "temp" | "old" | "mobile")␊ - _use?: Element61␊ - /**␊ - * Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.␊ - */␊ - rank?: number␊ - _rank?: Element62␊ - period?: Period2␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1268 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference335 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept402 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Information about the message that this message is a response to. Only present if this message is a response.␊ - */␊ - export interface MessageHeader_Response {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * The MessageHeader.id of the message to which this message is a response.␊ - */␊ - identifier?: string␊ - _identifier?: Element1269␊ - /**␊ - * Code that identifies the type of response to the message - whether it was successful or not, and whether it should be resent or not.␊ - */␊ - code?: ("ok" | "transient-error" | "fatal-error")␊ - _code?: Element1270␊ - details?: Reference336␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1269 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1270 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference336 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Raw data describing a biological sequence.␊ - */␊ - export interface MolecularSequence {␊ - /**␊ - * This is a MolecularSequence resource␊ - */␊ - resourceType: "MolecularSequence"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta93␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1271␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1272␊ - text?: Narrative91␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A unique identifier for this particular sequence instance. This is a FHIR-defined id.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * Amino Acid Sequence/ DNA Sequence / RNA Sequence.␊ - */␊ - type?: ("aa" | "dna" | "rna")␊ - _type?: Element1273␊ - /**␊ - * Whether the sequence is numbered starting at 0 (0-based numbering or coordinates, inclusive start, exclusive end) or starting at 1 (1-based numbering, inclusive start and inclusive end).␊ - */␊ - coordinateSystem?: number␊ - _coordinateSystem?: Element1274␊ - patient?: Reference337␊ - specimen?: Reference338␊ - device?: Reference339␊ - performer?: Reference340␊ - quantity?: Quantity68␊ - referenceSeq?: MolecularSequence_ReferenceSeq␊ - /**␊ - * The definition of variant here originates from Sequence ontology ([variant_of](http://www.sequenceontology.org/browser/current_svn/term/variant_of)). This element can represent amino acid or nucleic sequence change(including insertion,deletion,SNP,etc.) It can represent some complex mutation or segment variation with the assist of CIGAR string.␊ - */␊ - variant?: MolecularSequence_Variant[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - observedSeq?: string␊ - _observedSeq?: Element1286␊ - /**␊ - * An experimental feature attribute that defines the quality of the feature in a quantitative way, such as a phred quality score ([SO:0001686](http://www.sequenceontology.org/browser/current_svn/term/SO:0001686)).␊ - */␊ - quality?: MolecularSequence_Quality[]␊ - /**␊ - * A whole number␊ - */␊ - readCoverage?: number␊ - _readCoverage?: Element1298␊ - /**␊ - * Configurations of the external repository. The repository shall store target's observedSeq or records related with target's observedSeq.␊ - */␊ - repository?: MolecularSequence_Repository[]␊ - /**␊ - * Pointer to next atomic sequence which at most contains one variant.␊ - */␊ - pointer?: Reference11[]␊ - /**␊ - * Information about chromosome structure variation.␊ - */␊ - structureVariant?: MolecularSequence_StructureVariant[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta93 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1271 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1272 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative91 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1273 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1274 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference337 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference338 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference339 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference340 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity68 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * A sequence that is used as a reference to describe variants that are present in a sequence analyzed.␊ - */␊ - export interface MolecularSequence_ReferenceSeq {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - chromosome?: CodeableConcept403␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - genomeBuild?: string␊ - _genomeBuild?: Element1275␊ - /**␊ - * A relative reference to a DNA strand based on gene orientation. The strand that contains the open reading frame of the gene is the "sense" strand, and the opposite complementary strand is the "antisense" strand.␊ - */␊ - orientation?: ("sense" | "antisense")␊ - _orientation?: Element1276␊ - referenceSeqId?: CodeableConcept404␊ - referenceSeqPointer?: Reference341␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - referenceSeqString?: string␊ - _referenceSeqString?: Element1277␊ - /**␊ - * An absolute reference to a strand. The Watson strand is the strand whose 5'-end is on the short arm of the chromosome, and the Crick strand as the one whose 5'-end is on the long arm.␊ - */␊ - strand?: ("watson" | "crick")␊ - _strand?: Element1278␊ - /**␊ - * Start position of the window on the reference sequence. If the coordinate system is either 0-based or 1-based, then start position is inclusive.␊ - */␊ - windowStart?: number␊ - _windowStart?: Element1279␊ - /**␊ - * End position of the window on the reference sequence. If the coordinate system is 0-based then end is exclusive and does not include the last position. If the coordinate system is 1-base, then end is inclusive and includes the last position.␊ - */␊ - windowEnd?: number␊ - _windowEnd?: Element1280␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept403 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1275 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1276 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept404 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference341 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1277 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1278 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1279 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1280 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Raw data describing a biological sequence.␊ - */␊ - export interface MolecularSequence_Variant {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Start position of the variant on the reference sequence. If the coordinate system is either 0-based or 1-based, then start position is inclusive.␊ - */␊ - start?: number␊ - _start?: Element1281␊ - /**␊ - * End position of the variant on the reference sequence. If the coordinate system is 0-based then end is exclusive and does not include the last position. If the coordinate system is 1-base, then end is inclusive and includes the last position.␊ - */␊ - end?: number␊ - _end?: Element1282␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - observedAllele?: string␊ - _observedAllele?: Element1283␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - referenceAllele?: string␊ - _referenceAllele?: Element1284␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - cigar?: string␊ - _cigar?: Element1285␊ - variantPointer?: Reference342␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1281 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1282 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1283 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1284 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1285 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference342 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1286 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Raw data describing a biological sequence.␊ - */␊ - export interface MolecularSequence_Quality {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * INDEL / SNP / Undefined variant.␊ - */␊ - type?: ("indel" | "snp" | "unknown")␊ - _type?: Element1287␊ - standardSequence?: CodeableConcept405␊ - /**␊ - * Start position of the sequence. If the coordinate system is either 0-based or 1-based, then start position is inclusive.␊ - */␊ - start?: number␊ - _start?: Element1288␊ - /**␊ - * End position of the sequence. If the coordinate system is 0-based then end is exclusive and does not include the last position. If the coordinate system is 1-base, then end is inclusive and includes the last position.␊ - */␊ - end?: number␊ - _end?: Element1289␊ - score?: Quantity69␊ - method?: CodeableConcept406␊ - /**␊ - * True positives, from the perspective of the truth data, i.e. the number of sites in the Truth Call Set for which there are paths through the Query Call Set that are consistent with all of the alleles at this site, and for which there is an accurate genotype call for the event.␊ - */␊ - truthTP?: number␊ - _truthTP?: Element1290␊ - /**␊ - * True positives, from the perspective of the query data, i.e. the number of sites in the Query Call Set for which there are paths through the Truth Call Set that are consistent with all of the alleles at this site, and for which there is an accurate genotype call for the event.␊ - */␊ - queryTP?: number␊ - _queryTP?: Element1291␊ - /**␊ - * False negatives, i.e. the number of sites in the Truth Call Set for which there is no path through the Query Call Set that is consistent with all of the alleles at this site, or sites for which there is an inaccurate genotype call for the event. Sites with correct variant but incorrect genotype are counted here.␊ - */␊ - truthFN?: number␊ - _truthFN?: Element1292␊ - /**␊ - * False positives, i.e. the number of sites in the Query Call Set for which there is no path through the Truth Call Set that is consistent with this site. Sites with correct variant but incorrect genotype are counted here.␊ - */␊ - queryFP?: number␊ - _queryFP?: Element1293␊ - /**␊ - * The number of false positives where the non-REF alleles in the Truth and Query Call Sets match (i.e. cases where the truth is 1/1 and the query is 0/1 or similar).␊ - */␊ - gtFP?: number␊ - _gtFP?: Element1294␊ - /**␊ - * QUERY.TP / (QUERY.TP + QUERY.FP).␊ - */␊ - precision?: number␊ - _precision?: Element1295␊ - /**␊ - * TRUTH.TP / (TRUTH.TP + TRUTH.FN).␊ - */␊ - recall?: number␊ - _recall?: Element1296␊ - /**␊ - * Harmonic mean of Recall and Precision, computed as: 2 * precision * recall / (precision + recall).␊ - */␊ - fScore?: number␊ - _fScore?: Element1297␊ - roc?: MolecularSequence_Roc␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1287 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept405 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1288 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1289 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity69 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept406 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1290 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1291 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1292 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1293 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1294 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1295 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1296 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1297 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Receiver Operator Characteristic (ROC) Curve to give sensitivity/specificity tradeoff.␊ - */␊ - export interface MolecularSequence_Roc {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Invidual data point representing the GQ (genotype quality) score threshold.␊ - */␊ - score?: Integer[]␊ - /**␊ - * Extensions for score␊ - */␊ - _score?: Element23[]␊ - /**␊ - * The number of true positives if the GQ score threshold was set to "score" field value.␊ - */␊ - numTP?: Integer[]␊ - /**␊ - * Extensions for numTP␊ - */␊ - _numTP?: Element23[]␊ - /**␊ - * The number of false positives if the GQ score threshold was set to "score" field value.␊ - */␊ - numFP?: Integer[]␊ - /**␊ - * Extensions for numFP␊ - */␊ - _numFP?: Element23[]␊ - /**␊ - * The number of false negatives if the GQ score threshold was set to "score" field value.␊ - */␊ - numFN?: Integer[]␊ - /**␊ - * Extensions for numFN␊ - */␊ - _numFN?: Element23[]␊ - /**␊ - * Calculated precision if the GQ score threshold was set to "score" field value.␊ - */␊ - precision?: Decimal[]␊ - /**␊ - * Extensions for precision␊ - */␊ - _precision?: Element23[]␊ - /**␊ - * Calculated sensitivity if the GQ score threshold was set to "score" field value.␊ - */␊ - sensitivity?: Decimal[]␊ - /**␊ - * Extensions for sensitivity␊ - */␊ - _sensitivity?: Element23[]␊ - /**␊ - * Calculated fScore if the GQ score threshold was set to "score" field value.␊ - */␊ - fMeasure?: Decimal[]␊ - /**␊ - * Extensions for fMeasure␊ - */␊ - _fMeasure?: Element23[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1298 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Raw data describing a biological sequence.␊ - */␊ - export interface MolecularSequence_Repository {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Click and see / RESTful API / Need login to see / RESTful API with authentication / Other ways to see resource.␊ - */␊ - type?: ("directlink" | "openapi" | "login" | "oauth" | "other")␊ - _type?: Element1299␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - url?: string␊ - _url?: Element1300␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element1301␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - datasetId?: string␊ - _datasetId?: Element1302␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - variantsetId?: string␊ - _variantsetId?: Element1303␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - readsetId?: string␊ - _readsetId?: Element1304␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1299 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1300 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1301 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1302 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1303 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1304 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Raw data describing a biological sequence.␊ - */␊ - export interface MolecularSequence_StructureVariant {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - variantType?: CodeableConcept407␊ - /**␊ - * Used to indicate if the outer and inner start-end values have the same meaning.␊ - */␊ - exact?: boolean␊ - _exact?: Element1305␊ - /**␊ - * A whole number␊ - */␊ - length?: number␊ - _length?: Element1306␊ - outer?: MolecularSequence_Outer␊ - inner?: MolecularSequence_Inner␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept407 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1305 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1306 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Structural variant outer.␊ - */␊ - export interface MolecularSequence_Outer {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A whole number␊ - */␊ - start?: number␊ - _start?: Element1307␊ - /**␊ - * A whole number␊ - */␊ - end?: number␊ - _end?: Element1308␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1307 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1308 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Structural variant inner.␊ - */␊ - export interface MolecularSequence_Inner {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A whole number␊ - */␊ - start?: number␊ - _start?: Element1309␊ - /**␊ - * A whole number␊ - */␊ - end?: number␊ - _end?: Element1310␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1309 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1310 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A curated namespace that issues unique symbols within that namespace for the identification of concepts, people, devices, etc. Represents a "System" used within the Identifier and Coding data types.␊ - */␊ - export interface NamingSystem {␊ - /**␊ - * This is a NamingSystem resource␊ - */␊ - resourceType: "NamingSystem"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta94␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1311␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1312␊ - text?: Narrative92␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element1313␊ - /**␊ - * The status of this naming system. Enables tracking the life-cycle of the content.␊ - */␊ - status?: ("draft" | "active" | "retired" | "unknown")␊ - _status?: Element1314␊ - /**␊ - * Indicates the purpose for the naming system - what kinds of things does it make unique?␊ - */␊ - kind?: ("codesystem" | "identifier" | "root")␊ - _kind?: Element1315␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - date?: string␊ - _date?: Element1316␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - publisher?: string␊ - _publisher?: Element1317␊ - /**␊ - * Contact details to assist a user in finding and communicating with the publisher.␊ - */␊ - contact?: ContactDetail1[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - responsible?: string␊ - _responsible?: Element1318␊ - type?: CodeableConcept408␊ - /**␊ - * A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine␊ - */␊ - description?: string␊ - _description?: Element1319␊ - /**␊ - * The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate naming system instances.␊ - */␊ - useContext?: UsageContext1[]␊ - /**␊ - * A legal or geographic region in which the naming system is intended to be used.␊ - */␊ - jurisdiction?: CodeableConcept5[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - usage?: string␊ - _usage?: Element1320␊ - /**␊ - * Indicates how the system may be identified when referenced in electronic exchange.␊ - */␊ - uniqueId: NamingSystem_UniqueId[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta94 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1311 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1312 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative92 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1313 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1314 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1315 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1316 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1317 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1318 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept408 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1319 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1320 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A curated namespace that issues unique symbols within that namespace for the identification of concepts, people, devices, etc. Represents a "System" used within the Identifier and Coding data types.␊ - */␊ - export interface NamingSystem_UniqueId {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifies the unique identifier scheme used for this particular identifier.␊ - */␊ - type?: ("oid" | "uuid" | "uri" | "other")␊ - _type?: Element1321␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element1322␊ - /**␊ - * Indicates whether this identifier is the "preferred" identifier of this type.␊ - */␊ - preferred?: boolean␊ - _preferred?: Element1323␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - comment?: string␊ - _comment?: Element1324␊ - period?: Period86␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1321 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1322 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1323 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1324 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period86 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.␊ - */␊ - export interface NutritionOrder {␊ - /**␊ - * This is a NutritionOrder resource␊ - */␊ - resourceType: "NutritionOrder"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta95␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1325␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1326␊ - text?: Narrative93␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifiers assigned to this order by the order sender or by the order receiver.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder.␊ - */␊ - instantiatesCanonical?: Canonical[]␊ - /**␊ - * The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder.␊ - */␊ - instantiatesUri?: Uri[]␊ - /**␊ - * Extensions for instantiatesUri␊ - */␊ - _instantiatesUri?: Element23[]␊ - /**␊ - * The URL pointing to a protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder.␊ - */␊ - instantiates?: Uri[]␊ - /**␊ - * Extensions for instantiates␊ - */␊ - _instantiates?: Element23[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - status?: string␊ - _status?: Element1327␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - intent?: string␊ - _intent?: Element1328␊ - patient: Reference343␊ - encounter?: Reference344␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - dateTime?: string␊ - _dateTime?: Element1329␊ - orderer?: Reference345␊ - /**␊ - * A link to a record of allergies or intolerances which should be included in the nutrition order.␊ - */␊ - allergyIntolerance?: Reference11[]␊ - /**␊ - * This modifier is used to convey order-specific modifiers about the type of food that should be given. These can be derived from patient allergies, intolerances, or preferences such as Halal, Vegan or Kosher. This modifier applies to the entire nutrition order inclusive of the oral diet, nutritional supplements and enteral formula feedings.␊ - */␊ - foodPreferenceModifier?: CodeableConcept5[]␊ - /**␊ - * This modifier is used to convey Order-specific modifier about the type of oral food or oral fluids that should not be given. These can be derived from patient allergies, intolerances, or preferences such as No Red Meat, No Soy or No Wheat or Gluten-Free. While it should not be necessary to repeat allergy or intolerance information captured in the referenced AllergyIntolerance resource in the excludeFoodModifier, this element may be used to convey additional specificity related to foods that should be eliminated from the patient’s diet for any reason. This modifier applies to the entire nutrition order inclusive of the oral diet, nutritional supplements and enteral formula feedings.␊ - */␊ - excludeFoodModifier?: CodeableConcept5[]␊ - oralDiet?: NutritionOrder_OralDiet␊ - /**␊ - * Oral nutritional products given in order to add further nutritional value to the patient's diet.␊ - */␊ - supplement?: NutritionOrder_Supplement[]␊ - enteralFormula?: NutritionOrder_EnteralFormula␊ - /**␊ - * Comments made about the {{title}} by the requester, performer, subject or other participants.␊ - */␊ - note?: Annotation1[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta95 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1325 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1326 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative93 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1327 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1328 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference343 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference344 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1329 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference345 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Diet given orally in contrast to enteral (tube) feeding.␊ - */␊ - export interface NutritionOrder_OralDiet {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * The kind of diet or dietary restriction such as fiber restricted diet or diabetic diet.␊ - */␊ - type?: CodeableConcept5[]␊ - /**␊ - * The time period and frequency at which the diet should be given. The diet should be given for the combination of all schedules if more than one schedule is present.␊ - */␊ - schedule?: Timing11[]␊ - /**␊ - * Class that defines the quantity and type of nutrient modifications (for example carbohydrate, fiber or sodium) required for the oral diet.␊ - */␊ - nutrient?: NutritionOrder_Nutrient[]␊ - /**␊ - * Class that describes any texture modifications required for the patient to safely consume various types of solid foods.␊ - */␊ - texture?: NutritionOrder_Texture[]␊ - /**␊ - * The required consistency (e.g. honey-thick, nectar-thick, thin, thickened.) of liquids or fluids served to the patient.␊ - */␊ - fluidConsistencyType?: CodeableConcept5[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - instruction?: string␊ - _instruction?: Element1330␊ - }␊ - /**␊ - * Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.␊ - */␊ - export interface Timing11 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifies specific times when the event occurs.␊ - */␊ - event?: DateTime[]␊ - /**␊ - * Extensions for event␊ - */␊ - _event?: Element23[]␊ - repeat?: Timing_Repeat␊ - code?: CodeableConcept2␊ - }␊ - /**␊ - * A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.␊ - */␊ - export interface NutritionOrder_Nutrient {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - modifier?: CodeableConcept409␊ - amount?: Quantity70␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept409 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity70 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.␊ - */␊ - export interface NutritionOrder_Texture {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - modifier?: CodeableConcept410␊ - foodType?: CodeableConcept411␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept410 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept411 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1330 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.␊ - */␊ - export interface NutritionOrder_Supplement {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - type?: CodeableConcept412␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - productName?: string␊ - _productName?: Element1331␊ - /**␊ - * The time period and frequency at which the supplement(s) should be given. The supplement should be given for the combination of all schedules if more than one schedule is present.␊ - */␊ - schedule?: Timing11[]␊ - quantity?: Quantity71␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - instruction?: string␊ - _instruction?: Element1332␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept412 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1331 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity71 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1332 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Feeding provided through the gastrointestinal tract via a tube, catheter, or stoma that delivers nutrition distal to the oral cavity.␊ - */␊ - export interface NutritionOrder_EnteralFormula {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - baseFormulaType?: CodeableConcept413␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - baseFormulaProductName?: string␊ - _baseFormulaProductName?: Element1333␊ - additiveType?: CodeableConcept414␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - additiveProductName?: string␊ - _additiveProductName?: Element1334␊ - caloricDensity?: Quantity72␊ - routeofAdministration?: CodeableConcept415␊ - /**␊ - * Formula administration instructions as structured data. This repeating structure allows for changing the administration rate or volume over time for both bolus and continuous feeding. An example of this would be an instruction to increase the rate of continuous feeding every 2 hours.␊ - */␊ - administration?: NutritionOrder_Administration[]␊ - maxVolumeToDeliver?: Quantity75␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - administrationInstruction?: string␊ - _administrationInstruction?: Element1335␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept413 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1333 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept414 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1334 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity72 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept415 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.␊ - */␊ - export interface NutritionOrder_Administration {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - schedule?: Timing12␊ - quantity?: Quantity73␊ - rateQuantity?: Quantity74␊ - rateRatio?: Ratio15␊ - }␊ - /**␊ - * Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.␊ - */␊ - export interface Timing12 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifies specific times when the event occurs.␊ - */␊ - event?: DateTime[]␊ - /**␊ - * Extensions for event␊ - */␊ - _event?: Element23[]␊ - repeat?: Timing_Repeat␊ - code?: CodeableConcept2␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity73 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity74 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * The rate of administration of formula via a feeding pump, e.g. 60 mL per hour, according to the specified schedule.␊ - */␊ - export interface Ratio15 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - numerator?: Quantity3␊ - denominator?: Quantity4␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity75 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1335 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Measurements and simple assertions made about a patient, device or other subject.␊ - */␊ - export interface Observation {␊ - /**␊ - * This is a Observation resource␊ - */␊ - resourceType: "Observation"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta96␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1336␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1337␊ - text?: Narrative94␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A unique identifier assigned to this observation.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.␊ - */␊ - basedOn?: Reference11[]␊ - /**␊ - * A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.␊ - */␊ - partOf?: Reference11[]␊ - /**␊ - * The status of the result value.␊ - */␊ - status?: ("registered" | "preliminary" | "final" | "amended" | "corrected" | "cancelled" | "entered-in-error" | "unknown")␊ - _status?: Element1338␊ - /**␊ - * A code that classifies the general type of observation being made.␊ - */␊ - category?: CodeableConcept5[]␊ - code: CodeableConcept416␊ - subject?: Reference346␊ - /**␊ - * The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus.␊ - */␊ - focus?: Reference11[]␊ - encounter?: Reference347␊ - /**␊ - * The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.␊ - */␊ - effectiveDateTime?: string␊ - _effectiveDateTime?: Element1339␊ - effectivePeriod?: Period87␊ - effectiveTiming?: Timing13␊ - /**␊ - * The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.␊ - */␊ - effectiveInstant?: string␊ - _effectiveInstant?: Element1340␊ - /**␊ - * The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.␊ - */␊ - issued?: string␊ - _issued?: Element1341␊ - /**␊ - * Who was responsible for asserting the observed value as "true".␊ - */␊ - performer?: Reference11[]␊ - valueQuantity?: Quantity76␊ - valueCodeableConcept?: CodeableConcept417␊ - /**␊ - * The information determined as a result of making the observation, if the information has a simple value.␊ - */␊ - valueString?: string␊ - _valueString?: Element1342␊ - /**␊ - * The information determined as a result of making the observation, if the information has a simple value.␊ - */␊ - valueBoolean?: boolean␊ - _valueBoolean?: Element1343␊ - /**␊ - * The information determined as a result of making the observation, if the information has a simple value.␊ - */␊ - valueInteger?: number␊ - _valueInteger?: Element1344␊ - valueRange?: Range16␊ - valueRatio?: Ratio16␊ - valueSampledData?: SampledData1␊ - /**␊ - * The information determined as a result of making the observation, if the information has a simple value.␊ - */␊ - valueTime?: string␊ - _valueTime?: Element1345␊ - /**␊ - * The information determined as a result of making the observation, if the information has a simple value.␊ - */␊ - valueDateTime?: string␊ - _valueDateTime?: Element1346␊ - valuePeriod?: Period88␊ - dataAbsentReason?: CodeableConcept418␊ - /**␊ - * A categorical assessment of an observation value. For example, high, low, normal.␊ - */␊ - interpretation?: CodeableConcept5[]␊ - /**␊ - * Comments about the observation or the results.␊ - */␊ - note?: Annotation1[]␊ - bodySite?: CodeableConcept419␊ - method?: CodeableConcept420␊ - specimen?: Reference348␊ - device?: Reference349␊ - /**␊ - * Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two \`referenceRange\` elements would be used.␊ - */␊ - referenceRange?: Observation_ReferenceRange[]␊ - /**␊ - * This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group.␊ - */␊ - hasMember?: Reference11[]␊ - /**␊ - * The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.␊ - */␊ - derivedFrom?: Reference11[]␊ - /**␊ - * Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.␊ - */␊ - component?: Observation_Component[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta96 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1336 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1337 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative94 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1338 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept416 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference346 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference347 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1339 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period87 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.␊ - */␊ - export interface Timing13 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifies specific times when the event occurs.␊ - */␊ - event?: DateTime[]␊ - /**␊ - * Extensions for event␊ - */␊ - _event?: Element23[]␊ - repeat?: Timing_Repeat␊ - code?: CodeableConcept2␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1340 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1341 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity76 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept417 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1342 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1343 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1344 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The information determined as a result of making the observation, if the information has a simple value.␊ - */␊ - export interface Range16 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - low?: Quantity1␊ - high?: Quantity2␊ - }␊ - /**␊ - * The information determined as a result of making the observation, if the information has a simple value.␊ - */␊ - export interface Ratio16 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - numerator?: Quantity3␊ - denominator?: Quantity4␊ - }␊ - /**␊ - * The information determined as a result of making the observation, if the information has a simple value.␊ - */␊ - export interface SampledData1 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - origin: Quantity5␊ - /**␊ - * The length of time between sampling times, measured in milliseconds.␊ - */␊ - period?: number␊ - _period?: Element88␊ - /**␊ - * A correction factor that is applied to the sampled data points before they are added to the origin.␊ - */␊ - factor?: number␊ - _factor?: Element89␊ - /**␊ - * The lower limit of detection of the measured points. This is needed if any of the data points have the value "L" (lower than detection limit).␊ - */␊ - lowerLimit?: number␊ - _lowerLimit?: Element90␊ - /**␊ - * The upper limit of detection of the measured points. This is needed if any of the data points have the value "U" (higher than detection limit).␊ - */␊ - upperLimit?: number␊ - _upperLimit?: Element91␊ - /**␊ - * The number of sample points at each time point. If this value is greater than one, then the dimensions will be interlaced - all the sample points for a point in time will be recorded at once.␊ - */␊ - dimensions?: number␊ - _dimensions?: Element92␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - data?: string␊ - _data?: Element93␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1345 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1346 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period88 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept418 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept419 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept420 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference348 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference349 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Measurements and simple assertions made about a patient, device or other subject.␊ - */␊ - export interface Observation_ReferenceRange {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - low?: Quantity77␊ - high?: Quantity78␊ - type?: CodeableConcept421␊ - /**␊ - * Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple \`appliesTo\` are interpreted as an "AND" of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used.␊ - */␊ - appliesTo?: CodeableConcept5[]␊ - age?: Range17␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element1347␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity77 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity78 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept421 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.␊ - */␊ - export interface Range17 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - low?: Quantity1␊ - high?: Quantity2␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1347 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Measurements and simple assertions made about a patient, device or other subject.␊ - */␊ - export interface Observation_Component {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - code: CodeableConcept422␊ - valueQuantity?: Quantity79␊ - valueCodeableConcept?: CodeableConcept423␊ - /**␊ - * The information determined as a result of making the observation, if the information has a simple value.␊ - */␊ - valueString?: string␊ - _valueString?: Element1348␊ - /**␊ - * The information determined as a result of making the observation, if the information has a simple value.␊ - */␊ - valueBoolean?: boolean␊ - _valueBoolean?: Element1349␊ - /**␊ - * The information determined as a result of making the observation, if the information has a simple value.␊ - */␊ - valueInteger?: number␊ - _valueInteger?: Element1350␊ - valueRange?: Range18␊ - valueRatio?: Ratio17␊ - valueSampledData?: SampledData2␊ - /**␊ - * The information determined as a result of making the observation, if the information has a simple value.␊ - */␊ - valueTime?: string␊ - _valueTime?: Element1351␊ - /**␊ - * The information determined as a result of making the observation, if the information has a simple value.␊ - */␊ - valueDateTime?: string␊ - _valueDateTime?: Element1352␊ - valuePeriod?: Period89␊ - dataAbsentReason?: CodeableConcept424␊ - /**␊ - * A categorical assessment of an observation value. For example, high, low, normal.␊ - */␊ - interpretation?: CodeableConcept5[]␊ - /**␊ - * Guidance on how to interpret the value by comparison to a normal or recommended range.␊ - */␊ - referenceRange?: Observation_ReferenceRange[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept422 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity79 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept423 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1348 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1349 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1350 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The information determined as a result of making the observation, if the information has a simple value.␊ - */␊ - export interface Range18 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - low?: Quantity1␊ - high?: Quantity2␊ - }␊ - /**␊ - * The information determined as a result of making the observation, if the information has a simple value.␊ - */␊ - export interface Ratio17 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - numerator?: Quantity3␊ - denominator?: Quantity4␊ - }␊ - /**␊ - * The information determined as a result of making the observation, if the information has a simple value.␊ - */␊ - export interface SampledData2 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - origin: Quantity5␊ - /**␊ - * The length of time between sampling times, measured in milliseconds.␊ - */␊ - period?: number␊ - _period?: Element88␊ - /**␊ - * A correction factor that is applied to the sampled data points before they are added to the origin.␊ - */␊ - factor?: number␊ - _factor?: Element89␊ - /**␊ - * The lower limit of detection of the measured points. This is needed if any of the data points have the value "L" (lower than detection limit).␊ - */␊ - lowerLimit?: number␊ - _lowerLimit?: Element90␊ - /**␊ - * The upper limit of detection of the measured points. This is needed if any of the data points have the value "U" (higher than detection limit).␊ - */␊ - upperLimit?: number␊ - _upperLimit?: Element91␊ - /**␊ - * The number of sample points at each time point. If this value is greater than one, then the dimensions will be interlaced - all the sample points for a point in time will be recorded at once.␊ - */␊ - dimensions?: number␊ - _dimensions?: Element92␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - data?: string␊ - _data?: Element93␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1351 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1352 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period89 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept424 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Set of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service.␊ - */␊ - export interface ObservationDefinition {␊ - /**␊ - * This is a ObservationDefinition resource␊ - */␊ - resourceType: "ObservationDefinition"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta97␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1353␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1354␊ - text?: Narrative95␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A code that classifies the general type of observation.␊ - */␊ - category?: CodeableConcept5[]␊ - code: CodeableConcept425␊ - /**␊ - * A unique identifier assigned to this ObservationDefinition artifact.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * The data types allowed for the value element of the instance observations conforming to this ObservationDefinition.␊ - */␊ - permittedDataType?: ("Quantity" | "CodeableConcept" | "string" | "boolean" | "integer" | "Range" | "Ratio" | "SampledData" | "time" | "dateTime" | "Period")[]␊ - /**␊ - * Extensions for permittedDataType␊ - */␊ - _permittedDataType?: Element23[]␊ - /**␊ - * Multiple results allowed for observations conforming to this ObservationDefinition.␊ - */␊ - multipleResultsAllowed?: boolean␊ - _multipleResultsAllowed?: Element1355␊ - method?: CodeableConcept426␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - preferredReportName?: string␊ - _preferredReportName?: Element1356␊ - quantitativeDetails?: ObservationDefinition_QuantitativeDetails␊ - /**␊ - * Multiple ranges of results qualified by different contexts for ordinal or continuous observations conforming to this ObservationDefinition.␊ - */␊ - qualifiedInterval?: ObservationDefinition_QualifiedInterval[]␊ - validCodedValueSet?: Reference350␊ - normalCodedValueSet?: Reference351␊ - abnormalCodedValueSet?: Reference352␊ - criticalCodedValueSet?: Reference353␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta97 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1353 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1354 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative95 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept425 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1355 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept426 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1356 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Characteristics for quantitative results of this observation.␊ - */␊ - export interface ObservationDefinition_QuantitativeDetails {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - customaryUnit?: CodeableConcept427␊ - unit?: CodeableConcept428␊ - /**␊ - * A rational number with implicit precision␊ - */␊ - conversionFactor?: number␊ - _conversionFactor?: Element1357␊ - /**␊ - * A whole number␊ - */␊ - decimalPrecision?: number␊ - _decimalPrecision?: Element1358␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept427 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept428 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1357 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1358 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Set of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service.␊ - */␊ - export interface ObservationDefinition_QualifiedInterval {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * The category of interval of values for continuous or ordinal observations conforming to this ObservationDefinition.␊ - */␊ - category?: ("reference" | "critical" | "absolute")␊ - _category?: Element1359␊ - range?: Range19␊ - context?: CodeableConcept429␊ - /**␊ - * Codes to indicate the target population this reference range applies to.␊ - */␊ - appliesTo?: CodeableConcept5[]␊ - /**␊ - * Sex of the population the range applies to.␊ - */␊ - gender?: ("male" | "female" | "other" | "unknown")␊ - _gender?: Element1360␊ - age?: Range20␊ - gestationalAge?: Range21␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - condition?: string␊ - _condition?: Element1361␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1359 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The low and high values determining the interval. There may be only one of the two.␊ - */␊ - export interface Range19 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - low?: Quantity1␊ - high?: Quantity2␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept429 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1360 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.␊ - */␊ - export interface Range20 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - low?: Quantity1␊ - high?: Quantity2␊ - }␊ - /**␊ - * The gestational age to which this reference range is applicable, in the context of pregnancy.␊ - */␊ - export interface Range21 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - low?: Quantity1␊ - high?: Quantity2␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1361 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference350 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference351 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference352 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference353 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).␊ - */␊ - export interface OperationDefinition {␊ - /**␊ - * This is a OperationDefinition resource␊ - */␊ - resourceType: "OperationDefinition"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta98␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1362␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1363␊ - text?: Narrative96␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - url?: string␊ - _url?: Element1364␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element1365␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element1366␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element1367␊ - /**␊ - * The status of this operation definition. Enables tracking the life-cycle of the content.␊ - */␊ - status?: ("draft" | "active" | "retired" | "unknown")␊ - _status?: Element1368␊ - /**␊ - * Whether this is an operation or a named query.␊ - */␊ - kind?: ("operation" | "query")␊ - _kind?: Element1369␊ - /**␊ - * A Boolean value to indicate that this operation definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.␊ - */␊ - experimental?: boolean␊ - _experimental?: Element1370␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - date?: string␊ - _date?: Element1371␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - publisher?: string␊ - _publisher?: Element1372␊ - /**␊ - * Contact details to assist a user in finding and communicating with the publisher.␊ - */␊ - contact?: ContactDetail1[]␊ - /**␊ - * A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine␊ - */␊ - description?: string␊ - _description?: Element1373␊ - /**␊ - * The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate operation definition instances.␊ - */␊ - useContext?: UsageContext1[]␊ - /**␊ - * A legal or geographic region in which the operation definition is intended to be used.␊ - */␊ - jurisdiction?: CodeableConcept5[]␊ - /**␊ - * A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine␊ - */␊ - purpose?: string␊ - _purpose?: Element1374␊ - /**␊ - * Whether the operation affects state. Side effects such as producing audit trail entries do not count as 'affecting state'.␊ - */␊ - affectsState?: boolean␊ - _affectsState?: Element1375␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - code?: string␊ - _code?: Element1376␊ - /**␊ - * A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine␊ - */␊ - comment?: string␊ - _comment?: Element1377␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - base?: string␊ - /**␊ - * The types on which this operation can be executed.␊ - */␊ - resource?: Code[]␊ - /**␊ - * Extensions for resource␊ - */␊ - _resource?: Element23[]␊ - /**␊ - * Indicates whether this operation or named query can be invoked at the system level (e.g. without needing to choose a resource type for the context).␊ - */␊ - system?: boolean␊ - _system?: Element1378␊ - /**␊ - * Indicates whether this operation or named query can be invoked at the resource type level for any given resource type level (e.g. without needing to choose a specific resource id for the context).␊ - */␊ - type?: boolean␊ - _type?: Element1379␊ - /**␊ - * Indicates whether this operation can be invoked on a particular instance of one of the given types.␊ - */␊ - instance?: boolean␊ - _instance?: Element1380␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - inputProfile?: string␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - outputProfile?: string␊ - /**␊ - * The parameters for the operation/query.␊ - */␊ - parameter?: OperationDefinition_Parameter[]␊ - /**␊ - * Defines an appropriate combination of parameters to use when invoking this operation, to help code generators when generating overloaded parameter sets for this operation.␊ - */␊ - overload?: OperationDefinition_Overload[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta98 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1362 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1363 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative96 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1364 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1365 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1366 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1367 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1368 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1369 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1370 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1371 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1372 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1373 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1374 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1375 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1376 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1377 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1378 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1379 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1380 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).␊ - */␊ - export interface OperationDefinition_Parameter {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - name?: string␊ - _name?: Element1381␊ - /**␊ - * Whether this is an input or an output parameter.␊ - */␊ - use?: ("in" | "out")␊ - _use?: Element1382␊ - /**␊ - * A whole number␊ - */␊ - min?: number␊ - _min?: Element1383␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - max?: string␊ - _max?: Element1384␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - documentation?: string␊ - _documentation?: Element1385␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - type?: string␊ - _type?: Element1386␊ - /**␊ - * Used when the type is "Reference" or "canonical", and identifies a profile structure or implementation Guide that applies to the target of the reference this parameter refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the target resource SHALL conform to at least one profile defined in the implementation guide.␊ - */␊ - targetProfile?: Canonical[]␊ - /**␊ - * How the parameter is understood as a search parameter. This is only used if the parameter type is 'string'.␊ - */␊ - searchType?: ("number" | "date" | "string" | "token" | "reference" | "composite" | "quantity" | "uri" | "special")␊ - _searchType?: Element1387␊ - binding?: OperationDefinition_Binding␊ - /**␊ - * Identifies other resource parameters within the operation invocation that are expected to resolve to this resource.␊ - */␊ - referencedFrom?: OperationDefinition_ReferencedFrom[]␊ - /**␊ - * The parts of a nested Parameter.␊ - */␊ - part?: OperationDefinition_Parameter[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1381 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1382 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1383 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1384 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1385 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1386 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1387 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Binds to a value set if this parameter is coded (code, Coding, CodeableConcept).␊ - */␊ - export interface OperationDefinition_Binding {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Indicates the degree of conformance expectations associated with this binding - that is, the degree to which the provided value set must be adhered to in the instances.␊ - */␊ - strength?: ("required" | "extensible" | "preferred" | "example")␊ - _strength?: Element1388␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - valueSet: string␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1388 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).␊ - */␊ - export interface OperationDefinition_ReferencedFrom {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - source?: string␊ - _source?: Element1389␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - sourceId?: string␊ - _sourceId?: Element1390␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1389 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1390 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).␊ - */␊ - export interface OperationDefinition_Overload {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Name of parameter to include in overload.␊ - */␊ - parameterName?: String[]␊ - /**␊ - * Extensions for parameterName␊ - */␊ - _parameterName?: Element23[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - comment?: string␊ - _comment?: Element1391␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1391 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A collection of error, warning, or information messages that result from a system action.␊ - */␊ - export interface OperationOutcome {␊ - /**␊ - * This is a OperationOutcome resource␊ - */␊ - resourceType: "OperationOutcome"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta99␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1392␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1393␊ - text?: Narrative97␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * An error, warning, or information message that results from a system action.␊ - */␊ - issue: OperationOutcome_Issue[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta99 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1392 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1393 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative97 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * A collection of error, warning, or information messages that result from a system action.␊ - */␊ - export interface OperationOutcome_Issue {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Indicates whether the issue indicates a variation from successful processing.␊ - */␊ - severity?: ("fatal" | "error" | "warning" | "information")␊ - _severity?: Element1394␊ - /**␊ - * Describes the type of the issue. The system that creates an OperationOutcome SHALL choose the most applicable code from the IssueType value set, and may additional provide its own code for the error in the details element.␊ - */␊ - code?: ("invalid" | "structure" | "required" | "value" | "invariant" | "security" | "login" | "unknown" | "expired" | "forbidden" | "suppressed" | "processing" | "not-supported" | "duplicate" | "multiple-matches" | "not-found" | "deleted" | "too-long" | "code-invalid" | "extension" | "too-costly" | "business-rule" | "conflict" | "transient" | "lock-error" | "no-store" | "exception" | "timeout" | "incomplete" | "throttled" | "informational")␊ - _code?: Element1395␊ - details?: CodeableConcept430␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - diagnostics?: string␊ - _diagnostics?: Element1396␊ - /**␊ - * This element is deprecated because it is XML specific. It is replaced by issue.expression, which is format independent, and simpler to parse. ␊ - * ␊ - * For resource issues, this will be a simple XPath limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised. For HTTP errors, will be "http." + the parameter name.␊ - */␊ - location?: String[]␊ - /**␊ - * Extensions for location␊ - */␊ - _location?: Element23[]␊ - /**␊ - * A [simple subset of FHIRPath](fhirpath.html#simple) limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised.␊ - */␊ - expression?: String[]␊ - /**␊ - * Extensions for expression␊ - */␊ - _expression?: Element23[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1394 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1395 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept430 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1396 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.␊ - */␊ - export interface Organization {␊ - /**␊ - * This is a Organization resource␊ - */␊ - resourceType: "Organization"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta100␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1397␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1398␊ - text?: Narrative98␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifier for the organization that is used to identify the organization across multiple disparate systems.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * Whether the organization's record is still in active use.␊ - */␊ - active?: boolean␊ - _active?: Element1399␊ - /**␊ - * The kind(s) of organization that this is.␊ - */␊ - type?: CodeableConcept5[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element1400␊ - /**␊ - * A list of alternate names that the organization is known as, or was known as in the past.␊ - */␊ - alias?: String[]␊ - /**␊ - * Extensions for alias␊ - */␊ - _alias?: Element23[]␊ - /**␊ - * A contact detail for the organization.␊ - */␊ - telecom?: ContactPoint1[]␊ - /**␊ - * An address for the organization.␊ - */␊ - address?: Address9[]␊ - partOf?: Reference354␊ - /**␊ - * Contact for the organization for a certain purpose.␊ - */␊ - contact?: Organization_Contact[]␊ - /**␊ - * Technical endpoints providing access to services operated for the organization.␊ - */␊ - endpoint?: Reference11[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta100 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1397 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1398 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative98 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1399 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1400 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.␊ - */␊ - export interface Address9 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this address.␊ - */␊ - use?: ("home" | "work" | "temp" | "old" | "billing")␊ - _use?: Element20␊ - /**␊ - * Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.␊ - */␊ - type?: ("postal" | "physical" | "both")␊ - _type?: Element21␊ - /**␊ - * Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.␊ - */␊ - text?: string␊ - _text?: Element22␊ - /**␊ - * This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.␊ - */␊ - line?: String[]␊ - /**␊ - * Extensions for line␊ - */␊ - _line?: Element23[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - city?: string␊ - _city?: Element24␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - district?: string␊ - _district?: Element25␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - state?: string␊ - _state?: Element26␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - postalCode?: string␊ - _postalCode?: Element27␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - country?: string␊ - _country?: Element28␊ - period?: Period␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference354 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.␊ - */␊ - export interface Organization_Contact {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - purpose?: CodeableConcept431␊ - name?: HumanName2␊ - /**␊ - * A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.␊ - */␊ - telecom?: ContactPoint1[]␊ - address?: Address10␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept431 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A name associated with the contact.␊ - */␊ - export interface HumanName2 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Identifies the purpose for this name.␊ - */␊ - use?: ("usual" | "official" | "temp" | "nickname" | "anonymous" | "old" | "maiden")␊ - _use?: Element78␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element79␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - family?: string␊ - _family?: Element80␊ - /**␊ - * Given name.␊ - */␊ - given?: String[]␊ - /**␊ - * Extensions for given␊ - */␊ - _given?: Element23[]␊ - /**␊ - * Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.␊ - */␊ - prefix?: String[]␊ - /**␊ - * Extensions for prefix␊ - */␊ - _prefix?: Element23[]␊ - /**␊ - * Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.␊ - */␊ - suffix?: String[]␊ - /**␊ - * Extensions for suffix␊ - */␊ - _suffix?: Element23[]␊ - period?: Period3␊ - }␊ - /**␊ - * An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.␊ - */␊ - export interface Address10 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this address.␊ - */␊ - use?: ("home" | "work" | "temp" | "old" | "billing")␊ - _use?: Element20␊ - /**␊ - * Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.␊ - */␊ - type?: ("postal" | "physical" | "both")␊ - _type?: Element21␊ - /**␊ - * Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.␊ - */␊ - text?: string␊ - _text?: Element22␊ - /**␊ - * This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.␊ - */␊ - line?: String[]␊ - /**␊ - * Extensions for line␊ - */␊ - _line?: Element23[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - city?: string␊ - _city?: Element24␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - district?: string␊ - _district?: Element25␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - state?: string␊ - _state?: Element26␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - postalCode?: string␊ - _postalCode?: Element27␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - country?: string␊ - _country?: Element28␊ - period?: Period␊ - }␊ - /**␊ - * Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship.␊ - */␊ - export interface OrganizationAffiliation {␊ - /**␊ - * This is a OrganizationAffiliation resource␊ - */␊ - resourceType: "OrganizationAffiliation"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta101␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1401␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1402␊ - text?: Narrative99␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Business identifiers that are specific to this role.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * Whether this organization affiliation record is in active use.␊ - */␊ - active?: boolean␊ - _active?: Element1403␊ - period?: Period90␊ - organization?: Reference355␊ - participatingOrganization?: Reference356␊ - /**␊ - * Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined).␊ - */␊ - network?: Reference11[]␊ - /**␊ - * Definition of the role the participatingOrganization plays in the association.␊ - */␊ - code?: CodeableConcept5[]␊ - /**␊ - * Specific specialty of the participatingOrganization in the context of the role.␊ - */␊ - specialty?: CodeableConcept5[]␊ - /**␊ - * The location(s) at which the role occurs.␊ - */␊ - location?: Reference11[]␊ - /**␊ - * Healthcare services provided through the role.␊ - */␊ - healthcareService?: Reference11[]␊ - /**␊ - * Contact details at the participatingOrganization relevant to this Affiliation.␊ - */␊ - telecom?: ContactPoint1[]␊ - /**␊ - * Technical endpoints providing access to services operated for this role.␊ - */␊ - endpoint?: Reference11[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta101 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1401 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1402 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative99 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1403 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period90 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference355 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference356 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * This resource is a non-persisted resource used to pass information into and back from an [operation](operations.html). It has no other use, and there is no RESTful endpoint associated with it.␊ - */␊ - export interface Parameters {␊ - /**␊ - * This is a Parameters resource␊ - */␊ - resourceType: "Parameters"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta102␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1404␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1405␊ - /**␊ - * A parameter passed to or received from the operation.␊ - */␊ - parameter?: Parameters_Parameter[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta102 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1404 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1405 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * This resource is a non-persisted resource used to pass information into and back from an [operation](operations.html). It has no other use, and there is no RESTful endpoint associated with it.␊ - */␊ - export interface Parameters_Parameter {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element1406␊ - /**␊ - * If the parameter is a data type.␊ - */␊ - valueBase64Binary?: string␊ - _valueBase64Binary?: Element1407␊ - /**␊ - * If the parameter is a data type.␊ - */␊ - valueBoolean?: boolean␊ - _valueBoolean?: Element1408␊ - /**␊ - * If the parameter is a data type.␊ - */␊ - valueCanonical?: string␊ - _valueCanonical?: Element1409␊ - /**␊ - * If the parameter is a data type.␊ - */␊ - valueCode?: string␊ - _valueCode?: Element1410␊ - /**␊ - * If the parameter is a data type.␊ - */␊ - valueDate?: string␊ - _valueDate?: Element1411␊ - /**␊ - * If the parameter is a data type.␊ - */␊ - valueDateTime?: string␊ - _valueDateTime?: Element1412␊ - /**␊ - * If the parameter is a data type.␊ - */␊ - valueDecimal?: number␊ - _valueDecimal?: Element1413␊ - /**␊ - * If the parameter is a data type.␊ - */␊ - valueId?: string␊ - _valueId?: Element1414␊ - /**␊ - * If the parameter is a data type.␊ - */␊ - valueInstant?: string␊ - _valueInstant?: Element1415␊ - /**␊ - * If the parameter is a data type.␊ - */␊ - valueInteger?: number␊ - _valueInteger?: Element1416␊ - /**␊ - * If the parameter is a data type.␊ - */␊ - valueMarkdown?: string␊ - _valueMarkdown?: Element1417␊ - /**␊ - * If the parameter is a data type.␊ - */␊ - valueOid?: string␊ - _valueOid?: Element1418␊ - /**␊ - * If the parameter is a data type.␊ - */␊ - valuePositiveInt?: number␊ - _valuePositiveInt?: Element1419␊ - /**␊ - * If the parameter is a data type.␊ - */␊ - valueString?: string␊ - _valueString?: Element1420␊ - /**␊ - * If the parameter is a data type.␊ - */␊ - valueTime?: string␊ - _valueTime?: Element1421␊ - /**␊ - * If the parameter is a data type.␊ - */␊ - valueUnsignedInt?: number␊ - _valueUnsignedInt?: Element1422␊ - /**␊ - * If the parameter is a data type.␊ - */␊ - valueUri?: string␊ - _valueUri?: Element1423␊ - /**␊ - * If the parameter is a data type.␊ - */␊ - valueUrl?: string␊ - _valueUrl?: Element1424␊ - /**␊ - * If the parameter is a data type.␊ - */␊ - valueUuid?: string␊ - _valueUuid?: Element1425␊ - valueAddress?: Address11␊ - valueAge?: Age8␊ - valueAnnotation?: Annotation2␊ - valueAttachment?: Attachment18␊ - valueCodeableConcept?: CodeableConcept432␊ - valueCoding?: Coding29␊ - valueContactPoint?: ContactPoint3␊ - valueCount?: Count1␊ - valueDistance?: Distance1␊ - valueDuration?: Duration14␊ - valueHumanName?: HumanName3␊ - valueIdentifier?: Identifier30␊ - valueMoney?: Money49␊ - valuePeriod?: Period91␊ - valueQuantity?: Quantity80␊ - valueRange?: Range22␊ - valueRatio?: Ratio18␊ - valueReference?: Reference357␊ - valueSampledData?: SampledData3␊ - valueSignature?: Signature2␊ - valueTiming?: Timing14␊ - valueContactDetail?: ContactDetail2␊ - valueContributor?: Contributor1␊ - valueDataRequirement?: DataRequirement3␊ - valueExpression?: Expression8␊ - valueParameterDefinition?: ParameterDefinition2␊ - valueRelatedArtifact?: RelatedArtifact2␊ - valueTriggerDefinition?: TriggerDefinition3␊ - valueUsageContext?: UsageContext2␊ - valueDosage?: Dosage2␊ - valueMeta?: Meta103␊ - /**␊ - * If the parameter is a whole resource.␊ - */␊ - resource?: (Account | ActivityDefinition | AdverseEvent | AllergyIntolerance | Appointment | AppointmentResponse | AuditEvent | Basic | Binary | BiologicallyDerivedProduct | BodyStructure | Bundle | CapabilityStatement | CarePlan | CareTeam | CatalogEntry | ChargeItem | ChargeItemDefinition | Claim | ClaimResponse | ClinicalImpression | CodeSystem | Communication | CommunicationRequest | CompartmentDefinition | Composition | ConceptMap | Condition | Consent | Contract | Coverage | CoverageEligibilityRequest | CoverageEligibilityResponse | DetectedIssue | Device | DeviceDefinition | DeviceMetric | DeviceRequest | DeviceUseStatement | DiagnosticReport | DocumentManifest | DocumentReference | EffectEvidenceSynthesis | Encounter | Endpoint | EnrollmentRequest | EnrollmentResponse | EpisodeOfCare | EventDefinition | Evidence | EvidenceVariable | ExampleScenario | ExplanationOfBenefit | FamilyMemberHistory | Flag | Goal | GraphDefinition | Group | GuidanceResponse | HealthcareService | ImagingStudy | Immunization | ImmunizationEvaluation | ImmunizationRecommendation | ImplementationGuide | InsurancePlan | Invoice | Library | Linkage | List | Location | Measure | MeasureReport | Media | Medication | MedicationAdministration | MedicationDispense | MedicationKnowledge | MedicationRequest | MedicationStatement | MedicinalProduct | MedicinalProductAuthorization | MedicinalProductContraindication | MedicinalProductIndication | MedicinalProductIngredient | MedicinalProductInteraction | MedicinalProductManufactured | MedicinalProductPackaged | MedicinalProductPharmaceutical | MedicinalProductUndesirableEffect | MessageDefinition | MessageHeader | MolecularSequence | NamingSystem | NutritionOrder | Observation | ObservationDefinition | OperationDefinition | OperationOutcome | Organization | OrganizationAffiliation | Parameters | Patient | PaymentNotice | PaymentReconciliation | Person | PlanDefinition | Practitioner | PractitionerRole | Procedure | Provenance | Questionnaire | QuestionnaireResponse | RelatedPerson | RequestGroup | ResearchDefinition | ResearchElementDefinition | ResearchStudy | ResearchSubject | RiskAssessment | RiskEvidenceSynthesis | Schedule | SearchParameter | ServiceRequest | Slot | Specimen | SpecimenDefinition | StructureDefinition | StructureMap | Subscription | Substance | SubstanceNucleicAcid | SubstancePolymer | SubstanceProtein | SubstanceReferenceInformation | SubstanceSourceMaterial | SubstanceSpecification | SupplyDelivery | SupplyRequest | Task | TerminologyCapabilities | TestReport | TestScript | ValueSet | VerificationResult | VisionPrescription)␊ - /**␊ - * A named part of a multi-part parameter.␊ - */␊ - part?: Parameters_Parameter[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1406 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1407 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1408 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1409 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1410 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1411 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1412 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1413 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1414 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1415 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1416 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1417 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1418 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1419 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1420 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1421 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1422 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1423 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1424 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1425 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.␊ - */␊ - export interface Address11 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this address.␊ - */␊ - use?: ("home" | "work" | "temp" | "old" | "billing")␊ - _use?: Element20␊ - /**␊ - * Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.␊ - */␊ - type?: ("postal" | "physical" | "both")␊ - _type?: Element21␊ - /**␊ - * Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.␊ - */␊ - text?: string␊ - _text?: Element22␊ - /**␊ - * This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.␊ - */␊ - line?: String[]␊ - /**␊ - * Extensions for line␊ - */␊ - _line?: Element23[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - city?: string␊ - _city?: Element24␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - district?: string␊ - _district?: Element25␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - state?: string␊ - _state?: Element26␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - postalCode?: string␊ - _postalCode?: Element27␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - country?: string␊ - _country?: Element28␊ - period?: Period␊ - }␊ - /**␊ - * If the parameter is a data type.␊ - */␊ - export interface Age8 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element31␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element32␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element33␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element34␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element35␊ - }␊ - /**␊ - * A text note which also contains information about who made the statement and when.␊ - */␊ - export interface Annotation2 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - authorReference?: Reference␊ - /**␊ - * The individual responsible for making the annotation.␊ - */␊ - authorString?: string␊ - _authorString?: Element48␊ - /**␊ - * Indicates when this particular annotation was made.␊ - */␊ - time?: string␊ - _time?: Element49␊ - /**␊ - * The text of the annotation in markdown format.␊ - */␊ - text?: string␊ - _text?: Element50␊ - }␊ - /**␊ - * For referring to data content defined in other formats.␊ - */␊ - export interface Attachment18 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.␊ - */␊ - contentType?: string␊ - _contentType?: Element51␊ - /**␊ - * The human language of the content. The value can be any valid value according to BCP 47.␊ - */␊ - language?: string␊ - _language?: Element52␊ - /**␊ - * The actual data of the attachment - a sequence of bytes, base64 encoded.␊ - */␊ - data?: string␊ - _data?: Element53␊ - /**␊ - * A location where the data can be accessed.␊ - */␊ - url?: string␊ - _url?: Element54␊ - /**␊ - * The number of bytes of data that make up this attachment (before base64 encoding, if that is done).␊ - */␊ - size?: number␊ - _size?: Element55␊ - /**␊ - * The calculated hash of the data using SHA-1. Represented using base64.␊ - */␊ - hash?: string␊ - _hash?: Element56␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element57␊ - /**␊ - * The date that the attachment was first created.␊ - */␊ - creation?: string␊ - _creation?: Element58␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept432 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - export interface Coding29 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The identification of the code system that defines the meaning of the symbol in the code.␊ - */␊ - system?: string␊ - _system?: Element39␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element40␊ - /**␊ - * A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).␊ - */␊ - code?: string␊ - _code?: Element41␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element42␊ - /**␊ - * Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).␊ - */␊ - userSelected?: boolean␊ - _userSelected?: Element43␊ - }␊ - /**␊ - * Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.␊ - */␊ - export interface ContactPoint3 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Telecommunications form for contact point - what communications system is required to make use of the contact.␊ - */␊ - system?: ("phone" | "fax" | "email" | "pager" | "url" | "sms" | "other")␊ - _system?: Element59␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element60␊ - /**␊ - * Identifies the purpose for the contact point.␊ - */␊ - use?: ("home" | "work" | "temp" | "old" | "mobile")␊ - _use?: Element61␊ - /**␊ - * Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.␊ - */␊ - rank?: number␊ - _rank?: Element62␊ - period?: Period2␊ - }␊ - /**␊ - * If the parameter is a data type.␊ - */␊ - export interface Count1 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element63␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element64␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element65␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element66␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element67␊ - }␊ - /**␊ - * If the parameter is a data type.␊ - */␊ - export interface Distance1 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element68␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element69␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element70␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element71␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element72␊ - }␊ - /**␊ - * If the parameter is a data type.␊ - */␊ - export interface Duration14 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element73␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element74␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element75␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element76␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element77␊ - }␊ - /**␊ - * If the parameter is a data type.␊ - */␊ - export interface HumanName3 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Identifies the purpose for this name.␊ - */␊ - use?: ("usual" | "official" | "temp" | "nickname" | "anonymous" | "old" | "maiden")␊ - _use?: Element78␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element79␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - family?: string␊ - _family?: Element80␊ - /**␊ - * Given name.␊ - */␊ - given?: String[]␊ - /**␊ - * Extensions for given␊ - */␊ - _given?: Element23[]␊ - /**␊ - * Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.␊ - */␊ - prefix?: String[]␊ - /**␊ - * Extensions for prefix␊ - */␊ - _prefix?: Element23[]␊ - /**␊ - * Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.␊ - */␊ - suffix?: String[]␊ - /**␊ - * Extensions for suffix␊ - */␊ - _suffix?: Element23[]␊ - period?: Period3␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier30 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * If the parameter is a data type.␊ - */␊ - export interface Money49 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period91 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity80 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * If the parameter is a data type.␊ - */␊ - export interface Range22 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - low?: Quantity1␊ - high?: Quantity2␊ - }␊ - /**␊ - * If the parameter is a data type.␊ - */␊ - export interface Ratio18 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - numerator?: Quantity3␊ - denominator?: Quantity4␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference357 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * If the parameter is a data type.␊ - */␊ - export interface SampledData3 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - origin: Quantity5␊ - /**␊ - * The length of time between sampling times, measured in milliseconds.␊ - */␊ - period?: number␊ - _period?: Element88␊ - /**␊ - * A correction factor that is applied to the sampled data points before they are added to the origin.␊ - */␊ - factor?: number␊ - _factor?: Element89␊ - /**␊ - * The lower limit of detection of the measured points. This is needed if any of the data points have the value "L" (lower than detection limit).␊ - */␊ - lowerLimit?: number␊ - _lowerLimit?: Element90␊ - /**␊ - * The upper limit of detection of the measured points. This is needed if any of the data points have the value "U" (higher than detection limit).␊ - */␊ - upperLimit?: number␊ - _upperLimit?: Element91␊ - /**␊ - * The number of sample points at each time point. If this value is greater than one, then the dimensions will be interlaced - all the sample points for a point in time will be recorded at once.␊ - */␊ - dimensions?: number␊ - _dimensions?: Element92␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - data?: string␊ - _data?: Element93␊ - }␊ - /**␊ - * A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities.␊ - */␊ - export interface Signature2 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document.␊ - */␊ - type: Coding[]␊ - /**␊ - * When the digital signature was signed.␊ - */␊ - when?: string␊ - _when?: Element94␊ - who: Reference3␊ - onBehalfOf?: Reference4␊ - /**␊ - * A mime type that indicates the technical format of the target resources signed by the signature.␊ - */␊ - targetFormat?: string␊ - _targetFormat?: Element95␊ - /**␊ - * A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jose for JWS, and image/* for a graphical image of a signature, etc.␊ - */␊ - sigFormat?: string␊ - _sigFormat?: Element96␊ - /**␊ - * The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty.␊ - */␊ - data?: string␊ - _data?: Element97␊ - }␊ - /**␊ - * Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.␊ - */␊ - export interface Timing14 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifies specific times when the event occurs.␊ - */␊ - event?: DateTime[]␊ - /**␊ - * Extensions for event␊ - */␊ - _event?: Element23[]␊ - repeat?: Timing_Repeat␊ - code?: CodeableConcept2␊ - }␊ - /**␊ - * Specifies contact information for a person or organization.␊ - */␊ - export interface ContactDetail2 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element109␊ - /**␊ - * The contact details for the individual (if a name was provided) or the organization.␊ - */␊ - telecom?: ContactPoint1[]␊ - }␊ - /**␊ - * If the parameter is a data type.␊ - */␊ - export interface Contributor1 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The type of contributor.␊ - */␊ - type?: ("author" | "editor" | "reviewer" | "endorser")␊ - _type?: Element110␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element111␊ - /**␊ - * Contact details to assist a user in finding and communicating with the contributor.␊ - */␊ - contact?: ContactDetail1[]␊ - }␊ - /**␊ - * Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.␊ - */␊ - export interface DataRequirement3 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - type?: string␊ - _type?: Element112␊ - /**␊ - * The profile of the required data, specified as the uri of the profile definition.␊ - */␊ - profile?: Canonical[]␊ - subjectCodeableConcept?: CodeableConcept3␊ - subjectReference?: Reference5␊ - /**␊ - * Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. ␊ - * ␊ - * The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details).␊ - */␊ - mustSupport?: String[]␊ - /**␊ - * Extensions for mustSupport␊ - */␊ - _mustSupport?: Element23[]␊ - /**␊ - * Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.␊ - */␊ - codeFilter?: DataRequirement_CodeFilter[]␊ - /**␊ - * Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.␊ - */␊ - dateFilter?: DataRequirement_DateFilter[]␊ - /**␊ - * Specifies a maximum number of results that are required (uses the _count search parameter).␊ - */␊ - limit?: number␊ - _limit?: Element118␊ - /**␊ - * Specifies the order of the results to be returned.␊ - */␊ - sort?: DataRequirement_Sort[]␊ - }␊ - /**␊ - * If the parameter is a data type.␊ - */␊ - export interface Expression8 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element121␊ - /**␊ - * A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.␊ - */␊ - name?: string␊ - _name?: Element122␊ - /**␊ - * The media type of the language for the expression.␊ - */␊ - language?: ("text/cql" | "text/fhirpath" | "application/x-fhir-query")␊ - _language?: Element123␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - expression?: string␊ - _expression?: Element124␊ - /**␊ - * A URI that defines where the expression is found.␊ - */␊ - reference?: string␊ - _reference?: Element125␊ - }␊ - /**␊ - * The parameters to the module. This collection specifies both the input and output parameters. Input parameters are provided by the caller as part of the $evaluate operation. Output parameters are included in the GuidanceResponse.␊ - */␊ - export interface ParameterDefinition2 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - name?: string␊ - _name?: Element126␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - use?: string␊ - _use?: Element127␊ - /**␊ - * The minimum number of times this parameter SHALL appear in the request or response.␊ - */␊ - min?: number␊ - _min?: Element128␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - max?: string␊ - _max?: Element129␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - documentation?: string␊ - _documentation?: Element130␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - type?: string␊ - _type?: Element131␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - profile?: string␊ - }␊ - /**␊ - * Related artifacts such as additional documentation, justification, or bibliographic references.␊ - */␊ - export interface RelatedArtifact2 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The type of relationship to the related artifact.␊ - */␊ - type?: ("documentation" | "justification" | "citation" | "predecessor" | "successor" | "derived-from" | "depends-on" | "composed-of")␊ - _type?: Element132␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - label?: string␊ - _label?: Element133␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element134␊ - /**␊ - * A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.␊ - */␊ - citation?: string␊ - _citation?: Element135␊ - /**␊ - * A url for the artifact that can be followed to access the actual content.␊ - */␊ - url?: string␊ - _url?: Element136␊ - document?: Attachment1␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - resource?: string␊ - }␊ - /**␊ - * A description of a triggering event. Triggering events can be named events, data events, or periodic, as determined by the type element.␊ - */␊ - export interface TriggerDefinition3 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The type of triggering event.␊ - */␊ - type?: ("named-event" | "periodic" | "data-changed" | "data-added" | "data-modified" | "data-removed" | "data-accessed" | "data-access-ended")␊ - _type?: Element137␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element138␊ - timingTiming?: Timing1␊ - timingReference?: Reference6␊ - /**␊ - * The timing of the event (if this is a periodic trigger).␊ - */␊ - timingDate?: string␊ - _timingDate?: Element139␊ - /**␊ - * The timing of the event (if this is a periodic trigger).␊ - */␊ - timingDateTime?: string␊ - _timingDateTime?: Element140␊ - /**␊ - * The triggering data of the event (if this is a data trigger). If more than one data is requirement is specified, then all the data requirements must be true.␊ - */␊ - data?: DataRequirement1[]␊ - condition?: Expression1␊ - }␊ - /**␊ - * Specifies clinical/business/etc. metadata that can be used to retrieve, index and/or categorize an artifact. This metadata can either be specific to the applicable population (e.g., age category, DRG) or the specific context of care (e.g., venue, care setting, provider of care).␊ - */␊ - export interface UsageContext2 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - code: Coding2␊ - valueCodeableConcept?: CodeableConcept4␊ - valueQuantity?: Quantity6␊ - valueRange?: Range2␊ - valueReference?: Reference7␊ - }␊ - /**␊ - * Indicates how the medication is/was taken or should be taken by the patient.␊ - */␊ - export interface Dosage2 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Indicates the order in which the dosage instructions should be applied or interpreted.␊ - */␊ - sequence?: number␊ - _sequence?: Element141␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element142␊ - /**␊ - * Supplemental instructions to the patient on how to take the medication (e.g. "with meals" or"take half to one hour before food") or warnings for the patient about the medication (e.g. "may cause drowsiness" or "avoid exposure of skin to direct sunlight or sunlamps").␊ - */␊ - additionalInstruction?: CodeableConcept5[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - patientInstruction?: string␊ - _patientInstruction?: Element143␊ - timing?: Timing2␊ - /**␊ - * Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).␊ - */␊ - asNeededBoolean?: boolean␊ - _asNeededBoolean?: Element144␊ - asNeededCodeableConcept?: CodeableConcept6␊ - site?: CodeableConcept7␊ - route?: CodeableConcept8␊ - method?: CodeableConcept9␊ - /**␊ - * The amount of medication administered.␊ - */␊ - doseAndRate?: Dosage_DoseAndRate[]␊ - maxDosePerPeriod?: Ratio2␊ - maxDosePerAdministration?: Quantity9␊ - maxDosePerLifetime?: Quantity10␊ - }␊ - /**␊ - * If the parameter is a data type.␊ - */␊ - export interface Meta103 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Demographics and other administrative information about an individual or animal receiving care or other health-related services.␊ - */␊ - export interface Patient {␊ - /**␊ - * This is a Patient resource␊ - */␊ - resourceType: "Patient"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta104␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1426␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1427␊ - text?: Narrative100␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * An identifier for this patient.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * Whether this patient record is in active use. ␊ - * Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules.␊ - * ␊ - * It is often used to filter patient lists to exclude inactive patients␊ - * ␊ - * Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.␊ - */␊ - active?: boolean␊ - _active?: Element1428␊ - /**␊ - * A name associated with the individual.␊ - */␊ - name?: HumanName4[]␊ - /**␊ - * A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.␊ - */␊ - telecom?: ContactPoint1[]␊ - /**␊ - * Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.␊ - */␊ - gender?: ("male" | "female" | "other" | "unknown")␊ - _gender?: Element1429␊ - /**␊ - * The date of birth for the individual.␊ - */␊ - birthDate?: string␊ - _birthDate?: Element1430␊ - /**␊ - * Indicates if the individual is deceased or not.␊ - */␊ - deceasedBoolean?: boolean␊ - _deceasedBoolean?: Element1431␊ - /**␊ - * Indicates if the individual is deceased or not.␊ - */␊ - deceasedDateTime?: string␊ - _deceasedDateTime?: Element1432␊ - /**␊ - * An address for the individual.␊ - */␊ - address?: Address9[]␊ - maritalStatus?: CodeableConcept433␊ - /**␊ - * Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).␊ - */␊ - multipleBirthBoolean?: boolean␊ - _multipleBirthBoolean?: Element1433␊ - /**␊ - * Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).␊ - */␊ - multipleBirthInteger?: number␊ - _multipleBirthInteger?: Element1434␊ - /**␊ - * Image of the patient.␊ - */␊ - photo?: Attachment2[]␊ - /**␊ - * A contact party (e.g. guardian, partner, friend) for the patient.␊ - */␊ - contact?: Patient_Contact[]␊ - /**␊ - * A language which may be used to communicate with the patient about his or her health.␊ - */␊ - communication?: Patient_Communication[]␊ - /**␊ - * Patient's nominated care provider.␊ - */␊ - generalPractitioner?: Reference11[]␊ - managingOrganization?: Reference359␊ - /**␊ - * Link to another patient resource that concerns the same actual patient.␊ - */␊ - link?: Patient_Link[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta104 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1426 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1427 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative100 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1428 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human's name with the ability to identify parts and usage.␊ - */␊ - export interface HumanName4 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Identifies the purpose for this name.␊ - */␊ - use?: ("usual" | "official" | "temp" | "nickname" | "anonymous" | "old" | "maiden")␊ - _use?: Element78␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element79␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - family?: string␊ - _family?: Element80␊ - /**␊ - * Given name.␊ - */␊ - given?: String[]␊ - /**␊ - * Extensions for given␊ - */␊ - _given?: Element23[]␊ - /**␊ - * Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.␊ - */␊ - prefix?: String[]␊ - /**␊ - * Extensions for prefix␊ - */␊ - _prefix?: Element23[]␊ - /**␊ - * Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.␊ - */␊ - suffix?: String[]␊ - /**␊ - * Extensions for suffix␊ - */␊ - _suffix?: Element23[]␊ - period?: Period3␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1429 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1430 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1431 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1432 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept433 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1433 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1434 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Demographics and other administrative information about an individual or animal receiving care or other health-related services.␊ - */␊ - export interface Patient_Contact {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * The nature of the relationship between the patient and the contact person.␊ - */␊ - relationship?: CodeableConcept5[]␊ - name?: HumanName5␊ - /**␊ - * A contact detail for the person, e.g. a telephone number or an email address.␊ - */␊ - telecom?: ContactPoint1[]␊ - address?: Address12␊ - /**␊ - * Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.␊ - */␊ - gender?: ("male" | "female" | "other" | "unknown")␊ - _gender?: Element1435␊ - organization?: Reference358␊ - period?: Period92␊ - }␊ - /**␊ - * A human's name with the ability to identify parts and usage.␊ - */␊ - export interface HumanName5 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Identifies the purpose for this name.␊ - */␊ - use?: ("usual" | "official" | "temp" | "nickname" | "anonymous" | "old" | "maiden")␊ - _use?: Element78␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element79␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - family?: string␊ - _family?: Element80␊ - /**␊ - * Given name.␊ - */␊ - given?: String[]␊ - /**␊ - * Extensions for given␊ - */␊ - _given?: Element23[]␊ - /**␊ - * Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.␊ - */␊ - prefix?: String[]␊ - /**␊ - * Extensions for prefix␊ - */␊ - _prefix?: Element23[]␊ - /**␊ - * Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.␊ - */␊ - suffix?: String[]␊ - /**␊ - * Extensions for suffix␊ - */␊ - _suffix?: Element23[]␊ - period?: Period3␊ - }␊ - /**␊ - * An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.␊ - */␊ - export interface Address12 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this address.␊ - */␊ - use?: ("home" | "work" | "temp" | "old" | "billing")␊ - _use?: Element20␊ - /**␊ - * Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.␊ - */␊ - type?: ("postal" | "physical" | "both")␊ - _type?: Element21␊ - /**␊ - * Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.␊ - */␊ - text?: string␊ - _text?: Element22␊ - /**␊ - * This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.␊ - */␊ - line?: String[]␊ - /**␊ - * Extensions for line␊ - */␊ - _line?: Element23[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - city?: string␊ - _city?: Element24␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - district?: string␊ - _district?: Element25␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - state?: string␊ - _state?: Element26␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - postalCode?: string␊ - _postalCode?: Element27␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - country?: string␊ - _country?: Element28␊ - period?: Period␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1435 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference358 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period92 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Demographics and other administrative information about an individual or animal receiving care or other health-related services.␊ - */␊ - export interface Patient_Communication {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - language: CodeableConcept434␊ - /**␊ - * Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).␊ - */␊ - preferred?: boolean␊ - _preferred?: Element1436␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept434 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1436 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference359 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Demographics and other administrative information about an individual or animal receiving care or other health-related services.␊ - */␊ - export interface Patient_Link {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - other: Reference360␊ - /**␊ - * The type of link between this patient resource and another patient resource.␊ - */␊ - type?: ("replaced-by" | "replaces" | "refer" | "seealso")␊ - _type?: Element1437␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference360 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1437 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * This resource provides the status of the payment for goods and services rendered, and the request and response resource references.␊ - */␊ - export interface PaymentNotice {␊ - /**␊ - * This is a PaymentNotice resource␊ - */␊ - resourceType: "PaymentNotice"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta105␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1438␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1439␊ - text?: Narrative101␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A unique identifier assigned to this payment notice.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - status?: string␊ - _status?: Element1440␊ - request?: Reference361␊ - response?: Reference362␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - created?: string␊ - _created?: Element1441␊ - provider?: Reference363␊ - payment: Reference364␊ - /**␊ - * The date when the above payment action occurred.␊ - */␊ - paymentDate?: string␊ - _paymentDate?: Element1442␊ - payee?: Reference365␊ - recipient: Reference366␊ - amount: Money50␊ - paymentStatus?: CodeableConcept435␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta105 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1438 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1439 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative101 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1440 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference361 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference362 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1441 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference363 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference364 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1442 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference365 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference366 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * The amount sent to the payee.␊ - */␊ - export interface Money50 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept435 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * This resource provides the details including amount of a payment and allocates the payment items being paid.␊ - */␊ - export interface PaymentReconciliation {␊ - /**␊ - * This is a PaymentReconciliation resource␊ - */␊ - resourceType: "PaymentReconciliation"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta106␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1443␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1444␊ - text?: Narrative102␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A unique identifier assigned to this payment reconciliation.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - status?: string␊ - _status?: Element1445␊ - period?: Period93␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - created?: string␊ - _created?: Element1446␊ - paymentIssuer?: Reference367␊ - request?: Reference368␊ - requestor?: Reference369␊ - /**␊ - * The outcome of a request for a reconciliation.␊ - */␊ - outcome?: ("queued" | "complete" | "error" | "partial")␊ - _outcome?: Element1447␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - disposition?: string␊ - _disposition?: Element1448␊ - /**␊ - * The date of payment as indicated on the financial instrument.␊ - */␊ - paymentDate?: string␊ - _paymentDate?: Element1449␊ - paymentAmount: Money51␊ - paymentIdentifier?: Identifier31␊ - /**␊ - * Distribution of the payment amount for a previously acknowledged payable.␊ - */␊ - detail?: PaymentReconciliation_Detail[]␊ - formCode?: CodeableConcept437␊ - /**␊ - * A note that describes or explains the processing in a human readable form.␊ - */␊ - processNote?: PaymentReconciliation_ProcessNote[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta106 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1443 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1444 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative102 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1445 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period93 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1446 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference367 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference368 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference369 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1447 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1448 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1449 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Total payment amount as indicated on the financial instrument.␊ - */␊ - export interface Money51 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier31 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * This resource provides the details including amount of a payment and allocates the payment items being paid.␊ - */␊ - export interface PaymentReconciliation_Detail {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - identifier?: Identifier32␊ - predecessor?: Identifier33␊ - type: CodeableConcept436␊ - request?: Reference370␊ - submitter?: Reference371␊ - response?: Reference372␊ - /**␊ - * The date from the response resource containing a commitment to pay.␊ - */␊ - date?: string␊ - _date?: Element1450␊ - responsible?: Reference373␊ - payee?: Reference374␊ - amount?: Money52␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier32 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier33 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept436 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference370 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference371 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference372 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1450 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference373 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference374 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * The monetary amount allocated from the total payment to the payable.␊ - */␊ - export interface Money52 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept437 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * This resource provides the details including amount of a payment and allocates the payment items being paid.␊ - */␊ - export interface PaymentReconciliation_ProcessNote {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * The business purpose of the note text.␊ - */␊ - type?: ("display" | "print" | "printoper")␊ - _type?: Element1451␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element1452␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1451 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1452 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Demographics and administrative information about a person independent of a specific health-related context.␊ - */␊ - export interface Person {␊ - /**␊ - * This is a Person resource␊ - */␊ - resourceType: "Person"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta107␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1453␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1454␊ - text?: Narrative103␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifier for a person within a particular scope.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * A name associated with the person.␊ - */␊ - name?: HumanName4[]␊ - /**␊ - * A contact detail for the person, e.g. a telephone number or an email address.␊ - */␊ - telecom?: ContactPoint1[]␊ - /**␊ - * Administrative Gender.␊ - */␊ - gender?: ("male" | "female" | "other" | "unknown")␊ - _gender?: Element1455␊ - /**␊ - * The birth date for the person.␊ - */␊ - birthDate?: string␊ - _birthDate?: Element1456␊ - /**␊ - * One or more addresses for the person.␊ - */␊ - address?: Address9[]␊ - photo?: Attachment19␊ - managingOrganization?: Reference375␊ - /**␊ - * Whether this person's record is in active use.␊ - */␊ - active?: boolean␊ - _active?: Element1457␊ - /**␊ - * Link to a resource that concerns the same actual person.␊ - */␊ - link?: Person_Link[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta107 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1453 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1454 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative103 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1455 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1456 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * For referring to data content defined in other formats.␊ - */␊ - export interface Attachment19 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.␊ - */␊ - contentType?: string␊ - _contentType?: Element51␊ - /**␊ - * The human language of the content. The value can be any valid value according to BCP 47.␊ - */␊ - language?: string␊ - _language?: Element52␊ - /**␊ - * The actual data of the attachment - a sequence of bytes, base64 encoded.␊ - */␊ - data?: string␊ - _data?: Element53␊ - /**␊ - * A location where the data can be accessed.␊ - */␊ - url?: string␊ - _url?: Element54␊ - /**␊ - * The number of bytes of data that make up this attachment (before base64 encoding, if that is done).␊ - */␊ - size?: number␊ - _size?: Element55␊ - /**␊ - * The calculated hash of the data using SHA-1. Represented using base64.␊ - */␊ - hash?: string␊ - _hash?: Element56␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element57␊ - /**␊ - * The date that the attachment was first created.␊ - */␊ - creation?: string␊ - _creation?: Element58␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference375 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1457 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Demographics and administrative information about a person independent of a specific health-related context.␊ - */␊ - export interface Person_Link {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - target: Reference376␊ - /**␊ - * Level of assurance that this link is associated with the target resource.␊ - */␊ - assurance?: ("level1" | "level2" | "level3" | "level4")␊ - _assurance?: Element1458␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference376 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1458 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.␊ - */␊ - export interface PlanDefinition {␊ - /**␊ - * This is a PlanDefinition resource␊ - */␊ - resourceType: "PlanDefinition"␊ - /**␊ - * The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.␊ - */␊ - id?: string␊ - meta?: Meta108␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1459␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1460␊ - text?: Narrative104␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - url?: string␊ - _url?: Element1461␊ - /**␊ - * A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element1462␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element1463␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element1464␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - subtitle?: string␊ - _subtitle?: Element1465␊ - type?: CodeableConcept438␊ - /**␊ - * The status of this plan definition. Enables tracking the life-cycle of the content.␊ - */␊ - status?: ("draft" | "active" | "retired" | "unknown")␊ - _status?: Element1466␊ - /**␊ - * A Boolean value to indicate that this plan definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.␊ - */␊ - experimental?: boolean␊ - _experimental?: Element1467␊ - subjectCodeableConcept?: CodeableConcept439␊ - subjectReference?: Reference377␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - date?: string␊ - _date?: Element1468␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - publisher?: string␊ - _publisher?: Element1469␊ - /**␊ - * Contact details to assist a user in finding and communicating with the publisher.␊ - */␊ - contact?: ContactDetail1[]␊ - /**␊ - * A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine␊ - */␊ - description?: string␊ - _description?: Element1470␊ - /**␊ - * The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate plan definition instances.␊ - */␊ - useContext?: UsageContext1[]␊ - /**␊ - * A legal or geographic region in which the plan definition is intended to be used.␊ - */␊ - jurisdiction?: CodeableConcept5[]␊ - /**␊ - * A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine␊ - */␊ - purpose?: string␊ - _purpose?: Element1471␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - usage?: string␊ - _usage?: Element1472␊ - /**␊ - * A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine␊ - */␊ - copyright?: string␊ - _copyright?: Element1473␊ - /**␊ - * The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.␊ - */␊ - approvalDate?: string␊ - _approvalDate?: Element1474␊ - /**␊ - * The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.␊ - */␊ - lastReviewDate?: string␊ - _lastReviewDate?: Element1475␊ - effectivePeriod?: Period94␊ - /**␊ - * Descriptive topics related to the content of the plan definition. Topics provide a high-level categorization of the definition that can be useful for filtering and searching.␊ - */␊ - topic?: CodeableConcept5[]␊ - /**␊ - * An individiual or organization primarily involved in the creation and maintenance of the content.␊ - */␊ - author?: ContactDetail1[]␊ - /**␊ - * An individual or organization primarily responsible for internal coherence of the content.␊ - */␊ - editor?: ContactDetail1[]␊ - /**␊ - * An individual or organization primarily responsible for review of some aspect of the content.␊ - */␊ - reviewer?: ContactDetail1[]␊ - /**␊ - * An individual or organization responsible for officially endorsing the content for use in some setting.␊ - */␊ - endorser?: ContactDetail1[]␊ - /**␊ - * Related artifacts such as additional documentation, justification, or bibliographic references.␊ - */␊ - relatedArtifact?: RelatedArtifact1[]␊ - /**␊ - * A reference to a Library resource containing any formal logic used by the plan definition.␊ - */␊ - library?: Canonical[]␊ - /**␊ - * Goals that describe what the activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.␊ - */␊ - goal?: PlanDefinition_Goal[]␊ - /**␊ - * An action or group of actions to be taken as part of the plan.␊ - */␊ - action?: PlanDefinition_Action[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta108 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1459 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1460 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative104 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1461 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1462 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1463 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1464 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1465 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept438 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1466 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1467 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept439 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference377 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1468 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1469 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1470 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1471 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1472 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1473 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1474 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1475 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period94 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.␊ - */␊ - export interface PlanDefinition_Goal {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - category?: CodeableConcept440␊ - description: CodeableConcept441␊ - priority?: CodeableConcept442␊ - start?: CodeableConcept443␊ - /**␊ - * Identifies problems, conditions, issues, or concerns the goal is intended to address.␊ - */␊ - addresses?: CodeableConcept5[]␊ - /**␊ - * Didactic or other informational resources associated with the goal that provide further supporting information about the goal. Information resources can include inline text commentary and links to web resources.␊ - */␊ - documentation?: RelatedArtifact1[]␊ - /**␊ - * Indicates what should be done and within what timeframe.␊ - */␊ - target?: PlanDefinition_Target[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept440 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept441 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept442 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept443 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.␊ - */␊ - export interface PlanDefinition_Target {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - measure?: CodeableConcept444␊ - detailQuantity?: Quantity81␊ - detailRange?: Range23␊ - detailCodeableConcept?: CodeableConcept445␊ - due?: Duration15␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept444 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity81 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.␊ - */␊ - export interface Range23 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - low?: Quantity1␊ - high?: Quantity2␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept445 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Indicates the timeframe after the start of the goal in which the goal should be met.␊ - */␊ - export interface Duration15 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element73␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element74␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element75␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element76␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element77␊ - }␊ - /**␊ - * This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.␊ - */␊ - export interface PlanDefinition_Action {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - prefix?: string␊ - _prefix?: Element1476␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element1477␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element1478␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - textEquivalent?: string␊ - _textEquivalent?: Element1479␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - priority?: string␊ - _priority?: Element1480␊ - /**␊ - * A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.␊ - */␊ - code?: CodeableConcept5[]␊ - /**␊ - * A description of why this action is necessary or appropriate.␊ - */␊ - reason?: CodeableConcept5[]␊ - /**␊ - * Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.␊ - */␊ - documentation?: RelatedArtifact1[]␊ - /**␊ - * Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition.␊ - */␊ - goalId?: Id[]␊ - /**␊ - * Extensions for goalId␊ - */␊ - _goalId?: Element23[]␊ - subjectCodeableConcept?: CodeableConcept446␊ - subjectReference?: Reference378␊ - /**␊ - * A description of when the action should be triggered.␊ - */␊ - trigger?: TriggerDefinition1[]␊ - /**␊ - * An expression that describes applicability criteria or start/stop conditions for the action.␊ - */␊ - condition?: PlanDefinition_Condition[]␊ - /**␊ - * Defines input data requirements for the action.␊ - */␊ - input?: DataRequirement1[]␊ - /**␊ - * Defines the outputs of the action, if any.␊ - */␊ - output?: DataRequirement1[]␊ - /**␊ - * A relationship to another action such as "before" or "30-60 minutes after start of".␊ - */␊ - relatedAction?: PlanDefinition_RelatedAction[]␊ - /**␊ - * An optional value describing when the action should be performed.␊ - */␊ - timingDateTime?: string␊ - _timingDateTime?: Element1484␊ - timingAge?: Age9␊ - timingPeriod?: Period95␊ - timingDuration?: Duration17␊ - timingRange?: Range25␊ - timingTiming?: Timing15␊ - /**␊ - * Indicates who should participate in performing the action described.␊ - */␊ - participant?: PlanDefinition_Participant[]␊ - type?: CodeableConcept448␊ - /**␊ - * Defines the grouping behavior for the action and its children.␊ - */␊ - groupingBehavior?: ("visual-group" | "logical-group" | "sentence-group")␊ - _groupingBehavior?: Element1486␊ - /**␊ - * Defines the selection behavior for the action and its children.␊ - */␊ - selectionBehavior?: ("any" | "all" | "all-or-none" | "exactly-one" | "at-most-one" | "one-or-more")␊ - _selectionBehavior?: Element1487␊ - /**␊ - * Defines the required behavior for the action.␊ - */␊ - requiredBehavior?: ("must" | "could" | "must-unless-documented")␊ - _requiredBehavior?: Element1488␊ - /**␊ - * Defines whether the action should usually be preselected.␊ - */␊ - precheckBehavior?: ("yes" | "no")␊ - _precheckBehavior?: Element1489␊ - /**␊ - * Defines whether the action can be selected multiple times.␊ - */␊ - cardinalityBehavior?: ("single" | "multiple")␊ - _cardinalityBehavior?: Element1490␊ - /**␊ - * A reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be taken.␊ - */␊ - definitionCanonical?: string␊ - _definitionCanonical?: Element1491␊ - /**␊ - * A reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be taken.␊ - */␊ - definitionUri?: string␊ - _definitionUri?: Element1492␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - transform?: string␊ - /**␊ - * Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient's weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the result.␊ - */␊ - dynamicValue?: PlanDefinition_DynamicValue[]␊ - /**␊ - * Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition.␊ - */␊ - action?: PlanDefinition_Action[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1476 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1477 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1478 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1479 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1480 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept446 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference378 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.␊ - */␊ - export interface PlanDefinition_Condition {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * The kind of condition.␊ - */␊ - kind?: ("applicability" | "start" | "stop")␊ - _kind?: Element1481␊ - expression?: Expression9␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1481 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * An expression that returns true or false, indicating whether the condition is satisfied.␊ - */␊ - export interface Expression9 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element121␊ - /**␊ - * A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.␊ - */␊ - name?: string␊ - _name?: Element122␊ - /**␊ - * The media type of the language for the expression.␊ - */␊ - language?: ("text/cql" | "text/fhirpath" | "application/x-fhir-query")␊ - _language?: Element123␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - expression?: string␊ - _expression?: Element124␊ - /**␊ - * A URI that defines where the expression is found.␊ - */␊ - reference?: string␊ - _reference?: Element125␊ - }␊ - /**␊ - * This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.␊ - */␊ - export interface PlanDefinition_RelatedAction {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - actionId?: string␊ - _actionId?: Element1482␊ - /**␊ - * The relationship of this action to the related action.␊ - */␊ - relationship?: ("before-start" | "before" | "before-end" | "concurrent-with-start" | "concurrent" | "concurrent-with-end" | "after-start" | "after" | "after-end")␊ - _relationship?: Element1483␊ - offsetDuration?: Duration16␊ - offsetRange?: Range24␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1482 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1483 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.␊ - */␊ - export interface Duration16 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element73␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element74␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element75␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element76␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element77␊ - }␊ - /**␊ - * A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.␊ - */␊ - export interface Range24 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - low?: Quantity1␊ - high?: Quantity2␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1484 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * An optional value describing when the action should be performed.␊ - */␊ - export interface Age9 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element31␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element32␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element33␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element34␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element35␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period95 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * An optional value describing when the action should be performed.␊ - */␊ - export interface Duration17 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element73␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element74␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element75␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element76␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element77␊ - }␊ - /**␊ - * An optional value describing when the action should be performed.␊ - */␊ - export interface Range25 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - low?: Quantity1␊ - high?: Quantity2␊ - }␊ - /**␊ - * Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.␊ - */␊ - export interface Timing15 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifies specific times when the event occurs.␊ - */␊ - event?: DateTime[]␊ - /**␊ - * Extensions for event␊ - */␊ - _event?: Element23[]␊ - repeat?: Timing_Repeat␊ - code?: CodeableConcept2␊ - }␊ - /**␊ - * This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.␊ - */␊ - export interface PlanDefinition_Participant {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * The type of participant in the action.␊ - */␊ - type?: ("patient" | "practitioner" | "related-person" | "device")␊ - _type?: Element1485␊ - role?: CodeableConcept447␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1485 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept447 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept448 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1486 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1487 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1488 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1489 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1490 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1491 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1492 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.␊ - */␊ - export interface PlanDefinition_DynamicValue {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - path?: string␊ - _path?: Element1493␊ - expression?: Expression10␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1493 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * An expression specifying the value of the customized element.␊ - */␊ - export interface Expression10 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element121␊ - /**␊ - * A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.␊ - */␊ - name?: string␊ - _name?: Element122␊ - /**␊ - * The media type of the language for the expression.␊ - */␊ - language?: ("text/cql" | "text/fhirpath" | "application/x-fhir-query")␊ - _language?: Element123␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - expression?: string␊ - _expression?: Element124␊ - /**␊ - * A URI that defines where the expression is found.␊ - */␊ - reference?: string␊ - _reference?: Element125␊ - }␊ - /**␊ - * A person who is directly or indirectly involved in the provisioning of healthcare.␊ - */␊ - export interface Practitioner {␊ - /**␊ - * This is a Practitioner resource␊ - */␊ - resourceType: "Practitioner"␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - id?: string␊ - meta?: Meta109␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1494␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1495␊ - text?: Narrative105␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * An identifier that applies to this person in this role.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * Whether this practitioner's record is in active use.␊ - */␊ - active?: boolean␊ - _active?: Element1496␊ - /**␊ - * The name(s) associated with the practitioner.␊ - */␊ - name?: HumanName4[]␊ - /**␊ - * A contact detail for the practitioner, e.g. a telephone number or an email address.␊ - */␊ - telecom?: ContactPoint1[]␊ - /**␊ - * Address(es) of the practitioner that are not role specific (typically home address). ␍ - Work addresses are not typically entered in this property as they are usually role dependent.␊ - */␊ - address?: Address9[]␊ - /**␊ - * Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.␊ - */␊ - gender?: ("male" | "female" | "other" | "unknown")␊ - _gender?: Element1497␊ - /**␊ - * The date of birth for the practitioner.␊ - */␊ - birthDate?: string␊ - _birthDate?: Element1498␊ - /**␊ - * Image of the person.␊ - */␊ - photo?: Attachment2[]␊ - /**␊ - * The official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality.␊ - */␊ - qualification?: Practitioner_Qualification[]␊ - /**␊ - * A language the practitioner can use in patient communication.␊ - */␊ - communication?: CodeableConcept5[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta109 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1494 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1495 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative105 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1496 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1497 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1498 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A person who is directly or indirectly involved in the provisioning of healthcare.␊ - */␊ - export interface Practitioner_Qualification {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * An identifier that applies to this person's qualification in this role.␊ - */␊ - identifier?: Identifier2[]␊ - code: CodeableConcept449␊ - period?: Period96␊ - issuer?: Reference379␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept449 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period96 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference379 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.␊ - */␊ - export interface PractitionerRole {␊ - /**␊ - * This is a PractitionerRole resource␊ - */␊ - resourceType: "PractitionerRole"␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - id?: string␊ - meta?: Meta110␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1499␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1500␊ - text?: Narrative106␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Business Identifiers that are specific to a role/location.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * Whether this practitioner role record is in active use.␊ - */␊ - active?: boolean␊ - _active?: Element1501␊ - period?: Period97␊ - practitioner?: Reference380␊ - organization?: Reference381␊ - /**␊ - * Roles which this practitioner is authorized to perform for the organization.␊ - */␊ - code?: CodeableConcept5[]␊ - /**␊ - * Specific specialty of the practitioner.␊ - */␊ - specialty?: CodeableConcept5[]␊ - /**␊ - * The location(s) at which this practitioner provides care.␊ - */␊ - location?: Reference11[]␊ - /**␊ - * The list of healthcare services that this worker provides for this role's Organization/Location(s).␊ - */␊ - healthcareService?: Reference11[]␊ - /**␊ - * Contact details that are specific to the role/location/service.␊ - */␊ - telecom?: ContactPoint1[]␊ - /**␊ - * A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.␊ - */␊ - availableTime?: PractitionerRole_AvailableTime[]␊ - /**␊ - * The practitioner is not available or performing this role during this period of time due to the provided reason.␊ - */␊ - notAvailable?: PractitionerRole_NotAvailable[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - availabilityExceptions?: string␊ - _availabilityExceptions?: Element1506␊ - /**␊ - * Technical endpoints providing access to services operated for the practitioner with this role.␊ - */␊ - endpoint?: Reference11[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta110 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1499 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1500 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative106 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1501 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period97 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference380 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference381 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.␊ - */␊ - export interface PractitionerRole_AvailableTime {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Indicates which days of the week are available between the start and end Times.␊ - */␊ - daysOfWeek?: Code[]␊ - /**␊ - * Extensions for daysOfWeek␊ - */␊ - _daysOfWeek?: Element23[]␊ - /**␊ - * Is this always available? (hence times are irrelevant) e.g. 24 hour service.␊ - */␊ - allDay?: boolean␊ - _allDay?: Element1502␊ - /**␊ - * A time during the day, with no date specified␊ - */␊ - availableStartTime?: string␊ - _availableStartTime?: Element1503␊ - /**␊ - * A time during the day, with no date specified␊ - */␊ - availableEndTime?: string␊ - _availableEndTime?: Element1504␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1502 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1503 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1504 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.␊ - */␊ - export interface PractitionerRole_NotAvailable {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element1505␊ - during?: Period98␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1505 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period98 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1506 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * An action that is or was performed on or for a patient. This can be a physical intervention like an operation, or less invasive like long term services, counseling, or hypnotherapy.␊ - */␊ - export interface Procedure {␊ - /**␊ - * This is a Procedure resource␊ - */␊ - resourceType: "Procedure"␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - id?: string␊ - meta?: Meta111␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1507␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1508␊ - text?: Narrative107␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Business identifiers assigned to this procedure by the performer or other systems which remain constant as the resource is updated and is propagated from server to server.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * The URL pointing to a FHIR-defined protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.␊ - */␊ - instantiatesCanonical?: Canonical[]␊ - /**␊ - * The URL pointing to an externally maintained protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.␊ - */␊ - instantiatesUri?: Uri[]␊ - /**␊ - * Extensions for instantiatesUri␊ - */␊ - _instantiatesUri?: Element23[]␊ - /**␊ - * A reference to a resource that contains details of the request for this procedure.␊ - */␊ - basedOn?: Reference11[]␊ - /**␊ - * A larger event of which this particular procedure is a component or step.␊ - */␊ - partOf?: Reference11[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - status?: string␊ - _status?: Element1509␊ - statusReason?: CodeableConcept450␊ - category?: CodeableConcept451␊ - code?: CodeableConcept452␊ - subject: Reference382␊ - encounter?: Reference383␊ - /**␊ - * Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.␊ - */␊ - performedDateTime?: string␊ - _performedDateTime?: Element1510␊ - performedPeriod?: Period99␊ - /**␊ - * Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.␊ - */␊ - performedString?: string␊ - _performedString?: Element1511␊ - performedAge?: Age10␊ - performedRange?: Range26␊ - recorder?: Reference384␊ - asserter?: Reference385␊ - /**␊ - * Limited to "real" people rather than equipment.␊ - */␊ - performer?: Procedure_Performer[]␊ - location?: Reference388␊ - /**␊ - * The coded reason why the procedure was performed. This may be a coded entity of some type, or may simply be present as text.␊ - */␊ - reasonCode?: CodeableConcept5[]␊ - /**␊ - * The justification of why the procedure was performed.␊ - */␊ - reasonReference?: Reference11[]␊ - /**␊ - * Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion.␊ - */␊ - bodySite?: CodeableConcept5[]␊ - outcome?: CodeableConcept454␊ - /**␊ - * This could be a histology result, pathology report, surgical report, etc.␊ - */␊ - report?: Reference11[]␊ - /**␊ - * Any complications that occurred during the procedure, or in the immediate post-performance period. These are generally tracked separately from the notes, which will typically describe the procedure itself rather than any 'post procedure' issues.␊ - */␊ - complication?: CodeableConcept5[]␊ - /**␊ - * Any complications that occurred during the procedure, or in the immediate post-performance period.␊ - */␊ - complicationDetail?: Reference11[]␊ - /**␊ - * If the procedure required specific follow up - e.g. removal of sutures. The follow up may be represented as a simple note or could potentially be more complex, in which case the CarePlan resource can be used.␊ - */␊ - followUp?: CodeableConcept5[]␊ - /**␊ - * Any other notes and comments about the procedure.␊ - */␊ - note?: Annotation1[]␊ - /**␊ - * A device that is implanted, removed or otherwise manipulated (calibration, battery replacement, fitting a prosthesis, attaching a wound-vac, etc.) as a focal portion of the Procedure.␊ - */␊ - focalDevice?: Procedure_FocalDevice[]␊ - /**␊ - * Identifies medications, devices and any other substance used as part of the procedure.␊ - */␊ - usedReference?: Reference11[]␊ - /**␊ - * Identifies coded items that were used as part of the procedure.␊ - */␊ - usedCode?: CodeableConcept5[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta111 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1507 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1508 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative107 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1509 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept450 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept451 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept452 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference382 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference383 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1510 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period99 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1511 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.␊ - */␊ - export interface Age10 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element31␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element32␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element33␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element34␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element35␊ - }␊ - /**␊ - * Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.␊ - */␊ - export interface Range26 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - low?: Quantity1␊ - high?: Quantity2␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference384 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference385 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * An action that is or was performed on or for a patient. This can be a physical intervention like an operation, or less invasive like long term services, counseling, or hypnotherapy.␊ - */␊ - export interface Procedure_Performer {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - function?: CodeableConcept453␊ - actor: Reference386␊ - onBehalfOf?: Reference387␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept453 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference386 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference387 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference388 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept454 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * An action that is or was performed on or for a patient. This can be a physical intervention like an operation, or less invasive like long term services, counseling, or hypnotherapy.␊ - */␊ - export interface Procedure_FocalDevice {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - action?: CodeableConcept455␊ - manipulated: Reference389␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept455 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference389 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. Provenance assertions are a form of contextual metadata and can themselves become important records with their own provenance. Provenance statement indicates clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity, and stage in lifecycle (e.g. Document Completion - has the artifact been legally authenticated), all of which may impact security, privacy, and trust policies.␊ - */␊ - export interface Provenance {␊ - /**␊ - * This is a Provenance resource␊ - */␊ - resourceType: "Provenance"␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - id?: string␊ - meta?: Meta112␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1512␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1513␊ - text?: Narrative108␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * The Reference(s) that were generated or updated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by the same activity.␊ - */␊ - target: Reference11[]␊ - occurredPeriod?: Period100␊ - /**␊ - * The period during which the activity occurred.␊ - */␊ - occurredDateTime?: string␊ - _occurredDateTime?: Element1514␊ - /**␊ - * The instant of time at which the activity was recorded.␊ - */␊ - recorded?: string␊ - _recorded?: Element1515␊ - /**␊ - * Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc.␊ - */␊ - policy?: Uri[]␊ - /**␊ - * Extensions for policy␊ - */␊ - _policy?: Element23[]␊ - location?: Reference390␊ - /**␊ - * The reason that the activity was taking place.␊ - */␊ - reason?: CodeableConcept5[]␊ - activity?: CodeableConcept456␊ - /**␊ - * An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.␊ - */␊ - agent: Provenance_Agent[]␊ - /**␊ - * An entity used in this activity.␊ - */␊ - entity?: Provenance_Entity[]␊ - /**␊ - * A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated.␊ - */␊ - signature?: Signature1[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta112 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1512 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1513 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative108 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period100 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1514 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1515 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference390 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept456 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. Provenance assertions are a form of contextual metadata and can themselves become important records with their own provenance. Provenance statement indicates clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity, and stage in lifecycle (e.g. Document Completion - has the artifact been legally authenticated), all of which may impact security, privacy, and trust policies.␊ - */␊ - export interface Provenance_Agent {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - type?: CodeableConcept457␊ - /**␊ - * The function of the agent with respect to the activity. The security role enabling the agent with respect to the activity.␊ - */␊ - role?: CodeableConcept5[]␊ - who: Reference391␊ - onBehalfOf?: Reference392␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept457 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference391 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference392 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. Provenance assertions are a form of contextual metadata and can themselves become important records with their own provenance. Provenance statement indicates clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity, and stage in lifecycle (e.g. Document Completion - has the artifact been legally authenticated), all of which may impact security, privacy, and trust policies.␊ - */␊ - export interface Provenance_Entity {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * How the entity was used during the activity.␊ - */␊ - role?: ("derivation" | "revision" | "quotation" | "source" | "removal")␊ - _role?: Element1516␊ - what: Reference393␊ - /**␊ - * The entity is attributed to an agent to express the agent's responsibility for that entity, possibly along with other agents. This description can be understood as shorthand for saying that the agent was responsible for the activity which generated the entity.␊ - */␊ - agent?: Provenance_Agent[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1516 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference393 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.␊ - */␊ - export interface Questionnaire {␊ - /**␊ - * This is a Questionnaire resource␊ - */␊ - resourceType: "Questionnaire"␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - id?: string␊ - meta?: Meta113␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1517␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1518␊ - text?: Narrative109␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - url?: string␊ - _url?: Element1519␊ - /**␊ - * A formal identifier that is used to identify this questionnaire when it is represented in other formats, or referenced in a specification, model, design or an instance.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element1520␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element1521␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element1522␊ - /**␊ - * The URL of a Questionnaire that this Questionnaire is based on.␊ - */␊ - derivedFrom?: Canonical[]␊ - /**␊ - * The status of this questionnaire. Enables tracking the life-cycle of the content.␊ - */␊ - status?: ("draft" | "active" | "retired" | "unknown")␊ - _status?: Element1523␊ - /**␊ - * A Boolean value to indicate that this questionnaire is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.␊ - */␊ - experimental?: boolean␊ - _experimental?: Element1524␊ - /**␊ - * The types of subjects that can be the subject of responses created for the questionnaire.␊ - */␊ - subjectType?: Code[]␊ - /**␊ - * Extensions for subjectType␊ - */␊ - _subjectType?: Element23[]␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - date?: string␊ - _date?: Element1525␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - publisher?: string␊ - _publisher?: Element1526␊ - /**␊ - * Contact details to assist a user in finding and communicating with the publisher.␊ - */␊ - contact?: ContactDetail1[]␊ - /**␊ - * A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine␊ - */␊ - description?: string␊ - _description?: Element1527␊ - /**␊ - * The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate questionnaire instances.␊ - */␊ - useContext?: UsageContext1[]␊ - /**␊ - * A legal or geographic region in which the questionnaire is intended to be used.␊ - */␊ - jurisdiction?: CodeableConcept5[]␊ - /**␊ - * A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine␊ - */␊ - purpose?: string␊ - _purpose?: Element1528␊ - /**␊ - * A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine␊ - */␊ - copyright?: string␊ - _copyright?: Element1529␊ - /**␊ - * The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.␊ - */␊ - approvalDate?: string␊ - _approvalDate?: Element1530␊ - /**␊ - * The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.␊ - */␊ - lastReviewDate?: string␊ - _lastReviewDate?: Element1531␊ - effectivePeriod?: Period101␊ - /**␊ - * An identifier for this question or group of questions in a particular terminology such as LOINC.␊ - */␊ - code?: Coding[]␊ - /**␊ - * A particular question, question grouping or display text that is part of the questionnaire.␊ - */␊ - item?: Questionnaire_Item[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta113 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1517 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1518 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative109 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1519 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1520 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1521 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1522 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1523 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1524 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1525 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1526 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1527 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1528 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1529 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1530 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1531 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period101 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * A structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.␊ - */␊ - export interface Questionnaire_Item {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - linkId?: string␊ - _linkId?: Element1532␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - definition?: string␊ - _definition?: Element1533␊ - /**␊ - * A terminology code that corresponds to this group or question (e.g. a code from LOINC, which defines many questions and answers).␊ - */␊ - code?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - prefix?: string␊ - _prefix?: Element1534␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element1535␊ - /**␊ - * The type of questionnaire item this is - whether text for display, a grouping of other items or a particular type of data to be captured (string, integer, coded choice, etc.).␊ - */␊ - type?: ("group" | "display" | "boolean" | "decimal" | "integer" | "date" | "dateTime" | "time" | "string" | "text" | "url" | "choice" | "open-choice" | "attachment" | "reference" | "quantity")␊ - _type?: Element1536␊ - /**␊ - * A constraint indicating that this item should only be enabled (displayed/allow answers to be captured) when the specified condition is true.␊ - */␊ - enableWhen?: Questionnaire_EnableWhen[]␊ - /**␊ - * Controls how multiple enableWhen values are interpreted - whether all or any must be true.␊ - */␊ - enableBehavior?: ("all" | "any")␊ - _enableBehavior?: Element1546␊ - /**␊ - * An indication, if true, that the item must be present in a "completed" QuestionnaireResponse. If false, the item may be skipped when answering the questionnaire.␊ - */␊ - required?: boolean␊ - _required?: Element1547␊ - /**␊ - * An indication, if true, that the item may occur multiple times in the response, collecting multiple answers for questions or multiple sets of answers for groups.␊ - */␊ - repeats?: boolean␊ - _repeats?: Element1548␊ - /**␊ - * An indication, when true, that the value cannot be changed by a human respondent to the Questionnaire.␊ - */␊ - readOnly?: boolean␊ - _readOnly?: Element1549␊ - /**␊ - * A whole number␊ - */␊ - maxLength?: number␊ - _maxLength?: Element1550␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - answerValueSet?: string␊ - /**␊ - * One of the permitted answers for a "choice" or "open-choice" question.␊ - */␊ - answerOption?: Questionnaire_AnswerOption[]␊ - /**␊ - * One or more values that should be pre-populated in the answer when initially rendering the questionnaire for user input.␊ - */␊ - initial?: Questionnaire_Initial[]␊ - /**␊ - * Text, questions and other groups to be nested beneath a question or group.␊ - */␊ - item?: Questionnaire_Item[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1532 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1533 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1534 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1535 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1536 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.␊ - */␊ - export interface Questionnaire_EnableWhen {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - question?: string␊ - _question?: Element1537␊ - /**␊ - * Specifies the criteria by which the question is enabled.␊ - */␊ - operator?: ("exists" | "=" | "!=" | ">" | "<" | ">=" | "<=")␊ - _operator?: Element1538␊ - /**␊ - * A value that the referenced question is tested using the specified operator in order for the item to be enabled.␊ - */␊ - answerBoolean?: boolean␊ - _answerBoolean?: Element1539␊ - /**␊ - * A value that the referenced question is tested using the specified operator in order for the item to be enabled.␊ - */␊ - answerDecimal?: number␊ - _answerDecimal?: Element1540␊ - /**␊ - * A value that the referenced question is tested using the specified operator in order for the item to be enabled.␊ - */␊ - answerInteger?: number␊ - _answerInteger?: Element1541␊ - /**␊ - * A value that the referenced question is tested using the specified operator in order for the item to be enabled.␊ - */␊ - answerDate?: string␊ - _answerDate?: Element1542␊ - /**␊ - * A value that the referenced question is tested using the specified operator in order for the item to be enabled.␊ - */␊ - answerDateTime?: string␊ - _answerDateTime?: Element1543␊ - /**␊ - * A value that the referenced question is tested using the specified operator in order for the item to be enabled.␊ - */␊ - answerTime?: string␊ - _answerTime?: Element1544␊ - /**␊ - * A value that the referenced question is tested using the specified operator in order for the item to be enabled.␊ - */␊ - answerString?: string␊ - _answerString?: Element1545␊ - answerCoding?: Coding30␊ - answerQuantity?: Quantity82␊ - answerReference?: Reference394␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1537 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1538 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1539 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1540 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1541 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1542 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1543 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1544 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1545 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - export interface Coding30 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The identification of the code system that defines the meaning of the symbol in the code.␊ - */␊ - system?: string␊ - _system?: Element39␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element40␊ - /**␊ - * A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).␊ - */␊ - code?: string␊ - _code?: Element41␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element42␊ - /**␊ - * Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).␊ - */␊ - userSelected?: boolean␊ - _userSelected?: Element43␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity82 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference394 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1546 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1547 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1548 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1549 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1550 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.␊ - */␊ - export interface Questionnaire_AnswerOption {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A potential answer that's allowed as the answer to this question.␊ - */␊ - valueInteger?: number␊ - _valueInteger?: Element1551␊ - /**␊ - * A potential answer that's allowed as the answer to this question.␊ - */␊ - valueDate?: string␊ - _valueDate?: Element1552␊ - /**␊ - * A potential answer that's allowed as the answer to this question.␊ - */␊ - valueTime?: string␊ - _valueTime?: Element1553␊ - /**␊ - * A potential answer that's allowed as the answer to this question.␊ - */␊ - valueString?: string␊ - _valueString?: Element1554␊ - valueCoding?: Coding31␊ - valueReference?: Reference395␊ - /**␊ - * Indicates whether the answer value is selected when the list of possible answers is initially shown.␊ - */␊ - initialSelected?: boolean␊ - _initialSelected?: Element1555␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1551 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1552 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1553 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1554 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - export interface Coding31 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The identification of the code system that defines the meaning of the symbol in the code.␊ - */␊ - system?: string␊ - _system?: Element39␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element40␊ - /**␊ - * A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).␊ - */␊ - code?: string␊ - _code?: Element41␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element42␊ - /**␊ - * Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).␊ - */␊ - userSelected?: boolean␊ - _userSelected?: Element43␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference395 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1555 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.␊ - */␊ - export interface Questionnaire_Initial {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * The actual value to for an initial answer.␊ - */␊ - valueBoolean?: boolean␊ - _valueBoolean?: Element1556␊ - /**␊ - * The actual value to for an initial answer.␊ - */␊ - valueDecimal?: number␊ - _valueDecimal?: Element1557␊ - /**␊ - * The actual value to for an initial answer.␊ - */␊ - valueInteger?: number␊ - _valueInteger?: Element1558␊ - /**␊ - * The actual value to for an initial answer.␊ - */␊ - valueDate?: string␊ - _valueDate?: Element1559␊ - /**␊ - * The actual value to for an initial answer.␊ - */␊ - valueDateTime?: string␊ - _valueDateTime?: Element1560␊ - /**␊ - * The actual value to for an initial answer.␊ - */␊ - valueTime?: string␊ - _valueTime?: Element1561␊ - /**␊ - * The actual value to for an initial answer.␊ - */␊ - valueString?: string␊ - _valueString?: Element1562␊ - /**␊ - * The actual value to for an initial answer.␊ - */␊ - valueUri?: string␊ - _valueUri?: Element1563␊ - valueAttachment?: Attachment20␊ - valueCoding?: Coding32␊ - valueQuantity?: Quantity83␊ - valueReference?: Reference396␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1556 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1557 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1558 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1559 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1560 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1561 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1562 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1563 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * For referring to data content defined in other formats.␊ - */␊ - export interface Attachment20 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.␊ - */␊ - contentType?: string␊ - _contentType?: Element51␊ - /**␊ - * The human language of the content. The value can be any valid value according to BCP 47.␊ - */␊ - language?: string␊ - _language?: Element52␊ - /**␊ - * The actual data of the attachment - a sequence of bytes, base64 encoded.␊ - */␊ - data?: string␊ - _data?: Element53␊ - /**␊ - * A location where the data can be accessed.␊ - */␊ - url?: string␊ - _url?: Element54␊ - /**␊ - * The number of bytes of data that make up this attachment (before base64 encoding, if that is done).␊ - */␊ - size?: number␊ - _size?: Element55␊ - /**␊ - * The calculated hash of the data using SHA-1. Represented using base64.␊ - */␊ - hash?: string␊ - _hash?: Element56␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element57␊ - /**␊ - * The date that the attachment was first created.␊ - */␊ - creation?: string␊ - _creation?: Element58␊ - }␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - export interface Coding32 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The identification of the code system that defines the meaning of the symbol in the code.␊ - */␊ - system?: string␊ - _system?: Element39␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element40␊ - /**␊ - * A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).␊ - */␊ - code?: string␊ - _code?: Element41␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element42␊ - /**␊ - * Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).␊ - */␊ - userSelected?: boolean␊ - _userSelected?: Element43␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity83 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference396 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A structured set of questions and their answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the questionnaire being responded to.␊ - */␊ - export interface QuestionnaireResponse {␊ - /**␊ - * This is a QuestionnaireResponse resource␊ - */␊ - resourceType: "QuestionnaireResponse"␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - id?: string␊ - meta?: Meta114␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1564␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1565␊ - text?: Narrative110␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - identifier?: Identifier34␊ - /**␊ - * The order, proposal or plan that is fulfilled in whole or in part by this QuestionnaireResponse. For example, a ServiceRequest seeking an intake assessment or a decision support recommendation to assess for post-partum depression.␊ - */␊ - basedOn?: Reference11[]␊ - /**␊ - * A procedure or observation that this questionnaire was performed as part of the execution of. For example, the surgery a checklist was executed as part of.␊ - */␊ - partOf?: Reference11[]␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - questionnaire?: string␊ - /**␊ - * The position of the questionnaire response within its overall lifecycle.␊ - */␊ - status?: ("in-progress" | "completed" | "amended" | "entered-in-error" | "stopped")␊ - _status?: Element1566␊ - subject?: Reference397␊ - encounter?: Reference398␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - authored?: string␊ - _authored?: Element1567␊ - author?: Reference399␊ - source?: Reference400␊ - /**␊ - * A group or question item from the original questionnaire for which answers are provided.␊ - */␊ - item?: QuestionnaireResponse_Item[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta114 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1564 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1565 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative110 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier34 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1566 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference397 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference398 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1567 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference399 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference400 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A structured set of questions and their answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the questionnaire being responded to.␊ - */␊ - export interface QuestionnaireResponse_Item {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - linkId?: string␊ - _linkId?: Element1568␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - definition?: string␊ - _definition?: Element1569␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element1570␊ - /**␊ - * The respondent's answer(s) to the question.␊ - */␊ - answer?: QuestionnaireResponse_Answer[]␊ - /**␊ - * Questions or sub-groups nested beneath a question or group.␊ - */␊ - item?: QuestionnaireResponse_Item[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1568 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1569 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1570 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A structured set of questions and their answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the questionnaire being responded to.␊ - */␊ - export interface QuestionnaireResponse_Answer {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * The answer (or one of the answers) provided by the respondent to the question.␊ - */␊ - valueBoolean?: boolean␊ - _valueBoolean?: Element1571␊ - /**␊ - * The answer (or one of the answers) provided by the respondent to the question.␊ - */␊ - valueDecimal?: number␊ - _valueDecimal?: Element1572␊ - /**␊ - * The answer (or one of the answers) provided by the respondent to the question.␊ - */␊ - valueInteger?: number␊ - _valueInteger?: Element1573␊ - /**␊ - * The answer (or one of the answers) provided by the respondent to the question.␊ - */␊ - valueDate?: string␊ - _valueDate?: Element1574␊ - /**␊ - * The answer (or one of the answers) provided by the respondent to the question.␊ - */␊ - valueDateTime?: string␊ - _valueDateTime?: Element1575␊ - /**␊ - * The answer (or one of the answers) provided by the respondent to the question.␊ - */␊ - valueTime?: string␊ - _valueTime?: Element1576␊ - /**␊ - * The answer (or one of the answers) provided by the respondent to the question.␊ - */␊ - valueString?: string␊ - _valueString?: Element1577␊ - /**␊ - * The answer (or one of the answers) provided by the respondent to the question.␊ - */␊ - valueUri?: string␊ - _valueUri?: Element1578␊ - valueAttachment?: Attachment21␊ - valueCoding?: Coding33␊ - valueQuantity?: Quantity84␊ - valueReference?: Reference401␊ - /**␊ - * Nested groups and/or questions found within this particular answer.␊ - */␊ - item?: QuestionnaireResponse_Item[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1571 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1572 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1573 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1574 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1575 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1576 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1577 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1578 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * For referring to data content defined in other formats.␊ - */␊ - export interface Attachment21 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.␊ - */␊ - contentType?: string␊ - _contentType?: Element51␊ - /**␊ - * The human language of the content. The value can be any valid value according to BCP 47.␊ - */␊ - language?: string␊ - _language?: Element52␊ - /**␊ - * The actual data of the attachment - a sequence of bytes, base64 encoded.␊ - */␊ - data?: string␊ - _data?: Element53␊ - /**␊ - * A location where the data can be accessed.␊ - */␊ - url?: string␊ - _url?: Element54␊ - /**␊ - * The number of bytes of data that make up this attachment (before base64 encoding, if that is done).␊ - */␊ - size?: number␊ - _size?: Element55␊ - /**␊ - * The calculated hash of the data using SHA-1. Represented using base64.␊ - */␊ - hash?: string␊ - _hash?: Element56␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element57␊ - /**␊ - * The date that the attachment was first created.␊ - */␊ - creation?: string␊ - _creation?: Element58␊ - }␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - export interface Coding33 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The identification of the code system that defines the meaning of the symbol in the code.␊ - */␊ - system?: string␊ - _system?: Element39␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element40␊ - /**␊ - * A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).␊ - */␊ - code?: string␊ - _code?: Element41␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element42␊ - /**␊ - * Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).␊ - */␊ - userSelected?: boolean␊ - _userSelected?: Element43␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity84 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference401 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.␊ - */␊ - export interface RelatedPerson {␊ - /**␊ - * This is a RelatedPerson resource␊ - */␊ - resourceType: "RelatedPerson"␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - id?: string␊ - meta?: Meta115␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1579␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1580␊ - text?: Narrative111␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifier for a person within a particular scope.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * Whether this related person record is in active use.␊ - */␊ - active?: boolean␊ - _active?: Element1581␊ - patient: Reference402␊ - /**␊ - * The nature of the relationship between a patient and the related person.␊ - */␊ - relationship?: CodeableConcept5[]␊ - /**␊ - * A name associated with the person.␊ - */␊ - name?: HumanName4[]␊ - /**␊ - * A contact detail for the person, e.g. a telephone number or an email address.␊ - */␊ - telecom?: ContactPoint1[]␊ - /**␊ - * Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.␊ - */␊ - gender?: ("male" | "female" | "other" | "unknown")␊ - _gender?: Element1582␊ - /**␊ - * The date on which the related person was born.␊ - */␊ - birthDate?: string␊ - _birthDate?: Element1583␊ - /**␊ - * Address where the related person can be contacted or visited.␊ - */␊ - address?: Address9[]␊ - /**␊ - * Image of the person.␊ - */␊ - photo?: Attachment2[]␊ - period?: Period102␊ - /**␊ - * A language which may be used to communicate with about the patient's health.␊ - */␊ - communication?: RelatedPerson_Communication[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta115 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1579 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1580 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative111 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1581 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference402 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1582 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1583 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period102 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.␊ - */␊ - export interface RelatedPerson_Communication {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - language: CodeableConcept458␊ - /**␊ - * Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).␊ - */␊ - preferred?: boolean␊ - _preferred?: Element1584␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept458 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1584 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A group of related requests that can be used to capture intended activities that have inter-dependencies such as "give this medication after that one".␊ - */␊ - export interface RequestGroup {␊ - /**␊ - * This is a RequestGroup resource␊ - */␊ - resourceType: "RequestGroup"␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - id?: string␊ - meta?: Meta116␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1585␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1586␊ - text?: Narrative112␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Allows a service to provide a unique, business identifier for the request.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * A canonical URL referencing a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.␊ - */␊ - instantiatesCanonical?: Canonical[]␊ - /**␊ - * Extensions for instantiatesCanonical␊ - */␊ - _instantiatesCanonical?: Element23[]␊ - /**␊ - * A URL referencing an externally defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.␊ - */␊ - instantiatesUri?: Uri[]␊ - /**␊ - * Extensions for instantiatesUri␊ - */␊ - _instantiatesUri?: Element23[]␊ - /**␊ - * A plan, proposal or order that is fulfilled in whole or in part by this request.␊ - */␊ - basedOn?: Reference11[]␊ - /**␊ - * Completed or terminated request(s) whose function is taken by this new request.␊ - */␊ - replaces?: Reference11[]␊ - groupIdentifier?: Identifier35␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - status?: string␊ - _status?: Element1587␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - intent?: string␊ - _intent?: Element1588␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - priority?: string␊ - _priority?: Element1589␊ - code?: CodeableConcept459␊ - subject?: Reference403␊ - encounter?: Reference404␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - authoredOn?: string␊ - _authoredOn?: Element1590␊ - author?: Reference405␊ - /**␊ - * Describes the reason for the request group in coded or textual form.␊ - */␊ - reasonCode?: CodeableConcept5[]␊ - /**␊ - * Indicates another resource whose existence justifies this request group.␊ - */␊ - reasonReference?: Reference11[]␊ - /**␊ - * Provides a mechanism to communicate additional information about the response.␊ - */␊ - note?: Annotation1[]␊ - /**␊ - * The actions, if any, produced by the evaluation of the artifact.␊ - */␊ - action?: RequestGroup_Action[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta116 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1585 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1586 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative112 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier35 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1587 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1588 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1589 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept459 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference403 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference404 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1590 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference405 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A group of related requests that can be used to capture intended activities that have inter-dependencies such as "give this medication after that one".␊ - */␊ - export interface RequestGroup_Action {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - prefix?: string␊ - _prefix?: Element1591␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element1592␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element1593␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - textEquivalent?: string␊ - _textEquivalent?: Element1594␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - priority?: string␊ - _priority?: Element1595␊ - /**␊ - * A code that provides meaning for the action or action group. For example, a section may have a LOINC code for a section of a documentation template.␊ - */␊ - code?: CodeableConcept5[]␊ - /**␊ - * Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.␊ - */␊ - documentation?: RelatedArtifact1[]␊ - /**␊ - * An expression that describes applicability criteria, or start/stop conditions for the action.␊ - */␊ - condition?: RequestGroup_Condition[]␊ - /**␊ - * A relationship to another action such as "before" or "30-60 minutes after start of".␊ - */␊ - relatedAction?: RequestGroup_RelatedAction[]␊ - /**␊ - * An optional value describing when the action should be performed.␊ - */␊ - timingDateTime?: string␊ - _timingDateTime?: Element1599␊ - timingAge?: Age11␊ - timingPeriod?: Period103␊ - timingDuration?: Duration19␊ - timingRange?: Range28␊ - timingTiming?: Timing16␊ - /**␊ - * The participant that should perform or be responsible for this action.␊ - */␊ - participant?: Reference11[]␊ - type?: CodeableConcept460␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - groupingBehavior?: string␊ - _groupingBehavior?: Element1600␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - selectionBehavior?: string␊ - _selectionBehavior?: Element1601␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - requiredBehavior?: string␊ - _requiredBehavior?: Element1602␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - precheckBehavior?: string␊ - _precheckBehavior?: Element1603␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - cardinalityBehavior?: string␊ - _cardinalityBehavior?: Element1604␊ - resource?: Reference406␊ - /**␊ - * Sub actions.␊ - */␊ - action?: RequestGroup_Action[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1591 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1592 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1593 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1594 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1595 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A group of related requests that can be used to capture intended activities that have inter-dependencies such as "give this medication after that one".␊ - */␊ - export interface RequestGroup_Condition {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - kind?: string␊ - _kind?: Element1596␊ - expression?: Expression11␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1596 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * An expression that returns true or false, indicating whether or not the condition is satisfied.␊ - */␊ - export interface Expression11 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element121␊ - /**␊ - * A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.␊ - */␊ - name?: string␊ - _name?: Element122␊ - /**␊ - * The media type of the language for the expression.␊ - */␊ - language?: ("text/cql" | "text/fhirpath" | "application/x-fhir-query")␊ - _language?: Element123␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - expression?: string␊ - _expression?: Element124␊ - /**␊ - * A URI that defines where the expression is found.␊ - */␊ - reference?: string␊ - _reference?: Element125␊ - }␊ - /**␊ - * A group of related requests that can be used to capture intended activities that have inter-dependencies such as "give this medication after that one".␊ - */␊ - export interface RequestGroup_RelatedAction {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - actionId?: string␊ - _actionId?: Element1597␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - relationship?: string␊ - _relationship?: Element1598␊ - offsetDuration?: Duration18␊ - offsetRange?: Range27␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1597 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1598 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.␊ - */␊ - export interface Duration18 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element73␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element74␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element75␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element76␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element77␊ - }␊ - /**␊ - * A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.␊ - */␊ - export interface Range27 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - low?: Quantity1␊ - high?: Quantity2␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1599 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * An optional value describing when the action should be performed.␊ - */␊ - export interface Age11 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element31␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element32␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element33␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element34␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element35␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period103 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * An optional value describing when the action should be performed.␊ - */␊ - export interface Duration19 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element73␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element74␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element75␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element76␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element77␊ - }␊ - /**␊ - * An optional value describing when the action should be performed.␊ - */␊ - export interface Range28 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - low?: Quantity1␊ - high?: Quantity2␊ - }␊ - /**␊ - * Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.␊ - */␊ - export interface Timing16 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifies specific times when the event occurs.␊ - */␊ - event?: DateTime[]␊ - /**␊ - * Extensions for event␊ - */␊ - _event?: Element23[]␊ - repeat?: Timing_Repeat␊ - code?: CodeableConcept2␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept460 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1600 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1601 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1602 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1603 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1604 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference406 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * The ResearchDefinition resource describes the conditional state (population and any exposures being compared within the population) and outcome (if specified) that the knowledge (evidence, assertion, recommendation) is about.␊ - */␊ - export interface ResearchDefinition {␊ - /**␊ - * This is a ResearchDefinition resource␊ - */␊ - resourceType: "ResearchDefinition"␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - id?: string␊ - meta?: Meta117␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1605␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1606␊ - text?: Narrative113␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - url?: string␊ - _url?: Element1607␊ - /**␊ - * A formal identifier that is used to identify this research definition when it is represented in other formats, or referenced in a specification, model, design or an instance.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element1608␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element1609␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element1610␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - shortTitle?: string␊ - _shortTitle?: Element1611␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - subtitle?: string␊ - _subtitle?: Element1612␊ - /**␊ - * The status of this research definition. Enables tracking the life-cycle of the content.␊ - */␊ - status?: ("draft" | "active" | "retired" | "unknown")␊ - _status?: Element1613␊ - /**␊ - * A Boolean value to indicate that this research definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.␊ - */␊ - experimental?: boolean␊ - _experimental?: Element1614␊ - subjectCodeableConcept?: CodeableConcept461␊ - subjectReference?: Reference407␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - date?: string␊ - _date?: Element1615␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - publisher?: string␊ - _publisher?: Element1616␊ - /**␊ - * Contact details to assist a user in finding and communicating with the publisher.␊ - */␊ - contact?: ContactDetail1[]␊ - /**␊ - * A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine␊ - */␊ - description?: string␊ - _description?: Element1617␊ - /**␊ - * A human-readable string to clarify or explain concepts about the resource.␊ - */␊ - comment?: String[]␊ - /**␊ - * Extensions for comment␊ - */␊ - _comment?: Element23[]␊ - /**␊ - * The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate research definition instances.␊ - */␊ - useContext?: UsageContext1[]␊ - /**␊ - * A legal or geographic region in which the research definition is intended to be used.␊ - */␊ - jurisdiction?: CodeableConcept5[]␊ - /**␊ - * A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine␊ - */␊ - purpose?: string␊ - _purpose?: Element1618␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - usage?: string␊ - _usage?: Element1619␊ - /**␊ - * A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine␊ - */␊ - copyright?: string␊ - _copyright?: Element1620␊ - /**␊ - * The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.␊ - */␊ - approvalDate?: string␊ - _approvalDate?: Element1621␊ - /**␊ - * The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.␊ - */␊ - lastReviewDate?: string␊ - _lastReviewDate?: Element1622␊ - effectivePeriod?: Period104␊ - /**␊ - * Descriptive topics related to the content of the ResearchDefinition. Topics provide a high-level categorization grouping types of ResearchDefinitions that can be useful for filtering and searching.␊ - */␊ - topic?: CodeableConcept5[]␊ - /**␊ - * An individiual or organization primarily involved in the creation and maintenance of the content.␊ - */␊ - author?: ContactDetail1[]␊ - /**␊ - * An individual or organization primarily responsible for internal coherence of the content.␊ - */␊ - editor?: ContactDetail1[]␊ - /**␊ - * An individual or organization primarily responsible for review of some aspect of the content.␊ - */␊ - reviewer?: ContactDetail1[]␊ - /**␊ - * An individual or organization responsible for officially endorsing the content for use in some setting.␊ - */␊ - endorser?: ContactDetail1[]␊ - /**␊ - * Related artifacts such as additional documentation, justification, or bibliographic references.␊ - */␊ - relatedArtifact?: RelatedArtifact1[]␊ - /**␊ - * A reference to a Library resource containing the formal logic used by the ResearchDefinition.␊ - */␊ - library?: Canonical[]␊ - population: Reference408␊ - exposure?: Reference409␊ - exposureAlternative?: Reference410␊ - outcome?: Reference411␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta117 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1605 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1606 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative113 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1607 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1608 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1609 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1610 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1611 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1612 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1613 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1614 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept461 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference407 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1615 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1616 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1617 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1618 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1619 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1620 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1621 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1622 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period104 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference408 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference409 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference410 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference411 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * The ResearchElementDefinition resource describes a "PICO" element that knowledge (evidence, assertion, recommendation) is about.␊ - */␊ - export interface ResearchElementDefinition {␊ - /**␊ - * This is a ResearchElementDefinition resource␊ - */␊ - resourceType: "ResearchElementDefinition"␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - id?: string␊ - meta?: Meta118␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1623␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1624␊ - text?: Narrative114␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - url?: string␊ - _url?: Element1625␊ - /**␊ - * A formal identifier that is used to identify this research element definition when it is represented in other formats, or referenced in a specification, model, design or an instance.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element1626␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element1627␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element1628␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - shortTitle?: string␊ - _shortTitle?: Element1629␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - subtitle?: string␊ - _subtitle?: Element1630␊ - /**␊ - * The status of this research element definition. Enables tracking the life-cycle of the content.␊ - */␊ - status?: ("draft" | "active" | "retired" | "unknown")␊ - _status?: Element1631␊ - /**␊ - * A Boolean value to indicate that this research element definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.␊ - */␊ - experimental?: boolean␊ - _experimental?: Element1632␊ - subjectCodeableConcept?: CodeableConcept462␊ - subjectReference?: Reference412␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - date?: string␊ - _date?: Element1633␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - publisher?: string␊ - _publisher?: Element1634␊ - /**␊ - * Contact details to assist a user in finding and communicating with the publisher.␊ - */␊ - contact?: ContactDetail1[]␊ - /**␊ - * A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine␊ - */␊ - description?: string␊ - _description?: Element1635␊ - /**␊ - * A human-readable string to clarify or explain concepts about the resource.␊ - */␊ - comment?: String[]␊ - /**␊ - * Extensions for comment␊ - */␊ - _comment?: Element23[]␊ - /**␊ - * The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate research element definition instances.␊ - */␊ - useContext?: UsageContext1[]␊ - /**␊ - * A legal or geographic region in which the research element definition is intended to be used.␊ - */␊ - jurisdiction?: CodeableConcept5[]␊ - /**␊ - * A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine␊ - */␊ - purpose?: string␊ - _purpose?: Element1636␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - usage?: string␊ - _usage?: Element1637␊ - /**␊ - * A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine␊ - */␊ - copyright?: string␊ - _copyright?: Element1638␊ - /**␊ - * The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.␊ - */␊ - approvalDate?: string␊ - _approvalDate?: Element1639␊ - /**␊ - * The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.␊ - */␊ - lastReviewDate?: string␊ - _lastReviewDate?: Element1640␊ - effectivePeriod?: Period105␊ - /**␊ - * Descriptive topics related to the content of the ResearchElementDefinition. Topics provide a high-level categorization grouping types of ResearchElementDefinitions that can be useful for filtering and searching.␊ - */␊ - topic?: CodeableConcept5[]␊ - /**␊ - * An individiual or organization primarily involved in the creation and maintenance of the content.␊ - */␊ - author?: ContactDetail1[]␊ - /**␊ - * An individual or organization primarily responsible for internal coherence of the content.␊ - */␊ - editor?: ContactDetail1[]␊ - /**␊ - * An individual or organization primarily responsible for review of some aspect of the content.␊ - */␊ - reviewer?: ContactDetail1[]␊ - /**␊ - * An individual or organization responsible for officially endorsing the content for use in some setting.␊ - */␊ - endorser?: ContactDetail1[]␊ - /**␊ - * Related artifacts such as additional documentation, justification, or bibliographic references.␊ - */␊ - relatedArtifact?: RelatedArtifact1[]␊ - /**␊ - * A reference to a Library resource containing the formal logic used by the ResearchElementDefinition.␊ - */␊ - library?: Canonical[]␊ - /**␊ - * The type of research element, a population, an exposure, or an outcome.␊ - */␊ - type?: ("population" | "exposure" | "outcome")␊ - _type?: Element1641␊ - /**␊ - * The type of the outcome (e.g. Dichotomous, Continuous, or Descriptive).␊ - */␊ - variableType?: ("dichotomous" | "continuous" | "descriptive")␊ - _variableType?: Element1642␊ - /**␊ - * A characteristic that defines the members of the research element. Multiple characteristics are applied with "and" semantics.␊ - */␊ - characteristic: ResearchElementDefinition_Characteristic[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta118 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1623 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1624 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative114 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1625 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1626 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1627 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1628 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1629 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1630 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1631 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1632 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept462 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference412 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1633 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1634 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1635 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1636 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1637 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1638 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1639 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1640 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period105 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1641 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1642 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The ResearchElementDefinition resource describes a "PICO" element that knowledge (evidence, assertion, recommendation) is about.␊ - */␊ - export interface ResearchElementDefinition_Characteristic {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - definitionCodeableConcept?: CodeableConcept463␊ - /**␊ - * Define members of the research element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year).␊ - */␊ - definitionCanonical?: string␊ - _definitionCanonical?: Element1643␊ - definitionExpression?: Expression12␊ - definitionDataRequirement?: DataRequirement4␊ - /**␊ - * Use UsageContext to define the members of the population, such as Age Ranges, Genders, Settings.␊ - */␊ - usageContext?: UsageContext1[]␊ - /**␊ - * When true, members with this characteristic are excluded from the element.␊ - */␊ - exclude?: boolean␊ - _exclude?: Element1644␊ - unitOfMeasure?: CodeableConcept464␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - studyEffectiveDescription?: string␊ - _studyEffectiveDescription?: Element1645␊ - /**␊ - * Indicates what effective period the study covers.␊ - */␊ - studyEffectiveDateTime?: string␊ - _studyEffectiveDateTime?: Element1646␊ - studyEffectivePeriod?: Period106␊ - studyEffectiveDuration?: Duration20␊ - studyEffectiveTiming?: Timing17␊ - studyEffectiveTimeFromStart?: Duration21␊ - /**␊ - * Indicates how elements are aggregated within the study effective period.␊ - */␊ - studyEffectiveGroupMeasure?: ("mean" | "median" | "mean-of-mean" | "mean-of-median" | "median-of-mean" | "median-of-median")␊ - _studyEffectiveGroupMeasure?: Element1647␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - participantEffectiveDescription?: string␊ - _participantEffectiveDescription?: Element1648␊ - /**␊ - * Indicates what effective period the study covers.␊ - */␊ - participantEffectiveDateTime?: string␊ - _participantEffectiveDateTime?: Element1649␊ - participantEffectivePeriod?: Period107␊ - participantEffectiveDuration?: Duration22␊ - participantEffectiveTiming?: Timing18␊ - participantEffectiveTimeFromStart?: Duration23␊ - /**␊ - * Indicates how elements are aggregated within the study effective period.␊ - */␊ - participantEffectiveGroupMeasure?: ("mean" | "median" | "mean-of-mean" | "mean-of-median" | "median-of-mean" | "median-of-median")␊ - _participantEffectiveGroupMeasure?: Element1650␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept463 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1643 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Define members of the research element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year).␊ - */␊ - export interface Expression12 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element121␊ - /**␊ - * A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.␊ - */␊ - name?: string␊ - _name?: Element122␊ - /**␊ - * The media type of the language for the expression.␊ - */␊ - language?: ("text/cql" | "text/fhirpath" | "application/x-fhir-query")␊ - _language?: Element123␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - expression?: string␊ - _expression?: Element124␊ - /**␊ - * A URI that defines where the expression is found.␊ - */␊ - reference?: string␊ - _reference?: Element125␊ - }␊ - /**␊ - * Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.␊ - */␊ - export interface DataRequirement4 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - type?: string␊ - _type?: Element112␊ - /**␊ - * The profile of the required data, specified as the uri of the profile definition.␊ - */␊ - profile?: Canonical[]␊ - subjectCodeableConcept?: CodeableConcept3␊ - subjectReference?: Reference5␊ - /**␊ - * Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. ␊ - * ␊ - * The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details).␊ - */␊ - mustSupport?: String[]␊ - /**␊ - * Extensions for mustSupport␊ - */␊ - _mustSupport?: Element23[]␊ - /**␊ - * Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.␊ - */␊ - codeFilter?: DataRequirement_CodeFilter[]␊ - /**␊ - * Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.␊ - */␊ - dateFilter?: DataRequirement_DateFilter[]␊ - /**␊ - * Specifies a maximum number of results that are required (uses the _count search parameter).␊ - */␊ - limit?: number␊ - _limit?: Element118␊ - /**␊ - * Specifies the order of the results to be returned.␊ - */␊ - sort?: DataRequirement_Sort[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1644 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept464 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1645 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1646 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period106 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Indicates what effective period the study covers.␊ - */␊ - export interface Duration20 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element73␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element74␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element75␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element76␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element77␊ - }␊ - /**␊ - * Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.␊ - */␊ - export interface Timing17 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifies specific times when the event occurs.␊ - */␊ - event?: DateTime[]␊ - /**␊ - * Extensions for event␊ - */␊ - _event?: Element23[]␊ - repeat?: Timing_Repeat␊ - code?: CodeableConcept2␊ - }␊ - /**␊ - * Indicates duration from the study initiation.␊ - */␊ - export interface Duration21 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element73␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element74␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element75␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element76␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element77␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1647 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1648 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1649 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period107 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Indicates what effective period the study covers.␊ - */␊ - export interface Duration22 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element73␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element74␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element75␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element76␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element77␊ - }␊ - /**␊ - * Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.␊ - */␊ - export interface Timing18 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifies specific times when the event occurs.␊ - */␊ - event?: DateTime[]␊ - /**␊ - * Extensions for event␊ - */␊ - _event?: Element23[]␊ - repeat?: Timing_Repeat␊ - code?: CodeableConcept2␊ - }␊ - /**␊ - * Indicates duration from the participant's study entry.␊ - */␊ - export interface Duration23 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element73␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element74␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element75␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element76␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element77␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1650 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A process where a researcher or organization plans and then executes a series of steps intended to increase the field of healthcare-related knowledge. This includes studies of safety, efficacy, comparative effectiveness and other information about medications, devices, therapies and other interventional and investigative techniques. A ResearchStudy involves the gathering of information about human or animal subjects.␊ - */␊ - export interface ResearchStudy {␊ - /**␊ - * This is a ResearchStudy resource␊ - */␊ - resourceType: "ResearchStudy"␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - id?: string␊ - meta?: Meta119␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1651␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1652␊ - text?: Narrative115␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifiers assigned to this research study by the sponsor or other systems.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element1653␊ - /**␊ - * The set of steps expected to be performed as part of the execution of the study.␊ - */␊ - protocol?: Reference11[]␊ - /**␊ - * A larger research study of which this particular study is a component or step.␊ - */␊ - partOf?: Reference11[]␊ - /**␊ - * The current state of the study.␊ - */␊ - status?: ("active" | "administratively-completed" | "approved" | "closed-to-accrual" | "closed-to-accrual-and-intervention" | "completed" | "disapproved" | "in-review" | "temporarily-closed-to-accrual" | "temporarily-closed-to-accrual-and-intervention" | "withdrawn")␊ - _status?: Element1654␊ - primaryPurposeType?: CodeableConcept465␊ - phase?: CodeableConcept466␊ - /**␊ - * Codes categorizing the type of study such as investigational vs. observational, type of blinding, type of randomization, safety vs. efficacy, etc.␊ - */␊ - category?: CodeableConcept5[]␊ - /**␊ - * The medication(s), food(s), therapy(ies), device(s) or other concerns or interventions that the study is seeking to gain more information about.␊ - */␊ - focus?: CodeableConcept5[]␊ - /**␊ - * The condition that is the focus of the study. For example, In a study to examine risk factors for Lupus, might have as an inclusion criterion "healthy volunteer", but the target condition code would be a Lupus SNOMED code.␊ - */␊ - condition?: CodeableConcept5[]␊ - /**␊ - * Contact details to assist a user in learning more about or engaging with the study.␊ - */␊ - contact?: ContactDetail1[]␊ - /**␊ - * Citations, references and other related documents.␊ - */␊ - relatedArtifact?: RelatedArtifact1[]␊ - /**␊ - * Key terms to aid in searching for or filtering the study.␊ - */␊ - keyword?: CodeableConcept5[]␊ - /**␊ - * Indicates a country, state or other region where the study is taking place.␊ - */␊ - location?: CodeableConcept5[]␊ - /**␊ - * A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine␊ - */␊ - description?: string␊ - _description?: Element1655␊ - /**␊ - * Reference to a Group that defines the criteria for and quantity of subjects participating in the study. E.g. " 200 female Europeans between the ages of 20 and 45 with early onset diabetes".␊ - */␊ - enrollment?: Reference11[]␊ - period?: Period108␊ - sponsor?: Reference413␊ - principalInvestigator?: Reference414␊ - /**␊ - * A facility in which study activities are conducted.␊ - */␊ - site?: Reference11[]␊ - reasonStopped?: CodeableConcept467␊ - /**␊ - * Comments made about the study by the performer, subject or other participants.␊ - */␊ - note?: Annotation1[]␊ - /**␊ - * Describes an expected sequence of events for one of the participants of a study. E.g. Exposure to drug A, wash-out, exposure to drug B, wash-out, follow-up.␊ - */␊ - arm?: ResearchStudy_Arm[]␊ - /**␊ - * A goal that the study is aiming to achieve in terms of a scientific question to be answered by the analysis of data collected during the study.␊ - */␊ - objective?: ResearchStudy_Objective[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta119 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1651 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1652 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative115 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1653 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1654 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept465 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept466 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1655 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period108 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference413 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference414 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept467 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A process where a researcher or organization plans and then executes a series of steps intended to increase the field of healthcare-related knowledge. This includes studies of safety, efficacy, comparative effectiveness and other information about medications, devices, therapies and other interventional and investigative techniques. A ResearchStudy involves the gathering of information about human or animal subjects.␊ - */␊ - export interface ResearchStudy_Arm {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element1656␊ - type?: CodeableConcept468␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element1657␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1656 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept468 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1657 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A process where a researcher or organization plans and then executes a series of steps intended to increase the field of healthcare-related knowledge. This includes studies of safety, efficacy, comparative effectiveness and other information about medications, devices, therapies and other interventional and investigative techniques. A ResearchStudy involves the gathering of information about human or animal subjects.␊ - */␊ - export interface ResearchStudy_Objective {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element1658␊ - type?: CodeableConcept469␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1658 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept469 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A physical entity which is the primary unit of operational and/or administrative interest in a study.␊ - */␊ - export interface ResearchSubject {␊ - /**␊ - * This is a ResearchSubject resource␊ - */␊ - resourceType: "ResearchSubject"␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - id?: string␊ - meta?: Meta120␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1659␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1660␊ - text?: Narrative116␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifiers assigned to this research subject for a study.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * The current state of the subject.␊ - */␊ - status?: ("candidate" | "eligible" | "follow-up" | "ineligible" | "not-registered" | "off-study" | "on-study" | "on-study-intervention" | "on-study-observation" | "pending-on-study" | "potential-candidate" | "screening" | "withdrawn")␊ - _status?: Element1661␊ - period?: Period109␊ - study: Reference415␊ - individual: Reference416␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - assignedArm?: string␊ - _assignedArm?: Element1662␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - actualArm?: string␊ - _actualArm?: Element1663␊ - consent?: Reference417␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta120 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1659 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1660 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative116 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1661 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period109 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference415 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference416 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1662 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1663 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference417 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * An assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome.␊ - */␊ - export interface RiskAssessment {␊ - /**␊ - * This is a RiskAssessment resource␊ - */␊ - resourceType: "RiskAssessment"␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - id?: string␊ - meta?: Meta121␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1664␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1665␊ - text?: Narrative117␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Business identifier assigned to the risk assessment.␊ - */␊ - identifier?: Identifier2[]␊ - basedOn?: Reference418␊ - parent?: Reference419␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - status?: string␊ - _status?: Element1666␊ - method?: CodeableConcept470␊ - code?: CodeableConcept471␊ - subject: Reference420␊ - encounter?: Reference421␊ - /**␊ - * The date (and possibly time) the risk assessment was performed.␊ - */␊ - occurrenceDateTime?: string␊ - _occurrenceDateTime?: Element1667␊ - occurrencePeriod?: Period110␊ - condition?: Reference422␊ - performer?: Reference423␊ - /**␊ - * The reason the risk assessment was performed.␊ - */␊ - reasonCode?: CodeableConcept5[]␊ - /**␊ - * Resources supporting the reason the risk assessment was performed.␊ - */␊ - reasonReference?: Reference11[]␊ - /**␊ - * Indicates the source data considered as part of the assessment (for example, FamilyHistory, Observations, Procedures, Conditions, etc.).␊ - */␊ - basis?: Reference11[]␊ - /**␊ - * Describes the expected outcome for the subject.␊ - */␊ - prediction?: RiskAssessment_Prediction[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - mitigation?: string␊ - _mitigation?: Element1671␊ - /**␊ - * Additional comments about the risk assessment.␊ - */␊ - note?: Annotation1[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta121 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1664 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1665 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative117 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference418 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference419 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1666 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept470 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept471 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference420 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference421 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1667 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period110 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference422 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference423 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * An assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome.␊ - */␊ - export interface RiskAssessment_Prediction {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - outcome?: CodeableConcept472␊ - /**␊ - * Indicates how likely the outcome is (in the specified timeframe).␊ - */␊ - probabilityDecimal?: number␊ - _probabilityDecimal?: Element1668␊ - probabilityRange?: Range29␊ - qualitativeRisk?: CodeableConcept473␊ - /**␊ - * A rational number with implicit precision␊ - */␊ - relativeRisk?: number␊ - _relativeRisk?: Element1669␊ - whenPeriod?: Period111␊ - whenRange?: Range30␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - rationale?: string␊ - _rationale?: Element1670␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept472 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1668 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Indicates how likely the outcome is (in the specified timeframe).␊ - */␊ - export interface Range29 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - low?: Quantity1␊ - high?: Quantity2␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept473 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1669 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period111 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Indicates the period of time or age range of the subject to which the specified probability applies.␊ - */␊ - export interface Range30 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - low?: Quantity1␊ - high?: Quantity2␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1670 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1671 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The RiskEvidenceSynthesis resource describes the likelihood of an outcome in a population plus exposure state where the risk estimate is derived from a combination of research studies.␊ - */␊ - export interface RiskEvidenceSynthesis {␊ - /**␊ - * This is a RiskEvidenceSynthesis resource␊ - */␊ - resourceType: "RiskEvidenceSynthesis"␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - id?: string␊ - meta?: Meta122␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1672␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1673␊ - text?: Narrative118␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - url?: string␊ - _url?: Element1674␊ - /**␊ - * A formal identifier that is used to identify this risk evidence synthesis when it is represented in other formats, or referenced in a specification, model, design or an instance.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element1675␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element1676␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element1677␊ - /**␊ - * The status of this risk evidence synthesis. Enables tracking the life-cycle of the content.␊ - */␊ - status?: ("draft" | "active" | "retired" | "unknown")␊ - _status?: Element1678␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - date?: string␊ - _date?: Element1679␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - publisher?: string␊ - _publisher?: Element1680␊ - /**␊ - * Contact details to assist a user in finding and communicating with the publisher.␊ - */␊ - contact?: ContactDetail1[]␊ - /**␊ - * A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine␊ - */␊ - description?: string␊ - _description?: Element1681␊ - /**␊ - * A human-readable string to clarify or explain concepts about the resource.␊ - */␊ - note?: Annotation1[]␊ - /**␊ - * The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate risk evidence synthesis instances.␊ - */␊ - useContext?: UsageContext1[]␊ - /**␊ - * A legal or geographic region in which the risk evidence synthesis is intended to be used.␊ - */␊ - jurisdiction?: CodeableConcept5[]␊ - /**␊ - * A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine␊ - */␊ - copyright?: string␊ - _copyright?: Element1682␊ - /**␊ - * The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.␊ - */␊ - approvalDate?: string␊ - _approvalDate?: Element1683␊ - /**␊ - * The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.␊ - */␊ - lastReviewDate?: string␊ - _lastReviewDate?: Element1684␊ - effectivePeriod?: Period112␊ - /**␊ - * Descriptive topics related to the content of the RiskEvidenceSynthesis. Topics provide a high-level categorization grouping types of EffectEvidenceSynthesiss that can be useful for filtering and searching.␊ - */␊ - topic?: CodeableConcept5[]␊ - /**␊ - * An individiual or organization primarily involved in the creation and maintenance of the content.␊ - */␊ - author?: ContactDetail1[]␊ - /**␊ - * An individual or organization primarily responsible for internal coherence of the content.␊ - */␊ - editor?: ContactDetail1[]␊ - /**␊ - * An individual or organization primarily responsible for review of some aspect of the content.␊ - */␊ - reviewer?: ContactDetail1[]␊ - /**␊ - * An individual or organization responsible for officially endorsing the content for use in some setting.␊ - */␊ - endorser?: ContactDetail1[]␊ - /**␊ - * Related artifacts such as additional documentation, justification, or bibliographic references.␊ - */␊ - relatedArtifact?: RelatedArtifact1[]␊ - synthesisType?: CodeableConcept474␊ - studyType?: CodeableConcept475␊ - population: Reference424␊ - exposure?: Reference425␊ - outcome: Reference426␊ - sampleSize?: RiskEvidenceSynthesis_SampleSize␊ - riskEstimate?: RiskEvidenceSynthesis_RiskEstimate␊ - /**␊ - * A description of the certainty of the risk estimate.␊ - */␊ - certainty?: RiskEvidenceSynthesis_Certainty[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta122 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1672 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1673 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative118 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1674 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1675 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1676 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1677 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1678 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1679 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1680 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1681 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1682 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1683 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1684 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period112 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept474 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept475 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference424 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference425 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference426 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A description of the size of the sample involved in the synthesis.␊ - */␊ - export interface RiskEvidenceSynthesis_SampleSize {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element1685␊ - /**␊ - * A whole number␊ - */␊ - numberOfStudies?: number␊ - _numberOfStudies?: Element1686␊ - /**␊ - * A whole number␊ - */␊ - numberOfParticipants?: number␊ - _numberOfParticipants?: Element1687␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1685 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1686 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1687 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The estimated risk of the outcome.␊ - */␊ - export interface RiskEvidenceSynthesis_RiskEstimate {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element1688␊ - type?: CodeableConcept476␊ - /**␊ - * A rational number with implicit precision␊ - */␊ - value?: number␊ - _value?: Element1689␊ - unitOfMeasure?: CodeableConcept477␊ - /**␊ - * A whole number␊ - */␊ - denominatorCount?: number␊ - _denominatorCount?: Element1690␊ - /**␊ - * A whole number␊ - */␊ - numeratorCount?: number␊ - _numeratorCount?: Element1691␊ - /**␊ - * A description of the precision of the estimate for the effect.␊ - */␊ - precisionEstimate?: RiskEvidenceSynthesis_PrecisionEstimate[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1688 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept476 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1689 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept477 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1690 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1691 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The RiskEvidenceSynthesis resource describes the likelihood of an outcome in a population plus exposure state where the risk estimate is derived from a combination of research studies.␊ - */␊ - export interface RiskEvidenceSynthesis_PrecisionEstimate {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - type?: CodeableConcept478␊ - /**␊ - * A rational number with implicit precision␊ - */␊ - level?: number␊ - _level?: Element1692␊ - /**␊ - * A rational number with implicit precision␊ - */␊ - from?: number␊ - _from?: Element1693␊ - /**␊ - * A rational number with implicit precision␊ - */␊ - to?: number␊ - _to?: Element1694␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept478 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1692 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1693 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1694 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The RiskEvidenceSynthesis resource describes the likelihood of an outcome in a population plus exposure state where the risk estimate is derived from a combination of research studies.␊ - */␊ - export interface RiskEvidenceSynthesis_Certainty {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A rating of the certainty of the effect estimate.␊ - */␊ - rating?: CodeableConcept5[]␊ - /**␊ - * A human-readable string to clarify or explain concepts about the resource.␊ - */␊ - note?: Annotation1[]␊ - /**␊ - * A description of a component of the overall certainty.␊ - */␊ - certaintySubcomponent?: RiskEvidenceSynthesis_CertaintySubcomponent[]␊ - }␊ - /**␊ - * The RiskEvidenceSynthesis resource describes the likelihood of an outcome in a population plus exposure state where the risk estimate is derived from a combination of research studies.␊ - */␊ - export interface RiskEvidenceSynthesis_CertaintySubcomponent {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - type?: CodeableConcept479␊ - /**␊ - * A rating of a subcomponent of rating certainty.␊ - */␊ - rating?: CodeableConcept5[]␊ - /**␊ - * A human-readable string to clarify or explain concepts about the resource.␊ - */␊ - note?: Annotation1[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept479 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A container for slots of time that may be available for booking appointments.␊ - */␊ - export interface Schedule {␊ - /**␊ - * This is a Schedule resource␊ - */␊ - resourceType: "Schedule"␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - id?: string␊ - meta?: Meta123␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1695␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1696␊ - text?: Narrative119␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * External Ids for this item.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * Whether this schedule record is in active use or should not be used (such as was entered in error).␊ - */␊ - active?: boolean␊ - _active?: Element1697␊ - /**␊ - * A broad categorization of the service that is to be performed during this appointment.␊ - */␊ - serviceCategory?: CodeableConcept5[]␊ - /**␊ - * The specific service that is to be performed during this appointment.␊ - */␊ - serviceType?: CodeableConcept5[]␊ - /**␊ - * The specialty of a practitioner that would be required to perform the service requested in this appointment.␊ - */␊ - specialty?: CodeableConcept5[]␊ - /**␊ - * Slots that reference this schedule resource provide the availability details to these referenced resource(s).␊ - */␊ - actor: Reference11[]␊ - planningHorizon?: Period113␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - comment?: string␊ - _comment?: Element1698␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta123 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1695 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1696 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative119 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1697 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period113 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1698 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A search parameter that defines a named search item that can be used to search/filter on a resource.␊ - */␊ - export interface SearchParameter {␊ - /**␊ - * This is a SearchParameter resource␊ - */␊ - resourceType: "SearchParameter"␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - id?: string␊ - meta?: Meta124␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1699␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1700␊ - text?: Narrative120␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - url?: string␊ - _url?: Element1701␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element1702␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element1703␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - derivedFrom?: string␊ - /**␊ - * The status of this search parameter. Enables tracking the life-cycle of the content.␊ - */␊ - status?: ("draft" | "active" | "retired" | "unknown")␊ - _status?: Element1704␊ - /**␊ - * A Boolean value to indicate that this search parameter is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.␊ - */␊ - experimental?: boolean␊ - _experimental?: Element1705␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - date?: string␊ - _date?: Element1706␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - publisher?: string␊ - _publisher?: Element1707␊ - /**␊ - * Contact details to assist a user in finding and communicating with the publisher.␊ - */␊ - contact?: ContactDetail1[]␊ - /**␊ - * A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine␊ - */␊ - description?: string␊ - _description?: Element1708␊ - /**␊ - * The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate search parameter instances.␊ - */␊ - useContext?: UsageContext1[]␊ - /**␊ - * A legal or geographic region in which the search parameter is intended to be used.␊ - */␊ - jurisdiction?: CodeableConcept5[]␊ - /**␊ - * A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine␊ - */␊ - purpose?: string␊ - _purpose?: Element1709␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - code?: string␊ - _code?: Element1710␊ - /**␊ - * The base resource type(s) that this search parameter can be used against.␊ - */␊ - base?: Code[]␊ - /**␊ - * Extensions for base␊ - */␊ - _base?: Element23[]␊ - /**␊ - * The type of value that a search parameter may contain, and how the content is interpreted.␊ - */␊ - type?: ("number" | "date" | "string" | "token" | "reference" | "composite" | "quantity" | "uri" | "special")␊ - _type?: Element1711␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - expression?: string␊ - _expression?: Element1712␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - xpath?: string␊ - _xpath?: Element1713␊ - /**␊ - * How the search parameter relates to the set of elements returned by evaluating the xpath query.␊ - */␊ - xpathUsage?: ("normal" | "phonetic" | "nearby" | "distance" | "other")␊ - _xpathUsage?: Element1714␊ - /**␊ - * Types of resource (if a resource is referenced).␊ - */␊ - target?: Code[]␊ - /**␊ - * Extensions for target␊ - */␊ - _target?: Element23[]␊ - /**␊ - * Whether multiple values are allowed for each time the parameter exists. Values are separated by commas, and the parameter matches if any of the values match.␊ - */␊ - multipleOr?: boolean␊ - _multipleOr?: Element1715␊ - /**␊ - * Whether multiple parameters are allowed - e.g. more than one parameter with the same name. The search matches if all the parameters match.␊ - */␊ - multipleAnd?: boolean␊ - _multipleAnd?: Element1716␊ - /**␊ - * Comparators supported for the search parameter.␊ - */␊ - comparator?: ("eq" | "ne" | "gt" | "lt" | "ge" | "le" | "sa" | "eb" | "ap")[]␊ - /**␊ - * Extensions for comparator␊ - */␊ - _comparator?: Element23[]␊ - /**␊ - * A modifier supported for the search parameter.␊ - */␊ - modifier?: ("missing" | "exact" | "contains" | "not" | "text" | "in" | "not-in" | "below" | "above" | "type" | "identifier" | "ofType")[]␊ - /**␊ - * Extensions for modifier␊ - */␊ - _modifier?: Element23[]␊ - /**␊ - * Contains the names of any search parameters which may be chained to the containing search parameter. Chained parameters may be added to search parameters of type reference and specify that resources will only be returned if they contain a reference to a resource which matches the chained parameter value. Values for this field should be drawn from SearchParameter.code for a parameter on the target resource type.␊ - */␊ - chain?: String[]␊ - /**␊ - * Extensions for chain␊ - */␊ - _chain?: Element23[]␊ - /**␊ - * Used to define the parts of a composite search parameter.␊ - */␊ - component?: SearchParameter_Component[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta124 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1699 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1700 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative120 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1701 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1702 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1703 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1704 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1705 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1706 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1707 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1708 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1709 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1710 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1711 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1712 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1713 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1714 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1715 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1716 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A search parameter that defines a named search item that can be used to search/filter on a resource.␊ - */␊ - export interface SearchParameter_Component {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - definition: string␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - expression?: string␊ - _expression?: Element1717␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1717 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A record of a request for service such as diagnostic investigations, treatments, or operations to be performed.␊ - */␊ - export interface ServiceRequest {␊ - /**␊ - * This is a ServiceRequest resource␊ - */␊ - resourceType: "ServiceRequest"␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - id?: string␊ - meta?: Meta125␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1718␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1719␊ - text?: Narrative121␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest.␊ - */␊ - instantiatesCanonical?: Canonical[]␊ - /**␊ - * The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest.␊ - */␊ - instantiatesUri?: Uri[]␊ - /**␊ - * Extensions for instantiatesUri␊ - */␊ - _instantiatesUri?: Element23[]␊ - /**␊ - * Plan/proposal/order fulfilled by this request.␊ - */␊ - basedOn?: Reference11[]␊ - /**␊ - * The request takes the place of the referenced completed or terminated request(s).␊ - */␊ - replaces?: Reference11[]␊ - requisition?: Identifier36␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - status?: string␊ - _status?: Element1720␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - intent?: string␊ - _intent?: Element1721␊ - /**␊ - * A code that classifies the service for searching, sorting and display purposes (e.g. "Surgical Procedure").␊ - */␊ - category?: CodeableConcept5[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - priority?: string␊ - _priority?: Element1722␊ - /**␊ - * Set this to true if the record is saying that the service/procedure should NOT be performed.␊ - */␊ - doNotPerform?: boolean␊ - _doNotPerform?: Element1723␊ - code?: CodeableConcept480␊ - /**␊ - * Additional details and instructions about the how the services are to be delivered. For example, and order for a urinary catheter may have an order detail for an external or indwelling catheter, or an order for a bandage may require additional instructions specifying how the bandage should be applied.␊ - */␊ - orderDetail?: CodeableConcept5[]␊ - quantityQuantity?: Quantity85␊ - quantityRatio?: Ratio19␊ - quantityRange?: Range31␊ - subject: Reference427␊ - encounter?: Reference428␊ - /**␊ - * The date/time at which the requested service should occur.␊ - */␊ - occurrenceDateTime?: string␊ - _occurrenceDateTime?: Element1724␊ - occurrencePeriod?: Period114␊ - occurrenceTiming?: Timing19␊ - /**␊ - * If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc.␊ - */␊ - asNeededBoolean?: boolean␊ - _asNeededBoolean?: Element1725␊ - asNeededCodeableConcept?: CodeableConcept481␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - authoredOn?: string␊ - _authoredOn?: Element1726␊ - requester?: Reference429␊ - performerType?: CodeableConcept482␊ - /**␊ - * The desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc.␊ - */␊ - performer?: Reference11[]␊ - /**␊ - * The preferred location(s) where the procedure should actually happen in coded or free text form. E.g. at home or nursing day care center.␊ - */␊ - locationCode?: CodeableConcept5[]␊ - /**␊ - * A reference to the the preferred location(s) where the procedure should actually happen. E.g. at home or nursing day care center.␊ - */␊ - locationReference?: Reference11[]␊ - /**␊ - * An explanation or justification for why this service is being requested in coded or textual form. This is often for billing purposes. May relate to the resources referred to in \`supportingInfo\`.␊ - */␊ - reasonCode?: CodeableConcept5[]␊ - /**␊ - * Indicates another resource that provides a justification for why this service is being requested. May relate to the resources referred to in \`supportingInfo\`.␊ - */␊ - reasonReference?: Reference11[]␊ - /**␊ - * Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service.␊ - */␊ - insurance?: Reference11[]␊ - /**␊ - * Additional clinical information about the patient or specimen that may influence the services or their interpretations. This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as "ask at order entry questions (AOEs)". This includes observations explicitly requested by the producer (filler) to provide context or supporting information needed to complete the order. For example, reporting the amount of inspired oxygen for blood gas measurements.␊ - */␊ - supportingInfo?: Reference11[]␊ - /**␊ - * One or more specimens that the laboratory procedure will use.␊ - */␊ - specimen?: Reference11[]␊ - /**␊ - * Anatomic location where the procedure should be performed. This is the target site.␊ - */␊ - bodySite?: CodeableConcept5[]␊ - /**␊ - * Any other notes and comments made about the service request. For example, internal billing notes.␊ - */␊ - note?: Annotation1[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - patientInstruction?: string␊ - _patientInstruction?: Element1727␊ - /**␊ - * Key events in the history of the request.␊ - */␊ - relevantHistory?: Reference11[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta125 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1718 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1719 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative121 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier36 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1720 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1721 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1722 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1723 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept480 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity85 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * An amount of service being requested which can be a quantity ( for example $1,500 home modification), a ratio ( for example, 20 half day visits per month), or a range (2.0 to 1.8 Gy per fraction).␊ - */␊ - export interface Ratio19 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - numerator?: Quantity3␊ - denominator?: Quantity4␊ - }␊ - /**␊ - * An amount of service being requested which can be a quantity ( for example $1,500 home modification), a ratio ( for example, 20 half day visits per month), or a range (2.0 to 1.8 Gy per fraction).␊ - */␊ - export interface Range31 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - low?: Quantity1␊ - high?: Quantity2␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference427 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference428 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1724 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period114 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.␊ - */␊ - export interface Timing19 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifies specific times when the event occurs.␊ - */␊ - event?: DateTime[]␊ - /**␊ - * Extensions for event␊ - */␊ - _event?: Element23[]␊ - repeat?: Timing_Repeat␊ - code?: CodeableConcept2␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1725 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept481 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1726 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference429 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept482 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1727 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A slot of time on a schedule that may be available for booking appointments.␊ - */␊ - export interface Slot {␊ - /**␊ - * This is a Slot resource␊ - */␊ - resourceType: "Slot"␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - id?: string␊ - meta?: Meta126␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1728␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1729␊ - text?: Narrative122␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * External Ids for this item.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * A broad categorization of the service that is to be performed during this appointment.␊ - */␊ - serviceCategory?: CodeableConcept5[]␊ - /**␊ - * The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the availability resource.␊ - */␊ - serviceType?: CodeableConcept5[]␊ - /**␊ - * The specialty of a practitioner that would be required to perform the service requested in this appointment.␊ - */␊ - specialty?: CodeableConcept5[]␊ - appointmentType?: CodeableConcept483␊ - schedule: Reference430␊ - /**␊ - * busy | free | busy-unavailable | busy-tentative | entered-in-error.␊ - */␊ - status?: ("busy" | "free" | "busy-unavailable" | "busy-tentative" | "entered-in-error")␊ - _status?: Element1730␊ - /**␊ - * Date/Time that the slot is to begin.␊ - */␊ - start?: string␊ - _start?: Element1731␊ - /**␊ - * Date/Time that the slot is to conclude.␊ - */␊ - end?: string␊ - _end?: Element1732␊ - /**␊ - * This slot has already been overbooked, appointments are unlikely to be accepted for this time.␊ - */␊ - overbooked?: boolean␊ - _overbooked?: Element1733␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - comment?: string␊ - _comment?: Element1734␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta126 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1728 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1729 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative122 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept483 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference430 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1730 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1731 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1732 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1733 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1734 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A sample to be used for analysis.␊ - */␊ - export interface Specimen {␊ - /**␊ - * This is a Specimen resource␊ - */␊ - resourceType: "Specimen"␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - id?: string␊ - meta?: Meta127␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1735␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1736␊ - text?: Narrative123␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Id for specimen.␊ - */␊ - identifier?: Identifier2[]␊ - accessionIdentifier?: Identifier37␊ - /**␊ - * The availability of the specimen.␊ - */␊ - status?: ("available" | "unavailable" | "unsatisfactory" | "entered-in-error")␊ - _status?: Element1737␊ - type?: CodeableConcept484␊ - subject?: Reference431␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - receivedTime?: string␊ - _receivedTime?: Element1738␊ - /**␊ - * Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.␊ - */␊ - parent?: Reference11[]␊ - /**␊ - * Details concerning a service request that required a specimen to be collected.␊ - */␊ - request?: Reference11[]␊ - collection?: Specimen_Collection␊ - /**␊ - * Details concerning processing and processing steps for the specimen.␊ - */␊ - processing?: Specimen_Processing[]␊ - /**␊ - * The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.␊ - */␊ - container?: Specimen_Container[]␊ - /**␊ - * A mode or state of being that describes the nature of the specimen.␊ - */␊ - condition?: CodeableConcept5[]␊ - /**␊ - * To communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen).␊ - */␊ - note?: Annotation1[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta127 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1735 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1736 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative123 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier37 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1737 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept484 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference431 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1738 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Details concerning the specimen collection.␊ - */␊ - export interface Specimen_Collection {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - collector?: Reference432␊ - /**␊ - * Time when specimen was collected from subject - the physiologically relevant time.␊ - */␊ - collectedDateTime?: string␊ - _collectedDateTime?: Element1739␊ - collectedPeriod?: Period115␊ - duration?: Duration24␊ - quantity?: Quantity86␊ - method?: CodeableConcept485␊ - bodySite?: CodeableConcept486␊ - fastingStatusCodeableConcept?: CodeableConcept487␊ - fastingStatusDuration?: Duration25␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference432 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1739 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period115 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * The span of time over which the collection of a specimen occurred.␊ - */␊ - export interface Duration24 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element73␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element74␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element75␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element76␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element77␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity86 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept485 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept486 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept487 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Abstinence or reduction from some or all food, drink, or both, for a period of time prior to sample collection.␊ - */␊ - export interface Duration25 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element73␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element74␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element75␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element76␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element77␊ - }␊ - /**␊ - * A sample to be used for analysis.␊ - */␊ - export interface Specimen_Processing {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element1740␊ - procedure?: CodeableConcept488␊ - /**␊ - * Material used in the processing step.␊ - */␊ - additive?: Reference11[]␊ - /**␊ - * A record of the time or period when the specimen processing occurred. For example the time of sample fixation or the period of time the sample was in formalin.␊ - */␊ - timeDateTime?: string␊ - _timeDateTime?: Element1741␊ - timePeriod?: Period116␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1740 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept488 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1741 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period116 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * A sample to be used for analysis.␊ - */␊ - export interface Specimen_Container {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Id for container. There may be multiple; a manufacturer's bar code, lab assigned identifier, etc. The container ID may differ from the specimen id in some circumstances.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element1742␊ - type?: CodeableConcept489␊ - capacity?: Quantity87␊ - specimenQuantity?: Quantity88␊ - additiveCodeableConcept?: CodeableConcept490␊ - additiveReference?: Reference433␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1742 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept489 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity87 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity88 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept490 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference433 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A kind of specimen with associated set of requirements.␊ - */␊ - export interface SpecimenDefinition {␊ - /**␊ - * This is a SpecimenDefinition resource␊ - */␊ - resourceType: "SpecimenDefinition"␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - id?: string␊ - meta?: Meta128␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1743␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1744␊ - text?: Narrative124␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - identifier?: Identifier38␊ - typeCollected?: CodeableConcept491␊ - /**␊ - * Preparation of the patient for specimen collection.␊ - */␊ - patientPreparation?: CodeableConcept5[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - timeAspect?: string␊ - _timeAspect?: Element1745␊ - /**␊ - * The action to be performed for collecting the specimen.␊ - */␊ - collection?: CodeableConcept5[]␊ - /**␊ - * Specimen conditioned in a container as expected by the testing laboratory.␊ - */␊ - typeTested?: SpecimenDefinition_TypeTested[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta128 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1743 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1744 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative124 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier38 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept491 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1745 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A kind of specimen with associated set of requirements.␊ - */␊ - export interface SpecimenDefinition_TypeTested {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Primary of secondary specimen.␊ - */␊ - isDerived?: boolean␊ - _isDerived?: Element1746␊ - type?: CodeableConcept492␊ - /**␊ - * The preference for this type of conditioned specimen.␊ - */␊ - preference?: ("preferred" | "alternate")␊ - _preference?: Element1747␊ - container?: SpecimenDefinition_Container␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - requirement?: string␊ - _requirement?: Element1751␊ - retentionTime?: Duration26␊ - /**␊ - * Criterion for rejection of the specimen in its container by the laboratory.␊ - */␊ - rejectionCriterion?: CodeableConcept5[]␊ - /**␊ - * Set of instructions for preservation/transport of the specimen at a defined temperature interval, prior the testing process.␊ - */␊ - handling?: SpecimenDefinition_Handling[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1746 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept492 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1747 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The specimen's container.␊ - */␊ - export interface SpecimenDefinition_Container {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - material?: CodeableConcept493␊ - type?: CodeableConcept494␊ - cap?: CodeableConcept495␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element1748␊ - capacity?: Quantity89␊ - minimumVolumeQuantity?: Quantity90␊ - /**␊ - * The minimum volume to be conditioned in the container.␊ - */␊ - minimumVolumeString?: string␊ - _minimumVolumeString?: Element1749␊ - /**␊ - * Substance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.␊ - */␊ - additive?: SpecimenDefinition_Additive[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - preparation?: string␊ - _preparation?: Element1750␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept493 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept494 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept495 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1748 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity89 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity90 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1749 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A kind of specimen with associated set of requirements.␊ - */␊ - export interface SpecimenDefinition_Additive {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - additiveCodeableConcept?: CodeableConcept496␊ - additiveReference?: Reference434␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept496 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference434 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1750 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1751 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The usual time that a specimen of this kind is retained after the ordered tests are completed, for the purpose of additional testing.␊ - */␊ - export interface Duration26 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element73␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element74␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element75␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element76␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element77␊ - }␊ - /**␊ - * A kind of specimen with associated set of requirements.␊ - */␊ - export interface SpecimenDefinition_Handling {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - temperatureQualifier?: CodeableConcept497␊ - temperatureRange?: Range32␊ - maxDuration?: Duration27␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - instruction?: string␊ - _instruction?: Element1752␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept497 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * The temperature interval for this set of handling instructions.␊ - */␊ - export interface Range32 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - low?: Quantity1␊ - high?: Quantity2␊ - }␊ - /**␊ - * The maximum time interval of preservation of the specimen with these conditions.␊ - */␊ - export interface Duration27 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element73␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element74␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element75␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element76␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element77␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1752 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.␊ - */␊ - export interface StructureDefinition {␊ - /**␊ - * This is a StructureDefinition resource␊ - */␊ - resourceType: "StructureDefinition"␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - id?: string␊ - meta?: Meta129␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1753␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1754␊ - text?: Narrative125␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - url?: string␊ - _url?: Element1755␊ - /**␊ - * A formal identifier that is used to identify this structure definition when it is represented in other formats, or referenced in a specification, model, design or an instance.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element1756␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element1757␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element1758␊ - /**␊ - * The status of this structure definition. Enables tracking the life-cycle of the content.␊ - */␊ - status?: ("draft" | "active" | "retired" | "unknown")␊ - _status?: Element1759␊ - /**␊ - * A Boolean value to indicate that this structure definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.␊ - */␊ - experimental?: boolean␊ - _experimental?: Element1760␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - date?: string␊ - _date?: Element1761␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - publisher?: string␊ - _publisher?: Element1762␊ - /**␊ - * Contact details to assist a user in finding and communicating with the publisher.␊ - */␊ - contact?: ContactDetail1[]␊ - /**␊ - * A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine␊ - */␊ - description?: string␊ - _description?: Element1763␊ - /**␊ - * The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate structure definition instances.␊ - */␊ - useContext?: UsageContext1[]␊ - /**␊ - * A legal or geographic region in which the structure definition is intended to be used.␊ - */␊ - jurisdiction?: CodeableConcept5[]␊ - /**␊ - * A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine␊ - */␊ - purpose?: string␊ - _purpose?: Element1764␊ - /**␊ - * A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine␊ - */␊ - copyright?: string␊ - _copyright?: Element1765␊ - /**␊ - * A set of key words or terms from external terminologies that may be used to assist with indexing and searching of templates nby describing the use of this structure definition, or the content it describes.␊ - */␊ - keyword?: Coding[]␊ - /**␊ - * The version of the FHIR specification on which this StructureDefinition is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 4.0.1. for this version.␊ - */␊ - fhirVersion?: ("0.01" | "0.05" | "0.06" | "0.11" | "0.0.80" | "0.0.81" | "0.0.82" | "0.4.0" | "0.5.0" | "1.0.0" | "1.0.1" | "1.0.2" | "1.1.0" | "1.4.0" | "1.6.0" | "1.8.0" | "3.0.0" | "3.0.1" | "3.3.0" | "3.5.0" | "4.0.0" | "4.0.1")␊ - _fhirVersion?: Element1766␊ - /**␊ - * An external specification that the content is mapped to.␊ - */␊ - mapping?: StructureDefinition_Mapping[]␊ - /**␊ - * Defines the kind of structure that this definition is describing.␊ - */␊ - kind?: ("primitive-type" | "complex-type" | "resource" | "logical")␊ - _kind?: Element1771␊ - /**␊ - * Whether structure this definition describes is abstract or not - that is, whether the structure is not intended to be instantiated. For Resources and Data types, abstract types will never be exchanged between systems.␊ - */␊ - abstract?: boolean␊ - _abstract?: Element1772␊ - /**␊ - * Identifies the types of resource or data type elements to which the extension can be applied.␊ - */␊ - context?: StructureDefinition_Context[]␊ - /**␊ - * A set of rules as FHIRPath Invariants about when the extension can be used (e.g. co-occurrence variants for the extension). All the rules must be true.␊ - */␊ - contextInvariant?: String[]␊ - /**␊ - * Extensions for contextInvariant␊ - */␊ - _contextInvariant?: Element23[]␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - type?: string␊ - _type?: Element1775␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - baseDefinition?: string␊ - /**␊ - * How the type relates to the baseDefinition.␊ - */␊ - derivation?: ("specialization" | "constraint")␊ - _derivation?: Element1776␊ - snapshot?: StructureDefinition_Snapshot␊ - differential?: StructureDefinition_Differential␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta129 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1753 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1754 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative125 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1755 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1756 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1757 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1758 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1759 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1760 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1761 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1762 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1763 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1764 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1765 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1766 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.␊ - */␊ - export interface StructureDefinition_Mapping {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - identity?: string␊ - _identity?: Element1767␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - uri?: string␊ - _uri?: Element1768␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element1769␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - comment?: string␊ - _comment?: Element1770␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1767 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1768 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1769 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1770 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1771 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1772 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.␊ - */␊ - export interface StructureDefinition_Context {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Defines how to interpret the expression that defines what the context of the extension is.␊ - */␊ - type?: ("fhirpath" | "element" | "extension")␊ - _type?: Element1773␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - expression?: string␊ - _expression?: Element1774␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1773 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1774 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1775 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1776 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A snapshot view is expressed in a standalone form that can be used and interpreted without considering the base StructureDefinition.␊ - */␊ - export interface StructureDefinition_Snapshot {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Captures constraints on each element within the resource.␊ - */␊ - element: ElementDefinition[]␊ - }␊ - /**␊ - * Captures constraints on each element within the resource, profile, or extension.␊ - */␊ - export interface ElementDefinition {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - path?: string␊ - _path?: Element1777␊ - /**␊ - * Codes that define how this element is represented in instances, when the deviation varies from the normal case.␊ - */␊ - representation?: ("xmlAttr" | "xmlText" | "typeAttr" | "cdaText" | "xhtml")[]␊ - /**␊ - * Extensions for representation␊ - */␊ - _representation?: Element23[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - sliceName?: string␊ - _sliceName?: Element1778␊ - /**␊ - * If true, indicates that this slice definition is constraining a slice definition with the same name in an inherited profile. If false, the slice is not overriding any slice in an inherited profile. If missing, the slice might or might not be overriding a slice in an inherited profile, depending on the sliceName.␊ - */␊ - sliceIsConstraining?: boolean␊ - _sliceIsConstraining?: Element1779␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - label?: string␊ - _label?: Element1780␊ - /**␊ - * A code that has the same meaning as the element in a particular terminology.␊ - */␊ - code?: Coding[]␊ - slicing?: ElementDefinition_Slicing␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - short?: string␊ - _short?: Element1786␊ - /**␊ - * A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine␊ - */␊ - definition?: string␊ - _definition?: Element1787␊ - /**␊ - * A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine␊ - */␊ - comment?: string␊ - _comment?: Element1788␊ - /**␊ - * A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine␊ - */␊ - requirements?: string␊ - _requirements?: Element1789␊ - /**␊ - * Identifies additional names by which this element might also be known.␊ - */␊ - alias?: String[]␊ - /**␊ - * Extensions for alias␊ - */␊ - _alias?: Element23[]␊ - /**␊ - * An integer with a value that is not negative (e.g. >= 0)␊ - */␊ - min?: number␊ - _min?: Element1790␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - max?: string␊ - _max?: Element1791␊ - base?: ElementDefinition_Base␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - contentReference?: string␊ - _contentReference?: Element1795␊ - /**␊ - * The data type or resource that the value of this element is permitted to be.␊ - */␊ - type?: ElementDefinition_Type[]␊ - /**␊ - * The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false').␊ - */␊ - defaultValueBase64Binary?: string␊ - _defaultValueBase64Binary?: Element1798␊ - /**␊ - * The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false').␊ - */␊ - defaultValueBoolean?: boolean␊ - _defaultValueBoolean?: Element1799␊ - /**␊ - * The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false').␊ - */␊ - defaultValueCanonical?: string␊ - _defaultValueCanonical?: Element1800␊ - /**␊ - * The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false').␊ - */␊ - defaultValueCode?: string␊ - _defaultValueCode?: Element1801␊ - /**␊ - * The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false').␊ - */␊ - defaultValueDate?: string␊ - _defaultValueDate?: Element1802␊ - /**␊ - * The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false').␊ - */␊ - defaultValueDateTime?: string␊ - _defaultValueDateTime?: Element1803␊ - /**␊ - * The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false').␊ - */␊ - defaultValueDecimal?: number␊ - _defaultValueDecimal?: Element1804␊ - /**␊ - * The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false').␊ - */␊ - defaultValueId?: string␊ - _defaultValueId?: Element1805␊ - /**␊ - * The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false').␊ - */␊ - defaultValueInstant?: string␊ - _defaultValueInstant?: Element1806␊ - /**␊ - * The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false').␊ - */␊ - defaultValueInteger?: number␊ - _defaultValueInteger?: Element1807␊ - /**␊ - * The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false').␊ - */␊ - defaultValueMarkdown?: string␊ - _defaultValueMarkdown?: Element1808␊ - /**␊ - * The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false').␊ - */␊ - defaultValueOid?: string␊ - _defaultValueOid?: Element1809␊ - /**␊ - * The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false').␊ - */␊ - defaultValuePositiveInt?: number␊ - _defaultValuePositiveInt?: Element1810␊ - /**␊ - * The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false').␊ - */␊ - defaultValueString?: string␊ - _defaultValueString?: Element1811␊ - /**␊ - * The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false').␊ - */␊ - defaultValueTime?: string␊ - _defaultValueTime?: Element1812␊ - /**␊ - * The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false').␊ - */␊ - defaultValueUnsignedInt?: number␊ - _defaultValueUnsignedInt?: Element1813␊ - /**␊ - * The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false').␊ - */␊ - defaultValueUri?: string␊ - _defaultValueUri?: Element1814␊ - /**␊ - * The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false').␊ - */␊ - defaultValueUrl?: string␊ - _defaultValueUrl?: Element1815␊ - /**␊ - * The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false').␊ - */␊ - defaultValueUuid?: string␊ - _defaultValueUuid?: Element1816␊ - defaultValueAddress?: Address13␊ - defaultValueAge?: Age12␊ - defaultValueAnnotation?: Annotation3␊ - defaultValueAttachment?: Attachment22␊ - defaultValueCodeableConcept?: CodeableConcept498␊ - defaultValueCoding?: Coding34␊ - defaultValueContactPoint?: ContactPoint4␊ - defaultValueCount?: Count2␊ - defaultValueDistance?: Distance2␊ - defaultValueDuration?: Duration28␊ - defaultValueHumanName?: HumanName6␊ - defaultValueIdentifier?: Identifier39␊ - defaultValueMoney?: Money53␊ - defaultValuePeriod?: Period117␊ - defaultValueQuantity?: Quantity91␊ - defaultValueRange?: Range33␊ - defaultValueRatio?: Ratio20␊ - defaultValueReference?: Reference435␊ - defaultValueSampledData?: SampledData4␊ - defaultValueSignature?: Signature3␊ - defaultValueTiming?: Timing20␊ - defaultValueContactDetail?: ContactDetail3␊ - defaultValueContributor?: Contributor2␊ - defaultValueDataRequirement?: DataRequirement5␊ - defaultValueExpression?: Expression13␊ - defaultValueParameterDefinition?: ParameterDefinition3␊ - defaultValueRelatedArtifact?: RelatedArtifact3␊ - defaultValueTriggerDefinition?: TriggerDefinition4␊ - defaultValueUsageContext?: UsageContext3␊ - defaultValueDosage?: Dosage3␊ - defaultValueMeta?: Meta130␊ - /**␊ - * A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine␊ - */␊ - meaningWhenMissing?: string␊ - _meaningWhenMissing?: Element1817␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - orderMeaning?: string␊ - _orderMeaning?: Element1818␊ - /**␊ - * Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.␊ - */␊ - fixedBase64Binary?: string␊ - _fixedBase64Binary?: Element1819␊ - /**␊ - * Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.␊ - */␊ - fixedBoolean?: boolean␊ - _fixedBoolean?: Element1820␊ - /**␊ - * Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.␊ - */␊ - fixedCanonical?: string␊ - _fixedCanonical?: Element1821␊ - /**␊ - * Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.␊ - */␊ - fixedCode?: string␊ - _fixedCode?: Element1822␊ - /**␊ - * Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.␊ - */␊ - fixedDate?: string␊ - _fixedDate?: Element1823␊ - /**␊ - * Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.␊ - */␊ - fixedDateTime?: string␊ - _fixedDateTime?: Element1824␊ - /**␊ - * Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.␊ - */␊ - fixedDecimal?: number␊ - _fixedDecimal?: Element1825␊ - /**␊ - * Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.␊ - */␊ - fixedId?: string␊ - _fixedId?: Element1826␊ - /**␊ - * Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.␊ - */␊ - fixedInstant?: string␊ - _fixedInstant?: Element1827␊ - /**␊ - * Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.␊ - */␊ - fixedInteger?: number␊ - _fixedInteger?: Element1828␊ - /**␊ - * Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.␊ - */␊ - fixedMarkdown?: string␊ - _fixedMarkdown?: Element1829␊ - /**␊ - * Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.␊ - */␊ - fixedOid?: string␊ - _fixedOid?: Element1830␊ - /**␊ - * Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.␊ - */␊ - fixedPositiveInt?: number␊ - _fixedPositiveInt?: Element1831␊ - /**␊ - * Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.␊ - */␊ - fixedString?: string␊ - _fixedString?: Element1832␊ - /**␊ - * Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.␊ - */␊ - fixedTime?: string␊ - _fixedTime?: Element1833␊ - /**␊ - * Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.␊ - */␊ - fixedUnsignedInt?: number␊ - _fixedUnsignedInt?: Element1834␊ - /**␊ - * Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.␊ - */␊ - fixedUri?: string␊ - _fixedUri?: Element1835␊ - /**␊ - * Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.␊ - */␊ - fixedUrl?: string␊ - _fixedUrl?: Element1836␊ - /**␊ - * Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.␊ - */␊ - fixedUuid?: string␊ - _fixedUuid?: Element1837␊ - fixedAddress?: Address14␊ - fixedAge?: Age13␊ - fixedAnnotation?: Annotation4␊ - fixedAttachment?: Attachment23␊ - fixedCodeableConcept?: CodeableConcept499␊ - fixedCoding?: Coding35␊ - fixedContactPoint?: ContactPoint5␊ - fixedCount?: Count3␊ - fixedDistance?: Distance3␊ - fixedDuration?: Duration29␊ - fixedHumanName?: HumanName7␊ - fixedIdentifier?: Identifier40␊ - fixedMoney?: Money54␊ - fixedPeriod?: Period118␊ - fixedQuantity?: Quantity92␊ - fixedRange?: Range34␊ - fixedRatio?: Ratio21␊ - fixedReference?: Reference436␊ - fixedSampledData?: SampledData5␊ - fixedSignature?: Signature4␊ - fixedTiming?: Timing21␊ - fixedContactDetail?: ContactDetail4␊ - fixedContributor?: Contributor3␊ - fixedDataRequirement?: DataRequirement6␊ - fixedExpression?: Expression14␊ - fixedParameterDefinition?: ParameterDefinition4␊ - fixedRelatedArtifact?: RelatedArtifact4␊ - fixedTriggerDefinition?: TriggerDefinition5␊ - fixedUsageContext?: UsageContext4␊ - fixedDosage?: Dosage4␊ - fixedMeta?: Meta131␊ - /**␊ - * Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. ␊ - * ␊ - * When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.␊ - * ␊ - * When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.␊ - * ␊ - * When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,␊ - * ␊ - * 1. If primitive: it must match exactly the pattern value␊ - * 2. If a complex object: it must match (recursively) the pattern value␊ - * 3. If an array: it must match (recursively) the pattern value.␊ - */␊ - patternBase64Binary?: string␊ - _patternBase64Binary?: Element1838␊ - /**␊ - * Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. ␊ - * ␊ - * When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.␊ - * ␊ - * When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.␊ - * ␊ - * When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,␊ - * ␊ - * 1. If primitive: it must match exactly the pattern value␊ - * 2. If a complex object: it must match (recursively) the pattern value␊ - * 3. If an array: it must match (recursively) the pattern value.␊ - */␊ - patternBoolean?: boolean␊ - _patternBoolean?: Element1839␊ - /**␊ - * Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. ␊ - * ␊ - * When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.␊ - * ␊ - * When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.␊ - * ␊ - * When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,␊ - * ␊ - * 1. If primitive: it must match exactly the pattern value␊ - * 2. If a complex object: it must match (recursively) the pattern value␊ - * 3. If an array: it must match (recursively) the pattern value.␊ - */␊ - patternCanonical?: string␊ - _patternCanonical?: Element1840␊ - /**␊ - * Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. ␊ - * ␊ - * When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.␊ - * ␊ - * When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.␊ - * ␊ - * When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,␊ - * ␊ - * 1. If primitive: it must match exactly the pattern value␊ - * 2. If a complex object: it must match (recursively) the pattern value␊ - * 3. If an array: it must match (recursively) the pattern value.␊ - */␊ - patternCode?: string␊ - _patternCode?: Element1841␊ - /**␊ - * Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. ␊ - * ␊ - * When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.␊ - * ␊ - * When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.␊ - * ␊ - * When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,␊ - * ␊ - * 1. If primitive: it must match exactly the pattern value␊ - * 2. If a complex object: it must match (recursively) the pattern value␊ - * 3. If an array: it must match (recursively) the pattern value.␊ - */␊ - patternDate?: string␊ - _patternDate?: Element1842␊ - /**␊ - * Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. ␊ - * ␊ - * When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.␊ - * ␊ - * When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.␊ - * ␊ - * When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,␊ - * ␊ - * 1. If primitive: it must match exactly the pattern value␊ - * 2. If a complex object: it must match (recursively) the pattern value␊ - * 3. If an array: it must match (recursively) the pattern value.␊ - */␊ - patternDateTime?: string␊ - _patternDateTime?: Element1843␊ - /**␊ - * Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. ␊ - * ␊ - * When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.␊ - * ␊ - * When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.␊ - * ␊ - * When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,␊ - * ␊ - * 1. If primitive: it must match exactly the pattern value␊ - * 2. If a complex object: it must match (recursively) the pattern value␊ - * 3. If an array: it must match (recursively) the pattern value.␊ - */␊ - patternDecimal?: number␊ - _patternDecimal?: Element1844␊ - /**␊ - * Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. ␊ - * ␊ - * When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.␊ - * ␊ - * When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.␊ - * ␊ - * When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,␊ - * ␊ - * 1. If primitive: it must match exactly the pattern value␊ - * 2. If a complex object: it must match (recursively) the pattern value␊ - * 3. If an array: it must match (recursively) the pattern value.␊ - */␊ - patternId?: string␊ - _patternId?: Element1845␊ - /**␊ - * Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. ␊ - * ␊ - * When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.␊ - * ␊ - * When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.␊ - * ␊ - * When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,␊ - * ␊ - * 1. If primitive: it must match exactly the pattern value␊ - * 2. If a complex object: it must match (recursively) the pattern value␊ - * 3. If an array: it must match (recursively) the pattern value.␊ - */␊ - patternInstant?: string␊ - _patternInstant?: Element1846␊ - /**␊ - * Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. ␊ - * ␊ - * When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.␊ - * ␊ - * When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.␊ - * ␊ - * When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,␊ - * ␊ - * 1. If primitive: it must match exactly the pattern value␊ - * 2. If a complex object: it must match (recursively) the pattern value␊ - * 3. If an array: it must match (recursively) the pattern value.␊ - */␊ - patternInteger?: number␊ - _patternInteger?: Element1847␊ - /**␊ - * Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. ␊ - * ␊ - * When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.␊ - * ␊ - * When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.␊ - * ␊ - * When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,␊ - * ␊ - * 1. If primitive: it must match exactly the pattern value␊ - * 2. If a complex object: it must match (recursively) the pattern value␊ - * 3. If an array: it must match (recursively) the pattern value.␊ - */␊ - patternMarkdown?: string␊ - _patternMarkdown?: Element1848␊ - /**␊ - * Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. ␊ - * ␊ - * When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.␊ - * ␊ - * When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.␊ - * ␊ - * When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,␊ - * ␊ - * 1. If primitive: it must match exactly the pattern value␊ - * 2. If a complex object: it must match (recursively) the pattern value␊ - * 3. If an array: it must match (recursively) the pattern value.␊ - */␊ - patternOid?: string␊ - _patternOid?: Element1849␊ - /**␊ - * Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. ␊ - * ␊ - * When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.␊ - * ␊ - * When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.␊ - * ␊ - * When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,␊ - * ␊ - * 1. If primitive: it must match exactly the pattern value␊ - * 2. If a complex object: it must match (recursively) the pattern value␊ - * 3. If an array: it must match (recursively) the pattern value.␊ - */␊ - patternPositiveInt?: number␊ - _patternPositiveInt?: Element1850␊ - /**␊ - * Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. ␊ - * ␊ - * When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.␊ - * ␊ - * When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.␊ - * ␊ - * When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,␊ - * ␊ - * 1. If primitive: it must match exactly the pattern value␊ - * 2. If a complex object: it must match (recursively) the pattern value␊ - * 3. If an array: it must match (recursively) the pattern value.␊ - */␊ - patternString?: string␊ - _patternString?: Element1851␊ - /**␊ - * Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. ␊ - * ␊ - * When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.␊ - * ␊ - * When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.␊ - * ␊ - * When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,␊ - * ␊ - * 1. If primitive: it must match exactly the pattern value␊ - * 2. If a complex object: it must match (recursively) the pattern value␊ - * 3. If an array: it must match (recursively) the pattern value.␊ - */␊ - patternTime?: string␊ - _patternTime?: Element1852␊ - /**␊ - * Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. ␊ - * ␊ - * When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.␊ - * ␊ - * When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.␊ - * ␊ - * When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,␊ - * ␊ - * 1. If primitive: it must match exactly the pattern value␊ - * 2. If a complex object: it must match (recursively) the pattern value␊ - * 3. If an array: it must match (recursively) the pattern value.␊ - */␊ - patternUnsignedInt?: number␊ - _patternUnsignedInt?: Element1853␊ - /**␊ - * Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. ␊ - * ␊ - * When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.␊ - * ␊ - * When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.␊ - * ␊ - * When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,␊ - * ␊ - * 1. If primitive: it must match exactly the pattern value␊ - * 2. If a complex object: it must match (recursively) the pattern value␊ - * 3. If an array: it must match (recursively) the pattern value.␊ - */␊ - patternUri?: string␊ - _patternUri?: Element1854␊ - /**␊ - * Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. ␊ - * ␊ - * When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.␊ - * ␊ - * When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.␊ - * ␊ - * When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,␊ - * ␊ - * 1. If primitive: it must match exactly the pattern value␊ - * 2. If a complex object: it must match (recursively) the pattern value␊ - * 3. If an array: it must match (recursively) the pattern value.␊ - */␊ - patternUrl?: string␊ - _patternUrl?: Element1855␊ - /**␊ - * Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. ␊ - * ␊ - * When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.␊ - * ␊ - * When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.␊ - * ␊ - * When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,␊ - * ␊ - * 1. If primitive: it must match exactly the pattern value␊ - * 2. If a complex object: it must match (recursively) the pattern value␊ - * 3. If an array: it must match (recursively) the pattern value.␊ - */␊ - patternUuid?: string␊ - _patternUuid?: Element1856␊ - patternAddress?: Address15␊ - patternAge?: Age14␊ - patternAnnotation?: Annotation5␊ - patternAttachment?: Attachment24␊ - patternCodeableConcept?: CodeableConcept500␊ - patternCoding?: Coding36␊ - patternContactPoint?: ContactPoint6␊ - patternCount?: Count4␊ - patternDistance?: Distance4␊ - patternDuration?: Duration30␊ - patternHumanName?: HumanName8␊ - patternIdentifier?: Identifier41␊ - patternMoney?: Money55␊ - patternPeriod?: Period119␊ - patternQuantity?: Quantity93␊ - patternRange?: Range35␊ - patternRatio?: Ratio22␊ - patternReference?: Reference437␊ - patternSampledData?: SampledData6␊ - patternSignature?: Signature5␊ - patternTiming?: Timing22␊ - patternContactDetail?: ContactDetail5␊ - patternContributor?: Contributor4␊ - patternDataRequirement?: DataRequirement7␊ - patternExpression?: Expression15␊ - patternParameterDefinition?: ParameterDefinition5␊ - patternRelatedArtifact?: RelatedArtifact5␊ - patternTriggerDefinition?: TriggerDefinition6␊ - patternUsageContext?: UsageContext5␊ - patternDosage?: Dosage5␊ - patternMeta?: Meta132␊ - /**␊ - * A sample value for this element demonstrating the type of information that would typically be found in the element.␊ - */␊ - example?: ElementDefinition_Example[]␊ - /**␊ - * The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.␊ - */␊ - minValueDate?: string␊ - _minValueDate?: Element1877␊ - /**␊ - * The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.␊ - */␊ - minValueDateTime?: string␊ - _minValueDateTime?: Element1878␊ - /**␊ - * The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.␊ - */␊ - minValueInstant?: string␊ - _minValueInstant?: Element1879␊ - /**␊ - * The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.␊ - */␊ - minValueTime?: string␊ - _minValueTime?: Element1880␊ - /**␊ - * The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.␊ - */␊ - minValueDecimal?: number␊ - _minValueDecimal?: Element1881␊ - /**␊ - * The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.␊ - */␊ - minValueInteger?: number␊ - _minValueInteger?: Element1882␊ - /**␊ - * The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.␊ - */␊ - minValuePositiveInt?: number␊ - _minValuePositiveInt?: Element1883␊ - /**␊ - * The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.␊ - */␊ - minValueUnsignedInt?: number␊ - _minValueUnsignedInt?: Element1884␊ - minValueQuantity?: Quantity95␊ - /**␊ - * The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.␊ - */␊ - maxValueDate?: string␊ - _maxValueDate?: Element1885␊ - /**␊ - * The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.␊ - */␊ - maxValueDateTime?: string␊ - _maxValueDateTime?: Element1886␊ - /**␊ - * The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.␊ - */␊ - maxValueInstant?: string␊ - _maxValueInstant?: Element1887␊ - /**␊ - * The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.␊ - */␊ - maxValueTime?: string␊ - _maxValueTime?: Element1888␊ - /**␊ - * The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.␊ - */␊ - maxValueDecimal?: number␊ - _maxValueDecimal?: Element1889␊ - /**␊ - * The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.␊ - */␊ - maxValueInteger?: number␊ - _maxValueInteger?: Element1890␊ - /**␊ - * The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.␊ - */␊ - maxValuePositiveInt?: number␊ - _maxValuePositiveInt?: Element1891␊ - /**␊ - * The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.␊ - */␊ - maxValueUnsignedInt?: number␊ - _maxValueUnsignedInt?: Element1892␊ - maxValueQuantity?: Quantity96␊ - /**␊ - * A whole number␊ - */␊ - maxLength?: number␊ - _maxLength?: Element1893␊ - /**␊ - * A reference to an invariant that may make additional statements about the cardinality or value in the instance.␊ - */␊ - condition?: Id[]␊ - /**␊ - * Extensions for condition␊ - */␊ - _condition?: Element23[]␊ - /**␊ - * Formal constraints such as co-occurrence and other constraints that can be computationally evaluated within the context of the instance.␊ - */␊ - constraint?: ElementDefinition_Constraint[]␊ - /**␊ - * If true, implementations that produce or consume resources SHALL provide "support" for the element in some meaningful way. If false, the element may be ignored and not supported. If false, whether to populate or use the data element in any way is at the discretion of the implementation.␊ - */␊ - mustSupport?: boolean␊ - _mustSupport?: Element1900␊ - /**␊ - * If true, the value of this element affects the interpretation of the element or resource that contains it, and the value of the element cannot be ignored. Typically, this is used for status, negation and qualification codes. The effect of this is that the element cannot be ignored by systems: they SHALL either recognize the element and process it, and/or a pre-determination has been made that it is not relevant to their particular system.␊ - */␊ - isModifier?: boolean␊ - _isModifier?: Element1901␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - isModifierReason?: string␊ - _isModifierReason?: Element1902␊ - /**␊ - * Whether the element should be included if a client requests a search with the parameter _summary=true.␊ - */␊ - isSummary?: boolean␊ - _isSummary?: Element1903␊ - binding?: ElementDefinition_Binding␊ - /**␊ - * Identifies a concept from an external specification that roughly corresponds to this element.␊ - */␊ - mapping?: ElementDefinition_Mapping[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1777 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1778 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1779 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1780 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Indicates that the element is sliced into a set of alternative definitions (i.e. in a structure definition, there are multiple different constraints on a single element in the base resource). Slicing can be used in any resource that has cardinality ..* on the base resource, or any resource with a choice of types. The set of slices is any elements that come after this in the element sequence that have the same path, until a shorter path occurs (the shorter path terminates the set).␊ - */␊ - export interface ElementDefinition_Slicing {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Designates which child elements are used to discriminate between the slices when processing an instance. If one or more discriminators are provided, the value of the child elements in the instance data SHALL completely distinguish which slice the element in the resource matches based on the allowed values for those elements in each of the slices.␊ - */␊ - discriminator?: ElementDefinition_Discriminator[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element1783␊ - /**␊ - * If the matching elements have to occur in the same order as defined in the profile.␊ - */␊ - ordered?: boolean␊ - _ordered?: Element1784␊ - /**␊ - * Whether additional slices are allowed or not. When the slices are ordered, profile authors can also say that additional slices are only allowed at the end.␊ - */␊ - rules?: ("closed" | "open" | "openAtEnd")␊ - _rules?: Element1785␊ - }␊ - /**␊ - * Captures constraints on each element within the resource, profile, or extension.␊ - */␊ - export interface ElementDefinition_Discriminator {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * How the element value is interpreted when discrimination is evaluated.␊ - */␊ - type?: ("value" | "exists" | "pattern" | "type" | "profile")␊ - _type?: Element1781␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - path?: string␊ - _path?: Element1782␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1781 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1782 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1783 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1784 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1785 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1786 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1787 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1788 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1789 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1790 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1791 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Information about the base definition of the element, provided to make it unnecessary for tools to trace the deviation of the element through the derived and related profiles. When the element definition is not the original definition of an element - i.g. either in a constraint on another type, or for elements from a super type in a snap shot - then the information in provided in the element definition may be different to the base definition. On the original definition of the element, it will be same.␊ - */␊ - export interface ElementDefinition_Base {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - path?: string␊ - _path?: Element1792␊ - /**␊ - * An integer with a value that is not negative (e.g. >= 0)␊ - */␊ - min?: number␊ - _min?: Element1793␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - max?: string␊ - _max?: Element1794␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1792 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1793 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1794 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1795 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Captures constraints on each element within the resource, profile, or extension.␊ - */␊ - export interface ElementDefinition_Type {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - code?: string␊ - _code?: Element1796␊ - /**␊ - * Identifies a profile structure or implementation Guide that applies to the datatype this element refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the type SHALL conform to at least one profile defined in the implementation guide.␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Used when the type is "Reference" or "canonical", and identifies a profile structure or implementation Guide that applies to the target of the reference this element refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the target resource SHALL conform to at least one profile defined in the implementation guide.␊ - */␊ - targetProfile?: Canonical[]␊ - /**␊ - * If the type is a reference to another resource, how the resource is or can be aggregated - is it a contained resource, or a reference, and if the context is a bundle, is it included in the bundle.␊ - */␊ - aggregation?: ("contained" | "referenced" | "bundled")[]␊ - /**␊ - * Extensions for aggregation␊ - */␊ - _aggregation?: Element23[]␊ - /**␊ - * Whether this reference needs to be version specific or version independent, or whether either can be used.␊ - */␊ - versioning?: ("either" | "independent" | "specific")␊ - _versioning?: Element1797␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1796 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1797 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1798 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1799 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1800 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1801 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1802 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1803 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1804 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1805 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1806 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1807 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1808 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1809 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1810 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1811 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1812 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1813 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1814 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1815 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1816 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.␊ - */␊ - export interface Address13 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this address.␊ - */␊ - use?: ("home" | "work" | "temp" | "old" | "billing")␊ - _use?: Element20␊ - /**␊ - * Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.␊ - */␊ - type?: ("postal" | "physical" | "both")␊ - _type?: Element21␊ - /**␊ - * Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.␊ - */␊ - text?: string␊ - _text?: Element22␊ - /**␊ - * This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.␊ - */␊ - line?: String[]␊ - /**␊ - * Extensions for line␊ - */␊ - _line?: Element23[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - city?: string␊ - _city?: Element24␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - district?: string␊ - _district?: Element25␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - state?: string␊ - _state?: Element26␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - postalCode?: string␊ - _postalCode?: Element27␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - country?: string␊ - _country?: Element28␊ - period?: Period␊ - }␊ - /**␊ - * The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false').␊ - */␊ - export interface Age12 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element31␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element32␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element33␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element34␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element35␊ - }␊ - /**␊ - * A text note which also contains information about who made the statement and when.␊ - */␊ - export interface Annotation3 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - authorReference?: Reference␊ - /**␊ - * The individual responsible for making the annotation.␊ - */␊ - authorString?: string␊ - _authorString?: Element48␊ - /**␊ - * Indicates when this particular annotation was made.␊ - */␊ - time?: string␊ - _time?: Element49␊ - /**␊ - * The text of the annotation in markdown format.␊ - */␊ - text?: string␊ - _text?: Element50␊ - }␊ - /**␊ - * For referring to data content defined in other formats.␊ - */␊ - export interface Attachment22 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.␊ - */␊ - contentType?: string␊ - _contentType?: Element51␊ - /**␊ - * The human language of the content. The value can be any valid value according to BCP 47.␊ - */␊ - language?: string␊ - _language?: Element52␊ - /**␊ - * The actual data of the attachment - a sequence of bytes, base64 encoded.␊ - */␊ - data?: string␊ - _data?: Element53␊ - /**␊ - * A location where the data can be accessed.␊ - */␊ - url?: string␊ - _url?: Element54␊ - /**␊ - * The number of bytes of data that make up this attachment (before base64 encoding, if that is done).␊ - */␊ - size?: number␊ - _size?: Element55␊ - /**␊ - * The calculated hash of the data using SHA-1. Represented using base64.␊ - */␊ - hash?: string␊ - _hash?: Element56␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element57␊ - /**␊ - * The date that the attachment was first created.␊ - */␊ - creation?: string␊ - _creation?: Element58␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept498 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - export interface Coding34 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The identification of the code system that defines the meaning of the symbol in the code.␊ - */␊ - system?: string␊ - _system?: Element39␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element40␊ - /**␊ - * A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).␊ - */␊ - code?: string␊ - _code?: Element41␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element42␊ - /**␊ - * Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).␊ - */␊ - userSelected?: boolean␊ - _userSelected?: Element43␊ - }␊ - /**␊ - * Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.␊ - */␊ - export interface ContactPoint4 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Telecommunications form for contact point - what communications system is required to make use of the contact.␊ - */␊ - system?: ("phone" | "fax" | "email" | "pager" | "url" | "sms" | "other")␊ - _system?: Element59␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element60␊ - /**␊ - * Identifies the purpose for the contact point.␊ - */␊ - use?: ("home" | "work" | "temp" | "old" | "mobile")␊ - _use?: Element61␊ - /**␊ - * Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.␊ - */␊ - rank?: number␊ - _rank?: Element62␊ - period?: Period2␊ - }␊ - /**␊ - * The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false').␊ - */␊ - export interface Count2 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element63␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element64␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element65␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element66␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element67␊ - }␊ - /**␊ - * The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false').␊ - */␊ - export interface Distance2 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element68␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element69␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element70␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element71␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element72␊ - }␊ - /**␊ - * The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false').␊ - */␊ - export interface Duration28 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element73␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element74␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element75␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element76␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element77␊ - }␊ - /**␊ - * A human's name with the ability to identify parts and usage.␊ - */␊ - export interface HumanName6 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Identifies the purpose for this name.␊ - */␊ - use?: ("usual" | "official" | "temp" | "nickname" | "anonymous" | "old" | "maiden")␊ - _use?: Element78␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element79␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - family?: string␊ - _family?: Element80␊ - /**␊ - * Given name.␊ - */␊ - given?: String[]␊ - /**␊ - * Extensions for given␊ - */␊ - _given?: Element23[]␊ - /**␊ - * Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.␊ - */␊ - prefix?: String[]␊ - /**␊ - * Extensions for prefix␊ - */␊ - _prefix?: Element23[]␊ - /**␊ - * Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.␊ - */␊ - suffix?: String[]␊ - /**␊ - * Extensions for suffix␊ - */␊ - _suffix?: Element23[]␊ - period?: Period3␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier39 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false').␊ - */␊ - export interface Money53 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period117 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity91 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false').␊ - */␊ - export interface Range33 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - low?: Quantity1␊ - high?: Quantity2␊ - }␊ - /**␊ - * The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false').␊ - */␊ - export interface Ratio20 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - numerator?: Quantity3␊ - denominator?: Quantity4␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference435 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false').␊ - */␊ - export interface SampledData4 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - origin: Quantity5␊ - /**␊ - * The length of time between sampling times, measured in milliseconds.␊ - */␊ - period?: number␊ - _period?: Element88␊ - /**␊ - * A correction factor that is applied to the sampled data points before they are added to the origin.␊ - */␊ - factor?: number␊ - _factor?: Element89␊ - /**␊ - * The lower limit of detection of the measured points. This is needed if any of the data points have the value "L" (lower than detection limit).␊ - */␊ - lowerLimit?: number␊ - _lowerLimit?: Element90␊ - /**␊ - * The upper limit of detection of the measured points. This is needed if any of the data points have the value "U" (higher than detection limit).␊ - */␊ - upperLimit?: number␊ - _upperLimit?: Element91␊ - /**␊ - * The number of sample points at each time point. If this value is greater than one, then the dimensions will be interlaced - all the sample points for a point in time will be recorded at once.␊ - */␊ - dimensions?: number␊ - _dimensions?: Element92␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - data?: string␊ - _data?: Element93␊ - }␊ - /**␊ - * A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities.␊ - */␊ - export interface Signature3 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document.␊ - */␊ - type: Coding[]␊ - /**␊ - * When the digital signature was signed.␊ - */␊ - when?: string␊ - _when?: Element94␊ - who: Reference3␊ - onBehalfOf?: Reference4␊ - /**␊ - * A mime type that indicates the technical format of the target resources signed by the signature.␊ - */␊ - targetFormat?: string␊ - _targetFormat?: Element95␊ - /**␊ - * A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jose for JWS, and image/* for a graphical image of a signature, etc.␊ - */␊ - sigFormat?: string␊ - _sigFormat?: Element96␊ - /**␊ - * The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty.␊ - */␊ - data?: string␊ - _data?: Element97␊ - }␊ - /**␊ - * Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.␊ - */␊ - export interface Timing20 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifies specific times when the event occurs.␊ - */␊ - event?: DateTime[]␊ - /**␊ - * Extensions for event␊ - */␊ - _event?: Element23[]␊ - repeat?: Timing_Repeat␊ - code?: CodeableConcept2␊ - }␊ - /**␊ - * Specifies contact information for a person or organization.␊ - */␊ - export interface ContactDetail3 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element109␊ - /**␊ - * The contact details for the individual (if a name was provided) or the organization.␊ - */␊ - telecom?: ContactPoint1[]␊ - }␊ - /**␊ - * The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false').␊ - */␊ - export interface Contributor2 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The type of contributor.␊ - */␊ - type?: ("author" | "editor" | "reviewer" | "endorser")␊ - _type?: Element110␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element111␊ - /**␊ - * Contact details to assist a user in finding and communicating with the contributor.␊ - */␊ - contact?: ContactDetail1[]␊ - }␊ - /**␊ - * Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.␊ - */␊ - export interface DataRequirement5 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - type?: string␊ - _type?: Element112␊ - /**␊ - * The profile of the required data, specified as the uri of the profile definition.␊ - */␊ - profile?: Canonical[]␊ - subjectCodeableConcept?: CodeableConcept3␊ - subjectReference?: Reference5␊ - /**␊ - * Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. ␊ - * ␊ - * The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details).␊ - */␊ - mustSupport?: String[]␊ - /**␊ - * Extensions for mustSupport␊ - */␊ - _mustSupport?: Element23[]␊ - /**␊ - * Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.␊ - */␊ - codeFilter?: DataRequirement_CodeFilter[]␊ - /**␊ - * Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.␊ - */␊ - dateFilter?: DataRequirement_DateFilter[]␊ - /**␊ - * Specifies a maximum number of results that are required (uses the _count search parameter).␊ - */␊ - limit?: number␊ - _limit?: Element118␊ - /**␊ - * Specifies the order of the results to be returned.␊ - */␊ - sort?: DataRequirement_Sort[]␊ - }␊ - /**␊ - * The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false').␊ - */␊ - export interface Expression13 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element121␊ - /**␊ - * A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.␊ - */␊ - name?: string␊ - _name?: Element122␊ - /**␊ - * The media type of the language for the expression.␊ - */␊ - language?: ("text/cql" | "text/fhirpath" | "application/x-fhir-query")␊ - _language?: Element123␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - expression?: string␊ - _expression?: Element124␊ - /**␊ - * A URI that defines where the expression is found.␊ - */␊ - reference?: string␊ - _reference?: Element125␊ - }␊ - /**␊ - * The parameters to the module. This collection specifies both the input and output parameters. Input parameters are provided by the caller as part of the $evaluate operation. Output parameters are included in the GuidanceResponse.␊ - */␊ - export interface ParameterDefinition3 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - name?: string␊ - _name?: Element126␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - use?: string␊ - _use?: Element127␊ - /**␊ - * The minimum number of times this parameter SHALL appear in the request or response.␊ - */␊ - min?: number␊ - _min?: Element128␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - max?: string␊ - _max?: Element129␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - documentation?: string␊ - _documentation?: Element130␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - type?: string␊ - _type?: Element131␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - profile?: string␊ - }␊ - /**␊ - * Related artifacts such as additional documentation, justification, or bibliographic references.␊ - */␊ - export interface RelatedArtifact3 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The type of relationship to the related artifact.␊ - */␊ - type?: ("documentation" | "justification" | "citation" | "predecessor" | "successor" | "derived-from" | "depends-on" | "composed-of")␊ - _type?: Element132␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - label?: string␊ - _label?: Element133␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element134␊ - /**␊ - * A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.␊ - */␊ - citation?: string␊ - _citation?: Element135␊ - /**␊ - * A url for the artifact that can be followed to access the actual content.␊ - */␊ - url?: string␊ - _url?: Element136␊ - document?: Attachment1␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - resource?: string␊ - }␊ - /**␊ - * A description of a triggering event. Triggering events can be named events, data events, or periodic, as determined by the type element.␊ - */␊ - export interface TriggerDefinition4 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The type of triggering event.␊ - */␊ - type?: ("named-event" | "periodic" | "data-changed" | "data-added" | "data-modified" | "data-removed" | "data-accessed" | "data-access-ended")␊ - _type?: Element137␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element138␊ - timingTiming?: Timing1␊ - timingReference?: Reference6␊ - /**␊ - * The timing of the event (if this is a periodic trigger).␊ - */␊ - timingDate?: string␊ - _timingDate?: Element139␊ - /**␊ - * The timing of the event (if this is a periodic trigger).␊ - */␊ - timingDateTime?: string␊ - _timingDateTime?: Element140␊ - /**␊ - * The triggering data of the event (if this is a data trigger). If more than one data is requirement is specified, then all the data requirements must be true.␊ - */␊ - data?: DataRequirement1[]␊ - condition?: Expression1␊ - }␊ - /**␊ - * Specifies clinical/business/etc. metadata that can be used to retrieve, index and/or categorize an artifact. This metadata can either be specific to the applicable population (e.g., age category, DRG) or the specific context of care (e.g., venue, care setting, provider of care).␊ - */␊ - export interface UsageContext3 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - code: Coding2␊ - valueCodeableConcept?: CodeableConcept4␊ - valueQuantity?: Quantity6␊ - valueRange?: Range2␊ - valueReference?: Reference7␊ - }␊ - /**␊ - * Indicates how the medication is/was taken or should be taken by the patient.␊ - */␊ - export interface Dosage3 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Indicates the order in which the dosage instructions should be applied or interpreted.␊ - */␊ - sequence?: number␊ - _sequence?: Element141␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element142␊ - /**␊ - * Supplemental instructions to the patient on how to take the medication (e.g. "with meals" or"take half to one hour before food") or warnings for the patient about the medication (e.g. "may cause drowsiness" or "avoid exposure of skin to direct sunlight or sunlamps").␊ - */␊ - additionalInstruction?: CodeableConcept5[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - patientInstruction?: string␊ - _patientInstruction?: Element143␊ - timing?: Timing2␊ - /**␊ - * Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).␊ - */␊ - asNeededBoolean?: boolean␊ - _asNeededBoolean?: Element144␊ - asNeededCodeableConcept?: CodeableConcept6␊ - site?: CodeableConcept7␊ - route?: CodeableConcept8␊ - method?: CodeableConcept9␊ - /**␊ - * The amount of medication administered.␊ - */␊ - doseAndRate?: Dosage_DoseAndRate[]␊ - maxDosePerPeriod?: Ratio2␊ - maxDosePerAdministration?: Quantity9␊ - maxDosePerLifetime?: Quantity10␊ - }␊ - /**␊ - * The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false').␊ - */␊ - export interface Meta130 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1817 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1818 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1819 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1820 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1821 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1822 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1823 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1824 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1825 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1826 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1827 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1828 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1829 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1830 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1831 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1832 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1833 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1834 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1835 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1836 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1837 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.␊ - */␊ - export interface Address14 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this address.␊ - */␊ - use?: ("home" | "work" | "temp" | "old" | "billing")␊ - _use?: Element20␊ - /**␊ - * Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.␊ - */␊ - type?: ("postal" | "physical" | "both")␊ - _type?: Element21␊ - /**␊ - * Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.␊ - */␊ - text?: string␊ - _text?: Element22␊ - /**␊ - * This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.␊ - */␊ - line?: String[]␊ - /**␊ - * Extensions for line␊ - */␊ - _line?: Element23[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - city?: string␊ - _city?: Element24␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - district?: string␊ - _district?: Element25␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - state?: string␊ - _state?: Element26␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - postalCode?: string␊ - _postalCode?: Element27␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - country?: string␊ - _country?: Element28␊ - period?: Period␊ - }␊ - /**␊ - * Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.␊ - */␊ - export interface Age13 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element31␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element32␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element33␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element34␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element35␊ - }␊ - /**␊ - * A text note which also contains information about who made the statement and when.␊ - */␊ - export interface Annotation4 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - authorReference?: Reference␊ - /**␊ - * The individual responsible for making the annotation.␊ - */␊ - authorString?: string␊ - _authorString?: Element48␊ - /**␊ - * Indicates when this particular annotation was made.␊ - */␊ - time?: string␊ - _time?: Element49␊ - /**␊ - * The text of the annotation in markdown format.␊ - */␊ - text?: string␊ - _text?: Element50␊ - }␊ - /**␊ - * For referring to data content defined in other formats.␊ - */␊ - export interface Attachment23 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.␊ - */␊ - contentType?: string␊ - _contentType?: Element51␊ - /**␊ - * The human language of the content. The value can be any valid value according to BCP 47.␊ - */␊ - language?: string␊ - _language?: Element52␊ - /**␊ - * The actual data of the attachment - a sequence of bytes, base64 encoded.␊ - */␊ - data?: string␊ - _data?: Element53␊ - /**␊ - * A location where the data can be accessed.␊ - */␊ - url?: string␊ - _url?: Element54␊ - /**␊ - * The number of bytes of data that make up this attachment (before base64 encoding, if that is done).␊ - */␊ - size?: number␊ - _size?: Element55␊ - /**␊ - * The calculated hash of the data using SHA-1. Represented using base64.␊ - */␊ - hash?: string␊ - _hash?: Element56␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element57␊ - /**␊ - * The date that the attachment was first created.␊ - */␊ - creation?: string␊ - _creation?: Element58␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept499 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - export interface Coding35 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The identification of the code system that defines the meaning of the symbol in the code.␊ - */␊ - system?: string␊ - _system?: Element39␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element40␊ - /**␊ - * A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).␊ - */␊ - code?: string␊ - _code?: Element41␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element42␊ - /**␊ - * Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).␊ - */␊ - userSelected?: boolean␊ - _userSelected?: Element43␊ - }␊ - /**␊ - * Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.␊ - */␊ - export interface ContactPoint5 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Telecommunications form for contact point - what communications system is required to make use of the contact.␊ - */␊ - system?: ("phone" | "fax" | "email" | "pager" | "url" | "sms" | "other")␊ - _system?: Element59␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element60␊ - /**␊ - * Identifies the purpose for the contact point.␊ - */␊ - use?: ("home" | "work" | "temp" | "old" | "mobile")␊ - _use?: Element61␊ - /**␊ - * Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.␊ - */␊ - rank?: number␊ - _rank?: Element62␊ - period?: Period2␊ - }␊ - /**␊ - * Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.␊ - */␊ - export interface Count3 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element63␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element64␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element65␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element66␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element67␊ - }␊ - /**␊ - * Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.␊ - */␊ - export interface Distance3 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element68␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element69␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element70␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element71␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element72␊ - }␊ - /**␊ - * Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.␊ - */␊ - export interface Duration29 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element73␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element74␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element75␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element76␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element77␊ - }␊ - /**␊ - * A human's name with the ability to identify parts and usage.␊ - */␊ - export interface HumanName7 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Identifies the purpose for this name.␊ - */␊ - use?: ("usual" | "official" | "temp" | "nickname" | "anonymous" | "old" | "maiden")␊ - _use?: Element78␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element79␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - family?: string␊ - _family?: Element80␊ - /**␊ - * Given name.␊ - */␊ - given?: String[]␊ - /**␊ - * Extensions for given␊ - */␊ - _given?: Element23[]␊ - /**␊ - * Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.␊ - */␊ - prefix?: String[]␊ - /**␊ - * Extensions for prefix␊ - */␊ - _prefix?: Element23[]␊ - /**␊ - * Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.␊ - */␊ - suffix?: String[]␊ - /**␊ - * Extensions for suffix␊ - */␊ - _suffix?: Element23[]␊ - period?: Period3␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier40 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.␊ - */␊ - export interface Money54 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period118 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity92 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.␊ - */␊ - export interface Range34 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - low?: Quantity1␊ - high?: Quantity2␊ - }␊ - /**␊ - * Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.␊ - */␊ - export interface Ratio21 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - numerator?: Quantity3␊ - denominator?: Quantity4␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference436 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.␊ - */␊ - export interface SampledData5 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - origin: Quantity5␊ - /**␊ - * The length of time between sampling times, measured in milliseconds.␊ - */␊ - period?: number␊ - _period?: Element88␊ - /**␊ - * A correction factor that is applied to the sampled data points before they are added to the origin.␊ - */␊ - factor?: number␊ - _factor?: Element89␊ - /**␊ - * The lower limit of detection of the measured points. This is needed if any of the data points have the value "L" (lower than detection limit).␊ - */␊ - lowerLimit?: number␊ - _lowerLimit?: Element90␊ - /**␊ - * The upper limit of detection of the measured points. This is needed if any of the data points have the value "U" (higher than detection limit).␊ - */␊ - upperLimit?: number␊ - _upperLimit?: Element91␊ - /**␊ - * The number of sample points at each time point. If this value is greater than one, then the dimensions will be interlaced - all the sample points for a point in time will be recorded at once.␊ - */␊ - dimensions?: number␊ - _dimensions?: Element92␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - data?: string␊ - _data?: Element93␊ - }␊ - /**␊ - * A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities.␊ - */␊ - export interface Signature4 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document.␊ - */␊ - type: Coding[]␊ - /**␊ - * When the digital signature was signed.␊ - */␊ - when?: string␊ - _when?: Element94␊ - who: Reference3␊ - onBehalfOf?: Reference4␊ - /**␊ - * A mime type that indicates the technical format of the target resources signed by the signature.␊ - */␊ - targetFormat?: string␊ - _targetFormat?: Element95␊ - /**␊ - * A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jose for JWS, and image/* for a graphical image of a signature, etc.␊ - */␊ - sigFormat?: string␊ - _sigFormat?: Element96␊ - /**␊ - * The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty.␊ - */␊ - data?: string␊ - _data?: Element97␊ - }␊ - /**␊ - * Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.␊ - */␊ - export interface Timing21 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifies specific times when the event occurs.␊ - */␊ - event?: DateTime[]␊ - /**␊ - * Extensions for event␊ - */␊ - _event?: Element23[]␊ - repeat?: Timing_Repeat␊ - code?: CodeableConcept2␊ - }␊ - /**␊ - * Specifies contact information for a person or organization.␊ - */␊ - export interface ContactDetail4 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element109␊ - /**␊ - * The contact details for the individual (if a name was provided) or the organization.␊ - */␊ - telecom?: ContactPoint1[]␊ - }␊ - /**␊ - * Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.␊ - */␊ - export interface Contributor3 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The type of contributor.␊ - */␊ - type?: ("author" | "editor" | "reviewer" | "endorser")␊ - _type?: Element110␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element111␊ - /**␊ - * Contact details to assist a user in finding and communicating with the contributor.␊ - */␊ - contact?: ContactDetail1[]␊ - }␊ - /**␊ - * Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.␊ - */␊ - export interface DataRequirement6 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - type?: string␊ - _type?: Element112␊ - /**␊ - * The profile of the required data, specified as the uri of the profile definition.␊ - */␊ - profile?: Canonical[]␊ - subjectCodeableConcept?: CodeableConcept3␊ - subjectReference?: Reference5␊ - /**␊ - * Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. ␊ - * ␊ - * The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details).␊ - */␊ - mustSupport?: String[]␊ - /**␊ - * Extensions for mustSupport␊ - */␊ - _mustSupport?: Element23[]␊ - /**␊ - * Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.␊ - */␊ - codeFilter?: DataRequirement_CodeFilter[]␊ - /**␊ - * Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.␊ - */␊ - dateFilter?: DataRequirement_DateFilter[]␊ - /**␊ - * Specifies a maximum number of results that are required (uses the _count search parameter).␊ - */␊ - limit?: number␊ - _limit?: Element118␊ - /**␊ - * Specifies the order of the results to be returned.␊ - */␊ - sort?: DataRequirement_Sort[]␊ - }␊ - /**␊ - * Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.␊ - */␊ - export interface Expression14 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element121␊ - /**␊ - * A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.␊ - */␊ - name?: string␊ - _name?: Element122␊ - /**␊ - * The media type of the language for the expression.␊ - */␊ - language?: ("text/cql" | "text/fhirpath" | "application/x-fhir-query")␊ - _language?: Element123␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - expression?: string␊ - _expression?: Element124␊ - /**␊ - * A URI that defines where the expression is found.␊ - */␊ - reference?: string␊ - _reference?: Element125␊ - }␊ - /**␊ - * The parameters to the module. This collection specifies both the input and output parameters. Input parameters are provided by the caller as part of the $evaluate operation. Output parameters are included in the GuidanceResponse.␊ - */␊ - export interface ParameterDefinition4 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - name?: string␊ - _name?: Element126␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - use?: string␊ - _use?: Element127␊ - /**␊ - * The minimum number of times this parameter SHALL appear in the request or response.␊ - */␊ - min?: number␊ - _min?: Element128␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - max?: string␊ - _max?: Element129␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - documentation?: string␊ - _documentation?: Element130␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - type?: string␊ - _type?: Element131␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - profile?: string␊ - }␊ - /**␊ - * Related artifacts such as additional documentation, justification, or bibliographic references.␊ - */␊ - export interface RelatedArtifact4 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The type of relationship to the related artifact.␊ - */␊ - type?: ("documentation" | "justification" | "citation" | "predecessor" | "successor" | "derived-from" | "depends-on" | "composed-of")␊ - _type?: Element132␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - label?: string␊ - _label?: Element133␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element134␊ - /**␊ - * A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.␊ - */␊ - citation?: string␊ - _citation?: Element135␊ - /**␊ - * A url for the artifact that can be followed to access the actual content.␊ - */␊ - url?: string␊ - _url?: Element136␊ - document?: Attachment1␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - resource?: string␊ - }␊ - /**␊ - * A description of a triggering event. Triggering events can be named events, data events, or periodic, as determined by the type element.␊ - */␊ - export interface TriggerDefinition5 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The type of triggering event.␊ - */␊ - type?: ("named-event" | "periodic" | "data-changed" | "data-added" | "data-modified" | "data-removed" | "data-accessed" | "data-access-ended")␊ - _type?: Element137␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element138␊ - timingTiming?: Timing1␊ - timingReference?: Reference6␊ - /**␊ - * The timing of the event (if this is a periodic trigger).␊ - */␊ - timingDate?: string␊ - _timingDate?: Element139␊ - /**␊ - * The timing of the event (if this is a periodic trigger).␊ - */␊ - timingDateTime?: string␊ - _timingDateTime?: Element140␊ - /**␊ - * The triggering data of the event (if this is a data trigger). If more than one data is requirement is specified, then all the data requirements must be true.␊ - */␊ - data?: DataRequirement1[]␊ - condition?: Expression1␊ - }␊ - /**␊ - * Specifies clinical/business/etc. metadata that can be used to retrieve, index and/or categorize an artifact. This metadata can either be specific to the applicable population (e.g., age category, DRG) or the specific context of care (e.g., venue, care setting, provider of care).␊ - */␊ - export interface UsageContext4 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - code: Coding2␊ - valueCodeableConcept?: CodeableConcept4␊ - valueQuantity?: Quantity6␊ - valueRange?: Range2␊ - valueReference?: Reference7␊ - }␊ - /**␊ - * Indicates how the medication is/was taken or should be taken by the patient.␊ - */␊ - export interface Dosage4 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Indicates the order in which the dosage instructions should be applied or interpreted.␊ - */␊ - sequence?: number␊ - _sequence?: Element141␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element142␊ - /**␊ - * Supplemental instructions to the patient on how to take the medication (e.g. "with meals" or"take half to one hour before food") or warnings for the patient about the medication (e.g. "may cause drowsiness" or "avoid exposure of skin to direct sunlight or sunlamps").␊ - */␊ - additionalInstruction?: CodeableConcept5[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - patientInstruction?: string␊ - _patientInstruction?: Element143␊ - timing?: Timing2␊ - /**␊ - * Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).␊ - */␊ - asNeededBoolean?: boolean␊ - _asNeededBoolean?: Element144␊ - asNeededCodeableConcept?: CodeableConcept6␊ - site?: CodeableConcept7␊ - route?: CodeableConcept8␊ - method?: CodeableConcept9␊ - /**␊ - * The amount of medication administered.␊ - */␊ - doseAndRate?: Dosage_DoseAndRate[]␊ - maxDosePerPeriod?: Ratio2␊ - maxDosePerAdministration?: Quantity9␊ - maxDosePerLifetime?: Quantity10␊ - }␊ - /**␊ - * Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.␊ - */␊ - export interface Meta131 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1838 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1839 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1840 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1841 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1842 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1843 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1844 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1845 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1846 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1847 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1848 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1849 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1850 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1851 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1852 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1853 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1854 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1855 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1856 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.␊ - */␊ - export interface Address15 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this address.␊ - */␊ - use?: ("home" | "work" | "temp" | "old" | "billing")␊ - _use?: Element20␊ - /**␊ - * Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.␊ - */␊ - type?: ("postal" | "physical" | "both")␊ - _type?: Element21␊ - /**␊ - * Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.␊ - */␊ - text?: string␊ - _text?: Element22␊ - /**␊ - * This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.␊ - */␊ - line?: String[]␊ - /**␊ - * Extensions for line␊ - */␊ - _line?: Element23[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - city?: string␊ - _city?: Element24␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - district?: string␊ - _district?: Element25␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - state?: string␊ - _state?: Element26␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - postalCode?: string␊ - _postalCode?: Element27␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - country?: string␊ - _country?: Element28␊ - period?: Period␊ - }␊ - /**␊ - * Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. ␊ - * ␊ - * When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.␊ - * ␊ - * When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.␊ - * ␊ - * When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,␊ - * ␊ - * 1. If primitive: it must match exactly the pattern value␊ - * 2. If a complex object: it must match (recursively) the pattern value␊ - * 3. If an array: it must match (recursively) the pattern value.␊ - */␊ - export interface Age14 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element31␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element32␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element33␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element34␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element35␊ - }␊ - /**␊ - * A text note which also contains information about who made the statement and when.␊ - */␊ - export interface Annotation5 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - authorReference?: Reference␊ - /**␊ - * The individual responsible for making the annotation.␊ - */␊ - authorString?: string␊ - _authorString?: Element48␊ - /**␊ - * Indicates when this particular annotation was made.␊ - */␊ - time?: string␊ - _time?: Element49␊ - /**␊ - * The text of the annotation in markdown format.␊ - */␊ - text?: string␊ - _text?: Element50␊ - }␊ - /**␊ - * For referring to data content defined in other formats.␊ - */␊ - export interface Attachment24 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.␊ - */␊ - contentType?: string␊ - _contentType?: Element51␊ - /**␊ - * The human language of the content. The value can be any valid value according to BCP 47.␊ - */␊ - language?: string␊ - _language?: Element52␊ - /**␊ - * The actual data of the attachment - a sequence of bytes, base64 encoded.␊ - */␊ - data?: string␊ - _data?: Element53␊ - /**␊ - * A location where the data can be accessed.␊ - */␊ - url?: string␊ - _url?: Element54␊ - /**␊ - * The number of bytes of data that make up this attachment (before base64 encoding, if that is done).␊ - */␊ - size?: number␊ - _size?: Element55␊ - /**␊ - * The calculated hash of the data using SHA-1. Represented using base64.␊ - */␊ - hash?: string␊ - _hash?: Element56␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element57␊ - /**␊ - * The date that the attachment was first created.␊ - */␊ - creation?: string␊ - _creation?: Element58␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept500 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - export interface Coding36 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The identification of the code system that defines the meaning of the symbol in the code.␊ - */␊ - system?: string␊ - _system?: Element39␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element40␊ - /**␊ - * A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).␊ - */␊ - code?: string␊ - _code?: Element41␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element42␊ - /**␊ - * Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).␊ - */␊ - userSelected?: boolean␊ - _userSelected?: Element43␊ - }␊ - /**␊ - * Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.␊ - */␊ - export interface ContactPoint6 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Telecommunications form for contact point - what communications system is required to make use of the contact.␊ - */␊ - system?: ("phone" | "fax" | "email" | "pager" | "url" | "sms" | "other")␊ - _system?: Element59␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element60␊ - /**␊ - * Identifies the purpose for the contact point.␊ - */␊ - use?: ("home" | "work" | "temp" | "old" | "mobile")␊ - _use?: Element61␊ - /**␊ - * Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.␊ - */␊ - rank?: number␊ - _rank?: Element62␊ - period?: Period2␊ - }␊ - /**␊ - * Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. ␊ - * ␊ - * When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.␊ - * ␊ - * When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.␊ - * ␊ - * When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,␊ - * ␊ - * 1. If primitive: it must match exactly the pattern value␊ - * 2. If a complex object: it must match (recursively) the pattern value␊ - * 3. If an array: it must match (recursively) the pattern value.␊ - */␊ - export interface Count4 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element63␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element64␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element65␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element66␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element67␊ - }␊ - /**␊ - * Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. ␊ - * ␊ - * When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.␊ - * ␊ - * When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.␊ - * ␊ - * When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,␊ - * ␊ - * 1. If primitive: it must match exactly the pattern value␊ - * 2. If a complex object: it must match (recursively) the pattern value␊ - * 3. If an array: it must match (recursively) the pattern value.␊ - */␊ - export interface Distance4 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element68␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element69␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element70␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element71␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element72␊ - }␊ - /**␊ - * Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. ␊ - * ␊ - * When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.␊ - * ␊ - * When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.␊ - * ␊ - * When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,␊ - * ␊ - * 1. If primitive: it must match exactly the pattern value␊ - * 2. If a complex object: it must match (recursively) the pattern value␊ - * 3. If an array: it must match (recursively) the pattern value.␊ - */␊ - export interface Duration30 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element73␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element74␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element75␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element76␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element77␊ - }␊ - /**␊ - * A human's name with the ability to identify parts and usage.␊ - */␊ - export interface HumanName8 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Identifies the purpose for this name.␊ - */␊ - use?: ("usual" | "official" | "temp" | "nickname" | "anonymous" | "old" | "maiden")␊ - _use?: Element78␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element79␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - family?: string␊ - _family?: Element80␊ - /**␊ - * Given name.␊ - */␊ - given?: String[]␊ - /**␊ - * Extensions for given␊ - */␊ - _given?: Element23[]␊ - /**␊ - * Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.␊ - */␊ - prefix?: String[]␊ - /**␊ - * Extensions for prefix␊ - */␊ - _prefix?: Element23[]␊ - /**␊ - * Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.␊ - */␊ - suffix?: String[]␊ - /**␊ - * Extensions for suffix␊ - */␊ - _suffix?: Element23[]␊ - period?: Period3␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier41 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. ␊ - * ␊ - * When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.␊ - * ␊ - * When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.␊ - * ␊ - * When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,␊ - * ␊ - * 1. If primitive: it must match exactly the pattern value␊ - * 2. If a complex object: it must match (recursively) the pattern value␊ - * 3. If an array: it must match (recursively) the pattern value.␊ - */␊ - export interface Money55 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period119 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity93 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. ␊ - * ␊ - * When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.␊ - * ␊ - * When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.␊ - * ␊ - * When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,␊ - * ␊ - * 1. If primitive: it must match exactly the pattern value␊ - * 2. If a complex object: it must match (recursively) the pattern value␊ - * 3. If an array: it must match (recursively) the pattern value.␊ - */␊ - export interface Range35 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - low?: Quantity1␊ - high?: Quantity2␊ - }␊ - /**␊ - * Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. ␊ - * ␊ - * When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.␊ - * ␊ - * When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.␊ - * ␊ - * When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,␊ - * ␊ - * 1. If primitive: it must match exactly the pattern value␊ - * 2. If a complex object: it must match (recursively) the pattern value␊ - * 3. If an array: it must match (recursively) the pattern value.␊ - */␊ - export interface Ratio22 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - numerator?: Quantity3␊ - denominator?: Quantity4␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference437 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. ␊ - * ␊ - * When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.␊ - * ␊ - * When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.␊ - * ␊ - * When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,␊ - * ␊ - * 1. If primitive: it must match exactly the pattern value␊ - * 2. If a complex object: it must match (recursively) the pattern value␊ - * 3. If an array: it must match (recursively) the pattern value.␊ - */␊ - export interface SampledData6 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - origin: Quantity5␊ - /**␊ - * The length of time between sampling times, measured in milliseconds.␊ - */␊ - period?: number␊ - _period?: Element88␊ - /**␊ - * A correction factor that is applied to the sampled data points before they are added to the origin.␊ - */␊ - factor?: number␊ - _factor?: Element89␊ - /**␊ - * The lower limit of detection of the measured points. This is needed if any of the data points have the value "L" (lower than detection limit).␊ - */␊ - lowerLimit?: number␊ - _lowerLimit?: Element90␊ - /**␊ - * The upper limit of detection of the measured points. This is needed if any of the data points have the value "U" (higher than detection limit).␊ - */␊ - upperLimit?: number␊ - _upperLimit?: Element91␊ - /**␊ - * The number of sample points at each time point. If this value is greater than one, then the dimensions will be interlaced - all the sample points for a point in time will be recorded at once.␊ - */␊ - dimensions?: number␊ - _dimensions?: Element92␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - data?: string␊ - _data?: Element93␊ - }␊ - /**␊ - * A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities.␊ - */␊ - export interface Signature5 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document.␊ - */␊ - type: Coding[]␊ - /**␊ - * When the digital signature was signed.␊ - */␊ - when?: string␊ - _when?: Element94␊ - who: Reference3␊ - onBehalfOf?: Reference4␊ - /**␊ - * A mime type that indicates the technical format of the target resources signed by the signature.␊ - */␊ - targetFormat?: string␊ - _targetFormat?: Element95␊ - /**␊ - * A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jose for JWS, and image/* for a graphical image of a signature, etc.␊ - */␊ - sigFormat?: string␊ - _sigFormat?: Element96␊ - /**␊ - * The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty.␊ - */␊ - data?: string␊ - _data?: Element97␊ - }␊ - /**␊ - * Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.␊ - */␊ - export interface Timing22 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifies specific times when the event occurs.␊ - */␊ - event?: DateTime[]␊ - /**␊ - * Extensions for event␊ - */␊ - _event?: Element23[]␊ - repeat?: Timing_Repeat␊ - code?: CodeableConcept2␊ - }␊ - /**␊ - * Specifies contact information for a person or organization.␊ - */␊ - export interface ContactDetail5 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element109␊ - /**␊ - * The contact details for the individual (if a name was provided) or the organization.␊ - */␊ - telecom?: ContactPoint1[]␊ - }␊ - /**␊ - * Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. ␊ - * ␊ - * When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.␊ - * ␊ - * When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.␊ - * ␊ - * When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,␊ - * ␊ - * 1. If primitive: it must match exactly the pattern value␊ - * 2. If a complex object: it must match (recursively) the pattern value␊ - * 3. If an array: it must match (recursively) the pattern value.␊ - */␊ - export interface Contributor4 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The type of contributor.␊ - */␊ - type?: ("author" | "editor" | "reviewer" | "endorser")␊ - _type?: Element110␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element111␊ - /**␊ - * Contact details to assist a user in finding and communicating with the contributor.␊ - */␊ - contact?: ContactDetail1[]␊ - }␊ - /**␊ - * Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.␊ - */␊ - export interface DataRequirement7 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - type?: string␊ - _type?: Element112␊ - /**␊ - * The profile of the required data, specified as the uri of the profile definition.␊ - */␊ - profile?: Canonical[]␊ - subjectCodeableConcept?: CodeableConcept3␊ - subjectReference?: Reference5␊ - /**␊ - * Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. ␊ - * ␊ - * The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details).␊ - */␊ - mustSupport?: String[]␊ - /**␊ - * Extensions for mustSupport␊ - */␊ - _mustSupport?: Element23[]␊ - /**␊ - * Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.␊ - */␊ - codeFilter?: DataRequirement_CodeFilter[]␊ - /**␊ - * Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.␊ - */␊ - dateFilter?: DataRequirement_DateFilter[]␊ - /**␊ - * Specifies a maximum number of results that are required (uses the _count search parameter).␊ - */␊ - limit?: number␊ - _limit?: Element118␊ - /**␊ - * Specifies the order of the results to be returned.␊ - */␊ - sort?: DataRequirement_Sort[]␊ - }␊ - /**␊ - * Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. ␊ - * ␊ - * When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.␊ - * ␊ - * When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.␊ - * ␊ - * When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,␊ - * ␊ - * 1. If primitive: it must match exactly the pattern value␊ - * 2. If a complex object: it must match (recursively) the pattern value␊ - * 3. If an array: it must match (recursively) the pattern value.␊ - */␊ - export interface Expression15 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element121␊ - /**␊ - * A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.␊ - */␊ - name?: string␊ - _name?: Element122␊ - /**␊ - * The media type of the language for the expression.␊ - */␊ - language?: ("text/cql" | "text/fhirpath" | "application/x-fhir-query")␊ - _language?: Element123␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - expression?: string␊ - _expression?: Element124␊ - /**␊ - * A URI that defines where the expression is found.␊ - */␊ - reference?: string␊ - _reference?: Element125␊ - }␊ - /**␊ - * The parameters to the module. This collection specifies both the input and output parameters. Input parameters are provided by the caller as part of the $evaluate operation. Output parameters are included in the GuidanceResponse.␊ - */␊ - export interface ParameterDefinition5 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - name?: string␊ - _name?: Element126␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - use?: string␊ - _use?: Element127␊ - /**␊ - * The minimum number of times this parameter SHALL appear in the request or response.␊ - */␊ - min?: number␊ - _min?: Element128␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - max?: string␊ - _max?: Element129␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - documentation?: string␊ - _documentation?: Element130␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - type?: string␊ - _type?: Element131␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - profile?: string␊ - }␊ - /**␊ - * Related artifacts such as additional documentation, justification, or bibliographic references.␊ - */␊ - export interface RelatedArtifact5 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The type of relationship to the related artifact.␊ - */␊ - type?: ("documentation" | "justification" | "citation" | "predecessor" | "successor" | "derived-from" | "depends-on" | "composed-of")␊ - _type?: Element132␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - label?: string␊ - _label?: Element133␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element134␊ - /**␊ - * A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.␊ - */␊ - citation?: string␊ - _citation?: Element135␊ - /**␊ - * A url for the artifact that can be followed to access the actual content.␊ - */␊ - url?: string␊ - _url?: Element136␊ - document?: Attachment1␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - resource?: string␊ - }␊ - /**␊ - * A description of a triggering event. Triggering events can be named events, data events, or periodic, as determined by the type element.␊ - */␊ - export interface TriggerDefinition6 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The type of triggering event.␊ - */␊ - type?: ("named-event" | "periodic" | "data-changed" | "data-added" | "data-modified" | "data-removed" | "data-accessed" | "data-access-ended")␊ - _type?: Element137␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element138␊ - timingTiming?: Timing1␊ - timingReference?: Reference6␊ - /**␊ - * The timing of the event (if this is a periodic trigger).␊ - */␊ - timingDate?: string␊ - _timingDate?: Element139␊ - /**␊ - * The timing of the event (if this is a periodic trigger).␊ - */␊ - timingDateTime?: string␊ - _timingDateTime?: Element140␊ - /**␊ - * The triggering data of the event (if this is a data trigger). If more than one data is requirement is specified, then all the data requirements must be true.␊ - */␊ - data?: DataRequirement1[]␊ - condition?: Expression1␊ - }␊ - /**␊ - * Specifies clinical/business/etc. metadata that can be used to retrieve, index and/or categorize an artifact. This metadata can either be specific to the applicable population (e.g., age category, DRG) or the specific context of care (e.g., venue, care setting, provider of care).␊ - */␊ - export interface UsageContext5 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - code: Coding2␊ - valueCodeableConcept?: CodeableConcept4␊ - valueQuantity?: Quantity6␊ - valueRange?: Range2␊ - valueReference?: Reference7␊ - }␊ - /**␊ - * Indicates how the medication is/was taken or should be taken by the patient.␊ - */␊ - export interface Dosage5 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Indicates the order in which the dosage instructions should be applied or interpreted.␊ - */␊ - sequence?: number␊ - _sequence?: Element141␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element142␊ - /**␊ - * Supplemental instructions to the patient on how to take the medication (e.g. "with meals" or"take half to one hour before food") or warnings for the patient about the medication (e.g. "may cause drowsiness" or "avoid exposure of skin to direct sunlight or sunlamps").␊ - */␊ - additionalInstruction?: CodeableConcept5[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - patientInstruction?: string␊ - _patientInstruction?: Element143␊ - timing?: Timing2␊ - /**␊ - * Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).␊ - */␊ - asNeededBoolean?: boolean␊ - _asNeededBoolean?: Element144␊ - asNeededCodeableConcept?: CodeableConcept6␊ - site?: CodeableConcept7␊ - route?: CodeableConcept8␊ - method?: CodeableConcept9␊ - /**␊ - * The amount of medication administered.␊ - */␊ - doseAndRate?: Dosage_DoseAndRate[]␊ - maxDosePerPeriod?: Ratio2␊ - maxDosePerAdministration?: Quantity9␊ - maxDosePerLifetime?: Quantity10␊ - }␊ - /**␊ - * Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. ␊ - * ␊ - * When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.␊ - * ␊ - * When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.␊ - * ␊ - * When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,␊ - * ␊ - * 1. If primitive: it must match exactly the pattern value␊ - * 2. If a complex object: it must match (recursively) the pattern value␊ - * 3. If an array: it must match (recursively) the pattern value.␊ - */␊ - export interface Meta132 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Captures constraints on each element within the resource, profile, or extension.␊ - */␊ - export interface ElementDefinition_Example {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - label?: string␊ - _label?: Element1857␊ - /**␊ - * The actual value for the element, which must be one of the types allowed for this element.␊ - */␊ - valueBase64Binary?: string␊ - _valueBase64Binary?: Element1858␊ - /**␊ - * The actual value for the element, which must be one of the types allowed for this element.␊ - */␊ - valueBoolean?: boolean␊ - _valueBoolean?: Element1859␊ - /**␊ - * The actual value for the element, which must be one of the types allowed for this element.␊ - */␊ - valueCanonical?: string␊ - _valueCanonical?: Element1860␊ - /**␊ - * The actual value for the element, which must be one of the types allowed for this element.␊ - */␊ - valueCode?: string␊ - _valueCode?: Element1861␊ - /**␊ - * The actual value for the element, which must be one of the types allowed for this element.␊ - */␊ - valueDate?: string␊ - _valueDate?: Element1862␊ - /**␊ - * The actual value for the element, which must be one of the types allowed for this element.␊ - */␊ - valueDateTime?: string␊ - _valueDateTime?: Element1863␊ - /**␊ - * The actual value for the element, which must be one of the types allowed for this element.␊ - */␊ - valueDecimal?: number␊ - _valueDecimal?: Element1864␊ - /**␊ - * The actual value for the element, which must be one of the types allowed for this element.␊ - */␊ - valueId?: string␊ - _valueId?: Element1865␊ - /**␊ - * The actual value for the element, which must be one of the types allowed for this element.␊ - */␊ - valueInstant?: string␊ - _valueInstant?: Element1866␊ - /**␊ - * The actual value for the element, which must be one of the types allowed for this element.␊ - */␊ - valueInteger?: number␊ - _valueInteger?: Element1867␊ - /**␊ - * The actual value for the element, which must be one of the types allowed for this element.␊ - */␊ - valueMarkdown?: string␊ - _valueMarkdown?: Element1868␊ - /**␊ - * The actual value for the element, which must be one of the types allowed for this element.␊ - */␊ - valueOid?: string␊ - _valueOid?: Element1869␊ - /**␊ - * The actual value for the element, which must be one of the types allowed for this element.␊ - */␊ - valuePositiveInt?: number␊ - _valuePositiveInt?: Element1870␊ - /**␊ - * The actual value for the element, which must be one of the types allowed for this element.␊ - */␊ - valueString?: string␊ - _valueString?: Element1871␊ - /**␊ - * The actual value for the element, which must be one of the types allowed for this element.␊ - */␊ - valueTime?: string␊ - _valueTime?: Element1872␊ - /**␊ - * The actual value for the element, which must be one of the types allowed for this element.␊ - */␊ - valueUnsignedInt?: number␊ - _valueUnsignedInt?: Element1873␊ - /**␊ - * The actual value for the element, which must be one of the types allowed for this element.␊ - */␊ - valueUri?: string␊ - _valueUri?: Element1874␊ - /**␊ - * The actual value for the element, which must be one of the types allowed for this element.␊ - */␊ - valueUrl?: string␊ - _valueUrl?: Element1875␊ - /**␊ - * The actual value for the element, which must be one of the types allowed for this element.␊ - */␊ - valueUuid?: string␊ - _valueUuid?: Element1876␊ - valueAddress?: Address16␊ - valueAge?: Age15␊ - valueAnnotation?: Annotation6␊ - valueAttachment?: Attachment25␊ - valueCodeableConcept?: CodeableConcept501␊ - valueCoding?: Coding37␊ - valueContactPoint?: ContactPoint7␊ - valueCount?: Count5␊ - valueDistance?: Distance5␊ - valueDuration?: Duration31␊ - valueHumanName?: HumanName9␊ - valueIdentifier?: Identifier42␊ - valueMoney?: Money56␊ - valuePeriod?: Period120␊ - valueQuantity?: Quantity94␊ - valueRange?: Range36␊ - valueRatio?: Ratio23␊ - valueReference?: Reference438␊ - valueSampledData?: SampledData7␊ - valueSignature?: Signature6␊ - valueTiming?: Timing23␊ - valueContactDetail?: ContactDetail6␊ - valueContributor?: Contributor5␊ - valueDataRequirement?: DataRequirement8␊ - valueExpression?: Expression16␊ - valueParameterDefinition?: ParameterDefinition6␊ - valueRelatedArtifact?: RelatedArtifact6␊ - valueTriggerDefinition?: TriggerDefinition7␊ - valueUsageContext?: UsageContext6␊ - valueDosage?: Dosage6␊ - valueMeta?: Meta133␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1857 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1858 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1859 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1860 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1861 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1862 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1863 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1864 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1865 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1866 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1867 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1868 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1869 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1870 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1871 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1872 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1873 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1874 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1875 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1876 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.␊ - */␊ - export interface Address16 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this address.␊ - */␊ - use?: ("home" | "work" | "temp" | "old" | "billing")␊ - _use?: Element20␊ - /**␊ - * Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.␊ - */␊ - type?: ("postal" | "physical" | "both")␊ - _type?: Element21␊ - /**␊ - * Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.␊ - */␊ - text?: string␊ - _text?: Element22␊ - /**␊ - * This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.␊ - */␊ - line?: String[]␊ - /**␊ - * Extensions for line␊ - */␊ - _line?: Element23[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - city?: string␊ - _city?: Element24␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - district?: string␊ - _district?: Element25␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - state?: string␊ - _state?: Element26␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - postalCode?: string␊ - _postalCode?: Element27␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - country?: string␊ - _country?: Element28␊ - period?: Period␊ - }␊ - /**␊ - * The actual value for the element, which must be one of the types allowed for this element.␊ - */␊ - export interface Age15 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element31␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element32␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element33␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element34␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element35␊ - }␊ - /**␊ - * A text note which also contains information about who made the statement and when.␊ - */␊ - export interface Annotation6 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - authorReference?: Reference␊ - /**␊ - * The individual responsible for making the annotation.␊ - */␊ - authorString?: string␊ - _authorString?: Element48␊ - /**␊ - * Indicates when this particular annotation was made.␊ - */␊ - time?: string␊ - _time?: Element49␊ - /**␊ - * The text of the annotation in markdown format.␊ - */␊ - text?: string␊ - _text?: Element50␊ - }␊ - /**␊ - * For referring to data content defined in other formats.␊ - */␊ - export interface Attachment25 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.␊ - */␊ - contentType?: string␊ - _contentType?: Element51␊ - /**␊ - * The human language of the content. The value can be any valid value according to BCP 47.␊ - */␊ - language?: string␊ - _language?: Element52␊ - /**␊ - * The actual data of the attachment - a sequence of bytes, base64 encoded.␊ - */␊ - data?: string␊ - _data?: Element53␊ - /**␊ - * A location where the data can be accessed.␊ - */␊ - url?: string␊ - _url?: Element54␊ - /**␊ - * The number of bytes of data that make up this attachment (before base64 encoding, if that is done).␊ - */␊ - size?: number␊ - _size?: Element55␊ - /**␊ - * The calculated hash of the data using SHA-1. Represented using base64.␊ - */␊ - hash?: string␊ - _hash?: Element56␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element57␊ - /**␊ - * The date that the attachment was first created.␊ - */␊ - creation?: string␊ - _creation?: Element58␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept501 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - export interface Coding37 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The identification of the code system that defines the meaning of the symbol in the code.␊ - */␊ - system?: string␊ - _system?: Element39␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element40␊ - /**␊ - * A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).␊ - */␊ - code?: string␊ - _code?: Element41␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element42␊ - /**␊ - * Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).␊ - */␊ - userSelected?: boolean␊ - _userSelected?: Element43␊ - }␊ - /**␊ - * Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.␊ - */␊ - export interface ContactPoint7 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Telecommunications form for contact point - what communications system is required to make use of the contact.␊ - */␊ - system?: ("phone" | "fax" | "email" | "pager" | "url" | "sms" | "other")␊ - _system?: Element59␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element60␊ - /**␊ - * Identifies the purpose for the contact point.␊ - */␊ - use?: ("home" | "work" | "temp" | "old" | "mobile")␊ - _use?: Element61␊ - /**␊ - * Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.␊ - */␊ - rank?: number␊ - _rank?: Element62␊ - period?: Period2␊ - }␊ - /**␊ - * The actual value for the element, which must be one of the types allowed for this element.␊ - */␊ - export interface Count5 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element63␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element64␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element65␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element66␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element67␊ - }␊ - /**␊ - * The actual value for the element, which must be one of the types allowed for this element.␊ - */␊ - export interface Distance5 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element68␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element69␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element70␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element71␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element72␊ - }␊ - /**␊ - * The actual value for the element, which must be one of the types allowed for this element.␊ - */␊ - export interface Duration31 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element73␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element74␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element75␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element76␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element77␊ - }␊ - /**␊ - * A human's name with the ability to identify parts and usage.␊ - */␊ - export interface HumanName9 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Identifies the purpose for this name.␊ - */␊ - use?: ("usual" | "official" | "temp" | "nickname" | "anonymous" | "old" | "maiden")␊ - _use?: Element78␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element79␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - family?: string␊ - _family?: Element80␊ - /**␊ - * Given name.␊ - */␊ - given?: String[]␊ - /**␊ - * Extensions for given␊ - */␊ - _given?: Element23[]␊ - /**␊ - * Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.␊ - */␊ - prefix?: String[]␊ - /**␊ - * Extensions for prefix␊ - */␊ - _prefix?: Element23[]␊ - /**␊ - * Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.␊ - */␊ - suffix?: String[]␊ - /**␊ - * Extensions for suffix␊ - */␊ - _suffix?: Element23[]␊ - period?: Period3␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier42 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * The actual value for the element, which must be one of the types allowed for this element.␊ - */␊ - export interface Money56 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period120 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity94 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * The actual value for the element, which must be one of the types allowed for this element.␊ - */␊ - export interface Range36 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - low?: Quantity1␊ - high?: Quantity2␊ - }␊ - /**␊ - * The actual value for the element, which must be one of the types allowed for this element.␊ - */␊ - export interface Ratio23 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - numerator?: Quantity3␊ - denominator?: Quantity4␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference438 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * The actual value for the element, which must be one of the types allowed for this element.␊ - */␊ - export interface SampledData7 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - origin: Quantity5␊ - /**␊ - * The length of time between sampling times, measured in milliseconds.␊ - */␊ - period?: number␊ - _period?: Element88␊ - /**␊ - * A correction factor that is applied to the sampled data points before they are added to the origin.␊ - */␊ - factor?: number␊ - _factor?: Element89␊ - /**␊ - * The lower limit of detection of the measured points. This is needed if any of the data points have the value "L" (lower than detection limit).␊ - */␊ - lowerLimit?: number␊ - _lowerLimit?: Element90␊ - /**␊ - * The upper limit of detection of the measured points. This is needed if any of the data points have the value "U" (higher than detection limit).␊ - */␊ - upperLimit?: number␊ - _upperLimit?: Element91␊ - /**␊ - * The number of sample points at each time point. If this value is greater than one, then the dimensions will be interlaced - all the sample points for a point in time will be recorded at once.␊ - */␊ - dimensions?: number␊ - _dimensions?: Element92␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - data?: string␊ - _data?: Element93␊ - }␊ - /**␊ - * A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities.␊ - */␊ - export interface Signature6 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document.␊ - */␊ - type: Coding[]␊ - /**␊ - * When the digital signature was signed.␊ - */␊ - when?: string␊ - _when?: Element94␊ - who: Reference3␊ - onBehalfOf?: Reference4␊ - /**␊ - * A mime type that indicates the technical format of the target resources signed by the signature.␊ - */␊ - targetFormat?: string␊ - _targetFormat?: Element95␊ - /**␊ - * A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jose for JWS, and image/* for a graphical image of a signature, etc.␊ - */␊ - sigFormat?: string␊ - _sigFormat?: Element96␊ - /**␊ - * The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty.␊ - */␊ - data?: string␊ - _data?: Element97␊ - }␊ - /**␊ - * Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.␊ - */␊ - export interface Timing23 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifies specific times when the event occurs.␊ - */␊ - event?: DateTime[]␊ - /**␊ - * Extensions for event␊ - */␊ - _event?: Element23[]␊ - repeat?: Timing_Repeat␊ - code?: CodeableConcept2␊ - }␊ - /**␊ - * Specifies contact information for a person or organization.␊ - */␊ - export interface ContactDetail6 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element109␊ - /**␊ - * The contact details for the individual (if a name was provided) or the organization.␊ - */␊ - telecom?: ContactPoint1[]␊ - }␊ - /**␊ - * The actual value for the element, which must be one of the types allowed for this element.␊ - */␊ - export interface Contributor5 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The type of contributor.␊ - */␊ - type?: ("author" | "editor" | "reviewer" | "endorser")␊ - _type?: Element110␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element111␊ - /**␊ - * Contact details to assist a user in finding and communicating with the contributor.␊ - */␊ - contact?: ContactDetail1[]␊ - }␊ - /**␊ - * Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.␊ - */␊ - export interface DataRequirement8 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - type?: string␊ - _type?: Element112␊ - /**␊ - * The profile of the required data, specified as the uri of the profile definition.␊ - */␊ - profile?: Canonical[]␊ - subjectCodeableConcept?: CodeableConcept3␊ - subjectReference?: Reference5␊ - /**␊ - * Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. ␊ - * ␊ - * The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details).␊ - */␊ - mustSupport?: String[]␊ - /**␊ - * Extensions for mustSupport␊ - */␊ - _mustSupport?: Element23[]␊ - /**␊ - * Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.␊ - */␊ - codeFilter?: DataRequirement_CodeFilter[]␊ - /**␊ - * Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.␊ - */␊ - dateFilter?: DataRequirement_DateFilter[]␊ - /**␊ - * Specifies a maximum number of results that are required (uses the _count search parameter).␊ - */␊ - limit?: number␊ - _limit?: Element118␊ - /**␊ - * Specifies the order of the results to be returned.␊ - */␊ - sort?: DataRequirement_Sort[]␊ - }␊ - /**␊ - * The actual value for the element, which must be one of the types allowed for this element.␊ - */␊ - export interface Expression16 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element121␊ - /**␊ - * A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.␊ - */␊ - name?: string␊ - _name?: Element122␊ - /**␊ - * The media type of the language for the expression.␊ - */␊ - language?: ("text/cql" | "text/fhirpath" | "application/x-fhir-query")␊ - _language?: Element123␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - expression?: string␊ - _expression?: Element124␊ - /**␊ - * A URI that defines where the expression is found.␊ - */␊ - reference?: string␊ - _reference?: Element125␊ - }␊ - /**␊ - * The parameters to the module. This collection specifies both the input and output parameters. Input parameters are provided by the caller as part of the $evaluate operation. Output parameters are included in the GuidanceResponse.␊ - */␊ - export interface ParameterDefinition6 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - name?: string␊ - _name?: Element126␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - use?: string␊ - _use?: Element127␊ - /**␊ - * The minimum number of times this parameter SHALL appear in the request or response.␊ - */␊ - min?: number␊ - _min?: Element128␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - max?: string␊ - _max?: Element129␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - documentation?: string␊ - _documentation?: Element130␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - type?: string␊ - _type?: Element131␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - profile?: string␊ - }␊ - /**␊ - * Related artifacts such as additional documentation, justification, or bibliographic references.␊ - */␊ - export interface RelatedArtifact6 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The type of relationship to the related artifact.␊ - */␊ - type?: ("documentation" | "justification" | "citation" | "predecessor" | "successor" | "derived-from" | "depends-on" | "composed-of")␊ - _type?: Element132␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - label?: string␊ - _label?: Element133␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element134␊ - /**␊ - * A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.␊ - */␊ - citation?: string␊ - _citation?: Element135␊ - /**␊ - * A url for the artifact that can be followed to access the actual content.␊ - */␊ - url?: string␊ - _url?: Element136␊ - document?: Attachment1␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - resource?: string␊ - }␊ - /**␊ - * A description of a triggering event. Triggering events can be named events, data events, or periodic, as determined by the type element.␊ - */␊ - export interface TriggerDefinition7 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The type of triggering event.␊ - */␊ - type?: ("named-event" | "periodic" | "data-changed" | "data-added" | "data-modified" | "data-removed" | "data-accessed" | "data-access-ended")␊ - _type?: Element137␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element138␊ - timingTiming?: Timing1␊ - timingReference?: Reference6␊ - /**␊ - * The timing of the event (if this is a periodic trigger).␊ - */␊ - timingDate?: string␊ - _timingDate?: Element139␊ - /**␊ - * The timing of the event (if this is a periodic trigger).␊ - */␊ - timingDateTime?: string␊ - _timingDateTime?: Element140␊ - /**␊ - * The triggering data of the event (if this is a data trigger). If more than one data is requirement is specified, then all the data requirements must be true.␊ - */␊ - data?: DataRequirement1[]␊ - condition?: Expression1␊ - }␊ - /**␊ - * Specifies clinical/business/etc. metadata that can be used to retrieve, index and/or categorize an artifact. This metadata can either be specific to the applicable population (e.g., age category, DRG) or the specific context of care (e.g., venue, care setting, provider of care).␊ - */␊ - export interface UsageContext6 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - code: Coding2␊ - valueCodeableConcept?: CodeableConcept4␊ - valueQuantity?: Quantity6␊ - valueRange?: Range2␊ - valueReference?: Reference7␊ - }␊ - /**␊ - * Indicates how the medication is/was taken or should be taken by the patient.␊ - */␊ - export interface Dosage6 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Indicates the order in which the dosage instructions should be applied or interpreted.␊ - */␊ - sequence?: number␊ - _sequence?: Element141␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element142␊ - /**␊ - * Supplemental instructions to the patient on how to take the medication (e.g. "with meals" or"take half to one hour before food") or warnings for the patient about the medication (e.g. "may cause drowsiness" or "avoid exposure of skin to direct sunlight or sunlamps").␊ - */␊ - additionalInstruction?: CodeableConcept5[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - patientInstruction?: string␊ - _patientInstruction?: Element143␊ - timing?: Timing2␊ - /**␊ - * Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).␊ - */␊ - asNeededBoolean?: boolean␊ - _asNeededBoolean?: Element144␊ - asNeededCodeableConcept?: CodeableConcept6␊ - site?: CodeableConcept7␊ - route?: CodeableConcept8␊ - method?: CodeableConcept9␊ - /**␊ - * The amount of medication administered.␊ - */␊ - doseAndRate?: Dosage_DoseAndRate[]␊ - maxDosePerPeriod?: Ratio2␊ - maxDosePerAdministration?: Quantity9␊ - maxDosePerLifetime?: Quantity10␊ - }␊ - /**␊ - * The actual value for the element, which must be one of the types allowed for this element.␊ - */␊ - export interface Meta133 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1877 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1878 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1879 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1880 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1881 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1882 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1883 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1884 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity95 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1885 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1886 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1887 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1888 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1889 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1890 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1891 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1892 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity96 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1893 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Captures constraints on each element within the resource, profile, or extension.␊ - */␊ - export interface ElementDefinition_Constraint {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - key?: string␊ - _key?: Element1894␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - requirements?: string␊ - _requirements?: Element1895␊ - /**␊ - * Identifies the impact constraint violation has on the conformance of the instance.␊ - */␊ - severity?: ("error" | "warning")␊ - _severity?: Element1896␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - human?: string␊ - _human?: Element1897␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - expression?: string␊ - _expression?: Element1898␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - xpath?: string␊ - _xpath?: Element1899␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - source?: string␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1894 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1895 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1896 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1897 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1898 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1899 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1900 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1901 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1902 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1903 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Binds to a value set if this element is coded (code, Coding, CodeableConcept, Quantity), or the data types (string, uri).␊ - */␊ - export interface ElementDefinition_Binding {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Indicates the degree of conformance expectations associated with this binding - that is, the degree to which the provided value set must be adhered to in the instances.␊ - */␊ - strength?: ("required" | "extensible" | "preferred" | "example")␊ - _strength?: Element1904␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element1905␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - valueSet?: string␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1904 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1905 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Captures constraints on each element within the resource, profile, or extension.␊ - */␊ - export interface ElementDefinition_Mapping {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - identity?: string␊ - _identity?: Element1906␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1907␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - map?: string␊ - _map?: Element1908␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - comment?: string␊ - _comment?: Element1909␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1906 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1907 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1908 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1909 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A differential view is expressed relative to the base StructureDefinition - a statement of differences that it applies.␊ - */␊ - export interface StructureDefinition_Differential {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Captures constraints on each element within the resource.␊ - */␊ - element: ElementDefinition[]␊ - }␊ - /**␊ - * A Map of relationships between 2 structures that can be used to transform data.␊ - */␊ - export interface StructureMap {␊ - /**␊ - * This is a StructureMap resource␊ - */␊ - resourceType: "StructureMap"␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - id?: string␊ - meta?: Meta134␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1910␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1911␊ - text?: Narrative126␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - url?: string␊ - _url?: Element1912␊ - /**␊ - * A formal identifier that is used to identify this structure map when it is represented in other formats, or referenced in a specification, model, design or an instance.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element1913␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element1914␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element1915␊ - /**␊ - * The status of this structure map. Enables tracking the life-cycle of the content.␊ - */␊ - status?: ("draft" | "active" | "retired" | "unknown")␊ - _status?: Element1916␊ - /**␊ - * A Boolean value to indicate that this structure map is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.␊ - */␊ - experimental?: boolean␊ - _experimental?: Element1917␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - date?: string␊ - _date?: Element1918␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - publisher?: string␊ - _publisher?: Element1919␊ - /**␊ - * Contact details to assist a user in finding and communicating with the publisher.␊ - */␊ - contact?: ContactDetail1[]␊ - /**␊ - * A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine␊ - */␊ - description?: string␊ - _description?: Element1920␊ - /**␊ - * The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate structure map instances.␊ - */␊ - useContext?: UsageContext1[]␊ - /**␊ - * A legal or geographic region in which the structure map is intended to be used.␊ - */␊ - jurisdiction?: CodeableConcept5[]␊ - /**␊ - * A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine␊ - */␊ - purpose?: string␊ - _purpose?: Element1921␊ - /**␊ - * A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine␊ - */␊ - copyright?: string␊ - _copyright?: Element1922␊ - /**␊ - * A structure definition used by this map. The structure definition may describe instances that are converted, or the instances that are produced.␊ - */␊ - structure?: StructureMap_Structure[]␊ - /**␊ - * Other maps used by this map (canonical URLs).␊ - */␊ - import?: Canonical[]␊ - /**␊ - * Organizes the mapping into manageable chunks for human review/ease of maintenance.␊ - */␊ - group: StructureMap_Group[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta134 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1910 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1911 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative126 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1912 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1913 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1914 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1915 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1916 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1917 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1918 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1919 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1920 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1921 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1922 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A Map of relationships between 2 structures that can be used to transform data.␊ - */␊ - export interface StructureMap_Structure {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - url: string␊ - /**␊ - * How the referenced structure is used in this mapping.␊ - */␊ - mode?: ("source" | "queried" | "target" | "produced")␊ - _mode?: Element1923␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - alias?: string␊ - _alias?: Element1924␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - documentation?: string␊ - _documentation?: Element1925␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1923 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1924 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1925 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A Map of relationships between 2 structures that can be used to transform data.␊ - */␊ - export interface StructureMap_Group {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - name?: string␊ - _name?: Element1926␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - extends?: string␊ - _extends?: Element1927␊ - /**␊ - * If this is the default rule set to apply for the source type or this combination of types.␊ - */␊ - typeMode?: ("none" | "types" | "type-and-types")␊ - _typeMode?: Element1928␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - documentation?: string␊ - _documentation?: Element1929␊ - /**␊ - * A name assigned to an instance of data. The instance must be provided when the mapping is invoked.␊ - */␊ - input: StructureMap_Input[]␊ - /**␊ - * Transform Rule from source to target.␊ - */␊ - rule: StructureMap_Rule[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1926 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1927 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1928 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1929 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A Map of relationships between 2 structures that can be used to transform data.␊ - */␊ - export interface StructureMap_Input {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - name?: string␊ - _name?: Element1930␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - type?: string␊ - _type?: Element1931␊ - /**␊ - * Mode for this instance of data.␊ - */␊ - mode?: ("source" | "target")␊ - _mode?: Element1932␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - documentation?: string␊ - _documentation?: Element1933␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1930 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1931 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1932 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1933 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A Map of relationships between 2 structures that can be used to transform data.␊ - */␊ - export interface StructureMap_Rule {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - name?: string␊ - _name?: Element1934␊ - /**␊ - * Source inputs to the mapping.␊ - */␊ - source: StructureMap_Source[]␊ - /**␊ - * Content to create because of this mapping rule.␊ - */␊ - target?: StructureMap_Target[]␊ - /**␊ - * Rules contained in this rule.␊ - */␊ - rule?: StructureMap_Rule[]␊ - /**␊ - * Which other rules to apply in the context of this rule.␊ - */␊ - dependent?: StructureMap_Dependent[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - documentation?: string␊ - _documentation?: Element1976␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1934 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A Map of relationships between 2 structures that can be used to transform data.␊ - */␊ - export interface StructureMap_Source {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - context?: string␊ - _context?: Element1935␊ - /**␊ - * A whole number␊ - */␊ - min?: number␊ - _min?: Element1936␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - max?: string␊ - _max?: Element1937␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - type?: string␊ - _type?: Element1938␊ - /**␊ - * A value to use if there is no existing value in the source object.␊ - */␊ - defaultValueBase64Binary?: string␊ - _defaultValueBase64Binary?: Element1939␊ - /**␊ - * A value to use if there is no existing value in the source object.␊ - */␊ - defaultValueBoolean?: boolean␊ - _defaultValueBoolean?: Element1940␊ - /**␊ - * A value to use if there is no existing value in the source object.␊ - */␊ - defaultValueCanonical?: string␊ - _defaultValueCanonical?: Element1941␊ - /**␊ - * A value to use if there is no existing value in the source object.␊ - */␊ - defaultValueCode?: string␊ - _defaultValueCode?: Element1942␊ - /**␊ - * A value to use if there is no existing value in the source object.␊ - */␊ - defaultValueDate?: string␊ - _defaultValueDate?: Element1943␊ - /**␊ - * A value to use if there is no existing value in the source object.␊ - */␊ - defaultValueDateTime?: string␊ - _defaultValueDateTime?: Element1944␊ - /**␊ - * A value to use if there is no existing value in the source object.␊ - */␊ - defaultValueDecimal?: number␊ - _defaultValueDecimal?: Element1945␊ - /**␊ - * A value to use if there is no existing value in the source object.␊ - */␊ - defaultValueId?: string␊ - _defaultValueId?: Element1946␊ - /**␊ - * A value to use if there is no existing value in the source object.␊ - */␊ - defaultValueInstant?: string␊ - _defaultValueInstant?: Element1947␊ - /**␊ - * A value to use if there is no existing value in the source object.␊ - */␊ - defaultValueInteger?: number␊ - _defaultValueInteger?: Element1948␊ - /**␊ - * A value to use if there is no existing value in the source object.␊ - */␊ - defaultValueMarkdown?: string␊ - _defaultValueMarkdown?: Element1949␊ - /**␊ - * A value to use if there is no existing value in the source object.␊ - */␊ - defaultValueOid?: string␊ - _defaultValueOid?: Element1950␊ - /**␊ - * A value to use if there is no existing value in the source object.␊ - */␊ - defaultValuePositiveInt?: number␊ - _defaultValuePositiveInt?: Element1951␊ - /**␊ - * A value to use if there is no existing value in the source object.␊ - */␊ - defaultValueString?: string␊ - _defaultValueString?: Element1952␊ - /**␊ - * A value to use if there is no existing value in the source object.␊ - */␊ - defaultValueTime?: string␊ - _defaultValueTime?: Element1953␊ - /**␊ - * A value to use if there is no existing value in the source object.␊ - */␊ - defaultValueUnsignedInt?: number␊ - _defaultValueUnsignedInt?: Element1954␊ - /**␊ - * A value to use if there is no existing value in the source object.␊ - */␊ - defaultValueUri?: string␊ - _defaultValueUri?: Element1955␊ - /**␊ - * A value to use if there is no existing value in the source object.␊ - */␊ - defaultValueUrl?: string␊ - _defaultValueUrl?: Element1956␊ - /**␊ - * A value to use if there is no existing value in the source object.␊ - */␊ - defaultValueUuid?: string␊ - _defaultValueUuid?: Element1957␊ - defaultValueAddress?: Address17␊ - defaultValueAge?: Age16␊ - defaultValueAnnotation?: Annotation7␊ - defaultValueAttachment?: Attachment26␊ - defaultValueCodeableConcept?: CodeableConcept502␊ - defaultValueCoding?: Coding38␊ - defaultValueContactPoint?: ContactPoint8␊ - defaultValueCount?: Count6␊ - defaultValueDistance?: Distance6␊ - defaultValueDuration?: Duration32␊ - defaultValueHumanName?: HumanName10␊ - defaultValueIdentifier?: Identifier43␊ - defaultValueMoney?: Money57␊ - defaultValuePeriod?: Period121␊ - defaultValueQuantity?: Quantity97␊ - defaultValueRange?: Range37␊ - defaultValueRatio?: Ratio24␊ - defaultValueReference?: Reference439␊ - defaultValueSampledData?: SampledData8␊ - defaultValueSignature?: Signature7␊ - defaultValueTiming?: Timing24␊ - defaultValueContactDetail?: ContactDetail7␊ - defaultValueContributor?: Contributor6␊ - defaultValueDataRequirement?: DataRequirement9␊ - defaultValueExpression?: Expression17␊ - defaultValueParameterDefinition?: ParameterDefinition7␊ - defaultValueRelatedArtifact?: RelatedArtifact7␊ - defaultValueTriggerDefinition?: TriggerDefinition8␊ - defaultValueUsageContext?: UsageContext7␊ - defaultValueDosage?: Dosage7␊ - defaultValueMeta?: Meta135␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - element?: string␊ - _element?: Element1958␊ - /**␊ - * How to handle the list mode for this element.␊ - */␊ - listMode?: ("first" | "not_first" | "last" | "not_last" | "only_one")␊ - _listMode?: Element1959␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - variable?: string␊ - _variable?: Element1960␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - condition?: string␊ - _condition?: Element1961␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - check?: string␊ - _check?: Element1962␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - logMessage?: string␊ - _logMessage?: Element1963␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1935 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1936 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1937 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1938 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1939 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1940 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1941 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1942 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1943 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1944 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1945 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1946 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1947 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1948 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1949 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1950 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1951 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1952 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1953 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1954 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1955 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1956 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1957 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.␊ - */␊ - export interface Address17 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this address.␊ - */␊ - use?: ("home" | "work" | "temp" | "old" | "billing")␊ - _use?: Element20␊ - /**␊ - * Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.␊ - */␊ - type?: ("postal" | "physical" | "both")␊ - _type?: Element21␊ - /**␊ - * Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.␊ - */␊ - text?: string␊ - _text?: Element22␊ - /**␊ - * This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.␊ - */␊ - line?: String[]␊ - /**␊ - * Extensions for line␊ - */␊ - _line?: Element23[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - city?: string␊ - _city?: Element24␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - district?: string␊ - _district?: Element25␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - state?: string␊ - _state?: Element26␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - postalCode?: string␊ - _postalCode?: Element27␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - country?: string␊ - _country?: Element28␊ - period?: Period␊ - }␊ - /**␊ - * A value to use if there is no existing value in the source object.␊ - */␊ - export interface Age16 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element31␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element32␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element33␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element34␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element35␊ - }␊ - /**␊ - * A text note which also contains information about who made the statement and when.␊ - */␊ - export interface Annotation7 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - authorReference?: Reference␊ - /**␊ - * The individual responsible for making the annotation.␊ - */␊ - authorString?: string␊ - _authorString?: Element48␊ - /**␊ - * Indicates when this particular annotation was made.␊ - */␊ - time?: string␊ - _time?: Element49␊ - /**␊ - * The text of the annotation in markdown format.␊ - */␊ - text?: string␊ - _text?: Element50␊ - }␊ - /**␊ - * For referring to data content defined in other formats.␊ - */␊ - export interface Attachment26 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.␊ - */␊ - contentType?: string␊ - _contentType?: Element51␊ - /**␊ - * The human language of the content. The value can be any valid value according to BCP 47.␊ - */␊ - language?: string␊ - _language?: Element52␊ - /**␊ - * The actual data of the attachment - a sequence of bytes, base64 encoded.␊ - */␊ - data?: string␊ - _data?: Element53␊ - /**␊ - * A location where the data can be accessed.␊ - */␊ - url?: string␊ - _url?: Element54␊ - /**␊ - * The number of bytes of data that make up this attachment (before base64 encoding, if that is done).␊ - */␊ - size?: number␊ - _size?: Element55␊ - /**␊ - * The calculated hash of the data using SHA-1. Represented using base64.␊ - */␊ - hash?: string␊ - _hash?: Element56␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element57␊ - /**␊ - * The date that the attachment was first created.␊ - */␊ - creation?: string␊ - _creation?: Element58␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept502 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - export interface Coding38 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The identification of the code system that defines the meaning of the symbol in the code.␊ - */␊ - system?: string␊ - _system?: Element39␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element40␊ - /**␊ - * A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).␊ - */␊ - code?: string␊ - _code?: Element41␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element42␊ - /**␊ - * Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).␊ - */␊ - userSelected?: boolean␊ - _userSelected?: Element43␊ - }␊ - /**␊ - * Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.␊ - */␊ - export interface ContactPoint8 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Telecommunications form for contact point - what communications system is required to make use of the contact.␊ - */␊ - system?: ("phone" | "fax" | "email" | "pager" | "url" | "sms" | "other")␊ - _system?: Element59␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element60␊ - /**␊ - * Identifies the purpose for the contact point.␊ - */␊ - use?: ("home" | "work" | "temp" | "old" | "mobile")␊ - _use?: Element61␊ - /**␊ - * Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.␊ - */␊ - rank?: number␊ - _rank?: Element62␊ - period?: Period2␊ - }␊ - /**␊ - * A value to use if there is no existing value in the source object.␊ - */␊ - export interface Count6 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element63␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element64␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element65␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element66␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element67␊ - }␊ - /**␊ - * A value to use if there is no existing value in the source object.␊ - */␊ - export interface Distance6 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element68␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element69␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element70␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element71␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element72␊ - }␊ - /**␊ - * A value to use if there is no existing value in the source object.␊ - */␊ - export interface Duration32 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element73␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element74␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element75␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element76␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element77␊ - }␊ - /**␊ - * A human's name with the ability to identify parts and usage.␊ - */␊ - export interface HumanName10 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Identifies the purpose for this name.␊ - */␊ - use?: ("usual" | "official" | "temp" | "nickname" | "anonymous" | "old" | "maiden")␊ - _use?: Element78␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element79␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - family?: string␊ - _family?: Element80␊ - /**␊ - * Given name.␊ - */␊ - given?: String[]␊ - /**␊ - * Extensions for given␊ - */␊ - _given?: Element23[]␊ - /**␊ - * Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.␊ - */␊ - prefix?: String[]␊ - /**␊ - * Extensions for prefix␊ - */␊ - _prefix?: Element23[]␊ - /**␊ - * Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.␊ - */␊ - suffix?: String[]␊ - /**␊ - * Extensions for suffix␊ - */␊ - _suffix?: Element23[]␊ - period?: Period3␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier43 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * A value to use if there is no existing value in the source object.␊ - */␊ - export interface Money57 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period121 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity97 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * A value to use if there is no existing value in the source object.␊ - */␊ - export interface Range37 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - low?: Quantity1␊ - high?: Quantity2␊ - }␊ - /**␊ - * A value to use if there is no existing value in the source object.␊ - */␊ - export interface Ratio24 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - numerator?: Quantity3␊ - denominator?: Quantity4␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference439 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A value to use if there is no existing value in the source object.␊ - */␊ - export interface SampledData8 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - origin: Quantity5␊ - /**␊ - * The length of time between sampling times, measured in milliseconds.␊ - */␊ - period?: number␊ - _period?: Element88␊ - /**␊ - * A correction factor that is applied to the sampled data points before they are added to the origin.␊ - */␊ - factor?: number␊ - _factor?: Element89␊ - /**␊ - * The lower limit of detection of the measured points. This is needed if any of the data points have the value "L" (lower than detection limit).␊ - */␊ - lowerLimit?: number␊ - _lowerLimit?: Element90␊ - /**␊ - * The upper limit of detection of the measured points. This is needed if any of the data points have the value "U" (higher than detection limit).␊ - */␊ - upperLimit?: number␊ - _upperLimit?: Element91␊ - /**␊ - * The number of sample points at each time point. If this value is greater than one, then the dimensions will be interlaced - all the sample points for a point in time will be recorded at once.␊ - */␊ - dimensions?: number␊ - _dimensions?: Element92␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - data?: string␊ - _data?: Element93␊ - }␊ - /**␊ - * A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities.␊ - */␊ - export interface Signature7 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document.␊ - */␊ - type: Coding[]␊ - /**␊ - * When the digital signature was signed.␊ - */␊ - when?: string␊ - _when?: Element94␊ - who: Reference3␊ - onBehalfOf?: Reference4␊ - /**␊ - * A mime type that indicates the technical format of the target resources signed by the signature.␊ - */␊ - targetFormat?: string␊ - _targetFormat?: Element95␊ - /**␊ - * A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jose for JWS, and image/* for a graphical image of a signature, etc.␊ - */␊ - sigFormat?: string␊ - _sigFormat?: Element96␊ - /**␊ - * The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty.␊ - */␊ - data?: string␊ - _data?: Element97␊ - }␊ - /**␊ - * Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.␊ - */␊ - export interface Timing24 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifies specific times when the event occurs.␊ - */␊ - event?: DateTime[]␊ - /**␊ - * Extensions for event␊ - */␊ - _event?: Element23[]␊ - repeat?: Timing_Repeat␊ - code?: CodeableConcept2␊ - }␊ - /**␊ - * Specifies contact information for a person or organization.␊ - */␊ - export interface ContactDetail7 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element109␊ - /**␊ - * The contact details for the individual (if a name was provided) or the organization.␊ - */␊ - telecom?: ContactPoint1[]␊ - }␊ - /**␊ - * A value to use if there is no existing value in the source object.␊ - */␊ - export interface Contributor6 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The type of contributor.␊ - */␊ - type?: ("author" | "editor" | "reviewer" | "endorser")␊ - _type?: Element110␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element111␊ - /**␊ - * Contact details to assist a user in finding and communicating with the contributor.␊ - */␊ - contact?: ContactDetail1[]␊ - }␊ - /**␊ - * Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.␊ - */␊ - export interface DataRequirement9 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - type?: string␊ - _type?: Element112␊ - /**␊ - * The profile of the required data, specified as the uri of the profile definition.␊ - */␊ - profile?: Canonical[]␊ - subjectCodeableConcept?: CodeableConcept3␊ - subjectReference?: Reference5␊ - /**␊ - * Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. ␊ - * ␊ - * The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details).␊ - */␊ - mustSupport?: String[]␊ - /**␊ - * Extensions for mustSupport␊ - */␊ - _mustSupport?: Element23[]␊ - /**␊ - * Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.␊ - */␊ - codeFilter?: DataRequirement_CodeFilter[]␊ - /**␊ - * Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.␊ - */␊ - dateFilter?: DataRequirement_DateFilter[]␊ - /**␊ - * Specifies a maximum number of results that are required (uses the _count search parameter).␊ - */␊ - limit?: number␊ - _limit?: Element118␊ - /**␊ - * Specifies the order of the results to be returned.␊ - */␊ - sort?: DataRequirement_Sort[]␊ - }␊ - /**␊ - * A value to use if there is no existing value in the source object.␊ - */␊ - export interface Expression17 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element121␊ - /**␊ - * A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.␊ - */␊ - name?: string␊ - _name?: Element122␊ - /**␊ - * The media type of the language for the expression.␊ - */␊ - language?: ("text/cql" | "text/fhirpath" | "application/x-fhir-query")␊ - _language?: Element123␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - expression?: string␊ - _expression?: Element124␊ - /**␊ - * A URI that defines where the expression is found.␊ - */␊ - reference?: string␊ - _reference?: Element125␊ - }␊ - /**␊ - * The parameters to the module. This collection specifies both the input and output parameters. Input parameters are provided by the caller as part of the $evaluate operation. Output parameters are included in the GuidanceResponse.␊ - */␊ - export interface ParameterDefinition7 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - name?: string␊ - _name?: Element126␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - use?: string␊ - _use?: Element127␊ - /**␊ - * The minimum number of times this parameter SHALL appear in the request or response.␊ - */␊ - min?: number␊ - _min?: Element128␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - max?: string␊ - _max?: Element129␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - documentation?: string␊ - _documentation?: Element130␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - type?: string␊ - _type?: Element131␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - profile?: string␊ - }␊ - /**␊ - * Related artifacts such as additional documentation, justification, or bibliographic references.␊ - */␊ - export interface RelatedArtifact7 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The type of relationship to the related artifact.␊ - */␊ - type?: ("documentation" | "justification" | "citation" | "predecessor" | "successor" | "derived-from" | "depends-on" | "composed-of")␊ - _type?: Element132␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - label?: string␊ - _label?: Element133␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element134␊ - /**␊ - * A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.␊ - */␊ - citation?: string␊ - _citation?: Element135␊ - /**␊ - * A url for the artifact that can be followed to access the actual content.␊ - */␊ - url?: string␊ - _url?: Element136␊ - document?: Attachment1␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - resource?: string␊ - }␊ - /**␊ - * A description of a triggering event. Triggering events can be named events, data events, or periodic, as determined by the type element.␊ - */␊ - export interface TriggerDefinition8 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The type of triggering event.␊ - */␊ - type?: ("named-event" | "periodic" | "data-changed" | "data-added" | "data-modified" | "data-removed" | "data-accessed" | "data-access-ended")␊ - _type?: Element137␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element138␊ - timingTiming?: Timing1␊ - timingReference?: Reference6␊ - /**␊ - * The timing of the event (if this is a periodic trigger).␊ - */␊ - timingDate?: string␊ - _timingDate?: Element139␊ - /**␊ - * The timing of the event (if this is a periodic trigger).␊ - */␊ - timingDateTime?: string␊ - _timingDateTime?: Element140␊ - /**␊ - * The triggering data of the event (if this is a data trigger). If more than one data is requirement is specified, then all the data requirements must be true.␊ - */␊ - data?: DataRequirement1[]␊ - condition?: Expression1␊ - }␊ - /**␊ - * Specifies clinical/business/etc. metadata that can be used to retrieve, index and/or categorize an artifact. This metadata can either be specific to the applicable population (e.g., age category, DRG) or the specific context of care (e.g., venue, care setting, provider of care).␊ - */␊ - export interface UsageContext7 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - code: Coding2␊ - valueCodeableConcept?: CodeableConcept4␊ - valueQuantity?: Quantity6␊ - valueRange?: Range2␊ - valueReference?: Reference7␊ - }␊ - /**␊ - * Indicates how the medication is/was taken or should be taken by the patient.␊ - */␊ - export interface Dosage7 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Indicates the order in which the dosage instructions should be applied or interpreted.␊ - */␊ - sequence?: number␊ - _sequence?: Element141␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element142␊ - /**␊ - * Supplemental instructions to the patient on how to take the medication (e.g. "with meals" or"take half to one hour before food") or warnings for the patient about the medication (e.g. "may cause drowsiness" or "avoid exposure of skin to direct sunlight or sunlamps").␊ - */␊ - additionalInstruction?: CodeableConcept5[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - patientInstruction?: string␊ - _patientInstruction?: Element143␊ - timing?: Timing2␊ - /**␊ - * Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).␊ - */␊ - asNeededBoolean?: boolean␊ - _asNeededBoolean?: Element144␊ - asNeededCodeableConcept?: CodeableConcept6␊ - site?: CodeableConcept7␊ - route?: CodeableConcept8␊ - method?: CodeableConcept9␊ - /**␊ - * The amount of medication administered.␊ - */␊ - doseAndRate?: Dosage_DoseAndRate[]␊ - maxDosePerPeriod?: Ratio2␊ - maxDosePerAdministration?: Quantity9␊ - maxDosePerLifetime?: Quantity10␊ - }␊ - /**␊ - * A value to use if there is no existing value in the source object.␊ - */␊ - export interface Meta135 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1958 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1959 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1960 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1961 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1962 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1963 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A Map of relationships between 2 structures that can be used to transform data.␊ - */␊ - export interface StructureMap_Target {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - context?: string␊ - _context?: Element1964␊ - /**␊ - * How to interpret the context.␊ - */␊ - contextType?: ("type" | "variable")␊ - _contextType?: Element1965␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - element?: string␊ - _element?: Element1966␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - variable?: string␊ - _variable?: Element1967␊ - /**␊ - * If field is a list, how to manage the list.␊ - */␊ - listMode?: ("first" | "share" | "last" | "collate")[]␊ - /**␊ - * Extensions for listMode␊ - */␊ - _listMode?: Element23[]␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - listRuleId?: string␊ - _listRuleId?: Element1968␊ - /**␊ - * How the data is copied / created.␊ - */␊ - transform?: ("create" | "copy" | "truncate" | "escape" | "cast" | "append" | "translate" | "reference" | "dateOp" | "uuid" | "pointer" | "evaluate" | "cc" | "c" | "qty" | "id" | "cp")␊ - _transform?: Element1969␊ - /**␊ - * Parameters to the transform.␊ - */␊ - parameter?: StructureMap_Parameter[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1964 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1965 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1966 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1967 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1968 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1969 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A Map of relationships between 2 structures that can be used to transform data.␊ - */␊ - export interface StructureMap_Parameter {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Parameter value - variable or literal.␊ - */␊ - valueId?: string␊ - _valueId?: Element1970␊ - /**␊ - * Parameter value - variable or literal.␊ - */␊ - valueString?: string␊ - _valueString?: Element1971␊ - /**␊ - * Parameter value - variable or literal.␊ - */␊ - valueBoolean?: boolean␊ - _valueBoolean?: Element1972␊ - /**␊ - * Parameter value - variable or literal.␊ - */␊ - valueInteger?: number␊ - _valueInteger?: Element1973␊ - /**␊ - * Parameter value - variable or literal.␊ - */␊ - valueDecimal?: number␊ - _valueDecimal?: Element1974␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1970 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1971 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1972 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1973 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1974 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A Map of relationships between 2 structures that can be used to transform data.␊ - */␊ - export interface StructureMap_Dependent {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - name?: string␊ - _name?: Element1975␊ - /**␊ - * Variable to pass to the rule or group.␊ - */␊ - variable?: String[]␊ - /**␊ - * Extensions for variable␊ - */␊ - _variable?: Element23[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1975 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1976 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The subscription resource is used to define a push-based subscription from a server to another system. Once a subscription is registered with the server, the server checks every resource that is created or updated, and if the resource matches the given criteria, it sends a message on the defined "channel" so that another system can take an appropriate action.␊ - */␊ - export interface Subscription {␊ - /**␊ - * This is a Subscription resource␊ - */␊ - resourceType: "Subscription"␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - id?: string␊ - meta?: Meta136␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1977␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1978␊ - text?: Narrative127␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * The status of the subscription, which marks the server state for managing the subscription.␊ - */␊ - status?: ("requested" | "active" | "error" | "off")␊ - _status?: Element1979␊ - /**␊ - * Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.␊ - */␊ - contact?: ContactPoint1[]␊ - /**␊ - * The time for the server to turn the subscription off.␊ - */␊ - end?: string␊ - _end?: Element1980␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reason?: string␊ - _reason?: Element1981␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - criteria?: string␊ - _criteria?: Element1982␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - error?: string␊ - _error?: Element1983␊ - channel: Subscription_Channel␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta136 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1977 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1978 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative127 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1979 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1980 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1981 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1982 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1983 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Details where to send notifications when resources are received that meet the criteria.␊ - */␊ - export interface Subscription_Channel {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * The type of channel to send notifications on.␊ - */␊ - type?: ("rest-hook" | "websocket" | "email" | "sms" | "message")␊ - _type?: Element1984␊ - /**␊ - * The url that describes the actual end-point to send messages to.␊ - */␊ - endpoint?: string␊ - _endpoint?: Element1985␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - payload?: string␊ - _payload?: Element1986␊ - /**␊ - * Additional headers / information to send as part of the notification.␊ - */␊ - header?: String[]␊ - /**␊ - * Extensions for header␊ - */␊ - _header?: Element23[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1984 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1985 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1986 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A homogeneous material with a definite composition.␊ - */␊ - export interface Substance {␊ - /**␊ - * This is a Substance resource␊ - */␊ - resourceType: "Substance"␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - id?: string␊ - meta?: Meta137␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1987␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1988␊ - text?: Narrative128␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Unique identifier for the substance.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * A code to indicate if the substance is actively used.␊ - */␊ - status?: ("active" | "inactive" | "entered-in-error")␊ - _status?: Element1989␊ - /**␊ - * A code that classifies the general type of substance. This is used for searching, sorting and display purposes.␊ - */␊ - category?: CodeableConcept5[]␊ - code: CodeableConcept503␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element1990␊ - /**␊ - * Substance may be used to describe a kind of substance, or a specific package/container of the substance: an instance.␊ - */␊ - instance?: Substance_Instance[]␊ - /**␊ - * A substance can be composed of other substances.␊ - */␊ - ingredient?: Substance_Ingredient[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta137 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1987 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1988 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative128 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1989 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept503 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1990 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A homogeneous material with a definite composition.␊ - */␊ - export interface Substance_Instance {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - identifier?: Identifier44␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - expiry?: string␊ - _expiry?: Element1991␊ - quantity?: Quantity98␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier44 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1991 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity98 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * A homogeneous material with a definite composition.␊ - */␊ - export interface Substance_Ingredient {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - quantity?: Ratio25␊ - substanceCodeableConcept?: CodeableConcept504␊ - substanceReference?: Reference440␊ - }␊ - /**␊ - * The amount of the ingredient in the substance - a concentration ratio.␊ - */␊ - export interface Ratio25 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - numerator?: Quantity3␊ - denominator?: Quantity4␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept504 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference440 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Nucleic acids are defined by three distinct elements: the base, sugar and linkage. Individual substance/moiety IDs will be created for each of these elements. The nucleotide sequence will be always entered in the 5’-3’ direction.␊ - */␊ - export interface SubstanceNucleicAcid {␊ - /**␊ - * This is a SubstanceNucleicAcid resource␊ - */␊ - resourceType: "SubstanceNucleicAcid"␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - id?: string␊ - meta?: Meta138␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element1992␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element1993␊ - text?: Narrative129␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - sequenceType?: CodeableConcept505␊ - /**␊ - * A whole number␊ - */␊ - numberOfSubunits?: number␊ - _numberOfSubunits?: Element1994␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - areaOfHybridisation?: string␊ - _areaOfHybridisation?: Element1995␊ - oligoNucleotideType?: CodeableConcept506␊ - /**␊ - * Subunits are listed in order of decreasing length; sequences of the same length will be ordered by molecular weight; subunits that have identical sequences will be repeated multiple times.␊ - */␊ - subunit?: SubstanceNucleicAcid_Subunit[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta138 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1992 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1993 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative129 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept505 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1994 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1995 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept506 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Nucleic acids are defined by three distinct elements: the base, sugar and linkage. Individual substance/moiety IDs will be created for each of these elements. The nucleotide sequence will be always entered in the 5’-3’ direction.␊ - */␊ - export interface SubstanceNucleicAcid_Subunit {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A whole number␊ - */␊ - subunit?: number␊ - _subunit?: Element1996␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - sequence?: string␊ - _sequence?: Element1997␊ - /**␊ - * A whole number␊ - */␊ - length?: number␊ - _length?: Element1998␊ - sequenceAttachment?: Attachment27␊ - fivePrime?: CodeableConcept507␊ - threePrime?: CodeableConcept508␊ - /**␊ - * The linkages between sugar residues will also be captured.␊ - */␊ - linkage?: SubstanceNucleicAcid_Linkage[]␊ - /**␊ - * 5.3.6.8.1 Sugar ID (Mandatory).␊ - */␊ - sugar?: SubstanceNucleicAcid_Sugar[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1996 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1997 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1998 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * For referring to data content defined in other formats.␊ - */␊ - export interface Attachment27 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.␊ - */␊ - contentType?: string␊ - _contentType?: Element51␊ - /**␊ - * The human language of the content. The value can be any valid value according to BCP 47.␊ - */␊ - language?: string␊ - _language?: Element52␊ - /**␊ - * The actual data of the attachment - a sequence of bytes, base64 encoded.␊ - */␊ - data?: string␊ - _data?: Element53␊ - /**␊ - * A location where the data can be accessed.␊ - */␊ - url?: string␊ - _url?: Element54␊ - /**␊ - * The number of bytes of data that make up this attachment (before base64 encoding, if that is done).␊ - */␊ - size?: number␊ - _size?: Element55␊ - /**␊ - * The calculated hash of the data using SHA-1. Represented using base64.␊ - */␊ - hash?: string␊ - _hash?: Element56␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element57␊ - /**␊ - * The date that the attachment was first created.␊ - */␊ - creation?: string␊ - _creation?: Element58␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept507 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept508 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Nucleic acids are defined by three distinct elements: the base, sugar and linkage. Individual substance/moiety IDs will be created for each of these elements. The nucleotide sequence will be always entered in the 5’-3’ direction.␊ - */␊ - export interface SubstanceNucleicAcid_Linkage {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - connectivity?: string␊ - _connectivity?: Element1999␊ - identifier?: Identifier45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element2000␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - residueSite?: string␊ - _residueSite?: Element2001␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element1999 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier45 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2000 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2001 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Nucleic acids are defined by three distinct elements: the base, sugar and linkage. Individual substance/moiety IDs will be created for each of these elements. The nucleotide sequence will be always entered in the 5’-3’ direction.␊ - */␊ - export interface SubstanceNucleicAcid_Sugar {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - identifier?: Identifier46␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element2002␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - residueSite?: string␊ - _residueSite?: Element2003␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier46 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2002 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2003 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Todo.␊ - */␊ - export interface SubstancePolymer {␊ - /**␊ - * This is a SubstancePolymer resource␊ - */␊ - resourceType: "SubstancePolymer"␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - id?: string␊ - meta?: Meta139␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element2004␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element2005␊ - text?: Narrative130␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - class?: CodeableConcept509␊ - geometry?: CodeableConcept510␊ - /**␊ - * Todo.␊ - */␊ - copolymerConnectivity?: CodeableConcept5[]␊ - /**␊ - * Todo.␊ - */␊ - modification?: String[]␊ - /**␊ - * Extensions for modification␊ - */␊ - _modification?: Element23[]␊ - /**␊ - * Todo.␊ - */␊ - monomerSet?: SubstancePolymer_MonomerSet[]␊ - /**␊ - * Todo.␊ - */␊ - repeat?: SubstancePolymer_Repeat[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta139 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2004 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2005 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative130 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept509 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept510 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Todo.␊ - */␊ - export interface SubstancePolymer_MonomerSet {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - ratioType?: CodeableConcept511␊ - /**␊ - * Todo.␊ - */␊ - startingMaterial?: SubstancePolymer_StartingMaterial[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept511 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Todo.␊ - */␊ - export interface SubstancePolymer_StartingMaterial {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - material?: CodeableConcept512␊ - type?: CodeableConcept513␊ - /**␊ - * Todo.␊ - */␊ - isDefining?: boolean␊ - _isDefining?: Element2006␊ - amount?: SubstanceAmount␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept512 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept513 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2006 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Todo.␊ - */␊ - export interface SubstanceAmount {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - amountQuantity?: Quantity99␊ - amountRange?: Range38␊ - /**␊ - * Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field.␊ - */␊ - amountString?: string␊ - _amountString?: Element2007␊ - amountType?: CodeableConcept514␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - amountText?: string␊ - _amountText?: Element2008␊ - referenceRange?: SubstanceAmount_ReferenceRange␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity99 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field.␊ - */␊ - export interface Range38 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - low?: Quantity1␊ - high?: Quantity2␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2007 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept514 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2008 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Reference range of possible or expected values.␊ - */␊ - export interface SubstanceAmount_ReferenceRange {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - lowLimit?: Quantity100␊ - highLimit?: Quantity101␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity100 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity101 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * Todo.␊ - */␊ - export interface SubstancePolymer_Repeat {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A whole number␊ - */␊ - numberOfUnits?: number␊ - _numberOfUnits?: Element2009␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - averageMolecularFormula?: string␊ - _averageMolecularFormula?: Element2010␊ - repeatUnitAmountType?: CodeableConcept515␊ - /**␊ - * Todo.␊ - */␊ - repeatUnit?: SubstancePolymer_RepeatUnit[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2009 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2010 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept515 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Todo.␊ - */␊ - export interface SubstancePolymer_RepeatUnit {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - orientationOfPolymerisation?: CodeableConcept516␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - repeatUnit?: string␊ - _repeatUnit?: Element2011␊ - amount?: SubstanceAmount1␊ - /**␊ - * Todo.␊ - */␊ - degreeOfPolymerisation?: SubstancePolymer_DegreeOfPolymerisation[]␊ - /**␊ - * Todo.␊ - */␊ - structuralRepresentation?: SubstancePolymer_StructuralRepresentation[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept516 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2011 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Todo.␊ - */␊ - export interface SubstanceAmount1 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - amountQuantity?: Quantity99␊ - amountRange?: Range38␊ - /**␊ - * Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field.␊ - */␊ - amountString?: string␊ - _amountString?: Element2007␊ - amountType?: CodeableConcept514␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - amountText?: string␊ - _amountText?: Element2008␊ - referenceRange?: SubstanceAmount_ReferenceRange␊ - }␊ - /**␊ - * Todo.␊ - */␊ - export interface SubstancePolymer_DegreeOfPolymerisation {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - degree?: CodeableConcept517␊ - amount?: SubstanceAmount2␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept517 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Todo.␊ - */␊ - export interface SubstanceAmount2 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - amountQuantity?: Quantity99␊ - amountRange?: Range38␊ - /**␊ - * Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field.␊ - */␊ - amountString?: string␊ - _amountString?: Element2007␊ - amountType?: CodeableConcept514␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - amountText?: string␊ - _amountText?: Element2008␊ - referenceRange?: SubstanceAmount_ReferenceRange␊ - }␊ - /**␊ - * Todo.␊ - */␊ - export interface SubstancePolymer_StructuralRepresentation {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - type?: CodeableConcept518␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - representation?: string␊ - _representation?: Element2012␊ - attachment?: Attachment28␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept518 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2012 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * For referring to data content defined in other formats.␊ - */␊ - export interface Attachment28 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.␊ - */␊ - contentType?: string␊ - _contentType?: Element51␊ - /**␊ - * The human language of the content. The value can be any valid value according to BCP 47.␊ - */␊ - language?: string␊ - _language?: Element52␊ - /**␊ - * The actual data of the attachment - a sequence of bytes, base64 encoded.␊ - */␊ - data?: string␊ - _data?: Element53␊ - /**␊ - * A location where the data can be accessed.␊ - */␊ - url?: string␊ - _url?: Element54␊ - /**␊ - * The number of bytes of data that make up this attachment (before base64 encoding, if that is done).␊ - */␊ - size?: number␊ - _size?: Element55␊ - /**␊ - * The calculated hash of the data using SHA-1. Represented using base64.␊ - */␊ - hash?: string␊ - _hash?: Element56␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element57␊ - /**␊ - * The date that the attachment was first created.␊ - */␊ - creation?: string␊ - _creation?: Element58␊ - }␊ - /**␊ - * A SubstanceProtein is defined as a single unit of a linear amino acid sequence, or a combination of subunits that are either covalently linked or have a defined invariant stoichiometric relationship. This includes all synthetic, recombinant and purified SubstanceProteins of defined sequence, whether the use is therapeutic or prophylactic. This set of elements will be used to describe albumins, coagulation factors, cytokines, growth factors, peptide/SubstanceProtein hormones, enzymes, toxins, toxoids, recombinant vaccines, and immunomodulators.␊ - */␊ - export interface SubstanceProtein {␊ - /**␊ - * This is a SubstanceProtein resource␊ - */␊ - resourceType: "SubstanceProtein"␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - id?: string␊ - meta?: Meta140␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element2013␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element2014␊ - text?: Narrative131␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - sequenceType?: CodeableConcept519␊ - /**␊ - * A whole number␊ - */␊ - numberOfSubunits?: number␊ - _numberOfSubunits?: Element2015␊ - /**␊ - * The disulphide bond between two cysteine residues either on the same subunit or on two different subunits shall be described. The position of the disulfide bonds in the SubstanceProtein shall be listed in increasing order of subunit number and position within subunit followed by the abbreviation of the amino acids involved. The disulfide linkage positions shall actually contain the amino acid Cysteine at the respective positions.␊ - */␊ - disulfideLinkage?: String[]␊ - /**␊ - * Extensions for disulfideLinkage␊ - */␊ - _disulfideLinkage?: Element23[]␊ - /**␊ - * This subclause refers to the description of each subunit constituting the SubstanceProtein. A subunit is a linear sequence of amino acids linked through peptide bonds. The Subunit information shall be provided when the finished SubstanceProtein is a complex of multiple sequences; subunits are not used to delineate domains within a single sequence. Subunits are listed in order of decreasing length; sequences of the same length will be ordered by decreasing molecular weight; subunits that have identical sequences will be repeated multiple times.␊ - */␊ - subunit?: SubstanceProtein_Subunit[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta140 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2013 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2014 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative131 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept519 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2015 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A SubstanceProtein is defined as a single unit of a linear amino acid sequence, or a combination of subunits that are either covalently linked or have a defined invariant stoichiometric relationship. This includes all synthetic, recombinant and purified SubstanceProteins of defined sequence, whether the use is therapeutic or prophylactic. This set of elements will be used to describe albumins, coagulation factors, cytokines, growth factors, peptide/SubstanceProtein hormones, enzymes, toxins, toxoids, recombinant vaccines, and immunomodulators.␊ - */␊ - export interface SubstanceProtein_Subunit {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A whole number␊ - */␊ - subunit?: number␊ - _subunit?: Element2016␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - sequence?: string␊ - _sequence?: Element2017␊ - /**␊ - * A whole number␊ - */␊ - length?: number␊ - _length?: Element2018␊ - sequenceAttachment?: Attachment29␊ - nTerminalModificationId?: Identifier47␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - nTerminalModification?: string␊ - _nTerminalModification?: Element2019␊ - cTerminalModificationId?: Identifier48␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - cTerminalModification?: string␊ - _cTerminalModification?: Element2020␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2016 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2017 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2018 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * For referring to data content defined in other formats.␊ - */␊ - export interface Attachment29 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.␊ - */␊ - contentType?: string␊ - _contentType?: Element51␊ - /**␊ - * The human language of the content. The value can be any valid value according to BCP 47.␊ - */␊ - language?: string␊ - _language?: Element52␊ - /**␊ - * The actual data of the attachment - a sequence of bytes, base64 encoded.␊ - */␊ - data?: string␊ - _data?: Element53␊ - /**␊ - * A location where the data can be accessed.␊ - */␊ - url?: string␊ - _url?: Element54␊ - /**␊ - * The number of bytes of data that make up this attachment (before base64 encoding, if that is done).␊ - */␊ - size?: number␊ - _size?: Element55␊ - /**␊ - * The calculated hash of the data using SHA-1. Represented using base64.␊ - */␊ - hash?: string␊ - _hash?: Element56␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element57␊ - /**␊ - * The date that the attachment was first created.␊ - */␊ - creation?: string␊ - _creation?: Element58␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier47 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2019 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier48 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2020 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Todo.␊ - */␊ - export interface SubstanceReferenceInformation {␊ - /**␊ - * This is a SubstanceReferenceInformation resource␊ - */␊ - resourceType: "SubstanceReferenceInformation"␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - id?: string␊ - meta?: Meta141␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element2021␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element2022␊ - text?: Narrative132␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - comment?: string␊ - _comment?: Element2023␊ - /**␊ - * Todo.␊ - */␊ - gene?: SubstanceReferenceInformation_Gene[]␊ - /**␊ - * Todo.␊ - */␊ - geneElement?: SubstanceReferenceInformation_GeneElement[]␊ - /**␊ - * Todo.␊ - */␊ - classification?: SubstanceReferenceInformation_Classification[]␊ - /**␊ - * Todo.␊ - */␊ - target?: SubstanceReferenceInformation_Target[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta141 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2021 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2022 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative132 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2023 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Todo.␊ - */␊ - export interface SubstanceReferenceInformation_Gene {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - geneSequenceOrigin?: CodeableConcept520␊ - gene?: CodeableConcept521␊ - /**␊ - * Todo.␊ - */␊ - source?: Reference11[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept520 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept521 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Todo.␊ - */␊ - export interface SubstanceReferenceInformation_GeneElement {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - type?: CodeableConcept522␊ - element?: Identifier49␊ - /**␊ - * Todo.␊ - */␊ - source?: Reference11[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept522 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier49 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * Todo.␊ - */␊ - export interface SubstanceReferenceInformation_Classification {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - domain?: CodeableConcept523␊ - classification?: CodeableConcept524␊ - /**␊ - * Todo.␊ - */␊ - subtype?: CodeableConcept5[]␊ - /**␊ - * Todo.␊ - */␊ - source?: Reference11[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept523 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept524 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Todo.␊ - */␊ - export interface SubstanceReferenceInformation_Target {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - target?: Identifier50␊ - type?: CodeableConcept525␊ - interaction?: CodeableConcept526␊ - organism?: CodeableConcept527␊ - organismType?: CodeableConcept528␊ - amountQuantity?: Quantity102␊ - amountRange?: Range39␊ - /**␊ - * Todo.␊ - */␊ - amountString?: string␊ - _amountString?: Element2024␊ - amountType?: CodeableConcept529␊ - /**␊ - * Todo.␊ - */␊ - source?: Reference11[]␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier50 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept525 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept526 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept527 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept528 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity102 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * Todo.␊ - */␊ - export interface Range39 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - low?: Quantity1␊ - high?: Quantity2␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2024 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept529 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Source material shall capture information on the taxonomic and anatomical origins as well as the fraction of a material that can result in or can be modified to form a substance. This set of data elements shall be used to define polymer substances isolated from biological matrices. Taxonomic and anatomical origins shall be described using a controlled vocabulary as required. This information is captured for naturally derived polymers ( . starch) and structurally diverse substances. For Organisms belonging to the Kingdom Plantae the Substance level defines the fresh material of a single species or infraspecies, the Herbal Drug and the Herbal preparation. For Herbal preparations, the fraction information will be captured at the Substance information level and additional information for herbal extracts will be captured at the Specified Substance Group 1 information level. See for further explanation the Substance Class: Structurally Diverse and the herbal annex.␊ - */␊ - export interface SubstanceSourceMaterial {␊ - /**␊ - * This is a SubstanceSourceMaterial resource␊ - */␊ - resourceType: "SubstanceSourceMaterial"␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - id?: string␊ - meta?: Meta142␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element2025␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element2026␊ - text?: Narrative133␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - sourceMaterialClass?: CodeableConcept530␊ - sourceMaterialType?: CodeableConcept531␊ - sourceMaterialState?: CodeableConcept532␊ - organismId?: Identifier51␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - organismName?: string␊ - _organismName?: Element2027␊ - /**␊ - * The parent of the herbal drug Ginkgo biloba, Leaf is the substance ID of the substance (fresh) of Ginkgo biloba L. or Ginkgo biloba L. (Whole plant).␊ - */␊ - parentSubstanceId?: Identifier2[]␊ - /**␊ - * The parent substance of the Herbal Drug, or Herbal preparation.␊ - */␊ - parentSubstanceName?: String[]␊ - /**␊ - * Extensions for parentSubstanceName␊ - */␊ - _parentSubstanceName?: Element23[]␊ - /**␊ - * The country where the plant material is harvested or the countries where the plasma is sourced from as laid down in accordance with the Plasma Master File. For “Plasma-derived substances” the attribute country of origin provides information about the countries used for the manufacturing of the Cryopoor plama or Crioprecipitate.␊ - */␊ - countryOfOrigin?: CodeableConcept5[]␊ - /**␊ - * The place/region where the plant is harvested or the places/regions where the animal source material has its habitat.␊ - */␊ - geographicalLocation?: String[]␊ - /**␊ - * Extensions for geographicalLocation␊ - */␊ - _geographicalLocation?: Element23[]␊ - developmentStage?: CodeableConcept533␊ - /**␊ - * Many complex materials are fractions of parts of plants, animals, or minerals. Fraction elements are often necessary to define both Substances and Specified Group 1 Substances. For substances derived from Plants, fraction information will be captured at the Substance information level ( . Oils, Juices and Exudates). Additional information for Extracts, such as extraction solvent composition, will be captured at the Specified Substance Group 1 information level. For plasma-derived products fraction information will be captured at the Substance and the Specified Substance Group 1 levels.␊ - */␊ - fractionDescription?: SubstanceSourceMaterial_FractionDescription[]␊ - organism?: SubstanceSourceMaterial_Organism␊ - /**␊ - * To do.␊ - */␊ - partDescription?: SubstanceSourceMaterial_PartDescription[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta142 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2025 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2026 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative133 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept530 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept531 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept532 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier51 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2027 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept533 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Source material shall capture information on the taxonomic and anatomical origins as well as the fraction of a material that can result in or can be modified to form a substance. This set of data elements shall be used to define polymer substances isolated from biological matrices. Taxonomic and anatomical origins shall be described using a controlled vocabulary as required. This information is captured for naturally derived polymers ( . starch) and structurally diverse substances. For Organisms belonging to the Kingdom Plantae the Substance level defines the fresh material of a single species or infraspecies, the Herbal Drug and the Herbal preparation. For Herbal preparations, the fraction information will be captured at the Substance information level and additional information for herbal extracts will be captured at the Specified Substance Group 1 information level. See for further explanation the Substance Class: Structurally Diverse and the herbal annex.␊ - */␊ - export interface SubstanceSourceMaterial_FractionDescription {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - fraction?: string␊ - _fraction?: Element2028␊ - materialType?: CodeableConcept534␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2028 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept534 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * This subclause describes the organism which the substance is derived from. For vaccines, the parent organism shall be specified based on these subclause elements. As an example, full taxonomy will be described for the Substance Name: ., Leaf.␊ - */␊ - export interface SubstanceSourceMaterial_Organism {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - family?: CodeableConcept535␊ - genus?: CodeableConcept536␊ - species?: CodeableConcept537␊ - intraspecificType?: CodeableConcept538␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - intraspecificDescription?: string␊ - _intraspecificDescription?: Element2029␊ - /**␊ - * 4.9.13.6.1 Author type (Conditional).␊ - */␊ - author?: SubstanceSourceMaterial_Author[]␊ - hybrid?: SubstanceSourceMaterial_Hybrid␊ - organismGeneral?: SubstanceSourceMaterial_OrganismGeneral␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept535 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept536 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept537 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept538 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2029 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Source material shall capture information on the taxonomic and anatomical origins as well as the fraction of a material that can result in or can be modified to form a substance. This set of data elements shall be used to define polymer substances isolated from biological matrices. Taxonomic and anatomical origins shall be described using a controlled vocabulary as required. This information is captured for naturally derived polymers ( . starch) and structurally diverse substances. For Organisms belonging to the Kingdom Plantae the Substance level defines the fresh material of a single species or infraspecies, the Herbal Drug and the Herbal preparation. For Herbal preparations, the fraction information will be captured at the Substance information level and additional information for herbal extracts will be captured at the Specified Substance Group 1 information level. See for further explanation the Substance Class: Structurally Diverse and the herbal annex.␊ - */␊ - export interface SubstanceSourceMaterial_Author {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - authorType?: CodeableConcept539␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - authorDescription?: string␊ - _authorDescription?: Element2030␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept539 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2030 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * 4.9.13.8.1 Hybrid species maternal organism ID (Optional).␊ - */␊ - export interface SubstanceSourceMaterial_Hybrid {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - maternalOrganismId?: string␊ - _maternalOrganismId?: Element2031␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - maternalOrganismName?: string␊ - _maternalOrganismName?: Element2032␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - paternalOrganismId?: string␊ - _paternalOrganismId?: Element2033␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - paternalOrganismName?: string␊ - _paternalOrganismName?: Element2034␊ - hybridType?: CodeableConcept540␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2031 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2032 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2033 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2034 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept540 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * 4.9.13.7.1 Kingdom (Conditional).␊ - */␊ - export interface SubstanceSourceMaterial_OrganismGeneral {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - kingdom?: CodeableConcept541␊ - phylum?: CodeableConcept542␊ - class?: CodeableConcept543␊ - order?: CodeableConcept544␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept541 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept542 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept543 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept544 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Source material shall capture information on the taxonomic and anatomical origins as well as the fraction of a material that can result in or can be modified to form a substance. This set of data elements shall be used to define polymer substances isolated from biological matrices. Taxonomic and anatomical origins shall be described using a controlled vocabulary as required. This information is captured for naturally derived polymers ( . starch) and structurally diverse substances. For Organisms belonging to the Kingdom Plantae the Substance level defines the fresh material of a single species or infraspecies, the Herbal Drug and the Herbal preparation. For Herbal preparations, the fraction information will be captured at the Substance information level and additional information for herbal extracts will be captured at the Specified Substance Group 1 information level. See for further explanation the Substance Class: Structurally Diverse and the herbal annex.␊ - */␊ - export interface SubstanceSourceMaterial_PartDescription {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - part?: CodeableConcept545␊ - partLocation?: CodeableConcept546␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept545 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept546 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * The detailed description of a substance, typically at a level beyond what is used for prescribing.␊ - */␊ - export interface SubstanceSpecification {␊ - /**␊ - * This is a SubstanceSpecification resource␊ - */␊ - resourceType: "SubstanceSpecification"␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - id?: string␊ - meta?: Meta143␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element2035␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element2036␊ - text?: Narrative134␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - identifier?: Identifier52␊ - type?: CodeableConcept547␊ - status?: CodeableConcept548␊ - domain?: CodeableConcept549␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element2037␊ - /**␊ - * Supporting literature.␊ - */␊ - source?: Reference11[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - comment?: string␊ - _comment?: Element2038␊ - /**␊ - * Moiety, for structural modifications.␊ - */␊ - moiety?: SubstanceSpecification_Moiety[]␊ - /**␊ - * General specifications for this substance, including how it is related to other substances.␊ - */␊ - property?: SubstanceSpecification_Property[]␊ - referenceInformation?: Reference442␊ - structure?: SubstanceSpecification_Structure␊ - /**␊ - * Codes associated with the substance.␊ - */␊ - code?: SubstanceSpecification_Code[]␊ - /**␊ - * Names applicable to this substance.␊ - */␊ - name?: SubstanceSpecification_Name[]␊ - /**␊ - * The molecular weight or weight range (for proteins, polymers or nucleic acids).␊ - */␊ - molecularWeight?: SubstanceSpecification_MolecularWeight2[]␊ - /**␊ - * A link between this substance and another, with details of the relationship.␊ - */␊ - relationship?: SubstanceSpecification_Relationship[]␊ - nucleicAcid?: Reference444␊ - polymer?: Reference445␊ - protein?: Reference446␊ - sourceMaterial?: Reference447␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta143 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2035 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2036 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative134 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier52 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept547 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept548 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept549 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2037 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2038 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The detailed description of a substance, typically at a level beyond what is used for prescribing.␊ - */␊ - export interface SubstanceSpecification_Moiety {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - role?: CodeableConcept550␊ - identifier?: Identifier53␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element2039␊ - stereochemistry?: CodeableConcept551␊ - opticalActivity?: CodeableConcept552␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - molecularFormula?: string␊ - _molecularFormula?: Element2040␊ - amountQuantity?: Quantity103␊ - /**␊ - * Quantitative value for this moiety.␊ - */␊ - amountString?: string␊ - _amountString?: Element2041␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept550 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier53 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2039 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept551 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept552 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2040 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity103 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2041 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The detailed description of a substance, typically at a level beyond what is used for prescribing.␊ - */␊ - export interface SubstanceSpecification_Property {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - category?: CodeableConcept553␊ - code?: CodeableConcept554␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - parameters?: string␊ - _parameters?: Element2042␊ - definingSubstanceReference?: Reference441␊ - definingSubstanceCodeableConcept?: CodeableConcept555␊ - amountQuantity?: Quantity104␊ - /**␊ - * Quantitative value for this property.␊ - */␊ - amountString?: string␊ - _amountString?: Element2043␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept553 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept554 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2042 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference441 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept555 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity104 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2043 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference442 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Structural information.␊ - */␊ - export interface SubstanceSpecification_Structure {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - stereochemistry?: CodeableConcept556␊ - opticalActivity?: CodeableConcept557␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - molecularFormula?: string␊ - _molecularFormula?: Element2044␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - molecularFormulaByMoiety?: string␊ - _molecularFormulaByMoiety?: Element2045␊ - /**␊ - * Applicable for single substances that contain a radionuclide or a non-natural isotopic ratio.␊ - */␊ - isotope?: SubstanceSpecification_Isotope[]␊ - molecularWeight?: SubstanceSpecification_MolecularWeight1␊ - /**␊ - * Supporting literature.␊ - */␊ - source?: Reference11[]␊ - /**␊ - * Molecular structural representation.␊ - */␊ - representation?: SubstanceSpecification_Representation[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept556 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept557 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2044 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2045 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The detailed description of a substance, typically at a level beyond what is used for prescribing.␊ - */␊ - export interface SubstanceSpecification_Isotope {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - identifier?: Identifier54␊ - name?: CodeableConcept558␊ - substitution?: CodeableConcept559␊ - halfLife?: Quantity105␊ - molecularWeight?: SubstanceSpecification_MolecularWeight␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier54 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept558 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept559 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity105 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * The molecular weight or weight range (for proteins, polymers or nucleic acids).␊ - */␊ - export interface SubstanceSpecification_MolecularWeight {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - method?: CodeableConcept560␊ - type?: CodeableConcept561␊ - amount?: Quantity106␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept560 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept561 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity106 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * The molecular weight or weight range (for proteins, polymers or nucleic acids).␊ - */␊ - export interface SubstanceSpecification_MolecularWeight1 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - method?: CodeableConcept560␊ - type?: CodeableConcept561␊ - amount?: Quantity106␊ - }␊ - /**␊ - * The detailed description of a substance, typically at a level beyond what is used for prescribing.␊ - */␊ - export interface SubstanceSpecification_Representation {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - type?: CodeableConcept562␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - representation?: string␊ - _representation?: Element2046␊ - attachment?: Attachment30␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept562 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2046 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * For referring to data content defined in other formats.␊ - */␊ - export interface Attachment30 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.␊ - */␊ - contentType?: string␊ - _contentType?: Element51␊ - /**␊ - * The human language of the content. The value can be any valid value according to BCP 47.␊ - */␊ - language?: string␊ - _language?: Element52␊ - /**␊ - * The actual data of the attachment - a sequence of bytes, base64 encoded.␊ - */␊ - data?: string␊ - _data?: Element53␊ - /**␊ - * A location where the data can be accessed.␊ - */␊ - url?: string␊ - _url?: Element54␊ - /**␊ - * The number of bytes of data that make up this attachment (before base64 encoding, if that is done).␊ - */␊ - size?: number␊ - _size?: Element55␊ - /**␊ - * The calculated hash of the data using SHA-1. Represented using base64.␊ - */␊ - hash?: string␊ - _hash?: Element56␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element57␊ - /**␊ - * The date that the attachment was first created.␊ - */␊ - creation?: string␊ - _creation?: Element58␊ - }␊ - /**␊ - * The detailed description of a substance, typically at a level beyond what is used for prescribing.␊ - */␊ - export interface SubstanceSpecification_Code {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - code?: CodeableConcept563␊ - status?: CodeableConcept564␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - statusDate?: string␊ - _statusDate?: Element2047␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - comment?: string␊ - _comment?: Element2048␊ - /**␊ - * Supporting literature.␊ - */␊ - source?: Reference11[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept563 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept564 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2047 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2048 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The detailed description of a substance, typically at a level beyond what is used for prescribing.␊ - */␊ - export interface SubstanceSpecification_Name {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element2049␊ - type?: CodeableConcept565␊ - status?: CodeableConcept566␊ - /**␊ - * If this is the preferred name for this substance.␊ - */␊ - preferred?: boolean␊ - _preferred?: Element2050␊ - /**␊ - * Language of the name.␊ - */␊ - language?: CodeableConcept5[]␊ - /**␊ - * The use context of this name for example if there is a different name a drug active ingredient as opposed to a food colour additive.␊ - */␊ - domain?: CodeableConcept5[]␊ - /**␊ - * The jurisdiction where this name applies.␊ - */␊ - jurisdiction?: CodeableConcept5[]␊ - /**␊ - * A synonym of this name.␊ - */␊ - synonym?: SubstanceSpecification_Name[]␊ - /**␊ - * A translation for this name.␊ - */␊ - translation?: SubstanceSpecification_Name[]␊ - /**␊ - * Details of the official nature of this name.␊ - */␊ - official?: SubstanceSpecification_Official[]␊ - /**␊ - * Supporting literature.␊ - */␊ - source?: Reference11[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2049 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept565 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept566 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2050 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The detailed description of a substance, typically at a level beyond what is used for prescribing.␊ - */␊ - export interface SubstanceSpecification_Official {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - authority?: CodeableConcept567␊ - status?: CodeableConcept568␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - date?: string␊ - _date?: Element2051␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept567 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept568 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2051 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The detailed description of a substance, typically at a level beyond what is used for prescribing.␊ - */␊ - export interface SubstanceSpecification_MolecularWeight2 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - method?: CodeableConcept560␊ - type?: CodeableConcept561␊ - amount?: Quantity106␊ - }␊ - /**␊ - * The detailed description of a substance, typically at a level beyond what is used for prescribing.␊ - */␊ - export interface SubstanceSpecification_Relationship {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - substanceReference?: Reference443␊ - substanceCodeableConcept?: CodeableConcept569␊ - relationship?: CodeableConcept570␊ - /**␊ - * For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible substance relationships.␊ - */␊ - isDefining?: boolean␊ - _isDefining?: Element2052␊ - amountQuantity?: Quantity107␊ - amountRange?: Range40␊ - amountRatio?: Ratio26␊ - /**␊ - * A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other.␊ - */␊ - amountString?: string␊ - _amountString?: Element2053␊ - amountRatioLowLimit?: Ratio27␊ - amountType?: CodeableConcept571␊ - /**␊ - * Supporting literature.␊ - */␊ - source?: Reference11[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference443 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept569 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept570 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2052 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity107 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other.␊ - */␊ - export interface Range40 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - low?: Quantity1␊ - high?: Quantity2␊ - }␊ - /**␊ - * A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other.␊ - */␊ - export interface Ratio26 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - numerator?: Quantity3␊ - denominator?: Quantity4␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2053 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * For use when the numeric.␊ - */␊ - export interface Ratio27 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - numerator?: Quantity3␊ - denominator?: Quantity4␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept571 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference444 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference445 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference446 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference447 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Record of delivery of what is supplied.␊ - */␊ - export interface SupplyDelivery {␊ - /**␊ - * This is a SupplyDelivery resource␊ - */␊ - resourceType: "SupplyDelivery"␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - id?: string␊ - meta?: Meta144␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element2054␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element2055␊ - text?: Narrative135␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifier for the supply delivery event that is used to identify it across multiple disparate systems.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * A plan, proposal or order that is fulfilled in whole or in part by this event.␊ - */␊ - basedOn?: Reference11[]␊ - /**␊ - * A larger event of which this particular event is a component or step.␊ - */␊ - partOf?: Reference11[]␊ - /**␊ - * A code specifying the state of the dispense event.␊ - */␊ - status?: ("in-progress" | "completed" | "abandoned" | "entered-in-error")␊ - _status?: Element2056␊ - patient?: Reference448␊ - type?: CodeableConcept572␊ - suppliedItem?: SupplyDelivery_SuppliedItem␊ - /**␊ - * The date or time(s) the activity occurred.␊ - */␊ - occurrenceDateTime?: string␊ - _occurrenceDateTime?: Element2057␊ - occurrencePeriod?: Period122␊ - occurrenceTiming?: Timing25␊ - supplier?: Reference450␊ - destination?: Reference451␊ - /**␊ - * Identifies the person who picked up the Supply.␊ - */␊ - receiver?: Reference11[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta144 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2054 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2055 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative135 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2056 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference448 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept572 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * The item that is being delivered or has been supplied.␊ - */␊ - export interface SupplyDelivery_SuppliedItem {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - quantity?: Quantity108␊ - itemCodeableConcept?: CodeableConcept573␊ - itemReference?: Reference449␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity108 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept573 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference449 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2057 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period122 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.␊ - */␊ - export interface Timing25 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifies specific times when the event occurs.␊ - */␊ - event?: DateTime[]␊ - /**␊ - * Extensions for event␊ - */␊ - _event?: Element23[]␊ - repeat?: Timing_Repeat␊ - code?: CodeableConcept2␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference450 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference451 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A record of a request for a medication, substance or device used in the healthcare setting.␊ - */␊ - export interface SupplyRequest {␊ - /**␊ - * This is a SupplyRequest resource␊ - */␊ - resourceType: "SupplyRequest"␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - id?: string␊ - meta?: Meta145␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element2058␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element2059␊ - text?: Narrative136␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Business identifiers assigned to this SupplyRequest by the author and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * Status of the supply request.␊ - */␊ - status?: ("draft" | "active" | "suspended" | "cancelled" | "completed" | "entered-in-error" | "unknown")␊ - _status?: Element2060␊ - category?: CodeableConcept574␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - priority?: string␊ - _priority?: Element2061␊ - itemCodeableConcept?: CodeableConcept575␊ - itemReference?: Reference452␊ - quantity: Quantity109␊ - /**␊ - * Specific parameters for the ordered item. For example, the size of the indicated item.␊ - */␊ - parameter?: SupplyRequest_Parameter[]␊ - /**␊ - * When the request should be fulfilled.␊ - */␊ - occurrenceDateTime?: string␊ - _occurrenceDateTime?: Element2063␊ - occurrencePeriod?: Period123␊ - occurrenceTiming?: Timing26␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - authoredOn?: string␊ - _authoredOn?: Element2064␊ - requester?: Reference453␊ - /**␊ - * Who is intended to fulfill the request.␊ - */␊ - supplier?: Reference11[]␊ - /**␊ - * The reason why the supply item was requested.␊ - */␊ - reasonCode?: CodeableConcept5[]␊ - /**␊ - * The reason why the supply item was requested.␊ - */␊ - reasonReference?: Reference11[]␊ - deliverFrom?: Reference454␊ - deliverTo?: Reference455␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta145 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2058 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2059 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative136 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2060 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept574 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2061 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept575 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference452 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity109 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * A record of a request for a medication, substance or device used in the healthcare setting.␊ - */␊ - export interface SupplyRequest_Parameter {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - code?: CodeableConcept576␊ - valueCodeableConcept?: CodeableConcept577␊ - valueQuantity?: Quantity110␊ - valueRange?: Range41␊ - /**␊ - * The value of the device detail.␊ - */␊ - valueBoolean?: boolean␊ - _valueBoolean?: Element2062␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept576 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept577 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity110 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * The value of the device detail.␊ - */␊ - export interface Range41 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - low?: Quantity1␊ - high?: Quantity2␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2062 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2063 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period123 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.␊ - */␊ - export interface Timing26 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifies specific times when the event occurs.␊ - */␊ - event?: DateTime[]␊ - /**␊ - * Extensions for event␊ - */␊ - _event?: Element23[]␊ - repeat?: Timing_Repeat␊ - code?: CodeableConcept2␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2064 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference453 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference454 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference455 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A task to be performed.␊ - */␊ - export interface Task {␊ - /**␊ - * This is a Task resource␊ - */␊ - resourceType: "Task"␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - id?: string␊ - meta?: Meta146␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element2065␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element2066␊ - text?: Narrative137␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * The business identifier for this task.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - instantiatesCanonical?: string␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - instantiatesUri?: string␊ - _instantiatesUri?: Element2067␊ - /**␊ - * BasedOn refers to a higher-level authorization that triggered the creation of the task. It references a "request" resource such as a ServiceRequest, MedicationRequest, ServiceRequest, CarePlan, etc. which is distinct from the "request" resource the task is seeking to fulfill. This latter resource is referenced by FocusOn. For example, based on a ServiceRequest (= BasedOn), a task is created to fulfill a procedureRequest ( = FocusOn ) to collect a specimen from a patient.␊ - */␊ - basedOn?: Reference11[]␊ - groupIdentifier?: Identifier55␊ - /**␊ - * Task that this particular task is part of.␊ - */␊ - partOf?: Reference11[]␊ - /**␊ - * The current status of the task.␊ - */␊ - status?: ("draft" | "requested" | "received" | "accepted" | "rejected" | "ready" | "cancelled" | "in-progress" | "on-hold" | "failed" | "completed" | "entered-in-error")␊ - _status?: Element2068␊ - statusReason?: CodeableConcept578␊ - businessStatus?: CodeableConcept579␊ - /**␊ - * Indicates the "level" of actionability associated with the Task, i.e. i+R[9]Cs this a proposed task, a planned task, an actionable task, etc.␊ - */␊ - intent?: ("unknown" | "proposal" | "plan" | "order" | "original-order" | "reflex-order" | "filler-order" | "instance-order" | "option")␊ - _intent?: Element2069␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - priority?: string␊ - _priority?: Element2070␊ - code?: CodeableConcept580␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element2071␊ - focus?: Reference456␊ - for?: Reference457␊ - encounter?: Reference458␊ - executionPeriod?: Period124␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - authoredOn?: string␊ - _authoredOn?: Element2072␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - lastModified?: string␊ - _lastModified?: Element2073␊ - requester?: Reference459␊ - /**␊ - * The kind of participant that should perform the task.␊ - */␊ - performerType?: CodeableConcept5[]␊ - owner?: Reference460␊ - location?: Reference461␊ - reasonCode?: CodeableConcept581␊ - reasonReference?: Reference462␊ - /**␊ - * Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task.␊ - */␊ - insurance?: Reference11[]␊ - /**␊ - * Free-text information captured about the task as it progresses.␊ - */␊ - note?: Annotation1[]␊ - /**␊ - * Links to Provenance records for past versions of this Task that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the task.␊ - */␊ - relevantHistory?: Reference11[]␊ - restriction?: Task_Restriction␊ - /**␊ - * Additional information that may be needed in the execution of the task.␊ - */␊ - input?: Task_Input[]␊ - /**␊ - * Outputs produced by the Task.␊ - */␊ - output?: Task_Output[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta146 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2065 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2066 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative137 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2067 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier55 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2068 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept578 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept579 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2069 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2070 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept580 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2071 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference456 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference457 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference458 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period124 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2072 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2073 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference459 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference460 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference461 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept581 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference462 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * If the Task.focus is a request resource and the task is seeking fulfillment (i.e. is asking for the request to be actioned), this element identifies any limitations on what parts of the referenced request should be actioned.␊ - */␊ - export interface Task_Restriction {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * An integer with a value that is positive (e.g. >0)␊ - */␊ - repetitions?: number␊ - _repetitions?: Element2074␊ - period?: Period125␊ - /**␊ - * For requests that are targeted to more than on potential recipient/target, for whom is fulfillment sought?␊ - */␊ - recipient?: Reference11[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2074 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period125 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * A task to be performed.␊ - */␊ - export interface Task_Input {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - type: CodeableConcept582␊ - /**␊ - * The value of the input parameter as a basic type.␊ - */␊ - valueBase64Binary?: string␊ - _valueBase64Binary?: Element2075␊ - /**␊ - * The value of the input parameter as a basic type.␊ - */␊ - valueBoolean?: boolean␊ - _valueBoolean?: Element2076␊ - /**␊ - * The value of the input parameter as a basic type.␊ - */␊ - valueCanonical?: string␊ - _valueCanonical?: Element2077␊ - /**␊ - * The value of the input parameter as a basic type.␊ - */␊ - valueCode?: string␊ - _valueCode?: Element2078␊ - /**␊ - * The value of the input parameter as a basic type.␊ - */␊ - valueDate?: string␊ - _valueDate?: Element2079␊ - /**␊ - * The value of the input parameter as a basic type.␊ - */␊ - valueDateTime?: string␊ - _valueDateTime?: Element2080␊ - /**␊ - * The value of the input parameter as a basic type.␊ - */␊ - valueDecimal?: number␊ - _valueDecimal?: Element2081␊ - /**␊ - * The value of the input parameter as a basic type.␊ - */␊ - valueId?: string␊ - _valueId?: Element2082␊ - /**␊ - * The value of the input parameter as a basic type.␊ - */␊ - valueInstant?: string␊ - _valueInstant?: Element2083␊ - /**␊ - * The value of the input parameter as a basic type.␊ - */␊ - valueInteger?: number␊ - _valueInteger?: Element2084␊ - /**␊ - * The value of the input parameter as a basic type.␊ - */␊ - valueMarkdown?: string␊ - _valueMarkdown?: Element2085␊ - /**␊ - * The value of the input parameter as a basic type.␊ - */␊ - valueOid?: string␊ - _valueOid?: Element2086␊ - /**␊ - * The value of the input parameter as a basic type.␊ - */␊ - valuePositiveInt?: number␊ - _valuePositiveInt?: Element2087␊ - /**␊ - * The value of the input parameter as a basic type.␊ - */␊ - valueString?: string␊ - _valueString?: Element2088␊ - /**␊ - * The value of the input parameter as a basic type.␊ - */␊ - valueTime?: string␊ - _valueTime?: Element2089␊ - /**␊ - * The value of the input parameter as a basic type.␊ - */␊ - valueUnsignedInt?: number␊ - _valueUnsignedInt?: Element2090␊ - /**␊ - * The value of the input parameter as a basic type.␊ - */␊ - valueUri?: string␊ - _valueUri?: Element2091␊ - /**␊ - * The value of the input parameter as a basic type.␊ - */␊ - valueUrl?: string␊ - _valueUrl?: Element2092␊ - /**␊ - * The value of the input parameter as a basic type.␊ - */␊ - valueUuid?: string␊ - _valueUuid?: Element2093␊ - valueAddress?: Address18␊ - valueAge?: Age17␊ - valueAnnotation?: Annotation8␊ - valueAttachment?: Attachment31␊ - valueCodeableConcept?: CodeableConcept583␊ - valueCoding?: Coding39␊ - valueContactPoint?: ContactPoint9␊ - valueCount?: Count7␊ - valueDistance?: Distance7␊ - valueDuration?: Duration33␊ - valueHumanName?: HumanName11␊ - valueIdentifier?: Identifier56␊ - valueMoney?: Money58␊ - valuePeriod?: Period126␊ - valueQuantity?: Quantity111␊ - valueRange?: Range42␊ - valueRatio?: Ratio28␊ - valueReference?: Reference463␊ - valueSampledData?: SampledData9␊ - valueSignature?: Signature8␊ - valueTiming?: Timing27␊ - valueContactDetail?: ContactDetail8␊ - valueContributor?: Contributor7␊ - valueDataRequirement?: DataRequirement10␊ - valueExpression?: Expression18␊ - valueParameterDefinition?: ParameterDefinition8␊ - valueRelatedArtifact?: RelatedArtifact8␊ - valueTriggerDefinition?: TriggerDefinition9␊ - valueUsageContext?: UsageContext8␊ - valueDosage?: Dosage8␊ - valueMeta?: Meta147␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept582 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2075 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2076 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2077 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2078 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2079 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2080 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2081 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2082 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2083 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2084 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2085 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2086 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2087 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2088 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2089 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2090 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2091 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2092 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2093 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.␊ - */␊ - export interface Address18 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this address.␊ - */␊ - use?: ("home" | "work" | "temp" | "old" | "billing")␊ - _use?: Element20␊ - /**␊ - * Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.␊ - */␊ - type?: ("postal" | "physical" | "both")␊ - _type?: Element21␊ - /**␊ - * Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.␊ - */␊ - text?: string␊ - _text?: Element22␊ - /**␊ - * This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.␊ - */␊ - line?: String[]␊ - /**␊ - * Extensions for line␊ - */␊ - _line?: Element23[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - city?: string␊ - _city?: Element24␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - district?: string␊ - _district?: Element25␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - state?: string␊ - _state?: Element26␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - postalCode?: string␊ - _postalCode?: Element27␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - country?: string␊ - _country?: Element28␊ - period?: Period␊ - }␊ - /**␊ - * The value of the input parameter as a basic type.␊ - */␊ - export interface Age17 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element31␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element32␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element33␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element34␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element35␊ - }␊ - /**␊ - * A text note which also contains information about who made the statement and when.␊ - */␊ - export interface Annotation8 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - authorReference?: Reference␊ - /**␊ - * The individual responsible for making the annotation.␊ - */␊ - authorString?: string␊ - _authorString?: Element48␊ - /**␊ - * Indicates when this particular annotation was made.␊ - */␊ - time?: string␊ - _time?: Element49␊ - /**␊ - * The text of the annotation in markdown format.␊ - */␊ - text?: string␊ - _text?: Element50␊ - }␊ - /**␊ - * For referring to data content defined in other formats.␊ - */␊ - export interface Attachment31 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.␊ - */␊ - contentType?: string␊ - _contentType?: Element51␊ - /**␊ - * The human language of the content. The value can be any valid value according to BCP 47.␊ - */␊ - language?: string␊ - _language?: Element52␊ - /**␊ - * The actual data of the attachment - a sequence of bytes, base64 encoded.␊ - */␊ - data?: string␊ - _data?: Element53␊ - /**␊ - * A location where the data can be accessed.␊ - */␊ - url?: string␊ - _url?: Element54␊ - /**␊ - * The number of bytes of data that make up this attachment (before base64 encoding, if that is done).␊ - */␊ - size?: number␊ - _size?: Element55␊ - /**␊ - * The calculated hash of the data using SHA-1. Represented using base64.␊ - */␊ - hash?: string␊ - _hash?: Element56␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element57␊ - /**␊ - * The date that the attachment was first created.␊ - */␊ - creation?: string␊ - _creation?: Element58␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept583 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - export interface Coding39 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The identification of the code system that defines the meaning of the symbol in the code.␊ - */␊ - system?: string␊ - _system?: Element39␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element40␊ - /**␊ - * A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).␊ - */␊ - code?: string␊ - _code?: Element41␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element42␊ - /**␊ - * Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).␊ - */␊ - userSelected?: boolean␊ - _userSelected?: Element43␊ - }␊ - /**␊ - * Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.␊ - */␊ - export interface ContactPoint9 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Telecommunications form for contact point - what communications system is required to make use of the contact.␊ - */␊ - system?: ("phone" | "fax" | "email" | "pager" | "url" | "sms" | "other")␊ - _system?: Element59␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element60␊ - /**␊ - * Identifies the purpose for the contact point.␊ - */␊ - use?: ("home" | "work" | "temp" | "old" | "mobile")␊ - _use?: Element61␊ - /**␊ - * Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.␊ - */␊ - rank?: number␊ - _rank?: Element62␊ - period?: Period2␊ - }␊ - /**␊ - * The value of the input parameter as a basic type.␊ - */␊ - export interface Count7 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element63␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element64␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element65␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element66␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element67␊ - }␊ - /**␊ - * The value of the input parameter as a basic type.␊ - */␊ - export interface Distance7 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element68␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element69␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element70␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element71␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element72␊ - }␊ - /**␊ - * The value of the input parameter as a basic type.␊ - */␊ - export interface Duration33 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element73␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element74␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element75␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element76␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element77␊ - }␊ - /**␊ - * A human's name with the ability to identify parts and usage.␊ - */␊ - export interface HumanName11 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Identifies the purpose for this name.␊ - */␊ - use?: ("usual" | "official" | "temp" | "nickname" | "anonymous" | "old" | "maiden")␊ - _use?: Element78␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element79␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - family?: string␊ - _family?: Element80␊ - /**␊ - * Given name.␊ - */␊ - given?: String[]␊ - /**␊ - * Extensions for given␊ - */␊ - _given?: Element23[]␊ - /**␊ - * Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.␊ - */␊ - prefix?: String[]␊ - /**␊ - * Extensions for prefix␊ - */␊ - _prefix?: Element23[]␊ - /**␊ - * Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.␊ - */␊ - suffix?: String[]␊ - /**␊ - * Extensions for suffix␊ - */␊ - _suffix?: Element23[]␊ - period?: Period3␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier56 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * The value of the input parameter as a basic type.␊ - */␊ - export interface Money58 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period126 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity111 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * The value of the input parameter as a basic type.␊ - */␊ - export interface Range42 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - low?: Quantity1␊ - high?: Quantity2␊ - }␊ - /**␊ - * The value of the input parameter as a basic type.␊ - */␊ - export interface Ratio28 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - numerator?: Quantity3␊ - denominator?: Quantity4␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference463 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * The value of the input parameter as a basic type.␊ - */␊ - export interface SampledData9 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - origin: Quantity5␊ - /**␊ - * The length of time between sampling times, measured in milliseconds.␊ - */␊ - period?: number␊ - _period?: Element88␊ - /**␊ - * A correction factor that is applied to the sampled data points before they are added to the origin.␊ - */␊ - factor?: number␊ - _factor?: Element89␊ - /**␊ - * The lower limit of detection of the measured points. This is needed if any of the data points have the value "L" (lower than detection limit).␊ - */␊ - lowerLimit?: number␊ - _lowerLimit?: Element90␊ - /**␊ - * The upper limit of detection of the measured points. This is needed if any of the data points have the value "U" (higher than detection limit).␊ - */␊ - upperLimit?: number␊ - _upperLimit?: Element91␊ - /**␊ - * The number of sample points at each time point. If this value is greater than one, then the dimensions will be interlaced - all the sample points for a point in time will be recorded at once.␊ - */␊ - dimensions?: number␊ - _dimensions?: Element92␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - data?: string␊ - _data?: Element93␊ - }␊ - /**␊ - * A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities.␊ - */␊ - export interface Signature8 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document.␊ - */␊ - type: Coding[]␊ - /**␊ - * When the digital signature was signed.␊ - */␊ - when?: string␊ - _when?: Element94␊ - who: Reference3␊ - onBehalfOf?: Reference4␊ - /**␊ - * A mime type that indicates the technical format of the target resources signed by the signature.␊ - */␊ - targetFormat?: string␊ - _targetFormat?: Element95␊ - /**␊ - * A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jose for JWS, and image/* for a graphical image of a signature, etc.␊ - */␊ - sigFormat?: string␊ - _sigFormat?: Element96␊ - /**␊ - * The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty.␊ - */␊ - data?: string␊ - _data?: Element97␊ - }␊ - /**␊ - * Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.␊ - */␊ - export interface Timing27 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifies specific times when the event occurs.␊ - */␊ - event?: DateTime[]␊ - /**␊ - * Extensions for event␊ - */␊ - _event?: Element23[]␊ - repeat?: Timing_Repeat␊ - code?: CodeableConcept2␊ - }␊ - /**␊ - * Specifies contact information for a person or organization.␊ - */␊ - export interface ContactDetail8 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element109␊ - /**␊ - * The contact details for the individual (if a name was provided) or the organization.␊ - */␊ - telecom?: ContactPoint1[]␊ - }␊ - /**␊ - * The value of the input parameter as a basic type.␊ - */␊ - export interface Contributor7 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The type of contributor.␊ - */␊ - type?: ("author" | "editor" | "reviewer" | "endorser")␊ - _type?: Element110␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element111␊ - /**␊ - * Contact details to assist a user in finding and communicating with the contributor.␊ - */␊ - contact?: ContactDetail1[]␊ - }␊ - /**␊ - * Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.␊ - */␊ - export interface DataRequirement10 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - type?: string␊ - _type?: Element112␊ - /**␊ - * The profile of the required data, specified as the uri of the profile definition.␊ - */␊ - profile?: Canonical[]␊ - subjectCodeableConcept?: CodeableConcept3␊ - subjectReference?: Reference5␊ - /**␊ - * Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. ␊ - * ␊ - * The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details).␊ - */␊ - mustSupport?: String[]␊ - /**␊ - * Extensions for mustSupport␊ - */␊ - _mustSupport?: Element23[]␊ - /**␊ - * Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.␊ - */␊ - codeFilter?: DataRequirement_CodeFilter[]␊ - /**␊ - * Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.␊ - */␊ - dateFilter?: DataRequirement_DateFilter[]␊ - /**␊ - * Specifies a maximum number of results that are required (uses the _count search parameter).␊ - */␊ - limit?: number␊ - _limit?: Element118␊ - /**␊ - * Specifies the order of the results to be returned.␊ - */␊ - sort?: DataRequirement_Sort[]␊ - }␊ - /**␊ - * The value of the input parameter as a basic type.␊ - */␊ - export interface Expression18 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element121␊ - /**␊ - * A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.␊ - */␊ - name?: string␊ - _name?: Element122␊ - /**␊ - * The media type of the language for the expression.␊ - */␊ - language?: ("text/cql" | "text/fhirpath" | "application/x-fhir-query")␊ - _language?: Element123␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - expression?: string␊ - _expression?: Element124␊ - /**␊ - * A URI that defines where the expression is found.␊ - */␊ - reference?: string␊ - _reference?: Element125␊ - }␊ - /**␊ - * The parameters to the module. This collection specifies both the input and output parameters. Input parameters are provided by the caller as part of the $evaluate operation. Output parameters are included in the GuidanceResponse.␊ - */␊ - export interface ParameterDefinition8 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - name?: string␊ - _name?: Element126␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - use?: string␊ - _use?: Element127␊ - /**␊ - * The minimum number of times this parameter SHALL appear in the request or response.␊ - */␊ - min?: number␊ - _min?: Element128␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - max?: string␊ - _max?: Element129␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - documentation?: string␊ - _documentation?: Element130␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - type?: string␊ - _type?: Element131␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - profile?: string␊ - }␊ - /**␊ - * Related artifacts such as additional documentation, justification, or bibliographic references.␊ - */␊ - export interface RelatedArtifact8 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The type of relationship to the related artifact.␊ - */␊ - type?: ("documentation" | "justification" | "citation" | "predecessor" | "successor" | "derived-from" | "depends-on" | "composed-of")␊ - _type?: Element132␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - label?: string␊ - _label?: Element133␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element134␊ - /**␊ - * A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.␊ - */␊ - citation?: string␊ - _citation?: Element135␊ - /**␊ - * A url for the artifact that can be followed to access the actual content.␊ - */␊ - url?: string␊ - _url?: Element136␊ - document?: Attachment1␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - resource?: string␊ - }␊ - /**␊ - * A description of a triggering event. Triggering events can be named events, data events, or periodic, as determined by the type element.␊ - */␊ - export interface TriggerDefinition9 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The type of triggering event.␊ - */␊ - type?: ("named-event" | "periodic" | "data-changed" | "data-added" | "data-modified" | "data-removed" | "data-accessed" | "data-access-ended")␊ - _type?: Element137␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element138␊ - timingTiming?: Timing1␊ - timingReference?: Reference6␊ - /**␊ - * The timing of the event (if this is a periodic trigger).␊ - */␊ - timingDate?: string␊ - _timingDate?: Element139␊ - /**␊ - * The timing of the event (if this is a periodic trigger).␊ - */␊ - timingDateTime?: string␊ - _timingDateTime?: Element140␊ - /**␊ - * The triggering data of the event (if this is a data trigger). If more than one data is requirement is specified, then all the data requirements must be true.␊ - */␊ - data?: DataRequirement1[]␊ - condition?: Expression1␊ - }␊ - /**␊ - * Specifies clinical/business/etc. metadata that can be used to retrieve, index and/or categorize an artifact. This metadata can either be specific to the applicable population (e.g., age category, DRG) or the specific context of care (e.g., venue, care setting, provider of care).␊ - */␊ - export interface UsageContext8 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - code: Coding2␊ - valueCodeableConcept?: CodeableConcept4␊ - valueQuantity?: Quantity6␊ - valueRange?: Range2␊ - valueReference?: Reference7␊ - }␊ - /**␊ - * Indicates how the medication is/was taken or should be taken by the patient.␊ - */␊ - export interface Dosage8 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Indicates the order in which the dosage instructions should be applied or interpreted.␊ - */␊ - sequence?: number␊ - _sequence?: Element141␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element142␊ - /**␊ - * Supplemental instructions to the patient on how to take the medication (e.g. "with meals" or"take half to one hour before food") or warnings for the patient about the medication (e.g. "may cause drowsiness" or "avoid exposure of skin to direct sunlight or sunlamps").␊ - */␊ - additionalInstruction?: CodeableConcept5[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - patientInstruction?: string␊ - _patientInstruction?: Element143␊ - timing?: Timing2␊ - /**␊ - * Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).␊ - */␊ - asNeededBoolean?: boolean␊ - _asNeededBoolean?: Element144␊ - asNeededCodeableConcept?: CodeableConcept6␊ - site?: CodeableConcept7␊ - route?: CodeableConcept8␊ - method?: CodeableConcept9␊ - /**␊ - * The amount of medication administered.␊ - */␊ - doseAndRate?: Dosage_DoseAndRate[]␊ - maxDosePerPeriod?: Ratio2␊ - maxDosePerAdministration?: Quantity9␊ - maxDosePerLifetime?: Quantity10␊ - }␊ - /**␊ - * The value of the input parameter as a basic type.␊ - */␊ - export interface Meta147 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * A task to be performed.␊ - */␊ - export interface Task_Output {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - type: CodeableConcept584␊ - /**␊ - * The value of the Output parameter as a basic type.␊ - */␊ - valueBase64Binary?: string␊ - _valueBase64Binary?: Element2094␊ - /**␊ - * The value of the Output parameter as a basic type.␊ - */␊ - valueBoolean?: boolean␊ - _valueBoolean?: Element2095␊ - /**␊ - * The value of the Output parameter as a basic type.␊ - */␊ - valueCanonical?: string␊ - _valueCanonical?: Element2096␊ - /**␊ - * The value of the Output parameter as a basic type.␊ - */␊ - valueCode?: string␊ - _valueCode?: Element2097␊ - /**␊ - * The value of the Output parameter as a basic type.␊ - */␊ - valueDate?: string␊ - _valueDate?: Element2098␊ - /**␊ - * The value of the Output parameter as a basic type.␊ - */␊ - valueDateTime?: string␊ - _valueDateTime?: Element2099␊ - /**␊ - * The value of the Output parameter as a basic type.␊ - */␊ - valueDecimal?: number␊ - _valueDecimal?: Element2100␊ - /**␊ - * The value of the Output parameter as a basic type.␊ - */␊ - valueId?: string␊ - _valueId?: Element2101␊ - /**␊ - * The value of the Output parameter as a basic type.␊ - */␊ - valueInstant?: string␊ - _valueInstant?: Element2102␊ - /**␊ - * The value of the Output parameter as a basic type.␊ - */␊ - valueInteger?: number␊ - _valueInteger?: Element2103␊ - /**␊ - * The value of the Output parameter as a basic type.␊ - */␊ - valueMarkdown?: string␊ - _valueMarkdown?: Element2104␊ - /**␊ - * The value of the Output parameter as a basic type.␊ - */␊ - valueOid?: string␊ - _valueOid?: Element2105␊ - /**␊ - * The value of the Output parameter as a basic type.␊ - */␊ - valuePositiveInt?: number␊ - _valuePositiveInt?: Element2106␊ - /**␊ - * The value of the Output parameter as a basic type.␊ - */␊ - valueString?: string␊ - _valueString?: Element2107␊ - /**␊ - * The value of the Output parameter as a basic type.␊ - */␊ - valueTime?: string␊ - _valueTime?: Element2108␊ - /**␊ - * The value of the Output parameter as a basic type.␊ - */␊ - valueUnsignedInt?: number␊ - _valueUnsignedInt?: Element2109␊ - /**␊ - * The value of the Output parameter as a basic type.␊ - */␊ - valueUri?: string␊ - _valueUri?: Element2110␊ - /**␊ - * The value of the Output parameter as a basic type.␊ - */␊ - valueUrl?: string␊ - _valueUrl?: Element2111␊ - /**␊ - * The value of the Output parameter as a basic type.␊ - */␊ - valueUuid?: string␊ - _valueUuid?: Element2112␊ - valueAddress?: Address19␊ - valueAge?: Age18␊ - valueAnnotation?: Annotation9␊ - valueAttachment?: Attachment32␊ - valueCodeableConcept?: CodeableConcept585␊ - valueCoding?: Coding40␊ - valueContactPoint?: ContactPoint10␊ - valueCount?: Count8␊ - valueDistance?: Distance8␊ - valueDuration?: Duration34␊ - valueHumanName?: HumanName12␊ - valueIdentifier?: Identifier57␊ - valueMoney?: Money59␊ - valuePeriod?: Period127␊ - valueQuantity?: Quantity112␊ - valueRange?: Range43␊ - valueRatio?: Ratio29␊ - valueReference?: Reference464␊ - valueSampledData?: SampledData10␊ - valueSignature?: Signature9␊ - valueTiming?: Timing28␊ - valueContactDetail?: ContactDetail9␊ - valueContributor?: Contributor8␊ - valueDataRequirement?: DataRequirement11␊ - valueExpression?: Expression19␊ - valueParameterDefinition?: ParameterDefinition9␊ - valueRelatedArtifact?: RelatedArtifact9␊ - valueTriggerDefinition?: TriggerDefinition10␊ - valueUsageContext?: UsageContext9␊ - valueDosage?: Dosage9␊ - valueMeta?: Meta148␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept584 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2094 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2095 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2096 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2097 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2098 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2099 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2100 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2101 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2102 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2103 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2104 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2105 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2106 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2107 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2108 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2109 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2110 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2111 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2112 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.␊ - */␊ - export interface Address19 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this address.␊ - */␊ - use?: ("home" | "work" | "temp" | "old" | "billing")␊ - _use?: Element20␊ - /**␊ - * Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.␊ - */␊ - type?: ("postal" | "physical" | "both")␊ - _type?: Element21␊ - /**␊ - * Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.␊ - */␊ - text?: string␊ - _text?: Element22␊ - /**␊ - * This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.␊ - */␊ - line?: String[]␊ - /**␊ - * Extensions for line␊ - */␊ - _line?: Element23[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - city?: string␊ - _city?: Element24␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - district?: string␊ - _district?: Element25␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - state?: string␊ - _state?: Element26␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - postalCode?: string␊ - _postalCode?: Element27␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - country?: string␊ - _country?: Element28␊ - period?: Period␊ - }␊ - /**␊ - * The value of the Output parameter as a basic type.␊ - */␊ - export interface Age18 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element31␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element32␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element33␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element34␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element35␊ - }␊ - /**␊ - * A text note which also contains information about who made the statement and when.␊ - */␊ - export interface Annotation9 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - authorReference?: Reference␊ - /**␊ - * The individual responsible for making the annotation.␊ - */␊ - authorString?: string␊ - _authorString?: Element48␊ - /**␊ - * Indicates when this particular annotation was made.␊ - */␊ - time?: string␊ - _time?: Element49␊ - /**␊ - * The text of the annotation in markdown format.␊ - */␊ - text?: string␊ - _text?: Element50␊ - }␊ - /**␊ - * For referring to data content defined in other formats.␊ - */␊ - export interface Attachment32 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.␊ - */␊ - contentType?: string␊ - _contentType?: Element51␊ - /**␊ - * The human language of the content. The value can be any valid value according to BCP 47.␊ - */␊ - language?: string␊ - _language?: Element52␊ - /**␊ - * The actual data of the attachment - a sequence of bytes, base64 encoded.␊ - */␊ - data?: string␊ - _data?: Element53␊ - /**␊ - * A location where the data can be accessed.␊ - */␊ - url?: string␊ - _url?: Element54␊ - /**␊ - * The number of bytes of data that make up this attachment (before base64 encoding, if that is done).␊ - */␊ - size?: number␊ - _size?: Element55␊ - /**␊ - * The calculated hash of the data using SHA-1. Represented using base64.␊ - */␊ - hash?: string␊ - _hash?: Element56␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element57␊ - /**␊ - * The date that the attachment was first created.␊ - */␊ - creation?: string␊ - _creation?: Element58␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept585 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - export interface Coding40 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The identification of the code system that defines the meaning of the symbol in the code.␊ - */␊ - system?: string␊ - _system?: Element39␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element40␊ - /**␊ - * A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).␊ - */␊ - code?: string␊ - _code?: Element41␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element42␊ - /**␊ - * Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).␊ - */␊ - userSelected?: boolean␊ - _userSelected?: Element43␊ - }␊ - /**␊ - * Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.␊ - */␊ - export interface ContactPoint10 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Telecommunications form for contact point - what communications system is required to make use of the contact.␊ - */␊ - system?: ("phone" | "fax" | "email" | "pager" | "url" | "sms" | "other")␊ - _system?: Element59␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element60␊ - /**␊ - * Identifies the purpose for the contact point.␊ - */␊ - use?: ("home" | "work" | "temp" | "old" | "mobile")␊ - _use?: Element61␊ - /**␊ - * Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.␊ - */␊ - rank?: number␊ - _rank?: Element62␊ - period?: Period2␊ - }␊ - /**␊ - * The value of the Output parameter as a basic type.␊ - */␊ - export interface Count8 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element63␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element64␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element65␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element66␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element67␊ - }␊ - /**␊ - * The value of the Output parameter as a basic type.␊ - */␊ - export interface Distance8 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element68␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element69␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element70␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element71␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element72␊ - }␊ - /**␊ - * The value of the Output parameter as a basic type.␊ - */␊ - export interface Duration34 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element73␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element74␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element75␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element76␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element77␊ - }␊ - /**␊ - * A human's name with the ability to identify parts and usage.␊ - */␊ - export interface HumanName12 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Identifies the purpose for this name.␊ - */␊ - use?: ("usual" | "official" | "temp" | "nickname" | "anonymous" | "old" | "maiden")␊ - _use?: Element78␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element79␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - family?: string␊ - _family?: Element80␊ - /**␊ - * Given name.␊ - */␊ - given?: String[]␊ - /**␊ - * Extensions for given␊ - */␊ - _given?: Element23[]␊ - /**␊ - * Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.␊ - */␊ - prefix?: String[]␊ - /**␊ - * Extensions for prefix␊ - */␊ - _prefix?: Element23[]␊ - /**␊ - * Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.␊ - */␊ - suffix?: String[]␊ - /**␊ - * Extensions for suffix␊ - */␊ - _suffix?: Element23[]␊ - period?: Period3␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier57 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * The value of the Output parameter as a basic type.␊ - */␊ - export interface Money59 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * Numerical value (with implicit precision).␊ - */␊ - value?: number␊ - _value?: Element81␊ - /**␊ - * ISO 4217 Currency Code.␊ - */␊ - currency?: string␊ - _currency?: Element82␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period127 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity112 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * The value of the Output parameter as a basic type.␊ - */␊ - export interface Range43 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - low?: Quantity1␊ - high?: Quantity2␊ - }␊ - /**␊ - * The value of the Output parameter as a basic type.␊ - */␊ - export interface Ratio29 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - numerator?: Quantity3␊ - denominator?: Quantity4␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference464 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * The value of the Output parameter as a basic type.␊ - */␊ - export interface SampledData10 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - origin: Quantity5␊ - /**␊ - * The length of time between sampling times, measured in milliseconds.␊ - */␊ - period?: number␊ - _period?: Element88␊ - /**␊ - * A correction factor that is applied to the sampled data points before they are added to the origin.␊ - */␊ - factor?: number␊ - _factor?: Element89␊ - /**␊ - * The lower limit of detection of the measured points. This is needed if any of the data points have the value "L" (lower than detection limit).␊ - */␊ - lowerLimit?: number␊ - _lowerLimit?: Element90␊ - /**␊ - * The upper limit of detection of the measured points. This is needed if any of the data points have the value "U" (higher than detection limit).␊ - */␊ - upperLimit?: number␊ - _upperLimit?: Element91␊ - /**␊ - * The number of sample points at each time point. If this value is greater than one, then the dimensions will be interlaced - all the sample points for a point in time will be recorded at once.␊ - */␊ - dimensions?: number␊ - _dimensions?: Element92␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - data?: string␊ - _data?: Element93␊ - }␊ - /**␊ - * A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities.␊ - */␊ - export interface Signature9 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document.␊ - */␊ - type: Coding[]␊ - /**␊ - * When the digital signature was signed.␊ - */␊ - when?: string␊ - _when?: Element94␊ - who: Reference3␊ - onBehalfOf?: Reference4␊ - /**␊ - * A mime type that indicates the technical format of the target resources signed by the signature.␊ - */␊ - targetFormat?: string␊ - _targetFormat?: Element95␊ - /**␊ - * A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jose for JWS, and image/* for a graphical image of a signature, etc.␊ - */␊ - sigFormat?: string␊ - _sigFormat?: Element96␊ - /**␊ - * The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty.␊ - */␊ - data?: string␊ - _data?: Element97␊ - }␊ - /**␊ - * Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.␊ - */␊ - export interface Timing28 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifies specific times when the event occurs.␊ - */␊ - event?: DateTime[]␊ - /**␊ - * Extensions for event␊ - */␊ - _event?: Element23[]␊ - repeat?: Timing_Repeat␊ - code?: CodeableConcept2␊ - }␊ - /**␊ - * Specifies contact information for a person or organization.␊ - */␊ - export interface ContactDetail9 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element109␊ - /**␊ - * The contact details for the individual (if a name was provided) or the organization.␊ - */␊ - telecom?: ContactPoint1[]␊ - }␊ - /**␊ - * The value of the Output parameter as a basic type.␊ - */␊ - export interface Contributor8 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The type of contributor.␊ - */␊ - type?: ("author" | "editor" | "reviewer" | "endorser")␊ - _type?: Element110␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element111␊ - /**␊ - * Contact details to assist a user in finding and communicating with the contributor.␊ - */␊ - contact?: ContactDetail1[]␊ - }␊ - /**␊ - * Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.␊ - */␊ - export interface DataRequirement11 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - type?: string␊ - _type?: Element112␊ - /**␊ - * The profile of the required data, specified as the uri of the profile definition.␊ - */␊ - profile?: Canonical[]␊ - subjectCodeableConcept?: CodeableConcept3␊ - subjectReference?: Reference5␊ - /**␊ - * Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. ␊ - * ␊ - * The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details).␊ - */␊ - mustSupport?: String[]␊ - /**␊ - * Extensions for mustSupport␊ - */␊ - _mustSupport?: Element23[]␊ - /**␊ - * Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.␊ - */␊ - codeFilter?: DataRequirement_CodeFilter[]␊ - /**␊ - * Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.␊ - */␊ - dateFilter?: DataRequirement_DateFilter[]␊ - /**␊ - * Specifies a maximum number of results that are required (uses the _count search parameter).␊ - */␊ - limit?: number␊ - _limit?: Element118␊ - /**␊ - * Specifies the order of the results to be returned.␊ - */␊ - sort?: DataRequirement_Sort[]␊ - }␊ - /**␊ - * The value of the Output parameter as a basic type.␊ - */␊ - export interface Expression19 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element121␊ - /**␊ - * A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.␊ - */␊ - name?: string␊ - _name?: Element122␊ - /**␊ - * The media type of the language for the expression.␊ - */␊ - language?: ("text/cql" | "text/fhirpath" | "application/x-fhir-query")␊ - _language?: Element123␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - expression?: string␊ - _expression?: Element124␊ - /**␊ - * A URI that defines where the expression is found.␊ - */␊ - reference?: string␊ - _reference?: Element125␊ - }␊ - /**␊ - * The parameters to the module. This collection specifies both the input and output parameters. Input parameters are provided by the caller as part of the $evaluate operation. Output parameters are included in the GuidanceResponse.␊ - */␊ - export interface ParameterDefinition9 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - name?: string␊ - _name?: Element126␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - use?: string␊ - _use?: Element127␊ - /**␊ - * The minimum number of times this parameter SHALL appear in the request or response.␊ - */␊ - min?: number␊ - _min?: Element128␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - max?: string␊ - _max?: Element129␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - documentation?: string␊ - _documentation?: Element130␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - type?: string␊ - _type?: Element131␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - profile?: string␊ - }␊ - /**␊ - * Related artifacts such as additional documentation, justification, or bibliographic references.␊ - */␊ - export interface RelatedArtifact9 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The type of relationship to the related artifact.␊ - */␊ - type?: ("documentation" | "justification" | "citation" | "predecessor" | "successor" | "derived-from" | "depends-on" | "composed-of")␊ - _type?: Element132␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - label?: string␊ - _label?: Element133␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element134␊ - /**␊ - * A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.␊ - */␊ - citation?: string␊ - _citation?: Element135␊ - /**␊ - * A url for the artifact that can be followed to access the actual content.␊ - */␊ - url?: string␊ - _url?: Element136␊ - document?: Attachment1␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - resource?: string␊ - }␊ - /**␊ - * A description of a triggering event. Triggering events can be named events, data events, or periodic, as determined by the type element.␊ - */␊ - export interface TriggerDefinition10 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The type of triggering event.␊ - */␊ - type?: ("named-event" | "periodic" | "data-changed" | "data-added" | "data-modified" | "data-removed" | "data-accessed" | "data-access-ended")␊ - _type?: Element137␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element138␊ - timingTiming?: Timing1␊ - timingReference?: Reference6␊ - /**␊ - * The timing of the event (if this is a periodic trigger).␊ - */␊ - timingDate?: string␊ - _timingDate?: Element139␊ - /**␊ - * The timing of the event (if this is a periodic trigger).␊ - */␊ - timingDateTime?: string␊ - _timingDateTime?: Element140␊ - /**␊ - * The triggering data of the event (if this is a data trigger). If more than one data is requirement is specified, then all the data requirements must be true.␊ - */␊ - data?: DataRequirement1[]␊ - condition?: Expression1␊ - }␊ - /**␊ - * Specifies clinical/business/etc. metadata that can be used to retrieve, index and/or categorize an artifact. This metadata can either be specific to the applicable population (e.g., age category, DRG) or the specific context of care (e.g., venue, care setting, provider of care).␊ - */␊ - export interface UsageContext9 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - code: Coding2␊ - valueCodeableConcept?: CodeableConcept4␊ - valueQuantity?: Quantity6␊ - valueRange?: Range2␊ - valueReference?: Reference7␊ - }␊ - /**␊ - * Indicates how the medication is/was taken or should be taken by the patient.␊ - */␊ - export interface Dosage9 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Indicates the order in which the dosage instructions should be applied or interpreted.␊ - */␊ - sequence?: number␊ - _sequence?: Element141␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element142␊ - /**␊ - * Supplemental instructions to the patient on how to take the medication (e.g. "with meals" or"take half to one hour before food") or warnings for the patient about the medication (e.g. "may cause drowsiness" or "avoid exposure of skin to direct sunlight or sunlamps").␊ - */␊ - additionalInstruction?: CodeableConcept5[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - patientInstruction?: string␊ - _patientInstruction?: Element143␊ - timing?: Timing2␊ - /**␊ - * Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).␊ - */␊ - asNeededBoolean?: boolean␊ - _asNeededBoolean?: Element144␊ - asNeededCodeableConcept?: CodeableConcept6␊ - site?: CodeableConcept7␊ - route?: CodeableConcept8␊ - method?: CodeableConcept9␊ - /**␊ - * The amount of medication administered.␊ - */␊ - doseAndRate?: Dosage_DoseAndRate[]␊ - maxDosePerPeriod?: Ratio2␊ - maxDosePerAdministration?: Quantity9␊ - maxDosePerLifetime?: Quantity10␊ - }␊ - /**␊ - * The value of the Output parameter as a basic type.␊ - */␊ - export interface Meta148 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * A TerminologyCapabilities resource documents a set of capabilities (behaviors) of a FHIR Terminology Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.␊ - */␊ - export interface TerminologyCapabilities {␊ - /**␊ - * This is a TerminologyCapabilities resource␊ - */␊ - resourceType: "TerminologyCapabilities"␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - id?: string␊ - meta?: Meta149␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element2113␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element2114␊ - text?: Narrative138␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - url?: string␊ - _url?: Element2115␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element2116␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element2117␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element2118␊ - /**␊ - * The status of this terminology capabilities. Enables tracking the life-cycle of the content.␊ - */␊ - status?: ("draft" | "active" | "retired" | "unknown")␊ - _status?: Element2119␊ - /**␊ - * A Boolean value to indicate that this terminology capabilities is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.␊ - */␊ - experimental?: boolean␊ - _experimental?: Element2120␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - date?: string␊ - _date?: Element2121␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - publisher?: string␊ - _publisher?: Element2122␊ - /**␊ - * Contact details to assist a user in finding and communicating with the publisher.␊ - */␊ - contact?: ContactDetail1[]␊ - /**␊ - * A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine␊ - */␊ - description?: string␊ - _description?: Element2123␊ - /**␊ - * The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate terminology capabilities instances.␊ - */␊ - useContext?: UsageContext1[]␊ - /**␊ - * A legal or geographic region in which the terminology capabilities is intended to be used.␊ - */␊ - jurisdiction?: CodeableConcept5[]␊ - /**␊ - * A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine␊ - */␊ - purpose?: string␊ - _purpose?: Element2124␊ - /**␊ - * A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine␊ - */␊ - copyright?: string␊ - _copyright?: Element2125␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - kind?: string␊ - _kind?: Element2126␊ - software?: TerminologyCapabilities_Software␊ - implementation?: TerminologyCapabilities_Implementation␊ - /**␊ - * Whether the server supports lockedDate.␊ - */␊ - lockedDate?: boolean␊ - _lockedDate?: Element2131␊ - /**␊ - * Identifies a code system that is supported by the server. If there is a no code system URL, then this declares the general assumptions a client can make about support for any CodeSystem resource.␊ - */␊ - codeSystem?: TerminologyCapabilities_CodeSystem[]␊ - expansion?: TerminologyCapabilities_Expansion␊ - /**␊ - * The degree to which the server supports the code search parameter on ValueSet, if it is supported.␊ - */␊ - codeSearch?: ("explicit" | "all")␊ - _codeSearch?: Element2143␊ - validateCode?: TerminologyCapabilities_ValidateCode␊ - translation?: TerminologyCapabilities_Translation␊ - closure?: TerminologyCapabilities_Closure␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta149 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2113 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2114 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative138 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2115 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2116 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2117 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2118 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2119 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2120 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2121 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2122 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2123 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2124 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2125 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2126 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Software that is covered by this terminology capability statement. It is used when the statement describes the capabilities of a particular software version, independent of an installation.␊ - */␊ - export interface TerminologyCapabilities_Software {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element2127␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element2128␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2127 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2128 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Identifies a specific implementation instance that is described by the terminology capability statement - i.e. a particular installation, rather than the capabilities of a software program.␊ - */␊ - export interface TerminologyCapabilities_Implementation {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element2129␊ - /**␊ - * An absolute base URL for the implementation.␊ - */␊ - url?: string␊ - _url?: Element2130␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2129 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2130 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2131 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A TerminologyCapabilities resource documents a set of capabilities (behaviors) of a FHIR Terminology Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.␊ - */␊ - export interface TerminologyCapabilities_CodeSystem {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - uri?: string␊ - /**␊ - * For the code system, a list of versions that are supported by the server.␊ - */␊ - version?: TerminologyCapabilities_Version[]␊ - /**␊ - * True if subsumption is supported for this version of the code system.␊ - */␊ - subsumption?: boolean␊ - _subsumption?: Element2136␊ - }␊ - /**␊ - * A TerminologyCapabilities resource documents a set of capabilities (behaviors) of a FHIR Terminology Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.␊ - */␊ - export interface TerminologyCapabilities_Version {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - code?: string␊ - _code?: Element2132␊ - /**␊ - * If this is the default version for this code system.␊ - */␊ - isDefault?: boolean␊ - _isDefault?: Element2133␊ - /**␊ - * If the compositional grammar defined by the code system is supported.␊ - */␊ - compositional?: boolean␊ - _compositional?: Element2134␊ - /**␊ - * Language Displays supported.␊ - */␊ - language?: Code[]␊ - /**␊ - * Extensions for language␊ - */␊ - _language?: Element23[]␊ - /**␊ - * Filter Properties supported.␊ - */␊ - filter?: TerminologyCapabilities_Filter[]␊ - /**␊ - * Properties supported for $lookup.␊ - */␊ - property?: Code[]␊ - /**␊ - * Extensions for property␊ - */␊ - _property?: Element23[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2132 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2133 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2134 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A TerminologyCapabilities resource documents a set of capabilities (behaviors) of a FHIR Terminology Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.␊ - */␊ - export interface TerminologyCapabilities_Filter {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - code?: string␊ - _code?: Element2135␊ - /**␊ - * Operations supported for the property.␊ - */␊ - op?: Code[]␊ - /**␊ - * Extensions for op␊ - */␊ - _op?: Element23[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2135 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2136 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Information about the [ValueSet/$expand](valueset-operation-expand.html) operation.␊ - */␊ - export interface TerminologyCapabilities_Expansion {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Whether the server can return nested value sets.␊ - */␊ - hierarchical?: boolean␊ - _hierarchical?: Element2137␊ - /**␊ - * Whether the server supports paging on expansion.␊ - */␊ - paging?: boolean␊ - _paging?: Element2138␊ - /**␊ - * Allow request for incomplete expansions?␊ - */␊ - incomplete?: boolean␊ - _incomplete?: Element2139␊ - /**␊ - * Supported expansion parameter.␊ - */␊ - parameter?: TerminologyCapabilities_Parameter[]␊ - /**␊ - * A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine␊ - */␊ - textFilter?: string␊ - _textFilter?: Element2142␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2137 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2138 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2139 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A TerminologyCapabilities resource documents a set of capabilities (behaviors) of a FHIR Terminology Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.␊ - */␊ - export interface TerminologyCapabilities_Parameter {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - name?: string␊ - _name?: Element2140␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - documentation?: string␊ - _documentation?: Element2141␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2140 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2141 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2142 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2143 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Information about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operation.␊ - */␊ - export interface TerminologyCapabilities_ValidateCode {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Whether translations are validated.␊ - */␊ - translations?: boolean␊ - _translations?: Element2144␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2144 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Information about the [ConceptMap/$translate](conceptmap-operation-translate.html) operation.␊ - */␊ - export interface TerminologyCapabilities_Translation {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Whether the client must identify the map.␊ - */␊ - needsMap?: boolean␊ - _needsMap?: Element2145␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2145 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Whether the $closure operation is supported.␊ - */␊ - export interface TerminologyCapabilities_Closure {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * If cross-system closure is supported.␊ - */␊ - translation?: boolean␊ - _translation?: Element2146␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2146 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A summary of information based on the results of executing a TestScript.␊ - */␊ - export interface TestReport {␊ - /**␊ - * This is a TestReport resource␊ - */␊ - resourceType: "TestReport"␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - id?: string␊ - meta?: Meta150␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element2147␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element2148␊ - text?: Narrative139␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - identifier?: Identifier58␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element2149␊ - /**␊ - * The current state of this test report.␊ - */␊ - status?: ("completed" | "in-progress" | "waiting" | "stopped" | "entered-in-error")␊ - _status?: Element2150␊ - testScript: Reference465␊ - /**␊ - * The overall result from the execution of the TestScript.␊ - */␊ - result?: ("pass" | "fail" | "pending")␊ - _result?: Element2151␊ - /**␊ - * A rational number with implicit precision␊ - */␊ - score?: number␊ - _score?: Element2152␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - tester?: string␊ - _tester?: Element2153␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - issued?: string␊ - _issued?: Element2154␊ - /**␊ - * A participant in the test execution, either the execution engine, a client, or a server.␊ - */␊ - participant?: TestReport_Participant[]␊ - setup?: TestReport_Setup␊ - /**␊ - * A test executed from the test script.␊ - */␊ - test?: TestReport_Test[]␊ - teardown?: TestReport_Teardown␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta150 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2147 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2148 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative139 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier58 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2149 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2150 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference465 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2151 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2152 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2153 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2154 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A summary of information based on the results of executing a TestScript.␊ - */␊ - export interface TestReport_Participant {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * The type of participant.␊ - */␊ - type?: ("test-engine" | "client" | "server")␊ - _type?: Element2155␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - uri?: string␊ - _uri?: Element2156␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element2157␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2155 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2156 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2157 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The results of the series of required setup operations before the tests were executed.␊ - */␊ - export interface TestReport_Setup {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Action would contain either an operation or an assertion.␊ - */␊ - action: TestReport_Action[]␊ - }␊ - /**␊ - * A summary of information based on the results of executing a TestScript.␊ - */␊ - export interface TestReport_Action {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - operation?: TestReport_Operation␊ - assert?: TestReport_Assert␊ - }␊ - /**␊ - * The operation performed.␊ - */␊ - export interface TestReport_Operation {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * The result of this operation.␊ - */␊ - result?: ("pass" | "skip" | "fail" | "warning" | "error")␊ - _result?: Element2158␊ - /**␊ - * A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine␊ - */␊ - message?: string␊ - _message?: Element2159␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - detail?: string␊ - _detail?: Element2160␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2158 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2159 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2160 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * The results of the assertion performed on the previous operations.␊ - */␊ - export interface TestReport_Assert {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * The result of this assertion.␊ - */␊ - result?: ("pass" | "skip" | "fail" | "warning" | "error")␊ - _result?: Element2161␊ - /**␊ - * A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine␊ - */␊ - message?: string␊ - _message?: Element2162␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - detail?: string␊ - _detail?: Element2163␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2161 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2162 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2163 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A summary of information based on the results of executing a TestScript.␊ - */␊ - export interface TestReport_Test {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element2164␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element2165␊ - /**␊ - * Action would contain either an operation or an assertion.␊ - */␊ - action: TestReport_Action1[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2164 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2165 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A summary of information based on the results of executing a TestScript.␊ - */␊ - export interface TestReport_Action1 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - operation?: TestReport_Operation1␊ - assert?: TestReport_Assert1␊ - }␊ - /**␊ - * An operation would involve a REST request to a server.␊ - */␊ - export interface TestReport_Operation1 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * The result of this operation.␊ - */␊ - result?: ("pass" | "skip" | "fail" | "warning" | "error")␊ - _result?: Element2158␊ - /**␊ - * A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine␊ - */␊ - message?: string␊ - _message?: Element2159␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - detail?: string␊ - _detail?: Element2160␊ - }␊ - /**␊ - * The results of the assertion performed on the previous operations.␊ - */␊ - export interface TestReport_Assert1 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * The result of this assertion.␊ - */␊ - result?: ("pass" | "skip" | "fail" | "warning" | "error")␊ - _result?: Element2161␊ - /**␊ - * A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine␊ - */␊ - message?: string␊ - _message?: Element2162␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - detail?: string␊ - _detail?: Element2163␊ - }␊ - /**␊ - * The results of the series of operations required to clean up after all the tests were executed (successfully or otherwise).␊ - */␊ - export interface TestReport_Teardown {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * The teardown action will only contain an operation.␊ - */␊ - action: TestReport_Action2[]␊ - }␊ - /**␊ - * A summary of information based on the results of executing a TestScript.␊ - */␊ - export interface TestReport_Action2 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - operation: TestReport_Operation2␊ - }␊ - /**␊ - * An operation would involve a REST request to a server.␊ - */␊ - export interface TestReport_Operation2 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * The result of this operation.␊ - */␊ - result?: ("pass" | "skip" | "fail" | "warning" | "error")␊ - _result?: Element2158␊ - /**␊ - * A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine␊ - */␊ - message?: string␊ - _message?: Element2159␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - detail?: string␊ - _detail?: Element2160␊ - }␊ - /**␊ - * A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.␊ - */␊ - export interface TestScript {␊ - /**␊ - * This is a TestScript resource␊ - */␊ - resourceType: "TestScript"␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - id?: string␊ - meta?: Meta151␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element2166␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element2167␊ - text?: Narrative140␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - url?: string␊ - _url?: Element2168␊ - identifier?: Identifier59␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element2169␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element2170␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element2171␊ - /**␊ - * The status of this test script. Enables tracking the life-cycle of the content.␊ - */␊ - status?: ("draft" | "active" | "retired" | "unknown")␊ - _status?: Element2172␊ - /**␊ - * A Boolean value to indicate that this test script is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.␊ - */␊ - experimental?: boolean␊ - _experimental?: Element2173␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - date?: string␊ - _date?: Element2174␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - publisher?: string␊ - _publisher?: Element2175␊ - /**␊ - * Contact details to assist a user in finding and communicating with the publisher.␊ - */␊ - contact?: ContactDetail1[]␊ - /**␊ - * A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine␊ - */␊ - description?: string␊ - _description?: Element2176␊ - /**␊ - * The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate test script instances.␊ - */␊ - useContext?: UsageContext1[]␊ - /**␊ - * A legal or geographic region in which the test script is intended to be used.␊ - */␊ - jurisdiction?: CodeableConcept5[]␊ - /**␊ - * A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine␊ - */␊ - purpose?: string␊ - _purpose?: Element2177␊ - /**␊ - * A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine␊ - */␊ - copyright?: string␊ - _copyright?: Element2178␊ - /**␊ - * An abstract server used in operations within this test script in the origin element.␊ - */␊ - origin?: TestScript_Origin[]␊ - /**␊ - * An abstract server used in operations within this test script in the destination element.␊ - */␊ - destination?: TestScript_Destination[]␊ - metadata?: TestScript_Metadata␊ - /**␊ - * Fixture in the test script - by reference (uri). All fixtures are required for the test script to execute.␊ - */␊ - fixture?: TestScript_Fixture[]␊ - /**␊ - * Reference to the profile to be used for validation.␊ - */␊ - profile?: Reference11[]␊ - /**␊ - * Variable is set based either on element value in response body or on header field value in the response headers.␊ - */␊ - variable?: TestScript_Variable[]␊ - setup?: TestScript_Setup␊ - /**␊ - * A test in this script.␊ - */␊ - test?: TestScript_Test[]␊ - teardown?: TestScript_Teardown␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta151 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2166 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2167 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative140 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2168 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.␊ - */␊ - export interface Identifier59 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The purpose of this identifier.␊ - */␊ - use?: ("usual" | "official" | "temp" | "secondary" | "old")␊ - _use?: Element38␊ - type?: CodeableConcept␊ - /**␊ - * Establishes the namespace for the value - that is, a URL that describes a set values that are unique.␊ - */␊ - system?: string␊ - _system?: Element45␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element46␊ - period?: Period1␊ - assigner?: Reference1␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2169 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2170 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2171 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2172 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2173 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2174 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2175 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2176 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2177 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2178 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.␊ - */␊ - export interface TestScript_Origin {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A whole number␊ - */␊ - index?: number␊ - _index?: Element2179␊ - profile: Coding41␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2179 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - export interface Coding41 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The identification of the code system that defines the meaning of the symbol in the code.␊ - */␊ - system?: string␊ - _system?: Element39␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element40␊ - /**␊ - * A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).␊ - */␊ - code?: string␊ - _code?: Element41␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element42␊ - /**␊ - * Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).␊ - */␊ - userSelected?: boolean␊ - _userSelected?: Element43␊ - }␊ - /**␊ - * A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.␊ - */␊ - export interface TestScript_Destination {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A whole number␊ - */␊ - index?: number␊ - _index?: Element2180␊ - profile: Coding42␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2180 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - export interface Coding42 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The identification of the code system that defines the meaning of the symbol in the code.␊ - */␊ - system?: string␊ - _system?: Element39␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element40␊ - /**␊ - * A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).␊ - */␊ - code?: string␊ - _code?: Element41␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element42␊ - /**␊ - * Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).␊ - */␊ - userSelected?: boolean␊ - _userSelected?: Element43␊ - }␊ - /**␊ - * The required capability must exist and are assumed to function correctly on the FHIR server being tested.␊ - */␊ - export interface TestScript_Metadata {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A link to the FHIR specification that this test is covering.␊ - */␊ - link?: TestScript_Link[]␊ - /**␊ - * Capabilities that must exist and are assumed to function correctly on the FHIR server being tested.␊ - */␊ - capability: TestScript_Capability[]␊ - }␊ - /**␊ - * A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.␊ - */␊ - export interface TestScript_Link {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - url?: string␊ - _url?: Element2181␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element2182␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2181 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2182 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.␊ - */␊ - export interface TestScript_Capability {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Whether or not the test execution will require the given capabilities of the server in order for this test script to execute.␊ - */␊ - required?: boolean␊ - _required?: Element2183␊ - /**␊ - * Whether or not the test execution will validate the given capabilities of the server in order for this test script to execute.␊ - */␊ - validated?: boolean␊ - _validated?: Element2184␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element2185␊ - /**␊ - * Which origin server these requirements apply to.␊ - */␊ - origin?: Integer[]␊ - /**␊ - * Extensions for origin␊ - */␊ - _origin?: Element23[]␊ - /**␊ - * A whole number␊ - */␊ - destination?: number␊ - _destination?: Element2186␊ - /**␊ - * Links to the FHIR specification that describes this interaction and the resources involved in more detail.␊ - */␊ - link?: Uri[]␊ - /**␊ - * Extensions for link␊ - */␊ - _link?: Element23[]␊ - /**␊ - * A URI that is a reference to a canonical URL on a FHIR resource␊ - */␊ - capabilities: string␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2183 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2184 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2185 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2186 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.␊ - */␊ - export interface TestScript_Fixture {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Whether or not to implicitly create the fixture during setup. If true, the fixture is automatically created on each server being tested during setup, therefore no create operation is required for this fixture in the TestScript.setup section.␊ - */␊ - autocreate?: boolean␊ - _autocreate?: Element2187␊ - /**␊ - * Whether or not to implicitly delete the fixture during teardown. If true, the fixture is automatically deleted on each server being tested during teardown, therefore no delete operation is required for this fixture in the TestScript.teardown section.␊ - */␊ - autodelete?: boolean␊ - _autodelete?: Element2188␊ - resource?: Reference466␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2187 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2188 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference466 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.␊ - */␊ - export interface TestScript_Variable {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element2189␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - defaultValue?: string␊ - _defaultValue?: Element2190␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element2191␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - expression?: string␊ - _expression?: Element2192␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - headerField?: string␊ - _headerField?: Element2193␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - hint?: string␊ - _hint?: Element2194␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - path?: string␊ - _path?: Element2195␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - sourceId?: string␊ - _sourceId?: Element2196␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2189 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2190 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2191 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2192 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2193 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2194 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2195 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2196 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A series of required setup operations before tests are executed.␊ - */␊ - export interface TestScript_Setup {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Action would contain either an operation or an assertion.␊ - */␊ - action: TestScript_Action[]␊ - }␊ - /**␊ - * A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.␊ - */␊ - export interface TestScript_Action {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - operation?: TestScript_Operation␊ - assert?: TestScript_Assert␊ - }␊ - /**␊ - * The operation to perform.␊ - */␊ - export interface TestScript_Operation {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - type?: Coding43␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - resource?: string␊ - _resource?: Element2197␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - label?: string␊ - _label?: Element2198␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element2199␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - accept?: string␊ - _accept?: Element2200␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - contentType?: string␊ - _contentType?: Element2201␊ - /**␊ - * A whole number␊ - */␊ - destination?: number␊ - _destination?: Element2202␊ - /**␊ - * Whether or not to implicitly send the request url in encoded format. The default is true to match the standard RESTful client behavior. Set to false when communicating with a server that does not support encoded url paths.␊ - */␊ - encodeRequestUrl?: boolean␊ - _encodeRequestUrl?: Element2203␊ - /**␊ - * The HTTP method the test engine MUST use for this operation regardless of any other operation details.␊ - */␊ - method?: ("delete" | "get" | "options" | "patch" | "post" | "put" | "head")␊ - _method?: Element2204␊ - /**␊ - * A whole number␊ - */␊ - origin?: number␊ - _origin?: Element2205␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - params?: string␊ - _params?: Element2206␊ - /**␊ - * Header elements would be used to set HTTP headers.␊ - */␊ - requestHeader?: TestScript_RequestHeader[]␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - requestId?: string␊ - _requestId?: Element2209␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - responseId?: string␊ - _responseId?: Element2210␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - sourceId?: string␊ - _sourceId?: Element2211␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - targetId?: string␊ - _targetId?: Element2212␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - url?: string␊ - _url?: Element2213␊ - }␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - export interface Coding43 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The identification of the code system that defines the meaning of the symbol in the code.␊ - */␊ - system?: string␊ - _system?: Element39␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element40␊ - /**␊ - * A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).␊ - */␊ - code?: string␊ - _code?: Element41␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element42␊ - /**␊ - * Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).␊ - */␊ - userSelected?: boolean␊ - _userSelected?: Element43␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2197 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2198 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2199 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2200 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2201 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2202 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2203 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2204 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2205 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2206 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.␊ - */␊ - export interface TestScript_RequestHeader {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - field?: string␊ - _field?: Element2207␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element2208␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2207 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2208 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2209 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2210 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2211 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2212 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2213 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Evaluates the results of previous operations to determine if the server under test behaves appropriately.␊ - */␊ - export interface TestScript_Assert {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - label?: string␊ - _label?: Element2214␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element2215␊ - /**␊ - * The direction to use for the assertion.␊ - */␊ - direction?: ("response" | "request")␊ - _direction?: Element2216␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - compareToSourceId?: string␊ - _compareToSourceId?: Element2217␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - compareToSourceExpression?: string␊ - _compareToSourceExpression?: Element2218␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - compareToSourcePath?: string␊ - _compareToSourcePath?: Element2219␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - contentType?: string␊ - _contentType?: Element2220␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - expression?: string␊ - _expression?: Element2221␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - headerField?: string␊ - _headerField?: Element2222␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - minimumId?: string␊ - _minimumId?: Element2223␊ - /**␊ - * Whether or not the test execution performs validation on the bundle navigation links.␊ - */␊ - navigationLinks?: boolean␊ - _navigationLinks?: Element2224␊ - /**␊ - * The operator type defines the conditional behavior of the assert. If not defined, the default is equals.␊ - */␊ - operator?: ("equals" | "notEquals" | "in" | "notIn" | "greaterThan" | "lessThan" | "empty" | "notEmpty" | "contains" | "notContains" | "eval")␊ - _operator?: Element2225␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - path?: string␊ - _path?: Element2226␊ - /**␊ - * The request method or HTTP operation code to compare against that used by the client system under test.␊ - */␊ - requestMethod?: ("delete" | "get" | "options" | "patch" | "post" | "put" | "head")␊ - _requestMethod?: Element2227␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - requestURL?: string␊ - _requestURL?: Element2228␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - resource?: string␊ - _resource?: Element2229␊ - /**␊ - * okay | created | noContent | notModified | bad | forbidden | notFound | methodNotAllowed | conflict | gone | preconditionFailed | unprocessable.␊ - */␊ - response?: ("okay" | "created" | "noContent" | "notModified" | "bad" | "forbidden" | "notFound" | "methodNotAllowed" | "conflict" | "gone" | "preconditionFailed" | "unprocessable")␊ - _response?: Element2230␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - responseCode?: string␊ - _responseCode?: Element2231␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - sourceId?: string␊ - _sourceId?: Element2232␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - validateProfileId?: string␊ - _validateProfileId?: Element2233␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element2234␊ - /**␊ - * Whether or not the test execution will produce a warning only on error for this assert.␊ - */␊ - warningOnly?: boolean␊ - _warningOnly?: Element2235␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2214 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2215 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2216 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2217 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2218 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2219 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2220 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2221 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2222 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2223 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2224 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2225 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2226 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2227 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2228 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2229 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2230 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2231 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2232 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2233 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2234 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2235 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.␊ - */␊ - export interface TestScript_Test {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element2236␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element2237␊ - /**␊ - * Action would contain either an operation or an assertion.␊ - */␊ - action: TestScript_Action1[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2236 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2237 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.␊ - */␊ - export interface TestScript_Action1 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - operation?: TestScript_Operation1␊ - assert?: TestScript_Assert1␊ - }␊ - /**␊ - * An operation would involve a REST request to a server.␊ - */␊ - export interface TestScript_Operation1 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - type?: Coding43␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - resource?: string␊ - _resource?: Element2197␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - label?: string␊ - _label?: Element2198␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element2199␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - accept?: string␊ - _accept?: Element2200␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - contentType?: string␊ - _contentType?: Element2201␊ - /**␊ - * A whole number␊ - */␊ - destination?: number␊ - _destination?: Element2202␊ - /**␊ - * Whether or not to implicitly send the request url in encoded format. The default is true to match the standard RESTful client behavior. Set to false when communicating with a server that does not support encoded url paths.␊ - */␊ - encodeRequestUrl?: boolean␊ - _encodeRequestUrl?: Element2203␊ - /**␊ - * The HTTP method the test engine MUST use for this operation regardless of any other operation details.␊ - */␊ - method?: ("delete" | "get" | "options" | "patch" | "post" | "put" | "head")␊ - _method?: Element2204␊ - /**␊ - * A whole number␊ - */␊ - origin?: number␊ - _origin?: Element2205␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - params?: string␊ - _params?: Element2206␊ - /**␊ - * Header elements would be used to set HTTP headers.␊ - */␊ - requestHeader?: TestScript_RequestHeader[]␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - requestId?: string␊ - _requestId?: Element2209␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - responseId?: string␊ - _responseId?: Element2210␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - sourceId?: string␊ - _sourceId?: Element2211␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - targetId?: string␊ - _targetId?: Element2212␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - url?: string␊ - _url?: Element2213␊ - }␊ - /**␊ - * Evaluates the results of previous operations to determine if the server under test behaves appropriately.␊ - */␊ - export interface TestScript_Assert1 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - label?: string␊ - _label?: Element2214␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element2215␊ - /**␊ - * The direction to use for the assertion.␊ - */␊ - direction?: ("response" | "request")␊ - _direction?: Element2216␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - compareToSourceId?: string␊ - _compareToSourceId?: Element2217␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - compareToSourceExpression?: string␊ - _compareToSourceExpression?: Element2218␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - compareToSourcePath?: string␊ - _compareToSourcePath?: Element2219␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - contentType?: string␊ - _contentType?: Element2220␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - expression?: string␊ - _expression?: Element2221␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - headerField?: string␊ - _headerField?: Element2222␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - minimumId?: string␊ - _minimumId?: Element2223␊ - /**␊ - * Whether or not the test execution performs validation on the bundle navigation links.␊ - */␊ - navigationLinks?: boolean␊ - _navigationLinks?: Element2224␊ - /**␊ - * The operator type defines the conditional behavior of the assert. If not defined, the default is equals.␊ - */␊ - operator?: ("equals" | "notEquals" | "in" | "notIn" | "greaterThan" | "lessThan" | "empty" | "notEmpty" | "contains" | "notContains" | "eval")␊ - _operator?: Element2225␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - path?: string␊ - _path?: Element2226␊ - /**␊ - * The request method or HTTP operation code to compare against that used by the client system under test.␊ - */␊ - requestMethod?: ("delete" | "get" | "options" | "patch" | "post" | "put" | "head")␊ - _requestMethod?: Element2227␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - requestURL?: string␊ - _requestURL?: Element2228␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - resource?: string␊ - _resource?: Element2229␊ - /**␊ - * okay | created | noContent | notModified | bad | forbidden | notFound | methodNotAllowed | conflict | gone | preconditionFailed | unprocessable.␊ - */␊ - response?: ("okay" | "created" | "noContent" | "notModified" | "bad" | "forbidden" | "notFound" | "methodNotAllowed" | "conflict" | "gone" | "preconditionFailed" | "unprocessable")␊ - _response?: Element2230␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - responseCode?: string␊ - _responseCode?: Element2231␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - sourceId?: string␊ - _sourceId?: Element2232␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - validateProfileId?: string␊ - _validateProfileId?: Element2233␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element2234␊ - /**␊ - * Whether or not the test execution will produce a warning only on error for this assert.␊ - */␊ - warningOnly?: boolean␊ - _warningOnly?: Element2235␊ - }␊ - /**␊ - * A series of operations required to clean up after all the tests are executed (successfully or otherwise).␊ - */␊ - export interface TestScript_Teardown {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * The teardown action will only contain an operation.␊ - */␊ - action: TestScript_Action2[]␊ - }␊ - /**␊ - * A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.␊ - */␊ - export interface TestScript_Action2 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - operation: TestScript_Operation2␊ - }␊ - /**␊ - * An operation would involve a REST request to a server.␊ - */␊ - export interface TestScript_Operation2 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - type?: Coding43␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - resource?: string␊ - _resource?: Element2197␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - label?: string␊ - _label?: Element2198␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - description?: string␊ - _description?: Element2199␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - accept?: string␊ - _accept?: Element2200␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - contentType?: string␊ - _contentType?: Element2201␊ - /**␊ - * A whole number␊ - */␊ - destination?: number␊ - _destination?: Element2202␊ - /**␊ - * Whether or not to implicitly send the request url in encoded format. The default is true to match the standard RESTful client behavior. Set to false when communicating with a server that does not support encoded url paths.␊ - */␊ - encodeRequestUrl?: boolean␊ - _encodeRequestUrl?: Element2203␊ - /**␊ - * The HTTP method the test engine MUST use for this operation regardless of any other operation details.␊ - */␊ - method?: ("delete" | "get" | "options" | "patch" | "post" | "put" | "head")␊ - _method?: Element2204␊ - /**␊ - * A whole number␊ - */␊ - origin?: number␊ - _origin?: Element2205␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - params?: string␊ - _params?: Element2206␊ - /**␊ - * Header elements would be used to set HTTP headers.␊ - */␊ - requestHeader?: TestScript_RequestHeader[]␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - requestId?: string␊ - _requestId?: Element2209␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - responseId?: string␊ - _responseId?: Element2210␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - sourceId?: string␊ - _sourceId?: Element2211␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - targetId?: string␊ - _targetId?: Element2212␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - url?: string␊ - _url?: Element2213␊ - }␊ - /**␊ - * A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between [[[CodeSystem]]] definitions and their use in [coded elements](terminologies.html).␊ - */␊ - export interface ValueSet {␊ - /**␊ - * This is a ValueSet resource␊ - */␊ - resourceType: "ValueSet"␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - id?: string␊ - meta?: Meta152␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element2238␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element2239␊ - text?: Narrative141␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - url?: string␊ - _url?: Element2240␊ - /**␊ - * A formal identifier that is used to identify this value set when it is represented in other formats, or referenced in a specification, model, design or an instance.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element2241␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element2242␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - title?: string␊ - _title?: Element2243␊ - /**␊ - * The status of this value set. Enables tracking the life-cycle of the content. The status of the value set applies to the value set definition (ValueSet.compose) and the associated ValueSet metadata. Expansions do not have a state.␊ - */␊ - status?: ("draft" | "active" | "retired" | "unknown")␊ - _status?: Element2244␊ - /**␊ - * A Boolean value to indicate that this value set is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.␊ - */␊ - experimental?: boolean␊ - _experimental?: Element2245␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - date?: string␊ - _date?: Element2246␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - publisher?: string␊ - _publisher?: Element2247␊ - /**␊ - * Contact details to assist a user in finding and communicating with the publisher.␊ - */␊ - contact?: ContactDetail1[]␊ - /**␊ - * A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine␊ - */␊ - description?: string␊ - _description?: Element2248␊ - /**␊ - * The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate value set instances.␊ - */␊ - useContext?: UsageContext1[]␊ - /**␊ - * A legal or geographic region in which the value set is intended to be used.␊ - */␊ - jurisdiction?: CodeableConcept5[]␊ - /**␊ - * If this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change.␊ - */␊ - immutable?: boolean␊ - _immutable?: Element2249␊ - /**␊ - * A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine␊ - */␊ - purpose?: string␊ - _purpose?: Element2250␊ - /**␊ - * A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine␊ - */␊ - copyright?: string␊ - _copyright?: Element2251␊ - compose?: ValueSet_Compose␊ - expansion?: ValueSet_Expansion␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta152 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2238 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2239 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative141 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2240 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2241 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2242 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2243 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2244 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2245 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2246 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2247 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2248 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2249 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2250 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2251 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A set of criteria that define the contents of the value set by including or excluding codes selected from the specified code system(s) that the value set draws from. This is also known as the Content Logical Definition (CLD).␊ - */␊ - export interface ValueSet_Compose {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * The Locked Date is the effective date that is used to determine the version of all referenced Code Systems and Value Set Definitions included in the compose that are not already tied to a specific version.␊ - */␊ - lockedDate?: string␊ - _lockedDate?: Element2252␊ - /**␊ - * Whether inactive codes - codes that are not approved for current use - are in the value set. If inactive = true, inactive codes are to be included in the expansion, if inactive = false, the inactive codes will not be included in the expansion. If absent, the behavior is determined by the implementation, or by the applicable $expand parameters (but generally, inactive codes would be expected to be included).␊ - */␊ - inactive?: boolean␊ - _inactive?: Element2253␊ - /**␊ - * Include one or more codes from a code system or other value set(s).␊ - */␊ - include: ValueSet_Include[]␊ - /**␊ - * Exclude one or more codes from the value set based on code system filters and/or other value sets.␊ - */␊ - exclude?: ValueSet_Include[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2252 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2253 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between [[[CodeSystem]]] definitions and their use in [coded elements](terminologies.html).␊ - */␊ - export interface ValueSet_Include {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - system?: string␊ - _system?: Element2254␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element2255␊ - /**␊ - * Specifies a concept to be included or excluded.␊ - */␊ - concept?: ValueSet_Concept[]␊ - /**␊ - * Select concepts by specify a matching criterion based on the properties (including relationships) defined by the system, or on filters defined by the system. If multiple filters are specified, they SHALL all be true.␊ - */␊ - filter?: ValueSet_Filter[]␊ - /**␊ - * Selects the concepts found in this value set (based on its value set definition). This is an absolute URI that is a reference to ValueSet.url. If multiple value sets are specified this includes the union of the contents of all of the referenced value sets.␊ - */␊ - valueSet?: Canonical[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2254 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2255 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between [[[CodeSystem]]] definitions and their use in [coded elements](terminologies.html).␊ - */␊ - export interface ValueSet_Concept {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - code?: string␊ - _code?: Element2256␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element2257␊ - /**␊ - * Additional representations for this concept when used in this value set - other languages, aliases, specialized purposes, used for particular purposes, etc.␊ - */␊ - designation?: ValueSet_Designation[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2256 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2257 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between [[[CodeSystem]]] definitions and their use in [coded elements](terminologies.html).␊ - */␊ - export interface ValueSet_Designation {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element2258␊ - use?: Coding44␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element2259␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2258 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - export interface Coding44 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The identification of the code system that defines the meaning of the symbol in the code.␊ - */␊ - system?: string␊ - _system?: Element39␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element40␊ - /**␊ - * A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).␊ - */␊ - code?: string␊ - _code?: Element41␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element42␊ - /**␊ - * Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).␊ - */␊ - userSelected?: boolean␊ - _userSelected?: Element43␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2259 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between [[[CodeSystem]]] definitions and their use in [coded elements](terminologies.html).␊ - */␊ - export interface ValueSet_Filter {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - property?: string␊ - _property?: Element2260␊ - /**␊ - * The kind of operation to perform as a part of the filter criteria.␊ - */␊ - op?: ("=" | "is-a" | "descendent-of" | "is-not-a" | "regex" | "in" | "not-in" | "generalizes" | "exists")␊ - _op?: Element2261␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - value?: string␊ - _value?: Element2262␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2260 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2261 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2262 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A value set can also be "expanded", where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed.␊ - */␊ - export interface ValueSet_Expansion {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - identifier?: string␊ - _identifier?: Element2263␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - timestamp?: string␊ - _timestamp?: Element2264␊ - /**␊ - * A whole number␊ - */␊ - total?: number␊ - _total?: Element2265␊ - /**␊ - * A whole number␊ - */␊ - offset?: number␊ - _offset?: Element2266␊ - /**␊ - * A parameter that controlled the expansion process. These parameters may be used by users of expanded value sets to check whether the expansion is suitable for a particular purpose, or to pick the correct expansion.␊ - */␊ - parameter?: ValueSet_Parameter[]␊ - /**␊ - * The codes that are contained in the value set expansion.␊ - */␊ - contains?: ValueSet_Contains[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2263 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2264 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2265 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2266 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between [[[CodeSystem]]] definitions and their use in [coded elements](terminologies.html).␊ - */␊ - export interface ValueSet_Parameter {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - name?: string␊ - _name?: Element2267␊ - /**␊ - * The value of the parameter.␊ - */␊ - valueString?: string␊ - _valueString?: Element2268␊ - /**␊ - * The value of the parameter.␊ - */␊ - valueBoolean?: boolean␊ - _valueBoolean?: Element2269␊ - /**␊ - * The value of the parameter.␊ - */␊ - valueInteger?: number␊ - _valueInteger?: Element2270␊ - /**␊ - * The value of the parameter.␊ - */␊ - valueDecimal?: number␊ - _valueDecimal?: Element2271␊ - /**␊ - * The value of the parameter.␊ - */␊ - valueUri?: string␊ - _valueUri?: Element2272␊ - /**␊ - * The value of the parameter.␊ - */␊ - valueCode?: string␊ - _valueCode?: Element2273␊ - /**␊ - * The value of the parameter.␊ - */␊ - valueDateTime?: string␊ - _valueDateTime?: Element2274␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2267 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2268 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2269 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2270 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2271 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2272 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2273 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2274 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between [[[CodeSystem]]] definitions and their use in [coded elements](terminologies.html).␊ - */␊ - export interface ValueSet_Contains {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - system?: string␊ - _system?: Element2275␊ - /**␊ - * If true, this entry is included in the expansion for navigational purposes, and the user cannot select the code directly as a proper value.␊ - */␊ - abstract?: boolean␊ - _abstract?: Element2276␊ - /**␊ - * If the concept is inactive in the code system that defines it. Inactive codes are those that are no longer to be used, but are maintained by the code system for understanding legacy data. It might not be known or specified whether an concept is inactive (and it may depend on the context of use).␊ - */␊ - inactive?: boolean␊ - _inactive?: Element2277␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - version?: string␊ - _version?: Element2278␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - code?: string␊ - _code?: Element2279␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element2280␊ - /**␊ - * Additional representations for this item - other languages, aliases, specialized purposes, used for particular purposes, etc. These are relevant when the conditions of the expansion do not fix to a single correct representation.␊ - */␊ - designation?: ValueSet_Designation[]␊ - /**␊ - * Other codes and entries contained under this entry in the hierarchy.␊ - */␊ - contains?: ValueSet_Contains[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2275 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2276 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2277 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2278 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2279 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2280 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Describes validation requirements, source(s), status and dates for one or more elements.␊ - */␊ - export interface VerificationResult {␊ - /**␊ - * This is a VerificationResult resource␊ - */␊ - resourceType: "VerificationResult"␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - id?: string␊ - meta?: Meta153␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element2281␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element2282␊ - text?: Narrative142␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A resource that was validated.␊ - */␊ - target?: Reference11[]␊ - /**␊ - * The fhirpath location(s) within the resource that was validated.␊ - */␊ - targetLocation?: String[]␊ - /**␊ - * Extensions for targetLocation␊ - */␊ - _targetLocation?: Element23[]␊ - need?: CodeableConcept586␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - status?: string␊ - _status?: Element2283␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - statusDate?: string␊ - _statusDate?: Element2284␊ - validationType?: CodeableConcept587␊ - /**␊ - * The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context).␊ - */␊ - validationProcess?: CodeableConcept5[]␊ - frequency?: Timing29␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - lastPerformed?: string␊ - _lastPerformed?: Element2285␊ - /**␊ - * The date when target is next validated, if appropriate.␊ - */␊ - nextScheduled?: string␊ - _nextScheduled?: Element2286␊ - failureAction?: CodeableConcept588␊ - /**␊ - * Information about the primary source(s) involved in validation.␊ - */␊ - primarySource?: VerificationResult_PrimarySource[]␊ - attestation?: VerificationResult_Attestation␊ - /**␊ - * Information about the entity validating information.␊ - */␊ - validator?: VerificationResult_Validator[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta153 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2281 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2282 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative142 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept586 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2283 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2284 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept587 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.␊ - */␊ - export interface Timing29 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Identifies specific times when the event occurs.␊ - */␊ - event?: DateTime[]␊ - /**␊ - * Extensions for event␊ - */␊ - _event?: Element23[]␊ - repeat?: Timing_Repeat␊ - code?: CodeableConcept2␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2285 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2286 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept588 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Describes validation requirements, source(s), status and dates for one or more elements.␊ - */␊ - export interface VerificationResult_PrimarySource {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - who?: Reference467␊ - /**␊ - * Type of primary source (License Board; Primary Education; Continuing Education; Postal Service; Relationship owner; Registration Authority; legal source; issuing source; authoritative source).␊ - */␊ - type?: CodeableConcept5[]␊ - /**␊ - * Method for communicating with the primary source (manual; API; Push).␊ - */␊ - communicationMethod?: CodeableConcept5[]␊ - validationStatus?: CodeableConcept589␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - validationDate?: string␊ - _validationDate?: Element2287␊ - canPushUpdates?: CodeableConcept590␊ - /**␊ - * Type of alerts/updates the primary source can send (specific requested changes; any changes; as defined by source).␊ - */␊ - pushTypeAvailable?: CodeableConcept5[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference467 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept589 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2287 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept590 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Information about the entity attesting to information.␊ - */␊ - export interface VerificationResult_Attestation {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - who?: Reference468␊ - onBehalfOf?: Reference469␊ - communicationMethod?: CodeableConcept591␊ - /**␊ - * The date the information was attested to.␊ - */␊ - date?: string␊ - _date?: Element2288␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - sourceIdentityCertificate?: string␊ - _sourceIdentityCertificate?: Element2289␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - proxyIdentityCertificate?: string␊ - _proxyIdentityCertificate?: Element2290␊ - proxySignature?: Signature10␊ - sourceSignature?: Signature11␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference468 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference469 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept591 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2288 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2289 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2290 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities.␊ - */␊ - export interface Signature10 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document.␊ - */␊ - type: Coding[]␊ - /**␊ - * When the digital signature was signed.␊ - */␊ - when?: string␊ - _when?: Element94␊ - who: Reference3␊ - onBehalfOf?: Reference4␊ - /**␊ - * A mime type that indicates the technical format of the target resources signed by the signature.␊ - */␊ - targetFormat?: string␊ - _targetFormat?: Element95␊ - /**␊ - * A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jose for JWS, and image/* for a graphical image of a signature, etc.␊ - */␊ - sigFormat?: string␊ - _sigFormat?: Element96␊ - /**␊ - * The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty.␊ - */␊ - data?: string␊ - _data?: Element97␊ - }␊ - /**␊ - * A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities.␊ - */␊ - export interface Signature11 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document.␊ - */␊ - type: Coding[]␊ - /**␊ - * When the digital signature was signed.␊ - */␊ - when?: string␊ - _when?: Element94␊ - who: Reference3␊ - onBehalfOf?: Reference4␊ - /**␊ - * A mime type that indicates the technical format of the target resources signed by the signature.␊ - */␊ - targetFormat?: string␊ - _targetFormat?: Element95␊ - /**␊ - * A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jose for JWS, and image/* for a graphical image of a signature, etc.␊ - */␊ - sigFormat?: string␊ - _sigFormat?: Element96␊ - /**␊ - * The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty.␊ - */␊ - data?: string␊ - _data?: Element97␊ - }␊ - /**␊ - * Describes validation requirements, source(s), status and dates for one or more elements.␊ - */␊ - export interface VerificationResult_Validator {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - organization: Reference470␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - identityCertificate?: string␊ - _identityCertificate?: Element2291␊ - attestationSignature?: Signature12␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference470 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2291 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities.␊ - */␊ - export interface Signature12 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document.␊ - */␊ - type: Coding[]␊ - /**␊ - * When the digital signature was signed.␊ - */␊ - when?: string␊ - _when?: Element94␊ - who: Reference3␊ - onBehalfOf?: Reference4␊ - /**␊ - * A mime type that indicates the technical format of the target resources signed by the signature.␊ - */␊ - targetFormat?: string␊ - _targetFormat?: Element95␊ - /**␊ - * A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jose for JWS, and image/* for a graphical image of a signature, etc.␊ - */␊ - sigFormat?: string␊ - _sigFormat?: Element96␊ - /**␊ - * The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty.␊ - */␊ - data?: string␊ - _data?: Element97␊ - }␊ - /**␊ - * An authorization for the provision of glasses and/or contact lenses to a patient.␊ - */␊ - export interface VisionPrescription {␊ - /**␊ - * This is a VisionPrescription resource␊ - */␊ - resourceType: "VisionPrescription"␊ - /**␊ - * Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.␊ - */␊ - id?: string␊ - meta?: Meta154␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - implicitRules?: string␊ - _implicitRules?: Element2292␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - language?: string␊ - _language?: Element2293␊ - text?: Narrative143␊ - /**␊ - * These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.␊ - */␊ - contained?: ResourceList[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A unique identifier assigned to this vision prescription.␊ - */␊ - identifier?: Identifier2[]␊ - /**␊ - * A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents␊ - */␊ - status?: string␊ - _status?: Element2294␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - created?: string␊ - _created?: Element2295␊ - patient: Reference471␊ - encounter?: Reference472␊ - /**␊ - * A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.␊ - */␊ - dateWritten?: string␊ - _dateWritten?: Element2296␊ - prescriber: Reference473␊ - /**␊ - * Contain the details of the individual lens specifications and serves as the authorization for the fullfillment by certified professionals.␊ - */␊ - lensSpecification: VisionPrescription_LensSpecification[]␊ - }␊ - /**␊ - * The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.␊ - */␊ - export interface Meta154 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.␊ - */␊ - versionId?: string␊ - _versionId?: Element145␊ - /**␊ - * When the resource last changed - e.g. when the version changed.␊ - */␊ - lastUpdated?: string␊ - _lastUpdated?: Element146␊ - /**␊ - * A uri that identifies the source system of the resource. This provides a minimal amount of [[[Provenance]]] information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.␊ - */␊ - source?: string␊ - _source?: Element147␊ - /**␊ - * A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].␊ - */␊ - profile?: Canonical[]␊ - /**␊ - * Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.␊ - */␊ - security?: Coding[]␊ - /**␊ - * Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.␊ - */␊ - tag?: Coding[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2292 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2293 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.␊ - */␊ - export interface Narrative143 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.␊ - */␊ - status?: ("generated" | "extensions" | "additional" | "empty")␊ - _status?: Element150␊ - /**␊ - * The actual narrative content, a stripped down version of XHTML.␊ - */␊ - div: {␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2294 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2295 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference471 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference472 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2296 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference473 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * An authorization for the provision of glasses and/or contact lenses to a patient.␊ - */␊ - export interface VisionPrescription_LensSpecification {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - product: CodeableConcept592␊ - /**␊ - * The eye for which the lens specification applies.␊ - */␊ - eye?: ("right" | "left")␊ - _eye?: Element2297␊ - /**␊ - * A rational number with implicit precision␊ - */␊ - sphere?: number␊ - _sphere?: Element2298␊ - /**␊ - * A rational number with implicit precision␊ - */␊ - cylinder?: number␊ - _cylinder?: Element2299␊ - /**␊ - * A whole number␊ - */␊ - axis?: number␊ - _axis?: Element2300␊ - /**␊ - * Allows for adjustment on two axis.␊ - */␊ - prism?: VisionPrescription_Prism[]␊ - /**␊ - * A rational number with implicit precision␊ - */␊ - add?: number␊ - _add?: Element2303␊ - /**␊ - * A rational number with implicit precision␊ - */␊ - power?: number␊ - _power?: Element2304␊ - /**␊ - * A rational number with implicit precision␊ - */␊ - backCurve?: number␊ - _backCurve?: Element2305␊ - /**␊ - * A rational number with implicit precision␊ - */␊ - diameter?: number␊ - _diameter?: Element2306␊ - duration?: Quantity113␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - color?: string␊ - _color?: Element2307␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - brand?: string␊ - _brand?: Element2308␊ - /**␊ - * Notes for special requirements such as coatings and lens materials.␊ - */␊ - note?: Annotation1[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept592 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2297 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2298 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2299 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2300 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * An authorization for the provision of glasses and/or contact lenses to a patient.␊ - */␊ - export interface VisionPrescription_Prism {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A rational number with implicit precision␊ - */␊ - amount?: number␊ - _amount?: Element2301␊ - /**␊ - * The relative base, or reference lens edge, for the prism.␊ - */␊ - base?: ("up" | "down" | "in" | "out")␊ - _base?: Element2302␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2301 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2302 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2303 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2304 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2305 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2306 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.␊ - */␊ - export interface Quantity113 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The value of the measured amount. The value includes an implicit precision in the presentation of the value.␊ - */␊ - value?: number␊ - _value?: Element83␊ - /**␊ - * How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.␊ - */␊ - comparator?: ("<" | "<=" | ">=" | ">")␊ - _comparator?: Element84␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - unit?: string␊ - _unit?: Element85␊ - /**␊ - * The identification of the system that provides the coded form of the unit.␊ - */␊ - system?: string␊ - _system?: Element86␊ - /**␊ - * A computer processable form of the unit in some unit representation system.␊ - */␊ - code?: string␊ - _code?: Element87␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2307 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2308 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Information about the search process that lead to the creation of this entry.␊ - */␊ - export interface Bundle_Search {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.␊ - */␊ - mode?: ("match" | "include" | "outcome")␊ - _mode?: Element2309␊ - /**␊ - * When searching, the server's search ranking score for the entry.␊ - */␊ - score?: number␊ - _score?: Element2310␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2309 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2310 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.␊ - */␊ - export interface Bundle_Request {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.␊ - */␊ - method?: ("GET" | "HEAD" | "POST" | "PUT" | "DELETE" | "PATCH")␊ - _method?: Element2311␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - url?: string␊ - _url?: Element2312␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - ifNoneMatch?: string␊ - _ifNoneMatch?: Element2313␊ - /**␊ - * Only perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http.html#cread).␊ - */␊ - ifModifiedSince?: string␊ - _ifModifiedSince?: Element2314␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - ifMatch?: string␊ - _ifMatch?: Element2315␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - ifNoneExist?: string␊ - _ifNoneExist?: Element2316␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2311 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2312 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2313 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2314 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2315 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2316 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.␊ - */␊ - export interface Bundle_Response {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - status?: string␊ - _status?: Element2317␊ - /**␊ - * String of characters used to identify a name or a resource␊ - */␊ - location?: string␊ - _location?: Element2318␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - etag?: string␊ - _etag?: Element2319␊ - /**␊ - * The date/time that the resource was modified on the server.␊ - */␊ - lastModified?: string␊ - _lastModified?: Element2320␊ - /**␊ - * An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.␊ - */␊ - outcome?: (Account | ActivityDefinition | AdverseEvent | AllergyIntolerance | Appointment | AppointmentResponse | AuditEvent | Basic | Binary | BiologicallyDerivedProduct | BodyStructure | Bundle | CapabilityStatement | CarePlan | CareTeam | CatalogEntry | ChargeItem | ChargeItemDefinition | Claim | ClaimResponse | ClinicalImpression | CodeSystem | Communication | CommunicationRequest | CompartmentDefinition | Composition | ConceptMap | Condition | Consent | Contract | Coverage | CoverageEligibilityRequest | CoverageEligibilityResponse | DetectedIssue | Device | DeviceDefinition | DeviceMetric | DeviceRequest | DeviceUseStatement | DiagnosticReport | DocumentManifest | DocumentReference | EffectEvidenceSynthesis | Encounter | Endpoint | EnrollmentRequest | EnrollmentResponse | EpisodeOfCare | EventDefinition | Evidence | EvidenceVariable | ExampleScenario | ExplanationOfBenefit | FamilyMemberHistory | Flag | Goal | GraphDefinition | Group | GuidanceResponse | HealthcareService | ImagingStudy | Immunization | ImmunizationEvaluation | ImmunizationRecommendation | ImplementationGuide | InsurancePlan | Invoice | Library | Linkage | List | Location | Measure | MeasureReport | Media | Medication | MedicationAdministration | MedicationDispense | MedicationKnowledge | MedicationRequest | MedicationStatement | MedicinalProduct | MedicinalProductAuthorization | MedicinalProductContraindication | MedicinalProductIndication | MedicinalProductIngredient | MedicinalProductInteraction | MedicinalProductManufactured | MedicinalProductPackaged | MedicinalProductPharmaceutical | MedicinalProductUndesirableEffect | MessageDefinition | MessageHeader | MolecularSequence | NamingSystem | NutritionOrder | Observation | ObservationDefinition | OperationDefinition | OperationOutcome | Organization | OrganizationAffiliation | Parameters | Patient | PaymentNotice | PaymentReconciliation | Person | PlanDefinition | Practitioner | PractitionerRole | Procedure | Provenance | Questionnaire | QuestionnaireResponse | RelatedPerson | RequestGroup | ResearchDefinition | ResearchElementDefinition | ResearchStudy | ResearchSubject | RiskAssessment | RiskEvidenceSynthesis | Schedule | SearchParameter | ServiceRequest | Slot | Specimen | SpecimenDefinition | StructureDefinition | StructureMap | Subscription | Substance | SubstanceNucleicAcid | SubstancePolymer | SubstanceProtein | SubstanceReferenceInformation | SubstanceSourceMaterial | SubstanceSpecification | SupplyDelivery | SupplyRequest | Task | TerminologyCapabilities | TestReport | TestScript | ValueSet | VerificationResult | VisionPrescription)␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2317 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2318 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2319 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2320 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * Digital Signature - base64 encoded. XML-DSig or a JWT.␊ - */␊ - export interface Signature13 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document.␊ - */␊ - type: Coding[]␊ - /**␊ - * When the digital signature was signed.␊ - */␊ - when?: string␊ - _when?: Element94␊ - who: Reference3␊ - onBehalfOf?: Reference4␊ - /**␊ - * A mime type that indicates the technical format of the target resources signed by the signature.␊ - */␊ - targetFormat?: string␊ - _targetFormat?: Element95␊ - /**␊ - * A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jose for JWS, and image/* for a graphical image of a signature, etc.␊ - */␊ - sigFormat?: string␊ - _sigFormat?: Element96␊ - /**␊ - * The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty.␊ - */␊ - data?: string␊ - _data?: Element97␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2321 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.␊ - */␊ - export interface CodeableConcept593 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A reference to a code defined by a terminology system.␊ - */␊ - coding?: Coding[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - text?: string␊ - _text?: Element44␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2322 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period128 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centers, etc.␊ - */␊ - export interface Account_Coverage {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - coverage: Reference474␊ - /**␊ - * An integer with a value that is positive (e.g. >0)␊ - */␊ - priority?: number␊ - _priority?: Element2323␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference474 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2323 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference475 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2324 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centers, etc.␊ - */␊ - export interface Account_Guarantor {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.␊ - * ␊ - * Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).␊ - */␊ - modifierExtension?: Extension[]␊ - party: Reference476␊ - /**␊ - * A guarantor may be placed on credit hold or otherwise have their role temporarily suspended.␊ - */␊ - onHold?: boolean␊ - _onHold?: Element2325␊ - period?: Period129␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference476 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - /**␊ - * Base definition for all elements in a resource.␊ - */␊ - export interface Element2325 {␊ - /**␊ - * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - }␊ - /**␊ - * A time period defined by a start and end date and optionally time.␊ - */␊ - export interface Period129 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * The start of the period. The boundary is inclusive.␊ - */␊ - start?: string␊ - _start?: Element29␊ - /**␊ - * The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.␊ - */␊ - end?: string␊ - _end?: Element30␊ - }␊ - /**␊ - * A reference from one resource to another.␊ - */␊ - export interface Reference477 {␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - id?: string␊ - /**␊ - * May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.␊ - */␊ - extension?: Extension[]␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - reference?: string␊ - _reference?: Element36␊ - /**␊ - * The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.␊ - * ␊ - * The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).␊ - */␊ - type?: string␊ - _type?: Element37␊ - identifier?: Identifier␊ - /**␊ - * A sequence of Unicode characters␊ - */␊ - display?: string␊ - _display?: Element47␊ - }␊ - ` - -## realWorld.heroku.js - -> Expected output to match snapshot for e2e test: realWorld.heroku.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - /**␊ - * provider actions for this specific add-on␊ - */␊ - export type Actions = ({␊ - /**␊ - * a unique identifier␊ - */␊ - id?: string␊ - /**␊ - * the display text shown in Dashboard␊ - */␊ - label?: string␊ - /**␊ - * identifier of the action to take that is sent via SSO␊ - */␊ - action?: string␊ - /**␊ - * absolute URL to use instead of an action␊ - */␊ - url?: string␊ - /**␊ - * if the action requires the user to own the app␊ - */␊ - requires_owner?: boolean␊ - [k: string]: unknown␊ - } & {␊ - [k: string]: unknown␊ - }[])␊ - /**␊ - * config vars exposed to the owning app by this add-on␊ - */␊ - export type ConfigVars = string[]␊ - /**␊ - * errors associated with invalid app.json manifest file␊ - */␊ - export type ManifestErrors = string[]␊ - /**␊ - * result of postdeploy script␊ - */␊ - export type Postdeploy = ({␊ - /**␊ - * output of the postdeploy script␊ - */␊ - output?: string␊ - /**␊ - * The exit code of the postdeploy script␊ - */␊ - exit_code?: number␊ - [k: string]: unknown␊ - } & ({␊ - /**␊ - * output of the postdeploy script␊ - */␊ - output?: string␊ - /**␊ - * The exit code of the postdeploy script␊ - */␊ - exit_code?: number␊ - [k: string]: unknown␊ - } | null))␊ - /**␊ - * buildpacks executed for this build, in order␊ - */␊ - export type Buildpacks = ({␊ - /**␊ - * location of the buildpack for the app. Either a url (unofficial buildpacks) or an internal urn (heroku official buildpacks).␊ - */␊ - url?: string␊ - [k: string]: unknown␊ - }[] | null)␊ - /**␊ - * release resulting from the build␊ - */␊ - export type Release = ({␊ - /**␊ - * unique identifier of release␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - } & (null | {␊ - /**␊ - * unique identifier of release␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }))␊ - /**␊ - * price information for this dyno size␊ - */␊ - export type Cost = (null | {␊ - [k: string]: unknown␊ - })␊ - /**␊ - * the serialized resource affected by the event␊ - */␊ - export type Data = (HerokuPlatformAPIAccount | HerokuPlatformAPIAddOn | HerokuPlatformAPIAddOnAttachment | HerokuPlatformAPIApp | HerokuPlatformAPIApplicationFormationSet | HerokuSetupAPIAppSetup | HerokuPlatformAPIAppTransfer | HerokuBuildAPIBuild | HerokuPlatformAPICollaborator | HerokuPlatformAPIDomain | HerokuPlatformAPIDyno | HerokuPlatformAPIFailedEvent | HerokuPlatformAPIFormation | HerokuPlatformAPIInboundRuleset | HerokuPlatformAPIOrganization | HerokuPlatformAPIRelease | HerokuPlatformAPISpace)␊ - /**␊ - * add-on that created the drain␊ - */␊ - export type Addon = ({␊ - /**␊ - * unique identifier of add-on␊ - */␊ - id?: string␊ - /**␊ - * globally unique name of the add-on␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - } & ({␊ - /**␊ - * unique identifier of add-on␊ - */␊ - id?: string␊ - /**␊ - * globally unique name of the add-on␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - } | null))␊ - /**␊ - * The scope of access OAuth authorization allows␊ - */␊ - export type Scope = string[]␊ - /**␊ - * the compliance regimes applied to an add-on plan␊ - */␊ - export type Compliance = (null | ("HIPAA" | "PCI")[])␊ - /**␊ - * potential IPs from which outbound network traffic will originate␊ - */␊ - export type Sources = string[]␊ - /**␊ - * Which pipeline uuids the user has dismissed the GitHub banner for␊ - */␊ - export type DismissedPipelinesGithubBanners = (null | string[])␊ - ␊ - /**␊ - * The platform API empowers developers to automate, extend and combine Heroku with other services.␊ - */␊ - export interface HerokuPlatformAPI {␊ - "account-feature"?: HerokuPlatformAPIAccountFeature␊ - account?: HerokuPlatformAPIAccount␊ - "add-on-action"?: HerokuPlatformAPIAddOnAction␊ - "add-on-attachment"?: HerokuPlatformAPIAddOnAttachment␊ - "add-on-config"?: HerokuPlatformAPIAddOnConfig␊ - "add-on-plan-action"?: HerokuPlatformAPIAddOnPlanAction␊ - "add-on-region-capability"?: HerokuPlatformAPIAddOnRegionCapability␊ - "add-on-service"?: HerokuPlatformAPIAddOnService␊ - "add-on"?: HerokuPlatformAPIAddOn␊ - "app-feature"?: HerokuPlatformAPIAppFeature␊ - "app-formation-set"?: HerokuPlatformAPIApplicationFormationSet␊ - "app-setup"?: HerokuSetupAPIAppSetup␊ - "app-transfer"?: HerokuPlatformAPIAppTransfer␊ - app?: HerokuPlatformAPIApp␊ - "build-result"?: HerokuBuildAPIBuildResult␊ - build?: HerokuBuildAPIBuild␊ - "buildpack-installation"?: HerokuPlatformAPIBuildpackInstallations␊ - collaborator?: HerokuPlatformAPICollaborator␊ - "config-var"?: HerokuPlatformAPIConfigVars␊ - credit?: HerokuPlatformAPICredit␊ - domain?: HerokuPlatformAPIDomain␊ - "dyno-size"?: HerokuPlatformAPIDynoSize␊ - dyno?: HerokuPlatformAPIDyno␊ - event?: HerokuPlatformAPIEvent␊ - "failed-event"?: HerokuPlatformAPIFailedEvent␊ - "filter-apps"?: HerokuPlatformAPIFilters␊ - formation?: HerokuPlatformAPIFormation␊ - "identity-provider"?: HerokuPlatformAPIIdentityProvider␊ - "inbound-ruleset"?: HerokuPlatformAPIInboundRuleset␊ - invitation?: HerokuPlatformAPIInvitation␊ - "invoice-address"?: HerokuVaultAPIInvoiceAddress␊ - invoice?: HerokuPlatformAPIInvoice␊ - key?: HerokuPlatformAPIKey␊ - "log-drain"?: HerokuPlatformAPILogDrain␊ - "log-session"?: HerokuPlatformAPILogSession␊ - "oauth-authorization"?: HerokuPlatformAPIOAuthAuthorization␊ - "oauth-client"?: HerokuPlatformAPIOAuthClient␊ - "oauth-grant"?: HerokuPlatformAPIOAuthGrant␊ - "oauth-token"?: HerokuPlatformAPIOAuthToken␊ - "organization-add-on"?: HerokuPlatformAPIOrganizationAddOn␊ - "organization-app-collaborator"?: HerokuPlatformAPIOrganizationAppCollaborator␊ - "organization-app"?: HerokuPlatformAPIOrganizationApp␊ - "organization-feature"?: HerokuPlatformAPIOrganizationFeature␊ - "organization-invitation"?: HerokuPlatformAPIOrganizationInvitation␊ - "organization-invoice"?: HerokuPlatformAPIOrganizationInvoice␊ - "organization-member"?: HerokuPlatformAPIOrganizationMember␊ - "organization-preferences"?: HerokuPlatformAPIOrganizationPreferences␊ - organization?: HerokuPlatformAPIOrganization␊ - "outbound-ruleset"?: HerokuPlatformAPIOutboundRuleset␊ - "password-reset"?: HerokuPlatformAPIPasswordReset␊ - "organization-app-permission"?: HerokuPlatformAPIOrganizationAppPermission␊ - "pipeline-coupling"?: HerokuPlatformAPIPipelineCoupling␊ - "pipeline-promotion-target"?: HerokuPlatformAPIPipelinePromotionTarget␊ - "pipeline-promotion"?: HerokuPlatformAPIPipelinePromotion␊ - pipeline?: HerokuPlatformAPIPipeline␊ - plan?: HerokuPlatformAPIPlan␊ - "rate-limit"?: HerokuPlatformAPIRateLimit␊ - region?: HerokuPlatformAPIRegion␊ - release?: HerokuPlatformAPIRelease␊ - slug?: HerokuPlatformAPISlug␊ - "sms-number"?: HerokuPlatformAPISMSNumber␊ - "sni-endpoint"?: HerokuPlatformAPISNIEndpoint␊ - source?: HerokuPlatformAPISource␊ - "space-app-access"?: HerokuPlatformAPISpaceAccess␊ - "space-nat"?: HerokuPlatformAPISpaceNetworkAddressTranslation␊ - space?: HerokuPlatformAPISpace␊ - "ssl-endpoint"?: HerokuPlatformAPISSLEndpoint␊ - stack?: HerokuPlatformAPIStack␊ - "user-preferences"?: HerokuPlatformAPIUserPreferences␊ - "whitelisted-add-on-service"?: HerokuPlatformAPIWhitelistedEntity␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An account feature represents a Heroku labs capability that can be enabled or disabled for an account on Heroku.␊ - */␊ - export interface HerokuPlatformAPIAccountFeature {␊ - /**␊ - * when account feature was created␊ - */␊ - created_at?: string␊ - /**␊ - * description of account feature␊ - */␊ - description?: string␊ - /**␊ - * documentation URL of account feature␊ - */␊ - doc_url?: string␊ - /**␊ - * whether or not account feature has been enabled␊ - */␊ - enabled?: boolean␊ - /**␊ - * unique identifier of account feature␊ - */␊ - id?: string␊ - /**␊ - * unique name of account feature␊ - */␊ - name?: string␊ - /**␊ - * state of account feature␊ - */␊ - state?: string␊ - /**␊ - * when account feature was updated␊ - */␊ - updated_at?: string␊ - /**␊ - * user readable feature name␊ - */␊ - display_name?: string␊ - /**␊ - * e-mail to send feedback about the feature␊ - */␊ - feedback_email?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An account represents an individual signed up to use the Heroku platform.␊ - */␊ - export interface HerokuPlatformAPIAccount {␊ - /**␊ - * whether to allow third party web activity tracking␊ - */␊ - allow_tracking?: boolean␊ - /**␊ - * whether allowed to utilize beta Heroku features␊ - */␊ - beta?: boolean␊ - /**␊ - * when account was created␊ - */␊ - created_at?: string␊ - /**␊ - * unique email address of account␊ - */␊ - email?: string␊ - /**␊ - * whether the user is federated and belongs to an Identity Provider␊ - */␊ - federated?: boolean␊ - /**␊ - * unique identifier of an account␊ - */␊ - id?: string␊ - /**␊ - * Identity Provider details for federated users.␊ - */␊ - identity_provider?: ({␊ - /**␊ - * unique identifier of this identity provider␊ - */␊ - id?: string␊ - organization?: {␊ - /**␊ - * unique name of organization␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - } | null)␊ - /**␊ - * when account last authorized with Heroku␊ - */␊ - last_login?: (string | null)␊ - /**␊ - * full name of the account owner␊ - */␊ - name?: (string | null)␊ - /**␊ - * SMS number of account␊ - */␊ - sms_number?: (string | null)␊ - /**␊ - * when account was suspended␊ - */␊ - suspended_at?: (string | null)␊ - /**␊ - * when account became delinquent␊ - */␊ - delinquent_at?: (string | null)␊ - /**␊ - * whether two-factor auth is enabled on the account␊ - */␊ - two_factor_authentication?: boolean␊ - /**␊ - * when account was updated␊ - */␊ - updated_at?: string␊ - /**␊ - * whether account has been verified with billing information␊ - */␊ - verified?: boolean␊ - /**␊ - * organization selected by default␊ - */␊ - default_organization?: ({␊ - /**␊ - * unique identifier of organization␊ - */␊ - id?: string␊ - /**␊ - * unique name of organization␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - } | null)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Add-on Actions are lifecycle operations for add-on provisioning and deprovisioning. They allow whitelisted add-on providers to (de)provision add-ons in the background and then report back when (de)provisioning is complete.␊ - */␊ - export interface HerokuPlatformAPIAddOnAction {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An add-on attachment represents a connection between an app and an add-on that it has been given access to.␊ - */␊ - export interface HerokuPlatformAPIAddOnAttachment {␊ - /**␊ - * identity of add-on␊ - */␊ - addon?: {␊ - /**␊ - * unique identifier of add-on␊ - */␊ - id: string␊ - /**␊ - * globally unique name of the add-on␊ - */␊ - name: string␊ - /**␊ - * billing application associated with this add-on␊ - */␊ - app: {␊ - /**␊ - * unique identifier of app␊ - */␊ - id?: string␊ - /**␊ - * unique name of app␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * identity of add-on plan␊ - */␊ - plan?: {␊ - /**␊ - * unique identifier of this plan␊ - */␊ - id?: string␊ - /**␊ - * unique name of this plan␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * application that is attached to add-on␊ - */␊ - app?: {␊ - /**␊ - * unique identifier of app␊ - */␊ - id?: string␊ - /**␊ - * unique name of app␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * when add-on attachment was created␊ - */␊ - created_at?: string␊ - /**␊ - * unique identifier of this add-on attachment␊ - */␊ - id?: string␊ - /**␊ - * unique name for this add-on attachment to this app␊ - */␊ - name?: string␊ - /**␊ - * attachment namespace␊ - */␊ - namespace?: (null | string)␊ - /**␊ - * when add-on attachment was updated␊ - */␊ - updated_at?: string␊ - /**␊ - * URL for logging into web interface of add-on in attached app context␊ - */␊ - web_url?: (null | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Configuration of an Add-on␊ - */␊ - export interface HerokuPlatformAPIAddOnConfig {␊ - /**␊ - * unique name of the config␊ - */␊ - name?: string␊ - /**␊ - * value of the config␊ - */␊ - value?: (string | null)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Add-on Plan Actions are Provider functionality for specific add-on installations␊ - */␊ - export interface HerokuPlatformAPIAddOnPlanAction {␊ - /**␊ - * a unique identifier␊ - */␊ - id?: string␊ - /**␊ - * the display text shown in Dashboard␊ - */␊ - label?: string␊ - /**␊ - * identifier of the action to take that is sent via SSO␊ - */␊ - action?: string␊ - /**␊ - * absolute URL to use instead of an action␊ - */␊ - url?: string␊ - /**␊ - * if the action requires the user to own the app␊ - */␊ - requires_owner?: boolean␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Add-on region capabilities represent the relationship between an Add-on Service and a specific Region. Only Beta and GA add-ons are returned by these endpoints.␊ - */␊ - export interface HerokuPlatformAPIAddOnRegionCapability {␊ - /**␊ - * unique identifier of this add-on-region-capability␊ - */␊ - id?: string␊ - /**␊ - * whether the add-on can be installed to a Space␊ - */␊ - supports_private_networking?: boolean␊ - addon_service?: HerokuPlatformAPIAddOnService␊ - region?: HerokuPlatformAPIRegion␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Add-on services represent add-ons that may be provisioned for apps. Endpoints under add-on services can be accessed without authentication.␊ - */␊ - export interface HerokuPlatformAPIAddOnService {␊ - /**␊ - * npm package name of the add-on service's Heroku CLI plugin␊ - */␊ - cli_plugin_name?: (string | null)␊ - /**␊ - * when add-on-service was created␊ - */␊ - created_at?: string␊ - /**␊ - * human-readable name of the add-on service provider␊ - */␊ - human_name?: string␊ - /**␊ - * unique identifier of this add-on-service␊ - */␊ - id?: string␊ - /**␊ - * unique name of this add-on-service␊ - */␊ - name?: string␊ - /**␊ - * release status for add-on service␊ - */␊ - state?: ("alpha" | "beta" | "ga" | "shutdown")␊ - /**␊ - * whether or not apps can have access to more than one instance of this add-on at the same time␊ - */␊ - supports_multiple_installations?: boolean␊ - /**␊ - * whether or not apps can have access to add-ons billed to a different app␊ - */␊ - supports_sharing?: boolean␊ - /**␊ - * when add-on-service was updated␊ - */␊ - updated_at?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A region represents a geographic location in which your application may run.␊ - */␊ - export interface HerokuPlatformAPIRegion {␊ - /**␊ - * country where the region exists␊ - */␊ - country?: string␊ - /**␊ - * when region was created␊ - */␊ - created_at?: string␊ - /**␊ - * description of region␊ - */␊ - description?: string␊ - /**␊ - * unique identifier of region␊ - */␊ - id?: string␊ - /**␊ - * area in the country where the region exists␊ - */␊ - locale?: string␊ - /**␊ - * unique name of region␊ - */␊ - name?: string␊ - /**␊ - * whether or not region is available for creating a Private Space␊ - */␊ - private_capable?: boolean␊ - provider?: Provider␊ - /**␊ - * when region was updated␊ - */␊ - updated_at?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * provider of underlying substrate␊ - */␊ - export interface Provider {␊ - /**␊ - * name of provider␊ - */␊ - name?: string␊ - /**␊ - * region name used by provider␊ - */␊ - region?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Add-ons represent add-ons that have been provisioned and attached to one or more apps.␊ - */␊ - export interface HerokuPlatformAPIAddOn {␊ - actions?: Actions␊ - /**␊ - * identity of add-on service␊ - */␊ - addon_service?: {␊ - /**␊ - * unique identifier of this add-on-service␊ - */␊ - id?: string␊ - /**␊ - * unique name of this add-on-service␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * billing application associated with this add-on␊ - */␊ - app?: {␊ - /**␊ - * unique identifier of app␊ - */␊ - id?: string␊ - /**␊ - * unique name of app␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - config_vars?: ConfigVars␊ - /**␊ - * when add-on was created␊ - */␊ - created_at?: string␊ - /**␊ - * unique identifier of add-on␊ - */␊ - id?: string␊ - /**␊ - * globally unique name of the add-on␊ - */␊ - name?: string␊ - /**␊ - * identity of add-on plan␊ - */␊ - plan?: {␊ - /**␊ - * unique identifier of this plan␊ - */␊ - id?: string␊ - /**␊ - * unique name of this plan␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * id of this add-on with its provider␊ - */␊ - provider_id?: string␊ - /**␊ - * state in the add-on's lifecycle␊ - */␊ - state?: ("provisioning" | "provisioned" | "deprovisioned")␊ - /**␊ - * when add-on was updated␊ - */␊ - updated_at?: string␊ - /**␊ - * URL for logging into web interface of add-on (e.g. a dashboard)␊ - */␊ - web_url?: (null | string)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An app feature represents a Heroku labs capability that can be enabled or disabled for an app on Heroku.␊ - */␊ - export interface HerokuPlatformAPIAppFeature {␊ - /**␊ - * when app feature was created␊ - */␊ - created_at?: string␊ - /**␊ - * description of app feature␊ - */␊ - description?: string␊ - /**␊ - * documentation URL of app feature␊ - */␊ - doc_url?: string␊ - /**␊ - * whether or not app feature has been enabled␊ - */␊ - enabled?: boolean␊ - /**␊ - * unique identifier of app feature␊ - */␊ - id?: string␊ - /**␊ - * unique name of app feature␊ - */␊ - name?: string␊ - /**␊ - * state of app feature␊ - */␊ - state?: string␊ - /**␊ - * when app feature was updated␊ - */␊ - updated_at?: string␊ - /**␊ - * user readable feature name␊ - */␊ - display_name?: string␊ - /**␊ - * e-mail to send feedback about the feature␊ - */␊ - feedback_email?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * App formation set describes the combination of process types with their quantities and sizes as well as application process tier␊ - */␊ - export interface HerokuPlatformAPIApplicationFormationSet {␊ - /**␊ - * a string representation of the formation set␊ - */␊ - description?: string␊ - /**␊ - * application process tier␊ - */␊ - process_tier?: ("production" | "traditional" | "free" | "hobby" | "private")␊ - /**␊ - * app being described by the formation-set␊ - */␊ - app?: {␊ - /**␊ - * unique name of app␊ - */␊ - name?: string␊ - /**␊ - * unique identifier of app␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * last time fomation-set was updated␊ - */␊ - updated_at?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An app setup represents an app on Heroku that is setup using an environment, addons, and scripts described in an app.json manifest file.␊ - */␊ - export interface HerokuSetupAPIAppSetup {␊ - /**␊ - * unique identifier of app setup␊ - */␊ - id?: string␊ - /**␊ - * when app setup was created␊ - */␊ - created_at?: string␊ - /**␊ - * when app setup was updated␊ - */␊ - updated_at?: string␊ - /**␊ - * the overall status of app setup␊ - */␊ - status?: ("failed" | "pending" | "succeeded")␊ - /**␊ - * reason that app setup has failed␊ - */␊ - failure_message?: (string | null)␊ - /**␊ - * identity of app␊ - */␊ - app?: {␊ - /**␊ - * unique identifier of app␊ - */␊ - id?: string␊ - /**␊ - * unique name of app␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * identity and status of build␊ - */␊ - build?: (null | {␊ - /**␊ - * unique identifier of build␊ - */␊ - id?: string␊ - /**␊ - * status of build␊ - */␊ - status?: ("failed" | "pending" | "succeeded")␊ - /**␊ - * Build process output will be available from this URL as a stream. The stream is available as either \`text/plain\` or \`text/event-stream\`. Clients should be prepared to handle disconnects and can resume the stream by sending a \`Range\` header (for \`text/plain\`) or a \`Last-Event-Id\` header (for \`text/event-stream\`).␊ - */␊ - output_stream_url?: string␊ - [k: string]: unknown␊ - })␊ - manifest_errors?: ManifestErrors␊ - postdeploy?: Postdeploy␊ - /**␊ - * fully qualified success url␊ - */␊ - resolved_success_url?: (string | null)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An app transfer represents a two party interaction for transferring ownership of an app.␊ - */␊ - export interface HerokuPlatformAPIAppTransfer {␊ - /**␊ - * app involved in the transfer␊ - */␊ - app?: {␊ - /**␊ - * unique name of app␊ - */␊ - name?: string␊ - /**␊ - * unique identifier of app␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * when app transfer was created␊ - */␊ - created_at?: string␊ - /**␊ - * unique identifier of app transfer␊ - */␊ - id?: string␊ - /**␊ - * identity of the owner of the transfer␊ - */␊ - owner?: {␊ - /**␊ - * unique email address of account␊ - */␊ - email?: string␊ - /**␊ - * unique identifier of an account␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * identity of the recipient of the transfer␊ - */␊ - recipient?: {␊ - /**␊ - * unique email address of account␊ - */␊ - email?: string␊ - /**␊ - * unique identifier of an account␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * the current state of an app transfer␊ - */␊ - state?: ("pending" | "accepted" | "declined")␊ - /**␊ - * when app transfer was updated␊ - */␊ - updated_at?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An app represents the program that you would like to deploy and run on Heroku.␊ - */␊ - export interface HerokuPlatformAPIApp {␊ - /**␊ - * when app was archived␊ - */␊ - archived_at?: (null | string)␊ - /**␊ - * description from buildpack of app␊ - */␊ - buildpack_provided_description?: (null | string)␊ - /**␊ - * identity of the stack that will be used for new builds␊ - */␊ - build_stack?: {␊ - /**␊ - * unique identifier of stack␊ - */␊ - id?: string␊ - /**␊ - * unique name of stack␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * when app was created␊ - */␊ - created_at?: string␊ - /**␊ - * git repo URL of app␊ - */␊ - git_url?: string␊ - /**␊ - * unique identifier of app␊ - */␊ - id?: string␊ - /**␊ - * maintenance status of app␊ - */␊ - maintenance?: boolean␊ - /**␊ - * unique name of app␊ - */␊ - name?: string␊ - /**␊ - * identity of app owner␊ - */␊ - owner?: {␊ - /**␊ - * unique email address of account␊ - */␊ - email?: string␊ - /**␊ - * unique identifier of an account␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * identity of organization␊ - */␊ - organization?: (null | {␊ - /**␊ - * unique identifier of organization␊ - */␊ - id?: string␊ - /**␊ - * unique name of organization␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - })␊ - /**␊ - * identity of app region␊ - */␊ - region?: {␊ - /**␊ - * unique identifier of region␊ - */␊ - id?: string␊ - /**␊ - * unique name of region␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * when app was released␊ - */␊ - released_at?: (null | string)␊ - /**␊ - * git repo size in bytes of app␊ - */␊ - repo_size?: (number | null)␊ - /**␊ - * slug size in bytes of app␊ - */␊ - slug_size?: (number | null)␊ - /**␊ - * identity of space␊ - */␊ - space?: (null | {␊ - /**␊ - * unique identifier of space␊ - */␊ - id?: string␊ - /**␊ - * unique name of space␊ - */␊ - name?: string␊ - /**␊ - * true if this space has shield enabled␊ - */␊ - shield?: boolean␊ - [k: string]: unknown␊ - })␊ - /**␊ - * identity of app stack␊ - */␊ - stack?: {␊ - /**␊ - * unique identifier of stack␊ - */␊ - id?: string␊ - /**␊ - * unique name of stack␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * when app was updated␊ - */␊ - updated_at?: string␊ - /**␊ - * web URL of app␊ - */␊ - web_url?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A build result contains the output from a build.␊ - */␊ - export interface HerokuBuildAPIBuildResult {␊ - /**␊ - * identity of build␊ - */␊ - build?: {␊ - /**␊ - * unique identifier of build␊ - */␊ - id?: string␊ - /**␊ - * status of build␊ - */␊ - status?: ("failed" | "pending" | "succeeded")␊ - /**␊ - * Build process output will be available from this URL as a stream. The stream is available as either \`text/plain\` or \`text/event-stream\`. Clients should be prepared to handle disconnects and can resume the stream by sending a \`Range\` header (for \`text/plain\`) or a \`Last-Event-Id\` header (for \`text/event-stream\`).␊ - */␊ - output_stream_url?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * status from the build␊ - */␊ - exit_code?: number␊ - /**␊ - * A list of all the lines of a build's output. This has been replaced by the \`output_stream_url\` attribute on the build resource.␊ - */␊ - lines?: Line[]␊ - [k: string]: unknown␊ - }␊ - /**␊ - * a single line of output to STDOUT or STDERR from the build.␊ - */␊ - export interface Line {␊ - /**␊ - * The output stream where the line was sent.␊ - */␊ - stream?: ("STDOUT" | "STDERR")␊ - /**␊ - * A line of output from the build.␊ - */␊ - line?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A build represents the process of transforming a code tarball into a slug␊ - */␊ - export interface HerokuBuildAPIBuild {␊ - /**␊ - * app that the build belongs to␊ - */␊ - app?: {␊ - /**␊ - * unique identifier of app␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - buildpacks?: Buildpacks␊ - /**␊ - * when build was created␊ - */␊ - created_at?: string␊ - /**␊ - * unique identifier of build␊ - */␊ - id?: string␊ - /**␊ - * Build process output will be available from this URL as a stream. The stream is available as either \`text/plain\` or \`text/event-stream\`. Clients should be prepared to handle disconnects and can resume the stream by sending a \`Range\` header (for \`text/plain\`) or a \`Last-Event-Id\` header (for \`text/event-stream\`).␊ - */␊ - output_stream_url?: string␊ - source_blob?: SourceBlob␊ - release?: Release␊ - /**␊ - * slug created by this build␊ - */␊ - slug?: ({␊ - /**␊ - * unique identifier of slug␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - } | null)␊ - /**␊ - * status of build␊ - */␊ - status?: ("failed" | "pending" | "succeeded")␊ - /**␊ - * when build was updated␊ - */␊ - updated_at?: string␊ - /**␊ - * user that started the build␊ - */␊ - user?: {␊ - /**␊ - * unique identifier of an account␊ - */␊ - id?: string␊ - /**␊ - * unique email address of account␊ - */␊ - email?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * location of gzipped tarball of source code used to create build␊ - */␊ - export interface SourceBlob {␊ - /**␊ - * an optional checksum of the gzipped tarball for verifying its integrity␊ - */␊ - checksum?: (null | string)␊ - /**␊ - * URL where gzipped tar archive of source code for build was downloaded.␊ - */␊ - url?: string␊ - /**␊ - * Version of the gzipped tarball.␊ - */␊ - version?: (string | null)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A buildpack installation represents a buildpack that will be run against an app.␊ - */␊ - export interface HerokuPlatformAPIBuildpackInstallations {␊ - /**␊ - * determines the order in which the buildpacks will execute␊ - */␊ - ordinal?: number␊ - /**␊ - * buildpack␊ - */␊ - buildpack?: {␊ - /**␊ - * location of the buildpack for the app. Either a url (unofficial buildpacks) or an internal urn (heroku official buildpacks).␊ - */␊ - url?: string␊ - /**␊ - * either the shorthand name (heroku official buildpacks) or url (unofficial buildpacks) of the buildpack for the app␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A collaborator represents an account that has been given access to an app on Heroku.␊ - */␊ - export interface HerokuPlatformAPICollaborator {␊ - /**␊ - * app collaborator belongs to␊ - */␊ - app: {␊ - /**␊ - * unique name of app␊ - */␊ - name?: string␊ - /**␊ - * unique identifier of app␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * when collaborator was created␊ - */␊ - created_at: string␊ - /**␊ - * unique identifier of collaborator␊ - */␊ - id: string␊ - permissions?: HerokuPlatformAPIOrganizationAppPermission[]␊ - /**␊ - * role in the organization␊ - */␊ - role?: ("admin" | "collaborator" | "member" | "owner" | null)␊ - /**␊ - * when collaborator was updated␊ - */␊ - updated_at: string␊ - /**␊ - * identity of collaborated account␊ - */␊ - user: {␊ - /**␊ - * unique email address of account␊ - */␊ - email?: string␊ - /**␊ - * whether the user is federated and belongs to an Identity Provider␊ - */␊ - federated?: boolean␊ - /**␊ - * unique identifier of an account␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * An organization app permission is a behavior that is assigned to a user in an organization app.␊ - */␊ - export interface HerokuPlatformAPIOrganizationAppPermission {␊ - /**␊ - * The name of the app permission.␊ - */␊ - name?: string␊ - /**␊ - * A description of what the app permission allows.␊ - */␊ - description?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Config Vars allow you to manage the configuration information provided to an app on Heroku.␊ - */␊ - export interface HerokuPlatformAPIConfigVars {␊ - /**␊ - * This interface was referenced by \`HerokuPlatformAPIConfigVars\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^\\w+$".␊ - */␊ - [k: string]: string␊ - }␊ - /**␊ - * A credit represents value that will be used up before further charges are assigned to an account.␊ - */␊ - export interface HerokuPlatformAPICredit {␊ - /**␊ - * total value of credit in cents␊ - */␊ - amount?: number␊ - /**␊ - * remaining value of credit in cents␊ - */␊ - balance?: number␊ - /**␊ - * when credit was created␊ - */␊ - created_at?: string␊ - /**␊ - * when credit will expire␊ - */␊ - expires_at?: string␊ - /**␊ - * unique identifier of credit␊ - */␊ - id?: string␊ - /**␊ - * a name for credit␊ - */␊ - title?: string␊ - /**␊ - * when credit was updated␊ - */␊ - updated_at?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Domains define what web routes should be routed to an app on Heroku.␊ - */␊ - export interface HerokuPlatformAPIDomain {␊ - /**␊ - * app that owns the domain␊ - */␊ - app?: {␊ - /**␊ - * unique name of app␊ - */␊ - name?: string␊ - /**␊ - * unique identifier of app␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * canonical name record, the address to point a domain at␊ - */␊ - cname?: (null | string)␊ - /**␊ - * when domain was created␊ - */␊ - created_at?: string␊ - /**␊ - * full hostname␊ - */␊ - hostname?: string␊ - /**␊ - * unique identifier of this domain␊ - */␊ - id?: string␊ - /**␊ - * type of domain name␊ - */␊ - kind?: ("heroku" | "custom")␊ - /**␊ - * when domain was updated␊ - */␊ - updated_at?: string␊ - /**␊ - * status of this record's cname␊ - */␊ - status?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Dyno sizes are the values and details of sizes that can be assigned to dynos. This information can also be found at : [https://devcenter.heroku.com/articles/dyno-types](https://devcenter.heroku.com/articles/dyno-types).␊ - */␊ - export interface HerokuPlatformAPIDynoSize {␊ - /**␊ - * minimum vCPUs, non-dedicated may get more depending on load␊ - */␊ - compute?: number␊ - cost?: Cost␊ - /**␊ - * whether this dyno will be dedicated to one user␊ - */␊ - dedicated?: boolean␊ - /**␊ - * unit of consumption for Heroku Enterprise customers␊ - */␊ - dyno_units?: number␊ - /**␊ - * unique identifier of this dyno size␊ - */␊ - id?: string␊ - /**␊ - * amount of RAM in GB␊ - */␊ - memory?: number␊ - /**␊ - * the name of this dyno-size␊ - */␊ - name?: string␊ - /**␊ - * whether this dyno can only be provisioned in a private space␊ - */␊ - private_space_only?: boolean␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Dynos encapsulate running processes of an app on Heroku. Detailed information about dyno sizes can be found at: [https://devcenter.heroku.com/articles/dyno-types](https://devcenter.heroku.com/articles/dyno-types).␊ - */␊ - export interface HerokuPlatformAPIDyno {␊ - /**␊ - * a URL to stream output from for attached processes or null for non-attached processes␊ - */␊ - attach_url?: (string | null)␊ - /**␊ - * command used to start this process␊ - */␊ - command?: string␊ - /**␊ - * when dyno was created␊ - */␊ - created_at?: string␊ - /**␊ - * unique identifier of this dyno␊ - */␊ - id?: string␊ - /**␊ - * the name of this process on this dyno␊ - */␊ - name?: string␊ - /**␊ - * app release of the dyno␊ - */␊ - release?: {␊ - /**␊ - * unique identifier of release␊ - */␊ - id?: string␊ - /**␊ - * unique version assigned to the release␊ - */␊ - version?: number␊ - [k: string]: unknown␊ - }␊ - /**␊ - * app formation belongs to␊ - */␊ - app?: {␊ - /**␊ - * unique name of app␊ - */␊ - name?: string␊ - /**␊ - * unique identifier of app␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * dyno size (default: "standard-1X")␊ - */␊ - size?: string␊ - /**␊ - * current status of process (either: crashed, down, idle, starting, or up)␊ - */␊ - state?: string␊ - /**␊ - * type of process␊ - */␊ - type?: string␊ - /**␊ - * when process last changed state␊ - */␊ - updated_at?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An event represents an action performed on another API resource.␊ - */␊ - export interface HerokuPlatformAPIEvent {␊ - /**␊ - * the operation performed on the resource␊ - */␊ - action?: ("create" | "destroy" | "update")␊ - /**␊ - * user that performed the operation␊ - */␊ - actor?: {␊ - /**␊ - * unique email address of account␊ - */␊ - email?: string␊ - /**␊ - * unique identifier of an account␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * when the event was created␊ - */␊ - created_at?: string␊ - data?: Data␊ - /**␊ - * unique identifier of an event␊ - */␊ - id?: string␊ - /**␊ - * data fields that were changed during update with previous values␊ - */␊ - previous_data?: {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * when the event was published␊ - */␊ - published_at?: (null | string)␊ - /**␊ - * the type of resource affected␊ - */␊ - resource?: ("addon" | "addon-attachment" | "app" | "app-setup" | "app-transfer" | "build" | "collaborator" | "domain" | "dyno" | "failed-event" | "formation" | "formation-set" | "inbound-ruleset" | "organization" | "release" | "space" | "user")␊ - /**␊ - * a numeric string representing the event's sequence␊ - */␊ - sequence?: (null | string)␊ - /**␊ - * when the event was updated (same as created)␊ - */␊ - updated_at?: string␊ - /**␊ - * the event's API version string␊ - */␊ - version?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A failed event represents a failure of an action performed on another API resource.␊ - */␊ - export interface HerokuPlatformAPIFailedEvent {␊ - /**␊ - * The attempted operation performed on the resource.␊ - */␊ - action?: ("create" | "destroy" | "update" | "unknown")␊ - /**␊ - * An HTTP status code.␊ - */␊ - code?: (number | null)␊ - /**␊ - * ID of error raised.␊ - */␊ - error_id?: (string | null)␊ - /**␊ - * A detailed error message.␊ - */␊ - message?: string␊ - /**␊ - * The HTTP method type of the failed action.␊ - */␊ - method?: ("DELETE" | "GET" | "HEAD" | "OPTIONS" | "PATCH" | "POST" | "PUT")␊ - /**␊ - * The path of the attempted operation.␊ - */␊ - path?: string␊ - /**␊ - * The related resource of the failed action.␊ - */␊ - resource?: ({␊ - /**␊ - * Unique identifier of a resource.␊ - */␊ - id?: string␊ - /**␊ - * the type of resource affected␊ - */␊ - name?: ("addon" | "addon-attachment" | "app" | "app-setup" | "app-transfer" | "build" | "collaborator" | "domain" | "dyno" | "failed-event" | "formation" | "formation-set" | "inbound-ruleset" | "organization" | "release" | "space" | "user")␊ - [k: string]: unknown␊ - } | null)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * The formation of processes that should be maintained for an app. Update the formation to scale processes or change dyno sizes. Available process type names and commands are defined by the \`process_types\` attribute for the [slug](#slug) currently released on an app.␊ - */␊ - export interface HerokuPlatformAPIFormation {␊ - /**␊ - * app formation belongs to␊ - */␊ - app?: {␊ - /**␊ - * unique name of app␊ - */␊ - name?: string␊ - /**␊ - * unique identifier of app␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * command to use to launch this process␊ - */␊ - command?: string␊ - /**␊ - * when process type was created␊ - */␊ - created_at?: string␊ - /**␊ - * unique identifier of this process type␊ - */␊ - id?: string␊ - /**␊ - * number of processes to maintain␊ - */␊ - quantity?: number␊ - /**␊ - * dyno size (default: "standard-1X")␊ - */␊ - size?: string␊ - /**␊ - * type of process to maintain␊ - */␊ - type?: string␊ - /**␊ - * when dyno type was updated␊ - */␊ - updated_at?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An inbound-ruleset is a collection of rules that specify what hosts can or cannot connect to an application.␊ - */␊ - export interface HerokuPlatformAPIInboundRuleset {␊ - /**␊ - * unique identifier of an inbound-ruleset␊ - */␊ - id?: string␊ - /**␊ - * when inbound-ruleset was created␊ - */␊ - created_at?: string␊ - rules?: Rule[]␊ - /**␊ - * unique email address of account␊ - */␊ - created_by?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * the combination of an IP address in CIDR notation and whether to allow or deny it's traffic.␊ - */␊ - export interface Rule {␊ - /**␊ - * states whether the connection is allowed or denied␊ - */␊ - action: ("allow" | "deny")␊ - /**␊ - * is the request’s source in CIDR notation␊ - */␊ - source: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Organizations allow you to manage access to a shared group of applications across your development team.␊ - */␊ - export interface HerokuPlatformAPIOrganization {␊ - /**␊ - * unique identifier of organization␊ - */␊ - id?: string␊ - /**␊ - * when the organization was created␊ - */␊ - created_at?: string␊ - /**␊ - * whether charges incurred by the org are paid by credit card.␊ - */␊ - credit_card_collections?: boolean␊ - /**␊ - * whether to use this organization when none is specified␊ - */␊ - default?: boolean␊ - /**␊ - * upper limit of members allowed in an organization.␊ - */␊ - membership_limit?: (number | null)␊ - /**␊ - * unique name of organization␊ - */␊ - name?: string␊ - /**␊ - * whether the org is provisioned licenses by salesforce.␊ - */␊ - provisioned_licenses?: boolean␊ - /**␊ - * role in the organization␊ - */␊ - role?: ("admin" | "collaborator" | "member" | "owner" | null)␊ - /**␊ - * type of organization.␊ - */␊ - type?: ("enterprise" | "team")␊ - /**␊ - * when the organization was updated␊ - */␊ - updated_at?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A release represents a combination of code, config vars and add-ons for an app on Heroku.␊ - */␊ - export interface HerokuPlatformAPIRelease {␊ - /**␊ - * add-on plans installed on the app for this release␊ - */␊ - addon_plan_names?: string[]␊ - /**␊ - * app involved in the release␊ - */␊ - app?: {␊ - /**␊ - * unique name of app␊ - */␊ - name?: string␊ - /**␊ - * unique identifier of app␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * when release was created␊ - */␊ - created_at?: string␊ - /**␊ - * description of changes in this release␊ - */␊ - description?: string␊ - /**␊ - * unique identifier of release␊ - */␊ - id?: string␊ - /**␊ - * when release was updated␊ - */␊ - updated_at?: string␊ - /**␊ - * slug running in this release␊ - */␊ - slug?: ({␊ - /**␊ - * unique identifier of slug␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - } | null)␊ - /**␊ - * current status of the release␊ - */␊ - status?: ("failed" | "pending" | "succeeded")␊ - /**␊ - * user that created the release␊ - */␊ - user?: {␊ - /**␊ - * unique identifier of an account␊ - */␊ - id?: string␊ - /**␊ - * unique email address of account␊ - */␊ - email?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * unique version assigned to the release␊ - */␊ - version?: number␊ - /**␊ - * indicates this release as being the current one for the app␊ - */␊ - current?: boolean␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A space is an isolated, highly available, secure app execution environments, running in the modern VPC substrate.␊ - */␊ - export interface HerokuPlatformAPISpace {␊ - /**␊ - * when space was created␊ - */␊ - created_at?: string␊ - /**␊ - * unique identifier of space␊ - */␊ - id?: string␊ - /**␊ - * unique name of space␊ - */␊ - name?: string␊ - /**␊ - * organization that owns this space␊ - */␊ - organization?: {␊ - /**␊ - * unique name of organization␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * identity of space region␊ - */␊ - region?: {␊ - /**␊ - * unique identifier of region␊ - */␊ - id?: string␊ - /**␊ - * unique name of region␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * true if this space has shield enabled␊ - */␊ - shield?: boolean␊ - /**␊ - * availability of this space␊ - */␊ - state?: ("allocating" | "allocated" | "deleting")␊ - /**␊ - * when space was updated␊ - */␊ - updated_at?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Filters are special endpoints to allow for API consumers to specify a subset of resources to consume in order to reduce the number of requests that are performed. Each filter endpoint endpoint is responsible for determining its supported request format. The endpoints are over POST in order to handle large request bodies without hitting request uri query length limitations, but the requests themselves are idempotent and will not have side effects.␊ - */␊ - export interface HerokuPlatformAPIFilters {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Identity Providers represent the SAML configuration of an Organization.␊ - */␊ - export interface HerokuPlatformAPIIdentityProvider {␊ - /**␊ - * raw contents of the public certificate (eg: .crt or .pem file)␊ - */␊ - certificate?: string␊ - /**␊ - * when provider record was created␊ - */␊ - created_at?: string␊ - /**␊ - * URL identifier provided by the identity provider␊ - */␊ - entity_id?: string␊ - /**␊ - * unique identifier of this identity provider␊ - */␊ - id?: string␊ - /**␊ - * single log out URL for this identity provider␊ - */␊ - slo_target_url?: string␊ - /**␊ - * single sign on URL for this identity provider␊ - */␊ - sso_target_url?: string␊ - /**␊ - * organization associated with this identity provider␊ - */␊ - organization?: (null | {␊ - /**␊ - * unique name of organization␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - })␊ - /**␊ - * when the identity provider record was updated␊ - */␊ - updated_at?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An invitation represents an invite sent to a user to use the Heroku platform.␊ - */␊ - export interface HerokuPlatformAPIInvitation {␊ - /**␊ - * if the invitation requires verification␊ - */␊ - verification_required?: boolean␊ - /**␊ - * when invitation was created␊ - */␊ - created_at?: string␊ - user?: {␊ - /**␊ - * unique email address of account␊ - */␊ - email?: string␊ - /**␊ - * unique identifier of an account␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An invoice address represents the address that should be listed on an invoice.␊ - */␊ - export interface HerokuVaultAPIInvoiceAddress {␊ - /**␊ - * invoice street address line 1␊ - */␊ - address_1?: string␊ - /**␊ - * invoice street address line 2␊ - */␊ - address_2?: string␊ - /**␊ - * invoice city␊ - */␊ - city?: string␊ - /**␊ - * country␊ - */␊ - country?: string␊ - heroku_id?: string␊ - /**␊ - * metadata / additional information to go on invoice␊ - */␊ - other?: string␊ - /**␊ - * invoice zip code␊ - */␊ - postal_code?: string␊ - /**␊ - * invoice state␊ - */␊ - state?: string␊ - /**␊ - * flag to use the invoice address for an account or not␊ - */␊ - use_invoice_address?: boolean␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An invoice is an itemized bill of goods for an account which includes pricing and charges.␊ - */␊ - export interface HerokuPlatformAPIInvoice {␊ - /**␊ - * total charges on this invoice␊ - */␊ - charges_total?: number␊ - /**␊ - * when invoice was created␊ - */␊ - created_at?: string␊ - /**␊ - * total credits on this invoice␊ - */␊ - credits_total?: number␊ - /**␊ - * unique identifier of this invoice␊ - */␊ - id?: string␊ - /**␊ - * human readable invoice number␊ - */␊ - number?: number␊ - /**␊ - * the ending date that the invoice covers␊ - */␊ - period_end?: string␊ - /**␊ - * the starting date that this invoice covers␊ - */␊ - period_start?: string␊ - /**␊ - * payment status for this invoice (pending, successful, failed)␊ - */␊ - state?: number␊ - /**␊ - * combined total of charges and credits on this invoice␊ - */␊ - total?: number␊ - /**␊ - * when invoice was updated␊ - */␊ - updated_at?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Keys represent public SSH keys associated with an account and are used to authorize accounts as they are performing git operations.␊ - */␊ - export interface HerokuPlatformAPIKey {␊ - /**␊ - * comment on the key␊ - */␊ - comment?: string␊ - /**␊ - * when key was created␊ - */␊ - created_at?: string␊ - /**␊ - * @deprecated␊ - * deprecated. Please refer to 'comment' instead␊ - */␊ - email?: string␊ - /**␊ - * a unique identifying string based on contents␊ - */␊ - fingerprint?: string␊ - /**␊ - * unique identifier of this key␊ - */␊ - id?: string␊ - /**␊ - * full public_key as uploaded␊ - */␊ - public_key?: string␊ - /**␊ - * when key was updated␊ - */␊ - updated_at?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * [Log drains](https://devcenter.heroku.com/articles/log-drains) provide a way to forward your Heroku logs to an external syslog server for long-term archiving. This external service must be configured to receive syslog packets from Heroku, whereupon its URL can be added to an app using this API. Some add-ons will add a log drain when they are provisioned to an app. These drains can only be removed by removing the add-on.␊ - */␊ - export interface HerokuPlatformAPILogDrain {␊ - addon?: Addon␊ - /**␊ - * when log drain was created␊ - */␊ - created_at?: string␊ - /**␊ - * unique identifier of this log drain␊ - */␊ - id?: string␊ - /**␊ - * token associated with the log drain␊ - */␊ - token?: string␊ - /**␊ - * when log drain was updated␊ - */␊ - updated_at?: string␊ - /**␊ - * url associated with the log drain␊ - */␊ - url?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A log session is a reference to the http based log stream for an app.␊ - */␊ - export interface HerokuPlatformAPILogSession {␊ - /**␊ - * when log connection was created␊ - */␊ - created_at?: string␊ - /**␊ - * unique identifier of this log session␊ - */␊ - id?: string␊ - /**␊ - * URL for log streaming session␊ - */␊ - logplex_url?: string␊ - /**␊ - * when log session was updated␊ - */␊ - updated_at?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * OAuth authorizations represent clients that a Heroku user has authorized to automate, customize or extend their usage of the platform. For more information please refer to the [Heroku OAuth documentation](https://devcenter.heroku.com/articles/oauth)␊ - */␊ - export interface HerokuPlatformAPIOAuthAuthorization {␊ - /**␊ - * access token for this authorization␊ - */␊ - access_token?: (null | {␊ - /**␊ - * seconds until OAuth token expires; may be \`null\` for tokens with indefinite lifetime␊ - */␊ - expires_in?: (null | number)␊ - /**␊ - * unique identifier of OAuth token␊ - */␊ - id?: string␊ - /**␊ - * contents of the token to be used for authorization␊ - */␊ - token?: string␊ - [k: string]: unknown␊ - })␊ - /**␊ - * identifier of the client that obtained this authorization, if any␊ - */␊ - client?: (null | {␊ - /**␊ - * unique identifier of this OAuth client␊ - */␊ - id?: string␊ - /**␊ - * OAuth client name␊ - */␊ - name?: string␊ - /**␊ - * endpoint for redirection after authorization with OAuth client␊ - */␊ - redirect_uri?: string␊ - [k: string]: unknown␊ - })␊ - /**␊ - * when OAuth authorization was created␊ - */␊ - created_at?: string␊ - /**␊ - * this authorization's grant␊ - */␊ - grant?: (null | {␊ - /**␊ - * grant code received from OAuth web application authorization␊ - */␊ - code?: string␊ - /**␊ - * seconds until OAuth grant expires␊ - */␊ - expires_in?: number␊ - /**␊ - * unique identifier of OAuth grant␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - })␊ - /**␊ - * unique identifier of OAuth authorization␊ - */␊ - id?: string␊ - /**␊ - * refresh token for this authorization␊ - */␊ - refresh_token?: (null | {␊ - /**␊ - * seconds until OAuth token expires; may be \`null\` for tokens with indefinite lifetime␊ - */␊ - expires_in?: (null | number)␊ - /**␊ - * unique identifier of OAuth token␊ - */␊ - id?: string␊ - /**␊ - * contents of the token to be used for authorization␊ - */␊ - token?: string␊ - [k: string]: unknown␊ - })␊ - scope?: Scope␊ - /**␊ - * when OAuth authorization was updated␊ - */␊ - updated_at?: string␊ - /**␊ - * authenticated user associated with this authorization␊ - */␊ - user?: {␊ - /**␊ - * unique identifier of an account␊ - */␊ - id?: string␊ - /**␊ - * unique email address of account␊ - */␊ - email?: string␊ - /**␊ - * full name of the account owner␊ - */␊ - full_name?: (string | null)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * OAuth clients are applications that Heroku users can authorize to automate, customize or extend their usage of the platform. For more information please refer to the [Heroku OAuth documentation](https://devcenter.heroku.com/articles/oauth).␊ - */␊ - export interface HerokuPlatformAPIOAuthClient {␊ - /**␊ - * when OAuth client was created␊ - */␊ - created_at?: string␊ - /**␊ - * unique identifier of this OAuth client␊ - */␊ - id?: string␊ - /**␊ - * whether the client is still operable given a delinquent account␊ - */␊ - ignores_delinquent?: (boolean | null)␊ - /**␊ - * OAuth client name␊ - */␊ - name?: string␊ - /**␊ - * endpoint for redirection after authorization with OAuth client␊ - */␊ - redirect_uri?: string␊ - /**␊ - * secret used to obtain OAuth authorizations under this client␊ - */␊ - secret?: string␊ - /**␊ - * when OAuth client was updated␊ - */␊ - updated_at?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * OAuth grants are used to obtain authorizations on behalf of a user. For more information please refer to the [Heroku OAuth documentation](https://devcenter.heroku.com/articles/oauth)␊ - */␊ - export interface HerokuPlatformAPIOAuthGrant {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * OAuth tokens provide access for authorized clients to act on behalf of a Heroku user to automate, customize or extend their usage of the platform. For more information please refer to the [Heroku OAuth documentation](https://devcenter.heroku.com/articles/oauth)␊ - */␊ - export interface HerokuPlatformAPIOAuthToken {␊ - /**␊ - * current access token␊ - */␊ - access_token?: {␊ - /**␊ - * seconds until OAuth token expires; may be \`null\` for tokens with indefinite lifetime␊ - */␊ - expires_in?: (null | number)␊ - /**␊ - * unique identifier of OAuth token␊ - */␊ - id?: string␊ - /**␊ - * contents of the token to be used for authorization␊ - */␊ - token?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * authorization for this set of tokens␊ - */␊ - authorization?: {␊ - /**␊ - * unique identifier of OAuth authorization␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * OAuth client secret used to obtain token␊ - */␊ - client?: (null | {␊ - /**␊ - * secret used to obtain OAuth authorizations under this client␊ - */␊ - secret?: string␊ - [k: string]: unknown␊ - })␊ - /**␊ - * when OAuth token was created␊ - */␊ - created_at?: string␊ - /**␊ - * grant used on the underlying authorization␊ - */␊ - grant?: {␊ - /**␊ - * grant code received from OAuth web application authorization␊ - */␊ - code?: string␊ - /**␊ - * type of grant requested, one of \`authorization_code\` or \`refresh_token\`␊ - */␊ - type?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * unique identifier of OAuth token␊ - */␊ - id?: string␊ - /**␊ - * refresh token for this authorization␊ - */␊ - refresh_token?: {␊ - /**␊ - * seconds until OAuth token expires; may be \`null\` for tokens with indefinite lifetime␊ - */␊ - expires_in?: (null | number)␊ - /**␊ - * unique identifier of OAuth token␊ - */␊ - id?: string␊ - /**␊ - * contents of the token to be used for authorization␊ - */␊ - token?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * OAuth session using this token␊ - */␊ - session?: {␊ - /**␊ - * unique identifier of OAuth token␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * when OAuth token was updated␊ - */␊ - updated_at?: string␊ - /**␊ - * Reference to the user associated with this token␊ - */␊ - user?: {␊ - /**␊ - * unique identifier of an account␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A list of add-ons the Organization uses across all apps␊ - */␊ - export interface HerokuPlatformAPIOrganizationAddOn {␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An organization collaborator represents an account that has been given access to an organization app on Heroku.␊ - */␊ - export interface HerokuPlatformAPIOrganizationAppCollaborator {␊ - /**␊ - * app collaborator belongs to␊ - */␊ - app?: {␊ - /**␊ - * unique name of app␊ - */␊ - name?: string␊ - /**␊ - * unique identifier of app␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * when collaborator was created␊ - */␊ - created_at?: string␊ - /**␊ - * unique identifier of collaborator␊ - */␊ - id?: string␊ - /**␊ - * role in the organization␊ - */␊ - role?: ("admin" | "collaborator" | "member" | "owner" | null)␊ - /**␊ - * when collaborator was updated␊ - */␊ - updated_at?: string␊ - /**␊ - * identity of collaborated account␊ - */␊ - user?: {␊ - /**␊ - * unique email address of account␊ - */␊ - email?: string␊ - /**␊ - * whether the user is federated and belongs to an Identity Provider␊ - */␊ - federated?: boolean␊ - /**␊ - * unique identifier of an account␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An organization app encapsulates the organization specific functionality of Heroku apps.␊ - */␊ - export interface HerokuPlatformAPIOrganizationApp {␊ - /**␊ - * when app was archived␊ - */␊ - archived_at?: (null | string)␊ - /**␊ - * description from buildpack of app␊ - */␊ - buildpack_provided_description?: (null | string)␊ - /**␊ - * when app was created␊ - */␊ - created_at?: string␊ - /**␊ - * git repo URL of app␊ - */␊ - git_url?: string␊ - /**␊ - * unique identifier of app␊ - */␊ - id?: string␊ - /**␊ - * is the current member a collaborator on this app.␊ - */␊ - joined?: boolean␊ - /**␊ - * are other organization members forbidden from joining this app.␊ - */␊ - locked?: boolean␊ - /**␊ - * maintenance status of app␊ - */␊ - maintenance?: boolean␊ - /**␊ - * unique name of app␊ - */␊ - name?: string␊ - /**␊ - * organization that owns this app␊ - */␊ - organization?: (null | {␊ - /**␊ - * unique name of organization␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - })␊ - /**␊ - * identity of app owner␊ - */␊ - owner?: (null | {␊ - /**␊ - * unique email address of account␊ - */␊ - email?: string␊ - /**␊ - * unique identifier of an account␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - })␊ - /**␊ - * identity of app region␊ - */␊ - region?: {␊ - /**␊ - * unique identifier of region␊ - */␊ - id?: string␊ - /**␊ - * unique name of region␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * when app was released␊ - */␊ - released_at?: (null | string)␊ - /**␊ - * git repo size in bytes of app␊ - */␊ - repo_size?: (number | null)␊ - /**␊ - * slug size in bytes of app␊ - */␊ - slug_size?: (number | null)␊ - /**␊ - * identity of space␊ - */␊ - space?: (null | {␊ - /**␊ - * unique identifier of space␊ - */␊ - id?: string␊ - /**␊ - * unique name of space␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - })␊ - /**␊ - * identity of app stack␊ - */␊ - stack?: {␊ - /**␊ - * unique identifier of stack␊ - */␊ - id?: string␊ - /**␊ - * unique name of stack␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * when app was updated␊ - */␊ - updated_at?: string␊ - /**␊ - * web URL of app␊ - */␊ - web_url?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An organization feature represents a feature enabled on an organization account.␊ - */␊ - export interface HerokuPlatformAPIOrganizationFeature {␊ - /**␊ - * when organization feature was created␊ - */␊ - created_at?: string␊ - /**␊ - * description of organization feature␊ - */␊ - description?: string␊ - /**␊ - * documentation URL of organization feature␊ - */␊ - doc_url?: string␊ - /**␊ - * whether or not organization feature has been enabled␊ - */␊ - enabled?: boolean␊ - /**␊ - * unique identifier of organization feature␊ - */␊ - id?: string␊ - /**␊ - * unique name of organization feature␊ - */␊ - name?: string␊ - /**␊ - * state of organization feature␊ - */␊ - state?: string␊ - /**␊ - * when organization feature was updated␊ - */␊ - updated_at?: string␊ - /**␊ - * user readable feature name␊ - */␊ - display_name?: string␊ - /**␊ - * e-mail to send feedback about the feature␊ - */␊ - feedback_email?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An organization invitation represents an invite to an organization.␊ - */␊ - export interface HerokuPlatformAPIOrganizationInvitation {␊ - /**␊ - * when invitation was created␊ - */␊ - created_at?: string␊ - /**␊ - * Unique identifier of an invitation␊ - */␊ - id?: string␊ - invited_by?: {␊ - /**␊ - * unique email address of account␊ - */␊ - email?: string␊ - /**␊ - * unique identifier of an account␊ - */␊ - id?: string␊ - /**␊ - * full name of the account owner␊ - */␊ - name?: (string | null)␊ - [k: string]: unknown␊ - }␊ - organization?: {␊ - /**␊ - * unique identifier of organization␊ - */␊ - id?: string␊ - /**␊ - * unique name of organization␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * role in the organization␊ - */␊ - role?: ("admin" | "collaborator" | "member" | "owner" | null)␊ - /**␊ - * when invitation was updated␊ - */␊ - updated_at?: string␊ - user?: {␊ - /**␊ - * unique email address of account␊ - */␊ - email?: string␊ - /**␊ - * unique identifier of an account␊ - */␊ - id?: string␊ - /**␊ - * full name of the account owner␊ - */␊ - name?: (string | null)␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An organization invoice is an itemized bill of goods for an organization which includes pricing and charges.␊ - */␊ - export interface HerokuPlatformAPIOrganizationInvoice {␊ - /**␊ - * total add-ons charges in on this invoice␊ - */␊ - addons_total?: number␊ - /**␊ - * total database charges on this invoice␊ - */␊ - database_total?: number␊ - /**␊ - * total charges on this invoice␊ - */␊ - charges_total?: number␊ - /**␊ - * when invoice was created␊ - */␊ - created_at?: string␊ - /**␊ - * total credits on this invoice␊ - */␊ - credits_total?: number␊ - /**␊ - * The total amount of dyno units consumed across dyno types.␊ - */␊ - dyno_units?: number␊ - /**␊ - * unique identifier of this invoice␊ - */␊ - id?: string␊ - /**␊ - * human readable invoice number␊ - */␊ - number?: number␊ - /**␊ - * Status of the invoice payment.␊ - */␊ - payment_status?: string␊ - /**␊ - * the ending date that the invoice covers␊ - */␊ - period_end?: string␊ - /**␊ - * the starting date that this invoice covers␊ - */␊ - period_start?: string␊ - /**␊ - * total platform charges on this invoice␊ - */␊ - platform_total?: number␊ - /**␊ - * payment status for this invoice (pending, successful, failed)␊ - */␊ - state?: number␊ - /**␊ - * combined total of charges and credits on this invoice␊ - */␊ - total?: number␊ - /**␊ - * when invoice was updated␊ - */␊ - updated_at?: string␊ - /**␊ - * The total amount of hours consumed across dyno types.␊ - */␊ - weighted_dyno_hours?: number␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An organization member is an individual with access to an organization.␊ - */␊ - export interface HerokuPlatformAPIOrganizationMember {␊ - /**␊ - * when the membership record was created␊ - */␊ - created_at: string␊ - /**␊ - * email address of the organization member␊ - */␊ - email: string␊ - /**␊ - * whether the user is federated and belongs to an Identity Provider␊ - */␊ - federated: boolean␊ - /**␊ - * unique identifier of organization member␊ - */␊ - id?: string␊ - /**␊ - * role in the organization␊ - */␊ - role?: ("admin" | "collaborator" | "member" | "owner" | null)␊ - /**␊ - * whether the Enterprise organization member has two factor authentication enabled␊ - */␊ - two_factor_authentication?: boolean␊ - /**␊ - * when the membership record was updated␊ - */␊ - updated_at: string␊ - /**␊ - * user information for the membership␊ - */␊ - user?: {␊ - /**␊ - * unique email address of account␊ - */␊ - email?: string␊ - /**␊ - * unique identifier of an account␊ - */␊ - id?: string␊ - /**␊ - * full name of the account owner␊ - */␊ - name?: (string | null)␊ - [k: string]: unknown␊ - }␊ - }␊ - /**␊ - * Tracks an organization's preferences␊ - */␊ - export interface HerokuPlatformAPIOrganizationPreferences {␊ - /**␊ - * The default permission used when adding new members to the organization␊ - */␊ - "default-permission"?: ("admin" | "member" | "viewer" | null)␊ - /**␊ - * Whether whitelisting rules should be applied to add-on installations␊ - */␊ - "whitelisting-enabled"?: (boolean | null)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * An outbound-ruleset is a collection of rules that specify what hosts Dynos are allowed to communicate with. ␊ - */␊ - export interface HerokuPlatformAPIOutboundRuleset {␊ - /**␊ - * unique identifier of an outbound-ruleset␊ - */␊ - id?: string␊ - /**␊ - * when outbound-ruleset was created␊ - */␊ - created_at?: string␊ - rules?: Rule1[]␊ - /**␊ - * unique email address of account␊ - */␊ - created_by?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * the combination of an IP address in CIDR notation, a from_port, to_port and protocol.␊ - */␊ - export interface Rule1 {␊ - /**␊ - * is the target destination in CIDR notation␊ - */␊ - target: string␊ - /**␊ - * an endpoint of communication in an operating system.␊ - */␊ - from_port: number␊ - /**␊ - * an endpoint of communication in an operating system.␊ - */␊ - to_port: number␊ - /**␊ - * formal standards and policies comprised of rules, procedures and formats that define communication between two or more devices over a network␊ - */␊ - protocol: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A password reset represents a in-process password reset attempt.␊ - */␊ - export interface HerokuPlatformAPIPasswordReset {␊ - /**␊ - * when password reset was created␊ - */␊ - created_at?: string␊ - user?: {␊ - /**␊ - * unique email address of account␊ - */␊ - email?: string␊ - /**␊ - * unique identifier of an account␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Information about an app's coupling to a pipeline␊ - */␊ - export interface HerokuPlatformAPIPipelineCoupling {␊ - /**␊ - * app involved in the pipeline coupling␊ - */␊ - app?: {␊ - /**␊ - * unique identifier of app␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * when pipeline coupling was created␊ - */␊ - created_at?: string␊ - /**␊ - * unique identifier of pipeline coupling␊ - */␊ - id?: string␊ - /**␊ - * pipeline involved in the coupling␊ - */␊ - pipeline?: {␊ - /**␊ - * unique identifier of pipeline␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * target pipeline stage␊ - */␊ - stage?: ("test" | "review" | "development" | "staging" | "production")␊ - /**␊ - * when pipeline coupling was updated␊ - */␊ - updated_at?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Promotion targets represent an individual app being promoted to␊ - */␊ - export interface HerokuPlatformAPIPipelinePromotionTarget {␊ - /**␊ - * the app which was promoted to␊ - */␊ - app?: {␊ - /**␊ - * unique identifier of app␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * an error message for why the promotion failed␊ - */␊ - error_message?: (null | string)␊ - /**␊ - * unique identifier of promotion target␊ - */␊ - id?: string␊ - /**␊ - * the promotion which the target belongs to␊ - */␊ - pipeline_promotion?: {␊ - /**␊ - * unique identifier of promotion␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * the release which was created on the target app␊ - */␊ - release?: ({␊ - /**␊ - * unique identifier of release␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - } | null)␊ - /**␊ - * status of promotion␊ - */␊ - status?: ("pending" | "succeeded" | "failed")␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Promotions allow you to move code from an app in a pipeline to all targets␊ - */␊ - export interface HerokuPlatformAPIPipelinePromotion {␊ - /**␊ - * when promotion was created␊ - */␊ - created_at?: string␊ - /**␊ - * unique identifier of promotion␊ - */␊ - id?: string␊ - /**␊ - * the pipeline which the promotion belongs to␊ - */␊ - pipeline?: {␊ - /**␊ - * unique identifier of pipeline␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * the app being promoted from␊ - */␊ - source?: {␊ - /**␊ - * the app which was promoted from␊ - */␊ - app?: {␊ - /**␊ - * unique identifier of app␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * the release used to promoted from␊ - */␊ - release?: {␊ - /**␊ - * unique identifier of release␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * status of promotion␊ - */␊ - status?: ("pending" | "completed")␊ - /**␊ - * when promotion was updated␊ - */␊ - updated_at?: (string | null)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A pipeline allows grouping of apps into different stages.␊ - */␊ - export interface HerokuPlatformAPIPipeline {␊ - /**␊ - * when pipeline was created␊ - */␊ - created_at?: string␊ - /**␊ - * unique identifier of pipeline␊ - */␊ - id?: string␊ - /**␊ - * name of pipeline␊ - */␊ - name?: string␊ - /**␊ - * when pipeline was updated␊ - */␊ - updated_at?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Plans represent different configurations of add-ons that may be added to apps. Endpoints under add-on services can be accessed without authentication.␊ - */␊ - export interface HerokuPlatformAPIPlan {␊ - /**␊ - * identity of add-on service␊ - */␊ - addon_service?: {␊ - /**␊ - * unique identifier of this add-on-service␊ - */␊ - id?: string␊ - /**␊ - * unique name of this add-on-service␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * when plan was created␊ - */␊ - created_at?: string␊ - compliance?: Compliance␊ - /**␊ - * whether this plan is the default for its add-on service␊ - */␊ - default?: boolean␊ - /**␊ - * description of plan␊ - */␊ - description?: string␊ - /**␊ - * human readable name of the add-on plan␊ - */␊ - human_name?: string␊ - /**␊ - * unique identifier of this plan␊ - */␊ - id?: string␊ - /**␊ - * whether this plan is installable to a Private Spaces app␊ - */␊ - installable_inside_private_network?: boolean␊ - /**␊ - * whether this plan is installable to a Common Runtime app␊ - */␊ - installable_outside_private_network?: boolean␊ - /**␊ - * unique name of this plan␊ - */␊ - name?: string␊ - /**␊ - * price␊ - */␊ - price?: {␊ - /**␊ - * price in cents per unit of plan␊ - */␊ - cents?: number␊ - /**␊ - * unit of price for plan␊ - */␊ - unit?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * whether this plan is the default for apps in Private Spaces␊ - */␊ - space_default?: boolean␊ - /**␊ - * release status for plan␊ - */␊ - state?: string␊ - /**␊ - * when plan was updated␊ - */␊ - updated_at?: string␊ - /**␊ - * whether this plan is publicly visible␊ - */␊ - visible?: boolean␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Rate Limit represents the number of request tokens each account holds. Requests to this endpoint do not count towards the rate limit.␊ - */␊ - export interface HerokuPlatformAPIRateLimit {␊ - /**␊ - * allowed requests remaining in current interval␊ - */␊ - remaining?: number␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A slug is a snapshot of your application code that is ready to run on the platform.␊ - */␊ - export interface HerokuPlatformAPISlug {␊ - /**␊ - * pointer to the url where clients can fetch or store the actual release binary␊ - */␊ - blob?: {␊ - /**␊ - * method to be used to interact with the slug blob␊ - */␊ - method?: string␊ - /**␊ - * URL to interact with the slug blob␊ - */␊ - url?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * description from buildpack of slug␊ - */␊ - buildpack_provided_description?: (null | string)␊ - /**␊ - * an optional checksum of the slug for verifying its integrity␊ - */␊ - checksum?: (null | string)␊ - /**␊ - * identification of the code with your version control system (eg: SHA of the git HEAD)␊ - */␊ - commit?: (null | string)␊ - /**␊ - * an optional description of the provided commit␊ - */␊ - commit_description?: (null | string)␊ - /**␊ - * when slug was created␊ - */␊ - created_at?: string␊ - /**␊ - * unique identifier of slug␊ - */␊ - id?: string␊ - process_types?: ProcessTypes␊ - /**␊ - * size of slug, in bytes␊ - */␊ - size?: (number | null)␊ - /**␊ - * identity of slug stack␊ - */␊ - stack?: {␊ - /**␊ - * unique identifier of stack␊ - */␊ - id?: string␊ - /**␊ - * unique name of stack␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * when slug was updated␊ - */␊ - updated_at?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * hash mapping process type names to their respective command␊ - */␊ - export interface ProcessTypes {␊ - /**␊ - * This interface was referenced by \`ProcessTypes\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^[-\\w]{1,128}$".␊ - */␊ - [k: string]: string␊ - }␊ - /**␊ - * SMS numbers are used for recovery on accounts with two-factor authentication enabled.␊ - */␊ - export interface HerokuPlatformAPISMSNumber {␊ - /**␊ - * SMS number of account␊ - */␊ - sms_number?: (string | null)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * SNI Endpoint is a public address serving a custom SSL cert for HTTPS traffic, using the SNI TLS extension, to a Heroku app.␊ - */␊ - export interface HerokuPlatformAPISNIEndpoint {␊ - /**␊ - * raw contents of the public certificate chain (eg: .crt or .pem file)␊ - */␊ - certificate_chain?: string␊ - /**␊ - * deprecated; refer to GET /apps/:id/domains for valid CNAMEs for this app␊ - */␊ - cname?: string␊ - /**␊ - * when endpoint was created␊ - */␊ - created_at?: string␊ - /**␊ - * unique identifier of this SNI endpoint␊ - */␊ - id?: string␊ - /**␊ - * unique name for SNI endpoint␊ - */␊ - name?: string␊ - /**␊ - * when SNI endpoint was updated␊ - */␊ - updated_at?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * A source is a location for uploading and downloading an application's source code.␊ - */␊ - export interface HerokuPlatformAPISource {␊ - /**␊ - * pointer to the URL where clients can fetch or store the source␊ - */␊ - source_blob?: {␊ - /**␊ - * URL to download the source␊ - */␊ - get_url?: string␊ - /**␊ - * URL to upload the source␊ - */␊ - put_url?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Space access represents the permissions a particular user has on a particular space.␊ - */␊ - export interface HerokuPlatformAPISpaceAccess {␊ - /**␊ - * space user belongs to␊ - */␊ - space?: {␊ - /**␊ - * unique name of app␊ - */␊ - name?: string␊ - /**␊ - * unique identifier of app␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * when space was created␊ - */␊ - created_at?: string␊ - /**␊ - * unique identifier of space␊ - */␊ - id?: string␊ - /**␊ - * user space permissions␊ - */␊ - permissions?: {␊ - description?: string␊ - name?: string␊ - [k: string]: unknown␊ - }[]␊ - /**␊ - * when space was updated␊ - */␊ - updated_at?: string␊ - /**␊ - * identity of user account␊ - */␊ - user?: {␊ - /**␊ - * unique email address of account␊ - */␊ - email?: string␊ - /**␊ - * unique identifier of an account␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Network address translation (NAT) for stable outbound IP addresses from a space␊ - */␊ - export interface HerokuPlatformAPISpaceNetworkAddressTranslation {␊ - /**␊ - * when network address translation for a space was created␊ - */␊ - created_at?: string␊ - sources?: Sources␊ - /**␊ - * availability of network address translation for a space␊ - */␊ - state?: ("disabled" | "updating" | "enabled")␊ - /**␊ - * when network address translation for a space was updated␊ - */␊ - updated_at?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * [SSL Endpoint](https://devcenter.heroku.com/articles/ssl-endpoint) is a public address serving custom SSL cert for HTTPS traffic to a Heroku app. Note that an app must have the \`ssl:endpoint\` add-on installed before it can provision an SSL Endpoint using these APIs.␊ - */␊ - export interface HerokuPlatformAPISSLEndpoint {␊ - /**␊ - * application associated with this ssl-endpoint␊ - */␊ - app?: {␊ - /**␊ - * unique identifier of app␊ - */␊ - id?: string␊ - /**␊ - * unique name of app␊ - */␊ - name?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * raw contents of the public certificate chain (eg: .crt or .pem file)␊ - */␊ - certificate_chain?: string␊ - /**␊ - * canonical name record, the address to point a domain at␊ - */␊ - cname?: string␊ - /**␊ - * when endpoint was created␊ - */␊ - created_at?: string␊ - /**␊ - * unique identifier of this SSL endpoint␊ - */␊ - id?: string␊ - /**␊ - * unique name for SSL endpoint␊ - */␊ - name?: string␊ - /**␊ - * when endpoint was updated␊ - */␊ - updated_at?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Stacks are the different application execution environments available in the Heroku platform.␊ - */␊ - export interface HerokuPlatformAPIStack {␊ - /**␊ - * when stack was introduced␊ - */␊ - created_at?: string␊ - /**␊ - * unique identifier of stack␊ - */␊ - id?: string␊ - /**␊ - * unique name of stack␊ - */␊ - name?: string␊ - /**␊ - * availability of this stack: beta, deprecated or public␊ - */␊ - state?: string␊ - /**␊ - * when stack was last modified␊ - */␊ - updated_at?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Tracks a user's preferences and message dismissals␊ - */␊ - export interface HerokuPlatformAPIUserPreferences {␊ - /**␊ - * User's default timezone␊ - */␊ - timezone?: (string | null)␊ - /**␊ - * User's default organization␊ - */␊ - "default-organization"?: (string | null)␊ - /**␊ - * Whether the user has dismissed the GitHub link banner␊ - */␊ - "dismissed-github-banner"?: (boolean | null)␊ - /**␊ - * Whether the user has dismissed the getting started banner␊ - */␊ - "dismissed-getting-started"?: (boolean | null)␊ - /**␊ - * Whether the user has dismissed the Organization Access Controls banner␊ - */␊ - "dismissed-org-access-controls"?: (boolean | null)␊ - /**␊ - * Whether the user has dismissed the Organization Wizard␊ - */␊ - "dismissed-org-wizard-notification"?: (boolean | null)␊ - /**␊ - * Whether the user has dismissed the Pipelines banner␊ - */␊ - "dismissed-pipelines-banner"?: (boolean | null)␊ - /**␊ - * Whether the user has dismissed the GitHub banner on a pipeline overview␊ - */␊ - "dismissed-pipelines-github-banner"?: (boolean | null)␊ - "dismissed-pipelines-github-banners"?: DismissedPipelinesGithubBanners␊ - /**␊ - * Whether the user has dismissed the 2FA SMS banner␊ - */␊ - "dismissed-sms-banner"?: (boolean | null)␊ - [k: string]: unknown␊ - }␊ - /**␊ - * Entities that have been whitelisted to be used by an Organization␊ - */␊ - export interface HerokuPlatformAPIWhitelistedEntity {␊ - /**␊ - * when the add-on service was whitelisted␊ - */␊ - added_at?: string␊ - added_by?: AddedBy␊ - addon_service?: AddonService␊ - /**␊ - * unique identifier for this whitelisting entity␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * the user which whitelisted the Add-on Service␊ - */␊ - export interface AddedBy {␊ - /**␊ - * unique email address of account␊ - */␊ - email?: string␊ - /**␊ - * unique identifier of an account␊ - */␊ - id?: string␊ - [k: string]: unknown␊ - }␊ - /**␊ - * the Add-on Service whitelisted for use␊ - */␊ - export interface AddonService {␊ - /**␊ - * unique identifier of this add-on-service␊ - */␊ - id?: string␊ - /**␊ - * unique name of this add-on-service␊ - */␊ - name?: string␊ - /**␊ - * human-readable name of the add-on service provider␊ - */␊ - human_name?: string␊ - [k: string]: unknown␊ - }␊ - ` - -## realWorld.jsonStat.js - -> Expected output to match snapshot for e2e test: realWorld.jsonStat.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - /**␊ - * This is version 1.03 of the JSON-stat 2.0 Schema (2016-05-04)␊ - */␊ - export type JSONStat20Schema =␊ - | {␊ - class: "dataset";␊ - version: Version;␊ - href?: Href;␊ - label?: Label;␊ - note?: Note;␊ - link?: Link;␊ - updated?: Updated;␊ - source?: Source;␊ - error?: Error;␊ - extension?: Extension;␊ - id: Note;␊ - size: number[];␊ - role?: {␊ - time?: Note;␊ - geo?: Note;␊ - metric?: Note;␊ - };␊ - dimension: {␊ - [k: string]: {␊ - href?: Href;␊ - label?: Label;␊ - note?: Note;␊ - link?: Link;␊ - extension?: Extension;␊ - category: Category;␊ - };␊ - };␊ - value:␊ - | (number | null | string)[]␊ - | {␊ - [k: string]: number | null | string;␊ - };␊ - status?:␊ - | string␊ - | string[]␊ - | {␊ - [k: string]: string;␊ - };␊ - }␊ - | {␊ - class: "dimension";␊ - version: Version;␊ - href?: Href;␊ - label?: Label;␊ - note?: Note;␊ - link?: Link;␊ - updated?: Updated;␊ - source?: Source;␊ - error?: Error;␊ - extension?: Extension;␊ - category: Category;␊ - }␊ - | {␊ - class: "collection";␊ - version: Version;␊ - href?: Href;␊ - label?: Label;␊ - note?: Note;␊ - link: {␊ - item?: {␊ - type?: string;␊ - class?: "dataset" | "collection" | "dimension";␊ - href?: Href;␊ - label?: Label;␊ - note?: Note;␊ - link?: Link;␊ - updated?: Updated;␊ - source?: Source;␊ - extension?: Extension;␊ - category?: Category;␊ - id?: Note;␊ - size?: number[];␊ - role?: {␊ - time?: Note;␊ - geo?: Note;␊ - metric?: Note;␊ - };␊ - dimension?: {␊ - [k: string]: {␊ - href?: Href;␊ - label?: Label;␊ - note?: Note;␊ - link?: Link;␊ - extension?: Extension;␊ - category: Category;␊ - };␊ - };␊ - value?:␊ - | (number | null | string)[]␊ - | {␊ - [k: string]: number | null | string;␊ - };␊ - status?:␊ - | string␊ - | string[]␊ - | {␊ - [k: string]: string;␊ - };␊ - }[];␊ - };␊ - updated?: Updated;␊ - source?: Source;␊ - error?: Error;␊ - extension?: Extension;␊ - };␊ - export type Version = "2.0";␊ - export type Href = string;␊ - export type Label = string;␊ - export type Note = string[];␊ - export type Updated = string;␊ - export type Source = string;␊ - export type Error = unknown[];␊ - ␊ - export interface Link {␊ - /**␊ - * This interface was referenced by \`Link\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^(about|alternate|appendix|archives|author|blocked-by|bookmark|canonical|chapter|collection|contents|copyright|create-form|current|derivedfrom|describedby|describes|disclosure|dns-prefetch|duplicate|edit|edit-form|edit-media|enclosure|first|glossary|help|hosts|hub|icon|index|item|last|latest-version|license|lrdd|memento|monitor|monitor-group|next|next-archive|nofollow|noreferrer|original|payment|pingback|preconnect|predecessor-version|prefetch|preload|prerender|prev|preview|previous|prev-archive|privacy-policy|profile|related|replies|search|section|self|service|start|stylesheet|subsection|successor-version|tag|terms-of-service|timegate|timemap|type|up|version-history|via|webmention|working-copy|working-copy-of)$".␊ - */␊ - [k: string]: {␊ - type?: string;␊ - class?: "dataset" | "collection" | "dimension";␊ - href?: Href;␊ - label?: Label;␊ - note?: Note;␊ - link?: Link;␊ - updated?: Updated;␊ - source?: Source;␊ - extension?: Extension;␊ - category?: Category;␊ - id?: Note;␊ - size?: number[];␊ - role?: {␊ - time?: Note;␊ - geo?: Note;␊ - metric?: Note;␊ - };␊ - dimension?: {␊ - [k: string]: {␊ - href?: Href;␊ - label?: Label;␊ - note?: Note;␊ - link?: Link;␊ - extension?: Extension;␊ - category: Category;␊ - };␊ - };␊ - value?:␊ - | (number | null | string)[]␊ - | {␊ - [k: string]: number | null | string;␊ - };␊ - status?:␊ - | string␊ - | string[]␊ - | {␊ - [k: string]: string;␊ - };␊ - }[];␊ - }␊ - export interface Extension {␊ - [k: string]: unknown;␊ - }␊ - export interface Category {␊ - index?:␊ - | Note␊ - | {␊ - [k: string]: number;␊ - };␊ - label?: {␊ - [k: string]: string;␊ - };␊ - note?: {␊ - [k: string]: Note;␊ - };␊ - unit?: {␊ - [k: string]: {␊ - label?: Label;␊ - decimals?: number;␊ - position?: "start" | "end";␊ - [k: string]: unknown;␊ - };␊ - };␊ - coordinates?: {␊ - [k: string]: [] | [number] | [number, number];␊ - };␊ - child?: {␊ - [k: string]: Note;␊ - };␊ - }␊ - ` - -## realWorld.jsonschema.js - -> Expected output to match snapshot for e2e test: realWorld.jsonschema.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export type CoreSchemaMetaSchema = CoreSchemaMetaSchema1 & CoreSchemaMetaSchema2;␊ - export type NonNegativeInteger = number;␊ - export type NonNegativeIntegerDefault0 = NonNegativeInteger;␊ - export type CoreSchemaMetaSchema2 =␊ - | {␊ - $id?: string;␊ - $schema?: string;␊ - $ref?: string;␊ - $comment?: string;␊ - title?: string;␊ - description?: string;␊ - default?: unknown;␊ - readOnly?: boolean;␊ - writeOnly?: boolean;␊ - examples?: unknown[];␊ - multipleOf?: number;␊ - maximum?: number;␊ - exclusiveMaximum?: number;␊ - minimum?: number;␊ - exclusiveMinimum?: number;␊ - maxLength?: NonNegativeInteger;␊ - minLength?: NonNegativeIntegerDefault0;␊ - pattern?: string;␊ - additionalItems?: CoreSchemaMetaSchema2;␊ - items?: CoreSchemaMetaSchema2 | SchemaArray;␊ - maxItems?: NonNegativeInteger;␊ - minItems?: NonNegativeIntegerDefault0;␊ - uniqueItems?: boolean;␊ - contains?: CoreSchemaMetaSchema2;␊ - maxProperties?: NonNegativeInteger;␊ - minProperties?: NonNegativeIntegerDefault0;␊ - required?: StringArray;␊ - additionalProperties?: CoreSchemaMetaSchema2;␊ - definitions?: {␊ - [k: string]: CoreSchemaMetaSchema2;␊ - };␊ - properties?: {␊ - [k: string]: CoreSchemaMetaSchema2;␊ - };␊ - patternProperties?: {␊ - [k: string]: CoreSchemaMetaSchema2;␊ - };␊ - dependencies?: {␊ - [k: string]: CoreSchemaMetaSchema2 | StringArray;␊ - };␊ - propertyNames?: CoreSchemaMetaSchema2;␊ - const?: unknown;␊ - /**␊ - * @minItems 1␊ - */␊ - enum?: [unknown, ...unknown[]];␊ - type?: SimpleTypes | [SimpleTypes, ...SimpleTypes[]];␊ - format?: string;␊ - contentMediaType?: string;␊ - contentEncoding?: string;␊ - if?: CoreSchemaMetaSchema2;␊ - then?: CoreSchemaMetaSchema2;␊ - else?: CoreSchemaMetaSchema2;␊ - allOf?: SchemaArray;␊ - anyOf?: SchemaArray;␊ - oneOf?: SchemaArray;␊ - not?: CoreSchemaMetaSchema2;␊ - [k: string]: unknown;␊ - }␊ - | boolean;␊ - /**␊ - * @minItems 1␊ - */␊ - export type SchemaArray = [CoreSchemaMetaSchema2, ...CoreSchemaMetaSchema2[]];␊ - export type StringArray = string[];␊ - export type SimpleTypes = "array" | "boolean" | "integer" | "null" | "number" | "object" | "string";␊ - ␊ - export interface CoreSchemaMetaSchema1 {␊ - $id?: string;␊ - $schema?: string;␊ - $ref?: string;␊ - $comment?: string;␊ - title?: string;␊ - description?: string;␊ - default?: unknown;␊ - readOnly?: boolean;␊ - writeOnly?: boolean;␊ - examples?: unknown[];␊ - multipleOf?: number;␊ - maximum?: number;␊ - exclusiveMaximum?: number;␊ - minimum?: number;␊ - exclusiveMinimum?: number;␊ - maxLength?: NonNegativeInteger;␊ - minLength?: NonNegativeIntegerDefault0;␊ - pattern?: string;␊ - additionalItems?: CoreSchemaMetaSchema2;␊ - items?: CoreSchemaMetaSchema2 | SchemaArray;␊ - maxItems?: NonNegativeInteger;␊ - minItems?: NonNegativeIntegerDefault0;␊ - uniqueItems?: boolean;␊ - contains?: CoreSchemaMetaSchema2;␊ - maxProperties?: NonNegativeInteger;␊ - minProperties?: NonNegativeIntegerDefault0;␊ - required?: StringArray;␊ - additionalProperties?: CoreSchemaMetaSchema2;␊ - definitions?: {␊ - [k: string]: CoreSchemaMetaSchema2;␊ - };␊ - properties?: {␊ - [k: string]: CoreSchemaMetaSchema2;␊ - };␊ - patternProperties?: {␊ - [k: string]: CoreSchemaMetaSchema2;␊ - };␊ - dependencies?: {␊ - [k: string]: CoreSchemaMetaSchema2 | StringArray;␊ - };␊ - propertyNames?: CoreSchemaMetaSchema2;␊ - const?: unknown;␊ - /**␊ - * @minItems 1␊ - */␊ - enum?: [unknown, ...unknown[]];␊ - type?: SimpleTypes | [SimpleTypes, ...SimpleTypes[]];␊ - format?: string;␊ - contentMediaType?: string;␊ - contentEncoding?: string;␊ - if?: CoreSchemaMetaSchema2;␊ - then?: CoreSchemaMetaSchema2;␊ - else?: CoreSchemaMetaSchema2;␊ - allOf?: SchemaArray;␊ - anyOf?: SchemaArray;␊ - oneOf?: SchemaArray;␊ - not?: CoreSchemaMetaSchema2;␊ - [k: string]: unknown;␊ - }␊ - ` - -## realWorld.openapi.js - -> Expected output to match snapshot for e2e test: realWorld.openapi.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export type Parameter = Parameter1 & {␊ - name: string;␊ - in: string;␊ - description?: string;␊ - required?: boolean;␊ - deprecated?: boolean;␊ - allowEmptyValue?: boolean;␊ - style?: string;␊ - explode?: boolean;␊ - allowReserved?: boolean;␊ - schema?: Schema | Reference;␊ - content?: {␊ - [k: string]: MediaType;␊ - };␊ - example?: unknown;␊ - examples?: {␊ - [k: string]: Example | Reference;␊ - };␊ - /**␊ - * This interface was referenced by \`undefined\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - };␊ - export type Parameter1 = ExampleXORExamples & SchemaXORContent & ParameterLocation;␊ - /**␊ - * Schema and content are mutually exclusive, at least one is required␊ - */␊ - export type SchemaXORContent = {␊ - [k: string]: unknown;␊ - };␊ - /**␊ - * Parameter location␊ - */␊ - export type ParameterLocation =␊ - | {␊ - in?: "path";␊ - style?: "matrix" | "label" | "simple";␊ - required: true;␊ - [k: string]: unknown;␊ - }␊ - | {␊ - in?: "query";␊ - style?: "form" | "spaceDelimited" | "pipeDelimited" | "deepObject";␊ - [k: string]: unknown;␊ - }␊ - | {␊ - in?: "header";␊ - style?: "simple";␊ - [k: string]: unknown;␊ - }␊ - | {␊ - in?: "cookie";␊ - style?: "form";␊ - [k: string]: unknown;␊ - };␊ - export type MediaType = MediaType1 & {␊ - schema?: Schema | Reference;␊ - example?: unknown;␊ - examples?: {␊ - [k: string]: Example | Reference;␊ - };␊ - encoding?: {␊ - [k: string]: Encoding;␊ - };␊ - /**␊ - * This interface was referenced by \`undefined\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - };␊ - export type MediaType1 = ExampleXORExamples;␊ - export type Header = Header1 & {␊ - description?: string;␊ - required?: boolean;␊ - deprecated?: boolean;␊ - allowEmptyValue?: boolean;␊ - style?: "simple";␊ - explode?: boolean;␊ - allowReserved?: boolean;␊ - schema?: Schema | Reference;␊ - content?: {␊ - [k: string]: MediaType1;␊ - };␊ - example?: unknown;␊ - examples?: {␊ - [k: string]: Example | Reference;␊ - };␊ - /**␊ - * This interface was referenced by \`undefined\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - };␊ - export type Header1 = ExampleXORExamples & SchemaXORContent;␊ - export type SecurityScheme =␊ - | APIKeySecurityScheme␊ - | HTTPSecurityScheme␊ - | OAuth2SecurityScheme␊ - | OpenIdConnectSecurityScheme;␊ - export type HTTPSecurityScheme = {␊ - scheme: string;␊ - bearerFormat?: string;␊ - description?: string;␊ - type: "http";␊ - /**␊ - * This interface was referenced by \`undefined\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - } & HTTPSecurityScheme1;␊ - export type HTTPSecurityScheme1 =␊ - | {␊ - scheme?: "bearer";␊ - [k: string]: unknown;␊ - }␊ - | {␊ - scheme?: {␊ - [k: string]: unknown;␊ - };␊ - [k: string]: unknown;␊ - };␊ - ␊ - /**␊ - * Validation schema for OpenAPI Specification 3.0.X.␊ - */␊ - export interface HttpsSpecOpenapisOrgOas30Schema20190402 {␊ - openapi: string;␊ - info: Info;␊ - externalDocs?: ExternalDocumentation;␊ - servers?: Server[];␊ - security?: SecurityRequirement[];␊ - tags?: Tag[];␊ - paths: Paths;␊ - components?: Components;␊ - /**␊ - * This interface was referenced by \`HttpsSpecOpenapisOrgOas30Schema20190402\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - }␊ - export interface Info {␊ - title: string;␊ - description?: string;␊ - termsOfService?: string;␊ - contact?: Contact;␊ - license?: License;␊ - version: string;␊ - /**␊ - * This interface was referenced by \`Info\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - }␊ - export interface Contact {␊ - name?: string;␊ - url?: string;␊ - email?: string;␊ - /**␊ - * This interface was referenced by \`Contact\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - }␊ - export interface License {␊ - name: string;␊ - url?: string;␊ - /**␊ - * This interface was referenced by \`License\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - }␊ - export interface ExternalDocumentation {␊ - description?: string;␊ - url: string;␊ - /**␊ - * This interface was referenced by \`ExternalDocumentation\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - }␊ - export interface Server {␊ - url: string;␊ - description?: string;␊ - variables?: {␊ - [k: string]: ServerVariable;␊ - };␊ - /**␊ - * This interface was referenced by \`Server\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - }␊ - export interface ServerVariable {␊ - enum?: string[];␊ - default: string;␊ - description?: string;␊ - /**␊ - * This interface was referenced by \`ServerVariable\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - }␊ - export interface SecurityRequirement {␊ - [k: string]: string[];␊ - }␊ - export interface Tag {␊ - name: string;␊ - description?: string;␊ - externalDocs?: ExternalDocumentation;␊ - /**␊ - * This interface was referenced by \`Tag\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - }␊ - export interface Paths {}␊ - /**␊ - * This interface was referenced by \`Paths\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^\\/".␊ - */␊ - export interface PathItem {␊ - $ref?: string;␊ - summary?: string;␊ - description?: string;␊ - servers?: Server[];␊ - parameters?: (Parameter | Reference)[];␊ - }␊ - /**␊ - * Example and examples are mutually exclusive␊ - */␊ - export interface ExampleXORExamples {␊ - [k: string]: unknown;␊ - }␊ - export interface Schema {␊ - title?: string;␊ - multipleOf?: number;␊ - maximum?: number;␊ - exclusiveMaximum?: boolean;␊ - minimum?: number;␊ - exclusiveMinimum?: boolean;␊ - maxLength?: number;␊ - minLength?: number;␊ - pattern?: string;␊ - maxItems?: number;␊ - minItems?: number;␊ - uniqueItems?: boolean;␊ - maxProperties?: number;␊ - minProperties?: number;␊ - /**␊ - * @minItems 1␊ - */␊ - required?: [string, ...string[]];␊ - /**␊ - * @minItems 1␊ - */␊ - enum?: [unknown, ...unknown[]];␊ - type?: "array" | "boolean" | "integer" | "number" | "object" | "string";␊ - not?: Schema | Reference;␊ - allOf?: (Schema | Reference)[];␊ - oneOf?: (Schema | Reference)[];␊ - anyOf?: (Schema | Reference)[];␊ - items?: Schema | Reference;␊ - properties?: {␊ - [k: string]: Schema | Reference;␊ - };␊ - additionalProperties?: Schema | Reference | boolean;␊ - description?: string;␊ - format?: string;␊ - default?: unknown;␊ - nullable?: boolean;␊ - discriminator?: Discriminator;␊ - readOnly?: boolean;␊ - writeOnly?: boolean;␊ - example?: unknown;␊ - externalDocs?: ExternalDocumentation;␊ - deprecated?: boolean;␊ - xml?: XML;␊ - /**␊ - * This interface was referenced by \`Schema\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - }␊ - export interface Reference {␊ - /**␊ - * This interface was referenced by \`Reference\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^\\$ref$".␊ - */␊ - [k: string]: string;␊ - }␊ - export interface Discriminator {␊ - propertyName: string;␊ - mapping?: {␊ - [k: string]: string;␊ - };␊ - [k: string]: unknown;␊ - }␊ - export interface XML {␊ - name?: string;␊ - namespace?: string;␊ - prefix?: string;␊ - attribute?: boolean;␊ - wrapped?: boolean;␊ - /**␊ - * This interface was referenced by \`XML\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - }␊ - export interface Example {␊ - summary?: string;␊ - description?: string;␊ - value?: unknown;␊ - externalValue?: string;␊ - /**␊ - * This interface was referenced by \`Example\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - }␊ - export interface Encoding {␊ - contentType?: string;␊ - headers?: {␊ - [k: string]: Header;␊ - };␊ - style?: "form" | "spaceDelimited" | "pipeDelimited" | "deepObject";␊ - explode?: boolean;␊ - allowReserved?: boolean;␊ - }␊ - /**␊ - * This interface was referenced by \`PathItem\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^(get|put|post|delete|options|head|patch|trace)$".␊ - */␊ - export interface Operation {␊ - tags?: string[];␊ - summary?: string;␊ - description?: string;␊ - externalDocs?: ExternalDocumentation;␊ - operationId?: string;␊ - parameters?: (Parameter1 | Reference)[];␊ - requestBody?: RequestBody | Reference;␊ - responses: Responses;␊ - callbacks?: {␊ - [k: string]: Callback | Reference;␊ - };␊ - deprecated?: boolean;␊ - security?: SecurityRequirement[];␊ - servers?: Server[];␊ - /**␊ - * This interface was referenced by \`Operation\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - }␊ - export interface RequestBody {␊ - description?: string;␊ - content: {␊ - [k: string]: MediaType1;␊ - };␊ - required?: boolean;␊ - /**␊ - * This interface was referenced by \`RequestBody\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - }␊ - export interface Responses {␊ - default?: Response | Reference;␊ - }␊ - export interface Response {␊ - description: string;␊ - headers?: {␊ - [k: string]: Header1 | Reference;␊ - };␊ - content?: {␊ - [k: string]: MediaType1;␊ - };␊ - links?: {␊ - [k: string]: Link | Reference;␊ - };␊ - /**␊ - * This interface was referenced by \`Response\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - }␊ - export interface Link {␊ - operationId?: string;␊ - operationRef?: string;␊ - parameters?: {␊ - [k: string]: unknown;␊ - };␊ - requestBody?: unknown;␊ - description?: string;␊ - server?: Server;␊ - /**␊ - * This interface was referenced by \`Link\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - }␊ - export interface Callback {␊ - [k: string]: PathItem;␊ - }␊ - export interface Components {␊ - schemas?: {␊ - /**␊ - * This interface was referenced by \`undefined\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^[a-zA-Z0-9\\.\\-_]+$".␊ - */␊ - [k: string]: Schema | Reference;␊ - };␊ - responses?: {␊ - /**␊ - * This interface was referenced by \`undefined\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^[a-zA-Z0-9\\.\\-_]+$".␊ - */␊ - [k: string]: Reference | Response;␊ - };␊ - parameters?: {␊ - /**␊ - * This interface was referenced by \`undefined\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^[a-zA-Z0-9\\.\\-_]+$".␊ - */␊ - [k: string]: Reference | Parameter1;␊ - };␊ - examples?: {␊ - /**␊ - * This interface was referenced by \`undefined\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^[a-zA-Z0-9\\.\\-_]+$".␊ - */␊ - [k: string]: Reference | Example;␊ - };␊ - requestBodies?: {␊ - /**␊ - * This interface was referenced by \`undefined\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^[a-zA-Z0-9\\.\\-_]+$".␊ - */␊ - [k: string]: Reference | RequestBody;␊ - };␊ - headers?: {␊ - /**␊ - * This interface was referenced by \`undefined\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^[a-zA-Z0-9\\.\\-_]+$".␊ - */␊ - [k: string]: Reference | Header1;␊ - };␊ - securitySchemes?: {␊ - /**␊ - * This interface was referenced by \`undefined\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^[a-zA-Z0-9\\.\\-_]+$".␊ - */␊ - [k: string]: Reference | SecurityScheme;␊ - };␊ - links?: {␊ - /**␊ - * This interface was referenced by \`undefined\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^[a-zA-Z0-9\\.\\-_]+$".␊ - */␊ - [k: string]: Reference | Link;␊ - };␊ - callbacks?: {␊ - /**␊ - * This interface was referenced by \`undefined\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^[a-zA-Z0-9\\.\\-_]+$".␊ - */␊ - [k: string]: Reference | Callback;␊ - };␊ - /**␊ - * This interface was referenced by \`Components\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - }␊ - export interface APIKeySecurityScheme {␊ - type: "apiKey";␊ - name: string;␊ - in: "header" | "query" | "cookie";␊ - description?: string;␊ - /**␊ - * This interface was referenced by \`APIKeySecurityScheme\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - }␊ - export interface OAuth2SecurityScheme {␊ - type: "oauth2";␊ - flows: OAuthFlows;␊ - description?: string;␊ - /**␊ - * This interface was referenced by \`OAuth2SecurityScheme\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - }␊ - export interface OAuthFlows {␊ - implicit?: ImplicitOAuthFlow;␊ - password?: PasswordOAuthFlow;␊ - clientCredentials?: ClientCredentialsFlow;␊ - authorizationCode?: AuthorizationCodeOAuthFlow;␊ - /**␊ - * This interface was referenced by \`OAuthFlows\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - }␊ - export interface ImplicitOAuthFlow {␊ - authorizationUrl: string;␊ - refreshUrl?: string;␊ - scopes: {␊ - [k: string]: string;␊ - };␊ - /**␊ - * This interface was referenced by \`ImplicitOAuthFlow\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - }␊ - export interface PasswordOAuthFlow {␊ - tokenUrl: string;␊ - refreshUrl?: string;␊ - scopes?: {␊ - [k: string]: string;␊ - };␊ - /**␊ - * This interface was referenced by \`PasswordOAuthFlow\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - }␊ - export interface ClientCredentialsFlow {␊ - tokenUrl: string;␊ - refreshUrl?: string;␊ - scopes?: {␊ - [k: string]: string;␊ - };␊ - /**␊ - * This interface was referenced by \`ClientCredentialsFlow\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - }␊ - export interface AuthorizationCodeOAuthFlow {␊ - authorizationUrl: string;␊ - tokenUrl: string;␊ - refreshUrl?: string;␊ - scopes?: {␊ - [k: string]: string;␊ - };␊ - /**␊ - * This interface was referenced by \`AuthorizationCodeOAuthFlow\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - }␊ - export interface OpenIdConnectSecurityScheme {␊ - type: "openIdConnect";␊ - openIdConnectUrl: string;␊ - description?: string;␊ - /**␊ - * This interface was referenced by \`OpenIdConnectSecurityScheme\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^x-".␊ - */␊ - [k: string]: unknown;␊ - }␊ - ` - -## realWorld.payloadCMS.js - -> Expected output to match snapshot for e2e test: realWorld.payloadCMS.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface RealWorld {}␊ - /**␊ - * This interface was referenced by \`RealWorld\`'s JSON-Schema␊ - * via the \`definition\` "mainMenu".␊ - */␊ - export interface MainMenu {␊ - items?: {␊ - type?: "link" | "subMenu";␊ - label: string;␊ - subMenu?: {␊ - column1?: (␊ - | {␊ - appearance?: "primary" | "secondary" | "arrow";␊ - link?: {␊ - type?: "reference" | "custom";␊ - label: string;␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - blockName?: string;␊ - blockType: "menuLink";␊ - }␊ - | {␊ - content: string;␊ - id?: string;␊ - blockName?: string;␊ - blockType: "menuDescription";␊ - }␊ - | {␊ - media: string | Media;␊ - headline: string;␊ - link?: {␊ - type?: "reference" | "custom";␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - blockName?: string;␊ - blockType: "menuFeature";␊ - }␊ - )[];␊ - enableColumn2?: boolean;␊ - column2?: (␊ - | {␊ - appearance?: "primary" | "secondary" | "arrow";␊ - link?: {␊ - type?: "reference" | "custom";␊ - label: string;␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - blockName?: string;␊ - blockType: "menuLink";␊ - }␊ - | {␊ - content: string;␊ - id?: string;␊ - blockName?: string;␊ - blockType: "menuDescription";␊ - }␊ - | {␊ - media: string | Media;␊ - headline: string;␊ - link?: {␊ - type?: "reference" | "custom";␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - blockName?: string;␊ - blockType: "menuFeature";␊ - }␊ - )[];␊ - };␊ - link?: {␊ - type?: "reference" | "custom";␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - }[];␊ - secondaryItems?: {␊ - link?: {␊ - type?: "reference" | "custom";␊ - label: string;␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - }[];␊ - }␊ - /**␊ - * This interface was referenced by \`RealWorld\`'s JSON-Schema␊ - * via the \`definition\` "pages".␊ - */␊ - export interface Page {␊ - breadcrumbs?: {␊ - doc?: string | Page;␊ - url?: string;␊ - label?: string;␊ - id?: string;␊ - }[];␊ - title: string;␊ - showBreadcrumbs?: boolean;␊ - hero?: {␊ - type:␊ - | "basic"␊ - | "content"␊ - | "contentMedia"␊ - | "contentMedia2"␊ - | "contentSidebar"␊ - | "columnsBelow"␊ - | "quickNav"␊ - | "fullscreenBackground"␊ - | "fullscreenSlider";␊ - basic?: {␊ - richText?: {␊ - [k: string]: unknown;␊ - }[];␊ - links?: {␊ - link?: {␊ - appearance?: "text" | "primaryButton" | "secondaryButton";␊ - type?: "reference" | "custom";␊ - label: string;␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - }[];␊ - };␊ - content?: {␊ - richText?: {␊ - [k: string]: unknown;␊ - }[];␊ - links?: {␊ - link?: {␊ - appearance?: "text" | "primaryButton" | "secondaryButton";␊ - type?: "reference" | "custom";␊ - label: string;␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - }[];␊ - };␊ - contentMedia?: {␊ - richText?: {␊ - [k: string]: unknown;␊ - }[];␊ - links?: {␊ - link?: {␊ - appearance?: "text" | "primaryButton" | "secondaryButton";␊ - type?: "reference" | "custom";␊ - label: string;␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - }[];␊ - media: string | Media;␊ - };␊ - contentMedia2?: {␊ - richText?: {␊ - [k: string]: unknown;␊ - }[];␊ - links?: {␊ - link?: {␊ - appearance?: "text" | "primaryButton" | "secondaryButton";␊ - type?: "reference" | "custom";␊ - label: string;␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - }[];␊ - media: string | Media;␊ - };␊ - contentSidebar?: {␊ - mainContent?: {␊ - [k: string]: unknown;␊ - }[];␊ - links?: {␊ - link?: {␊ - appearance?: "text" | "primaryButton" | "secondaryButton";␊ - type?: "reference" | "custom";␊ - label: string;␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - }[];␊ - sidebarContent?: {␊ - [k: string]: unknown;␊ - }[];␊ - };␊ - columnsBelow?: {␊ - backgroundMedia: string | Media;␊ - useOverlay?: boolean;␊ - richText?: {␊ - [k: string]: unknown;␊ - }[];␊ - links?: {␊ - link?: {␊ - appearance?: "text" | "primaryButton" | "secondaryButton";␊ - type?: "reference" | "custom";␊ - label: string;␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - }[];␊ - columns?: {␊ - heading: string;␊ - description: string;␊ - link?: {␊ - type?: "reference" | "custom";␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - }[];␊ - };␊ - fullscreenBackground?: {␊ - invertColors?: boolean;␊ - backgroundMedia: string | Media;␊ - useOverlay?: boolean;␊ - richText?: {␊ - [k: string]: unknown;␊ - }[];␊ - links?: {␊ - link?: {␊ - appearance?: "text" | "primaryButton" | "secondaryButton";␊ - type?: "reference" | "custom";␊ - label: string;␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - }[];␊ - };␊ - quickNav?: {␊ - invertColors?: boolean;␊ - backgroundMedia: string | Media;␊ - useOverlay?: boolean;␊ - richText?: {␊ - [k: string]: unknown;␊ - }[];␊ - links?: {␊ - link?: {␊ - appearance?: "text" | "primaryButton" | "secondaryButton";␊ - type?: "reference" | "custom";␊ - label: string;␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - }[];␊ - columns?: {␊ - heading: string;␊ - description: string;␊ - link?: {␊ - type?: "reference" | "custom";␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - }[];␊ - };␊ - fullscreenSlider?: {␊ - useStaticContent?: boolean;␊ - richText?: {␊ - [k: string]: unknown;␊ - }[];␊ - links?: {␊ - link?: {␊ - appearance?: "text" | "primaryButton" | "secondaryButton";␊ - type?: "reference" | "custom";␊ - label: string;␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - }[];␊ - slides?: {␊ - backgroundMedia: string | Media;␊ - useOverlay?: boolean;␊ - richText?: {␊ - [k: string]: unknown;␊ - }[];␊ - links?: {␊ - link?: {␊ - appearance?: "text" | "primaryButton" | "secondaryButton";␊ - type?: "reference" | "custom";␊ - label: string;␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - }[];␊ - id?: string;␊ - }[];␊ - };␊ - };␊ - layout?: (␊ - | {␊ - appearance?: "default" | "condensed";␊ - sections?: {␊ - label: string;␊ - openOnInit?: boolean;␊ - columns?: {␊ - width: "oneThird" | "half" | "twoThirds" | "full";␊ - alignment: "left" | "center" | "right";␊ - richText?: {␊ - [k: string]: unknown;␊ - }[];␊ - links?: {␊ - link?: {␊ - type?: "reference" | "custom";␊ - label: string;␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - }[];␊ - id?: string;␊ - }[];␊ - id?: string;␊ - }[];␊ - id?: string;␊ - blockName?: string;␊ - blockType: "accordion";␊ - }␊ - | {␊ - introContent?: {␊ - [k: string]: unknown;␊ - }[];␊ - id?: string;␊ - blockName?: string;␊ - blockType: "blackbaudForm";␊ - }␊ - | {␊ - invertColors?: boolean;␊ - backgroundMedia?: string | Media;␊ - useOverlay?: boolean;␊ - richText?: {␊ - [k: string]: unknown;␊ - }[];␊ - links?: {␊ - link?: {␊ - appearance?: "text" | "primaryButton" | "secondaryButton";␊ - type?: "reference" | "custom";␊ - label: string;␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - }[];␊ - id?: string;␊ - blockName?: string;␊ - blockType: "callToAction";␊ - }␊ - | {␊ - introContent?: {␊ - [k: string]: unknown;␊ - }[];␊ - cardStyle: "fullBG" | "insetImage" | "noImage";␊ - cards?: {␊ - richText?: {␊ - [k: string]: unknown;␊ - }[];␊ - link?: {␊ - type?: "reference" | "custom";␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - media?: string | Media;␊ - useOverlay?: boolean;␊ - id?: string;␊ - }[];␊ - id?: string;␊ - blockName?: string;␊ - blockType: "cardGrid";␊ - }␊ - | {␊ - introContent?: {␊ - [k: string]: unknown;␊ - }[];␊ - backgroundType?: "light" | "color";␊ - cardStyle: "fullBG" | "insetImage" | "noImage";␊ - slides?: {␊ - richText?: {␊ - [k: string]: unknown;␊ - }[];␊ - link?: {␊ - type?: "reference" | "custom";␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - media: string | Media;␊ - useOverlay?: boolean;␊ - id?: string;␊ - }[];␊ - id?: string;␊ - blockName?: string;␊ - blockType: "cardSlider";␊ - }␊ - | {␊ - introContent?: {␊ - [k: string]: unknown;␊ - }[];␊ - media1?: string | Media;␊ - media2?: string | Media;␊ - media3?: string | Media;␊ - id?: string;␊ - blockName?: string;␊ - blockType: "careerSearch";␊ - }␊ - | {␊ - enableGrayBackground?: boolean;␊ - columns?: {␊ - width: "oneThird" | "half" | "twoThirds" | "full";␊ - alignment: "left" | "center" | "right";␊ - richText?: {␊ - [k: string]: unknown;␊ - }[];␊ - links?: {␊ - link?: {␊ - type?: "reference" | "custom";␊ - label: string;␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - }[];␊ - id?: string;␊ - }[];␊ - id?: string;␊ - blockName?: string;␊ - blockType: "content";␊ - }␊ - | {␊ - cellWidth?: "two" | "three";␊ - invertColors?: boolean;␊ - enableCellNumbers?: boolean;␊ - introContent?: {␊ - [k: string]: unknown;␊ - }[];␊ - cells?: {␊ - richText?: {␊ - [k: string]: unknown;␊ - }[];␊ - enableLink?: boolean;␊ - link?: {␊ - type?: "reference" | "custom";␊ - label: string;␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - }[];␊ - id?: string;␊ - blockName?: string;␊ - blockType: "contentGrid";␊ - }␊ - | {␊ - introContent?: {␊ - [k: string]: unknown;␊ - }[];␊ - backgroundType?: "light" | "color";␊ - slides?: {␊ - richText?: {␊ - [k: string]: unknown;␊ - }[];␊ - enableLink?: boolean;␊ - link?: {␊ - type?: "reference" | "custom";␊ - label: string;␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - }[];␊ - id?: string;␊ - blockName?: string;␊ - blockType: "contentSlider";␊ - }␊ - | {␊ - introContent?: {␊ - [k: string]: unknown;␊ - }[];␊ - id?: string;␊ - blockName?: string;␊ - blockType: "housingMap";␊ - }␊ - | {␊ - introContent?: {␊ - [k: string]: unknown;␊ - }[];␊ - id?: string;␊ - blockName?: string;␊ - blockType: "housingList";␊ - }␊ - | {␊ - richText?: {␊ - [k: string]: unknown;␊ - }[];␊ - form: string | Form;␊ - id?: string;␊ - blockName?: string;␊ - blockType: "embeddedForm";␊ - }␊ - | {␊ - introContent?: {␊ - [k: string]: unknown;␊ - }[];␊ - locations?: (string | Location)[];␊ - id?: string;␊ - blockName?: string;␊ - blockType: "locations";␊ - }␊ - | {␊ - media: string | Media;␊ - useVimeo?: boolean;␊ - vimeoID: string;␊ - aspectRatio?: "56.25" | "75";␊ - size?: "normal" | "wide" | "fullscreen";␊ - caption?: {␊ - [k: string]: unknown;␊ - }[];␊ - id?: string;␊ - blockName?: string;␊ - blockType: "media";␊ - }␊ - | {␊ - collage?: {␊ - media: string | Media;␊ - id?: string;␊ - }[];␊ - id?: string;␊ - blockName?: string;␊ - blockType: "mediaCollage";␊ - }␊ - | {␊ - alignment: "contentOnLeft" | "contentOnRight";␊ - overlap?: boolean;␊ - invertColors?: boolean;␊ - richText: {␊ - [k: string]: unknown;␊ - }[];␊ - media: string | Media;␊ - embeddedVideo?: {␊ - embed?: boolean;␊ - poster?: string | Media;␊ - platform?: "youtube" | "vimeo";␊ - videoID: string;␊ - aspectRatio?: "56.25" | "75";␊ - };␊ - links?: {␊ - link?: {␊ - appearance?: "text" | "primaryButton" | "secondaryButton";␊ - type?: "reference" | "custom";␊ - label: string;␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - }[];␊ - id?: string;␊ - blockName?: string;␊ - blockType: "mediaContent";␊ - }␊ - | {␊ - introContent?: {␊ - [k: string]: unknown;␊ - }[];␊ - backgroundType?: "light" | "color";␊ - slides?: {␊ - media: string | Media;␊ - id?: string;␊ - }[];␊ - id?: string;␊ - blockName?: string;␊ - blockType: "mediaSlider";␊ - }␊ - | {␊ - items?: {␊ - label: string;␊ - richText?: {␊ - [k: string]: unknown;␊ - }[];␊ - enableLink?: boolean;␊ - link?: {␊ - type?: "reference" | "custom";␊ - label: string;␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - }[];␊ - id?: string;␊ - blockName?: string;␊ - blockType: "stickyList";␊ - }␊ - | {␊ - id?: string;␊ - blockName?: string;␊ - blockType: "divider";␊ - }␊ - )[];␊ - fullTitle?: string;␊ - excerpt?: string;␊ - meta?: {␊ - title?: string;␊ - description?: string;␊ - keywords?: string;␊ - image?: string | Media;␊ - };␊ - status?: "published" | "draft";␊ - slug?: string;␊ - parent?: string | Page;␊ - subsite?: string | Subsite;␊ - color?: "green" | "blue" | "red" | "purple";␊ - author?: string | User;␊ - preview?: string;␊ - }␊ - /**␊ - * This interface was referenced by \`RealWorld\`'s JSON-Schema␊ - * via the \`definition\` "posts".␊ - */␊ - export interface Post {␊ - title: string;␊ - hero?: {␊ - type:␊ - | "basic"␊ - | "content"␊ - | "contentMedia"␊ - | "contentMedia2"␊ - | "contentSidebar"␊ - | "columnsBelow"␊ - | "quickNav"␊ - | "fullscreenBackground"␊ - | "fullscreenSlider";␊ - basic?: {␊ - richText?: {␊ - [k: string]: unknown;␊ - }[];␊ - links?: {␊ - link?: {␊ - appearance?: "text" | "primaryButton" | "secondaryButton";␊ - type?: "reference" | "custom";␊ - label: string;␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - }[];␊ - };␊ - content?: {␊ - richText?: {␊ - [k: string]: unknown;␊ - }[];␊ - links?: {␊ - link?: {␊ - appearance?: "text" | "primaryButton" | "secondaryButton";␊ - type?: "reference" | "custom";␊ - label: string;␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - }[];␊ - };␊ - contentMedia?: {␊ - richText?: {␊ - [k: string]: unknown;␊ - }[];␊ - links?: {␊ - link?: {␊ - appearance?: "text" | "primaryButton" | "secondaryButton";␊ - type?: "reference" | "custom";␊ - label: string;␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - }[];␊ - media: string | Media;␊ - };␊ - contentMedia2?: {␊ - richText?: {␊ - [k: string]: unknown;␊ - }[];␊ - links?: {␊ - link?: {␊ - appearance?: "text" | "primaryButton" | "secondaryButton";␊ - type?: "reference" | "custom";␊ - label: string;␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - }[];␊ - media: string | Media;␊ - };␊ - contentSidebar?: {␊ - mainContent?: {␊ - [k: string]: unknown;␊ - }[];␊ - links?: {␊ - link?: {␊ - appearance?: "text" | "primaryButton" | "secondaryButton";␊ - type?: "reference" | "custom";␊ - label: string;␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - }[];␊ - sidebarContent?: {␊ - [k: string]: unknown;␊ - }[];␊ - };␊ - columnsBelow?: {␊ - backgroundMedia: string | Media;␊ - useOverlay?: boolean;␊ - richText?: {␊ - [k: string]: unknown;␊ - }[];␊ - links?: {␊ - link?: {␊ - appearance?: "text" | "primaryButton" | "secondaryButton";␊ - type?: "reference" | "custom";␊ - label: string;␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - }[];␊ - columns?: {␊ - heading: string;␊ - description: string;␊ - link?: {␊ - type?: "reference" | "custom";␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - }[];␊ - };␊ - fullscreenBackground?: {␊ - invertColors?: boolean;␊ - backgroundMedia: string | Media;␊ - useOverlay?: boolean;␊ - richText?: {␊ - [k: string]: unknown;␊ - }[];␊ - links?: {␊ - link?: {␊ - appearance?: "text" | "primaryButton" | "secondaryButton";␊ - type?: "reference" | "custom";␊ - label: string;␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - }[];␊ - };␊ - quickNav?: {␊ - invertColors?: boolean;␊ - backgroundMedia: string | Media;␊ - useOverlay?: boolean;␊ - richText?: {␊ - [k: string]: unknown;␊ - }[];␊ - links?: {␊ - link?: {␊ - appearance?: "text" | "primaryButton" | "secondaryButton";␊ - type?: "reference" | "custom";␊ - label: string;␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - }[];␊ - columns?: {␊ - heading: string;␊ - description: string;␊ - link?: {␊ - type?: "reference" | "custom";␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - }[];␊ - };␊ - fullscreenSlider?: {␊ - useStaticContent?: boolean;␊ - richText?: {␊ - [k: string]: unknown;␊ - }[];␊ - links?: {␊ - link?: {␊ - appearance?: "text" | "primaryButton" | "secondaryButton";␊ - type?: "reference" | "custom";␊ - label: string;␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - }[];␊ - slides?: {␊ - backgroundMedia: string | Media;␊ - useOverlay?: boolean;␊ - richText?: {␊ - [k: string]: unknown;␊ - }[];␊ - links?: {␊ - link?: {␊ - appearance?: "text" | "primaryButton" | "secondaryButton";␊ - type?: "reference" | "custom";␊ - label: string;␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - }[];␊ - id?: string;␊ - }[];␊ - };␊ - };␊ - layout?: (␊ - | {␊ - appearance?: "default" | "condensed";␊ - sections?: {␊ - label: string;␊ - openOnInit?: boolean;␊ - columns?: {␊ - width: "oneThird" | "half" | "twoThirds" | "full";␊ - alignment: "left" | "center" | "right";␊ - richText?: {␊ - [k: string]: unknown;␊ - }[];␊ - links?: {␊ - link?: {␊ - type?: "reference" | "custom";␊ - label: string;␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - }[];␊ - id?: string;␊ - }[];␊ - id?: string;␊ - }[];␊ - id?: string;␊ - blockName?: string;␊ - blockType: "accordion";␊ - }␊ - | {␊ - introContent?: {␊ - [k: string]: unknown;␊ - }[];␊ - id?: string;␊ - blockName?: string;␊ - blockType: "blackbaudForm";␊ - }␊ - | {␊ - invertColors?: boolean;␊ - backgroundMedia?: string | Media;␊ - useOverlay?: boolean;␊ - richText?: {␊ - [k: string]: unknown;␊ - }[];␊ - links?: {␊ - link?: {␊ - appearance?: "text" | "primaryButton" | "secondaryButton";␊ - type?: "reference" | "custom";␊ - label: string;␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - }[];␊ - id?: string;␊ - blockName?: string;␊ - blockType: "callToAction";␊ - }␊ - | {␊ - introContent?: {␊ - [k: string]: unknown;␊ - }[];␊ - cardStyle: "fullBG" | "insetImage" | "noImage";␊ - cards?: {␊ - richText?: {␊ - [k: string]: unknown;␊ - }[];␊ - link?: {␊ - type?: "reference" | "custom";␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - media?: string | Media;␊ - useOverlay?: boolean;␊ - id?: string;␊ - }[];␊ - id?: string;␊ - blockName?: string;␊ - blockType: "cardGrid";␊ - }␊ - | {␊ - introContent?: {␊ - [k: string]: unknown;␊ - }[];␊ - backgroundType?: "light" | "color";␊ - cardStyle: "fullBG" | "insetImage" | "noImage";␊ - slides?: {␊ - richText?: {␊ - [k: string]: unknown;␊ - }[];␊ - link?: {␊ - type?: "reference" | "custom";␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - media: string | Media;␊ - useOverlay?: boolean;␊ - id?: string;␊ - }[];␊ - id?: string;␊ - blockName?: string;␊ - blockType: "cardSlider";␊ - }␊ - | {␊ - introContent?: {␊ - [k: string]: unknown;␊ - }[];␊ - media1?: string | Media;␊ - media2?: string | Media;␊ - media3?: string | Media;␊ - id?: string;␊ - blockName?: string;␊ - blockType: "careerSearch";␊ - }␊ - | {␊ - enableGrayBackground?: boolean;␊ - columns?: {␊ - width: "oneThird" | "half" | "twoThirds" | "full";␊ - alignment: "left" | "center" | "right";␊ - richText?: {␊ - [k: string]: unknown;␊ - }[];␊ - links?: {␊ - link?: {␊ - type?: "reference" | "custom";␊ - label: string;␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - }[];␊ - id?: string;␊ - }[];␊ - id?: string;␊ - blockName?: string;␊ - blockType: "content";␊ - }␊ - | {␊ - cellWidth?: "two" | "three";␊ - invertColors?: boolean;␊ - enableCellNumbers?: boolean;␊ - introContent?: {␊ - [k: string]: unknown;␊ - }[];␊ - cells?: {␊ - richText?: {␊ - [k: string]: unknown;␊ - }[];␊ - enableLink?: boolean;␊ - link?: {␊ - type?: "reference" | "custom";␊ - label: string;␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - }[];␊ - id?: string;␊ - blockName?: string;␊ - blockType: "contentGrid";␊ - }␊ - | {␊ - introContent?: {␊ - [k: string]: unknown;␊ - }[];␊ - backgroundType?: "light" | "color";␊ - slides?: {␊ - richText?: {␊ - [k: string]: unknown;␊ - }[];␊ - enableLink?: boolean;␊ - link?: {␊ - type?: "reference" | "custom";␊ - label: string;␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - }[];␊ - id?: string;␊ - blockName?: string;␊ - blockType: "contentSlider";␊ - }␊ - | {␊ - richText?: {␊ - [k: string]: unknown;␊ - }[];␊ - form: string | Form;␊ - id?: string;␊ - blockName?: string;␊ - blockType: "embeddedForm";␊ - }␊ - | {␊ - introContent?: {␊ - [k: string]: unknown;␊ - }[];␊ - id?: string;␊ - blockName?: string;␊ - blockType: "housingMap";␊ - }␊ - | {␊ - introContent?: {␊ - [k: string]: unknown;␊ - }[];␊ - id?: string;␊ - blockName?: string;␊ - blockType: "housingList";␊ - }␊ - | {␊ - introContent?: {␊ - [k: string]: unknown;␊ - }[];␊ - locations?: (string | Location)[];␊ - id?: string;␊ - blockName?: string;␊ - blockType: "locations";␊ - }␊ - | {␊ - media: string | Media;␊ - useVimeo?: boolean;␊ - vimeoID: string;␊ - aspectRatio?: "56.25" | "75";␊ - size?: "normal" | "wide" | "fullscreen";␊ - caption?: {␊ - [k: string]: unknown;␊ - }[];␊ - id?: string;␊ - blockName?: string;␊ - blockType: "media";␊ - }␊ - | {␊ - collage?: {␊ - media: string | Media;␊ - id?: string;␊ - }[];␊ - id?: string;␊ - blockName?: string;␊ - blockType: "mediaCollage";␊ - }␊ - | {␊ - alignment: "contentOnLeft" | "contentOnRight";␊ - overlap?: boolean;␊ - invertColors?: boolean;␊ - richText: {␊ - [k: string]: unknown;␊ - }[];␊ - media: string | Media;␊ - embeddedVideo?: {␊ - embed?: boolean;␊ - poster?: string | Media;␊ - platform?: "youtube" | "vimeo";␊ - videoID: string;␊ - aspectRatio?: "56.25" | "75";␊ - };␊ - links?: {␊ - link?: {␊ - appearance?: "text" | "primaryButton" | "secondaryButton";␊ - type?: "reference" | "custom";␊ - label: string;␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - }[];␊ - id?: string;␊ - blockName?: string;␊ - blockType: "mediaContent";␊ - }␊ - | {␊ - introContent?: {␊ - [k: string]: unknown;␊ - }[];␊ - backgroundType?: "light" | "color";␊ - slides?: {␊ - media: string | Media;␊ - id?: string;␊ - }[];␊ - id?: string;␊ - blockName?: string;␊ - blockType: "mediaSlider";␊ - }␊ - | {␊ - items?: {␊ - label: string;␊ - richText?: {␊ - [k: string]: unknown;␊ - }[];␊ - enableLink?: boolean;␊ - link?: {␊ - type?: "reference" | "custom";␊ - label: string;␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - }[];␊ - id?: string;␊ - blockName?: string;␊ - blockType: "stickyList";␊ - }␊ - | {␊ - id?: string;␊ - blockName?: string;␊ - blockType: "divider";␊ - }␊ - )[];␊ - slug?: string;␊ - category: string | PostCategory;␊ - subsite?: string | Subsite;␊ - meta?: {␊ - title?: string;␊ - description?: string;␊ - keywords?: string;␊ - image?: string | Media;␊ - };␊ - }␊ - /**␊ - * This interface was referenced by \`RealWorld\`'s JSON-Schema␊ - * via the \`definition\` "housing".␊ - */␊ - export interface Housing {␊ - title: string;␊ - address?: {␊ - line1?: string;␊ - line2?: string;␊ - city?: string;␊ - state?:␊ - | "None"␊ - | "Alabama"␊ - | "Alaska"␊ - | "Arizona"␊ - | "Arkansas"␊ - | "California"␊ - | "Colorado"␊ - | "Connecticut"␊ - | "Delaware"␊ - | "Florida"␊ - | "Georgia"␊ - | "Hawaii"␊ - | "Idaho"␊ - | "Illinois"␊ - | "Indiana"␊ - | "Iowa"␊ - | "Kansas"␊ - | "Kentucky"␊ - | "Louisiana"␊ - | "Maine"␊ - | "Maryland"␊ - | "Massachusetts"␊ - | "Michigan"␊ - | "Minnesota"␊ - | "Mississippi"␊ - | "Missouri"␊ - | "Montana"␊ - | "Nebraska"␊ - | "Nevada"␊ - | "New Hampshire"␊ - | "New Jersey"␊ - | "New Mexico"␊ - | "New York"␊ - | "North Carolina"␊ - | "North Dakota"␊ - | "Ohio"␊ - | "Oklahoma"␊ - | "Oregon"␊ - | "Pennsylvania"␊ - | "Rhode Island"␊ - | "South Carolina"␊ - | "South Dakota"␊ - | "Tennessee"␊ - | "Texas"␊ - | "Utah"␊ - | "Vermont"␊ - | "Virginia"␊ - | "Washington"␊ - | "West Virginia"␊ - | "Wisconsin"␊ - | "Wyoming";␊ - zip?: string;␊ - coords?: {␊ - lat?: number;␊ - lng?: number;␊ - };␊ - };␊ - contacts?: {␊ - type?: "mailto" | "tel" | "fax";␊ - label?: string;␊ - value?: string;␊ - id?: string;␊ - }[];␊ - layout?: (␊ - | {␊ - appearance?: "default" | "condensed";␊ - sections?: {␊ - label: string;␊ - openOnInit?: boolean;␊ - columns?: {␊ - width: "oneThird" | "half" | "twoThirds" | "full";␊ - alignment: "left" | "center" | "right";␊ - richText?: {␊ - [k: string]: unknown;␊ - }[];␊ - links?: {␊ - link?: {␊ - type?: "reference" | "custom";␊ - label: string;␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - }[];␊ - id?: string;␊ - }[];␊ - id?: string;␊ - }[];␊ - id?: string;␊ - blockName?: string;␊ - blockType: "accordion";␊ - }␊ - | {␊ - invertColors?: boolean;␊ - backgroundMedia?: string | Media;␊ - useOverlay?: boolean;␊ - richText?: {␊ - [k: string]: unknown;␊ - }[];␊ - links?: {␊ - link?: {␊ - appearance?: "text" | "primaryButton" | "secondaryButton";␊ - type?: "reference" | "custom";␊ - label: string;␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - }[];␊ - id?: string;␊ - blockName?: string;␊ - blockType: "callToAction";␊ - }␊ - | {␊ - introContent?: {␊ - [k: string]: unknown;␊ - }[];␊ - cardStyle: "fullBG" | "insetImage" | "noImage";␊ - cards?: {␊ - richText?: {␊ - [k: string]: unknown;␊ - }[];␊ - link?: {␊ - type?: "reference" | "custom";␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - media?: string | Media;␊ - useOverlay?: boolean;␊ - id?: string;␊ - }[];␊ - id?: string;␊ - blockName?: string;␊ - blockType: "cardGrid";␊ - }␊ - | {␊ - introContent?: {␊ - [k: string]: unknown;␊ - }[];␊ - backgroundType?: "light" | "color";␊ - cardStyle: "fullBG" | "insetImage" | "noImage";␊ - slides?: {␊ - richText?: {␊ - [k: string]: unknown;␊ - }[];␊ - link?: {␊ - type?: "reference" | "custom";␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - media: string | Media;␊ - useOverlay?: boolean;␊ - id?: string;␊ - }[];␊ - id?: string;␊ - blockName?: string;␊ - blockType: "cardSlider";␊ - }␊ - | {␊ - introContent?: {␊ - [k: string]: unknown;␊ - }[];␊ - media1?: string | Media;␊ - media2?: string | Media;␊ - media3?: string | Media;␊ - id?: string;␊ - blockName?: string;␊ - blockType: "careerSearch";␊ - }␊ - | {␊ - enableGrayBackground?: boolean;␊ - columns?: {␊ - width: "oneThird" | "half" | "twoThirds" | "full";␊ - alignment: "left" | "center" | "right";␊ - richText?: {␊ - [k: string]: unknown;␊ - }[];␊ - links?: {␊ - link?: {␊ - type?: "reference" | "custom";␊ - label: string;␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - }[];␊ - id?: string;␊ - }[];␊ - id?: string;␊ - blockName?: string;␊ - blockType: "content";␊ - }␊ - | {␊ - cellWidth?: "two" | "three";␊ - invertColors?: boolean;␊ - enableCellNumbers?: boolean;␊ - introContent?: {␊ - [k: string]: unknown;␊ - }[];␊ - cells?: {␊ - richText?: {␊ - [k: string]: unknown;␊ - }[];␊ - enableLink?: boolean;␊ - link?: {␊ - type?: "reference" | "custom";␊ - label: string;␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - }[];␊ - id?: string;␊ - blockName?: string;␊ - blockType: "contentGrid";␊ - }␊ - | {␊ - introContent?: {␊ - [k: string]: unknown;␊ - }[];␊ - backgroundType?: "light" | "color";␊ - slides?: {␊ - richText?: {␊ - [k: string]: unknown;␊ - }[];␊ - enableLink?: boolean;␊ - link?: {␊ - type?: "reference" | "custom";␊ - label: string;␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - }[];␊ - id?: string;␊ - blockName?: string;␊ - blockType: "contentSlider";␊ - }␊ - | {␊ - richText?: {␊ - [k: string]: unknown;␊ - }[];␊ - form: string | Form;␊ - id?: string;␊ - blockName?: string;␊ - blockType: "embeddedForm";␊ - }␊ - | {␊ - introContent?: {␊ - [k: string]: unknown;␊ - }[];␊ - locations?: (string | Location)[];␊ - id?: string;␊ - blockName?: string;␊ - blockType: "locations";␊ - }␊ - | {␊ - media: string | Media;␊ - useVimeo?: boolean;␊ - vimeoID: string;␊ - aspectRatio?: "56.25" | "75";␊ - size?: "normal" | "wide" | "fullscreen";␊ - caption?: {␊ - [k: string]: unknown;␊ - }[];␊ - id?: string;␊ - blockName?: string;␊ - blockType: "media";␊ - }␊ - | {␊ - collage?: {␊ - media: string | Media;␊ - id?: string;␊ - }[];␊ - id?: string;␊ - blockName?: string;␊ - blockType: "mediaCollage";␊ - }␊ - | {␊ - alignment: "contentOnLeft" | "contentOnRight";␊ - overlap?: boolean;␊ - invertColors?: boolean;␊ - richText: {␊ - [k: string]: unknown;␊ - }[];␊ - media: string | Media;␊ - embeddedVideo?: {␊ - embed?: boolean;␊ - poster?: string | Media;␊ - platform?: "youtube" | "vimeo";␊ - videoID: string;␊ - aspectRatio?: "56.25" | "75";␊ - };␊ - links?: {␊ - link?: {␊ - appearance?: "text" | "primaryButton" | "secondaryButton";␊ - type?: "reference" | "custom";␊ - label: string;␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - }[];␊ - id?: string;␊ - blockName?: string;␊ - blockType: "mediaContent";␊ - }␊ - | {␊ - introContent?: {␊ - [k: string]: unknown;␊ - }[];␊ - backgroundType?: "light" | "color";␊ - slides?: {␊ - media: string | Media;␊ - id?: string;␊ - }[];␊ - id?: string;␊ - blockName?: string;␊ - blockType: "mediaSlider";␊ - }␊ - | {␊ - items?: {␊ - label: string;␊ - richText?: {␊ - [k: string]: unknown;␊ - }[];␊ - enableLink?: boolean;␊ - link?: {␊ - type?: "reference" | "custom";␊ - label: string;␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - }[];␊ - id?: string;␊ - blockName?: string;␊ - blockType: "stickyList";␊ - }␊ - )[];␊ - meta?: {␊ - title?: string;␊ - description?: string;␊ - keywords?: string;␊ - image?: string | Media;␊ - };␊ - slug?: string;␊ - categories?: (string | HousingCategory)[];␊ - subsite?: string | Subsite;␊ - }␊ - /**␊ - * This interface was referenced by \`RealWorld\`'s JSON-Schema␊ - * via the \`definition\` "media".␊ - */␊ - export interface Media {␊ - url?: string;␊ - filename?: string;␊ - mimeType?: string;␊ - filesize?: number;␊ - width?: number;␊ - height?: number;␊ - sizes?: {␊ - thumbnail?: {␊ - url?: string;␊ - width?: number;␊ - height?: number;␊ - mimeType?: string;␊ - filesize?: number;␊ - filename?: string;␊ - };␊ - card?: {␊ - url?: string;␊ - width?: number;␊ - height?: number;␊ - mimeType?: string;␊ - filesize?: number;␊ - filename?: string;␊ - };␊ - portrait?: {␊ - url?: string;␊ - width?: number;␊ - height?: number;␊ - mimeType?: string;␊ - filesize?: number;␊ - filename?: string;␊ - };␊ - square?: {␊ - url?: string;␊ - width?: number;␊ - height?: number;␊ - mimeType?: string;␊ - filesize?: number;␊ - filename?: string;␊ - };␊ - feature?: {␊ - url?: string;␊ - width?: number;␊ - height?: number;␊ - mimeType?: string;␊ - filesize?: number;␊ - filename?: string;␊ - };␊ - meta?: {␊ - url?: string;␊ - width?: number;␊ - height?: number;␊ - mimeType?: string;␊ - filesize?: number;␊ - filename?: string;␊ - };␊ - hero?: {␊ - url?: string;␊ - width?: number;␊ - height?: number;␊ - mimeType?: string;␊ - filesize?: number;␊ - filename?: string;␊ - };␊ - };␊ - alt: string;␊ - fallback?: string | Media;␊ - }␊ - /**␊ - * This interface was referenced by \`RealWorld\`'s JSON-Schema␊ - * via the \`definition\` "forms".␊ - */␊ - export interface Form {␊ - title: string;␊ - emailTo?: string;␊ - successMessage?: {␊ - [k: string]: unknown;␊ - }[];␊ - redirect?: string;␊ - submitButtonLabel?: string;␊ - fields?: (␊ - | {␊ - name: string;␊ - label: string;␊ - width?: number;␊ - defaultValue?: string;␊ - required?: boolean;␊ - id?: string;␊ - blockName?: string;␊ - blockType: "text";␊ - }␊ - | {␊ - name: string;␊ - label: string;␊ - width?: number;␊ - defaultValue?: string;␊ - options?: {␊ - label: string;␊ - value: string;␊ - id?: string;␊ - }[];␊ - required?: boolean;␊ - id?: string;␊ - blockName?: string;␊ - blockType: "select";␊ - }␊ - | {␊ - name: string;␊ - label: string;␊ - width?: number;␊ - required?: boolean;␊ - id?: string;␊ - blockName?: string;␊ - blockType: "email";␊ - }␊ - | {␊ - name: string;␊ - label: string;␊ - width?: number;␊ - required?: boolean;␊ - id?: string;␊ - blockName?: string;␊ - blockType: "state";␊ - }␊ - | {␊ - name: string;␊ - label: string;␊ - width?: number;␊ - required?: boolean;␊ - id?: string;␊ - blockName?: string;␊ - blockType: "country";␊ - }␊ - | {␊ - name: string;␊ - label: string;␊ - width?: number;␊ - required?: boolean;␊ - defaultValue?: boolean;␊ - id?: string;␊ - blockName?: string;␊ - blockType: "checkbox";␊ - }␊ - | {␊ - message?: {␊ - [k: string]: unknown;␊ - }[];␊ - id?: string;␊ - blockName?: string;␊ - blockType: "message";␊ - }␊ - )[];␊ - }␊ - /**␊ - * This interface was referenced by \`RealWorld\`'s JSON-Schema␊ - * via the \`definition\` "locations".␊ - */␊ - export interface Location {␊ - name: string;␊ - address?: {␊ - line1?: string;␊ - line2?: string;␊ - city?: string;␊ - state?:␊ - | "None"␊ - | "Alabama"␊ - | "Alaska"␊ - | "Arizona"␊ - | "Arkansas"␊ - | "California"␊ - | "Colorado"␊ - | "Connecticut"␊ - | "Delaware"␊ - | "Florida"␊ - | "Georgia"␊ - | "Hawaii"␊ - | "Idaho"␊ - | "Illinois"␊ - | "Indiana"␊ - | "Iowa"␊ - | "Kansas"␊ - | "Kentucky"␊ - | "Louisiana"␊ - | "Maine"␊ - | "Maryland"␊ - | "Massachusetts"␊ - | "Michigan"␊ - | "Minnesota"␊ - | "Mississippi"␊ - | "Missouri"␊ - | "Montana"␊ - | "Nebraska"␊ - | "Nevada"␊ - | "New Hampshire"␊ - | "New Jersey"␊ - | "New Mexico"␊ - | "New York"␊ - | "North Carolina"␊ - | "North Dakota"␊ - | "Ohio"␊ - | "Oklahoma"␊ - | "Oregon"␊ - | "Pennsylvania"␊ - | "Rhode Island"␊ - | "South Carolina"␊ - | "South Dakota"␊ - | "Tennessee"␊ - | "Texas"␊ - | "Utah"␊ - | "Vermont"␊ - | "Virginia"␊ - | "Washington"␊ - | "West Virginia"␊ - | "Wisconsin"␊ - | "Wyoming";␊ - zip?: string;␊ - coords?: {␊ - lat?: number;␊ - lng?: number;␊ - };␊ - };␊ - contacts?: {␊ - type?: "mailto" | "tel" | "fax";␊ - label?: string;␊ - value?: string;␊ - id?: string;␊ - }[];␊ - meta?: {␊ - title?: string;␊ - description?: string;␊ - keywords?: string;␊ - image?: string | Media;␊ - };␊ - }␊ - /**␊ - * This interface was referenced by \`RealWorld\`'s JSON-Schema␊ - * via the \`definition\` "housing-categories".␊ - */␊ - export interface HousingCategory {␊ - title: string;␊ - slug?: string;␊ - }␊ - /**␊ - * This interface was referenced by \`RealWorld\`'s JSON-Schema␊ - * via the \`definition\` "subsites".␊ - */␊ - export interface Subsite {␊ - title: string;␊ - menuItems?: {␊ - type?: "link" | "subMenu";␊ - link?: {␊ - type?: "reference" | "custom";␊ - label: string;␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - label: string;␊ - subMenu?: {␊ - column1?: (␊ - | {␊ - appearance?: "primary" | "secondary" | "arrow";␊ - link?: {␊ - type?: "reference" | "custom";␊ - label: string;␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - blockName?: string;␊ - blockType: "menuLink";␊ - }␊ - | {␊ - content: string;␊ - id?: string;␊ - blockName?: string;␊ - blockType: "menuDescription";␊ - }␊ - | {␊ - media: string | Media;␊ - headline: string;␊ - link?: {␊ - type?: "reference" | "custom";␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - blockName?: string;␊ - blockType: "menuFeature";␊ - }␊ - )[];␊ - enableColumn2?: boolean;␊ - column2?: (␊ - | {␊ - appearance?: "primary" | "secondary" | "arrow";␊ - link?: {␊ - type?: "reference" | "custom";␊ - label: string;␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - blockName?: string;␊ - blockType: "menuLink";␊ - }␊ - | {␊ - content: string;␊ - id?: string;␊ - blockName?: string;␊ - blockType: "menuDescription";␊ - }␊ - | {␊ - media: string | Media;␊ - headline: string;␊ - link?: {␊ - type?: "reference" | "custom";␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - blockName?: string;␊ - blockType: "menuFeature";␊ - }␊ - )[];␊ - enableColumn3?: boolean;␊ - column3?: (␊ - | {␊ - appearance?: "primary" | "secondary" | "arrow";␊ - link?: {␊ - type?: "reference" | "custom";␊ - label: string;␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - blockName?: string;␊ - blockType: "menuLink";␊ - }␊ - | {␊ - content: string;␊ - id?: string;␊ - blockName?: string;␊ - blockType: "menuDescription";␊ - }␊ - | {␊ - media: string | Media;␊ - headline: string;␊ - link?: {␊ - type?: "reference" | "custom";␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - blockName?: string;␊ - blockType: "menuFeature";␊ - }␊ - )[];␊ - };␊ - id?: string;␊ - }[];␊ - slug?: string;␊ - color?: "green" | "blue" | "red" | "purple";␊ - home: string | Page;␊ - }␊ - /**␊ - * This interface was referenced by \`RealWorld\`'s JSON-Schema␊ - * via the \`definition\` "post-categories".␊ - */␊ - export interface PostCategory {␊ - title: string;␊ - color?: "green" | "blue" | "red" | "purple";␊ - slug?: string;␊ - subsite?: string | Subsite;␊ - }␊ - /**␊ - * This interface was referenced by \`RealWorld\`'s JSON-Schema␊ - * via the \`definition\` "users".␊ - */␊ - export interface User {␊ - email?: string;␊ - resetPasswordToken?: string;␊ - resetPasswordExpiration?: string;␊ - loginAttempts?: number;␊ - lockUntil?: string;␊ - }␊ - /**␊ - * This interface was referenced by \`RealWorld\`'s JSON-Schema␊ - * via the \`definition\` "footer".␊ - */␊ - export interface Footer {␊ - column1?: {␊ - appearance?: "primary" | "secondary" | "tertiary";␊ - label?: string;␊ - useLink?: boolean;␊ - link?: {␊ - type?: "reference" | "custom";␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - }[];␊ - column2?: {␊ - appearance?: "secondary" | "tertiary";␊ - label?: string;␊ - useLink?: boolean;␊ - link?: {␊ - type?: "reference" | "custom";␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - }[];␊ - }␊ - /**␊ - * This interface was referenced by \`RealWorld\`'s JSON-Schema␊ - * via the \`definition\` "meta".␊ - */␊ - export interface Meta {␊ - socialMediaLinks?: {␊ - type: "facebook" | "vimeo" | "twitter" | "linkedin" | "instagram";␊ - url: string;␊ - id?: string;␊ - }[];␊ - legalLinks?: {␊ - link?: {␊ - type?: "reference" | "custom";␊ - label: string;␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - }[];␊ - locations?: (string | Location)[];␊ - phone?: string;␊ - nationalPhone?: string;␊ - fax?: string;␊ - popularSearchTerms?: {␊ - term: string;␊ - id?: string;␊ - }[];␊ - }␊ - /**␊ - * This interface was referenced by \`RealWorld\`'s JSON-Schema␊ - * via the \`definition\` "alerts".␊ - */␊ - export interface Alert {␊ - placement: "global" | "subsite";␊ - subsites: (string | Subsite)[];␊ - backgroundColor?: "matchTheme" | "green" | "blue" | "red" | "purple";␊ - content: {␊ - [k: string]: unknown;␊ - }[];␊ - links?: {␊ - link?: {␊ - appearance?: "text" | "primaryButton" | "secondaryButton";␊ - type?: "reference" | "custom";␊ - label: string;␊ - reference:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - };␊ - url: string;␊ - };␊ - id?: string;␊ - }[];␊ - }␊ - /**␊ - * This interface was referenced by \`RealWorld\`'s JSON-Schema␊ - * via the \`definition\` "search".␊ - */␊ - export interface SearchResult {␊ - title: string;␊ - description?: string;␊ - keywords?: string;␊ - slug: string;␊ - media?: string | Media;␊ - doc:␊ - | {␊ - value: string | Page;␊ - relationTo: "pages";␊ - }␊ - | {␊ - value: string | Post;␊ - relationTo: "posts";␊ - }␊ - | {␊ - value: string | Housing;␊ - relationTo: "housing";␊ - }␊ - | {␊ - value: string | Person;␊ - relationTo: "people";␊ - }␊ - | {␊ - value: string | Location;␊ - relationTo: "locations";␊ - };␊ - }␊ - /**␊ - * This interface was referenced by \`RealWorld\`'s JSON-Schema␊ - * via the \`definition\` "people".␊ - */␊ - export interface Person {␊ - name: string;␊ - position?: string;␊ - contacts?: {␊ - type?: "mailto" | "tel" | "fax";␊ - label?: string;␊ - value?: string;␊ - id?: string;␊ - }[];␊ - socialMediaLinks?: {␊ - type: "facebook" | "vimeo" | "twitter" | "linkedin" | "instagram";␊ - url: string;␊ - id?: string;␊ - }[];␊ - richText?: {␊ - [k: string]: unknown;␊ - }[];␊ - meta?: {␊ - title?: string;␊ - description?: string;␊ - keywords?: string;␊ - image?: string | Media;␊ - };␊ - slug?: string;␊ - home?: string | Page;␊ - }␊ - /**␊ - * This interface was referenced by \`RealWorld\`'s JSON-Schema␊ - * via the \`definition\` "form-submissions".␊ - */␊ - export interface FormSubmission {␊ - form: string | Form;␊ - submissionData?: {␊ - field: string;␊ - value: string;␊ - id?: string;␊ - }[];␊ - }␊ - ` - -## realWorld.schemaStore.1.js - -> Expected output to match snapshot for e2e test: realWorld.schemaStore.1.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export type JSONSchemaForNPMPackageJsonFiles = JSONSchemaForNPMPackageJsonFiles1 & JSONSchemaForNPMPackageJsonFiles2;␊ - export type JSONSchemaForNPMPackageJsonFiles1 = {␊ - [k: string]: unknown;␊ - };␊ - /**␊ - * A person who has been involved in creating or maintaining this package.␊ - */␊ - export type Person = {␊ - name: string;␊ - url?: string;␊ - email?: string;␊ - [k: string]: unknown;␊ - } & Person1;␊ - export type Person1 =␊ - | {␊ - name: string;␊ - url?: string;␊ - email?: string;␊ - [k: string]: unknown;␊ - }␊ - | string;␊ - export type PackageExportsEntry = PackageExportsEntryPath | PackageExportsEntryObject;␊ - /**␊ - * The module path that is resolved when this specifier is imported. Set to \`null\` to disallow importing this module.␊ - */␊ - export type PackageExportsEntryPath = string | null;␊ - /**␊ - * Used to allow fallbacks in case this environment doesn't support the preceding entries.␊ - */␊ - export type PackageExportsFallback = PackageExportsEntry[];␊ - /**␊ - * Used to allow fallbacks in case this environment doesn't support the preceding entries.␊ - */␊ - export type PackageExportsFallback1 = PackageExportsEntry[];␊ - /**␊ - * Run AFTER the package is published.␊ - */␊ - export type ScriptsPublishAfter = string;␊ - /**␊ - * Run AFTER the package is installed.␊ - */␊ - export type ScriptsInstallAfter = string;␊ - /**␊ - * Run BEFORE the package is uninstalled.␊ - */␊ - export type ScriptsUninstallBefore = string;␊ - /**␊ - * Run BEFORE bump the package version.␊ - */␊ - export type ScriptsVersionBefore = string;␊ - /**␊ - * Run by the 'npm test' command.␊ - */␊ - export type ScriptsTest = string;␊ - /**␊ - * Run by the 'npm stop' command.␊ - */␊ - export type ScriptsStop = string;␊ - /**␊ - * Run by the 'npm start' command.␊ - */␊ - export type ScriptsStart = string;␊ - /**␊ - * Run by the 'npm restart' command. Note: 'npm restart' will run the stop and start scripts if no restart script is provided.␊ - */␊ - export type ScriptsRestart = string;␊ - ␊ - export interface JSONSchemaForNPMPackageJsonFiles2 {␊ - /**␊ - * The name of the package.␊ - */␊ - name?: string;␊ - /**␊ - * Version must be parseable by node-semver, which is bundled with npm as a dependency.␊ - */␊ - version?: string;␊ - /**␊ - * This helps people discover your package, as it's listed in 'npm search'.␊ - */␊ - description?: string;␊ - /**␊ - * This helps people discover your package as it's listed in 'npm search'.␊ - */␊ - keywords?: string[];␊ - /**␊ - * The url to the project homepage.␊ - */␊ - homepage?: string;␊ - /**␊ - * The url to your project's issue tracker and / or the email address to which issues should be reported. These are helpful for people who encounter issues with your package.␊ - */␊ - bugs?:␊ - | {␊ - /**␊ - * The url to your project's issue tracker.␊ - */␊ - url?: string;␊ - /**␊ - * The email address to which issues should be reported.␊ - */␊ - email?: string;␊ - [k: string]: unknown;␊ - }␊ - | string;␊ - /**␊ - * You should specify a license for your package so that people know how they are permitted to use it, and any restrictions you're placing on it.␊ - */␊ - license?: string;␊ - /**␊ - * DEPRECATED: Instead, use SPDX expressions, like this: { "license": "ISC" } or { "license": "(MIT OR Apache-2.0)" } see: 'https://docs.npmjs.com/files/package.json#license'.␊ - */␊ - licenses?: {␊ - type?: string;␊ - url?: string;␊ - [k: string]: unknown;␊ - }[];␊ - author?: Person;␊ - /**␊ - * A list of people who contributed to this package.␊ - */␊ - contributors?: Person1[];␊ - /**␊ - * A list of people who maintains this package.␊ - */␊ - maintainers?: Person1[];␊ - /**␊ - * The 'files' field is an array of files to include in your project. If you name a folder in the array, then it will also include the files inside that folder.␊ - */␊ - files?: string[];␊ - /**␊ - * The main field is a module ID that is the primary entry point to your program.␊ - */␊ - main?: string;␊ - /**␊ - * The "exports" field is used to restrict external access to non-exported module files, also enables a module to import itself using "name".␊ - */␊ - exports?:␊ - | (string | null)␊ - | {␊ - /**␊ - * The module path that is resolved when the module specifier matches "name", shadows the "main" field.␊ - */␊ - "."?: PackageExportsEntry | PackageExportsFallback;␊ - /**␊ - * The module path prefix that is resolved when the module specifier starts with "name/", set to "./" to allow external modules to import any subpath.␊ - */␊ - "./"?: PackageExportsEntry | PackageExportsFallback;␊ - /**␊ - * The module path that is resolved when the path component of the module specifier matches the property name.␊ - *␊ - * This interface was referenced by \`undefined\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^\\./".␊ - */␊ - [k: string]: PackageExportsEntry | PackageExportsFallback;␊ - }␊ - | PackageExportsEntryObject1␊ - | PackageExportsFallback1;␊ - bin?:␊ - | string␊ - | {␊ - [k: string]: string;␊ - };␊ - /**␊ - * When set to "module", the type field allows a package to specify all .js files within are ES modules. If the "type" field is omitted or set to "commonjs", all .js files are treated as CommonJS.␊ - */␊ - type?: "commonjs" | "module";␊ - /**␊ - * Set the types property to point to your bundled declaration file.␊ - */␊ - types?: string;␊ - /**␊ - * Note that the "typings" field is synonymous with "types", and could be used as well.␊ - */␊ - typings?: string;␊ - /**␊ - * The "typesVersions" field is used since TypeScript 3.1 to support features that were only made available in newer TypeScript versions.␊ - */␊ - typesVersions?: {␊ - /**␊ - * Contains overrides for the TypeScript version that matches the version range matching the property key.␊ - */␊ - [k: string]: {␊ - /**␊ - * Maps all file paths to the file paths specified in the array.␊ - */␊ - "*"?: string[];␊ - };␊ - };␊ - /**␊ - * Specify either a single file or an array of filenames to put in place for the man program to find.␊ - */␊ - man?: string[] | string;␊ - directories?: {␊ - /**␊ - * If you specify a 'bin' directory, then all the files in that folder will be used as the 'bin' hash.␊ - */␊ - bin?: string;␊ - /**␊ - * Put markdown files in here. Eventually, these will be displayed nicely, maybe, someday.␊ - */␊ - doc?: string;␊ - /**␊ - * Put example scripts in here. Someday, it might be exposed in some clever way.␊ - */␊ - example?: string;␊ - /**␊ - * Tell people where the bulk of your library is. Nothing special is done with the lib folder in any way, but it's useful meta info.␊ - */␊ - lib?: string;␊ - /**␊ - * A folder that is full of man pages. Sugar to generate a 'man' array by walking the folder.␊ - */␊ - man?: string;␊ - test?: string;␊ - [k: string]: unknown;␊ - };␊ - /**␊ - * Specify the place where your code lives. This is helpful for people who want to contribute.␊ - */␊ - repository?:␊ - | {␊ - type?: string;␊ - url?: string;␊ - directory?: string;␊ - [k: string]: unknown;␊ - }␊ - | string;␊ - /**␊ - * The 'scripts' member is an object hash of script commands that are run at various times in the lifecycle of your package. The key is the lifecycle event, and the value is the command to run at that point.␊ - */␊ - scripts?: {␊ - /**␊ - * Run BEFORE the package is published (Also run on local npm install without any arguments).␊ - */␊ - prepublish?: string;␊ - /**␊ - * Run both BEFORE the package is packed and published, and on local npm install without any arguments. This is run AFTER prepublish, but BEFORE prepublishOnly.␊ - */␊ - prepare?: string;␊ - /**␊ - * Run BEFORE the package is prepared and packed, ONLY on npm publish.␊ - */␊ - prepublishOnly?: string;␊ - /**␊ - * run BEFORE a tarball is packed (on npm pack, npm publish, and when installing git dependencies).␊ - */␊ - prepack?: string;␊ - /**␊ - * Run AFTER the tarball has been generated and moved to its final destination.␊ - */␊ - postpack?: string;␊ - publish?: ScriptsPublishAfter;␊ - postpublish?: ScriptsPublishAfter;␊ - /**␊ - * Run BEFORE the package is installed.␊ - */␊ - preinstall?: string;␊ - install?: ScriptsInstallAfter;␊ - postinstall?: ScriptsInstallAfter;␊ - preuninstall?: ScriptsUninstallBefore;␊ - uninstall?: ScriptsUninstallBefore;␊ - /**␊ - * Run AFTER the package is uninstalled.␊ - */␊ - postuninstall?: string;␊ - preversion?: ScriptsVersionBefore;␊ - version?: ScriptsVersionBefore;␊ - /**␊ - * Run AFTER bump the package version.␊ - */␊ - postversion?: string;␊ - pretest?: ScriptsTest;␊ - test?: ScriptsTest;␊ - posttest?: ScriptsTest;␊ - prestop?: ScriptsStop;␊ - stop?: ScriptsStop;␊ - poststop?: ScriptsStop;␊ - prestart?: ScriptsStart;␊ - start?: ScriptsStart;␊ - poststart?: ScriptsStart;␊ - prerestart?: ScriptsRestart;␊ - restart?: ScriptsRestart;␊ - postrestart?: ScriptsRestart;␊ - [k: string]: string | undefined;␊ - };␊ - /**␊ - * A 'config' hash can be used to set configuration parameters used in package scripts that persist across upgrades.␊ - */␊ - config?: {␊ - [k: string]: unknown;␊ - };␊ - dependencies?: Dependency;␊ - devDependencies?: Dependency;␊ - optionalDependencies?: Dependency;␊ - peerDependencies?: Dependency;␊ - /**␊ - * When a user installs your package, warnings are emitted if packages specified in "peerDependencies" are not already installed. The "peerDependenciesMeta" field serves to provide more information on how your peer dependencies are utilized. Most commonly, it allows peer dependencies to be marked as optional. Metadata for this field is specified with a simple hash of the package name to a metadata object.␊ - */␊ - peerDependenciesMeta?: {␊ - [k: string]: {␊ - /**␊ - * Specifies that this peer dependency is optional and should not be installed automatically.␊ - */␊ - optional?: boolean;␊ - [k: string]: unknown;␊ - };␊ - };␊ - /**␊ - * Array of package names that will be bundled when publishing the package.␊ - */␊ - bundledDependencies?: string[] | false;␊ - /**␊ - * DEPRECATED: This field is honored, but "bundledDependencies" is the correct field name.␊ - */␊ - bundleDependencies?: string[] | false;␊ - /**␊ - * Resolutions is used to support selective version resolutions, which lets you define custom package versions or ranges inside your dependencies. See: https://classic.yarnpkg.com/en/docs/selective-version-resolutions␊ - */␊ - resolutions?: {␊ - [k: string]: unknown;␊ - };␊ - engines?: {␊ - node?: string;␊ - [k: string]: string;␊ - };␊ - engineStrict?: boolean;␊ - /**␊ - * Specify which operating systems your module will run on.␊ - */␊ - os?: string[];␊ - /**␊ - * Specify that your code only runs on certain cpu architectures.␊ - */␊ - cpu?: string[];␊ - /**␊ - * DEPRECATED: This option used to trigger an npm warning, but it will no longer warn. It is purely there for informational purposes. It is now recommended that you install any binaries as local devDependencies wherever possible.␊ - */␊ - preferGlobal?: boolean;␊ - /**␊ - * If set to true, then npm will refuse to publish it.␊ - */␊ - private?: boolean | ("false" | "true");␊ - publishConfig?: {␊ - access?: "public" | "restricted";␊ - tag?: string;␊ - registry?: string;␊ - [k: string]: unknown;␊ - };␊ - dist?: {␊ - shasum?: string;␊ - tarball?: string;␊ - [k: string]: unknown;␊ - };␊ - readme?: string;␊ - /**␊ - * An ECMAScript module ID that is the primary entry point to your program.␊ - */␊ - module?: string;␊ - /**␊ - * A module ID with untranspiled code that is the primary entry point to your program.␊ - */␊ - esnext?:␊ - | string␊ - | {␊ - main?: string;␊ - browser?: string;␊ - [k: string]: string;␊ - };␊ - /**␊ - * Allows packages within a directory to depend on one another using direct linking of local files. Additionally, dependencies within a workspace are hoisted to the workspace root when possible to reduce duplication. Note: It's also a good idea to set "private" to true when using this feature.␊ - */␊ - workspaces?:␊ - | string[]␊ - | {␊ - /**␊ - * Workspace package paths. Glob patterns are supported.␊ - */␊ - packages?: string[];␊ - /**␊ - * Packages to block from hoisting to the workspace root. Currently only supported in Yarn only.␊ - */␊ - nohoist?: string[];␊ - [k: string]: unknown;␊ - };␊ - jspm?: JSONSchemaForNPMPackageJsonFiles1;␊ - /**␊ - * Any property starting with _ is valid.␊ - *␊ - * This interface was referenced by \`JSONSchemaForNPMPackageJsonFiles2\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^_".␊ - */␊ - [k: string]: any;␊ - }␊ - /**␊ - * Used to specify conditional exports, note that Conditional exports are unsupported in older environments, so it's recommended to use the fallback array option if support for those environments is a concern.␊ - */␊ - export interface PackageExportsEntryObject {␊ - /**␊ - * The module path that is resolved when this specifier is imported as a CommonJS module using the \`require(...)\` function.␊ - */␊ - require?: PackageExportsEntry | PackageExportsFallback;␊ - /**␊ - * The module path that is resolved when this specifier is imported as an ECMAScript module using an \`import\` declaration or the dynamic \`import(...)\` function.␊ - */␊ - import?: PackageExportsEntry | PackageExportsFallback;␊ - /**␊ - * The module path that is resolved when this environment is Node.js.␊ - */␊ - node?: PackageExportsEntry | PackageExportsFallback;␊ - /**␊ - * The module path that is resolved when no other export type matches.␊ - */␊ - default?: PackageExportsEntry | PackageExportsFallback;␊ - /**␊ - * The module path that is resolved when this environment matches the property name.␊ - *␊ - * This interface was referenced by \`PackageExportsEntryObject\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^(?![\\.0-9]).".␊ - *␊ - * This interface was referenced by \`PackageExportsEntryObject1\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^(?![\\.0-9]).".␊ - */␊ - [k: string]: PackageExportsEntry | PackageExportsFallback;␊ - }␊ - /**␊ - * Used to specify conditional exports, note that Conditional exports are unsupported in older environments, so it's recommended to use the fallback array option if support for those environments is a concern.␊ - */␊ - export interface PackageExportsEntryObject1 {␊ - /**␊ - * The module path that is resolved when this specifier is imported as a CommonJS module using the \`require(...)\` function.␊ - */␊ - require?: PackageExportsEntry | PackageExportsFallback;␊ - /**␊ - * The module path that is resolved when this specifier is imported as an ECMAScript module using an \`import\` declaration or the dynamic \`import(...)\` function.␊ - */␊ - import?: PackageExportsEntry | PackageExportsFallback;␊ - /**␊ - * The module path that is resolved when this environment is Node.js.␊ - */␊ - node?: PackageExportsEntry | PackageExportsFallback;␊ - /**␊ - * The module path that is resolved when no other export type matches.␊ - */␊ - default?: PackageExportsEntry | PackageExportsFallback;␊ - /**␊ - * The module path that is resolved when this environment matches the property name.␊ - *␊ - * This interface was referenced by \`PackageExportsEntryObject\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^(?![\\.0-9]).".␊ - *␊ - * This interface was referenced by \`PackageExportsEntryObject1\`'s JSON-Schema definition␊ - * via the \`patternProperty\` "^(?![\\.0-9]).".␊ - */␊ - [k: string]: PackageExportsEntry | PackageExportsFallback;␊ - }␊ - /**␊ - * Dependencies are specified with a simple hash of package name to version range. The version range is a string which has one or more space-separated descriptors. Dependencies can also be identified with a tarball or git URL.␊ - */␊ - export interface Dependency {␊ - [k: string]: string;␊ - }␊ - ` - -## realWorld.swagger.2.js - -> Expected output to match snapshot for e2e test: realWorld.swagger.2.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface RealWorldSwagger {␊ - definitions?: Definitions;␊ - [k: string]: unknown;␊ - }␊ - export interface Definitions {␊ - additionalProperties?: Definitions;␊ - [k: string]: unknown;␊ - }␊ - ` - -## ref.1a.js - -> Expected output to match snapshot for e2e test: ref.1a.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface Referencing {␊ - foo: ExampleSchema;␊ - }␊ - export interface ExampleSchema {␊ - firstName: string;␊ - lastName: string;␊ - /**␊ - * Age in years␊ - */␊ - age?: number;␊ - height?: number;␊ - favoriteFoods?: unknown[];␊ - likesDogs?: boolean;␊ - [k: string]: unknown;␊ - }␊ - ` - -## ref.1b.js - -> Expected output to match snapshot for e2e test: ref.1b.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface Referencing {␊ - foo: ExampleSchema;␊ - }␊ - ` - -## ref.2.js - -> Expected output to match snapshot for e2e test: ref.2.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - /**␊ - * A string with title and enum defined does produce a duplicate Interface␊ - */␊ - export type FifthDefinitionString = "one" | "two" | "three";␊ - export type Six = number;␊ - ␊ - export interface LocallyReferencedManifest {␊ - /**␊ - * Behaviour is the same if definition is referenced as prop within a container␊ - */␊ - firstContainer?: {␊ - first?: FirstDefinition;␊ - [k: string]: unknown;␊ - };␊ - second?: UnrelatedTitle;␊ - third?: ThirdDefinition;␊ - fourth?: FourthDefinitionSimpleObject;␊ - fifth?: FifthDefinitionString;␊ - sixth?: Six;␊ - [k: string]: unknown;␊ - }␊ - /**␊ - * Title matches definition key for kicks␊ - */␊ - export interface FirstDefinition {␊ - name?: string;␊ - [k: string]: unknown;␊ - }␊ - /**␊ - * Title is unrelated to definition key and behaviour is the same␊ - */␊ - export interface UnrelatedTitle {␊ - name?: string;␊ - [k: string]: unknown;␊ - }␊ - /**␊ - * Definition has no title and produces no duplicate Interface␊ - */␊ - export interface ThirdDefinition {␊ - name?: string;␊ - [k: string]: unknown;␊ - }␊ - /**␊ - * A simple object type with title set and no properties defined produces no duplicate Interface␊ - */␊ - export interface FourthDefinitionSimpleObject {␊ - [k: string]: unknown;␊ - }␊ - ` - -## ref.4.js - -> Expected output to match snapshot for e2e test: ref.4.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface Referencing {␊ - foo: ExampleSchema;␊ - }␊ - export interface ExampleSchema {␊ - firstName: string;␊ - lastName: string;␊ - /**␊ - * Age in years␊ - */␊ - age?: number;␊ - height?: number;␊ - favoriteFoods?: unknown[];␊ - likesDogs?: boolean;␊ - [k: string]: unknown;␊ - }␊ - ` - -## ref.5.js - -> Expected output to match snapshot for e2e test: ref.5.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface Referencing {␊ - foo: ExampleSchema;␊ - bar: ExampleSchema1;␊ - }␊ - export interface ExampleSchema {␊ - firstName: string;␊ - lastName: string;␊ - /**␊ - * Age in years␊ - */␊ - age?: number;␊ - height?: number;␊ - favoriteFoods?: unknown[];␊ - likesDogs?: boolean;␊ - [k: string]: unknown;␊ - }␊ - export interface ExampleSchema1 {␊ - isConflict: boolean;␊ - }␊ - ` - -## ref.6a.js - -> Expected output to match snapshot for e2e test: ref.6a.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export type ExampleCombinedSchema = string | number;␊ - ␊ - export interface ReferencingCombined {␊ - foo: ExampleCombinedSchema;␊ - }␊ - ` - -## ref.6b.js - -> Expected output to match snapshot for e2e test: ref.6b.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface ReferencingCombined {␊ - foo: ExampleCombinedSchema;␊ - }␊ - ` - -## refWithCycle.1.js - -> Expected output to match snapshot for e2e test: refWithCycle.1.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface LocalCycle {␊ - foo: LocalCycle;␊ - bar?: LocalCycle;␊ - [k: string]: unknown;␊ - }␊ - ` - -## refWithCycle.2.js - -> Expected output to match snapshot for e2e test: refWithCycle.2.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface Cycle2 {␊ - foo: Cycle3;␊ - [k: string]: unknown;␊ - }␊ - export interface Cycle3 {␊ - foo?: Cycle4;␊ - }␊ - export interface Cycle4 {␊ - foo?: number;␊ - bar?: Cycle3;␊ - [k: string]: unknown;␊ - }␊ - ` - -## refWithCycle.4.js - -> Expected output to match snapshot for e2e test: refWithCycle.4.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface RefWithCycle {␊ - id?: number;␊ - userId?: number;␊ - [k: string]: unknown;␊ - }␊ - ` - -## refWithCycle.5.js - -> Expected output to match snapshot for e2e test: refWithCycle.5.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface RefWithCycle {␊ - owner?: Person;␊ - [k: string]: unknown;␊ - }␊ - export interface Person {␊ - name?: string;␊ - children?: Person;␊ - }␊ - ` - -## referencesShouldBeNormalized.js - -> Expected output to match snapshot for e2e test: referencesShouldBeNormalized.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface Referencing {␊ - a: ExampleSchema;␊ - [k: string]: unknown;␊ - }␊ - export interface ExampleSchema {␊ - /**␊ - * @maxItems 5␊ - */␊ - b?:␊ - | []␊ - | [number]␊ - | [number, number]␊ - | [number, number, number]␊ - | [number, number, number, number]␊ - | [number, number, number, number, number];␊ - [k: string]: unknown;␊ - }␊ - ` - -## required.js - -> Expected output to match snapshot for e2e test: required.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface Required {␊ - location: Location & {␊ - [k: string]: unknown;␊ - };␊ - name: string;␊ - website?: string;␊ - }␊ - export interface Location {␊ - city?: string;␊ - postalCode?: number;␊ - [k: string]: unknown;␊ - }␊ - ` - -## reservedWords.1.js - -> Expected output to match snapshot for e2e test: reservedWords.1.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface ReservedWords {␊ - additionalProperties?: number[];␊ - definitions?: number;␊ - properties?: boolean;␊ - [k: string]: unknown;␊ - }␊ - ` - -## reservedWords.2.js - -> Expected output to match snapshot for e2e test: reservedWords.2.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface ReservedWords {␊ - definitions?: Definitions;␊ - [k: string]: unknown;␊ - }␊ - export interface Definitions {␊ - additionalProperties?: Definitions;␊ - [k: string]: unknown;␊ - }␊ - ` - -## safeTypeNames.js - -> Expected output to match snapshot for e2e test: safeTypeNames.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface SafeTypeNames {␊ - [k: string]: unknown;␊ - }␊ - /**␊ - * This interface was referenced by \`SafeTypeNames\`'s JSON-Schema␊ - * via the \`definition\` "stra'nge#name".␊ - */␊ - export interface StraNgeName {␊ - a: string;␊ - b?: number;␊ - }␊ - /**␊ - * This interface was referenced by \`SafeTypeNames\`'s JSON-Schema␊ - * via the \`definition\` "keepUPPERCASE".␊ - */␊ - export interface KeepUPPERCASE {␊ - a?: "a" | "b" | "c";␊ - [k: string]: unknown;␊ - }␊ - /**␊ - * This interface was referenced by \`SafeTypeNames\`'s JSON-Schema␊ - * via the \`definition\` "snake_case".␊ - */␊ - export interface SnakeCase {␊ - a?: boolean;␊ - [k: string]: unknown;␊ - }␊ - /**␊ - * This interface was referenced by \`SafeTypeNames\`'s JSON-Schema␊ - * via the \`definition\` "_startsWithUnderscore".␊ - */␊ - export interface _StartsWithUnderscore {␊ - a?: boolean;␊ - [k: string]: unknown;␊ - }␊ - /**␊ - * This interface was referenced by \`SafeTypeNames\`'s JSON-Schema␊ - * via the \`definition\` "_StartsWithUnderscoreUppercase".␊ - */␊ - export interface _StartsWithUnderscoreUppercase {␊ - a?: boolean;␊ - [k: string]: unknown;␊ - }␊ - /**␊ - * This interface was referenced by \`SafeTypeNames\`'s JSON-Schema␊ - * via the \`definition\` "EndsWithUnderscore_".␊ - */␊ - export interface EndsWithUnderscore_ {␊ - a?: boolean;␊ - [k: string]: unknown;␊ - }␊ - /**␊ - * This interface was referenced by \`SafeTypeNames\`'s JSON-Schema␊ - * via the \`definition\` "UPPER_CASE".␊ - */␊ - export interface UPPER_CASE {␊ - a?: boolean;␊ - [k: string]: unknown;␊ - }␊ - /**␊ - * This interface was referenced by \`SafeTypeNames\`'s JSON-Schema␊ - * via the \`definition\` "______________".␊ - */␊ - export interface ______________ {␊ - a?: boolean;␊ - [k: string]: unknown;␊ - }␊ - /**␊ - * This interface was referenced by \`SafeTypeNames\`'s JSON-Schema␊ - * via the \`definition\` "camelCase".␊ - */␊ - export interface CamelCase {␊ - a?: {␊ - [k: string]: unknown;␊ - };␊ - [k: string]: unknown;␊ - }␊ - /**␊ - * This interface was referenced by \`SafeTypeNames\`'s JSON-Schema␊ - * via the \`definition\` "kebab-case".␊ - */␊ - export interface KebabCase {␊ - a?: string;␊ - [k: string]: unknown;␊ - }␊ - /**␊ - * This interface was referenced by \`SafeTypeNames\`'s JSON-Schema␊ - * via the \`definition\` " startsWithSpace".␊ - */␊ - export interface StartsWithSpace {␊ - a?: string;␊ - [k: string]: unknown;␊ - }␊ - /**␊ - * This interface was referenced by \`SafeTypeNames\`'s JSON-Schema␊ - * via the \`definition\` "contains space".␊ - */␊ - export interface ContainsSpace {␊ - a?: string;␊ - [k: string]: unknown;␊ - }␊ - /**␊ - * This interface was referenced by \`SafeTypeNames\`'s JSON-Schema␊ - * via the \`definition\` "5tartsWithDigit".␊ - */␊ - export interface TartsWithDigit {␊ - a?: string;␊ - [k: string]: unknown;␊ - }␊ - /**␊ - * This interface was referenced by \`SafeTypeNames\`'s JSON-Schema␊ - * via the \`definition\` " 5tartsWithBlankAndDigit".␊ - */␊ - export interface TartsWithBlankAndDigit {␊ - a?: string;␊ - [k: string]: unknown;␊ - }␊ - /**␊ - * This interface was referenced by \`SafeTypeNames\`'s JSON-Schema␊ - * via the \`definition\` "endsWithDigi7".␊ - */␊ - export interface EndsWithDigi7 {␊ - a?: string;␊ - [k: string]: unknown;␊ - }␊ - /**␊ - * This interface was referenced by \`SafeTypeNames\`'s JSON-Schema␊ - * via the \`definition\` "contains4digit".␊ - */␊ - export interface Contains4Digit {␊ - a?: string;␊ - [k: string]: unknown;␊ - }␊ - /**␊ - * This interface was referenced by \`SafeTypeNames\`'s JSON-Schema␊ - * via the \`definition\` ".startsWithPeriod".␊ - */␊ - export interface StartsWithPeriod {␊ - a?: string;␊ - [k: string]: unknown;␊ - }␊ - /**␊ - * This interface was referenced by \`SafeTypeNames\`'s JSON-Schema␊ - * via the \`definition\` "endsWithPeriod.".␊ - */␊ - export interface EndsWithPeriod {␊ - a?: string;␊ - [k: string]: unknown;␊ - }␊ - /**␊ - * This interface was referenced by \`SafeTypeNames\`'s JSON-Schema␊ - * via the \`definition\` "contains...period".␊ - */␊ - export interface ContainsPeriod {␊ - a?: string;␊ - [k: string]: unknown;␊ - }␊ - /**␊ - * This interface was referenced by \`SafeTypeNames\`'s JSON-Schema␊ - * via the \`definition\` ",startsWithComma".␊ - */␊ - export interface StartsWithComma {␊ - a?: string;␊ - [k: string]: unknown;␊ - }␊ - /**␊ - * This interface was referenced by \`SafeTypeNames\`'s JSON-Schema␊ - * via the \`definition\` "endsWithComma,".␊ - */␊ - export interface EndsWithComma {␊ - a?: string;␊ - [k: string]: unknown;␊ - }␊ - /**␊ - * This interface was referenced by \`SafeTypeNames\`'s JSON-Schema␊ - * via the \`definition\` "contains,,Comma".␊ - */␊ - export interface ContainsComma {␊ - a?: string;␊ - [k: string]: unknown;␊ - }␊ - /**␊ - * This interface was referenced by \`SafeTypeNames\`'s JSON-Schema␊ - * via the \`definition\` "$startsWithDollar".␊ - */␊ - export interface $StartsWithDollar {␊ - a?: string;␊ - [k: string]: unknown;␊ - }␊ - /**␊ - * This interface was referenced by \`SafeTypeNames\`'s JSON-Schema␊ - * via the \`definition\` "endsWithDollar$".␊ - */␊ - export interface EndsWithDollar$ {␊ - a?: string;␊ - [k: string]: unknown;␊ - }␊ - /**␊ - * This interface was referenced by \`SafeTypeNames\`'s JSON-Schema␊ - * via the \`definition\` "contains$Dollar".␊ - */␊ - export interface Contains$Dollar {␊ - a?: string;␊ - [k: string]: unknown;␊ - }␊ - /**␊ - * This interface was referenced by \`SafeTypeNames\`'s JSON-Schema␊ - * via the \`definition\` "$".␊ - */␊ - export interface $ {␊ - a?: string;␊ - [k: string]: unknown;␊ - }␊ - /**␊ - * This interface was referenced by \`SafeTypeNames\`'s JSON-Schema␊ - * via the \`definition\` "UPPERCASE".␊ - */␊ - export interface UPPERCASE {␊ - a?: string;␊ - [k: string]: unknown;␊ - }␊ - /**␊ - * This interface was referenced by \`SafeTypeNames\`'s JSON-Schema␊ - * via the \`definition\` "Startsuppercase".␊ - */␊ - export interface Startsuppercase {␊ - a?: string;␊ - [k: string]: unknown;␊ - }␊ - ` - -## schemaTitleAsTypeName.js - -> Expected output to match snapshot for e2e test: schemaTitleAsTypeName.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface Referencing {␊ - ref: ExampleSchema;␊ - }␊ - export interface ExampleSchema {␊ - firstName: string;␊ - lastName: string;␊ - /**␊ - * Age in years␊ - */␊ - age?: number;␊ - height?: number;␊ - favoriteFoods?: unknown[];␊ - likesDogs?: boolean;␊ - [k: string]: unknown;␊ - }␊ - ` - -## specialCharacters.js - -> Expected output to match snapshot for e2e test: specialCharacters.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface ExampleSchema {␊ - "\`foo\`": string;␊ - "'bar'": string;␊ - '"baz"': string;␊ - "$zoo 2"?: string;␊ - "qux..."?: number;␊ - [k: string]: unknown;␊ - }␊ - ` - -## subSchema.js - -> Expected output to match snapshot for e2e test: subSchema.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface SchemaWithSubschema {␊ - firstName: string;␊ - friend?: {␊ - knowsFrom: "work" | "school" | "other";␊ - [k: string]: unknown;␊ - };␊ - coworker?: {␊ - company?: {␊ - name: string;␊ - };␊ - [k: string]: KString;␊ - };␊ - [k: string]: unknown;␊ - }␊ - ␊ - export const enum KString {␊ - red = 10,␊ - green = 20,␊ - blue = 30␊ - }␊ - ` - -## topLevelUnion.js - -> Expected output to match snapshot for e2e test: topLevelUnion.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export type TopLevelUnion = number | string;␊ - ` - -## tupleItemsWithTitles.js - -> Expected output to match snapshot for e2e test: tupleItemsWithTitles.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export type TupleFooBar = [] | [Foo] | [Foo, Bar];␊ - ␊ - export interface Foo {␊ - foo?: string;␊ - [k: string]: unknown;␊ - }␊ - export interface Bar {␊ - bar?: string;␊ - [k: string]: unknown;␊ - }␊ - ` - -## tupleRef.js - -> Expected output to match snapshot for e2e test: tupleRef.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export type A = string;␊ - export type B = number;␊ - ␊ - export interface TupleRef {␊ - c?: [] | [A] | [A, B];␊ - }␊ - ` - -## typedArray.1.js - -> Expected output to match snapshot for e2e test: typedArray.1.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export type ArrayItems = ArrayItem[];␊ - ␊ - export interface ObjectWithArrayField {␊ - data: ArrayItems;␊ - }␊ - export interface ArrayItem {␊ - prop: string;␊ - }␊ - ` - -## typedArray.2.js - -> Expected output to match snapshot for e2e test: typedArray.2.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export type Id = string;␊ - export type ArrayItems = ArrayItem[];␊ - ␊ - export interface ObjectWithArrayField {␊ - data: ArrayItems;␊ - }␊ - export interface ArrayItem {␊ - id: Id;␊ - }␊ - ` - -## unicode.js - -> Expected output to match snapshot for e2e test: unicode.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export type NoName1 = string;␊ - ␊ - export interface NoName {␊ - someKey?: NoName1;␊ - [k: string]: unknown;␊ - }␊ - ` - -## union.2.js - -> Expected output to match snapshot for e2e test: union.2.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface Union {␊ - input?:␊ - | string␊ - | {␊ - [k: string]: unknown;␊ - }␊ - | string[];␊ - }␊ - ` - -## union.3.js - -> Expected output to match snapshot for e2e test: union.3.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface MySchema {␊ - example?: boolean | string;␊ - }␊ - ` - -## union.4.js - -> Expected output to match snapshot for e2e test: union.4.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export type Union = string | false;␊ - ` - -## union.js - -> Expected output to match snapshot for e2e test: union.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface Union {␊ - test?: {␊ - /**␊ - * @minItems 1␊ - */␊ - test1?: boolean | [string, ...string[]];␊ - /**␊ - * @minItems 1␊ - */␊ - test2?: boolean | [string, ...string[]];␊ - [k: string]: unknown;␊ - };␊ - [k: string]: unknown;␊ - }␊ - ` - -## unionWithProperties.js - -> Expected output to match snapshot for e2e test: unionWithProperties.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export type UnionWithProps = UnionWithProps1 & UnionWithProps2;␊ - export type UnionWithProps1 =␊ + export type Person = {␊ + name?: string;␊ + } & (␊ | {␊ - obj_type: "Foo";␊ - foo_type?: string;␊ - [k: string]: unknown;␊ + name?: string;␊ }␊ - | {␊ - obj_type: "Bar";␊ - bar_type?: string;␊ - team: string;␊ - health: number;␊ - [k: string]: unknown;␊ - };␊ - ␊ - export interface UnionWithProps2 {␊ - coords: number;␊ - id: number;␊ - [k: string]: unknown;␊ - }␊ - ` - -## unnamedSchema.js - -> Expected output to match snapshot for e2e test: unnamedSchema.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface UnnamedSchema {␊ - foo: string;␊ - }␊ - ` - -## withDescription.js - -> Expected output to match snapshot for e2e test: withDescription.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - /**␊ - * My cool schema␊ - */␊ - export interface ExampleSchema {␊ - firstName: string;␊ - lastName: string;␊ - /**␊ - * Age in years␊ - */␊ - age?: number;␊ - [k: string]: unknown;␊ - }␊ - ` - -## withDescriptionNewlines.js - -> Expected output to match snapshot for e2e test: withDescriptionNewlines.js - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - /**␊ - * My cool schema␊ - */␊ - export interface ExampleSchema {␊ - /**␊ - * first name single line description␊ - */␊ - firstName: string;␊ - lastName: string;␊ - /**␊ - * Age description with␊ - * multiple lines␊ - */␊ - age?: number;␊ - [k: string]: unknown;␊ - }␊ - ` - -## compileFromFile should resolve refs from cwd option - -> Snapshot 1 - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface Referencing {␊ - foo: ExampleSchema;␊ - }␊ - export interface ExampleSchema {␊ - firstName: string;␊ - lastName: string;␊ - /**␊ - * Age in years␊ - */␊ - age?: number;␊ - height?: number;␊ - favoriteFoods?: unknown[];␊ - likesDogs?: boolean;␊ - [k: string]: unknown;␊ - }␊ - ` - -## compileFromFile should resolve refs from cwd option as yml - -> Snapshot 1 - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface Referencing {␊ - foo: ExampleSchema;␊ - }␊ - export interface ExampleSchema {␊ - firstName: string;␊ - lastName: string;␊ - /**␊ - * Age in years␊ - */␊ - age?: number;␊ - height?: number;␊ - favoriteFoods?: unknown[];␊ - likesDogs?: boolean;␊ - [k: string]: unknown;␊ - }␊ - ` - -## pipe in, pipe out - -> Snapshot 1 - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface ExampleSchema {␊ - firstName: string;␊ - lastName: string;␊ - /**␊ - * Age in years␊ - */␊ - age?: number;␊ - height?: number;␊ - favoriteFoods?: unknown[];␊ - likesDogs?: boolean;␊ - [k: string]: unknown;␊ - }␊ - ` - -## pipe in (schema without ID), pipe out - -> Snapshot 1 - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface ExampleSchema {␊ - firstName: string;␊ - lastName: string;␊ - /**␊ - * Age in years␊ - */␊ - age?: number;␊ - height?: number;␊ - favoriteFoods?: unknown[];␊ - likesDogs?: boolean;␊ - [k: string]: unknown;␊ - }␊ - ` - -## file in (no flags), pipe out - -> Snapshot 1 - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface ExampleSchema {␊ - firstName: string;␊ - lastName: string;␊ - /**␊ - * Age in years␊ - */␊ - age?: number;␊ - height?: number;␊ - favoriteFoods?: unknown[];␊ - likesDogs?: boolean;␊ - [k: string]: unknown;␊ - }␊ - ` - -## file in (--input), pipe out - -> Snapshot 1 - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface ExampleSchema {␊ - firstName: string;␊ - lastName: string;␊ - /**␊ - * Age in years␊ - */␊ - age?: number;␊ - height?: number;␊ - favoriteFoods?: unknown[];␊ - likesDogs?: boolean;␊ - [k: string]: unknown;␊ - }␊ - ` - -## file in (-i), pipe out - -> Snapshot 1 - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface ExampleSchema {␊ - firstName: string;␊ - lastName: string;␊ - /**␊ - * Age in years␊ - */␊ - age?: number;␊ - height?: number;␊ - favoriteFoods?: unknown[];␊ - likesDogs?: boolean;␊ - [k: string]: unknown;␊ - }␊ - ` - -## file in (-i), unreachable definitions flag, pipe out - -> Snapshot 1 - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface DefinitionsOnly {␊ - [k: string]: unknown;␊ - }␊ - /**␊ - * This interface was referenced by \`DefinitionsOnly\`'s JSON-Schema␊ - * via the \`definition\` "DummyPerson".␊ - */␊ - export interface DummyPerson {␊ - age?: number;␊ - [k: string]: unknown;␊ - }␊ - ` - -## file in (-i), style flags, pipe out - -> Snapshot 1 - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface Enum {␊ - fstype?: 'ext3' | 'ext4' | 'btrfs'␊ - [k: string]: unknown␊ - }␊ - ` - -## file in (-i), pipe out (absolute path) - -> Snapshot 1 - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface ExampleSchema {␊ - firstName: string;␊ - lastName: string;␊ - /**␊ - * Age in years␊ - */␊ - age?: number;␊ - height?: number;␊ - favoriteFoods?: unknown[];␊ - likesDogs?: boolean;␊ - [k: string]: unknown;␊ - }␊ - ` - -## file in (yaml), pipe out - -> Snapshot 1 - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface ExampleSchema {␊ - firstName: string;␊ - lastName: string;␊ - /**␊ - * Age in years␊ - */␊ - age?: number;␊ - height?: number;␊ - favoriteFoods?: unknown[];␊ - likesDogs?: boolean;␊ - [k: string]: unknown;␊ - }␊ - ` - -## pipe in, file out (--output) - -> Snapshot 1 - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface ExampleSchema {␊ - firstName: string;␊ - lastName: string;␊ - /**␊ - * Age in years␊ - */␊ - age?: number;␊ - height?: number;␊ - favoriteFoods?: unknown[];␊ - likesDogs?: boolean;␊ - [k: string]: unknown;␊ - }␊ - ` - -## pipe in, file out (-o) - -> Snapshot 1 - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface ExampleSchema {␊ - firstName: string;␊ - lastName: string;␊ - /**␊ - * Age in years␊ - */␊ - age?: number;␊ - height?: number;␊ - favoriteFoods?: unknown[];␊ - likesDogs?: boolean;␊ - [k: string]: unknown;␊ - }␊ - ` - -## file in (no flags), file out (no flags) - -> Snapshot 1 - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface ExampleSchema {␊ - firstName: string;␊ - lastName: string;␊ - /**␊ - * Age in years␊ - */␊ - age?: number;␊ - height?: number;␊ - favoriteFoods?: unknown[];␊ - likesDogs?: boolean;␊ - [k: string]: unknown;␊ - }␊ - ` - -## file in (-i), file out (-o) - -> Snapshot 1 - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface ExampleSchema {␊ - firstName: string;␊ - lastName: string;␊ - /**␊ - * Age in years␊ - */␊ - age?: number;␊ - height?: number;␊ - favoriteFoods?: unknown[];␊ - likesDogs?: boolean;␊ - [k: string]: unknown;␊ - }␊ - ` - -## file in (--input), file out (--output) - -> Snapshot 1 - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface ExampleSchema {␊ - firstName: string;␊ - lastName: string;␊ - /**␊ - * Age in years␊ - */␊ - age?: number;␊ - height?: number;␊ - favoriteFoods?: unknown[];␊ - likesDogs?: boolean;␊ - [k: string]: unknown;␊ - }␊ - ` - -## --unknownAny - -> Snapshot 1 - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface ExampleSchema {␊ - firstName: string;␊ - lastName: string;␊ - /**␊ - * Age in years␊ - */␊ - age?: number;␊ - height?: number;␊ - favoriteFoods?: any[];␊ - likesDogs?: boolean;␊ - [k: string]: any;␊ - }␊ - ` - -## --additionalProperties - -> Snapshot 1 - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface ExampleSchema {␊ - firstName: string;␊ - lastName: string;␊ - /**␊ - * Age in years␊ - */␊ - age?: number;␊ - height?: number;␊ - favoriteFoods?: unknown[];␊ - likesDogs?: boolean;␊ - }␊ - ` - -## files in (-i), files out (-o) - -> Snapshot 1 - - './test/resources/MultiSchema/out/a.d.ts' - -> Snapshot 2 - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface ASchema {␊ - f: string;␊ - g?: number;␊ - }␊ - ` - -> Snapshot 3 - - './test/resources/MultiSchema/out/b.d.ts' - -> Snapshot 4 - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface BSchema {␊ - x?: string;␊ - y: number;␊ - [k: string]: unknown;␊ - }␊ - ` - -## files in (-i), pipe out - -> Snapshot 1 - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface BSchema {␊ - x?: string;␊ - y: number;␊ - [k: string]: unknown;␊ - }␊ - /* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface ASchema {␊ - f: string;␊ - g?: number;␊ - }␊ - ` - -## files in (-i), files out (-o) nested dir does not exist - -> Snapshot 1 - - './test/resources/MultiSchema/foo/bar/out/a.d.ts' - -> Snapshot 2 - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface ASchema {␊ - f: string;␊ - g?: number;␊ - }␊ - ` - -> Snapshot 3 - - './test/resources/MultiSchema/foo/bar/out/b.d.ts' - -> Snapshot 4 - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface BSchema {␊ - x?: string;␊ - y: number;␊ - [k: string]: unknown;␊ - }␊ - ` - -## files in (-i), files out (-o) matching nested dir - -> Snapshot 1 - - 'test/resources/MultiSchema2/out/bar/b.d.ts' - -> Snapshot 2 - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface BSchema {␊ - x?: string;␊ - y: number;␊ - [k: string]: unknown;␊ - }␊ - ` - -> Snapshot 3 - - 'test/resources/MultiSchema2/out/bar/SameDirName/MultiSchema2/e.d.ts' - -> Snapshot 4 - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export type ESchema = string;␊ - ` - -> Snapshot 5 - - 'test/resources/MultiSchema2/out/foo/a.d.ts' - -> Snapshot 6 - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface ASchema {␊ - f: string;␊ - g?: number;␊ - }␊ - ` - -> Snapshot 7 - - 'test/resources/MultiSchema2/out/foobar/c.d.ts' - -> Snapshot 8 - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ - ␊ - export interface CSchema {␊ - f: string;␊ - g?: number;␊ - }␊ - ` - -> Snapshot 9 - - 'test/resources/MultiSchema2/out/foobar/fuzz/d.d.ts' - -> Snapshot 10 - - `/* eslint-disable */␊ - /**␊ - * This file was automatically generated by json-schema-to-typescript.␊ - * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,␊ - * and run json-schema-to-typescript to regenerate this file.␊ - */␊ + | string␊ + );␊ ␊ - export interface DSchema {␊ - f: string;␊ - g?: number;␊ + export interface Union {␊ + user?: Person;␊ }␊ ` diff --git a/test/__snapshots__/test/test.ts.snap b/test/__snapshots__/test/test.ts.snap index 0545e964..8ea471e9 100644 Binary files a/test/__snapshots__/test/test.ts.snap and b/test/__snapshots__/test/test.ts.snap differ diff --git a/test/e2e/customName.1.ts b/test/e2e/customName.1.ts index 378ed896..1cb6e846 100644 --- a/test/e2e/customName.1.ts +++ b/test/e2e/customName.1.ts @@ -16,9 +16,10 @@ export const input = { } export const options: Partial = { - customName: (_schema, keyName) => { - if (!keyName) - return undefined // Fallback to default naming - return 'CustomPrefix_' + keyName + customName(schema) { + if (!schema.$id) { + return // Fallback to default naming + } + return `CustomPrefix_${schema.$id}` }, } diff --git a/test/e2e/enum.5.ts b/test/e2e/enum.5.ts index a1685f94..f16c9593 100644 --- a/test/e2e/enum.5.ts +++ b/test/e2e/enum.5.ts @@ -28,7 +28,7 @@ export const input = { }, impliedIntegerEnum: { enum: [-1, 0, 1], - } + }, }, required: [ 'stringEnum', @@ -36,11 +36,11 @@ export const input = { 'booleanEnum', 'impliedBooleanEnum', 'integerEnum', - 'impliedIntegerEnum' + 'impliedIntegerEnum', ], additionalProperties: false, } export const options = { - inferStringEnumKeysFromValues: true + inferStringEnumKeysFromValues: true, } diff --git a/test/e2e/union.5.ts b/test/e2e/union.5.ts new file mode 100644 index 00000000..978775be --- /dev/null +++ b/test/e2e/union.5.ts @@ -0,0 +1,19 @@ +export const input = { + $defs: { + person: { + type: ['object', 'string'], + properties: { + name: { + type: 'string', + }, + }, + additionalProperties: false, + }, + }, + properties: { + user: {$ref: '#/$defs/person'}, + }, + additionalProperties: false, +} + +export const only = true diff --git a/test/testAnnotator.ts b/test/testAnnotator.ts index 19e7a416..55ddb99f 100644 --- a/test/testAnnotator.ts +++ b/test/testAnnotator.ts @@ -5,7 +5,7 @@ import {input} from './e2e/basics' export function run() { test("annotator should link to each node's parent schema", t => { - const schema = annotate(input, new WeakMap()) as any + const schema = annotate(input) as any t.is(schema[Parent], null) t.is(schema.properties[Parent], schema) t.is(schema.properties.firstName[Parent], schema.properties) @@ -16,4 +16,35 @@ export function run() { t.is(schema.properties.likesDogs[Parent], schema.properties) t.is(schema.required[Parent], schema) }) + + // test('annotator should add key names from $refs', t => { + // const input: JSONSchema = { + // definitions: { + // x: {type: 'string'}, + // y: {type: 'number'}, + // z: {$ref: '#/definitions/y'}, + // }, + // properties: { + // a: {$ref: '#/definitions/x'}, + // b: {$ref: '#/definitions/x'}, + // c: {$ref: '#/definitions/y'}, + // d: {$ref: '#/definitions/z'}, + // e: {$ref: '#/properties/e'}, + // f: {type: 'string'}, + // }, + // } + // const schema = annotate(input, new WeakMap()) + // t.is(schema[KeyNameFromDefinition], undefined) + // t.is(schema.definitions![KeyNameFromDefinition as any], undefined as any) + // t.is(schema.definitions!.x[KeyNameFromDefinition], undefined) + // t.is(schema.definitions!.y[KeyNameFromDefinition], undefined) + // t.is(schema.definitions!.z[KeyNameFromDefinition], undefined) + // t.is(schema.properties![KeyNameFromDefinition as any], undefined as any) + // t.is(schema.properties!.a[KeyNameFromDefinition], 'x') + // t.is(schema.properties!.b[KeyNameFromDefinition], 'x') + // t.is(schema.properties!.c[KeyNameFromDefinition], 'y') + // t.is(schema.properties!.d[KeyNameFromDefinition], 'z') + // t.is(schema.properties!.e[KeyNameFromDefinition], 'e') + // t.is(schema.properties!.f[KeyNameFromDefinition], undefined) + // }) } diff --git a/test/testNormalizer.ts b/test/testNormalizer.ts index 7866e84d..efe29787 100644 --- a/test/testNormalizer.ts +++ b/test/testNormalizer.ts @@ -21,12 +21,7 @@ export function run() { .map(_ => [_, require(_)] as [string, JSONTestCase]) .forEach(([filename, json]: [string, JSONTestCase]) => { test(json.name, t => { - const normalized = normalize( - annotate(json.in, new WeakMap()), - new WeakMap(), - filename, - json.options ?? DEFAULT_OPTIONS, - ) + const normalized = normalize(annotate(json.in), filename, json.options ?? DEFAULT_OPTIONS) t.deepEqual(json.out, normalized) }) }) diff --git a/test/testUtils.ts b/test/testUtils.ts index 67661783..23d72dc4 100644 --- a/test/testUtils.ts +++ b/test/testUtils.ts @@ -22,23 +22,20 @@ export function run() { t.is(generateName('a', usedNames), 'A3') }) test('isSchemaLike', t => { - const schema = annotate( - { - title: 'Example Schema', - type: 'object', - properties: { - firstName: { - type: 'string', - }, - lastName: { - id: 'lastName', - type: 'string', - }, + const schema = annotate({ + title: 'Example Schema', + type: 'object', + properties: { + firstName: { + type: 'string', + }, + lastName: { + id: 'lastName', + type: 'string', }, - required: ['firstName', 'lastName'], }, - new WeakMap(), - ) + required: ['firstName', 'lastName'], + }) t.is(isSchemaLike(schema), true) t.is(isSchemaLike([]), false) t.is(isSchemaLike(schema.properties), false)